sound/core/vmaster.c

   1 /*
   2  * Virtual master and slave controls
   3  *
   4  *  Copyright (c) 2008 by Takashi Iwai <tiwai@suse.de>
   5  *
   6  *  This program is free software; you can redistribute it and/or
   7  *  modify it under the terms of the GNU General Public License as
   8  *  published by the Free Software Foundation, version 2.
   9  *
  10  */
  11
  12 #include <linux/slab.h>
  13 #include <linux/export.h>
  14 #include <sound/core.h>
  15 #include <sound/control.h>
  16 #include <sound/tlv.h>
  17
  18 /*
  19  * a subset of information returned via ctl info callback
  20  */
  21 struct link_ctl_info {
  22         snd_ctl_elem_type_t type; /* value type */
  23         int count;              /* item count */
  24         int min_val, max_val;   /* min, max values */
  25 };
  26
  27 /*
  28  * link master - this contains a list of slave controls that are
  29  * identical types, i.e. info returns the same value type and value
  30  * ranges, but may have different number of counts.
  31  *
  32  * The master control is so far only mono volume/switch for simplicity.
  33  * The same value will be applied to all slaves.
  34  */
  35 struct link_master {
  36         struct list_head slaves;
  37         struct link_ctl_info info;
  38         int val;                /* the master value */
  39         unsigned int tlv[4];
  40         void (*hook)(void *private_data, int);
  41         void *hook_private_data;
  42 };
  43
  44 /*
  45  * link slave - this contains a slave control element
  46  *
  47  * It fakes the control callbacsk with additional attenuation by the
  48  * master control.  A slave may have either one or two channels.
  49  */
  50
  51 struct link_slave {
  52         struct list_head list;
  53         struct link_master *master;
  54         struct link_ctl_info info;
  55         int vals[2];            /* current values */
  56         unsigned int flags;
  57         struct snd_kcontrol *kctl; /* original kcontrol pointer */
  58         struct snd_kcontrol slave; /* the copy of original control entry */
  59 };
  60
  61 static int slave_update(struct link_slave *slave)
  62 {
  63         struct snd_ctl_elem_value *uctl;
  64         int err, ch;
  65
  66         uctl = kmalloc(sizeof(*uctl), GFP_KERNEL);
  67         if (!uctl)
  68                 return -ENOMEM;
  69         uctl->id = slave->slave.id;
  70         err = slave->slave.get(&slave->slave, uctl);
  71         for (ch = 0; ch < slave->info.count; ch++)
  72                 slave->vals[ch] = uctl->value.integer.value[ch];
  73         kfree(uctl);
  74         return 0;
  75 }
  76
  77 /* get the slave ctl info and save the initial values */
  78 static int slave_init(struct link_slave *slave)
  79 {
  80         struct snd_ctl_elem_info *uinfo;
  81         int err;
  82
  83         if (slave->info.count) {
  84                 /* already initialized */
  85                 if (slave->flags & SND_CTL_SLAVE_NEED_UPDATE)
  86                         return slave_update(slave);
  87                 return 0;
  88         }
  89
  90         uinfo = kmalloc(sizeof(*uinfo), GFP_KERNEL);
  91         if (!uinfo)
  92                 return -ENOMEM;
  93         uinfo->id = slave->slave.id;
  94         err = slave->slave.info(&slave->slave, uinfo);
  95         if (err < 0) {
  96                 kfree(uinfo);
  97                 return err;
  98         }
  99         slave->info.type = uinfo->type;
 100         slave->info.count = uinfo->count;
 101         if (slave->info.count > 2  ||
 102             (slave->info.type != SNDRV_CTL_ELEM_TYPE_INTEGER &&
 103              slave->info.type != SNDRV_CTL_ELEM_TYPE_BOOLEAN)) {
 104                 snd_printk(KERN_ERR "invalid slave element\n");
 105                 kfree(uinfo);
 106                 return -EINVAL;
 107         }
 108         slave->info.min_val = uinfo->value.integer.min;
 109         slave->info.max_val = uinfo->value.integer.max;
 110         kfree(uinfo);
 111
 112         return slave_update(slave);
 113 }
 114
 115 /* initialize master volume */
 116 static int master_init(struct link_master *master)
 117 {
 118         struct link_slave *slave;
 119
 120         if (master->info.count)
 121                 return 0; /* already initialized */
 122
 123         list_for_each_entry(slave, &master->slaves, list) {
 124                 int err = slave_init(slave);
 125                 if (err < 0)
 126                         return err;
 127                 master->info = slave->info;
 128                 master->info.count = 1; /* always mono */
 129                 /* set full volume as default (= no attenuation) */
 130                 master->val = master->info.max_val;
 131                 if (master->hook)
 132                         master->hook(master->hook_private_data, master->val);
 133                 return 1;
 134         }
 135         return -ENOENT;
 136 }
 137
 138 static int slave_get_val(struct link_slave *slave,
 139                          struct snd_ctl_elem_value *ucontrol)
 140 {
 141         int err, ch;
 142
 143         err = slave_init(slave);
 144         if (err < 0)
 145                 return err;
 146         for (ch = 0; ch < slave->info.count; ch++)
 147                 ucontrol->value.integer.value[ch] = slave->vals[ch];
 148         return 0;
 149 }
 150
 151 static int slave_put_val(struct link_slave *slave,
 152                          struct snd_ctl_elem_value *ucontrol)
 153 {
 154         int err, ch, vol;
 155
 156         err = master_init(slave->master);
 157         if (err < 0)
 158                 return err;
 159
 160         switch (slave->info.type) {
 161         case SNDRV_CTL_ELEM_TYPE_BOOLEAN:
 162                 for (ch = 0; ch < slave->info.count; ch++)
 163                         ucontrol->value.integer.value[ch] &=
 164                                 !!slave->master->val;
 165                 break;
 166         case SNDRV_CTL_ELEM_TYPE_INTEGER:
 167                 for (ch = 0; ch < slave->info.count; ch++) {
 168                         /* max master volume is supposed to be 0 dB */
 169                         vol = ucontrol->value.integer.value[ch];
 170                         vol += slave->master->val - slave->master->info.max_val;
 171                         if (vol < slave->info.min_val)
 172                                 vol = slave->info.min_val;
 173                         else if (vol > slave->info.max_val)
 174                                 vol = slave->info.max_val;
 175                         ucontrol->value.integer.value[ch] = vol;
 176                 }
 177                 break;
 178         }
 179         return slave->slave.put(&slave->slave, ucontrol);
 180 }
 181
 182 /*
 183  * ctl callbacks for slaves
 184  */
 185 static int slave_info(struct snd_kcontrol *kcontrol,
 186                       struct snd_ctl_elem_info *uinfo)
 187 {
 188         struct link_slave *slave = snd_kcontrol_chip(kcontrol);
 189         return slave->slave.info(&slave->slave, uinfo);
 190 }
 191
 192 static int slave_get(struct snd_kcontrol *kcontrol,
 193                      struct snd_ctl_elem_value *ucontrol)
 194 {
 195         struct link_slave *slave = snd_kcontrol_chip(kcontrol);
 196         return slave_get_val(slave, ucontrol);
 197 }
 198
 199 static int slave_put(struct snd_kcontrol *kcontrol,
 200                      struct snd_ctl_elem_value *ucontrol)
 201 {
 202         struct link_slave *slave = snd_kcontrol_chip(kcontrol);
 203         int err, ch, changed = 0;
 204
 205         err = slave_init(slave);
 206         if (err < 0)
 207                 return err;
 208         for (ch = 0; ch < slave->info.count; ch++) {
 209                 if (slave->vals[ch] != ucontrol->value.integer.value[ch]) {
 210                         changed = 1;
 211                         slave->vals[ch] = ucontrol->value.integer.value[ch];
 212                 }
 213         }
 214         if (!changed)
 215                 return 0;
 216         err = slave_put_val(slave, ucontrol);
 217         if (err < 0)
 218                 return err;
 219         return 1;
 220 }
 221
 222 static int slave_tlv_cmd(struct snd_kcontrol *kcontrol,
 223                          int op_flag, unsigned int size,
 224                          unsigned int __user *tlv)
 225 {
 226         struct link_slave *slave = snd_kcontrol_chip(kcontrol);
 227         /* FIXME: this assumes that the max volume is 0 dB */
 228         return slave->slave.tlv.c(&slave->slave, op_flag, size, tlv);
 229 }
 230
 231 static void slave_free(struct snd_kcontrol *kcontrol)
 232 {
 233         struct link_slave *slave = snd_kcontrol_chip(kcontrol);
 234         if (slave->slave.private_free)
 235                 slave->slave.private_free(&slave->slave);
 236         if (slave->master)
 237                 list_del(&slave->list);
 238         kfree(slave);
 239 }
 240
 241 /*
 242  * Add a slave control to the group with the given master control
 243  *
 244  * All slaves must be the same type (returning the same information
 245  * via info callback).  The function doesn't check it, so it's your
 246  * responsibility.
 247  *
 248  * Also, some additional limitations:
 249  * - at most two channels
 250  * - logarithmic volume control (dB level), no linear volume
 251  * - master can only attenuate the volume, no gain
 252  */
 253 int _snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave,
 254                        unsigned int flags)
 255 {
 256         struct link_master *master_link = snd_kcontrol_chip(master);
 257         struct link_slave *srec;
 258
 259         srec = kzalloc(sizeof(*srec) +
 260                        slave->count * sizeof(*slave->vd), GFP_KERNEL);
 261         if (!srec)
 262                 return -ENOMEM;
 263         srec->kctl = slave;
 264         srec->slave = *slave;
 265         memcpy(srec->slave.vd, slave->vd, slave->count * sizeof(*slave->vd));
 266         srec->master = master_link;
 267         srec->flags = flags;
 268
 269         /* override callbacks */
 270         slave->info = slave_info;
 271         slave->get = slave_get;
 272         slave->put = slave_put;
 273         if (slave->vd[0].access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)
 274                 slave->tlv.c = slave_tlv_cmd;
 275         slave->private_data = srec;
 276         slave->private_free = slave_free;
 277
 278         list_add_tail(&srec->list, &master_link->slaves);
 279         return 0;
 280 }
 281 EXPORT_SYMBOL(_snd_ctl_add_slave);
 282
 283 /*
 284  * ctl callbacks for master controls
 285  */
 286 static int master_info(struct snd_kcontrol *kcontrol,
 287                       struct snd_ctl_elem_info *uinfo)
 288 {
 289         struct link_master *master = snd_kcontrol_chip(kcontrol);
 290         int ret;
 291
 292         ret = master_init(master);
 293         if (ret < 0)
 294                 return ret;
 295         uinfo->type = master->info.type;
 296         uinfo->count = master->info.count;
 297         uinfo->value.integer.min = master->info.min_val;
 298         uinfo->value.integer.max = master->info.max_val;
 299         return 0;
 300 }
 301
 302 static int master_get(struct snd_kcontrol *kcontrol,
 303                       struct snd_ctl_elem_value *ucontrol)
 304 {
 305         struct link_master *master = snd_kcontrol_chip(kcontrol);
 306         int err = master_init(master);
 307         if (err < 0)
 308                 return err;
 309         ucontrol->value.integer.value[0] = master->val;
 310         return 0;
 311 }
 312
 313 static int master_put(struct snd_kcontrol *kcontrol,
 314                       struct snd_ctl_elem_value *ucontrol)
 315 {
 316         struct link_master *master = snd_kcontrol_chip(kcontrol);
 317         struct link_slave *slave;
 318         struct snd_ctl_elem_value *uval;
 319         int err, old_val;
 320
 321         err = master_init(master);
 322         if (err < 0)
 323                 return err;
 324         old_val = master->val;
 325         if (ucontrol->value.integer.value[0] == old_val)
 326                 return 0;
 327
 328         uval = kmalloc(sizeof(*uval), GFP_KERNEL);
 329         if (!uval)
 330                 return -ENOMEM;
 331         list_for_each_entry(slave, &master->slaves, list) {
 332                 master->val = old_val;
 333                 uval->id = slave->slave.id;
 334                 slave_get_val(slave, uval);
 335                 master->val = ucontrol->value.integer.value[0];
 336                 slave_put_val(slave, uval);
 337         }
 338         kfree(uval);
 339         if (master->hook && !err)
 340                 master->hook(master->hook_private_data, master->val);
 341         return 1;
 342 }
 343
 344 static void master_free(struct snd_kcontrol *kcontrol)
 345 {
 346         struct link_master *master = snd_kcontrol_chip(kcontrol);
 347         struct link_slave *slave, *n;
 348
 349         /* free all slave links and retore the original slave kctls */
 350         list_for_each_entry_safe(slave, n, &master->slaves, list) {
 351                 struct snd_kcontrol *sctl = slave->kctl;
 352                 struct list_head olist = sctl->list;
 353                 memcpy(sctl, &slave->slave, sizeof(*sctl));
 354                 memcpy(sctl->vd, slave->slave.vd,
 355                        sctl->count * sizeof(*sctl->vd));
 356                 sctl->list = olist; /* keep the current linked-list */
 357                 kfree(slave);
 358         }
 359         kfree(master);
 360 }
 361
 362
 363 /**
 364  * snd_ctl_make_virtual_master - Create a virtual master control
 365  * @name: name string of the control element to create
 366  * @tlv: optional TLV int array for dB information
 367  *
 368  * Creates a virtual matster control with the given name string.
 369  * Returns the created control element, or NULL for errors (ENOMEM).
 370  *
 371  * After creating a vmaster element, you can add the slave controls
 372  * via snd_ctl_add_slave() or snd_ctl_add_slave_uncached().
 373  *
 374  * The optional argument @tlv can be used to specify the TLV information
 375  * for dB scale of the master control.  It should be a single element
 376  * with #SNDRV_CTL_TLVT_DB_SCALE, #SNDRV_CTL_TLV_DB_MINMAX or
 377  * #SNDRV_CTL_TLVT_DB_MINMAX_MUTE type, and should be the max 0dB.
 378  */
 379 struct snd_kcontrol *snd_ctl_make_virtual_master(char *name,
 380                                                  const unsigned int *tlv)
 381 {
 382         struct link_master *master;
 383         struct snd_kcontrol *kctl;
 384         struct snd_kcontrol_new knew;
 385
 386         memset(&knew, 0, sizeof(knew));
 387         knew.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
 388         knew.name = name;
 389         knew.info = master_info;
 390
 391         master = kzalloc(sizeof(*master), GFP_KERNEL);
 392         if (!master)
 393                 return NULL;
 394         INIT_LIST_HEAD(&master->slaves);
 395
 396         kctl = snd_ctl_new1(&knew, master);
 397         if (!kctl) {
 398                 kfree(master);
 399                 return NULL;
 400         }
 401         /* override some callbacks */
 402         kctl->info = master_info;
 403         kctl->get = master_get;
 404         kctl->put = master_put;
 405         kctl->private_free = master_free;
 406
 407         /* additional (constant) TLV read */
 408         if (tlv &&
 409             (tlv[0] == SNDRV_CTL_TLVT_DB_SCALE ||
 410              tlv[0] == SNDRV_CTL_TLVT_DB_MINMAX ||
 411              tlv[0] == SNDRV_CTL_TLVT_DB_MINMAX_MUTE)) {
 412                 kctl->vd[0].access |= SNDRV_CTL_ELEM_ACCESS_TLV_READ;
 413                 memcpy(master->tlv, tlv, sizeof(master->tlv));
 414                 kctl->tlv.p = master->tlv;
 415         }
 416
 417         return kctl;
 418 }
 419 EXPORT_SYMBOL(snd_ctl_make_virtual_master);
 420
 421 /**
 422  * snd_ctl_add_vmaster_hook - Add a hook to a vmaster control
 423  * @kcontrol: vmaster kctl element
 424  * @hook: the hook function
 425  * @private_data: the private_data pointer to be saved
 426  *
 427  * Adds the given hook to the vmaster control element so that it's called
 428  * at each time when the value is changed.
 429  */
 430 int snd_ctl_add_vmaster_hook(struct snd_kcontrol *kcontrol,
 431                              void (*hook)(void *private_data, int),
 432                              void *private_data)
 433 {
 434         struct link_master *master = snd_kcontrol_chip(kcontrol);
 435         master->hook = hook;
 436         master->hook_private_data = private_data;
 437         return 0;
 438 }
 439 EXPORT_SYMBOL_GPL(snd_ctl_add_vmaster_hook);
 440
 441 /**
 442  * snd_ctl_sync_vmaster_hook - Sync the vmaster hook
 443  * @kcontrol: vmaster kctl element
 444  *
 445  * Call the hook function to synchronize with the current value of the given
 446  * vmaster element.  NOP when NULL is passed to @kcontrol or the hook doesn't
 447  * exist.
 448  */
 449 void snd_ctl_sync_vmaster_hook(struct snd_kcontrol *kcontrol)
 450 {
 451         struct link_master *master;
 452         if (!kcontrol)
 453                 return;
 454         master = snd_kcontrol_chip(kcontrol);
 455         if (master->hook)
 456                 master->hook(master->hook_private_data, master->val);
 457 }
 458 EXPORT_SYMBOL_GPL(snd_ctl_sync_vmaster_hook);