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/rtclock.h>
30 #include <pulse/timeval.h>
31 #include <pulse/xmalloc.h>
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>
51 #include "module-combine-symdef.h"
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
);
58 "sink_name=<name for the sink> "
59 "sink_properties=<properties for the sink> "
60 "slaves=<slave sinks> "
61 "adjust_time=<how often to readjust rates in s> "
62 "resample_method=<method> "
63 "format=<sample format> "
65 "channels=<number of channels> "
66 "channel_map=<channel map>");
68 #define DEFAULT_SINK_NAME "combined"
70 #define MEMBLOCKQ_MAXLENGTH (1024*1024*16)
72 #define DEFAULT_ADJUST_TIME_USEC (10*PA_USEC_PER_SEC)
74 #define BLOCK_USEC (PA_USEC_PER_MSEC * 200)
76 static const char* const valid_modargs
[] = {
90 struct userdata
*userdata
;
93 pa_sink_input
*sink_input
;
94 pa_bool_t ignore_state_change
;
96 pa_asyncmsgq
*inq
, /* Message queue from the sink thread to this sink input */
97 *outq
; /* Message queue from this sink input to the sink thread */
98 pa_rtpoll_item
*inq_rtpoll_item_read
, *inq_rtpoll_item_write
;
99 pa_rtpoll_item
*outq_rtpoll_item_read
, *outq_rtpoll_item_write
;
101 pa_memblockq
*memblockq
;
103 /* For communication of the stream latencies to the main thread */
104 pa_usec_t total_latency
;
106 /* For coomunication of the stream parameters to the sink thread */
107 pa_atomic_t max_request
;
108 pa_atomic_t requested_latency
;
110 PA_LLIST_FIELDS(struct output
);
119 pa_thread_mq thread_mq
;
122 pa_time_event
*time_event
;
123 pa_usec_t adjust_time
;
128 pa_hook_slot
*sink_put_slot
, *sink_unlink_slot
, *sink_state_changed_slot
;
130 pa_resample_method_t resample_method
;
132 pa_usec_t block_usec
;
134 pa_idxset
* outputs
; /* managed in main context */
137 PA_LLIST_HEAD(struct output
, active_outputs
); /* managed in IO thread context */
138 pa_atomic_t running
; /* we cache that value here, so that every thread can query it cheaply */
140 pa_bool_t in_null_mode
;
141 pa_smoother
*smoother
;
147 SINK_MESSAGE_ADD_OUTPUT
= PA_SINK_MESSAGE_MAX
,
148 SINK_MESSAGE_REMOVE_OUTPUT
,
150 SINK_MESSAGE_UPDATE_LATENCY
,
151 SINK_MESSAGE_UPDATE_MAX_REQUEST
,
152 SINK_MESSAGE_UPDATE_REQUESTED_LATENCY
156 SINK_INPUT_MESSAGE_POST
= PA_SINK_INPUT_MESSAGE_MAX
,
159 static void output_disable(struct output
*o
);
160 static void output_enable(struct output
*o
);
161 static void output_free(struct output
*o
);
162 static int output_create_sink_input(struct output
*o
);
164 static void adjust_rates(struct userdata
*u
) {
166 pa_usec_t max_sink_latency
= 0, min_total_latency
= (pa_usec_t
) -1, target_latency
, avg_total_latency
= 0;
172 pa_sink_assert_ref(u
->sink
);
174 if (pa_idxset_size(u
->outputs
) <= 0)
177 if (!PA_SINK_IS_OPENED(pa_sink_get_state(u
->sink
)))
180 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
) {
181 pa_usec_t sink_latency
;
183 if (!o
->sink_input
|| !PA_SINK_IS_OPENED(pa_sink_get_state(o
->sink
)))
186 o
->total_latency
= pa_sink_input_get_latency(o
->sink_input
, &sink_latency
);
187 o
->total_latency
+= sink_latency
;
189 if (sink_latency
> max_sink_latency
)
190 max_sink_latency
= sink_latency
;
192 if (min_total_latency
== (pa_usec_t
) -1 || o
->total_latency
< min_total_latency
)
193 min_total_latency
= o
->total_latency
;
195 avg_total_latency
+= o
->total_latency
;
198 pa_log_debug("[%s] total=%0.2fms sink=%0.2fms ", o
->sink
->name
, (double) o
->total_latency
/ PA_USEC_PER_MSEC
, (double) sink_latency
/ PA_USEC_PER_MSEC
);
200 if (o
->total_latency
> 10*PA_USEC_PER_SEC
)
201 pa_log_warn("[%s] Total latency of output is very high (%0.2fms), most likely the audio timing in one of your drivers is broken.", o
->sink
->name
, (double) o
->total_latency
/ PA_USEC_PER_MSEC
);
204 if (min_total_latency
== (pa_usec_t
) -1)
207 avg_total_latency
/= n
;
209 target_latency
= max_sink_latency
> min_total_latency
? max_sink_latency
: min_total_latency
;
211 pa_log_info("[%s] avg total latency is %0.2f msec.", u
->sink
->name
, (double) avg_total_latency
/ PA_USEC_PER_MSEC
);
212 pa_log_info("[%s] target latency is %0.2f msec.", u
->sink
->name
, (double) target_latency
/ PA_USEC_PER_MSEC
);
214 base_rate
= u
->sink
->sample_spec
.rate
;
216 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
) {
217 uint32_t r
= base_rate
;
219 if (!o
->sink_input
|| !PA_SINK_IS_OPENED(pa_sink_get_state(o
->sink
)))
222 if (o
->total_latency
< target_latency
)
223 r
-= (uint32_t) ((((double) (target_latency
- o
->total_latency
))/(double)u
->adjust_time
)*(double)r
);
224 else if (o
->total_latency
> target_latency
)
225 r
+= (uint32_t) ((((double) (o
->total_latency
- target_latency
))/(double)u
->adjust_time
)*(double)r
);
227 if (r
< (uint32_t) (base_rate
*0.9) || r
> (uint32_t) (base_rate
*1.1)) {
228 pa_log_warn("[%s] sample rates too different, not adjusting (%u vs. %u).", o
->sink_input
->sink
->name
, base_rate
, r
);
229 pa_sink_input_set_rate(o
->sink_input
, base_rate
);
231 pa_log_info("[%s] new rate is %u Hz; ratio is %0.3f; latency is %0.0f usec.", o
->sink_input
->sink
->name
, r
, (double) r
/ base_rate
, (float) o
->total_latency
);
232 pa_sink_input_set_rate(o
->sink_input
, r
);
236 pa_asyncmsgq_send(u
->sink
->asyncmsgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_UPDATE_LATENCY
, NULL
, (int64_t) avg_total_latency
, NULL
);
239 static void time_callback(pa_mainloop_api
*a
, pa_time_event
*e
, const struct timeval
*t
, void *userdata
) {
240 struct userdata
*u
= userdata
;
244 pa_assert(u
->time_event
== e
);
248 pa_core_rttime_restart(u
->core
, e
, pa_rtclock_now() + u
->adjust_time
);
251 static void process_render_null(struct userdata
*u
, pa_usec_t now
) {
255 if (u
->thread_info
.in_null_mode
)
256 u
->thread_info
.timestamp
= now
;
258 while (u
->thread_info
.timestamp
< now
+ u
->block_usec
) {
261 pa_sink_render(u
->sink
, u
->sink
->thread_info
.max_request
, &chunk
);
262 pa_memblock_unref(chunk
.memblock
);
264 u
->thread_info
.counter
+= chunk
.length
;
266 /* pa_log_debug("Ate %lu bytes.", (unsigned long) chunk.length); */
267 u
->thread_info
.timestamp
+= pa_bytes_to_usec(chunk
.length
, &u
->sink
->sample_spec
);
271 if (ate
>= u
->sink
->thread_info
.max_request
)
275 /* pa_log_debug("Ate in sum %lu bytes (of %lu)", (unsigned long) ate, (unsigned long) nbytes); */
277 pa_smoother_put(u
->thread_info
.smoother
, now
,
278 pa_bytes_to_usec(u
->thread_info
.counter
, &u
->sink
->sample_spec
) - (u
->thread_info
.timestamp
- now
));
281 static void thread_func(void *userdata
) {
282 struct userdata
*u
= userdata
;
286 pa_log_debug("Thread starting up");
288 if (u
->core
->realtime_scheduling
)
289 pa_make_realtime(u
->core
->realtime_priority
+1);
291 pa_thread_mq_install(&u
->thread_mq
);
293 u
->thread_info
.timestamp
= pa_rtclock_now();
294 u
->thread_info
.in_null_mode
= FALSE
;
299 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
))
300 if (u
->sink
->thread_info
.rewind_requested
)
301 pa_sink_process_rewind(u
->sink
, 0);
303 /* If no outputs are connected, render some data and drop it immediately. */
304 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
) && !u
->thread_info
.active_outputs
) {
307 now
= pa_rtclock_now();
309 if (!u
->thread_info
.in_null_mode
|| u
->thread_info
.timestamp
<= now
)
310 process_render_null(u
, now
);
312 pa_rtpoll_set_timer_absolute(u
->rtpoll
, u
->thread_info
.timestamp
);
313 u
->thread_info
.in_null_mode
= TRUE
;
315 pa_rtpoll_set_timer_disabled(u
->rtpoll
);
316 u
->thread_info
.in_null_mode
= FALSE
;
319 /* Hmm, nothing to do. Let's sleep */
320 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0) {
321 pa_log_info("pa_rtpoll_run() = %i", ret
);
330 /* If this was no regular exit from the loop we have to continue
331 * processing messages until we received PA_MESSAGE_SHUTDOWN */
332 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
333 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
336 pa_log_debug("Thread shutting down");
339 /* Called from I/O thread context */
340 static void render_memblock(struct userdata
*u
, struct output
*o
, size_t length
) {
344 /* We are run by the sink thread, on behalf of an output (o). The
345 * output is waiting for us, hence it is safe to access its
346 * mainblockq and asyncmsgq directly. */
348 /* If we are not running, we cannot produce any data */
349 if (!pa_atomic_load(&u
->thread_info
.running
))
352 /* Maybe there's some data in the requesting output's queue
354 while (pa_asyncmsgq_process_one(o
->inq
) > 0)
357 /* Ok, now let's prepare some data if we really have to */
358 while (!pa_memblockq_is_readable(o
->memblockq
)) {
363 pa_sink_render(u
->sink
, length
, &chunk
);
365 u
->thread_info
.counter
+= chunk
.length
;
367 /* OK, let's send this data to the other threads */
368 PA_LLIST_FOREACH(j
, u
->thread_info
.active_outputs
) {
372 pa_asyncmsgq_post(j
->inq
, PA_MSGOBJECT(j
->sink_input
), SINK_INPUT_MESSAGE_POST
, NULL
, 0, &chunk
, NULL
);
375 /* And place it directly into the requesting output's queue */
376 pa_memblockq_push_align(o
->memblockq
, &chunk
);
377 pa_memblock_unref(chunk
.memblock
);
381 /* Called from I/O thread context */
382 static void request_memblock(struct output
*o
, size_t length
) {
384 pa_sink_input_assert_ref(o
->sink_input
);
385 pa_sink_assert_ref(o
->userdata
->sink
);
387 /* If another thread already prepared some data we received
388 * the data over the asyncmsgq, hence let's first process
390 while (pa_asyncmsgq_process_one(o
->inq
) > 0)
393 /* Check whether we're now readable */
394 if (pa_memblockq_is_readable(o
->memblockq
))
397 /* OK, we need to prepare new data, but only if the sink is actually running */
398 if (pa_atomic_load(&o
->userdata
->thread_info
.running
))
399 pa_asyncmsgq_send(o
->outq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_NEED
, o
, (int64_t) length
, NULL
);
402 /* Called from I/O thread context */
403 static int sink_input_pop_cb(pa_sink_input
*i
, size_t nbytes
, pa_memchunk
*chunk
) {
406 pa_sink_input_assert_ref(i
);
407 pa_assert_se(o
= i
->userdata
);
409 /* If necessary, get some new data */
410 request_memblock(o
, nbytes
);
412 /* pa_log("%s q size is %u + %u (%u/%u)", */
414 /* pa_memblockq_get_nblocks(o->memblockq), */
415 /* pa_memblockq_get_nblocks(i->thread_info.render_memblockq), */
416 /* pa_memblockq_get_maxrewind(o->memblockq), */
417 /* pa_memblockq_get_maxrewind(i->thread_info.render_memblockq)); */
419 if (pa_memblockq_peek(o
->memblockq
, chunk
) < 0)
422 pa_memblockq_drop(o
->memblockq
, chunk
->length
);
427 /* Called from I/O thread context */
428 static void sink_input_process_rewind_cb(pa_sink_input
*i
, size_t nbytes
) {
431 pa_sink_input_assert_ref(i
);
432 pa_assert_se(o
= i
->userdata
);
434 pa_memblockq_rewind(o
->memblockq
, nbytes
);
437 /* Called from I/O thread context */
438 static void sink_input_update_max_rewind_cb(pa_sink_input
*i
, size_t nbytes
) {
441 pa_sink_input_assert_ref(i
);
442 pa_assert_se(o
= i
->userdata
);
444 pa_memblockq_set_maxrewind(o
->memblockq
, nbytes
);
447 /* Called from I/O thread context */
448 static void sink_input_update_max_request_cb(pa_sink_input
*i
, size_t nbytes
) {
451 pa_sink_input_assert_ref(i
);
452 pa_assert_se(o
= i
->userdata
);
454 if (pa_atomic_load(&o
->max_request
) == (int) nbytes
)
457 pa_atomic_store(&o
->max_request
, (int) nbytes
);
458 pa_asyncmsgq_post(o
->outq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_UPDATE_MAX_REQUEST
, NULL
, 0, NULL
, NULL
);
461 /* Called from thread context */
462 static void sink_input_update_sink_requested_latency_cb(pa_sink_input
*i
) {
468 pa_sink_input_assert_ref(i
);
469 pa_assert_se(o
= i
->userdata
);
471 c
= pa_sink_get_requested_latency_within_thread(i
->sink
);
473 if (c
== (pa_usec_t
) -1)
474 c
= i
->sink
->thread_info
.max_latency
;
476 if (pa_atomic_load(&o
->requested_latency
) == (int) c
)
479 pa_atomic_store(&o
->requested_latency
, (int) c
);
480 pa_asyncmsgq_post(o
->outq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_UPDATE_REQUESTED_LATENCY
, NULL
, 0, NULL
, NULL
);
483 /* Called from I/O thread context */
484 static void sink_input_attach_cb(pa_sink_input
*i
) {
488 pa_sink_input_assert_ref(i
);
489 pa_assert_se(o
= i
->userdata
);
491 /* Set up the queue from the sink thread to us */
492 pa_assert(!o
->inq_rtpoll_item_read
&& !o
->outq_rtpoll_item_write
);
494 o
->inq_rtpoll_item_read
= pa_rtpoll_item_new_asyncmsgq_read(
495 i
->sink
->thread_info
.rtpoll
,
496 PA_RTPOLL_LATE
, /* This one is not that important, since we check for data in _peek() anyway. */
499 o
->outq_rtpoll_item_write
= pa_rtpoll_item_new_asyncmsgq_write(
500 i
->sink
->thread_info
.rtpoll
,
504 pa_sink_input_request_rewind(i
, 0, FALSE
, TRUE
, TRUE
);
506 pa_atomic_store(&o
->max_request
, (int) pa_sink_input_get_max_request(i
));
508 c
= pa_sink_get_requested_latency_within_thread(i
->sink
);
509 pa_atomic_store(&o
->requested_latency
, (int) (c
== (pa_usec_t
) -1 ? 0 : c
));
511 pa_asyncmsgq_post(o
->outq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_UPDATE_MAX_REQUEST
, NULL
, 0, NULL
, NULL
);
512 pa_asyncmsgq_post(o
->outq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_UPDATE_REQUESTED_LATENCY
, NULL
, 0, NULL
, NULL
);
515 /* Called from I/O thread context */
516 static void sink_input_detach_cb(pa_sink_input
*i
) {
519 pa_sink_input_assert_ref(i
);
520 pa_assert_se(o
= i
->userdata
);
522 if (o
->inq_rtpoll_item_read
) {
523 pa_rtpoll_item_free(o
->inq_rtpoll_item_read
);
524 o
->inq_rtpoll_item_read
= NULL
;
527 if (o
->outq_rtpoll_item_write
) {
528 pa_rtpoll_item_free(o
->outq_rtpoll_item_write
);
529 o
->outq_rtpoll_item_write
= NULL
;
533 /* Called from main context */
534 static void sink_input_kill_cb(pa_sink_input
*i
) {
537 pa_sink_input_assert_ref(i
);
538 pa_assert_se(o
= i
->userdata
);
540 pa_module_unload_request(o
->userdata
->module
, TRUE
);
544 /* Called from thread context */
545 static int sink_input_process_msg(pa_msgobject
*obj
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
546 struct output
*o
= PA_SINK_INPUT(obj
)->userdata
;
550 case PA_SINK_INPUT_MESSAGE_GET_LATENCY
: {
553 *r
= pa_bytes_to_usec(pa_memblockq_get_length(o
->memblockq
), &o
->sink_input
->sample_spec
);
555 /* Fall through, the default handler will add in the extra
556 * latency added by the resampler */
560 case SINK_INPUT_MESSAGE_POST
:
562 if (PA_SINK_IS_OPENED(o
->sink_input
->sink
->thread_info
.state
))
563 pa_memblockq_push_align(o
->memblockq
, chunk
);
565 pa_memblockq_flush_write(o
->memblockq
);
570 return pa_sink_input_process_msg(obj
, code
, data
, offset
, chunk
);
573 /* Called from main context */
574 static void suspend(struct userdata
*u
) {
580 /* Let's suspend by unlinking all streams */
581 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
)
584 pa_log_info("Device suspended...");
587 /* Called from main context */
588 static void unsuspend(struct userdata
*u
) {
595 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
)
598 pa_log_info("Resumed successfully...");
601 /* Called from main context */
602 static int sink_set_state(pa_sink
*sink
, pa_sink_state_t state
) {
605 pa_sink_assert_ref(sink
);
606 pa_assert_se(u
= sink
->userdata
);
608 /* Please note that in contrast to the ALSA modules we call
609 * suspend/unsuspend from main context here! */
612 case PA_SINK_SUSPENDED
:
613 pa_assert(PA_SINK_IS_OPENED(pa_sink_get_state(u
->sink
)));
619 case PA_SINK_RUNNING
:
621 if (pa_sink_get_state(u
->sink
) == PA_SINK_SUSPENDED
)
626 case PA_SINK_UNLINKED
:
628 case PA_SINK_INVALID_STATE
:
635 /* Called from IO context */
636 static void update_max_request(struct userdata
*u
) {
637 size_t max_request
= 0;
641 pa_sink_assert_io_context(u
->sink
);
643 /* Collects the max_request values of all streams and sets the
644 * largest one locally */
646 PA_LLIST_FOREACH(o
, u
->thread_info
.active_outputs
) {
647 size_t mr
= (size_t) pa_atomic_load(&o
->max_request
);
649 if (mr
> max_request
)
653 if (max_request
<= 0)
654 max_request
= pa_usec_to_bytes(u
->block_usec
, &u
->sink
->sample_spec
);
656 pa_sink_set_max_request_within_thread(u
->sink
, max_request
);
659 /* Called from IO context */
660 static void update_fixed_latency(struct userdata
*u
) {
661 pa_usec_t fixed_latency
= 0;
665 pa_sink_assert_io_context(u
->sink
);
667 /* Collects the requested_latency values of all streams and sets
668 * the largest one as fixed_latency locally */
670 PA_LLIST_FOREACH(o
, u
->thread_info
.active_outputs
) {
671 pa_usec_t rl
= (size_t) pa_atomic_load(&o
->requested_latency
);
673 if (rl
> fixed_latency
)
677 if (fixed_latency
<= 0)
678 fixed_latency
= u
->block_usec
;
680 pa_sink_set_fixed_latency_within_thread(u
->sink
, fixed_latency
);
683 /* Called from thread context of the io thread */
684 static void output_add_within_thread(struct output
*o
) {
686 pa_sink_assert_io_context(o
->sink
);
688 PA_LLIST_PREPEND(struct output
, o
->userdata
->thread_info
.active_outputs
, o
);
690 pa_assert(!o
->outq_rtpoll_item_read
&& !o
->inq_rtpoll_item_write
);
692 o
->outq_rtpoll_item_read
= pa_rtpoll_item_new_asyncmsgq_read(
694 PA_RTPOLL_EARLY
-1, /* This item is very important */
696 o
->inq_rtpoll_item_write
= pa_rtpoll_item_new_asyncmsgq_write(
702 /* Called from thread context of the io thread */
703 static void output_remove_within_thread(struct output
*o
) {
705 pa_sink_assert_io_context(o
->sink
);
707 PA_LLIST_REMOVE(struct output
, o
->userdata
->thread_info
.active_outputs
, o
);
709 if (o
->outq_rtpoll_item_read
) {
710 pa_rtpoll_item_free(o
->outq_rtpoll_item_read
);
711 o
->outq_rtpoll_item_read
= NULL
;
714 if (o
->inq_rtpoll_item_write
) {
715 pa_rtpoll_item_free(o
->inq_rtpoll_item_write
);
716 o
->inq_rtpoll_item_write
= NULL
;
720 /* Called from thread context of the io thread */
721 static int sink_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
722 struct userdata
*u
= PA_SINK(o
)->userdata
;
726 case PA_SINK_MESSAGE_SET_STATE
:
727 pa_atomic_store(&u
->thread_info
.running
, PA_PTR_TO_UINT(data
) == PA_SINK_RUNNING
);
729 if (PA_PTR_TO_UINT(data
) == PA_SINK_SUSPENDED
)
730 pa_smoother_pause(u
->thread_info
.smoother
, pa_rtclock_now());
732 pa_smoother_resume(u
->thread_info
.smoother
, pa_rtclock_now(), TRUE
);
736 case PA_SINK_MESSAGE_GET_LATENCY
: {
737 pa_usec_t x
, y
, c
, *delay
= data
;
739 x
= pa_rtclock_now();
740 y
= pa_smoother_get(u
->thread_info
.smoother
, x
);
742 c
= pa_bytes_to_usec(u
->thread_info
.counter
, &u
->sink
->sample_spec
);
752 case SINK_MESSAGE_ADD_OUTPUT
:
753 output_add_within_thread(data
);
754 update_max_request(u
);
755 update_fixed_latency(u
);
758 case SINK_MESSAGE_REMOVE_OUTPUT
:
759 output_remove_within_thread(data
);
760 update_max_request(u
);
761 update_fixed_latency(u
);
764 case SINK_MESSAGE_NEED
:
765 render_memblock(u
, (struct output
*) data
, (size_t) offset
);
768 case SINK_MESSAGE_UPDATE_LATENCY
: {
769 pa_usec_t x
, y
, latency
= (pa_usec_t
) offset
;
771 x
= pa_rtclock_now();
772 y
= pa_bytes_to_usec(u
->thread_info
.counter
, &u
->sink
->sample_spec
);
779 pa_smoother_put(u
->thread_info
.smoother
, x
, y
);
783 case SINK_MESSAGE_UPDATE_MAX_REQUEST
:
784 update_max_request(u
);
787 case SINK_MESSAGE_UPDATE_REQUESTED_LATENCY
:
788 update_fixed_latency(u
);
792 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
795 static void update_description(struct userdata
*u
) {
796 pa_bool_t first
= TRUE
;
806 if (pa_idxset_isempty(u
->outputs
)) {
807 pa_sink_set_description(u
->sink
, "Simultaneous output");
811 t
= pa_xstrdup("Simultaneous output to");
813 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
) {
817 e
= pa_sprintf_malloc("%s %s", t
, pa_strnull(pa_proplist_gets(o
->sink
->proplist
, PA_PROP_DEVICE_DESCRIPTION
)));
820 e
= pa_sprintf_malloc("%s, %s", t
, pa_strnull(pa_proplist_gets(o
->sink
->proplist
, PA_PROP_DEVICE_DESCRIPTION
)));
826 pa_sink_set_description(u
->sink
, t
);
830 static int output_create_sink_input(struct output
*o
) {
831 pa_sink_input_new_data data
;
838 pa_sink_input_new_data_init(&data
);
840 data
.driver
= __FILE__
;
841 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
)));
842 pa_proplist_sets(data
.proplist
, PA_PROP_MEDIA_ROLE
, "filter");
843 pa_sink_input_new_data_set_sample_spec(&data
, &o
->userdata
->sink
->sample_spec
);
844 pa_sink_input_new_data_set_channel_map(&data
, &o
->userdata
->sink
->channel_map
);
845 data
.module
= o
->userdata
->module
;
846 data
.resample_method
= o
->userdata
->resample_method
;
847 data
.flags
= PA_SINK_INPUT_VARIABLE_RATE
|PA_SINK_INPUT_DONT_MOVE
|PA_SINK_INPUT_NO_CREATE_ON_SUSPEND
;
849 pa_sink_input_new(&o
->sink_input
, o
->userdata
->core
, &data
);
851 pa_sink_input_new_data_done(&data
);
856 o
->sink_input
->parent
.process_msg
= sink_input_process_msg
;
857 o
->sink_input
->pop
= sink_input_pop_cb
;
858 o
->sink_input
->process_rewind
= sink_input_process_rewind_cb
;
859 o
->sink_input
->update_max_rewind
= sink_input_update_max_rewind_cb
;
860 o
->sink_input
->update_max_request
= sink_input_update_max_request_cb
;
861 o
->sink_input
->update_sink_requested_latency
= sink_input_update_sink_requested_latency_cb
;
862 o
->sink_input
->attach
= sink_input_attach_cb
;
863 o
->sink_input
->detach
= sink_input_detach_cb
;
864 o
->sink_input
->kill
= sink_input_kill_cb
;
865 o
->sink_input
->userdata
= o
;
867 pa_sink_input_set_requested_latency(o
->sink_input
, BLOCK_USEC
);
872 /* Called from main context */
873 static struct output
*output_new(struct userdata
*u
, pa_sink
*sink
) {
880 o
= pa_xnew0(struct output
, 1);
882 o
->inq
= pa_asyncmsgq_new(0);
883 o
->outq
= pa_asyncmsgq_new(0);
885 o
->memblockq
= pa_memblockq_new(
889 pa_frame_size(&u
->sink
->sample_spec
),
895 pa_assert_se(pa_idxset_put(u
->outputs
, o
, NULL
) == 0);
896 update_description(u
);
901 /* Called from main context */
902 static void output_free(struct output
*o
) {
907 pa_assert_se(pa_idxset_remove_by_data(o
->userdata
->outputs
, o
, NULL
));
908 update_description(o
->userdata
);
910 if (o
->inq_rtpoll_item_read
)
911 pa_rtpoll_item_free(o
->inq_rtpoll_item_read
);
912 if (o
->inq_rtpoll_item_write
)
913 pa_rtpoll_item_free(o
->inq_rtpoll_item_write
);
915 if (o
->outq_rtpoll_item_read
)
916 pa_rtpoll_item_free(o
->outq_rtpoll_item_read
);
917 if (o
->outq_rtpoll_item_write
)
918 pa_rtpoll_item_free(o
->outq_rtpoll_item_write
);
921 pa_asyncmsgq_unref(o
->inq
);
924 pa_asyncmsgq_unref(o
->outq
);
927 pa_memblockq_free(o
->memblockq
);
932 /* Called from main context */
933 static void output_enable(struct output
*o
) {
939 /* This might cause the sink to be resumed. The state change hook
940 * of the sink might hence be called from here, which might then
941 * cause us to be called in a loop. Make sure that state changes
942 * for this output don't cause this loop by setting a flag here */
943 o
->ignore_state_change
= TRUE
;
945 if (output_create_sink_input(o
) >= 0) {
947 if (pa_sink_get_state(o
->sink
) != PA_SINK_INIT
) {
949 /* First we register the output. That means that the sink
950 * will start to pass data to this output. */
951 pa_asyncmsgq_send(o
->userdata
->sink
->asyncmsgq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_ADD_OUTPUT
, o
, 0, NULL
);
953 /* Then we enable the sink input. That means that the sink
954 * is now asked for new data. */
955 pa_sink_input_put(o
->sink_input
);
958 /* Hmm the sink is not yet started, do things right here */
959 output_add_within_thread(o
);
962 o
->ignore_state_change
= FALSE
;
965 /* Called from main context */
966 static void output_disable(struct output
*o
) {
972 /* First we disable the sink input. That means that the sink is
973 * not asked for new data anymore */
974 pa_sink_input_unlink(o
->sink_input
);
976 /* Then we unregister the output. That means that the sink doesn't
977 * pass any further data to this output */
978 pa_asyncmsgq_send(o
->userdata
->sink
->asyncmsgq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_REMOVE_OUTPUT
, o
, 0, NULL
);
980 /* Now dellocate the stream */
981 pa_sink_input_unref(o
->sink_input
);
982 o
->sink_input
= NULL
;
984 /* Finally, drop all queued data */
985 pa_memblockq_flush_write(o
->memblockq
);
986 pa_asyncmsgq_flush(o
->inq
, FALSE
);
987 pa_asyncmsgq_flush(o
->outq
, FALSE
);
990 /* Called from main context */
991 static void output_verify(struct output
*o
) {
994 if (PA_SINK_IS_OPENED(pa_sink_get_state(o
->userdata
->sink
)))
1000 /* Called from main context */
1001 static pa_bool_t
is_suitable_sink(struct userdata
*u
, pa_sink
*s
) {
1004 pa_sink_assert_ref(s
);
1009 if (!(s
->flags
& PA_SINK_HARDWARE
))
1012 if (!(s
->flags
& PA_SINK_LATENCY
))
1015 if ((t
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_CLASS
)))
1016 if (!pa_streq(t
, "sound"))
1022 /* Called from main context */
1023 static pa_hook_result_t
sink_put_hook_cb(pa_core
*c
, pa_sink
*s
, struct userdata
* u
) {
1026 pa_core_assert_ref(c
);
1027 pa_sink_assert_ref(s
);
1029 pa_assert(u
->automatic
);
1031 if (!is_suitable_sink(u
, s
))
1034 pa_log_info("Configuring new sink: %s", s
->name
);
1035 if (!(o
= output_new(u
, s
))) {
1036 pa_log("Failed to create sink input on sink '%s'.", s
->name
);
1045 /* Called from main context */
1046 static struct output
* find_output(struct userdata
*u
, pa_sink
*s
) {
1056 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
)
1063 /* Called from main context */
1064 static pa_hook_result_t
sink_unlink_hook_cb(pa_core
*c
, pa_sink
*s
, struct userdata
* u
) {
1068 pa_sink_assert_ref(s
);
1071 if (!(o
= find_output(u
, s
)))
1074 pa_log_info("Unconfiguring sink: %s", s
->name
);
1080 /* Called from main context */
1081 static pa_hook_result_t
sink_state_changed_hook_cb(pa_core
*c
, pa_sink
*s
, struct userdata
* u
) {
1084 if (!(o
= find_output(u
, s
)))
1087 /* This state change might be triggered because we are creating a
1088 * stream here, in that case we don't want to create it a second
1089 * time here and enter a loop */
1090 if (o
->ignore_state_change
)
1098 int pa__init(pa_module
*m
) {
1100 pa_modargs
*ma
= NULL
;
1101 const char *slaves
, *rm
;
1102 int resample_method
= PA_RESAMPLER_TRIVIAL
;
1107 pa_sink_new_data data
;
1108 uint32_t adjust_time_sec
;
1112 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
1113 pa_log("failed to parse module arguments");
1117 if ((rm
= pa_modargs_get_value(ma
, "resample_method", NULL
))) {
1118 if ((resample_method
= pa_parse_resample_method(rm
)) < 0) {
1119 pa_log("invalid resample method '%s'", rm
);
1124 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
1127 u
->rtpoll
= pa_rtpoll_new();
1128 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
1129 u
->resample_method
= resample_method
;
1130 u
->outputs
= pa_idxset_new(NULL
, NULL
);
1131 u
->thread_info
.smoother
= pa_smoother_new(
1140 adjust_time_sec
= DEFAULT_ADJUST_TIME_USEC
/ PA_USEC_PER_SEC
;
1141 if (pa_modargs_get_value_u32(ma
, "adjust_time", &adjust_time_sec
) < 0) {
1142 pa_log("Failed to parse adjust_time value");
1146 if (adjust_time_sec
!= DEFAULT_ADJUST_TIME_USEC
/ PA_USEC_PER_SEC
)
1147 u
->adjust_time
= adjust_time_sec
* PA_USEC_PER_SEC
;
1149 u
->adjust_time
= DEFAULT_ADJUST_TIME_USEC
;
1151 slaves
= pa_modargs_get_value(ma
, "slaves", NULL
);
1152 u
->automatic
= !slaves
;
1154 ss
= m
->core
->default_sample_spec
;
1155 map
= m
->core
->default_channel_map
;
1157 /* Check the specified slave sinks for sample_spec and channel_map to use for the combined sink */
1158 if (!u
->automatic
) {
1159 const char*split_state
= NULL
;
1161 pa_sample_spec slaves_spec
;
1162 pa_channel_map slaves_map
;
1163 pa_bool_t is_first_slave
= TRUE
;
1165 pa_sample_spec_init(&slaves_spec
);
1167 while ((n
= pa_split(slaves
, ",", &split_state
))) {
1168 pa_sink
*slave_sink
;
1170 if (!(slave_sink
= pa_namereg_get(m
->core
, n
, PA_NAMEREG_SINK
))) {
1171 pa_log("Invalid slave sink '%s'", n
);
1178 if (is_first_slave
) {
1179 slaves_spec
= slave_sink
->sample_spec
;
1180 slaves_map
= slave_sink
->channel_map
;
1181 is_first_slave
= FALSE
;
1183 if (slaves_spec
.format
!= slave_sink
->sample_spec
.format
)
1184 slaves_spec
.format
= PA_SAMPLE_INVALID
;
1186 if (slaves_spec
.rate
< slave_sink
->sample_spec
.rate
)
1187 slaves_spec
.rate
= slave_sink
->sample_spec
.rate
;
1189 if (!pa_channel_map_equal(&slaves_map
, &slave_sink
->channel_map
))
1190 slaves_spec
.channels
= 0;
1194 if (!is_first_slave
) {
1195 if (slaves_spec
.format
!= PA_SAMPLE_INVALID
)
1196 ss
.format
= slaves_spec
.format
;
1198 ss
.rate
= slaves_spec
.rate
;
1200 if (slaves_spec
.channels
> 0) {
1202 ss
.channels
= slaves_map
.channels
;
1207 if ((pa_modargs_get_sample_spec_and_channel_map(ma
, &ss
, &map
, PA_CHANNEL_MAP_DEFAULT
) < 0)) {
1208 pa_log("Invalid sample specification.");
1212 pa_sink_new_data_init(&data
);
1213 data
.namereg_fail
= FALSE
;
1214 data
.driver
= __FILE__
;
1216 pa_sink_new_data_set_name(&data
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
));
1217 pa_sink_new_data_set_sample_spec(&data
, &ss
);
1218 pa_sink_new_data_set_channel_map(&data
, &map
);
1219 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_CLASS
, "filter");
1222 pa_proplist_sets(data
.proplist
, "combine.slaves", slaves
);
1224 if (pa_modargs_get_proplist(ma
, "sink_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
1225 pa_log("Invalid properties");
1226 pa_sink_new_data_done(&data
);
1230 /* Check proplist for a description & fill in a default value if not */
1231 u
->auto_desc
= FALSE
;
1232 if (NULL
== pa_proplist_gets(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
)) {
1233 u
->auto_desc
= TRUE
;
1234 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Simultaneous Output");
1237 u
->sink
= pa_sink_new(m
->core
, &data
, PA_SINK_LATENCY
);
1238 pa_sink_new_data_done(&data
);
1241 pa_log("Failed to create sink");
1245 u
->sink
->parent
.process_msg
= sink_process_msg
;
1246 u
->sink
->set_state
= sink_set_state
;
1247 u
->sink
->userdata
= u
;
1249 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
1250 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
1252 u
->block_usec
= BLOCK_USEC
;
1253 pa_sink_set_max_request(u
->sink
, pa_usec_to_bytes(u
->block_usec
, &u
->sink
->sample_spec
));
1255 if (!u
->automatic
) {
1256 const char*split_state
;
1260 /* The slaves have been specified manually */
1263 while ((n
= pa_split(slaves
, ",", &split_state
))) {
1264 pa_sink
*slave_sink
;
1266 if (!(slave_sink
= pa_namereg_get(m
->core
, n
, PA_NAMEREG_SINK
)) || slave_sink
== u
->sink
) {
1267 pa_log("Invalid slave sink '%s'", n
);
1274 if (!output_new(u
, slave_sink
)) {
1275 pa_log("Failed to create slave sink input on sink '%s'.", slave_sink
->name
);
1280 if (pa_idxset_size(u
->outputs
) <= 1)
1281 pa_log_warn("No slave sinks specified.");
1283 u
->sink_put_slot
= NULL
;
1288 /* We're in automatic mode, we add every sink that matches our needs */
1290 PA_IDXSET_FOREACH(s
, m
->core
->sinks
, idx
) {
1292 if (!is_suitable_sink(u
, s
))
1295 if (!output_new(u
, s
)) {
1296 pa_log("Failed to create sink input on sink '%s'.", s
->name
);
1301 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
);
1304 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
);
1305 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
);
1307 if (!(u
->thread
= pa_thread_new(thread_func
, u
))) {
1308 pa_log("Failed to create thread.");
1312 /* Activate the sink and the sink inputs */
1313 pa_sink_put(u
->sink
);
1315 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
)
1318 if (u
->adjust_time
> 0)
1319 u
->time_event
= pa_core_rttime_new(m
->core
, pa_rtclock_now() + u
->adjust_time
, time_callback
, u
);
1321 pa_modargs_free(ma
);
1328 pa_modargs_free(ma
);
1335 void pa__done(pa_module
*m
) {
1341 if (!(u
= m
->userdata
))
1344 if (u
->sink_put_slot
)
1345 pa_hook_slot_free(u
->sink_put_slot
);
1347 if (u
->sink_unlink_slot
)
1348 pa_hook_slot_free(u
->sink_unlink_slot
);
1350 if (u
->sink_state_changed_slot
)
1351 pa_hook_slot_free(u
->sink_state_changed_slot
);
1354 while ((o
= pa_idxset_first(u
->outputs
, NULL
)))
1357 pa_idxset_free(u
->outputs
, NULL
, NULL
);
1361 pa_sink_unlink(u
->sink
);
1364 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
1365 pa_thread_free(u
->thread
);
1368 pa_thread_mq_done(&u
->thread_mq
);
1371 pa_sink_unref(u
->sink
);
1374 pa_rtpoll_free(u
->rtpoll
);
1377 u
->core
->mainloop
->time_free(u
->time_event
);
1379 if (u
->thread_info
.smoother
)
1380 pa_smoother_free(u
->thread_info
.smoother
);