]> code.delx.au - pulseaudio/blob - src/pulsecore/sink.c
Yes, yet another evil all-in-one commit of intervowen changes. I suck.
[pulseaudio] / src / pulsecore / sink.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 <stdlib.h>
30 #include <string.h>
31 #include <stdio.h>
32
33 #include <pulse/introspect.h>
34 #include <pulse/utf8.h>
35 #include <pulse/xmalloc.h>
36 #include <pulse/timeval.h>
37
38 #include <pulsecore/sink-input.h>
39 #include <pulsecore/namereg.h>
40 #include <pulsecore/core-util.h>
41 #include <pulsecore/sample-util.h>
42 #include <pulsecore/core-subscribe.h>
43 #include <pulsecore/log.h>
44 #include <pulsecore/macro.h>
45 #include <pulsecore/play-memblockq.h>
46
47 #include "sink.h"
48
49 #define MAX_MIX_CHANNELS 32
50 #define MIX_BUFFER_LENGTH (PA_PAGE_SIZE)
51 #define DEFAULT_MIN_LATENCY (4*PA_USEC_PER_MSEC)
52
53 static PA_DEFINE_CHECK_TYPE(pa_sink, pa_msgobject);
54
55 static void sink_free(pa_object *s);
56
57 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data) {
58 pa_assert(data);
59
60 memset(data, 0, sizeof(*data));
61 data->proplist = pa_proplist_new();
62
63 return data;
64 }
65
66 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name) {
67 pa_assert(data);
68
69 pa_xfree(data->name);
70 data->name = pa_xstrdup(name);
71 }
72
73 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec) {
74 pa_assert(data);
75
76 if ((data->sample_spec_is_set = !!spec))
77 data->sample_spec = *spec;
78 }
79
80 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map) {
81 pa_assert(data);
82
83 if ((data->channel_map_is_set = !!map))
84 data->channel_map = *map;
85 }
86
87 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume) {
88 pa_assert(data);
89
90 if ((data->volume_is_set = !!volume))
91 data->volume = *volume;
92 }
93
94 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute) {
95 pa_assert(data);
96
97 data->muted_is_set = TRUE;
98 data->muted = !!mute;
99 }
100
101 void pa_sink_new_data_done(pa_sink_new_data *data) {
102 pa_assert(data);
103
104 pa_xfree(data->name);
105 pa_proplist_free(data->proplist);
106 }
107
108 static void reset_callbacks(pa_sink *s) {
109 pa_assert(s);
110
111 s->set_state = NULL;
112 s->get_volume = NULL;
113 s->set_volume = NULL;
114 s->get_mute = NULL;
115 s->set_mute = NULL;
116 s->get_latency = NULL;
117 s->request_rewind = NULL;
118 s->update_requested_latency = NULL;
119 }
120
121 pa_sink* pa_sink_new(
122 pa_core *core,
123 pa_sink_new_data *data,
124 pa_sink_flags_t flags) {
125
126 pa_sink *s;
127 const char *name;
128 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
129 pa_source_new_data source_data;
130 const char *dn;
131
132 pa_assert(core);
133 pa_assert(data);
134 pa_assert(data->name);
135
136 s = pa_msgobject_new(pa_sink);
137
138 if (!(name = pa_namereg_register(core, data->name, PA_NAMEREG_SINK, s, data->namereg_fail))) {
139 pa_xfree(s);
140 return NULL;
141 }
142
143 pa_sink_new_data_set_name(data, name);
144
145 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_NEW], data) < 0) {
146 pa_xfree(s);
147 pa_namereg_unregister(core, name);
148 return NULL;
149 }
150
151 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
152 pa_return_null_if_fail(data->name && pa_utf8_valid(data->name) && data->name[0]);
153
154 pa_return_null_if_fail(data->sample_spec_is_set && pa_sample_spec_valid(&data->sample_spec));
155
156 if (!data->channel_map_is_set)
157 pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
158
159 pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
160 pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
161
162 if (!data->volume_is_set)
163 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
164
165 pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
166 pa_return_null_if_fail(data->volume.channels == data->sample_spec.channels);
167
168 if (!data->muted_is_set)
169 data->muted = FALSE;
170
171 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_FIXATE], data) < 0) {
172 pa_xfree(s);
173 pa_namereg_unregister(core, name);
174 return NULL;
175 }
176
177 s->parent.parent.free = sink_free;
178 s->parent.process_msg = pa_sink_process_msg;
179
180 s->core = core;
181 s->state = PA_SINK_INIT;
182 s->flags = flags;
183 s->name = pa_xstrdup(name);
184 s->proplist = pa_proplist_copy(data->proplist);
185 s->driver = pa_xstrdup(data->driver);
186 s->module = data->module;
187
188 s->sample_spec = data->sample_spec;
189 s->channel_map = data->channel_map;
190
191 s->inputs = pa_idxset_new(NULL, NULL);
192 s->n_corked = 0;
193
194 s->volume = data->volume;
195 s->muted = data->muted;
196 s->refresh_volume = s->refresh_mute = FALSE;
197
198 reset_callbacks(s);
199 s->userdata = NULL;
200
201 s->asyncmsgq = NULL;
202 s->rtpoll = NULL;
203
204 pa_silence_memchunk_get(
205 &core->silence_cache,
206 core->mempool,
207 &s->silence,
208 &s->sample_spec,
209 0);
210
211 s->min_latency = DEFAULT_MIN_LATENCY;
212 s->max_latency = s->min_latency;
213
214 s->thread_info.inputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
215 s->thread_info.soft_volume = s->volume;
216 s->thread_info.soft_muted = s->muted;
217 s->thread_info.state = s->state;
218 s->thread_info.rewind_nbytes = 0;
219 s->thread_info.max_rewind = 0;
220 s->thread_info.requested_latency_valid = FALSE;
221 s->thread_info.requested_latency = 0;
222
223 pa_assert_se(pa_idxset_put(core->sinks, s, &s->index) >= 0);
224
225 pa_log_info("Created sink %u \"%s\" with sample spec %s and channel map %s",
226 s->index,
227 s->name,
228 pa_sample_spec_snprint(st, sizeof(st), &s->sample_spec),
229 pa_channel_map_snprint(cm, sizeof(cm), &s->channel_map));
230
231 pa_source_new_data_init(&source_data);
232 pa_source_new_data_set_sample_spec(&source_data, &s->sample_spec);
233 pa_source_new_data_set_channel_map(&source_data, &s->channel_map);
234 source_data.name = pa_sprintf_malloc("%s.monitor", name);
235 source_data.driver = data->driver;
236 source_data.module = data->module;
237
238 dn = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
239 pa_proplist_setf(source_data.proplist, PA_PROP_DEVICE_DESCRIPTION, "Monitor of %s", dn ? dn : s->name);
240 pa_proplist_sets(source_data.proplist, PA_PROP_DEVICE_CLASS, "monitor");
241
242 s->monitor_source = pa_source_new(core, &source_data, 0);
243
244 pa_source_new_data_done(&source_data);
245
246 if (!s->monitor_source) {
247 pa_sink_unlink(s);
248 pa_sink_unref(s);
249 return NULL;
250 }
251
252 s->monitor_source->monitor_of = s;
253 pa_source_set_max_rewind(s->monitor_source, s->thread_info.max_rewind);
254
255 return s;
256 }
257
258 static int sink_set_state(pa_sink *s, pa_sink_state_t state) {
259 int ret;
260 pa_bool_t suspend_change;
261
262 pa_assert(s);
263
264 if (s->state == state)
265 return 0;
266
267 suspend_change =
268 (s->state == PA_SINK_SUSPENDED && PA_SINK_IS_OPENED(state)) ||
269 (PA_SINK_IS_OPENED(s->state) && state == PA_SINK_SUSPENDED);
270
271 if (s->set_state)
272 if ((ret = s->set_state(s, state)) < 0)
273 return -1;
274
275 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
276 return -1;
277
278 s->state = state;
279
280 if (suspend_change) {
281 pa_sink_input *i;
282 uint32_t idx;
283
284 /* We're suspending or resuming, tell everyone about it */
285
286 for (i = PA_SINK_INPUT(pa_idxset_first(s->inputs, &idx)); i; i = PA_SINK_INPUT(pa_idxset_next(s->inputs, &idx)))
287 if (i->suspend)
288 i->suspend(i, state == PA_SINK_SUSPENDED);
289 }
290
291 if (state != PA_SINK_UNLINKED) /* if we enter UNLINKED state pa_sink_unlink() will fire the apropriate events */
292 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_STATE_CHANGED], s);
293
294 return 0;
295 }
296
297 void pa_sink_put(pa_sink* s) {
298 pa_sink_assert_ref(s);
299
300 pa_assert(s->state == PA_SINK_INIT);
301 pa_assert(s->asyncmsgq);
302 pa_assert(s->rtpoll);
303
304 pa_assert(!s->min_latency || !s->max_latency || s->min_latency <= s->max_latency);
305
306 if (!(s->flags & PA_SINK_HW_VOLUME_CTRL))
307 s->flags |= PA_SINK_DECIBEL_VOLUME;
308
309 pa_assert_se(sink_set_state(s, PA_SINK_IDLE) == 0);
310
311 pa_source_put(s->monitor_source);
312
313 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_NEW, s->index);
314 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PUT], s);
315 }
316
317 void pa_sink_unlink(pa_sink* s) {
318 pa_bool_t linked;
319 pa_sink_input *i, *j = NULL;
320
321 pa_assert(s);
322
323 /* Please note that pa_sink_unlink() does more than simply
324 * reversing pa_sink_put(). It also undoes the registrations
325 * already done in pa_sink_new()! */
326
327 /* All operations here shall be idempotent, i.e. pa_sink_unlink()
328 * may be called multiple times on the same sink without bad
329 * effects. */
330
331 linked = PA_SINK_IS_LINKED(s->state);
332
333 if (linked)
334 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_UNLINK], s);
335
336 if (s->state != PA_SINK_UNLINKED)
337 pa_namereg_unregister(s->core, s->name);
338 pa_idxset_remove_by_data(s->core->sinks, s, NULL);
339
340 while ((i = pa_idxset_first(s->inputs, NULL))) {
341 pa_assert(i != j);
342 pa_sink_input_kill(i);
343 j = i;
344 }
345
346 if (linked)
347 sink_set_state(s, PA_SINK_UNLINKED);
348 else
349 s->state = PA_SINK_UNLINKED;
350
351 reset_callbacks(s);
352
353 if (s->monitor_source)
354 pa_source_unlink(s->monitor_source);
355
356 if (linked) {
357 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
358 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_UNLINK_POST], s);
359 }
360 }
361
362 static void sink_free(pa_object *o) {
363 pa_sink *s = PA_SINK(o);
364 pa_sink_input *i;
365
366 pa_assert(s);
367 pa_assert(pa_sink_refcnt(s) == 0);
368
369 if (PA_SINK_IS_LINKED(s->state))
370 pa_sink_unlink(s);
371
372 pa_log_info("Freeing sink %u \"%s\"", s->index, s->name);
373
374 if (s->monitor_source) {
375 pa_source_unref(s->monitor_source);
376 s->monitor_source = NULL;
377 }
378
379 pa_idxset_free(s->inputs, NULL, NULL);
380
381 while ((i = pa_hashmap_steal_first(s->thread_info.inputs)))
382 pa_sink_input_unref(i);
383
384 pa_hashmap_free(s->thread_info.inputs, NULL, NULL);
385
386 if (s->silence.memblock)
387 pa_memblock_unref(s->silence.memblock);
388
389 pa_xfree(s->name);
390 pa_xfree(s->driver);
391
392 if (s->proplist)
393 pa_proplist_free(s->proplist);
394
395 pa_xfree(s);
396 }
397
398 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q) {
399 pa_sink_assert_ref(s);
400
401 s->asyncmsgq = q;
402
403 if (s->monitor_source)
404 pa_source_set_asyncmsgq(s->monitor_source, q);
405 }
406
407 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p) {
408 pa_sink_assert_ref(s);
409
410 s->rtpoll = p;
411 if (s->monitor_source)
412 pa_source_set_rtpoll(s->monitor_source, p);
413 }
414
415 int pa_sink_update_status(pa_sink*s) {
416 pa_sink_assert_ref(s);
417 pa_assert(PA_SINK_IS_LINKED(s->state));
418
419 if (s->state == PA_SINK_SUSPENDED)
420 return 0;
421
422 return sink_set_state(s, pa_sink_used_by(s) ? PA_SINK_RUNNING : PA_SINK_IDLE);
423 }
424
425 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend) {
426 pa_sink_assert_ref(s);
427 pa_assert(PA_SINK_IS_LINKED(s->state));
428
429 if (suspend)
430 return sink_set_state(s, PA_SINK_SUSPENDED);
431 else
432 return sink_set_state(s, pa_sink_used_by(s) ? PA_SINK_RUNNING : PA_SINK_IDLE);
433 }
434
435 void pa_sink_process_rewind(pa_sink *s, size_t nbytes) {
436 pa_sink_input *i;
437 void *state = NULL;
438 pa_sink_assert_ref(s);
439 pa_assert(PA_SINK_IS_LINKED(s->state));
440
441 /* Make sure the sink code already reset the counter! */
442 pa_assert(s->thread_info.rewind_nbytes <= 0);
443
444 if (nbytes <= 0)
445 return;
446
447 pa_log_debug("Processing rewind...");
448
449 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL))) {
450 pa_sink_input_assert_ref(i);
451 pa_sink_input_process_rewind(i, nbytes);
452 }
453
454 if (s->monitor_source && PA_SOURCE_IS_OPENED(pa_source_get_state(s->monitor_source)))
455 pa_source_process_rewind(s->monitor_source, nbytes);
456
457 }
458
459 static unsigned fill_mix_info(pa_sink *s, size_t *length, pa_mix_info *info, unsigned maxinfo) {
460 pa_sink_input *i;
461 unsigned n = 0;
462 void *state = NULL;
463 size_t mixlength = *length;
464
465 pa_sink_assert_ref(s);
466 pa_assert(info);
467
468 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)) && maxinfo > 0) {
469 pa_sink_input_assert_ref(i);
470
471 if (pa_sink_input_peek(i, *length, &info->chunk, &info->volume) < 0)
472 continue;
473
474 if (mixlength == 0 || info->chunk.length < mixlength)
475 mixlength = info->chunk.length;
476
477 if (pa_memblock_is_silence(info->chunk.memblock)) {
478 pa_memblock_unref(info->chunk.memblock);
479 continue;
480 }
481
482 info->userdata = pa_sink_input_ref(i);
483
484 pa_assert(info->chunk.memblock);
485 pa_assert(info->chunk.length > 0);
486
487 info++;
488 n++;
489 maxinfo--;
490 }
491
492 if (mixlength > 0)
493 *length = mixlength;
494
495 return n;
496 }
497
498 static void inputs_drop(pa_sink *s, pa_mix_info *info, unsigned n, size_t length) {
499 pa_sink_input *i;
500 void *state = NULL;
501 unsigned p = 0;
502 unsigned n_unreffed = 0;
503
504 pa_sink_assert_ref(s);
505
506 /* We optimize for the case where the order of the inputs has not changed */
507
508 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL))) {
509 unsigned j;
510 pa_mix_info* m;
511
512 pa_sink_input_assert_ref(i);
513
514 m = NULL;
515
516 /* Let's try to find the matching entry info the pa_mix_info array */
517 for (j = 0; j < n; j ++) {
518
519 if (info[p].userdata == i) {
520 m = info + p;
521 break;
522 }
523
524 p++;
525 if (p >= n)
526 p = 0;
527 }
528
529 /* Drop read data */
530 pa_sink_input_drop(i, length);
531
532 if (m) {
533 pa_sink_input_unref(m->userdata);
534 m->userdata = NULL;
535 if (m->chunk.memblock)
536 pa_memblock_unref(m->chunk.memblock);
537 pa_memchunk_reset(&m->chunk);
538
539 n_unreffed += 1;
540 }
541 }
542
543 /* Now drop references to entries that are included in the
544 * pa_mix_info array but don't exist anymore */
545
546 if (n_unreffed < n) {
547 for (; n > 0; info++, n--) {
548 if (info->userdata)
549 pa_sink_input_unref(info->userdata);
550 if (info->chunk.memblock)
551 pa_memblock_unref(info->chunk.memblock);
552 }
553 }
554 }
555
556 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result) {
557 pa_mix_info info[MAX_MIX_CHANNELS];
558 unsigned n;
559 size_t block_size_max;
560
561 pa_sink_assert_ref(s);
562 pa_assert(PA_SINK_IS_OPENED(s->thread_info.state));
563 pa_assert(pa_frame_aligned(length, &s->sample_spec));
564 pa_assert(result);
565
566 pa_sink_ref(s);
567
568 s->thread_info.rewind_nbytes = 0;
569
570 if (length <= 0)
571 length = pa_frame_align(MIX_BUFFER_LENGTH, &s->sample_spec);
572
573 block_size_max = pa_mempool_block_size_max(s->core->mempool);
574 if (length > block_size_max)
575 length = pa_frame_align(block_size_max, &s->sample_spec);
576
577 pa_assert(length > 0);
578
579 n = s->thread_info.state == PA_SINK_RUNNING ? fill_mix_info(s, &length, info, MAX_MIX_CHANNELS) : 0;
580
581 if (n == 0) {
582
583 *result = s->silence;
584 pa_memblock_ref(result->memblock);
585
586 if (result->length > length)
587 result->length = length;
588
589 } else if (n == 1) {
590 pa_cvolume volume;
591
592 *result = info[0].chunk;
593 pa_memblock_ref(result->memblock);
594
595 if (result->length > length)
596 result->length = length;
597
598 pa_sw_cvolume_multiply(&volume, &s->thread_info.soft_volume, &info[0].volume);
599
600 if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&volume)) {
601 pa_log("adjusting volume ");
602 pa_memchunk_make_writable(result, 0);
603 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&volume))
604 pa_silence_memchunk(result, &s->sample_spec);
605 else
606 pa_volume_memchunk(result, &s->sample_spec, &volume);
607 }
608 } else {
609 void *ptr;
610 result->memblock = pa_memblock_new(s->core->mempool, length);
611
612 ptr = pa_memblock_acquire(result->memblock);
613 result->length = pa_mix(info, n,
614 ptr, length,
615 &s->sample_spec,
616 &s->thread_info.soft_volume,
617 s->thread_info.soft_muted);
618 pa_memblock_release(result->memblock);
619
620 result->index = 0;
621 }
622
623 if (s->thread_info.state == PA_SINK_RUNNING)
624 inputs_drop(s, info, n, result->length);
625
626 if (s->monitor_source && PA_SOURCE_IS_OPENED(pa_source_get_state(s->monitor_source)))
627 pa_source_post(s->monitor_source, result);
628
629 pa_sink_unref(s);
630 }
631
632 void pa_sink_render_into(pa_sink*s, pa_memchunk *target) {
633 pa_mix_info info[MAX_MIX_CHANNELS];
634 unsigned n;
635 size_t length, block_size_max;
636
637 pa_sink_assert_ref(s);
638 pa_assert(PA_SINK_IS_OPENED(s->thread_info.state));
639 pa_assert(target);
640 pa_assert(target->memblock);
641 pa_assert(target->length > 0);
642 pa_assert(pa_frame_aligned(target->length, &s->sample_spec));
643
644 pa_sink_ref(s);
645
646 s->thread_info.rewind_nbytes = 0;
647
648 length = target->length;
649 block_size_max = pa_mempool_block_size_max(s->core->mempool);
650 if (length > block_size_max)
651 length = pa_frame_align(block_size_max, &s->sample_spec);
652
653 n = s->thread_info.state == PA_SINK_RUNNING ? fill_mix_info(s, &length, info, MAX_MIX_CHANNELS) : 0;
654
655 if (n == 0) {
656 if (target->length > length)
657 target->length = length;
658
659 pa_silence_memchunk(target, &s->sample_spec);
660 } else if (n == 1) {
661 pa_cvolume volume;
662
663 if (target->length > length)
664 target->length = length;
665
666 pa_sw_cvolume_multiply(&volume, &s->thread_info.soft_volume, &info[0].volume);
667
668 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&volume))
669 pa_silence_memchunk(target, &s->sample_spec);
670 else {
671 pa_memchunk vchunk;
672
673 vchunk = info[0].chunk;
674 pa_memblock_ref(vchunk.memblock);
675
676 if (vchunk.length > target->length)
677 vchunk.length = target->length;
678
679 if (!pa_cvolume_is_norm(&volume)) {
680 pa_memchunk_make_writable(&vchunk, 0);
681 pa_volume_memchunk(&vchunk, &s->sample_spec, &volume);
682 }
683
684 pa_memchunk_memcpy(target, &vchunk);
685 pa_memblock_unref(vchunk.memblock);
686 }
687
688 } else {
689 void *ptr;
690
691 ptr = pa_memblock_acquire(target->memblock);
692
693 target->length = pa_mix(info, n,
694 (uint8_t*) ptr + target->index, length,
695 &s->sample_spec,
696 &s->thread_info.soft_volume,
697 s->thread_info.soft_muted);
698
699 pa_memblock_release(target->memblock);
700 }
701
702 if (s->thread_info.state == PA_SINK_RUNNING)
703 inputs_drop(s, info, n, target->length);
704
705 if (s->monitor_source && PA_SOURCE_IS_OPENED(pa_source_get_state(s->monitor_source)))
706 pa_source_post(s->monitor_source, target);
707
708 pa_sink_unref(s);
709 }
710
711 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target) {
712 pa_memchunk chunk;
713 size_t l, d;
714
715 pa_sink_assert_ref(s);
716 pa_assert(PA_SINK_IS_OPENED(s->thread_info.state));
717 pa_assert(target);
718 pa_assert(target->memblock);
719 pa_assert(target->length > 0);
720 pa_assert(pa_frame_aligned(target->length, &s->sample_spec));
721
722 pa_sink_ref(s);
723
724 s->thread_info.rewind_nbytes = 0;
725
726 l = target->length;
727 d = 0;
728 while (l > 0) {
729 chunk = *target;
730 chunk.index += d;
731 chunk.length -= d;
732
733 pa_sink_render_into(s, &chunk);
734
735 d += chunk.length;
736 l -= chunk.length;
737 }
738
739 pa_sink_unref(s);
740 }
741
742 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result) {
743 pa_sink_assert_ref(s);
744 pa_assert(PA_SINK_IS_OPENED(s->thread_info.state));
745 pa_assert(length > 0);
746 pa_assert(pa_frame_aligned(length, &s->sample_spec));
747 pa_assert(result);
748
749 s->thread_info.rewind_nbytes = 0;
750
751 /*** This needs optimization ***/
752
753 result->index = 0;
754 result->length = length;
755 result->memblock = pa_memblock_new(s->core->mempool, length);
756
757 pa_sink_render_into_full(s, result);
758 }
759
760 pa_usec_t pa_sink_get_latency(pa_sink *s) {
761 pa_usec_t usec = 0;
762
763 pa_sink_assert_ref(s);
764 pa_assert(PA_SINK_IS_LINKED(s->state));
765
766 /* The returned value is supposed to be in the time domain of the sound card! */
767
768 if (!PA_SINK_IS_OPENED(s->state))
769 return 0;
770
771 if (s->get_latency)
772 return s->get_latency(s);
773
774 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
775 return 0;
776
777 return usec;
778 }
779
780 void pa_sink_set_volume(pa_sink *s, const pa_cvolume *volume) {
781 int changed;
782
783 pa_sink_assert_ref(s);
784 pa_assert(PA_SINK_IS_LINKED(s->state));
785 pa_assert(volume);
786
787 changed = !pa_cvolume_equal(volume, &s->volume);
788 s->volume = *volume;
789
790 if (s->set_volume && s->set_volume(s) < 0)
791 s->set_volume = NULL;
792
793 if (!s->set_volume)
794 pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_VOLUME, pa_xnewdup(struct pa_cvolume, volume, 1), 0, NULL, pa_xfree);
795
796 if (changed)
797 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
798 }
799
800 const pa_cvolume *pa_sink_get_volume(pa_sink *s) {
801 struct pa_cvolume old_volume;
802
803 pa_sink_assert_ref(s);
804 pa_assert(PA_SINK_IS_LINKED(s->state));
805
806 old_volume = s->volume;
807
808 if (s->get_volume && s->get_volume(s) < 0)
809 s->get_volume = NULL;
810
811 if (!s->get_volume && s->refresh_volume)
812 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_VOLUME, &s->volume, 0, NULL);
813
814 if (!pa_cvolume_equal(&old_volume, &s->volume))
815 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
816
817 return &s->volume;
818 }
819
820 void pa_sink_set_mute(pa_sink *s, pa_bool_t mute) {
821 int changed;
822
823 pa_sink_assert_ref(s);
824 pa_assert(PA_SINK_IS_LINKED(s->state));
825
826 changed = s->muted != mute;
827 s->muted = mute;
828
829 if (s->set_mute && s->set_mute(s) < 0)
830 s->set_mute = NULL;
831
832 if (!s->set_mute)
833 pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_SET_MUTE, PA_UINT_TO_PTR(mute), 0, NULL, NULL);
834
835 if (changed)
836 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
837 }
838
839 pa_bool_t pa_sink_get_mute(pa_sink *s) {
840 pa_bool_t old_muted;
841
842 pa_sink_assert_ref(s);
843 pa_assert(PA_SINK_IS_LINKED(s->state));
844
845 old_muted = s->muted;
846
847 if (s->get_mute && s->get_mute(s) < 0)
848 s->get_mute = NULL;
849
850 if (!s->get_mute && s->refresh_mute)
851 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_MUTE, &s->muted, 0, NULL);
852
853 if (old_muted != s->muted)
854 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
855
856 return s->muted;
857 }
858
859 void pa_sink_set_description(pa_sink *s, const char *description) {
860 const char *old;
861 pa_sink_assert_ref(s);
862
863 if (!description && !pa_proplist_contains(s->proplist, PA_PROP_DEVICE_DESCRIPTION))
864 return;
865
866 old = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
867
868 if (old && description && !strcmp(old, description))
869 return;
870
871 if (description)
872 pa_proplist_sets(s->proplist, PA_PROP_DEVICE_DESCRIPTION, description);
873 else
874 pa_proplist_unset(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
875
876 if (s->monitor_source) {
877 char *n;
878
879 n = pa_sprintf_malloc("Monitor Source of %s", description ? description : s->name);
880 pa_source_set_description(s->monitor_source, n);
881 pa_xfree(n);
882 }
883
884 if (PA_SINK_IS_LINKED(s->state)) {
885 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
886 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SINK_PROPLIST_CHANGED], s);
887 }
888 }
889
890 unsigned pa_sink_linked_by(pa_sink *s) {
891 unsigned ret;
892
893 pa_sink_assert_ref(s);
894 pa_assert(PA_SINK_IS_LINKED(s->state));
895
896 ret = pa_idxset_size(s->inputs);
897
898 /* We add in the number of streams connected to us here. Please
899 * not the asymmmetry to pa_sink_used_by()! */
900
901 if (s->monitor_source)
902 ret += pa_source_linked_by(s->monitor_source);
903
904 return ret;
905 }
906
907 unsigned pa_sink_used_by(pa_sink *s) {
908 unsigned ret;
909
910 pa_sink_assert_ref(s);
911 pa_assert(PA_SINK_IS_LINKED(s->state));
912
913 ret = pa_idxset_size(s->inputs);
914 pa_assert(ret >= s->n_corked);
915
916 /* Streams connected to our monitor source do not matter for
917 * pa_sink_used_by()!.*/
918
919 return ret - s->n_corked;
920 }
921
922 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
923 pa_sink *s = PA_SINK(o);
924 pa_sink_assert_ref(s);
925 pa_assert(s->thread_info.state != PA_SINK_UNLINKED);
926
927 switch ((pa_sink_message_t) code) {
928
929 case PA_SINK_MESSAGE_ADD_INPUT: {
930 pa_sink_input *i = PA_SINK_INPUT(userdata);
931
932 pa_hashmap_put(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index), pa_sink_input_ref(i));
933
934 /* Since the caller sleeps in pa_sink_input_put(), we can
935 * safely access data outside of thread_info even though
936 * it is mutable */
937
938 if ((i->thread_info.sync_prev = i->sync_prev)) {
939 pa_assert(i->sink == i->thread_info.sync_prev->sink);
940 pa_assert(i->sync_prev->sync_next == i);
941 i->thread_info.sync_prev->thread_info.sync_next = i;
942 }
943
944 if ((i->thread_info.sync_next = i->sync_next)) {
945 pa_assert(i->sink == i->thread_info.sync_next->sink);
946 pa_assert(i->sync_next->sync_prev == i);
947 i->thread_info.sync_next->thread_info.sync_prev = i;
948 }
949
950 pa_assert(!i->thread_info.attached);
951 i->thread_info.attached = TRUE;
952
953 if (i->attach)
954 i->attach(i);
955
956 pa_sink_input_set_state_within_thread(i, i->state);
957
958 pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
959
960 pa_sink_invalidate_requested_latency(s);
961
962 /* We don't rewind here automatically. This is left to the
963 * sink input implementor because some sink inputs need a
964 * slow start, i.e. need some time to buffer client
965 * samples before beginning streaming. */
966
967 /* If you change anything here, make sure to change the
968 * ghost sink input handling a few lines down at
969 * PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER, too. */
970
971 return 0;
972 }
973
974 case PA_SINK_MESSAGE_REMOVE_INPUT: {
975 pa_sink_input *i = PA_SINK_INPUT(userdata);
976
977 /* If you change anything here, make sure to change the
978 * sink input handling a few lines down at
979 * PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER, too. */
980
981 pa_sink_input_set_state_within_thread(i, i->state);
982
983 if (i->detach)
984 i->detach(i);
985
986 pa_assert(i->thread_info.attached);
987 i->thread_info.attached = FALSE;
988
989 /* Since the caller sleeps in pa_sink_input_unlink(),
990 * we can safely access data outside of thread_info even
991 * though it is mutable */
992
993 pa_assert(!i->thread_info.sync_prev);
994 pa_assert(!i->thread_info.sync_next);
995
996 if (i->thread_info.sync_prev) {
997 i->thread_info.sync_prev->thread_info.sync_next = i->thread_info.sync_prev->sync_next;
998 i->thread_info.sync_prev = NULL;
999 }
1000
1001 if (i->thread_info.sync_next) {
1002 i->thread_info.sync_next->thread_info.sync_prev = i->thread_info.sync_next->sync_prev;
1003 i->thread_info.sync_next = NULL;
1004 }
1005
1006 if (pa_hashmap_remove(s->thread_info.inputs, PA_UINT32_TO_PTR(i->index)))
1007 pa_sink_input_unref(i);
1008
1009 pa_sink_invalidate_requested_latency(s);
1010 pa_sink_request_rewind(s, 0);
1011
1012 return 0;
1013 }
1014
1015 case PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER: {
1016 pa_sink_input_move_info *info = userdata;
1017 int volume_is_norm;
1018
1019 /* We don't support moving synchronized streams. */
1020 pa_assert(!info->sink_input->sync_prev);
1021 pa_assert(!info->sink_input->sync_next);
1022 pa_assert(!info->sink_input->thread_info.sync_next);
1023 pa_assert(!info->sink_input->thread_info.sync_prev);
1024
1025 if (info->sink_input->detach)
1026 info->sink_input->detach(info->sink_input);
1027
1028 pa_assert(info->sink_input->thread_info.attached);
1029 info->sink_input->thread_info.attached = FALSE;
1030 pa_sink_invalidate_requested_latency(info->sink_input->sink);
1031
1032 if (info->ghost_sink_input) {
1033 pa_assert(info->buffer_bytes > 0);
1034 pa_assert(info->buffer);
1035
1036 volume_is_norm = pa_cvolume_is_norm(&info->sink_input->thread_info.volume);
1037
1038 pa_log_debug("Buffering %lu bytes ...", (unsigned long) info->buffer_bytes);
1039
1040 while (info->buffer_bytes > 0) {
1041 pa_memchunk memchunk;
1042 pa_cvolume volume;
1043 size_t n;
1044
1045 if (pa_sink_input_peek(info->sink_input, info->buffer_bytes, &memchunk, &volume) < 0)
1046 break;
1047
1048 n = memchunk.length > info->buffer_bytes ? info->buffer_bytes : memchunk.length;
1049 pa_sink_input_drop(info->sink_input, n);
1050 memchunk.length = n;
1051
1052 if (!volume_is_norm) {
1053 pa_memchunk_make_writable(&memchunk, 0);
1054 pa_volume_memchunk(&memchunk, &s->sample_spec, &volume);
1055 }
1056
1057 if (pa_memblockq_push(info->buffer, &memchunk) < 0) {
1058 pa_memblock_unref(memchunk.memblock);
1059 break;
1060 }
1061
1062 pa_memblock_unref(memchunk.memblock);
1063 info->buffer_bytes -= n;
1064 }
1065
1066 /* Add the remaining already resampled chunks to the buffer */
1067 pa_memblockq_splice(info->buffer, info->sink_input->thread_info.render_memblockq);
1068
1069 pa_memblockq_sink_input_set_queue(info->ghost_sink_input, info->buffer);
1070
1071 pa_log_debug("Buffered %lu bytes ...", (unsigned long) pa_memblockq_get_length(info->buffer));
1072 }
1073
1074 /* Let's remove the sink input ...*/
1075 if (pa_hashmap_remove(s->thread_info.inputs, PA_UINT32_TO_PTR(info->sink_input->index)))
1076 pa_sink_input_unref(info->sink_input);
1077
1078 /* .. and add the ghost sink input instead */
1079 if (info->ghost_sink_input) {
1080 pa_hashmap_put(s->thread_info.inputs, PA_UINT32_TO_PTR(info->ghost_sink_input->index), pa_sink_input_ref(info->ghost_sink_input));
1081 info->ghost_sink_input->thread_info.sync_prev = info->ghost_sink_input->thread_info.sync_next = NULL;
1082
1083 pa_sink_input_update_max_rewind(info->ghost_sink_input, s->thread_info.max_rewind);
1084
1085 pa_assert(!info->ghost_sink_input->thread_info.attached);
1086 info->ghost_sink_input->thread_info.attached = TRUE;
1087
1088 if (info->ghost_sink_input->attach)
1089 info->ghost_sink_input->attach(info->ghost_sink_input);
1090 }
1091
1092 pa_sink_invalidate_requested_latency(s);
1093 pa_sink_request_rewind(s, 0);
1094
1095 return 0;
1096 }
1097
1098 case PA_SINK_MESSAGE_SET_VOLUME:
1099 s->thread_info.soft_volume = *((pa_cvolume*) userdata);
1100
1101 pa_sink_request_rewind(s, 0);
1102 return 0;
1103
1104 case PA_SINK_MESSAGE_SET_MUTE:
1105 s->thread_info.soft_muted = PA_PTR_TO_UINT(userdata);
1106
1107 pa_sink_request_rewind(s, 0);
1108 return 0;
1109
1110 case PA_SINK_MESSAGE_GET_VOLUME:
1111 *((pa_cvolume*) userdata) = s->thread_info.soft_volume;
1112 return 0;
1113
1114 case PA_SINK_MESSAGE_GET_MUTE:
1115 *((pa_bool_t*) userdata) = s->thread_info.soft_muted;
1116 return 0;
1117
1118 case PA_SINK_MESSAGE_SET_STATE:
1119
1120 s->thread_info.state = PA_PTR_TO_UINT(userdata);
1121 return 0;
1122
1123 case PA_SINK_MESSAGE_DETACH:
1124
1125 /* We're detaching all our input streams so that the
1126 * asyncmsgq and rtpoll fields can be changed without
1127 * problems */
1128 pa_sink_detach_within_thread(s);
1129 return 0;
1130
1131 case PA_SINK_MESSAGE_ATTACH:
1132
1133 /* Reattach all streams */
1134 pa_sink_attach_within_thread(s);
1135 return 0;
1136
1137 case PA_SINK_MESSAGE_GET_REQUESTED_LATENCY: {
1138
1139 pa_usec_t *usec = userdata;
1140 *usec = pa_sink_get_requested_latency_within_thread(s);
1141 return 0;
1142 }
1143
1144 case PA_SINK_MESSAGE_GET_LATENCY:
1145 case PA_SINK_MESSAGE_MAX:
1146 ;
1147 }
1148
1149 return -1;
1150 }
1151
1152 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend) {
1153 pa_sink *sink;
1154 uint32_t idx;
1155 int ret = 0;
1156
1157 pa_core_assert_ref(c);
1158
1159 for (sink = PA_SINK(pa_idxset_first(c->sinks, &idx)); sink; sink = PA_SINK(pa_idxset_next(c->sinks, &idx)))
1160 ret -= pa_sink_suspend(sink, suspend) < 0;
1161
1162 return ret;
1163 }
1164
1165 void pa_sink_detach(pa_sink *s) {
1166 pa_sink_assert_ref(s);
1167 pa_assert(PA_SINK_IS_LINKED(s->state));
1168
1169 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_DETACH, NULL, 0, NULL);
1170 }
1171
1172 void pa_sink_attach(pa_sink *s) {
1173 pa_sink_assert_ref(s);
1174 pa_assert(PA_SINK_IS_LINKED(s->state));
1175
1176 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_ATTACH, NULL, 0, NULL);
1177 }
1178
1179 void pa_sink_detach_within_thread(pa_sink *s) {
1180 pa_sink_input *i;
1181 void *state = NULL;
1182
1183 pa_sink_assert_ref(s);
1184 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1185
1186 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
1187 if (i->detach)
1188 i->detach(i);
1189
1190 if (s->monitor_source)
1191 pa_source_detach_within_thread(s->monitor_source);
1192 }
1193
1194 void pa_sink_attach_within_thread(pa_sink *s) {
1195 pa_sink_input *i;
1196 void *state = NULL;
1197
1198 pa_sink_assert_ref(s);
1199 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1200
1201 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
1202 if (i->attach)
1203 i->attach(i);
1204
1205 if (s->monitor_source)
1206 pa_source_attach_within_thread(s->monitor_source);
1207 }
1208
1209 void pa_sink_request_rewind(pa_sink*s, size_t nbytes) {
1210 pa_sink_assert_ref(s);
1211 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1212
1213 if (nbytes <= 0)
1214 nbytes = s->thread_info.max_rewind;
1215
1216 nbytes = PA_MIN(nbytes, s->thread_info.max_rewind);
1217
1218 if (nbytes <= s->thread_info.rewind_nbytes)
1219 return;
1220
1221 s->thread_info.rewind_nbytes = nbytes;
1222
1223 if (s->request_rewind)
1224 s->request_rewind(s);
1225 }
1226
1227 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s) {
1228 pa_usec_t result = (pa_usec_t) -1;
1229 pa_sink_input *i;
1230 void *state = NULL;
1231
1232 pa_sink_assert_ref(s);
1233
1234 if (s->thread_info.requested_latency_valid)
1235 return s->thread_info.requested_latency;
1236
1237 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
1238
1239 if (i->thread_info.requested_sink_latency != (pa_usec_t) -1 &&
1240 (result == (pa_usec_t) -1 || result > i->thread_info.requested_sink_latency))
1241 result = i->thread_info.requested_sink_latency;
1242
1243 if (result != (pa_usec_t) -1) {
1244 if (s->max_latency > 0 && result > s->max_latency)
1245 result = s->max_latency;
1246
1247 if (s->min_latency > 0 && result < s->min_latency)
1248 result = s->min_latency;
1249 }
1250
1251 s->thread_info.requested_latency = result;
1252 s->thread_info.requested_latency_valid = TRUE;
1253
1254 return result;
1255 }
1256
1257 pa_usec_t pa_sink_get_requested_latency(pa_sink *s) {
1258 pa_usec_t usec = 0;
1259
1260 pa_sink_assert_ref(s);
1261 pa_assert(PA_SINK_IS_LINKED(s->state));
1262
1263 if (!PA_SINK_IS_OPENED(s->state))
1264 return 0;
1265
1266 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SINK_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) < 0)
1267 return 0;
1268
1269 if (usec == (pa_usec_t) -1)
1270 usec = s->max_latency;
1271
1272 return usec;
1273 }
1274
1275 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind) {
1276 pa_sink_input *i;
1277 void *state = NULL;
1278
1279 pa_sink_assert_ref(s);
1280
1281 if (max_rewind == s->thread_info.max_rewind)
1282 return;
1283
1284 s->thread_info.max_rewind = max_rewind;
1285
1286 while ((i = pa_hashmap_iterate(s->thread_info.inputs, &state, NULL)))
1287 pa_sink_input_update_max_rewind(i, s->thread_info.max_rewind);
1288
1289 if (s->monitor_source)
1290 pa_source_set_max_rewind(s->monitor_source, s->thread_info.max_rewind);
1291 }
1292
1293 void pa_sink_invalidate_requested_latency(pa_sink *s) {
1294
1295 pa_sink_assert_ref(s);
1296 pa_assert(PA_SINK_IS_LINKED(s->thread_info.state));
1297
1298 if (!s->thread_info.requested_latency_valid)
1299 return;
1300
1301 s->thread_info.requested_latency_valid = FALSE;
1302
1303 if (s->update_requested_latency)
1304 s->update_requested_latency(s);
1305 }