4 This file is part of PulseAudio.
6 Copyright 2004-2006 Lennart Poettering
7 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published
11 by the Free Software Foundation; either version 2 of the License,
12 or (at your option) any later version.
14 PulseAudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
33 #include <pulse/utf8.h>
34 #include <pulse/xmalloc.h>
36 #include <pulsecore/sample-util.h>
37 #include <pulsecore/core-subscribe.h>
38 #include <pulsecore/log.h>
39 #include <pulsecore/play-memblockq.h>
40 #include <pulsecore/namereg.h>
41 #include <pulsecore/core-util.h>
43 #include "sink-input.h"
45 #define MEMBLOCKQ_MAXLENGTH (32*1024*1024)
46 #define CONVERT_BUFFER_LENGTH (PA_PAGE_SIZE)
47 #define MOVE_BUFFER_LENGTH (PA_PAGE_SIZE*256)
49 static PA_DEFINE_CHECK_TYPE(pa_sink_input
, pa_msgobject
);
51 static void sink_input_free(pa_object
*o
);
53 pa_sink_input_new_data
* pa_sink_input_new_data_init(pa_sink_input_new_data
*data
) {
56 memset(data
, 0, sizeof(*data
));
57 data
->resample_method
= PA_RESAMPLER_INVALID
;
58 data
->proplist
= pa_proplist_new();
63 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data
*data
, const pa_sample_spec
*spec
) {
66 if ((data
->sample_spec_is_set
= !!spec
))
67 data
->sample_spec
= *spec
;
70 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data
*data
, const pa_channel_map
*map
) {
73 if ((data
->channel_map_is_set
= !!map
))
74 data
->channel_map
= *map
;
77 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data
*data
, const pa_cvolume
*volume
) {
80 if ((data
->volume_is_set
= !!volume
))
81 data
->volume
= *volume
;
84 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data
*data
, pa_bool_t mute
) {
87 data
->muted_is_set
= TRUE
;
91 void pa_sink_input_new_data_done(pa_sink_input_new_data
*data
) {
94 pa_proplist_free(data
->proplist
);
97 static void reset_callbacks(pa_sink_input
*i
) {
101 i
->process_rewind
= NULL
;
102 i
->update_max_rewind
= NULL
;
108 i
->get_latency
= NULL
;
109 i
->state_change
= NULL
;
112 pa_sink_input
* pa_sink_input_new(
114 pa_sink_input_new_data
*data
,
115 pa_sink_input_flags_t flags
) {
118 pa_resampler
*resampler
= NULL
;
119 char st
[PA_SAMPLE_SPEC_SNPRINT_MAX
], cm
[PA_CHANNEL_MAP_SNPRINT_MAX
];
124 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_INPUT_NEW
], data
) < 0)
127 pa_return_null_if_fail(!data
->driver
|| pa_utf8_valid(data
->driver
));
130 data
->sink
= pa_namereg_get(core
, NULL
, PA_NAMEREG_SINK
, 1);
132 pa_return_null_if_fail(data
->sink
);
133 pa_return_null_if_fail(pa_sink_get_state(data
->sink
) != PA_SINK_UNLINKED
);
134 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
));
136 if (!data
->sample_spec_is_set
)
137 data
->sample_spec
= data
->sink
->sample_spec
;
139 pa_return_null_if_fail(pa_sample_spec_valid(&data
->sample_spec
));
141 if (!data
->channel_map_is_set
) {
142 if (data
->sink
->channel_map
.channels
== data
->sample_spec
.channels
)
143 data
->channel_map
= data
->sink
->channel_map
;
145 pa_return_null_if_fail(pa_channel_map_init_auto(&data
->channel_map
, data
->sample_spec
.channels
, PA_CHANNEL_MAP_DEFAULT
));
148 pa_return_null_if_fail(pa_channel_map_valid(&data
->channel_map
));
149 pa_return_null_if_fail(data
->channel_map
.channels
== data
->sample_spec
.channels
);
151 if (!data
->volume_is_set
)
152 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
154 pa_return_null_if_fail(pa_cvolume_valid(&data
->volume
));
155 pa_return_null_if_fail(data
->volume
.channels
== data
->sample_spec
.channels
);
157 if (!data
->muted_is_set
)
160 if (flags
& PA_SINK_INPUT_FIX_FORMAT
)
161 data
->sample_spec
.format
= data
->sink
->sample_spec
.format
;
163 if (flags
& PA_SINK_INPUT_FIX_RATE
)
164 data
->sample_spec
.rate
= data
->sink
->sample_spec
.rate
;
166 if (flags
& PA_SINK_INPUT_FIX_CHANNELS
) {
167 data
->sample_spec
.channels
= data
->sink
->sample_spec
.channels
;
168 data
->channel_map
= data
->sink
->channel_map
;
171 pa_assert(pa_sample_spec_valid(&data
->sample_spec
));
172 pa_assert(pa_channel_map_valid(&data
->channel_map
));
174 /* Due to the fixing of the sample spec the volume might not match anymore */
175 if (data
->volume
.channels
!= data
->sample_spec
.channels
)
176 pa_cvolume_set(&data
->volume
, data
->sample_spec
.channels
, pa_cvolume_avg(&data
->volume
));
178 if (data
->resample_method
== PA_RESAMPLER_INVALID
)
179 data
->resample_method
= core
->resample_method
;
181 pa_return_null_if_fail(data
->resample_method
< PA_RESAMPLER_MAX
);
183 if (pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SINK_INPUT_FIXATE
], data
) < 0)
186 if (pa_idxset_size(data
->sink
->inputs
) >= PA_MAX_INPUTS_PER_SINK
) {
187 pa_log_warn("Failed to create sink input: too many inputs per sink.");
191 if ((flags
& PA_SINK_INPUT_VARIABLE_RATE
) ||
192 !pa_sample_spec_equal(&data
->sample_spec
, &data
->sink
->sample_spec
) ||
193 !pa_channel_map_equal(&data
->channel_map
, &data
->sink
->channel_map
)) {
195 if (!(resampler
= pa_resampler_new(
197 &data
->sample_spec
, &data
->channel_map
,
198 &data
->sink
->sample_spec
, &data
->sink
->channel_map
,
199 data
->resample_method
,
200 ((flags
& PA_SINK_INPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
201 ((flags
& PA_SINK_INPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
202 (core
->disable_remixing
|| (flags
& PA_SINK_INPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0)))) {
203 pa_log_warn("Unsupported resampling operation.");
207 data
->resample_method
= pa_resampler_get_method(resampler
);
210 i
= pa_msgobject_new(pa_sink_input
);
211 i
->parent
.parent
.free
= sink_input_free
;
212 i
->parent
.process_msg
= pa_sink_input_process_msg
;
215 i
->state
= PA_SINK_INPUT_INIT
;
217 i
->proplist
= pa_proplist_copy(data
->proplist
);
218 i
->driver
= pa_xstrdup(data
->driver
);
219 i
->module
= data
->module
;
220 i
->sink
= data
->sink
;
221 i
->client
= data
->client
;
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 pa_atomic_store(&i
->thread_info
.render_memblockq_is_empty
, 0);
247 i
->thread_info
.sample_spec
= i
->sample_spec
;
248 i
->thread_info
.resampler
= resampler
;
249 i
->thread_info
.volume
= i
->volume
;
250 i
->thread_info
.muted
= i
->muted
;
251 i
->thread_info
.requested_sink_latency
= (pa_usec_t
) -1;
252 i
->thread_info
.rewrite_nbytes
= 0;
253 i
->thread_info
.rewrite_flush
= FALSE
;
254 i
->thread_info
.underrun_for
= (uint64_t) -1;
255 i
->thread_info
.playing_for
= 0;
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
) {
328 /* See pa_sink_unlink() for a couple of comments how this function
331 pa_sink_input_ref(i
);
333 linked
= PA_SINK_INPUT_IS_LINKED(i
->state
);
336 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_UNLINK
], i
);
339 i
->sync_prev
->sync_next
= i
->sync_next
;
341 i
->sync_next
->sync_prev
= i
->sync_prev
;
343 i
->sync_prev
= i
->sync_next
= NULL
;
345 pa_idxset_remove_by_data(i
->sink
->core
->sink_inputs
, i
, NULL
);
346 if (pa_idxset_remove_by_data(i
->sink
->inputs
, i
, NULL
))
347 pa_sink_input_unref(i
);
349 update_n_corked(i
, PA_SINK_INPUT_UNLINKED
);
350 i
->state
= PA_SINK_INPUT_UNLINKED
;
353 if (i
->sink
->asyncmsgq
)
354 pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_REMOVE_INPUT
, i
, 0, NULL
);
359 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_REMOVE
, i
->index
);
360 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST
], i
);
364 pa_sink_input_unref(i
);
367 static void sink_input_free(pa_object
*o
) {
368 pa_sink_input
* i
= PA_SINK_INPUT(o
);
371 pa_assert(pa_sink_input_refcnt(i
) == 0);
373 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
374 pa_sink_input_unlink(i
);
376 pa_log_info("Freeing input %u \"%s\"", i
->index
, pa_strnull(pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
)));
378 pa_assert(!i
->thread_info
.attached
);
380 if (i
->thread_info
.render_memblockq
)
381 pa_memblockq_free(i
->thread_info
.render_memblockq
);
383 if (i
->thread_info
.resampler
)
384 pa_resampler_free(i
->thread_info
.resampler
);
387 pa_proplist_free(i
->proplist
);
393 void pa_sink_input_put(pa_sink_input
*i
) {
394 pa_sink_input_state_t state
;
395 pa_sink_input_assert_ref(i
);
397 pa_assert(i
->state
== PA_SINK_INPUT_INIT
);
399 pa_assert(i
->process_rewind
);
401 i
->thread_info
.volume
= i
->volume
;
402 i
->thread_info
.muted
= i
->muted
;
404 state
= i
->flags
& PA_SINK_INPUT_START_CORKED
? PA_SINK_INPUT_CORKED
: PA_SINK_INPUT_RUNNING
;
406 update_n_corked(i
, state
);
409 pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_ADD_INPUT
, i
, 0, NULL
);
411 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_NEW
, i
->index
);
412 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PUT
], i
);
414 /* Please note that if you change something here, you have to
415 change something in pa_sink_input_move() with the ghost stream
419 void pa_sink_input_kill(pa_sink_input
*i
) {
420 pa_sink_input_assert_ref(i
);
421 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
427 pa_usec_t
pa_sink_input_get_latency(pa_sink_input
*i
) {
430 pa_sink_input_assert_ref(i
);
431 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
433 if (pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_GET_LATENCY
, &r
, 0, NULL
) < 0)
437 r
+= i
->get_latency(i
);
442 /* Called from thread context */
443 int pa_sink_input_peek(pa_sink_input
*i
, size_t slength
/* in sink frames */, pa_memchunk
*chunk
, pa_cvolume
*volume
) {
444 pa_bool_t do_volume_adj_here
;
445 pa_bool_t volume_is_norm
;
446 size_t block_size_max_sink
, block_size_max_sink_input
;
449 pa_sink_input_assert_ref(i
);
450 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
451 pa_assert(pa_frame_aligned(slength
, &i
->sink
->sample_spec
));
455 /* pa_log_debug("peek"); */
460 pa_assert(i
->thread_info
.state
== PA_SINK_INPUT_RUNNING
||
461 i
->thread_info
.state
== PA_SINK_INPUT_CORKED
||
462 i
->thread_info
.state
== PA_SINK_INPUT_DRAINED
);
464 /* If there's still some rewrite request the handle, but the sink
465 didn't do this for us, we do it here. However, since the sink
466 apparently doesn't support rewinding, we pass 0 here. This still
467 allows rewinding through the render buffer. */
468 pa_sink_input_process_rewind(i
, 0);
470 block_size_max_sink_input
= i
->thread_info
.resampler
?
471 pa_resampler_max_block_size(i
->thread_info
.resampler
) :
472 pa_frame_align(pa_mempool_block_size_max(i
->sink
->core
->mempool
), &i
->sample_spec
);
474 block_size_max_sink
= pa_frame_align(pa_mempool_block_size_max(i
->sink
->core
->mempool
), &i
->sink
->sample_spec
);
476 /* Default buffer size */
478 slength
= pa_frame_align(CONVERT_BUFFER_LENGTH
, &i
->sink
->sample_spec
);
480 if (slength
> block_size_max_sink
)
481 slength
= block_size_max_sink
;
483 if (i
->thread_info
.resampler
) {
484 ilength
= pa_resampler_request(i
->thread_info
.resampler
, slength
);
487 ilength
= pa_frame_align(CONVERT_BUFFER_LENGTH
, &i
->sample_spec
);
491 if (ilength
> block_size_max_sink_input
)
492 ilength
= block_size_max_sink_input
;
494 /* If the channel maps of the sink and this stream differ, we need
495 * to adjust the volume *before* we resample. Otherwise we can do
496 * it after and leave it for the sink code */
498 do_volume_adj_here
= !pa_channel_map_equal(&i
->channel_map
, &i
->sink
->channel_map
);
499 volume_is_norm
= pa_cvolume_is_norm(&i
->thread_info
.volume
) && !i
->thread_info
.muted
;
501 while (!pa_memblockq_is_readable(i
->thread_info
.render_memblockq
)) {
504 /* There's nothing in our render queue. We need to fill it up
505 * with data from the implementor. */
507 if (i
->thread_info
.state
== PA_SINK_INPUT_CORKED
||
508 i
->pop(i
, ilength
, &tchunk
) < 0) {
510 /* OK, we're corked or the implementor didn't give us any
511 * data, so let's just hand out silence */
512 pa_atomic_store(&i
->thread_info
.drained
, 1);
514 pa_memblockq_seek(i
->thread_info
.render_memblockq
, slength
, PA_SEEK_RELATIVE_ON_READ
);
515 i
->thread_info
.playing_for
= 0;
516 if (i
->thread_info
.underrun_for
!= (uint64_t) -1)
517 i
->thread_info
.underrun_for
+= slength
;
521 pa_atomic_store(&i
->thread_info
.drained
, 0);
523 pa_assert(tchunk
.length
> 0);
524 pa_assert(tchunk
.memblock
);
526 i
->thread_info
.underrun_for
= 0;
527 i
->thread_info
.playing_for
+= tchunk
.length
;
529 while (tchunk
.length
> 0) {
533 pa_memblock_ref(wchunk
.memblock
);
535 if (wchunk
.length
> block_size_max_sink_input
)
536 wchunk
.length
= block_size_max_sink_input
;
538 /* It might be necessary to adjust the volume here */
539 if (do_volume_adj_here
&& !volume_is_norm
) {
540 pa_memchunk_make_writable(&wchunk
, 0);
542 if (i
->thread_info
.muted
)
543 pa_silence_memchunk(&wchunk
, &i
->thread_info
.sample_spec
);
545 pa_volume_memchunk(&wchunk
, &i
->thread_info
.sample_spec
, &i
->thread_info
.volume
);
548 if (!i
->thread_info
.resampler
)
549 pa_memblockq_push_align(i
->thread_info
.render_memblockq
, &wchunk
);
552 pa_resampler_run(i
->thread_info
.resampler
, &wchunk
, &rchunk
);
554 if (rchunk
.memblock
) {
555 pa_memblockq_push_align(i
->thread_info
.render_memblockq
, &rchunk
);
556 pa_memblock_unref(rchunk
.memblock
);
560 pa_memblock_unref(wchunk
.memblock
);
562 tchunk
.index
+= wchunk
.length
;
563 tchunk
.length
-= wchunk
.length
;
566 pa_memblock_unref(tchunk
.memblock
);
569 pa_assert_se(pa_memblockq_peek(i
->thread_info
.render_memblockq
, chunk
) >= 0);
571 pa_assert(chunk
->length
> 0);
572 pa_assert(chunk
->memblock
);
574 if (chunk
->length
> block_size_max_sink
)
575 chunk
->length
= block_size_max_sink
;
577 /* Let's see if we had to apply the volume adjustment ourselves,
578 * or if this can be done by the sink for us */
580 if (do_volume_adj_here
)
581 /* We had different channel maps, so we already did the adjustment */
582 pa_cvolume_reset(volume
, i
->sink
->sample_spec
.channels
);
583 else if (i
->thread_info
.muted
)
584 /* We've both the same channel map, so let's have the sink do the adjustment for us*/
585 pa_cvolume_mute(volume
, i
->sink
->sample_spec
.channels
);
587 *volume
= i
->thread_info
.volume
;
589 pa_atomic_store(&i
->thread_info
.render_memblockq_is_empty
, pa_memblockq_is_empty(i
->thread_info
.render_memblockq
));
594 /* Called from thread context */
595 void pa_sink_input_drop(pa_sink_input
*i
, size_t nbytes
/* in sink sample spec */) {
596 pa_sink_input_assert_ref(i
);
598 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
599 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
600 pa_assert(nbytes
> 0);
602 /* If there's still some rewrite request the handle, but the sink
603 didn't do this for us, we do it here. However, since the sink
604 apparently doesn't support rewinding, we pass 0 here. This still
605 allows rewinding through the render buffer. */
606 pa_sink_input_process_rewind(i
, 0);
608 pa_memblockq_drop(i
->thread_info
.render_memblockq
, nbytes
);
610 pa_atomic_store(&i
->thread_info
.render_memblockq_is_empty
, pa_memblockq_is_empty(i
->thread_info
.render_memblockq
));
613 /* Called from thread context */
614 void pa_sink_input_process_rewind(pa_sink_input
*i
, size_t nbytes
/* in sink sample spec */) {
615 pa_sink_input_assert_ref(i
);
617 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
618 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
620 /* pa_log_debug("rewind(%lu, %lu)", (unsigned long) nbytes, (unsigned long) i->thread_info.rewrite_nbytes); */
623 pa_log_debug("Have to rewind %lu bytes on render memblockq.", (unsigned long) nbytes
);
624 pa_memblockq_rewind(i
->thread_info
.render_memblockq
, nbytes
);
627 if (i
->thread_info
.rewrite_nbytes
== (size_t) -1) {
629 /* We were asked to drop all buffered data, and rerequest new
630 * data from implementor the next time push() is called */
632 pa_memblockq_flush(i
->thread_info
.render_memblockq
);
634 } else if (i
->thread_info
.rewrite_nbytes
> 0) {
635 size_t max_rewrite
, amount
;
637 /* Calculate how much make sense to rewrite at most */
638 max_rewrite
= nbytes
+ pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
640 /* Transform into local domain */
641 if (i
->thread_info
.resampler
)
642 max_rewrite
= pa_resampler_request(i
->thread_info
.resampler
, max_rewrite
);
644 /* Calculate how much of the rewinded data should actually be rewritten */
645 amount
= PA_MIN(i
->thread_info
.rewrite_nbytes
, max_rewrite
);
648 pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) amount
);
650 /* Tell the implementor */
651 if (i
->process_rewind
)
652 i
->process_rewind(i
, amount
);
654 if (i
->thread_info
.rewrite_flush
)
655 pa_memblockq_silence(i
->thread_info
.render_memblockq
);
658 /* Convert back to to sink domain */
659 if (i
->thread_info
.resampler
)
660 amount
= pa_resampler_result(i
->thread_info
.resampler
, amount
);
663 /* Ok, now update the write pointer */
664 pa_memblockq_seek(i
->thread_info
.render_memblockq
, - ((int64_t) amount
), PA_SEEK_RELATIVE
);
667 /* And reset the resampler */
668 if (i
->thread_info
.resampler
)
669 pa_resampler_reset(i
->thread_info
.resampler
);
673 i
->thread_info
.rewrite_nbytes
= 0;
674 i
->thread_info
.rewrite_flush
= FALSE
;
677 /* Called from thread context */
678 void pa_sink_input_update_max_rewind(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */) {
679 pa_sink_input_assert_ref(i
);
680 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
681 pa_assert(pa_frame_aligned(nbytes
, &i
->sink
->sample_spec
));
683 pa_memblockq_set_maxrewind(i
->thread_info
.render_memblockq
, nbytes
);
685 if (i
->update_max_rewind
)
686 i
->update_max_rewind(i
, i
->thread_info
.resampler
? pa_resampler_request(i
->thread_info
.resampler
, nbytes
) : nbytes
);
689 static pa_usec_t
fixup_latency(pa_sink
*s
, pa_usec_t usec
) {
690 pa_sink_assert_ref(s
);
692 if (usec
== (pa_usec_t
) -1)
695 if (s
->max_latency
> 0 && usec
> s
->max_latency
)
696 usec
= s
->max_latency
;
698 if (s
->min_latency
> 0 && usec
< s
->min_latency
)
699 usec
= s
->min_latency
;
704 pa_usec_t
pa_sink_input_set_requested_latency_within_thread(pa_sink_input
*i
, pa_usec_t usec
) {
706 usec
= fixup_latency(i
->sink
, usec
);
708 i
->thread_info
.requested_sink_latency
= usec
;
709 pa_sink_invalidate_requested_latency(i
->sink
);
714 pa_usec_t
pa_sink_input_set_requested_latency(pa_sink_input
*i
, pa_usec_t usec
) {
715 pa_sink_input_assert_ref(i
);
717 usec
= fixup_latency(i
->sink
, usec
);
719 if (PA_SINK_INPUT_IS_LINKED(i
->state
))
720 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
, NULL
, (int64_t) usec
, NULL
, NULL
);
722 /* If this sink input is not realized yet, we have to touch
723 * the thread info data directly */
724 i
->thread_info
.requested_sink_latency
= usec
;
725 i
->sink
->thread_info
.requested_latency_valid
= FALSE
;
731 void pa_sink_input_set_volume(pa_sink_input
*i
, const pa_cvolume
*volume
) {
732 pa_sink_input_assert_ref(i
);
733 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
735 if (pa_cvolume_equal(&i
->volume
, volume
))
740 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
);
741 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
744 const pa_cvolume
*pa_sink_input_get_volume(pa_sink_input
*i
) {
745 pa_sink_input_assert_ref(i
);
746 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
751 void pa_sink_input_set_mute(pa_sink_input
*i
, pa_bool_t mute
) {
753 pa_sink_input_assert_ref(i
);
754 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
756 if (!i
->muted
== !mute
)
761 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_MUTE
, PA_UINT_TO_PTR(mute
), 0, NULL
, NULL
);
762 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
765 int pa_sink_input_get_mute(pa_sink_input
*i
) {
766 pa_sink_input_assert_ref(i
);
767 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
772 void pa_sink_input_cork(pa_sink_input
*i
, pa_bool_t b
) {
773 pa_sink_input_assert_ref(i
);
774 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
776 sink_input_set_state(i
, b
? PA_SINK_INPUT_CORKED
: PA_SINK_INPUT_RUNNING
);
779 int pa_sink_input_set_rate(pa_sink_input
*i
, uint32_t rate
) {
780 pa_sink_input_assert_ref(i
);
781 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
782 pa_return_val_if_fail(i
->thread_info
.resampler
, -1);
784 if (i
->sample_spec
.rate
== rate
)
787 i
->sample_spec
.rate
= rate
;
789 pa_asyncmsgq_post(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
), PA_SINK_INPUT_MESSAGE_SET_RATE
, PA_UINT_TO_PTR(rate
), 0, NULL
, NULL
);
791 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
795 void pa_sink_input_set_name(pa_sink_input
*i
, const char *name
) {
797 pa_sink_input_assert_ref(i
);
799 if (!name
&& !pa_proplist_contains(i
->proplist
, PA_PROP_MEDIA_NAME
))
802 old
= pa_proplist_gets(i
->proplist
, PA_PROP_MEDIA_NAME
);
804 if (old
&& name
&& !strcmp(old
, name
))
808 pa_proplist_sets(i
->proplist
, PA_PROP_MEDIA_NAME
, name
);
810 pa_proplist_unset(i
->proplist
, PA_PROP_MEDIA_NAME
);
812 if (PA_SINK_INPUT_IS_LINKED(i
->state
)) {
813 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED
], i
);
814 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
818 pa_resample_method_t
pa_sink_input_get_resample_method(pa_sink_input
*i
) {
819 pa_sink_input_assert_ref(i
);
821 return i
->resample_method
;
824 int pa_sink_input_move_to(pa_sink_input
*i
, pa_sink
*dest
, pa_bool_t immediately
) {
825 pa_resampler
*new_resampler
;
827 pa_usec_t silence_usec
= 0;
828 pa_sink_input_move_info info
;
829 pa_sink_input_move_hook_data hook_data
;
831 pa_sink_input_assert_ref(i
);
832 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->state
));
833 pa_sink_assert_ref(dest
);
840 if (i
->flags
& PA_SINK_INPUT_DONT_MOVE
)
843 if (i
->sync_next
|| i
->sync_prev
) {
844 pa_log_warn("Moving synchronised streams not supported.");
848 if (pa_idxset_size(dest
->inputs
) >= PA_MAX_INPUTS_PER_SINK
) {
849 pa_log_warn("Failed to move sink input: too many inputs per sink.");
853 if (i
->thread_info
.resampler
&&
854 pa_sample_spec_equal(&origin
->sample_spec
, &dest
->sample_spec
) &&
855 pa_channel_map_equal(&origin
->channel_map
, &dest
->channel_map
))
857 /* Try to reuse the old resampler if possible */
858 new_resampler
= i
->thread_info
.resampler
;
860 else if ((i
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ||
861 !pa_sample_spec_equal(&i
->sample_spec
, &dest
->sample_spec
) ||
862 !pa_channel_map_equal(&i
->channel_map
, &dest
->channel_map
)) {
864 /* Okey, we need a new resampler for the new sink */
866 if (!(new_resampler
= pa_resampler_new(
868 &i
->sample_spec
, &i
->channel_map
,
869 &dest
->sample_spec
, &dest
->channel_map
,
871 ((i
->flags
& PA_SINK_INPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
872 ((i
->flags
& PA_SINK_INPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
873 (i
->core
->disable_remixing
|| (i
->flags
& PA_SINK_INPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0)))) {
874 pa_log_warn("Unsupported resampling operation.");
878 new_resampler
= NULL
;
880 hook_data
.sink_input
= i
;
881 hook_data
.destination
= dest
;
882 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE
], &hook_data
);
884 memset(&info
, 0, sizeof(info
));
888 pa_usec_t old_latency
, new_latency
;
890 /* Let's do a little bit of Voodoo for compensating latency
891 * differences. We assume that the accuracy for our
892 * estimations is still good enough, even though we do these
893 * operations non-atomic. */
895 old_latency
= pa_sink_get_latency(origin
);
896 new_latency
= pa_sink_get_latency(dest
);
898 /* The already resampled data should go to the old sink */
900 if (old_latency
>= new_latency
) {
902 /* The latency of the old sink is larger than the latency
903 * of the new sink. Therefore to compensate for the
904 * difference we to play silence on the new one for a
907 silence_usec
= old_latency
- new_latency
;
911 /* The latency of new sink is larger than the latency of
912 * the old sink. Therefore we have to precompute a little
913 * and make sure that this is still played on the old
914 * sink, until we can play the first sample on the new
917 info
.buffer_bytes
= pa_usec_to_bytes(new_latency
- old_latency
, &origin
->sample_spec
);
920 /* Okey, let's move it */
922 if (info
.buffer_bytes
> 0) {
925 p
= pa_proplist_new();
926 pa_proplist_sets(p
, PA_PROP_MEDIA_NAME
, "Ghost For Moved Stream");
927 pa_proplist_sets(p
, PA_PROP_MEDIA_ROLE
, "routing");
929 info
.ghost_sink_input
= pa_memblockq_sink_input_new(
931 &origin
->sample_spec
,
932 &origin
->channel_map
,
939 if (info
.ghost_sink_input
) {
940 info
.ghost_sink_input
->thread_info
.state
= info
.ghost_sink_input
->state
= PA_SINK_INPUT_RUNNING
;
941 info
.ghost_sink_input
->thread_info
.volume
= info
.ghost_sink_input
->volume
;
942 info
.ghost_sink_input
->thread_info
.muted
= info
.ghost_sink_input
->muted
;
944 info
.buffer
= pa_memblockq_new(0, MOVE_BUFFER_LENGTH
, 0, pa_frame_size(&origin
->sample_spec
), 0, 0, 0, NULL
);
949 pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER
, &info
, 0, NULL
);
951 if (info
.ghost_sink_input
) {
952 /* Basically, do what pa_sink_input_put() does ...*/
954 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_NEW
, info
.ghost_sink_input
->index
);
955 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_PUT
], info
.ghost_sink_input
);
956 pa_sink_input_unref(info
.ghost_sink_input
);
959 pa_idxset_remove_by_data(origin
->inputs
, i
, NULL
);
960 pa_idxset_put(dest
->inputs
, i
, NULL
);
963 if (pa_sink_input_get_state(i
) == PA_SINK_INPUT_CORKED
) {
964 pa_assert_se(origin
->n_corked
-- >= 1);
968 /* Replace resampler */
969 if (new_resampler
!= i
->thread_info
.resampler
) {
972 if (i
->thread_info
.resampler
)
973 pa_resampler_free(i
->thread_info
.resampler
);
974 i
->thread_info
.resampler
= new_resampler
;
976 /* if the resampler changed, the silence memblock is
977 * probably invalid now, too */
979 pa_silence_memchunk_get(
980 &i
->sink
->core
->silence_cache
,
981 i
->sink
->core
->mempool
,
986 pa_memblockq_set_silence(i
->thread_info
.render_memblockq
, &silence
);
987 pa_memblock_unref(silence
.memblock
);
991 pa_memblockq_flush(i
->thread_info
.render_memblockq
);
993 /* Calculate the new sleeping time */
995 pa_memblockq_seek(i
->thread_info
.render_memblockq
, pa_usec_to_bytes(silence_usec
, &dest
->sample_spec
), PA_SEEK_RELATIVE
);
997 pa_asyncmsgq_send(i
->sink
->asyncmsgq
, PA_MSGOBJECT(i
->sink
), PA_SINK_MESSAGE_ADD_INPUT
, i
, 0, NULL
);
999 pa_sink_update_status(origin
);
1000 pa_sink_update_status(dest
);
1005 pa_hook_fire(&i
->sink
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_MOVE_POST
], i
);
1007 pa_log_debug("Successfully moved sink input %i from %s to %s.", i
->index
, origin
->name
, dest
->name
);
1009 /* Notify everyone */
1010 pa_subscription_post(i
->sink
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, i
->index
);
1015 void pa_sink_input_set_state_within_thread(pa_sink_input
*i
, pa_sink_input_state_t state
) {
1016 pa_sink_input_assert_ref(i
);
1018 if ((state
== PA_SINK_INPUT_DRAINED
|| state
== PA_SINK_INPUT_RUNNING
) &&
1019 !(i
->thread_info
.state
== PA_SINK_INPUT_DRAINED
|| i
->thread_info
.state
!= PA_SINK_INPUT_RUNNING
))
1020 pa_atomic_store(&i
->thread_info
.drained
, 1);
1022 if (state
== PA_SINK_INPUT_CORKED
&& i
->thread_info
.state
!= PA_SINK_INPUT_CORKED
) {
1024 /* This will tell the implementing sink input driver to rewind
1025 * so that the unplayed already mixed data is not lost */
1026 pa_sink_input_request_rewind(i
, 0, TRUE
, TRUE
);
1028 } else if (i
->thread_info
.state
== PA_SINK_INPUT_CORKED
&& state
!= PA_SINK_INPUT_CORKED
) {
1030 /* OK, we're being uncorked. Make sure we're not rewound when
1031 * the hw buffer is remixed and request a remix. */
1032 pa_sink_input_request_rewind(i
, 0, FALSE
, TRUE
);
1035 if (i
->state_change
)
1036 i
->state_change(i
, state
);
1038 i
->thread_info
.state
= state
;
1041 /* Called from thread context */
1042 int pa_sink_input_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
) {
1043 pa_sink_input
*i
= PA_SINK_INPUT(o
);
1045 pa_sink_input_assert_ref(i
);
1046 pa_assert(PA_SINK_INPUT_IS_LINKED(i
->thread_info
.state
));
1049 case PA_SINK_INPUT_MESSAGE_SET_VOLUME
:
1050 i
->thread_info
.volume
= *((pa_cvolume
*) userdata
);
1051 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
);
1054 case PA_SINK_INPUT_MESSAGE_SET_MUTE
:
1055 i
->thread_info
.muted
= PA_PTR_TO_UINT(userdata
);
1056 pa_sink_input_request_rewind(i
, 0, TRUE
, FALSE
);
1059 case PA_SINK_INPUT_MESSAGE_GET_LATENCY
: {
1060 pa_usec_t
*r
= userdata
;
1062 *r
+= pa_bytes_to_usec(pa_memblockq_get_length(i
->thread_info
.render_memblockq
), &i
->sink
->sample_spec
);
1067 case PA_SINK_INPUT_MESSAGE_SET_RATE
:
1069 i
->thread_info
.sample_spec
.rate
= PA_PTR_TO_UINT(userdata
);
1070 pa_resampler_set_input_rate(i
->thread_info
.resampler
, PA_PTR_TO_UINT(userdata
));
1074 case PA_SINK_INPUT_MESSAGE_SET_STATE
: {
1075 pa_sink_input
*ssync
;
1077 pa_sink_input_set_state_within_thread(i
, PA_PTR_TO_UINT(userdata
));
1079 for (ssync
= i
->thread_info
.sync_prev
; ssync
; ssync
= ssync
->thread_info
.sync_prev
)
1080 pa_sink_input_set_state_within_thread(ssync
, PA_PTR_TO_UINT(userdata
));
1082 for (ssync
= i
->thread_info
.sync_next
; ssync
; ssync
= ssync
->thread_info
.sync_next
)
1083 pa_sink_input_set_state_within_thread(ssync
, PA_PTR_TO_UINT(userdata
));
1088 case PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
:
1090 pa_sink_input_set_requested_latency_within_thread(i
, (pa_usec_t
) offset
);
1097 pa_sink_input_state_t
pa_sink_input_get_state(pa_sink_input
*i
) {
1098 pa_sink_input_assert_ref(i
);
1100 if (i
->state
== PA_SINK_INPUT_RUNNING
|| i
->state
== PA_SINK_INPUT_DRAINED
)
1101 return pa_atomic_load(&i
->thread_info
.drained
) ? PA_SINK_INPUT_DRAINED
: PA_SINK_INPUT_RUNNING
;
1106 pa_bool_t
pa_sink_input_safe_to_remove(pa_sink_input
*i
) {
1107 pa_sink_input_assert_ref(i
);
1109 if (i
->state
== PA_SINK_INPUT_RUNNING
|| i
->state
== PA_SINK_INPUT_DRAINED
|| i
->state
== PA_SINK_INPUT_CORKED
)
1110 return pa_atomic_load(&i
->thread_info
.render_memblockq_is_empty
);
1115 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
) {
1118 /* If 'rewrite' is TRUE the sink is rewound as far as requested
1119 * and possible and the exact value of this is passed back the
1120 * implementor via process_rewind(). If 'flush' is also TRUE all
1121 * already rendered data is also dropped.
1123 * If 'rewrite' is FALSE the sink is rewound as far as requested
1124 * and possible and the already rendered data is dropped so that
1125 * in the next iteration we read new data from the
1126 * implementor. This implies 'flush' is TRUE. */
1128 pa_sink_input_assert_ref(i
);
1129 pa_assert(i
->thread_info
.rewrite_nbytes
== 0);
1131 /* We don't take rewind requests while we are corked */
1132 if (i
->state
== PA_SINK_INPUT_CORKED
)
1135 pa_assert(rewrite
|| flush
);
1137 /* Calculate how much we can rewind locally without having to
1140 lbq
= pa_memblockq_get_length(i
->thread_info
.render_memblockq
);
1144 /* Check if rewinding for the maximum is requested, and if so, fix up */
1147 /* Calculate maximum number of bytes that could be rewound in theory */
1148 nbytes
= i
->sink
->thread_info
.max_rewind
+ lbq
;
1150 /* Transform from sink domain */
1151 if (i
->thread_info
.resampler
)
1152 nbytes
= pa_resampler_request(i
->thread_info
.resampler
, nbytes
);
1156 /* Make sure to not overwrite over underruns */
1157 if (nbytes
> i
->thread_info
.playing_for
)
1158 nbytes
= (size_t) i
->thread_info
.playing_for
;
1160 i
->thread_info
.rewrite_nbytes
= nbytes
;
1162 i
->thread_info
.rewrite_nbytes
= (size_t) -1;
1164 i
->thread_info
.rewrite_flush
= flush
&& i
->thread_info
.rewrite_nbytes
!= 0;
1166 /* Transform to sink domain */
1167 if (i
->thread_info
.resampler
)
1168 nbytes
= pa_resampler_result(i
->thread_info
.resampler
, nbytes
);
1171 pa_sink_request_rewind(i
->sink
, nbytes
- lbq
);
1174 pa_memchunk
* pa_sink_input_get_silence(pa_sink_input
*i
, pa_memchunk
*ret
) {
1175 pa_sink_input_assert_ref(i
);
1178 pa_silence_memchunk_get(
1179 &i
->sink
->core
->silence_cache
,
1180 i
->sink
->core
->mempool
,
1183 i
->thread_info
.resampler
? pa_resampler_max_block_size(i
->thread_info
.resampler
) : 0);