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 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.
  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 Library General Public License for more details.
  21  *
  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.
  25  *
  26  */
  27
  28 #ifndef __ALSA_CONTROL_H
  29 #define __ALSA_CONTROL_H
  30
  31 /**
  32  *  \defgroup Control Control Interface
  33  *  The control interface.
  34  *  \{
  35  */
  36
  37 /** dlsym version for interface entry callback */
  38 #define SND_CONTROL_DLSYM_VERSION       _dlsym_control_001
  39
  40 /** IEC958 structure */
  41 typedef struct snd_aes_iec958 {
  42         unsigned char status[24];       /**< AES/IEC958 channel status bits */
  43         unsigned char subcode[147];     /**< AES/IEC958 subcode bits */
  44         unsigned char pad;              /**< nothing */
  45         unsigned char dig_subframe[4];  /**< AES/IEC958 subframe bits */
  46 } snd_aes_iec958_t;
  47
  48 /** CTL card info container */
  49 typedef struct _snd_ctl_card_info snd_ctl_card_info_t;
  50
  51 /** CTL element identificator container */
  52 typedef struct _snd_ctl_elem_id snd_ctl_elem_id_t;
  53
  54 /** CTL element identificator list container */
  55 typedef struct _snd_ctl_elem_list snd_ctl_elem_list_t;
  56
  57 /** CTL element info container */
  58 typedef struct _snd_ctl_elem_info snd_ctl_elem_info_t;
  59
  60 /** CTL element value container */
  61 typedef struct _snd_ctl_elem_value snd_ctl_elem_value_t;
  62
  63 /** CTL event container */
  64 typedef struct _snd_ctl_event snd_ctl_event_t;
  65
  66 /** CTL element type */
  67 typedef enum _snd_ctl_elem_type {
  68         /** Invalid type */
  69         SND_CTL_ELEM_TYPE_NONE = 0,
  70         /** Boolean contents */
  71         SND_CTL_ELEM_TYPE_BOOLEAN,
  72         /** Integer contents */
  73         SND_CTL_ELEM_TYPE_INTEGER,
  74         /** Enumerated contents */
  75         SND_CTL_ELEM_TYPE_ENUMERATED,
  76         /** Bytes contents */
  77         SND_CTL_ELEM_TYPE_BYTES,
  78         /** IEC958 (S/PDIF) setting content */
  79         SND_CTL_ELEM_TYPE_IEC958,
  80         SND_CTL_ELEM_TYPE_LAST = SND_CTL_ELEM_TYPE_IEC958,
  81 } snd_ctl_elem_type_t;
  82
  83 /** CTL related interface */
  84 typedef enum _snd_ctl_elem_iface {
  85         /** Card level */
  86         SND_CTL_ELEM_IFACE_CARD = 0,
  87         /** Hardware dependent device */
  88         SND_CTL_ELEM_IFACE_HWDEP,
  89         /** Mixer */
  90         SND_CTL_ELEM_IFACE_MIXER,
  91         /** PCM */
  92         SND_CTL_ELEM_IFACE_PCM,
  93         /** RawMidi */
  94         SND_CTL_ELEM_IFACE_RAWMIDI,
  95         /** Timer */
  96         SND_CTL_ELEM_IFACE_TIMER,
  97         /** Sequencer */
  98         SND_CTL_ELEM_IFACE_SEQUENCER,
  99         SND_CTL_ELEM_IFACE_LAST = SND_CTL_ELEM_IFACE_SEQUENCER,
 100 } snd_ctl_elem_iface_t;
 101
 102 /** Event class */
 103 typedef enum _snd_ctl_event_type {
 104         /** Elements related event */
 105         SND_CTL_EVENT_ELEM = 0,
 106         SND_CTL_EVENT_LAST = SND_CTL_EVENT_ELEM,
 107 }snd_ctl_event_type_t;
 108
 109 /** Element has been removed (Warning: test this first and if set don't
 110   * test the other masks) \hideinitializer */
 111 #define SND_CTL_EVENT_MASK_REMOVE       (~0U)
 112 /** Element value has been changed \hideinitializer */
 113 #define SND_CTL_EVENT_MASK_VALUE        (1<<0)
 114 /** Element info has been changed \hideinitializer */
 115 #define SND_CTL_EVENT_MASK_INFO         (1<<1)
 116 /** Element has been added \hideinitializer */
 117 #define SND_CTL_EVENT_MASK_ADD          (1<<2)
 118
 119 /** CTL name helper */
 120 #define SND_CTL_NAME_NONE                               ""
 121 /** CTL name helper */
 122 #define SND_CTL_NAME_PLAYBACK                           "Playback "
 123 /** CTL name helper */
 124 #define SND_CTL_NAME_CAPTURE                            "Capture "
 125
 126 /** CTL name helper */
 127 #define SND_CTL_NAME_IEC958_NONE                        ""
 128 /** CTL name helper */
 129 #define SND_CTL_NAME_IEC958_SWITCH                      "Switch"
 130 /** CTL name helper */
 131 #define SND_CTL_NAME_IEC958_VOLUME                      "Volume"
 132 /** CTL name helper */
 133 #define SND_CTL_NAME_IEC958_DEFAULT                     "Default"
 134 /** CTL name helper */
 135 #define SND_CTL_NAME_IEC958_MASK                        "Mask"
 136 /** CTL name helper */
 137 #define SND_CTL_NAME_IEC958_CON_MASK                    "Con Mask"
 138 /** CTL name helper */
 139 #define SND_CTL_NAME_IEC958_PRO_MASK                    "Pro Mask"
 140 /** CTL name helper */
 141 #define SND_CTL_NAME_IEC958_PCM_STREAM                  "PCM Stream"
 142 /** Element name for IEC958 (S/PDIF) */
 143 #define SND_CTL_NAME_IEC958(expl,direction,what)        "IEC958 " expl SND_CTL_NAME_##direction SND_CTL_NAME_IEC958_##what
 144
 145
 146 /** CTL type */
 147 typedef enum _snd_ctl_type {
 148         /** Kernel level CTL */
 149         SND_CTL_TYPE_HW,
 150         /** Shared memory client CTL */
 151         SND_CTL_TYPE_SHM,
 152         /** INET client CTL (not yet implemented) */
 153         SND_CTL_TYPE_INET
 154 } snd_ctl_type_t;
 155
 156 /** Non blocking mode \hideinitializer */
 157 #define SND_CTL_NONBLOCK                0x0001
 158
 159 /** Async notification \hideinitializer */
 160 #define SND_CTL_ASYNC                   0x0002
 161
 162 /** CTL handle */
 163 typedef struct _snd_ctl snd_ctl_t;
 164
 165 /** Don't destroy the ctl handle when close */
 166 #define SND_SCTL_NOFREE                 0x0001
 167
 168 /** SCTL type */
 169 typedef struct _snd_sctl snd_sctl_t;
 170
 171 #ifdef __cplusplus
 172 extern "C" {
 173 #endif
 174
 175 int snd_card_load(int card);
 176 int snd_card_next(int *card);
 177 int snd_card_get_index(const char *name);
 178 int snd_card_get_name(int card, char **name);
 179 int snd_card_get_longname(int card, char **name);
 180
 181 int snd_sctl_build(snd_sctl_t **ctl, snd_ctl_t *handle, snd_config_t *config,
 182                    void *private_data, int mode);
 183 int snd_sctl_free(snd_sctl_t *handle);
 184 int snd_sctl_install(snd_sctl_t *handle);
 185 int snd_sctl_remove(snd_sctl_t *handle);
 186
 187 int snd_ctl_open(snd_ctl_t **ctl, const char *name, int mode);
 188 int snd_ctl_close(snd_ctl_t *ctl);
 189 int snd_ctl_nonblock(snd_ctl_t *ctl, int nonblock);
 190 int snd_async_add_ctl_handler(snd_async_handler_t **handler, snd_ctl_t *ctl,
 191                               snd_async_callback_t callback, void *private_data);
 192 snd_ctl_t *snd_async_handler_get_ctl(snd_async_handler_t *handler);
 193 int snd_ctl_poll_descriptors_count(snd_ctl_t *ctl);
 194 int snd_ctl_poll_descriptors(snd_ctl_t *ctl, struct pollfd *pfds, unsigned int space);
 195 int snd_ctl_subscribe_events(snd_ctl_t *ctl, int subscribe);
 196 int snd_ctl_card_info(snd_ctl_t *ctl, snd_ctl_card_info_t *info);
 197 int snd_ctl_elem_list(snd_ctl_t *ctl, snd_ctl_elem_list_t * list);
 198 int snd_ctl_elem_info(snd_ctl_t *ctl, snd_ctl_elem_info_t *info);
 199 int snd_ctl_elem_read(snd_ctl_t *ctl, snd_ctl_elem_value_t *value);
 200 int snd_ctl_elem_write(snd_ctl_t *ctl, snd_ctl_elem_value_t *value);
 201 int snd_ctl_elem_lock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id);
 202 int snd_ctl_elem_unlock(snd_ctl_t *ctl, snd_ctl_elem_id_t *id);
 203 int snd_ctl_hwdep_next_device(snd_ctl_t *ctl, int * device);
 204 int snd_ctl_hwdep_info(snd_ctl_t *ctl, snd_hwdep_info_t * info);
 205 int snd_ctl_pcm_next_device(snd_ctl_t *ctl, int *device);
 206 int snd_ctl_pcm_info(snd_ctl_t *ctl, snd_pcm_info_t * info);
 207 int snd_ctl_pcm_prefer_subdevice(snd_ctl_t *ctl, int subdev);
 208 int snd_ctl_rawmidi_next_device(snd_ctl_t *ctl, int * device);
 209 int snd_ctl_rawmidi_info(snd_ctl_t *ctl, snd_rawmidi_info_t * info);
 210 int snd_ctl_rawmidi_prefer_subdevice(snd_ctl_t *ctl, int subdev);
 211
 212 int snd_ctl_read(snd_ctl_t *ctl, snd_ctl_event_t *event);
 213 int snd_ctl_wait(snd_ctl_t *ctl, int timeout);
 214 const char *snd_ctl_name(snd_ctl_t *ctl);
 215 snd_ctl_type_t snd_ctl_type(snd_ctl_t *ctl);
 216
 217 void snd_ctl_elem_set_bytes(snd_ctl_elem_value_t *obj, void *data, size_t size);
 218 const char *snd_ctl_elem_type_name(snd_ctl_elem_type_t type);
 219 const char *snd_ctl_elem_iface_name(snd_ctl_elem_iface_t iface);
 220 const char *snd_ctl_event_type_name(snd_ctl_event_type_t type);
 221
 222 unsigned int snd_ctl_event_elem_get_mask(const snd_ctl_event_t *obj);
 223 unsigned int snd_ctl_event_elem_get_numid(const snd_ctl_event_t *obj);
 224 void snd_ctl_event_elem_get_id(const snd_ctl_event_t *obj, snd_ctl_elem_id_t *ptr);
 225 snd_ctl_elem_iface_t snd_ctl_event_elem_get_interface(const snd_ctl_event_t *obj);
 226 unsigned int snd_ctl_event_elem_get_device(const snd_ctl_event_t *obj);
 227 unsigned int snd_ctl_event_elem_get_subdevice(const snd_ctl_event_t *obj);
 228 const char *snd_ctl_event_elem_get_name(const snd_ctl_event_t *obj);
 229 unsigned int snd_ctl_event_elem_get_index(const snd_ctl_event_t *obj);
 230
 231 int snd_ctl_elem_list_alloc_space(snd_ctl_elem_list_t *obj, unsigned int entries);
 232 void snd_ctl_elem_list_free_space(snd_ctl_elem_list_t *obj);
 233
 234 size_t snd_ctl_elem_id_sizeof(void);
 235 /** \hideinitializer
 236  * \brief allocate an invalid #snd_ctl_elem_id_t using standard alloca
 237  * \param ptr returned pointer
 238  */
 239 #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)
 240 int snd_ctl_elem_id_malloc(snd_ctl_elem_id_t **ptr);
 241 void snd_ctl_elem_id_free(snd_ctl_elem_id_t *obj);
 242 void snd_ctl_elem_id_clear(snd_ctl_elem_id_t *obj);
 243 void snd_ctl_elem_id_copy(snd_ctl_elem_id_t *dst, const snd_ctl_elem_id_t *src);
 244 unsigned int snd_ctl_elem_id_get_numid(const snd_ctl_elem_id_t *obj);
 245 snd_ctl_elem_iface_t snd_ctl_elem_id_get_interface(const snd_ctl_elem_id_t *obj);
 246 unsigned int snd_ctl_elem_id_get_device(const snd_ctl_elem_id_t *obj);
 247 unsigned int snd_ctl_elem_id_get_subdevice(const snd_ctl_elem_id_t *obj);
 248 const char *snd_ctl_elem_id_get_name(const snd_ctl_elem_id_t *obj);
 249 unsigned int snd_ctl_elem_id_get_index(const snd_ctl_elem_id_t *obj);
 250 void snd_ctl_elem_id_set_numid(snd_ctl_elem_id_t *obj, unsigned int val);
 251 void snd_ctl_elem_id_set_interface(snd_ctl_elem_id_t *obj, snd_ctl_elem_iface_t val);
 252 void snd_ctl_elem_id_set_device(snd_ctl_elem_id_t *obj, unsigned int val);
 253 void snd_ctl_elem_id_set_subdevice(snd_ctl_elem_id_t *obj, unsigned int val);
 254 void snd_ctl_elem_id_set_name(snd_ctl_elem_id_t *obj, const char *val);
 255 void snd_ctl_elem_id_set_index(snd_ctl_elem_id_t *obj, unsigned int val);
 256
 257 size_t snd_ctl_card_info_sizeof(void);
 258 /** \hideinitializer
 259  * \brief allocate an invalid #snd_ctl_card_info_t using standard alloca
 260  * \param ptr returned pointer
 261  */
 262 #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)
 263 int snd_ctl_card_info_malloc(snd_ctl_card_info_t **ptr);
 264 void snd_ctl_card_info_free(snd_ctl_card_info_t *obj);
 265 void snd_ctl_card_info_clear(snd_ctl_card_info_t *obj);
 266 void snd_ctl_card_info_copy(snd_ctl_card_info_t *dst, const snd_ctl_card_info_t *src);
 267 int snd_ctl_card_info_get_card(const snd_ctl_card_info_t *obj);
 268 const char *snd_ctl_card_info_get_id(const snd_ctl_card_info_t *obj);
 269 const char *snd_ctl_card_info_get_driver(const snd_ctl_card_info_t *obj);
 270 const char *snd_ctl_card_info_get_name(const snd_ctl_card_info_t *obj);
 271 const char *snd_ctl_card_info_get_longname(const snd_ctl_card_info_t *obj);
 272 const char *snd_ctl_card_info_get_mixername(const snd_ctl_card_info_t *obj);
 273 const char *snd_ctl_card_info_get_components(const snd_ctl_card_info_t *obj);
 274
 275 size_t snd_ctl_event_sizeof(void);
 276 /** \hideinitializer
 277  * \brief allocate an invalid #snd_ctl_event_t using standard alloca
 278  * \param ptr returned pointer
 279  */
 280 #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)
 281 int snd_ctl_event_malloc(snd_ctl_event_t **ptr);
 282 void snd_ctl_event_free(snd_ctl_event_t *obj);
 283 void snd_ctl_event_clear(snd_ctl_event_t *obj);
 284 void snd_ctl_event_copy(snd_ctl_event_t *dst, const snd_ctl_event_t *src);
 285 snd_ctl_event_type_t snd_ctl_event_get_type(const snd_ctl_event_t *obj);
 286
 287 size_t snd_ctl_elem_list_sizeof(void);
 288 /** \hideinitializer
 289  * \brief allocate an invalid #snd_ctl_elem_list_t using standard alloca
 290  * \param ptr returned pointer
 291  */
 292 #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)
 293 int snd_ctl_elem_list_malloc(snd_ctl_elem_list_t **ptr);
 294 void snd_ctl_elem_list_free(snd_ctl_elem_list_t *obj);
 295 void snd_ctl_elem_list_clear(snd_ctl_elem_list_t *obj);
 296 void snd_ctl_elem_list_copy(snd_ctl_elem_list_t *dst, const snd_ctl_elem_list_t *src);
 297 void snd_ctl_elem_list_set_offset(snd_ctl_elem_list_t *obj, unsigned int val);
 298 unsigned int snd_ctl_elem_list_get_used(const snd_ctl_elem_list_t *obj);
 299 unsigned int snd_ctl_elem_list_get_count(const snd_ctl_elem_list_t *obj);
 300 void snd_ctl_elem_list_get_id(const snd_ctl_elem_list_t *obj, unsigned int idx, snd_ctl_elem_id_t *ptr);
 301 unsigned int snd_ctl_elem_list_get_numid(const snd_ctl_elem_list_t *obj, unsigned int idx);
 302 snd_ctl_elem_iface_t snd_ctl_elem_list_get_interface(const snd_ctl_elem_list_t *obj, unsigned int idx);
 303 unsigned int snd_ctl_elem_list_get_device(const snd_ctl_elem_list_t *obj, unsigned int idx);
 304 unsigned int snd_ctl_elem_list_get_subdevice(const snd_ctl_elem_list_t *obj, unsigned int idx);
 305 const char *snd_ctl_elem_list_get_name(const snd_ctl_elem_list_t *obj, unsigned int idx);
 306 unsigned int snd_ctl_elem_list_get_index(const snd_ctl_elem_list_t *obj, unsigned int idx);
 307
 308 size_t snd_ctl_elem_info_sizeof(void);
 309 /** \hideinitializer
 310  * \brief allocate an invalid #snd_ctl_elem_info_t using standard alloca
 311  * \param ptr returned pointer
 312  */
 313 #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)
 314 int snd_ctl_elem_info_malloc(snd_ctl_elem_info_t **ptr);
 315 void snd_ctl_elem_info_free(snd_ctl_elem_info_t *obj);
 316 void snd_ctl_elem_info_clear(snd_ctl_elem_info_t *obj);
 317 void snd_ctl_elem_info_copy(snd_ctl_elem_info_t *dst, const snd_ctl_elem_info_t *src);
 318 snd_ctl_elem_type_t snd_ctl_elem_info_get_type(const snd_ctl_elem_info_t *obj);
 319 int snd_ctl_elem_info_is_readable(const snd_ctl_elem_info_t *obj);
 320 int snd_ctl_elem_info_is_writable(const snd_ctl_elem_info_t *obj);
 321 int snd_ctl_elem_info_is_volatile(const snd_ctl_elem_info_t *obj);
 322 int snd_ctl_elem_info_is_inactive(const snd_ctl_elem_info_t *obj);
 323 int snd_ctl_elem_info_is_locked(const snd_ctl_elem_info_t *obj);
 324 int snd_ctl_elem_info_is_owner(const snd_ctl_elem_info_t *obj);
 325 int snd_ctl_elem_info_is_indirect(const snd_ctl_elem_info_t *obj);
 326 pid_t snd_ctl_elem_info_get_owner(const snd_ctl_elem_info_t *obj);
 327 unsigned int snd_ctl_elem_info_get_count(const snd_ctl_elem_info_t *obj);
 328 long snd_ctl_elem_info_get_min(const snd_ctl_elem_info_t *obj);
 329 long snd_ctl_elem_info_get_max(const snd_ctl_elem_info_t *obj);
 330 long snd_ctl_elem_info_get_step(const snd_ctl_elem_info_t *obj);
 331 unsigned int snd_ctl_elem_info_get_items(const snd_ctl_elem_info_t *obj);
 332 void snd_ctl_elem_info_set_item(snd_ctl_elem_info_t *obj, unsigned int val);
 333 const char *snd_ctl_elem_info_get_item_name(const snd_ctl_elem_info_t *obj);
 334 void snd_ctl_elem_info_get_id(const snd_ctl_elem_info_t *obj, snd_ctl_elem_id_t *ptr);
 335 unsigned int snd_ctl_elem_info_get_numid(const snd_ctl_elem_info_t *obj);
 336 snd_ctl_elem_iface_t snd_ctl_elem_info_get_interface(const snd_ctl_elem_info_t *obj);
 337 unsigned int snd_ctl_elem_info_get_device(const snd_ctl_elem_info_t *obj);
 338 unsigned int snd_ctl_elem_info_get_subdevice(const snd_ctl_elem_info_t *obj);
 339 const char *snd_ctl_elem_info_get_name(const snd_ctl_elem_info_t *obj);
 340 unsigned int snd_ctl_elem_info_get_index(const snd_ctl_elem_info_t *obj);
 341 void snd_ctl_elem_info_set_id(snd_ctl_elem_info_t *obj, const snd_ctl_elem_id_t *ptr);
 342 void snd_ctl_elem_info_set_numid(snd_ctl_elem_info_t *obj, unsigned int val);
 343 void snd_ctl_elem_info_set_interface(snd_ctl_elem_info_t *obj, snd_ctl_elem_iface_t val);
 344 void snd_ctl_elem_info_set_device(snd_ctl_elem_info_t *obj, unsigned int val);
 345 void snd_ctl_elem_info_set_subdevice(snd_ctl_elem_info_t *obj, unsigned int val);
 346 void snd_ctl_elem_info_set_name(snd_ctl_elem_info_t *obj, const char *val);
 347 void snd_ctl_elem_info_set_index(snd_ctl_elem_info_t *obj, unsigned int val);
 348
 349 size_t snd_ctl_elem_value_sizeof(void);
 350 /** \hideinitializer
 351  * \brief allocate an invalid #snd_ctl_elem_value_t using standard alloca
 352  * \param ptr returned pointer
 353  */
 354 #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)
 355 int snd_ctl_elem_value_malloc(snd_ctl_elem_value_t **ptr);
 356 void snd_ctl_elem_value_free(snd_ctl_elem_value_t *obj);
 357 void snd_ctl_elem_value_clear(snd_ctl_elem_value_t *obj);
 358 void snd_ctl_elem_value_copy(snd_ctl_elem_value_t *dst, const snd_ctl_elem_value_t *src);
 359 void snd_ctl_elem_value_get_id(const snd_ctl_elem_value_t *obj, snd_ctl_elem_id_t *ptr);
 360 unsigned int snd_ctl_elem_value_get_numid(const snd_ctl_elem_value_t *obj);
 361 snd_ctl_elem_iface_t snd_ctl_elem_value_get_interface(const snd_ctl_elem_value_t *obj);
 362 unsigned int snd_ctl_elem_value_get_device(const snd_ctl_elem_value_t *obj);
 363 unsigned int snd_ctl_elem_value_get_subdevice(const snd_ctl_elem_value_t *obj);
 364 const char *snd_ctl_elem_value_get_name(const snd_ctl_elem_value_t *obj);
 365 unsigned int snd_ctl_elem_value_get_index(const snd_ctl_elem_value_t *obj);
 366 void snd_ctl_elem_value_set_id(snd_ctl_elem_value_t *obj, const snd_ctl_elem_id_t *ptr);
 367 void snd_ctl_elem_value_set_numid(snd_ctl_elem_value_t *obj, unsigned int val);
 368 void snd_ctl_elem_value_set_interface(snd_ctl_elem_value_t *obj, snd_ctl_elem_iface_t val);
 369 void snd_ctl_elem_value_set_device(snd_ctl_elem_value_t *obj, unsigned int val);
 370 void snd_ctl_elem_value_set_subdevice(snd_ctl_elem_value_t *obj, unsigned int val);
 371 void snd_ctl_elem_value_set_name(snd_ctl_elem_value_t *obj, const char *val);
 372 void snd_ctl_elem_value_set_index(snd_ctl_elem_value_t *obj, unsigned int val);
 373 int snd_ctl_elem_value_get_boolean(const snd_ctl_elem_value_t *obj, unsigned int idx);
 374 long snd_ctl_elem_value_get_integer(const snd_ctl_elem_value_t *obj, unsigned int idx);
 375 unsigned int snd_ctl_elem_value_get_enumerated(const snd_ctl_elem_value_t *obj, unsigned int idx);
 376 unsigned char snd_ctl_elem_value_get_byte(const snd_ctl_elem_value_t *obj, unsigned int idx);
 377 void snd_ctl_elem_value_set_boolean(snd_ctl_elem_value_t *obj, unsigned int idx, long val);
 378 void snd_ctl_elem_value_set_integer(snd_ctl_elem_value_t *obj, unsigned int idx, long val);
 379 void snd_ctl_elem_value_set_enumerated(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned int val);
 380 void snd_ctl_elem_value_set_byte(snd_ctl_elem_value_t *obj, unsigned int idx, unsigned char val);
 381 const void * snd_ctl_elem_value_get_bytes(const snd_ctl_elem_value_t *obj);
 382 void snd_ctl_elem_value_get_iec958(const snd_ctl_elem_value_t *obj, snd_aes_iec958_t *ptr);
 383 void snd_ctl_elem_value_set_iec958(snd_ctl_elem_value_t *obj, const snd_aes_iec958_t *ptr);
 384
 385 #ifdef __cplusplus
 386 }
 387 #endif
 388
 389 /**
 390  *  \defgroup HControl Highlevel Control Interface
 391  *  \ingroup Control
 392  *  The highlevel control interface.
 393  *  \{
 394  */
 395
 396 /** HCTL element handle */
 397 typedef struct _snd_hctl_elem snd_hctl_elem_t;
 398
 399 /** HCTL handle */
 400 typedef struct _snd_hctl snd_hctl_t;
 401
 402 #ifdef __cplusplus
 403 extern "C" {
 404 #endif
 405
 406 /**
 407  * \brief Compare function for sorting HCTL elements
 408  * \param e1 First element
 409  * \param e2 Second element
 410  * \return -1 if e1 < e2, 0 if e1 == e2, 1 if e1 > e2
 411  */
 412 typedef int (*snd_hctl_compare_t)(const snd_hctl_elem_t *e1,
 413                                   const snd_hctl_elem_t *e2);
 414 int snd_hctl_compare_fast(const snd_hctl_elem_t *c1,
 415                           const snd_hctl_elem_t *c2);
 416 /**
 417  * \brief HCTL callback function
 418  * \param hctl HCTL handle
 419  * \param mask event mask
 420  * \param elem related HCTL element (if any)
 421  * \return 0 on success otherwise a negative error code
 422  */
 423 typedef int (*snd_hctl_callback_t)(snd_hctl_t *hctl,
 424                                    unsigned int mask,
 425                                    snd_hctl_elem_t *elem);
 426 /**
 427  * \brief HCTL element callback function
 428  * \param elem HCTL element
 429  * \param mask event mask
 430  * \return 0 on success otherwise a negative error code
 431  */
 432 typedef int (*snd_hctl_elem_callback_t)(snd_hctl_elem_t *elem,
 433                                         unsigned int mask);
 434
 435 int snd_hctl_open(snd_hctl_t **hctl, const char *name, int mode);
 436 int snd_hctl_close(snd_hctl_t *hctl);
 437 int snd_hctl_nonblock(snd_hctl_t *hctl, int nonblock);
 438 int snd_hctl_poll_descriptors_count(snd_hctl_t *hctl);
 439 int snd_hctl_poll_descriptors(snd_hctl_t *hctl, struct pollfd *pfds, unsigned int space);
 440 unsigned int snd_hctl_get_count(snd_hctl_t *hctl);
 441 int snd_hctl_set_compare(snd_hctl_t *hctl, snd_hctl_compare_t hsort);
 442 snd_hctl_elem_t *snd_hctl_first_elem(snd_hctl_t *hctl);
 443 snd_hctl_elem_t *snd_hctl_last_elem(snd_hctl_t *hctl);
 444 snd_hctl_elem_t *snd_hctl_find_elem(snd_hctl_t *hctl, const snd_ctl_elem_id_t *id);
 445 void snd_hctl_set_callback(snd_hctl_t *hctl, snd_hctl_callback_t callback);
 446 void snd_hctl_set_callback_private(snd_hctl_t *hctl, void *data);
 447 void *snd_hctl_get_callback_private(snd_hctl_t *hctl);
 448 int snd_hctl_load(snd_hctl_t *hctl);
 449 int snd_hctl_free(snd_hctl_t *hctl);
 450 int snd_hctl_handle_events(snd_hctl_t *hctl);
 451 const char *snd_hctl_name(snd_hctl_t *hctl);
 452 int snd_hctl_wait(snd_hctl_t *hctl, int timeout);
 453
 454 snd_hctl_elem_t *snd_hctl_elem_next(snd_hctl_elem_t *elem);
 455 snd_hctl_elem_t *snd_hctl_elem_prev(snd_hctl_elem_t *elem);
 456 int snd_hctl_elem_info(snd_hctl_elem_t *elem, snd_ctl_elem_info_t * info);
 457 int snd_hctl_elem_read(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
 458 int snd_hctl_elem_write(snd_hctl_elem_t *elem, snd_ctl_elem_value_t * value);
 459
 460 snd_hctl_t *snd_hctl_elem_get_hctl(snd_hctl_elem_t *elem);
 461
 462 void snd_hctl_elem_get_id(const snd_hctl_elem_t *obj, snd_ctl_elem_id_t *ptr);
 463 unsigned int snd_hctl_elem_get_numid(const snd_hctl_elem_t *obj);
 464 snd_ctl_elem_iface_t snd_hctl_elem_get_interface(const snd_hctl_elem_t *obj);
 465 unsigned int snd_hctl_elem_get_device(const snd_hctl_elem_t *obj);
 466 unsigned int snd_hctl_elem_get_subdevice(const snd_hctl_elem_t *obj);
 467 const char *snd_hctl_elem_get_name(const snd_hctl_elem_t *obj);
 468 unsigned int snd_hctl_elem_get_index(const snd_hctl_elem_t *obj);
 469 void snd_hctl_elem_set_callback(snd_hctl_elem_t *obj, snd_hctl_elem_callback_t val);
 470 void * snd_hctl_elem_get_callback_private(const snd_hctl_elem_t *obj);
 471 void snd_hctl_elem_set_callback_private(snd_hctl_elem_t *obj, void * val);
 472
 473 #ifdef __cplusplus
 474 }
 475 #endif
 476
 477 /** \} */
 478 /** \} */
 479
 480 #endif /* __ALSA_CONTROL_H */
 481