src/modules/module-position-event-sounds.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 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 <unistd.h>
  27 #include <errno.h>
  28 #include <sys/types.h>
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31
  32 #include <pulse/xmalloc.h>
  33 #include <pulse/volume.h>
  34 #include <pulse/channelmap.h>
  35
  36 #include <pulsecore/module.h>
  37 #include <pulsecore/core-util.h>
  38 #include <pulsecore/modargs.h>
  39 #include <pulsecore/log.h>
  40 #include <pulsecore/sink-input.h>
  41
  42 #include "module-position-event-sounds-symdef.h"
  43
  44 PA_MODULE_AUTHOR("Lennart Poettering");
  45 PA_MODULE_DESCRIPTION("Position event sounds between L and R depending on the position on screen of the widget triggering them.");
  46 PA_MODULE_VERSION(PACKAGE_VERSION);
  47 PA_MODULE_LOAD_ONCE(TRUE);
  48
  49 static const char* const valid_modargs[] = {
  50     NULL
  51 };
  52
  53 struct userdata {
  54     pa_hook_slot *sink_input_fixate_hook_slot;
  55 };
  56
  57 static int parse_pos(const char *pos, double *f) {
  58
  59     if (pa_atod(pos, f) < 0) {
  60         pa_log_warn("Failed to parse hpos/vpos property '%s'.", pos);
  61         return -1;
  62     }
  63
  64     if (*f < 0.0 || *f > 1.0) {
  65         pa_log_debug("Property hpos/vpos out of range %0.2f", *f);
  66
  67         *f = PA_CLAMP(*f, 0.0, 1.0);
  68     }
  69
  70     return 0;
  71 }
  72
  73 static pa_hook_result_t sink_input_fixate_hook_callback(pa_core *core, pa_sink_input_new_data *data, struct userdata *u) {
  74     const char *hpos, *vpos, *role, *id;
  75     double f;
  76     char t[PA_CVOLUME_SNPRINT_MAX];
  77     pa_cvolume v;
  78
  79     pa_assert(data);
  80
  81     if (!(role = pa_proplist_gets(data->proplist, PA_PROP_MEDIA_ROLE)))
  82         return PA_HOOK_OK;
  83
  84     if (!pa_streq(role, "event"))
  85         return PA_HOOK_OK;
  86
  87     if ((id = pa_proplist_gets(data->proplist, PA_PROP_EVENT_ID))) {
  88
  89         /* The test sounds should never be positioned in space, since
  90          * they might be triggered themselves to configure the speakers
  91          * in space, which we don't want to mess up. */
  92
  93         if (pa_startswith(id, "audio-channel-"))
  94             return PA_HOOK_OK;
  95
  96         if (pa_streq(id, "audio-volume-change"))
  97             return PA_HOOK_OK;
  98
  99         if (pa_streq(id, "audio-test-signal"))
 100             return PA_HOOK_OK;
 101     }
 102
 103     if (!(hpos = pa_proplist_gets(data->proplist, PA_PROP_EVENT_MOUSE_HPOS)))
 104         hpos = pa_proplist_gets(data->proplist, PA_PROP_WINDOW_HPOS);
 105
 106     if (!(vpos = pa_proplist_gets(data->proplist, PA_PROP_EVENT_MOUSE_VPOS)))
 107         vpos = pa_proplist_gets(data->proplist, PA_PROP_WINDOW_VPOS);
 108
 109     if (!hpos && !vpos)
 110         return PA_HOOK_OK;
 111
 112     pa_cvolume_reset(&v, data->sink->sample_spec.channels);
 113
 114     if (hpos) {
 115         if (parse_pos(hpos, &f) < 0)
 116             return PA_HOOK_OK;
 117
 118         if (pa_channel_map_can_balance(&data->sink->channel_map)) {
 119             pa_log_debug("Positioning event sound '%s' horizontally at %0.2f.", pa_strnull(pa_proplist_gets(data->proplist, PA_PROP_EVENT_ID)), f);
 120             pa_cvolume_set_balance(&v, &data->sink->channel_map, f*2.0-1.0);
 121         }
 122     }
 123
 124     if (vpos) {
 125         if (parse_pos(vpos, &f) < 0)
 126             return PA_HOOK_OK;
 127
 128         if (pa_channel_map_can_fade(&data->sink->channel_map)) {
 129             pa_log_debug("Positioning event sound '%s' vertically at %0.2f.", pa_strnull(pa_proplist_gets(data->proplist, PA_PROP_EVENT_ID)), f);
 130             pa_cvolume_set_fade(&v, &data->sink->channel_map, f*2.0-1.0);
 131         }
 132     }
 133
 134     pa_log_debug("Final volume factor %s.", pa_cvolume_snprint(t, sizeof(t), &v));
 135     pa_sink_input_new_data_apply_volume_factor_sink(data, &v);
 136
 137     return PA_HOOK_OK;
 138 }
 139
 140 int pa__init(pa_module*m) {
 141     pa_modargs *ma = NULL;
 142     struct userdata *u;
 143
 144     pa_assert(m);
 145
 146     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 147         pa_log("Failed to parse module arguments");
 148         goto fail;
 149     }
 150
 151     m->userdata = u = pa_xnew(struct userdata, 1);
 152     u->sink_input_fixate_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_FIXATE], PA_HOOK_EARLY, (pa_hook_cb_t) sink_input_fixate_hook_callback, u);
 153
 154     pa_modargs_free(ma);
 155
 156     return 0;
 157
 158 fail:
 159     pa__done(m);
 160
 161     if (ma)
 162         pa_modargs_free(ma);
 163
 164     return -1;
 165 }
 166
 167 void pa__done(pa_module*m) {
 168     struct userdata* u;
 169
 170     pa_assert(m);
 171
 172     if (!(u = m->userdata))
 173         return;
 174
 175     if (u->sink_input_fixate_hook_slot)
 176         pa_hook_slot_free(u->sink_input_fixate_hook_slot);
 177
 178     pa_xfree(u);
 179 }