src/modules/module-combine.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 <stdio.h>
  27 #include <errno.h>
  28
  29 #include <pulse/rtclock.h>
  30 #include <pulse/timeval.h>
  31 #include <pulse/xmalloc.h>
  32
  33 #include <pulsecore/macro.h>
  34 #include <pulsecore/module.h>
  35 #include <pulsecore/llist.h>
  36 #include <pulsecore/sink.h>
  37 #include <pulsecore/sink-input.h>
  38 #include <pulsecore/memblockq.h>
  39 #include <pulsecore/log.h>
  40 #include <pulsecore/core-rtclock.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/core-error.h>
  49 #include <pulsecore/time-smoother.h>
  50 #include <pulsecore/strlist.h>
  51
  52 #include "module-combine-symdef.h"
  53
  54 PA_MODULE_AUTHOR("Lennart Poettering");
  55 PA_MODULE_DESCRIPTION("Combine multiple sinks to one");
  56 PA_MODULE_VERSION(PACKAGE_VERSION);
  57 PA_MODULE_LOAD_ONCE(FALSE);
  58 PA_MODULE_USAGE(
  59         "sink_name=<name for the sink> "
  60         "sink_properties=<properties for the sink> "
  61         "slaves=<slave sinks> "
  62         "adjust_time=<how often to readjust rates in s> "
  63         "resample_method=<method> "
  64         "format=<sample format> "
  65         "rate=<sample rate> "
  66         "channels=<number of channels> "
  67         "channel_map=<channel map>");
  68
  69 #define DEFAULT_SINK_NAME "combined"
  70
  71 #define MEMBLOCKQ_MAXLENGTH (1024*1024*16)
  72
  73 #define DEFAULT_ADJUST_TIME_USEC (10*PA_USEC_PER_SEC)
  74
  75 #define BLOCK_USEC (PA_USEC_PER_MSEC * 200)
  76
  77 static const char* const valid_modargs[] = {
  78     "sink_name",
  79     "sink_properties",
  80     "slaves",
  81     "adjust_time",
  82     "resample_method",
  83     "format",
  84     "rate",
  85     "channels",
  86     "channel_map",
  87     NULL
  88 };
  89
  90 struct output {
  91     struct userdata *userdata;
  92
  93     pa_sink *sink;
  94     pa_sink_input *sink_input;
  95     pa_bool_t ignore_state_change;
  96
  97     pa_asyncmsgq *inq,    /* Message queue from the sink thread to this sink input */
  98                  *outq;   /* Message queue from this sink input to the sink thread */
  99     pa_rtpoll_item *inq_rtpoll_item_read, *inq_rtpoll_item_write;
 100     pa_rtpoll_item *outq_rtpoll_item_read, *outq_rtpoll_item_write;
 101
 102     pa_memblockq *memblockq;
 103
 104     /* For communication of the stream latencies to the main thread */
 105     pa_usec_t total_latency;
 106
 107     /* For coomunication of the stream parameters to the sink thread */
 108     pa_atomic_t max_request;
 109     pa_atomic_t requested_latency;
 110
 111     PA_LLIST_FIELDS(struct output);
 112 };
 113
 114 struct userdata {
 115     pa_core *core;
 116     pa_module *module;
 117     pa_sink *sink;
 118
 119     pa_thread *thread;
 120     pa_thread_mq thread_mq;
 121     pa_rtpoll *rtpoll;
 122
 123     pa_time_event *time_event;
 124     pa_usec_t adjust_time;
 125
 126     pa_bool_t automatic;
 127     pa_bool_t auto_desc;
 128
 129     pa_strlist *unlinked_slaves;
 130
 131     pa_hook_slot *sink_put_slot, *sink_unlink_slot, *sink_state_changed_slot;
 132
 133     pa_resample_method_t resample_method;
 134
 135     pa_usec_t block_usec;
 136
 137     pa_idxset* outputs; /* managed in main context */
 138
 139     struct {
 140         PA_LLIST_HEAD(struct output, active_outputs); /* managed in IO thread context */
 141         pa_atomic_t running;  /* we cache that value here, so that every thread can query it cheaply */
 142         pa_usec_t timestamp;
 143         pa_bool_t in_null_mode;
 144         pa_smoother *smoother;
 145         uint64_t counter;
 146     } thread_info;
 147 };
 148
 149 enum {
 150     SINK_MESSAGE_ADD_OUTPUT = PA_SINK_MESSAGE_MAX,
 151     SINK_MESSAGE_REMOVE_OUTPUT,
 152     SINK_MESSAGE_NEED,
 153     SINK_MESSAGE_UPDATE_LATENCY,
 154     SINK_MESSAGE_UPDATE_MAX_REQUEST,
 155     SINK_MESSAGE_UPDATE_REQUESTED_LATENCY
 156 };
 157
 158 enum {
 159     SINK_INPUT_MESSAGE_POST = PA_SINK_INPUT_MESSAGE_MAX,
 160 };
 161
 162 static void output_disable(struct output *o);
 163 static void output_enable(struct output *o);
 164 static void output_free(struct output *o);
 165 static int output_create_sink_input(struct output *o);
 166
 167 static void adjust_rates(struct userdata *u) {
 168     struct output *o;
 169     pa_usec_t max_sink_latency = 0, min_total_latency = (pa_usec_t) -1, target_latency, avg_total_latency = 0;
 170     uint32_t base_rate;
 171     uint32_t idx;
 172     unsigned n = 0;
 173
 174     pa_assert(u);
 175     pa_sink_assert_ref(u->sink);
 176
 177     if (pa_idxset_size(u->outputs) <= 0)
 178         return;
 179
 180     if (!PA_SINK_IS_OPENED(pa_sink_get_state(u->sink)))
 181         return;
 182
 183     PA_IDXSET_FOREACH(o, u->outputs, idx) {
 184         pa_usec_t sink_latency;
 185
 186         if (!o->sink_input || !PA_SINK_IS_OPENED(pa_sink_get_state(o->sink)))
 187             continue;
 188
 189         o->total_latency = pa_sink_input_get_latency(o->sink_input, &sink_latency);
 190         o->total_latency += sink_latency;
 191
 192         if (sink_latency > max_sink_latency)
 193             max_sink_latency = sink_latency;
 194
 195         if (min_total_latency == (pa_usec_t) -1 || o->total_latency < min_total_latency)
 196             min_total_latency = o->total_latency;
 197
 198         avg_total_latency += o->total_latency;
 199         n++;
 200
 201         pa_log_debug("[%s] total=%0.2fms sink=%0.2fms ", o->sink->name, (double) o->total_latency / PA_USEC_PER_MSEC, (double) sink_latency / PA_USEC_PER_MSEC);
 202
 203         if (o->total_latency > 10*PA_USEC_PER_SEC)
 204             pa_log_warn("[%s] Total latency of output is very high (%0.2fms), most likely the audio timing in one of your drivers is broken.", o->sink->name, (double) o->total_latency / PA_USEC_PER_MSEC);
 205     }
 206
 207     if (min_total_latency == (pa_usec_t) -1)
 208         return;
 209
 210     avg_total_latency /= n;
 211
 212     target_latency = max_sink_latency > min_total_latency ? max_sink_latency : min_total_latency;
 213
 214     pa_log_info("[%s] avg total latency is %0.2f msec.", u->sink->name, (double) avg_total_latency / PA_USEC_PER_MSEC);
 215     pa_log_info("[%s] target latency is %0.2f msec.", u->sink->name, (double) target_latency / PA_USEC_PER_MSEC);
 216
 217     base_rate = u->sink->sample_spec.rate;
 218
 219     PA_IDXSET_FOREACH(o, u->outputs, idx) {
 220         uint32_t new_rate = base_rate;
 221         uint32_t current_rate = o->sink_input->sample_spec.rate;
 222
 223         if (!o->sink_input || !PA_SINK_IS_OPENED(pa_sink_get_state(o->sink)))
 224             continue;
 225
 226         if (o->total_latency != target_latency)
 227             new_rate += (uint32_t) (((double) o->total_latency - (double) target_latency) / (double) u->adjust_time * (double) new_rate);
 228
 229         if (new_rate < (uint32_t) (base_rate*0.8) || new_rate > (uint32_t) (base_rate*1.25)) {
 230             pa_log_warn("[%s] sample rates too different, not adjusting (%u vs. %u).", o->sink_input->sink->name, base_rate, new_rate);
 231             new_rate = base_rate;
 232         } else {
 233             if (base_rate < new_rate + 20 && new_rate < base_rate + 20)
 234               new_rate = base_rate;
 235             /* Do the adjustment in small steps; 2‰ can be considered inaudible */
 236             if (new_rate < (uint32_t) (current_rate*0.998) || new_rate > (uint32_t) (current_rate*1.002)) {
 237                 pa_log_info("[%s] new rate of %u Hz not within 2‰ of %u Hz, forcing smaller adjustment", o->sink_input->sink->name, new_rate, current_rate);
 238                 new_rate = PA_CLAMP(new_rate, (uint32_t) (current_rate*0.998), (uint32_t) (current_rate*1.002));
 239             }
 240             pa_log_info("[%s] new rate is %u Hz; ratio is %0.3f; latency is %0.2f msec.", o->sink_input->sink->name, new_rate, (double) new_rate / base_rate, (double) o->total_latency / PA_USEC_PER_MSEC);
 241         }
 242         pa_sink_input_set_rate(o->sink_input, new_rate);
 243     }
 244
 245     pa_asyncmsgq_send(u->sink->asyncmsgq, PA_MSGOBJECT(u->sink), SINK_MESSAGE_UPDATE_LATENCY, NULL, (int64_t) avg_total_latency, NULL);
 246 }
 247
 248 static void time_callback(pa_mainloop_api *a, pa_time_event *e, const struct timeval *t, void *userdata) {
 249     struct userdata *u = userdata;
 250
 251     pa_assert(u);
 252     pa_assert(a);
 253     pa_assert(u->time_event == e);
 254
 255     adjust_rates(u);
 256
 257     pa_core_rttime_restart(u->core, e, pa_rtclock_now() + u->adjust_time);
 258 }
 259
 260 static void process_render_null(struct userdata *u, pa_usec_t now) {
 261     size_t ate = 0;
 262     pa_assert(u);
 263
 264     if (u->thread_info.in_null_mode)
 265         u->thread_info.timestamp = now;
 266
 267     while (u->thread_info.timestamp < now + u->block_usec) {
 268         pa_memchunk chunk;
 269
 270         pa_sink_render(u->sink, u->sink->thread_info.max_request, &chunk);
 271         pa_memblock_unref(chunk.memblock);
 272
 273         u->thread_info.counter += chunk.length;
 274
 275 /*         pa_log_debug("Ate %lu bytes.", (unsigned long) chunk.length); */
 276         u->thread_info.timestamp += pa_bytes_to_usec(chunk.length, &u->sink->sample_spec);
 277
 278         ate += chunk.length;
 279
 280         if (ate >= u->sink->thread_info.max_request)
 281             break;
 282     }
 283
 284 /*     pa_log_debug("Ate in sum %lu bytes (of %lu)", (unsigned long) ate, (unsigned long) nbytes); */
 285
 286     pa_smoother_put(u->thread_info.smoother, now,
 287                     pa_bytes_to_usec(u->thread_info.counter, &u->sink->sample_spec) - (u->thread_info.timestamp - now));
 288 }
 289
 290 static void thread_func(void *userdata) {
 291     struct userdata *u = userdata;
 292
 293     pa_assert(u);
 294
 295     pa_log_debug("Thread starting up");
 296
 297     if (u->core->realtime_scheduling)
 298         pa_make_realtime(u->core->realtime_priority+1);
 299
 300     pa_thread_mq_install(&u->thread_mq);
 301
 302     u->thread_info.timestamp = pa_rtclock_now();
 303     u->thread_info.in_null_mode = FALSE;
 304
 305     for (;;) {
 306         int ret;
 307
 308         if (PA_SINK_IS_OPENED(u->sink->thread_info.state))
 309             if (u->sink->thread_info.rewind_requested)
 310                 pa_sink_process_rewind(u->sink, 0);
 311
 312         /* If no outputs are connected, render some data and drop it immediately. */
 313         if (PA_SINK_IS_OPENED(u->sink->thread_info.state) && !u->thread_info.active_outputs) {
 314             pa_usec_t now;
 315
 316             now = pa_rtclock_now();
 317
 318             if (!u->thread_info.in_null_mode || u->thread_info.timestamp <= now)
 319                 process_render_null(u, now);
 320
 321             pa_rtpoll_set_timer_absolute(u->rtpoll, u->thread_info.timestamp);
 322             u->thread_info.in_null_mode = TRUE;
 323         } else {
 324             pa_rtpoll_set_timer_disabled(u->rtpoll);
 325             u->thread_info.in_null_mode = FALSE;
 326         }
 327
 328         /* Hmm, nothing to do. Let's sleep */
 329         if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0) {
 330             pa_log_info("pa_rtpoll_run() = %i", ret);
 331             goto fail;
 332         }
 333
 334         if (ret == 0)
 335             goto finish;
 336     }
 337
 338 fail:
 339     /* If this was no regular exit from the loop we have to continue
 340      * processing messages until we received PA_MESSAGE_SHUTDOWN */
 341     pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
 342     pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
 343
 344 finish:
 345     pa_log_debug("Thread shutting down");
 346 }
 347
 348 /* Called from I/O thread context */
 349 static void render_memblock(struct userdata *u, struct output *o, size_t length) {
 350     pa_assert(u);
 351     pa_assert(o);
 352
 353     /* We are run by the sink thread, on behalf of an output (o). The
 354      * output is waiting for us, hence it is safe to access its
 355      * mainblockq and asyncmsgq directly. */
 356
 357     /* If we are not running, we cannot produce any data */
 358     if (!pa_atomic_load(&u->thread_info.running))
 359         return;
 360
 361     /* Maybe there's some data in the requesting output's queue
 362      * now? */
 363     while (pa_asyncmsgq_process_one(o->inq) > 0)
 364         ;
 365
 366     /* Ok, now let's prepare some data if we really have to */
 367     while (!pa_memblockq_is_readable(o->memblockq)) {
 368         struct output *j;
 369         pa_memchunk chunk;
 370
 371         /* Render data! */
 372         pa_sink_render(u->sink, length, &chunk);
 373
 374         u->thread_info.counter += chunk.length;
 375
 376         /* OK, let's send this data to the other threads */
 377         PA_LLIST_FOREACH(j, u->thread_info.active_outputs) {
 378             if (j == o)
 379                 continue;
 380
 381             pa_asyncmsgq_post(j->inq, PA_MSGOBJECT(j->sink_input), SINK_INPUT_MESSAGE_POST, NULL, 0, &chunk, NULL);
 382         }
 383
 384         /* And place it directly into the requesting output's queue */
 385         pa_memblockq_push_align(o->memblockq, &chunk);
 386         pa_memblock_unref(chunk.memblock);
 387     }
 388 }
 389
 390 /* Called from I/O thread context */
 391 static void request_memblock(struct output *o, size_t length) {
 392     pa_assert(o);
 393     pa_sink_input_assert_ref(o->sink_input);
 394     pa_sink_assert_ref(o->userdata->sink);
 395
 396     /* If another thread already prepared some data we received
 397      * the data over the asyncmsgq, hence let's first process
 398      * it. */
 399     while (pa_asyncmsgq_process_one(o->inq) > 0)
 400         ;
 401
 402     /* Check whether we're now readable */
 403     if (pa_memblockq_is_readable(o->memblockq))
 404         return;
 405
 406     /* OK, we need to prepare new data, but only if the sink is actually running */
 407     if (pa_atomic_load(&o->userdata->thread_info.running))
 408         pa_asyncmsgq_send(o->outq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_NEED, o, (int64_t) length, NULL);
 409 }
 410
 411 /* Called from I/O thread context */
 412 static int sink_input_pop_cb(pa_sink_input *i, size_t nbytes, pa_memchunk *chunk) {
 413     struct output *o;
 414
 415     pa_sink_input_assert_ref(i);
 416     pa_assert_se(o = i->userdata);
 417
 418     /* If necessary, get some new data */
 419     request_memblock(o, nbytes);
 420
 421     /* pa_log("%s q size is %u + %u (%u/%u)", */
 422     /*        i->sink->name, */
 423     /*        pa_memblockq_get_nblocks(o->memblockq), */
 424     /*        pa_memblockq_get_nblocks(i->thread_info.render_memblockq), */
 425     /*        pa_memblockq_get_maxrewind(o->memblockq), */
 426     /*        pa_memblockq_get_maxrewind(i->thread_info.render_memblockq)); */
 427
 428     if (pa_memblockq_peek(o->memblockq, chunk) < 0)
 429         return -1;
 430
 431     pa_memblockq_drop(o->memblockq, chunk->length);
 432
 433     return 0;
 434 }
 435
 436 /* Called from I/O thread context */
 437 static void sink_input_process_rewind_cb(pa_sink_input *i, size_t nbytes) {
 438     struct output *o;
 439
 440     pa_sink_input_assert_ref(i);
 441     pa_assert_se(o = i->userdata);
 442
 443     pa_memblockq_rewind(o->memblockq, nbytes);
 444 }
 445
 446 /* Called from I/O thread context */
 447 static void sink_input_update_max_rewind_cb(pa_sink_input *i, size_t nbytes) {
 448     struct output *o;
 449
 450     pa_sink_input_assert_ref(i);
 451     pa_assert_se(o = i->userdata);
 452
 453     pa_memblockq_set_maxrewind(o->memblockq, nbytes);
 454 }
 455
 456 /* Called from I/O thread context */
 457 static void sink_input_update_max_request_cb(pa_sink_input *i, size_t nbytes) {
 458     struct output *o;
 459
 460     pa_sink_input_assert_ref(i);
 461     pa_assert_se(o = i->userdata);
 462
 463     if (pa_atomic_load(&o->max_request) == (int) nbytes)
 464         return;
 465
 466     pa_atomic_store(&o->max_request, (int) nbytes);
 467     pa_asyncmsgq_post(o->outq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_UPDATE_MAX_REQUEST, NULL, 0, NULL, NULL);
 468 }
 469
 470 /* Called from thread context */
 471 static void sink_input_update_sink_requested_latency_cb(pa_sink_input *i) {
 472     struct output *o;
 473     pa_usec_t c;
 474
 475     pa_assert(i);
 476
 477     pa_sink_input_assert_ref(i);
 478     pa_assert_se(o = i->userdata);
 479
 480     c = pa_sink_get_requested_latency_within_thread(i->sink);
 481
 482     if (c == (pa_usec_t) -1)
 483         c = i->sink->thread_info.max_latency;
 484
 485     if (pa_atomic_load(&o->requested_latency) == (int) c)
 486         return;
 487
 488     pa_atomic_store(&o->requested_latency, (int) c);
 489     pa_asyncmsgq_post(o->outq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_UPDATE_REQUESTED_LATENCY, NULL, 0, NULL, NULL);
 490 }
 491
 492 /* Called from I/O thread context */
 493 static void sink_input_attach_cb(pa_sink_input *i) {
 494     struct output *o;
 495     pa_usec_t c;
 496
 497     pa_sink_input_assert_ref(i);
 498     pa_assert_se(o = i->userdata);
 499
 500     /* Set up the queue from the sink thread to us */
 501     pa_assert(!o->inq_rtpoll_item_read && !o->outq_rtpoll_item_write);
 502
 503     o->inq_rtpoll_item_read = pa_rtpoll_item_new_asyncmsgq_read(
 504             i->sink->thread_info.rtpoll,
 505             PA_RTPOLL_LATE,  /* This one is not that important, since we check for data in _peek() anyway. */
 506             o->inq);
 507
 508     o->outq_rtpoll_item_write = pa_rtpoll_item_new_asyncmsgq_write(
 509             i->sink->thread_info.rtpoll,
 510             PA_RTPOLL_EARLY,
 511             o->outq);
 512
 513     pa_sink_input_request_rewind(i, 0, FALSE, TRUE, TRUE);
 514
 515     pa_atomic_store(&o->max_request, (int) pa_sink_input_get_max_request(i));
 516
 517     c = pa_sink_get_requested_latency_within_thread(i->sink);
 518     pa_atomic_store(&o->requested_latency, (int) (c == (pa_usec_t) -1 ? 0 : c));
 519
 520     pa_asyncmsgq_post(o->outq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_UPDATE_MAX_REQUEST, NULL, 0, NULL, NULL);
 521     pa_asyncmsgq_post(o->outq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_UPDATE_REQUESTED_LATENCY, NULL, 0, NULL, NULL);
 522 }
 523
 524 /* Called from I/O thread context */
 525 static void sink_input_detach_cb(pa_sink_input *i) {
 526     struct output *o;
 527
 528     pa_sink_input_assert_ref(i);
 529     pa_assert_se(o = i->userdata);
 530
 531     if (o->inq_rtpoll_item_read) {
 532         pa_rtpoll_item_free(o->inq_rtpoll_item_read);
 533         o->inq_rtpoll_item_read = NULL;
 534     }
 535
 536     if (o->outq_rtpoll_item_write) {
 537         pa_rtpoll_item_free(o->outq_rtpoll_item_write);
 538         o->outq_rtpoll_item_write = NULL;
 539     }
 540 }
 541
 542 /* Called from main context */
 543 static void sink_input_kill_cb(pa_sink_input *i) {
 544     struct output *o;
 545
 546     pa_sink_input_assert_ref(i);
 547     pa_assert_se(o = i->userdata);
 548
 549     pa_module_unload_request(o->userdata->module, TRUE);
 550     output_free(o);
 551 }
 552
 553 /* Called from thread context */
 554 static int sink_input_process_msg(pa_msgobject *obj, int code, void *data, int64_t offset, pa_memchunk *chunk) {
 555     struct output *o = PA_SINK_INPUT(obj)->userdata;
 556
 557     switch (code) {
 558
 559         case PA_SINK_INPUT_MESSAGE_GET_LATENCY: {
 560             pa_usec_t *r = data;
 561
 562             *r = pa_bytes_to_usec(pa_memblockq_get_length(o->memblockq), &o->sink_input->sample_spec);
 563
 564             /* Fall through, the default handler will add in the extra
 565              * latency added by the resampler */
 566             break;
 567         }
 568
 569         case SINK_INPUT_MESSAGE_POST:
 570
 571             if (PA_SINK_IS_OPENED(o->sink_input->sink->thread_info.state))
 572                 pa_memblockq_push_align(o->memblockq, chunk);
 573             else
 574                 pa_memblockq_flush_write(o->memblockq, TRUE);
 575
 576             return 0;
 577     }
 578
 579     return pa_sink_input_process_msg(obj, code, data, offset, chunk);
 580 }
 581
 582 /* Called from main context */
 583 static void suspend(struct userdata *u) {
 584     struct output *o;
 585     uint32_t idx;
 586
 587     pa_assert(u);
 588
 589     /* Let's suspend by unlinking all streams */
 590     PA_IDXSET_FOREACH(o, u->outputs, idx)
 591         output_disable(o);
 592
 593     pa_log_info("Device suspended...");
 594 }
 595
 596 /* Called from main context */
 597 static void unsuspend(struct userdata *u) {
 598     struct output *o;
 599     uint32_t idx;
 600
 601     pa_assert(u);
 602
 603     /* Let's resume */
 604     PA_IDXSET_FOREACH(o, u->outputs, idx)
 605         output_enable(o);
 606
 607     pa_log_info("Resumed successfully...");
 608 }
 609
 610 /* Called from main context */
 611 static int sink_set_state(pa_sink *sink, pa_sink_state_t state) {
 612     struct userdata *u;
 613
 614     pa_sink_assert_ref(sink);
 615     pa_assert_se(u = sink->userdata);
 616
 617     /* Please note that in contrast to the ALSA modules we call
 618      * suspend/unsuspend from main context here! */
 619
 620     switch (state) {
 621         case PA_SINK_SUSPENDED:
 622             pa_assert(PA_SINK_IS_OPENED(pa_sink_get_state(u->sink)));
 623
 624             suspend(u);
 625             break;
 626
 627         case PA_SINK_IDLE:
 628         case PA_SINK_RUNNING:
 629
 630             if (pa_sink_get_state(u->sink) == PA_SINK_SUSPENDED)
 631                 unsuspend(u);
 632
 633             break;
 634
 635         case PA_SINK_UNLINKED:
 636         case PA_SINK_INIT:
 637         case PA_SINK_INVALID_STATE:
 638             ;
 639     }
 640
 641     return 0;
 642 }
 643
 644 /* Called from IO context */
 645 static void update_max_request(struct userdata *u) {
 646     size_t max_request = 0;
 647     struct output *o;
 648
 649     pa_assert(u);
 650     pa_sink_assert_io_context(u->sink);
 651
 652     /* Collects the max_request values of all streams and sets the
 653      * largest one locally */
 654
 655     PA_LLIST_FOREACH(o, u->thread_info.active_outputs) {
 656         size_t mr = (size_t) pa_atomic_load(&o->max_request);
 657
 658         if (mr > max_request)
 659             max_request = mr;
 660     }
 661
 662     if (max_request <= 0)
 663         max_request = pa_usec_to_bytes(u->block_usec, &u->sink->sample_spec);
 664
 665     pa_sink_set_max_request_within_thread(u->sink, max_request);
 666 }
 667
 668 /* Called from IO context */
 669 static void update_fixed_latency(struct userdata *u) {
 670     pa_usec_t fixed_latency = 0;
 671     struct output *o;
 672
 673     pa_assert(u);
 674     pa_sink_assert_io_context(u->sink);
 675
 676     /* Collects the requested_latency values of all streams and sets
 677      * the largest one as fixed_latency locally */
 678
 679     PA_LLIST_FOREACH(o, u->thread_info.active_outputs) {
 680         pa_usec_t rl = (size_t) pa_atomic_load(&o->requested_latency);
 681
 682         if (rl > fixed_latency)
 683             fixed_latency = rl;
 684     }
 685
 686     if (fixed_latency <= 0)
 687         fixed_latency = u->block_usec;
 688
 689     pa_sink_set_fixed_latency_within_thread(u->sink, fixed_latency);
 690 }
 691
 692 /* Called from thread context of the io thread */
 693 static void output_add_within_thread(struct output *o) {
 694     pa_assert(o);
 695     pa_sink_assert_io_context(o->sink);
 696
 697     PA_LLIST_PREPEND(struct output, o->userdata->thread_info.active_outputs, o);
 698
 699     pa_assert(!o->outq_rtpoll_item_read && !o->inq_rtpoll_item_write);
 700
 701     o->outq_rtpoll_item_read = pa_rtpoll_item_new_asyncmsgq_read(
 702             o->userdata->rtpoll,
 703             PA_RTPOLL_EARLY-1,  /* This item is very important */
 704             o->outq);
 705     o->inq_rtpoll_item_write = pa_rtpoll_item_new_asyncmsgq_write(
 706             o->userdata->rtpoll,
 707             PA_RTPOLL_EARLY,
 708             o->inq);
 709 }
 710
 711 /* Called from thread context of the io thread */
 712 static void output_remove_within_thread(struct output *o) {
 713     pa_assert(o);
 714     pa_sink_assert_io_context(o->sink);
 715
 716     PA_LLIST_REMOVE(struct output, o->userdata->thread_info.active_outputs, o);
 717
 718     if (o->outq_rtpoll_item_read) {
 719         pa_rtpoll_item_free(o->outq_rtpoll_item_read);
 720         o->outq_rtpoll_item_read = NULL;
 721     }
 722
 723     if (o->inq_rtpoll_item_write) {
 724         pa_rtpoll_item_free(o->inq_rtpoll_item_write);
 725         o->inq_rtpoll_item_write = NULL;
 726     }
 727 }
 728
 729 /* Called from thread context of the io thread */
 730 static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
 731     struct userdata *u = PA_SINK(o)->userdata;
 732
 733     switch (code) {
 734
 735         case PA_SINK_MESSAGE_SET_STATE:
 736             pa_atomic_store(&u->thread_info.running, PA_PTR_TO_UINT(data) == PA_SINK_RUNNING);
 737
 738             if (PA_PTR_TO_UINT(data) == PA_SINK_SUSPENDED)
 739                 pa_smoother_pause(u->thread_info.smoother, pa_rtclock_now());
 740             else
 741                 pa_smoother_resume(u->thread_info.smoother, pa_rtclock_now(), TRUE);
 742
 743             break;
 744
 745         case PA_SINK_MESSAGE_GET_LATENCY: {
 746             pa_usec_t x, y, c, *delay = data;
 747
 748             x = pa_rtclock_now();
 749             y = pa_smoother_get(u->thread_info.smoother, x);
 750
 751             c = pa_bytes_to_usec(u->thread_info.counter, &u->sink->sample_spec);
 752
 753             if (y < c)
 754                 *delay = c - y;
 755             else
 756                 *delay = 0;
 757
 758             return 0;
 759         }
 760
 761         case SINK_MESSAGE_ADD_OUTPUT:
 762             output_add_within_thread(data);
 763             update_max_request(u);
 764             update_fixed_latency(u);
 765             return 0;
 766
 767         case SINK_MESSAGE_REMOVE_OUTPUT:
 768             output_remove_within_thread(data);
 769             update_max_request(u);
 770             update_fixed_latency(u);
 771             return 0;
 772
 773         case SINK_MESSAGE_NEED:
 774             render_memblock(u, (struct output*) data, (size_t) offset);
 775             return 0;
 776
 777         case SINK_MESSAGE_UPDATE_LATENCY: {
 778             pa_usec_t x, y, latency = (pa_usec_t) offset;
 779
 780             x = pa_rtclock_now();
 781             y = pa_bytes_to_usec(u->thread_info.counter, &u->sink->sample_spec);
 782
 783             if (y > latency)
 784                 y -= latency;
 785             else
 786                 y = 0;
 787
 788             pa_smoother_put(u->thread_info.smoother, x, y);
 789             return 0;
 790         }
 791
 792         case SINK_MESSAGE_UPDATE_MAX_REQUEST:
 793             update_max_request(u);
 794             break;
 795
 796         case SINK_MESSAGE_UPDATE_REQUESTED_LATENCY:
 797             update_fixed_latency(u);
 798             break;
 799 }
 800
 801     return pa_sink_process_msg(o, code, data, offset, chunk);
 802 }
 803
 804 static void update_description(struct userdata *u) {
 805     pa_bool_t first = TRUE;
 806     char *t;
 807     struct output *o;
 808     uint32_t idx;
 809
 810     pa_assert(u);
 811
 812     if (!u->auto_desc)
 813         return;
 814
 815     if (pa_idxset_isempty(u->outputs)) {
 816         pa_sink_set_description(u->sink, "Simultaneous output");
 817         return;
 818     }
 819
 820     t = pa_xstrdup("Simultaneous output to");
 821
 822     PA_IDXSET_FOREACH(o, u->outputs, idx) {
 823         char *e;
 824
 825         if (first) {
 826             e = pa_sprintf_malloc("%s %s", t, pa_strnull(pa_proplist_gets(o->sink->proplist, PA_PROP_DEVICE_DESCRIPTION)));
 827             first = FALSE;
 828         } else
 829             e = pa_sprintf_malloc("%s, %s", t, pa_strnull(pa_proplist_gets(o->sink->proplist, PA_PROP_DEVICE_DESCRIPTION)));
 830
 831         pa_xfree(t);
 832         t = e;
 833     }
 834
 835     pa_sink_set_description(u->sink, t);
 836     pa_xfree(t);
 837 }
 838
 839 static int output_create_sink_input(struct output *o) {
 840     pa_sink_input_new_data data;
 841
 842     pa_assert(o);
 843
 844     if (o->sink_input)
 845         return 0;
 846
 847     pa_sink_input_new_data_init(&data);
 848     data.sink = o->sink;
 849     data.driver = __FILE__;
 850     pa_proplist_setf(data.proplist, PA_PROP_MEDIA_NAME, "Simultaneous output on %s", pa_strnull(pa_proplist_gets(o->sink->proplist, PA_PROP_DEVICE_DESCRIPTION)));
 851     pa_proplist_sets(data.proplist, PA_PROP_MEDIA_ROLE, "filter");
 852     pa_sink_input_new_data_set_sample_spec(&data, &o->userdata->sink->sample_spec);
 853     pa_sink_input_new_data_set_channel_map(&data, &o->userdata->sink->channel_map);
 854     data.module = o->userdata->module;
 855     data.resample_method = o->userdata->resample_method;
 856     data.flags = PA_SINK_INPUT_VARIABLE_RATE|PA_SINK_INPUT_DONT_MOVE|PA_SINK_INPUT_NO_CREATE_ON_SUSPEND;
 857
 858     pa_sink_input_new(&o->sink_input, o->userdata->core, &data);
 859
 860     pa_sink_input_new_data_done(&data);
 861
 862     if (!o->sink_input)
 863         return -1;
 864
 865     o->sink_input->parent.process_msg = sink_input_process_msg;
 866     o->sink_input->pop = sink_input_pop_cb;
 867     o->sink_input->process_rewind = sink_input_process_rewind_cb;
 868     o->sink_input->update_max_rewind = sink_input_update_max_rewind_cb;
 869     o->sink_input->update_max_request = sink_input_update_max_request_cb;
 870     o->sink_input->update_sink_requested_latency = sink_input_update_sink_requested_latency_cb;
 871     o->sink_input->attach = sink_input_attach_cb;
 872     o->sink_input->detach = sink_input_detach_cb;
 873     o->sink_input->kill = sink_input_kill_cb;
 874     o->sink_input->userdata = o;
 875
 876     pa_sink_input_set_requested_latency(o->sink_input, BLOCK_USEC);
 877
 878     return 0;
 879 }
 880
 881 /* Called from main context */
 882 static struct output *output_new(struct userdata *u, pa_sink *sink) {
 883     struct output *o;
 884
 885     pa_assert(u);
 886     pa_assert(sink);
 887     pa_assert(u->sink);
 888
 889     o = pa_xnew0(struct output, 1);
 890     o->userdata = u;
 891     o->inq = pa_asyncmsgq_new(0);
 892     o->outq = pa_asyncmsgq_new(0);
 893     o->sink = sink;
 894     o->memblockq = pa_memblockq_new(
 895             0,
 896             MEMBLOCKQ_MAXLENGTH,
 897             MEMBLOCKQ_MAXLENGTH,
 898             pa_frame_size(&u->sink->sample_spec),
 899             1,
 900             0,
 901             0,
 902             &u->sink->silence);
 903
 904     pa_assert_se(pa_idxset_put(u->outputs, o, NULL) == 0);
 905     update_description(u);
 906
 907     return o;
 908 }
 909
 910 /* Called from main context */
 911 static void output_free(struct output *o) {
 912     pa_assert(o);
 913
 914     output_disable(o);
 915
 916     pa_assert_se(pa_idxset_remove_by_data(o->userdata->outputs, o, NULL));
 917     update_description(o->userdata);
 918
 919     if (o->inq_rtpoll_item_read)
 920         pa_rtpoll_item_free(o->inq_rtpoll_item_read);
 921     if (o->inq_rtpoll_item_write)
 922         pa_rtpoll_item_free(o->inq_rtpoll_item_write);
 923
 924     if (o->outq_rtpoll_item_read)
 925         pa_rtpoll_item_free(o->outq_rtpoll_item_read);
 926     if (o->outq_rtpoll_item_write)
 927         pa_rtpoll_item_free(o->outq_rtpoll_item_write);
 928
 929     if (o->inq)
 930         pa_asyncmsgq_unref(o->inq);
 931
 932     if (o->outq)
 933         pa_asyncmsgq_unref(o->outq);
 934
 935     if (o->memblockq)
 936         pa_memblockq_free(o->memblockq);
 937
 938     pa_xfree(o);
 939 }
 940
 941 /* Called from main context */
 942 static void output_enable(struct output *o) {
 943     pa_assert(o);
 944
 945     if (o->sink_input)
 946         return;
 947
 948     /* This might cause the sink to be resumed. The state change hook
 949      * of the sink might hence be called from here, which might then
 950      * cause us to be called in a loop. Make sure that state changes
 951      * for this output don't cause this loop by setting a flag here */
 952     o->ignore_state_change = TRUE;
 953
 954     if (output_create_sink_input(o) >= 0) {
 955
 956         if (pa_sink_get_state(o->sink) != PA_SINK_INIT) {
 957
 958             /* First we register the output. That means that the sink
 959              * will start to pass data to this output. */
 960             pa_asyncmsgq_send(o->userdata->sink->asyncmsgq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_ADD_OUTPUT, o, 0, NULL);
 961
 962             /* Then we enable the sink input. That means that the sink
 963              * is now asked for new data. */
 964             pa_sink_input_put(o->sink_input);
 965
 966         } else
 967             /* Hmm the sink is not yet started, do things right here */
 968             output_add_within_thread(o);
 969     }
 970
 971     o->ignore_state_change = FALSE;
 972 }
 973
 974 /* Called from main context */
 975 static void output_disable(struct output *o) {
 976     pa_assert(o);
 977
 978     if (!o->sink_input)
 979         return;
 980
 981     /* First we disable the sink input. That means that the sink is
 982      * not asked for new data anymore  */
 983     pa_sink_input_unlink(o->sink_input);
 984
 985     /* Then we unregister the output. That means that the sink doesn't
 986      * pass any further data to this output */
 987     pa_asyncmsgq_send(o->userdata->sink->asyncmsgq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_REMOVE_OUTPUT, o, 0, NULL);
 988
 989     /* Now dellocate the stream */
 990     pa_sink_input_unref(o->sink_input);
 991     o->sink_input = NULL;
 992
 993     /* Finally, drop all queued data */
 994     pa_memblockq_flush_write(o->memblockq, TRUE);
 995     pa_asyncmsgq_flush(o->inq, FALSE);
 996     pa_asyncmsgq_flush(o->outq, FALSE);
 997 }
 998
 999 /* Called from main context */
