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/core-subscribe.h>
46 #include <pulsecore/log.h>
47 #include <pulsecore/macro.h>
48 #include <pulsecore/play-memblockq.h>
49 #include <pulsecore/flist.h>
53 #define MAX_MIX_CHANNELS 32
54 #define MIX_BUFFER_LENGTH (PA_PAGE_SIZE)
55 #define ABSOLUTE_MIN_LATENCY (500)
56 #define ABSOLUTE_MAX_LATENCY (10*PA_USEC_PER_SEC)
57 #define DEFAULT_FIXED_LATENCY (250*PA_USEC_PER_MSEC)
59 PA_DEFINE_PUBLIC_CLASS(pa_sink
, pa_msgobject
);
61 struct pa_sink_volume_change
{
65 PA_LLIST_FIELDS(pa_sink_volume_change
);
68 struct sink_message_set_port
{
73 static void sink_free(pa_object
*s
);
75 static void pa_sink_volume_change_push(pa_sink
*s
);
76 static void pa_sink_volume_change_flush(pa_sink
*s
);
77 static void pa_sink_volume_change_rewind(pa_sink
*s
, size_t nbytes
);
79 pa_sink_new_data
* pa_sink_new_data_init(pa_sink_new_data
*data
) {
83 data
->proplist
= pa_proplist_new();
84 data
->ports
= pa_hashmap_new(pa_idxset_string_hash_func
, pa_idxset_string_compare_func
);
89 void pa_sink_new_data_set_name(pa_sink_new_data
*data
, const char *name
) {
93 data
->name
= pa_xstrdup(name
);
96 void pa_sink_new_data_set_sample_spec(pa_sink_new_data
*data
, const pa_sample_spec
*spec
) {
99 if ((data
->sample_spec_is_set
= !!spec
))
100 data
->sample_spec
= *spec
;
103 void pa_sink_new_data_set_channel_map(pa_sink_new_data
*data
, const pa_channel_map
*map
) {
106 if ((data
->channel_map_is_set
= !!map
))
107 data
->channel_map
= *map
;
110 void pa_sink_new_data_set_alternate_sample_rate(pa_sink_new_data
*data
, const uint32_t alternate_sample_rate
) {
113 data
->alternate_sample_rate_is_set
= TRUE
;
114 data
->alternate_sample_rate
= alternate_sample_rate
;
117 void pa_sink_new_data_set_volume(pa_sink_new_data
*data
, const pa_cvolume
*volume
) {
120 if ((data
->volume_is_set
= !!volume
))
121 data
->volume
= *volume
;
124 void pa_sink_new_data_set_muted(pa_sink_new_data
*data
, pa_bool_t mute
) {
127 data
->muted_is_set
= TRUE
;
128 data
->muted
= !!mute
;
131 void pa_sink_new_data_set_port(pa_sink_new_data
*data
, const char *port
) {
134 pa_xfree(data
->active_port
);
135 data
->active_port
= pa_xstrdup(port
);
138 void pa_sink_new_data_done(pa_sink_new_data
*data
) {
141 pa_proplist_free(data
->proplist
);
144 pa_device_port_hashmap_free(data
->ports
);
146 pa_xfree(data
->name
);
147 pa_xfree(data
->active_port
);
151 /* Called from main context */
152 static void reset_callbacks(pa_sink
*s
) {
156 s
->get_volume
= NULL
;
157 s
->set_volume
= NULL
;
158 s
->write_volume
= NULL
;
161 s
->request_rewind
= NULL
;
162 s
->update_requested_latency
= NULL
;
164 s
->get_formats
= NULL
;
165 s
->set_formats
= NULL
;
166 s
->update_rate
= NULL
;
169 /* Called from main context */
170 pa_sink
* pa_sink_new(
172 pa_sink_new_data
*data
,
173 pa_sink_flags_t flags
) {
177 char st
[PA_SAMPLE_SPEC_SNPRINT_MAX
], cm
[PA_CHANNEL_MAP_SNPRINT_MAX
];
178 pa_source_new_data source_data
;
184 pa_assert(data
->name
);
185 pa_assert_ctl_context();
187 s
= pa_msgobject_new(pa_sink
);
189 if (!(name
= pa_namereg_register(core
, data
->name
, PA_NAMEREG_SINK
, s
, data
->namereg_fail
))) {
190 pa_log_debug("Failed to register name %s.", data
->name
);
195 pa_sink_new_data_set_name(data
, name
);
197 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_NEW
], data
) < 0) {
199 pa_namereg_unregister(core
, name
);
203 /* FIXME, need to free s here on failure */
205 pa_return_null_if_fail(!data
->driver
|| pa_utf8_valid(data
->driver
));
206 pa_return_null_if_fail(data
->name
&& pa_utf8_valid(data
->name
) && data
->name
[0]);
208 pa_return_null_if_fail(data
->sample_spec_is_set
&& pa_sample_spec_valid(&data
->sample_spec
));
210 if (!data
->channel_map_is_set
)
211 pa_return_null_if_fail(pa_channel_map_init_auto(&data
->channel_map
, data
->sample_spec
.channels
, PA_CHANNEL_MAP_DEFAULT
));
213 pa_return_null_if_fail(pa_channel_map_valid(&data
->channel_map
));
214 pa_return_null_if_fail(data
->channel_map
.channels
== data
->sample_spec
.channels
);
216 /* FIXME: There should probably be a general function for checking whether
217 * the sink volume is allowed to be set, like there is for sink inputs. */
218 pa_assert(!data
->volume_is_set
|| !(flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
220 if (!data
->volume_is_set
) {
221 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
222 data
->save_volume
= FALSE
;
225 pa_return_null_if_fail(pa_cvolume_valid(&data
->volume
));
226 pa_return_null_if_fail(pa_cvolume_compatible(&data
->volume
, &data
->sample_spec
));
228 if (!data
->muted_is_set
)
232 pa_proplist_update(data
->proplist
, PA_UPDATE_MERGE
, data
->card
->proplist
);
234 pa_device_init_description(data
->proplist
);
235 pa_device_init_icon(data
->proplist
, TRUE
);
236 pa_device_init_intended_roles(data
->proplist
);
238 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_FIXATE
], data
) < 0) {
240 pa_namereg_unregister(core
, name
);
244 s
->parent
.parent
.free
= sink_free
;
245 s
->parent
.process_msg
= pa_sink_process_msg
;
248 s
->state
= PA_SINK_INIT
;
251 s
->suspend_cause
= data
->suspend_cause
;
252 pa_sink_set_mixer_dirty(s
, FALSE
);
253 s
->name
= pa_xstrdup(name
);
254 s
->proplist
= pa_proplist_copy(data
->proplist
);
255 s
->driver
= pa_xstrdup(pa_path_get_filename(data
->driver
));
256 s
->module
= data
->module
;
257 s
->card
= data
->card
;
259 s
->priority
= pa_device_init_priority(s
->proplist
);
261 s
->sample_spec
= data
->sample_spec
;
262 s
->channel_map
= data
->channel_map
;
263 s
->default_sample_rate
= s
->sample_spec
.rate
;
265 if (data
->alternate_sample_rate_is_set
)
266 s
->alternate_sample_rate
= data
->alternate_sample_rate
;
268 s
->alternate_sample_rate
= s
->core
->alternate_sample_rate
;
270 if (s
->sample_spec
.rate
== s
->alternate_sample_rate
) {
271 pa_log_warn("Default and alternate sample rates are the same.");
272 s
->alternate_sample_rate
= 0;
275 s
->inputs
= pa_idxset_new(NULL
, NULL
);
277 s
->input_to_master
= NULL
;
279 s
->reference_volume
= s
->real_volume
= data
->volume
;
280 pa_cvolume_reset(&s
->soft_volume
, s
->sample_spec
.channels
);
281 s
->base_volume
= PA_VOLUME_NORM
;
282 s
->n_volume_steps
= PA_VOLUME_NORM
+1;
283 s
->muted
= data
->muted
;
284 s
->refresh_volume
= s
->refresh_muted
= FALSE
;
291 /* As a minor optimization we just steal the list instead of
293 s
->ports
= data
->ports
;
296 s
->active_port
= NULL
;
297 s
->save_port
= FALSE
;
299 if (data
->active_port
)
300 if ((s
->active_port
= pa_hashmap_get(s
->ports
, data
->active_port
)))
301 s
->save_port
= data
->save_port
;
303 if (!s
->active_port
) {
307 PA_HASHMAP_FOREACH(p
, s
->ports
, state
)
308 if (!s
->active_port
|| p
->priority
> s
->active_port
->priority
)
313 s
->latency_offset
= s
->active_port
->latency_offset
;
315 s
->latency_offset
= 0;
317 s
->save_volume
= data
->save_volume
;
318 s
->save_muted
= data
->save_muted
;
320 pa_silence_memchunk_get(
321 &core
->silence_cache
,
327 s
->thread_info
.rtpoll
= NULL
;
328 s
->thread_info
.inputs
= pa_hashmap_new(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
);
329 s
->thread_info
.soft_volume
= s
->soft_volume
;
330 s
->thread_info
.soft_muted
= s
->muted
;
331 s
->thread_info
.state
= s
->state
;
332 s
->thread_info
.rewind_nbytes
= 0;
333 s
->thread_info
.rewind_requested
= FALSE
;
334 s
->thread_info
.max_rewind
= 0;
335 s
->thread_info
.max_request
= 0;
336 s
->thread_info
.requested_latency_valid
= FALSE
;
337 s
->thread_info
.requested_latency
= 0;
338 s
->thread_info
.min_latency
= ABSOLUTE_MIN_LATENCY
;
339 s
->thread_info
.max_latency
= ABSOLUTE_MAX_LATENCY
;
340 s
->thread_info
.fixed_latency
= flags
& PA_SINK_DYNAMIC_LATENCY
? 0 : DEFAULT_FIXED_LATENCY
;
342 PA_LLIST_HEAD_INIT(pa_sink_volume_change
, s
->thread_info
.volume_changes
);
343 s
->thread_info
.volume_changes_tail
= NULL
;
344 pa_sw_cvolume_multiply(&s
->thread_info
.current_hw_volume
, &s
->soft_volume
, &s
->real_volume
);
345 s
->thread_info
.volume_change_safety_margin
= core
->deferred_volume_safety_margin_usec
;
346 s
->thread_info
.volume_change_extra_delay
= core
->deferred_volume_extra_delay_usec
;
347 s
->thread_info
.latency_offset
= s
->latency_offset
;
349 /* FIXME: This should probably be moved to pa_sink_put() */
350 pa_assert_se(pa_idxset_put(core
->sinks
, s
, &s
->index
) >= 0);
353 pa_assert_se(pa_idxset_put(s
->card
->sinks
, s
, NULL
) >= 0);
355 pt
= pa_proplist_to_string_sep(s
->proplist
, "\n ");
356 pa_log_info("Created sink %u \"%s\" with sample spec %s and channel map %s\n %s",
359 pa_sample_spec_snprint(st
, sizeof(st
), &s
->sample_spec
),
360 pa_channel_map_snprint(cm
, sizeof(cm
), &s
->channel_map
),
364 pa_source_new_data_init(&source_data
);
365 pa_source_new_data_set_sample_spec(&source_data
, &s
->sample_spec
);
366 pa_source_new_data_set_channel_map(&source_data
, &s
->channel_map
);
367 pa_source_new_data_set_alternate_sample_rate(&source_data
, s
->alternate_sample_rate
);
368 source_data
.name
= pa_sprintf_malloc("%s.monitor", name
);
369 source_data
.driver
= data
->driver
;
370 source_data
.module
= data
->module
;
371 source_data
.card
= data
->card
;
373 dn
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
374 pa_proplist_setf(source_data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Monitor of %s", dn
? dn
: s
->name
);
375 pa_proplist_sets(source_data
.proplist
, PA_PROP_DEVICE_CLASS
, "monitor");
377 s
->monitor_source
= pa_source_new(core
, &source_data
,
378 ((flags
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
379 ((flags
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0));
381 pa_source_new_data_done(&source_data
);
383 if (!s
->monitor_source
) {
389 s
->monitor_source
->monitor_of
= s
;
391 pa_source_set_latency_range(s
->monitor_source
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
392 pa_source_set_fixed_latency(s
->monitor_source
, s
->thread_info
.fixed_latency
);
393 pa_source_set_max_rewind(s
->monitor_source
, s
->thread_info
.max_rewind
);
398 /* Called from main context */
399 static int sink_set_state(pa_sink
*s
, pa_sink_state_t state
) {
401 pa_bool_t suspend_change
;
402 pa_sink_state_t original_state
;
405 pa_assert_ctl_context();
407 if (s
->state
== state
)
410 original_state
= s
->state
;
413 (original_state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(state
)) ||
414 (PA_SINK_IS_OPENED(original_state
) && state
== PA_SINK_SUSPENDED
);
417 if ((ret
= s
->set_state(s
, state
)) < 0)
421 if ((ret
= pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_STATE
, PA_UINT_TO_PTR(state
), 0, NULL
)) < 0) {
424 s
->set_state(s
, original_state
);
431 if (state
!= PA_SINK_UNLINKED
) { /* if we enter UNLINKED state pa_sink_unlink() will fire the appropriate events */
432 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_STATE_CHANGED
], s
);
433 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
436 if (suspend_change
) {
440 /* We're suspending or resuming, tell everyone about it */
442 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
)
443 if (s
->state
== PA_SINK_SUSPENDED
&&
444 (i
->flags
& PA_SINK_INPUT_KILL_ON_SUSPEND
))
445 pa_sink_input_kill(i
);
447 i
->suspend(i
, state
== PA_SINK_SUSPENDED
);
449 if (s
->monitor_source
)
450 pa_source_sync_suspend(s
->monitor_source
);
456 void pa_sink_set_get_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
462 void pa_sink_set_set_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
463 pa_sink_flags_t flags
;
466 pa_assert(!s
->write_volume
|| cb
);
470 /* Save the current flags so we can tell if they've changed */
474 /* The sink implementor is responsible for setting decibel volume support */
475 s
->flags
|= PA_SINK_HW_VOLUME_CTRL
;
477 s
->flags
&= ~PA_SINK_HW_VOLUME_CTRL
;
478 /* See note below in pa_sink_put() about volume sharing and decibel volumes */
479 pa_sink_enable_decibel_volume(s
, !(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
482 /* If the flags have changed after init, let any clients know via a change event */
483 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
484 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
487 void pa_sink_set_write_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
488 pa_sink_flags_t flags
;
491 pa_assert(!cb
|| s
->set_volume
);
493 s
->write_volume
= cb
;
495 /* Save the current flags so we can tell if they've changed */
499 s
->flags
|= PA_SINK_DEFERRED_VOLUME
;
501 s
->flags
&= ~PA_SINK_DEFERRED_VOLUME
;
503 /* If the flags have changed after init, let any clients know via a change event */
504 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
505 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
508 void pa_sink_set_get_mute_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
514 void pa_sink_set_set_mute_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
515 pa_sink_flags_t flags
;
521 /* Save the current flags so we can tell if they've changed */
525 s
->flags
|= PA_SINK_HW_MUTE_CTRL
;
527 s
->flags
&= ~PA_SINK_HW_MUTE_CTRL
;
529 /* If the flags have changed after init, let any clients know via a change event */
530 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
531 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
534 static void enable_flat_volume(pa_sink
*s
, pa_bool_t enable
) {
535 pa_sink_flags_t flags
;
539 /* Always follow the overall user preference here */
540 enable
= enable
&& s
->core
->flat_volumes
;
542 /* Save the current flags so we can tell if they've changed */
546 s
->flags
|= PA_SINK_FLAT_VOLUME
;
548 s
->flags
&= ~PA_SINK_FLAT_VOLUME
;
550 /* If the flags have changed after init, let any clients know via a change event */
551 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
552 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
555 void pa_sink_enable_decibel_volume(pa_sink
*s
, pa_bool_t enable
) {
556 pa_sink_flags_t flags
;
560 /* Save the current flags so we can tell if they've changed */
564 s
->flags
|= PA_SINK_DECIBEL_VOLUME
;
565 enable_flat_volume(s
, TRUE
);
567 s
->flags
&= ~PA_SINK_DECIBEL_VOLUME
;
568 enable_flat_volume(s
, FALSE
);
571 /* If the flags have changed after init, let any clients know via a change event */
572 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
573 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
576 /* Called from main context */
577 void pa_sink_put(pa_sink
* s
) {
578 pa_sink_assert_ref(s
);
579 pa_assert_ctl_context();
581 pa_assert(s
->state
== PA_SINK_INIT
);
582 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) || s
->input_to_master
);
584 /* The following fields must be initialized properly when calling _put() */
585 pa_assert(s
->asyncmsgq
);
586 pa_assert(s
->thread_info
.min_latency
<= s
->thread_info
.max_latency
);
588 /* Generally, flags should be initialized via pa_sink_new(). As a
589 * special exception we allow some volume related flags to be set
590 * between _new() and _put() by the callback setter functions above.
592 * Thus we implement a couple safeguards here which ensure the above
593 * setters were used (or at least the implementor made manual changes
594 * in a compatible way).
596 * Note: All of these flags set here can change over the life time
598 pa_assert(!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
) || s
->set_volume
);
599 pa_assert(!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) || s
->write_volume
);
600 pa_assert(!(s
->flags
& PA_SINK_HW_MUTE_CTRL
) || s
->set_mute
);
602 /* XXX: Currently decibel volume is disabled for all sinks that use volume
603 * sharing. When the master sink supports decibel volume, it would be good
604 * to have the flag also in the filter sink, but currently we don't do that
605 * so that the flags of the filter sink never change when it's moved from
606 * a master sink to another. One solution for this problem would be to
607 * remove user-visible volume altogether from filter sinks when volume
608 * sharing is used, but the current approach was easier to implement... */
609 /* We always support decibel volumes in software, otherwise we leave it to
610 * the sink implementor to set this flag as needed.
612 * Note: This flag can also change over the life time of the sink. */
613 if (!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
) && !(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
614 pa_sink_enable_decibel_volume(s
, TRUE
);
616 /* If the sink implementor support DB volumes by itself, we should always
617 * try and enable flat volumes too */
618 if ((s
->flags
& PA_SINK_DECIBEL_VOLUME
))
619 enable_flat_volume(s
, TRUE
);
621 if (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) {
622 pa_sink
*root_sink
= pa_sink_get_master(s
);
624 pa_assert(root_sink
);
626 s
->reference_volume
= root_sink
->reference_volume
;
627 pa_cvolume_remap(&s
->reference_volume
, &root_sink
->channel_map
, &s
->channel_map
);
629 s
->real_volume
= root_sink
->real_volume
;
630 pa_cvolume_remap(&s
->real_volume
, &root_sink
->channel_map
, &s
->channel_map
);
632 /* We assume that if the sink implementor changed the default
633 * volume he did so in real_volume, because that is the usual
634 * place where he is supposed to place his changes. */
635 s
->reference_volume
= s
->real_volume
;
637 s
->thread_info
.soft_volume
= s
->soft_volume
;
638 s
->thread_info
.soft_muted
= s
->muted
;
639 pa_sw_cvolume_multiply(&s
->thread_info
.current_hw_volume
, &s
->soft_volume
, &s
->real_volume
);
641 pa_assert((s
->flags
& PA_SINK_HW_VOLUME_CTRL
)
642 || (s
->base_volume
== PA_VOLUME_NORM
643 && ((s
->flags
& PA_SINK_DECIBEL_VOLUME
|| (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)))));
644 pa_assert(!(s
->flags
& PA_SINK_DECIBEL_VOLUME
) || s
->n_volume_steps
== PA_VOLUME_NORM
+1);
645 pa_assert(!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
) == (s
->thread_info
.fixed_latency
!= 0));
646 pa_assert(!(s
->flags
& PA_SINK_LATENCY
) == !(s
->monitor_source
->flags
& PA_SOURCE_LATENCY
));
647 pa_assert(!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
) == !(s
->monitor_source
->flags
& PA_SOURCE_DYNAMIC_LATENCY
));
649 pa_assert(s
->monitor_source
->thread_info
.fixed_latency
== s
->thread_info
.fixed_latency
);
650 pa_assert(s
->monitor_source
->thread_info
.min_latency
== s
->thread_info
.min_latency
);
651 pa_assert(s
->monitor_source
->thread_info
.max_latency
== s
->thread_info
.max_latency
);
653 if (s
->suspend_cause
)
654 pa_assert_se(sink_set_state(s
, PA_SINK_SUSPENDED
) == 0);
656 pa_assert_se(sink_set_state(s
, PA_SINK_IDLE
) == 0);
658 pa_source_put(s
->monitor_source
);
660 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_NEW
, s
->index
);
661 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PUT
], s
);
664 /* Called from main context */
665 void pa_sink_unlink(pa_sink
* s
) {
667 pa_sink_input
*i
, *j
= NULL
;
670 pa_assert_ctl_context();
672 /* Please note that pa_sink_unlink() does more than simply
673 * reversing pa_sink_put(). It also undoes the registrations
674 * already done in pa_sink_new()! */
676 /* All operations here shall be idempotent, i.e. pa_sink_unlink()
677 * may be called multiple times on the same sink without bad
680 linked
= PA_SINK_IS_LINKED(s
->state
);
683 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK
], s
);
685 if (s
->state
!= PA_SINK_UNLINKED
)
686 pa_namereg_unregister(s
->core
, s
->name
);
687 pa_idxset_remove_by_data(s
->core
->sinks
, s
, NULL
);
690 pa_idxset_remove_by_data(s
->card
->sinks
, s
, NULL
);
692 while ((i
= pa_idxset_first(s
->inputs
, NULL
))) {
694 pa_sink_input_kill(i
);
699 sink_set_state(s
, PA_SINK_UNLINKED
);
701 s
->state
= PA_SINK_UNLINKED
;
705 if (s
->monitor_source
)
706 pa_source_unlink(s
->monitor_source
);
709 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_REMOVE
, s
->index
);
710 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK_POST
], s
);
714 /* Called from main context */
715 static void sink_free(pa_object
*o
) {
716 pa_sink
*s
= PA_SINK(o
);
720 pa_assert_ctl_context();
721 pa_assert(pa_sink_refcnt(s
) == 0);
723 if (PA_SINK_IS_LINKED(s
->state
))
726 pa_log_info("Freeing sink %u \"%s\"", s
->index
, s
->name
);
728 if (s
->monitor_source
) {
729 pa_source_unref(s
->monitor_source
);
730 s
->monitor_source
= NULL
;
733 pa_idxset_free(s
->inputs
, NULL
, NULL
);
735 while ((i
= pa_hashmap_steal_first(s
->thread_info
.inputs
)))
736 pa_sink_input_unref(i
);
738 pa_hashmap_free(s
->thread_info
.inputs
, NULL
, NULL
);
740 if (s
->silence
.memblock
)
741 pa_memblock_unref(s
->silence
.memblock
);
747 pa_proplist_free(s
->proplist
);
750 pa_device_port_hashmap_free(s
->ports
);
755 /* Called from main context, and not while the IO thread is active, please */
756 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
) {
757 pa_sink_assert_ref(s
);
758 pa_assert_ctl_context();
762 if (s
->monitor_source
)
763 pa_source_set_asyncmsgq(s
->monitor_source
, q
);
766 /* Called from main context, and not while the IO thread is active, please */
767 void pa_sink_update_flags(pa_sink
*s
, pa_sink_flags_t mask
, pa_sink_flags_t value
) {
768 pa_sink_assert_ref(s
);
769 pa_assert_ctl_context();
774 /* For now, allow only a minimal set of flags to be changed. */
775 pa_assert((mask
& ~(PA_SINK_DYNAMIC_LATENCY
|PA_SINK_LATENCY
)) == 0);
777 s
->flags
= (s
->flags
& ~mask
) | (value
& mask
);
779 pa_source_update_flags(s
->monitor_source
,
780 ((mask
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
781 ((mask
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0),
782 ((value
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
783 ((value
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SINK_DYNAMIC_LATENCY
: 0));
786 /* Called from IO context, or before _put() from main context */
787 void pa_sink_set_rtpoll(pa_sink
*s
, pa_rtpoll
*p
) {
788 pa_sink_assert_ref(s
);
789 pa_sink_assert_io_context(s
);
791 s
->thread_info
.rtpoll
= p
;
793 if (s
->monitor_source
)
794 pa_source_set_rtpoll(s
->monitor_source
, p
);
797 /* Called from main context */
798 int pa_sink_update_status(pa_sink
*s
) {
799 pa_sink_assert_ref(s
);
800 pa_assert_ctl_context();
801 pa_assert(PA_SINK_IS_LINKED(s
->state
));
803 if (s
->state
== PA_SINK_SUSPENDED
)
806 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
809 /* Called from any context - must be threadsafe */
810 void pa_sink_set_mixer_dirty(pa_sink
*s
, pa_bool_t is_dirty
)
812 pa_atomic_store(&s
->mixer_dirty
, is_dirty
? 1 : 0);
815 /* Called from main context */
816 int pa_sink_suspend(pa_sink
*s
, pa_bool_t suspend
, pa_suspend_cause_t cause
) {
817 pa_sink_assert_ref(s
);
818 pa_assert_ctl_context();
819 pa_assert(PA_SINK_IS_LINKED(s
->state
));
820 pa_assert(cause
!= 0);
823 s
->suspend_cause
|= cause
;
824 s
->monitor_source
->suspend_cause
|= cause
;
826 s
->suspend_cause
&= ~cause
;
827 s
->monitor_source
->suspend_cause
&= ~cause
;
830 if (!(s
->suspend_cause
& PA_SUSPEND_SESSION
) && (pa_atomic_load(&s
->mixer_dirty
) != 0)) {
831 /* This might look racy but isn't: If somebody sets mixer_dirty exactly here,
832 it'll be handled just fine. */
833 pa_sink_set_mixer_dirty(s
, FALSE
);
834 pa_log_debug("Mixer is now accessible. Updating alsa mixer settings.");
835 if (s
->active_port
&& s
->set_port
) {
836 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
837 struct sink_message_set_port msg
= { .port
= s
->active_port
, .ret
= 0 };
838 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_PORT
, &msg
, 0, NULL
) == 0);
841 s
->set_port(s
, s
->active_port
);
851 if ((pa_sink_get_state(s
) == PA_SINK_SUSPENDED
) == !!s
->suspend_cause
)
854 pa_log_debug("Suspend cause of sink %s is 0x%04x, %s", s
->name
, s
->suspend_cause
, s
->suspend_cause
? "suspending" : "resuming");
856 if (s
->suspend_cause
)
857 return sink_set_state(s
, PA_SINK_SUSPENDED
);
859 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
862 /* Called from main context */
863 pa_queue
*pa_sink_move_all_start(pa_sink
*s
, pa_queue
*q
) {
864 pa_sink_input
*i
, *n
;
867 pa_sink_assert_ref(s
);
868 pa_assert_ctl_context();
869 pa_assert(PA_SINK_IS_LINKED(s
->state
));
874 for (i
= PA_SINK_INPUT(pa_idxset_first(s
->inputs
, &idx
)); i
; i
= n
) {
875 n
= PA_SINK_INPUT(pa_idxset_next(s
->inputs
, &idx
));
877 pa_sink_input_ref(i
);
879 if (pa_sink_input_start_move(i
) >= 0)
882 pa_sink_input_unref(i
);
888 /* Called from main context */
889 void pa_sink_move_all_finish(pa_sink
*s
, pa_queue
*q
, pa_bool_t save
) {
892 pa_sink_assert_ref(s
);
893 pa_assert_ctl_context();
894 pa_assert(PA_SINK_IS_LINKED(s
->state
));
897 while ((i
= PA_SINK_INPUT(pa_queue_pop(q
)))) {
898 if (pa_sink_input_finish_move(i
, s
, save
) < 0)
899 pa_sink_input_fail_move(i
);
901 pa_sink_input_unref(i
);
904 pa_queue_free(q
, NULL
);
907 /* Called from main context */
908 void pa_sink_move_all_fail(pa_queue
*q
) {
911 pa_assert_ctl_context();
914 while ((i
= PA_SINK_INPUT(pa_queue_pop(q
)))) {
915 pa_sink_input_fail_move(i
);
916 pa_sink_input_unref(i
);
919 pa_queue_free(q
, NULL
);
922 /* Called from IO thread context */
923 void pa_sink_process_rewind(pa_sink
*s
, size_t nbytes
) {
927 pa_sink_assert_ref(s
);
928 pa_sink_assert_io_context(s
);
929 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
931 /* If nobody requested this and this is actually no real rewind
932 * then we can short cut this. Please note that this means that
933 * not all rewind requests triggered upstream will always be
934 * translated in actual requests! */
935 if (!s
->thread_info
.rewind_requested
&& nbytes
<= 0)
938 s
->thread_info
.rewind_nbytes
= 0;
939 s
->thread_info
.rewind_requested
= FALSE
;
942 pa_log_debug("Processing rewind...");
943 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
944 pa_sink_volume_change_rewind(s
, nbytes
);
947 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
948 pa_sink_input_assert_ref(i
);
949 pa_sink_input_process_rewind(i
, nbytes
);
953 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
954 pa_source_process_rewind(s
->monitor_source
, nbytes
);
958 /* Called from IO thread context */
959 static unsigned fill_mix_info(pa_sink
*s
, size_t *length
, pa_mix_info
*info
, unsigned maxinfo
) {
963 size_t mixlength
= *length
;
965 pa_sink_assert_ref(s
);
966 pa_sink_assert_io_context(s
);
969 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)) && maxinfo
> 0) {
970 pa_sink_input_assert_ref(i
);
972 pa_sink_input_peek(i
, *length
, &info
->chunk
, &info
->volume
);
974 if (mixlength
== 0 || info
->chunk
.length
< mixlength
)
975 mixlength
= info
->chunk
.length
;
977 if (pa_memblock_is_silence(info
->chunk
.memblock
)) {
978 pa_memblock_unref(info
->chunk
.memblock
);
982 info
->userdata
= pa_sink_input_ref(i
);
984 pa_assert(info
->chunk
.memblock
);
985 pa_assert(info
->chunk
.length
> 0);
998 /* Called from IO thread context */
999 static void inputs_drop(pa_sink
*s
, pa_mix_info
*info
, unsigned n
, pa_memchunk
*result
) {
1003 unsigned n_unreffed
= 0;
1005 pa_sink_assert_ref(s
);
1006 pa_sink_assert_io_context(s
);
1008 pa_assert(result
->memblock
);
1009 pa_assert(result
->length
> 0);
1011 /* We optimize for the case where the order of the inputs has not changed */
1013 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
1015 pa_mix_info
* m
= NULL
;
1017 pa_sink_input_assert_ref(i
);
1019 /* Let's try to find the matching entry info the pa_mix_info array */
1020 for (j
= 0; j
< n
; j
++) {
1022 if (info
[p
].userdata
== i
) {
1032 /* Drop read data */
1033 pa_sink_input_drop(i
, result
->length
);
1035 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
)) {
1037 if (pa_hashmap_size(i
->thread_info
.direct_outputs
) > 0) {
1038 void *ostate
= NULL
;
1039 pa_source_output
*o
;
1042 if (m
&& m
->chunk
.memblock
) {
1044 pa_memblock_ref(c
.memblock
);
1045 pa_assert(result
->length
<= c
.length
);
1046 c
.length
= result
->length
;
1048 pa_memchunk_make_writable(&c
, 0);
1049 pa_volume_memchunk(&c
, &s
->sample_spec
, &m
->volume
);
1052 pa_memblock_ref(c
.memblock
);
1053 pa_assert(result
->length
<= c
.length
);
1054 c
.length
= result
->length
;
1057 while ((o
= pa_hashmap_iterate(i
->thread_info
.direct_outputs
, &ostate
, NULL
))) {
1058 pa_source_output_assert_ref(o
);
1059 pa_assert(o
->direct_on_input
== i
);
1060 pa_source_post_direct(s
->monitor_source
, o
, &c
);
1063 pa_memblock_unref(c
.memblock
);
1068 if (m
->chunk
.memblock
)
1069 pa_memblock_unref(m
->chunk
.memblock
);
1070 pa_memchunk_reset(&m
->chunk
);
1072 pa_sink_input_unref(m
->userdata
);
1079 /* Now drop references to entries that are included in the
1080 * pa_mix_info array but don't exist anymore */
1082 if (n_unreffed
< n
) {
1083 for (; n
> 0; info
++, n
--) {
1085 pa_sink_input_unref(info
->userdata
);
1086 if (info
->chunk
.memblock
)
1087 pa_memblock_unref(info
->chunk
.memblock
);
1091 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
1092 pa_source_post(s
->monitor_source
, result
);
1095 /* Called from IO thread context */
1096 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1097 pa_mix_info info
[MAX_MIX_CHANNELS
];
1099 size_t block_size_max
;
1101 pa_sink_assert_ref(s
);
1102 pa_sink_assert_io_context(s
);
1103 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1104 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1107 pa_assert(!s
->thread_info
.rewind_requested
);
1108 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1110 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1111 result
->memblock
= pa_memblock_ref(s
->silence
.memblock
);
1112 result
->index
= s
->silence
.index
;
1113 result
->length
= PA_MIN(s
->silence
.length
, length
);
1120 length
= pa_frame_align(MIX_BUFFER_LENGTH
, &s
->sample_spec
);
1122 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1123 if (length
> block_size_max
)
1124 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1126 pa_assert(length
> 0);
1128 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1132 *result
= s
->silence
;
1133 pa_memblock_ref(result
->memblock
);
1135 if (result
->length
> length
)
1136 result
->length
= length
;
1138 } else if (n
== 1) {
1141 *result
= info
[0].chunk
;
1142 pa_memblock_ref(result
->memblock
);
1144 if (result
->length
> length
)
1145 result
->length
= length
;
1147 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1149 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
)) {
1150 pa_memblock_unref(result
->memblock
);
1151 pa_silence_memchunk_get(&s
->core
->silence_cache
,
1156 } else if (!pa_cvolume_is_norm(&volume
)) {
1157 pa_memchunk_make_writable(result
, 0);
1158 pa_volume_memchunk(result
, &s
->sample_spec
, &volume
);
1162 result
->memblock
= pa_memblock_new(s
->core
->mempool
, length
);
1164 ptr
= pa_memblock_acquire(result
->memblock
);
1165 result
->length
= pa_mix(info
, n
,
1168 &s
->thread_info
.soft_volume
,
1169 s
->thread_info
.soft_muted
);
1170 pa_memblock_release(result
->memblock
);
1175 inputs_drop(s
, info
, n
, result
);
1180 /* Called from IO thread context */
1181 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
) {
1182 pa_mix_info info
[MAX_MIX_CHANNELS
];
1184 size_t length
, block_size_max
;
1186 pa_sink_assert_ref(s
);
1187 pa_sink_assert_io_context(s
);
1188 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1190 pa_assert(target
->memblock
);
1191 pa_assert(target
->length
> 0);
1192 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1194 pa_assert(!s
->thread_info
.rewind_requested
);
1195 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1197 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1198 pa_silence_memchunk(target
, &s
->sample_spec
);
1204 length
= target
->length
;
1205 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1206 if (length
> block_size_max
)
1207 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1209 pa_assert(length
> 0);
1211 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1214 if (target
->length
> length
)
1215 target
->length
= length
;
1217 pa_silence_memchunk(target
, &s
->sample_spec
);
1218 } else if (n
== 1) {
1221 if (target
->length
> length
)
1222 target
->length
= length
;
1224 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1226 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
))
1227 pa_silence_memchunk(target
, &s
->sample_spec
);
1231 vchunk
= info
[0].chunk
;
1232 pa_memblock_ref(vchunk
.memblock
);
1234 if (vchunk
.length
> length
)
1235 vchunk
.length
= length
;
1237 if (!pa_cvolume_is_norm(&volume
)) {
1238 pa_memchunk_make_writable(&vchunk
, 0);
1239 pa_volume_memchunk(&vchunk
, &s
->sample_spec
, &volume
);
1242 pa_memchunk_memcpy(target
, &vchunk
);
1243 pa_memblock_unref(vchunk
.memblock
);
1249 ptr
= pa_memblock_acquire(target
->memblock
);
1251 target
->length
= pa_mix(info
, n
,
1252 (uint8_t*) ptr
+ target
->index
, length
,
1254 &s
->thread_info
.soft_volume
,
1255 s
->thread_info
.soft_muted
);
1257 pa_memblock_release(target
->memblock
);
1260 inputs_drop(s
, info
, n
, target
);
1265 /* Called from IO thread context */
1266 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
) {
1270 pa_sink_assert_ref(s
);
1271 pa_sink_assert_io_context(s
);
1272 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1274 pa_assert(target
->memblock
);
1275 pa_assert(target
->length
> 0);
1276 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1278 pa_assert(!s
->thread_info
.rewind_requested
);
1279 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1281 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1282 pa_silence_memchunk(target
, &s
->sample_spec
);
1295 pa_sink_render_into(s
, &chunk
);
1304 /* Called from IO thread context */
1305 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1306 pa_sink_assert_ref(s
);
1307 pa_sink_assert_io_context(s
);
1308 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1309 pa_assert(length
> 0);
1310 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1313 pa_assert(!s
->thread_info
.rewind_requested
);
1314 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1318 pa_sink_render(s
, length
, result
);
1320 if (result
->length
< length
) {
1323 pa_memchunk_make_writable(result
, length
);
1325 chunk
.memblock
= result
->memblock
;
1326 chunk
.index
= result
->index
+ result
->length
;
1327 chunk
.length
= length
- result
->length
;
1329 pa_sink_render_into_full(s
, &chunk
);
1331 result
->length
= length
;
1337 /* Called from main thread */
1338 pa_bool_t
pa_sink_update_rate(pa_sink
*s
, uint32_t rate
, pa_bool_t passthrough
)
1340 if (s
->update_rate
) {
1341 uint32_t desired_rate
= rate
;
1342 uint32_t default_rate
= s
->default_sample_rate
;
1343 uint32_t alternate_rate
= s
->alternate_sample_rate
;
1346 pa_bool_t use_alternate
= FALSE
;
1348 if (PA_UNLIKELY(default_rate
== alternate_rate
)) {
1349 pa_log_warn("Default and alternate sample rates are the same.");
1353 if (PA_SINK_IS_RUNNING(s
->state
)) {
1354 pa_log_info("Cannot update rate, SINK_IS_RUNNING, will keep using %u Hz",
1355 s
->sample_spec
.rate
);
1359 if (s
->monitor_source
) {
1360 if (PA_SOURCE_IS_RUNNING(s
->monitor_source
->state
) == TRUE
) {
1361 pa_log_info("Cannot update rate, monitor source is RUNNING");
1366 if (PA_UNLIKELY (desired_rate
< 8000 ||
1367 desired_rate
> PA_RATE_MAX
))
1371 pa_assert(default_rate
% 4000 || default_rate
% 11025);
1372 pa_assert(alternate_rate
% 4000 || alternate_rate
% 11025);
1374 if (default_rate
% 4000) {
1375 /* default is a 11025 multiple */
1376 if ((alternate_rate
% 4000 == 0) && (desired_rate
% 4000 == 0))
1379 /* default is 4000 multiple */
1380 if ((alternate_rate
% 11025 == 0) && (desired_rate
% 11025 == 0))
1385 desired_rate
= alternate_rate
;
1387 desired_rate
= default_rate
;
1389 desired_rate
= rate
; /* use stream sampling rate, discard default/alternate settings */
1392 if (desired_rate
== s
->sample_spec
.rate
)
1395 if (!passthrough
&& pa_sink_used_by(s
) > 0)
1398 pa_log_debug("Suspending sink %s due to changing the sample rate.", s
->name
);
1399 pa_sink_suspend(s
, TRUE
, PA_SUSPEND_IDLE
); /* needed before rate update, will be resumed automatically */
1401 if (s
->update_rate(s
, desired_rate
) == TRUE
) {
1402 /* update monitor source as well */
1403 if (s
->monitor_source
&& !passthrough
)
1404 pa_source_update_rate(s
->monitor_source
, desired_rate
, FALSE
);
1405 pa_log_info("Changed sampling rate successfully");
1407 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1408 if (i
->state
== PA_SINK_INPUT_CORKED
)
1409 pa_sink_input_update_rate(i
);
1418 /* Called from main thread */
1419 pa_usec_t
pa_sink_get_latency(pa_sink
*s
) {
1422 pa_sink_assert_ref(s
);
1423 pa_assert_ctl_context();
1424 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1426 /* The returned value is supposed to be in the time domain of the sound card! */
1428 if (s
->state
== PA_SINK_SUSPENDED
)
1431 if (!(s
->flags
& PA_SINK_LATENCY
))
1434 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) == 0);
1436 /* usec is unsigned, so check that the offset can be added to usec without
1438 if (-s
->latency_offset
<= (int64_t) usec
)
1439 usec
+= s
->latency_offset
;
1446 /* Called from IO thread */
1447 pa_usec_t
pa_sink_get_latency_within_thread(pa_sink
*s
) {
1451 pa_sink_assert_ref(s
);
1452 pa_sink_assert_io_context(s
);
1453 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1455 /* The returned value is supposed to be in the time domain of the sound card! */
1457 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
1460 if (!(s
->flags
& PA_SINK_LATENCY
))
1463 o
= PA_MSGOBJECT(s
);
1465 /* FIXME: We probably should make this a proper vtable callback instead of going through process_msg() */
1467 if (o
->process_msg(o
, PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) < 0)
1470 /* usec is unsigned, so check that the offset can be added to usec without
1472 if (-s
->thread_info
.latency_offset
<= (int64_t) usec
)
1473 usec
+= s
->thread_info
.latency_offset
;
1480 /* Called from the main thread (and also from the IO thread while the main
1481 * thread is waiting).
1483 * When a sink uses volume sharing, it never has the PA_SINK_FLAT_VOLUME flag
1484 * set. Instead, flat volume mode is detected by checking whether the root sink
1485 * has the flag set. */
1486 pa_bool_t
pa_sink_flat_volume_enabled(pa_sink
*s
) {
1487 pa_sink_assert_ref(s
);
1489 s
= pa_sink_get_master(s
);
1492 return (s
->flags
& PA_SINK_FLAT_VOLUME
);
1497 /* Called from the main thread (and also from the IO thread while the main
1498 * thread is waiting). */
1499 pa_sink
*pa_sink_get_master(pa_sink
*s
) {
1500 pa_sink_assert_ref(s
);
1502 while (s
&& (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1503 if (PA_UNLIKELY(!s
->input_to_master
))
1506 s
= s
->input_to_master
->sink
;
1512 /* Called from main context */
1513 pa_bool_t
pa_sink_is_passthrough(pa_sink
*s
) {
1514 pa_sink_input
*alt_i
;
1517 pa_sink_assert_ref(s
);
1519 /* one and only one PASSTHROUGH input can possibly be connected */
1520 if (pa_idxset_size(s
->inputs
) == 1) {
1521 alt_i
= pa_idxset_first(s
->inputs
, &idx
);
1523 if (pa_sink_input_is_passthrough(alt_i
))
1530 /* Called from main context */
1531 void pa_sink_enter_passthrough(pa_sink
*s
) {
1534 /* disable the monitor in passthrough mode */
1535 if (s
->monitor_source
) {
1536 pa_log_debug("Suspending monitor source %s, because the sink is entering the passthrough mode.", s
->monitor_source
->name
);
1537 pa_source_suspend(s
->monitor_source
, TRUE
, PA_SUSPEND_PASSTHROUGH
);
1540 /* set the volume to NORM */
1541 s
->saved_volume
= *pa_sink_get_volume(s
, TRUE
);
1542 s
->saved_save_volume
= s
->save_volume
;
1544 pa_cvolume_set(&volume
, s
->sample_spec
.channels
, PA_MIN(s
->base_volume
, PA_VOLUME_NORM
));
1545 pa_sink_set_volume(s
, &volume
, TRUE
, FALSE
);
1548 /* Called from main context */
1549 void pa_sink_leave_passthrough(pa_sink
*s
) {
1550 /* Unsuspend monitor */
1551 if (s
->monitor_source
) {
1552 pa_log_debug("Resuming monitor source %s, because the sink is leaving the passthrough mode.", s
->monitor_source
->name
);
1553 pa_source_suspend(s
->monitor_source
, FALSE
, PA_SUSPEND_PASSTHROUGH
);
1556 /* Restore sink volume to what it was before we entered passthrough mode */
1557 pa_sink_set_volume(s
, &s
->saved_volume
, TRUE
, s
->saved_save_volume
);
1559 pa_cvolume_init(&s
->saved_volume
);
1560 s
->saved_save_volume
= FALSE
;
1563 /* Called from main context. */
1564 static void compute_reference_ratio(pa_sink_input
*i
) {
1566 pa_cvolume remapped
;
1569 pa_assert(pa_sink_flat_volume_enabled(i
->sink
));
1572 * Calculates the reference ratio from the sink's reference
1573 * volume. This basically calculates:
1575 * i->reference_ratio = i->volume / i->sink->reference_volume
1578 remapped
= i
->sink
->reference_volume
;
1579 pa_cvolume_remap(&remapped
, &i
->sink
->channel_map
, &i
->channel_map
);
1581 i
->reference_ratio
.channels
= i
->sample_spec
.channels
;
1583 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1585 /* We don't update when the sink volume is 0 anyway */
1586 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
)
1589 /* Don't update the reference ratio unless necessary */
1590 if (pa_sw_volume_multiply(
1591 i
->reference_ratio
.values
[c
],
1592 remapped
.values
[c
]) == i
->volume
.values
[c
])
1595 i
->reference_ratio
.values
[c
] = pa_sw_volume_divide(
1596 i
->volume
.values
[c
],
1597 remapped
.values
[c
]);
1601 /* Called from main context. Only called for the root sink in volume sharing
1602 * cases, except for internal recursive calls. */
1603 static void compute_reference_ratios(pa_sink
*s
) {
1607 pa_sink_assert_ref(s
);
1608 pa_assert_ctl_context();
1609 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1610 pa_assert(pa_sink_flat_volume_enabled(s
));
1612 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1613 compute_reference_ratio(i
);
1615 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1616 compute_reference_ratios(i
->origin_sink
);
1620 /* Called from main context. Only called for the root sink in volume sharing
1621 * cases, except for internal recursive calls. */
1622 static void compute_real_ratios(pa_sink
*s
) {
1626 pa_sink_assert_ref(s
);
1627 pa_assert_ctl_context();
1628 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1629 pa_assert(pa_sink_flat_volume_enabled(s
));
1631 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1633 pa_cvolume remapped
;
1635 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1636 /* The origin sink uses volume sharing, so this input's real ratio
1637 * is handled as a special case - the real ratio must be 0 dB, and
1638 * as a result i->soft_volume must equal i->volume_factor. */
1639 pa_cvolume_reset(&i
->real_ratio
, i
->real_ratio
.channels
);
1640 i
->soft_volume
= i
->volume_factor
;
1642 compute_real_ratios(i
->origin_sink
);
1648 * This basically calculates:
1650 * i->real_ratio := i->volume / s->real_volume
1651 * i->soft_volume := i->real_ratio * i->volume_factor
1654 remapped
= s
->real_volume
;
1655 pa_cvolume_remap(&remapped
, &s
->channel_map
, &i
->channel_map
);
1657 i
->real_ratio
.channels
= i
->sample_spec
.channels
;
1658 i
->soft_volume
.channels
= i
->sample_spec
.channels
;
1660 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1662 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
) {
1663 /* We leave i->real_ratio untouched */
1664 i
->soft_volume
.values
[c
] = PA_VOLUME_MUTED
;
1668 /* Don't lose accuracy unless necessary */
1669 if (pa_sw_volume_multiply(
1670 i
->real_ratio
.values
[c
],
1671 remapped
.values
[c
]) != i
->volume
.values
[c
])
1673 i
->real_ratio
.values
[c
] = pa_sw_volume_divide(
1674 i
->volume
.values
[c
],
1675 remapped
.values
[c
]);
1677 i
->soft_volume
.values
[c
] = pa_sw_volume_multiply(
1678 i
->real_ratio
.values
[c
],
1679 i
->volume_factor
.values
[c
]);
1682 /* We don't copy the soft_volume to the thread_info data
1683 * here. That must be done by the caller */
1687 static pa_cvolume
*cvolume_remap_minimal_impact(
1689 const pa_cvolume
*template,
1690 const pa_channel_map
*from
,
1691 const pa_channel_map
*to
) {
1696 pa_assert(template);
1699 pa_assert(pa_cvolume_compatible_with_channel_map(v
, from
));
1700 pa_assert(pa_cvolume_compatible_with_channel_map(template, to
));
1702 /* Much like pa_cvolume_remap(), but tries to minimize impact when
1703 * mapping from sink input to sink volumes:
1705 * If template is a possible remapping from v it is used instead
1706 * of remapping anew.
1708 * If the channel maps don't match we set an all-channel volume on
1709 * the sink to ensure that changing a volume on one stream has no
1710 * effect that cannot be compensated for in another stream that
1711 * does not have the same channel map as the sink. */
1713 if (pa_channel_map_equal(from
, to
))
1717 if (pa_cvolume_equal(pa_cvolume_remap(&t
, to
, from
), v
)) {
1722 pa_cvolume_set(v
, to
->channels
, pa_cvolume_max(v
));
1726 /* Called from main thread. Only called for the root sink in volume sharing
1727 * cases, except for internal recursive calls. */
1728 static void get_maximum_input_volume(pa_sink
*s
, pa_cvolume
*max_volume
, const pa_channel_map
*channel_map
) {
1732 pa_sink_assert_ref(s
);
1733 pa_assert(max_volume
);
1734 pa_assert(channel_map
);
1735 pa_assert(pa_sink_flat_volume_enabled(s
));
1737 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1738 pa_cvolume remapped
;
1740 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1741 get_maximum_input_volume(i
->origin_sink
, max_volume
, channel_map
);
1743 /* Ignore this input. The origin sink uses volume sharing, so this
1744 * input's volume will be set to be equal to the root sink's real
1745 * volume. Obviously this input's current volume must not then
1746 * affect what the root sink's real volume will be. */
1750 remapped
= i
->volume
;
1751 cvolume_remap_minimal_impact(&remapped
, max_volume
, &i
->channel_map
, channel_map
);
1752 pa_cvolume_merge(max_volume
, max_volume
, &remapped
);
1756 /* Called from main thread. Only called for the root sink in volume sharing
1757 * cases, except for internal recursive calls. */
1758 static pa_bool_t
has_inputs(pa_sink
*s
) {
1762 pa_sink_assert_ref(s
);
1764 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1765 if (!i
->origin_sink
|| !(i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) || has_inputs(i
->origin_sink
))
1772 /* Called from main thread. Only called for the root sink in volume sharing
1773 * cases, except for internal recursive calls. */
1774 static void update_real_volume(pa_sink
*s
, const pa_cvolume
*new_volume
, pa_channel_map
*channel_map
) {
1778 pa_sink_assert_ref(s
);
1779 pa_assert(new_volume
);
1780 pa_assert(channel_map
);
1782 s
->real_volume
= *new_volume
;
1783 pa_cvolume_remap(&s
->real_volume
, channel_map
, &s
->channel_map
);
1785 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1786 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1787 if (pa_sink_flat_volume_enabled(s
)) {
1788 pa_cvolume old_volume
= i
->volume
;
1790 /* Follow the root sink's real volume. */
1791 i
->volume
= *new_volume
;
1792 pa_cvolume_remap(&i
->volume
, channel_map
, &i
->channel_map
);
1793 compute_reference_ratio(i
);
1795 /* The volume changed, let's tell people so */
1796 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
1797 if (i
->volume_changed
)
1798 i
->volume_changed(i
);
1800 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1804 update_real_volume(i
->origin_sink
, new_volume
, channel_map
);
1809 /* Called from main thread. Only called for the root sink in shared volume
1811 static void compute_real_volume(pa_sink
*s
) {
1812 pa_sink_assert_ref(s
);
1813 pa_assert_ctl_context();
1814 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1815 pa_assert(pa_sink_flat_volume_enabled(s
));
1816 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
1818 /* This determines the maximum volume of all streams and sets
1819 * s->real_volume accordingly. */
1821 if (!has_inputs(s
)) {
1822 /* In the special case that we have no sink inputs we leave the
1823 * volume unmodified. */
1824 update_real_volume(s
, &s
->reference_volume
, &s
->channel_map
);
1828 pa_cvolume_mute(&s
->real_volume
, s
->channel_map
.channels
);
1830 /* First let's determine the new maximum volume of all inputs
1831 * connected to this sink */
1832 get_maximum_input_volume(s
, &s
->real_volume
, &s
->channel_map
);
1833 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
1835 /* Then, let's update the real ratios/soft volumes of all inputs
1836 * connected to this sink */
1837 compute_real_ratios(s
);
1840 /* Called from main thread. Only called for the root sink in shared volume
1841 * cases, except for internal recursive calls. */
1842 static void propagate_reference_volume(pa_sink
*s
) {
1846 pa_sink_assert_ref(s
);
1847 pa_assert_ctl_context();
1848 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1849 pa_assert(pa_sink_flat_volume_enabled(s
));
1851 /* This is called whenever the sink volume changes that is not
1852 * caused by a sink input volume change. We need to fix up the
1853 * sink input volumes accordingly */
1855 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1856 pa_cvolume old_volume
;
1858 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1859 propagate_reference_volume(i
->origin_sink
);
1861 /* Since the origin sink uses volume sharing, this input's volume
1862 * needs to be updated to match the root sink's real volume, but
1863 * that will be done later in update_shared_real_volume(). */
1867 old_volume
= i
->volume
;
1869 /* This basically calculates:
1871 * i->volume := s->reference_volume * i->reference_ratio */
1873 i
->volume
= s
->reference_volume
;
1874 pa_cvolume_remap(&i
->volume
, &s
->channel_map
, &i
->channel_map
);
1875 pa_sw_cvolume_multiply(&i
->volume
, &i
->volume
, &i
->reference_ratio
);
1877 /* The volume changed, let's tell people so */
1878 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
1880 if (i
->volume_changed
)
1881 i
->volume_changed(i
);
1883 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1888 /* Called from main thread. Only called for the root sink in volume sharing
1889 * cases, except for internal recursive calls. The return value indicates
1890 * whether any reference volume actually changed. */
1891 static pa_bool_t
update_reference_volume(pa_sink
*s
, const pa_cvolume
*v
, const pa_channel_map
*channel_map
, pa_bool_t save
) {
1893 pa_bool_t reference_volume_changed
;
1897 pa_sink_assert_ref(s
);
1898 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1900 pa_assert(channel_map
);
1901 pa_assert(pa_cvolume_valid(v
));
1904 pa_cvolume_remap(&volume
, channel_map
, &s
->channel_map
);
1906 reference_volume_changed
= !pa_cvolume_equal(&volume
, &s
->reference_volume
);
1907 s
->reference_volume
= volume
;
1909 s
->save_volume
= (!reference_volume_changed
&& s
->save_volume
) || save
;
1911 if (reference_volume_changed
)
1912 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
1913 else if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1914 /* If the root sink's volume doesn't change, then there can't be any
1915 * changes in the other sinks in the sink tree either.
1917 * It's probably theoretically possible that even if the root sink's
1918 * volume changes slightly, some filter sink doesn't change its volume
1919 * due to rounding errors. If that happens, we still want to propagate
1920 * the changed root sink volume to the sinks connected to the
1921 * intermediate sink that didn't change its volume. This theoretical
1922 * possibility is the reason why we have that !(s->flags &
1923 * PA_SINK_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would
1924 * notice even if we returned here FALSE always if
1925 * reference_volume_changed is FALSE. */
1928 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1929 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1930 update_reference_volume(i
->origin_sink
, v
, channel_map
, FALSE
);
1936 /* Called from main thread */
1937 void pa_sink_set_volume(
1939 const pa_cvolume
*volume
,
1943 pa_cvolume new_reference_volume
;
1946 pa_sink_assert_ref(s
);
1947 pa_assert_ctl_context();
1948 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1949 pa_assert(!volume
|| pa_cvolume_valid(volume
));
1950 pa_assert(volume
|| pa_sink_flat_volume_enabled(s
));
1951 pa_assert(!volume
|| volume
->channels
== 1 || pa_cvolume_compatible(volume
, &s
->sample_spec
));
1953 /* make sure we don't change the volume when a PASSTHROUGH input is connected ...
1954 * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */
1955 if (pa_sink_is_passthrough(s
) && (!volume
|| !pa_cvolume_is_norm(volume
))) {
1956 pa_log_warn("Cannot change volume, Sink is connected to PASSTHROUGH input");
1960 /* In case of volume sharing, the volume is set for the root sink first,
1961 * from which it's then propagated to the sharing sinks. */
1962 root_sink
= pa_sink_get_master(s
);
1964 if (PA_UNLIKELY(!root_sink
))
1967 /* As a special exception we accept mono volumes on all sinks --
1968 * even on those with more complex channel maps */
1971 if (pa_cvolume_compatible(volume
, &s
->sample_spec
))
1972 new_reference_volume
= *volume
;
1974 new_reference_volume
= s
->reference_volume
;
1975 pa_cvolume_scale(&new_reference_volume
, pa_cvolume_max(volume
));
1978 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
1980 if (update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
)) {
1981 if (pa_sink_flat_volume_enabled(root_sink
)) {
1982 /* OK, propagate this volume change back to the inputs */
1983 propagate_reference_volume(root_sink
);
1985 /* And now recalculate the real volume */
1986 compute_real_volume(root_sink
);
1988 update_real_volume(root_sink
, &root_sink
->reference_volume
, &root_sink
->channel_map
);
1992 /* If volume is NULL we synchronize the sink's real and
1993 * reference volumes with the stream volumes. */
1995 pa_assert(pa_sink_flat_volume_enabled(root_sink
));
1997 /* Ok, let's determine the new real volume */
1998 compute_real_volume(root_sink
);
2000 /* Let's 'push' the reference volume if necessary */
2001 pa_cvolume_merge(&new_reference_volume
, &s
->reference_volume
, &root_sink
->real_volume
);
2002 /* If the sink and it's root don't have the same number of channels, we need to remap */
2003 if (s
!= root_sink
&& !pa_channel_map_equal(&s
->channel_map
, &root_sink
->channel_map
))
2004 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
2005 update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
);
2007 /* Now that the reference volume is updated, we can update the streams'
2008 * reference ratios. */
2009 compute_reference_ratios(root_sink
);
2012 if (root_sink
->set_volume
) {
2013 /* If we have a function set_volume(), then we do not apply a
2014 * soft volume by default. However, set_volume() is free to
2015 * apply one to root_sink->soft_volume */
2017 pa_cvolume_reset(&root_sink
->soft_volume
, root_sink
->sample_spec
.channels
);
2018 if (!(root_sink
->flags
& PA_SINK_DEFERRED_VOLUME
))
2019 root_sink
->set_volume(root_sink
);
2022 /* If we have no function set_volume(), then the soft volume
2023 * becomes the real volume */
2024 root_sink
->soft_volume
= root_sink
->real_volume
;
2026 /* This tells the sink that soft volume and/or real volume changed */
2028 pa_assert_se(pa_asyncmsgq_send(root_sink
->asyncmsgq
, PA_MSGOBJECT(root_sink
), PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
) == 0);
2031 /* Called from the io thread if sync volume is used, otherwise from the main thread.
2032 * Only to be called by sink implementor */
2033 void pa_sink_set_soft_volume(pa_sink
*s
, const pa_cvolume
*volume
) {
2035 pa_sink_assert_ref(s
);
2036 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2038 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
2039 pa_sink_assert_io_context(s
);
2041 pa_assert_ctl_context();
2044 pa_cvolume_reset(&s
->soft_volume
, s
->sample_spec
.channels
);
2046 s
->soft_volume
= *volume
;
2048 if (PA_SINK_IS_LINKED(s
->state
) && !(s
->flags
& PA_SINK_DEFERRED_VOLUME
))
2049 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME
, NULL
, 0, NULL
) == 0);
2051 s
->thread_info
.soft_volume
= s
->soft_volume
;
2054 /* Called from the main thread. Only called for the root sink in volume sharing
2055 * cases, except for internal recursive calls. */
2056 static void propagate_real_volume(pa_sink
*s
, const pa_cvolume
*old_real_volume
) {
2060 pa_sink_assert_ref(s
);
2061 pa_assert(old_real_volume
);
2062 pa_assert_ctl_context();
2063 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2065 /* This is called when the hardware's real volume changes due to
2066 * some external event. We copy the real volume into our
2067 * reference volume and then rebuild the stream volumes based on
2068 * i->real_ratio which should stay fixed. */
2070 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
2071 if (pa_cvolume_equal(old_real_volume
, &s
->real_volume
))
2074 /* 1. Make the real volume the reference volume */
2075 update_reference_volume(s
, &s
->real_volume
, &s
->channel_map
, TRUE
);
2078 if (pa_sink_flat_volume_enabled(s
)) {
2080 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2081 pa_cvolume old_volume
= i
->volume
;
2083 /* 2. Since the sink's reference and real volumes are equal
2084 * now our ratios should be too. */
2085 i
->reference_ratio
= i
->real_ratio
;
2087 /* 3. Recalculate the new stream reference volume based on the
2088 * reference ratio and the sink's reference volume.
2090 * This basically calculates:
2092 * i->volume = s->reference_volume * i->reference_ratio
2094 * This is identical to propagate_reference_volume() */
2095 i
->volume
= s
->reference_volume
;
2096 pa_cvolume_remap(&i
->volume
, &s
->channel_map
, &i
->channel_map
);
2097 pa_sw_cvolume_multiply(&i
->volume
, &i
->volume
, &i
->reference_ratio
);
2099 /* Notify if something changed */
2100 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
2102 if (i
->volume_changed
)
2103 i
->volume_changed(i
);
2105 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
2108 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2109 propagate_real_volume(i
->origin_sink
, old_real_volume
);
2113 /* Something got changed in the hardware. It probably makes sense
2114 * to save changed hw settings given that hw volume changes not
2115 * triggered by PA are almost certainly done by the user. */
2116 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2117 s
->save_volume
= TRUE
;
2120 /* Called from io thread */
2121 void pa_sink_update_volume_and_mute(pa_sink
*s
) {
2123 pa_sink_assert_io_context(s
);
2125 pa_asyncmsgq_post(pa_thread_mq_get()->outq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
, NULL
, 0, NULL
, NULL
);
2128 /* Called from main thread */
2129 const pa_cvolume
*pa_sink_get_volume(pa_sink
*s
, pa_bool_t force_refresh
) {
2130 pa_sink_assert_ref(s
);
2131 pa_assert_ctl_context();
2132 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2134 if (s
->refresh_volume
|| force_refresh
) {
2135 struct pa_cvolume old_real_volume
;
2137 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2139 old_real_volume
= s
->real_volume
;
2141 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
)
2144 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_VOLUME
, NULL
, 0, NULL
) == 0);
2146 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
2147 propagate_real_volume(s
, &old_real_volume
);
2150 return &s
->reference_volume
;
2153 /* Called from main thread. In volume sharing cases, only the root sink may
2155 void pa_sink_volume_changed(pa_sink
*s
, const pa_cvolume
*new_real_volume
) {
2156 pa_cvolume old_real_volume
;
2158 pa_sink_assert_ref(s
);
2159 pa_assert_ctl_context();
2160 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2161 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2163 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2165 old_real_volume
= s
->real_volume
;
2166 update_real_volume(s
, new_real_volume
, &s
->channel_map
);
2167 propagate_real_volume(s
, &old_real_volume
);
2170 /* Called from main thread */
2171 void pa_sink_set_mute(pa_sink
*s
, pa_bool_t mute
, pa_bool_t save
) {
2172 pa_bool_t old_muted
;
2174 pa_sink_assert_ref(s
);
2175 pa_assert_ctl_context();
2176 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2178 old_muted
= s
->muted
;
2180 s
->save_muted
= (old_muted
== s
->muted
&& s
->save_muted
) || save
;
2182 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->set_mute
)
2185 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2187 if (old_muted
!= s
->muted
)
2188 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2191 /* Called from main thread */
2192 pa_bool_t
pa_sink_get_mute(pa_sink
*s
, pa_bool_t force_refresh
) {
2194 pa_sink_assert_ref(s
);
2195 pa_assert_ctl_context();
2196 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2198 if (s
->refresh_muted
|| force_refresh
) {
2199 pa_bool_t old_muted
= s
->muted
;
2201 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_mute
)
2204 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MUTE
, NULL
, 0, NULL
) == 0);
2206 if (old_muted
!= s
->muted
) {
2207 s
->save_muted
= TRUE
;
2209 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2211 /* Make sure the soft mute status stays in sync */
2212 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2219 /* Called from main thread */
2220 void pa_sink_mute_changed(pa_sink
*s
, pa_bool_t new_muted
) {
2221 pa_sink_assert_ref(s
);
2222 pa_assert_ctl_context();
2223 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2225 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2227 if (s
->muted
== new_muted
)
2230 s
->muted
= new_muted
;
2231 s
->save_muted
= TRUE
;
2233 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2236 /* Called from main thread */
2237 pa_bool_t
pa_sink_update_proplist(pa_sink
*s
, pa_update_mode_t mode
, pa_proplist
*p
) {
2238 pa_sink_assert_ref(s
);
2239 pa_assert_ctl_context();
2242 pa_proplist_update(s
->proplist
, mode
, p
);
2244 if (PA_SINK_IS_LINKED(s
->state
)) {
2245 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2246 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2252 /* Called from main thread */
2253 /* FIXME -- this should be dropped and be merged into pa_sink_update_proplist() */
2254 void pa_sink_set_description(pa_sink
*s
, const char *description
) {
2256 pa_sink_assert_ref(s
);
2257 pa_assert_ctl_context();
2259 if (!description
&& !pa_proplist_contains(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
))
2262 old
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2264 if (old
&& description
&& pa_streq(old
, description
))
2268 pa_proplist_sets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
, description
);
2270 pa_proplist_unset(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2272 if (s
->monitor_source
) {
2275 n
= pa_sprintf_malloc("Monitor Source of %s", description
? description
: s
->name
);
2276 pa_source_set_description(s
->monitor_source
, n
);
2280 if (PA_SINK_IS_LINKED(s
->state
)) {
2281 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2282 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2286 /* Called from main thread */
2287 unsigned pa_sink_linked_by(pa_sink
*s
) {
2290 pa_sink_assert_ref(s
);
2291 pa_assert_ctl_context();
2292 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2294 ret
= pa_idxset_size(s
->inputs
);
2296 /* We add in the number of streams connected to us here. Please
2297 * note the asymmetry to pa_sink_used_by()! */
2299 if (s
->monitor_source
)
2300 ret
+= pa_source_linked_by(s
->monitor_source
);
2305 /* Called from main thread */
2306 unsigned pa_sink_used_by(pa_sink
*s
) {
2309 pa_sink_assert_ref(s
);
2310 pa_assert_ctl_context();
2311 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2313 ret
= pa_idxset_size(s
->inputs
);
2314 pa_assert(ret
>= s
->n_corked
);
2316 /* Streams connected to our monitor source do not matter for
2317 * pa_sink_used_by()!.*/
2319 return ret
- s
->n_corked
;
2322 /* Called from main thread */
2323 unsigned pa_sink_check_suspend(pa_sink
*s
) {
2328 pa_sink_assert_ref(s
);
2329 pa_assert_ctl_context();
2331 if (!PA_SINK_IS_LINKED(s
->state
))
2336 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2337 pa_sink_input_state_t st
;
2339 st
= pa_sink_input_get_state(i
);
2341 /* We do not assert here. It is perfectly valid for a sink input to
2342 * be in the INIT state (i.e. created, marked done but not yet put)
2343 * and we should not care if it's unlinked as it won't contribute
2344 * towards our busy status.
2346 if (!PA_SINK_INPUT_IS_LINKED(st
))
2349 if (st
== PA_SINK_INPUT_CORKED
)
2352 if (i
->flags
& PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND
)
2358 if (s
->monitor_source
)
2359 ret
+= pa_source_check_suspend(s
->monitor_source
);
2364 /* Called from the IO thread */
2365 static void sync_input_volumes_within_thread(pa_sink
*s
) {
2369 pa_sink_assert_ref(s
);
2370 pa_sink_assert_io_context(s
);
2372 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2373 if (pa_cvolume_equal(&i
->thread_info
.soft_volume
, &i
->soft_volume
))
2376 i
->thread_info
.soft_volume
= i
->soft_volume
;
2377 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
, FALSE
);
2381 /* Called from the IO thread. Only called for the root sink in volume sharing
2382 * cases, except for internal recursive calls. */
2383 static void set_shared_volume_within_thread(pa_sink
*s
) {
2384 pa_sink_input
*i
= NULL
;
2387 pa_sink_assert_ref(s
);
2389 PA_MSGOBJECT(s
)->process_msg(PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME_SYNCED
, NULL
, 0, NULL
);
2391 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2392 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2393 set_shared_volume_within_thread(i
->origin_sink
);
2397 /* Called from IO thread, except when it is not */
2398 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
2399 pa_sink
*s
= PA_SINK(o
);
2400 pa_sink_assert_ref(s
);
2402 switch ((pa_sink_message_t
) code
) {
2404 case PA_SINK_MESSAGE_ADD_INPUT
: {
2405 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2407 /* If you change anything here, make sure to change the
2408 * sink input handling a few lines down at
2409 * PA_SINK_MESSAGE_FINISH_MOVE, too. */
2411 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2413 /* Since the caller sleeps in pa_sink_input_put(), we can
2414 * safely access data outside of thread_info even though
2417 if ((i
->thread_info
.sync_prev
= i
->sync_prev
)) {
2418 pa_assert(i
->sink
== i
->thread_info
.sync_prev
->sink
);
2419 pa_assert(i
->sync_prev
->sync_next
== i
);
2420 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
;
2423 if ((i
->thread_info
.sync_next
= i
->sync_next
)) {
2424 pa_assert(i
->sink
== i
->thread_info
.sync_next
->sink
);
2425 pa_assert(i
->sync_next
->sync_prev
== i
);
2426 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
;
2429 pa_assert(!i
->thread_info
.attached
);
2430 i
->thread_info
.attached
= TRUE
;
2435 pa_sink_input_set_state_within_thread(i
, i
->state
);
2437 /* The requested latency of the sink input needs to be fixed up and
2438 * then configured on the sink. If this causes the sink latency to
2439 * go down, the sink implementor is responsible for doing a rewind
2440 * in the update_requested_latency() callback to ensure that the
2441 * sink buffer doesn't contain more data than what the new latency
2444 * XXX: Does it really make sense to push this responsibility to
2445 * the sink implementors? Wouldn't it be better to do it once in
2446 * the core than many times in the modules? */
2448 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2449 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2451 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2452 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2454 /* We don't rewind here automatically. This is left to the
2455 * sink input implementor because some sink inputs need a
2456 * slow start, i.e. need some time to buffer client
2457 * samples before beginning streaming.
2459 * XXX: Does it really make sense to push this functionality to
2460 * the sink implementors? Wouldn't it be better to do it once in
2461 * the core than many times in the modules? */
2463 /* In flat volume mode we need to update the volume as
2465 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2468 case PA_SINK_MESSAGE_REMOVE_INPUT
: {
2469 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2471 /* If you change anything here, make sure to change the
2472 * sink input handling a few lines down at
2473 * PA_SINK_MESSAGE_START_MOVE, too. */
2478 pa_sink_input_set_state_within_thread(i
, i
->state
);
2480 pa_assert(i
->thread_info
.attached
);
2481 i
->thread_info
.attached
= FALSE
;
2483 /* Since the caller sleeps in pa_sink_input_unlink(),
2484 * we can safely access data outside of thread_info even
2485 * though it is mutable */
2487 pa_assert(!i
->sync_prev
);
2488 pa_assert(!i
->sync_next
);
2490 if (i
->thread_info
.sync_prev
) {
2491 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
->thread_info
.sync_prev
->sync_next
;
2492 i
->thread_info
.sync_prev
= NULL
;
2495 if (i
->thread_info
.sync_next
) {
2496 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
->thread_info
.sync_next
->sync_prev
;
2497 i
->thread_info
.sync_next
= NULL
;
2500 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
2501 pa_sink_input_unref(i
);
2503 pa_sink_invalidate_requested_latency(s
, TRUE
);
2504 pa_sink_request_rewind(s
, (size_t) -1);
2506 /* In flat volume mode we need to update the volume as
2508 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2511 case PA_SINK_MESSAGE_START_MOVE
: {
2512 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2514 /* We don't support moving synchronized streams. */
2515 pa_assert(!i
->sync_prev
);
2516 pa_assert(!i
->sync_next
);
2517 pa_assert(!i
->thread_info
.sync_next
);
2518 pa_assert(!i
->thread_info
.sync_prev
);
2520 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2522 size_t sink_nbytes
, total_nbytes
;
2524 /* The old sink probably has some audio from this
2525 * stream in its buffer. We want to "take it back" as
2526 * much as possible and play it to the new sink. We
2527 * don't know at this point how much the old sink can
2528 * rewind. We have to pick something, and that
2529 * something is the full latency of the old sink here.
2530 * So we rewind the stream buffer by the sink latency
2531 * amount, which may be more than what we should
2532 * rewind. This can result in a chunk of audio being
2533 * played both to the old sink and the new sink.
2535 * FIXME: Fix this code so that we don't have to make
2536 * guesses about how much the sink will actually be
2537 * able to rewind. If someone comes up with a solution
2538 * for this, something to note is that the part of the
2539 * latency that the old sink couldn't rewind should
2540 * ideally be compensated after the stream has moved
2541 * to the new sink by adding silence. The new sink
2542 * most likely can't start playing the moved stream
2543 * immediately, and that gap should be removed from
2544 * the "compensation silence" (at least at the time of
2545 * writing this, the move finish code will actually
2546 * already take care of dropping the new sink's
2547 * unrewindable latency, so taking into account the
2548 * unrewindable latency of the old sink is the only
2551 * The render_memblockq contents are discarded,
2552 * because when the sink changes, the format of the
2553 * audio stored in the render_memblockq may change
2554 * too, making the stored audio invalid. FIXME:
2555 * However, the read and write indices are moved back
2556 * the same amount, so if they are not the same now,
2557 * they won't be the same after the rewind either. If
2558 * the write index of the render_memblockq is ahead of
2559 * the read index, then the render_memblockq will feed
2560 * the new sink some silence first, which it shouldn't
2561 * do. The write index should be flushed to be the
2562 * same as the read index. */
2564 /* Get the latency of the sink */
2565 usec
= pa_sink_get_latency_within_thread(s
);
2566 sink_nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2567 total_nbytes
= sink_nbytes
+ pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
2569 if (total_nbytes
> 0) {
2570 i
->thread_info
.rewrite_nbytes
= i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, total_nbytes
) : total_nbytes
;
2571 i
->thread_info
.rewrite_flush
= TRUE
;
2572 pa_sink_input_process_rewind(i
, sink_nbytes
);
2579 pa_assert(i
->thread_info
.attached
);
2580 i
->thread_info
.attached
= FALSE
;
2582 /* Let's remove the sink input ...*/
2583 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
2584 pa_sink_input_unref(i
);
2586 pa_sink_invalidate_requested_latency(s
, TRUE
);
2588 pa_log_debug("Requesting rewind due to started move");
2589 pa_sink_request_rewind(s
, (size_t) -1);
2591 /* In flat volume mode we need to update the volume as
2593 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2596 case PA_SINK_MESSAGE_FINISH_MOVE
: {
2597 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2599 /* We don't support moving synchronized streams. */
2600 pa_assert(!i
->sync_prev
);
2601 pa_assert(!i
->sync_next
);
2602 pa_assert(!i
->thread_info
.sync_next
);
2603 pa_assert(!i
->thread_info
.sync_prev
);
2605 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2607 pa_assert(!i
->thread_info
.attached
);
2608 i
->thread_info
.attached
= TRUE
;
2613 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2617 /* In the ideal case the new sink would start playing
2618 * the stream immediately. That requires the sink to
2619 * be able to rewind all of its latency, which usually
2620 * isn't possible, so there will probably be some gap
2621 * before the moved stream becomes audible. We then
2622 * have two possibilities: 1) start playing the stream
2623 * from where it is now, or 2) drop the unrewindable
2624 * latency of the sink from the stream. With option 1
2625 * we won't lose any audio but the stream will have a
2626 * pause. With option 2 we may lose some audio but the
2627 * stream time will be somewhat in sync with the wall
2628 * clock. Lennart seems to have chosen option 2 (one
2629 * of the reasons might have been that option 1 is
2630 * actually much harder to implement), so we drop the
2631 * latency of the new sink from the moved stream and
2632 * hope that the sink will undo most of that in the
2635 /* Get the latency of the sink */
2636 usec
= pa_sink_get_latency_within_thread(s
);
2637 nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2640 pa_sink_input_drop(i
, nbytes
);
2642 pa_log_debug("Requesting rewind due to finished move");
2643 pa_sink_request_rewind(s
, nbytes
);
2646 /* Updating the requested sink latency has to be done
2647 * after the sink rewind request, not before, because
2648 * otherwise the sink may limit the rewind amount
2651 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2652 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2654 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2655 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2657 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2660 case PA_SINK_MESSAGE_SET_SHARED_VOLUME
: {
2661 pa_sink
*root_sink
= pa_sink_get_master(s
);
2663 if (PA_LIKELY(root_sink
))
2664 set_shared_volume_within_thread(root_sink
);
2669 case PA_SINK_MESSAGE_SET_VOLUME_SYNCED
:
2671 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
2673 pa_sink_volume_change_push(s
);
2675 /* Fall through ... */
2677 case PA_SINK_MESSAGE_SET_VOLUME
:
2679 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2680 s
->thread_info
.soft_volume
= s
->soft_volume
;
2681 pa_sink_request_rewind(s
, (size_t) -1);
2684 /* Fall through ... */
2686 case PA_SINK_MESSAGE_SYNC_VOLUMES
:
2687 sync_input_volumes_within_thread(s
);
2690 case PA_SINK_MESSAGE_GET_VOLUME
:
2692 if ((s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
) {
2694 pa_sink_volume_change_flush(s
);
2695 pa_sw_cvolume_divide(&s
->thread_info
.current_hw_volume
, &s
->real_volume
, &s
->soft_volume
);
2698 /* In case sink implementor reset SW volume. */
2699 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2700 s
->thread_info
.soft_volume
= s
->soft_volume
;
2701 pa_sink_request_rewind(s
, (size_t) -1);
2706 case PA_SINK_MESSAGE_SET_MUTE
:
2708 if (s
->thread_info
.soft_muted
!= s
->muted
) {
2709 s
->thread_info
.soft_muted
= s
->muted
;
2710 pa_sink_request_rewind(s
, (size_t) -1);
2713 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->set_mute
)
2718 case PA_SINK_MESSAGE_GET_MUTE
:
2720 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->get_mute
)
2725 case PA_SINK_MESSAGE_SET_STATE
: {
2727 pa_bool_t suspend_change
=
2728 (s
->thread_info
.state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(PA_PTR_TO_UINT(userdata
))) ||
2729 (PA_SINK_IS_OPENED(s
->thread_info
.state
) && PA_PTR_TO_UINT(userdata
) == PA_SINK_SUSPENDED
);
2731 s
->thread_info
.state
= PA_PTR_TO_UINT(userdata
);
2733 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
2734 s
->thread_info
.rewind_nbytes
= 0;
2735 s
->thread_info
.rewind_requested
= FALSE
;
2738 if (suspend_change
) {
2742 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
2743 if (i
->suspend_within_thread
)
2744 i
->suspend_within_thread(i
, s
->thread_info
.state
== PA_SINK_SUSPENDED
);
2750 case PA_SINK_MESSAGE_DETACH
:
2752 /* Detach all streams */
2753 pa_sink_detach_within_thread(s
);
2756 case PA_SINK_MESSAGE_ATTACH
:
2758 /* Reattach all streams */
2759 pa_sink_attach_within_thread(s
);
2762 case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
: {
2764 pa_usec_t
*usec
= userdata
;
2765 *usec
= pa_sink_get_requested_latency_within_thread(s
);
2767 /* Yes, that's right, the IO thread will see -1 when no
2768 * explicit requested latency is configured, the main
2769 * thread will see max_latency */
2770 if (*usec
== (pa_usec_t
) -1)
2771 *usec
= s
->thread_info
.max_latency
;
2776 case PA_SINK_MESSAGE_SET_LATENCY_RANGE
: {
2777 pa_usec_t
*r
= userdata
;
2779 pa_sink_set_latency_range_within_thread(s
, r
[0], r
[1]);
2784 case PA_SINK_MESSAGE_GET_LATENCY_RANGE
: {
2785 pa_usec_t
*r
= userdata
;
2787 r
[0] = s
->thread_info
.min_latency
;
2788 r
[1] = s
->thread_info
.max_latency
;
2793 case PA_SINK_MESSAGE_GET_FIXED_LATENCY
:
2795 *((pa_usec_t
*) userdata
) = s
->thread_info
.fixed_latency
;
2798 case PA_SINK_MESSAGE_SET_FIXED_LATENCY
:
2800 pa_sink_set_fixed_latency_within_thread(s
, (pa_usec_t
) offset
);
2803 case PA_SINK_MESSAGE_GET_MAX_REWIND
:
2805 *((size_t*) userdata
) = s
->thread_info
.max_rewind
;
2808 case PA_SINK_MESSAGE_GET_MAX_REQUEST
:
2810 *((size_t*) userdata
) = s
->thread_info
.max_request
;
2813 case PA_SINK_MESSAGE_SET_MAX_REWIND
:
2815 pa_sink_set_max_rewind_within_thread(s
, (size_t) offset
);
2818 case PA_SINK_MESSAGE_SET_MAX_REQUEST
:
2820 pa_sink_set_max_request_within_thread(s
, (size_t) offset
);
2823 case PA_SINK_MESSAGE_SET_PORT
:
2825 pa_assert(userdata
);
2827 struct sink_message_set_port
*msg_data
= userdata
;
2828 msg_data
->ret
= s
->set_port(s
, msg_data
->port
);
2832 case PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
:
2833 /* This message is sent from IO-thread and handled in main thread. */
2834 pa_assert_ctl_context();
2836 /* Make sure we're not messing with main thread when no longer linked */
2837 if (!PA_SINK_IS_LINKED(s
->state
))
2840 pa_sink_get_volume(s
, TRUE
);
2841 pa_sink_get_mute(s
, TRUE
);
2844 case PA_SINK_MESSAGE_SET_LATENCY_OFFSET
:
2845 s
->thread_info
.latency_offset
= offset
;
2848 case PA_SINK_MESSAGE_GET_LATENCY
:
2849 case PA_SINK_MESSAGE_MAX
:
2856 /* Called from main thread */
2857 int pa_sink_suspend_all(pa_core
*c
, pa_bool_t suspend
, pa_suspend_cause_t cause
) {
2862 pa_core_assert_ref(c
);
2863 pa_assert_ctl_context();
2864 pa_assert(cause
!= 0);
2866 PA_IDXSET_FOREACH(sink
, c
->sinks
, idx
) {
2869 if ((r
= pa_sink_suspend(sink
, suspend
, cause
)) < 0)
2876 /* Called from main thread */
2877 void pa_sink_detach(pa_sink
*s
) {
2878 pa_sink_assert_ref(s
);
2879 pa_assert_ctl_context();
2880 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2882 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_DETACH
, NULL
, 0, NULL
) == 0);
2885 /* Called from main thread */
2886 void pa_sink_attach(pa_sink
*s
) {
2887 pa_sink_assert_ref(s
);
2888 pa_assert_ctl_context();
2889 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2891 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_ATTACH
, NULL
, 0, NULL
) == 0);
2894 /* Called from IO thread */
2895 void pa_sink_detach_within_thread(pa_sink
*s
) {
2899 pa_sink_assert_ref(s
);
2900 pa_sink_assert_io_context(s
);
2901 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2903 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2907 if (s
->monitor_source
)
2908 pa_source_detach_within_thread(s
->monitor_source
);
2911 /* Called from IO thread */
2912 void pa_sink_attach_within_thread(pa_sink
*s
) {
2916 pa_sink_assert_ref(s
);
2917 pa_sink_assert_io_context(s
);
2918 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2920 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2924 if (s
->monitor_source
)
2925 pa_source_attach_within_thread(s
->monitor_source
);
2928 /* Called from IO thread */
2929 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
) {
2930 pa_sink_assert_ref(s
);
2931 pa_sink_assert_io_context(s
);
2932 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2934 if (nbytes
== (size_t) -1)
2935 nbytes
= s
->thread_info
.max_rewind
;
2937 nbytes
= PA_MIN(nbytes
, s
->thread_info
.max_rewind
);
2939 if (s
->thread_info
.rewind_requested
&&
2940 nbytes
<= s
->thread_info
.rewind_nbytes
)
2943 s
->thread_info
.rewind_nbytes
= nbytes
;
2944 s
->thread_info
.rewind_requested
= TRUE
;
2946 if (s
->request_rewind
)
2947 s
->request_rewind(s
);
2950 /* Called from IO thread */
2951 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
) {
2952 pa_usec_t result
= (pa_usec_t
) -1;
2955 pa_usec_t monitor_latency
;
2957 pa_sink_assert_ref(s
);
2958 pa_sink_assert_io_context(s
);
2960 if (!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
2961 return PA_CLAMP(s
->thread_info
.fixed_latency
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
2963 if (s
->thread_info
.requested_latency_valid
)
2964 return s
->thread_info
.requested_latency
;
2966 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2967 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1 &&
2968 (result
== (pa_usec_t
) -1 || result
> i
->thread_info
.requested_sink_latency
))
2969 result
= i
->thread_info
.requested_sink_latency
;
2971 monitor_latency
= pa_source_get_requested_latency_within_thread(s
->monitor_source
);
2973 if (monitor_latency
!= (pa_usec_t
) -1 &&
2974 (result
== (pa_usec_t
) -1 || result
> monitor_latency
))
2975 result
= monitor_latency
;
2977 if (result
!= (pa_usec_t
) -1)
2978 result
= PA_CLAMP(result
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
2980 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
2981 /* Only cache if properly initialized */
2982 s
->thread_info
.requested_latency
= result
;
2983 s
->thread_info
.requested_latency_valid
= TRUE
;
2989 /* Called from main thread */
2990 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
) {
2993 pa_sink_assert_ref(s
);
2994 pa_assert_ctl_context();
2995 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2997 if (s
->state
== PA_SINK_SUSPENDED
)
3000 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
3005 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3006 void pa_sink_set_max_rewind_within_thread(pa_sink
*s
, size_t max_rewind
) {
3010 pa_sink_assert_ref(s
);
3011 pa_sink_assert_io_context(s
);
3013 if (max_rewind
== s
->thread_info
.max_rewind
)
3016 s
->thread_info
.max_rewind
= max_rewind
;
3018 if (PA_SINK_IS_LINKED(s
->thread_info
.state
))
3019 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3020 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
3022 if (s
->monitor_source
)
3023 pa_source_set_max_rewind_within_thread(s
->monitor_source
, s
->thread_info
.max_rewind
);
3026 /* Called from main thread */
3027 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
) {
3028 pa_sink_assert_ref(s
);
3029 pa_assert_ctl_context();
3031 if (PA_SINK_IS_LINKED(s
->state
))
3032 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REWIND
, NULL
, max_rewind
, NULL
) == 0);
3034 pa_sink_set_max_rewind_within_thread(s
, max_rewind
);
3037 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3038 void pa_sink_set_max_request_within_thread(pa_sink
*s
, size_t max_request
) {
3041 pa_sink_assert_ref(s
);
3042 pa_sink_assert_io_context(s
);
3044 if (max_request
== s
->thread_info
.max_request
)
3047 s
->thread_info
.max_request
= max_request
;
3049 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3052 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3053 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
3057 /* Called from main thread */
3058 void pa_sink_set_max_request(pa_sink
*s
, size_t max_request
) {
3059 pa_sink_assert_ref(s
);
3060 pa_assert_ctl_context();
3062 if (PA_SINK_IS_LINKED(s
->state
))
3063 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REQUEST
, NULL
, max_request
, NULL
) == 0);
3065 pa_sink_set_max_request_within_thread(s
, max_request
);
3068 /* Called from IO thread */
3069 void pa_sink_invalidate_requested_latency(pa_sink
*s
, pa_bool_t dynamic
) {
3073 pa_sink_assert_ref(s
);
3074 pa_sink_assert_io_context(s
);
3076 if ((s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
3077 s
->thread_info
.requested_latency_valid
= FALSE
;
3081 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3083 if (s
->update_requested_latency
)
3084 s
->update_requested_latency(s
);
3086 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3087 if (i
->update_sink_requested_latency
)
3088 i
->update_sink_requested_latency(i
);
3092 /* Called from main thread */
3093 void pa_sink_set_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3094 pa_sink_assert_ref(s
);
3095 pa_assert_ctl_context();
3097 /* min_latency == 0: no limit
3098 * min_latency anything else: specified limit
3100 * Similar for max_latency */
3102 if (min_latency
< ABSOLUTE_MIN_LATENCY
)
3103 min_latency
= ABSOLUTE_MIN_LATENCY
;
3105 if (max_latency
<= 0 ||
3106 max_latency
> ABSOLUTE_MAX_LATENCY
)
3107 max_latency
= ABSOLUTE_MAX_LATENCY
;
3109 pa_assert(min_latency
<= max_latency
);
3111 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3112 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3113 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3114 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3116 if (PA_SINK_IS_LINKED(s
->state
)) {
3122 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3124 pa_sink_set_latency_range_within_thread(s
, min_latency
, max_latency
);
3127 /* Called from main thread */
3128 void pa_sink_get_latency_range(pa_sink
*s
, pa_usec_t
*min_latency
, pa_usec_t
*max_latency
) {
3129 pa_sink_assert_ref(s
);
3130 pa_assert_ctl_context();
3131 pa_assert(min_latency
);
3132 pa_assert(max_latency
);
3134 if (PA_SINK_IS_LINKED(s
->state
)) {
3135 pa_usec_t r
[2] = { 0, 0 };
3137 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3139 *min_latency
= r
[0];
3140 *max_latency
= r
[1];
3142 *min_latency
= s
->thread_info
.min_latency
;
3143 *max_latency
= s
->thread_info
.max_latency
;
3147 /* Called from IO thread */
3148 void pa_sink_set_latency_range_within_thread(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3149 pa_sink_assert_ref(s
);
3150 pa_sink_assert_io_context(s
);
3152 pa_assert(min_latency
>= ABSOLUTE_MIN_LATENCY
);
3153 pa_assert(max_latency
<= ABSOLUTE_MAX_LATENCY
);
3154 pa_assert(min_latency
<= max_latency
);
3156 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3157 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3158 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3159 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3161 if (s
->thread_info
.min_latency
== min_latency
&&
3162 s
->thread_info
.max_latency
== max_latency
)
3165 s
->thread_info
.min_latency
= min_latency
;
3166 s
->thread_info
.max_latency
= max_latency
;
3168 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3172 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3173 if (i
->update_sink_latency_range
)
3174 i
->update_sink_latency_range(i
);
3177 pa_sink_invalidate_requested_latency(s
, FALSE
);
3179 pa_source_set_latency_range_within_thread(s
->monitor_source
, min_latency
, max_latency
);
3182 /* Called from main thread */
3183 void pa_sink_set_fixed_latency(pa_sink
*s
, pa_usec_t latency
) {
3184 pa_sink_assert_ref(s
);
3185 pa_assert_ctl_context();
3187 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3188 pa_assert(latency
== 0);
3192 if (latency
< ABSOLUTE_MIN_LATENCY
)
3193 latency
= ABSOLUTE_MIN_LATENCY
;
3195 if (latency
> ABSOLUTE_MAX_LATENCY
)
3196 latency
= ABSOLUTE_MAX_LATENCY
;
3198 if (PA_SINK_IS_LINKED(s
->state
))
3199 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_FIXED_LATENCY
, NULL
, (int64_t) latency
, NULL
) == 0);
3201 s
->thread_info
.fixed_latency
= latency
;
3203 pa_source_set_fixed_latency(s
->monitor_source
, latency
);
3206 /* Called from main thread */
3207 pa_usec_t
pa_sink_get_fixed_latency(pa_sink
*s
) {
3210 pa_sink_assert_ref(s
);
3211 pa_assert_ctl_context();
3213 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
)
3216 if (PA_SINK_IS_LINKED(s
->state
))
3217 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_FIXED_LATENCY
, &latency
, 0, NULL
) == 0);
3219 latency
= s
->thread_info
.fixed_latency
;
3224 /* Called from IO thread */
3225 void pa_sink_set_fixed_latency_within_thread(pa_sink
*s
, pa_usec_t latency
) {
3226 pa_sink_assert_ref(s
);
3227 pa_sink_assert_io_context(s
);
3229 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3230 pa_assert(latency
== 0);
3234 pa_assert(latency
>= ABSOLUTE_MIN_LATENCY
);
3235 pa_assert(latency
<= ABSOLUTE_MAX_LATENCY
);
3237 if (s
->thread_info
.fixed_latency
== latency
)
3240 s
->thread_info
.fixed_latency
= latency
;
3242 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3246 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3247 if (i
->update_sink_fixed_latency
)
3248 i
->update_sink_fixed_latency(i
);
3251 pa_sink_invalidate_requested_latency(s
, FALSE
);
3253 pa_source_set_fixed_latency_within_thread(s
->monitor_source
, latency
);
3256 /* Called from main context */
3257 void pa_sink_set_latency_offset(pa_sink
*s
, int64_t offset
) {
3258 pa_sink_assert_ref(s
);
3260 s
->latency_offset
= offset
;
3262 if (PA_SINK_IS_LINKED(s
->state
))
3263 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_LATENCY_OFFSET
, NULL
, offset
, NULL
) == 0);
3265 s
->thread_info
.latency_offset
= offset
;
3268 /* Called from main context */
3269 size_t pa_sink_get_max_rewind(pa_sink
*s
) {
3271 pa_assert_ctl_context();
3272 pa_sink_assert_ref(s
);
3274 if (!PA_SINK_IS_LINKED(s
->state
))
3275 return s
->thread_info
.max_rewind
;
3277 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REWIND
, &r
, 0, NULL
) == 0);
3282 /* Called from main context */
3283 size_t pa_sink_get_max_request(pa_sink
*s
) {
3285 pa_sink_assert_ref(s
);
3286 pa_assert_ctl_context();
3288 if (!PA_SINK_IS_LINKED(s
->state
))
3289 return s
->thread_info
.max_request
;
3291 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REQUEST
, &r
, 0, NULL
) == 0);
3296 /* Called from main context */
3297 int pa_sink_set_port(pa_sink
*s
, const char *name
, pa_bool_t save
) {
3298 pa_device_port
*port
;
3301 pa_sink_assert_ref(s
);
3302 pa_assert_ctl_context();
3305 pa_log_debug("set_port() operation not implemented for sink %u \"%s\"", s
->index
, s
->name
);
3306 return -PA_ERR_NOTIMPLEMENTED
;
3310 return -PA_ERR_NOENTITY
;
3312 if (!(port
= pa_hashmap_get(s
->ports
, name
)))
3313 return -PA_ERR_NOENTITY
;
3315 if (s
->active_port
== port
) {
3316 s
->save_port
= s
->save_port
|| save
;
3320 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
3321 struct sink_message_set_port msg
= { .port
= port
, .ret
= 0 };
3322 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_PORT
, &msg
, 0, NULL
) == 0);
3326 ret
= s
->set_port(s
, port
);
3329 return -PA_ERR_NOENTITY
;
3331 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
3333 pa_log_info("Changed port of sink %u \"%s\" to %s", s
->index
, s
->name
, port
->name
);
3335 s
->active_port
= port
;
3336 s
->save_port
= save
;
3338 pa_sink_set_latency_offset(s
, s
->active_port
->latency_offset
);
3340 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PORT_CHANGED
], s
);
3345 pa_bool_t
pa_device_init_icon(pa_proplist
*p
, pa_bool_t is_sink
) {
3346 const char *ff
, *c
, *t
= NULL
, *s
= "", *profile
, *bus
;
3350 if (pa_proplist_contains(p
, PA_PROP_DEVICE_ICON_NAME
))
3353 if ((ff
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3355 if (pa_streq(ff
, "microphone"))
3356 t
= "audio-input-microphone";
3357 else if (pa_streq(ff
, "webcam"))
3359 else if (pa_streq(ff
, "computer"))
3361 else if (pa_streq(ff
, "handset"))
3363 else if (pa_streq(ff
, "portable"))
3364 t
= "multimedia-player";
3365 else if (pa_streq(ff
, "tv"))
3366 t
= "video-display";
3369 * The following icons are not part of the icon naming spec,
3370 * because Rodney Dawes sucks as the maintainer of that spec.
3372 * http://lists.freedesktop.org/archives/xdg/2009-May/010397.html
3374 else if (pa_streq(ff
, "headset"))
3375 t
= "audio-headset";
3376 else if (pa_streq(ff
, "headphone"))
3377 t
= "audio-headphones";
3378 else if (pa_streq(ff
, "speaker"))
3379 t
= "audio-speakers";
3380 else if (pa_streq(ff
, "hands-free"))
3381 t
= "audio-handsfree";
3385 if ((c
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3386 if (pa_streq(c
, "modem"))
3393 t
= "audio-input-microphone";
3396 if ((profile
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3397 if (strstr(profile
, "analog"))
3399 else if (strstr(profile
, "iec958"))
3401 else if (strstr(profile
, "hdmi"))
3405 bus
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
);
3407 pa_proplist_setf(p
, PA_PROP_DEVICE_ICON_NAME
, "%s%s%s%s", t
, pa_strempty(s
), bus
? "-" : "", pa_strempty(bus
));
3412 pa_bool_t
pa_device_init_description(pa_proplist
*p
) {
3413 const char *s
, *d
= NULL
, *k
;
3416 if (pa_proplist_contains(p
, PA_PROP_DEVICE_DESCRIPTION
))
3419 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3420 if (pa_streq(s
, "internal"))
3421 d
= _("Built-in Audio");
3424 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3425 if (pa_streq(s
, "modem"))
3429 d
= pa_proplist_gets(p
, PA_PROP_DEVICE_PRODUCT_NAME
);
3434 k
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_DESCRIPTION
);
3437 pa_proplist_setf(p
, PA_PROP_DEVICE_DESCRIPTION
, "%s %s", d
, k
);
3439 pa_proplist_sets(p
, PA_PROP_DEVICE_DESCRIPTION
, d
);
3444 pa_bool_t
pa_device_init_intended_roles(pa_proplist
*p
) {
3448 if (pa_proplist_contains(p
, PA_PROP_DEVICE_INTENDED_ROLES
))
3451 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3452 if (pa_streq(s
, "handset") || pa_streq(s
, "hands-free")
3453 || pa_streq(s
, "headset")) {
3454 pa_proplist_sets(p
, PA_PROP_DEVICE_INTENDED_ROLES
, "phone");
3461 unsigned pa_device_init_priority(pa_proplist
*p
) {
3463 unsigned priority
= 0;
3467 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
))) {
3469 if (pa_streq(s
, "sound"))
3471 else if (!pa_streq(s
, "modem"))
3475 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3477 if (pa_streq(s
, "internal"))
3479 else if (pa_streq(s
, "speaker"))
3481 else if (pa_streq(s
, "headphone"))
3485 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
))) {
3487 if (pa_streq(s
, "pci"))
3489 else if (pa_streq(s
, "usb"))
3491 else if (pa_streq(s
, "bluetooth"))
3495 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3497 if (pa_startswith(s
, "analog-"))
3499 else if (pa_startswith(s
, "iec958-"))
3506 PA_STATIC_FLIST_DECLARE(pa_sink_volume_change
, 0, pa_xfree
);
3508 /* Called from the IO thread. */
3509 static pa_sink_volume_change
*pa_sink_volume_change_new(pa_sink
*s
) {
3510 pa_sink_volume_change
*c
;
3511 if (!(c
= pa_flist_pop(PA_STATIC_FLIST_GET(pa_sink_volume_change
))))
3512 c
= pa_xnew(pa_sink_volume_change
, 1);
3514 PA_LLIST_INIT(pa_sink_volume_change
, c
);
3516 pa_cvolume_reset(&c
->hw_volume
, s
->sample_spec
.channels
);
3520 /* Called from the IO thread. */
3521 static void pa_sink_volume_change_free(pa_sink_volume_change
*c
) {
3523 if (pa_flist_push(PA_STATIC_FLIST_GET(pa_sink_volume_change
), c
) < 0)
3527 /* Called from the IO thread. */
3528 void pa_sink_volume_change_push(pa_sink
*s
) {
3529 pa_sink_volume_change
*c
= NULL
;
3530 pa_sink_volume_change
*nc
= NULL
;
3531 uint32_t safety_margin
= s
->thread_info
.volume_change_safety_margin
;
3533 const char *direction
= NULL
;
3536 nc
= pa_sink_volume_change_new(s
);
3538 /* NOTE: There is already more different volumes in pa_sink that I can remember.
3539 * Adding one more volume for HW would get us rid of this, but I am trying
3540 * to survive with the ones we already have. */
3541 pa_sw_cvolume_divide(&nc
->hw_volume
, &s
->real_volume
, &s
->soft_volume
);
3543 if (!s
->thread_info
.volume_changes
&& pa_cvolume_equal(&nc
->hw_volume
, &s
->thread_info
.current_hw_volume
)) {
3544 pa_log_debug("Volume not changing");
3545 pa_sink_volume_change_free(nc
);
3549 nc
->at
= pa_sink_get_latency_within_thread(s
);
3550 nc
->at
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3552 if (s
->thread_info
.volume_changes_tail
) {
3553 for (c
= s
->thread_info
.volume_changes_tail
; c
; c
= c
->prev
) {
3554 /* If volume is going up let's do it a bit late. If it is going
3555 * down let's do it a bit early. */
3556 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&c
->hw_volume
)) {
3557 if (nc
->at
+ safety_margin
> c
->at
) {
3558 nc
->at
+= safety_margin
;
3563 else if (nc
->at
- safety_margin
> c
->at
) {
3564 nc
->at
-= safety_margin
;
3572 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&s
->thread_info
.current_hw_volume
)) {
3573 nc
->at
+= safety_margin
;
3576 nc
->at
-= safety_margin
;
3579 PA_LLIST_PREPEND(pa_sink_volume_change
, s
->thread_info
.volume_changes
, nc
);
3582 PA_LLIST_INSERT_AFTER(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
, nc
);
3585 pa_log_debug("Volume going %s to %d at %llu", direction
, pa_cvolume_avg(&nc
->hw_volume
), (long long unsigned) nc
->at
);
3587 /* We can ignore volume events that came earlier but should happen later than this. */
3588 PA_LLIST_FOREACH(c
, nc
->next
) {
3589 pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
);
3590 pa_sink_volume_change_free(c
);
3593 s
->thread_info
.volume_changes_tail
= nc
;
3596 /* Called from the IO thread. */
3597 static void pa_sink_volume_change_flush(pa_sink
*s
) {
3598 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3600 s
->thread_info
.volume_changes
= NULL
;
3601 s
->thread_info
.volume_changes_tail
= NULL
;
3603 pa_sink_volume_change
*next
= c
->next
;
3604 pa_sink_volume_change_free(c
);
3609 /* Called from the IO thread. */
3610 pa_bool_t
pa_sink_volume_change_apply(pa_sink
*s
, pa_usec_t
*usec_to_next
) {
3612 pa_bool_t ret
= FALSE
;
3616 if (!s
->thread_info
.volume_changes
|| !PA_SINK_IS_LINKED(s
->state
)) {
3622 pa_assert(s
->write_volume
);
3624 now
= pa_rtclock_now();
3626 while (s
->thread_info
.volume_changes
&& now
>= s
->thread_info
.volume_changes
->at
) {
3627 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3628 PA_LLIST_REMOVE(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
);
3629 pa_log_debug("Volume change to %d at %llu was written %llu usec late",
3630 pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
, (long long unsigned) (now
- c
->at
));
3632 s
->thread_info
.current_hw_volume
= c
->hw_volume
;
3633 pa_sink_volume_change_free(c
);
3639 if (s
->thread_info
.volume_changes
) {
3641 *usec_to_next
= s
->thread_info
.volume_changes
->at
- now
;
3642 if (pa_log_ratelimit(PA_LOG_DEBUG
))
3643 pa_log_debug("Next volume change in %lld usec", (long long) (s
->thread_info
.volume_changes
->at
- now
));
3648 s
->thread_info
.volume_changes_tail
= NULL
;
3653 /* Called from the IO thread. */
3654 static void pa_sink_volume_change_rewind(pa_sink
*s
, size_t nbytes
) {
3655 /* All the queued volume events later than current latency are shifted to happen earlier. */
3656 pa_sink_volume_change
*c
;
3657 pa_volume_t prev_vol
= pa_cvolume_avg(&s
->thread_info
.current_hw_volume
);
3658 pa_usec_t rewound
= pa_bytes_to_usec(nbytes
, &s
->sample_spec
);
3659 pa_usec_t limit
= pa_sink_get_latency_within_thread(s
);
3661 pa_log_debug("latency = %lld", (long long) limit
);
3662 limit
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3664 PA_LLIST_FOREACH(c
, s
->thread_info
.volume_changes
) {
3665 pa_usec_t modified_limit
= limit
;
3666 if (prev_vol
> pa_cvolume_avg(&c
->hw_volume
))
3667 modified_limit
-= s
->thread_info
.volume_change_safety_margin
;
3669 modified_limit
+= s
->thread_info
.volume_change_safety_margin
;
3670 if (c
->at
> modified_limit
) {
3672 if (c
->at
< modified_limit
)
3673 c
->at
= modified_limit
;
3675 prev_vol
= pa_cvolume_avg(&c
->hw_volume
);
3677 pa_sink_volume_change_apply(s
, NULL
);
3680 /* Called from the main thread */
3681 /* Gets the list of formats supported by the sink. The members and idxset must
3682 * be freed by the caller. */
3683 pa_idxset
* pa_sink_get_formats(pa_sink
*s
) {
3688 if (s
->get_formats
) {
3689 /* Sink supports format query, all is good */
3690 ret
= s
->get_formats(s
);
3692 /* Sink doesn't support format query, so assume it does PCM */
3693 pa_format_info
*f
= pa_format_info_new();
3694 f
->encoding
= PA_ENCODING_PCM
;
3696 ret
= pa_idxset_new(NULL
, NULL
);
3697 pa_idxset_put(ret
, f
, NULL
);
3703 /* Called from the main thread */
3704 /* Allows an external source to set what formats a sink supports if the sink
3705 * permits this. The function makes a copy of the formats on success. */
3706 pa_bool_t
pa_sink_set_formats(pa_sink
*s
, pa_idxset
*formats
) {
3711 /* Sink supports setting formats -- let's give it a shot */
3712 return s
->set_formats(s
, formats
);
3714 /* Sink doesn't support setting this -- bail out */
3718 /* Called from the main thread */
3719 /* Checks if the sink can accept this format */
3720 pa_bool_t
pa_sink_check_format(pa_sink
*s
, pa_format_info
*f
)
3722 pa_idxset
*formats
= NULL
;
3723 pa_bool_t ret
= FALSE
;
3728 formats
= pa_sink_get_formats(s
);
3731 pa_format_info
*finfo_device
;
3734 PA_IDXSET_FOREACH(finfo_device
, formats
, i
) {
3735 if (pa_format_info_is_compatible(finfo_device
, f
)) {
3741 pa_idxset_free(formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);
3747 /* Called from the main thread */
3748 /* Calculates the intersection between formats supported by the sink and
3749 * in_formats, and returns these, in the order of the sink's formats. */
3750 pa_idxset
* pa_sink_check_formats(pa_sink
*s
, pa_idxset
*in_formats
) {
3751 pa_idxset
*out_formats
= pa_idxset_new(NULL
, NULL
), *sink_formats
= NULL
;
3752 pa_format_info
*f_sink
, *f_in
;
3757 if (!in_formats
|| pa_idxset_isempty(in_formats
))
3760 sink_formats
= pa_sink_get_formats(s
);
3762 PA_IDXSET_FOREACH(f_sink
, sink_formats
, i
) {
3763 PA_IDXSET_FOREACH(f_in
, in_formats
, j
) {
3764 if (pa_format_info_is_compatible(f_sink
, f_in
))
3765 pa_idxset_put(out_formats
, pa_format_info_copy(f_in
), NULL
);
3771 pa_idxset_free(sink_formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);