src/modules/module-x11-bell.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   Copyright 2004-2006 Lennart Poettering
   7
   8   PulseAudio is free software; you can redistribute it and/or modify
   9   it under the terms of the GNU Lesser General Public License as published
  10   by the Free Software Foundation; either version 2 of the License,
  11   or (at your option) any later version.
  12
  13   PulseAudio is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with PulseAudio; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21   USA.
  22 ***/
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31
  32 #include <X11/Xlib.h>
  33 #include <X11/XKBlib.h>
  34
  35 #include <pulse/xmalloc.h>
  36
  37 #include <pulsecore/iochannel.h>
  38 #include <pulsecore/sink.h>
  39 #include <pulsecore/core-scache.h>
  40 #include <pulsecore/modargs.h>
  41 #include <pulsecore/namereg.h>
  42 #include <pulsecore/log.h>
  43 #include <pulsecore/x11wrap.h>
  44
  45 #include "module-x11-bell-symdef.h"
  46
  47 PA_MODULE_AUTHOR("Lennart Poettering");
  48 PA_MODULE_DESCRIPTION("X11 Bell interceptor");
  49 PA_MODULE_VERSION(PACKAGE_VERSION);
  50 PA_MODULE_LOAD_ONCE(FALSE);
  51 PA_MODULE_USAGE("sink=<sink to connect to> sample=<sample name> display=<X11 display>");
  52
  53 struct userdata {
  54     pa_core *core;
  55     int xkb_event_base;
  56     char *sink_name;
  57     char *scache_item;
  58
  59     pa_x11_wrapper *x11_wrapper;
  60     pa_x11_client *x11_client;
  61 };
  62
  63 static const char* const valid_modargs[] = {
  64     "sink",
  65     "sample",
  66     "display",
  67     NULL
  68 };
  69
  70 static int x11_event_callback(pa_x11_wrapper *w, XEvent *e, void *userdata) {
  71     XkbBellNotifyEvent *bne;
  72     struct userdata *u = userdata;
  73
  74     pa_assert(w);
  75     pa_assert(e);
  76     pa_assert(u);
  77     pa_assert(u->x11_wrapper == w);
  78
  79     if (((XkbEvent*) e)->any.xkb_type != XkbBellNotify)
  80         return 0;
  81
  82     bne = (XkbBellNotifyEvent*) e;
  83
  84     if (pa_scache_play_item_by_name(u->core, u->scache_item, u->sink_name, TRUE, (bne->percent*PA_VOLUME_NORM)/100, NULL, NULL) < 0) {
  85         pa_log_info("Ringing bell failed, reverting to X11 device bell.");
  86         XkbForceDeviceBell(pa_x11_wrapper_get_display(w), bne->device, bne->bell_class, bne->bell_id, bne->percent);
  87     }
  88
  89     return 1;
  90 }
  91
  92 int pa__init(pa_module*m) {
  93
  94     struct userdata *u = NULL;
  95     pa_modargs *ma = NULL;
  96     int major, minor;
  97     unsigned int auto_ctrls, auto_values;
  98
  99     pa_assert(m);
 100
 101     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 102         pa_log("Failed to parse module arguments");
 103         goto fail;
 104     }
 105
 106     m->userdata = u = pa_xnew(struct userdata, 1);
 107     u->core = m->core;
 108     u->scache_item = pa_xstrdup(pa_modargs_get_value(ma, "sample", "x11-bell"));
 109     u->sink_name = pa_xstrdup(pa_modargs_get_value(ma, "sink", NULL));
 110     u->x11_client = NULL;
 111
 112     if (!(u->x11_wrapper = pa_x11_wrapper_get(m->core, pa_modargs_get_value(ma, "display", NULL))))
 113         goto fail;
 114
 115     major = XkbMajorVersion;
 116     minor = XkbMinorVersion;
 117
 118     if (!XkbLibraryVersion(&major, &minor)) {
 119         pa_log("XkbLibraryVersion() failed");
 120         goto fail;
 121     }
 122
 123     major = XkbMajorVersion;
 124     minor = XkbMinorVersion;
 125
 126     if (!XkbQueryExtension(pa_x11_wrapper_get_display(u->x11_wrapper), NULL, &u->xkb_event_base, NULL, &major, &minor)) {
 127         pa_log("XkbQueryExtension() failed");
 128         goto fail;
 129     }
 130
 131     XkbSelectEvents(pa_x11_wrapper_get_display(u->x11_wrapper), XkbUseCoreKbd, XkbBellNotifyMask, XkbBellNotifyMask);
 132     auto_ctrls = auto_values = XkbAudibleBellMask;
 133     XkbSetAutoResetControls(pa_x11_wrapper_get_display(u->x11_wrapper), XkbAudibleBellMask, &auto_ctrls, &auto_values);
 134     XkbChangeEnabledControls(pa_x11_wrapper_get_display(u->x11_wrapper), XkbUseCoreKbd, XkbAudibleBellMask, 0);
 135
 136     u->x11_client = pa_x11_client_new(u->x11_wrapper, x11_event_callback, u);
 137
 138     pa_modargs_free(ma);
 139
 140     return 0;
 141
 142 fail:
 143     if (ma)
 144         pa_modargs_free(ma);
 145
 146     pa__done(m);
 147
 148     return -1;
 149 }
 150
 151 void pa__done(pa_module*m) {
 152     struct userdata *u;
 153
 154     pa_assert(m);
 155
 156     if (!m->userdata)
 157         return;
 158
 159     u = m->userdata;
 160
 161     pa_xfree(u->scache_item);
 162     pa_xfree(u->sink_name);
 163
 164     if (u->x11_client)
 165         pa_x11_client_free(u->x11_client);
 166
 167     if (u->x11_wrapper)
 168         pa_x11_wrapper_unref(u->x11_wrapper);
 169
 170     pa_xfree(u);
 171 }