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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 26 * 27 */ 28 29#ifndef __ALSA_PCM_H 30#define __ALSA_PCM_H 31 32#ifdef __cplusplus 33extern "C" { 34#endif 35 36/** 37 * \defgroup PCM PCM Interface 38 * See the \ref pcm page for more details. 39 * \{ 40 */ 41 42/** dlsym version for interface entry callback */ 43#define SND_PCM_DLSYM_VERSION _dlsym_pcm_001 44 45/** PCM generic info container */ 46typedef struct _snd_pcm_info snd_pcm_info_t; 47/** PCM hardware configuration space container */ 48typedef struct _snd_pcm_hw_params snd_pcm_hw_params_t; 49/** PCM software configuration container */ 50typedef struct _snd_pcm_sw_params snd_pcm_sw_params_t; 51/** PCM status container */ 52 typedef struct _snd_pcm_status snd_pcm_status_t; 53/** PCM access types mask */ 54typedef struct _snd_pcm_access_mask snd_pcm_access_mask_t; 55/** PCM formats mask */ 56typedef struct _snd_pcm_format_mask snd_pcm_format_mask_t; 57/** PCM subformats mask */ 58typedef struct _snd_pcm_subformat_mask snd_pcm_subformat_mask_t; 59 60/** PCM class */ 61typedef enum _snd_pcm_class { 62 /** standard device */ 63 64 SND_PCM_CLASS_GENERIC = 0, 65 /** multichannel device */ 66 SND_PCM_CLASS_MULTI, 67 /** software modem device */ 68 SND_PCM_CLASS_MODEM, 69 /** digitizer device */ 70 SND_PCM_CLASS_DIGITIZER, 71 SND_PCM_CLASS_LAST = SND_PCM_CLASS_DIGITIZER 72} snd_pcm_class_t; 73 74/** PCM subclass */ 75typedef enum _snd_pcm_subclass { 76 /** subdevices are mixed together */ 77 SND_PCM_SUBCLASS_GENERIC_MIX = 0, 78 /** multichannel subdevices are mixed together */ 79 SND_PCM_SUBCLASS_MULTI_MIX, 80 SND_PCM_SUBCLASS_LAST = SND_PCM_SUBCLASS_MULTI_MIX 81} snd_pcm_subclass_t; 82 83/** PCM stream (direction) */ 84typedef enum _snd_pcm_stream { 85 /** Playback stream */ 86 SND_PCM_STREAM_PLAYBACK = 0, 87 /** Capture stream */ 88 SND_PCM_STREAM_CAPTURE, 89 SND_PCM_STREAM_LAST = SND_PCM_STREAM_CAPTURE 90} snd_pcm_stream_t; 91 92/** PCM access type */ 93typedef enum _snd_pcm_access { 94 /** mmap access with simple interleaved channels */ 95 SND_PCM_ACCESS_MMAP_INTERLEAVED = 0, 96 /** mmap access with simple non interleaved channels */ 97 SND_PCM_ACCESS_MMAP_NONINTERLEAVED, 98 /** mmap access with complex placement */ 99 SND_PCM_ACCESS_MMAP_COMPLEX, 100 /** snd_pcm_readi/snd_pcm_writei access */ 101 SND_PCM_ACCESS_RW_INTERLEAVED, 102 /** snd_pcm_readn/snd_pcm_writen access */ 103 SND_PCM_ACCESS_RW_NONINTERLEAVED, 104 SND_PCM_ACCESS_LAST = SND_PCM_ACCESS_RW_NONINTERLEAVED 105} snd_pcm_access_t; 106 107/** PCM sample format */ 108typedef enum _snd_pcm_format { 109 /** Unknown */ 110 SND_PCM_FORMAT_UNKNOWN = -1, 111 /** Signed 8 bit */ 112 SND_PCM_FORMAT_S8 = 0, 113 /** Unsigned 8 bit */ 114 SND_PCM_FORMAT_U8, 115 /** Signed 16 bit Little Endian */ 116 SND_PCM_FORMAT_S16_LE, 117 /** Signed 16 bit Big Endian */ 118 SND_PCM_FORMAT_S16_BE, 119 /** Unsigned 16 bit Little Endian */ 120 SND_PCM_FORMAT_U16_LE, 121 /** Unsigned 16 bit Big Endian */ 122 SND_PCM_FORMAT_U16_BE, 123 /** Signed 24 bit Little Endian using low three bytes in 32-bit word */ 124 SND_PCM_FORMAT_S24_LE, 125 /** Signed 24 bit Big Endian using low three bytes in 32-bit word */ 126 SND_PCM_FORMAT_S24_BE, 127 /** Unsigned 24 bit Little Endian using low three bytes in 32-bit word */ 128 SND_PCM_FORMAT_U24_LE, 129 /** Unsigned 24 bit Big Endian using low three bytes in 32-bit word */ 130 SND_PCM_FORMAT_U24_BE, 131 /** Signed 32 bit Little Endian */ 132 SND_PCM_FORMAT_S32_LE, 133 /** Signed 32 bit Big Endian */ 134 SND_PCM_FORMAT_S32_BE, 135 /** Unsigned 32 bit Little Endian */ 136 SND_PCM_FORMAT_U32_LE, 137 /** Unsigned 32 bit Big Endian */ 138 SND_PCM_FORMAT_U32_BE, 139 /** Float 32 bit Little Endian, Range -1.0 to 1.0 */ 140 SND_PCM_FORMAT_FLOAT_LE, 141 /** Float 32 bit Big Endian, Range -1.0 to 1.0 */ 142 SND_PCM_FORMAT_FLOAT_BE, 143 /** Float 64 bit Little Endian, Range -1.0 to 1.0 */ 144 SND_PCM_FORMAT_FLOAT64_LE, 145 /** Float 64 bit Big Endian, Range -1.0 to 1.0 */ 146 SND_PCM_FORMAT_FLOAT64_BE, 147 /** IEC-958 Little Endian */ 148 SND_PCM_FORMAT_IEC958_SUBFRAME_LE, 149 /** IEC-958 Big Endian */ 150 SND_PCM_FORMAT_IEC958_SUBFRAME_BE, 151 /** Mu-Law */ 152 SND_PCM_FORMAT_MU_LAW, 153 /** A-Law */ 154 SND_PCM_FORMAT_A_LAW, 155 /** Ima-ADPCM */ 156 SND_PCM_FORMAT_IMA_ADPCM, 157 /** MPEG */ 158 SND_PCM_FORMAT_MPEG, 159 /** GSM */ 160 SND_PCM_FORMAT_GSM, 161 /** Special */ 162 SND_PCM_FORMAT_SPECIAL = 31, 163 /** Signed 24bit Little Endian in 3bytes format */ 164 SND_PCM_FORMAT_S24_3LE = 32, 165 /** Signed 24bit Big Endian in 3bytes format */ 166 SND_PCM_FORMAT_S24_3BE, 167 /** Unsigned 24bit Little Endian in 3bytes format */ 168 SND_PCM_FORMAT_U24_3LE, 169 /** Unsigned 24bit Big Endian in 3bytes format */ 170 SND_PCM_FORMAT_U24_3BE, 171 /** Signed 20bit Little Endian in 3bytes format */ 172 SND_PCM_FORMAT_S20_3LE, 173 /** Signed 20bit Big Endian in 3bytes format */ 174 SND_PCM_FORMAT_S20_3BE, 175 /** Unsigned 20bit Little Endian in 3bytes format */ 176 SND_PCM_FORMAT_U20_3LE, 177 /** Unsigned 20bit Big Endian in 3bytes format */ 178 SND_PCM_FORMAT_U20_3BE, 179 /** Signed 18bit Little Endian in 3bytes format */ 180 SND_PCM_FORMAT_S18_3LE, 181 /** Signed 18bit Big Endian in 3bytes format */ 182 SND_PCM_FORMAT_S18_3BE, 183 /** Unsigned 18bit Little Endian in 3bytes format */ 184 SND_PCM_FORMAT_U18_3LE, 185 /** Unsigned 18bit Big Endian in 3bytes format */ 186 SND_PCM_FORMAT_U18_3BE, 187 SND_PCM_FORMAT_LAST = SND_PCM_FORMAT_U18_3BE, 188 189#if __BYTE_ORDER == __LITTLE_ENDIAN 190 /** Signed 16 bit CPU endian */ 191 SND_PCM_FORMAT_S16 = SND_PCM_FORMAT_S16_LE, 192 /** Unsigned 16 bit CPU endian */ 193 SND_PCM_FORMAT_U16 = SND_PCM_FORMAT_U16_LE, 194 /** Signed 24 bit CPU endian */ 195 SND_PCM_FORMAT_S24 = SND_PCM_FORMAT_S24_LE, 196 /** Unsigned 24 bit CPU endian */ 197 SND_PCM_FORMAT_U24 = SND_PCM_FORMAT_U24_LE, 198 /** Signed 32 bit CPU endian */ 199 SND_PCM_FORMAT_S32 = SND_PCM_FORMAT_S32_LE, 200 /** Unsigned 32 bit CPU endian */ 201 SND_PCM_FORMAT_U32 = SND_PCM_FORMAT_U32_LE, 202 /** Float 32 bit CPU endian */ 203 SND_PCM_FORMAT_FLOAT = SND_PCM_FORMAT_FLOAT_LE, 204 /** Float 64 bit CPU endian */ 205 SND_PCM_FORMAT_FLOAT64 = SND_PCM_FORMAT_FLOAT64_LE, 206 /** IEC-958 CPU Endian */ 207 SND_PCM_FORMAT_IEC958_SUBFRAME = SND_PCM_FORMAT_IEC958_SUBFRAME_LE 208#elif __BYTE_ORDER == __BIG_ENDIAN 209 /** Signed 16 bit CPU endian */ 210 SND_PCM_FORMAT_S16 = SND_PCM_FORMAT_S16_BE, 211 /** Unsigned 16 bit CPU endian */ 212 SND_PCM_FORMAT_U16 = SND_PCM_FORMAT_U16_BE, 213 /** Signed 24 bit CPU endian */ 214 SND_PCM_FORMAT_S24 = SND_PCM_FORMAT_S24_BE, 215 /** Unsigned 24 bit CPU endian */ 216 SND_PCM_FORMAT_U24 = SND_PCM_FORMAT_U24_BE, 217 /** Signed 32 bit CPU endian */ 218 SND_PCM_FORMAT_S32 = SND_PCM_FORMAT_S32_BE, 219 /** Unsigned 32 bit CPU endian */ 220 SND_PCM_FORMAT_U32 = SND_PCM_FORMAT_U32_BE, 221 /** Float 32 bit CPU endian */ 222 SND_PCM_FORMAT_FLOAT = SND_PCM_FORMAT_FLOAT_BE, 223 /** Float 64 bit CPU endian */ 224 SND_PCM_FORMAT_FLOAT64 = SND_PCM_FORMAT_FLOAT64_BE, 225 /** IEC-958 CPU Endian */ 226 SND_PCM_FORMAT_IEC958_SUBFRAME = SND_PCM_FORMAT_IEC958_SUBFRAME_BE 227#else 228#error "Unknown endian" 229#endif 230} snd_pcm_format_t; 231 232/** PCM sample subformat */ 233typedef enum _snd_pcm_subformat { 234 /** Standard */ 235 SND_PCM_SUBFORMAT_STD = 0, 236 SND_PCM_SUBFORMAT_LAST = SND_PCM_SUBFORMAT_STD 237} snd_pcm_subformat_t; 238 239/** PCM state */ 240typedef enum _snd_pcm_state { 241 /** Open */ 242 SND_PCM_STATE_OPEN = 0, 243 /** Setup installed */ 244 SND_PCM_STATE_SETUP, 245 /** Ready to start */ 246 SND_PCM_STATE_PREPARED, 247 /** Running */ 248 SND_PCM_STATE_RUNNING, 249 /** Stopped: underrun (playback) or overrun (capture) detected */ 250 SND_PCM_STATE_XRUN, 251 /** Draining: running (playback) or stopped (capture) */ 252 SND_PCM_STATE_DRAINING, 253 /** Paused */ 254 SND_PCM_STATE_PAUSED, 255 /** Hardware is suspended */ 256 SND_PCM_STATE_SUSPENDED, 257 /** Hardware is disconnected */ 258 SND_PCM_STATE_DISCONNECTED, 259 SND_PCM_STATE_LAST = SND_PCM_STATE_DISCONNECTED 260} snd_pcm_state_t; 261 262/** PCM start mode */ 263typedef enum _snd_pcm_start { 264 /** Automatic start on data read/write */ 265 SND_PCM_START_DATA = 0, 266 /** Explicit start */ 267 SND_PCM_START_EXPLICIT, 268 SND_PCM_START_LAST = SND_PCM_START_EXPLICIT 269} snd_pcm_start_t; 270 271/** PCM xrun mode */ 272typedef enum _snd_pcm_xrun { 273 /** Xrun detection disabled */ 274 SND_PCM_XRUN_NONE = 0, 275 /** Stop on xrun detection */ 276 SND_PCM_XRUN_STOP, 277 SND_PCM_XRUN_LAST = SND_PCM_XRUN_STOP 278} snd_pcm_xrun_t; 279 280/** PCM timestamp mode */ 281typedef enum _snd_pcm_tstamp { 282 /** No timestamp */ 283 SND_PCM_TSTAMP_NONE = 0, 284 /** Update timestamp at every hardware position update */ 285 SND_PCM_TSTAMP_ENABLE, 286 /** Equivalent with #SND_PCM_TSTAMP_ENABLE, 287 * just for compatibility with older versions 288 */ 289 SND_PCM_TSTAMP_MMAP = SND_PCM_TSTAMP_ENABLE, 290 SND_PCM_TSTAMP_LAST = SND_PCM_TSTAMP_ENABLE 291} snd_pcm_tstamp_t; 292 293/** Unsigned frames quantity */ 294typedef unsigned long snd_pcm_uframes_t; 295/** Signed frames quantity */ 296typedef long snd_pcm_sframes_t; 297 298/** Non blocking mode (flag for open mode) \hideinitializer */ 299#define SND_PCM_NONBLOCK 0x00000001 300/** Async notification (flag for open mode) \hideinitializer */ 301#define SND_PCM_ASYNC 0x00000002 302/** Disable automatic (but not forced!) rate resamplinig */ 303#define SND_PCM_NO_AUTO_RESAMPLE 0x00010000 304/** Disable automatic (but not forced!) channel conversion */ 305#define SND_PCM_NO_AUTO_CHANNELS 0x00020000 306/** Disable automatic (but not forced!) format conversion */ 307#define SND_PCM_NO_AUTO_FORMAT 0x00040000 308/** Disable soft volume control */ 309#define SND_PCM_NO_SOFTVOL 0x00080000 310 311/** PCM handle */ 312typedef struct _snd_pcm snd_pcm_t; 313 314/** PCM type */ 315enum _snd_pcm_type { 316 /** Kernel level PCM */ 317 SND_PCM_TYPE_HW = 0, 318 /** Hooked PCM */ 319 SND_PCM_TYPE_HOOKS, 320 /** One or more linked PCM with exclusive access to selected 321 channels */ 322 SND_PCM_TYPE_MULTI, 323 /** File writing plugin */ 324 SND_PCM_TYPE_FILE, 325 /** Null endpoint PCM */ 326 SND_PCM_TYPE_NULL, 327 /** Shared memory client PCM */ 328 SND_PCM_TYPE_SHM, 329 /** INET client PCM (not yet implemented) */ 330 SND_PCM_TYPE_INET, 331 /** Copying plugin */ 332 SND_PCM_TYPE_COPY, 333 /** Linear format conversion PCM */ 334 SND_PCM_TYPE_LINEAR, 335 /** A-Law format conversion PCM */ 336 SND_PCM_TYPE_ALAW, 337 /** Mu-Law format conversion PCM */ 338 SND_PCM_TYPE_MULAW, 339 /** IMA-ADPCM format conversion PCM */ 340 SND_PCM_TYPE_ADPCM, 341 /** Rate conversion PCM */ 342 SND_PCM_TYPE_RATE, 343 /** Attenuated static route PCM */ 344 SND_PCM_TYPE_ROUTE, 345 /** Format adjusted PCM */ 346 SND_PCM_TYPE_PLUG, 347 /** Sharing PCM */ 348 SND_PCM_TYPE_SHARE, 349 /** Meter plugin */ 350 SND_PCM_TYPE_METER, 351 /** Mixing PCM */ 352 SND_PCM_TYPE_MIX, 353 /** Attenuated dynamic route PCM (not yet implemented) */ 354 SND_PCM_TYPE_DROUTE, 355 /** Loopback server plugin (not yet implemented) */ 356 SND_PCM_TYPE_LBSERVER, 357 /** Linear Integer <-> Linear Float format conversion PCM */ 358 SND_PCM_TYPE_LINEAR_FLOAT, 359 /** LADSPA integration plugin */ 360 SND_PCM_TYPE_LADSPA, 361 /** Direct Mixing plugin */ 362 SND_PCM_TYPE_DMIX, 363 /** Jack Audio Connection Kit plugin */ 364 SND_PCM_TYPE_JACK, 365 /** Direct Snooping plugin */ 366 SND_PCM_TYPE_DSNOOP, 367 /** Direct Sharing plugin */ 368 SND_PCM_TYPE_DSHARE, 369 /** IEC958 subframe plugin */ 370 SND_PCM_TYPE_IEC958, 371 /** Soft volume plugin */ 372 SND_PCM_TYPE_SOFTVOL, 373 /** External I/O plugin */ 374 SND_PCM_TYPE_IOPLUG, 375 /** External filter plugin */ 376 SND_PCM_TYPE_EXTPLUG, 377 /** Mmap-emulation plugin */ 378 SND_PCM_TYPE_MMAP_EMUL, 379 SND_PCM_TYPE_LAST = SND_PCM_TYPE_MMAP_EMUL 380}; 381 382/** PCM type */ 383typedef enum _snd_pcm_type snd_pcm_type_t; 384 385/** PCM area specification */ 386typedef struct _snd_pcm_channel_area { 387 /** base address of channel samples */ 388 void *addr; 389 /** offset to first sample in bits */ 390 unsigned int first; 391 /** samples distance in bits */ 392 unsigned int step; 393} snd_pcm_channel_area_t; 394 395/** PCM synchronization ID */ 396typedef union _snd_pcm_sync_id { 397 /** 8-bit ID */ 398 unsigned char id[16]; 399 /** 16-bit ID */ 400 unsigned short id16[8]; 401 /** 32-bit ID */ 402 unsigned int id32[4]; 403} snd_pcm_sync_id_t; 404 405/** #SND_PCM_TYPE_METER scope handle */ 406typedef struct _snd_pcm_scope snd_pcm_scope_t; 407 408int snd_pcm_open(snd_pcm_t **pcm, const char *name, 409 snd_pcm_stream_t stream, int mode); 410int snd_pcm_open_lconf(snd_pcm_t **pcm, const char *name, 411 snd_pcm_stream_t stream, int mode, 412 snd_config_t *lconf); 413 414int snd_pcm_close(snd_pcm_t *pcm); 415const char *snd_pcm_name(snd_pcm_t *pcm); 416snd_pcm_type_t snd_pcm_type(snd_pcm_t *pcm); 417snd_pcm_stream_t snd_pcm_stream(snd_pcm_t *pcm); 418int snd_pcm_poll_descriptors_count(snd_pcm_t *pcm); 419int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space); 420int snd_pcm_poll_descriptors_revents(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int nfds, unsigned short *revents); 421int snd_pcm_nonblock(snd_pcm_t *pcm, int nonblock); 422int snd_async_add_pcm_handler(snd_async_handler_t **handler, snd_pcm_t *pcm, 423 snd_async_callback_t callback, void *private_data); 424snd_pcm_t *snd_async_handler_get_pcm(snd_async_handler_t *handler); 425int snd_pcm_info(snd_pcm_t *pcm, snd_pcm_info_t *info); 426int snd_pcm_hw_params_current(snd_pcm_t *pcm, snd_pcm_hw_params_t *params); 427int snd_pcm_hw_params(snd_pcm_t *pcm, snd_pcm_hw_params_t *params); 428int snd_pcm_hw_free(snd_pcm_t *pcm); 429int snd_pcm_sw_params_current(snd_pcm_t *pcm, snd_pcm_sw_params_t *params); 430int snd_pcm_sw_params(snd_pcm_t *pcm, snd_pcm_sw_params_t *params); 431int snd_pcm_prepare(snd_pcm_t *pcm); 432int snd_pcm_reset(snd_pcm_t *pcm); 433int snd_pcm_status(snd_pcm_t *pcm, snd_pcm_status_t *status); 434int snd_pcm_start(snd_pcm_t *pcm); 435int snd_pcm_drop(snd_pcm_t *pcm); 436int snd_pcm_drain(snd_pcm_t *pcm); 437int snd_pcm_pause(snd_pcm_t *pcm, int enable); 438snd_pcm_state_t snd_pcm_state(snd_pcm_t *pcm); 439int snd_pcm_hwsync(snd_pcm_t *pcm); 440int snd_pcm_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *delayp); 441int snd_pcm_resume(snd_pcm_t *pcm); 442int snd_pcm_htimestamp(snd_pcm_t *pcm, snd_pcm_uframes_t *avail, snd_htimestamp_t *tstamp); 443snd_pcm_sframes_t snd_pcm_avail(snd_pcm_t *pcm); 444snd_pcm_sframes_t snd_pcm_avail_update(snd_pcm_t *pcm); 445int snd_pcm_avail_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *availp, snd_pcm_sframes_t *delayp); 446snd_pcm_sframes_t snd_pcm_rewindable(snd_pcm_t *pcm); 447snd_pcm_sframes_t snd_pcm_rewind(snd_pcm_t *pcm, snd_pcm_uframes_t frames); 448snd_pcm_sframes_t snd_pcm_forwardable(snd_pcm_t *pcm); 449snd_pcm_sframes_t snd_pcm_forward(snd_pcm_t *pcm, snd_pcm_uframes_t frames); 450snd_pcm_sframes_t snd_pcm_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size); 451snd_pcm_sframes_t snd_pcm_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size); 452snd_pcm_sframes_t snd_pcm_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size); 453snd_pcm_sframes_t snd_pcm_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size); 454int snd_pcm_wait(snd_pcm_t *pcm, int timeout); 455 456int snd_pcm_link(snd_pcm_t *pcm1, snd_pcm_t *pcm2); 457int snd_pcm_unlink(snd_pcm_t *pcm); 458 459//int snd_pcm_mixer_element(snd_pcm_t *pcm, snd_mixer_t *mixer, snd_mixer_elem_t **elem); 460 461/* 462 * application helpers - these functions are implemented on top 463 * of the basic API 464 */ 465 466int snd_pcm_recover(snd_pcm_t *pcm, int err, int silent); 467int snd_pcm_set_params(snd_pcm_t *pcm, 468 snd_pcm_format_t format, 469 snd_pcm_access_t access, 470 unsigned int channels, 471 unsigned int rate, 472 int soft_resample, 473 unsigned int latency); 474int snd_pcm_get_params(snd_pcm_t *pcm, 475 snd_pcm_uframes_t *buffer_size, 476 snd_pcm_uframes_t *period_size); 477 478/** \} */ 479 480/** 481 * \defgroup PCM_Info Stream Information 482 * \ingroup PCM 483 * See the \ref pcm page for more details. 484 * \{ 485 */ 486 487size_t snd_pcm_info_sizeof(void); 488/** \hideinitializer 489 * \brief allocate an invalid #snd_pcm_info_t using standard alloca 490 * \param ptr returned pointer 491 */ 492#define snd_pcm_info_alloca(ptr) __snd_alloca(ptr, snd_pcm_info) 493int snd_pcm_info_malloc(snd_pcm_info_t **ptr); 494void snd_pcm_info_free(snd_pcm_info_t *obj); 495void snd_pcm_info_copy(snd_pcm_info_t *dst, const snd_pcm_info_t *src); 496unsigned int snd_pcm_info_get_device(const snd_pcm_info_t *obj); 497unsigned int snd_pcm_info_get_subdevice(const snd_pcm_info_t *obj); 498snd_pcm_stream_t snd_pcm_info_get_stream(const snd_pcm_info_t *obj); 499int snd_pcm_info_get_card(const snd_pcm_info_t *obj); 500const char *snd_pcm_info_get_id(const snd_pcm_info_t *obj); 501const char *snd_pcm_info_get_name(const snd_pcm_info_t *obj); 502const char *snd_pcm_info_get_subdevice_name(const snd_pcm_info_t *obj); 503snd_pcm_class_t snd_pcm_info_get_class(const snd_pcm_info_t *obj); 504snd_pcm_subclass_t snd_pcm_info_get_subclass(const snd_pcm_info_t *obj); 505unsigned int snd_pcm_info_get_subdevices_count(const snd_pcm_info_t *obj); 506unsigned int snd_pcm_info_get_subdevices_avail(const snd_pcm_info_t *obj); 507snd_pcm_sync_id_t snd_pcm_info_get_sync(const snd_pcm_info_t *obj); 508void snd_pcm_info_set_device(snd_pcm_info_t *obj, unsigned int val); 509void snd_pcm_info_set_subdevice(snd_pcm_info_t *obj, unsigned int val); 510void snd_pcm_info_set_stream(snd_pcm_info_t *obj, snd_pcm_stream_t val); 511 512/** \} */ 513 514/** 515 * \defgroup PCM_HW_Params Hardware Parameters 516 * \ingroup PCM 517 * See the \ref pcm page for more details. 518 * \{ 519 */ 520 521int snd_pcm_hw_params_any(snd_pcm_t *pcm, snd_pcm_hw_params_t *params); 522 523int snd_pcm_hw_params_can_mmap_sample_resolution(const snd_pcm_hw_params_t *params); 524int snd_pcm_hw_params_is_double(const snd_pcm_hw_params_t *params); 525int snd_pcm_hw_params_is_batch(const snd_pcm_hw_params_t *params); 526int snd_pcm_hw_params_is_block_transfer(const snd_pcm_hw_params_t *params); 527int snd_pcm_hw_params_is_monotonic(const snd_pcm_hw_params_t *params); 528int snd_pcm_hw_params_can_overrange(const snd_pcm_hw_params_t *params); 529int snd_pcm_hw_params_can_pause(const snd_pcm_hw_params_t *params); 530int snd_pcm_hw_params_can_resume(const snd_pcm_hw_params_t *params); 531int snd_pcm_hw_params_is_half_duplex(const snd_pcm_hw_params_t *params); 532int snd_pcm_hw_params_is_joint_duplex(const snd_pcm_hw_params_t *params); 533int snd_pcm_hw_params_can_sync_start(const snd_pcm_hw_params_t *params); 534int snd_pcm_hw_params_get_rate_numden(const snd_pcm_hw_params_t *params, 535 unsigned int *rate_num, 536 unsigned int *rate_den); 537int snd_pcm_hw_params_get_sbits(const snd_pcm_hw_params_t *params); 538int snd_pcm_hw_params_get_fifo_size(const snd_pcm_hw_params_t *params); 539 540#if 0 541typedef struct _snd_pcm_hw_strategy snd_pcm_hw_strategy_t; 542 543/* choices need to be sorted on ascending badness */ 544typedef struct _snd_pcm_hw_strategy_simple_choices_list { 545 unsigned int value; 546 unsigned int badness; 547} snd_pcm_hw_strategy_simple_choices_list_t; 548 549int snd_pcm_hw_params_strategy(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, 550 const snd_pcm_hw_strategy_t *strategy, 551 unsigned int badness_min, 552 unsigned int badness_max); 553 554void snd_pcm_hw_strategy_free(snd_pcm_hw_strategy_t *strategy); 555int snd_pcm_hw_strategy_simple(snd_pcm_hw_strategy_t **strategyp, 556 unsigned int badness_min, 557 unsigned int badness_max); 558int snd_pcm_hw_params_try_explain_failure(snd_pcm_t *pcm, 559 snd_pcm_hw_params_t *fail, 560 snd_pcm_hw_params_t *success, 561 unsigned int depth, 562 snd_output_t *out); 563 564#endif 565 566size_t snd_pcm_hw_params_sizeof(void); 567/** \hideinitializer 568 * \brief allocate an invalid #snd_pcm_hw_params_t using standard alloca 569 * \param ptr returned pointer 570 */ 571#define snd_pcm_hw_params_alloca(ptr) __snd_alloca(ptr, snd_pcm_hw_params) 572int snd_pcm_hw_params_malloc(snd_pcm_hw_params_t **ptr); 573void snd_pcm_hw_params_free(snd_pcm_hw_params_t *obj); 574void snd_pcm_hw_params_copy(snd_pcm_hw_params_t *dst, const snd_pcm_hw_params_t *src); 575 576#if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_HW_PARAMS_API) 577 578int snd_pcm_hw_params_get_access(const snd_pcm_hw_params_t *params, snd_pcm_access_t *_access); 579int snd_pcm_hw_params_test_access(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t _access); 580int snd_pcm_hw_params_set_access(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t _access); 581int snd_pcm_hw_params_set_access_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *_access); 582int snd_pcm_hw_params_set_access_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *_access); 583int snd_pcm_hw_params_set_access_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask); 584int snd_pcm_hw_params_get_access_mask(snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask); 585 586int snd_pcm_hw_params_get_format(const snd_pcm_hw_params_t *params, snd_pcm_format_t *val); 587int snd_pcm_hw_params_test_format(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val); 588int snd_pcm_hw_params_set_format(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val); 589int snd_pcm_hw_params_set_format_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format); 590int snd_pcm_hw_params_set_format_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format); 591int snd_pcm_hw_params_set_format_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask); 592void snd_pcm_hw_params_get_format_mask(snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask); 593 594int snd_pcm_hw_params_get_subformat(const snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat); 595int snd_pcm_hw_params_test_subformat(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat); 596int snd_pcm_hw_params_set_subformat(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat); 597int snd_pcm_hw_params_set_subformat_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat); 598int snd_pcm_hw_params_set_subformat_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat); 599int snd_pcm_hw_params_set_subformat_mask(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask); 600void snd_pcm_hw_params_get_subformat_mask(snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask); 601 602int snd_pcm_hw_params_get_channels(const snd_pcm_hw_params_t *params, unsigned int *val); 603int snd_pcm_hw_params_get_channels_min(const snd_pcm_hw_params_t *params, unsigned int *val); 604int snd_pcm_hw_params_get_channels_max(const snd_pcm_hw_params_t *params, unsigned int *val); 605int snd_pcm_hw_params_test_channels(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val); 606int snd_pcm_hw_params_set_channels(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val); 607int snd_pcm_hw_params_set_channels_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val); 608int snd_pcm_hw_params_set_channels_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val); 609int snd_pcm_hw_params_set_channels_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, unsigned int *max); 610int snd_pcm_hw_params_set_channels_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val); 611int snd_pcm_hw_params_set_channels_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val); 612int snd_pcm_hw_params_set_channels_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val); 613 614int snd_pcm_hw_params_get_rate(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 615int snd_pcm_hw_params_get_rate_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 616int snd_pcm_hw_params_get_rate_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 617int snd_pcm_hw_params_test_rate(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir); 618int snd_pcm_hw_params_set_rate(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir); 619int snd_pcm_hw_params_set_rate_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 620int snd_pcm_hw_params_set_rate_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 621int 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); 622int snd_pcm_hw_params_set_rate_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 623int snd_pcm_hw_params_set_rate_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 624int snd_pcm_hw_params_set_rate_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 625int snd_pcm_hw_params_set_rate_resample(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val); 626int snd_pcm_hw_params_get_rate_resample(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val); 627int snd_pcm_hw_params_set_export_buffer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val); 628int snd_pcm_hw_params_get_export_buffer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val); 629 630int snd_pcm_hw_params_get_period_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 631int snd_pcm_hw_params_get_period_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 632int snd_pcm_hw_params_get_period_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 633int snd_pcm_hw_params_test_period_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir); 634int snd_pcm_hw_params_set_period_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir); 635int snd_pcm_hw_params_set_period_time_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 636int snd_pcm_hw_params_set_period_time_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 637int 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); 638int snd_pcm_hw_params_set_period_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 639int snd_pcm_hw_params_set_period_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 640int snd_pcm_hw_params_set_period_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 641 642int snd_pcm_hw_params_get_period_size(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir); 643int snd_pcm_hw_params_get_period_size_min(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir); 644int snd_pcm_hw_params_get_period_size_max(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir); 645int snd_pcm_hw_params_test_period_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val, int dir); 646int snd_pcm_hw_params_set_period_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val, int dir); 647int 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); 648int 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); 649int 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); 650int 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); 651int 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); 652int 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); 653int snd_pcm_hw_params_set_period_size_integer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params); 654 655int snd_pcm_hw_params_get_periods(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 656int snd_pcm_hw_params_get_periods_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 657int snd_pcm_hw_params_get_periods_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 658int snd_pcm_hw_params_test_periods(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir); 659int snd_pcm_hw_params_set_periods(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir); 660int snd_pcm_hw_params_set_periods_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 661int snd_pcm_hw_params_set_periods_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 662int 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); 663int snd_pcm_hw_params_set_periods_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 664int snd_pcm_hw_params_set_periods_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 665int snd_pcm_hw_params_set_periods_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 666int snd_pcm_hw_params_set_periods_integer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params); 667 668int snd_pcm_hw_params_get_buffer_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 669int snd_pcm_hw_params_get_buffer_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 670int snd_pcm_hw_params_get_buffer_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 671int snd_pcm_hw_params_test_buffer_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir); 672int snd_pcm_hw_params_set_buffer_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir); 673int snd_pcm_hw_params_set_buffer_time_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 674int snd_pcm_hw_params_set_buffer_time_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 675int 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); 676int snd_pcm_hw_params_set_buffer_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 677int snd_pcm_hw_params_set_buffer_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 678int snd_pcm_hw_params_set_buffer_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir); 679 680int snd_pcm_hw_params_get_buffer_size(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val); 681int snd_pcm_hw_params_get_buffer_size_min(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val); 682int snd_pcm_hw_params_get_buffer_size_max(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val); 683int snd_pcm_hw_params_test_buffer_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val); 684int snd_pcm_hw_params_set_buffer_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val); 685int snd_pcm_hw_params_set_buffer_size_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val); 686int snd_pcm_hw_params_set_buffer_size_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val); 687int 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); 688int snd_pcm_hw_params_set_buffer_size_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val); 689int snd_pcm_hw_params_set_buffer_size_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val); 690int snd_pcm_hw_params_set_buffer_size_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val); 691 692#endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_HW_PARAMS_API */ 693 694int snd_pcm_hw_params_get_min_align(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val); 695 696/** \} */ 697 698/** 699 * \defgroup PCM_SW_Params Software Parameters 700 * \ingroup PCM 701 * See the \ref pcm page for more details. 702 * \{ 703 */ 704 705size_t snd_pcm_sw_params_sizeof(void); 706/** \hideinitializer 707 * \brief allocate an invalid #snd_pcm_sw_params_t using standard alloca 708 * \param ptr returned pointer 709 */ 710#define snd_pcm_sw_params_alloca(ptr) __snd_alloca(ptr, snd_pcm_sw_params) 711int snd_pcm_sw_params_malloc(snd_pcm_sw_params_t **ptr); 712void snd_pcm_sw_params_free(snd_pcm_sw_params_t *obj); 713void snd_pcm_sw_params_copy(snd_pcm_sw_params_t *dst, const snd_pcm_sw_params_t *src); 714int snd_pcm_sw_params_get_boundary(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val); 715 716#if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_SW_PARAMS_API) 717 718int snd_pcm_sw_params_set_tstamp_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_tstamp_t val); 719int snd_pcm_sw_params_get_tstamp_mode(const snd_pcm_sw_params_t *params, snd_pcm_tstamp_t *val); 720int snd_pcm_sw_params_set_avail_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val); 721int snd_pcm_sw_params_get_avail_min(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val); 722int snd_pcm_sw_params_set_period_event(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, int val); 723int snd_pcm_sw_params_get_period_event(const snd_pcm_sw_params_t *params, int *val); 724int snd_pcm_sw_params_set_start_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val); 725int snd_pcm_sw_params_get_start_threshold(const snd_pcm_sw_params_t *paramsm, snd_pcm_uframes_t *val); 726int snd_pcm_sw_params_set_stop_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val); 727int snd_pcm_sw_params_get_stop_threshold(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val); 728int snd_pcm_sw_params_set_silence_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val); 729int snd_pcm_sw_params_get_silence_threshold(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val); 730int snd_pcm_sw_params_set_silence_size(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val); 731int snd_pcm_sw_params_get_silence_size(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val); 732 733#endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_SW_PARAMS_API */ 734 735/** \} */ 736 737/* include old API */ 738#ifndef ALSA_LIBRARY_BUILD 739#if defined(ALSA_PCM_OLD_HW_PARAMS_API) || defined(ALSA_PCM_OLD_SW_PARAMS_API) 740#include "pcm_old.h" 741#endif 742#endif 743 744/** 745 * \defgroup PCM_Access Access Mask Functions 746 * \ingroup PCM 747 * See the \ref pcm page for more details. 748 * \{ 749 */ 750 751size_t snd_pcm_access_mask_sizeof(void); 752/** \hideinitializer 753 * \brief allocate an empty #snd_pcm_access_mask_t using standard alloca 754 * \param ptr returned pointer 755 */ 756#define snd_pcm_access_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_access_mask) 757int snd_pcm_access_mask_malloc(snd_pcm_access_mask_t **ptr); 758void snd_pcm_access_mask_free(snd_pcm_access_mask_t *obj); 759void snd_pcm_access_mask_copy(snd_pcm_access_mask_t *dst, const snd_pcm_access_mask_t *src); 760void snd_pcm_access_mask_none(snd_pcm_access_mask_t *mask); 761void snd_pcm_access_mask_any(snd_pcm_access_mask_t *mask); 762int snd_pcm_access_mask_test(const snd_pcm_access_mask_t *mask, snd_pcm_access_t val); 763int snd_pcm_access_mask_empty(const snd_pcm_access_mask_t *mask); 764void snd_pcm_access_mask_set(snd_pcm_access_mask_t *mask, snd_pcm_access_t val); 765void snd_pcm_access_mask_reset(snd_pcm_access_mask_t *mask, snd_pcm_access_t val); 766 767/** \} */ 768 769/** 770 * \defgroup PCM_Format Format Mask Functions 771 * \ingroup PCM 772 * See the \ref pcm page for more details. 773 * \{ 774 */ 775 776size_t snd_pcm_format_mask_sizeof(void); 777/** \hideinitializer 778 * \brief allocate an empty #snd_pcm_format_mask_t using standard alloca 779 * \param ptr returned pointer 780 */ 781#define snd_pcm_format_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_format_mask) 782int snd_pcm_format_mask_malloc(snd_pcm_format_mask_t **ptr); 783void snd_pcm_format_mask_free(snd_pcm_format_mask_t *obj); 784void snd_pcm_format_mask_copy(snd_pcm_format_mask_t *dst, const snd_pcm_format_mask_t *src); 785void snd_pcm_format_mask_none(snd_pcm_format_mask_t *mask); 786void snd_pcm_format_mask_any(snd_pcm_format_mask_t *mask); 787int snd_pcm_format_mask_test(const snd_pcm_format_mask_t *mask, snd_pcm_format_t val); 788int snd_pcm_format_mask_empty(const snd_pcm_format_mask_t *mask); 789void snd_pcm_format_mask_set(snd_pcm_format_mask_t *mask, snd_pcm_format_t val); 790void snd_pcm_format_mask_reset(snd_pcm_format_mask_t *mask, snd_pcm_format_t val); 791 792/** \} */ 793 794/** 795 * \defgroup PCM_SubFormat Subformat Mask Functions 796 * \ingroup PCM 797 * See the \ref pcm page for more details. 798 * \{ 799 */ 800 801size_t snd_pcm_subformat_mask_sizeof(void); 802/** \hideinitializer 803 * \brief allocate an empty #snd_pcm_subformat_mask_t using standard alloca 804 * \param ptr returned pointer 805 */ 806#define snd_pcm_subformat_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_subformat_mask) 807int snd_pcm_subformat_mask_malloc(snd_pcm_subformat_mask_t **ptr); 808void snd_pcm_subformat_mask_free(snd_pcm_subformat_mask_t *obj); 809void snd_pcm_subformat_mask_copy(snd_pcm_subformat_mask_t *dst, const snd_pcm_subformat_mask_t *src); 810void snd_pcm_subformat_mask_none(snd_pcm_subformat_mask_t *mask); 811void snd_pcm_subformat_mask_any(snd_pcm_subformat_mask_t *mask); 812int snd_pcm_subformat_mask_test(const snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val); 813int snd_pcm_subformat_mask_empty(const snd_pcm_subformat_mask_t *mask); 814void snd_pcm_subformat_mask_set(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val); 815void snd_pcm_subformat_mask_reset(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val); 816 817/** \} */ 818 819/** 820 * \defgroup PCM_Status Status Functions 821 * \ingroup PCM 822 * See the \ref pcm page for more details. 823 * \{ 824 */ 825 826size_t snd_pcm_status_sizeof(void); 827/** \hideinitializer 828 * \brief allocate an invalid #snd_pcm_status_t using standard alloca 829 * \param ptr returned pointer 830 */ 831#define snd_pcm_status_alloca(ptr) __snd_alloca(ptr, snd_pcm_status) 832int snd_pcm_status_malloc(snd_pcm_status_t **ptr); 833void snd_pcm_status_free(snd_pcm_status_t *obj); 834void snd_pcm_status_copy(snd_pcm_status_t *dst, const snd_pcm_status_t *src); 835snd_pcm_state_t snd_pcm_status_get_state(const snd_pcm_status_t *obj); 836void snd_pcm_status_get_trigger_tstamp(const snd_pcm_status_t *obj, snd_timestamp_t *ptr); 837void snd_pcm_status_get_trigger_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr); 838void snd_pcm_status_get_tstamp(const snd_pcm_status_t *obj, snd_timestamp_t *ptr); 839void snd_pcm_status_get_htstamp(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr); 840snd_pcm_sframes_t snd_pcm_status_get_delay(const snd_pcm_status_t *obj); 841snd_pcm_uframes_t snd_pcm_status_get_avail(const snd_pcm_status_t *obj); 842snd_pcm_uframes_t snd_pcm_status_get_avail_max(const snd_pcm_status_t *obj); 843snd_pcm_uframes_t snd_pcm_status_get_overrange(const snd_pcm_status_t *obj); 844 845/** \} */ 846 847/** 848 * \defgroup PCM_Description Description Functions 849 * \ingroup PCM 850 * See the \ref pcm page for more details. 851 * \{ 852 */ 853 854const char *snd_pcm_type_name(snd_pcm_type_t type); 855const char *snd_pcm_stream_name(const snd_pcm_stream_t stream); 856const char *snd_pcm_access_name(const snd_pcm_access_t _access); 857const char *snd_pcm_format_name(const snd_pcm_format_t format); 858const char *snd_pcm_format_description(const snd_pcm_format_t format); 859const char *snd_pcm_subformat_name(const snd_pcm_subformat_t subformat); 860const char *snd_pcm_subformat_description(const snd_pcm_subformat_t subformat); 861snd_pcm_format_t snd_pcm_format_value(const char* name); 862const char *snd_pcm_tstamp_mode_name(const snd_pcm_tstamp_t mode); 863const char *snd_pcm_state_name(const snd_pcm_state_t state); 864 865/** \} */ 866 867/** 868 * \defgroup PCM_Dump Debug Functions 869 * \ingroup PCM 870 * See the \ref pcm page for more details. 871 * \{ 872 */ 873 874int snd_pcm_dump(snd_pcm_t *pcm, snd_output_t *out); 875int snd_pcm_dump_hw_setup(snd_pcm_t *pcm, snd_output_t *out); 876int snd_pcm_dump_sw_setup(snd_pcm_t *pcm, snd_output_t *out); 877int snd_pcm_dump_setup(snd_pcm_t *pcm, snd_output_t *out); 878int snd_pcm_hw_params_dump(snd_pcm_hw_params_t *params, snd_output_t *out); 879int snd_pcm_sw_params_dump(snd_pcm_sw_params_t *params, snd_output_t *out); 880int snd_pcm_status_dump(snd_pcm_status_t *status, snd_output_t *out); 881 882/** \} */ 883 884/** 885 * \defgroup PCM_Direct Direct Access (MMAP) Functions 886 * \ingroup PCM 887 * See the \ref pcm page for more details. 888 * \{ 889 */ 890 891int snd_pcm_mmap_begin(snd_pcm_t *pcm, 892 const snd_pcm_channel_area_t **areas, 893 snd_pcm_uframes_t *offset, 894 snd_pcm_uframes_t *frames); 895snd_pcm_sframes_t snd_pcm_mmap_commit(snd_pcm_t *pcm, 896 snd_pcm_uframes_t offset, 897 snd_pcm_uframes_t frames); 898snd_pcm_sframes_t snd_pcm_mmap_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size); 899snd_pcm_sframes_t snd_pcm_mmap_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size); 900snd_pcm_sframes_t snd_pcm_mmap_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size); 901snd_pcm_sframes_t snd_pcm_mmap_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size); 902 903/** \} */ 904 905/** 906 * \defgroup PCM_Helpers Helper Functions 907 * \ingroup PCM 908 * See the \ref pcm page for more details. 909 * \{ 910 */ 911 912int snd_pcm_format_signed(snd_pcm_format_t format); 913int snd_pcm_format_unsigned(snd_pcm_format_t format); 914int snd_pcm_format_linear(snd_pcm_format_t format); 915int snd_pcm_format_float(snd_pcm_format_t format); 916int snd_pcm_format_little_endian(snd_pcm_format_t format); 917int snd_pcm_format_big_endian(snd_pcm_format_t format); 918int snd_pcm_format_cpu_endian(snd_pcm_format_t format); 919int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */ 920int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */ 921snd_pcm_format_t snd_pcm_build_linear_format(int width, int pwidth, int unsignd, int big_endian); 922ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples); 923u_int8_t snd_pcm_format_silence(snd_pcm_format_t format); 924u_int16_t snd_pcm_format_silence_16(snd_pcm_format_t format); 925u_int32_t snd_pcm_format_silence_32(snd_pcm_format_t format); 926u_int64_t snd_pcm_format_silence_64(snd_pcm_format_t format); 927int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int samples); 928 929snd_pcm_sframes_t snd_pcm_bytes_to_frames(snd_pcm_t *pcm, ssize_t bytes); 930ssize_t snd_pcm_frames_to_bytes(snd_pcm_t *pcm, snd_pcm_sframes_t frames); 931long snd_pcm_bytes_to_samples(snd_pcm_t *pcm, ssize_t bytes); 932ssize_t snd_pcm_samples_to_bytes(snd_pcm_t *pcm, long samples); 933 934int snd_pcm_area_silence(const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset, 935 unsigned int samples, snd_pcm_format_t format); 936int snd_pcm_areas_silence(const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset, 937 unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format); 938int snd_pcm_area_copy(const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset, 939 const snd_pcm_channel_area_t *src_channel, snd_pcm_uframes_t src_offset, 940 unsigned int samples, snd_pcm_format_t format); 941int snd_pcm_areas_copy(const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset, 942 const snd_pcm_channel_area_t *src_channels, snd_pcm_uframes_t src_offset, 943 unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format); 944 945/** \} */ 946 947/** 948 * \defgroup PCM_Hook Hook Extension 949 * \ingroup PCM 950 * See the \ref pcm page for more details. 951 * \{ 952 */ 953 954/** type of pcm hook */ 955typedef enum _snd_pcm_hook_type { 956 SND_PCM_HOOK_TYPE_HW_PARAMS = 0, 957 SND_PCM_HOOK_TYPE_HW_FREE, 958 SND_PCM_HOOK_TYPE_CLOSE, 959 SND_PCM_HOOK_TYPE_LAST = SND_PCM_HOOK_TYPE_CLOSE 960} snd_pcm_hook_type_t; 961 962/** PCM hook container */ 963typedef struct _snd_pcm_hook snd_pcm_hook_t; 964/** PCM hook callback function */ 965typedef int (*snd_pcm_hook_func_t)(snd_pcm_hook_t *hook); 966snd_pcm_t *snd_pcm_hook_get_pcm(snd_pcm_hook_t *hook); 967void *snd_pcm_hook_get_private(snd_pcm_hook_t *hook); 968void snd_pcm_hook_set_private(snd_pcm_hook_t *hook, void *private_data); 969int snd_pcm_hook_add(snd_pcm_hook_t **hookp, snd_pcm_t *pcm, 970 snd_pcm_hook_type_t type, 971 snd_pcm_hook_func_t func, void *private_data); 972int snd_pcm_hook_remove(snd_pcm_hook_t *hook); 973 974/** \} */ 975 976/** 977 * \defgroup PCM_Scope Scope Plugin Extension 978 * \ingroup PCM 979 * See the \ref pcm page for more details. 980 * \{ 981 */ 982 983/** #SND_PCM_TYPE_METER scope functions */ 984typedef struct _snd_pcm_scope_ops { 985 /** \brief Enable and prepare it using current params 986 * \param scope scope handle 987 */ 988 int (*enable)(snd_pcm_scope_t *scope); 989 /** \brief Disable 990 * \param scope scope handle 991 */ 992 void (*disable)(snd_pcm_scope_t *scope); 993 /** \brief PCM has been started 994 * \param scope scope handle 995 */ 996 void (*start)(snd_pcm_scope_t *scope); 997 /** \brief PCM has been stopped 998 * \param scope scope handle 999 */ 1000 void (*stop)(snd_pcm_scope_t *scope); 1001 /** \brief New frames are present 1002 * \param scope scope handle 1003 */ 1004 void (*update)(snd_pcm_scope_t *scope); 1005 /** \brief Reset status 1006 * \param scope scope handle 1007 */ 1008 void (*reset)(snd_pcm_scope_t *scope); 1009 /** \brief PCM is closing 1010 * \param scope scope handle 1011 */ 1012 void (*close)(snd_pcm_scope_t *scope); 1013} snd_pcm_scope_ops_t; 1014 1015snd_pcm_uframes_t snd_pcm_meter_get_bufsize(snd_pcm_t *pcm); 1016unsigned int snd_pcm_meter_get_channels(snd_pcm_t *pcm); 1017unsigned int snd_pcm_meter_get_rate(snd_pcm_t *pcm); 1018snd_pcm_uframes_t snd_pcm_meter_get_now(snd_pcm_t *pcm); 1019snd_pcm_uframes_t snd_pcm_meter_get_boundary(snd_pcm_t *pcm); 1020int snd_pcm_meter_add_scope(snd_pcm_t *pcm, snd_pcm_scope_t *scope); 1021snd_pcm_scope_t *snd_pcm_meter_search_scope(snd_pcm_t *pcm, const char *name); 1022int snd_pcm_scope_malloc(snd_pcm_scope_t **ptr); 1023void snd_pcm_scope_set_ops(snd_pcm_scope_t *scope, 1024 const snd_pcm_scope_ops_t *val); 1025void snd_pcm_scope_set_name(snd_pcm_scope_t *scope, const char *val); 1026const char *snd_pcm_scope_get_name(snd_pcm_scope_t *scope); 1027void *snd_pcm_scope_get_callback_private(snd_pcm_scope_t *scope); 1028void snd_pcm_scope_set_callback_private(snd_pcm_scope_t *scope, void *val); 1029int snd_pcm_scope_s16_open(snd_pcm_t *pcm, const char *name, 1030 snd_pcm_scope_t **scopep); 1031int16_t *snd_pcm_scope_s16_get_channel_buffer(snd_pcm_scope_t *scope, 1032 unsigned int channel); 1033 1034/** \} */ 1035 1036/** 1037 * \defgroup PCM_Simple Simple setup functions 1038 * \ingroup PCM 1039 * See the \ref pcm page for more details. 1040 * \{ 1041 */ 1042 1043/** Simple PCM latency type */ 1044typedef enum _snd_spcm_latency { 1045 /** standard latency - for standard playback or capture 1046 (estimated latency in one direction 350ms) */ 1047 SND_SPCM_LATENCY_STANDARD = 0, 1048 /** medium latency - software phones etc. 1049 (estimated latency in one direction maximally 25ms */ 1050 SND_SPCM_LATENCY_MEDIUM, 1051 /** realtime latency - realtime applications (effect processors etc.) 1052 (estimated latency in one direction 5ms and better) */ 1053 SND_SPCM_LATENCY_REALTIME 1054} snd_spcm_latency_t; 1055 1056/** Simple PCM xrun type */ 1057typedef enum _snd_spcm_xrun_type { 1058 /** driver / library will ignore all xruns, the stream runs forever */ 1059 SND_SPCM_XRUN_IGNORE = 0, 1060 /** driver / library stops the stream when an xrun occurs */ 1061 SND_SPCM_XRUN_STOP 1062} snd_spcm_xrun_type_t; 1063 1064/** Simple PCM duplex type */ 1065typedef enum _snd_spcm_duplex_type { 1066 /** liberal duplex - the buffer and period sizes might not match */ 1067 SND_SPCM_DUPLEX_LIBERAL = 0, 1068 /** pedantic duplex - the buffer and period sizes MUST match */ 1069 SND_SPCM_DUPLEX_PEDANTIC 1070} snd_spcm_duplex_type_t; 1071 1072int snd_spcm_init(snd_pcm_t *pcm, 1073 unsigned int rate, 1074 unsigned int channels, 1075 snd_pcm_format_t format, 1076 snd_pcm_subformat_t subformat, 1077 snd_spcm_latency_t latency, 1078 snd_pcm_access_t _access, 1079 snd_spcm_xrun_type_t xrun_type); 1080 1081int snd_spcm_init_duplex(snd_pcm_t *playback_pcm, 1082 snd_pcm_t *capture_pcm, 1083 unsigned int rate, 1084 unsigned int channels, 1085 snd_pcm_format_t format, 1086 snd_pcm_subformat_t subformat, 1087 snd_spcm_latency_t latency, 1088 snd_pcm_access_t _access, 1089 snd_spcm_xrun_type_t xrun_type, 1090 snd_spcm_duplex_type_t duplex_type); 1091 1092int snd_spcm_init_get_params(snd_pcm_t *pcm, 1093 unsigned int *rate, 1094 snd_pcm_uframes_t *buffer_size, 1095 snd_pcm_uframes_t *period_size); 1096 1097/** \} */ 1098 1099/** 1100 * \defgroup PCM_Deprecated Deprecated Functions 1101 * \ingroup PCM 1102 * See the \ref pcm page for more details. 1103 * \{ 1104 */ 1105 1106/* Deprecated functions, for compatibility */ 1107const char *snd_pcm_start_mode_name(snd_pcm_start_t mode) __attribute__((deprecated)); 1108const char *snd_pcm_xrun_mode_name(snd_pcm_xrun_t mode) __attribute__((deprecated)); 1109int snd_pcm_sw_params_set_start_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_start_t val) __attribute__((deprecated)); 1110snd_pcm_start_t snd_pcm_sw_params_get_start_mode(const snd_pcm_sw_params_t *params) __attribute__((deprecated)); 1111int snd_pcm_sw_params_set_xrun_mode(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_xrun_t val) __attribute__((deprecated)); 1112snd_pcm_xrun_t snd_pcm_sw_params_get_xrun_mode(const snd_pcm_sw_params_t *params) __attribute__((deprecated)); 1113#if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_SW_PARAMS_API) 1114int snd_pcm_sw_params_set_xfer_align(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val) __attribute__((deprecated)); 1115int snd_pcm_sw_params_get_xfer_align(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val) __attribute__((deprecated)); 1116int snd_pcm_sw_params_set_sleep_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, unsigned int val) __attribute__((deprecated)); 1117int snd_pcm_sw_params_get_sleep_min(const snd_pcm_sw_params_t *params, unsigned int *val) __attribute__((deprecated)); 1118#endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_SW_PARAMS_API */ 1119#if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_HW_PARAMS_API) 1120int snd_pcm_hw_params_get_tick_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated)); 1121int snd_pcm_hw_params_get_tick_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated)); 1122int snd_pcm_hw_params_get_tick_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated)); 1123int snd_pcm_hw_params_test_tick_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir) __attribute__((deprecated)); 1124int snd_pcm_hw_params_set_tick_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir) __attribute__((deprecated)); 1125int 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)); 1126int 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)); 1127int 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)); 1128int 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)); 1129int 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)); 1130int 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)); 1131#endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_HW_PARAMS_API */ 1132 1133/** \} */ 1134 1135#ifdef __cplusplus 1136} 1137#endif 1138 1139#endif /* __ALSA_PCM_H */ 1140