include/sound/control.h

   1 #ifndef __SOUND_CONTROL_H
   2 #define __SOUND_CONTROL_H
   3
   4 /*
   5  *  Header file for control interface
   6  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
   7  *
   8  *
   9  *   This program is free software; you can redistribute it and/or modify
  10  *   it under the terms of the GNU General Public License as published by
  11  *   the Free Software Foundation; either version 2 of the License, or
  12  *   (at your option) any later version.
  13  *
  14  *   This program is distributed in the hope that it will be useful,
  15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *   GNU General Public License for more details.
  18  *
  19  *   You should have received a copy of the GNU General Public License
  20  *   along with this program; if not, write to the Free Software
  21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  22  *
  23  */
  24
  25 #include <sound/asound.h>
  26
  27 #define snd_kcontrol_chip(kcontrol) ((kcontrol)->private_data)
  28
  29 struct snd_kcontrol;
  30 typedef int (snd_kcontrol_info_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_info * uinfo);
  31 typedef int (snd_kcontrol_get_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
  32 typedef int (snd_kcontrol_put_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
  33
  34 struct snd_kcontrol_new {
  35         snd_ctl_elem_iface_t iface;     /* interface identifier */
  36         unsigned int device;            /* device/client number */
  37         unsigned int subdevice;         /* subdevice (substream) number */
  38         unsigned char *name;            /* ASCII name of item */
  39         unsigned int index;             /* index of item */
  40         unsigned int access;            /* access rights */
  41         unsigned int count;             /* count of same elements */
  42         snd_kcontrol_info_t *info;
  43         snd_kcontrol_get_t *get;
  44         snd_kcontrol_put_t *put;
  45         unsigned int *tlv;
  46         unsigned long private_value;
  47 };
  48
  49 struct snd_kcontrol_volatile {
  50         struct snd_ctl_file *owner;     /* locked */
  51         pid_t owner_pid;
  52         unsigned int access;    /* access rights */
  53 };
  54
  55 struct snd_kcontrol {
  56         struct list_head list;          /* list of controls */
  57         struct snd_ctl_elem_id id;
  58         unsigned int count;             /* count of same elements */
  59         snd_kcontrol_info_t *info;
  60         snd_kcontrol_get_t *get;
  61         snd_kcontrol_put_t *put;
  62         unsigned int *tlv;
  63         unsigned long private_value;
  64         void *private_data;
  65         void (*private_free)(struct snd_kcontrol *kcontrol);
  66         struct snd_kcontrol_volatile vd[0];     /* volatile data */
  67 };
  68
  69 #define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list)
  70
  71 struct snd_kctl_event {
  72         struct list_head list;  /* list of events */
  73         struct snd_ctl_elem_id id;
  74         unsigned int mask;
  75 };
  76
  77 #define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list)
  78
  79 struct snd_ctl_file {
  80         struct list_head list;          /* list of all control files */
  81         struct snd_card *card;
  82         pid_t pid;
  83         int prefer_pcm_subdevice;
  84         int prefer_rawmidi_subdevice;
  85         wait_queue_head_t change_sleep;
  86         spinlock_t read_lock;
  87         struct fasync_struct *fasync;
  88         int subscribed;                 /* read interface is activated */
  89         struct list_head events;        /* waiting events for read */
  90 };
  91
  92 #define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list)
  93
  94 typedef int (*snd_kctl_ioctl_func_t) (struct snd_card * card,
  95                                       struct snd_ctl_file * control,
  96                                       unsigned int cmd, unsigned long arg);
  97
  98 void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id);
  99
 100 struct snd_kcontrol *snd_ctl_new(struct snd_kcontrol * kcontrol, unsigned int access);
 101 struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new * kcontrolnew, void * private_data);
 102 void snd_ctl_free_one(struct snd_kcontrol * kcontrol);
 103 int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol);
 104 int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol);
 105 int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id);
 106 int snd_ctl_rename_id(struct snd_card * card, struct snd_ctl_elem_id *src_id, struct snd_ctl_elem_id *dst_id);
 107 struct snd_kcontrol *snd_ctl_find_numid(struct snd_card * card, unsigned int numid);
 108 struct snd_kcontrol *snd_ctl_find_id(struct snd_card * card, struct snd_ctl_elem_id *id);
 109
 110 int snd_ctl_create(struct snd_card *card);
 111
 112 int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn);
 113 int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn);
 114 #ifdef CONFIG_COMPAT
 115 int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn);
 116 int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn);
 117 #else
 118 #define snd_ctl_register_ioctl_compat(fcn)
 119 #define snd_ctl_unregister_ioctl_compat(fcn)
 120 #endif
 121
 122 int snd_ctl_elem_read(struct snd_card *card, struct snd_ctl_elem_value *control);
 123 int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file, struct snd_ctl_elem_value *control);
 124
 125 static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
 126 {
 127         return id->numid - kctl->id.numid;
 128 }
 129
 130 static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
 131 {
 132         return id->index - kctl->id.index;
 133 }
 134
 135 static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
 136 {
 137         if (id->numid) {
 138                 return snd_ctl_get_ioffnum(kctl, id);
 139         } else {
 140                 return snd_ctl_get_ioffidx(kctl, id);
 141         }
 142 }
 143
 144 static inline struct snd_ctl_elem_id *snd_ctl_build_ioff(struct snd_ctl_elem_id *dst_id,
 145                                                     struct snd_kcontrol *src_kctl,
 146                                                     unsigned int offset)
 147 {
 148         *dst_id = src_kctl->id;
 149         dst_id->index += offset;
 150         dst_id->numid += offset;
 151         return dst_id;
 152 }
 153
 154 #endif  /* __SOUND_CONTROL_H */