2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2.1 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
31 #include <pulse/introspect.h>
32 #include <pulse/format.h>
33 #include <pulse/utf8.h>
34 #include <pulse/xmalloc.h>
35 #include <pulse/timeval.h>
36 #include <pulse/util.h>
37 #include <pulse/rtclock.h>
38 #include <pulse/internal.h>
40 #include <pulsecore/i18n.h>
41 #include <pulsecore/sink-input.h>
42 #include <pulsecore/namereg.h>
43 #include <pulsecore/core-util.h>
44 #include <pulsecore/sample-util.h>
45 #include <pulsecore/mix.h>
46 #include <pulsecore/core-subscribe.h>
47 #include <pulsecore/log.h>
48 #include <pulsecore/macro.h>
49 #include <pulsecore/play-memblockq.h>
50 #include <pulsecore/flist.h>
54 #define MAX_MIX_CHANNELS 32
55 #define MIX_BUFFER_LENGTH (PA_PAGE_SIZE)
56 #define ABSOLUTE_MIN_LATENCY (500)
57 #define ABSOLUTE_MAX_LATENCY (10*PA_USEC_PER_SEC)
58 #define DEFAULT_FIXED_LATENCY (250*PA_USEC_PER_MSEC)
60 PA_DEFINE_PUBLIC_CLASS(pa_sink
, pa_msgobject
);
62 struct pa_sink_volume_change
{
66 PA_LLIST_FIELDS(pa_sink_volume_change
);
69 struct sink_message_set_port
{
74 static void sink_free(pa_object
*s
);
76 static void pa_sink_volume_change_push(pa_sink
*s
);
77 static void pa_sink_volume_change_flush(pa_sink
*s
);
78 static void pa_sink_volume_change_rewind(pa_sink
*s
, size_t nbytes
);
80 pa_sink_new_data
* pa_sink_new_data_init(pa_sink_new_data
*data
) {
84 data
->proplist
= pa_proplist_new();
85 data
->ports
= pa_hashmap_new_full(pa_idxset_string_hash_func
, pa_idxset_string_compare_func
, NULL
, (pa_free_cb_t
) pa_device_port_unref
);
90 void pa_sink_new_data_set_name(pa_sink_new_data
*data
, const char *name
) {
94 data
->name
= pa_xstrdup(name
);
97 void pa_sink_new_data_set_sample_spec(pa_sink_new_data
*data
, const pa_sample_spec
*spec
) {
100 if ((data
->sample_spec_is_set
= !!spec
))
101 data
->sample_spec
= *spec
;
104 void pa_sink_new_data_set_channel_map(pa_sink_new_data
*data
, const pa_channel_map
*map
) {
107 if ((data
->channel_map_is_set
= !!map
))
108 data
->channel_map
= *map
;
111 void pa_sink_new_data_set_alternate_sample_rate(pa_sink_new_data
*data
, const uint32_t alternate_sample_rate
) {
114 data
->alternate_sample_rate_is_set
= true;
115 data
->alternate_sample_rate
= alternate_sample_rate
;
118 void pa_sink_new_data_set_volume(pa_sink_new_data
*data
, const pa_cvolume
*volume
) {
121 if ((data
->volume_is_set
= !!volume
))
122 data
->volume
= *volume
;
125 void pa_sink_new_data_set_muted(pa_sink_new_data
*data
, bool mute
) {
128 data
->muted_is_set
= true;
129 data
->muted
= !!mute
;
132 void pa_sink_new_data_set_port(pa_sink_new_data
*data
, const char *port
) {
135 pa_xfree(data
->active_port
);
136 data
->active_port
= pa_xstrdup(port
);
139 void pa_sink_new_data_done(pa_sink_new_data
*data
) {
142 pa_proplist_free(data
->proplist
);
145 pa_hashmap_free(data
->ports
);
147 pa_xfree(data
->name
);
148 pa_xfree(data
->active_port
);
151 /* Called from main context */
152 static void reset_callbacks(pa_sink
*s
) {
156 s
->get_volume
= NULL
;
157 s
->set_volume
= NULL
;
158 s
->write_volume
= NULL
;
161 s
->request_rewind
= NULL
;
162 s
->update_requested_latency
= NULL
;
164 s
->get_formats
= NULL
;
165 s
->set_formats
= NULL
;
166 s
->update_rate
= NULL
;
169 /* Called from main context */
170 pa_sink
* pa_sink_new(
172 pa_sink_new_data
*data
,
173 pa_sink_flags_t flags
) {
177 char st
[PA_SAMPLE_SPEC_SNPRINT_MAX
], cm
[PA_CHANNEL_MAP_SNPRINT_MAX
];
178 pa_source_new_data source_data
;
184 pa_assert(data
->name
);
185 pa_assert_ctl_context();
187 s
= pa_msgobject_new(pa_sink
);
189 if (!(name
= pa_namereg_register(core
, data
->name
, PA_NAMEREG_SINK
, s
, data
->namereg_fail
))) {
190 pa_log_debug("Failed to register name %s.", data
->name
);
195 pa_sink_new_data_set_name(data
, name
);
197 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_NEW
], data
) < 0) {
199 pa_namereg_unregister(core
, name
);
203 /* FIXME, need to free s here on failure */
205 pa_return_null_if_fail(!data
->driver
|| pa_utf8_valid(data
->driver
));
206 pa_return_null_if_fail(data
->name
&& pa_utf8_valid(data
->name
) && data
->name
[0]);
208 pa_return_null_if_fail(data
->sample_spec_is_set
&& pa_sample_spec_valid(&data
->sample_spec
));
210 if (!data
->channel_map_is_set
)
211 pa_return_null_if_fail(pa_channel_map_init_auto(&data
->channel_map
, data
->sample_spec
.channels
, PA_CHANNEL_MAP_DEFAULT
));
213 pa_return_null_if_fail(pa_channel_map_valid(&data
->channel_map
));
214 pa_return_null_if_fail(data
->channel_map
.channels
== data
->sample_spec
.channels
);
216 /* FIXME: There should probably be a general function for checking whether
217 * the sink volume is allowed to be set, like there is for sink inputs. */
218 pa_assert(!data
->volume_is_set
|| !(flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
220 if (!data
->volume_is_set
) {
221 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
222 data
->save_volume
= false;
225 pa_return_null_if_fail(pa_cvolume_valid(&data
->volume
));
226 pa_return_null_if_fail(pa_cvolume_compatible(&data
->volume
, &data
->sample_spec
));
228 if (!data
->muted_is_set
)
232 pa_proplist_update(data
->proplist
, PA_UPDATE_MERGE
, data
->card
->proplist
);
234 pa_device_init_description(data
->proplist
);
235 pa_device_init_icon(data
->proplist
, true);
236 pa_device_init_intended_roles(data
->proplist
);
238 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_FIXATE
], data
) < 0) {
240 pa_namereg_unregister(core
, name
);
244 s
->parent
.parent
.free
= sink_free
;
245 s
->parent
.process_msg
= pa_sink_process_msg
;
248 s
->state
= PA_SINK_INIT
;
251 s
->suspend_cause
= data
->suspend_cause
;
252 pa_sink_set_mixer_dirty(s
, false);
253 s
->name
= pa_xstrdup(name
);
254 s
->proplist
= pa_proplist_copy(data
->proplist
);
255 s
->driver
= pa_xstrdup(pa_path_get_filename(data
->driver
));
256 s
->module
= data
->module
;
257 s
->card
= data
->card
;
259 s
->priority
= pa_device_init_priority(s
->proplist
);
261 s
->sample_spec
= data
->sample_spec
;
262 s
->channel_map
= data
->channel_map
;
263 s
->default_sample_rate
= s
->sample_spec
.rate
;
265 if (data
->alternate_sample_rate_is_set
)
266 s
->alternate_sample_rate
= data
->alternate_sample_rate
;
268 s
->alternate_sample_rate
= s
->core
->alternate_sample_rate
;
270 if (s
->sample_spec
.rate
== s
->alternate_sample_rate
) {
271 pa_log_warn("Default and alternate sample rates are the same.");
272 s
->alternate_sample_rate
= 0;
275 s
->inputs
= pa_idxset_new(NULL
, NULL
);
277 s
->input_to_master
= NULL
;
279 s
->reference_volume
= s
->real_volume
= data
->volume
;
280 pa_cvolume_reset(&s
->soft_volume
, s
->sample_spec
.channels
);
281 s
->base_volume
= PA_VOLUME_NORM
;
282 s
->n_volume_steps
= PA_VOLUME_NORM
+1;
283 s
->muted
= data
->muted
;
284 s
->refresh_volume
= s
->refresh_muted
= false;
291 /* As a minor optimization we just steal the list instead of
293 s
->ports
= data
->ports
;
296 s
->active_port
= NULL
;
297 s
->save_port
= false;
299 if (data
->active_port
)
300 if ((s
->active_port
= pa_hashmap_get(s
->ports
, data
->active_port
)))
301 s
->save_port
= data
->save_port
;
303 if (!s
->active_port
) {
307 PA_HASHMAP_FOREACH(p
, s
->ports
, state
) {
308 if (p
->available
== PA_AVAILABLE_NO
)
311 if (!s
->active_port
|| p
->priority
> s
->active_port
->priority
)
314 if (!s
->active_port
) {
315 PA_HASHMAP_FOREACH(p
, s
->ports
, state
)
316 if (!s
->active_port
|| p
->priority
> s
->active_port
->priority
)
322 s
->latency_offset
= s
->active_port
->latency_offset
;
324 s
->latency_offset
= 0;
326 s
->save_volume
= data
->save_volume
;
327 s
->save_muted
= data
->save_muted
;
329 pa_silence_memchunk_get(
330 &core
->silence_cache
,
336 s
->thread_info
.rtpoll
= NULL
;
337 s
->thread_info
.inputs
= pa_hashmap_new_full(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
, NULL
,
338 (pa_free_cb_t
) pa_sink_input_unref
);
339 s
->thread_info
.soft_volume
= s
->soft_volume
;
340 s
->thread_info
.soft_muted
= s
->muted
;
341 s
->thread_info
.state
= s
->state
;
342 s
->thread_info
.rewind_nbytes
= 0;
343 s
->thread_info
.rewind_requested
= false;
344 s
->thread_info
.max_rewind
= 0;
345 s
->thread_info
.max_request
= 0;
346 s
->thread_info
.requested_latency_valid
= false;
347 s
->thread_info
.requested_latency
= 0;
348 s
->thread_info
.min_latency
= ABSOLUTE_MIN_LATENCY
;
349 s
->thread_info
.max_latency
= ABSOLUTE_MAX_LATENCY
;
350 s
->thread_info
.fixed_latency
= flags
& PA_SINK_DYNAMIC_LATENCY
? 0 : DEFAULT_FIXED_LATENCY
;
352 PA_LLIST_HEAD_INIT(pa_sink_volume_change
, s
->thread_info
.volume_changes
);
353 s
->thread_info
.volume_changes_tail
= NULL
;
354 pa_sw_cvolume_multiply(&s
->thread_info
.current_hw_volume
, &s
->soft_volume
, &s
->real_volume
);
355 s
->thread_info
.volume_change_safety_margin
= core
->deferred_volume_safety_margin_usec
;
356 s
->thread_info
.volume_change_extra_delay
= core
->deferred_volume_extra_delay_usec
;
357 s
->thread_info
.latency_offset
= s
->latency_offset
;
359 /* FIXME: This should probably be moved to pa_sink_put() */
360 pa_assert_se(pa_idxset_put(core
->sinks
, s
, &s
->index
) >= 0);
363 pa_assert_se(pa_idxset_put(s
->card
->sinks
, s
, NULL
) >= 0);
365 pt
= pa_proplist_to_string_sep(s
->proplist
, "\n ");
366 pa_log_info("Created sink %u \"%s\" with sample spec %s and channel map %s\n %s",
369 pa_sample_spec_snprint(st
, sizeof(st
), &s
->sample_spec
),
370 pa_channel_map_snprint(cm
, sizeof(cm
), &s
->channel_map
),
374 pa_source_new_data_init(&source_data
);
375 pa_source_new_data_set_sample_spec(&source_data
, &s
->sample_spec
);
376 pa_source_new_data_set_channel_map(&source_data
, &s
->channel_map
);
377 pa_source_new_data_set_alternate_sample_rate(&source_data
, s
->alternate_sample_rate
);
378 source_data
.name
= pa_sprintf_malloc("%s.monitor", name
);
379 source_data
.driver
= data
->driver
;
380 source_data
.module
= data
->module
;
381 source_data
.card
= data
->card
;
383 dn
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
384 pa_proplist_setf(source_data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Monitor of %s", dn
? dn
: s
->name
);
385 pa_proplist_sets(source_data
.proplist
, PA_PROP_DEVICE_CLASS
, "monitor");
387 s
->monitor_source
= pa_source_new(core
, &source_data
,
388 ((flags
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
389 ((flags
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0));
391 pa_source_new_data_done(&source_data
);
393 if (!s
->monitor_source
) {
399 s
->monitor_source
->monitor_of
= s
;
401 pa_source_set_latency_range(s
->monitor_source
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
402 pa_source_set_fixed_latency(s
->monitor_source
, s
->thread_info
.fixed_latency
);
403 pa_source_set_max_rewind(s
->monitor_source
, s
->thread_info
.max_rewind
);
408 /* Called from main context */
409 static int sink_set_state(pa_sink
*s
, pa_sink_state_t state
) {
412 pa_sink_state_t original_state
;
415 pa_assert_ctl_context();
417 if (s
->state
== state
)
420 original_state
= s
->state
;
423 (original_state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(state
)) ||
424 (PA_SINK_IS_OPENED(original_state
) && state
== PA_SINK_SUSPENDED
);
427 if ((ret
= s
->set_state(s
, state
)) < 0)
431 if ((ret
= pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_STATE
, PA_UINT_TO_PTR(state
), 0, NULL
)) < 0) {
434 s
->set_state(s
, original_state
);
441 if (state
!= PA_SINK_UNLINKED
) { /* if we enter UNLINKED state pa_sink_unlink() will fire the appropriate events */
442 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_STATE_CHANGED
], s
);
443 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
446 if (suspend_change
) {
450 /* We're suspending or resuming, tell everyone about it */
452 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
)
453 if (s
->state
== PA_SINK_SUSPENDED
&&
454 (i
->flags
& PA_SINK_INPUT_KILL_ON_SUSPEND
))
455 pa_sink_input_kill(i
);
457 i
->suspend(i
, state
== PA_SINK_SUSPENDED
);
459 if (s
->monitor_source
)
460 pa_source_sync_suspend(s
->monitor_source
);
466 void pa_sink_set_get_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
472 void pa_sink_set_set_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
473 pa_sink_flags_t flags
;
476 pa_assert(!s
->write_volume
|| cb
);
480 /* Save the current flags so we can tell if they've changed */
484 /* The sink implementor is responsible for setting decibel volume support */
485 s
->flags
|= PA_SINK_HW_VOLUME_CTRL
;
487 s
->flags
&= ~PA_SINK_HW_VOLUME_CTRL
;
488 /* See note below in pa_sink_put() about volume sharing and decibel volumes */
489 pa_sink_enable_decibel_volume(s
, !(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
492 /* If the flags have changed after init, let any clients know via a change event */
493 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
494 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
497 void pa_sink_set_write_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
498 pa_sink_flags_t flags
;
501 pa_assert(!cb
|| s
->set_volume
);
503 s
->write_volume
= cb
;
505 /* Save the current flags so we can tell if they've changed */
509 s
->flags
|= PA_SINK_DEFERRED_VOLUME
;
511 s
->flags
&= ~PA_SINK_DEFERRED_VOLUME
;
513 /* If the flags have changed after init, let any clients know via a change event */
514 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
515 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
518 void pa_sink_set_get_mute_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
524 void pa_sink_set_set_mute_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
525 pa_sink_flags_t flags
;
531 /* Save the current flags so we can tell if they've changed */
535 s
->flags
|= PA_SINK_HW_MUTE_CTRL
;
537 s
->flags
&= ~PA_SINK_HW_MUTE_CTRL
;
539 /* If the flags have changed after init, let any clients know via a change event */
540 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
541 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
544 static void enable_flat_volume(pa_sink
*s
, bool enable
) {
545 pa_sink_flags_t flags
;
549 /* Always follow the overall user preference here */
550 enable
= enable
&& s
->core
->flat_volumes
;
552 /* Save the current flags so we can tell if they've changed */
556 s
->flags
|= PA_SINK_FLAT_VOLUME
;
558 s
->flags
&= ~PA_SINK_FLAT_VOLUME
;
560 /* If the flags have changed after init, let any clients know via a change event */
561 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
562 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
565 void pa_sink_enable_decibel_volume(pa_sink
*s
, bool enable
) {
566 pa_sink_flags_t flags
;
570 /* Save the current flags so we can tell if they've changed */
574 s
->flags
|= PA_SINK_DECIBEL_VOLUME
;
575 enable_flat_volume(s
, true);
577 s
->flags
&= ~PA_SINK_DECIBEL_VOLUME
;
578 enable_flat_volume(s
, false);
581 /* If the flags have changed after init, let any clients know via a change event */
582 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
583 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
586 /* Called from main context */
587 void pa_sink_put(pa_sink
* s
) {
588 pa_sink_assert_ref(s
);
589 pa_assert_ctl_context();
591 pa_assert(s
->state
== PA_SINK_INIT
);
592 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) || s
->input_to_master
);
594 /* The following fields must be initialized properly when calling _put() */
595 pa_assert(s
->asyncmsgq
);
596 pa_assert(s
->thread_info
.min_latency
<= s
->thread_info
.max_latency
);
598 /* Generally, flags should be initialized via pa_sink_new(). As a
599 * special exception we allow some volume related flags to be set
600 * between _new() and _put() by the callback setter functions above.
602 * Thus we implement a couple safeguards here which ensure the above
603 * setters were used (or at least the implementor made manual changes
604 * in a compatible way).
606 * Note: All of these flags set here can change over the life time
608 pa_assert(!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
) || s
->set_volume
);
609 pa_assert(!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) || s
->write_volume
);
610 pa_assert(!(s
->flags
& PA_SINK_HW_MUTE_CTRL
) || s
->set_mute
);
612 /* XXX: Currently decibel volume is disabled for all sinks that use volume
613 * sharing. When the master sink supports decibel volume, it would be good
614 * to have the flag also in the filter sink, but currently we don't do that
615 * so that the flags of the filter sink never change when it's moved from
616 * a master sink to another. One solution for this problem would be to
617 * remove user-visible volume altogether from filter sinks when volume
618 * sharing is used, but the current approach was easier to implement... */
619 /* We always support decibel volumes in software, otherwise we leave it to
620 * the sink implementor to set this flag as needed.
622 * Note: This flag can also change over the life time of the sink. */
623 if (!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
) && !(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
624 pa_sink_enable_decibel_volume(s
, true);
626 /* If the sink implementor support DB volumes by itself, we should always
627 * try and enable flat volumes too */
628 if ((s
->flags
& PA_SINK_DECIBEL_VOLUME
))
629 enable_flat_volume(s
, true);
631 if (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) {
632 pa_sink
*root_sink
= pa_sink_get_master(s
);
634 pa_assert(root_sink
);
636 s
->reference_volume
= root_sink
->reference_volume
;
637 pa_cvolume_remap(&s
->reference_volume
, &root_sink
->channel_map
, &s
->channel_map
);
639 s
->real_volume
= root_sink
->real_volume
;
640 pa_cvolume_remap(&s
->real_volume
, &root_sink
->channel_map
, &s
->channel_map
);
642 /* We assume that if the sink implementor changed the default
643 * volume he did so in real_volume, because that is the usual
644 * place where he is supposed to place his changes. */
645 s
->reference_volume
= s
->real_volume
;
647 s
->thread_info
.soft_volume
= s
->soft_volume
;
648 s
->thread_info
.soft_muted
= s
->muted
;
649 pa_sw_cvolume_multiply(&s
->thread_info
.current_hw_volume
, &s
->soft_volume
, &s
->real_volume
);
651 pa_assert((s
->flags
& PA_SINK_HW_VOLUME_CTRL
)
652 || (s
->base_volume
== PA_VOLUME_NORM
653 && ((s
->flags
& PA_SINK_DECIBEL_VOLUME
|| (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)))));
654 pa_assert(!(s
->flags
& PA_SINK_DECIBEL_VOLUME
) || s
->n_volume_steps
== PA_VOLUME_NORM
+1);
655 pa_assert(!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
) == (s
->thread_info
.fixed_latency
!= 0));
656 pa_assert(!(s
->flags
& PA_SINK_LATENCY
) == !(s
->monitor_source
->flags
& PA_SOURCE_LATENCY
));
657 pa_assert(!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
) == !(s
->monitor_source
->flags
& PA_SOURCE_DYNAMIC_LATENCY
));
659 pa_assert(s
->monitor_source
->thread_info
.fixed_latency
== s
->thread_info
.fixed_latency
);
660 pa_assert(s
->monitor_source
->thread_info
.min_latency
== s
->thread_info
.min_latency
);
661 pa_assert(s
->monitor_source
->thread_info
.max_latency
== s
->thread_info
.max_latency
);
663 if (s
->suspend_cause
)
664 pa_assert_se(sink_set_state(s
, PA_SINK_SUSPENDED
) == 0);
666 pa_assert_se(sink_set_state(s
, PA_SINK_IDLE
) == 0);
668 pa_source_put(s
->monitor_source
);
670 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_NEW
, s
->index
);
671 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PUT
], s
);
674 /* Called from main context */
675 void pa_sink_unlink(pa_sink
* s
) {
677 pa_sink_input
*i
, *j
= NULL
;
680 pa_assert_ctl_context();
682 /* Please note that pa_sink_unlink() does more than simply
683 * reversing pa_sink_put(). It also undoes the registrations
684 * already done in pa_sink_new()! */
686 /* All operations here shall be idempotent, i.e. pa_sink_unlink()
687 * may be called multiple times on the same sink without bad
690 linked
= PA_SINK_IS_LINKED(s
->state
);
693 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK
], s
);
695 if (s
->state
!= PA_SINK_UNLINKED
)
696 pa_namereg_unregister(s
->core
, s
->name
);
697 pa_idxset_remove_by_data(s
->core
->sinks
, s
, NULL
);
700 pa_idxset_remove_by_data(s
->card
->sinks
, s
, NULL
);
702 while ((i
= pa_idxset_first(s
->inputs
, NULL
))) {
704 pa_sink_input_kill(i
);
709 sink_set_state(s
, PA_SINK_UNLINKED
);
711 s
->state
= PA_SINK_UNLINKED
;
715 if (s
->monitor_source
)
716 pa_source_unlink(s
->monitor_source
);
719 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_REMOVE
, s
->index
);
720 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK_POST
], s
);
724 /* Called from main context */
725 static void sink_free(pa_object
*o
) {
726 pa_sink
*s
= PA_SINK(o
);
729 pa_assert_ctl_context();
730 pa_assert(pa_sink_refcnt(s
) == 0);
732 if (PA_SINK_IS_LINKED(s
->state
))
735 pa_log_info("Freeing sink %u \"%s\"", s
->index
, s
->name
);
737 if (s
->monitor_source
) {
738 pa_source_unref(s
->monitor_source
);
739 s
->monitor_source
= NULL
;
742 pa_idxset_free(s
->inputs
, NULL
);
743 pa_hashmap_free(s
->thread_info
.inputs
);
745 if (s
->silence
.memblock
)
746 pa_memblock_unref(s
->silence
.memblock
);
752 pa_proplist_free(s
->proplist
);
755 pa_hashmap_free(s
->ports
);
760 /* Called from main context, and not while the IO thread is active, please */
761 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
) {
762 pa_sink_assert_ref(s
);
763 pa_assert_ctl_context();
767 if (s
->monitor_source
)
768 pa_source_set_asyncmsgq(s
->monitor_source
, q
);
771 /* Called from main context, and not while the IO thread is active, please */
772 void pa_sink_update_flags(pa_sink
*s
, pa_sink_flags_t mask
, pa_sink_flags_t value
) {
773 pa_sink_flags_t old_flags
;
774 pa_sink_input
*input
;
777 pa_sink_assert_ref(s
);
778 pa_assert_ctl_context();
780 /* For now, allow only a minimal set of flags to be changed. */
781 pa_assert((mask
& ~(PA_SINK_DYNAMIC_LATENCY
|PA_SINK_LATENCY
)) == 0);
783 old_flags
= s
->flags
;
784 s
->flags
= (s
->flags
& ~mask
) | (value
& mask
);
786 if (s
->flags
== old_flags
)
789 if ((s
->flags
& PA_SINK_LATENCY
) != (old_flags
& PA_SINK_LATENCY
))
790 pa_log_debug("Sink %s: LATENCY flag %s.", s
->name
, (s
->flags
& PA_SINK_LATENCY
) ? "enabled" : "disabled");
792 if ((s
->flags
& PA_SINK_DYNAMIC_LATENCY
) != (old_flags
& PA_SINK_DYNAMIC_LATENCY
))
793 pa_log_debug("Sink %s: DYNAMIC_LATENCY flag %s.",
794 s
->name
, (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) ? "enabled" : "disabled");
796 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
797 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_FLAGS_CHANGED
], s
);
799 if (s
->monitor_source
)
800 pa_source_update_flags(s
->monitor_source
,
801 ((mask
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
802 ((mask
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0),
803 ((value
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
804 ((value
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0));
806 PA_IDXSET_FOREACH(input
, s
->inputs
, idx
) {
807 if (input
->origin_sink
)
808 pa_sink_update_flags(input
->origin_sink
, mask
, value
);
812 /* Called from IO context, or before _put() from main context */
813 void pa_sink_set_rtpoll(pa_sink
*s
, pa_rtpoll
*p
) {
814 pa_sink_assert_ref(s
);
815 pa_sink_assert_io_context(s
);
817 s
->thread_info
.rtpoll
= p
;
819 if (s
->monitor_source
)
820 pa_source_set_rtpoll(s
->monitor_source
, p
);
823 /* Called from main context */
824 int pa_sink_update_status(pa_sink
*s
) {
825 pa_sink_assert_ref(s
);
826 pa_assert_ctl_context();
827 pa_assert(PA_SINK_IS_LINKED(s
->state
));
829 if (s
->state
== PA_SINK_SUSPENDED
)
832 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
835 /* Called from any context - must be threadsafe */
836 void pa_sink_set_mixer_dirty(pa_sink
*s
, bool is_dirty
) {
837 pa_atomic_store(&s
->mixer_dirty
, is_dirty
? 1 : 0);
840 /* Called from main context */
841 int pa_sink_suspend(pa_sink
*s
, bool suspend
, pa_suspend_cause_t cause
) {
842 pa_sink_assert_ref(s
);
843 pa_assert_ctl_context();
844 pa_assert(PA_SINK_IS_LINKED(s
->state
));
845 pa_assert(cause
!= 0);
848 s
->suspend_cause
|= cause
;
849 s
->monitor_source
->suspend_cause
|= cause
;
851 s
->suspend_cause
&= ~cause
;
852 s
->monitor_source
->suspend_cause
&= ~cause
;
855 if (!(s
->suspend_cause
& PA_SUSPEND_SESSION
) && (pa_atomic_load(&s
->mixer_dirty
) != 0)) {
856 /* This might look racy but isn't: If somebody sets mixer_dirty exactly here,
857 it'll be handled just fine. */
858 pa_sink_set_mixer_dirty(s
, false);
859 pa_log_debug("Mixer is now accessible. Updating alsa mixer settings.");
860 if (s
->active_port
&& s
->set_port
) {
861 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
862 struct sink_message_set_port msg
= { .port
= s
->active_port
, .ret
= 0 };
863 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_PORT
, &msg
, 0, NULL
) == 0);
866 s
->set_port(s
, s
->active_port
);
876 if ((pa_sink_get_state(s
) == PA_SINK_SUSPENDED
) == !!s
->suspend_cause
)
879 pa_log_debug("Suspend cause of sink %s is 0x%04x, %s", s
->name
, s
->suspend_cause
, s
->suspend_cause
? "suspending" : "resuming");
881 if (s
->suspend_cause
)
882 return sink_set_state(s
, PA_SINK_SUSPENDED
);
884 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
887 /* Called from main context */
888 pa_queue
*pa_sink_move_all_start(pa_sink
*s
, pa_queue
*q
) {
889 pa_sink_input
*i
, *n
;
892 pa_sink_assert_ref(s
);
893 pa_assert_ctl_context();
894 pa_assert(PA_SINK_IS_LINKED(s
->state
));
899 for (i
= PA_SINK_INPUT(pa_idxset_first(s
->inputs
, &idx
)); i
; i
= n
) {
900 n
= PA_SINK_INPUT(pa_idxset_next(s
->inputs
, &idx
));
902 pa_sink_input_ref(i
);
904 if (pa_sink_input_start_move(i
) >= 0)
907 pa_sink_input_unref(i
);
913 /* Called from main context */
914 void pa_sink_move_all_finish(pa_sink
*s
, pa_queue
*q
, bool save
) {
917 pa_sink_assert_ref(s
);
918 pa_assert_ctl_context();
919 pa_assert(PA_SINK_IS_LINKED(s
->state
));
922 while ((i
= PA_SINK_INPUT(pa_queue_pop(q
)))) {
923 if (pa_sink_input_finish_move(i
, s
, save
) < 0)
924 pa_sink_input_fail_move(i
);
926 pa_sink_input_unref(i
);
929 pa_queue_free(q
, NULL
);
932 /* Called from main context */
933 void pa_sink_move_all_fail(pa_queue
*q
) {
936 pa_assert_ctl_context();
939 while ((i
= PA_SINK_INPUT(pa_queue_pop(q
)))) {
940 pa_sink_input_fail_move(i
);
941 pa_sink_input_unref(i
);
944 pa_queue_free(q
, NULL
);
947 /* Called from IO thread context */
948 size_t pa_sink_process_input_underruns(pa_sink
*s
, size_t left_to_play
) {
953 pa_sink_assert_ref(s
);
954 pa_sink_assert_io_context(s
);
956 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
957 size_t uf
= i
->thread_info
.underrun_for_sink
;
960 if (uf
>= left_to_play
) {
961 if (pa_sink_input_process_underrun(i
))
964 else if (uf
> result
)
969 pa_log_debug("Found underrun %ld bytes ago (%ld bytes ahead in playback buffer)", (long) result
, (long) left_to_play
- result
);
970 return left_to_play
- result
;
973 /* Called from IO thread context */
974 void pa_sink_process_rewind(pa_sink
*s
, size_t nbytes
) {
978 pa_sink_assert_ref(s
);
979 pa_sink_assert_io_context(s
);
980 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
982 /* If nobody requested this and this is actually no real rewind
983 * then we can short cut this. Please note that this means that
984 * not all rewind requests triggered upstream will always be
985 * translated in actual requests! */
986 if (!s
->thread_info
.rewind_requested
&& nbytes
<= 0)
989 s
->thread_info
.rewind_nbytes
= 0;
990 s
->thread_info
.rewind_requested
= false;
993 pa_log_debug("Processing rewind...");
994 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
995 pa_sink_volume_change_rewind(s
, nbytes
);
998 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
999 pa_sink_input_assert_ref(i
);
1000 pa_sink_input_process_rewind(i
, nbytes
);
1004 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
1005 pa_source_process_rewind(s
->monitor_source
, nbytes
);
1009 /* Called from IO thread context */
1010 static unsigned fill_mix_info(pa_sink
*s
, size_t *length
, pa_mix_info
*info
, unsigned maxinfo
) {
1014 size_t mixlength
= *length
;
1016 pa_sink_assert_ref(s
);
1017 pa_sink_assert_io_context(s
);
1020 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)) && maxinfo
> 0) {
1021 pa_sink_input_assert_ref(i
);
1023 pa_sink_input_peek(i
, *length
, &info
->chunk
, &info
->volume
);
1025 if (mixlength
== 0 || info
->chunk
.length
< mixlength
)
1026 mixlength
= info
->chunk
.length
;
1028 if (pa_memblock_is_silence(info
->chunk
.memblock
)) {
1029 pa_memblock_unref(info
->chunk
.memblock
);
1033 info
->userdata
= pa_sink_input_ref(i
);
1035 pa_assert(info
->chunk
.memblock
);
1036 pa_assert(info
->chunk
.length
> 0);
1044 *length
= mixlength
;
1049 /* Called from IO thread context */
1050 static void inputs_drop(pa_sink
*s
, pa_mix_info
*info
, unsigned n
, pa_memchunk
*result
) {
1054 unsigned n_unreffed
= 0;
1056 pa_sink_assert_ref(s
);
1057 pa_sink_assert_io_context(s
);
1059 pa_assert(result
->memblock
);
1060 pa_assert(result
->length
> 0);
1062 /* We optimize for the case where the order of the inputs has not changed */
1064 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
1066 pa_mix_info
* m
= NULL
;
1068 pa_sink_input_assert_ref(i
);
1070 /* Let's try to find the matching entry info the pa_mix_info array */
1071 for (j
= 0; j
< n
; j
++) {
1073 if (info
[p
].userdata
== i
) {
1083 /* Drop read data */
1084 pa_sink_input_drop(i
, result
->length
);
1086 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
)) {
1088 if (pa_hashmap_size(i
->thread_info
.direct_outputs
) > 0) {
1089 void *ostate
= NULL
;
1090 pa_source_output
*o
;
1093 if (m
&& m
->chunk
.memblock
) {
1095 pa_memblock_ref(c
.memblock
);
1096 pa_assert(result
->length
<= c
.length
);
1097 c
.length
= result
->length
;
1099 pa_memchunk_make_writable(&c
, 0);
1100 pa_volume_memchunk(&c
, &s
->sample_spec
, &m
->volume
);
1103 pa_memblock_ref(c
.memblock
);
1104 pa_assert(result
->length
<= c
.length
);
1105 c
.length
= result
->length
;
1108 while ((o
= pa_hashmap_iterate(i
->thread_info
.direct_outputs
, &ostate
, NULL
))) {
1109 pa_source_output_assert_ref(o
);
1110 pa_assert(o
->direct_on_input
== i
);
1111 pa_source_post_direct(s
->monitor_source
, o
, &c
);
1114 pa_memblock_unref(c
.memblock
);
1119 if (m
->chunk
.memblock
) {
1120 pa_memblock_unref(m
->chunk
.memblock
);
1121 pa_memchunk_reset(&m
->chunk
);
1124 pa_sink_input_unref(m
->userdata
);
1131 /* Now drop references to entries that are included in the
1132 * pa_mix_info array but don't exist anymore */
1134 if (n_unreffed
< n
) {
1135 for (; n
> 0; info
++, n
--) {
1137 pa_sink_input_unref(info
->userdata
);
1138 if (info
->chunk
.memblock
)
1139 pa_memblock_unref(info
->chunk
.memblock
);
1143 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
1144 pa_source_post(s
->monitor_source
, result
);
1147 /* Called from IO thread context */
1148 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1149 pa_mix_info info
[MAX_MIX_CHANNELS
];
1151 size_t block_size_max
;
1153 pa_sink_assert_ref(s
);
1154 pa_sink_assert_io_context(s
);
1155 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1156 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1159 pa_assert(!s
->thread_info
.rewind_requested
);
1160 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1162 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1163 result
->memblock
= pa_memblock_ref(s
->silence
.memblock
);
1164 result
->index
= s
->silence
.index
;
1165 result
->length
= PA_MIN(s
->silence
.length
, length
);
1172 length
= pa_frame_align(MIX_BUFFER_LENGTH
, &s
->sample_spec
);
1174 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1175 if (length
> block_size_max
)
1176 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1178 pa_assert(length
> 0);
1180 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1184 *result
= s
->silence
;
1185 pa_memblock_ref(result
->memblock
);
1187 if (result
->length
> length
)
1188 result
->length
= length
;
1190 } else if (n
== 1) {
1193 *result
= info
[0].chunk
;
1194 pa_memblock_ref(result
->memblock
);
1196 if (result
->length
> length
)
1197 result
->length
= length
;
1199 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1201 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
)) {
1202 pa_memblock_unref(result
->memblock
);
1203 pa_silence_memchunk_get(&s
->core
->silence_cache
,
1208 } else if (!pa_cvolume_is_norm(&volume
)) {
1209 pa_memchunk_make_writable(result
, 0);
1210 pa_volume_memchunk(result
, &s
->sample_spec
, &volume
);
1214 result
->memblock
= pa_memblock_new(s
->core
->mempool
, length
);
1216 ptr
= pa_memblock_acquire(result
->memblock
);
1217 result
->length
= pa_mix(info
, n
,
1220 &s
->thread_info
.soft_volume
,
1221 s
->thread_info
.soft_muted
);
1222 pa_memblock_release(result
->memblock
);
1227 inputs_drop(s
, info
, n
, result
);
1232 /* Called from IO thread context */
1233 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
) {
1234 pa_mix_info info
[MAX_MIX_CHANNELS
];
1236 size_t length
, block_size_max
;
1238 pa_sink_assert_ref(s
);
1239 pa_sink_assert_io_context(s
);
1240 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1242 pa_assert(target
->memblock
);
1243 pa_assert(target
->length
> 0);
1244 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1246 pa_assert(!s
->thread_info
.rewind_requested
);
1247 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1249 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1250 pa_silence_memchunk(target
, &s
->sample_spec
);
1256 length
= target
->length
;
1257 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1258 if (length
> block_size_max
)
1259 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1261 pa_assert(length
> 0);
1263 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1266 if (target
->length
> length
)
1267 target
->length
= length
;
1269 pa_silence_memchunk(target
, &s
->sample_spec
);
1270 } else if (n
== 1) {
1273 if (target
->length
> length
)
1274 target
->length
= length
;
1276 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1278 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
))
1279 pa_silence_memchunk(target
, &s
->sample_spec
);
1283 vchunk
= info
[0].chunk
;
1284 pa_memblock_ref(vchunk
.memblock
);
1286 if (vchunk
.length
> length
)
1287 vchunk
.length
= length
;
1289 if (!pa_cvolume_is_norm(&volume
)) {
1290 pa_memchunk_make_writable(&vchunk
, 0);
1291 pa_volume_memchunk(&vchunk
, &s
->sample_spec
, &volume
);
1294 pa_memchunk_memcpy(target
, &vchunk
);
1295 pa_memblock_unref(vchunk
.memblock
);
1301 ptr
= pa_memblock_acquire(target
->memblock
);
1303 target
->length
= pa_mix(info
, n
,
1304 (uint8_t*) ptr
+ target
->index
, length
,
1306 &s
->thread_info
.soft_volume
,
1307 s
->thread_info
.soft_muted
);
1309 pa_memblock_release(target
->memblock
);
1312 inputs_drop(s
, info
, n
, target
);
1317 /* Called from IO thread context */
1318 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
) {
1322 pa_sink_assert_ref(s
);
1323 pa_sink_assert_io_context(s
);
1324 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1326 pa_assert(target
->memblock
);
1327 pa_assert(target
->length
> 0);
1328 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1330 pa_assert(!s
->thread_info
.rewind_requested
);
1331 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1333 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1334 pa_silence_memchunk(target
, &s
->sample_spec
);
1347 pa_sink_render_into(s
, &chunk
);
1356 /* Called from IO thread context */
1357 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1358 pa_sink_assert_ref(s
);
1359 pa_sink_assert_io_context(s
);
1360 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1361 pa_assert(length
> 0);
1362 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1365 pa_assert(!s
->thread_info
.rewind_requested
);
1366 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1370 pa_sink_render(s
, length
, result
);
1372 if (result
->length
< length
) {
1375 pa_memchunk_make_writable(result
, length
);
1377 chunk
.memblock
= result
->memblock
;
1378 chunk
.index
= result
->index
+ result
->length
;
1379 chunk
.length
= length
- result
->length
;
1381 pa_sink_render_into_full(s
, &chunk
);
1383 result
->length
= length
;
1389 /* Called from main thread */
1390 int pa_sink_update_rate(pa_sink
*s
, uint32_t rate
, bool passthrough
) {
1392 uint32_t desired_rate
= rate
;
1393 uint32_t default_rate
= s
->default_sample_rate
;
1394 uint32_t alternate_rate
= s
->alternate_sample_rate
;
1397 bool use_alternate
= false;
1399 if (rate
== s
->sample_spec
.rate
)
1402 if (!s
->update_rate
)
1405 if (PA_UNLIKELY(default_rate
== alternate_rate
&& !passthrough
)) {
1406 pa_log_debug("Default and alternate sample rates are the same.");
1410 if (PA_SINK_IS_RUNNING(s
->state
)) {
1411 pa_log_info("Cannot update rate, SINK_IS_RUNNING, will keep using %u Hz",
1412 s
->sample_spec
.rate
);
1416 if (s
->monitor_source
) {
1417 if (PA_SOURCE_IS_RUNNING(s
->monitor_source
->state
) == true) {
1418 pa_log_info("Cannot update rate, monitor source is RUNNING");
1423 if (PA_UNLIKELY(!pa_sample_rate_valid(desired_rate
)))
1427 pa_assert((default_rate
% 4000 == 0) || (default_rate
% 11025 == 0));
1428 pa_assert((alternate_rate
% 4000 == 0) || (alternate_rate
% 11025 == 0));
1430 if (default_rate
% 11025 == 0) {
1431 if ((alternate_rate
% 4000 == 0) && (desired_rate
% 4000 == 0))
1434 /* default is 4000 multiple */
1435 if ((alternate_rate
% 11025 == 0) && (desired_rate
% 11025 == 0))
1440 desired_rate
= alternate_rate
;
1442 desired_rate
= default_rate
;
1444 desired_rate
= rate
; /* use stream sampling rate, discard default/alternate settings */
1447 if (desired_rate
== s
->sample_spec
.rate
)
1450 if (!passthrough
&& pa_sink_used_by(s
) > 0)
1453 pa_log_debug("Suspending sink %s due to changing the sample rate.", s
->name
);
1454 pa_sink_suspend(s
, true, PA_SUSPEND_INTERNAL
);
1456 if (s
->update_rate(s
, desired_rate
) >= 0) {
1457 /* update monitor source as well */
1458 if (s
->monitor_source
&& !passthrough
)
1459 pa_source_update_rate(s
->monitor_source
, desired_rate
, false);
1460 pa_log_info("Changed sampling rate successfully");
1462 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1463 if (i
->state
== PA_SINK_INPUT_CORKED
)
1464 pa_sink_input_update_rate(i
);
1470 pa_sink_suspend(s
, false, PA_SUSPEND_INTERNAL
);
1475 /* Called from main thread */
1476 pa_usec_t
pa_sink_get_latency(pa_sink
*s
) {
1479 pa_sink_assert_ref(s
);
1480 pa_assert_ctl_context();
1481 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1483 /* The returned value is supposed to be in the time domain of the sound card! */
1485 if (s
->state
== PA_SINK_SUSPENDED
)
1488 if (!(s
->flags
& PA_SINK_LATENCY
))
1491 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) == 0);
1493 /* usec is unsigned, so check that the offset can be added to usec without
1495 if (-s
->latency_offset
<= (int64_t) usec
)
1496 usec
+= s
->latency_offset
;
1503 /* Called from IO thread */
1504 pa_usec_t
pa_sink_get_latency_within_thread(pa_sink
*s
) {
1508 pa_sink_assert_ref(s
);
1509 pa_sink_assert_io_context(s
);
1510 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1512 /* The returned value is supposed to be in the time domain of the sound card! */
1514 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
1517 if (!(s
->flags
& PA_SINK_LATENCY
))
1520 o
= PA_MSGOBJECT(s
);
1522 /* FIXME: We probably should make this a proper vtable callback instead of going through process_msg() */
1524 if (o
->process_msg(o
, PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) < 0)
1527 /* usec is unsigned, so check that the offset can be added to usec without
1529 if (-s
->thread_info
.latency_offset
<= (int64_t) usec
)
1530 usec
+= s
->thread_info
.latency_offset
;
1537 /* Called from the main thread (and also from the IO thread while the main
1538 * thread is waiting).
1540 * When a sink uses volume sharing, it never has the PA_SINK_FLAT_VOLUME flag
1541 * set. Instead, flat volume mode is detected by checking whether the root sink
1542 * has the flag set. */
1543 bool pa_sink_flat_volume_enabled(pa_sink
*s
) {
1544 pa_sink_assert_ref(s
);
1546 s
= pa_sink_get_master(s
);
1549 return (s
->flags
& PA_SINK_FLAT_VOLUME
);
1554 /* Called from the main thread (and also from the IO thread while the main
1555 * thread is waiting). */
1556 pa_sink
*pa_sink_get_master(pa_sink
*s
) {
1557 pa_sink_assert_ref(s
);
1559 while (s
&& (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1560 if (PA_UNLIKELY(!s
->input_to_master
))
1563 s
= s
->input_to_master
->sink
;
1569 /* Called from main context */
1570 bool pa_sink_is_passthrough(pa_sink
*s
) {
1571 pa_sink_input
*alt_i
;
1574 pa_sink_assert_ref(s
);
1576 /* one and only one PASSTHROUGH input can possibly be connected */
1577 if (pa_idxset_size(s
->inputs
) == 1) {
1578 alt_i
= pa_idxset_first(s
->inputs
, &idx
);
1580 if (pa_sink_input_is_passthrough(alt_i
))
1587 /* Called from main context */
1588 void pa_sink_enter_passthrough(pa_sink
*s
) {
1591 /* disable the monitor in passthrough mode */
1592 if (s
->monitor_source
) {
1593 pa_log_debug("Suspending monitor source %s, because the sink is entering the passthrough mode.", s
->monitor_source
->name
);
1594 pa_source_suspend(s
->monitor_source
, true, PA_SUSPEND_PASSTHROUGH
);
1597 /* set the volume to NORM */
1598 s
->saved_volume
= *pa_sink_get_volume(s
, true);
1599 s
->saved_save_volume
= s
->save_volume
;
1601 pa_cvolume_set(&volume
, s
->sample_spec
.channels
, PA_MIN(s
->base_volume
, PA_VOLUME_NORM
));
1602 pa_sink_set_volume(s
, &volume
, true, false);
1605 /* Called from main context */
1606 void pa_sink_leave_passthrough(pa_sink
*s
) {
1607 /* Unsuspend monitor */
1608 if (s
->monitor_source
) {
1609 pa_log_debug("Resuming monitor source %s, because the sink is leaving the passthrough mode.", s
->monitor_source
->name
);
1610 pa_source_suspend(s
->monitor_source
, false, PA_SUSPEND_PASSTHROUGH
);
1613 /* Restore sink volume to what it was before we entered passthrough mode */
1614 pa_sink_set_volume(s
, &s
->saved_volume
, true, s
->saved_save_volume
);
1616 pa_cvolume_init(&s
->saved_volume
);
1617 s
->saved_save_volume
= false;
1620 /* Called from main context. */
1621 static void compute_reference_ratio(pa_sink_input
*i
) {
1623 pa_cvolume remapped
;
1626 pa_assert(pa_sink_flat_volume_enabled(i
->sink
));
1629 * Calculates the reference ratio from the sink's reference
1630 * volume. This basically calculates:
1632 * i->reference_ratio = i->volume / i->sink->reference_volume
1635 remapped
= i
->sink
->reference_volume
;
1636 pa_cvolume_remap(&remapped
, &i
->sink
->channel_map
, &i
->channel_map
);
1638 i
->reference_ratio
.channels
= i
->sample_spec
.channels
;
1640 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1642 /* We don't update when the sink volume is 0 anyway */
1643 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
)
1646 /* Don't update the reference ratio unless necessary */
1647 if (pa_sw_volume_multiply(
1648 i
->reference_ratio
.values
[c
],
1649 remapped
.values
[c
]) == i
->volume
.values
[c
])
1652 i
->reference_ratio
.values
[c
] = pa_sw_volume_divide(
1653 i
->volume
.values
[c
],
1654 remapped
.values
[c
]);
1658 /* Called from main context. Only called for the root sink in volume sharing
1659 * cases, except for internal recursive calls. */
1660 static void compute_reference_ratios(pa_sink
*s
) {
1664 pa_sink_assert_ref(s
);
1665 pa_assert_ctl_context();
1666 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1667 pa_assert(pa_sink_flat_volume_enabled(s
));
1669 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1670 compute_reference_ratio(i
);
1672 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1673 compute_reference_ratios(i
->origin_sink
);
1677 /* Called from main context. Only called for the root sink in volume sharing
1678 * cases, except for internal recursive calls. */
1679 static void compute_real_ratios(pa_sink
*s
) {
1683 pa_sink_assert_ref(s
);
1684 pa_assert_ctl_context();
1685 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1686 pa_assert(pa_sink_flat_volume_enabled(s
));
1688 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1690 pa_cvolume remapped
;
1692 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1693 /* The origin sink uses volume sharing, so this input's real ratio
1694 * is handled as a special case - the real ratio must be 0 dB, and
1695 * as a result i->soft_volume must equal i->volume_factor. */
1696 pa_cvolume_reset(&i
->real_ratio
, i
->real_ratio
.channels
);
1697 i
->soft_volume
= i
->volume_factor
;
1699 compute_real_ratios(i
->origin_sink
);
1705 * This basically calculates:
1707 * i->real_ratio := i->volume / s->real_volume
1708 * i->soft_volume := i->real_ratio * i->volume_factor
1711 remapped
= s
->real_volume
;
1712 pa_cvolume_remap(&remapped
, &s
->channel_map
, &i
->channel_map
);
1714 i
->real_ratio
.channels
= i
->sample_spec
.channels
;
1715 i
->soft_volume
.channels
= i
->sample_spec
.channels
;
1717 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1719 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
) {
1720 /* We leave i->real_ratio untouched */
1721 i
->soft_volume
.values
[c
] = PA_VOLUME_MUTED
;
1725 /* Don't lose accuracy unless necessary */
1726 if (pa_sw_volume_multiply(
1727 i
->real_ratio
.values
[c
],
1728 remapped
.values
[c
]) != i
->volume
.values
[c
])
1730 i
->real_ratio
.values
[c
] = pa_sw_volume_divide(
1731 i
->volume
.values
[c
],
1732 remapped
.values
[c
]);
1734 i
->soft_volume
.values
[c
] = pa_sw_volume_multiply(
1735 i
->real_ratio
.values
[c
],
1736 i
->volume_factor
.values
[c
]);
1739 /* We don't copy the soft_volume to the thread_info data
1740 * here. That must be done by the caller */
1744 static pa_cvolume
*cvolume_remap_minimal_impact(
1746 const pa_cvolume
*template,
1747 const pa_channel_map
*from
,
1748 const pa_channel_map
*to
) {
1753 pa_assert(template);
1756 pa_assert(pa_cvolume_compatible_with_channel_map(v
, from
));
1757 pa_assert(pa_cvolume_compatible_with_channel_map(template, to
));
1759 /* Much like pa_cvolume_remap(), but tries to minimize impact when
1760 * mapping from sink input to sink volumes:
1762 * If template is a possible remapping from v it is used instead
1763 * of remapping anew.
1765 * If the channel maps don't match we set an all-channel volume on
1766 * the sink to ensure that changing a volume on one stream has no
1767 * effect that cannot be compensated for in another stream that
1768 * does not have the same channel map as the sink. */
1770 if (pa_channel_map_equal(from
, to
))
1774 if (pa_cvolume_equal(pa_cvolume_remap(&t
, to
, from
), v
)) {
1779 pa_cvolume_set(v
, to
->channels
, pa_cvolume_max(v
));
1783 /* Called from main thread. Only called for the root sink in volume sharing
1784 * cases, except for internal recursive calls. */
1785 static void get_maximum_input_volume(pa_sink
*s
, pa_cvolume
*max_volume
, const pa_channel_map
*channel_map
) {
1789 pa_sink_assert_ref(s
);
1790 pa_assert(max_volume
);
1791 pa_assert(channel_map
);
1792 pa_assert(pa_sink_flat_volume_enabled(s
));
1794 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1795 pa_cvolume remapped
;
1797 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1798 get_maximum_input_volume(i
->origin_sink
, max_volume
, channel_map
);
1800 /* Ignore this input. The origin sink uses volume sharing, so this
1801 * input's volume will be set to be equal to the root sink's real
1802 * volume. Obviously this input's current volume must not then
1803 * affect what the root sink's real volume will be. */
1807 remapped
= i
->volume
;
1808 cvolume_remap_minimal_impact(&remapped
, max_volume
, &i
->channel_map
, channel_map
);
1809 pa_cvolume_merge(max_volume
, max_volume
, &remapped
);
1813 /* Called from main thread. Only called for the root sink in volume sharing
1814 * cases, except for internal recursive calls. */
1815 static bool has_inputs(pa_sink
*s
) {
1819 pa_sink_assert_ref(s
);
1821 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1822 if (!i
->origin_sink
|| !(i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) || has_inputs(i
->origin_sink
))
1829 /* Called from main thread. Only called for the root sink in volume sharing
1830 * cases, except for internal recursive calls. */
1831 static void update_real_volume(pa_sink
*s
, const pa_cvolume
*new_volume
, pa_channel_map
*channel_map
) {
1835 pa_sink_assert_ref(s
);
1836 pa_assert(new_volume
);
1837 pa_assert(channel_map
);
1839 s
->real_volume
= *new_volume
;
1840 pa_cvolume_remap(&s
->real_volume
, channel_map
, &s
->channel_map
);
1842 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1843 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1844 if (pa_sink_flat_volume_enabled(s
)) {
1845 pa_cvolume old_volume
= i
->volume
;
1847 /* Follow the root sink's real volume. */
1848 i
->volume
= *new_volume
;
1849 pa_cvolume_remap(&i
->volume
, channel_map
, &i
->channel_map
);
1850 compute_reference_ratio(i
);
1852 /* The volume changed, let's tell people so */
1853 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
1854 if (i
->volume_changed
)
1855 i
->volume_changed(i
);
1857 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1861 update_real_volume(i
->origin_sink
, new_volume
, channel_map
);
1866 /* Called from main thread. Only called for the root sink in shared volume
1868 static void compute_real_volume(pa_sink
*s
) {
1869 pa_sink_assert_ref(s
);
1870 pa_assert_ctl_context();
1871 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1872 pa_assert(pa_sink_flat_volume_enabled(s
));
1873 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
1875 /* This determines the maximum volume of all streams and sets
1876 * s->real_volume accordingly. */
1878 if (!has_inputs(s
)) {
1879 /* In the special case that we have no sink inputs we leave the
1880 * volume unmodified. */
1881 update_real_volume(s
, &s
->reference_volume
, &s
->channel_map
);
1885 pa_cvolume_mute(&s
->real_volume
, s
->channel_map
.channels
);
1887 /* First let's determine the new maximum volume of all inputs
1888 * connected to this sink */
1889 get_maximum_input_volume(s
, &s
->real_volume
, &s
->channel_map
);
1890 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
1892 /* Then, let's update the real ratios/soft volumes of all inputs
1893 * connected to this sink */
1894 compute_real_ratios(s
);
1897 /* Called from main thread. Only called for the root sink in shared volume
1898 * cases, except for internal recursive calls. */
1899 static void propagate_reference_volume(pa_sink
*s
) {
1903 pa_sink_assert_ref(s
);
1904 pa_assert_ctl_context();
1905 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1906 pa_assert(pa_sink_flat_volume_enabled(s
));
1908 /* This is called whenever the sink volume changes that is not
1909 * caused by a sink input volume change. We need to fix up the
1910 * sink input volumes accordingly */
1912 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1913 pa_cvolume old_volume
;
1915 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1916 propagate_reference_volume(i
->origin_sink
);
1918 /* Since the origin sink uses volume sharing, this input's volume
1919 * needs to be updated to match the root sink's real volume, but
1920 * that will be done later in update_shared_real_volume(). */
1924 old_volume
= i
->volume
;
1926 /* This basically calculates:
1928 * i->volume := s->reference_volume * i->reference_ratio */
1930 i
->volume
= s
->reference_volume
;
1931 pa_cvolume_remap(&i
->volume
, &s
->channel_map
, &i
->channel_map
);
1932 pa_sw_cvolume_multiply(&i
->volume
, &i
->volume
, &i
->reference_ratio
);
1934 /* The volume changed, let's tell people so */
1935 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
1937 if (i
->volume_changed
)
1938 i
->volume_changed(i
);
1940 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1945 /* Called from main thread. Only called for the root sink in volume sharing
1946 * cases, except for internal recursive calls. The return value indicates
1947 * whether any reference volume actually changed. */
1948 static bool update_reference_volume(pa_sink
*s
, const pa_cvolume
*v
, const pa_channel_map
*channel_map
, bool save
) {
1950 bool reference_volume_changed
;
1954 pa_sink_assert_ref(s
);
1955 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1957 pa_assert(channel_map
);
1958 pa_assert(pa_cvolume_valid(v
));
1961 pa_cvolume_remap(&volume
, channel_map
, &s
->channel_map
);
1963 reference_volume_changed
= !pa_cvolume_equal(&volume
, &s
->reference_volume
);
1964 s
->reference_volume
= volume
;
1966 s
->save_volume
= (!reference_volume_changed
&& s
->save_volume
) || save
;
1968 if (reference_volume_changed
)
1969 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
1970 else if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1971 /* If the root sink's volume doesn't change, then there can't be any
1972 * changes in the other sinks in the sink tree either.
1974 * It's probably theoretically possible that even if the root sink's
1975 * volume changes slightly, some filter sink doesn't change its volume
1976 * due to rounding errors. If that happens, we still want to propagate
1977 * the changed root sink volume to the sinks connected to the
1978 * intermediate sink that didn't change its volume. This theoretical
1979 * possibility is the reason why we have that !(s->flags &
1980 * PA_SINK_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would
1981 * notice even if we returned here false always if
1982 * reference_volume_changed is false. */
1985 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1986 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1987 update_reference_volume(i
->origin_sink
, v
, channel_map
, false);
1993 /* Called from main thread */
1994 void pa_sink_set_volume(
1996 const pa_cvolume
*volume
,
2000 pa_cvolume new_reference_volume
;
2003 pa_sink_assert_ref(s
);
2004 pa_assert_ctl_context();
2005 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2006 pa_assert(!volume
|| pa_cvolume_valid(volume
));
2007 pa_assert(volume
|| pa_sink_flat_volume_enabled(s
));
2008 pa_assert(!volume
|| volume
->channels
== 1 || pa_cvolume_compatible(volume
, &s
->sample_spec
));
2010 /* make sure we don't change the volume when a PASSTHROUGH input is connected ...
2011 * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */
2012 if (pa_sink_is_passthrough(s
) && (!volume
|| !pa_cvolume_is_norm(volume
))) {
2013 pa_log_warn("Cannot change volume, Sink is connected to PASSTHROUGH input");
2017 /* In case of volume sharing, the volume is set for the root sink first,
2018 * from which it's then propagated to the sharing sinks. */
2019 root_sink
= pa_sink_get_master(s
);
2021 if (PA_UNLIKELY(!root_sink
))
2024 /* As a special exception we accept mono volumes on all sinks --
2025 * even on those with more complex channel maps */
2028 if (pa_cvolume_compatible(volume
, &s
->sample_spec
))
2029 new_reference_volume
= *volume
;
2031 new_reference_volume
= s
->reference_volume
;
2032 pa_cvolume_scale(&new_reference_volume
, pa_cvolume_max(volume
));
2035 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
2037 if (update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
)) {
2038 if (pa_sink_flat_volume_enabled(root_sink
)) {
2039 /* OK, propagate this volume change back to the inputs */
2040 propagate_reference_volume(root_sink
);
2042 /* And now recalculate the real volume */
2043 compute_real_volume(root_sink
);
2045 update_real_volume(root_sink
, &root_sink
->reference_volume
, &root_sink
->channel_map
);
2049 /* If volume is NULL we synchronize the sink's real and
2050 * reference volumes with the stream volumes. */
2052 pa_assert(pa_sink_flat_volume_enabled(root_sink
));
2054 /* Ok, let's determine the new real volume */
2055 compute_real_volume(root_sink
);
2057 /* Let's 'push' the reference volume if necessary */
2058 pa_cvolume_merge(&new_reference_volume
, &s
->reference_volume
, &root_sink
->real_volume
);
2059 /* If the sink and its root don't have the same number of channels, we need to remap */
2060 if (s
!= root_sink
&& !pa_channel_map_equal(&s
->channel_map
, &root_sink
->channel_map
))
2061 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
2062 update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
);
2064 /* Now that the reference volume is updated, we can update the streams'
2065 * reference ratios. */
2066 compute_reference_ratios(root_sink
);
2069 if (root_sink
->set_volume
) {
2070 /* If we have a function set_volume(), then we do not apply a
2071 * soft volume by default. However, set_volume() is free to
2072 * apply one to root_sink->soft_volume */
2074 pa_cvolume_reset(&root_sink
->soft_volume
, root_sink
->sample_spec
.channels
);
2075 if (!(root_sink
->flags
& PA_SINK_DEFERRED_VOLUME
))
2076 root_sink
->set_volume(root_sink
);
2079 /* If we have no function set_volume(), then the soft volume
2080 * becomes the real volume */
2081 root_sink
->soft_volume
= root_sink
->real_volume
;
2083 /* This tells the sink that soft volume and/or real volume changed */
2085 pa_assert_se(pa_asyncmsgq_send(root_sink
->asyncmsgq
, PA_MSGOBJECT(root_sink
), PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
) == 0);
2088 /* Called from the io thread if sync volume is used, otherwise from the main thread.
2089 * Only to be called by sink implementor */
2090 void pa_sink_set_soft_volume(pa_sink
*s
, const pa_cvolume
*volume
) {
2092 pa_sink_assert_ref(s
);
2093 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2095 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
2096 pa_sink_assert_io_context(s
);
2098 pa_assert_ctl_context();
2101 pa_cvolume_reset(&s
->soft_volume
, s
->sample_spec
.channels
);
2103 s
->soft_volume
= *volume
;
2105 if (PA_SINK_IS_LINKED(s
->state
) && !(s
->flags
& PA_SINK_DEFERRED_VOLUME
))
2106 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME
, NULL
, 0, NULL
) == 0);
2108 s
->thread_info
.soft_volume
= s
->soft_volume
;
2111 /* Called from the main thread. Only called for the root sink in volume sharing
2112 * cases, except for internal recursive calls. */
2113 static void propagate_real_volume(pa_sink
*s
, const pa_cvolume
*old_real_volume
) {
2117 pa_sink_assert_ref(s
);
2118 pa_assert(old_real_volume
);
2119 pa_assert_ctl_context();
2120 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2122 /* This is called when the hardware's real volume changes due to
2123 * some external event. We copy the real volume into our
2124 * reference volume and then rebuild the stream volumes based on
2125 * i->real_ratio which should stay fixed. */
2127 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
2128 if (pa_cvolume_equal(old_real_volume
, &s
->real_volume
))
2131 /* 1. Make the real volume the reference volume */
2132 update_reference_volume(s
, &s
->real_volume
, &s
->channel_map
, true);
2135 if (pa_sink_flat_volume_enabled(s
)) {
2137 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2138 pa_cvolume old_volume
= i
->volume
;
2140 /* 2. Since the sink's reference and real volumes are equal
2141 * now our ratios should be too. */
2142 i
->reference_ratio
= i
->real_ratio
;
2144 /* 3. Recalculate the new stream reference volume based on the
2145 * reference ratio and the sink's reference volume.
2147 * This basically calculates:
2149 * i->volume = s->reference_volume * i->reference_ratio
2151 * This is identical to propagate_reference_volume() */
2152 i
->volume
= s
->reference_volume
;
2153 pa_cvolume_remap(&i
->volume
, &s
->channel_map
, &i
->channel_map
);
2154 pa_sw_cvolume_multiply(&i
->volume
, &i
->volume
, &i
->reference_ratio
);
2156 /* Notify if something changed */
2157 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
2159 if (i
->volume_changed
)
2160 i
->volume_changed(i
);
2162 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
2165 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2166 propagate_real_volume(i
->origin_sink
, old_real_volume
);
2170 /* Something got changed in the hardware. It probably makes sense
2171 * to save changed hw settings given that hw volume changes not
2172 * triggered by PA are almost certainly done by the user. */
2173 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2174 s
->save_volume
= true;
2177 /* Called from io thread */
2178 void pa_sink_update_volume_and_mute(pa_sink
*s
) {
2180 pa_sink_assert_io_context(s
);
2182 pa_asyncmsgq_post(pa_thread_mq_get()->outq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
, NULL
, 0, NULL
, NULL
);
2185 /* Called from main thread */
2186 const pa_cvolume
*pa_sink_get_volume(pa_sink
*s
, bool force_refresh
) {
2187 pa_sink_assert_ref(s
);
2188 pa_assert_ctl_context();
2189 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2191 if (s
->refresh_volume
|| force_refresh
) {
2192 struct pa_cvolume old_real_volume
;
2194 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2196 old_real_volume
= s
->real_volume
;
2198 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
)
2201 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_VOLUME
, NULL
, 0, NULL
) == 0);
2203 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
2204 propagate_real_volume(s
, &old_real_volume
);
2207 return &s
->reference_volume
;
2210 /* Called from main thread. In volume sharing cases, only the root sink may
2212 void pa_sink_volume_changed(pa_sink
*s
, const pa_cvolume
*new_real_volume
) {
2213 pa_cvolume old_real_volume
;
2215 pa_sink_assert_ref(s
);
2216 pa_assert_ctl_context();
2217 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2218 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2220 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2222 old_real_volume
= s
->real_volume
;
2223 update_real_volume(s
, new_real_volume
, &s
->channel_map
);
2224 propagate_real_volume(s
, &old_real_volume
);
2227 /* Called from main thread */
2228 void pa_sink_set_mute(pa_sink
*s
, bool mute
, bool save
) {
2231 pa_sink_assert_ref(s
);
2232 pa_assert_ctl_context();
2233 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2235 old_muted
= s
->muted
;
2237 s
->save_muted
= (old_muted
== s
->muted
&& s
->save_muted
) || save
;
2239 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->set_mute
)
2242 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2244 if (old_muted
!= s
->muted
)
2245 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2248 /* Called from main thread */
2249 bool pa_sink_get_mute(pa_sink
*s
, bool force_refresh
) {
2251 pa_sink_assert_ref(s
);
2252 pa_assert_ctl_context();
2253 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2255 if (s
->refresh_muted
|| force_refresh
) {
2256 bool old_muted
= s
->muted
;
2258 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_mute
)
2261 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MUTE
, NULL
, 0, NULL
) == 0);
2263 if (old_muted
!= s
->muted
) {
2264 s
->save_muted
= true;
2266 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2268 /* Make sure the soft mute status stays in sync */
2269 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2276 /* Called from main thread */
2277 void pa_sink_mute_changed(pa_sink
*s
, bool new_muted
) {
2278 pa_sink_assert_ref(s
);
2279 pa_assert_ctl_context();
2280 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2282 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2284 if (s
->muted
== new_muted
)
2287 s
->muted
= new_muted
;
2288 s
->save_muted
= true;
2290 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2293 /* Called from main thread */
2294 bool pa_sink_update_proplist(pa_sink
*s
, pa_update_mode_t mode
, pa_proplist
*p
) {
2295 pa_sink_assert_ref(s
);
2296 pa_assert_ctl_context();
2299 pa_proplist_update(s
->proplist
, mode
, p
);
2301 if (PA_SINK_IS_LINKED(s
->state
)) {
2302 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2303 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2309 /* Called from main thread */
2310 /* FIXME -- this should be dropped and be merged into pa_sink_update_proplist() */
2311 void pa_sink_set_description(pa_sink
*s
, const char *description
) {
2313 pa_sink_assert_ref(s
);
2314 pa_assert_ctl_context();
2316 if (!description
&& !pa_proplist_contains(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
))
2319 old
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2321 if (old
&& description
&& pa_streq(old
, description
))
2325 pa_proplist_sets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
, description
);
2327 pa_proplist_unset(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2329 if (s
->monitor_source
) {
2332 n
= pa_sprintf_malloc("Monitor Source of %s", description
? description
: s
->name
);
2333 pa_source_set_description(s
->monitor_source
, n
);
2337 if (PA_SINK_IS_LINKED(s
->state
)) {
2338 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2339 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2343 /* Called from main thread */
2344 unsigned pa_sink_linked_by(pa_sink
*s
) {
2347 pa_sink_assert_ref(s
);
2348 pa_assert_ctl_context();
2349 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2351 ret
= pa_idxset_size(s
->inputs
);
2353 /* We add in the number of streams connected to us here. Please
2354 * note the asymmetry to pa_sink_used_by()! */
2356 if (s
->monitor_source
)
2357 ret
+= pa_source_linked_by(s
->monitor_source
);
2362 /* Called from main thread */
2363 unsigned pa_sink_used_by(pa_sink
*s
) {
2366 pa_sink_assert_ref(s
);
2367 pa_assert_ctl_context();
2368 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2370 ret
= pa_idxset_size(s
->inputs
);
2371 pa_assert(ret
>= s
->n_corked
);
2373 /* Streams connected to our monitor source do not matter for
2374 * pa_sink_used_by()!.*/
2376 return ret
- s
->n_corked
;
2379 /* Called from main thread */
2380 unsigned pa_sink_check_suspend(pa_sink
*s
) {
2385 pa_sink_assert_ref(s
);
2386 pa_assert_ctl_context();
2388 if (!PA_SINK_IS_LINKED(s
->state
))
2393 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2394 pa_sink_input_state_t st
;
2396 st
= pa_sink_input_get_state(i
);
2398 /* We do not assert here. It is perfectly valid for a sink input to
2399 * be in the INIT state (i.e. created, marked done but not yet put)
2400 * and we should not care if it's unlinked as it won't contribute
2401 * towards our busy status.
2403 if (!PA_SINK_INPUT_IS_LINKED(st
))
2406 if (st
== PA_SINK_INPUT_CORKED
)
2409 if (i
->flags
& PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND
)
2415 if (s
->monitor_source
)
2416 ret
+= pa_source_check_suspend(s
->monitor_source
);
2421 /* Called from the IO thread */
2422 static void sync_input_volumes_within_thread(pa_sink
*s
) {
2426 pa_sink_assert_ref(s
);
2427 pa_sink_assert_io_context(s
);
2429 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2430 if (pa_cvolume_equal(&i
->thread_info
.soft_volume
, &i
->soft_volume
))
2433 i
->thread_info
.soft_volume
= i
->soft_volume
;
2434 pa_sink_input_request_rewind(i
, 0, true, false, false);
2438 /* Called from the IO thread. Only called for the root sink in volume sharing
2439 * cases, except for internal recursive calls. */
2440 static void set_shared_volume_within_thread(pa_sink
*s
) {
2441 pa_sink_input
*i
= NULL
;
2444 pa_sink_assert_ref(s
);
2446 PA_MSGOBJECT(s
)->process_msg(PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME_SYNCED
, NULL
, 0, NULL
);
2448 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2449 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2450 set_shared_volume_within_thread(i
->origin_sink
);
2454 /* Called from IO thread, except when it is not */
2455 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
2456 pa_sink
*s
= PA_SINK(o
);
2457 pa_sink_assert_ref(s
);
2459 switch ((pa_sink_message_t
) code
) {
2461 case PA_SINK_MESSAGE_ADD_INPUT
: {
2462 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2464 /* If you change anything here, make sure to change the
2465 * sink input handling a few lines down at
2466 * PA_SINK_MESSAGE_FINISH_MOVE, too. */
2468 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2470 /* Since the caller sleeps in pa_sink_input_put(), we can
2471 * safely access data outside of thread_info even though
2474 if ((i
->thread_info
.sync_prev
= i
->sync_prev
)) {
2475 pa_assert(i
->sink
== i
->thread_info
.sync_prev
->sink
);
2476 pa_assert(i
->sync_prev
->sync_next
== i
);
2477 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
;
2480 if ((i
->thread_info
.sync_next
= i
->sync_next
)) {
2481 pa_assert(i
->sink
== i
->thread_info
.sync_next
->sink
);
2482 pa_assert(i
->sync_next
->sync_prev
== i
);
2483 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
;
2486 pa_assert(!i
->thread_info
.attached
);
2487 i
->thread_info
.attached
= true;
2492 pa_sink_input_set_state_within_thread(i
, i
->state
);
2494 /* The requested latency of the sink input needs to be fixed up and
2495 * then configured on the sink. If this causes the sink latency to
2496 * go down, the sink implementor is responsible for doing a rewind
2497 * in the update_requested_latency() callback to ensure that the
2498 * sink buffer doesn't contain more data than what the new latency
2501 * XXX: Does it really make sense to push this responsibility to
2502 * the sink implementors? Wouldn't it be better to do it once in
2503 * the core than many times in the modules? */
2505 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2506 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2508 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2509 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2511 /* We don't rewind here automatically. This is left to the
2512 * sink input implementor because some sink inputs need a
2513 * slow start, i.e. need some time to buffer client
2514 * samples before beginning streaming.
2516 * XXX: Does it really make sense to push this functionality to
2517 * the sink implementors? Wouldn't it be better to do it once in
2518 * the core than many times in the modules? */
2520 /* In flat volume mode we need to update the volume as
2522 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2525 case PA_SINK_MESSAGE_REMOVE_INPUT
: {
2526 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2528 /* If you change anything here, make sure to change the
2529 * sink input handling a few lines down at
2530 * PA_SINK_MESSAGE_START_MOVE, too. */
2535 pa_sink_input_set_state_within_thread(i
, i
->state
);
2537 pa_assert(i
->thread_info
.attached
);
2538 i
->thread_info
.attached
= false;
2540 /* Since the caller sleeps in pa_sink_input_unlink(),
2541 * we can safely access data outside of thread_info even
2542 * though it is mutable */
2544 pa_assert(!i
->sync_prev
);
2545 pa_assert(!i
->sync_next
);
2547 if (i
->thread_info
.sync_prev
) {
2548 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
->thread_info
.sync_prev
->sync_next
;
2549 i
->thread_info
.sync_prev
= NULL
;
2552 if (i
->thread_info
.sync_next
) {
2553 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
->thread_info
.sync_next
->sync_prev
;
2554 i
->thread_info
.sync_next
= NULL
;
2557 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
2558 pa_sink_input_unref(i
);
2560 pa_sink_invalidate_requested_latency(s
, true);
2561 pa_sink_request_rewind(s
, (size_t) -1);
2563 /* In flat volume mode we need to update the volume as
2565 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2568 case PA_SINK_MESSAGE_START_MOVE
: {
2569 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2571 /* We don't support moving synchronized streams. */
2572 pa_assert(!i
->sync_prev
);
2573 pa_assert(!i
->sync_next
);
2574 pa_assert(!i
->thread_info
.sync_next
);
2575 pa_assert(!i
->thread_info
.sync_prev
);
2577 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2579 size_t sink_nbytes
, total_nbytes
;
2581 /* The old sink probably has some audio from this
2582 * stream in its buffer. We want to "take it back" as
2583 * much as possible and play it to the new sink. We
2584 * don't know at this point how much the old sink can
2585 * rewind. We have to pick something, and that
2586 * something is the full latency of the old sink here.
2587 * So we rewind the stream buffer by the sink latency
2588 * amount, which may be more than what we should
2589 * rewind. This can result in a chunk of audio being
2590 * played both to the old sink and the new sink.
2592 * FIXME: Fix this code so that we don't have to make
2593 * guesses about how much the sink will actually be
2594 * able to rewind. If someone comes up with a solution
2595 * for this, something to note is that the part of the
2596 * latency that the old sink couldn't rewind should
2597 * ideally be compensated after the stream has moved
2598 * to the new sink by adding silence. The new sink
2599 * most likely can't start playing the moved stream
2600 * immediately, and that gap should be removed from
2601 * the "compensation silence" (at least at the time of
2602 * writing this, the move finish code will actually
2603 * already take care of dropping the new sink's
2604 * unrewindable latency, so taking into account the
2605 * unrewindable latency of the old sink is the only
2608 * The render_memblockq contents are discarded,
2609 * because when the sink changes, the format of the
2610 * audio stored in the render_memblockq may change
2611 * too, making the stored audio invalid. FIXME:
2612 * However, the read and write indices are moved back
2613 * the same amount, so if they are not the same now,
2614 * they won't be the same after the rewind either. If
2615 * the write index of the render_memblockq is ahead of
2616 * the read index, then the render_memblockq will feed
2617 * the new sink some silence first, which it shouldn't
2618 * do. The write index should be flushed to be the
2619 * same as the read index. */
2621 /* Get the latency of the sink */
2622 usec
= pa_sink_get_latency_within_thread(s
);
2623 sink_nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2624 total_nbytes
= sink_nbytes
+ pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
2626 if (total_nbytes
> 0) {
2627 i
->thread_info
.rewrite_nbytes
= i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, total_nbytes
) : total_nbytes
;
2628 i
->thread_info
.rewrite_flush
= true;
2629 pa_sink_input_process_rewind(i
, sink_nbytes
);
2636 pa_assert(i
->thread_info
.attached
);
2637 i
->thread_info
.attached
= false;
2639 /* Let's remove the sink input ...*/
2640 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
2641 pa_sink_input_unref(i
);
2643 pa_sink_invalidate_requested_latency(s
, true);
2645 pa_log_debug("Requesting rewind due to started move");
2646 pa_sink_request_rewind(s
, (size_t) -1);
2648 /* In flat volume mode we need to update the volume as
2650 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2653 case PA_SINK_MESSAGE_FINISH_MOVE
: {
2654 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2656 /* We don't support moving synchronized streams. */
2657 pa_assert(!i
->sync_prev
);
2658 pa_assert(!i
->sync_next
);
2659 pa_assert(!i
->thread_info
.sync_next
);
2660 pa_assert(!i
->thread_info
.sync_prev
);
2662 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2664 pa_assert(!i
->thread_info
.attached
);
2665 i
->thread_info
.attached
= true;
2670 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2674 /* In the ideal case the new sink would start playing
2675 * the stream immediately. That requires the sink to
2676 * be able to rewind all of its latency, which usually
2677 * isn't possible, so there will probably be some gap
2678 * before the moved stream becomes audible. We then
2679 * have two possibilities: 1) start playing the stream
2680 * from where it is now, or 2) drop the unrewindable
2681 * latency of the sink from the stream. With option 1
2682 * we won't lose any audio but the stream will have a
2683 * pause. With option 2 we may lose some audio but the
2684 * stream time will be somewhat in sync with the wall
2685 * clock. Lennart seems to have chosen option 2 (one
2686 * of the reasons might have been that option 1 is
2687 * actually much harder to implement), so we drop the
2688 * latency of the new sink from the moved stream and
2689 * hope that the sink will undo most of that in the
2692 /* Get the latency of the sink */
2693 usec
= pa_sink_get_latency_within_thread(s
);
2694 nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2697 pa_sink_input_drop(i
, nbytes
);
2699 pa_log_debug("Requesting rewind due to finished move");
2700 pa_sink_request_rewind(s
, nbytes
);
2703 /* Updating the requested sink latency has to be done
2704 * after the sink rewind request, not before, because
2705 * otherwise the sink may limit the rewind amount
2708 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2709 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2711 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2712 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2714 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2717 case PA_SINK_MESSAGE_SET_SHARED_VOLUME
: {
2718 pa_sink
*root_sink
= pa_sink_get_master(s
);
2720 if (PA_LIKELY(root_sink
))
2721 set_shared_volume_within_thread(root_sink
);
2726 case PA_SINK_MESSAGE_SET_VOLUME_SYNCED
:
2728 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
2730 pa_sink_volume_change_push(s
);
2732 /* Fall through ... */
2734 case PA_SINK_MESSAGE_SET_VOLUME
:
2736 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2737 s
->thread_info
.soft_volume
= s
->soft_volume
;
2738 pa_sink_request_rewind(s
, (size_t) -1);
2741 /* Fall through ... */
2743 case PA_SINK_MESSAGE_SYNC_VOLUMES
:
2744 sync_input_volumes_within_thread(s
);
2747 case PA_SINK_MESSAGE_GET_VOLUME
:
2749 if ((s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
) {
2751 pa_sink_volume_change_flush(s
);
2752 pa_sw_cvolume_divide(&s
->thread_info
.current_hw_volume
, &s
->real_volume
, &s
->soft_volume
);
2755 /* In case sink implementor reset SW volume. */
2756 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2757 s
->thread_info
.soft_volume
= s
->soft_volume
;
2758 pa_sink_request_rewind(s
, (size_t) -1);
2763 case PA_SINK_MESSAGE_SET_MUTE
:
2765 if (s
->thread_info
.soft_muted
!= s
->muted
) {
2766 s
->thread_info
.soft_muted
= s
->muted
;
2767 pa_sink_request_rewind(s
, (size_t) -1);
2770 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->set_mute
)
2775 case PA_SINK_MESSAGE_GET_MUTE
:
2777 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->get_mute
)
2782 case PA_SINK_MESSAGE_SET_STATE
: {
2784 bool suspend_change
=
2785 (s
->thread_info
.state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(PA_PTR_TO_UINT(userdata
))) ||
2786 (PA_SINK_IS_OPENED(s
->thread_info
.state
) && PA_PTR_TO_UINT(userdata
) == PA_SINK_SUSPENDED
);
2788 s
->thread_info
.state
= PA_PTR_TO_UINT(userdata
);
2790 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
2791 s
->thread_info
.rewind_nbytes
= 0;
2792 s
->thread_info
.rewind_requested
= false;
2795 if (suspend_change
) {
2799 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
2800 if (i
->suspend_within_thread
)
2801 i
->suspend_within_thread(i
, s
->thread_info
.state
== PA_SINK_SUSPENDED
);
2807 case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
: {
2809 pa_usec_t
*usec
= userdata
;
2810 *usec
= pa_sink_get_requested_latency_within_thread(s
);
2812 /* Yes, that's right, the IO thread will see -1 when no
2813 * explicit requested latency is configured, the main
2814 * thread will see max_latency */
2815 if (*usec
== (pa_usec_t
) -1)
2816 *usec
= s
->thread_info
.max_latency
;
2821 case PA_SINK_MESSAGE_SET_LATENCY_RANGE
: {
2822 pa_usec_t
*r
= userdata
;
2824 pa_sink_set_latency_range_within_thread(s
, r
[0], r
[1]);
2829 case PA_SINK_MESSAGE_GET_LATENCY_RANGE
: {
2830 pa_usec_t
*r
= userdata
;
2832 r
[0] = s
->thread_info
.min_latency
;
2833 r
[1] = s
->thread_info
.max_latency
;
2838 case PA_SINK_MESSAGE_GET_FIXED_LATENCY
:
2840 *((pa_usec_t
*) userdata
) = s
->thread_info
.fixed_latency
;
2843 case PA_SINK_MESSAGE_SET_FIXED_LATENCY
:
2845 pa_sink_set_fixed_latency_within_thread(s
, (pa_usec_t
) offset
);
2848 case PA_SINK_MESSAGE_GET_MAX_REWIND
:
2850 *((size_t*) userdata
) = s
->thread_info
.max_rewind
;
2853 case PA_SINK_MESSAGE_GET_MAX_REQUEST
:
2855 *((size_t*) userdata
) = s
->thread_info
.max_request
;
2858 case PA_SINK_MESSAGE_SET_MAX_REWIND
:
2860 pa_sink_set_max_rewind_within_thread(s
, (size_t) offset
);
2863 case PA_SINK_MESSAGE_SET_MAX_REQUEST
:
2865 pa_sink_set_max_request_within_thread(s
, (size_t) offset
);
2868 case PA_SINK_MESSAGE_SET_PORT
:
2870 pa_assert(userdata
);
2872 struct sink_message_set_port
*msg_data
= userdata
;
2873 msg_data
->ret
= s
->set_port(s
, msg_data
->port
);
2877 case PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
:
2878 /* This message is sent from IO-thread and handled in main thread. */
2879 pa_assert_ctl_context();
2881 /* Make sure we're not messing with main thread when no longer linked */
2882 if (!PA_SINK_IS_LINKED(s
->state
))
2885 pa_sink_get_volume(s
, true);
2886 pa_sink_get_mute(s
, true);
2889 case PA_SINK_MESSAGE_SET_LATENCY_OFFSET
:
2890 s
->thread_info
.latency_offset
= offset
;
2893 case PA_SINK_MESSAGE_GET_LATENCY
:
2894 case PA_SINK_MESSAGE_MAX
:
2901 /* Called from main thread */
2902 int pa_sink_suspend_all(pa_core
*c
, bool suspend
, pa_suspend_cause_t cause
) {
2907 pa_core_assert_ref(c
);
2908 pa_assert_ctl_context();
2909 pa_assert(cause
!= 0);
2911 PA_IDXSET_FOREACH(sink
, c
->sinks
, idx
) {
2914 if ((r
= pa_sink_suspend(sink
, suspend
, cause
)) < 0)
2921 /* Called from IO thread */
2922 void pa_sink_detach_within_thread(pa_sink
*s
) {
2926 pa_sink_assert_ref(s
);
2927 pa_sink_assert_io_context(s
);
2928 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2930 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2934 if (s
->monitor_source
)
2935 pa_source_detach_within_thread(s
->monitor_source
);
2938 /* Called from IO thread */
2939 void pa_sink_attach_within_thread(pa_sink
*s
) {
2943 pa_sink_assert_ref(s
);
2944 pa_sink_assert_io_context(s
);
2945 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2947 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2951 if (s
->monitor_source
)
2952 pa_source_attach_within_thread(s
->monitor_source
);
2955 /* Called from IO thread */
2956 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
) {
2957 pa_sink_assert_ref(s
);
2958 pa_sink_assert_io_context(s
);
2959 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2961 if (nbytes
== (size_t) -1)
2962 nbytes
= s
->thread_info
.max_rewind
;
2964 nbytes
= PA_MIN(nbytes
, s
->thread_info
.max_rewind
);
2966 if (s
->thread_info
.rewind_requested
&&
2967 nbytes
<= s
->thread_info
.rewind_nbytes
)
2970 s
->thread_info
.rewind_nbytes
= nbytes
;
2971 s
->thread_info
.rewind_requested
= true;
2973 if (s
->request_rewind
)
2974 s
->request_rewind(s
);
2977 /* Called from IO thread */
2978 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
) {
2979 pa_usec_t result
= (pa_usec_t
) -1;
2982 pa_usec_t monitor_latency
;
2984 pa_sink_assert_ref(s
);
2985 pa_sink_assert_io_context(s
);
2987 if (!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
2988 return PA_CLAMP(s
->thread_info
.fixed_latency
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
2990 if (s
->thread_info
.requested_latency_valid
)
2991 return s
->thread_info
.requested_latency
;
2993 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2994 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1 &&
2995 (result
== (pa_usec_t
) -1 || result
> i
->thread_info
.requested_sink_latency
))
2996 result
= i
->thread_info
.requested_sink_latency
;
2998 monitor_latency
= pa_source_get_requested_latency_within_thread(s
->monitor_source
);
3000 if (monitor_latency
!= (pa_usec_t
) -1 &&
3001 (result
== (pa_usec_t
) -1 || result
> monitor_latency
))
3002 result
= monitor_latency
;
3004 if (result
!= (pa_usec_t
) -1)
3005 result
= PA_CLAMP(result
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
3007 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3008 /* Only cache if properly initialized */
3009 s
->thread_info
.requested_latency
= result
;
3010 s
->thread_info
.requested_latency_valid
= true;
3016 /* Called from main thread */
3017 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
) {
3020 pa_sink_assert_ref(s
);
3021 pa_assert_ctl_context();
3022 pa_assert(PA_SINK_IS_LINKED(s
->state
));
3024 if (s
->state
== PA_SINK_SUSPENDED
)
3027 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
3032 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3033 void pa_sink_set_max_rewind_within_thread(pa_sink
*s
, size_t max_rewind
) {
3037 pa_sink_assert_ref(s
);
3038 pa_sink_assert_io_context(s
);
3040 if (max_rewind
== s
->thread_info
.max_rewind
)
3043 s
->thread_info
.max_rewind
= max_rewind
;
3045 if (PA_SINK_IS_LINKED(s
->thread_info
.state
))
3046 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3047 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
3049 if (s
->monitor_source
)
3050 pa_source_set_max_rewind_within_thread(s
->monitor_source
, s
->thread_info
.max_rewind
);
3053 /* Called from main thread */
3054 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
) {
3055 pa_sink_assert_ref(s
);
3056 pa_assert_ctl_context();
3058 if (PA_SINK_IS_LINKED(s
->state
))
3059 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REWIND
, NULL
, max_rewind
, NULL
) == 0);
3061 pa_sink_set_max_rewind_within_thread(s
, max_rewind
);
3064 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3065 void pa_sink_set_max_request_within_thread(pa_sink
*s
, size_t max_request
) {
3068 pa_sink_assert_ref(s
);
3069 pa_sink_assert_io_context(s
);
3071 if (max_request
== s
->thread_info
.max_request
)
3074 s
->thread_info
.max_request
= max_request
;
3076 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3079 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3080 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
3084 /* Called from main thread */
3085 void pa_sink_set_max_request(pa_sink
*s
, size_t max_request
) {
3086 pa_sink_assert_ref(s
);
3087 pa_assert_ctl_context();
3089 if (PA_SINK_IS_LINKED(s
->state
))
3090 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REQUEST
, NULL
, max_request
, NULL
) == 0);
3092 pa_sink_set_max_request_within_thread(s
, max_request
);
3095 /* Called from IO thread */
3096 void pa_sink_invalidate_requested_latency(pa_sink
*s
, bool dynamic
) {
3100 pa_sink_assert_ref(s
);
3101 pa_sink_assert_io_context(s
);
3103 if ((s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
3104 s
->thread_info
.requested_latency_valid
= false;
3108 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3110 if (s
->update_requested_latency
)
3111 s
->update_requested_latency(s
);
3113 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3114 if (i
->update_sink_requested_latency
)
3115 i
->update_sink_requested_latency(i
);
3119 /* Called from main thread */
3120 void pa_sink_set_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3121 pa_sink_assert_ref(s
);
3122 pa_assert_ctl_context();
3124 /* min_latency == 0: no limit
3125 * min_latency anything else: specified limit
3127 * Similar for max_latency */
3129 if (min_latency
< ABSOLUTE_MIN_LATENCY
)
3130 min_latency
= ABSOLUTE_MIN_LATENCY
;
3132 if (max_latency
<= 0 ||
3133 max_latency
> ABSOLUTE_MAX_LATENCY
)
3134 max_latency
= ABSOLUTE_MAX_LATENCY
;
3136 pa_assert(min_latency
<= max_latency
);
3138 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3139 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3140 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3141 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3143 if (PA_SINK_IS_LINKED(s
->state
)) {
3149 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3151 pa_sink_set_latency_range_within_thread(s
, min_latency
, max_latency
);
3154 /* Called from main thread */
3155 void pa_sink_get_latency_range(pa_sink
*s
, pa_usec_t
*min_latency
, pa_usec_t
*max_latency
) {
3156 pa_sink_assert_ref(s
);
3157 pa_assert_ctl_context();
3158 pa_assert(min_latency
);
3159 pa_assert(max_latency
);
3161 if (PA_SINK_IS_LINKED(s
->state
)) {
3162 pa_usec_t r
[2] = { 0, 0 };
3164 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3166 *min_latency
= r
[0];
3167 *max_latency
= r
[1];
3169 *min_latency
= s
->thread_info
.min_latency
;
3170 *max_latency
= s
->thread_info
.max_latency
;
3174 /* Called from IO thread */
3175 void pa_sink_set_latency_range_within_thread(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3176 pa_sink_assert_ref(s
);
3177 pa_sink_assert_io_context(s
);
3179 pa_assert(min_latency
>= ABSOLUTE_MIN_LATENCY
);
3180 pa_assert(max_latency
<= ABSOLUTE_MAX_LATENCY
);
3181 pa_assert(min_latency
<= max_latency
);
3183 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3184 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3185 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3186 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3188 if (s
->thread_info
.min_latency
== min_latency
&&
3189 s
->thread_info
.max_latency
== max_latency
)
3192 s
->thread_info
.min_latency
= min_latency
;
3193 s
->thread_info
.max_latency
= max_latency
;
3195 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3199 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3200 if (i
->update_sink_latency_range
)
3201 i
->update_sink_latency_range(i
);
3204 pa_sink_invalidate_requested_latency(s
, false);
3206 pa_source_set_latency_range_within_thread(s
->monitor_source
, min_latency
, max_latency
);
3209 /* Called from main thread */
3210 void pa_sink_set_fixed_latency(pa_sink
*s
, pa_usec_t latency
) {
3211 pa_sink_assert_ref(s
);
3212 pa_assert_ctl_context();
3214 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3215 pa_assert(latency
== 0);
3219 if (latency
< ABSOLUTE_MIN_LATENCY
)
3220 latency
= ABSOLUTE_MIN_LATENCY
;
3222 if (latency
> ABSOLUTE_MAX_LATENCY
)
3223 latency
= ABSOLUTE_MAX_LATENCY
;
3225 if (PA_SINK_IS_LINKED(s
->state
))
3226 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_FIXED_LATENCY
, NULL
, (int64_t) latency
, NULL
) == 0);
3228 s
->thread_info
.fixed_latency
= latency
;
3230 pa_source_set_fixed_latency(s
->monitor_source
, latency
);
3233 /* Called from main thread */
3234 pa_usec_t
pa_sink_get_fixed_latency(pa_sink
*s
) {
3237 pa_sink_assert_ref(s
);
3238 pa_assert_ctl_context();
3240 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
)
3243 if (PA_SINK_IS_LINKED(s
->state
))
3244 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_FIXED_LATENCY
, &latency
, 0, NULL
) == 0);
3246 latency
= s
->thread_info
.fixed_latency
;
3251 /* Called from IO thread */
3252 void pa_sink_set_fixed_latency_within_thread(pa_sink
*s
, pa_usec_t latency
) {
3253 pa_sink_assert_ref(s
);
3254 pa_sink_assert_io_context(s
);
3256 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3257 pa_assert(latency
== 0);
3258 s
->thread_info
.fixed_latency
= 0;
3260 if (s
->monitor_source
)
3261 pa_source_set_fixed_latency_within_thread(s
->monitor_source
, 0);
3266 pa_assert(latency
>= ABSOLUTE_MIN_LATENCY
);
3267 pa_assert(latency
<= ABSOLUTE_MAX_LATENCY
);
3269 if (s
->thread_info
.fixed_latency
== latency
)
3272 s
->thread_info
.fixed_latency
= latency
;
3274 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3278 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3279 if (i
->update_sink_fixed_latency
)
3280 i
->update_sink_fixed_latency(i
);
3283 pa_sink_invalidate_requested_latency(s
, false);
3285 pa_source_set_fixed_latency_within_thread(s
->monitor_source
, latency
);
3288 /* Called from main context */
3289 void pa_sink_set_latency_offset(pa_sink
*s
, int64_t offset
) {
3290 pa_sink_assert_ref(s
);
3292 s
->latency_offset
= offset
;
3294 if (PA_SINK_IS_LINKED(s
->state
))
3295 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_LATENCY_OFFSET
, NULL
, offset
, NULL
) == 0);
3297 s
->thread_info
.latency_offset
= offset
;
3300 /* Called from main context */
3301 size_t pa_sink_get_max_rewind(pa_sink
*s
) {
3303 pa_assert_ctl_context();
3304 pa_sink_assert_ref(s
);
3306 if (!PA_SINK_IS_LINKED(s
->state
))
3307 return s
->thread_info
.max_rewind
;
3309 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REWIND
, &r
, 0, NULL
) == 0);
3314 /* Called from main context */
3315 size_t pa_sink_get_max_request(pa_sink
*s
) {
3317 pa_sink_assert_ref(s
);
3318 pa_assert_ctl_context();
3320 if (!PA_SINK_IS_LINKED(s
->state
))
3321 return s
->thread_info
.max_request
;
3323 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REQUEST
, &r
, 0, NULL
) == 0);
3328 /* Called from main context */
3329 int pa_sink_set_port(pa_sink
*s
, const char *name
, bool save
) {
3330 pa_device_port
*port
;
3333 pa_sink_assert_ref(s
);
3334 pa_assert_ctl_context();
3337 pa_log_debug("set_port() operation not implemented for sink %u \"%s\"", s
->index
, s
->name
);
3338 return -PA_ERR_NOTIMPLEMENTED
;
3342 return -PA_ERR_NOENTITY
;
3344 if (!(port
= pa_hashmap_get(s
->ports
, name
)))
3345 return -PA_ERR_NOENTITY
;
3347 if (s
->active_port
== port
) {
3348 s
->save_port
= s
->save_port
|| save
;
3352 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
3353 struct sink_message_set_port msg
= { .port
= port
, .ret
= 0 };
3354 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_PORT
, &msg
, 0, NULL
) == 0);
3358 ret
= s
->set_port(s
, port
);
3361 return -PA_ERR_NOENTITY
;
3363 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
3365 pa_log_info("Changed port of sink %u \"%s\" to %s", s
->index
, s
->name
, port
->name
);
3367 s
->active_port
= port
;
3368 s
->save_port
= save
;
3370 pa_sink_set_latency_offset(s
, s
->active_port
->latency_offset
);
3372 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PORT_CHANGED
], s
);
3377 bool pa_device_init_icon(pa_proplist
*p
, bool is_sink
) {
3378 const char *ff
, *c
, *t
= NULL
, *s
= "", *profile
, *bus
;
3382 if (pa_proplist_contains(p
, PA_PROP_DEVICE_ICON_NAME
))
3385 if ((ff
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3387 if (pa_streq(ff
, "microphone"))
3388 t
= "audio-input-microphone";
3389 else if (pa_streq(ff
, "webcam"))
3391 else if (pa_streq(ff
, "computer"))
3393 else if (pa_streq(ff
, "handset"))
3395 else if (pa_streq(ff
, "portable"))
3396 t
= "multimedia-player";
3397 else if (pa_streq(ff
, "tv"))
3398 t
= "video-display";
3401 * The following icons are not part of the icon naming spec,
3402 * because Rodney Dawes sucks as the maintainer of that spec.
3404 * http://lists.freedesktop.org/archives/xdg/2009-May/010397.html
3406 else if (pa_streq(ff
, "headset"))
3407 t
= "audio-headset";
3408 else if (pa_streq(ff
, "headphone"))
3409 t
= "audio-headphones";
3410 else if (pa_streq(ff
, "speaker"))
3411 t
= "audio-speakers";
3412 else if (pa_streq(ff
, "hands-free"))
3413 t
= "audio-handsfree";
3417 if ((c
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3418 if (pa_streq(c
, "modem"))
3425 t
= "audio-input-microphone";
3428 if ((profile
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3429 if (strstr(profile
, "analog"))
3431 else if (strstr(profile
, "iec958"))
3433 else if (strstr(profile
, "hdmi"))
3437 bus
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
);
3439 pa_proplist_setf(p
, PA_PROP_DEVICE_ICON_NAME
, "%s%s%s%s", t
, pa_strempty(s
), bus
? "-" : "", pa_strempty(bus
));
3444 bool pa_device_init_description(pa_proplist
*p
) {
3445 const char *s
, *d
= NULL
, *k
;
3448 if (pa_proplist_contains(p
, PA_PROP_DEVICE_DESCRIPTION
))
3451 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3452 if (pa_streq(s
, "internal"))
3453 d
= _("Built-in Audio");
3456 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3457 if (pa_streq(s
, "modem"))
3461 d
= pa_proplist_gets(p
, PA_PROP_DEVICE_PRODUCT_NAME
);
3466 k
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_DESCRIPTION
);
3469 pa_proplist_setf(p
, PA_PROP_DEVICE_DESCRIPTION
, "%s %s", d
, k
);
3471 pa_proplist_sets(p
, PA_PROP_DEVICE_DESCRIPTION
, d
);
3476 bool pa_device_init_intended_roles(pa_proplist
*p
) {
3480 if (pa_proplist_contains(p
, PA_PROP_DEVICE_INTENDED_ROLES
))
3483 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3484 if (pa_streq(s
, "handset") || pa_streq(s
, "hands-free")
3485 || pa_streq(s
, "headset")) {
3486 pa_proplist_sets(p
, PA_PROP_DEVICE_INTENDED_ROLES
, "phone");
3493 unsigned pa_device_init_priority(pa_proplist
*p
) {
3495 unsigned priority
= 0;
3499 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
))) {
3501 if (pa_streq(s
, "sound"))
3503 else if (!pa_streq(s
, "modem"))
3507 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3509 if (pa_streq(s
, "internal"))
3511 else if (pa_streq(s
, "speaker"))
3513 else if (pa_streq(s
, "headphone"))
3517 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
))) {
3519 if (pa_streq(s
, "pci"))
3521 else if (pa_streq(s
, "usb"))
3523 else if (pa_streq(s
, "bluetooth"))
3527 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3529 if (pa_startswith(s
, "analog-"))
3531 else if (pa_startswith(s
, "iec958-"))
3538 PA_STATIC_FLIST_DECLARE(pa_sink_volume_change
, 0, pa_xfree
);
3540 /* Called from the IO thread. */
3541 static pa_sink_volume_change
*pa_sink_volume_change_new(pa_sink
*s
) {
3542 pa_sink_volume_change
*c
;
3543 if (!(c
= pa_flist_pop(PA_STATIC_FLIST_GET(pa_sink_volume_change
))))
3544 c
= pa_xnew(pa_sink_volume_change
, 1);
3546 PA_LLIST_INIT(pa_sink_volume_change
, c
);
3548 pa_cvolume_reset(&c
->hw_volume
, s
->sample_spec
.channels
);
3552 /* Called from the IO thread. */
3553 static void pa_sink_volume_change_free(pa_sink_volume_change
*c
) {
3555 if (pa_flist_push(PA_STATIC_FLIST_GET(pa_sink_volume_change
), c
) < 0)
3559 /* Called from the IO thread. */
3560 void pa_sink_volume_change_push(pa_sink
*s
) {
3561 pa_sink_volume_change
*c
= NULL
;
3562 pa_sink_volume_change
*nc
= NULL
;
3563 uint32_t safety_margin
= s
->thread_info
.volume_change_safety_margin
;
3565 const char *direction
= NULL
;
3568 nc
= pa_sink_volume_change_new(s
);
3570 /* NOTE: There is already more different volumes in pa_sink that I can remember.
3571 * Adding one more volume for HW would get us rid of this, but I am trying
3572 * to survive with the ones we already have. */
3573 pa_sw_cvolume_divide(&nc
->hw_volume
, &s
->real_volume
, &s
->soft_volume
);
3575 if (!s
->thread_info
.volume_changes
&& pa_cvolume_equal(&nc
->hw_volume
, &s
->thread_info
.current_hw_volume
)) {
3576 pa_log_debug("Volume not changing");
3577 pa_sink_volume_change_free(nc
);
3581 nc
->at
= pa_sink_get_latency_within_thread(s
);
3582 nc
->at
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3584 if (s
->thread_info
.volume_changes_tail
) {
3585 for (c
= s
->thread_info
.volume_changes_tail
; c
; c
= c
->prev
) {
3586 /* If volume is going up let's do it a bit late. If it is going
3587 * down let's do it a bit early. */
3588 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&c
->hw_volume
)) {
3589 if (nc
->at
+ safety_margin
> c
->at
) {
3590 nc
->at
+= safety_margin
;
3595 else if (nc
->at
- safety_margin
> c
->at
) {
3596 nc
->at
-= safety_margin
;
3604 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&s
->thread_info
.current_hw_volume
)) {
3605 nc
->at
+= safety_margin
;
3608 nc
->at
-= safety_margin
;
3611 PA_LLIST_PREPEND(pa_sink_volume_change
, s
->thread_info
.volume_changes
, nc
);
3614 PA_LLIST_INSERT_AFTER(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
, nc
);
3617 pa_log_debug("Volume going %s to %d at %llu", direction
, pa_cvolume_avg(&nc
->hw_volume
), (long long unsigned) nc
->at
);
3619 /* We can ignore volume events that came earlier but should happen later than this. */
3620 PA_LLIST_FOREACH(c
, nc
->next
) {
3621 pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
);
3622 pa_sink_volume_change_free(c
);
3625 s
->thread_info
.volume_changes_tail
= nc
;
3628 /* Called from the IO thread. */
3629 static void pa_sink_volume_change_flush(pa_sink
*s
) {
3630 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3632 s
->thread_info
.volume_changes
= NULL
;
3633 s
->thread_info
.volume_changes_tail
= NULL
;
3635 pa_sink_volume_change
*next
= c
->next
;
3636 pa_sink_volume_change_free(c
);
3641 /* Called from the IO thread. */
3642 bool pa_sink_volume_change_apply(pa_sink
*s
, pa_usec_t
*usec_to_next
) {
3648 if (!s
->thread_info
.volume_changes
|| !PA_SINK_IS_LINKED(s
->state
)) {
3654 pa_assert(s
->write_volume
);
3656 now
= pa_rtclock_now();
3658 while (s
->thread_info
.volume_changes
&& now
>= s
->thread_info
.volume_changes
->at
) {
3659 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3660 PA_LLIST_REMOVE(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
);
3661 pa_log_debug("Volume change to %d at %llu was written %llu usec late",
3662 pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
, (long long unsigned) (now
- c
->at
));
3664 s
->thread_info
.current_hw_volume
= c
->hw_volume
;
3665 pa_sink_volume_change_free(c
);
3671 if (s
->thread_info
.volume_changes
) {
3673 *usec_to_next
= s
->thread_info
.volume_changes
->at
- now
;
3674 if (pa_log_ratelimit(PA_LOG_DEBUG
))
3675 pa_log_debug("Next volume change in %lld usec", (long long) (s
->thread_info
.volume_changes
->at
- now
));
3680 s
->thread_info
.volume_changes_tail
= NULL
;
3685 /* Called from the IO thread. */
3686 static void pa_sink_volume_change_rewind(pa_sink
*s
, size_t nbytes
) {
3687 /* All the queued volume events later than current latency are shifted to happen earlier. */
3688 pa_sink_volume_change
*c
;
3689 pa_volume_t prev_vol
= pa_cvolume_avg(&s
->thread_info
.current_hw_volume
);
3690 pa_usec_t rewound
= pa_bytes_to_usec(nbytes
, &s
->sample_spec
);
3691 pa_usec_t limit
= pa_sink_get_latency_within_thread(s
);
3693 pa_log_debug("latency = %lld", (long long) limit
);
3694 limit
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3696 PA_LLIST_FOREACH(c
, s
->thread_info
.volume_changes
) {
3697 pa_usec_t modified_limit
= limit
;
3698 if (prev_vol
> pa_cvolume_avg(&c
->hw_volume
))
3699 modified_limit
-= s
->thread_info
.volume_change_safety_margin
;
3701 modified_limit
+= s
->thread_info
.volume_change_safety_margin
;
3702 if (c
->at
> modified_limit
) {
3704 if (c
->at
< modified_limit
)
3705 c
->at
= modified_limit
;
3707 prev_vol
= pa_cvolume_avg(&c
->hw_volume
);
3709 pa_sink_volume_change_apply(s
, NULL
);
3712 /* Called from the main thread */
3713 /* Gets the list of formats supported by the sink. The members and idxset must
3714 * be freed by the caller. */
3715 pa_idxset
* pa_sink_get_formats(pa_sink
*s
) {
3720 if (s
->get_formats
) {
3721 /* Sink supports format query, all is good */
3722 ret
= s
->get_formats(s
);
3724 /* Sink doesn't support format query, so assume it does PCM */
3725 pa_format_info
*f
= pa_format_info_new();
3726 f
->encoding
= PA_ENCODING_PCM
;
3728 ret
= pa_idxset_new(NULL
, NULL
);
3729 pa_idxset_put(ret
, f
, NULL
);
3735 /* Called from the main thread */
3736 /* Allows an external source to set what formats a sink supports if the sink
3737 * permits this. The function makes a copy of the formats on success. */
3738 bool pa_sink_set_formats(pa_sink
*s
, pa_idxset
*formats
) {
3743 /* Sink supports setting formats -- let's give it a shot */
3744 return s
->set_formats(s
, formats
);
3746 /* Sink doesn't support setting this -- bail out */
3750 /* Called from the main thread */
3751 /* Checks if the sink can accept this format */
3752 bool pa_sink_check_format(pa_sink
*s
, pa_format_info
*f
) {
3753 pa_idxset
*formats
= NULL
;
3759 formats
= pa_sink_get_formats(s
);
3762 pa_format_info
*finfo_device
;
3765 PA_IDXSET_FOREACH(finfo_device
, formats
, i
) {
3766 if (pa_format_info_is_compatible(finfo_device
, f
)) {
3772 pa_idxset_free(formats
, (pa_free_cb_t
) pa_format_info_free
);
3778 /* Called from the main thread */
3779 /* Calculates the intersection between formats supported by the sink and
3780 * in_formats, and returns these, in the order of the sink's formats. */
3781 pa_idxset
* pa_sink_check_formats(pa_sink
*s
, pa_idxset
*in_formats
) {
3782 pa_idxset
*out_formats
= pa_idxset_new(NULL
, NULL
), *sink_formats
= NULL
;
3783 pa_format_info
*f_sink
, *f_in
;
3788 if (!in_formats
|| pa_idxset_isempty(in_formats
))
3791 sink_formats
= pa_sink_get_formats(s
);
3793 PA_IDXSET_FOREACH(f_sink
, sink_formats
, i
) {
3794 PA_IDXSET_FOREACH(f_in
, in_formats
, j
) {
3795 if (pa_format_info_is_compatible(f_sink
, f_in
))
3796 pa_idxset_put(out_formats
, pa_format_info_copy(f_in
), NULL
);
3802 pa_idxset_free(sink_formats
, (pa_free_cb_t
) pa_format_info_free
);