2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2.1 of the License,
9 or (at your option) any later version.
11 PulseAudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
30 #include <pulse/utf8.h>
31 #include <pulse/xmalloc.h>
32 #include <pulse/util.h>
33 #include <pulse/internal.h>
35 #include <pulsecore/mix.h>
36 #include <pulsecore/core-subscribe.h>
37 #include <pulsecore/log.h>
38 #include <pulsecore/namereg.h>
39 #include <pulsecore/core-util.h>
41 #include "source-output.h"
43 #define MEMBLOCKQ_MAXLENGTH (32*1024*1024)
45 PA_DEFINE_PUBLIC_CLASS(pa_source_output, pa_msgobject);
47 static void source_output_free(pa_object* mo);
48 static void set_real_ratio(pa_source_output *o, const pa_cvolume *v);
50 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data) {
54 data->resample_method = PA_RESAMPLER_INVALID;
55 data->proplist = pa_proplist_new();
56 data->volume_writable = true;
61 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec) {
64 if ((data->sample_spec_is_set = !!spec))
65 data->sample_spec = *spec;
68 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map) {
71 if ((data->channel_map_is_set = !!map))
72 data->channel_map = *map;
75 bool pa_source_output_new_data_is_passthrough(pa_source_output_new_data *data) {
78 if (PA_LIKELY(data->format) && PA_UNLIKELY(!pa_format_info_is_pcm(data->format)))
81 if (PA_UNLIKELY(data->flags & PA_SOURCE_OUTPUT_PASSTHROUGH))
87 void pa_source_output_new_data_set_volume(pa_source_output_new_data *data, const pa_cvolume *volume) {
89 pa_assert(data->volume_writable);
91 if ((data->volume_is_set = !!volume))
92 data->volume = *volume;
95 void pa_source_output_new_data_apply_volume_factor(pa_source_output_new_data *data, const pa_cvolume *volume_factor) {
97 pa_assert(volume_factor);
99 if (data->volume_factor_is_set)
100 pa_sw_cvolume_multiply(&data->volume_factor, &data->volume_factor, volume_factor);
102 data->volume_factor_is_set = true;
103 data->volume_factor = *volume_factor;
107 void pa_source_output_new_data_apply_volume_factor_source(pa_source_output_new_data *data, const pa_cvolume *volume_factor) {
109 pa_assert(volume_factor);
111 if (data->volume_factor_source_is_set)
112 pa_sw_cvolume_multiply(&data->volume_factor_source, &data->volume_factor_source, volume_factor);
114 data->volume_factor_source_is_set = true;
115 data->volume_factor_source = *volume_factor;
119 void pa_source_output_new_data_set_muted(pa_source_output_new_data *data, bool mute) {
122 data->muted_is_set = true;
123 data->muted = !!mute;
126 bool pa_source_output_new_data_set_source(pa_source_output_new_data *data, pa_source *s, bool save) {
128 pa_idxset *formats = NULL;
133 if (!data->req_formats) {
134 /* We're not working with the extended API */
136 data->save_source = save;
138 /* Extended API: let's see if this source supports the formats the client would like */
139 formats = pa_source_check_formats(s, data->req_formats);
141 if (formats && !pa_idxset_isempty(formats)) {
142 /* Source supports at least one of the requested formats */
144 data->save_source = save;
145 if (data->nego_formats)
146 pa_idxset_free(data->nego_formats, (pa_free_cb_t) pa_format_info_free);
147 data->nego_formats = formats;
149 /* Source doesn't support any of the formats requested by the client */
151 pa_idxset_free(formats, (pa_free_cb_t) pa_format_info_free);
159 bool pa_source_output_new_data_set_formats(pa_source_output_new_data *data, pa_idxset *formats) {
163 if (data->req_formats)
164 pa_idxset_free(formats, (pa_free_cb_t) pa_format_info_free);
166 data->req_formats = formats;
169 /* Trigger format negotiation */
170 return pa_source_output_new_data_set_source(data, data->source, data->save_source);
176 void pa_source_output_new_data_done(pa_source_output_new_data *data) {
179 if (data->req_formats)
180 pa_idxset_free(data->req_formats, (pa_free_cb_t) pa_format_info_free);
182 if (data->nego_formats)
183 pa_idxset_free(data->nego_formats, (pa_free_cb_t) pa_format_info_free);
186 pa_format_info_free(data->format);
188 pa_proplist_free(data->proplist);
191 /* Called from main context */
192 static void reset_callbacks(pa_source_output *o) {
196 o->process_rewind = NULL;
197 o->update_max_rewind = NULL;
198 o->update_source_requested_latency = NULL;
199 o->update_source_latency_range = NULL;
200 o->update_source_fixed_latency = NULL;
204 o->suspend_within_thread = NULL;
207 o->get_latency = NULL;
208 o->state_change = NULL;
209 o->may_move_to = NULL;
210 o->send_event = NULL;
211 o->volume_changed = NULL;
212 o->mute_changed = NULL;
215 /* Called from main context */
216 int pa_source_output_new(
217 pa_source_output**_o,
219 pa_source_output_new_data *data) {
222 pa_resampler *resampler = NULL;
223 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
224 pa_channel_map original_cm;
233 pa_assert_ctl_context();
236 pa_proplist_update(data->proplist, PA_UPDATE_MERGE, data->client->proplist);
238 if (data->destination_source && (data->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER))
239 data->volume_writable = false;
241 if (!data->req_formats) {
242 /* From this point on, we want to work only with formats, and get back
243 * to using the sample spec and channel map after all decisions w.r.t.
244 * routing are complete. */
245 pa_idxset *tmp = pa_idxset_new(NULL, NULL);
246 pa_format_info *f = pa_format_info_from_sample_spec(&data->sample_spec,
247 data->channel_map_is_set ? &data->channel_map : NULL);
248 pa_idxset_put(tmp, f, NULL);
249 pa_source_output_new_data_set_formats(data, tmp);
252 if ((r = pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_NEW], data)) < 0)
255 pa_return_val_if_fail(!data->driver || pa_utf8_valid(data->driver), -PA_ERR_INVALID);
260 if (data->direct_on_input) {
261 source = data->direct_on_input->sink->monitor_source;
262 pa_return_val_if_fail(source, -PA_ERR_INVALID);
264 source = pa_namereg_get(core, NULL, PA_NAMEREG_SOURCE);
265 pa_return_val_if_fail(source, -PA_ERR_NOENTITY);
268 pa_source_output_new_data_set_source(data, source, false);
271 /* Routing's done, we have a source. Now let's fix the format and set up the
274 /* If something didn't pick a format for us, pick the top-most format since
275 * we assume this is sorted in priority order */
276 if (!data->format && data->nego_formats && !pa_idxset_isempty(data->nego_formats))
277 data->format = pa_format_info_copy(pa_idxset_first(data->nego_formats, NULL));
279 pa_return_val_if_fail(data->format, -PA_ERR_NOTSUPPORTED);
281 /* Now populate the sample spec and format according to the final
282 * format that we've negotiated */
283 pa_return_val_if_fail(pa_format_info_to_sample_spec(data->format, &ss, &map) == 0, -PA_ERR_INVALID);
284 pa_source_output_new_data_set_sample_spec(data, &ss);
285 if (pa_format_info_is_pcm(data->format) && pa_channel_map_valid(&map))
286 pa_source_output_new_data_set_channel_map(data, &map);
288 pa_return_val_if_fail(PA_SOURCE_IS_LINKED(pa_source_get_state(data->source)), -PA_ERR_BADSTATE);
289 pa_return_val_if_fail(!data->direct_on_input || data->direct_on_input->sink == data->source->monitor_of, -PA_ERR_INVALID);
291 if (!data->sample_spec_is_set)
292 data->sample_spec = data->source->sample_spec;
294 pa_return_val_if_fail(pa_sample_spec_valid(&data->sample_spec), -PA_ERR_INVALID);
296 if (!data->channel_map_is_set) {
297 if (pa_channel_map_compatible(&data->source->channel_map, &data->sample_spec))
298 data->channel_map = data->source->channel_map;
300 pa_channel_map_init_extend(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT);
303 pa_return_val_if_fail(pa_channel_map_compatible(&data->channel_map, &data->sample_spec), -PA_ERR_INVALID);
305 /* Don't restore (or save) stream volume for passthrough streams and
306 * prevent attenuation/gain */
307 if (pa_source_output_new_data_is_passthrough(data)) {
308 data->volume_is_set = true;
309 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
310 data->volume_is_absolute = true;
311 data->save_volume = false;
314 if (!data->volume_is_set) {
315 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
316 data->volume_is_absolute = false;
317 data->save_volume = false;
320 if (!data->volume_writable)
321 data->save_volume = false;
323 pa_return_val_if_fail(pa_cvolume_compatible(&data->volume, &data->sample_spec), -PA_ERR_INVALID);
325 if (!data->volume_factor_is_set)
326 pa_cvolume_reset(&data->volume_factor, data->sample_spec.channels);
328 pa_return_val_if_fail(pa_cvolume_compatible(&data->volume_factor, &data->sample_spec), -PA_ERR_INVALID);
330 if (!data->volume_factor_source_is_set)
331 pa_cvolume_reset(&data->volume_factor_source, data->source->sample_spec.channels);
333 pa_return_val_if_fail(pa_cvolume_compatible(&data->volume_factor_source, &data->source->sample_spec), -PA_ERR_INVALID);
335 if (!data->muted_is_set)
338 if (data->flags & PA_SOURCE_OUTPUT_FIX_FORMAT) {
339 pa_return_val_if_fail(pa_format_info_is_pcm(data->format), -PA_ERR_INVALID);
340 data->sample_spec.format = data->source->sample_spec.format;
341 pa_format_info_set_sample_format(data->format, data->sample_spec.format);
344 if (data->flags & PA_SOURCE_OUTPUT_FIX_RATE) {
345 pa_return_val_if_fail(pa_format_info_is_pcm(data->format), -PA_ERR_INVALID);
346 pa_format_info_set_rate(data->format, data->sample_spec.rate);
347 data->sample_spec.rate = data->source->sample_spec.rate;
350 original_cm = data->channel_map;
352 if (data->flags & PA_SOURCE_OUTPUT_FIX_CHANNELS) {
353 pa_return_val_if_fail(pa_format_info_is_pcm(data->format), -PA_ERR_INVALID);
354 data->sample_spec.channels = data->source->sample_spec.channels;
355 data->channel_map = data->source->channel_map;
356 pa_format_info_set_channels(data->format, data->sample_spec.channels);
357 pa_format_info_set_channel_map(data->format, &data->channel_map);
360 pa_assert(pa_sample_spec_valid(&data->sample_spec));
361 pa_assert(pa_channel_map_valid(&data->channel_map));
363 if (!(data->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) &&
364 !pa_sample_spec_equal(&data->sample_spec, &data->source->sample_spec)) {
365 /* try to change source rate. This is done before the FIXATE hook since
366 module-suspend-on-idle can resume a source */
368 pa_log_info("Trying to change sample rate");
369 if (pa_source_update_rate(data->source, data->sample_spec.rate, pa_source_output_new_data_is_passthrough(data)) == true)
370 pa_log_info("Rate changed to %u Hz", data->source->sample_spec.rate);
373 if (pa_source_output_new_data_is_passthrough(data) &&
374 !pa_sample_spec_equal(&data->sample_spec, &data->source->sample_spec)) {
375 /* rate update failed, or other parts of sample spec didn't match */
377 pa_log_debug("Could not update source sample spec to match passthrough stream");
378 return -PA_ERR_NOTSUPPORTED;
381 /* Due to the fixing of the sample spec the volume might not match anymore */
382 pa_cvolume_remap(&data->volume, &original_cm, &data->channel_map);
384 if (data->resample_method == PA_RESAMPLER_INVALID)
385 data->resample_method = core->resample_method;
387 pa_return_val_if_fail(data->resample_method < PA_RESAMPLER_MAX, -PA_ERR_INVALID);
389 if ((r = pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE], data)) < 0)
392 if ((data->flags & PA_SOURCE_OUTPUT_NO_CREATE_ON_SUSPEND) &&
393 pa_source_get_state(data->source) == PA_SOURCE_SUSPENDED) {
394 pa_log("Failed to create source output: source is suspended.");
395 return -PA_ERR_BADSTATE;
398 if (pa_idxset_size(data->source->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
399 pa_log("Failed to create source output: too many outputs per source.");
400 return -PA_ERR_TOOLARGE;
403 if ((data->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
404 !pa_sample_spec_equal(&data->sample_spec, &data->source->sample_spec) ||
405 !pa_channel_map_equal(&data->channel_map, &data->source->channel_map)) {
407 if (!pa_source_output_new_data_is_passthrough(data)) /* no resampler for passthrough content */
408 if (!(resampler = pa_resampler_new(
410 &data->source->sample_spec, &data->source->channel_map,
411 &data->sample_spec, &data->channel_map,
412 data->resample_method,
413 ((data->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
414 ((data->flags & PA_SOURCE_OUTPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
415 (core->disable_remixing || (data->flags & PA_SOURCE_OUTPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0) |
416 (core->disable_lfe_remixing ? PA_RESAMPLER_NO_LFE : 0)))) {
417 pa_log_warn("Unsupported resampling operation.");
418 return -PA_ERR_NOTSUPPORTED;
422 o = pa_msgobject_new(pa_source_output);
423 o->parent.parent.free = source_output_free;
424 o->parent.process_msg = pa_source_output_process_msg;
427 o->state = PA_SOURCE_OUTPUT_INIT;
428 o->flags = data->flags;
429 o->proplist = pa_proplist_copy(data->proplist);
430 o->driver = pa_xstrdup(pa_path_get_filename(data->driver));
431 o->module = data->module;
432 o->source = data->source;
433 o->destination_source = data->destination_source;
434 o->client = data->client;
436 o->requested_resample_method = data->resample_method;
437 o->actual_resample_method = resampler ? pa_resampler_get_method(resampler) : PA_RESAMPLER_INVALID;
438 o->sample_spec = data->sample_spec;
439 o->channel_map = data->channel_map;
440 o->format = pa_format_info_copy(data->format);
442 if (!data->volume_is_absolute && pa_source_flat_volume_enabled(o->source)) {
445 /* When the 'absolute' bool is not set then we'll treat the volume
446 * as relative to the source volume even in flat volume mode */
447 remapped = data->source->reference_volume;
448 pa_cvolume_remap(&remapped, &data->source->channel_map, &data->channel_map);
449 pa_sw_cvolume_multiply(&o->volume, &data->volume, &remapped);
451 o->volume = data->volume;
453 o->volume_factor = data->volume_factor;
454 o->volume_factor_source = data->volume_factor_source;
455 o->real_ratio = o->reference_ratio = data->volume;
456 pa_cvolume_reset(&o->soft_volume, o->sample_spec.channels);
457 pa_cvolume_reset(&o->real_ratio, o->sample_spec.channels);
458 o->volume_writable = data->volume_writable;
459 o->save_volume = data->save_volume;
460 o->save_source = data->save_source;
461 o->save_muted = data->save_muted;
463 o->muted = data->muted;
465 o->direct_on_input = data->direct_on_input;
470 o->thread_info.state = o->state;
471 o->thread_info.attached = false;
472 o->thread_info.sample_spec = o->sample_spec;
473 o->thread_info.resampler = resampler;
474 o->thread_info.soft_volume = o->soft_volume;
475 o->thread_info.muted = o->muted;
476 o->thread_info.requested_source_latency = (pa_usec_t) -1;
477 o->thread_info.direct_on_input = o->direct_on_input;
479 o->thread_info.delay_memblockq = pa_memblockq_new(
480 "source output delay_memblockq",
484 &o->source->sample_spec,
488 &o->source->silence);
490 pa_assert_se(pa_idxset_put(core->source_outputs, o, &o->index) == 0);
491 pa_assert_se(pa_idxset_put(o->source->outputs, pa_source_output_ref(o), NULL) == 0);
494 pa_assert_se(pa_idxset_put(o->client->source_outputs, o, NULL) >= 0);
496 if (o->direct_on_input)
497 pa_assert_se(pa_idxset_put(o->direct_on_input->direct_outputs, o, NULL) == 0);
499 pt = pa_proplist_to_string_sep(o->proplist, "\n ");
500 pa_log_info("Created output %u \"%s\" on %s with sample spec %s and channel map %s\n %s",
502 pa_strnull(pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME)),
504 pa_sample_spec_snprint(st, sizeof(st), &o->sample_spec),
505 pa_channel_map_snprint(cm, sizeof(cm), &o->channel_map),
509 /* Don't forget to call pa_source_output_put! */
515 /* Called from main context */
516 static void update_n_corked(pa_source_output *o, pa_source_output_state_t state) {
518 pa_assert_ctl_context();
523 if (o->state == PA_SOURCE_OUTPUT_CORKED && state != PA_SOURCE_OUTPUT_CORKED)
524 pa_assert_se(o->source->n_corked -- >= 1);
525 else if (o->state != PA_SOURCE_OUTPUT_CORKED && state == PA_SOURCE_OUTPUT_CORKED)
526 o->source->n_corked++;
529 /* Called from main context */
530 static void source_output_set_state(pa_source_output *o, pa_source_output_state_t state) {
533 pa_assert_ctl_context();
535 if (o->state == state)
538 if (o->state == PA_SOURCE_OUTPUT_CORKED && state == PA_SOURCE_OUTPUT_RUNNING && pa_source_used_by(o->source) == 0 &&
539 !pa_sample_spec_equal(&o->sample_spec, &o->source->sample_spec)) {
540 /* We were uncorked and the source was not playing anything -- let's try
541 * to update the sample rate to avoid resampling */
542 pa_source_update_rate(o->source, o->sample_spec.rate, pa_source_output_is_passthrough(o));
545 pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) == 0);
547 update_n_corked(o, state);
550 if (state != PA_SOURCE_OUTPUT_UNLINKED) {
551 pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED], o);
553 if (PA_SOURCE_OUTPUT_IS_LINKED(state))
554 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
557 pa_source_update_status(o->source);
560 /* Called from main context */
561 void pa_source_output_unlink(pa_source_output*o) {
564 pa_assert_ctl_context();
566 /* See pa_sink_unlink() for a couple of comments how this function
569 pa_source_output_ref(o);
571 linked = PA_SOURCE_OUTPUT_IS_LINKED(o->state);
574 pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK], o);
576 if (o->direct_on_input)
577 pa_idxset_remove_by_data(o->direct_on_input->direct_outputs, o, NULL);
579 pa_idxset_remove_by_data(o->core->source_outputs, o, NULL);
582 if (pa_idxset_remove_by_data(o->source->outputs, o, NULL))
583 pa_source_output_unref(o);
586 pa_idxset_remove_by_data(o->client->source_outputs, o, NULL);
588 update_n_corked(o, PA_SOURCE_OUTPUT_UNLINKED);
589 o->state = PA_SOURCE_OUTPUT_UNLINKED;
591 if (linked && o->source) {
592 if (pa_source_output_is_passthrough(o))
593 pa_source_leave_passthrough(o->source);
595 /* We might need to update the source's volume if we are in flat volume mode. */
596 if (pa_source_flat_volume_enabled(o->source))
597 pa_source_set_volume(o->source, NULL, false, false);
599 if (o->source->asyncmsgq)
600 pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL) == 0);
606 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_REMOVE, o->index);
607 pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST], o);
611 if (PA_SOURCE_IS_LINKED(pa_source_get_state(o->source)))
612 pa_source_update_status(o->source);
617 pa_core_maybe_vacuum(o->core);
619 pa_source_output_unref(o);
622 /* Called from main context */
623 static void source_output_free(pa_object* mo) {
624 pa_source_output *o = PA_SOURCE_OUTPUT(mo);
627 pa_assert_ctl_context();
628 pa_assert(pa_source_output_refcnt(o) == 0);
630 if (PA_SOURCE_OUTPUT_IS_LINKED(o->state))
631 pa_source_output_unlink(o);
633 pa_log_info("Freeing output %u \"%s\"", o->index, pa_strnull(pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME)));
635 if (o->thread_info.delay_memblockq)
636 pa_memblockq_free(o->thread_info.delay_memblockq);
638 if (o->thread_info.resampler)
639 pa_resampler_free(o->thread_info.resampler);
642 pa_format_info_free(o->format);
645 pa_proplist_free(o->proplist);
651 /* Called from main context */
652 void pa_source_output_put(pa_source_output *o) {
653 pa_source_output_state_t state;
655 pa_source_output_assert_ref(o);
656 pa_assert_ctl_context();
658 pa_assert(o->state == PA_SOURCE_OUTPUT_INIT);
660 /* The following fields must be initialized properly */
664 state = o->flags & PA_SOURCE_OUTPUT_START_CORKED ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING;
666 update_n_corked(o, state);
669 /* We might need to update the source's volume if we are in flat volume mode. */
670 if (pa_source_flat_volume_enabled(o->source))
671 pa_source_set_volume(o->source, NULL, false, o->save_volume);
673 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
674 pa_assert(pa_cvolume_is_norm(&o->volume));
675 pa_assert(pa_cvolume_is_norm(&o->reference_ratio));
678 set_real_ratio(o, &o->volume);
681 if (pa_source_output_is_passthrough(o))
682 pa_source_enter_passthrough(o->source);
684 o->thread_info.soft_volume = o->soft_volume;
685 o->thread_info.muted = o->muted;
687 pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL) == 0);
689 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW, o->index);
690 pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PUT], o);
692 pa_source_update_status(o->source);
695 /* Called from main context */
696 void pa_source_output_kill(pa_source_output*o) {
697 pa_source_output_assert_ref(o);
698 pa_assert_ctl_context();
699 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
704 /* Called from main context */
705 pa_usec_t pa_source_output_get_latency(pa_source_output *o, pa_usec_t *source_latency) {
706 pa_usec_t r[2] = { 0, 0 };
708 pa_source_output_assert_ref(o);
709 pa_assert_ctl_context();
710 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
712 pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY, r, 0, NULL) == 0);
715 r[0] += o->get_latency(o);
718 *source_latency = r[1];
723 /* Called from thread context */
724 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk) {
725 bool need_volume_factor_source;
728 size_t limit, mbs = 0;
730 pa_source_output_assert_ref(o);
731 pa_source_output_assert_io_context(o);
732 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->thread_info.state));
734 pa_assert(pa_frame_aligned(chunk->length, &o->source->sample_spec));
736 if (!o->push || o->thread_info.state == PA_SOURCE_OUTPUT_CORKED)
739 pa_assert(o->thread_info.state == PA_SOURCE_OUTPUT_RUNNING);
741 if (pa_memblockq_push(o->thread_info.delay_memblockq, chunk) < 0) {
742 pa_log_debug("Delay queue overflow!");
743 pa_memblockq_seek(o->thread_info.delay_memblockq, (int64_t) chunk->length, PA_SEEK_RELATIVE, true);
746 limit = o->process_rewind ? 0 : o->source->thread_info.max_rewind;
748 volume_is_norm = pa_cvolume_is_norm(&o->thread_info.soft_volume) && !o->thread_info.muted;
749 need_volume_factor_source = !pa_cvolume_is_norm(&o->volume_factor_source);
751 if (limit > 0 && o->source->monitor_of) {
755 /* Hmm, check the latency for knowing how much of the buffered
756 * data is actually still unplayed and might hence still
757 * change. This is suboptimal. Ideally we'd have a call like
758 * pa_sink_get_changeable_size() or so that tells us how much
759 * of the queued data is actually still changeable. Hence
762 latency = pa_sink_get_latency_within_thread(o->source->monitor_of);
764 n = pa_usec_to_bytes(latency, &o->source->sample_spec);
770 /* Implement the delay queue */
771 while ((length = pa_memblockq_get_length(o->thread_info.delay_memblockq)) > limit) {
773 bool nvfs = need_volume_factor_source;
777 pa_assert_se(pa_memblockq_peek(o->thread_info.delay_memblockq, &qchunk) >= 0);
779 if (qchunk.length > length)
780 qchunk.length = length;
782 pa_assert(qchunk.length > 0);
784 /* It might be necessary to adjust the volume here */
785 if (!volume_is_norm) {
786 pa_memchunk_make_writable(&qchunk, 0);
788 if (o->thread_info.muted) {
789 pa_silence_memchunk(&qchunk, &o->source->sample_spec);
792 } else if (!o->thread_info.resampler && nvfs) {
795 /* If we don't need a resampler we can merge the
796 * post and the pre volume adjustment into one */
798 pa_sw_cvolume_multiply(&v, &o->thread_info.soft_volume, &o->volume_factor_source);
799 pa_volume_memchunk(&qchunk, &o->source->sample_spec, &v);
803 pa_volume_memchunk(&qchunk, &o->source->sample_spec, &o->thread_info.soft_volume);
806 if (!o->thread_info.resampler) {
808 pa_memchunk_make_writable(&qchunk, 0);
809 pa_volume_memchunk(&qchunk, &o->thread_info.sample_spec, &o->volume_factor_source);
817 mbs = pa_resampler_max_block_size(o->thread_info.resampler);
819 if (qchunk.length > mbs)
822 pa_resampler_run(o->thread_info.resampler, &qchunk, &rchunk);
824 if (rchunk.length > 0) {
826 pa_memchunk_make_writable(&rchunk, 0);
827 pa_volume_memchunk(&rchunk, &o->thread_info.sample_spec, &o->volume_factor_source);
834 pa_memblock_unref(rchunk.memblock);
837 pa_memblock_unref(qchunk.memblock);
838 pa_memblockq_drop(o->thread_info.delay_memblockq, qchunk.length);
842 /* Called from thread context */
843 void pa_source_output_process_rewind(pa_source_output *o, size_t nbytes /* in source sample spec */) {
845 pa_source_output_assert_ref(o);
846 pa_source_output_assert_io_context(o);
847 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->thread_info.state));
848 pa_assert(pa_frame_aligned(nbytes, &o->source->sample_spec));
853 if (o->process_rewind) {
854 pa_assert(pa_memblockq_get_length(o->thread_info.delay_memblockq) == 0);
856 if (o->thread_info.resampler)
857 nbytes = pa_resampler_result(o->thread_info.resampler, nbytes);
859 pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) nbytes);
862 o->process_rewind(o, nbytes);
864 if (o->thread_info.resampler)
865 pa_resampler_reset(o->thread_info.resampler);
868 pa_memblockq_rewind(o->thread_info.delay_memblockq, nbytes);
871 /* Called from thread context */
872 size_t pa_source_output_get_max_rewind(pa_source_output *o) {
873 pa_source_output_assert_ref(o);
874 pa_source_output_assert_io_context(o);
876 return o->thread_info.resampler ? pa_resampler_request(o->thread_info.resampler, o->source->thread_info.max_rewind) : o->source->thread_info.max_rewind;
879 /* Called from thread context */
880 void pa_source_output_update_max_rewind(pa_source_output *o, size_t nbytes /* in the source's sample spec */) {
881 pa_source_output_assert_ref(o);
882 pa_source_output_assert_io_context(o);
883 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->thread_info.state));
884 pa_assert(pa_frame_aligned(nbytes, &o->source->sample_spec));
886 if (o->update_max_rewind)
887 o->update_max_rewind(o, o->thread_info.resampler ? pa_resampler_result(o->thread_info.resampler, nbytes) : nbytes);
890 /* Called from thread context */
891 pa_usec_t pa_source_output_set_requested_latency_within_thread(pa_source_output *o, pa_usec_t usec) {
892 pa_source_output_assert_ref(o);
893 pa_source_output_assert_io_context(o);
895 if (!(o->source->flags & PA_SOURCE_DYNAMIC_LATENCY))
896 usec = o->source->thread_info.fixed_latency;
898 if (usec != (pa_usec_t) -1)
899 usec = PA_CLAMP(usec, o->source->thread_info.min_latency, o->source->thread_info.max_latency);
901 o->thread_info.requested_source_latency = usec;
902 pa_source_invalidate_requested_latency(o->source, true);
907 /* Called from main context */
908 pa_usec_t pa_source_output_set_requested_latency(pa_source_output *o, pa_usec_t usec) {
909 pa_source_output_assert_ref(o);
910 pa_assert_ctl_context();
912 if (PA_SOURCE_OUTPUT_IS_LINKED(o->state) && o->source) {
913 pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
917 /* If this source output is not realized yet or is being moved, we
918 * have to touch the thread info data directly */
921 if (!(o->source->flags & PA_SOURCE_DYNAMIC_LATENCY))
922 usec = pa_source_get_fixed_latency(o->source);
924 if (usec != (pa_usec_t) -1) {
925 pa_usec_t min_latency, max_latency;
926 pa_source_get_latency_range(o->source, &min_latency, &max_latency);
927 usec = PA_CLAMP(usec, min_latency, max_latency);
931 o->thread_info.requested_source_latency = usec;
936 /* Called from main context */
937 pa_usec_t pa_source_output_get_requested_latency(pa_source_output *o) {
938 pa_source_output_assert_ref(o);
939 pa_assert_ctl_context();
941 if (PA_SOURCE_OUTPUT_IS_LINKED(o->state) && o->source) {
943 pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) == 0);
947 /* If this source output is not realized yet or is being moved, we
948 * have to touch the thread info data directly */
950 return o->thread_info.requested_source_latency;
953 /* Called from main context */
954 void pa_source_output_set_volume(pa_source_output *o, const pa_cvolume *volume, bool save, bool absolute) {
957 pa_source_output_assert_ref(o);
958 pa_assert_ctl_context();
959 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
961 pa_assert(pa_cvolume_valid(volume));
962 pa_assert(volume->channels == 1 || pa_cvolume_compatible(volume, &o->sample_spec));
963 pa_assert(o->volume_writable);
965 if (!absolute && pa_source_flat_volume_enabled(o->source)) {
966 v = o->source->reference_volume;
967 pa_cvolume_remap(&v, &o->source->channel_map, &o->channel_map);
969 if (pa_cvolume_compatible(volume, &o->sample_spec))
970 volume = pa_sw_cvolume_multiply(&v, &v, volume);
972 volume = pa_sw_cvolume_multiply_scalar(&v, &v, pa_cvolume_max(volume));
974 if (!pa_cvolume_compatible(volume, &o->sample_spec)) {
976 volume = pa_cvolume_scale(&v, pa_cvolume_max(volume));
980 if (pa_cvolume_equal(volume, &o->volume)) {
981 o->save_volume = o->save_volume || save;
986 o->save_volume = save;
988 if (pa_source_flat_volume_enabled(o->source)) {
989 /* We are in flat volume mode, so let's update all source input
990 * volumes and update the flat volume of the source */
992 pa_source_set_volume(o->source, NULL, true, save);
995 /* OK, we are in normal volume mode. The volume only affects
997 set_real_ratio(o, volume);
999 /* Copy the new soft_volume to the thread_info struct */
1000 pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_VOLUME, NULL, 0, NULL) == 0);
1003 /* The volume changed, let's tell people so */
1004 if (o->volume_changed)
1005 o->volume_changed(o);
1007 /* The virtual volume changed, let's tell people so */
1008 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1011 /* Called from main context */
1012 static void set_real_ratio(pa_source_output *o, const pa_cvolume *v) {
1013 pa_source_output_assert_ref(o);
1014 pa_assert_ctl_context();
1015 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1016 pa_assert(!v || pa_cvolume_compatible(v, &o->sample_spec));
1018 /* This basically calculates:
1020 * o->real_ratio := v
1021 * o->soft_volume := o->real_ratio * o->volume_factor */
1026 pa_cvolume_reset(&o->real_ratio, o->sample_spec.channels);
1028 pa_sw_cvolume_multiply(&o->soft_volume, &o->real_ratio, &o->volume_factor);
1029 /* We don't copy the data to the thread_info data. That's left for someone else to do */
1032 /* Called from main or I/O context */
1033 bool pa_source_output_is_passthrough(pa_source_output *o) {
1034 pa_source_output_assert_ref(o);
1036 if (PA_UNLIKELY(!pa_format_info_is_pcm(o->format)))
1039 if (PA_UNLIKELY(o->flags & PA_SOURCE_OUTPUT_PASSTHROUGH))
1045 /* Called from main context */
1046 bool pa_source_output_is_volume_readable(pa_source_output *o) {
1047 pa_source_output_assert_ref(o);
1048 pa_assert_ctl_context();
1050 return !pa_source_output_is_passthrough(o);
1053 /* Called from main context */
1054 pa_cvolume *pa_source_output_get_volume(pa_source_output *o, pa_cvolume *volume, bool absolute) {
1055 pa_source_output_assert_ref(o);
1056 pa_assert_ctl_context();
1057 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1058 pa_assert(pa_source_output_is_volume_readable(o));
1060 if (absolute || !pa_source_flat_volume_enabled(o->source))
1061 *volume = o->volume;
1063 *volume = o->reference_ratio;
1068 /* Called from main context */
1069 void pa_source_output_set_mute(pa_source_output *o, bool mute, bool save) {
1070 pa_source_output_assert_ref(o);
1071 pa_assert_ctl_context();
1072 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1074 if (!o->muted == !mute) {
1075 o->save_muted = o->save_muted || mute;
1080 o->save_muted = save;
1082 pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_MUTE, NULL, 0, NULL) == 0);
1084 /* The mute status changed, let's tell people so */
1085 if (o->mute_changed)
1088 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1091 /* Called from main context */
1092 bool pa_source_output_get_mute(pa_source_output *o) {
1093 pa_source_output_assert_ref(o);
1094 pa_assert_ctl_context();
1095 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1100 /* Called from main thread */
1101 void pa_source_output_update_proplist(pa_source_output *o, pa_update_mode_t mode, pa_proplist *p) {
1102 pa_source_output_assert_ref(o);
1103 pa_assert_ctl_context();
1106 pa_proplist_update(o->proplist, mode, p);
1108 if (PA_SOURCE_OUTPUT_IS_LINKED(o->state)) {
1109 pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED], o);
1110 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1114 /* Called from main context */
1115 void pa_source_output_cork(pa_source_output *o, bool b) {
1116 pa_source_output_assert_ref(o);
1117 pa_assert_ctl_context();
1118 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1120 source_output_set_state(o, b ? PA_SOURCE_OUTPUT_CORKED : PA_SOURCE_OUTPUT_RUNNING);
1123 /* Called from main context */
1124 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate) {
1125 pa_source_output_assert_ref(o);
1126 pa_assert_ctl_context();
1127 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1128 pa_return_val_if_fail(o->thread_info.resampler, -PA_ERR_BADSTATE);
1130 if (o->sample_spec.rate == rate)
1133 o->sample_spec.rate = rate;
1135 pa_asyncmsgq_post(o->source->asyncmsgq, PA_MSGOBJECT(o), PA_SOURCE_OUTPUT_MESSAGE_SET_RATE, PA_UINT_TO_PTR(rate), 0, NULL, NULL);
1137 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1141 /* Called from main context */
1142 void pa_source_output_set_name(pa_source_output *o, const char *name) {
1144 pa_assert_ctl_context();
1145 pa_source_output_assert_ref(o);
1147 if (!name && !pa_proplist_contains(o->proplist, PA_PROP_MEDIA_NAME))
1150 old = pa_proplist_gets(o->proplist, PA_PROP_MEDIA_NAME);
1152 if (old && name && pa_streq(old, name))
1156 pa_proplist_sets(o->proplist, PA_PROP_MEDIA_NAME, name);
1158 pa_proplist_unset(o->proplist, PA_PROP_MEDIA_NAME);
1160 if (PA_SOURCE_OUTPUT_IS_LINKED(o->state)) {
1161 pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED], o);
1162 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1166 /* Called from main context */
1167 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o) {
1168 pa_source_output_assert_ref(o);
1169 pa_assert_ctl_context();
1171 return o->actual_resample_method;
1174 /* Called from main context */
1175 bool pa_source_output_may_move(pa_source_output *o) {
1176 pa_source_output_assert_ref(o);
1177 pa_assert_ctl_context();
1178 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1180 if (o->flags & PA_SOURCE_OUTPUT_DONT_MOVE)
1183 if (o->direct_on_input)
1189 static bool find_filter_source_output(pa_source_output *target, pa_source *s) {
1191 while (s && s->output_from_master) {
1192 if (s->output_from_master == target)
1194 s = s->output_from_master->source;
1195 pa_assert(i++ < 100);
1200 /* Called from main context */
1201 bool pa_source_output_may_move_to(pa_source_output *o, pa_source *dest) {
1202 pa_source_output_assert_ref(o);
1203 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1204 pa_source_assert_ref(dest);
1206 if (dest == o->source)
1209 if (!pa_source_output_may_move(o))
1212 /* Make sure we're not creating a filter source cycle */
1213 if (find_filter_source_output(o, dest)) {
1214 pa_log_debug("Can't connect output to %s, as that would create a cycle.", dest->name);
1218 if (pa_idxset_size(dest->outputs) >= PA_MAX_OUTPUTS_PER_SOURCE) {
1219 pa_log_warn("Failed to move source output: too many outputs per source.");
1224 if (!o->may_move_to(o, dest))
1230 /* Called from main context */
1231 int pa_source_output_start_move(pa_source_output *o) {
1235 pa_source_output_assert_ref(o);
1236 pa_assert_ctl_context();
1237 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1238 pa_assert(o->source);
1240 if (!pa_source_output_may_move(o))
1241 return -PA_ERR_NOTSUPPORTED;
1243 if ((r = pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_START], o)) < 0)
1248 pa_idxset_remove_by_data(o->source->outputs, o, NULL);
1250 if (pa_source_output_get_state(o) == PA_SOURCE_OUTPUT_CORKED)
1251 pa_assert_se(origin->n_corked-- >= 1);
1253 if (pa_source_output_is_passthrough(o))
1254 pa_source_leave_passthrough(o->source);
1256 if (pa_source_flat_volume_enabled(o->source))
1257 /* We might need to update the source's volume if we are in flat
1259 pa_source_set_volume(o->source, NULL, false, false);
1261 pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_REMOVE_OUTPUT, o, 0, NULL) == 0);
1263 pa_source_update_status(o->source);
1266 pa_source_output_unref(o);
1271 /* Called from main context. If it has an origin source that uses volume sharing,
1272 * then also the origin source and all streams connected to it need to update
1273 * their volume - this function does all that by using recursion. */
1274 static void update_volume_due_to_moving(pa_source_output *o, pa_source *dest) {
1275 pa_cvolume old_volume;
1279 pa_assert(o->source); /* The destination source should already be set. */
1281 if (o->destination_source && (o->destination_source->flags & PA_SOURCE_SHARE_VOLUME_WITH_MASTER)) {
1282 pa_source *root_source;
1283 pa_source_output *destination_source_output;
1286 root_source = pa_source_get_master(o->source);
1288 if (PA_UNLIKELY(!root_source))
1291 if (pa_source_flat_volume_enabled(o->source)) {
1292 /* Ok, so the origin source uses volume sharing, and flat volume is
1293 * enabled. The volume will have to be updated as follows:
1295 * o->volume := o->source->real_volume
1296 * (handled later by pa_source_set_volume)
1297 * o->reference_ratio := o->volume / o->source->reference_volume
1298 * (handled later by pa_source_set_volume)
1299 * o->real_ratio stays unchanged
1300 * (streams whose origin source uses volume sharing should
1301 * always have real_ratio of 0 dB)
1302 * o->soft_volume stays unchanged
1303 * (streams whose origin source uses volume sharing should
1304 * always have volume_factor as soft_volume, so no change
1305 * should be needed) */
1307 pa_assert(pa_cvolume_is_norm(&o->real_ratio));
1308 pa_assert(pa_cvolume_equal(&o->soft_volume, &o->volume_factor));
1310 /* Notifications will be sent by pa_source_set_volume(). */
1313 /* Ok, so the origin source uses volume sharing, and flat volume is
1314 * disabled. The volume will have to be updated as follows:
1317 * o->reference_ratio := 0 dB
1318 * o->real_ratio stays unchanged
1319 * (streams whose origin source uses volume sharing should
1320 * always have real_ratio of 0 dB)
1321 * o->soft_volume stays unchanged
1322 * (streams whose origin source uses volume sharing should
1323 * always have volume_factor as soft_volume, so no change
1324 * should be needed) */
1326 old_volume = o->volume;
1327 pa_cvolume_reset(&o->volume, o->volume.channels);
1328 pa_cvolume_reset(&o->reference_ratio, o->reference_ratio.channels);
1329 pa_assert(pa_cvolume_is_norm(&o->real_ratio));
1330 pa_assert(pa_cvolume_equal(&o->soft_volume, &o->volume_factor));
1332 /* Notify others about the changed source output volume. */
1333 if (!pa_cvolume_equal(&o->volume, &old_volume)) {
1334 if (o->volume_changed)
1335 o->volume_changed(o);
1337 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1341 /* Additionally, the origin source volume needs updating:
1343 * o->destination_source->reference_volume := root_source->reference_volume
1344 * o->destination_source->real_volume := root_source->real_volume
1345 * o->destination_source->soft_volume stays unchanged
1346 * (sources that use volume sharing should always have
1347 * soft_volume of 0 dB) */
1349 old_volume = o->destination_source->reference_volume;
1351 o->destination_source->reference_volume = root_source->reference_volume;
1352 pa_cvolume_remap(&o->destination_source->reference_volume, &root_source->channel_map, &o->destination_source->channel_map);
1354 o->destination_source->real_volume = root_source->real_volume;
1355 pa_cvolume_remap(&o->destination_source->real_volume, &root_source->channel_map, &o->destination_source->channel_map);
1357 pa_assert(pa_cvolume_is_norm(&o->destination_source->soft_volume));
1359 /* Notify others about the changed source volume. If you wonder whether
1360 * o->destination_source->set_volume() should be called somewhere, that's not
1361 * the case, because sources that use volume sharing shouldn't have any
1362 * internal volume that set_volume() would update. If you wonder
1363 * whether the thread_info variables should be synced, yes, they
1364 * should, and it's done by the PA_SOURCE_MESSAGE_FINISH_MOVE message
1366 if (!pa_cvolume_equal(&o->destination_source->reference_volume, &old_volume))
1367 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, o->destination_source->index);
1369 /* Recursively update origin source outputs. */
1370 PA_IDXSET_FOREACH(destination_source_output, o->destination_source->outputs, idx)
1371 update_volume_due_to_moving(destination_source_output, dest);
1374 old_volume = o->volume;
1376 if (pa_source_flat_volume_enabled(o->source)) {
1377 /* Ok, so this is a regular stream, and flat volume is enabled. The
1378 * volume will have to be updated as follows:
1380 * o->volume := o->reference_ratio * o->source->reference_volume
1381 * o->reference_ratio stays unchanged
1382 * o->real_ratio := o->volume / o->source->real_volume
1383 * (handled later by pa_source_set_volume)
1384 * o->soft_volume := o->real_ratio * o->volume_factor
1385 * (handled later by pa_source_set_volume) */
1387 o->volume = o->source->reference_volume;
1388 pa_cvolume_remap(&o->volume, &o->source->channel_map, &o->channel_map);
1389 pa_sw_cvolume_multiply(&o->volume, &o->volume, &o->reference_ratio);
1392 /* Ok, so this is a regular stream, and flat volume is disabled.
1393 * The volume will have to be updated as follows:
1395 * o->volume := o->reference_ratio
1396 * o->reference_ratio stays unchanged
1397 * o->real_ratio := o->reference_ratio
1398 * o->soft_volume := o->real_ratio * o->volume_factor */
1400 o->volume = o->reference_ratio;
1401 o->real_ratio = o->reference_ratio;
1402 pa_sw_cvolume_multiply(&o->soft_volume, &o->real_ratio, &o->volume_factor);
1405 /* Notify others about the changed source output volume. */
1406 if (!pa_cvolume_equal(&o->volume, &old_volume)) {
1407 /* XXX: In case o->source has flat volume enabled, then real_ratio
1408 * and soft_volume are not updated yet. Let's hope that the
1409 * callback implementation doesn't care about those variables... */
1410 if (o->volume_changed)
1411 o->volume_changed(o);
1413 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1417 /* If o->source == dest, then recursion has finished, and we can finally call
1418 * pa_source_set_volume(), which will do the rest of the updates. */
1419 if ((o->source == dest) && pa_source_flat_volume_enabled(o->source))
1420 pa_source_set_volume(o->source, NULL, false, o->save_volume);
1423 /* Called from main context */
1424 int pa_source_output_finish_move(pa_source_output *o, pa_source *dest, bool save) {
1425 pa_source_output_assert_ref(o);
1426 pa_assert_ctl_context();
1427 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1428 pa_assert(!o->source);
1429 pa_source_assert_ref(dest);
1431 if (!pa_source_output_may_move_to(o, dest))
1432 return -PA_ERR_NOTSUPPORTED;
1434 if (pa_source_output_is_passthrough(o) && !pa_source_check_format(dest, o->format)) {
1435 pa_proplist *p = pa_proplist_new();
1436 pa_log_debug("New source doesn't support stream format, sending format-changed and killing");
1437 /* Tell the client what device we want to be on if it is going to
1439 pa_proplist_sets(p, "device", dest->name);
1440 pa_source_output_send_event(o, PA_STREAM_EVENT_FORMAT_LOST, p);
1441 pa_proplist_free(p);
1442 return -PA_ERR_NOTSUPPORTED;
1445 if (!(o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) &&
1446 !pa_sample_spec_equal(&o->sample_spec, &dest->sample_spec)) {
1447 /* try to change dest sink rate if possible without glitches.
1448 module-suspend-on-idle resumes destination source with
1449 SOURCE_OUTPUT_MOVE_FINISH hook */
1451 pa_log_info("Trying to change sample rate");
1452 if (pa_source_update_rate(dest, o->sample_spec.rate, pa_source_output_is_passthrough(o)) == true)
1453 pa_log_info("Rate changed to %u Hz", dest->sample_spec.rate);
1460 o->save_source = save;
1461 pa_idxset_put(o->source->outputs, pa_source_output_ref(o), NULL);
1463 pa_cvolume_remap(&o->volume_factor_source, &o->channel_map, &o->source->channel_map);
1465 if (pa_source_output_get_state(o) == PA_SOURCE_OUTPUT_CORKED)
1466 o->source->n_corked++;
1468 pa_source_output_update_rate(o);
1470 pa_source_update_status(dest);
1472 update_volume_due_to_moving(o, dest);
1474 if (pa_source_output_is_passthrough(o))
1475 pa_source_enter_passthrough(o->source);
1477 pa_assert_se(pa_asyncmsgq_send(o->source->asyncmsgq, PA_MSGOBJECT(o->source), PA_SOURCE_MESSAGE_ADD_OUTPUT, o, 0, NULL) == 0);
1479 pa_log_debug("Successfully moved source output %i to %s.", o->index, dest->name);
1481 /* Notify everyone */
1482 pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FINISH], o);
1483 pa_subscription_post(o->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, o->index);
1488 /* Called from main context */
1489 void pa_source_output_fail_move(pa_source_output *o) {
1491 pa_source_output_assert_ref(o);
1492 pa_assert_ctl_context();
1493 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1494 pa_assert(!o->source);
1496 /* Check if someone wants this source output? */
1497 if (pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FAIL], o) == PA_HOOK_STOP)
1503 pa_source_output_kill(o);
1506 /* Called from main context */
1507 int pa_source_output_move_to(pa_source_output *o, pa_source *dest, bool save) {
1510 pa_source_output_assert_ref(o);
1511 pa_assert_ctl_context();
1512 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o->state));
1513 pa_assert(o->source);
1514 pa_source_assert_ref(dest);
1516 if (dest == o->source)
1519 if (!pa_source_output_may_move_to(o, dest))
1520 return -PA_ERR_NOTSUPPORTED;
1522 pa_source_output_ref(o);
1524 if ((r = pa_source_output_start_move(o)) < 0) {
1525 pa_source_output_unref(o);
1529 if ((r = pa_source_output_finish_move(o, dest, save)) < 0) {
1530 pa_source_output_fail_move(o);
1531 pa_source_output_unref(o);
1535 pa_source_output_unref(o);
1540 /* Called from IO thread context */
1541 void pa_source_output_set_state_within_thread(pa_source_output *o, pa_source_output_state_t state) {
1542 pa_source_output_assert_ref(o);
1543 pa_source_output_assert_io_context(o);
1545 if (state == o->thread_info.state)
1548 if (o->state_change)
1549 o->state_change(o, state);
1551 o->thread_info.state = state;
1554 /* Called from IO thread context, except when it is not */
1555 int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int64_t offset, pa_memchunk* chunk) {
1556 pa_source_output *o = PA_SOURCE_OUTPUT(mo);
1557 pa_source_output_assert_ref(o);
1561 case PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY: {
1562 pa_usec_t *r = userdata;
1564 r[0] += pa_bytes_to_usec(pa_memblockq_get_length(o->thread_info.delay_memblockq), &o->source->sample_spec);
1565 r[1] += pa_source_get_latency_within_thread(o->source);
1570 case PA_SOURCE_OUTPUT_MESSAGE_SET_RATE:
1572 o->thread_info.sample_spec.rate = PA_PTR_TO_UINT(userdata);
1573 pa_resampler_set_output_rate(o->thread_info.resampler, PA_PTR_TO_UINT(userdata));
1576 case PA_SOURCE_OUTPUT_MESSAGE_SET_STATE:
1578 pa_source_output_set_state_within_thread(o, PA_PTR_TO_UINT(userdata));
1582 case PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY: {
1583 pa_usec_t *usec = userdata;
1585 *usec = pa_source_output_set_requested_latency_within_thread(o, *usec);
1590 case PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY: {
1591 pa_usec_t *r = userdata;
1593 *r = o->thread_info.requested_source_latency;
1597 case PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_VOLUME:
1598 if (!pa_cvolume_equal(&o->thread_info.soft_volume, &o->soft_volume)) {
1599 o->thread_info.soft_volume = o->soft_volume;
1603 case PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_MUTE:
1604 if (o->thread_info.muted != o->muted) {
1605 o->thread_info.muted = o->muted;
1610 return -PA_ERR_NOTIMPLEMENTED;
1613 /* Called from main context */
1614 void pa_source_output_send_event(pa_source_output *o, const char *event, pa_proplist *data) {
1615 pa_proplist *pl = NULL;
1616 pa_source_output_send_event_hook_data hook_data;
1618 pa_source_output_assert_ref(o);
1619 pa_assert_ctl_context();
1626 data = pl = pa_proplist_new();
1628 hook_data.source_output = o;
1629 hook_data.data = data;
1630 hook_data.event = event;
1632 if (pa_hook_fire(&o->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_SEND_EVENT], &hook_data) < 0)
1635 o->send_event(o, event, data);
1639 pa_proplist_free(pl);
1642 /* Called from main context */
1643 /* Updates the source output's resampler with whatever the current source
1644 * requires -- useful when the underlying source's rate might have changed */
1645 int pa_source_output_update_rate(pa_source_output *o) {
1646 pa_resampler *new_resampler;
1647 char *memblockq_name;
1649 pa_source_output_assert_ref(o);
1650 pa_assert_ctl_context();
1652 if (o->thread_info.resampler &&
1653 pa_sample_spec_equal(pa_resampler_input_sample_spec(o->thread_info.resampler), &o->source->sample_spec) &&
1654 pa_channel_map_equal(pa_resampler_input_channel_map(o->thread_info.resampler), &o->source->channel_map))
1656 new_resampler = o->thread_info.resampler;
1658 else if (!pa_source_output_is_passthrough(o) &&
1659 ((o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ||
1660 !pa_sample_spec_equal(&o->sample_spec, &o->source->sample_spec) ||
1661 !pa_channel_map_equal(&o->channel_map, &o->source->channel_map))) {
1663 new_resampler = pa_resampler_new(o->core->mempool,
1664 &o->source->sample_spec, &o->source->channel_map,
1665 &o->sample_spec, &o->channel_map,
1666 o->requested_resample_method,
1667 ((o->flags & PA_SOURCE_OUTPUT_VARIABLE_RATE) ? PA_RESAMPLER_VARIABLE_RATE : 0) |
1668 ((o->flags & PA_SOURCE_OUTPUT_NO_REMAP) ? PA_RESAMPLER_NO_REMAP : 0) |
1669 (o->core->disable_remixing || (o->flags & PA_SOURCE_OUTPUT_NO_REMIX) ? PA_RESAMPLER_NO_REMIX : 0));
1671 if (!new_resampler) {
1672 pa_log_warn("Unsupported resampling operation.");
1673 return -PA_ERR_NOTSUPPORTED;
1676 new_resampler = NULL;
1678 if (new_resampler == o->thread_info.resampler)
1681 if (o->thread_info.resampler)
1682 pa_resampler_free(o->thread_info.resampler);
1684 o->thread_info.resampler = new_resampler;
1686 pa_memblockq_free(o->thread_info.delay_memblockq);
1688 memblockq_name = pa_sprintf_malloc("source output delay_memblockq [%u]", o->index);
1689 o->thread_info.delay_memblockq = pa_memblockq_new(
1692 MEMBLOCKQ_MAXLENGTH,
1694 &o->source->sample_spec,
1698 &o->source->silence);
1699 pa_xfree(memblockq_name);
1701 o->actual_resample_method = new_resampler ? pa_resampler_get_method(new_resampler) : PA_RESAMPLER_INVALID;
1703 pa_log_debug("Updated resampler for source output %d", o->index);