1/**
2 * \file include/control.h
3 * \brief Application interface library for the ALSA driver
4 * \author Jaroslav Kysela <perex@perex.cz>
5 * \author Abramo Bagnara <abramo@alsa-project.org>
6 * \author Takashi Iwai <tiwai@suse.de>
7 * \date 1998-2001
8 *
9 * Application interface library for the ALSA driver
10 */
11/*
12 * This library is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Lesser General Public License as
14 * published by the Free Software Foundation; either version 2.1 of
15 * the License, or (at your option) any later version.
16 *
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 Lesser General Public License for more details.
21 *
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this library; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 *
26 */
27
28#ifndef __ALSA_CONTROL_H
29#define __ALSA_CONTROL_H
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35/**
36 * \defgroup Control Control Interface
37 * The control interface.
38 * See \ref control page for more details.
39 * \{
40 */
41
42/** dlsym version for interface entry callback */
43#define SND_CONTROL_DLSYM_VERSION _dlsym_control_001
44
45/** IEC958 structure */
46typedef struct snd_aes_iec958 {
47 unsigned char status[24]; /**< AES/IEC958 channel status bits */
48 unsigned char subcode[147]; /**< AES/IEC958 subcode bits */
49 unsigned char pad; /**< nothing */
50 unsigned char dig_subframe[4]; /**< AES/IEC958 subframe bits */
51} snd_aes_iec958_t;
52
53/** CTL card info container */
54typedef struct _snd_ctl_card_info snd_ctl_card_info_t;
55
56/** CTL element identifier container */
57typedef struct _snd_ctl_elem_id snd_ctl_elem_id_t;
58
59/** CTL element identifier list container */
60typedef struct _snd_ctl_elem_list snd_ctl_elem_list_t;
61
62/** CTL element info container */
63typedef struct _snd_ctl_elem_info snd_ctl_elem_info_t;
64
65/** CTL element value container */
66typedef struct _snd_ctl_elem_value snd_ctl_elem_value_t;
67
68/** CTL event container */
69typedef struct _snd_ctl_event snd_ctl_event_t;
70
71/** CTL element type */
72typedef enum _snd_ctl_elem_type {
73 /** Invalid type */
74 SND_CTL_ELEM_TYPE_NONE = 0,
75 /** Boolean contents */
76 SND_CTL_ELEM_TYPE_BOOLEAN,
77 /** Integer contents */
78 SND_CTL_ELEM_TYPE_INTEGER,
79 /** Enumerated contents */
80 SND_CTL_ELEM_TYPE_ENUMERATED,
81 /** Bytes contents */
82 SND_CTL_ELEM_TYPE_BYTES,
83 /** IEC958 (S/PDIF) setting content */
84 SND_CTL_ELEM_TYPE_IEC958,
85 /** 64-bit integer contents */
86 SND_CTL_ELEM_TYPE_INTEGER64,
87 SND_CTL_ELEM_TYPE_LAST = SND_CTL_ELEM_TYPE_INTEGER64
88} snd_ctl_elem_type_t;
89
90/** CTL related interface */
91typedef enum _snd_ctl_elem_iface {
92 /** Card level */
93 SND_CTL_ELEM_IFACE_CARD = 0,
94 /** Hardware dependent device */
95 SND_CTL_ELEM_IFACE_HWDEP,
96 /** Mixer */
97 SND_CTL_ELEM_IFACE_MIXER,
98 /** PCM */
99 SND_CTL_ELEM_IFACE_PCM,
100 /** RawMidi */
101 SND_CTL_ELEM_IFACE_RAWMIDI,
102 /** Timer */
103 SND_CTL_ELEM_IFACE_TIMER,
104 /** Sequencer */
105 SND_CTL_ELEM_IFACE_SEQUENCER,
106 SND_CTL_ELEM_IFACE_LAST = SND_CTL_ELEM_IFACE_SEQUENCER
107} snd_ctl_elem_iface_t;
108
109/** Event class */
110typedef enum _snd_ctl_event_type {
111 /** Elements related event */
112 SND_CTL_EVENT_ELEM = 0,
113 SND_CTL_EVENT_LAST = SND_CTL_EVENT_ELEM
114}snd_ctl_event_type_t;
115
116/** Element has been removed (Warning: test this first and if set don't
117 * test the other masks) \hideinitializer */
118#define SND_CTL_EVENT_MASK_REMOVE (~0U)
119/** Element value has been changed \hideinitializer */
120#define SND_CTL_EVENT_MASK_VALUE (1<<0)
121/** Element info has been changed \hideinitializer */
122#define SND_CTL_EVENT_MASK_INFO (1<<1)
123/** Element has been added \hideinitializer */
124#define SND_CTL_EVENT_MASK_ADD (1<<2)
125/** Element's TLV value has been changed \hideinitializer */
126#define SND_CTL_EVENT_MASK_TLV (1<<3)
127
128/** CTL name helper */
129#define SND_CTL_NAME_NONE ""
130/** CTL name helper */
131#define SND_CTL_NAME_PLAYBACK "Playback "
132/** CTL name helper */
133#define SND_CTL_NAME_CAPTURE "Capture "
134
135/** CTL name helper */
136#define SND_CTL_NAME_IEC958_NONE ""
137/** CTL name helper */
138#define SND_CTL_NAME_IEC958_SWITCH "Switch"
139/** CTL name helper */
140#define SND_CTL_NAME_IEC958_VOLUME "Volume"
141/** CTL name helper */
142#define SND_CTL_NAME_IEC958_DEFAULT "Default"
143/** CTL name helper */
144#define SND_CTL_NAME_IEC958_MASK "Mask"
145/** CTL name helper */
146#define SND_CTL_NAME_IEC958_CON_MASK "Con Mask"
147/** CTL name helper */
148#define SND_CTL_NAME_IEC958_PRO_MASK "Pro Mask"
149/** CTL name helper */
150#define SND_CTL_NAME_IEC958_PCM_STREAM "PCM Stream"
151/** Element name for IEC958 (S/PDIF) */
152#define SND_CTL_NAME_IEC958(expl,direction,what) "IEC958 " expl SND_CTL_NAME_##direction SND_CTL_NAME_IEC958_##what
153
154/** Mask for the major Power State identifier */
155#define SND_CTL_POWER_MASK 0xff00
156/** ACPI/PCI Power State D0 */
157#define SND_CTL_POWER_D0 0x0000
158/** ACPI/PCI Power State D1 */
159#define SND_CTL_POWER_D1 0x0100
160/** ACPI/PCI Power State D2 */
161#define SND_CTL_POWER_D2 0x0200
162/** ACPI/PCI Power State D3 */
163#define SND_CTL_POWER_D3 0x0300
164/** ACPI/PCI Power State D3hot */
165#define SND_CTL_POWER_D3hot (SND_CTL_POWER_D3|0x0000)
166/** ACPI/PCI Power State D3cold */
167#define SND_CTL_POWER_D3cold (SND_CTL_POWER_D3|0x0001)
168
169/** TLV type - Container */
170#define SND_CTL_TLVT_CONTAINER 0x0000
171/** TLV type - basic dB scale */
172#define SND_CTL_TLVT_DB_SCALE 0x0001
173/** TLV type - linear volume */
174#define SND_CTL_TLVT_DB_LINEAR 0x0002
175/** TLV type - dB range container */
176#define SND_CTL_TLVT_DB_RANGE 0x0003
177/** TLV type - dB scale specified by min/max values */
178#define SND_CTL_TLVT_DB_MINMAX 0x0004
179/** TLV type - dB scale specified by min/max values (with mute) */
180#define SND_CTL_TLVT_DB_MINMAX_MUTE 0x0005
181
182/** Mute state */
183#define SND_CTL_TLV_DB_GAIN_MUTE -9999999
184
185/** TLV type - fixed channel map positions */
186#define SND_CTL_TLVT_CHMAP_FIXED 0x00101
187/** TLV type - freely swappable channel map positions */
188#define SND_CTL_TLVT_CHMAP_VAR 0x00102
189/** TLV type - pair-wise swappable channel map positions */
190#define SND_CTL_TLVT_CHMAP_PAIRED 0x00103
191
192/** CTL type */
193typedef enum _snd_ctl_type {
194 /** Kernel level CTL */
195 SND_CTL_TYPE_HW,
196 /** Shared memory client CTL */
197 SND_CTL_TYPE_SHM,
198 /** INET client CTL (not yet implemented) */
199 SND_CTL_TYPE_INET,
200 /** External control plugin */
201 SND_CTL_TYPE_EXT
202} snd_ctl_type_t;
203
204/** Non blocking mode (flag for open mode) \hideinitializer */
205#define SND_CTL_NONBLOCK 0x0001
206
207/** Async notification (flag for open mode) \hideinitializer */
208#define SND_CTL_ASYNC 0x0002
209
210/** Read only (flag for open mode) \hideinitializer */
211#define SND_CTL_READONLY 0x0004
212
213/** CTL handle */
214typedef struct _snd_ctl snd_ctl_t;
215
216/** Don't destroy the ctl handle when close */
217#define SND_SCTL_NOFREE 0x0001
218
219/** SCTL type */
220typedef struct _snd_sctl snd_sctl_t;
221
222int snd_card_load(int card);
223int snd_card_next(int *card);
224int snd_card_get_index(const char *name);
225int snd_card_get_name(int card, char **name);
226int snd_card_get_longname(int card, char **name);
227
228int snd_device_name_hint(int card, const char *iface, void ***hints);
229int snd_device_name_free_hint(void **hints);
230char *snd_device_name_get_hint(const void *hint, const char *id);
231
232int snd_ctl_open(snd_ctl_t **ctl, const char *name, int mode);
233int snd_ctl_open_lconf(snd_ctl_t **ctl, const char *name, int mode, snd_config_t *lconf);
234int snd_ctl_open_fallback(snd_ctl_t **ctl, snd_config_t *root, const char *name, const char *orig_name, int mode);
235int snd_ctl_close(snd_ctl_t *ctl);
236int snd_ctl_nonblock(snd_ctl_t *ctl, int nonblock);
237static __inline__ int snd_ctl_abort(snd_ctl_t *ctl) { return snd_ctl_nonblock(ctl, 2); }
238int snd_async_add_ctl_handler(snd_async_handler_t **handler, snd_ctl_t *ctl,
239 snd_async_callback_t callback, void *private_data);
240snd_ctl_t *snd_async_handler_get_ctl(snd_async_handler_t *handler);
241int snd_ctl_poll_descriptors_count(snd_ctl_t *ctl);
242int snd_ctl_poll_descriptors(snd_ctl_t *ctl, struct pollfd *pfds, unsigned int space);
243int snd_ctl_poll_descriptors_revents(snd_ctl_t *ctl, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
244int snd_ctl_subscribe_events(snd_ctl_t *ctl, int subscribe);
245int snd_ctl_card_info(snd_ctl_t *ctl, snd_ctl_card_info_t *info);
246int snd_ctl_elem_list(snd_ctl_t *ctl, snd_ctl_elem_list_t *list);
247int snd_ctl_elem_info(snd_ctl_t *ctl, snd_ctl_elem_info_t *info);
248int snd_ctl_elem_read(snd_ctl_t *ctl, snd_ctl_elem_value_t *value);
249int snd_ctl_elem_write(snd_ctl_t *ctl, snd_ctl_elem_value_t *value);
250int snd_ctl_elem_lock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id);
251int snd_ctl_elem_unlock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id);
252int snd_ctl_elem_tlv_read(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
253 unsigned int *tlv, unsigned int tlv_size);
254int snd_ctl_elem_tlv_write(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
255 const unsigned int *tlv);
256int snd_ctl_elem_tlv_command(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
257 const unsigned int *tlv);
258#ifdef __ALSA_HWDEP_H
259int snd_ctl_hwdep_next_device(snd_ctl_t *ctl, int * device);
260int snd_ctl_hwdep_info(snd_ctl_t *ctl, snd_hwdep_info_t * info);
261#endif
262#ifdef __ALSA_PCM_H
263int snd_ctl_pcm_next_device(snd_ctl_t *ctl, int *device);
264int snd_ctl_pcm_info(snd_ctl_t *ctl, snd_pcm_info_t * info);
265int snd_ctl_pcm_prefer_subdevice(snd_ctl_t *ctl, int subdev);
266#endif
267#ifdef __ALSA_RAWMIDI_H
268int snd_ctl_rawmidi_next_device(snd_ctl_t *ctl, int * device);
269int snd_ctl_rawmidi_info(snd_ctl_t *ctl, snd_rawmidi_info_t * info);
270int snd_ctl_rawmidi_prefer_subdevice(snd_ctl_t *ctl, int subdev);
271#endif
272int snd_ctl_set_power_state(snd_ctl_t *ctl, unsigned int state);
273int snd_ctl_get_power_state(snd_ctl_t *ctl, unsigned int *state);
274
275int snd_ctl_read(snd_ctl_t *ctl, snd_ctl_event_t *event);
276int snd_ctl_wait(snd_ctl_t *ctl, int timeout);
277const char *snd_ctl_name(snd_ctl_t *ctl);
278snd_ctl_type_t snd_ctl_type(snd_ctl_t *ctl);
279
280const char *snd_ctl_elem_type_name(snd_ctl_elem_type_t type);
281const char *snd_ctl_elem_iface_name(snd_ctl_elem_iface_t iface);
282const char *snd_ctl_event_type_name(snd_ctl_event_type_t type);
283
284unsigned int snd_ctl_event_elem_get_mask(const snd_ctl_event_t *obj);
285unsigned int snd_ctl_event_elem_get_numid(const snd_ctl_event_t *obj);
286void snd_ctl_event_elem_get_id(const snd_ctl_event_t *obj, snd_ctl_elem_id_t *ptr);
287snd_ctl_elem_iface_t snd_ctl_event_elem_get_interface(const snd_ctl_event_t *obj);
288unsigned int snd_ctl_event_elem_get_device(const snd_ctl_event_t *obj);
289unsigned int snd_ctl_event_elem_get_subdevice(const snd_ctl_event_t *obj);
290const char *snd_ctl_event_elem_get_name(const snd_ctl_event_t *obj);
291unsigned int snd_ctl_event_elem_get_index(const snd_ctl_event_t *obj);
292
293int snd_ctl_elem_list_alloc_space(snd_ctl_elem_list_t *obj, unsigned int entries);
294void snd_ctl_elem_list_free_space(snd_ctl_elem_list_t *obj);
295
296char *snd_ctl_ascii_elem_id_get(snd_ctl_elem_id_t *id);
297int snd_ctl_ascii_elem_id_parse(snd_ctl_elem_id_t *dst, const char *str);
298int snd_ctl_ascii_value_parse(snd_ctl_t *handle,
299 snd_ctl_elem_value_t *dst,
300 snd_ctl_elem_info_t *info,
301 const char *value);
302
303size_t snd_ctl_elem_id_sizeof(void);
304/** \hideinitializer
305 * \brief allocate an invalid #snd_ctl_elem_id_t using standard alloca
306 * \param ptr returned pointer
307 */
308#define snd_ctl_elem_id_alloca(ptr) __snd_alloca(ptr, snd_ctl_elem_id)
309int snd_ctl_elem_id_malloc(snd_ctl_elem_id_t **ptr);
310void snd_ctl_elem_id_free(snd_ctl_elem_id_t *obj);
311void snd_ctl_elem_id_clear(snd_ctl_elem_id_t *obj);
312void snd_ctl_elem_id_copy(snd_ctl_elem_id_t *dst, const snd_ctl_elem_id_t *src);
313unsigned int snd_ctl_elem_id_get_numid(const snd_ctl_elem_id_t *obj);
314snd_ctl_elem_iface_t snd_ctl_elem_id_get_interface(const snd_ctl_elem_id_t *obj);
315unsigned int snd_ctl_elem_id_get_device(const snd_ctl_elem_id_t *obj);
316unsigned int snd_ctl_elem_id_get_subdevice(const snd_ctl_elem_id_t *obj);
317const char *snd_ctl_elem_id_get_name(const snd_ctl_elem_id_t *obj);
318unsigned int snd_ctl_elem_id_get_index(const snd_ctl_elem_id_t *obj);
319void snd_ctl_elem_id_set_numid(snd_ctl_elem_id_t *obj, unsigned int val);
320void snd_ctl_elem_id_set_interface(snd_ctl_elem_id_t *obj, snd_ctl_elem_iface_t val);
321void snd_ctl_elem_id_set_device(snd_ctl_elem_id_t *obj, unsigned int val);
322void snd_ctl_elem_id_set_subdevice(snd_ctl_elem_id_t *obj, unsigned int val);
323void snd_ctl_elem_id_set_name(snd_ctl_elem_id_t *obj, const char *val);
324void snd_ctl_elem_id_set_index(snd_ctl_elem_id_t *obj, unsigned int val);
325
326size_t snd_ctl_card_info_sizeof(void);
327/** \hideinitializer
328 * \brief allocate an invalid #snd_ctl_card_info_t using standard alloca
329 * \param ptr returned pointer
330 */
331#define snd_ctl_card_info_alloca(ptr) __snd_alloca(ptr, snd_ctl_card_info)
332int snd_ctl_card_info_malloc(snd_ctl_card_info_t **ptr);
333void snd_ctl_card_info_free(snd_ctl_card_info_t *obj);
334void snd_ctl_card_info_clear(snd_ctl_card_info_t *obj);
335void snd_ctl_card_info_copy(snd_ctl_card_info_t *dst, const snd_ctl_card_info_t *src);
336int snd_ctl_card_info_get_card(const snd_ctl_card_info_t *obj);
337const char *snd_ctl_card_info_get_id(const snd_ctl_card_info_t *obj);
338const char *snd_ctl_card_info_get_driver(const snd_ctl_card_info_t *obj);
339const char *snd_ctl_card_info_get_name(const snd_ctl_card_info_t *obj);
340const char *snd_ctl_card_info_get_longname(const snd_ctl_card_info_t *obj);
341const char *snd_ctl_card_info_get_mixername(const snd_ctl_card_info_t *obj);
342const char *snd_ctl_card_info_get_components(const snd_ctl_card_info_t *obj);
343
344size_t snd_ctl_event_sizeof(void);
345/** \hideinitializer
346 * \brief allocate an invalid #snd_ctl_event_t using standard alloca
347 * \param ptr returned pointer
348 */
349#define snd_ctl_event_alloca(ptr) __snd_alloca(ptr, snd_ctl_event)
350int snd_ctl_event_malloc(snd_ctl_event_t **ptr);
351void snd_ctl_event_free(snd_ctl_event_t *obj);
352void snd_ctl_event_clear(snd_ctl_event_t *obj);
353void snd_ctl_event_copy(snd_ctl_event_t *dst, const snd_ctl_event_t *src);
354snd_ctl_event_type_t snd_ctl_event_get_type(const snd_ctl_event_t *obj);
355
356size_t snd_ctl_elem_list_sizeof(void);
357/** \hideinitializer
358 * \brief allocate an invalid #snd_ctl_elem_list_t using standard alloca
359 * \param ptr returned pointer
360 */
361#define snd_ctl_elem_list_alloca(ptr) __snd_alloca(ptr, snd_ctl_elem_list)
362int snd_ctl_elem_list_malloc(snd_ctl_elem_list_t **ptr);
363void snd_ctl_elem_list_free(snd_ctl_elem_list_t *obj);
364void snd_ctl_elem_list_clear(snd_ctl_elem_list_t *obj);
365void snd_ctl_elem_list_copy(snd_ctl_elem_list_t *dst, const snd_ctl_elem_list_t *src);
366void snd_ctl_elem_list_set_offset(snd_ctl_elem_list_t *obj, unsigned int val);
367unsigned int snd_ctl_elem_list_get_used(const snd_ctl_elem_list_t *obj);
368unsigned int snd_ctl_elem_list_get_count(const snd_ctl_elem_list_t *obj);
369void snd_ctl_elem_list_get_id(const snd_ctl_elem_list_t *obj, unsigned int idx, snd_ctl_elem_id_t *ptr);
370unsigned int snd_ctl_elem_list_get_numid(const snd_ctl_elem_list_t *obj, unsigned int idx);
371snd_ctl_elem_iface_t snd_ctl_elem_list_get_interface(const snd_ctl_elem_list_t *obj, unsigned int idx);
372unsigned int snd_ctl_elem_list_get_device(const snd_ctl_elem_list_t *obj, unsigned int idx);
373unsigned int snd_ctl_elem_list_get_subdevice(const snd_ctl_elem_list_t *obj, unsigned int idx);
374const char *snd_ctl_elem_list_get_name(const snd_ctl_elem_list_t *obj, unsigned int idx);
375unsigned int snd_ctl_elem_list_get_index(const snd_ctl_elem_list_t *obj, unsigned int idx);
376
377size_t snd_ctl_elem_info_sizeof(void);
378/** \hideinitializer
379 * \brief allocate an invalid #snd_ctl_elem_info_t using standard alloca
380 * \param ptr returned pointer
381 */
382#define snd_ctl_elem_info_alloca(ptr) __snd_alloca(ptr, snd_ctl_elem_info)
383int snd_ctl_elem_info_malloc(snd_ctl_elem_info_t **ptr);
384void snd_ctl_elem_info_free(snd_ctl_elem_info_t *obj);
385void snd_ctl_elem_info_clear(snd_ctl_elem_info_t *obj);
386void snd_ctl_elem_info_copy(snd_ctl_elem_info_t *dst, const snd_ctl_elem_info_t *src);
387snd_ctl_elem_type_t snd_ctl_elem_info_get_type(const snd_ctl_elem_info_t *obj);
388int snd_ctl_elem_info_is_readable(const snd_ctl_elem_info_t *obj);
389int snd_ctl_elem_info_is_writable(const snd_ctl_elem_info_t *obj);
390int snd_ctl_elem_info_is_volatile(const snd_ctl_elem_info_t *obj);
391int snd_ctl_elem_info_is_inactive(const snd_ctl_elem_info_t *obj);
392int snd_ctl_elem_info_is_locked(const snd_ctl_elem_info_t *obj);
393int snd_ctl_elem_info_is_tlv_readable(const snd_ctl_elem_info_t *obj);
394int snd_ctl_elem_info_is_tlv_writable(const snd_ctl_elem_info_t *obj);
395int snd_ctl_elem_info_is_tlv_commandable(const snd_ctl_elem_info_t *obj);
396int snd_ctl_elem_info_is_owner(const snd_ctl_elem_info_t *obj);
397int snd_ctl_elem_info_is_user(const snd_ctl_elem_info_t *obj);
398pid_t snd_ctl_elem_info_get_owner(const snd_ctl_elem_info_t *obj);
399unsigned int snd_ctl_elem_info_get_count(const snd_ctl_elem_info_t *obj);
400long snd_ctl_elem_info_get_min(const snd_ctl_elem_info_t *obj);
401long snd_ctl_elem_info_get_max(const snd_ctl_elem_info_t *obj);
402long snd_ctl_elem_info_get_step(const snd_ctl_elem_info_t *obj);
403long long snd_ctl_elem_info_get_min64(const snd_ctl_elem_info_t *obj);
404long long snd_ctl_elem_info_get_max64(const snd_ctl_elem_info_t *obj);
405long long snd_ctl_elem_info_get_step64(const snd_ctl_elem_info_t *obj);
406unsigned int snd_ctl_elem_info_get_items(const snd_ctl_elem_info_t *obj);
407void snd_ctl_elem_info_set_item(snd_ctl_elem_info_t *obj, unsigned int val);
408const char *snd_ctl_elem_info_get_item_name(const snd_ctl_elem_info_t *obj);
409int snd_ctl_elem_info_get_dimensions(const snd_ctl_elem_info_t *obj);
410int snd_ctl_elem_info_get_dimension(const snd_ctl_elem_info_t *obj, unsigned int idx);
411void snd_ctl_elem_info_get_id(const snd_ctl_elem_info_t *obj, snd_ctl_elem_id_t *ptr);
412unsigned int snd_ctl_elem_info_get_numid(const snd_ctl_elem_info_t *obj);
413snd_ctl_elem_iface_t snd_ctl_elem_info_get_interface(const snd_ctl_elem_info_t *obj);
414unsigned int snd_ctl_elem_info_get_device(const snd_ctl_elem_info_t *obj);
415unsigned int snd_ctl_elem_info_get_subdevice(const snd_ctl_elem_info_t *obj);
416const char *snd_ctl_elem_info_get_name(const snd_ctl_elem_info_t *obj);
417unsigned int snd_ctl_elem_info_get_index(const snd_ctl_elem_info_t *obj);
418void snd_ctl_elem_info_set_id(snd_ctl_elem_info_t *obj, const snd_ctl_elem_id_t *ptr);
419void snd_ctl_elem_info_set_numid(snd_ctl_elem_info_t *obj, unsigned int val);
420void snd_ctl_elem_info_set_interface(snd_ctl_elem_info_t *obj, snd_ctl_elem_iface_t val);
421void snd_ctl_elem_info_set_device(snd_ctl_elem_info_t *obj, unsigned int val);
422void snd_ctl_elem_info_set_subdevice(snd_ctl_elem_info_t *obj, unsigned int val);
423void snd_ctl_elem_info_set_name(snd_ctl_elem_info_t *obj, const char *val);
424void snd_ctl_elem_info_set_index(snd_ctl_elem_info_t *obj, unsigned int val);
425
426int snd_ctl_elem_add_integer(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int count, long imin, long imax, long istep);
427int snd_ctl_elem_add_integer64(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int count, long long imin, long long imax, long long istep);
428int snd_ctl_elem_add_boolean(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int count);
429int snd_ctl_elem_add_enumerated(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int count, unsigned int items, const char *const names[]);
430int snd_ctl_elem_add_iec958(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id);
431int snd_ctl_elem_remove(snd_ctl_t *ctl, snd_ctl_elem_id_t *id);
432
433size_t snd_ctl_elem_value_sizeof(void);
434/** \hideinitializer
435 * \brief allocate an invalid #snd_ctl_elem_value_t using standard alloca
436 * \param ptr returned pointer
437 */
438#define snd_ctl_elem_value_alloca(ptr) __snd_alloca(ptr, snd_ctl_elem_value)
439int snd_ctl_elem_value_malloc(snd_ctl_elem_value_t **ptr);
440void snd_ctl_elem_value_free(snd_ctl_elem_value_t *obj);
441void snd_ctl_elem_value_clear(snd_ctl_elem_value_t *obj);
442void snd_ctl_elem_value_copy(snd_ctl_elem_value_t *dst, const snd_ctl_elem_value_t *src);
443int snd_ctl_elem_value_compare(snd_ctl_elem_value_t *left, const snd_ctl_elem_value_t *right);
444void snd_ctl_elem_value_get_id(const snd_ctl_elem_value_t *obj, snd_ctl_elem_id_t *ptr);
445unsigned int snd_ctl_elem_value_get_numid(const snd_ctl_elem_value_t *obj);
446snd_ctl_elem_iface_t snd_ctl_elem_value_get_interface(const snd_ctl_elem_value_t *obj);
447unsigned int snd_ctl_elem_value_get_device(const snd_ctl_elem_value_t *obj);
448unsigned int snd_ctl_elem_value_get_subdevice(const snd_ctl_elem_value_t *obj);
449const char *snd_ctl_elem_value_get_name(const snd_ctl_elem_value_t *obj);
450unsigned int snd_ctl_elem_value_get_index(const snd_ctl_elem_value_t *obj);
451void snd_ctl_elem_value_set_id(snd_ctl_elem_value_t *obj, const snd_ctl_elem_id_t *ptr);
452void snd_ctl_elem_value_set_numid(snd_ctl_elem_value_t *obj, unsigned int val);
453void snd_ctl_elem_value_set_interface(snd_ctl_elem_value_t *obj, snd_ctl_elem_iface_t val);
454void snd_ctl_elem_value_set_device(snd_ctl_elem_value_t *obj, unsigned int val);
455void snd_ctl_elem_value_set_subdevice(snd_ctl_elem_value_t *obj, unsigned int val);
456void snd_ctl_elem_value_set_name(snd_ctl_elem_value_t *obj, const char *val);
457void snd_ctl_elem_value_set_index(snd_ctl_elem_value_t *obj, unsigned int val);
458int snd_ctl_elem_value_get_boolean(const snd_ctl_elem_value_t *obj, unsigned int idx);
459long snd_ctl_elem_value_get_integer(const snd_ctl_elem_value_t *obj, unsigned int idx);
460long long snd_ctl_elem_value_get_integer64(const snd_ctl_elem_value_t *obj, unsigned int idx);
461unsigned int snd_ctl_elem_value_get_enumerated(const snd_ctl_elem_value_t *obj, unsigned int idx);
462unsigned char snd_ctl_elem_value_get_byte(const snd_ctl_elem_value_t *obj, unsigned int idx);
463void snd_ctl_elem_value_set_boolean(snd_ctl_elem_value_t *obj, unsigned int idx, long val);
464void snd_ctl_elem_value_set_integer(snd_ctl_elem_value_t *obj, unsigned int idx, long val);
465void snd_ctl_elem_value_set_integer64(snd_ctl_elem_value_t *obj, unsigned int idx, long long val);
466void snd_ctl_elem_value_set_enumerated(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned int val);
467void snd_ctl_elem_value_set_byte(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned char val);
468void snd_ctl_elem_set_bytes(snd_ctl_elem_value_t *obj, void *data, size_t size);
469const void * snd_ctl_elem_value_get_bytes(const snd_ctl_elem_value_t *obj);
470void snd_ctl_elem_value_get_iec958(const snd_ctl_elem_value_t *obj, snd_aes_iec958_t *ptr);
471void snd_ctl_elem_value_set_iec958(snd_ctl_elem_value_t *obj, const snd_aes_iec958_t *ptr);
472
473int snd_tlv_parse_dB_info(unsigned int *tlv, unsigned int tlv_size,
474 unsigned int **db_tlvp);
475int snd_tlv_get_dB_range(unsigned int *tlv, long rangemin, long rangemax,
476 long *min, long *max);
477int snd_tlv_convert_to_dB(unsigned int *tlv, long rangemin, long rangemax,
478 long volume, long *db_gain);
479int snd_tlv_convert_from_dB(unsigned int *tlv, long rangemin, long rangemax,
480 long db_gain, long *value, int xdir);
481int snd_ctl_get_dB_range(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
482 long *min, long *max);
483int snd_ctl_convert_to_dB(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
484 long volume, long *db_gain);
485int snd_ctl_convert_from_dB(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id,
486 long db_gain, long *value, int xdir);
487
488/**
489 * \defgroup HControl High level Control Interface
490 * \ingroup Control
491 * The high level control interface.
492 * See \ref hcontrol page for more details.
493 * \{
494 */
495
496/** HCTL element handle */
497typedef struct _snd_hctl_elem snd_hctl_elem_t;
498
499/** HCTL handle */
500typedef struct _snd_hctl snd_hctl_t;
501
502/**
503 * \brief Compare function for sorting HCTL elements
504 * \param e1 First element
505 * \param e2 Second element
506 * \return -1 if e1 < e2, 0 if e1 == e2, 1 if e1 > e2
507 */
508typedef int (*snd_hctl_compare_t)(const snd_hctl_elem_t *e1,
509 const snd_hctl_elem_t *e2);
510int snd_hctl_compare_fast(const snd_hctl_elem_t *c1,
511 const snd_hctl_elem_t *c2);
512/**
513 * \brief HCTL callback function
514 * \param hctl HCTL handle
515 * \param mask event mask
516 * \param elem related HCTL element (if any)
517 * \return 0 on success otherwise a negative error code
518 */
519typedef int (*snd_hctl_callback_t)(snd_hctl_t *hctl,
520 unsigned int mask,
521 snd_hctl_elem_t *elem);
522/**
523 * \brief HCTL element callback function
524 * \param elem HCTL element
525 * \param mask event mask
526 * \return 0 on success otherwise a negative error code
527 */
528typedef int (*snd_hctl_elem_callback_t)(snd_hctl_elem_t *elem,
529 unsigned int mask);
530
531int snd_hctl_open(snd_hctl_t **hctl, const char *name, int mode);
532int snd_hctl_open_ctl(snd_hctl_t **hctlp, snd_ctl_t *ctl);
533int snd_hctl_close(snd_hctl_t *hctl);
534int snd_hctl_nonblock(snd_hctl_t *hctl, int nonblock);
535static __inline__ int snd_hctl_abort(snd_hctl_t *hctl) { return snd_hctl_nonblock(hctl, 2); }
536int snd_hctl_poll_descriptors_count(snd_hctl_t *hctl);
537int snd_hctl_poll_descriptors(snd_hctl_t *hctl, struct pollfd *pfds, unsigned int space);
538int snd_hctl_poll_descriptors_revents(snd_hctl_t *ctl, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
539unsigned int snd_hctl_get_count(snd_hctl_t *hctl);
540int snd_hctl_set_compare(snd_hctl_t *hctl, snd_hctl_compare_t hsort);
541snd_hctl_elem_t *snd_hctl_first_elem(snd_hctl_t *hctl);
542snd_hctl_elem_t *snd_hctl_last_elem(snd_hctl_t *hctl);
543snd_hctl_elem_t *snd_hctl_find_elem(snd_hctl_t *hctl, const snd_ctl_elem_id_t *id);
544void snd_hctl_set_callback(snd_hctl_t *hctl, snd_hctl_callback_t callback);
545void snd_hctl_set_callback_private(snd_hctl_t *hctl, void *data);
546void *snd_hctl_get_callback_private(snd_hctl_t *hctl);
547int snd_hctl_load(snd_hctl_t *hctl);
548int snd_hctl_free(snd_hctl_t *hctl);
549int snd_hctl_handle_events(snd_hctl_t *hctl);
550const char *snd_hctl_name(snd_hctl_t *hctl);
551int snd_hctl_wait(snd_hctl_t *hctl, int timeout);
552snd_ctl_t *snd_hctl_ctl(snd_hctl_t *hctl);
553
554snd_hctl_elem_t *snd_hctl_elem_next(snd_hctl_elem_t *elem);
555snd_hctl_elem_t *snd_hctl_elem_prev(snd_hctl_elem_t *elem);
556int snd_hctl_elem_info(snd_hctl_elem_t *elem, snd_ctl_elem_info_t * info);
557int snd_hctl_elem_read(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
558int snd_hctl_elem_write(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
559int snd_hctl_elem_tlv_read(snd_hctl_elem_t *elem, unsigned int *tlv, unsigned int tlv_size);
560int snd_hctl_elem_tlv_write(snd_hctl_elem_t *elem, const unsigned int *tlv);
561int snd_hctl_elem_tlv_command(snd_hctl_elem_t *elem, const unsigned int *tlv);
562
563snd_hctl_t *snd_hctl_elem_get_hctl(snd_hctl_elem_t *elem);
564
565void snd_hctl_elem_get_id(const snd_hctl_elem_t *obj, snd_ctl_elem_id_t *ptr);
566unsigned int snd_hctl_elem_get_numid(const snd_hctl_elem_t *obj);
567snd_ctl_elem_iface_t snd_hctl_elem_get_interface(const snd_hctl_elem_t *obj);
568unsigned int snd_hctl_elem_get_device(const snd_hctl_elem_t *obj);
569unsigned int snd_hctl_elem_get_subdevice(const snd_hctl_elem_t *obj);
570const char *snd_hctl_elem_get_name(const snd_hctl_elem_t *obj);
571unsigned int snd_hctl_elem_get_index(const snd_hctl_elem_t *obj);
572void snd_hctl_elem_set_callback(snd_hctl_elem_t *obj, snd_hctl_elem_callback_t val);
573void * snd_hctl_elem_get_callback_private(const snd_hctl_elem_t *obj);
574void snd_hctl_elem_set_callback_private(snd_hctl_elem_t *obj, void * val);
575
576/** \} */
577
578/** \} */
579
580/**
581 * \defgroup SControl Setup Control Interface
582 * \ingroup Control
583 * The setup control interface - set or modify control elements from a configuration file.
584 * \{
585 */
586
587int snd_sctl_build(snd_sctl_t **ctl, snd_ctl_t *handle, snd_config_t *config,
588 snd_config_t *private_data, int mode);
589int snd_sctl_free(snd_sctl_t *handle);
590int snd_sctl_install(snd_sctl_t *handle);
591int snd_sctl_remove(snd_sctl_t *handle);
592
593/** \} */
594
595#ifdef __cplusplus
596}
597#endif
598
599#endif /* __ALSA_CONTROL_H */
600