← Back to branch summary

~n3npq/lsb/t2c-alsa-tests

« back to all changes in this revision

Viewing changes to spec/pcm__ladspa_8c.html

  • Committer: Jeff Licquia
  • Date: 2009-12-01 02:17:33 UTC
  • Revision ID: jeff@licquia.org-20091201021733-3wwc7cdytdzz7hwo
Initial version.

This contains the spec, as mirrored from the ALSA site, and as run
through KompoZer (so its gratuitous format changes are already there).

Show diffs side-by-side

added added

removed removed

Lines of Context:
spec/pcm__ladspa_8c.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head>
 
3
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>ALSA project - the C library reference: /home/alsa/tmp/cvs/alsa-lib/src/pcm/pcm_ladspa.c File Reference</title>
 
4
 
 
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"></head><body>
 
7
<!-- Generated by Doxygen 1.5.0 -->
 
8
<div class="tabs">
 
9
  <ul>
 
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
11
    <li><a href="modules.html"><span>Modules</span></a></li>
 
12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 
13
    <li id="current"><a href="files.html"><span>Files</span></a></li>
 
14
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
15
    <li><a href="examples.html"><span>Examples</span></a></li>
 
16
  </ul></div>
 
17
<div class="tabs">
 
18
  <ul>
 
19
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
 
20
    <li><a href="globals.html"><span>Globals</span></a></li>
 
21
  </ul></div>
 
22
<h1>/home/alsa/tmp/cvs/alsa-lib/src/pcm/pcm_ladspa.c File Reference</h1>ALSA Plugin &lt;-&gt; LADSPA Plugin Interface. <a href="#_details">More...</a>
 
23
<p>
 
24
<table border="0" cellpadding="0" cellspacing="0">
 
25
<tbody><tr><td><br>
 
26
</td></tr>
 
27
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
 
28
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pcm__ladspa_8c.html#4c798b187a7f23c9dfd95f70a59705da">snd_pcm_ladspa_open</a> (<a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> **pcmp, const char *name, const char *ladspa_path, unsigned int channels, <a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *ladspa_pplugins, <a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *ladspa_cplugins, <a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> *slave, int close_slave)</td></tr>
 
29
 
 
30
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new LADSPA&lt;-&gt;ALSA Plugin.  <a href="#4c798b187a7f23c9dfd95f70a59705da"></a><br></td></tr>
 
31
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pcm__ladspa_8c.html#d41af32e75fbc67d15d23fa4ad15d9f1">_snd_pcm_ladspa_open</a> (<a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> **pcmp, const char *name, <a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *root, <a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *conf, <a class="el" href="group___p_c_m.html#g854f0966bd0d7248ed3d9e5c293136ed">snd_pcm_stream_t</a> stream, int mode)</td></tr>
 
32
 
 
33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new LADSPA&lt;-&gt;ALSA PCM.  <a href="#d41af32e75fbc67d15d23fa4ad15d9f1"></a><br></td></tr>
 
34
</tbody></table>
 
35
</p><hr><a name="_details"></a><h2>Detailed Description</h2>
 
36
ALSA Plugin &lt;-&gt; LADSPA Plugin Interface. 
 
37
<p>
 
38
</p><dl class="author" compact="compact"><dt><b>Author:</b></dt><dd>Jaroslav Kysela &lt;<a href="mailto:perex@perex.cz">perex@perex.cz</a>&gt; <p>
 
39
Jaroslav Kysela &lt;<a href="mailto:perex@perex.cz">perex@perex.cz</a>&gt; </p></dd></dl>
 
40
<dl class="date" compact="compact"><dt><b>Date:</b></dt><dd>2001,2006 </dd></dl>
 
41
<hr><h2>Function Documentation</h2>
 
42
<a class="anchor" name="d41af32e75fbc67d15d23fa4ad15d9f1"></a><!-- doxytag: member="pcm_ladspa.c::_snd_pcm_ladspa_open" ref="d41af32e75fbc67d15d23fa4ad15d9f1" args="(snd_pcm_t **pcmp, const char *name, snd_config_t *root, snd_config_t *conf, snd_pcm_stream_t stream, int mode)" -->
 
43
<div class="memitem">
 
44
<div class="memproto">
 
45
      <table class="memname">
 
46
        <tbody><tr>
 
47
          <td class="memname">int _snd_pcm_ladspa_open           </td>
 
