2 This file is part of PulseAudio.
4 Copyright 2009 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
26 #include <pulse/xmalloc.h>
27 #include <pulse/i18n.h>
29 #include <pulsecore/core-util.h>
30 #include <pulsecore/modargs.h>
31 #include <pulsecore/queue.h>
33 #include <modules/reserve-wrap.h>
36 #include <modules/udev-util.h>
39 #include "alsa-util.h"
40 #include "alsa-sink.h"
41 #include "alsa-source.h"
42 #include "module-alsa-card-symdef.h"
44 PA_MODULE_AUTHOR("Lennart Poettering");
45 PA_MODULE_DESCRIPTION("ALSA Card");
46 PA_MODULE_VERSION(PACKAGE_VERSION);
47 PA_MODULE_LOAD_ONCE(FALSE);
49 "name=<name for the card/sink/source, to be prefixed> "
50 "card_name=<name for the card> "
51 "card_properties=<properties for the card> "
52 "sink_name=<name for the sink> "
53 "sink_properties=<properties for the sink> "
54 "source_name=<name for the source> "
55 "source_properties=<properties for the source> "
56 "namereg_fail=<pa_namereg_register() fail parameter value> "
57 "device_id=<ALSA card index> "
58 "format=<sample format> "
60 "fragments=<number of fragments> "
61 "fragment_size=<fragment size> "
62 "mmap=<enable memory mapping?> "
63 "tsched=<enable system timer based scheduling mode?> "
64 "tsched_buffer_size=<buffer size when using timer based scheduling> "
65 "tsched_buffer_watermark=<lower fill watermark> "
66 "profile=<profile name> "
67 "ignore_dB=<ignore dB information from the device?>");
69 static const char* const valid_modargs[] = {
86 "tsched_buffer_watermark",
92 #define DEFAULT_DEVICE_ID "0"
104 pa_alsa_profile_set *profile_set;
107 struct profile_data {
108 pa_alsa_profile *profile;
111 static void add_profiles(struct userdata *u, pa_hashmap *h) {
118 PA_HASHMAP_FOREACH(ap, u->profile_set->profiles, state) {
119 struct profile_data *d;
124 cp = pa_card_profile_new(ap->name, ap->description, sizeof(struct profile_data));
125 cp->priority = ap->priority;
127 if (ap->output_mappings) {
128 cp->n_sinks = pa_idxset_size(ap->output_mappings);
130 PA_IDXSET_FOREACH(m, ap->output_mappings, idx)
131 if (m->channel_map.channels > cp->max_sink_channels)
132 cp->max_sink_channels = m->channel_map.channels;
135 if (ap->input_mappings) {
136 cp->n_sources = pa_idxset_size(ap->input_mappings);
138 PA_IDXSET_FOREACH(m, ap->input_mappings, idx)
139 if (m->channel_map.channels > cp->max_source_channels)
140 cp->max_source_channels = m->channel_map.channels;
143 d = PA_CARD_PROFILE_DATA(cp);
146 pa_hashmap_put(h, cp->name, cp);
150 static void add_disabled_profile(pa_hashmap *profiles) {
152 struct profile_data *d;
154 p = pa_card_profile_new("off", _("Off"), sizeof(struct profile_data));
156 d = PA_CARD_PROFILE_DATA(p);
159 pa_hashmap_put(profiles, p->name, p);
162 static int card_set_profile(pa_card *c, pa_card_profile *new_profile) {
164 struct profile_data *nd, *od;
167 pa_queue *sink_inputs = NULL, *source_outputs = NULL;
170 pa_assert(new_profile);
171 pa_assert_se(u = c->userdata);
173 nd = PA_CARD_PROFILE_DATA(new_profile);
174 od = PA_CARD_PROFILE_DATA(c->active_profile);
176 if (od->profile && od->profile->output_mappings)
177 PA_IDXSET_FOREACH(am, od->profile->output_mappings, idx) {
182 nd->profile->output_mappings &&
183 pa_idxset_get_by_data(nd->profile->output_mappings, am, NULL))
186 sink_inputs = pa_sink_move_all_start(am->sink, sink_inputs);
187 pa_alsa_sink_free(am->sink);
191 if (od->profile && od->profile->input_mappings)
192 PA_IDXSET_FOREACH(am, od->profile->input_mappings, idx) {
197 nd->profile->input_mappings &&
198 pa_idxset_get_by_data(nd->profile->input_mappings, am, NULL))
201 source_outputs = pa_source_move_all_start(am->source, source_outputs);
202 pa_alsa_source_free(am->source);
206 if (nd->profile && nd->profile->output_mappings)
207 PA_IDXSET_FOREACH(am, nd->profile->output_mappings, idx) {
210 am->sink = pa_alsa_sink_new(c->module, u->modargs, __FILE__, c, am);
212 if (sink_inputs && am->sink) {
213 pa_sink_move_all_finish(am->sink, sink_inputs, FALSE);
218 if (nd->profile && nd->profile->input_mappings)
219 PA_IDXSET_FOREACH(am, nd->profile->input_mappings, idx) {
222 am->source = pa_alsa_source_new(c->module, u->modargs, __FILE__, c, am);
224 if (source_outputs && am->source) {
225 pa_source_move_all_finish(am->source, source_outputs, FALSE);
226 source_outputs = NULL;
231 pa_sink_move_all_fail(sink_inputs);
234 pa_source_move_all_fail(source_outputs);
239 static void init_profile(struct userdata *u) {
242 struct profile_data *d;
246 d = PA_CARD_PROFILE_DATA(u->card->active_profile);
248 if (d->profile && d->profile->output_mappings)
249 PA_IDXSET_FOREACH(am, d->profile->output_mappings, idx)
250 am->sink = pa_alsa_sink_new(u->module, u->modargs, __FILE__, u->card, am);
252 if (d->profile && d->profile->input_mappings)
253 PA_IDXSET_FOREACH(am, d->profile->input_mappings, idx)
254 am->source = pa_alsa_source_new(u->module, u->modargs, __FILE__, u->card, am);
257 static void set_card_name(pa_card_new_data *data, pa_modargs *ma, const char *device_id) {
263 pa_assert(device_id);
265 if ((n = pa_modargs_get_value(ma, "card_name", NULL))) {
266 pa_card_new_data_set_name(data, n);
267 data->namereg_fail = TRUE;
271 if ((n = pa_modargs_get_value(ma, "name", NULL)))
272 data->namereg_fail = TRUE;
275 data->namereg_fail = FALSE;
278 t = pa_sprintf_malloc("alsa_card.%s", n);
279 pa_card_new_data_set_name(data, t);
283 int pa__init(pa_module *m) {
284 pa_card_new_data data;
288 pa_reserve_wrapper *reserve = NULL;
289 const char *description;
291 pa_bool_t namereg_fail = FALSE;
293 pa_alsa_refcnt_inc();
297 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
298 pa_log("Failed to parse module arguments");
302 m->userdata = u = pa_xnew0(struct userdata, 1);
305 u->device_id = pa_xstrdup(pa_modargs_get_value(ma, "device_id", DEFAULT_DEVICE_ID));
308 if ((alsa_card_index = snd_card_get_index(u->device_id)) < 0) {
309 pa_log("Card '%s' doesn't exist: %s", u->device_id, pa_alsa_strerror(alsa_card_index));
313 if (!pa_in_system_mode()) {
316 if ((rname = pa_alsa_get_reserve_name(u->device_id))) {
317 reserve = pa_reserve_wrapper_get(m->core, rname);
326 fn = pa_udev_get_property(alsa_card_index, "PULSE_PROFILE_SET");
329 u->profile_set = pa_alsa_profile_set_new(fn, &u->core->default_channel_map);
335 pa_alsa_profile_set_probe(u->profile_set, u->device_id, &m->core->default_sample_spec, m->core->default_n_fragments, m->core->default_fragment_size_msec);
337 pa_card_new_data_init(&data);
338 data.driver = __FILE__;
341 pa_alsa_init_proplist_card(m->core, data.proplist, alsa_card_index);
343 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, u->device_id);
344 pa_alsa_init_description(data.proplist);
345 set_card_name(&data, ma, u->device_id);
347 /* We need to give pa_modargs_get_value_boolean() a pointer to a local
348 * variable instead of using &data.namereg_fail directly, because
349 * data.namereg_fail is a bitfield and taking the address of a bitfield
350 * variable is impossible. */
351 namereg_fail = data.namereg_fail;
352 if (pa_modargs_get_value_boolean(ma, "namereg_fail", &namereg_fail) < 0) {
353 pa_log("Failed to parse boolean argument namereg_fail.");
354 pa_card_new_data_done(&data);
357 data.namereg_fail = namereg_fail;
360 if ((description = pa_proplist_gets(data.proplist, PA_PROP_DEVICE_DESCRIPTION)))
361 pa_reserve_wrapper_set_application_device_name(reserve, description);
363 data.profiles = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
364 add_profiles(u, data.profiles);
366 if (pa_hashmap_isempty(data.profiles)) {
367 pa_log("Failed to find a working profile.");
368 pa_card_new_data_done(&data);
372 add_disabled_profile(data.profiles);
374 if (pa_modargs_get_proplist(ma, "card_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
375 pa_log("Invalid properties");
376 pa_card_new_data_done(&data);
380 u->card = pa_card_new(m->core, &data);
381 pa_card_new_data_done(&data);
386 u->card->userdata = u;
387 u->card->set_profile = card_set_profile;
392 pa_reserve_wrapper_unref(reserve);
398 pa_reserve_wrapper_unref(reserve);
405 int pa__get_n_used(pa_module *m) {
413 pa_assert_se(u = m->userdata);
416 PA_IDXSET_FOREACH(sink, u->card->sinks, idx)
417 n += pa_sink_linked_by(sink);
419 PA_IDXSET_FOREACH(source, u->card->sources, idx)
420 n += pa_source_linked_by(source);
425 void pa__done(pa_module*m) {
430 if (!(u = m->userdata))
433 if (u->card && u->card->sinks) {
436 while ((s = pa_idxset_steal_first(u->card->sinks, NULL)))
437 pa_alsa_sink_free(s);
440 if (u->card && u->card->sources) {
443 while ((s = pa_idxset_steal_first(u->card->sources, NULL)))
444 pa_alsa_source_free(s);
448 pa_card_free(u->card);
451 pa_modargs_free(u->modargs);
454 pa_alsa_profile_set_free(u->profile_set);
456 pa_xfree(u->device_id);
460 pa_alsa_refcnt_dec();