src/modules/module-combine.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 <errno.h>
  30
  31 #include <pulse/timeval.h>
  32 #include <pulse/xmalloc.h>
  33
  34 #include <pulsecore/macro.h>
  35 #include <pulsecore/module.h>
  36 #include <pulsecore/llist.h>
  37 #include <pulsecore/sink.h>
  38 #include <pulsecore/sink-input.h>
  39 #include <pulsecore/memblockq.h>
  40 #include <pulsecore/log.h>
  41 #include <pulsecore/core-util.h>
  42 #include <pulsecore/modargs.h>
  43 #include <pulsecore/namereg.h>
  44 #include <pulsecore/mutex.h>
  45 #include <pulsecore/thread.h>
  46 #include <pulsecore/thread-mq.h>
  47 #include <pulsecore/rtpoll.h>
  48 #include <pulsecore/rtclock.h>
  49 #include <pulsecore/core-error.h>
  50
  51 #include "module-combine-symdef.h"
  52
  53 PA_MODULE_AUTHOR("Lennart Poettering");
  54 PA_MODULE_DESCRIPTION("Combine multiple sinks to one");
  55 PA_MODULE_VERSION(PACKAGE_VERSION);
  56 PA_MODULE_LOAD_ONCE(FALSE);
  57 PA_MODULE_USAGE(
  58         "sink_name=<name for the sink> "
  59         "master=<master sink> "
  60         "slaves=<slave sinks> "
  61         "adjust_time=<seconds> "
  62         "resample_method=<method> "
  63         "format=<sample format> "
  64         "channels=<number of channels> "
  65         "rate=<sample rate> "
  66         "channel_map=<channel map>");
  67
  68 #define DEFAULT_SINK_NAME "combined"
  69 #define MEMBLOCKQ_MAXLENGTH (1024*1024*16)
  70
  71 #define DEFAULT_ADJUST_TIME 10
  72
  73 static const char* const valid_modargs[] = {
  74     "sink_name",
  75     "master",
  76     "slaves",
  77     "adjust_time",
  78     "resample_method",
  79     "format",
  80     "channels",
  81     "rate",
  82     "channel_map",
  83     NULL
  84 };
  85
  86 struct output {
  87     struct userdata *userdata;
  88
  89     pa_sink *sink;
  90     pa_sink_input *sink_input;
  91
  92     pa_asyncmsgq *inq,    /* Message queue from the sink thread to this sink input */
  93                  *outq;   /* Message queue from this sink input to the sink thread */
  94     pa_rtpoll_item *inq_rtpoll_item, *outq_rtpoll_item;
  95
  96     pa_memblockq *memblockq;
  97
  98     pa_usec_t total_latency;
  99
 100     PA_LLIST_FIELDS(struct output);
 101 };
 102
 103 struct userdata {
 104     pa_core *core;
 105     pa_module *module;
 106     pa_sink *sink;
 107
 108     pa_thread *thread;
 109     pa_thread_mq thread_mq;
 110     pa_rtpoll *rtpoll;
 111
 112     pa_time_event *time_event;
 113     uint32_t adjust_time;
 114
 115     pa_bool_t automatic;
 116     size_t block_size;
 117
 118     pa_hook_slot *sink_new_slot, *sink_unlink_slot, *sink_state_changed_slot;
 119
 120     pa_resample_method_t resample_method;
 121
 122     struct timeval adjust_timestamp;
 123
 124     struct output *master;
 125     pa_idxset* outputs; /* managed in main context */
 126
 127     struct {
 128         PA_LLIST_HEAD(struct output, active_outputs); /* managed in IO thread context */
 129         pa_atomic_t running;  /* we cache that value here, so that every thread can query it cheaply */
 130         struct timeval timestamp;
 131         pa_bool_t in_null_mode;
 132     } thread_info;
 133 };
 134
 135 enum {
 136     SINK_MESSAGE_ADD_OUTPUT = PA_SINK_MESSAGE_MAX,
 137     SINK_MESSAGE_REMOVE_OUTPUT,
 138     SINK_MESSAGE_NEED
 139 };
 140
 141 enum {
 142     SINK_INPUT_MESSAGE_POST = PA_SINK_INPUT_MESSAGE_MAX,
 143 };
 144
 145 static void output_free(struct output *o);
 146 static int output_create_sink_input(struct output *o);
 147 static void update_master(struct userdata *u, struct output *o);
 148 static void pick_master(struct userdata *u, struct output *except);
 149
 150 static void adjust_rates(struct userdata *u) {
 151     struct output *o;
 152     pa_usec_t max_sink_latency = 0, min_total_latency = (pa_usec_t) -1, target_latency;
 153     uint32_t base_rate;
 154     uint32_t idx;
 155
 156     pa_assert(u);
 157     pa_sink_assert_ref(u->sink);
 158
 159     if (pa_idxset_size(u->outputs) <= 0)
 160         return;
 161
 162     if (!u->master)
 163         return;
 164
 165     if (!PA_SINK_OPENED(pa_sink_get_state(u->sink)))
 166         return;
 167
 168     for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx)) {
 169         pa_usec_t sink_latency;
 170
 171         if (!o->sink_input || !PA_SINK_OPENED(pa_sink_get_state(o->sink)))
 172             continue;
 173
 174         sink_latency = pa_sink_get_latency(o->sink);
 175         o->total_latency = sink_latency + pa_sink_input_get_latency(o->sink_input);
 176
 177         if (sink_latency > max_sink_latency)
 178             max_sink_latency = sink_latency;
 179
 180         if (min_total_latency == (pa_usec_t) -1 || o->total_latency < min_total_latency)
 181             min_total_latency = o->total_latency;
 182     }
 183
 184     if (min_total_latency == (pa_usec_t) -1)
 185         return;
 186
 187     target_latency = max_sink_latency > min_total_latency ? max_sink_latency : min_total_latency;
 188
 189     pa_log_info("[%s] target latency is %0.0f usec.", u->sink->name, (float) target_latency);
 190     pa_log_info("[%s] master %s latency %0.0f usec.", u->sink->name, u->master->sink->name, (float) u->master->total_latency);
 191
 192     base_rate = u->sink->sample_spec.rate;
 193
 194     for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx)) {
 195         uint32_t r = base_rate;
 196
 197         if (!o->sink_input || !PA_SINK_OPENED(pa_sink_get_state(o->sink)))
 198             continue;
 199
 200         if (o->total_latency < target_latency)
 201             r -= (uint32_t) (((((double) target_latency - o->total_latency))/u->adjust_time)*r/PA_USEC_PER_SEC);
 202         else if (o->total_latency > target_latency)
 203             r += (uint32_t) (((((double) o->total_latency - target_latency))/u->adjust_time)*r/PA_USEC_PER_SEC);
 204
 205         if (r < (uint32_t) (base_rate*0.9) || r > (uint32_t) (base_rate*1.1)) {
 206             pa_log_warn("[%s] sample rates too different, not adjusting (%u vs. %u).", pa_proplist_gets(o->sink_input->proplist, PA_PROP_MEDIA_NAME), base_rate, r);
 207             pa_sink_input_set_rate(o->sink_input, base_rate);
 208         } else {
 209             pa_log_info("[%s] new rate is %u Hz; ratio is %0.3f; latency is %0.0f usec.", pa_proplist_gets(o->sink_input->proplist, PA_PROP_MEDIA_NAME), r, (double) r / base_rate, (float) o->total_latency);
 210             pa_sink_input_set_rate(o->sink_input, r);
 211         }
 212     }
 213 }
 214
 215 static void time_callback(pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata) {
 216     struct userdata *u = userdata;
 217     struct timeval n;
 218
 219     pa_assert(u);
 220     pa_assert(a);
 221     pa_assert(u->time_event == e);
 222
 223     adjust_rates(u);
 224
 225     pa_gettimeofday(&n);
 226     n.tv_sec += u->adjust_time;
 227     u->sink->core->mainloop->time_restart(e, &n);
 228 }
 229
 230 static void thread_func(void *userdata) {
 231     struct userdata *u = userdata;
 232
 233     pa_assert(u);
 234
 235     pa_log_debug("Thread starting up");
 236
 237     if (u->core->realtime_scheduling)
 238         pa_make_realtime(u->core->realtime_priority+1);
 239
 240     pa_thread_mq_install(&u->thread_mq);
 241     pa_rtpoll_install(u->rtpoll);
 242
 243     pa_rtclock_get(&u->thread_info.timestamp);
 244     u->thread_info.in_null_mode = FALSE;
 245
 246     for (;;) {
 247         int ret;
 248
 249         /* If no outputs are connected, render some data and drop it immediately. */
 250         if (u->sink->thread_info.state == PA_SINK_RUNNING && !u->thread_info.active_outputs) {
 251             struct timeval now;
 252
 253             /* Just rewind if necessary, since we are in NULL mode, we
 254              * don't have to pass this on */
 255             pa_sink_process_rewind(u->sink, u->sink->thread_info.rewind_nbytes);
 256             u->sink->thread_info.rewind_nbytes = 0;
 257
 258             pa_rtclock_get(&now);
 259
 260             if (!u->thread_info.in_null_mode || pa_timeval_cmp(&u->thread_info.timestamp, &now) <= 0) {
 261                 pa_sink_skip(u->sink, u->block_size);
 262
 263                 if (!u->thread_info.in_null_mode)
 264                     u->thread_info.timestamp = now;
 265
 266                 pa_timeval_add(&u->thread_info.timestamp, pa_bytes_to_usec(u->block_size, &u->sink->sample_spec));
 267             }
 268
 269             pa_rtpoll_set_timer_absolute(u->rtpoll, &u->thread_info.timestamp);
 270             u->thread_info.in_null_mode = TRUE;
 271
 272         } else {
 273             pa_rtpoll_set_timer_disabled(u->rtpoll);
 274             u->thread_info.in_null_mode = FALSE;
 275         }
 276
 277         /* Hmm, nothing to do. Let's sleep */
 278         if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0) {
 279             pa_log_info("pa_rtpoll_run() = %i", ret);
 280             goto fail;
 281         }
 282
 283         if (ret == 0)
 284             goto finish;
 285     }
 286
 287 fail:
 288     /* If this was no regular exit from the loop we have to continue
 289      * processing messages until we received PA_MESSAGE_SHUTDOWN */
 290     pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
 291     pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
 292
 293 finish:
 294     pa_log_debug("Thread shutting down");
 295 }
 296
 297 /* Called from I/O thread context */
 298 static void render_memblock(struct userdata *u, struct output *o, size_t length) {
 299     pa_assert(u);
 300     pa_assert(o);
 301
 302     /* We are run by the sink thread, on behalf of an output (o). The
 303      * other output is waiting for us, hence it is safe to access its
 304      * mainblockq and asyncmsgq directly. */
 305
 306     /* If we are not running, we cannot produce any data */
 307     if (!pa_atomic_load(&u->thread_info.running))
 308         return;
 309
 310     /* Maybe there's some data in the requesting output's queue
 311      * now? */
 312     while (pa_asyncmsgq_process_one(o->inq) > 0)
 313         ;
 314
 315     /* Ok, now let's prepare some data if we really have to */
 316     while (!pa_memblockq_is_readable(o->memblockq)) {
 317         struct output *j;
 318         pa_memchunk chunk;
 319
 320         /* Render data! */
 321         pa_sink_render(u->sink, length, &chunk);
 322
 323         /* OK, let's send this data to the other threads */
 324         for (j = u->thread_info.active_outputs; j; j = j->next)
 325
 326             /* Send to other outputs, which are not the requesting
 327              * one */
 328
 329             if (j != o)
 330                 pa_asyncmsgq_post(j->inq, PA_MSGOBJECT(j->sink_input), SINK_INPUT_MESSAGE_POST, NULL, 0, &chunk, NULL);
 331
 332         /* And place it directly into the requesting output's queue */
 333         if (o)
 334             pa_memblockq_push_align(o->memblockq, &chunk);
 335
 336         pa_memblock_unref(chunk.memblock);
 337     }
 338 }
 339
 340 /* Called from I/O thread context */
 341 static void request_memblock(struct output *o, size_t length) {
 342     pa_assert(o);
 343     pa_sink_input_assert_ref(o->sink_input);
 344     pa_sink_assert_ref(o->userdata->sink);
 345
 346     /* If another thread already prepared some data we received
 347      * the data over the asyncmsgq, hence let's first process
 348      * it. */
 349     while (pa_asyncmsgq_process_one(o->inq) > 0)
 350         ;
 351
 352     /* Check whether we're now readable */
 353     if (pa_memblockq_is_readable(o->memblockq))
 354         return;
 355
 356     /* OK, we need to prepare new data, but only if the sink is actually running */
 357     if (pa_atomic_load(&o->userdata->thread_info.running))
 358         pa_asyncmsgq_send(o->outq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_NEED, o, length, NULL);
 359 }
 360
 361 /* Called from I/O thread context */
 362 static int sink_input_pop_cb(pa_sink_input *i, size_t nbytes, pa_memchunk *chunk) {
 363     struct output *o;
 364
 365     pa_sink_input_assert_ref(i);
 366     pa_assert_se(o = i->userdata);
 367
 368     /* If necessary, get some new data */
 369     request_memblock(o, nbytes);
 370
 371     if (pa_memblockq_peek(o->memblockq, chunk) < 0)
 372         return -1;
 373
 374     pa_memblockq_drop(o->memblockq, chunk->length);
 375     return 0;
 376 }
 377
 378 /* Called from I/O thread context */
 379 static void sink_input_attach_cb(pa_sink_input *i) {
 380     struct output *o;
 381
 382     pa_sink_input_assert_ref(i);
 383     pa_assert_se(o = i->userdata);
 384
 385     /* Set up the queue from the sink thread to us */
 386     pa_assert(!o->inq_rtpoll_item);
 387     o->inq_rtpoll_item = pa_rtpoll_item_new_asyncmsgq_read(
 388             i->sink->rtpoll,
 389             PA_RTPOLL_LATE,  /* This one is not that important, since we check for data in _peek() anyway. */
 390             o->inq);
 391 }
 392
 393 /* Called from I/O thread context */
 394 static void sink_input_detach_cb(pa_sink_input *i) {
 395     struct output *o;
 396
 397     pa_sink_input_assert_ref(i);
 398     pa_assert_se(o = i->userdata);
 399
 400     /* Shut down the queue from the sink thread to us */
 401     pa_assert(o->inq_rtpoll_item);
 402     pa_rtpoll_item_free(o->inq_rtpoll_item);
 403     o->inq_rtpoll_item = NULL;
 404 }
 405
 406 /* Called from main context */
 407 static void sink_input_kill_cb(pa_sink_input *i) {
 408     struct output *o;
 409
 410     pa_sink_input_assert_ref(i);
 411     pa_assert(o = i->userdata);
 412
 413     pa_module_unload_request(o->userdata->module);
 414     output_free(o);
 415 }
 416
 417 /* Called from thread context */
 418 static int sink_input_process_msg(pa_msgobject *obj, int code, void *data, int64_t offset, pa_memchunk *chunk) {
 419     struct output *o = PA_SINK_INPUT(obj)->userdata;
 420
 421     switch (code) {
 422
 423         case PA_SINK_INPUT_MESSAGE_GET_LATENCY: {
 424              pa_usec_t *r = data;
 425
 426             *r = pa_bytes_to_usec(pa_memblockq_get_length(o->memblockq), &o->sink_input->sample_spec);
 427
 428             /* Fall through, the default handler will add in the extra
 429              * latency added by the resampler */
 430             break;
 431         }
 432
 433         case SINK_INPUT_MESSAGE_POST:
 434
 435             if (PA_SINK_OPENED(o->sink_input->sink->thread_info.state))
 436                 pa_memblockq_push_align(o->memblockq, chunk);
 437             else
 438                 pa_memblockq_flush(o->memblockq);
 439
 440             break;
 441
 442     }
 443
 444     return pa_sink_input_process_msg(obj, code, data, offset, chunk);
 445 }
 446
 447 /* Called from main context */
 448 static void disable_output(struct output *o) {
 449     pa_assert(o);
 450
 451     if (!o->sink_input)
 452         return;
 453
 454     pa_asyncmsgq_send(o->userdata->sink->asyncmsgq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_REMOVE_OUTPUT, o, 0, NULL);
 455     pa_sink_input_unlink(o->sink_input);
 456     pa_sink_input_unref(o->sink_input);
 457     o->sink_input = NULL;
 458
 459 }
 460
 461 /* Called from main context */
 462 static void enable_output(struct output *o) {
 463     pa_assert(o);
 464
 465     if (o->sink_input)
 466         return;
 467
 468     if (output_create_sink_input(o) >= 0) {
 469
 470         pa_memblockq_flush(o->memblockq);
 471
 472         pa_sink_input_put(o->sink_input);
 473
 474         if (o->userdata->sink && PA_SINK_LINKED(pa_sink_get_state(o->userdata->sink)))
 475             pa_asyncmsgq_send(o->userdata->sink->asyncmsgq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_ADD_OUTPUT, o, 0, NULL);
 476     }
 477 }
 478
 479 /* Called from main context */
 480 static void suspend(struct userdata *u) {
 481     struct output *o;
 482     uint32_t idx;
 483
 484     pa_assert(u);
 485
 486     /* Let's suspend by unlinking all streams */
 487     for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx))
 488         disable_output(o);
 489
 490     pick_master(u, NULL);
 491
 492     pa_log_info("Device suspended...");
 493 }
 494
 495 /* Called from main context */
 496 static void unsuspend(struct userdata *u) {
 497     struct output *o;
 498     uint32_t idx;
 499
 500     pa_assert(u);
 501
 502     /* Let's resume */
 503     for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx)) {
 504
 505         pa_sink_suspend(o->sink, FALSE);
 506
 507         if (PA_SINK_OPENED(pa_sink_get_state(o->sink)))
 508             enable_output(o);
 509     }
 510
 511     pick_master(u, NULL);
 512
 513     pa_log_info("Resumed successfully...");
 514 }
 515
 516 /* Called from main context */
 517 static int sink_set_state(pa_sink *sink, pa_sink_state_t state) {
 518     struct userdata *u;
 519
 520     pa_sink_assert_ref(sink);
 521     pa_assert_se(u = sink->userdata);
 522
 523     /* Please note that in contrast to the ALSA modules we call
 524      * suspend/unsuspend from main context here! */
 525
 526     switch (state) {
 527         case PA_SINK_SUSPENDED:
 528             pa_assert(PA_SINK_OPENED(pa_sink_get_state(u->sink)));
 529
 530             suspend(u);
 531             break;
 532
 533         case PA_SINK_IDLE:
 534         case PA_SINK_RUNNING:
 535
 536             if (pa_sink_get_state(u->sink) == PA_SINK_SUSPENDED)
 537                 unsuspend(u);
 538
 539             break;
 540
 541         case PA_SINK_UNLINKED:
 542         case PA_SINK_INIT:
 543             ;
 544     }
 545
 546     return 0;
 547 }
 548
 549 /* Called from thread context of the master */
 550 static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
 551     struct userdata *u = PA_SINK(o)->userdata;
 552
 553     switch (code) {
 554
 555         case PA_SINK_MESSAGE_SET_STATE:
 556             pa_atomic_store(&u->thread_info.running, PA_PTR_TO_UINT(data) == PA_SINK_RUNNING);
 557             break;
 558
 559         case PA_SINK_MESSAGE_GET_LATENCY:
 560
 561             /* This code will only be called when running in NULL
 562              * mode, i.e. when no output is attached. See
 563              * sink_get_latency_cb() below */
 564
 565             if (u->thread_info.in_null_mode) {
 566                 struct timeval now;
 567
 568                 if (pa_timeval_cmp(&u->thread_info.timestamp, pa_rtclock_get(&now)) > 0) {
 569                     *((pa_usec_t*) data) = pa_timeval_diff(&u->thread_info.timestamp, &now);
 570                     break;
 571                 }
 572             }
 573
 574             *((pa_usec_t*) data) = 0;
 575
 576             break;
 577
 578         case SINK_MESSAGE_ADD_OUTPUT: {
 579             struct output *op = data;
 580
 581             PA_LLIST_PREPEND(struct output, u->thread_info.active_outputs, op);
 582
 583             pa_assert(!op->outq_rtpoll_item);
 584
 585             /* Create pa_asyncmsgq to the sink thread */
 586
 587             op->outq_rtpoll_item = pa_rtpoll_item_new_asyncmsgq_read(
 588                     u->rtpoll,
 589                     PA_RTPOLL_EARLY-1,  /* This item is very important */
 590                     op->outq);
 591
 592             return 0;
 593         }
 594
 595         case SINK_MESSAGE_REMOVE_OUTPUT: {
 596             struct output *op = data;
 597
 598             PA_LLIST_REMOVE(struct output, u->thread_info.active_outputs, op);
 599
 600             /* Remove the q that leads from this output to the sink thread */
 601
 602             pa_assert(op->outq_rtpoll_item);
 603             pa_rtpoll_item_free(op->outq_rtpoll_item);
 604             op->outq_rtpoll_item = NULL;
 605
 606             return 0;
 607         }
 608
 609         case SINK_MESSAGE_NEED:
 610             render_memblock(u, data, (size_t) offset);
 611             return 0;
 612     }
 613
 614     return pa_sink_process_msg(o, code, data, offset, chunk);
 615 }
 616
 617 /* Called from main context */
 618 static pa_usec_t sink_get_latency_cb(pa_sink *s) {
 619     struct userdata *u;
 620
 621     pa_sink_assert_ref(s);
 622     pa_assert_se(u = s->userdata);
 623
 624     if (u->master) {
 625         /* If we have a master sink, we just return the latency of it
 626          * and add our own buffering on top */
 627
 628         if (!u->master->sink_input)
 629             return 0;
 630
 631         return
 632             pa_sink_input_get_latency(u->master->sink_input) +
 633             pa_sink_get_latency(u->master->sink);
 634
 635     } else {
 636         pa_usec_t usec = 0;
 637
 638         /* We have no master, hence let's ask our own thread which
 639          * implements the NULL sink */
 640
 641         if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
 642             return 0;
 643
 644         return usec;
 645     }
 646 }
 647
 648 static void update_description(struct userdata *u) {
 649     int first = 1;
 650     char *t;
 651     struct output *o;
 652     uint32_t idx;
 653
 654     pa_assert(u);
 655
 656     if (pa_idxset_isempty(u->outputs)) {
 657         pa_sink_set_description(u->sink, "Simultaneous output");
 658         return;
 659     }
 660
 661     t = pa_xstrdup("Simultaneous output to");
 662
 663     for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx)) {
 664         char *e;
 665
 666         if (first) {
 667             e = pa_sprintf_malloc("%s %s", t, pa_strnull(pa_proplist_gets(o->sink->proplist, PA_PROP_DEVICE_DESCRIPTION)));
 668             first = 0;
 669         } else
 670             e = pa_sprintf_malloc("%s, %s", t, pa_strnull(pa_proplist_gets(o->sink->proplist, PA_PROP_DEVICE_DESCRIPTION)));
 671
 672         pa_xfree(t);
 673         t = e;
 674     }
 675
 676     pa_sink_set_description(u->sink, t);
 677     pa_xfree(t);
 678 }
 679
 680 static void update_master(struct userdata *u, struct output *o) {
 681     pa_assert(u);
 682
 683     if (u->master == o)
 684         return;
 685
 686     if ((u->master = o))
 687         pa_log_info("Master sink is now '%s'", o->sink_input->sink->name);
 688     else
 689         pa_log_info("No master selected, lacking suitable outputs.");
 690 }
 691
 692 static void pick_master(struct userdata *u, struct output *except) {
 693     struct output *o;
 694     uint32_t idx;
 695     pa_assert(u);
 696
 697     if (u->master &&
 698         u->master != except &&
 699         u->master->sink_input &&
 700         PA_SINK_OPENED(pa_sink_get_state(u->master->sink))) {
 701         update_master(u, u->master);
 702         return;
 703     }
 704
 705     for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx))
 706         if (o != except &&
 707             o->sink_input &&
 708             PA_SINK_OPENED(pa_sink_get_state(o->sink))) {
 709             update_master(u, o);
 710             return;
 711         }
 712
 713     update_master(u, NULL);
 714 }
 715
 716 static int output_create_sink_input(struct output *o) {
 717     pa_sink_input_new_data data;
 718     char *t;
 719
 720     pa_assert(o);
 721
 722     if (o->sink_input)
 723         return 0;
 724
 725     t = pa_sprintf_malloc("Simultaneous output on %s", pa_strnull(pa_proplist_gets(o->sink->proplist, PA_PROP_DEVICE_DESCRIPTION)));
 726
 727     pa_sink_input_new_data_init(&data);
 728     data.sink = o->sink;
 729     data.driver = __FILE__;
 730     pa_proplist_sets(data.proplist, PA_PROP_DEVICE_DESCRIPTION, t);
 731     pa_sink_input_new_data_set_sample_spec(&data, &o->userdata->sink->sample_spec);
 732     pa_sink_input_new_data_set_channel_map(&data, &o->userdata->sink->channel_map);
 733     data.module = o->userdata->module;
 734     data.resample_method = o->userdata->resample_method;
 735
 736     o->sink_input = pa_sink_input_new(o->userdata->core, &data, PA_SINK_INPUT_VARIABLE_RATE|PA_SINK_INPUT_DONT_MOVE);
 737
 738     pa_sink_input_new_data_done(&data);
 739
 740     pa_xfree(t);
 741
 742     if (!o->sink_input)
 743         return -1;
 744
 745     o->sink_input->parent.process_msg = sink_input_process_msg;
 746     o->sink_input->pop = sink_input_pop_cb;
 747     o->sink_input->attach = sink_input_attach_cb;
 748     o->sink_input->detach = sink_input_detach_cb;
 749     o->sink_input->kill = sink_input_kill_cb;
 750     o->sink_input->userdata = o;
 751
 752
 753     return 0;
 754 }
 755
 756 static struct output *output_new(struct userdata *u, pa_sink *sink) {
 757     struct output *o;
 758
 759     pa_assert(u);
 760     pa_assert(sink);
 761     pa_assert(u->sink);
 762
 763     o = pa_xnew(struct output, 1);
 764     o->userdata = u;
 765     o->inq = pa_asyncmsgq_new(0);
 766     o->outq = pa_asyncmsgq_new(0);
 767     o->inq_rtpoll_item = NULL;
 768     o->outq_rtpoll_item = NULL;
 769     o->sink = sink;
 770     o->sink_input = NULL;
 771     o->memblockq = pa_memblockq_new(
 772             0,
 773             MEMBLOCKQ_MAXLENGTH,
 774             MEMBLOCKQ_MAXLENGTH,
 775             pa_frame_size(&u->sink->sample_spec),
 776             1,
 777             0,
 778             0,
 779             NULL);
 780
 781     pa_assert_se(pa_idxset_put(u->outputs, o, NULL) == 0);
 782
 783     if (u->sink && PA_SINK_LINKED(pa_sink_get_state(u->sink)))
 784         pa_asyncmsgq_send(u->sink->asyncmsgq, PA_MSGOBJECT(u->sink), SINK_MESSAGE_ADD_OUTPUT, o, 0, NULL);
 785     else {
 786         /* If the sink is not yet started, we need to do the activation ourselves */
 787         PA_LLIST_PREPEND(struct output, u->thread_info.active_outputs, o);
 788
 789         o->outq_rtpoll_item = pa_rtpoll_item_new_asyncmsgq_read(
 790                 u->rtpoll,
 791                 PA_RTPOLL_EARLY-1,  /* This item is very important */
 792                 o->outq);
 793     }
 794
 795     if (PA_SINK_OPENED(pa_sink_get_state(u->sink)) || pa_sink_get_state(u->sink) == PA_SINK_INIT) {
 796         pa_sink_suspend(sink, FALSE);
 797
 798         if (PA_SINK_OPENED(pa_sink_get_state(sink)))
 799             if (output_create_sink_input(o) < 0)
 800                 goto fail;
 801     }
 802
 803
 804     update_description(u);
 805
 806     return o;
 807
 808 fail:
 809
 810     if (o) {
 811         pa_idxset_remove_by_data(u->outputs, o, NULL);
 812
 813         if (o->sink_input) {
 814             pa_sink_input_unlink(o->sink_input);
 815             pa_sink_input_unref(o->sink_input);
 816         }
 817
 818         if (o->memblockq)
 819             pa_memblockq_free(o->memblockq);
 820
 821         if (o->inq)
 822             pa_asyncmsgq_unref(o->inq);
 823
 824         if (o->outq)
 825             pa_asyncmsgq_unref(o->outq);
 826
 827         pa_xfree(o);
 828     }
 829
 830     return NULL;
 831 }
 832
 833 static pa_hook_result_t sink_new_hook_cb(pa_core *c, pa_sink *s, struct userdata* u) {
 834     struct output *o;
 835
 836     pa_core_assert_ref(c);
 837     pa_sink_assert_ref(s);
 838     pa_assert(u);
 839     pa_assert(u->automatic);
 840
 841     if (!(s->flags & PA_SINK_HARDWARE) || s == u->sink)
 842         return PA_HOOK_OK;
 843
 844     pa_log_info("Configuring new sink: %s", s->name);
 845
 846     if (!(o = output_new(u, s))) {
 847         pa_log("Failed to create sink input on sink '%s'.", s->name);
 848         return PA_HOOK_OK;
 849     }
 850
 851     if (o->sink_input)
 852         pa_sink_input_put(o->sink_input);
 853
 854     pick_master(u, NULL);
 855
 856     return PA_HOOK_OK;
 857 }
 858
 859 static pa_hook_result_t sink_unlink_hook_cb(pa_core *c, pa_sink *s, struct userdata* u) {
 860     struct output *o;
 861     uint32_t idx;
 862
 863     pa_assert(c);
 864     pa_sink_assert_ref(s);
 865     pa_assert(u);
 866
 867     if (s == u->sink)
 868         return PA_HOOK_OK;
 869
 870     for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx))
 871         if (o->sink == s)
 872             break;
 873
 874     if (!o)
 875         return PA_HOOK_OK;
 876
 877     pa_log_info("Unconfiguring sink: %s", s->name);
 878
 879     output_free(o);
 880
 881     return PA_HOOK_OK;
 882 }
 883
 884 static pa_hook_result_t sink_state_changed_hook_cb(pa_core *c, pa_sink *s, struct userdata* u) {
 885     struct output *o;
 886     uint32_t idx;
 887     pa_sink_state_t state;
 888
 889     if (s == u->sink)
 890         return PA_HOOK_OK;
 891
 892     for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx))
 893         if (o->sink == s)
 894             break;
 895
 896     if (!o)
 897         return PA_HOOK_OK;
 898
 899     state = pa_sink_get_state(s);
 900
 901     if (PA_SINK_OPENED(state) && PA_SINK_OPENED(pa_sink_get_state(u->sink)) && !o->sink_input) {
 902         enable_output(o);
 903         pick_master(u, NULL);
 904     }
 905
 906     if (state == PA_SINK_SUSPENDED && o->sink_input) {
 907         disable_output(o);
 908         pick_master(u, o);
 909     }
 910
 911     return PA_HOOK_OK;
 912 }
 913
 914 int pa__init(pa_module*m) {
 915     struct userdata *u;
 916     pa_modargs *ma = NULL;
 917     const char *master_name, *slaves, *rm;
 918     pa_sink *master_sink = NULL;
 919     int resample_method = PA_RESAMPLER_TRIVIAL;
 920     pa_sample_spec ss;
 921     pa_channel_map map;
 922     struct output *o;
 923     uint32_t idx;
 924     pa_sink_new_data data;
 925
 926     pa_assert(m);
 927
 928     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 929         pa_log("failed to parse module arguments");
 930         goto fail;
 931     }
 932
 933     if ((rm = pa_modargs_get_value(ma, "resample_method", NULL))) {
 934         if ((resample_method = pa_parse_resample_method(rm)) < 0) {
 935             pa_log("invalid resample method '%s'", rm);
 936             goto fail;
 937         }
 938     }
 939
 940     u = pa_xnew(struct userdata, 1);
 941     u->core = m->core;
 942     u->module = m;
 943     m->userdata = u;
 944     u->sink = NULL;
 945     u->master = NULL;
 946     u->time_event = NULL;
 947     u->adjust_time = DEFAULT_ADJUST_TIME;
 948     u->rtpoll = pa_rtpoll_new();
 949     pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll);
 950     u->thread = NULL;
 951     u->resample_method = resample_method;
 952     u->outputs = pa_idxset_new(NULL, NULL);
 953     memset(&u->adjust_timestamp, 0, sizeof(u->adjust_timestamp));
 954     u->sink_new_slot = u->sink_unlink_slot = u->sink_state_changed_slot = NULL;
 955     PA_LLIST_HEAD_INIT(struct output, u->thread_info.active_outputs);
 956     pa_atomic_store(&u->thread_info.running, FALSE);
 957     u->thread_info.in_null_mode = FALSE;
 958
 959     if (pa_modargs_get_value_u32(ma, "adjust_time", &u->adjust_time) < 0) {
 960         pa_log("Failed to parse adjust_time value");
 961         goto fail;
 962     }
 963
 964     master_name = pa_modargs_get_value(ma, "master", NULL);
 965     slaves = pa_modargs_get_value(ma, "slaves", NULL);
 966     if (!master_name != !slaves) {
 967         pa_log("No master or slave sinks specified");
 968         goto fail;
 969     }
 970
 971     if (master_name) {
 972         if (!(master_sink = pa_namereg_get(m->core, master_name, PA_NAMEREG_SINK, 1))) {
 973             pa_log("Invalid master sink '%s'", master_name);
 974             goto fail;
 975         }
 976
 977         ss = master_sink->sample_spec;
 978         u->automatic = FALSE;
 979     } else {
 980         master_sink = NULL;
 981         ss = m->core->default_sample_spec;
 982         u->automatic = TRUE;
 983     }
 984
 985     if ((pa_modargs_get_sample_spec(ma, &ss) < 0)) {
 986         pa_log("Invalid sample specification.");
 987         goto fail;
 988     }
 989
 990     if (master_sink && ss.channels == master_sink->sample_spec.channels)
 991         map = master_sink->channel_map;
 992     else {
 993         pa_assert_se(pa_channel_map_init_auto(&map, ss.channels, PA_CHANNEL_MAP_AUX));
 994         pa_channel_map_init_auto(&map, ss.channels, PA_CHANNEL_MAP_DEFAULT);
 995     }
 996
 997     if ((pa_modargs_get_channel_map(ma, NULL, &map) < 0)) {
 998         pa_log("Invalid channel map.");
 999         goto fail;
1000     }
1001
1002     if (ss.channels != map.channels) {
1003         pa_log("Channel map and sample specification don't match.");
1004         goto fail;
1005     }
1006
1007     pa_sink_new_data_init(&data);
1008     data.name = pa_xstrdup(pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME));
1009     data.namereg_fail = FALSE;
1010     data.driver = __FILE__;
1011     data.module = m;
1012     pa_sink_new_data_set_sample_spec(&data, &ss);
1013     pa_sink_new_data_set_channel_map(&data, &map);
1014     pa_proplist_sets(data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Simultaneous Output");
1015
1016     u->sink = pa_sink_new(m->core, &data, PA_SINK_LATENCY);
1017     pa_sink_new_data_done(&data);
1018
1019     if (!u->sink) {
1020         pa_log("Failed to create sink");
1021         goto fail;
1022     }
1023
1024     u->sink->parent.process_msg = sink_process_msg;
1025     u->sink->get_latency = sink_get_latency_cb;
1026     u->sink->set_state = sink_set_state;
1027     u->sink->userdata = u;
1028
1029     pa_sink_set_rtpoll(u->sink, u->rtpoll);
1030     pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq);
1031
1032     u->block_size = pa_bytes_per_second(&ss) / 20; /* 50 ms */
1033     if (u->block_size <= 0)
1034         u->block_size = pa_frame_size(&ss);
1035
1036     if (!u->automatic) {
1037         const char*split_state;
1038         char *n = NULL;
1039         pa_assert(slaves);
1040
1041         /* The master and slaves have been specified manually */
1042
1043         if (!(u->master = output_new(u, master_sink))) {
1044             pa_log("Failed to create master sink input on sink '%s'.", master_sink->name);
1045             goto fail;
1046         }
1047
1048         split_state = NULL;
1049         while ((n = pa_split(slaves, ",", &split_state))) {
1050             pa_sink *slave_sink;
1051
1052             if (!(slave_sink = pa_namereg_get(m->core, n, PA_NAMEREG_SINK, 1)) || slave_sink == u->sink) {
1053                 pa_log("Invalid slave sink '%s'", n);
1054                 pa_xfree(n);
1055                 goto fail;
1056             }
1057
1058             pa_xfree(n);
1059
1060             if (!output_new(u, slave_sink)) {
1061                 pa_log("Failed to create slave sink input on sink '%s'.", slave_sink->name);
1062                 goto fail;
1063             }
1064         }
1065
1066         if (pa_idxset_size(u->outputs) <= 1)
1067             pa_log_warn("No slave sinks specified.");
1068
1069         u->sink_new_slot = NULL;
1070
1071     } else {
1072         pa_sink *s;
1073
1074         /* We're in automatic mode, we elect one hw sink to the master
1075          * and attach all other hw sinks as slaves to it */
1076
1077         for (s = pa_idxset_first(m->core->sinks, &idx); s; s = pa_idxset_next(m->core->sinks, &idx)) {
1078
1079             if (!(s->flags & PA_SINK_HARDWARE) || s == u->sink)
1080                 continue;
1081
1082             if (!output_new(u, s)) {
1083                 pa_log("Failed to create sink input on sink '%s'.", s->name);
1084                 goto fail;
1085             }
1086         }
1087
1088         u->sink_new_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_PUT], (pa_hook_cb_t) sink_new_hook_cb, u);
1089     }
1090
1091     u->sink_unlink_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_UNLINK], (pa_hook_cb_t) sink_unlink_hook_cb, u);
1092     u->sink_state_changed_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_STATE_CHANGED], (pa_hook_cb_t) sink_state_changed_hook_cb, u);
1093
1094     pick_master(u, NULL);
1095
1096     if (!(u->thread = pa_thread_new(thread_func, u))) {
1097         pa_log("Failed to create thread.");
1098         goto fail;
1099     }
1100
1101     /* Activate the sink and the sink inputs */
1102     pa_sink_put(u->sink);
1103
1104     for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx))
1105         if (o->sink_input)
1106             pa_sink_input_put(o->sink_input);
1107
1108     if (u->adjust_time > 0) {
1109         struct timeval tv;
1110         pa_gettimeofday(&tv);
1111         tv.tv_sec += u->adjust_time;
1112         u->time_event = m->core->mainloop->time_new(m->core->mainloop, &tv, time_callback, u);
1113     }
1114
1115     pa_modargs_free(ma);
1116
1117     return 0;
1118
1119 fail:
1120
1121     if (ma)
1122         pa_modargs_free(ma);
1123
1124     pa__done(m);
1125
1126     return -1;
1127 }
1128
1129 static void output_free(struct output *o) {
1130     pa_assert(o);
1131
1132     pick_master(o->userdata, o);
1133
1134     disable_output(o);
1135
1136     pa_assert_se(pa_idxset_remove_by_data(o->userdata->outputs, o, NULL));
1137
1138     update_description(o->userdata);
1139
1140     if (o->inq_rtpoll_item)
1141         pa_rtpoll_item_free(o->inq_rtpoll_item);
1142
1143     if (o->outq_rtpoll_item)
1144         pa_rtpoll_item_free(o->outq_rtpoll_item);
1145
1146     if (o->inq)
1147         pa_asyncmsgq_unref(o->inq);
1148
1149     if (o->outq)
1150         pa_asyncmsgq_unref(o->outq);
1151
1152     if (o->memblockq)
1153         pa_memblockq_free(o->memblockq);
1154
1155     pa_xfree(o);
1156 }
1157
1158 void pa__done(pa_module*m) {
1159     struct userdata *u;
1160     struct output *o;
1161
1162     pa_assert(m);
1163
1164     if (!(u = m->userdata))
1165         return;
1166
1167     if (u->sink_new_slot)
1168         pa_hook_slot_free(u->sink_new_slot);
1169
1170     if (u->sink_unlink_slot)
1171         pa_hook_slot_free(u->sink_unlink_slot);
1172
1173     if (u->sink_state_changed_slot)
1174         pa_hook_slot_free(u->sink_state_changed_slot);
1175
1176     if (u->outputs) {
1177         while ((o = pa_idxset_first(u->outputs, NULL)))
1178             output_free(o);
1179
1180         pa_idxset_free(u->outputs, NULL, NULL);
1181     }
1182
1183     if (u->sink)
1184         pa_sink_unlink(u->sink);
1185
1186     if (u->thread) {
1187         pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
1188         pa_thread_free(u->thread);
1189     }
1190
1191     pa_thread_mq_done(&u->thread_mq);
1192
1193     if (u->sink)
1194         pa_sink_unref(u->sink);
1195
1196     if (u->rtpoll)
1197         pa_rtpoll_free(u->rtpoll);
1198
1199     if (u->time_event)
1200         u->core->mainloop->time_free(u->time_event);
1201
1202     pa_xfree(u);
1203 }