1000 static void output_verify(struct output *o) {
1001     pa_assert(o);
1002
1003     if (PA_SINK_IS_OPENED(pa_sink_get_state(o->userdata->sink)))
1004         output_enable(o);
1005     else
1006         output_disable(o);
1007 }
1008
1009 /* Called from main context */
1010 static pa_bool_t is_suitable_sink(struct userdata *u, pa_sink *s) {
1011     const char *t;
1012
1013     pa_sink_assert_ref(s);
1014
1015     if (s == u->sink)
1016         return FALSE;
1017
1018     if (!(s->flags & PA_SINK_HARDWARE))
1019         return FALSE;
1020
1021     if (!(s->flags & PA_SINK_LATENCY))
1022         return FALSE;
1023
1024     if ((t = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_CLASS)))
1025         if (!pa_streq(t, "sound"))
1026             return FALSE;
1027
1028     return TRUE;
1029 }
1030
1031 /* Called from main context */
1032 static pa_hook_result_t sink_put_hook_cb(pa_core *c, pa_sink *s, struct userdata* u) {
1033     struct output *o;
1034
1035     pa_core_assert_ref(c);
1036     pa_sink_assert_ref(s);
1037     pa_assert(u);
1038
1039     if (u->automatic) {
1040         if (!is_suitable_sink(u, s))
1041             return PA_HOOK_OK;
1042     } else {
1043         /* Check if the sink is a previously unlinked slave (non-automatic mode) */
1044         pa_strlist *l = u->unlinked_slaves;
1045
1046         while (l && !pa_streq(pa_strlist_data(l), s->name))
1047             l = pa_strlist_next(l);
1048
1049         if (!l)
1050             return PA_HOOK_OK;
1051
1052         u->unlinked_slaves = pa_strlist_remove(u->unlinked_slaves, s->name);
1053     }
1054
1055     pa_log_info("Configuring new sink: %s", s->name);
1056     if (!(o = output_new(u, s))) {
1057         pa_log("Failed to create sink input on sink '%s'.", s->name);
1058         return PA_HOOK_OK;
1059     }
1060
1061     output_verify(o);
1062
1063     return PA_HOOK_OK;
1064 }
1065
1066 /* Called from main context */
1067 static struct output* find_output(struct userdata *u, pa_sink *s) {
1068     struct output *o;
1069     uint32_t idx;
1070
1071     pa_assert(u);
1072     pa_assert(s);
1073
1074     if (u->sink == s)
1075         return NULL;
1076
1077     PA_IDXSET_FOREACH(o, u->outputs, idx)
1078         if (o->sink == s)
1079             return o;
1080
1081     return NULL;
1082 }
1083
1084 /* Called from main context */
1085 static pa_hook_result_t sink_unlink_hook_cb(pa_core *c, pa_sink *s, struct userdata* u) {
1086     struct output *o;
1087
1088     pa_assert(c);
1089     pa_sink_assert_ref(s);
1090     pa_assert(u);
1091
1092     if (!(o = find_output(u, s)))
1093         return PA_HOOK_OK;
1094
1095     pa_log_info("Unconfiguring sink: %s", s->name);
1096
1097     if (!u->automatic)
1098         u->unlinked_slaves = pa_strlist_prepend(u->unlinked_slaves, s->name);
1099
1100     output_free(o);
1101
1102     return PA_HOOK_OK;
1103 }
1104
1105 /* Called from main context */
1106 static pa_hook_result_t sink_state_changed_hook_cb(pa_core *c, pa_sink *s, struct userdata* u) {
1107     struct output *o;
1108
1109     if (!(o = find_output(u, s)))
1110         return PA_HOOK_OK;
1111
1112     /* This state change might be triggered because we are creating a
1113      * stream here, in that case we don't want to create it a second
1114      * time here and enter a loop */
1115     if (o->ignore_state_change)
1116         return PA_HOOK_OK;
1117
1118     output_verify(o);
1119
1120     return PA_HOOK_OK;
1121 }
1122
1123 int pa__init(pa_module*m) {
1124     struct userdata *u;
1125     pa_modargs *ma = NULL;
1126     const char *slaves, *rm;
1127     int resample_method = PA_RESAMPLER_TRIVIAL;
1128     pa_sample_spec ss;
1129     pa_channel_map map;
1130     struct output *o;
1131     uint32_t idx;
1132     pa_sink_new_data data;
1133     uint32_t adjust_time_sec;
1134
1135     pa_assert(m);
1136
1137     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
1138         pa_log("failed to parse module arguments");
1139         goto fail;
1140     }
1141
1142     if ((rm = pa_modargs_get_value(ma, "resample_method", NULL))) {
1143         if ((resample_method = pa_parse_resample_method(rm)) < 0) {
1144             pa_log("invalid resample method '%s'", rm);
1145             goto fail;
1146         }
1147     }
1148
1149     m->userdata = u = pa_xnew0(struct userdata, 1);
1150     u->core = m->core;
1151     u->module = m;
1152     u->rtpoll = pa_rtpoll_new();
1153     pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll);
1154     u->resample_method = resample_method;
1155     u->outputs = pa_idxset_new(NULL, NULL);
1156     u->thread_info.smoother = pa_smoother_new(
1157             PA_USEC_PER_SEC,
1158             PA_USEC_PER_SEC*2,
1159             TRUE,
1160             TRUE,
1161             10,
1162             0,
1163             FALSE);
1164
1165     adjust_time_sec = DEFAULT_ADJUST_TIME_USEC / PA_USEC_PER_SEC;
1166     if (pa_modargs_get_value_u32(ma, "adjust_time", &adjust_time_sec) < 0) {
1167         pa_log("Failed to parse adjust_time value");
1168         goto fail;
1169     }
1170
1171     if (adjust_time_sec != DEFAULT_ADJUST_TIME_USEC / PA_USEC_PER_SEC)
1172         u->adjust_time = adjust_time_sec * PA_USEC_PER_SEC;
1173     else
1174         u->adjust_time = DEFAULT_ADJUST_TIME_USEC;
1175
1176     slaves = pa_modargs_get_value(ma, "slaves", NULL);
1177     u->automatic = !slaves;
1178
1179     ss = m->core->default_sample_spec;
1180     map = m->core->default_channel_map;
1181
1182     /* Check the specified slave sinks for sample_spec and channel_map to use for the combined sink */
1183     if (!u->automatic) {
1184         const char*split_state = NULL;
1185         char *n = NULL;
1186         pa_sample_spec slaves_spec;
1187         pa_channel_map slaves_map;
1188         pa_bool_t is_first_slave = TRUE;
1189
1190         pa_sample_spec_init(&slaves_spec);
1191
1192         while ((n = pa_split(slaves, ",", &split_state))) {
1193             pa_sink *slave_sink;
1194
1195             if (!(slave_sink = pa_namereg_get(m->core, n, PA_NAMEREG_SINK))) {
1196                 pa_log("Invalid slave sink '%s'", n);
1197                 pa_xfree(n);
1198                 goto fail;
1199             }
1200
1201             pa_xfree(n);
1202
1203             if (is_first_slave) {
1204                 slaves_spec = slave_sink->sample_spec;
1205                 slaves_map = slave_sink->channel_map;
1206                 is_first_slave = FALSE;
1207             } else {
1208                 if (slaves_spec.format != slave_sink->sample_spec.format)
1209                     slaves_spec.format = PA_SAMPLE_INVALID;
1210
1211                 if (slaves_spec.rate < slave_sink->sample_spec.rate)
1212                     slaves_spec.rate = slave_sink->sample_spec.rate;
1213
1214                 if (!pa_channel_map_equal(&slaves_map, &slave_sink->channel_map))
1215                     slaves_spec.channels = 0;
1216             }
1217         }
1218
1219         if (!is_first_slave) {
1220             if (slaves_spec.format != PA_SAMPLE_INVALID)
1221                 ss.format = slaves_spec.format;
1222
1223             ss.rate = slaves_spec.rate;
1224
1225             if (slaves_spec.channels > 0) {
1226                 map = slaves_map;
1227                 ss.channels = slaves_map.channels;
1228             }
1229         }
1230     }
1231
1232     if ((pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_DEFAULT) < 0)) {
1233         pa_log("Invalid sample specification.");
1234         goto fail;
1235     }
1236
1237     pa_sink_new_data_init(&data);
1238     data.namereg_fail = FALSE;
1239     data.driver = __FILE__;
1240     data.module = m;
1241     pa_sink_new_data_set_name(&data, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME));
1242     pa_sink_new_data_set_sample_spec(&data, &ss);
1243     pa_sink_new_data_set_channel_map(&data, &map);
1244     pa_proplist_sets(data.proplist, PA_PROP_DEVICE_CLASS, "filter");
1245
1246     if (slaves)
1247         pa_proplist_sets(data.proplist, "combine.slaves", slaves);
1248
1249     if (pa_modargs_get_proplist(ma, "sink_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
1250         pa_log("Invalid properties");
1251         pa_sink_new_data_done(&data);
1252         goto fail;
1253     }
1254
1255     /* Check proplist for a description & fill in a default value if not */
1256     u->auto_desc = FALSE;
1257     if (NULL == pa_proplist_gets(data.proplist, PA_PROP_DEVICE_DESCRIPTION)) {
1258         u->auto_desc = TRUE;
1259         pa_proplist_sets(data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Simultaneous Output");
1260     }
1261
1262     u->sink = pa_sink_new(m->core, &data, PA_SINK_LATENCY);
1263     pa_sink_new_data_done(&data);
1264
1265     if (!u->sink) {
1266         pa_log("Failed to create sink");
1267         goto fail;
1268     }
1269
1270     u->sink->parent.process_msg = sink_process_msg;
1271     u->sink->set_state = sink_set_state;
1272     u->sink->userdata = u;
1273
1274     pa_sink_set_rtpoll(u->sink, u->rtpoll);
1275     pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq);
1276
1277     u->block_usec = BLOCK_USEC;
1278     pa_sink_set_max_request(u->sink, pa_usec_to_bytes(u->block_usec, &u->sink->sample_spec));
1279
1280     if (!u->automatic) {
1281         const char*split_state;
1282         char *n = NULL;
1283         pa_assert(slaves);
1284
1285         /* The slaves have been specified manually */
1286
1287         split_state = NULL;
1288         while ((n = pa_split(slaves, ",", &split_state))) {
1289             pa_sink *slave_sink;
1290
1291             if (!(slave_sink = pa_namereg_get(m->core, n, PA_NAMEREG_SINK)) || slave_sink == u->sink) {
1292                 pa_log("Invalid slave sink '%s'", n);
1293                 pa_xfree(n);
1294                 goto fail;
1295             }
1296
1297             pa_xfree(n);
1298
1299             if (!output_new(u, slave_sink)) {
1300                 pa_log("Failed to create slave sink input on sink '%s'.", slave_sink->name);
1301                 goto fail;
1302             }
1303         }
1304
1305         if (pa_idxset_size(u->outputs) <= 1)
1306             pa_log_warn("No slave sinks specified.");
1307
1308         u->sink_put_slot = NULL;
1309
1310     } else {
1311         pa_sink *s;
1312
1313         /* We're in automatic mode, we add every sink that matches our needs  */
1314
1315         PA_IDXSET_FOREACH(s, m->core->sinks, idx) {
1316
1317             if (!is_suitable_sink(u, s))
1318                 continue;
1319
1320             if (!output_new(u, s)) {
1321                 pa_log("Failed to create sink input on sink '%s'.", s->name);
1322                 goto fail;
1323             }
1324         }
1325     }
1326
1327     u->sink_put_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_PUT], PA_HOOK_LATE, (pa_hook_cb_t) sink_put_hook_cb, u);
1328     u->sink_unlink_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_UNLINK], PA_HOOK_EARLY, (pa_hook_cb_t) sink_unlink_hook_cb, u);
1329     u->sink_state_changed_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_STATE_CHANGED], PA_HOOK_NORMAL, (pa_hook_cb_t) sink_state_changed_hook_cb, u);
1330
1331     if (!(u->thread = pa_thread_new("combine", thread_func, u))) {
1332         pa_log("Failed to create thread.");
1333         goto fail;
1334     }
1335
1336     /* Activate the sink and the sink inputs */
1337     pa_sink_put(u->sink);
1338
1339     PA_IDXSET_FOREACH(o, u->outputs, idx)
1340         output_verify(o);
1341
1342     if (u->adjust_time > 0)
1343         u->time_event = pa_core_rttime_new(m->core, pa_rtclock_now() + u->adjust_time, time_callback, u);
1344
1345     pa_modargs_free(ma);
1346
1347     return 0;
1348
1349 fail:
1350
1351     if (ma)
1352         pa_modargs_free(ma);
1353
1354     pa__done(m);
1355
1356     return -1;
1357 }
1358
1359 void pa__done(pa_module*m) {
1360     struct userdata *u;
1361     struct output *o;
1362
1363     pa_assert(m);
1364
1365     if (!(u = m->userdata))
1366         return;
1367
1368     pa_strlist_free(u->unlinked_slaves);
1369
1370     if (u->sink_put_slot)
1371         pa_hook_slot_free(u->sink_put_slot);
1372
1373     if (u->sink_unlink_slot)
1374         pa_hook_slot_free(u->sink_unlink_slot);
1375
1376     if (u->sink_state_changed_slot)
1377         pa_hook_slot_free(u->sink_state_changed_slot);
1378
1379     if (u->outputs) {
1380         while ((o = pa_idxset_first(u->outputs, NULL)))
1381             output_free(o);
1382
1383         pa_idxset_free(u->outputs, NULL, NULL);
1384     }
1385
1386     if (u->sink)
1387         pa_sink_unlink(u->sink);
1388
1389     if (u->thread) {
1390         pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
1391         pa_thread_free(u->thread);
1392     }
1393
1394     pa_thread_mq_done(&u->thread_mq);
1395
1396     if (u->sink)
1397         pa_sink_unref(u->sink);
1398
1399     if (u->rtpoll)
1400         pa_rtpoll_free(u->rtpoll);
1401
1402     if (u->time_event)
1403         u->core->mainloop->time_free(u->time_event);
1404
1405     if (u->thread_info.smoother)
1406         pa_smoother_free(u->thread_info.smoother);
1407
1408     pa_xfree(u);
1409 }