]> code.delx.au - pulseaudio/blob - src/pulsecore/sink-input.c
merge glitch-free branch back into trunk
[pulseaudio] / src / pulsecore / sink-input.c
1 /* $Id$ */
2
3 /***
4 This file is part of PulseAudio.
5
6 Copyright 2004-2006 Lennart Poettering
7 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
8
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.
13
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.
18
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
22 USA.
23 ***/
24
25 #ifdef HAVE_CONFIG_H
26 #include <config.h>
27 #endif
28
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <string.h>
32
33 #include <pulse/utf8.h>
34 #include <pulse/xmalloc.h>
35
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>
42
43 #include "sink-input.h"
44
45 #define MEMBLOCKQ_MAXLENGTH (32*1024*1024)
46 #define CONVERT_BUFFER_LENGTH (PA_PAGE_SIZE)
47 #define MOVE_BUFFER_LENGTH (PA_PAGE_SIZE*256)
48
49 static PA_DEFINE_CHECK_TYPE(pa_sink_input, pa_msgobject);
50
51 static void sink_input_free(pa_object *o);
52
53 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data) {
54 pa_assert(data);
55
56 memset(data, 0, sizeof(*data));
57 data->resample_method = PA_RESAMPLER_INVALID;
58 data->proplist = pa_proplist_new();
59
60 return data;
61 }
62
63 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec) {
64 pa_assert(data);
65
66 if ((data->sample_spec_is_set = !!spec))
67 data->sample_spec = *spec;
68 }
69
70 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map) {
71 pa_assert(data);
72
73 if ((data->channel_map_is_set = !!map))
74 data->channel_map = *map;
75 }
76
77 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume) {
78 pa_assert(data);
79
80 if ((data->volume_is_set = !!volume))
81 data->volume = *volume;
82 }
83
84 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, pa_bool_t mute) {
85 pa_assert(data);
86
87 data->muted_is_set = TRUE;
88 data->muted = !!mute;
89 }
90
91 void pa_sink_input_new_data_done(pa_sink_input_new_data *data) {
92 pa_assert(data);
93
94 pa_proplist_free(data->proplist);
95 }
96
97 static void reset_callbacks(pa_sink_input *i) {
98 pa_assert(i);
99
100 i->pop = NULL;
101 i->process_rewind = NULL;
102 i->update_max_rewind = NULL;
103 i->attach = NULL;
104 i->detach = NULL;
105 i->suspend = NULL;
106 i->moved = NULL;
107 i->kill = NULL;
108 i->get_latency = NULL;
109 i->state_change = NULL;
110 }
111
112 pa_sink_input* pa_sink_input_new(
113 pa_core *core,
114 pa_sink_input_new_data *data,
115 pa_sink_input_flags_t flags) {
116
117 pa_sink_input *i;
118 pa_resampler *resampler = NULL;
119 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
120
121 pa_assert(core);
122 pa_assert(data);
123
124 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_NEW], data) < 0)
125 return NULL;
126
127 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
128
129 if (!data->sink)
130 data->sink = pa_namereg_get(core, NULL, PA_NAMEREG_SINK, 1);
131
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));
135
136 if (!data->sample_spec_is_set)
137 data->sample_spec = data->sink->sample_spec;
138
139 pa_return_null_if_fail(pa_sample_spec_valid(&data->sample_spec));
140
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;
144 else
145 pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
146 }
147
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);
150
151 if (!data->volume_is_set)
152 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
153
154 pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
155 pa_return_null_if_fail(data->volume.channels == data->sample_spec.channels);
156
157 if (!data->muted_is_set)
158 data->muted = FALSE;
159
160 if (flags & PA_SINK_INPUT_FIX_FORMAT)
161 data->sample_spec.format = data->sink->sample_spec.format;
162
163 if (flags & PA_SINK_INPUT_FIX_RATE)
164 data->sample_spec.rate = data->sink->sample_spec.rate;
165
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;
169 }
170
171 pa_assert(pa_sample_spec_valid(&data->sample_spec));
172 pa_assert(pa_channel_map_valid(&data->channel_map));
173
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));
177
178 if (data->resample_method == PA_RESAMPLER_INVALID)
179 data->resample_method = core->resample_method;
180
181 pa_return_null_if_fail(data->resample_method < PA_RESAMPLER_MAX);
182
183 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_FIXATE], data) < 0)
184 return NULL;
185
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.");
188 return NULL;
189 }
190
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)) {
194
195 if (!(resampler = pa_resampler_new(
196 core->mempool,
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.");
204 return NULL;
205 }
206
207 data->resample_method = pa_resampler_get_method(resampler);
208 }
209
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;
213
214 i->core = core;
215 i->state = PA_SINK_INPUT_INIT;
216 i->flags = flags;
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;
222
223 i->resample_method = data->resample_method;
224 i->sample_spec = data->sample_spec;
225 i->channel_map = data->channel_map;
226
227 i->volume = data->volume;
228 i->muted = data->muted;
229
230 if (data->sync_base) {
231 i->sync_next = data->sync_base->sync_next;
232 i->sync_prev = data->sync_base;
233
234 if (data->sync_base->sync_next)
235 data->sync_base->sync_next->sync_prev = i;
236 data->sync_base->sync_next = i;
237 } else
238 i->sync_next = i->sync_prev = NULL;
239
240 reset_callbacks(i);
241 i->userdata = NULL;
242
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
256 i->thread_info.render_memblockq = pa_memblockq_new(
257 0,
258 MEMBLOCKQ_MAXLENGTH,
259 0,
260 pa_frame_size(&i->sink->sample_spec),
261 0,
262 1,
263 0,
264 &i->sink->silence);
265
266 pa_assert_se(pa_idxset_put(core->sink_inputs, pa_sink_input_ref(i), &i->index) == 0);
267 pa_assert_se(pa_idxset_put(i->sink->inputs, i, NULL) == 0);
268
269 pa_log_info("Created input %u \"%s\" on %s with sample spec %s and channel map %s",
270 i->index,
271 pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)),
272 i->sink->name,
273 pa_sample_spec_snprint(st, sizeof(st), &i->sample_spec),
274 pa_channel_map_snprint(cm, sizeof(cm), &i->channel_map));
275
276 /* Don't forget to call pa_sink_input_put! */
277
278 return i;
279 }
280
281 static void update_n_corked(pa_sink_input *i, pa_sink_input_state_t state) {
282 pa_assert(i);
283
284 if (i->state == PA_SINK_INPUT_CORKED && state != PA_SINK_INPUT_CORKED)
285 pa_assert_se(i->sink->n_corked -- >= 1);
286 else if (i->state != PA_SINK_INPUT_CORKED && state == PA_SINK_INPUT_CORKED)
287 i->sink->n_corked++;
288
289 pa_sink_update_status(i->sink);
290 }
291
292 static int sink_input_set_state(pa_sink_input *i, pa_sink_input_state_t state) {
293 pa_sink_input *ssync;
294 pa_assert(i);
295
296 if (state == PA_SINK_INPUT_DRAINED)
297 state = PA_SINK_INPUT_RUNNING;
298
299 if (i->state == state)
300 return 0;
301
302 if (pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
303 return -1;
304
305 update_n_corked(i, state);
306 i->state = state;
307
308 for (ssync = i->sync_prev; ssync; ssync = ssync->sync_prev) {
309 update_n_corked(ssync, state);
310 ssync->state = state;
311 }
312 for (ssync = i->sync_next; ssync; ssync = ssync->sync_next) {
313 update_n_corked(ssync, state);
314 ssync->state = state;
315 }
316
317 if (state != PA_SINK_INPUT_UNLINKED)
318 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], i);
319
320 return 0;
321 }
322
323 void pa_sink_input_unlink(pa_sink_input *i) {
324 pa_bool_t linked;
325 pa_assert(i);
326
327 /* See pa_sink_unlink() for a couple of comments how this function
328 * works */
329
330 pa_sink_input_ref(i);
331
332 linked = PA_SINK_INPUT_IS_LINKED(i->state);
333
334 if (linked)
335 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK], i);
336
337 if (i->sync_prev)
338 i->sync_prev->sync_next = i->sync_next;
339 if (i->sync_next)
340 i->sync_next->sync_prev = i->sync_prev;
341
342 i->sync_prev = i->sync_next = NULL;
343
344 pa_idxset_remove_by_data(i->sink->core->sink_inputs, i, NULL);
345 if (pa_idxset_remove_by_data(i->sink->inputs, i, NULL))
346 pa_sink_input_unref(i);
347
348 update_n_corked(i, PA_SINK_INPUT_UNLINKED);
349 i->state = PA_SINK_INPUT_UNLINKED;
350
351 if (linked)
352 if (i->sink->asyncmsgq)
353 pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_REMOVE_INPUT, i, 0, NULL);
354
355 reset_callbacks(i);
356
357 if (linked) {
358 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_REMOVE, i->index);
359 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST], i);
360 }
361
362 i->sink = NULL;
363 pa_sink_input_unref(i);
364 }
365
366 static void sink_input_free(pa_object *o) {
367 pa_sink_input* i = PA_SINK_INPUT(o);
368
369 pa_assert(i);
370 pa_assert(pa_sink_input_refcnt(i) == 0);
371
372 if (PA_SINK_INPUT_IS_LINKED(i->state))
373 pa_sink_input_unlink(i);
374
375 pa_log_info("Freeing input %u \"%s\"", i->index, pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)));
376
377 pa_assert(!i->thread_info.attached);
378
379 if (i->thread_info.render_memblockq)
380 pa_memblockq_free(i->thread_info.render_memblockq);
381
382 if (i->thread_info.resampler)
383 pa_resampler_free(i->thread_info.resampler);
384
385 if (i->proplist)
386 pa_proplist_free(i->proplist);
387
388 pa_xfree(i->driver);
389 pa_xfree(i);
390 }
391
392 void pa_sink_input_put(pa_sink_input *i) {
393 pa_sink_input_state_t state;
394 pa_sink_input_assert_ref(i);
395
396 pa_assert(i->state == PA_SINK_INPUT_INIT);
397 pa_assert(i->pop);
398 pa_assert(i->process_rewind);
399
400 i->thread_info.volume = i->volume;
401 i->thread_info.muted = i->muted;
402
403 state = i->flags & PA_SINK_INPUT_START_CORKED ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING;
404
405 update_n_corked(i, state);
406 i->state = state;
407
408 pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_ADD_INPUT, i, 0, NULL);
409
410 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW, i->index);
411 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_PUT], i);
412 }
413
414 void pa_sink_input_kill(pa_sink_input*i) {
415 pa_sink_input_assert_ref(i);
416 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
417
418 if (i->kill)
419 i->kill(i);
420 }
421
422 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i) {
423 pa_usec_t r = 0;
424
425 pa_sink_input_assert_ref(i);
426 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
427
428 if (pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_GET_LATENCY, &r, 0, NULL) < 0)
429 r = 0;
430
431 if (i->get_latency)
432 r += i->get_latency(i);
433
434 return r;
435 }
436
437 /* Called from thread context */
438 int pa_sink_input_peek(pa_sink_input *i, size_t slength /* in sink frames */, pa_memchunk *chunk, pa_cvolume *volume) {
439 pa_bool_t do_volume_adj_here;
440 pa_bool_t volume_is_norm;
441 size_t block_size_max_sink, block_size_max_sink_input;
442 size_t ilength;
443
444 pa_sink_input_assert_ref(i);
445 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
446 pa_assert(pa_frame_aligned(slength, &i->sink->sample_spec));
447 pa_assert(chunk);
448 pa_assert(volume);
449
450 /* pa_log_debug("peek"); */
451
452 if (!i->pop)
453 return -1;
454
455 pa_assert(i->thread_info.state == PA_SINK_INPUT_RUNNING ||
456 i->thread_info.state == PA_SINK_INPUT_CORKED ||
457 i->thread_info.state == PA_SINK_INPUT_DRAINED);
458
459 /* If there's still some rewrite request the handle, but the sink
460 didn't do this for us, we do it here. However, since the sink
461 apparently doesn't support rewinding, we pass 0 here. This still
462 allows rewinding through the render buffer. */
463 pa_sink_input_process_rewind(i, 0);
464
465 block_size_max_sink_input = i->thread_info.resampler ?
466 pa_resampler_max_block_size(i->thread_info.resampler) :
467 pa_frame_align(pa_mempool_block_size_max(i->sink->core->mempool), &i->sample_spec);
468
469 block_size_max_sink = pa_frame_align(pa_mempool_block_size_max(i->sink->core->mempool), &i->sink->sample_spec);
470
471 /* Default buffer size */
472 if (slength <= 0)
473 slength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sink->sample_spec);
474
475 if (slength > block_size_max_sink)
476 slength = block_size_max_sink;
477
478 if (i->thread_info.resampler) {
479 ilength = pa_resampler_request(i->thread_info.resampler, slength);
480
481 if (ilength <= 0)
482 ilength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sample_spec);
483 } else
484 ilength = slength;
485
486 if (ilength > block_size_max_sink_input)
487 ilength = block_size_max_sink_input;
488
489 /* If the channel maps of the sink and this stream differ, we need
490 * to adjust the volume *before* we resample. Otherwise we can do
491 * it after and leave it for the sink code */
492
493 do_volume_adj_here = !pa_channel_map_equal(&i->channel_map, &i->sink->channel_map);
494 volume_is_norm = pa_cvolume_is_norm(&i->thread_info.volume) && !i->thread_info.muted;
495
496 while (!pa_memblockq_is_readable(i->thread_info.render_memblockq)) {
497 pa_memchunk tchunk;
498
499 /* There's nothing in our render queue. We need to fill it up
500 * with data from the implementor. */
501
502 if (i->thread_info.state == PA_SINK_INPUT_CORKED ||
503 i->pop(i, ilength, &tchunk) < 0) {
504
505 /* OK, we're corked or the implementor didn't give us any
506 * data, so let's just hand out silence */
507 pa_atomic_store(&i->thread_info.drained, 1);
508
509 pa_memblockq_seek(i->thread_info.render_memblockq, slength, PA_SEEK_RELATIVE);
510 i->thread_info.playing_for = 0;
511 if (i->thread_info.underrun_for != (uint64_t) -1)
512 i->thread_info.underrun_for += ilength;
513 break;
514 }
515
516 pa_atomic_store(&i->thread_info.drained, 0);
517
518 pa_assert(tchunk.length > 0);
519 pa_assert(tchunk.memblock);
520
521 i->thread_info.underrun_for = 0;
522 i->thread_info.playing_for += tchunk.length;
523
524 while (tchunk.length > 0) {
525 pa_memchunk wchunk;
526
527 wchunk = tchunk;
528 pa_memblock_ref(wchunk.memblock);
529
530 if (wchunk.length > block_size_max_sink_input)
531 wchunk.length = block_size_max_sink_input;
532
533 /* It might be necessary to adjust the volume here */
534 if (do_volume_adj_here && !volume_is_norm) {
535 pa_memchunk_make_writable(&wchunk, 0);
536
537 if (i->thread_info.muted)
538 pa_silence_memchunk(&wchunk, &i->thread_info.sample_spec);
539 else
540 pa_volume_memchunk(&wchunk, &i->thread_info.sample_spec, &i->thread_info.volume);
541 }
542
543 if (!i->thread_info.resampler)
544 pa_memblockq_push_align(i->thread_info.render_memblockq, &wchunk);
545 else {
546 pa_memchunk rchunk;
547 pa_resampler_run(i->thread_info.resampler, &wchunk, &rchunk);
548
549 /* pa_log_debug("pushing %lu", (unsigned long) rchunk.length); */
550
551 if (rchunk.memblock) {
552 pa_memblockq_push_align(i->thread_info.render_memblockq, &rchunk);
553 pa_memblock_unref(rchunk.memblock);
554 }
555 }
556
557 pa_memblock_unref(wchunk.memblock);
558
559 tchunk.index += wchunk.length;
560 tchunk.length -= wchunk.length;
561 }
562
563 pa_memblock_unref(tchunk.memblock);
564 }
565
566 pa_assert_se(pa_memblockq_peek(i->thread_info.render_memblockq, chunk) >= 0);
567
568 pa_assert(chunk->length > 0);
569 pa_assert(chunk->memblock);
570
571 /* pa_log_debug("peeking %lu", (unsigned long) chunk->length); */
572
573 if (chunk->length > block_size_max_sink)
574 chunk->length = block_size_max_sink;
575
576 /* Let's see if we had to apply the volume adjustment ourselves,
577 * or if this can be done by the sink for us */
578
579 if (do_volume_adj_here)
580 /* We had different channel maps, so we already did the adjustment */
581 pa_cvolume_reset(volume, i->sink->sample_spec.channels);
582 else if (i->thread_info.muted)
583 /* We've both the same channel map, so let's have the sink do the adjustment for us*/
584 pa_cvolume_mute(volume, i->sink->sample_spec.channels);
585 else
586 *volume = i->thread_info.volume;
587
588 return 0;
589 }
590
591 /* Called from thread context */
592 void pa_sink_input_drop(pa_sink_input *i, size_t nbytes /* in sink sample spec */) {
593 pa_sink_input_assert_ref(i);
594
595 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
596 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
597 pa_assert(nbytes > 0);
598
599 /* pa_log_debug("dropping %lu", (unsigned long) nbytes); */
600
601 /* If there's still some rewrite request the handle, but the sink
602 didn't do this for us, we do it here. However, since the sink
603 apparently doesn't support rewinding, we pass 0 here. This still
604 allows rewinding through the render buffer. */
605 pa_sink_input_process_rewind(i, 0);
606
607 pa_memblockq_drop(i->thread_info.render_memblockq, nbytes);
608 }
609
610 /* Called from thread context */
611 void pa_sink_input_process_rewind(pa_sink_input *i, size_t nbytes /* in sink sample spec */) {
612 size_t lbq;
613 pa_sink_input_assert_ref(i);
614
615 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
616 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
617
618 /* pa_log_debug("rewind(%lu, %lu)", (unsigned long) nbytes, (unsigned long) i->thread_info.rewrite_nbytes); */
619
620 lbq = pa_memblockq_get_length(i->thread_info.render_memblockq);
621
622 if (nbytes > 0) {
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);
625 }
626
627 if (i->thread_info.rewrite_nbytes == (size_t) -1) {
628
629 /* We were asked to drop all buffered data, and rerequest new
630 * data from implementor the next time push() is called */
631
632 pa_memblockq_flush(i->thread_info.render_memblockq);
633
634 } else if (i->thread_info.rewrite_nbytes > 0) {
635 size_t max_rewrite, amount;
636
637 /* Calculate how much make sense to rewrite at most */
638 max_rewrite = nbytes + lbq;
639
640 /* Transform into local domain */
641 if (i->thread_info.resampler)
642 max_rewrite = pa_resampler_request(i->thread_info.resampler, max_rewrite);
643
644 /* Calculate how much of the rewinded data should actually be rewritten */
645 amount = PA_MIN(i->thread_info.rewrite_nbytes, max_rewrite);
646
647 if (amount > 0) {
648 pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) amount);
649
650 /* Tell the implementor */
651 if (i->process_rewind)
652 i->process_rewind(i, amount);
653
654 /* Convert back to to sink domain */
655 if (i->thread_info.resampler)
656 amount = pa_resampler_result(i->thread_info.resampler, amount);
657
658 if (amount > 0)
659 /* Ok, now update the write pointer */
660 pa_memblockq_seek(i->thread_info.render_memblockq, - ((int64_t) amount), PA_SEEK_RELATIVE);
661
662 if (i->thread_info.rewrite_flush)
663 pa_memblockq_silence(i->thread_info.render_memblockq);
664
665 /* And reset the resampler */
666 if (i->thread_info.resampler)
667 pa_resampler_reset(i->thread_info.resampler);
668 }
669 }
670
671 i->thread_info.rewrite_nbytes = 0;
672 i->thread_info.rewrite_flush = FALSE;
673 }
674
675 /* Called from thread context */
676 void pa_sink_input_update_max_rewind(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */) {
677 pa_sink_input_assert_ref(i);
678 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
679 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
680
681 pa_memblockq_set_maxrewind(i->thread_info.render_memblockq, nbytes);
682
683 if (i->update_max_rewind)
684 i->update_max_rewind(i, i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, nbytes) : nbytes);
685 }
686
687 static pa_usec_t fixup_latency(pa_sink *s, pa_usec_t usec) {
688 pa_sink_assert_ref(s);
689
690 if (usec == (pa_usec_t) -1)
691 return usec;
692
693 if (s->max_latency > 0 && usec > s->max_latency)
694 usec = s->max_latency;
695
696 if (s->min_latency > 0 && usec < s->min_latency)
697 usec = s->min_latency;
698
699 return usec;
700 }
701
702 pa_usec_t pa_sink_input_set_requested_latency_within_thread(pa_sink_input *i, pa_usec_t usec) {
703 pa_sink_input_assert_ref(i);
704
705 usec = fixup_latency(i->sink, usec);
706
707 i->thread_info.requested_sink_latency = usec;
708 pa_sink_invalidate_requested_latency(i->sink);
709
710 return usec;
711 }
712
713 pa_usec_t pa_sink_input_set_requested_latency(pa_sink_input *i, pa_usec_t usec) {
714 pa_sink_input_assert_ref(i);
715
716 usec = fixup_latency(i->sink, usec);
717
718 if (PA_SINK_INPUT_IS_LINKED(i->state))
719 pa_asyncmsgq_post(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY, NULL, (int64_t) usec, NULL, NULL);
720 else {
721 /* If this sink input is not realized yet, we have to touch
722 * the thread info data directly */
723 i->thread_info.requested_sink_latency = usec;
724 i->sink->thread_info.requested_latency_valid = FALSE;
725 }
726
727 return usec;
728 }
729
730 pa_usec_t pa_sink_input_get_requested_latency(pa_sink_input *i) {
731 pa_usec_t usec = 0;
732
733 pa_sink_input_assert_ref(i);
734
735 if (PA_SINK_INPUT_IS_LINKED(i->state))
736 pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL);
737 else
738 /* If this sink input is not realized yet, we have to touch
739 * the thread info data directly */
740 usec = i->thread_info.requested_sink_latency;
741
742 return usec;
743 }
744
745 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume) {
746 pa_sink_input_assert_ref(i);
747 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
748
749 if (pa_cvolume_equal(&i->volume, volume))
750 return;
751
752 i->volume = *volume;
753
754 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);
755 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
756 }
757
758 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i) {
759 pa_sink_input_assert_ref(i);
760 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
761
762 return &i->volume;
763 }
764
765 void pa_sink_input_set_mute(pa_sink_input *i, pa_bool_t mute) {
766 pa_assert(i);
767 pa_sink_input_assert_ref(i);
768 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
769
770 if (!i->muted == !mute)
771 return;
772
773 i->muted = mute;
774
775 pa_asyncmsgq_post(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_MUTE, PA_UINT_TO_PTR(mute), 0, NULL, NULL);
776 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
777 }
778
779 int pa_sink_input_get_mute(pa_sink_input *i) {
780 pa_sink_input_assert_ref(i);
781 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
782
783 return !!i->muted;
784 }
785
786 void pa_sink_input_cork(pa_sink_input *i, pa_bool_t b) {
787 pa_sink_input_assert_ref(i);
788 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
789
790 sink_input_set_state(i, b ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING);
791 }
792
793 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate) {
794 pa_sink_input_assert_ref(i);
795 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
796 pa_return_val_if_fail(i->thread_info.resampler, -1);
797
798 if (i->sample_spec.rate == rate)
799 return 0;
800
801 i->sample_spec.rate = rate;
802
803 pa_asyncmsgq_post(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
804
805 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
806 return 0;
807 }
808
809 void pa_sink_input_set_name(pa_sink_input *i, const char *name) {
810 const char *old;
811 pa_sink_input_assert_ref(i);
812
813 if (!name && !pa_proplist_contains(i->proplist, PA_PROP_MEDIA_NAME))
814 return;
815
816 old = pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME);
817
818 if (old && name && !strcmp(old, name))
819 return;
820
821 if (name)
822 pa_proplist_sets(i->proplist, PA_PROP_MEDIA_NAME, name);
823 else
824 pa_proplist_unset(i->proplist, PA_PROP_MEDIA_NAME);
825
826 if (PA_SINK_INPUT_IS_LINKED(i->state)) {
827 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], i);
828 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
829 }
830 }
831
832 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i) {
833 pa_sink_input_assert_ref(i);
834
835 return i->resample_method;
836 }
837
838 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest) {
839 pa_resampler *new_resampler;
840 pa_sink *origin;
841 pa_sink_input_move_hook_data hook_data;
842
843 pa_sink_input_assert_ref(i);
844 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
845 pa_sink_assert_ref(dest);
846
847 origin = i->sink;
848
849 if (dest == origin)
850 return 0;
851
852 if (i->flags & PA_SINK_INPUT_DONT_MOVE)
853 return -1;
854
855 if (i->sync_next || i->sync_prev) {
856 pa_log_warn("Moving synchronised streams not supported.");
857 return -1;
858 }
859
860 if (pa_idxset_size(dest->inputs) >= PA_MAX_INPUTS_PER_SINK) {
861 pa_log_warn("Failed to move sink input: too many inputs per sink.");
862 return -1;
863 }
864
865 if (i->thread_info.resampler &&
866 pa_sample_spec_equal(&origin->sample_spec, &dest->sample_spec) &&
867 pa_channel_map_equal(&origin->channel_map, &dest->channel_map))
868
869 /* Try to reuse the old resampler if possible */
870 new_resampler = i->thread_info.resampler;
871
872 else if ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ||
873 !pa_sample_spec_equal(&i->sample_spec, &dest->sample_spec) ||
874 !pa_channel_map_equal(&i->channel_map, &dest->channel_map)) {
875
876 /* Okey, we need a new resampler for the new sink */
877
878 if (!(new_resampler = pa_resampler_new(
879 dest->core->mempool,
880 &i->sample_spec, &i->channel_map,
881 &dest->sample_spec, &dest->channel_map,
882 i->resample_method,
883 ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
884 ((i->flags & PA_SINK_INPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
885 (i->core->disable_remixing || (i->flags & PA_SINK_INPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0)))) {
886 pa_log_warn("Unsupported resampling operation.");
887 return -1;
888 }
889 } else
890 new_resampler = NULL;
891
892 hook_data.sink_input = i;
893 hook_data.destination = dest;
894 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE], &hook_data);
895
896 pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_START_MOVE, i, 0, NULL);
897
898 pa_idxset_remove_by_data(origin->inputs, i, NULL);
899 pa_idxset_put(dest->inputs, i, NULL);
900 i->sink = dest;
901
902 if (pa_sink_input_get_state(i) == PA_SINK_INPUT_CORKED) {
903 pa_assert_se(origin->n_corked-- >= 1);
904 dest->n_corked++;
905 }
906
907 /* Replace resampler and render queue */
908 if (new_resampler != i->thread_info.resampler) {
909
910 if (i->thread_info.resampler)
911 pa_resampler_free(i->thread_info.resampler);
912 i->thread_info.resampler = new_resampler;
913
914 pa_memblockq_free(i->thread_info.render_memblockq);
915
916 i->thread_info.render_memblockq = pa_memblockq_new(
917 0,
918 MEMBLOCKQ_MAXLENGTH,
919 0,
920 pa_frame_size(&i->sink->sample_spec),
921 0,
922 1,
923 0,
924 &i->sink->silence);
925 }
926
927 pa_sink_update_status(origin);
928 pa_sink_update_status(dest);
929
930 pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_FINISH_MOVE, i, 0, NULL);
931
932 if (i->moved)
933 i->moved(i);
934
935 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_POST], i);
936
937 pa_log_debug("Successfully moved sink input %i from %s to %s.", i->index, origin->name, dest->name);
938
939 /* Notify everyone */
940 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
941
942 return 0;
943 }
944
945 void pa_sink_input_set_state_within_thread(pa_sink_input *i, pa_sink_input_state_t state) {
946 pa_sink_input_assert_ref(i);
947
948 if (state == i->thread_info.state)
949 return;
950
951 if ((state == PA_SINK_INPUT_DRAINED || state == PA_SINK_INPUT_RUNNING) &&
952 !(i->thread_info.state == PA_SINK_INPUT_DRAINED || i->thread_info.state != PA_SINK_INPUT_RUNNING))
953 pa_atomic_store(&i->thread_info.drained, 1);
954
955 if (state == PA_SINK_INPUT_CORKED && i->thread_info.state != PA_SINK_INPUT_CORKED) {
956
957 /* This will tell the implementing sink input driver to rewind
958 * so that the unplayed already mixed data is not lost */
959 pa_sink_input_request_rewind(i, 0, TRUE, TRUE);
960
961 } else if (i->thread_info.state == PA_SINK_INPUT_CORKED && state != PA_SINK_INPUT_CORKED) {
962
963 /* OK, we're being uncorked. Make sure we're not rewound when
964 * the hw buffer is remixed and request a remix. */
965 pa_sink_input_request_rewind(i, 0, FALSE, TRUE);
966 }
967
968 if (i->state_change)
969 i->state_change(i, state);
970
971 i->thread_info.state = state;
972 }
973
974 /* Called from thread context */
975 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
976 pa_sink_input *i = PA_SINK_INPUT(o);
977
978 pa_sink_input_assert_ref(i);
979 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
980
981 switch (code) {
982 case PA_SINK_INPUT_MESSAGE_SET_VOLUME:
983 i->thread_info.volume = *((pa_cvolume*) userdata);
984 pa_sink_input_request_rewind(i, 0, TRUE, FALSE);
985 return 0;
986
987 case PA_SINK_INPUT_MESSAGE_SET_MUTE:
988 i->thread_info.muted = PA_PTR_TO_UINT(userdata);
989 pa_sink_input_request_rewind(i, 0, TRUE, FALSE);
990 return 0;
991
992 case PA_SINK_INPUT_MESSAGE_GET_LATENCY: {
993 pa_usec_t *r = userdata;
994
995 *r += pa_bytes_to_usec(pa_memblockq_get_length(i->thread_info.render_memblockq), &i->sink->sample_spec);
996 return 0;
997 }
998
999 case PA_SINK_INPUT_MESSAGE_SET_RATE:
1000
1001 i->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
1002 pa_resampler_set_input_rate(i->thread_info.resampler, PA_PTR_TO_UINT(userdata));
1003
1004 return 0;
1005
1006 case PA_SINK_INPUT_MESSAGE_SET_STATE: {
1007 pa_sink_input *ssync;
1008
1009 pa_sink_input_set_state_within_thread(i, PA_PTR_TO_UINT(userdata));
1010
1011 for (ssync = i->thread_info.sync_prev; ssync; ssync = ssync->thread_info.sync_prev)
1012 pa_sink_input_set_state_within_thread(ssync, PA_PTR_TO_UINT(userdata));
1013
1014 for (ssync = i->thread_info.sync_next; ssync; ssync = ssync->thread_info.sync_next)
1015 pa_sink_input_set_state_within_thread(ssync, PA_PTR_TO_UINT(userdata));
1016
1017 return 0;
1018 }
1019
1020 case PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY:
1021
1022 pa_sink_input_set_requested_latency_within_thread(i, (pa_usec_t) offset);
1023 return 0;
1024
1025 case PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY: {
1026 pa_usec_t *r = userdata;
1027
1028 *r = i->thread_info.requested_sink_latency;
1029 return 0;
1030 }
1031 }
1032
1033 return -1;
1034 }
1035
1036 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i) {
1037 pa_sink_input_assert_ref(i);
1038
1039 if (i->state == PA_SINK_INPUT_RUNNING || i->state == PA_SINK_INPUT_DRAINED)
1040 return pa_atomic_load(&i->thread_info.drained) ? PA_SINK_INPUT_DRAINED : PA_SINK_INPUT_RUNNING;
1041
1042 return i->state;
1043 }
1044
1045 /* Called from IO context */
1046 pa_bool_t pa_sink_input_safe_to_remove(pa_sink_input *i) {
1047 pa_sink_input_assert_ref(i);
1048
1049 if (PA_SINK_INPUT_IS_LINKED(i->thread_info.state))
1050 return pa_memblockq_is_empty(i->thread_info.render_memblockq);
1051
1052 return TRUE;
1053 }
1054
1055 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) {
1056 size_t lbq;
1057
1058 /* If 'rewrite' is TRUE the sink is rewound as far as requested
1059 * and possible and the exact value of this is passed back the
1060 * implementor via process_rewind(). If 'flush' is also TRUE all
1061 * already rendered data is also dropped.
1062 *
1063 * If 'rewrite' is FALSE the sink is rewound as far as requested
1064 * and possible and the already rendered data is dropped so that
1065 * in the next iteration we read new data from the
1066 * implementor. This implies 'flush' is TRUE. */
1067
1068 pa_sink_input_assert_ref(i);
1069 pa_assert(i->thread_info.rewrite_nbytes == 0);
1070
1071 /* We don't take rewind requests while we are corked */
1072 if (i->thread_info.state == PA_SINK_INPUT_CORKED)
1073 return;
1074
1075 pa_assert(rewrite || flush);
1076
1077 /* Calculate how much we can rewind locally without having to
1078 * touch the sink */
1079 if (rewrite)
1080 lbq = pa_memblockq_get_length(i->thread_info.render_memblockq);
1081 else
1082 lbq = 0;
1083
1084 /* Check if rewinding for the maximum is requested, and if so, fix up */
1085 if (nbytes <= 0) {
1086
1087 /* Calculate maximum number of bytes that could be rewound in theory */
1088 nbytes = i->sink->thread_info.max_rewind + lbq;
1089
1090 /* Transform from sink domain */
1091 if (i->thread_info.resampler)
1092 nbytes = pa_resampler_request(i->thread_info.resampler, nbytes);
1093 }
1094
1095 if (rewrite) {
1096 /* Make sure to not overwrite over underruns */
1097 if (nbytes > i->thread_info.playing_for)
1098 nbytes = (size_t) i->thread_info.playing_for;
1099
1100 i->thread_info.rewrite_nbytes = nbytes;
1101 } else
1102 i->thread_info.rewrite_nbytes = (size_t) -1;
1103
1104 i->thread_info.rewrite_flush = flush && i->thread_info.rewrite_nbytes != 0;
1105
1106 /* Transform to sink domain */
1107 if (i->thread_info.resampler)
1108 nbytes = pa_resampler_result(i->thread_info.resampler, nbytes);
1109
1110 if (nbytes > lbq)
1111 pa_sink_request_rewind(i->sink, nbytes - lbq);
1112 }
1113
1114 pa_memchunk* pa_sink_input_get_silence(pa_sink_input *i, pa_memchunk *ret) {
1115 pa_sink_input_assert_ref(i);
1116 pa_assert(ret);
1117
1118 pa_silence_memchunk_get(
1119 &i->sink->core->silence_cache,
1120 i->sink->core->mempool,
1121 ret,
1122 &i->sample_spec,
1123 i->thread_info.resampler ? pa_resampler_max_block_size(i->thread_info.resampler) : 0);
1124
1125 return ret;
1126 }