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 178/** Mute state */ 179#define SND_CTL_TLV_DB_GAIN_MUTE -9999999 180 181/** CTL type */ 182typedef enum _snd_ctl_type { 183 /** Kernel level CTL */ 184 SND_CTL_TYPE_HW, 185 /** Shared memory client CTL */ 186 SND_CTL_TYPE_SHM, 187 /** INET client CTL (not yet implemented) */ 188 SND_CTL_TYPE_INET, 189 /** External control plugin */ 190 SND_CTL_TYPE_EXT 191} snd_ctl_type_t; 192 193/** Non blocking mode (flag for open mode) \hideinitializer */ 194#define SND_CTL_NONBLOCK 0x0001 195 196/** Async notification (flag for open mode) \hideinitializer */ 197#define SND_CTL_ASYNC 0x0002 198 199/** Read only (flag for open mode) \hideinitializer */ 200#define SND_CTL_READONLY 0x0004 201 202/** CTL handle */ 203typedef struct _snd_ctl snd_ctl_t; 204 205/** Don't destroy the ctl handle when close */ 206#define SND_SCTL_NOFREE 0x0001 207 208/** SCTL type */ 209typedef struct _snd_sctl snd_sctl_t; 210 211int snd_card_load(int card); 212int snd_card_next(int *card); 213int snd_card_get_index(const char *name); 214int snd_card_get_name(int card, char **name); 215int snd_card_get_longname(int card, char **name); 216 217int snd_device_name_hint(int card, const char *iface, void ***hints); 218int snd_device_name_free_hint(void **hints); 219char *snd_device_name_get_hint(const void *hint, const char *id); 220 221int snd_ctl_open(snd_ctl_t **ctl, const char *name, int mode); 222int snd_ctl_open_lconf(snd_ctl_t **ctl, const char *name, int mode, snd_config_t *lconf); 223int snd_ctl_close(snd_ctl_t *ctl); 224int snd_ctl_nonblock(snd_ctl_t *ctl, int nonblock); 225int snd_async_add_ctl_handler(snd_async_handler_t **handler, snd_ctl_t *ctl, 226 snd_async_callback_t callback, void *private_data); 227snd_ctl_t *snd_async_handler_get_ctl(snd_async_handler_t *handler); 228int snd_ctl_poll_descriptors_count(snd_ctl_t *ctl); 229int snd_ctl_poll_descriptors(snd_ctl_t *ctl, struct pollfd *pfds, unsigned int space); 230int snd_ctl_poll_descriptors_revents(snd_ctl_t *ctl, struct pollfd *pfds, unsigned int nfds, unsigned short *revents); 231int snd_ctl_subscribe_events(snd_ctl_t *ctl, int subscribe); 232int snd_ctl_card_info(snd_ctl_t *ctl, snd_ctl_card_info_t *info); 233int snd_ctl_elem_list(snd_ctl_t *ctl, snd_ctl_elem_list_t *list); 234int snd_ctl_elem_info(snd_ctl_t *ctl, snd_ctl_elem_info_t *info); 235int snd_ctl_elem_read(snd_ctl_t *ctl, snd_ctl_elem_value_t *value); 236int snd_ctl_elem_write(snd_ctl_t *ctl, snd_ctl_elem_value_t *value); 237int snd_ctl_elem_lock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id); 238int snd_ctl_elem_unlock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id); 239int snd_ctl_elem_tlv_read(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, 240 unsigned int *tlv, unsigned int tlv_size); 241int snd_ctl_elem_tlv_write(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, 242 const unsigned int *tlv); 243int snd_ctl_elem_tlv_command(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, 244 const unsigned int *tlv); 245int snd_ctl_hwdep_next_device(snd_ctl_t *ctl, int * device); 246int snd_ctl_hwdep_info(snd_ctl_t *ctl, snd_hwdep_info_t * info); 247int snd_ctl_pcm_next_device(snd_ctl_t *ctl, int *device); 248int snd_ctl_pcm_info(snd_ctl_t *ctl, snd_pcm_info_t * info); 249int snd_ctl_pcm_prefer_subdevice(snd_ctl_t *ctl, int subdev); 250int snd_ctl_rawmidi_next_device(snd_ctl_t *ctl, int * device); 251int snd_ctl_rawmidi_info(snd_ctl_t *ctl, snd_rawmidi_info_t * info); 252int snd_ctl_rawmidi_prefer_subdevice(snd_ctl_t *ctl, int subdev); 253int snd_ctl_set_power_state(snd_ctl_t *ctl, unsigned int state); 254int snd_ctl_get_power_state(snd_ctl_t *ctl, unsigned int *state); 255 256int snd_ctl_read(snd_ctl_t *ctl, snd_ctl_event_t *event); 257int snd_ctl_wait(snd_ctl_t *ctl, int timeout); 258const char *snd_ctl_name(snd_ctl_t *ctl); 259snd_ctl_type_t snd_ctl_type(snd_ctl_t *ctl); 260 261const char *snd_ctl_elem_type_name(snd_ctl_elem_type_t type); 262const char *snd_ctl_elem_iface_name(snd_ctl_elem_iface_t iface); 263const char *snd_ctl_event_type_name(snd_ctl_event_type_t type); 264 265unsigned int snd_ctl_event_elem_get_mask(const snd_ctl_event_t *obj); 266unsigned int snd_ctl_event_elem_get_numid(const snd_ctl_event_t *obj); 267void snd_ctl_event_elem_get_id(const snd_ctl_event_t *obj, snd_ctl_elem_id_t *ptr); 268snd_ctl_elem_iface_t snd_ctl_event_elem_get_interface(const snd_ctl_event_t *obj); 269unsigned int snd_ctl_event_elem_get_device(const snd_ctl_event_t *obj); 270unsigned int snd_ctl_event_elem_get_subdevice(const snd_ctl_event_t *obj); 271const char *snd_ctl_event_elem_get_name(const snd_ctl_event_t *obj); 272unsigned int snd_ctl_event_elem_get_index(const snd_ctl_event_t *obj); 273 274int snd_ctl_elem_list_alloc_space(snd_ctl_elem_list_t *obj, unsigned int entries); 275void snd_ctl_elem_list_free_space(snd_ctl_elem_list_t *obj); 276 277size_t snd_ctl_elem_id_sizeof(void); 278/** \hideinitializer 279 * \brief allocate an invalid #snd_ctl_elem_id_t using standard alloca 280 * \param ptr returned pointer 281 */ 282#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) 283int snd_ctl_elem_id_malloc(snd_ctl_elem_id_t **ptr); 284void snd_ctl_elem_id_free(snd_ctl_elem_id_t *obj); 285void snd_ctl_elem_id_clear(snd_ctl_elem_id_t *obj); 286void snd_ctl_elem_id_copy(snd_ctl_elem_id_t *dst, const snd_ctl_elem_id_t *src); 287unsigned int snd_ctl_elem_id_get_numid(const snd_ctl_elem_id_t *obj); 288snd_ctl_elem_iface_t snd_ctl_elem_id_get_interface(const snd_ctl_elem_id_t *obj); 289unsigned int snd_ctl_elem_id_get_device(const snd_ctl_elem_id_t *obj); 290unsigned int snd_ctl_elem_id_get_subdevice(const snd_ctl_elem_id_t *obj); 291const char *snd_ctl_elem_id_get_name(const snd_ctl_elem_id_t *obj); 292unsigned int snd_ctl_elem_id_get_index(const snd_ctl_elem_id_t *obj); 293void snd_ctl_elem_id_set_numid(snd_ctl_elem_id_t *obj, unsigned int val); 294void snd_ctl_elem_id_set_interface(snd_ctl_elem_id_t *obj, snd_ctl_elem_iface_t val); 295void snd_ctl_elem_id_set_device(snd_ctl_elem_id_t *obj, unsigned int val); 296void snd_ctl_elem_id_set_subdevice(snd_ctl_elem_id_t *obj, unsigned int val); 297void snd_ctl_elem_id_set_name(snd_ctl_elem_id_t *obj, const char *val); 298void snd_ctl_elem_id_set_index(snd_ctl_elem_id_t *obj, unsigned int val); 299 300size_t snd_ctl_card_info_sizeof(void); 301/** \hideinitializer 302 * \brief allocate an invalid #snd_ctl_card_info_t using standard alloca 303 * \param ptr returned pointer 304 */ 305#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) 306int snd_ctl_card_info_malloc(snd_ctl_card_info_t **ptr); 307void snd_ctl_card_info_free(snd_ctl_card_info_t *obj); 308void snd_ctl_card_info_clear(snd_ctl_card_info_t *obj); 309void snd_ctl_card_info_copy(snd_ctl_card_info_t *dst, const snd_ctl_card_info_t *src); 310int snd_ctl_card_info_get_card(const snd_ctl_card_info_t *obj); 311const char *snd_ctl_card_info_get_id(const snd_ctl_card_info_t *obj); 312const char *snd_ctl_card_info_get_driver(const snd_ctl_card_info_t *obj); 313const char *snd_ctl_card_info_get_name(const snd_ctl_card_info_t *obj); 314const char *snd_ctl_card_info_get_longname(const snd_ctl_card_info_t *obj); 315const char *snd_ctl_card_info_get_mixername(const snd_ctl_card_info_t *obj); 316const char *snd_ctl_card_info_get_components(const snd_ctl_card_info_t *obj); 317 318size_t snd_ctl_event_sizeof(void); 319/** \hideinitializer 320 * \brief allocate an invalid #snd_ctl_event_t using standard alloca 321 * \param ptr returned pointer 322 */ 323#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) 324int snd_ctl_event_malloc(snd_ctl_event_t **ptr); 325void snd_ctl_event_free(snd_ctl_event_t *obj); 326void snd_ctl_event_clear(snd_ctl_event_t *obj); 327void snd_ctl_event_copy(snd_ctl_event_t *dst, const snd_ctl_event_t *src); 328snd_ctl_event_type_t snd_ctl_event_get_type(const snd_ctl_event_t *obj); 329 330size_t snd_ctl_elem_list_sizeof(void); 331/** \hideinitializer 332 * \brief allocate an invalid #snd_ctl_elem_list_t using standard alloca 333 * \param ptr returned pointer 334 */ 335#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) 336int snd_ctl_elem_list_malloc(snd_ctl_elem_list_t **ptr); 337void snd_ctl_elem_list_free(snd_ctl_elem_list_t *obj); 338void snd_ctl_elem_list_clear(snd_ctl_elem_list_t *obj); 339void snd_ctl_elem_list_copy(snd_ctl_elem_list_t *dst, const snd_ctl_elem_list_t *src); 340void snd_ctl_elem_list_set_offset(snd_ctl_elem_list_t *obj, unsigned int val); 341unsigned int snd_ctl_elem_list_get_used(const snd_ctl_elem_list_t *obj); 342unsigned int snd_ctl_elem_list_get_count(const snd_ctl_elem_list_t *obj); 343void snd_ctl_elem_list_get_id(const snd_ctl_elem_list_t *obj, unsigned int idx, snd_ctl_elem_id_t *ptr); 344unsigned int snd_ctl_elem_list_get_numid(const snd_ctl_elem_list_t *obj, unsigned int idx); 345snd_ctl_elem_iface_t snd_ctl_elem_list_get_interface(const snd_ctl_elem_list_t *obj, unsigned int idx); 346unsigned int snd_ctl_elem_list_get_device(const snd_ctl_elem_list_t *obj, unsigned int idx); 347unsigned int snd_ctl_elem_list_get_subdevice(const snd_ctl_elem_list_t *obj, unsigned int idx); 348const char *snd_ctl_elem_list_get_name(const snd_ctl_elem_list_t *obj, unsigned int idx); 349unsigned int snd_ctl_elem_list_get_index(const snd_ctl_elem_list_t *obj, unsigned int idx); 350 351size_t snd_ctl_elem_info_sizeof(void); 352/** \hideinitializer 353 * \brief allocate an invalid #snd_ctl_elem_info_t using standard alloca 354 * \param ptr returned pointer 355 */ 356#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) 357int snd_ctl_elem_info_malloc(snd_ctl_elem_info_t **ptr); 358void snd_ctl_elem_info_free(snd_ctl_elem_info_t *obj); 359void snd_ctl_elem_info_clear(snd_ctl_elem_info_t *obj); 360void snd_ctl_elem_info_copy(snd_ctl_elem_info_t *dst, const snd_ctl_elem_info_t *src); 361snd_ctl_elem_type_t snd_ctl_elem_info_get_type(const snd_ctl_elem_info_t *obj); 362int snd_ctl_elem_info_is_readable(const snd_ctl_elem_info_t *obj); 363int snd_ctl_elem_info_is_writable(const snd_ctl_elem_info_t *obj); 364int snd_ctl_elem_info_is_volatile(const snd_ctl_elem_info_t *obj); 365int snd_ctl_elem_info_is_inactive(const snd_ctl_elem_info_t *obj); 366int snd_ctl_elem_info_is_locked(const snd_ctl_elem_info_t *obj); 367int snd_ctl_elem_info_is_tlv_readable(const snd_ctl_elem_info_t *obj); 368int snd_ctl_elem_info_is_tlv_writable(const snd_ctl_elem_info_t *obj); 369int snd_ctl_elem_info_is_tlv_commandable(const snd_ctl_elem_info_t *obj); 370int snd_ctl_elem_info_is_owner(const snd_ctl_elem_info_t *obj); 371int snd_ctl_elem_info_is_user(const snd_ctl_elem_info_t *obj); 372pid_t snd_ctl_elem_info_get_owner(const snd_ctl_elem_info_t *obj); 373unsigned int snd_ctl_elem_info_get_count(const snd_ctl_elem_info_t *obj); 374long snd_ctl_elem_info_get_min(const snd_ctl_elem_info_t *obj); 375long snd_ctl_elem_info_get_max(const snd_ctl_elem_info_t *obj); 376long snd_ctl_elem_info_get_step(const snd_ctl_elem_info_t *obj); 377long long snd_ctl_elem_info_get_min64(const snd_ctl_elem_info_t *obj); 378long long snd_ctl_elem_info_get_max64(const snd_ctl_elem_info_t *obj); 379long long snd_ctl_elem_info_get_step64(const snd_ctl_elem_info_t *obj); 380unsigned int snd_ctl_elem_info_get_items(const snd_ctl_elem_info_t *obj); 381void snd_ctl_elem_info_set_item(snd_ctl_elem_info_t *obj, unsigned int val); 382const char *snd_ctl_elem_info_get_item_name(const snd_ctl_elem_info_t *obj); 383int snd_ctl_elem_info_get_dimensions(const snd_ctl_elem_info_t *obj); 384int snd_ctl_elem_info_get_dimension(const snd_ctl_elem_info_t *obj, unsigned int idx); 385void snd_ctl_elem_info_get_id(const snd_ctl_elem_info_t *obj, snd_ctl_elem_id_t *ptr); 386unsigned int snd_ctl_elem_info_get_numid(const snd_ctl_elem_info_t *obj); 387snd_ctl_elem_iface_t snd_ctl_elem_info_get_interface(const snd_ctl_elem_info_t *obj); 388unsigned int snd_ctl_elem_info_get_device(const snd_ctl_elem_info_t *obj); 389unsigned int snd_ctl_elem_info_get_subdevice(const snd_ctl_elem_info_t *obj); 390const char *snd_ctl_elem_info_get_name(const snd_ctl_elem_info_t *obj); 391unsigned int snd_ctl_elem_info_get_index(const snd_ctl_elem_info_t *obj); 392void snd_ctl_elem_info_set_id(snd_ctl_elem_info_t *obj, const snd_ctl_elem_id_t *ptr); 393void snd_ctl_elem_info_set_numid(snd_ctl_elem_info_t *obj, unsigned int val); 394void snd_ctl_elem_info_set_interface(snd_ctl_elem_info_t *obj, snd_ctl_elem_iface_t val); 395void snd_ctl_elem_info_set_device(snd_ctl_elem_info_t *obj, unsigned int val); 396void snd_ctl_elem_info_set_subdevice(snd_ctl_elem_info_t *obj, unsigned int val); 397void snd_ctl_elem_info_set_name(snd_ctl_elem_info_t *obj, const char *val); 398void snd_ctl_elem_info_set_index(snd_ctl_elem_info_t *obj, unsigned int val); 399 400int 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); 401int 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); 402int snd_ctl_elem_add_boolean(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id, unsigned int count); 403int snd_ctl_elem_add_iec958(snd_ctl_t *ctl, const snd_ctl_elem_id_t *id); 404int snd_ctl_elem_remove(snd_ctl_t *ctl, snd_ctl_elem_id_t *id); 405 406size_t snd_ctl_elem_value_sizeof(void); 407/** \hideinitializer 408 * \brief allocate an invalid #snd_ctl_elem_value_t using standard alloca 409 * \param ptr returned pointer 410 */ 411#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) 412int snd_ctl_elem_value_malloc(snd_ctl_elem_value_t **ptr); 413void snd_ctl_elem_value_free(snd_ctl_elem_value_t *obj); 414void snd_ctl_elem_value_clear(snd_ctl_elem_value_t *obj); 415void snd_ctl_elem_value_copy(snd_ctl_elem_value_t *dst, const snd_ctl_elem_value_t *src); 416void snd_ctl_elem_value_get_id(const snd_ctl_elem_value_t *obj, snd_ctl_elem_id_t *ptr); 417unsigned int snd_ctl_elem_value_get_numid(const snd_ctl_elem_value_t *obj); 418snd_ctl_elem_iface_t snd_ctl_elem_value_get_interface(const snd_ctl_elem_value_t *obj); 419unsigned int snd_ctl_elem_value_get_device(const snd_ctl_elem_value_t *obj); 420unsigned int snd_ctl_elem_value_get_subdevice(const snd_ctl_elem_value_t *obj); 421const char *snd_ctl_elem_value_get_name(const snd_ctl_elem_value_t *obj); 422unsigned int snd_ctl_elem_value_get_index(const snd_ctl_elem_value_t *obj); 423void snd_ctl_elem_value_set_id(snd_ctl_elem_value_t *obj, const snd_ctl_elem_id_t *ptr); 424void snd_ctl_elem_value_set_numid(snd_ctl_elem_value_t *obj, unsigned int val); 425void snd_ctl_elem_value_set_interface(snd_ctl_elem_value_t *obj, snd_ctl_elem_iface_t val); 426void snd_ctl_elem_value_set_device(snd_ctl_elem_value_t *obj, unsigned int val); 427void snd_ctl_elem_value_set_subdevice(snd_ctl_elem_value_t *obj, unsigned int val); 428void snd_ctl_elem_value_set_name(snd_ctl_elem_value_t *obj, const char *val); 429void snd_ctl_elem_value_set_index(snd_ctl_elem_value_t *obj, unsigned int val); 430int snd_ctl_elem_value_get_boolean(const snd_ctl_elem_value_t *obj, unsigned int idx); 431long snd_ctl_elem_value_get_integer(const snd_ctl_elem_value_t *obj, unsigned int idx); 432long long snd_ctl_elem_value_get_integer64(const snd_ctl_elem_value_t *obj, unsigned int idx); 433unsigned int snd_ctl_elem_value_get_enumerated(const snd_ctl_elem_value_t *obj, unsigned int idx); 434unsigned char snd_ctl_elem_value_get_byte(const snd_ctl_elem_value_t *obj, unsigned int idx); 435void snd_ctl_elem_value_set_boolean(snd_ctl_elem_value_t *obj, unsigned int idx, long val); 436void snd_ctl_elem_value_set_integer(snd_ctl_elem_value_t *obj, unsigned int idx, long val); 437void snd_ctl_elem_value_set_integer64(snd_ctl_elem_value_t *obj, unsigned int idx, long long val); 438void snd_ctl_elem_value_set_enumerated(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned int val); 439void snd_ctl_elem_value_set_byte(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned char val); 440void snd_ctl_elem_set_bytes(snd_ctl_elem_value_t *obj, void *data, size_t size); 441const void * snd_ctl_elem_value_get_bytes(const snd_ctl_elem_value_t *obj); 442void snd_ctl_elem_value_get_iec958(const snd_ctl_elem_value_t *obj, snd_aes_iec958_t *ptr); 443void snd_ctl_elem_value_set_iec958(snd_ctl_elem_value_t *obj, const snd_aes_iec958_t *ptr); 444 445/** 446 * \defgroup HControl High level Control Interface 447 * \ingroup Control 448 * The high level control interface. 449 * See \ref hcontrol page for more details. 450 * \{ 451 */ 452 453/** HCTL element handle */ 454typedef struct _snd_hctl_elem snd_hctl_elem_t; 455 456/** HCTL handle */ 457typedef struct _snd_hctl snd_hctl_t; 458 459/** 460 * \brief Compare function for sorting HCTL elements 461 * \param e1 First element 462 * \param e2 Second element 463 * \return -1 if e1 < e2, 0 if e1 == e2, 1 if e1 > e2 464 */ 465typedef int (*snd_hctl_compare_t)(const snd_hctl_elem_t *e1, 466 const snd_hctl_elem_t *e2); 467int snd_hctl_compare_fast(const snd_hctl_elem_t *c1, 468 const snd_hctl_elem_t *c2); 469/** 470 * \brief HCTL callback function 471 * \param hctl HCTL handle 472 * \param mask event mask 473 * \param elem related HCTL element (if any) 474 * \return 0 on success otherwise a negative error code 475 */ 476typedef int (*snd_hctl_callback_t)(snd_hctl_t *hctl, 477 unsigned int mask, 478 snd_hctl_elem_t *elem); 479/** 480 * \brief HCTL element callback function 481 * \param elem HCTL element 482 * \param mask event mask 483 * \return 0 on success otherwise a negative error code 484 */ 485typedef int (*snd_hctl_elem_callback_t)(snd_hctl_elem_t *elem, 486 unsigned int mask); 487 488int snd_hctl_open(snd_hctl_t **hctl, const char *name, int mode); 489int snd_hctl_open_ctl(snd_hctl_t **hctlp, snd_ctl_t *ctl); 490int snd_hctl_close(snd_hctl_t *hctl); 491int snd_hctl_nonblock(snd_hctl_t *hctl, int nonblock); 492int snd_hctl_poll_descriptors_count(snd_hctl_t *hctl); 493int snd_hctl_poll_descriptors(snd_hctl_t *hctl, struct pollfd *pfds, unsigned int space); 494int snd_hctl_poll_descriptors_revents(snd_hctl_t *ctl, struct pollfd *pfds, unsigned int nfds, unsigned short *revents); 495unsigned int snd_hctl_get_count(snd_hctl_t *hctl); 496int snd_hctl_set_compare(snd_hctl_t *hctl, snd_hctl_compare_t hsort); 497snd_hctl_elem_t *snd_hctl_first_elem(snd_hctl_t *hctl); 498snd_hctl_elem_t *snd_hctl_last_elem(snd_hctl_t *hctl); 499snd_hctl_elem_t *snd_hctl_find_elem(snd_hctl_t *hctl, const snd_ctl_elem_id_t *id); 500void snd_hctl_set_callback(snd_hctl_t *hctl, snd_hctl_callback_t callback); 501void snd_hctl_set_callback_private(snd_hctl_t *hctl, void *data); 502void *snd_hctl_get_callback_private(snd_hctl_t *hctl); 503int snd_hctl_load(snd_hctl_t *hctl); 504int snd_hctl_free(snd_hctl_t *hctl); 505int snd_hctl_handle_events(snd_hctl_t *hctl); 506const char *snd_hctl_name(snd_hctl_t *hctl); 507int snd_hctl_wait(snd_hctl_t *hctl, int timeout); 508snd_ctl_t *snd_hctl_ctl(snd_hctl_t *hctl); 509 510snd_hctl_elem_t *snd_hctl_elem_next(snd_hctl_elem_t *elem); 511snd_hctl_elem_t *snd_hctl_elem_prev(snd_hctl_elem_t *elem); 512int snd_hctl_elem_info(snd_hctl_elem_t *elem, snd_ctl_elem_info_t * info); 513int snd_hctl_elem_read(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value); 514int snd_hctl_elem_write(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value); 515int snd_hctl_elem_tlv_read(snd_hctl_elem_t *elem, unsigned int *tlv, unsigned int tlv_size); 516int snd_hctl_elem_tlv_write(snd_hctl_elem_t *elem, const unsigned int *tlv); 517int snd_hctl_elem_tlv_command(snd_hctl_elem_t *elem, const unsigned int *tlv); 518 519snd_hctl_t *snd_hctl_elem_get_hctl(snd_hctl_elem_t *elem); 520 521void snd_hctl_elem_get_id(const snd_hctl_elem_t *obj, snd_ctl_elem_id_t *ptr); 522unsigned int snd_hctl_elem_get_numid(const snd_hctl_elem_t *obj); 523snd_ctl_elem_iface_t snd_hctl_elem_get_interface(const snd_hctl_elem_t *obj); 524unsigned int snd_hctl_elem_get_device(const snd_hctl_elem_t *obj); 525unsigned int snd_hctl_elem_get_subdevice(const snd_hctl_elem_t *obj); 526const char *snd_hctl_elem_get_name(const snd_hctl_elem_t *obj); 527unsigned int snd_hctl_elem_get_index(const snd_hctl_elem_t *obj); 528void snd_hctl_elem_set_callback(snd_hctl_elem_t *obj, snd_hctl_elem_callback_t val); 529void * snd_hctl_elem_get_callback_private(const snd_hctl_elem_t *obj); 530void snd_hctl_elem_set_callback_private(snd_hctl_elem_t *obj, void * val); 531 532/** \} */ 533 534/** \} */ 535 536/** 537 * \defgroup SControl Setup Control Interface 538 * \ingroup Control 539 * The setup control interface - set or modify control elements from a configuration file. 540 * \{ 541 */ 542 543int snd_sctl_build(snd_sctl_t **ctl, snd_ctl_t *handle, snd_config_t *config, 544 snd_config_t *private_data, int mode); 545int snd_sctl_free(snd_sctl_t *handle); 546int snd_sctl_install(snd_sctl_t *handle); 547int snd_sctl_remove(snd_sctl_t *handle); 548 549/** \} */ 550 551#ifdef __cplusplus 552} 553#endif 554 555#endif /* __ALSA_CONTROL_H */ 556