ALSA project - the C library reference
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
pcm.h
Go to the documentation of this file.
1 
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
33 extern "C" {
34 #endif
35 
43 #define SND_PCM_DLSYM_VERSION _dlsym_pcm_001
44 
46 typedef struct _snd_pcm_info snd_pcm_info_t;
47 
62 typedef struct _snd_pcm_hw_params snd_pcm_hw_params_t;
63 
65 typedef struct _snd_pcm_sw_params snd_pcm_sw_params_t;
67  typedef struct _snd_pcm_status snd_pcm_status_t;
69 typedef struct _snd_pcm_access_mask snd_pcm_access_mask_t;
71 typedef struct _snd_pcm_format_mask snd_pcm_format_mask_t;
73 typedef struct _snd_pcm_subformat_mask snd_pcm_subformat_mask_t;
74 
76 typedef enum _snd_pcm_class {
86  SND_PCM_CLASS_LAST = SND_PCM_CLASS_DIGITIZER
88 
90 typedef enum _snd_pcm_subclass {
95  SND_PCM_SUBCLASS_LAST = SND_PCM_SUBCLASS_MULTI_MIX
97 
99 typedef enum _snd_pcm_stream {
104  SND_PCM_STREAM_LAST = SND_PCM_STREAM_CAPTURE
106 
108 typedef enum _snd_pcm_access {
119  SND_PCM_ACCESS_LAST = SND_PCM_ACCESS_RW_NONINTERLEAVED
121 
123 typedef enum _snd_pcm_format {
202  /* G.723 (ADPCM) 24 kbit/s, 8 samples in 3 bytes */
203  SND_PCM_FORMAT_G723_24,
204  /* G.723 (ADPCM) 24 kbit/s, 1 sample in 1 byte */
205  SND_PCM_FORMAT_G723_24_1B,
206  /* G.723 (ADPCM) 40 kbit/s, 8 samples in 3 bytes */
207  SND_PCM_FORMAT_G723_40,
208  /* G.723 (ADPCM) 40 kbit/s, 1 sample in 1 byte */
209  SND_PCM_FORMAT_G723_40_1B,
210  /* Direct Stream Digital (DSD) in 1-byte samples (x8) */
211  SND_PCM_FORMAT_DSD_U8,
212  /* Direct Stream Digital (DSD) in 2-byte samples (x16) */
213  SND_PCM_FORMAT_DSD_U16_LE,
214  SND_PCM_FORMAT_LAST = SND_PCM_FORMAT_DSD_U16_LE,
215 
216 #if __BYTE_ORDER == __LITTLE_ENDIAN
217 
235 #elif __BYTE_ORDER == __BIG_ENDIAN
236 
254 #else
255 #error "Unknown endian"
256 #endif
258 
260 typedef enum _snd_pcm_subformat {
263  SND_PCM_SUBFORMAT_LAST = SND_PCM_SUBFORMAT_STD
265 
267 typedef enum _snd_pcm_state {
286  SND_PCM_STATE_LAST = SND_PCM_STATE_DISCONNECTED
288 
290 typedef enum _snd_pcm_start {
295  SND_PCM_START_LAST = SND_PCM_START_EXPLICIT
297 
299 typedef enum _snd_pcm_xrun {
304  SND_PCM_XRUN_LAST = SND_PCM_XRUN_STOP
306 
308 typedef enum _snd_pcm_tstamp {
317  SND_PCM_TSTAMP_LAST = SND_PCM_TSTAMP_ENABLE
319 
321 typedef unsigned long snd_pcm_uframes_t;
323 typedef long snd_pcm_sframes_t;
324 
326 #define SND_PCM_NONBLOCK 0x00000001
327 
328 #define SND_PCM_ASYNC 0x00000002
329 
330 #define SND_PCM_ABORT 0x00008000
331 
332 #define SND_PCM_NO_AUTO_RESAMPLE 0x00010000
333 
334 #define SND_PCM_NO_AUTO_CHANNELS 0x00020000
335 
336 #define SND_PCM_NO_AUTO_FORMAT 0x00040000
337 
338 #define SND_PCM_NO_SOFTVOL 0x00080000
339 
341 typedef struct _snd_pcm snd_pcm_t;
342 
408  SND_PCM_TYPE_LAST = SND_PCM_TYPE_MMAP_EMUL
409 };
410 
413 
415 typedef struct _snd_pcm_channel_area {
417  void *addr;
419  unsigned int first;
421  unsigned int step;
423 
425 typedef union _snd_pcm_sync_id {
427  unsigned char id[16];
429  unsigned short id16[8];
431  unsigned int id32[4];
433 
435 typedef struct _snd_pcm_scope snd_pcm_scope_t;
436 
437 int snd_pcm_open(snd_pcm_t **pcm, const char *name,
438  snd_pcm_stream_t stream, int mode);
439 int snd_pcm_open_lconf(snd_pcm_t **pcm, const char *name,
440  snd_pcm_stream_t stream, int mode,
441  snd_config_t *lconf);
443  const char *name, const char *orig_name,
444  snd_pcm_stream_t stream, int mode);
445 
446 int snd_pcm_close(snd_pcm_t *pcm);
447 const char *snd_pcm_name(snd_pcm_t *pcm);
448 snd_pcm_type_t snd_pcm_type(snd_pcm_t *pcm);
451 int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space);
452 int snd_pcm_poll_descriptors_revents(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
453 int snd_pcm_nonblock(snd_pcm_t *pcm, int nonblock);
454 static __inline__ int snd_pcm_abort(snd_pcm_t *pcm) { return snd_pcm_nonblock(pcm, 2); }
456  snd_async_callback_t callback, void *private_data);
458 int snd_pcm_info(snd_pcm_t *pcm, snd_pcm_info_t *info);
461 int snd_pcm_hw_free(snd_pcm_t *pcm);
464 int snd_pcm_prepare(snd_pcm_t *pcm);
465 int snd_pcm_reset(snd_pcm_t *pcm);
466 int snd_pcm_status(snd_pcm_t *pcm, snd_pcm_status_t *status);
467 int snd_pcm_start(snd_pcm_t *pcm);
468 int snd_pcm_drop(snd_pcm_t *pcm);
469 int snd_pcm_drain(snd_pcm_t *pcm);
470 int snd_pcm_pause(snd_pcm_t *pcm, int enable);
472 int snd_pcm_hwsync(snd_pcm_t *pcm);
473 int snd_pcm_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *delayp);
474 int snd_pcm_resume(snd_pcm_t *pcm);
475 int snd_pcm_htimestamp(snd_pcm_t *pcm, snd_pcm_uframes_t *avail, snd_htimestamp_t *tstamp);
476 snd_pcm_sframes_t snd_pcm_avail(snd_pcm_t *pcm);
477 snd_pcm_sframes_t snd_pcm_avail_update(snd_pcm_t *pcm);
478 int snd_pcm_avail_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *availp, snd_pcm_sframes_t *delayp);
479 snd_pcm_sframes_t snd_pcm_rewindable(snd_pcm_t *pcm);
480 snd_pcm_sframes_t snd_pcm_rewind(snd_pcm_t *pcm, snd_pcm_uframes_t frames);
481 snd_pcm_sframes_t snd_pcm_forwardable(snd_pcm_t *pcm);
482 snd_pcm_sframes_t snd_pcm_forward(snd_pcm_t *pcm, snd_pcm_uframes_t frames);
483 snd_pcm_sframes_t snd_pcm_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size);
484 snd_pcm_sframes_t snd_pcm_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size);
485 snd_pcm_sframes_t snd_pcm_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
486 snd_pcm_sframes_t snd_pcm_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
487 int snd_pcm_wait(snd_pcm_t *pcm, int timeout);
488 
489 int snd_pcm_link(snd_pcm_t *pcm1, snd_pcm_t *pcm2);
490 int snd_pcm_unlink(snd_pcm_t *pcm);
491 
493 #define SND_CHMAP_API_VERSION ((1 << 16) | (0 << 8) | 1)
494 
497  SND_CHMAP_TYPE_NONE = 0,
502 };
503 
543  SND_CHMAP_LAST = SND_CHMAP_BRC,
544 };
545 
547 #define SND_CHMAP_POSITION_MASK 0xffff
548 
550 #define SND_CHMAP_PHASE_INVERSE (0x01 << 16)
551 
552 #define SND_CHMAP_DRIVER_SPEC (0x02 << 16)
553 
555 typedef struct snd_pcm_chmap {
556  unsigned int channels;
557  unsigned int pos[0];
559 
561 typedef struct snd_pcm_chmap_query {
565 
566 
569  int subdev,
570  snd_pcm_stream_t stream);
573 int snd_pcm_set_chmap(snd_pcm_t *pcm, const snd_pcm_chmap_t *map);
574 
575 const char *snd_pcm_chmap_type_name(enum snd_pcm_chmap_type val);
576 const char *snd_pcm_chmap_name(enum snd_pcm_chmap_position val);
577 const char *snd_pcm_chmap_long_name(enum snd_pcm_chmap_position val);
578 int snd_pcm_chmap_print(const snd_pcm_chmap_t *map, size_t maxlen, char *buf);
579 unsigned int snd_pcm_chmap_from_string(const char *str);
581 
582 //int snd_pcm_mixer_element(snd_pcm_t *pcm, snd_mixer_t *mixer, snd_mixer_elem_t **elem);
583 
584 /*
585  * application helpers - these functions are implemented on top
586  * of the basic API
587  */
588 
589 int snd_pcm_recover(snd_pcm_t *pcm, int err, int silent);
591  snd_pcm_format_t format,
592  snd_pcm_access_t access,
593  unsigned int channels,
594  unsigned int rate,
595  int soft_resample,
596  unsigned int latency);
598  snd_pcm_uframes_t *buffer_size,
599  snd_pcm_uframes_t *period_size);
600 
610 size_t snd_pcm_info_sizeof(void);
615 #define snd_pcm_info_alloca(ptr) __snd_alloca(ptr, snd_pcm_info)
618 void snd_pcm_info_copy(snd_pcm_info_t *dst, const snd_pcm_info_t *src);
619 unsigned int snd_pcm_info_get_device(const snd_pcm_info_t *obj);
620 unsigned int snd_pcm_info_get_subdevice(const snd_pcm_info_t *obj);
622 int snd_pcm_info_get_card(const snd_pcm_info_t *obj);
623 const char *snd_pcm_info_get_id(const snd_pcm_info_t *obj);
624 const char *snd_pcm_info_get_name(const snd_pcm_info_t *obj);
625 const char *snd_pcm_info_get_subdevice_name(const snd_pcm_info_t *obj);
628 unsigned int snd_pcm_info_get_subdevices_count(const snd_pcm_info_t *obj);
629 unsigned int snd_pcm_info_get_subdevices_avail(const snd_pcm_info_t *obj);
631 void snd_pcm_info_set_device(snd_pcm_info_t *obj, unsigned int val);
632 void snd_pcm_info_set_subdevice(snd_pcm_info_t *obj, unsigned int val);
634 
645 
660  unsigned int *rate_num,
661  unsigned int *rate_den);
664 
665 #if 0
666 typedef struct _snd_pcm_hw_strategy snd_pcm_hw_strategy_t;
667 
668 /* choices need to be sorted on ascending badness */
669 typedef struct _snd_pcm_hw_strategy_simple_choices_list {
670  unsigned int value;
671  unsigned int badness;
672 } snd_pcm_hw_strategy_simple_choices_list_t;
673 
674 int snd_pcm_hw_params_strategy(snd_pcm_t *pcm, snd_pcm_hw_params_t *params,
675  const snd_pcm_hw_strategy_t *strategy,
676  unsigned int badness_min,
677  unsigned int badness_max);
678 
679 void snd_pcm_hw_strategy_free(snd_pcm_hw_strategy_t *strategy);
680 int snd_pcm_hw_strategy_simple(snd_pcm_hw_strategy_t **strategyp,
681  unsigned int badness_min,
682  unsigned int badness_max);
683 int snd_pcm_hw_params_try_explain_failure(snd_pcm_t *pcm,
684  snd_pcm_hw_params_t *fail,
685  snd_pcm_hw_params_t *success,
686  unsigned int depth,
687  snd_output_t *out);
688 
689 #endif
690 
691 size_t snd_pcm_hw_params_sizeof(void);
696 #define snd_pcm_hw_params_alloca(ptr) __snd_alloca(ptr, snd_pcm_hw_params)
700 
701 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_HW_PARAMS_API)
702 
710 
718 
726 
727 int snd_pcm_hw_params_get_channels(const snd_pcm_hw_params_t *params, unsigned int *val);
728 int snd_pcm_hw_params_get_channels_min(const snd_pcm_hw_params_t *params, unsigned int *val);
729 int snd_pcm_hw_params_get_channels_max(const snd_pcm_hw_params_t *params, unsigned int *val);
730 int snd_pcm_hw_params_test_channels(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
731 int snd_pcm_hw_params_set_channels(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
732 int snd_pcm_hw_params_set_channels_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
733 int snd_pcm_hw_params_set_channels_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
734 int snd_pcm_hw_params_set_channels_minmax(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, unsigned int *max);
735 int snd_pcm_hw_params_set_channels_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
736 int snd_pcm_hw_params_set_channels_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
737 int snd_pcm_hw_params_set_channels_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
738 
739 int snd_pcm_hw_params_get_rate(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
740 int snd_pcm_hw_params_get_rate_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
741 int snd_pcm_hw_params_get_rate_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
742 int snd_pcm_hw_params_test_rate(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
743 int snd_pcm_hw_params_set_rate(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
744 int snd_pcm_hw_params_set_rate_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
745 int snd_pcm_hw_params_set_rate_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
746 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);
747 int snd_pcm_hw_params_set_rate_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
748 int snd_pcm_hw_params_set_rate_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
749 int snd_pcm_hw_params_set_rate_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
750 int snd_pcm_hw_params_set_rate_resample(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
751 int snd_pcm_hw_params_get_rate_resample(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
752 int snd_pcm_hw_params_set_export_buffer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
753 int snd_pcm_hw_params_get_export_buffer(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
754 int snd_pcm_hw_params_set_period_wakeup(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val);
755 int snd_pcm_hw_params_get_period_wakeup(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val);
756 
757 int snd_pcm_hw_params_get_period_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
758 int snd_pcm_hw_params_get_period_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
759 int snd_pcm_hw_params_get_period_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
760 int snd_pcm_hw_params_test_period_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
761 int snd_pcm_hw_params_set_period_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
762 int snd_pcm_hw_params_set_period_time_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
763 int snd_pcm_hw_params_set_period_time_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
764 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);
765 int snd_pcm_hw_params_set_period_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
766 int snd_pcm_hw_params_set_period_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
767 int snd_pcm_hw_params_set_period_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
768 
769 int snd_pcm_hw_params_get_period_size(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
770 int snd_pcm_hw_params_get_period_size_min(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
771 int snd_pcm_hw_params_get_period_size_max(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir);
772 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);
773 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);
774 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);
775 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);
776 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);
777 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);
778 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);
779 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);
781 
782 int snd_pcm_hw_params_get_periods(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
783 int snd_pcm_hw_params_get_periods_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
784 int snd_pcm_hw_params_get_periods_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
785 int snd_pcm_hw_params_test_periods(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
786 int snd_pcm_hw_params_set_periods(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
787 int snd_pcm_hw_params_set_periods_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
788 int snd_pcm_hw_params_set_periods_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
789 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);
790 int snd_pcm_hw_params_set_periods_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
791 int snd_pcm_hw_params_set_periods_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
792 int snd_pcm_hw_params_set_periods_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
794 
795 int snd_pcm_hw_params_get_buffer_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
796 int snd_pcm_hw_params_get_buffer_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
797 int snd_pcm_hw_params_get_buffer_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
798 int snd_pcm_hw_params_test_buffer_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
799 int snd_pcm_hw_params_set_buffer_time(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir);
800 int snd_pcm_hw_params_set_buffer_time_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
801 int snd_pcm_hw_params_set_buffer_time_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
802 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);
803 int snd_pcm_hw_params_set_buffer_time_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
804 int snd_pcm_hw_params_set_buffer_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
805 int snd_pcm_hw_params_set_buffer_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir);
806 
807 int snd_pcm_hw_params_get_buffer_size(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
808 int snd_pcm_hw_params_get_buffer_size_min(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
809 int snd_pcm_hw_params_get_buffer_size_max(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
810 int snd_pcm_hw_params_test_buffer_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val);
811 int snd_pcm_hw_params_set_buffer_size(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val);
812 int snd_pcm_hw_params_set_buffer_size_min(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
813 int snd_pcm_hw_params_set_buffer_size_max(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
814 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);
815 int snd_pcm_hw_params_set_buffer_size_near(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
816 int snd_pcm_hw_params_set_buffer_size_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
817 int snd_pcm_hw_params_set_buffer_size_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
818 
819 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_HW_PARAMS_API */
820 
821 int snd_pcm_hw_params_get_min_align(const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val);
822 
832 size_t snd_pcm_sw_params_sizeof(void);
837 #define snd_pcm_sw_params_alloca(ptr) __snd_alloca(ptr, snd_pcm_sw_params)
841 int snd_pcm_sw_params_get_boundary(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
842 
843 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_SW_PARAMS_API)
844 
847 int snd_pcm_sw_params_set_avail_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
848 int snd_pcm_sw_params_get_avail_min(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
850 int snd_pcm_sw_params_get_period_event(const snd_pcm_sw_params_t *params, int *val);
851 int snd_pcm_sw_params_set_start_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
852 int snd_pcm_sw_params_get_start_threshold(const snd_pcm_sw_params_t *paramsm, snd_pcm_uframes_t *val);
853 int snd_pcm_sw_params_set_stop_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
854 int snd_pcm_sw_params_get_stop_threshold(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
855 int snd_pcm_sw_params_set_silence_threshold(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
856 int snd_pcm_sw_params_get_silence_threshold(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
857 int snd_pcm_sw_params_set_silence_size(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
858 int snd_pcm_sw_params_get_silence_size(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val);
859 
860 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_SW_PARAMS_API */
861 
864 /* include old API */
865 #ifndef ALSA_LIBRARY_BUILD
866 #if defined(ALSA_PCM_OLD_HW_PARAMS_API) || defined(ALSA_PCM_OLD_SW_PARAMS_API)
867 #include "pcm_old.h"
868 #endif
869 #endif
870 
878 size_t snd_pcm_access_mask_sizeof(void);
883 #define snd_pcm_access_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_access_mask)
893 
903 size_t snd_pcm_format_mask_sizeof(void);
908 #define snd_pcm_format_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_format_mask)
918 
928 size_t snd_pcm_subformat_mask_sizeof(void);
933 #define snd_pcm_subformat_mask_alloca(ptr) __snd_alloca(ptr, snd_pcm_subformat_mask)
943 
953 size_t snd_pcm_status_sizeof(void);
958 #define snd_pcm_status_alloca(ptr) __snd_alloca(ptr, snd_pcm_status)
968 snd_pcm_sframes_t snd_pcm_status_get_delay(const snd_pcm_status_t *obj);
969 snd_pcm_uframes_t snd_pcm_status_get_avail(const snd_pcm_status_t *obj);
970 snd_pcm_uframes_t snd_pcm_status_get_avail_max(const snd_pcm_status_t *obj);
971 snd_pcm_uframes_t snd_pcm_status_get_overrange(const snd_pcm_status_t *obj);
972 
982 const char *snd_pcm_type_name(snd_pcm_type_t type);
983 const char *snd_pcm_stream_name(const snd_pcm_stream_t stream);
984 const char *snd_pcm_access_name(const snd_pcm_access_t _access);
985 const char *snd_pcm_format_name(const snd_pcm_format_t format);
986 const char *snd_pcm_format_description(const snd_pcm_format_t format);
987 const char *snd_pcm_subformat_name(const snd_pcm_subformat_t subformat);
988 const char *snd_pcm_subformat_description(const snd_pcm_subformat_t subformat);
989 snd_pcm_format_t snd_pcm_format_value(const char* name);
990 const char *snd_pcm_tstamp_mode_name(const snd_pcm_tstamp_t mode);
991 const char *snd_pcm_state_name(const snd_pcm_state_t state);
992 
1002 int snd_pcm_dump(snd_pcm_t *pcm, snd_output_t *out);
1005 int snd_pcm_dump_setup(snd_pcm_t *pcm, snd_output_t *out);
1009 
1019 int snd_pcm_mmap_begin(snd_pcm_t *pcm,
1020  const snd_pcm_channel_area_t **areas,
1021  snd_pcm_uframes_t *offset,
1022  snd_pcm_uframes_t *frames);
1023 snd_pcm_sframes_t snd_pcm_mmap_commit(snd_pcm_t *pcm,
1024  snd_pcm_uframes_t offset,
1025  snd_pcm_uframes_t frames);
1026 snd_pcm_sframes_t snd_pcm_mmap_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size);
1027 snd_pcm_sframes_t snd_pcm_mmap_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size);
1028 snd_pcm_sframes_t snd_pcm_mmap_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
1029 snd_pcm_sframes_t snd_pcm_mmap_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
1030 
1047 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
1048 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
1049 snd_pcm_format_t snd_pcm_build_linear_format(int width, int pwidth, int unsignd, int big_endian);
1050 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1051 u_int8_t snd_pcm_format_silence(snd_pcm_format_t format);
1055 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int samples);
1056 
1057 snd_pcm_sframes_t snd_pcm_bytes_to_frames(snd_pcm_t *pcm, ssize_t bytes);
1058 ssize_t snd_pcm_frames_to_bytes(snd_pcm_t *pcm, snd_pcm_sframes_t frames);
1059 long snd_pcm_bytes_to_samples(snd_pcm_t *pcm, ssize_t bytes);
1060 ssize_t snd_pcm_samples_to_bytes(snd_pcm_t *pcm, long samples);
1061 
1062 int snd_pcm_area_silence(const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset,
1063  unsigned int samples, snd_pcm_format_t format);
1064 int snd_pcm_areas_silence(const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset,
1065  unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format);
1066 int snd_pcm_area_copy(const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset,
1067  const snd_pcm_channel_area_t *src_channel, snd_pcm_uframes_t src_offset,
1068  unsigned int samples, snd_pcm_format_t format);
1069 int snd_pcm_areas_copy(const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset,
1070  const snd_pcm_channel_area_t *src_channels, snd_pcm_uframes_t src_offset,
1071  unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format);
1072 
1083 typedef enum _snd_pcm_hook_type {
1084  SND_PCM_HOOK_TYPE_HW_PARAMS = 0,
1085  SND_PCM_HOOK_TYPE_HW_FREE,
1086  SND_PCM_HOOK_TYPE_CLOSE,
1087  SND_PCM_HOOK_TYPE_LAST = SND_PCM_HOOK_TYPE_CLOSE
1089 
1091 typedef struct _snd_pcm_hook snd_pcm_hook_t;
1093 typedef int (*snd_pcm_hook_func_t)(snd_pcm_hook_t *hook);
1096 void snd_pcm_hook_set_private(snd_pcm_hook_t *hook, void *private_data);
1097 int snd_pcm_hook_add(snd_pcm_hook_t **hookp, snd_pcm_t *pcm,
1098  snd_pcm_hook_type_t type,
1099  snd_pcm_hook_func_t func, void *private_data);
1101 
1112 typedef struct _snd_pcm_scope_ops {
1116  int (*enable)(snd_pcm_scope_t *scope);
1120  void (*disable)(snd_pcm_scope_t *scope);
1124  void (*start)(snd_pcm_scope_t *scope);
1128  void (*stop)(snd_pcm_scope_t *scope);
1132  void (*update)(snd_pcm_scope_t *scope);
1136  void (*reset)(snd_pcm_scope_t *scope);
1140  void (*close)(snd_pcm_scope_t *scope);
1142 
1143 snd_pcm_uframes_t snd_pcm_meter_get_bufsize(snd_pcm_t *pcm);
1144 unsigned int snd_pcm_meter_get_channels(snd_pcm_t *pcm);
1145 unsigned int snd_pcm_meter_get_rate(snd_pcm_t *pcm);
1146 snd_pcm_uframes_t snd_pcm_meter_get_now(snd_pcm_t *pcm);
1147 snd_pcm_uframes_t snd_pcm_meter_get_boundary(snd_pcm_t *pcm);
1149 snd_pcm_scope_t *snd_pcm_meter_search_scope(snd_pcm_t *pcm, const char *name);
1152  const snd_pcm_scope_ops_t *val);
1153 void snd_pcm_scope_set_name(snd_pcm_scope_t *scope, const char *val);
1154 const char *snd_pcm_scope_get_name(snd_pcm_scope_t *scope);
1156 void snd_pcm_scope_set_callback_private(snd_pcm_scope_t *scope, void *val);
1157 int snd_pcm_scope_s16_open(snd_pcm_t *pcm, const char *name,
1158  snd_pcm_scope_t **scopep);
1160  unsigned int channel);
1161 
1172 typedef enum _snd_spcm_latency {
1183 
1185 typedef enum _snd_spcm_xrun_type {
1191 
1193 typedef enum _snd_spcm_duplex_type {
1199 
1200 int snd_spcm_init(snd_pcm_t *pcm,
1201  unsigned int rate,
1202  unsigned int channels,
1203  snd_pcm_format_t format,
1204  snd_pcm_subformat_t subformat,
1205  snd_spcm_latency_t latency,
1206  snd_pcm_access_t _access,
1207  snd_spcm_xrun_type_t xrun_type);
1208 
1209 int snd_spcm_init_duplex(snd_pcm_t *playback_pcm,
1210  snd_pcm_t *capture_pcm,
1211  unsigned int rate,
1212  unsigned int channels,
1213  snd_pcm_format_t format,
1214  snd_pcm_subformat_t subformat,
1215  snd_spcm_latency_t latency,
1216  snd_pcm_access_t _access,
1217  snd_spcm_xrun_type_t xrun_type,
1218  snd_spcm_duplex_type_t duplex_type);
1219 
1221  unsigned int *rate,
1222  snd_pcm_uframes_t *buffer_size,
1223  snd_pcm_uframes_t *period_size);
1224 
1234 /* Deprecated functions, for compatibility */
1235 const char *snd_pcm_start_mode_name(snd_pcm_start_t mode) __attribute__((deprecated));
1236 const char *snd_pcm_xrun_mode_name(snd_pcm_xrun_t mode) __attribute__((deprecated));
1237 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));
1238 snd_pcm_start_t snd_pcm_sw_params_get_start_mode(const snd_pcm_sw_params_t *params) __attribute__((deprecated));
1239 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));
1240 snd_pcm_xrun_t snd_pcm_sw_params_get_xrun_mode(const snd_pcm_sw_params_t *params) __attribute__((deprecated));
1241 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_SW_PARAMS_API)
1242 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));
1243 int snd_pcm_sw_params_get_xfer_align(const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val) __attribute__((deprecated));
1244 int snd_pcm_sw_params_set_sleep_min(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, unsigned int val) __attribute__((deprecated));
1245 int snd_pcm_sw_params_get_sleep_min(const snd_pcm_sw_params_t *params, unsigned int *val) __attribute__((deprecated));
1246 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_SW_PARAMS_API */
1247 #if !defined(ALSA_LIBRARY_BUILD) && !defined(ALSA_PCM_OLD_HW_PARAMS_API)
1248 int snd_pcm_hw_params_get_tick_time(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1249 int snd_pcm_hw_params_get_tick_time_min(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1250 int snd_pcm_hw_params_get_tick_time_max(const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated));
1251 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));
1252 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));
1253 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));
1254 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));
1255 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));
1256 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));
1257 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));
1258 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));
1259 #endif /* !ALSA_LIBRARY_BUILD && !ALSA_PCM_OLD_HW_PARAMS_API */
1260 
1263 #ifdef __cplusplus
1264 }
1265 #endif
1266 
1267 #endif /* __ALSA_PCM_H */