Data Structures |
struct | snd_pcm_channel_area_t |
union | snd_pcm_sync_id_t |
Modules |
| Stream Information |
| Hardware Parameters |
| Software Parameters |
| Access Mask Functions |
| Format Mask Functions |
| Subformat Mask Functions |
| Status Functions |
| Description Functions |
| Debug Functions |
| Direct Access (MMAP) Functions |
| Helper Functions |
| Hook Extension |
| Scope Plugin Extension |
| Simple setup functions |
| Deprecated Functions |
Files |
file | pcm.c |
| PCM Interface.
|
file | pcm_plugin.c |
| PCM Interface.
|
Defines |
#define | SND_PCM_DLSYM_VERSION _dlsym_pcm_001 |
#define | SND_PCM_NONBLOCK |
#define | SND_PCM_ASYNC |
#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 |
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 |
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_LAST = SND_PCM_FORMAT_U18_3BE,
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
} |
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_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_t * | snd_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.
|
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.
|