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>
9 * Application interface library for the ALSA driver.
10 * See the \ref pcm page for more details.
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
37 * \defgroup PCM PCM Interface
38 * See the \ref pcm page for more details.
42 /** dlsym version for interface entry callback */
43 #define SND_PCM_DLSYM_VERSION _dlsym_pcm_001
45 /** PCM generic info container */
46 typedef struct _snd_pcm_info snd_pcm_info_t;
48 /** PCM hardware configuration space container
50 * snd_pcm_hw_params_t is an opaque structure which contains a set of possible
51 * PCM hardware configurations. For example, a given instance might include a
52 * range of buffer sizes, a range of period sizes, and a set of several sample
53 * formats. Some subset of all possible combinations these sets may be valid,
54 * but not necessarily any combination will be valid.
56 * When a parameter is set or restricted using a snd_pcm_hw_params_set*
57 * function, all of the other ranges will be updated to exclude as many
58 * impossible configurations as possible. Attempting to set a parameter
59 * outside of its acceptable range will result in the function failing
60 * and an error code being returned.
62 typedef struct _snd_pcm_hw_params snd_pcm_hw_params_t;
64 /** PCM software configuration container */
65 typedef struct _snd_pcm_sw_params snd_pcm_sw_params_t;
66 /** PCM status container */
67 typedef struct _snd_pcm_status snd_pcm_status_t;
68 /** PCM access types mask */
69 typedef struct _snd_pcm_access_mask snd_pcm_access_mask_t;
70 /** PCM formats mask */
71 typedef struct _snd_pcm_format_mask snd_pcm_format_mask_t;
72 /** PCM subformats mask */
73 typedef struct _snd_pcm_subformat_mask snd_pcm_subformat_mask_t;
76 typedef enum _snd_pcm_class {
77 /** standard device */
79 SND_PCM_CLASS_GENERIC = 0,
80 /** multichannel device */
82 /** software modem device */
84 /** digitizer device */
85 SND_PCM_CLASS_DIGITIZER,
86 SND_PCM_CLASS_LAST = SND_PCM_CLASS_DIGITIZER
90 typedef enum _snd_pcm_subclass {
91 /** subdevices are mixed together */
92 SND_PCM_SUBCLASS_GENERIC_MIX = 0,
93 /** multichannel subdevices are mixed together */
94 SND_PCM_SUBCLASS_MULTI_MIX,
95 SND_PCM_SUBCLASS_LAST = SND_PCM_SUBCLASS_MULTI_MIX
98 /** PCM stream (direction) */
99 typedef enum _snd_pcm_stream {
100 /** Playback stream */
101 SND_PCM_STREAM_PLAYBACK = 0,
102 /** Capture stream */
103 SND_PCM_STREAM_CAPTURE,
104 SND_PCM_STREAM_LAST = SND_PCM_STREAM_CAPTURE
107 /** PCM access type */
108 typedef enum _snd_pcm_access {
109 /** mmap access with simple interleaved channels */
110 SND_PCM_ACCESS_MMAP_INTERLEAVED = 0,
111 /** mmap access with simple non interleaved channels */
112 SND_PCM_ACCESS_MMAP_NONINTERLEAVED,
113 /** mmap access with complex placement */
114 SND_PCM_ACCESS_MMAP_COMPLEX,
115 /** snd_pcm_readi/snd_pcm_writei access */
116 SND_PCM_ACCESS_RW_INTERLEAVED,
117 /** snd_pcm_readn/snd_pcm_writen access */
118 SND_PCM_ACCESS_RW_NONINTERLEAVED,
119 SND_PCM_ACCESS_LAST = SND_PCM_ACCESS_RW_NONINTERLEAVED
122 /** PCM sample format */
123 typedef enum _snd_pcm_format {
125 SND_PCM_FORMAT_UNKNOWN = -1,
127 SND_PCM_FORMAT_S8 = 0,
128 /** Unsigned 8 bit */
130 /** Signed 16 bit Little Endian */
131 SND_PCM_FORMAT_S16_LE,
132 /** Signed 16 bit Big Endian */
133 SND_PCM_FORMAT_S16_BE,
134 /** Unsigned 16 bit Little Endian */
135 SND_PCM_FORMAT_U16_LE,
136 /** Unsigned 16 bit Big Endian */
137 SND_PCM_FORMAT_U16_BE,
138 /** Signed 24 bit Little Endian using low three bytes in 32-bit word */
139 SND_PCM_FORMAT_S24_LE,
140 /** Signed 24 bit Big Endian using low three bytes in 32-bit word */
141 SND_PCM_FORMAT_S24_BE,
142 /** Unsigned 24 bit Little Endian using low three bytes in 32-bit word */
143 SND_PCM_FORMAT_U24_LE,
144 /** Unsigned 24 bit Big Endian using low three bytes in 32-bit word */
145 SND_PCM_FORMAT_U24_BE,
146 /** Signed 32 bit Little Endian */
147 SND_PCM_FORMAT_S32_LE,
148 /** Signed 32 bit Big Endian */
149 SND_PCM_FORMAT_S32_BE,
150 /** Unsigned 32 bit Little Endian */
151 SND_PCM_FORMAT_U32_LE,
152 /** Unsigned 32 bit Big Endian */
153 SND_PCM_FORMAT_U32_BE,
154 /** Float 32 bit Little Endian, Range -1.0 to 1.0 */
155 SND_PCM_FORMAT_FLOAT_LE,
156 /** Float 32 bit Big Endian, Range -1.0 to 1.0 */
157 SND_PCM_FORMAT_FLOAT_BE,
158 /** Float 64 bit Little Endian, Range -1.0 to 1.0 */
159 SND_PCM_FORMAT_FLOAT64_LE,
160 /** Float 64 bit Big Endian, Range -1.0 to 1.0 */
161 SND_PCM_FORMAT_FLOAT64_BE,
162 /** IEC-958 Little Endian */
163 SND_PCM_FORMAT_IEC958_SUBFRAME_LE,
164 /** IEC-958 Big Endian */
165 SND_PCM_FORMAT_IEC958_SUBFRAME_BE,
167 SND_PCM_FORMAT_MU_LAW,
169 SND_PCM_FORMAT_A_LAW,
171 SND_PCM_FORMAT_IMA_ADPCM,
177 SND_PCM_FORMAT_SPECIAL = 31,
178 /** Signed 24bit Little Endian in 3bytes format */
179 SND_PCM_FORMAT_S24_3LE = 32,
180 /** Signed 24bit Big Endian in 3bytes format */
181 SND_PCM_FORMAT_S24_3BE,
182 /** Unsigned 24bit Little Endian in 3bytes format */
183 SND_PCM_FORMAT_U24_3LE,
184 /** Unsigned 24bit Big Endian in 3bytes format */
185 SND_PCM_FORMAT_U24_3BE,
186 /** Signed 20bit Little Endian in 3bytes format */
187 SND_PCM_FORMAT_S20_3LE,
188 /** Signed 20bit Big Endian in 3bytes format */
189 SND_PCM_FORMAT_S20_3BE,
190 /** Unsigned 20bit Little Endian in 3bytes format */
191 SND_PCM_FORMAT_U20_3LE,
192 /** Unsigned 20bit Big Endian in 3bytes format */
193 SND_PCM_FORMAT_U20_3BE,
194 /** Signed 18bit Little Endian in 3bytes format */
195 SND_PCM_FORMAT_S18_3LE,
196 /** Signed 18bit Big Endian in 3bytes format */
197 SND_PCM_FORMAT_S18_3BE,
198 /** Unsigned 18bit Little Endian in 3bytes format */
199 SND_PCM_FORMAT_U18_3LE,
200 /** Unsigned 18bit Big Endian in 3bytes format */
201 SND_PCM_FORMAT_U18_3BE,
202 SND_PCM_FORMAT_LAST = SND_PCM_FORMAT_U18_3BE,
204 #if __BYTE_ORDER == __LITTLE_ENDIAN
205 /** Signed 16 bit CPU endian */
206 SND_PCM_FORMAT_S16 = SND_PCM_FORMAT_S16_LE,
207 /** Unsigned 16 bit CPU endian */
208 SND_PCM_FORMAT_U16 = SND_PCM_FORMAT_U16_LE,
209 /** Signed 24 bit CPU endian */
210 SND_PCM_FORMAT_S24 = SND_PCM_FORMAT_S24_LE,
211 /** Unsigned 24 bit CPU endian */
212 SND_PCM_FORMAT_U24 = SND_PCM_FORMAT_U24_LE,
213 /** Signed 32 bit CPU endian */
214 SND_PCM_FORMAT_S32 = SND_PCM_FORMAT_S32_LE,
215 /** Unsigned 32 bit CPU endian */
216 SND_PCM_FORMAT_U32 = SND_PCM_FORMAT_U32_LE,
217 /** Float 32 bit CPU endian */
218 SND_PCM_FORMAT_FLOAT = SND_PCM_FORMAT_FLOAT_LE,
219 /** Float 64 bit CPU endian */
220 SND_PCM_FORMAT_FLOAT64 = SND_PCM_FORMAT_FLOAT64_LE,
221 /** IEC-958 CPU Endian */
222 SND_PCM_FORMAT_IEC958_SUBFRAME = SND_PCM_FORMAT_IEC958_SUBFRAME_LE
223 #elif __BYTE_ORDER == __BIG_ENDIAN
224 /** Signed 16 bit CPU endian */
225 SND_PCM_FORMAT_S16 = SND_PCM_FORMAT_S16_BE,
226 /** Unsigned 16 bit CPU endian */
227 SND_PCM_FORMAT_U16 = SND_PCM_FORMAT_U16_BE,
228 /** Signed 24 bit CPU endian */
229 SND_PCM_FORMAT_S24 = SND_PCM_FORMAT_S24_BE,
230 /** Unsigned 24 bit CPU endian */
231 SND_PCM_FORMAT_U24 = SND_PCM_FORMAT_U24_BE,
232 /** Signed 32 bit CPU endian */
233 SND_PCM_FORMAT_S32 = SND_PCM_FORMAT_S32_BE,
234 /** Unsigned 32 bit CPU endian */
235 SND_PCM_FORMAT_U32 = SND_PCM_FORMAT_U32_BE,
236 /** Float 32 bit CPU endian */
237 SND_PCM_FORMAT_FLOAT = SND_PCM_FORMAT_FLOAT_BE,
238 /** Float 64 bit CPU endian */
239 SND_PCM_FORMAT_FLOAT64 = SND_PCM_FORMAT_FLOAT64_BE,
240 /** IEC-958 CPU Endian */
241 SND_PCM_FORMAT_IEC958_SUBFRAME = SND_PCM_FORMAT_IEC958_SUBFRAME_BE
243 #error "Unknown endian"
247 /** PCM sample subformat */
248 typedef enum _snd_pcm_subformat {
250 SND_PCM_SUBFORMAT_STD = 0,
251 SND_PCM_SUBFORMAT_LAST = SND_PCM_SUBFORMAT_STD
252 } snd_pcm_subformat_t;
255 typedef enum _snd_pcm_state {
257 SND_PCM_STATE_OPEN = 0,
258 /** Setup installed */
260 /** Ready to start */
261 SND_PCM_STATE_PREPARED,
263 SND_PCM_STATE_RUNNING,
264 /** Stopped: underrun (playback) or overrun (capture) detected */
266 /** Draining: running (playback) or stopped (capture) */
267 SND_PCM_STATE_DRAINING,
269 SND_PCM_STATE_PAUSED,
270 /** Hardware is suspended */
271 SND_PCM_STATE_SUSPENDED,
272 /** Hardware is disconnected */
273 SND_PCM_STATE_DISCONNECTED,
274 SND_PCM_STATE_LAST = SND_PCM_STATE_DISCONNECTED
277 /** PCM start mode */
278 typedef enum _snd_pcm_start {
279 /** Automatic start on data read/write */
280 SND_PCM_START_DATA = 0,
281 /** Explicit start */
282 SND_PCM_START_EXPLICIT,
283 SND_PCM_START_LAST = SND_PCM_START_EXPLICIT
287 typedef enum _snd_pcm_xrun {
288 /** Xrun detection disabled */
289 SND_PCM_XRUN_NONE = 0,
290 /** Stop on xrun detection */
292 SND_PCM_XRUN_LAST = SND_PCM_XRUN_STOP
295 /** PCM timestamp mode */
296 typedef enum _snd_pcm_tstamp {
298 SND_PCM_TSTAMP_NONE = 0,
299 /** Update timestamp at every hardware position update */
300 SND_PCM_TSTAMP_ENABLE,
301 /** Equivalent with #SND_PCM_TSTAMP_ENABLE,
302 * just for compatibility with older versions
304 SND_PCM_TSTAMP_MMAP = SND_PCM_TSTAMP_ENABLE,
305 SND_PCM_TSTAMP_LAST = SND_PCM_TSTAMP_ENABLE
308 /** Unsigned frames quantity */
309 typedef unsigned long snd_pcm_uframes_t;
310 /** Signed frames quantity */
311 typedef long snd_pcm_sframes_t;
313 /** Non blocking mode (flag for open mode) \hideinitializer */
314 #define SND_PCM_NONBLOCK 0x00000001
315 /** Async notification (flag for open mode) \hideinitializer */
316 #define SND_PCM_ASYNC 0x00000002
317 /** Disable automatic (but not forced!) rate resamplinig */
318 #define SND_PCM_NO_AUTO_RESAMPLE 0x00010000
319 /** Disable automatic (but not forced!) channel conversion */
320 #define SND_PCM_NO_AUTO_CHANNELS 0x00020000
321 /** Disable automatic (but not forced!) format conversion */
322 #define SND_PCM_NO_AUTO_FORMAT 0x00040000
323 /** Disable soft volume control */
324 #define SND_PCM_NO_SOFTVOL 0x00080000
327 typedef struct _snd_pcm snd_pcm_t;
331 /** Kernel level PCM */
335 /** One or more linked PCM with exclusive access to selected
338 /** File writing plugin */
340 /** Null endpoint PCM */
342 /** Shared memory client PCM */
344 /** INET client PCM (not yet implemented) */
346 /** Copying plugin */
348 /** Linear format conversion PCM */
350 /** A-Law format conversion PCM */
352 /** Mu-Law format conversion PCM */
354 /** IMA-ADPCM format conversion PCM */
356 /** Rate conversion PCM */
358 /** Attenuated static route PCM */
360 /** Format adjusted PCM */
368 /** Attenuated dynamic route PCM (not yet implemented) */
370 /** Loopback server plugin (not yet implemented) */
371 SND_PCM_TYPE_LBSERVER,
372 /** Linear Integer <-> Linear Float format conversion PCM */
373 SND_PCM_TYPE_LINEAR_FLOAT,
374 /** LADSPA integration plugin */
376 /** Direct Mixing plugin */
378 /** Jack Audio Connection Kit plugin */
380 /** Direct Snooping plugin */
382 /** Direct Sharing plugin */
384 /** IEC958 subframe plugin */
386 /** Soft volume plugin */
387 SND_PCM_TYPE_SOFTVOL,
388 /** External I/O plugin */
390 /** External filter plugin */
391 SND_PCM_TYPE_EXTPLUG,
392 /** Mmap-emulation plugin */
393 SND_PCM_TYPE_MMAP_EMUL,
394 SND_PCM_TYPE_LAST = SND_PCM_TYPE_MMAP_EMUL
398 typedef enum _snd_pcm_type snd_pcm_type_t;
400 /** PCM area specification */
401 typedef struct _snd_pcm_channel_area {
402 /** base address of channel samples */
404 /** offset to first sample in bits */
406 /** samples distance in bits */
408 } snd_pcm_channel_area_t;
410 /** PCM synchronization ID */
411 typedef union _snd_pcm_sync_id {
413 unsigned char id[16];
415 unsigned short id16[8];
417 unsigned int id32[4];
420 /** #SND_PCM_TYPE_METER scope handle */
421 typedef struct _snd_pcm_scope snd_pcm_scope_t;
423 int snd_pcm_open(snd_pcm_t **pcm, const char *name,
424 snd_pcm_stream_t stream, int mode);
425 int snd_pcm_open_lconf(snd_pcm_t **pcm, const char *name,
426 snd_pcm_stream_t stream, int mode,
427 snd_config_t *lconf);
428 int snd_pcm_open_fallback(snd_pcm_t **pcm, snd_config_t *root,
429 const char *name, const char *orig_name,
430 snd_pcm_stream_t stream, int mode);
432 int snd_pcm_close(snd_pcm_t *pcm);
433 const char *snd_pcm_name(snd_pcm_t *pcm);
434 snd_pcm_type_t snd_pcm_type(snd_pcm_t *pcm);
435 snd_pcm_stream_t snd_pcm_stream(snd_pcm_t *pcm);
436 int snd_pcm_poll_descriptors_count(snd_pcm_t *pcm);
437 int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space);
438 int snd_pcm_poll_descriptors_revents(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
439 int snd_pcm_nonblock(snd_pcm_t *pcm, int nonblock);
440 int snd_async_add_pcm_handler(snd_async_handler_t **handler, snd_pcm_t *pcm,
441 snd_async_callback_t callback, void *private_data);
442 snd_pcm_t *snd_async_handler_get_pcm(snd_async_handler_t *handler);
443 int snd_pcm_info(snd_pcm_t *pcm, snd_pcm_info_t *info);
444 int snd_pcm_hw_params_current(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
445 int snd_pcm_hw_params(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
446 int snd_pcm_hw_free(snd_pcm_t *pcm);
447 int snd_pcm_sw_params_current(snd_pcm_t *pcm, snd_pcm_sw_params_t *params);
448 int snd_pcm_sw_params(snd_pcm_t *pcm, snd_pcm_sw_params_t *params);
449 int snd_pcm_prepare(snd_pcm_t *pcm);
450 int snd_pcm_reset(snd_pcm_t *pcm);
451 int snd_pcm_status(snd_pcm_t *pcm, snd_pcm_status_t *status);
452 int snd_pcm_start(snd_pcm_t *pcm);
453 int snd_pcm_drop(snd_pcm_t *pcm);
454 int snd_pcm_drain(snd_pcm_t *pcm);
455 int snd_pcm_pause(snd_pcm_t *pcm, int enable);
456 snd_pcm_state_t snd_pcm_state(snd_pcm_t *pcm);
457 int snd_pcm_hwsync(snd_pcm_t *pcm);
458 int snd_pcm_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *delayp);
459 int snd_pcm_resume(snd_pcm_t *pcm);
460 int snd_pcm_htimestamp(snd_pcm_t *pcm, snd_pcm_uframes_t *avail, snd_htimestamp_t *tstamp);
461 snd_pcm_sframes_t snd_pcm_avail(snd_pcm_t *pcm);
462 snd_pcm_sframes_t snd_pcm_avail_update(snd_pcm_t *pcm);
463 int snd_pcm_avail_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *availp, snd_pcm_sframes_t *delayp);
464 snd_pcm_sframes_t snd_pcm_rewindable(snd_pcm_t *pcm);
465 snd_pcm_sframes_t snd_pcm_rewind(snd_pcm_t *pcm, snd_pcm_uframes_t frames);
466 snd_pcm_sframes_t snd_pcm_forwardable(snd_pcm_t *pcm);
467 snd_pcm_sframes_t snd_pcm_forward(snd_pcm_t *pcm, snd_pcm_uframes_t frames);
468 snd_pcm_sframes_t snd_pcm_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size);
469 snd_pcm_sframes_t snd_pcm_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size);
470 snd_pcm_sframes_t snd_pcm_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
471 snd_pcm_sframes_t snd_pcm_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
472 int snd_pcm_wait(snd_pcm_t *pcm, int timeout);
474 int snd_pcm_link(snd_pcm_t *pcm1, snd_pcm_t *pcm2);
475 int snd_pcm_unlink(snd_pcm_t *pcm);
477 //int snd_pcm_mixer_element(snd_pcm_t *pcm, snd_mixer_t *mixer, snd_mixer_elem_t **elem);
480 * application helpers - these functions are implemented on top
484 int snd_pcm_recover(snd_pcm_t *pcm, int err, int silent);
485 int snd_pcm_set_params(snd_pcm_t *pcm,
486 snd_pcm_format_t format,
487 snd_pcm_access_t access,
488 unsigned int channels,
491 unsigned int latency);
492 int snd_pcm_get_params(snd_pcm_t *pcm,
493 snd_pcm_uframes_t *buffer_size,
494 snd_pcm_uframes_t *period_size);
499 * \defgroup PCM_Info Stream Information
501 * See the \ref pcm page for more details.
505 size_t snd_pcm_info_sizeof(void);
507 * \brief allocate an invalid #snd_pcm_info_t using standard alloca
508 * \param ptr returned pointer
510 #define snd_pcm_info_alloca(ptr) __snd_alloca(ptr, snd_pcm_info)
511 int snd_pcm_info_malloc(snd_pcm_info_t **ptr);
512 void snd_pcm_info_free(snd_pcm_info_t *obj);
513 void snd_pcm_info_copy(snd_pcm_info_t *dst, const snd_pcm_info_t *src);
514 unsigned int snd_pcm_info_get_device(const snd_pcm_info_t *obj);
515 unsigned int snd_pcm_info_get_subdevice(const snd_pcm_info_t *obj);
516 snd_pcm_stream_t snd_pcm_info_get_stream(const snd_pcm_info_t *obj);
517 int snd_pcm_info_get_card(const snd_pcm_info_t *obj);
518 const char *snd_pcm_info_get_id(const snd_pcm_info_t *obj);
519 const char *snd_pcm_info_get_name(const snd_pcm_info_t *obj);
520 const char *snd_pcm_info_get_subdevice_name(const snd_pcm_info_t *obj);
521 snd_pcm_class_t snd_pcm_info_get_class(const snd_pcm_info_t *obj);
522 snd_pcm_subclass_t snd_pcm_info_get_subclass(const snd_pcm_info_t *obj);
523 unsigned int snd_pcm_info_get_subdevices_count(const snd_pcm_info_t *obj);
524 unsigned int snd_pcm_info_get_subdevices_avail(const snd_pcm_info_t *obj);
525 snd_pcm_sync_id_t snd_pcm_info_get_sync(const snd_pcm_info_t *obj);
526 void snd_pcm_info_set_device(snd_pcm_info_t *obj, unsigned int val);
527 void snd_pcm_info_set_subdevice(snd_pcm_info_t *obj, unsigned int val);
528 void snd_pcm_info_set_stream(snd_pcm_info_t *obj, snd_pcm_stream_t val);
533 * \defgroup PCM_HW_Params Hardware Parameters
535 * See the \ref pcm page for more details.
539 int snd_pcm_hw_params_any(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
541 int snd_pcm_hw_params_can_mmap_sample_resolution(const snd_pcm_hw_params_t *params);
542 int snd_pcm_hw_params_is_double(const snd_pcm_hw_params_t *params);
543 int snd_pcm_hw_params_is_batch(const snd_pcm_hw_params_t *params);
544 int snd_pcm_hw_params_is_block_transfer(const snd_pcm_hw_params_t *params);
545 int snd_pcm_hw_params_is_monotonic(const snd_pcm_hw_params_t *params);
546 int snd_pcm_hw_params_can_overrange(const snd_pcm_hw_params_t *params);
547 int snd_pcm_hw_params_can_pause(const snd_pcm_hw_params_t *params);
548 int snd_pcm_hw_params_can_resume(const snd_pcm_hw_params_t *params);
549 int snd_pcm_hw_params_is_half_duplex(const snd_pcm_hw_params_t *params);
550 int snd_pcm_hw_params_is_joint_duplex(const snd_pcm_hw_params_t *params);
551 int snd_pcm_hw_params_can_sync_start(const snd_pcm_hw_params_t *params);
552 int snd_pcm_hw_params_can_disable_period_wakeup(const snd_pcm_hw_params_t *params);
553 int snd_pcm_hw_params_get_rate_numden(const snd_pcm_hw_params_t *params,
554 unsigned int *rate_num,
555 unsigned int *rate_den);
556 int snd_pcm_hw_params_get_sbits(const snd_pcm_hw_params_t *params);
557 int snd_pcm_hw_params_get_fifo_size(const snd_pcm_hw_params_t *params);
560 typedef struct _snd_pcm_hw_strategy snd_pcm_hw_strategy_t;
562 /* choices need to be sorted on ascending badness */
563 typedef struct _snd_pcm_hw_strategy_simple_choices_list {
565 unsigned int badness;
566 } snd_pcm_hw_strategy_simple_choices_list_t;
568 int snd_pcm_hw_params_strategy(snd_pcm_t *pcm, snd_pcm_hw_params_t *params,
569 const snd_pcm_hw_strategy_t *strategy,
570 unsigned int badness_min,
571 unsigned int badness_max);
573 void snd_pcm_hw_strategy_free(snd_pcm_hw_strategy_t *strategy);
574 int snd_pcm_hw_strategy_simple(snd_pcm_hw_strategy_t **strategyp,
575 unsigned int badness_min,
576 unsigned int badness_max);
577 int snd_pcm_hw_params_try_explain_failure(snd_pcm_t *pcm,
578 snd_pcm_hw_params_t *fail,
579 snd_pcm_hw_params_t *success,
585 size_t snd_pcm_hw_params_sizeof(void);
587 * \brief allocate an invalid #snd_pcm_hw_params_t using standard alloca
588 * \param ptr returned pointer
590 #define snd_pcm_hw_params_alloca(ptr) __snd_alloca(ptr, snd_pcm_hw_params)
591 int snd_pcm_hw_params_malloc(snd_pcm_hw_params_t **ptr);
592 void snd_pcm_hw_params_free(snd_pcm_hw_params_t *obj);
593 void snd_pcm_hw_params_copy(snd_pcm_hw_params_t *dst, const snd_pcm_hw_params_t *src);
595 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_HW_PARAMS_API)
597 int snd_pcm_hw_params_get_access(const snd_pcm_hw_params_t *params, snd_pcm_access_t *_access);
598 int snd_pcm_hw_params_test_access(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t _access);
599 int snd_pcm_hw_params_set_access(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t _access);
600 int snd_pcm_hw_params_set_access_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *_access);
601 int snd_pcm_hw_params_set_access_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *_access);
602 int snd_pcm_hw_params_set_access_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask);
603 int snd_pcm_hw_params_get_access_mask(snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask);
605 int snd_pcm_hw_params_get_format(const snd_pcm_hw_params_t *params, snd_pcm_format_t *val);
606 int snd_pcm_hw_params_test_format(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val);
607 int snd_pcm_hw_params_set_format(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val);
608 int snd_pcm_hw_params_set_format_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format);
609 int snd_pcm_hw_params_set_format_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format);
610 int snd_pcm_hw_params_set_format_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask);
611 void snd_pcm_hw_params_get_format_mask(snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask);
613 int snd_pcm_hw_params_get_subformat(const snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat);
614 int snd_pcm_hw_params_test_subformat(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat);
615 int snd_pcm_hw_params_set_subformat(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat);
616 int snd_pcm_hw_params_set_subformat_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat);
617 int snd_pcm_hw_params_set_subformat_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat);
618 int snd_pcm_hw_params_set_subformat_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask);
619 void snd_pcm_hw_params_get_subformat_mask(snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask);
621 int snd_pcm_hw_params_get_channels(const snd_pcm_hw_params_t *params, unsigned int *val);
622 int snd_pcm_hw_params_get_channels_min(const snd_pcm_hw_params_t *params, unsigned int *val);
623 int snd_pcm_hw_params_get_channels_max(const snd_pcm_hw_params_t *params, unsigned int *val);
624 int snd_pcm_hw_params_test_channels(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
625 int snd_pcm_hw_params_set_channels(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
626 int snd_pcm_hw_params_set_channels_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
627 int snd_pcm_hw_params_set_channels_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
628 int snd_pcm_hw_params_set_channels_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, unsigned int *max);
629 int snd_pcm_hw_params_set_channels_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
630 int snd_pcm_hw_params_set_channels_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
631 int snd_pcm_hw_params_set_channels_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
633 int snd_pcm_hw_params_get_rate(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
634 int snd_pcm_hw_params_get_rate_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
635 int snd_pcm_hw_params_get_rate_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
636 int snd_pcm_hw_params_test_rate(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
637 int snd_pcm_hw_params_set_rate(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
638 int snd_pcm_hw_params_set_rate_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
639 int snd_pcm_hw_params_set_rate_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
640 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);
641 int snd_pcm_hw_params_set_rate_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
642 int snd_pcm_hw_params_set_rate_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
643 int snd_pcm_hw_params_set_rate_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
644 int snd_pcm_hw_params_set_rate_resample(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
645 int snd_pcm_hw_params_get_rate_resample(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
646 int snd_pcm_hw_params_set_export_buffer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
647 int snd_pcm_hw_params_get_export_buffer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
648 int snd_pcm_hw_params_set_period_wakeup(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
649 int snd_pcm_hw_params_get_period_wakeup(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
651 int snd_pcm_hw_params_get_period_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
652 int snd_pcm_hw_params_get_period_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
653 int snd_pcm_hw_params_get_period_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
654 int snd_pcm_hw_params_test_period_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
655 int snd_pcm_hw_params_set_period_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
656 int snd_pcm_hw_params_set_period_time_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
657 int snd_pcm_hw_params_set_period_time_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
658 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);
659 int snd_pcm_hw_params_set_period_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
660 int snd_pcm_hw_params_set_period_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
661 int snd_pcm_hw_params_set_period_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
663 int snd_pcm_hw_params_get_period_size(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
664 int snd_pcm_hw_params_get_period_size_min(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
665 int snd_pcm_hw_params_get_period_size_max(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
666 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);
667 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);
668 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);
669 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);
670 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);
671 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);
672 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);
673 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);
674 int snd_pcm_hw_params_set_period_size_integer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
676 int snd_pcm_hw_params_get_periods(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
677 int snd_pcm_hw_params_get_periods_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
678 int snd_pcm_hw_params_get_periods_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
679 int snd_pcm_hw_params_test_periods(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
680 int snd_pcm_hw_params_set_periods(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
681 int snd_pcm_hw_params_set_periods_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
682 int snd_pcm_hw_params_set_periods_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
683 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);
684 int snd_pcm_hw_params_set_periods_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
685 int snd_pcm_hw_params_set_periods_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
686 int snd_pcm_hw_params_set_periods_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
687 int snd_pcm_hw_params_set_periods_integer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
689 int snd_pcm_hw_params_get_buffer_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
690 int snd_pcm_hw_params_get_buffer_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
691 int snd_pcm_hw_params_get_buffer_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
692 int snd_pcm_hw_params_test_buffer_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
693 int snd_pcm_hw_params_set_buffer_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
694 int snd_pcm_hw_params_set_buffer_time_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
695 int snd_pcm_hw_params_set_buffer_time_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
696 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);
697 int snd_pcm_hw_params_set_buffer_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
698 int snd_pcm_hw_params_set_buffer_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
699 int snd_pcm_hw_params_set_buffer_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
701 int snd_pcm_hw_params_get_buffer_size(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
702 int snd_pcm_hw_params_get_buffer_size_min(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
703 int snd_pcm_hw_params_get_buffer_size_max(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
704 int snd_pcm_hw_params_test_buffer_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val);
705 int snd_pcm_hw_params_set_buffer_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val);
706 int snd_pcm_hw_params_set_buffer_size_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
707 int snd_pcm_hw_params_set_buffer_size_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
708 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);
709 int snd_pcm_hw_params_set_buffer_size_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
710 int snd_pcm_hw_params_set_buffer_size_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
711 int snd_pcm_hw_params_set_buffer_size_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
713 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_HW_PARAMS_API */
715 int snd_pcm_hw_params_get_min_align(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
720 * \defgroup PCM_SW_Params Software Parameters
722 * See the \ref pcm page for more details.
726 size_t snd_pcm_sw_params_sizeof(void);
728 * \brief allocate an invalid #snd_pcm_sw_params_t using standard alloca
729 * \param ptr returned pointer
731 #define snd_pcm_sw_params_alloca(ptr) __snd_alloca(ptr, snd_pcm_sw_params)
732 int snd_pcm_sw_params_malloc(snd_pcm_sw_params_t **ptr);
733 void snd_pcm_sw_params_free(snd_pcm_sw_params_t *obj);
734 void snd_pcm_sw_params_copy(snd_pcm_sw_params_t *dst, const snd_pcm_sw_params_t *src);
735 int snd_pcm_sw_params_get_boundary(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
737 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_SW_PARAMS_API)
739 int snd_pcm_sw_params_set_tstamp_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_tstamp_t val);
740 int snd_pcm_sw_params_get_tstamp_mode(const snd_pcm_sw_params_t *params, snd_pcm_tstamp_t *val);
741 int snd_pcm_sw_params_set_avail_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
742 int snd_pcm_sw_params_get_avail_min(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
743 int snd_pcm_sw_params_set_period_event(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, int val);
744 int snd_pcm_sw_params_get_period_event(const snd_pcm_sw_params_t *params, int *val);
745 int snd_pcm_sw_params_set_start_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
746 int snd_pcm_sw_params_get_start_threshold(const snd_pcm_sw_params_t *paramsm, snd_pcm_uframes_t *val);
747 int snd_pcm_sw_params_set_stop_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
748 int snd_pcm_sw_params_get_stop_threshold(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
749 int snd_pcm_sw_params_set_silence_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
750 int snd_pcm_sw_params_get_silence_threshold(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
751 int snd_pcm_sw_params_set_silence_size(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
752 int snd_pcm_sw_params_get_silence_size(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
754 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_SW_PARAMS_API */
758 /* include old API */
759 #ifndef ALSA_LIBRARY_BUILD
760 #if defined(ALSA_PCM_OLD_HW_PARAMS_API) || defined(ALSA_PCM_OLD_SW_PARAMS_API)
766 * \defgroup PCM_Access Access Mask Functions
768 * See the \ref pcm page for more details.
772 size_t snd_pcm_access_mask_sizeof(void);
774 * \brief allocate an empty #snd_pcm_access_mask_t using standard alloca
775 * \param ptr returned pointer
777 #define snd_pcm_access_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_access_mask)
778 int snd_pcm_access_mask_malloc(snd_pcm_access_mask_t **ptr);
779 void snd_pcm_access_mask_free(snd_pcm_access_mask_t *obj);
780 void snd_pcm_access_mask_copy(snd_pcm_access_mask_t *dst, const snd_pcm_access_mask_t *src);
781 void snd_pcm_access_mask_none(snd_pcm_access_mask_t *mask);
782 void snd_pcm_access_mask_any(snd_pcm_access_mask_t *mask);
783 int snd_pcm_access_mask_test(const snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
784 int snd_pcm_access_mask_empty(const snd_pcm_access_mask_t *mask);
785 void snd_pcm_access_mask_set(snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
786 void snd_pcm_access_mask_reset(snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
791 * \defgroup PCM_Format Format Mask Functions
793 * See the \ref pcm page for more details.
797 size_t snd_pcm_format_mask_sizeof(void);
799 * \brief allocate an empty #snd_pcm_format_mask_t using standard alloca
800 * \param ptr returned pointer
802 #define snd_pcm_format_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_format_mask)
803 int snd_pcm_format_mask_malloc(snd_pcm_format_mask_t **ptr);
804 void snd_pcm_format_mask_free(snd_pcm_format_mask_t *obj);
805 void snd_pcm_format_mask_copy(snd_pcm_format_mask_t *dst, const snd_pcm_format_mask_t *src);
806 void snd_pcm_format_mask_none(snd_pcm_format_mask_t *mask);
807 void snd_pcm_format_mask_any(snd_pcm_format_mask_t *mask);
808 int snd_pcm_format_mask_test(const snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
809 int snd_pcm_format_mask_empty(const snd_pcm_format_mask_t *mask);
810 void snd_pcm_format_mask_set(snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
811 void snd_pcm_format_mask_reset(snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
816 * \defgroup PCM_SubFormat Subformat Mask Functions
818 * See the \ref pcm page for more details.
822 size_t snd_pcm_subformat_mask_sizeof(void);
824 * \brief allocate an empty #snd_pcm_subformat_mask_t using standard alloca
825 * \param ptr returned pointer
827 #define snd_pcm_subformat_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_subformat_mask)
828 int snd_pcm_subformat_mask_malloc(snd_pcm_subformat_mask_t **ptr);
829 void snd_pcm_subformat_mask_free(snd_pcm_subformat_mask_t *obj);
830 void snd_pcm_subformat_mask_copy(snd_pcm_subformat_mask_t *dst, const snd_pcm_subformat_mask_t *src);
831 void snd_pcm_subformat_mask_none(snd_pcm_subformat_mask_t *mask);
832 void snd_pcm_subformat_mask_any(snd_pcm_subformat_mask_t *mask);
833 int snd_pcm_subformat_mask_test(const snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
834 int snd_pcm_subformat_mask_empty(const snd_pcm_subformat_mask_t *mask);
835 void snd_pcm_subformat_mask_set(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
836 void snd_pcm_subformat_mask_reset(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
841 * \defgroup PCM_Status Status Functions
843 * See the \ref pcm page for more details.
847 size_t snd_pcm_status_sizeof(void);
849 * \brief allocate an invalid #snd_pcm_status_t using standard alloca
850 * \param ptr returned pointer
852 #define snd_pcm_status_alloca(ptr) __snd_alloca(ptr, snd_pcm_status)
853 int snd_pcm_status_malloc(snd_pcm_status_t **ptr);
854 void snd_pcm_status_free(snd_pcm_status_t *obj);
855 void snd_pcm_status_copy(snd_pcm_status_t *dst, const snd_pcm_status_t *src);
856 snd_pcm_state_t snd_pcm_status_get_state(const snd_pcm_status_t *obj);
857 void snd_pcm_status_get_trigger_tstamp(const snd_pcm_status_t *obj, snd_timestamp_t *ptr);
858 void snd_pcm_status_get_trigger_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr);
859 void snd_pcm_status_get_tstamp(const snd_pcm_status_t *obj, snd_timestamp_t *ptr);
860 void snd_pcm_status_get_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr);
861 snd_pcm_sframes_t snd_pcm_status_get_delay(const snd_pcm_status_t *obj);
862 snd_pcm_uframes_t snd_pcm_status_get_avail(const snd_pcm_status_t *obj);
863 snd_pcm_uframes_t snd_pcm_status_get_avail_max(const snd_pcm_status_t *obj);
864 snd_pcm_uframes_t snd_pcm_status_get_overrange(const snd_pcm_status_t *obj);
869 * \defgroup PCM_Description Description Functions
871 * See the \ref pcm page for more details.
875 const char *snd_pcm_type_name(snd_pcm_type_t type);
876 const char *snd_pcm_stream_name(const snd_pcm_stream_t stream);
877 const char *snd_pcm_access_name(const snd_pcm_access_t _access);
878 const char *snd_pcm_format_name(const snd_pcm_format_t format);
879 const char *snd_pcm_format_description(const snd_pcm_format_t format);
880 const char *snd_pcm_subformat_name(const snd_pcm_subformat_t subformat);
881 const char *snd_pcm_subformat_description(const snd_pcm_subformat_t subformat);
882 snd_pcm_format_t snd_pcm_format_value(const char* name);
883 const char *snd_pcm_tstamp_mode_name(const snd_pcm_tstamp_t mode);
884 const char *snd_pcm_state_name(const snd_pcm_state_t state);
889 * \defgroup PCM_Dump Debug Functions
891 * See the \ref pcm page for more details.
895 int snd_pcm_dump(snd_pcm_t *pcm, snd_output_t *out);
896 int snd_pcm_dump_hw_setup(snd_pcm_t *pcm, snd_output_t *out);
897 int snd_pcm_dump_sw_setup(snd_pcm_t *pcm, snd_output_t *out);
898 int snd_pcm_dump_setup(snd_pcm_t *pcm, snd_output_t *out);
899 int snd_pcm_hw_params_dump(snd_pcm_hw_params_t *params, snd_output_t *out);
900 int snd_pcm_sw_params_dump(snd_pcm_sw_params_t *params, snd_output_t *out);
901 int snd_pcm_status_dump(snd_pcm_status_t *status, snd_output_t *out);
906 * \defgroup PCM_Direct Direct Access (MMAP) Functions
908 * See the \ref pcm page for more details.
912 int snd_pcm_mmap_begin(snd_pcm_t *pcm,
913 const snd_pcm_channel_area_t **areas,
914 snd_pcm_uframes_t *offset,
915 snd_pcm_uframes_t *frames);
916 snd_pcm_sframes_t snd_pcm_mmap_commit(snd_pcm_t *pcm,
917 snd_pcm_uframes_t offset,
918 snd_pcm_uframes_t frames);
919 snd_pcm_sframes_t snd_pcm_mmap_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size);
920 snd_pcm_sframes_t snd_pcm_mmap_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size);
921 snd_pcm_sframes_t snd_pcm_mmap_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
922 snd_pcm_sframes_t snd_pcm_mmap_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
927 * \defgroup PCM_Helpers Helper Functions
929 * See the \ref pcm page for more details.
933 int snd_pcm_format_signed(snd_pcm_format_t format);
934 int snd_pcm_format_unsigned(snd_pcm_format_t format);
935 int snd_pcm_format_linear(snd_pcm_format_t format);
936 int snd_pcm_format_float(snd_pcm_format_t format);
937 int snd_pcm_format_little_endian(snd_pcm_format_t format);
938 int snd_pcm_format_big_endian(snd_pcm_format_t format);
939 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
940 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
941 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
942 snd_pcm_format_t snd_pcm_build_linear_format(int width, int pwidth, int unsignd, int big_endian);
943 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
944 u_int8_t snd_pcm_format_silence(snd_pcm_format_t format);
945 u_int16_t snd_pcm_format_silence_16(snd_pcm_format_t format);
946 u_int32_t snd_pcm_format_silence_32(snd_pcm_format_t format);
947 u_int64_t snd_pcm_format_silence_64(snd_pcm_format_t format);
948 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int samples);
950 snd_pcm_sframes_t snd_pcm_bytes_to_frames(snd_pcm_t *pcm, ssize_t bytes);
951 ssize_t snd_pcm_frames_to_bytes(snd_pcm_t *pcm, snd_pcm_sframes_t frames);
952 long snd_pcm_bytes_to_samples(snd_pcm_t *pcm, ssize_t bytes);
953 ssize_t snd_pcm_samples_to_bytes(snd_pcm_t *pcm, long samples);
955 int snd_pcm_area_silence(const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset,
956 unsigned int samples, snd_pcm_format_t format);
957 int snd_pcm_areas_silence(const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset,
958 unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format);
959 int snd_pcm_area_copy(const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset,
960 const snd_pcm_channel_area_t *src_channel, snd_pcm_uframes_t src_offset,
961 unsigned int samples, snd_pcm_format_t format);
962 int snd_pcm_areas_copy(const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset,
963 const snd_pcm_channel_area_t *src_channels, snd_pcm_uframes_t src_offset,
964 unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format);
969 * \defgroup PCM_Hook Hook Extension
971 * See the \ref pcm page for more details.
975 /** type of pcm hook */
976 typedef enum _snd_pcm_hook_type {
977 SND_PCM_HOOK_TYPE_HW_PARAMS = 0,
978 SND_PCM_HOOK_TYPE_HW_FREE,
979 SND_PCM_HOOK_TYPE_CLOSE,
980 SND_PCM_HOOK_TYPE_LAST = SND_PCM_HOOK_TYPE_CLOSE
981 } snd_pcm_hook_type_t;
983 /** PCM hook container */
984 typedef struct _snd_pcm_hook snd_pcm_hook_t;
985 /** PCM hook callback function */
986 typedef int (*snd_pcm_hook_func_t)(snd_pcm_hook_t *hook);
987 snd_pcm_t *snd_pcm_hook_get_pcm(snd_pcm_hook_t *hook);
988 void *snd_pcm_hook_get_private(snd_pcm_hook_t *hook);
989 void snd_pcm_hook_set_private(snd_pcm_hook_t *hook, void *private_data);
990 int snd_pcm_hook_add(snd_pcm_hook_t **hookp, snd_pcm_t *pcm,
991 snd_pcm_hook_type_t type,
992 snd_pcm_hook_func_t func, void *private_data);
993 int snd_pcm_hook_remove(snd_pcm_hook_t *hook);
998 * \defgroup PCM_Scope Scope Plugin Extension
1000 * See the \ref pcm page for more details.
1004 /** #SND_PCM_TYPE_METER scope functions */
1005 typedef struct _snd_pcm_scope_ops {
1006 /** \brief Enable and prepare it using current params
1007 * \param scope scope handle
1009 int (*enable)(snd_pcm_scope_t *scope);
1011 * \param scope scope handle
1013 void (*disable)(snd_pcm_scope_t *scope);
1014 /** \brief PCM has been started
1015 * \param scope scope handle
1017 void (*start)(snd_pcm_scope_t *scope);
1018 /** \brief PCM has been stopped
1019 * \param scope scope handle
1021 void (*stop)(snd_pcm_scope_t *scope);
1022 /** \brief New frames are present
1023 * \param scope scope handle
1025 void (*update)(snd_pcm_scope_t *scope);
1026 /** \brief Reset status
1027 * \param scope scope handle
1029 void (*reset)(snd_pcm_scope_t *scope);
1030 /** \brief PCM is closing
1031 * \param scope scope handle
1033 void (*close)(snd_pcm_scope_t *scope);
1034 } snd_pcm_scope_ops_t;
1036 snd_pcm_uframes_t snd_pcm_meter_get_bufsize(snd_pcm_t *pcm);
1037 unsigned int snd_pcm_meter_get_channels(snd_pcm_t *pcm);
1038 unsigned int snd_pcm_meter_get_rate(snd_pcm_t *pcm);
1039 snd_pcm_uframes_t snd_pcm_meter_get_now(snd_pcm_t *pcm);
1040 snd_pcm_uframes_t snd_pcm_meter_get_boundary(snd_pcm_t *pcm);
1041 int snd_pcm_meter_add_scope(snd_pcm_t *pcm, snd_pcm_scope_t *scope);
1042 snd_pcm_scope_t *snd_pcm_meter_search_scope(snd_pcm_t *pcm, const char *name);
1043 int snd_pcm_scope_malloc(snd_pcm_scope_t **ptr);
1044 void snd_pcm_scope_set_ops(snd_pcm_scope_t *scope,
1045 const snd_pcm_scope_ops_t *val);
1046 void snd_pcm_scope_set_name(snd_pcm_scope_t *scope, const char *val);
1047 const char *snd_pcm_scope_get_name(snd_pcm_scope_t *scope);
1048 void *snd_pcm_scope_get_callback_private(snd_pcm_scope_t *scope);
1049 void snd_pcm_scope_set_callback_private(snd_pcm_scope_t *scope, void *val);
1050 int snd_pcm_scope_s16_open(snd_pcm_t *pcm, const char *name,
1051 snd_pcm_scope_t **scopep);
1052 int16_t *snd_pcm_scope_s16_get_channel_buffer(snd_pcm_scope_t *scope,
1053 unsigned int channel);
1058 * \defgroup PCM_Simple Simple setup functions
1060 * See the \ref pcm page for more details.
1064 /** Simple PCM latency type */
1065 typedef enum _snd_spcm_latency {
1066 /** standard latency - for standard playback or capture
1067 (estimated latency in one direction 350ms) */
1068 SND_SPCM_LATENCY_STANDARD = 0,
1069 /** medium latency - software phones etc.
1070 (estimated latency in one direction maximally 25ms */
1071 SND_SPCM_LATENCY_MEDIUM,
1072 /** realtime latency - realtime applications (effect processors etc.)
1073 (estimated latency in one direction 5ms and better) */
1074 SND_SPCM_LATENCY_REALTIME
1075 } snd_spcm_latency_t;
1077 /** Simple PCM xrun type */
1078 typedef enum _snd_spcm_xrun_type {
1079 /** driver / library will ignore all xruns, the stream runs forever */
1080 SND_SPCM_XRUN_IGNORE = 0,
1081 /** driver / library stops the stream when an xrun occurs */
1083 } snd_spcm_xrun_type_t;
1085 /** Simple PCM duplex type */
1086 typedef enum _snd_spcm_duplex_type {
1087 /** liberal duplex - the buffer and period sizes might not match */
1088 SND_SPCM_DUPLEX_LIBERAL = 0,
1089 /** pedantic duplex - the buffer and period sizes MUST match */
1090 SND_SPCM_DUPLEX_PEDANTIC
1091 } snd_spcm_duplex_type_t;
1093 int snd_spcm_init(snd_pcm_t *pcm,
1095 unsigned int channels,
1096 snd_pcm_format_t format,
1097 snd_pcm_subformat_t subformat,
1098 snd_spcm_latency_t latency,
1099 snd_pcm_access_t _access,
1100 snd_spcm_xrun_type_t xrun_type);
1102 int snd_spcm_init_duplex(snd_pcm_t *playback_pcm,
1103 snd_pcm_t *capture_pcm,
1105 unsigned int channels,
1106 snd_pcm_format_t format,
1107 snd_pcm_subformat_t subformat,
1108 snd_spcm_latency_t latency,
1109 snd_pcm_access_t _access,
1110 snd_spcm_xrun_type_t xrun_type,
1111 snd_spcm_duplex_type_t duplex_type);
1113 int snd_spcm_init_get_params(snd_pcm_t *pcm,
1115 snd_pcm_uframes_t *buffer_size,
1116 snd_pcm_uframes_t *period_size);
1121 * \defgroup PCM_Deprecated Deprecated Functions
1123 * See the \ref pcm page for more details.
1127 /* Deprecated functions, for compatibility */
1128 const char *snd_pcm_start_mode_name(snd_pcm_start_t mode) __attribute__((deprecated));
1129 const char *snd_pcm_xrun_mode_name(snd_pcm_xrun_t mode) __attribute__((deprecated));
1130 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));
1131 snd_pcm_start_t snd_pcm_sw_params_get_start_mode(const snd_pcm_sw_params_t *params) __attribute__((deprecated));
1132 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));
1133 snd_pcm_xrun_t snd_pcm_sw_params_get_xrun_mode(const snd_pcm_sw_params_t *params) __attribute__((deprecated));
1134 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_SW_PARAMS_API)
1135 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));
1136 int snd_pcm_sw_params_get_xfer_align(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val) __attribute__((deprecated));
1137 int snd_pcm_sw_params_set_sleep_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, unsigned int val) __attribute__((deprecated));
1138 int snd_pcm_sw_params_get_sleep_min(const snd_pcm_sw_params_t *params, unsigned int *val) __attribute__((deprecated));
1139 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_SW_PARAMS_API */
1140 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_HW_PARAMS_API)
1141 int snd_pcm_hw_params_get_tick_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1142 int snd_pcm_hw_params_get_tick_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1143 int snd_pcm_hw_params_get_tick_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1144 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));
1145 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));
1146 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));
1147 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));
1148 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));
1149 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));
1150 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));
1151 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));
1152 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_HW_PARAMS_API */
1160 #endif /* __ALSA_PCM_H */