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 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/utf8.h>
32 #include <pulse/xmalloc.h>
34 #include <pulsecore/sample-util.h>
35 #include <pulsecore/core-subscribe.h>
36 #include <pulsecore/log.h>
37 #include <pulsecore/play-memblockq.h>
38 #include <pulsecore/namereg.h>
39 #include <pulsecore/core-util.h>
41 #include "sink-input.h"
43 #define MEMBLOCKQ_MAXLENGTH (32*1024*1024)
44 #define CONVERT_BUFFER_LENGTH (PA_PAGE_SIZE)
46 static PA_DEFINE_CHECK_TYPE(pa_sink_input
, pa_msgobject
);
48 static void sink_input_free(pa_object
*o
);
50 pa_sink_input_new_data
* pa_sink_input_new_data_init(pa_sink_input_new_data
*data
) {
53 memset(data
, 0, sizeof(*data
));
54 data
->resample_method
= PA_RESAMPLER_INVALID
;
55 data
->proplist
= pa_proplist_new();
60 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data
*data
, const pa_sample_spec
*spec
) {
63 if ((data
->sample_spec_is_set
= !!spec
))
64 data
->sample_spec
= *spec
;
67 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data
*data
, const pa_channel_map
*map
) {
70 if ((data
->channel_map_is_set
= !!map
))
71 data
->channel_map
= *map
;
74 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data
*data
, const pa_cvolume
*volume
) {
77 if ((data
->volume_is_set
= !!volume
))
78 data
->volume
= data
->virtual_volume
= *volume
;
81 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data
*data
, pa_bool_t mute
) {
84 data
->muted_is_set
= TRUE
;
88 void pa_sink_input_new_data_done(pa_sink_input_new_data
*data
) {
91 pa_proplist_free(data
->proplist
);
94 /* Called from main context */
95 static void reset_callbacks(pa_sink_input
*i
) {
99 i
->process_rewind
= NULL
;
100 i
->update_max_rewind
= NULL
;
101 i
->update_max_request
= NULL
;
102 i
->update_sink_requested_latency
= NULL
;
103 i
->update_sink_latency_range
= NULL
;
109 i
->get_latency
= NULL
;
110 i
->state_change
= NULL
;
113 /* Called from main context */
114 pa_sink_input
* pa_sink_input_new(
116 pa_sink_input_new_data
*data
,
117 pa_sink_input_flags_t flags
) {
120 pa_resampler
*resampler
= NULL
;
121 char st
[PA_SAMPLE_SPEC_SNPRINT_MAX
], cm
[PA_CHANNEL_MAP_SNPRINT_MAX
];
126 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_INPUT_NEW
], data
) < 0)
129 pa_return_null_if_fail(!data
->driver
|| pa_utf8_valid(data
->driver
));
132 data
->sink
= pa_namereg_get(core
, NULL
, PA_NAMEREG_SINK
, TRUE
);
134 pa_return_null_if_fail(data
->sink
);
135 pa_return_null_if_fail(pa_sink_get_state(data
->sink
) != PA_SINK_UNLINKED
);
136 pa_return_null_if_fail(!data
->sync_base
|| (data
->sync_base
->sink
== data
->sink
&& pa_sink_input_get_state(data
->sync_base
) == PA_SINK_INPUT_CORKED
));
138 if (!data
->sample_spec_is_set
)
139 data
->sample_spec
= data
->sink
->sample_spec
;
141 pa_return_null_if_fail(pa_sample_spec_valid(&data
->sample_spec
));
143 if (!data
->channel_map_is_set
) {
144 if (data
->sink
->channel_map
.channels
== data
->sample_spec
.channels
)
145 data
->channel_map
= data
->sink
->channel_map
;
147 pa_return_null_if_fail(pa_channel_map_init_auto(&data
->channel_map
, data
->sample_spec
.channels
, PA_CHANNEL_MAP_DEFAULT
));
150 pa_return_null_if_fail(pa_channel_map_valid(&data
->channel_map
));
151 pa_return_null_if_fail(data
->channel_map
.channels
== data
->sample_spec
.channels
);
153 if (!data
->volume_is_set
)
154 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
156 pa_return_null_if_fail(pa_cvolume_valid(&data
->volume
));
157 pa_return_null_if_fail(data
->volume
.channels
== data
->sample_spec
.channels
);
159 data
->virtual_volume
= data
->volume
;
161 if (!data
->muted_is_set
)
164 if (flags
& PA_SINK_INPUT_FIX_FORMAT
)
165 data
->sample_spec
.format
= data
->sink
->sample_spec
.format
;
167 if (flags
& PA_SINK_INPUT_FIX_RATE
)
168 data
->sample_spec
.rate
= data
->sink
->sample_spec
.rate
;
170 if (flags
& PA_SINK_INPUT_FIX_CHANNELS
) {
171 data
->sample_spec
.channels
= data
->sink
->sample_spec
.channels
;
172 data
->channel_map
= data
->sink
->channel_map
;
175 pa_assert(pa_sample_spec_valid(&data
->sample_spec
));
176 pa_assert(pa_channel_map_valid(&data
->channel_map
));
178 /* Due to the fixing of the sample spec the volume might not match anymore */
179 if (data
->volume
.channels
!= data
->sample_spec
.channels
)
180 pa_cvolume_set(&data
->volume
, data
->sample_spec
.channels
, pa_cvolume_avg(&data
->volume
));
182 if (data
->resample_method
== PA_RESAMPLER_INVALID
)
183 data
->resample_method
= core
->resample_method
;
185 pa_return_null_if_fail(data
->resample_method
< PA_RESAMPLER_MAX
);
187 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_INPUT_FIXATE
], data
) < 0)
190 if (pa_idxset_size(data
->sink
->inputs
) >= PA_MAX_INPUTS_PER_SINK
) {
191 pa_log_warn("Failed to create sink input: too many inputs per sink.");
195 if ((flags
& PA_SINK_INPUT_VARIABLE_RATE
) ||
196 !pa_sample_spec_equal(&data
->sample_spec
, &data
->sink
->sample_spec
) ||
197 !pa_channel_map_equal(&data
->channel_map
, &data
->sink
->channel_map
)) {
199 if (!(resampler
= pa_resampler_new(
201 &data
->sample_spec
, &data
->channel_map
,
202 &data
->sink
->sample_spec
, &data
->sink
->channel_map
,
203 data
->resample_method
,
204 ((flags
& PA_SINK_INPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
205 ((flags
& PA_SINK_INPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
206 (core
->disable_remixing
|| (flags
& PA_SINK_INPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0) |
207 (core
->disable_lfe_remixing
? PA_RESAMPLER_NO_LFE
: 0)))) {
208 pa_log_warn("Unsupported resampling operation.");
212 data
->resample_method
= pa_resampler_get_method(resampler
);
215 i
= pa_msgobject_new(pa_sink_input
);
216 i
->parent
.parent
.free
= sink_input_free
;
217 i
->parent
.process_msg
= pa_sink_input_process_msg
;
220 i
->state
= PA_SINK_INPUT_INIT
;
222 i
->proplist
= pa_proplist_copy(data
->proplist
);
223 i
->driver
= pa_xstrdup(data
->driver
);
224 i
->module
= data
->module
;
225 i
->sink
= data
->sink
;
226 i
->client
= data
->client
;
228 i
->resample_method
= data
->resample_method
;
229 i
->sample_spec
= data
->sample_spec
;
230 i
->channel_map
= data
->channel_map
;
232 i
->virtual_volume
= data
->virtual_volume
;
233 i
->volume
= data
->volume
;
235 i
->muted
= data
->muted
;
237 if (data
->sync_base
) {
238 i
->sync_next
= data
->sync_base
->sync_next
;
239 i
->sync_prev
= data
->sync_base
;
241 if (data
->sync_base
->sync_next
)
242 data
->sync_base
->sync_next
->sync_prev
= i
;
243 data
->sync_base
->sync_next
= i
;
245 i
->sync_next
= i
->sync_prev
= NULL
;
247 i
->direct_outputs
= pa_idxset_new(NULL
, NULL
);
252 i
->thread_info
.state
= i
->state
;
253 i
->thread_info
.attached
= FALSE
;
254 pa_atomic_store(&i
->thread_info
.drained
, 1);
255 i
->thread_info
.sample_spec
= i
->sample_spec
;
256 i
->thread_info
.resampler
= resampler
;
257 i
->thread_info
.volume
= i
->volume
;
258 i
->thread_info
.muted
= i
->muted
;
259 i
->thread_info
.requested_sink_latency
= (pa_usec_t
) -1;
260 i
->thread_info
.rewrite_nbytes
= 0;
261 i
->thread_info
.rewrite_flush
= FALSE
;
262 i
->thread_info
.underrun_for
= (uint64_t) -1;
263 i
->thread_info
.playing_for
= 0;
264 i
->thread_info
.direct_outputs
= pa_hashmap_new(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
);
266 i
->thread_info
.render_memblockq
= pa_memblockq_new(
270 pa_frame_size(&i
->sink
->sample_spec
),
276 pa_assert_se(pa_idxset_put(core
->sink_inputs
, pa_sink_input_ref(i
), &i
->index
) == 0);
277 pa_assert_se(pa_idxset_put(i
->sink
->inputs
, i
, NULL
) == 0);
279 pa_log_info("Created input %u \"%s\" on %s with sample spec %s and channel map %s",
281 pa_strnull(pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
)),
283 pa_sample_spec_snprint(st
, sizeof(st
), &i
->sample_spec
),
284 pa_channel_map_snprint(cm
, sizeof(cm
), &i
->channel_map
));
286 /* Don't forget to call pa_sink_input_put! */
291 /* Called from main context */
292 static void update_n_corked(pa_sink_input
*i
, pa_sink_input_state_t state
) {
295 if (i
->state
== PA_SINK_INPUT_CORKED
&& state
!= PA_SINK_INPUT_CORKED
)
296 pa_assert_se(i
->sink
->n_corked
-- >= 1);
297 else if (i
->state
!= PA_SINK_INPUT_CORKED
&& state
== PA_SINK_INPUT_CORKED
)
300 pa_sink_update_status(i
->sink
);
303 /* Called from main context */
304 static int sink_input_set_state(pa_sink_input
*i
, pa_sink_input_state_t state
) {
305 pa_sink_input
*ssync
;
308 if (state
== PA_SINK_INPUT_DRAINED
)
309 state
= PA_SINK_INPUT_RUNNING
;
311 if (i
->state
== state
)
314 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);
316 update_n_corked(i
, state
);
319 for (ssync
= i
->sync_prev
; ssync
; ssync
= ssync
->sync_prev
) {
320 update_n_corked(ssync
, state
);
321 ssync
->state
= state
;
323 for (ssync
= i
->sync_next
; ssync
; ssync
= ssync
->sync_next
) {
324 update_n_corked(ssync
, state
);
325 ssync
->state
= state
;
328 if (state
!= PA_SINK_INPUT_UNLINKED
) {
329 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED
], i
);
331 for (ssync
= i
->sync_prev
; ssync
; ssync
= ssync
->sync_prev
)
332 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED
], ssync
);
334 for (ssync
= i
->sync_next
; ssync
; ssync
= ssync
->sync_next
)
335 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED
], ssync
);
341 /* Called from main context */
342 void pa_sink_input_unlink(pa_sink_input
*i
) {
344 pa_source_output
*o
, *p
= NULL
;
347 /* See pa_sink_unlink() for a couple of comments how this function
350 pa_sink_input_ref(i
);
352 linked
= PA_SINK_INPUT_IS_LINKED(i
->state
);
355 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_UNLINK
], i
);
358 i
->sync_prev
->sync_next
= i
->sync_next
;
360 i
->sync_next
->sync_prev
= i
->sync_prev
;
362 i
->sync_prev
= i
->sync_next
= NULL
;
364 pa_idxset_remove_by_data(i
->sink
->core
->sink_inputs
, i
, NULL
);
365 if (pa_idxset_remove_by_data(i
->sink
->inputs
, i
, NULL
))
366 pa_sink_input_unref(i
);
368 while ((o
= pa_idxset_first(i
->direct_outputs
, NULL
))) {
370 pa_source_output_kill(o
);
374 update_n_corked(i
, PA_SINK_INPUT_UNLINKED
);
375 i
->state
= PA_SINK_INPUT_UNLINKED
;
378 if (i
->sink
->asyncmsgq
)
379 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_REMOVE_INPUT
, i
, 0, NULL
) == 0);
384 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_REMOVE
, i
->index
);
385 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST
], i
);
389 pa_sink_input_unref(i
);
392 /* Called from main context */
393 static void sink_input_free(pa_object
*o
) {
394 pa_sink_input
* i
= PA_SINK_INPUT(o
);
397 pa_assert(pa_sink_input_refcnt(i
) == 0);
399 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
400 pa_sink_input_unlink(i
);
402 pa_log_info("Freeing input %u \"%s\"", i
->index
, pa_strnull(pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
)));
404 pa_assert(!i
->thread_info
.attached
);
406 if (i
->thread_info
.render_memblockq
)
407 pa_memblockq_free(i
->thread_info
.render_memblockq
);
409 if (i
->thread_info
.resampler
)
410 pa_resampler_free(i
->thread_info
.resampler
);
413 pa_proplist_free(i
->proplist
);
415 if (i
->direct_outputs
)
416 pa_idxset_free(i
->direct_outputs
, NULL
, NULL
);
418 if (i
->thread_info
.direct_outputs
)
419 pa_hashmap_free(i
->thread_info
.direct_outputs
, NULL
, NULL
);
425 /* Called from main context */
426 void pa_sink_input_put(pa_sink_input
*i
) {
427 pa_sink_input_state_t state
;
428 pa_sink_input_assert_ref(i
);
430 pa_assert(i
->state
== PA_SINK_INPUT_INIT
);
432 /* The following fields must be initialized properly */
434 pa_assert(i
->process_rewind
);
437 i
->thread_info
.volume
= i
->volume
;
438 i
->thread_info
.muted
= i
->muted
;
440 state
= i
->flags
& PA_SINK_INPUT_START_CORKED
? PA_SINK_INPUT_CORKED
: PA_SINK_INPUT_RUNNING
;
442 update_n_corked(i
, state
);
445 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_ADD_INPUT
, i
, 0, NULL
) == 0);
447 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_NEW
, i
->index
);
448 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PUT
], i
);
451 /* Called from main context */
452 void pa_sink_input_kill(pa_sink_input
*i
) {
453 pa_sink_input_assert_ref(i
);
454 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
459 /* Called from main context */
460 pa_usec_t
pa_sink_input_get_latency(pa_sink_input
*i
, pa_usec_t
*sink_latency
) {
461 pa_usec_t r
[2] = { 0, 0 };
463 pa_sink_input_assert_ref(i
);
464 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
466 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_GET_LATENCY
, r
, 0, NULL
) == 0);
469 r
[0] += i
->get_latency(i
);
472 *sink_latency
= r
[1];
477 /* Called from thread context */
478 int pa_sink_input_peek(pa_sink_input
*i
, size_t slength
/* in sink frames */, pa_memchunk
*chunk
, pa_cvolume
*volume
) {
479 pa_bool_t do_volume_adj_here
;
480 pa_bool_t volume_is_norm
;
481 size_t block_size_max_sink
, block_size_max_sink_input
;
484 pa_sink_input_assert_ref(i
);
485 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
486 pa_assert(pa_frame_aligned(slength
, &i
->sink
->sample_spec
));
490 /* pa_log_debug("peek"); */
495 pa_assert(i
->thread_info
.state
== PA_SINK_INPUT_RUNNING
||
496 i
->thread_info
.state
== PA_SINK_INPUT_CORKED
||
497 i
->thread_info
.state
== PA_SINK_INPUT_DRAINED
);
499 block_size_max_sink_input
= i
->thread_info
.resampler
?
500 pa_resampler_max_block_size(i
->thread_info
.resampler
) :
501 pa_frame_align(pa_mempool_block_size_max(i
->sink
->core
->mempool
), &i
->sample_spec
);
503 block_size_max_sink
= pa_frame_align(pa_mempool_block_size_max(i
->sink
->core
->mempool
), &i
->sink
->sample_spec
);
505 /* Default buffer size */
507 slength
= pa_frame_align(CONVERT_BUFFER_LENGTH
, &i
->sink
->sample_spec
);
509 if (slength
> block_size_max_sink
)
510 slength
= block_size_max_sink
;
512 if (i
->thread_info
.resampler
) {
513 ilength
= pa_resampler_request(i
->thread_info
.resampler
, slength
);
516 ilength
= pa_frame_align(CONVERT_BUFFER_LENGTH
, &i
->sample_spec
);
520 if (ilength
> block_size_max_sink_input
)
521 ilength
= block_size_max_sink_input
;
523 /* If the channel maps of the sink and this stream differ, we need
524 * to adjust the volume *before* we resample. Otherwise we can do
525 * it after and leave it for the sink code */
527 do_volume_adj_here
= !pa_channel_map_equal(&i
->channel_map
, &i
->sink
->channel_map
);
528 volume_is_norm
= pa_cvolume_is_norm(&i
->thread_info
.volume
) && !i
->thread_info
.muted
;
530 while (!pa_memblockq_is_readable(i
->thread_info
.render_memblockq
)) {
533 /* There's nothing in our render queue. We need to fill it up
534 * with data from the implementor. */
536 if (i
->thread_info
.state
== PA_SINK_INPUT_CORKED
||
537 i
->pop(i
, ilength
, &tchunk
) < 0) {
539 /* OK, we're corked or the implementor didn't give us any
540 * data, so let's just hand out silence */
541 pa_atomic_store(&i
->thread_info
.drained
, 1);
543 pa_memblockq_seek(i
->thread_info
.render_memblockq
, (int64_t) slength
, PA_SEEK_RELATIVE
);
544 i
->thread_info
.playing_for
= 0;
545 if (i
->thread_info
.underrun_for
!= (uint64_t) -1)
546 i
->thread_info
.underrun_for
+= ilength
;
550 pa_atomic_store(&i
->thread_info
.drained
, 0);
552 pa_assert(tchunk
.length
> 0);
553 pa_assert(tchunk
.memblock
);
555 i
->thread_info
.underrun_for
= 0;
556 i
->thread_info
.playing_for
+= tchunk
.length
;
558 while (tchunk
.length
> 0) {
562 pa_memblock_ref(wchunk
.memblock
);
564 if (wchunk
.length
> block_size_max_sink_input
)
565 wchunk
.length
= block_size_max_sink_input
;
567 /* It might be necessary to adjust the volume here */
568 if (do_volume_adj_here
&& !volume_is_norm
) {
569 pa_memchunk_make_writable(&wchunk
, 0);
571 if (i
->thread_info
.muted
)
572 pa_silence_memchunk(&wchunk
, &i
->thread_info
.sample_spec
);
574 pa_volume_memchunk(&wchunk
, &i
->thread_info
.sample_spec
, &i
->thread_info
.volume
);
577 if (!i
->thread_info
.resampler
)
578 pa_memblockq_push_align(i
->thread_info
.render_memblockq
, &wchunk
);
581 pa_resampler_run(i
->thread_info
.resampler
, &wchunk
, &rchunk
);
583 /* pa_log_debug("pushing %lu", (unsigned long) rchunk.length); */
585 if (rchunk
.memblock
) {
586 pa_memblockq_push_align(i
->thread_info
.render_memblockq
, &rchunk
);
587 pa_memblock_unref(rchunk
.memblock
);
591 pa_memblock_unref(wchunk
.memblock
);
593 tchunk
.index
+= wchunk
.length
;
594 tchunk
.length
-= wchunk
.length
;
597 pa_memblock_unref(tchunk
.memblock
);
600 pa_assert_se(pa_memblockq_peek(i
->thread_info
.render_memblockq
, chunk
) >= 0);
602 pa_assert(chunk
->length
> 0);
603 pa_assert(chunk
->memblock
);
605 /* pa_log_debug("peeking %lu", (unsigned long) chunk->length); */
607 if (chunk
->length
> block_size_max_sink
)
608 chunk
->length
= block_size_max_sink
;
610 /* Let's see if we had to apply the volume adjustment ourselves,
611 * or if this can be done by the sink for us */
613 if (do_volume_adj_here
)
614 /* We had different channel maps, so we already did the adjustment */
615 pa_cvolume_reset(volume
, i
->sink
->sample_spec
.channels
);
616 else if (i
->thread_info
.muted
)
617 /* We've both the same channel map, so let's have the sink do the adjustment for us*/
618 pa_cvolume_mute(volume
, i
->sink
->sample_spec
.channels
);
620 *volume
= i
->thread_info
.volume
;
625 /* Called from thread context */
626 void pa_sink_input_drop(pa_sink_input
*i
, size_t nbytes
/* in sink sample spec */) {
627 pa_sink_input_assert_ref(i
);
629 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
630 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
631 pa_assert(nbytes
> 0);
633 /* pa_log_debug("dropping %lu", (unsigned long) nbytes); */
635 pa_memblockq_drop(i
->thread_info
.render_memblockq
, nbytes
);
638 /* Called from thread context */
639 void pa_sink_input_process_rewind(pa_sink_input
*i
, size_t nbytes
/* in sink sample spec */) {
641 pa_bool_t called
= FALSE
;
642 pa_sink_input_assert_ref(i
);
644 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
645 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
647 /* pa_log_debug("rewind(%lu, %lu)", (unsigned long) nbytes, (unsigned long) i->thread_info.rewrite_nbytes); */
649 lbq
= pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
652 pa_log_debug("Have to rewind %lu bytes on render memblockq.", (unsigned long) nbytes
);
653 pa_memblockq_rewind(i
->thread_info
.render_memblockq
, nbytes
);
656 if (i
->thread_info
.rewrite_nbytes
== (size_t) -1) {
658 /* We were asked to drop all buffered data, and rerequest new
659 * data from implementor the next time push() is called */
661 pa_memblockq_flush_write(i
->thread_info
.render_memblockq
);
663 } else if (i
->thread_info
.rewrite_nbytes
> 0) {
664 size_t max_rewrite
, amount
;
666 /* Calculate how much make sense to rewrite at most */
667 max_rewrite
= nbytes
+ lbq
;
669 /* Transform into local domain */
670 if (i
->thread_info
.resampler
)
671 max_rewrite
= pa_resampler_request(i
->thread_info
.resampler
, max_rewrite
);
673 /* Calculate how much of the rewinded data should actually be rewritten */
674 amount
= PA_MIN(i
->thread_info
.rewrite_nbytes
, max_rewrite
);
677 pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) amount
);
679 /* Tell the implementor */
680 if (i
->process_rewind
)
681 i
->process_rewind(i
, amount
);
684 /* Convert back to to sink domain */
685 if (i
->thread_info
.resampler
)
686 amount
= pa_resampler_result(i
->thread_info
.resampler
, amount
);
689 /* Ok, now update the write pointer */
690 pa_memblockq_seek(i
->thread_info
.render_memblockq
, - ((int64_t) amount
), PA_SEEK_RELATIVE
);
692 if (i
->thread_info
.rewrite_flush
)
693 pa_memblockq_silence(i
->thread_info
.render_memblockq
);
695 /* And reset the resampler */
696 if (i
->thread_info
.resampler
)
697 pa_resampler_reset(i
->thread_info
.resampler
);
702 if (i
->process_rewind
)
703 i
->process_rewind(i
, 0);
705 i
->thread_info
.rewrite_nbytes
= 0;
706 i
->thread_info
.rewrite_flush
= FALSE
;
709 /* Called from thread context */
710 void pa_sink_input_update_max_rewind(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */) {
711 pa_sink_input_assert_ref(i
);
712 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
713 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
715 pa_memblockq_set_maxrewind(i
->thread_info
.render_memblockq
, nbytes
);
717 if (i
->update_max_rewind
)
718 i
->update_max_rewind(i
, i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, nbytes
) : nbytes
);
721 /* Called from thread context */
722 void pa_sink_input_update_max_request(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */) {
723 pa_sink_input_assert_ref(i
);
724 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
725 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
727 if (i
->update_max_request
)
728 i
->update_max_request(i
, i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, nbytes
) : nbytes
);
731 /* Called from thread context */
732 static pa_usec_t
fixup_latency(pa_sink
*s
, pa_usec_t usec
) {
733 pa_sink_assert_ref(s
);
735 if (usec
== (pa_usec_t
) -1)
738 if (s
->thread_info
.max_latency
> 0 && usec
> s
->thread_info
.max_latency
)
739 usec
= s
->thread_info
.max_latency
;
741 if (s
->thread_info
.min_latency
> 0 && usec
< s
->thread_info
.min_latency
)
742 usec
= s
->thread_info
.min_latency
;
747 /* Called from thread context */
748 pa_usec_t
pa_sink_input_set_requested_latency_within_thread(pa_sink_input
*i
, pa_usec_t usec
) {
749 pa_sink_input_assert_ref(i
);
751 usec
= fixup_latency(i
->sink
, usec
);
752 i
->thread_info
.requested_sink_latency
= usec
;
753 pa_sink_invalidate_requested_latency(i
->sink
);
758 /* Called from main context */
759 pa_usec_t
pa_sink_input_set_requested_latency(pa_sink_input
*i
, pa_usec_t usec
) {
760 pa_sink_input_assert_ref(i
);
762 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
763 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
765 /* If this sink input is not realized yet, we have to touch
766 * the thread info data directly */
768 i
->thread_info
.requested_sink_latency
= usec
;
773 /* Called from main context */
774 pa_usec_t
pa_sink_input_get_requested_latency(pa_sink_input
*i
) {
777 pa_sink_input_assert_ref(i
);
779 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
780 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
782 /* If this sink input is not realized yet, we have to touch
783 * the thread info data directly */
784 usec
= i
->thread_info
.requested_sink_latency
;
789 /* Called from main context */
790 void pa_sink_input_set_volume(pa_sink_input
*i
, const pa_cvolume
*volume
) {
791 pa_sink_input_set_volume_data data
;
793 pa_sink_input_assert_ref(i
);
794 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
798 data
.virtual_volume
= *volume
;
799 data
.volume
= *volume
;
801 if (pa_hook_fire(&i
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_SET_VOLUME
], &data
) < 0) {
805 if (!pa_cvolume_equal(&i
->volume
, &data
.volume
)) {
806 i
->volume
= data
.volume
;
807 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_VOLUME
, &data
.volume
, 0, NULL
) == 0);
811 if (!pa_cvolume_equal(&i
->virtual_volume
, &data
.virtual_volume
)) {
812 i
->virtual_volume
= data
.virtual_volume
;
813 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
817 /* Called from main context */
818 const pa_cvolume
*pa_sink_input_get_volume(pa_sink_input
*i
) {
819 pa_sink_input_assert_ref(i
);
820 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
822 return &i
->virtual_volume
;
825 /* Called from main context */
826 void pa_sink_input_set_mute(pa_sink_input
*i
, pa_bool_t mute
) {
828 pa_sink_input_assert_ref(i
);
829 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
831 if (!i
->muted
== !mute
)
836 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_MUTE
, PA_UINT_TO_PTR(mute
), 0, NULL
, NULL
);
837 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
840 /* Called from main context */
841 pa_bool_t
pa_sink_input_get_mute(pa_sink_input
*i
) {
842 pa_sink_input_assert_ref(i
);
843 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
848 /* Called from main context */
849 void pa_sink_input_cork(pa_sink_input
*i
, pa_bool_t b
) {
850 pa_sink_input_assert_ref(i
);
851 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
853 sink_input_set_state(i
, b
? PA_SINK_INPUT_CORKED
: PA_SINK_INPUT_RUNNING
);
856 /* Called from main context */
857 int pa_sink_input_set_rate(pa_sink_input
*i
, uint32_t rate
) {
858 pa_sink_input_assert_ref(i
);
859 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
860 pa_return_val_if_fail(i
->thread_info
.resampler
, -1);
862 if (i
->sample_spec
.rate
== rate
)
865 i
->sample_spec
.rate
= rate
;
867 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_RATE
, PA_UINT_TO_PTR(rate
), 0, NULL
, NULL
);
869 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
873 /* Called from main context */
874 void pa_sink_input_set_name(pa_sink_input
*i
, const char *name
) {
876 pa_sink_input_assert_ref(i
);
878 if (!name
&& !pa_proplist_contains(i
->proplist
, PA_PROP_MEDIA_NAME
))
881 old
= pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
);
883 if (old
&& name
&& !strcmp(old
, name
))
887 pa_proplist_sets(i
->proplist
, PA_PROP_MEDIA_NAME
, name
);
889 pa_proplist_unset(i
->proplist
, PA_PROP_MEDIA_NAME
);
891 if (PA_SINK_INPUT_IS_LINKED(i
->state
)) {
892 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED
], i
);
893 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
897 /* Called from main context */
898 pa_resample_method_t
pa_sink_input_get_resample_method(pa_sink_input
*i
) {
899 pa_sink_input_assert_ref(i
);
901 return i
->resample_method
;
904 /* Called from main context */
905 int pa_sink_input_move_to(pa_sink_input
*i
, pa_sink
*dest
) {
906 pa_resampler
*new_resampler
;
908 pa_sink_input_move_hook_data hook_data
;
909 pa_source_output
*o
, *p
= NULL
;
911 pa_sink_input_assert_ref(i
);
912 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
913 pa_sink_assert_ref(dest
);
920 if (i
->flags
& PA_SINK_INPUT_DONT_MOVE
)
923 if (i
->sync_next
|| i
->sync_prev
) {
924 pa_log_warn("Moving synchronised streams not supported.");
928 if (pa_idxset_size(dest
->inputs
) >= PA_MAX_INPUTS_PER_SINK
) {
929 pa_log_warn("Failed to move sink input: too many inputs per sink.");
933 /* Kill directly connected outputs */
934 while ((o
= pa_idxset_first(i
->direct_outputs
, NULL
))) {
936 pa_source_output_kill(o
);
940 if (i
->thread_info
.resampler
&&
941 pa_sample_spec_equal(&origin
->sample_spec
, &dest
->sample_spec
) &&
942 pa_channel_map_equal(&origin
->channel_map
, &dest
->channel_map
))
944 /* Try to reuse the old resampler if possible */
945 new_resampler
= i
->thread_info
.resampler
;
947 else if ((i
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ||
948 !pa_sample_spec_equal(&i
->sample_spec
, &dest
->sample_spec
) ||
949 !pa_channel_map_equal(&i
->channel_map
, &dest
->channel_map
)) {
951 /* Okey, we need a new resampler for the new sink */
953 if (!(new_resampler
= pa_resampler_new(
955 &i
->sample_spec
, &i
->channel_map
,
956 &dest
->sample_spec
, &dest
->channel_map
,
958 ((i
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
959 ((i
->flags
& PA_SINK_INPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
960 (i
->core
->disable_remixing
|| (i
->flags
& PA_SINK_INPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0)))) {
961 pa_log_warn("Unsupported resampling operation.");
965 new_resampler
= NULL
;
967 hook_data
.sink_input
= i
;
968 hook_data
.destination
= dest
;
969 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE
], &hook_data
);
971 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_START_MOVE
, i
, 0, NULL
) == 0);
973 pa_idxset_remove_by_data(origin
->inputs
, i
, NULL
);
974 pa_idxset_put(dest
->inputs
, i
, NULL
);
977 if (pa_sink_input_get_state(i
) == PA_SINK_INPUT_CORKED
) {
978 pa_assert_se(origin
->n_corked
-- >= 1);
982 /* Replace resampler and render queue */
983 if (new_resampler
!= i
->thread_info
.resampler
) {
985 if (i
->thread_info
.resampler
)
986 pa_resampler_free(i
->thread_info
.resampler
);
987 i
->thread_info
.resampler
= new_resampler
;
989 pa_memblockq_free(i
->thread_info
.render_memblockq
);
991 i
->thread_info
.render_memblockq
= pa_memblockq_new(
995 pa_frame_size(&i
->sink
->sample_spec
),
1002 pa_sink_update_status(origin
);
1003 pa_sink_update_status(dest
);
1005 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_FINISH_MOVE
, i
, 0, NULL
) == 0);
1010 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE_POST
], i
);
1012 pa_log_debug("Successfully moved sink input %i from %s to %s.", i
->index
, origin
->name
, dest
->name
);
1014 /* Notify everyone */
1015 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1020 /* Called from IO thread context */
1021 void pa_sink_input_set_state_within_thread(pa_sink_input
*i
, pa_sink_input_state_t state
) {
1022 pa_bool_t corking
, uncorking
;
1023 pa_sink_input_assert_ref(i
);
1025 if (state
== i
->thread_info
.state
)
1028 if ((state
== PA_SINK_INPUT_DRAINED
|| state
== PA_SINK_INPUT_RUNNING
) &&
1029 !(i
->thread_info
.state
== PA_SINK_INPUT_DRAINED
|| i
->thread_info
.state
!= PA_SINK_INPUT_RUNNING
))
1030 pa_atomic_store(&i
->thread_info
.drained
, 1);
1032 corking
= state
== PA_SINK_INPUT_CORKED
&& i
->thread_info
.state
== PA_SINK_INPUT_RUNNING
;
1033 uncorking
= i
->thread_info
.state
== PA_SINK_INPUT_CORKED
&& state
== PA_SINK_INPUT_RUNNING
;
1035 if (i
->state_change
)
1036 i
->state_change(i
, state
);
1038 i
->thread_info
.state
= state
;
1042 pa_log_debug("Requesting rewind due to corking");
1044 /* This will tell the implementing sink input driver to rewind
1045 * so that the unplayed already mixed data is not lost */
1046 pa_sink_input_request_rewind(i
, 0, TRUE
, TRUE
);
1048 } else if (uncorking
) {
1050 i
->thread_info
.underrun_for
= (uint64_t) -1;
1051 i
->thread_info
.playing_for
= 0;
1053 pa_log_debug("Requesting rewind due to uncorking");
1055 /* OK, we're being uncorked. Make sure we're not rewound when
1056 * the hw buffer is remixed and request a remix. */
1057 pa_sink_input_request_rewind(i
, 0, FALSE
, TRUE
);
1061 /* Called from thread context, except when it is not. */
1062 int pa_sink_input_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
1063 pa_sink_input
*i
= PA_SINK_INPUT(o
);
1064 pa_sink_input_assert_ref(i
);
1068 case PA_SINK_INPUT_MESSAGE_SET_VOLUME
:
1069 i
->thread_info
.volume
= *((pa_cvolume
*) userdata
);
1070 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
);
1073 case PA_SINK_INPUT_MESSAGE_SET_MUTE
:
1074 i
->thread_info
.muted
= PA_PTR_TO_UINT(userdata
);
1075 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
);
1078 case PA_SINK_INPUT_MESSAGE_GET_LATENCY
: {
1079 pa_usec_t
*r
= userdata
;
1080 pa_usec_t sink_usec
= 0;
1082 r
[0] += pa_bytes_to_usec(pa_memblockq_get_length(i
->thread_info
.render_memblockq
), &i
->sink
->sample_spec
);
1084 if (i
->sink
->parent
.process_msg(PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_GET_LATENCY
, &sink_usec
, 0, NULL
) >= 0)
1090 case PA_SINK_INPUT_MESSAGE_SET_RATE
:
1092 i
->thread_info
.sample_spec
.rate
= PA_PTR_TO_UINT(userdata
);
1093 pa_resampler_set_input_rate(i
->thread_info
.resampler
, PA_PTR_TO_UINT(userdata
));
1097 case PA_SINK_INPUT_MESSAGE_SET_STATE
: {
1098 pa_sink_input
*ssync
;
1100 pa_sink_input_set_state_within_thread(i
, PA_PTR_TO_UINT(userdata
));
1102 for (ssync
= i
->thread_info
.sync_prev
; ssync
; ssync
= ssync
->thread_info
.sync_prev
)
1103 pa_sink_input_set_state_within_thread(ssync
, PA_PTR_TO_UINT(userdata
));
1105 for (ssync
= i
->thread_info
.sync_next
; ssync
; ssync
= ssync
->thread_info
.sync_next
)
1106 pa_sink_input_set_state_within_thread(ssync
, PA_PTR_TO_UINT(userdata
));
1111 case PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
: {
1112 pa_usec_t
*usec
= userdata
;
1114 *usec
= pa_sink_input_set_requested_latency_within_thread(i
, *usec
);
1118 case PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY
: {
1119 pa_usec_t
*r
= userdata
;
1121 *r
= i
->thread_info
.requested_sink_latency
;
1129 /* Called from main thread */
1130 pa_sink_input_state_t
pa_sink_input_get_state(pa_sink_input
*i
) {
1131 pa_sink_input_assert_ref(i
);
1133 if (i
->state
== PA_SINK_INPUT_RUNNING
|| i
->state
== PA_SINK_INPUT_DRAINED
)
1134 return pa_atomic_load(&i
->thread_info
.drained
) ? PA_SINK_INPUT_DRAINED
: PA_SINK_INPUT_RUNNING
;
1139 /* Called from IO context */
1140 pa_bool_t
pa_sink_input_safe_to_remove(pa_sink_input
*i
) {
1141 pa_sink_input_assert_ref(i
);
1143 if (PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
))
1144 return pa_memblockq_is_empty(i
->thread_info
.render_memblockq
);
1149 /* Called from IO context */
1150 void pa_sink_input_request_rewind(pa_sink_input
*i
, size_t nbytes
/* in our sample spec */, pa_bool_t rewrite
, pa_bool_t flush
) {
1153 /* If 'rewrite' is TRUE the sink is rewound as far as requested
1154 * and possible and the exact value of this is passed back the
1155 * implementor via process_rewind(). If 'flush' is also TRUE all
1156 * already rendered data is also dropped.
1158 * If 'rewrite' is FALSE the sink is rewound as far as requested
1159 * and possible and the already rendered data is dropped so that
1160 * in the next iteration we read new data from the
1161 * implementor. This implies 'flush' is TRUE. */
1163 pa_sink_input_assert_ref(i
);
1164 pa_assert(i
->thread_info
.rewrite_nbytes
== 0);
1166 /* pa_log_debug("request rewrite %lu", (unsigned long) nbytes); */
1168 /* We don't take rewind requests while we are corked */
1169 if (i
->thread_info
.state
== PA_SINK_INPUT_CORKED
)
1172 pa_assert(rewrite
|| flush
);
1174 /* Calculate how much we can rewind locally without having to
1177 lbq
= pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
1181 /* Check if rewinding for the maximum is requested, and if so, fix up */
1184 /* Calculate maximum number of bytes that could be rewound in theory */
1185 nbytes
= i
->sink
->thread_info
.max_rewind
+ lbq
;
1187 /* Transform from sink domain */
1188 if (i
->thread_info
.resampler
)
1189 nbytes
= pa_resampler_request(i
->thread_info
.resampler
, nbytes
);
1193 /* Make sure to not overwrite over underruns */
1194 if (nbytes
> i
->thread_info
.playing_for
)
1195 nbytes
= (size_t) i
->thread_info
.playing_for
;
1197 i
->thread_info
.rewrite_nbytes
= nbytes
;
1199 i
->thread_info
.rewrite_nbytes
= (size_t) -1;
1201 i
->thread_info
.rewrite_flush
= flush
&& i
->thread_info
.rewrite_nbytes
!= 0;
1203 /* Transform to sink domain */
1204 if (i
->thread_info
.resampler
)
1205 nbytes
= pa_resampler_result(i
->thread_info
.resampler
, nbytes
);
1208 pa_sink_request_rewind(i
->sink
, nbytes
- lbq
);
1210 /* This call will make sure process_rewind() is called later */
1211 pa_sink_request_rewind(i
->sink
, 0);
1214 /* Called from main context */
1215 pa_memchunk
* pa_sink_input_get_silence(pa_sink_input
*i
, pa_memchunk
*ret
) {
1216 pa_sink_input_assert_ref(i
);
1219 pa_silence_memchunk_get(
1220 &i
->sink
->core
->silence_cache
,
1221 i
->sink
->core
->mempool
,
1224 i
->thread_info
.resampler
? pa_resampler_max_block_size(i
->thread_info
.resampler
) : 0);