~n3npq/lsb/t2c-alsa-tests

1 by Jeff Licquia
Initial version.
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: Debug Functions</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><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
<h1>Debug Functions<br>
18
<small>
19
[<a class="el" href="group___p_c_m.html">PCM Interface</a>]</small>
20
</h1><table border="0" cellpadding="0" cellspacing="0">
21
<tbody><tr><td><br>
22
</td></tr>
23
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
24
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___dump.html#gb7eb3d2a4aa6f3e47ebd1e3833aeb8b7">snd_pcm_dump</a> (<a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> *pcm, <a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *out)</td></tr>
25
26
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dump PCM info.  <a href="#gb7eb3d2a4aa6f3e47ebd1e3833aeb8b7"></a><br></td></tr>
27
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___dump.html#g701b888b6d87820db0a22c8c5a2dd82d">snd_pcm_dump_hw_setup</a> (<a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> *pcm, <a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *out)</td></tr>
28
29
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dump current hardware setup for PCM.  <a href="#g701b888b6d87820db0a22c8c5a2dd82d"></a><br></td></tr>
30
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___dump.html#g9286c0977f1dbf7444b843e823d4206b">snd_pcm_dump_sw_setup</a> (<a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> *pcm, <a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *out)</td></tr>
31
32
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dump current software setup for PCM.  <a href="#g9286c0977f1dbf7444b843e823d4206b"></a><br></td></tr>
33
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___dump.html#gae2eeeb3df99a6d8d35c51c6d02995ef">snd_pcm_dump_setup</a> (<a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> *pcm, <a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *out)</td></tr>
34
35
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dump current setup (hardware and software) for PCM.  <a href="#gae2eeeb3df99a6d8d35c51c6d02995ef"></a><br></td></tr>
36
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___dump.html#g8d808218d13b78178748e152d724e4da">snd_pcm_hw_params_dump</a> (<a class="el" href="group___p_c_m.html#g232a2e2b6bb7bb2dca2885eec2e095b3">snd_pcm_hw_params_t</a> *params, <a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *out)</td></tr>
37
38
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dump a PCM hardware configuration space.  <a href="#g8d808218d13b78178748e152d724e4da"></a><br></td></tr>
39
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___dump.html#g0566466e58d13cae7dafa266979cb237">snd_pcm_sw_params_dump</a> (<a class="el" href="group___p_c_m.html#g999c8c52d8a8d521f1f2cfcd902d7098">snd_pcm_sw_params_t</a> *params, <a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *out)</td></tr>
40
41
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dump a software configuration.  <a href="#g0566466e58d13cae7dafa266979cb237"></a><br></td></tr>
42
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___dump.html#gf369962e048f072363e411cdf9bb27d7">snd_pcm_status_dump</a> (<a class="el" href="group___p_c_m.html#g1f281a9476a599d4f320297e3a07ec79">snd_pcm_status_t</a> *status, <a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *out)</td></tr>
43
44
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dump status.  <a href="#gf369962e048f072363e411cdf9bb27d7"></a><br></td></tr>
45
</tbody></table>
46
<hr><a name="_details"></a><h2>Detailed Description</h2>
47
See the <a class="el" href="pcm.html">PCM (digital audio) interface</a> page for more details. <hr><h2>Function Documentation</h2>
48
<a class="anchor" name="gb7eb3d2a4aa6f3e47ebd1e3833aeb8b7"></a><!-- doxytag: member="pcm.h::snd_pcm_dump" ref="gb7eb3d2a4aa6f3e47ebd1e3833aeb8b7" args="(snd_pcm_t *pcm, snd_output_t *out)" -->
49
<div class="memitem">
50
<div class="memproto">
51
      <table class="memname">
52
        <tbody><tr>
53
          <td class="memname">int snd_pcm_dump           </td>
54
          <td>(</td>
55
          <td class="paramtype"><a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> *&nbsp;</td>
56
          <td class="paramname"> <em>pcm</em>, </td>
57
        </tr>
58
        <tr>
59
          <td class="paramkey"><br>
60
</td>
61
          <td><br>
62
</td>
63
          <td class="paramtype"><a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *&nbsp;</td>
64
          <td class="paramname"> <em>out</em></td><td>&nbsp;</td>
65
        </tr>
66
        <tr>
67
          <td><br>
68
</td>
69
          <td>)</td>
70
          <td><br>
