ALSA project - the C library reference
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Typedefs | Enumerations | Functions
pcm.h File Reference

Application interface library for the ALSA driver. More...

Go to the source code of this file.

Data Structures

struct  snd_pcm_channel_area_t
union  snd_pcm_sync_id_t
struct  snd_pcm_chmap_t
struct  snd_pcm_chmap_query_t
struct  snd_pcm_scope_ops_t

Macros

#define SND_PCM_DLSYM_VERSION   _dlsym_pcm_001
#define SND_PCM_NONBLOCK
#define SND_PCM_ASYNC
#define SND_PCM_ABORT   0x00008000
#define SND_PCM_NO_AUTO_RESAMPLE   0x00010000
#define SND_PCM_NO_AUTO_CHANNELS   0x00020000
#define SND_PCM_NO_AUTO_FORMAT   0x00040000
#define SND_PCM_NO_SOFTVOL   0x00080000
#define SND_CHMAP_API_VERSION   ((1 << 16) | (0 << 8) | 1)
#define SND_CHMAP_POSITION_MASK   0xffff
#define SND_CHMAP_PHASE_INVERSE   (0x01 << 16)
#define SND_CHMAP_DRIVER_SPEC   (0x02 << 16)
#define snd_pcm_info_alloca(ptr)
 allocate an invalid snd_pcm_info_t using standard alloca
#define snd_pcm_hw_params_alloca(ptr)
 allocate an invalid snd_pcm_hw_params_t using standard alloca
#define snd_pcm_sw_params_alloca(ptr)
 allocate an invalid snd_pcm_sw_params_t using standard alloca
#define snd_pcm_access_mask_alloca(ptr)
 allocate an empty snd_pcm_access_mask_t using standard alloca
#define snd_pcm_format_mask_alloca(ptr)
 allocate an empty snd_pcm_format_mask_t using standard alloca
#define snd_pcm_subformat_mask_alloca(ptr)
 allocate an empty snd_pcm_subformat_mask_t using standard alloca
#define snd_pcm_status_alloca(ptr)
 allocate an invalid snd_pcm_status_t using standard alloca

Typedefs

typedef struct _snd_pcm_info snd_pcm_info_t
typedef struct _snd_pcm_hw_params snd_pcm_hw_params_t
typedef struct _snd_pcm_sw_params snd_pcm_sw_params_t
typedef struct _snd_pcm_status snd_pcm_status_t
typedef struct _snd_pcm_access_mask snd_pcm_access_mask_t
typedef struct _snd_pcm_format_mask snd_pcm_format_mask_t
typedef struct
_snd_pcm_subformat_mask 
snd_pcm_subformat_mask_t
typedef unsigned long snd_pcm_uframes_t
typedef long snd_pcm_sframes_t
typedef struct _snd_pcm snd_pcm_t
typedef enum _snd_pcm_type snd_pcm_type_t
typedef struct _snd_pcm_scope snd_pcm_scope_t
typedef struct _snd_pcm_hook snd_pcm_hook_t
typedef int(* snd_pcm_hook_func_t )(snd_pcm_hook_t *hook)

Enumerations

