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