71
</td><td><br>
72
</td><td width="100%"><br>
73
</td>
74
        </tr>
75
      </tbody></table>
76
</div>
77
<div class="memdoc">
78
79
<p>
80
Dump PCM info. 
81
</p><p>
82
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
83
  <table border="0" cellpadding="0" cellspacing="2">
84
    <tbody><tr><td valign="top"><br>
85
</td><td valign="top"><em>pcm</em>&nbsp;</td><td>PCM handle </td></tr>
86
    <tr><td valign="top"><br>
87
</td><td valign="top"><em>out</em>&nbsp;</td><td>Output handle </td></tr>
88
  </tbody></table>
89
</dd></dl>
90
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 on success otherwise a negative error code </dd></dl>
91
<dl compact="compact"><dt><b>Examples: </b></dt><dd>
92
<a class="el" href="_2test_2latency_8c-example.html#a29">/test/latency.c</a>, and <a class="el" href="_2test_2pcm_8c-example.html#a67">/test/pcm.c</a>.</dd></dl>
93
</div>
94
</div><p>
95
<a class="anchor" name="g701b888b6d87820db0a22c8c5a2dd82d"></a><!-- doxytag: member="pcm.h::snd_pcm_dump_hw_setup" ref="g701b888b6d87820db0a22c8c5a2dd82d" args="(snd_pcm_t *pcm, snd_output_t *out)" -->
96
</p><div class="memitem">
97
<div class="memproto">
98
      <table class="memname">
99
        <tbody><tr>
100
          <td class="memname">int snd_pcm_dump_hw_setup           </td>
101
          <td>(</td>
102
          <td class="paramtype"><a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> *&nbsp;</td>
103
          <td class="paramname"> <em>pcm</em>, </td>
104
        </tr>
105
        <tr>
106
          <td class="paramkey"><br>
107
</td>
108
          <td><br>
109
</td>
110
          <td class="paramtype"><a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *&nbsp;</td>
111
          <td class="paramname"> <em>out</em></td><td>&nbsp;</td>
112
        </tr>
113
        <tr>
114
          <td><br>
115
</td>
116
          <td>)</td>
117
          <td><br>
118
</td><td><br>
119
</td><td width="100%"><br>
120
</td>
121
        </tr>
122
      </tbody></table>
123
</div>
124
<div class="memdoc">
125
126
<p>
127
Dump current hardware setup for PCM. 
128
</p><p>
129
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
130
  <table border="0" cellpadding="0" cellspacing="2">
131
    <tbody><tr><td valign="top"><br>
132
</td><td valign="top"><em>pcm</em>&nbsp;</td><td>PCM handle </td></tr>
133
    <tr><td valign="top"><br>
134
</td><td valign="top"><em>out</em>&nbsp;</td><td>Output handle </td></tr>
135
  </tbody></table>
136
</dd></dl>
137
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 on success otherwise a negative error code </dd></dl>
138
139
</div>
140
</div><p>
141
<a class="anchor" name="gae2eeeb3df99a6d8d35c51c6d02995ef"></a><!-- doxytag: member="pcm.h::snd_pcm_dump_setup" ref="gae2eeeb3df99a6d8d35c51c6d02995ef" args="(snd_pcm_t *pcm, snd_output_t *out)" -->
142
</p><div class="memitem">
143
<div class="memproto">
144
      <table class="memname">
145
        <tbody><tr>
146
          <td class="memname">int snd_pcm_dump_setup           </td>
147
          <td>(</td>
148
          <td class="paramtype"><a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> *&nbsp;</td>
149
          <td class="paramname"> <em>pcm</em>, </td>
150
        </tr>
151
        <tr>
152
          <td class="paramkey"><br>
153
</td>
154
          <td><br>
155
</td>
156
          <td class="paramtype"><a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *&nbsp;</td>
157
          <td class="paramname"> <em>out</em></td><td>&nbsp;</td>
158
        </tr>
159
        <tr>
160
          <td><br>
161
</td>
162
          <td>)</td>
163
          <td><br>
164
</td><td><br>
165
</td><td width="100%"><br>
166
</td>
167
        </tr>
168
      </tbody></table>
169
</div>
170
<div class="memdoc">
171
172
<p>
173
Dump current setup (hardware and software) for PCM. 
174
</p><p>
175
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
176
  <table border="0" cellpadding="0" cellspacing="2">
177
    <tbody><tr><td valign="top"><br>
