src/modules/module-remap-sink.c

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