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;
51 typedef struct snd_pcm_extplug_callback snd_pcm_extplug_callback_t;
52 
53 /*
54  * Protocol version
55  */
56 #define SND_PCM_EXTPLUG_VERSION_MAJOR 1
57 #define SND_PCM_EXTPLUG_VERSION_MINOR 0
58 #define SND_PCM_EXTPLUG_VERSION_TINY 1
62 #define SND_PCM_EXTPLUG_VERSION ((SND_PCM_EXTPLUG_VERSION_MAJOR<<16) |\
63  (SND_PCM_EXTPLUG_VERSION_MINOR<<8) |\
64  (SND_PCM_EXTPLUG_VERSION_TINY))
65 
72  unsigned int version;
76  const char *name;
80  const snd_pcm_extplug_callback_t *callback;
84  void *private_data;
104  unsigned int channels;
108  unsigned int rate;
120  unsigned int slave_channels;
121 };
122 
128  snd_pcm_sframes_t (*transfer)(snd_pcm_extplug_t *ext,
129  const snd_pcm_channel_area_t *dst_areas,
130  snd_pcm_uframes_t dst_offset,
131  const snd_pcm_channel_area_t *src_areas,
132  snd_pcm_uframes_t src_offset,
133  snd_pcm_uframes_t size);
137  int (*close)(snd_pcm_extplug_t *ext);
141  int (*hw_params)(snd_pcm_extplug_t *ext, snd_pcm_hw_params_t *params);
145  int (*hw_free)(snd_pcm_extplug_t *ext);
149  void (*dump)(snd_pcm_extplug_t *ext, snd_output_t *out);
153  int (*init)(snd_pcm_extplug_t *ext);
154 };
155 
156 
157 int snd_pcm_extplug_create(snd_pcm_extplug_t *ext, const char *name,
158  snd_config_t *root, snd_config_t *slave_conf,
159  snd_pcm_stream_t stream, int mode);
160 int snd_pcm_extplug_delete(snd_pcm_extplug_t *ext);
161 
162 /* clear hw_parameter setting */
163 void snd_pcm_extplug_params_reset(snd_pcm_extplug_t *ext);
164 
165 /* hw_parameter setting */
166 int snd_pcm_extplug_set_param_list(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list);
167 int snd_pcm_extplug_set_param_minmax(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max);
168 int snd_pcm_extplug_set_slave_param_list(snd_pcm_extplug_t *extplug, int type, unsigned int num_list, const unsigned int *list);
169 int snd_pcm_extplug_set_slave_param_minmax(snd_pcm_extplug_t *extplug, int type, unsigned int min, unsigned int max);
170 
174 static inline int snd_pcm_extplug_set_param(snd_pcm_extplug_t *extplug, int type, unsigned int val)
175 {
176  return snd_pcm_extplug_set_param_list(extplug, type, 1, &val);
177 }
178 
182 static inline int snd_pcm_extplug_set_slave_param(snd_pcm_extplug_t *extplug, int type, unsigned int val)
183 {
184  return snd_pcm_extplug_set_slave_param_list(extplug, type, 1, &val);
185 }
186 
189 #endif /* __ALSA_PCM_EXTPLUG_H */

Generated for ALSA project - the C library reference by doxygen 1.8.3.1