178
</td><td valign="top"><em>pcm</em>&nbsp;</td><td>PCM handle </td></tr>
179
    <tr><td valign="top"><br>
180
</td><td valign="top"><em>out</em>&nbsp;</td><td>Output handle </td></tr>
181
  </tbody></table>
182
</dd></dl>
183
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 on success otherwise a negative error code </dd></dl>
184
185
</div>
186
</div><p>
187
<a class="anchor" name="g9286c0977f1dbf7444b843e823d4206b"></a><!-- doxytag: member="pcm.h::snd_pcm_dump_sw_setup" ref="g9286c0977f1dbf7444b843e823d4206b" args="(snd_pcm_t *pcm, snd_output_t *out)" -->
188
</p><div class="memitem">
189
<div class="memproto">
190
      <table class="memname">
191
        <tbody><tr>
192
          <td class="memname">int snd_pcm_dump_sw_setup           </td>
193
          <td>(</td>
194
          <td class="paramtype"><a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> *&nbsp;</td>
195
          <td class="paramname"> <em>pcm</em>, </td>
196
        </tr>
197
        <tr>
198
          <td class="paramkey"><br>
199
</td>
200
          <td><br>
201
</td>
202
          <td class="paramtype"><a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *&nbsp;</td>
203
          <td class="paramname"> <em>out</em></td><td>&nbsp;</td>
204
        </tr>
205
        <tr>
206
          <td><br>
207
</td>
208
          <td>)</td>
209
          <td><br>
210
</td><td><br>
211
</td><td width="100%"><br>
212
</td>
213
        </tr>
214
      </tbody></table>
215
</div>
216
<div class="memdoc">
217
218
<p>
219
Dump current software setup for PCM. 
220
</p><p>
221
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
222
  <table border="0" cellpadding="0" cellspacing="2">
223
    <tbody><tr><td valign="top"><br>
224
</td><td valign="top"><em>pcm</em>&nbsp;</td><td>PCM handle </td></tr>
225
    <tr><td valign="top"><br>
226
</td><td valign="top"><em>out</em>&nbsp;</td><td>Output handle </td></tr>
227
  </tbody></table>
228
</dd></dl>
229
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 on success otherwise a negative error code </dd></dl>
230
231
</div>
232
</div><p>
233
<a class="anchor" name="g8d808218d13b78178748e152d724e4da"></a><!-- doxytag: member="pcm.h::snd_pcm_hw_params_dump" ref="g8d808218d13b78178748e152d724e4da" args="(snd_pcm_hw_params_t *params, snd_output_t *out)" -->
234
</p><div class="memitem">
235
<div class="memproto">
236
      <table class="memname">
237
        <tbody><tr>
238
          <td class="memname">int snd_pcm_hw_params_dump           </td>
239
          <td>(</td>
240
          <td class="paramtype"><a class="el" href="group___p_c_m.html#g232a2e2b6bb7bb2dca2885eec2e095b3">snd_pcm_hw_params_t</a> *&nbsp;</td>
241
          <td class="paramname"> <em>params</em>, </td>
242
        </tr>
243
        <tr>
244
          <td class="paramkey"><br>
245
</td>
246
          <td><br>
247
</td>
248
          <td class="paramtype"><a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *&nbsp;</td>
249
          <td class="paramname"> <em>out</em></td><td>&nbsp;</td>
250
        </tr>
251
        <tr>
252
          <td><br>
253
</td>
254
          <td>)</td>
255
          <td><br>
256
</td><td><br>
257
</td><td width="100%"><br>
258
</td>
259
        </tr>
260
      </tbody></table>
261
</div>
262
<div class="memdoc">
263
264
<p>
265
Dump a PCM hardware configuration space. 
266
</p><p>
267
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
268
  <table border="0" cellpadding="0" cellspacing="2">
269
    <tbody><tr><td valign="top"><br>
270
</td><td valign="top"><em>params</em>&nbsp;</td><td>Configuration space </td></tr>
271
    <tr><td valign="top"><br>
272
</td><td valign="top"><em>out</em>&nbsp;</td><td>Output handle </td></tr>
273
  </tbody></table>
274
</dd></dl>
275
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 on success otherwise a negative error code </dd></dl>
276
277
</div>
278
</div><p>
279
<a class="anchor" name="gf369962e048f072363e411cdf9bb27d7"></a><!-- doxytag: member="pcm.h::snd_pcm_status_dump" ref="gf369962e048f072363e411cdf9bb27d7" args="(snd_pcm_status_t *status, snd_output_t *out)" -->
280
</p><div class="memitem">
281
<div class="memproto">
282
      <table class="memname">
