include/control.h

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