2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
31 #include <pulse/utf8.h>
32 #include <pulse/xmalloc.h>
34 #include <pulsecore/sample-util.h>
35 #include <pulsecore/core-subscribe.h>
36 #include <pulsecore/log.h>
37 #include <pulsecore/play-memblockq.h>
38 #include <pulsecore/namereg.h>
39 #include <pulsecore/core-util.h>
41 #include "sink-input.h"
43 #define MEMBLOCKQ_MAXLENGTH (32*1024*1024)
44 #define CONVERT_BUFFER_LENGTH (PA_PAGE_SIZE)
46 static PA_DEFINE_CHECK_TYPE(pa_sink_input, pa_msgobject);
48 static void sink_input_free(pa_object *o);
50 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data) {
53 memset(data, 0, sizeof(*data));
54 data->resample_method = PA_RESAMPLER_INVALID;
55 data->proplist = pa_proplist_new();
60 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec) {
63 if ((data->sample_spec_is_set = !!spec))
64 data->sample_spec = *spec;
67 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map) {
70 if ((data->channel_map_is_set = !!map))
71 data->channel_map = *map;
74 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume) {
77 if ((data->volume_is_set = !!volume))
78 data->volume = data->virtual_volume = *volume;
81 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, pa_bool_t mute) {
84 data->muted_is_set = TRUE;
88 void pa_sink_input_new_data_done(pa_sink_input_new_data *data) {
91 pa_proplist_free(data->proplist);
94 /* Called from main context */
95 static void reset_callbacks(pa_sink_input *i) {
99 i->process_rewind = NULL;
100 i->update_max_rewind = NULL;
101 i->update_max_request = NULL;
102 i->update_sink_requested_latency = NULL;
103 i->update_sink_latency_range = NULL;
109 i->get_latency = NULL;
110 i->state_change = NULL;
111 i->may_move_to = NULL;
114 /* Called from main context */
115 pa_sink_input* pa_sink_input_new(
117 pa_sink_input_new_data *data,
118 pa_sink_input_flags_t flags) {
121 pa_resampler *resampler = NULL;
122 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
123 pa_channel_map original_cm;
128 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_NEW], data) < 0)
131 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
134 data->sink = pa_namereg_get(core, NULL, PA_NAMEREG_SINK, TRUE);
136 pa_return_null_if_fail(data->sink);
137 pa_return_null_if_fail(pa_sink_get_state(data->sink) != PA_SINK_UNLINKED);
138 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));
140 if (!data->sample_spec_is_set)
141 data->sample_spec = data->sink->sample_spec;
143 pa_return_null_if_fail(pa_sample_spec_valid(&data->sample_spec));
145 if (!data->channel_map_is_set) {
146 if (pa_channel_map_compatible(&data->sink->channel_map, &data->sample_spec))
147 data->channel_map = data->sink->channel_map;
149 pa_channel_map_init_extend(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT);
152 pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
153 pa_return_null_if_fail(pa_channel_map_compatible(&data->channel_map, &data->sample_spec));
155 if (!data->volume_is_set) {
156 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
157 pa_cvolume_reset(&data->virtual_volume, data->sample_spec.channels);
160 pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
161 pa_return_null_if_fail(pa_cvolume_compatible(&data->volume, &data->sample_spec));
163 pa_return_null_if_fail(pa_cvolume_valid(&data->virtual_volume));
164 pa_return_null_if_fail(pa_cvolume_compatible(&data->virtual_volume, &data->sample_spec));
166 if (!data->muted_is_set)
169 if (flags & PA_SINK_INPUT_FIX_FORMAT)
170 data->sample_spec.format = data->sink->sample_spec.format;
172 if (flags & PA_SINK_INPUT_FIX_RATE)
173 data->sample_spec.rate = data->sink->sample_spec.rate;
175 original_cm = data->channel_map;
177 if (flags & PA_SINK_INPUT_FIX_CHANNELS) {
178 data->sample_spec.channels = data->sink->sample_spec.channels;
179 data->channel_map = data->sink->channel_map;
182 pa_assert(pa_sample_spec_valid(&data->sample_spec));
183 pa_assert(pa_channel_map_valid(&data->channel_map));
185 /* Due to the fixing of the sample spec the volume might not match anymore */
186 pa_cvolume_remap(&data->volume, &original_cm, &data->channel_map);
188 if (data->resample_method == PA_RESAMPLER_INVALID)
189 data->resample_method = core->resample_method;
191 pa_return_null_if_fail(data->resample_method < PA_RESAMPLER_MAX);
193 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_FIXATE], data) < 0)
196 if (pa_idxset_size(data->sink->inputs) >= PA_MAX_INPUTS_PER_SINK) {
197 pa_log_warn("Failed to create sink input: too many inputs per sink.");
201 if ((flags & PA_SINK_INPUT_VARIABLE_RATE) ||
202 !pa_sample_spec_equal(&data->sample_spec, &data->sink->sample_spec) ||
203 !pa_channel_map_equal(&data->channel_map, &data->sink->channel_map)) {
205 if (!(resampler = pa_resampler_new(
207 &data->sample_spec, &data->channel_map,
208 &data->sink->sample_spec, &data->sink->channel_map,
209 data->resample_method,
210 ((flags & PA_SINK_INPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
211 ((flags & PA_SINK_INPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
212 (core->disable_remixing || (flags & PA_SINK_INPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0) |
213 (core->disable_lfe_remixing ? PA_RESAMPLER_NO_LFE : 0)))) {
214 pa_log_warn("Unsupported resampling operation.");
218 data->resample_method = pa_resampler_get_method(resampler);
221 i = pa_msgobject_new(pa_sink_input);
222 i->parent.parent.free = sink_input_free;
223 i->parent.process_msg = pa_sink_input_process_msg;
226 i->state = PA_SINK_INPUT_INIT;
228 i->proplist = pa_proplist_copy(data->proplist);
229 i->driver = pa_xstrdup(data->driver);
230 i->module = data->module;
231 i->sink = data->sink;
232 i->client = data->client;
234 i->resample_method = data->resample_method;
235 i->sample_spec = data->sample_spec;
236 i->channel_map = data->channel_map;
238 i->virtual_volume = data->virtual_volume;
239 i->volume = data->volume;
241 i->muted = data->muted;
243 if (data->sync_base) {
244 i->sync_next = data->sync_base->sync_next;
245 i->sync_prev = data->sync_base;
247 if (data->sync_base->sync_next)
248 data->sync_base->sync_next->sync_prev = i;
249 data->sync_base->sync_next = i;
251 i->sync_next = i->sync_prev = NULL;
253 i->direct_outputs = pa_idxset_new(NULL, NULL);
258 i->thread_info.state = i->state;
259 i->thread_info.attached = FALSE;
260 pa_atomic_store(&i->thread_info.drained, 1);
261 i->thread_info.sample_spec = i->sample_spec;
262 i->thread_info.resampler = resampler;
263 i->thread_info.volume = i->volume;
264 i->thread_info.muted = i->muted;
265 i->thread_info.requested_sink_latency = (pa_usec_t) -1;
266 i->thread_info.rewrite_nbytes = 0;
267 i->thread_info.rewrite_flush = FALSE;
268 i->thread_info.underrun_for = (uint64_t) -1;
269 i->thread_info.playing_for = 0;
270 i->thread_info.direct_outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
272 i->thread_info.render_memblockq = pa_memblockq_new(
276 pa_frame_size(&i->sink->sample_spec),
282 pa_assert_se(pa_idxset_put(core->sink_inputs, pa_sink_input_ref(i), &i->index) == 0);
283 pa_assert_se(pa_idxset_put(i->sink->inputs, i, NULL) == 0);
285 pa_log_info("Created input %u \"%s\" on %s with sample spec %s and channel map %s",
287 pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)),
289 pa_sample_spec_snprint(st, sizeof(st), &i->sample_spec),
290 pa_channel_map_snprint(cm, sizeof(cm), &i->channel_map));
292 /* Don't forget to call pa_sink_input_put! */
297 /* Called from main context */
298 static void update_n_corked(pa_sink_input *i, pa_sink_input_state_t state) {
301 if (i->state == PA_SINK_INPUT_CORKED && state != PA_SINK_INPUT_CORKED)
302 pa_assert_se(i->sink->n_corked -- >= 1);
303 else if (i->state != PA_SINK_INPUT_CORKED && state == PA_SINK_INPUT_CORKED)
307 /* Called from main context */
308 static int sink_input_set_state(pa_sink_input *i, pa_sink_input_state_t state) {
309 pa_sink_input *ssync;
312 if (state == PA_SINK_INPUT_DRAINED)
313 state = PA_SINK_INPUT_RUNNING;
315 if (i->state == state)
318 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);
320 update_n_corked(i, state);
323 for (ssync = i->sync_prev; ssync; ssync = ssync->sync_prev) {
324 update_n_corked(ssync, state);
325 ssync->state = state;
327 for (ssync = i->sync_next; ssync; ssync = ssync->sync_next) {
328 update_n_corked(ssync, state);
329 ssync->state = state;
332 if (state != PA_SINK_INPUT_UNLINKED) {
333 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], i);
335 for (ssync = i->sync_prev; ssync; ssync = ssync->sync_prev)
336 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], ssync);
338 for (ssync = i->sync_next; ssync; ssync = ssync->sync_next)
339 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], ssync);
342 pa_sink_update_status(i->sink);
347 /* Called from main context */
348 void pa_sink_input_unlink(pa_sink_input *i) {
350 pa_source_output *o, *p = NULL;
353 /* See pa_sink_unlink() for a couple of comments how this function
356 pa_sink_input_ref(i);
358 linked = PA_SINK_INPUT_IS_LINKED(i->state);
361 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK], i);
364 i->sync_prev->sync_next = i->sync_next;
366 i->sync_next->sync_prev = i->sync_prev;
368 i->sync_prev = i->sync_next = NULL;
370 pa_idxset_remove_by_data(i->sink->core->sink_inputs, i, NULL);
371 if (pa_idxset_remove_by_data(i->sink->inputs, i, NULL))
372 pa_sink_input_unref(i);
374 while ((o = pa_idxset_first(i->direct_outputs, NULL))) {
376 pa_source_output_kill(o);
380 update_n_corked(i, PA_SINK_INPUT_UNLINKED);
381 i->state = PA_SINK_INPUT_UNLINKED;
384 if (i->sink->asyncmsgq)
385 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_REMOVE_INPUT, i, 0, NULL) == 0);
390 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_REMOVE, i->index);
391 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST], i);
394 pa_sink_update_status(i->sink);
397 pa_sink_input_unref(i);
400 /* Called from main context */
401 static void sink_input_free(pa_object *o) {
402 pa_sink_input* i = PA_SINK_INPUT(o);
405 pa_assert(pa_sink_input_refcnt(i) == 0);
407 if (PA_SINK_INPUT_IS_LINKED(i->state))
408 pa_sink_input_unlink(i);
410 pa_log_info("Freeing input %u \"%s\"", i->index, pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)));
412 pa_assert(!i->thread_info.attached);
414 if (i->thread_info.render_memblockq)
415 pa_memblockq_free(i->thread_info.render_memblockq);
417 if (i->thread_info.resampler)
418 pa_resampler_free(i->thread_info.resampler);
421 pa_proplist_free(i->proplist);
423 if (i->direct_outputs)
424 pa_idxset_free(i->direct_outputs, NULL, NULL);
426 if (i->thread_info.direct_outputs)
427 pa_hashmap_free(i->thread_info.direct_outputs, NULL, NULL);
433 /* Called from main context */
434 void pa_sink_input_put(pa_sink_input *i) {
435 pa_sink_input_state_t state;
436 pa_sink_input_assert_ref(i);
438 pa_assert(i->state == PA_SINK_INPUT_INIT);
440 /* The following fields must be initialized properly */
442 pa_assert(i->process_rewind);
445 i->thread_info.volume = i->volume;
446 i->thread_info.muted = i->muted;
448 state = i->flags & PA_SINK_INPUT_START_CORKED ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING;
450 update_n_corked(i, state);
453 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_ADD_INPUT, i, 0, NULL) == 0);
455 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW, i->index);
456 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_PUT], i);
458 pa_sink_update_status(i->sink);
461 /* Called from main context */
462 void pa_sink_input_kill(pa_sink_input*i) {
463 pa_sink_input_assert_ref(i);
464 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
469 /* Called from main context */
470 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i, pa_usec_t *sink_latency) {
471 pa_usec_t r[2] = { 0, 0 };
473 pa_sink_input_assert_ref(i);
474 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
476 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_GET_LATENCY, r, 0, NULL) == 0);
479 r[0] += i->get_latency(i);
482 *sink_latency = r[1];
487 /* Called from thread context */
488 int pa_sink_input_peek(pa_sink_input *i, size_t slength /* in sink frames */, pa_memchunk *chunk, pa_cvolume *volume) {
489 pa_bool_t do_volume_adj_here;
490 pa_bool_t volume_is_norm;
491 size_t block_size_max_sink, block_size_max_sink_input;
494 pa_sink_input_assert_ref(i);
495 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
496 pa_assert(pa_frame_aligned(slength, &i->sink->sample_spec));
500 /* pa_log_debug("peek"); */
505 pa_assert(i->thread_info.state == PA_SINK_INPUT_RUNNING ||
506 i->thread_info.state == PA_SINK_INPUT_CORKED ||
507 i->thread_info.state == PA_SINK_INPUT_DRAINED);
509 block_size_max_sink_input = i->thread_info.resampler ?
510 pa_resampler_max_block_size(i->thread_info.resampler) :
511 pa_frame_align(pa_mempool_block_size_max(i->sink->core->mempool), &i->sample_spec);
513 block_size_max_sink = pa_frame_align(pa_mempool_block_size_max(i->sink->core->mempool), &i->sink->sample_spec);
515 /* Default buffer size */
517 slength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sink->sample_spec);
519 if (slength > block_size_max_sink)
520 slength = block_size_max_sink;
522 if (i->thread_info.resampler) {
523 ilength = pa_resampler_request(i->thread_info.resampler, slength);
526 ilength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sample_spec);
530 if (ilength > block_size_max_sink_input)
531 ilength = block_size_max_sink_input;
533 /* If the channel maps of the sink and this stream differ, we need
534 * to adjust the volume *before* we resample. Otherwise we can do
535 * it after and leave it for the sink code */
537 do_volume_adj_here = !pa_channel_map_equal(&i->channel_map, &i->sink->channel_map);
538 volume_is_norm = pa_cvolume_is_norm(&i->thread_info.volume) && !i->thread_info.muted;
540 while (!pa_memblockq_is_readable(i->thread_info.render_memblockq)) {
543 /* There's nothing in our render queue. We need to fill it up
544 * with data from the implementor. */
546 if (i->thread_info.state == PA_SINK_INPUT_CORKED ||
547 i->pop(i, ilength, &tchunk) < 0) {
549 /* OK, we're corked or the implementor didn't give us any
550 * data, so let's just hand out silence */
551 pa_atomic_store(&i->thread_info.drained, 1);
553 pa_memblockq_seek(i->thread_info.render_memblockq, (int64_t) slength, PA_SEEK_RELATIVE);
554 i->thread_info.playing_for = 0;
555 if (i->thread_info.underrun_for != (uint64_t) -1)
556 i->thread_info.underrun_for += ilength;
560 pa_atomic_store(&i->thread_info.drained, 0);
562 pa_assert(tchunk.length > 0);
563 pa_assert(tchunk.memblock);
565 i->thread_info.underrun_for = 0;
566 i->thread_info.playing_for += tchunk.length;
568 while (tchunk.length > 0) {
572 pa_memblock_ref(wchunk.memblock);
574 if (wchunk.length > block_size_max_sink_input)
575 wchunk.length = block_size_max_sink_input;
577 /* It might be necessary to adjust the volume here */
578 if (do_volume_adj_here && !volume_is_norm) {
579 pa_memchunk_make_writable(&wchunk, 0);
581 if (i->thread_info.muted)
582 pa_silence_memchunk(&wchunk, &i->thread_info.sample_spec);
584 pa_volume_memchunk(&wchunk, &i->thread_info.sample_spec, &i->thread_info.volume);
587 if (!i->thread_info.resampler)
588 pa_memblockq_push_align(i->thread_info.render_memblockq, &wchunk);
591 pa_resampler_run(i->thread_info.resampler, &wchunk, &rchunk);
593 /* pa_log_debug("pushing %lu", (unsigned long) rchunk.length); */
595 if (rchunk.memblock) {
596 pa_memblockq_push_align(i->thread_info.render_memblockq, &rchunk);
597 pa_memblock_unref(rchunk.memblock);
601 pa_memblock_unref(wchunk.memblock);
603 tchunk.index += wchunk.length;
604 tchunk.length -= wchunk.length;
607 pa_memblock_unref(tchunk.memblock);
610 pa_assert_se(pa_memblockq_peek(i->thread_info.render_memblockq, chunk) >= 0);
612 pa_assert(chunk->length > 0);
613 pa_assert(chunk->memblock);
615 /* pa_log_debug("peeking %lu", (unsigned long) chunk->length); */
617 if (chunk->length > block_size_max_sink)
618 chunk->length = block_size_max_sink;
620 /* Let's see if we had to apply the volume adjustment ourselves,
621 * or if this can be done by the sink for us */
623 if (do_volume_adj_here)
624 /* We had different channel maps, so we already did the adjustment */
625 pa_cvolume_reset(volume, i->sink->sample_spec.channels);
626 else if (i->thread_info.muted)
627 /* We've both the same channel map, so let's have the sink do the adjustment for us*/
628 pa_cvolume_mute(volume, i->sink->sample_spec.channels);
630 *volume = i->thread_info.volume;
635 /* Called from thread context */
636 void pa_sink_input_drop(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));
641 pa_assert(nbytes > 0);
643 /* pa_log_debug("dropping %lu", (unsigned long) nbytes); */
645 pa_memblockq_drop(i->thread_info.render_memblockq, nbytes);
648 /* Called from thread context */
649 void pa_sink_input_process_rewind(pa_sink_input *i, size_t nbytes /* in sink sample spec */) {
651 pa_bool_t called = FALSE;
652 pa_sink_input_assert_ref(i);
654 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
655 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
657 /* pa_log_debug("rewind(%lu, %lu)", (unsigned long) nbytes, (unsigned long) i->thread_info.rewrite_nbytes); */
659 lbq = pa_memblockq_get_length(i->thread_info.render_memblockq);
662 pa_log_debug("Have to rewind %lu bytes on render memblockq.", (unsigned long) nbytes);
663 pa_memblockq_rewind(i->thread_info.render_memblockq, nbytes);
666 if (i->thread_info.rewrite_nbytes == (size_t) -1) {
668 /* We were asked to drop all buffered data, and rerequest new
669 * data from implementor the next time push() is called */
671 pa_memblockq_flush_write(i->thread_info.render_memblockq);
673 } else if (i->thread_info.rewrite_nbytes > 0) {
674 size_t max_rewrite, amount;
676 /* Calculate how much make sense to rewrite at most */
677 max_rewrite = nbytes + lbq;
679 /* Transform into local domain */
680 if (i->thread_info.resampler)
681 max_rewrite = pa_resampler_request(i->thread_info.resampler, max_rewrite);
683 /* Calculate how much of the rewinded data should actually be rewritten */
684 amount = PA_MIN(i->thread_info.rewrite_nbytes, max_rewrite);
687 pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) amount);
689 /* Tell the implementor */
690 if (i->process_rewind)
691 i->process_rewind(i, amount);
694 /* Convert back to to sink domain */
695 if (i->thread_info.resampler)
696 amount = pa_resampler_result(i->thread_info.resampler, amount);
699 /* Ok, now update the write pointer */
700 pa_memblockq_seek(i->thread_info.render_memblockq, - ((int64_t) amount), PA_SEEK_RELATIVE);
702 if (i->thread_info.rewrite_flush)
703 pa_memblockq_silence(i->thread_info.render_memblockq);
705 /* And reset the resampler */
706 if (i->thread_info.resampler)
707 pa_resampler_reset(i->thread_info.resampler);
712 if (i->process_rewind)
713 i->process_rewind(i, 0);
715 i->thread_info.rewrite_nbytes = 0;
716 i->thread_info.rewrite_flush = FALSE;
719 /* Called from thread context */
720 void pa_sink_input_update_max_rewind(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */) {
721 pa_sink_input_assert_ref(i);
722 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
723 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
725 pa_memblockq_set_maxrewind(i->thread_info.render_memblockq, nbytes);
727 if (i->update_max_rewind)
728 i->update_max_rewind(i, i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, nbytes) : nbytes);
731 /* Called from thread context */
732 void pa_sink_input_update_max_request(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */) {
733 pa_sink_input_assert_ref(i);
734 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
735 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
737 if (i->update_max_request)
738 i->update_max_request(i, i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, nbytes) : nbytes);
741 /* Called from thread context */
742 static pa_usec_t fixup_latency(pa_sink *s, pa_usec_t usec) {
743 pa_sink_assert_ref(s);
745 if (usec == (pa_usec_t) -1)
748 if (s->thread_info.max_latency > 0 && usec > s->thread_info.max_latency)
749 usec = s->thread_info.max_latency;
751 if (s->thread_info.min_latency > 0 && usec < s->thread_info.min_latency)
752 usec = s->thread_info.min_latency;
757 /* Called from thread context */
758 pa_usec_t pa_sink_input_set_requested_latency_within_thread(pa_sink_input *i, pa_usec_t usec) {
759 pa_sink_input_assert_ref(i);
761 usec = fixup_latency(i->sink, usec);
762 i->thread_info.requested_sink_latency = usec;
763 pa_sink_invalidate_requested_latency(i->sink);
768 /* Called from main context */
769 pa_usec_t pa_sink_input_set_requested_latency(pa_sink_input *i, pa_usec_t usec) {
770 pa_sink_input_assert_ref(i);
772 if (PA_SINK_INPUT_IS_LINKED(i->state))
773 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
775 /* If this sink input is not realized yet, we have to touch
776 * the thread info data directly */
778 i->thread_info.requested_sink_latency = usec;
783 /* Called from main context */
784 pa_usec_t pa_sink_input_get_requested_latency(pa_sink_input *i) {
787 pa_sink_input_assert_ref(i);
789 if (PA_SINK_INPUT_IS_LINKED(i->state))
790 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
792 /* If this sink input is not realized yet, we have to touch
793 * the thread info data directly */
794 usec = i->thread_info.requested_sink_latency;
799 /* Called from main context */
800 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume) {
801 pa_sink_input_set_volume_data data;
803 pa_sink_input_assert_ref(i);
804 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
806 pa_assert(pa_cvolume_valid(volume));
807 pa_assert(pa_cvolume_compatible(volume, &i->sample_spec));
810 data.virtual_volume = *volume;
811 data.volume = *volume;
813 /* If you change something here, consider looking into
814 * module-flat-volume.c as well since it uses very similar
817 if (pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_SET_VOLUME], &data) < 0)
820 if (!pa_cvolume_equal(&i->volume, &data.volume)) {
821 i->volume = data.volume;
822 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_VOLUME, &data.volume, 0, NULL) == 0);
825 if (!pa_cvolume_equal(&i->virtual_volume, &data.virtual_volume)) {
826 i->virtual_volume = data.virtual_volume;
827 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
831 /* Called from main context */
832 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i) {
833 pa_sink_input_assert_ref(i);
834 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
836 return &i->virtual_volume;
839 /* Called from main context */
840 void pa_sink_input_set_mute(pa_sink_input *i, pa_bool_t mute) {
842 pa_sink_input_assert_ref(i);
843 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
845 if (!i->muted == !mute)
850 pa_asyncmsgq_post(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_MUTE, PA_UINT_TO_PTR(mute), 0, NULL, NULL);
851 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
854 /* Called from main context */
855 pa_bool_t pa_sink_input_get_mute(pa_sink_input *i) {
856 pa_sink_input_assert_ref(i);
857 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
862 /* Called from main thread */
863 pa_bool_t pa_sink_input_update_proplist(pa_sink_input *i, pa_update_mode_t mode, pa_proplist *p) {
865 pa_sink_input_assert_ref(i);
867 pa_proplist_update(i->proplist, mode, p);
869 if (PA_SINK_IS_LINKED(i->state)) {
870 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], i);
871 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
877 /* Called from main context */
878 void pa_sink_input_cork(pa_sink_input *i, pa_bool_t b) {
879 pa_sink_input_assert_ref(i);
880 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
882 sink_input_set_state(i, b ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING);
885 /* Called from main context */
886 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate) {
887 pa_sink_input_assert_ref(i);
888 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
889 pa_return_val_if_fail(i->thread_info.resampler, -1);
891 if (i->sample_spec.rate == rate)
894 i->sample_spec.rate = rate;
896 pa_asyncmsgq_post(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
898 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
902 /* Called from main context */
903 void pa_sink_input_set_name(pa_sink_input *i, const char *name) {
905 pa_sink_input_assert_ref(i);
907 if (!name && !pa_proplist_contains(i->proplist, PA_PROP_MEDIA_NAME))
910 old = pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME);
912 if (old && name && !strcmp(old, name))
916 pa_proplist_sets(i->proplist, PA_PROP_MEDIA_NAME, name);
918 pa_proplist_unset(i->proplist, PA_PROP_MEDIA_NAME);
920 if (PA_SINK_INPUT_IS_LINKED(i->state)) {
921 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], i);
922 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
926 /* Called from main context */
927 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i) {
928 pa_sink_input_assert_ref(i);
930 return i->resample_method;
933 /* Called from main context */
934 pa_bool_t pa_sink_input_may_move_to(pa_sink_input *i, pa_sink *dest) {
935 pa_sink_input_assert_ref(i);
936 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
937 pa_sink_assert_ref(dest);
942 if (i->flags & PA_SINK_INPUT_DONT_MOVE)
945 if (i->sync_next || i->sync_prev) {
946 pa_log_warn("Moving synchronised streams not supported.");
950 if (pa_idxset_size(dest->inputs) >= PA_MAX_INPUTS_PER_SINK) {
951 pa_log_warn("Failed to move sink input: too many inputs per sink.");
956 if (!i->may_move_to(i, dest))
962 /* Called from main context */
963 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest) {
964 pa_resampler *new_resampler;
966 pa_sink_input_move_hook_data hook_data;
967 pa_source_output *o, *p = NULL;
969 pa_sink_input_assert_ref(i);
970 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
971 pa_sink_assert_ref(dest);
978 if (!pa_sink_input_may_move_to(i, dest))
981 /* Kill directly connected outputs */
982 while ((o = pa_idxset_first(i->direct_outputs, NULL))) {
984 pa_source_output_kill(o);
988 if (i->thread_info.resampler &&
989 pa_sample_spec_equal(&origin->sample_spec, &dest->sample_spec) &&
990 pa_channel_map_equal(&origin->channel_map, &dest->channel_map))
992 /* Try to reuse the old resampler if possible */
993 new_resampler = i->thread_info.resampler;
995 else if ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ||
996 !pa_sample_spec_equal(&i->sample_spec, &dest->sample_spec) ||
997 !pa_channel_map_equal(&i->channel_map, &dest->channel_map)) {
999 /* Okey, we need a new resampler for the new sink */
1001 if (!(new_resampler = pa_resampler_new(
1002 dest->core->mempool,
1003 &i->sample_spec, &i->channel_map,
1004 &dest->sample_spec, &dest->channel_map,
1006 ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
1007 ((i->flags & PA_SINK_INPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
1008 (i->core->disable_remixing || (i->flags & PA_SINK_INPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0)))) {
1009 pa_log_warn("Unsupported resampling operation.");
1013 new_resampler = NULL;
1015 hook_data.sink_input = i;
1016 hook_data.destination = dest;
1017 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE], &hook_data);
1019 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_START_MOVE, i, 0, NULL) == 0);
1021 pa_idxset_remove_by_data(origin->inputs, i, NULL);
1022 pa_idxset_put(dest->inputs, i, NULL);
1025 if (pa_sink_input_get_state(i) == PA_SINK_INPUT_CORKED) {
1026 pa_assert_se(origin->n_corked-- >= 1);
1030 /* Replace resampler and render queue */
1031 if (new_resampler != i->thread_info.resampler) {
1033 if (i->thread_info.resampler)
1034 pa_resampler_free(i->thread_info.resampler);
1035 i->thread_info.resampler = new_resampler;
1037 pa_memblockq_free(i->thread_info.render_memblockq);
1039 i->thread_info.render_memblockq = pa_memblockq_new(
1041 MEMBLOCKQ_MAXLENGTH,
1043 pa_frame_size(&i->sink->sample_spec),
1050 pa_sink_update_status(origin);
1051 pa_sink_update_status(dest);
1053 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_FINISH_MOVE, i, 0, NULL) == 0);
1058 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_POST], i);
1060 pa_log_debug("Successfully moved sink input %i from %s to %s.", i->index, origin->name, dest->name);
1062 /* Notify everyone */
1063 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
1068 /* Called from IO thread context */
1069 void pa_sink_input_set_state_within_thread(pa_sink_input *i, pa_sink_input_state_t state) {
1070 pa_bool_t corking, uncorking;
1071 pa_sink_input_assert_ref(i);
1073 if (state == i->thread_info.state)
1076 if ((state == PA_SINK_INPUT_DRAINED || state == PA_SINK_INPUT_RUNNING) &&
1077 !(i->thread_info.state == PA_SINK_INPUT_DRAINED || i->thread_info.state != PA_SINK_INPUT_RUNNING))
1078 pa_atomic_store(&i->thread_info.drained, 1);
1080 corking = state == PA_SINK_INPUT_CORKED && i->thread_info.state == PA_SINK_INPUT_RUNNING;
1081 uncorking = i->thread_info.state == PA_SINK_INPUT_CORKED && state == PA_SINK_INPUT_RUNNING;
1083 if (i->state_change)
1084 i->state_change(i, state);
1086 i->thread_info.state = state;
1090 pa_log_debug("Requesting rewind due to corking");
1092 /* This will tell the implementing sink input driver to rewind
1093 * so that the unplayed already mixed data is not lost */
1094 pa_sink_input_request_rewind(i, 0, TRUE, TRUE);
1096 } else if (uncorking) {
1098 i->thread_info.underrun_for = (uint64_t) -1;
1099 i->thread_info.playing_for = 0;
1101 pa_log_debug("Requesting rewind due to uncorking");
1103 /* OK, we're being uncorked. Make sure we're not rewound when
1104 * the hw buffer is remixed and request a remix. */
1105 pa_sink_input_request_rewind(i, 0, FALSE, TRUE);
1109 /* Called from thread context, except when it is not. */
1110 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
1111 pa_sink_input *i = PA_SINK_INPUT(o);
1112 pa_sink_input_assert_ref(i);
1116 case PA_SINK_INPUT_MESSAGE_SET_VOLUME:
1117 i->thread_info.volume = *((pa_cvolume*) userdata);
1118 pa_sink_input_request_rewind(i, 0, TRUE, FALSE);
1121 case PA_SINK_INPUT_MESSAGE_SET_MUTE:
1122 i->thread_info.muted = PA_PTR_TO_UINT(userdata);
1123 pa_sink_input_request_rewind(i, 0, TRUE, FALSE);
1126 case PA_SINK_INPUT_MESSAGE_GET_LATENCY: {
1127 pa_usec_t *r = userdata;
1128 pa_usec_t sink_usec = 0;
1130 r[0] += pa_bytes_to_usec(pa_memblockq_get_length(i->thread_info.render_memblockq), &i->sink->sample_spec);
1132 if (i->sink->parent.process_msg(PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_GET_LATENCY, &sink_usec, 0, NULL) >= 0)
1138 case PA_SINK_INPUT_MESSAGE_SET_RATE:
1140 i->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
1141 pa_resampler_set_input_rate(i->thread_info.resampler, PA_PTR_TO_UINT(userdata));
1145 case PA_SINK_INPUT_MESSAGE_SET_STATE: {
1146 pa_sink_input *ssync;
1148 pa_sink_input_set_state_within_thread(i, PA_PTR_TO_UINT(userdata));
1150 for (ssync = i->thread_info.sync_prev; ssync; ssync = ssync->thread_info.sync_prev)
1151 pa_sink_input_set_state_within_thread(ssync, PA_PTR_TO_UINT(userdata));
1153 for (ssync = i->thread_info.sync_next; ssync; ssync = ssync->thread_info.sync_next)
1154 pa_sink_input_set_state_within_thread(ssync, PA_PTR_TO_UINT(userdata));
1159 case PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY: {
1160 pa_usec_t *usec = userdata;
1162 *usec = pa_sink_input_set_requested_latency_within_thread(i, *usec);
1166 case PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY: {
1167 pa_usec_t *r = userdata;
1169 *r = i->thread_info.requested_sink_latency;
1177 /* Called from main thread */
1178 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i) {
1179 pa_sink_input_assert_ref(i);
1181 if (i->state == PA_SINK_INPUT_RUNNING || i->state == PA_SINK_INPUT_DRAINED)
1182 return pa_atomic_load(&i->thread_info.drained) ? PA_SINK_INPUT_DRAINED : PA_SINK_INPUT_RUNNING;
1187 /* Called from IO context */
1188 pa_bool_t pa_sink_input_safe_to_remove(pa_sink_input *i) {
1189 pa_sink_input_assert_ref(i);
1191 if (PA_SINK_INPUT_IS_LINKED(i->thread_info.state))
1192 return pa_memblockq_is_empty(i->thread_info.render_memblockq);
1197 /* Called from IO context */
1198 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) {
1201 /* If 'rewrite' is TRUE the sink is rewound as far as requested
1202 * and possible and the exact value of this is passed back the
1203 * implementor via process_rewind(). If 'flush' is also TRUE all
1204 * already rendered data is also dropped.
1206 * If 'rewrite' is FALSE the sink is rewound as far as requested
1207 * and possible and the already rendered data is dropped so that
1208 * in the next iteration we read new data from the
1209 * implementor. This implies 'flush' is TRUE. */
1211 pa_sink_input_assert_ref(i);
1213 nbytes = PA_MAX(i->thread_info.rewrite_nbytes, nbytes);
1215 /* pa_log_debug("request rewrite %lu", (unsigned long) nbytes); */
1217 /* We don't take rewind requests while we are corked */
1218 if (i->thread_info.state == PA_SINK_INPUT_CORKED)
1221 pa_assert(rewrite || flush);
1223 /* Calculate how much we can rewind locally without having to
1226 lbq = pa_memblockq_get_length(i->thread_info.render_memblockq);
1230 /* Check if rewinding for the maximum is requested, and if so, fix up */
1233 /* Calculate maximum number of bytes that could be rewound in theory */
1234 nbytes = i->sink->thread_info.max_rewind + lbq;
1236 /* Transform from sink domain */
1237 if (i->thread_info.resampler)
1238 nbytes = pa_resampler_request(i->thread_info.resampler, nbytes);
1241 if (i->thread_info.rewrite_nbytes != (size_t) -1) {
1243 /* Make sure to not overwrite over underruns */
1244 if (nbytes > i->thread_info.playing_for)
1245 nbytes = (size_t) i->thread_info.playing_for;
1247 i->thread_info.rewrite_nbytes = nbytes;
1249 i->thread_info.rewrite_nbytes = (size_t) -1;
1252 i->thread_info.rewrite_flush =
1253 i->thread_info.rewrite_flush ||
1254 (flush && i->thread_info.rewrite_nbytes != 0);
1256 if (nbytes != (size_t) -1) {
1258 /* Transform to sink domain */
1259 if (i->thread_info.resampler)
1260 nbytes = pa_resampler_result(i->thread_info.resampler, nbytes);
1263 pa_sink_request_rewind(i->sink, nbytes - lbq);
1265 /* This call will make sure process_rewind() is called later */
1266 pa_sink_request_rewind(i->sink, 0);
1270 /* Called from main context */
1271 pa_memchunk* pa_sink_input_get_silence(pa_sink_input *i, pa_memchunk *ret) {
1272 pa_sink_input_assert_ref(i);
1275 pa_silence_memchunk_get(
1276 &i->sink->core->silence_cache,
1277 i->sink->core->mempool,
1280 i->thread_info.resampler ? pa_resampler_max_block_size(i->thread_info.resampler) : 0);