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