Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/alsa/pcm.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 69:33d812a61356
1 /**
2 * \file include/pcm.h
3 * \brief Application interface library for the ALSA driver
4 * \author Jaroslav Kysela <perex@perex.cz>
5 * \author Abramo Bagnara <abramo@alsa-project.org>
6 * \author Takashi Iwai <tiwai@suse.de>
7 * \date 1998-2001
8 *
9 * Application interface library for the ALSA driver.
10 * See the \ref pcm page for more details.
11 */
12 /*
13 * This library is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU Lesser General Public License as
15 * published by the Free Software Foundation; either version 2.1 of
16 * the License, or (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License for more details.
22 *
23 * You should have received a copy of the GNU Lesser General Public
24 * License along with this library; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 *
27 */
28
29 #ifndef __ALSA_PCM_H
30 #define __ALSA_PCM_H
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 #include <stdint.h>
37
38 /**
39 * \defgroup PCM PCM Interface
40 * See the \ref pcm page for more details.
41 * \{
42 */
43
44 /** dlsym version for interface entry callback */
45 #define SND_PCM_DLSYM_VERSION _dlsym_pcm_001
46
47 /** PCM generic info container */
48 typedef struct _snd_pcm_info snd_pcm_info_t;
49
50 /** PCM hardware configuration space container
51 *
52 * snd_pcm_hw_params_t is an opaque structure which contains a set of possible
53 * PCM hardware configurations. For example, a given instance might include a
54 * range of buffer sizes, a range of period sizes, and a set of several sample
55 * formats. Some subset of all possible combinations these sets may be valid,
56 * but not necessarily any combination will be valid.
57 *
58 * When a parameter is set or restricted using a snd_pcm_hw_params_set*
59 * function, all of the other ranges will be updated to exclude as many
60 * impossible configurations as possible. Attempting to set a parameter
61 * outside of its acceptable range will result in the function failing
62 * and an error code being returned.
63 */
64 typedef struct _snd_pcm_hw_params snd_pcm_hw_params_t;
65
66 /** PCM software configuration container */
67 typedef struct _snd_pcm_sw_params snd_pcm_sw_params_t;
68 /** PCM status container */
69 typedef struct _snd_pcm_status snd_pcm_status_t;
70 /** PCM access types mask */
71 typedef struct _snd_pcm_access_mask snd_pcm_access_mask_t;
72 /** PCM formats mask */
73 typedef struct _snd_pcm_format_mask snd_pcm_format_mask_t;
74 /** PCM subformats mask */
75 typedef struct _snd_pcm_subformat_mask snd_pcm_subformat_mask_t;
76
77 /** PCM class */
78 typedef enum _snd_pcm_class {
79 /** standard device */
80
81 SND_PCM_CLASS_GENERIC = 0,
82 /** multichannel device */
83 SND_PCM_CLASS_MULTI,
84 /** software modem device */
85 SND_PCM_CLASS_MODEM,
86 /** digitizer device */
87 SND_PCM_CLASS_DIGITIZER,
88 SND_PCM_CLASS_LAST = SND_PCM_CLASS_DIGITIZER
89 } snd_pcm_class_t;
90
91 /** PCM subclass */
92 typedef enum _snd_pcm_subclass {
93 /** subdevices are mixed together */
94 SND_PCM_SUBCLASS_GENERIC_MIX = 0,
95 /** multichannel subdevices are mixed together */
96 SND_PCM_SUBCLASS_MULTI_MIX,
97 SND_PCM_SUBCLASS_LAST = SND_PCM_SUBCLASS_MULTI_MIX
98 } snd_pcm_subclass_t;
99
100 /** PCM stream (direction) */
101 typedef enum _snd_pcm_stream {
102 /** Playback stream */
103 SND_PCM_STREAM_PLAYBACK = 0,
104 /** Capture stream */
105 SND_PCM_STREAM_CAPTURE,
106 SND_PCM_STREAM_LAST = SND_PCM_STREAM_CAPTURE
107 } snd_pcm_stream_t;
108
109 /** PCM access type */
110 typedef enum _snd_pcm_access {
111 /** mmap access with simple interleaved channels */
112 SND_PCM_ACCESS_MMAP_INTERLEAVED = 0,
113 /** mmap access with simple non interleaved channels */
114 SND_PCM_ACCESS_MMAP_NONINTERLEAVED,
115 /** mmap access with complex placement */
116 SND_PCM_ACCESS_MMAP_COMPLEX,
117 /** snd_pcm_readi/snd_pcm_writei access */
118 SND_PCM_ACCESS_RW_INTERLEAVED,
119 /** snd_pcm_readn/snd_pcm_writen access */
120 SND_PCM_ACCESS_RW_NONINTERLEAVED,
121 SND_PCM_ACCESS_LAST = SND_PCM_ACCESS_RW_NONINTERLEAVED
122 } snd_pcm_access_t;
123
124 /** PCM sample format */
125 typedef enum _snd_pcm_format {
126 /** Unknown */
127 SND_PCM_FORMAT_UNKNOWN = -1,
128 /** Signed 8 bit */
129 SND_PCM_FORMAT_S8 = 0,
130 /** Unsigned 8 bit */
131 SND_PCM_FORMAT_U8,
132 /** Signed 16 bit Little Endian */
133 SND_PCM_FORMAT_S16_LE,
134 /** Signed 16 bit Big Endian */
135 SND_PCM_FORMAT_S16_BE,
136 /** Unsigned 16 bit Little Endian */
137 SND_PCM_FORMAT_U16_LE,
138 /** Unsigned 16 bit Big Endian */
139 SND_PCM_FORMAT_U16_BE,
140 /** Signed 24 bit Little Endian using low three bytes in 32-bit word */
141 SND_PCM_FORMAT_S24_LE,
142 /** Signed 24 bit Big Endian using low three bytes in 32-bit word */
143 SND_PCM_FORMAT_S24_BE,
144 /** Unsigned 24 bit Little Endian using low three bytes in 32-bit word */
145 SND_PCM_FORMAT_U24_LE,
146 /** Unsigned 24 bit Big Endian using low three bytes in 32-bit word */
147 SND_PCM_FORMAT_U24_BE,
148 /** Signed 32 bit Little Endian */
149 SND_PCM_FORMAT_S32_LE,
150 /** Signed 32 bit Big Endian */
151 SND_PCM_FORMAT_S32_BE,
152 /** Unsigned 32 bit Little Endian */
153 SND_PCM_FORMAT_U32_LE,
154 /** Unsigned 32 bit Big Endian */
155 SND_PCM_FORMAT_U32_BE,
156 /** Float 32 bit Little Endian, Range -1.0 to 1.0 */
157 SND_PCM_FORMAT_FLOAT_LE,
158 /** Float 32 bit Big Endian, Range -1.0 to 1.0 */
159 SND_PCM_FORMAT_FLOAT_BE,
160 /** Float 64 bit Little Endian, Range -1.0 to 1.0 */
161 SND_PCM_FORMAT_FLOAT64_LE,
162 /** Float 64 bit Big Endian, Range -1.0 to 1.0 */
163 SND_PCM_FORMAT_FLOAT64_BE,
164 /** IEC-958 Little Endian */
165 SND_PCM_FORMAT_IEC958_SUBFRAME_LE,
166 /** IEC-958 Big Endian */
167 SND_PCM_FORMAT_IEC958_SUBFRAME_BE,
168 /** Mu-Law */
169 SND_PCM_FORMAT_MU_LAW,
170 /** A-Law */
171 SND_PCM_FORMAT_A_LAW,
172 /** Ima-ADPCM */
173 SND_PCM_FORMAT_IMA_ADPCM,
174 /** MPEG */
175 SND_PCM_FORMAT_MPEG,
176 /** GSM */
177 SND_PCM_FORMAT_GSM,
178 /** Signed 20bit Little Endian in 4bytes format, LSB justified */
179 SND_PCM_FORMAT_S20_LE,
180 /** Signed 20bit Big Endian in 4bytes format, LSB justified */
181 SND_PCM_FORMAT_S20_BE,
182 /** Unsigned 20bit Little Endian in 4bytes format, LSB justified */
183 SND_PCM_FORMAT_U20_LE,
184 /** Unsigned 20bit Big Endian in 4bytes format, LSB justified */
185 SND_PCM_FORMAT_U20_BE,
186 /** Special */
187 SND_PCM_FORMAT_SPECIAL = 31,
188 /** Signed 24bit Little Endian in 3bytes format */
189 SND_PCM_FORMAT_S24_3LE = 32,
190 /** Signed 24bit Big Endian in 3bytes format */
191 SND_PCM_FORMAT_S24_3BE,
192 /** Unsigned 24bit Little Endian in 3bytes format */
193 SND_PCM_FORMAT_U24_3LE,
194 /** Unsigned 24bit Big Endian in 3bytes format */
195 SND_PCM_FORMAT_U24_3BE,
196 /** Signed 20bit Little Endian in 3bytes format */
197 SND_PCM_FORMAT_S20_3LE,
198 /** Signed 20bit Big Endian in 3bytes format */
199 SND_PCM_FORMAT_S20_3BE,
200 /** Unsigned 20bit Little Endian in 3bytes format */
201 SND_PCM_FORMAT_U20_3LE,
202 /** Unsigned 20bit Big Endian in 3bytes format */
203 SND_PCM_FORMAT_U20_3BE,
204 /** Signed 18bit Little Endian in 3bytes format */
205 SND_PCM_FORMAT_S18_3LE,
206 /** Signed 18bit Big Endian in 3bytes format */
207 SND_PCM_FORMAT_S18_3BE,
208 /** Unsigned 18bit Little Endian in 3bytes format */
209 SND_PCM_FORMAT_U18_3LE,
210 /** Unsigned 18bit Big Endian in 3bytes format */
211 SND_PCM_FORMAT_U18_3BE,
212 /* G.723 (ADPCM) 24 kbit/s, 8 samples in 3 bytes */
213 SND_PCM_FORMAT_G723_24,
214 /* G.723 (ADPCM) 24 kbit/s, 1 sample in 1 byte */
215 SND_PCM_FORMAT_G723_24_1B,
216 /* G.723 (ADPCM) 40 kbit/s, 8 samples in 3 bytes */
217 SND_PCM_FORMAT_G723_40,
218 /* G.723 (ADPCM) 40 kbit/s, 1 sample in 1 byte */
219 SND_PCM_FORMAT_G723_40_1B,
220 /* Direct Stream Digital (DSD) in 1-byte samples (x8) */
221 SND_PCM_FORMAT_DSD_U8,
222 /* Direct Stream Digital (DSD) in 2-byte samples (x16) */
223 SND_PCM_FORMAT_DSD_U16_LE,
224 /* Direct Stream Digital (DSD) in 4-byte samples (x32) */
225 SND_PCM_FORMAT_DSD_U32_LE,
226 /* Direct Stream Digital (DSD) in 2-byte samples (x16) */
227 SND_PCM_FORMAT_DSD_U16_BE,
228 /* Direct Stream Digital (DSD) in 4-byte samples (x32) */
229 SND_PCM_FORMAT_DSD_U32_BE,
230 SND_PCM_FORMAT_LAST = SND_PCM_FORMAT_DSD_U32_BE,
231
232 #if __BYTE_ORDER == __LITTLE_ENDIAN
233 /** Signed 16 bit CPU endian */
234 SND_PCM_FORMAT_S16 = SND_PCM_FORMAT_S16_LE,
235 /** Unsigned 16 bit CPU endian */
236 SND_PCM_FORMAT_U16 = SND_PCM_FORMAT_U16_LE,
237 /** Signed 24 bit CPU endian */
238 SND_PCM_FORMAT_S24 = SND_PCM_FORMAT_S24_LE,
239 /** Unsigned 24 bit CPU endian */
240 SND_PCM_FORMAT_U24 = SND_PCM_FORMAT_U24_LE,
241 /** Signed 32 bit CPU endian */
242 SND_PCM_FORMAT_S32 = SND_PCM_FORMAT_S32_LE,
243 /** Unsigned 32 bit CPU endian */
244 SND_PCM_FORMAT_U32 = SND_PCM_FORMAT_U32_LE,
245 /** Float 32 bit CPU endian */
246 SND_PCM_FORMAT_FLOAT = SND_PCM_FORMAT_FLOAT_LE,
247 /** Float 64 bit CPU endian */
248 SND_PCM_FORMAT_FLOAT64 = SND_PCM_FORMAT_FLOAT64_LE,
249 /** IEC-958 CPU Endian */
250 SND_PCM_FORMAT_IEC958_SUBFRAME = SND_PCM_FORMAT_IEC958_SUBFRAME_LE,
251 /** Signed 20bit in 4bytes format, LSB justified, CPU Endian */
252 SND_PCM_FORMAT_S20 = SND_PCM_FORMAT_S20_LE,
253 /** Unsigned 20bit in 4bytes format, LSB justified, CPU Endian */
254 SND_PCM_FORMAT_U20 = SND_PCM_FORMAT_U20_LE,
255 #elif __BYTE_ORDER == __BIG_ENDIAN
256 /** Signed 16 bit CPU endian */
257 SND_PCM_FORMAT_S16 = SND_PCM_FORMAT_S16_BE,
258 /** Unsigned 16 bit CPU endian */
259 SND_PCM_FORMAT_U16 = SND_PCM_FORMAT_U16_BE,
260 /** Signed 24 bit CPU endian */
261 SND_PCM_FORMAT_S24 = SND_PCM_FORMAT_S24_BE,
262 /** Unsigned 24 bit CPU endian */
263 SND_PCM_FORMAT_U24 = SND_PCM_FORMAT_U24_BE,
264 /** Signed 32 bit CPU endian */
265 SND_PCM_FORMAT_S32 = SND_PCM_FORMAT_S32_BE,
266 /** Unsigned 32 bit CPU endian */
267 SND_PCM_FORMAT_U32 = SND_PCM_FORMAT_U32_BE,
268 /** Float 32 bit CPU endian */
269 SND_PCM_FORMAT_FLOAT = SND_PCM_FORMAT_FLOAT_BE,
270 /** Float 64 bit CPU endian */
271 SND_PCM_FORMAT_FLOAT64 = SND_PCM_FORMAT_FLOAT64_BE,
272 /** IEC-958 CPU Endian */
273 SND_PCM_FORMAT_IEC958_SUBFRAME = SND_PCM_FORMAT_IEC958_SUBFRAME_BE,
274 /** Signed 20bit in 4bytes format, LSB justified, CPU Endian */
275 SND_PCM_FORMAT_S20 = SND_PCM_FORMAT_S20_BE,
276 /** Unsigned 20bit in 4bytes format, LSB justified, CPU Endian */
277 SND_PCM_FORMAT_U20 = SND_PCM_FORMAT_U20_BE,
278 #else
279 #error "Unknown endian"
280 #endif
281 } snd_pcm_format_t;
282
283 /** PCM sample subformat */
284 typedef enum _snd_pcm_subformat {
285 /** Standard */
286 SND_PCM_SUBFORMAT_STD = 0,
287 SND_PCM_SUBFORMAT_LAST = SND_PCM_SUBFORMAT_STD
288 } snd_pcm_subformat_t;
289
290 /** PCM state */
291 typedef enum _snd_pcm_state {
292 /** Open */
293 SND_PCM_STATE_OPEN = 0,
294 /** Setup installed */
295 SND_PCM_STATE_SETUP,
296 /** Ready to start */
297 SND_PCM_STATE_PREPARED,
298 /** Running */
299 SND_PCM_STATE_RUNNING,
300 /** Stopped: underrun (playback) or overrun (capture) detected */
301 SND_PCM_STATE_XRUN,
302 /** Draining: running (playback) or stopped (capture) */
303 SND_PCM_STATE_DRAINING,
304 /** Paused */
305 SND_PCM_STATE_PAUSED,
306 /** Hardware is suspended */
307 SND_PCM_STATE_SUSPENDED,
308 /** Hardware is disconnected */
309 SND_PCM_STATE_DISCONNECTED,
310 SND_PCM_STATE_LAST = SND_PCM_STATE_DISCONNECTED,
311 /** Private - used internally in the library - do not use*/
312 SND_PCM_STATE_PRIVATE1 = 1024
313 } snd_pcm_state_t;
314
315 /** PCM start mode */
316 typedef enum _snd_pcm_start {
317 /** Automatic start on data read/write */
318 SND_PCM_START_DATA = 0,
319 /** Explicit start */
320 SND_PCM_START_EXPLICIT,
321 SND_PCM_START_LAST = SND_PCM_START_EXPLICIT
322 } snd_pcm_start_t;
323
324 /** PCM xrun mode */
325 typedef enum _snd_pcm_xrun {
326 /** Xrun detection disabled */
327 SND_PCM_XRUN_NONE = 0,
328 /** Stop on xrun detection */
329 SND_PCM_XRUN_STOP,
330 SND_PCM_XRUN_LAST = SND_PCM_XRUN_STOP
331 } snd_pcm_xrun_t;
332
333 /** PCM timestamp mode */
334 typedef enum _snd_pcm_tstamp {
335 /** No timestamp */
336 SND_PCM_TSTAMP_NONE = 0,
337 /** Update timestamp at every hardware position update */
338 SND_PCM_TSTAMP_ENABLE,
339 /** Equivalent with #SND_PCM_TSTAMP_ENABLE,
340 * just for compatibility with older versions
341 */
342 SND_PCM_TSTAMP_MMAP = SND_PCM_TSTAMP_ENABLE,
343 SND_PCM_TSTAMP_LAST = SND_PCM_TSTAMP_ENABLE
344 } snd_pcm_tstamp_t;
345
346 typedef enum _snd_pcm_tstamp_type {
347 SND_PCM_TSTAMP_TYPE_GETTIMEOFDAY = 0, /**< gettimeofday equivalent */
348 SND_PCM_TSTAMP_TYPE_MONOTONIC, /**< posix_clock_monotonic equivalent */
349 SND_PCM_TSTAMP_TYPE_MONOTONIC_RAW, /**< monotonic_raw (no NTP) */
350 SND_PCM_TSTAMP_TYPE_LAST = SND_PCM_TSTAMP_TYPE_MONOTONIC_RAW,
351 } snd_pcm_tstamp_type_t;
352
353 typedef struct _snd_pcm_audio_tstamp_config {
354 /* 5 of max 16 bits used */
355 unsigned int type_requested:4;
356 unsigned int report_delay:1; /* add total delay to A/D or D/A */
357 } snd_pcm_audio_tstamp_config_t;
358
359 typedef struct _snd_pcm_audio_tstamp_report {
360 /* 6 of max 16 bits used for bit-fields */
361
362 /* for backwards compatibility */
363 unsigned int valid:1;
364
365 /* actual type if hardware could not support requested timestamp */
366 unsigned int actual_type:4;
367
368 /* accuracy represented in ns units */
369 unsigned int accuracy_report:1; /* 0 if accuracy unknown, 1 if accuracy field is valid */
370 unsigned int accuracy; /* up to 4.29s, will be packed in separate field */
371 } snd_pcm_audio_tstamp_report_t;
372
373 /** Unsigned frames quantity */
374 typedef unsigned long snd_pcm_uframes_t;
375 /** Signed frames quantity */
376 typedef long snd_pcm_sframes_t;
377
378 /** Non blocking mode (flag for open mode) \hideinitializer */
379 #define SND_PCM_NONBLOCK 0x00000001
380 /** Async notification (flag for open mode) \hideinitializer */
381 #define SND_PCM_ASYNC 0x00000002
382 /** In an abort state (internal, not allowed for open) */
383 #define SND_PCM_ABORT 0x00008000
384 /** Disable automatic (but not forced!) rate resamplinig */
385 #define SND_PCM_NO_AUTO_RESAMPLE 0x00010000
386 /** Disable automatic (but not forced!) channel conversion */
387 #define SND_PCM_NO_AUTO_CHANNELS 0x00020000
388 /** Disable automatic (but not forced!) format conversion */
389 #define SND_PCM_NO_AUTO_FORMAT 0x00040000
390 /** Disable soft volume control */
391 #define SND_PCM_NO_SOFTVOL 0x00080000
392
393 /** PCM handle */
394 typedef struct _snd_pcm snd_pcm_t;
395
396 /** PCM type */
397 enum _snd_pcm_type {
398 /** Kernel level PCM */
399 SND_PCM_TYPE_HW = 0,
400 /** Hooked PCM */
401 SND_PCM_TYPE_HOOKS,
402 /** One or more linked PCM with exclusive access to selected
403 channels */
404 SND_PCM_TYPE_MULTI,
405 /** File writing plugin */
406 SND_PCM_TYPE_FILE,
407 /** Null endpoint PCM */
408 SND_PCM_TYPE_NULL,
409 /** Shared memory client PCM */
410 SND_PCM_TYPE_SHM,
411 /** INET client PCM (not yet implemented) */
412 SND_PCM_TYPE_INET,
413 /** Copying plugin */
414 SND_PCM_TYPE_COPY,
415 /** Linear format conversion PCM */
416 SND_PCM_TYPE_LINEAR,
417 /** A-Law format conversion PCM */
418 SND_PCM_TYPE_ALAW,
419 /** Mu-Law format conversion PCM */
420 SND_PCM_TYPE_MULAW,
421 /** IMA-ADPCM format conversion PCM */
422 SND_PCM_TYPE_ADPCM,
423 /** Rate conversion PCM */
424 SND_PCM_TYPE_RATE,
425 /** Attenuated static route PCM */
426 SND_PCM_TYPE_ROUTE,
427 /** Format adjusted PCM */
428 SND_PCM_TYPE_PLUG,
429 /** Sharing PCM */
430 SND_PCM_TYPE_SHARE,
431 /** Meter plugin */
432 SND_PCM_TYPE_METER,
433 /** Mixing PCM */
434 SND_PCM_TYPE_MIX,
435 /** Attenuated dynamic route PCM (not yet implemented) */
436 SND_PCM_TYPE_DROUTE,
437 /** Loopback server plugin (not yet implemented) */
438 SND_PCM_TYPE_LBSERVER,
439 /** Linear Integer <-> Linear Float format conversion PCM */
440 SND_PCM_TYPE_LINEAR_FLOAT,
441 /** LADSPA integration plugin */
442 SND_PCM_TYPE_LADSPA,
443 /** Direct Mixing plugin */
444 SND_PCM_TYPE_DMIX,
445 /** Jack Audio Connection Kit plugin */
446 SND_PCM_TYPE_JACK,
447 /** Direct Snooping plugin */
448 SND_PCM_TYPE_DSNOOP,
449 /** Direct Sharing plugin */
450 SND_PCM_TYPE_DSHARE,
451 /** IEC958 subframe plugin */
452 SND_PCM_TYPE_IEC958,
453 /** Soft volume plugin */
454 SND_PCM_TYPE_SOFTVOL,
455 /** External I/O plugin */
456 SND_PCM_TYPE_IOPLUG,
457 /** External filter plugin */
458 SND_PCM_TYPE_EXTPLUG,
459 /** Mmap-emulation plugin */
460 SND_PCM_TYPE_MMAP_EMUL,
461 SND_PCM_TYPE_LAST = SND_PCM_TYPE_MMAP_EMUL
462 };
463
464 /** PCM type */
465 typedef enum _snd_pcm_type snd_pcm_type_t;
466
467 /** PCM area specification */
468 typedef struct _snd_pcm_channel_area {
469 /** base address of channel samples */
470 void *addr;
471 /** offset to first sample in bits */
472 unsigned int first;
473 /** samples distance in bits */
474 unsigned int step;
475 } snd_pcm_channel_area_t;
476
477 /** PCM synchronization ID */
478 typedef union _snd_pcm_sync_id {
479 /** 8-bit ID */
480 unsigned char id[16];
481 /** 16-bit ID */
482 unsigned short id16[8];
483 /** 32-bit ID */
484 unsigned int id32[4];
485 } snd_pcm_sync_id_t;
486
487 /** #SND_PCM_TYPE_METER scope handle */
488 typedef struct _snd_pcm_scope snd_pcm_scope_t;
489
490 int snd_pcm_open(snd_pcm_t **pcm, const char *name,
491 snd_pcm_stream_t stream, int mode);
492 int snd_pcm_open_lconf(snd_pcm_t **pcm, const char *name,
493 snd_pcm_stream_t stream, int mode,
494 snd_config_t *lconf);
495 int snd_pcm_open_fallback(snd_pcm_t **pcm, snd_config_t *root,
496 const char *name, const char *orig_name,
497 snd_pcm_stream_t stream, int mode);
498
499 int snd_pcm_close(snd_pcm_t *pcm);
500 const char *snd_pcm_name(snd_pcm_t *pcm);
501 snd_pcm_type_t snd_pcm_type(snd_pcm_t *pcm);
502 snd_pcm_stream_t snd_pcm_stream(snd_pcm_t *pcm);
503 int snd_pcm_poll_descriptors_count(snd_pcm_t *pcm);
504 int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space);
505 int snd_pcm_poll_descriptors_revents(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
506 int snd_pcm_nonblock(snd_pcm_t *pcm, int nonblock);
507 static __inline__ int snd_pcm_abort(snd_pcm_t *pcm) { return snd_pcm_nonblock(pcm, 2); }
508 int snd_async_add_pcm_handler(snd_async_handler_t **handler, snd_pcm_t *pcm,
509 snd_async_callback_t callback, void *private_data);
510 snd_pcm_t *snd_async_handler_get_pcm(snd_async_handler_t *handler);
511 int snd_pcm_info(snd_pcm_t *pcm, snd_pcm_info_t *info);
512 int snd_pcm_hw_params_current(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
513 int snd_pcm_hw_params(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
514 int snd_pcm_hw_free(snd_pcm_t *pcm);
515 int snd_pcm_sw_params_current(snd_pcm_t *pcm, snd_pcm_sw_params_t *params);
516 int snd_pcm_sw_params(snd_pcm_t *pcm, snd_pcm_sw_params_t *params);
517 int snd_pcm_prepare(snd_pcm_t *pcm);
518 int snd_pcm_reset(snd_pcm_t *pcm);
519 int snd_pcm_status(snd_pcm_t *pcm, snd_pcm_status_t *status);
520 int snd_pcm_start(snd_pcm_t *pcm);
521 int snd_pcm_drop(snd_pcm_t *pcm);
522 int snd_pcm_drain(snd_pcm_t *pcm);
523 int snd_pcm_pause(snd_pcm_t *pcm, int enable);
524 snd_pcm_state_t snd_pcm_state(snd_pcm_t *pcm);
525 int snd_pcm_hwsync(snd_pcm_t *pcm);
526 int snd_pcm_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *delayp);
527 int snd_pcm_resume(snd_pcm_t *pcm);
528 int snd_pcm_htimestamp(snd_pcm_t *pcm, snd_pcm_uframes_t *avail, snd_htimestamp_t *tstamp);
529 snd_pcm_sframes_t snd_pcm_avail(snd_pcm_t *pcm);
530 snd_pcm_sframes_t snd_pcm_avail_update(snd_pcm_t *pcm);
531 int snd_pcm_avail_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *availp, snd_pcm_sframes_t *delayp);
532 snd_pcm_sframes_t snd_pcm_rewindable(snd_pcm_t *pcm);
533 snd_pcm_sframes_t snd_pcm_rewind(snd_pcm_t *pcm, snd_pcm_uframes_t frames);
534 snd_pcm_sframes_t snd_pcm_forwardable(snd_pcm_t *pcm);
535 snd_pcm_sframes_t snd_pcm_forward(snd_pcm_t *pcm, snd_pcm_uframes_t frames);
536 snd_pcm_sframes_t snd_pcm_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size);
537 snd_pcm_sframes_t snd_pcm_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size);
538 snd_pcm_sframes_t snd_pcm_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
539 snd_pcm_sframes_t snd_pcm_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
540 int snd_pcm_wait(snd_pcm_t *pcm, int timeout);
541
542 int snd_pcm_link(snd_pcm_t *pcm1, snd_pcm_t *pcm2);
543 int snd_pcm_unlink(snd_pcm_t *pcm);
544
545 /** channel mapping API version number */
546 #define SND_CHMAP_API_VERSION ((1 << 16) | (0 << 8) | 1)
547
548 /** channel map list type */
549 enum snd_pcm_chmap_type {
550 SND_CHMAP_TYPE_NONE = 0,/**< unspecified channel position */
551 SND_CHMAP_TYPE_FIXED, /**< fixed channel position */
552 SND_CHMAP_TYPE_VAR, /**< freely swappable channel position */
553 SND_CHMAP_TYPE_PAIRED, /**< pair-wise swappable channel position */
554 SND_CHMAP_TYPE_LAST = SND_CHMAP_TYPE_PAIRED, /**< last entry */
555 };
556
557 /** channel positions */
558 enum snd_pcm_chmap_position {
559 SND_CHMAP_UNKNOWN = 0, /**< unspecified */
560 SND_CHMAP_NA, /**< N/A, silent */
561 SND_CHMAP_MONO, /**< mono stream */
562 SND_CHMAP_FL, /**< front left */
563 SND_CHMAP_FR, /**< front right */
564 SND_CHMAP_RL, /**< rear left */
565 SND_CHMAP_RR, /**< rear right */
566 SND_CHMAP_FC, /**< front center */
567 SND_CHMAP_LFE, /**< LFE */
568 SND_CHMAP_SL, /**< side left */
569 SND_CHMAP_SR, /**< side right */
570 SND_CHMAP_RC, /**< rear center */
571 SND_CHMAP_FLC, /**< front left center */
572 SND_CHMAP_FRC, /**< front right center */
573 SND_CHMAP_RLC, /**< rear left center */
574 SND_CHMAP_RRC, /**< rear right center */
575 SND_CHMAP_FLW, /**< front left wide */
576 SND_CHMAP_FRW, /**< front right wide */
577 SND_CHMAP_FLH, /**< front left high */
578 SND_CHMAP_FCH, /**< front center high */
579 SND_CHMAP_FRH, /**< front right high */
580 SND_CHMAP_TC, /**< top center */
581 SND_CHMAP_TFL, /**< top front left */
582 SND_CHMAP_TFR, /**< top front right */
583 SND_CHMAP_TFC, /**< top front center */
584 SND_CHMAP_TRL, /**< top rear left */
585 SND_CHMAP_TRR, /**< top rear right */
586 SND_CHMAP_TRC, /**< top rear center */
587 SND_CHMAP_TFLC, /**< top front left center */
588 SND_CHMAP_TFRC, /**< top front right center */
589 SND_CHMAP_TSL, /**< top side left */
590 SND_CHMAP_TSR, /**< top side right */
591 SND_CHMAP_LLFE, /**< left LFE */
592 SND_CHMAP_RLFE, /**< right LFE */
593 SND_CHMAP_BC, /**< bottom center */
594 SND_CHMAP_BLC, /**< bottom left center */
595 SND_CHMAP_BRC, /**< bottom right center */
596 SND_CHMAP_LAST = SND_CHMAP_BRC,
597 };
598
599 /** bitmask for channel position */
600 #define SND_CHMAP_POSITION_MASK 0xffff
601
602 /** bit flag indicating the channel is phase inverted */
603 #define SND_CHMAP_PHASE_INVERSE (0x01 << 16)
604 /** bit flag indicating the non-standard channel value */
605 #define SND_CHMAP_DRIVER_SPEC (0x02 << 16)
606
607 /** the channel map header */
608 typedef struct snd_pcm_chmap {
609 unsigned int channels; /**< number of channels */
610 unsigned int pos[0]; /**< channel position array */
611 } snd_pcm_chmap_t;
612
613 /** the header of array items returned from snd_pcm_query_chmaps() */
614 typedef struct snd_pcm_chmap_query {
615 enum snd_pcm_chmap_type type; /**< channel map type */
616 snd_pcm_chmap_t map; /**< available channel map */
617 } snd_pcm_chmap_query_t;
618
619
620 snd_pcm_chmap_query_t **snd_pcm_query_chmaps(snd_pcm_t *pcm);
621 snd_pcm_chmap_query_t **snd_pcm_query_chmaps_from_hw(int card, int dev,
622 int subdev,
623 snd_pcm_stream_t stream);
624 void snd_pcm_free_chmaps(snd_pcm_chmap_query_t **maps);
625 snd_pcm_chmap_t *snd_pcm_get_chmap(snd_pcm_t *pcm);
626 int snd_pcm_set_chmap(snd_pcm_t *pcm, const snd_pcm_chmap_t *map);
627
628 const char *snd_pcm_chmap_type_name(enum snd_pcm_chmap_type val);
629 const char *snd_pcm_chmap_name(enum snd_pcm_chmap_position val);
630 const char *snd_pcm_chmap_long_name(enum snd_pcm_chmap_position val);
631 int snd_pcm_chmap_print(const snd_pcm_chmap_t *map, size_t maxlen, char *buf);
632 unsigned int snd_pcm_chmap_from_string(const char *str);
633 snd_pcm_chmap_t *snd_pcm_chmap_parse_string(const char *str);
634
635 //int snd_pcm_mixer_element(snd_pcm_t *pcm, snd_mixer_t *mixer, snd_mixer_elem_t **elem);
636
637 /*
638 * application helpers - these functions are implemented on top
639 * of the basic API
640 */
641
642 int snd_pcm_recover(snd_pcm_t *pcm, int err, int silent);
643 int snd_pcm_set_params(snd_pcm_t *pcm,
644 snd_pcm_format_t format,
645 snd_pcm_access_t access,
646 unsigned int channels,
647 unsigned int rate,
648 int soft_resample,
649 unsigned int latency);
650 int snd_pcm_get_params(snd_pcm_t *pcm,
651 snd_pcm_uframes_t *buffer_size,
652 snd_pcm_uframes_t *period_size);
653
654 /** \} */
655
656 /**
657 * \defgroup PCM_Info Stream Information
658 * \ingroup PCM
659 * See the \ref pcm page for more details.
660 * \{
661 */
662
663 size_t snd_pcm_info_sizeof(void);
664 /** \hideinitializer
665 * \brief allocate an invalid #snd_pcm_info_t using standard alloca
666 * \param ptr returned pointer
667 */
668 #define snd_pcm_info_alloca(ptr) __snd_alloca(ptr, snd_pcm_info)
669 int snd_pcm_info_malloc(snd_pcm_info_t **ptr);
670 void snd_pcm_info_free(snd_pcm_info_t *obj);
671 void snd_pcm_info_copy(snd_pcm_info_t *dst, const snd_pcm_info_t *src);
672 unsigned int snd_pcm_info_get_device(const snd_pcm_info_t *obj);
673 unsigned int snd_pcm_info_get_subdevice(const snd_pcm_info_t *obj);
674 snd_pcm_stream_t snd_pcm_info_get_stream(const snd_pcm_info_t *obj);
675 int snd_pcm_info_get_card(const snd_pcm_info_t *obj);
676 const char *snd_pcm_info_get_id(const snd_pcm_info_t *obj);
677 const char *snd_pcm_info_get_name(const snd_pcm_info_t *obj);
678 const char *snd_pcm_info_get_subdevice_name(const snd_pcm_info_t *obj);
679 snd_pcm_class_t snd_pcm_info_get_class(const snd_pcm_info_t *obj);
680 snd_pcm_subclass_t snd_pcm_info_get_subclass(const snd_pcm_info_t *obj);
681 unsigned int snd_pcm_info_get_subdevices_count(const snd_pcm_info_t *obj);
682 unsigned int snd_pcm_info_get_subdevices_avail(const snd_pcm_info_t *obj);
683 snd_pcm_sync_id_t snd_pcm_info_get_sync(const snd_pcm_info_t *obj);
684 void snd_pcm_info_set_device(snd_pcm_info_t *obj, unsigned int val);
685 void snd_pcm_info_set_subdevice(snd_pcm_info_t *obj, unsigned int val);
686 void snd_pcm_info_set_stream(snd_pcm_info_t *obj, snd_pcm_stream_t val);
687
688 /** \} */
689
690 /**
691 * \defgroup PCM_HW_Params Hardware Parameters
692 * \ingroup PCM
693 * See the \ref pcm page for more details.
694 * \{
695 */
696
697 int snd_pcm_hw_params_any(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
698
699 int snd_pcm_hw_params_can_mmap_sample_resolution(const snd_pcm_hw_params_t *params);
700 int snd_pcm_hw_params_is_double(const snd_pcm_hw_params_t *params);
701 int snd_pcm_hw_params_is_batch(const snd_pcm_hw_params_t *params);
702 int snd_pcm_hw_params_is_block_transfer(const snd_pcm_hw_params_t *params);
703 int snd_pcm_hw_params_is_monotonic(const snd_pcm_hw_params_t *params);
704 int snd_pcm_hw_params_can_overrange(const snd_pcm_hw_params_t *params);
705 int snd_pcm_hw_params_can_pause(const snd_pcm_hw_params_t *params);
706 int snd_pcm_hw_params_can_resume(const snd_pcm_hw_params_t *params);
707 int snd_pcm_hw_params_is_half_duplex(const snd_pcm_hw_params_t *params);
708 int snd_pcm_hw_params_is_joint_duplex(const snd_pcm_hw_params_t *params);
709 int snd_pcm_hw_params_can_sync_start(const snd_pcm_hw_params_t *params);
710 int snd_pcm_hw_params_can_disable_period_wakeup(const snd_pcm_hw_params_t *params);
711 int snd_pcm_hw_params_supports_audio_wallclock_ts(const snd_pcm_hw_params_t *params); /* deprecated, use audio_ts_type */
712 int snd_pcm_hw_params_supports_audio_ts_type(const snd_pcm_hw_params_t *params, int type);
713 int snd_pcm_hw_params_get_rate_numden(const snd_pcm_hw_params_t *params,
714 unsigned int *rate_num,
715 unsigned int *rate_den);
716 int snd_pcm_hw_params_get_sbits(const snd_pcm_hw_params_t *params);
717 int snd_pcm_hw_params_get_fifo_size(const snd_pcm_hw_params_t *params);
718
719 #if 0
720 typedef struct _snd_pcm_hw_strategy snd_pcm_hw_strategy_t;
721
722 /* choices need to be sorted on ascending badness */
723 typedef struct _snd_pcm_hw_strategy_simple_choices_list {
724 unsigned int value;
725 unsigned int badness;
726 } snd_pcm_hw_strategy_simple_choices_list_t;
727
728 int snd_pcm_hw_params_strategy(snd_pcm_t *pcm, snd_pcm_hw_params_t *params,
729 const snd_pcm_hw_strategy_t *strategy,
730 unsigned int badness_min,
731 unsigned int badness_max);
732
733 void snd_pcm_hw_strategy_free(snd_pcm_hw_strategy_t *strategy);
734 int snd_pcm_hw_strategy_simple(snd_pcm_hw_strategy_t **strategyp,
735 unsigned int badness_min,
736 unsigned int badness_max);
737 int snd_pcm_hw_params_try_explain_failure(snd_pcm_t *pcm,
738 snd_pcm_hw_params_t *fail,
739 snd_pcm_hw_params_t *success,
740 unsigned int depth,
741 snd_output_t *out);
742
743 #endif
744
745 size_t snd_pcm_hw_params_sizeof(void);
746 /** \hideinitializer
747 * \brief allocate an invalid #snd_pcm_hw_params_t using standard alloca
748 * \param ptr returned pointer
749 */
750 #define snd_pcm_hw_params_alloca(ptr) __snd_alloca(ptr, snd_pcm_hw_params)
751 int snd_pcm_hw_params_malloc(snd_pcm_hw_params_t **ptr);
752 void snd_pcm_hw_params_free(snd_pcm_hw_params_t *obj);
753 void snd_pcm_hw_params_copy(snd_pcm_hw_params_t *dst, const snd_pcm_hw_params_t *src);
754
755 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_HW_PARAMS_API)
756
757 int snd_pcm_hw_params_get_access(const snd_pcm_hw_params_t *params, snd_pcm_access_t *_access);
758 int snd_pcm_hw_params_test_access(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t _access);
759 int snd_pcm_hw_params_set_access(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t _access);
760 int snd_pcm_hw_params_set_access_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *_access);
761 int snd_pcm_hw_params_set_access_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *_access);
762 int snd_pcm_hw_params_set_access_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask);
763 int snd_pcm_hw_params_get_access_mask(snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask);
764
765 int snd_pcm_hw_params_get_format(const snd_pcm_hw_params_t *params, snd_pcm_format_t *val);
766 int snd_pcm_hw_params_test_format(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val);
767 int snd_pcm_hw_params_set_format(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val);
768 int snd_pcm_hw_params_set_format_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format);
769 int snd_pcm_hw_params_set_format_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format);
770 int snd_pcm_hw_params_set_format_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask);
771 void snd_pcm_hw_params_get_format_mask(snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask);
772
773 int snd_pcm_hw_params_get_subformat(const snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat);
774 int snd_pcm_hw_params_test_subformat(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat);
775 int snd_pcm_hw_params_set_subformat(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat);
776 int snd_pcm_hw_params_set_subformat_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat);
777 int snd_pcm_hw_params_set_subformat_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat);
778 int snd_pcm_hw_params_set_subformat_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask);
779 void snd_pcm_hw_params_get_subformat_mask(snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask);
780
781 int snd_pcm_hw_params_get_channels(const snd_pcm_hw_params_t *params, unsigned int *val);
782 int snd_pcm_hw_params_get_channels_min(const snd_pcm_hw_params_t *params, unsigned int *val);
783 int snd_pcm_hw_params_get_channels_max(const snd_pcm_hw_params_t *params, unsigned int *val);
784 int snd_pcm_hw_params_test_channels(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
785 int snd_pcm_hw_params_set_channels(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
786 int snd_pcm_hw_params_set_channels_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
787 int snd_pcm_hw_params_set_channels_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
788 int snd_pcm_hw_params_set_channels_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, unsigned int *max);
789 int snd_pcm_hw_params_set_channels_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
790 int snd_pcm_hw_params_set_channels_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
791 int snd_pcm_hw_params_set_channels_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
792
793 int snd_pcm_hw_params_get_rate(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
794 int snd_pcm_hw_params_get_rate_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
795 int snd_pcm_hw_params_get_rate_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
796 int snd_pcm_hw_params_test_rate(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
797 int snd_pcm_hw_params_set_rate(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
798 int snd_pcm_hw_params_set_rate_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
799 int snd_pcm_hw_params_set_rate_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
800 int snd_pcm_hw_params_set_rate_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, int *mindir, unsigned int *max, int *maxdir);
801 int snd_pcm_hw_params_set_rate_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
802 int snd_pcm_hw_params_set_rate_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
803 int snd_pcm_hw_params_set_rate_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
804 int snd_pcm_hw_params_set_rate_resample(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
805 int snd_pcm_hw_params_get_rate_resample(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
806 int snd_pcm_hw_params_set_export_buffer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
807 int snd_pcm_hw_params_get_export_buffer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
808 int snd_pcm_hw_params_set_period_wakeup(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
809 int snd_pcm_hw_params_get_period_wakeup(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
810
811 int snd_pcm_hw_params_get_period_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
812 int snd_pcm_hw_params_get_period_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
813 int snd_pcm_hw_params_get_period_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
814 int snd_pcm_hw_params_test_period_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
815 int snd_pcm_hw_params_set_period_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
816 int snd_pcm_hw_params_set_period_time_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
817 int snd_pcm_hw_params_set_period_time_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
818 int snd_pcm_hw_params_set_period_time_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, int *mindir, unsigned int *max, int *maxdir);
819 int snd_pcm_hw_params_set_period_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
820 int snd_pcm_hw_params_set_period_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
821 int snd_pcm_hw_params_set_period_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
822
823 int snd_pcm_hw_params_get_period_size(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
824 int snd_pcm_hw_params_get_period_size_min(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
825 int snd_pcm_hw_params_get_period_size_max(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
826 int snd_pcm_hw_params_test_period_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val, int dir);
827 int snd_pcm_hw_params_set_period_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val, int dir);
828 int snd_pcm_hw_params_set_period_size_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir);
829 int snd_pcm_hw_params_set_period_size_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir);
830 int snd_pcm_hw_params_set_period_size_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *min, int *mindir, snd_pcm_uframes_t *max, int *maxdir);
831 int snd_pcm_hw_params_set_period_size_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir);
832 int snd_pcm_hw_params_set_period_size_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir);
833 int snd_pcm_hw_params_set_period_size_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val, int *dir);
834 int snd_pcm_hw_params_set_period_size_integer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
835
836 int snd_pcm_hw_params_get_periods(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
837 int snd_pcm_hw_params_get_periods_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
838 int snd_pcm_hw_params_get_periods_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
839 int snd_pcm_hw_params_test_periods(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
840 int snd_pcm_hw_params_set_periods(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
841 int snd_pcm_hw_params_set_periods_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
842 int snd_pcm_hw_params_set_periods_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
843 int snd_pcm_hw_params_set_periods_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, int *mindir, unsigned int *max, int *maxdir);
844 int snd_pcm_hw_params_set_periods_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
845 int snd_pcm_hw_params_set_periods_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
846 int snd_pcm_hw_params_set_periods_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
847 int snd_pcm_hw_params_set_periods_integer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
848
849 int snd_pcm_hw_params_get_buffer_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
850 int snd_pcm_hw_params_get_buffer_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
851 int snd_pcm_hw_params_get_buffer_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
852 int snd_pcm_hw_params_test_buffer_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
853 int snd_pcm_hw_params_set_buffer_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
854 int snd_pcm_hw_params_set_buffer_time_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
855 int snd_pcm_hw_params_set_buffer_time_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
856 int snd_pcm_hw_params_set_buffer_time_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, int *mindir, unsigned int *max, int *maxdir);
857 int snd_pcm_hw_params_set_buffer_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
858 int snd_pcm_hw_params_set_buffer_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
859 int snd_pcm_hw_params_set_buffer_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
860
861 int snd_pcm_hw_params_get_buffer_size(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
862 int snd_pcm_hw_params_get_buffer_size_min(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
863 int snd_pcm_hw_params_get_buffer_size_max(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
864 int snd_pcm_hw_params_test_buffer_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val);
865 int snd_pcm_hw_params_set_buffer_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val);
866 int snd_pcm_hw_params_set_buffer_size_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
867 int snd_pcm_hw_params_set_buffer_size_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
868 int snd_pcm_hw_params_set_buffer_size_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *min, snd_pcm_uframes_t *max);
869 int snd_pcm_hw_params_set_buffer_size_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
870 int snd_pcm_hw_params_set_buffer_size_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
871 int snd_pcm_hw_params_set_buffer_size_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
872
873 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_HW_PARAMS_API */
874
875 int snd_pcm_hw_params_get_min_align(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
876
877 /** \} */
878
879 /**
880 * \defgroup PCM_SW_Params Software Parameters
881 * \ingroup PCM
882 * See the \ref pcm page for more details.
883 * \{
884 */
885
886 size_t snd_pcm_sw_params_sizeof(void);
887 /** \hideinitializer
888 * \brief allocate an invalid #snd_pcm_sw_params_t using standard alloca
889 * \param ptr returned pointer
890 */
891 #define snd_pcm_sw_params_alloca(ptr) __snd_alloca(ptr, snd_pcm_sw_params)
892 int snd_pcm_sw_params_malloc(snd_pcm_sw_params_t **ptr);
893 void snd_pcm_sw_params_free(snd_pcm_sw_params_t *obj);
894 void snd_pcm_sw_params_copy(snd_pcm_sw_params_t *dst, const snd_pcm_sw_params_t *src);
895 int snd_pcm_sw_params_get_boundary(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
896
897 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_SW_PARAMS_API)
898
899 int snd_pcm_sw_params_set_tstamp_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_tstamp_t val);
900 int snd_pcm_sw_params_get_tstamp_mode(const snd_pcm_sw_params_t *params, snd_pcm_tstamp_t *val);
901 int snd_pcm_sw_params_set_tstamp_type(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_tstamp_type_t val);
902 int snd_pcm_sw_params_get_tstamp_type(const snd_pcm_sw_params_t *params, snd_pcm_tstamp_type_t *val);
903 int snd_pcm_sw_params_set_avail_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
904 int snd_pcm_sw_params_get_avail_min(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
905 int snd_pcm_sw_params_set_period_event(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, int val);
906 int snd_pcm_sw_params_get_period_event(const snd_pcm_sw_params_t *params, int *val);
907 int snd_pcm_sw_params_set_start_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
908 int snd_pcm_sw_params_get_start_threshold(const snd_pcm_sw_params_t *paramsm, snd_pcm_uframes_t *val);
909 int snd_pcm_sw_params_set_stop_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
910 int snd_pcm_sw_params_get_stop_threshold(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
911 int snd_pcm_sw_params_set_silence_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
912 int snd_pcm_sw_params_get_silence_threshold(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
913 int snd_pcm_sw_params_set_silence_size(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
914 int snd_pcm_sw_params_get_silence_size(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
915
916 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_SW_PARAMS_API */
917
918 /** \} */
919
920 /* include old API */
921 #ifndef ALSA_LIBRARY_BUILD
922 #if defined(ALSA_PCM_OLD_HW_PARAMS_API) || defined(ALSA_PCM_OLD_SW_PARAMS_API)
923 #include "pcm_old.h"
924 #endif
925 #endif
926
927 /**
928 * \defgroup PCM_Access Access Mask Functions
929 * \ingroup PCM
930 * See the \ref pcm page for more details.
931 * \{
932 */
933
934 size_t snd_pcm_access_mask_sizeof(void);
935 /** \hideinitializer
936 * \brief allocate an empty #snd_pcm_access_mask_t using standard alloca
937 * \param ptr returned pointer
938 */
939 #define snd_pcm_access_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_access_mask)
940 int snd_pcm_access_mask_malloc(snd_pcm_access_mask_t **ptr);
941 void snd_pcm_access_mask_free(snd_pcm_access_mask_t *obj);
942 void snd_pcm_access_mask_copy(snd_pcm_access_mask_t *dst, const snd_pcm_access_mask_t *src);
943 void snd_pcm_access_mask_none(snd_pcm_access_mask_t *mask);
944 void snd_pcm_access_mask_any(snd_pcm_access_mask_t *mask);
945 int snd_pcm_access_mask_test(const snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
946 int snd_pcm_access_mask_empty(const snd_pcm_access_mask_t *mask);
947 void snd_pcm_access_mask_set(snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
948 void snd_pcm_access_mask_reset(snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
949
950 /** \} */
951
952 /**
953 * \defgroup PCM_Format Format Mask Functions
954 * \ingroup PCM
955 * See the \ref pcm page for more details.
956 * \{
957 */
958
959 size_t snd_pcm_format_mask_sizeof(void);
960 /** \hideinitializer
961 * \brief allocate an empty #snd_pcm_format_mask_t using standard alloca
962 * \param ptr returned pointer
963 */
964 #define snd_pcm_format_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_format_mask)
965 int snd_pcm_format_mask_malloc(snd_pcm_format_mask_t **ptr);
966 void snd_pcm_format_mask_free(snd_pcm_format_mask_t *obj);
967 void snd_pcm_format_mask_copy(snd_pcm_format_mask_t *dst, const snd_pcm_format_mask_t *src);
968 void snd_pcm_format_mask_none(snd_pcm_format_mask_t *mask);
969 void snd_pcm_format_mask_any(snd_pcm_format_mask_t *mask);
970 int snd_pcm_format_mask_test(const snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
971 int snd_pcm_format_mask_empty(const snd_pcm_format_mask_t *mask);
972 void snd_pcm_format_mask_set(snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
973 void snd_pcm_format_mask_reset(snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
974
975 /** \} */
976
977 /**
978 * \defgroup PCM_SubFormat Subformat Mask Functions
979 * \ingroup PCM
980 * See the \ref pcm page for more details.
981 * \{
982 */
983
984 size_t snd_pcm_subformat_mask_sizeof(void);
985 /** \hideinitializer
986 * \brief allocate an empty #snd_pcm_subformat_mask_t using standard alloca
987 * \param ptr returned pointer
988 */
989 #define snd_pcm_subformat_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_subformat_mask)
990 int snd_pcm_subformat_mask_malloc(snd_pcm_subformat_mask_t **ptr);
991 void snd_pcm_subformat_mask_free(snd_pcm_subformat_mask_t *obj);
992 void snd_pcm_subformat_mask_copy(snd_pcm_subformat_mask_t *dst, const snd_pcm_subformat_mask_t *src);
993 void snd_pcm_subformat_mask_none(snd_pcm_subformat_mask_t *mask);
994 void snd_pcm_subformat_mask_any(snd_pcm_subformat_mask_t *mask);
995 int snd_pcm_subformat_mask_test(const snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
996 int snd_pcm_subformat_mask_empty(const snd_pcm_subformat_mask_t *mask);
997 void snd_pcm_subformat_mask_set(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
998 void snd_pcm_subformat_mask_reset(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
999
1000 /** \} */
1001
1002 /**
1003 * \defgroup PCM_Status Status Functions
1004 * \ingroup PCM
1005 * See the \ref pcm page for more details.
1006 * \{
1007 */
1008
1009 size_t snd_pcm_status_sizeof(void);
1010 /** \hideinitializer
1011 * \brief allocate an invalid #snd_pcm_status_t using standard alloca
1012 * \param ptr returned pointer
1013 */
1014 #define snd_pcm_status_alloca(ptr) __snd_alloca(ptr, snd_pcm_status)
1015 int snd_pcm_status_malloc(snd_pcm_status_t **ptr);
1016 void snd_pcm_status_free(snd_pcm_status_t *obj);
1017 void snd_pcm_status_copy(snd_pcm_status_t *dst, const snd_pcm_status_t *src);
1018 snd_pcm_state_t snd_pcm_status_get_state(const snd_pcm_status_t *obj);
1019 void snd_pcm_status_get_trigger_tstamp(const snd_pcm_status_t *obj, snd_timestamp_t *ptr);
1020 void snd_pcm_status_get_trigger_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr);
1021 void snd_pcm_status_get_tstamp(const snd_pcm_status_t *obj, snd_timestamp_t *ptr);
1022 void snd_pcm_status_get_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr);
1023 void snd_pcm_status_get_audio_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr);
1024 void snd_pcm_status_get_driver_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr);
1025 void snd_pcm_status_get_audio_htstamp_report(const snd_pcm_status_t *obj,
1026 snd_pcm_audio_tstamp_report_t *audio_tstamp_report);
1027 void snd_pcm_status_set_audio_htstamp_config(snd_pcm_status_t *obj,
1028 snd_pcm_audio_tstamp_config_t *audio_tstamp_config);
1029
1030 static inline void snd_pcm_pack_audio_tstamp_config(unsigned int *data,
1031 snd_pcm_audio_tstamp_config_t *config)
1032 {
1033 *data = config->report_delay;
1034 *data <<= 4;
1035 *data |= config->type_requested;
1036 }
1037
1038 static inline void snd_pcm_unpack_audio_tstamp_report(unsigned int data, unsigned int accuracy,
1039 snd_pcm_audio_tstamp_report_t *report)
1040 {
1041 data >>= 16;
1042 report->valid = data & 1;
1043 report->actual_type = (data >> 1) & 0xF;
1044 report->accuracy_report = (data >> 5) & 1;
1045 report->accuracy = accuracy;
1046 }
1047
1048 snd_pcm_sframes_t snd_pcm_status_get_delay(const snd_pcm_status_t *obj);
1049 snd_pcm_uframes_t snd_pcm_status_get_avail(const snd_pcm_status_t *obj);
1050 snd_pcm_uframes_t snd_pcm_status_get_avail_max(const snd_pcm_status_t *obj);
1051 snd_pcm_uframes_t snd_pcm_status_get_overrange(const snd_pcm_status_t *obj);
1052
1053 /** \} */
1054
1055 /**
1056 * \defgroup PCM_Description Description Functions
1057 * \ingroup PCM
1058 * See the \ref pcm page for more details.
1059 * \{
1060 */
1061
1062 const char *snd_pcm_type_name(snd_pcm_type_t type);
1063 const char *snd_pcm_stream_name(const snd_pcm_stream_t stream);
1064 const char *snd_pcm_access_name(const snd_pcm_access_t _access);
1065 const char *snd_pcm_format_name(const snd_pcm_format_t format);
1066 const char *snd_pcm_format_description(const snd_pcm_format_t format);
1067 const char *snd_pcm_subformat_name(const snd_pcm_subformat_t subformat);
1068 const char *snd_pcm_subformat_description(const snd_pcm_subformat_t subformat);
1069 snd_pcm_format_t snd_pcm_format_value(const char* name);
1070 const char *snd_pcm_tstamp_mode_name(const snd_pcm_tstamp_t mode);
1071 const char *snd_pcm_state_name(const snd_pcm_state_t state);
1072
1073 /** \} */
1074
1075 /**
1076 * \defgroup PCM_Dump Debug Functions
1077 * \ingroup PCM
1078 * See the \ref pcm page for more details.
1079 * \{
1080 */
1081
1082 int snd_pcm_dump(snd_pcm_t *pcm, snd_output_t *out);
1083 int snd_pcm_dump_hw_setup(snd_pcm_t *pcm, snd_output_t *out);
1084 int snd_pcm_dump_sw_setup(snd_pcm_t *pcm, snd_output_t *out);
1085 int snd_pcm_dump_setup(snd_pcm_t *pcm, snd_output_t *out);
1086 int snd_pcm_hw_params_dump(snd_pcm_hw_params_t *params, snd_output_t *out);
1087 int snd_pcm_sw_params_dump(snd_pcm_sw_params_t *params, snd_output_t *out);
1088 int snd_pcm_status_dump(snd_pcm_status_t *status, snd_output_t *out);
1089
1090 /** \} */
1091
1092 /**
1093 * \defgroup PCM_Direct Direct Access (MMAP) Functions
1094 * \ingroup PCM
1095 * See the \ref pcm page for more details.
1096 * \{
1097 */
1098
1099 int snd_pcm_mmap_begin(snd_pcm_t *pcm,
1100 const snd_pcm_channel_area_t **areas,
1101 snd_pcm_uframes_t *offset,
1102 snd_pcm_uframes_t *frames);
1103 snd_pcm_sframes_t snd_pcm_mmap_commit(snd_pcm_t *pcm,
1104 snd_pcm_uframes_t offset,
1105 snd_pcm_uframes_t frames);
1106 snd_pcm_sframes_t snd_pcm_mmap_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size);
1107 snd_pcm_sframes_t snd_pcm_mmap_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size);
1108 snd_pcm_sframes_t snd_pcm_mmap_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
1109 snd_pcm_sframes_t snd_pcm_mmap_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
1110
1111 /** \} */
1112
1113 /**
1114 * \defgroup PCM_Helpers Helper Functions
1115 * \ingroup PCM
1116 * See the \ref pcm page for more details.
1117 * \{
1118 */
1119
1120 int snd_pcm_format_signed(snd_pcm_format_t format);
1121 int snd_pcm_format_unsigned(snd_pcm_format_t format);
1122 int snd_pcm_format_linear(snd_pcm_format_t format);
1123 int snd_pcm_format_float(snd_pcm_format_t format);
1124 int snd_pcm_format_little_endian(snd_pcm_format_t format);
1125 int snd_pcm_format_big_endian(snd_pcm_format_t format);
1126 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1127 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
1128 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
1129 snd_pcm_format_t snd_pcm_build_linear_format(int width, int pwidth, int unsignd, int big_endian);
1130 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1131 uint8_t snd_pcm_format_silence(snd_pcm_format_t format);
1132 uint16_t snd_pcm_format_silence_16(snd_pcm_format_t format);
1133 uint32_t snd_pcm_format_silence_32(snd_pcm_format_t format);
1134 uint64_t snd_pcm_format_silence_64(snd_pcm_format_t format);
1135 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int samples);
1136
1137 snd_pcm_sframes_t snd_pcm_bytes_to_frames(snd_pcm_t *pcm, ssize_t bytes);
1138 ssize_t snd_pcm_frames_to_bytes(snd_pcm_t *pcm, snd_pcm_sframes_t frames);
1139 long snd_pcm_bytes_to_samples(snd_pcm_t *pcm, ssize_t bytes);
1140 ssize_t snd_pcm_samples_to_bytes(snd_pcm_t *pcm, long samples);
1141
1142 int snd_pcm_area_silence(const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset,
1143 unsigned int samples, snd_pcm_format_t format);
1144 int snd_pcm_areas_silence(const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset,
1145 unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format);
1146 int snd_pcm_area_copy(const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset,
1147 const snd_pcm_channel_area_t *src_channel, snd_pcm_uframes_t src_offset,
1148 unsigned int samples, snd_pcm_format_t format);
1149 int snd_pcm_areas_copy(const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset,
1150 const snd_pcm_channel_area_t *src_channels, snd_pcm_uframes_t src_offset,
1151 unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format);
1152 int snd_pcm_areas_copy_wrap(const snd_pcm_channel_area_t *dst_channels,
1153 snd_pcm_uframes_t dst_offset,
1154 const snd_pcm_uframes_t dst_size,
1155 const snd_pcm_channel_area_t *src_channels,
1156 snd_pcm_uframes_t src_offset,
1157 const snd_pcm_uframes_t src_size,
1158 const unsigned int channels,
1159 snd_pcm_uframes_t frames,
1160 const snd_pcm_format_t format);
1161
1162 /** \} */
1163
1164 /**
1165 * \defgroup PCM_Hook Hook Extension
1166 * \ingroup PCM
1167 * See the \ref pcm page for more details.
1168 * \{
1169 */
1170
1171 /** type of pcm hook */
1172 typedef enum _snd_pcm_hook_type {
1173 SND_PCM_HOOK_TYPE_HW_PARAMS = 0,
1174 SND_PCM_HOOK_TYPE_HW_FREE,
1175 SND_PCM_HOOK_TYPE_CLOSE,
1176 SND_PCM_HOOK_TYPE_LAST = SND_PCM_HOOK_TYPE_CLOSE
1177 } snd_pcm_hook_type_t;
1178
1179 /** PCM hook container */
1180 typedef struct _snd_pcm_hook snd_pcm_hook_t;
1181 /** PCM hook callback function */
1182 typedef int (*snd_pcm_hook_func_t)(snd_pcm_hook_t *hook);
1183 snd_pcm_t *snd_pcm_hook_get_pcm(snd_pcm_hook_t *hook);
1184 void *snd_pcm_hook_get_private(snd_pcm_hook_t *hook);
1185 void snd_pcm_hook_set_private(snd_pcm_hook_t *hook, void *private_data);
1186 int snd_pcm_hook_add(snd_pcm_hook_t **hookp, snd_pcm_t *pcm,
1187 snd_pcm_hook_type_t type,
1188 snd_pcm_hook_func_t func, void *private_data);
1189 int snd_pcm_hook_remove(snd_pcm_hook_t *hook);
1190
1191 /** \} */
1192
1193 /**
1194 * \defgroup PCM_Scope Scope Plugin Extension
1195 * \ingroup PCM
1196 * See the \ref pcm page for more details.
1197 * \{
1198 */
1199
1200 /** #SND_PCM_TYPE_METER scope functions */
1201 typedef struct _snd_pcm_scope_ops {
1202 /** \brief Enable and prepare it using current params
1203 * \param scope scope handle
1204 */
1205 int (*enable)(snd_pcm_scope_t *scope);
1206 /** \brief Disable
1207 * \param scope scope handle
1208 */
1209 void (*disable)(snd_pcm_scope_t *scope);
1210 /** \brief PCM has been started
1211 * \param scope scope handle
1212 */
1213 void (*start)(snd_pcm_scope_t *scope);
1214 /** \brief PCM has been stopped
1215 * \param scope scope handle
1216 */
1217 void (*stop)(snd_pcm_scope_t *scope);
1218 /** \brief New frames are present
1219 * \param scope scope handle
1220 */
1221 void (*update)(snd_pcm_scope_t *scope);
1222 /** \brief Reset status
1223 * \param scope scope handle
1224 */
1225 void (*reset)(snd_pcm_scope_t *scope);
1226 /** \brief PCM is closing
1227 * \param scope scope handle
1228 */
1229 void (*close)(snd_pcm_scope_t *scope);
1230 } snd_pcm_scope_ops_t;
1231
1232 snd_pcm_uframes_t snd_pcm_meter_get_bufsize(snd_pcm_t *pcm);
1233 unsigned int snd_pcm_meter_get_channels(snd_pcm_t *pcm);
1234 unsigned int snd_pcm_meter_get_rate(snd_pcm_t *pcm);
1235 snd_pcm_uframes_t snd_pcm_meter_get_now(snd_pcm_t *pcm);
1236 snd_pcm_uframes_t snd_pcm_meter_get_boundary(snd_pcm_t *pcm);
1237 int snd_pcm_meter_add_scope(snd_pcm_t *pcm, snd_pcm_scope_t *scope);
1238 snd_pcm_scope_t *snd_pcm_meter_search_scope(snd_pcm_t *pcm, const char *name);
1239 int snd_pcm_scope_malloc(snd_pcm_scope_t **ptr);
1240 void snd_pcm_scope_set_ops(snd_pcm_scope_t *scope,
1241 const snd_pcm_scope_ops_t *val);
1242 void snd_pcm_scope_set_name(snd_pcm_scope_t *scope, const char *val);
1243 const char *snd_pcm_scope_get_name(snd_pcm_scope_t *scope);
1244 void *snd_pcm_scope_get_callback_private(snd_pcm_scope_t *scope);
1245 void snd_pcm_scope_set_callback_private(snd_pcm_scope_t *scope, void *val);
1246 int snd_pcm_scope_s16_open(snd_pcm_t *pcm, const char *name,
1247 snd_pcm_scope_t **scopep);
1248 int16_t *snd_pcm_scope_s16_get_channel_buffer(snd_pcm_scope_t *scope,
1249 unsigned int channel);
1250
1251 /** \} */
1252
1253 /**
1254 * \defgroup PCM_Simple Simple setup functions
1255 * \ingroup PCM
1256 * See the \ref pcm page for more details.
1257 * \{
1258 */
1259
1260 /** Simple PCM latency type */
1261 typedef enum _snd_spcm_latency {
1262 /** standard latency - for standard playback or capture
1263 (estimated latency in one direction 350ms) */
1264 SND_SPCM_LATENCY_STANDARD = 0,
1265 /** medium latency - software phones etc.
1266 (estimated latency in one direction maximally 25ms */
1267 SND_SPCM_LATENCY_MEDIUM,
1268 /** realtime latency - realtime applications (effect processors etc.)
1269 (estimated latency in one direction 5ms and better) */
1270 SND_SPCM_LATENCY_REALTIME
1271 } snd_spcm_latency_t;
1272
1273 /** Simple PCM xrun type */
1274 typedef enum _snd_spcm_xrun_type {
1275 /** driver / library will ignore all xruns, the stream runs forever */
1276 SND_SPCM_XRUN_IGNORE = 0,
1277 /** driver / library stops the stream when an xrun occurs */
1278 SND_SPCM_XRUN_STOP
1279 } snd_spcm_xrun_type_t;
1280
1281 /** Simple PCM duplex type */
1282 typedef enum _snd_spcm_duplex_type {
1283 /** liberal duplex - the buffer and period sizes might not match */
1284 SND_SPCM_DUPLEX_LIBERAL = 0,
1285 /** pedantic duplex - the buffer and period sizes MUST match */
1286 SND_SPCM_DUPLEX_PEDANTIC
1287 } snd_spcm_duplex_type_t;
1288
1289 int snd_spcm_init(snd_pcm_t *pcm,
1290 unsigned int rate,
1291 unsigned int channels,
1292 snd_pcm_format_t format,
1293 snd_pcm_subformat_t subformat,
1294 snd_spcm_latency_t latency,
1295 snd_pcm_access_t _access,
1296 snd_spcm_xrun_type_t xrun_type);
1297
1298 int snd_spcm_init_duplex(snd_pcm_t *playback_pcm,
1299 snd_pcm_t *capture_pcm,
1300 unsigned int rate,
1301 unsigned int channels,
1302 snd_pcm_format_t format,
1303 snd_pcm_subformat_t subformat,
1304 snd_spcm_latency_t latency,
1305 snd_pcm_access_t _access,
1306 snd_spcm_xrun_type_t xrun_type,
1307 snd_spcm_duplex_type_t duplex_type);
1308
1309 int snd_spcm_init_get_params(snd_pcm_t *pcm,
1310 unsigned int *rate,
1311 snd_pcm_uframes_t *buffer_size,
1312 snd_pcm_uframes_t *period_size);
1313
1314 /** \} */
1315
1316 /**
1317 * \defgroup PCM_Deprecated Deprecated Functions
1318 * \ingroup PCM
1319 * See the \ref pcm page for more details.
1320 * \{
1321 */
1322
1323 /* Deprecated functions, for compatibility */
1324 const char *snd_pcm_start_mode_name(snd_pcm_start_t mode) __attribute__((deprecated));
1325 const char *snd_pcm_xrun_mode_name(snd_pcm_xrun_t mode) __attribute__((deprecated));
1326 int snd_pcm_sw_params_set_start_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_start_t val) __attribute__((deprecated));
1327 snd_pcm_start_t snd_pcm_sw_params_get_start_mode(const snd_pcm_sw_params_t *params) __attribute__((deprecated));
1328 int snd_pcm_sw_params_set_xrun_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_xrun_t val) __attribute__((deprecated));
1329 snd_pcm_xrun_t snd_pcm_sw_params_get_xrun_mode(const snd_pcm_sw_params_t *params) __attribute__((deprecated));
1330 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_SW_PARAMS_API)
1331 int snd_pcm_sw_params_set_xfer_align(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val) __attribute__((deprecated));
1332 int snd_pcm_sw_params_get_xfer_align(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val) __attribute__((deprecated));
1333 int snd_pcm_sw_params_set_sleep_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, unsigned int val) __attribute__((deprecated));
1334 int snd_pcm_sw_params_get_sleep_min(const snd_pcm_sw_params_t *params, unsigned int *val) __attribute__((deprecated));
1335 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_SW_PARAMS_API */
1336 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_HW_PARAMS_API)
1337 int snd_pcm_hw_params_get_tick_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1338 int snd_pcm_hw_params_get_tick_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1339 int snd_pcm_hw_params_get_tick_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1340 int snd_pcm_hw_params_test_tick_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir) __attribute__((deprecated));
1341 int snd_pcm_hw_params_set_tick_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir) __attribute__((deprecated));
1342 int snd_pcm_hw_params_set_tick_time_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1343 int snd_pcm_hw_params_set_tick_time_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1344 int snd_pcm_hw_params_set_tick_time_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, int *mindir, unsigned int *max, int *maxdir) __attribute__((deprecated));
1345 int snd_pcm_hw_params_set_tick_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1346 int snd_pcm_hw_params_set_tick_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1347 int snd_pcm_hw_params_set_tick_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1348 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_HW_PARAMS_API */
1349
1350 /** \} */
1351
1352 #ifdef __cplusplus
1353 }
1354 #endif
1355
1356 #endif /* __ALSA_PCM_H */