include/control.h

   1 /**
   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>
   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
  32 extern "C" {
  33 #endif
  34
  35 /**
  36  *  \defgroup Control Control Interface
  37  *  The control interface.
  38  *  \{
  39  */
  40
  41 /** dlsym version for interface entry callback */
  42 #define SND_CONTROL_DLSYM_VERSION       _dlsym_control_001
  43
  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 */
  50 } snd_aes_iec958_t;
  51
  52 /** CTL card info container */
  53 typedef struct _snd_ctl_card_info snd_ctl_card_info_t;
  54
  55 /** CTL element identificator container */
  56 typedef struct _snd_ctl_elem_id snd_ctl_elem_id_t;
  57
  58 /** CTL element identificator list container */
  59 typedef struct _snd_ctl_elem_list snd_ctl_elem_list_t;
  60
  61 /** CTL element info container */
  62 typedef struct _snd_ctl_elem_info snd_ctl_elem_info_t;
  63
  64 /** CTL element value container */
  65 typedef struct _snd_ctl_elem_value snd_ctl_elem_value_t;
  66
  67 /** CTL event container */
  68 typedef struct _snd_ctl_event snd_ctl_event_t;
  69
  70 /** CTL element type */
  71 typedef enum _snd_ctl_elem_type {
  72         /** Invalid 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,
  80         /** Bytes contents */
  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;
  86
  87 /** CTL related interface */
  88 typedef enum _snd_ctl_elem_iface {
  89         /** Card level */
  90         SND_CTL_ELEM_IFACE_CARD = 0,
  91         /** Hardware dependent device */
  92         SND_CTL_ELEM_IFACE_HWDEP,
  93         /** Mixer */
  94         SND_CTL_ELEM_IFACE_MIXER,
  95         /** PCM */
  96         SND_CTL_ELEM_IFACE_PCM,
  97         /** RawMidi */
  98         SND_CTL_ELEM_IFACE_RAWMIDI,
  99         /** Timer */
 100         SND_CTL_ELEM_IFACE_TIMER,
 101         /** Sequencer */
 102         SND_CTL_ELEM_IFACE_SEQUENCER,
 103         SND_CTL_ELEM_IFACE_LAST = SND_CTL_ELEM_IFACE_SEQUENCER,
 104 } snd_ctl_elem_iface_t;
 105
 106 /** Event class */
 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;
 112
 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)
 122
 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 "
 129
 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
 148
 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)
 163
 164 /** CTL type */
 165 typedef enum _snd_ctl_type {
 166         /** Kernel level CTL */
 167         SND_CTL_TYPE_HW,
 168         /** Shared memory client CTL */
 169         SND_CTL_TYPE_SHM,
 170         /** INET client CTL (not yet implemented) */
 171         SND_CTL_TYPE_INET
 172 } snd_ctl_type_t;
 173
 174 /** Non blocking mode \hideinitializer */
 175 #define SND_CTL_NONBLOCK                0x0001
 176
 177 /** Async notification \hideinitializer */
 178 #define SND_CTL_ASYNC                   0x0002
 179
 180 /** CTL handle */
 181 typedef struct _snd_ctl snd_ctl_t;
 182
 183 /** Don't destroy the ctl handle when close */
 184 #define SND_SCTL_NOFREE                 0x0001
 185
 186 /** SCTL type */
 187 typedef struct _snd_sctl snd_sctl_t;
 188
 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);
 194
 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_poll_descriptors_revents(snd_ctl_t *ctl, struct pollfd *pfds, unsigned int nfds, unsigned short *revents);
 205 int snd_ctl_subscribe_events(snd_ctl_t *ctl, int subscribe);
 206 int snd_ctl_card_info(snd_ctl_t *ctl, snd_ctl_card_info_t *info);
 207 int snd_ctl_elem_list(snd_ctl_t *ctl, snd_ctl_elem_list_t * list);
 208 int snd_ctl_elem_info(snd_ctl_t *ctl, snd_ctl_elem_info_t *info);
 209 int snd_ctl_elem_read(snd_ctl_t *ctl, snd_ctl_elem_value_t *value);
 210 int snd_ctl_elem_write(snd_ctl_t *ctl, snd_ctl_elem_value_t *value);
 211 int snd_ctl_elem_lock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id);
 212 int snd_ctl_elem_unlock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id);
 213 int snd_ctl_hwdep_next_device(snd_ctl_t *ctl, int * device);
 214 int snd_ctl_hwdep_info(snd_ctl_t *ctl, snd_hwdep_info_t * info);
 215 int snd_ctl_pcm_next_device(snd_ctl_t *ctl, int *device);
 216 int snd_ctl_pcm_info(snd_ctl_t *ctl, snd_pcm_info_t * info);
 217 int snd_ctl_pcm_prefer_subdevice(snd_ctl_t *ctl, int subdev);
 218 int snd_ctl_rawmidi_next_device(snd_ctl_t *ctl, int * device);
 219 int snd_ctl_rawmidi_info(snd_ctl_t *ctl, snd_rawmidi_info_t * info);
 220 int snd_ctl_rawmidi_prefer_subdevice(snd_ctl_t *ctl, int subdev);
 221 int snd_ctl_set_power_state(snd_ctl_t *ctl, unsigned int state);
 222 int snd_ctl_get_power_state(snd_ctl_t *ctl, unsigned int *state);
 223
 224 int snd_ctl_read(snd_ctl_t *ctl, snd_ctl_event_t *event);
 225 int snd_ctl_wait(snd_ctl_t *ctl, int timeout);
 226 const char *snd_ctl_name(snd_ctl_t *ctl);
 227 snd_ctl_type_t snd_ctl_type(snd_ctl_t *ctl);
 228
 229 void snd_ctl_elem_set_bytes(snd_ctl_elem_value_t *obj, void *data, size_t size);
 230 const char *snd_ctl_elem_type_name(snd_ctl_elem_type_t type);
 231 const char *snd_ctl_elem_iface_name(snd_ctl_elem_iface_t iface);
 232 const char *snd_ctl_event_type_name(snd_ctl_event_type_t type);
 233
 234 unsigned int snd_ctl_event_elem_get_mask(const snd_ctl_event_t *obj);
 235 unsigned int snd_ctl_event_elem_get_numid(const snd_ctl_event_t *obj);
 236 void snd_ctl_event_elem_get_id(const snd_ctl_event_t *obj, snd_ctl_elem_id_t *ptr);
 237 snd_ctl_elem_iface_t snd_ctl_event_elem_get_interface(const snd_ctl_event_t *obj);
 238 unsigned int snd_ctl_event_elem_get_device(const snd_ctl_event_t *obj);
 239 unsigned int snd_ctl_event_elem_get_subdevice(const snd_ctl_event_t *obj);
 240 const char *snd_ctl_event_elem_get_name(const snd_ctl_event_t *obj);
 241 unsigned int snd_ctl_event_elem_get_index(const snd_ctl_event_t *obj);
 242
 243 int snd_ctl_elem_list_alloc_space(snd_ctl_elem_list_t *obj, unsigned int entries);
 244 void snd_ctl_elem_list_free_space(snd_ctl_elem_list_t *obj);
 245
 246 size_t snd_ctl_elem_id_sizeof(void);
 247 /** \hideinitializer
 248  * \brief allocate an invalid #snd_ctl_elem_id_t using standard alloca
 249  * \param ptr returned pointer
 250  */
 251 #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)
 252 int snd_ctl_elem_id_malloc(snd_ctl_elem_id_t **ptr);
 253 void snd_ctl_elem_id_free(snd_ctl_elem_id_t *obj);
 254 void snd_ctl_elem_id_clear(snd_ctl_elem_id_t *obj);
 255 void snd_ctl_elem_id_copy(snd_ctl_elem_id_t *dst, const snd_ctl_elem_id_t *src);
 256 unsigned int snd_ctl_elem_id_get_numid(const snd_ctl_elem_id_t *obj);
 257 snd_ctl_elem_iface_t snd_ctl_elem_id_get_interface(const snd_ctl_elem_id_t *obj);
 258 unsigned int snd_ctl_elem_id_get_device(const snd_ctl_elem_id_t *obj);
 259 unsigned int snd_ctl_elem_id_get_subdevice(const snd_ctl_elem_id_t *obj);
 260 const char *snd_ctl_elem_id_get_name(const snd_ctl_elem_id_t *obj);
 261 unsigned int snd_ctl_elem_id_get_index(const snd_ctl_elem_id_t *obj);
 262 void snd_ctl_elem_id_set_numid(snd_ctl_elem_id_t *obj, unsigned int val);
 263 void snd_ctl_elem_id_set_interface(snd_ctl_elem_id_t *obj, snd_ctl_elem_iface_t val);
 264 void snd_ctl_elem_id_set_device(snd_ctl_elem_id_t *obj, unsigned int val);
 265 void snd_ctl_elem_id_set_subdevice(snd_ctl_elem_id_t *obj, unsigned int val);
 266 void snd_ctl_elem_id_set_name(snd_ctl_elem_id_t *obj, const char *val);
 267 void snd_ctl_elem_id_set_index(snd_ctl_elem_id_t *obj, unsigned int val);
 268
 269 size_t snd_ctl_card_info_sizeof(void);
 270 /** \hideinitializer
 271  * \brief allocate an invalid #snd_ctl_card_info_t using standard alloca
 272  * \param ptr returned pointer
 273  */
 274 #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)
 275 int snd_ctl_card_info_malloc(snd_ctl_card_info_t **ptr);
 276 void snd_ctl_card_info_free(snd_ctl_card_info_t *obj);
 277 void snd_ctl_card_info_clear(snd_ctl_card_info_t *obj);
 278 void snd_ctl_card_info_copy(snd_ctl_card_info_t *dst, const snd_ctl_card_info_t *src);
 279 int snd_ctl_card_info_get_card(const snd_ctl_card_info_t *obj);
 280 const char *snd_ctl_card_info_get_id(const snd_ctl_card_info_t *obj);
 281 const char *snd_ctl_card_info_get_driver(const snd_ctl_card_info_t *obj);
 282 const char *snd_ctl_card_info_get_name(const snd_ctl_card_info_t *obj);
 283 const char *snd_ctl_card_info_get_longname(const snd_ctl_card_info_t *obj);
 284 const char *snd_ctl_card_info_get_mixername(const snd_ctl_card_info_t *obj);
 285 const char *snd_ctl_card_info_get_components(const snd_ctl_card_info_t *obj);
 286
 287 size_t snd_ctl_event_sizeof(void);
 288 /** \hideinitializer
 289  * \brief allocate an invalid #snd_ctl_event_t using standard alloca
 290  * \param ptr returned pointer
 291  */
 292 #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)
 293 int snd_ctl_event_malloc(snd_ctl_event_t **ptr);
 294 void snd_ctl_event_free(snd_ctl_event_t *obj);
 295 void snd_ctl_event_clear(snd_ctl_event_t *obj);
 296 void snd_ctl_event_copy(snd_ctl_event_t *dst, const snd_ctl_event_t *src);
 297 snd_ctl_event_type_t snd_ctl_event_get_type(const snd_ctl_event_t *obj);
 298
 299 size_t snd_ctl_elem_list_sizeof(void);
 300 /** \hideinitializer
 301  * \brief allocate an invalid #snd_ctl_elem_list_t using standard alloca
 302  * \param ptr returned pointer
 303  */
 304 #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)
 305 int snd_ctl_elem_list_malloc(snd_ctl_elem_list_t **ptr);
 306 void snd_ctl_elem_list_free(snd_ctl_elem_list_t *obj);
 307 void snd_ctl_elem_list_clear(snd_ctl_elem_list_t *obj);
 308 void snd_ctl_elem_list_copy(snd_ctl_elem_list_t *dst, const snd_ctl_elem_list_t *src);
 309 void snd_ctl_elem_list_set_offset(snd_ctl_elem_list_t *obj, unsigned int val);
 310 unsigned int snd_ctl_elem_list_get_used(const snd_ctl_elem_list_t *obj);
 311 unsigned int snd_ctl_elem_list_get_count(const snd_ctl_elem_list_t *obj);
 312 void snd_ctl_elem_list_get_id(const snd_ctl_elem_list_t *obj, unsigned int idx, snd_ctl_elem_id_t *ptr);
 313 unsigned int snd_ctl_elem_list_get_numid(const snd_ctl_elem_list_t *obj, unsigned int idx);
 314 snd_ctl_elem_iface_t snd_ctl_elem_list_get_interface(const snd_ctl_elem_list_t *obj, unsigned int idx);
 315 unsigned int snd_ctl_elem_list_get_device(const snd_ctl_elem_list_t *obj, unsigned int idx);
 316 unsigned int snd_ctl_elem_list_get_subdevice(const snd_ctl_elem_list_t *obj, unsigned int idx);
 317 const char *snd_ctl_elem_list_get_name(const snd_ctl_elem_list_t *obj, unsigned int idx);
 318 unsigned int snd_ctl_elem_list_get_index(const snd_ctl_elem_list_t *obj, unsigned int idx);
 319
 320 size_t snd_ctl_elem_info_sizeof(void);
 321 /** \hideinitializer
 322  * \brief allocate an invalid #snd_ctl_elem_info_t using standard alloca
 323  * \param ptr returned pointer
 324  */
 325 #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)
 326 int snd_ctl_elem_info_malloc(snd_ctl_elem_info_t **ptr);
 327 void snd_ctl_elem_info_free(snd_ctl_elem_info_t *obj);
 328 void snd_ctl_elem_info_clear(snd_ctl_elem_info_t *obj);
 329 void snd_ctl_elem_info_copy(snd_ctl_elem_info_t *dst, const snd_ctl_elem_info_t *src);
 330 snd_ctl_elem_type_t snd_ctl_elem_info_get_type(const snd_ctl_elem_info_t *obj);
 331 int snd_ctl_elem_info_is_readable(const snd_ctl_elem_info_t *obj);
 332 int snd_ctl_elem_info_is_writable(const snd_ctl_elem_info_t *obj);
 333 int snd_ctl_elem_info_is_volatile(const snd_ctl_elem_info_t *obj);
 334 int snd_ctl_elem_info_is_inactive(const snd_ctl_elem_info_t *obj);
 335 int snd_ctl_elem_info_is_locked(const snd_ctl_elem_info_t *obj);
 336 int snd_ctl_elem_info_is_owner(const snd_ctl_elem_info_t *obj);
 337 int snd_ctl_elem_info_is_indirect(const snd_ctl_elem_info_t *obj);
 338 pid_t snd_ctl_elem_info_get_owner(const snd_ctl_elem_info_t *obj);
 339 unsigned int snd_ctl_elem_info_get_count(const snd_ctl_elem_info_t *obj);
 340 long snd_ctl_elem_info_get_min(const snd_ctl_elem_info_t *obj);
 341 long snd_ctl_elem_info_get_max(const snd_ctl_elem_info_t *obj);
 342 long snd_ctl_elem_info_get_step(const snd_ctl_elem_info_t *obj);
 343 unsigned int snd_ctl_elem_info_get_items(const snd_ctl_elem_info_t *obj);
 344 void snd_ctl_elem_info_set_item(snd_ctl_elem_info_t *obj, unsigned int val);
 345 const char *snd_ctl_elem_info_get_item_name(const snd_ctl_elem_info_t *obj);
 346 void snd_ctl_elem_info_get_id(const snd_ctl_elem_info_t *obj, snd_ctl_elem_id_t *ptr);
 347 unsigned int snd_ctl_elem_info_get_numid(const snd_ctl_elem_info_t *obj);
 348 snd_ctl_elem_iface_t snd_ctl_elem_info_get_interface(const snd_ctl_elem_info_t *obj);
 349 unsigned int snd_ctl_elem_info_get_device(const snd_ctl_elem_info_t *obj);
 350 unsigned int snd_ctl_elem_info_get_subdevice(const snd_ctl_elem_info_t *obj);
 351 const char *snd_ctl_elem_info_get_name(const snd_ctl_elem_info_t *obj);
 352 unsigned int snd_ctl_elem_info_get_index(const snd_ctl_elem_info_t *obj);
 353 void snd_ctl_elem_info_set_id(snd_ctl_elem_info_t *obj, const snd_ctl_elem_id_t *ptr);
 354 void snd_ctl_elem_info_set_numid(snd_ctl_elem_info_t *obj, unsigned int val);
 355 void snd_ctl_elem_info_set_interface(snd_ctl_elem_info_t *obj, snd_ctl_elem_iface_t val);
 356 void snd_ctl_elem_info_set_device(snd_ctl_elem_info_t *obj, unsigned int val);
 357 void snd_ctl_elem_info_set_subdevice(snd_ctl_elem_info_t *obj, unsigned int val);
 358 void snd_ctl_elem_info_set_name(snd_ctl_elem_info_t *obj, const char *val);
 359 void snd_ctl_elem_info_set_index(snd_ctl_elem_info_t *obj, unsigned int val);
 360
 361 size_t snd_ctl_elem_value_sizeof(void);
 362 /** \hideinitializer
 363  * \brief allocate an invalid #snd_ctl_elem_value_t using standard alloca
 364  * \param ptr returned pointer
 365  */
 366 #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)
 367 int snd_ctl_elem_value_malloc(snd_ctl_elem_value_t **ptr);
 368 void snd_ctl_elem_value_free(snd_ctl_elem_value_t *obj);
 369 void snd_ctl_elem_value_clear(snd_ctl_elem_value_t *obj);
 370 void snd_ctl_elem_value_copy(snd_ctl_elem_value_t *dst, const snd_ctl_elem_value_t *src);
 371 void snd_ctl_elem_value_get_id(const snd_ctl_elem_value_t *obj, snd_ctl_elem_id_t *ptr);
 372 unsigned int snd_ctl_elem_value_get_numid(const snd_ctl_elem_value_t *obj);
 373 snd_ctl_elem_iface_t snd_ctl_elem_value_get_interface(const snd_ctl_elem_value_t *obj);
 374 unsigned int snd_ctl_elem_value_get_device(const snd_ctl_elem_value_t *obj);
 375 unsigned int snd_ctl_elem_value_get_subdevice(const snd_ctl_elem_value_t *obj);
 376 const char *snd_ctl_elem_value_get_name(const snd_ctl_elem_value_t *obj);
 377 unsigned int snd_ctl_elem_value_get_index(const snd_ctl_elem_value_t *obj);
 378 void snd_ctl_elem_value_set_id(snd_ctl_elem_value_t *obj, const snd_ctl_elem_id_t *ptr);
 379 void snd_ctl_elem_value_set_numid(snd_ctl_elem_value_t *obj, unsigned int val);
 380 void snd_ctl_elem_value_set_interface(snd_ctl_elem_value_t *obj, snd_ctl_elem_iface_t val);
 381 void snd_ctl_elem_value_set_device(snd_ctl_elem_value_t *obj, unsigned int val);
 382 void snd_ctl_elem_value_set_subdevice(snd_ctl_elem_value_t *obj, unsigned int val);
 383 void snd_ctl_elem_value_set_name(snd_ctl_elem_value_t *obj, const char *val);
 384 void snd_ctl_elem_value_set_index(snd_ctl_elem_value_t *obj, unsigned int val);
 385 int snd_ctl_elem_value_get_boolean(const snd_ctl_elem_value_t *obj, unsigned int idx);
 386 long snd_ctl_elem_value_get_integer(const snd_ctl_elem_value_t *obj, unsigned int idx);
 387 unsigned int snd_ctl_elem_value_get_enumerated(const snd_ctl_elem_value_t *obj, unsigned int idx);
 388 unsigned char snd_ctl_elem_value_get_byte(const snd_ctl_elem_value_t *obj, unsigned int idx);
 389 void snd_ctl_elem_value_set_boolean(snd_ctl_elem_value_t *obj, unsigned int idx, long val);
 390 void snd_ctl_elem_value_set_integer(snd_ctl_elem_value_t *obj, unsigned int idx, long val);
 391 void snd_ctl_elem_value_set_enumerated(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned int val);
 392 void snd_ctl_elem_value_set_byte(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned char val);
 393 const void * snd_ctl_elem_value_get_bytes(const snd_ctl_elem_value_t *obj);
 394 void snd_ctl_elem_value_get_iec958(const snd_ctl_elem_value_t *obj, snd_aes_iec958_t *ptr);
 395 void snd_ctl_elem_value_set_iec958(snd_ctl_elem_value_t *obj, const snd_aes_iec958_t *ptr);
 396
 397 /**
 398  *  \defgroup HControl Highlevel Control Interface
 399  *  \ingroup Control
 400  *  The highlevel control interface.
 401  *  \{
 402  */
 403
 404 /** HCTL element handle */
 405 typedef struct _snd_hctl_elem snd_hctl_elem_t;
 406
 407 /** HCTL handle */
 408 typedef struct _snd_hctl snd_hctl_t;
 409
 410 /**
 411  * \brief Compare function for sorting HCTL elements
 412  * \param e1 First element
 413  * \param e2 Second element
 414  * \return -1 if e1 < e2, 0 if e1 == e2, 1 if e1 > e2
 415  */
 416 typedef int (*snd_hctl_compare_t)(const snd_hctl_elem_t *e1,
 417                                   const snd_hctl_elem_t *e2);
 418 int snd_hctl_compare_fast(const snd_hctl_elem_t *c1,
 419                           const snd_hctl_elem_t *c2);
 420 /**
 421  * \brief HCTL callback function
 422  * \param hctl HCTL handle
 423  * \param mask event mask
 424  * \param elem related HCTL element (if any)
 425  * \return 0 on success otherwise a negative error code
 426  */
 427 typedef int (*snd_hctl_callback_t)(snd_hctl_t *hctl,
 428                                    unsigned int mask,
 429                                    snd_hctl_elem_t *elem);
 430 /**
 431  * \brief HCTL element callback function
 432  * \param elem HCTL element
 433  * \param mask event mask
 434  * \return 0 on success otherwise a negative error code
 435  */
 436 typedef int (*snd_hctl_elem_callback_t)(snd_hctl_elem_t *elem,
 437                                         unsigned int mask);
 438
 439 int snd_hctl_open(snd_hctl_t **hctl, const char *name, int mode);
 440 int snd_hctl_close(snd_hctl_t *hctl);
 441 int snd_hctl_nonblock(snd_hctl_t *hctl, int nonblock);
 442 int snd_hctl_poll_descriptors_count(snd_hctl_t *hctl);
 443 int snd_hctl_poll_descriptors(snd_hctl_t *hctl, struct pollfd *pfds, unsigned int space);
 444 unsigned int snd_hctl_get_count(snd_hctl_t *hctl);
 445 int snd_hctl_set_compare(snd_hctl_t *hctl, snd_hctl_compare_t hsort);
 446 snd_hctl_elem_t *snd_hctl_first_elem(snd_hctl_t *hctl);
 447 snd_hctl_elem_t *snd_hctl_last_elem(snd_hctl_t *hctl);
 448 snd_hctl_elem_t *snd_hctl_find_elem(snd_hctl_t *hctl, const snd_ctl_elem_id_t *id);
 449 void snd_hctl_set_callback(snd_hctl_t *hctl, snd_hctl_callback_t callback);
 450 void snd_hctl_set_callback_private(snd_hctl_t *hctl, void *data);
 451 void *snd_hctl_get_callback_private(snd_hctl_t *hctl);
 452 int snd_hctl_load(snd_hctl_t *hctl);
 453 int snd_hctl_free(snd_hctl_t *hctl);
 454 int snd_hctl_handle_events(snd_hctl_t *hctl);
 455 const char *snd_hctl_name(snd_hctl_t *hctl);
 456 int snd_hctl_wait(snd_hctl_t *hctl, int timeout);
 457
 458 snd_hctl_elem_t *snd_hctl_elem_next(snd_hctl_elem_t *elem);
 459 snd_hctl_elem_t *snd_hctl_elem_prev(snd_hctl_elem_t *elem);
 460 int snd_hctl_elem_info(snd_hctl_elem_t *elem, snd_ctl_elem_info_t * info);
 461 int snd_hctl_elem_read(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
 462 int snd_hctl_elem_write(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
 463
 464 snd_hctl_t *snd_hctl_elem_get_hctl(snd_hctl_elem_t *elem);
 465
 466 void snd_hctl_elem_get_id(const snd_hctl_elem_t *obj, snd_ctl_elem_id_t *ptr);
 467 unsigned int snd_hctl_elem_get_numid(const snd_hctl_elem_t *obj);
 468 snd_ctl_elem_iface_t snd_hctl_elem_get_interface(const snd_hctl_elem_t *obj);
 469 unsigned int snd_hctl_elem_get_device(const snd_hctl_elem_t *obj);
 470 unsigned int snd_hctl_elem_get_subdevice(const snd_hctl_elem_t *obj);
 471 const char *snd_hctl_elem_get_name(const snd_hctl_elem_t *obj);
 472 unsigned int snd_hctl_elem_get_index(const snd_hctl_elem_t *obj);
 473 void snd_hctl_elem_set_callback(snd_hctl_elem_t *obj, snd_hctl_elem_callback_t val);
 474 void * snd_hctl_elem_get_callback_private(const snd_hctl_elem_t *obj);
 475 void snd_hctl_elem_set_callback_private(snd_hctl_elem_t *obj, void * val);
 476
 477 /** \} */
 478
 479 /** \} */
 480
 481 /**
 482  *  \defgroup SControl Setup Control Interface
 483  *  \ingroup Control
 484  *  The setup control interface - set or modify control elements from a configuration file.
 485  *  \{
 486  */
 487
 488 int snd_sctl_build(snd_sctl_t **ctl, snd_ctl_t *handle, snd_config_t *config,
 489                    snd_config_t *private_data, int mode);
 490 int snd_sctl_free(snd_sctl_t *handle);
 491 int snd_sctl_install(snd_sctl_t *handle);
 492 int snd_sctl_remove(snd_sctl_t *handle);
 493
 494 /** \} */
 495
 496 #ifdef __cplusplus
 497 }
 498 #endif
 499
 500 #endif /* __ALSA_CONTROL_H */