2 * \file <alsa/control.h>
3 * \brief Application interface library for the ALSA driver
4 * \author Jaroslav Kysela <perex@suse.cz>
5 * \author Abramo Bagnara <abramo@alsa-project.org>
6 * \author Takashi Iwai <tiwai@suse.de>
9 * Application interface library for the ALSA driver
12 * This library is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Library General Public License as
14 * published by the Free Software Foundation; either version 2 of
15 * the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
22 * You should have received a copy of the GNU Library General Public
23 * License along with this library; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #ifndef __ALSA_CONTROL_H
29 #define __ALSA_CONTROL_H
36 * \defgroup Control Control Interface
37 * The control interface.
41 /** dlsym version for interface entry callback */
42 #define SND_CONTROL_DLSYM_VERSION _dlsym_control_001
44 /** IEC958 structure */
45 typedef struct snd_aes_iec958 {
46 unsigned char status[24]; /**< AES/IEC958 channel status bits */
47 unsigned char subcode[147]; /**< AES/IEC958 subcode bits */
48 unsigned char pad; /**< nothing */
49 unsigned char dig_subframe[4]; /**< AES/IEC958 subframe bits */
52 /** CTL card info container */
53 typedef struct _snd_ctl_card_info snd_ctl_card_info_t;
55 /** CTL element identificator container */
56 typedef struct _snd_ctl_elem_id snd_ctl_elem_id_t;
58 /** CTL element identificator list container */
59 typedef struct _snd_ctl_elem_list snd_ctl_elem_list_t;
61 /** CTL element info container */
62 typedef struct _snd_ctl_elem_info snd_ctl_elem_info_t;
64 /** CTL element value container */
65 typedef struct _snd_ctl_elem_value snd_ctl_elem_value_t;
67 /** CTL event container */
68 typedef struct _snd_ctl_event snd_ctl_event_t;
70 /** CTL element type */
71 typedef enum _snd_ctl_elem_type {
73 SND_CTL_ELEM_TYPE_NONE = 0,
74 /** Boolean contents */
75 SND_CTL_ELEM_TYPE_BOOLEAN,
76 /** Integer contents */
77 SND_CTL_ELEM_TYPE_INTEGER,
78 /** Enumerated contents */
79 SND_CTL_ELEM_TYPE_ENUMERATED,
81 SND_CTL_ELEM_TYPE_BYTES,
82 /** IEC958 (S/PDIF) setting content */
83 SND_CTL_ELEM_TYPE_IEC958,
84 SND_CTL_ELEM_TYPE_LAST = SND_CTL_ELEM_TYPE_IEC958,
85 } snd_ctl_elem_type_t;
87 /** CTL related interface */
88 typedef enum _snd_ctl_elem_iface {
90 SND_CTL_ELEM_IFACE_CARD = 0,
91 /** Hardware dependent device */
92 SND_CTL_ELEM_IFACE_HWDEP,
94 SND_CTL_ELEM_IFACE_MIXER,
96 SND_CTL_ELEM_IFACE_PCM,
98 SND_CTL_ELEM_IFACE_RAWMIDI,
100 SND_CTL_ELEM_IFACE_TIMER,
102 SND_CTL_ELEM_IFACE_SEQUENCER,
103 SND_CTL_ELEM_IFACE_LAST = SND_CTL_ELEM_IFACE_SEQUENCER,
104 } snd_ctl_elem_iface_t;
107 typedef enum _snd_ctl_event_type {
108 /** Elements related event */
109 SND_CTL_EVENT_ELEM = 0,
110 SND_CTL_EVENT_LAST = SND_CTL_EVENT_ELEM,
111 }snd_ctl_event_type_t;
113 /** Element has been removed (Warning: test this first and if set don't
114 * test the other masks) \hideinitializer */
115 #define SND_CTL_EVENT_MASK_REMOVE (~0U)
116 /** Element value has been changed \hideinitializer */
117 #define SND_CTL_EVENT_MASK_VALUE (1<<0)
118 /** Element info has been changed \hideinitializer */
119 #define SND_CTL_EVENT_MASK_INFO (1<<1)
120 /** Element has been added \hideinitializer */
121 #define SND_CTL_EVENT_MASK_ADD (1<<2)
123 /** CTL name helper */
124 #define SND_CTL_NAME_NONE ""
125 /** CTL name helper */
126 #define SND_CTL_NAME_PLAYBACK "Playback "
127 /** CTL name helper */
128 #define SND_CTL_NAME_CAPTURE "Capture "
130 /** CTL name helper */
131 #define SND_CTL_NAME_IEC958_NONE ""
132 /** CTL name helper */
133 #define SND_CTL_NAME_IEC958_SWITCH "Switch"
134 /** CTL name helper */
135 #define SND_CTL_NAME_IEC958_VOLUME "Volume"
136 /** CTL name helper */
137 #define SND_CTL_NAME_IEC958_DEFAULT "Default"
138 /** CTL name helper */
139 #define SND_CTL_NAME_IEC958_MASK "Mask"
140 /** CTL name helper */
141 #define SND_CTL_NAME_IEC958_CON_MASK "Con Mask"
142 /** CTL name helper */
143 #define SND_CTL_NAME_IEC958_PRO_MASK "Pro Mask"
144 /** CTL name helper */
145 #define SND_CTL_NAME_IEC958_PCM_STREAM "PCM Stream"
146 /** Element name for IEC958 (S/PDIF) */
147 #define SND_CTL_NAME_IEC958(expl,direction,what) "IEC958 " expl SND_CTL_NAME_##direction SND_CTL_NAME_IEC958_##what
149 /** Mask for the major Power State identifier */
150 #define SND_CTL_POWER_MASK 0xff00
151 /** ACPI/PCI Power State D0 */
152 #define SND_CTL_POWER_D0 0x0000
153 /** ACPI/PCI Power State D1 */
154 #define SND_CTL_POWER_D1 0x0100
155 /** ACPI/PCI Power State D2 */
156 #define SND_CTL_POWER_D2 0x0200
157 /** ACPI/PCI Power State D3 */
158 #define SND_CTL_POWER_D3 0x0300
159 /** ACPI/PCI Power State D3hot */
160 #define SND_CTL_POWER_D3hot (SND_CTL_POWER_D3|0x0000)
161 /** ACPI/PCI Power State D3cold */
162 #define SND_CTL_POWER_D3cold (SND_CTL_POWER_D3|0x0001)
165 typedef enum _snd_ctl_type {
166 /** Kernel level CTL */
168 /** Shared memory client CTL */
170 /** INET client CTL (not yet implemented) */
174 /** Non blocking mode \hideinitializer */
175 #define SND_CTL_NONBLOCK 0x0001
177 /** Async notification \hideinitializer */
178 #define SND_CTL_ASYNC 0x0002
181 typedef struct _snd_ctl snd_ctl_t;
183 /** Don't destroy the ctl handle when close */
184 #define SND_SCTL_NOFREE 0x0001
187 typedef struct _snd_sctl snd_sctl_t;
189 int snd_card_load(int card);
190 int snd_card_next(int *card);
191 int snd_card_get_index(const char *name);
192 int snd_card_get_name(int card, char **name);
193 int snd_card_get_longname(int card, char **name);
195 int snd_ctl_open(snd_ctl_t **ctl, const char *name, int mode);
196 int snd_ctl_open_lconf(snd_ctl_t **ctl, const char *name, int mode, snd_config_t *lconf);
197 int snd_ctl_close(snd_ctl_t *ctl);
198 int snd_ctl_nonblock(snd_ctl_t *ctl, int nonblock);
199 int snd_async_add_ctl_handler(snd_async_handler_t **handler, snd_ctl_t *ctl,
200 snd_async_callback_t callback, void *private_data);
201 snd_ctl_t *snd_async_handler_get_ctl(snd_async_handler_t *handler);
202 int snd_ctl_poll_descriptors_count(snd_ctl_t *ctl);
203 int snd_ctl_poll_descriptors(snd_ctl_t *ctl, struct pollfd *pfds, unsigned int space);
204 int snd_ctl_subscribe_events(snd_ctl_t *ctl, int subscribe);
205 int snd_ctl_card_info(snd_ctl_t *ctl, snd_ctl_card_info_t *info);
206 int snd_ctl_elem_list(snd_ctl_t *ctl, snd_ctl_elem_list_t * list);
207 int snd_ctl_elem_info(snd_ctl_t *ctl, snd_ctl_elem_info_t *info);
208 int snd_ctl_elem_read(snd_ctl_t *ctl, snd_ctl_elem_value_t *value);
209 int snd_ctl_elem_write(snd_ctl_t *ctl, snd_ctl_elem_value_t *value);
210 int snd_ctl_elem_lock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id);
211 int snd_ctl_elem_unlock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id);
212 int snd_ctl_hwdep_next_device(snd_ctl_t *ctl, int * device);
213 int snd_ctl_hwdep_info(snd_ctl_t *ctl, snd_hwdep_info_t * info);
214 int snd_ctl_pcm_next_device(snd_ctl_t *ctl, int *device);
215 int snd_ctl_pcm_info(snd_ctl_t *ctl, snd_pcm_info_t * info);
216 int snd_ctl_pcm_prefer_subdevice(snd_ctl_t *ctl, int subdev);
217 int snd_ctl_rawmidi_next_device(snd_ctl_t *ctl, int * device);
218 int snd_ctl_rawmidi_info(snd_ctl_t *ctl, snd_rawmidi_info_t * info);
219 int snd_ctl_rawmidi_prefer_subdevice(snd_ctl_t *ctl, int subdev);
220 int snd_ctl_set_power_state(snd_ctl_t *ctl, unsigned int state);
221 int snd_ctl_get_power_state(snd_ctl_t *ctl, unsigned int *state);
223 int snd_ctl_read(snd_ctl_t *ctl, snd_ctl_event_t *event);
224 int snd_ctl_wait(snd_ctl_t *ctl, int timeout);
225 const char *snd_ctl_name(snd_ctl_t *ctl);
226 snd_ctl_type_t snd_ctl_type(snd_ctl_t *ctl);
228 void snd_ctl_elem_set_bytes(snd_ctl_elem_value_t *obj, void *data, size_t size);
229 const char *snd_ctl_elem_type_name(snd_ctl_elem_type_t type);
230 const char *snd_ctl_elem_iface_name(snd_ctl_elem_iface_t iface);
231 const char *snd_ctl_event_type_name(snd_ctl_event_type_t type);
233 unsigned int snd_ctl_event_elem_get_mask(const snd_ctl_event_t *obj);
234 unsigned int snd_ctl_event_elem_get_numid(const snd_ctl_event_t *obj);
235 void snd_ctl_event_elem_get_id(const snd_ctl_event_t *obj, snd_ctl_elem_id_t *ptr);
236 snd_ctl_elem_iface_t snd_ctl_event_elem_get_interface(const snd_ctl_event_t *obj);
237 unsigned int snd_ctl_event_elem_get_device(const snd_ctl_event_t *obj);
238 unsigned int snd_ctl_event_elem_get_subdevice(const snd_ctl_event_t *obj);
239 const char *snd_ctl_event_elem_get_name(const snd_ctl_event_t *obj);
240 unsigned int snd_ctl_event_elem_get_index(const snd_ctl_event_t *obj);
242 int snd_ctl_elem_list_alloc_space(snd_ctl_elem_list_t *obj, unsigned int entries);
243 void snd_ctl_elem_list_free_space(snd_ctl_elem_list_t *obj);
245 size_t snd_ctl_elem_id_sizeof(void);
247 * \brief allocate an invalid #snd_ctl_elem_id_t using standard alloca
248 * \param ptr returned pointer
250 #define snd_ctl_elem_id_alloca(ptr) do { assert(ptr); *ptr = (snd_ctl_elem_id_t *) alloca(snd_ctl_elem_id_sizeof()); memset(*ptr, 0, snd_ctl_elem_id_sizeof()); } while (0)
251 int snd_ctl_elem_id_malloc(snd_ctl_elem_id_t **ptr);
252 void snd_ctl_elem_id_free(snd_ctl_elem_id_t *obj);
253 void snd_ctl_elem_id_clear(snd_ctl_elem_id_t *obj);
254 void snd_ctl_elem_id_copy(snd_ctl_elem_id_t *dst, const snd_ctl_elem_id_t *src);
255 unsigned int snd_ctl_elem_id_get_numid(const snd_ctl_elem_id_t *obj);
256 snd_ctl_elem_iface_t snd_ctl_elem_id_get_interface(const snd_ctl_elem_id_t *obj);
257 unsigned int snd_ctl_elem_id_get_device(const snd_ctl_elem_id_t *obj);
258 unsigned int snd_ctl_elem_id_get_subdevice(const snd_ctl_elem_id_t *obj);
259 const char *snd_ctl_elem_id_get_name(const snd_ctl_elem_id_t *obj);
260 unsigned int snd_ctl_elem_id_get_index(const snd_ctl_elem_id_t *obj);
261 void snd_ctl_elem_id_set_numid(snd_ctl_elem_id_t *obj, unsigned int val);
262 void snd_ctl_elem_id_set_interface(snd_ctl_elem_id_t *obj, snd_ctl_elem_iface_t val);
263 void snd_ctl_elem_id_set_device(snd_ctl_elem_id_t *obj, unsigned int val);
264 void snd_ctl_elem_id_set_subdevice(snd_ctl_elem_id_t *obj, unsigned int val);
265 void snd_ctl_elem_id_set_name(snd_ctl_elem_id_t *obj, const char *val);
266 void snd_ctl_elem_id_set_index(snd_ctl_elem_id_t *obj, unsigned int val);
268 size_t snd_ctl_card_info_sizeof(void);
270 * \brief allocate an invalid #snd_ctl_card_info_t using standard alloca
271 * \param ptr returned pointer
273 #define snd_ctl_card_info_alloca(ptr) do { assert(ptr); *ptr = (snd_ctl_card_info_t *) alloca(snd_ctl_card_info_sizeof()); memset(*ptr, 0, snd_ctl_card_info_sizeof()); } while (0)
274 int snd_ctl_card_info_malloc(snd_ctl_card_info_t **ptr);
275 void snd_ctl_card_info_free(snd_ctl_card_info_t *obj);
276 void snd_ctl_card_info_clear(snd_ctl_card_info_t *obj);
277 void snd_ctl_card_info_copy(snd_ctl_card_info_t *dst, const snd_ctl_card_info_t *src);
278 int snd_ctl_card_info_get_card(const snd_ctl_card_info_t *obj);
279 const char *snd_ctl_card_info_get_id(const snd_ctl_card_info_t *obj);
280 const char *snd_ctl_card_info_get_driver(const snd_ctl_card_info_t *obj);
281 const char *snd_ctl_card_info_get_name(const snd_ctl_card_info_t *obj);
282 const char *snd_ctl_card_info_get_longname(const snd_ctl_card_info_t *obj);
283 const char *snd_ctl_card_info_get_mixername(const snd_ctl_card_info_t *obj);
284 const char *snd_ctl_card_info_get_components(const snd_ctl_card_info_t *obj);
286 size_t snd_ctl_event_sizeof(void);
288 * \brief allocate an invalid #snd_ctl_event_t using standard alloca
289 * \param ptr returned pointer
291 #define snd_ctl_event_alloca(ptr) do { assert(ptr); *ptr = (snd_ctl_event_t *) alloca(snd_ctl_event_sizeof()); memset(*ptr, 0, snd_ctl_event_sizeof()); } while (0)
292 int snd_ctl_event_malloc(snd_ctl_event_t **ptr);
293 void snd_ctl_event_free(snd_ctl_event_t *obj);
294 void snd_ctl_event_clear(snd_ctl_event_t *obj);
295 void snd_ctl_event_copy(snd_ctl_event_t *dst, const snd_ctl_event_t *src);
296 snd_ctl_event_type_t snd_ctl_event_get_type(const snd_ctl_event_t *obj);
298 size_t snd_ctl_elem_list_sizeof(void);
300 * \brief allocate an invalid #snd_ctl_elem_list_t using standard alloca
301 * \param ptr returned pointer
303 #define snd_ctl_elem_list_alloca(ptr) do { assert(ptr); *ptr = (snd_ctl_elem_list_t *) alloca(snd_ctl_elem_list_sizeof()); memset(*ptr, 0, snd_ctl_elem_list_sizeof()); } while (0)
304 int snd_ctl_elem_list_malloc(snd_ctl_elem_list_t **ptr);
305 void snd_ctl_elem_list_free(snd_ctl_elem_list_t *obj);
306 void snd_ctl_elem_list_clear(snd_ctl_elem_list_t *obj);
307 void snd_ctl_elem_list_copy(snd_ctl_elem_list_t *dst, const snd_ctl_elem_list_t *src);
308 void snd_ctl_elem_list_set_offset(snd_ctl_elem_list_t *obj, unsigned int val);
309 unsigned int snd_ctl_elem_list_get_used(const snd_ctl_elem_list_t *obj);
310 unsigned int snd_ctl_elem_list_get_count(const snd_ctl_elem_list_t *obj);
311 void snd_ctl_elem_list_get_id(const snd_ctl_elem_list_t *obj, unsigned int idx, snd_ctl_elem_id_t *ptr);
312 unsigned int snd_ctl_elem_list_get_numid(const snd_ctl_elem_list_t *obj, unsigned int idx);
313 snd_ctl_elem_iface_t snd_ctl_elem_list_get_interface(const snd_ctl_elem_list_t *obj, unsigned int idx);
314 unsigned int snd_ctl_elem_list_get_device(const snd_ctl_elem_list_t *obj, unsigned int idx);
315 unsigned int snd_ctl_elem_list_get_subdevice(const snd_ctl_elem_list_t *obj, unsigned int idx);
316 const char *snd_ctl_elem_list_get_name(const snd_ctl_elem_list_t *obj, unsigned int idx);
317 unsigned int snd_ctl_elem_list_get_index(const snd_ctl_elem_list_t *obj, unsigned int idx);
319 size_t snd_ctl_elem_info_sizeof(void);
321 * \brief allocate an invalid #snd_ctl_elem_info_t using standard alloca
322 * \param ptr returned pointer
324 #define snd_ctl_elem_info_alloca(ptr) do { assert(ptr); *ptr = (snd_ctl_elem_info_t *) alloca(snd_ctl_elem_info_sizeof()); memset(*ptr, 0, snd_ctl_elem_info_sizeof()); } while (0)
325 int snd_ctl_elem_info_malloc(snd_ctl_elem_info_t **ptr);
326 void snd_ctl_elem_info_free(snd_ctl_elem_info_t *obj);
327 void snd_ctl_elem_info_clear(snd_ctl_elem_info_t *obj);
328 void snd_ctl_elem_info_copy(snd_ctl_elem_info_t *dst, const snd_ctl_elem_info_t *src);
329 snd_ctl_elem_type_t snd_ctl_elem_info_get_type(const snd_ctl_elem_info_t *obj);
330 int snd_ctl_elem_info_is_readable(const snd_ctl_elem_info_t *obj);
331 int snd_ctl_elem_info_is_writable(const snd_ctl_elem_info_t *obj);
332 int snd_ctl_elem_info_is_volatile(const snd_ctl_elem_info_t *obj);
333 int snd_ctl_elem_info_is_inactive(const snd_ctl_elem_info_t *obj);
334 int snd_ctl_elem_info_is_locked(const snd_ctl_elem_info_t *obj);
335 int snd_ctl_elem_info_is_owner(const snd_ctl_elem_info_t *obj);
336 int snd_ctl_elem_info_is_indirect(const snd_ctl_elem_info_t *obj);
337 pid_t snd_ctl_elem_info_get_owner(const snd_ctl_elem_info_t *obj);
338 unsigned int snd_ctl_elem_info_get_count(const snd_ctl_elem_info_t *obj);
339 long snd_ctl_elem_info_get_min(const snd_ctl_elem_info_t *obj);
340 long snd_ctl_elem_info_get_max(const snd_ctl_elem_info_t *obj);
341 long snd_ctl_elem_info_get_step(const snd_ctl_elem_info_t *obj);
342 unsigned int snd_ctl_elem_info_get_items(const snd_ctl_elem_info_t *obj);
343 void snd_ctl_elem_info_set_item(snd_ctl_elem_info_t *obj, unsigned int val);
344 const char *snd_ctl_elem_info_get_item_name(const snd_ctl_elem_info_t *obj);
345 void snd_ctl_elem_info_get_id(const snd_ctl_elem_info_t *obj, snd_ctl_elem_id_t *ptr);
346 unsigned int snd_ctl_elem_info_get_numid(const snd_ctl_elem_info_t *obj);
347 snd_ctl_elem_iface_t snd_ctl_elem_info_get_interface(const snd_ctl_elem_info_t *obj);
348 unsigned int snd_ctl_elem_info_get_device(const snd_ctl_elem_info_t *obj);
349 unsigned int snd_ctl_elem_info_get_subdevice(const snd_ctl_elem_info_t *obj);
350 const char *snd_ctl_elem_info_get_name(const snd_ctl_elem_info_t *obj);
351 unsigned int snd_ctl_elem_info_get_index(const snd_ctl_elem_info_t *obj);
352 void snd_ctl_elem_info_set_id(snd_ctl_elem_info_t *obj, const snd_ctl_elem_id_t *ptr);
353 void snd_ctl_elem_info_set_numid(snd_ctl_elem_info_t *obj, unsigned int val);
354 void snd_ctl_elem_info_set_interface(snd_ctl_elem_info_t *obj, snd_ctl_elem_iface_t val);
355 void snd_ctl_elem_info_set_device(snd_ctl_elem_info_t *obj, unsigned int val);
356 void snd_ctl_elem_info_set_subdevice(snd_ctl_elem_info_t *obj, unsigned int val);
357 void snd_ctl_elem_info_set_name(snd_ctl_elem_info_t *obj, const char *val);
358 void snd_ctl_elem_info_set_index(snd_ctl_elem_info_t *obj, unsigned int val);
360 size_t snd_ctl_elem_value_sizeof(void);
362 * \brief allocate an invalid #snd_ctl_elem_value_t using standard alloca
363 * \param ptr returned pointer
365 #define snd_ctl_elem_value_alloca(ptr) do { assert(ptr); *ptr = (snd_ctl_elem_value_t *) alloca(snd_ctl_elem_value_sizeof()); memset(*ptr, 0, snd_ctl_elem_value_sizeof()); } while (0)
366 int snd_ctl_elem_value_malloc(snd_ctl_elem_value_t **ptr);
367 void snd_ctl_elem_value_free(snd_ctl_elem_value_t *obj);
368 void snd_ctl_elem_value_clear(snd_ctl_elem_value_t *obj);
369 void snd_ctl_elem_value_copy(snd_ctl_elem_value_t *dst, const snd_ctl_elem_value_t *src);
370 void snd_ctl_elem_value_get_id(const snd_ctl_elem_value_t *obj, snd_ctl_elem_id_t *ptr);
371 unsigned int snd_ctl_elem_value_get_numid(const snd_ctl_elem_value_t *obj);
372 snd_ctl_elem_iface_t snd_ctl_elem_value_get_interface(const snd_ctl_elem_value_t *obj);
373 unsigned int snd_ctl_elem_value_get_device(const snd_ctl_elem_value_t *obj);
374 unsigned int snd_ctl_elem_value_get_subdevice(const snd_ctl_elem_value_t *obj);
375 const char *snd_ctl_elem_value_get_name(const snd_ctl_elem_value_t *obj);
376 unsigned int snd_ctl_elem_value_get_index(const snd_ctl_elem_value_t *obj);
377 void snd_ctl_elem_value_set_id(snd_ctl_elem_value_t *obj, const snd_ctl_elem_id_t *ptr);
378 void snd_ctl_elem_value_set_numid(snd_ctl_elem_value_t *obj, unsigned int val);
379 void snd_ctl_elem_value_set_interface(snd_ctl_elem_value_t *obj, snd_ctl_elem_iface_t val);
380 void snd_ctl_elem_value_set_device(snd_ctl_elem_value_t *obj, unsigned int val);
381 void snd_ctl_elem_value_set_subdevice(snd_ctl_elem_value_t *obj, unsigned int val);
382 void snd_ctl_elem_value_set_name(snd_ctl_elem_value_t *obj, const char *val);
383 void snd_ctl_elem_value_set_index(snd_ctl_elem_value_t *obj, unsigned int val);
384 int snd_ctl_elem_value_get_boolean(const snd_ctl_elem_value_t *obj, unsigned int idx);
385 long snd_ctl_elem_value_get_integer(const snd_ctl_elem_value_t *obj, unsigned int idx);
386 unsigned int snd_ctl_elem_value_get_enumerated(const snd_ctl_elem_value_t *obj, unsigned int idx);
387 unsigned char snd_ctl_elem_value_get_byte(const snd_ctl_elem_value_t *obj, unsigned int idx);
388 void snd_ctl_elem_value_set_boolean(snd_ctl_elem_value_t *obj, unsigned int idx, long val);
389 void snd_ctl_elem_value_set_integer(snd_ctl_elem_value_t *obj, unsigned int idx, long val);
390 void snd_ctl_elem_value_set_enumerated(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned int val);
391 void snd_ctl_elem_value_set_byte(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned char val);
392 const void * snd_ctl_elem_value_get_bytes(const snd_ctl_elem_value_t *obj);
393 void snd_ctl_elem_value_get_iec958(const snd_ctl_elem_value_t *obj, snd_aes_iec958_t *ptr);
394 void snd_ctl_elem_value_set_iec958(snd_ctl_elem_value_t *obj, const snd_aes_iec958_t *ptr);
397 * \defgroup HControl Highlevel Control Interface
399 * The highlevel control interface.
403 /** HCTL element handle */
404 typedef struct _snd_hctl_elem snd_hctl_elem_t;
407 typedef struct _snd_hctl snd_hctl_t;
410 * \brief Compare function for sorting HCTL elements
411 * \param e1 First element
412 * \param e2 Second element
413 * \return -1 if e1 < e2, 0 if e1 == e2, 1 if e1 > e2
415 typedef int (*snd_hctl_compare_t)(const snd_hctl_elem_t *e1,
416 const snd_hctl_elem_t *e2);
417 int snd_hctl_compare_fast(const snd_hctl_elem_t *c1,
418 const snd_hctl_elem_t *c2);
420 * \brief HCTL callback function
421 * \param hctl HCTL handle
422 * \param mask event mask
423 * \param elem related HCTL element (if any)
424 * \return 0 on success otherwise a negative error code
426 typedef int (*snd_hctl_callback_t)(snd_hctl_t *hctl,
428 snd_hctl_elem_t *elem);
430 * \brief HCTL element callback function
431 * \param elem HCTL element
432 * \param mask event mask
433 * \return 0 on success otherwise a negative error code
435 typedef int (*snd_hctl_elem_callback_t)(snd_hctl_elem_t *elem,
438 int snd_hctl_open(snd_hctl_t **hctl, const char *name, int mode);
439 int snd_hctl_close(snd_hctl_t *hctl);
440 int snd_hctl_nonblock(snd_hctl_t *hctl, int nonblock);
441 int snd_hctl_poll_descriptors_count(snd_hctl_t *hctl);
442 int snd_hctl_poll_descriptors(snd_hctl_t *hctl, struct pollfd *pfds, unsigned int space);
443 unsigned int snd_hctl_get_count(snd_hctl_t *hctl);
444 int snd_hctl_set_compare(snd_hctl_t *hctl, snd_hctl_compare_t hsort);
445 snd_hctl_elem_t *snd_hctl_first_elem(snd_hctl_t *hctl);
446 snd_hctl_elem_t *snd_hctl_last_elem(snd_hctl_t *hctl);
447 snd_hctl_elem_t *snd_hctl_find_elem(snd_hctl_t *hctl, const snd_ctl_elem_id_t *id);
448 void snd_hctl_set_callback(snd_hctl_t *hctl, snd_hctl_callback_t callback);
449 void snd_hctl_set_callback_private(snd_hctl_t *hctl, void *data);
450 void *snd_hctl_get_callback_private(snd_hctl_t *hctl);
451 int snd_hctl_load(snd_hctl_t *hctl);
452 int snd_hctl_free(snd_hctl_t *hctl);
453 int snd_hctl_handle_events(snd_hctl_t *hctl);
454 const char *snd_hctl_name(snd_hctl_t *hctl);
455 int snd_hctl_wait(snd_hctl_t *hctl, int timeout);
457 snd_hctl_elem_t *snd_hctl_elem_next(snd_hctl_elem_t *elem);
458 snd_hctl_elem_t *snd_hctl_elem_prev(snd_hctl_elem_t *elem);
459 int snd_hctl_elem_info(snd_hctl_elem_t *elem, snd_ctl_elem_info_t * info);
460 int snd_hctl_elem_read(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
461 int snd_hctl_elem_write(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
463 snd_hctl_t *snd_hctl_elem_get_hctl(snd_hctl_elem_t *elem);
465 void snd_hctl_elem_get_id(const snd_hctl_elem_t *obj, snd_ctl_elem_id_t *ptr);
466 unsigned int snd_hctl_elem_get_numid(const snd_hctl_elem_t *obj);
467 snd_ctl_elem_iface_t snd_hctl_elem_get_interface(const snd_hctl_elem_t *obj);
468 unsigned int snd_hctl_elem_get_device(const snd_hctl_elem_t *obj);
469 unsigned int snd_hctl_elem_get_subdevice(const snd_hctl_elem_t *obj);
470 const char *snd_hctl_elem_get_name(const snd_hctl_elem_t *obj);
471 unsigned int snd_hctl_elem_get_index(const snd_hctl_elem_t *obj);
472 void snd_hctl_elem_set_callback(snd_hctl_elem_t *obj, snd_hctl_elem_callback_t val);
473 void * snd_hctl_elem_get_callback_private(const snd_hctl_elem_t *obj);
474 void snd_hctl_elem_set_callback_private(snd_hctl_elem_t *obj, void * val);
481 * \defgroup SControl Setup Control Interface
483 * The setup control interface - set or modify control elements from a configuration file.
487 int snd_sctl_build(snd_sctl_t **ctl, snd_ctl_t *handle, snd_config_t *config,
488 snd_config_t *private_data, int mode);
489 int snd_sctl_free(snd_sctl_t *handle);
490 int snd_sctl_install(snd_sctl_t *handle);
491 int snd_sctl_remove(snd_sctl_t *handle);
499 #endif /* __ALSA_CONTROL_H */