283
        <tbody><tr>
284
          <td class="memname">int snd_pcm_status_dump           </td>
285
          <td>(</td>
286
          <td class="paramtype"><a class="el" href="group___p_c_m.html#g1f281a9476a599d4f320297e3a07ec79">snd_pcm_status_t</a> *&nbsp;</td>
287
          <td class="paramname"> <em>status</em>, </td>
288
        </tr>
289
        <tr>
290
          <td class="paramkey"><br>
291
</td>
292
          <td><br>
293
</td>
294
          <td class="paramtype"><a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *&nbsp;</td>
295
          <td class="paramname"> <em>out</em></td><td>&nbsp;</td>
296
        </tr>
297
        <tr>
298
          <td><br>
299
</td>
300
          <td>)</td>
301
          <td><br>
302
</td><td><br>
303
</td><td width="100%"><br>
304
</td>
305
        </tr>
306
      </tbody></table>
307
</div>
308
<div class="memdoc">
309
310
<p>
311
Dump status. 
312
</p><p>
313
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
314
  <table border="0" cellpadding="0" cellspacing="2">
315
    <tbody><tr><td valign="top"><br>
316
</td><td valign="top"><em>status</em>&nbsp;</td><td>Status container </td></tr>
317
    <tr><td valign="top"><br>
318
</td><td valign="top"><em>out</em>&nbsp;</td><td>Output handle </td></tr>
319
  </tbody></table>
320
</dd></dl>
321
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 on success otherwise a negative error code </dd></dl>
322
<dl compact="compact"><dt><b>Examples: </b></dt><dd>
323
<a class="el" href="_2test_2latency_8c-example.html#a33">/test/latency.c</a>.</dd></dl>
324
</div>
325
</div><p>
326
<a class="anchor" name="g0566466e58d13cae7dafa266979cb237"></a><!-- doxytag: member="pcm.h::snd_pcm_sw_params_dump" ref="g0566466e58d13cae7dafa266979cb237" args="(snd_pcm_sw_params_t *params, snd_output_t *out)" -->
327
</p><div class="memitem">
328
<div class="memproto">
329
      <table class="memname">
330
        <tbody><tr>
331
          <td class="memname">int snd_pcm_sw_params_dump           </td>
332
          <td>(</td>
333
          <td class="paramtype"><a class="el" href="group___p_c_m.html#g999c8c52d8a8d521f1f2cfcd902d7098">snd_pcm_sw_params_t</a> *&nbsp;</td>
334
          <td class="paramname"> <em>params</em>, </td>
335
        </tr>
336
        <tr>
337
          <td class="paramkey"><br>
338
</td>
339
          <td><br>
340
</td>
341
          <td class="paramtype"><a class="el" href="group___output.html#gfcb4f6ed600e8daf18d5d5d8623dda50">snd_output_t</a> *&nbsp;</td>
342
          <td class="paramname"> <em>out</em></td><td>&nbsp;</td>
343
        </tr>
344
        <tr>
345
          <td><br>
346
</td>
347
          <td>)</td>
348
          <td><br>
349
</td><td><br>
350
</td><td width="100%"><br>
351
</td>
352
        </tr>
353
      </tbody></table>
354
</div>
355
<div class="memdoc">
356
357
<p>
358
Dump a software configuration. 
359
</p><p>
360
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
361
  <table border="0" cellpadding="0" cellspacing="2">
362
    <tbody><tr><td valign="top"><br>
363
</td><td valign="top"><em>params</em>&nbsp;</td><td>Software configuration container </td></tr>
364
    <tr><td valign="top"><br>
365
</td><td valign="top"><em>out</em>&nbsp;</td><td>Output handle </td></tr>
366
  </tbody></table>
367
</dd></dl>
368
<dl class="return" compact="compact"><dt><b>Returns:</b></dt><dd>0 on success otherwise a negative error code </dd></dl>
369
370
</div>
371
</div><p>
372
</p><hr size="1"><address style=""><small>Generated on Wed Sep 9 14:37:09 2009 for ALSA project - the C library reference by&nbsp;
373
<a href="http://www.doxygen.org/index.html">
374
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
375
</body></html>