Blame view
include/sound/control.h
7.94 KB
1da177e4c Linux-2.6.12-rc2 |
1 2 3 4 5 |
#ifndef __SOUND_CONTROL_H #define __SOUND_CONTROL_H /* * Header file for control interface |
c1017a4cd [ALSA] Changed Ja... |
6 |
* Copyright (c) by Jaroslav Kysela <perex@perex.cz> |
1da177e4c Linux-2.6.12-rc2 |
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
* * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * */ #include <sound/asound.h> |
1da177e4c Linux-2.6.12-rc2 |
26 |
#define snd_kcontrol_chip(kcontrol) ((kcontrol)->private_data) |
82e9bae6f [ALSA] Remove xxx... |
27 28 29 30 |
struct snd_kcontrol; typedef int (snd_kcontrol_info_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_info * uinfo); typedef int (snd_kcontrol_get_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol); typedef int (snd_kcontrol_put_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol); |
8aa9b586e [ALSA] Control AP... |
31 32 33 34 |
typedef int (snd_kcontrol_tlv_rw_t)(struct snd_kcontrol *kcontrol, int op_flag, /* 0=read,1=write,-1=command */ unsigned int size, unsigned int __user *tlv); |
1da177e4c Linux-2.6.12-rc2 |
35 |
|
82e9bae6f [ALSA] Remove xxx... |
36 |
struct snd_kcontrol_new { |
1da177e4c Linux-2.6.12-rc2 |
37 38 39 40 41 42 43 44 45 46 |
snd_ctl_elem_iface_t iface; /* interface identifier */ unsigned int device; /* device/client number */ unsigned int subdevice; /* subdevice (substream) number */ unsigned char *name; /* ASCII name of item */ unsigned int index; /* index of item */ unsigned int access; /* access rights */ unsigned int count; /* count of same elements */ snd_kcontrol_info_t *info; snd_kcontrol_get_t *get; snd_kcontrol_put_t *put; |
8aa9b586e [ALSA] Control AP... |
47 48 |
union { snd_kcontrol_tlv_rw_t *c; |
0cb29ea0d [ALSA] Add even m... |
49 |
const unsigned int *p; |
8aa9b586e [ALSA] Control AP... |
50 |
} tlv; |
1da177e4c Linux-2.6.12-rc2 |
51 |
unsigned long private_value; |
82e9bae6f [ALSA] Remove xxx... |
52 |
}; |
1da177e4c Linux-2.6.12-rc2 |
53 |
|
82e9bae6f [ALSA] Remove xxx... |
54 55 |
struct snd_kcontrol_volatile { struct snd_ctl_file *owner; /* locked */ |
1da177e4c Linux-2.6.12-rc2 |
56 |
unsigned int access; /* access rights */ |
82e9bae6f [ALSA] Remove xxx... |
57 |
}; |
1da177e4c Linux-2.6.12-rc2 |
58 |
|
82e9bae6f [ALSA] Remove xxx... |
59 |
struct snd_kcontrol { |
1da177e4c Linux-2.6.12-rc2 |
60 |
struct list_head list; /* list of controls */ |
82e9bae6f [ALSA] Remove xxx... |
61 |
struct snd_ctl_elem_id id; |
1da177e4c Linux-2.6.12-rc2 |
62 63 64 65 |
unsigned int count; /* count of same elements */ snd_kcontrol_info_t *info; snd_kcontrol_get_t *get; snd_kcontrol_put_t *put; |
8aa9b586e [ALSA] Control AP... |
66 67 |
union { snd_kcontrol_tlv_rw_t *c; |
0cb29ea0d [ALSA] Add even m... |
68 |
const unsigned int *p; |
8aa9b586e [ALSA] Control AP... |
69 |
} tlv; |
1da177e4c Linux-2.6.12-rc2 |
70 71 |
unsigned long private_value; void *private_data; |
82e9bae6f [ALSA] Remove xxx... |
72 73 |
void (*private_free)(struct snd_kcontrol *kcontrol); struct snd_kcontrol_volatile vd[0]; /* volatile data */ |
1da177e4c Linux-2.6.12-rc2 |
74 |
}; |
82e9bae6f [ALSA] Remove xxx... |
75 |
#define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list) |
1da177e4c Linux-2.6.12-rc2 |
76 |
|
82e9bae6f [ALSA] Remove xxx... |
77 |
struct snd_kctl_event { |
1da177e4c Linux-2.6.12-rc2 |
78 |
struct list_head list; /* list of events */ |
82e9bae6f [ALSA] Remove xxx... |
79 |
struct snd_ctl_elem_id id; |
1da177e4c Linux-2.6.12-rc2 |
80 |
unsigned int mask; |
82e9bae6f [ALSA] Remove xxx... |
81 |
}; |
1da177e4c Linux-2.6.12-rc2 |
82 |
|
82e9bae6f [ALSA] Remove xxx... |
83 |
#define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list) |
1da177e4c Linux-2.6.12-rc2 |
84 |
|
25d27eded control: use refe... |
85 |
struct pid; |
82e9bae6f [ALSA] Remove xxx... |
86 |
struct snd_ctl_file { |
1da177e4c Linux-2.6.12-rc2 |
87 |
struct list_head list; /* list of all control files */ |
82e9bae6f [ALSA] Remove xxx... |
88 |
struct snd_card *card; |
25d27eded control: use refe... |
89 |
struct pid *pid; |
1da177e4c Linux-2.6.12-rc2 |
90 91 92 93 94 95 96 97 |
int prefer_pcm_subdevice; int prefer_rawmidi_subdevice; wait_queue_head_t change_sleep; spinlock_t read_lock; struct fasync_struct *fasync; int subscribed; /* read interface is activated */ struct list_head events; /* waiting events for read */ }; |
82e9bae6f [ALSA] Remove xxx... |
98 |
#define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list) |
1da177e4c Linux-2.6.12-rc2 |
99 |
|
82e9bae6f [ALSA] Remove xxx... |
100 101 102 |
typedef int (*snd_kctl_ioctl_func_t) (struct snd_card * card, struct snd_ctl_file * control, unsigned int cmd, unsigned long arg); |
1da177e4c Linux-2.6.12-rc2 |
103 |
|
82e9bae6f [ALSA] Remove xxx... |
104 |
void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id); |
1da177e4c Linux-2.6.12-rc2 |
105 |
|
82e9bae6f [ALSA] Remove xxx... |
106 107 108 109 |
struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new * kcontrolnew, void * private_data); void snd_ctl_free_one(struct snd_kcontrol * kcontrol); int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol); int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol); |
66b5b9722 ALSA: Add snd_ctl... |
110 |
int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol, bool add_on_replace); |
82e9bae6f [ALSA] Remove xxx... |
111 112 |
int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id); int snd_ctl_rename_id(struct snd_card * card, struct snd_ctl_elem_id *src_id, struct snd_ctl_elem_id *dst_id); |
3cbdd7533 ALSA: Add snd_ctl... |
113 114 |
int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id, int active); |
82e9bae6f [ALSA] Remove xxx... |
115 116 |
struct snd_kcontrol *snd_ctl_find_numid(struct snd_card * card, unsigned int numid); struct snd_kcontrol *snd_ctl_find_id(struct snd_card * card, struct snd_ctl_elem_id *id); |
1da177e4c Linux-2.6.12-rc2 |
117 |
|
82e9bae6f [ALSA] Remove xxx... |
118 |
int snd_ctl_create(struct snd_card *card); |
1da177e4c Linux-2.6.12-rc2 |
119 120 121 122 123 124 125 126 127 128 |
int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn); int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn); #ifdef CONFIG_COMPAT int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn); int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn); #else #define snd_ctl_register_ioctl_compat(fcn) #define snd_ctl_unregister_ioctl_compat(fcn) #endif |
82e9bae6f [ALSA] Remove xxx... |
129 |
static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
1da177e4c Linux-2.6.12-rc2 |
130 131 132 |
{ return id->numid - kctl->id.numid; } |
82e9bae6f [ALSA] Remove xxx... |
133 |
static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
1da177e4c Linux-2.6.12-rc2 |
134 135 136 |
{ return id->index - kctl->id.index; } |
82e9bae6f [ALSA] Remove xxx... |
137 |
static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id) |
1da177e4c Linux-2.6.12-rc2 |
138 139 140 141 142 143 144 |
{ if (id->numid) { return snd_ctl_get_ioffnum(kctl, id); } else { return snd_ctl_get_ioffidx(kctl, id); } } |
82e9bae6f [ALSA] Remove xxx... |
145 146 |
static inline struct snd_ctl_elem_id *snd_ctl_build_ioff(struct snd_ctl_elem_id *dst_id, struct snd_kcontrol *src_kctl, |
1da177e4c Linux-2.6.12-rc2 |
147 148 149 150 151 152 153 |
unsigned int offset) { *dst_id = src_kctl->id; dst_id->index += offset; dst_id->numid += offset; return dst_id; } |
b9ed4f2b6 [ALSA] Add helper... |
154 |
/* |
9600732b6 ALSA: core, oxyge... |
155 |
* Frequently used control callbacks/helpers |
b9ed4f2b6 [ALSA] Add helper... |
156 157 158 159 160 |
*/ int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo); int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo); |
9600732b6 ALSA: core, oxyge... |
161 162 |
int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels, unsigned int items, const char *const names[]); |
b9ed4f2b6 [ALSA] Add helper... |
163 |
|
e922b0028 [ALSA] Move vmast... |
164 165 166 167 168 |
/* * virtual master control */ struct snd_kcontrol *snd_ctl_make_virtual_master(char *name, const unsigned int *tlv); |
f5b1db634 ALSA: add snd_ctl... |
169 170 171 172 |
int _snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave, unsigned int flags); /* optional flags for slave */ #define SND_CTL_SLAVE_NEED_UPDATE (1 << 0) |
79c7cdd54 ALSA: Add kernel-... |
173 174 175 176 177 178 179 180 181 182 |
/** * snd_ctl_add_slave - Add a virtual slave control * @master: vmaster element * @slave: slave element to add * * Add a virtual slave control to the given master element created via * snd_ctl_create_virtual_master() beforehand. * Returns zero if successful or a negative error code. * * All slaves must be the same type (returning the same information |
25985edce Fix common misspe... |
183 |
* via info callback). The function doesn't check it, so it's your |
79c7cdd54 ALSA: Add kernel-... |
184 185 186 187 188 189 190 |
* responsibility. * * Also, some additional limitations: * at most two channels, * logarithmic volume control (dB level) thus no linear volume, * master can only attenuate the volume without gain */ |
f5b1db634 ALSA: add snd_ctl... |
191 192 193 194 195 |
static inline int snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave) { return _snd_ctl_add_slave(master, slave, 0); } |
79c7cdd54 ALSA: Add kernel-... |
196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
/** * snd_ctl_add_slave_uncached - Add a virtual slave control * @master: vmaster element * @slave: slave element to add * * Add a virtual slave control to the given master. * Unlike snd_ctl_add_slave(), the element added via this function * is supposed to have volatile values, and get callback is called * at each time quried from the master. * * When the control peeks the hardware values directly and the value * can be changed by other means than the put callback of the element, * this function should be used to keep the value always up-to-date. */ |
f5b1db634 ALSA: add snd_ctl... |
210 211 212 213 214 215 |
static inline int snd_ctl_add_slave_uncached(struct snd_kcontrol *master, struct snd_kcontrol *slave) { return _snd_ctl_add_slave(master, slave, SND_CTL_SLAVE_NEED_UPDATE); } |
35be544af ALSA: Introduce c... |
216 217 218 219 220 221 222 |
/* * Helper functions for jack-detection controls */ struct snd_kcontrol * snd_kctl_jack_new(const char *name, int idx, void *private_data); void snd_kctl_jack_report(struct snd_card *card, struct snd_kcontrol *kctl, bool status); |
1da177e4c Linux-2.6.12-rc2 |
223 |
#endif /* __SOUND_CONTROL_H */ |