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 enum _snd_pcm_audio_tstamp_type {
354 /**
355 * first definition for backwards compatibility only,
356 * maps to wallclock/link time for HDAudio playback and DEFAULT/DMA time for everything else
357 */
358 SND_PCM_AUDIO_TSTAMP_TYPE_COMPAT = 0,
359 SND_PCM_AUDIO_TSTAMP_TYPE_DEFAULT = 1, /**< DMA time, reported as per hw_ptr */
360 SND_PCM_AUDIO_TSTAMP_TYPE_LINK = 2, /**< link time reported by sample or wallclock counter, reset on startup */
361 SND_PCM_AUDIO_TSTAMP_TYPE_LINK_ABSOLUTE = 3, /**< link time reported by sample or wallclock counter, not reset on startup */
362 SND_PCM_AUDIO_TSTAMP_TYPE_LINK_ESTIMATED = 4, /**< link time estimated indirectly */
363 SND_PCM_AUDIO_TSTAMP_TYPE_LINK_SYNCHRONIZED = 5, /**< link time synchronized with system time */
364 SND_PCM_AUDIO_TSTAMP_TYPE_LAST = SND_PCM_AUDIO_TSTAMP_TYPE_LINK_SYNCHRONIZED
365 } snd_pcm_audio_tstamp_type_t;
366
367 typedef struct _snd_pcm_audio_tstamp_config {
368 /* 5 of max 16 bits used */
369 unsigned int type_requested:4;
370 unsigned int report_delay:1; /* add total delay to A/D or D/A */
371 } snd_pcm_audio_tstamp_config_t;
372
373 typedef struct _snd_pcm_audio_tstamp_report {
374 /* 6 of max 16 bits used for bit-fields */
375
376 /* for backwards compatibility */
377 unsigned int valid:1;
378
379 /* actual type if hardware could not support requested timestamp */
380 unsigned int actual_type:4;
381
382 /* accuracy represented in ns units */
383 unsigned int accuracy_report:1; /* 0 if accuracy unknown, 1 if accuracy field is valid */
384 unsigned int accuracy; /* up to 4.29s, will be packed in separate field */
385 } snd_pcm_audio_tstamp_report_t;
386
387 /** Unsigned frames quantity */
388 typedef unsigned long snd_pcm_uframes_t;
389 /** Signed frames quantity */
390 typedef long snd_pcm_sframes_t;
391
392 /** Non blocking mode (flag for open mode) \hideinitializer */
393 #define SND_PCM_NONBLOCK 0x00000001
394 /** Async notification (flag for open mode) \hideinitializer */
395 #define SND_PCM_ASYNC 0x00000002
396 /** In an abort state (internal, not allowed for open) */
397 #define SND_PCM_ABORT 0x00008000
398 /** Disable automatic (but not forced!) rate resamplinig */
399 #define SND_PCM_NO_AUTO_RESAMPLE 0x00010000
400 /** Disable automatic (but not forced!) channel conversion */
401 #define SND_PCM_NO_AUTO_CHANNELS 0x00020000
402 /** Disable automatic (but not forced!) format conversion */
403 #define SND_PCM_NO_AUTO_FORMAT 0x00040000
404 /** Disable soft volume control */
405 #define SND_PCM_NO_SOFTVOL 0x00080000
406
407 /** PCM handle */
408 typedef struct _snd_pcm snd_pcm_t;
409
410 /** PCM type */
411 enum _snd_pcm_type {
412 /** Kernel level PCM */
413 SND_PCM_TYPE_HW = 0,
414 /** Hooked PCM */
415 SND_PCM_TYPE_HOOKS,
416 /** One or more linked PCM with exclusive access to selected
417 channels */
418 SND_PCM_TYPE_MULTI,
419 /** File writing plugin */
420 SND_PCM_TYPE_FILE,
421 /** Null endpoint PCM */
422 SND_PCM_TYPE_NULL,
423 /** Shared memory client PCM */
424 SND_PCM_TYPE_SHM,
425 /** INET client PCM (not yet implemented) */
426 SND_PCM_TYPE_INET,
427 /** Copying plugin */
428 SND_PCM_TYPE_COPY,
429 /** Linear format conversion PCM */
430 SND_PCM_TYPE_LINEAR,
431 /** A-Law format conversion PCM */
432 SND_PCM_TYPE_ALAW,
433 /** Mu-Law format conversion PCM */
434 SND_PCM_TYPE_MULAW,
435 /** IMA-ADPCM format conversion PCM */
436 SND_PCM_TYPE_ADPCM,
437 /** Rate conversion PCM */
438 SND_PCM_TYPE_RATE,
439 /** Attenuated static route PCM */
440 SND_PCM_TYPE_ROUTE,
441 /** Format adjusted PCM */
442 SND_PCM_TYPE_PLUG,
443 /** Sharing PCM */
444 SND_PCM_TYPE_SHARE,
445 /** Meter plugin */
446 SND_PCM_TYPE_METER,
447 /** Mixing PCM */
448 SND_PCM_TYPE_MIX,
449 /** Attenuated dynamic route PCM (not yet implemented) */
450 SND_PCM_TYPE_DROUTE,
451 /** Loopback server plugin (not yet implemented) */
452 SND_PCM_TYPE_LBSERVER,
453 /** Linear Integer <-> Linear Float format conversion PCM */
454 SND_PCM_TYPE_LINEAR_FLOAT,
455 /** LADSPA integration plugin */
456 SND_PCM_TYPE_LADSPA,
457 /** Direct Mixing plugin */
458 SND_PCM_TYPE_DMIX,
459 /** Jack Audio Connection Kit plugin */
460 SND_PCM_TYPE_JACK,
461 /** Direct Snooping plugin */
462 SND_PCM_TYPE_DSNOOP,
463 /** Direct Sharing plugin */
464 SND_PCM_TYPE_DSHARE,
465 /** IEC958 subframe plugin */
466 SND_PCM_TYPE_IEC958,
467 /** Soft volume plugin */
468 SND_PCM_TYPE_SOFTVOL,
469 /** External I/O plugin */
470 SND_PCM_TYPE_IOPLUG,
471 /** External filter plugin */
472 SND_PCM_TYPE_EXTPLUG,
473 /** Mmap-emulation plugin */
474 SND_PCM_TYPE_MMAP_EMUL,
475 SND_PCM_TYPE_LAST = SND_PCM_TYPE_MMAP_EMUL
476 };
477
478 /** PCM type */
479 typedef enum _snd_pcm_type snd_pcm_type_t;
480
481 /** PCM area specification */
482 typedef struct _snd_pcm_channel_area {
483 /** base address of channel samples */
484 void *addr;
485 /** offset to first sample in bits */
486 unsigned int first;
487 /** samples distance in bits */
488 unsigned int step;
489 } snd_pcm_channel_area_t;
490
491 /** PCM synchronization ID */
492 typedef union _snd_pcm_sync_id {
493 /** 8-bit ID */
494 unsigned char id[16];
495 /** 16-bit ID */
496 unsigned short id16[8];
497 /** 32-bit ID */
498 unsigned int id32[4];
499 } snd_pcm_sync_id_t;
500
501 /** #SND_PCM_TYPE_METER scope handle */
502 typedef struct _snd_pcm_scope snd_pcm_scope_t;
503
504 int snd_pcm_open(snd_pcm_t **pcm, const char *name,
505 snd_pcm_stream_t stream, int mode);
506 int snd_pcm_open_lconf(snd_pcm_t **pcm, const char *name,
507 snd_pcm_stream_t stream, int mode,
508 snd_config_t *lconf);
509 int snd_pcm_open_fallback(snd_pcm_t **pcm, snd_config_t *root,
510 const char *name, const char *orig_name,
511 snd_pcm_stream_t stream, int mode);
512
513 int snd_pcm_close(snd_pcm_t *pcm);
514 const char *snd_pcm_name(snd_pcm_t *pcm);
515 snd_pcm_type_t snd_pcm_type(snd_pcm_t *pcm);
516 snd_pcm_stream_t snd_pcm_stream(snd_pcm_t *pcm);
517 int snd_pcm_poll_descriptors_count(snd_pcm_t *pcm);
518 int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space);
519 int snd_pcm_poll_descriptors_revents(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
520 int snd_pcm_nonblock(snd_pcm_t *pcm, int nonblock);
snd_pcm_abort(snd_pcm_t * pcm)521 static __inline__ int snd_pcm_abort(snd_pcm_t *pcm) { return snd_pcm_nonblock(pcm, 2); }
522 int snd_async_add_pcm_handler(snd_async_handler_t **handler, snd_pcm_t *pcm,
523 snd_async_callback_t callback, void *private_data);
524 snd_pcm_t *snd_async_handler_get_pcm(snd_async_handler_t *handler);
525 int snd_pcm_info(snd_pcm_t *pcm, snd_pcm_info_t *info);
526 int snd_pcm_hw_params_current(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
527 int snd_pcm_hw_params(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
528 int snd_pcm_hw_free(snd_pcm_t *pcm);
529 int snd_pcm_sw_params_current(snd_pcm_t *pcm, snd_pcm_sw_params_t *params);
530 int snd_pcm_sw_params(snd_pcm_t *pcm, snd_pcm_sw_params_t *params);
531 int snd_pcm_prepare(snd_pcm_t *pcm);
532 int snd_pcm_reset(snd_pcm_t *pcm);
533 int snd_pcm_status(snd_pcm_t *pcm, snd_pcm_status_t *status);
534 int snd_pcm_start(snd_pcm_t *pcm);
535 int snd_pcm_drop(snd_pcm_t *pcm);
536 int snd_pcm_drain(snd_pcm_t *pcm);
537 int snd_pcm_pause(snd_pcm_t *pcm, int enable);
538 snd_pcm_state_t snd_pcm_state(snd_pcm_t *pcm);
539 int snd_pcm_hwsync(snd_pcm_t *pcm);
540 int snd_pcm_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *delayp);
541 int snd_pcm_resume(snd_pcm_t *pcm);
542 int snd_pcm_htimestamp(snd_pcm_t *pcm, snd_pcm_uframes_t *avail, snd_htimestamp_t *tstamp);
543 snd_pcm_sframes_t snd_pcm_avail(snd_pcm_t *pcm);
544 snd_pcm_sframes_t snd_pcm_avail_update(snd_pcm_t *pcm);
545 int snd_pcm_avail_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *availp, snd_pcm_sframes_t *delayp);
546 snd_pcm_sframes_t snd_pcm_rewindable(snd_pcm_t *pcm);
547 snd_pcm_sframes_t snd_pcm_rewind(snd_pcm_t *pcm, snd_pcm_uframes_t frames);
548 snd_pcm_sframes_t snd_pcm_forwardable(snd_pcm_t *pcm);
549 snd_pcm_sframes_t snd_pcm_forward(snd_pcm_t *pcm, snd_pcm_uframes_t frames);
550 snd_pcm_sframes_t snd_pcm_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size);
551 snd_pcm_sframes_t snd_pcm_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size);
552 snd_pcm_sframes_t snd_pcm_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
553 snd_pcm_sframes_t snd_pcm_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
554 int snd_pcm_wait(snd_pcm_t *pcm, int timeout);
555
556 int snd_pcm_link(snd_pcm_t *pcm1, snd_pcm_t *pcm2);
557 int snd_pcm_unlink(snd_pcm_t *pcm);
558
559 /** channel mapping API version number */
560 #define SND_CHMAP_API_VERSION ((1 << 16) | (0 << 8) | 1)
561
562 /** channel map list type */
563 enum snd_pcm_chmap_type {
564 SND_CHMAP_TYPE_NONE = 0,/**< unspecified channel position */
565 SND_CHMAP_TYPE_FIXED, /**< fixed channel position */
566 SND_CHMAP_TYPE_VAR, /**< freely swappable channel position */
567 SND_CHMAP_TYPE_PAIRED, /**< pair-wise swappable channel position */
568 SND_CHMAP_TYPE_LAST = SND_CHMAP_TYPE_PAIRED, /**< last entry */
569 };
570
571 /** channel positions */
572 enum snd_pcm_chmap_position {
573 SND_CHMAP_UNKNOWN = 0, /**< unspecified */
574 SND_CHMAP_NA, /**< N/A, silent */
575 SND_CHMAP_MONO, /**< mono stream */
576 SND_CHMAP_FL, /**< front left */
577 SND_CHMAP_FR, /**< front right */
578 SND_CHMAP_RL, /**< rear left */
579 SND_CHMAP_RR, /**< rear right */
580 SND_CHMAP_FC, /**< front center */
581 SND_CHMAP_LFE, /**< LFE */
582 SND_CHMAP_SL, /**< side left */
583 SND_CHMAP_SR, /**< side right */
584 SND_CHMAP_RC, /**< rear center */
585 SND_CHMAP_FLC, /**< front left center */
586 SND_CHMAP_FRC, /**< front right center */
587 SND_CHMAP_RLC, /**< rear left center */
588 SND_CHMAP_RRC, /**< rear right center */
589 SND_CHMAP_FLW, /**< front left wide */
590 SND_CHMAP_FRW, /**< front right wide */
591 SND_CHMAP_FLH, /**< front left high */
592 SND_CHMAP_FCH, /**< front center high */
593 SND_CHMAP_FRH, /**< front right high */
594 SND_CHMAP_TC, /**< top center */
595 SND_CHMAP_TFL, /**< top front left */
596 SND_CHMAP_TFR, /**< top front right */
597 SND_CHMAP_TFC, /**< top front center */
598 SND_CHMAP_TRL, /**< top rear left */
599 SND_CHMAP_TRR, /**< top rear right */
600 SND_CHMAP_TRC, /**< top rear center */
601 SND_CHMAP_TFLC, /**< top front left center */
602 SND_CHMAP_TFRC, /**< top front right center */
603 SND_CHMAP_TSL, /**< top side left */
604 SND_CHMAP_TSR, /**< top side right */
605 SND_CHMAP_LLFE, /**< left LFE */
606 SND_CHMAP_RLFE, /**< right LFE */
607 SND_CHMAP_BC, /**< bottom center */
608 SND_CHMAP_BLC, /**< bottom left center */
609 SND_CHMAP_BRC, /**< bottom right center */
610 SND_CHMAP_LAST = SND_CHMAP_BRC,
611 };
612
613 /** bitmask for channel position */
614 #define SND_CHMAP_POSITION_MASK 0xffff
615
616 /** bit flag indicating the channel is phase inverted */
617 #define SND_CHMAP_PHASE_INVERSE (0x01 << 16)
618 /** bit flag indicating the non-standard channel value */
619 #define SND_CHMAP_DRIVER_SPEC (0x02 << 16)
620
621 /** the channel map header */
622 typedef struct snd_pcm_chmap {
623 unsigned int channels; /**< number of channels */
624 unsigned int pos[0]; /**< channel position array */
625 } snd_pcm_chmap_t;
626
627 /** the header of array items returned from snd_pcm_query_chmaps() */
628 typedef struct snd_pcm_chmap_query {
629 enum snd_pcm_chmap_type type; /**< channel map type */
630 snd_pcm_chmap_t map; /**< available channel map */
631 } snd_pcm_chmap_query_t;
632
633
634 snd_pcm_chmap_query_t **snd_pcm_query_chmaps(snd_pcm_t *pcm);
635 snd_pcm_chmap_query_t **snd_pcm_query_chmaps_from_hw(int card, int dev,
636 int subdev,
637 snd_pcm_stream_t stream);
638 void snd_pcm_free_chmaps(snd_pcm_chmap_query_t **maps);
639 snd_pcm_chmap_t *snd_pcm_get_chmap(snd_pcm_t *pcm);
640 int snd_pcm_set_chmap(snd_pcm_t *pcm, const snd_pcm_chmap_t *map);
641
642 const char *snd_pcm_chmap_type_name(enum snd_pcm_chmap_type val);
643 const char *snd_pcm_chmap_name(enum snd_pcm_chmap_position val);
644 const char *snd_pcm_chmap_long_name(enum snd_pcm_chmap_position val);
645 int snd_pcm_chmap_print(const snd_pcm_chmap_t *map, size_t maxlen, char *buf);
646 unsigned int snd_pcm_chmap_from_string(const char *str);
647 snd_pcm_chmap_t *snd_pcm_chmap_parse_string(const char *str);
648
649 //int snd_pcm_mixer_element(snd_pcm_t *pcm, snd_mixer_t *mixer, snd_mixer_elem_t **elem);
650
651 /*
652 * application helpers - these functions are implemented on top
653 * of the basic API
654 */
655
656 int snd_pcm_recover(snd_pcm_t *pcm, int err, int silent);
657 int snd_pcm_set_params(snd_pcm_t *pcm,
658 snd_pcm_format_t format,
659 snd_pcm_access_t access,
660 unsigned int channels,
661 unsigned int rate,
662 int soft_resample,
663 unsigned int latency);
664 int snd_pcm_get_params(snd_pcm_t *pcm,
665 snd_pcm_uframes_t *buffer_size,
666 snd_pcm_uframes_t *period_size);
667
668 /** \} */
669
670 /**
671 * \defgroup PCM_Info Stream Information
672 * \ingroup PCM
673 * See the \ref pcm page for more details.
674 * \{
675 */
676
677 size_t snd_pcm_info_sizeof(void);
678 /** \hideinitializer
679 * \brief allocate an invalid #snd_pcm_info_t using standard alloca
680 * \param ptr returned pointer
681 */
682 #define snd_pcm_info_alloca(ptr) __snd_alloca(ptr, snd_pcm_info)
683 int snd_pcm_info_malloc(snd_pcm_info_t **ptr);
684 void snd_pcm_info_free(snd_pcm_info_t *obj);
685 void snd_pcm_info_copy(snd_pcm_info_t *dst, const snd_pcm_info_t *src);
686 unsigned int snd_pcm_info_get_device(const snd_pcm_info_t *obj);
687 unsigned int snd_pcm_info_get_subdevice(const snd_pcm_info_t *obj);
688 snd_pcm_stream_t snd_pcm_info_get_stream(const snd_pcm_info_t *obj);
689 int snd_pcm_info_get_card(const snd_pcm_info_t *obj);
690 const char *snd_pcm_info_get_id(const snd_pcm_info_t *obj);
691 const char *snd_pcm_info_get_name(const snd_pcm_info_t *obj);
692 const char *snd_pcm_info_get_subdevice_name(const snd_pcm_info_t *obj);
693 snd_pcm_class_t snd_pcm_info_get_class(const snd_pcm_info_t *obj);
694 snd_pcm_subclass_t snd_pcm_info_get_subclass(const snd_pcm_info_t *obj);
695 unsigned int snd_pcm_info_get_subdevices_count(const snd_pcm_info_t *obj);
696 unsigned int snd_pcm_info_get_subdevices_avail(const snd_pcm_info_t *obj);
697 snd_pcm_sync_id_t snd_pcm_info_get_sync(const snd_pcm_info_t *obj);
698 void snd_pcm_info_set_device(snd_pcm_info_t *obj, unsigned int val);
699 void snd_pcm_info_set_subdevice(snd_pcm_info_t *obj, unsigned int val);
700 void snd_pcm_info_set_stream(snd_pcm_info_t *obj, snd_pcm_stream_t val);
701
702 /** \} */
703
704 /**
705 * \defgroup PCM_HW_Params Hardware Parameters
706 * \ingroup PCM
707 * See the \ref pcm page for more details.
708 * \{
709 */
710
711 int snd_pcm_hw_params_any(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
712
713 int snd_pcm_hw_params_can_mmap_sample_resolution(const snd_pcm_hw_params_t *params);
714 int snd_pcm_hw_params_is_double(const snd_pcm_hw_params_t *params);
715 int snd_pcm_hw_params_is_batch(const snd_pcm_hw_params_t *params);
716 int snd_pcm_hw_params_is_block_transfer(const snd_pcm_hw_params_t *params);
717 int snd_pcm_hw_params_is_monotonic(const snd_pcm_hw_params_t *params);
718 int snd_pcm_hw_params_can_overrange(const snd_pcm_hw_params_t *params);
719 int snd_pcm_hw_params_can_pause(const snd_pcm_hw_params_t *params);
720 int snd_pcm_hw_params_can_resume(const snd_pcm_hw_params_t *params);
721 int snd_pcm_hw_params_is_half_duplex(const snd_pcm_hw_params_t *params);
722 int snd_pcm_hw_params_is_joint_duplex(const snd_pcm_hw_params_t *params);
723 int snd_pcm_hw_params_can_sync_start(const snd_pcm_hw_params_t *params);
724 int snd_pcm_hw_params_can_disable_period_wakeup(const snd_pcm_hw_params_t *params);
725 int snd_pcm_hw_params_supports_audio_wallclock_ts(const snd_pcm_hw_params_t *params); /* deprecated, use audio_ts_type */
726 int snd_pcm_hw_params_supports_audio_ts_type(const snd_pcm_hw_params_t *params, int type);
727 int snd_pcm_hw_params_get_rate_numden(const snd_pcm_hw_params_t *params,
728 unsigned int *rate_num,
729 unsigned int *rate_den);
730 int snd_pcm_hw_params_get_sbits(const snd_pcm_hw_params_t *params);
731 int snd_pcm_hw_params_get_fifo_size(const snd_pcm_hw_params_t *params);
732
733 #if 0
734 typedef struct _snd_pcm_hw_strategy snd_pcm_hw_strategy_t;
735
736 /* choices need to be sorted on ascending badness */
737 typedef struct _snd_pcm_hw_strategy_simple_choices_list {
738 unsigned int value;
739 unsigned int badness;
740 } snd_pcm_hw_strategy_simple_choices_list_t;
741
742 int snd_pcm_hw_params_strategy(snd_pcm_t *pcm, snd_pcm_hw_params_t *params,
743 const snd_pcm_hw_strategy_t *strategy,
744 unsigned int badness_min,
745 unsigned int badness_max);
746
747 void snd_pcm_hw_strategy_free(snd_pcm_hw_strategy_t *strategy);
748 int snd_pcm_hw_strategy_simple(snd_pcm_hw_strategy_t **strategyp,
749 unsigned int badness_min,
750 unsigned int badness_max);
751 int snd_pcm_hw_params_try_explain_failure(snd_pcm_t *pcm,
752 snd_pcm_hw_params_t *fail,
753 snd_pcm_hw_params_t *success,
754 unsigned int depth,
755 snd_output_t *out);
756
757 #endif
758
759 size_t snd_pcm_hw_params_sizeof(void);
760 /** \hideinitializer
761 * \brief allocate an invalid #snd_pcm_hw_params_t using standard alloca
762 * \param ptr returned pointer
763 */
764 #define snd_pcm_hw_params_alloca(ptr) __snd_alloca(ptr, snd_pcm_hw_params)
765 int snd_pcm_hw_params_malloc(snd_pcm_hw_params_t **ptr);
766 void snd_pcm_hw_params_free(snd_pcm_hw_params_t *obj);
767 void snd_pcm_hw_params_copy(snd_pcm_hw_params_t *dst, const snd_pcm_hw_params_t *src);
768
769 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_HW_PARAMS_API)
770
771 int snd_pcm_hw_params_get_access(const snd_pcm_hw_params_t *params, snd_pcm_access_t *_access);
772 int snd_pcm_hw_params_test_access(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t _access);
773 int snd_pcm_hw_params_set_access(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t _access);
774 int snd_pcm_hw_params_set_access_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *_access);
775 int snd_pcm_hw_params_set_access_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *_access);
776 int snd_pcm_hw_params_set_access_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask);
777 int snd_pcm_hw_params_get_access_mask(snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask);
778
779 int snd_pcm_hw_params_get_format(const snd_pcm_hw_params_t *params, snd_pcm_format_t *val);
780 int snd_pcm_hw_params_test_format(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val);
781 int snd_pcm_hw_params_set_format(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val);
782 int snd_pcm_hw_params_set_format_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format);
783 int snd_pcm_hw_params_set_format_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format);
784 int snd_pcm_hw_params_set_format_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask);
785 void snd_pcm_hw_params_get_format_mask(snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask);
786
787 int snd_pcm_hw_params_get_subformat(const snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat);
788 int snd_pcm_hw_params_test_subformat(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat);
789 int snd_pcm_hw_params_set_subformat(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat);
790 int snd_pcm_hw_params_set_subformat_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat);
791 int snd_pcm_hw_params_set_subformat_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat);
792 int snd_pcm_hw_params_set_subformat_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask);
793 void snd_pcm_hw_params_get_subformat_mask(snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask);
794
795 int snd_pcm_hw_params_get_channels(const snd_pcm_hw_params_t *params, unsigned int *val);
796 int snd_pcm_hw_params_get_channels_min(const snd_pcm_hw_params_t *params, unsigned int *val);
797 int snd_pcm_hw_params_get_channels_max(const snd_pcm_hw_params_t *params, unsigned int *val);
798 int snd_pcm_hw_params_test_channels(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
799 int snd_pcm_hw_params_set_channels(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
800 int snd_pcm_hw_params_set_channels_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
801 int snd_pcm_hw_params_set_channels_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
802 int snd_pcm_hw_params_set_channels_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, unsigned int *max);
803 int snd_pcm_hw_params_set_channels_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
804 int snd_pcm_hw_params_set_channels_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
805 int snd_pcm_hw_params_set_channels_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
806
807 int snd_pcm_hw_params_get_rate(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
808 int snd_pcm_hw_params_get_rate_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
809 int snd_pcm_hw_params_get_rate_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
810 int snd_pcm_hw_params_test_rate(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
811 int snd_pcm_hw_params_set_rate(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
812 int snd_pcm_hw_params_set_rate_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
813 int snd_pcm_hw_params_set_rate_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
814 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);
815 int snd_pcm_hw_params_set_rate_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
816 int snd_pcm_hw_params_set_rate_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
817 int snd_pcm_hw_params_set_rate_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
818 int snd_pcm_hw_params_set_rate_resample(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
819 int snd_pcm_hw_params_get_rate_resample(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
820 int snd_pcm_hw_params_set_export_buffer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
821 int snd_pcm_hw_params_get_export_buffer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
822 int snd_pcm_hw_params_set_period_wakeup(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
823 int snd_pcm_hw_params_get_period_wakeup(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
824
825 int snd_pcm_hw_params_get_period_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
826 int snd_pcm_hw_params_get_period_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
827 int snd_pcm_hw_params_get_period_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
828 int snd_pcm_hw_params_test_period_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
829 int snd_pcm_hw_params_set_period_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
830 int snd_pcm_hw_params_set_period_time_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
831 int snd_pcm_hw_params_set_period_time_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
832 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);
833 int snd_pcm_hw_params_set_period_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
834 int snd_pcm_hw_params_set_period_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
835 int snd_pcm_hw_params_set_period_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
836
837 int snd_pcm_hw_params_get_period_size(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
838 int snd_pcm_hw_params_get_period_size_min(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
839 int snd_pcm_hw_params_get_period_size_max(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
840 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);
841 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);
842 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);
843 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);
844 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);
845 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);
846 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);
847 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);
848 int snd_pcm_hw_params_set_period_size_integer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
849
850 int snd_pcm_hw_params_get_periods(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
851 int snd_pcm_hw_params_get_periods_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
852 int snd_pcm_hw_params_get_periods_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
853 int snd_pcm_hw_params_test_periods(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
854 int snd_pcm_hw_params_set_periods(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
855 int snd_pcm_hw_params_set_periods_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
856 int snd_pcm_hw_params_set_periods_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
857 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);
858 int snd_pcm_hw_params_set_periods_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
859 int snd_pcm_hw_params_set_periods_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
860 int snd_pcm_hw_params_set_periods_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
861 int snd_pcm_hw_params_set_periods_integer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
862
863 int snd_pcm_hw_params_get_buffer_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
864 int snd_pcm_hw_params_get_buffer_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
865 int snd_pcm_hw_params_get_buffer_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
866 int snd_pcm_hw_params_test_buffer_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
867 int snd_pcm_hw_params_set_buffer_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
868 int snd_pcm_hw_params_set_buffer_time_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
869 int snd_pcm_hw_params_set_buffer_time_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
870 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);
871 int snd_pcm_hw_params_set_buffer_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
872 int snd_pcm_hw_params_set_buffer_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
873 int snd_pcm_hw_params_set_buffer_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
874
875 int snd_pcm_hw_params_get_buffer_size(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
876 int snd_pcm_hw_params_get_buffer_size_min(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
877 int snd_pcm_hw_params_get_buffer_size_max(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
878 int snd_pcm_hw_params_test_buffer_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val);
879 int snd_pcm_hw_params_set_buffer_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val);
880 int snd_pcm_hw_params_set_buffer_size_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
881 int snd_pcm_hw_params_set_buffer_size_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
882 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);
883 int snd_pcm_hw_params_set_buffer_size_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
884 int snd_pcm_hw_params_set_buffer_size_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
885 int snd_pcm_hw_params_set_buffer_size_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
886
887 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_HW_PARAMS_API */
888
889 int snd_pcm_hw_params_get_min_align(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
890
891 /** \} */
892
893 /**
894 * \defgroup PCM_SW_Params Software Parameters
895 * \ingroup PCM
896 * See the \ref pcm page for more details.
897 * \{
898 */
899
900 size_t snd_pcm_sw_params_sizeof(void);
901 /** \hideinitializer
902 * \brief allocate an invalid #snd_pcm_sw_params_t using standard alloca
903 * \param ptr returned pointer
904 */
905 #define snd_pcm_sw_params_alloca(ptr) __snd_alloca(ptr, snd_pcm_sw_params)
906 int snd_pcm_sw_params_malloc(snd_pcm_sw_params_t **ptr);
907 void snd_pcm_sw_params_free(snd_pcm_sw_params_t *obj);
908 void snd_pcm_sw_params_copy(snd_pcm_sw_params_t *dst, const snd_pcm_sw_params_t *src);
909 int snd_pcm_sw_params_get_boundary(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
910
911 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_SW_PARAMS_API)
912
913 int snd_pcm_sw_params_set_tstamp_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_tstamp_t val);
914 int snd_pcm_sw_params_get_tstamp_mode(const snd_pcm_sw_params_t *params, snd_pcm_tstamp_t *val);
915 int snd_pcm_sw_params_set_tstamp_type(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_tstamp_type_t val);
916 int snd_pcm_sw_params_get_tstamp_type(const snd_pcm_sw_params_t *params, snd_pcm_tstamp_type_t *val);
917 int snd_pcm_sw_params_set_avail_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
918 int snd_pcm_sw_params_get_avail_min(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
919 int snd_pcm_sw_params_set_period_event(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, int val);
920 int snd_pcm_sw_params_get_period_event(const snd_pcm_sw_params_t *params, int *val);
921 int snd_pcm_sw_params_set_start_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
922 int snd_pcm_sw_params_get_start_threshold(const snd_pcm_sw_params_t *paramsm, snd_pcm_uframes_t *val);
923 int snd_pcm_sw_params_set_stop_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
924 int snd_pcm_sw_params_get_stop_threshold(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
925 int snd_pcm_sw_params_set_silence_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
926 int snd_pcm_sw_params_get_silence_threshold(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
927 int snd_pcm_sw_params_set_silence_size(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
928 int snd_pcm_sw_params_get_silence_size(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
929
930 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_SW_PARAMS_API */
931
932 /** \} */
933
934 /* include old API */
935 #ifndef ALSA_LIBRARY_BUILD
936 #if defined(ALSA_PCM_OLD_HW_PARAMS_API) || defined(ALSA_PCM_OLD_SW_PARAMS_API)
937 #include "pcm_old.h"
938 #endif
939 #endif
940
941 /**
942 * \defgroup PCM_Access Access Mask Functions
943 * \ingroup PCM
944 * See the \ref pcm page for more details.
945 * \{
946 */
947
948 size_t snd_pcm_access_mask_sizeof(void);
949 /** \hideinitializer
950 * \brief allocate an empty #snd_pcm_access_mask_t using standard alloca
951 * \param ptr returned pointer
952 */
953 #define snd_pcm_access_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_access_mask)
954 int snd_pcm_access_mask_malloc(snd_pcm_access_mask_t **ptr);
955 void snd_pcm_access_mask_free(snd_pcm_access_mask_t *obj);
956 void snd_pcm_access_mask_copy(snd_pcm_access_mask_t *dst, const snd_pcm_access_mask_t *src);
957 void snd_pcm_access_mask_none(snd_pcm_access_mask_t *mask);
958 void snd_pcm_access_mask_any(snd_pcm_access_mask_t *mask);
959 int snd_pcm_access_mask_test(const snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
960 int snd_pcm_access_mask_empty(const snd_pcm_access_mask_t *mask);
961 void snd_pcm_access_mask_set(snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
962 void snd_pcm_access_mask_reset(snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
963
964 /** \} */
965
966 /**
967 * \defgroup PCM_Format Format Mask Functions
968 * \ingroup PCM
969 * See the \ref pcm page for more details.
970 * \{
971 */
972
973 size_t snd_pcm_format_mask_sizeof(void);
974 /** \hideinitializer
975 * \brief allocate an empty #snd_pcm_format_mask_t using standard alloca
976 * \param ptr returned pointer
977 */
978 #define snd_pcm_format_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_format_mask)
979 int snd_pcm_format_mask_malloc(snd_pcm_format_mask_t **ptr);
980 void snd_pcm_format_mask_free(snd_pcm_format_mask_t *obj);
981 void snd_pcm_format_mask_copy(snd_pcm_format_mask_t *dst, const snd_pcm_format_mask_t *src);
982 void snd_pcm_format_mask_none(snd_pcm_format_mask_t *mask);
983 void snd_pcm_format_mask_any(snd_pcm_format_mask_t *mask);
984 int snd_pcm_format_mask_test(const snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
985 int snd_pcm_format_mask_empty(const snd_pcm_format_mask_t *mask);
986 void snd_pcm_format_mask_set(snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
987 void snd_pcm_format_mask_reset(snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
988
989 /** \} */
990
991 /**
992 * \defgroup PCM_SubFormat Subformat Mask Functions
993 * \ingroup PCM
994 * See the \ref pcm page for more details.
995 * \{
996 */
997
998 size_t snd_pcm_subformat_mask_sizeof(void);
999 /** \hideinitializer
1000 * \brief allocate an empty #snd_pcm_subformat_mask_t using standard alloca
1001 * \param ptr returned pointer
1002 */
1003 #define snd_pcm_subformat_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_subformat_mask)
1004 int snd_pcm_subformat_mask_malloc(snd_pcm_subformat_mask_t **ptr);
1005 void snd_pcm_subformat_mask_free(snd_pcm_subformat_mask_t *obj);
1006 void snd_pcm_subformat_mask_copy(snd_pcm_subformat_mask_t *dst, const snd_pcm_subformat_mask_t *src);
1007 void snd_pcm_subformat_mask_none(snd_pcm_subformat_mask_t *mask);
1008 void snd_pcm_subformat_mask_any(snd_pcm_subformat_mask_t *mask);
1009 int snd_pcm_subformat_mask_test(const snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
1010 int snd_pcm_subformat_mask_empty(const snd_pcm_subformat_mask_t *mask);
1011 void snd_pcm_subformat_mask_set(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
1012 void snd_pcm_subformat_mask_reset(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
1013
1014 /** \} */
1015
1016 /**
1017 * \defgroup PCM_Status Status Functions
1018 * \ingroup PCM
1019 * See the \ref pcm page for more details.
1020 * \{
1021 */
1022
1023 size_t snd_pcm_status_sizeof(void);
1024 /** \hideinitializer
1025 * \brief allocate an invalid #snd_pcm_status_t using standard alloca
1026 * \param ptr returned pointer
1027 */
1028 #define snd_pcm_status_alloca(ptr) __snd_alloca(ptr, snd_pcm_status)
1029 int snd_pcm_status_malloc(snd_pcm_status_t **ptr);
1030 void snd_pcm_status_free(snd_pcm_status_t *obj);
1031 void snd_pcm_status_copy(snd_pcm_status_t *dst, const snd_pcm_status_t *src);
1032 snd_pcm_state_t snd_pcm_status_get_state(const snd_pcm_status_t *obj);
1033 void snd_pcm_status_get_trigger_tstamp(const snd_pcm_status_t *obj, snd_timestamp_t *ptr);
1034 void snd_pcm_status_get_trigger_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr);
1035 void snd_pcm_status_get_tstamp(const snd_pcm_status_t *obj, snd_timestamp_t *ptr);
1036 void snd_pcm_status_get_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr);
1037 void snd_pcm_status_get_audio_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr);
1038 void snd_pcm_status_get_driver_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr);
1039 void snd_pcm_status_get_audio_htstamp_report(const snd_pcm_status_t *obj,
1040 snd_pcm_audio_tstamp_report_t *audio_tstamp_report);
1041 void snd_pcm_status_set_audio_htstamp_config(snd_pcm_status_t *obj,
1042 snd_pcm_audio_tstamp_config_t *audio_tstamp_config);
1043
snd_pcm_pack_audio_tstamp_config(unsigned int * data,snd_pcm_audio_tstamp_config_t * config)1044 static inline void snd_pcm_pack_audio_tstamp_config(unsigned int *data,
1045 snd_pcm_audio_tstamp_config_t *config)
1046 {
1047 *data = config->report_delay;
1048 *data <<= 4;
1049 *data |= config->type_requested;
1050 }
1051
snd_pcm_unpack_audio_tstamp_report(unsigned int data,unsigned int accuracy,snd_pcm_audio_tstamp_report_t * report)1052 static inline void snd_pcm_unpack_audio_tstamp_report(unsigned int data, unsigned int accuracy,
1053 snd_pcm_audio_tstamp_report_t *report)
1054 {
1055 data >>= 16;
1056 report->valid = data & 1;
1057 report->actual_type = (data >> 1) & 0xF;
1058 report->accuracy_report = (data >> 5) & 1;
1059 report->accuracy = accuracy;
1060 }
1061
1062 snd_pcm_sframes_t snd_pcm_status_get_delay(const snd_pcm_status_t *obj);
1063 snd_pcm_uframes_t snd_pcm_status_get_avail(const snd_pcm_status_t *obj);
1064 snd_pcm_uframes_t snd_pcm_status_get_avail_max(const snd_pcm_status_t *obj);
1065 snd_pcm_uframes_t snd_pcm_status_get_overrange(const snd_pcm_status_t *obj);
1066
1067 /** \} */
1068
1069 /**
1070 * \defgroup PCM_Description Description Functions
1071 * \ingroup PCM
1072 * See the \ref pcm page for more details.
1073 * \{
1074 */
1075
1076 const char *snd_pcm_type_name(snd_pcm_type_t type);
1077 const char *snd_pcm_stream_name(const snd_pcm_stream_t stream);
1078 const char *snd_pcm_access_name(const snd_pcm_access_t _access);
1079 const char *snd_pcm_format_name(const snd_pcm_format_t format);
1080 const char *snd_pcm_format_description(const snd_pcm_format_t format);
1081 const char *snd_pcm_subformat_name(const snd_pcm_subformat_t subformat);
1082 const char *snd_pcm_subformat_description(const snd_pcm_subformat_t subformat);
1083 snd_pcm_format_t snd_pcm_format_value(const char* name);
1084 const char *snd_pcm_tstamp_mode_name(const snd_pcm_tstamp_t mode);
1085 const char *snd_pcm_state_name(const snd_pcm_state_t state);
1086
1087 /** \} */
1088
1089 /**
1090 * \defgroup PCM_Dump Debug Functions
1091 * \ingroup PCM
1092 * See the \ref pcm page for more details.
1093 * \{
1094 */
1095
1096 int snd_pcm_dump(snd_pcm_t *pcm, snd_output_t *out);
1097 int snd_pcm_dump_hw_setup(snd_pcm_t *pcm, snd_output_t *out);
1098 int snd_pcm_dump_sw_setup(snd_pcm_t *pcm, snd_output_t *out);
1099 int snd_pcm_dump_setup(snd_pcm_t *pcm, snd_output_t *out);
1100 int snd_pcm_hw_params_dump(snd_pcm_hw_params_t *params, snd_output_t *out);
1101 int snd_pcm_sw_params_dump(snd_pcm_sw_params_t *params, snd_output_t *out);
1102 int snd_pcm_status_dump(snd_pcm_status_t *status, snd_output_t *out);
1103
1104 /** \} */
1105
1106 /**
1107 * \defgroup PCM_Direct Direct Access (MMAP) Functions
1108 * \ingroup PCM
1109 * See the \ref pcm page for more details.
1110 * \{
1111 */
1112
1113 int snd_pcm_mmap_begin(snd_pcm_t *pcm,
1114 const snd_pcm_channel_area_t **areas,
1115 snd_pcm_uframes_t *offset,
1116 snd_pcm_uframes_t *frames);
1117 snd_pcm_sframes_t snd_pcm_mmap_commit(snd_pcm_t *pcm,
1118 snd_pcm_uframes_t offset,
1119 snd_pcm_uframes_t frames);
1120 snd_pcm_sframes_t snd_pcm_mmap_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size);
1121 snd_pcm_sframes_t snd_pcm_mmap_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size);
1122 snd_pcm_sframes_t snd_pcm_mmap_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
1123 snd_pcm_sframes_t snd_pcm_mmap_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
1124
1125 /** \} */
1126
1127 /**
1128 * \defgroup PCM_Helpers Helper Functions
1129 * \ingroup PCM
1130 * See the \ref pcm page for more details.
1131 * \{
1132 */
1133
1134 int snd_pcm_format_signed(snd_pcm_format_t format);
1135 int snd_pcm_format_unsigned(snd_pcm_format_t format);
1136 int snd_pcm_format_linear(snd_pcm_format_t format);
1137 int snd_pcm_format_float(snd_pcm_format_t format);
1138 int snd_pcm_format_little_endian(snd_pcm_format_t format);
1139 int snd_pcm_format_big_endian(snd_pcm_format_t format);
1140 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1141 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
1142 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
1143 snd_pcm_format_t snd_pcm_build_linear_format(int width, int pwidth, int unsignd, int big_endian);
1144 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1145 uint8_t snd_pcm_format_silence(snd_pcm_format_t format);
1146 uint16_t snd_pcm_format_silence_16(snd_pcm_format_t format);
1147 uint32_t snd_pcm_format_silence_32(snd_pcm_format_t format);
1148 uint64_t snd_pcm_format_silence_64(snd_pcm_format_t format);
1149 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int samples);
1150
1151 snd_pcm_sframes_t snd_pcm_bytes_to_frames(snd_pcm_t *pcm, ssize_t bytes);
1152 ssize_t snd_pcm_frames_to_bytes(snd_pcm_t *pcm, snd_pcm_sframes_t frames);
1153 long snd_pcm_bytes_to_samples(snd_pcm_t *pcm, ssize_t bytes);
1154 ssize_t snd_pcm_samples_to_bytes(snd_pcm_t *pcm, long samples);
1155
1156 int snd_pcm_area_silence(const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset,
1157 unsigned int samples, snd_pcm_format_t format);
1158 int snd_pcm_areas_silence(const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset,
1159 unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format);
1160 int snd_pcm_area_copy(const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset,
1161 const snd_pcm_channel_area_t *src_channel, snd_pcm_uframes_t src_offset,
1162 unsigned int samples, snd_pcm_format_t format);
1163 int snd_pcm_areas_copy(const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset,
1164 const snd_pcm_channel_area_t *src_channels, snd_pcm_uframes_t src_offset,
1165 unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format);
1166 int snd_pcm_areas_copy_wrap(const snd_pcm_channel_area_t *dst_channels,
1167 snd_pcm_uframes_t dst_offset,
1168 const snd_pcm_uframes_t dst_size,
1169 const snd_pcm_channel_area_t *src_channels,
1170 snd_pcm_uframes_t src_offset,
1171 const snd_pcm_uframes_t src_size,
1172 const unsigned int channels,
1173 snd_pcm_uframes_t frames,
1174 const snd_pcm_format_t format);
1175
1176 /**
1177 * \brief get the address of the given PCM channel area
1178 * \param area PCM channel area
1179 * \param offset Offset in frames
1180 *
1181 * Returns the pointer corresponding to the given offset on the channel area.
1182 */
snd_pcm_channel_area_addr(const snd_pcm_channel_area_t * area,snd_pcm_uframes_t offset)1183 static inline void *snd_pcm_channel_area_addr(const snd_pcm_channel_area_t *area, snd_pcm_uframes_t offset)
1184 {
1185 return (char *)area->addr + (area->first + area->step * offset) / 8;
1186 }
1187
1188 /**
1189 * \brief get the step size of the given PCM channel area in bytes
1190 * \param area PCM channel area
1191 *
1192 * Returns the step size in bytes from the given channel area.
1193 */
snd_pcm_channel_area_step(const snd_pcm_channel_area_t * area)1194 static inline unsigned int snd_pcm_channel_area_step(const snd_pcm_channel_area_t *area)
1195 {
1196 return area->step / 8;
1197 }
1198
1199 /** \} */
1200
1201 /**
1202 * \defgroup PCM_Hook Hook Extension
1203 * \ingroup PCM
1204 * See the \ref pcm page for more details.
1205 * \{
1206 */
1207
1208 /** type of pcm hook */
1209 typedef enum _snd_pcm_hook_type {
1210 SND_PCM_HOOK_TYPE_HW_PARAMS = 0,
1211 SND_PCM_HOOK_TYPE_HW_FREE,
1212 SND_PCM_HOOK_TYPE_CLOSE,
1213 SND_PCM_HOOK_TYPE_LAST = SND_PCM_HOOK_TYPE_CLOSE
1214 } snd_pcm_hook_type_t;
1215
1216 /** PCM hook container */
1217 typedef struct _snd_pcm_hook snd_pcm_hook_t;
1218 /** PCM hook callback function */
1219 typedef int (*snd_pcm_hook_func_t)(snd_pcm_hook_t *hook);
1220 snd_pcm_t *snd_pcm_hook_get_pcm(snd_pcm_hook_t *hook);
1221 void *snd_pcm_hook_get_private(snd_pcm_hook_t *hook);
1222 void snd_pcm_hook_set_private(snd_pcm_hook_t *hook, void *private_data);
1223 int snd_pcm_hook_add(snd_pcm_hook_t **hookp, snd_pcm_t *pcm,
1224 snd_pcm_hook_type_t type,
1225 snd_pcm_hook_func_t func, void *private_data);
1226 int snd_pcm_hook_remove(snd_pcm_hook_t *hook);
1227
1228 /** \} */
1229
1230 /**
1231 * \defgroup PCM_Scope Scope Plugin Extension
1232 * \ingroup PCM
1233 * See the \ref pcm page for more details.
1234 * \{
1235 */
1236
1237 /** #SND_PCM_TYPE_METER scope functions */
1238 typedef struct _snd_pcm_scope_ops {
1239 /** \brief Enable and prepare it using current params
1240 * \param scope scope handle
1241 */
1242 int (*enable)(snd_pcm_scope_t *scope);
1243 /** \brief Disable
1244 * \param scope scope handle
1245 */
1246 void (*disable)(snd_pcm_scope_t *scope);
1247 /** \brief PCM has been started
1248 * \param scope scope handle
1249 */
1250 void (*start)(snd_pcm_scope_t *scope);
1251 /** \brief PCM has been stopped
1252 * \param scope scope handle
1253 */
1254 void (*stop)(snd_pcm_scope_t *scope);
1255 /** \brief New frames are present
1256 * \param scope scope handle
1257 */
1258 void (*update)(snd_pcm_scope_t *scope);
1259 /** \brief Reset status
1260 * \param scope scope handle
1261 */
1262 void (*reset)(snd_pcm_scope_t *scope);
1263 /** \brief PCM is closing
1264 * \param scope scope handle
1265 */
1266 void (*close)(snd_pcm_scope_t *scope);
1267 } snd_pcm_scope_ops_t;
1268
1269 snd_pcm_uframes_t snd_pcm_meter_get_bufsize(snd_pcm_t *pcm);
1270 unsigned int snd_pcm_meter_get_channels(snd_pcm_t *pcm);
1271 unsigned int snd_pcm_meter_get_rate(snd_pcm_t *pcm);
1272 snd_pcm_uframes_t snd_pcm_meter_get_now(snd_pcm_t *pcm);
1273 snd_pcm_uframes_t snd_pcm_meter_get_boundary(snd_pcm_t *pcm);
1274 int snd_pcm_meter_add_scope(snd_pcm_t *pcm, snd_pcm_scope_t *scope);
1275 snd_pcm_scope_t *snd_pcm_meter_search_scope(snd_pcm_t *pcm, const char *name);
1276 int snd_pcm_scope_malloc(snd_pcm_scope_t **ptr);
1277 void snd_pcm_scope_set_ops(snd_pcm_scope_t *scope,
1278 const snd_pcm_scope_ops_t *val);
1279 void snd_pcm_scope_set_name(snd_pcm_scope_t *scope, const char *val);
1280 const char *snd_pcm_scope_get_name(snd_pcm_scope_t *scope);
1281 void *snd_pcm_scope_get_callback_private(snd_pcm_scope_t *scope);
1282 void snd_pcm_scope_set_callback_private(snd_pcm_scope_t *scope, void *val);
1283 int snd_pcm_scope_s16_open(snd_pcm_t *pcm, const char *name,
1284 snd_pcm_scope_t **scopep);
1285 int16_t *snd_pcm_scope_s16_get_channel_buffer(snd_pcm_scope_t *scope,
1286 unsigned int channel);
1287
1288 /** \} */
1289
1290 /**
1291 * \defgroup PCM_Simple Simple setup functions
1292 * \ingroup PCM
1293 * See the \ref pcm page for more details.
1294 * \{
1295 */
1296
1297 /** Simple PCM latency type */
1298 typedef enum _snd_spcm_latency {
1299 /** standard latency - for standard playback or capture
1300 (estimated latency in one direction 350ms) */
1301 SND_SPCM_LATENCY_STANDARD = 0,
1302 /** medium latency - software phones etc.
1303 (estimated latency in one direction maximally 25ms */
1304 SND_SPCM_LATENCY_MEDIUM,
1305 /** realtime latency - realtime applications (effect processors etc.)
1306 (estimated latency in one direction 5ms and better) */
1307 SND_SPCM_LATENCY_REALTIME
1308 } snd_spcm_latency_t;
1309
1310 /** Simple PCM xrun type */
1311 typedef enum _snd_spcm_xrun_type {
1312 /** driver / library will ignore all xruns, the stream runs forever */
1313 SND_SPCM_XRUN_IGNORE = 0,
1314 /** driver / library stops the stream when an xrun occurs */
1315 SND_SPCM_XRUN_STOP
1316 } snd_spcm_xrun_type_t;
1317
1318 /** Simple PCM duplex type */
1319 typedef enum _snd_spcm_duplex_type {
1320 /** liberal duplex - the buffer and period sizes might not match */
1321 SND_SPCM_DUPLEX_LIBERAL = 0,
1322 /** pedantic duplex - the buffer and period sizes MUST match */
1323 SND_SPCM_DUPLEX_PEDANTIC
1324 } snd_spcm_duplex_type_t;
1325
1326 int snd_spcm_init(snd_pcm_t *pcm,
1327 unsigned int rate,
1328 unsigned int channels,
1329 snd_pcm_format_t format,
1330 snd_pcm_subformat_t subformat,
1331 snd_spcm_latency_t latency,
1332 snd_pcm_access_t _access,
1333 snd_spcm_xrun_type_t xrun_type);
1334
1335 int snd_spcm_init_duplex(snd_pcm_t *playback_pcm,
1336 snd_pcm_t *capture_pcm,
1337 unsigned int rate,
1338 unsigned int channels,
1339 snd_pcm_format_t format,
1340 snd_pcm_subformat_t subformat,
1341 snd_spcm_latency_t latency,
1342 snd_pcm_access_t _access,
1343 snd_spcm_xrun_type_t xrun_type,
1344 snd_spcm_duplex_type_t duplex_type);
1345
1346 int snd_spcm_init_get_params(snd_pcm_t *pcm,
1347 unsigned int *rate,
1348 snd_pcm_uframes_t *buffer_size,
1349 snd_pcm_uframes_t *period_size);
1350
1351 /** \} */
1352
1353 /**
1354 * \defgroup PCM_Deprecated Deprecated Functions
1355 * \ingroup PCM
1356 * See the \ref pcm page for more details.
1357 * \{
1358 */
1359
1360 /* Deprecated functions, for compatibility */
1361 const char *snd_pcm_start_mode_name(snd_pcm_start_t mode) __attribute__((deprecated));
1362 const char *snd_pcm_xrun_mode_name(snd_pcm_xrun_t mode) __attribute__((deprecated));
1363 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));
1364 snd_pcm_start_t snd_pcm_sw_params_get_start_mode(const snd_pcm_sw_params_t *params) __attribute__((deprecated));
1365 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));
1366 snd_pcm_xrun_t snd_pcm_sw_params_get_xrun_mode(const snd_pcm_sw_params_t *params) __attribute__((deprecated));
1367 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_SW_PARAMS_API)
1368 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));
1369 int snd_pcm_sw_params_get_xfer_align(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val) __attribute__((deprecated));
1370 int snd_pcm_sw_params_set_sleep_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, unsigned int val) __attribute__((deprecated));
1371 int snd_pcm_sw_params_get_sleep_min(const snd_pcm_sw_params_t *params, unsigned int *val) __attribute__((deprecated));
1372 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_SW_PARAMS_API */
1373 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_HW_PARAMS_API)
1374 int snd_pcm_hw_params_get_tick_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1375 int snd_pcm_hw_params_get_tick_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1376 int snd_pcm_hw_params_get_tick_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1377 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));
1378 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));
1379 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));
1380 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));
1381 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));
1382 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));
1383 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));
1384 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));
1385 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_HW_PARAMS_API */
1386
1387 /** \} */
1388
1389 #ifdef __cplusplus
1390 }
1391 #endif
1392
1393 #endif /* __ALSA_PCM_H */
1394