]> code.delx.au - pulseaudio/blob - src/pulsecore/sink-input.c
- Change meaning of special values of latency request: 0 -> "minimal latency, please...
[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 }
110
111 pa_sink_input* pa_sink_input_new(
112 pa_core *core,
113 pa_sink_input_new_data *data,
114 pa_sink_input_flags_t flags) {
115
116 pa_sink_input *i;
117 pa_resampler *resampler = NULL;
118 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
119
120 pa_assert(core);
121 pa_assert(data);
122
123 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_NEW], data) < 0)
124 return NULL;
125
126 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
127
128 if (!data->sink)
129 data->sink = pa_namereg_get(core, NULL, PA_NAMEREG_SINK, 1);
130
131 pa_return_null_if_fail(data->sink);
132 pa_return_null_if_fail(pa_sink_get_state(data->sink) != PA_SINK_UNLINKED);
133 pa_return_null_if_fail(!data->sync_base || (data->sync_base->sink == data->sink && pa_sink_input_get_state(data->sync_base) == PA_SINK_INPUT_CORKED));
134
135 if (!data->sample_spec_is_set)
136 data->sample_spec = data->sink->sample_spec;
137
138 pa_return_null_if_fail(pa_sample_spec_valid(&data->sample_spec));
139
140 if (!data->channel_map_is_set) {
141 if (data->sink->channel_map.channels == data->sample_spec.channels)
142 data->channel_map = data->sink->channel_map;
143 else
144 pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
145 }
146
147 pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
148 pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
149
150 if (!data->volume_is_set)
151 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
152
153 pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
154 pa_return_null_if_fail(data->volume.channels == data->sample_spec.channels);
155
156 if (!data->muted_is_set)
157 data->muted = FALSE;
158
159 if (flags & PA_SINK_INPUT_FIX_FORMAT)
160 data->sample_spec.format = data->sink->sample_spec.format;
161
162 if (flags & PA_SINK_INPUT_FIX_RATE)
163 data->sample_spec.rate = data->sink->sample_spec.rate;
164
165 if (flags & PA_SINK_INPUT_FIX_CHANNELS) {
166 data->sample_spec.channels = data->sink->sample_spec.channels;
167 data->channel_map = data->sink->channel_map;
168 }
169
170 pa_assert(pa_sample_spec_valid(&data->sample_spec));
171 pa_assert(pa_channel_map_valid(&data->channel_map));
172
173 /* Due to the fixing of the sample spec the volume might not match anymore */
174 if (data->volume.channels != data->sample_spec.channels)
175 pa_cvolume_set(&data->volume, data->sample_spec.channels, pa_cvolume_avg(&data->volume));
176
177 if (data->resample_method == PA_RESAMPLER_INVALID)
178 data->resample_method = core->resample_method;
179
180 pa_return_null_if_fail(data->resample_method < PA_RESAMPLER_MAX);
181
182 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_FIXATE], data) < 0)
183 return NULL;
184
185 if (pa_idxset_size(data->sink->inputs) >= PA_MAX_INPUTS_PER_SINK) {
186 pa_log_warn("Failed to create sink input: too many inputs per sink.");
187 return NULL;
188 }
189
190 if ((flags & PA_SINK_INPUT_VARIABLE_RATE) ||
191 !pa_sample_spec_equal(&data->sample_spec, &data->sink->sample_spec) ||
192 !pa_channel_map_equal(&data->channel_map, &data->sink->channel_map)) {
193
194 if (!(resampler = pa_resampler_new(
195 core->mempool,
196 &data->sample_spec, &data->channel_map,
197 &data->sink->sample_spec, &data->sink->channel_map,
198 data->resample_method,
199 ((flags & PA_SINK_INPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
200 ((flags & PA_SINK_INPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
201 (core->disable_remixing || (flags & PA_SINK_INPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0)))) {
202 pa_log_warn("Unsupported resampling operation.");
203 return NULL;
204 }
205
206 data->resample_method = pa_resampler_get_method(resampler);
207 }
208
209 i = pa_msgobject_new(pa_sink_input);
210 i->parent.parent.free = sink_input_free;
211 i->parent.process_msg = pa_sink_input_process_msg;
212
213 i->core = core;
214 i->state = PA_SINK_INPUT_INIT;
215 i->flags = flags;
216 i->proplist = pa_proplist_copy(data->proplist);
217 i->driver = pa_xstrdup(data->driver);
218 i->module = data->module;
219 i->sink = data->sink;
220 i->client = data->client;
221
222 i->resample_method = data->resample_method;
223 i->sample_spec = data->sample_spec;
224 i->channel_map = data->channel_map;
225
226 i->volume = data->volume;
227 i->muted = data->muted;
228
229 if (data->sync_base) {
230 i->sync_next = data->sync_base->sync_next;
231 i->sync_prev = data->sync_base;
232
233 if (data->sync_base->sync_next)
234 data->sync_base->sync_next->sync_prev = i;
235 data->sync_base->sync_next = i;
236 } else
237 i->sync_next = i->sync_prev = NULL;
238
239 reset_callbacks(i);
240 i->userdata = NULL;
241
242 i->thread_info.state = i->state;
243 i->thread_info.attached = FALSE;
244 pa_atomic_store(&i->thread_info.drained, 1);
245 pa_atomic_store(&i->thread_info.render_memblockq_is_empty, 0);
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.since_underrun = 0;
253 i->thread_info.ignore_rewind = FALSE;
254
255 i->thread_info.render_memblockq = pa_memblockq_new(
256 0,
257 MEMBLOCKQ_MAXLENGTH,
258 0,
259 pa_frame_size(&i->sink->sample_spec),
260 0,
261 1,
262 0,
263 &i->sink->silence);
264
265 pa_assert_se(pa_idxset_put(core->sink_inputs, pa_sink_input_ref(i), &i->index) == 0);
266 pa_assert_se(pa_idxset_put(i->sink->inputs, i, NULL) == 0);
267
268 pa_log_info("Created input %u \"%s\" on %s with sample spec %s and channel map %s",
269 i->index,
270 pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)),
271 i->sink->name,
272 pa_sample_spec_snprint(st, sizeof(st), &i->sample_spec),
273 pa_channel_map_snprint(cm, sizeof(cm), &i->channel_map));
274
275 /* Don't forget to call pa_sink_input_put! */
276
277 return i;
278 }
279
280 static void update_n_corked(pa_sink_input *i, pa_sink_input_state_t state) {
281 pa_assert(i);
282
283 if (i->state == PA_SINK_INPUT_CORKED && state != PA_SINK_INPUT_CORKED)
284 pa_assert_se(i->sink->n_corked -- >= 1);
285 else if (i->state != PA_SINK_INPUT_CORKED && state == PA_SINK_INPUT_CORKED)
286 i->sink->n_corked++;
287
288 pa_sink_update_status(i->sink);
289 }
290
291 static int sink_input_set_state(pa_sink_input *i, pa_sink_input_state_t state) {
292 pa_sink_input *ssync;
293 pa_assert(i);
294
295 if (state == PA_SINK_INPUT_DRAINED)
296 state = PA_SINK_INPUT_RUNNING;
297
298 if (i->state == state)
299 return 0;
300
301 if (pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
302 return -1;
303
304 update_n_corked(i, state);
305 i->state = state;
306
307 for (ssync = i->sync_prev; ssync; ssync = ssync->sync_prev) {
308 update_n_corked(ssync, state);
309 ssync->state = state;
310 }
311 for (ssync = i->sync_next; ssync; ssync = ssync->sync_next) {
312 update_n_corked(ssync, state);
313 ssync->state = state;
314 }
315
316 if (state != PA_SINK_INPUT_UNLINKED)
317 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], i);
318
319 return 0;
320 }
321
322 void pa_sink_input_unlink(pa_sink_input *i) {
323 pa_bool_t linked;
324 pa_assert(i);
325
326 /* See pa_sink_unlink() for a couple of comments how this function
327 * works */
328
329 pa_sink_input_ref(i);
330
331 linked = PA_SINK_INPUT_LINKED(i->state);
332
333 if (linked)
334 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK], i);
335
336 if (i->sync_prev)
337 i->sync_prev->sync_next = i->sync_next;
338 if (i->sync_next)
339 i->sync_next->sync_prev = i->sync_prev;
340
341 i->sync_prev = i->sync_next = NULL;
342
343 pa_idxset_remove_by_data(i->sink->core->sink_inputs, i, NULL);
344 if (pa_idxset_remove_by_data(i->sink->inputs, i, NULL))
345 pa_sink_input_unref(i);
346
347 if (linked) {
348 pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_REMOVE_INPUT, i, 0, NULL);
349 sink_input_set_state(i, PA_SINK_INPUT_UNLINKED);
350 pa_sink_update_status(i->sink);
351 } else
352 i->state = PA_SINK_INPUT_UNLINKED;
353
354 reset_callbacks(i);
355
356 if (linked) {
357 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_REMOVE, i->index);
358 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST], i);
359 }
360
361 i->sink = NULL;
362 pa_sink_input_unref(i);
363 }
364
365 static void sink_input_free(pa_object *o) {
366 pa_sink_input* i = PA_SINK_INPUT(o);
367
368 pa_assert(i);
369 pa_assert(pa_sink_input_refcnt(i) == 0);
370
371 if (PA_SINK_INPUT_LINKED(i->state))
372 pa_sink_input_unlink(i);
373
374 pa_log_info("Freeing input %u \"%s\"", i->index, pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)));
375
376 pa_assert(!i->thread_info.attached);
377
378 if (i->thread_info.render_memblockq)
379 pa_memblockq_free(i->thread_info.render_memblockq);
380
381 if (i->thread_info.resampler)
382 pa_resampler_free(i->thread_info.resampler);
383
384 if (i->proplist)
385 pa_proplist_free(i->proplist);
386
387 pa_xfree(i->driver);
388 pa_xfree(i);
389 }
390
391 void pa_sink_input_put(pa_sink_input *i) {
392 pa_sink_input_state_t state;
393 pa_sink_input_assert_ref(i);
394
395 pa_assert(i->state == PA_SINK_INPUT_INIT);
396 pa_assert(i->pop);
397 pa_assert(i->process_rewind);
398
399 i->thread_info.volume = i->volume;
400 i->thread_info.muted = i->muted;
401
402 state = i->flags & PA_SINK_INPUT_START_CORKED ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING;
403
404 update_n_corked(i, state);
405 i->thread_info.state = i->state = state;
406
407 pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_ADD_INPUT, i, 0, NULL);
408
409 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW, i->index);
410 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_PUT], i);
411
412 /* Please note that if you change something here, you have to
413 change something in pa_sink_input_move() with the ghost stream
414 registration too. */
415 }
416
417 void pa_sink_input_kill(pa_sink_input*i) {
418 pa_sink_input_assert_ref(i);
419 pa_assert(PA_SINK_INPUT_LINKED(i->state));
420
421 if (i->kill)
422 i->kill(i);
423 }
424
425 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i) {
426 pa_usec_t r = 0;
427
428 pa_sink_input_assert_ref(i);
429 pa_assert(PA_SINK_INPUT_LINKED(i->state));
430
431 if (pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_GET_LATENCY, &r, 0, NULL) < 0)
432 r = 0;
433
434 if (i->get_latency)
435 r += i->get_latency(i);
436
437 return r;
438 }
439
440 /* Called from thread context */
441 int pa_sink_input_peek(pa_sink_input *i, size_t slength /* in sink frames */, pa_memchunk *chunk, pa_cvolume *volume) {
442 pa_bool_t do_volume_adj_here;
443 pa_bool_t volume_is_norm;
444 size_t block_size_max_sink, block_size_max_sink_input;
445 size_t ilength;
446
447 pa_sink_input_assert_ref(i);
448 pa_assert(PA_SINK_INPUT_LINKED(i->thread_info.state));
449 pa_assert(pa_frame_aligned(slength, &i->sink->sample_spec));
450 pa_assert(chunk);
451 pa_assert(volume);
452
453 /* pa_log_debug("peek"); */
454
455 if (!i->pop)
456 return -1;
457
458 pa_assert(i->thread_info.state == PA_SINK_INPUT_RUNNING ||
459 i->thread_info.state == PA_SINK_INPUT_CORKED ||
460 i->thread_info.state == PA_SINK_INPUT_DRAINED);
461
462 /* If there's still some rewrite request the handle, but the sink
463 didn't do this for us, we do it here. However, since the sink
464 apparently doesn't support rewinding, we pass 0 here. This still
465 allows rewinding through the render buffer. */
466 pa_sink_input_process_rewind(i, 0);
467
468 block_size_max_sink_input = i->thread_info.resampler ?
469 pa_resampler_max_block_size(i->thread_info.resampler) :
470 pa_frame_align(pa_mempool_block_size_max(i->sink->core->mempool), &i->sample_spec);
471
472 block_size_max_sink = pa_frame_align(pa_mempool_block_size_max(i->sink->core->mempool), &i->sink->sample_spec);
473
474 /* Default buffer size */
475 if (slength <= 0)
476 slength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sink->sample_spec);
477
478 if (slength > block_size_max_sink)
479 slength = block_size_max_sink;
480
481 if (i->thread_info.resampler) {
482 ilength = pa_resampler_request(i->thread_info.resampler, slength);
483
484 if (ilength <= 0)
485 ilength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sample_spec);
486 } else
487 ilength = slength;
488
489 if (ilength > block_size_max_sink_input)
490 ilength = block_size_max_sink_input;
491
492 /* If the channel maps of the sink and this stream differ, we need
493 * to adjust the volume *before* we resample. Otherwise we can do
494 * it after and leave it for the sink code */
495
496 do_volume_adj_here = !pa_channel_map_equal(&i->channel_map, &i->sink->channel_map);
497 volume_is_norm = pa_cvolume_is_norm(&i->thread_info.volume) && !i->thread_info.muted;
498
499 while (!pa_memblockq_is_readable(i->thread_info.render_memblockq)) {
500 pa_memchunk tchunk;
501
502 /* There's nothing in our render queue. We need to fill it up
503 * with data from the implementor. */
504
505 if (i->thread_info.state == PA_SINK_INPUT_CORKED ||
506 i->pop(i, ilength, &tchunk) < 0) {
507
508 /* OK, we're corked or the implementor didn't give us any
509 * data, so let's just hand out silence */
510 pa_atomic_store(&i->thread_info.drained, 1);
511
512 pa_memblockq_seek(i->thread_info.render_memblockq, slength, PA_SEEK_RELATIVE_ON_READ);
513 i->thread_info.since_underrun = 0;
514 break;
515 }
516
517 pa_atomic_store(&i->thread_info.drained, 0);
518
519 pa_assert(tchunk.length > 0);
520 pa_assert(tchunk.memblock);
521
522 i->thread_info.since_underrun += 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 if (rchunk.memblock) {
550 pa_memblockq_push_align(i->thread_info.render_memblockq, &rchunk);
551 pa_memblock_unref(rchunk.memblock);
552 }
553 }
554
555 pa_memblock_unref(wchunk.memblock);
556
557 tchunk.index += wchunk.length;
558 tchunk.length -= wchunk.length;
559 }
560
561 pa_memblock_unref(tchunk.memblock);
562 }
563
564 pa_assert_se(pa_memblockq_peek(i->thread_info.render_memblockq, chunk) >= 0);
565
566 pa_assert(chunk->length > 0);
567 pa_assert(chunk->memblock);
568
569 if (chunk->length > block_size_max_sink)
570 chunk->length = block_size_max_sink;
571
572 /* Let's see if we had to apply the volume adjustment ourselves,
573 * or if this can be done by the sink for us */
574
575 if (do_volume_adj_here)
576 /* We had different channel maps, so we already did the adjustment */
577 pa_cvolume_reset(volume, i->sink->sample_spec.channels);
578 else if (i->thread_info.muted)
579 /* We've both the same channel map, so let's have the sink do the adjustment for us*/
580 pa_cvolume_mute(volume, i->sink->sample_spec.channels);
581 else
582 *volume = i->thread_info.volume;
583
584 pa_atomic_store(&i->thread_info.render_memblockq_is_empty, pa_memblockq_is_empty(i->thread_info.render_memblockq));
585
586 return 0;
587 }
588
589 /* Called from thread context */
590 void pa_sink_input_drop(pa_sink_input *i, size_t nbytes /* in sink sample spec */) {
591 pa_sink_input_assert_ref(i);
592
593 pa_assert(PA_SINK_INPUT_LINKED(i->thread_info.state));
594 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
595 pa_assert(nbytes > 0);
596
597 /* If there's still some rewrite request the handle, but the sink
598 didn't do this for us, we do it here. However, since the sink
599 apparently doesn't support rewinding, we pass 0 here. This still
600 allows rewinding through the render buffer. */
601 if (i->thread_info.rewrite_nbytes > 0)
602 pa_sink_input_process_rewind(i, 0);
603
604 pa_memblockq_drop(i->thread_info.render_memblockq, nbytes);
605
606 pa_atomic_store(&i->thread_info.render_memblockq_is_empty, pa_memblockq_is_empty(i->thread_info.render_memblockq));
607 }
608
609 /* Called from thread context */
610 void pa_sink_input_process_rewind(pa_sink_input *i, size_t nbytes /* in sink sample spec */) {
611 pa_sink_input_assert_ref(i);
612
613 pa_assert(PA_SINK_INPUT_LINKED(i->thread_info.state));
614 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
615
616 /* pa_log_debug("rewind(%lu, %lu)", (unsigned long) nbytes, (unsigned long) i->thread_info.rewrite_nbytes); */
617
618 if (i->thread_info.ignore_rewind) {
619 i->thread_info.ignore_rewind = FALSE;
620 i->thread_info.rewrite_nbytes = 0;
621 return;
622 }
623
624 if (nbytes > 0)
625 pa_log_debug("Have to rewind %lu bytes on render memblockq.", (unsigned long) nbytes);
626
627 if (i->thread_info.rewrite_nbytes > 0) {
628 size_t max_rewrite;
629
630 /* Calculate how much make sense to rewrite at most */
631 if ((max_rewrite = nbytes + pa_memblockq_get_length(i->thread_info.render_memblockq)) > 0) {
632 size_t amount, r;
633
634 /* Transform into local domain */
635 if (i->thread_info.resampler)
636 max_rewrite = pa_resampler_request(i->thread_info.resampler, max_rewrite);
637
638 /* Calculate how much of the rewinded data should actually be rewritten */
639 amount = PA_MIN(max_rewrite, i->thread_info.rewrite_nbytes);
640
641 /* Convert back to to sink domain */
642 r = i->thread_info.resampler ? pa_resampler_result(i->thread_info.resampler, amount) : amount;
643
644 if (r > 0)
645 /* Ok, now update the write pointer */
646 pa_memblockq_seek(i->thread_info.render_memblockq, -r, PA_SEEK_RELATIVE);
647
648 if (amount) {
649 pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) amount);
650
651 /* Tell the implementor */
652 if (i->process_rewind)
653 i->process_rewind(i, amount);
654 }
655
656 /* And reset the resampler */
657 if (i->thread_info.resampler)
658 pa_resampler_reset(i->thread_info.resampler);
659 }
660
661 i->thread_info.rewrite_nbytes = 0;
662 }
663
664 if (nbytes > 0)
665 pa_memblockq_rewind(i->thread_info.render_memblockq, nbytes);
666 }
667
668 /* Called from thread context */
669 void pa_sink_input_update_max_rewind(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */) {
670 pa_sink_input_assert_ref(i);
671 pa_assert(PA_SINK_INPUT_LINKED(i->thread_info.state));
672 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
673
674 pa_memblockq_set_maxrewind(i->thread_info.render_memblockq, nbytes);
675
676 if (i->update_max_rewind)
677 i->update_max_rewind(i, i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, nbytes) : nbytes);
678 }
679
680 pa_usec_t pa_sink_input_set_requested_latency(pa_sink_input *i, pa_usec_t usec) {
681 pa_sink_input_assert_ref(i);
682
683 if (usec != (pa_usec_t) -1) {
684
685 if (i->sink->max_latency > 0 && usec > i->sink->max_latency)
686 usec = i->sink->max_latency;
687
688 if (i->sink->min_latency > 0 && usec < i->sink->min_latency)
689 usec = i->sink->min_latency;
690 }
691
692 if (PA_SINK_INPUT_LINKED(i->state))
693 pa_asyncmsgq_post(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY, NULL, (int64_t) usec, NULL, NULL);
694 else {
695 i->thread_info.requested_sink_latency = usec;
696 i->sink->thread_info.requested_latency_valid = FALSE;
697 }
698
699 return usec;
700 }
701
702 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume) {
703 pa_sink_input_assert_ref(i);
704 pa_assert(PA_SINK_INPUT_LINKED(i->state));
705
706 if (pa_cvolume_equal(&i->volume, volume))
707 return;
708
709 i->volume = *volume;
710
711 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);
712 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
713 }
714
715 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i) {
716 pa_sink_input_assert_ref(i);
717 pa_assert(PA_SINK_INPUT_LINKED(i->state));
718
719 return &i->volume;
720 }
721
722 void pa_sink_input_set_mute(pa_sink_input *i, pa_bool_t mute) {
723 pa_assert(i);
724 pa_sink_input_assert_ref(i);
725 pa_assert(PA_SINK_INPUT_LINKED(i->state));
726
727 if (!i->muted == !mute)
728 return;
729
730 i->muted = mute;
731
732 pa_asyncmsgq_post(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_MUTE, PA_UINT_TO_PTR(mute), 0, NULL, NULL);
733 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
734 }
735
736 int pa_sink_input_get_mute(pa_sink_input *i) {
737 pa_sink_input_assert_ref(i);
738 pa_assert(PA_SINK_INPUT_LINKED(i->state));
739
740 return !!i->muted;
741 }
742
743 void pa_sink_input_cork(pa_sink_input *i, pa_bool_t b) {
744 pa_sink_input_assert_ref(i);
745 pa_assert(PA_SINK_INPUT_LINKED(i->state));
746
747 sink_input_set_state(i, b ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING);
748 }
749
750 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate) {
751 pa_sink_input_assert_ref(i);
752 pa_assert(PA_SINK_INPUT_LINKED(i->state));
753 pa_return_val_if_fail(i->thread_info.resampler, -1);
754
755 if (i->sample_spec.rate == rate)
756 return 0;
757
758 i->sample_spec.rate = rate;
759
760 pa_asyncmsgq_post(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
761
762 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
763 return 0;
764 }
765
766 void pa_sink_input_set_name(pa_sink_input *i, const char *name) {
767 const char *old;
768 pa_sink_input_assert_ref(i);
769
770 if (!name && !pa_proplist_contains(i->proplist, PA_PROP_MEDIA_NAME))
771 return;
772
773 old = pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME);
774
775 if (old && name && !strcmp(old, name))
776 return;
777
778 if (name)
779 pa_proplist_sets(i->proplist, PA_PROP_MEDIA_NAME, name);
780 else
781 pa_proplist_unset(i->proplist, PA_PROP_MEDIA_NAME);
782
783 if (PA_SINK_INPUT_LINKED(i->state)) {
784 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], i);
785 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
786 }
787 }
788
789 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i) {
790 pa_sink_input_assert_ref(i);
791
792 return i->resample_method;
793 }
794
795 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest, int immediately) {
796 pa_resampler *new_resampler;
797 pa_sink *origin;
798 pa_usec_t silence_usec = 0;
799 pa_sink_input_move_info info;
800 pa_sink_input_move_hook_data hook_data;
801
802 pa_sink_input_assert_ref(i);
803 pa_assert(PA_SINK_INPUT_LINKED(i->state));
804 pa_sink_assert_ref(dest);
805
806 origin = i->sink;
807
808 if (dest == origin)
809 return 0;
810
811 if (i->flags & PA_SINK_INPUT_DONT_MOVE)
812 return -1;
813
814 if (i->sync_next || i->sync_prev) {
815 pa_log_warn("Moving synchronised streams not supported.");
816 return -1;
817 }
818
819 if (pa_idxset_size(dest->inputs) >= PA_MAX_INPUTS_PER_SINK) {
820 pa_log_warn("Failed to move sink input: too many inputs per sink.");
821 return -1;
822 }
823
824 if (i->thread_info.resampler &&
825 pa_sample_spec_equal(&origin->sample_spec, &dest->sample_spec) &&
826 pa_channel_map_equal(&origin->channel_map, &dest->channel_map))
827
828 /* Try to reuse the old resampler if possible */
829 new_resampler = i->thread_info.resampler;
830
831 else if ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ||
832 !pa_sample_spec_equal(&i->sample_spec, &dest->sample_spec) ||
833 !pa_channel_map_equal(&i->channel_map, &dest->channel_map)) {
834
835 /* Okey, we need a new resampler for the new sink */
836
837 if (!(new_resampler = pa_resampler_new(
838 dest->core->mempool,
839 &i->sample_spec, &i->channel_map,
840 &dest->sample_spec, &dest->channel_map,
841 i->resample_method,
842 ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
843 ((i->flags & PA_SINK_INPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
844 (i->core->disable_remixing || (i->flags & PA_SINK_INPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0)))) {
845 pa_log_warn("Unsupported resampling operation.");
846 return -1;
847 }
848 } else
849 new_resampler = NULL;
850
851 hook_data.sink_input = i;
852 hook_data.destination = dest;
853 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE], &hook_data);
854
855 memset(&info, 0, sizeof(info));
856 info.sink_input = i;
857
858 if (!immediately) {
859 pa_usec_t old_latency, new_latency;
860
861 /* Let's do a little bit of Voodoo for compensating latency
862 * differences. We assume that the accuracy for our
863 * estimations is still good enough, even though we do these
864 * operations non-atomic. */
865
866 old_latency = pa_sink_get_latency(origin);
867 new_latency = pa_sink_get_latency(dest);
868
869 /* The already resampled data should go to the old sink */
870
871 if (old_latency >= new_latency) {
872
873 /* The latency of the old sink is larger than the latency
874 * of the new sink. Therefore to compensate for the
875 * difference we to play silence on the new one for a
876 * while */
877
878 silence_usec = old_latency - new_latency;
879
880 } else {
881
882 /* The latency of new sink is larger than the latency of
883 * the old sink. Therefore we have to precompute a little
884 * and make sure that this is still played on the old
885 * sink, until we can play the first sample on the new
886 * sink.*/
887
888 info.buffer_bytes = pa_usec_to_bytes(new_latency - old_latency, &origin->sample_spec);
889 }
890
891 /* Okey, let's move it */
892
893 if (info.buffer_bytes > 0) {
894 pa_proplist *p;
895
896 p = pa_proplist_new();
897 pa_proplist_sets(p, PA_PROP_MEDIA_NAME, "Ghost For Moved Stream");
898 pa_proplist_sets(p, PA_PROP_MEDIA_ROLE, "routing");
899
900 info.ghost_sink_input = pa_memblockq_sink_input_new(
901 origin,
902 &origin->sample_spec,
903 &origin->channel_map,
904 NULL,
905 NULL,
906 p);
907
908 pa_proplist_free(p);
909
910 if (info.ghost_sink_input) {
911 info.ghost_sink_input->thread_info.state = info.ghost_sink_input->state = PA_SINK_INPUT_RUNNING;
912 info.ghost_sink_input->thread_info.volume = info.ghost_sink_input->volume;
913 info.ghost_sink_input->thread_info.muted = info.ghost_sink_input->muted;
914
915 info.buffer = pa_memblockq_new(0, MOVE_BUFFER_LENGTH, 0, pa_frame_size(&origin->sample_spec), 0, 0, 0, NULL);
916 }
917 }
918 }
919
920 pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER, &info, 0, NULL);
921
922 if (info.ghost_sink_input) {
923 /* Basically, do what pa_sink_input_put() does ...*/
924
925 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW, info.ghost_sink_input->index);
926 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_PUT], info.ghost_sink_input);
927 pa_sink_input_unref(info.ghost_sink_input);
928 }
929
930 pa_idxset_remove_by_data(origin->inputs, i, NULL);
931 pa_idxset_put(dest->inputs, i, NULL);
932 i->sink = dest;
933
934 if (pa_sink_input_get_state(i) == PA_SINK_INPUT_CORKED) {
935 pa_assert_se(origin->n_corked-- >= 1);
936 dest->n_corked++;
937 }
938
939 /* Replace resampler */
940 if (new_resampler != i->thread_info.resampler) {
941 pa_memchunk silence;
942
943 if (i->thread_info.resampler)
944 pa_resampler_free(i->thread_info.resampler);
945 i->thread_info.resampler = new_resampler;
946
947 /* if the resampler changed, the silence memblock is
948 * probably invalid now, too */
949
950 pa_silence_memchunk_get(
951 &i->sink->core->silence_cache,
952 i->sink->core->mempool,
953 &silence,
954 &dest->sample_spec,
955 0);
956
957 pa_memblockq_set_silence(i->thread_info.render_memblockq, &silence);
958 pa_memblock_unref(silence.memblock);
959
960 }
961
962 pa_memblockq_flush(i->thread_info.render_memblockq);
963
964 /* Calculate the new sleeping time */
965 if (!immediately)
966 pa_memblockq_seek(i->thread_info.render_memblockq, pa_usec_to_bytes(silence_usec, &dest->sample_spec), PA_SEEK_RELATIVE);
967
968 pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_ADD_INPUT, i, 0, NULL);
969
970 pa_sink_update_status(origin);
971 pa_sink_update_status(dest);
972
973 if (i->moved)
974 i->moved(i);
975
976 pa_hook_fire(&i->sink->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_POST], i);
977
978 pa_log_debug("Successfully moved sink input %i from %s to %s.", i->index, origin->name, dest->name);
979
980 /* Notify everyone */
981 pa_subscription_post(i->sink->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
982
983 return 0;
984 }
985
986 static void set_state(pa_sink_input *i, pa_sink_input_state_t state) {
987 pa_sink_input_assert_ref(i);
988
989 if ((state == PA_SINK_INPUT_DRAINED || state == PA_SINK_INPUT_RUNNING) &&
990 !(i->thread_info.state == PA_SINK_INPUT_DRAINED || i->thread_info.state != PA_SINK_INPUT_RUNNING))
991 pa_atomic_store(&i->thread_info.drained, 1);
992
993 if (state == PA_SINK_INPUT_CORKED && i->thread_info.state != PA_SINK_INPUT_CORKED) {
994
995 /* OK, we're corked, so let's make sure we have total silence
996 * from now on on this stream */
997 pa_memblockq_silence(i->thread_info.render_memblockq);
998
999 /* This will tell the implementing sink input driver to rewind
1000 * so that the unplayed already mixed data is not lost */
1001 pa_sink_input_request_rewind(i, 0, FALSE);
1002
1003 } else if (i->thread_info.state == PA_SINK_INPUT_CORKED && state != PA_SINK_INPUT_CORKED) {
1004
1005 /* OK, we're being uncorked. Make sure we're not rewound when
1006 * the hw buffer is remixed and request a remix. */
1007 i->thread_info.ignore_rewind = TRUE;
1008 i->thread_info.since_underrun = 0;
1009 pa_sink_request_rewind(i->sink, 0);
1010 }
1011
1012 i->thread_info.state = state;
1013 }
1014
1015 /* Called from thread context */
1016 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
1017 pa_sink_input *i = PA_SINK_INPUT(o);
1018
1019 pa_sink_input_assert_ref(i);
1020 pa_assert(PA_SINK_INPUT_LINKED(i->thread_info.state));
1021
1022 switch (code) {
1023 case PA_SINK_INPUT_MESSAGE_SET_VOLUME:
1024 i->thread_info.volume = *((pa_cvolume*) userdata);
1025 pa_sink_input_request_rewind(i, 0, FALSE);
1026 return 0;
1027
1028 case PA_SINK_INPUT_MESSAGE_SET_MUTE:
1029 i->thread_info.muted = PA_PTR_TO_UINT(userdata);
1030 pa_sink_input_request_rewind(i, 0, FALSE);
1031 return 0;
1032
1033 case PA_SINK_INPUT_MESSAGE_GET_LATENCY: {
1034 pa_usec_t *r = userdata;
1035
1036 *r += pa_bytes_to_usec(pa_memblockq_get_length(i->thread_info.render_memblockq), &i->sink->sample_spec);
1037
1038 return 0;
1039 }
1040
1041 case PA_SINK_INPUT_MESSAGE_SET_RATE:
1042
1043 i->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
1044 pa_resampler_set_input_rate(i->thread_info.resampler, PA_PTR_TO_UINT(userdata));
1045
1046 return 0;
1047
1048 case PA_SINK_INPUT_MESSAGE_SET_STATE: {
1049 pa_sink_input *ssync;
1050
1051 set_state(i, PA_PTR_TO_UINT(userdata));
1052
1053 for (ssync = i->thread_info.sync_prev; ssync; ssync = ssync->thread_info.sync_prev)
1054 set_state(ssync, PA_PTR_TO_UINT(userdata));
1055
1056 for (ssync = i->thread_info.sync_next; ssync; ssync = ssync->thread_info.sync_next)
1057 set_state(ssync, PA_PTR_TO_UINT(userdata));
1058
1059 return 0;
1060 }
1061
1062 case PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY:
1063
1064 i->thread_info.requested_sink_latency = (pa_usec_t) offset;
1065 pa_sink_invalidate_requested_latency(i->sink);
1066
1067 return 0;
1068 }
1069
1070 return -1;
1071 }
1072
1073 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i) {
1074 pa_sink_input_assert_ref(i);
1075
1076 if (i->state == PA_SINK_INPUT_RUNNING || i->state == PA_SINK_INPUT_DRAINED)
1077 return pa_atomic_load(&i->thread_info.drained) ? PA_SINK_INPUT_DRAINED : PA_SINK_INPUT_RUNNING;
1078
1079 return i->state;
1080 }
1081
1082 pa_bool_t pa_sink_input_safe_to_remove(pa_sink_input *i) {
1083 pa_sink_input_assert_ref(i);
1084
1085 if (i->state == PA_SINK_INPUT_RUNNING || i->state == PA_SINK_INPUT_DRAINED || i->state == PA_SINK_INPUT_CORKED)
1086 return pa_atomic_load(&i->thread_info.render_memblockq_is_empty);
1087
1088 return TRUE;
1089 }
1090
1091 void pa_sink_input_request_rewind(pa_sink_input *i, size_t nbytes /* in our sample spec */, pa_bool_t ignore_underruns) {
1092 size_t l, lbq;
1093
1094 pa_sink_input_assert_ref(i);
1095
1096 /* We don't take rewind requests while we are corked */
1097 if (i->state == PA_SINK_INPUT_CORKED)
1098 return;
1099
1100 lbq = pa_memblockq_get_length(i->thread_info.render_memblockq);
1101
1102 if (nbytes <= 0) {
1103 /* Calulate maximum number of bytes that could be rewound in theory */
1104 nbytes = i->sink->thread_info.max_rewind + lbq;
1105
1106 /* Transform from sink domain */
1107 nbytes =
1108 i->thread_info.resampler ?
1109 pa_resampler_request(i->thread_info.resampler, nbytes) :
1110 nbytes;
1111 }
1112
1113 /* Increase the number of bytes to rewrite, never decrease */
1114 if (nbytes > i->thread_info.rewrite_nbytes)
1115 i->thread_info.rewrite_nbytes = nbytes;
1116
1117 if (!ignore_underruns) {
1118 /* Make sure to not overwrite over underruns */
1119 if ((int64_t) i->thread_info.rewrite_nbytes > i->thread_info.since_underrun)
1120 i->thread_info.rewrite_nbytes = (size_t) i->thread_info.since_underrun;
1121 }
1122
1123 /* Transform to sink domain */
1124 l = i->thread_info.resampler ?
1125 pa_resampler_result(i->thread_info.resampler, i->thread_info.rewrite_nbytes) :
1126 i->thread_info.rewrite_nbytes;
1127
1128 if (l <= 0)
1129 return;
1130
1131 if (l > lbq)
1132 pa_sink_request_rewind(i->sink, l - lbq);
1133 }
1134
1135 pa_memchunk* pa_sink_input_get_silence(pa_sink_input *i, pa_memchunk *ret) {
1136 pa_sink_input_assert_ref(i);
1137 pa_assert(ret);
1138
1139 pa_silence_memchunk_get(
1140 &i->sink->core->silence_cache,
1141 i->sink->core->mempool,
1142 ret,
1143 &i->sample_spec,
1144 i->thread_info.resampler ? pa_resampler_max_block_size(i->thread_info.resampler) : 0);
1145
1146 return ret;
1147 }