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/thread.h>
45 #include <pulsecore/thread-mq.h>
46 #include <pulsecore/rtpoll.h>
47 #include <pulsecore/time-smoother.h>
48 #include <pulsecore/strlist.h>
50 #include "module-combine-sink-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=<how often to readjust rates in s> "
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_USEC (10*PA_USEC_PER_SEC)
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
;
93 bool ignore_state_change
;
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
;
100 pa_memblockq
*memblockq
;
102 /* For communication of the stream latencies to the main thread */
103 pa_usec_t total_latency
;
105 /* For communication of the stream parameters to the sink thread */
106 pa_atomic_t max_request
;
107 pa_atomic_t requested_latency
;
109 PA_LLIST_FIELDS(struct output
);
118 pa_thread_mq thread_mq
;
121 pa_time_event
*time_event
;
122 pa_usec_t adjust_time
;
127 pa_strlist
*unlinked_slaves
;
129 pa_hook_slot
*sink_put_slot
, *sink_unlink_slot
, *sink_state_changed_slot
;
131 pa_resample_method_t resample_method
;
133 pa_usec_t block_usec
;
135 pa_idxset
* outputs
; /* managed in main context */
138 PA_LLIST_HEAD(struct output
, active_outputs
); /* managed in IO thread context */
139 pa_atomic_t running
; /* we cache that value here, so that every thread can query it cheaply */
142 pa_smoother
*smoother
;
148 SINK_MESSAGE_ADD_OUTPUT
= PA_SINK_MESSAGE_MAX
,
149 SINK_MESSAGE_REMOVE_OUTPUT
,
151 SINK_MESSAGE_UPDATE_LATENCY
,
152 SINK_MESSAGE_UPDATE_MAX_REQUEST
,
153 SINK_MESSAGE_UPDATE_REQUESTED_LATENCY
157 SINK_INPUT_MESSAGE_POST
= PA_SINK_INPUT_MESSAGE_MAX
,
160 static void output_disable(struct output
*o
);
161 static void output_enable(struct output
*o
);
162 static void output_free(struct output
*o
);
163 static int output_create_sink_input(struct output
*o
);
165 static void adjust_rates(struct userdata
*u
) {
167 pa_usec_t max_sink_latency
= 0, min_total_latency
= (pa_usec_t
) -1, target_latency
, avg_total_latency
= 0;
173 pa_sink_assert_ref(u
->sink
);
175 if (pa_idxset_size(u
->outputs
) <= 0)
178 if (!PA_SINK_IS_OPENED(pa_sink_get_state(u
->sink
)))
181 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
) {
182 pa_usec_t sink_latency
;
184 if (!o
->sink_input
|| !PA_SINK_IS_OPENED(pa_sink_get_state(o
->sink
)))
187 o
->total_latency
= pa_sink_input_get_latency(o
->sink_input
, &sink_latency
);
188 o
->total_latency
+= sink_latency
;
190 if (sink_latency
> max_sink_latency
)
191 max_sink_latency
= sink_latency
;
193 if (min_total_latency
== (pa_usec_t
) -1 || o
->total_latency
< min_total_latency
)
194 min_total_latency
= o
->total_latency
;
196 avg_total_latency
+= o
->total_latency
;
199 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
);
201 if (o
->total_latency
> 10*PA_USEC_PER_SEC
)
202 pa_log_warn("[%s] Total latency of output is very high (%0.2fms), most likely the audio timing in one of your drivers is broken.", o
->sink
->name
, (double) o
->total_latency
/ PA_USEC_PER_MSEC
);
205 if (min_total_latency
== (pa_usec_t
) -1)
208 avg_total_latency
/= n
;
210 target_latency
= max_sink_latency
> min_total_latency
? max_sink_latency
: min_total_latency
;
212 pa_log_info("[%s] avg total latency is %0.2f msec.", u
->sink
->name
, (double) avg_total_latency
/ PA_USEC_PER_MSEC
);
213 pa_log_info("[%s] target latency is %0.2f msec.", u
->sink
->name
, (double) target_latency
/ PA_USEC_PER_MSEC
);
215 base_rate
= u
->sink
->sample_spec
.rate
;
217 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
) {
218 uint32_t new_rate
= base_rate
;
219 uint32_t current_rate
= o
->sink_input
->sample_spec
.rate
;
221 if (!o
->sink_input
|| !PA_SINK_IS_OPENED(pa_sink_get_state(o
->sink
)))
224 if (o
->total_latency
!= target_latency
)
225 new_rate
+= (uint32_t) (((double) o
->total_latency
- (double) target_latency
) / (double) u
->adjust_time
* (double) new_rate
);
227 if (new_rate
< (uint32_t) (base_rate
*0.8) || new_rate
> (uint32_t) (base_rate
*1.25)) {
228 pa_log_warn("[%s] sample rates too different, not adjusting (%u vs. %u).", o
->sink_input
->sink
->name
, base_rate
, new_rate
);
229 new_rate
= base_rate
;
231 if (base_rate
< new_rate
+ 20 && new_rate
< base_rate
+ 20)
232 new_rate
= base_rate
;
233 /* Do the adjustment in small steps; 2‰ can be considered inaudible */
234 if (new_rate
< (uint32_t) (current_rate
*0.998) || new_rate
> (uint32_t) (current_rate
*1.002)) {
235 pa_log_info("[%s] new rate of %u Hz not within 2‰ of %u Hz, forcing smaller adjustment", o
->sink_input
->sink
->name
, new_rate
, current_rate
);
236 new_rate
= PA_CLAMP(new_rate
, (uint32_t) (current_rate
*0.998), (uint32_t) (current_rate
*1.002));
238 pa_log_info("[%s] new rate is %u Hz; ratio is %0.3f; latency is %0.2f msec.", o
->sink_input
->sink
->name
, new_rate
, (double) new_rate
/ base_rate
, (double) o
->total_latency
/ PA_USEC_PER_MSEC
);
240 pa_sink_input_set_rate(o
->sink_input
, new_rate
);
243 pa_asyncmsgq_send(u
->sink
->asyncmsgq
, PA_MSGOBJECT(u
->sink
), SINK_MESSAGE_UPDATE_LATENCY
, NULL
, (int64_t) avg_total_latency
, NULL
);
246 static void time_callback(pa_mainloop_api
*a
, pa_time_event
*e
, const struct timeval
*t
, void *userdata
) {
247 struct userdata
*u
= userdata
;
251 pa_assert(u
->time_event
== e
);
255 if (pa_sink_get_state(u
->sink
) == PA_SINK_SUSPENDED
) {
256 u
->core
->mainloop
->time_free(e
);
257 u
->time_event
= NULL
;
259 pa_core_rttime_restart(u
->core
, e
, pa_rtclock_now() + u
->adjust_time
);
262 static void process_render_null(struct userdata
*u
, pa_usec_t now
) {
266 pa_assert(u
->sink
->thread_info
.state
== PA_SINK_RUNNING
);
268 if (u
->thread_info
.in_null_mode
)
269 u
->thread_info
.timestamp
= now
;
271 while (u
->thread_info
.timestamp
< now
+ u
->block_usec
) {
274 pa_sink_render(u
->sink
, u
->sink
->thread_info
.max_request
, &chunk
);
275 pa_memblock_unref(chunk
.memblock
);
277 u
->thread_info
.counter
+= chunk
.length
;
279 /* pa_log_debug("Ate %lu bytes.", (unsigned long) chunk.length); */
280 u
->thread_info
.timestamp
+= pa_bytes_to_usec(chunk
.length
, &u
->sink
->sample_spec
);
284 if (ate
>= u
->sink
->thread_info
.max_request
)
288 /* pa_log_debug("Ate in sum %lu bytes (of %lu)", (unsigned long) ate, (unsigned long) nbytes); */
290 pa_smoother_put(u
->thread_info
.smoother
, now
,
291 pa_bytes_to_usec(u
->thread_info
.counter
, &u
->sink
->sample_spec
) - (u
->thread_info
.timestamp
- now
));
294 static void thread_func(void *userdata
) {
295 struct userdata
*u
= userdata
;
299 pa_log_debug("Thread starting up");
301 if (u
->core
->realtime_scheduling
)
302 pa_make_realtime(u
->core
->realtime_priority
+1);
304 pa_thread_mq_install(&u
->thread_mq
);
306 u
->thread_info
.timestamp
= pa_rtclock_now();
307 u
->thread_info
.in_null_mode
= false;
312 if (PA_UNLIKELY(u
->sink
->thread_info
.rewind_requested
))
313 pa_sink_process_rewind(u
->sink
, 0);
315 /* If no outputs are connected, render some data and drop it immediately. */
316 if (u
->sink
->thread_info
.state
== PA_SINK_RUNNING
&& !u
->thread_info
.active_outputs
) {
319 now
= pa_rtclock_now();
321 if (!u
->thread_info
.in_null_mode
|| u
->thread_info
.timestamp
<= now
)
322 process_render_null(u
, now
);
324 pa_rtpoll_set_timer_absolute(u
->rtpoll
, u
->thread_info
.timestamp
);
325 u
->thread_info
.in_null_mode
= true;
327 pa_rtpoll_set_timer_disabled(u
->rtpoll
);
328 u
->thread_info
.in_null_mode
= false;
331 /* Hmm, nothing to do. Let's sleep */
332 if ((ret
= pa_rtpoll_run(u
->rtpoll
, true)) < 0) {
333 pa_log_info("pa_rtpoll_run() = %i", ret
);
342 /* If this was no regular exit from the loop we have to continue
343 * processing messages until we received PA_MESSAGE_SHUTDOWN */
344 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
345 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
348 pa_log_debug("Thread shutting down");
351 /* Called from I/O thread context */
352 static void render_memblock(struct userdata
*u
, struct output
*o
, size_t length
) {
356 /* We are run by the sink thread, on behalf of an output (o). The
357 * output is waiting for us, hence it is safe to access its
358 * mainblockq and asyncmsgq directly. */
360 /* If we are not running, we cannot produce any data */
361 if (!pa_atomic_load(&u
->thread_info
.running
))
364 /* Maybe there's some data in the requesting output's queue
366 while (pa_asyncmsgq_process_one(o
->inq
) > 0)
369 /* Ok, now let's prepare some data if we really have to */
370 while (!pa_memblockq_is_readable(o
->memblockq
)) {
375 pa_sink_render(u
->sink
, length
, &chunk
);
377 u
->thread_info
.counter
+= chunk
.length
;
379 /* OK, let's send this data to the other threads */
380 PA_LLIST_FOREACH(j
, u
->thread_info
.active_outputs
) {
384 pa_asyncmsgq_post(j
->inq
, PA_MSGOBJECT(j
->sink_input
), SINK_INPUT_MESSAGE_POST
, NULL
, 0, &chunk
, NULL
);
387 /* And place it directly into the requesting output's queue */
388 pa_memblockq_push_align(o
->memblockq
, &chunk
);
389 pa_memblock_unref(chunk
.memblock
);
393 /* Called from I/O thread context */
394 static void request_memblock(struct output
*o
, size_t length
) {
396 pa_sink_input_assert_ref(o
->sink_input
);
397 pa_sink_assert_ref(o
->userdata
->sink
);
399 /* If another thread already prepared some data we received
400 * the data over the asyncmsgq, hence let's first process
402 while (pa_asyncmsgq_process_one(o
->inq
) > 0)
405 /* Check whether we're now readable */
406 if (pa_memblockq_is_readable(o
->memblockq
))
409 /* OK, we need to prepare new data, but only if the sink is actually running */
410 if (pa_atomic_load(&o
->userdata
->thread_info
.running
))
411 pa_asyncmsgq_send(o
->outq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_NEED
, o
, (int64_t) length
, NULL
);
414 /* Called from I/O thread context */
415 static int sink_input_pop_cb(pa_sink_input
*i
, size_t nbytes
, pa_memchunk
*chunk
) {
418 pa_sink_input_assert_ref(i
);
419 pa_assert_se(o
= i
->userdata
);
421 /* If necessary, get some new data */
422 request_memblock(o
, nbytes
);
424 /* pa_log("%s q size is %u + %u (%u/%u)", */
426 /* pa_memblockq_get_nblocks(o->memblockq), */
427 /* pa_memblockq_get_nblocks(i->thread_info.render_memblockq), */
428 /* pa_memblockq_get_maxrewind(o->memblockq), */
429 /* pa_memblockq_get_maxrewind(i->thread_info.render_memblockq)); */
431 if (pa_memblockq_peek(o
->memblockq
, chunk
) < 0)
434 pa_memblockq_drop(o
->memblockq
, chunk
->length
);
439 /* Called from I/O thread context */
440 static void sink_input_process_rewind_cb(pa_sink_input
*i
, size_t nbytes
) {
443 pa_sink_input_assert_ref(i
);
444 pa_assert_se(o
= i
->userdata
);
446 pa_memblockq_rewind(o
->memblockq
, nbytes
);
449 /* Called from I/O thread context */
450 static void sink_input_update_max_rewind_cb(pa_sink_input
*i
, size_t nbytes
) {
453 pa_sink_input_assert_ref(i
);
454 pa_assert_se(o
= i
->userdata
);
456 pa_memblockq_set_maxrewind(o
->memblockq
, nbytes
);
459 /* Called from I/O thread context */
460 static void sink_input_update_max_request_cb(pa_sink_input
*i
, size_t nbytes
) {
463 pa_sink_input_assert_ref(i
);
464 pa_assert_se(o
= i
->userdata
);
466 if (pa_atomic_load(&o
->max_request
) == (int) nbytes
)
469 pa_atomic_store(&o
->max_request
, (int) nbytes
);
470 pa_asyncmsgq_post(o
->outq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_UPDATE_MAX_REQUEST
, NULL
, 0, NULL
, NULL
);
473 /* Called from thread context */
474 static void sink_input_update_sink_requested_latency_cb(pa_sink_input
*i
) {
480 pa_sink_input_assert_ref(i
);
481 pa_assert_se(o
= i
->userdata
);
483 c
= pa_sink_get_requested_latency_within_thread(i
->sink
);
485 if (c
== (pa_usec_t
) -1)
486 c
= i
->sink
->thread_info
.max_latency
;
488 if (pa_atomic_load(&o
->requested_latency
) == (int) c
)
491 pa_atomic_store(&o
->requested_latency
, (int) c
);
492 pa_asyncmsgq_post(o
->outq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_UPDATE_REQUESTED_LATENCY
, NULL
, 0, NULL
, NULL
);
495 /* Called from I/O thread context */
496 static void sink_input_attach_cb(pa_sink_input
*i
) {
500 pa_sink_input_assert_ref(i
);
501 pa_assert_se(o
= i
->userdata
);
503 /* Set up the queue from the sink thread to us */
504 pa_assert(!o
->inq_rtpoll_item_read
&& !o
->outq_rtpoll_item_write
);
506 o
->inq_rtpoll_item_read
= pa_rtpoll_item_new_asyncmsgq_read(
507 i
->sink
->thread_info
.rtpoll
,
508 PA_RTPOLL_LATE
, /* This one is not that important, since we check for data in _peek() anyway. */
511 o
->outq_rtpoll_item_write
= pa_rtpoll_item_new_asyncmsgq_write(
512 i
->sink
->thread_info
.rtpoll
,
516 pa_sink_input_request_rewind(i
, 0, false, true, true);
518 pa_atomic_store(&o
->max_request
, (int) pa_sink_input_get_max_request(i
));
520 c
= pa_sink_get_requested_latency_within_thread(i
->sink
);
521 pa_atomic_store(&o
->requested_latency
, (int) (c
== (pa_usec_t
) -1 ? 0 : c
));
523 pa_asyncmsgq_post(o
->outq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_UPDATE_MAX_REQUEST
, NULL
, 0, NULL
, NULL
);
524 pa_asyncmsgq_post(o
->outq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_UPDATE_REQUESTED_LATENCY
, NULL
, 0, NULL
, NULL
);
527 /* Called from I/O thread context */
528 static void sink_input_detach_cb(pa_sink_input
*i
) {
531 pa_sink_input_assert_ref(i
);
532 pa_assert_se(o
= i
->userdata
);
534 if (o
->inq_rtpoll_item_read
) {
535 pa_rtpoll_item_free(o
->inq_rtpoll_item_read
);
536 o
->inq_rtpoll_item_read
= NULL
;
539 if (o
->outq_rtpoll_item_write
) {
540 pa_rtpoll_item_free(o
->outq_rtpoll_item_write
);
541 o
->outq_rtpoll_item_write
= NULL
;
545 /* Called from main context */
546 static void sink_input_kill_cb(pa_sink_input
*i
) {
549 pa_sink_input_assert_ref(i
);
550 pa_assert_se(o
= i
->userdata
);
552 pa_module_unload_request(o
->userdata
->module
, true);
553 pa_idxset_remove_by_data(o
->userdata
->outputs
, o
, NULL
);
557 /* Called from thread context */
558 static int sink_input_process_msg(pa_msgobject
*obj
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
559 struct output
*o
= PA_SINK_INPUT(obj
)->userdata
;
563 case PA_SINK_INPUT_MESSAGE_GET_LATENCY
: {
566 *r
= pa_bytes_to_usec(pa_memblockq_get_length(o
->memblockq
), &o
->sink_input
->sample_spec
);
568 /* Fall through, the default handler will add in the extra
569 * latency added by the resampler */
573 case SINK_INPUT_MESSAGE_POST
:
575 if (PA_SINK_IS_OPENED(o
->sink_input
->sink
->thread_info
.state
))
576 pa_memblockq_push_align(o
->memblockq
, chunk
);
578 pa_memblockq_flush_write(o
->memblockq
, true);
583 return pa_sink_input_process_msg(obj
, code
, data
, offset
, chunk
);
586 /* Called from main context */
587 static void suspend(struct userdata
*u
) {
593 /* Let's suspend by unlinking all streams */
594 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
)
597 pa_log_info("Device suspended...");
600 /* Called from main context */
601 static void unsuspend(struct userdata
*u
) {
608 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
)
612 u
->time_event
= pa_core_rttime_new(u
->core
, pa_rtclock_now() + u
->adjust_time
, time_callback
, u
);
614 pa_log_info("Resumed successfully...");
617 /* Called from main context */
618 static int sink_set_state(pa_sink
*sink
, pa_sink_state_t state
) {
621 pa_sink_assert_ref(sink
);
622 pa_assert_se(u
= sink
->userdata
);
624 /* Please note that in contrast to the ALSA modules we call
625 * suspend/unsuspend from main context here! */
628 case PA_SINK_SUSPENDED
:
629 pa_assert(PA_SINK_IS_OPENED(pa_sink_get_state(u
->sink
)));
635 case PA_SINK_RUNNING
:
637 if (pa_sink_get_state(u
->sink
) == PA_SINK_SUSPENDED
)
642 case PA_SINK_UNLINKED
:
644 case PA_SINK_INVALID_STATE
:
651 /* Called from IO context */
652 static void update_max_request(struct userdata
*u
) {
653 size_t max_request
= 0;
657 pa_sink_assert_io_context(u
->sink
);
659 /* Collects the max_request values of all streams and sets the
660 * largest one locally */
662 PA_LLIST_FOREACH(o
, u
->thread_info
.active_outputs
) {
663 size_t mr
= (size_t) pa_atomic_load(&o
->max_request
);
665 if (mr
> max_request
)
669 if (max_request
<= 0)
670 max_request
= pa_usec_to_bytes(u
->block_usec
, &u
->sink
->sample_spec
);
672 pa_sink_set_max_request_within_thread(u
->sink
, max_request
);
675 /* Called from IO context */
676 static void update_fixed_latency(struct userdata
*u
) {
677 pa_usec_t fixed_latency
= 0;
681 pa_sink_assert_io_context(u
->sink
);
683 /* Collects the requested_latency values of all streams and sets
684 * the largest one as fixed_latency locally */
686 PA_LLIST_FOREACH(o
, u
->thread_info
.active_outputs
) {
687 pa_usec_t rl
= (size_t) pa_atomic_load(&o
->requested_latency
);
689 if (rl
> fixed_latency
)
693 if (fixed_latency
<= 0)
694 fixed_latency
= u
->block_usec
;
696 pa_sink_set_fixed_latency_within_thread(u
->sink
, fixed_latency
);
699 /* Called from thread context of the io thread */
700 static void output_add_within_thread(struct output
*o
) {
702 pa_sink_assert_io_context(o
->sink
);
704 PA_LLIST_PREPEND(struct output
, o
->userdata
->thread_info
.active_outputs
, o
);
706 pa_assert(!o
->outq_rtpoll_item_read
&& !o
->inq_rtpoll_item_write
);
708 o
->outq_rtpoll_item_read
= pa_rtpoll_item_new_asyncmsgq_read(
710 PA_RTPOLL_EARLY
-1, /* This item is very important */
712 o
->inq_rtpoll_item_write
= pa_rtpoll_item_new_asyncmsgq_write(
718 /* Called from thread context of the io thread */
719 static void output_remove_within_thread(struct output
*o
) {
721 pa_sink_assert_io_context(o
->sink
);
723 PA_LLIST_REMOVE(struct output
, o
->userdata
->thread_info
.active_outputs
, o
);
725 if (o
->outq_rtpoll_item_read
) {
726 pa_rtpoll_item_free(o
->outq_rtpoll_item_read
);
727 o
->outq_rtpoll_item_read
= NULL
;
730 if (o
->inq_rtpoll_item_write
) {
731 pa_rtpoll_item_free(o
->inq_rtpoll_item_write
);
732 o
->inq_rtpoll_item_write
= NULL
;
736 /* Called from thread context of the io thread */
737 static int sink_process_msg(pa_msgobject
*o
, int code
, void *data
, int64_t offset
, pa_memchunk
*chunk
) {
738 struct userdata
*u
= PA_SINK(o
)->userdata
;
742 case PA_SINK_MESSAGE_SET_STATE
: {
743 bool running
= (PA_PTR_TO_UINT(data
) == PA_SINK_RUNNING
);
745 pa_atomic_store(&u
->thread_info
.running
, running
);
748 pa_smoother_resume(u
->thread_info
.smoother
, pa_rtclock_now(), true);
750 pa_smoother_pause(u
->thread_info
.smoother
, pa_rtclock_now());
755 case PA_SINK_MESSAGE_GET_LATENCY
: {
756 pa_usec_t x
, y
, c
, *delay
= data
;
758 x
= pa_rtclock_now();
759 y
= pa_smoother_get(u
->thread_info
.smoother
, x
);
761 c
= pa_bytes_to_usec(u
->thread_info
.counter
, &u
->sink
->sample_spec
);
771 case SINK_MESSAGE_ADD_OUTPUT
:
772 output_add_within_thread(data
);
773 update_max_request(u
);
774 update_fixed_latency(u
);
777 case SINK_MESSAGE_REMOVE_OUTPUT
:
778 output_remove_within_thread(data
);
779 update_max_request(u
);
780 update_fixed_latency(u
);
783 case SINK_MESSAGE_NEED
:
784 render_memblock(u
, (struct output
*) data
, (size_t) offset
);
787 case SINK_MESSAGE_UPDATE_LATENCY
: {
788 pa_usec_t x
, y
, latency
= (pa_usec_t
) offset
;
790 x
= pa_rtclock_now();
791 y
= pa_bytes_to_usec(u
->thread_info
.counter
, &u
->sink
->sample_spec
);
798 pa_smoother_put(u
->thread_info
.smoother
, x
, y
);
802 case SINK_MESSAGE_UPDATE_MAX_REQUEST
:
803 update_max_request(u
);
806 case SINK_MESSAGE_UPDATE_REQUESTED_LATENCY
:
807 update_fixed_latency(u
);
811 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
814 static void update_description(struct userdata
*u
) {
825 if (pa_idxset_isempty(u
->outputs
)) {
826 pa_sink_set_description(u
->sink
, "Simultaneous output");
830 t
= pa_xstrdup("Simultaneous output to");
832 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
) {
836 e
= pa_sprintf_malloc("%s %s", t
, pa_strnull(pa_proplist_gets(o
->sink
->proplist
, PA_PROP_DEVICE_DESCRIPTION
)));
839 e
= pa_sprintf_malloc("%s, %s", t
, pa_strnull(pa_proplist_gets(o
->sink
->proplist
, PA_PROP_DEVICE_DESCRIPTION
)));
845 pa_sink_set_description(u
->sink
, t
);
849 static int output_create_sink_input(struct output
*o
) {
850 pa_sink_input_new_data data
;
857 pa_sink_input_new_data_init(&data
);
858 pa_sink_input_new_data_set_sink(&data
, o
->sink
, false);
859 data
.driver
= __FILE__
;
860 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
)));
861 pa_proplist_sets(data
.proplist
, PA_PROP_MEDIA_ROLE
, "filter");
862 pa_sink_input_new_data_set_sample_spec(&data
, &o
->userdata
->sink
->sample_spec
);
863 pa_sink_input_new_data_set_channel_map(&data
, &o
->userdata
->sink
->channel_map
);
864 data
.module
= o
->userdata
->module
;
865 data
.resample_method
= o
->userdata
->resample_method
;
866 data
.flags
= PA_SINK_INPUT_VARIABLE_RATE
|PA_SINK_INPUT_DONT_MOVE
|PA_SINK_INPUT_NO_CREATE_ON_SUSPEND
;
868 pa_sink_input_new(&o
->sink_input
, o
->userdata
->core
, &data
);
870 pa_sink_input_new_data_done(&data
);
875 o
->sink_input
->parent
.process_msg
= sink_input_process_msg
;
876 o
->sink_input
->pop
= sink_input_pop_cb
;
877 o
->sink_input
->process_rewind
= sink_input_process_rewind_cb
;
878 o
->sink_input
->update_max_rewind
= sink_input_update_max_rewind_cb
;
879 o
->sink_input
->update_max_request
= sink_input_update_max_request_cb
;
880 o
->sink_input
->update_sink_requested_latency
= sink_input_update_sink_requested_latency_cb
;
881 o
->sink_input
->attach
= sink_input_attach_cb
;
882 o
->sink_input
->detach
= sink_input_detach_cb
;
883 o
->sink_input
->kill
= sink_input_kill_cb
;
884 o
->sink_input
->userdata
= o
;
886 pa_sink_input_set_requested_latency(o
->sink_input
, BLOCK_USEC
);
891 /* Called from main context */
892 static struct output
*output_new(struct userdata
*u
, pa_sink
*sink
) {
899 o
= pa_xnew0(struct output
, 1);
901 o
->inq
= pa_asyncmsgq_new(0);
902 o
->outq
= pa_asyncmsgq_new(0);
904 o
->memblockq
= pa_memblockq_new(
905 "module-combine-sink output memblockq",
909 &u
->sink
->sample_spec
,
915 pa_assert_se(pa_idxset_put(u
->outputs
, o
, NULL
) == 0);
916 update_description(u
);
921 /* Called from main context */
922 static void output_free(struct output
*o
) {
926 update_description(o
->userdata
);
928 if (o
->inq_rtpoll_item_read
)
929 pa_rtpoll_item_free(o
->inq_rtpoll_item_read
);
930 if (o
->inq_rtpoll_item_write
)
931 pa_rtpoll_item_free(o
->inq_rtpoll_item_write
);
933 if (o
->outq_rtpoll_item_read
)
934 pa_rtpoll_item_free(o
->outq_rtpoll_item_read
);
935 if (o
->outq_rtpoll_item_write
)
936 pa_rtpoll_item_free(o
->outq_rtpoll_item_write
);
939 pa_asyncmsgq_unref(o
->inq
);
942 pa_asyncmsgq_unref(o
->outq
);
945 pa_memblockq_free(o
->memblockq
);
950 /* Called from main context */
951 static void output_enable(struct output
*o
) {
957 /* This might cause the sink to be resumed. The state change hook
958 * of the sink might hence be called from here, which might then
959 * cause us to be called in a loop. Make sure that state changes
960 * for this output don't cause this loop by setting a flag here */
961 o
->ignore_state_change
= true;
963 if (output_create_sink_input(o
) >= 0) {
965 if (pa_sink_get_state(o
->sink
) != PA_SINK_INIT
) {
967 /* First we register the output. That means that the sink
968 * will start to pass data to this output. */
969 pa_asyncmsgq_send(o
->userdata
->sink
->asyncmsgq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_ADD_OUTPUT
, o
, 0, NULL
);
971 /* Then we enable the sink input. That means that the sink
972 * is now asked for new data. */
973 pa_sink_input_put(o
->sink_input
);
976 /* Hmm the sink is not yet started, do things right here */
977 output_add_within_thread(o
);
980 o
->ignore_state_change
= false;
983 /* Called from main context */
984 static void output_disable(struct output
*o
) {
990 /* First we disable the sink input. That means that the sink is
991 * not asked for new data anymore */
992 pa_sink_input_unlink(o
->sink_input
);
994 /* Then we unregister the output. That means that the sink doesn't
995 * pass any further data to this output */
996 pa_asyncmsgq_send(o
->userdata
->sink
->asyncmsgq
, PA_MSGOBJECT(o
->userdata
->sink
), SINK_MESSAGE_REMOVE_OUTPUT
, o
, 0, NULL
);
998 /* Now deallocate the stream */
999 pa_sink_input_unref(o
->sink_input
);
1000 o
->sink_input
= NULL
;
1002 /* Finally, drop all queued data */
1003 pa_memblockq_flush_write(o
->memblockq
, true);
1004 pa_asyncmsgq_flush(o
->inq
, false);
1005 pa_asyncmsgq_flush(o
->outq
, false);
1008 /* Called from main context */
1009 static void output_verify(struct output
*o
) {
1012 if (PA_SINK_IS_OPENED(pa_sink_get_state(o
->userdata
->sink
)))
1018 /* Called from main context */
1019 static bool is_suitable_sink(struct userdata
*u
, pa_sink
*s
) {
1022 pa_sink_assert_ref(s
);
1027 if (!(s
->flags
& PA_SINK_HARDWARE
))
1030 if (!(s
->flags
& PA_SINK_LATENCY
))
1033 if ((t
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_CLASS
)))
1034 if (!pa_streq(t
, "sound"))
1040 /* Called from main context */
1041 static pa_hook_result_t
sink_put_hook_cb(pa_core
*c
, pa_sink
*s
, struct userdata
* u
) {
1044 pa_core_assert_ref(c
);
1045 pa_sink_assert_ref(s
);
1049 if (!is_suitable_sink(u
, s
))
1052 /* Check if the sink is a previously unlinked slave (non-automatic mode) */
1053 pa_strlist
*l
= u
->unlinked_slaves
;
1055 while (l
&& !pa_streq(pa_strlist_data(l
), s
->name
))
1056 l
= pa_strlist_next(l
);
1061 u
->unlinked_slaves
= pa_strlist_remove(u
->unlinked_slaves
, s
->name
);
1064 pa_log_info("Configuring new sink: %s", s
->name
);
1065 if (!(o
= output_new(u
, s
))) {
1066 pa_log("Failed to create sink input on sink '%s'.", s
->name
);
1075 /* Called from main context */
1076 static struct output
* find_output(struct userdata
*u
, pa_sink
*s
) {
1086 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
)
1093 /* Called from main context */
1094 static pa_hook_result_t
sink_unlink_hook_cb(pa_core
*c
, pa_sink
*s
, struct userdata
* u
) {
1098 pa_sink_assert_ref(s
);
1101 if (!(o
= find_output(u
, s
)))
1104 pa_log_info("Unconfiguring sink: %s", s
->name
);
1107 u
->unlinked_slaves
= pa_strlist_prepend(u
->unlinked_slaves
, s
->name
);
1109 pa_idxset_remove_by_data(u
->outputs
, o
, NULL
);
1115 /* Called from main context */
1116 static pa_hook_result_t
sink_state_changed_hook_cb(pa_core
*c
, pa_sink
*s
, struct userdata
* u
) {
1119 if (!(o
= find_output(u
, s
)))
1122 /* This state change might be triggered because we are creating a
1123 * stream here, in that case we don't want to create it a second
1124 * time here and enter a loop */
1125 if (o
->ignore_state_change
)
1133 int pa__init(pa_module
*m
) {
1135 pa_modargs
*ma
= NULL
;
1136 const char *slaves
, *rm
;
1137 int resample_method
= PA_RESAMPLER_TRIVIAL
;
1142 pa_sink_new_data data
;
1143 uint32_t adjust_time_sec
;
1147 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
1148 pa_log("failed to parse module arguments");
1152 if ((rm
= pa_modargs_get_value(ma
, "resample_method", NULL
))) {
1153 if ((resample_method
= pa_parse_resample_method(rm
)) < 0) {
1154 pa_log("invalid resample method '%s'", rm
);
1159 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
1162 u
->rtpoll
= pa_rtpoll_new();
1163 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
1164 u
->resample_method
= resample_method
;
1165 u
->outputs
= pa_idxset_new(NULL
, NULL
);
1166 u
->thread_info
.smoother
= pa_smoother_new(
1175 adjust_time_sec
= DEFAULT_ADJUST_TIME_USEC
/ PA_USEC_PER_SEC
;
1176 if (pa_modargs_get_value_u32(ma
, "adjust_time", &adjust_time_sec
) < 0) {
1177 pa_log("Failed to parse adjust_time value");
1181 if (adjust_time_sec
!= DEFAULT_ADJUST_TIME_USEC
/ PA_USEC_PER_SEC
)
1182 u
->adjust_time
= adjust_time_sec
* PA_USEC_PER_SEC
;
1184 u
->adjust_time
= DEFAULT_ADJUST_TIME_USEC
;
1186 slaves
= pa_modargs_get_value(ma
, "slaves", NULL
);
1187 u
->automatic
= !slaves
;
1189 ss
= m
->core
->default_sample_spec
;
1190 map
= m
->core
->default_channel_map
;
1192 /* Check the specified slave sinks for sample_spec and channel_map to use for the combined sink */
1193 if (!u
->automatic
) {
1194 const char*split_state
= NULL
;
1196 pa_sample_spec slaves_spec
;
1197 pa_channel_map slaves_map
;
1198 bool is_first_slave
= true;
1200 pa_sample_spec_init(&slaves_spec
);
1202 while ((n
= pa_split(slaves
, ",", &split_state
))) {
1203 pa_sink
*slave_sink
;
1205 if (!(slave_sink
= pa_namereg_get(m
->core
, n
, PA_NAMEREG_SINK
))) {
1206 pa_log("Invalid slave sink '%s'", n
);
1213 if (is_first_slave
) {
1214 slaves_spec
= slave_sink
->sample_spec
;
1215 slaves_map
= slave_sink
->channel_map
;
1216 is_first_slave
= false;
1218 if (slaves_spec
.format
!= slave_sink
->sample_spec
.format
)
1219 slaves_spec
.format
= PA_SAMPLE_INVALID
;
1221 if (slaves_spec
.rate
< slave_sink
->sample_spec
.rate
)
1222 slaves_spec
.rate
= slave_sink
->sample_spec
.rate
;
1224 if (!pa_channel_map_equal(&slaves_map
, &slave_sink
->channel_map
))
1225 slaves_spec
.channels
= 0;
1229 if (!is_first_slave
) {
1230 if (slaves_spec
.format
!= PA_SAMPLE_INVALID
)
1231 ss
.format
= slaves_spec
.format
;
1233 ss
.rate
= slaves_spec
.rate
;
1235 if (slaves_spec
.channels
> 0) {
1237 ss
.channels
= slaves_map
.channels
;
1242 if ((pa_modargs_get_sample_spec_and_channel_map(ma
, &ss
, &map
, PA_CHANNEL_MAP_DEFAULT
) < 0)) {
1243 pa_log("Invalid sample specification.");
1247 pa_sink_new_data_init(&data
);
1248 data
.namereg_fail
= false;
1249 data
.driver
= __FILE__
;
1251 pa_sink_new_data_set_name(&data
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
));
1252 pa_sink_new_data_set_sample_spec(&data
, &ss
);
1253 pa_sink_new_data_set_channel_map(&data
, &map
);
1254 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_CLASS
, "filter");
1257 pa_proplist_sets(data
.proplist
, "combine.slaves", slaves
);
1259 if (pa_modargs_get_proplist(ma
, "sink_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
1260 pa_log("Invalid properties");
1261 pa_sink_new_data_done(&data
);
1265 /* Check proplist for a description & fill in a default value if not */
1266 u
->auto_desc
= false;
1267 if (NULL
== pa_proplist_gets(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
)) {
1268 u
->auto_desc
= true;
1269 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Simultaneous Output");
1272 u
->sink
= pa_sink_new(m
->core
, &data
, PA_SINK_LATENCY
);
1273 pa_sink_new_data_done(&data
);
1276 pa_log("Failed to create sink");
1280 u
->sink
->parent
.process_msg
= sink_process_msg
;
1281 u
->sink
->set_state
= sink_set_state
;
1282 u
->sink
->userdata
= u
;
1284 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
1285 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
1287 u
->block_usec
= BLOCK_USEC
;
1288 pa_sink_set_max_request(u
->sink
, pa_usec_to_bytes(u
->block_usec
, &u
->sink
->sample_spec
));
1290 if (!u
->automatic
) {
1291 const char*split_state
;
1295 /* The slaves have been specified manually */
1298 while ((n
= pa_split(slaves
, ",", &split_state
))) {
1299 pa_sink
*slave_sink
;
1301 if (!(slave_sink
= pa_namereg_get(m
->core
, n
, PA_NAMEREG_SINK
)) || slave_sink
== u
->sink
) {
1302 pa_log("Invalid slave sink '%s'", n
);
1309 if (!output_new(u
, slave_sink
)) {
1310 pa_log("Failed to create slave sink input on sink '%s'.", slave_sink
->name
);
1315 if (pa_idxset_size(u
->outputs
) <= 1)
1316 pa_log_warn("No slave sinks specified.");
1318 u
->sink_put_slot
= NULL
;
1323 /* We're in automatic mode, we add every sink that matches our needs */
1325 PA_IDXSET_FOREACH(s
, m
->core
->sinks
, idx
) {
1327 if (!is_suitable_sink(u
, s
))
1330 if (!output_new(u
, s
)) {
1331 pa_log("Failed to create sink input on sink '%s'.", s
->name
);
1337 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
);
1338 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
);
1339 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
);
1341 if (!(u
->thread
= pa_thread_new("combine", thread_func
, u
))) {
1342 pa_log("Failed to create thread.");
1346 /* Activate the sink and the sink inputs */
1347 pa_sink_put(u
->sink
);
1349 PA_IDXSET_FOREACH(o
, u
->outputs
, idx
)
1352 if (u
->adjust_time
> 0)
1353 u
->time_event
= pa_core_rttime_new(m
->core
, pa_rtclock_now() + u
->adjust_time
, time_callback
, u
);
1355 pa_modargs_free(ma
);
1362 pa_modargs_free(ma
);
1369 void pa__done(pa_module
*m
) {
1374 if (!(u
= m
->userdata
))
1377 pa_strlist_free(u
->unlinked_slaves
);
1379 if (u
->sink_put_slot
)
1380 pa_hook_slot_free(u
->sink_put_slot
);
1382 if (u
->sink_unlink_slot
)
1383 pa_hook_slot_free(u
->sink_unlink_slot
);
1385 if (u
->sink_state_changed_slot
)
1386 pa_hook_slot_free(u
->sink_state_changed_slot
);
1389 pa_idxset_free(u
->outputs
, (pa_free_cb_t
) output_free
);
1392 pa_sink_unlink(u
->sink
);
1395 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
1396 pa_thread_free(u
->thread
);
1399 pa_thread_mq_done(&u
->thread_mq
);
1402 pa_sink_unref(u
->sink
);
1405 pa_rtpoll_free(u
->rtpoll
);
1408 u
->core
->mainloop
->time_free(u
->time_event
);
1410 if (u
->thread_info
.smoother
)
1411 pa_smoother_free(u
->thread_info
.smoother
);