enum  snd_pcm_class_t {
  SND_PCM_CLASS_GENERIC = 0, SND_PCM_CLASS_MULTI, SND_PCM_CLASS_MODEM, SND_PCM_CLASS_DIGITIZER,
  SND_PCM_CLASS_LAST = SND_PCM_CLASS_DIGITIZER
}
enum  snd_pcm_subclass_t { SND_PCM_SUBCLASS_GENERIC_MIX = 0, SND_PCM_SUBCLASS_MULTI_MIX, SND_PCM_SUBCLASS_LAST = SND_PCM_SUBCLASS_MULTI_MIX }
enum  snd_pcm_stream_t { SND_PCM_STREAM_PLAYBACK = 0, SND_PCM_STREAM_CAPTURE, SND_PCM_STREAM_LAST = SND_PCM_STREAM_CAPTURE }
enum  snd_pcm_access_t {
  SND_PCM_ACCESS_MMAP_INTERLEAVED = 0, SND_PCM_ACCESS_MMAP_NONINTERLEAVED, SND_PCM_ACCESS_MMAP_COMPLEX, SND_PCM_ACCESS_RW_INTERLEAVED,
  SND_PCM_ACCESS_RW_NONINTERLEAVED, SND_PCM_ACCESS_LAST = SND_PCM_ACCESS_RW_NONINTERLEAVED
}
enum  snd_pcm_format_t {
  SND_PCM_FORMAT_UNKNOWN = -1, SND_PCM_FORMAT_S8 = 0, SND_PCM_FORMAT_U8, SND_PCM_FORMAT_S16_LE,
  SND_PCM_FORMAT_S16_BE, SND_PCM_FORMAT_U16_LE, SND_PCM_FORMAT_U16_BE, SND_PCM_FORMAT_S24_LE,
  SND_PCM_FORMAT_S24_BE, SND_PCM_FORMAT_U24_LE, SND_PCM_FORMAT_U24_BE, SND_PCM_FORMAT_S32_LE,
  SND_PCM_FORMAT_S32_BE, SND_PCM_FORMAT_U32_LE, SND_PCM_FORMAT_U32_BE, SND_PCM_FORMAT_FLOAT_LE,
  SND_PCM_FORMAT_FLOAT_BE, SND_PCM_FORMAT_FLOAT64_LE, SND_PCM_FORMAT_FLOAT64_BE, SND_PCM_FORMAT_IEC958_SUBFRAME_LE,
  SND_PCM_FORMAT_IEC958_SUBFRAME_BE, SND_PCM_FORMAT_MU_LAW, SND_PCM_FORMAT_A_LAW, SND_PCM_FORMAT_IMA_ADPCM,
  SND_PCM_FORMAT_MPEG, SND_PCM_FORMAT_GSM, SND_PCM_FORMAT_SPECIAL = 31, SND_PCM_FORMAT_S24_3LE = 32,
  SND_PCM_FORMAT_S24_3BE, SND_PCM_FORMAT_U24_3LE, SND_PCM_FORMAT_U24_3BE, SND_PCM_FORMAT_S20_3LE,
  SND_PCM_FORMAT_S20_3BE, SND_PCM_FORMAT_U20_3LE, SND_PCM_FORMAT_U20_3BE, SND_PCM_FORMAT_S18_3LE,
  SND_PCM_FORMAT_S18_3BE, SND_PCM_FORMAT_U18_3LE, SND_PCM_FORMAT_U18_3BE, SND_PCM_FORMAT_G723_24,
  SND_PCM_FORMAT_G723_24_1B, SND_PCM_FORMAT_G723_40, SND_PCM_FORMAT_G723_40_1B, SND_PCM_FORMAT_DSD_U8,
  SND_PCM_FORMAT_DSD_U16_LE, SND_PCM_FORMAT_LAST = SND_PCM_FORMAT_DSD_U16_LE, SND_PCM_FORMAT_S16 = SND_PCM_FORMAT_S16_LE, SND_PCM_FORMAT_U16 = SND_PCM_FORMAT_U16_LE,
  SND_PCM_FORMAT_S24 = SND_PCM_FORMAT_S24_LE, SND_PCM_FORMAT_U24 = SND_PCM_FORMAT_U24_LE, SND_PCM_FORMAT_S32 = SND_PCM_FORMAT_S32_LE, SND_PCM_FORMAT_U32 = SND_PCM_FORMAT_U32_LE,
  SND_PCM_FORMAT_FLOAT = SND_PCM_FORMAT_FLOAT_LE, SND_PCM_FORMAT_FLOAT64 = SND_PCM_FORMAT_FLOAT64_LE, SND_PCM_FORMAT_IEC958_SUBFRAME = SND_PCM_FORMAT_IEC958_SUBFRAME_LE
}
enum  snd_pcm_subformat_t { SND_PCM_SUBFORMAT_STD = 0, SND_PCM_SUBFORMAT_LAST = SND_PCM_SUBFORMAT_STD }
enum  snd_pcm_state_t {
  SND_PCM_STATE_OPEN = 0, SND_PCM_STATE_SETUP, SND_PCM_STATE_PREPARED, SND_PCM_STATE_RUNNING,
  SND_PCM_STATE_XRUN, SND_PCM_STATE_DRAINING, SND_PCM_STATE_PAUSED, SND_PCM_STATE_SUSPENDED,
  SND_PCM_STATE_DISCONNECTED, SND_PCM_STATE_LAST = SND_PCM_STATE_DISCONNECTED
}
enum  snd_pcm_start_t { SND_PCM_START_DATA = 0, SND_PCM_START_EXPLICIT, SND_PCM_START_LAST = SND_PCM_START_EXPLICIT }
enum  snd_pcm_xrun_t { SND_PCM_XRUN_NONE = 0, SND_PCM_XRUN_STOP, SND_PCM_XRUN_LAST = SND_PCM_XRUN_STOP }
enum  snd_pcm_tstamp_t { SND_PCM_TSTAMP_NONE = 0, SND_PCM_TSTAMP_ENABLE, SND_PCM_TSTAMP_MMAP = SND_PCM_TSTAMP_ENABLE, SND_PCM_TSTAMP_LAST = SND_PCM_TSTAMP_ENABLE }
enum  _snd_pcm_type {
  SND_PCM_TYPE_HW = 0, SND_PCM_TYPE_HOOKS, SND_PCM_TYPE_MULTI, SND_PCM_TYPE_FILE,
  SND_PCM_TYPE_NULL, SND_PCM_TYPE_SHM, SND_PCM_TYPE_INET, SND_PCM_TYPE_COPY,
  SND_PCM_TYPE_LINEAR, SND_PCM_TYPE_ALAW, SND_PCM_TYPE_MULAW, SND_PCM_TYPE_ADPCM,
  SND_PCM_TYPE_RATE, SND_PCM_TYPE_ROUTE, SND_PCM_TYPE_PLUG, SND_PCM_TYPE_SHARE,
  SND_PCM_TYPE_METER, SND_PCM_TYPE_MIX, SND_PCM_TYPE_DROUTE, SND_PCM_TYPE_LBSERVER,
  SND_PCM_TYPE_LINEAR_FLOAT, SND_PCM_TYPE_LADSPA, SND_PCM_TYPE_DMIX, SND_PCM_TYPE_JACK,
  SND_PCM_TYPE_DSNOOP, SND_PCM_TYPE_DSHARE, SND_PCM_TYPE_IEC958, SND_PCM_TYPE_SOFTVOL,
  SND_PCM_TYPE_IOPLUG, SND_PCM_TYPE_EXTPLUG, SND_PCM_TYPE_MMAP_EMUL, SND_PCM_TYPE_LAST = SND_PCM_TYPE_MMAP_EMUL
}
enum  snd_pcm_chmap_type {
  SND_CHMAP_TYPE_NONE = 0, SND_CHMAP_TYPE_FIXED, SND_CHMAP_TYPE_VAR, SND_CHMAP_TYPE_PAIRED,
  SND_CHMAP_TYPE_LAST = SND_CHMAP_TYPE_PAIRED
}
enum  snd_pcm_chmap_position {
  SND_CHMAP_UNKNOWN = 0, SND_CHMAP_NA, SND_CHMAP_MONO, SND_CHMAP_FL,
  SND_CHMAP_FR, SND_CHMAP_RL, SND_CHMAP_RR, SND_CHMAP_FC,
  SND_CHMAP_LFE, SND_CHMAP_SL, SND_CHMAP_SR, SND_CHMAP_RC,
  SND_CHMAP_FLC, SND_CHMAP_FRC, SND_CHMAP_RLC, SND_CHMAP_RRC,
  SND_CHMAP_FLW, SND_CHMAP_FRW, SND_CHMAP_FLH, SND_CHMAP_FCH,
  SND_CHMAP_FRH, SND_CHMAP_TC, SND_CHMAP_TFL, SND_CHMAP_TFR,
  SND_CHMAP_TFC, SND_CHMAP_TRL, SND_CHMAP_TRR, SND_CHMAP_TRC,
  SND_CHMAP_TFLC, SND_CHMAP_TFRC, SND_CHMAP_TSL, SND_CHMAP_TSR,
  SND_CHMAP_LLFE, SND_CHMAP_RLFE, SND_CHMAP_BC, SND_CHMAP_BLC,
  SND_CHMAP_BRC, SND_CHMAP_LAST = SND_CHMAP_BRC
}
enum  snd_pcm_hook_type_t { SND_PCM_HOOK_TYPE_HW_PARAMS = 0, SND_PCM_HOOK_TYPE_HW_FREE, SND_PCM_HOOK_TYPE_CLOSE, SND_PCM_HOOK_TYPE_LAST = SND_PCM_HOOK_TYPE_CLOSE }
enum  snd_spcm_latency_t { SND_SPCM_LATENCY_STANDARD = 0, SND_SPCM_LATENCY_MEDIUM, SND_SPCM_LATENCY_REALTIME }
enum  snd_spcm_xrun_type_t { SND_SPCM_XRUN_IGNORE = 0, SND_SPCM_XRUN_STOP }
enum  snd_spcm_duplex_type_t { SND_SPCM_DUPLEX_LIBERAL = 0, SND_SPCM_DUPLEX_PEDANTIC }

Functions

int snd_pcm_open (snd_pcm_t **pcm, const char *name, snd_pcm_stream_t stream, int mode)
 Opens a PCM.
int snd_pcm_open_lconf (snd_pcm_t **pcm, const char *name, snd_pcm_stream_t stream, int mode, snd_config_t *lconf)
 Opens a PCM using local configuration.
int snd_pcm_open_fallback (snd_pcm_t **pcm, snd_config_t *root, const char *name, const char *orig_name, snd_pcm_stream_t stream, int mode)
 Opens a fallback PCM.
int snd_pcm_close (snd_pcm_t *pcm)
 close PCM handle
const char * snd_pcm_name (snd_pcm_t *pcm)
 get identifier of PCM handle
snd_pcm_type_t snd_pcm_type (snd_pcm_t *pcm)
 get type of PCM handle
snd_pcm_stream_t snd_pcm_stream (snd_pcm_t *pcm)
 get stream for a PCM handle
int snd_pcm_poll_descriptors_count (snd_pcm_t *pcm)
 get count of poll descriptors for PCM handle
int snd_pcm_poll_descriptors (snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space)
 get poll descriptors
int snd_pcm_poll_descriptors_revents (snd_pcm_t *pcm, struct pollfd *pfds, unsigned int nfds, unsigned short *revents)
 get returned events from poll descriptors
int snd_pcm_nonblock (snd_pcm_t *pcm, int nonblock)
 set nonblock mode
int snd_async_add_pcm_handler (snd_async_handler_t **handler, snd_pcm_t *pcm, snd_async_callback_t callback, void *private_data)
 Add an async handler for a PCM.
snd_pcm_tsnd_async_handler_get_pcm (snd_async_handler_t *handler)
 Return PCM handle related to an async handler.
