4 This file is part of PulseAudio.
6 Copyright 2004-2006 Lennart Poettering
7 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published
11 by the Free Software Foundation; either version 2 of the License,
12 or (at your option) any later version.
14 PulseAudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
33 #include <pulse/utf8.h>
34 #include <pulse/xmalloc.h>
35 #include <pulse/timeval.h>
37 #include <pulsecore/source-output.h>
38 #include <pulsecore/namereg.h>
39 #include <pulsecore/core-subscribe.h>
40 #include <pulsecore/log.h>
41 #include <pulsecore/sample-util.h>
45 #define DEFAULT_MIN_LATENCY (4*PA_USEC_PER_MSEC)
47 static PA_DEFINE_CHECK_TYPE(pa_source, pa_msgobject);
49 static void source_free(pa_object *o);
51 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data) {
54 memset(data, 0, sizeof(*data));
55 data->proplist = pa_proplist_new();
60 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name) {
64 data->name = pa_xstrdup(name);
67 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec) {
70 if ((data->sample_spec_is_set = !!spec))
71 data->sample_spec = *spec;
74 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map) {
77 if ((data->channel_map_is_set = !!map))
78 data->channel_map = *map;
81 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume) {
84 if ((data->volume_is_set = !!volume))
85 data->volume = *volume;
88 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute) {
91 data->muted_is_set = TRUE;
95 void pa_source_new_data_done(pa_source_new_data *data) {
99 pa_proplist_free(data->proplist);
102 static void reset_callbacks(pa_source *s) {
106 s->get_volume = NULL;
107 s->set_volume = NULL;
110 s->get_latency = NULL;
111 s->update_requested_latency = NULL;
114 pa_source* pa_source_new(
116 pa_source_new_data *data,
117 pa_source_flags_t flags) {
121 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
125 s = pa_msgobject_new(pa_source);
127 if (!(name = pa_namereg_register(core, data->name, PA_NAMEREG_SOURCE, s, data->namereg_fail))) {
132 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_NEW], data) < 0) {
134 pa_namereg_unregister(core, name);
138 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
139 pa_return_null_if_fail(data->name && pa_utf8_valid(data->name) && data->name[0]);
141 pa_return_null_if_fail(data->sample_spec_is_set && pa_sample_spec_valid(&data->sample_spec));
143 if (!data->channel_map_is_set)
144 pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
146 pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
147 pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
149 if (!data->volume_is_set)
150 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
152 pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
153 pa_return_null_if_fail(data->volume.channels == data->sample_spec.channels);
155 if (!data->muted_is_set)
158 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_FIXATE], data) < 0) {
160 pa_namereg_unregister(core, name);
164 s->parent.parent.free = source_free;
165 s->parent.process_msg = pa_source_process_msg;
168 s->state = PA_SOURCE_INIT;
170 s->name = pa_xstrdup(name);
171 s->proplist = pa_proplist_copy(data->proplist);
172 s->driver = pa_xstrdup(data->driver);
173 s->module = data->module;
175 s->sample_spec = data->sample_spec;
176 s->channel_map = data->channel_map;
178 s->outputs = pa_idxset_new(NULL, NULL);
180 s->monitor_of = NULL;
182 s->volume = data->volume;
183 s->muted = data->muted;
184 s->refresh_volume = s->refresh_muted = FALSE;
192 pa_silence_memchunk_get(
193 &core->silence_cache,
199 s->min_latency = DEFAULT_MIN_LATENCY;
200 s->max_latency = s->min_latency;
202 s->thread_info.outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
203 s->thread_info.soft_volume = s->volume;
204 s->thread_info.soft_muted = s->muted;
205 s->thread_info.state = s->state;
206 s->thread_info.max_rewind = 0;
207 s->thread_info.requested_latency_valid = TRUE;
208 s->thread_info.requested_latency = 0;
210 pa_assert_se(pa_idxset_put(core->sources, s, &s->index) >= 0);
212 pa_log_info("Created source %u \"%s\" with sample spec %s and channel map %s",
215 pa_sample_spec_snprint(st, sizeof(st), &s->sample_spec),
216 pa_channel_map_snprint(cm, sizeof(cm), &s->channel_map));
221 static int source_set_state(pa_source *s, pa_source_state_t state) {
223 pa_bool_t suspend_change;
227 if (s->state == state)
231 (s->state == PA_SOURCE_SUSPENDED && PA_SOURCE_OPENED(state)) ||
232 (PA_SOURCE_OPENED(s->state) && state == PA_SOURCE_SUSPENDED);
235 if ((ret = s->set_state(s, state)) < 0)
238 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
243 if (suspend_change) {
247 /* We're suspending or resuming, tell everyone about it */
249 for (o = PA_SOURCE_OUTPUT(pa_idxset_first(s->outputs, &idx)); o; o = PA_SOURCE_OUTPUT(pa_idxset_next(s->outputs, &idx)))
251 o->suspend(o, state == PA_SINK_SUSPENDED);
254 if (state != PA_SOURCE_UNLINKED) /* if we enter UNLINKED state pa_source_unlink() will fire the apropriate events */
255 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_STATE_CHANGED], s);
260 void pa_source_put(pa_source *s) {
261 pa_source_assert_ref(s);
263 pa_assert(s->state == PA_SINK_INIT);
264 pa_assert(s->asyncmsgq);
265 pa_assert(s->rtpoll);
267 pa_assert(!s->min_latency || !s->max_latency || s->min_latency <= s->max_latency);
269 if (!(s->flags & PA_SOURCE_HW_VOLUME_CTRL))
270 s->flags |= PA_SOURCE_DECIBEL_VOLUME;
272 pa_assert_se(source_set_state(s, PA_SOURCE_IDLE) == 0);
274 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_NEW, s->index);
275 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PUT], s);
278 void pa_source_unlink(pa_source *s) {
280 pa_source_output *o, *j = NULL;
284 /* See pa_sink_unlink() for a couple of comments how this function
287 linked = PA_SOURCE_LINKED(s->state);
290 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK], s);
292 if (s->state != PA_SOURCE_UNLINKED)
293 pa_namereg_unregister(s->core, s->name);
294 pa_idxset_remove_by_data(s->core->sources, s, NULL);
296 while ((o = pa_idxset_first(s->outputs, NULL))) {
298 pa_source_output_kill(o);
303 source_set_state(s, PA_SOURCE_UNLINKED);
305 s->state = PA_SOURCE_UNLINKED;
310 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
311 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK_POST], s);
315 static void source_free(pa_object *o) {
316 pa_source_output *so;
317 pa_source *s = PA_SOURCE(o);
320 pa_assert(pa_source_refcnt(s) == 0);
322 if (PA_SOURCE_LINKED(s->state))
325 pa_log_info("Freeing source %u \"%s\"", s->index, s->name);
327 pa_idxset_free(s->outputs, NULL, NULL);
329 while ((so = pa_hashmap_steal_first(s->thread_info.outputs)))
330 pa_source_output_unref(so);
332 pa_hashmap_free(s->thread_info.outputs, NULL, NULL);
334 if (s->silence.memblock)
335 pa_memblock_unref(s->silence.memblock);
341 pa_proplist_free(s->proplist);
346 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q) {
347 pa_source_assert_ref(s);
353 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p) {
354 pa_source_assert_ref(s);
360 int pa_source_update_status(pa_source*s) {
361 pa_source_assert_ref(s);
362 pa_assert(PA_SOURCE_LINKED(s->state));
364 if (s->state == PA_SOURCE_SUSPENDED)
367 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
370 int pa_source_suspend(pa_source *s, pa_bool_t suspend) {
371 pa_source_assert_ref(s);
372 pa_assert(PA_SOURCE_LINKED(s->state));
375 return source_set_state(s, PA_SOURCE_SUSPENDED);
377 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
380 void pa_source_process_rewind(pa_source *s, size_t nbytes) {
384 pa_source_assert_ref(s);
385 pa_assert(PA_SOURCE_OPENED(s->thread_info.state));
390 pa_log_debug("Processing rewind...");
392 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
393 pa_source_output_assert_ref(o);
394 pa_source_output_process_rewind(o, nbytes);
398 void pa_source_post(pa_source*s, const pa_memchunk *chunk) {
402 pa_source_assert_ref(s);
403 pa_assert(PA_SOURCE_OPENED(s->thread_info.state));
406 if (s->thread_info.state != PA_SOURCE_RUNNING)
409 if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
410 pa_memchunk vchunk = *chunk;
412 pa_memblock_ref(vchunk.memblock);
413 pa_memchunk_make_writable(&vchunk, 0);
415 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
416 pa_silence_memchunk(&vchunk, &s->sample_spec);
418 pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
420 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
421 pa_source_output_assert_ref(o);
422 pa_source_output_push(o, &vchunk);
425 pa_memblock_unref(vchunk.memblock);
428 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL))) {
429 pa_source_output_assert_ref(o);
430 pa_source_output_push(o, chunk);
435 pa_usec_t pa_source_get_latency(pa_source *s) {
438 pa_source_assert_ref(s);
439 pa_assert(PA_SOURCE_LINKED(s->state));
441 if (!PA_SOURCE_OPENED(s->state))
445 return s->get_latency(s);
447 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
453 void pa_source_set_volume(pa_source *s, const pa_cvolume *volume) {
456 pa_source_assert_ref(s);
457 pa_assert(PA_SOURCE_LINKED(s->state));
460 changed = !pa_cvolume_equal(volume, &s->volume);
463 if (s->set_volume && s->set_volume(s) < 0)
464 s->set_volume = NULL;
467 pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME, pa_xnewdup(struct pa_cvolume, volume, 1), 0, NULL, pa_xfree);
470 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
473 const pa_cvolume *pa_source_get_volume(pa_source *s) {
474 pa_cvolume old_volume;
476 pa_source_assert_ref(s);
477 pa_assert(PA_SOURCE_LINKED(s->state));
479 old_volume = s->volume;
481 if (s->get_volume && s->get_volume(s) < 0)
482 s->get_volume = NULL;
484 if (!s->get_volume && s->refresh_volume)
485 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_VOLUME, &s->volume, 0, NULL);
487 if (!pa_cvolume_equal(&old_volume, &s->volume))
488 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
493 void pa_source_set_mute(pa_source *s, pa_bool_t mute) {
496 pa_source_assert_ref(s);
497 pa_assert(PA_SOURCE_LINKED(s->state));
499 changed = s->muted != mute;
502 if (s->set_mute && s->set_mute(s) < 0)
506 pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MUTE, PA_UINT_TO_PTR(mute), 0, NULL, NULL);
509 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
512 pa_bool_t pa_source_get_mute(pa_source *s) {
515 pa_source_assert_ref(s);
516 pa_assert(PA_SOURCE_LINKED(s->state));
518 old_muted = s->muted;
520 if (s->get_mute && s->get_mute(s) < 0)
523 if (!s->get_mute && s->refresh_muted)
524 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MUTE, &s->muted, 0, NULL);
526 if (old_muted != s->muted)
527 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
532 void pa_source_set_description(pa_source *s, const char *description) {
534 pa_source_assert_ref(s);
536 if (!description && !pa_proplist_contains(s->proplist, PA_PROP_DEVICE_DESCRIPTION))
539 old = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
541 if (old && description && !strcmp(old, description))
545 pa_proplist_sets(s->proplist, PA_PROP_DEVICE_DESCRIPTION, description);
547 pa_proplist_unset(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
549 if (PA_SOURCE_LINKED(s->state)) {
550 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
551 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED], s);
555 unsigned pa_source_linked_by(pa_source *s) {
556 pa_source_assert_ref(s);
557 pa_assert(PA_SOURCE_LINKED(s->state));
559 return pa_idxset_size(s->outputs);
562 unsigned pa_source_used_by(pa_source *s) {
565 pa_source_assert_ref(s);
566 pa_assert(PA_SOURCE_LINKED(s->state));
568 ret = pa_idxset_size(s->outputs);
569 pa_assert(ret >= s->n_corked);
571 return ret - s->n_corked;
574 int pa_source_process_msg(pa_msgobject *object, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
575 pa_source *s = PA_SOURCE(object);
576 pa_source_assert_ref(s);
577 pa_assert(s->thread_info.state != PA_SOURCE_UNLINKED);
579 switch ((pa_source_message_t) code) {
580 case PA_SOURCE_MESSAGE_ADD_OUTPUT: {
581 pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
583 pa_hashmap_put(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index), pa_source_output_ref(o));
585 pa_source_output_update_max_rewind(o, s->thread_info.max_rewind);
587 pa_assert(!o->thread_info.attached);
588 o->thread_info.attached = TRUE;
593 pa_source_invalidate_requested_latency(s);
598 case PA_SOURCE_MESSAGE_REMOVE_OUTPUT: {
599 pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
604 pa_assert(o->thread_info.attached);
605 o->thread_info.attached = FALSE;
607 if (pa_hashmap_remove(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index)))
608 pa_source_output_unref(o);
610 pa_source_invalidate_requested_latency(s);
615 case PA_SOURCE_MESSAGE_SET_VOLUME:
616 s->thread_info.soft_volume = *((pa_cvolume*) userdata);
619 case PA_SOURCE_MESSAGE_SET_MUTE:
620 s->thread_info.soft_muted = PA_PTR_TO_UINT(userdata);
623 case PA_SOURCE_MESSAGE_GET_VOLUME:
624 *((pa_cvolume*) userdata) = s->thread_info.soft_volume;
627 case PA_SOURCE_MESSAGE_GET_MUTE:
628 *((pa_bool_t*) userdata) = s->thread_info.soft_muted;
631 case PA_SOURCE_MESSAGE_SET_STATE:
632 s->thread_info.state = PA_PTR_TO_UINT(userdata);
635 case PA_SOURCE_MESSAGE_DETACH:
637 /* We're detaching all our output streams so that the
638 * asyncmsgq and rtpoll fields can be changed without
640 pa_source_detach_within_thread(s);
643 case PA_SOURCE_MESSAGE_ATTACH:
645 /* Reattach all streams */
646 pa_source_attach_within_thread(s);
649 case PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY: {
651 pa_usec_t *usec = userdata;
652 *usec = pa_source_get_requested_latency_within_thread(s);
656 case PA_SOURCE_MESSAGE_GET_LATENCY:
657 case PA_SOURCE_MESSAGE_MAX:
664 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend) {
669 pa_core_assert_ref(c);
671 for (source = PA_SOURCE(pa_idxset_first(c->sources, &idx)); source; source = PA_SOURCE(pa_idxset_next(c->sources, &idx)))
672 ret -= pa_source_suspend(source, suspend) < 0;
677 void pa_source_detach(pa_source *s) {
678 pa_source_assert_ref(s);
679 pa_assert(PA_SOURCE_LINKED(s->state));
681 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_DETACH, NULL, 0, NULL);
684 void pa_source_attach(pa_source *s) {
685 pa_source_assert_ref(s);
686 pa_assert(PA_SOURCE_LINKED(s->state));
688 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_ATTACH, NULL, 0, NULL);
691 void pa_source_detach_within_thread(pa_source *s) {
695 pa_source_assert_ref(s);
696 pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
698 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
703 void pa_source_attach_within_thread(pa_source *s) {
707 pa_source_assert_ref(s);
708 pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
710 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
715 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s) {
716 pa_usec_t result = 0;
720 pa_source_assert_ref(s);
722 if (s->thread_info.requested_latency_valid)
723 return s->thread_info.requested_latency;
725 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
727 if (o->thread_info.requested_source_latency > 0 &&
728 (!result || result > o->thread_info.requested_source_latency))
729 result = o->thread_info.requested_source_latency;
732 if (s->max_latency > 0 && result > s->max_latency)
733 result = s->max_latency;
735 if (s->min_latency > 0 && result < s->min_latency)
736 result = s->min_latency;
739 s->thread_info.requested_latency = result;
740 s->thread_info.requested_latency_valid = TRUE;
745 pa_usec_t pa_source_get_requested_latency(pa_source *s) {
748 pa_source_assert_ref(s);
749 pa_assert(PA_SOURCE_LINKED(s->state));
751 if (!PA_SOURCE_OPENED(s->state))
754 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) < 0)
760 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind) {
764 pa_source_assert_ref(s);
766 if (max_rewind == s->thread_info.max_rewind)
769 s->thread_info.max_rewind = max_rewind;
771 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
772 pa_source_output_update_max_rewind(o, s->thread_info.max_rewind);
775 void pa_source_invalidate_requested_latency(pa_source *s) {
777 pa_source_assert_ref(s);
778 pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
780 if (!s->thread_info.requested_latency_valid)
783 s->thread_info.requested_latency_valid = FALSE;
785 if (s->update_requested_latency)
786 s->update_requested_latency(s);