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
30 #include <pulse/utf8.h>
31 #include <pulse/xmalloc.h>
32 #include <pulse/util.h>
33 #include <pulse/internal.h>
35 #include <pulsecore/core-format.h>
36 #include <pulsecore/mix.h>
37 #include <pulsecore/stream-util.h>
38 #include <pulsecore/core-subscribe.h>
39 #include <pulsecore/log.h>
40 #include <pulsecore/play-memblockq.h>
41 #include <pulsecore/namereg.h>
42 #include <pulsecore/core-util.h>
44 #include "sink-input.h"
46 /* #define SINK_INPUT_DEBUG */
48 #define MEMBLOCKQ_MAXLENGTH (32*1024*1024)
49 #define CONVERT_BUFFER_LENGTH (PA_PAGE_SIZE)
51 PA_DEFINE_PUBLIC_CLASS(pa_sink_input
, pa_msgobject
);
53 struct volume_factor_entry
{
58 static struct volume_factor_entry
*volume_factor_entry_new(const char *key
, const pa_cvolume
*volume
) {
59 struct volume_factor_entry
*entry
;
64 entry
= pa_xnew(struct volume_factor_entry
, 1);
65 entry
->key
= pa_xstrdup(key
);
67 entry
->volume
= *volume
;
72 static void volume_factor_entry_free(struct volume_factor_entry
*volume_entry
) {
73 pa_assert(volume_entry
);
75 pa_xfree(volume_entry
->key
);
76 pa_xfree(volume_entry
);
79 static void volume_factor_from_hashmap(pa_cvolume
*v
, pa_hashmap
*items
, uint8_t channels
) {
80 struct volume_factor_entry
*entry
;
83 pa_cvolume_reset(v
, channels
);
84 PA_HASHMAP_FOREACH(entry
, items
, state
)
85 pa_sw_cvolume_multiply(v
, v
, &entry
->volume
);
88 static void sink_input_free(pa_object
*o
);
89 static void set_real_ratio(pa_sink_input
*i
, const pa_cvolume
*v
);
91 static int check_passthrough_connection(bool passthrough
, pa_sink
*dest
) {
92 if (pa_sink_is_passthrough(dest
)) {
93 pa_log_warn("Sink is already connected to PASSTHROUGH input");
97 /* If current input(s) exist, check new input is not PASSTHROUGH */
98 if (pa_idxset_size(dest
->inputs
) > 0 && passthrough
) {
99 pa_log_warn("Sink is already connected, cannot accept new PASSTHROUGH INPUT");
106 pa_sink_input_new_data
* pa_sink_input_new_data_init(pa_sink_input_new_data
*data
) {
110 data
->resample_method
= PA_RESAMPLER_INVALID
;
111 data
->proplist
= pa_proplist_new();
112 data
->volume_writable
= true;
114 data
->volume_factor_items
= pa_hashmap_new_full(pa_idxset_string_hash_func
, pa_idxset_string_compare_func
, NULL
,
115 (pa_free_cb_t
) volume_factor_entry_free
);
116 data
->volume_factor_sink_items
= pa_hashmap_new_full(pa_idxset_string_hash_func
, pa_idxset_string_compare_func
, NULL
,
117 (pa_free_cb_t
) volume_factor_entry_free
);
122 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data
*data
, const pa_sample_spec
*spec
) {
125 if ((data
->sample_spec_is_set
= !!spec
))
126 data
->sample_spec
= *spec
;
129 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data
*data
, const pa_channel_map
*map
) {
132 if ((data
->channel_map_is_set
= !!map
))
133 data
->channel_map
= *map
;
136 bool pa_sink_input_new_data_is_passthrough(pa_sink_input_new_data
*data
) {
139 if (PA_LIKELY(data
->format
) && PA_UNLIKELY(!pa_format_info_is_pcm(data
->format
)))
142 if (PA_UNLIKELY(data
->flags
& PA_SINK_INPUT_PASSTHROUGH
))
148 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data
*data
, const pa_cvolume
*volume
) {
150 pa_assert(data
->volume_writable
);
152 if ((data
->volume_is_set
= !!volume
))
153 data
->volume
= *volume
;
156 void pa_sink_input_new_data_add_volume_factor(pa_sink_input_new_data
*data
, const char *key
, const pa_cvolume
*volume_factor
) {
157 struct volume_factor_entry
*v
;
161 pa_assert(volume_factor
);
163 v
= volume_factor_entry_new(key
, volume_factor
);
164 pa_assert_se(pa_hashmap_put(data
->volume_factor_items
, v
->key
, v
) >= 0);
167 void pa_sink_input_new_data_add_volume_factor_sink(pa_sink_input_new_data
*data
, const char *key
, const pa_cvolume
*volume_factor
) {
168 struct volume_factor_entry
*v
;
172 pa_assert(volume_factor
);
174 v
= volume_factor_entry_new(key
, volume_factor
);
175 pa_assert_se(pa_hashmap_put(data
->volume_factor_sink_items
, v
->key
, v
) >= 0);
178 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data
*data
, bool mute
) {
181 data
->muted_is_set
= true;
182 data
->muted
= !!mute
;
185 bool pa_sink_input_new_data_set_sink(pa_sink_input_new_data
*data
, pa_sink
*s
, bool save
) {
187 pa_idxset
*formats
= NULL
;
192 if (!data
->req_formats
) {
193 /* We're not working with the extended API */
195 data
->save_sink
= save
;
197 /* Extended API: let's see if this sink supports the formats the client can provide */
198 formats
= pa_sink_check_formats(s
, data
->req_formats
);
200 if (formats
&& !pa_idxset_isempty(formats
)) {
201 /* Sink supports at least one of the requested formats */
203 data
->save_sink
= save
;
204 if (data
->nego_formats
)
205 pa_idxset_free(data
->nego_formats
, (pa_free_cb_t
) pa_format_info_free
);
206 data
->nego_formats
= formats
;
208 /* Sink doesn't support any of the formats requested by the client */
210 pa_idxset_free(formats
, (pa_free_cb_t
) pa_format_info_free
);
218 bool pa_sink_input_new_data_set_formats(pa_sink_input_new_data
*data
, pa_idxset
*formats
) {
222 if (data
->req_formats
)
223 pa_idxset_free(data
->req_formats
, (pa_free_cb_t
) pa_format_info_free
);
225 data
->req_formats
= formats
;
228 /* Trigger format negotiation */
229 return pa_sink_input_new_data_set_sink(data
, data
->sink
, data
->save_sink
);
235 void pa_sink_input_new_data_done(pa_sink_input_new_data
*data
) {
238 if (data
->req_formats
)
239 pa_idxset_free(data
->req_formats
, (pa_free_cb_t
) pa_format_info_free
);
241 if (data
->nego_formats
)
242 pa_idxset_free(data
->nego_formats
, (pa_free_cb_t
) pa_format_info_free
);
245 pa_format_info_free(data
->format
);
247 if (data
->volume_factor_items
)
248 pa_hashmap_free(data
->volume_factor_items
);
250 if (data
->volume_factor_sink_items
)
251 pa_hashmap_free(data
->volume_factor_sink_items
);
253 pa_proplist_free(data
->proplist
);
256 /* Called from main context */
257 static void reset_callbacks(pa_sink_input
*i
) {
261 i
->process_underrun
= NULL
;
262 i
->process_rewind
= NULL
;
263 i
->update_max_rewind
= NULL
;
264 i
->update_max_request
= NULL
;
265 i
->update_sink_requested_latency
= NULL
;
266 i
->update_sink_latency_range
= NULL
;
267 i
->update_sink_fixed_latency
= NULL
;
271 i
->suspend_within_thread
= NULL
;
274 i
->get_latency
= NULL
;
275 i
->state_change
= NULL
;
276 i
->may_move_to
= NULL
;
277 i
->send_event
= NULL
;
278 i
->volume_changed
= NULL
;
279 i
->mute_changed
= NULL
;
282 /* Called from main context */
283 int pa_sink_input_new(
286 pa_sink_input_new_data
*data
) {
289 pa_resampler
*resampler
= NULL
;
290 char st
[PA_SAMPLE_SPEC_SNPRINT_MAX
], cm
[PA_CHANNEL_MAP_SNPRINT_MAX
], fmt
[PA_FORMAT_INFO_SNPRINT_MAX
];
291 pa_channel_map volume_map
;
294 char *memblockq_name
;
299 pa_assert_ctl_context();
302 pa_proplist_update(data
->proplist
, PA_UPDATE_MERGE
, data
->client
->proplist
);
304 if (data
->origin_sink
&& (data
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
))
305 data
->volume_writable
= false;
307 if (!data
->req_formats
) {
308 /* From this point on, we want to work only with formats, and get back
309 * to using the sample spec and channel map after all decisions w.r.t.
310 * routing are complete. */
314 f
= pa_format_info_from_sample_spec2(&data
->sample_spec
, data
->channel_map_is_set
? &data
->channel_map
: NULL
,
315 !(data
->flags
& PA_SINK_INPUT_FIX_FORMAT
),
316 !(data
->flags
& PA_SINK_INPUT_FIX_RATE
),
317 !(data
->flags
& PA_SINK_INPUT_FIX_CHANNELS
));
319 return -PA_ERR_INVALID
;
321 formats
= pa_idxset_new(NULL
, NULL
);
322 pa_idxset_put(formats
, f
, NULL
);
323 pa_sink_input_new_data_set_formats(data
, formats
);
326 if ((r
= pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_INPUT_NEW
], data
)) < 0)
329 pa_return_val_if_fail(!data
->driver
|| pa_utf8_valid(data
->driver
), -PA_ERR_INVALID
);
332 pa_sink
*sink
= pa_namereg_get(core
, NULL
, PA_NAMEREG_SINK
);
333 pa_return_val_if_fail(sink
, -PA_ERR_NOENTITY
);
334 pa_sink_input_new_data_set_sink(data
, sink
, false);
337 /* If something didn't pick a format for us, pick the top-most format since
338 * we assume this is sorted in priority order */
339 if (!data
->format
&& data
->nego_formats
&& !pa_idxset_isempty(data
->nego_formats
))
340 data
->format
= pa_format_info_copy(pa_idxset_first(data
->nego_formats
, NULL
));
342 if (PA_LIKELY(data
->format
)) {
343 pa_log_debug("Negotiated format: %s", pa_format_info_snprint(fmt
, sizeof(fmt
), data
->format
));
345 pa_format_info
*format
;
348 pa_log_info("Sink does not support any requested format:");
349 PA_IDXSET_FOREACH(format
, data
->req_formats
, idx
)
350 pa_log_info(" -- %s", pa_format_info_snprint(fmt
, sizeof(fmt
), format
));
352 return -PA_ERR_NOTSUPPORTED
;
355 pa_return_val_if_fail(PA_SINK_IS_LINKED(pa_sink_get_state(data
->sink
)), -PA_ERR_BADSTATE
);
356 pa_return_val_if_fail(!data
->sync_base
|| (data
->sync_base
->sink
== data
->sink
357 && pa_sink_input_get_state(data
->sync_base
) == PA_SINK_INPUT_CORKED
),
360 /* Routing is done. We have a sink and a format. */
362 if (data
->volume_is_set
&& pa_format_info_is_pcm(data
->format
)) {
363 /* If volume is set, we need to save the original data->channel_map,
364 * so that we can remap the volume from the original channel map to the
365 * final channel map of the stream in case data->channel_map gets
366 * modified in pa_format_info_to_sample_spec2(). */
367 r
= pa_stream_get_volume_channel_map(&data
->volume
, data
->channel_map_is_set
? &data
->channel_map
: NULL
, data
->format
, &volume_map
);
372 /* Now populate the sample spec and channel map according to the final
373 * format that we've negotiated */
374 r
= pa_format_info_to_sample_spec2(data
->format
, &data
->sample_spec
, &data
->channel_map
, &data
->sink
->sample_spec
,
375 &data
->sink
->channel_map
);
379 r
= check_passthrough_connection(pa_sink_input_new_data_is_passthrough(data
), data
->sink
);
383 /* Don't restore (or save) stream volume for passthrough streams and
384 * prevent attenuation/gain */
385 if (pa_sink_input_new_data_is_passthrough(data
)) {
386 data
->volume_is_set
= true;
387 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
388 data
->volume_is_absolute
= true;
389 data
->save_volume
= false;
392 if (!data
->volume_is_set
) {
393 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
394 data
->volume_is_absolute
= false;
395 data
->save_volume
= false;
398 if (!data
->volume_writable
)
399 data
->save_volume
= false;
401 if (data
->volume_is_set
)
402 /* The original volume channel map may be different than the final
403 * stream channel map, so remapping may be needed. */
404 pa_cvolume_remap(&data
->volume
, &volume_map
, &data
->channel_map
);
406 if (!data
->muted_is_set
)
409 if (!(data
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) &&
410 !pa_sample_spec_equal(&data
->sample_spec
, &data
->sink
->sample_spec
)) {
411 /* try to change sink rate. This is done before the FIXATE hook since
412 module-suspend-on-idle can resume a sink */
414 pa_log_info("Trying to change sample rate");
415 if (pa_sink_update_rate(data
->sink
, data
->sample_spec
.rate
, pa_sink_input_new_data_is_passthrough(data
)) >= 0)
416 pa_log_info("Rate changed to %u Hz", data
->sink
->sample_spec
.rate
);
419 if (pa_sink_input_new_data_is_passthrough(data
) &&
420 !pa_sample_spec_equal(&data
->sample_spec
, &data
->sink
->sample_spec
)) {
421 /* rate update failed, or other parts of sample spec didn't match */
423 pa_log_debug("Could not update sink sample spec to match passthrough stream");
424 return -PA_ERR_NOTSUPPORTED
;
427 if (data
->resample_method
== PA_RESAMPLER_INVALID
)
428 data
->resample_method
= core
->resample_method
;
430 pa_return_val_if_fail(data
->resample_method
< PA_RESAMPLER_MAX
, -PA_ERR_INVALID
);
432 if ((r
= pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_INPUT_FIXATE
], data
)) < 0)
435 if ((data
->flags
& PA_SINK_INPUT_NO_CREATE_ON_SUSPEND
) &&
436 pa_sink_get_state(data
->sink
) == PA_SINK_SUSPENDED
) {
437 pa_log_warn("Failed to create sink input: sink is suspended.");
438 return -PA_ERR_BADSTATE
;
441 if (pa_idxset_size(data
->sink
->inputs
) >= PA_MAX_INPUTS_PER_SINK
) {
442 pa_log_warn("Failed to create sink input: too many inputs per sink.");
443 return -PA_ERR_TOOLARGE
;
446 if ((data
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ||
447 !pa_sample_spec_equal(&data
->sample_spec
, &data
->sink
->sample_spec
) ||
448 !pa_channel_map_equal(&data
->channel_map
, &data
->sink
->channel_map
)) {
450 /* Note: for passthrough content we need to adjust the output rate to that of the current sink-input */
451 if (!pa_sink_input_new_data_is_passthrough(data
)) /* no resampler for passthrough content */
452 if (!(resampler
= pa_resampler_new(
454 &data
->sample_spec
, &data
->channel_map
,
455 &data
->sink
->sample_spec
, &data
->sink
->channel_map
,
456 data
->resample_method
,
457 ((data
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
458 ((data
->flags
& PA_SINK_INPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
459 (core
->disable_remixing
|| (data
->flags
& PA_SINK_INPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0) |
460 (core
->disable_lfe_remixing
? PA_RESAMPLER_NO_LFE
: 0)))) {
461 pa_log_warn("Unsupported resampling operation.");
462 return -PA_ERR_NOTSUPPORTED
;
466 i
= pa_msgobject_new(pa_sink_input
);
467 i
->parent
.parent
.free
= sink_input_free
;
468 i
->parent
.process_msg
= pa_sink_input_process_msg
;
471 i
->state
= PA_SINK_INPUT_INIT
;
472 i
->flags
= data
->flags
;
473 i
->proplist
= pa_proplist_copy(data
->proplist
);
474 i
->driver
= pa_xstrdup(pa_path_get_filename(data
->driver
));
475 i
->module
= data
->module
;
476 i
->sink
= data
->sink
;
477 i
->origin_sink
= data
->origin_sink
;
478 i
->client
= data
->client
;
480 i
->requested_resample_method
= data
->resample_method
;
481 i
->actual_resample_method
= resampler
? pa_resampler_get_method(resampler
) : PA_RESAMPLER_INVALID
;
482 i
->sample_spec
= data
->sample_spec
;
483 i
->channel_map
= data
->channel_map
;
484 i
->format
= pa_format_info_copy(data
->format
);
486 if (!data
->volume_is_absolute
&& pa_sink_flat_volume_enabled(i
->sink
)) {
489 /* When the 'absolute' bool is not set then we'll treat the volume
490 * as relative to the sink volume even in flat volume mode */
491 remapped
= data
->sink
->reference_volume
;
492 pa_cvolume_remap(&remapped
, &data
->sink
->channel_map
, &data
->channel_map
);
493 pa_sw_cvolume_multiply(&i
->volume
, &data
->volume
, &remapped
);
495 i
->volume
= data
->volume
;
497 i
->volume_factor_items
= data
->volume_factor_items
;
498 data
->volume_factor_items
= NULL
;
499 volume_factor_from_hashmap(&i
->volume_factor
, i
->volume_factor_items
, i
->sample_spec
.channels
);
501 i
->volume_factor_sink_items
= data
->volume_factor_sink_items
;
502 data
->volume_factor_sink_items
= NULL
;
503 volume_factor_from_hashmap(&i
->volume_factor_sink
, i
->volume_factor_sink_items
, i
->sink
->sample_spec
.channels
);
505 i
->real_ratio
= i
->reference_ratio
= data
->volume
;
506 pa_cvolume_reset(&i
->soft_volume
, i
->sample_spec
.channels
);
507 pa_cvolume_reset(&i
->real_ratio
, i
->sample_spec
.channels
);
508 i
->volume_writable
= data
->volume_writable
;
509 i
->save_volume
= data
->save_volume
;
510 i
->save_sink
= data
->save_sink
;
511 i
->save_muted
= data
->save_muted
;
513 i
->muted
= data
->muted
;
515 if (data
->sync_base
) {
516 i
->sync_next
= data
->sync_base
->sync_next
;
517 i
->sync_prev
= data
->sync_base
;
519 if (data
->sync_base
->sync_next
)
520 data
->sync_base
->sync_next
->sync_prev
= i
;
521 data
->sync_base
->sync_next
= i
;
523 i
->sync_next
= i
->sync_prev
= NULL
;
525 i
->direct_outputs
= pa_idxset_new(NULL
, NULL
);
530 i
->thread_info
.state
= i
->state
;
531 i
->thread_info
.attached
= false;
532 pa_atomic_store(&i
->thread_info
.drained
, 1);
533 i
->thread_info
.sample_spec
= i
->sample_spec
;
534 i
->thread_info
.resampler
= resampler
;
535 i
->thread_info
.soft_volume
= i
->soft_volume
;
536 i
->thread_info
.muted
= i
->muted
;
537 i
->thread_info
.requested_sink_latency
= (pa_usec_t
) -1;
538 i
->thread_info
.rewrite_nbytes
= 0;
539 i
->thread_info
.rewrite_flush
= false;
540 i
->thread_info
.dont_rewind_render
= false;
541 i
->thread_info
.underrun_for
= (uint64_t) -1;
542 i
->thread_info
.underrun_for_sink
= 0;
543 i
->thread_info
.playing_for
= 0;
544 i
->thread_info
.direct_outputs
= pa_hashmap_new(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
);
546 pa_assert_se(pa_idxset_put(core
->sink_inputs
, i
, &i
->index
) == 0);
547 pa_assert_se(pa_idxset_put(i
->sink
->inputs
, pa_sink_input_ref(i
), NULL
) == 0);
550 pa_assert_se(pa_idxset_put(i
->client
->sink_inputs
, i
, NULL
) >= 0);
552 memblockq_name
= pa_sprintf_malloc("sink input render_memblockq [%u]", i
->index
);
553 i
->thread_info
.render_memblockq
= pa_memblockq_new(
558 &i
->sink
->sample_spec
,
563 pa_xfree(memblockq_name
);
565 pt
= pa_proplist_to_string_sep(i
->proplist
, "\n ");
566 pa_log_info("Created input %u \"%s\" on %s with sample spec %s and channel map %s\n %s",
568 pa_strnull(pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
)),
570 pa_sample_spec_snprint(st
, sizeof(st
), &i
->sample_spec
),
571 pa_channel_map_snprint(cm
, sizeof(cm
), &i
->channel_map
),
575 /* Don't forget to call pa_sink_input_put! */
581 /* Called from main context */
582 static void update_n_corked(pa_sink_input
*i
, pa_sink_input_state_t state
) {
584 pa_assert_ctl_context();
589 if (i
->state
== PA_SINK_INPUT_CORKED
&& state
!= PA_SINK_INPUT_CORKED
)
590 pa_assert_se(i
->sink
->n_corked
-- >= 1);
591 else if (i
->state
!= PA_SINK_INPUT_CORKED
&& state
== PA_SINK_INPUT_CORKED
)
595 /* Called from main context */
596 static void sink_input_set_state(pa_sink_input
*i
, pa_sink_input_state_t state
) {
597 pa_sink_input
*ssync
;
599 pa_assert_ctl_context();
601 if (state
== PA_SINK_INPUT_DRAINED
)
602 state
= PA_SINK_INPUT_RUNNING
;
604 if (i
->state
== state
)
607 if (i
->state
== PA_SINK_INPUT_CORKED
&& state
== PA_SINK_INPUT_RUNNING
&& pa_sink_used_by(i
->sink
) == 0 &&
608 !pa_sample_spec_equal(&i
->sample_spec
, &i
->sink
->sample_spec
)) {
609 /* We were uncorked and the sink was not playing anything -- let's try
610 * to update the sample rate to avoid resampling */
611 pa_sink_update_rate(i
->sink
, i
->sample_spec
.rate
, pa_sink_input_is_passthrough(i
));
614 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_STATE
, PA_UINT_TO_PTR(state
), 0, NULL
) == 0);
616 update_n_corked(i
, state
);
619 for (ssync
= i
->sync_prev
; ssync
; ssync
= ssync
->sync_prev
) {
620 update_n_corked(ssync
, state
);
621 ssync
->state
= state
;
623 for (ssync
= i
->sync_next
; ssync
; ssync
= ssync
->sync_next
) {
624 update_n_corked(ssync
, state
);
625 ssync
->state
= state
;
628 if (state
!= PA_SINK_INPUT_UNLINKED
) {
629 pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED
], i
);
631 for (ssync
= i
->sync_prev
; ssync
; ssync
= ssync
->sync_prev
)
632 pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED
], ssync
);
634 for (ssync
= i
->sync_next
; ssync
; ssync
= ssync
->sync_next
)
635 pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED
], ssync
);
637 if (PA_SINK_INPUT_IS_LINKED(state
))
638 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
641 pa_sink_update_status(i
->sink
);
644 /* Called from main context */
645 void pa_sink_input_unlink(pa_sink_input
*i
) {
647 pa_source_output
*o
, *p
= NULL
;
650 pa_assert_ctl_context();
652 /* See pa_sink_unlink() for a couple of comments how this function
655 pa_sink_input_ref(i
);
657 linked
= PA_SINK_INPUT_IS_LINKED(i
->state
);
660 pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_UNLINK
], i
);
663 i
->sync_prev
->sync_next
= i
->sync_next
;
665 i
->sync_next
->sync_prev
= i
->sync_prev
;
667 i
->sync_prev
= i
->sync_next
= NULL
;
669 pa_idxset_remove_by_data(i
->core
->sink_inputs
, i
, NULL
);
672 if (pa_idxset_remove_by_data(i
->sink
->inputs
, i
, NULL
))
673 pa_sink_input_unref(i
);
676 pa_idxset_remove_by_data(i
->client
->sink_inputs
, i
, NULL
);
678 while ((o
= pa_idxset_first(i
->direct_outputs
, NULL
))) {
680 pa_source_output_kill(o
);
684 update_n_corked(i
, PA_SINK_INPUT_UNLINKED
);
685 i
->state
= PA_SINK_INPUT_UNLINKED
;
687 if (linked
&& i
->sink
) {
688 if (pa_sink_input_is_passthrough(i
))
689 pa_sink_leave_passthrough(i
->sink
);
691 /* We might need to update the sink's volume if we are in flat volume mode. */
692 if (pa_sink_flat_volume_enabled(i
->sink
))
693 pa_sink_set_volume(i
->sink
, NULL
, false, false);
695 if (i
->sink
->asyncmsgq
)
696 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_REMOVE_INPUT
, i
, 0, NULL
) == 0);
702 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_REMOVE
, i
->index
);
703 pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST
], i
);
707 if (PA_SINK_IS_LINKED(pa_sink_get_state(i
->sink
)))
708 pa_sink_update_status(i
->sink
);
713 pa_core_maybe_vacuum(i
->core
);
715 pa_sink_input_unref(i
);
718 /* Called from main context */
719 static void sink_input_free(pa_object
*o
) {
720 pa_sink_input
* i
= PA_SINK_INPUT(o
);
723 pa_assert_ctl_context();
724 pa_assert(pa_sink_input_refcnt(i
) == 0);
726 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
727 pa_sink_input_unlink(i
);
729 pa_log_info("Freeing input %u \"%s\"", i
->index
,
730 i
->proplist
? pa_strnull(pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
)) : "");
732 /* Side note: this function must be able to destruct properly any
733 * kind of sink input in any state, even those which are
734 * "half-moved" or are connected to sinks that have no asyncmsgq
735 * and are hence half-destructed themselves! */
737 if (i
->thread_info
.render_memblockq
)
738 pa_memblockq_free(i
->thread_info
.render_memblockq
);
740 if (i
->thread_info
.resampler
)
741 pa_resampler_free(i
->thread_info
.resampler
);
744 pa_format_info_free(i
->format
);
747 pa_proplist_free(i
->proplist
);
749 if (i
->direct_outputs
)
750 pa_idxset_free(i
->direct_outputs
, NULL
);
752 if (i
->thread_info
.direct_outputs
)
753 pa_hashmap_free(i
->thread_info
.direct_outputs
);
755 if (i
->volume_factor_items
)
756 pa_hashmap_free(i
->volume_factor_items
);
758 if (i
->volume_factor_sink_items
)
759 pa_hashmap_free(i
->volume_factor_sink_items
);
765 /* Called from main context */
766 void pa_sink_input_put(pa_sink_input
*i
) {
767 pa_sink_input_state_t state
;
769 pa_sink_input_assert_ref(i
);
770 pa_assert_ctl_context();
772 pa_assert(i
->state
== PA_SINK_INPUT_INIT
);
774 /* The following fields must be initialized properly */
776 pa_assert(i
->process_rewind
);
779 state
= i
->flags
& PA_SINK_INPUT_START_CORKED
? PA_SINK_INPUT_CORKED
: PA_SINK_INPUT_RUNNING
;
781 update_n_corked(i
, state
);
784 /* We might need to update the sink's volume if we are in flat volume mode. */
785 if (pa_sink_flat_volume_enabled(i
->sink
))
786 pa_sink_set_volume(i
->sink
, NULL
, false, i
->save_volume
);
788 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
789 pa_assert(pa_cvolume_is_norm(&i
->volume
));
790 pa_assert(pa_cvolume_is_norm(&i
->reference_ratio
));
793 set_real_ratio(i
, &i
->volume
);
796 if (pa_sink_input_is_passthrough(i
))
797 pa_sink_enter_passthrough(i
->sink
);
799 i
->thread_info
.soft_volume
= i
->soft_volume
;
800 i
->thread_info
.muted
= i
->muted
;
802 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_ADD_INPUT
, i
, 0, NULL
) == 0);
804 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_NEW
, i
->index
);
805 pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PUT
], i
);
807 pa_sink_update_status(i
->sink
);
810 /* Called from main context */
811 void pa_sink_input_kill(pa_sink_input
*i
) {
812 pa_sink_input_assert_ref(i
);
813 pa_assert_ctl_context();
814 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
819 /* Called from main context */
820 pa_usec_t
pa_sink_input_get_latency(pa_sink_input
*i
, pa_usec_t
*sink_latency
) {
821 pa_usec_t r
[2] = { 0, 0 };
823 pa_sink_input_assert_ref(i
);
824 pa_assert_ctl_context();
825 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
827 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_GET_LATENCY
, r
, 0, NULL
) == 0);
830 r
[0] += i
->get_latency(i
);
833 *sink_latency
= r
[1];
838 /* Called from thread context */
839 void pa_sink_input_peek(pa_sink_input
*i
, size_t slength
/* in sink bytes */, pa_memchunk
*chunk
, pa_cvolume
*volume
) {
840 bool do_volume_adj_here
, need_volume_factor_sink
;
842 size_t block_size_max_sink
, block_size_max_sink_input
;
846 pa_sink_input_assert_ref(i
);
847 pa_sink_input_assert_io_context(i
);
848 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
849 pa_assert(pa_frame_aligned(slength
, &i
->sink
->sample_spec
));
853 #ifdef SINK_INPUT_DEBUG
854 pa_log_debug("peek");
857 block_size_max_sink_input
= i
->thread_info
.resampler
?
858 pa_resampler_max_block_size(i
->thread_info
.resampler
) :
859 pa_frame_align(pa_mempool_block_size_max(i
->core
->mempool
), &i
->sample_spec
);
861 block_size_max_sink
= pa_frame_align(pa_mempool_block_size_max(i
->core
->mempool
), &i
->sink
->sample_spec
);
863 /* Default buffer size */
865 slength
= pa_frame_align(CONVERT_BUFFER_LENGTH
, &i
->sink
->sample_spec
);
867 if (slength
> block_size_max_sink
)
868 slength
= block_size_max_sink
;
870 if (i
->thread_info
.resampler
) {
871 ilength
= pa_resampler_request(i
->thread_info
.resampler
, slength
);
874 ilength
= pa_frame_align(CONVERT_BUFFER_LENGTH
, &i
->sample_spec
);
878 /* Length corresponding to slength (without limiting to
879 * block_size_max_sink_input). */
880 ilength_full
= ilength
;
882 if (ilength
> block_size_max_sink_input
)
883 ilength
= block_size_max_sink_input
;
885 /* If the channel maps of the sink and this stream differ, we need
886 * to adjust the volume *before* we resample. Otherwise we can do
887 * it after and leave it for the sink code */
889 do_volume_adj_here
= !pa_channel_map_equal(&i
->channel_map
, &i
->sink
->channel_map
);
890 volume_is_norm
= pa_cvolume_is_norm(&i
->thread_info
.soft_volume
) && !i
->thread_info
.muted
;
891 need_volume_factor_sink
= !pa_cvolume_is_norm(&i
->volume_factor_sink
);
893 while (!pa_memblockq_is_readable(i
->thread_info
.render_memblockq
)) {
896 /* There's nothing in our render queue. We need to fill it up
897 * with data from the implementor. */
899 if (i
->thread_info
.state
== PA_SINK_INPUT_CORKED
||
900 i
->pop(i
, ilength
, &tchunk
) < 0) {
902 /* OK, we're corked or the implementor didn't give us any
903 * data, so let's just hand out silence */
904 pa_atomic_store(&i
->thread_info
.drained
, 1);
906 pa_memblockq_seek(i
->thread_info
.render_memblockq
, (int64_t) slength
, PA_SEEK_RELATIVE
, true);
907 i
->thread_info
.playing_for
= 0;
908 if (i
->thread_info
.underrun_for
!= (uint64_t) -1) {
909 i
->thread_info
.underrun_for
+= ilength_full
;
910 i
->thread_info
.underrun_for_sink
+= slength
;
915 pa_atomic_store(&i
->thread_info
.drained
, 0);
917 pa_assert(tchunk
.length
> 0);
918 pa_assert(tchunk
.memblock
);
920 i
->thread_info
.underrun_for
= 0;
921 i
->thread_info
.underrun_for_sink
= 0;
922 i
->thread_info
.playing_for
+= tchunk
.length
;
924 while (tchunk
.length
> 0) {
926 bool nvfs
= need_volume_factor_sink
;
929 pa_memblock_ref(wchunk
.memblock
);
931 if (wchunk
.length
> block_size_max_sink_input
)
932 wchunk
.length
= block_size_max_sink_input
;
934 /* It might be necessary to adjust the volume here */
935 if (do_volume_adj_here
&& !volume_is_norm
) {
936 pa_memchunk_make_writable(&wchunk
, 0);
938 if (i
->thread_info
.muted
) {
939 pa_silence_memchunk(&wchunk
, &i
->thread_info
.sample_spec
);
942 } else if (!i
->thread_info
.resampler
&& nvfs
) {
945 /* If we don't need a resampler we can merge the
946 * post and the pre volume adjustment into one */
948 pa_sw_cvolume_multiply(&v
, &i
->thread_info
.soft_volume
, &i
->volume_factor_sink
);
949 pa_volume_memchunk(&wchunk
, &i
->thread_info
.sample_spec
, &v
);
953 pa_volume_memchunk(&wchunk
, &i
->thread_info
.sample_spec
, &i
->thread_info
.soft_volume
);
956 if (!i
->thread_info
.resampler
) {
959 pa_memchunk_make_writable(&wchunk
, 0);
960 pa_volume_memchunk(&wchunk
, &i
->sink
->sample_spec
, &i
->volume_factor_sink
);
963 pa_memblockq_push_align(i
->thread_info
.render_memblockq
, &wchunk
);
966 pa_resampler_run(i
->thread_info
.resampler
, &wchunk
, &rchunk
);
968 #ifdef SINK_INPUT_DEBUG
969 pa_log_debug("pushing %lu", (unsigned long) rchunk
.length
);
972 if (rchunk
.memblock
) {
975 pa_memchunk_make_writable(&rchunk
, 0);
976 pa_volume_memchunk(&rchunk
, &i
->sink
->sample_spec
, &i
->volume_factor_sink
);
979 pa_memblockq_push_align(i
->thread_info
.render_memblockq
, &rchunk
);
980 pa_memblock_unref(rchunk
.memblock
);
984 pa_memblock_unref(wchunk
.memblock
);
986 tchunk
.index
+= wchunk
.length
;
987 tchunk
.length
-= wchunk
.length
;
990 pa_memblock_unref(tchunk
.memblock
);
993 pa_assert_se(pa_memblockq_peek(i
->thread_info
.render_memblockq
, chunk
) >= 0);
995 pa_assert(chunk
->length
> 0);
996 pa_assert(chunk
->memblock
);
998 #ifdef SINK_INPUT_DEBUG
999 pa_log_debug("peeking %lu", (unsigned long) chunk
->length
);
1002 if (chunk
->length
> block_size_max_sink
)
1003 chunk
->length
= block_size_max_sink
;
1005 /* Let's see if we had to apply the volume adjustment ourselves,
1006 * or if this can be done by the sink for us */
1008 if (do_volume_adj_here
)
1009 /* We had different channel maps, so we already did the adjustment */
1010 pa_cvolume_reset(volume
, i
->sink
->sample_spec
.channels
);
1011 else if (i
->thread_info
.muted
)
1012 /* We've both the same channel map, so let's have the sink do the adjustment for us*/
1013 pa_cvolume_mute(volume
, i
->sink
->sample_spec
.channels
);
1015 *volume
= i
->thread_info
.soft_volume
;
1018 /* Called from thread context */
1019 void pa_sink_input_drop(pa_sink_input
*i
, size_t nbytes
/* in sink sample spec */) {
1021 pa_sink_input_assert_ref(i
);
1022 pa_sink_input_assert_io_context(i
);
1023 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
1024 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
1025 pa_assert(nbytes
> 0);
1027 #ifdef SINK_INPUT_DEBUG
1028 pa_log_debug("dropping %lu", (unsigned long) nbytes
);
1031 pa_memblockq_drop(i
->thread_info
.render_memblockq
, nbytes
);
1034 /* Called from thread context */
1035 bool pa_sink_input_process_underrun(pa_sink_input
*i
) {
1036 pa_sink_input_assert_ref(i
);
1037 pa_sink_input_assert_io_context(i
);
1039 if (pa_memblockq_is_readable(i
->thread_info
.render_memblockq
))
1042 if (i
->process_underrun
&& i
->process_underrun(i
)) {
1043 /* All valid data has been played back, so we can empty this queue. */
1044 pa_memblockq_silence(i
->thread_info
.render_memblockq
);
1050 /* Called from thread context */
1051 void pa_sink_input_process_rewind(pa_sink_input
*i
, size_t nbytes
/* in sink sample spec */) {
1053 bool called
= false;
1055 pa_sink_input_assert_ref(i
);
1056 pa_sink_input_assert_io_context(i
);
1057 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
1058 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
1060 #ifdef SINK_INPUT_DEBUG
1061 pa_log_debug("rewind(%lu, %lu)", (unsigned long) nbytes
, (unsigned long) i
->thread_info
.rewrite_nbytes
);
1064 lbq
= pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
1066 if (nbytes
> 0 && !i
->thread_info
.dont_rewind_render
) {
1067 pa_log_debug("Have to rewind %lu bytes on render memblockq.", (unsigned long) nbytes
);
1068 pa_memblockq_rewind(i
->thread_info
.render_memblockq
, nbytes
);
1071 if (i
->thread_info
.rewrite_nbytes
== (size_t) -1) {
1073 /* We were asked to drop all buffered data, and rerequest new
1074 * data from implementor the next time peek() is called */
1076 pa_memblockq_flush_write(i
->thread_info
.render_memblockq
, true);
1078 } else if (i
->thread_info
.rewrite_nbytes
> 0) {
1079 size_t max_rewrite
, amount
;
1081 /* Calculate how much make sense to rewrite at most */
1082 max_rewrite
= nbytes
+ lbq
;
1084 /* Transform into local domain */
1085 if (i
->thread_info
.resampler
)
1086 max_rewrite
= pa_resampler_request(i
->thread_info
.resampler
, max_rewrite
);
1088 /* Calculate how much of the rewinded data should actually be rewritten */
1089 amount
= PA_MIN(i
->thread_info
.rewrite_nbytes
, max_rewrite
);
1092 pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) amount
);
1094 /* Tell the implementor */
1095 if (i
->process_rewind
)
1096 i
->process_rewind(i
, amount
);
1099 /* Convert back to sink domain */
1100 if (i
->thread_info
.resampler
)
1101 amount
= pa_resampler_result(i
->thread_info
.resampler
, amount
);
1104 /* Ok, now update the write pointer */
1105 pa_memblockq_seek(i
->thread_info
.render_memblockq
, - ((int64_t) amount
), PA_SEEK_RELATIVE
, true);
1107 if (i
->thread_info
.rewrite_flush
)
1108 pa_memblockq_silence(i
->thread_info
.render_memblockq
);
1110 /* And reset the resampler */
1111 if (i
->thread_info
.resampler
)
1112 pa_resampler_reset(i
->thread_info
.resampler
);
1117 if (i
->process_rewind
)
1118 i
->process_rewind(i
, 0);
1120 i
->thread_info
.rewrite_nbytes
= 0;
1121 i
->thread_info
.rewrite_flush
= false;
1122 i
->thread_info
.dont_rewind_render
= false;
1125 /* Called from thread context */
1126 size_t pa_sink_input_get_max_rewind(pa_sink_input
*i
) {
1127 pa_sink_input_assert_ref(i
);
1128 pa_sink_input_assert_io_context(i
);
1130 return i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, i
->sink
->thread_info
.max_rewind
) : i
->sink
->thread_info
.max_rewind
;
1133 /* Called from thread context */
1134 size_t pa_sink_input_get_max_request(pa_sink_input
*i
) {
1135 pa_sink_input_assert_ref(i
);
1136 pa_sink_input_assert_io_context(i
);
1138 /* We're not verifying the status here, to allow this to be called
1139 * in the state change handler between _INIT and _RUNNING */
1141 return i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, i
->sink
->thread_info
.max_request
) : i
->sink
->thread_info
.max_request
;
1144 /* Called from thread context */
1145 void pa_sink_input_update_max_rewind(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */) {
1146 pa_sink_input_assert_ref(i
);
1147 pa_sink_input_assert_io_context(i
);
1148 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
1149 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
1151 pa_memblockq_set_maxrewind(i
->thread_info
.render_memblockq
, nbytes
);
1153 if (i
->update_max_rewind
)
1154 i
->update_max_rewind(i
, i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, nbytes
) : nbytes
);
1157 /* Called from thread context */
1158 void pa_sink_input_update_max_request(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */) {
1159 pa_sink_input_assert_ref(i
);
1160 pa_sink_input_assert_io_context(i
);
1161 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
1162 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
1164 if (i
->update_max_request
)
1165 i
->update_max_request(i
, i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, nbytes
) : nbytes
);
1168 /* Called from thread context */
1169 pa_usec_t
pa_sink_input_set_requested_latency_within_thread(pa_sink_input
*i
, pa_usec_t usec
) {
1170 pa_sink_input_assert_ref(i
);
1171 pa_sink_input_assert_io_context(i
);
1173 if (!(i
->sink
->flags
& PA_SINK_DYNAMIC_LATENCY
))
1174 usec
= i
->sink
->thread_info
.fixed_latency
;
1176 if (usec
!= (pa_usec_t
) -1)
1177 usec
= PA_CLAMP(usec
, i
->sink
->thread_info
.min_latency
, i
->sink
->thread_info
.max_latency
);
1179 i
->thread_info
.requested_sink_latency
= usec
;
1180 pa_sink_invalidate_requested_latency(i
->sink
, true);
1185 /* Called from main context */
1186 pa_usec_t
pa_sink_input_set_requested_latency(pa_sink_input
*i
, pa_usec_t usec
) {
1187 pa_sink_input_assert_ref(i
);
1188 pa_assert_ctl_context();
1190 if (PA_SINK_INPUT_IS_LINKED(i
->state
) && i
->sink
) {
1191 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
1195 /* If this sink input is not realized yet or we are being moved,
1196 * we have to touch the thread info data directly */
1199 if (!(i
->sink
->flags
& PA_SINK_DYNAMIC_LATENCY
))
1200 usec
= pa_sink_get_fixed_latency(i
->sink
);
1202 if (usec
!= (pa_usec_t
) -1) {
1203 pa_usec_t min_latency
, max_latency
;
1204 pa_sink_get_latency_range(i
->sink
, &min_latency
, &max_latency
);
1205 usec
= PA_CLAMP(usec
, min_latency
, max_latency
);
1209 i
->thread_info
.requested_sink_latency
= usec
;
1214 /* Called from main context */
1215 pa_usec_t
pa_sink_input_get_requested_latency(pa_sink_input
*i
) {
1216 pa_sink_input_assert_ref(i
);
1217 pa_assert_ctl_context();
1219 if (PA_SINK_INPUT_IS_LINKED(i
->state
) && i
->sink
) {
1221 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
1225 /* If this sink input is not realized yet or we are being moved,
1226 * we have to touch the thread info data directly */
1228 return i
->thread_info
.requested_sink_latency
;
1231 /* Called from main context */
1232 void pa_sink_input_set_volume(pa_sink_input
*i
, const pa_cvolume
*volume
, bool save
, bool absolute
) {
1235 pa_sink_input_assert_ref(i
);
1236 pa_assert_ctl_context();
1237 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1239 pa_assert(pa_cvolume_valid(volume
));
1240 pa_assert(volume
->channels
== 1 || pa_cvolume_compatible(volume
, &i
->sample_spec
));
1241 pa_assert(i
->volume_writable
);
1243 if (!absolute
&& pa_sink_flat_volume_enabled(i
->sink
)) {
1244 v
= i
->sink
->reference_volume
;
1245 pa_cvolume_remap(&v
, &i
->sink
->channel_map
, &i
->channel_map
);
1247 if (pa_cvolume_compatible(volume
, &i
->sample_spec
))
1248 volume
= pa_sw_cvolume_multiply(&v
, &v
, volume
);
1250 volume
= pa_sw_cvolume_multiply_scalar(&v
, &v
, pa_cvolume_max(volume
));
1252 if (!pa_cvolume_compatible(volume
, &i
->sample_spec
)) {
1254 volume
= pa_cvolume_scale(&v
, pa_cvolume_max(volume
));
1258 if (pa_cvolume_equal(volume
, &i
->volume
)) {
1259 i
->save_volume
= i
->save_volume
|| save
;
1263 pa_sink_input_set_volume_direct(i
, volume
);
1264 i
->save_volume
= save
;
1266 if (pa_sink_flat_volume_enabled(i
->sink
)) {
1267 /* We are in flat volume mode, so let's update all sink input
1268 * volumes and update the flat volume of the sink */
1270 pa_sink_set_volume(i
->sink
, NULL
, true, save
);
1273 /* OK, we are in normal volume mode. The volume only affects
1275 set_real_ratio(i
, volume
);
1276 i
->reference_ratio
= i
->volume
;
1278 /* Copy the new soft_volume to the thread_info struct */
1279 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME
, NULL
, 0, NULL
) == 0);
1283 void pa_sink_input_add_volume_factor(pa_sink_input
*i
, const char *key
, const pa_cvolume
*volume_factor
) {
1284 struct volume_factor_entry
*v
;
1286 pa_sink_input_assert_ref(i
);
1287 pa_assert_ctl_context();
1288 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1289 pa_assert(volume_factor
);
1291 pa_assert(pa_cvolume_valid(volume_factor
));
1292 pa_assert(volume_factor
->channels
== 1 || pa_cvolume_compatible(volume_factor
, &i
->sample_spec
));
1294 v
= volume_factor_entry_new(key
, volume_factor
);
1295 if (!pa_cvolume_compatible(volume_factor
, &i
->sample_spec
))
1296 pa_cvolume_set(&v
->volume
, i
->sample_spec
.channels
, volume_factor
->values
[0]);
1298 pa_assert_se(pa_hashmap_put(i
->volume_factor_items
, v
->key
, v
) >= 0);
1299 if (pa_hashmap_size(i
->volume_factor_items
) == 1)
1300 i
->volume_factor
= v
->volume
;
1302 pa_sw_cvolume_multiply(&i
->volume_factor
, &i
->volume_factor
, &v
->volume
);
1304 pa_sw_cvolume_multiply(&i
->soft_volume
, &i
->real_ratio
, &i
->volume_factor
);
1306 /* Copy the new soft_volume to the thread_info struct */
1307 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME
, NULL
, 0, NULL
) == 0);
1310 /* Returns 0 if an entry was removed and -1 if no entry for the given key was
1312 int pa_sink_input_remove_volume_factor(pa_sink_input
*i
, const char *key
) {
1313 struct volume_factor_entry
*v
;
1315 pa_sink_input_assert_ref(i
);
1317 pa_assert_ctl_context();
1318 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1320 if (pa_hashmap_remove_and_free(i
->volume_factor_items
, key
) < 0)
1323 switch (pa_hashmap_size(i
->volume_factor_items
)) {
1325 pa_cvolume_reset(&i
->volume_factor
, i
->sample_spec
.channels
);
1328 v
= pa_hashmap_first(i
->volume_factor_items
);
1329 i
->volume_factor
= v
->volume
;
1332 volume_factor_from_hashmap(&i
->volume_factor
, i
->volume_factor_items
, i
->volume_factor
.channels
);
1335 pa_sw_cvolume_multiply(&i
->soft_volume
, &i
->real_ratio
, &i
->volume_factor
);
1337 /* Copy the new soft_volume to the thread_info struct */
1338 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME
, NULL
, 0, NULL
) == 0);
1343 /* Called from main context */
1344 static void set_real_ratio(pa_sink_input
*i
, const pa_cvolume
*v
) {
1345 pa_sink_input_assert_ref(i
);
1346 pa_assert_ctl_context();
1347 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1348 pa_assert(!v
|| pa_cvolume_compatible(v
, &i
->sample_spec
));
1350 /* This basically calculates:
1352 * i->real_ratio := v
1353 * i->soft_volume := i->real_ratio * i->volume_factor */
1358 pa_cvolume_reset(&i
->real_ratio
, i
->sample_spec
.channels
);
1360 pa_sw_cvolume_multiply(&i
->soft_volume
, &i
->real_ratio
, &i
->volume_factor
);
1361 /* We don't copy the data to the thread_info data. That's left for someone else to do */
1364 /* Called from main or I/O context */
1365 bool pa_sink_input_is_passthrough(pa_sink_input
*i
) {
1366 pa_sink_input_assert_ref(i
);
1368 if (PA_UNLIKELY(!pa_format_info_is_pcm(i
->format
)))
1371 if (PA_UNLIKELY(i
->flags
& PA_SINK_INPUT_PASSTHROUGH
))
1377 /* Called from main context */
1378 bool pa_sink_input_is_volume_readable(pa_sink_input
*i
) {
1379 pa_sink_input_assert_ref(i
);
1380 pa_assert_ctl_context();
1382 return !pa_sink_input_is_passthrough(i
);
1385 /* Called from main context */
1386 pa_cvolume
*pa_sink_input_get_volume(pa_sink_input
*i
, pa_cvolume
*volume
, bool absolute
) {
1387 pa_sink_input_assert_ref(i
);
1388 pa_assert_ctl_context();
1389 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1390 pa_assert(pa_sink_input_is_volume_readable(i
));
1392 if (absolute
|| !pa_sink_flat_volume_enabled(i
->sink
))
1393 *volume
= i
->volume
;
1395 *volume
= i
->reference_ratio
;
1400 /* Called from main context */
1401 void pa_sink_input_set_mute(pa_sink_input
*i
, bool mute
, bool save
) {
1402 pa_sink_input_assert_ref(i
);
1403 pa_assert_ctl_context();
1404 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1406 if (mute
== i
->muted
) {
1407 i
->save_muted
|= save
;
1412 i
->save_muted
= save
;
1414 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE
, NULL
, 0, NULL
) == 0);
1416 /* The mute status changed, let's tell people so */
1417 if (i
->mute_changed
)
1420 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1423 /* Called from main context */
1424 bool pa_sink_input_get_mute(pa_sink_input
*i
) {
1425 pa_sink_input_assert_ref(i
);
1426 pa_assert_ctl_context();
1427 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1432 /* Called from main thread */
1433 void pa_sink_input_update_proplist(pa_sink_input
*i
, pa_update_mode_t mode
, pa_proplist
*p
) {
1434 pa_sink_input_assert_ref(i
);
1435 pa_assert_ctl_context();
1438 pa_proplist_update(i
->proplist
, mode
, p
);
1440 if (PA_SINK_INPUT_IS_LINKED(i
->state
)) {
1441 pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED
], i
);
1442 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1446 /* Called from main context */
1447 void pa_sink_input_cork(pa_sink_input
*i
, bool b
) {
1448 pa_sink_input_assert_ref(i
);
1449 pa_assert_ctl_context();
1450 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1452 sink_input_set_state(i
, b
? PA_SINK_INPUT_CORKED
: PA_SINK_INPUT_RUNNING
);
1455 /* Called from main context */
1456 int pa_sink_input_set_rate(pa_sink_input
*i
, uint32_t rate
) {
1457 pa_sink_input_assert_ref(i
);
1458 pa_assert_ctl_context();
1459 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1460 pa_return_val_if_fail(i
->thread_info
.resampler
, -PA_ERR_BADSTATE
);
1462 if (i
->sample_spec
.rate
== rate
)
1465 i
->sample_spec
.rate
= rate
;
1467 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_RATE
, PA_UINT_TO_PTR(rate
), 0, NULL
, NULL
);
1469 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1473 /* Called from main context */
1474 void pa_sink_input_set_name(pa_sink_input
*i
, const char *name
) {
1476 pa_sink_input_assert_ref(i
);
1477 pa_assert_ctl_context();
1479 if (!name
&& !pa_proplist_contains(i
->proplist
, PA_PROP_MEDIA_NAME
))
1482 old
= pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
);
1484 if (old
&& name
&& pa_streq(old
, name
))
1488 pa_proplist_sets(i
->proplist
, PA_PROP_MEDIA_NAME
, name
);
1490 pa_proplist_unset(i
->proplist
, PA_PROP_MEDIA_NAME
);
1492 if (PA_SINK_INPUT_IS_LINKED(i
->state
)) {
1493 pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED
], i
);
1494 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1498 /* Called from main context */
1499 pa_resample_method_t
pa_sink_input_get_resample_method(pa_sink_input
*i
) {
1500 pa_sink_input_assert_ref(i
);
1501 pa_assert_ctl_context();
1503 return i
->actual_resample_method
;
1506 /* Called from main context */
1507 bool pa_sink_input_may_move(pa_sink_input
*i
) {
1508 pa_sink_input_assert_ref(i
);
1509 pa_assert_ctl_context();
1510 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1512 if (i
->flags
& PA_SINK_INPUT_DONT_MOVE
)
1515 if (i
->sync_next
|| i
->sync_prev
) {
1516 pa_log_warn("Moving synchronized streams not supported.");
1523 static bool find_filter_sink_input(pa_sink_input
*target
, pa_sink
*s
) {
1525 while (s
&& s
->input_to_master
) {
1526 if (s
->input_to_master
== target
)
1528 s
= s
->input_to_master
->sink
;
1529 pa_assert(i
++ < 100);
1534 /* Called from main context */
1535 bool pa_sink_input_may_move_to(pa_sink_input
*i
, pa_sink
*dest
) {
1536 pa_sink_input_assert_ref(i
);
1537 pa_assert_ctl_context();
1538 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1539 pa_sink_assert_ref(dest
);
1541 if (dest
== i
->sink
)
1544 if (!pa_sink_input_may_move(i
))
1547 /* Make sure we're not creating a filter sink cycle */
1548 if (find_filter_sink_input(i
, dest
)) {
1549 pa_log_debug("Can't connect input to %s, as that would create a cycle.", dest
->name
);
1553 if (pa_idxset_size(dest
->inputs
) >= PA_MAX_INPUTS_PER_SINK
) {
1554 pa_log_warn("Failed to move sink input: too many inputs per sink.");
1558 if (check_passthrough_connection(pa_sink_input_is_passthrough(i
), dest
) < 0)
1562 if (!i
->may_move_to(i
, dest
))
1568 /* Called from main context */
1569 int pa_sink_input_start_move(pa_sink_input
*i
) {
1570 pa_source_output
*o
, *p
= NULL
;
1571 struct volume_factor_entry
*v
;
1575 pa_sink_input_assert_ref(i
);
1576 pa_assert_ctl_context();
1577 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1580 if (!pa_sink_input_may_move(i
))
1581 return -PA_ERR_NOTSUPPORTED
;
1583 if ((r
= pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE_START
], i
)) < 0)
1586 /* Kill directly connected outputs */
1587 while ((o
= pa_idxset_first(i
->direct_outputs
, NULL
))) {
1589 pa_source_output_kill(o
);
1592 pa_assert(pa_idxset_isempty(i
->direct_outputs
));
1594 pa_idxset_remove_by_data(i
->sink
->inputs
, i
, NULL
);
1596 if (pa_sink_input_get_state(i
) == PA_SINK_INPUT_CORKED
)
1597 pa_assert_se(i
->sink
->n_corked
-- >= 1);
1599 if (pa_sink_input_is_passthrough(i
))
1600 pa_sink_leave_passthrough(i
->sink
);
1602 if (pa_sink_flat_volume_enabled(i
->sink
))
1603 /* We might need to update the sink's volume if we are in flat
1605 pa_sink_set_volume(i
->sink
, NULL
, false, false);
1607 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_START_MOVE
, i
, 0, NULL
) == 0);
1609 pa_sink_update_status(i
->sink
);
1611 PA_HASHMAP_FOREACH(v
, i
->volume_factor_sink_items
, state
)
1612 pa_cvolume_remap(&v
->volume
, &i
->sink
->channel_map
, &i
->channel_map
);
1614 pa_cvolume_remap(&i
->volume_factor_sink
, &i
->sink
->channel_map
, &i
->channel_map
);
1618 pa_sink_input_unref(i
);
1623 /* Called from main context. If i has an origin sink that uses volume sharing,
1624 * then also the origin sink and all streams connected to it need to update
1625 * their volume - this function does all that by using recursion. */
1626 static void update_volume_due_to_moving(pa_sink_input
*i
, pa_sink
*dest
) {
1627 pa_cvolume new_volume
;
1631 pa_assert(i
->sink
); /* The destination sink should already be set. */
1633 if (i
->origin_sink
&& (i
->origin_sink
->flags
& PA_SINK_SHARE_VOLUME_WITH_MASTER
)) {
1634 pa_sink
*root_sink
= pa_sink_get_master(i
->sink
);
1635 pa_sink_input
*origin_sink_input
;
1638 if (PA_UNLIKELY(!root_sink
))
1641 if (pa_sink_flat_volume_enabled(i
->sink
)) {
1642 /* Ok, so the origin sink uses volume sharing, and flat volume is
1643 * enabled. The volume will have to be updated as follows:
1645 * i->volume := i->sink->real_volume
1646 * (handled later by pa_sink_set_volume)
1647 * i->reference_ratio := i->volume / i->sink->reference_volume
1648 * (handled later by pa_sink_set_volume)
1649 * i->real_ratio stays unchanged
1650 * (streams whose origin sink uses volume sharing should
1651 * always have real_ratio of 0 dB)
1652 * i->soft_volume stays unchanged
1653 * (streams whose origin sink uses volume sharing should
1654 * always have volume_factor as soft_volume, so no change
1655 * should be needed) */
1657 pa_assert(pa_cvolume_is_norm(&i
->real_ratio
));
1658 pa_assert(pa_cvolume_equal(&i
->soft_volume
, &i
->volume_factor
));
1660 /* Notifications will be sent by pa_sink_set_volume(). */
1663 /* Ok, so the origin sink uses volume sharing, and flat volume is
1664 * disabled. The volume will have to be updated as follows:
1667 * i->reference_ratio := 0 dB
1668 * i->real_ratio stays unchanged
1669 * (streams whose origin sink uses volume sharing should
1670 * always have real_ratio of 0 dB)
1671 * i->soft_volume stays unchanged
1672 * (streams whose origin sink uses volume sharing should
1673 * always have volume_factor as soft_volume, so no change
1674 * should be needed) */
1676 pa_cvolume_reset(&new_volume
, i
->volume
.channels
);
1677 pa_sink_input_set_volume_direct(i
, &new_volume
);
1678 pa_cvolume_reset(&i
->reference_ratio
, i
->reference_ratio
.channels
);
1679 pa_assert(pa_cvolume_is_norm(&i
->real_ratio
));
1680 pa_assert(pa_cvolume_equal(&i
->soft_volume
, &i
->volume_factor
));
1683 /* Additionally, the origin sink volume needs updating:
1685 * i->origin_sink->reference_volume := root_sink->reference_volume
1686 * i->origin_sink->real_volume := root_sink->real_volume
1687 * i->origin_sink->soft_volume stays unchanged
1688 * (sinks that use volume sharing should always have
1689 * soft_volume of 0 dB) */
1691 new_volume
= root_sink
->reference_volume
;
1692 pa_cvolume_remap(&new_volume
, &root_sink
->channel_map
, &i
->origin_sink
->channel_map
);
1693 pa_sink_set_reference_volume_direct(i
->origin_sink
, &new_volume
);
1695 i
->origin_sink
->real_volume
= root_sink
->real_volume
;
1696 pa_cvolume_remap(&i
->origin_sink
->real_volume
, &root_sink
->channel_map
, &i
->origin_sink
->channel_map
);
1698 pa_assert(pa_cvolume_is_norm(&i
->origin_sink
->soft_volume
));
1700 /* If you wonder whether i->origin_sink->set_volume() should be called
1701 * somewhere, that's not the case, because sinks that use volume
1702 * sharing shouldn't have any internal volume that set_volume() would
1703 * update. If you wonder whether the thread_info variables should be
1704 * synced, yes, they should, and it's done by the
1705 * PA_SINK_MESSAGE_FINISH_MOVE message handler. */
1707 /* Recursively update origin sink inputs. */
1708 PA_IDXSET_FOREACH(origin_sink_input
, i
->origin_sink
->inputs
, idx
)
1709 update_volume_due_to_moving(origin_sink_input
, dest
);
1712 if (pa_sink_flat_volume_enabled(i
->sink
)) {
1713 /* Ok, so this is a regular stream, and flat volume is enabled. The
1714 * volume will have to be updated as follows:
1716 * i->volume := i->reference_ratio * i->sink->reference_volume
1717 * i->reference_ratio stays unchanged
1718 * i->real_ratio := i->volume / i->sink->real_volume
1719 * (handled later by pa_sink_set_volume)
1720 * i->soft_volume := i->real_ratio * i->volume_factor
1721 * (handled later by pa_sink_set_volume) */
1723 new_volume
= i
->sink
->reference_volume
;
1724 pa_cvolume_remap(&new_volume
, &i
->sink
->channel_map
, &i
->channel_map
);
1725 pa_sw_cvolume_multiply(&new_volume
, &new_volume
, &i
->reference_ratio
);
1726 pa_sink_input_set_volume_direct(i
, &new_volume
);
1729 /* Ok, so this is a regular stream, and flat volume is disabled.
1730 * The volume will have to be updated as follows:
1732 * i->volume := i->reference_ratio
1733 * i->reference_ratio stays unchanged
1734 * i->real_ratio := i->reference_ratio
1735 * i->soft_volume := i->real_ratio * i->volume_factor */
1737 pa_sink_input_set_volume_direct(i
, &i
->reference_ratio
);
1738 i
->real_ratio
= i
->reference_ratio
;
1739 pa_sw_cvolume_multiply(&i
->soft_volume
, &i
->real_ratio
, &i
->volume_factor
);
1743 /* If i->sink == dest, then recursion has finished, and we can finally call
1744 * pa_sink_set_volume(), which will do the rest of the updates. */
1745 if ((i
->sink
== dest
) && pa_sink_flat_volume_enabled(i
->sink
))
1746 pa_sink_set_volume(i
->sink
, NULL
, false, i
->save_volume
);
1749 /* Called from main context */
1750 int pa_sink_input_finish_move(pa_sink_input
*i
, pa_sink
*dest
, bool save
) {
1751 struct volume_factor_entry
*v
;
1754 pa_sink_input_assert_ref(i
);
1755 pa_assert_ctl_context();
1756 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1757 pa_assert(!i
->sink
);
1758 pa_sink_assert_ref(dest
);
1760 if (!pa_sink_input_may_move_to(i
, dest
))
1761 return -PA_ERR_NOTSUPPORTED
;
1763 if (pa_sink_input_is_passthrough(i
) && !pa_sink_check_format(dest
, i
->format
)) {
1764 pa_proplist
*p
= pa_proplist_new();
1765 pa_log_debug("New sink doesn't support stream format, sending format-changed and killing");
1766 /* Tell the client what device we want to be on if it is going to
1768 pa_proplist_sets(p
, "device", dest
->name
);
1769 pa_sink_input_send_event(i
, PA_STREAM_EVENT_FORMAT_LOST
, p
);
1770 pa_proplist_free(p
);
1771 return -PA_ERR_NOTSUPPORTED
;
1774 if (!(i
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) &&
1775 !pa_sample_spec_equal(&i
->sample_spec
, &dest
->sample_spec
)) {
1776 /* try to change dest sink rate if possible without glitches.
1777 module-suspend-on-idle resumes destination sink with
1778 SINK_INPUT_MOVE_FINISH hook */
1780 pa_log_info("Trying to change sample rate");
1781 if (pa_sink_update_rate(dest
, i
->sample_spec
.rate
, pa_sink_input_is_passthrough(i
)) >= 0)
1782 pa_log_info("Rate changed to %u Hz", dest
->sample_spec
.rate
);
1789 i
->save_sink
= save
;
1790 pa_idxset_put(dest
->inputs
, pa_sink_input_ref(i
), NULL
);
1792 PA_HASHMAP_FOREACH(v
, i
->volume_factor_sink_items
, state
)
1793 pa_cvolume_remap(&v
->volume
, &i
->channel_map
, &i
->sink
->channel_map
);
1795 pa_cvolume_remap(&i
->volume_factor_sink
, &i
->channel_map
, &i
->sink
->channel_map
);
1797 if (pa_sink_input_get_state(i
) == PA_SINK_INPUT_CORKED
)
1798 i
->sink
->n_corked
++;
1800 pa_sink_input_update_rate(i
);
1802 pa_sink_update_status(dest
);
1804 update_volume_due_to_moving(i
, dest
);
1806 if (pa_sink_input_is_passthrough(i
))
1807 pa_sink_enter_passthrough(i
->sink
);
1809 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_FINISH_MOVE
, i
, 0, NULL
) == 0);
1811 pa_log_debug("Successfully moved sink input %i to %s.", i
->index
, dest
->name
);
1813 /* Notify everyone */
1814 pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE_FINISH
], i
);
1815 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1820 /* Called from main context */
1821 void pa_sink_input_fail_move(pa_sink_input
*i
) {
1823 pa_sink_input_assert_ref(i
);
1824 pa_assert_ctl_context();
1825 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1826 pa_assert(!i
->sink
);
1828 /* Check if someone wants this sink input? */
1829 if (pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE_FAIL
], i
) == PA_HOOK_STOP
)
1835 pa_sink_input_kill(i
);
1838 /* Called from main context */
1839 int pa_sink_input_move_to(pa_sink_input
*i
, pa_sink
*dest
, bool save
) {
1842 pa_sink_input_assert_ref(i
);
1843 pa_assert_ctl_context();
1844 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
1846 pa_sink_assert_ref(dest
);
1848 if (dest
== i
->sink
)
1851 if (!pa_sink_input_may_move_to(i
, dest
))
1852 return -PA_ERR_NOTSUPPORTED
;
1854 pa_sink_input_ref(i
);
1856 if ((r
= pa_sink_input_start_move(i
)) < 0) {
1857 pa_sink_input_unref(i
);
1861 if ((r
= pa_sink_input_finish_move(i
, dest
, save
)) < 0) {
1862 pa_sink_input_fail_move(i
);
1863 pa_sink_input_unref(i
);
1867 pa_sink_input_unref(i
);
1872 /* Called from IO thread context */
1873 void pa_sink_input_set_state_within_thread(pa_sink_input
*i
, pa_sink_input_state_t state
) {
1874 bool corking
, uncorking
;
1876 pa_sink_input_assert_ref(i
);
1877 pa_sink_input_assert_io_context(i
);
1879 if (state
== i
->thread_info
.state
)
1882 if ((state
== PA_SINK_INPUT_DRAINED
|| state
== PA_SINK_INPUT_RUNNING
) &&
1883 !(i
->thread_info
.state
== PA_SINK_INPUT_DRAINED
|| i
->thread_info
.state
!= PA_SINK_INPUT_RUNNING
))
1884 pa_atomic_store(&i
->thread_info
.drained
, 1);
1886 corking
= state
== PA_SINK_INPUT_CORKED
&& i
->thread_info
.state
== PA_SINK_INPUT_RUNNING
;
1887 uncorking
= i
->thread_info
.state
== PA_SINK_INPUT_CORKED
&& state
== PA_SINK_INPUT_RUNNING
;
1889 if (i
->state_change
)
1890 i
->state_change(i
, state
);
1894 pa_log_debug("Requesting rewind due to corking");
1896 /* This will tell the implementing sink input driver to rewind
1897 * so that the unplayed already mixed data is not lost */
1898 pa_sink_input_request_rewind(i
, 0, true, true, false);
1900 /* Set the corked state *after* requesting rewind */
1901 i
->thread_info
.state
= state
;
1903 } else if (uncorking
) {
1905 pa_log_debug("Requesting rewind due to uncorking");
1907 i
->thread_info
.underrun_for
= (uint64_t) -1;
1908 i
->thread_info
.underrun_for_sink
= 0;
1909 i
->thread_info
.playing_for
= 0;
1911 /* Set the uncorked state *before* requesting rewind */
1912 i
->thread_info
.state
= state
;
1914 /* OK, we're being uncorked. Make sure we're not rewound when
1915 * the hw buffer is remixed and request a remix. */
1916 pa_sink_input_request_rewind(i
, 0, false, true, true);
1918 /* We may not be corking or uncorking, but we still need to set the state. */
1919 i
->thread_info
.state
= state
;
1922 /* Called from thread context, except when it is not. */
1923 int pa_sink_input_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
1924 pa_sink_input
*i
= PA_SINK_INPUT(o
);
1925 pa_sink_input_assert_ref(i
);
1929 case PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME
:
1930 if (!pa_cvolume_equal(&i
->thread_info
.soft_volume
, &i
->soft_volume
)) {
1931 i
->thread_info
.soft_volume
= i
->soft_volume
;
1932 pa_sink_input_request_rewind(i
, 0, true, false, false);
1936 case PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE
:
1937 if (i
->thread_info
.muted
!= i
->muted
) {
1938 i
->thread_info
.muted
= i
->muted
;
1939 pa_sink_input_request_rewind(i
, 0, true, false, false);
1943 case PA_SINK_INPUT_MESSAGE_GET_LATENCY
: {
1944 pa_usec_t
*r
= userdata
;
1946 r
[0] += pa_bytes_to_usec(pa_memblockq_get_length(i
->thread_info
.render_memblockq
), &i
->sink
->sample_spec
);
1947 r
[1] += pa_sink_get_latency_within_thread(i
->sink
);
1952 case PA_SINK_INPUT_MESSAGE_SET_RATE
:
1954 i
->thread_info
.sample_spec
.rate
= PA_PTR_TO_UINT(userdata
);
1955 pa_resampler_set_input_rate(i
->thread_info
.resampler
, PA_PTR_TO_UINT(userdata
));
1959 case PA_SINK_INPUT_MESSAGE_SET_STATE
: {
1960 pa_sink_input
*ssync
;
1962 pa_sink_input_set_state_within_thread(i
, PA_PTR_TO_UINT(userdata
));
1964 for (ssync
= i
->thread_info
.sync_prev
; ssync
; ssync
= ssync
->thread_info
.sync_prev
)
1965 pa_sink_input_set_state_within_thread(ssync
, PA_PTR_TO_UINT(userdata
));
1967 for (ssync
= i
->thread_info
.sync_next
; ssync
; ssync
= ssync
->thread_info
.sync_next
)
1968 pa_sink_input_set_state_within_thread(ssync
, PA_PTR_TO_UINT(userdata
));
1973 case PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
: {
1974 pa_usec_t
*usec
= userdata
;
1976 *usec
= pa_sink_input_set_requested_latency_within_thread(i
, *usec
);
1980 case PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY
: {
1981 pa_usec_t
*r
= userdata
;
1983 *r
= i
->thread_info
.requested_sink_latency
;
1988 return -PA_ERR_NOTIMPLEMENTED
;
1991 /* Called from main thread */
1992 pa_sink_input_state_t
pa_sink_input_get_state(pa_sink_input
*i
) {
1993 pa_sink_input_assert_ref(i
);
1994 pa_assert_ctl_context();
1996 if (i
->state
== PA_SINK_INPUT_RUNNING
|| i
->state
== PA_SINK_INPUT_DRAINED
)
1997 return pa_atomic_load(&i
->thread_info
.drained
) ? PA_SINK_INPUT_DRAINED
: PA_SINK_INPUT_RUNNING
;
2002 /* Called from IO context */
2003 bool pa_sink_input_safe_to_remove(pa_sink_input
*i
) {
2004 pa_sink_input_assert_ref(i
);
2005 pa_sink_input_assert_io_context(i
);
2007 if (PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
))
2008 return pa_memblockq_is_empty(i
->thread_info
.render_memblockq
);
2013 /* Called from IO context */
2014 void pa_sink_input_request_rewind(
2016 size_t nbytes
/* in our sample spec */,
2019 bool dont_rewind_render
) {
2023 /* If 'rewrite' is true the sink is rewound as far as requested
2024 * and possible and the exact value of this is passed back the
2025 * implementor via process_rewind(). If 'flush' is also true all
2026 * already rendered data is also dropped.
2028 * If 'rewrite' is false the sink is rewound as far as requested
2029 * and possible and the already rendered data is dropped so that
2030 * in the next iteration we read new data from the
2031 * implementor. This implies 'flush' is true. If
2032 * dont_rewind_render is true then the render memblockq is not
2035 /* nbytes = 0 means maximum rewind request */
2037 pa_sink_input_assert_ref(i
);
2038 pa_sink_input_assert_io_context(i
);
2039 pa_assert(rewrite
|| flush
);
2040 pa_assert(!dont_rewind_render
|| !rewrite
);
2042 /* We don't take rewind requests while we are corked */
2043 if (i
->thread_info
.state
== PA_SINK_INPUT_CORKED
)
2046 nbytes
= PA_MAX(i
->thread_info
.rewrite_nbytes
, nbytes
);
2048 #ifdef SINK_INPUT_DEBUG
2049 pa_log_debug("request rewrite %zu", nbytes
);
2052 /* Calculate how much we can rewind locally without having to
2055 lbq
= pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
2059 /* Check if rewinding for the maximum is requested, and if so, fix up */
2062 /* Calculate maximum number of bytes that could be rewound in theory */
2063 nbytes
= i
->sink
->thread_info
.max_rewind
+ lbq
;
2065 /* Transform from sink domain */
2066 if (i
->thread_info
.resampler
)
2067 nbytes
= pa_resampler_request(i
->thread_info
.resampler
, nbytes
);
2070 /* Remember how much we actually want to rewrite */
2071 if (i
->thread_info
.rewrite_nbytes
!= (size_t) -1) {
2073 /* Make sure to not overwrite over underruns */
2074 if (nbytes
> i
->thread_info
.playing_for
)
2075 nbytes
= (size_t) i
->thread_info
.playing_for
;
2077 i
->thread_info
.rewrite_nbytes
= nbytes
;
2079 i
->thread_info
.rewrite_nbytes
= (size_t) -1;
2082 i
->thread_info
.rewrite_flush
=
2083 i
->thread_info
.rewrite_flush
|| flush
;
2085 i
->thread_info
.dont_rewind_render
=
2086 i
->thread_info
.dont_rewind_render
||
2089 /* nbytes is -1 if some earlier rewind request had rewrite == false. */
2090 if (nbytes
!= (size_t) -1) {
2092 /* Transform to sink domain */
2093 if (i
->thread_info
.resampler
)
2094 nbytes
= pa_resampler_result(i
->thread_info
.resampler
, nbytes
);
2097 pa_sink_request_rewind(i
->sink
, nbytes
- lbq
);
2099 /* This call will make sure process_rewind() is called later */
2100 pa_sink_request_rewind(i
->sink
, 0);
2104 /* Called from main context */
2105 pa_memchunk
* pa_sink_input_get_silence(pa_sink_input
*i
, pa_memchunk
*ret
) {
2106 pa_sink_input_assert_ref(i
);
2107 pa_assert_ctl_context();
2110 /* FIXME: Shouldn't access resampler object from main context! */
2112 pa_silence_memchunk_get(
2113 &i
->core
->silence_cache
,
2117 i
->thread_info
.resampler
? pa_resampler_max_block_size(i
->thread_info
.resampler
) : 0);
2122 /* Called from main context */
2123 void pa_sink_input_send_event(pa_sink_input
*i
, const char *event
, pa_proplist
*data
) {
2124 pa_proplist
*pl
= NULL
;
2125 pa_sink_input_send_event_hook_data hook_data
;
2127 pa_sink_input_assert_ref(i
);
2128 pa_assert_ctl_context();
2135 data
= pl
= pa_proplist_new();
2137 hook_data
.sink_input
= i
;
2138 hook_data
.data
= data
;
2139 hook_data
.event
= event
;
2141 if (pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_SEND_EVENT
], &hook_data
) < 0)
2144 i
->send_event(i
, event
, data
);
2148 pa_proplist_free(pl
);
2151 /* Called from main context */
2152 /* Updates the sink input's resampler with whatever the current sink requires
2153 * -- useful when the underlying sink's rate might have changed */
2154 int pa_sink_input_update_rate(pa_sink_input
*i
) {
2155 pa_resampler
*new_resampler
;
2156 char *memblockq_name
;
2158 pa_sink_input_assert_ref(i
);
2159 pa_assert_ctl_context();
2161 if (i
->thread_info
.resampler
&&
2162 pa_sample_spec_equal(pa_resampler_output_sample_spec(i
->thread_info
.resampler
), &i
->sink
->sample_spec
) &&
2163 pa_channel_map_equal(pa_resampler_output_channel_map(i
->thread_info
.resampler
), &i
->sink
->channel_map
))
2165 new_resampler
= i
->thread_info
.resampler
;
2167 else if (!pa_sink_input_is_passthrough(i
) &&
2168 ((i
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ||
2169 !pa_sample_spec_equal(&i
->sample_spec
, &i
->sink
->sample_spec
) ||
2170 !pa_channel_map_equal(&i
->channel_map
, &i
->sink
->channel_map
))) {
2172 new_resampler
= pa_resampler_new(i
->core
->mempool
,
2173 &i
->sample_spec
, &i
->channel_map
,
2174 &i
->sink
->sample_spec
, &i
->sink
->channel_map
,
2175 i
->requested_resample_method
,
2176 ((i
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
2177 ((i
->flags
& PA_SINK_INPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
2178 (i
->core
->disable_remixing
|| (i
->flags
& PA_SINK_INPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0) |
2179 (i
->core
->disable_lfe_remixing
? PA_RESAMPLER_NO_LFE
: 0));
2181 if (!new_resampler
) {
2182 pa_log_warn("Unsupported resampling operation.");
2183 return -PA_ERR_NOTSUPPORTED
;
2186 new_resampler
= NULL
;
2188 if (new_resampler
== i
->thread_info
.resampler
)
2191 if (i
->thread_info
.resampler
)
2192 pa_resampler_free(i
->thread_info
.resampler
);
2194 i
->thread_info
.resampler
= new_resampler
;
2196 pa_memblockq_free(i
->thread_info
.render_memblockq
);
2198 memblockq_name
= pa_sprintf_malloc("sink input render_memblockq [%u]", i
->index
);
2199 i
->thread_info
.render_memblockq
= pa_memblockq_new(
2202 MEMBLOCKQ_MAXLENGTH
,
2204 &i
->sink
->sample_spec
,
2209 pa_xfree(memblockq_name
);
2211 i
->actual_resample_method
= new_resampler
? pa_resampler_get_method(new_resampler
) : PA_RESAMPLER_INVALID
;
2213 pa_log_debug("Updated resampler for sink input %d", i
->index
);
2218 /* Called from the main thread. */
2219 void pa_sink_input_set_volume_direct(pa_sink_input
*i
, const pa_cvolume
*volume
) {
2220 pa_cvolume old_volume
;
2221 char old_volume_str
[PA_CVOLUME_SNPRINT_VERBOSE_MAX
];
2222 char new_volume_str
[PA_CVOLUME_SNPRINT_VERBOSE_MAX
];
2227 old_volume
= i
->volume
;
2229 if (pa_cvolume_equal(volume
, &old_volume
))
2232 i
->volume
= *volume
;
2233 pa_log_debug("The volume of sink input %u changed from %s to %s.", i
->index
,
2234 pa_cvolume_snprint_verbose(old_volume_str
, sizeof(old_volume_str
), &old_volume
, &i
->channel_map
, true),
2235 pa_cvolume_snprint_verbose(new_volume_str
, sizeof(new_volume_str
), volume
, &i
->channel_map
, true));
2237 if (i
->volume_changed
)
2238 i
->volume_changed(i
);
2240 pa_subscription_post(i
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);