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
, data
->card
);
235 pa_device_init_icon(data
->proplist
, true);
236 pa_device_init_intended_roles(data
->proplist
);
238 if (!data
->active_port
) {
239 pa_device_port
*p
= pa_device_port_find_best(data
->ports
);
241 pa_sink_new_data_set_port(data
, p
->name
);
244 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_FIXATE
], data
) < 0) {
246 pa_namereg_unregister(core
, name
);
250 s
->parent
.parent
.free
= sink_free
;
251 s
->parent
.process_msg
= pa_sink_process_msg
;
254 s
->state
= PA_SINK_INIT
;
257 s
->suspend_cause
= data
->suspend_cause
;
258 pa_sink_set_mixer_dirty(s
, false);
259 s
->name
= pa_xstrdup(name
);
260 s
->proplist
= pa_proplist_copy(data
->proplist
);
261 s
->driver
= pa_xstrdup(pa_path_get_filename(data
->driver
));
262 s
->module
= data
->module
;
263 s
->card
= data
->card
;
265 s
->priority
= pa_device_init_priority(s
->proplist
);
267 s
->sample_spec
= data
->sample_spec
;
268 s
->channel_map
= data
->channel_map
;
269 s
->default_sample_rate
= s
->sample_spec
.rate
;
271 if (data
->alternate_sample_rate_is_set
)
272 s
->alternate_sample_rate
= data
->alternate_sample_rate
;
274 s
->alternate_sample_rate
= s
->core
->alternate_sample_rate
;
276 if (s
->sample_spec
.rate
== s
->alternate_sample_rate
) {
277 pa_log_warn("Default and alternate sample rates are the same.");
278 s
->alternate_sample_rate
= 0;
281 s
->inputs
= pa_idxset_new(NULL
, NULL
);
283 s
->input_to_master
= NULL
;
285 s
->reference_volume
= s
->real_volume
= data
->volume
;
286 pa_cvolume_reset(&s
->soft_volume
, s
->sample_spec
.channels
);
287 s
->base_volume
= PA_VOLUME_NORM
;
288 s
->n_volume_steps
= PA_VOLUME_NORM
+1;
289 s
->muted
= data
->muted
;
290 s
->refresh_volume
= s
->refresh_muted
= false;
297 /* As a minor optimization we just steal the list instead of
299 s
->ports
= data
->ports
;
302 s
->active_port
= NULL
;
303 s
->save_port
= false;
305 if (data
->active_port
)
306 if ((s
->active_port
= pa_hashmap_get(s
->ports
, data
->active_port
)))
307 s
->save_port
= data
->save_port
;
309 /* Hopefully the active port has already been assigned in the previous call
310 to pa_device_port_find_best, but better safe than sorry */
312 s
->active_port
= pa_device_port_find_best(s
->ports
);
315 s
->latency_offset
= s
->active_port
->latency_offset
;
317 s
->latency_offset
= 0;
319 s
->save_volume
= data
->save_volume
;
320 s
->save_muted
= data
->save_muted
;
322 pa_silence_memchunk_get(
323 &core
->silence_cache
,
329 s
->thread_info
.rtpoll
= NULL
;
330 s
->thread_info
.inputs
= pa_hashmap_new_full(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
, NULL
,
331 (pa_free_cb_t
) pa_sink_input_unref
);
332 s
->thread_info
.soft_volume
= s
->soft_volume
;
333 s
->thread_info
.soft_muted
= s
->muted
;
334 s
->thread_info
.state
= s
->state
;
335 s
->thread_info
.rewind_nbytes
= 0;
336 s
->thread_info
.rewind_requested
= false;
337 s
->thread_info
.max_rewind
= 0;
338 s
->thread_info
.max_request
= 0;
339 s
->thread_info
.requested_latency_valid
= false;
340 s
->thread_info
.requested_latency
= 0;
341 s
->thread_info
.min_latency
= ABSOLUTE_MIN_LATENCY
;
342 s
->thread_info
.max_latency
= ABSOLUTE_MAX_LATENCY
;
343 s
->thread_info
.fixed_latency
= flags
& PA_SINK_DYNAMIC_LATENCY
? 0 : DEFAULT_FIXED_LATENCY
;
345 PA_LLIST_HEAD_INIT(pa_sink_volume_change
, s
->thread_info
.volume_changes
);
346 s
->thread_info
.volume_changes_tail
= NULL
;
347 pa_sw_cvolume_multiply(&s
->thread_info
.current_hw_volume
, &s
->soft_volume
, &s
->real_volume
);
348 s
->thread_info
.volume_change_safety_margin
= core
->deferred_volume_safety_margin_usec
;
349 s
->thread_info
.volume_change_extra_delay
= core
->deferred_volume_extra_delay_usec
;
350 s
->thread_info
.latency_offset
= s
->latency_offset
;
352 /* FIXME: This should probably be moved to pa_sink_put() */
353 pa_assert_se(pa_idxset_put(core
->sinks
, s
, &s
->index
) >= 0);
356 pa_assert_se(pa_idxset_put(s
->card
->sinks
, s
, NULL
) >= 0);
358 pt
= pa_proplist_to_string_sep(s
->proplist
, "\n ");
359 pa_log_info("Created sink %u \"%s\" with sample spec %s and channel map %s\n %s",
362 pa_sample_spec_snprint(st
, sizeof(st
), &s
->sample_spec
),
363 pa_channel_map_snprint(cm
, sizeof(cm
), &s
->channel_map
),
367 pa_source_new_data_init(&source_data
);
368 pa_source_new_data_set_sample_spec(&source_data
, &s
->sample_spec
);
369 pa_source_new_data_set_channel_map(&source_data
, &s
->channel_map
);
370 pa_source_new_data_set_alternate_sample_rate(&source_data
, s
->alternate_sample_rate
);
371 source_data
.name
= pa_sprintf_malloc("%s.monitor", name
);
372 source_data
.driver
= data
->driver
;
373 source_data
.module
= data
->module
;
374 source_data
.card
= data
->card
;
376 dn
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
377 pa_proplist_setf(source_data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Monitor of %s", dn
? dn
: s
->name
);
378 pa_proplist_sets(source_data
.proplist
, PA_PROP_DEVICE_CLASS
, "monitor");
380 s
->monitor_source
= pa_source_new(core
, &source_data
,
381 ((flags
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
382 ((flags
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0));
384 pa_source_new_data_done(&source_data
);
386 if (!s
->monitor_source
) {
392 s
->monitor_source
->monitor_of
= s
;
394 pa_source_set_latency_range(s
->monitor_source
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
395 pa_source_set_fixed_latency(s
->monitor_source
, s
->thread_info
.fixed_latency
);
396 pa_source_set_max_rewind(s
->monitor_source
, s
->thread_info
.max_rewind
);
401 /* Called from main context */
402 static int sink_set_state(pa_sink
*s
, pa_sink_state_t state
) {
405 pa_sink_state_t original_state
;
408 pa_assert_ctl_context();
410 if (s
->state
== state
)
413 original_state
= s
->state
;
416 (original_state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(state
)) ||
417 (PA_SINK_IS_OPENED(original_state
) && state
== PA_SINK_SUSPENDED
);
420 if ((ret
= s
->set_state(s
, state
)) < 0)
424 if ((ret
= pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_STATE
, PA_UINT_TO_PTR(state
), 0, NULL
)) < 0) {
427 s
->set_state(s
, original_state
);
434 if (state
!= PA_SINK_UNLINKED
) { /* if we enter UNLINKED state pa_sink_unlink() will fire the appropriate events */
435 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_STATE_CHANGED
], s
);
436 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
439 if (suspend_change
) {
443 /* We're suspending or resuming, tell everyone about it */
445 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
)
446 if (s
->state
== PA_SINK_SUSPENDED
&&
447 (i
->flags
& PA_SINK_INPUT_KILL_ON_SUSPEND
))
448 pa_sink_input_kill(i
);
450 i
->suspend(i
, state
== PA_SINK_SUSPENDED
);
452 if (s
->monitor_source
)
453 pa_source_sync_suspend(s
->monitor_source
);
459 void pa_sink_set_get_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
465 void pa_sink_set_set_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
466 pa_sink_flags_t flags
;
469 pa_assert(!s
->write_volume
|| cb
);
473 /* Save the current flags so we can tell if they've changed */
477 /* The sink implementor is responsible for setting decibel volume support */
478 s
->flags
|= PA_SINK_HW_VOLUME_CTRL
;
480 s
->flags
&= ~PA_SINK_HW_VOLUME_CTRL
;
481 /* See note below in pa_sink_put() about volume sharing and decibel volumes */
482 pa_sink_enable_decibel_volume(s
, !(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
485 /* If the flags have changed after init, let any clients know via a change event */
486 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
487 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
490 void pa_sink_set_write_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
491 pa_sink_flags_t flags
;
494 pa_assert(!cb
|| s
->set_volume
);
496 s
->write_volume
= cb
;
498 /* Save the current flags so we can tell if they've changed */
502 s
->flags
|= PA_SINK_DEFERRED_VOLUME
;
504 s
->flags
&= ~PA_SINK_DEFERRED_VOLUME
;
506 /* If the flags have changed after init, let any clients know via a change event */
507 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
508 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
511 void pa_sink_set_get_mute_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
517 void pa_sink_set_set_mute_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
518 pa_sink_flags_t flags
;
524 /* Save the current flags so we can tell if they've changed */
528 s
->flags
|= PA_SINK_HW_MUTE_CTRL
;
530 s
->flags
&= ~PA_SINK_HW_MUTE_CTRL
;
532 /* If the flags have changed after init, let any clients know via a change event */
533 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
534 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
537 static void enable_flat_volume(pa_sink
*s
, bool enable
) {
538 pa_sink_flags_t flags
;
542 /* Always follow the overall user preference here */
543 enable
= enable
&& s
->core
->flat_volumes
;
545 /* Save the current flags so we can tell if they've changed */
549 s
->flags
|= PA_SINK_FLAT_VOLUME
;
551 s
->flags
&= ~PA_SINK_FLAT_VOLUME
;
553 /* If the flags have changed after init, let any clients know via a change event */
554 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
555 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
558 void pa_sink_enable_decibel_volume(pa_sink
*s
, bool enable
) {
559 pa_sink_flags_t flags
;
563 /* Save the current flags so we can tell if they've changed */
567 s
->flags
|= PA_SINK_DECIBEL_VOLUME
;
568 enable_flat_volume(s
, true);
570 s
->flags
&= ~PA_SINK_DECIBEL_VOLUME
;
571 enable_flat_volume(s
, false);
574 /* If the flags have changed after init, let any clients know via a change event */
575 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
576 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
579 /* Called from main context */
580 void pa_sink_put(pa_sink
* s
) {
581 pa_sink_assert_ref(s
);
582 pa_assert_ctl_context();
584 pa_assert(s
->state
== PA_SINK_INIT
);
585 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) || s
->input_to_master
);
587 /* The following fields must be initialized properly when calling _put() */
588 pa_assert(s
->asyncmsgq
);
589 pa_assert(s
->thread_info
.min_latency
<= s
->thread_info
.max_latency
);
591 /* Generally, flags should be initialized via pa_sink_new(). As a
592 * special exception we allow some volume related flags to be set
593 * between _new() and _put() by the callback setter functions above.
595 * Thus we implement a couple safeguards here which ensure the above
596 * setters were used (or at least the implementor made manual changes
597 * in a compatible way).
599 * Note: All of these flags set here can change over the life time
601 pa_assert(!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
) || s
->set_volume
);
602 pa_assert(!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) || s
->write_volume
);
603 pa_assert(!(s
->flags
& PA_SINK_HW_MUTE_CTRL
) || s
->set_mute
);
605 /* XXX: Currently decibel volume is disabled for all sinks that use volume
606 * sharing. When the master sink supports decibel volume, it would be good
607 * to have the flag also in the filter sink, but currently we don't do that
608 * so that the flags of the filter sink never change when it's moved from
609 * a master sink to another. One solution for this problem would be to
610 * remove user-visible volume altogether from filter sinks when volume
611 * sharing is used, but the current approach was easier to implement... */
612 /* We always support decibel volumes in software, otherwise we leave it to
613 * the sink implementor to set this flag as needed.
615 * Note: This flag can also change over the life time of the sink. */
616 if (!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
) && !(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
617 pa_sink_enable_decibel_volume(s
, true);
619 /* If the sink implementor support DB volumes by itself, we should always
620 * try and enable flat volumes too */
621 if ((s
->flags
& PA_SINK_DECIBEL_VOLUME
))
622 enable_flat_volume(s
, true);
624 if (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) {
625 pa_sink
*root_sink
= pa_sink_get_master(s
);
627 pa_assert(root_sink
);
629 s
->reference_volume
= root_sink
->reference_volume
;
630 pa_cvolume_remap(&s
->reference_volume
, &root_sink
->channel_map
, &s
->channel_map
);
632 s
->real_volume
= root_sink
->real_volume
;
633 pa_cvolume_remap(&s
->real_volume
, &root_sink
->channel_map
, &s
->channel_map
);
635 /* We assume that if the sink implementor changed the default
636 * volume he did so in real_volume, because that is the usual
637 * place where he is supposed to place his changes. */
638 s
->reference_volume
= s
->real_volume
;
640 s
->thread_info
.soft_volume
= s
->soft_volume
;
641 s
->thread_info
.soft_muted
= s
->muted
;
642 pa_sw_cvolume_multiply(&s
->thread_info
.current_hw_volume
, &s
->soft_volume
, &s
->real_volume
);
644 pa_assert((s
->flags
& PA_SINK_HW_VOLUME_CTRL
)
645 || (s
->base_volume
== PA_VOLUME_NORM
646 && ((s
->flags
& PA_SINK_DECIBEL_VOLUME
|| (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)))));
647 pa_assert(!(s
->flags
& PA_SINK_DECIBEL_VOLUME
) || s
->n_volume_steps
== PA_VOLUME_NORM
+1);
648 pa_assert(!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
) == (s
->thread_info
.fixed_latency
!= 0));
649 pa_assert(!(s
->flags
& PA_SINK_LATENCY
) == !(s
->monitor_source
->flags
& PA_SOURCE_LATENCY
));
650 pa_assert(!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
) == !(s
->monitor_source
->flags
& PA_SOURCE_DYNAMIC_LATENCY
));
652 pa_assert(s
->monitor_source
->thread_info
.fixed_latency
== s
->thread_info
.fixed_latency
);
653 pa_assert(s
->monitor_source
->thread_info
.min_latency
== s
->thread_info
.min_latency
);
654 pa_assert(s
->monitor_source
->thread_info
.max_latency
== s
->thread_info
.max_latency
);
656 if (s
->suspend_cause
)
657 pa_assert_se(sink_set_state(s
, PA_SINK_SUSPENDED
) == 0);
659 pa_assert_se(sink_set_state(s
, PA_SINK_IDLE
) == 0);
661 pa_source_put(s
->monitor_source
);
663 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_NEW
, s
->index
);
664 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PUT
], s
);
667 /* Called from main context */
668 void pa_sink_unlink(pa_sink
* s
) {
670 pa_sink_input
*i
, *j
= NULL
;
673 pa_assert_ctl_context();
675 /* Please note that pa_sink_unlink() does more than simply
676 * reversing pa_sink_put(). It also undoes the registrations
677 * already done in pa_sink_new()! */
679 /* All operations here shall be idempotent, i.e. pa_sink_unlink()
680 * may be called multiple times on the same sink without bad
683 linked
= PA_SINK_IS_LINKED(s
->state
);
686 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK
], s
);
688 if (s
->state
!= PA_SINK_UNLINKED
)
689 pa_namereg_unregister(s
->core
, s
->name
);
690 pa_idxset_remove_by_data(s
->core
->sinks
, s
, NULL
);
693 pa_idxset_remove_by_data(s
->card
->sinks
, s
, NULL
);
695 while ((i
= pa_idxset_first(s
->inputs
, NULL
))) {
697 pa_sink_input_kill(i
);
702 sink_set_state(s
, PA_SINK_UNLINKED
);
704 s
->state
= PA_SINK_UNLINKED
;
708 if (s
->monitor_source
)
709 pa_source_unlink(s
->monitor_source
);
712 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_REMOVE
, s
->index
);
713 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK_POST
], s
);
717 /* Called from main context */
718 static void sink_free(pa_object
*o
) {
719 pa_sink
*s
= PA_SINK(o
);
722 pa_assert_ctl_context();
723 pa_assert(pa_sink_refcnt(s
) == 0);
725 if (PA_SINK_IS_LINKED(s
->state
))
728 pa_log_info("Freeing sink %u \"%s\"", s
->index
, s
->name
);
730 if (s
->monitor_source
) {
731 pa_source_unref(s
->monitor_source
);
732 s
->monitor_source
= NULL
;
735 pa_idxset_free(s
->inputs
, NULL
);
736 pa_hashmap_free(s
->thread_info
.inputs
);
738 if (s
->silence
.memblock
)
739 pa_memblock_unref(s
->silence
.memblock
);
745 pa_proplist_free(s
->proplist
);
748 pa_hashmap_free(s
->ports
);
753 /* Called from main context, and not while the IO thread is active, please */
754 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
) {
755 pa_sink_assert_ref(s
);
756 pa_assert_ctl_context();
760 if (s
->monitor_source
)
761 pa_source_set_asyncmsgq(s
->monitor_source
, q
);
764 /* Called from main context, and not while the IO thread is active, please */
765 void pa_sink_update_flags(pa_sink
*s
, pa_sink_flags_t mask
, pa_sink_flags_t value
) {
766 pa_sink_flags_t old_flags
;
767 pa_sink_input
*input
;
770 pa_sink_assert_ref(s
);
771 pa_assert_ctl_context();
773 /* For now, allow only a minimal set of flags to be changed. */
774 pa_assert((mask
& ~(PA_SINK_DYNAMIC_LATENCY
|PA_SINK_LATENCY
)) == 0);
776 old_flags
= s
->flags
;
777 s
->flags
= (s
->flags
& ~mask
) | (value
& mask
);
779 if (s
->flags
== old_flags
)
782 if ((s
->flags
& PA_SINK_LATENCY
) != (old_flags
& PA_SINK_LATENCY
))
783 pa_log_debug("Sink %s: LATENCY flag %s.", s
->name
, (s
->flags
& PA_SINK_LATENCY
) ? "enabled" : "disabled");
785 if ((s
->flags
& PA_SINK_DYNAMIC_LATENCY
) != (old_flags
& PA_SINK_DYNAMIC_LATENCY
))
786 pa_log_debug("Sink %s: DYNAMIC_LATENCY flag %s.",
787 s
->name
, (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) ? "enabled" : "disabled");
789 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
790 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_FLAGS_CHANGED
], s
);
792 if (s
->monitor_source
)
793 pa_source_update_flags(s
->monitor_source
,
794 ((mask
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
795 ((mask
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0),
796 ((value
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
797 ((value
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0));
799 PA_IDXSET_FOREACH(input
, s
->inputs
, idx
) {
800 if (input
->origin_sink
)
801 pa_sink_update_flags(input
->origin_sink
, mask
, value
);
805 /* Called from IO context, or before _put() from main context */
806 void pa_sink_set_rtpoll(pa_sink
*s
, pa_rtpoll
*p
) {
807 pa_sink_assert_ref(s
);
808 pa_sink_assert_io_context(s
);
810 s
->thread_info
.rtpoll
= p
;
812 if (s
->monitor_source
)
813 pa_source_set_rtpoll(s
->monitor_source
, p
);
816 /* Called from main context */
817 int pa_sink_update_status(pa_sink
*s
) {
818 pa_sink_assert_ref(s
);
819 pa_assert_ctl_context();
820 pa_assert(PA_SINK_IS_LINKED(s
->state
));
822 if (s
->state
== PA_SINK_SUSPENDED
)
825 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
828 /* Called from any context - must be threadsafe */
829 void pa_sink_set_mixer_dirty(pa_sink
*s
, bool is_dirty
) {
830 pa_atomic_store(&s
->mixer_dirty
, is_dirty
? 1 : 0);
833 /* Called from main context */
834 int pa_sink_suspend(pa_sink
*s
, bool suspend
, pa_suspend_cause_t cause
) {
835 pa_sink_assert_ref(s
);
836 pa_assert_ctl_context();
837 pa_assert(PA_SINK_IS_LINKED(s
->state
));
838 pa_assert(cause
!= 0);
841 s
->suspend_cause
|= cause
;
842 s
->monitor_source
->suspend_cause
|= cause
;
844 s
->suspend_cause
&= ~cause
;
845 s
->monitor_source
->suspend_cause
&= ~cause
;
848 if (!(s
->suspend_cause
& PA_SUSPEND_SESSION
) && (pa_atomic_load(&s
->mixer_dirty
) != 0)) {
849 /* This might look racy but isn't: If somebody sets mixer_dirty exactly here,
850 it'll be handled just fine. */
851 pa_sink_set_mixer_dirty(s
, false);
852 pa_log_debug("Mixer is now accessible. Updating alsa mixer settings.");
853 if (s
->active_port
&& s
->set_port
) {
854 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
855 struct sink_message_set_port msg
= { .port
= s
->active_port
, .ret
= 0 };
856 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_PORT
, &msg
, 0, NULL
) == 0);
859 s
->set_port(s
, s
->active_port
);
869 if ((pa_sink_get_state(s
) == PA_SINK_SUSPENDED
) == !!s
->suspend_cause
)
872 pa_log_debug("Suspend cause of sink %s is 0x%04x, %s", s
->name
, s
->suspend_cause
, s
->suspend_cause
? "suspending" : "resuming");
874 if (s
->suspend_cause
)
875 return sink_set_state(s
, PA_SINK_SUSPENDED
);
877 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
880 /* Called from main context */
881 pa_queue
*pa_sink_move_all_start(pa_sink
*s
, pa_queue
*q
) {
882 pa_sink_input
*i
, *n
;
885 pa_sink_assert_ref(s
);
886 pa_assert_ctl_context();
887 pa_assert(PA_SINK_IS_LINKED(s
->state
));
892 for (i
= PA_SINK_INPUT(pa_idxset_first(s
->inputs
, &idx
)); i
; i
= n
) {
893 n
= PA_SINK_INPUT(pa_idxset_next(s
->inputs
, &idx
));
895 pa_sink_input_ref(i
);
897 if (pa_sink_input_start_move(i
) >= 0)
900 pa_sink_input_unref(i
);
906 /* Called from main context */
907 void pa_sink_move_all_finish(pa_sink
*s
, pa_queue
*q
, bool save
) {
910 pa_sink_assert_ref(s
);
911 pa_assert_ctl_context();
912 pa_assert(PA_SINK_IS_LINKED(s
->state
));
915 while ((i
= PA_SINK_INPUT(pa_queue_pop(q
)))) {
916 if (pa_sink_input_finish_move(i
, s
, save
) < 0)
917 pa_sink_input_fail_move(i
);
919 pa_sink_input_unref(i
);
922 pa_queue_free(q
, NULL
);
925 /* Called from main context */
926 void pa_sink_move_all_fail(pa_queue
*q
) {
929 pa_assert_ctl_context();
932 while ((i
= PA_SINK_INPUT(pa_queue_pop(q
)))) {
933 pa_sink_input_fail_move(i
);
934 pa_sink_input_unref(i
);
937 pa_queue_free(q
, NULL
);
940 /* Called from IO thread context */
941 size_t pa_sink_process_input_underruns(pa_sink
*s
, size_t left_to_play
) {
946 pa_sink_assert_ref(s
);
947 pa_sink_assert_io_context(s
);
949 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
950 size_t uf
= i
->thread_info
.underrun_for_sink
;
953 if (uf
>= left_to_play
) {
954 if (pa_sink_input_process_underrun(i
))
957 else if (uf
> result
)
962 pa_log_debug("Found underrun %ld bytes ago (%ld bytes ahead in playback buffer)", (long) result
, (long) left_to_play
- result
);
963 return left_to_play
- result
;
966 /* Called from IO thread context */
967 void pa_sink_process_rewind(pa_sink
*s
, size_t nbytes
) {
971 pa_sink_assert_ref(s
);
972 pa_sink_assert_io_context(s
);
973 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
975 /* If nobody requested this and this is actually no real rewind
976 * then we can short cut this. Please note that this means that
977 * not all rewind requests triggered upstream will always be
978 * translated in actual requests! */
979 if (!s
->thread_info
.rewind_requested
&& nbytes
<= 0)
982 s
->thread_info
.rewind_nbytes
= 0;
983 s
->thread_info
.rewind_requested
= false;
986 pa_log_debug("Processing rewind...");
987 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
988 pa_sink_volume_change_rewind(s
, nbytes
);
991 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
992 pa_sink_input_assert_ref(i
);
993 pa_sink_input_process_rewind(i
, nbytes
);
997 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
998 pa_source_process_rewind(s
->monitor_source
, nbytes
);
1002 /* Called from IO thread context */
1003 static unsigned fill_mix_info(pa_sink
*s
, size_t *length
, pa_mix_info
*info
, unsigned maxinfo
) {
1007 size_t mixlength
= *length
;
1009 pa_sink_assert_ref(s
);
1010 pa_sink_assert_io_context(s
);
1013 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)) && maxinfo
> 0) {
1014 pa_sink_input_assert_ref(i
);
1016 pa_sink_input_peek(i
, *length
, &info
->chunk
, &info
->volume
);
1018 if (mixlength
== 0 || info
->chunk
.length
< mixlength
)
1019 mixlength
= info
->chunk
.length
;
1021 if (pa_memblock_is_silence(info
->chunk
.memblock
)) {
1022 pa_memblock_unref(info
->chunk
.memblock
);
1026 info
->userdata
= pa_sink_input_ref(i
);
1028 pa_assert(info
->chunk
.memblock
);
1029 pa_assert(info
->chunk
.length
> 0);
1037 *length
= mixlength
;
1042 /* Called from IO thread context */
1043 static void inputs_drop(pa_sink
*s
, pa_mix_info
*info
, unsigned n
, pa_memchunk
*result
) {
1047 unsigned n_unreffed
= 0;
1049 pa_sink_assert_ref(s
);
1050 pa_sink_assert_io_context(s
);
1052 pa_assert(result
->memblock
);
1053 pa_assert(result
->length
> 0);
1055 /* We optimize for the case where the order of the inputs has not changed */
1057 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
1059 pa_mix_info
* m
= NULL
;
1061 pa_sink_input_assert_ref(i
);
1063 /* Let's try to find the matching entry info the pa_mix_info array */
1064 for (j
= 0; j
< n
; j
++) {
1066 if (info
[p
].userdata
== i
) {
1076 /* Drop read data */
1077 pa_sink_input_drop(i
, result
->length
);
1079 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
)) {
1081 if (pa_hashmap_size(i
->thread_info
.direct_outputs
) > 0) {
1082 void *ostate
= NULL
;
1083 pa_source_output
*o
;
1086 if (m
&& m
->chunk
.memblock
) {
1088 pa_memblock_ref(c
.memblock
);
1089 pa_assert(result
->length
<= c
.length
);
1090 c
.length
= result
->length
;
1092 pa_memchunk_make_writable(&c
, 0);
1093 pa_volume_memchunk(&c
, &s
->sample_spec
, &m
->volume
);
1096 pa_memblock_ref(c
.memblock
);
1097 pa_assert(result
->length
<= c
.length
);
1098 c
.length
= result
->length
;
1101 while ((o
= pa_hashmap_iterate(i
->thread_info
.direct_outputs
, &ostate
, NULL
))) {
1102 pa_source_output_assert_ref(o
);
1103 pa_assert(o
->direct_on_input
== i
);
1104 pa_source_post_direct(s
->monitor_source
, o
, &c
);
1107 pa_memblock_unref(c
.memblock
);
1112 if (m
->chunk
.memblock
) {
1113 pa_memblock_unref(m
->chunk
.memblock
);
1114 pa_memchunk_reset(&m
->chunk
);
1117 pa_sink_input_unref(m
->userdata
);
1124 /* Now drop references to entries that are included in the
1125 * pa_mix_info array but don't exist anymore */
1127 if (n_unreffed
< n
) {
1128 for (; n
> 0; info
++, n
--) {
1130 pa_sink_input_unref(info
->userdata
);
1131 if (info
->chunk
.memblock
)
1132 pa_memblock_unref(info
->chunk
.memblock
);
1136 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
1137 pa_source_post(s
->monitor_source
, result
);
1140 /* Called from IO thread context */
1141 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1142 pa_mix_info info
[MAX_MIX_CHANNELS
];
1144 size_t block_size_max
;
1146 pa_sink_assert_ref(s
);
1147 pa_sink_assert_io_context(s
);
1148 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1149 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1152 pa_assert(!s
->thread_info
.rewind_requested
);
1153 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1155 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1156 result
->memblock
= pa_memblock_ref(s
->silence
.memblock
);
1157 result
->index
= s
->silence
.index
;
1158 result
->length
= PA_MIN(s
->silence
.length
, length
);
1165 length
= pa_frame_align(MIX_BUFFER_LENGTH
, &s
->sample_spec
);
1167 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1168 if (length
> block_size_max
)
1169 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1171 pa_assert(length
> 0);
1173 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1177 *result
= s
->silence
;
1178 pa_memblock_ref(result
->memblock
);
1180 if (result
->length
> length
)
1181 result
->length
= length
;
1183 } else if (n
== 1) {
1186 *result
= info
[0].chunk
;
1187 pa_memblock_ref(result
->memblock
);
1189 if (result
->length
> length
)
1190 result
->length
= length
;
1192 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1194 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
)) {
1195 pa_memblock_unref(result
->memblock
);
1196 pa_silence_memchunk_get(&s
->core
->silence_cache
,
1201 } else if (!pa_cvolume_is_norm(&volume
)) {
1202 pa_memchunk_make_writable(result
, 0);
1203 pa_volume_memchunk(result
, &s
->sample_spec
, &volume
);
1207 result
->memblock
= pa_memblock_new(s
->core
->mempool
, length
);
1209 ptr
= pa_memblock_acquire(result
->memblock
);
1210 result
->length
= pa_mix(info
, n
,
1213 &s
->thread_info
.soft_volume
,
1214 s
->thread_info
.soft_muted
);
1215 pa_memblock_release(result
->memblock
);
1220 inputs_drop(s
, info
, n
, result
);
1225 /* Called from IO thread context */
1226 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
) {
1227 pa_mix_info info
[MAX_MIX_CHANNELS
];
1229 size_t length
, block_size_max
;
1231 pa_sink_assert_ref(s
);
1232 pa_sink_assert_io_context(s
);
1233 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1235 pa_assert(target
->memblock
);
1236 pa_assert(target
->length
> 0);
1237 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1239 pa_assert(!s
->thread_info
.rewind_requested
);
1240 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1242 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1243 pa_silence_memchunk(target
, &s
->sample_spec
);
1249 length
= target
->length
;
1250 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1251 if (length
> block_size_max
)
1252 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1254 pa_assert(length
> 0);
1256 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1259 if (target
->length
> length
)
1260 target
->length
= length
;
1262 pa_silence_memchunk(target
, &s
->sample_spec
);
1263 } else if (n
== 1) {
1266 if (target
->length
> length
)
1267 target
->length
= length
;
1269 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1271 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
))
1272 pa_silence_memchunk(target
, &s
->sample_spec
);
1276 vchunk
= info
[0].chunk
;
1277 pa_memblock_ref(vchunk
.memblock
);
1279 if (vchunk
.length
> length
)
1280 vchunk
.length
= length
;
1282 if (!pa_cvolume_is_norm(&volume
)) {
1283 pa_memchunk_make_writable(&vchunk
, 0);
1284 pa_volume_memchunk(&vchunk
, &s
->sample_spec
, &volume
);
1287 pa_memchunk_memcpy(target
, &vchunk
);
1288 pa_memblock_unref(vchunk
.memblock
);
1294 ptr
= pa_memblock_acquire(target
->memblock
);
1296 target
->length
= pa_mix(info
, n
,
1297 (uint8_t*) ptr
+ target
->index
, length
,
1299 &s
->thread_info
.soft_volume
,
1300 s
->thread_info
.soft_muted
);
1302 pa_memblock_release(target
->memblock
);
1305 inputs_drop(s
, info
, n
, target
);
1310 /* Called from IO thread context */
1311 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
) {
1315 pa_sink_assert_ref(s
);
1316 pa_sink_assert_io_context(s
);
1317 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1319 pa_assert(target
->memblock
);
1320 pa_assert(target
->length
> 0);
1321 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1323 pa_assert(!s
->thread_info
.rewind_requested
);
1324 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1326 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1327 pa_silence_memchunk(target
, &s
->sample_spec
);
1340 pa_sink_render_into(s
, &chunk
);
1349 /* Called from IO thread context */
1350 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1351 pa_sink_assert_ref(s
);
1352 pa_sink_assert_io_context(s
);
1353 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1354 pa_assert(length
> 0);
1355 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1358 pa_assert(!s
->thread_info
.rewind_requested
);
1359 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1363 pa_sink_render(s
, length
, result
);
1365 if (result
->length
< length
) {
1368 pa_memchunk_make_writable(result
, length
);
1370 chunk
.memblock
= result
->memblock
;
1371 chunk
.index
= result
->index
+ result
->length
;
1372 chunk
.length
= length
- result
->length
;
1374 pa_sink_render_into_full(s
, &chunk
);
1376 result
->length
= length
;
1382 /* Called from main thread */
1383 int pa_sink_update_rate(pa_sink
*s
, uint32_t rate
, bool passthrough
) {
1385 uint32_t desired_rate
= rate
;
1386 uint32_t default_rate
= s
->default_sample_rate
;
1387 uint32_t alternate_rate
= s
->alternate_sample_rate
;
1390 bool use_alternate
= false;
1392 if (rate
== s
->sample_spec
.rate
)
1395 if (!s
->update_rate
)
1398 if (PA_UNLIKELY(default_rate
== alternate_rate
&& !passthrough
)) {
1399 pa_log_debug("Default and alternate sample rates are the same.");
1403 if (PA_SINK_IS_RUNNING(s
->state
)) {
1404 pa_log_info("Cannot update rate, SINK_IS_RUNNING, will keep using %u Hz",
1405 s
->sample_spec
.rate
);
1409 if (s
->monitor_source
) {
1410 if (PA_SOURCE_IS_RUNNING(s
->monitor_source
->state
) == true) {
1411 pa_log_info("Cannot update rate, monitor source is RUNNING");
1416 if (PA_UNLIKELY(!pa_sample_rate_valid(desired_rate
)))
1420 pa_assert((default_rate
% 4000 == 0) || (default_rate
% 11025 == 0));
1421 pa_assert((alternate_rate
% 4000 == 0) || (alternate_rate
% 11025 == 0));
1423 if (default_rate
% 11025 == 0) {
1424 if ((alternate_rate
% 4000 == 0) && (desired_rate
% 4000 == 0))
1427 /* default is 4000 multiple */
1428 if ((alternate_rate
% 11025 == 0) && (desired_rate
% 11025 == 0))
1433 desired_rate
= alternate_rate
;
1435 desired_rate
= default_rate
;
1437 desired_rate
= rate
; /* use stream sampling rate, discard default/alternate settings */
1440 if (desired_rate
== s
->sample_spec
.rate
)
1443 if (!passthrough
&& pa_sink_used_by(s
) > 0)
1446 pa_log_debug("Suspending sink %s due to changing the sample rate.", s
->name
);
1447 pa_sink_suspend(s
, true, PA_SUSPEND_INTERNAL
);
1449 if (s
->update_rate(s
, desired_rate
) >= 0) {
1450 /* update monitor source as well */
1451 if (s
->monitor_source
&& !passthrough
)
1452 pa_source_update_rate(s
->monitor_source
, desired_rate
, false);
1453 pa_log_info("Changed sampling rate successfully");
1455 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1456 if (i
->state
== PA_SINK_INPUT_CORKED
)
1457 pa_sink_input_update_rate(i
);
1463 pa_sink_suspend(s
, false, PA_SUSPEND_INTERNAL
);
1468 /* Called from main thread */
1469 pa_usec_t
pa_sink_get_latency(pa_sink
*s
) {
1472 pa_sink_assert_ref(s
);
1473 pa_assert_ctl_context();
1474 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1476 /* The returned value is supposed to be in the time domain of the sound card! */
1478 if (s
->state
== PA_SINK_SUSPENDED
)
1481 if (!(s
->flags
& PA_SINK_LATENCY
))
1484 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) == 0);
1486 /* usec is unsigned, so check that the offset can be added to usec without
1488 if (-s
->latency_offset
<= (int64_t) usec
)
1489 usec
+= s
->latency_offset
;
1496 /* Called from IO thread */
1497 pa_usec_t
pa_sink_get_latency_within_thread(pa_sink
*s
) {
1501 pa_sink_assert_ref(s
);
1502 pa_sink_assert_io_context(s
);
1503 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1505 /* The returned value is supposed to be in the time domain of the sound card! */
1507 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
1510 if (!(s
->flags
& PA_SINK_LATENCY
))
1513 o
= PA_MSGOBJECT(s
);
1515 /* FIXME: We probably should make this a proper vtable callback instead of going through process_msg() */
1517 if (o
->process_msg(o
, PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) < 0)
1520 /* usec is unsigned, so check that the offset can be added to usec without
1522 if (-s
->thread_info
.latency_offset
<= (int64_t) usec
)
1523 usec
+= s
->thread_info
.latency_offset
;
1530 /* Called from the main thread (and also from the IO thread while the main
1531 * thread is waiting).
1533 * When a sink uses volume sharing, it never has the PA_SINK_FLAT_VOLUME flag
1534 * set. Instead, flat volume mode is detected by checking whether the root sink
1535 * has the flag set. */
1536 bool pa_sink_flat_volume_enabled(pa_sink
*s
) {
1537 pa_sink_assert_ref(s
);
1539 s
= pa_sink_get_master(s
);
1542 return (s
->flags
& PA_SINK_FLAT_VOLUME
);
1547 /* Called from the main thread (and also from the IO thread while the main
1548 * thread is waiting). */
1549 pa_sink
*pa_sink_get_master(pa_sink
*s
) {
1550 pa_sink_assert_ref(s
);
1552 while (s
&& (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1553 if (PA_UNLIKELY(!s
->input_to_master
))
1556 s
= s
->input_to_master
->sink
;
1562 /* Called from main context */
1563 bool pa_sink_is_passthrough(pa_sink
*s
) {
1564 pa_sink_input
*alt_i
;
1567 pa_sink_assert_ref(s
);
1569 /* one and only one PASSTHROUGH input can possibly be connected */
1570 if (pa_idxset_size(s
->inputs
) == 1) {
1571 alt_i
= pa_idxset_first(s
->inputs
, &idx
);
1573 if (pa_sink_input_is_passthrough(alt_i
))
1580 /* Called from main context */
1581 void pa_sink_enter_passthrough(pa_sink
*s
) {
1584 /* disable the monitor in passthrough mode */
1585 if (s
->monitor_source
) {
1586 pa_log_debug("Suspending monitor source %s, because the sink is entering the passthrough mode.", s
->monitor_source
->name
);
1587 pa_source_suspend(s
->monitor_source
, true, PA_SUSPEND_PASSTHROUGH
);
1590 /* set the volume to NORM */
1591 s
->saved_volume
= *pa_sink_get_volume(s
, true);
1592 s
->saved_save_volume
= s
->save_volume
;
1594 pa_cvolume_set(&volume
, s
->sample_spec
.channels
, PA_MIN(s
->base_volume
, PA_VOLUME_NORM
));
1595 pa_sink_set_volume(s
, &volume
, true, false);
1598 /* Called from main context */
1599 void pa_sink_leave_passthrough(pa_sink
*s
) {
1600 /* Unsuspend monitor */
1601 if (s
->monitor_source
) {
1602 pa_log_debug("Resuming monitor source %s, because the sink is leaving the passthrough mode.", s
->monitor_source
->name
);
1603 pa_source_suspend(s
->monitor_source
, false, PA_SUSPEND_PASSTHROUGH
);
1606 /* Restore sink volume to what it was before we entered passthrough mode */
1607 pa_sink_set_volume(s
, &s
->saved_volume
, true, s
->saved_save_volume
);
1609 pa_cvolume_init(&s
->saved_volume
);
1610 s
->saved_save_volume
= false;
1613 /* Called from main context. */
1614 static void compute_reference_ratio(pa_sink_input
*i
) {
1616 pa_cvolume remapped
;
1619 pa_assert(pa_sink_flat_volume_enabled(i
->sink
));
1622 * Calculates the reference ratio from the sink's reference
1623 * volume. This basically calculates:
1625 * i->reference_ratio = i->volume / i->sink->reference_volume
1628 remapped
= i
->sink
->reference_volume
;
1629 pa_cvolume_remap(&remapped
, &i
->sink
->channel_map
, &i
->channel_map
);
1631 i
->reference_ratio
.channels
= i
->sample_spec
.channels
;
1633 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1635 /* We don't update when the sink volume is 0 anyway */
1636 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
)
1639 /* Don't update the reference ratio unless necessary */
1640 if (pa_sw_volume_multiply(
1641 i
->reference_ratio
.values
[c
],
1642 remapped
.values
[c
]) == i
->volume
.values
[c
])
1645 i
->reference_ratio
.values
[c
] = pa_sw_volume_divide(
1646 i
->volume
.values
[c
],
1647 remapped
.values
[c
]);
1651 /* Called from main context. Only called for the root sink in volume sharing
1652 * cases, except for internal recursive calls. */
1653 static void compute_reference_ratios(pa_sink
*s
) {
1657 pa_sink_assert_ref(s
);
1658 pa_assert_ctl_context();
1659 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1660 pa_assert(pa_sink_flat_volume_enabled(s
));
1662 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1663 compute_reference_ratio(i
);
1665 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1666 compute_reference_ratios(i
->origin_sink
);
1670 /* Called from main context. Only called for the root sink in volume sharing
1671 * cases, except for internal recursive calls. */
1672 static void compute_real_ratios(pa_sink
*s
) {
1676 pa_sink_assert_ref(s
);
1677 pa_assert_ctl_context();
1678 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1679 pa_assert(pa_sink_flat_volume_enabled(s
));
1681 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1683 pa_cvolume remapped
;
1685 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1686 /* The origin sink uses volume sharing, so this input's real ratio
1687 * is handled as a special case - the real ratio must be 0 dB, and
1688 * as a result i->soft_volume must equal i->volume_factor. */
1689 pa_cvolume_reset(&i
->real_ratio
, i
->real_ratio
.channels
);
1690 i
->soft_volume
= i
->volume_factor
;
1692 compute_real_ratios(i
->origin_sink
);
1698 * This basically calculates:
1700 * i->real_ratio := i->volume / s->real_volume
1701 * i->soft_volume := i->real_ratio * i->volume_factor
1704 remapped
= s
->real_volume
;
1705 pa_cvolume_remap(&remapped
, &s
->channel_map
, &i
->channel_map
);
1707 i
->real_ratio
.channels
= i
->sample_spec
.channels
;
1708 i
->soft_volume
.channels
= i
->sample_spec
.channels
;
1710 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1712 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
) {
1713 /* We leave i->real_ratio untouched */
1714 i
->soft_volume
.values
[c
] = PA_VOLUME_MUTED
;
1718 /* Don't lose accuracy unless necessary */
1719 if (pa_sw_volume_multiply(
1720 i
->real_ratio
.values
[c
],
1721 remapped
.values
[c
]) != i
->volume
.values
[c
])
1723 i
->real_ratio
.values
[c
] = pa_sw_volume_divide(
1724 i
->volume
.values
[c
],
1725 remapped
.values
[c
]);
1727 i
->soft_volume
.values
[c
] = pa_sw_volume_multiply(
1728 i
->real_ratio
.values
[c
],
1729 i
->volume_factor
.values
[c
]);
1732 /* We don't copy the soft_volume to the thread_info data
1733 * here. That must be done by the caller */
1737 static pa_cvolume
*cvolume_remap_minimal_impact(
1739 const pa_cvolume
*template,
1740 const pa_channel_map
*from
,
1741 const pa_channel_map
*to
) {
1746 pa_assert(template);
1749 pa_assert(pa_cvolume_compatible_with_channel_map(v
, from
));
1750 pa_assert(pa_cvolume_compatible_with_channel_map(template, to
));
1752 /* Much like pa_cvolume_remap(), but tries to minimize impact when
1753 * mapping from sink input to sink volumes:
1755 * If template is a possible remapping from v it is used instead
1756 * of remapping anew.
1758 * If the channel maps don't match we set an all-channel volume on
1759 * the sink to ensure that changing a volume on one stream has no
1760 * effect that cannot be compensated for in another stream that
1761 * does not have the same channel map as the sink. */
1763 if (pa_channel_map_equal(from
, to
))
1767 if (pa_cvolume_equal(pa_cvolume_remap(&t
, to
, from
), v
)) {
1772 pa_cvolume_set(v
, to
->channels
, pa_cvolume_max(v
));
1776 /* Called from main thread. Only called for the root sink in volume sharing
1777 * cases, except for internal recursive calls. */
1778 static void get_maximum_input_volume(pa_sink
*s
, pa_cvolume
*max_volume
, const pa_channel_map
*channel_map
) {
1782 pa_sink_assert_ref(s
);
1783 pa_assert(max_volume
);
1784 pa_assert(channel_map
);
1785 pa_assert(pa_sink_flat_volume_enabled(s
));
1787 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1788 pa_cvolume remapped
;
1790 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1791 get_maximum_input_volume(i
->origin_sink
, max_volume
, channel_map
);
1793 /* Ignore this input. The origin sink uses volume sharing, so this
1794 * input's volume will be set to be equal to the root sink's real
1795 * volume. Obviously this input's current volume must not then
1796 * affect what the root sink's real volume will be. */
1800 remapped
= i
->volume
;
1801 cvolume_remap_minimal_impact(&remapped
, max_volume
, &i
->channel_map
, channel_map
);
1802 pa_cvolume_merge(max_volume
, max_volume
, &remapped
);
1806 /* Called from main thread. Only called for the root sink in volume sharing
1807 * cases, except for internal recursive calls. */
1808 static bool has_inputs(pa_sink
*s
) {
1812 pa_sink_assert_ref(s
);
1814 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1815 if (!i
->origin_sink
|| !(i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) || has_inputs(i
->origin_sink
))
1822 /* Called from main thread. Only called for the root sink in volume sharing
1823 * cases, except for internal recursive calls. */
1824 static void update_real_volume(pa_sink
*s
, const pa_cvolume
*new_volume
, pa_channel_map
*channel_map
) {
1828 pa_sink_assert_ref(s
);
1829 pa_assert(new_volume
);
1830 pa_assert(channel_map
);
1832 s
->real_volume
= *new_volume
;
1833 pa_cvolume_remap(&s
->real_volume
, channel_map
, &s
->channel_map
);
1835 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1836 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1837 if (pa_sink_flat_volume_enabled(s
)) {
1838 pa_cvolume new_input_volume
;
1840 /* Follow the root sink's real volume. */
1841 new_input_volume
= *new_volume
;
1842 pa_cvolume_remap(&new_input_volume
, channel_map
, &i
->channel_map
);
1843 pa_sink_input_set_volume_direct(i
, &new_input_volume
);
1844 compute_reference_ratio(i
);
1847 update_real_volume(i
->origin_sink
, new_volume
, channel_map
);
1852 /* Called from main thread. Only called for the root sink in shared volume
1854 static void compute_real_volume(pa_sink
*s
) {
1855 pa_sink_assert_ref(s
);
1856 pa_assert_ctl_context();
1857 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1858 pa_assert(pa_sink_flat_volume_enabled(s
));
1859 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
1861 /* This determines the maximum volume of all streams and sets
1862 * s->real_volume accordingly. */
1864 if (!has_inputs(s
)) {
1865 /* In the special case that we have no sink inputs we leave the
1866 * volume unmodified. */
1867 update_real_volume(s
, &s
->reference_volume
, &s
->channel_map
);
1871 pa_cvolume_mute(&s
->real_volume
, s
->channel_map
.channels
);
1873 /* First let's determine the new maximum volume of all inputs
1874 * connected to this sink */
1875 get_maximum_input_volume(s
, &s
->real_volume
, &s
->channel_map
);
1876 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
1878 /* Then, let's update the real ratios/soft volumes of all inputs
1879 * connected to this sink */
1880 compute_real_ratios(s
);
1883 /* Called from main thread. Only called for the root sink in shared volume
1884 * cases, except for internal recursive calls. */
1885 static void propagate_reference_volume(pa_sink
*s
) {
1889 pa_sink_assert_ref(s
);
1890 pa_assert_ctl_context();
1891 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1892 pa_assert(pa_sink_flat_volume_enabled(s
));
1894 /* This is called whenever the sink volume changes that is not
1895 * caused by a sink input volume change. We need to fix up the
1896 * sink input volumes accordingly */
1898 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1899 pa_cvolume new_volume
;
1901 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1902 propagate_reference_volume(i
->origin_sink
);
1904 /* Since the origin sink uses volume sharing, this input's volume
1905 * needs to be updated to match the root sink's real volume, but
1906 * that will be done later in update_shared_real_volume(). */
1910 /* This basically calculates:
1912 * i->volume := s->reference_volume * i->reference_ratio */
1914 new_volume
= s
->reference_volume
;
1915 pa_cvolume_remap(&new_volume
, &s
->channel_map
, &i
->channel_map
);
1916 pa_sw_cvolume_multiply(&new_volume
, &new_volume
, &i
->reference_ratio
);
1917 pa_sink_input_set_volume_direct(i
, &new_volume
);
1921 /* Called from main thread. Only called for the root sink in volume sharing
1922 * cases, except for internal recursive calls. The return value indicates
1923 * whether any reference volume actually changed. */
1924 static bool update_reference_volume(pa_sink
*s
, const pa_cvolume
*v
, const pa_channel_map
*channel_map
, bool save
) {
1926 bool reference_volume_changed
;
1930 pa_sink_assert_ref(s
);
1931 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1933 pa_assert(channel_map
);
1934 pa_assert(pa_cvolume_valid(v
));
1937 pa_cvolume_remap(&volume
, channel_map
, &s
->channel_map
);
1939 reference_volume_changed
= !pa_cvolume_equal(&volume
, &s
->reference_volume
);
1940 pa_sink_set_reference_volume_direct(s
, &volume
);
1942 s
->save_volume
= (!reference_volume_changed
&& s
->save_volume
) || save
;
1944 if (!reference_volume_changed
&& !(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1945 /* If the root sink's volume doesn't change, then there can't be any
1946 * changes in the other sinks in the sink tree either.
1948 * It's probably theoretically possible that even if the root sink's
1949 * volume changes slightly, some filter sink doesn't change its volume
1950 * due to rounding errors. If that happens, we still want to propagate
1951 * the changed root sink volume to the sinks connected to the
1952 * intermediate sink that didn't change its volume. This theoretical
1953 * possibility is the reason why we have that !(s->flags &
1954 * PA_SINK_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would
1955 * notice even if we returned here false always if
1956 * reference_volume_changed is false. */
1959 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1960 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1961 update_reference_volume(i
->origin_sink
, v
, channel_map
, false);
1967 /* Called from main thread */
1968 void pa_sink_set_volume(
1970 const pa_cvolume
*volume
,
1974 pa_cvolume new_reference_volume
;
1977 pa_sink_assert_ref(s
);
1978 pa_assert_ctl_context();
1979 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1980 pa_assert(!volume
|| pa_cvolume_valid(volume
));
1981 pa_assert(volume
|| pa_sink_flat_volume_enabled(s
));
1982 pa_assert(!volume
|| volume
->channels
== 1 || pa_cvolume_compatible(volume
, &s
->sample_spec
));
1984 /* make sure we don't change the volume when a PASSTHROUGH input is connected ...
1985 * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */
1986 if (pa_sink_is_passthrough(s
) && (!volume
|| !pa_cvolume_is_norm(volume
))) {
1987 pa_log_warn("Cannot change volume, Sink is connected to PASSTHROUGH input");
1991 /* In case of volume sharing, the volume is set for the root sink first,
1992 * from which it's then propagated to the sharing sinks. */
1993 root_sink
= pa_sink_get_master(s
);
1995 if (PA_UNLIKELY(!root_sink
))
1998 /* As a special exception we accept mono volumes on all sinks --
1999 * even on those with more complex channel maps */
2002 if (pa_cvolume_compatible(volume
, &s
->sample_spec
))
2003 new_reference_volume
= *volume
;
2005 new_reference_volume
= s
->reference_volume
;
2006 pa_cvolume_scale(&new_reference_volume
, pa_cvolume_max(volume
));
2009 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
2011 if (update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
)) {
2012 if (pa_sink_flat_volume_enabled(root_sink
)) {
2013 /* OK, propagate this volume change back to the inputs */
2014 propagate_reference_volume(root_sink
);
2016 /* And now recalculate the real volume */
2017 compute_real_volume(root_sink
);
2019 update_real_volume(root_sink
, &root_sink
->reference_volume
, &root_sink
->channel_map
);
2023 /* If volume is NULL we synchronize the sink's real and
2024 * reference volumes with the stream volumes. */
2026 pa_assert(pa_sink_flat_volume_enabled(root_sink
));
2028 /* Ok, let's determine the new real volume */
2029 compute_real_volume(root_sink
);
2031 /* Let's 'push' the reference volume if necessary */
2032 pa_cvolume_merge(&new_reference_volume
, &s
->reference_volume
, &root_sink
->real_volume
);
2033 /* If the sink and its root don't have the same number of channels, we need to remap */
2034 if (s
!= root_sink
&& !pa_channel_map_equal(&s
->channel_map
, &root_sink
->channel_map
))
2035 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
2036 update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
);
2038 /* Now that the reference volume is updated, we can update the streams'
2039 * reference ratios. */
2040 compute_reference_ratios(root_sink
);
2043 if (root_sink
->set_volume
) {
2044 /* If we have a function set_volume(), then we do not apply a
2045 * soft volume by default. However, set_volume() is free to
2046 * apply one to root_sink->soft_volume */
2048 pa_cvolume_reset(&root_sink
->soft_volume
, root_sink
->sample_spec
.channels
);
2049 if (!(root_sink
->flags
& PA_SINK_DEFERRED_VOLUME
))
2050 root_sink
->set_volume(root_sink
);
2053 /* If we have no function set_volume(), then the soft volume
2054 * becomes the real volume */
2055 root_sink
->soft_volume
= root_sink
->real_volume
;
2057 /* This tells the sink that soft volume and/or real volume changed */
2059 pa_assert_se(pa_asyncmsgq_send(root_sink
->asyncmsgq
, PA_MSGOBJECT(root_sink
), PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
) == 0);
2062 /* Called from the io thread if sync volume is used, otherwise from the main thread.
2063 * Only to be called by sink implementor */
2064 void pa_sink_set_soft_volume(pa_sink
*s
, const pa_cvolume
*volume
) {
2066 pa_sink_assert_ref(s
);
2067 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2069 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
2070 pa_sink_assert_io_context(s
);
2072 pa_assert_ctl_context();
2075 pa_cvolume_reset(&s
->soft_volume
, s
->sample_spec
.channels
);
2077 s
->soft_volume
= *volume
;
2079 if (PA_SINK_IS_LINKED(s
->state
) && !(s
->flags
& PA_SINK_DEFERRED_VOLUME
))
2080 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME
, NULL
, 0, NULL
) == 0);
2082 s
->thread_info
.soft_volume
= s
->soft_volume
;
2085 /* Called from the main thread. Only called for the root sink in volume sharing
2086 * cases, except for internal recursive calls. */
2087 static void propagate_real_volume(pa_sink
*s
, const pa_cvolume
*old_real_volume
) {
2091 pa_sink_assert_ref(s
);
2092 pa_assert(old_real_volume
);
2093 pa_assert_ctl_context();
2094 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2096 /* This is called when the hardware's real volume changes due to
2097 * some external event. We copy the real volume into our
2098 * reference volume and then rebuild the stream volumes based on
2099 * i->real_ratio which should stay fixed. */
2101 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
2102 if (pa_cvolume_equal(old_real_volume
, &s
->real_volume
))
2105 /* 1. Make the real volume the reference volume */
2106 update_reference_volume(s
, &s
->real_volume
, &s
->channel_map
, true);
2109 if (pa_sink_flat_volume_enabled(s
)) {
2111 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2112 pa_cvolume new_volume
;
2114 /* 2. Since the sink's reference and real volumes are equal
2115 * now our ratios should be too. */
2116 i
->reference_ratio
= i
->real_ratio
;
2118 /* 3. Recalculate the new stream reference volume based on the
2119 * reference ratio and the sink's reference volume.
2121 * This basically calculates:
2123 * i->volume = s->reference_volume * i->reference_ratio
2125 * This is identical to propagate_reference_volume() */
2126 new_volume
= s
->reference_volume
;
2127 pa_cvolume_remap(&new_volume
, &s
->channel_map
, &i
->channel_map
);
2128 pa_sw_cvolume_multiply(&new_volume
, &new_volume
, &i
->reference_ratio
);
2129 pa_sink_input_set_volume_direct(i
, &new_volume
);
2131 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2132 propagate_real_volume(i
->origin_sink
, old_real_volume
);
2136 /* Something got changed in the hardware. It probably makes sense
2137 * to save changed hw settings given that hw volume changes not
2138 * triggered by PA are almost certainly done by the user. */
2139 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2140 s
->save_volume
= true;
2143 /* Called from io thread */
2144 void pa_sink_update_volume_and_mute(pa_sink
*s
) {
2146 pa_sink_assert_io_context(s
);
2148 pa_asyncmsgq_post(pa_thread_mq_get()->outq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
, NULL
, 0, NULL
, NULL
);
2151 /* Called from main thread */
2152 const pa_cvolume
*pa_sink_get_volume(pa_sink
*s
, bool force_refresh
) {
2153 pa_sink_assert_ref(s
);
2154 pa_assert_ctl_context();
2155 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2157 if (s
->refresh_volume
|| force_refresh
) {
2158 struct pa_cvolume old_real_volume
;
2160 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2162 old_real_volume
= s
->real_volume
;
2164 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
)
2167 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_VOLUME
, NULL
, 0, NULL
) == 0);
2169 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
2170 propagate_real_volume(s
, &old_real_volume
);
2173 return &s
->reference_volume
;
2176 /* Called from main thread. In volume sharing cases, only the root sink may
2178 void pa_sink_volume_changed(pa_sink
*s
, const pa_cvolume
*new_real_volume
) {
2179 pa_cvolume old_real_volume
;
2181 pa_sink_assert_ref(s
);
2182 pa_assert_ctl_context();
2183 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2184 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2186 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2188 old_real_volume
= s
->real_volume
;
2189 update_real_volume(s
, new_real_volume
, &s
->channel_map
);
2190 propagate_real_volume(s
, &old_real_volume
);
2193 /* Called from main thread */
2194 void pa_sink_set_mute(pa_sink
*s
, bool mute
, bool save
) {
2197 pa_sink_assert_ref(s
);
2198 pa_assert_ctl_context();
2200 old_muted
= s
->muted
;
2202 if (mute
== old_muted
) {
2203 s
->save_muted
|= save
;
2208 s
->save_muted
= save
;
2210 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->set_mute
)
2213 if (!PA_SINK_IS_LINKED(s
->state
))
2216 pa_log_debug("The mute of sink %s changed from %s to %s.", s
->name
, pa_yes_no(old_muted
), pa_yes_no(mute
));
2217 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2218 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2221 /* Called from main thread */
2222 bool pa_sink_get_mute(pa_sink
*s
, bool force_refresh
) {
2224 pa_sink_assert_ref(s
);
2225 pa_assert_ctl_context();
2226 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2228 if (s
->refresh_muted
|| force_refresh
) {
2229 bool old_muted
= s
->muted
;
2231 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_mute
)
2234 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MUTE
, NULL
, 0, NULL
) == 0);
2236 if (old_muted
!= s
->muted
) {
2237 s
->save_muted
= true;
2239 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2241 /* Make sure the soft mute status stays in sync */
2242 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2249 /* Called from main thread */
2250 void pa_sink_mute_changed(pa_sink
*s
, bool new_muted
) {
2251 pa_sink_assert_ref(s
);
2252 pa_assert_ctl_context();
2253 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2255 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2257 if (s
->muted
== new_muted
)
2260 s
->muted
= new_muted
;
2261 s
->save_muted
= true;
2263 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2266 /* Called from main thread */
2267 bool pa_sink_update_proplist(pa_sink
*s
, pa_update_mode_t mode
, pa_proplist
*p
) {
2268 pa_sink_assert_ref(s
);
2269 pa_assert_ctl_context();
2272 pa_proplist_update(s
->proplist
, mode
, p
);
2274 if (PA_SINK_IS_LINKED(s
->state
)) {
2275 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2276 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2282 /* Called from main thread */
2283 /* FIXME -- this should be dropped and be merged into pa_sink_update_proplist() */
2284 void pa_sink_set_description(pa_sink
*s
, const char *description
) {
2286 pa_sink_assert_ref(s
);
2287 pa_assert_ctl_context();
2289 if (!description
&& !pa_proplist_contains(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
))
2292 old
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2294 if (old
&& description
&& pa_streq(old
, description
))
2298 pa_proplist_sets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
, description
);
2300 pa_proplist_unset(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2302 if (s
->monitor_source
) {
2305 n
= pa_sprintf_malloc("Monitor Source of %s", description
? description
: s
->name
);
2306 pa_source_set_description(s
->monitor_source
, n
);
2310 if (PA_SINK_IS_LINKED(s
->state
)) {
2311 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2312 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2316 /* Called from main thread */
2317 unsigned pa_sink_linked_by(pa_sink
*s
) {
2320 pa_sink_assert_ref(s
);
2321 pa_assert_ctl_context();
2322 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2324 ret
= pa_idxset_size(s
->inputs
);
2326 /* We add in the number of streams connected to us here. Please
2327 * note the asymmetry to pa_sink_used_by()! */
2329 if (s
->monitor_source
)
2330 ret
+= pa_source_linked_by(s
->monitor_source
);
2335 /* Called from main thread */
2336 unsigned pa_sink_used_by(pa_sink
*s
) {
2339 pa_sink_assert_ref(s
);
2340 pa_assert_ctl_context();
2341 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2343 ret
= pa_idxset_size(s
->inputs
);
2344 pa_assert(ret
>= s
->n_corked
);
2346 /* Streams connected to our monitor source do not matter for
2347 * pa_sink_used_by()!.*/
2349 return ret
- s
->n_corked
;
2352 /* Called from main thread */
2353 unsigned pa_sink_check_suspend(pa_sink
*s
) {
2358 pa_sink_assert_ref(s
);
2359 pa_assert_ctl_context();
2361 if (!PA_SINK_IS_LINKED(s
->state
))
2366 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2367 pa_sink_input_state_t st
;
2369 st
= pa_sink_input_get_state(i
);
2371 /* We do not assert here. It is perfectly valid for a sink input to
2372 * be in the INIT state (i.e. created, marked done but not yet put)
2373 * and we should not care if it's unlinked as it won't contribute
2374 * towards our busy status.
2376 if (!PA_SINK_INPUT_IS_LINKED(st
))
2379 if (st
== PA_SINK_INPUT_CORKED
)
2382 if (i
->flags
& PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND
)
2388 if (s
->monitor_source
)
2389 ret
+= pa_source_check_suspend(s
->monitor_source
);
2394 /* Called from the IO thread */
2395 static void sync_input_volumes_within_thread(pa_sink
*s
) {
2399 pa_sink_assert_ref(s
);
2400 pa_sink_assert_io_context(s
);
2402 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2403 if (pa_cvolume_equal(&i
->thread_info
.soft_volume
, &i
->soft_volume
))
2406 i
->thread_info
.soft_volume
= i
->soft_volume
;
2407 pa_sink_input_request_rewind(i
, 0, true, false, false);
2411 /* Called from the IO thread. Only called for the root sink in volume sharing
2412 * cases, except for internal recursive calls. */
2413 static void set_shared_volume_within_thread(pa_sink
*s
) {
2414 pa_sink_input
*i
= NULL
;
2417 pa_sink_assert_ref(s
);
2419 PA_MSGOBJECT(s
)->process_msg(PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME_SYNCED
, NULL
, 0, NULL
);
2421 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2422 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2423 set_shared_volume_within_thread(i
->origin_sink
);
2427 /* Called from IO thread, except when it is not */
2428 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
2429 pa_sink
*s
= PA_SINK(o
);
2430 pa_sink_assert_ref(s
);
2432 switch ((pa_sink_message_t
) code
) {
2434 case PA_SINK_MESSAGE_ADD_INPUT
: {
2435 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2437 /* If you change anything here, make sure to change the
2438 * sink input handling a few lines down at
2439 * PA_SINK_MESSAGE_FINISH_MOVE, too. */
2441 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2443 /* Since the caller sleeps in pa_sink_input_put(), we can
2444 * safely access data outside of thread_info even though
2447 if ((i
->thread_info
.sync_prev
= i
->sync_prev
)) {
2448 pa_assert(i
->sink
== i
->thread_info
.sync_prev
->sink
);
2449 pa_assert(i
->sync_prev
->sync_next
== i
);
2450 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
;
2453 if ((i
->thread_info
.sync_next
= i
->sync_next
)) {
2454 pa_assert(i
->sink
== i
->thread_info
.sync_next
->sink
);
2455 pa_assert(i
->sync_next
->sync_prev
== i
);
2456 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
;
2459 pa_assert(!i
->thread_info
.attached
);
2460 i
->thread_info
.attached
= true;
2465 pa_sink_input_set_state_within_thread(i
, i
->state
);
2467 /* The requested latency of the sink input needs to be fixed up and
2468 * then configured on the sink. If this causes the sink latency to
2469 * go down, the sink implementor is responsible for doing a rewind
2470 * in the update_requested_latency() callback to ensure that the
2471 * sink buffer doesn't contain more data than what the new latency
2474 * XXX: Does it really make sense to push this responsibility to
2475 * the sink implementors? Wouldn't it be better to do it once in
2476 * the core than many times in the modules? */
2478 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2479 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2481 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2482 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2484 /* We don't rewind here automatically. This is left to the
2485 * sink input implementor because some sink inputs need a
2486 * slow start, i.e. need some time to buffer client
2487 * samples before beginning streaming.
2489 * XXX: Does it really make sense to push this functionality to
2490 * the sink implementors? Wouldn't it be better to do it once in
2491 * the core than many times in the modules? */
2493 /* In flat volume mode we need to update the volume as
2495 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2498 case PA_SINK_MESSAGE_REMOVE_INPUT
: {
2499 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2501 /* If you change anything here, make sure to change the
2502 * sink input handling a few lines down at
2503 * PA_SINK_MESSAGE_START_MOVE, too. */
2508 pa_sink_input_set_state_within_thread(i
, i
->state
);
2510 pa_assert(i
->thread_info
.attached
);
2511 i
->thread_info
.attached
= false;
2513 /* Since the caller sleeps in pa_sink_input_unlink(),
2514 * we can safely access data outside of thread_info even
2515 * though it is mutable */
2517 pa_assert(!i
->sync_prev
);
2518 pa_assert(!i
->sync_next
);
2520 if (i
->thread_info
.sync_prev
) {
2521 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
->thread_info
.sync_prev
->sync_next
;
2522 i
->thread_info
.sync_prev
= NULL
;
2525 if (i
->thread_info
.sync_next
) {
2526 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
->thread_info
.sync_next
->sync_prev
;
2527 i
->thread_info
.sync_next
= NULL
;
2530 pa_hashmap_remove_and_free(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
));
2531 pa_sink_invalidate_requested_latency(s
, true);
2532 pa_sink_request_rewind(s
, (size_t) -1);
2534 /* In flat volume mode we need to update the volume as
2536 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2539 case PA_SINK_MESSAGE_START_MOVE
: {
2540 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2542 /* We don't support moving synchronized streams. */
2543 pa_assert(!i
->sync_prev
);
2544 pa_assert(!i
->sync_next
);
2545 pa_assert(!i
->thread_info
.sync_next
);
2546 pa_assert(!i
->thread_info
.sync_prev
);
2548 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2550 size_t sink_nbytes
, total_nbytes
;
2552 /* The old sink probably has some audio from this
2553 * stream in its buffer. We want to "take it back" as
2554 * much as possible and play it to the new sink. We
2555 * don't know at this point how much the old sink can
2556 * rewind. We have to pick something, and that
2557 * something is the full latency of the old sink here.
2558 * So we rewind the stream buffer by the sink latency
2559 * amount, which may be more than what we should
2560 * rewind. This can result in a chunk of audio being
2561 * played both to the old sink and the new sink.
2563 * FIXME: Fix this code so that we don't have to make
2564 * guesses about how much the sink will actually be
2565 * able to rewind. If someone comes up with a solution
2566 * for this, something to note is that the part of the
2567 * latency that the old sink couldn't rewind should
2568 * ideally be compensated after the stream has moved
2569 * to the new sink by adding silence. The new sink
2570 * most likely can't start playing the moved stream
2571 * immediately, and that gap should be removed from
2572 * the "compensation silence" (at least at the time of
2573 * writing this, the move finish code will actually
2574 * already take care of dropping the new sink's
2575 * unrewindable latency, so taking into account the
2576 * unrewindable latency of the old sink is the only
2579 * The render_memblockq contents are discarded,
2580 * because when the sink changes, the format of the
2581 * audio stored in the render_memblockq may change
2582 * too, making the stored audio invalid. FIXME:
2583 * However, the read and write indices are moved back
2584 * the same amount, so if they are not the same now,
2585 * they won't be the same after the rewind either. If
2586 * the write index of the render_memblockq is ahead of
2587 * the read index, then the render_memblockq will feed
2588 * the new sink some silence first, which it shouldn't
2589 * do. The write index should be flushed to be the
2590 * same as the read index. */
2592 /* Get the latency of the sink */
2593 usec
= pa_sink_get_latency_within_thread(s
);
2594 sink_nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2595 total_nbytes
= sink_nbytes
+ pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
2597 if (total_nbytes
> 0) {
2598 i
->thread_info
.rewrite_nbytes
= i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, total_nbytes
) : total_nbytes
;
2599 i
->thread_info
.rewrite_flush
= true;
2600 pa_sink_input_process_rewind(i
, sink_nbytes
);
2607 pa_assert(i
->thread_info
.attached
);
2608 i
->thread_info
.attached
= false;
2610 /* Let's remove the sink input ...*/
2611 pa_hashmap_remove_and_free(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
));
2613 pa_sink_invalidate_requested_latency(s
, true);
2615 pa_log_debug("Requesting rewind due to started move");
2616 pa_sink_request_rewind(s
, (size_t) -1);
2618 /* In flat volume mode we need to update the volume as
2620 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2623 case PA_SINK_MESSAGE_FINISH_MOVE
: {
2624 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2626 /* We don't support moving synchronized streams. */
2627 pa_assert(!i
->sync_prev
);
2628 pa_assert(!i
->sync_next
);
2629 pa_assert(!i
->thread_info
.sync_next
);
2630 pa_assert(!i
->thread_info
.sync_prev
);
2632 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2634 pa_assert(!i
->thread_info
.attached
);
2635 i
->thread_info
.attached
= true;
2640 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2644 /* In the ideal case the new sink would start playing
2645 * the stream immediately. That requires the sink to
2646 * be able to rewind all of its latency, which usually
2647 * isn't possible, so there will probably be some gap
2648 * before the moved stream becomes audible. We then
2649 * have two possibilities: 1) start playing the stream
2650 * from where it is now, or 2) drop the unrewindable
2651 * latency of the sink from the stream. With option 1
2652 * we won't lose any audio but the stream will have a
2653 * pause. With option 2 we may lose some audio but the
2654 * stream time will be somewhat in sync with the wall
2655 * clock. Lennart seems to have chosen option 2 (one
2656 * of the reasons might have been that option 1 is
2657 * actually much harder to implement), so we drop the
2658 * latency of the new sink from the moved stream and
2659 * hope that the sink will undo most of that in the
2662 /* Get the latency of the sink */
2663 usec
= pa_sink_get_latency_within_thread(s
);
2664 nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2667 pa_sink_input_drop(i
, nbytes
);
2669 pa_log_debug("Requesting rewind due to finished move");
2670 pa_sink_request_rewind(s
, nbytes
);
2673 /* Updating the requested sink latency has to be done
2674 * after the sink rewind request, not before, because
2675 * otherwise the sink may limit the rewind amount
2678 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2679 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2681 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2682 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2684 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2687 case PA_SINK_MESSAGE_SET_SHARED_VOLUME
: {
2688 pa_sink
*root_sink
= pa_sink_get_master(s
);
2690 if (PA_LIKELY(root_sink
))
2691 set_shared_volume_within_thread(root_sink
);
2696 case PA_SINK_MESSAGE_SET_VOLUME_SYNCED
:
2698 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
2700 pa_sink_volume_change_push(s
);
2702 /* Fall through ... */
2704 case PA_SINK_MESSAGE_SET_VOLUME
:
2706 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2707 s
->thread_info
.soft_volume
= s
->soft_volume
;
2708 pa_sink_request_rewind(s
, (size_t) -1);
2711 /* Fall through ... */
2713 case PA_SINK_MESSAGE_SYNC_VOLUMES
:
2714 sync_input_volumes_within_thread(s
);
2717 case PA_SINK_MESSAGE_GET_VOLUME
:
2719 if ((s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
) {
2721 pa_sink_volume_change_flush(s
);
2722 pa_sw_cvolume_divide(&s
->thread_info
.current_hw_volume
, &s
->real_volume
, &s
->soft_volume
);
2725 /* In case sink implementor reset SW volume. */
2726 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2727 s
->thread_info
.soft_volume
= s
->soft_volume
;
2728 pa_sink_request_rewind(s
, (size_t) -1);
2733 case PA_SINK_MESSAGE_SET_MUTE
:
2735 if (s
->thread_info
.soft_muted
!= s
->muted
) {
2736 s
->thread_info
.soft_muted
= s
->muted
;
2737 pa_sink_request_rewind(s
, (size_t) -1);
2740 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->set_mute
)
2745 case PA_SINK_MESSAGE_GET_MUTE
:
2747 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->get_mute
)
2752 case PA_SINK_MESSAGE_SET_STATE
: {
2754 bool suspend_change
=
2755 (s
->thread_info
.state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(PA_PTR_TO_UINT(userdata
))) ||
2756 (PA_SINK_IS_OPENED(s
->thread_info
.state
) && PA_PTR_TO_UINT(userdata
) == PA_SINK_SUSPENDED
);
2758 s
->thread_info
.state
= PA_PTR_TO_UINT(userdata
);
2760 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
2761 s
->thread_info
.rewind_nbytes
= 0;
2762 s
->thread_info
.rewind_requested
= false;
2765 if (suspend_change
) {
2769 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
2770 if (i
->suspend_within_thread
)
2771 i
->suspend_within_thread(i
, s
->thread_info
.state
== PA_SINK_SUSPENDED
);
2777 case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
: {
2779 pa_usec_t
*usec
= userdata
;
2780 *usec
= pa_sink_get_requested_latency_within_thread(s
);
2782 /* Yes, that's right, the IO thread will see -1 when no
2783 * explicit requested latency is configured, the main
2784 * thread will see max_latency */
2785 if (*usec
== (pa_usec_t
) -1)
2786 *usec
= s
->thread_info
.max_latency
;
2791 case PA_SINK_MESSAGE_SET_LATENCY_RANGE
: {
2792 pa_usec_t
*r
= userdata
;
2794 pa_sink_set_latency_range_within_thread(s
, r
[0], r
[1]);
2799 case PA_SINK_MESSAGE_GET_LATENCY_RANGE
: {
2800 pa_usec_t
*r
= userdata
;
2802 r
[0] = s
->thread_info
.min_latency
;
2803 r
[1] = s
->thread_info
.max_latency
;
2808 case PA_SINK_MESSAGE_GET_FIXED_LATENCY
:
2810 *((pa_usec_t
*) userdata
) = s
->thread_info
.fixed_latency
;
2813 case PA_SINK_MESSAGE_SET_FIXED_LATENCY
:
2815 pa_sink_set_fixed_latency_within_thread(s
, (pa_usec_t
) offset
);
2818 case PA_SINK_MESSAGE_GET_MAX_REWIND
:
2820 *((size_t*) userdata
) = s
->thread_info
.max_rewind
;
2823 case PA_SINK_MESSAGE_GET_MAX_REQUEST
:
2825 *((size_t*) userdata
) = s
->thread_info
.max_request
;
2828 case PA_SINK_MESSAGE_SET_MAX_REWIND
:
2830 pa_sink_set_max_rewind_within_thread(s
, (size_t) offset
);
2833 case PA_SINK_MESSAGE_SET_MAX_REQUEST
:
2835 pa_sink_set_max_request_within_thread(s
, (size_t) offset
);
2838 case PA_SINK_MESSAGE_SET_PORT
:
2840 pa_assert(userdata
);
2842 struct sink_message_set_port
*msg_data
= userdata
;
2843 msg_data
->ret
= s
->set_port(s
, msg_data
->port
);
2847 case PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
:
2848 /* This message is sent from IO-thread and handled in main thread. */
2849 pa_assert_ctl_context();
2851 /* Make sure we're not messing with main thread when no longer linked */
2852 if (!PA_SINK_IS_LINKED(s
->state
))
2855 pa_sink_get_volume(s
, true);
2856 pa_sink_get_mute(s
, true);
2859 case PA_SINK_MESSAGE_SET_LATENCY_OFFSET
:
2860 s
->thread_info
.latency_offset
= offset
;
2863 case PA_SINK_MESSAGE_GET_LATENCY
:
2864 case PA_SINK_MESSAGE_MAX
:
2871 /* Called from main thread */
2872 int pa_sink_suspend_all(pa_core
*c
, bool suspend
, pa_suspend_cause_t cause
) {
2877 pa_core_assert_ref(c
);
2878 pa_assert_ctl_context();
2879 pa_assert(cause
!= 0);
2881 PA_IDXSET_FOREACH(sink
, c
->sinks
, idx
) {
2884 if ((r
= pa_sink_suspend(sink
, suspend
, cause
)) < 0)
2891 /* Called from IO thread */
2892 void pa_sink_detach_within_thread(pa_sink
*s
) {
2896 pa_sink_assert_ref(s
);
2897 pa_sink_assert_io_context(s
);
2898 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2900 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2904 if (s
->monitor_source
)
2905 pa_source_detach_within_thread(s
->monitor_source
);
2908 /* Called from IO thread */
2909 void pa_sink_attach_within_thread(pa_sink
*s
) {
2913 pa_sink_assert_ref(s
);
2914 pa_sink_assert_io_context(s
);
2915 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2917 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2921 if (s
->monitor_source
)
2922 pa_source_attach_within_thread(s
->monitor_source
);
2925 /* Called from IO thread */
2926 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
) {
2927 pa_sink_assert_ref(s
);
2928 pa_sink_assert_io_context(s
);
2929 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2931 if (nbytes
== (size_t) -1)
2932 nbytes
= s
->thread_info
.max_rewind
;
2934 nbytes
= PA_MIN(nbytes
, s
->thread_info
.max_rewind
);
2936 if (s
->thread_info
.rewind_requested
&&
2937 nbytes
<= s
->thread_info
.rewind_nbytes
)
2940 s
->thread_info
.rewind_nbytes
= nbytes
;
2941 s
->thread_info
.rewind_requested
= true;
2943 if (s
->request_rewind
)
2944 s
->request_rewind(s
);
2947 /* Called from IO thread */
2948 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
) {
2949 pa_usec_t result
= (pa_usec_t
) -1;
2952 pa_usec_t monitor_latency
;
2954 pa_sink_assert_ref(s
);
2955 pa_sink_assert_io_context(s
);
2957 if (!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
2958 return PA_CLAMP(s
->thread_info
.fixed_latency
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
2960 if (s
->thread_info
.requested_latency_valid
)
2961 return s
->thread_info
.requested_latency
;
2963 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2964 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1 &&
2965 (result
== (pa_usec_t
) -1 || result
> i
->thread_info
.requested_sink_latency
))
2966 result
= i
->thread_info
.requested_sink_latency
;
2968 monitor_latency
= pa_source_get_requested_latency_within_thread(s
->monitor_source
);
2970 if (monitor_latency
!= (pa_usec_t
) -1 &&
2971 (result
== (pa_usec_t
) -1 || result
> monitor_latency
))
2972 result
= monitor_latency
;
2974 if (result
!= (pa_usec_t
) -1)
2975 result
= PA_CLAMP(result
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
2977 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
2978 /* Only cache if properly initialized */
2979 s
->thread_info
.requested_latency
= result
;
2980 s
->thread_info
.requested_latency_valid
= true;
2986 /* Called from main thread */
2987 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
) {
2990 pa_sink_assert_ref(s
);
2991 pa_assert_ctl_context();
2992 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2994 if (s
->state
== PA_SINK_SUSPENDED
)
2997 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
3002 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3003 void pa_sink_set_max_rewind_within_thread(pa_sink
*s
, size_t max_rewind
) {
3007 pa_sink_assert_ref(s
);
3008 pa_sink_assert_io_context(s
);
3010 if (max_rewind
== s
->thread_info
.max_rewind
)
3013 s
->thread_info
.max_rewind
= max_rewind
;
3015 if (PA_SINK_IS_LINKED(s
->thread_info
.state
))
3016 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3017 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
3019 if (s
->monitor_source
)
3020 pa_source_set_max_rewind_within_thread(s
->monitor_source
, s
->thread_info
.max_rewind
);
3023 /* Called from main thread */
3024 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
) {
3025 pa_sink_assert_ref(s
);
3026 pa_assert_ctl_context();
3028 if (PA_SINK_IS_LINKED(s
->state
))
3029 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REWIND
, NULL
, max_rewind
, NULL
) == 0);
3031 pa_sink_set_max_rewind_within_thread(s
, max_rewind
);
3034 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3035 void pa_sink_set_max_request_within_thread(pa_sink
*s
, size_t max_request
) {
3038 pa_sink_assert_ref(s
);
3039 pa_sink_assert_io_context(s
);
3041 if (max_request
== s
->thread_info
.max_request
)
3044 s
->thread_info
.max_request
= max_request
;
3046 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3049 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3050 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
3054 /* Called from main thread */
3055 void pa_sink_set_max_request(pa_sink
*s
, size_t max_request
) {
3056 pa_sink_assert_ref(s
);
3057 pa_assert_ctl_context();
3059 if (PA_SINK_IS_LINKED(s
->state
))
3060 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REQUEST
, NULL
, max_request
, NULL
) == 0);
3062 pa_sink_set_max_request_within_thread(s
, max_request
);
3065 /* Called from IO thread */
3066 void pa_sink_invalidate_requested_latency(pa_sink
*s
, bool dynamic
) {
3070 pa_sink_assert_ref(s
);
3071 pa_sink_assert_io_context(s
);
3073 if ((s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
3074 s
->thread_info
.requested_latency_valid
= false;
3078 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3080 if (s
->update_requested_latency
)
3081 s
->update_requested_latency(s
);
3083 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3084 if (i
->update_sink_requested_latency
)
3085 i
->update_sink_requested_latency(i
);
3089 /* Called from main thread */
3090 void pa_sink_set_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3091 pa_sink_assert_ref(s
);
3092 pa_assert_ctl_context();
3094 /* min_latency == 0: no limit
3095 * min_latency anything else: specified limit
3097 * Similar for max_latency */
3099 if (min_latency
< ABSOLUTE_MIN_LATENCY
)
3100 min_latency
= ABSOLUTE_MIN_LATENCY
;
3102 if (max_latency
<= 0 ||
3103 max_latency
> ABSOLUTE_MAX_LATENCY
)
3104 max_latency
= ABSOLUTE_MAX_LATENCY
;
3106 pa_assert(min_latency
<= max_latency
);
3108 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3109 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3110 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3111 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3113 if (PA_SINK_IS_LINKED(s
->state
)) {
3119 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3121 pa_sink_set_latency_range_within_thread(s
, min_latency
, max_latency
);
3124 /* Called from main thread */
3125 void pa_sink_get_latency_range(pa_sink
*s
, pa_usec_t
*min_latency
, pa_usec_t
*max_latency
) {
3126 pa_sink_assert_ref(s
);
3127 pa_assert_ctl_context();
3128 pa_assert(min_latency
);
3129 pa_assert(max_latency
);
3131 if (PA_SINK_IS_LINKED(s
->state
)) {
3132 pa_usec_t r
[2] = { 0, 0 };
3134 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3136 *min_latency
= r
[0];
3137 *max_latency
= r
[1];
3139 *min_latency
= s
->thread_info
.min_latency
;
3140 *max_latency
= s
->thread_info
.max_latency
;
3144 /* Called from IO thread */
3145 void pa_sink_set_latency_range_within_thread(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3146 pa_sink_assert_ref(s
);
3147 pa_sink_assert_io_context(s
);
3149 pa_assert(min_latency
>= ABSOLUTE_MIN_LATENCY
);
3150 pa_assert(max_latency
<= ABSOLUTE_MAX_LATENCY
);
3151 pa_assert(min_latency
<= max_latency
);
3153 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3154 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3155 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3156 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3158 if (s
->thread_info
.min_latency
== min_latency
&&
3159 s
->thread_info
.max_latency
== max_latency
)
3162 s
->thread_info
.min_latency
= min_latency
;
3163 s
->thread_info
.max_latency
= max_latency
;
3165 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3169 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3170 if (i
->update_sink_latency_range
)
3171 i
->update_sink_latency_range(i
);
3174 pa_sink_invalidate_requested_latency(s
, false);
3176 pa_source_set_latency_range_within_thread(s
->monitor_source
, min_latency
, max_latency
);
3179 /* Called from main thread */
3180 void pa_sink_set_fixed_latency(pa_sink
*s
, pa_usec_t latency
) {
3181 pa_sink_assert_ref(s
);
3182 pa_assert_ctl_context();
3184 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3185 pa_assert(latency
== 0);
3189 if (latency
< ABSOLUTE_MIN_LATENCY
)
3190 latency
= ABSOLUTE_MIN_LATENCY
;
3192 if (latency
> ABSOLUTE_MAX_LATENCY
)
3193 latency
= ABSOLUTE_MAX_LATENCY
;
3195 if (PA_SINK_IS_LINKED(s
->state
))
3196 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_FIXED_LATENCY
, NULL
, (int64_t) latency
, NULL
) == 0);
3198 s
->thread_info
.fixed_latency
= latency
;
3200 pa_source_set_fixed_latency(s
->monitor_source
, latency
);
3203 /* Called from main thread */
3204 pa_usec_t
pa_sink_get_fixed_latency(pa_sink
*s
) {
3207 pa_sink_assert_ref(s
);
3208 pa_assert_ctl_context();
3210 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
)
3213 if (PA_SINK_IS_LINKED(s
->state
))
3214 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_FIXED_LATENCY
, &latency
, 0, NULL
) == 0);
3216 latency
= s
->thread_info
.fixed_latency
;
3221 /* Called from IO thread */
3222 void pa_sink_set_fixed_latency_within_thread(pa_sink
*s
, pa_usec_t latency
) {
3223 pa_sink_assert_ref(s
);
3224 pa_sink_assert_io_context(s
);
3226 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3227 pa_assert(latency
== 0);
3228 s
->thread_info
.fixed_latency
= 0;
3230 if (s
->monitor_source
)
3231 pa_source_set_fixed_latency_within_thread(s
->monitor_source
, 0);
3236 pa_assert(latency
>= ABSOLUTE_MIN_LATENCY
);
3237 pa_assert(latency
<= ABSOLUTE_MAX_LATENCY
);
3239 if (s
->thread_info
.fixed_latency
== latency
)
3242 s
->thread_info
.fixed_latency
= latency
;
3244 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3248 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3249 if (i
->update_sink_fixed_latency
)
3250 i
->update_sink_fixed_latency(i
);
3253 pa_sink_invalidate_requested_latency(s
, false);
3255 pa_source_set_fixed_latency_within_thread(s
->monitor_source
, latency
);
3258 /* Called from main context */
3259 void pa_sink_set_latency_offset(pa_sink
*s
, int64_t offset
) {
3260 pa_sink_assert_ref(s
);
3262 s
->latency_offset
= offset
;
3264 if (PA_SINK_IS_LINKED(s
->state
))
3265 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_LATENCY_OFFSET
, NULL
, offset
, NULL
) == 0);
3267 s
->thread_info
.latency_offset
= offset
;
3270 /* Called from main context */
3271 size_t pa_sink_get_max_rewind(pa_sink
*s
) {
3273 pa_assert_ctl_context();
3274 pa_sink_assert_ref(s
);
3276 if (!PA_SINK_IS_LINKED(s
->state
))
3277 return s
->thread_info
.max_rewind
;
3279 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REWIND
, &r
, 0, NULL
) == 0);
3284 /* Called from main context */
3285 size_t pa_sink_get_max_request(pa_sink
*s
) {
3287 pa_sink_assert_ref(s
);
3288 pa_assert_ctl_context();
3290 if (!PA_SINK_IS_LINKED(s
->state
))
3291 return s
->thread_info
.max_request
;
3293 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REQUEST
, &r
, 0, NULL
) == 0);
3298 /* Called from main context */
3299 int pa_sink_set_port(pa_sink
*s
, const char *name
, bool save
) {
3300 pa_device_port
*port
;
3303 pa_sink_assert_ref(s
);
3304 pa_assert_ctl_context();
3307 pa_log_debug("set_port() operation not implemented for sink %u \"%s\"", s
->index
, s
->name
);
3308 return -PA_ERR_NOTIMPLEMENTED
;
3312 return -PA_ERR_NOENTITY
;
3314 if (!(port
= pa_hashmap_get(s
->ports
, name
)))
3315 return -PA_ERR_NOENTITY
;
3317 if (s
->active_port
== port
) {
3318 s
->save_port
= s
->save_port
|| save
;
3322 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
3323 struct sink_message_set_port msg
= { .port
= port
, .ret
= 0 };
3324 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_PORT
, &msg
, 0, NULL
) == 0);
3328 ret
= s
->set_port(s
, port
);
3331 return -PA_ERR_NOENTITY
;
3333 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
3335 pa_log_info("Changed port of sink %u \"%s\" to %s", s
->index
, s
->name
, port
->name
);
3337 s
->active_port
= port
;
3338 s
->save_port
= save
;
3340 pa_sink_set_latency_offset(s
, s
->active_port
->latency_offset
);
3342 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PORT_CHANGED
], s
);
3347 bool pa_device_init_icon(pa_proplist
*p
, bool is_sink
) {
3348 const char *ff
, *c
, *t
= NULL
, *s
= "", *profile
, *bus
;
3352 if (pa_proplist_contains(p
, PA_PROP_DEVICE_ICON_NAME
))
3355 if ((ff
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3357 if (pa_streq(ff
, "microphone"))
3358 t
= "audio-input-microphone";
3359 else if (pa_streq(ff
, "webcam"))
3361 else if (pa_streq(ff
, "computer"))
3363 else if (pa_streq(ff
, "handset"))
3365 else if (pa_streq(ff
, "portable"))
3366 t
= "multimedia-player";
3367 else if (pa_streq(ff
, "tv"))
3368 t
= "video-display";
3371 * The following icons are not part of the icon naming spec,
3372 * because Rodney Dawes sucks as the maintainer of that spec.
3374 * http://lists.freedesktop.org/archives/xdg/2009-May/010397.html
3376 else if (pa_streq(ff
, "headset"))
3377 t
= "audio-headset";
3378 else if (pa_streq(ff
, "headphone"))
3379 t
= "audio-headphones";
3380 else if (pa_streq(ff
, "speaker"))
3381 t
= "audio-speakers";
3382 else if (pa_streq(ff
, "hands-free"))
3383 t
= "audio-handsfree";
3387 if ((c
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3388 if (pa_streq(c
, "modem"))
3395 t
= "audio-input-microphone";
3398 if ((profile
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3399 if (strstr(profile
, "analog"))
3401 else if (strstr(profile
, "iec958"))
3403 else if (strstr(profile
, "hdmi"))
3407 bus
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
);
3409 pa_proplist_setf(p
, PA_PROP_DEVICE_ICON_NAME
, "%s%s%s%s", t
, pa_strempty(s
), bus
? "-" : "", pa_strempty(bus
));
3414 bool pa_device_init_description(pa_proplist
*p
, pa_card
*card
) {
3415 const char *s
, *d
= NULL
, *k
;
3418 if (pa_proplist_contains(p
, PA_PROP_DEVICE_DESCRIPTION
))
3422 if ((s
= pa_proplist_gets(card
->proplist
, PA_PROP_DEVICE_DESCRIPTION
)))
3426 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3427 if (pa_streq(s
, "internal"))
3428 d
= _("Built-in Audio");
3431 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3432 if (pa_streq(s
, "modem"))
3436 d
= pa_proplist_gets(p
, PA_PROP_DEVICE_PRODUCT_NAME
);
3441 k
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_DESCRIPTION
);
3444 pa_proplist_setf(p
, PA_PROP_DEVICE_DESCRIPTION
, "%s %s", d
, k
);
3446 pa_proplist_sets(p
, PA_PROP_DEVICE_DESCRIPTION
, d
);
3451 bool pa_device_init_intended_roles(pa_proplist
*p
) {
3455 if (pa_proplist_contains(p
, PA_PROP_DEVICE_INTENDED_ROLES
))
3458 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3459 if (pa_streq(s
, "handset") || pa_streq(s
, "hands-free")
3460 || pa_streq(s
, "headset")) {
3461 pa_proplist_sets(p
, PA_PROP_DEVICE_INTENDED_ROLES
, "phone");
3468 unsigned pa_device_init_priority(pa_proplist
*p
) {
3470 unsigned priority
= 0;
3474 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
))) {
3476 if (pa_streq(s
, "sound"))
3478 else if (!pa_streq(s
, "modem"))
3482 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3484 if (pa_streq(s
, "internal"))
3486 else if (pa_streq(s
, "speaker"))
3488 else if (pa_streq(s
, "headphone"))
3492 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
))) {
3494 if (pa_streq(s
, "pci"))
3496 else if (pa_streq(s
, "usb"))
3498 else if (pa_streq(s
, "bluetooth"))
3502 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3504 if (pa_startswith(s
, "analog-"))
3506 else if (pa_startswith(s
, "iec958-"))
3513 PA_STATIC_FLIST_DECLARE(pa_sink_volume_change
, 0, pa_xfree
);
3515 /* Called from the IO thread. */
3516 static pa_sink_volume_change
*pa_sink_volume_change_new(pa_sink
*s
) {
3517 pa_sink_volume_change
*c
;
3518 if (!(c
= pa_flist_pop(PA_STATIC_FLIST_GET(pa_sink_volume_change
))))
3519 c
= pa_xnew(pa_sink_volume_change
, 1);
3521 PA_LLIST_INIT(pa_sink_volume_change
, c
);
3523 pa_cvolume_reset(&c
->hw_volume
, s
->sample_spec
.channels
);
3527 /* Called from the IO thread. */
3528 static void pa_sink_volume_change_free(pa_sink_volume_change
*c
) {
3530 if (pa_flist_push(PA_STATIC_FLIST_GET(pa_sink_volume_change
), c
) < 0)
3534 /* Called from the IO thread. */
3535 void pa_sink_volume_change_push(pa_sink
*s
) {
3536 pa_sink_volume_change
*c
= NULL
;
3537 pa_sink_volume_change
*nc
= NULL
;
3538 uint32_t safety_margin
= s
->thread_info
.volume_change_safety_margin
;
3540 const char *direction
= NULL
;
3543 nc
= pa_sink_volume_change_new(s
);
3545 /* NOTE: There is already more different volumes in pa_sink that I can remember.
3546 * Adding one more volume for HW would get us rid of this, but I am trying
3547 * to survive with the ones we already have. */
3548 pa_sw_cvolume_divide(&nc
->hw_volume
, &s
->real_volume
, &s
->soft_volume
);
3550 if (!s
->thread_info
.volume_changes
&& pa_cvolume_equal(&nc
->hw_volume
, &s
->thread_info
.current_hw_volume
)) {
3551 pa_log_debug("Volume not changing");
3552 pa_sink_volume_change_free(nc
);
3556 nc
->at
= pa_sink_get_latency_within_thread(s
);
3557 nc
->at
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3559 if (s
->thread_info
.volume_changes_tail
) {
3560 for (c
= s
->thread_info
.volume_changes_tail
; c
; c
= c
->prev
) {
3561 /* If volume is going up let's do it a bit late. If it is going
3562 * down let's do it a bit early. */
3563 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&c
->hw_volume
)) {
3564 if (nc
->at
+ safety_margin
> c
->at
) {
3565 nc
->at
+= safety_margin
;
3570 else if (nc
->at
- safety_margin
> c
->at
) {
3571 nc
->at
-= safety_margin
;
3579 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&s
->thread_info
.current_hw_volume
)) {
3580 nc
->at
+= safety_margin
;
3583 nc
->at
-= safety_margin
;
3586 PA_LLIST_PREPEND(pa_sink_volume_change
, s
->thread_info
.volume_changes
, nc
);
3589 PA_LLIST_INSERT_AFTER(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
, nc
);
3592 pa_log_debug("Volume going %s to %d at %llu", direction
, pa_cvolume_avg(&nc
->hw_volume
), (long long unsigned) nc
->at
);
3594 /* We can ignore volume events that came earlier but should happen later than this. */
3595 PA_LLIST_FOREACH(c
, nc
->next
) {
3596 pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
);
3597 pa_sink_volume_change_free(c
);
3600 s
->thread_info
.volume_changes_tail
= nc
;
3603 /* Called from the IO thread. */
3604 static void pa_sink_volume_change_flush(pa_sink
*s
) {
3605 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3607 s
->thread_info
.volume_changes
= NULL
;
3608 s
->thread_info
.volume_changes_tail
= NULL
;
3610 pa_sink_volume_change
*next
= c
->next
;
3611 pa_sink_volume_change_free(c
);
3616 /* Called from the IO thread. */
3617 bool pa_sink_volume_change_apply(pa_sink
*s
, pa_usec_t
*usec_to_next
) {
3623 if (!s
->thread_info
.volume_changes
|| !PA_SINK_IS_LINKED(s
->state
)) {
3629 pa_assert(s
->write_volume
);
3631 now
= pa_rtclock_now();
3633 while (s
->thread_info
.volume_changes
&& now
>= s
->thread_info
.volume_changes
->at
) {
3634 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3635 PA_LLIST_REMOVE(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
);
3636 pa_log_debug("Volume change to %d at %llu was written %llu usec late",
3637 pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
, (long long unsigned) (now
- c
->at
));
3639 s
->thread_info
.current_hw_volume
= c
->hw_volume
;
3640 pa_sink_volume_change_free(c
);
3646 if (s
->thread_info
.volume_changes
) {
3648 *usec_to_next
= s
->thread_info
.volume_changes
->at
- now
;
3649 if (pa_log_ratelimit(PA_LOG_DEBUG
))
3650 pa_log_debug("Next volume change in %lld usec", (long long) (s
->thread_info
.volume_changes
->at
- now
));
3655 s
->thread_info
.volume_changes_tail
= NULL
;
3660 /* Called from the IO thread. */
3661 static void pa_sink_volume_change_rewind(pa_sink
*s
, size_t nbytes
) {
3662 /* All the queued volume events later than current latency are shifted to happen earlier. */
3663 pa_sink_volume_change
*c
;
3664 pa_volume_t prev_vol
= pa_cvolume_avg(&s
->thread_info
.current_hw_volume
);
3665 pa_usec_t rewound
= pa_bytes_to_usec(nbytes
, &s
->sample_spec
);
3666 pa_usec_t limit
= pa_sink_get_latency_within_thread(s
);
3668 pa_log_debug("latency = %lld", (long long) limit
);
3669 limit
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3671 PA_LLIST_FOREACH(c
, s
->thread_info
.volume_changes
) {
3672 pa_usec_t modified_limit
= limit
;
3673 if (prev_vol
> pa_cvolume_avg(&c
->hw_volume
))
3674 modified_limit
-= s
->thread_info
.volume_change_safety_margin
;
3676 modified_limit
+= s
->thread_info
.volume_change_safety_margin
;
3677 if (c
->at
> modified_limit
) {
3679 if (c
->at
< modified_limit
)
3680 c
->at
= modified_limit
;
3682 prev_vol
= pa_cvolume_avg(&c
->hw_volume
);
3684 pa_sink_volume_change_apply(s
, NULL
);
3687 /* Called from the main thread */
3688 /* Gets the list of formats supported by the sink. The members and idxset must
3689 * be freed by the caller. */
3690 pa_idxset
* pa_sink_get_formats(pa_sink
*s
) {
3695 if (s
->get_formats
) {
3696 /* Sink supports format query, all is good */
3697 ret
= s
->get_formats(s
);
3699 /* Sink doesn't support format query, so assume it does PCM */
3700 pa_format_info
*f
= pa_format_info_new();
3701 f
->encoding
= PA_ENCODING_PCM
;
3703 ret
= pa_idxset_new(NULL
, NULL
);
3704 pa_idxset_put(ret
, f
, NULL
);
3710 /* Called from the main thread */
3711 /* Allows an external source to set what formats a sink supports if the sink
3712 * permits this. The function makes a copy of the formats on success. */
3713 bool pa_sink_set_formats(pa_sink
*s
, pa_idxset
*formats
) {
3718 /* Sink supports setting formats -- let's give it a shot */
3719 return s
->set_formats(s
, formats
);
3721 /* Sink doesn't support setting this -- bail out */
3725 /* Called from the main thread */
3726 /* Checks if the sink can accept this format */
3727 bool pa_sink_check_format(pa_sink
*s
, pa_format_info
*f
) {
3728 pa_idxset
*formats
= NULL
;
3734 formats
= pa_sink_get_formats(s
);
3737 pa_format_info
*finfo_device
;
3740 PA_IDXSET_FOREACH(finfo_device
, formats
, i
) {
3741 if (pa_format_info_is_compatible(finfo_device
, f
)) {
3747 pa_idxset_free(formats
, (pa_free_cb_t
) pa_format_info_free
);
3753 /* Called from the main thread */
3754 /* Calculates the intersection between formats supported by the sink and
3755 * in_formats, and returns these, in the order of the sink's formats. */
3756 pa_idxset
* pa_sink_check_formats(pa_sink
*s
, pa_idxset
*in_formats
) {
3757 pa_idxset
*out_formats
= pa_idxset_new(NULL
, NULL
), *sink_formats
= NULL
;
3758 pa_format_info
*f_sink
, *f_in
;
3763 if (!in_formats
|| pa_idxset_isempty(in_formats
))
3766 sink_formats
= pa_sink_get_formats(s
);
3768 PA_IDXSET_FOREACH(f_sink
, sink_formats
, i
) {
3769 PA_IDXSET_FOREACH(f_in
, in_formats
, j
) {
3770 if (pa_format_info_is_compatible(f_sink
, f_in
))
3771 pa_idxset_put(out_formats
, pa_format_info_copy(f_in
), NULL
);
3777 pa_idxset_free(sink_formats
, (pa_free_cb_t
) pa_format_info_free
);
3782 /* Called from the main thread. */
3783 void pa_sink_set_reference_volume_direct(pa_sink
*s
, const pa_cvolume
*volume
) {
3784 pa_cvolume old_volume
;
3785 char old_volume_str
[PA_CVOLUME_SNPRINT_VERBOSE_MAX
];
3786 char new_volume_str
[PA_CVOLUME_SNPRINT_VERBOSE_MAX
];
3791 old_volume
= s
->reference_volume
;
3793 if (pa_cvolume_equal(volume
, &old_volume
))
3796 s
->reference_volume
= *volume
;
3797 pa_log_debug("The reference volume of sink %s changed from %s to %s.", s
->name
,
3798 pa_cvolume_snprint_verbose(old_volume_str
, sizeof(old_volume_str
), &old_volume
, &s
->channel_map
,
3799 s
->flags
& PA_SINK_DECIBEL_VOLUME
),
3800 pa_cvolume_snprint_verbose(new_volume_str
, sizeof(new_volume_str
), volume
, &s
->channel_map
,
3801 s
->flags
& PA_SINK_DECIBEL_VOLUME
));
3803 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);