code.delx.au - pulseaudio/blob - src/modules/module-remap-sink.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2008 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 <pulse/xmalloc.h>
  27
  28 #include <pulsecore/core-error.h>
  29 #include <pulsecore/namereg.h>
  30 #include <pulsecore/sink.h>
  31 #include <pulsecore/module.h>
  32 #include <pulsecore/core-util.h>
  33 #include <pulsecore/modargs.h>
  34 #include <pulsecore/log.h>
  35 #include <pulsecore/thread.h>
  36 #include <pulsecore/thread-mq.h>
  37 #include <pulsecore/rtpoll.h>
  38
  39 #include "module-remap-sink-symdef.h"
  40
  41 PA_MODULE_AUTHOR("Lennart Poettering");
  42 PA_MODULE_DESCRIPTION("Virtual channel remapping sink");
  43 PA_MODULE_VERSION(PACKAGE_VERSION);
  44 PA_MODULE_LOAD_ONCE(FALSE);
  45 PA_MODULE_USAGE(
  46         "sink_name=<name for the sink> "
  47         "sink_properties=<properties for the sink> "
  48         "master=<name of sink to remap> "
  49         "master_channel_map=<channel map> "
  50         "format=<sample format> "
  51         "channels=<number of channels> "
  52         "rate=<sample rate> "
  53         "channel_map=<channel map> "
  54         "remix=<remix channels?>");
  55
  56 struct userdata {
  57     pa_core *core;
  58     pa_module *module;
  59
  60     pa_sink *sink, *master;
  61     pa_sink_input *sink_input;
  62 };
  63
  64 static const char* const valid_modargs[] = {
  65     "sink_name",
  66     "sink_properties",
  67     "master",
  68     "master_channel_map",
  69     "format",
  70     "rate",
  71     "channels",
  72     "channel_map",
  73     "remix",
  74     NULL
  75 };
  76
  77 /* Called from I/O thread context */
  78 static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
  79     struct userdata *u = PA_SINK(o)->userdata;
  80
  81     switch (code) {
  82
  83         case PA_SINK_MESSAGE_GET_LATENCY: {
  84             pa_usec_t usec = 0;
  85
  86             /* Get the latency of the master sink */
  87             if (PA_MSGOBJECT(u->master)->process_msg(PA_MSGOBJECT(u->master), PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
  88                 usec = 0;
  89
  90             /* Add the latency internal to our sink input on top */
  91             usec += pa_bytes_to_usec(pa_memblockq_get_length(u->sink_input->thread_info.render_memblockq), &u->master->sample_spec);
  92
  93             *((pa_usec_t*) data) = usec;
  94             return 0;
  95         }
  96     }
  97
  98     return pa_sink_process_msg(o, code, data, offset, chunk);
  99 }
 100
 101 /* Called from main context */
 102 static int sink_set_state(pa_sink *s, pa_sink_state_t state) {
 103     struct userdata *u;
 104
 105     pa_sink_assert_ref(s);
 106     pa_assert_se(u = s->userdata);
 107
 108     if (PA_SINK_IS_LINKED(state) &&
 109         u->sink_input &&
 110         PA_SINK_INPUT_IS_LINKED(pa_sink_input_get_state(u->sink_input)))
 111
 112         pa_sink_input_cork(u->sink_input, state == PA_SINK_SUSPENDED);
 113
 114     return 0;
 115 }
 116
 117 /* Called from I/O thread context */
 118 static void sink_request_rewind(pa_sink *s) {
 119     struct userdata *u;
 120
 121     pa_sink_assert_ref(s);
 122     pa_assert_se(u = s->userdata);
 123
 124     pa_sink_input_request_rewind(u->sink_input, s->thread_info.rewind_nbytes, TRUE, FALSE, FALSE);
 125 }
 126
 127 /* Called from I/O thread context */
 128 static void sink_update_requested_latency(pa_sink *s) {
 129     struct userdata *u;
 130
 131     pa_sink_assert_ref(s);
 132     pa_assert_se(u = s->userdata);
 133
 134     /* Just hand this one over to the master sink */
 135     pa_sink_input_set_requested_latency_within_thread(
 136             u->sink_input,
 137             pa_sink_get_requested_latency_within_thread(s));
 138 }
 139
 140 /* Called from I/O thread context */
 141 static int sink_input_pop_cb(pa_sink_input *i, size_t nbytes, pa_memchunk *chunk) {
 142     struct userdata *u;
 143
 144     pa_sink_input_assert_ref(i);
 145     pa_assert(chunk);
 146     pa_assert_se(u = i->userdata);
 147
 148     if (!u->sink || !PA_SINK_IS_OPENED(u->sink->thread_info.state))
 149         return -1;
 150
 151     pa_sink_render(u->sink, nbytes, chunk);
 152     return 0;
 153 }
 154
 155 /* Called from I/O thread context */
 156 static void sink_input_process_rewind_cb(pa_sink_input *i, size_t nbytes) {
 157     size_t amount = 0;
 158     struct userdata *u;
 159
 160     pa_sink_input_assert_ref(i);
 161     pa_assert_se(u = i->userdata);
 162
 163     if (!u->sink || !PA_SINK_IS_OPENED(u->sink->thread_info.state))
 164         return;
 165
 166     if (u->sink->thread_info.rewind_nbytes > 0) {
 167         amount = PA_MIN(u->sink->thread_info.rewind_nbytes, nbytes);
 168         u->sink->thread_info.rewind_nbytes = 0;
 169     }
 170
 171     pa_sink_process_rewind(u->sink, amount);
 172 }
 173
 174 /* Called from I/O thread context */
 175 static void sink_input_update_max_rewind_cb(pa_sink_input *i, size_t nbytes) {
 176     struct userdata *u;
 177
 178     pa_sink_input_assert_ref(i);
 179     pa_assert_se(u = i->userdata);
 180
 181     if (!u->sink || !PA_SINK_IS_LINKED(u->sink->thread_info.state))
 182         return;
 183
 184     pa_sink_set_max_rewind_within_thread(u->sink, nbytes);
 185 }
 186
 187 /* Called from I/O thread context */
 188 static void sink_input_update_max_request_cb(pa_sink_input *i, size_t nbytes) {
 189     struct userdata *u;
 190
 191     pa_sink_input_assert_ref(i);
 192     pa_assert_se(u = i->userdata);
 193
 194     if (!u->sink || !PA_SINK_IS_LINKED(u->sink->thread_info.state))
 195         return;
 196
 197     pa_sink_set_max_request_within_thread(u->sink, nbytes);
 198 }
 199
 200 /* Called from I/O thread context */
 201 static void sink_input_update_sink_latency_range_cb(pa_sink_input *i) {
 202     struct userdata *u;
 203
 204     pa_sink_input_assert_ref(i);
 205     pa_assert_se(u = i->userdata);
 206
 207     if (!u->sink || !PA_SINK_IS_LINKED(u->sink->thread_info.state))
 208         return;
 209
 210     pa_sink_set_latency_range_within_thread(u->sink, i->sink->thread_info.min_latency, i->sink->thread_info.max_latency);
 211 }
 212
 213 /* Called from I/O thread context */
 214 static void sink_input_detach_cb(pa_sink_input *i) {
 215     struct userdata *u;
 216
 217     pa_sink_input_assert_ref(i);
 218     pa_assert_se(u = i->userdata);
 219
 220     if (!u->sink || !PA_SINK_IS_LINKED(u->sink->thread_info.state))
 221         return;
 222
 223     pa_sink_detach_within_thread(u->sink);
 224     pa_sink_set_asyncmsgq(u->sink, NULL);
 225     pa_sink_set_rtpoll(u->sink, NULL);
 226 }
 227
 228 /* Called from I/O thread context */
 229 static void sink_input_attach_cb(pa_sink_input *i) {
 230     struct userdata *u;
 231
 232     pa_sink_input_assert_ref(i);
 233     pa_assert_se(u = i->userdata);
 234
 235     if (!u->sink || !PA_SINK_IS_LINKED(u->sink->thread_info.state))
 236         return;
 237
 238     pa_sink_set_asyncmsgq(u->sink, i->sink->asyncmsgq);
 239     pa_sink_set_rtpoll(u->sink, i->sink->rtpoll);
 240     pa_sink_attach_within_thread(u->sink);
 241
 242     pa_sink_set_latency_range_within_thread(u->sink, u->master->thread_info.min_latency, u->master->thread_info.max_latency);
 243 }
 244
 245 /* Called from main context */
 246 static void sink_input_kill_cb(pa_sink_input *i) {
 247     struct userdata *u;
 248
 249     pa_sink_input_assert_ref(i);
 250     pa_assert_se(u = i->userdata);
 251
 252     pa_sink_unlink(u->sink);
 253     pa_sink_input_unlink(u->sink_input);
 254
 255     pa_sink_unref(u->sink);
 256     u->sink = NULL;
 257     pa_sink_input_unref(u->sink_input);
 258     u->sink_input = NULL;
 259
 260     pa_module_unload_request(u->module, TRUE);
 261 }
 262
 263 /* Called from IO thread context */
 264 static void sink_input_state_change_cb(pa_sink_input *i, pa_sink_input_state_t state) {
 265     struct userdata *u;
 266
 267     pa_sink_input_assert_ref(i);
 268     pa_assert_se(u = i->userdata);
 269
 270     /* If we are added for the first time, ask for a rewinding so that
 271      * we are heard right-away. */
 272     if (PA_SINK_INPUT_IS_LINKED(state) &&
 273         i->thread_info.state == PA_SINK_INPUT_INIT) {
 274         pa_log_debug("Requesting rewind due to state change.");
 275         pa_sink_input_request_rewind(i, 0, FALSE, TRUE, TRUE);
 276     }
 277 }
 278
 279 /* Called from main context */
 280 static pa_bool_t sink_input_may_move_to_cb(pa_sink_input *i, pa_sink *dest) {
 281     struct userdata *u;
 282
 283     pa_sink_input_assert_ref(i);
 284     pa_assert_se(u = i->userdata);
 285
 286     return u->sink != dest;
 287 }
 288
 289 int pa__init(pa_module*m) {
 290     struct userdata *u;
 291     pa_sample_spec ss;
 292     pa_channel_map sink_map, stream_map;
 293     pa_modargs *ma;
 294     const char *k;
 295     pa_sink *master;
 296     pa_sink_input_new_data sink_input_data;
 297     pa_sink_new_data sink_data;
 298     pa_bool_t remix = TRUE;
 299
 300     pa_assert(m);
 301
 302     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 303         pa_log("Failed to parse module arguments.");
 304         goto fail;
 305     }
 306
 307     if (!(master = pa_namereg_get(m->core, pa_modargs_get_value(ma, "master", NULL), PA_NAMEREG_SINK))) {
 308         pa_log("Master sink not found");
 309         goto fail;
 310     }
 311
 312     ss = master->sample_spec;
 313     sink_map = master->channel_map;
 314     if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &sink_map, PA_CHANNEL_MAP_DEFAULT) < 0) {
 315         pa_log("Invalid sample format specification or channel map");
 316         goto fail;
 317     }
 318
 319     stream_map = sink_map;
 320     if (pa_modargs_get_channel_map(ma, "master_channel_map", &stream_map) < 0) {
 321         pa_log("Invalid master channel map");
 322         goto fail;
 323     }
 324
 325     if (stream_map.channels != ss.channels) {
 326         pa_log("Number of channels doesn't match");
 327         goto fail;
 328     }
 329
 330     if (pa_channel_map_equal(&stream_map, &master->channel_map))
 331         pa_log_warn("No remapping configured, proceeding nonetheless!");
 332
 333     if (pa_modargs_get_value_boolean(ma, "remix", &remix) < 0) {
 334         pa_log("Invalid boolean remix parameter");
 335         goto fail;
 336     }
 337
 338     u = pa_xnew0(struct userdata, 1);
 339     u->core = m->core;
 340     u->module = m;
 341     m->userdata = u;
 342     u->master = master;
 343     u->sink = NULL;
 344     u->sink_input = NULL;
 345
 346     /* Create sink */
 347     pa_sink_new_data_init(&sink_data);
 348     sink_data.driver = __FILE__;
 349     sink_data.module = m;
 350     if (!(sink_data.name = pa_xstrdup(pa_modargs_get_value(ma, "sink_name", NULL))))
 351         sink_data.name = pa_sprintf_malloc("%s.remapped", master->name);
 352     pa_sink_new_data_set_sample_spec(&sink_data, &ss);
 353     pa_sink_new_data_set_channel_map(&sink_data, &sink_map);
 354     k = pa_proplist_gets(master->proplist, PA_PROP_DEVICE_DESCRIPTION);
 355     pa_proplist_setf(sink_data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Remapped %s", k ? k : master->name);
 356     pa_proplist_sets(sink_data.proplist, PA_PROP_DEVICE_MASTER_DEVICE, master->name);
 357     pa_proplist_sets(sink_data.proplist, PA_PROP_DEVICE_CLASS, "filter");
 358
 359     if (pa_modargs_get_proplist(ma, "sink_properties", sink_data.proplist, PA_UPDATE_REPLACE) < 0) {
 360         pa_log("Invalid properties");
 361         pa_sink_new_data_done(&sink_data);
 362         goto fail;
 363     }
 364
 365     u->sink = pa_sink_new(m->core, &sink_data, PA_SINK_LATENCY|PA_SINK_DYNAMIC_LATENCY);
 366     pa_sink_new_data_done(&sink_data);
 367
 368     if (!u->sink) {
 369         pa_log("Failed to create sink.");
 370         goto fail;
 371     }
 372
 373     u->sink->parent.process_msg = sink_process_msg;
 374     u->sink->set_state = sink_set_state;
 375     u->sink->update_requested_latency = sink_update_requested_latency;
 376     u->sink->request_rewind = sink_request_rewind;
 377     u->sink->userdata = u;
 378
 379     pa_sink_set_asyncmsgq(u->sink, master->asyncmsgq);
 380     pa_sink_set_rtpoll(u->sink, master->rtpoll);
 381
 382     /* Create sink input */
 383     pa_sink_input_new_data_init(&sink_input_data);
 384     sink_input_data.driver = __FILE__;
 385     sink_input_data.module = m;
 386     sink_input_data.sink = u->master;
 387     pa_proplist_sets(sink_input_data.proplist, PA_PROP_MEDIA_NAME, "Remapped Stream");
 388     pa_proplist_sets(sink_input_data.proplist, PA_PROP_MEDIA_ROLE, "filter");
 389     pa_sink_input_new_data_set_sample_spec(&sink_input_data, &ss);
 390     pa_sink_input_new_data_set_channel_map(&sink_input_data, &stream_map);
 391
 392     pa_sink_input_new(&u->sink_input, m->core, &sink_input_data, PA_SINK_INPUT_DONT_MOVE | (remix ? 0 : PA_SINK_INPUT_NO_REMIX));
 393     pa_sink_input_new_data_done(&sink_input_data);
 394
 395     if (!u->sink_input)
 396         goto fail;
 397
 398     u->sink_input->pop = sink_input_pop_cb;
 399     u->sink_input->process_rewind = sink_input_process_rewind_cb;
 400     u->sink_input->update_max_rewind = sink_input_update_max_rewind_cb;
 401     u->sink_input->update_max_request = sink_input_update_max_request_cb;
 402     u->sink_input->update_sink_latency_range = sink_input_update_sink_latency_range_cb;
 403     u->sink_input->attach = sink_input_attach_cb;
 404     u->sink_input->detach = sink_input_detach_cb;
 405     u->sink_input->kill = sink_input_kill_cb;
 406     u->sink_input->state_change = sink_input_state_change_cb;
 407     u->sink_input->may_move_to = sink_input_may_move_to_cb;
 408     u->sink_input->userdata = u;
 409
 410     pa_sink_put(u->sink);
 411     pa_sink_input_put(u->sink_input);
 412
 413     pa_modargs_free(ma);
 414
 415     return 0;
 416
 417 fail:
 418     if (ma)
 419         pa_modargs_free(ma);
 420
 421     pa__done(m);
 422
 423     return -1;
 424 }
 425
 426 int pa__get_n_used(pa_module *m) {
 427     struct userdata *u;
 428
 429     pa_assert(m);
 430     pa_assert_se(u = m->userdata);
 431
 432     return pa_sink_linked_by(u->sink);
 433 }
 434
 435 void pa__done(pa_module*m) {
 436     struct userdata *u;
 437
 438     pa_assert(m);
 439
 440     if (!(u = m->userdata))
 441         return;
 442
 443     if (u->sink) {
 444         pa_sink_unlink(u->sink);
 445         pa_sink_unref(u->sink);
 446     }
 447
 448     if (u->sink_input) {
 449         pa_sink_input_unlink(u->sink_input);
 450         pa_sink_input_unref(u->sink_input);
 451     }
 452
 453     pa_xfree(u);
 454 }