int snd_pcm_info (snd_pcm_t *pcm, snd_pcm_info_t *info)
 Obtain general (static) information for PCM handle.
int snd_pcm_hw_params_current (snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
 Retreive current PCM hardware configuration chosen with snd_pcm_hw_params.
int snd_pcm_hw_params (snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
 Install one PCM hardware configuration chosen from a configuration space and snd_pcm_prepare it.
int snd_pcm_hw_free (snd_pcm_t *pcm)
 Remove PCM hardware configuration and free associated resources.
int snd_pcm_sw_params_current (snd_pcm_t *pcm, snd_pcm_sw_params_t *params)
 Return current software configuration for a PCM.
int snd_pcm_sw_params (snd_pcm_t *pcm, snd_pcm_sw_params_t *params)
 Install PCM software configuration defined by params.
int snd_pcm_prepare (snd_pcm_t *pcm)
 Prepare PCM for use.
int snd_pcm_reset (snd_pcm_t *pcm)
 Reset PCM position.
int snd_pcm_status (snd_pcm_t *pcm, snd_pcm_status_t *status)
 Obtain status (runtime) information for PCM handle.
int snd_pcm_start (snd_pcm_t *pcm)
 Start a PCM.
int snd_pcm_drop (snd_pcm_t *pcm)
 Stop a PCM dropping pending frames.
int snd_pcm_drain (snd_pcm_t *pcm)
 Stop a PCM preserving pending frames.
int snd_pcm_pause (snd_pcm_t *pcm, int enable)
 Pause/resume PCM.
snd_pcm_state_t snd_pcm_state (snd_pcm_t *pcm)
 Return PCM state.
int snd_pcm_hwsync (snd_pcm_t *pcm)
 (DEPRECATED) Synchronize stream position with hardware
int snd_pcm_delay (snd_pcm_t *pcm, snd_pcm_sframes_t *delayp)
 Obtain delay for a running PCM handle.
int snd_pcm_resume (snd_pcm_t *pcm)
 Resume from suspend, no samples are lost.
int snd_pcm_htimestamp (snd_pcm_t *pcm, snd_pcm_uframes_t *avail, snd_htimestamp_t *tstamp)
 Obtain last position update hi-res timestamp.
snd_pcm_sframes_t snd_pcm_avail (snd_pcm_t *pcm)
 Return number of frames ready to be read (capture) / written (playback)
snd_pcm_sframes_t snd_pcm_avail_update (snd_pcm_t *pcm)
 Return number of frames ready to be read (capture) / written (playback)
int snd_pcm_avail_delay (snd_pcm_t *pcm, snd_pcm_sframes_t *availp, snd_pcm_sframes_t *delayp)
 Combine snd_pcm_avail and snd_pcm_delay functions.
snd_pcm_sframes_t snd_pcm_rewindable (snd_pcm_t *pcm)
 Get safe count of frames which can be rewinded.
snd_pcm_sframes_t snd_pcm_rewind (snd_pcm_t *pcm, snd_pcm_uframes_t frames)
 Move application frame position backward.
snd_pcm_sframes_t snd_pcm_forwardable (snd_pcm_t *pcm)
 Get safe count of frames which can be forwarded.
snd_pcm_sframes_t snd_pcm_forward (snd_pcm_t *pcm, snd_pcm_uframes_t frames)
 Move application frame position forward.
snd_pcm_sframes_t snd_pcm_writei (snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size)
 Write interleaved frames to a PCM.
snd_pcm_sframes_t snd_pcm_readi (snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size)
 Read interleaved frames from a PCM.
snd_pcm_sframes_t snd_pcm_writen (snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size)
 Write non interleaved frames to a PCM.
snd_pcm_sframes_t snd_pcm_readn (snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size)
 Read non interleaved frames to a PCM.
int snd_pcm_wait (snd_pcm_t *pcm, int timeout)
 Wait for a PCM to become ready.
int snd_pcm_link (snd_pcm_t *pcm1, snd_pcm_t *pcm2)
 Link two PCMs.
int snd_pcm_unlink (snd_pcm_t *pcm)
 Remove a PCM from a linked group.
snd_pcm_chmap_query_t ** snd_pcm_query_chmaps (snd_pcm_t *pcm)
snd_pcm_chmap_query_t ** snd_pcm_query_chmaps_from_hw (int card, int dev, int subdev, snd_pcm_stream_t stream)
void snd_pcm_free_chmaps (snd_pcm_chmap_query_t **maps)
snd_pcm_chmap_tsnd_pcm_get_chmap (snd_pcm_t *pcm)
int snd_pcm_set_chmap (snd_pcm_t *pcm, const snd_pcm_chmap_t *map)
const char * snd_pcm_chmap_type_name (enum snd_pcm_chmap_type val)
const char * snd_pcm_chmap_name (enum snd_pcm_chmap_position val)
const char * snd_pcm_chmap_long_name (enum snd_pcm_chmap_position val)
int snd_pcm_chmap_print (const snd_pcm_chmap_t *map, size_t maxlen, char *buf)
unsigned int snd_pcm_chmap_from_string (const char *str)
snd_pcm_chmap_tsnd_pcm_chmap_parse_string (const char *str)
int snd_pcm_recover (snd_pcm_t *pcm, int err, int silent)
 Recover the stream state from an error or suspend.
int snd_pcm_set_params (snd_pcm_t *pcm, snd_pcm_format_t format, snd_pcm_access_t access, unsigned int channels, unsigned int rate, int soft_resample, unsigned int latency)
 Set the hardware and software parameters in a simple way.
int snd_pcm_get_params (snd_pcm_t *pcm, snd_pcm_uframes_t *buffer_size, snd_pcm_uframes_t *period_size)
 Get the transfer size parameters in a simple way.
size_t snd_pcm_info_sizeof (void)
 get size of snd_pcm_info_t
int snd_pcm_info_malloc (snd_pcm_info_t **ptr)
 allocate an invalid snd_pcm_info_t using standard malloc
void snd_pcm_info_free (snd_pcm_info_t *obj)
 frees a previously allocated snd_pcm_info_t
void snd_pcm_info_copy (snd_pcm_info_t *dst, const snd_pcm_info_t *src)
 copy one snd_pcm_info_t to another
unsigned int snd_pcm_info_get_device (const snd_pcm_info_t *obj)
 Get device from a PCM info container.
unsigned int snd_pcm_info_get_subdevice (const snd_pcm_info_t *obj)
 Get subdevice from a PCM info container.
snd_pcm_stream_t snd_pcm_info_get_stream (const snd_pcm_info_t *obj)
 Get stream (direction) from a PCM info container.
int snd_pcm_info_get_card (const snd_pcm_info_t *obj)
 Get card from a PCM info container.
const char * snd_pcm_info_get_id (const snd_pcm_info_t *obj)
 Get id from a PCM info container.
const char * snd_pcm_info_get_name (const snd_pcm_info_t *obj)
 Get name from a PCM info container.
const char * snd_pcm_info_get_subdevice_name (const snd_pcm_info_t *obj)
 Get subdevice name from a PCM info container.
snd_pcm_class_t snd_pcm_info_get_class (const snd_pcm_info_t *obj)
 Get class from a PCM info container.
snd_pcm_subclass_t snd_pcm_info_get_subclass (const snd_pcm_info_t *obj)
 Get subclass from a PCM info container.
unsigned int snd_pcm_info_get_subdevices_count (const snd_pcm_info_t *obj)
 Get subdevices count from a PCM info container.
unsigned int snd_pcm_info_get_subdevices_avail (const snd_pcm_info_t *obj)
 Get available subdevices count from a PCM info container.
snd_pcm_sync_id_t snd_pcm_info_get_sync (const snd_pcm_info_t *obj)
 Get hardware synchronization ID from a PCM info container.
void snd_pcm_info_set_device (snd_pcm_info_t *obj, unsigned int val)
 Set wanted device inside a PCM info container (see snd_ctl_pcm_info)
void snd_pcm_info_set_subdevice (snd_pcm_info_t *obj, unsigned int val)
 Set wanted subdevice inside a PCM info container (see snd_ctl_pcm_info)
void snd_pcm_info_set_stream (snd_pcm_info_t *obj, snd_pcm_stream_t val)
 Set wanted stream inside a PCM info container (see snd_ctl_pcm_info)
int snd_pcm_hw_params_any (snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
 Fill params with a full configuration space for a PCM.
int snd_pcm_hw_params_can_mmap_sample_resolution (const snd_pcm_hw_params_t *params)
 Check if hardware supports sample-resolution mmap for given configuration.
int snd_pcm_hw_params_is_double (const snd_pcm_hw_params_t *params)
 Check if hardware does double buffering for start/stop for given configuration.
int snd_pcm_hw_params_is_batch (const snd_pcm_hw_params_t *params)
 Check if hardware does double buffering for data transfers for given configuration.
int snd_pcm_hw_params_is_block_transfer (const snd_pcm_hw_params_t *params)
 Check if hardware does block transfers for samples for given configuration.
int snd_pcm_hw_params_is_monotonic (const snd_pcm_hw_params_t *params)
 Check if timestamps are monotonic for given configuration.
int snd_pcm_hw_params_can_overrange (const snd_pcm_hw_params_t *params)
 Check if hardware supports overrange detection.
int snd_pcm_hw_params_can_pause (const snd_pcm_hw_params_t *params)
 Check if hardware supports pause.
int snd_pcm_hw_params_can_resume (const snd_pcm_hw_params_t *params)
 Check if hardware supports resume.
int snd_pcm_hw_params_is_half_duplex (const snd_pcm_hw_params_t *params)
 Check if hardware does half-duplex only.
int snd_pcm_hw_params_is_joint_duplex (const snd_pcm_hw_params_t *params)
 Check if hardware does joint-duplex (playback and capture are somewhat correlated)
int snd_pcm_hw_params_can_sync_start (const snd_pcm_hw_params_t *params)
 Check if hardware supports synchronized start with sample resolution.
int snd_pcm_hw_params_can_disable_period_wakeup (const snd_pcm_hw_params_t *params)
 Check if hardware can disable period wakeups.
int snd_pcm_hw_params_supports_audio_wallclock_ts (const snd_pcm_hw_params_t *params)
 Check if hardware supports audio wallclock timestamps.
int snd_pcm_hw_params_get_rate_numden (const snd_pcm_hw_params_t *params, unsigned int *rate_num, unsigned int *rate_den)
 Get rate exact info from a configuration space.
int snd_pcm_hw_params_get_sbits (const snd_pcm_hw_params_t *params)
 Get sample resolution info from a configuration space.
int snd_pcm_hw_params_get_fifo_size (const snd_pcm_hw_params_t *params)
 Get hardware FIFO size info from a configuration space.
size_t snd_pcm_hw_params_sizeof (void)
 get size of snd_pcm_hw_params_t
int snd_pcm_hw_params_malloc (snd_pcm_hw_params_t **ptr)
 allocate an invalid snd_pcm_hw_params_t using standard malloc
void snd_pcm_hw_params_free (snd_pcm_hw_params_t *obj)
 frees a previously allocated snd_pcm_hw_params_t
void snd_pcm_hw_params_copy (snd_pcm_hw_params_t *dst, const snd_pcm_hw_params_t *src)
 copy one snd_pcm_hw_params_t to another
int snd_pcm_hw_params_get_access (const snd_pcm_hw_params_t *params, snd_pcm_access_t *_access)
 Extract access type from a configuration space.
int snd_pcm_hw_params_test_access (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t _access)
 Verify if an access type is available inside a configuration space for a PCM.
int snd_pcm_hw_params_set_access (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t _access)
 Restrict a configuration space to contain only one access type.
int snd_pcm_hw_params_set_access_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *_access)
 Restrict a configuration space to contain only its first access type.
int snd_pcm_hw_params_set_access_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_t *_access)
 Restrict a configuration space to contain only its last access type.
int snd_pcm_hw_params_set_access_mask (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask)
 Restrict a configuration space to contain only a set of access types.
int snd_pcm_hw_params_get_access_mask (snd_pcm_hw_params_t *params, snd_pcm_access_mask_t *mask)
 Get access mask from a configuration space.
int snd_pcm_hw_params_get_format (const snd_pcm_hw_params_t *params, snd_pcm_format_t *val)
 Extract format from a configuration space.
int snd_pcm_hw_params_test_format (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val)
 Verify if a format is available inside a configuration space for a PCM.
int snd_pcm_hw_params_set_format (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t val)
 Restrict a configuration space to contain only one format.
int snd_pcm_hw_params_set_format_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format)
 Restrict a configuration space to contain only its first format.
