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_IS_OPENED(state
)) ||
269 (PA_SINK_IS_OPENED(s
->state
) && state
== PA_SINK_SUSPENDED
);
272 if ((ret
= s
->set_state(s
, state
)) < 0)
276 if (pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_STATE
, PA_UINT_TO_PTR(state
), 0, NULL
) < 0)
281 if (suspend_change
) {
285 /* We're suspending or resuming, tell everyone about it */
287 for (i
= PA_SINK_INPUT(pa_idxset_first(s
->inputs
, &idx
)); i
; i
= PA_SINK_INPUT(pa_idxset_next(s
->inputs
, &idx
)))
289 i
->suspend(i
, state
== PA_SINK_SUSPENDED
);
292 if (state
!= PA_SINK_UNLINKED
) /* if we enter UNLINKED state pa_sink_unlink() will fire the apropriate events */
293 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_STATE_CHANGED
], s
);
298 void pa_sink_put(pa_sink
* s
) {
299 pa_sink_assert_ref(s
);
301 pa_assert(s
->state
== PA_SINK_INIT
);
302 pa_assert(s
->asyncmsgq
);
303 pa_assert(s
->rtpoll
);
305 pa_assert(!s
->min_latency
|| !s
->max_latency
|| s
->min_latency
<= s
->max_latency
);
307 if (!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
))
308 s
->flags
|= PA_SINK_DECIBEL_VOLUME
;
310 pa_assert_se(sink_set_state(s
, PA_SINK_IDLE
) == 0);
312 pa_source_put(s
->monitor_source
);
314 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_NEW
, s
->index
);
315 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PUT
], s
);
318 void pa_sink_unlink(pa_sink
* s
) {
320 pa_sink_input
*i
, *j
= NULL
;
324 /* Please note that pa_sink_unlink() does more than simply
325 * reversing pa_sink_put(). It also undoes the registrations
326 * already done in pa_sink_new()! */
328 /* All operations here shall be idempotent, i.e. pa_sink_unlink()
329 * may be called multiple times on the same sink without bad
332 linked
= PA_SINK_IS_LINKED(s
->state
);
335 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK
], s
);
337 if (s
->state
!= PA_SINK_UNLINKED
)
338 pa_namereg_unregister(s
->core
, s
->name
);
339 pa_idxset_remove_by_data(s
->core
->sinks
, s
, NULL
);
341 while ((i
= pa_idxset_first(s
->inputs
, NULL
))) {
343 pa_sink_input_kill(i
);
348 sink_set_state(s
, PA_SINK_UNLINKED
);
350 s
->state
= PA_SINK_UNLINKED
;
354 if (s
->monitor_source
)
355 pa_source_unlink(s
->monitor_source
);
358 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_REMOVE
, s
->index
);
359 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK_POST
], s
);
363 static void sink_free(pa_object
*o
) {
364 pa_sink
*s
= PA_SINK(o
);
368 pa_assert(pa_sink_refcnt(s
) == 0);
370 if (PA_SINK_IS_LINKED(s
->state
))
373 pa_log_info("Freeing sink %u \"%s\"", s
->index
, s
->name
);
375 if (s
->monitor_source
) {
376 pa_source_unref(s
->monitor_source
);
377 s
->monitor_source
= NULL
;
380 pa_idxset_free(s
->inputs
, NULL
, NULL
);
382 while ((i
= pa_hashmap_steal_first(s
->thread_info
.inputs
)))
383 pa_sink_input_unref(i
);
385 pa_hashmap_free(s
->thread_info
.inputs
, NULL
, NULL
);
387 if (s
->silence
.memblock
)
388 pa_memblock_unref(s
->silence
.memblock
);
394 pa_proplist_free(s
->proplist
);
399 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
) {
400 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
);
412 if (s
->monitor_source
)
413 pa_source_set_rtpoll(s
->monitor_source
, p
);
416 int pa_sink_update_status(pa_sink
*s
) {
417 pa_sink_assert_ref(s
);
418 pa_assert(PA_SINK_IS_LINKED(s
->state
));
420 if (s
->state
== PA_SINK_SUSPENDED
)
423 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
426 int pa_sink_suspend(pa_sink
*s
, pa_bool_t suspend
) {
427 pa_sink_assert_ref(s
);
428 pa_assert(PA_SINK_IS_LINKED(s
->state
));
431 return sink_set_state(s
, PA_SINK_SUSPENDED
);
433 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
436 void pa_sink_process_rewind(pa_sink
*s
, size_t nbytes
) {
439 pa_sink_assert_ref(s
);
440 pa_assert(PA_SINK_IS_LINKED(s
->state
));
442 /* Make sure the sink code already reset the counter! */
443 pa_assert(s
->thread_info
.rewind_nbytes
<= 0);
448 pa_log_debug("Processing rewind...");
450 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
))) {
451 pa_sink_input_assert_ref(i
);
452 pa_sink_input_process_rewind(i
, nbytes
);
455 if (s
->monitor_source
&& PA_SOURCE_IS_OPENED(pa_source_get_state(s
->monitor_source
)))
456 pa_source_process_rewind(s
->monitor_source
, nbytes
);
460 static unsigned fill_mix_info(pa_sink
*s
, size_t *length
, pa_mix_info
*info
, unsigned maxinfo
) {
464 size_t mixlength
= *length
;
466 pa_sink_assert_ref(s
);
469 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)) && maxinfo
> 0) {
470 pa_sink_input_assert_ref(i
);
472 if (pa_sink_input_peek(i
, *length
, &info
->chunk
, &info
->volume
) < 0)
475 if (mixlength
== 0 || info
->chunk
.length
< mixlength
)
476 mixlength
= info
->chunk
.length
;
478 if (pa_memblock_is_silence(info
->chunk
.memblock
)) {
479 pa_memblock_unref(info
->chunk
.memblock
);
483 info
->userdata
= pa_sink_input_ref(i
);
485 pa_assert(info
->chunk
.memblock
);
486 pa_assert(info
->chunk
.length
> 0);
499 static void inputs_drop(pa_sink
*s
, pa_mix_info
*info
, unsigned n
, size_t length
) {
503 unsigned n_unreffed
= 0;
505 pa_sink_assert_ref(s
);
507 /* We optimize for the case where the order of the inputs has not changed */
509 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
))) {
513 pa_sink_input_assert_ref(i
);
517 /* Let's try to find the matching entry info the pa_mix_info array */
518 for (j
= 0; j
< n
; j
++) {
520 if (info
[p
].userdata
== i
) {
531 pa_sink_input_drop(i
, length
);
534 pa_sink_input_unref(m
->userdata
);
536 if (m
->chunk
.memblock
)
537 pa_memblock_unref(m
->chunk
.memblock
);
538 pa_memchunk_reset(&m
->chunk
);
544 /* Now drop references to entries that are included in the
545 * pa_mix_info array but don't exist anymore */
547 if (n_unreffed
< n
) {
548 for (; n
> 0; info
++, n
--) {
550 pa_sink_input_unref(info
->userdata
);
551 if (info
->chunk
.memblock
)
552 pa_memblock_unref(info
->chunk
.memblock
);
557 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
558 pa_mix_info info
[MAX_MIX_CHANNELS
];
560 size_t block_size_max
;
562 pa_sink_assert_ref(s
);
563 pa_assert(PA_SINK_IS_OPENED(s
->thread_info
.state
));
564 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
569 s
->thread_info
.rewind_nbytes
= 0;
572 length
= pa_frame_align(MIX_BUFFER_LENGTH
, &s
->sample_spec
);
574 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
575 if (length
> block_size_max
)
576 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
578 pa_assert(length
> 0);
580 n
= s
->thread_info
.state
== PA_SINK_RUNNING
? fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
) : 0;
584 *result
= s
->silence
;
585 pa_memblock_ref(result
->memblock
);
587 if (result
->length
> length
)
588 result
->length
= length
;
593 *result
= info
[0].chunk
;
594 pa_memblock_ref(result
->memblock
);
596 if (result
->length
> length
)
597 result
->length
= length
;
599 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
601 if (s
->thread_info
.soft_muted
|| !pa_cvolume_is_norm(&volume
)) {
602 pa_log("adjusting volume ");
603 pa_memchunk_make_writable(result
, 0);
604 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
))
605 pa_silence_memchunk(result
, &s
->sample_spec
);
607 pa_volume_memchunk(result
, &s
->sample_spec
, &volume
);
611 result
->memblock
= pa_memblock_new(s
->core
->mempool
, length
);
613 ptr
= pa_memblock_acquire(result
->memblock
);
614 result
->length
= pa_mix(info
, n
,
617 &s
->thread_info
.soft_volume
,
618 s
->thread_info
.soft_muted
);
619 pa_memblock_release(result
->memblock
);
624 if (s
->thread_info
.state
== PA_SINK_RUNNING
)
625 inputs_drop(s
, info
, n
, result
->length
);
627 if (s
->monitor_source
&& PA_SOURCE_IS_OPENED(pa_source_get_state(s
->monitor_source
)))
628 pa_source_post(s
->monitor_source
, result
);
633 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
) {
634 pa_mix_info info
[MAX_MIX_CHANNELS
];
636 size_t length
, block_size_max
;
638 pa_sink_assert_ref(s
);
639 pa_assert(PA_SINK_IS_OPENED(s
->thread_info
.state
));
641 pa_assert(target
->memblock
);
642 pa_assert(target
->length
> 0);
643 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
647 s
->thread_info
.rewind_nbytes
= 0;
649 length
= target
->length
;
650 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
651 if (length
> block_size_max
)
652 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
654 n
= s
->thread_info
.state
== PA_SINK_RUNNING
? fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
) : 0;
657 if (target
->length
> length
)
658 target
->length
= length
;
660 pa_silence_memchunk(target
, &s
->sample_spec
);
664 if (target
->length
> length
)
665 target
->length
= length
;
667 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
669 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
))
670 pa_silence_memchunk(target
, &s
->sample_spec
);
674 vchunk
= info
[0].chunk
;
675 pa_memblock_ref(vchunk
.memblock
);
677 if (vchunk
.length
> target
->length
)
678 vchunk
.length
= target
->length
;
680 if (!pa_cvolume_is_norm(&volume
)) {
681 pa_memchunk_make_writable(&vchunk
, 0);
682 pa_volume_memchunk(&vchunk
, &s
->sample_spec
, &volume
);
685 pa_memchunk_memcpy(target
, &vchunk
);
686 pa_memblock_unref(vchunk
.memblock
);
692 ptr
= pa_memblock_acquire(target
->memblock
);
694 target
->length
= pa_mix(info
, n
,
695 (uint8_t*) ptr
+ target
->index
, length
,
697 &s
->thread_info
.soft_volume
,
698 s
->thread_info
.soft_muted
);
700 pa_memblock_release(target
->memblock
);
703 if (s
->thread_info
.state
== PA_SINK_RUNNING
)
704 inputs_drop(s
, info
, n
, target
->length
);
706 if (s
->monitor_source
&& PA_SOURCE_IS_OPENED(pa_source_get_state(s
->monitor_source
)))
707 pa_source_post(s
->monitor_source
, target
);
712 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
) {
716 pa_sink_assert_ref(s
);
717 pa_assert(PA_SINK_IS_OPENED(s
->thread_info
.state
));
719 pa_assert(target
->memblock
);
720 pa_assert(target
->length
> 0);
721 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
725 s
->thread_info
.rewind_nbytes
= 0;
734 pa_sink_render_into(s
, &chunk
);
743 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
744 pa_sink_assert_ref(s
);
745 pa_assert(PA_SINK_IS_OPENED(s
->thread_info
.state
));
746 pa_assert(length
> 0);
747 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
750 s
->thread_info
.rewind_nbytes
= 0;
752 /*** This needs optimization ***/
755 result
->length
= length
;
756 result
->memblock
= pa_memblock_new(s
->core
->mempool
, length
);
758 pa_sink_render_into_full(s
, result
);
761 pa_usec_t
pa_sink_get_latency(pa_sink
*s
) {
764 pa_sink_assert_ref(s
);
765 pa_assert(PA_SINK_IS_LINKED(s
->state
));
767 /* The returned value is supposed to be in the time domain of the sound card! */
769 if (!PA_SINK_IS_OPENED(s
->state
))
773 return s
->get_latency(s
);
775 if (pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) < 0)
781 void pa_sink_set_volume(pa_sink
*s
, const pa_cvolume
*volume
) {
784 pa_sink_assert_ref(s
);
785 pa_assert(PA_SINK_IS_LINKED(s
->state
));
788 changed
= !pa_cvolume_equal(volume
, &s
->volume
);
791 if (s
->set_volume
&& s
->set_volume(s
) < 0)
792 s
->set_volume
= NULL
;
795 pa_asyncmsgq_post(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME
, pa_xnewdup(struct pa_cvolume
, volume
, 1), 0, NULL
, pa_xfree
);
798 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
801 const pa_cvolume
*pa_sink_get_volume(pa_sink
*s
) {
802 struct pa_cvolume old_volume
;
804 pa_sink_assert_ref(s
);
805 pa_assert(PA_SINK_IS_LINKED(s
->state
));
807 old_volume
= s
->volume
;
809 if (s
->get_volume
&& s
->get_volume(s
) < 0)
810 s
->get_volume
= NULL
;
812 if (!s
->get_volume
&& s
->refresh_volume
)
813 pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_VOLUME
, &s
->volume
, 0, NULL
);
815 if (!pa_cvolume_equal(&old_volume
, &s
->volume
))
816 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
821 void pa_sink_set_mute(pa_sink
*s
, pa_bool_t mute
) {
824 pa_sink_assert_ref(s
);
825 pa_assert(PA_SINK_IS_LINKED(s
->state
));
827 changed
= s
->muted
!= mute
;
830 if (s
->set_mute
&& s
->set_mute(s
) < 0)
834 pa_asyncmsgq_post(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, PA_UINT_TO_PTR(mute
), 0, NULL
, NULL
);
837 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
840 pa_bool_t
pa_sink_get_mute(pa_sink
*s
) {
843 pa_sink_assert_ref(s
);
844 pa_assert(PA_SINK_IS_LINKED(s
->state
));
846 old_muted
= s
->muted
;
848 if (s
->get_mute
&& s
->get_mute(s
) < 0)
851 if (!s
->get_mute
&& s
->refresh_mute
)
852 pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MUTE
, &s
->muted
, 0, NULL
);
854 if (old_muted
!= s
->muted
)
855 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
860 void pa_sink_set_description(pa_sink
*s
, const char *description
) {
862 pa_sink_assert_ref(s
);
864 if (!description
&& !pa_proplist_contains(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
))
867 old
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
869 if (old
&& description
&& !strcmp(old
, description
))
873 pa_proplist_sets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
, description
);
875 pa_proplist_unset(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
877 if (s
->monitor_source
) {
880 n
= pa_sprintf_malloc("Monitor Source of %s", description
? description
: s
->name
);
881 pa_source_set_description(s
->monitor_source
, n
);
885 if (PA_SINK_IS_LINKED(s
->state
)) {
886 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
887 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
891 unsigned pa_sink_linked_by(pa_sink
*s
) {
894 pa_sink_assert_ref(s
);
895 pa_assert(PA_SINK_IS_LINKED(s
->state
));
897 ret
= pa_idxset_size(s
->inputs
);
899 /* We add in the number of streams connected to us here. Please
900 * not the asymmmetry to pa_sink_used_by()! */
902 if (s
->monitor_source
)
903 ret
+= pa_source_linked_by(s
->monitor_source
);
908 unsigned pa_sink_used_by(pa_sink
*s
) {
911 pa_sink_assert_ref(s
);
912 pa_assert(PA_SINK_IS_LINKED(s
->state
));
914 ret
= pa_idxset_size(s
->inputs
);
915 pa_assert(ret
>= s
->n_corked
);
917 /* Streams connected to our monitor source do not matter for
918 * pa_sink_used_by()!.*/
920 return ret
- s
->n_corked
;
923 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
924 pa_sink
*s
= PA_SINK(o
);
925 pa_sink_assert_ref(s
);
926 pa_assert(s
->thread_info
.state
!= PA_SINK_UNLINKED
);
928 switch ((pa_sink_message_t
) code
) {
930 case PA_SINK_MESSAGE_ADD_INPUT
: {
931 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
933 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
935 /* Since the caller sleeps in pa_sink_input_put(), we can
936 * safely access data outside of thread_info even though
939 if ((i
->thread_info
.sync_prev
= i
->sync_prev
)) {
940 pa_assert(i
->sink
== i
->thread_info
.sync_prev
->sink
);
941 pa_assert(i
->sync_prev
->sync_next
== i
);
942 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
;
945 if ((i
->thread_info
.sync_next
= i
->sync_next
)) {
946 pa_assert(i
->sink
== i
->thread_info
.sync_next
->sink
);
947 pa_assert(i
->sync_next
->sync_prev
== i
);
948 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
;
951 pa_assert(!i
->thread_info
.attached
);
952 i
->thread_info
.attached
= TRUE
;
957 pa_sink_input_set_state_within_thread(i
, i
->state
);
959 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
961 pa_sink_invalidate_requested_latency(s
);
963 /* We don't rewind here automatically. This is left to the
964 * sink input implementor because some sink inputs need a
965 * slow start, i.e. need some time to buffer client
966 * samples before beginning streaming. */
968 /* If you change anything here, make sure to change the
969 * ghost sink input handling a few lines down at
970 * PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER, too. */
975 case PA_SINK_MESSAGE_REMOVE_INPUT
: {
976 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
978 /* If you change anything here, make sure to change the
979 * sink input handling a few lines down at
980 * PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER, too. */
982 pa_sink_input_set_state_within_thread(i
, i
->state
);
987 pa_assert(i
->thread_info
.attached
);
988 i
->thread_info
.attached
= FALSE
;
990 /* Since the caller sleeps in pa_sink_input_unlink(),
991 * we can safely access data outside of thread_info even
992 * though it is mutable */
994 pa_assert(!i
->thread_info
.sync_prev
);
995 pa_assert(!i
->thread_info
.sync_next
);
997 if (i
->thread_info
.sync_prev
) {
998 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
->thread_info
.sync_prev
->sync_next
;
999 i
->thread_info
.sync_prev
= NULL
;
1002 if (i
->thread_info
.sync_next
) {
1003 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
->thread_info
.sync_next
->sync_prev
;
1004 i
->thread_info
.sync_next
= NULL
;
1007 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
1008 pa_sink_input_unref(i
);
1010 pa_sink_invalidate_requested_latency(s
);
1011 pa_sink_request_rewind(s
, 0);
1016 case PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER
: {
1017 pa_sink_input_move_info
*info
= userdata
;
1020 /* We don't support moving synchronized streams. */
1021 pa_assert(!info
->sink_input
->sync_prev
);
1022 pa_assert(!info
->sink_input
->sync_next
);
1023 pa_assert(!info
->sink_input
->thread_info
.sync_next
);
1024 pa_assert(!info
->sink_input
->thread_info
.sync_prev
);
1026 if (info
->sink_input
->detach
)
1027 info
->sink_input
->detach(info
->sink_input
);
1029 pa_assert(info
->sink_input
->thread_info
.attached
);
1030 info
->sink_input
->thread_info
.attached
= FALSE
;
1031 pa_sink_invalidate_requested_latency(info
->sink_input
->sink
);
1033 if (info
->ghost_sink_input
) {
1034 pa_assert(info
->buffer_bytes
> 0);
1035 pa_assert(info
->buffer
);
1037 volume_is_norm
= pa_cvolume_is_norm(&info
->sink_input
->thread_info
.volume
);
1039 pa_log_debug("Buffering %lu bytes ...", (unsigned long) info
->buffer_bytes
);
1041 while (info
->buffer_bytes
> 0) {
1042 pa_memchunk memchunk
;
1046 if (pa_sink_input_peek(info
->sink_input
, info
->buffer_bytes
, &memchunk
, &volume
) < 0)
1049 n
= memchunk
.length
> info
->buffer_bytes
? info
->buffer_bytes
: memchunk
.length
;
1050 pa_sink_input_drop(info
->sink_input
, n
);
1051 memchunk
.length
= n
;
1053 if (!volume_is_norm
) {
1054 pa_memchunk_make_writable(&memchunk
, 0);
1055 pa_volume_memchunk(&memchunk
, &s
->sample_spec
, &volume
);
1058 if (pa_memblockq_push(info
->buffer
, &memchunk
) < 0) {
1059 pa_memblock_unref(memchunk
.memblock
);
1063 pa_memblock_unref(memchunk
.memblock
);
1064 info
->buffer_bytes
-= n
;
1067 /* Add the remaining already resampled chunks to the buffer */
1068 pa_memblockq_splice(info
->buffer
, info
->sink_input
->thread_info
.render_memblockq
);
1070 pa_memblockq_sink_input_set_queue(info
->ghost_sink_input
, info
->buffer
);
1072 pa_log_debug("Buffered %lu bytes ...", (unsigned long) pa_memblockq_get_length(info
->buffer
));
1075 /* Let's remove the sink input ...*/
1076 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(info
->sink_input
->index
)))
1077 pa_sink_input_unref(info
->sink_input
);
1079 /* .. and add the ghost sink input instead */
1080 if (info
->ghost_sink_input
) {
1081 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(info
->ghost_sink_input
->index
), pa_sink_input_ref(info
->ghost_sink_input
));
1082 info
->ghost_sink_input
->thread_info
.sync_prev
= info
->ghost_sink_input
->thread_info
.sync_next
= NULL
;
1084 pa_sink_input_update_max_rewind(info
->ghost_sink_input
, s
->thread_info
.max_rewind
);
1086 pa_assert(!info
->ghost_sink_input
->thread_info
.attached
);
1087 info
->ghost_sink_input
->thread_info
.attached
= TRUE
;
1089 if (info
->ghost_sink_input
->attach
)
1090 info
->ghost_sink_input
->attach(info
->ghost_sink_input
);
1093 pa_sink_invalidate_requested_latency(s
);
1094 pa_sink_request_rewind(s
, 0);
1099 case PA_SINK_MESSAGE_SET_VOLUME
:
1100 s
->thread_info
.soft_volume
= *((pa_cvolume
*) userdata
);
1102 pa_sink_request_rewind(s
, 0);
1105 case PA_SINK_MESSAGE_SET_MUTE
:
1106 s
->thread_info
.soft_muted
= PA_PTR_TO_UINT(userdata
);
1108 pa_sink_request_rewind(s
, 0);
1111 case PA_SINK_MESSAGE_GET_VOLUME
:
1112 *((pa_cvolume
*) userdata
) = s
->thread_info
.soft_volume
;
1115 case PA_SINK_MESSAGE_GET_MUTE
:
1116 *((pa_bool_t
*) userdata
) = s
->thread_info
.soft_muted
;
1119 case PA_SINK_MESSAGE_SET_STATE
:
1121 s
->thread_info
.state
= PA_PTR_TO_UINT(userdata
);
1124 case PA_SINK_MESSAGE_DETACH
:
1126 /* We're detaching all our input streams so that the
1127 * asyncmsgq and rtpoll fields can be changed without
1129 pa_sink_detach_within_thread(s
);
1132 case PA_SINK_MESSAGE_ATTACH
:
1134 /* Reattach all streams */
1135 pa_sink_attach_within_thread(s
);
1138 case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
: {
1140 pa_usec_t
*usec
= userdata
;
1141 *usec
= pa_sink_get_requested_latency_within_thread(s
);
1145 case PA_SINK_MESSAGE_GET_LATENCY
:
1146 case PA_SINK_MESSAGE_MAX
:
1153 int pa_sink_suspend_all(pa_core
*c
, pa_bool_t suspend
) {
1158 pa_core_assert_ref(c
);
1160 for (sink
= PA_SINK(pa_idxset_first(c
->sinks
, &idx
)); sink
; sink
= PA_SINK(pa_idxset_next(c
->sinks
, &idx
)))
1161 ret
-= pa_sink_suspend(sink
, suspend
) < 0;
1166 void pa_sink_detach(pa_sink
*s
) {
1167 pa_sink_assert_ref(s
);
1168 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1170 pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_DETACH
, NULL
, 0, NULL
);
1173 void pa_sink_attach(pa_sink
*s
) {
1174 pa_sink_assert_ref(s
);
1175 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1177 pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_ATTACH
, NULL
, 0, NULL
);
1180 void pa_sink_detach_within_thread(pa_sink
*s
) {
1184 pa_sink_assert_ref(s
);
1185 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1187 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
1191 if (s
->monitor_source
)
1192 pa_source_detach_within_thread(s
->monitor_source
);
1195 void pa_sink_attach_within_thread(pa_sink
*s
) {
1199 pa_sink_assert_ref(s
);
1200 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1202 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
1206 if (s
->monitor_source
)
1207 pa_source_attach_within_thread(s
->monitor_source
);
1210 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
) {
1211 pa_sink_assert_ref(s
);
1212 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1215 nbytes
= s
->thread_info
.max_rewind
;
1217 nbytes
= PA_MIN(nbytes
, s
->thread_info
.max_rewind
);
1219 if (nbytes
<= s
->thread_info
.rewind_nbytes
)
1222 s
->thread_info
.rewind_nbytes
= nbytes
;
1224 if (s
->request_rewind
)
1225 s
->request_rewind(s
);
1228 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
) {
1229 pa_usec_t result
= (pa_usec_t
) -1;
1233 pa_sink_assert_ref(s
);
1235 if (s
->thread_info
.requested_latency_valid
)
1236 return s
->thread_info
.requested_latency
;
1238 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
1240 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1 &&
1241 (result
== (pa_usec_t
) -1 || result
> i
->thread_info
.requested_sink_latency
))
1242 result
= i
->thread_info
.requested_sink_latency
;
1244 if (result
!= (pa_usec_t
) -1) {
1245 if (s
->max_latency
> 0 && result
> s
->max_latency
)
1246 result
= s
->max_latency
;
1248 if (s
->min_latency
> 0 && result
< s
->min_latency
)
1249 result
= s
->min_latency
;
1252 s
->thread_info
.requested_latency
= result
;
1253 s
->thread_info
.requested_latency_valid
= TRUE
;
1258 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
) {
1261 pa_sink_assert_ref(s
);
1262 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1264 if (!PA_SINK_IS_OPENED(s
->state
))
1267 if (pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) < 0)
1270 if (usec
== (pa_usec_t
) -1)
1271 usec
= s
->max_latency
;
1276 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
) {
1280 pa_sink_assert_ref(s
);
1282 if (max_rewind
== s
->thread_info
.max_rewind
)
1285 s
->thread_info
.max_rewind
= max_rewind
;
1287 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
1288 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
1290 if (s
->monitor_source
)
1291 pa_source_set_max_rewind(s
->monitor_source
, s
->thread_info
.max_rewind
);
1294 void pa_sink_invalidate_requested_latency(pa_sink
*s
) {
1296 pa_sink_assert_ref(s
);
1297 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1299 s
->thread_info
.requested_latency_valid
= FALSE
;
1301 if (s
->update_requested_latency
)
1302 s
->update_requested_latency(s
);