mirror of
https://github.com/alsa-project/alsa-lib.git
synced 2025-10-29 05:40:25 -04:00
pcm.h - major documentation updates and reordering
Cleanup for __cplusplus defines.
This commit is contained in:
Jaroslav Kysela
parent
5e58abf785
commit
87b5b249a5
14 changed files with 402 additions and 321 deletions
515
include/pcm.h
515
include/pcm.h
|
|
@ -28,6 +28,10 @@
|
|||
#ifndef __ALSA_PCM_H
|
||||
#define __ALSA_PCM_H
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* \defgroup PCM PCM Interface
|
||||
* The PCM Interface.
|
||||
|
|
@ -342,14 +346,13 @@ typedef union _snd_pcm_sync_id {
|
|||
/** #SND_PCM_TYPE_METER scope handle */
|
||||
typedef struct _snd_pcm_scope snd_pcm_scope_t;
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
int snd_pcm_open(snd_pcm_t **pcm, const char *name,
|
||||
snd_pcm_stream_t stream, int mode);
|
||||
|
||||
int snd_pcm_close(snd_pcm_t *pcm);
|
||||
const char *snd_pcm_name(snd_pcm_t *pcm);
|
||||
snd_pcm_type_t snd_pcm_type(snd_pcm_t *pcm);
|
||||
snd_pcm_stream_t snd_pcm_stream(snd_pcm_t *pcm);
|
||||
int snd_pcm_poll_descriptors_count(snd_pcm_t *pcm);
|
||||
int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space);
|
||||
int snd_pcm_nonblock(snd_pcm_t *pcm, int nonblock);
|
||||
|
|
@ -370,26 +373,60 @@ int snd_pcm_pause(snd_pcm_t *pcm, int enable);
|
|||
snd_pcm_state_t snd_pcm_state(snd_pcm_t *pcm);
|
||||
int snd_pcm_delay(snd_pcm_t *pcm, snd_pcm_sframes_t *delayp);
|
||||
int snd_pcm_resume(snd_pcm_t *pcm);
|
||||
snd_pcm_sframes_t snd_pcm_avail_update(snd_pcm_t *pcm);
|
||||
snd_pcm_sframes_t snd_pcm_rewind(snd_pcm_t *pcm, snd_pcm_uframes_t frames);
|
||||
snd_pcm_sframes_t snd_pcm_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size);
|
||||
snd_pcm_sframes_t snd_pcm_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size);
|
||||
snd_pcm_sframes_t snd_pcm_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
|
||||
snd_pcm_sframes_t snd_pcm_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
|
||||
int snd_pcm_wait(snd_pcm_t *pcm, int timeout);
|
||||
|
||||
int snd_pcm_dump_hw_setup(snd_pcm_t *pcm, snd_output_t *out);
|
||||
int snd_pcm_dump_sw_setup(snd_pcm_t *pcm, snd_output_t *out);
|
||||
int snd_pcm_dump_setup(snd_pcm_t *pcm, snd_output_t *out);
|
||||
int snd_pcm_dump(snd_pcm_t *pcm, snd_output_t *out);
|
||||
int snd_pcm_link(snd_pcm_t *pcm1, snd_pcm_t *pcm2);
|
||||
int snd_pcm_unlink(snd_pcm_t *pcm);
|
||||
|
||||
int snd_pcm_wait(snd_pcm_t *pcm, int timeout);
|
||||
snd_pcm_sframes_t snd_pcm_avail_update(snd_pcm_t *pcm);
|
||||
const char *snd_pcm_name(snd_pcm_t *pcm);
|
||||
snd_pcm_type_t snd_pcm_type(snd_pcm_t *pcm);
|
||||
snd_pcm_stream_t snd_pcm_stream(snd_pcm_t *pcm);
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_Info Stream Information
|
||||
* PCM Stream Information
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
size_t snd_pcm_info_sizeof(void);
|
||||
/** \hideinitializer
|
||||
* \brief allocate an invalid #snd_pcm_info_t using standard alloca
|
||||
* \param ptr returned pointer
|
||||
*/
|
||||
#define snd_pcm_info_alloca(ptr) do { assert(ptr); *ptr = (snd_pcm_info_t *) alloca(snd_pcm_info_sizeof()); memset(*ptr, 0, snd_pcm_info_sizeof()); } while (0)
|
||||
int snd_pcm_info_malloc(snd_pcm_info_t **ptr);
|
||||
void snd_pcm_info_free(snd_pcm_info_t *obj);
|
||||
void snd_pcm_info_copy(snd_pcm_info_t *dst, const snd_pcm_info_t *src);
|
||||
unsigned int snd_pcm_info_get_device(const snd_pcm_info_t *obj);
|
||||
unsigned int snd_pcm_info_get_subdevice(const snd_pcm_info_t *obj);
|
||||
snd_pcm_stream_t snd_pcm_info_get_stream(const snd_pcm_info_t *obj);
|
||||
int snd_pcm_info_get_card(const snd_pcm_info_t *obj);
|
||||
const char *snd_pcm_info_get_id(const snd_pcm_info_t *obj);
|
||||
const char *snd_pcm_info_get_name(const snd_pcm_info_t *obj);
|
||||
const char *snd_pcm_info_get_subdevice_name(const snd_pcm_info_t *obj);
|
||||
snd_pcm_class_t snd_pcm_info_get_class(const snd_pcm_info_t *obj);
|
||||
snd_pcm_subclass_t snd_pcm_info_get_subclass(const snd_pcm_info_t *obj);
|
||||
unsigned int snd_pcm_info_get_subdevices_count(const snd_pcm_info_t *obj);
|
||||
unsigned int snd_pcm_info_get_subdevices_avail(const snd_pcm_info_t *obj);
|
||||
snd_pcm_sync_id_t snd_pcm_info_get_sync(const snd_pcm_info_t *obj);
|
||||
void snd_pcm_info_set_device(snd_pcm_info_t *obj, unsigned int val);
|
||||
void snd_pcm_info_set_subdevice(snd_pcm_info_t *obj, unsigned int val);
|
||||
void snd_pcm_info_set_stream(snd_pcm_info_t *obj, snd_pcm_stream_t val);
|
||||
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_HW_Params Hardware Parameters
|
||||
* PCM Hardware Parameters
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
/* HW params */
|
||||
int snd_pcm_hw_params_any(snd_pcm_t *pcm, snd_pcm_hw_params_t *params);
|
||||
|
||||
int snd_pcm_hw_params_can_mmap_sample_resolution(const snd_pcm_hw_params_t *params);
|
||||
|
|
@ -407,7 +444,6 @@ int snd_pcm_hw_params_get_rate_numden(const snd_pcm_hw_params_t *params,
|
|||
unsigned int *rate_den);
|
||||
int snd_pcm_hw_params_get_sbits(const snd_pcm_hw_params_t *params);
|
||||
int snd_pcm_hw_params_get_fifo_size(const snd_pcm_hw_params_t *params);
|
||||
int snd_pcm_hw_params_dump(snd_pcm_hw_params_t *params, snd_output_t *out);
|
||||
|
||||
#if 0
|
||||
typedef struct _snd_pcm_hw_strategy snd_pcm_hw_strategy_t;
|
||||
|
|
@ -435,162 +471,6 @@ int snd_pcm_hw_params_try_explain_failure(snd_pcm_t *pcm,
|
|||
|
||||
#endif
|
||||
|
||||
int snd_pcm_sw_params_current(snd_pcm_t *pcm, snd_pcm_sw_params_t *params);
|
||||
int snd_pcm_sw_params_dump(snd_pcm_sw_params_t *params, snd_output_t *out);
|
||||
|
||||
int snd_pcm_status_dump(snd_pcm_status_t *status, snd_output_t *out);
|
||||
|
||||
/* mmap */
|
||||
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);
|
||||
int snd_pcm_mmap_commit(snd_pcm_t *pcm, snd_pcm_uframes_t offset,
|
||||
snd_pcm_uframes_t frames);
|
||||
snd_pcm_sframes_t snd_pcm_mmap_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size);
|
||||
snd_pcm_sframes_t snd_pcm_mmap_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size);
|
||||
snd_pcm_sframes_t snd_pcm_mmap_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
|
||||
snd_pcm_sframes_t snd_pcm_mmap_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
|
||||
|
||||
const char *snd_pcm_stream_name(snd_pcm_stream_t stream);
|
||||
const char *snd_pcm_access_name(snd_pcm_access_t _access);
|
||||
const char *snd_pcm_format_name(snd_pcm_format_t format);
|
||||
const char *snd_pcm_format_description(snd_pcm_format_t format);
|
||||
const char *snd_pcm_subformat_name(snd_pcm_subformat_t subformat);
|
||||
const char *snd_pcm_subformat_description(snd_pcm_subformat_t subformat);
|
||||
snd_pcm_format_t snd_pcm_format_value(const char* name);
|
||||
const char *snd_pcm_tstamp_mode_name(snd_pcm_tstamp_t mode);
|
||||
const char *snd_pcm_state_name(snd_pcm_state_t state);
|
||||
|
||||
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);
|
||||
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);
|
||||
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);
|
||||
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);
|
||||
|
||||
snd_pcm_sframes_t snd_pcm_bytes_to_frames(snd_pcm_t *pcm, ssize_t bytes);
|
||||
ssize_t snd_pcm_frames_to_bytes(snd_pcm_t *pcm, snd_pcm_sframes_t frames);
|
||||
int snd_pcm_bytes_to_samples(snd_pcm_t *pcm, ssize_t bytes);
|
||||
ssize_t snd_pcm_samples_to_bytes(snd_pcm_t *pcm, int samples);
|
||||
|
||||
/** #SND_PCM_TYPE_METER scope functions */
|
||||
typedef struct _snd_pcm_scope_ops {
|
||||
/** \brief Enable and prepare it using current params
|
||||
* \param scope scope handle
|
||||
*/
|
||||
int (*enable)(snd_pcm_scope_t *scope);
|
||||
/** \brief Disable
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*disable)(snd_pcm_scope_t *scope);
|
||||
/** \brief PCM has been started
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*start)(snd_pcm_scope_t *scope);
|
||||
/** \brief PCM has been stopped
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*stop)(snd_pcm_scope_t *scope);
|
||||
/** \brief New frames are present
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*update)(snd_pcm_scope_t *scope);
|
||||
/** \brief Reset status
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*reset)(snd_pcm_scope_t *scope);
|
||||
/** \brief PCM is closing
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*close)(snd_pcm_scope_t *scope);
|
||||
} snd_pcm_scope_ops_t;
|
||||
|
||||
snd_pcm_uframes_t snd_pcm_meter_get_bufsize(snd_pcm_t *pcm);
|
||||
unsigned int snd_pcm_meter_get_channels(snd_pcm_t *pcm);
|
||||
unsigned int snd_pcm_meter_get_rate(snd_pcm_t *pcm);
|
||||
snd_pcm_uframes_t snd_pcm_meter_get_now(snd_pcm_t *pcm);
|
||||
snd_pcm_uframes_t snd_pcm_meter_get_boundary(snd_pcm_t *pcm);
|
||||
int snd_pcm_meter_add_scope(snd_pcm_t *pcm, snd_pcm_scope_t *scope);
|
||||
snd_pcm_scope_t *snd_pcm_meter_search_scope(snd_pcm_t *pcm, const char *name);
|
||||
int snd_pcm_scope_malloc(snd_pcm_scope_t **ptr);
|
||||
void snd_pcm_scope_set_ops(snd_pcm_scope_t *scope, snd_pcm_scope_ops_t *val);
|
||||
void snd_pcm_scope_set_name(snd_pcm_scope_t *scope, const char *val);
|
||||
const char *snd_pcm_scope_get_name(snd_pcm_scope_t *scope);
|
||||
void *snd_pcm_scope_get_callback_private(snd_pcm_scope_t *scope);
|
||||
void snd_pcm_scope_set_callback_private(snd_pcm_scope_t *scope, void *val);
|
||||
int snd_pcm_scope_s16_open(snd_pcm_t *pcm, const char *name,
|
||||
snd_pcm_scope_t **scopep);
|
||||
int16_t *snd_pcm_scope_s16_get_channel_buffer(snd_pcm_scope_t *scope,
|
||||
unsigned int channel);
|
||||
|
||||
/* misc */
|
||||
|
||||
int snd_pcm_format_signed(snd_pcm_format_t format);
|
||||
int snd_pcm_format_unsigned(snd_pcm_format_t format);
|
||||
int snd_pcm_format_linear(snd_pcm_format_t format);
|
||||
int snd_pcm_format_little_endian(snd_pcm_format_t format);
|
||||
int snd_pcm_format_big_endian(snd_pcm_format_t format);
|
||||
int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
|
||||
int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
|
||||
int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
|
||||
snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
|
||||
ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
|
||||
u_int8_t snd_pcm_format_silence(snd_pcm_format_t format);
|
||||
u_int16_t snd_pcm_format_silence_16(snd_pcm_format_t format);
|
||||
u_int32_t snd_pcm_format_silence_32(snd_pcm_format_t format);
|
||||
u_int64_t snd_pcm_format_silence_64(snd_pcm_format_t format);
|
||||
int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int samples);
|
||||
|
||||
size_t snd_pcm_access_mask_sizeof(void);
|
||||
/** \hideinitializer
|
||||
* \brief allocate an empty #snd_pcm_access_mask_t using standard alloca
|
||||
* \param ptr returned pointer
|
||||
*/
|
||||
#define snd_pcm_access_mask_alloca(ptr) do { assert(ptr); *ptr = (snd_pcm_access_mask_t *) alloca(snd_pcm_access_mask_sizeof()); memset(*ptr, 0, snd_pcm_access_mask_sizeof()); } while (0)
|
||||
int snd_pcm_access_mask_malloc(snd_pcm_access_mask_t **ptr);
|
||||
void snd_pcm_access_mask_free(snd_pcm_access_mask_t *obj);
|
||||
void snd_pcm_access_mask_copy(snd_pcm_access_mask_t *dst, const snd_pcm_access_mask_t *src);
|
||||
void snd_pcm_access_mask_none(snd_pcm_access_mask_t *mask);
|
||||
void snd_pcm_access_mask_any(snd_pcm_access_mask_t *mask);
|
||||
int snd_pcm_access_mask_test(const snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
|
||||
void snd_pcm_access_mask_set(snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
|
||||
void snd_pcm_access_mask_reset(snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
|
||||
|
||||
size_t snd_pcm_format_mask_sizeof(void);
|
||||
/** \hideinitializer
|
||||
* \brief allocate an empty #snd_pcm_format_mask_t using standard alloca
|
||||
* \param ptr returned pointer
|
||||
*/
|
||||
#define snd_pcm_format_mask_alloca(ptr) do { assert(ptr); *ptr = (snd_pcm_format_mask_t *) alloca(snd_pcm_format_mask_sizeof()); memset(*ptr, 0, snd_pcm_format_mask_sizeof()); } while (0)
|
||||
int snd_pcm_format_mask_malloc(snd_pcm_format_mask_t **ptr);
|
||||
void snd_pcm_format_mask_free(snd_pcm_format_mask_t *obj);
|
||||
void snd_pcm_format_mask_copy(snd_pcm_format_mask_t *dst, const snd_pcm_format_mask_t *src);
|
||||
void snd_pcm_format_mask_none(snd_pcm_format_mask_t *mask);
|
||||
void snd_pcm_format_mask_any(snd_pcm_format_mask_t *mask);
|
||||
int snd_pcm_format_mask_test(const snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
|
||||
void snd_pcm_format_mask_set(snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
|
||||
void snd_pcm_format_mask_reset(snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
|
||||
|
||||
size_t snd_pcm_subformat_mask_sizeof(void);
|
||||
/** \hideinitializer
|
||||
* \brief allocate an empty #snd_pcm_subformat_mask_t using standard alloca
|
||||
* \param ptr returned pointer
|
||||
*/
|
||||
#define snd_pcm_subformat_mask_alloca(ptr) do { assert(ptr); *ptr = (snd_pcm_subformat_mask_t *) alloca(snd_pcm_subformat_mask_sizeof()); memset(*ptr, 0, snd_pcm_subformat_mask_sizeof()); } while (0)
|
||||
int snd_pcm_subformat_mask_malloc(snd_pcm_subformat_mask_t **ptr);
|
||||
void snd_pcm_subformat_mask_free(snd_pcm_subformat_mask_t *obj);
|
||||
void snd_pcm_subformat_mask_copy(snd_pcm_subformat_mask_t *dst, const snd_pcm_subformat_mask_t *src);
|
||||
void snd_pcm_subformat_mask_none(snd_pcm_subformat_mask_t *mask);
|
||||
void snd_pcm_subformat_mask_any(snd_pcm_subformat_mask_t *mask);
|
||||
int snd_pcm_subformat_mask_test(const snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
|
||||
void snd_pcm_subformat_mask_set(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
|
||||
void snd_pcm_subformat_mask_reset(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
|
||||
|
||||
size_t snd_pcm_hw_params_sizeof(void);
|
||||
/** \hideinitializer
|
||||
* \brief allocate an invalid #snd_pcm_hw_params_t using standard alloca
|
||||
|
|
@ -712,6 +592,17 @@ unsigned int snd_pcm_hw_params_set_tick_time_near(snd_pcm_t *pcm, snd_pcm_hw_par
|
|||
unsigned int snd_pcm_hw_params_set_tick_time_first(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
|
||||
unsigned int snd_pcm_hw_params_set_tick_time_last(snd_pcm_t *pcm, snd_pcm_hw_params_t *params, int *dir);
|
||||
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_SW_Params Software Parameters
|
||||
* PCM Software Parameters
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
int snd_pcm_sw_params_current(snd_pcm_t *pcm, snd_pcm_sw_params_t *params);
|
||||
|
||||
size_t snd_pcm_sw_params_sizeof(void);
|
||||
/** \hideinitializer
|
||||
* \brief allocate an invalid #snd_pcm_sw_params_t using standard alloca
|
||||
|
|
@ -742,6 +633,87 @@ snd_pcm_uframes_t snd_pcm_sw_params_get_silence_threshold(const snd_pcm_sw_param
|
|||
int snd_pcm_sw_params_set_silence_size(snd_pcm_t *pcm, snd_pcm_sw_params_t *params, snd_pcm_uframes_t val);
|
||||
snd_pcm_uframes_t snd_pcm_sw_params_get_silence_size(const snd_pcm_sw_params_t *params);
|
||||
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_Access Access Mask Functions
|
||||
* PCM Access Mask Functions
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
size_t snd_pcm_access_mask_sizeof(void);
|
||||
/** \hideinitializer
|
||||
* \brief allocate an empty #snd_pcm_access_mask_t using standard alloca
|
||||
* \param ptr returned pointer
|
||||
*/
|
||||
#define snd_pcm_access_mask_alloca(ptr) do { assert(ptr); *ptr = (snd_pcm_access_mask_t *) alloca(snd_pcm_access_mask_sizeof()); memset(*ptr, 0, snd_pcm_access_mask_sizeof()); } while (0)
|
||||
int snd_pcm_access_mask_malloc(snd_pcm_access_mask_t **ptr);
|
||||
void snd_pcm_access_mask_free(snd_pcm_access_mask_t *obj);
|
||||
void snd_pcm_access_mask_copy(snd_pcm_access_mask_t *dst, const snd_pcm_access_mask_t *src);
|
||||
void snd_pcm_access_mask_none(snd_pcm_access_mask_t *mask);
|
||||
void snd_pcm_access_mask_any(snd_pcm_access_mask_t *mask);
|
||||
int snd_pcm_access_mask_test(const snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
|
||||
void snd_pcm_access_mask_set(snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
|
||||
void snd_pcm_access_mask_reset(snd_pcm_access_mask_t *mask, snd_pcm_access_t val);
|
||||
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_Format Format Mask Functions
|
||||
* PCM Format Mask Functions
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
size_t snd_pcm_format_mask_sizeof(void);
|
||||
/** \hideinitializer
|
||||
* \brief allocate an empty #snd_pcm_format_mask_t using standard alloca
|
||||
* \param ptr returned pointer
|
||||
*/
|
||||
#define snd_pcm_format_mask_alloca(ptr) do { assert(ptr); *ptr = (snd_pcm_format_mask_t *) alloca(snd_pcm_format_mask_sizeof()); memset(*ptr, 0, snd_pcm_format_mask_sizeof()); } while (0)
|
||||
int snd_pcm_format_mask_malloc(snd_pcm_format_mask_t **ptr);
|
||||
void snd_pcm_format_mask_free(snd_pcm_format_mask_t *obj);
|
||||
void snd_pcm_format_mask_copy(snd_pcm_format_mask_t *dst, const snd_pcm_format_mask_t *src);
|
||||
void snd_pcm_format_mask_none(snd_pcm_format_mask_t *mask);
|
||||
void snd_pcm_format_mask_any(snd_pcm_format_mask_t *mask);
|
||||
int snd_pcm_format_mask_test(const snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
|
||||
void snd_pcm_format_mask_set(snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
|
||||
void snd_pcm_format_mask_reset(snd_pcm_format_mask_t *mask, snd_pcm_format_t val);
|
||||
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_SubFormat Subformat Mask Functions
|
||||
* PCM Subformat Mask Functions
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
size_t snd_pcm_subformat_mask_sizeof(void);
|
||||
/** \hideinitializer
|
||||
* \brief allocate an empty #snd_pcm_subformat_mask_t using standard alloca
|
||||
* \param ptr returned pointer
|
||||
*/
|
||||
#define snd_pcm_subformat_mask_alloca(ptr) do { assert(ptr); *ptr = (snd_pcm_subformat_mask_t *) alloca(snd_pcm_subformat_mask_sizeof()); memset(*ptr, 0, snd_pcm_subformat_mask_sizeof()); } while (0)
|
||||
int snd_pcm_subformat_mask_malloc(snd_pcm_subformat_mask_t **ptr);
|
||||
void snd_pcm_subformat_mask_free(snd_pcm_subformat_mask_t *obj);
|
||||
void snd_pcm_subformat_mask_copy(snd_pcm_subformat_mask_t *dst, const snd_pcm_subformat_mask_t *src);
|
||||
void snd_pcm_subformat_mask_none(snd_pcm_subformat_mask_t *mask);
|
||||
void snd_pcm_subformat_mask_any(snd_pcm_subformat_mask_t *mask);
|
||||
int snd_pcm_subformat_mask_test(const snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
|
||||
void snd_pcm_subformat_mask_set(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
|
||||
void snd_pcm_subformat_mask_reset(snd_pcm_subformat_mask_t *mask, snd_pcm_subformat_t val);
|
||||
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_Status Status Functions
|
||||
* PCM Status Functions
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
size_t snd_pcm_status_sizeof(void);
|
||||
/** \hideinitializer
|
||||
* \brief allocate an invalid #snd_pcm_status_t using standard alloca
|
||||
|
|
@ -759,30 +731,111 @@ snd_pcm_uframes_t snd_pcm_status_get_avail(const snd_pcm_status_t *obj);
|
|||
snd_pcm_uframes_t snd_pcm_status_get_avail_max(const snd_pcm_status_t *obj);
|
||||
snd_pcm_uframes_t snd_pcm_status_get_overrange(const snd_pcm_status_t *obj);
|
||||
|
||||
size_t snd_pcm_info_sizeof(void);
|
||||
/** \hideinitializer
|
||||
* \brief allocate an invalid #snd_pcm_info_t using standard alloca
|
||||
* \param ptr returned pointer
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_Description Description Functions
|
||||
* PCM Description Functions
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
const char *snd_pcm_stream_name(const snd_pcm_stream_t stream);
|
||||
const char *snd_pcm_access_name(const snd_pcm_access_t _access);
|
||||
const char *snd_pcm_format_name(const snd_pcm_format_t format);
|
||||
const char *snd_pcm_format_description(const snd_pcm_format_t format);
|
||||
const char *snd_pcm_subformat_name(const snd_pcm_subformat_t subformat);
|
||||
const char *snd_pcm_subformat_description(const snd_pcm_subformat_t subformat);
|
||||
snd_pcm_format_t snd_pcm_format_value(const char* name);
|
||||
const char *snd_pcm_tstamp_mode_name(const snd_pcm_tstamp_t mode);
|
||||
const char *snd_pcm_state_name(const snd_pcm_state_t state);
|
||||
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_Dump Debug Functions
|
||||
* PCM Debug Functions
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
int snd_pcm_dump(snd_pcm_t *pcm, snd_output_t *out);
|
||||
int snd_pcm_dump_hw_setup(snd_pcm_t *pcm, snd_output_t *out);
|
||||
int snd_pcm_dump_sw_setup(snd_pcm_t *pcm, snd_output_t *out);
|
||||
int snd_pcm_dump_setup(snd_pcm_t *pcm, snd_output_t *out);
|
||||
int snd_pcm_hw_params_dump(snd_pcm_hw_params_t *params, snd_output_t *out);
|
||||
int snd_pcm_sw_params_dump(snd_pcm_sw_params_t *params, snd_output_t *out);
|
||||
int snd_pcm_status_dump(snd_pcm_status_t *status, snd_output_t *out);
|
||||
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_Direct Direct Access (MMAP) Functions
|
||||
* PCM Direct Access (MMAP) Functions
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
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);
|
||||
int snd_pcm_mmap_commit(snd_pcm_t *pcm, snd_pcm_uframes_t offset,
|
||||
snd_pcm_uframes_t frames);
|
||||
snd_pcm_sframes_t snd_pcm_mmap_writei(snd_pcm_t *pcm, const void *buffer, snd_pcm_uframes_t size);
|
||||
snd_pcm_sframes_t snd_pcm_mmap_readi(snd_pcm_t *pcm, void *buffer, snd_pcm_uframes_t size);
|
||||
snd_pcm_sframes_t snd_pcm_mmap_writen(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
|
||||
snd_pcm_sframes_t snd_pcm_mmap_readn(snd_pcm_t *pcm, void **bufs, snd_pcm_uframes_t size);
|
||||
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_Helpers Helper Functions
|
||||
* PCM Helper Functions
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
int snd_pcm_format_signed(snd_pcm_format_t format);
|
||||
int snd_pcm_format_unsigned(snd_pcm_format_t format);
|
||||
int snd_pcm_format_linear(snd_pcm_format_t format);
|
||||
int snd_pcm_format_little_endian(snd_pcm_format_t format);
|
||||
int snd_pcm_format_big_endian(snd_pcm_format_t format);
|
||||
int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
|
||||
int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
|
||||
int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
|
||||
snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
|
||||
ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
|
||||
u_int8_t snd_pcm_format_silence(snd_pcm_format_t format);
|
||||
u_int16_t snd_pcm_format_silence_16(snd_pcm_format_t format);
|
||||
u_int32_t snd_pcm_format_silence_32(snd_pcm_format_t format);
|
||||
u_int64_t snd_pcm_format_silence_64(snd_pcm_format_t format);
|
||||
int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int samples);
|
||||
|
||||
snd_pcm_sframes_t snd_pcm_bytes_to_frames(snd_pcm_t *pcm, ssize_t bytes);
|
||||
ssize_t snd_pcm_frames_to_bytes(snd_pcm_t *pcm, snd_pcm_sframes_t frames);
|
||||
int snd_pcm_bytes_to_samples(snd_pcm_t *pcm, ssize_t bytes);
|
||||
ssize_t snd_pcm_samples_to_bytes(snd_pcm_t *pcm, int samples);
|
||||
|
||||
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);
|
||||
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);
|
||||
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);
|
||||
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);
|
||||
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_Hook Hook Extension
|
||||
* PCM Hook Extension
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
#define snd_pcm_info_alloca(ptr) do { assert(ptr); *ptr = (snd_pcm_info_t *) alloca(snd_pcm_info_sizeof()); memset(*ptr, 0, snd_pcm_info_sizeof()); } while (0)
|
||||
int snd_pcm_info_malloc(snd_pcm_info_t **ptr);
|
||||
void snd_pcm_info_free(snd_pcm_info_t *obj);
|
||||
void snd_pcm_info_copy(snd_pcm_info_t *dst, const snd_pcm_info_t *src);
|
||||
unsigned int snd_pcm_info_get_device(const snd_pcm_info_t *obj);
|
||||
unsigned int snd_pcm_info_get_subdevice(const snd_pcm_info_t *obj);
|
||||
snd_pcm_stream_t snd_pcm_info_get_stream(const snd_pcm_info_t *obj);
|
||||
int snd_pcm_info_get_card(const snd_pcm_info_t *obj);
|
||||
const char *snd_pcm_info_get_id(const snd_pcm_info_t *obj);
|
||||
const char *snd_pcm_info_get_name(const snd_pcm_info_t *obj);
|
||||
const char *snd_pcm_info_get_subdevice_name(const snd_pcm_info_t *obj);
|
||||
snd_pcm_class_t snd_pcm_info_get_class(const snd_pcm_info_t *obj);
|
||||
snd_pcm_subclass_t snd_pcm_info_get_subclass(const snd_pcm_info_t *obj);
|
||||
unsigned int snd_pcm_info_get_subdevices_count(const snd_pcm_info_t *obj);
|
||||
unsigned int snd_pcm_info_get_subdevices_avail(const snd_pcm_info_t *obj);
|
||||
snd_pcm_sync_id_t snd_pcm_info_get_sync(const snd_pcm_info_t *obj);
|
||||
void snd_pcm_info_set_device(snd_pcm_info_t *obj, unsigned int val);
|
||||
void snd_pcm_info_set_subdevice(snd_pcm_info_t *obj, unsigned int val);
|
||||
void snd_pcm_info_set_stream(snd_pcm_info_t *obj, snd_pcm_stream_t val);
|
||||
|
||||
/** type of pcm hook */
|
||||
typedef enum _snd_pcm_hook_type {
|
||||
|
|
@ -804,9 +857,73 @@ int snd_pcm_hook_add(snd_pcm_hook_t **hookp, snd_pcm_t *pcm,
|
|||
snd_pcm_hook_func_t func, void *private_data);
|
||||
int snd_pcm_hook_remove(snd_pcm_hook_t *hook);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_Scope Scope Plugin Extension
|
||||
* PCM Scope Plugin Extension
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
/** #SND_PCM_TYPE_METER scope functions */
|
||||
typedef struct _snd_pcm_scope_ops {
|
||||
/** \brief Enable and prepare it using current params
|
||||
* \param scope scope handle
|
||||
*/
|
||||
int (*enable)(snd_pcm_scope_t *scope);
|
||||
/** \brief Disable
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*disable)(snd_pcm_scope_t *scope);
|
||||
/** \brief PCM has been started
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*start)(snd_pcm_scope_t *scope);
|
||||
/** \brief PCM has been stopped
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*stop)(snd_pcm_scope_t *scope);
|
||||
/** \brief New frames are present
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*update)(snd_pcm_scope_t *scope);
|
||||
/** \brief Reset status
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*reset)(snd_pcm_scope_t *scope);
|
||||
/** \brief PCM is closing
|
||||
* \param scope scope handle
|
||||
*/
|
||||
void (*close)(snd_pcm_scope_t *scope);
|
||||
} snd_pcm_scope_ops_t;
|
||||
|
||||
snd_pcm_uframes_t snd_pcm_meter_get_bufsize(snd_pcm_t *pcm);
|
||||
unsigned int snd_pcm_meter_get_channels(snd_pcm_t *pcm);
|
||||
unsigned int snd_pcm_meter_get_rate(snd_pcm_t *pcm);
|
||||
snd_pcm_uframes_t snd_pcm_meter_get_now(snd_pcm_t *pcm);
|
||||
snd_pcm_uframes_t snd_pcm_meter_get_boundary(snd_pcm_t *pcm);
|
||||
int snd_pcm_meter_add_scope(snd_pcm_t *pcm, snd_pcm_scope_t *scope);
|
||||
snd_pcm_scope_t *snd_pcm_meter_search_scope(snd_pcm_t *pcm, const char *name);
|
||||
int snd_pcm_scope_malloc(snd_pcm_scope_t **ptr);
|
||||
void snd_pcm_scope_set_ops(snd_pcm_scope_t *scope, snd_pcm_scope_ops_t *val);
|
||||
void snd_pcm_scope_set_name(snd_pcm_scope_t *scope, const char *val);
|
||||
const char *snd_pcm_scope_get_name(snd_pcm_scope_t *scope);
|
||||
void *snd_pcm_scope_get_callback_private(snd_pcm_scope_t *scope);
|
||||
void snd_pcm_scope_set_callback_private(snd_pcm_scope_t *scope, void *val);
|
||||
int snd_pcm_scope_s16_open(snd_pcm_t *pcm, const char *name,
|
||||
snd_pcm_scope_t **scopep);
|
||||
int16_t *snd_pcm_scope_s16_get_channel_buffer(snd_pcm_scope_t *scope,
|
||||
unsigned int channel);
|
||||
|
||||
/** \} */
|
||||
|
||||
/**
|
||||
* \defgroup PCM_Deprecated Deprecated Functions
|
||||
* PCM Deprecated Functions
|
||||
* \ingroup PCM
|
||||
* \{
|
||||
*/
|
||||
|
||||
/* Deprecated functions, for compatibity */
|
||||
const char *snd_pcm_start_mode_name(snd_pcm_start_t mode);
|
||||
|
|
@ -818,5 +935,9 @@ snd_pcm_xrun_t snd_pcm_sw_params_get_xrun_mode(const snd_pcm_sw_params_t *params
|
|||
|
||||
/** \} */
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* __ALSA_PCM_H */
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue