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();
88 void pa_sink_new_data_set_name(pa_sink_new_data
*data
, const char *name
) {
92 data
->name
= pa_xstrdup(name
);
95 void pa_sink_new_data_set_sample_spec(pa_sink_new_data
*data
, const pa_sample_spec
*spec
) {
98 if ((data
->sample_spec_is_set
= !!spec
))
99 data
->sample_spec
= *spec
;
102 void pa_sink_new_data_set_channel_map(pa_sink_new_data
*data
, const pa_channel_map
*map
) {
105 if ((data
->channel_map_is_set
= !!map
))
106 data
->channel_map
= *map
;
109 void pa_sink_new_data_set_alternate_sample_rate(pa_sink_new_data
*data
, const uint32_t alternate_sample_rate
) {
112 data
->alternate_sample_rate_is_set
= TRUE
;
113 data
->alternate_sample_rate
= alternate_sample_rate
;
116 void pa_sink_new_data_set_volume(pa_sink_new_data
*data
, const pa_cvolume
*volume
) {
119 if ((data
->volume_is_set
= !!volume
))
120 data
->volume
= *volume
;
123 void pa_sink_new_data_set_muted(pa_sink_new_data
*data
, pa_bool_t mute
) {
126 data
->muted_is_set
= TRUE
;
127 data
->muted
= !!mute
;
130 void pa_sink_new_data_set_port(pa_sink_new_data
*data
, const char *port
) {
133 pa_xfree(data
->active_port
);
134 data
->active_port
= pa_xstrdup(port
);
137 void pa_sink_new_data_done(pa_sink_new_data
*data
) {
140 pa_proplist_free(data
->proplist
);
143 pa_device_port_hashmap_free(data
->ports
);
145 pa_xfree(data
->name
);
146 pa_xfree(data
->active_port
);
150 /* Called from main context */
151 static void reset_callbacks(pa_sink
*s
) {
155 s
->get_volume
= NULL
;
156 s
->set_volume
= NULL
;
157 s
->write_volume
= NULL
;
160 s
->request_rewind
= NULL
;
161 s
->update_requested_latency
= NULL
;
163 s
->get_formats
= NULL
;
164 s
->set_formats
= NULL
;
165 s
->update_rate
= NULL
;
168 /* Called from main context */
169 pa_sink
* pa_sink_new(
171 pa_sink_new_data
*data
,
172 pa_sink_flags_t flags
) {
176 char st
[PA_SAMPLE_SPEC_SNPRINT_MAX
], cm
[PA_CHANNEL_MAP_SNPRINT_MAX
];
177 pa_source_new_data source_data
;
183 pa_assert(data
->name
);
184 pa_assert_ctl_context();
186 s
= pa_msgobject_new(pa_sink
);
188 if (!(name
= pa_namereg_register(core
, data
->name
, PA_NAMEREG_SINK
, s
, data
->namereg_fail
))) {
189 pa_log_debug("Failed to register name %s.", data
->name
);
194 pa_sink_new_data_set_name(data
, name
);
196 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_NEW
], data
) < 0) {
198 pa_namereg_unregister(core
, name
);
202 /* FIXME, need to free s here on failure */
204 pa_return_null_if_fail(!data
->driver
|| pa_utf8_valid(data
->driver
));
205 pa_return_null_if_fail(data
->name
&& pa_utf8_valid(data
->name
) && data
->name
[0]);
207 pa_return_null_if_fail(data
->sample_spec_is_set
&& pa_sample_spec_valid(&data
->sample_spec
));
209 if (!data
->channel_map_is_set
)
210 pa_return_null_if_fail(pa_channel_map_init_auto(&data
->channel_map
, data
->sample_spec
.channels
, PA_CHANNEL_MAP_DEFAULT
));
212 pa_return_null_if_fail(pa_channel_map_valid(&data
->channel_map
));
213 pa_return_null_if_fail(data
->channel_map
.channels
== data
->sample_spec
.channels
);
215 /* FIXME: There should probably be a general function for checking whether
216 * the sink volume is allowed to be set, like there is for sink inputs. */
217 pa_assert(!data
->volume_is_set
|| !(flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
219 if (!data
->volume_is_set
) {
220 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
221 data
->save_volume
= FALSE
;
224 pa_return_null_if_fail(pa_cvolume_valid(&data
->volume
));
225 pa_return_null_if_fail(pa_cvolume_compatible(&data
->volume
, &data
->sample_spec
));
227 if (!data
->muted_is_set
)
231 pa_proplist_update(data
->proplist
, PA_UPDATE_MERGE
, data
->card
->proplist
);
233 pa_device_init_description(data
->proplist
);
234 pa_device_init_icon(data
->proplist
, TRUE
);
235 pa_device_init_intended_roles(data
->proplist
);
237 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_FIXATE
], data
) < 0) {
239 pa_namereg_unregister(core
, name
);
243 s
->parent
.parent
.free
= sink_free
;
244 s
->parent
.process_msg
= pa_sink_process_msg
;
247 s
->state
= PA_SINK_INIT
;
250 s
->suspend_cause
= 0;
251 pa_sink_set_mixer_dirty(s
, FALSE
);
252 s
->name
= pa_xstrdup(name
);
253 s
->proplist
= pa_proplist_copy(data
->proplist
);
254 s
->driver
= pa_xstrdup(pa_path_get_filename(data
->driver
));
255 s
->module
= data
->module
;
256 s
->card
= data
->card
;
258 s
->priority
= pa_device_init_priority(s
->proplist
);
260 s
->sample_spec
= data
->sample_spec
;
261 s
->channel_map
= data
->channel_map
;
262 s
->default_sample_rate
= s
->sample_spec
.rate
;
264 if (data
->alternate_sample_rate_is_set
)
265 s
->alternate_sample_rate
= data
->alternate_sample_rate
;
267 s
->alternate_sample_rate
= s
->core
->alternate_sample_rate
;
269 if (s
->sample_spec
.rate
== s
->alternate_sample_rate
) {
270 pa_log_warn("Default and alternate sample rates are the same.");
271 s
->alternate_sample_rate
= 0;
274 s
->inputs
= pa_idxset_new(NULL
, NULL
);
276 s
->input_to_master
= NULL
;
278 s
->reference_volume
= s
->real_volume
= data
->volume
;
279 pa_cvolume_reset(&s
->soft_volume
, s
->sample_spec
.channels
);
280 s
->base_volume
= PA_VOLUME_NORM
;
281 s
->n_volume_steps
= PA_VOLUME_NORM
+1;
282 s
->muted
= data
->muted
;
283 s
->refresh_volume
= s
->refresh_muted
= FALSE
;
290 /* As a minor optimization we just steal the list instead of
292 s
->ports
= data
->ports
;
295 s
->active_port
= NULL
;
296 s
->save_port
= FALSE
;
298 if (data
->active_port
&& s
->ports
)
299 if ((s
->active_port
= pa_hashmap_get(s
->ports
, data
->active_port
)))
300 s
->save_port
= data
->save_port
;
302 if (!s
->active_port
&& s
->ports
) {
306 PA_HASHMAP_FOREACH(p
, s
->ports
, state
)
307 if (!s
->active_port
|| p
->priority
> s
->active_port
->priority
)
312 s
->latency_offset
= s
->active_port
->latency_offset
;
314 s
->latency_offset
= 0;
316 s
->save_volume
= data
->save_volume
;
317 s
->save_muted
= data
->save_muted
;
319 pa_silence_memchunk_get(
320 &core
->silence_cache
,
326 s
->thread_info
.rtpoll
= NULL
;
327 s
->thread_info
.inputs
= pa_hashmap_new(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
);
328 s
->thread_info
.soft_volume
= s
->soft_volume
;
329 s
->thread_info
.soft_muted
= s
->muted
;
330 s
->thread_info
.state
= s
->state
;
331 s
->thread_info
.rewind_nbytes
= 0;
332 s
->thread_info
.rewind_requested
= FALSE
;
333 s
->thread_info
.max_rewind
= 0;
334 s
->thread_info
.max_request
= 0;
335 s
->thread_info
.requested_latency_valid
= FALSE
;
336 s
->thread_info
.requested_latency
= 0;
337 s
->thread_info
.min_latency
= ABSOLUTE_MIN_LATENCY
;
338 s
->thread_info
.max_latency
= ABSOLUTE_MAX_LATENCY
;
339 s
->thread_info
.fixed_latency
= flags
& PA_SINK_DYNAMIC_LATENCY
? 0 : DEFAULT_FIXED_LATENCY
;
341 PA_LLIST_HEAD_INIT(pa_sink_volume_change
, s
->thread_info
.volume_changes
);
342 s
->thread_info
.volume_changes_tail
= NULL
;
343 pa_sw_cvolume_multiply(&s
->thread_info
.current_hw_volume
, &s
->soft_volume
, &s
->real_volume
);
344 s
->thread_info
.volume_change_safety_margin
= core
->deferred_volume_safety_margin_usec
;
345 s
->thread_info
.volume_change_extra_delay
= core
->deferred_volume_extra_delay_usec
;
346 s
->thread_info
.latency_offset
= s
->latency_offset
;
348 /* FIXME: This should probably be moved to pa_sink_put() */
349 pa_assert_se(pa_idxset_put(core
->sinks
, s
, &s
->index
) >= 0);
352 pa_assert_se(pa_idxset_put(s
->card
->sinks
, s
, NULL
) >= 0);
354 pt
= pa_proplist_to_string_sep(s
->proplist
, "\n ");
355 pa_log_info("Created sink %u \"%s\" with sample spec %s and channel map %s\n %s",
358 pa_sample_spec_snprint(st
, sizeof(st
), &s
->sample_spec
),
359 pa_channel_map_snprint(cm
, sizeof(cm
), &s
->channel_map
),
363 pa_source_new_data_init(&source_data
);
364 pa_source_new_data_set_sample_spec(&source_data
, &s
->sample_spec
);
365 pa_source_new_data_set_channel_map(&source_data
, &s
->channel_map
);
366 pa_source_new_data_set_alternate_sample_rate(&source_data
, s
->alternate_sample_rate
);
367 source_data
.name
= pa_sprintf_malloc("%s.monitor", name
);
368 source_data
.driver
= data
->driver
;
369 source_data
.module
= data
->module
;
370 source_data
.card
= data
->card
;
372 dn
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
373 pa_proplist_setf(source_data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Monitor of %s", dn
? dn
: s
->name
);
374 pa_proplist_sets(source_data
.proplist
, PA_PROP_DEVICE_CLASS
, "monitor");
376 s
->monitor_source
= pa_source_new(core
, &source_data
,
377 ((flags
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
378 ((flags
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0));
380 pa_source_new_data_done(&source_data
);
382 if (!s
->monitor_source
) {
388 s
->monitor_source
->monitor_of
= s
;
390 pa_source_set_latency_range(s
->monitor_source
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
391 pa_source_set_fixed_latency(s
->monitor_source
, s
->thread_info
.fixed_latency
);
392 pa_source_set_max_rewind(s
->monitor_source
, s
->thread_info
.max_rewind
);
397 /* Called from main context */
398 static int sink_set_state(pa_sink
*s
, pa_sink_state_t state
) {
400 pa_bool_t suspend_change
;
401 pa_sink_state_t original_state
;
404 pa_assert_ctl_context();
406 if (s
->state
== state
)
409 original_state
= s
->state
;
412 (original_state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(state
)) ||
413 (PA_SINK_IS_OPENED(original_state
) && state
== PA_SINK_SUSPENDED
);
416 if ((ret
= s
->set_state(s
, state
)) < 0)
420 if ((ret
= pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_STATE
, PA_UINT_TO_PTR(state
), 0, NULL
)) < 0) {
423 s
->set_state(s
, original_state
);
430 if (state
!= PA_SINK_UNLINKED
) { /* if we enter UNLINKED state pa_sink_unlink() will fire the appropriate events */
431 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_STATE_CHANGED
], s
);
432 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
435 if (suspend_change
) {
439 /* We're suspending or resuming, tell everyone about it */
441 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
)
442 if (s
->state
== PA_SINK_SUSPENDED
&&
443 (i
->flags
& PA_SINK_INPUT_KILL_ON_SUSPEND
))
444 pa_sink_input_kill(i
);
446 i
->suspend(i
, state
== PA_SINK_SUSPENDED
);
448 if (s
->monitor_source
)
449 pa_source_sync_suspend(s
->monitor_source
);
455 void pa_sink_set_get_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
461 void pa_sink_set_set_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
462 pa_sink_flags_t flags
;
465 pa_assert(!s
->write_volume
|| cb
);
469 /* Save the current flags so we can tell if they've changed */
473 /* The sink implementor is responsible for setting decibel volume support */
474 s
->flags
|= PA_SINK_HW_VOLUME_CTRL
;
476 s
->flags
&= ~PA_SINK_HW_VOLUME_CTRL
;
477 /* See note below in pa_sink_put() about volume sharing and decibel volumes */
478 pa_sink_enable_decibel_volume(s
, !(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
481 /* If the flags have changed after init, let any clients know via a change event */
482 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
483 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
486 void pa_sink_set_write_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
487 pa_sink_flags_t flags
;
490 pa_assert(!cb
|| s
->set_volume
);
492 s
->write_volume
= cb
;
494 /* Save the current flags so we can tell if they've changed */
498 s
->flags
|= PA_SINK_DEFERRED_VOLUME
;
500 s
->flags
&= ~PA_SINK_DEFERRED_VOLUME
;
502 /* If the flags have changed after init, let any clients know via a change event */
503 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
504 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
507 void pa_sink_set_get_mute_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
513 void pa_sink_set_set_mute_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
514 pa_sink_flags_t flags
;
520 /* Save the current flags so we can tell if they've changed */
524 s
->flags
|= PA_SINK_HW_MUTE_CTRL
;
526 s
->flags
&= ~PA_SINK_HW_MUTE_CTRL
;
528 /* If the flags have changed after init, let any clients know via a change event */
529 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
530 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
533 static void enable_flat_volume(pa_sink
*s
, pa_bool_t enable
) {
534 pa_sink_flags_t flags
;
538 /* Always follow the overall user preference here */
539 enable
= enable
&& s
->core
->flat_volumes
;
541 /* Save the current flags so we can tell if they've changed */
545 s
->flags
|= PA_SINK_FLAT_VOLUME
;
547 s
->flags
&= ~PA_SINK_FLAT_VOLUME
;
549 /* If the flags have changed after init, let any clients know via a change event */
550 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
551 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
554 void pa_sink_enable_decibel_volume(pa_sink
*s
, pa_bool_t enable
) {
555 pa_sink_flags_t flags
;
559 /* Save the current flags so we can tell if they've changed */
563 s
->flags
|= PA_SINK_DECIBEL_VOLUME
;
564 enable_flat_volume(s
, TRUE
);
566 s
->flags
&= ~PA_SINK_DECIBEL_VOLUME
;
567 enable_flat_volume(s
, FALSE
);
570 /* If the flags have changed after init, let any clients know via a change event */
571 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
572 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
575 /* Called from main context */
576 void pa_sink_put(pa_sink
* s
) {
577 pa_sink_assert_ref(s
);
578 pa_assert_ctl_context();
580 pa_assert(s
->state
== PA_SINK_INIT
);
581 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) || s
->input_to_master
);
583 /* The following fields must be initialized properly when calling _put() */
584 pa_assert(s
->asyncmsgq
);
585 pa_assert(s
->thread_info
.min_latency
<= s
->thread_info
.max_latency
);
587 /* Generally, flags should be initialized via pa_sink_new(). As a
588 * special exception we allow some volume related flags to be set
589 * between _new() and _put() by the callback setter functions above.
591 * Thus we implement a couple safeguards here which ensure the above
592 * setters were used (or at least the implementor made manual changes
593 * in a compatible way).
595 * Note: All of these flags set here can change over the life time
597 pa_assert(!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
) || s
->set_volume
);
598 pa_assert(!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) || s
->write_volume
);
599 pa_assert(!(s
->flags
& PA_SINK_HW_MUTE_CTRL
) || s
->set_mute
);
601 /* XXX: Currently decibel volume is disabled for all sinks that use volume
602 * sharing. When the master sink supports decibel volume, it would be good
603 * to have the flag also in the filter sink, but currently we don't do that
604 * so that the flags of the filter sink never change when it's moved from
605 * a master sink to another. One solution for this problem would be to
606 * remove user-visible volume altogether from filter sinks when volume
607 * sharing is used, but the current approach was easier to implement... */
608 /* We always support decibel volumes in software, otherwise we leave it to
609 * the sink implementor to set this flag as needed.
611 * Note: This flag can also change over the life time of the sink. */
612 if (!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
) && !(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
613 pa_sink_enable_decibel_volume(s
, TRUE
);
615 /* If the sink implementor support DB volumes by itself, we should always
616 * try and enable flat volumes too */
617 if ((s
->flags
& PA_SINK_DECIBEL_VOLUME
))
618 enable_flat_volume(s
, TRUE
);
620 if (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) {
621 pa_sink
*root_sink
= pa_sink_get_master(s
);
623 pa_assert(root_sink
);
625 s
->reference_volume
= root_sink
->reference_volume
;
626 pa_cvolume_remap(&s
->reference_volume
, &root_sink
->channel_map
, &s
->channel_map
);
628 s
->real_volume
= root_sink
->real_volume
;
629 pa_cvolume_remap(&s
->real_volume
, &root_sink
->channel_map
, &s
->channel_map
);
631 /* We assume that if the sink implementor changed the default
632 * volume he did so in real_volume, because that is the usual
633 * place where he is supposed to place his changes. */
634 s
->reference_volume
= s
->real_volume
;
636 s
->thread_info
.soft_volume
= s
->soft_volume
;
637 s
->thread_info
.soft_muted
= s
->muted
;
638 pa_sw_cvolume_multiply(&s
->thread_info
.current_hw_volume
, &s
->soft_volume
, &s
->real_volume
);
640 pa_assert((s
->flags
& PA_SINK_HW_VOLUME_CTRL
)
641 || (s
->base_volume
== PA_VOLUME_NORM
642 && ((s
->flags
& PA_SINK_DECIBEL_VOLUME
|| (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)))));
643 pa_assert(!(s
->flags
& PA_SINK_DECIBEL_VOLUME
) || s
->n_volume_steps
== PA_VOLUME_NORM
+1);
644 pa_assert(!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
) == (s
->thread_info
.fixed_latency
!= 0));
645 pa_assert(!(s
->flags
& PA_SINK_LATENCY
) == !(s
->monitor_source
->flags
& PA_SOURCE_LATENCY
));
646 pa_assert(!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
) == !(s
->monitor_source
->flags
& PA_SOURCE_DYNAMIC_LATENCY
));
648 pa_assert(s
->monitor_source
->thread_info
.fixed_latency
== s
->thread_info
.fixed_latency
);
649 pa_assert(s
->monitor_source
->thread_info
.min_latency
== s
->thread_info
.min_latency
);
650 pa_assert(s
->monitor_source
->thread_info
.max_latency
== s
->thread_info
.max_latency
);
652 pa_assert_se(sink_set_state(s
, PA_SINK_IDLE
) == 0);
654 pa_source_put(s
->monitor_source
);
656 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_NEW
, s
->index
);
657 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PUT
], s
);
660 /* Called from main context */
661 void pa_sink_unlink(pa_sink
* s
) {
663 pa_sink_input
*i
, *j
= NULL
;
666 pa_assert_ctl_context();
668 /* Please note that pa_sink_unlink() does more than simply
669 * reversing pa_sink_put(). It also undoes the registrations
670 * already done in pa_sink_new()! */
672 /* All operations here shall be idempotent, i.e. pa_sink_unlink()
673 * may be called multiple times on the same sink without bad
676 linked
= PA_SINK_IS_LINKED(s
->state
);
679 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK
], s
);
681 if (s
->state
!= PA_SINK_UNLINKED
)
682 pa_namereg_unregister(s
->core
, s
->name
);
683 pa_idxset_remove_by_data(s
->core
->sinks
, s
, NULL
);
686 pa_idxset_remove_by_data(s
->card
->sinks
, s
, NULL
);
688 while ((i
= pa_idxset_first(s
->inputs
, NULL
))) {
690 pa_sink_input_kill(i
);
695 sink_set_state(s
, PA_SINK_UNLINKED
);
697 s
->state
= PA_SINK_UNLINKED
;
701 if (s
->monitor_source
)
702 pa_source_unlink(s
->monitor_source
);
705 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_REMOVE
, s
->index
);
706 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK_POST
], s
);
710 /* Called from main context */
711 static void sink_free(pa_object
*o
) {
712 pa_sink
*s
= PA_SINK(o
);
716 pa_assert_ctl_context();
717 pa_assert(pa_sink_refcnt(s
) == 0);
719 if (PA_SINK_IS_LINKED(s
->state
))
722 pa_log_info("Freeing sink %u \"%s\"", s
->index
, s
->name
);
724 if (s
->monitor_source
) {
725 pa_source_unref(s
->monitor_source
);
726 s
->monitor_source
= NULL
;
729 pa_idxset_free(s
->inputs
, NULL
, NULL
);
731 while ((i
= pa_hashmap_steal_first(s
->thread_info
.inputs
)))
732 pa_sink_input_unref(i
);
734 pa_hashmap_free(s
->thread_info
.inputs
, NULL
, NULL
);
736 if (s
->silence
.memblock
)
737 pa_memblock_unref(s
->silence
.memblock
);
743 pa_proplist_free(s
->proplist
);
746 pa_device_port_hashmap_free(s
->ports
);
751 /* Called from main context, and not while the IO thread is active, please */
752 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
) {
753 pa_sink_assert_ref(s
);
754 pa_assert_ctl_context();
758 if (s
->monitor_source
)
759 pa_source_set_asyncmsgq(s
->monitor_source
, q
);
762 /* Called from main context, and not while the IO thread is active, please */
763 void pa_sink_update_flags(pa_sink
*s
, pa_sink_flags_t mask
, pa_sink_flags_t value
) {
764 pa_sink_assert_ref(s
);
765 pa_assert_ctl_context();
770 /* For now, allow only a minimal set of flags to be changed. */
771 pa_assert((mask
& ~(PA_SINK_DYNAMIC_LATENCY
|PA_SINK_LATENCY
)) == 0);
773 s
->flags
= (s
->flags
& ~mask
) | (value
& mask
);
775 pa_source_update_flags(s
->monitor_source
,
776 ((mask
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
777 ((mask
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0),
778 ((value
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
779 ((value
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SINK_DYNAMIC_LATENCY
: 0));
782 /* Called from IO context, or before _put() from main context */
783 void pa_sink_set_rtpoll(pa_sink
*s
, pa_rtpoll
*p
) {
784 pa_sink_assert_ref(s
);
785 pa_sink_assert_io_context(s
);
787 s
->thread_info
.rtpoll
= p
;
789 if (s
->monitor_source
)
790 pa_source_set_rtpoll(s
->monitor_source
, p
);
793 /* Called from main context */
794 int pa_sink_update_status(pa_sink
*s
) {
795 pa_sink_assert_ref(s
);
796 pa_assert_ctl_context();
797 pa_assert(PA_SINK_IS_LINKED(s
->state
));
799 if (s
->state
== PA_SINK_SUSPENDED
)
802 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
805 /* Called from any context - must be threadsafe */
806 void pa_sink_set_mixer_dirty(pa_sink
*s
, pa_bool_t is_dirty
)
808 pa_atomic_store(&s
->mixer_dirty
, is_dirty
? 1 : 0);
811 /* Called from main context */
812 int pa_sink_suspend(pa_sink
*s
, pa_bool_t suspend
, pa_suspend_cause_t cause
) {
813 pa_sink_assert_ref(s
);
814 pa_assert_ctl_context();
815 pa_assert(PA_SINK_IS_LINKED(s
->state
));
816 pa_assert(cause
!= 0);
819 s
->suspend_cause
|= cause
;
820 s
->monitor_source
->suspend_cause
|= cause
;
822 s
->suspend_cause
&= ~cause
;
823 s
->monitor_source
->suspend_cause
&= ~cause
;
826 if (!(s
->suspend_cause
& PA_SUSPEND_SESSION
) && (pa_atomic_load(&s
->mixer_dirty
) != 0)) {
827 /* This might look racy but isn't: If somebody sets mixer_dirty exactly here,
828 it'll be handled just fine. */
829 pa_sink_set_mixer_dirty(s
, FALSE
);
830 pa_log_debug("Mixer is now accessible. Updating alsa mixer settings.");
831 if (s
->active_port
&& s
->set_port
) {
832 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
833 struct sink_message_set_port msg
= { .port
= s
->active_port
, .ret
= 0 };
834 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_PORT
, &msg
, 0, NULL
) == 0);
837 s
->set_port(s
, s
->active_port
);
847 if ((pa_sink_get_state(s
) == PA_SINK_SUSPENDED
) == !!s
->suspend_cause
)
850 pa_log_debug("Suspend cause of sink %s is 0x%04x, %s", s
->name
, s
->suspend_cause
, s
->suspend_cause
? "suspending" : "resuming");
852 if (s
->suspend_cause
)
853 return sink_set_state(s
, PA_SINK_SUSPENDED
);
855 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
858 /* Called from main context */
859 pa_queue
*pa_sink_move_all_start(pa_sink
*s
, pa_queue
*q
) {
860 pa_sink_input
*i
, *n
;
863 pa_sink_assert_ref(s
);
864 pa_assert_ctl_context();
865 pa_assert(PA_SINK_IS_LINKED(s
->state
));
870 for (i
= PA_SINK_INPUT(pa_idxset_first(s
->inputs
, &idx
)); i
; i
= n
) {
871 n
= PA_SINK_INPUT(pa_idxset_next(s
->inputs
, &idx
));
873 pa_sink_input_ref(i
);
875 if (pa_sink_input_start_move(i
) >= 0)
878 pa_sink_input_unref(i
);
884 /* Called from main context */
885 void pa_sink_move_all_finish(pa_sink
*s
, pa_queue
*q
, pa_bool_t save
) {
888 pa_sink_assert_ref(s
);
889 pa_assert_ctl_context();
890 pa_assert(PA_SINK_IS_LINKED(s
->state
));
893 while ((i
= PA_SINK_INPUT(pa_queue_pop(q
)))) {
894 if (pa_sink_input_finish_move(i
, s
, save
) < 0)
895 pa_sink_input_fail_move(i
);
897 pa_sink_input_unref(i
);
900 pa_queue_free(q
, NULL
);
903 /* Called from main context */
904 void pa_sink_move_all_fail(pa_queue
*q
) {
907 pa_assert_ctl_context();
910 while ((i
= PA_SINK_INPUT(pa_queue_pop(q
)))) {
911 pa_sink_input_fail_move(i
);
912 pa_sink_input_unref(i
);
915 pa_queue_free(q
, NULL
);
918 /* Called from IO thread context */
919 void pa_sink_process_rewind(pa_sink
*s
, size_t nbytes
) {
923 pa_sink_assert_ref(s
);
924 pa_sink_assert_io_context(s
);
925 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
927 /* If nobody requested this and this is actually no real rewind
928 * then we can short cut this. Please note that this means that
929 * not all rewind requests triggered upstream will always be
930 * translated in actual requests! */
931 if (!s
->thread_info
.rewind_requested
&& nbytes
<= 0)
934 s
->thread_info
.rewind_nbytes
= 0;
935 s
->thread_info
.rewind_requested
= FALSE
;
937 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
941 pa_log_debug("Processing rewind...");
942 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
943 pa_sink_volume_change_rewind(s
, nbytes
);
946 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
947 pa_sink_input_assert_ref(i
);
948 pa_sink_input_process_rewind(i
, nbytes
);
952 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
953 pa_source_process_rewind(s
->monitor_source
, nbytes
);
957 /* Called from IO thread context */
958 static unsigned fill_mix_info(pa_sink
*s
, size_t *length
, pa_mix_info
*info
, unsigned maxinfo
) {
962 size_t mixlength
= *length
;
964 pa_sink_assert_ref(s
);
965 pa_sink_assert_io_context(s
);
968 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)) && maxinfo
> 0) {
969 pa_sink_input_assert_ref(i
);
971 pa_sink_input_peek(i
, *length
, &info
->chunk
, &info
->volume
);
973 if (mixlength
== 0 || info
->chunk
.length
< mixlength
)
974 mixlength
= info
->chunk
.length
;
976 if (pa_memblock_is_silence(info
->chunk
.memblock
)) {
977 pa_memblock_unref(info
->chunk
.memblock
);
981 info
->userdata
= pa_sink_input_ref(i
);
983 pa_assert(info
->chunk
.memblock
);
984 pa_assert(info
->chunk
.length
> 0);
997 /* Called from IO thread context */
998 static void inputs_drop(pa_sink
*s
, pa_mix_info
*info
, unsigned n
, pa_memchunk
*result
) {
1002 unsigned n_unreffed
= 0;
1004 pa_sink_assert_ref(s
);
1005 pa_sink_assert_io_context(s
);
1007 pa_assert(result
->memblock
);
1008 pa_assert(result
->length
> 0);
1010 /* We optimize for the case where the order of the inputs has not changed */
1012 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
1014 pa_mix_info
* m
= NULL
;
1016 pa_sink_input_assert_ref(i
);
1018 /* Let's try to find the matching entry info the pa_mix_info array */
1019 for (j
= 0; j
< n
; j
++) {
1021 if (info
[p
].userdata
== i
) {
1031 /* Drop read data */
1032 pa_sink_input_drop(i
, result
->length
);
1034 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
)) {
1036 if (pa_hashmap_size(i
->thread_info
.direct_outputs
) > 0) {
1037 void *ostate
= NULL
;
1038 pa_source_output
*o
;
1041 if (m
&& m
->chunk
.memblock
) {
1043 pa_memblock_ref(c
.memblock
);
1044 pa_assert(result
->length
<= c
.length
);
1045 c
.length
= result
->length
;
1047 pa_memchunk_make_writable(&c
, 0);
1048 pa_volume_memchunk(&c
, &s
->sample_spec
, &m
->volume
);
1051 pa_memblock_ref(c
.memblock
);
1052 pa_assert(result
->length
<= c
.length
);
1053 c
.length
= result
->length
;
1056 while ((o
= pa_hashmap_iterate(i
->thread_info
.direct_outputs
, &ostate
, NULL
))) {
1057 pa_source_output_assert_ref(o
);
1058 pa_assert(o
->direct_on_input
== i
);
1059 pa_source_post_direct(s
->monitor_source
, o
, &c
);
1062 pa_memblock_unref(c
.memblock
);
1067 if (m
->chunk
.memblock
)
1068 pa_memblock_unref(m
->chunk
.memblock
);
1069 pa_memchunk_reset(&m
->chunk
);
1071 pa_sink_input_unref(m
->userdata
);
1078 /* Now drop references to entries that are included in the
1079 * pa_mix_info array but don't exist anymore */
1081 if (n_unreffed
< n
) {
1082 for (; n
> 0; info
++, n
--) {
1084 pa_sink_input_unref(info
->userdata
);
1085 if (info
->chunk
.memblock
)
1086 pa_memblock_unref(info
->chunk
.memblock
);
1090 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
1091 pa_source_post(s
->monitor_source
, result
);
1094 /* Called from IO thread context */
1095 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1096 pa_mix_info info
[MAX_MIX_CHANNELS
];
1098 size_t block_size_max
;
1100 pa_sink_assert_ref(s
);
1101 pa_sink_assert_io_context(s
);
1102 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1103 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1106 pa_assert(!s
->thread_info
.rewind_requested
);
1107 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1109 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1110 result
->memblock
= pa_memblock_ref(s
->silence
.memblock
);
1111 result
->index
= s
->silence
.index
;
1112 result
->length
= PA_MIN(s
->silence
.length
, length
);
1119 length
= pa_frame_align(MIX_BUFFER_LENGTH
, &s
->sample_spec
);
1121 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1122 if (length
> block_size_max
)
1123 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1125 pa_assert(length
> 0);
1127 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1131 *result
= s
->silence
;
1132 pa_memblock_ref(result
->memblock
);
1134 if (result
->length
> length
)
1135 result
->length
= length
;
1137 } else if (n
== 1) {
1140 *result
= info
[0].chunk
;
1141 pa_memblock_ref(result
->memblock
);
1143 if (result
->length
> length
)
1144 result
->length
= length
;
1146 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1148 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
)) {
1149 pa_memblock_unref(result
->memblock
);
1150 pa_silence_memchunk_get(&s
->core
->silence_cache
,
1155 } else if (!pa_cvolume_is_norm(&volume
)) {
1156 pa_memchunk_make_writable(result
, 0);
1157 pa_volume_memchunk(result
, &s
->sample_spec
, &volume
);
1161 result
->memblock
= pa_memblock_new(s
->core
->mempool
, length
);
1163 ptr
= pa_memblock_acquire(result
->memblock
);
1164 result
->length
= pa_mix(info
, n
,
1167 &s
->thread_info
.soft_volume
,
1168 s
->thread_info
.soft_muted
);
1169 pa_memblock_release(result
->memblock
);
1174 inputs_drop(s
, info
, n
, result
);
1179 /* Called from IO thread context */
1180 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
) {
1181 pa_mix_info info
[MAX_MIX_CHANNELS
];
1183 size_t length
, block_size_max
;
1185 pa_sink_assert_ref(s
);
1186 pa_sink_assert_io_context(s
);
1187 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1189 pa_assert(target
->memblock
);
1190 pa_assert(target
->length
> 0);
1191 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1193 pa_assert(!s
->thread_info
.rewind_requested
);
1194 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1196 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1197 pa_silence_memchunk(target
, &s
->sample_spec
);
1203 length
= target
->length
;
1204 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1205 if (length
> block_size_max
)
1206 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1208 pa_assert(length
> 0);
1210 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1213 if (target
->length
> length
)
1214 target
->length
= length
;
1216 pa_silence_memchunk(target
, &s
->sample_spec
);
1217 } else if (n
== 1) {
1220 if (target
->length
> length
)
1221 target
->length
= length
;
1223 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1225 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
))
1226 pa_silence_memchunk(target
, &s
->sample_spec
);
1230 vchunk
= info
[0].chunk
;
1231 pa_memblock_ref(vchunk
.memblock
);
1233 if (vchunk
.length
> length
)
1234 vchunk
.length
= length
;
1236 if (!pa_cvolume_is_norm(&volume
)) {
1237 pa_memchunk_make_writable(&vchunk
, 0);
1238 pa_volume_memchunk(&vchunk
, &s
->sample_spec
, &volume
);
1241 pa_memchunk_memcpy(target
, &vchunk
);
1242 pa_memblock_unref(vchunk
.memblock
);
1248 ptr
= pa_memblock_acquire(target
->memblock
);
1250 target
->length
= pa_mix(info
, n
,
1251 (uint8_t*) ptr
+ target
->index
, length
,
1253 &s
->thread_info
.soft_volume
,
1254 s
->thread_info
.soft_muted
);
1256 pa_memblock_release(target
->memblock
);
1259 inputs_drop(s
, info
, n
, target
);
1264 /* Called from IO thread context */
1265 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
) {
1269 pa_sink_assert_ref(s
);
1270 pa_sink_assert_io_context(s
);
1271 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1273 pa_assert(target
->memblock
);
1274 pa_assert(target
->length
> 0);
1275 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1277 pa_assert(!s
->thread_info
.rewind_requested
);
1278 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1280 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1281 pa_silence_memchunk(target
, &s
->sample_spec
);
1294 pa_sink_render_into(s
, &chunk
);
1303 /* Called from IO thread context */
1304 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1305 pa_sink_assert_ref(s
);
1306 pa_sink_assert_io_context(s
);
1307 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1308 pa_assert(length
> 0);
1309 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1312 pa_assert(!s
->thread_info
.rewind_requested
);
1313 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1317 pa_sink_render(s
, length
, result
);
1319 if (result
->length
< length
) {
1322 pa_memchunk_make_writable(result
, length
);
1324 chunk
.memblock
= result
->memblock
;
1325 chunk
.index
= result
->index
+ result
->length
;
1326 chunk
.length
= length
- result
->length
;
1328 pa_sink_render_into_full(s
, &chunk
);
1330 result
->length
= length
;
1336 /* Called from main thread */
1337 pa_bool_t
pa_sink_update_rate(pa_sink
*s
, uint32_t rate
, pa_bool_t passthrough
)
1339 if (s
->update_rate
) {
1340 uint32_t desired_rate
= rate
;
1341 uint32_t default_rate
= s
->default_sample_rate
;
1342 uint32_t alternate_rate
= s
->alternate_sample_rate
;
1345 pa_bool_t use_alternate
= FALSE
;
1347 if (PA_UNLIKELY(default_rate
== alternate_rate
)) {
1348 pa_log_warn("Default and alternate sample rates are the same.");
1352 if (PA_SINK_IS_RUNNING(s
->state
)) {
1353 pa_log_info("Cannot update rate, SINK_IS_RUNNING, will keep using %u Hz",
1354 s
->sample_spec
.rate
);
1358 if (s
->monitor_source
) {
1359 if (PA_SOURCE_IS_RUNNING(s
->monitor_source
->state
) == TRUE
) {
1360 pa_log_info("Cannot update rate, monitor source is RUNNING");
1365 if (PA_UNLIKELY (desired_rate
< 8000 ||
1366 desired_rate
> PA_RATE_MAX
))
1370 pa_assert(default_rate
% 4000 || default_rate
% 11025);
1371 pa_assert(alternate_rate
% 4000 || alternate_rate
% 11025);
1373 if (default_rate
% 4000) {
1374 /* default is a 11025 multiple */
1375 if ((alternate_rate
% 4000 == 0) && (desired_rate
% 4000 == 0))
1378 /* default is 4000 multiple */
1379 if ((alternate_rate
% 11025 == 0) && (desired_rate
% 11025 == 0))
1384 desired_rate
= alternate_rate
;
1386 desired_rate
= default_rate
;
1388 desired_rate
= rate
; /* use stream sampling rate, discard default/alternate settings */
1391 if (!passthrough
&& pa_sink_used_by(s
) > 0)
1394 pa_sink_suspend(s
, TRUE
, PA_SUSPEND_IDLE
); /* needed before rate update, will be resumed automatically */
1396 if (s
->update_rate(s
, desired_rate
) == TRUE
) {
1397 /* update monitor source as well */
1398 if (s
->monitor_source
&& !passthrough
)
1399 pa_source_update_rate(s
->monitor_source
, desired_rate
, FALSE
);
1400 pa_log_info("Changed sampling rate successfully");
1402 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1403 if (i
->state
== PA_SINK_INPUT_CORKED
)
1404 pa_sink_input_update_rate(i
);
1413 /* Called from main thread */
1414 pa_usec_t
pa_sink_get_latency(pa_sink
*s
) {
1417 pa_sink_assert_ref(s
);
1418 pa_assert_ctl_context();
1419 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1421 /* The returned value is supposed to be in the time domain of the sound card! */
1423 if (s
->state
== PA_SINK_SUSPENDED
)
1426 if (!(s
->flags
& PA_SINK_LATENCY
))
1429 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) == 0);
1431 /* usec is unsigned, so check that the offset can be added to usec without
1433 if (-s
->latency_offset
<= (int64_t) usec
)
1434 usec
+= s
->latency_offset
;
1441 /* Called from IO thread */
1442 pa_usec_t
pa_sink_get_latency_within_thread(pa_sink
*s
) {
1446 pa_sink_assert_ref(s
);
1447 pa_sink_assert_io_context(s
);
1448 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1450 /* The returned value is supposed to be in the time domain of the sound card! */
1452 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
1455 if (!(s
->flags
& PA_SINK_LATENCY
))
1458 o
= PA_MSGOBJECT(s
);
1460 /* FIXME: We probably should make this a proper vtable callback instead of going through process_msg() */
1462 if (o
->process_msg(o
, PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) < 0)
1465 /* usec is unsigned, so check that the offset can be added to usec without
1467 if (-s
->thread_info
.latency_offset
<= (int64_t) usec
)
1468 usec
+= s
->thread_info
.latency_offset
;
1475 /* Called from the main thread (and also from the IO thread while the main
1476 * thread is waiting).
1478 * When a sink uses volume sharing, it never has the PA_SINK_FLAT_VOLUME flag
1479 * set. Instead, flat volume mode is detected by checking whether the root sink
1480 * has the flag set. */
1481 pa_bool_t
pa_sink_flat_volume_enabled(pa_sink
*s
) {
1482 pa_sink_assert_ref(s
);
1484 s
= pa_sink_get_master(s
);
1487 return (s
->flags
& PA_SINK_FLAT_VOLUME
);
1492 /* Called from the main thread (and also from the IO thread while the main
1493 * thread is waiting). */
1494 pa_sink
*pa_sink_get_master(pa_sink
*s
) {
1495 pa_sink_assert_ref(s
);
1497 while (s
&& (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1498 if (PA_UNLIKELY(!s
->input_to_master
))
1501 s
= s
->input_to_master
->sink
;
1507 /* Called from main context */
1508 pa_bool_t
pa_sink_is_passthrough(pa_sink
*s
) {
1509 pa_sink_input
*alt_i
;
1512 pa_sink_assert_ref(s
);
1514 /* one and only one PASSTHROUGH input can possibly be connected */
1515 if (pa_idxset_size(s
->inputs
) == 1) {
1516 alt_i
= pa_idxset_first(s
->inputs
, &idx
);
1518 if (pa_sink_input_is_passthrough(alt_i
))
1525 /* Called from main context */
1526 void pa_sink_enter_passthrough(pa_sink
*s
) {
1529 /* disable the monitor in passthrough mode */
1530 if (s
->monitor_source
)
1531 pa_source_suspend(s
->monitor_source
, TRUE
, PA_SUSPEND_PASSTHROUGH
);
1533 /* set the volume to NORM */
1534 s
->saved_volume
= *pa_sink_get_volume(s
, TRUE
);
1535 s
->saved_save_volume
= s
->save_volume
;
1537 pa_cvolume_set(&volume
, s
->sample_spec
.channels
, PA_MIN(s
->base_volume
, PA_VOLUME_NORM
));
1538 pa_sink_set_volume(s
, &volume
, TRUE
, FALSE
);
1541 /* Called from main context */
1542 void pa_sink_leave_passthrough(pa_sink
*s
) {
1543 /* Unsuspend monitor */
1544 if (s
->monitor_source
)
1545 pa_source_suspend(s
->monitor_source
, FALSE
, PA_SUSPEND_PASSTHROUGH
);
1547 /* Restore sink volume to what it was before we entered passthrough mode */
1548 pa_sink_set_volume(s
, &s
->saved_volume
, TRUE
, s
->saved_save_volume
);
1550 pa_cvolume_init(&s
->saved_volume
);
1551 s
->saved_save_volume
= FALSE
;
1554 /* Called from main context. */
1555 static void compute_reference_ratio(pa_sink_input
*i
) {
1557 pa_cvolume remapped
;
1560 pa_assert(pa_sink_flat_volume_enabled(i
->sink
));
1563 * Calculates the reference ratio from the sink's reference
1564 * volume. This basically calculates:
1566 * i->reference_ratio = i->volume / i->sink->reference_volume
1569 remapped
= i
->sink
->reference_volume
;
1570 pa_cvolume_remap(&remapped
, &i
->sink
->channel_map
, &i
->channel_map
);
1572 i
->reference_ratio
.channels
= i
->sample_spec
.channels
;
1574 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1576 /* We don't update when the sink volume is 0 anyway */
1577 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
)
1580 /* Don't update the reference ratio unless necessary */
1581 if (pa_sw_volume_multiply(
1582 i
->reference_ratio
.values
[c
],
1583 remapped
.values
[c
]) == i
->volume
.values
[c
])
1586 i
->reference_ratio
.values
[c
] = pa_sw_volume_divide(
1587 i
->volume
.values
[c
],
1588 remapped
.values
[c
]);
1592 /* Called from main context. Only called for the root sink in volume sharing
1593 * cases, except for internal recursive calls. */
1594 static void compute_reference_ratios(pa_sink
*s
) {
1598 pa_sink_assert_ref(s
);
1599 pa_assert_ctl_context();
1600 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1601 pa_assert(pa_sink_flat_volume_enabled(s
));
1603 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1604 compute_reference_ratio(i
);
1606 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1607 compute_reference_ratios(i
->origin_sink
);
1611 /* Called from main context. Only called for the root sink in volume sharing
1612 * cases, except for internal recursive calls. */
1613 static void compute_real_ratios(pa_sink
*s
) {
1617 pa_sink_assert_ref(s
);
1618 pa_assert_ctl_context();
1619 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1620 pa_assert(pa_sink_flat_volume_enabled(s
));
1622 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1624 pa_cvolume remapped
;
1626 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1627 /* The origin sink uses volume sharing, so this input's real ratio
1628 * is handled as a special case - the real ratio must be 0 dB, and
1629 * as a result i->soft_volume must equal i->volume_factor. */
1630 pa_cvolume_reset(&i
->real_ratio
, i
->real_ratio
.channels
);
1631 i
->soft_volume
= i
->volume_factor
;
1633 compute_real_ratios(i
->origin_sink
);
1639 * This basically calculates:
1641 * i->real_ratio := i->volume / s->real_volume
1642 * i->soft_volume := i->real_ratio * i->volume_factor
1645 remapped
= s
->real_volume
;
1646 pa_cvolume_remap(&remapped
, &s
->channel_map
, &i
->channel_map
);
1648 i
->real_ratio
.channels
= i
->sample_spec
.channels
;
1649 i
->soft_volume
.channels
= i
->sample_spec
.channels
;
1651 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1653 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
) {
1654 /* We leave i->real_ratio untouched */
1655 i
->soft_volume
.values
[c
] = PA_VOLUME_MUTED
;
1659 /* Don't lose accuracy unless necessary */
1660 if (pa_sw_volume_multiply(
1661 i
->real_ratio
.values
[c
],
1662 remapped
.values
[c
]) != i
->volume
.values
[c
])
1664 i
->real_ratio
.values
[c
] = pa_sw_volume_divide(
1665 i
->volume
.values
[c
],
1666 remapped
.values
[c
]);
1668 i
->soft_volume
.values
[c
] = pa_sw_volume_multiply(
1669 i
->real_ratio
.values
[c
],
1670 i
->volume_factor
.values
[c
]);
1673 /* We don't copy the soft_volume to the thread_info data
1674 * here. That must be done by the caller */
1678 static pa_cvolume
*cvolume_remap_minimal_impact(
1680 const pa_cvolume
*template,
1681 const pa_channel_map
*from
,
1682 const pa_channel_map
*to
) {
1687 pa_assert(template);
1690 pa_assert(pa_cvolume_compatible_with_channel_map(v
, from
));
1691 pa_assert(pa_cvolume_compatible_with_channel_map(template, to
));
1693 /* Much like pa_cvolume_remap(), but tries to minimize impact when
1694 * mapping from sink input to sink volumes:
1696 * If template is a possible remapping from v it is used instead
1697 * of remapping anew.
1699 * If the channel maps don't match we set an all-channel volume on
1700 * the sink to ensure that changing a volume on one stream has no
1701 * effect that cannot be compensated for in another stream that
1702 * does not have the same channel map as the sink. */
1704 if (pa_channel_map_equal(from
, to
))
1708 if (pa_cvolume_equal(pa_cvolume_remap(&t
, to
, from
), v
)) {
1713 pa_cvolume_set(v
, to
->channels
, pa_cvolume_max(v
));
1717 /* Called from main thread. Only called for the root sink in volume sharing
1718 * cases, except for internal recursive calls. */
1719 static void get_maximum_input_volume(pa_sink
*s
, pa_cvolume
*max_volume
, const pa_channel_map
*channel_map
) {
1723 pa_sink_assert_ref(s
);
1724 pa_assert(max_volume
);
1725 pa_assert(channel_map
);
1726 pa_assert(pa_sink_flat_volume_enabled(s
));
1728 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1729 pa_cvolume remapped
;
1731 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1732 get_maximum_input_volume(i
->origin_sink
, max_volume
, channel_map
);
1734 /* Ignore this input. The origin sink uses volume sharing, so this
1735 * input's volume will be set to be equal to the root sink's real
1736 * volume. Obviously this input's current volume must not then
1737 * affect what the root sink's real volume will be. */
1741 remapped
= i
->volume
;
1742 cvolume_remap_minimal_impact(&remapped
, max_volume
, &i
->channel_map
, channel_map
);
1743 pa_cvolume_merge(max_volume
, max_volume
, &remapped
);
1747 /* Called from main thread. Only called for the root sink in volume sharing
1748 * cases, except for internal recursive calls. */
1749 static pa_bool_t
has_inputs(pa_sink
*s
) {
1753 pa_sink_assert_ref(s
);
1755 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1756 if (!i
->origin_sink
|| !(i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) || has_inputs(i
->origin_sink
))
1763 /* Called from main thread. Only called for the root sink in volume sharing
1764 * cases, except for internal recursive calls. */
1765 static void update_real_volume(pa_sink
*s
, const pa_cvolume
*new_volume
, pa_channel_map
*channel_map
) {
1769 pa_sink_assert_ref(s
);
1770 pa_assert(new_volume
);
1771 pa_assert(channel_map
);
1773 s
->real_volume
= *new_volume
;
1774 pa_cvolume_remap(&s
->real_volume
, channel_map
, &s
->channel_map
);
1776 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1777 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1778 if (pa_sink_flat_volume_enabled(s
)) {
1779 pa_cvolume old_volume
= i
->volume
;
1781 /* Follow the root sink's real volume. */
1782 i
->volume
= *new_volume
;
1783 pa_cvolume_remap(&i
->volume
, channel_map
, &i
->channel_map
);
1784 compute_reference_ratio(i
);
1786 /* The volume changed, let's tell people so */
1787 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
1788 if (i
->volume_changed
)
1789 i
->volume_changed(i
);
1791 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1795 update_real_volume(i
->origin_sink
, new_volume
, channel_map
);
1800 /* Called from main thread. Only called for the root sink in shared volume
1802 static void compute_real_volume(pa_sink
*s
) {
1803 pa_sink_assert_ref(s
);
1804 pa_assert_ctl_context();
1805 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1806 pa_assert(pa_sink_flat_volume_enabled(s
));
1807 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
1809 /* This determines the maximum volume of all streams and sets
1810 * s->real_volume accordingly. */
1812 if (!has_inputs(s
)) {
1813 /* In the special case that we have no sink inputs we leave the
1814 * volume unmodified. */
1815 update_real_volume(s
, &s
->reference_volume
, &s
->channel_map
);
1819 pa_cvolume_mute(&s
->real_volume
, s
->channel_map
.channels
);
1821 /* First let's determine the new maximum volume of all inputs
1822 * connected to this sink */
1823 get_maximum_input_volume(s
, &s
->real_volume
, &s
->channel_map
);
1824 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
1826 /* Then, let's update the real ratios/soft volumes of all inputs
1827 * connected to this sink */
1828 compute_real_ratios(s
);
1831 /* Called from main thread. Only called for the root sink in shared volume
1832 * cases, except for internal recursive calls. */
1833 static void propagate_reference_volume(pa_sink
*s
) {
1837 pa_sink_assert_ref(s
);
1838 pa_assert_ctl_context();
1839 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1840 pa_assert(pa_sink_flat_volume_enabled(s
));
1842 /* This is called whenever the sink volume changes that is not
1843 * caused by a sink input volume change. We need to fix up the
1844 * sink input volumes accordingly */
1846 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1847 pa_cvolume old_volume
;
1849 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1850 propagate_reference_volume(i
->origin_sink
);
1852 /* Since the origin sink uses volume sharing, this input's volume
1853 * needs to be updated to match the root sink's real volume, but
1854 * that will be done later in update_shared_real_volume(). */
1858 old_volume
= i
->volume
;
1860 /* This basically calculates:
1862 * i->volume := s->reference_volume * i->reference_ratio */
1864 i
->volume
= s
->reference_volume
;
1865 pa_cvolume_remap(&i
->volume
, &s
->channel_map
, &i
->channel_map
);
1866 pa_sw_cvolume_multiply(&i
->volume
, &i
->volume
, &i
->reference_ratio
);
1868 /* The volume changed, let's tell people so */
1869 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
1871 if (i
->volume_changed
)
1872 i
->volume_changed(i
);
1874 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1879 /* Called from main thread. Only called for the root sink in volume sharing
1880 * cases, except for internal recursive calls. The return value indicates
1881 * whether any reference volume actually changed. */
1882 static pa_bool_t
update_reference_volume(pa_sink
*s
, const pa_cvolume
*v
, const pa_channel_map
*channel_map
, pa_bool_t save
) {
1884 pa_bool_t reference_volume_changed
;
1888 pa_sink_assert_ref(s
);
1889 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1891 pa_assert(channel_map
);
1892 pa_assert(pa_cvolume_valid(v
));
1895 pa_cvolume_remap(&volume
, channel_map
, &s
->channel_map
);
1897 reference_volume_changed
= !pa_cvolume_equal(&volume
, &s
->reference_volume
);
1898 s
->reference_volume
= volume
;
1900 s
->save_volume
= (!reference_volume_changed
&& s
->save_volume
) || save
;
1902 if (reference_volume_changed
)
1903 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
1904 else if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1905 /* If the root sink's volume doesn't change, then there can't be any
1906 * changes in the other sinks in the sink tree either.
1908 * It's probably theoretically possible that even if the root sink's
1909 * volume changes slightly, some filter sink doesn't change its volume
1910 * due to rounding errors. If that happens, we still want to propagate
1911 * the changed root sink volume to the sinks connected to the
1912 * intermediate sink that didn't change its volume. This theoretical
1913 * possibility is the reason why we have that !(s->flags &
1914 * PA_SINK_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would
1915 * notice even if we returned here FALSE always if
1916 * reference_volume_changed is FALSE. */
1919 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1920 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1921 update_reference_volume(i
->origin_sink
, v
, channel_map
, FALSE
);
1927 /* Called from main thread */
1928 void pa_sink_set_volume(
1930 const pa_cvolume
*volume
,
1934 pa_cvolume new_reference_volume
;
1937 pa_sink_assert_ref(s
);
1938 pa_assert_ctl_context();
1939 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1940 pa_assert(!volume
|| pa_cvolume_valid(volume
));
1941 pa_assert(volume
|| pa_sink_flat_volume_enabled(s
));
1942 pa_assert(!volume
|| volume
->channels
== 1 || pa_cvolume_compatible(volume
, &s
->sample_spec
));
1944 /* make sure we don't change the volume when a PASSTHROUGH input is connected ...
1945 * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */
1946 if (pa_sink_is_passthrough(s
) && (!volume
|| !pa_cvolume_is_norm(volume
))) {
1947 pa_log_warn("Cannot change volume, Sink is connected to PASSTHROUGH input");
1951 /* In case of volume sharing, the volume is set for the root sink first,
1952 * from which it's then propagated to the sharing sinks. */
1953 root_sink
= pa_sink_get_master(s
);
1955 if (PA_UNLIKELY(!root_sink
))
1958 /* As a special exception we accept mono volumes on all sinks --
1959 * even on those with more complex channel maps */
1962 if (pa_cvolume_compatible(volume
, &s
->sample_spec
))
1963 new_reference_volume
= *volume
;
1965 new_reference_volume
= s
->reference_volume
;
1966 pa_cvolume_scale(&new_reference_volume
, pa_cvolume_max(volume
));
1969 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
1971 if (update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
)) {
1972 if (pa_sink_flat_volume_enabled(root_sink
)) {
1973 /* OK, propagate this volume change back to the inputs */
1974 propagate_reference_volume(root_sink
);
1976 /* And now recalculate the real volume */
1977 compute_real_volume(root_sink
);
1979 update_real_volume(root_sink
, &root_sink
->reference_volume
, &root_sink
->channel_map
);
1983 /* If volume is NULL we synchronize the sink's real and
1984 * reference volumes with the stream volumes. */
1986 pa_assert(pa_sink_flat_volume_enabled(root_sink
));
1988 /* Ok, let's determine the new real volume */
1989 compute_real_volume(root_sink
);
1991 /* Let's 'push' the reference volume if necessary */
1992 pa_cvolume_merge(&new_reference_volume
, &s
->reference_volume
, &root_sink
->real_volume
);
1993 /* If the sink and it's root don't have the same number of channels, we need to remap */
1994 if (s
!= root_sink
&& !pa_channel_map_equal(&s
->channel_map
, &root_sink
->channel_map
))
1995 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
1996 update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
);
1998 /* Now that the reference volume is updated, we can update the streams'
1999 * reference ratios. */
2000 compute_reference_ratios(root_sink
);
2003 if (root_sink
->set_volume
) {
2004 /* If we have a function set_volume(), then we do not apply a
2005 * soft volume by default. However, set_volume() is free to
2006 * apply one to root_sink->soft_volume */
2008 pa_cvolume_reset(&root_sink
->soft_volume
, root_sink
->sample_spec
.channels
);
2009 if (!(root_sink
->flags
& PA_SINK_DEFERRED_VOLUME
))
2010 root_sink
->set_volume(root_sink
);
2013 /* If we have no function set_volume(), then the soft volume
2014 * becomes the real volume */
2015 root_sink
->soft_volume
= root_sink
->real_volume
;
2017 /* This tells the sink that soft volume and/or real volume changed */
2019 pa_assert_se(pa_asyncmsgq_send(root_sink
->asyncmsgq
, PA_MSGOBJECT(root_sink
), PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
) == 0);
2022 /* Called from the io thread if sync volume is used, otherwise from the main thread.
2023 * Only to be called by sink implementor */
2024 void pa_sink_set_soft_volume(pa_sink
*s
, const pa_cvolume
*volume
) {
2026 pa_sink_assert_ref(s
);
2027 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2029 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
2030 pa_sink_assert_io_context(s
);
2032 pa_assert_ctl_context();
2035 pa_cvolume_reset(&s
->soft_volume
, s
->sample_spec
.channels
);
2037 s
->soft_volume
= *volume
;
2039 if (PA_SINK_IS_LINKED(s
->state
) && !(s
->flags
& PA_SINK_DEFERRED_VOLUME
))
2040 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME
, NULL
, 0, NULL
) == 0);
2042 s
->thread_info
.soft_volume
= s
->soft_volume
;
2045 /* Called from the main thread. Only called for the root sink in volume sharing
2046 * cases, except for internal recursive calls. */
2047 static void propagate_real_volume(pa_sink
*s
, const pa_cvolume
*old_real_volume
) {
2051 pa_sink_assert_ref(s
);
2052 pa_assert(old_real_volume
);
2053 pa_assert_ctl_context();
2054 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2056 /* This is called when the hardware's real volume changes due to
2057 * some external event. We copy the real volume into our
2058 * reference volume and then rebuild the stream volumes based on
2059 * i->real_ratio which should stay fixed. */
2061 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
2062 if (pa_cvolume_equal(old_real_volume
, &s
->real_volume
))
2065 /* 1. Make the real volume the reference volume */
2066 update_reference_volume(s
, &s
->real_volume
, &s
->channel_map
, TRUE
);
2069 if (pa_sink_flat_volume_enabled(s
)) {
2071 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2072 pa_cvolume old_volume
= i
->volume
;
2074 /* 2. Since the sink's reference and real volumes are equal
2075 * now our ratios should be too. */
2076 i
->reference_ratio
= i
->real_ratio
;
2078 /* 3. Recalculate the new stream reference volume based on the
2079 * reference ratio and the sink's reference volume.
2081 * This basically calculates:
2083 * i->volume = s->reference_volume * i->reference_ratio
2085 * This is identical to propagate_reference_volume() */
2086 i
->volume
= s
->reference_volume
;
2087 pa_cvolume_remap(&i
->volume
, &s
->channel_map
, &i
->channel_map
);
2088 pa_sw_cvolume_multiply(&i
->volume
, &i
->volume
, &i
->reference_ratio
);
2090 /* Notify if something changed */
2091 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
2093 if (i
->volume_changed
)
2094 i
->volume_changed(i
);
2096 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
2099 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2100 propagate_real_volume(i
->origin_sink
, old_real_volume
);
2104 /* Something got changed in the hardware. It probably makes sense
2105 * to save changed hw settings given that hw volume changes not
2106 * triggered by PA are almost certainly done by the user. */
2107 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2108 s
->save_volume
= TRUE
;
2111 /* Called from io thread */
2112 void pa_sink_update_volume_and_mute(pa_sink
*s
) {
2114 pa_sink_assert_io_context(s
);
2116 pa_asyncmsgq_post(pa_thread_mq_get()->outq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
, NULL
, 0, NULL
, NULL
);
2119 /* Called from main thread */
2120 const pa_cvolume
*pa_sink_get_volume(pa_sink
*s
, pa_bool_t force_refresh
) {
2121 pa_sink_assert_ref(s
);
2122 pa_assert_ctl_context();
2123 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2125 if (s
->refresh_volume
|| force_refresh
) {
2126 struct pa_cvolume old_real_volume
;
2128 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2130 old_real_volume
= s
->real_volume
;
2132 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
)
2135 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_VOLUME
, NULL
, 0, NULL
) == 0);
2137 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
2138 propagate_real_volume(s
, &old_real_volume
);
2141 return &s
->reference_volume
;
2144 /* Called from main thread. In volume sharing cases, only the root sink may
2146 void pa_sink_volume_changed(pa_sink
*s
, const pa_cvolume
*new_real_volume
) {
2147 pa_cvolume old_real_volume
;
2149 pa_sink_assert_ref(s
);
2150 pa_assert_ctl_context();
2151 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2152 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2154 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2156 old_real_volume
= s
->real_volume
;
2157 update_real_volume(s
, new_real_volume
, &s
->channel_map
);
2158 propagate_real_volume(s
, &old_real_volume
);
2161 /* Called from main thread */
2162 void pa_sink_set_mute(pa_sink
*s
, pa_bool_t mute
, pa_bool_t save
) {
2163 pa_bool_t old_muted
;
2165 pa_sink_assert_ref(s
);
2166 pa_assert_ctl_context();
2167 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2169 old_muted
= s
->muted
;
2171 s
->save_muted
= (old_muted
== s
->muted
&& s
->save_muted
) || save
;
2173 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->set_mute
)
2176 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2178 if (old_muted
!= s
->muted
)
2179 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2182 /* Called from main thread */
2183 pa_bool_t
pa_sink_get_mute(pa_sink
*s
, pa_bool_t force_refresh
) {
2185 pa_sink_assert_ref(s
);
2186 pa_assert_ctl_context();
2187 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2189 if (s
->refresh_muted
|| force_refresh
) {
2190 pa_bool_t old_muted
= s
->muted
;
2192 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_mute
)
2195 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MUTE
, NULL
, 0, NULL
) == 0);
2197 if (old_muted
!= s
->muted
) {
2198 s
->save_muted
= TRUE
;
2200 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2202 /* Make sure the soft mute status stays in sync */
2203 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2210 /* Called from main thread */
2211 void pa_sink_mute_changed(pa_sink
*s
, pa_bool_t new_muted
) {
2212 pa_sink_assert_ref(s
);
2213 pa_assert_ctl_context();
2214 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2216 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2218 if (s
->muted
== new_muted
)
2221 s
->muted
= new_muted
;
2222 s
->save_muted
= TRUE
;
2224 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2227 /* Called from main thread */
2228 pa_bool_t
pa_sink_update_proplist(pa_sink
*s
, pa_update_mode_t mode
, pa_proplist
*p
) {
2229 pa_sink_assert_ref(s
);
2230 pa_assert_ctl_context();
2233 pa_proplist_update(s
->proplist
, mode
, p
);
2235 if (PA_SINK_IS_LINKED(s
->state
)) {
2236 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2237 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2243 /* Called from main thread */
2244 /* FIXME -- this should be dropped and be merged into pa_sink_update_proplist() */
2245 void pa_sink_set_description(pa_sink
*s
, const char *description
) {
2247 pa_sink_assert_ref(s
);
2248 pa_assert_ctl_context();
2250 if (!description
&& !pa_proplist_contains(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
))
2253 old
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2255 if (old
&& description
&& pa_streq(old
, description
))
2259 pa_proplist_sets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
, description
);
2261 pa_proplist_unset(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2263 if (s
->monitor_source
) {
2266 n
= pa_sprintf_malloc("Monitor Source of %s", description
? description
: s
->name
);
2267 pa_source_set_description(s
->monitor_source
, n
);
2271 if (PA_SINK_IS_LINKED(s
->state
)) {
2272 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2273 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2277 /* Called from main thread */
2278 unsigned pa_sink_linked_by(pa_sink
*s
) {
2281 pa_sink_assert_ref(s
);
2282 pa_assert_ctl_context();
2283 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2285 ret
= pa_idxset_size(s
->inputs
);
2287 /* We add in the number of streams connected to us here. Please
2288 * note the asymmetry to pa_sink_used_by()! */
2290 if (s
->monitor_source
)
2291 ret
+= pa_source_linked_by(s
->monitor_source
);
2296 /* Called from main thread */
2297 unsigned pa_sink_used_by(pa_sink
*s
) {
2300 pa_sink_assert_ref(s
);
2301 pa_assert_ctl_context();
2302 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2304 ret
= pa_idxset_size(s
->inputs
);
2305 pa_assert(ret
>= s
->n_corked
);
2307 /* Streams connected to our monitor source do not matter for
2308 * pa_sink_used_by()!.*/
2310 return ret
- s
->n_corked
;
2313 /* Called from main thread */
2314 unsigned pa_sink_check_suspend(pa_sink
*s
) {
2319 pa_sink_assert_ref(s
);
2320 pa_assert_ctl_context();
2322 if (!PA_SINK_IS_LINKED(s
->state
))
2327 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2328 pa_sink_input_state_t st
;
2330 st
= pa_sink_input_get_state(i
);
2332 /* We do not assert here. It is perfectly valid for a sink input to
2333 * be in the INIT state (i.e. created, marked done but not yet put)
2334 * and we should not care if it's unlinked as it won't contribute
2335 * towards our busy status.
2337 if (!PA_SINK_INPUT_IS_LINKED(st
))
2340 if (st
== PA_SINK_INPUT_CORKED
)
2343 if (i
->flags
& PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND
)
2349 if (s
->monitor_source
)
2350 ret
+= pa_source_check_suspend(s
->monitor_source
);
2355 /* Called from the IO thread */
2356 static void sync_input_volumes_within_thread(pa_sink
*s
) {
2360 pa_sink_assert_ref(s
);
2361 pa_sink_assert_io_context(s
);
2363 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2364 if (pa_cvolume_equal(&i
->thread_info
.soft_volume
, &i
->soft_volume
))
2367 i
->thread_info
.soft_volume
= i
->soft_volume
;
2368 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
, FALSE
);
2372 /* Called from the IO thread. Only called for the root sink in volume sharing
2373 * cases, except for internal recursive calls. */
2374 static void set_shared_volume_within_thread(pa_sink
*s
) {
2375 pa_sink_input
*i
= NULL
;
2378 pa_sink_assert_ref(s
);
2380 PA_MSGOBJECT(s
)->process_msg(PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME_SYNCED
, NULL
, 0, NULL
);
2382 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2383 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2384 set_shared_volume_within_thread(i
->origin_sink
);
2388 /* Called from IO thread, except when it is not */
2389 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
2390 pa_sink
*s
= PA_SINK(o
);
2391 pa_sink_assert_ref(s
);
2393 switch ((pa_sink_message_t
) code
) {
2395 case PA_SINK_MESSAGE_ADD_INPUT
: {
2396 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2398 /* If you change anything here, make sure to change the
2399 * sink input handling a few lines down at
2400 * PA_SINK_MESSAGE_FINISH_MOVE, too. */
2402 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2404 /* Since the caller sleeps in pa_sink_input_put(), we can
2405 * safely access data outside of thread_info even though
2408 if ((i
->thread_info
.sync_prev
= i
->sync_prev
)) {
2409 pa_assert(i
->sink
== i
->thread_info
.sync_prev
->sink
);
2410 pa_assert(i
->sync_prev
->sync_next
== i
);
2411 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
;
2414 if ((i
->thread_info
.sync_next
= i
->sync_next
)) {
2415 pa_assert(i
->sink
== i
->thread_info
.sync_next
->sink
);
2416 pa_assert(i
->sync_next
->sync_prev
== i
);
2417 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
;
2420 pa_assert(!i
->thread_info
.attached
);
2421 i
->thread_info
.attached
= TRUE
;
2426 pa_sink_input_set_state_within_thread(i
, i
->state
);
2428 /* The requested latency of the sink input needs to be
2429 * fixed up and then configured on the sink */
2431 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2432 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2434 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2435 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2437 /* We don't rewind here automatically. This is left to the
2438 * sink input implementor because some sink inputs need a
2439 * slow start, i.e. need some time to buffer client
2440 * samples before beginning streaming. */
2442 /* FIXME: Actually rewinding should be requested before
2443 * updating the sink requested latency, because updating
2444 * the requested latency updates also max_rewind of the
2445 * sink. Now consider this: a sink has a 10 s buffer and
2446 * nobody has requested anything less. Then a new stream
2447 * appears while the sink buffer is full. The new stream
2448 * requests e.g. 100 ms latency. That request is forwarded
2449 * to the sink, so now max_rewind is 100 ms. When a rewind
2450 * is requested, the sink will only rewind 100 ms, and the
2451 * new stream will have to wait about 10 seconds before it
2452 * becomes audible. */
2454 /* In flat volume mode we need to update the volume as
2456 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2459 case PA_SINK_MESSAGE_REMOVE_INPUT
: {
2460 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2462 /* If you change anything here, make sure to change the
2463 * sink input handling a few lines down at
2464 * PA_SINK_MESSAGE_START_MOVE, too. */
2469 pa_sink_input_set_state_within_thread(i
, i
->state
);
2471 pa_assert(i
->thread_info
.attached
);
2472 i
->thread_info
.attached
= FALSE
;
2474 /* Since the caller sleeps in pa_sink_input_unlink(),
2475 * we can safely access data outside of thread_info even
2476 * though it is mutable */
2478 pa_assert(!i
->sync_prev
);
2479 pa_assert(!i
->sync_next
);
2481 if (i
->thread_info
.sync_prev
) {
2482 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
->thread_info
.sync_prev
->sync_next
;
2483 i
->thread_info
.sync_prev
= NULL
;
2486 if (i
->thread_info
.sync_next
) {
2487 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
->thread_info
.sync_next
->sync_prev
;
2488 i
->thread_info
.sync_next
= NULL
;
2491 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
2492 pa_sink_input_unref(i
);
2494 pa_sink_invalidate_requested_latency(s
, TRUE
);
2495 pa_sink_request_rewind(s
, (size_t) -1);
2497 /* In flat volume mode we need to update the volume as
2499 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2502 case PA_SINK_MESSAGE_START_MOVE
: {
2503 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2505 /* We don't support moving synchronized streams. */
2506 pa_assert(!i
->sync_prev
);
2507 pa_assert(!i
->sync_next
);
2508 pa_assert(!i
->thread_info
.sync_next
);
2509 pa_assert(!i
->thread_info
.sync_prev
);
2511 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2513 size_t sink_nbytes
, total_nbytes
;
2515 /* The old sink probably has some audio from this
2516 * stream in its buffer. We want to "take it back" as
2517 * much as possible and play it to the new sink. We
2518 * don't know at this point how much the old sink can
2519 * rewind. We have to pick something, and that
2520 * something is the full latency of the old sink here.
2521 * So we rewind the stream buffer by the sink latency
2522 * amount, which may be more than what we should
2523 * rewind. This can result in a chunk of audio being
2524 * played both to the old sink and the new sink.
2526 * FIXME: Fix this code so that we don't have to make
2527 * guesses about how much the sink will actually be
2528 * able to rewind. If someone comes up with a solution
2529 * for this, something to note is that the part of the
2530 * latency that the old sink couldn't rewind should
2531 * ideally be compensated after the stream has moved
2532 * to the new sink by adding silence. The new sink
2533 * most likely can't start playing the moved stream
2534 * immediately, and that gap should be removed from
2535 * the "compensation silence" (at least at the time of
2536 * writing this, the move finish code will actually
2537 * already take care of dropping the new sink's
2538 * unrewindable latency, so taking into account the
2539 * unrewindable latency of the old sink is the only
2542 * The render_memblockq contents are discarded,
2543 * because when the sink changes, the format of the
2544 * audio stored in the render_memblockq may change
2545 * too, making the stored audio invalid. FIXME:
2546 * However, the read and write indices are moved back
2547 * the same amount, so if they are not the same now,
2548 * they won't be the same after the rewind either. If
2549 * the write index of the render_memblockq is ahead of
2550 * the read index, then the render_memblockq will feed
2551 * the new sink some silence first, which it shouldn't
2552 * do. The write index should be flushed to be the
2553 * same as the read index. */
2555 /* Get the latency of the sink */
2556 usec
= pa_sink_get_latency_within_thread(s
);
2557 sink_nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2558 total_nbytes
= sink_nbytes
+ pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
2560 if (total_nbytes
> 0) {
2561 i
->thread_info
.rewrite_nbytes
= i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, total_nbytes
) : total_nbytes
;
2562 i
->thread_info
.rewrite_flush
= TRUE
;
2563 pa_sink_input_process_rewind(i
, sink_nbytes
);
2570 pa_assert(i
->thread_info
.attached
);
2571 i
->thread_info
.attached
= FALSE
;
2573 /* Let's remove the sink input ...*/
2574 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
2575 pa_sink_input_unref(i
);
2577 pa_sink_invalidate_requested_latency(s
, TRUE
);
2579 pa_log_debug("Requesting rewind due to started move");
2580 pa_sink_request_rewind(s
, (size_t) -1);
2582 /* In flat volume mode we need to update the volume as
2584 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2587 case PA_SINK_MESSAGE_FINISH_MOVE
: {
2588 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2590 /* We don't support moving synchronized streams. */
2591 pa_assert(!i
->sync_prev
);
2592 pa_assert(!i
->sync_next
);
2593 pa_assert(!i
->thread_info
.sync_next
);
2594 pa_assert(!i
->thread_info
.sync_prev
);
2596 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2598 pa_assert(!i
->thread_info
.attached
);
2599 i
->thread_info
.attached
= TRUE
;
2604 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2608 /* In the ideal case the new sink would start playing
2609 * the stream immediately. That requires the sink to
2610 * be able to rewind all of its latency, which usually
2611 * isn't possible, so there will probably be some gap
2612 * before the moved stream becomes audible. We then
2613 * have two possibilities: 1) start playing the stream
2614 * from where it is now, or 2) drop the unrewindable
2615 * latency of the sink from the stream. With option 1
2616 * we won't lose any audio but the stream will have a
2617 * pause. With option 2 we may lose some audio but the
2618 * stream time will be somewhat in sync with the wall
2619 * clock. Lennart seems to have chosen option 2 (one
2620 * of the reasons might have been that option 1 is
2621 * actually much harder to implement), so we drop the
2622 * latency of the new sink from the moved stream and
2623 * hope that the sink will undo most of that in the
2626 /* Get the latency of the sink */
2627 usec
= pa_sink_get_latency_within_thread(s
);
2628 nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2631 pa_sink_input_drop(i
, nbytes
);
2633 pa_log_debug("Requesting rewind due to finished move");
2634 pa_sink_request_rewind(s
, nbytes
);
2637 /* Updating the requested sink latency has to be done
2638 * after the sink rewind request, not before, because
2639 * otherwise the sink may limit the rewind amount
2642 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2643 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2645 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2646 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2648 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2651 case PA_SINK_MESSAGE_SET_SHARED_VOLUME
: {
2652 pa_sink
*root_sink
= pa_sink_get_master(s
);
2654 if (PA_LIKELY(root_sink
))
2655 set_shared_volume_within_thread(root_sink
);
2660 case PA_SINK_MESSAGE_SET_VOLUME_SYNCED
:
2662 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
2664 pa_sink_volume_change_push(s
);
2666 /* Fall through ... */
2668 case PA_SINK_MESSAGE_SET_VOLUME
:
2670 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2671 s
->thread_info
.soft_volume
= s
->soft_volume
;
2672 pa_sink_request_rewind(s
, (size_t) -1);
2675 /* Fall through ... */
2677 case PA_SINK_MESSAGE_SYNC_VOLUMES
:
2678 sync_input_volumes_within_thread(s
);
2681 case PA_SINK_MESSAGE_GET_VOLUME
:
2683 if ((s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
) {
2685 pa_sink_volume_change_flush(s
);
2686 pa_sw_cvolume_divide(&s
->thread_info
.current_hw_volume
, &s
->real_volume
, &s
->soft_volume
);
2689 /* In case sink implementor reset SW volume. */
2690 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2691 s
->thread_info
.soft_volume
= s
->soft_volume
;
2692 pa_sink_request_rewind(s
, (size_t) -1);
2697 case PA_SINK_MESSAGE_SET_MUTE
:
2699 if (s
->thread_info
.soft_muted
!= s
->muted
) {
2700 s
->thread_info
.soft_muted
= s
->muted
;
2701 pa_sink_request_rewind(s
, (size_t) -1);
2704 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->set_mute
)
2709 case PA_SINK_MESSAGE_GET_MUTE
:
2711 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->get_mute
)
2716 case PA_SINK_MESSAGE_SET_STATE
: {
2718 pa_bool_t suspend_change
=
2719 (s
->thread_info
.state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(PA_PTR_TO_UINT(userdata
))) ||
2720 (PA_SINK_IS_OPENED(s
->thread_info
.state
) && PA_PTR_TO_UINT(userdata
) == PA_SINK_SUSPENDED
);
2722 s
->thread_info
.state
= PA_PTR_TO_UINT(userdata
);
2724 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
2725 s
->thread_info
.rewind_nbytes
= 0;
2726 s
->thread_info
.rewind_requested
= FALSE
;
2729 if (suspend_change
) {
2733 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
2734 if (i
->suspend_within_thread
)
2735 i
->suspend_within_thread(i
, s
->thread_info
.state
== PA_SINK_SUSPENDED
);
2741 case PA_SINK_MESSAGE_DETACH
:
2743 /* Detach all streams */
2744 pa_sink_detach_within_thread(s
);
2747 case PA_SINK_MESSAGE_ATTACH
:
2749 /* Reattach all streams */
2750 pa_sink_attach_within_thread(s
);
2753 case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
: {
2755 pa_usec_t
*usec
= userdata
;
2756 *usec
= pa_sink_get_requested_latency_within_thread(s
);
2758 /* Yes, that's right, the IO thread will see -1 when no
2759 * explicit requested latency is configured, the main
2760 * thread will see max_latency */
2761 if (*usec
== (pa_usec_t
) -1)
2762 *usec
= s
->thread_info
.max_latency
;
2767 case PA_SINK_MESSAGE_SET_LATENCY_RANGE
: {
2768 pa_usec_t
*r
= userdata
;
2770 pa_sink_set_latency_range_within_thread(s
, r
[0], r
[1]);
2775 case PA_SINK_MESSAGE_GET_LATENCY_RANGE
: {
2776 pa_usec_t
*r
= userdata
;
2778 r
[0] = s
->thread_info
.min_latency
;
2779 r
[1] = s
->thread_info
.max_latency
;
2784 case PA_SINK_MESSAGE_GET_FIXED_LATENCY
:
2786 *((pa_usec_t
*) userdata
) = s
->thread_info
.fixed_latency
;
2789 case PA_SINK_MESSAGE_SET_FIXED_LATENCY
:
2791 pa_sink_set_fixed_latency_within_thread(s
, (pa_usec_t
) offset
);
2794 case PA_SINK_MESSAGE_GET_MAX_REWIND
:
2796 *((size_t*) userdata
) = s
->thread_info
.max_rewind
;
2799 case PA_SINK_MESSAGE_GET_MAX_REQUEST
:
2801 *((size_t*) userdata
) = s
->thread_info
.max_request
;
2804 case PA_SINK_MESSAGE_SET_MAX_REWIND
:
2806 pa_sink_set_max_rewind_within_thread(s
, (size_t) offset
);
2809 case PA_SINK_MESSAGE_SET_MAX_REQUEST
:
2811 pa_sink_set_max_request_within_thread(s
, (size_t) offset
);
2814 case PA_SINK_MESSAGE_SET_PORT
:
2816 pa_assert(userdata
);
2818 struct sink_message_set_port
*msg_data
= userdata
;
2819 msg_data
->ret
= s
->set_port(s
, msg_data
->port
);
2823 case PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
:
2824 /* This message is sent from IO-thread and handled in main thread. */
2825 pa_assert_ctl_context();
2827 /* Make sure we're not messing with main thread when no longer linked */
2828 if (!PA_SINK_IS_LINKED(s
->state
))
2831 pa_sink_get_volume(s
, TRUE
);
2832 pa_sink_get_mute(s
, TRUE
);
2835 case PA_SINK_MESSAGE_SET_LATENCY_OFFSET
:
2836 s
->thread_info
.latency_offset
= offset
;
2839 case PA_SINK_MESSAGE_GET_LATENCY
:
2840 case PA_SINK_MESSAGE_MAX
:
2847 /* Called from main thread */
2848 int pa_sink_suspend_all(pa_core
*c
, pa_bool_t suspend
, pa_suspend_cause_t cause
) {
2853 pa_core_assert_ref(c
);
2854 pa_assert_ctl_context();
2855 pa_assert(cause
!= 0);
2857 PA_IDXSET_FOREACH(sink
, c
->sinks
, idx
) {
2860 if ((r
= pa_sink_suspend(sink
, suspend
, cause
)) < 0)
2867 /* Called from main thread */
2868 void pa_sink_detach(pa_sink
*s
) {
2869 pa_sink_assert_ref(s
);
2870 pa_assert_ctl_context();
2871 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2873 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_DETACH
, NULL
, 0, NULL
) == 0);
2876 /* Called from main thread */
2877 void pa_sink_attach(pa_sink
*s
) {
2878 pa_sink_assert_ref(s
);
2879 pa_assert_ctl_context();
2880 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2882 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_ATTACH
, NULL
, 0, NULL
) == 0);
2885 /* Called from IO thread */
2886 void pa_sink_detach_within_thread(pa_sink
*s
) {
2890 pa_sink_assert_ref(s
);
2891 pa_sink_assert_io_context(s
);
2892 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2894 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2898 if (s
->monitor_source
)
2899 pa_source_detach_within_thread(s
->monitor_source
);
2902 /* Called from IO thread */
2903 void pa_sink_attach_within_thread(pa_sink
*s
) {
2907 pa_sink_assert_ref(s
);
2908 pa_sink_assert_io_context(s
);
2909 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2911 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2915 if (s
->monitor_source
)
2916 pa_source_attach_within_thread(s
->monitor_source
);
2919 /* Called from IO thread */
2920 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
) {
2921 pa_sink_assert_ref(s
);
2922 pa_sink_assert_io_context(s
);
2923 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2925 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
2928 if (nbytes
== (size_t) -1)
2929 nbytes
= s
->thread_info
.max_rewind
;
2931 nbytes
= PA_MIN(nbytes
, s
->thread_info
.max_rewind
);
2933 if (s
->thread_info
.rewind_requested
&&
2934 nbytes
<= s
->thread_info
.rewind_nbytes
)
2937 s
->thread_info
.rewind_nbytes
= nbytes
;
2938 s
->thread_info
.rewind_requested
= TRUE
;
2940 if (s
->request_rewind
)
2941 s
->request_rewind(s
);
2944 /* Called from IO thread */
2945 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
) {
2946 pa_usec_t result
= (pa_usec_t
) -1;
2949 pa_usec_t monitor_latency
;
2951 pa_sink_assert_ref(s
);
2952 pa_sink_assert_io_context(s
);
2954 if (!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
2955 return PA_CLAMP(s
->thread_info
.fixed_latency
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
2957 if (s
->thread_info
.requested_latency_valid
)
2958 return s
->thread_info
.requested_latency
;
2960 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2961 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1 &&
2962 (result
== (pa_usec_t
) -1 || result
> i
->thread_info
.requested_sink_latency
))
2963 result
= i
->thread_info
.requested_sink_latency
;
2965 monitor_latency
= pa_source_get_requested_latency_within_thread(s
->monitor_source
);
2967 if (monitor_latency
!= (pa_usec_t
) -1 &&
2968 (result
== (pa_usec_t
) -1 || result
> monitor_latency
))
2969 result
= monitor_latency
;
2971 if (result
!= (pa_usec_t
) -1)
2972 result
= PA_CLAMP(result
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
2974 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
2975 /* Only cache if properly initialized */
2976 s
->thread_info
.requested_latency
= result
;
2977 s
->thread_info
.requested_latency_valid
= TRUE
;
2983 /* Called from main thread */
2984 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
) {
2987 pa_sink_assert_ref(s
);
2988 pa_assert_ctl_context();
2989 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2991 if (s
->state
== PA_SINK_SUSPENDED
)
2994 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
2999 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3000 void pa_sink_set_max_rewind_within_thread(pa_sink
*s
, size_t max_rewind
) {
3004 pa_sink_assert_ref(s
);
3005 pa_sink_assert_io_context(s
);
3007 if (max_rewind
== s
->thread_info
.max_rewind
)
3010 s
->thread_info
.max_rewind
= max_rewind
;
3012 if (PA_SINK_IS_LINKED(s
->thread_info
.state
))
3013 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3014 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
3016 if (s
->monitor_source
)
3017 pa_source_set_max_rewind_within_thread(s
->monitor_source
, s
->thread_info
.max_rewind
);
3020 /* Called from main thread */
3021 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
) {
3022 pa_sink_assert_ref(s
);
3023 pa_assert_ctl_context();
3025 if (PA_SINK_IS_LINKED(s
->state
))
3026 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REWIND
, NULL
, max_rewind
, NULL
) == 0);
3028 pa_sink_set_max_rewind_within_thread(s
, max_rewind
);
3031 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3032 void pa_sink_set_max_request_within_thread(pa_sink
*s
, size_t max_request
) {
3035 pa_sink_assert_ref(s
);
3036 pa_sink_assert_io_context(s
);
3038 if (max_request
== s
->thread_info
.max_request
)
3041 s
->thread_info
.max_request
= max_request
;
3043 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3046 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3047 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
3051 /* Called from main thread */
3052 void pa_sink_set_max_request(pa_sink
*s
, size_t max_request
) {
3053 pa_sink_assert_ref(s
);
3054 pa_assert_ctl_context();
3056 if (PA_SINK_IS_LINKED(s
->state
))
3057 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REQUEST
, NULL
, max_request
, NULL
) == 0);
3059 pa_sink_set_max_request_within_thread(s
, max_request
);
3062 /* Called from IO thread */
3063 void pa_sink_invalidate_requested_latency(pa_sink
*s
, pa_bool_t dynamic
) {
3067 pa_sink_assert_ref(s
);
3068 pa_sink_assert_io_context(s
);
3070 if ((s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
3071 s
->thread_info
.requested_latency_valid
= FALSE
;
3075 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3077 if (s
->update_requested_latency
)
3078 s
->update_requested_latency(s
);
3080 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3081 if (i
->update_sink_requested_latency
)
3082 i
->update_sink_requested_latency(i
);
3086 /* Called from main thread */
3087 void pa_sink_set_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3088 pa_sink_assert_ref(s
);
3089 pa_assert_ctl_context();
3091 /* min_latency == 0: no limit
3092 * min_latency anything else: specified limit
3094 * Similar for max_latency */
3096 if (min_latency
< ABSOLUTE_MIN_LATENCY
)
3097 min_latency
= ABSOLUTE_MIN_LATENCY
;
3099 if (max_latency
<= 0 ||
3100 max_latency
> ABSOLUTE_MAX_LATENCY
)
3101 max_latency
= ABSOLUTE_MAX_LATENCY
;
3103 pa_assert(min_latency
<= max_latency
);
3105 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3106 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3107 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3108 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3110 if (PA_SINK_IS_LINKED(s
->state
)) {
3116 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3118 pa_sink_set_latency_range_within_thread(s
, min_latency
, max_latency
);
3121 /* Called from main thread */
3122 void pa_sink_get_latency_range(pa_sink
*s
, pa_usec_t
*min_latency
, pa_usec_t
*max_latency
) {
3123 pa_sink_assert_ref(s
);
3124 pa_assert_ctl_context();
3125 pa_assert(min_latency
);
3126 pa_assert(max_latency
);
3128 if (PA_SINK_IS_LINKED(s
->state
)) {
3129 pa_usec_t r
[2] = { 0, 0 };
3131 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3133 *min_latency
= r
[0];
3134 *max_latency
= r
[1];
3136 *min_latency
= s
->thread_info
.min_latency
;
3137 *max_latency
= s
->thread_info
.max_latency
;
3141 /* Called from IO thread */
3142 void pa_sink_set_latency_range_within_thread(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3143 pa_sink_assert_ref(s
);
3144 pa_sink_assert_io_context(s
);
3146 pa_assert(min_latency
>= ABSOLUTE_MIN_LATENCY
);
3147 pa_assert(max_latency
<= ABSOLUTE_MAX_LATENCY
);
3148 pa_assert(min_latency
<= max_latency
);
3150 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3151 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3152 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3153 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3155 if (s
->thread_info
.min_latency
== min_latency
&&
3156 s
->thread_info
.max_latency
== max_latency
)
3159 s
->thread_info
.min_latency
= min_latency
;
3160 s
->thread_info
.max_latency
= max_latency
;
3162 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3166 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3167 if (i
->update_sink_latency_range
)
3168 i
->update_sink_latency_range(i
);
3171 pa_sink_invalidate_requested_latency(s
, FALSE
);
3173 pa_source_set_latency_range_within_thread(s
->monitor_source
, min_latency
, max_latency
);
3176 /* Called from main thread */
3177 void pa_sink_set_fixed_latency(pa_sink
*s
, pa_usec_t latency
) {
3178 pa_sink_assert_ref(s
);
3179 pa_assert_ctl_context();
3181 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3182 pa_assert(latency
== 0);
3186 if (latency
< ABSOLUTE_MIN_LATENCY
)
3187 latency
= ABSOLUTE_MIN_LATENCY
;
3189 if (latency
> ABSOLUTE_MAX_LATENCY
)
3190 latency
= ABSOLUTE_MAX_LATENCY
;
3192 if (PA_SINK_IS_LINKED(s
->state
))
3193 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_FIXED_LATENCY
, NULL
, (int64_t) latency
, NULL
) == 0);
3195 s
->thread_info
.fixed_latency
= latency
;
3197 pa_source_set_fixed_latency(s
->monitor_source
, latency
);
3200 /* Called from main thread */
3201 pa_usec_t
pa_sink_get_fixed_latency(pa_sink
*s
) {
3204 pa_sink_assert_ref(s
);
3205 pa_assert_ctl_context();
3207 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
)
3210 if (PA_SINK_IS_LINKED(s
->state
))
3211 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_FIXED_LATENCY
, &latency
, 0, NULL
) == 0);
3213 latency
= s
->thread_info
.fixed_latency
;
3218 /* Called from IO thread */
3219 void pa_sink_set_fixed_latency_within_thread(pa_sink
*s
, pa_usec_t latency
) {
3220 pa_sink_assert_ref(s
);
3221 pa_sink_assert_io_context(s
);
3223 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3224 pa_assert(latency
== 0);
3228 pa_assert(latency
>= ABSOLUTE_MIN_LATENCY
);
3229 pa_assert(latency
<= ABSOLUTE_MAX_LATENCY
);
3231 if (s
->thread_info
.fixed_latency
== latency
)
3234 s
->thread_info
.fixed_latency
= latency
;
3236 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3240 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3241 if (i
->update_sink_fixed_latency
)
3242 i
->update_sink_fixed_latency(i
);
3245 pa_sink_invalidate_requested_latency(s
, FALSE
);
3247 pa_source_set_fixed_latency_within_thread(s
->monitor_source
, latency
);
3250 /* Called from main context */
3251 void pa_sink_set_latency_offset(pa_sink
*s
, int64_t offset
) {
3252 pa_sink_assert_ref(s
);
3254 s
->latency_offset
= offset
;
3256 if (PA_SINK_IS_LINKED(s
->state
))
3257 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_LATENCY_OFFSET
, NULL
, offset
, NULL
) == 0);
3259 s
->thread_info
.latency_offset
= offset
;
3262 /* Called from main context */
3263 size_t pa_sink_get_max_rewind(pa_sink
*s
) {
3265 pa_assert_ctl_context();
3266 pa_sink_assert_ref(s
);
3268 if (!PA_SINK_IS_LINKED(s
->state
))
3269 return s
->thread_info
.max_rewind
;
3271 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REWIND
, &r
, 0, NULL
) == 0);
3276 /* Called from main context */
3277 size_t pa_sink_get_max_request(pa_sink
*s
) {
3279 pa_sink_assert_ref(s
);
3280 pa_assert_ctl_context();
3282 if (!PA_SINK_IS_LINKED(s
->state
))
3283 return s
->thread_info
.max_request
;
3285 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REQUEST
, &r
, 0, NULL
) == 0);
3290 /* Called from main context */
3291 int pa_sink_set_port(pa_sink
*s
, const char *name
, pa_bool_t save
) {
3292 pa_device_port
*port
;
3295 pa_sink_assert_ref(s
);
3296 pa_assert_ctl_context();
3299 pa_log_debug("set_port() operation not implemented for sink %u \"%s\"", s
->index
, s
->name
);
3300 return -PA_ERR_NOTIMPLEMENTED
;
3303 if (!s
->ports
|| !name
)
3304 return -PA_ERR_NOENTITY
;
3306 if (!(port
= pa_hashmap_get(s
->ports
, name
)))
3307 return -PA_ERR_NOENTITY
;
3309 if (s
->active_port
== port
) {
3310 s
->save_port
= s
->save_port
|| save
;
3314 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
3315 struct sink_message_set_port msg
= { .port
= port
, .ret
= 0 };
3316 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_PORT
, &msg
, 0, NULL
) == 0);
3320 ret
= s
->set_port(s
, port
);
3323 return -PA_ERR_NOENTITY
;
3325 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
3327 pa_log_info("Changed port of sink %u \"%s\" to %s", s
->index
, s
->name
, port
->name
);
3329 s
->active_port
= port
;
3330 s
->save_port
= save
;
3332 pa_sink_set_latency_offset(s
, s
->active_port
->latency_offset
);
3334 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PORT_CHANGED
], s
);
3339 pa_bool_t
pa_device_init_icon(pa_proplist
*p
, pa_bool_t is_sink
) {
3340 const char *ff
, *c
, *t
= NULL
, *s
= "", *profile
, *bus
;
3344 if (pa_proplist_contains(p
, PA_PROP_DEVICE_ICON_NAME
))
3347 if ((ff
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3349 if (pa_streq(ff
, "microphone"))
3350 t
= "audio-input-microphone";
3351 else if (pa_streq(ff
, "webcam"))
3353 else if (pa_streq(ff
, "computer"))
3355 else if (pa_streq(ff
, "handset"))
3357 else if (pa_streq(ff
, "portable"))
3358 t
= "multimedia-player";
3359 else if (pa_streq(ff
, "tv"))
3360 t
= "video-display";
3363 * The following icons are not part of the icon naming spec,
3364 * because Rodney Dawes sucks as the maintainer of that spec.
3366 * http://lists.freedesktop.org/archives/xdg/2009-May/010397.html
3368 else if (pa_streq(ff
, "headset"))
3369 t
= "audio-headset";
3370 else if (pa_streq(ff
, "headphone"))
3371 t
= "audio-headphones";
3372 else if (pa_streq(ff
, "speaker"))
3373 t
= "audio-speakers";
3374 else if (pa_streq(ff
, "hands-free"))
3375 t
= "audio-handsfree";
3379 if ((c
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3380 if (pa_streq(c
, "modem"))
3387 t
= "audio-input-microphone";
3390 if ((profile
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3391 if (strstr(profile
, "analog"))
3393 else if (strstr(profile
, "iec958"))
3395 else if (strstr(profile
, "hdmi"))
3399 bus
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
);
3401 pa_proplist_setf(p
, PA_PROP_DEVICE_ICON_NAME
, "%s%s%s%s", t
, pa_strempty(s
), bus
? "-" : "", pa_strempty(bus
));
3406 pa_bool_t
pa_device_init_description(pa_proplist
*p
) {
3407 const char *s
, *d
= NULL
, *k
;
3410 if (pa_proplist_contains(p
, PA_PROP_DEVICE_DESCRIPTION
))
3413 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3414 if (pa_streq(s
, "internal"))
3415 d
= _("Built-in Audio");
3418 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3419 if (pa_streq(s
, "modem"))
3423 d
= pa_proplist_gets(p
, PA_PROP_DEVICE_PRODUCT_NAME
);
3428 k
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_DESCRIPTION
);
3431 pa_proplist_setf(p
, PA_PROP_DEVICE_DESCRIPTION
, "%s %s", d
, k
);
3433 pa_proplist_sets(p
, PA_PROP_DEVICE_DESCRIPTION
, d
);
3438 pa_bool_t
pa_device_init_intended_roles(pa_proplist
*p
) {
3442 if (pa_proplist_contains(p
, PA_PROP_DEVICE_INTENDED_ROLES
))
3445 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3446 if (pa_streq(s
, "handset") || pa_streq(s
, "hands-free")
3447 || pa_streq(s
, "headset")) {
3448 pa_proplist_sets(p
, PA_PROP_DEVICE_INTENDED_ROLES
, "phone");
3455 unsigned pa_device_init_priority(pa_proplist
*p
) {
3457 unsigned priority
= 0;
3461 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
))) {
3463 if (pa_streq(s
, "sound"))
3465 else if (!pa_streq(s
, "modem"))
3469 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3471 if (pa_streq(s
, "internal"))
3473 else if (pa_streq(s
, "speaker"))
3475 else if (pa_streq(s
, "headphone"))
3479 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
))) {
3481 if (pa_streq(s
, "pci"))
3483 else if (pa_streq(s
, "usb"))
3485 else if (pa_streq(s
, "bluetooth"))
3489 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3491 if (pa_startswith(s
, "analog-"))
3493 else if (pa_startswith(s
, "iec958-"))
3500 PA_STATIC_FLIST_DECLARE(pa_sink_volume_change
, 0, pa_xfree
);
3502 /* Called from the IO thread. */
3503 static pa_sink_volume_change
*pa_sink_volume_change_new(pa_sink
*s
) {
3504 pa_sink_volume_change
*c
;
3505 if (!(c
= pa_flist_pop(PA_STATIC_FLIST_GET(pa_sink_volume_change
))))
3506 c
= pa_xnew(pa_sink_volume_change
, 1);
3508 PA_LLIST_INIT(pa_sink_volume_change
, c
);
3510 pa_cvolume_reset(&c
->hw_volume
, s
->sample_spec
.channels
);
3514 /* Called from the IO thread. */
3515 static void pa_sink_volume_change_free(pa_sink_volume_change
*c
) {
3517 if (pa_flist_push(PA_STATIC_FLIST_GET(pa_sink_volume_change
), c
) < 0)
3521 /* Called from the IO thread. */
3522 void pa_sink_volume_change_push(pa_sink
*s
) {
3523 pa_sink_volume_change
*c
= NULL
;
3524 pa_sink_volume_change
*nc
= NULL
;
3525 uint32_t safety_margin
= s
->thread_info
.volume_change_safety_margin
;
3527 const char *direction
= NULL
;
3530 nc
= pa_sink_volume_change_new(s
);
3532 /* NOTE: There is already more different volumes in pa_sink that I can remember.
3533 * Adding one more volume for HW would get us rid of this, but I am trying
3534 * to survive with the ones we already have. */
3535 pa_sw_cvolume_divide(&nc
->hw_volume
, &s
->real_volume
, &s
->soft_volume
);
3537 if (!s
->thread_info
.volume_changes
&& pa_cvolume_equal(&nc
->hw_volume
, &s
->thread_info
.current_hw_volume
)) {
3538 pa_log_debug("Volume not changing");
3539 pa_sink_volume_change_free(nc
);
3543 nc
->at
= pa_sink_get_latency_within_thread(s
);
3544 nc
->at
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3546 if (s
->thread_info
.volume_changes_tail
) {
3547 for (c
= s
->thread_info
.volume_changes_tail
; c
; c
= c
->prev
) {
3548 /* If volume is going up let's do it a bit late. If it is going
3549 * down let's do it a bit early. */
3550 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&c
->hw_volume
)) {
3551 if (nc
->at
+ safety_margin
> c
->at
) {
3552 nc
->at
+= safety_margin
;
3557 else if (nc
->at
- safety_margin
> c
->at
) {
3558 nc
->at
-= safety_margin
;
3566 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&s
->thread_info
.current_hw_volume
)) {
3567 nc
->at
+= safety_margin
;
3570 nc
->at
-= safety_margin
;
3573 PA_LLIST_PREPEND(pa_sink_volume_change
, s
->thread_info
.volume_changes
, nc
);
3576 PA_LLIST_INSERT_AFTER(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
, nc
);
3579 pa_log_debug("Volume going %s to %d at %llu", direction
, pa_cvolume_avg(&nc
->hw_volume
), (long long unsigned) nc
->at
);
3581 /* We can ignore volume events that came earlier but should happen later than this. */
3582 PA_LLIST_FOREACH(c
, nc
->next
) {
3583 pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
);
3584 pa_sink_volume_change_free(c
);
3587 s
->thread_info
.volume_changes_tail
= nc
;
3590 /* Called from the IO thread. */
3591 static void pa_sink_volume_change_flush(pa_sink
*s
) {
3592 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3594 s
->thread_info
.volume_changes
= NULL
;
3595 s
->thread_info
.volume_changes_tail
= NULL
;
3597 pa_sink_volume_change
*next
= c
->next
;
3598 pa_sink_volume_change_free(c
);
3603 /* Called from the IO thread. */
3604 pa_bool_t
pa_sink_volume_change_apply(pa_sink
*s
, pa_usec_t
*usec_to_next
) {
3606 pa_bool_t ret
= FALSE
;
3610 if (!s
->thread_info
.volume_changes
|| !PA_SINK_IS_LINKED(s
->state
)) {
3616 pa_assert(s
->write_volume
);
3618 now
= pa_rtclock_now();
3620 while (s
->thread_info
.volume_changes
&& now
>= s
->thread_info
.volume_changes
->at
) {
3621 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3622 PA_LLIST_REMOVE(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
);
3623 pa_log_debug("Volume change to %d at %llu was written %llu usec late",
3624 pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
, (long long unsigned) (now
- c
->at
));
3626 s
->thread_info
.current_hw_volume
= c
->hw_volume
;
3627 pa_sink_volume_change_free(c
);
3633 if (s
->thread_info
.volume_changes
) {
3635 *usec_to_next
= s
->thread_info
.volume_changes
->at
- now
;
3636 if (pa_log_ratelimit(PA_LOG_DEBUG
))
3637 pa_log_debug("Next volume change in %lld usec", (long long) (s
->thread_info
.volume_changes
->at
- now
));
3642 s
->thread_info
.volume_changes_tail
= NULL
;
3647 /* Called from the IO thread. */
3648 static void pa_sink_volume_change_rewind(pa_sink
*s
, size_t nbytes
) {
3649 /* All the queued volume events later than current latency are shifted to happen earlier. */
3650 pa_sink_volume_change
*c
;
3651 pa_volume_t prev_vol
= pa_cvolume_avg(&s
->thread_info
.current_hw_volume
);
3652 pa_usec_t rewound
= pa_bytes_to_usec(nbytes
, &s
->sample_spec
);
3653 pa_usec_t limit
= pa_sink_get_latency_within_thread(s
);
3655 pa_log_debug("latency = %lld", (long long) limit
);
3656 limit
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3658 PA_LLIST_FOREACH(c
, s
->thread_info
.volume_changes
) {
3659 pa_usec_t modified_limit
= limit
;
3660 if (prev_vol
> pa_cvolume_avg(&c
->hw_volume
))
3661 modified_limit
-= s
->thread_info
.volume_change_safety_margin
;
3663 modified_limit
+= s
->thread_info
.volume_change_safety_margin
;
3664 if (c
->at
> modified_limit
) {
3666 if (c
->at
< modified_limit
)
3667 c
->at
= modified_limit
;
3669 prev_vol
= pa_cvolume_avg(&c
->hw_volume
);
3671 pa_sink_volume_change_apply(s
, NULL
);
3674 /* Called from the main thread */
3675 /* Gets the list of formats supported by the sink. The members and idxset must
3676 * be freed by the caller. */
3677 pa_idxset
* pa_sink_get_formats(pa_sink
*s
) {
3682 if (s
->get_formats
) {
3683 /* Sink supports format query, all is good */
3684 ret
= s
->get_formats(s
);
3686 /* Sink doesn't support format query, so assume it does PCM */
3687 pa_format_info
*f
= pa_format_info_new();
3688 f
->encoding
= PA_ENCODING_PCM
;
3690 ret
= pa_idxset_new(NULL
, NULL
);
3691 pa_idxset_put(ret
, f
, NULL
);
3697 /* Called from the main thread */
3698 /* Allows an external source to set what formats a sink supports if the sink
3699 * permits this. The function makes a copy of the formats on success. */
3700 pa_bool_t
pa_sink_set_formats(pa_sink
*s
, pa_idxset
*formats
) {
3705 /* Sink supports setting formats -- let's give it a shot */
3706 return s
->set_formats(s
, formats
);
3708 /* Sink doesn't support setting this -- bail out */
3712 /* Called from the main thread */
3713 /* Checks if the sink can accept this format */
3714 pa_bool_t
pa_sink_check_format(pa_sink
*s
, pa_format_info
*f
)
3716 pa_idxset
*formats
= NULL
;
3717 pa_bool_t ret
= FALSE
;
3722 formats
= pa_sink_get_formats(s
);
3725 pa_format_info
*finfo_device
;
3728 PA_IDXSET_FOREACH(finfo_device
, formats
, i
) {
3729 if (pa_format_info_is_compatible(finfo_device
, f
)) {
3735 pa_idxset_free(formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);
3741 /* Called from the main thread */
3742 /* Calculates the intersection between formats supported by the sink and
3743 * in_formats, and returns these, in the order of the sink's formats. */
3744 pa_idxset
* pa_sink_check_formats(pa_sink
*s
, pa_idxset
*in_formats
) {
3745 pa_idxset
*out_formats
= pa_idxset_new(NULL
, NULL
), *sink_formats
= NULL
;
3746 pa_format_info
*f_sink
, *f_in
;
3751 if (!in_formats
|| pa_idxset_isempty(in_formats
))
3754 sink_formats
= pa_sink_get_formats(s
);
3756 PA_IDXSET_FOREACH(f_sink
, sink_formats
, i
) {
3757 PA_IDXSET_FOREACH(f_in
, in_formats
, j
) {
3758 if (pa_format_info_is_compatible(f_sink
, f_in
))
3759 pa_idxset_put(out_formats
, pa_format_info_copy(f_in
), NULL
);
3765 pa_idxset_free(sink_formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);