int snd_pcm_hw_params_set_format_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_t *format)
 Restrict a configuration space to contain only its last format.
int snd_pcm_hw_params_set_format_mask (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask)
 Restrict a configuration space to contain only a set of formats.
void snd_pcm_hw_params_get_format_mask (snd_pcm_hw_params_t *params, snd_pcm_format_mask_t *mask)
 Get format mask from a configuration space.
int snd_pcm_hw_params_get_subformat (const snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat)
 Extract subformat from a configuration space.
int snd_pcm_hw_params_test_subformat (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat)
 Verify if a subformat is available inside a configuration space for a PCM.
int snd_pcm_hw_params_set_subformat (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t subformat)
 Restrict a configuration space to contain only one subformat.
int snd_pcm_hw_params_set_subformat_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat)
 Restrict a configuration space to contain only its first subformat.
int snd_pcm_hw_params_set_subformat_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_t *subformat)
 Restrict a configuration space to contain only its last subformat.
int snd_pcm_hw_params_set_subformat_mask (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask)
 Restrict a configuration space to contain only a set of subformats.
void snd_pcm_hw_params_get_subformat_mask (snd_pcm_hw_params_t *params, snd_pcm_subformat_mask_t *mask)
 Get subformat mask from a configuration space.
int snd_pcm_hw_params_get_channels (const snd_pcm_hw_params_t *params, unsigned int *val)
 Extract channels from a configuration space.
int snd_pcm_hw_params_get_channels_min (const snd_pcm_hw_params_t *params, unsigned int *val)
 Extract minimum channels count from a configuration space.
int snd_pcm_hw_params_get_channels_max (const snd_pcm_hw_params_t *params, unsigned int *val)
 Extract maximum channels count from a configuration space.
int snd_pcm_hw_params_test_channels (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val)
 Verify if a channels count is available inside a configuration space for a PCM.
int snd_pcm_hw_params_set_channels (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val)
 Restrict a configuration space to contain only one channels count.
int snd_pcm_hw_params_set_channels_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Restrict a configuration space with a minimum channels count.
int snd_pcm_hw_params_set_channels_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Restrict a configuration space with a maximum channels count.
int snd_pcm_hw_params_set_channels_minmax (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *min, unsigned int *max)
 Restrict a configuration space to have channels counts in a given range.
