src/modules/module-mmkbd-evdev.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2005-2006 Lennart Poettering
   5
   6   PulseAudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU Lesser General Public License as published
   8   by the Free Software Foundation; either version 2.1 of the License,
   9   or (at your option) any later version.
  10
  11   PulseAudio is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with PulseAudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <unistd.h>
  28 #include <string.h>
  29 #include <stdlib.h>
  30 #include <errno.h>
  31 #include <fcntl.h>
  32
  33 #include <linux/input.h>
  34
  35 #include <pulse/xmalloc.h>
  36
  37 #include <pulsecore/core-error.h>
  38 #include <pulsecore/module.h>
  39 #include <pulsecore/log.h>
  40 #include <pulsecore/namereg.h>
  41 #include <pulsecore/sink.h>
  42 #include <pulsecore/modargs.h>
  43 #include <pulsecore/core-util.h>
  44
  45 #include "module-mmkbd-evdev-symdef.h"
  46
  47 PA_MODULE_AUTHOR("Lennart Poettering");
  48 PA_MODULE_DESCRIPTION("Multimedia keyboard support via Linux evdev");
  49 PA_MODULE_VERSION(PACKAGE_VERSION);
  50 PA_MODULE_LOAD_ONCE(FALSE);
  51 PA_MODULE_USAGE("device=<evdev device> sink=<sink name> volume_limit=<volume limit> volume_step=<volume change step>");
  52
  53 #define DEFAULT_DEVICE "/dev/input/event0"
  54
  55 static const char* const valid_modargs[] = {
  56     "device",
  57     "sink",
  58     "volume_limit",
  59     "volume_step",
  60     NULL,
  61 };
  62
  63 struct userdata {
  64     int fd, fd_type;
  65     pa_io_event *io;
  66     char *sink_name;
  67     pa_module *module;
  68     pa_volume_t volume_limit;
  69     pa_volume_t volume_step;
  70 };
  71
  72 static void io_callback(pa_mainloop_api *io, pa_io_event *e, int fd, pa_io_event_flags_t events, void*userdata) {
  73     struct userdata *u = userdata;
  74
  75     pa_assert(io);
  76     pa_assert(u);
  77
  78     if (events & (PA_IO_EVENT_HANGUP|PA_IO_EVENT_ERROR)) {
  79         pa_log("Lost connection to evdev device.");
  80         goto fail;
  81     }
  82
  83     if (events & PA_IO_EVENT_INPUT) {
  84         struct input_event ev;
  85
  86         if (pa_loop_read(u->fd, &ev, sizeof(ev), &u->fd_type) <= 0) {
  87             pa_log("Failed to read from event device: %s", pa_cstrerror(errno));
  88             goto fail;
  89         }
  90
  91         if (ev.type == EV_KEY && (ev.value == 1 || ev.value == 2)) {
  92             enum {
  93                 INVALID,
  94                 UP,
  95                 DOWN,
  96                 MUTE_TOGGLE
  97             } volchange = INVALID;
  98
  99             pa_log_debug("Key code=%u, value=%u", ev.code, ev.value);
 100
 101             switch (ev.code) {
 102                 case KEY_VOLUMEDOWN:
 103                     volchange = DOWN;
 104                     break;
 105
 106                 case KEY_VOLUMEUP:
 107                     volchange = UP;
 108                     break;
 109
 110                 case KEY_MUTE:
 111                     volchange = MUTE_TOGGLE;
 112                     break;
 113             }
 114
 115             if (volchange != INVALID) {
 116                 pa_sink *s;
 117
 118                 if (!(s = pa_namereg_get(u->module->core, u->sink_name, PA_NAMEREG_SINK)))
 119                     pa_log("Failed to get sink '%s'", u->sink_name);
 120                 else {
 121                     pa_cvolume cv = *pa_sink_get_volume(s, FALSE);
 122
 123                     switch (volchange) {
 124                         case UP:
 125                             pa_cvolume_inc_clamp(&cv, u->volume_step, u->volume_limit);
 126                             pa_sink_set_volume(s, &cv, TRUE, TRUE);
 127                             break;
 128
 129                         case DOWN:
 130                             pa_cvolume_dec(&cv, u->volume_step);
 131                             pa_sink_set_volume(s, &cv, TRUE, TRUE);
 132                             break;
 133
 134                         case MUTE_TOGGLE:
 135                             pa_sink_set_mute(s, !pa_sink_get_mute(s, FALSE), TRUE);
 136                             break;
 137
 138                         case INVALID:
 139                             pa_assert_not_reached();
 140                     }
 141                 }
 142             }
 143         }
 144     }
 145
 146     return;
 147
 148 fail:
 149     u->module->core->mainloop->io_free(u->io);
 150     u->io = NULL;
 151
 152     pa_module_unload_request(u->module, TRUE);
 153 }
 154
 155 #define test_bit(bit, array) (array[bit/8] & (1<<(bit%8)))
 156
 157 int pa__init(pa_module*m) {
 158
 159     pa_modargs *ma = NULL;
 160     struct userdata *u;
 161     int version;
 162     struct input_id input_id;
 163     char name[256];
 164     uint8_t evtype_bitmask[EV_MAX/8 + 1];
 165     pa_volume_t volume_limit = PA_VOLUME_NORM*3/2;
 166     pa_volume_t volume_step = PA_VOLUME_NORM/20;
 167
 168     pa_assert(m);
 169
 170     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 171         pa_log("Failed to parse module arguments");
 172         goto fail;
 173     }
 174
 175     if (pa_modargs_get_value_u32(ma, "volume_limit", &volume_limit) < 0) {
 176         pa_log("Failed to parse volume limit");
 177         goto fail;
 178     }
 179
 180     if (pa_modargs_get_value_u32(ma, "volume_step", &volume_step) < 0) {
 181         pa_log("Failed to parse volume step");
 182         goto fail;
 183     }
 184
 185     m->userdata = u = pa_xnew(struct userdata, 1);
 186     u->module = m;
 187     u->io = NULL;
 188     u->sink_name = pa_xstrdup(pa_modargs_get_value(ma, "sink", NULL));
 189     u->fd = -1;
 190     u->fd_type = 0;
 191     u->volume_limit = PA_CLAMP_VOLUME(volume_limit);
 192     u->volume_step = PA_CLAMP_VOLUME(volume_step);
 193
 194     if ((u->fd = pa_open_cloexec(pa_modargs_get_value(ma, "device", DEFAULT_DEVICE), O_RDONLY, 0)) < 0) {
 195         pa_log("Failed to open evdev device: %s", pa_cstrerror(errno));
 196         goto fail;
 197     }
 198
 199     if (ioctl(u->fd, EVIOCGVERSION, &version) < 0) {
 200         pa_log("EVIOCGVERSION failed: %s", pa_cstrerror(errno));
 201         goto fail;
 202     }
 203
 204     pa_log_info("evdev driver version %i.%i.%i", version >> 16, (version >> 8) & 0xff, version & 0xff);
 205
 206     if(ioctl(u->fd, EVIOCGID, &input_id)) {
 207         pa_log("EVIOCGID failed: %s", pa_cstrerror(errno));
 208         goto fail;
 209     }
 210
 211     pa_log_info("evdev vendor 0x%04hx product 0x%04hx version 0x%04hx bustype %u",
 212                 input_id.vendor, input_id.product, input_id.version, input_id.bustype);
 213
 214     memset(name, 0, sizeof(name));
 215     if (ioctl(u->fd, EVIOCGNAME(sizeof(name)), name) < 0) {
 216         pa_log("EVIOCGNAME failed: %s", pa_cstrerror(errno));
 217         goto fail;
 218     }
 219
 220     pa_log_info("evdev device name: %s", name);
 221
 222     memset(evtype_bitmask, 0, sizeof(evtype_bitmask));
 223     if (ioctl(u->fd, EVIOCGBIT(0, EV_MAX), evtype_bitmask) < 0) {
 224         pa_log("EVIOCGBIT failed: %s", pa_cstrerror(errno));
 225         goto fail;
 226     }
 227
 228     if (!test_bit(EV_KEY, evtype_bitmask)) {
 229         pa_log("Device has no keys.");
 230         goto fail;
 231     }
 232
 233     u->io = m->core->mainloop->io_new(m->core->mainloop, u->fd, PA_IO_EVENT_INPUT|PA_IO_EVENT_HANGUP, io_callback, u);
 234
 235     pa_modargs_free(ma);
 236
 237     return 0;
 238
 239 fail:
 240
 241     if (ma)
 242         pa_modargs_free(ma);
 243
 244     pa__done(m);
 245     return -1;
 246 }
 247
 248 void pa__done(pa_module*m) {
 249     struct userdata *u;
 250
 251     pa_assert(m);
 252
 253     if (!(u = m->userdata))
 254         return;
 255
 256     if (u->io)
 257         m->core->mainloop->io_free(u->io);
 258
 259     if (u->fd >= 0)
 260         pa_assert_se(pa_close(u->fd) == 0);
 261
 262     pa_xfree(u->sink_name);
 263     pa_xfree(u);
 264 }