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/sample-util.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 pa_bool_t
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
, pa_bool_t mute
) {
122 data
->muted_is_set
= TRUE
;
123 data
->muted
= !!mute
;
126 pa_bool_t
pa_source_output_new_data_set_source(pa_source_output_new_data
*data
, pa_source
*s
, pa_bool_t save
) {
127 pa_bool_t ret
= TRUE
;
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_free2_cb_t
) pa_format_info_free2
, NULL
);
147 data
->nego_formats
= formats
;
149 /* Source doesn't support any of the formats requested by the client */
151 pa_idxset_free(formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);
159 pa_bool_t
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_free2_cb_t
) pa_format_info_free2
, NULL
);
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_free2_cb_t
) pa_format_info_free2
, NULL
);
182 if (data
->nego_formats
)
183 pa_idxset_free(data
->nego_formats
, (pa_free2_cb_t
) pa_format_info_free2
, NULL
);
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
);
258 pa_source
*source
= pa_namereg_get(core
, NULL
, PA_NAMEREG_SOURCE
);
259 pa_return_val_if_fail(source
, -PA_ERR_NOENTITY
);
260 pa_source_output_new_data_set_source(data
, source
, FALSE
);
263 /* Routing's done, we have a source. Now let's fix the format and set up the
266 /* If something didn't pick a format for us, pick the top-most format since
267 * we assume this is sorted in priority order */
268 if (!data
->format
&& data
->nego_formats
&& !pa_idxset_isempty(data
->nego_formats
))
269 data
->format
= pa_format_info_copy(pa_idxset_first(data
->nego_formats
, NULL
));
271 pa_return_val_if_fail(data
->format
, -PA_ERR_NOTSUPPORTED
);
273 /* Now populate the sample spec and format according to the final
274 * format that we've negotiated */
275 if (PA_LIKELY(data
->format
->encoding
== PA_ENCODING_PCM
)) {
276 pa_return_val_if_fail(pa_format_info_to_sample_spec(data
->format
, &ss
, &map
), -PA_ERR_INVALID
);
277 pa_source_output_new_data_set_sample_spec(data
, &ss
);
278 if (pa_channel_map_valid(&map
))
279 pa_source_output_new_data_set_channel_map(data
, &map
);
281 pa_return_val_if_fail(pa_format_info_to_sample_spec_fake(data
->format
, &ss
), -PA_ERR_INVALID
);
282 pa_source_output_new_data_set_sample_spec(data
, &ss
);
285 pa_return_val_if_fail(PA_SOURCE_IS_LINKED(pa_source_get_state(data
->source
)), -PA_ERR_BADSTATE
);
286 pa_return_val_if_fail(!data
->direct_on_input
|| data
->direct_on_input
->sink
== data
->source
->monitor_of
, -PA_ERR_INVALID
);
288 if (!data
->sample_spec_is_set
)
289 data
->sample_spec
= data
->source
->sample_spec
;
291 pa_return_val_if_fail(pa_sample_spec_valid(&data
->sample_spec
), -PA_ERR_INVALID
);
293 if (!data
->channel_map_is_set
) {
294 if (pa_channel_map_compatible(&data
->source
->channel_map
, &data
->sample_spec
))
295 data
->channel_map
= data
->source
->channel_map
;
297 pa_channel_map_init_extend(&data
->channel_map
, data
->sample_spec
.channels
, PA_CHANNEL_MAP_DEFAULT
);
300 pa_return_val_if_fail(pa_channel_map_compatible(&data
->channel_map
, &data
->sample_spec
), -PA_ERR_INVALID
);
302 /* Don't restore (or save) stream volume for passthrough streams and
303 * prevent attenuation/gain */
304 if (pa_source_output_new_data_is_passthrough(data
)) {
305 data
->volume_is_set
= TRUE
;
306 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
307 data
->volume_is_absolute
= TRUE
;
308 data
->save_volume
= FALSE
;
311 if (!data
->volume_is_set
) {
312 pa_cvolume_reset(&data
->volume
, data
->sample_spec
.channels
);
313 data
->volume_is_absolute
= FALSE
;
314 data
->save_volume
= FALSE
;
317 pa_return_val_if_fail(pa_cvolume_compatible(&data
->volume
, &data
->sample_spec
), -PA_ERR_INVALID
);
319 if (!data
->volume_factor_is_set
)
320 pa_cvolume_reset(&data
->volume_factor
, data
->sample_spec
.channels
);
322 pa_return_val_if_fail(pa_cvolume_compatible(&data
->volume_factor
, &data
->sample_spec
), -PA_ERR_INVALID
);
324 if (!data
->volume_factor_source_is_set
)
325 pa_cvolume_reset(&data
->volume_factor_source
, data
->source
->sample_spec
.channels
);
327 pa_return_val_if_fail(pa_cvolume_compatible(&data
->volume_factor_source
, &data
->source
->sample_spec
), -PA_ERR_INVALID
);
329 if (!data
->muted_is_set
)
332 if (data
->flags
& PA_SOURCE_OUTPUT_FIX_FORMAT
)
333 data
->sample_spec
.format
= data
->source
->sample_spec
.format
;
335 if (data
->flags
& PA_SOURCE_OUTPUT_FIX_RATE
)
336 data
->sample_spec
.rate
= data
->source
->sample_spec
.rate
;
338 original_cm
= data
->channel_map
;
340 if (data
->flags
& PA_SOURCE_OUTPUT_FIX_CHANNELS
) {
341 data
->sample_spec
.channels
= data
->source
->sample_spec
.channels
;
342 data
->channel_map
= data
->source
->channel_map
;
345 pa_assert(pa_sample_spec_valid(&data
->sample_spec
));
346 pa_assert(pa_channel_map_valid(&data
->channel_map
));
348 /* Due to the fixing of the sample spec the volume might not match anymore */
349 pa_cvolume_remap(&data
->volume
, &original_cm
, &data
->channel_map
);
351 if (!(data
->flags
& PA_SOURCE_OUTPUT_VARIABLE_RATE
) &&
352 !pa_sample_spec_equal(&data
->sample_spec
, &data
->source
->sample_spec
)){
353 /* try to change source rate. This is done before the FIXATE hook since
354 module-suspend-on-idle can resume a source */
356 pa_log_info("Trying to change sample rate");
357 if (pa_source_update_rate(data
->source
, data
->sample_spec
.rate
, pa_source_output_new_data_is_passthrough(data
)) == TRUE
)
358 pa_log_info("Rate changed to %u kHz",
359 data
->source
->sample_spec
.rate
);
361 pa_log_info("Resampling enabled to %u kHz", data
->source
->sample_spec
.rate
);
364 if (data
->resample_method
== PA_RESAMPLER_INVALID
)
365 data
->resample_method
= core
->resample_method
;
367 pa_return_val_if_fail(data
->resample_method
< PA_RESAMPLER_MAX
, -PA_ERR_INVALID
);
369 if ((r
= pa_hook_fire(&core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE
], data
)) < 0)
372 if ((data
->flags
& PA_SOURCE_OUTPUT_NO_CREATE_ON_SUSPEND
) &&
373 pa_source_get_state(data
->source
) == PA_SOURCE_SUSPENDED
) {
374 pa_log("Failed to create source output: source is suspended.");
375 return -PA_ERR_BADSTATE
;
378 if (pa_idxset_size(data
->source
->outputs
) >= PA_MAX_OUTPUTS_PER_SOURCE
) {
379 pa_log("Failed to create source output: too many outputs per source.");
380 return -PA_ERR_TOOLARGE
;
383 if ((data
->flags
& PA_SOURCE_OUTPUT_VARIABLE_RATE
) ||
384 !pa_sample_spec_equal(&data
->sample_spec
, &data
->source
->sample_spec
) ||
385 !pa_channel_map_equal(&data
->channel_map
, &data
->source
->channel_map
)) {
387 if (!pa_source_output_new_data_is_passthrough(data
)) /* no resampler for passthrough content */
388 if (!(resampler
= pa_resampler_new(
390 &data
->source
->sample_spec
, &data
->source
->channel_map
,
391 &data
->sample_spec
, &data
->channel_map
,
392 data
->resample_method
,
393 ((data
->flags
& PA_SOURCE_OUTPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
394 ((data
->flags
& PA_SOURCE_OUTPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
395 (core
->disable_remixing
|| (data
->flags
& PA_SOURCE_OUTPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0) |
396 (core
->disable_lfe_remixing
? PA_RESAMPLER_NO_LFE
: 0)))) {
397 pa_log_warn("Unsupported resampling operation.");
398 return -PA_ERR_NOTSUPPORTED
;
402 o
= pa_msgobject_new(pa_source_output
);
403 o
->parent
.parent
.free
= source_output_free
;
404 o
->parent
.process_msg
= pa_source_output_process_msg
;
407 o
->state
= PA_SOURCE_OUTPUT_INIT
;
408 o
->flags
= data
->flags
;
409 o
->proplist
= pa_proplist_copy(data
->proplist
);
410 o
->driver
= pa_xstrdup(pa_path_get_filename(data
->driver
));
411 o
->module
= data
->module
;
412 o
->source
= data
->source
;
413 o
->destination_source
= data
->destination_source
;
414 o
->client
= data
->client
;
416 o
->requested_resample_method
= data
->resample_method
;
417 o
->actual_resample_method
= resampler
? pa_resampler_get_method(resampler
) : PA_RESAMPLER_INVALID
;
418 o
->sample_spec
= data
->sample_spec
;
419 o
->channel_map
= data
->channel_map
;
420 o
->format
= pa_format_info_copy(data
->format
);
422 if (!data
->volume_is_absolute
&& pa_source_flat_volume_enabled(o
->source
)) {
425 /* When the 'absolute' bool is not set then we'll treat the volume
426 * as relative to the source volume even in flat volume mode */
427 remapped
= data
->source
->reference_volume
;
428 pa_cvolume_remap(&remapped
, &data
->source
->channel_map
, &data
->channel_map
);
429 pa_sw_cvolume_multiply(&o
->volume
, &data
->volume
, &remapped
);
431 o
->volume
= data
->volume
;
433 o
->volume_factor
= data
->volume_factor
;
434 o
->volume_factor_source
= data
->volume_factor_source
;
435 o
->real_ratio
= o
->reference_ratio
= data
->volume
;
436 pa_cvolume_reset(&o
->soft_volume
, o
->sample_spec
.channels
);
437 pa_cvolume_reset(&o
->real_ratio
, o
->sample_spec
.channels
);
438 o
->volume_writable
= data
->volume_writable
;
439 o
->save_volume
= data
->save_volume
;
440 o
->save_source
= data
->save_source
;
441 o
->save_muted
= data
->save_muted
;
443 o
->muted
= data
->muted
;
445 o
->direct_on_input
= data
->direct_on_input
;
450 o
->thread_info
.state
= o
->state
;
451 o
->thread_info
.attached
= FALSE
;
452 o
->thread_info
.sample_spec
= o
->sample_spec
;
453 o
->thread_info
.resampler
= resampler
;
454 o
->thread_info
.soft_volume
= o
->soft_volume
;
455 o
->thread_info
.muted
= o
->muted
;
456 o
->thread_info
.requested_source_latency
= (pa_usec_t
) -1;
457 o
->thread_info
.direct_on_input
= o
->direct_on_input
;
459 o
->thread_info
.delay_memblockq
= pa_memblockq_new(
460 "source output delay_memblockq",
464 &o
->source
->sample_spec
,
468 &o
->source
->silence
);
470 pa_assert_se(pa_idxset_put(core
->source_outputs
, o
, &o
->index
) == 0);
471 pa_assert_se(pa_idxset_put(o
->source
->outputs
, pa_source_output_ref(o
), NULL
) == 0);
474 pa_assert_se(pa_idxset_put(o
->client
->source_outputs
, o
, NULL
) >= 0);
476 if (o
->direct_on_input
)
477 pa_assert_se(pa_idxset_put(o
->direct_on_input
->direct_outputs
, o
, NULL
) == 0);
479 pt
= pa_proplist_to_string_sep(o
->proplist
, "\n ");
480 pa_log_info("Created output %u \"%s\" on %s with sample spec %s and channel map %s\n %s",
482 pa_strnull(pa_proplist_gets(o
->proplist
, PA_PROP_MEDIA_NAME
)),
484 pa_sample_spec_snprint(st
, sizeof(st
), &o
->sample_spec
),
485 pa_channel_map_snprint(cm
, sizeof(cm
), &o
->channel_map
),
489 /* Don't forget to call pa_source_output_put! */
495 /* Called from main context */
496 static void update_n_corked(pa_source_output
*o
, pa_source_output_state_t state
) {
498 pa_assert_ctl_context();
503 if (o
->state
== PA_SOURCE_OUTPUT_CORKED
&& state
!= PA_SOURCE_OUTPUT_CORKED
)
504 pa_assert_se(o
->source
->n_corked
-- >= 1);
505 else if (o
->state
!= PA_SOURCE_OUTPUT_CORKED
&& state
== PA_SOURCE_OUTPUT_CORKED
)
506 o
->source
->n_corked
++;
509 /* Called from main context */
510 static void source_output_set_state(pa_source_output
*o
, pa_source_output_state_t state
) {
513 pa_assert_ctl_context();
515 if (o
->state
== state
)
518 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);
520 update_n_corked(o
, state
);
523 if (state
!= PA_SOURCE_OUTPUT_UNLINKED
) {
524 pa_hook_fire(&o
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED
], o
);
526 if (PA_SOURCE_OUTPUT_IS_LINKED(state
))
527 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, o
->index
);
530 pa_source_update_status(o
->source
);
533 /* Called from main context */
534 void pa_source_output_unlink(pa_source_output
*o
) {
537 pa_assert_ctl_context();
539 /* See pa_sink_unlink() for a couple of comments how this function
542 pa_source_output_ref(o
);
544 linked
= PA_SOURCE_OUTPUT_IS_LINKED(o
->state
);
547 pa_hook_fire(&o
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK
], o
);
549 if (o
->direct_on_input
)
550 pa_idxset_remove_by_data(o
->direct_on_input
->direct_outputs
, o
, NULL
);
552 pa_idxset_remove_by_data(o
->core
->source_outputs
, o
, NULL
);
555 if (pa_idxset_remove_by_data(o
->source
->outputs
, o
, NULL
))
556 pa_source_output_unref(o
);
559 pa_idxset_remove_by_data(o
->client
->source_outputs
, o
, NULL
);
561 update_n_corked(o
, PA_SOURCE_OUTPUT_UNLINKED
);
562 o
->state
= PA_SOURCE_OUTPUT_UNLINKED
;
564 if (linked
&& o
->source
) {
565 if (pa_source_output_is_passthrough(o
))
566 pa_source_leave_passthrough(o
->source
);
568 /* We might need to update the source's volume if we are in flat volume mode. */
569 if (pa_source_flat_volume_enabled(o
->source
))
570 pa_source_set_volume(o
->source
, NULL
, FALSE
, FALSE
);
572 if (o
->source
->asyncmsgq
)
573 pa_assert_se(pa_asyncmsgq_send(o
->source
->asyncmsgq
, PA_MSGOBJECT(o
->source
), PA_SOURCE_MESSAGE_REMOVE_OUTPUT
, o
, 0, NULL
) == 0);
579 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_REMOVE
, o
->index
);
580 pa_hook_fire(&o
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST
], o
);
584 pa_source_update_status(o
->source
);
588 pa_core_maybe_vacuum(o
->core
);
590 pa_source_output_unref(o
);
593 /* Called from main context */
594 static void source_output_free(pa_object
* mo
) {
595 pa_source_output
*o
= PA_SOURCE_OUTPUT(mo
);
598 pa_assert_ctl_context();
599 pa_assert(pa_source_output_refcnt(o
) == 0);
601 if (PA_SOURCE_OUTPUT_IS_LINKED(o
->state
))
602 pa_source_output_unlink(o
);
604 pa_log_info("Freeing output %u \"%s\"", o
->index
, pa_strnull(pa_proplist_gets(o
->proplist
, PA_PROP_MEDIA_NAME
)));
606 if (o
->thread_info
.delay_memblockq
)
607 pa_memblockq_free(o
->thread_info
.delay_memblockq
);
609 if (o
->thread_info
.resampler
)
610 pa_resampler_free(o
->thread_info
.resampler
);
613 pa_format_info_free(o
->format
);
616 pa_proplist_free(o
->proplist
);
622 /* Called from main context */
623 void pa_source_output_put(pa_source_output
*o
) {
624 pa_source_output_state_t state
;
626 pa_source_output_assert_ref(o
);
627 pa_assert_ctl_context();
629 pa_assert(o
->state
== PA_SOURCE_OUTPUT_INIT
);
631 /* The following fields must be initialized properly */
635 state
= o
->flags
& PA_SOURCE_OUTPUT_START_CORKED
? PA_SOURCE_OUTPUT_CORKED
: PA_SOURCE_OUTPUT_RUNNING
;
637 update_n_corked(o
, state
);
640 /* We might need to update the source's volume if we are in flat volume mode. */
641 if (pa_source_flat_volume_enabled(o
->source
))
642 pa_source_set_volume(o
->source
, NULL
, FALSE
, o
->save_volume
);
644 if (o
->destination_source
&& (o
->destination_source
->flags
& PA_SOURCE_SHARE_VOLUME_WITH_MASTER
)) {
645 pa_assert(pa_cvolume_is_norm(&o
->volume
));
646 pa_assert(pa_cvolume_is_norm(&o
->reference_ratio
));
649 set_real_ratio(o
, &o
->volume
);
652 if (pa_source_output_is_passthrough(o
))
653 pa_source_enter_passthrough(o
->source
);
655 o
->thread_info
.soft_volume
= o
->soft_volume
;
656 o
->thread_info
.muted
= o
->muted
;
658 pa_assert_se(pa_asyncmsgq_send(o
->source
->asyncmsgq
, PA_MSGOBJECT(o
->source
), PA_SOURCE_MESSAGE_ADD_OUTPUT
, o
, 0, NULL
) == 0);
660 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_NEW
, o
->index
);
661 pa_hook_fire(&o
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_PUT
], o
);
663 pa_source_update_status(o
->source
);
666 /* Called from main context */
667 void pa_source_output_kill(pa_source_output
*o
) {
668 pa_source_output_assert_ref(o
);
669 pa_assert_ctl_context();
670 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
675 /* Called from main context */
676 pa_usec_t
pa_source_output_get_latency(pa_source_output
*o
, pa_usec_t
*source_latency
) {
677 pa_usec_t r
[2] = { 0, 0 };
679 pa_source_output_assert_ref(o
);
680 pa_assert_ctl_context();
681 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
683 pa_assert_se(pa_asyncmsgq_send(o
->source
->asyncmsgq
, PA_MSGOBJECT(o
), PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY
, r
, 0, NULL
) == 0);
686 r
[0] += o
->get_latency(o
);
689 *source_latency
= r
[1];
694 /* Called from thread context */
695 void pa_source_output_push(pa_source_output
*o
, const pa_memchunk
*chunk
) {
696 pa_bool_t need_volume_factor_source
;
697 pa_bool_t volume_is_norm
;
699 size_t limit
, mbs
= 0;
701 pa_source_output_assert_ref(o
);
702 pa_source_output_assert_io_context(o
);
703 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->thread_info
.state
));
705 pa_assert(pa_frame_aligned(chunk
->length
, &o
->source
->sample_spec
));
707 if (!o
->push
|| o
->thread_info
.state
== PA_SOURCE_OUTPUT_CORKED
)
710 pa_assert(o
->thread_info
.state
== PA_SOURCE_OUTPUT_RUNNING
);
712 if (pa_memblockq_push(o
->thread_info
.delay_memblockq
, chunk
) < 0) {
713 pa_log_debug("Delay queue overflow!");
714 pa_memblockq_seek(o
->thread_info
.delay_memblockq
, (int64_t) chunk
->length
, PA_SEEK_RELATIVE
, TRUE
);
717 limit
= o
->process_rewind
? 0 : o
->source
->thread_info
.max_rewind
;
719 volume_is_norm
= pa_cvolume_is_norm(&o
->thread_info
.soft_volume
) && !o
->thread_info
.muted
;
720 need_volume_factor_source
= !pa_cvolume_is_norm(&o
->volume_factor_source
);
722 if (limit
> 0 && o
->source
->monitor_of
) {
726 /* Hmm, check the latency for knowing how much of the buffered
727 * data is actually still unplayed and might hence still
728 * change. This is suboptimal. Ideally we'd have a call like
729 * pa_sink_get_changeable_size() or so that tells us how much
730 * of the queued data is actually still changeable. Hence
733 latency
= pa_sink_get_latency_within_thread(o
->source
->monitor_of
);
735 n
= pa_usec_to_bytes(latency
, &o
->source
->sample_spec
);
741 /* Implement the delay queue */
742 while ((length
= pa_memblockq_get_length(o
->thread_info
.delay_memblockq
)) > limit
) {
744 pa_bool_t nvfs
= need_volume_factor_source
;
748 pa_assert_se(pa_memblockq_peek(o
->thread_info
.delay_memblockq
, &qchunk
) >= 0);
750 if (qchunk
.length
> length
)
751 qchunk
.length
= length
;
753 pa_assert(qchunk
.length
> 0);
755 /* It might be necessary to adjust the volume here */
756 if (!volume_is_norm
) {
757 pa_memchunk_make_writable(&qchunk
, 0);
759 if (o
->thread_info
.muted
) {
760 pa_silence_memchunk(&qchunk
, &o
->source
->sample_spec
);
763 } else if (!o
->thread_info
.resampler
&& nvfs
) {
766 /* If we don't need a resampler we can merge the
767 * post and the pre volume adjustment into one */
769 pa_sw_cvolume_multiply(&v
, &o
->thread_info
.soft_volume
, &o
->volume_factor_source
);
770 pa_volume_memchunk(&qchunk
, &o
->source
->sample_spec
, &v
);
774 pa_volume_memchunk(&qchunk
, &o
->source
->sample_spec
, &o
->thread_info
.soft_volume
);
777 if (!o
->thread_info
.resampler
) {
779 pa_memchunk_make_writable(&qchunk
, 0);
780 pa_volume_memchunk(&qchunk
, &o
->thread_info
.sample_spec
, &o
->volume_factor_source
);
788 mbs
= pa_resampler_max_block_size(o
->thread_info
.resampler
);
790 if (qchunk
.length
> mbs
)
793 pa_resampler_run(o
->thread_info
.resampler
, &qchunk
, &rchunk
);
795 if (rchunk
.length
> 0) {
797 pa_memchunk_make_writable(&rchunk
, 0);
798 pa_volume_memchunk(&rchunk
, &o
->thread_info
.sample_spec
, &o
->volume_factor_source
);
805 pa_memblock_unref(rchunk
.memblock
);
808 pa_memblock_unref(qchunk
.memblock
);
809 pa_memblockq_drop(o
->thread_info
.delay_memblockq
, qchunk
.length
);
813 /* Called from thread context */
814 void pa_source_output_process_rewind(pa_source_output
*o
, size_t nbytes
/* in source sample spec */) {
816 pa_source_output_assert_ref(o
);
817 pa_source_output_assert_io_context(o
);
818 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->thread_info
.state
));
819 pa_assert(pa_frame_aligned(nbytes
, &o
->source
->sample_spec
));
824 if (o
->process_rewind
) {
825 pa_assert(pa_memblockq_get_length(o
->thread_info
.delay_memblockq
) == 0);
827 if (o
->thread_info
.resampler
)
828 nbytes
= pa_resampler_result(o
->thread_info
.resampler
, nbytes
);
830 pa_log_debug("Have to rewind %lu bytes on implementor.", (unsigned long) nbytes
);
833 o
->process_rewind(o
, nbytes
);
835 if (o
->thread_info
.resampler
)
836 pa_resampler_reset(o
->thread_info
.resampler
);
839 pa_memblockq_rewind(o
->thread_info
.delay_memblockq
, nbytes
);
842 /* Called from thread context */
843 size_t pa_source_output_get_max_rewind(pa_source_output
*o
) {
844 pa_source_output_assert_ref(o
);
845 pa_source_output_assert_io_context(o
);
847 return o
->thread_info
.resampler
? pa_resampler_request(o
->thread_info
.resampler
, o
->source
->thread_info
.max_rewind
) : o
->source
->thread_info
.max_rewind
;
850 /* Called from thread context */
851 void pa_source_output_update_max_rewind(pa_source_output
*o
, size_t nbytes
/* in the source's sample spec */) {
852 pa_source_output_assert_ref(o
);
853 pa_source_output_assert_io_context(o
);
854 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->thread_info
.state
));
855 pa_assert(pa_frame_aligned(nbytes
, &o
->source
->sample_spec
));
857 if (o
->update_max_rewind
)
858 o
->update_max_rewind(o
, o
->thread_info
.resampler
? pa_resampler_result(o
->thread_info
.resampler
, nbytes
) : nbytes
);
861 /* Called from thread context */
862 pa_usec_t
pa_source_output_set_requested_latency_within_thread(pa_source_output
*o
, pa_usec_t usec
) {
863 pa_source_output_assert_ref(o
);
864 pa_source_output_assert_io_context(o
);
866 if (!(o
->source
->flags
& PA_SOURCE_DYNAMIC_LATENCY
))
867 usec
= o
->source
->thread_info
.fixed_latency
;
869 if (usec
!= (pa_usec_t
) -1)
870 usec
= PA_CLAMP(usec
, o
->source
->thread_info
.min_latency
, o
->source
->thread_info
.max_latency
);
872 o
->thread_info
.requested_source_latency
= usec
;
873 pa_source_invalidate_requested_latency(o
->source
, TRUE
);
878 /* Called from main context */
879 pa_usec_t
pa_source_output_set_requested_latency(pa_source_output
*o
, pa_usec_t usec
) {
880 pa_source_output_assert_ref(o
);
881 pa_assert_ctl_context();
883 if (PA_SOURCE_OUTPUT_IS_LINKED(o
->state
) && o
->source
) {
884 pa_assert_se(pa_asyncmsgq_send(o
->source
->asyncmsgq
, PA_MSGOBJECT(o
), PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
888 /* If this source output is not realized yet or is being moved, we
889 * have to touch the thread info data directly */
892 if (!(o
->source
->flags
& PA_SOURCE_DYNAMIC_LATENCY
))
893 usec
= pa_source_get_fixed_latency(o
->source
);
895 if (usec
!= (pa_usec_t
) -1) {
896 pa_usec_t min_latency
, max_latency
;
897 pa_source_get_latency_range(o
->source
, &min_latency
, &max_latency
);
898 usec
= PA_CLAMP(usec
, min_latency
, max_latency
);
902 o
->thread_info
.requested_source_latency
= usec
;
907 /* Called from main context */
908 pa_usec_t
pa_source_output_get_requested_latency(pa_source_output
*o
) {
909 pa_source_output_assert_ref(o
);
910 pa_assert_ctl_context();
912 if (PA_SOURCE_OUTPUT_IS_LINKED(o
->state
) && o
->source
) {
914 pa_assert_se(pa_asyncmsgq_send(o
->source
->asyncmsgq
, PA_MSGOBJECT(o
), PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY
, &usec
, 0, NULL
) == 0);
918 /* If this source output is not realized yet or is being moved, we
919 * have to touch the thread info data directly */
921 return o
->thread_info
.requested_source_latency
;
924 /* Called from main context */
925 void pa_source_output_set_volume(pa_source_output
*o
, const pa_cvolume
*volume
, pa_bool_t save
, pa_bool_t absolute
) {
928 pa_source_output_assert_ref(o
);
929 pa_assert_ctl_context();
930 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
932 pa_assert(pa_cvolume_valid(volume
));
933 pa_assert(volume
->channels
== 1 || pa_cvolume_compatible(volume
, &o
->sample_spec
));
934 pa_assert(o
->volume_writable
);
936 if (!absolute
&& pa_source_flat_volume_enabled(o
->source
)) {
937 v
= o
->source
->reference_volume
;
938 pa_cvolume_remap(&v
, &o
->source
->channel_map
, &o
->channel_map
);
940 if (pa_cvolume_compatible(volume
, &o
->sample_spec
))
941 volume
= pa_sw_cvolume_multiply(&v
, &v
, volume
);
943 volume
= pa_sw_cvolume_multiply_scalar(&v
, &v
, pa_cvolume_max(volume
));
945 if (!pa_cvolume_compatible(volume
, &o
->sample_spec
)) {
947 volume
= pa_cvolume_scale(&v
, pa_cvolume_max(volume
));
951 if (pa_cvolume_equal(volume
, &o
->volume
)) {
952 o
->save_volume
= o
->save_volume
|| save
;
957 o
->save_volume
= save
;
959 if (pa_source_flat_volume_enabled(o
->source
)) {
960 /* We are in flat volume mode, so let's update all source input
961 * volumes and update the flat volume of the source */
963 pa_source_set_volume(o
->source
, NULL
, TRUE
, save
);
966 /* OK, we are in normal volume mode. The volume only affects
968 set_real_ratio(o
, volume
);
970 /* Copy the new soft_volume to the thread_info struct */
971 pa_assert_se(pa_asyncmsgq_send(o
->source
->asyncmsgq
, PA_MSGOBJECT(o
), PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_VOLUME
, NULL
, 0, NULL
) == 0);
974 /* The volume changed, let's tell people so */
975 if (o
->volume_changed
)
976 o
->volume_changed(o
);
978 /* The virtual volume changed, let's tell people so */
979 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, o
->index
);
982 /* Called from main context */
983 static void set_real_ratio(pa_source_output
*o
, const pa_cvolume
*v
) {
984 pa_source_output_assert_ref(o
);
985 pa_assert_ctl_context();
986 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
987 pa_assert(!v
|| pa_cvolume_compatible(v
, &o
->sample_spec
));
989 /* This basically calculates:
992 * o->soft_volume := o->real_ratio * o->volume_factor */
997 pa_cvolume_reset(&o
->real_ratio
, o
->sample_spec
.channels
);
999 pa_sw_cvolume_multiply(&o
->soft_volume
, &o
->real_ratio
, &o
->volume_factor
);
1000 /* We don't copy the data to the thread_info data. That's left for someone else to do */
1003 /* Called from main or I/O context */
1004 pa_bool_t
pa_source_output_is_passthrough(pa_source_output
*o
) {
1005 pa_source_output_assert_ref(o
);
1007 if (PA_UNLIKELY(!pa_format_info_is_pcm(o
->format
)))
1010 if (PA_UNLIKELY(o
->flags
& PA_SOURCE_OUTPUT_PASSTHROUGH
))
1016 /* Called from main context */
1017 pa_bool_t
pa_source_output_is_volume_readable(pa_source_output
*o
) {
1018 pa_source_output_assert_ref(o
);
1019 pa_assert_ctl_context();
1021 return !pa_source_output_is_passthrough(o
);
1024 /* Called from main context */
1025 pa_cvolume
*pa_source_output_get_volume(pa_source_output
*o
, pa_cvolume
*volume
, pa_bool_t absolute
) {
1026 pa_source_output_assert_ref(o
);
1027 pa_assert_ctl_context();
1028 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
1029 pa_assert(pa_source_output_is_volume_readable(o
));
1031 if (absolute
|| !pa_source_flat_volume_enabled(o
->source
))
1032 *volume
= o
->volume
;
1034 *volume
= o
->reference_ratio
;
1039 /* Called from main context */
1040 void pa_source_output_set_mute(pa_source_output
*o
, pa_bool_t mute
, pa_bool_t save
) {
1041 pa_source_output_assert_ref(o
);
1042 pa_assert_ctl_context();
1043 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
1045 if (!o
->muted
== !mute
) {
1046 o
->save_muted
= o
->save_muted
|| mute
;
1051 o
->save_muted
= save
;
1053 pa_assert_se(pa_asyncmsgq_send(o
->source
->asyncmsgq
, PA_MSGOBJECT(o
), PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_MUTE
, NULL
, 0, NULL
) == 0);
1055 /* The mute status changed, let's tell people so */
1056 if (o
->mute_changed
)
1059 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, o
->index
);
1062 /* Called from main context */
1063 pa_bool_t
pa_source_output_get_mute(pa_source_output
*o
) {
1064 pa_source_output_assert_ref(o
);
1065 pa_assert_ctl_context();
1066 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
1071 /* Called from main thread */
1072 void pa_source_output_update_proplist(pa_source_output
*o
, pa_update_mode_t mode
, pa_proplist
*p
) {
1073 pa_source_output_assert_ref(o
);
1074 pa_assert_ctl_context();
1077 pa_proplist_update(o
->proplist
, mode
, p
);
1079 if (PA_SOURCE_OUTPUT_IS_LINKED(o
->state
)) {
1080 pa_hook_fire(&o
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED
], o
);
1081 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, o
->index
);
1085 /* Called from main context */
1086 void pa_source_output_cork(pa_source_output
*o
, pa_bool_t b
) {
1087 pa_source_output_assert_ref(o
);
1088 pa_assert_ctl_context();
1089 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
1091 source_output_set_state(o
, b
? PA_SOURCE_OUTPUT_CORKED
: PA_SOURCE_OUTPUT_RUNNING
);
1094 /* Called from main context */
1095 int pa_source_output_set_rate(pa_source_output
*o
, uint32_t rate
) {
1096 pa_source_output_assert_ref(o
);
1097 pa_assert_ctl_context();
1098 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
1099 pa_return_val_if_fail(o
->thread_info
.resampler
, -PA_ERR_BADSTATE
);
1101 if (o
->sample_spec
.rate
== rate
)
1104 o
->sample_spec
.rate
= rate
;
1106 pa_asyncmsgq_post(o
->source
->asyncmsgq
, PA_MSGOBJECT(o
), PA_SOURCE_OUTPUT_MESSAGE_SET_RATE
, PA_UINT_TO_PTR(rate
), 0, NULL
, NULL
);
1108 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, o
->index
);
1112 /* Called from main context */
1113 void pa_source_output_set_name(pa_source_output
*o
, const char *name
) {
1115 pa_assert_ctl_context();
1116 pa_source_output_assert_ref(o
);
1118 if (!name
&& !pa_proplist_contains(o
->proplist
, PA_PROP_MEDIA_NAME
))
1121 old
= pa_proplist_gets(o
->proplist
, PA_PROP_MEDIA_NAME
);
1123 if (old
&& name
&& !strcmp(old
, name
))
1127 pa_proplist_sets(o
->proplist
, PA_PROP_MEDIA_NAME
, name
);
1129 pa_proplist_unset(o
->proplist
, PA_PROP_MEDIA_NAME
);
1131 if (PA_SOURCE_OUTPUT_IS_LINKED(o
->state
)) {
1132 pa_hook_fire(&o
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED
], o
);
1133 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, o
->index
);
1137 /* Called from main context */
1138 pa_resample_method_t
pa_source_output_get_resample_method(pa_source_output
*o
) {
1139 pa_source_output_assert_ref(o
);
1140 pa_assert_ctl_context();
1142 return o
->actual_resample_method
;
1145 /* Called from main context */
1146 pa_bool_t
pa_source_output_may_move(pa_source_output
*o
) {
1147 pa_source_output_assert_ref(o
);
1148 pa_assert_ctl_context();
1149 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
1151 if (o
->flags
& PA_SOURCE_OUTPUT_DONT_MOVE
)
1154 if (o
->direct_on_input
)
1160 /* Called from main context */
1161 pa_bool_t
pa_source_output_may_move_to(pa_source_output
*o
, pa_source
*dest
) {
1162 pa_source_output_assert_ref(o
);
1163 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
1164 pa_source_assert_ref(dest
);
1166 if (dest
== o
->source
)
1169 if (!pa_source_output_may_move(o
))
1172 if (pa_idxset_size(dest
->outputs
) >= PA_MAX_OUTPUTS_PER_SOURCE
) {
1173 pa_log_warn("Failed to move source output: too many outputs per source.");
1178 if (!o
->may_move_to(o
, dest
))
1184 /* Called from main context */
1185 int pa_source_output_start_move(pa_source_output
*o
) {
1189 pa_source_output_assert_ref(o
);
1190 pa_assert_ctl_context();
1191 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
1192 pa_assert(o
->source
);
1194 if (!pa_source_output_may_move(o
))
1195 return -PA_ERR_NOTSUPPORTED
;
1197 if ((r
= pa_hook_fire(&o
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_START
], o
)) < 0)
1202 pa_idxset_remove_by_data(o
->source
->outputs
, o
, NULL
);
1204 if (pa_source_output_get_state(o
) == PA_SOURCE_OUTPUT_CORKED
)
1205 pa_assert_se(origin
->n_corked
-- >= 1);
1207 if (pa_source_output_is_passthrough(o
))
1208 pa_source_leave_passthrough(o
->source
);
1210 if (pa_source_flat_volume_enabled(o
->source
))
1211 /* We might need to update the source's volume if we are in flat
1213 pa_source_set_volume(o
->source
, NULL
, FALSE
, FALSE
);
1215 pa_assert_se(pa_asyncmsgq_send(o
->source
->asyncmsgq
, PA_MSGOBJECT(o
->source
), PA_SOURCE_MESSAGE_REMOVE_OUTPUT
, o
, 0, NULL
) == 0);
1217 pa_source_update_status(o
->source
);
1220 pa_source_output_unref(o
);
1225 /* Called from main context. If it has an origin source that uses volume sharing,
1226 * then also the origin source and all streams connected to it need to update
1227 * their volume - this function does all that by using recursion. */
1228 static void update_volume_due_to_moving(pa_source_output
*o
, pa_source
*dest
) {
1229 pa_cvolume old_volume
;
1233 pa_assert(o
->source
); /* The destination source should already be set. */
1235 if (o
->destination_source
&& (o
->destination_source
->flags
& PA_SOURCE_SHARE_VOLUME_WITH_MASTER
)) {
1236 pa_source
*root_source
;
1237 pa_source_output
*destination_source_output
;
1240 root_source
= pa_source_get_master(o
->source
);
1242 if (PA_UNLIKELY(!root_source
))
1245 if (pa_source_flat_volume_enabled(o
->source
)) {
1246 /* Ok, so the origin source uses volume sharing, and flat volume is
1247 * enabled. The volume will have to be updated as follows:
1249 * o->volume := o->source->real_volume
1250 * (handled later by pa_source_set_volume)
1251 * o->reference_ratio := o->volume / o->source->reference_volume
1252 * (handled later by pa_source_set_volume)
1253 * o->real_ratio stays unchanged
1254 * (streams whose origin source uses volume sharing should
1255 * always have real_ratio of 0 dB)
1256 * o->soft_volume stays unchanged
1257 * (streams whose origin source uses volume sharing should
1258 * always have volume_factor as soft_volume, so no change
1259 * should be needed) */
1261 pa_assert(pa_cvolume_is_norm(&o
->real_ratio
));
1262 pa_assert(pa_cvolume_equal(&o
->soft_volume
, &o
->volume_factor
));
1264 /* Notifications will be sent by pa_source_set_volume(). */
1267 /* Ok, so the origin source uses volume sharing, and flat volume is
1268 * disabled. The volume will have to be updated as follows:
1271 * o->reference_ratio := 0 dB
1272 * o->real_ratio stays unchanged
1273 * (streams whose origin source uses volume sharing should
1274 * always have real_ratio of 0 dB)
1275 * o->soft_volume stays unchanged
1276 * (streams whose origin source uses volume sharing should
1277 * always have volume_factor as soft_volume, so no change
1278 * should be needed) */
1280 old_volume
= o
->volume
;
1281 pa_cvolume_reset(&o
->volume
, o
->volume
.channels
);
1282 pa_cvolume_reset(&o
->reference_ratio
, o
->reference_ratio
.channels
);
1283 pa_assert(pa_cvolume_is_norm(&o
->real_ratio
));
1284 pa_assert(pa_cvolume_equal(&o
->soft_volume
, &o
->volume_factor
));
1286 /* Notify others about the changed source output volume. */
1287 if (!pa_cvolume_equal(&o
->volume
, &old_volume
)) {
1288 if (o
->volume_changed
)
1289 o
->volume_changed(o
);
1291 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, o
->index
);
1295 /* Additionally, the origin source volume needs updating:
1297 * o->destination_source->reference_volume := root_source->reference_volume
1298 * o->destination_source->real_volume := root_source->real_volume
1299 * o->destination_source->soft_volume stays unchanged
1300 * (sources that use volume sharing should always have
1301 * soft_volume of 0 dB) */
1303 old_volume
= o
->destination_source
->reference_volume
;
1305 o
->destination_source
->reference_volume
= root_source
->reference_volume
;
1306 pa_cvolume_remap(&o
->destination_source
->reference_volume
, &root_source
->channel_map
, &o
->destination_source
->channel_map
);
1308 o
->destination_source
->real_volume
= root_source
->real_volume
;
1309 pa_cvolume_remap(&o
->destination_source
->real_volume
, &root_source
->channel_map
, &o
->destination_source
->channel_map
);
1311 pa_assert(pa_cvolume_is_norm(&o
->destination_source
->soft_volume
));
1313 /* Notify others about the changed source volume. If you wonder whether
1314 * o->destination_source->set_volume() should be called somewhere, that's not
1315 * the case, because sources that use volume sharing shouldn't have any
1316 * internal volume that set_volume() would update. If you wonder
1317 * whether the thread_info variables should be synced, yes, they
1318 * should, and it's done by the PA_SOURCE_MESSAGE_FINISH_MOVE message
1320 if (!pa_cvolume_equal(&o
->destination_source
->reference_volume
, &old_volume
))
1321 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE
|PA_SUBSCRIPTION_EVENT_CHANGE
, o
->destination_source
->index
);
1323 /* Recursively update origin source outputs. */
1324 PA_IDXSET_FOREACH(destination_source_output
, o
->destination_source
->outputs
, idx
)
1325 update_volume_due_to_moving(destination_source_output
, dest
);
1328 old_volume
= o
->volume
;
1330 if (pa_source_flat_volume_enabled(o
->source
)) {
1331 /* Ok, so this is a regular stream, and flat volume is enabled. The
1332 * volume will have to be updated as follows:
1334 * o->volume := o->reference_ratio * o->source->reference_volume
1335 * o->reference_ratio stays unchanged
1336 * o->real_ratio := o->volume / o->source->real_volume
1337 * (handled later by pa_source_set_volume)
1338 * o->soft_volume := o->real_ratio * o->volume_factor
1339 * (handled later by pa_source_set_volume) */
1341 o
->volume
= o
->source
->reference_volume
;
1342 pa_cvolume_remap(&o
->volume
, &o
->source
->channel_map
, &o
->channel_map
);
1343 pa_sw_cvolume_multiply(&o
->volume
, &o
->volume
, &o
->reference_ratio
);
1346 /* Ok, so this is a regular stream, and flat volume is disabled.
1347 * The volume will have to be updated as follows:
1349 * o->volume := o->reference_ratio
1350 * o->reference_ratio stays unchanged
1351 * o->real_ratio := o->reference_ratio
1352 * o->soft_volume := o->real_ratio * o->volume_factor */
1354 o
->volume
= o
->reference_ratio
;
1355 o
->real_ratio
= o
->reference_ratio
;
1356 pa_sw_cvolume_multiply(&o
->soft_volume
, &o
->real_ratio
, &o
->volume_factor
);
1359 /* Notify others about the changed source output volume. */
1360 if (!pa_cvolume_equal(&o
->volume
, &old_volume
)) {
1361 /* XXX: In case o->source has flat volume enabled, then real_ratio
1362 * and soft_volume are not updated yet. Let's hope that the
1363 * callback implementation doesn't care about those variables... */
1364 if (o
->volume_changed
)
1365 o
->volume_changed(o
);
1367 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, o
->index
);
1371 /* If o->source == dest, then recursion has finished, and we can finally call
1372 * pa_source_set_volume(), which will do the rest of the updates. */
1373 if ((o
->source
== dest
) && pa_source_flat_volume_enabled(o
->source
))
1374 pa_source_set_volume(o
->source
, NULL
, FALSE
, o
->save_volume
);
1377 /* Called from main context */
1378 int pa_source_output_finish_move(pa_source_output
*o
, pa_source
*dest
, pa_bool_t save
) {
1379 pa_source_output_assert_ref(o
);
1380 pa_assert_ctl_context();
1381 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
1382 pa_assert(!o
->source
);
1383 pa_source_assert_ref(dest
);
1385 if (!pa_source_output_may_move_to(o
, dest
))
1386 return -PA_ERR_NOTSUPPORTED
;
1388 if (pa_source_output_is_passthrough(o
) && !pa_source_check_format(dest
, o
->format
)) {
1389 pa_proplist
*p
= pa_proplist_new();
1390 pa_log_debug("New source doesn't support stream format, sending format-changed and killing");
1391 /* Tell the client what device we want to be on if it is going to
1393 pa_proplist_sets(p
, "device", dest
->name
);
1394 pa_source_output_send_event(o
, PA_STREAM_EVENT_FORMAT_LOST
, p
);
1395 pa_proplist_free(p
);
1396 return -PA_ERR_NOTSUPPORTED
;
1399 if (!(o
->flags
& PA_SOURCE_OUTPUT_VARIABLE_RATE
) &&
1400 !pa_sample_spec_equal(&o
->sample_spec
, &dest
->sample_spec
)){
1401 /* try to change dest sink rate if possible without glitches.
1402 module-suspend-on-idle resumes destination source with
1403 SOURCE_OUTPUT_MOVE_FINISH hook */
1405 pa_log_info("Trying to change sample rate");
1406 if (pa_source_update_rate(dest
, o
->sample_spec
.rate
, pa_source_output_is_passthrough(o
)) == TRUE
)
1407 pa_log_info("Rate changed to %u kHz",
1408 dest
->sample_spec
.rate
);
1410 pa_log_info("Resampling enabled to %u kHz",
1411 dest
->sample_spec
.rate
);
1418 o
->save_source
= save
;
1419 pa_idxset_put(o
->source
->outputs
, pa_source_output_ref(o
), NULL
);
1421 pa_cvolume_remap(&o
->volume_factor_source
, &o
->channel_map
, &o
->source
->channel_map
);
1423 if (pa_source_output_get_state(o
) == PA_SOURCE_OUTPUT_CORKED
)
1424 o
->source
->n_corked
++;
1426 pa_source_output_update_rate(o
);
1428 pa_source_update_status(dest
);
1430 update_volume_due_to_moving(o
, dest
);
1432 if (pa_source_output_is_passthrough(o
))
1433 pa_source_enter_passthrough(o
->source
);
1435 pa_assert_se(pa_asyncmsgq_send(o
->source
->asyncmsgq
, PA_MSGOBJECT(o
->source
), PA_SOURCE_MESSAGE_ADD_OUTPUT
, o
, 0, NULL
) == 0);
1437 pa_log_debug("Successfully moved source output %i to %s.", o
->index
, dest
->name
);
1439 /* Notify everyone */
1440 pa_hook_fire(&o
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FINISH
], o
);
1441 pa_subscription_post(o
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
, o
->index
);
1446 /* Called from main context */
1447 void pa_source_output_fail_move(pa_source_output
*o
) {
1449 pa_source_output_assert_ref(o
);
1450 pa_assert_ctl_context();
1451 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
1452 pa_assert(!o
->source
);
1454 /* Check if someone wants this source output? */
1455 if (pa_hook_fire(&o
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FAIL
], o
) == PA_HOOK_STOP
)
1461 pa_source_output_kill(o
);
1464 /* Called from main context */
1465 int pa_source_output_move_to(pa_source_output
*o
, pa_source
*dest
, pa_bool_t save
) {
1468 pa_source_output_assert_ref(o
);
1469 pa_assert_ctl_context();
1470 pa_assert(PA_SOURCE_OUTPUT_IS_LINKED(o
->state
));
1471 pa_assert(o
->source
);
1472 pa_source_assert_ref(dest
);
1474 if (dest
== o
->source
)
1477 if (!pa_source_output_may_move_to(o
, dest
))
1478 return -PA_ERR_NOTSUPPORTED
;
1480 pa_source_output_ref(o
);
1482 if ((r
= pa_source_output_start_move(o
)) < 0) {
1483 pa_source_output_unref(o
);
1487 if ((r
= pa_source_output_finish_move(o
, dest
, save
)) < 0) {
1488 pa_source_output_fail_move(o
);
1489 pa_source_output_unref(o
);
1493 pa_source_output_unref(o
);
1498 /* Called from IO thread context */
1499 void pa_source_output_set_state_within_thread(pa_source_output
*o
, pa_source_output_state_t state
) {
1500 pa_source_output_assert_ref(o
);
1501 pa_source_output_assert_io_context(o
);
1503 if (state
== o
->thread_info
.state
)
1506 if (o
->state_change
)
1507 o
->state_change(o
, state
);
1509 o
->thread_info
.state
= state
;
1512 /* Called from IO thread context, except when it is not */
1513 int pa_source_output_process_msg(pa_msgobject
*mo
, int code
, void *userdata
, int64_t offset
, pa_memchunk
* chunk
) {
1514 pa_source_output
*o
= PA_SOURCE_OUTPUT(mo
);
1515 pa_source_output_assert_ref(o
);
1519 case PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY
: {
1520 pa_usec_t
*r
= userdata
;
1522 r
[0] += pa_bytes_to_usec(pa_memblockq_get_length(o
->thread_info
.delay_memblockq
), &o
->source
->sample_spec
);
1523 r
[1] += pa_source_get_latency_within_thread(o
->source
);
1528 case PA_SOURCE_OUTPUT_MESSAGE_SET_RATE
:
1530 o
->thread_info
.sample_spec
.rate
= PA_PTR_TO_UINT(userdata
);
1531 pa_resampler_set_output_rate(o
->thread_info
.resampler
, PA_PTR_TO_UINT(userdata
));
1534 case PA_SOURCE_OUTPUT_MESSAGE_SET_STATE
:
1536 pa_source_output_set_state_within_thread(o
, PA_PTR_TO_UINT(userdata
));
1540 case PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY
: {
1541 pa_usec_t
*usec
= userdata
;
1543 *usec
= pa_source_output_set_requested_latency_within_thread(o
, *usec
);
1548 case PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY
: {
1549 pa_usec_t
*r
= userdata
;
1551 *r
= o
->thread_info
.requested_source_latency
;
1555 case PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_VOLUME
:
1556 if (!pa_cvolume_equal(&o
->thread_info
.soft_volume
, &o
->soft_volume
)) {
1557 o
->thread_info
.soft_volume
= o
->soft_volume
;
1561 case PA_SOURCE_OUTPUT_MESSAGE_SET_SOFT_MUTE
:
1562 if (o
->thread_info
.muted
!= o
->muted
) {
1563 o
->thread_info
.muted
= o
->muted
;
1568 return -PA_ERR_NOTIMPLEMENTED
;
1571 /* Called from main context */
1572 void pa_source_output_send_event(pa_source_output
*o
, const char *event
, pa_proplist
*data
) {
1573 pa_proplist
*pl
= NULL
;
1574 pa_source_output_send_event_hook_data hook_data
;
1576 pa_source_output_assert_ref(o
);
1577 pa_assert_ctl_context();
1584 data
= pl
= pa_proplist_new();
1586 hook_data
.source_output
= o
;
1587 hook_data
.data
= data
;
1588 hook_data
.event
= event
;
1590 if (pa_hook_fire(&o
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_SEND_EVENT
], &hook_data
) < 0)
1593 o
->send_event(o
, event
, data
);
1597 pa_proplist_free(pl
);
1600 /* Called from main context */
1601 /* Updates the source output's resampler with whatever the current source
1602 * requires -- useful when the underlying source's rate might have changed */
1603 int pa_source_output_update_rate(pa_source_output
*o
) {
1604 pa_resampler
*new_resampler
;
1605 char *memblockq_name
;
1607 pa_source_output_assert_ref(o
);
1608 pa_assert_ctl_context();
1610 if (o
->thread_info
.resampler
&&
1611 pa_sample_spec_equal(pa_resampler_input_sample_spec(o
->thread_info
.resampler
), &o
->source
->sample_spec
) &&
1612 pa_channel_map_equal(pa_resampler_input_channel_map(o
->thread_info
.resampler
), &o
->source
->channel_map
))
1614 new_resampler
= o
->thread_info
.resampler
;
1616 else if (!pa_source_output_is_passthrough(o
) &&
1617 ((o
->flags
& PA_SOURCE_OUTPUT_VARIABLE_RATE
) ||
1618 !pa_sample_spec_equal(&o
->sample_spec
, &o
->source
->sample_spec
) ||
1619 !pa_channel_map_equal(&o
->channel_map
, &o
->source
->channel_map
))) {
1621 new_resampler
= pa_resampler_new(o
->core
->mempool
,
1622 &o
->source
->sample_spec
, &o
->source
->channel_map
,
1623 &o
->sample_spec
, &o
->channel_map
,
1624 o
->requested_resample_method
,
1625 ((o
->flags
& PA_SOURCE_OUTPUT_VARIABLE_RATE
) ? PA_RESAMPLER_VARIABLE_RATE
: 0) |
1626 ((o
->flags
& PA_SOURCE_OUTPUT_NO_REMAP
) ? PA_RESAMPLER_NO_REMAP
: 0) |
1627 (o
->core
->disable_remixing
|| (o
->flags
& PA_SOURCE_OUTPUT_NO_REMIX
) ? PA_RESAMPLER_NO_REMIX
: 0));
1629 if (!new_resampler
) {
1630 pa_log_warn("Unsupported resampling operation.");
1631 return -PA_ERR_NOTSUPPORTED
;
1634 new_resampler
= NULL
;
1636 if (new_resampler
== o
->thread_info
.resampler
)
1639 if (o
->thread_info
.resampler
)
1640 pa_resampler_free(o
->thread_info
.resampler
);
1642 o
->thread_info
.resampler
= new_resampler
;
1644 pa_memblockq_free(o
->thread_info
.delay_memblockq
);
1646 memblockq_name
= pa_sprintf_malloc("source output delay_memblockq [%u]", o
->index
);
1647 o
->thread_info
.delay_memblockq
= pa_memblockq_new(
1650 MEMBLOCKQ_MAXLENGTH
,
1652 &o
->source
->sample_spec
,
1656 &o
->source
->silence
);
1657 pa_xfree(memblockq_name
);
1659 o
->actual_resample_method
= new_resampler
? pa_resampler_get_method(new_resampler
) : PA_RESAMPLER_INVALID
;
1661 pa_log_debug("Updated resmpler for source output %d", o
->index
);