]> code.delx.au - pulseaudio/blob - src/pulsecore/sink-input.c
delx.au / code / pulseaudio / blob


e41afc9ba82d3eb5992191fe94fbe63210f8ab04
[pulseaudio] / src / pulsecore / sink-input.c
1 /***
2 This file is part of PulseAudio.
3
4 Copyright 2004-2006 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
6
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2.1 of the License,
10 or (at your option) any later version.
11
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA.
21 ***/
22
23 #ifdef HAVE_CONFIG_H
24 #include <config.h>
25 #endif
26
27 #include <stdio.h>
28 #include <stdlib.h>
29
30 #include <pulse/utf8.h>
31 #include <pulse/xmalloc.h>
32 #include <pulse/util.h>
33 #include <pulse/internal.h>
34
35 #include <pulsecore/core-format.h>
36 #include <pulsecore/mix.h>
37 #include <pulsecore/stream-util.h>
38 #include <pulsecore/core-subscribe.h>
39 #include <pulsecore/log.h>
40 #include <pulsecore/play-memblockq.h>
41 #include <pulsecore/namereg.h>
42 #include <pulsecore/core-util.h>
43
44 #include "sink-input.h"
45
46 /* #define SINK_INPUT_DEBUG */
47
48 #define MEMBLOCKQ_MAXLENGTH (32*1024*1024)
49 #define CONVERT_BUFFER_LENGTH (PA_PAGE_SIZE)
50
51 PA_DEFINE_PUBLIC_CLASS(pa_sink_input, pa_msgobject);
52
53 struct volume_factor_entry {
54 char *key;
55 pa_cvolume volume;
56 };
57
58 static struct volume_factor_entry *volume_factor_entry_new(const char *key, const pa_cvolume *volume) {
59 struct volume_factor_entry *entry;
60
61 pa_assert(key);
62 pa_assert(volume);
63
64 entry = pa_xnew(struct volume_factor_entry, 1);
65 entry->key = pa_xstrdup(key);
66
67 entry->volume = *volume;
68
69 return entry;
70 }
71
72 static void volume_factor_entry_free(struct volume_factor_entry *volume_entry) {
73 pa_assert(volume_entry);
74
75 pa_xfree(volume_entry->key);
76 pa_xfree(volume_entry);
77 }
78
79 static void volume_factor_from_hashmap(pa_cvolume *v, pa_hashmap *items, uint8_t channels) {
80 struct volume_factor_entry *entry;
81 void *state = NULL;
82
83 pa_cvolume_reset(v, channels);
84 PA_HASHMAP_FOREACH(entry, items, state)
85 pa_sw_cvolume_multiply(v, v, &entry->volume);
86 }
87
88 static void sink_input_free(pa_object *o);
89 static void set_real_ratio(pa_sink_input *i, const pa_cvolume *v);
90
91 static int check_passthrough_connection(bool passthrough, pa_sink *dest) {
92 if (pa_sink_is_passthrough(dest)) {
93 pa_log_warn("Sink is already connected to PASSTHROUGH input");
94 return -PA_ERR_BUSY;
95 }
96
97 /* If current input(s) exist, check new input is not PASSTHROUGH */
98 if (pa_idxset_size(dest->inputs) > 0 && passthrough) {
99 pa_log_warn("Sink is already connected, cannot accept new PASSTHROUGH INPUT");
100 return -PA_ERR_BUSY;
101 }
102
103 return PA_OK;
104 }
105
106 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data) {
107 pa_assert(data);
108
109 pa_zero(*data);
110 data->resample_method = PA_RESAMPLER_INVALID;
111 data->proplist = pa_proplist_new();
112 data->volume_writable = true;
113
114 data->volume_factor_items = pa_hashmap_new_full(pa_idxset_string_hash_func, pa_idxset_string_compare_func, NULL,
115 (pa_free_cb_t) volume_factor_entry_free);
116 data->volume_factor_sink_items = pa_hashmap_new_full(pa_idxset_string_hash_func, pa_idxset_string_compare_func, NULL,
117 (pa_free_cb_t) volume_factor_entry_free);
118
119 return data;
120 }
121
122 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec) {
123 pa_assert(data);
124
125 if ((data->sample_spec_is_set = !!spec))
126 data->sample_spec = *spec;
127 }
128
129 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map) {
130 pa_assert(data);
131
132 if ((data->channel_map_is_set = !!map))
133 data->channel_map = *map;
134 }
135
136 bool pa_sink_input_new_data_is_passthrough(pa_sink_input_new_data *data) {
137 pa_assert(data);
138
139 if (PA_LIKELY(data->format) && PA_UNLIKELY(!pa_format_info_is_pcm(data->format)))
140 return true;
141
142 if (PA_UNLIKELY(data->flags & PA_SINK_INPUT_PASSTHROUGH))
143 return true;
144
145 return false;
146 }
147
148 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume) {
149 pa_assert(data);
150 pa_assert(data->volume_writable);
151
152 if ((data->volume_is_set = !!volume))
153 data->volume = *volume;
154 }
155
156 void pa_sink_input_new_data_add_volume_factor(pa_sink_input_new_data *data, const char *key, const pa_cvolume *volume_factor) {
157 struct volume_factor_entry *v;
158
159 pa_assert(data);
160 pa_assert(key);
161 pa_assert(volume_factor);
162
163 v = volume_factor_entry_new(key, volume_factor);
164 pa_assert_se(pa_hashmap_put(data->volume_factor_items, v->key, v) >= 0);
165 }
166
167 void pa_sink_input_new_data_add_volume_factor_sink(pa_sink_input_new_data *data, const char *key, const pa_cvolume *volume_factor) {
168 struct volume_factor_entry *v;
169
170 pa_assert(data);
171 pa_assert(key);
172 pa_assert(volume_factor);
173
174 v = volume_factor_entry_new(key, volume_factor);
175 pa_assert_se(pa_hashmap_put(data->volume_factor_sink_items, v->key, v) >= 0);
176 }
177
178 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, bool mute) {
179 pa_assert(data);
180
181 data->muted_is_set = true;
182 data->muted = !!mute;
183 }
184
185 bool pa_sink_input_new_data_set_sink(pa_sink_input_new_data *data, pa_sink *s, bool save) {
186 bool ret = true;
187 pa_idxset *formats = NULL;
188
189 pa_assert(data);
190 pa_assert(s);
191
192 if (!data->req_formats) {
193 /* We're not working with the extended API */
194 data->sink = s;
195 data->save_sink = save;
196 } else {
197 /* Extended API: let's see if this sink supports the formats the client can provide */
198 formats = pa_sink_check_formats(s, data->req_formats);
199
200 if (formats && !pa_idxset_isempty(formats)) {
201 /* Sink supports at least one of the requested formats */
202 data->sink = s;
203 data->save_sink = save;
204 if (data->nego_formats)
205 pa_idxset_free(data->nego_formats, (pa_free_cb_t) pa_format_info_free);
206 data->nego_formats = formats;
207 } else {
208 /* Sink doesn't support any of the formats requested by the client */
209 if (formats)
210 pa_idxset_free(formats, (pa_free_cb_t) pa_format_info_free);
211 ret = false;
212 }
213 }
214
215 return ret;
216 }
217
218 bool pa_sink_input_new_data_set_formats(pa_sink_input_new_data *data, pa_idxset *formats) {
219 pa_assert(data);
220 pa_assert(formats);
221
222 if (data->req_formats)
223 pa_idxset_free(data->req_formats, (pa_free_cb_t) pa_format_info_free);
224
225 data->req_formats = formats;
226
227 if (data->sink) {
228 /* Trigger format negotiation */
229 return pa_sink_input_new_data_set_sink(data, data->sink, data->save_sink);
230 }
231
232 return true;
233 }
234
235 void pa_sink_input_new_data_done(pa_sink_input_new_data *data) {
236 pa_assert(data);
237
238 if (data->req_formats)
239 pa_idxset_free(data->req_formats, (pa_free_cb_t) pa_format_info_free);
240
241 if (data->nego_formats)
242 pa_idxset_free(data->nego_formats, (pa_free_cb_t) pa_format_info_free);
243
244 if (data->format)
245 pa_format_info_free(data->format);
246
247 if (data->volume_factor_items)
248 pa_hashmap_free(data->volume_factor_items);
249
250 if (data->volume_factor_sink_items)
251 pa_hashmap_free(data->volume_factor_sink_items);
252
253 pa_proplist_free(data->proplist);
254 }
255
256 /* Called from main context */
257 static void reset_callbacks(pa_sink_input *i) {
258 pa_assert(i);
259
260 i->pop = NULL;
261 i->process_underrun = NULL;
262 i->process_rewind = NULL;
263 i->update_max_rewind = NULL;
264 i->update_max_request = NULL;
265 i->update_sink_requested_latency = NULL;
266 i->update_sink_latency_range = NULL;
267 i->update_sink_fixed_latency = NULL;
268 i->attach = NULL;
269 i->detach = NULL;
270 i->suspend = NULL;
271 i->suspend_within_thread = NULL;
272 i->moving = NULL;
273 i->kill = NULL;
274 i->get_latency = NULL;
275 i->state_change = NULL;
276 i->may_move_to = NULL;
277 i->send_event = NULL;
278 i->volume_changed = NULL;
279 i->mute_changed = NULL;
280 }
281
282 /* Called from main context */
283 int pa_sink_input_new(
284 pa_sink_input **_i,
285 pa_core *core,
286 pa_sink_input_new_data *data) {
287
288 pa_sink_input *i;
289 pa_resampler *resampler = NULL;
290 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX], fmt[PA_FORMAT_INFO_SNPRINT_MAX];
291 pa_channel_map volume_map;
292 int r;
293 char *pt;
294 char *memblockq_name;
295
296 pa_assert(_i);
297 pa_assert(core);
298 pa_assert(data);
299 pa_assert_ctl_context();
300
301 if (data->client)
302 pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->client->proplist);
303
304 if (data->origin_sink && (data->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER))
305 data->volume_writable = false;
306
307 if (!data->req_formats) {
308 /* From this point on, we want to work only with formats, and get back
309 * to using the sample spec and channel map after all decisions w.r.t.
310 * routing are complete. */
311 pa_format_info *f;
312 pa_idxset *formats;
313
314 f = pa_format_info_from_sample_spec2(&data->sample_spec, data->channel_map_is_set ? &data->channel_map : NULL,
315 !(data->flags & PA_SINK_INPUT_FIX_FORMAT),
316 !(data->flags & PA_SINK_INPUT_FIX_RATE),
317 !(data->flags & PA_SINK_INPUT_FIX_CHANNELS));
318 if (!f)
319 return -PA_ERR_INVALID;
320
321 formats = pa_idxset_new(NULL, NULL);
322 pa_idxset_put(formats, f, NULL);
323 pa_sink_input_new_data_set_formats(data, formats);
324 }
325
326 if ((r = pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_NEW], data)) < 0)
327 return r;
328
329 pa_return_val_if_fail(!data->driver || pa_utf8_valid(data->driver), -PA_ERR_INVALID);
330
331 if (!data->sink) {
332 pa_sink *sink = pa_namereg_get(core, NULL, PA_NAMEREG_SINK);
333 pa_return_val_if_fail(sink, -PA_ERR_NOENTITY);
334 pa_sink_input_new_data_set_sink(data, sink, false);
335 }
336
337 /* If something didn't pick a format for us, pick the top-most format since
338 * we assume this is sorted in priority order */
339 if (!data->format && data->nego_formats && !pa_idxset_isempty(data->nego_formats))
340 data->format = pa_format_info_copy(pa_idxset_first(data->nego_formats, NULL));
341
342 if (PA_LIKELY(data->format)) {
343 pa_log_debug("Negotiated format: %s", pa_format_info_snprint(fmt, sizeof(fmt), data->format));
344 } else {
345 pa_format_info *format;
346 uint32_t idx;
347
348 pa_log_info("Sink does not support any requested format:");
349 PA_IDXSET_FOREACH(format, data->req_formats, idx)
350 pa_log_info(" -- %s", pa_format_info_snprint(fmt, sizeof(fmt), format));
351
352 return -PA_ERR_NOTSUPPORTED;
353 }
354
355 pa_return_val_if_fail(PA_SINK_IS_LINKED(pa_sink_get_state(data->sink)), -PA_ERR_BADSTATE);
356 pa_return_val_if_fail(!data->sync_base || (data->sync_base->sink == data->sink
357 && pa_sink_input_get_state(data->sync_base) == PA_SINK_INPUT_CORKED),
358 -PA_ERR_INVALID);
359
360 /* Routing is done. We have a sink and a format. */
361
362 if (data->volume_is_set && pa_format_info_is_pcm(data->format)) {
363 /* If volume is set, we need to save the original data->channel_map,
364 * so that we can remap the volume from the original channel map to the
365 * final channel map of the stream in case data->channel_map gets
366 * modified in pa_format_info_to_sample_spec2(). */
367 r = pa_stream_get_volume_channel_map(&data->volume, data->channel_map_is_set ? &data->channel_map : NULL, data->format, &volume_map);
368 if (r < 0)
369 return r;
370 }
371
372 /* Now populate the sample spec and channel map according to the final
373 * format that we've negotiated */
374 r = pa_format_info_to_sample_spec2(data->format, &data->sample_spec, &data->channel_map, &data->sink->sample_spec,
375 &data->sink->channel_map);
376 if (r < 0)
377 return r;
378
379 r = check_passthrough_connection(pa_sink_input_new_data_is_passthrough(data), data->sink);
380 if (r != PA_OK)
381 return r;
382
383 /* Don't restore (or save) stream volume for passthrough streams and
384 * prevent attenuation/gain */
385 if (pa_sink_input_new_data_is_passthrough(data)) {
386 data->volume_is_set = true;
387 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
388 data->volume_is_absolute = true;
389 data->save_volume = false;
390 }
391
392 if (!data->volume_is_set) {
393 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
394 data->volume_is_absolute = false;
395 data->save_volume = false;
396 }
397
398 if (!data->volume_writable)
399 data->save_volume = false;
400
401 if (data->volume_is_set)
402 /* The original volume channel map may be different than the final
403 * stream channel map, so remapping may be needed. */
404 pa_cvolume_remap(&data->volume, &volume_map, &data->channel_map);
405
406 if (!data->muted_is_set)
407 data->muted = false;
408
409 if (!(data->flags & PA_SINK_INPUT_VARIABLE_RATE) &&
410 !pa_sample_spec_equal(&data->sample_spec, &data->sink->sample_spec)) {
411 /* try to change sink rate. This is done before the FIXATE hook since
412 module-suspend-on-idle can resume a sink */
413
414 pa_log_info("Trying to change sample rate");
415 if (pa_sink_update_rate(data->sink, data->sample_spec.rate, pa_sink_input_new_data_is_passthrough(data)) >= 0)
416 pa_log_info("Rate changed to %u Hz", data->sink->sample_spec.rate);
417 }
418
419 if (pa_sink_input_new_data_is_passthrough(data) &&
420 !pa_sample_spec_equal(&data->sample_spec, &data->sink->sample_spec)) {
421 /* rate update failed, or other parts of sample spec didn't match */
422
423 pa_log_debug("Could not update sink sample spec to match passthrough stream");
424 return -PA_ERR_NOTSUPPORTED;
425 }
426
427 if (data->resample_method == PA_RESAMPLER_INVALID)
428 data->resample_method = core->resample_method;
429
430 pa_return_val_if_fail(data->resample_method < PA_RESAMPLER_MAX, -PA_ERR_INVALID);
431
432 if ((r = pa_hook_fire(&core->hooks[PA_CORE_HOOK_SINK_INPUT_FIXATE], data)) < 0)
433 return r;
434
435 if ((data->flags & PA_SINK_INPUT_NO_CREATE_ON_SUSPEND) &&
436 pa_sink_get_state(data->sink) == PA_SINK_SUSPENDED) {
437 pa_log_warn("Failed to create sink input: sink is suspended.");
438 return -PA_ERR_BADSTATE;
439 }
440
441 if (pa_idxset_size(data->sink->inputs) >= PA_MAX_INPUTS_PER_SINK) {
442 pa_log_warn("Failed to create sink input: too many inputs per sink.");
443 return -PA_ERR_TOOLARGE;
444 }
445
446 if ((data->flags & PA_SINK_INPUT_VARIABLE_RATE) ||
447 !pa_sample_spec_equal(&data->sample_spec, &data->sink->sample_spec) ||
448 !pa_channel_map_equal(&data->channel_map, &data->sink->channel_map)) {
449
450 /* Note: for passthrough content we need to adjust the output rate to that of the current sink-input */
451 if (!pa_sink_input_new_data_is_passthrough(data)) /* no resampler for passthrough content */
452 if (!(resampler = pa_resampler_new(
453 core->mempool,
454 &data->sample_spec, &data->channel_map,
455 &data->sink->sample_spec, &data->sink->channel_map,
456 data->resample_method,
457 ((data->flags & PA_SINK_INPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
458 ((data->flags & PA_SINK_INPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
459 (core->disable_remixing || (data->flags & PA_SINK_INPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0) |
460 (core->disable_lfe_remixing ? PA_RESAMPLER_NO_LFE : 0)))) {
461 pa_log_warn("Unsupported resampling operation.");
462 return -PA_ERR_NOTSUPPORTED;
463 }
464 }
465
466 i = pa_msgobject_new(pa_sink_input);
467 i->parent.parent.free = sink_input_free;
468 i->parent.process_msg = pa_sink_input_process_msg;
469
470 i->core = core;
471 i->state = PA_SINK_INPUT_INIT;
472 i->flags = data->flags;
473 i->proplist = pa_proplist_copy(data->proplist);
474 i->driver = pa_xstrdup(pa_path_get_filename(data->driver));
475 i->module = data->module;
476 i->sink = data->sink;
477 i->origin_sink = data->origin_sink;
478 i->client = data->client;
479
480 i->requested_resample_method = data->resample_method;
481 i->actual_resample_method = resampler ? pa_resampler_get_method(resampler) : PA_RESAMPLER_INVALID;
482 i->sample_spec = data->sample_spec;
483 i->channel_map = data->channel_map;
484 i->format = pa_format_info_copy(data->format);
485
486 if (!data->volume_is_absolute && pa_sink_flat_volume_enabled(i->sink)) {
487 pa_cvolume remapped;
488
489 /* When the 'absolute' bool is not set then we'll treat the volume
490 * as relative to the sink volume even in flat volume mode */
491 remapped = data->sink->reference_volume;
492 pa_cvolume_remap(&remapped, &data->sink->channel_map, &data->channel_map);
493 pa_sw_cvolume_multiply(&i->volume, &data->volume, &remapped);
494 } else
495 i->volume = data->volume;
496
497 i->volume_factor_items = data->volume_factor_items;
498 data->volume_factor_items = NULL;
499 volume_factor_from_hashmap(&i->volume_factor, i->volume_factor_items, i->sample_spec.channels);
500
501 i->volume_factor_sink_items = data->volume_factor_sink_items;
502 data->volume_factor_sink_items = NULL;
503 volume_factor_from_hashmap(&i->volume_factor_sink, i->volume_factor_sink_items, i->sink->sample_spec.channels);
504
505 i->real_ratio = i->reference_ratio = data->volume;
506 pa_cvolume_reset(&i->soft_volume, i->sample_spec.channels);
507 pa_cvolume_reset(&i->real_ratio, i->sample_spec.channels);
508 i->volume_writable = data->volume_writable;
509 i->save_volume = data->save_volume;
510 i->save_sink = data->save_sink;
511 i->save_muted = data->save_muted;
512
513 i->muted = data->muted;
514
515 if (data->sync_base) {
516 i->sync_next = data->sync_base->sync_next;
517 i->sync_prev = data->sync_base;
518
519 if (data->sync_base->sync_next)
520 data->sync_base->sync_next->sync_prev = i;
521 data->sync_base->sync_next = i;
522 } else
523 i->sync_next = i->sync_prev = NULL;
524
525 i->direct_outputs = pa_idxset_new(NULL, NULL);
526
527 reset_callbacks(i);
528 i->userdata = NULL;
529
530 i->thread_info.state = i->state;
531 i->thread_info.attached = false;
532 pa_atomic_store(&i->thread_info.drained, 1);
533 i->thread_info.sample_spec = i->sample_spec;
534 i->thread_info.resampler = resampler;
535 i->thread_info.soft_volume = i->soft_volume;
536 i->thread_info.muted = i->muted;
537 i->thread_info.requested_sink_latency = (pa_usec_t) -1;
538 i->thread_info.rewrite_nbytes = 0;
539 i->thread_info.rewrite_flush = false;
540 i->thread_info.dont_rewind_render = false;
541 i->thread_info.underrun_for = (uint64_t) -1;
542 i->thread_info.underrun_for_sink = 0;
543 i->thread_info.playing_for = 0;
544 i->thread_info.direct_outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
545
546 pa_assert_se(pa_idxset_put(core->sink_inputs, i, &i->index) == 0);
547 pa_assert_se(pa_idxset_put(i->sink->inputs, pa_sink_input_ref(i), NULL) == 0);
548
549 if (i->client)
550 pa_assert_se(pa_idxset_put(i->client->sink_inputs, i, NULL) >= 0);
551
552 memblockq_name = pa_sprintf_malloc("sink input render_memblockq [%u]", i->index);
553 i->thread_info.render_memblockq = pa_memblockq_new(
554 memblockq_name,
555 0,
556 MEMBLOCKQ_MAXLENGTH,
557 0,
558 &i->sink->sample_spec,
559 0,
560 1,
561 0,
562 &i->sink->silence);
563 pa_xfree(memblockq_name);
564
565 pt = pa_proplist_to_string_sep(i->proplist, "\n ");
566 pa_log_info("Created input %u \"%s\" on %s with sample spec %s and channel map %s\n %s",
567 i->index,
568 pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)),
569 i->sink->name,
570 pa_sample_spec_snprint(st, sizeof(st), &i->sample_spec),
571 pa_channel_map_snprint(cm, sizeof(cm), &i->channel_map),
572 pt);
573 pa_xfree(pt);
574
575 /* Don't forget to call pa_sink_input_put! */
576
577 *_i = i;
578 return 0;
579 }
580
581 /* Called from main context */
582 static void update_n_corked(pa_sink_input *i, pa_sink_input_state_t state) {
583 pa_assert(i);
584 pa_assert_ctl_context();
585
586 if (!i->sink)
587 return;
588
589 if (i->state == PA_SINK_INPUT_CORKED && state != PA_SINK_INPUT_CORKED)
590 pa_assert_se(i->sink->n_corked -- >= 1);
591 else if (i->state != PA_SINK_INPUT_CORKED && state == PA_SINK_INPUT_CORKED)
592 i->sink->n_corked++;
593 }
594
595 /* Called from main context */
596 static void sink_input_set_state(pa_sink_input *i, pa_sink_input_state_t state) {
597 pa_sink_input *ssync;
598 pa_assert(i);
599 pa_assert_ctl_context();
600
601 if (state == PA_SINK_INPUT_DRAINED)
602 state = PA_SINK_INPUT_RUNNING;
603
604 if (i->state == state)
605 return;
606
607 if (i->state == PA_SINK_INPUT_CORKED && state == PA_SINK_INPUT_RUNNING && pa_sink_used_by(i->sink) == 0 &&
608 !pa_sample_spec_equal(&i->sample_spec, &i->sink->sample_spec)) {
609 /* We were uncorked and the sink was not playing anything -- let's try
610 * to update the sample rate to avoid resampling */
611 pa_sink_update_rate(i->sink, i->sample_spec.rate, pa_sink_input_is_passthrough(i));
612 }
613
614 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) == 0);
615
616 update_n_corked(i, state);
617 i->state = state;
618
619 for (ssync = i->sync_prev; ssync; ssync = ssync->sync_prev) {
620 update_n_corked(ssync, state);
621 ssync->state = state;
622 }
623 for (ssync = i->sync_next; ssync; ssync = ssync->sync_next) {
624 update_n_corked(ssync, state);
625 ssync->state = state;
626 }
627
628 if (state != PA_SINK_INPUT_UNLINKED) {
629 pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], i);
630
631 for (ssync = i->sync_prev; ssync; ssync = ssync->sync_prev)
632 pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], ssync);
633
634 for (ssync = i->sync_next; ssync; ssync = ssync->sync_next)
635 pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED], ssync);
636
637 if (PA_SINK_INPUT_IS_LINKED(state))
638 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
639 }
640
641 pa_sink_update_status(i->sink);
642 }
643
644 /* Called from main context */
645 void pa_sink_input_unlink(pa_sink_input *i) {
646 bool linked;
647 pa_source_output *o, *p = NULL;
648
649 pa_assert(i);
650 pa_assert_ctl_context();
651
652 /* See pa_sink_unlink() for a couple of comments how this function
653 * works */
654
655 pa_sink_input_ref(i);
656
657 linked = PA_SINK_INPUT_IS_LINKED(i->state);
658
659 if (linked)
660 pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK], i);
661
662 if (i->sync_prev)
663 i->sync_prev->sync_next = i->sync_next;
664 if (i->sync_next)
665 i->sync_next->sync_prev = i->sync_prev;
666
667 i->sync_prev = i->sync_next = NULL;
668
669 pa_idxset_remove_by_data(i->core->sink_inputs, i, NULL);
670
671 if (i->sink)
672 if (pa_idxset_remove_by_data(i->sink->inputs, i, NULL))
673 pa_sink_input_unref(i);
674
675 if (i->client)
676 pa_idxset_remove_by_data(i->client->sink_inputs, i, NULL);
677
678 while ((o = pa_idxset_first(i->direct_outputs, NULL))) {
679 pa_assert(o != p);
680 pa_source_output_kill(o);
681 p = o;
682 }
683
684 update_n_corked(i, PA_SINK_INPUT_UNLINKED);
685 i->state = PA_SINK_INPUT_UNLINKED;
686
687 if (linked && i->sink) {
688 if (pa_sink_input_is_passthrough(i))
689 pa_sink_leave_passthrough(i->sink);
690
691 /* We might need to update the sink's volume if we are in flat volume mode. */
692 if (pa_sink_flat_volume_enabled(i->sink))
693 pa_sink_set_volume(i->sink, NULL, false, false);
694
695 if (i->sink->asyncmsgq)
696 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_REMOVE_INPUT, i, 0, NULL) == 0);
697 }
698
699 reset_callbacks(i);
700
701 if (linked) {
702 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_REMOVE, i->index);
703 pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK_POST], i);
704 }
705
706 if (i->sink) {
707 if (PA_SINK_IS_LINKED(pa_sink_get_state(i->sink)))
708 pa_sink_update_status(i->sink);
709
710 i->sink = NULL;
711 }
712
713 pa_core_maybe_vacuum(i->core);
714
715 pa_sink_input_unref(i);
716 }
717
718 /* Called from main context */
719 static void sink_input_free(pa_object *o) {
720 pa_sink_input* i = PA_SINK_INPUT(o);
721
722 pa_assert(i);
723 pa_assert_ctl_context();
724 pa_assert(pa_sink_input_refcnt(i) == 0);
725
726 if (PA_SINK_INPUT_IS_LINKED(i->state))
727 pa_sink_input_unlink(i);
728
729 pa_log_info("Freeing input %u \"%s\"", i->index,
730 i->proplist ? pa_strnull(pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME)) : "");
731
732 /* Side note: this function must be able to destruct properly any
733 * kind of sink input in any state, even those which are
734 * "half-moved" or are connected to sinks that have no asyncmsgq
735 * and are hence half-destructed themselves! */
736
737 if (i->thread_info.render_memblockq)
738 pa_memblockq_free(i->thread_info.render_memblockq);
739
740 if (i->thread_info.resampler)
741 pa_resampler_free(i->thread_info.resampler);
742
743 if (i->format)
744 pa_format_info_free(i->format);
745
746 if (i->proplist)
747 pa_proplist_free(i->proplist);
748
749 if (i->direct_outputs)
750 pa_idxset_free(i->direct_outputs, NULL);
751
752 if (i->thread_info.direct_outputs)
753 pa_hashmap_free(i->thread_info.direct_outputs);
754
755 if (i->volume_factor_items)
756 pa_hashmap_free(i->volume_factor_items);
757
758 if (i->volume_factor_sink_items)
759 pa_hashmap_free(i->volume_factor_sink_items);
760
761 pa_xfree(i->driver);
762 pa_xfree(i);
763 }
764
765 /* Called from main context */
766 void pa_sink_input_put(pa_sink_input *i) {
767 pa_sink_input_state_t state;
768
769 pa_sink_input_assert_ref(i);
770 pa_assert_ctl_context();
771
772 pa_assert(i->state == PA_SINK_INPUT_INIT);
773
774 /* The following fields must be initialized properly */
775 pa_assert(i->pop);
776 pa_assert(i->process_rewind);
777 pa_assert(i->kill);
778
779 state = i->flags & PA_SINK_INPUT_START_CORKED ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING;
780
781 update_n_corked(i, state);
782 i->state = state;
783
784 /* We might need to update the sink's volume if we are in flat volume mode. */
785 if (pa_sink_flat_volume_enabled(i->sink))
786 pa_sink_set_volume(i->sink, NULL, false, i->save_volume);
787 else {
788 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
789 pa_assert(pa_cvolume_is_norm(&i->volume));
790 pa_assert(pa_cvolume_is_norm(&i->reference_ratio));
791 }
792
793 set_real_ratio(i, &i->volume);
794 }
795
796 if (pa_sink_input_is_passthrough(i))
797 pa_sink_enter_passthrough(i->sink);
798
799 i->thread_info.soft_volume = i->soft_volume;
800 i->thread_info.muted = i->muted;
801
802 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_ADD_INPUT, i, 0, NULL) == 0);
803
804 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW, i->index);
805 pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_PUT], i);
806
807 pa_sink_update_status(i->sink);
808 }
809
810 /* Called from main context */
811 void pa_sink_input_kill(pa_sink_input*i) {
812 pa_sink_input_assert_ref(i);
813 pa_assert_ctl_context();
814 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
815
816 i->kill(i);
817 }
818
819 /* Called from main context */
820 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i, pa_usec_t *sink_latency) {
821 pa_usec_t r[2] = { 0, 0 };
822
823 pa_sink_input_assert_ref(i);
824 pa_assert_ctl_context();
825 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
826
827 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_GET_LATENCY, r, 0, NULL) == 0);
828
829 if (i->get_latency)
830 r[0] += i->get_latency(i);
831
832 if (sink_latency)
833 *sink_latency = r[1];
834
835 return r[0];
836 }
837
838 /* Called from thread context */
839 void pa_sink_input_peek(pa_sink_input *i, size_t slength /* in sink bytes */, pa_memchunk *chunk, pa_cvolume *volume) {
840 bool do_volume_adj_here, need_volume_factor_sink;
841 bool volume_is_norm;
842 size_t block_size_max_sink, block_size_max_sink_input;
843 size_t ilength;
844 size_t ilength_full;
845
846 pa_sink_input_assert_ref(i);
847 pa_sink_input_assert_io_context(i);
848 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
849 pa_assert(pa_frame_aligned(slength, &i->sink->sample_spec));
850 pa_assert(chunk);
851 pa_assert(volume);
852
853 #ifdef SINK_INPUT_DEBUG
854 pa_log_debug("peek");
855 #endif
856
857 block_size_max_sink_input = i->thread_info.resampler ?
858 pa_resampler_max_block_size(i->thread_info.resampler) :
859 pa_frame_align(pa_mempool_block_size_max(i->core->mempool), &i->sample_spec);
860
861 block_size_max_sink = pa_frame_align(pa_mempool_block_size_max(i->core->mempool), &i->sink->sample_spec);
862
863 /* Default buffer size */
864 if (slength <= 0)
865 slength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sink->sample_spec);
866
867 if (slength > block_size_max_sink)
868 slength = block_size_max_sink;
869
870 if (i->thread_info.resampler) {
871 ilength = pa_resampler_request(i->thread_info.resampler, slength);
872
873 if (ilength <= 0)
874 ilength = pa_frame_align(CONVERT_BUFFER_LENGTH, &i->sample_spec);
875 } else
876 ilength = slength;
877
878 /* Length corresponding to slength (without limiting to
879 * block_size_max_sink_input). */
880 ilength_full = ilength;
881
882 if (ilength > block_size_max_sink_input)
883 ilength = block_size_max_sink_input;
884
885 /* If the channel maps of the sink and this stream differ, we need
886 * to adjust the volume *before* we resample. Otherwise we can do
887 * it after and leave it for the sink code */
888
889 do_volume_adj_here = !pa_channel_map_equal(&i->channel_map, &i->sink->channel_map);
890 volume_is_norm = pa_cvolume_is_norm(&i->thread_info.soft_volume) && !i->thread_info.muted;
891 need_volume_factor_sink = !pa_cvolume_is_norm(&i->volume_factor_sink);
892
893 while (!pa_memblockq_is_readable(i->thread_info.render_memblockq)) {
894 pa_memchunk tchunk;
895
896 /* There's nothing in our render queue. We need to fill it up
897 * with data from the implementor. */
898
899 if (i->thread_info.state == PA_SINK_INPUT_CORKED ||
900 i->pop(i, ilength, &tchunk) < 0) {
901
902 /* OK, we're corked or the implementor didn't give us any
903 * data, so let's just hand out silence */
904 pa_atomic_store(&i->thread_info.drained, 1);
905
906 pa_memblockq_seek(i->thread_info.render_memblockq, (int64_t) slength, PA_SEEK_RELATIVE, true);
907 i->thread_info.playing_for = 0;
908 if (i->thread_info.underrun_for != (uint64_t) -1) {
909 i->thread_info.underrun_for += ilength_full;
910 i->thread_info.underrun_for_sink += slength;
911 }
912 break;
913 }
914
915 pa_atomic_store(&i->thread_info.drained, 0);
916
917 pa_assert(tchunk.length > 0);
918 pa_assert(tchunk.memblock);
919
920 i->thread_info.underrun_for = 0;
921 i->thread_info.underrun_for_sink = 0;
922 i->thread_info.playing_for += tchunk.length;
923
924 while (tchunk.length > 0) {
925 pa_memchunk wchunk;
926 bool nvfs = need_volume_factor_sink;
927
928 wchunk = tchunk;
929 pa_memblock_ref(wchunk.memblock);
930
931 if (wchunk.length > block_size_max_sink_input)
932 wchunk.length = block_size_max_sink_input;
933
934 /* It might be necessary to adjust the volume here */
935 if (do_volume_adj_here && !volume_is_norm) {
936 pa_memchunk_make_writable(&wchunk, 0);
937
938 if (i->thread_info.muted) {
939 pa_silence_memchunk(&wchunk, &i->thread_info.sample_spec);
940 nvfs = false;
941
942 } else if (!i->thread_info.resampler && nvfs) {
943 pa_cvolume v;
944
945 /* If we don't need a resampler we can merge the
946 * post and the pre volume adjustment into one */
947
948 pa_sw_cvolume_multiply(&v, &i->thread_info.soft_volume, &i->volume_factor_sink);
949 pa_volume_memchunk(&wchunk, &i->thread_info.sample_spec, &v);
950 nvfs = false;
951
952 } else
953 pa_volume_memchunk(&wchunk, &i->thread_info.sample_spec, &i->thread_info.soft_volume);
954 }
955
956 if (!i->thread_info.resampler) {
957
958 if (nvfs) {
959 pa_memchunk_make_writable(&wchunk, 0);
960 pa_volume_memchunk(&wchunk, &i->sink->sample_spec, &i->volume_factor_sink);
961 }
962
963 pa_memblockq_push_align(i->thread_info.render_memblockq, &wchunk);
964 } else {
965 pa_memchunk rchunk;
966 pa_resampler_run(i->thread_info.resampler, &wchunk, &rchunk);
967
968 #ifdef SINK_INPUT_DEBUG
969 pa_log_debug("pushing %lu", (unsigned long) rchunk.length);
970 #endif
971
972 if (rchunk.memblock) {
973
974 if (nvfs) {
975 pa_memchunk_make_writable(&rchunk, 0);
976 pa_volume_memchunk(&rchunk, &i->sink->sample_spec, &i->volume_factor_sink);
977 }
978
979 pa_memblockq_push_align(i->thread_info.render_memblockq, &rchunk);
980 pa_memblock_unref(rchunk.memblock);
981 }
982 }
983
984 pa_memblock_unref(wchunk.memblock);
985
986 tchunk.index += wchunk.length;
987 tchunk.length -= wchunk.length;
988 }
989
990 pa_memblock_unref(tchunk.memblock);
991 }
992
993 pa_assert_se(pa_memblockq_peek(i->thread_info.render_memblockq, chunk) >= 0);
994
995 pa_assert(chunk->length > 0);
996 pa_assert(chunk->memblock);
997
998 #ifdef SINK_INPUT_DEBUG
999 pa_log_debug("peeking %lu", (unsigned long) chunk->length);
1000 #endif
1001
1002 if (chunk->length > block_size_max_sink)
1003 chunk->length = block_size_max_sink;
1004
1005 /* Let's see if we had to apply the volume adjustment ourselves,
1006 * or if this can be done by the sink for us */
1007
1008 if (do_volume_adj_here)
1009 /* We had different channel maps, so we already did the adjustment */
1010 pa_cvolume_reset(volume, i->sink->sample_spec.channels);
1011 else if (i->thread_info.muted)
1012 /* We've both the same channel map, so let's have the sink do the adjustment for us*/
1013 pa_cvolume_mute(volume, i->sink->sample_spec.channels);
1014 else
1015 *volume = i->thread_info.soft_volume;
1016 }
1017
1018 /* Called from thread context */
1019 void pa_sink_input_drop(pa_sink_input *i, size_t nbytes /* in sink sample spec */) {
1020
1021 pa_sink_input_assert_ref(i);
1022 pa_sink_input_assert_io_context(i);
1023 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
1024 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
1025 pa_assert(nbytes > 0);
1026
1027 #ifdef SINK_INPUT_DEBUG
1028 pa_log_debug("dropping %lu", (unsigned long) nbytes);
1029 #endif
1030
1031 pa_memblockq_drop(i->thread_info.render_memblockq, nbytes);
1032 }
1033
1034 /* Called from thread context */
1035 bool pa_sink_input_process_underrun(pa_sink_input *i) {
1036 pa_sink_input_assert_ref(i);
1037 pa_sink_input_assert_io_context(i);
1038
1039 if (pa_memblockq_is_readable(i->thread_info.render_memblockq))
1040 return false;
1041
1042 if (i->process_underrun && i->process_underrun(i)) {
1043 /* All valid data has been played back, so we can empty this queue. */
1044 pa_memblockq_silence(i->thread_info.render_memblockq);
1045 return true;
1046 }
1047 return false;
1048 }
1049
1050 /* Called from thread context */
1051 void pa_sink_input_process_rewind(pa_sink_input *i, size_t nbytes /* in sink sample spec */) {
1052 size_t lbq;
1053 bool called = false;
1054
1055 pa_sink_input_assert_ref(i);
1056 pa_sink_input_assert_io_context(i);
1057 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
1058 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
1059
1060 #ifdef SINK_INPUT_DEBUG
1061 pa_log_debug("rewind(%lu, %lu)", (unsigned long) nbytes, (unsigned long) i->thread_info.rewrite_nbytes);
1062 #endif
1063
1064 lbq = pa_memblockq_get_length(i->thread_info.render_memblockq);
1065
1066 if (nbytes > 0 && !i->thread_info.dont_rewind_render) {
1067 pa_log_debug("Have to rewind %lu bytes on render memblockq.", (unsigned long) nbytes);
1068 pa_memblockq_rewind(i->thread_info.render_memblockq, nbytes);
1069 }
1070
1071 if (i->thread_info.rewrite_nbytes == (size_t) -1) {
1072
1073 /* We were asked to drop all buffered data, and rerequest new
1074 * data from implementor the next time peek() is called */
1075
1076 pa_memblockq_flush_write(i->thread_info.render_memblockq, true);
1077
1078 } else if (i->thread_info.rewrite_nbytes > 0) {
1079 size_t max_rewrite, amount;
1080
1081 /* Calculate how much make sense to rewrite at most */
1082 max_rewrite = nbytes + lbq;
1083
1084 /* Transform into local domain */
1085 if (i->thread_info.resampler)
1086 max_rewrite = pa_resampler_request(i->thread_info.resampler, max_rewrite);
1087
1088 /* Calculate how much of the rewinded data should actually be rewritten */
1089 amount = PA_MIN(i->thread_info.rewrite_nbytes, max_rewrite);
1090
1091 if (amount > 0) {
1092 pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) amount);
1093
1094 /* Tell the implementor */
1095 if (i->process_rewind)
1096 i->process_rewind(i, amount);
1097 called = true;
1098
1099 /* Convert back to sink domain */
1100 if (i->thread_info.resampler)
1101 amount = pa_resampler_result(i->thread_info.resampler, amount);
1102
1103 if (amount > 0)
1104 /* Ok, now update the write pointer */
1105 pa_memblockq_seek(i->thread_info.render_memblockq, - ((int64_t) amount), PA_SEEK_RELATIVE, true);
1106
1107 if (i->thread_info.rewrite_flush)
1108 pa_memblockq_silence(i->thread_info.render_memblockq);
1109
1110 /* And reset the resampler */
1111 if (i->thread_info.resampler)
1112 pa_resampler_reset(i->thread_info.resampler);
1113 }
1114 }
1115
1116 if (!called)
1117 if (i->process_rewind)
1118 i->process_rewind(i, 0);
1119
1120 i->thread_info.rewrite_nbytes = 0;
1121 i->thread_info.rewrite_flush = false;
1122 i->thread_info.dont_rewind_render = false;
1123 }
1124
1125 /* Called from thread context */
1126 size_t pa_sink_input_get_max_rewind(pa_sink_input *i) {
1127 pa_sink_input_assert_ref(i);
1128 pa_sink_input_assert_io_context(i);
1129
1130 return i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, i->sink->thread_info.max_rewind) : i->sink->thread_info.max_rewind;
1131 }
1132
1133 /* Called from thread context */
1134 size_t pa_sink_input_get_max_request(pa_sink_input *i) {
1135 pa_sink_input_assert_ref(i);
1136 pa_sink_input_assert_io_context(i);
1137
1138 /* We're not verifying the status here, to allow this to be called
1139 * in the state change handler between _INIT and _RUNNING */
1140
1141 return i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, i->sink->thread_info.max_request) : i->sink->thread_info.max_request;
1142 }
1143
1144 /* Called from thread context */
1145 void pa_sink_input_update_max_rewind(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */) {
1146 pa_sink_input_assert_ref(i);
1147 pa_sink_input_assert_io_context(i);
1148 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
1149 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
1150
1151 pa_memblockq_set_maxrewind(i->thread_info.render_memblockq, nbytes);
1152
1153 if (i->update_max_rewind)
1154 i->update_max_rewind(i, i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, nbytes) : nbytes);
1155 }
1156
1157 /* Called from thread context */
1158 void pa_sink_input_update_max_request(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */) {
1159 pa_sink_input_assert_ref(i);
1160 pa_sink_input_assert_io_context(i);
1161 pa_assert(PA_SINK_INPUT_IS_LINKED(i->thread_info.state));
1162 pa_assert(pa_frame_aligned(nbytes, &i->sink->sample_spec));
1163
1164 if (i->update_max_request)
1165 i->update_max_request(i, i->thread_info.resampler ? pa_resampler_request(i->thread_info.resampler, nbytes) : nbytes);
1166 }
1167
1168 /* Called from thread context */
1169 pa_usec_t pa_sink_input_set_requested_latency_within_thread(pa_sink_input *i, pa_usec_t usec) {
1170 pa_sink_input_assert_ref(i);
1171 pa_sink_input_assert_io_context(i);
1172
1173 if (!(i->sink->flags & PA_SINK_DYNAMIC_LATENCY))
1174 usec = i->sink->thread_info.fixed_latency;
1175
1176 if (usec != (pa_usec_t) -1)
1177 usec = PA_CLAMP(usec, i->sink->thread_info.min_latency, i->sink->thread_info.max_latency);
1178
1179 i->thread_info.requested_sink_latency = usec;
1180 pa_sink_invalidate_requested_latency(i->sink, true);
1181
1182 return usec;
1183 }
1184
1185 /* Called from main context */
1186 pa_usec_t pa_sink_input_set_requested_latency(pa_sink_input *i, pa_usec_t usec) {
1187 pa_sink_input_assert_ref(i);
1188 pa_assert_ctl_context();
1189
1190 if (PA_SINK_INPUT_IS_LINKED(i->state) && i->sink) {
1191 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
1192 return usec;
1193 }
1194
1195 /* If this sink input is not realized yet or we are being moved,
1196 * we have to touch the thread info data directly */
1197
1198 if (i->sink) {
1199 if (!(i->sink->flags & PA_SINK_DYNAMIC_LATENCY))
1200 usec = pa_sink_get_fixed_latency(i->sink);
1201
1202 if (usec != (pa_usec_t) -1) {
1203 pa_usec_t min_latency, max_latency;
1204 pa_sink_get_latency_range(i->sink, &min_latency, &max_latency);
1205 usec = PA_CLAMP(usec, min_latency, max_latency);
1206 }
1207 }
1208
1209 i->thread_info.requested_sink_latency = usec;
1210
1211 return usec;
1212 }
1213
1214 /* Called from main context */
1215 pa_usec_t pa_sink_input_get_requested_latency(pa_sink_input *i) {
1216 pa_sink_input_assert_ref(i);
1217 pa_assert_ctl_context();
1218
1219 if (PA_SINK_INPUT_IS_LINKED(i->state) && i->sink) {
1220 pa_usec_t usec = 0;
1221 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
1222 return usec;
1223 }
1224
1225 /* If this sink input is not realized yet or we are being moved,
1226 * we have to touch the thread info data directly */
1227
1228 return i->thread_info.requested_sink_latency;
1229 }
1230
1231 /* Called from main context */
1232 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume, bool save, bool absolute) {
1233 pa_cvolume v;
1234
1235 pa_sink_input_assert_ref(i);
1236 pa_assert_ctl_context();
1237 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1238 pa_assert(volume);
1239 pa_assert(pa_cvolume_valid(volume));
1240 pa_assert(volume->channels == 1 || pa_cvolume_compatible(volume, &i->sample_spec));
1241 pa_assert(i->volume_writable);
1242
1243 if (!absolute && pa_sink_flat_volume_enabled(i->sink)) {
1244 v = i->sink->reference_volume;
1245 pa_cvolume_remap(&v, &i->sink->channel_map, &i->channel_map);
1246
1247 if (pa_cvolume_compatible(volume, &i->sample_spec))
1248 volume = pa_sw_cvolume_multiply(&v, &v, volume);
1249 else
1250 volume = pa_sw_cvolume_multiply_scalar(&v, &v, pa_cvolume_max(volume));
1251 } else {
1252 if (!pa_cvolume_compatible(volume, &i->sample_spec)) {
1253 v = i->volume;
1254 volume = pa_cvolume_scale(&v, pa_cvolume_max(volume));
1255 }
1256 }
1257
1258 if (pa_cvolume_equal(volume, &i->volume)) {
1259 i->save_volume = i->save_volume || save;
1260 return;
1261 }
1262
1263 pa_sink_input_set_volume_direct(i, volume);
1264 i->save_volume = save;
1265
1266 if (pa_sink_flat_volume_enabled(i->sink)) {
1267 /* We are in flat volume mode, so let's update all sink input
1268 * volumes and update the flat volume of the sink */
1269
1270 pa_sink_set_volume(i->sink, NULL, true, save);
1271
1272 } else {
1273 /* OK, we are in normal volume mode. The volume only affects
1274 * ourselves */
1275 set_real_ratio(i, volume);
1276 i->reference_ratio = i->volume;
1277
1278 /* Copy the new soft_volume to the thread_info struct */
1279 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME, NULL, 0, NULL) == 0);
1280 }
1281 }
1282
1283 void pa_sink_input_add_volume_factor(pa_sink_input *i, const char *key, const pa_cvolume *volume_factor) {
1284 struct volume_factor_entry *v;
1285
1286 pa_sink_input_assert_ref(i);
1287 pa_assert_ctl_context();
1288 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1289 pa_assert(volume_factor);
1290 pa_assert(key);
1291 pa_assert(pa_cvolume_valid(volume_factor));
1292 pa_assert(volume_factor->channels == 1 || pa_cvolume_compatible(volume_factor, &i->sample_spec));
1293
1294 v = volume_factor_entry_new(key, volume_factor);
1295 if (!pa_cvolume_compatible(volume_factor, &i->sample_spec))
1296 pa_cvolume_set(&v->volume, i->sample_spec.channels, volume_factor->values[0]);
1297
1298 pa_assert_se(pa_hashmap_put(i->volume_factor_items, v->key, v) >= 0);
1299 if (pa_hashmap_size(i->volume_factor_items) == 1)
1300 i->volume_factor = v->volume;
1301 else
1302 pa_sw_cvolume_multiply(&i->volume_factor, &i->volume_factor, &v->volume);
1303
1304 pa_sw_cvolume_multiply(&i->soft_volume, &i->real_ratio, &i->volume_factor);
1305
1306 /* Copy the new soft_volume to the thread_info struct */
1307 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME, NULL, 0, NULL) == 0);
1308 }
1309
1310 /* Returns 0 if an entry was removed and -1 if no entry for the given key was
1311 * found. */
1312 int pa_sink_input_remove_volume_factor(pa_sink_input *i, const char *key) {
1313 struct volume_factor_entry *v;
1314
1315 pa_sink_input_assert_ref(i);
1316 pa_assert(key);
1317 pa_assert_ctl_context();
1318 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1319
1320 if (pa_hashmap_remove_and_free(i->volume_factor_items, key) < 0)
1321 return -1;
1322
1323 switch (pa_hashmap_size(i->volume_factor_items)) {
1324 case 0:
1325 pa_cvolume_reset(&i->volume_factor, i->sample_spec.channels);
1326 break;
1327 case 1:
1328 v = pa_hashmap_first(i->volume_factor_items);
1329 i->volume_factor = v->volume;
1330 break;
1331 default:
1332 volume_factor_from_hashmap(&i->volume_factor, i->volume_factor_items, i->volume_factor.channels);
1333 }
1334
1335 pa_sw_cvolume_multiply(&i->soft_volume, &i->real_ratio, &i->volume_factor);
1336
1337 /* Copy the new soft_volume to the thread_info struct */
1338 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME, NULL, 0, NULL) == 0);
1339
1340 return 0;
1341 }
1342
1343 /* Called from main context */
1344 static void set_real_ratio(pa_sink_input *i, const pa_cvolume *v) {
1345 pa_sink_input_assert_ref(i);
1346 pa_assert_ctl_context();
1347 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1348 pa_assert(!v || pa_cvolume_compatible(v, &i->sample_spec));
1349
1350 /* This basically calculates:
1351 *
1352 * i->real_ratio := v
1353 * i->soft_volume := i->real_ratio * i->volume_factor */
1354
1355 if (v)
1356 i->real_ratio = *v;
1357 else
1358 pa_cvolume_reset(&i->real_ratio, i->sample_spec.channels);
1359
1360 pa_sw_cvolume_multiply(&i->soft_volume, &i->real_ratio, &i->volume_factor);
1361 /* We don't copy the data to the thread_info data. That's left for someone else to do */
1362 }
1363
1364 /* Called from main or I/O context */
1365 bool pa_sink_input_is_passthrough(pa_sink_input *i) {
1366 pa_sink_input_assert_ref(i);
1367
1368 if (PA_UNLIKELY(!pa_format_info_is_pcm(i->format)))
1369 return true;
1370
1371 if (PA_UNLIKELY(i->flags & PA_SINK_INPUT_PASSTHROUGH))
1372 return true;
1373
1374 return false;
1375 }
1376
1377 /* Called from main context */
1378 bool pa_sink_input_is_volume_readable(pa_sink_input *i) {
1379 pa_sink_input_assert_ref(i);
1380 pa_assert_ctl_context();
1381
1382 return !pa_sink_input_is_passthrough(i);
1383 }
1384
1385 /* Called from main context */
1386 pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i, pa_cvolume *volume, bool absolute) {
1387 pa_sink_input_assert_ref(i);
1388 pa_assert_ctl_context();
1389 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1390 pa_assert(pa_sink_input_is_volume_readable(i));
1391
1392 if (absolute || !pa_sink_flat_volume_enabled(i->sink))
1393 *volume = i->volume;
1394 else
1395 *volume = i->reference_ratio;
1396
1397 return volume;
1398 }
1399
1400 /* Called from main context */
1401 void pa_sink_input_set_mute(pa_sink_input *i, bool mute, bool save) {
1402 bool old_mute;
1403
1404 pa_sink_input_assert_ref(i);
1405 pa_assert_ctl_context();
1406 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1407
1408 old_mute = i->muted;
1409
1410 if (mute == old_mute) {
1411 i->save_muted |= save;
1412 return;
1413 }
1414
1415 i->muted = mute;
1416 pa_log_debug("The mute of sink input %u changed from %s to %s.", i->index, pa_yes_no(old_mute), pa_yes_no(mute));
1417
1418 i->save_muted = save;
1419
1420 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE, NULL, 0, NULL) == 0);
1421
1422 /* The mute status changed, let's tell people so */
1423 if (i->mute_changed)
1424 i->mute_changed(i);
1425
1426 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
1427 }
1428
1429 /* Called from main context */
1430 bool pa_sink_input_get_mute(pa_sink_input *i) {
1431 pa_sink_input_assert_ref(i);
1432 pa_assert_ctl_context();
1433 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1434
1435 return i->muted;
1436 }
1437
1438 /* Called from main thread */
1439 void pa_sink_input_update_proplist(pa_sink_input *i, pa_update_mode_t mode, pa_proplist *p) {
1440 pa_sink_input_assert_ref(i);
1441 pa_assert_ctl_context();
1442
1443 if (p)
1444 pa_proplist_update(i->proplist, mode, p);
1445
1446 if (PA_SINK_INPUT_IS_LINKED(i->state)) {
1447 pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], i);
1448 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
1449 }
1450 }
1451
1452 /* Called from main context */
1453 void pa_sink_input_cork(pa_sink_input *i, bool b) {
1454 pa_sink_input_assert_ref(i);
1455 pa_assert_ctl_context();
1456 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1457
1458 sink_input_set_state(i, b ? PA_SINK_INPUT_CORKED : PA_SINK_INPUT_RUNNING);
1459 }
1460
1461 /* Called from main context */
1462 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate) {
1463 pa_sink_input_assert_ref(i);
1464 pa_assert_ctl_context();
1465 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1466 pa_return_val_if_fail(i->thread_info.resampler, -PA_ERR_BADSTATE);
1467
1468 if (i->sample_spec.rate == rate)
1469 return 0;
1470
1471 i->sample_spec.rate = rate;
1472
1473 pa_asyncmsgq_post(i->sink->asyncmsgq, PA_MSGOBJECT(i), PA_SINK_INPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
1474
1475 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
1476 return 0;
1477 }
1478
1479 /* Called from main context */
1480 void pa_sink_input_set_name(pa_sink_input *i, const char *name) {
1481 const char *old;
1482 pa_sink_input_assert_ref(i);
1483 pa_assert_ctl_context();
1484
1485 if (!name && !pa_proplist_contains(i->proplist, PA_PROP_MEDIA_NAME))
1486 return;
1487
1488 old = pa_proplist_gets(i->proplist, PA_PROP_MEDIA_NAME);
1489
1490 if (old && name && pa_streq(old, name))
1491 return;
1492
1493 if (name)
1494 pa_proplist_sets(i->proplist, PA_PROP_MEDIA_NAME, name);
1495 else
1496 pa_proplist_unset(i->proplist, PA_PROP_MEDIA_NAME);
1497
1498 if (PA_SINK_INPUT_IS_LINKED(i->state)) {
1499 pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED], i);
1500 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
1501 }
1502 }
1503
1504 /* Called from main context */
1505 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i) {
1506 pa_sink_input_assert_ref(i);
1507 pa_assert_ctl_context();
1508
1509 return i->actual_resample_method;
1510 }
1511
1512 /* Called from main context */
1513 bool pa_sink_input_may_move(pa_sink_input *i) {
1514 pa_sink_input_assert_ref(i);
1515 pa_assert_ctl_context();
1516 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1517
1518 if (i->flags & PA_SINK_INPUT_DONT_MOVE)
1519 return false;
1520
1521 if (i->sync_next || i->sync_prev) {
1522 pa_log_warn("Moving synchronized streams not supported.");
1523 return false;
1524 }
1525
1526 return true;
1527 }
1528
1529 static bool find_filter_sink_input(pa_sink_input *target, pa_sink *s) {
1530 int i = 0;
1531 while (s && s->input_to_master) {
1532 if (s->input_to_master == target)
1533 return true;
1534 s = s->input_to_master->sink;
1535 pa_assert(i++ < 100);
1536 }
1537 return false;
1538 }
1539
1540 /* Called from main context */
1541 bool pa_sink_input_may_move_to(pa_sink_input *i, pa_sink *dest) {
1542 pa_sink_input_assert_ref(i);
1543 pa_assert_ctl_context();
1544 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1545 pa_sink_assert_ref(dest);
1546
1547 if (dest == i->sink)
1548 return true;
1549
1550 if (!pa_sink_input_may_move(i))
1551 return false;
1552
1553 /* Make sure we're not creating a filter sink cycle */
1554 if (find_filter_sink_input(i, dest)) {
1555 pa_log_debug("Can't connect input to %s, as that would create a cycle.", dest->name);
1556 return false;
1557 }
1558
1559 if (pa_idxset_size(dest->inputs) >= PA_MAX_INPUTS_PER_SINK) {
1560 pa_log_warn("Failed to move sink input: too many inputs per sink.");
1561 return false;
1562 }
1563
1564 if (check_passthrough_connection(pa_sink_input_is_passthrough(i), dest) < 0)
1565 return false;
1566
1567 if (i->may_move_to)
1568 if (!i->may_move_to(i, dest))
1569 return false;
1570
1571 return true;
1572 }
1573
1574 /* Called from main context */
1575 int pa_sink_input_start_move(pa_sink_input *i) {
1576 pa_source_output *o, *p = NULL;
1577 struct volume_factor_entry *v;
1578 void *state = NULL;
1579 int r;
1580
1581 pa_sink_input_assert_ref(i);
1582 pa_assert_ctl_context();
1583 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1584 pa_assert(i->sink);
1585
1586 if (!pa_sink_input_may_move(i))
1587 return -PA_ERR_NOTSUPPORTED;
1588
1589 if ((r = pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_START], i)) < 0)
1590 return r;
1591
1592 /* Kill directly connected outputs */
1593 while ((o = pa_idxset_first(i->direct_outputs, NULL))) {
1594 pa_assert(o != p);
1595 pa_source_output_kill(o);
1596 p = o;
1597 }
1598 pa_assert(pa_idxset_isempty(i->direct_outputs));
1599
1600 pa_idxset_remove_by_data(i->sink->inputs, i, NULL);
1601
1602 if (pa_sink_input_get_state(i) == PA_SINK_INPUT_CORKED)
1603 pa_assert_se(i->sink->n_corked-- >= 1);
1604
1605 if (pa_sink_input_is_passthrough(i))
1606 pa_sink_leave_passthrough(i->sink);
1607
1608 if (pa_sink_flat_volume_enabled(i->sink))
1609 /* We might need to update the sink's volume if we are in flat
1610 * volume mode. */
1611 pa_sink_set_volume(i->sink, NULL, false, false);
1612
1613 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_START_MOVE, i, 0, NULL) == 0);
1614
1615 pa_sink_update_status(i->sink);
1616
1617 PA_HASHMAP_FOREACH(v, i->volume_factor_sink_items, state)
1618 pa_cvolume_remap(&v->volume, &i->sink->channel_map, &i->channel_map);
1619
1620 pa_cvolume_remap(&i->volume_factor_sink, &i->sink->channel_map, &i->channel_map);
1621
1622 i->sink = NULL;
1623
1624 pa_sink_input_unref(i);
1625
1626 return 0;
1627 }
1628
1629 /* Called from main context. If i has an origin sink that uses volume sharing,
1630 * then also the origin sink and all streams connected to it need to update
1631 * their volume - this function does all that by using recursion. */
1632 static void update_volume_due_to_moving(pa_sink_input *i, pa_sink *dest) {
1633 pa_cvolume new_volume;
1634
1635 pa_assert(i);
1636 pa_assert(dest);
1637 pa_assert(i->sink); /* The destination sink should already be set. */
1638
1639 if (i->origin_sink && (i->origin_sink->flags & PA_SINK_SHARE_VOLUME_WITH_MASTER)) {
1640 pa_sink *root_sink = pa_sink_get_master(i->sink);
1641 pa_sink_input *origin_sink_input;
1642 uint32_t idx;
1643
1644 if (PA_UNLIKELY(!root_sink))
1645 return;
1646
1647 if (pa_sink_flat_volume_enabled(i->sink)) {
1648 /* Ok, so the origin sink uses volume sharing, and flat volume is
1649 * enabled. The volume will have to be updated as follows:
1650 *
1651 * i->volume := i->sink->real_volume
1652 * (handled later by pa_sink_set_volume)
1653 * i->reference_ratio := i->volume / i->sink->reference_volume
1654 * (handled later by pa_sink_set_volume)
1655 * i->real_ratio stays unchanged
1656 * (streams whose origin sink uses volume sharing should
1657 * always have real_ratio of 0 dB)
1658 * i->soft_volume stays unchanged
1659 * (streams whose origin sink uses volume sharing should
1660 * always have volume_factor as soft_volume, so no change
1661 * should be needed) */
1662
1663 pa_assert(pa_cvolume_is_norm(&i->real_ratio));
1664 pa_assert(pa_cvolume_equal(&i->soft_volume, &i->volume_factor));
1665
1666 /* Notifications will be sent by pa_sink_set_volume(). */
1667
1668 } else {
1669 /* Ok, so the origin sink uses volume sharing, and flat volume is
1670 * disabled. The volume will have to be updated as follows:
1671 *
1672 * i->volume := 0 dB
1673 * i->reference_ratio := 0 dB
1674 * i->real_ratio stays unchanged
1675 * (streams whose origin sink uses volume sharing should
1676 * always have real_ratio of 0 dB)
1677 * i->soft_volume stays unchanged
1678 * (streams whose origin sink uses volume sharing should
1679 * always have volume_factor as soft_volume, so no change
1680 * should be needed) */
1681
1682 pa_cvolume_reset(&new_volume, i->volume.channels);
1683 pa_sink_input_set_volume_direct(i, &new_volume);
1684 pa_cvolume_reset(&i->reference_ratio, i->reference_ratio.channels);
1685 pa_assert(pa_cvolume_is_norm(&i->real_ratio));
1686 pa_assert(pa_cvolume_equal(&i->soft_volume, &i->volume_factor));
1687 }
1688
1689 /* Additionally, the origin sink volume needs updating:
1690 *
1691 * i->origin_sink->reference_volume := root_sink->reference_volume
1692 * i->origin_sink->real_volume := root_sink->real_volume
1693 * i->origin_sink->soft_volume stays unchanged
1694 * (sinks that use volume sharing should always have
1695 * soft_volume of 0 dB) */
1696
1697 new_volume = root_sink->reference_volume;
1698 pa_cvolume_remap(&new_volume, &root_sink->channel_map, &i->origin_sink->channel_map);
1699 pa_sink_set_reference_volume_direct(i->origin_sink, &new_volume);
1700
1701 i->origin_sink->real_volume = root_sink->real_volume;
1702 pa_cvolume_remap(&i->origin_sink->real_volume, &root_sink->channel_map, &i->origin_sink->channel_map);
1703
1704 pa_assert(pa_cvolume_is_norm(&i->origin_sink->soft_volume));
1705
1706 /* If you wonder whether i->origin_sink->set_volume() should be called
1707 * somewhere, that's not the case, because sinks that use volume
1708 * sharing shouldn't have any internal volume that set_volume() would
1709 * update. If you wonder whether the thread_info variables should be
1710 * synced, yes, they should, and it's done by the
1711 * PA_SINK_MESSAGE_FINISH_MOVE message handler. */
1712
1713 /* Recursively update origin sink inputs. */
1714 PA_IDXSET_FOREACH(origin_sink_input, i->origin_sink->inputs, idx)
1715 update_volume_due_to_moving(origin_sink_input, dest);
1716
1717 } else {
1718 if (pa_sink_flat_volume_enabled(i->sink)) {
1719 /* Ok, so this is a regular stream, and flat volume is enabled. The
1720 * volume will have to be updated as follows:
1721 *
1722 * i->volume := i->reference_ratio * i->sink->reference_volume
1723 * i->reference_ratio stays unchanged
1724 * i->real_ratio := i->volume / i->sink->real_volume
1725 * (handled later by pa_sink_set_volume)
1726 * i->soft_volume := i->real_ratio * i->volume_factor
1727 * (handled later by pa_sink_set_volume) */
1728
1729 new_volume = i->sink->reference_volume;
1730 pa_cvolume_remap(&new_volume, &i->sink->channel_map, &i->channel_map);
1731 pa_sw_cvolume_multiply(&new_volume, &new_volume, &i->reference_ratio);
1732 pa_sink_input_set_volume_direct(i, &new_volume);
1733
1734 } else {
1735 /* Ok, so this is a regular stream, and flat volume is disabled.
1736 * The volume will have to be updated as follows:
1737 *
1738 * i->volume := i->reference_ratio
1739 * i->reference_ratio stays unchanged
1740 * i->real_ratio := i->reference_ratio
1741 * i->soft_volume := i->real_ratio * i->volume_factor */
1742
1743 pa_sink_input_set_volume_direct(i, &i->reference_ratio);
1744 i->real_ratio = i->reference_ratio;
1745 pa_sw_cvolume_multiply(&i->soft_volume, &i->real_ratio, &i->volume_factor);
1746 }
1747 }
1748
1749 /* If i->sink == dest, then recursion has finished, and we can finally call
1750 * pa_sink_set_volume(), which will do the rest of the updates. */
1751 if ((i->sink == dest) && pa_sink_flat_volume_enabled(i->sink))
1752 pa_sink_set_volume(i->sink, NULL, false, i->save_volume);
1753 }
1754
1755 /* Called from main context */
1756 int pa_sink_input_finish_move(pa_sink_input *i, pa_sink *dest, bool save) {
1757 struct volume_factor_entry *v;
1758 void *state = NULL;
1759
1760 pa_sink_input_assert_ref(i);
1761 pa_assert_ctl_context();
1762 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1763 pa_assert(!i->sink);
1764 pa_sink_assert_ref(dest);
1765
1766 if (!pa_sink_input_may_move_to(i, dest))
1767 return -PA_ERR_NOTSUPPORTED;
1768
1769 if (pa_sink_input_is_passthrough(i) && !pa_sink_check_format(dest, i->format)) {
1770 pa_proplist *p = pa_proplist_new();
1771 pa_log_debug("New sink doesn't support stream format, sending format-changed and killing");
1772 /* Tell the client what device we want to be on if it is going to
1773 * reconnect */
1774 pa_proplist_sets(p, "device", dest->name);
1775 pa_sink_input_send_event(i, PA_STREAM_EVENT_FORMAT_LOST, p);
1776 pa_proplist_free(p);
1777 return -PA_ERR_NOTSUPPORTED;
1778 }
1779
1780 if (!(i->flags & PA_SINK_INPUT_VARIABLE_RATE) &&
1781 !pa_sample_spec_equal(&i->sample_spec, &dest->sample_spec)) {
1782 /* try to change dest sink rate if possible without glitches.
1783 module-suspend-on-idle resumes destination sink with
1784 SINK_INPUT_MOVE_FINISH hook */
1785
1786 pa_log_info("Trying to change sample rate");
1787 if (pa_sink_update_rate(dest, i->sample_spec.rate, pa_sink_input_is_passthrough(i)) >= 0)
1788 pa_log_info("Rate changed to %u Hz", dest->sample_spec.rate);
1789 }
1790
1791 if (i->moving)
1792 i->moving(i, dest);
1793
1794 i->sink = dest;
1795 i->save_sink = save;
1796 pa_idxset_put(dest->inputs, pa_sink_input_ref(i), NULL);
1797
1798 PA_HASHMAP_FOREACH(v, i->volume_factor_sink_items, state)
1799 pa_cvolume_remap(&v->volume, &i->channel_map, &i->sink->channel_map);
1800
1801 pa_cvolume_remap(&i->volume_factor_sink, &i->channel_map, &i->sink->channel_map);
1802
1803 if (pa_sink_input_get_state(i) == PA_SINK_INPUT_CORKED)
1804 i->sink->n_corked++;
1805
1806 pa_sink_input_update_rate(i);
1807
1808 pa_sink_update_status(dest);
1809
1810 update_volume_due_to_moving(i, dest);
1811
1812 if (pa_sink_input_is_passthrough(i))
1813 pa_sink_enter_passthrough(i->sink);
1814
1815 pa_assert_se(pa_asyncmsgq_send(i->sink->asyncmsgq, PA_MSGOBJECT(i->sink), PA_SINK_MESSAGE_FINISH_MOVE, i, 0, NULL) == 0);
1816
1817 pa_log_debug("Successfully moved sink input %i to %s.", i->index, dest->name);
1818
1819 /* Notify everyone */
1820 pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_FINISH], i);
1821 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
1822
1823 return 0;
1824 }
1825
1826 /* Called from main context */
1827 void pa_sink_input_fail_move(pa_sink_input *i) {
1828
1829 pa_sink_input_assert_ref(i);
1830 pa_assert_ctl_context();
1831 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1832 pa_assert(!i->sink);
1833
1834 /* Check if someone wants this sink input? */
1835 if (pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_MOVE_FAIL], i) == PA_HOOK_STOP)
1836 return;
1837
1838 if (i->moving)
1839 i->moving(i, NULL);
1840
1841 pa_sink_input_kill(i);
1842 }
1843
1844 /* Called from main context */
1845 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest, bool save) {
1846 int r;
1847
1848 pa_sink_input_assert_ref(i);
1849 pa_assert_ctl_context();
1850 pa_assert(PA_SINK_INPUT_IS_LINKED(i->state));
1851 pa_assert(i->sink);
1852 pa_sink_assert_ref(dest);
1853
1854 if (dest == i->sink)
1855 return 0;
1856
1857 if (!pa_sink_input_may_move_to(i, dest))
1858 return -PA_ERR_NOTSUPPORTED;
1859
1860 pa_sink_input_ref(i);
1861
1862 if ((r = pa_sink_input_start_move(i)) < 0) {
1863 pa_sink_input_unref(i);
1864 return r;
1865 }
1866
1867 if ((r = pa_sink_input_finish_move(i, dest, save)) < 0) {
1868 pa_sink_input_fail_move(i);
1869 pa_sink_input_unref(i);
1870 return r;
1871 }
1872
1873 pa_sink_input_unref(i);
1874
1875 return 0;
1876 }
1877
1878 /* Called from IO thread context */
1879 void pa_sink_input_set_state_within_thread(pa_sink_input *i, pa_sink_input_state_t state) {
1880 bool corking, uncorking;
1881
1882 pa_sink_input_assert_ref(i);
1883 pa_sink_input_assert_io_context(i);
1884
1885 if (state == i->thread_info.state)
1886 return;
1887
1888 if ((state == PA_SINK_INPUT_DRAINED || state == PA_SINK_INPUT_RUNNING) &&
1889 !(i->thread_info.state == PA_SINK_INPUT_DRAINED || i->thread_info.state != PA_SINK_INPUT_RUNNING))
1890 pa_atomic_store(&i->thread_info.drained, 1);
1891
1892 corking = state == PA_SINK_INPUT_CORKED && i->thread_info.state == PA_SINK_INPUT_RUNNING;
1893 uncorking = i->thread_info.state == PA_SINK_INPUT_CORKED && state == PA_SINK_INPUT_RUNNING;
1894
1895 if (i->state_change)
1896 i->state_change(i, state);
1897
1898 if (corking) {
1899
1900 pa_log_debug("Requesting rewind due to corking");
1901
1902 /* This will tell the implementing sink input driver to rewind
1903 * so that the unplayed already mixed data is not lost */
1904 pa_sink_input_request_rewind(i, 0, true, true, false);
1905
1906 /* Set the corked state *after* requesting rewind */
1907 i->thread_info.state = state;
1908
1909 } else if (uncorking) {
1910
1911 pa_log_debug("Requesting rewind due to uncorking");
1912
1913 i->thread_info.underrun_for = (uint64_t) -1;
1914 i->thread_info.underrun_for_sink = 0;
1915 i->thread_info.playing_for = 0;
1916
1917 /* Set the uncorked state *before* requesting rewind */
1918 i->thread_info.state = state;
1919
1920 /* OK, we're being uncorked. Make sure we're not rewound when
1921 * the hw buffer is remixed and request a remix. */
1922 pa_sink_input_request_rewind(i, 0, false, true, true);
1923 } else
1924 /* We may not be corking or uncorking, but we still need to set the state. */
1925 i->thread_info.state = state;
1926 }
1927
1928 /* Called from thread context, except when it is not. */
1929 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
1930 pa_sink_input *i = PA_SINK_INPUT(o);
1931 pa_sink_input_assert_ref(i);
1932
1933 switch (code) {
1934
1935 case PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME:
1936 if (!pa_cvolume_equal(&i->thread_info.soft_volume, &i->soft_volume)) {
1937 i->thread_info.soft_volume = i->soft_volume;
1938 pa_sink_input_request_rewind(i, 0, true, false, false);
1939 }
1940 return 0;
1941
1942 case PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE:
1943 if (i->thread_info.muted != i->muted) {
1944 i->thread_info.muted = i->muted;
1945 pa_sink_input_request_rewind(i, 0, true, false, false);
1946 }
1947 return 0;
1948
1949 case PA_SINK_INPUT_MESSAGE_GET_LATENCY: {
1950 pa_usec_t *r = userdata;
1951
1952 r[0] += pa_bytes_to_usec(pa_memblockq_get_length(i->thread_info.render_memblockq), &i->sink->sample_spec);
1953 r[1] += pa_sink_get_latency_within_thread(i->sink);
1954
1955 return 0;
1956 }
1957
1958 case PA_SINK_INPUT_MESSAGE_SET_RATE:
1959
1960 i->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
1961 pa_resampler_set_input_rate(i->thread_info.resampler, PA_PTR_TO_UINT(userdata));
1962
1963 return 0;
1964
1965 case PA_SINK_INPUT_MESSAGE_SET_STATE: {
1966 pa_sink_input *ssync;
1967
1968 pa_sink_input_set_state_within_thread(i, PA_PTR_TO_UINT(userdata));
1969
1970 for (ssync = i->thread_info.sync_prev; ssync; ssync = ssync->thread_info.sync_prev)
1971 pa_sink_input_set_state_within_thread(ssync, PA_PTR_TO_UINT(userdata));
1972
1973 for (ssync = i->thread_info.sync_next; ssync; ssync = ssync->thread_info.sync_next)
1974 pa_sink_input_set_state_within_thread(ssync, PA_PTR_TO_UINT(userdata));
1975
1976 return 0;
1977 }
1978
1979 case PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY: {
1980 pa_usec_t *usec = userdata;
1981
1982 *usec = pa_sink_input_set_requested_latency_within_thread(i, *usec);
1983 return 0;
1984 }
1985
1986 case PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY: {
1987 pa_usec_t *r = userdata;
1988
1989 *r = i->thread_info.requested_sink_latency;
1990 return 0;
1991 }
1992 }
1993
1994 return -PA_ERR_NOTIMPLEMENTED;
1995 }
1996
1997 /* Called from main thread */
1998 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i) {
1999 pa_sink_input_assert_ref(i);
2000 pa_assert_ctl_context();
2001
2002 if (i->state == PA_SINK_INPUT_RUNNING || i->state == PA_SINK_INPUT_DRAINED)
2003 return pa_atomic_load(&i->thread_info.drained) ? PA_SINK_INPUT_DRAINED : PA_SINK_INPUT_RUNNING;
2004
2005 return i->state;
2006 }
2007
2008 /* Called from IO context */
2009 bool pa_sink_input_safe_to_remove(pa_sink_input *i) {
2010 pa_sink_input_assert_ref(i);
2011 pa_sink_input_assert_io_context(i);
2012
2013 if (PA_SINK_INPUT_IS_LINKED(i->thread_info.state))
2014 return pa_memblockq_is_empty(i->thread_info.render_memblockq);
2015
2016 return true;
2017 }
2018
2019 /* Called from IO context */
2020 void pa_sink_input_request_rewind(
2021 pa_sink_input *i,
2022 size_t nbytes /* in our sample spec */,
2023 bool rewrite,
2024 bool flush,
2025 bool dont_rewind_render) {
2026
2027 size_t lbq;
2028
2029 /* If 'rewrite' is true the sink is rewound as far as requested
2030 * and possible and the exact value of this is passed back the
2031 * implementor via process_rewind(). If 'flush' is also true all
2032 * already rendered data is also dropped.
2033 *
2034 * If 'rewrite' is false the sink is rewound as far as requested
2035 * and possible and the already rendered data is dropped so that
2036 * in the next iteration we read new data from the
2037 * implementor. This implies 'flush' is true. If
2038 * dont_rewind_render is true then the render memblockq is not
2039 * rewound. */
2040
2041 /* nbytes = 0 means maximum rewind request */
2042
2043 pa_sink_input_assert_ref(i);
2044 pa_sink_input_assert_io_context(i);
2045 pa_assert(rewrite || flush);
2046 pa_assert(!dont_rewind_render || !rewrite);
2047
2048 /* We don't take rewind requests while we are corked */
2049 if (i->thread_info.state == PA_SINK_INPUT_CORKED)
2050 return;
2051
2052 nbytes = PA_MAX(i->thread_info.rewrite_nbytes, nbytes);
2053
2054 #ifdef SINK_INPUT_DEBUG
2055 pa_log_debug("request rewrite %zu", nbytes);
2056 #endif
2057
2058 /* Calculate how much we can rewind locally without having to
2059 * touch the sink */
2060 if (rewrite)
2061 lbq = pa_memblockq_get_length(i->thread_info.render_memblockq);
2062 else
2063 lbq = 0;
2064
2065 /* Check if rewinding for the maximum is requested, and if so, fix up */
2066 if (nbytes <= 0) {
2067
2068 /* Calculate maximum number of bytes that could be rewound in theory */
2069 nbytes = i->sink->thread_info.max_rewind + lbq;
2070
2071 /* Transform from sink domain */
2072 if (i->thread_info.resampler)
2073 nbytes = pa_resampler_request(i->thread_info.resampler, nbytes);
2074 }
2075
2076 /* Remember how much we actually want to rewrite */
2077 if (i->thread_info.rewrite_nbytes != (size_t) -1) {
2078 if (rewrite) {
2079 /* Make sure to not overwrite over underruns */
2080 if (nbytes > i->thread_info.playing_for)
2081 nbytes = (size_t) i->thread_info.playing_for;
2082
2083 i->thread_info.rewrite_nbytes = nbytes;
2084 } else
2085 i->thread_info.rewrite_nbytes = (size_t) -1;
2086 }
2087
2088 i->thread_info.rewrite_flush =
2089 i->thread_info.rewrite_flush || flush;
2090
2091 i->thread_info.dont_rewind_render =
2092 i->thread_info.dont_rewind_render ||
2093 dont_rewind_render;
2094
2095 /* nbytes is -1 if some earlier rewind request had rewrite == false. */
2096 if (nbytes != (size_t) -1) {
2097
2098 /* Transform to sink domain */
2099 if (i->thread_info.resampler)
2100 nbytes = pa_resampler_result(i->thread_info.resampler, nbytes);
2101
2102 if (nbytes > lbq)
2103 pa_sink_request_rewind(i->sink, nbytes - lbq);
2104 else
2105 /* This call will make sure process_rewind() is called later */
2106 pa_sink_request_rewind(i->sink, 0);
2107 }
2108 }
2109
2110 /* Called from main context */
2111 pa_memchunk* pa_sink_input_get_silence(pa_sink_input *i, pa_memchunk *ret) {
2112 pa_sink_input_assert_ref(i);
2113 pa_assert_ctl_context();
2114 pa_assert(ret);
2115
2116 /* FIXME: Shouldn't access resampler object from main context! */
2117
2118 pa_silence_memchunk_get(
2119 &i->core->silence_cache,
2120 i->core->mempool,
2121 ret,
2122 &i->sample_spec,
2123 i->thread_info.resampler ? pa_resampler_max_block_size(i->thread_info.resampler) : 0);
2124
2125 return ret;
2126 }
2127
2128 /* Called from main context */
2129 void pa_sink_input_send_event(pa_sink_input *i, const char *event, pa_proplist *data) {
2130 pa_proplist *pl = NULL;
2131 pa_sink_input_send_event_hook_data hook_data;
2132
2133 pa_sink_input_assert_ref(i);
2134 pa_assert_ctl_context();
2135 pa_assert(event);
2136
2137 if (!i->send_event)
2138 return;
2139
2140 if (!data)
2141 data = pl = pa_proplist_new();
2142
2143 hook_data.sink_input = i;
2144 hook_data.data = data;
2145 hook_data.event = event;
2146
2147 if (pa_hook_fire(&i->core->hooks[PA_CORE_HOOK_SINK_INPUT_SEND_EVENT], &hook_data) < 0)
2148 goto finish;
2149
2150 i->send_event(i, event, data);
2151
2152 finish:
2153 if (pl)
2154 pa_proplist_free(pl);
2155 }
2156
2157 /* Called from main context */
2158 /* Updates the sink input's resampler with whatever the current sink requires
2159 * -- useful when the underlying sink's rate might have changed */
2160 int pa_sink_input_update_rate(pa_sink_input *i) {
2161 pa_resampler *new_resampler;
2162 char *memblockq_name;
2163
2164 pa_sink_input_assert_ref(i);
2165 pa_assert_ctl_context();
2166
2167 if (i->thread_info.resampler &&
2168 pa_sample_spec_equal(pa_resampler_output_sample_spec(i->thread_info.resampler), &i->sink->sample_spec) &&
2169 pa_channel_map_equal(pa_resampler_output_channel_map(i->thread_info.resampler), &i->sink->channel_map))
2170
2171 new_resampler = i->thread_info.resampler;
2172
2173 else if (!pa_sink_input_is_passthrough(i) &&
2174 ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ||
2175 !pa_sample_spec_equal(&i->sample_spec, &i->sink->sample_spec) ||
2176 !pa_channel_map_equal(&i->channel_map, &i->sink->channel_map))) {
2177
2178 new_resampler = pa_resampler_new(i->core->mempool,
2179 &i->sample_spec, &i->channel_map,
2180 &i->sink->sample_spec, &i->sink->channel_map,
2181 i->requested_resample_method,
2182 ((i->flags & PA_SINK_INPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
2183 ((i->flags & PA_SINK_INPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
2184 (i->core->disable_remixing || (i->flags & PA_SINK_INPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0) |
2185 (i->core->disable_lfe_remixing ? PA_RESAMPLER_NO_LFE : 0));
2186
2187 if (!new_resampler) {
2188 pa_log_warn("Unsupported resampling operation.");
2189 return -PA_ERR_NOTSUPPORTED;
2190 }
2191 } else
2192 new_resampler = NULL;
2193
2194 if (new_resampler == i->thread_info.resampler)
2195 return 0;
2196
2197 if (i->thread_info.resampler)
2198 pa_resampler_free(i->thread_info.resampler);
2199
2200 i->thread_info.resampler = new_resampler;
2201
2202 pa_memblockq_free(i->thread_info.render_memblockq);
2203
2204 memblockq_name = pa_sprintf_malloc("sink input render_memblockq [%u]", i->index);
2205 i->thread_info.render_memblockq = pa_memblockq_new(
2206 memblockq_name,
2207 0,
2208 MEMBLOCKQ_MAXLENGTH,
2209 0,
2210 &i->sink->sample_spec,
2211 0,
2212 1,
2213 0,
2214 &i->sink->silence);
2215 pa_xfree(memblockq_name);
2216
2217 i->actual_resample_method = new_resampler ? pa_resampler_get_method(new_resampler) : PA_RESAMPLER_INVALID;
2218
2219 pa_log_debug("Updated resampler for sink input %d", i->index);
2220
2221 return 0;
2222 }
2223
2224 /* Called from the main thread. */
2225 void pa_sink_input_set_volume_direct(pa_sink_input *i, const pa_cvolume *volume) {
2226 pa_cvolume old_volume;
2227 char old_volume_str[PA_CVOLUME_SNPRINT_VERBOSE_MAX];
2228 char new_volume_str[PA_CVOLUME_SNPRINT_VERBOSE_MAX];
2229
2230 pa_assert(i);
2231 pa_assert(volume);
2232
2233 old_volume = i->volume;
2234
2235 if (pa_cvolume_equal(volume, &old_volume))
2236 return;
2237
2238 i->volume = *volume;
2239 pa_log_debug("The volume of sink input %u changed from %s to %s.", i->index,
2240 pa_cvolume_snprint_verbose(old_volume_str, sizeof(old_volume_str), &old_volume, &i->channel_map, true),
2241 pa_cvolume_snprint_verbose(new_volume_str, sizeof(new_volume_str), volume, &i->channel_map, true));
2242
2243 if (i->volume_changed)
2244 i->volume_changed(i);
2245
2246 pa_subscription_post(i->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, i->index);
2247 }