2 This file is part of PulseAudio.
4 Copyright 2004-2008 Lennart Poettering
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.
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.
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
29 #include <pulse/timeval.h>
30 #include <pulse/xmalloc.h>
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>
50 #include "module-combine-symdef.h"
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);
57 "sink_name=<name for the sink> "
58 "sink_properties=<properties for the sink> "
59 "slaves=<slave sinks> "
60 "adjust_time=<seconds> "
61 "resample_method=<method> "
62 "format=<sample format> "
64 "channels=<number of channels> "
65 "channel_map=<channel map>");
67 #define DEFAULT_SINK_NAME "combined"
69 #define MEMBLOCKQ_MAXLENGTH (1024*1024*16)
71 #define DEFAULT_ADJUST_TIME 10
73 #define BLOCK_USEC (PA_USEC_PER_MSEC * 200)
75 static const char* const valid_modargs[] = {
89 struct userdata *userdata;
92 pa_sink_input *sink_input;
94 pa_asyncmsgq *inq, /* Message queue from the sink thread to this sink input */
95 *outq; /* Message queue from this sink input to the sink thread */
96 pa_rtpoll_item *inq_rtpoll_item_read, *inq_rtpoll_item_write;
97 pa_rtpoll_item *outq_rtpoll_item_read, *outq_rtpoll_item_write;
99 pa_memblockq *memblockq;
101 pa_usec_t total_latency;
103 pa_atomic_t max_request;
105 PA_LLIST_FIELDS(struct output);
114 pa_thread_mq thread_mq;
117 pa_time_event *time_event;
118 uint32_t adjust_time;
122 pa_hook_slot *sink_put_slot, *sink_unlink_slot, *sink_state_changed_slot;
124 pa_resample_method_t resample_method;
126 struct timeval adjust_timestamp;
128 pa_usec_t block_usec;
130 pa_idxset* outputs; /* managed in main context */
133 PA_LLIST_HEAD(struct output, active_outputs); /* managed in IO thread context */
134 pa_atomic_t running; /* we cache that value here, so that every thread can query it cheaply */
136 pa_bool_t in_null_mode;
137 pa_smoother *smoother;
143 SINK_MESSAGE_ADD_OUTPUT = PA_SINK_MESSAGE_MAX,
144 SINK_MESSAGE_REMOVE_OUTPUT,
146 SINK_MESSAGE_UPDATE_LATENCY,
147 SINK_MESSAGE_UPDATE_MAX_REQUEST
151 SINK_INPUT_MESSAGE_POST = PA_SINK_INPUT_MESSAGE_MAX,
154 static void output_free(struct output *o);
155 static int output_create_sink_input(struct output *o);
157 static void adjust_rates(struct userdata *u) {
159 pa_usec_t max_sink_latency = 0, min_total_latency = (pa_usec_t) -1, target_latency, avg_total_latency = 0;
165 pa_sink_assert_ref(u->sink);
167 if (pa_idxset_size(u->outputs) <= 0)
170 if (!PA_SINK_IS_OPENED(pa_sink_get_state(u->sink)))
173 for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx)) {
174 pa_usec_t sink_latency;
176 if (!o->sink_input || !PA_SINK_IS_OPENED(pa_sink_get_state(o->sink)))
179 o->total_latency = pa_sink_input_get_latency(o->sink_input, &sink_latency);
180 o->total_latency += sink_latency;
182 if (sink_latency > max_sink_latency)
183 max_sink_latency = sink_latency;
185 if (min_total_latency == (pa_usec_t) -1 || o->total_latency < min_total_latency)
186 min_total_latency = o->total_latency;
188 avg_total_latency += o->total_latency;
192 if (min_total_latency == (pa_usec_t) -1)
195 avg_total_latency /= n;
197 target_latency = max_sink_latency > min_total_latency ? max_sink_latency : min_total_latency;
199 pa_log_info("[%s] avg total latency is %0.2f msec.", u->sink->name, (double) avg_total_latency / PA_USEC_PER_MSEC);
200 pa_log_info("[%s] target latency is %0.2f msec.", u->sink->name, (double) target_latency / PA_USEC_PER_MSEC);
202 base_rate = u->sink->sample_spec.rate;
204 for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx)) {
205 uint32_t r = base_rate;
207 if (!o->sink_input || !PA_SINK_IS_OPENED(pa_sink_get_state(o->sink)))
210 if (o->total_latency < target_latency)
211 r -= (uint32_t) ((((double) (target_latency - o->total_latency))/(double)u->adjust_time)*(double)r/PA_USEC_PER_SEC);
212 else if (o->total_latency > target_latency)
213 r += (uint32_t) ((((double) (o->total_latency - target_latency))/(double)u->adjust_time)*(double)r/PA_USEC_PER_SEC);
215 if (r < (uint32_t) (base_rate*0.9) || r > (uint32_t) (base_rate*1.1)) {
216 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);
217 pa_sink_input_set_rate(o->sink_input, base_rate);
219 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);
220 pa_sink_input_set_rate(o->sink_input, r);
224 pa_asyncmsgq_send(u->sink->asyncmsgq, PA_MSGOBJECT(u->sink), SINK_MESSAGE_UPDATE_LATENCY, NULL, (int64_t) avg_total_latency, NULL);
227 static void time_callback(pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata) {
228 struct userdata *u = userdata;
233 pa_assert(u->time_event == e);
238 n.tv_sec += (time_t) u->adjust_time;
239 u->sink->core->mainloop->time_restart(e, &n);
242 static void process_render_null(struct userdata *u, pa_usec_t now) {
246 if (u->thread_info.in_null_mode)
247 u->thread_info.timestamp = now;
249 while (u->thread_info.timestamp < now + u->block_usec) {
252 pa_sink_render(u->sink, u->sink->thread_info.max_request, &chunk);
253 pa_memblock_unref(chunk.memblock);
255 u->thread_info.counter += chunk.length;
257 /* pa_log_debug("Ate %lu bytes.", (unsigned long) chunk.length); */
258 u->thread_info.timestamp += pa_bytes_to_usec(chunk.length, &u->sink->sample_spec);
262 if (ate >= u->sink->thread_info.max_request)
266 /* pa_log_debug("Ate in sum %lu bytes (of %lu)", (unsigned long) ate, (unsigned long) nbytes); */
268 pa_smoother_put(u->thread_info.smoother, now,
269 pa_bytes_to_usec(u->thread_info.counter, &u->sink->sample_spec) - (u->thread_info.timestamp - now));
272 static void thread_func(void *userdata) {
273 struct userdata *u = userdata;
277 pa_log_debug("Thread starting up");
279 if (u->core->realtime_scheduling)
280 pa_make_realtime(u->core->realtime_priority+1);
282 pa_thread_mq_install(&u->thread_mq);
284 u->thread_info.timestamp = pa_rtclock_usec();
285 u->thread_info.in_null_mode = FALSE;
290 if (PA_SINK_IS_OPENED(u->sink->thread_info.state))
291 if (u->sink->thread_info.rewind_requested)
292 pa_sink_process_rewind(u->sink, 0);
294 /* If no outputs are connected, render some data and drop it immediately. */
295 if (PA_SINK_IS_OPENED(u->sink->thread_info.state) && !u->thread_info.active_outputs) {
298 now = pa_rtclock_usec();
300 if (!u->thread_info.in_null_mode || u->thread_info.timestamp <= now)
301 process_render_null(u, now);
303 pa_rtpoll_set_timer_absolute(u->rtpoll, u->thread_info.timestamp);
304 u->thread_info.in_null_mode = TRUE;
306 pa_rtpoll_set_timer_disabled(u->rtpoll);
307 u->thread_info.in_null_mode = FALSE;
310 /* Hmm, nothing to do. Let's sleep */
311 if ((ret = pa_rtpoll_run(u->rtpoll, TRUE)) < 0) {
312 pa_log_info("pa_rtpoll_run() = %i", ret);
321 /* If this was no regular exit from the loop we have to continue
322 * processing messages until we received PA_MESSAGE_SHUTDOWN */
323 pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
324 pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
327 pa_log_debug("Thread shutting down");
330 /* Called from I/O thread context */
331 static void render_memblock(struct userdata *u, struct output *o, size_t length) {
335 /* We are run by the sink thread, on behalf of an output (o). The
336 * output is waiting for us, hence it is safe to access its
337 * mainblockq and asyncmsgq directly. */
339 /* If we are not running, we cannot produce any data */
340 if (!pa_atomic_load(&u->thread_info.running))
343 /* Maybe there's some data in the requesting output's queue
345 while (pa_asyncmsgq_process_one(o->inq) > 0)
348 /* Ok, now let's prepare some data if we really have to */
349 while (!pa_memblockq_is_readable(o->memblockq)) {
354 pa_sink_render(u->sink, length, &chunk);
356 u->thread_info.counter += chunk.length;
358 /* OK, let's send this data to the other threads */
359 for (j = u->thread_info.active_outputs; j; j = j->next)
361 /* Send to other outputs, which are not the requesting
365 pa_asyncmsgq_post(j->inq, PA_MSGOBJECT(j->sink_input), SINK_INPUT_MESSAGE_POST, NULL, 0, &chunk, NULL);
367 /* And place it directly into the requesting output's queue */
369 pa_memblockq_push_align(o->memblockq, &chunk);
371 pa_memblock_unref(chunk.memblock);
375 /* Called from I/O thread context */
376 static void request_memblock(struct output *o, size_t length) {
378 pa_sink_input_assert_ref(o->sink_input);
379 pa_sink_assert_ref(o->userdata->sink);
381 /* If another thread already prepared some data we received
382 * the data over the asyncmsgq, hence let's first process
384 while (pa_asyncmsgq_process_one(o->inq) > 0)
387 /* Check whether we're now readable */
388 if (pa_memblockq_is_readable(o->memblockq))
391 /* OK, we need to prepare new data, but only if the sink is actually running */
392 if (pa_atomic_load(&o->userdata->thread_info.running))
393 pa_asyncmsgq_send(o->outq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_NEED, o, (int64_t) length, NULL);
396 /* Called from I/O thread context */
397 static int sink_input_pop_cb(pa_sink_input *i, size_t nbytes, pa_memchunk *chunk) {
400 pa_sink_input_assert_ref(i);
401 pa_assert_se(o = i->userdata);
403 /* If necessary, get some new data */
404 request_memblock(o, nbytes);
406 if (pa_memblockq_peek(o->memblockq, chunk) < 0)
409 pa_memblockq_drop(o->memblockq, chunk->length);
413 /* Called from I/O thread context */
414 static void sink_input_process_rewind_cb(pa_sink_input *i, size_t nbytes) {
417 pa_sink_input_assert_ref(i);
418 pa_assert_se(o = i->userdata);
420 pa_memblockq_rewind(o->memblockq, nbytes);
423 /* Called from I/O thread context */
424 static void sink_input_update_max_rewind_cb(pa_sink_input *i, size_t nbytes) {
427 pa_sink_input_assert_ref(i);
428 pa_assert_se(o = i->userdata);
430 pa_memblockq_set_maxrewind(o->memblockq, nbytes);
433 /* Called from I/O thread context */
434 static void sink_input_update_max_request_cb(pa_sink_input *i, size_t nbytes) {
437 pa_sink_input_assert_ref(i);
438 pa_assert_se(o = i->userdata);
440 if (pa_atomic_load(&o->max_request) == (int) nbytes)
443 pa_atomic_store(&o->max_request, (int) nbytes);
445 pa_asyncmsgq_post(o->outq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_UPDATE_MAX_REQUEST, NULL, 0, NULL, NULL);
448 /* Called from I/O thread context */
449 static void sink_input_attach_cb(pa_sink_input *i) {
452 pa_sink_input_assert_ref(i);
453 pa_assert_se(o = i->userdata);
455 /* Set up the queue from the sink thread to us */
456 pa_assert(!o->inq_rtpoll_item_read && !o->outq_rtpoll_item_write);
458 o->inq_rtpoll_item_read = pa_rtpoll_item_new_asyncmsgq_read(
460 PA_RTPOLL_LATE, /* This one is not that important, since we check for data in _peek() anyway. */
463 o->outq_rtpoll_item_write = pa_rtpoll_item_new_asyncmsgq_write(
469 /* Called from I/O thread context */
470 static void sink_input_detach_cb(pa_sink_input *i) {
473 pa_sink_input_assert_ref(i);
474 pa_assert_se(o = i->userdata);
476 /* Shut down the queue from the sink thread to us */
477 pa_assert(o->inq_rtpoll_item_read && o->outq_rtpoll_item_write);
479 pa_rtpoll_item_free(o->inq_rtpoll_item_read);
480 o->inq_rtpoll_item_read = NULL;
482 pa_rtpoll_item_free(o->outq_rtpoll_item_write);
483 o->outq_rtpoll_item_write = NULL;
486 /* Called from main context */
487 static void sink_input_kill_cb(pa_sink_input *i) {
490 pa_sink_input_assert_ref(i);
491 pa_assert_se(o = i->userdata);
493 pa_module_unload_request(o->userdata->module, TRUE);
497 /* Called from IO thread context */
498 static void sink_input_state_change_cb(pa_sink_input *i, pa_sink_input_state_t state) {
501 pa_sink_input_assert_ref(i);
502 pa_assert_se(u = i->userdata);
504 /* If we are added for the first time, ask for a rewinding so that
505 * we are heard right-away. */
506 if (PA_SINK_INPUT_IS_LINKED(state) &&
507 i->thread_info.state == PA_SINK_INPUT_INIT)
508 pa_sink_input_request_rewind(i, 0, FALSE, TRUE, TRUE);
511 /* Called from thread context */
512 static int sink_input_process_msg(pa_msgobject *obj, int code, void *data, int64_t offset, pa_memchunk *chunk) {
513 struct output *o = PA_SINK_INPUT(obj)->userdata;
517 case PA_SINK_INPUT_MESSAGE_GET_LATENCY: {
520 *r = pa_bytes_to_usec(pa_memblockq_get_length(o->memblockq), &o->sink_input->sample_spec);
522 /* Fall through, the default handler will add in the extra
523 * latency added by the resampler */
527 case SINK_INPUT_MESSAGE_POST:
529 if (PA_SINK_IS_OPENED(o->sink_input->sink->thread_info.state))
530 pa_memblockq_push_align(o->memblockq, chunk);
532 pa_memblockq_flush_write(o->memblockq);
537 return pa_sink_input_process_msg(obj, code, data, offset, chunk);
540 /* Called from main context */
541 static void disable_output(struct output *o) {
547 pa_sink_input_unlink(o->sink_input);
548 pa_asyncmsgq_send(o->userdata->sink->asyncmsgq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_REMOVE_OUTPUT, o, 0, NULL);
549 pa_sink_input_unref(o->sink_input);
550 o->sink_input = NULL;
553 /* Called from main context */
554 static void enable_output(struct output *o) {
560 if (output_create_sink_input(o) >= 0) {
562 pa_memblockq_flush_write(o->memblockq);
564 pa_sink_input_put(o->sink_input);
566 if (o->userdata->sink && PA_SINK_IS_LINKED(pa_sink_get_state(o->userdata->sink)))
567 pa_asyncmsgq_send(o->userdata->sink->asyncmsgq, PA_MSGOBJECT(o->userdata->sink), SINK_MESSAGE_ADD_OUTPUT, o, 0, NULL);
571 /* Called from main context */
572 static void suspend(struct userdata *u) {
578 /* Let's suspend by unlinking all streams */
579 for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx))
582 pa_log_info("Device suspended...");
585 /* Called from main context */
586 static void unsuspend(struct userdata *u) {
593 for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx)) {
595 pa_sink_suspend(o->sink, FALSE, PA_SUSPEND_IDLE);
597 if (PA_SINK_IS_OPENED(pa_sink_get_state(o->sink)))
601 pa_log_info("Resumed successfully...");
604 /* Called from main context */
605 static int sink_set_state(pa_sink *sink, pa_sink_state_t state) {
608 pa_sink_assert_ref(sink);
609 pa_assert_se(u = sink->userdata);
611 /* Please note that in contrast to the ALSA modules we call
612 * suspend/unsuspend from main context here! */
615 case PA_SINK_SUSPENDED:
616 pa_assert(PA_SINK_IS_OPENED(pa_sink_get_state(u->sink)));
622 case PA_SINK_RUNNING:
624 if (pa_sink_get_state(u->sink) == PA_SINK_SUSPENDED)
629 case PA_SINK_UNLINKED:
631 case PA_SINK_INVALID_STATE:
638 /* Called from IO context */
639 static void update_max_request(struct userdata *u) {
640 size_t max_request = 0;
643 for (o = u->thread_info.active_outputs; o; o = o->next) {
644 size_t mr = (size_t) pa_atomic_load(&o->max_request);
646 if (mr > max_request)
650 if (max_request <= 0)
651 max_request = pa_usec_to_bytes(u->block_usec, &u->sink->sample_spec);
653 pa_sink_set_max_request_within_thread(u->sink, max_request);
656 /* Called from thread context of the io thread */
657 static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
658 struct userdata *u = PA_SINK(o)->userdata;
662 case PA_SINK_MESSAGE_SET_STATE:
663 pa_atomic_store(&u->thread_info.running, PA_PTR_TO_UINT(data) == PA_SINK_RUNNING);
665 if (PA_PTR_TO_UINT(data) == PA_SINK_SUSPENDED)
666 pa_smoother_pause(u->thread_info.smoother, pa_rtclock_usec());
668 pa_smoother_resume(u->thread_info.smoother, pa_rtclock_usec(), TRUE);
672 case PA_SINK_MESSAGE_GET_LATENCY: {
673 pa_usec_t x, y, c, *delay = data;
675 x = pa_rtclock_usec();
676 y = pa_smoother_get(u->thread_info.smoother, x);
678 c = pa_bytes_to_usec(u->thread_info.counter, &u->sink->sample_spec);
688 case SINK_MESSAGE_ADD_OUTPUT: {
689 struct output *op = data;
691 PA_LLIST_PREPEND(struct output, u->thread_info.active_outputs, op);
693 pa_assert(!op->outq_rtpoll_item_read && !op->inq_rtpoll_item_write);
695 op->outq_rtpoll_item_read = pa_rtpoll_item_new_asyncmsgq_read(
697 PA_RTPOLL_EARLY-1, /* This item is very important */
699 op->inq_rtpoll_item_write = pa_rtpoll_item_new_asyncmsgq_write(
704 update_max_request(u);
708 case SINK_MESSAGE_REMOVE_OUTPUT: {
709 struct output *op = data;
711 PA_LLIST_REMOVE(struct output, u->thread_info.active_outputs, op);
713 pa_assert(op->outq_rtpoll_item_read && op->inq_rtpoll_item_write);
715 pa_rtpoll_item_free(op->outq_rtpoll_item_read);
716 op->outq_rtpoll_item_read = NULL;
718 pa_rtpoll_item_free(op->inq_rtpoll_item_write);
719 op->inq_rtpoll_item_write = NULL;
721 update_max_request(u);
725 case SINK_MESSAGE_NEED:
726 render_memblock(u, (struct output*) data, (size_t) offset);
729 case SINK_MESSAGE_UPDATE_LATENCY: {
730 pa_usec_t x, y, latency = (pa_usec_t) offset;
732 x = pa_rtclock_usec();
733 y = pa_bytes_to_usec(u->thread_info.counter, &u->sink->sample_spec);
740 pa_smoother_put(u->thread_info.smoother, x, y);
744 case SINK_MESSAGE_UPDATE_MAX_REQUEST:
746 update_max_request(u);
750 return pa_sink_process_msg(o, code, data, offset, chunk);
753 static void update_description(struct userdata *u) {
754 pa_bool_t first = TRUE;
761 if (pa_idxset_isempty(u->outputs)) {
762 pa_sink_set_description(u->sink, "Simultaneous output");
766 t = pa_xstrdup("Simultaneous output to");
768 for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx)) {
772 e = pa_sprintf_malloc("%s %s", t, pa_strnull(pa_proplist_gets(o->sink->proplist, PA_PROP_DEVICE_DESCRIPTION)));
775 e = pa_sprintf_malloc("%s, %s", t, pa_strnull(pa_proplist_gets(o->sink->proplist, PA_PROP_DEVICE_DESCRIPTION)));
781 pa_sink_set_description(u->sink, t);
785 static int output_create_sink_input(struct output *o) {
786 pa_sink_input_new_data data;
793 pa_sink_input_new_data_init(&data);
795 data.driver = __FILE__;
796 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)));
797 pa_proplist_sets(data.proplist, PA_PROP_MEDIA_ROLE, "filter");
798 pa_sink_input_new_data_set_sample_spec(&data, &o->userdata->sink->sample_spec);
799 pa_sink_input_new_data_set_channel_map(&data, &o->userdata->sink->channel_map);
800 data.module = o->userdata->module;
801 data.resample_method = o->userdata->resample_method;
803 pa_sink_input_new(&o->sink_input, o->userdata->core, &data, PA_SINK_INPUT_VARIABLE_RATE|PA_SINK_INPUT_DONT_MOVE);
805 pa_sink_input_new_data_done(&data);
810 o->sink_input->parent.process_msg = sink_input_process_msg;
811 o->sink_input->pop = sink_input_pop_cb;
812 o->sink_input->process_rewind = sink_input_process_rewind_cb;
813 o->sink_input->state_change = sink_input_state_change_cb;
814 o->sink_input->update_max_rewind = sink_input_update_max_rewind_cb;
815 o->sink_input->update_max_request = sink_input_update_max_request_cb;
816 o->sink_input->attach = sink_input_attach_cb;
817 o->sink_input->detach = sink_input_detach_cb;
818 o->sink_input->kill = sink_input_kill_cb;
819 o->sink_input->userdata = o;
821 pa_sink_input_set_requested_latency(o->sink_input, BLOCK_USEC);
826 static struct output *output_new(struct userdata *u, pa_sink *sink) {
828 pa_sink_state_t state;
834 o = pa_xnew(struct output, 1);
836 o->inq = pa_asyncmsgq_new(0);
837 o->outq = pa_asyncmsgq_new(0);
838 o->inq_rtpoll_item_write = o->inq_rtpoll_item_read = NULL;
839 o->outq_rtpoll_item_write = o->outq_rtpoll_item_read = NULL;
841 o->sink_input = NULL;
842 o->memblockq = pa_memblockq_new(
846 pa_frame_size(&u->sink->sample_spec),
851 pa_atomic_store(&o->max_request, 0);
852 PA_LLIST_INIT(struct output, o);
854 pa_assert_se(pa_idxset_put(u->outputs, o, NULL) == 0);
856 state = pa_sink_get_state(u->sink);
858 if (state != PA_SINK_INIT)
859 pa_asyncmsgq_send(u->sink->asyncmsgq, PA_MSGOBJECT(u->sink), SINK_MESSAGE_ADD_OUTPUT, o, 0, NULL);
861 /* If the sink is not yet started, we need to do the activation ourselves */
862 PA_LLIST_PREPEND(struct output, u->thread_info.active_outputs, o);
864 o->outq_rtpoll_item_read = pa_rtpoll_item_new_asyncmsgq_read(
866 PA_RTPOLL_EARLY-1, /* This item is very important */
868 o->inq_rtpoll_item_write = pa_rtpoll_item_new_asyncmsgq_write(
874 if (PA_SINK_IS_OPENED(state) || state == PA_SINK_INIT) {
875 pa_sink_suspend(sink, FALSE, PA_SUSPEND_IDLE);
877 if (PA_SINK_IS_OPENED(pa_sink_get_state(sink)))
878 if (output_create_sink_input(o) < 0)
882 update_description(u);
889 pa_idxset_remove_by_data(u->outputs, o, NULL);
892 pa_sink_input_unlink(o->sink_input);
893 pa_sink_input_unref(o->sink_input);
897 pa_memblockq_free(o->memblockq);
900 pa_asyncmsgq_unref(o->inq);
903 pa_asyncmsgq_unref(o->outq);
911 static pa_bool_t is_suitable_sink(struct userdata *u, pa_sink *s) {
914 pa_sink_assert_ref(s);
916 if (!(s->flags & PA_SINK_HARDWARE))
922 if ((t = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_CLASS)))
923 if (strcmp(t, "sound"))
929 static pa_hook_result_t sink_put_hook_cb(pa_core *c, pa_sink *s, struct userdata* u) {
932 pa_core_assert_ref(c);
933 pa_sink_assert_ref(s);
935 pa_assert(u->automatic);
937 if (!is_suitable_sink(u, s))
940 pa_log_info("Configuring new sink: %s", s->name);
942 if (!(o = output_new(u, s))) {
943 pa_log("Failed to create sink input on sink '%s'.", s->name);
948 pa_sink_input_put(o->sink_input);
953 static struct output* find_output(struct userdata *u, pa_sink *s) {
963 for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx))
970 static pa_hook_result_t sink_unlink_hook_cb(pa_core *c, pa_sink *s, struct userdata* u) {
974 pa_sink_assert_ref(s);
977 if (!(o = find_output(u, s)))
980 pa_log_info("Unconfiguring sink: %s", s->name);
987 static pa_hook_result_t sink_state_changed_hook_cb(pa_core *c, pa_sink *s, struct userdata* u) {
989 pa_sink_state_t state;
991 if (!(o = find_output(u, s)))
994 state = pa_sink_get_state(s);
996 if (PA_SINK_IS_OPENED(state) && PA_SINK_IS_OPENED(pa_sink_get_state(u->sink)) && !o->sink_input)
999 if (state == PA_SINK_SUSPENDED && o->sink_input)
1005 int pa__init(pa_module*m) {
1007 pa_modargs *ma = NULL;
1008 const char *slaves, *rm;
1009 int resample_method = PA_RESAMPLER_TRIVIAL;
1014 pa_sink_new_data data;
1018 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
1019 pa_log("failed to parse module arguments");
1023 if ((rm = pa_modargs_get_value(ma, "resample_method", NULL))) {
1024 if ((resample_method = pa_parse_resample_method(rm)) < 0) {
1025 pa_log("invalid resample method '%s'", rm);
1030 m->userdata = u = pa_xnew(struct userdata, 1);
1034 u->time_event = NULL;
1035 u->adjust_time = DEFAULT_ADJUST_TIME;
1036 u->rtpoll = pa_rtpoll_new();
1037 pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll);
1039 u->resample_method = resample_method;
1040 u->outputs = pa_idxset_new(NULL, NULL);
1041 memset(&u->adjust_timestamp, 0, sizeof(u->adjust_timestamp));
1042 u->sink_put_slot = u->sink_unlink_slot = u->sink_state_changed_slot = NULL;
1043 PA_LLIST_HEAD_INIT(struct output, u->thread_info.active_outputs);
1044 pa_atomic_store(&u->thread_info.running, FALSE);
1045 u->thread_info.in_null_mode = FALSE;
1046 u->thread_info.counter = 0;
1047 u->thread_info.smoother = pa_smoother_new(
1056 if (pa_modargs_get_value_u32(ma, "adjust_time", &u->adjust_time) < 0) {
1057 pa_log("Failed to parse adjust_time value");
1061 slaves = pa_modargs_get_value(ma, "slaves", NULL);
1062 u->automatic = !slaves;
1064 ss = m->core->default_sample_spec;
1065 map = m->core->default_channel_map;
1066 if ((pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_DEFAULT) < 0)) {
1067 pa_log("Invalid sample specification.");
1071 pa_sink_new_data_init(&data);
1072 data.namereg_fail = FALSE;
1073 data.driver = __FILE__;
1075 pa_sink_new_data_set_name(&data, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME));
1076 pa_sink_new_data_set_sample_spec(&data, &ss);
1077 pa_sink_new_data_set_channel_map(&data, &map);
1078 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Simultaneous Output");
1079 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_CLASS, "filter");
1082 pa_proplist_sets(data.proplist, "combine.slaves", slaves);
1084 if (pa_modargs_get_proplist(ma, "sink_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
1085 pa_log("Invalid properties");
1086 pa_sink_new_data_done(&data);
1090 u->sink = pa_sink_new(m->core, &data, PA_SINK_LATENCY);
1091 pa_sink_new_data_done(&data);
1094 pa_log("Failed to create sink");
1098 u->sink->parent.process_msg = sink_process_msg;
1099 u->sink->set_state = sink_set_state;
1100 u->sink->userdata = u;
1102 pa_sink_set_rtpoll(u->sink, u->rtpoll);
1103 pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq);
1105 u->block_usec = BLOCK_USEC;
1106 pa_sink_set_max_request(u->sink, pa_usec_to_bytes(u->block_usec, &u->sink->sample_spec));
1108 if (!u->automatic) {
1109 const char*split_state;
1113 /* The slaves have been specified manually */
1116 while ((n = pa_split(slaves, ",", &split_state))) {
1117 pa_sink *slave_sink;
1119 if (!(slave_sink = pa_namereg_get(m->core, n, PA_NAMEREG_SINK)) || slave_sink == u->sink) {
1120 pa_log("Invalid slave sink '%s'", n);
1127 if (!output_new(u, slave_sink)) {
1128 pa_log("Failed to create slave sink input on sink '%s'.", slave_sink->name);
1133 if (pa_idxset_size(u->outputs) <= 1)
1134 pa_log_warn("No slave sinks specified.");
1136 u->sink_put_slot = NULL;
1141 /* We're in automatic mode, we add every sink that matches our needs */
1143 for (s = pa_idxset_first(m->core->sinks, &idx); s; s = pa_idxset_next(m->core->sinks, &idx)) {
1145 if (!is_suitable_sink(u, s))
1148 if (!output_new(u, s)) {
1149 pa_log("Failed to create sink input on sink '%s'.", s->name);
1154 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);
1157 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);
1158 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);
1160 if (!(u->thread = pa_thread_new(thread_func, u))) {
1161 pa_log("Failed to create thread.");
1165 /* Activate the sink and the sink inputs */
1166 pa_sink_put(u->sink);
1168 for (o = pa_idxset_first(u->outputs, &idx); o; o = pa_idxset_next(u->outputs, &idx))
1170 pa_sink_input_put(o->sink_input);
1172 if (u->adjust_time > 0) {
1174 pa_gettimeofday(&tv);
1175 tv.tv_sec += (time_t) u->adjust_time;
1176 u->time_event = m->core->mainloop->time_new(m->core->mainloop, &tv, time_callback, u);
1179 pa_modargs_free(ma);
1186 pa_modargs_free(ma);
1193 static void output_free(struct output *o) {
1198 pa_assert_se(pa_idxset_remove_by_data(o->userdata->outputs, o, NULL));
1200 update_description(o->userdata);
1202 if (o->inq_rtpoll_item_read)
1203 pa_rtpoll_item_free(o->inq_rtpoll_item_read);
1204 if (o->inq_rtpoll_item_write)
1205 pa_rtpoll_item_free(o->inq_rtpoll_item_write);
1207 if (o->outq_rtpoll_item_read)
1208 pa_rtpoll_item_free(o->outq_rtpoll_item_read);
1209 if (o->outq_rtpoll_item_write)
1210 pa_rtpoll_item_free(o->outq_rtpoll_item_write);
1213 pa_asyncmsgq_unref(o->inq);
1216 pa_asyncmsgq_unref(o->outq);
1219 pa_memblockq_free(o->memblockq);
1224 void pa__done(pa_module*m) {
1230 if (!(u = m->userdata))
1233 if (u->sink_put_slot)
1234 pa_hook_slot_free(u->sink_put_slot);
1236 if (u->sink_unlink_slot)
1237 pa_hook_slot_free(u->sink_unlink_slot);
1239 if (u->sink_state_changed_slot)
1240 pa_hook_slot_free(u->sink_state_changed_slot);
1243 while ((o = pa_idxset_first(u->outputs, NULL)))
1246 pa_idxset_free(u->outputs, NULL, NULL);
1250 pa_sink_unlink(u->sink);
1253 pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
1254 pa_thread_free(u->thread);
1257 pa_thread_mq_done(&u->thread_mq);
1260 pa_sink_unref(u->sink);
1263 pa_rtpoll_free(u->rtpoll);
1266 u->core->mainloop->time_free(u->time_event);
1268 if (u->thread_info.smoother)
1269 pa_smoother_free(u->thread_info.smoother);