pcm_extplug.h
Go to the documentation of this file.
/*
* ALSA external PCM plugin SDK (draft version)
*
* Copyright (c) 2005 Takashi Iwai <tiwai@suse.de>
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef __ALSA_PCM_EXTPLUG_H
#define __ALSA_PCM_EXTPLUG_H
enum {
SND_PCM_EXTPLUG_HW_FORMAT,
SND_PCM_EXTPLUG_HW_CHANNELS,
SND_PCM_EXTPLUG_HW_PARAMS
};
typedef struct snd_pcm_extplug snd_pcm_extplug_t;
typedef struct snd_pcm_extplug_callback snd_pcm_extplug_callback_t;
#ifdef DOC_HIDDEN
/* redefine typedefs for stupid doxygen */
typedef snd_pcm_extplug snd_pcm_extplug_t;
typedef snd_pcm_extplug_callback snd_pcm_extplug_callback_t;
#endif
/*
* Protocol version
*/
#define SND_PCM_EXTPLUG_VERSION_MAJOR 1
#define SND_PCM_EXTPLUG_VERSION_MINOR 0
#define SND_PCM_EXTPLUG_VERSION_TINY 2
#define SND_PCM_EXTPLUG_VERSION ((SND_PCM_EXTPLUG_VERSION_MAJOR<<16) |\
(SND_PCM_EXTPLUG_VERSION_MINOR<<8) |\
(SND_PCM_EXTPLUG_VERSION_TINY))
struct snd_pcm_extplug {
unsigned int version;
const char *name;
const snd_pcm_extplug_callback_t *callback;
void *private_data;
snd_pcm_t *pcm;
snd_pcm_stream_t stream;
snd_pcm_format_t format;
snd_pcm_subformat_t subformat;
unsigned int channels;
unsigned int rate;
snd_pcm_format_t slave_format;
snd_pcm_subformat_t slave_subformat;
unsigned int slave_channels;
};
struct snd_pcm_extplug_callback {
snd_pcm_sframes_t (*transfer)(snd_pcm_extplug_t *ext,
const snd_pcm_channel_area_t *dst_areas,
snd_pcm_uframes_t dst_offset,
const snd_pcm_channel_area_t *src_areas,
snd_pcm_uframes_t src_offset,
snd_pcm_uframes_t size);
int (*close)(snd_pcm_extplug_t *ext);
int (*hw_params)(snd_pcm_extplug_t *ext, snd_pcm_hw_params_t *params);
int (*hw_free)(snd_pcm_extplug_t *ext);
void (*dump)(snd_pcm_extplug_t *ext, snd_output_t *out);
int (*init)(snd_pcm_extplug_t *ext);
snd_pcm_chmap_query_t **(*query_chmaps)(snd_pcm_extplug_t *ext);
snd_pcm_chmap_t *(*get_chmap)(snd_pcm_extplug_t *ext);
int (*set_chmap)(snd_pcm_extplug_t *ext, const snd_pcm_chmap_t *map);
};
int snd_pcm_extplug_create(snd_pcm_extplug_t *ext, const char *name,
snd_config_t *root, snd_config_t *slave_conf,
snd_pcm_stream_t stream, int mode);
int snd_pcm_extplug_delete(snd_pcm_extplug_t *ext);
/* clear hw_parameter setting */
void snd_pcm_extplug_params_reset(snd_pcm_extplug_t *ext);
/* hw_parameter setting */
int snd_pcm_extplug_set_param_list(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list);
int snd_pcm_extplug_set_param_minmax(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max);
int snd_pcm_extplug_set_slave_param_list(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list);
int snd_pcm_extplug_set_slave_param_minmax(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max);
int snd_pcm_extplug_set_param_link(snd_pcm_extplug_t *extplug, int type,
int keep_link);
static __inline__ int snd_pcm_extplug_set_param(snd_pcm_extplug_t *extplug, int type, unsigned int val)
{
return snd_pcm_extplug_set_param_list(extplug, type, 1, &val);
}
static __inline__ int snd_pcm_extplug_set_slave_param(snd_pcm_extplug_t *extplug, int type, unsigned int val)
{
return snd_pcm_extplug_set_slave_param_list(extplug, type, 1, &val);
}
#endif /* __ALSA_PCM_EXTPLUG_H */
snd_pcm_channel_area_t
Definition: pcm.h:468
snd_pcm_extplug_callback::hw_free
int(* hw_free)(snd_pcm_extplug_t *ext)
Definition: pcm_extplug.h:150
snd_pcm_extplug_set_param_list
int snd_pcm_extplug_set_param_list(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list)
Set master parameter as the list.
Definition: pcm_extplug.c:828
snd_pcm_format_t
snd_pcm_format_t
Definition: pcm.h:125
snd_pcm_sframes_t
long snd_pcm_sframes_t
Definition: pcm.h:376
snd_pcm_extplug_params_reset
void snd_pcm_extplug_params_reset(snd_pcm_extplug_t *ext)
Reset extplug parameters.
Definition: pcm_extplug.c:762
snd_pcm_extplug_callback::set_chmap
int(* set_chmap)(snd_pcm_extplug_t *ext, const snd_pcm_chmap_t *map)
Definition: pcm_extplug.h:170
snd_pcm_extplug_callback_t
snd_pcm_extplug_callback snd_pcm_extplug_callback_t
Definition: pcm_extplug.h:55
snd_pcm_extplug::format
snd_pcm_format_t format
Definition: pcm_extplug.h:101
snd_pcm_t
struct _snd_pcm snd_pcm_t
Definition: pcm.h:394
snd_pcm_extplug_callback::dump
void(* dump)(snd_pcm_extplug_t *ext, snd_output_t *out)
Definition: pcm_extplug.h:154
snd_pcm_chmap_query_t
Definition: pcm.h:614
SND_PCM_EXTPLUG_HW_FORMAT
@ SND_PCM_EXTPLUG_HW_FORMAT
Definition: pcm_extplug.h:43
snd_pcm_extplug::slave_channels
unsigned int slave_channels
Definition: pcm_extplug.h:125
snd_pcm_extplug::stream
snd_pcm_stream_t stream
Definition: pcm_extplug.h:97
snd_pcm_extplug::subformat
snd_pcm_subformat_t subformat
Definition: pcm_extplug.h:105
snd_pcm_extplug_set_slave_param_list
int snd_pcm_extplug_set_slave_param_list(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list)
Set slave parameter as the list.
Definition: pcm_extplug.c:780
snd_pcm_extplug_create
int snd_pcm_extplug_create(snd_pcm_extplug_t *ext, const char *name, snd_config_t *root, snd_config_t *slave_conf, snd_pcm_stream_t stream, int mode)
Create an extplug instance.
Definition: pcm_extplug.c:676
snd_pcm_extplug::slave_format
snd_pcm_format_t slave_format
Definition: pcm_extplug.h:117
SND_PCM_EXTPLUG_HW_CHANNELS
@ SND_PCM_EXTPLUG_HW_CHANNELS
Definition: pcm_extplug.h:44
snd_config_t
struct _snd_config snd_config_t
Internal structure for a configuration node object.
Definition: conf.h:69
snd_output_t
struct _snd_output snd_output_t
Internal structure for an output object.
Definition: output.h:54
snd_pcm_extplug::callback
const snd_pcm_extplug_callback_t * callback
Definition: pcm_extplug.h:85
snd_pcm_hw_params_t
struct _snd_pcm_hw_params snd_pcm_hw_params_t
Definition: pcm.h:64
snd_pcm_extplug_callback::transfer
snd_pcm_sframes_t(* transfer)(snd_pcm_extplug_t *ext, const snd_pcm_channel_area_t *dst_areas, snd_pcm_uframes_t dst_offset, const snd_pcm_channel_area_t *src_areas, snd_pcm_uframes_t src_offset, snd_pcm_uframes_t size)
Definition: pcm_extplug.h:133
snd_pcm_uframes_t
unsigned long snd_pcm_uframes_t
Definition: pcm.h:374
snd_pcm_extplug_set_param_link
int snd_pcm_extplug_set_param_link(snd_pcm_extplug_t *extplug, int type, int keep_link)
Keep the client and slave format/channels the same if requested. This is for example useful if this e...
Definition: pcm_extplug.c:874
snd_pcm_extplug::name
const char * name
Definition: pcm_extplug.h:81
snd_pcm_extplug_callback::close
int(* close)(snd_pcm_extplug_t *ext)
Definition: pcm_extplug.h:142
snd_pcm_extplug::channels
unsigned int channels
Definition: pcm_extplug.h:109
snd_pcm_extplug_callback::hw_params
int(* hw_params)(snd_pcm_extplug_t *ext, snd_pcm_hw_params_t *params)
Definition: pcm_extplug.h:146
snd_pcm_extplug::private_data
void * private_data
Definition: pcm_extplug.h:89
snd_pcm_extplug::rate
unsigned int rate
Definition: pcm_extplug.h:113
snd_pcm_extplug_set_slave_param_minmax
int snd_pcm_extplug_set_slave_param_minmax(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max)
Set slave parameter as the min/max values.
Definition: pcm_extplug.c:802
snd_pcm_extplug_callback
Definition: pcm_extplug.h:129
snd_pcm_extplug::version
unsigned int version
Definition: pcm_extplug.h:77
snd_pcm_extplug::slave_subformat
snd_pcm_subformat_t slave_subformat
Definition: pcm_extplug.h:121
snd_pcm_extplug_t
snd_pcm_extplug snd_pcm_extplug_t
Definition: pcm_extplug.h:54
snd_pcm_extplug_callback::init
int(* init)(snd_pcm_extplug_t *ext)
Definition: pcm_extplug.h:158
snd_pcm_subformat_t
snd_pcm_subformat_t
Definition: pcm.h:284
snd_pcm_extplug
Definition: pcm_extplug.h:72
snd_pcm_chmap_t
Definition: pcm.h:608
snd_pcm_extplug_delete
int snd_pcm_extplug_delete(snd_pcm_extplug_t *ext)
Delete the extplug instance.
Definition: pcm_extplug.c:750
snd_pcm_stream_t
snd_pcm_stream_t
Definition: pcm.h:101
snd_pcm_extplug_set_param_minmax
int snd_pcm_extplug_set_param_minmax(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max)
Set master parameter as the min/max values.
Definition: pcm_extplug.c:850
SND_PCM_EXTPLUG_HW_PARAMS
@ SND_PCM_EXTPLUG_HW_PARAMS
Definition: pcm_extplug.h:45
snd_pcm_extplug::pcm
snd_pcm_t * pcm
Definition: pcm_extplug.h:93