48
          <td>(</td>
 
49
          <td class="paramtype"><a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> **&nbsp;</td>
 
50
          <td class="paramname"> <em>pcmp</em>, </td>
 
51
        </tr>
 
52
        <tr>
 
53
          <td class="paramkey"><br>
 
54
</td>
 
55
          <td><br>
 
56
</td>
 
57
          <td class="paramtype">const char *&nbsp;</td>
 
58
          <td class="paramname"> <em>name</em>, </td>
 
59
        </tr>
 
60
        <tr>
 
61
          <td class="paramkey"><br>
 
62
</td>
 
63
          <td><br>
 
64
</td>
 
65
          <td class="paramtype"><a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *&nbsp;</td>
 
66
          <td class="paramname"> <em>root</em>, </td>
 
67
        </tr>
 
68
        <tr>
 
69
          <td class="paramkey"><br>
 
70
</td>
 
71
          <td><br>
 
72
</td>
 
73
          <td class="paramtype"><a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *&nbsp;</td>
 
74
          <td class="paramname"> <em>conf</em>, </td>
 
75
        </tr>
 
76
        <tr>
 
77
          <td class="paramkey"><br>
 
78
</td>
 
79
          <td><br>
 
80
</td>
 
81
          <td class="paramtype"><a class="el" href="group___p_c_m.html#g854f0966bd0d7248ed3d9e5c293136ed">snd_pcm_stream_t</a>&nbsp;</td>
 
82
          <td class="paramname"> <em>stream</em>, </td>
 
83
        </tr>
 
84
        <tr>
 
85
          <td class="paramkey"><br>
 
86
</td>
 
87
          <td><br>
 
88
</td>
 
89
          <td class="paramtype">int&nbsp;</td>
 
90
          <td class="paramname"> <em>mode</em></td><td>&nbsp;</td>
 
91
        </tr>
 
92
        <tr>
 
93
          <td><br>
 
94
</td>
 
95
          <td>)</td>
 
96
          <td><br>
 
97
</td><td><br>
 
98
</td><td width="100%"><br>
 
99
</td>
 
100
        </tr>
 
101
      </tbody></table>
 
102
</div>
 
103
<div class="memdoc">
 
104
 
 
105
<p>
 
106
Creates a new LADSPA&lt;-&gt;ALSA PCM. 
 
107
</p><p>
 
108
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
 
109
  <table border="0" cellpadding="0" cellspacing="2">
 
110
    <tbody><tr><td valign="top"><br>
 
111
</td><td valign="top"><em>pcmp</em>&nbsp;</td><td>Returns created PCM handle </td></tr>
 
112
    <tr><td valign="top"><br>
 
113
</td><td valign="top"><em>name</em>&nbsp;</td><td>Name of PCM </td></tr>
 
114
    <tr><td valign="top"><br>
 
115
</td><td valign="top"><em>root</em>&nbsp;</td><td>Root configuration node </td></tr>
 
116
    <tr><td valign="top"><br>
 
117
</td><td valign="top"><em>conf</em>&nbsp;</td><td>Configuration node with LADSPA&lt;-&gt;ALSA PCM description </td></tr>
 
118
    <tr><td valign="top"><br>
 
119
</td><td valign="top"><em>stream</em>&nbsp;</td><td>Stream type </td></tr>
 
120
    <tr><td valign="top"><br>
 
121
</td><td valign="top"><em>mode</em>&nbsp;</td><td>Stream mode </td></tr>
 
122
  </tbody></table>
 
123
</dd></dl>
 
124
<dl compact="compact"><dt><b>Return values:</b></dt><dd>
 
125
  <table border="0" cellpadding="0" cellspacing="2">
 
126
    <tbody><tr><td valign="top"><br>
 
127
</td><td valign="top"><em>zero</em>&nbsp;</td><td>on success otherwise a negative error code </td></tr>
 
128
  </tbody></table>
 
129
</dd></dl>
 
130
<dl class="warning" compact="compact"><dt><b>Warning:</b></dt><dd>Using
 
131
of this function might be dangerous in the sense of compatibility
 
132
reasons. The prototype might be freely changed in future. </dd></dl>
 
133
 
 
134
</div>
 
135
</div><p>
 
136
<a class="anchor" name="4c798b187a7f23c9dfd95f70a59705da"></a><!-- doxytag: member="pcm_ladspa.c::snd_pcm_ladspa_open" ref="4c798b187a7f23c9dfd95f70a59705da" args="(snd_pcm_t **pcmp, const char *name, const char *ladspa_path, unsigned int channels, snd_config_t *ladspa_pplugins, snd_config_t *ladspa_cplugins, snd_pcm_t *slave, int close_slave)" -->
 
137
</p><div class="memitem">
 
138
<div class="memproto">
 
139
      <table class="memname">
 
140
        <tbody><tr>
 
141
          <td class="memname">int snd_pcm_ladspa_open           </td>
 
142
          <td>(</td>
 
143
          <td class="paramtype"><a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> **&nbsp;</td>
 
144
          <td class="paramname"> <em>pcmp</em>, </td>
 
145
        </tr>
 
146
        <tr>
 
147
          <td class="paramkey"><br>
 
148
</td>
 
149
          <td><br>
 
150
</td>
 
151
          <td class="paramtype">const char *&nbsp;</td>
 
152
          <td class="paramname"> <em>name</em>, </td>
 
153
        </tr>
 
154
        <tr>
 
155
          <td class="paramkey"><br>
 
156
</td>
 
157
          <td><br>
 
158
</td>
 
159
          <td class="paramtype">const char *&nbsp;</td>
 
160
          <td class="paramname"> <em>ladspa_path</em>, </td>
 
161
        </tr>
 
162
        <tr>
 
163
          <td class="paramkey"><br>
 
164
</td>
 
165
          <td><br>
 
166
</td>
 
167
          <td class="paramtype">unsigned int&nbsp;</td>
 
168
          <td class="paramname"> <em>channels</em>, </td>
 
169
        </tr>
 
170
        <tr>
 
171
          <td class="paramkey"><br>
 
172
</td>
 
173
          <td><br>
 
174
</td>
 
175
          <td class="paramtype"><a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *&nbsp;</td>
 
176
          <td class="paramname"> <em>ladspa_pplugins</em>, </td>
 
177
        </tr>
 
178
        <tr>
 
179
          <td class="paramkey"><br>
 
180
</td>
 
181
          <td><br>
 
182
</td>
 
183
          <td class="paramtype"><a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *&nbsp;</td>
 
184
          <td class="paramname"> <em>ladspa_cplugins</em>, </td>
 
185
        </tr>
 
186
        <tr>
 
187
          <td class="paramkey"><br>
 
188
</td>
 
189
          <td><br>
 
190
</td>
 
191
          <td class="paramtype"><a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> *&nbsp;</td>
 
192
          <td class="paramname"> <em>slave</em>, </td>
 
193
        </tr>
 
194
        <tr>
 
195
          <td class="paramkey"><br>
 
196
</td>
 
197
          <td><br>
 
198
</td>
 
199
          <td class="paramtype">int&nbsp;</td>
 
200
          <td class="paramname"> <em>close_slave</em></td><td>&nbsp;</td>
 
201
        </tr>
 
202
        <tr>
 
203
          <td><br>
 
204
</td>
 
205
          <td>)</td>
 
206
          <td><br>
 
207
</td><td><br>
 
208
</td><td width="100%"><br>
 
209
</td>
 
210
        </tr>
 
211
      </tbody></table>
 
212
</div>
 
213
<div class="memdoc">
 
214
 
 
215
<p>
 
216
Creates a new LADSPA&lt;-&gt;ALSA Plugin. 
 
217
</p><p>
 
218
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
 
219
  <table border="0" cellpadding="0" cellspacing="2">
 
220
    <tbody><tr><td valign="top"><br>
 
221
</td><td valign="top"><em>pcmp</em>&nbsp;</td><td>Returns created PCM handle </td></tr>
 
222
    <tr><td valign="top"><br>
 
223
</td><td valign="top"><em>name</em>&nbsp;</td><td>Name of PCM </td></tr>
 
224
    <tr><td valign="top"><br>
 
225
</td><td valign="top"><em>ladspa_path</em>&nbsp;</td><td>The path for LADSPA plugins </td></tr>
 
226
    <tr><td valign="top"><br>
 
227
</td><td valign="top"><em>channels</em>&nbsp;</td><td>Force input channel count to LADSPA plugin chain, 0 = no force (auto) </td></tr>
 
228
    <tr><td valign="top"><br>
 
229
</td><td valign="top"><em>ladspa_pplugins</em>&nbsp;</td><td>The playback configuration </td></tr>
 
230
    <tr><td valign="top"><br>
 
231
</td><td valign="top"><em>ladspa_cplugins</em>&nbsp;</td><td>The capture configuration </td></tr>
 
232
    <tr><td valign="top"><br>
 
233
</td><td valign="top"><em>slave</em>&nbsp;</td><td>Slave PCM handle </td></tr>
 
234
    <tr><td valign="top"><br>
 
235
</td><td valign="top"><em>close_slave</em>&nbsp;</td><td>When set, the slave PCM handle is closed with copy PCM </td></tr>
 
236
  </tbody></table>
 
237
</dd></dl>
 
238
<dl compact="compact"><dt><b>Return values:</b></dt><dd>
 
239
  <table border="0" cellpadding="0" cellspacing="2">
 
240
    <tbody><tr><td valign="top"><br>
 
241
</td><td valign="top"><em>zero</em>&nbsp;</td><td>on success otherwise a negative error code </td></tr>
 
242
  </tbody></table>
 
243
</dd></dl>
 
244
<dl class="warning" compact="compact"><dt><b>Warning:</b></dt><dd>Using
 
245
of this function might be dangerous in the sense of compatibility
 
246
reasons. The prototype might be freely changed in future. </dd></dl>
 
247
 
 
248
</div>
 
249
</div><p>
 
250
</p><hr size="1"><address style=""><small>Generated on Wed Sep 9 14:37:08 2009 for ALSA project - the C library reference by&nbsp;
 
251
<a href="http://www.doxygen.org/index.html">
 
252
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
 
253
</body></html>
 
 
b'\\ No newline at end of file'