4 This file is part of PulseAudio.
6 Copyright 2004-2006 Lennart Poettering
7 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published
11 by the Free Software Foundation; either version 2 of the License,
12 or (at your option) any later version.
14 PulseAudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
33 #include <pulse/introspect.h>
34 #include <pulse/utf8.h>
35 #include <pulse/xmalloc.h>
36 #include <pulse/timeval.h>
38 #include <pulsecore/sink-input.h>
39 #include <pulsecore/namereg.h>
40 #include <pulsecore/core-util.h>
41 #include <pulsecore/sample-util.h>
42 #include <pulsecore/core-subscribe.h>
43 #include <pulsecore/log.h>
44 #include <pulsecore/macro.h>
45 #include <pulsecore/play-memblockq.h>
49 #define MAX_MIX_CHANNELS 32
50 #define MIX_BUFFER_LENGTH (PA_PAGE_SIZE)
51 #define DEFAULT_MIN_LATENCY (4*PA_USEC_PER_MSEC)
53 static PA_DEFINE_CHECK_TYPE(pa_sink
, pa_msgobject
);
55 static void sink_free(pa_object
*s
);
57 pa_sink_new_data
* pa_sink_new_data_init(pa_sink_new_data
*data
) {
60 memset(data
, 0, sizeof(*data
));
61 data
->proplist
= pa_proplist_new();
66 void pa_sink_new_data_set_name(pa_sink_new_data
*data
, const char *name
) {
70 data
->name
= pa_xstrdup(name
);
73 void pa_sink_new_data_set_sample_spec(pa_sink_new_data
*data
, const pa_sample_spec
*spec
) {
76 if ((data
->sample_spec_is_set
= !!spec
))
77 data
->sample_spec
= *spec
;
80 void pa_sink_new_data_set_channel_map(pa_sink_new_data
*data
, const pa_channel_map
*map
) {
83 if ((data
->channel_map_is_set
= !!map
))
84 data
->channel_map
= *map
;
87 void pa_sink_new_data_set_volume(pa_sink_new_data
*data
, const pa_cvolume
*volume
) {
90 if ((data
->volume_is_set
= !!volume
))
91 data
->volume
= *volume
;
94 void pa_sink_new_data_set_muted(pa_sink_new_data
*data
, pa_bool_t mute
) {
97 data
->muted_is_set
= TRUE
;
101 void pa_sink_new_data_done(pa_sink_new_data
*data
) {
104 pa_xfree(data
->name
);
105 pa_proplist_free(data
->proplist
);
108 static void reset_callbacks(pa_sink
*s
) {
112 s
->get_volume
= NULL
;
113 s
->set_volume
= NULL
;
116 s
->get_latency
= NULL
;
117 s
->request_rewind
= NULL
;
118 s
->update_requested_latency
= NULL
;
121 pa_sink
* pa_sink_new(
123 pa_sink_new_data
*data
,
124 pa_sink_flags_t flags
) {
128 char st
[PA_SAMPLE_SPEC_SNPRINT_MAX
], cm
[PA_CHANNEL_MAP_SNPRINT_MAX
];
129 pa_source_new_data source_data
;
134 pa_assert(data
->name
);
136 s
= pa_msgobject_new(pa_sink
);
138 if (!(name
= pa_namereg_register(core
, data
->name
, PA_NAMEREG_SINK
, s
, data
->namereg_fail
))) {
143 pa_sink_new_data_set_name(data
, name
);
145 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_NEW
], data
) < 0) {
147 pa_namereg_unregister(core
, name
);
151 pa_return_null_if_fail(!data
->driver
|| pa_utf8_valid(data
->driver
));
152 pa_return_null_if_fail(data
->name
&& pa_utf8_valid(data
->name
) && data
->name
[0]);
154 pa_return_null_if_fail(data
->sample_spec_is_set
&& pa_sample_spec_valid(&data
->sample_spec
));
156 if (!data
->channel_map_is_set
)
157 pa_return_null_if_fail(pa_channel_map_init_auto(&data
->channel_map
, data
->sample_spec
.channels
, PA_CHANNEL_MAP_DEFAULT
));
159 pa_return_null_if_fail(pa_channel_map_valid(&data
->channel_map
));
160 pa_return_null_if_fail(data
->channel_map
.channels
== data
->sample_spec
.channels
);
162 if (!data
->volume_is_set
)
163 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
165 pa_return_null_if_fail(pa_cvolume_valid(&data
->volume
));
166 pa_return_null_if_fail(data
->volume
.channels
== data
->sample_spec
.channels
);
168 if (!data
->muted_is_set
)
171 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_FIXATE
], data
) < 0) {
173 pa_namereg_unregister(core
, name
);
177 s
->parent
.parent
.free
= sink_free
;
178 s
->parent
.process_msg
= pa_sink_process_msg
;
181 s
->state
= PA_SINK_INIT
;
183 s
->name
= pa_xstrdup(name
);
184 s
->proplist
= pa_proplist_copy(data
->proplist
);
185 s
->driver
= pa_xstrdup(data
->driver
);
186 s
->module
= data
->module
;
188 s
->sample_spec
= data
->sample_spec
;
189 s
->channel_map
= data
->channel_map
;
191 s
->inputs
= pa_idxset_new(NULL
, NULL
);
194 s
->volume
= data
->volume
;
195 s
->muted
= data
->muted
;
196 s
->refresh_volume
= s
->refresh_mute
= FALSE
;
204 pa_silence_memchunk_get(
205 &core
->silence_cache
,
211 s
->min_latency
= DEFAULT_MIN_LATENCY
;
212 s
->max_latency
= s
->min_latency
;
214 s
->thread_info
.inputs
= pa_hashmap_new(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
);
215 s
->thread_info
.soft_volume
= s
->volume
;
216 s
->thread_info
.soft_muted
= s
->muted
;
217 s
->thread_info
.state
= s
->state
;
218 s
->thread_info
.rewind_nbytes
= 0;
219 s
->thread_info
.max_rewind
= 0;
220 s
->thread_info
.requested_latency_valid
= FALSE
;
221 s
->thread_info
.requested_latency
= 0;
223 pa_assert_se(pa_idxset_put(core
->sinks
, s
, &s
->index
) >= 0);
225 pa_log_info("Created sink %u \"%s\" with sample spec %s and channel map %s",
228 pa_sample_spec_snprint(st
, sizeof(st
), &s
->sample_spec
),
229 pa_channel_map_snprint(cm
, sizeof(cm
), &s
->channel_map
));
231 pa_source_new_data_init(&source_data
);
232 pa_source_new_data_set_sample_spec(&source_data
, &s
->sample_spec
);
233 pa_source_new_data_set_channel_map(&source_data
, &s
->channel_map
);
234 source_data
.name
= pa_sprintf_malloc("%s.monitor", name
);
235 source_data
.driver
= data
->driver
;
236 source_data
.module
= data
->module
;
238 dn
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
239 pa_proplist_setf(source_data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Monitor of %s", dn
? dn
: s
->name
);
240 pa_proplist_sets(source_data
.proplist
, PA_PROP_DEVICE_CLASS
, "monitor");
242 s
->monitor_source
= pa_source_new(core
, &source_data
, 0);
244 pa_source_new_data_done(&source_data
);
246 if (!s
->monitor_source
) {
252 s
->monitor_source
->monitor_of
= s
;
253 pa_source_set_max_rewind(s
->monitor_source
, s
->thread_info
.max_rewind
);
258 static int sink_set_state(pa_sink
*s
, pa_sink_state_t state
) {
260 pa_bool_t suspend_change
;
264 if (s
->state
== state
)
268 (s
->state
== PA_SINK_SUSPENDED
&& PA_SINK_OPENED(state
)) ||
269 (PA_SINK_OPENED(s
->state
) && state
== PA_SINK_SUSPENDED
);
272 if ((ret
= s
->set_state(s
, state
)) < 0)
275 if (pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_STATE
, PA_UINT_TO_PTR(state
), 0, NULL
) < 0)
280 if (suspend_change
) {
284 /* We're suspending or resuming, tell everyone about it */
286 for (i
= PA_SINK_INPUT(pa_idxset_first(s
->inputs
, &idx
)); i
; i
= PA_SINK_INPUT(pa_idxset_next(s
->inputs
, &idx
)))
288 i
->suspend(i
, state
== PA_SINK_SUSPENDED
);
291 if (state
!= PA_SINK_UNLINKED
) /* if we enter UNLINKED state pa_sink_unlink() will fire the apropriate events */
292 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_STATE_CHANGED
], s
);
297 void pa_sink_put(pa_sink
* s
) {
298 pa_sink_assert_ref(s
);
300 pa_assert(s
->state
== PA_SINK_INIT
);
301 pa_assert(s
->asyncmsgq
);
302 pa_assert(s
->rtpoll
);
304 pa_assert(!s
->min_latency
|| !s
->max_latency
|| s
->min_latency
<= s
->max_latency
);
306 if (!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
))
307 s
->flags
|= PA_SINK_DECIBEL_VOLUME
;
309 pa_assert_se(sink_set_state(s
, PA_SINK_IDLE
) == 0);
311 pa_source_put(s
->monitor_source
);
313 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_NEW
, s
->index
);
314 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PUT
], s
);
317 void pa_sink_unlink(pa_sink
* s
) {
319 pa_sink_input
*i
, *j
= NULL
;
323 /* Please note that pa_sink_unlink() does more than simply
324 * reversing pa_sink_put(). It also undoes the registrations
325 * already done in pa_sink_new()! */
327 /* All operations here shall be idempotent, i.e. pa_sink_unlink()
328 * may be called multiple times on the same sink without bad
331 linked
= PA_SINK_LINKED(s
->state
);
334 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK
], s
);
336 if (s
->state
!= PA_SINK_UNLINKED
)
337 pa_namereg_unregister(s
->core
, s
->name
);
338 pa_idxset_remove_by_data(s
->core
->sinks
, s
, NULL
);
340 while ((i
= pa_idxset_first(s
->inputs
, NULL
))) {
342 pa_sink_input_kill(i
);
347 sink_set_state(s
, PA_SINK_UNLINKED
);
349 s
->state
= PA_SINK_UNLINKED
;
353 if (s
->monitor_source
)
354 pa_source_unlink(s
->monitor_source
);
357 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_REMOVE
, s
->index
);
358 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK_POST
], s
);
362 static void sink_free(pa_object
*o
) {
363 pa_sink
*s
= PA_SINK(o
);
367 pa_assert(pa_sink_refcnt(s
) == 0);
369 if (PA_SINK_LINKED(s
->state
))
372 pa_log_info("Freeing sink %u \"%s\"", s
->index
, s
->name
);
374 if (s
->monitor_source
) {
375 pa_source_unref(s
->monitor_source
);
376 s
->monitor_source
= NULL
;
379 pa_idxset_free(s
->inputs
, NULL
, NULL
);
381 while ((i
= pa_hashmap_steal_first(s
->thread_info
.inputs
)))
382 pa_sink_input_unref(i
);
384 pa_hashmap_free(s
->thread_info
.inputs
, NULL
, NULL
);
386 if (s
->silence
.memblock
)
387 pa_memblock_unref(s
->silence
.memblock
);
393 pa_proplist_free(s
->proplist
);
398 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
) {
399 pa_sink_assert_ref(s
);
404 if (s
->monitor_source
)
405 pa_source_set_asyncmsgq(s
->monitor_source
, q
);
408 void pa_sink_set_rtpoll(pa_sink
*s
, pa_rtpoll
*p
) {
409 pa_sink_assert_ref(s
);
413 if (s
->monitor_source
)
414 pa_source_set_rtpoll(s
->monitor_source
, p
);
417 int pa_sink_update_status(pa_sink
*s
) {
418 pa_sink_assert_ref(s
);
419 pa_assert(PA_SINK_LINKED(s
->state
));
421 if (s
->state
== PA_SINK_SUSPENDED
)
424 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
427 int pa_sink_suspend(pa_sink
*s
, pa_bool_t suspend
) {
428 pa_sink_assert_ref(s
);
429 pa_assert(PA_SINK_LINKED(s
->state
));
432 return sink_set_state(s
, PA_SINK_SUSPENDED
);
434 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
437 void pa_sink_process_rewind(pa_sink
*s
, size_t nbytes
) {
440 pa_sink_assert_ref(s
);
441 pa_assert(PA_SINK_LINKED(s
->state
));
446 pa_log_debug("Processing rewind...");
448 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
))) {
449 pa_sink_input_assert_ref(i
);
450 pa_sink_input_process_rewind(i
, nbytes
);
453 if (s
->monitor_source
&& PA_SOURCE_OPENED(pa_source_get_state(s
->monitor_source
)))
454 pa_source_process_rewind(s
->monitor_source
, nbytes
);
457 static unsigned fill_mix_info(pa_sink
*s
, size_t *length
, pa_mix_info
*info
, unsigned maxinfo
) {
461 size_t mixlength
= *length
;
463 pa_sink_assert_ref(s
);
466 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)) && maxinfo
> 0) {
467 pa_sink_input_assert_ref(i
);
469 if (pa_sink_input_peek(i
, *length
, &info
->chunk
, &info
->volume
) < 0)
472 if (mixlength
== 0 || info
->chunk
.length
< mixlength
)
473 mixlength
= info
->chunk
.length
;
475 if (pa_memblock_is_silence(info
->chunk
.memblock
)) {
476 pa_memblock_unref(info
->chunk
.memblock
);
480 info
->userdata
= pa_sink_input_ref(i
);
482 pa_assert(info
->chunk
.memblock
);
483 pa_assert(info
->chunk
.length
> 0);
496 static void inputs_drop(pa_sink
*s
, pa_mix_info
*info
, unsigned n
, size_t length
) {
500 unsigned n_unreffed
= 0;
502 pa_sink_assert_ref(s
);
504 /* We optimize for the case where the order of the inputs has not changed */
506 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
))) {
510 pa_sink_input_assert_ref(i
);
514 /* Let's try to find the matching entry info the pa_mix_info array */
515 for (j
= 0; j
< n
; j
++) {
517 if (info
[p
].userdata
== i
) {
528 pa_sink_input_drop(i
, length
);
531 pa_sink_input_unref(m
->userdata
);
533 if (m
->chunk
.memblock
)
534 pa_memblock_unref(m
->chunk
.memblock
);
535 pa_memchunk_reset(&m
->chunk
);
541 /* Now drop references to entries that are included in the
542 * pa_mix_info array but don't exist anymore */
544 if (n_unreffed
< n
) {
545 for (; n
> 0; info
++, n
--) {
547 pa_sink_input_unref(info
->userdata
);
548 if (info
->chunk
.memblock
)
549 pa_memblock_unref(info
->chunk
.memblock
);
554 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
555 pa_mix_info info
[MAX_MIX_CHANNELS
];
557 size_t block_size_max
;
559 pa_sink_assert_ref(s
);
560 pa_assert(PA_SINK_OPENED(s
->thread_info
.state
));
561 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
566 s
->thread_info
.rewind_nbytes
= 0;
569 length
= pa_frame_align(MIX_BUFFER_LENGTH
, &s
->sample_spec
);
571 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
572 if (length
> block_size_max
)
573 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
575 pa_assert(length
> 0);
577 n
= s
->thread_info
.state
== PA_SINK_RUNNING
? fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
) : 0;
581 *result
= s
->silence
;
582 pa_memblock_ref(result
->memblock
);
584 if (result
->length
> length
)
585 result
->length
= length
;
590 *result
= info
[0].chunk
;
591 pa_memblock_ref(result
->memblock
);
593 if (result
->length
> length
)
594 result
->length
= length
;
596 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
598 if (s
->thread_info
.soft_muted
|| !pa_cvolume_is_norm(&volume
)) {
599 pa_log("adjusting volume ");
600 pa_memchunk_make_writable(result
, 0);
601 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
))
602 pa_silence_memchunk(result
, &s
->sample_spec
);
604 pa_volume_memchunk(result
, &s
->sample_spec
, &volume
);
608 result
->memblock
= pa_memblock_new(s
->core
->mempool
, length
);
610 ptr
= pa_memblock_acquire(result
->memblock
);
611 result
->length
= pa_mix(info
, n
,
614 &s
->thread_info
.soft_volume
,
615 s
->thread_info
.soft_muted
);
616 pa_memblock_release(result
->memblock
);
621 if (s
->thread_info
.state
== PA_SINK_RUNNING
)
622 inputs_drop(s
, info
, n
, result
->length
);
624 if (s
->monitor_source
&& PA_SOURCE_OPENED(pa_source_get_state(s
->monitor_source
)))
625 pa_source_post(s
->monitor_source
, result
);
630 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
) {
631 pa_mix_info info
[MAX_MIX_CHANNELS
];
633 size_t length
, block_size_max
;
635 pa_sink_assert_ref(s
);
636 pa_assert(PA_SINK_OPENED(s
->thread_info
.state
));
638 pa_assert(target
->memblock
);
639 pa_assert(target
->length
> 0);
640 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
644 s
->thread_info
.rewind_nbytes
= 0;
646 length
= target
->length
;
647 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
648 if (length
> block_size_max
)
649 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
651 n
= s
->thread_info
.state
== PA_SINK_RUNNING
? fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
) : 0;
654 if (target
->length
> length
)
655 target
->length
= length
;
657 pa_silence_memchunk(target
, &s
->sample_spec
);
661 if (target
->length
> length
)
662 target
->length
= length
;
664 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
666 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
))
667 pa_silence_memchunk(target
, &s
->sample_spec
);
671 vchunk
= info
[0].chunk
;
672 pa_memblock_ref(vchunk
.memblock
);
674 if (vchunk
.length
> target
->length
)
675 vchunk
.length
= target
->length
;
677 if (!pa_cvolume_is_norm(&volume
)) {
678 pa_memchunk_make_writable(&vchunk
, 0);
679 pa_volume_memchunk(&vchunk
, &s
->sample_spec
, &volume
);
682 pa_memchunk_memcpy(target
, &vchunk
);
683 pa_memblock_unref(vchunk
.memblock
);
689 ptr
= pa_memblock_acquire(target
->memblock
);
691 target
->length
= pa_mix(info
, n
,
692 (uint8_t*) ptr
+ target
->index
, length
,
694 &s
->thread_info
.soft_volume
,
695 s
->thread_info
.soft_muted
);
697 pa_memblock_release(target
->memblock
);
700 if (s
->thread_info
.state
== PA_SINK_RUNNING
)
701 inputs_drop(s
, info
, n
, target
->length
);
703 if (s
->monitor_source
&& PA_SOURCE_OPENED(pa_source_get_state(s
->monitor_source
)))
704 pa_source_post(s
->monitor_source
, target
);
709 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
) {
713 pa_sink_assert_ref(s
);
714 pa_assert(PA_SINK_OPENED(s
->thread_info
.state
));
716 pa_assert(target
->memblock
);
717 pa_assert(target
->length
> 0);
718 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
722 s
->thread_info
.rewind_nbytes
= 0;
731 pa_sink_render_into(s
, &chunk
);
740 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
741 pa_sink_assert_ref(s
);
742 pa_assert(PA_SINK_OPENED(s
->thread_info
.state
));
743 pa_assert(length
> 0);
744 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
747 s
->thread_info
.rewind_nbytes
= 0;
749 /*** This needs optimization ***/
752 result
->length
= length
;
753 result
->memblock
= pa_memblock_new(s
->core
->mempool
, length
);
755 pa_sink_render_into_full(s
, result
);
758 void pa_sink_skip(pa_sink
*s
, size_t length
) {
762 pa_sink_assert_ref(s
);
763 pa_assert(PA_SINK_OPENED(s
->thread_info
.state
));
764 pa_assert(length
> 0);
765 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
767 s
->thread_info
.rewind_nbytes
= 0;
769 if (pa_source_used_by(s
->monitor_source
)) {
772 /* If something is connected to our monitor source, we have to
773 * pass valid data to it */
776 pa_sink_render(s
, length
, &chunk
);
777 pa_memblock_unref(chunk
.memblock
);
779 pa_assert(chunk
.length
<= length
);
780 length
-= chunk
.length
;
784 /* Ok, noone cares about the rendered data, so let's not even render it */
786 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
))) {
787 pa_sink_input_assert_ref(i
);
788 pa_sink_input_drop(i
, length
);
793 pa_usec_t
pa_sink_get_latency(pa_sink
*s
) {
796 pa_sink_assert_ref(s
);
797 pa_assert(PA_SINK_LINKED(s
->state
));
799 /* The returned value is supposed to be in the time domain of the sound card! */
801 if (!PA_SINK_OPENED(s
->state
))
805 return s
->get_latency(s
);
807 if (pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) < 0)
813 void pa_sink_set_volume(pa_sink
*s
, const pa_cvolume
*volume
) {
816 pa_sink_assert_ref(s
);
817 pa_assert(PA_SINK_LINKED(s
->state
));
820 changed
= !pa_cvolume_equal(volume
, &s
->volume
);
823 if (s
->set_volume
&& s
->set_volume(s
) < 0)
824 s
->set_volume
= NULL
;
827 pa_asyncmsgq_post(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME
, pa_xnewdup(struct pa_cvolume
, volume
, 1), 0, NULL
, pa_xfree
);
830 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
833 const pa_cvolume
*pa_sink_get_volume(pa_sink
*s
) {
834 struct pa_cvolume old_volume
;
836 pa_sink_assert_ref(s
);
837 pa_assert(PA_SINK_LINKED(s
->state
));
839 old_volume
= s
->volume
;
841 if (s
->get_volume
&& s
->get_volume(s
) < 0)
842 s
->get_volume
= NULL
;
844 if (!s
->get_volume
&& s
->refresh_volume
)
845 pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_VOLUME
, &s
->volume
, 0, NULL
);
847 if (!pa_cvolume_equal(&old_volume
, &s
->volume
))
848 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
853 void pa_sink_set_mute(pa_sink
*s
, pa_bool_t mute
) {
856 pa_sink_assert_ref(s
);
857 pa_assert(PA_SINK_LINKED(s
->state
));
859 changed
= s
->muted
!= mute
;
862 if (s
->set_mute
&& s
->set_mute(s
) < 0)
866 pa_asyncmsgq_post(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, PA_UINT_TO_PTR(mute
), 0, NULL
, NULL
);
869 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
872 pa_bool_t
pa_sink_get_mute(pa_sink
*s
) {
875 pa_sink_assert_ref(s
);
876 pa_assert(PA_SINK_LINKED(s
->state
));
878 old_muted
= s
->muted
;
880 if (s
->get_mute
&& s
->get_mute(s
) < 0)
883 if (!s
->get_mute
&& s
->refresh_mute
)
884 pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MUTE
, &s
->muted
, 0, NULL
);
886 if (old_muted
!= s
->muted
)
887 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
892 void pa_sink_set_description(pa_sink
*s
, const char *description
) {
894 pa_sink_assert_ref(s
);
896 if (!description
&& !pa_proplist_contains(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
))
899 old
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
901 if (old
&& description
&& !strcmp(old
, description
))
905 pa_proplist_sets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
, description
);
907 pa_proplist_unset(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
909 if (s
->monitor_source
) {
912 n
= pa_sprintf_malloc("Monitor Source of %s", description
? description
: s
->name
);
913 pa_source_set_description(s
->monitor_source
, n
);
917 if (PA_SINK_LINKED(s
->state
)) {
918 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
919 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
923 unsigned pa_sink_linked_by(pa_sink
*s
) {
926 pa_sink_assert_ref(s
);
927 pa_assert(PA_SINK_LINKED(s
->state
));
929 ret
= pa_idxset_size(s
->inputs
);
931 /* We add in the number of streams connected to us here. Please
932 * not the asymmmetry to pa_sink_used_by()! */
934 if (s
->monitor_source
)
935 ret
+= pa_source_linked_by(s
->monitor_source
);
940 unsigned pa_sink_used_by(pa_sink
*s
) {
943 pa_sink_assert_ref(s
);
944 pa_assert(PA_SINK_LINKED(s
->state
));
946 ret
= pa_idxset_size(s
->inputs
);
947 pa_assert(ret
>= s
->n_corked
);
949 /* Streams connected to our monitor source do not matter for
950 * pa_sink_used_by()!.*/
952 return ret
- s
->n_corked
;
955 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
956 pa_sink
*s
= PA_SINK(o
);
957 pa_sink_assert_ref(s
);
958 pa_assert(s
->thread_info
.state
!= PA_SINK_UNLINKED
);
960 switch ((pa_sink_message_t
) code
) {
962 case PA_SINK_MESSAGE_ADD_INPUT
: {
963 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
965 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
967 /* Since the caller sleeps in pa_sink_input_put(), we can
968 * safely access data outside of thread_info even though
971 if ((i
->thread_info
.sync_prev
= i
->sync_prev
)) {
972 pa_assert(i
->sink
== i
->thread_info
.sync_prev
->sink
);
973 pa_assert(i
->sync_prev
->sync_next
== i
);
974 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
;
977 if ((i
->thread_info
.sync_next
= i
->sync_next
)) {
978 pa_assert(i
->sink
== i
->thread_info
.sync_next
->sink
);
979 pa_assert(i
->sync_next
->sync_prev
== i
);
980 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
;
983 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
985 pa_assert(!i
->thread_info
.attached
);
986 i
->thread_info
.attached
= TRUE
;
991 /* If you change anything here, make sure to change the
992 * ghost sink input handling a few lines down at
993 * PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER, too. */
995 pa_sink_invalidate_requested_latency(s
);
997 /* Make sure we're not rewound when the hw buffer is remixed and request a remix*/
998 i
->thread_info
.ignore_rewind
= TRUE
;
999 i
->thread_info
.since_underrun
= 0;
1000 pa_sink_request_rewind(s
, 0);
1005 case PA_SINK_MESSAGE_REMOVE_INPUT
: {
1006 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
1008 /* If you change anything here, make sure to change the
1009 * sink input handling a few lines down at
1010 * PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER, too. */
1015 pa_assert(i
->thread_info
.attached
);
1016 i
->thread_info
.attached
= FALSE
;
1018 /* Since the caller sleeps in pa_sink_input_unlink(),
1019 * we can safely access data outside of thread_info even
1020 * though it is mutable */
1022 pa_assert(!i
->thread_info
.sync_prev
);
1023 pa_assert(!i
->thread_info
.sync_next
);
1025 if (i
->thread_info
.sync_prev
) {
1026 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
->thread_info
.sync_prev
->sync_next
;
1027 i
->thread_info
.sync_prev
= NULL
;
1030 if (i
->thread_info
.sync_next
) {
1031 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
->thread_info
.sync_next
->sync_prev
;
1032 i
->thread_info
.sync_next
= NULL
;
1035 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
1036 pa_sink_input_unref(i
);
1038 pa_sink_invalidate_requested_latency(s
);
1040 pa_sink_request_rewind(s
, 0);
1045 case PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER
: {
1046 pa_sink_input_move_info
*info
= userdata
;
1049 /* We don't support moving synchronized streams. */
1050 pa_assert(!info
->sink_input
->sync_prev
);
1051 pa_assert(!info
->sink_input
->sync_next
);
1052 pa_assert(!info
->sink_input
->thread_info
.sync_next
);
1053 pa_assert(!info
->sink_input
->thread_info
.sync_prev
);
1055 if (info
->sink_input
->detach
)
1056 info
->sink_input
->detach(info
->sink_input
);
1058 pa_assert(info
->sink_input
->thread_info
.attached
);
1059 info
->sink_input
->thread_info
.attached
= FALSE
;
1060 pa_sink_invalidate_requested_latency(info
->sink_input
->sink
);
1062 if (info
->ghost_sink_input
) {
1063 pa_assert(info
->buffer_bytes
> 0);
1064 pa_assert(info
->buffer
);
1066 volume_is_norm
= pa_cvolume_is_norm(&info
->sink_input
->thread_info
.volume
);
1068 pa_log_debug("Buffering %lu bytes ...", (unsigned long) info
->buffer_bytes
);
1070 while (info
->buffer_bytes
> 0) {
1071 pa_memchunk memchunk
;
1075 if (pa_sink_input_peek(info
->sink_input
, info
->buffer_bytes
, &memchunk
, &volume
) < 0)
1078 n
= memchunk
.length
> info
->buffer_bytes
? info
->buffer_bytes
: memchunk
.length
;
1079 pa_sink_input_drop(info
->sink_input
, n
);
1080 memchunk
.length
= n
;
1082 if (!volume_is_norm
) {
1083 pa_memchunk_make_writable(&memchunk
, 0);
1084 pa_volume_memchunk(&memchunk
, &s
->sample_spec
, &volume
);
1087 if (pa_memblockq_push(info
->buffer
, &memchunk
) < 0) {
1088 pa_memblock_unref(memchunk
.memblock
);
1092 pa_memblock_unref(memchunk
.memblock
);
1093 info
->buffer_bytes
-= n
;
1096 /* Add the remaining already resampled chunks to the buffer */
1097 pa_memblockq_splice(info
->buffer
, info
->sink_input
->thread_info
.render_memblockq
);
1099 pa_memblockq_sink_input_set_queue(info
->ghost_sink_input
, info
->buffer
);
1101 pa_log_debug("Buffered %lu bytes ...", (unsigned long) pa_memblockq_get_length(info
->buffer
));
1104 /* Let's remove the sink input ...*/
1105 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(info
->sink_input
->index
)))
1106 pa_sink_input_unref(info
->sink_input
);
1108 /* .. and add the ghost sink input instead */
1109 if (info
->ghost_sink_input
) {
1110 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(info
->ghost_sink_input
->index
), pa_sink_input_ref(info
->ghost_sink_input
));
1111 info
->ghost_sink_input
->thread_info
.sync_prev
= info
->ghost_sink_input
->thread_info
.sync_next
= NULL
;
1113 pa_sink_input_update_max_rewind(info
->ghost_sink_input
, s
->thread_info
.max_rewind
);
1115 pa_assert(!info
->ghost_sink_input
->thread_info
.attached
);
1116 info
->ghost_sink_input
->thread_info
.attached
= TRUE
;
1118 if (info
->ghost_sink_input
->attach
)
1119 info
->ghost_sink_input
->attach(info
->ghost_sink_input
);
1123 pa_sink_invalidate_requested_latency(s
);
1125 pa_sink_request_rewind(s
, 0);
1130 case PA_SINK_MESSAGE_SET_VOLUME
:
1131 s
->thread_info
.soft_volume
= *((pa_cvolume
*) userdata
);
1133 pa_sink_request_rewind(s
, 0);
1136 case PA_SINK_MESSAGE_SET_MUTE
:
1137 s
->thread_info
.soft_muted
= PA_PTR_TO_UINT(userdata
);
1139 pa_sink_request_rewind(s
, 0);
1142 case PA_SINK_MESSAGE_GET_VOLUME
:
1143 *((pa_cvolume
*) userdata
) = s
->thread_info
.soft_volume
;
1146 case PA_SINK_MESSAGE_GET_MUTE
:
1147 *((pa_bool_t
*) userdata
) = s
->thread_info
.soft_muted
;
1150 case PA_SINK_MESSAGE_SET_STATE
:
1152 s
->thread_info
.state
= PA_PTR_TO_UINT(userdata
);
1155 case PA_SINK_MESSAGE_DETACH
:
1157 /* We're detaching all our input streams so that the
1158 * asyncmsgq and rtpoll fields can be changed without
1160 pa_sink_detach_within_thread(s
);
1163 case PA_SINK_MESSAGE_ATTACH
:
1165 /* Reattach all streams */
1166 pa_sink_attach_within_thread(s
);
1169 case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
: {
1171 pa_usec_t
*usec
= userdata
;
1172 *usec
= pa_sink_get_requested_latency_within_thread(s
);
1176 case PA_SINK_MESSAGE_GET_LATENCY
:
1177 case PA_SINK_MESSAGE_MAX
:
1184 int pa_sink_suspend_all(pa_core
*c
, pa_bool_t suspend
) {
1189 pa_core_assert_ref(c
);
1191 for (sink
= PA_SINK(pa_idxset_first(c
->sinks
, &idx
)); sink
; sink
= PA_SINK(pa_idxset_next(c
->sinks
, &idx
)))
1192 ret
-= pa_sink_suspend(sink
, suspend
) < 0;
1197 void pa_sink_detach(pa_sink
*s
) {
1198 pa_sink_assert_ref(s
);
1199 pa_assert(PA_SINK_LINKED(s
->state
));
1201 pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_DETACH
, NULL
, 0, NULL
);
1204 void pa_sink_attach(pa_sink
*s
) {
1205 pa_sink_assert_ref(s
);
1206 pa_assert(PA_SINK_LINKED(s
->state
));
1208 pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_ATTACH
, NULL
, 0, NULL
);
1211 void pa_sink_detach_within_thread(pa_sink
*s
) {
1215 pa_sink_assert_ref(s
);
1216 pa_assert(PA_SINK_LINKED(s
->thread_info
.state
));
1218 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
1222 if (s
->monitor_source
)
1223 pa_source_detach_within_thread(s
->monitor_source
);
1226 void pa_sink_attach_within_thread(pa_sink
*s
) {
1230 pa_sink_assert_ref(s
);
1231 pa_assert(PA_SINK_LINKED(s
->thread_info
.state
));
1233 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
1237 if (s
->monitor_source
)
1238 pa_source_attach_within_thread(s
->monitor_source
);
1241 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
) {
1242 pa_sink_assert_ref(s
);
1243 pa_assert(PA_SINK_LINKED(s
->thread_info
.state
));
1246 nbytes
= s
->thread_info
.max_rewind
;
1248 nbytes
= PA_MIN(nbytes
, s
->thread_info
.max_rewind
);
1250 if (nbytes
<= s
->thread_info
.rewind_nbytes
)
1253 s
->thread_info
.rewind_nbytes
= nbytes
;
1255 if (s
->request_rewind
)
1256 s
->request_rewind(s
);
1259 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
) {
1260 pa_usec_t result
= (pa_usec_t
) -1;
1264 pa_sink_assert_ref(s
);
1266 if (s
->thread_info
.requested_latency_valid
)
1267 return s
->thread_info
.requested_latency
;
1269 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
1271 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1 &&
1272 (result
== (pa_usec_t
) -1 || result
> i
->thread_info
.requested_sink_latency
))
1273 result
= i
->thread_info
.requested_sink_latency
;
1275 if (result
!= (pa_usec_t
) -1) {
1276 if (s
->max_latency
> 0 && result
> s
->max_latency
)
1277 result
= s
->max_latency
;
1279 if (s
->min_latency
> 0 && result
< s
->min_latency
)
1280 result
= s
->min_latency
;
1283 s
->thread_info
.requested_latency
= result
;
1284 s
->thread_info
.requested_latency_valid
= TRUE
;
1289 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
) {
1292 pa_sink_assert_ref(s
);
1293 pa_assert(PA_SINK_LINKED(s
->state
));
1295 if (!PA_SINK_OPENED(s
->state
))
1298 if (pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) < 0)
1301 if (usec
== (pa_usec_t
) -1)
1302 usec
= s
->max_latency
;
1307 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
) {
1311 pa_sink_assert_ref(s
);
1313 if (max_rewind
== s
->thread_info
.max_rewind
)
1316 s
->thread_info
.max_rewind
= max_rewind
;
1318 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
1319 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
1321 if (s
->monitor_source
)
1322 pa_source_set_max_rewind(s
->monitor_source
, s
->thread_info
.max_rewind
);
1325 void pa_sink_invalidate_requested_latency(pa_sink
*s
) {
1327 pa_sink_assert_ref(s
);
1328 pa_assert(PA_SINK_LINKED(s
->thread_info
.state
));
1330 if (!s
->thread_info
.requested_latency_valid
)
1333 s
->thread_info
.requested_latency_valid
= FALSE
;
1335 if (s
->update_requested_latency
)
1336 s
->update_requested_latency(s
);