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
;
941 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
945 pa_log_debug("Processing rewind...");
946 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
947 pa_sink_volume_change_rewind(s
, nbytes
);
950 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
951 pa_sink_input_assert_ref(i
);
952 pa_sink_input_process_rewind(i
, nbytes
);
956 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
957 pa_source_process_rewind(s
->monitor_source
, nbytes
);
961 /* Called from IO thread context */
962 static unsigned fill_mix_info(pa_sink
*s
, size_t *length
, pa_mix_info
*info
, unsigned maxinfo
) {
966 size_t mixlength
= *length
;
968 pa_sink_assert_ref(s
);
969 pa_sink_assert_io_context(s
);
972 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)) && maxinfo
> 0) {
973 pa_sink_input_assert_ref(i
);
975 pa_sink_input_peek(i
, *length
, &info
->chunk
, &info
->volume
);
977 if (mixlength
== 0 || info
->chunk
.length
< mixlength
)
978 mixlength
= info
->chunk
.length
;
980 if (pa_memblock_is_silence(info
->chunk
.memblock
)) {
981 pa_memblock_unref(info
->chunk
.memblock
);
985 info
->userdata
= pa_sink_input_ref(i
);
987 pa_assert(info
->chunk
.memblock
);
988 pa_assert(info
->chunk
.length
> 0);
1001 /* Called from IO thread context */
1002 static void inputs_drop(pa_sink
*s
, pa_mix_info
*info
, unsigned n
, pa_memchunk
*result
) {
1006 unsigned n_unreffed
= 0;
1008 pa_sink_assert_ref(s
);
1009 pa_sink_assert_io_context(s
);
1011 pa_assert(result
->memblock
);
1012 pa_assert(result
->length
> 0);
1014 /* We optimize for the case where the order of the inputs has not changed */
1016 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
1018 pa_mix_info
* m
= NULL
;
1020 pa_sink_input_assert_ref(i
);
1022 /* Let's try to find the matching entry info the pa_mix_info array */
1023 for (j
= 0; j
< n
; j
++) {
1025 if (info
[p
].userdata
== i
) {
1035 /* Drop read data */
1036 pa_sink_input_drop(i
, result
->length
);
1038 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
)) {
1040 if (pa_hashmap_size(i
->thread_info
.direct_outputs
) > 0) {
1041 void *ostate
= NULL
;
1042 pa_source_output
*o
;
1045 if (m
&& m
->chunk
.memblock
) {
1047 pa_memblock_ref(c
.memblock
);
1048 pa_assert(result
->length
<= c
.length
);
1049 c
.length
= result
->length
;
1051 pa_memchunk_make_writable(&c
, 0);
1052 pa_volume_memchunk(&c
, &s
->sample_spec
, &m
->volume
);
1055 pa_memblock_ref(c
.memblock
);
1056 pa_assert(result
->length
<= c
.length
);
1057 c
.length
= result
->length
;
1060 while ((o
= pa_hashmap_iterate(i
->thread_info
.direct_outputs
, &ostate
, NULL
))) {
1061 pa_source_output_assert_ref(o
);
1062 pa_assert(o
->direct_on_input
== i
);
1063 pa_source_post_direct(s
->monitor_source
, o
, &c
);
1066 pa_memblock_unref(c
.memblock
);
1071 if (m
->chunk
.memblock
)
1072 pa_memblock_unref(m
->chunk
.memblock
);
1073 pa_memchunk_reset(&m
->chunk
);
1075 pa_sink_input_unref(m
->userdata
);
1082 /* Now drop references to entries that are included in the
1083 * pa_mix_info array but don't exist anymore */
1085 if (n_unreffed
< n
) {
1086 for (; n
> 0; info
++, n
--) {
1088 pa_sink_input_unref(info
->userdata
);
1089 if (info
->chunk
.memblock
)
1090 pa_memblock_unref(info
->chunk
.memblock
);
1094 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
1095 pa_source_post(s
->monitor_source
, result
);
1098 /* Called from IO thread context */
1099 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1100 pa_mix_info info
[MAX_MIX_CHANNELS
];
1102 size_t block_size_max
;
1104 pa_sink_assert_ref(s
);
1105 pa_sink_assert_io_context(s
);
1106 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1107 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1110 pa_assert(!s
->thread_info
.rewind_requested
);
1111 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1113 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1114 result
->memblock
= pa_memblock_ref(s
->silence
.memblock
);
1115 result
->index
= s
->silence
.index
;
1116 result
->length
= PA_MIN(s
->silence
.length
, length
);
1123 length
= pa_frame_align(MIX_BUFFER_LENGTH
, &s
->sample_spec
);
1125 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1126 if (length
> block_size_max
)
1127 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1129 pa_assert(length
> 0);
1131 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1135 *result
= s
->silence
;
1136 pa_memblock_ref(result
->memblock
);
1138 if (result
->length
> length
)
1139 result
->length
= length
;
1141 } else if (n
== 1) {
1144 *result
= info
[0].chunk
;
1145 pa_memblock_ref(result
->memblock
);
1147 if (result
->length
> length
)
1148 result
->length
= length
;
1150 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1152 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
)) {
1153 pa_memblock_unref(result
->memblock
);
1154 pa_silence_memchunk_get(&s
->core
->silence_cache
,
1159 } else if (!pa_cvolume_is_norm(&volume
)) {
1160 pa_memchunk_make_writable(result
, 0);
1161 pa_volume_memchunk(result
, &s
->sample_spec
, &volume
);
1165 result
->memblock
= pa_memblock_new(s
->core
->mempool
, length
);
1167 ptr
= pa_memblock_acquire(result
->memblock
);
1168 result
->length
= pa_mix(info
, n
,
1171 &s
->thread_info
.soft_volume
,
1172 s
->thread_info
.soft_muted
);
1173 pa_memblock_release(result
->memblock
);
1178 inputs_drop(s
, info
, n
, result
);
1183 /* Called from IO thread context */
1184 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
) {
1185 pa_mix_info info
[MAX_MIX_CHANNELS
];
1187 size_t length
, block_size_max
;
1189 pa_sink_assert_ref(s
);
1190 pa_sink_assert_io_context(s
);
1191 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1193 pa_assert(target
->memblock
);
1194 pa_assert(target
->length
> 0);
1195 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1197 pa_assert(!s
->thread_info
.rewind_requested
);
1198 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1200 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1201 pa_silence_memchunk(target
, &s
->sample_spec
);
1207 length
= target
->length
;
1208 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1209 if (length
> block_size_max
)
1210 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1212 pa_assert(length
> 0);
1214 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1217 if (target
->length
> length
)
1218 target
->length
= length
;
1220 pa_silence_memchunk(target
, &s
->sample_spec
);
1221 } else if (n
== 1) {
1224 if (target
->length
> length
)
1225 target
->length
= length
;
1227 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1229 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
))
1230 pa_silence_memchunk(target
, &s
->sample_spec
);
1234 vchunk
= info
[0].chunk
;
1235 pa_memblock_ref(vchunk
.memblock
);
1237 if (vchunk
.length
> length
)
1238 vchunk
.length
= length
;
1240 if (!pa_cvolume_is_norm(&volume
)) {
1241 pa_memchunk_make_writable(&vchunk
, 0);
1242 pa_volume_memchunk(&vchunk
, &s
->sample_spec
, &volume
);
1245 pa_memchunk_memcpy(target
, &vchunk
);
1246 pa_memblock_unref(vchunk
.memblock
);
1252 ptr
= pa_memblock_acquire(target
->memblock
);
1254 target
->length
= pa_mix(info
, n
,
1255 (uint8_t*) ptr
+ target
->index
, length
,
1257 &s
->thread_info
.soft_volume
,
1258 s
->thread_info
.soft_muted
);
1260 pa_memblock_release(target
->memblock
);
1263 inputs_drop(s
, info
, n
, target
);
1268 /* Called from IO thread context */
1269 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
) {
1273 pa_sink_assert_ref(s
);
1274 pa_sink_assert_io_context(s
);
1275 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1277 pa_assert(target
->memblock
);
1278 pa_assert(target
->length
> 0);
1279 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1281 pa_assert(!s
->thread_info
.rewind_requested
);
1282 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1284 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1285 pa_silence_memchunk(target
, &s
->sample_spec
);
1298 pa_sink_render_into(s
, &chunk
);
1307 /* Called from IO thread context */
1308 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1309 pa_sink_assert_ref(s
);
1310 pa_sink_assert_io_context(s
);
1311 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1312 pa_assert(length
> 0);
1313 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1316 pa_assert(!s
->thread_info
.rewind_requested
);
1317 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1321 pa_sink_render(s
, length
, result
);
1323 if (result
->length
< length
) {
1326 pa_memchunk_make_writable(result
, length
);
1328 chunk
.memblock
= result
->memblock
;
1329 chunk
.index
= result
->index
+ result
->length
;
1330 chunk
.length
= length
- result
->length
;
1332 pa_sink_render_into_full(s
, &chunk
);
1334 result
->length
= length
;
1340 /* Called from main thread */
1341 pa_bool_t
pa_sink_update_rate(pa_sink
*s
, uint32_t rate
, pa_bool_t passthrough
)
1343 if (s
->update_rate
) {
1344 uint32_t desired_rate
= rate
;
1345 uint32_t default_rate
= s
->default_sample_rate
;
1346 uint32_t alternate_rate
= s
->alternate_sample_rate
;
1349 pa_bool_t use_alternate
= FALSE
;
1351 if (PA_UNLIKELY(default_rate
== alternate_rate
)) {
1352 pa_log_warn("Default and alternate sample rates are the same.");
1356 if (PA_SINK_IS_RUNNING(s
->state
)) {
1357 pa_log_info("Cannot update rate, SINK_IS_RUNNING, will keep using %u Hz",
1358 s
->sample_spec
.rate
);
1362 if (s
->monitor_source
) {
1363 if (PA_SOURCE_IS_RUNNING(s
->monitor_source
->state
) == TRUE
) {
1364 pa_log_info("Cannot update rate, monitor source is RUNNING");
1369 if (PA_UNLIKELY (desired_rate
< 8000 ||
1370 desired_rate
> PA_RATE_MAX
))
1374 pa_assert(default_rate
% 4000 || default_rate
% 11025);
1375 pa_assert(alternate_rate
% 4000 || alternate_rate
% 11025);
1377 if (default_rate
% 4000) {
1378 /* default is a 11025 multiple */
1379 if ((alternate_rate
% 4000 == 0) && (desired_rate
% 4000 == 0))
1382 /* default is 4000 multiple */
1383 if ((alternate_rate
% 11025 == 0) && (desired_rate
% 11025 == 0))
1388 desired_rate
= alternate_rate
;
1390 desired_rate
= default_rate
;
1392 desired_rate
= rate
; /* use stream sampling rate, discard default/alternate settings */
1395 if (desired_rate
== s
->sample_spec
.rate
)
1398 if (!passthrough
&& pa_sink_used_by(s
) > 0)
1401 pa_sink_suspend(s
, TRUE
, PA_SUSPEND_IDLE
); /* needed before rate update, will be resumed automatically */
1403 if (s
->update_rate(s
, desired_rate
) == TRUE
) {
1404 /* update monitor source as well */
1405 if (s
->monitor_source
&& !passthrough
)
1406 pa_source_update_rate(s
->monitor_source
, desired_rate
, FALSE
);
1407 pa_log_info("Changed sampling rate successfully");
1409 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1410 if (i
->state
== PA_SINK_INPUT_CORKED
)
1411 pa_sink_input_update_rate(i
);
1420 /* Called from main thread */
1421 pa_usec_t
pa_sink_get_latency(pa_sink
*s
) {
1424 pa_sink_assert_ref(s
);
1425 pa_assert_ctl_context();
1426 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1428 /* The returned value is supposed to be in the time domain of the sound card! */
1430 if (s
->state
== PA_SINK_SUSPENDED
)
1433 if (!(s
->flags
& PA_SINK_LATENCY
))
1436 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) == 0);
1438 /* usec is unsigned, so check that the offset can be added to usec without
1440 if (-s
->latency_offset
<= (int64_t) usec
)
1441 usec
+= s
->latency_offset
;
1448 /* Called from IO thread */
1449 pa_usec_t
pa_sink_get_latency_within_thread(pa_sink
*s
) {
1453 pa_sink_assert_ref(s
);
1454 pa_sink_assert_io_context(s
);
1455 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1457 /* The returned value is supposed to be in the time domain of the sound card! */
1459 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
1462 if (!(s
->flags
& PA_SINK_LATENCY
))
1465 o
= PA_MSGOBJECT(s
);
1467 /* FIXME: We probably should make this a proper vtable callback instead of going through process_msg() */
1469 if (o
->process_msg(o
, PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) < 0)
1472 /* usec is unsigned, so check that the offset can be added to usec without
1474 if (-s
->thread_info
.latency_offset
<= (int64_t) usec
)
1475 usec
+= s
->thread_info
.latency_offset
;
1482 /* Called from the main thread (and also from the IO thread while the main
1483 * thread is waiting).
1485 * When a sink uses volume sharing, it never has the PA_SINK_FLAT_VOLUME flag
1486 * set. Instead, flat volume mode is detected by checking whether the root sink
1487 * has the flag set. */
1488 pa_bool_t
pa_sink_flat_volume_enabled(pa_sink
*s
) {
1489 pa_sink_assert_ref(s
);
1491 s
= pa_sink_get_master(s
);
1494 return (s
->flags
& PA_SINK_FLAT_VOLUME
);
1499 /* Called from the main thread (and also from the IO thread while the main
1500 * thread is waiting). */
1501 pa_sink
*pa_sink_get_master(pa_sink
*s
) {
1502 pa_sink_assert_ref(s
);
1504 while (s
&& (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1505 if (PA_UNLIKELY(!s
->input_to_master
))
1508 s
= s
->input_to_master
->sink
;
1514 /* Called from main context */
1515 pa_bool_t
pa_sink_is_passthrough(pa_sink
*s
) {
1516 pa_sink_input
*alt_i
;
1519 pa_sink_assert_ref(s
);
1521 /* one and only one PASSTHROUGH input can possibly be connected */
1522 if (pa_idxset_size(s
->inputs
) == 1) {
1523 alt_i
= pa_idxset_first(s
->inputs
, &idx
);
1525 if (pa_sink_input_is_passthrough(alt_i
))
1532 /* Called from main context */
1533 void pa_sink_enter_passthrough(pa_sink
*s
) {
1536 /* disable the monitor in passthrough mode */
1537 if (s
->monitor_source
)
1538 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_source_suspend(s
->monitor_source
, FALSE
, PA_SUSPEND_PASSTHROUGH
);
1554 /* Restore sink volume to what it was before we entered passthrough mode */
1555 pa_sink_set_volume(s
, &s
->saved_volume
, TRUE
, s
->saved_save_volume
);
1557 pa_cvolume_init(&s
->saved_volume
);
1558 s
->saved_save_volume
= FALSE
;
1561 /* Called from main context. */
1562 static void compute_reference_ratio(pa_sink_input
*i
) {
1564 pa_cvolume remapped
;
1567 pa_assert(pa_sink_flat_volume_enabled(i
->sink
));
1570 * Calculates the reference ratio from the sink's reference
1571 * volume. This basically calculates:
1573 * i->reference_ratio = i->volume / i->sink->reference_volume
1576 remapped
= i
->sink
->reference_volume
;
1577 pa_cvolume_remap(&remapped
, &i
->sink
->channel_map
, &i
->channel_map
);
1579 i
->reference_ratio
.channels
= i
->sample_spec
.channels
;
1581 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1583 /* We don't update when the sink volume is 0 anyway */
1584 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
)
1587 /* Don't update the reference ratio unless necessary */
1588 if (pa_sw_volume_multiply(
1589 i
->reference_ratio
.values
[c
],
1590 remapped
.values
[c
]) == i
->volume
.values
[c
])
1593 i
->reference_ratio
.values
[c
] = pa_sw_volume_divide(
1594 i
->volume
.values
[c
],
1595 remapped
.values
[c
]);
1599 /* Called from main context. Only called for the root sink in volume sharing
1600 * cases, except for internal recursive calls. */
1601 static void compute_reference_ratios(pa_sink
*s
) {
1605 pa_sink_assert_ref(s
);
1606 pa_assert_ctl_context();
1607 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1608 pa_assert(pa_sink_flat_volume_enabled(s
));
1610 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1611 compute_reference_ratio(i
);
1613 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1614 compute_reference_ratios(i
->origin_sink
);
1618 /* Called from main context. Only called for the root sink in volume sharing
1619 * cases, except for internal recursive calls. */
1620 static void compute_real_ratios(pa_sink
*s
) {
1624 pa_sink_assert_ref(s
);
1625 pa_assert_ctl_context();
1626 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1627 pa_assert(pa_sink_flat_volume_enabled(s
));
1629 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1631 pa_cvolume remapped
;
1633 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1634 /* The origin sink uses volume sharing, so this input's real ratio
1635 * is handled as a special case - the real ratio must be 0 dB, and
1636 * as a result i->soft_volume must equal i->volume_factor. */
1637 pa_cvolume_reset(&i
->real_ratio
, i
->real_ratio
.channels
);
1638 i
->soft_volume
= i
->volume_factor
;
1640 compute_real_ratios(i
->origin_sink
);
1646 * This basically calculates:
1648 * i->real_ratio := i->volume / s->real_volume
1649 * i->soft_volume := i->real_ratio * i->volume_factor
1652 remapped
= s
->real_volume
;
1653 pa_cvolume_remap(&remapped
, &s
->channel_map
, &i
->channel_map
);
1655 i
->real_ratio
.channels
= i
->sample_spec
.channels
;
1656 i
->soft_volume
.channels
= i
->sample_spec
.channels
;
1658 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1660 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
) {
1661 /* We leave i->real_ratio untouched */
1662 i
->soft_volume
.values
[c
] = PA_VOLUME_MUTED
;
1666 /* Don't lose accuracy unless necessary */
1667 if (pa_sw_volume_multiply(
1668 i
->real_ratio
.values
[c
],
1669 remapped
.values
[c
]) != i
->volume
.values
[c
])
1671 i
->real_ratio
.values
[c
] = pa_sw_volume_divide(
1672 i
->volume
.values
[c
],
1673 remapped
.values
[c
]);
1675 i
->soft_volume
.values
[c
] = pa_sw_volume_multiply(
1676 i
->real_ratio
.values
[c
],
1677 i
->volume_factor
.values
[c
]);
1680 /* We don't copy the soft_volume to the thread_info data
1681 * here. That must be done by the caller */
1685 static pa_cvolume
*cvolume_remap_minimal_impact(
1687 const pa_cvolume
*template,
1688 const pa_channel_map
*from
,
1689 const pa_channel_map
*to
) {
1694 pa_assert(template);
1697 pa_assert(pa_cvolume_compatible_with_channel_map(v
, from
));
1698 pa_assert(pa_cvolume_compatible_with_channel_map(template, to
));
1700 /* Much like pa_cvolume_remap(), but tries to minimize impact when
1701 * mapping from sink input to sink volumes:
1703 * If template is a possible remapping from v it is used instead
1704 * of remapping anew.
1706 * If the channel maps don't match we set an all-channel volume on
1707 * the sink to ensure that changing a volume on one stream has no
1708 * effect that cannot be compensated for in another stream that
1709 * does not have the same channel map as the sink. */
1711 if (pa_channel_map_equal(from
, to
))
1715 if (pa_cvolume_equal(pa_cvolume_remap(&t
, to
, from
), v
)) {
1720 pa_cvolume_set(v
, to
->channels
, pa_cvolume_max(v
));
1724 /* Called from main thread. Only called for the root sink in volume sharing
1725 * cases, except for internal recursive calls. */
1726 static void get_maximum_input_volume(pa_sink
*s
, pa_cvolume
*max_volume
, const pa_channel_map
*channel_map
) {
1730 pa_sink_assert_ref(s
);
1731 pa_assert(max_volume
);
1732 pa_assert(channel_map
);
1733 pa_assert(pa_sink_flat_volume_enabled(s
));
1735 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1736 pa_cvolume remapped
;
1738 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1739 get_maximum_input_volume(i
->origin_sink
, max_volume
, channel_map
);
1741 /* Ignore this input. The origin sink uses volume sharing, so this
1742 * input's volume will be set to be equal to the root sink's real
1743 * volume. Obviously this input's current volume must not then
1744 * affect what the root sink's real volume will be. */
1748 remapped
= i
->volume
;
1749 cvolume_remap_minimal_impact(&remapped
, max_volume
, &i
->channel_map
, channel_map
);
1750 pa_cvolume_merge(max_volume
, max_volume
, &remapped
);
1754 /* Called from main thread. Only called for the root sink in volume sharing
1755 * cases, except for internal recursive calls. */
1756 static pa_bool_t
has_inputs(pa_sink
*s
) {
1760 pa_sink_assert_ref(s
);
1762 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1763 if (!i
->origin_sink
|| !(i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) || has_inputs(i
->origin_sink
))
1770 /* Called from main thread. Only called for the root sink in volume sharing
1771 * cases, except for internal recursive calls. */
1772 static void update_real_volume(pa_sink
*s
, const pa_cvolume
*new_volume
, pa_channel_map
*channel_map
) {
1776 pa_sink_assert_ref(s
);
1777 pa_assert(new_volume
);
1778 pa_assert(channel_map
);
1780 s
->real_volume
= *new_volume
;
1781 pa_cvolume_remap(&s
->real_volume
, channel_map
, &s
->channel_map
);
1783 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1784 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1785 if (pa_sink_flat_volume_enabled(s
)) {
1786 pa_cvolume old_volume
= i
->volume
;
1788 /* Follow the root sink's real volume. */
1789 i
->volume
= *new_volume
;
1790 pa_cvolume_remap(&i
->volume
, channel_map
, &i
->channel_map
);
1791 compute_reference_ratio(i
);
1793 /* The volume changed, let's tell people so */
1794 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
1795 if (i
->volume_changed
)
1796 i
->volume_changed(i
);
1798 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1802 update_real_volume(i
->origin_sink
, new_volume
, channel_map
);
1807 /* Called from main thread. Only called for the root sink in shared volume
1809 static void compute_real_volume(pa_sink
*s
) {
1810 pa_sink_assert_ref(s
);
1811 pa_assert_ctl_context();
1812 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1813 pa_assert(pa_sink_flat_volume_enabled(s
));
1814 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
1816 /* This determines the maximum volume of all streams and sets
1817 * s->real_volume accordingly. */
1819 if (!has_inputs(s
)) {
1820 /* In the special case that we have no sink inputs we leave the
1821 * volume unmodified. */
1822 update_real_volume(s
, &s
->reference_volume
, &s
->channel_map
);
1826 pa_cvolume_mute(&s
->real_volume
, s
->channel_map
.channels
);
1828 /* First let's determine the new maximum volume of all inputs
1829 * connected to this sink */
1830 get_maximum_input_volume(s
, &s
->real_volume
, &s
->channel_map
);
1831 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
1833 /* Then, let's update the real ratios/soft volumes of all inputs
1834 * connected to this sink */
1835 compute_real_ratios(s
);
1838 /* Called from main thread. Only called for the root sink in shared volume
1839 * cases, except for internal recursive calls. */
1840 static void propagate_reference_volume(pa_sink
*s
) {
1844 pa_sink_assert_ref(s
);
1845 pa_assert_ctl_context();
1846 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1847 pa_assert(pa_sink_flat_volume_enabled(s
));
1849 /* This is called whenever the sink volume changes that is not
1850 * caused by a sink input volume change. We need to fix up the
1851 * sink input volumes accordingly */
1853 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1854 pa_cvolume old_volume
;
1856 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1857 propagate_reference_volume(i
->origin_sink
);
1859 /* Since the origin sink uses volume sharing, this input's volume
1860 * needs to be updated to match the root sink's real volume, but
1861 * that will be done later in update_shared_real_volume(). */
1865 old_volume
= i
->volume
;
1867 /* This basically calculates:
1869 * i->volume := s->reference_volume * i->reference_ratio */
1871 i
->volume
= s
->reference_volume
;
1872 pa_cvolume_remap(&i
->volume
, &s
->channel_map
, &i
->channel_map
);
1873 pa_sw_cvolume_multiply(&i
->volume
, &i
->volume
, &i
->reference_ratio
);
1875 /* The volume changed, let's tell people so */
1876 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
1878 if (i
->volume_changed
)
1879 i
->volume_changed(i
);
1881 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1886 /* Called from main thread. Only called for the root sink in volume sharing
1887 * cases, except for internal recursive calls. The return value indicates
1888 * whether any reference volume actually changed. */
1889 static pa_bool_t
update_reference_volume(pa_sink
*s
, const pa_cvolume
*v
, const pa_channel_map
*channel_map
, pa_bool_t save
) {
1891 pa_bool_t reference_volume_changed
;
1895 pa_sink_assert_ref(s
);
1896 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1898 pa_assert(channel_map
);
1899 pa_assert(pa_cvolume_valid(v
));
1902 pa_cvolume_remap(&volume
, channel_map
, &s
->channel_map
);
1904 reference_volume_changed
= !pa_cvolume_equal(&volume
, &s
->reference_volume
);
1905 s
->reference_volume
= volume
;
1907 s
->save_volume
= (!reference_volume_changed
&& s
->save_volume
) || save
;
1909 if (reference_volume_changed
)
1910 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
1911 else if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1912 /* If the root sink's volume doesn't change, then there can't be any
1913 * changes in the other sinks in the sink tree either.
1915 * It's probably theoretically possible that even if the root sink's
1916 * volume changes slightly, some filter sink doesn't change its volume
1917 * due to rounding errors. If that happens, we still want to propagate
1918 * the changed root sink volume to the sinks connected to the
1919 * intermediate sink that didn't change its volume. This theoretical
1920 * possibility is the reason why we have that !(s->flags &
1921 * PA_SINK_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would
1922 * notice even if we returned here FALSE always if
1923 * reference_volume_changed is FALSE. */
1926 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1927 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1928 update_reference_volume(i
->origin_sink
, v
, channel_map
, FALSE
);
1934 /* Called from main thread */
1935 void pa_sink_set_volume(
1937 const pa_cvolume
*volume
,
1941 pa_cvolume new_reference_volume
;
1944 pa_sink_assert_ref(s
);
1945 pa_assert_ctl_context();
1946 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1947 pa_assert(!volume
|| pa_cvolume_valid(volume
));
1948 pa_assert(volume
|| pa_sink_flat_volume_enabled(s
));
1949 pa_assert(!volume
|| volume
->channels
== 1 || pa_cvolume_compatible(volume
, &s
->sample_spec
));
1951 /* make sure we don't change the volume when a PASSTHROUGH input is connected ...
1952 * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */
1953 if (pa_sink_is_passthrough(s
) && (!volume
|| !pa_cvolume_is_norm(volume
))) {
1954 pa_log_warn("Cannot change volume, Sink is connected to PASSTHROUGH input");
1958 /* In case of volume sharing, the volume is set for the root sink first,
1959 * from which it's then propagated to the sharing sinks. */
1960 root_sink
= pa_sink_get_master(s
);
1962 if (PA_UNLIKELY(!root_sink
))
1965 /* As a special exception we accept mono volumes on all sinks --
1966 * even on those with more complex channel maps */
1969 if (pa_cvolume_compatible(volume
, &s
->sample_spec
))
1970 new_reference_volume
= *volume
;
1972 new_reference_volume
= s
->reference_volume
;
1973 pa_cvolume_scale(&new_reference_volume
, pa_cvolume_max(volume
));
1976 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
1978 if (update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
)) {
1979 if (pa_sink_flat_volume_enabled(root_sink
)) {
1980 /* OK, propagate this volume change back to the inputs */
1981 propagate_reference_volume(root_sink
);
1983 /* And now recalculate the real volume */
1984 compute_real_volume(root_sink
);
1986 update_real_volume(root_sink
, &root_sink
->reference_volume
, &root_sink
->channel_map
);
1990 /* If volume is NULL we synchronize the sink's real and
1991 * reference volumes with the stream volumes. */
1993 pa_assert(pa_sink_flat_volume_enabled(root_sink
));
1995 /* Ok, let's determine the new real volume */
1996 compute_real_volume(root_sink
);
1998 /* Let's 'push' the reference volume if necessary */
1999 pa_cvolume_merge(&new_reference_volume
, &s
->reference_volume
, &root_sink
->real_volume
);
2000 /* If the sink and it's root don't have the same number of channels, we need to remap */
2001 if (s
!= root_sink
&& !pa_channel_map_equal(&s
->channel_map
, &root_sink
->channel_map
))
2002 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
2003 update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
);
2005 /* Now that the reference volume is updated, we can update the streams'
2006 * reference ratios. */
2007 compute_reference_ratios(root_sink
);
2010 if (root_sink
->set_volume
) {
2011 /* If we have a function set_volume(), then we do not apply a
2012 * soft volume by default. However, set_volume() is free to
2013 * apply one to root_sink->soft_volume */
2015 pa_cvolume_reset(&root_sink
->soft_volume
, root_sink
->sample_spec
.channels
);
2016 if (!(root_sink
->flags
& PA_SINK_DEFERRED_VOLUME
))
2017 root_sink
->set_volume(root_sink
);
2020 /* If we have no function set_volume(), then the soft volume
2021 * becomes the real volume */
2022 root_sink
->soft_volume
= root_sink
->real_volume
;
2024 /* This tells the sink that soft volume and/or real volume changed */
2026 pa_assert_se(pa_asyncmsgq_send(root_sink
->asyncmsgq
, PA_MSGOBJECT(root_sink
), PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
) == 0);
2029 /* Called from the io thread if sync volume is used, otherwise from the main thread.
2030 * Only to be called by sink implementor */
2031 void pa_sink_set_soft_volume(pa_sink
*s
, const pa_cvolume
*volume
) {
2033 pa_sink_assert_ref(s
);
2034 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2036 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
2037 pa_sink_assert_io_context(s
);
2039 pa_assert_ctl_context();
2042 pa_cvolume_reset(&s
->soft_volume
, s
->sample_spec
.channels
);
2044 s
->soft_volume
= *volume
;
2046 if (PA_SINK_IS_LINKED(s
->state
) && !(s
->flags
& PA_SINK_DEFERRED_VOLUME
))
2047 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME
, NULL
, 0, NULL
) == 0);
2049 s
->thread_info
.soft_volume
= s
->soft_volume
;
2052 /* Called from the main thread. Only called for the root sink in volume sharing
2053 * cases, except for internal recursive calls. */
2054 static void propagate_real_volume(pa_sink
*s
, const pa_cvolume
*old_real_volume
) {
2058 pa_sink_assert_ref(s
);
2059 pa_assert(old_real_volume
);
2060 pa_assert_ctl_context();
2061 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2063 /* This is called when the hardware's real volume changes due to
2064 * some external event. We copy the real volume into our
2065 * reference volume and then rebuild the stream volumes based on
2066 * i->real_ratio which should stay fixed. */
2068 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
2069 if (pa_cvolume_equal(old_real_volume
, &s
->real_volume
))
2072 /* 1. Make the real volume the reference volume */
2073 update_reference_volume(s
, &s
->real_volume
, &s
->channel_map
, TRUE
);
2076 if (pa_sink_flat_volume_enabled(s
)) {
2078 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2079 pa_cvolume old_volume
= i
->volume
;
2081 /* 2. Since the sink's reference and real volumes are equal
2082 * now our ratios should be too. */
2083 i
->reference_ratio
= i
->real_ratio
;
2085 /* 3. Recalculate the new stream reference volume based on the
2086 * reference ratio and the sink's reference volume.
2088 * This basically calculates:
2090 * i->volume = s->reference_volume * i->reference_ratio
2092 * This is identical to propagate_reference_volume() */
2093 i
->volume
= s
->reference_volume
;
2094 pa_cvolume_remap(&i
->volume
, &s
->channel_map
, &i
->channel_map
);
2095 pa_sw_cvolume_multiply(&i
->volume
, &i
->volume
, &i
->reference_ratio
);
2097 /* Notify if something changed */
2098 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
2100 if (i
->volume_changed
)
2101 i
->volume_changed(i
);
2103 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
2106 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2107 propagate_real_volume(i
->origin_sink
, old_real_volume
);
2111 /* Something got changed in the hardware. It probably makes sense
2112 * to save changed hw settings given that hw volume changes not
2113 * triggered by PA are almost certainly done by the user. */
2114 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2115 s
->save_volume
= TRUE
;
2118 /* Called from io thread */
2119 void pa_sink_update_volume_and_mute(pa_sink
*s
) {
2121 pa_sink_assert_io_context(s
);
2123 pa_asyncmsgq_post(pa_thread_mq_get()->outq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
, NULL
, 0, NULL
, NULL
);
2126 /* Called from main thread */
2127 const pa_cvolume
*pa_sink_get_volume(pa_sink
*s
, pa_bool_t force_refresh
) {
2128 pa_sink_assert_ref(s
);
2129 pa_assert_ctl_context();
2130 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2132 if (s
->refresh_volume
|| force_refresh
) {
2133 struct pa_cvolume old_real_volume
;
2135 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2137 old_real_volume
= s
->real_volume
;
2139 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
)
2142 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_VOLUME
, NULL
, 0, NULL
) == 0);
2144 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
2145 propagate_real_volume(s
, &old_real_volume
);
2148 return &s
->reference_volume
;
2151 /* Called from main thread. In volume sharing cases, only the root sink may
2153 void pa_sink_volume_changed(pa_sink
*s
, const pa_cvolume
*new_real_volume
) {
2154 pa_cvolume old_real_volume
;
2156 pa_sink_assert_ref(s
);
2157 pa_assert_ctl_context();
2158 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2159 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2161 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2163 old_real_volume
= s
->real_volume
;
2164 update_real_volume(s
, new_real_volume
, &s
->channel_map
);
2165 propagate_real_volume(s
, &old_real_volume
);
2168 /* Called from main thread */
2169 void pa_sink_set_mute(pa_sink
*s
, pa_bool_t mute
, pa_bool_t save
) {
2170 pa_bool_t old_muted
;
2172 pa_sink_assert_ref(s
);
2173 pa_assert_ctl_context();
2174 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2176 old_muted
= s
->muted
;
2178 s
->save_muted
= (old_muted
== s
->muted
&& s
->save_muted
) || save
;
2180 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->set_mute
)
2183 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2185 if (old_muted
!= s
->muted
)
2186 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2189 /* Called from main thread */
2190 pa_bool_t
pa_sink_get_mute(pa_sink
*s
, pa_bool_t force_refresh
) {
2192 pa_sink_assert_ref(s
);
2193 pa_assert_ctl_context();
2194 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2196 if (s
->refresh_muted
|| force_refresh
) {
2197 pa_bool_t old_muted
= s
->muted
;
2199 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_mute
)
2202 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MUTE
, NULL
, 0, NULL
) == 0);
2204 if (old_muted
!= s
->muted
) {
2205 s
->save_muted
= TRUE
;
2207 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2209 /* Make sure the soft mute status stays in sync */
2210 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2217 /* Called from main thread */
2218 void pa_sink_mute_changed(pa_sink
*s
, pa_bool_t new_muted
) {
2219 pa_sink_assert_ref(s
);
2220 pa_assert_ctl_context();
2221 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2223 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2225 if (s
->muted
== new_muted
)
2228 s
->muted
= new_muted
;
2229 s
->save_muted
= TRUE
;
2231 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2234 /* Called from main thread */
2235 pa_bool_t
pa_sink_update_proplist(pa_sink
*s
, pa_update_mode_t mode
, pa_proplist
*p
) {
2236 pa_sink_assert_ref(s
);
2237 pa_assert_ctl_context();
2240 pa_proplist_update(s
->proplist
, mode
, p
);
2242 if (PA_SINK_IS_LINKED(s
->state
)) {
2243 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2244 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2250 /* Called from main thread */
2251 /* FIXME -- this should be dropped and be merged into pa_sink_update_proplist() */
2252 void pa_sink_set_description(pa_sink
*s
, const char *description
) {
2254 pa_sink_assert_ref(s
);
2255 pa_assert_ctl_context();
2257 if (!description
&& !pa_proplist_contains(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
))
2260 old
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2262 if (old
&& description
&& pa_streq(old
, description
))
2266 pa_proplist_sets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
, description
);
2268 pa_proplist_unset(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2270 if (s
->monitor_source
) {
2273 n
= pa_sprintf_malloc("Monitor Source of %s", description
? description
: s
->name
);
2274 pa_source_set_description(s
->monitor_source
, n
);
2278 if (PA_SINK_IS_LINKED(s
->state
)) {
2279 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2280 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2284 /* Called from main thread */
2285 unsigned pa_sink_linked_by(pa_sink
*s
) {
2288 pa_sink_assert_ref(s
);
2289 pa_assert_ctl_context();
2290 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2292 ret
= pa_idxset_size(s
->inputs
);
2294 /* We add in the number of streams connected to us here. Please
2295 * note the asymmetry to pa_sink_used_by()! */
2297 if (s
->monitor_source
)
2298 ret
+= pa_source_linked_by(s
->monitor_source
);
2303 /* Called from main thread */
2304 unsigned pa_sink_used_by(pa_sink
*s
) {
2307 pa_sink_assert_ref(s
);
2308 pa_assert_ctl_context();
2309 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2311 ret
= pa_idxset_size(s
->inputs
);
2312 pa_assert(ret
>= s
->n_corked
);
2314 /* Streams connected to our monitor source do not matter for
2315 * pa_sink_used_by()!.*/
2317 return ret
- s
->n_corked
;
2320 /* Called from main thread */
2321 unsigned pa_sink_check_suspend(pa_sink
*s
) {
2326 pa_sink_assert_ref(s
);
2327 pa_assert_ctl_context();
2329 if (!PA_SINK_IS_LINKED(s
->state
))
2334 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2335 pa_sink_input_state_t st
;
2337 st
= pa_sink_input_get_state(i
);
2339 /* We do not assert here. It is perfectly valid for a sink input to
2340 * be in the INIT state (i.e. created, marked done but not yet put)
2341 * and we should not care if it's unlinked as it won't contribute
2342 * towards our busy status.
2344 if (!PA_SINK_INPUT_IS_LINKED(st
))
2347 if (st
== PA_SINK_INPUT_CORKED
)
2350 if (i
->flags
& PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND
)
2356 if (s
->monitor_source
)
2357 ret
+= pa_source_check_suspend(s
->monitor_source
);
2362 /* Called from the IO thread */
2363 static void sync_input_volumes_within_thread(pa_sink
*s
) {
2367 pa_sink_assert_ref(s
);
2368 pa_sink_assert_io_context(s
);
2370 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2371 if (pa_cvolume_equal(&i
->thread_info
.soft_volume
, &i
->soft_volume
))
2374 i
->thread_info
.soft_volume
= i
->soft_volume
;
2375 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
, FALSE
);
2379 /* Called from the IO thread. Only called for the root sink in volume sharing
2380 * cases, except for internal recursive calls. */
2381 static void set_shared_volume_within_thread(pa_sink
*s
) {
2382 pa_sink_input
*i
= NULL
;
2385 pa_sink_assert_ref(s
);
2387 PA_MSGOBJECT(s
)->process_msg(PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME_SYNCED
, NULL
, 0, NULL
);
2389 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2390 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2391 set_shared_volume_within_thread(i
->origin_sink
);
2395 /* Called from IO thread, except when it is not */
2396 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
2397 pa_sink
*s
= PA_SINK(o
);
2398 pa_sink_assert_ref(s
);
2400 switch ((pa_sink_message_t
) code
) {
2402 case PA_SINK_MESSAGE_ADD_INPUT
: {
2403 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2405 /* If you change anything here, make sure to change the
2406 * sink input handling a few lines down at
2407 * PA_SINK_MESSAGE_FINISH_MOVE, too. */
2409 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2411 /* Since the caller sleeps in pa_sink_input_put(), we can
2412 * safely access data outside of thread_info even though
2415 if ((i
->thread_info
.sync_prev
= i
->sync_prev
)) {
2416 pa_assert(i
->sink
== i
->thread_info
.sync_prev
->sink
);
2417 pa_assert(i
->sync_prev
->sync_next
== i
);
2418 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
;
2421 if ((i
->thread_info
.sync_next
= i
->sync_next
)) {
2422 pa_assert(i
->sink
== i
->thread_info
.sync_next
->sink
);
2423 pa_assert(i
->sync_next
->sync_prev
== i
);
2424 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
;
2427 pa_assert(!i
->thread_info
.attached
);
2428 i
->thread_info
.attached
= TRUE
;
2433 pa_sink_input_set_state_within_thread(i
, i
->state
);
2435 /* The requested latency of the sink input needs to be fixed up and
2436 * then configured on the sink. If this causes the sink latency to
2437 * go down, the sink implementor is responsible for doing a rewind
2438 * in the update_requested_latency() callback to ensure that the
2439 * sink buffer doesn't contain more data than what the new latency
2442 * XXX: Does it really make sense to push this responsibility to
2443 * the sink implementors? Wouldn't it be better to do it once in
2444 * the core than many times in the modules? */
2446 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2447 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2449 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2450 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2452 /* We don't rewind here automatically. This is left to the
2453 * sink input implementor because some sink inputs need a
2454 * slow start, i.e. need some time to buffer client
2455 * samples before beginning streaming.
2457 * XXX: Does it really make sense to push this functionality to
2458 * the sink implementors? Wouldn't it be better to do it once in
2459 * the core than many times in the modules? */
2461 /* In flat volume mode we need to update the volume as
2463 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2466 case PA_SINK_MESSAGE_REMOVE_INPUT
: {
2467 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2469 /* If you change anything here, make sure to change the
2470 * sink input handling a few lines down at
2471 * PA_SINK_MESSAGE_START_MOVE, too. */
2476 pa_sink_input_set_state_within_thread(i
, i
->state
);
2478 pa_assert(i
->thread_info
.attached
);
2479 i
->thread_info
.attached
= FALSE
;
2481 /* Since the caller sleeps in pa_sink_input_unlink(),
2482 * we can safely access data outside of thread_info even
2483 * though it is mutable */
2485 pa_assert(!i
->sync_prev
);
2486 pa_assert(!i
->sync_next
);
2488 if (i
->thread_info
.sync_prev
) {
2489 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
->thread_info
.sync_prev
->sync_next
;
2490 i
->thread_info
.sync_prev
= NULL
;
2493 if (i
->thread_info
.sync_next
) {
2494 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
->thread_info
.sync_next
->sync_prev
;
2495 i
->thread_info
.sync_next
= NULL
;
2498 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
2499 pa_sink_input_unref(i
);
2501 pa_sink_invalidate_requested_latency(s
, TRUE
);
2502 pa_sink_request_rewind(s
, (size_t) -1);
2504 /* In flat volume mode we need to update the volume as
2506 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2509 case PA_SINK_MESSAGE_START_MOVE
: {
2510 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2512 /* We don't support moving synchronized streams. */
2513 pa_assert(!i
->sync_prev
);
2514 pa_assert(!i
->sync_next
);
2515 pa_assert(!i
->thread_info
.sync_next
);
2516 pa_assert(!i
->thread_info
.sync_prev
);
2518 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2520 size_t sink_nbytes
, total_nbytes
;
2522 /* The old sink probably has some audio from this
2523 * stream in its buffer. We want to "take it back" as
2524 * much as possible and play it to the new sink. We
2525 * don't know at this point how much the old sink can
2526 * rewind. We have to pick something, and that
2527 * something is the full latency of the old sink here.
2528 * So we rewind the stream buffer by the sink latency
2529 * amount, which may be more than what we should
2530 * rewind. This can result in a chunk of audio being
2531 * played both to the old sink and the new sink.
2533 * FIXME: Fix this code so that we don't have to make
2534 * guesses about how much the sink will actually be
2535 * able to rewind. If someone comes up with a solution
2536 * for this, something to note is that the part of the
2537 * latency that the old sink couldn't rewind should
2538 * ideally be compensated after the stream has moved
2539 * to the new sink by adding silence. The new sink
2540 * most likely can't start playing the moved stream
2541 * immediately, and that gap should be removed from
2542 * the "compensation silence" (at least at the time of
2543 * writing this, the move finish code will actually
2544 * already take care of dropping the new sink's
2545 * unrewindable latency, so taking into account the
2546 * unrewindable latency of the old sink is the only
2549 * The render_memblockq contents are discarded,
2550 * because when the sink changes, the format of the
2551 * audio stored in the render_memblockq may change
2552 * too, making the stored audio invalid. FIXME:
2553 * However, the read and write indices are moved back
2554 * the same amount, so if they are not the same now,
2555 * they won't be the same after the rewind either. If
2556 * the write index of the render_memblockq is ahead of
2557 * the read index, then the render_memblockq will feed
2558 * the new sink some silence first, which it shouldn't
2559 * do. The write index should be flushed to be the
2560 * same as the read index. */
2562 /* Get the latency of the sink */
2563 usec
= pa_sink_get_latency_within_thread(s
);
2564 sink_nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2565 total_nbytes
= sink_nbytes
+ pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
2567 if (total_nbytes
> 0) {
2568 i
->thread_info
.rewrite_nbytes
= i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, total_nbytes
) : total_nbytes
;
2569 i
->thread_info
.rewrite_flush
= TRUE
;
2570 pa_sink_input_process_rewind(i
, sink_nbytes
);
2577 pa_assert(i
->thread_info
.attached
);
2578 i
->thread_info
.attached
= FALSE
;
2580 /* Let's remove the sink input ...*/
2581 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
2582 pa_sink_input_unref(i
);
2584 pa_sink_invalidate_requested_latency(s
, TRUE
);
2586 pa_log_debug("Requesting rewind due to started move");
2587 pa_sink_request_rewind(s
, (size_t) -1);
2589 /* In flat volume mode we need to update the volume as
2591 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2594 case PA_SINK_MESSAGE_FINISH_MOVE
: {
2595 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2597 /* We don't support moving synchronized streams. */
2598 pa_assert(!i
->sync_prev
);
2599 pa_assert(!i
->sync_next
);
2600 pa_assert(!i
->thread_info
.sync_next
);
2601 pa_assert(!i
->thread_info
.sync_prev
);
2603 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2605 pa_assert(!i
->thread_info
.attached
);
2606 i
->thread_info
.attached
= TRUE
;
2611 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2615 /* In the ideal case the new sink would start playing
2616 * the stream immediately. That requires the sink to
2617 * be able to rewind all of its latency, which usually
2618 * isn't possible, so there will probably be some gap
2619 * before the moved stream becomes audible. We then
2620 * have two possibilities: 1) start playing the stream
2621 * from where it is now, or 2) drop the unrewindable
2622 * latency of the sink from the stream. With option 1
2623 * we won't lose any audio but the stream will have a
2624 * pause. With option 2 we may lose some audio but the
2625 * stream time will be somewhat in sync with the wall
2626 * clock. Lennart seems to have chosen option 2 (one
2627 * of the reasons might have been that option 1 is
2628 * actually much harder to implement), so we drop the
2629 * latency of the new sink from the moved stream and
2630 * hope that the sink will undo most of that in the
2633 /* Get the latency of the sink */
2634 usec
= pa_sink_get_latency_within_thread(s
);
2635 nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2638 pa_sink_input_drop(i
, nbytes
);
2640 pa_log_debug("Requesting rewind due to finished move");
2641 pa_sink_request_rewind(s
, nbytes
);
2644 /* Updating the requested sink latency has to be done
2645 * after the sink rewind request, not before, because
2646 * otherwise the sink may limit the rewind amount
2649 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2650 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2652 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2653 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2655 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2658 case PA_SINK_MESSAGE_SET_SHARED_VOLUME
: {
2659 pa_sink
*root_sink
= pa_sink_get_master(s
);
2661 if (PA_LIKELY(root_sink
))
2662 set_shared_volume_within_thread(root_sink
);
2667 case PA_SINK_MESSAGE_SET_VOLUME_SYNCED
:
2669 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
2671 pa_sink_volume_change_push(s
);
2673 /* Fall through ... */
2675 case PA_SINK_MESSAGE_SET_VOLUME
:
2677 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2678 s
->thread_info
.soft_volume
= s
->soft_volume
;
2679 pa_sink_request_rewind(s
, (size_t) -1);
2682 /* Fall through ... */
2684 case PA_SINK_MESSAGE_SYNC_VOLUMES
:
2685 sync_input_volumes_within_thread(s
);
2688 case PA_SINK_MESSAGE_GET_VOLUME
:
2690 if ((s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
) {
2692 pa_sink_volume_change_flush(s
);
2693 pa_sw_cvolume_divide(&s
->thread_info
.current_hw_volume
, &s
->real_volume
, &s
->soft_volume
);
2696 /* In case sink implementor reset SW volume. */
2697 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2698 s
->thread_info
.soft_volume
= s
->soft_volume
;
2699 pa_sink_request_rewind(s
, (size_t) -1);
2704 case PA_SINK_MESSAGE_SET_MUTE
:
2706 if (s
->thread_info
.soft_muted
!= s
->muted
) {
2707 s
->thread_info
.soft_muted
= s
->muted
;
2708 pa_sink_request_rewind(s
, (size_t) -1);
2711 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->set_mute
)
2716 case PA_SINK_MESSAGE_GET_MUTE
:
2718 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->get_mute
)
2723 case PA_SINK_MESSAGE_SET_STATE
: {
2725 pa_bool_t suspend_change
=
2726 (s
->thread_info
.state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(PA_PTR_TO_UINT(userdata
))) ||
2727 (PA_SINK_IS_OPENED(s
->thread_info
.state
) && PA_PTR_TO_UINT(userdata
) == PA_SINK_SUSPENDED
);
2729 s
->thread_info
.state
= PA_PTR_TO_UINT(userdata
);
2731 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
2732 s
->thread_info
.rewind_nbytes
= 0;
2733 s
->thread_info
.rewind_requested
= FALSE
;
2736 if (suspend_change
) {
2740 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
2741 if (i
->suspend_within_thread
)
2742 i
->suspend_within_thread(i
, s
->thread_info
.state
== PA_SINK_SUSPENDED
);
2748 case PA_SINK_MESSAGE_DETACH
:
2750 /* Detach all streams */
2751 pa_sink_detach_within_thread(s
);
2754 case PA_SINK_MESSAGE_ATTACH
:
2756 /* Reattach all streams */
2757 pa_sink_attach_within_thread(s
);
2760 case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
: {
2762 pa_usec_t
*usec
= userdata
;
2763 *usec
= pa_sink_get_requested_latency_within_thread(s
);
2765 /* Yes, that's right, the IO thread will see -1 when no
2766 * explicit requested latency is configured, the main
2767 * thread will see max_latency */
2768 if (*usec
== (pa_usec_t
) -1)
2769 *usec
= s
->thread_info
.max_latency
;
2774 case PA_SINK_MESSAGE_SET_LATENCY_RANGE
: {
2775 pa_usec_t
*r
= userdata
;
2777 pa_sink_set_latency_range_within_thread(s
, r
[0], r
[1]);
2782 case PA_SINK_MESSAGE_GET_LATENCY_RANGE
: {
2783 pa_usec_t
*r
= userdata
;
2785 r
[0] = s
->thread_info
.min_latency
;
2786 r
[1] = s
->thread_info
.max_latency
;
2791 case PA_SINK_MESSAGE_GET_FIXED_LATENCY
:
2793 *((pa_usec_t
*) userdata
) = s
->thread_info
.fixed_latency
;
2796 case PA_SINK_MESSAGE_SET_FIXED_LATENCY
:
2798 pa_sink_set_fixed_latency_within_thread(s
, (pa_usec_t
) offset
);
2801 case PA_SINK_MESSAGE_GET_MAX_REWIND
:
2803 *((size_t*) userdata
) = s
->thread_info
.max_rewind
;
2806 case PA_SINK_MESSAGE_GET_MAX_REQUEST
:
2808 *((size_t*) userdata
) = s
->thread_info
.max_request
;
2811 case PA_SINK_MESSAGE_SET_MAX_REWIND
:
2813 pa_sink_set_max_rewind_within_thread(s
, (size_t) offset
);
2816 case PA_SINK_MESSAGE_SET_MAX_REQUEST
:
2818 pa_sink_set_max_request_within_thread(s
, (size_t) offset
);
2821 case PA_SINK_MESSAGE_SET_PORT
:
2823 pa_assert(userdata
);
2825 struct sink_message_set_port
*msg_data
= userdata
;
2826 msg_data
->ret
= s
->set_port(s
, msg_data
->port
);
2830 case PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
:
2831 /* This message is sent from IO-thread and handled in main thread. */
2832 pa_assert_ctl_context();
2834 /* Make sure we're not messing with main thread when no longer linked */
2835 if (!PA_SINK_IS_LINKED(s
->state
))
2838 pa_sink_get_volume(s
, TRUE
);
2839 pa_sink_get_mute(s
, TRUE
);
2842 case PA_SINK_MESSAGE_SET_LATENCY_OFFSET
:
2843 s
->thread_info
.latency_offset
= offset
;
2846 case PA_SINK_MESSAGE_GET_LATENCY
:
2847 case PA_SINK_MESSAGE_MAX
:
2854 /* Called from main thread */
2855 int pa_sink_suspend_all(pa_core
*c
, pa_bool_t suspend
, pa_suspend_cause_t cause
) {
2860 pa_core_assert_ref(c
);
2861 pa_assert_ctl_context();
2862 pa_assert(cause
!= 0);
2864 PA_IDXSET_FOREACH(sink
, c
->sinks
, idx
) {
2867 if ((r
= pa_sink_suspend(sink
, suspend
, cause
)) < 0)
2874 /* Called from main thread */
2875 void pa_sink_detach(pa_sink
*s
) {
2876 pa_sink_assert_ref(s
);
2877 pa_assert_ctl_context();
2878 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2880 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_DETACH
, NULL
, 0, NULL
) == 0);
2883 /* Called from main thread */
2884 void pa_sink_attach(pa_sink
*s
) {
2885 pa_sink_assert_ref(s
);
2886 pa_assert_ctl_context();
2887 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2889 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_ATTACH
, NULL
, 0, NULL
) == 0);
2892 /* Called from IO thread */
2893 void pa_sink_detach_within_thread(pa_sink
*s
) {
2897 pa_sink_assert_ref(s
);
2898 pa_sink_assert_io_context(s
);
2899 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2901 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2905 if (s
->monitor_source
)
2906 pa_source_detach_within_thread(s
->monitor_source
);
2909 /* Called from IO thread */
2910 void pa_sink_attach_within_thread(pa_sink
*s
) {
2914 pa_sink_assert_ref(s
);
2915 pa_sink_assert_io_context(s
);
2916 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2918 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2922 if (s
->monitor_source
)
2923 pa_source_attach_within_thread(s
->monitor_source
);
2926 /* Called from IO thread */
2927 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
) {
2928 pa_sink_assert_ref(s
);
2929 pa_sink_assert_io_context(s
);
2930 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2932 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
2935 if (nbytes
== (size_t) -1)
2936 nbytes
= s
->thread_info
.max_rewind
;
2938 nbytes
= PA_MIN(nbytes
, s
->thread_info
.max_rewind
);
2940 if (s
->thread_info
.rewind_requested
&&
2941 nbytes
<= s
->thread_info
.rewind_nbytes
)
2944 s
->thread_info
.rewind_nbytes
= nbytes
;
2945 s
->thread_info
.rewind_requested
= TRUE
;
2947 if (s
->request_rewind
)
2948 s
->request_rewind(s
);
2951 /* Called from IO thread */
2952 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
) {
2953 pa_usec_t result
= (pa_usec_t
) -1;
2956 pa_usec_t monitor_latency
;
2958 pa_sink_assert_ref(s
);
2959 pa_sink_assert_io_context(s
);
2961 if (!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
2962 return PA_CLAMP(s
->thread_info
.fixed_latency
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
2964 if (s
->thread_info
.requested_latency_valid
)
2965 return s
->thread_info
.requested_latency
;
2967 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2968 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1 &&
2969 (result
== (pa_usec_t
) -1 || result
> i
->thread_info
.requested_sink_latency
))
2970 result
= i
->thread_info
.requested_sink_latency
;
2972 monitor_latency
= pa_source_get_requested_latency_within_thread(s
->monitor_source
);
2974 if (monitor_latency
!= (pa_usec_t
) -1 &&
2975 (result
== (pa_usec_t
) -1 || result
> monitor_latency
))
2976 result
= monitor_latency
;
2978 if (result
!= (pa_usec_t
) -1)
2979 result
= PA_CLAMP(result
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
2981 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
2982 /* Only cache if properly initialized */
2983 s
->thread_info
.requested_latency
= result
;
2984 s
->thread_info
.requested_latency_valid
= TRUE
;
2990 /* Called from main thread */
2991 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
) {
2994 pa_sink_assert_ref(s
);
2995 pa_assert_ctl_context();
2996 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2998 if (s
->state
== PA_SINK_SUSPENDED
)
3001 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
3006 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3007 void pa_sink_set_max_rewind_within_thread(pa_sink
*s
, size_t max_rewind
) {
3011 pa_sink_assert_ref(s
);
3012 pa_sink_assert_io_context(s
);
3014 if (max_rewind
== s
->thread_info
.max_rewind
)
3017 s
->thread_info
.max_rewind
= max_rewind
;
3019 if (PA_SINK_IS_LINKED(s
->thread_info
.state
))
3020 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3021 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
3023 if (s
->monitor_source
)
3024 pa_source_set_max_rewind_within_thread(s
->monitor_source
, s
->thread_info
.max_rewind
);
3027 /* Called from main thread */
3028 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
) {
3029 pa_sink_assert_ref(s
);
3030 pa_assert_ctl_context();
3032 if (PA_SINK_IS_LINKED(s
->state
))
3033 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REWIND
, NULL
, max_rewind
, NULL
) == 0);
3035 pa_sink_set_max_rewind_within_thread(s
, max_rewind
);
3038 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3039 void pa_sink_set_max_request_within_thread(pa_sink
*s
, size_t max_request
) {
3042 pa_sink_assert_ref(s
);
3043 pa_sink_assert_io_context(s
);
3045 if (max_request
== s
->thread_info
.max_request
)
3048 s
->thread_info
.max_request
= max_request
;
3050 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3053 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3054 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
3058 /* Called from main thread */
3059 void pa_sink_set_max_request(pa_sink
*s
, size_t max_request
) {
3060 pa_sink_assert_ref(s
);
3061 pa_assert_ctl_context();
3063 if (PA_SINK_IS_LINKED(s
->state
))
3064 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REQUEST
, NULL
, max_request
, NULL
) == 0);
3066 pa_sink_set_max_request_within_thread(s
, max_request
);
3069 /* Called from IO thread */
3070 void pa_sink_invalidate_requested_latency(pa_sink
*s
, pa_bool_t dynamic
) {
3074 pa_sink_assert_ref(s
);
3075 pa_sink_assert_io_context(s
);
3077 if ((s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
3078 s
->thread_info
.requested_latency_valid
= FALSE
;
3082 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3084 if (s
->update_requested_latency
)
3085 s
->update_requested_latency(s
);
3087 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3088 if (i
->update_sink_requested_latency
)
3089 i
->update_sink_requested_latency(i
);
3093 /* Called from main thread */
3094 void pa_sink_set_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3095 pa_sink_assert_ref(s
);
3096 pa_assert_ctl_context();
3098 /* min_latency == 0: no limit
3099 * min_latency anything else: specified limit
3101 * Similar for max_latency */
3103 if (min_latency
< ABSOLUTE_MIN_LATENCY
)
3104 min_latency
= ABSOLUTE_MIN_LATENCY
;
3106 if (max_latency
<= 0 ||
3107 max_latency
> ABSOLUTE_MAX_LATENCY
)
3108 max_latency
= ABSOLUTE_MAX_LATENCY
;
3110 pa_assert(min_latency
<= max_latency
);
3112 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3113 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3114 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3115 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3117 if (PA_SINK_IS_LINKED(s
->state
)) {
3123 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3125 pa_sink_set_latency_range_within_thread(s
, min_latency
, max_latency
);
3128 /* Called from main thread */
3129 void pa_sink_get_latency_range(pa_sink
*s
, pa_usec_t
*min_latency
, pa_usec_t
*max_latency
) {
3130 pa_sink_assert_ref(s
);
3131 pa_assert_ctl_context();
3132 pa_assert(min_latency
);
3133 pa_assert(max_latency
);
3135 if (PA_SINK_IS_LINKED(s
->state
)) {
3136 pa_usec_t r
[2] = { 0, 0 };
3138 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3140 *min_latency
= r
[0];
3141 *max_latency
= r
[1];
3143 *min_latency
= s
->thread_info
.min_latency
;
3144 *max_latency
= s
->thread_info
.max_latency
;
3148 /* Called from IO thread */
3149 void pa_sink_set_latency_range_within_thread(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3150 pa_sink_assert_ref(s
);
3151 pa_sink_assert_io_context(s
);
3153 pa_assert(min_latency
>= ABSOLUTE_MIN_LATENCY
);
3154 pa_assert(max_latency
<= ABSOLUTE_MAX_LATENCY
);
3155 pa_assert(min_latency
<= max_latency
);
3157 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3158 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3159 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3160 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3162 if (s
->thread_info
.min_latency
== min_latency
&&
3163 s
->thread_info
.max_latency
== max_latency
)
3166 s
->thread_info
.min_latency
= min_latency
;
3167 s
->thread_info
.max_latency
= max_latency
;
3169 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3173 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3174 if (i
->update_sink_latency_range
)
3175 i
->update_sink_latency_range(i
);
3178 pa_sink_invalidate_requested_latency(s
, FALSE
);
3180 pa_source_set_latency_range_within_thread(s
->monitor_source
, min_latency
, max_latency
);
3183 /* Called from main thread */
3184 void pa_sink_set_fixed_latency(pa_sink
*s
, pa_usec_t latency
) {
3185 pa_sink_assert_ref(s
);
3186 pa_assert_ctl_context();
3188 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3189 pa_assert(latency
== 0);
3193 if (latency
< ABSOLUTE_MIN_LATENCY
)
3194 latency
= ABSOLUTE_MIN_LATENCY
;
3196 if (latency
> ABSOLUTE_MAX_LATENCY
)
3197 latency
= ABSOLUTE_MAX_LATENCY
;
3199 if (PA_SINK_IS_LINKED(s
->state
))
3200 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_FIXED_LATENCY
, NULL
, (int64_t) latency
, NULL
) == 0);
3202 s
->thread_info
.fixed_latency
= latency
;
3204 pa_source_set_fixed_latency(s
->monitor_source
, latency
);
3207 /* Called from main thread */
3208 pa_usec_t
pa_sink_get_fixed_latency(pa_sink
*s
) {
3211 pa_sink_assert_ref(s
);
3212 pa_assert_ctl_context();
3214 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
)
3217 if (PA_SINK_IS_LINKED(s
->state
))
3218 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_FIXED_LATENCY
, &latency
, 0, NULL
) == 0);
3220 latency
= s
->thread_info
.fixed_latency
;
3225 /* Called from IO thread */
3226 void pa_sink_set_fixed_latency_within_thread(pa_sink
*s
, pa_usec_t latency
) {
3227 pa_sink_assert_ref(s
);
3228 pa_sink_assert_io_context(s
);
3230 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3231 pa_assert(latency
== 0);
3235 pa_assert(latency
>= ABSOLUTE_MIN_LATENCY
);
3236 pa_assert(latency
<= ABSOLUTE_MAX_LATENCY
);
3238 if (s
->thread_info
.fixed_latency
== latency
)
3241 s
->thread_info
.fixed_latency
= latency
;
3243 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3247 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3248 if (i
->update_sink_fixed_latency
)
3249 i
->update_sink_fixed_latency(i
);
3252 pa_sink_invalidate_requested_latency(s
, FALSE
);
3254 pa_source_set_fixed_latency_within_thread(s
->monitor_source
, latency
);
3257 /* Called from main context */
3258 void pa_sink_set_latency_offset(pa_sink
*s
, int64_t offset
) {
3259 pa_sink_assert_ref(s
);
3261 s
->latency_offset
= offset
;
3263 if (PA_SINK_IS_LINKED(s
->state
))
3264 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_LATENCY_OFFSET
, NULL
, offset
, NULL
) == 0);
3266 s
->thread_info
.latency_offset
= offset
;
3269 /* Called from main context */
3270 size_t pa_sink_get_max_rewind(pa_sink
*s
) {
3272 pa_assert_ctl_context();
3273 pa_sink_assert_ref(s
);
3275 if (!PA_SINK_IS_LINKED(s
->state
))
3276 return s
->thread_info
.max_rewind
;
3278 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REWIND
, &r
, 0, NULL
) == 0);
3283 /* Called from main context */
3284 size_t pa_sink_get_max_request(pa_sink
*s
) {
3286 pa_sink_assert_ref(s
);
3287 pa_assert_ctl_context();
3289 if (!PA_SINK_IS_LINKED(s
->state
))
3290 return s
->thread_info
.max_request
;
3292 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REQUEST
, &r
, 0, NULL
) == 0);
3297 /* Called from main context */
3298 int pa_sink_set_port(pa_sink
*s
, const char *name
, pa_bool_t save
) {
3299 pa_device_port
*port
;
3302 pa_sink_assert_ref(s
);
3303 pa_assert_ctl_context();
3306 pa_log_debug("set_port() operation not implemented for sink %u \"%s\"", s
->index
, s
->name
);
3307 return -PA_ERR_NOTIMPLEMENTED
;
3311 return -PA_ERR_NOENTITY
;
3313 if (!(port
= pa_hashmap_get(s
->ports
, name
)))
3314 return -PA_ERR_NOENTITY
;
3316 if (s
->active_port
== port
) {
3317 s
->save_port
= s
->save_port
|| save
;
3321 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
3322 struct sink_message_set_port msg
= { .port
= port
, .ret
= 0 };
3323 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_PORT
, &msg
, 0, NULL
) == 0);
3327 ret
= s
->set_port(s
, port
);
3330 return -PA_ERR_NOENTITY
;
3332 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
3334 pa_log_info("Changed port of sink %u \"%s\" to %s", s
->index
, s
->name
, port
->name
);
3336 s
->active_port
= port
;
3337 s
->save_port
= save
;
3339 pa_sink_set_latency_offset(s
, s
->active_port
->latency_offset
);
3341 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PORT_CHANGED
], s
);
3346 pa_bool_t
pa_device_init_icon(pa_proplist
*p
, pa_bool_t is_sink
) {
3347 const char *ff
, *c
, *t
= NULL
, *s
= "", *profile
, *bus
;
3351 if (pa_proplist_contains(p
, PA_PROP_DEVICE_ICON_NAME
))
3354 if ((ff
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3356 if (pa_streq(ff
, "microphone"))
3357 t
= "audio-input-microphone";
3358 else if (pa_streq(ff
, "webcam"))
3360 else if (pa_streq(ff
, "computer"))
3362 else if (pa_streq(ff
, "handset"))
3364 else if (pa_streq(ff
, "portable"))
3365 t
= "multimedia-player";
3366 else if (pa_streq(ff
, "tv"))
3367 t
= "video-display";
3370 * The following icons are not part of the icon naming spec,
3371 * because Rodney Dawes sucks as the maintainer of that spec.
3373 * http://lists.freedesktop.org/archives/xdg/2009-May/010397.html
3375 else if (pa_streq(ff
, "headset"))
3376 t
= "audio-headset";
3377 else if (pa_streq(ff
, "headphone"))
3378 t
= "audio-headphones";
3379 else if (pa_streq(ff
, "speaker"))
3380 t
= "audio-speakers";
3381 else if (pa_streq(ff
, "hands-free"))
3382 t
= "audio-handsfree";
3386 if ((c
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3387 if (pa_streq(c
, "modem"))
3394 t
= "audio-input-microphone";
3397 if ((profile
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3398 if (strstr(profile
, "analog"))
3400 else if (strstr(profile
, "iec958"))
3402 else if (strstr(profile
, "hdmi"))
3406 bus
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
);
3408 pa_proplist_setf(p
, PA_PROP_DEVICE_ICON_NAME
, "%s%s%s%s", t
, pa_strempty(s
), bus
? "-" : "", pa_strempty(bus
));
3413 pa_bool_t
pa_device_init_description(pa_proplist
*p
) {
3414 const char *s
, *d
= NULL
, *k
;
3417 if (pa_proplist_contains(p
, PA_PROP_DEVICE_DESCRIPTION
))
3420 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3421 if (pa_streq(s
, "internal"))
3422 d
= _("Built-in Audio");
3425 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3426 if (pa_streq(s
, "modem"))
3430 d
= pa_proplist_gets(p
, PA_PROP_DEVICE_PRODUCT_NAME
);
3435 k
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_DESCRIPTION
);
3438 pa_proplist_setf(p
, PA_PROP_DEVICE_DESCRIPTION
, "%s %s", d
, k
);
3440 pa_proplist_sets(p
, PA_PROP_DEVICE_DESCRIPTION
, d
);
3445 pa_bool_t
pa_device_init_intended_roles(pa_proplist
*p
) {
3449 if (pa_proplist_contains(p
, PA_PROP_DEVICE_INTENDED_ROLES
))
3452 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3453 if (pa_streq(s
, "handset") || pa_streq(s
, "hands-free")
3454 || pa_streq(s
, "headset")) {
3455 pa_proplist_sets(p
, PA_PROP_DEVICE_INTENDED_ROLES
, "phone");
3462 unsigned pa_device_init_priority(pa_proplist
*p
) {
3464 unsigned priority
= 0;
3468 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
))) {
3470 if (pa_streq(s
, "sound"))
3472 else if (!pa_streq(s
, "modem"))
3476 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3478 if (pa_streq(s
, "internal"))
3480 else if (pa_streq(s
, "speaker"))
3482 else if (pa_streq(s
, "headphone"))
3486 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
))) {
3488 if (pa_streq(s
, "pci"))
3490 else if (pa_streq(s
, "usb"))
3492 else if (pa_streq(s
, "bluetooth"))
3496 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3498 if (pa_startswith(s
, "analog-"))
3500 else if (pa_startswith(s
, "iec958-"))
3507 PA_STATIC_FLIST_DECLARE(pa_sink_volume_change
, 0, pa_xfree
);
3509 /* Called from the IO thread. */
3510 static pa_sink_volume_change
*pa_sink_volume_change_new(pa_sink
*s
) {
3511 pa_sink_volume_change
*c
;
3512 if (!(c
= pa_flist_pop(PA_STATIC_FLIST_GET(pa_sink_volume_change
))))
3513 c
= pa_xnew(pa_sink_volume_change
, 1);
3515 PA_LLIST_INIT(pa_sink_volume_change
, c
);
3517 pa_cvolume_reset(&c
->hw_volume
, s
->sample_spec
.channels
);
3521 /* Called from the IO thread. */
3522 static void pa_sink_volume_change_free(pa_sink_volume_change
*c
) {
3524 if (pa_flist_push(PA_STATIC_FLIST_GET(pa_sink_volume_change
), c
) < 0)
3528 /* Called from the IO thread. */
3529 void pa_sink_volume_change_push(pa_sink
*s
) {
3530 pa_sink_volume_change
*c
= NULL
;
3531 pa_sink_volume_change
*nc
= NULL
;
3532 uint32_t safety_margin
= s
->thread_info
.volume_change_safety_margin
;
3534 const char *direction
= NULL
;
3537 nc
= pa_sink_volume_change_new(s
);
3539 /* NOTE: There is already more different volumes in pa_sink that I can remember.
3540 * Adding one more volume for HW would get us rid of this, but I am trying
3541 * to survive with the ones we already have. */
3542 pa_sw_cvolume_divide(&nc
->hw_volume
, &s
->real_volume
, &s
->soft_volume
);
3544 if (!s
->thread_info
.volume_changes
&& pa_cvolume_equal(&nc
->hw_volume
, &s
->thread_info
.current_hw_volume
)) {
3545 pa_log_debug("Volume not changing");
3546 pa_sink_volume_change_free(nc
);
3550 nc
->at
= pa_sink_get_latency_within_thread(s
);
3551 nc
->at
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3553 if (s
->thread_info
.volume_changes_tail
) {
3554 for (c
= s
->thread_info
.volume_changes_tail
; c
; c
= c
->prev
) {
3555 /* If volume is going up let's do it a bit late. If it is going
3556 * down let's do it a bit early. */
3557 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&c
->hw_volume
)) {
3558 if (nc
->at
+ safety_margin
> c
->at
) {
3559 nc
->at
+= safety_margin
;
3564 else if (nc
->at
- safety_margin
> c
->at
) {
3565 nc
->at
-= safety_margin
;
3573 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&s
->thread_info
.current_hw_volume
)) {
3574 nc
->at
+= safety_margin
;
3577 nc
->at
-= safety_margin
;
3580 PA_LLIST_PREPEND(pa_sink_volume_change
, s
->thread_info
.volume_changes
, nc
);
3583 PA_LLIST_INSERT_AFTER(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
, nc
);
3586 pa_log_debug("Volume going %s to %d at %llu", direction
, pa_cvolume_avg(&nc
->hw_volume
), (long long unsigned) nc
->at
);
3588 /* We can ignore volume events that came earlier but should happen later than this. */
3589 PA_LLIST_FOREACH(c
, nc
->next
) {
3590 pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
);
3591 pa_sink_volume_change_free(c
);
3594 s
->thread_info
.volume_changes_tail
= nc
;
3597 /* Called from the IO thread. */
3598 static void pa_sink_volume_change_flush(pa_sink
*s
) {
3599 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3601 s
->thread_info
.volume_changes
= NULL
;
3602 s
->thread_info
.volume_changes_tail
= NULL
;
3604 pa_sink_volume_change
*next
= c
->next
;
3605 pa_sink_volume_change_free(c
);
3610 /* Called from the IO thread. */
3611 pa_bool_t
pa_sink_volume_change_apply(pa_sink
*s
, pa_usec_t
*usec_to_next
) {
3613 pa_bool_t ret
= FALSE
;
3617 if (!s
->thread_info
.volume_changes
|| !PA_SINK_IS_LINKED(s
->state
)) {
3623 pa_assert(s
->write_volume
);
3625 now
= pa_rtclock_now();
3627 while (s
->thread_info
.volume_changes
&& now
>= s
->thread_info
.volume_changes
->at
) {
3628 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3629 PA_LLIST_REMOVE(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
);
3630 pa_log_debug("Volume change to %d at %llu was written %llu usec late",
3631 pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
, (long long unsigned) (now
- c
->at
));
3633 s
->thread_info
.current_hw_volume
= c
->hw_volume
;
3634 pa_sink_volume_change_free(c
);
3640 if (s
->thread_info
.volume_changes
) {
3642 *usec_to_next
= s
->thread_info
.volume_changes
->at
- now
;
3643 if (pa_log_ratelimit(PA_LOG_DEBUG
))
3644 pa_log_debug("Next volume change in %lld usec", (long long) (s
->thread_info
.volume_changes
->at
- now
));
3649 s
->thread_info
.volume_changes_tail
= NULL
;
3654 /* Called from the IO thread. */
3655 static void pa_sink_volume_change_rewind(pa_sink
*s
, size_t nbytes
) {
3656 /* All the queued volume events later than current latency are shifted to happen earlier. */
3657 pa_sink_volume_change
*c
;
3658 pa_volume_t prev_vol
= pa_cvolume_avg(&s
->thread_info
.current_hw_volume
);
3659 pa_usec_t rewound
= pa_bytes_to_usec(nbytes
, &s
->sample_spec
);
3660 pa_usec_t limit
= pa_sink_get_latency_within_thread(s
);
3662 pa_log_debug("latency = %lld", (long long) limit
);
3663 limit
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3665 PA_LLIST_FOREACH(c
, s
->thread_info
.volume_changes
) {
3666 pa_usec_t modified_limit
= limit
;
3667 if (prev_vol
> pa_cvolume_avg(&c
->hw_volume
))
3668 modified_limit
-= s
->thread_info
.volume_change_safety_margin
;
3670 modified_limit
+= s
->thread_info
.volume_change_safety_margin
;
3671 if (c
->at
> modified_limit
) {
3673 if (c
->at
< modified_limit
)
3674 c
->at
= modified_limit
;
3676 prev_vol
= pa_cvolume_avg(&c
->hw_volume
);
3678 pa_sink_volume_change_apply(s
, NULL
);
3681 /* Called from the main thread */
3682 /* Gets the list of formats supported by the sink. The members and idxset must
3683 * be freed by the caller. */
3684 pa_idxset
* pa_sink_get_formats(pa_sink
*s
) {
3689 if (s
->get_formats
) {
3690 /* Sink supports format query, all is good */
3691 ret
= s
->get_formats(s
);
3693 /* Sink doesn't support format query, so assume it does PCM */
3694 pa_format_info
*f
= pa_format_info_new();
3695 f
->encoding
= PA_ENCODING_PCM
;
3697 ret
= pa_idxset_new(NULL
, NULL
);
3698 pa_idxset_put(ret
, f
, NULL
);
3704 /* Called from the main thread */
3705 /* Allows an external source to set what formats a sink supports if the sink
3706 * permits this. The function makes a copy of the formats on success. */
3707 pa_bool_t
pa_sink_set_formats(pa_sink
*s
, pa_idxset
*formats
) {
3712 /* Sink supports setting formats -- let's give it a shot */
3713 return s
->set_formats(s
, formats
);
3715 /* Sink doesn't support setting this -- bail out */
3719 /* Called from the main thread */
3720 /* Checks if the sink can accept this format */
3721 pa_bool_t
pa_sink_check_format(pa_sink
*s
, pa_format_info
*f
)
3723 pa_idxset
*formats
= NULL
;
3724 pa_bool_t ret
= FALSE
;
3729 formats
= pa_sink_get_formats(s
);
3732 pa_format_info
*finfo_device
;
3735 PA_IDXSET_FOREACH(finfo_device
, formats
, i
) {
3736 if (pa_format_info_is_compatible(finfo_device
, f
)) {
3742 pa_idxset_free(formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);
3748 /* Called from the main thread */
3749 /* Calculates the intersection between formats supported by the sink and
3750 * in_formats, and returns these, in the order of the sink's formats. */
3751 pa_idxset
* pa_sink_check_formats(pa_sink
*s
, pa_idxset
*in_formats
) {
3752 pa_idxset
*out_formats
= pa_idxset_new(NULL
, NULL
), *sink_formats
= NULL
;
3753 pa_format_info
*f_sink
, *f_in
;
3758 if (!in_formats
|| pa_idxset_isempty(in_formats
))
3761 sink_formats
= pa_sink_get_formats(s
);
3763 PA_IDXSET_FOREACH(f_sink
, sink_formats
, i
) {
3764 PA_IDXSET_FOREACH(f_in
, in_formats
, j
) {
3765 if (pa_format_info_is_compatible(f_sink
, f_in
))
3766 pa_idxset_put(out_formats
, pa_format_info_copy(f_in
), NULL
);
3772 pa_idxset_free(sink_formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);