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
);
145 while ((p
= pa_hashmap_steal_first(data
->ports
)))
146 pa_device_port_free(p
);
148 pa_hashmap_free(data
->ports
, NULL
, NULL
);
151 pa_xfree(data
->name
);
152 pa_xfree(data
->active_port
);
155 pa_device_port
*pa_device_port_new(const char *name
, const char *description
, size_t extra
) {
160 p
= pa_xmalloc(PA_ALIGN(sizeof(pa_device_port
)) + extra
);
161 p
->name
= pa_xstrdup(name
);
162 p
->description
= pa_xstrdup(description
);
169 void pa_device_port_free(pa_device_port
*p
) {
173 pa_xfree(p
->description
);
177 /* Called from main context */
178 static void reset_callbacks(pa_sink
*s
) {
182 s
->get_volume
= NULL
;
183 s
->set_volume
= NULL
;
184 s
->write_volume
= NULL
;
187 s
->request_rewind
= NULL
;
188 s
->update_requested_latency
= NULL
;
190 s
->get_formats
= NULL
;
191 s
->set_formats
= NULL
;
192 s
->update_rate
= NULL
;
195 /* Called from main context */
196 pa_sink
* pa_sink_new(
198 pa_sink_new_data
*data
,
199 pa_sink_flags_t flags
) {
203 char st
[PA_SAMPLE_SPEC_SNPRINT_MAX
], cm
[PA_CHANNEL_MAP_SNPRINT_MAX
];
204 pa_source_new_data source_data
;
210 pa_assert(data
->name
);
211 pa_assert_ctl_context();
213 s
= pa_msgobject_new(pa_sink
);
215 if (!(name
= pa_namereg_register(core
, data
->name
, PA_NAMEREG_SINK
, s
, data
->namereg_fail
))) {
216 pa_log_debug("Failed to register name %s.", data
->name
);
221 pa_sink_new_data_set_name(data
, name
);
223 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_NEW
], data
) < 0) {
225 pa_namereg_unregister(core
, name
);
229 /* FIXME, need to free s here on failure */
231 pa_return_null_if_fail(!data
->driver
|| pa_utf8_valid(data
->driver
));
232 pa_return_null_if_fail(data
->name
&& pa_utf8_valid(data
->name
) && data
->name
[0]);
234 pa_return_null_if_fail(data
->sample_spec_is_set
&& pa_sample_spec_valid(&data
->sample_spec
));
236 if (!data
->channel_map_is_set
)
237 pa_return_null_if_fail(pa_channel_map_init_auto(&data
->channel_map
, data
->sample_spec
.channels
, PA_CHANNEL_MAP_DEFAULT
));
239 pa_return_null_if_fail(pa_channel_map_valid(&data
->channel_map
));
240 pa_return_null_if_fail(data
->channel_map
.channels
== data
->sample_spec
.channels
);
242 /* FIXME: There should probably be a general function for checking whether
243 * the sink volume is allowed to be set, like there is for sink inputs. */
244 pa_assert(!data
->volume_is_set
|| !(flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
246 if (!data
->volume_is_set
) {
247 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
248 data
->save_volume
= FALSE
;
251 pa_return_null_if_fail(pa_cvolume_valid(&data
->volume
));
252 pa_return_null_if_fail(pa_cvolume_compatible(&data
->volume
, &data
->sample_spec
));
254 if (!data
->muted_is_set
)
258 pa_proplist_update(data
->proplist
, PA_UPDATE_MERGE
, data
->card
->proplist
);
260 pa_device_init_description(data
->proplist
);
261 pa_device_init_icon(data
->proplist
, TRUE
);
262 pa_device_init_intended_roles(data
->proplist
);
264 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_FIXATE
], data
) < 0) {
266 pa_namereg_unregister(core
, name
);
270 s
->parent
.parent
.free
= sink_free
;
271 s
->parent
.process_msg
= pa_sink_process_msg
;
274 s
->state
= PA_SINK_INIT
;
277 s
->suspend_cause
= 0;
278 s
->name
= pa_xstrdup(name
);
279 s
->proplist
= pa_proplist_copy(data
->proplist
);
280 s
->driver
= pa_xstrdup(pa_path_get_filename(data
->driver
));
281 s
->module
= data
->module
;
282 s
->card
= data
->card
;
284 s
->priority
= pa_device_init_priority(s
->proplist
);
286 s
->sample_spec
= data
->sample_spec
;
287 s
->channel_map
= data
->channel_map
;
288 s
->default_sample_rate
= s
->sample_spec
.rate
;
290 if (data
->alternate_sample_rate_is_set
)
291 s
->alternate_sample_rate
= data
->alternate_sample_rate
;
293 s
->alternate_sample_rate
= s
->core
->alternate_sample_rate
;
295 if (s
->sample_spec
.rate
== s
->alternate_sample_rate
) {
296 pa_log_warn("Default and alternate sample rates are the same.");
297 s
->alternate_sample_rate
= 0;
300 s
->inputs
= pa_idxset_new(NULL
, NULL
);
302 s
->input_to_master
= NULL
;
304 s
->reference_volume
= s
->real_volume
= data
->volume
;
305 pa_cvolume_reset(&s
->soft_volume
, s
->sample_spec
.channels
);
306 s
->base_volume
= PA_VOLUME_NORM
;
307 s
->n_volume_steps
= PA_VOLUME_NORM
+1;
308 s
->muted
= data
->muted
;
309 s
->refresh_volume
= s
->refresh_muted
= FALSE
;
316 /* As a minor optimization we just steal the list instead of
318 s
->ports
= data
->ports
;
321 s
->active_port
= NULL
;
322 s
->save_port
= FALSE
;
324 if (data
->active_port
&& s
->ports
)
325 if ((s
->active_port
= pa_hashmap_get(s
->ports
, data
->active_port
)))
326 s
->save_port
= data
->save_port
;
328 if (!s
->active_port
&& s
->ports
) {
332 PA_HASHMAP_FOREACH(p
, s
->ports
, state
)
333 if (!s
->active_port
|| p
->priority
> s
->active_port
->priority
)
337 s
->save_volume
= data
->save_volume
;
338 s
->save_muted
= data
->save_muted
;
340 pa_silence_memchunk_get(
341 &core
->silence_cache
,
347 s
->thread_info
.rtpoll
= NULL
;
348 s
->thread_info
.inputs
= pa_hashmap_new(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
);
349 s
->thread_info
.soft_volume
= s
->soft_volume
;
350 s
->thread_info
.soft_muted
= s
->muted
;
351 s
->thread_info
.state
= s
->state
;
352 s
->thread_info
.rewind_nbytes
= 0;
353 s
->thread_info
.rewind_requested
= FALSE
;
354 s
->thread_info
.max_rewind
= 0;
355 s
->thread_info
.max_request
= 0;
356 s
->thread_info
.requested_latency_valid
= FALSE
;
357 s
->thread_info
.requested_latency
= 0;
358 s
->thread_info
.min_latency
= ABSOLUTE_MIN_LATENCY
;
359 s
->thread_info
.max_latency
= ABSOLUTE_MAX_LATENCY
;
360 s
->thread_info
.fixed_latency
= flags
& PA_SINK_DYNAMIC_LATENCY
? 0 : DEFAULT_FIXED_LATENCY
;
362 PA_LLIST_HEAD_INIT(pa_sink_volume_change
, s
->thread_info
.volume_changes
);
363 s
->thread_info
.volume_changes_tail
= NULL
;
364 pa_sw_cvolume_multiply(&s
->thread_info
.current_hw_volume
, &s
->soft_volume
, &s
->real_volume
);
365 s
->thread_info
.volume_change_safety_margin
= core
->deferred_volume_safety_margin_usec
;
366 s
->thread_info
.volume_change_extra_delay
= core
->deferred_volume_extra_delay_usec
;
368 /* FIXME: This should probably be moved to pa_sink_put() */
369 pa_assert_se(pa_idxset_put(core
->sinks
, s
, &s
->index
) >= 0);
372 pa_assert_se(pa_idxset_put(s
->card
->sinks
, s
, NULL
) >= 0);
374 pt
= pa_proplist_to_string_sep(s
->proplist
, "\n ");
375 pa_log_info("Created sink %u \"%s\" with sample spec %s and channel map %s\n %s",
378 pa_sample_spec_snprint(st
, sizeof(st
), &s
->sample_spec
),
379 pa_channel_map_snprint(cm
, sizeof(cm
), &s
->channel_map
),
383 pa_source_new_data_init(&source_data
);
384 pa_source_new_data_set_sample_spec(&source_data
, &s
->sample_spec
);
385 pa_source_new_data_set_channel_map(&source_data
, &s
->channel_map
);
386 pa_source_new_data_set_alternate_sample_rate(&source_data
, s
->alternate_sample_rate
);
387 source_data
.name
= pa_sprintf_malloc("%s.monitor", name
);
388 source_data
.driver
= data
->driver
;
389 source_data
.module
= data
->module
;
390 source_data
.card
= data
->card
;
392 dn
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
393 pa_proplist_setf(source_data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, "Monitor of %s", dn
? dn
: s
->name
);
394 pa_proplist_sets(source_data
.proplist
, PA_PROP_DEVICE_CLASS
, "monitor");
396 s
->monitor_source
= pa_source_new(core
, &source_data
,
397 ((flags
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
398 ((flags
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0));
400 pa_source_new_data_done(&source_data
);
402 if (!s
->monitor_source
) {
408 s
->monitor_source
->monitor_of
= s
;
410 pa_source_set_latency_range(s
->monitor_source
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
411 pa_source_set_fixed_latency(s
->monitor_source
, s
->thread_info
.fixed_latency
);
412 pa_source_set_max_rewind(s
->monitor_source
, s
->thread_info
.max_rewind
);
417 /* Called from main context */
418 static int sink_set_state(pa_sink
*s
, pa_sink_state_t state
) {
420 pa_bool_t suspend_change
;
421 pa_sink_state_t original_state
;
424 pa_assert_ctl_context();
426 if (s
->state
== state
)
429 original_state
= s
->state
;
432 (original_state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(state
)) ||
433 (PA_SINK_IS_OPENED(original_state
) && state
== PA_SINK_SUSPENDED
);
436 if ((ret
= s
->set_state(s
, state
)) < 0)
440 if ((ret
= pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_STATE
, PA_UINT_TO_PTR(state
), 0, NULL
)) < 0) {
443 s
->set_state(s
, original_state
);
450 if (state
!= PA_SINK_UNLINKED
) { /* if we enter UNLINKED state pa_sink_unlink() will fire the appropriate events */
451 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_STATE_CHANGED
], s
);
452 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
455 if (suspend_change
) {
459 /* We're suspending or resuming, tell everyone about it */
461 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
)
462 if (s
->state
== PA_SINK_SUSPENDED
&&
463 (i
->flags
& PA_SINK_INPUT_KILL_ON_SUSPEND
))
464 pa_sink_input_kill(i
);
466 i
->suspend(i
, state
== PA_SINK_SUSPENDED
);
468 if (s
->monitor_source
)
469 pa_source_sync_suspend(s
->monitor_source
);
475 void pa_sink_set_get_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
481 void pa_sink_set_set_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
482 pa_sink_flags_t flags
;
485 pa_assert(!s
->write_volume
|| cb
);
489 /* Save the current flags so we can tell if they've changed */
493 /* The sink implementor is responsible for setting decibel volume support */
494 s
->flags
|= PA_SINK_HW_VOLUME_CTRL
;
496 s
->flags
&= ~PA_SINK_HW_VOLUME_CTRL
;
497 /* See note below in pa_sink_put() about volume sharing and decibel volumes */
498 pa_sink_enable_decibel_volume(s
, !(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
501 /* If the flags have changed after init, let any clients know via a change event */
502 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
503 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
506 void pa_sink_set_write_volume_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
507 pa_sink_flags_t flags
;
510 pa_assert(!cb
|| s
->set_volume
);
512 s
->write_volume
= cb
;
514 /* Save the current flags so we can tell if they've changed */
518 s
->flags
|= PA_SINK_DEFERRED_VOLUME
;
520 s
->flags
&= ~PA_SINK_DEFERRED_VOLUME
;
522 /* If the flags have changed after init, let any clients know via a change event */
523 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
524 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
527 void pa_sink_set_get_mute_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
533 void pa_sink_set_set_mute_callback(pa_sink
*s
, pa_sink_cb_t cb
) {
534 pa_sink_flags_t flags
;
540 /* Save the current flags so we can tell if they've changed */
544 s
->flags
|= PA_SINK_HW_MUTE_CTRL
;
546 s
->flags
&= ~PA_SINK_HW_MUTE_CTRL
;
548 /* If the flags have changed after init, let any clients know via a change event */
549 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
550 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
553 static void enable_flat_volume(pa_sink
*s
, pa_bool_t enable
) {
554 pa_sink_flags_t flags
;
558 /* Always follow the overall user preference here */
559 enable
= enable
&& s
->core
->flat_volumes
;
561 /* Save the current flags so we can tell if they've changed */
565 s
->flags
|= PA_SINK_FLAT_VOLUME
;
567 s
->flags
&= ~PA_SINK_FLAT_VOLUME
;
569 /* If the flags have changed after init, let any clients know via a change event */
570 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
571 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
574 void pa_sink_enable_decibel_volume(pa_sink
*s
, pa_bool_t enable
) {
575 pa_sink_flags_t flags
;
579 /* Save the current flags so we can tell if they've changed */
583 s
->flags
|= PA_SINK_DECIBEL_VOLUME
;
584 enable_flat_volume(s
, TRUE
);
586 s
->flags
&= ~PA_SINK_DECIBEL_VOLUME
;
587 enable_flat_volume(s
, FALSE
);
590 /* If the flags have changed after init, let any clients know via a change event */
591 if (s
->state
!= PA_SINK_INIT
&& flags
!= s
->flags
)
592 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
595 /* Called from main context */
596 void pa_sink_put(pa_sink
* s
) {
597 pa_sink_assert_ref(s
);
598 pa_assert_ctl_context();
600 pa_assert(s
->state
== PA_SINK_INIT
);
601 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) || s
->input_to_master
);
603 /* The following fields must be initialized properly when calling _put() */
604 pa_assert(s
->asyncmsgq
);
605 pa_assert(s
->thread_info
.min_latency
<= s
->thread_info
.max_latency
);
607 /* Generally, flags should be initialized via pa_sink_new(). As a
608 * special exception we allow some volume related flags to be set
609 * between _new() and _put() by the callback setter functions above.
611 * Thus we implement a couple safeguards here which ensure the above
612 * setters were used (or at least the implementor made manual changes
613 * in a compatible way).
615 * Note: All of these flags set here can change over the life time
617 pa_assert(!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
) || s
->set_volume
);
618 pa_assert(!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) || s
->write_volume
);
619 pa_assert(!(s
->flags
& PA_SINK_HW_MUTE_CTRL
) || s
->set_mute
);
621 /* XXX: Currently decibel volume is disabled for all sinks that use volume
622 * sharing. When the master sink supports decibel volume, it would be good
623 * to have the flag also in the filter sink, but currently we don't do that
624 * so that the flags of the filter sink never change when it's moved from
625 * a master sink to another. One solution for this problem would be to
626 * remove user-visible volume altogether from filter sinks when volume
627 * sharing is used, but the current approach was easier to implement... */
628 /* We always support decibel volumes in software, otherwise we leave it to
629 * the sink implementor to set this flag as needed.
631 * Note: This flag can also change over the life time of the sink. */
632 if (!(s
->flags
& PA_SINK_HW_VOLUME_CTRL
) && !(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
633 pa_sink_enable_decibel_volume(s
, TRUE
);
635 /* If the sink implementor support DB volumes by itself, we should always
636 * try and enable flat volumes too */
637 if ((s
->flags
& PA_SINK_DECIBEL_VOLUME
))
638 enable_flat_volume(s
, TRUE
);
640 if (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) {
641 pa_sink
*root_sink
= pa_sink_get_master(s
);
643 pa_assert(root_sink
);
645 s
->reference_volume
= root_sink
->reference_volume
;
646 pa_cvolume_remap(&s
->reference_volume
, &root_sink
->channel_map
, &s
->channel_map
);
648 s
->real_volume
= root_sink
->real_volume
;
649 pa_cvolume_remap(&s
->real_volume
, &root_sink
->channel_map
, &s
->channel_map
);
651 /* We assume that if the sink implementor changed the default
652 * volume he did so in real_volume, because that is the usual
653 * place where he is supposed to place his changes. */
654 s
->reference_volume
= s
->real_volume
;
656 s
->thread_info
.soft_volume
= s
->soft_volume
;
657 s
->thread_info
.soft_muted
= s
->muted
;
658 pa_sw_cvolume_multiply(&s
->thread_info
.current_hw_volume
, &s
->soft_volume
, &s
->real_volume
);
660 pa_assert((s
->flags
& PA_SINK_HW_VOLUME_CTRL
)
661 || (s
->base_volume
== PA_VOLUME_NORM
662 && ((s
->flags
& PA_SINK_DECIBEL_VOLUME
|| (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)))));
663 pa_assert(!(s
->flags
& PA_SINK_DECIBEL_VOLUME
) || s
->n_volume_steps
== PA_VOLUME_NORM
+1);
664 pa_assert(!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
) == (s
->thread_info
.fixed_latency
!= 0));
665 pa_assert(!(s
->flags
& PA_SINK_LATENCY
) == !(s
->monitor_source
->flags
& PA_SOURCE_LATENCY
));
666 pa_assert(!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
) == !(s
->monitor_source
->flags
& PA_SOURCE_DYNAMIC_LATENCY
));
668 pa_assert(s
->monitor_source
->thread_info
.fixed_latency
== s
->thread_info
.fixed_latency
);
669 pa_assert(s
->monitor_source
->thread_info
.min_latency
== s
->thread_info
.min_latency
);
670 pa_assert(s
->monitor_source
->thread_info
.max_latency
== s
->thread_info
.max_latency
);
672 pa_assert_se(sink_set_state(s
, PA_SINK_IDLE
) == 0);
674 pa_source_put(s
->monitor_source
);
676 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_NEW
, s
->index
);
677 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PUT
], s
);
680 /* Called from main context */
681 void pa_sink_unlink(pa_sink
* s
) {
683 pa_sink_input
*i
, *j
= NULL
;
686 pa_assert_ctl_context();
688 /* Please note that pa_sink_unlink() does more than simply
689 * reversing pa_sink_put(). It also undoes the registrations
690 * already done in pa_sink_new()! */
692 /* All operations here shall be idempotent, i.e. pa_sink_unlink()
693 * may be called multiple times on the same sink without bad
696 linked
= PA_SINK_IS_LINKED(s
->state
);
699 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK
], s
);
701 if (s
->state
!= PA_SINK_UNLINKED
)
702 pa_namereg_unregister(s
->core
, s
->name
);
703 pa_idxset_remove_by_data(s
->core
->sinks
, s
, NULL
);
706 pa_idxset_remove_by_data(s
->card
->sinks
, s
, NULL
);
708 while ((i
= pa_idxset_first(s
->inputs
, NULL
))) {
710 pa_sink_input_kill(i
);
715 sink_set_state(s
, PA_SINK_UNLINKED
);
717 s
->state
= PA_SINK_UNLINKED
;
721 if (s
->monitor_source
)
722 pa_source_unlink(s
->monitor_source
);
725 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
| PA_SUBSCRIPTION_EVENT_REMOVE
, s
->index
);
726 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_UNLINK_POST
], s
);
730 /* Called from main context */
731 static void sink_free(pa_object
*o
) {
732 pa_sink
*s
= PA_SINK(o
);
736 pa_assert_ctl_context();
737 pa_assert(pa_sink_refcnt(s
) == 0);
739 if (PA_SINK_IS_LINKED(s
->state
))
742 pa_log_info("Freeing sink %u \"%s\"", s
->index
, s
->name
);
744 if (s
->monitor_source
) {
745 pa_source_unref(s
->monitor_source
);
746 s
->monitor_source
= NULL
;
749 pa_idxset_free(s
->inputs
, NULL
, NULL
);
751 while ((i
= pa_hashmap_steal_first(s
->thread_info
.inputs
)))
752 pa_sink_input_unref(i
);
754 pa_hashmap_free(s
->thread_info
.inputs
, NULL
, NULL
);
756 if (s
->silence
.memblock
)
757 pa_memblock_unref(s
->silence
.memblock
);
763 pa_proplist_free(s
->proplist
);
768 while ((p
= pa_hashmap_steal_first(s
->ports
)))
769 pa_device_port_free(p
);
771 pa_hashmap_free(s
->ports
, NULL
, NULL
);
777 /* Called from main context, and not while the IO thread is active, please */
778 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
) {
779 pa_sink_assert_ref(s
);
780 pa_assert_ctl_context();
784 if (s
->monitor_source
)
785 pa_source_set_asyncmsgq(s
->monitor_source
, q
);
788 /* Called from main context, and not while the IO thread is active, please */
789 void pa_sink_update_flags(pa_sink
*s
, pa_sink_flags_t mask
, pa_sink_flags_t value
) {
790 pa_sink_assert_ref(s
);
791 pa_assert_ctl_context();
796 /* For now, allow only a minimal set of flags to be changed. */
797 pa_assert((mask
& ~(PA_SINK_DYNAMIC_LATENCY
|PA_SINK_LATENCY
)) == 0);
799 s
->flags
= (s
->flags
& ~mask
) | (value
& mask
);
801 pa_source_update_flags(s
->monitor_source
,
802 ((mask
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
803 ((mask
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SOURCE_DYNAMIC_LATENCY
: 0),
804 ((value
& PA_SINK_LATENCY
) ? PA_SOURCE_LATENCY
: 0) |
805 ((value
& PA_SINK_DYNAMIC_LATENCY
) ? PA_SINK_DYNAMIC_LATENCY
: 0));
808 /* Called from IO context, or before _put() from main context */
809 void pa_sink_set_rtpoll(pa_sink
*s
, pa_rtpoll
*p
) {
810 pa_sink_assert_ref(s
);
811 pa_sink_assert_io_context(s
);
813 s
->thread_info
.rtpoll
= p
;
815 if (s
->monitor_source
)
816 pa_source_set_rtpoll(s
->monitor_source
, p
);
819 /* Called from main context */
820 int pa_sink_update_status(pa_sink
*s
) {
821 pa_sink_assert_ref(s
);
822 pa_assert_ctl_context();
823 pa_assert(PA_SINK_IS_LINKED(s
->state
));
825 if (s
->state
== PA_SINK_SUSPENDED
)
828 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
831 /* Called from main context */
832 int pa_sink_suspend(pa_sink
*s
, pa_bool_t suspend
, pa_suspend_cause_t cause
) {
833 pa_sink_assert_ref(s
);
834 pa_assert_ctl_context();
835 pa_assert(PA_SINK_IS_LINKED(s
->state
));
836 pa_assert(cause
!= 0);
839 s
->suspend_cause
|= cause
;
840 s
->monitor_source
->suspend_cause
|= cause
;
842 s
->suspend_cause
&= ~cause
;
843 s
->monitor_source
->suspend_cause
&= ~cause
;
846 if ((pa_sink_get_state(s
) == PA_SINK_SUSPENDED
) == !!s
->suspend_cause
)
849 pa_log_debug("Suspend cause of sink %s is 0x%04x, %s", s
->name
, s
->suspend_cause
, s
->suspend_cause
? "suspending" : "resuming");
851 if (s
->suspend_cause
)
852 return sink_set_state(s
, PA_SINK_SUSPENDED
);
854 return sink_set_state(s
, pa_sink_used_by(s
) ? PA_SINK_RUNNING
: PA_SINK_IDLE
);
857 /* Called from main context */
858 pa_queue
*pa_sink_move_all_start(pa_sink
*s
, pa_queue
*q
) {
859 pa_sink_input
*i
, *n
;
862 pa_sink_assert_ref(s
);
863 pa_assert_ctl_context();
864 pa_assert(PA_SINK_IS_LINKED(s
->state
));
869 for (i
= PA_SINK_INPUT(pa_idxset_first(s
->inputs
, &idx
)); i
; i
= n
) {
870 n
= PA_SINK_INPUT(pa_idxset_next(s
->inputs
, &idx
));
872 pa_sink_input_ref(i
);
874 if (pa_sink_input_start_move(i
) >= 0)
877 pa_sink_input_unref(i
);
883 /* Called from main context */
884 void pa_sink_move_all_finish(pa_sink
*s
, pa_queue
*q
, pa_bool_t save
) {
887 pa_sink_assert_ref(s
);
888 pa_assert_ctl_context();
889 pa_assert(PA_SINK_IS_LINKED(s
->state
));
892 while ((i
= PA_SINK_INPUT(pa_queue_pop(q
)))) {
893 if (pa_sink_input_finish_move(i
, s
, save
) < 0)
894 pa_sink_input_fail_move(i
);
896 pa_sink_input_unref(i
);
899 pa_queue_free(q
, NULL
, NULL
);
902 /* Called from main context */
903 void pa_sink_move_all_fail(pa_queue
*q
) {
906 pa_assert_ctl_context();
909 while ((i
= PA_SINK_INPUT(pa_queue_pop(q
)))) {
910 pa_sink_input_fail_move(i
);
911 pa_sink_input_unref(i
);
914 pa_queue_free(q
, NULL
, NULL
);
917 /* Called from IO thread context */
918 void pa_sink_process_rewind(pa_sink
*s
, size_t nbytes
) {
922 pa_sink_assert_ref(s
);
923 pa_sink_assert_io_context(s
);
924 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
926 /* If nobody requested this and this is actually no real rewind
927 * then we can short cut this. Please note that this means that
928 * not all rewind requests triggered upstream will always be
929 * translated in actual requests! */
930 if (!s
->thread_info
.rewind_requested
&& nbytes
<= 0)
933 s
->thread_info
.rewind_nbytes
= 0;
934 s
->thread_info
.rewind_requested
= FALSE
;
936 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
940 pa_log_debug("Processing rewind...");
941 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
942 pa_sink_volume_change_rewind(s
, nbytes
);
945 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
946 pa_sink_input_assert_ref(i
);
947 pa_sink_input_process_rewind(i
, nbytes
);
951 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
952 pa_source_process_rewind(s
->monitor_source
, nbytes
);
956 /* Called from IO thread context */
957 static unsigned fill_mix_info(pa_sink
*s
, size_t *length
, pa_mix_info
*info
, unsigned maxinfo
) {
961 size_t mixlength
= *length
;
963 pa_sink_assert_ref(s
);
964 pa_sink_assert_io_context(s
);
967 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)) && maxinfo
> 0) {
968 pa_sink_input_assert_ref(i
);
970 pa_sink_input_peek(i
, *length
, &info
->chunk
, &info
->volume
);
972 if (mixlength
== 0 || info
->chunk
.length
< mixlength
)
973 mixlength
= info
->chunk
.length
;
975 if (pa_memblock_is_silence(info
->chunk
.memblock
)) {
976 pa_memblock_unref(info
->chunk
.memblock
);
980 info
->userdata
= pa_sink_input_ref(i
);
982 pa_assert(info
->chunk
.memblock
);
983 pa_assert(info
->chunk
.length
> 0);
996 /* Called from IO thread context */
997 static void inputs_drop(pa_sink
*s
, pa_mix_info
*info
, unsigned n
, pa_memchunk
*result
) {
1001 unsigned n_unreffed
= 0;
1003 pa_sink_assert_ref(s
);
1004 pa_sink_assert_io_context(s
);
1006 pa_assert(result
->memblock
);
1007 pa_assert(result
->length
> 0);
1009 /* We optimize for the case where the order of the inputs has not changed */
1011 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
1013 pa_mix_info
* m
= NULL
;
1015 pa_sink_input_assert_ref(i
);
1017 /* Let's try to find the matching entry info the pa_mix_info array */
1018 for (j
= 0; j
< n
; j
++) {
1020 if (info
[p
].userdata
== i
) {
1030 /* Drop read data */
1031 pa_sink_input_drop(i
, result
->length
);
1033 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
)) {
1035 if (pa_hashmap_size(i
->thread_info
.direct_outputs
) > 0) {
1036 void *ostate
= NULL
;
1037 pa_source_output
*o
;
1040 if (m
&& m
->chunk
.memblock
) {
1042 pa_memblock_ref(c
.memblock
);
1043 pa_assert(result
->length
<= c
.length
);
1044 c
.length
= result
->length
;
1046 pa_memchunk_make_writable(&c
, 0);
1047 pa_volume_memchunk(&c
, &s
->sample_spec
, &m
->volume
);
1050 pa_memblock_ref(c
.memblock
);
1051 pa_assert(result
->length
<= c
.length
);
1052 c
.length
= result
->length
;
1055 while ((o
= pa_hashmap_iterate(i
->thread_info
.direct_outputs
, &ostate
, NULL
))) {
1056 pa_source_output_assert_ref(o
);
1057 pa_assert(o
->direct_on_input
== i
);
1058 pa_source_post_direct(s
->monitor_source
, o
, &c
);
1061 pa_memblock_unref(c
.memblock
);
1066 if (m
->chunk
.memblock
)
1067 pa_memblock_unref(m
->chunk
.memblock
);
1068 pa_memchunk_reset(&m
->chunk
);
1070 pa_sink_input_unref(m
->userdata
);
1077 /* Now drop references to entries that are included in the
1078 * pa_mix_info array but don't exist anymore */
1080 if (n_unreffed
< n
) {
1081 for (; n
> 0; info
++, n
--) {
1083 pa_sink_input_unref(info
->userdata
);
1084 if (info
->chunk
.memblock
)
1085 pa_memblock_unref(info
->chunk
.memblock
);
1089 if (s
->monitor_source
&& PA_SOURCE_IS_LINKED(s
->monitor_source
->thread_info
.state
))
1090 pa_source_post(s
->monitor_source
, result
);
1093 /* Called from IO thread context */
1094 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1095 pa_mix_info info
[MAX_MIX_CHANNELS
];
1097 size_t block_size_max
;
1099 pa_sink_assert_ref(s
);
1100 pa_sink_assert_io_context(s
);
1101 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1102 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1105 pa_assert(!s
->thread_info
.rewind_requested
);
1106 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1108 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1109 result
->memblock
= pa_memblock_ref(s
->silence
.memblock
);
1110 result
->index
= s
->silence
.index
;
1111 result
->length
= PA_MIN(s
->silence
.length
, length
);
1118 length
= pa_frame_align(MIX_BUFFER_LENGTH
, &s
->sample_spec
);
1120 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1121 if (length
> block_size_max
)
1122 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1124 pa_assert(length
> 0);
1126 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1130 *result
= s
->silence
;
1131 pa_memblock_ref(result
->memblock
);
1133 if (result
->length
> length
)
1134 result
->length
= length
;
1136 } else if (n
== 1) {
1139 *result
= info
[0].chunk
;
1140 pa_memblock_ref(result
->memblock
);
1142 if (result
->length
> length
)
1143 result
->length
= length
;
1145 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1147 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
)) {
1148 pa_memblock_unref(result
->memblock
);
1149 pa_silence_memchunk_get(&s
->core
->silence_cache
,
1154 } else if (!pa_cvolume_is_norm(&volume
)) {
1155 pa_memchunk_make_writable(result
, 0);
1156 pa_volume_memchunk(result
, &s
->sample_spec
, &volume
);
1160 result
->memblock
= pa_memblock_new(s
->core
->mempool
, length
);
1162 ptr
= pa_memblock_acquire(result
->memblock
);
1163 result
->length
= pa_mix(info
, n
,
1166 &s
->thread_info
.soft_volume
,
1167 s
->thread_info
.soft_muted
);
1168 pa_memblock_release(result
->memblock
);
1173 inputs_drop(s
, info
, n
, result
);
1178 /* Called from IO thread context */
1179 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
) {
1180 pa_mix_info info
[MAX_MIX_CHANNELS
];
1182 size_t length
, block_size_max
;
1184 pa_sink_assert_ref(s
);
1185 pa_sink_assert_io_context(s
);
1186 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1188 pa_assert(target
->memblock
);
1189 pa_assert(target
->length
> 0);
1190 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1192 pa_assert(!s
->thread_info
.rewind_requested
);
1193 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1195 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1196 pa_silence_memchunk(target
, &s
->sample_spec
);
1202 length
= target
->length
;
1203 block_size_max
= pa_mempool_block_size_max(s
->core
->mempool
);
1204 if (length
> block_size_max
)
1205 length
= pa_frame_align(block_size_max
, &s
->sample_spec
);
1207 pa_assert(length
> 0);
1209 n
= fill_mix_info(s
, &length
, info
, MAX_MIX_CHANNELS
);
1212 if (target
->length
> length
)
1213 target
->length
= length
;
1215 pa_silence_memchunk(target
, &s
->sample_spec
);
1216 } else if (n
== 1) {
1219 if (target
->length
> length
)
1220 target
->length
= length
;
1222 pa_sw_cvolume_multiply(&volume
, &s
->thread_info
.soft_volume
, &info
[0].volume
);
1224 if (s
->thread_info
.soft_muted
|| pa_cvolume_is_muted(&volume
))
1225 pa_silence_memchunk(target
, &s
->sample_spec
);
1229 vchunk
= info
[0].chunk
;
1230 pa_memblock_ref(vchunk
.memblock
);
1232 if (vchunk
.length
> length
)
1233 vchunk
.length
= length
;
1235 if (!pa_cvolume_is_norm(&volume
)) {
1236 pa_memchunk_make_writable(&vchunk
, 0);
1237 pa_volume_memchunk(&vchunk
, &s
->sample_spec
, &volume
);
1240 pa_memchunk_memcpy(target
, &vchunk
);
1241 pa_memblock_unref(vchunk
.memblock
);
1247 ptr
= pa_memblock_acquire(target
->memblock
);
1249 target
->length
= pa_mix(info
, n
,
1250 (uint8_t*) ptr
+ target
->index
, length
,
1252 &s
->thread_info
.soft_volume
,
1253 s
->thread_info
.soft_muted
);
1255 pa_memblock_release(target
->memblock
);
1258 inputs_drop(s
, info
, n
, target
);
1263 /* Called from IO thread context */
1264 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
) {
1268 pa_sink_assert_ref(s
);
1269 pa_sink_assert_io_context(s
);
1270 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1272 pa_assert(target
->memblock
);
1273 pa_assert(target
->length
> 0);
1274 pa_assert(pa_frame_aligned(target
->length
, &s
->sample_spec
));
1276 pa_assert(!s
->thread_info
.rewind_requested
);
1277 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1279 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
1280 pa_silence_memchunk(target
, &s
->sample_spec
);
1293 pa_sink_render_into(s
, &chunk
);
1302 /* Called from IO thread context */
1303 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
) {
1304 pa_sink_assert_ref(s
);
1305 pa_sink_assert_io_context(s
);
1306 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1307 pa_assert(length
> 0);
1308 pa_assert(pa_frame_aligned(length
, &s
->sample_spec
));
1311 pa_assert(!s
->thread_info
.rewind_requested
);
1312 pa_assert(s
->thread_info
.rewind_nbytes
== 0);
1316 pa_sink_render(s
, length
, result
);
1318 if (result
->length
< length
) {
1321 pa_memchunk_make_writable(result
, length
);
1323 chunk
.memblock
= result
->memblock
;
1324 chunk
.index
= result
->index
+ result
->length
;
1325 chunk
.length
= length
- result
->length
;
1327 pa_sink_render_into_full(s
, &chunk
);
1329 result
->length
= length
;
1335 /* Called from main thread */
1336 pa_bool_t
pa_sink_update_rate(pa_sink
*s
, uint32_t rate
, pa_bool_t passthrough
)
1338 if (s
->update_rate
) {
1339 uint32_t desired_rate
= rate
;
1340 uint32_t default_rate
= s
->default_sample_rate
;
1341 uint32_t alternate_rate
= s
->alternate_sample_rate
;
1344 pa_bool_t use_alternate
= FALSE
;
1346 if (PA_UNLIKELY(default_rate
== alternate_rate
)) {
1347 pa_log_warn("Default and alternate sample rates are the same.");
1351 if (PA_SINK_IS_RUNNING(s
->state
)) {
1352 pa_log_info("Cannot update rate, SINK_IS_RUNNING, will keep using %u kHz",
1353 s
->sample_spec
.rate
);
1357 if (s
->monitor_source
) {
1358 if (PA_SOURCE_IS_RUNNING(s
->monitor_source
->state
) == TRUE
) {
1359 pa_log_info("Cannot update rate, monitor source is RUNNING");
1364 if (PA_UNLIKELY (desired_rate
< 8000 ||
1365 desired_rate
> PA_RATE_MAX
))
1369 pa_assert(default_rate
% 4000 || default_rate
% 11025);
1370 pa_assert(alternate_rate
% 4000 || alternate_rate
% 11025);
1372 if (default_rate
% 4000) {
1373 /* default is a 11025 multiple */
1374 if ((alternate_rate
% 4000 == 0) && (desired_rate
% 4000 == 0))
1377 /* default is 4000 multiple */
1378 if ((alternate_rate
% 11025 == 0) && (desired_rate
% 11025 == 0))
1383 desired_rate
= alternate_rate
;
1385 desired_rate
= default_rate
;
1387 desired_rate
= rate
; /* use stream sampling rate, discard default/alternate settings */
1390 if (!passthrough
&& pa_sink_used_by(s
) > 0)
1393 pa_sink_suspend(s
, TRUE
, PA_SUSPEND_IDLE
); /* needed before rate update, will be resumed automatically */
1395 if (s
->update_rate(s
, desired_rate
) == TRUE
) {
1396 /* update monitor source as well */
1397 if (s
->monitor_source
&& !passthrough
)
1398 pa_source_update_rate(s
->monitor_source
, desired_rate
, FALSE
);
1399 pa_log_info("Changed sampling rate successfully");
1401 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1402 if (i
->state
== PA_SINK_INPUT_CORKED
)
1403 pa_sink_input_update_rate(i
);
1412 /* Called from main thread */
1413 pa_usec_t
pa_sink_get_latency(pa_sink
*s
) {
1416 pa_sink_assert_ref(s
);
1417 pa_assert_ctl_context();
1418 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1420 /* The returned value is supposed to be in the time domain of the sound card! */
1422 if (s
->state
== PA_SINK_SUSPENDED
)
1425 if (!(s
->flags
& PA_SINK_LATENCY
))
1428 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) == 0);
1433 /* Called from IO thread */
1434 pa_usec_t
pa_sink_get_latency_within_thread(pa_sink
*s
) {
1438 pa_sink_assert_ref(s
);
1439 pa_sink_assert_io_context(s
);
1440 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
1442 /* The returned value is supposed to be in the time domain of the sound card! */
1444 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
1447 if (!(s
->flags
& PA_SINK_LATENCY
))
1450 o
= PA_MSGOBJECT(s
);
1452 /* FIXME: We probably should make this a proper vtable callback instead of going through process_msg() */
1454 if (o
->process_msg(o
, PA_SINK_MESSAGE_GET_LATENCY
, &usec
, 0, NULL
) < 0)
1460 /* Called from the main thread (and also from the IO thread while the main
1461 * thread is waiting).
1463 * When a sink uses volume sharing, it never has the PA_SINK_FLAT_VOLUME flag
1464 * set. Instead, flat volume mode is detected by checking whether the root sink
1465 * has the flag set. */
1466 pa_bool_t
pa_sink_flat_volume_enabled(pa_sink
*s
) {
1467 pa_sink_assert_ref(s
);
1469 s
= pa_sink_get_master(s
);
1472 return (s
->flags
& PA_SINK_FLAT_VOLUME
);
1477 /* Called from the main thread (and also from the IO thread while the main
1478 * thread is waiting). */
1479 pa_sink
*pa_sink_get_master(pa_sink
*s
) {
1480 pa_sink_assert_ref(s
);
1482 while (s
&& (s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1483 if (PA_UNLIKELY(!s
->input_to_master
))
1486 s
= s
->input_to_master
->sink
;
1492 /* Called from main context */
1493 pa_bool_t
pa_sink_is_passthrough(pa_sink
*s
) {
1494 pa_sink_input
*alt_i
;
1497 pa_sink_assert_ref(s
);
1499 /* one and only one PASSTHROUGH input can possibly be connected */
1500 if (pa_idxset_size(s
->inputs
) == 1) {
1501 alt_i
= pa_idxset_first(s
->inputs
, &idx
);
1503 if (pa_sink_input_is_passthrough(alt_i
))
1510 /* Called from main context */
1511 void pa_sink_enter_passthrough(pa_sink
*s
) {
1514 /* disable the monitor in passthrough mode */
1515 if (s
->monitor_source
)
1516 pa_source_suspend(s
->monitor_source
, TRUE
, PA_SUSPEND_PASSTHROUGH
);
1518 /* set the volume to NORM */
1519 s
->saved_volume
= *pa_sink_get_volume(s
, TRUE
);
1520 s
->saved_save_volume
= s
->save_volume
;
1522 pa_cvolume_set(&volume
, s
->sample_spec
.channels
, PA_MIN(s
->base_volume
, PA_VOLUME_NORM
));
1523 pa_sink_set_volume(s
, &volume
, TRUE
, FALSE
);
1526 /* Called from main context */
1527 void pa_sink_leave_passthrough(pa_sink
*s
) {
1528 /* Unsuspend monitor */
1529 if (s
->monitor_source
)
1530 pa_source_suspend(s
->monitor_source
, FALSE
, PA_SUSPEND_PASSTHROUGH
);
1532 /* Restore sink volume to what it was before we entered passthrough mode */
1533 pa_sink_set_volume(s
, &s
->saved_volume
, TRUE
, s
->saved_save_volume
);
1535 pa_cvolume_init(&s
->saved_volume
);
1536 s
->saved_save_volume
= FALSE
;
1539 /* Called from main context. */
1540 static void compute_reference_ratio(pa_sink_input
*i
) {
1542 pa_cvolume remapped
;
1545 pa_assert(pa_sink_flat_volume_enabled(i
->sink
));
1548 * Calculates the reference ratio from the sink's reference
1549 * volume. This basically calculates:
1551 * i->reference_ratio = i->volume / i->sink->reference_volume
1554 remapped
= i
->sink
->reference_volume
;
1555 pa_cvolume_remap(&remapped
, &i
->sink
->channel_map
, &i
->channel_map
);
1557 i
->reference_ratio
.channels
= i
->sample_spec
.channels
;
1559 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1561 /* We don't update when the sink volume is 0 anyway */
1562 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
)
1565 /* Don't update the reference ratio unless necessary */
1566 if (pa_sw_volume_multiply(
1567 i
->reference_ratio
.values
[c
],
1568 remapped
.values
[c
]) == i
->volume
.values
[c
])
1571 i
->reference_ratio
.values
[c
] = pa_sw_volume_divide(
1572 i
->volume
.values
[c
],
1573 remapped
.values
[c
]);
1577 /* Called from main context. Only called for the root sink in volume sharing
1578 * cases, except for internal recursive calls. */
1579 static void compute_reference_ratios(pa_sink
*s
) {
1583 pa_sink_assert_ref(s
);
1584 pa_assert_ctl_context();
1585 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1586 pa_assert(pa_sink_flat_volume_enabled(s
));
1588 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1589 compute_reference_ratio(i
);
1591 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1592 compute_reference_ratios(i
->origin_sink
);
1596 /* Called from main context. Only called for the root sink in volume sharing
1597 * cases, except for internal recursive calls. */
1598 static void compute_real_ratios(pa_sink
*s
) {
1602 pa_sink_assert_ref(s
);
1603 pa_assert_ctl_context();
1604 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1605 pa_assert(pa_sink_flat_volume_enabled(s
));
1607 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1609 pa_cvolume remapped
;
1611 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1612 /* The origin sink uses volume sharing, so this input's real ratio
1613 * is handled as a special case - the real ratio must be 0 dB, and
1614 * as a result i->soft_volume must equal i->volume_factor. */
1615 pa_cvolume_reset(&i
->real_ratio
, i
->real_ratio
.channels
);
1616 i
->soft_volume
= i
->volume_factor
;
1618 compute_real_ratios(i
->origin_sink
);
1624 * This basically calculates:
1626 * i->real_ratio := i->volume / s->real_volume
1627 * i->soft_volume := i->real_ratio * i->volume_factor
1630 remapped
= s
->real_volume
;
1631 pa_cvolume_remap(&remapped
, &s
->channel_map
, &i
->channel_map
);
1633 i
->real_ratio
.channels
= i
->sample_spec
.channels
;
1634 i
->soft_volume
.channels
= i
->sample_spec
.channels
;
1636 for (c
= 0; c
< i
->sample_spec
.channels
; c
++) {
1638 if (remapped
.values
[c
] <= PA_VOLUME_MUTED
) {
1639 /* We leave i->real_ratio untouched */
1640 i
->soft_volume
.values
[c
] = PA_VOLUME_MUTED
;
1644 /* Don't lose accuracy unless necessary */
1645 if (pa_sw_volume_multiply(
1646 i
->real_ratio
.values
[c
],
1647 remapped
.values
[c
]) != i
->volume
.values
[c
])
1649 i
->real_ratio
.values
[c
] = pa_sw_volume_divide(
1650 i
->volume
.values
[c
],
1651 remapped
.values
[c
]);
1653 i
->soft_volume
.values
[c
] = pa_sw_volume_multiply(
1654 i
->real_ratio
.values
[c
],
1655 i
->volume_factor
.values
[c
]);
1658 /* We don't copy the soft_volume to the thread_info data
1659 * here. That must be done by the caller */
1663 static pa_cvolume
*cvolume_remap_minimal_impact(
1665 const pa_cvolume
*template,
1666 const pa_channel_map
*from
,
1667 const pa_channel_map
*to
) {
1672 pa_assert(template);
1675 pa_assert(pa_cvolume_compatible_with_channel_map(v
, from
));
1676 pa_assert(pa_cvolume_compatible_with_channel_map(template, to
));
1678 /* Much like pa_cvolume_remap(), but tries to minimize impact when
1679 * mapping from sink input to sink volumes:
1681 * If template is a possible remapping from v it is used instead
1682 * of remapping anew.
1684 * If the channel maps don't match we set an all-channel volume on
1685 * the sink to ensure that changing a volume on one stream has no
1686 * effect that cannot be compensated for in another stream that
1687 * does not have the same channel map as the sink. */
1689 if (pa_channel_map_equal(from
, to
))
1693 if (pa_cvolume_equal(pa_cvolume_remap(&t
, to
, from
), v
)) {
1698 pa_cvolume_set(v
, to
->channels
, pa_cvolume_max(v
));
1702 /* Called from main thread. Only called for the root sink in volume sharing
1703 * cases, except for internal recursive calls. */
1704 static void get_maximum_input_volume(pa_sink
*s
, pa_cvolume
*max_volume
, const pa_channel_map
*channel_map
) {
1708 pa_sink_assert_ref(s
);
1709 pa_assert(max_volume
);
1710 pa_assert(channel_map
);
1711 pa_assert(pa_sink_flat_volume_enabled(s
));
1713 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1714 pa_cvolume remapped
;
1716 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1717 get_maximum_input_volume(i
->origin_sink
, max_volume
, channel_map
);
1719 /* Ignore this input. The origin sink uses volume sharing, so this
1720 * input's volume will be set to be equal to the root sink's real
1721 * volume. Obviously this input's current volume must not then
1722 * affect what the root sink's real volume will be. */
1726 remapped
= i
->volume
;
1727 cvolume_remap_minimal_impact(&remapped
, max_volume
, &i
->channel_map
, channel_map
);
1728 pa_cvolume_merge(max_volume
, max_volume
, &remapped
);
1732 /* Called from main thread. Only called for the root sink in volume sharing
1733 * cases, except for internal recursive calls. */
1734 static pa_bool_t
has_inputs(pa_sink
*s
) {
1738 pa_sink_assert_ref(s
);
1740 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1741 if (!i
->origin_sink
|| !(i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
) || has_inputs(i
->origin_sink
))
1748 /* Called from main thread. Only called for the root sink in volume sharing
1749 * cases, except for internal recursive calls. */
1750 static void update_real_volume(pa_sink
*s
, const pa_cvolume
*new_volume
, pa_channel_map
*channel_map
) {
1754 pa_sink_assert_ref(s
);
1755 pa_assert(new_volume
);
1756 pa_assert(channel_map
);
1758 s
->real_volume
= *new_volume
;
1759 pa_cvolume_remap(&s
->real_volume
, channel_map
, &s
->channel_map
);
1761 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1762 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1763 if (pa_sink_flat_volume_enabled(s
)) {
1764 pa_cvolume old_volume
= i
->volume
;
1766 /* Follow the root sink's real volume. */
1767 i
->volume
= *new_volume
;
1768 pa_cvolume_remap(&i
->volume
, channel_map
, &i
->channel_map
);
1769 compute_reference_ratio(i
);
1771 /* The volume changed, let's tell people so */
1772 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
1773 if (i
->volume_changed
)
1774 i
->volume_changed(i
);
1776 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1780 update_real_volume(i
->origin_sink
, new_volume
, channel_map
);
1785 /* Called from main thread. Only called for the root sink in shared volume
1787 static void compute_real_volume(pa_sink
*s
) {
1788 pa_sink_assert_ref(s
);
1789 pa_assert_ctl_context();
1790 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1791 pa_assert(pa_sink_flat_volume_enabled(s
));
1792 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
1794 /* This determines the maximum volume of all streams and sets
1795 * s->real_volume accordingly. */
1797 if (!has_inputs(s
)) {
1798 /* In the special case that we have no sink inputs we leave the
1799 * volume unmodified. */
1800 update_real_volume(s
, &s
->reference_volume
, &s
->channel_map
);
1804 pa_cvolume_mute(&s
->real_volume
, s
->channel_map
.channels
);
1806 /* First let's determine the new maximum volume of all inputs
1807 * connected to this sink */
1808 get_maximum_input_volume(s
, &s
->real_volume
, &s
->channel_map
);
1809 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
1811 /* Then, let's update the real ratios/soft volumes of all inputs
1812 * connected to this sink */
1813 compute_real_ratios(s
);
1816 /* Called from main thread. Only called for the root sink in shared volume
1817 * cases, except for internal recursive calls. */
1818 static void propagate_reference_volume(pa_sink
*s
) {
1822 pa_sink_assert_ref(s
);
1823 pa_assert_ctl_context();
1824 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1825 pa_assert(pa_sink_flat_volume_enabled(s
));
1827 /* This is called whenever the sink volume changes that is not
1828 * caused by a sink input volume change. We need to fix up the
1829 * sink input volumes accordingly */
1831 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1832 pa_cvolume old_volume
;
1834 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1835 propagate_reference_volume(i
->origin_sink
);
1837 /* Since the origin sink uses volume sharing, this input's volume
1838 * needs to be updated to match the root sink's real volume, but
1839 * that will be done later in update_shared_real_volume(). */
1843 old_volume
= i
->volume
;
1845 /* This basically calculates:
1847 * i->volume := s->reference_volume * i->reference_ratio */
1849 i
->volume
= s
->reference_volume
;
1850 pa_cvolume_remap(&i
->volume
, &s
->channel_map
, &i
->channel_map
);
1851 pa_sw_cvolume_multiply(&i
->volume
, &i
->volume
, &i
->reference_ratio
);
1853 /* The volume changed, let's tell people so */
1854 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
1856 if (i
->volume_changed
)
1857 i
->volume_changed(i
);
1859 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1864 /* Called from main thread. Only called for the root sink in volume sharing
1865 * cases, except for internal recursive calls. The return value indicates
1866 * whether any reference volume actually changed. */
1867 static pa_bool_t
update_reference_volume(pa_sink
*s
, const pa_cvolume
*v
, const pa_channel_map
*channel_map
, pa_bool_t save
) {
1869 pa_bool_t reference_volume_changed
;
1873 pa_sink_assert_ref(s
);
1874 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1876 pa_assert(channel_map
);
1877 pa_assert(pa_cvolume_valid(v
));
1880 pa_cvolume_remap(&volume
, channel_map
, &s
->channel_map
);
1882 reference_volume_changed
= !pa_cvolume_equal(&volume
, &s
->reference_volume
);
1883 s
->reference_volume
= volume
;
1885 s
->save_volume
= (!reference_volume_changed
&& s
->save_volume
) || save
;
1887 if (reference_volume_changed
)
1888 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
1889 else if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1890 /* If the root sink's volume doesn't change, then there can't be any
1891 * changes in the other sinks in the sink tree either.
1893 * It's probably theoretically possible that even if the root sink's
1894 * volume changes slightly, some filter sink doesn't change its volume
1895 * due to rounding errors. If that happens, we still want to propagate
1896 * the changed root sink volume to the sinks connected to the
1897 * intermediate sink that didn't change its volume. This theoretical
1898 * possibility is the reason why we have that !(s->flags &
1899 * PA_SINK_SHARE_VOLUME_WITH_MASTER) condition. Probably nobody would
1900 * notice even if we returned here FALSE always if
1901 * reference_volume_changed is FALSE. */
1904 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
1905 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
1906 update_reference_volume(i
->origin_sink
, v
, channel_map
, FALSE
);
1912 /* Called from main thread */
1913 void pa_sink_set_volume(
1915 const pa_cvolume
*volume
,
1919 pa_cvolume new_reference_volume
;
1922 pa_sink_assert_ref(s
);
1923 pa_assert_ctl_context();
1924 pa_assert(PA_SINK_IS_LINKED(s
->state
));
1925 pa_assert(!volume
|| pa_cvolume_valid(volume
));
1926 pa_assert(volume
|| pa_sink_flat_volume_enabled(s
));
1927 pa_assert(!volume
|| volume
->channels
== 1 || pa_cvolume_compatible(volume
, &s
->sample_spec
));
1929 /* make sure we don't change the volume when a PASSTHROUGH input is connected ...
1930 * ... *except* if we're being invoked to reset the volume to ensure 0 dB gain */
1931 if (pa_sink_is_passthrough(s
) && (!volume
|| !pa_cvolume_is_norm(volume
))) {
1932 pa_log_warn("Cannot change volume, Sink is connected to PASSTHROUGH input");
1936 /* In case of volume sharing, the volume is set for the root sink first,
1937 * from which it's then propagated to the sharing sinks. */
1938 root_sink
= pa_sink_get_master(s
);
1940 if (PA_UNLIKELY(!root_sink
))
1943 /* As a special exception we accept mono volumes on all sinks --
1944 * even on those with more complex channel maps */
1947 if (pa_cvolume_compatible(volume
, &s
->sample_spec
))
1948 new_reference_volume
= *volume
;
1950 new_reference_volume
= s
->reference_volume
;
1951 pa_cvolume_scale(&new_reference_volume
, pa_cvolume_max(volume
));
1954 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
1956 if (update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
)) {
1957 if (pa_sink_flat_volume_enabled(root_sink
)) {
1958 /* OK, propagate this volume change back to the inputs */
1959 propagate_reference_volume(root_sink
);
1961 /* And now recalculate the real volume */
1962 compute_real_volume(root_sink
);
1964 update_real_volume(root_sink
, &root_sink
->reference_volume
, &root_sink
->channel_map
);
1968 /* If volume is NULL we synchronize the sink's real and
1969 * reference volumes with the stream volumes. */
1971 pa_assert(pa_sink_flat_volume_enabled(root_sink
));
1973 /* Ok, let's determine the new real volume */
1974 compute_real_volume(root_sink
);
1976 /* Let's 'push' the reference volume if necessary */
1977 pa_cvolume_merge(&new_reference_volume
, &s
->reference_volume
, &root_sink
->real_volume
);
1978 /* If the sink and it's root don't have the same number of channels, we need to remap */
1979 if (s
!= root_sink
&& !pa_channel_map_equal(&s
->channel_map
, &root_sink
->channel_map
))
1980 pa_cvolume_remap(&new_reference_volume
, &s
->channel_map
, &root_sink
->channel_map
);
1981 update_reference_volume(root_sink
, &new_reference_volume
, &root_sink
->channel_map
, save
);
1983 /* Now that the reference volume is updated, we can update the streams'
1984 * reference ratios. */
1985 compute_reference_ratios(root_sink
);
1988 if (root_sink
->set_volume
) {
1989 /* If we have a function set_volume(), then we do not apply a
1990 * soft volume by default. However, set_volume() is free to
1991 * apply one to root_sink->soft_volume */
1993 pa_cvolume_reset(&root_sink
->soft_volume
, root_sink
->sample_spec
.channels
);
1994 if (!(root_sink
->flags
& PA_SINK_DEFERRED_VOLUME
))
1995 root_sink
->set_volume(root_sink
);
1998 /* If we have no function set_volume(), then the soft volume
1999 * becomes the real volume */
2000 root_sink
->soft_volume
= root_sink
->real_volume
;
2002 /* This tells the sink that soft volume and/or real volume changed */
2004 pa_assert_se(pa_asyncmsgq_send(root_sink
->asyncmsgq
, PA_MSGOBJECT(root_sink
), PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
) == 0);
2007 /* Called from the io thread if sync volume is used, otherwise from the main thread.
2008 * Only to be called by sink implementor */
2009 void pa_sink_set_soft_volume(pa_sink
*s
, const pa_cvolume
*volume
) {
2011 pa_sink_assert_ref(s
);
2012 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2014 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
)
2015 pa_sink_assert_io_context(s
);
2017 pa_assert_ctl_context();
2020 pa_cvolume_reset(&s
->soft_volume
, s
->sample_spec
.channels
);
2022 s
->soft_volume
= *volume
;
2024 if (PA_SINK_IS_LINKED(s
->state
) && !(s
->flags
& PA_SINK_DEFERRED_VOLUME
))
2025 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME
, NULL
, 0, NULL
) == 0);
2027 s
->thread_info
.soft_volume
= s
->soft_volume
;
2030 /* Called from the main thread. Only called for the root sink in volume sharing
2031 * cases, except for internal recursive calls. */
2032 static void propagate_real_volume(pa_sink
*s
, const pa_cvolume
*old_real_volume
) {
2036 pa_sink_assert_ref(s
);
2037 pa_assert(old_real_volume
);
2038 pa_assert_ctl_context();
2039 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2041 /* This is called when the hardware's real volume changes due to
2042 * some external event. We copy the real volume into our
2043 * reference volume and then rebuild the stream volumes based on
2044 * i->real_ratio which should stay fixed. */
2046 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
2047 if (pa_cvolume_equal(old_real_volume
, &s
->real_volume
))
2050 /* 1. Make the real volume the reference volume */
2051 update_reference_volume(s
, &s
->real_volume
, &s
->channel_map
, TRUE
);
2054 if (pa_sink_flat_volume_enabled(s
)) {
2056 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2057 pa_cvolume old_volume
= i
->volume
;
2059 /* 2. Since the sink's reference and real volumes are equal
2060 * now our ratios should be too. */
2061 i
->reference_ratio
= i
->real_ratio
;
2063 /* 3. Recalculate the new stream reference volume based on the
2064 * reference ratio and the sink's reference volume.
2066 * This basically calculates:
2068 * i->volume = s->reference_volume * i->reference_ratio
2070 * This is identical to propagate_reference_volume() */
2071 i
->volume
= s
->reference_volume
;
2072 pa_cvolume_remap(&i
->volume
, &s
->channel_map
, &i
->channel_map
);
2073 pa_sw_cvolume_multiply(&i
->volume
, &i
->volume
, &i
->reference_ratio
);
2075 /* Notify if something changed */
2076 if (!pa_cvolume_equal(&old_volume
, &i
->volume
)) {
2078 if (i
->volume_changed
)
2079 i
->volume_changed(i
);
2081 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
2084 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2085 propagate_real_volume(i
->origin_sink
, old_real_volume
);
2089 /* Something got changed in the hardware. It probably makes sense
2090 * to save changed hw settings given that hw volume changes not
2091 * triggered by PA are almost certainly done by the user. */
2092 if (!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2093 s
->save_volume
= TRUE
;
2096 /* Called from io thread */
2097 void pa_sink_update_volume_and_mute(pa_sink
*s
) {
2099 pa_sink_assert_io_context(s
);
2101 pa_asyncmsgq_post(pa_thread_mq_get()->outq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
, NULL
, 0, NULL
, NULL
);
2104 /* Called from main thread */
2105 const pa_cvolume
*pa_sink_get_volume(pa_sink
*s
, pa_bool_t force_refresh
) {
2106 pa_sink_assert_ref(s
);
2107 pa_assert_ctl_context();
2108 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2110 if (s
->refresh_volume
|| force_refresh
) {
2111 struct pa_cvolume old_real_volume
;
2113 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2115 old_real_volume
= s
->real_volume
;
2117 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
)
2120 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_VOLUME
, NULL
, 0, NULL
) == 0);
2122 update_real_volume(s
, &s
->real_volume
, &s
->channel_map
);
2123 propagate_real_volume(s
, &old_real_volume
);
2126 return &s
->reference_volume
;
2129 /* Called from main thread. In volume sharing cases, only the root sink may
2131 void pa_sink_volume_changed(pa_sink
*s
, const pa_cvolume
*new_real_volume
) {
2132 pa_cvolume old_real_volume
;
2134 pa_sink_assert_ref(s
);
2135 pa_assert_ctl_context();
2136 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2137 pa_assert(!(s
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
));
2139 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2141 old_real_volume
= s
->real_volume
;
2142 update_real_volume(s
, new_real_volume
, &s
->channel_map
);
2143 propagate_real_volume(s
, &old_real_volume
);
2146 /* Called from main thread */
2147 void pa_sink_set_mute(pa_sink
*s
, pa_bool_t mute
, pa_bool_t save
) {
2148 pa_bool_t old_muted
;
2150 pa_sink_assert_ref(s
);
2151 pa_assert_ctl_context();
2152 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2154 old_muted
= s
->muted
;
2156 s
->save_muted
= (old_muted
== s
->muted
&& s
->save_muted
) || save
;
2158 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->set_mute
)
2161 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2163 if (old_muted
!= s
->muted
)
2164 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2167 /* Called from main thread */
2168 pa_bool_t
pa_sink_get_mute(pa_sink
*s
, pa_bool_t force_refresh
) {
2170 pa_sink_assert_ref(s
);
2171 pa_assert_ctl_context();
2172 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2174 if (s
->refresh_muted
|| force_refresh
) {
2175 pa_bool_t old_muted
= s
->muted
;
2177 if (!(s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_mute
)
2180 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MUTE
, NULL
, 0, NULL
) == 0);
2182 if (old_muted
!= s
->muted
) {
2183 s
->save_muted
= TRUE
;
2185 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2187 /* Make sure the soft mute status stays in sync */
2188 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MUTE
, NULL
, 0, NULL
) == 0);
2195 /* Called from main thread */
2196 void pa_sink_mute_changed(pa_sink
*s
, pa_bool_t new_muted
) {
2197 pa_sink_assert_ref(s
);
2198 pa_assert_ctl_context();
2199 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2201 /* The sink implementor may call this if the volume changed to make sure everyone is notified */
2203 if (s
->muted
== new_muted
)
2206 s
->muted
= new_muted
;
2207 s
->save_muted
= TRUE
;
2209 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2212 /* Called from main thread */
2213 pa_bool_t
pa_sink_update_proplist(pa_sink
*s
, pa_update_mode_t mode
, pa_proplist
*p
) {
2214 pa_sink_assert_ref(s
);
2215 pa_assert_ctl_context();
2218 pa_proplist_update(s
->proplist
, mode
, p
);
2220 if (PA_SINK_IS_LINKED(s
->state
)) {
2221 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2222 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2228 /* Called from main thread */
2229 /* FIXME -- this should be dropped and be merged into pa_sink_update_proplist() */
2230 void pa_sink_set_description(pa_sink
*s
, const char *description
) {
2232 pa_sink_assert_ref(s
);
2233 pa_assert_ctl_context();
2235 if (!description
&& !pa_proplist_contains(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
))
2238 old
= pa_proplist_gets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2240 if (old
&& description
&& pa_streq(old
, description
))
2244 pa_proplist_sets(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
, description
);
2246 pa_proplist_unset(s
->proplist
, PA_PROP_DEVICE_DESCRIPTION
);
2248 if (s
->monitor_source
) {
2251 n
= pa_sprintf_malloc("Monitor Source of %s", description
? description
: s
->name
);
2252 pa_source_set_description(s
->monitor_source
, n
);
2256 if (PA_SINK_IS_LINKED(s
->state
)) {
2257 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
2258 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PROPLIST_CHANGED
], s
);
2262 /* Called from main thread */
2263 unsigned pa_sink_linked_by(pa_sink
*s
) {
2266 pa_sink_assert_ref(s
);
2267 pa_assert_ctl_context();
2268 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2270 ret
= pa_idxset_size(s
->inputs
);
2272 /* We add in the number of streams connected to us here. Please
2273 * note the asymmetry to pa_sink_used_by()! */
2275 if (s
->monitor_source
)
2276 ret
+= pa_source_linked_by(s
->monitor_source
);
2281 /* Called from main thread */
2282 unsigned pa_sink_used_by(pa_sink
*s
) {
2285 pa_sink_assert_ref(s
);
2286 pa_assert_ctl_context();
2287 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2289 ret
= pa_idxset_size(s
->inputs
);
2290 pa_assert(ret
>= s
->n_corked
);
2292 /* Streams connected to our monitor source do not matter for
2293 * pa_sink_used_by()!.*/
2295 return ret
- s
->n_corked
;
2298 /* Called from main thread */
2299 unsigned pa_sink_check_suspend(pa_sink
*s
) {
2304 pa_sink_assert_ref(s
);
2305 pa_assert_ctl_context();
2307 if (!PA_SINK_IS_LINKED(s
->state
))
2312 PA_IDXSET_FOREACH(i
, s
->inputs
, idx
) {
2313 pa_sink_input_state_t st
;
2315 st
= pa_sink_input_get_state(i
);
2317 /* We do not assert here. It is perfectly valid for a sink input to
2318 * be in the INIT state (i.e. created, marked done but not yet put)
2319 * and we should not care if it's unlinked as it won't contribute
2320 * towards our busy status.
2322 if (!PA_SINK_INPUT_IS_LINKED(st
))
2325 if (st
== PA_SINK_INPUT_CORKED
)
2328 if (i
->flags
& PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND
)
2334 if (s
->monitor_source
)
2335 ret
+= pa_source_check_suspend(s
->monitor_source
);
2340 /* Called from the IO thread */
2341 static void sync_input_volumes_within_thread(pa_sink
*s
) {
2345 pa_sink_assert_ref(s
);
2346 pa_sink_assert_io_context(s
);
2348 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2349 if (pa_cvolume_equal(&i
->thread_info
.soft_volume
, &i
->soft_volume
))
2352 i
->thread_info
.soft_volume
= i
->soft_volume
;
2353 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
, FALSE
);
2357 /* Called from the IO thread. Only called for the root sink in volume sharing
2358 * cases, except for internal recursive calls. */
2359 static void set_shared_volume_within_thread(pa_sink
*s
) {
2360 pa_sink_input
*i
= NULL
;
2363 pa_sink_assert_ref(s
);
2365 PA_MSGOBJECT(s
)->process_msg(PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_VOLUME_SYNCED
, NULL
, 0, NULL
);
2367 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
) {
2368 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
2369 set_shared_volume_within_thread(i
->origin_sink
);
2373 /* Called from IO thread, except when it is not */
2374 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
2375 pa_sink
*s
= PA_SINK(o
);
2376 pa_sink_assert_ref(s
);
2378 switch ((pa_sink_message_t
) code
) {
2380 case PA_SINK_MESSAGE_ADD_INPUT
: {
2381 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2383 /* If you change anything here, make sure to change the
2384 * sink input handling a few lines down at
2385 * PA_SINK_MESSAGE_FINISH_MOVE, too. */
2387 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2389 /* Since the caller sleeps in pa_sink_input_put(), we can
2390 * safely access data outside of thread_info even though
2393 if ((i
->thread_info
.sync_prev
= i
->sync_prev
)) {
2394 pa_assert(i
->sink
== i
->thread_info
.sync_prev
->sink
);
2395 pa_assert(i
->sync_prev
->sync_next
== i
);
2396 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
;
2399 if ((i
->thread_info
.sync_next
= i
->sync_next
)) {
2400 pa_assert(i
->sink
== i
->thread_info
.sync_next
->sink
);
2401 pa_assert(i
->sync_next
->sync_prev
== i
);
2402 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
;
2405 pa_assert(!i
->thread_info
.attached
);
2406 i
->thread_info
.attached
= TRUE
;
2411 pa_sink_input_set_state_within_thread(i
, i
->state
);
2413 /* The requested latency of the sink input needs to be
2414 * fixed up and then configured on the sink */
2416 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2417 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2419 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2420 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2422 /* We don't rewind here automatically. This is left to the
2423 * sink input implementor because some sink inputs need a
2424 * slow start, i.e. need some time to buffer client
2425 * samples before beginning streaming. */
2427 /* FIXME: Actually rewinding should be requested before
2428 * updating the sink requested latency, because updating
2429 * the requested latency updates also max_rewind of the
2430 * sink. Now consider this: a sink has a 10 s buffer and
2431 * nobody has requested anything less. Then a new stream
2432 * appears while the sink buffer is full. The new stream
2433 * requests e.g. 100 ms latency. That request is forwarded
2434 * to the sink, so now max_rewind is 100 ms. When a rewind
2435 * is requested, the sink will only rewind 100 ms, and the
2436 * new stream will have to wait about 10 seconds before it
2437 * becomes audible. */
2439 /* In flat volume mode we need to update the volume as
2441 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2444 case PA_SINK_MESSAGE_REMOVE_INPUT
: {
2445 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2447 /* If you change anything here, make sure to change the
2448 * sink input handling a few lines down at
2449 * PA_SINK_MESSAGE_START_MOVE, too. */
2454 pa_sink_input_set_state_within_thread(i
, i
->state
);
2456 pa_assert(i
->thread_info
.attached
);
2457 i
->thread_info
.attached
= FALSE
;
2459 /* Since the caller sleeps in pa_sink_input_unlink(),
2460 * we can safely access data outside of thread_info even
2461 * though it is mutable */
2463 pa_assert(!i
->sync_prev
);
2464 pa_assert(!i
->sync_next
);
2466 if (i
->thread_info
.sync_prev
) {
2467 i
->thread_info
.sync_prev
->thread_info
.sync_next
= i
->thread_info
.sync_prev
->sync_next
;
2468 i
->thread_info
.sync_prev
= NULL
;
2471 if (i
->thread_info
.sync_next
) {
2472 i
->thread_info
.sync_next
->thread_info
.sync_prev
= i
->thread_info
.sync_next
->sync_prev
;
2473 i
->thread_info
.sync_next
= NULL
;
2476 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
2477 pa_sink_input_unref(i
);
2479 pa_sink_invalidate_requested_latency(s
, TRUE
);
2480 pa_sink_request_rewind(s
, (size_t) -1);
2482 /* In flat volume mode we need to update the volume as
2484 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2487 case PA_SINK_MESSAGE_START_MOVE
: {
2488 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2490 /* We don't support moving synchronized streams. */
2491 pa_assert(!i
->sync_prev
);
2492 pa_assert(!i
->sync_next
);
2493 pa_assert(!i
->thread_info
.sync_next
);
2494 pa_assert(!i
->thread_info
.sync_prev
);
2496 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2498 size_t sink_nbytes
, total_nbytes
;
2500 /* The old sink probably has some audio from this
2501 * stream in its buffer. We want to "take it back" as
2502 * much as possible and play it to the new sink. We
2503 * don't know at this point how much the old sink can
2504 * rewind. We have to pick something, and that
2505 * something is the full latency of the old sink here.
2506 * So we rewind the stream buffer by the sink latency
2507 * amount, which may be more than what we should
2508 * rewind. This can result in a chunk of audio being
2509 * played both to the old sink and the new sink.
2511 * FIXME: Fix this code so that we don't have to make
2512 * guesses about how much the sink will actually be
2513 * able to rewind. If someone comes up with a solution
2514 * for this, something to note is that the part of the
2515 * latency that the old sink couldn't rewind should
2516 * ideally be compensated after the stream has moved
2517 * to the new sink by adding silence. The new sink
2518 * most likely can't start playing the moved stream
2519 * immediately, and that gap should be removed from
2520 * the "compensation silence" (at least at the time of
2521 * writing this, the move finish code will actually
2522 * already take care of dropping the new sink's
2523 * unrewindable latency, so taking into account the
2524 * unrewindable latency of the old sink is the only
2527 * The render_memblockq contents are discarded,
2528 * because when the sink changes, the format of the
2529 * audio stored in the render_memblockq may change
2530 * too, making the stored audio invalid. FIXME:
2531 * However, the read and write indices are moved back
2532 * the same amount, so if they are not the same now,
2533 * they won't be the same after the rewind either. If
2534 * the write index of the render_memblockq is ahead of
2535 * the read index, then the render_memblockq will feed
2536 * the new sink some silence first, which it shouldn't
2537 * do. The write index should be flushed to be the
2538 * same as the read index. */
2540 /* Get the latency of the sink */
2541 usec
= pa_sink_get_latency_within_thread(s
);
2542 sink_nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2543 total_nbytes
= sink_nbytes
+ pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
2545 if (total_nbytes
> 0) {
2546 i
->thread_info
.rewrite_nbytes
= i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, total_nbytes
) : total_nbytes
;
2547 i
->thread_info
.rewrite_flush
= TRUE
;
2548 pa_sink_input_process_rewind(i
, sink_nbytes
);
2555 pa_assert(i
->thread_info
.attached
);
2556 i
->thread_info
.attached
= FALSE
;
2558 /* Let's remove the sink input ...*/
2559 if (pa_hashmap_remove(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
)))
2560 pa_sink_input_unref(i
);
2562 pa_sink_invalidate_requested_latency(s
, TRUE
);
2564 pa_log_debug("Requesting rewind due to started move");
2565 pa_sink_request_rewind(s
, (size_t) -1);
2567 /* In flat volume mode we need to update the volume as
2569 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2572 case PA_SINK_MESSAGE_FINISH_MOVE
: {
2573 pa_sink_input
*i
= PA_SINK_INPUT(userdata
);
2575 /* We don't support moving synchronized streams. */
2576 pa_assert(!i
->sync_prev
);
2577 pa_assert(!i
->sync_next
);
2578 pa_assert(!i
->thread_info
.sync_next
);
2579 pa_assert(!i
->thread_info
.sync_prev
);
2581 pa_hashmap_put(s
->thread_info
.inputs
, PA_UINT32_TO_PTR(i
->index
), pa_sink_input_ref(i
));
2583 pa_assert(!i
->thread_info
.attached
);
2584 i
->thread_info
.attached
= TRUE
;
2589 if (i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
2593 /* In the ideal case the new sink would start playing
2594 * the stream immediately. That requires the sink to
2595 * be able to rewind all of its latency, which usually
2596 * isn't possible, so there will probably be some gap
2597 * before the moved stream becomes audible. We then
2598 * have two possibilities: 1) start playing the stream
2599 * from where it is now, or 2) drop the unrewindable
2600 * latency of the sink from the stream. With option 1
2601 * we won't lose any audio but the stream will have a
2602 * pause. With option 2 we may lose some audio but the
2603 * stream time will be somewhat in sync with the wall
2604 * clock. Lennart seems to have chosen option 2 (one
2605 * of the reasons might have been that option 1 is
2606 * actually much harder to implement), so we drop the
2607 * latency of the new sink from the moved stream and
2608 * hope that the sink will undo most of that in the
2611 /* Get the latency of the sink */
2612 usec
= pa_sink_get_latency_within_thread(s
);
2613 nbytes
= pa_usec_to_bytes(usec
, &s
->sample_spec
);
2616 pa_sink_input_drop(i
, nbytes
);
2618 pa_log_debug("Requesting rewind due to finished move");
2619 pa_sink_request_rewind(s
, nbytes
);
2622 /* Updating the requested sink latency has to be done
2623 * after the sink rewind request, not before, because
2624 * otherwise the sink may limit the rewind amount
2627 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1)
2628 pa_sink_input_set_requested_latency_within_thread(i
, i
->thread_info
.requested_sink_latency
);
2630 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2631 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
2633 return o
->process_msg(o
, PA_SINK_MESSAGE_SET_SHARED_VOLUME
, NULL
, 0, NULL
);
2636 case PA_SINK_MESSAGE_SET_SHARED_VOLUME
: {
2637 pa_sink
*root_sink
= pa_sink_get_master(s
);
2639 if (PA_LIKELY(root_sink
))
2640 set_shared_volume_within_thread(root_sink
);
2645 case PA_SINK_MESSAGE_SET_VOLUME_SYNCED
:
2647 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
2649 pa_sink_volume_change_push(s
);
2651 /* Fall through ... */
2653 case PA_SINK_MESSAGE_SET_VOLUME
:
2655 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2656 s
->thread_info
.soft_volume
= s
->soft_volume
;
2657 pa_sink_request_rewind(s
, (size_t) -1);
2660 /* Fall through ... */
2662 case PA_SINK_MESSAGE_SYNC_VOLUMES
:
2663 sync_input_volumes_within_thread(s
);
2666 case PA_SINK_MESSAGE_GET_VOLUME
:
2668 if ((s
->flags
& PA_SINK_DEFERRED_VOLUME
) && s
->get_volume
) {
2670 pa_sink_volume_change_flush(s
);
2671 pa_sw_cvolume_divide(&s
->thread_info
.current_hw_volume
, &s
->real_volume
, &s
->soft_volume
);
2674 /* In case sink implementor reset SW volume. */
2675 if (!pa_cvolume_equal(&s
->thread_info
.soft_volume
, &s
->soft_volume
)) {
2676 s
->thread_info
.soft_volume
= s
->soft_volume
;
2677 pa_sink_request_rewind(s
, (size_t) -1);
2682 case PA_SINK_MESSAGE_SET_MUTE
:
2684 if (s
->thread_info
.soft_muted
!= s
->muted
) {
2685 s
->thread_info
.soft_muted
= s
->muted
;
2686 pa_sink_request_rewind(s
, (size_t) -1);
2689 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->set_mute
)
2694 case PA_SINK_MESSAGE_GET_MUTE
:
2696 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
&& s
->get_mute
)
2701 case PA_SINK_MESSAGE_SET_STATE
: {
2703 pa_bool_t suspend_change
=
2704 (s
->thread_info
.state
== PA_SINK_SUSPENDED
&& PA_SINK_IS_OPENED(PA_PTR_TO_UINT(userdata
))) ||
2705 (PA_SINK_IS_OPENED(s
->thread_info
.state
) && PA_PTR_TO_UINT(userdata
) == PA_SINK_SUSPENDED
);
2707 s
->thread_info
.state
= PA_PTR_TO_UINT(userdata
);
2709 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
) {
2710 s
->thread_info
.rewind_nbytes
= 0;
2711 s
->thread_info
.rewind_requested
= FALSE
;
2714 if (suspend_change
) {
2718 while ((i
= pa_hashmap_iterate(s
->thread_info
.inputs
, &state
, NULL
)))
2719 if (i
->suspend_within_thread
)
2720 i
->suspend_within_thread(i
, s
->thread_info
.state
== PA_SINK_SUSPENDED
);
2726 case PA_SINK_MESSAGE_DETACH
:
2728 /* Detach all streams */
2729 pa_sink_detach_within_thread(s
);
2732 case PA_SINK_MESSAGE_ATTACH
:
2734 /* Reattach all streams */
2735 pa_sink_attach_within_thread(s
);
2738 case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
: {
2740 pa_usec_t
*usec
= userdata
;
2741 *usec
= pa_sink_get_requested_latency_within_thread(s
);
2743 /* Yes, that's right, the IO thread will see -1 when no
2744 * explicit requested latency is configured, the main
2745 * thread will see max_latency */
2746 if (*usec
== (pa_usec_t
) -1)
2747 *usec
= s
->thread_info
.max_latency
;
2752 case PA_SINK_MESSAGE_SET_LATENCY_RANGE
: {
2753 pa_usec_t
*r
= userdata
;
2755 pa_sink_set_latency_range_within_thread(s
, r
[0], r
[1]);
2760 case PA_SINK_MESSAGE_GET_LATENCY_RANGE
: {
2761 pa_usec_t
*r
= userdata
;
2763 r
[0] = s
->thread_info
.min_latency
;
2764 r
[1] = s
->thread_info
.max_latency
;
2769 case PA_SINK_MESSAGE_GET_FIXED_LATENCY
:
2771 *((pa_usec_t
*) userdata
) = s
->thread_info
.fixed_latency
;
2774 case PA_SINK_MESSAGE_SET_FIXED_LATENCY
:
2776 pa_sink_set_fixed_latency_within_thread(s
, (pa_usec_t
) offset
);
2779 case PA_SINK_MESSAGE_GET_MAX_REWIND
:
2781 *((size_t*) userdata
) = s
->thread_info
.max_rewind
;
2784 case PA_SINK_MESSAGE_GET_MAX_REQUEST
:
2786 *((size_t*) userdata
) = s
->thread_info
.max_request
;
2789 case PA_SINK_MESSAGE_SET_MAX_REWIND
:
2791 pa_sink_set_max_rewind_within_thread(s
, (size_t) offset
);
2794 case PA_SINK_MESSAGE_SET_MAX_REQUEST
:
2796 pa_sink_set_max_request_within_thread(s
, (size_t) offset
);
2799 case PA_SINK_MESSAGE_SET_PORT
:
2801 pa_assert(userdata
);
2803 struct sink_message_set_port
*msg_data
= userdata
;
2804 msg_data
->ret
= s
->set_port(s
, msg_data
->port
);
2808 case PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE
:
2809 /* This message is sent from IO-thread and handled in main thread. */
2810 pa_assert_ctl_context();
2812 /* Make sure we're not messing with main thread when no longer linked */
2813 if (!PA_SINK_IS_LINKED(s
->state
))
2816 pa_sink_get_volume(s
, TRUE
);
2817 pa_sink_get_mute(s
, TRUE
);
2820 case PA_SINK_MESSAGE_GET_LATENCY
:
2821 case PA_SINK_MESSAGE_MAX
:
2828 /* Called from main thread */
2829 int pa_sink_suspend_all(pa_core
*c
, pa_bool_t suspend
, pa_suspend_cause_t cause
) {
2834 pa_core_assert_ref(c
);
2835 pa_assert_ctl_context();
2836 pa_assert(cause
!= 0);
2838 PA_IDXSET_FOREACH(sink
, c
->sinks
, idx
) {
2841 if ((r
= pa_sink_suspend(sink
, suspend
, cause
)) < 0)
2848 /* Called from main thread */
2849 void pa_sink_detach(pa_sink
*s
) {
2850 pa_sink_assert_ref(s
);
2851 pa_assert_ctl_context();
2852 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2854 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_DETACH
, NULL
, 0, NULL
) == 0);
2857 /* Called from main thread */
2858 void pa_sink_attach(pa_sink
*s
) {
2859 pa_sink_assert_ref(s
);
2860 pa_assert_ctl_context();
2861 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2863 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_ATTACH
, NULL
, 0, NULL
) == 0);
2866 /* Called from IO thread */
2867 void pa_sink_detach_within_thread(pa_sink
*s
) {
2871 pa_sink_assert_ref(s
);
2872 pa_sink_assert_io_context(s
);
2873 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2875 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2879 if (s
->monitor_source
)
2880 pa_source_detach_within_thread(s
->monitor_source
);
2883 /* Called from IO thread */
2884 void pa_sink_attach_within_thread(pa_sink
*s
) {
2888 pa_sink_assert_ref(s
);
2889 pa_sink_assert_io_context(s
);
2890 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2892 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2896 if (s
->monitor_source
)
2897 pa_source_attach_within_thread(s
->monitor_source
);
2900 /* Called from IO thread */
2901 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
) {
2902 pa_sink_assert_ref(s
);
2903 pa_sink_assert_io_context(s
);
2904 pa_assert(PA_SINK_IS_LINKED(s
->thread_info
.state
));
2906 if (s
->thread_info
.state
== PA_SINK_SUSPENDED
)
2909 if (nbytes
== (size_t) -1)
2910 nbytes
= s
->thread_info
.max_rewind
;
2912 nbytes
= PA_MIN(nbytes
, s
->thread_info
.max_rewind
);
2914 if (s
->thread_info
.rewind_requested
&&
2915 nbytes
<= s
->thread_info
.rewind_nbytes
)
2918 s
->thread_info
.rewind_nbytes
= nbytes
;
2919 s
->thread_info
.rewind_requested
= TRUE
;
2921 if (s
->request_rewind
)
2922 s
->request_rewind(s
);
2925 /* Called from IO thread */
2926 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
) {
2927 pa_usec_t result
= (pa_usec_t
) -1;
2930 pa_usec_t monitor_latency
;
2932 pa_sink_assert_ref(s
);
2933 pa_sink_assert_io_context(s
);
2935 if (!(s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
2936 return PA_CLAMP(s
->thread_info
.fixed_latency
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
2938 if (s
->thread_info
.requested_latency_valid
)
2939 return s
->thread_info
.requested_latency
;
2941 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2942 if (i
->thread_info
.requested_sink_latency
!= (pa_usec_t
) -1 &&
2943 (result
== (pa_usec_t
) -1 || result
> i
->thread_info
.requested_sink_latency
))
2944 result
= i
->thread_info
.requested_sink_latency
;
2946 monitor_latency
= pa_source_get_requested_latency_within_thread(s
->monitor_source
);
2948 if (monitor_latency
!= (pa_usec_t
) -1 &&
2949 (result
== (pa_usec_t
) -1 || result
> monitor_latency
))
2950 result
= monitor_latency
;
2952 if (result
!= (pa_usec_t
) -1)
2953 result
= PA_CLAMP(result
, s
->thread_info
.min_latency
, s
->thread_info
.max_latency
);
2955 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
2956 /* Only cache if properly initialized */
2957 s
->thread_info
.requested_latency
= result
;
2958 s
->thread_info
.requested_latency_valid
= TRUE
;
2964 /* Called from main thread */
2965 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
) {
2968 pa_sink_assert_ref(s
);
2969 pa_assert_ctl_context();
2970 pa_assert(PA_SINK_IS_LINKED(s
->state
));
2972 if (s
->state
== PA_SINK_SUSPENDED
)
2975 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
2980 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
2981 void pa_sink_set_max_rewind_within_thread(pa_sink
*s
, size_t max_rewind
) {
2985 pa_sink_assert_ref(s
);
2986 pa_sink_assert_io_context(s
);
2988 if (max_rewind
== s
->thread_info
.max_rewind
)
2991 s
->thread_info
.max_rewind
= max_rewind
;
2993 if (PA_SINK_IS_LINKED(s
->thread_info
.state
))
2994 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
2995 pa_sink_input_update_max_rewind(i
, s
->thread_info
.max_rewind
);
2997 if (s
->monitor_source
)
2998 pa_source_set_max_rewind_within_thread(s
->monitor_source
, s
->thread_info
.max_rewind
);
3001 /* Called from main thread */
3002 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
) {
3003 pa_sink_assert_ref(s
);
3004 pa_assert_ctl_context();
3006 if (PA_SINK_IS_LINKED(s
->state
))
3007 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REWIND
, NULL
, max_rewind
, NULL
) == 0);
3009 pa_sink_set_max_rewind_within_thread(s
, max_rewind
);
3012 /* Called from IO as well as the main thread -- the latter only before the IO thread started up */
3013 void pa_sink_set_max_request_within_thread(pa_sink
*s
, size_t max_request
) {
3016 pa_sink_assert_ref(s
);
3017 pa_sink_assert_io_context(s
);
3019 if (max_request
== s
->thread_info
.max_request
)
3022 s
->thread_info
.max_request
= max_request
;
3024 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3027 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3028 pa_sink_input_update_max_request(i
, s
->thread_info
.max_request
);
3032 /* Called from main thread */
3033 void pa_sink_set_max_request(pa_sink
*s
, size_t max_request
) {
3034 pa_sink_assert_ref(s
);
3035 pa_assert_ctl_context();
3037 if (PA_SINK_IS_LINKED(s
->state
))
3038 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_MAX_REQUEST
, NULL
, max_request
, NULL
) == 0);
3040 pa_sink_set_max_request_within_thread(s
, max_request
);
3043 /* Called from IO thread */
3044 void pa_sink_invalidate_requested_latency(pa_sink
*s
, pa_bool_t dynamic
) {
3048 pa_sink_assert_ref(s
);
3049 pa_sink_assert_io_context(s
);
3051 if ((s
->flags
& PA_SINK_DYNAMIC_LATENCY
))
3052 s
->thread_info
.requested_latency_valid
= FALSE
;
3056 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3058 if (s
->update_requested_latency
)
3059 s
->update_requested_latency(s
);
3061 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3062 if (i
->update_sink_requested_latency
)
3063 i
->update_sink_requested_latency(i
);
3067 /* Called from main thread */
3068 void pa_sink_set_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3069 pa_sink_assert_ref(s
);
3070 pa_assert_ctl_context();
3072 /* min_latency == 0: no limit
3073 * min_latency anything else: specified limit
3075 * Similar for max_latency */
3077 if (min_latency
< ABSOLUTE_MIN_LATENCY
)
3078 min_latency
= ABSOLUTE_MIN_LATENCY
;
3080 if (max_latency
<= 0 ||
3081 max_latency
> ABSOLUTE_MAX_LATENCY
)
3082 max_latency
= ABSOLUTE_MAX_LATENCY
;
3084 pa_assert(min_latency
<= max_latency
);
3086 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3087 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3088 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3089 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3091 if (PA_SINK_IS_LINKED(s
->state
)) {
3097 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3099 pa_sink_set_latency_range_within_thread(s
, min_latency
, max_latency
);
3102 /* Called from main thread */
3103 void pa_sink_get_latency_range(pa_sink
*s
, pa_usec_t
*min_latency
, pa_usec_t
*max_latency
) {
3104 pa_sink_assert_ref(s
);
3105 pa_assert_ctl_context();
3106 pa_assert(min_latency
);
3107 pa_assert(max_latency
);
3109 if (PA_SINK_IS_LINKED(s
->state
)) {
3110 pa_usec_t r
[2] = { 0, 0 };
3112 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_LATENCY_RANGE
, r
, 0, NULL
) == 0);
3114 *min_latency
= r
[0];
3115 *max_latency
= r
[1];
3117 *min_latency
= s
->thread_info
.min_latency
;
3118 *max_latency
= s
->thread_info
.max_latency
;
3122 /* Called from IO thread */
3123 void pa_sink_set_latency_range_within_thread(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
) {
3124 pa_sink_assert_ref(s
);
3125 pa_sink_assert_io_context(s
);
3127 pa_assert(min_latency
>= ABSOLUTE_MIN_LATENCY
);
3128 pa_assert(max_latency
<= ABSOLUTE_MAX_LATENCY
);
3129 pa_assert(min_latency
<= max_latency
);
3131 /* Hmm, let's see if someone forgot to set PA_SINK_DYNAMIC_LATENCY here... */
3132 pa_assert((min_latency
== ABSOLUTE_MIN_LATENCY
&&
3133 max_latency
== ABSOLUTE_MAX_LATENCY
) ||
3134 (s
->flags
& PA_SINK_DYNAMIC_LATENCY
));
3136 if (s
->thread_info
.min_latency
== min_latency
&&
3137 s
->thread_info
.max_latency
== max_latency
)
3140 s
->thread_info
.min_latency
= min_latency
;
3141 s
->thread_info
.max_latency
= max_latency
;
3143 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3147 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3148 if (i
->update_sink_latency_range
)
3149 i
->update_sink_latency_range(i
);
3152 pa_sink_invalidate_requested_latency(s
, FALSE
);
3154 pa_source_set_latency_range_within_thread(s
->monitor_source
, min_latency
, max_latency
);
3157 /* Called from main thread */
3158 void pa_sink_set_fixed_latency(pa_sink
*s
, pa_usec_t latency
) {
3159 pa_sink_assert_ref(s
);
3160 pa_assert_ctl_context();
3162 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3163 pa_assert(latency
== 0);
3167 if (latency
< ABSOLUTE_MIN_LATENCY
)
3168 latency
= ABSOLUTE_MIN_LATENCY
;
3170 if (latency
> ABSOLUTE_MAX_LATENCY
)
3171 latency
= ABSOLUTE_MAX_LATENCY
;
3173 if (PA_SINK_IS_LINKED(s
->state
))
3174 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_FIXED_LATENCY
, NULL
, (int64_t) latency
, NULL
) == 0);
3176 s
->thread_info
.fixed_latency
= latency
;
3178 pa_source_set_fixed_latency(s
->monitor_source
, latency
);
3181 /* Called from main thread */
3182 pa_usec_t
pa_sink_get_fixed_latency(pa_sink
*s
) {
3185 pa_sink_assert_ref(s
);
3186 pa_assert_ctl_context();
3188 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
)
3191 if (PA_SINK_IS_LINKED(s
->state
))
3192 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_FIXED_LATENCY
, &latency
, 0, NULL
) == 0);
3194 latency
= s
->thread_info
.fixed_latency
;
3199 /* Called from IO thread */
3200 void pa_sink_set_fixed_latency_within_thread(pa_sink
*s
, pa_usec_t latency
) {
3201 pa_sink_assert_ref(s
);
3202 pa_sink_assert_io_context(s
);
3204 if (s
->flags
& PA_SINK_DYNAMIC_LATENCY
) {
3205 pa_assert(latency
== 0);
3209 pa_assert(latency
>= ABSOLUTE_MIN_LATENCY
);
3210 pa_assert(latency
<= ABSOLUTE_MAX_LATENCY
);
3212 if (s
->thread_info
.fixed_latency
== latency
)
3215 s
->thread_info
.fixed_latency
= latency
;
3217 if (PA_SINK_IS_LINKED(s
->thread_info
.state
)) {
3221 PA_HASHMAP_FOREACH(i
, s
->thread_info
.inputs
, state
)
3222 if (i
->update_sink_fixed_latency
)
3223 i
->update_sink_fixed_latency(i
);
3226 pa_sink_invalidate_requested_latency(s
, FALSE
);
3228 pa_source_set_fixed_latency_within_thread(s
->monitor_source
, latency
);
3231 /* Called from main context */
3232 size_t pa_sink_get_max_rewind(pa_sink
*s
) {
3234 pa_assert_ctl_context();
3235 pa_sink_assert_ref(s
);
3237 if (!PA_SINK_IS_LINKED(s
->state
))
3238 return s
->thread_info
.max_rewind
;
3240 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REWIND
, &r
, 0, NULL
) == 0);
3245 /* Called from main context */
3246 size_t pa_sink_get_max_request(pa_sink
*s
) {
3248 pa_sink_assert_ref(s
);
3249 pa_assert_ctl_context();
3251 if (!PA_SINK_IS_LINKED(s
->state
))
3252 return s
->thread_info
.max_request
;
3254 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_GET_MAX_REQUEST
, &r
, 0, NULL
) == 0);
3259 /* Called from main context */
3260 int pa_sink_set_port(pa_sink
*s
, const char *name
, pa_bool_t save
) {
3261 pa_device_port
*port
;
3264 pa_sink_assert_ref(s
);
3265 pa_assert_ctl_context();
3268 pa_log_debug("set_port() operation not implemented for sink %u \"%s\"", s
->index
, s
->name
);
3269 return -PA_ERR_NOTIMPLEMENTED
;
3273 return -PA_ERR_NOENTITY
;
3275 if (!(port
= pa_hashmap_get(s
->ports
, name
)))
3276 return -PA_ERR_NOENTITY
;
3278 if (s
->active_port
== port
) {
3279 s
->save_port
= s
->save_port
|| save
;
3283 if (s
->flags
& PA_SINK_DEFERRED_VOLUME
) {
3284 struct sink_message_set_port msg
= { .port
= port
, .ret
= 0 };
3285 pa_assert_se(pa_asyncmsgq_send(s
->asyncmsgq
, PA_MSGOBJECT(s
), PA_SINK_MESSAGE_SET_PORT
, &msg
, 0, NULL
) == 0);
3289 ret
= s
->set_port(s
, port
);
3292 return -PA_ERR_NOENTITY
;
3294 pa_subscription_post(s
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
, s
->index
);
3296 pa_log_info("Changed port of sink %u \"%s\" to %s", s
->index
, s
->name
, port
->name
);
3298 s
->active_port
= port
;
3299 s
->save_port
= save
;
3301 pa_hook_fire(&s
->core
->hooks
[PA_CORE_HOOK_SINK_PORT_CHANGED
], s
);
3306 pa_bool_t
pa_device_init_icon(pa_proplist
*p
, pa_bool_t is_sink
) {
3307 const char *ff
, *c
, *t
= NULL
, *s
= "", *profile
, *bus
;
3311 if (pa_proplist_contains(p
, PA_PROP_DEVICE_ICON_NAME
))
3314 if ((ff
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3316 if (pa_streq(ff
, "microphone"))
3317 t
= "audio-input-microphone";
3318 else if (pa_streq(ff
, "webcam"))
3320 else if (pa_streq(ff
, "computer"))
3322 else if (pa_streq(ff
, "handset"))
3324 else if (pa_streq(ff
, "portable"))
3325 t
= "multimedia-player";
3326 else if (pa_streq(ff
, "tv"))
3327 t
= "video-display";
3330 * The following icons are not part of the icon naming spec,
3331 * because Rodney Dawes sucks as the maintainer of that spec.
3333 * http://lists.freedesktop.org/archives/xdg/2009-May/010397.html
3335 else if (pa_streq(ff
, "headset"))
3336 t
= "audio-headset";
3337 else if (pa_streq(ff
, "headphone"))
3338 t
= "audio-headphones";
3339 else if (pa_streq(ff
, "speaker"))
3340 t
= "audio-speakers";
3341 else if (pa_streq(ff
, "hands-free"))
3342 t
= "audio-handsfree";
3346 if ((c
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3347 if (pa_streq(c
, "modem"))
3354 t
= "audio-input-microphone";
3357 if ((profile
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3358 if (strstr(profile
, "analog"))
3360 else if (strstr(profile
, "iec958"))
3362 else if (strstr(profile
, "hdmi"))
3366 bus
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
);
3368 pa_proplist_setf(p
, PA_PROP_DEVICE_ICON_NAME
, "%s%s%s%s", t
, pa_strempty(s
), bus
? "-" : "", pa_strempty(bus
));
3373 pa_bool_t
pa_device_init_description(pa_proplist
*p
) {
3374 const char *s
, *d
= NULL
, *k
;
3377 if (pa_proplist_contains(p
, PA_PROP_DEVICE_DESCRIPTION
))
3380 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3381 if (pa_streq(s
, "internal"))
3382 d
= _("Internal Audio");
3385 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
)))
3386 if (pa_streq(s
, "modem"))
3390 d
= pa_proplist_gets(p
, PA_PROP_DEVICE_PRODUCT_NAME
);
3395 k
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_DESCRIPTION
);
3398 pa_proplist_setf(p
, PA_PROP_DEVICE_DESCRIPTION
, _("%s %s"), d
, k
);
3400 pa_proplist_sets(p
, PA_PROP_DEVICE_DESCRIPTION
, d
);
3405 pa_bool_t
pa_device_init_intended_roles(pa_proplist
*p
) {
3409 if (pa_proplist_contains(p
, PA_PROP_DEVICE_INTENDED_ROLES
))
3412 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
)))
3413 if (pa_streq(s
, "handset") || pa_streq(s
, "hands-free")
3414 || pa_streq(s
, "headset")) {
3415 pa_proplist_sets(p
, PA_PROP_DEVICE_INTENDED_ROLES
, "phone");
3422 unsigned pa_device_init_priority(pa_proplist
*p
) {
3424 unsigned priority
= 0;
3428 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_CLASS
))) {
3430 if (pa_streq(s
, "sound"))
3432 else if (!pa_streq(s
, "modem"))
3436 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_FORM_FACTOR
))) {
3438 if (pa_streq(s
, "internal"))
3440 else if (pa_streq(s
, "speaker"))
3442 else if (pa_streq(s
, "headphone"))
3446 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_BUS
))) {
3448 if (pa_streq(s
, "pci"))
3450 else if (pa_streq(s
, "usb"))
3452 else if (pa_streq(s
, "bluetooth"))
3456 if ((s
= pa_proplist_gets(p
, PA_PROP_DEVICE_PROFILE_NAME
))) {
3458 if (pa_startswith(s
, "analog-"))
3460 else if (pa_startswith(s
, "iec958-"))
3467 PA_STATIC_FLIST_DECLARE(pa_sink_volume_change
, 0, pa_xfree
);
3469 /* Called from the IO thread. */
3470 static pa_sink_volume_change
*pa_sink_volume_change_new(pa_sink
*s
) {
3471 pa_sink_volume_change
*c
;
3472 if (!(c
= pa_flist_pop(PA_STATIC_FLIST_GET(pa_sink_volume_change
))))
3473 c
= pa_xnew(pa_sink_volume_change
, 1);
3475 PA_LLIST_INIT(pa_sink_volume_change
, c
);
3477 pa_cvolume_reset(&c
->hw_volume
, s
->sample_spec
.channels
);
3481 /* Called from the IO thread. */
3482 static void pa_sink_volume_change_free(pa_sink_volume_change
*c
) {
3484 if (pa_flist_push(PA_STATIC_FLIST_GET(pa_sink_volume_change
), c
) < 0)
3488 /* Called from the IO thread. */
3489 void pa_sink_volume_change_push(pa_sink
*s
) {
3490 pa_sink_volume_change
*c
= NULL
;
3491 pa_sink_volume_change
*nc
= NULL
;
3492 uint32_t safety_margin
= s
->thread_info
.volume_change_safety_margin
;
3494 const char *direction
= NULL
;
3497 nc
= pa_sink_volume_change_new(s
);
3499 /* NOTE: There is already more different volumes in pa_sink that I can remember.
3500 * Adding one more volume for HW would get us rid of this, but I am trying
3501 * to survive with the ones we already have. */
3502 pa_sw_cvolume_divide(&nc
->hw_volume
, &s
->real_volume
, &s
->soft_volume
);
3504 if (!s
->thread_info
.volume_changes
&& pa_cvolume_equal(&nc
->hw_volume
, &s
->thread_info
.current_hw_volume
)) {
3505 pa_log_debug("Volume not changing");
3506 pa_sink_volume_change_free(nc
);
3510 nc
->at
= pa_sink_get_latency_within_thread(s
);
3511 nc
->at
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3513 if (s
->thread_info
.volume_changes_tail
) {
3514 for (c
= s
->thread_info
.volume_changes_tail
; c
; c
= c
->prev
) {
3515 /* If volume is going up let's do it a bit late. If it is going
3516 * down let's do it a bit early. */
3517 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&c
->hw_volume
)) {
3518 if (nc
->at
+ safety_margin
> c
->at
) {
3519 nc
->at
+= safety_margin
;
3524 else if (nc
->at
- safety_margin
> c
->at
) {
3525 nc
->at
-= safety_margin
;
3533 if (pa_cvolume_avg(&nc
->hw_volume
) > pa_cvolume_avg(&s
->thread_info
.current_hw_volume
)) {
3534 nc
->at
+= safety_margin
;
3537 nc
->at
-= safety_margin
;
3540 PA_LLIST_PREPEND(pa_sink_volume_change
, s
->thread_info
.volume_changes
, nc
);
3543 PA_LLIST_INSERT_AFTER(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
, nc
);
3546 pa_log_debug("Volume going %s to %d at %llu", direction
, pa_cvolume_avg(&nc
->hw_volume
), (long long unsigned) nc
->at
);
3548 /* We can ignore volume events that came earlier but should happen later than this. */
3549 PA_LLIST_FOREACH(c
, nc
->next
) {
3550 pa_log_debug("Volume change to %d at %llu was dropped", pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
);
3551 pa_sink_volume_change_free(c
);
3554 s
->thread_info
.volume_changes_tail
= nc
;
3557 /* Called from the IO thread. */
3558 static void pa_sink_volume_change_flush(pa_sink
*s
) {
3559 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3561 s
->thread_info
.volume_changes
= NULL
;
3562 s
->thread_info
.volume_changes_tail
= NULL
;
3564 pa_sink_volume_change
*next
= c
->next
;
3565 pa_sink_volume_change_free(c
);
3570 /* Called from the IO thread. */
3571 pa_bool_t
pa_sink_volume_change_apply(pa_sink
*s
, pa_usec_t
*usec_to_next
) {
3573 pa_bool_t ret
= FALSE
;
3577 if (!s
->thread_info
.volume_changes
|| !PA_SINK_IS_LINKED(s
->state
)) {
3583 pa_assert(s
->write_volume
);
3585 now
= pa_rtclock_now();
3587 while (s
->thread_info
.volume_changes
&& now
>= s
->thread_info
.volume_changes
->at
) {
3588 pa_sink_volume_change
*c
= s
->thread_info
.volume_changes
;
3589 PA_LLIST_REMOVE(pa_sink_volume_change
, s
->thread_info
.volume_changes
, c
);
3590 pa_log_debug("Volume change to %d at %llu was written %llu usec late",
3591 pa_cvolume_avg(&c
->hw_volume
), (long long unsigned) c
->at
, (long long unsigned) (now
- c
->at
));
3593 s
->thread_info
.current_hw_volume
= c
->hw_volume
;
3594 pa_sink_volume_change_free(c
);
3600 if (s
->thread_info
.volume_changes
) {
3602 *usec_to_next
= s
->thread_info
.volume_changes
->at
- now
;
3603 if (pa_log_ratelimit(PA_LOG_DEBUG
))
3604 pa_log_debug("Next volume change in %lld usec", (long long) (s
->thread_info
.volume_changes
->at
- now
));
3609 s
->thread_info
.volume_changes_tail
= NULL
;
3614 /* Called from the IO thread. */
3615 static void pa_sink_volume_change_rewind(pa_sink
*s
, size_t nbytes
) {
3616 /* All the queued volume events later than current latency are shifted to happen earlier. */
3617 pa_sink_volume_change
*c
;
3618 pa_volume_t prev_vol
= pa_cvolume_avg(&s
->thread_info
.current_hw_volume
);
3619 pa_usec_t rewound
= pa_bytes_to_usec(nbytes
, &s
->sample_spec
);
3620 pa_usec_t limit
= pa_sink_get_latency_within_thread(s
);
3622 pa_log_debug("latency = %lld", (long long) limit
);
3623 limit
+= pa_rtclock_now() + s
->thread_info
.volume_change_extra_delay
;
3625 PA_LLIST_FOREACH(c
, s
->thread_info
.volume_changes
) {
3626 pa_usec_t modified_limit
= limit
;
3627 if (prev_vol
> pa_cvolume_avg(&c
->hw_volume
))
3628 modified_limit
-= s
->thread_info
.volume_change_safety_margin
;
3630 modified_limit
+= s
->thread_info
.volume_change_safety_margin
;
3631 if (c
->at
> modified_limit
) {
3633 if (c
->at
< modified_limit
)
3634 c
->at
= modified_limit
;
3636 prev_vol
= pa_cvolume_avg(&c
->hw_volume
);
3638 pa_sink_volume_change_apply(s
, NULL
);
3641 /* Called from the main thread */
3642 /* Gets the list of formats supported by the sink. The members and idxset must
3643 * be freed by the caller. */
3644 pa_idxset
* pa_sink_get_formats(pa_sink
*s
) {
3649 if (s
->get_formats
) {
3650 /* Sink supports format query, all is good */
3651 ret
= s
->get_formats(s
);
3653 /* Sink doesn't support format query, so assume it does PCM */
3654 pa_format_info
*f
= pa_format_info_new();
3655 f
->encoding
= PA_ENCODING_PCM
;
3657 ret
= pa_idxset_new(NULL
, NULL
);
3658 pa_idxset_put(ret
, f
, NULL
);
3664 /* Called from the main thread */
3665 /* Allows an external source to set what formats a sink supports if the sink
3666 * permits this. The function makes a copy of the formats on success. */
3667 pa_bool_t
pa_sink_set_formats(pa_sink
*s
, pa_idxset
*formats
) {
3672 /* Sink supports setting formats -- let's give it a shot */
3673 return s
->set_formats(s
, formats
);
3675 /* Sink doesn't support setting this -- bail out */
3679 /* Called from the main thread */
3680 /* Checks if the sink can accept this format */
3681 pa_bool_t
pa_sink_check_format(pa_sink
*s
, pa_format_info
*f
)
3683 pa_idxset
*formats
= NULL
;
3684 pa_bool_t ret
= FALSE
;
3689 formats
= pa_sink_get_formats(s
);
3692 pa_format_info
*finfo_device
;
3695 PA_IDXSET_FOREACH(finfo_device
, formats
, i
) {
3696 if (pa_format_info_is_compatible(finfo_device
, f
)) {
3702 pa_idxset_free(formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);
3708 /* Called from the main thread */
3709 /* Calculates the intersection between formats supported by the sink and
3710 * in_formats, and returns these, in the order of the sink's formats. */
3711 pa_idxset
* pa_sink_check_formats(pa_sink
*s
, pa_idxset
*in_formats
) {
3712 pa_idxset
*out_formats
= pa_idxset_new(NULL
, NULL
), *sink_formats
= NULL
;
3713 pa_format_info
*f_sink
, *f_in
;
3718 if (!in_formats
|| pa_idxset_isempty(in_formats
))
3721 sink_formats
= pa_sink_get_formats(s
);
3723 PA_IDXSET_FOREACH(f_sink
, sink_formats
, i
) {
3724 PA_IDXSET_FOREACH(f_in
, in_formats
, j
) {
3725 if (pa_format_info_is_compatible(f_sink
, f_in
))
3726 pa_idxset_put(out_formats
, pa_format_info_copy(f_in
), NULL
);
3732 pa_idxset_free(sink_formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);