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)
45 #define MOVE_BUFFER_LENGTH (PA_PAGE_SIZE*256)
47 static PA_DEFINE_CHECK_TYPE(pa_sink_input
, pa_msgobject
);
49 static void sink_input_free(pa_object
*o
);
51 pa_sink_input_new_data
* pa_sink_input_new_data_init(pa_sink_input_new_data
*data
) {
54 memset(data
, 0, sizeof(*data
));
55 data
->resample_method
= PA_RESAMPLER_INVALID
;
56 data
->proplist
= pa_proplist_new();
61 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data
*data
, const pa_sample_spec
*spec
) {
64 if ((data
->sample_spec_is_set
= !!spec
))
65 data
->sample_spec
= *spec
;
68 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data
*data
, const pa_channel_map
*map
) {
71 if ((data
->channel_map_is_set
= !!map
))
72 data
->channel_map
= *map
;
75 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data
*data
, const pa_cvolume
*volume
) {
78 if ((data
->volume_is_set
= !!volume
))
79 data
->volume
= *volume
;
82 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data
*data
, pa_bool_t mute
) {
85 data
->muted_is_set
= TRUE
;
89 void pa_sink_input_new_data_done(pa_sink_input_new_data
*data
) {
92 pa_proplist_free(data
->proplist
);
95 static void reset_callbacks(pa_sink_input
*i
) {
99 i
->process_rewind
= NULL
;
100 i
->update_max_rewind
= NULL
;
106 i
->get_latency
= NULL
;
107 i
->state_change
= NULL
;
110 pa_sink_input
* pa_sink_input_new(
112 pa_sink_input_new_data
*data
,
113 pa_sink_input_flags_t flags
) {
116 pa_resampler
*resampler
= NULL
;
117 char st
[PA_SAMPLE_SPEC_SNPRINT_MAX
], cm
[PA_CHANNEL_MAP_SNPRINT_MAX
];
122 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_INPUT_NEW
], data
) < 0)
125 pa_return_null_if_fail(!data
->driver
|| pa_utf8_valid(data
->driver
));
128 data
->sink
= pa_namereg_get(core
, NULL
, PA_NAMEREG_SINK
, 1);
130 pa_return_null_if_fail(data
->sink
);
131 pa_return_null_if_fail(pa_sink_get_state(data
->sink
) != PA_SINK_UNLINKED
);
132 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
));
134 if (!data
->sample_spec_is_set
)
135 data
->sample_spec
= data
->sink
->sample_spec
;
137 pa_return_null_if_fail(pa_sample_spec_valid(&data
->sample_spec
));
139 if (!data
->channel_map_is_set
) {
140 if (data
->sink
->channel_map
.channels
== data
->sample_spec
.channels
)
141 data
->channel_map
= data
->sink
->channel_map
;
143 pa_return_null_if_fail(pa_channel_map_init_auto(&data
->channel_map
, data
->sample_spec
.channels
, PA_CHANNEL_MAP_DEFAULT
));
146 pa_return_null_if_fail(pa_channel_map_valid(&data
->channel_map
));
147 pa_return_null_if_fail(data
->channel_map
.channels
== data
->sample_spec
.channels
);
149 if (!data
->volume_is_set
)
150 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
152 pa_return_null_if_fail(pa_cvolume_valid(&data
->volume
));
153 pa_return_null_if_fail(data
->volume
.channels
== data
->sample_spec
.channels
);
155 if (!data
->muted_is_set
)
158 if (flags
& PA_SINK_INPUT_FIX_FORMAT
)
159 data
->sample_spec
.format
= data
->sink
->sample_spec
.format
;
161 if (flags
& PA_SINK_INPUT_FIX_RATE
)
162 data
->sample_spec
.rate
= data
->sink
->sample_spec
.rate
;
164 if (flags
& PA_SINK_INPUT_FIX_CHANNELS
) {
165 data
->sample_spec
.channels
= data
->sink
->sample_spec
.channels
;
166 data
->channel_map
= data
->sink
->channel_map
;
169 pa_assert(pa_sample_spec_valid(&data
->sample_spec
));
170 pa_assert(pa_channel_map_valid(&data
->channel_map
));
172 /* Due to the fixing of the sample spec the volume might not match anymore */
173 if (data
->volume
.channels
!= data
->sample_spec
.channels
)
174 pa_cvolume_set(&data
->volume
, data
->sample_spec
.channels
, pa_cvolume_avg(&data
->volume
));
176 if (data
->resample_method
== PA_RESAMPLER_INVALID
)
177 data
->resample_method
= core
->resample_method
;
179 pa_return_null_if_fail(data
->resample_method
< PA_RESAMPLER_MAX
);
181 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_INPUT_FIXATE
], data
) < 0)
184 if (pa_idxset_size(data
->sink
->inputs
) >= PA_MAX_INPUTS_PER_SINK
) {
185 pa_log_warn("Failed to create sink input: too many inputs per sink.");
189 if ((flags
& PA_SINK_INPUT_VARIABLE_RATE
) ||
190 !pa_sample_spec_equal(&data
->sample_spec
, &data
->sink
->sample_spec
) ||
191 !pa_channel_map_equal(&data
->channel_map
, &data
->sink
->channel_map
)) {
193 if (!(resampler
= pa_resampler_new(
195 &data
->sample_spec
, &data
->channel_map
,
196 &data
->sink
->sample_spec
, &data
->sink
->channel_map
,
197 data
->resample_method
,
198 ((flags
& PA_SINK_INPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
199 ((flags
& PA_SINK_INPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
200 (core
->disable_remixing
|| (flags
& PA_SINK_INPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0)))) {
201 pa_log_warn("Unsupported resampling operation.");
205 data
->resample_method
= pa_resampler_get_method(resampler
);
208 i
= pa_msgobject_new(pa_sink_input
);
209 i
->parent
.parent
.free
= sink_input_free
;
210 i
->parent
.process_msg
= pa_sink_input_process_msg
;
213 i
->state
= PA_SINK_INPUT_INIT
;
215 i
->proplist
= pa_proplist_copy(data
->proplist
);
216 i
->driver
= pa_xstrdup(data
->driver
);
217 i
->module
= data
->module
;
218 i
->sink
= data
->sink
;
219 i
->client
= data
->client
;
221 i
->direct_outputs
= pa_idxset_new(NULL
, NULL
);
223 i
->resample_method
= data
->resample_method
;
224 i
->sample_spec
= data
->sample_spec
;
225 i
->channel_map
= data
->channel_map
;
227 i
->volume
= data
->volume
;
228 i
->muted
= data
->muted
;
230 if (data
->sync_base
) {
231 i
->sync_next
= data
->sync_base
->sync_next
;
232 i
->sync_prev
= data
->sync_base
;
234 if (data
->sync_base
->sync_next
)
235 data
->sync_base
->sync_next
->sync_prev
= i
;
236 data
->sync_base
->sync_next
= i
;
238 i
->sync_next
= i
->sync_prev
= NULL
;
243 i
->thread_info
.state
= i
->state
;
244 i
->thread_info
.attached
= FALSE
;
245 pa_atomic_store(&i
->thread_info
.drained
, 1);
246 i
->thread_info
.sample_spec
= i
->sample_spec
;
247 i
->thread_info
.resampler
= resampler
;
248 i
->thread_info
.volume
= i
->volume
;
249 i
->thread_info
.muted
= i
->muted
;
250 i
->thread_info
.requested_sink_latency
= (pa_usec_t
) -1;
251 i
->thread_info
.rewrite_nbytes
= 0;
252 i
->thread_info
.rewrite_flush
= FALSE
;
253 i
->thread_info
.underrun_for
= (uint64_t) -1;
254 i
->thread_info
.playing_for
= 0;
255 i
->thread_info
.direct_outputs
= pa_hashmap_new(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
);
257 i
->thread_info
.render_memblockq
= pa_memblockq_new(
261 pa_frame_size(&i
->sink
->sample_spec
),
267 pa_assert_se(pa_idxset_put(core
->sink_inputs
, pa_sink_input_ref(i
), &i
->index
) == 0);
268 pa_assert_se(pa_idxset_put(i
->sink
->inputs
, i
, NULL
) == 0);
270 pa_log_info("Created input %u \"%s\" on %s with sample spec %s and channel map %s",
272 pa_strnull(pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
)),
274 pa_sample_spec_snprint(st
, sizeof(st
), &i
->sample_spec
),
275 pa_channel_map_snprint(cm
, sizeof(cm
), &i
->channel_map
));
277 /* Don't forget to call pa_sink_input_put! */
282 static void update_n_corked(pa_sink_input
*i
, pa_sink_input_state_t state
) {
285 if (i
->state
== PA_SINK_INPUT_CORKED
&& state
!= PA_SINK_INPUT_CORKED
)
286 pa_assert_se(i
->sink
->n_corked
-- >= 1);
287 else if (i
->state
!= PA_SINK_INPUT_CORKED
&& state
== PA_SINK_INPUT_CORKED
)
290 pa_sink_update_status(i
->sink
);
293 static int sink_input_set_state(pa_sink_input
*i
, pa_sink_input_state_t state
) {
294 pa_sink_input
*ssync
;
297 if (state
== PA_SINK_INPUT_DRAINED
)
298 state
= PA_SINK_INPUT_RUNNING
;
300 if (i
->state
== state
)
303 if (pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_STATE
, PA_UINT_TO_PTR(state
), 0, NULL
) < 0)
306 update_n_corked(i
, state
);
309 for (ssync
= i
->sync_prev
; ssync
; ssync
= ssync
->sync_prev
) {
310 update_n_corked(ssync
, state
);
311 ssync
->state
= state
;
313 for (ssync
= i
->sync_next
; ssync
; ssync
= ssync
->sync_next
) {
314 update_n_corked(ssync
, state
);
315 ssync
->state
= state
;
318 if (state
!= PA_SINK_INPUT_UNLINKED
)
319 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED
], i
);
324 void pa_sink_input_unlink(pa_sink_input
*i
) {
326 pa_source_output
*o
, *p
= NULL
;
329 /* See pa_sink_unlink() for a couple of comments how this function
332 pa_sink_input_ref(i
);
334 linked
= PA_SINK_INPUT_IS_LINKED(i
->state
);
337 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_UNLINK
], i
);
340 i
->sync_prev
->sync_next
= i
->sync_next
;
342 i
->sync_next
->sync_prev
= i
->sync_prev
;
344 i
->sync_prev
= i
->sync_next
= NULL
;
346 pa_idxset_remove_by_data(i
->sink
->core
->sink_inputs
, i
, NULL
);
347 if (pa_idxset_remove_by_data(i
->sink
->inputs
, i
, NULL
))
348 pa_sink_input_unref(i
);
350 while ((o
= pa_idxset_first(i
->direct_outputs
, NULL
))) {
352 pa_source_output_kill(o
);
356 update_n_corked(i
, PA_SINK_INPUT_UNLINKED
);
357 i
->state
= PA_SINK_INPUT_UNLINKED
;
360 if (i
->sink
->asyncmsgq
)
361 pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_REMOVE_INPUT
, i
, 0, NULL
);
366 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_REMOVE
, i
->index
);
367 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST
], i
);
371 pa_sink_input_unref(i
);
374 static void sink_input_free(pa_object
*o
) {
375 pa_sink_input
* i
= PA_SINK_INPUT(o
);
378 pa_assert(pa_sink_input_refcnt(i
) == 0);
380 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
381 pa_sink_input_unlink(i
);
383 pa_log_info("Freeing input %u \"%s\"", i
->index
, pa_strnull(pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
)));
385 pa_assert(!i
->thread_info
.attached
);
387 if (i
->thread_info
.render_memblockq
)
388 pa_memblockq_free(i
->thread_info
.render_memblockq
);
390 if (i
->thread_info
.resampler
)
391 pa_resampler_free(i
->thread_info
.resampler
);
394 pa_proplist_free(i
->proplist
);
396 if (i
->direct_outputs
)
397 pa_idxset_free(i
->direct_outputs
, NULL
, NULL
);
399 if (i
->thread_info
.direct_outputs
)
400 pa_hashmap_free(i
->thread_info
.direct_outputs
, NULL
, NULL
);
406 void pa_sink_input_put(pa_sink_input
*i
) {
407 pa_sink_input_state_t state
;
408 pa_sink_input_assert_ref(i
);
410 pa_assert(i
->state
== PA_SINK_INPUT_INIT
);
412 pa_assert(i
->process_rewind
);
414 i
->thread_info
.volume
= i
->volume
;
415 i
->thread_info
.muted
= i
->muted
;
417 state
= i
->flags
& PA_SINK_INPUT_START_CORKED
? PA_SINK_INPUT_CORKED
: PA_SINK_INPUT_RUNNING
;
419 update_n_corked(i
, state
);
422 pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_ADD_INPUT
, i
, 0, NULL
);
424 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_NEW
, i
->index
);
425 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PUT
], i
);
428 void pa_sink_input_kill(pa_sink_input
*i
) {
429 pa_sink_input_assert_ref(i
);
430 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
436 pa_usec_t
pa_sink_input_get_latency(pa_sink_input
*i
) {
439 pa_sink_input_assert_ref(i
);
440 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
442 if (pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_GET_LATENCY
, &r
, 0, NULL
) < 0)
446 r
+= i
->get_latency(i
);
451 /* Called from thread context */
452 int pa_sink_input_peek(pa_sink_input
*i
, size_t slength
/* in sink frames */, pa_memchunk
*chunk
, pa_cvolume
*volume
) {
453 pa_bool_t do_volume_adj_here
;
454 pa_bool_t volume_is_norm
;
455 size_t block_size_max_sink
, block_size_max_sink_input
;
458 pa_sink_input_assert_ref(i
);
459 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
460 pa_assert(pa_frame_aligned(slength
, &i
->sink
->sample_spec
));
464 /* pa_log_debug("peek"); */
469 pa_assert(i
->thread_info
.state
== PA_SINK_INPUT_RUNNING
||
470 i
->thread_info
.state
== PA_SINK_INPUT_CORKED
||
471 i
->thread_info
.state
== PA_SINK_INPUT_DRAINED
);
473 /* If there's still some rewrite request the handle, but the sink
474 didn't do this for us, we do it here. However, since the sink
475 apparently doesn't support rewinding, we pass 0 here. This still
476 allows rewinding through the render buffer. */
477 pa_sink_input_process_rewind(i
, 0);
479 block_size_max_sink_input
= i
->thread_info
.resampler
?
480 pa_resampler_max_block_size(i
->thread_info
.resampler
) :
481 pa_frame_align(pa_mempool_block_size_max(i
->sink
->core
->mempool
), &i
->sample_spec
);
483 block_size_max_sink
= pa_frame_align(pa_mempool_block_size_max(i
->sink
->core
->mempool
), &i
->sink
->sample_spec
);
485 /* Default buffer size */
487 slength
= pa_frame_align(CONVERT_BUFFER_LENGTH
, &i
->sink
->sample_spec
);
489 if (slength
> block_size_max_sink
)
490 slength
= block_size_max_sink
;
492 if (i
->thread_info
.resampler
) {
493 ilength
= pa_resampler_request(i
->thread_info
.resampler
, slength
);
496 ilength
= pa_frame_align(CONVERT_BUFFER_LENGTH
, &i
->sample_spec
);
500 if (ilength
> block_size_max_sink_input
)
501 ilength
= block_size_max_sink_input
;
503 /* If the channel maps of the sink and this stream differ, we need
504 * to adjust the volume *before* we resample. Otherwise we can do
505 * it after and leave it for the sink code */
507 do_volume_adj_here
= !pa_channel_map_equal(&i
->channel_map
, &i
->sink
->channel_map
);
508 volume_is_norm
= pa_cvolume_is_norm(&i
->thread_info
.volume
) && !i
->thread_info
.muted
;
510 while (!pa_memblockq_is_readable(i
->thread_info
.render_memblockq
)) {
513 /* There's nothing in our render queue. We need to fill it up
514 * with data from the implementor. */
516 if (i
->thread_info
.state
== PA_SINK_INPUT_CORKED
||
517 i
->pop(i
, ilength
, &tchunk
) < 0) {
519 /* OK, we're corked or the implementor didn't give us any
520 * data, so let's just hand out silence */
521 pa_atomic_store(&i
->thread_info
.drained
, 1);
523 pa_memblockq_seek(i
->thread_info
.render_memblockq
, slength
, PA_SEEK_RELATIVE
);
524 i
->thread_info
.playing_for
= 0;
525 if (i
->thread_info
.underrun_for
!= (uint64_t) -1)
526 i
->thread_info
.underrun_for
+= ilength
;
530 pa_atomic_store(&i
->thread_info
.drained
, 0);
532 pa_assert(tchunk
.length
> 0);
533 pa_assert(tchunk
.memblock
);
535 i
->thread_info
.underrun_for
= 0;
536 i
->thread_info
.playing_for
+= tchunk
.length
;
538 while (tchunk
.length
> 0) {
542 pa_memblock_ref(wchunk
.memblock
);
544 if (wchunk
.length
> block_size_max_sink_input
)
545 wchunk
.length
= block_size_max_sink_input
;
547 /* It might be necessary to adjust the volume here */
548 if (do_volume_adj_here
&& !volume_is_norm
) {
549 pa_memchunk_make_writable(&wchunk
, 0);
551 if (i
->thread_info
.muted
)
552 pa_silence_memchunk(&wchunk
, &i
->thread_info
.sample_spec
);
554 pa_volume_memchunk(&wchunk
, &i
->thread_info
.sample_spec
, &i
->thread_info
.volume
);
557 if (!i
->thread_info
.resampler
)
558 pa_memblockq_push_align(i
->thread_info
.render_memblockq
, &wchunk
);
561 pa_resampler_run(i
->thread_info
.resampler
, &wchunk
, &rchunk
);
563 /* pa_log_debug("pushing %lu", (unsigned long) rchunk.length); */
565 if (rchunk
.memblock
) {
566 pa_memblockq_push_align(i
->thread_info
.render_memblockq
, &rchunk
);
567 pa_memblock_unref(rchunk
.memblock
);
571 pa_memblock_unref(wchunk
.memblock
);
573 tchunk
.index
+= wchunk
.length
;
574 tchunk
.length
-= wchunk
.length
;
577 pa_memblock_unref(tchunk
.memblock
);
580 pa_assert_se(pa_memblockq_peek(i
->thread_info
.render_memblockq
, chunk
) >= 0);
582 pa_assert(chunk
->length
> 0);
583 pa_assert(chunk
->memblock
);
585 /* pa_log_debug("peeking %lu", (unsigned long) chunk->length); */
587 if (chunk
->length
> block_size_max_sink
)
588 chunk
->length
= block_size_max_sink
;
590 /* Let's see if we had to apply the volume adjustment ourselves,
591 * or if this can be done by the sink for us */
593 if (do_volume_adj_here
)
594 /* We had different channel maps, so we already did the adjustment */
595 pa_cvolume_reset(volume
, i
->sink
->sample_spec
.channels
);
596 else if (i
->thread_info
.muted
)
597 /* We've both the same channel map, so let's have the sink do the adjustment for us*/
598 pa_cvolume_mute(volume
, i
->sink
->sample_spec
.channels
);
600 *volume
= i
->thread_info
.volume
;
605 /* Called from thread context */
606 void pa_sink_input_drop(pa_sink_input
*i
, size_t nbytes
/* in sink sample spec */) {
607 pa_sink_input_assert_ref(i
);
609 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
610 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
611 pa_assert(nbytes
> 0);
613 /* pa_log_debug("dropping %lu", (unsigned long) nbytes); */
615 /* If there's still some rewrite request the handle, but the sink
616 didn't do this for us, we do it here. However, since the sink
617 apparently doesn't support rewinding, we pass 0 here. This still
618 allows rewinding through the render buffer. */
619 pa_sink_input_process_rewind(i
, 0);
621 pa_memblockq_drop(i
->thread_info
.render_memblockq
, nbytes
);
624 /* Called from thread context */
625 void pa_sink_input_process_rewind(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
));
632 /* pa_log_debug("rewind(%lu, %lu)", (unsigned long) nbytes, (unsigned long) i->thread_info.rewrite_nbytes); */
634 lbq
= pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
637 pa_log_debug("Have to rewind %lu bytes on render memblockq.", (unsigned long) nbytes
);
638 pa_memblockq_rewind(i
->thread_info
.render_memblockq
, nbytes
);
641 if (i
->thread_info
.rewrite_nbytes
== (size_t) -1) {
643 /* We were asked to drop all buffered data, and rerequest new
644 * data from implementor the next time push() is called */
646 pa_memblockq_flush(i
->thread_info
.render_memblockq
);
648 } else if (i
->thread_info
.rewrite_nbytes
> 0) {
649 size_t max_rewrite
, amount
;
651 /* Calculate how much make sense to rewrite at most */
652 max_rewrite
= nbytes
+ lbq
;
654 /* Transform into local domain */
655 if (i
->thread_info
.resampler
)
656 max_rewrite
= pa_resampler_request(i
->thread_info
.resampler
, max_rewrite
);
658 /* Calculate how much of the rewinded data should actually be rewritten */
659 amount
= PA_MIN(i
->thread_info
.rewrite_nbytes
, max_rewrite
);
662 pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) amount
);
664 /* Tell the implementor */
665 if (i
->process_rewind
)
666 i
->process_rewind(i
, amount
);
668 /* Convert back to to sink domain */
669 if (i
->thread_info
.resampler
)
670 amount
= pa_resampler_result(i
->thread_info
.resampler
, amount
);
673 /* Ok, now update the write pointer */
674 pa_memblockq_seek(i
->thread_info
.render_memblockq
, - ((int64_t) amount
), PA_SEEK_RELATIVE
);
676 if (i
->thread_info
.rewrite_flush
)
677 pa_memblockq_silence(i
->thread_info
.render_memblockq
);
679 /* And reset the resampler */
680 if (i
->thread_info
.resampler
)
681 pa_resampler_reset(i
->thread_info
.resampler
);
685 i
->thread_info
.rewrite_nbytes
= 0;
686 i
->thread_info
.rewrite_flush
= FALSE
;
689 /* Called from thread context */
690 void pa_sink_input_update_max_rewind(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */) {
691 pa_sink_input_assert_ref(i
);
692 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
693 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
695 pa_memblockq_set_maxrewind(i
->thread_info
.render_memblockq
, nbytes
);
697 if (i
->update_max_rewind
)
698 i
->update_max_rewind(i
, i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, nbytes
) : nbytes
);
701 static pa_usec_t
fixup_latency(pa_sink
*s
, pa_usec_t usec
) {
702 pa_sink_assert_ref(s
);
704 if (usec
== (pa_usec_t
) -1)
707 if (s
->max_latency
> 0 && usec
> s
->max_latency
)
708 usec
= s
->max_latency
;
710 if (s
->min_latency
> 0 && usec
< s
->min_latency
)
711 usec
= s
->min_latency
;
716 pa_usec_t
pa_sink_input_set_requested_latency_within_thread(pa_sink_input
*i
, pa_usec_t usec
) {
717 pa_sink_input_assert_ref(i
);
719 usec
= fixup_latency(i
->sink
, usec
);
721 i
->thread_info
.requested_sink_latency
= usec
;
722 pa_sink_invalidate_requested_latency(i
->sink
);
727 pa_usec_t
pa_sink_input_set_requested_latency(pa_sink_input
*i
, pa_usec_t usec
) {
728 pa_sink_input_assert_ref(i
);
730 usec
= fixup_latency(i
->sink
, usec
);
732 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
733 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
, NULL
, (int64_t) usec
, NULL
, NULL
);
735 /* If this sink input is not realized yet, we have to touch
736 * the thread info data directly */
737 i
->thread_info
.requested_sink_latency
= usec
;
738 i
->sink
->thread_info
.requested_latency_valid
= FALSE
;
744 pa_usec_t
pa_sink_input_get_requested_latency(pa_sink_input
*i
) {
747 pa_sink_input_assert_ref(i
);
749 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
750 pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
);
752 /* If this sink input is not realized yet, we have to touch
753 * the thread info data directly */
754 usec
= i
->thread_info
.requested_sink_latency
;
759 void pa_sink_input_set_volume(pa_sink_input
*i
, const pa_cvolume
*volume
) {
760 pa_sink_input_assert_ref(i
);
761 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
763 if (pa_cvolume_equal(&i
->volume
, volume
))
768 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_VOLUME
, pa_xnewdup(struct pa_cvolume
, volume
, 1), 0, NULL
, pa_xfree
);
769 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
772 const pa_cvolume
*pa_sink_input_get_volume(pa_sink_input
*i
) {
773 pa_sink_input_assert_ref(i
);
774 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
779 void pa_sink_input_set_mute(pa_sink_input
*i
, pa_bool_t mute
) {
781 pa_sink_input_assert_ref(i
);
782 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
784 if (!i
->muted
== !mute
)
789 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_MUTE
, PA_UINT_TO_PTR(mute
), 0, NULL
, NULL
);
790 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
793 int pa_sink_input_get_mute(pa_sink_input
*i
) {
794 pa_sink_input_assert_ref(i
);
795 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
800 void pa_sink_input_cork(pa_sink_input
*i
, pa_bool_t b
) {
801 pa_sink_input_assert_ref(i
);
802 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
804 sink_input_set_state(i
, b
? PA_SINK_INPUT_CORKED
: PA_SINK_INPUT_RUNNING
);
807 int pa_sink_input_set_rate(pa_sink_input
*i
, uint32_t rate
) {
808 pa_sink_input_assert_ref(i
);
809 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
810 pa_return_val_if_fail(i
->thread_info
.resampler
, -1);
812 if (i
->sample_spec
.rate
== rate
)
815 i
->sample_spec
.rate
= rate
;
817 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_RATE
, PA_UINT_TO_PTR(rate
), 0, NULL
, NULL
);
819 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
823 void pa_sink_input_set_name(pa_sink_input
*i
, const char *name
) {
825 pa_sink_input_assert_ref(i
);
827 if (!name
&& !pa_proplist_contains(i
->proplist
, PA_PROP_MEDIA_NAME
))
830 old
= pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
);
832 if (old
&& name
&& !strcmp(old
, name
))
836 pa_proplist_sets(i
->proplist
, PA_PROP_MEDIA_NAME
, name
);
838 pa_proplist_unset(i
->proplist
, PA_PROP_MEDIA_NAME
);
840 if (PA_SINK_INPUT_IS_LINKED(i
->state
)) {
841 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED
], i
);
842 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
846 pa_resample_method_t
pa_sink_input_get_resample_method(pa_sink_input
*i
) {
847 pa_sink_input_assert_ref(i
);
849 return i
->resample_method
;
852 int pa_sink_input_move_to(pa_sink_input
*i
, pa_sink
*dest
) {
853 pa_resampler
*new_resampler
;
855 pa_sink_input_move_hook_data hook_data
;
856 pa_source_output
*o
, *p
= NULL
;
858 pa_sink_input_assert_ref(i
);
859 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
860 pa_sink_assert_ref(dest
);
867 if (i
->flags
& PA_SINK_INPUT_DONT_MOVE
)
870 if (i
->sync_next
|| i
->sync_prev
) {
871 pa_log_warn("Moving synchronised streams not supported.");
875 if (pa_idxset_size(dest
->inputs
) >= PA_MAX_INPUTS_PER_SINK
) {
876 pa_log_warn("Failed to move sink input: too many inputs per sink.");
880 /* Kill directly connected outputs */
881 while ((o
= pa_idxset_first(i
->direct_outputs
, NULL
))) {
883 pa_source_output_kill(o
);
887 if (i
->thread_info
.resampler
&&
888 pa_sample_spec_equal(&origin
->sample_spec
, &dest
->sample_spec
) &&
889 pa_channel_map_equal(&origin
->channel_map
, &dest
->channel_map
))
891 /* Try to reuse the old resampler if possible */
892 new_resampler
= i
->thread_info
.resampler
;
894 else if ((i
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ||
895 !pa_sample_spec_equal(&i
->sample_spec
, &dest
->sample_spec
) ||
896 !pa_channel_map_equal(&i
->channel_map
, &dest
->channel_map
)) {
898 /* Okey, we need a new resampler for the new sink */
900 if (!(new_resampler
= pa_resampler_new(
902 &i
->sample_spec
, &i
->channel_map
,
903 &dest
->sample_spec
, &dest
->channel_map
,
905 ((i
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
906 ((i
->flags
& PA_SINK_INPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
907 (i
->core
->disable_remixing
|| (i
->flags
& PA_SINK_INPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0)))) {
908 pa_log_warn("Unsupported resampling operation.");
912 new_resampler
= NULL
;
914 hook_data
.sink_input
= i
;
915 hook_data
.destination
= dest
;
916 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE
], &hook_data
);
918 pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_START_MOVE
, i
, 0, NULL
);
920 pa_idxset_remove_by_data(origin
->inputs
, i
, NULL
);
921 pa_idxset_put(dest
->inputs
, i
, NULL
);
924 if (pa_sink_input_get_state(i
) == PA_SINK_INPUT_CORKED
) {
925 pa_assert_se(origin
->n_corked
-- >= 1);
929 /* Replace resampler and render queue */
930 if (new_resampler
!= i
->thread_info
.resampler
) {
932 if (i
->thread_info
.resampler
)
933 pa_resampler_free(i
->thread_info
.resampler
);
934 i
->thread_info
.resampler
= new_resampler
;
936 pa_memblockq_free(i
->thread_info
.render_memblockq
);
938 i
->thread_info
.render_memblockq
= pa_memblockq_new(
942 pa_frame_size(&i
->sink
->sample_spec
),
949 pa_sink_update_status(origin
);
950 pa_sink_update_status(dest
);
952 pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_FINISH_MOVE
, i
, 0, NULL
);
957 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE_POST
], i
);
959 pa_log_debug("Successfully moved sink input %i from %s to %s.", i
->index
, origin
->name
, dest
->name
);
961 /* Notify everyone */
962 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
967 void pa_sink_input_set_state_within_thread(pa_sink_input
*i
, pa_sink_input_state_t state
) {
968 pa_sink_input_assert_ref(i
);
970 if (state
== i
->thread_info
.state
)
973 if ((state
== PA_SINK_INPUT_DRAINED
|| state
== PA_SINK_INPUT_RUNNING
) &&
974 !(i
->thread_info
.state
== PA_SINK_INPUT_DRAINED
|| i
->thread_info
.state
!= PA_SINK_INPUT_RUNNING
))
975 pa_atomic_store(&i
->thread_info
.drained
, 1);
977 if (state
== PA_SINK_INPUT_CORKED
&& i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
979 /* This will tell the implementing sink input driver to rewind
980 * so that the unplayed already mixed data is not lost */
981 pa_sink_input_request_rewind(i
, 0, TRUE
, TRUE
);
983 } else if (i
->thread_info
.state
== PA_SINK_INPUT_CORKED
&& state
!= PA_SINK_INPUT_CORKED
) {
985 /* OK, we're being uncorked. Make sure we're not rewound when
986 * the hw buffer is remixed and request a remix. */
987 pa_sink_input_request_rewind(i
, 0, FALSE
, TRUE
);
991 i
->state_change(i
, state
);
993 i
->thread_info
.state
= state
;
996 /* Called from thread context */
997 int pa_sink_input_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
998 pa_sink_input
*i
= PA_SINK_INPUT(o
);
1000 pa_sink_input_assert_ref(i
);
1001 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
1004 case PA_SINK_INPUT_MESSAGE_SET_VOLUME
:
1005 i
->thread_info
.volume
= *((pa_cvolume
*) userdata
);
1006 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
);
1009 case PA_SINK_INPUT_MESSAGE_SET_MUTE
:
1010 i
->thread_info
.muted
= PA_PTR_TO_UINT(userdata
);
1011 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
);
1014 case PA_SINK_INPUT_MESSAGE_GET_LATENCY
: {
1015 pa_usec_t
*r
= userdata
;
1017 *r
+= pa_bytes_to_usec(pa_memblockq_get_length(i
->thread_info
.render_memblockq
), &i
->sink
->sample_spec
);
1021 case PA_SINK_INPUT_MESSAGE_SET_RATE
:
1023 i
->thread_info
.sample_spec
.rate
= PA_PTR_TO_UINT(userdata
);
1024 pa_resampler_set_input_rate(i
->thread_info
.resampler
, PA_PTR_TO_UINT(userdata
));
1028 case PA_SINK_INPUT_MESSAGE_SET_STATE
: {
1029 pa_sink_input
*ssync
;
1031 pa_sink_input_set_state_within_thread(i
, PA_PTR_TO_UINT(userdata
));
1033 for (ssync
= i
->thread_info
.sync_prev
; ssync
; ssync
= ssync
->thread_info
.sync_prev
)
1034 pa_sink_input_set_state_within_thread(ssync
, PA_PTR_TO_UINT(userdata
));
1036 for (ssync
= i
->thread_info
.sync_next
; ssync
; ssync
= ssync
->thread_info
.sync_next
)
1037 pa_sink_input_set_state_within_thread(ssync
, PA_PTR_TO_UINT(userdata
));
1042 case PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
:
1044 pa_sink_input_set_requested_latency_within_thread(i
, (pa_usec_t
) offset
);
1047 case PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY
: {
1048 pa_usec_t
*r
= userdata
;
1050 *r
= i
->thread_info
.requested_sink_latency
;
1058 pa_sink_input_state_t
pa_sink_input_get_state(pa_sink_input
*i
) {
1059 pa_sink_input_assert_ref(i
);
1061 if (i
->state
== PA_SINK_INPUT_RUNNING
|| i
->state
== PA_SINK_INPUT_DRAINED
)
1062 return pa_atomic_load(&i
->thread_info
.drained
) ? PA_SINK_INPUT_DRAINED
: PA_SINK_INPUT_RUNNING
;
1067 /* Called from IO context */
1068 pa_bool_t
pa_sink_input_safe_to_remove(pa_sink_input
*i
) {
1069 pa_sink_input_assert_ref(i
);
1071 if (PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
))
1072 return pa_memblockq_is_empty(i
->thread_info
.render_memblockq
);
1077 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
) {
1080 /* If 'rewrite' is TRUE the sink is rewound as far as requested
1081 * and possible and the exact value of this is passed back the
1082 * implementor via process_rewind(). If 'flush' is also TRUE all
1083 * already rendered data is also dropped.
1085 * If 'rewrite' is FALSE the sink is rewound as far as requested
1086 * and possible and the already rendered data is dropped so that
1087 * in the next iteration we read new data from the
1088 * implementor. This implies 'flush' is TRUE. */
1090 pa_sink_input_assert_ref(i
);
1091 pa_assert(i
->thread_info
.rewrite_nbytes
== 0);
1093 /* We don't take rewind requests while we are corked */
1094 if (i
->thread_info
.state
== PA_SINK_INPUT_CORKED
)
1097 pa_assert(rewrite
|| flush
);
1099 /* Calculate how much we can rewind locally without having to
1102 lbq
= pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
1106 /* Check if rewinding for the maximum is requested, and if so, fix up */
1109 /* Calculate maximum number of bytes that could be rewound in theory */
1110 nbytes
= i
->sink
->thread_info
.max_rewind
+ lbq
;
1112 /* Transform from sink domain */
1113 if (i
->thread_info
.resampler
)
1114 nbytes
= pa_resampler_request(i
->thread_info
.resampler
, nbytes
);
1118 /* Make sure to not overwrite over underruns */
1119 if (nbytes
> i
->thread_info
.playing_for
)
1120 nbytes
= (size_t) i
->thread_info
.playing_for
;
1122 i
->thread_info
.rewrite_nbytes
= nbytes
;
1124 i
->thread_info
.rewrite_nbytes
= (size_t) -1;
1126 i
->thread_info
.rewrite_flush
= flush
&& i
->thread_info
.rewrite_nbytes
!= 0;
1128 /* Transform to sink domain */
1129 if (i
->thread_info
.resampler
)
1130 nbytes
= pa_resampler_result(i
->thread_info
.resampler
, nbytes
);
1133 pa_sink_request_rewind(i
->sink
, nbytes
- lbq
);
1136 pa_memchunk
* pa_sink_input_get_silence(pa_sink_input
*i
, pa_memchunk
*ret
) {
1137 pa_sink_input_assert_ref(i
);
1140 pa_silence_memchunk_get(
1141 &i
->sink
->core
->silence_cache
,
1142 i
->sink
->core
->mempool
,
1145 i
->thread_info
.resampler
? pa_resampler_max_block_size(i
->thread_info
.resampler
) : 0);