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>
36 #include <pulsecore/source-output.h>
37 #include <pulsecore/namereg.h>
38 #include <pulsecore/core-subscribe.h>
39 #include <pulsecore/log.h>
40 #include <pulsecore/sample-util.h>
44 static PA_DEFINE_CHECK_TYPE(pa_source, pa_msgobject);
46 static void source_free(pa_object *o);
48 pa_source* pa_source_new(
53 const pa_sample_spec *spec,
54 const pa_channel_map *map) {
64 pa_return_null_if_fail(pa_sample_spec_valid(spec));
67 pa_return_null_if_fail(map = pa_channel_map_init_auto(&tmap, spec->channels, PA_CHANNEL_MAP_DEFAULT));
69 pa_return_null_if_fail(map && pa_channel_map_valid(map));
70 pa_return_null_if_fail(map->channels == spec->channels);
71 pa_return_null_if_fail(!driver || pa_utf8_valid(driver));
72 pa_return_null_if_fail(pa_utf8_valid(name) && *name);
74 s = pa_msgobject_new(pa_source);
76 if (!(name = pa_namereg_register(core, name, PA_NAMEREG_SOURCE, s, fail))) {
81 s->parent.parent.free = source_free;
82 s->parent.process_msg = pa_source_process_msg;
85 s->state = PA_SOURCE_INIT;
87 s->name = pa_xstrdup(name);
88 s->description = NULL;
89 s->driver = pa_xstrdup(driver);
92 s->sample_spec = *spec;
93 s->channel_map = *map;
95 s->outputs = pa_idxset_new(NULL, NULL);
99 pa_cvolume_reset(&s->volume, spec->channels);
101 s->refresh_volume = s->refresh_muted = FALSE;
103 s->get_latency = NULL;
104 s->set_volume = NULL;
105 s->get_volume = NULL;
114 pa_assert_se(pa_idxset_put(core->sources, s, &s->index) >= 0);
116 pa_sample_spec_snprint(st, sizeof(st), spec);
117 pa_log_info("Created source %u \"%s\" with sample spec \"%s\"", s->index, s->name, st);
119 s->thread_info.outputs = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
120 s->thread_info.soft_volume = s->volume;
121 s->thread_info.soft_muted = s->muted;
122 s->thread_info.state = s->state;
127 static int source_set_state(pa_source *s, pa_source_state_t state) {
129 pa_bool_t suspend_change;
133 if (s->state == state)
137 (s->state == PA_SOURCE_SUSPENDED && PA_SOURCE_OPENED(state)) ||
138 (PA_SOURCE_OPENED(s->state) && state == PA_SOURCE_SUSPENDED);
141 if ((ret = s->set_state(s, state)) < 0)
144 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_STATE, PA_UINT_TO_PTR(state), 0, NULL) < 0)
149 if (suspend_change) {
153 /* We're suspending or resuming, tell everyone about it */
155 for (o = PA_SOURCE_OUTPUT(pa_idxset_first(s->outputs, &idx)); o; o = PA_SOURCE_OUTPUT(pa_idxset_next(s->outputs, &idx)))
157 o->suspend(o, state == PA_SINK_SUSPENDED);
160 if (state != PA_SOURCE_UNLINKED) /* if we enter UNLINKED state pa_source_unlink() will fire the apropriate events */
161 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_STATE_CHANGED], s);
166 void pa_source_put(pa_source *s) {
167 pa_source_assert_ref(s);
169 pa_assert(s->state == PA_SINK_INIT);
170 pa_assert(s->rtpoll);
171 pa_assert(s->asyncmsgq);
173 pa_assert_se(source_set_state(s, PA_SOURCE_IDLE) == 0);
175 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_NEW, s->index);
176 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_NEW_POST], s);
179 void pa_source_unlink(pa_source *s) {
181 pa_source_output *o, *j = NULL;
185 /* See pa_sink_unlink() for a couple of comments how this function
188 linked = PA_SOURCE_LINKED(s->state);
191 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK], s);
193 if (s->state != PA_SOURCE_UNLINKED)
194 pa_namereg_unregister(s->core, s->name);
195 pa_idxset_remove_by_data(s->core->sources, s, NULL);
197 while ((o = pa_idxset_first(s->outputs, NULL))) {
199 pa_source_output_kill(o);
204 source_set_state(s, PA_SOURCE_UNLINKED);
206 s->state = PA_SOURCE_UNLINKED;
208 s->get_latency = NULL;
209 s->get_volume = NULL;
210 s->set_volume = NULL;
216 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE | PA_SUBSCRIPTION_EVENT_REMOVE, s->index);
217 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK_POST], s);
221 static void source_free(pa_object *o) {
222 pa_source_output *so;
223 pa_source *s = PA_SOURCE(o);
226 pa_assert(pa_source_refcnt(s) == 0);
228 if (PA_SOURCE_LINKED(s->state))
231 pa_log_info("Freeing source %u \"%s\"", s->index, s->name);
233 pa_idxset_free(s->outputs, NULL, NULL);
235 while ((so = pa_hashmap_steal_first(s->thread_info.outputs)))
236 pa_source_output_unref(so);
238 pa_hashmap_free(s->thread_info.outputs, NULL, NULL);
241 pa_xfree(s->description);
246 int pa_source_update_status(pa_source*s) {
247 pa_source_assert_ref(s);
248 pa_assert(PA_SOURCE_LINKED(s->state));
250 if (s->state == PA_SOURCE_SUSPENDED)
253 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
256 int pa_source_suspend(pa_source *s, pa_bool_t suspend) {
257 pa_source_assert_ref(s);
258 pa_assert(PA_SOURCE_LINKED(s->state));
261 return source_set_state(s, PA_SOURCE_SUSPENDED);
263 return source_set_state(s, pa_source_used_by(s) ? PA_SOURCE_RUNNING : PA_SOURCE_IDLE);
266 void pa_source_ping(pa_source *s) {
267 pa_source_assert_ref(s);
268 pa_assert(PA_SOURCE_LINKED(s->state));
270 pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_PING, NULL, 0, NULL, NULL);
273 void pa_source_post(pa_source*s, const pa_memchunk *chunk) {
277 pa_source_assert_ref(s);
278 pa_assert(PA_SOURCE_OPENED(s->thread_info.state));
281 if (s->thread_info.state != PA_SOURCE_RUNNING)
284 if (s->thread_info.soft_muted || !pa_cvolume_is_norm(&s->thread_info.soft_volume)) {
285 pa_memchunk vchunk = *chunk;
287 pa_memblock_ref(vchunk.memblock);
288 pa_memchunk_make_writable(&vchunk, 0);
290 if (s->thread_info.soft_muted || pa_cvolume_is_muted(&s->thread_info.soft_volume))
291 pa_silence_memchunk(&vchunk, &s->sample_spec);
293 pa_volume_memchunk(&vchunk, &s->sample_spec, &s->thread_info.soft_volume);
295 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
296 pa_source_output_push(o, &vchunk);
298 pa_memblock_unref(vchunk.memblock);
301 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
302 pa_source_output_push(o, chunk);
306 pa_usec_t pa_source_get_latency(pa_source *s) {
309 pa_source_assert_ref(s);
310 pa_assert(PA_SOURCE_LINKED(s->state));
312 if (!PA_SOURCE_OPENED(s->state))
316 return s->get_latency(s);
318 if (pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_LATENCY, &usec, 0, NULL) < 0)
324 void pa_source_set_volume(pa_source *s, const pa_cvolume *volume) {
327 pa_source_assert_ref(s);
328 pa_assert(PA_SOURCE_LINKED(s->state));
331 changed = !pa_cvolume_equal(volume, &s->volume);
334 if (s->set_volume && s->set_volume(s) < 0)
335 s->set_volume = NULL;
338 pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_VOLUME, pa_xnewdup(struct pa_cvolume, volume, 1), 0, NULL, pa_xfree);
341 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
344 const pa_cvolume *pa_source_get_volume(pa_source *s) {
345 pa_cvolume old_volume;
347 pa_source_assert_ref(s);
348 pa_assert(PA_SOURCE_LINKED(s->state));
350 old_volume = s->volume;
352 if (s->get_volume && s->get_volume(s) < 0)
353 s->get_volume = NULL;
355 if (!s->get_volume && s->refresh_volume)
356 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_VOLUME, &s->volume, 0, NULL);
358 if (!pa_cvolume_equal(&old_volume, &s->volume))
359 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
364 void pa_source_set_mute(pa_source *s, pa_bool_t mute) {
367 pa_source_assert_ref(s);
368 pa_assert(PA_SOURCE_LINKED(s->state));
370 changed = s->muted != mute;
373 if (s->set_mute && s->set_mute(s) < 0)
377 pa_asyncmsgq_post(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_SET_MUTE, PA_UINT_TO_PTR(mute), 0, NULL, NULL);
380 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
383 pa_bool_t pa_source_get_mute(pa_source *s) {
386 pa_source_assert_ref(s);
387 pa_assert(PA_SOURCE_LINKED(s->state));
389 old_muted = s->muted;
391 if (s->get_mute && s->get_mute(s) < 0)
394 if (!s->get_mute && s->refresh_muted)
395 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_GET_MUTE, &s->muted, 0, NULL);
397 if (old_muted != s->muted)
398 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
403 void pa_source_set_module(pa_source *s, pa_module *m) {
404 pa_source_assert_ref(s);
411 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
414 void pa_source_set_description(pa_source *s, const char *description) {
415 pa_source_assert_ref(s);
417 if (!description && !s->description)
420 if (description && s->description && !strcmp(description, s->description))
423 pa_xfree(s->description);
424 s->description = pa_xstrdup(description);
426 if (PA_SOURCE_LINKED(s->state)) {
427 pa_hook_fire(&s->core->hooks[PA_CORE_HOOK_SOURCE_DESCRIPTION_CHANGED], s);
428 pa_subscription_post(s->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE, s->index);
432 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q) {
433 pa_source_assert_ref(s);
439 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p) {
440 pa_source_assert_ref(s);
446 unsigned pa_source_linked_by(pa_source *s) {
447 pa_source_assert_ref(s);
448 pa_assert(PA_SOURCE_LINKED(s->state));
450 return pa_idxset_size(s->outputs);
453 unsigned pa_source_used_by(pa_source *s) {
456 pa_source_assert_ref(s);
457 pa_assert(PA_SOURCE_LINKED(s->state));
459 ret = pa_idxset_size(s->outputs);
460 pa_assert(ret >= s->n_corked);
462 return ret - s->n_corked;
465 int pa_source_process_msg(pa_msgobject *object, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
466 pa_source *s = PA_SOURCE(object);
467 pa_source_assert_ref(s);
468 pa_assert(s->thread_info.state != PA_SOURCE_UNLINKED);
470 switch ((pa_source_message_t) code) {
471 case PA_SOURCE_MESSAGE_ADD_OUTPUT: {
472 pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
473 pa_hashmap_put(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index), pa_source_output_ref(o));
475 pa_assert(!o->thread_info.attached);
476 o->thread_info.attached = TRUE;
484 case PA_SOURCE_MESSAGE_REMOVE_OUTPUT: {
485 pa_source_output *o = PA_SOURCE_OUTPUT(userdata);
490 pa_assert(o->thread_info.attached);
491 o->thread_info.attached = FALSE;
493 if (pa_hashmap_remove(s->thread_info.outputs, PA_UINT32_TO_PTR(o->index)))
494 pa_source_output_unref(o);
499 case PA_SOURCE_MESSAGE_SET_VOLUME:
500 s->thread_info.soft_volume = *((pa_cvolume*) userdata);
503 case PA_SOURCE_MESSAGE_SET_MUTE:
504 s->thread_info.soft_muted = PA_PTR_TO_UINT(userdata);
507 case PA_SOURCE_MESSAGE_GET_VOLUME:
508 *((pa_cvolume*) userdata) = s->thread_info.soft_volume;
511 case PA_SOURCE_MESSAGE_GET_MUTE:
512 *((pa_bool_t*) userdata) = s->thread_info.soft_muted;
515 case PA_SOURCE_MESSAGE_PING:
518 case PA_SOURCE_MESSAGE_SET_STATE:
519 s->thread_info.state = PA_PTR_TO_UINT(userdata);
522 case PA_SOURCE_MESSAGE_DETACH:
524 /* We're detaching all our output streams so that the
525 * asyncmsgq and rtpoll fields can be changed without
527 pa_source_detach_within_thread(s);
530 case PA_SOURCE_MESSAGE_ATTACH:
532 /* Reattach all streams */
533 pa_source_attach_within_thread(s);
536 case PA_SOURCE_MESSAGE_GET_LATENCY:
537 case PA_SOURCE_MESSAGE_MAX:
544 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend) {
549 pa_core_assert_ref(c);
551 for (source = PA_SOURCE(pa_idxset_first(c->sources, &idx)); source; source = PA_SOURCE(pa_idxset_next(c->sources, &idx)))
552 ret -= pa_source_suspend(source, suspend) < 0;
557 void pa_source_detach(pa_source *s) {
558 pa_source_assert_ref(s);
559 pa_assert(PA_SOURCE_LINKED(s->state));
561 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_DETACH, NULL, 0, NULL);
564 void pa_source_attach(pa_source *s) {
565 pa_source_assert_ref(s);
566 pa_assert(PA_SOURCE_LINKED(s->state));
568 pa_asyncmsgq_send(s->asyncmsgq, PA_MSGOBJECT(s), PA_SOURCE_MESSAGE_ATTACH, NULL, 0, NULL);
571 void pa_source_detach_within_thread(pa_source *s) {
575 pa_source_assert_ref(s);
576 pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
578 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))
583 void pa_source_attach_within_thread(pa_source *s) {
587 pa_source_assert_ref(s);
588 pa_assert(PA_SOURCE_LINKED(s->thread_info.state));
590 while ((o = pa_hashmap_iterate(s->thread_info.outputs, &state, NULL)))