int snd_pcm_hw_params_set_channels_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Restrict a configuration space to have channels count nearest to a target.
int snd_pcm_hw_params_set_channels_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Restrict a configuration space to contain only its minimum channels count.
int snd_pcm_hw_params_set_channels_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Restrict a configuration space to contain only its maximum channels count.
int snd_pcm_hw_params_get_rate (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract rate from a configuration space.
int snd_pcm_hw_params_get_rate_min (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract minimum rate from a configuration space.
int snd_pcm_hw_params_get_rate_max (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract maximum rate from a configuration space.
int snd_pcm_hw_params_test_rate (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Verify if a rate is available inside a configuration space for a PCM.
int snd_pcm_hw_params_set_rate (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Restrict a configuration space to contain only one rate.
int snd_pcm_hw_params_set_rate_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a minimum rate.
int snd_pcm_hw_params_set_rate_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a maximum rate.
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)
 Restrict a configuration space to have rates in a given range.
int snd_pcm_hw_params_set_rate_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to have rate nearest to a target.
int snd_pcm_hw_params_set_rate_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its minimum rate.
int snd_pcm_hw_params_set_rate_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its maximum rate.
int snd_pcm_hw_params_set_rate_resample (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val)
 Restrict a configuration space to contain only real hardware rates.
int snd_pcm_hw_params_get_rate_resample (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Extract resample state from a configuration space.
int snd_pcm_hw_params_set_export_buffer (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val)
 Restrict a configuration space to allow the buffer to be accessible from outside.
int snd_pcm_hw_params_get_export_buffer (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Extract buffer accessibility from a configuration space.
int snd_pcm_hw_params_set_period_wakeup (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val)
 Restrict a configuration space to settings without period wakeups.
int snd_pcm_hw_params_get_period_wakeup (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val)
 Extract period wakeup flag from a configuration space.
int snd_pcm_hw_params_get_period_time (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract period time from a configuration space.
int snd_pcm_hw_params_get_period_time_min (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract minimum period time from a configuration space.
int snd_pcm_hw_params_get_period_time_max (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract maximum period time from a configuration space.
int snd_pcm_hw_params_test_period_time (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Verify if a period time is available inside a configuration space for a PCM.
int snd_pcm_hw_params_set_period_time (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Restrict a configuration space to contain only one period time.
int snd_pcm_hw_params_set_period_time_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a minimum period time.
int snd_pcm_hw_params_set_period_time_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a maximum period time.
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)
 Restrict a configuration space to have period times in a given range.
int snd_pcm_hw_params_set_period_time_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to have period time nearest to a target.
int snd_pcm_hw_params_set_period_time_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its minimum period time.
int snd_pcm_hw_params_set_period_time_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its maximum period time.
int snd_pcm_hw_params_get_period_size (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir)
 Extract period size from a configuration space.
int snd_pcm_hw_params_get_period_size_min (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir)
 Extract minimum period size from a configuration space.
int snd_pcm_hw_params_get_period_size_max (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *frames, int *dir)
 Extract maximum period size from a configuration space.
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)
 Verify if a period size is available inside a configuration space for a PCM.
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)
 Restrict a configuration space to contain only one period size.
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)
 Restrict a configuration space with a minimum period size.
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)
 Restrict a configuration space with a maximum period size.
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)
 Restrict a configuration space to have period sizes in a given range.
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)
 Restrict a configuration space to have period size nearest to a target.
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)
 Restrict a configuration space to contain only its minimum period size.
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)
 Restrict a configuration space to contain only its maximum period size.
int snd_pcm_hw_params_set_period_size_integer (snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
 Restrict a configuration space to contain only integer period sizes.
int snd_pcm_hw_params_get_periods (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract periods from a configuration space.
int snd_pcm_hw_params_get_periods_min (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract minimum periods count from a configuration space.
int snd_pcm_hw_params_get_periods_max (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract maximum periods count from a configuration space.
int snd_pcm_hw_params_test_periods (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Verify if a periods count is available inside a configuration space for a PCM.
int snd_pcm_hw_params_set_periods (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Restrict a configuration space to contain only one periods count.
int snd_pcm_hw_params_set_periods_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a minimum periods count.
int snd_pcm_hw_params_set_periods_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a maximum periods count.
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)
 Restrict a configuration space to have periods counts in a given range.
int snd_pcm_hw_params_set_periods_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to have periods count nearest to a target.
int snd_pcm_hw_params_set_periods_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its minimum periods count.
int snd_pcm_hw_params_set_periods_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its maximum periods count.
int snd_pcm_hw_params_set_periods_integer (snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
 Restrict a configuration space to contain only integer periods counts.
int snd_pcm_hw_params_get_buffer_time (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract buffer time from a configuration space.
int snd_pcm_hw_params_get_buffer_time_min (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract minimum buffer time from a configuration space.
int snd_pcm_hw_params_get_buffer_time_max (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Extract maximum buffer time from a configuration space.
int snd_pcm_hw_params_test_buffer_time (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Verify if a buffer time is available inside a configuration space for a PCM.
int snd_pcm_hw_params_set_buffer_time (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int val, int dir)
 Restrict a configuration space to contain only one buffer time.
int snd_pcm_hw_params_set_buffer_time_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a minimum buffer time.
int snd_pcm_hw_params_set_buffer_time_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space with a maximum buffer time.
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)
 Restrict a configuration space to have buffer times in a given range.
int snd_pcm_hw_params_set_buffer_time_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to have buffer time nearest to a target.
int snd_pcm_hw_params_set_buffer_time_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its minimum buffer time.
int snd_pcm_hw_params_set_buffer_time_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, unsigned int *val, int *dir)
 Restrict a configuration space to contain only its maximum buffered time.
int snd_pcm_hw_params_get_buffer_size (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Extract buffer size from a configuration space.
int snd_pcm_hw_params_get_buffer_size_min (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Extract minimum buffer size from a configuration space.
int snd_pcm_hw_params_get_buffer_size_max (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Extract maximum buffer size from a configuration space.
int snd_pcm_hw_params_test_buffer_size (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val)
 Verify if a buffer size is available inside a configuration space for a PCM.
int snd_pcm_hw_params_set_buffer_size (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t val)
 Restrict a configuration space to contain only one buffer size.
int snd_pcm_hw_params_set_buffer_size_min (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Restrict a configuration space with a minimum buffer size.
int snd_pcm_hw_params_set_buffer_size_max (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Restrict a configuration space with a maximum buffer size.
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)
 Restrict a configuration space to have buffer sizes in a given range.
int snd_pcm_hw_params_set_buffer_size_near (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Restrict a configuration space to have buffer size nearest to a target.
int snd_pcm_hw_params_set_buffer_size_first (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Restrict a configuration space to contain only its minimum buffer size.
int snd_pcm_hw_params_set_buffer_size_last (snd_pcm_t *pcm, snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Restrict a configuration space to contain only its maximum buffer size.
int snd_pcm_hw_params_get_min_align (const snd_pcm_hw_params_t *params, snd_pcm_uframes_t *val)
 Get the minimum transfer align value in samples.
size_t snd_pcm_sw_params_sizeof (void)
 get size of snd_pcm_sw_params_t
int snd_pcm_sw_params_malloc (snd_pcm_sw_params_t **ptr)
 allocate an invalid snd_pcm_sw_params_t using standard malloc
void snd_pcm_sw_params_free (snd_pcm_sw_params_t *obj)
 frees a previously allocated snd_pcm_sw_params_t
void snd_pcm_sw_params_copy (snd_pcm_sw_params_t *dst, const snd_pcm_sw_params_t *src)
 copy one snd_pcm_sw_params_t to another
int snd_pcm_sw_params_get_boundary (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 Get boundary for ring pointers from a software configuration container.
int snd_pcm_sw_params_set_tstamp_mode (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_tstamp_t val)
 Set timestamp mode inside a software configuration container.
int snd_pcm_sw_params_get_tstamp_mode (const snd_pcm_sw_params_t *params, snd_pcm_tstamp_t *val)
 Get timestamp mode from a software configuration container.
int snd_pcm_sw_params_set_avail_min (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
 Set avail min inside a software configuration container.
int snd_pcm_sw_params_get_avail_min (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 Get avail min from a software configuration container.
int snd_pcm_sw_params_set_period_event (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, int val)
 Set period event inside a software configuration container.
int snd_pcm_sw_params_get_period_event (const snd_pcm_sw_params_t *params, int *val)
 Get period event from a software configuration container.
int snd_pcm_sw_params_set_start_threshold (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
 Set start threshold inside a software configuration container.
int snd_pcm_sw_params_get_start_threshold (const snd_pcm_sw_params_t *paramsm, snd_pcm_uframes_t *val)
 Get start threshold from a software configuration container.
int snd_pcm_sw_params_set_stop_threshold (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
 Set stop threshold inside a software configuration container.
int snd_pcm_sw_params_get_stop_threshold (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 Get stop threshold from a software configuration container.
int snd_pcm_sw_params_set_silence_threshold (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
 Set silence threshold inside a software configuration container.
int snd_pcm_sw_params_get_silence_threshold (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 Get silence threshold from a software configuration container.
int snd_pcm_sw_params_set_silence_size (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val)
 Set silence size inside a software configuration container.
int snd_pcm_sw_params_get_silence_size (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val)
 Get silence size from a software configuration container.
size_t snd_pcm_access_mask_sizeof (void)
 get size of snd_pcm_access_mask_t
int snd_pcm_access_mask_malloc (snd_pcm_access_mask_t **ptr)
 allocate an empty snd_pcm_access_mask_t using standard malloc
void snd_pcm_access_mask_free (snd_pcm_access_mask_t *obj)
 frees a previously allocated snd_pcm_access_mask_t
void snd_pcm_access_mask_copy (snd_pcm_access_mask_t *dst, const snd_pcm_access_mask_t *src)
 copy one snd_pcm_access_mask_t to another
void snd_pcm_access_mask_none (snd_pcm_access_mask_t *mask)
 reset all bits in a snd_pcm_access_mask_t
void snd_pcm_access_mask_any (snd_pcm_access_mask_t *mask)
 set all bits in a snd_pcm_access_mask_t
int snd_pcm_access_mask_test (const snd_pcm_access_mask_t *mask, snd_pcm_access_t val)
 test the presence of an access type in a snd_pcm_access_mask_t
int snd_pcm_access_mask_empty (const snd_pcm_access_mask_t *mask)
 test, if given a snd_pcm_access_mask_t is empty
void snd_pcm_access_mask_set (snd_pcm_access_mask_t *mask, snd_pcm_access_t val)
 make an access type present in a snd_pcm_access_mask_t
void snd_pcm_access_mask_reset (snd_pcm_access_mask_t *mask, snd_pcm_access_t val)
 make an access type missing from a snd_pcm_access_mask_t
size_t snd_pcm_format_mask_sizeof (void)
 get size of snd_pcm_format_mask_t
int snd_pcm_format_mask_malloc (snd_pcm_format_mask_t **ptr)
 allocate an empty snd_pcm_format_mask_t using standard malloc
void snd_pcm_format_mask_free (snd_pcm_format_mask_t *obj)
 frees a previously allocated snd_pcm_format_mask_t
void snd_pcm_format_mask_copy (snd_pcm_format_mask_t *dst, const snd_pcm_format_mask_t *src)
 copy one snd_pcm_format_mask_t to another
void snd_pcm_format_mask_none (snd_pcm_format_mask_t *mask)
 reset all bits in a snd_pcm_format_mask_t
void snd_pcm_format_mask_any (snd_pcm_format_mask_t *mask)
 set all bits in a snd_pcm_format_mask_t
int snd_pcm_format_mask_test (const snd_pcm_format_mask_t *mask, snd_pcm_format_t val)
 test the presence of a format in a snd_pcm_format_mask_t
int snd_pcm_format_mask_empty (const snd_pcm_format_mask_t *mask)
 test, if given a snd_pcm_format_mask_t is empty
void snd_pcm_format_mask_set (snd_pcm_format_mask_t *mask, snd_pcm_format_t val)
 make a format present in a snd_pcm_format_mask_t
void snd_pcm_format_mask_reset (snd_pcm_format_mask_t *mask, snd_pcm_format_t val)
 make a format missing from a snd_pcm_format_mask_t
size_t snd_pcm_subformat_mask_sizeof (void)
 get size of snd_pcm_subformat_mask_t
int snd_pcm_subformat_mask_malloc (snd_pcm_subformat_mask_t **ptr)
 allocate an empty snd_pcm_subformat_mask_t using standard malloc
void snd_pcm_subformat_mask_free (snd_pcm_subformat_mask_t *obj)
 frees a previously allocated snd_pcm_subformat_mask_t
void snd_pcm_subformat_mask_copy (snd_pcm_subformat_mask_t *dst, const snd_pcm_subformat_mask_t *src)
 copy one snd_pcm_subformat_mask_t to another
void snd_pcm_subformat_mask_none (snd_pcm_subformat_mask_t *mask)
 reset all bits in a snd_pcm_subformat_mask_t
void snd_pcm_subformat_mask_any (snd_pcm_subformat_mask_t *mask)
 set all bits in a snd_pcm_subformat_mask_t
int snd_pcm_subformat_mask_test (const snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val)
 test the presence of a subformat in a snd_pcm_subformat_mask_t
int snd_pcm_subformat_mask_empty (const snd_pcm_subformat_mask_t *mask)
 test, if given a snd_pcm_subformat_mask_t is empty
void snd_pcm_subformat_mask_set (snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val)
 make a subformat present in a snd_pcm_subformat_mask_t
void snd_pcm_subformat_mask_reset (snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val)
 make a subformat missing from a snd_pcm_subformat_mask_t
size_t snd_pcm_status_sizeof (void)
 get size of snd_pcm_status_t
int snd_pcm_status_malloc (snd_pcm_status_t **ptr)
 allocate an invalid snd_pcm_status_t using standard malloc
void snd_pcm_status_free (snd_pcm_status_t *obj)
 frees a previously allocated snd_pcm_status_t
void snd_pcm_status_copy (snd_pcm_status_t *dst, const snd_pcm_status_t *src)
 copy one snd_pcm_status_t to another
snd_pcm_state_t snd_pcm_status_get_state (const snd_pcm_status_t *obj)
 Get state from a PCM status container (see snd_pcm_state)
void snd_pcm_status_get_trigger_tstamp (const snd_pcm_status_t *obj, snd_timestamp_t *ptr)
 Get trigger timestamp from a PCM status container.
void snd_pcm_status_get_trigger_htstamp (const snd_pcm_status_t *obj, snd_htimestamp_t *ptr)
 Get trigger hi-res timestamp from a PCM status container.
void snd_pcm_status_get_tstamp (const snd_pcm_status_t *obj, snd_timestamp_t *ptr)
 Get "now" timestamp from a PCM status container.
void snd_pcm_status_get_htstamp (const snd_pcm_status_t *obj, snd_htimestamp_t *ptr)
 Get "now" hi-res timestamp from a PCM status container.
void snd_pcm_status_get_audio_htstamp (const snd_pcm_status_t *obj, snd_htimestamp_t *ptr)
 Get "now" hi-res audio timestamp from a PCM status container.
snd_pcm_sframes_t snd_pcm_status_get_delay (const snd_pcm_status_t *obj)
 Get delay from a PCM status container (see snd_pcm_delay)
snd_pcm_uframes_t snd_pcm_status_get_avail (const snd_pcm_status_t *obj)
 Get number of frames available from a PCM status container (see snd_pcm_avail_update)
snd_pcm_uframes_t snd_pcm_status_get_avail_max (const snd_pcm_status_t *obj)
 Get maximum number of frames available from a PCM status container after last snd_pcm_status call.
snd_pcm_uframes_t snd_pcm_status_get_overrange (const snd_pcm_status_t *obj)
 Get count of ADC overrange detections since last call.
const char * snd_pcm_type_name (snd_pcm_type_t type)
 get name of PCM type
const char * snd_pcm_stream_name (const snd_pcm_stream_t stream)
 get name of PCM stream type
const char * snd_pcm_access_name (const snd_pcm_access_t _access)
 get name of PCM access type
const char * snd_pcm_format_name (const snd_pcm_format_t format)
 get name of PCM sample format
const char * snd_pcm_format_description (const snd_pcm_format_t format)
 get description of PCM sample format
const char * snd_pcm_subformat_name (const snd_pcm_subformat_t subformat)
 get name of PCM sample subformat
const char * snd_pcm_subformat_description (const snd_pcm_subformat_t subformat)
 get description of PCM sample subformat
snd_pcm_format_t snd_pcm_format_value (const char *name)
 get PCM sample format from name
const char * snd_pcm_tstamp_mode_name (const snd_pcm_tstamp_t mode)
 get name of PCM tstamp mode setting
const char * snd_pcm_state_name (const snd_pcm_state_t state)
 get name of PCM state
int snd_pcm_dump (snd_pcm_t *pcm, snd_output_t *out)
 Dump PCM info.
int snd_pcm_dump_hw_setup (snd_pcm_t *pcm, snd_output_t *out)
 Dump current hardware setup for PCM.
int snd_pcm_dump_sw_setup (snd_pcm_t *pcm, snd_output_t *out)
 Dump current software setup for PCM.
int snd_pcm_dump_setup (snd_pcm_t *pcm, snd_output_t *out)
 Dump current setup (hardware and software) for PCM.
int snd_pcm_hw_params_dump (snd_pcm_hw_params_t *params, snd_output_t *out)
 Dump a PCM hardware configuration space.
int snd_pcm_sw_params_dump (snd_pcm_sw_params_t *params, snd_output_t *out)
 Dump a software configuration.
int snd_pcm_status_dump (snd_pcm_status_t *status, snd_output_t *out)
 Dump status.
int snd_pcm_mmap_begin (snd_pcm_t *pcm, const snd_pcm_channel_area_t **areas, snd_pcm_uframes_t *offset, snd_pcm_uframes_t *frames)
 Application request to access a portion of direct (mmap) area.
snd_pcm_sframes_t snd_pcm_mmap_commit (snd_pcm_t *pcm, snd_pcm_uframes_t offset, snd_pcm_uframes_t frames)
 Application has completed the access to area requested with snd_pcm_mmap_begin.
snd_pcm_sframes_t snd_pcm_mmap_writei (snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size)
 Write interleaved frames to a PCM using direct buffer (mmap)
snd_pcm_sframes_t snd_pcm_mmap_readi (snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size)
 Read interleaved frames from a PCM using direct buffer (mmap)
snd_pcm_sframes_t snd_pcm_mmap_writen (snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size)
 Write non interleaved frames to a PCM using direct buffer (mmap)
snd_pcm_sframes_t snd_pcm_mmap_readn (snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size)
 Read non interleaved frames to a PCM using direct buffer (mmap)
int snd_pcm_format_signed (snd_pcm_format_t format)
 Return sign info for a PCM sample linear format.
int snd_pcm_format_unsigned (snd_pcm_format_t format)
 Return sign info for a PCM sample linear format.
int snd_pcm_format_linear (snd_pcm_format_t format)
 Return linear info for a PCM sample format.
int snd_pcm_format_float (snd_pcm_format_t format)
 Return float info for a PCM sample format.
int snd_pcm_format_little_endian (snd_pcm_format_t format)
 Return endian info for a PCM sample format.
int snd_pcm_format_big_endian (snd_pcm_format_t format)
 Return endian info for a PCM sample format.
int snd_pcm_format_cpu_endian (snd_pcm_format_t format)
 Return endian info for a PCM sample format.
int snd_pcm_format_width (snd_pcm_format_t format)
 Return nominal bits per a PCM sample.
int snd_pcm_format_physical_width (snd_pcm_format_t format)
 Return bits needed to store a PCM sample.
snd_pcm_format_t snd_pcm_build_linear_format (int width, int pwidth, int unsignd, int big_endian)
 Compose a PCM sample linear format.
ssize_t snd_pcm_format_size (snd_pcm_format_t format, size_t samples)
 Return bytes needed to store a quantity of PCM sample.
u_int8_t snd_pcm_format_silence (snd_pcm_format_t format)
 Return 8 bit expressing silence for a PCM sample format.
u_int16_t snd_pcm_format_silence_16 (snd_pcm_format_t format)
 Return 16 bit expressing silence for a PCM sample format.
u_int32_t snd_pcm_format_silence_32 (snd_pcm_format_t format)
 Return 32 bit expressing silence for a PCM sample format.
u_int64_t snd_pcm_format_silence_64 (snd_pcm_format_t format)
 Return 64 bit expressing silence for a PCM sample format.
int snd_pcm_format_set_silence (snd_pcm_format_t format, void *buf, unsigned int samples)
 Silence a PCM samples buffer.
snd_pcm_sframes_t snd_pcm_bytes_to_frames (snd_pcm_t *pcm, ssize_t bytes)
 Convert bytes in frames for a PCM.
ssize_t snd_pcm_frames_to_bytes (snd_pcm_t *pcm, snd_pcm_sframes_t frames)
 Convert frames in bytes for a PCM.
long snd_pcm_bytes_to_samples (snd_pcm_t *pcm, ssize_t bytes)
 Convert bytes in samples for a PCM.
ssize_t snd_pcm_samples_to_bytes (snd_pcm_t *pcm, long samples)
 Convert samples in bytes for a PCM.
int snd_pcm_area_silence (const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset, unsigned int samples, snd_pcm_format_t format)
 Silence an area.
int snd_pcm_areas_silence (const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset, unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format)
 Silence one or more areas.
int snd_pcm_area_copy (const snd_pcm_channel_area_t *dst_channel, snd_pcm_uframes_t dst_offset, const snd_pcm_channel_area_t *src_channel, snd_pcm_uframes_t src_offset, unsigned int samples, snd_pcm_format_t format)
 Copy an area.
int snd_pcm_areas_copy (const snd_pcm_channel_area_t *dst_channels, snd_pcm_uframes_t dst_offset, const snd_pcm_channel_area_t *src_channels, snd_pcm_uframes_t src_offset, unsigned int channels, snd_pcm_uframes_t frames, snd_pcm_format_t format)
 Copy one or more areas.
snd_pcm_tsnd_pcm_hook_get_pcm (snd_pcm_hook_t *hook)
 Get PCM handle for a PCM hook.
void * snd_pcm_hook_get_private (snd_pcm_hook_t *hook)
 Get callback function private data for a PCM hook.
void snd_pcm_hook_set_private (snd_pcm_hook_t *hook, void *private_data)
 Set callback function private data for a PCM hook.
int snd_pcm_hook_add (snd_pcm_hook_t **hookp, snd_pcm_t *pcm, snd_pcm_hook_type_t type, snd_pcm_hook_func_t func, void *private_data)
 Add a PCM hook at end of hooks chain.
int snd_pcm_hook_remove (snd_pcm_hook_t *hook)
 Remove a PCM hook.
snd_pcm_uframes_t snd_pcm_meter_get_bufsize (snd_pcm_t *pcm)
 Get meter buffer size from a SND_PCM_TYPE_METER PCM.
unsigned int snd_pcm_meter_get_channels (snd_pcm_t *pcm)
 Get meter channels from a SND_PCM_TYPE_METER PCM.
unsigned int snd_pcm_meter_get_rate (snd_pcm_t *pcm)
 Get meter rate from a SND_PCM_TYPE_METER PCM.
snd_pcm_uframes_t snd_pcm_meter_get_now (snd_pcm_t *pcm)
 Get meter "now" frame pointer from a SND_PCM_TYPE_METER PCM.
snd_pcm_uframes_t snd_pcm_meter_get_boundary (snd_pcm_t *pcm)
 Get boundary for frame pointers from a SND_PCM_TYPE_METER PCM.
int snd_pcm_meter_add_scope (snd_pcm_t *pcm, snd_pcm_scope_t *scope)
 Add a scope to a SND_PCM_TYPE_METER PCM.
snd_pcm_scope_tsnd_pcm_meter_search_scope (snd_pcm_t *pcm, const char *name)
 Search an installed scope inside a SND_PCM_TYPE_METER PCM.
int snd_pcm_scope_malloc (snd_pcm_scope_t **ptr)
 allocate an invalid snd_pcm_scope_t using standard malloc
void snd_pcm_scope_set_ops (snd_pcm_scope_t *scope, const snd_pcm_scope_ops_t *val)
 Set callbacks for a SND_PCM_TYPE_METER PCM scope.
void snd_pcm_scope_set_name (snd_pcm_scope_t *scope, const char *val)
 Set name of a SND_PCM_TYPE_METER PCM scope.
const char * snd_pcm_scope_get_name (snd_pcm_scope_t *scope)
 Get name of a SND_PCM_TYPE_METER PCM scope.
void * snd_pcm_scope_get_callback_private (snd_pcm_scope_t *scope)
 Get callbacks private value for a SND_PCM_TYPE_METER PCM scope.
void snd_pcm_scope_set_callback_private (snd_pcm_scope_t *scope, void *val)
 Get callbacks private value for a SND_PCM_TYPE_METER PCM scope.
int snd_pcm_scope_s16_open (snd_pcm_t *pcm, const char *name, snd_pcm_scope_t **scopep)
 Add a s16 pseudo scope to a SND_PCM_TYPE_METER PCM.
int16_t * snd_pcm_scope_s16_get_channel_buffer (snd_pcm_scope_t *scope, unsigned int channel)
 Get s16 pseudo scope frames buffer for a channel.
int snd_spcm_init (snd_pcm_t *pcm, unsigned int rate, unsigned int channels, snd_pcm_format_t format, snd_pcm_subformat_t subformat, snd_spcm_latency_t latency, snd_pcm_access_t _access, snd_spcm_xrun_type_t xrun_type)
 Set up a simple PCM.
int snd_spcm_init_duplex (snd_pcm_t *playback_pcm, snd_pcm_t *capture_pcm, unsigned int rate, unsigned int channels, snd_pcm_format_t format, snd_pcm_subformat_t subformat, snd_spcm_latency_t latency, snd_pcm_access_t _access, snd_spcm_xrun_type_t xrun_type, snd_spcm_duplex_type_t duplex_type)
 Initialize simple PCMs in the duplex mode.
int snd_spcm_init_get_params (snd_pcm_t *pcm, unsigned int *rate, snd_pcm_uframes_t *buffer_size, snd_pcm_uframes_t *period_size)
 Get the set up of simple PCM.
const char * snd_pcm_start_mode_name (snd_pcm_start_t mode) __attribute__((deprecated))
 (DEPRECATED) get name of PCM start mode setting
const char * snd_pcm_xrun_mode_name (snd_pcm_xrun_t mode) __attribute__((deprecated))
 (DEPRECATED) get name of PCM xrun mode setting
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))
 (DEPRECATED) Set start mode inside a software configuration container
snd_pcm_start_t snd_pcm_sw_params_get_start_mode (const snd_pcm_sw_params_t *params) __attribute__((deprecated))
 (DEPRECATED) Get start mode from a software configuration container
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))
 (DEPRECATED) Set xrun mode inside a software configuration container
snd_pcm_xrun_t snd_pcm_sw_params_get_xrun_mode (const snd_pcm_sw_params_t *params) __attribute__((deprecated))
 (DEPRECATED) Get xrun mode from a software configuration container
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))
 (DEPRECATED) Set xfer align inside a software configuration container
int snd_pcm_sw_params_get_xfer_align (const snd_pcm_sw_params_t *params, snd_pcm_uframes_t *val) __attribute__((deprecated))
 (DEPRECATED) Get xfer align from a software configuration container
int snd_pcm_sw_params_set_sleep_min (snd_pcm_t *pcm, snd_pcm_sw_params_t *params, unsigned int val) __attribute__((deprecated))
 (DEPRECATED) Set minimum number of ticks to sleep inside a software configuration container
int snd_pcm_sw_params_get_sleep_min (const snd_pcm_sw_params_t *params, unsigned int *val) __attribute__((deprecated))
 (DEPRECATED) Get minimum numbers of ticks to sleep from a software configuration container
int snd_pcm_hw_params_get_tick_time (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated))
 (DEPRECATED) Extract tick time from a configuration space
int snd_pcm_hw_params_get_tick_time_min (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated))
 (DEPRECATED) Extract minimum tick time from a configuration space
int snd_pcm_hw_params_get_tick_time_max (const snd_pcm_hw_params_t *params, unsigned int *val, int *dir) __attribute__((deprecated))
 (DEPRECATED) Extract maximum tick time from a configuration space
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))
 (DEPRECATED) Verify if a tick time is available inside a configuration space for a PCM
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))
 (DEPRECATED) Restrict a configuration space to contain only one tick time
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))
 (DEPRECATED) Restrict a configuration space with a minimum tick time
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))
 (DEPRECATED) Restrict a configuration space with a maximum tick time
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))
 (DEPRECATED) Restrict a configuration space to have tick times in a given range
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))
 (DEPRECATED) Restrict a configuration space to have tick time nearest to a target
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))
 (DEPRECATED) Restrict a configuration space to contain only its minimum tick time
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))
 (DEPRECATED) Restrict a configuration space to contain only its maximum tick time

Detailed Description

Application interface library for the ALSA driver.

Author:
Jaroslav Kysela perex.nosp@m.@per.nosp@m.ex.cz
Abramo Bagnara abram.nosp@m.o@al.nosp@m.sa-pr.nosp@m.ojec.nosp@m.t.org
Takashi Iwai tiwai.nosp@m.@sus.nosp@m.e.de
Date:
1998-2001

Application interface library for the ALSA driver. See the PCM (digital audio) interface page for more details.