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 pa_source* pa_source_new(
104 pa_source_new_data *data,
105 pa_source_flags_t flags) {
109 char st[PA_SAMPLE_SPEC_SNPRINT_MAX], cm[PA_CHANNEL_MAP_SNPRINT_MAX];
113 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_NEW], data) < 0)
116 pa_return_null_if_fail(!data->driver || pa_utf8_valid(data->driver));
117 pa_return_null_if_fail(data->name && pa_utf8_valid(data->name) && data->name[0]);
119 pa_return_null_if_fail(data->sample_spec_is_set && pa_sample_spec_valid(&data->sample_spec));
121 if (!data->channel_map_is_set)
122 pa_return_null_if_fail(pa_channel_map_init_auto(&data->channel_map, data->sample_spec.channels, PA_CHANNEL_MAP_DEFAULT));
124 pa_return_null_if_fail(pa_channel_map_valid(&data->channel_map));
125 pa_return_null_if_fail(data->channel_map.channels == data->sample_spec.channels);
127 if (!data->volume_is_set)
128 pa_cvolume_reset(&data->volume, data->sample_spec.channels);
130 pa_return_null_if_fail(pa_cvolume_valid(&data->volume));
131 pa_return_null_if_fail(data->volume.channels == data->sample_spec.channels);
133 if (!data->muted_is_set)
136 if (pa_hook_fire(&core->hooks[PA_CORE_HOOK_SOURCE_FIXATE], data) < 0)
139 s = pa_msgobject_new(pa_source);
141 if (!(name = pa_namereg_register(core, data->name, PA_NAMEREG_SOURCE, s, data->namereg_fail))) {
146 s->parent.parent.free = source_free;
147 s->parent.process_msg = pa_source_process_msg;
150 s->state = PA_SOURCE_INIT;
152 s->name = pa_xstrdup(name);
153 s->proplist = pa_proplist_copy(data->proplist);
154 s->driver = pa_xstrdup(data->driver);
155 s->module = data->module;
157 s->sample_spec = data->sample_spec;
158 s->channel_map = data->channel_map;
160 s->outputs = pa_idxset_new(NULL, NULL);
162 s->monitor_of = NULL;
164 s->volume = data->volume;
165 s->muted = data->muted;
166 s->refresh_volume = s->refresh_muted = FALSE;
168 s->min_latency = DEFAULT_MIN_LATENCY;
169 s->max_latency = s->min_latency;
171 s->get_latency = NULL;
172 s->set_volume = NULL;
173 s->get_volume = NULL;
177 s->update_requested_latency = NULL;
183 s->thread_info.outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
184 s->thread_info.soft_volume = s->volume;
185 s->thread_info.soft_muted = s->muted;
186 s->thread_info.state = s->state;
187 s->thread_info.requested_latency_valid = TRUE;
188 s->thread_info.requested_latency = 0;
190 pa_assert_se(pa_idxset_put(core->sources, s, &s->index) >= 0);
192 pa_log_info("Created source %u \"%s\" with sample spec %s and channel map %s",
195 pa_sample_spec_snprint(st, sizeof(st), &s->sample_spec),
196 pa_channel_map_snprint(cm, sizeof(cm), &s->channel_map));
201 static int source_set_state(pa_source *s, pa_source_state_t state) {
203 pa_bool_t suspend_change;
207 if (s->state == state)
211 (s->state == PA_SOURCE_SUSPENDED && PA_SOURCE_OPENED(state)) ||
212 (PA_SOURCE_OPENED(s->state) && state == PA_SOURCE_SUSPENDED);
215 if ((ret = s->set_state(s, state)) < 0)
218 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
223 if (suspend_change) {
227 /* We're suspending or resuming, tell everyone about it */
229 for (o = PA_SOURCE_OUTPUT(pa_idxset_first(s->outputs, &idx)); o; o = PA_SOURCE_OUTPUT(pa_idxset_next(s->outputs, &idx)))
231 o->suspend(o, state == PA_SINK_SUSPENDED);
234 if (state != PA_SOURCE_UNLINKED) /* if we enter UNLINKED state pa_source_unlink() will fire the apropriate events */
235 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_STATE_CHANGED], s);
240 void pa_source_put(pa_source *s) {
241 pa_source_assert_ref(s);
243 pa_assert(s->state == PA_SINK_INIT);
244 pa_assert(s->rtpoll);
245 pa_assert(s->asyncmsgq);
247 pa_assert(!s->min_latency || !s->max_latency || s->min_latency <= s->max_latency);
249 if (s->get_volume && s->set_volume)
250 s->flags |= PA_SOURCE_HW_VOLUME_CTRL;
252 s->get_volume = NULL;
253 s->set_volume = NULL;
254 s->flags = (s->flags & ~PA_SOURCE_HW_VOLUME_CTRL) | PA_SOURCE_DECIBEL_VOLUME;
257 if (s->get_mute && s->set_mute)
258 s->flags |= PA_SOURCE_HW_MUTE_CTRL;
262 s->flags &= ~PA_SOURCE_HW_MUTE_CTRL;
265 pa_assert_se(source_set_state(s, PA_SOURCE_IDLE) == 0);
267 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_NEW, s->index);
268 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PUT], s);
271 void pa_source_unlink(pa_source *s) {
273 pa_source_output *o, *j = NULL;
277 /* See pa_sink_unlink() for a couple of comments how this function
280 linked = PA_SOURCE_LINKED(s->state);
283 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK], s);
285 if (s->state != PA_SOURCE_UNLINKED)
286 pa_namereg_unregister(s->core, s->name);
287 pa_idxset_remove_by_data(s->core->sources, s, NULL);
289 while ((o = pa_idxset_first(s->outputs, NULL))) {
291 pa_source_output_kill(o);
296 source_set_state(s, PA_SOURCE_UNLINKED);
298 s->state = PA_SOURCE_UNLINKED;
300 s->get_latency = NULL;
301 s->get_volume = NULL;
302 s->set_volume = NULL;
306 s->update_requested_latency = NULL;
309 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
310 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK_POST], s);
314 static void source_free(pa_object *o) {
315 pa_source_output *so;
316 pa_source *s = PA_SOURCE(o);
319 pa_assert(pa_source_refcnt(s) == 0);
321 if (PA_SOURCE_LINKED(s->state))
324 pa_log_info("Freeing source %u \"%s\"", s->index, s->name);
326 pa_idxset_free(s->outputs, NULL, NULL);
328 while ((so = pa_hashmap_steal_first(s->thread_info.outputs)))
329 pa_source_output_unref(so);
331 pa_hashmap_free(s->thread_info.outputs, NULL, NULL);
337 pa_proplist_free(s->proplist);
342 int pa_source_update_status(pa_source*s) {
343 pa_source_assert_ref(s);
344 pa_assert(PA_SOURCE_LINKED(s->state));
346 if (s->state == PA_SOURCE_SUSPENDED)
349 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
352 int pa_source_suspend(pa_source *s, pa_bool_t suspend) {
353 pa_source_assert_ref(s);
354 pa_assert(PA_SOURCE_LINKED(s->state));
357 return source_set_state(s, PA_SOURCE_SUSPENDED);
359 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
362 void pa_source_ping(pa_source *s) {
363 pa_source_assert_ref(s);
364 pa_assert(PA_SOURCE_LINKED(s->state));
366 pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_PING, NULL, 0, NULL, NULL);
369 void pa_source_post(pa_source*s, const pa_memchunk *chunk) {
373 pa_source_assert_ref(s);
374 pa_assert(PA_SOURCE_OPENED(s->thread_info.state));
377 if (s->thread_info.state != PA_SOURCE_RUNNING)
380 if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
381 pa_memchunk vchunk = *chunk;
383 pa_memblock_ref(vchunk.memblock);
384 pa_memchunk_make_writable(&vchunk, 0);
386 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
387 pa_silence_memchunk(&vchunk, &s->sample_spec);
389 pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
391 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
392 pa_source_output_push(o, &vchunk);
394 pa_memblock_unref(vchunk.memblock);
397 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
398 pa_source_output_push(o, chunk);
402 pa_usec_t pa_source_get_latency(pa_source *s) {
405 pa_source_assert_ref(s);
406 pa_assert(PA_SOURCE_LINKED(s->state));
408 if (!PA_SOURCE_OPENED(s->state))
412 return s->get_latency(s);
414 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
420 void pa_source_set_volume(pa_source *s, const pa_cvolume *volume) {
423 pa_source_assert_ref(s);
424 pa_assert(PA_SOURCE_LINKED(s->state));
427 changed = !pa_cvolume_equal(volume, &s->volume);
430 if (s->set_volume && s->set_volume(s) < 0)
431 s->set_volume = NULL;
434 pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME, pa_xnewdup(struct pa_cvolume, volume, 1), 0, NULL, pa_xfree);
437 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
440 const pa_cvolume *pa_source_get_volume(pa_source *s) {
441 pa_cvolume old_volume;
443 pa_source_assert_ref(s);
444 pa_assert(PA_SOURCE_LINKED(s->state));
446 old_volume = s->volume;
448 if (s->get_volume && s->get_volume(s) < 0)
449 s->get_volume = NULL;
451 if (!s->get_volume && s->refresh_volume)
452 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_VOLUME, &s->volume, 0, NULL);
454 if (!pa_cvolume_equal(&old_volume, &s->volume))
455 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
460 void pa_source_set_mute(pa_source *s, pa_bool_t mute) {
463 pa_source_assert_ref(s);
464 pa_assert(PA_SOURCE_LINKED(s->state));
466 changed = s->muted != mute;
469 if (s->set_mute && s->set_mute(s) < 0)
473 pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MUTE, PA_UINT_TO_PTR(mute), 0, NULL, NULL);
476 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
479 pa_bool_t pa_source_get_mute(pa_source *s) {
482 pa_source_assert_ref(s);
483 pa_assert(PA_SOURCE_LINKED(s->state));
485 old_muted = s->muted;
487 if (s->get_mute && s->get_mute(s) < 0)
490 if (!s->get_mute && s->refresh_muted)
491 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MUTE, &s->muted, 0, NULL);
493 if (old_muted != s->muted)
494 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
499 void pa_source_set_description(pa_source *s, const char *description) {
501 pa_source_assert_ref(s);
503 if (!description && !pa_proplist_contains(s->proplist, PA_PROP_DEVICE_DESCRIPTION))
506 old = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
507 if (old && description && !strcmp(old, description))
511 pa_proplist_sets(s->proplist, PA_PROP_DEVICE_DESCRIPTION, description);
513 pa_proplist_unset(s->proplist, PA_PROP_DEVICE_DESCRIPTION);
515 if (PA_SOURCE_LINKED(s->state)) {
516 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
517 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED], s);
521 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q) {
522 pa_source_assert_ref(s);
528 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p) {
529 pa_source_assert_ref(s);
535 unsigned pa_source_linked_by(pa_source *s) {
536 pa_source_assert_ref(s);
537 pa_assert(PA_SOURCE_LINKED(s->state));
539 return pa_idxset_size(s->outputs);
542 unsigned pa_source_used_by(pa_source *s) {
545 pa_source_assert_ref(s);
546 pa_assert(PA_SOURCE_LINKED(s->state));
548 ret = pa_idxset_size(s->outputs);
549 pa_assert(ret >= s->n_corked);
551 return ret - s->n_corked;
554 int pa_source_process_msg(pa_msgobject *object, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
555 pa_source *s = PA_SOURCE(object);
556 pa_source_assert_ref(s);
557 pa_assert(s->thread_info.state != PA_SOURCE_UNLINKED);
559 switch ((pa_source_message_t) code) {
560 case PA_SOURCE_MESSAGE_ADD_OUTPUT: {
561 pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
563 pa_hashmap_put(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index), pa_source_output_ref(o));
565 pa_assert(!o->thread_info.attached);
566 o->thread_info.attached = TRUE;
571 pa_source_invalidate_requested_latency(s);
576 case PA_SOURCE_MESSAGE_REMOVE_OUTPUT: {
577 pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
582 pa_assert(o->thread_info.attached);
583 o->thread_info.attached = FALSE;
585 if (pa_hashmap_remove(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index)))
586 pa_source_output_unref(o);
588 pa_source_invalidate_requested_latency(s);
593 case PA_SOURCE_MESSAGE_SET_VOLUME:
594 s->thread_info.soft_volume = *((pa_cvolume*) userdata);
597 case PA_SOURCE_MESSAGE_SET_MUTE:
598 s->thread_info.soft_muted = PA_PTR_TO_UINT(userdata);
601 case PA_SOURCE_MESSAGE_GET_VOLUME:
602 *((pa_cvolume*) userdata) = s->thread_info.soft_volume;
605 case PA_SOURCE_MESSAGE_GET_MUTE:
606 *((pa_bool_t*) userdata) = s->thread_info.soft_muted;
609 case PA_SOURCE_MESSAGE_PING:
612 case PA_SOURCE_MESSAGE_SET_STATE:
613 s->thread_info.state = PA_PTR_TO_UINT(userdata);
616 case PA_SOURCE_MESSAGE_DETACH:
618 /* We're detaching all our output streams so that the
619 * asyncmsgq and rtpoll fields can be changed without
621 pa_source_detach_within_thread(s);
624 case PA_SOURCE_MESSAGE_ATTACH:
626 /* Reattach all streams */
627 pa_source_attach_within_thread(s);
630 case PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY: {
632 pa_usec_t *usec = userdata;
633 *usec = pa_source_get_requested_latency_within_thread(s);
637 case PA_SOURCE_MESSAGE_GET_LATENCY:
638 case PA_SOURCE_MESSAGE_MAX:
645 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend) {
650 pa_core_assert_ref(c);
652 for (source = PA_SOURCE(pa_idxset_first(c->sources, &idx)); source; source = PA_SOURCE(pa_idxset_next(c->sources, &idx)))
653 ret -= pa_source_suspend(source, suspend) < 0;
658 void pa_source_detach(pa_source *s) {
659 pa_source_assert_ref(s);
660 pa_assert(PA_SOURCE_LINKED(s->state));
662 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_DETACH, NULL, 0, NULL);
665 void pa_source_attach(pa_source *s) {
666 pa_source_assert_ref(s);
667 pa_assert(PA_SOURCE_LINKED(s->state));
669 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_ATTACH, NULL, 0, NULL);
672 void pa_source_detach_within_thread(pa_source *s) {
676 pa_source_assert_ref(s);
677 pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
679 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
684 void pa_source_attach_within_thread(pa_source *s) {
688 pa_source_assert_ref(s);
689 pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
691 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
696 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s) {
697 pa_usec_t result = 0;
701 pa_source_assert_ref(s);
703 if (s->thread_info.requested_latency_valid)
704 return s->thread_info.requested_latency;
706 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
708 if (o->thread_info.requested_source_latency > 0 &&
709 (!result || result > o->thread_info.requested_source_latency))
710 result = o->thread_info.requested_source_latency;
713 if (s->max_latency > 0 && result > s->max_latency)
714 result = s->max_latency;
716 if (s->min_latency > 0 && result < s->min_latency)
717 result = s->min_latency;
720 s->thread_info.requested_latency = result;
721 s->thread_info.requested_latency_valid = TRUE;
726 pa_usec_t pa_source_get_requested_latency(pa_source *s) {
729 pa_source_assert_ref(s);
730 pa_assert(PA_SOURCE_LINKED(s->state));
732 if (!PA_SOURCE_OPENED(s->state))
735 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY, &usec, 0, NULL) < 0)
741 void pa_source_invalidate_requested_latency(pa_source *s) {
743 pa_source_assert_ref(s);
744 pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
746 if (!s->thread_info.requested_latency_valid)
749 s->thread_info.requested_latency_valid = FALSE;
751 if (s->update_requested_latency)
752 s->update_requested_latency(s);