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
= *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 if (!data
->muted_is_set
)
162 if (flags
& PA_SINK_INPUT_FIX_FORMAT
)
163 data
->sample_spec
.format
= data
->sink
->sample_spec
.format
;
165 if (flags
& PA_SINK_INPUT_FIX_RATE
)
166 data
->sample_spec
.rate
= data
->sink
->sample_spec
.rate
;
168 if (flags
& PA_SINK_INPUT_FIX_CHANNELS
) {
169 data
->sample_spec
.channels
= data
->sink
->sample_spec
.channels
;
170 data
->channel_map
= data
->sink
->channel_map
;
173 pa_assert(pa_sample_spec_valid(&data
->sample_spec
));
174 pa_assert(pa_channel_map_valid(&data
->channel_map
));
176 /* Due to the fixing of the sample spec the volume might not match anymore */
177 if (data
->volume
.channels
!= data
->sample_spec
.channels
)
178 pa_cvolume_set(&data
->volume
, data
->sample_spec
.channels
, pa_cvolume_avg(&data
->volume
));
180 if (data
->resample_method
== PA_RESAMPLER_INVALID
)
181 data
->resample_method
= core
->resample_method
;
183 pa_return_null_if_fail(data
->resample_method
< PA_RESAMPLER_MAX
);
185 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_INPUT_FIXATE
], data
) < 0)
188 if (pa_idxset_size(data
->sink
->inputs
) >= PA_MAX_INPUTS_PER_SINK
) {
189 pa_log_warn("Failed to create sink input: too many inputs per sink.");
193 if ((flags
& PA_SINK_INPUT_VARIABLE_RATE
) ||
194 !pa_sample_spec_equal(&data
->sample_spec
, &data
->sink
->sample_spec
) ||
195 !pa_channel_map_equal(&data
->channel_map
, &data
->sink
->channel_map
)) {
197 if (!(resampler
= pa_resampler_new(
199 &data
->sample_spec
, &data
->channel_map
,
200 &data
->sink
->sample_spec
, &data
->sink
->channel_map
,
201 data
->resample_method
,
202 ((flags
& PA_SINK_INPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
203 ((flags
& PA_SINK_INPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
204 (core
->disable_remixing
|| (flags
& PA_SINK_INPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0)))) {
205 pa_log_warn("Unsupported resampling operation.");
209 data
->resample_method
= pa_resampler_get_method(resampler
);
212 i
= pa_msgobject_new(pa_sink_input
);
213 i
->parent
.parent
.free
= sink_input_free
;
214 i
->parent
.process_msg
= pa_sink_input_process_msg
;
217 i
->state
= PA_SINK_INPUT_INIT
;
219 i
->proplist
= pa_proplist_copy(data
->proplist
);
220 i
->driver
= pa_xstrdup(data
->driver
);
221 i
->module
= data
->module
;
222 i
->sink
= data
->sink
;
223 i
->client
= data
->client
;
225 i
->resample_method
= data
->resample_method
;
226 i
->sample_spec
= data
->sample_spec
;
227 i
->channel_map
= data
->channel_map
;
229 i
->volume
= data
->volume
;
230 i
->muted
= data
->muted
;
232 if (data
->sync_base
) {
233 i
->sync_next
= data
->sync_base
->sync_next
;
234 i
->sync_prev
= data
->sync_base
;
236 if (data
->sync_base
->sync_next
)
237 data
->sync_base
->sync_next
->sync_prev
= i
;
238 data
->sync_base
->sync_next
= i
;
240 i
->sync_next
= i
->sync_prev
= NULL
;
242 i
->direct_outputs
= pa_idxset_new(NULL
, NULL
);
247 i
->thread_info
.state
= i
->state
;
248 i
->thread_info
.attached
= FALSE
;
249 pa_atomic_store(&i
->thread_info
.drained
, 1);
250 i
->thread_info
.sample_spec
= i
->sample_spec
;
251 i
->thread_info
.resampler
= resampler
;
252 i
->thread_info
.volume
= i
->volume
;
253 i
->thread_info
.muted
= i
->muted
;
254 i
->thread_info
.requested_sink_latency
= (pa_usec_t
) -1;
255 i
->thread_info
.rewrite_nbytes
= 0;
256 i
->thread_info
.rewrite_flush
= FALSE
;
257 i
->thread_info
.underrun_for
= (uint64_t) -1;
258 i
->thread_info
.playing_for
= 0;
259 i
->thread_info
.direct_outputs
= pa_hashmap_new(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
);
261 i
->thread_info
.render_memblockq
= pa_memblockq_new(
265 pa_frame_size(&i
->sink
->sample_spec
),
271 pa_assert_se(pa_idxset_put(core
->sink_inputs
, pa_sink_input_ref(i
), &i
->index
) == 0);
272 pa_assert_se(pa_idxset_put(i
->sink
->inputs
, i
, NULL
) == 0);
274 pa_log_info("Created input %u \"%s\" on %s with sample spec %s and channel map %s",
276 pa_strnull(pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
)),
278 pa_sample_spec_snprint(st
, sizeof(st
), &i
->sample_spec
),
279 pa_channel_map_snprint(cm
, sizeof(cm
), &i
->channel_map
));
281 /* Don't forget to call pa_sink_input_put! */
286 /* Called from main context */
287 static void update_n_corked(pa_sink_input
*i
, pa_sink_input_state_t state
) {
290 if (i
->state
== PA_SINK_INPUT_CORKED
&& state
!= PA_SINK_INPUT_CORKED
)
291 pa_assert_se(i
->sink
->n_corked
-- >= 1);
292 else if (i
->state
!= PA_SINK_INPUT_CORKED
&& state
== PA_SINK_INPUT_CORKED
)
295 pa_sink_update_status(i
->sink
);
298 /* Called from main context */
299 static int sink_input_set_state(pa_sink_input
*i
, pa_sink_input_state_t state
) {
300 pa_sink_input
*ssync
;
303 if (state
== PA_SINK_INPUT_DRAINED
)
304 state
= PA_SINK_INPUT_RUNNING
;
306 if (i
->state
== state
)
309 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);
311 update_n_corked(i
, state
);
314 for (ssync
= i
->sync_prev
; ssync
; ssync
= ssync
->sync_prev
) {
315 update_n_corked(ssync
, state
);
316 ssync
->state
= state
;
318 for (ssync
= i
->sync_next
; ssync
; ssync
= ssync
->sync_next
) {
319 update_n_corked(ssync
, state
);
320 ssync
->state
= state
;
323 if (state
!= PA_SINK_INPUT_UNLINKED
) {
324 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED
], i
);
326 for (ssync
= i
->sync_prev
; ssync
; ssync
= ssync
->sync_prev
)
327 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED
], ssync
);
329 for (ssync
= i
->sync_next
; ssync
; ssync
= ssync
->sync_next
)
330 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED
], ssync
);
336 /* Called from main context */
337 void pa_sink_input_unlink(pa_sink_input
*i
) {
339 pa_source_output
*o
, *p
= NULL
;
342 /* See pa_sink_unlink() for a couple of comments how this function
345 pa_sink_input_ref(i
);
347 linked
= PA_SINK_INPUT_IS_LINKED(i
->state
);
350 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_UNLINK
], i
);
353 i
->sync_prev
->sync_next
= i
->sync_next
;
355 i
->sync_next
->sync_prev
= i
->sync_prev
;
357 i
->sync_prev
= i
->sync_next
= NULL
;
359 pa_idxset_remove_by_data(i
->sink
->core
->sink_inputs
, i
, NULL
);
360 if (pa_idxset_remove_by_data(i
->sink
->inputs
, i
, NULL
))
361 pa_sink_input_unref(i
);
363 while ((o
= pa_idxset_first(i
->direct_outputs
, NULL
))) {
365 pa_source_output_kill(o
);
369 update_n_corked(i
, PA_SINK_INPUT_UNLINKED
);
370 i
->state
= PA_SINK_INPUT_UNLINKED
;
373 if (i
->sink
->asyncmsgq
)
374 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_REMOVE_INPUT
, i
, 0, NULL
) == 0);
379 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_REMOVE
, i
->index
);
380 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST
], i
);
384 pa_sink_input_unref(i
);
387 /* Called from main context */
388 static void sink_input_free(pa_object
*o
) {
389 pa_sink_input
* i
= PA_SINK_INPUT(o
);
392 pa_assert(pa_sink_input_refcnt(i
) == 0);
394 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
395 pa_sink_input_unlink(i
);
397 pa_log_info("Freeing input %u \"%s\"", i
->index
, pa_strnull(pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
)));
399 pa_assert(!i
->thread_info
.attached
);
401 if (i
->thread_info
.render_memblockq
)
402 pa_memblockq_free(i
->thread_info
.render_memblockq
);
404 if (i
->thread_info
.resampler
)
405 pa_resampler_free(i
->thread_info
.resampler
);
408 pa_proplist_free(i
->proplist
);
410 if (i
->direct_outputs
)
411 pa_idxset_free(i
->direct_outputs
, NULL
, NULL
);
413 if (i
->thread_info
.direct_outputs
)
414 pa_hashmap_free(i
->thread_info
.direct_outputs
, NULL
, NULL
);
420 /* Called from main context */
421 void pa_sink_input_put(pa_sink_input
*i
) {
422 pa_sink_input_state_t state
;
423 pa_sink_input_assert_ref(i
);
425 pa_assert(i
->state
== PA_SINK_INPUT_INIT
);
427 /* The following fields must be initialized properly */
429 pa_assert(i
->process_rewind
);
432 i
->thread_info
.volume
= i
->volume
;
433 i
->thread_info
.muted
= i
->muted
;
435 state
= i
->flags
& PA_SINK_INPUT_START_CORKED
? PA_SINK_INPUT_CORKED
: PA_SINK_INPUT_RUNNING
;
437 update_n_corked(i
, state
);
440 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_ADD_INPUT
, i
, 0, NULL
) == 0);
442 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_NEW
, i
->index
);
443 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PUT
], i
);
446 /* Called from main context */
447 void pa_sink_input_kill(pa_sink_input
*i
) {
448 pa_sink_input_assert_ref(i
);
449 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
454 /* Called from main context */
455 pa_usec_t
pa_sink_input_get_latency(pa_sink_input
*i
, pa_usec_t
*sink_latency
) {
456 pa_usec_t r
[2] = { 0, 0 };
458 pa_sink_input_assert_ref(i
);
459 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
461 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_GET_LATENCY
, r
, 0, NULL
) == 0);
464 r
[0] += i
->get_latency(i
);
467 *sink_latency
= r
[1];
472 /* Called from thread context */
473 int pa_sink_input_peek(pa_sink_input
*i
, size_t slength
/* in sink frames */, pa_memchunk
*chunk
, pa_cvolume
*volume
) {
474 pa_bool_t do_volume_adj_here
;
475 pa_bool_t volume_is_norm
;
476 size_t block_size_max_sink
, block_size_max_sink_input
;
479 pa_sink_input_assert_ref(i
);
480 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
481 pa_assert(pa_frame_aligned(slength
, &i
->sink
->sample_spec
));
485 /* pa_log_debug("peek"); */
490 pa_assert(i
->thread_info
.state
== PA_SINK_INPUT_RUNNING
||
491 i
->thread_info
.state
== PA_SINK_INPUT_CORKED
||
492 i
->thread_info
.state
== PA_SINK_INPUT_DRAINED
);
494 block_size_max_sink_input
= i
->thread_info
.resampler
?
495 pa_resampler_max_block_size(i
->thread_info
.resampler
) :
496 pa_frame_align(pa_mempool_block_size_max(i
->sink
->core
->mempool
), &i
->sample_spec
);
498 block_size_max_sink
= pa_frame_align(pa_mempool_block_size_max(i
->sink
->core
->mempool
), &i
->sink
->sample_spec
);
500 /* Default buffer size */
502 slength
= pa_frame_align(CONVERT_BUFFER_LENGTH
, &i
->sink
->sample_spec
);
504 if (slength
> block_size_max_sink
)
505 slength
= block_size_max_sink
;
507 if (i
->thread_info
.resampler
) {
508 ilength
= pa_resampler_request(i
->thread_info
.resampler
, slength
);
511 ilength
= pa_frame_align(CONVERT_BUFFER_LENGTH
, &i
->sample_spec
);
515 if (ilength
> block_size_max_sink_input
)
516 ilength
= block_size_max_sink_input
;
518 /* If the channel maps of the sink and this stream differ, we need
519 * to adjust the volume *before* we resample. Otherwise we can do
520 * it after and leave it for the sink code */
522 do_volume_adj_here
= !pa_channel_map_equal(&i
->channel_map
, &i
->sink
->channel_map
);
523 volume_is_norm
= pa_cvolume_is_norm(&i
->thread_info
.volume
) && !i
->thread_info
.muted
;
525 while (!pa_memblockq_is_readable(i
->thread_info
.render_memblockq
)) {
528 /* There's nothing in our render queue. We need to fill it up
529 * with data from the implementor. */
531 if (i
->thread_info
.state
== PA_SINK_INPUT_CORKED
||
532 i
->pop(i
, ilength
, &tchunk
) < 0) {
534 /* OK, we're corked or the implementor didn't give us any
535 * data, so let's just hand out silence */
536 pa_atomic_store(&i
->thread_info
.drained
, 1);
538 pa_memblockq_seek(i
->thread_info
.render_memblockq
, slength
, PA_SEEK_RELATIVE
);
539 i
->thread_info
.playing_for
= 0;
540 if (i
->thread_info
.underrun_for
!= (uint64_t) -1)
541 i
->thread_info
.underrun_for
+= ilength
;
545 pa_atomic_store(&i
->thread_info
.drained
, 0);
547 pa_assert(tchunk
.length
> 0);
548 pa_assert(tchunk
.memblock
);
550 i
->thread_info
.underrun_for
= 0;
551 i
->thread_info
.playing_for
+= tchunk
.length
;
553 while (tchunk
.length
> 0) {
557 pa_memblock_ref(wchunk
.memblock
);
559 if (wchunk
.length
> block_size_max_sink_input
)
560 wchunk
.length
= block_size_max_sink_input
;
562 /* It might be necessary to adjust the volume here */
563 if (do_volume_adj_here
&& !volume_is_norm
) {
564 pa_memchunk_make_writable(&wchunk
, 0);
566 if (i
->thread_info
.muted
)
567 pa_silence_memchunk(&wchunk
, &i
->thread_info
.sample_spec
);
569 pa_volume_memchunk(&wchunk
, &i
->thread_info
.sample_spec
, &i
->thread_info
.volume
);
572 if (!i
->thread_info
.resampler
)
573 pa_memblockq_push_align(i
->thread_info
.render_memblockq
, &wchunk
);
576 pa_resampler_run(i
->thread_info
.resampler
, &wchunk
, &rchunk
);
578 /* pa_log_debug("pushing %lu", (unsigned long) rchunk.length); */
580 if (rchunk
.memblock
) {
581 pa_memblockq_push_align(i
->thread_info
.render_memblockq
, &rchunk
);
582 pa_memblock_unref(rchunk
.memblock
);
586 pa_memblock_unref(wchunk
.memblock
);
588 tchunk
.index
+= wchunk
.length
;
589 tchunk
.length
-= wchunk
.length
;
592 pa_memblock_unref(tchunk
.memblock
);
595 pa_assert_se(pa_memblockq_peek(i
->thread_info
.render_memblockq
, chunk
) >= 0);
597 pa_assert(chunk
->length
> 0);
598 pa_assert(chunk
->memblock
);
600 /* pa_log_debug("peeking %lu", (unsigned long) chunk->length); */
602 if (chunk
->length
> block_size_max_sink
)
603 chunk
->length
= block_size_max_sink
;
605 /* Let's see if we had to apply the volume adjustment ourselves,
606 * or if this can be done by the sink for us */
608 if (do_volume_adj_here
)
609 /* We had different channel maps, so we already did the adjustment */
610 pa_cvolume_reset(volume
, i
->sink
->sample_spec
.channels
);
611 else if (i
->thread_info
.muted
)
612 /* We've both the same channel map, so let's have the sink do the adjustment for us*/
613 pa_cvolume_mute(volume
, i
->sink
->sample_spec
.channels
);
615 *volume
= i
->thread_info
.volume
;
620 /* Called from thread context */
621 void pa_sink_input_drop(pa_sink_input
*i
, size_t nbytes
/* in sink sample spec */) {
622 pa_sink_input_assert_ref(i
);
624 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
625 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
626 pa_assert(nbytes
> 0);
628 /* pa_log_debug("dropping %lu", (unsigned long) nbytes); */
630 pa_memblockq_drop(i
->thread_info
.render_memblockq
, nbytes
);
633 /* Called from thread context */
634 void pa_sink_input_process_rewind(pa_sink_input
*i
, size_t nbytes
/* in sink sample spec */) {
637 pa_sink_input_assert_ref(i
);
639 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
640 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
642 /* pa_log_debug("rewind(%lu, %lu)", (unsigned long) nbytes, (unsigned long) i->thread_info.rewrite_nbytes); */
644 lbq
= pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
647 pa_log_debug("Have to rewind %lu bytes on render memblockq.", (unsigned long) nbytes
);
648 pa_memblockq_rewind(i
->thread_info
.render_memblockq
, nbytes
);
651 if (i
->thread_info
.rewrite_nbytes
== (size_t) -1) {
653 /* We were asked to drop all buffered data, and rerequest new
654 * data from implementor the next time push() is called */
656 pa_memblockq_flush_write(i
->thread_info
.render_memblockq
);
658 } else if (i
->thread_info
.rewrite_nbytes
> 0) {
659 size_t max_rewrite
, amount
;
661 /* Calculate how much make sense to rewrite at most */
662 max_rewrite
= nbytes
+ lbq
;
664 /* Transform into local domain */
665 if (i
->thread_info
.resampler
)
666 max_rewrite
= pa_resampler_request(i
->thread_info
.resampler
, max_rewrite
);
668 /* Calculate how much of the rewinded data should actually be rewritten */
669 amount
= PA_MIN(i
->thread_info
.rewrite_nbytes
, max_rewrite
);
672 pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) amount
);
674 /* Tell the implementor */
675 if (i
->process_rewind
)
676 i
->process_rewind(i
, amount
);
679 /* Convert back to to sink domain */
680 if (i
->thread_info
.resampler
)
681 amount
= pa_resampler_result(i
->thread_info
.resampler
, amount
);
684 /* Ok, now update the write pointer */
685 pa_memblockq_seek(i
->thread_info
.render_memblockq
, - ((int64_t) amount
), PA_SEEK_RELATIVE
);
687 if (i
->thread_info
.rewrite_flush
)
688 pa_memblockq_silence(i
->thread_info
.render_memblockq
);
690 /* And reset the resampler */
691 if (i
->thread_info
.resampler
)
692 pa_resampler_reset(i
->thread_info
.resampler
);
697 if (i
->process_rewind
)
698 i
->process_rewind(i
, 0);
700 i
->thread_info
.rewrite_nbytes
= 0;
701 i
->thread_info
.rewrite_flush
= FALSE
;
704 /* Called from thread context */
705 void pa_sink_input_update_max_rewind(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */) {
706 pa_sink_input_assert_ref(i
);
707 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
708 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
710 pa_memblockq_set_maxrewind(i
->thread_info
.render_memblockq
, nbytes
);
712 if (i
->update_max_rewind
)
713 i
->update_max_rewind(i
, i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, nbytes
) : nbytes
);
716 /* Called from thread context */
717 void pa_sink_input_update_max_request(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */) {
718 pa_sink_input_assert_ref(i
);
719 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
720 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
722 if (i
->update_max_request
)
723 i
->update_max_request(i
, i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, nbytes
) : nbytes
);
726 /* Called from thread context */
727 static pa_usec_t
fixup_latency(pa_sink
*s
, pa_usec_t usec
) {
728 pa_sink_assert_ref(s
);
730 if (usec
== (pa_usec_t
) -1)
733 if (s
->thread_info
.max_latency
> 0 && usec
> s
->thread_info
.max_latency
)
734 usec
= s
->thread_info
.max_latency
;
736 if (s
->thread_info
.min_latency
> 0 && usec
< s
->thread_info
.min_latency
)
737 usec
= s
->thread_info
.min_latency
;
742 /* Called from thread context */
743 pa_usec_t
pa_sink_input_set_requested_latency_within_thread(pa_sink_input
*i
, pa_usec_t usec
) {
744 pa_sink_input_assert_ref(i
);
746 usec
= fixup_latency(i
->sink
, usec
);
747 i
->thread_info
.requested_sink_latency
= usec
;
748 pa_sink_invalidate_requested_latency(i
->sink
);
753 /* Called from main context */
754 pa_usec_t
pa_sink_input_set_requested_latency(pa_sink_input
*i
, pa_usec_t usec
) {
755 pa_sink_input_assert_ref(i
);
757 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
758 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
760 /* If this sink input is not realized yet, we have to touch
761 * the thread info data directly */
763 usec
= fixup_latency(i
->sink
, usec
);
764 i
->thread_info
.requested_sink_latency
= usec
;
765 i
->sink
->thread_info
.requested_latency_valid
= FALSE
;
771 /* Called from main context */
772 pa_usec_t
pa_sink_input_get_requested_latency(pa_sink_input
*i
) {
775 pa_sink_input_assert_ref(i
);
777 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
778 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
780 /* If this sink input is not realized yet, we have to touch
781 * the thread info data directly */
782 usec
= i
->thread_info
.requested_sink_latency
;
787 /* Called from main context */
788 void pa_sink_input_set_volume(pa_sink_input
*i
, const pa_cvolume
*volume
) {
789 pa_sink_input_assert_ref(i
);
790 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
793 if (pa_cvolume_equal(&i
->volume
, volume
))
798 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_VOLUME
, &i
->volume
, 0, NULL
) == 0);
799 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
802 /* Called from main context */
803 const pa_cvolume
*pa_sink_input_get_volume(pa_sink_input
*i
) {
804 pa_sink_input_assert_ref(i
);
805 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
810 /* Called from main context */
811 void pa_sink_input_set_mute(pa_sink_input
*i
, pa_bool_t mute
) {
813 pa_sink_input_assert_ref(i
);
814 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
816 if (!i
->muted
== !mute
)
821 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_MUTE
, PA_UINT_TO_PTR(mute
), 0, NULL
, NULL
);
822 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
825 /* Called from main context */
826 pa_bool_t
pa_sink_input_get_mute(pa_sink_input
*i
) {
827 pa_sink_input_assert_ref(i
);
828 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
833 /* Called from main context */
834 void pa_sink_input_cork(pa_sink_input
*i
, pa_bool_t b
) {
835 pa_sink_input_assert_ref(i
);
836 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
838 sink_input_set_state(i
, b
? PA_SINK_INPUT_CORKED
: PA_SINK_INPUT_RUNNING
);
841 /* Called from main context */
842 int pa_sink_input_set_rate(pa_sink_input
*i
, uint32_t rate
) {
843 pa_sink_input_assert_ref(i
);
844 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
845 pa_return_val_if_fail(i
->thread_info
.resampler
, -1);
847 if (i
->sample_spec
.rate
== rate
)
850 i
->sample_spec
.rate
= rate
;
852 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_RATE
, PA_UINT_TO_PTR(rate
), 0, NULL
, NULL
);
854 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
858 /* Called from main context */
859 void pa_sink_input_set_name(pa_sink_input
*i
, const char *name
) {
861 pa_sink_input_assert_ref(i
);
863 if (!name
&& !pa_proplist_contains(i
->proplist
, PA_PROP_MEDIA_NAME
))
866 old
= pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
);
868 if (old
&& name
&& !strcmp(old
, name
))
872 pa_proplist_sets(i
->proplist
, PA_PROP_MEDIA_NAME
, name
);
874 pa_proplist_unset(i
->proplist
, PA_PROP_MEDIA_NAME
);
876 if (PA_SINK_INPUT_IS_LINKED(i
->state
)) {
877 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED
], i
);
878 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
882 /* Called from main context */
883 pa_resample_method_t
pa_sink_input_get_resample_method(pa_sink_input
*i
) {
884 pa_sink_input_assert_ref(i
);
886 return i
->resample_method
;
889 /* Called from main context */
890 int pa_sink_input_move_to(pa_sink_input
*i
, pa_sink
*dest
) {
891 pa_resampler
*new_resampler
;
893 pa_sink_input_move_hook_data hook_data
;
894 pa_source_output
*o
, *p
= NULL
;
896 pa_sink_input_assert_ref(i
);
897 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
898 pa_sink_assert_ref(dest
);
905 if (i
->flags
& PA_SINK_INPUT_DONT_MOVE
)
908 if (i
->sync_next
|| i
->sync_prev
) {
909 pa_log_warn("Moving synchronised streams not supported.");
913 if (pa_idxset_size(dest
->inputs
) >= PA_MAX_INPUTS_PER_SINK
) {
914 pa_log_warn("Failed to move sink input: too many inputs per sink.");
918 /* Kill directly connected outputs */
919 while ((o
= pa_idxset_first(i
->direct_outputs
, NULL
))) {
921 pa_source_output_kill(o
);
925 if (i
->thread_info
.resampler
&&
926 pa_sample_spec_equal(&origin
->sample_spec
, &dest
->sample_spec
) &&
927 pa_channel_map_equal(&origin
->channel_map
, &dest
->channel_map
))
929 /* Try to reuse the old resampler if possible */
930 new_resampler
= i
->thread_info
.resampler
;
932 else if ((i
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ||
933 !pa_sample_spec_equal(&i
->sample_spec
, &dest
->sample_spec
) ||
934 !pa_channel_map_equal(&i
->channel_map
, &dest
->channel_map
)) {
936 /* Okey, we need a new resampler for the new sink */
938 if (!(new_resampler
= pa_resampler_new(
940 &i
->sample_spec
, &i
->channel_map
,
941 &dest
->sample_spec
, &dest
->channel_map
,
943 ((i
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
944 ((i
->flags
& PA_SINK_INPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
945 (i
->core
->disable_remixing
|| (i
->flags
& PA_SINK_INPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0)))) {
946 pa_log_warn("Unsupported resampling operation.");
950 new_resampler
= NULL
;
952 hook_data
.sink_input
= i
;
953 hook_data
.destination
= dest
;
954 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE
], &hook_data
);
956 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_START_MOVE
, i
, 0, NULL
) == 0);
958 pa_idxset_remove_by_data(origin
->inputs
, i
, NULL
);
959 pa_idxset_put(dest
->inputs
, i
, NULL
);
962 if (pa_sink_input_get_state(i
) == PA_SINK_INPUT_CORKED
) {
963 pa_assert_se(origin
->n_corked
-- >= 1);
967 /* Replace resampler and render queue */
968 if (new_resampler
!= i
->thread_info
.resampler
) {
970 if (i
->thread_info
.resampler
)
971 pa_resampler_free(i
->thread_info
.resampler
);
972 i
->thread_info
.resampler
= new_resampler
;
974 pa_memblockq_free(i
->thread_info
.render_memblockq
);
976 i
->thread_info
.render_memblockq
= pa_memblockq_new(
980 pa_frame_size(&i
->sink
->sample_spec
),
987 pa_sink_update_status(origin
);
988 pa_sink_update_status(dest
);
990 pa_assert_se(pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_FINISH_MOVE
, i
, 0, NULL
) == 0);
995 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE_POST
], i
);
997 pa_log_debug("Successfully moved sink input %i from %s to %s.", i
->index
, origin
->name
, dest
->name
);
999 /* Notify everyone */
1000 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1005 /* Called from IO thread context */
1006 void pa_sink_input_set_state_within_thread(pa_sink_input
*i
, pa_sink_input_state_t state
) {
1007 pa_bool_t corking
, uncorking
;
1008 pa_sink_input_assert_ref(i
);
1010 if (state
== i
->thread_info
.state
)
1013 if ((state
== PA_SINK_INPUT_DRAINED
|| state
== PA_SINK_INPUT_RUNNING
) &&
1014 !(i
->thread_info
.state
== PA_SINK_INPUT_DRAINED
|| i
->thread_info
.state
!= PA_SINK_INPUT_RUNNING
))
1015 pa_atomic_store(&i
->thread_info
.drained
, 1);
1017 corking
= state
== PA_SINK_INPUT_CORKED
&& i
->thread_info
.state
== PA_SINK_INPUT_RUNNING
;
1018 uncorking
= i
->thread_info
.state
== PA_SINK_INPUT_CORKED
&& state
== PA_SINK_INPUT_RUNNING
;
1020 if (i
->state_change
)
1021 i
->state_change(i
, state
);
1023 i
->thread_info
.state
= state
;
1027 pa_log_debug("Requesting rewind due to corking");
1029 /* This will tell the implementing sink input driver to rewind
1030 * so that the unplayed already mixed data is not lost */
1031 pa_sink_input_request_rewind(i
, 0, TRUE
, TRUE
);
1033 } else if (uncorking
) {
1035 pa_log_debug("Requesting rewind due to uncorking");
1037 /* OK, we're being uncorked. Make sure we're not rewound when
1038 * the hw buffer is remixed and request a remix. */
1039 pa_sink_input_request_rewind(i
, 0, FALSE
, TRUE
);
1043 /* Called from thread context, except when it is not. */
1044 int pa_sink_input_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
1045 pa_sink_input
*i
= PA_SINK_INPUT(o
);
1046 pa_sink_input_assert_ref(i
);
1050 case PA_SINK_INPUT_MESSAGE_SET_VOLUME
:
1051 i
->thread_info
.volume
= *((pa_cvolume
*) userdata
);
1052 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
);
1055 case PA_SINK_INPUT_MESSAGE_SET_MUTE
:
1056 i
->thread_info
.muted
= PA_PTR_TO_UINT(userdata
);
1057 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
);
1060 case PA_SINK_INPUT_MESSAGE_GET_LATENCY
: {
1061 pa_usec_t
*r
= userdata
;
1062 pa_usec_t sink_usec
= 0;
1064 r
[0] += pa_bytes_to_usec(pa_memblockq_get_length(i
->thread_info
.render_memblockq
), &i
->sink
->sample_spec
);
1066 if (i
->sink
->parent
.process_msg(PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_GET_LATENCY
, &sink_usec
, 0, NULL
) >= 0)
1072 case PA_SINK_INPUT_MESSAGE_SET_RATE
:
1074 i
->thread_info
.sample_spec
.rate
= PA_PTR_TO_UINT(userdata
);
1075 pa_resampler_set_input_rate(i
->thread_info
.resampler
, PA_PTR_TO_UINT(userdata
));
1079 case PA_SINK_INPUT_MESSAGE_SET_STATE
: {
1080 pa_sink_input
*ssync
;
1082 pa_sink_input_set_state_within_thread(i
, PA_PTR_TO_UINT(userdata
));
1084 for (ssync
= i
->thread_info
.sync_prev
; ssync
; ssync
= ssync
->thread_info
.sync_prev
)
1085 pa_sink_input_set_state_within_thread(ssync
, PA_PTR_TO_UINT(userdata
));
1087 for (ssync
= i
->thread_info
.sync_next
; ssync
; ssync
= ssync
->thread_info
.sync_next
)
1088 pa_sink_input_set_state_within_thread(ssync
, PA_PTR_TO_UINT(userdata
));
1093 case PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
: {
1094 pa_usec_t
*usec
= userdata
;
1096 *usec
= pa_sink_input_set_requested_latency_within_thread(i
, *usec
);
1100 case PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY
: {
1101 pa_usec_t
*r
= userdata
;
1103 *r
= i
->thread_info
.requested_sink_latency
;
1111 /* Called from main thread */
1112 pa_sink_input_state_t
pa_sink_input_get_state(pa_sink_input
*i
) {
1113 pa_sink_input_assert_ref(i
);
1115 if (i
->state
== PA_SINK_INPUT_RUNNING
|| i
->state
== PA_SINK_INPUT_DRAINED
)
1116 return pa_atomic_load(&i
->thread_info
.drained
) ? PA_SINK_INPUT_DRAINED
: PA_SINK_INPUT_RUNNING
;
1121 /* Called from IO context */
1122 pa_bool_t
pa_sink_input_safe_to_remove(pa_sink_input
*i
) {
1123 pa_sink_input_assert_ref(i
);
1125 if (PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
))
1126 return pa_memblockq_is_empty(i
->thread_info
.render_memblockq
);
1131 /* Called from IO context */
1132 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
) {
1135 /* If 'rewrite' is TRUE the sink is rewound as far as requested
1136 * and possible and the exact value of this is passed back the
1137 * implementor via process_rewind(). If 'flush' is also TRUE all
1138 * already rendered data is also dropped.
1140 * If 'rewrite' is FALSE the sink is rewound as far as requested
1141 * and possible and the already rendered data is dropped so that
1142 * in the next iteration we read new data from the
1143 * implementor. This implies 'flush' is TRUE. */
1145 pa_sink_input_assert_ref(i
);
1146 pa_assert(i
->thread_info
.rewrite_nbytes
== 0);
1148 /* pa_log_debug("request rewrite %lu", (unsigned long) nbytes); */
1150 /* We don't take rewind requests while we are corked */
1151 if (i
->thread_info
.state
== PA_SINK_INPUT_CORKED
)
1154 pa_assert(rewrite
|| flush
);
1156 /* Calculate how much we can rewind locally without having to
1159 lbq
= pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
1163 /* Check if rewinding for the maximum is requested, and if so, fix up */
1166 /* Calculate maximum number of bytes that could be rewound in theory */
1167 nbytes
= i
->sink
->thread_info
.max_rewind
+ lbq
;
1169 /* Transform from sink domain */
1170 if (i
->thread_info
.resampler
)
1171 nbytes
= pa_resampler_request(i
->thread_info
.resampler
, nbytes
);
1175 /* Make sure to not overwrite over underruns */
1176 if (nbytes
> i
->thread_info
.playing_for
)
1177 nbytes
= (size_t) i
->thread_info
.playing_for
;
1179 i
->thread_info
.rewrite_nbytes
= nbytes
;
1181 i
->thread_info
.rewrite_nbytes
= (size_t) -1;
1183 i
->thread_info
.rewrite_flush
= flush
&& i
->thread_info
.rewrite_nbytes
!= 0;
1185 /* Transform to sink domain */
1186 if (i
->thread_info
.resampler
)
1187 nbytes
= pa_resampler_result(i
->thread_info
.resampler
, nbytes
);
1190 pa_sink_request_rewind(i
->sink
, nbytes
- lbq
);
1192 /* This call will make sure process_rewind() is called later */
1193 pa_sink_request_rewind(i
->sink
, 0);
1196 /* Called from main context */
1197 pa_memchunk
* pa_sink_input_get_silence(pa_sink_input
*i
, pa_memchunk
*ret
) {
1198 pa_sink_input_assert_ref(i
);
1201 pa_silence_memchunk_get(
1202 &i
->sink
->core
->silence_cache
,
1203 i
->sink
->core
->mempool
,
1206 i
->thread_info
.resampler
? pa_resampler_max_block_size(i
->thread_info
.resampler
) : 0);