include/control.h

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