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?> "
68 "sync_volume=<syncronize sw and hw voluchanges in IO-thread?> "
69 "profile_set=<profile set configuration file> ");
71 static const char* const valid_modargs[] = {
88 "tsched_buffer_watermark",
96 #define DEFAULT_DEVICE_ID "0"
108 pa_alsa_profile_set *profile_set;
111 struct profile_data {
112 pa_alsa_profile *profile;
115 static void add_profiles(struct userdata *u, pa_hashmap *h) {
122 PA_HASHMAP_FOREACH(ap, u->profile_set->profiles, state) {
123 struct profile_data *d;
128 cp = pa_card_profile_new(ap->name, ap->description, sizeof(struct profile_data));
129 cp->priority = ap->priority;
131 if (ap->output_mappings) {
132 cp->n_sinks = pa_idxset_size(ap->output_mappings);
134 PA_IDXSET_FOREACH(m, ap->output_mappings, idx)
135 if (m->channel_map.channels > cp->max_sink_channels)
136 cp->max_sink_channels = m->channel_map.channels;
139 if (ap->input_mappings) {
140 cp->n_sources = pa_idxset_size(ap->input_mappings);
142 PA_IDXSET_FOREACH(m, ap->input_mappings, idx)
143 if (m->channel_map.channels > cp->max_source_channels)
144 cp->max_source_channels = m->channel_map.channels;
147 d = PA_CARD_PROFILE_DATA(cp);
150 pa_hashmap_put(h, cp->name, cp);
154 static void add_disabled_profile(pa_hashmap *profiles) {
156 struct profile_data *d;
158 p = pa_card_profile_new("off", _("Off"), sizeof(struct profile_data));
160 d = PA_CARD_PROFILE_DATA(p);
163 pa_hashmap_put(profiles, p->name, p);
166 static int card_set_profile(pa_card *c, pa_card_profile *new_profile) {
168 struct profile_data *nd, *od;
171 pa_queue *sink_inputs = NULL, *source_outputs = NULL;
174 pa_assert(new_profile);
175 pa_assert_se(u = c->userdata);
177 nd = PA_CARD_PROFILE_DATA(new_profile);
178 od = PA_CARD_PROFILE_DATA(c->active_profile);
180 if (od->profile && od->profile->output_mappings)
181 PA_IDXSET_FOREACH(am, od->profile->output_mappings, idx) {
186 nd->profile->output_mappings &&
187 pa_idxset_get_by_data(nd->profile->output_mappings, am, NULL))
190 sink_inputs = pa_sink_move_all_start(am->sink, sink_inputs);
191 pa_alsa_sink_free(am->sink);
195 if (od->profile && od->profile->input_mappings)
196 PA_IDXSET_FOREACH(am, od->profile->input_mappings, idx) {
201 nd->profile->input_mappings &&
202 pa_idxset_get_by_data(nd->profile->input_mappings, am, NULL))
205 source_outputs = pa_source_move_all_start(am->source, source_outputs);
206 pa_alsa_source_free(am->source);
210 if (nd->profile && nd->profile->output_mappings)
211 PA_IDXSET_FOREACH(am, nd->profile->output_mappings, idx) {
214 am->sink = pa_alsa_sink_new(c->module, u->modargs, __FILE__, c, am);
216 if (sink_inputs && am->sink) {
217 pa_sink_move_all_finish(am->sink, sink_inputs, FALSE);
222 if (nd->profile && nd->profile->input_mappings)
223 PA_IDXSET_FOREACH(am, nd->profile->input_mappings, idx) {
226 am->source = pa_alsa_source_new(c->module, u->modargs, __FILE__, c, am);
228 if (source_outputs && am->source) {
229 pa_source_move_all_finish(am->source, source_outputs, FALSE);
230 source_outputs = NULL;
235 pa_sink_move_all_fail(sink_inputs);
238 pa_source_move_all_fail(source_outputs);
243 static void init_profile(struct userdata *u) {
246 struct profile_data *d;
250 d = PA_CARD_PROFILE_DATA(u->card->active_profile);
252 if (d->profile && d->profile->output_mappings)
253 PA_IDXSET_FOREACH(am, d->profile->output_mappings, idx)
254 am->sink = pa_alsa_sink_new(u->module, u->modargs, __FILE__, u->card, am);
256 if (d->profile && d->profile->input_mappings)
257 PA_IDXSET_FOREACH(am, d->profile->input_mappings, idx)
258 am->source = pa_alsa_source_new(u->module, u->modargs, __FILE__, u->card, am);
261 static void set_card_name(pa_card_new_data *data, pa_modargs *ma, const char *device_id) {
267 pa_assert(device_id);
269 if ((n = pa_modargs_get_value(ma, "card_name", NULL))) {
270 pa_card_new_data_set_name(data, n);
271 data->namereg_fail = TRUE;
275 if ((n = pa_modargs_get_value(ma, "name", NULL)))
276 data->namereg_fail = TRUE;
279 data->namereg_fail = FALSE;
282 t = pa_sprintf_malloc("alsa_card.%s", n);
283 pa_card_new_data_set_name(data, t);
287 int pa__init(pa_module *m) {
288 pa_card_new_data data;
292 pa_reserve_wrapper *reserve = NULL;
293 const char *description;
295 pa_bool_t namereg_fail = FALSE;
297 pa_alsa_refcnt_inc();
301 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
302 pa_log("Failed to parse module arguments");
306 m->userdata = u = pa_xnew0(struct userdata, 1);
309 u->device_id = pa_xstrdup(pa_modargs_get_value(ma, "device_id", DEFAULT_DEVICE_ID));
312 if ((alsa_card_index = snd_card_get_index(u->device_id)) < 0) {
313 pa_log("Card '%s' doesn't exist: %s", u->device_id, pa_alsa_strerror(alsa_card_index));
317 if (!pa_in_system_mode()) {
320 if ((rname = pa_alsa_get_reserve_name(u->device_id))) {
321 reserve = pa_reserve_wrapper_get(m->core, rname);
330 fn = pa_udev_get_property(alsa_card_index, "PULSE_PROFILE_SET");
333 if (pa_modargs_get_value(ma, "profile_set", NULL)) {
335 fn = pa_xstrdup(pa_modargs_get_value(ma, "profile_set", NULL));
338 u->profile_set = pa_alsa_profile_set_new(fn, &u->core->default_channel_map);
344 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);
345 pa_alsa_profile_set_dump(u->profile_set);
347 pa_card_new_data_init(&data);
348 data.driver = __FILE__;
351 pa_alsa_init_proplist_card(m->core, data.proplist, alsa_card_index);
353 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, u->device_id);
354 pa_alsa_init_description(data.proplist);
355 set_card_name(&data, ma, u->device_id);
357 /* We need to give pa_modargs_get_value_boolean() a pointer to a local
358 * variable instead of using &data.namereg_fail directly, because
359 * data.namereg_fail is a bitfield and taking the address of a bitfield
360 * variable is impossible. */
361 namereg_fail = data.namereg_fail;
362 if (pa_modargs_get_value_boolean(ma, "namereg_fail", &namereg_fail) < 0) {
363 pa_log("Failed to parse boolean argument namereg_fail.");
364 pa_card_new_data_done(&data);
367 data.namereg_fail = namereg_fail;
370 if ((description = pa_proplist_gets(data.proplist, PA_PROP_DEVICE_DESCRIPTION)))
371 pa_reserve_wrapper_set_application_device_name(reserve, description);
373 data.profiles = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
374 add_profiles(u, data.profiles);
376 if (pa_hashmap_isempty(data.profiles)) {
377 pa_log("Failed to find a working profile.");
378 pa_card_new_data_done(&data);
382 add_disabled_profile(data.profiles);
384 if (pa_modargs_get_proplist(ma, "card_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
385 pa_log("Invalid properties");
386 pa_card_new_data_done(&data);
390 u->card = pa_card_new(m->core, &data);
391 pa_card_new_data_done(&data);
396 u->card->userdata = u;
397 u->card->set_profile = card_set_profile;
402 pa_reserve_wrapper_unref(reserve);
404 if (!pa_hashmap_isempty(u->profile_set->decibel_fixes))
405 pa_log_warn("Card %s uses decibel fixes (i.e. overrides the decibel information for some alsa volume elements). "
406 "Please note that this feature is meant just as a help for figuring out the correct decibel values. "
407 "Pulseaudio is not the correct place to maintain the decibel mappings! The fixed decibel values "
408 "should be sent to ALSA developers so that they can fix the driver. If it turns out that this feature "
409 "is abused (i.e. fixes are not pushed to ALSA), the decibel fix feature may be removed in some future "
410 "Pulseaudio version.", u->card->name);
416 pa_reserve_wrapper_unref(reserve);
423 int pa__get_n_used(pa_module *m) {
431 pa_assert_se(u = m->userdata);
434 PA_IDXSET_FOREACH(sink, u->card->sinks, idx)
435 n += pa_sink_linked_by(sink);
437 PA_IDXSET_FOREACH(source, u->card->sources, idx)
438 n += pa_source_linked_by(source);
443 void pa__done(pa_module*m) {
448 if (!(u = m->userdata))
451 if (u->card && u->card->sinks) {
454 while ((s = pa_idxset_steal_first(u->card->sinks, NULL)))
455 pa_alsa_sink_free(s);
458 if (u->card && u->card->sources) {
461 while ((s = pa_idxset_steal_first(u->card->sources, NULL)))
462 pa_alsa_source_free(s);
466 pa_card_free(u->card);
469 pa_modargs_free(u->modargs);
472 pa_alsa_profile_set_free(u->profile_set);
474 pa_xfree(u->device_id);
478 pa_alsa_refcnt_dec();