ALSA project - the C library reference
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
pcm_extplug.h
Go to the documentation of this file.
1 
10 /*
11  * ALSA external PCM plugin SDK (draft version)
12  *
13  * Copyright (c) 2005 Takashi Iwai <tiwai@suse.de>
14  *
15  * This library is free software; you can redistribute it and/or modify
16  * it under the terms of the GNU Lesser General Public License as
17  * published by the Free Software Foundation; either version 2.1 of
18  * the License, or (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23  * GNU Lesser General Public License for more details.
24  *
25  * You should have received a copy of the GNU Lesser General Public
26  * License along with this library; if not, write to the Free Software
27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28  *
29  */
30 
31 #ifndef __ALSA_PCM_EXTPLUG_H
32 #define __ALSA_PCM_EXTPLUG_H
33 
42 enum {
46 };
47 
49 typedef struct snd_pcm_extplug snd_pcm_extplug_t;
52 #ifdef DOC_HIDDEN
53 /* redefine typedefs for stupid doxygen */
56 #endif
57 
58 /*
59  * Protocol version
60  */
61 #define SND_PCM_EXTPLUG_VERSION_MAJOR 1
62 #define SND_PCM_EXTPLUG_VERSION_MINOR 0
63 #define SND_PCM_EXTPLUG_VERSION_TINY 2
67 #define SND_PCM_EXTPLUG_VERSION ((SND_PCM_EXTPLUG_VERSION_MAJOR<<16) |\
68  (SND_PCM_EXTPLUG_VERSION_MINOR<<8) |\
69  (SND_PCM_EXTPLUG_VERSION_TINY))
70 
77  unsigned int version;
81  const char *name;
89  void *private_data;
109  unsigned int channels;
113  unsigned int rate;
125  unsigned int slave_channels;
126 };
127 
134  const snd_pcm_channel_area_t *dst_areas,
135  snd_pcm_uframes_t dst_offset,
136  const snd_pcm_channel_area_t *src_areas,
137  snd_pcm_uframes_t src_offset,
138  snd_pcm_uframes_t size);
142  int (*close)(snd_pcm_extplug_t *ext);
154  void (*dump)(snd_pcm_extplug_t *ext, snd_output_t *out);
158  int (*init)(snd_pcm_extplug_t *ext);
162  snd_pcm_chmap_query_t **(*query_chmaps)(snd_pcm_extplug_t *ext);
166  snd_pcm_chmap_t *(*get_chmap)(snd_pcm_extplug_t *ext);
170  int (*set_chmap)(snd_pcm_extplug_t *ext, const snd_pcm_chmap_t *map);
171 };
172 
173 
174 int snd_pcm_extplug_create(snd_pcm_extplug_t *ext, const char *name,
175  snd_config_t *root, snd_config_t *slave_conf,
176  snd_pcm_stream_t stream, int mode);
178 
179 /* clear hw_parameter setting */
181 
182 /* hw_parameter setting */
183 int snd_pcm_extplug_set_param_list(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list);
184 int snd_pcm_extplug_set_param_minmax(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max);
185 int snd_pcm_extplug_set_slave_param_list(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list);
186 int snd_pcm_extplug_set_slave_param_minmax(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max);
187 
191 static __inline__ int snd_pcm_extplug_set_param(snd_pcm_extplug_t *extplug, int type, unsigned int val)
192 {
193  return snd_pcm_extplug_set_param_list(extplug, type, 1, &val);
194 }
195 
199 static __inline__ int snd_pcm_extplug_set_slave_param(snd_pcm_extplug_t *extplug, int type, unsigned int val)
200 {
201  return snd_pcm_extplug_set_slave_param_list(extplug, type, 1, &val);
202 }
203 
206 #endif /* __ALSA_PCM_EXTPLUG_H */