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>
28 #include <pulsecore/core-util.h>
29 #include <pulsecore/i18n.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=<when false attempt to synthesise new names if they are already taken> "
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 "fixed_latency_range=<disable latency range changes on underrun?> "
68 "ignore_dB=<ignore dB information from the device?> "
69 "deferred_volume=<Synchronize software and hardware volume changes to avoid momentary jumps?> "
70 "profile_set=<profile set configuration file> "
71 "paths_dir=<directory containing the path configuration files> "
74 static const char* const valid_modargs[] = {
91 "tsched_buffer_watermark",
92 "fixed_latency_range",
101 #define DEFAULT_DEVICE_ID "0"
110 snd_mixer_t *mixer_handle;
111 snd_hctl_t *hctl_handle;
113 pa_alsa_fdlist *mixer_fdl;
119 pa_alsa_profile_set *profile_set;
122 struct profile_data {
123 pa_alsa_profile *profile;
126 static void add_profiles(struct userdata *u, pa_hashmap *h, pa_hashmap *ports) {
133 PA_HASHMAP_FOREACH(ap, u->profile_set->profiles, state) {
134 struct profile_data *d;
139 cp = pa_card_profile_new(ap->name, ap->description, sizeof(struct profile_data));
140 cp->priority = ap->priority;
142 if (ap->output_mappings) {
143 cp->n_sinks = pa_idxset_size(ap->output_mappings);
145 PA_IDXSET_FOREACH(m, ap->output_mappings, idx) {
146 pa_alsa_path_set_add_ports(m->output_path_set, cp, ports, NULL, u->core);
147 if (m->channel_map.channels > cp->max_sink_channels)
148 cp->max_sink_channels = m->channel_map.channels;
152 if (ap->input_mappings) {
153 cp->n_sources = pa_idxset_size(ap->input_mappings);
155 PA_IDXSET_FOREACH(m, ap->input_mappings, idx) {
156 pa_alsa_path_set_add_ports(m->input_path_set, cp, ports, NULL, u->core);
157 if (m->channel_map.channels > cp->max_source_channels)
158 cp->max_source_channels = m->channel_map.channels;
162 d = PA_CARD_PROFILE_DATA(cp);
165 pa_hashmap_put(h, cp->name, cp);
169 static void add_disabled_profile(pa_hashmap *profiles) {
171 struct profile_data *d;
173 p = pa_card_profile_new("off", _("Off"), sizeof(struct profile_data));
175 d = PA_CARD_PROFILE_DATA(p);
178 pa_hashmap_put(profiles, p->name, p);
181 static int card_set_profile(pa_card *c, pa_card_profile *new_profile) {
183 struct profile_data *nd, *od;
186 pa_queue *sink_inputs = NULL, *source_outputs = NULL;
189 pa_assert(new_profile);
190 pa_assert_se(u = c->userdata);
192 nd = PA_CARD_PROFILE_DATA(new_profile);
193 od = PA_CARD_PROFILE_DATA(c->active_profile);
195 if (od->profile && od->profile->output_mappings)
196 PA_IDXSET_FOREACH(am, od->profile->output_mappings, idx) {
201 nd->profile->output_mappings &&
202 pa_idxset_get_by_data(nd->profile->output_mappings, am, NULL))
205 sink_inputs = pa_sink_move_all_start(am->sink, sink_inputs);
206 pa_alsa_sink_free(am->sink);
210 if (od->profile && od->profile->input_mappings)
211 PA_IDXSET_FOREACH(am, od->profile->input_mappings, idx) {
216 nd->profile->input_mappings &&
217 pa_idxset_get_by_data(nd->profile->input_mappings, am, NULL))
220 source_outputs = pa_source_move_all_start(am->source, source_outputs);
221 pa_alsa_source_free(am->source);
225 if (nd->profile && nd->profile->output_mappings)
226 PA_IDXSET_FOREACH(am, nd->profile->output_mappings, idx) {
229 am->sink = pa_alsa_sink_new(c->module, u->modargs, __FILE__, c, am);
231 if (sink_inputs && am->sink) {
232 pa_sink_move_all_finish(am->sink, sink_inputs, FALSE);
237 if (nd->profile && nd->profile->input_mappings)
238 PA_IDXSET_FOREACH(am, nd->profile->input_mappings, idx) {
241 am->source = pa_alsa_source_new(c->module, u->modargs, __FILE__, c, am);
243 if (source_outputs && am->source) {
244 pa_source_move_all_finish(am->source, source_outputs, FALSE);
245 source_outputs = NULL;
250 pa_sink_move_all_fail(sink_inputs);
253 pa_source_move_all_fail(source_outputs);
258 static void init_profile(struct userdata *u) {
261 struct profile_data *d;
265 d = PA_CARD_PROFILE_DATA(u->card->active_profile);
267 if (d->profile && d->profile->output_mappings)
268 PA_IDXSET_FOREACH(am, d->profile->output_mappings, idx)
269 am->sink = pa_alsa_sink_new(u->module, u->modargs, __FILE__, u->card, am);
271 if (d->profile && d->profile->input_mappings)
272 PA_IDXSET_FOREACH(am, d->profile->input_mappings, idx)
273 am->source = pa_alsa_source_new(u->module, u->modargs, __FILE__, u->card, am);
276 static void report_port_state(pa_device_port *p, struct userdata *u)
280 pa_port_available_t pa = PA_PORT_AVAILABLE_UNKNOWN;
282 PA_HASHMAP_FOREACH(jack, u->jacks, state) {
283 pa_port_available_t cpa;
288 if (p != jack->path->port)
291 cpa = jack->plugged_in ? jack->state_plugged : jack->state_unplugged;
293 /* "Yes" and "no" trumphs "unknown" if we have more than one jack */
294 if (cpa == PA_PORT_AVAILABLE_UNKNOWN)
297 if ((cpa == PA_PORT_AVAILABLE_NO && pa == PA_PORT_AVAILABLE_YES) ||
298 (pa == PA_PORT_AVAILABLE_NO && cpa == PA_PORT_AVAILABLE_YES))
299 pa_log_warn("Availability of port '%s' is inconsistent!", p->name);
304 pa_device_port_set_available(p, pa);
307 static int report_jack_state(snd_hctl_elem_t *elem, unsigned int mask)
309 struct userdata *u = snd_hctl_elem_get_callback_private(elem);
310 snd_ctl_elem_value_t *elem_value;
311 pa_bool_t plugged_in;
317 if (mask == SND_CTL_EVENT_MASK_REMOVE)
320 snd_ctl_elem_value_alloca(&elem_value);
321 if (snd_hctl_elem_read(elem, elem_value) < 0) {
322 pa_log_warn("Failed to read jack detection from '%s'", pa_strnull(snd_hctl_elem_get_name(elem)));
326 plugged_in = !!snd_ctl_elem_value_get_boolean(elem_value, 0);
328 pa_log_debug("Jack '%s' is now %s", pa_strnull(snd_hctl_elem_get_name(elem)), plugged_in ? "plugged in" : "unplugged");
330 PA_HASHMAP_FOREACH(jack, u->jacks, state)
331 if (jack->hctl_elem == elem) {
332 jack->plugged_in = plugged_in;
333 pa_assert(jack->path && jack->path->port);
334 report_port_state(jack->path->port, u);
339 static void init_jacks(struct userdata *u) {
344 u->jacks = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
346 /* See if we have any jacks */
347 if (u->profile_set->output_paths)
348 PA_HASHMAP_FOREACH(path, u->profile_set->output_paths, state)
349 PA_LLIST_FOREACH(jack, path->jacks)
350 if (jack->has_control)
351 pa_hashmap_put(u->jacks, jack, jack);
353 if (u->profile_set->input_paths)
354 PA_HASHMAP_FOREACH(path, u->profile_set->input_paths, state)
355 PA_LLIST_FOREACH(jack, path->jacks)
356 if (jack->has_control)
357 pa_hashmap_put(u->jacks, jack, jack);
359 pa_log_debug("Found %d jacks.", pa_hashmap_size(u->jacks));
361 if (pa_hashmap_size(u->jacks) == 0)
364 u->mixer_fdl = pa_alsa_fdlist_new();
366 u->mixer_handle = pa_alsa_open_mixer(u->alsa_card_index, NULL, &u->hctl_handle);
367 if (u->mixer_handle && pa_alsa_fdlist_set_handle(u->mixer_fdl, NULL, u->hctl_handle, u->core->mainloop) >= 0) {
368 PA_HASHMAP_FOREACH(jack, u->jacks, state) {
369 jack->hctl_elem = pa_alsa_find_jack(u->hctl_handle, jack->alsa_name);
370 if (!jack->hctl_elem) {
371 pa_log_warn("Jack '%s' seems to have disappeared.", jack->alsa_name);
372 jack->has_control = FALSE;
375 snd_hctl_elem_set_callback_private(jack->hctl_elem, u);
376 snd_hctl_elem_set_callback(jack->hctl_elem, report_jack_state);
377 report_jack_state(jack->hctl_elem, 0);
381 pa_log("Failed to open hctl/mixer for jack detection");
385 static void set_card_name(pa_card_new_data *data, pa_modargs *ma, const char *device_id) {
391 pa_assert(device_id);
393 if ((n = pa_modargs_get_value(ma, "card_name", NULL))) {
394 pa_card_new_data_set_name(data, n);
395 data->namereg_fail = TRUE;
399 if ((n = pa_modargs_get_value(ma, "name", NULL)))
400 data->namereg_fail = TRUE;
403 data->namereg_fail = FALSE;
406 t = pa_sprintf_malloc("alsa_card.%s", n);
407 pa_card_new_data_set_name(data, t);
411 int pa__init(pa_module *m) {
412 pa_card_new_data data;
414 pa_bool_t ignore_dB = FALSE;
416 pa_reserve_wrapper *reserve = NULL;
417 const char *description;
418 const char *profile = NULL;
420 pa_bool_t namereg_fail = FALSE;
422 pa_alsa_refcnt_inc();
426 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
427 pa_log("Failed to parse module arguments");
431 if (pa_modargs_get_value_boolean(ma, "ignore_dB", &ignore_dB) < 0) {
432 pa_log("Failed to parse ignore_dB argument.");
436 m->userdata = u = pa_xnew0(struct userdata, 1);
439 u->device_id = pa_xstrdup(pa_modargs_get_value(ma, "device_id", DEFAULT_DEVICE_ID));
442 if ((u->alsa_card_index = snd_card_get_index(u->device_id)) < 0) {
443 pa_log("Card '%s' doesn't exist: %s", u->device_id, pa_alsa_strerror(u->alsa_card_index));
447 if (!pa_in_system_mode()) {
450 if ((rname = pa_alsa_get_reserve_name(u->device_id))) {
451 reserve = pa_reserve_wrapper_get(m->core, rname);
460 fn = pa_udev_get_property(u->alsa_card_index, "PULSE_PROFILE_SET");
463 if (pa_modargs_get_value(ma, "profile_set", NULL)) {
465 fn = pa_xstrdup(pa_modargs_get_value(ma, "profile_set", NULL));
468 u->profile_set = pa_alsa_profile_set_new(fn, &u->core->default_channel_map);
471 u->profile_set->ignore_dB = ignore_dB;
476 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);
477 pa_alsa_profile_set_dump(u->profile_set);
479 pa_card_new_data_init(&data);
480 data.driver = __FILE__;
483 pa_alsa_init_proplist_card(m->core, data.proplist, u->alsa_card_index);
485 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, u->device_id);
486 pa_alsa_init_description(data.proplist);
487 set_card_name(&data, ma, u->device_id);
489 /* We need to give pa_modargs_get_value_boolean() a pointer to a local
490 * variable instead of using &data.namereg_fail directly, because
491 * data.namereg_fail is a bitfield and taking the address of a bitfield
492 * variable is impossible. */
493 namereg_fail = data.namereg_fail;
494 if (pa_modargs_get_value_boolean(ma, "namereg_fail", &namereg_fail) < 0) {
495 pa_log("Failed to parse namereg_fail argument.");
496 pa_card_new_data_done(&data);
499 data.namereg_fail = namereg_fail;
502 if ((description = pa_proplist_gets(data.proplist, PA_PROP_DEVICE_DESCRIPTION)))
503 pa_reserve_wrapper_set_application_device_name(reserve, description);
505 data.profiles = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
506 add_profiles(u, data.profiles, data.ports);
508 if (pa_hashmap_isempty(data.profiles)) {
509 pa_log("Failed to find a working profile.");
510 pa_card_new_data_done(&data);
514 add_disabled_profile(data.profiles);
516 if (pa_modargs_get_proplist(ma, "card_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
517 pa_log("Invalid properties");
518 pa_card_new_data_done(&data);
522 if ((profile = pa_modargs_get_value(ma, "profile", NULL)))
523 pa_card_new_data_set_profile(&data, profile);
525 u->card = pa_card_new(m->core, &data);
526 pa_card_new_data_done(&data);
531 u->card->userdata = u;
532 u->card->set_profile = card_set_profile;
538 pa_reserve_wrapper_unref(reserve);
540 if (!pa_hashmap_isempty(u->profile_set->decibel_fixes))
541 pa_log_warn("Card %s uses decibel fixes (i.e. overrides the decibel information for some alsa volume elements). "
542 "Please note that this feature is meant just as a help for figuring out the correct decibel values. "
543 "Pulseaudio is not the correct place to maintain the decibel mappings! The fixed decibel values "
544 "should be sent to ALSA developers so that they can fix the driver. If it turns out that this feature "
545 "is abused (i.e. fixes are not pushed to ALSA), the decibel fix feature may be removed in some future "
546 "Pulseaudio version.", u->card->name);
552 pa_reserve_wrapper_unref(reserve);
559 int pa__get_n_used(pa_module *m) {
567 pa_assert_se(u = m->userdata);
570 PA_IDXSET_FOREACH(sink, u->card->sinks, idx)
571 n += pa_sink_linked_by(sink);
573 PA_IDXSET_FOREACH(source, u->card->sources, idx)
574 n += pa_source_linked_by(source);
579 void pa__done(pa_module*m) {
584 if (!(u = m->userdata))
588 pa_alsa_fdlist_free(u->mixer_fdl);
590 snd_mixer_close(u->mixer_handle);
592 pa_hashmap_free(u->jacks, NULL, NULL);
594 if (u->card && u->card->sinks) {
597 while ((s = pa_idxset_steal_first(u->card->sinks, NULL)))
598 pa_alsa_sink_free(s);
601 if (u->card && u->card->sources) {
604 while ((s = pa_idxset_steal_first(u->card->sources, NULL)))
605 pa_alsa_source_free(s);
609 pa_card_free(u->card);
612 pa_modargs_free(u->modargs);
615 pa_alsa_profile_set_free(u->profile_set);
617 pa_xfree(u->device_id);
621 pa_alsa_refcnt_dec();