src/modules/alsa/module-alsa-card.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2009 Lennart Poettering
   5
   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.
  10
  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.
  15
  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
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <pulse/xmalloc.h>
  27
  28 #include <pulsecore/core-util.h>
  29 #include <pulsecore/i18n.h>
  30 #include <pulsecore/modargs.h>
  31 #include <pulsecore/queue.h>
  32
  33 #include <modules/reserve-wrap.h>
  34
  35 #ifdef HAVE_UDEV
  36 #include <modules/udev-util.h>
  37 #endif
  38
  39 #include "alsa-util.h"
  40 #include "alsa-ucm.h"
  41 #include "alsa-sink.h"
  42 #include "alsa-source.h"
  43 #include "module-alsa-card-symdef.h"
  44
  45 PA_MODULE_AUTHOR("Lennart Poettering");
  46 PA_MODULE_DESCRIPTION("ALSA Card");
  47 PA_MODULE_VERSION(PACKAGE_VERSION);
  48 PA_MODULE_LOAD_ONCE(false);
  49 PA_MODULE_USAGE(
  50         "name=<name for the card/sink/source, to be prefixed> "
  51         "card_name=<name for the card> "
  52         "card_properties=<properties for the card> "
  53         "sink_name=<name for the sink> "
  54         "sink_properties=<properties for the sink> "
  55         "source_name=<name for the source> "
  56         "source_properties=<properties for the source> "
  57         "namereg_fail=<when false attempt to synthesise new names if they are already taken> "
  58         "device_id=<ALSA card index> "
  59         "format=<sample format> "
  60         "rate=<sample rate> "
  61         "fragments=<number of fragments> "
  62         "fragment_size=<fragment size> "
  63         "mmap=<enable memory mapping?> "
  64         "tsched=<enable system timer based scheduling mode?> "
  65         "tsched_buffer_size=<buffer size when using timer based scheduling> "
  66         "tsched_buffer_watermark=<lower fill watermark> "
  67         "profile=<profile name> "
  68         "fixed_latency_range=<disable latency range changes on underrun?> "
  69         "ignore_dB=<ignore dB information from the device?> "
  70         "deferred_volume=<Synchronize software and hardware volume changes to avoid momentary jumps?> "
  71         "profile_set=<profile set configuration file> "
  72         "paths_dir=<directory containing the path configuration files> "
  73         "use_ucm=<load use case manager> "
  74 );
  75
  76 static const char* const valid_modargs[] = {
  77     "name",
  78     "card_name",
  79     "card_properties",
  80     "sink_name",
  81     "sink_properties",
  82     "source_name",
  83     "source_properties",
  84     "namereg_fail",
  85     "device_id",
  86     "format",
  87     "rate",
  88     "fragments",
  89     "fragment_size",
  90     "mmap",
  91     "tsched",
  92     "tsched_buffer_size",
  93     "tsched_buffer_watermark",
  94     "fixed_latency_range",
  95     "profile",
  96     "ignore_dB",
  97     "deferred_volume",
  98     "profile_set",
  99     "paths_dir",
 100     "use_ucm",
 101     NULL
 102 };
 103
 104 #define DEFAULT_DEVICE_ID "0"
 105
 106 struct userdata {
 107     pa_core *core;
 108     pa_module *module;
 109
 110     char *device_id;
 111     int alsa_card_index;
 112
 113     snd_mixer_t *mixer_handle;
 114     snd_hctl_t *hctl_handle;
 115     pa_hashmap *jacks;
 116     pa_alsa_fdlist *mixer_fdl;
 117
 118     pa_card *card;
 119
 120     pa_modargs *modargs;
 121
 122     pa_alsa_profile_set *profile_set;
 123
 124     /* ucm stuffs */
 125     bool use_ucm;
 126     pa_alsa_ucm_config ucm;
 127
 128     /* hooks for modifier action */
 129     pa_hook_slot
 130         *sink_input_put_hook_slot,
 131         *source_output_put_hook_slot,
 132         *sink_input_unlink_hook_slot,
 133         *source_output_unlink_hook_slot;
 134 };
 135
 136 struct profile_data {
 137     pa_alsa_profile *profile;
 138 };
 139
 140 static void add_profiles(struct userdata *u, pa_hashmap *h, pa_hashmap *ports) {
 141     pa_alsa_profile *ap;
 142     void *state;
 143
 144     pa_assert(u);
 145     pa_assert(h);
 146
 147     PA_HASHMAP_FOREACH(ap, u->profile_set->profiles, state) {
 148         struct profile_data *d;
 149         pa_card_profile *cp;
 150         pa_alsa_mapping *m;
 151         uint32_t idx;
 152
 153         cp = pa_card_profile_new(ap->name, ap->description, sizeof(struct profile_data));
 154         cp->priority = ap->priority;
 155
 156         if (ap->output_mappings) {
 157             cp->n_sinks = pa_idxset_size(ap->output_mappings);
 158
 159             PA_IDXSET_FOREACH(m, ap->output_mappings, idx) {
 160                 if (u->use_ucm)
 161                     pa_alsa_ucm_add_ports_combination(NULL, &m->ucm_context, true, ports, cp, u->core);
 162                 else
 163                     pa_alsa_path_set_add_ports(m->output_path_set, cp, ports, NULL, u->core);
 164                 if (m->channel_map.channels > cp->max_sink_channels)
 165                     cp->max_sink_channels = m->channel_map.channels;
 166             }
 167         }
 168
 169         if (ap->input_mappings) {
 170             cp->n_sources = pa_idxset_size(ap->input_mappings);
 171
 172             PA_IDXSET_FOREACH(m, ap->input_mappings, idx) {
 173                 if (u->use_ucm)
 174                     pa_alsa_ucm_add_ports_combination(NULL, &m->ucm_context, false, ports, cp, u->core);
 175                 else
 176                     pa_alsa_path_set_add_ports(m->input_path_set, cp, ports, NULL, u->core);
 177                 if (m->channel_map.channels > cp->max_source_channels)
 178                     cp->max_source_channels = m->channel_map.channels;
 179             }
 180         }
 181
 182         d = PA_CARD_PROFILE_DATA(cp);
 183         d->profile = ap;
 184
 185         pa_hashmap_put(h, cp->name, cp);
 186     }
 187 }
 188
 189 static void add_disabled_profile(pa_hashmap *profiles) {
 190     pa_card_profile *p;
 191     struct profile_data *d;
 192
 193     p = pa_card_profile_new("off", _("Off"), sizeof(struct profile_data));
 194
 195     d = PA_CARD_PROFILE_DATA(p);
 196     d->profile = NULL;
 197
 198     pa_hashmap_put(profiles, p->name, p);
 199 }
 200
 201 static int card_set_profile(pa_card *c, pa_card_profile *new_profile) {
 202     struct userdata *u;
 203     struct profile_data *nd, *od;
 204     uint32_t idx;
 205     pa_alsa_mapping *am;
 206     pa_queue *sink_inputs = NULL, *source_outputs = NULL;
 207
 208     pa_assert(c);
 209     pa_assert(new_profile);
 210     pa_assert_se(u = c->userdata);
 211
 212     nd = PA_CARD_PROFILE_DATA(new_profile);
 213     od = PA_CARD_PROFILE_DATA(c->active_profile);
 214
 215     if (od->profile && od->profile->output_mappings)
 216         PA_IDXSET_FOREACH(am, od->profile->output_mappings, idx) {
 217             if (!am->sink)
 218                 continue;
 219
 220             if (nd->profile &&
 221                 nd->profile->output_mappings &&
 222                 pa_idxset_get_by_data(nd->profile->output_mappings, am, NULL))
 223                 continue;
 224
 225             sink_inputs = pa_sink_move_all_start(am->sink, sink_inputs);
 226             pa_alsa_sink_free(am->sink);
 227             am->sink = NULL;
 228         }
 229
 230     if (od->profile && od->profile->input_mappings)
 231         PA_IDXSET_FOREACH(am, od->profile->input_mappings, idx) {
 232             if (!am->source)
 233                 continue;
 234
 235             if (nd->profile &&
 236                 nd->profile->input_mappings &&
 237                 pa_idxset_get_by_data(nd->profile->input_mappings, am, NULL))
 238                 continue;
 239
 240             source_outputs = pa_source_move_all_start(am->source, source_outputs);
 241             pa_alsa_source_free(am->source);
 242             am->source = NULL;
 243         }
 244
 245     /* if UCM is available for this card then update the verb */
 246     if (u->use_ucm) {
 247         if (pa_alsa_ucm_set_profile(&u->ucm, nd->profile ? nd->profile->name : NULL,
 248                     od->profile ? od->profile->name : NULL) < 0)
 249             return -1;
 250     }
 251
 252     if (nd->profile && nd->profile->output_mappings)
 253         PA_IDXSET_FOREACH(am, nd->profile->output_mappings, idx) {
 254
 255             if (!am->sink)
 256                 am->sink = pa_alsa_sink_new(c->module, u->modargs, __FILE__, c, am);
 257
 258             if (sink_inputs && am->sink) {
 259                 pa_sink_move_all_finish(am->sink, sink_inputs, false);
 260                 sink_inputs = NULL;
 261             }
 262         }
 263
 264     if (nd->profile && nd->profile->input_mappings)
 265         PA_IDXSET_FOREACH(am, nd->profile->input_mappings, idx) {
 266
 267             if (!am->source)
 268                 am->source = pa_alsa_source_new(c->module, u->modargs, __FILE__, c, am);
 269
 270             if (source_outputs && am->source) {
 271                 pa_source_move_all_finish(am->source, source_outputs, false);
 272                 source_outputs = NULL;
 273             }
 274         }
 275
 276     if (sink_inputs)
 277         pa_sink_move_all_fail(sink_inputs);
 278
 279     if (source_outputs)
 280         pa_source_move_all_fail(source_outputs);
 281
 282     return 0;
 283 }
 284
 285 static void init_profile(struct userdata *u) {
 286     uint32_t idx;
 287     pa_alsa_mapping *am;
 288     struct profile_data *d;
 289     pa_alsa_ucm_config *ucm = &u->ucm;
 290
 291     pa_assert(u);
 292
 293     d = PA_CARD_PROFILE_DATA(u->card->active_profile);
 294
 295     if (d->profile && u->use_ucm) {
 296         /* Set initial verb */
 297         if (pa_alsa_ucm_set_profile(ucm, d->profile->name, NULL) < 0) {
 298             pa_log("Failed to set ucm profile %s", d->profile->name);
 299             return;
 300         }
 301     }
 302
 303     if (d->profile && d->profile->output_mappings)
 304         PA_IDXSET_FOREACH(am, d->profile->output_mappings, idx)
 305             am->sink = pa_alsa_sink_new(u->module, u->modargs, __FILE__, u->card, am);
 306
 307     if (d->profile && d->profile->input_mappings)
 308         PA_IDXSET_FOREACH(am, d->profile->input_mappings, idx)
 309             am->source = pa_alsa_source_new(u->module, u->modargs, __FILE__, u->card, am);
 310 }
 311
 312 static void report_port_state(pa_device_port *p, struct userdata *u) {
 313     void *state;
 314     pa_alsa_jack *jack;
 315     pa_available_t pa = PA_AVAILABLE_UNKNOWN;
 316     pa_device_port *port;
 317
 318     PA_HASHMAP_FOREACH(jack, u->jacks, state) {
 319         pa_available_t cpa;
 320
 321         if (u->use_ucm)
 322             port = pa_hashmap_get(u->card->ports, jack->name);
 323         else {
 324             if (jack->path)
 325                 port = jack->path->port;
 326             else
 327                 continue;
 328         }
 329
 330         if (p != port)
 331             continue;
 332
 333         cpa = jack->plugged_in ? jack->state_plugged : jack->state_unplugged;
 334
 335         /* "Yes" and "no" trumphs "unknown" if we have more than one jack */
 336         if (cpa == PA_AVAILABLE_UNKNOWN)
 337             continue;
 338
 339         if ((cpa == PA_AVAILABLE_NO && pa == PA_AVAILABLE_YES) ||
 340             (pa == PA_AVAILABLE_NO && cpa == PA_AVAILABLE_YES))
 341             pa_log_warn("Availability of port '%s' is inconsistent!", p->name);
 342         else
 343             pa = cpa;
 344     }
 345
 346     pa_device_port_set_available(p, pa);
 347 }
 348
 349 static int report_jack_state(snd_hctl_elem_t *elem, unsigned int mask) {
 350     struct userdata *u = snd_hctl_elem_get_callback_private(elem);
 351     snd_ctl_elem_value_t *elem_value;
 352     bool plugged_in;
 353     void *state;
 354     pa_alsa_jack *jack;
 355     pa_device_port *port;
 356
 357     pa_assert(u);
 358
 359     if (mask == SND_CTL_EVENT_MASK_REMOVE)
 360         return 0;
 361
 362     snd_ctl_elem_value_alloca(&elem_value);
 363     if (snd_hctl_elem_read(elem, elem_value) < 0) {
 364         pa_log_warn("Failed to read jack detection from '%s'", pa_strnull(snd_hctl_elem_get_name(elem)));
 365         return 0;
 366     }
 367
 368     plugged_in = !!snd_ctl_elem_value_get_boolean(elem_value, 0);
 369
 370     pa_log_debug("Jack '%s' is now %s", pa_strnull(snd_hctl_elem_get_name(elem)), plugged_in ? "plugged in" : "unplugged");
 371
 372     PA_HASHMAP_FOREACH(jack, u->jacks, state)
 373         if (jack->hctl_elem == elem) {
 374             jack->plugged_in = plugged_in;
 375             if (u->use_ucm) {
 376                 pa_assert(u->card->ports);
 377                 port = pa_hashmap_get(u->card->ports, jack->name);
 378                 pa_assert(port);
 379             }
 380             else {
 381                 pa_assert(jack->path && jack->path->port);
 382                 port = jack->path->port;
 383             }
 384             report_port_state(port, u);
 385         }
 386     return 0;
 387 }
 388
 389 static pa_device_port* find_port_with_eld_device(pa_hashmap *ports, int device) {
 390     void *state;
 391     pa_device_port *p;
 392
 393     PA_HASHMAP_FOREACH(p, ports, state) {
 394         pa_alsa_port_data *data = PA_DEVICE_PORT_DATA(p);
 395         pa_assert(data->path);
 396         if (device == data->path->eld_device)
 397             return p;
 398     }
 399     return NULL;
 400 }
 401
 402 static int hdmi_eld_changed(snd_hctl_elem_t *elem, unsigned int mask) {
 403     struct userdata *u = snd_hctl_elem_get_callback_private(elem);
 404     int device = snd_hctl_elem_get_device(elem);
 405     const char *old_monitor_name;
 406     pa_device_port *p;
 407     pa_hdmi_eld eld;
 408     bool changed = false;
 409
 410     if (mask == SND_CTL_EVENT_MASK_REMOVE)
 411         return 0;
 412
 413     p = find_port_with_eld_device(u->card->ports, device);
 414     if (p == NULL) {
 415         pa_log_error("Invalid device changed in ALSA: %d", device);
 416         return 0;
 417     }
 418
 419     if (pa_alsa_get_hdmi_eld(u->hctl_handle, device, &eld) < 0)
 420         memset(&eld, 0, sizeof(eld));
 421
 422     old_monitor_name = pa_proplist_gets(p->proplist, PA_PROP_DEVICE_PRODUCT_NAME);
 423     if (eld.monitor_name[0] == '\0') {
 424         changed |= old_monitor_name != NULL;
 425         pa_proplist_unset(p->proplist, PA_PROP_DEVICE_PRODUCT_NAME);
 426     } else {
 427         changed |= (old_monitor_name == NULL) || (strcmp(old_monitor_name, eld.monitor_name) != 0);
 428         pa_proplist_sets(p->proplist, PA_PROP_DEVICE_PRODUCT_NAME, eld.monitor_name);
 429     }
 430
 431     if (changed && mask != 0)
 432         pa_subscription_post(u->core, PA_SUBSCRIPTION_EVENT_CARD|PA_SUBSCRIPTION_EVENT_CHANGE, u->card->index);
 433
 434     return 0;
 435 }
 436
 437 static void init_eld_ctls(struct userdata *u) {
 438     void *state;
 439     pa_device_port *port;
 440
 441     if (!u->hctl_handle)
 442         return;
 443
 444     PA_HASHMAP_FOREACH(port, u->card->ports, state) {
 445         pa_alsa_port_data *data = PA_DEVICE_PORT_DATA(port);
 446         snd_hctl_elem_t* hctl_elem;
 447         int device;
 448
 449         pa_assert(data->path);
 450         device = data->path->eld_device;
 451         if (device < 0)
 452             continue;
 453
 454         hctl_elem = pa_alsa_find_eld_ctl(u->hctl_handle, device);
 455         if (!hctl_elem) {
 456             pa_log_debug("No ELD device found for port %s.", port->name);
 457             continue;
 458         }
 459
 460         snd_hctl_elem_set_callback_private(hctl_elem, u);
 461         snd_hctl_elem_set_callback(hctl_elem, hdmi_eld_changed);
 462         hdmi_eld_changed(hctl_elem, 0);
 463     }
 464 }
 465
 466 static void init_jacks(struct userdata *u) {
 467     void *state;
 468     pa_alsa_path* path;
 469     pa_alsa_jack* jack;
 470
 471     u->jacks = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
 472
 473     if (u->use_ucm) {
 474         PA_LLIST_FOREACH(jack, u->ucm.jacks)
 475             if (jack->has_control)
 476                 pa_hashmap_put(u->jacks, jack, jack);
 477     } else {
 478         /* See if we have any jacks */
 479         if (u->profile_set->output_paths)
 480             PA_HASHMAP_FOREACH(path, u->profile_set->output_paths, state)
 481                 PA_LLIST_FOREACH(jack, path->jacks)
 482                     if (jack->has_control)
 483                         pa_hashmap_put(u->jacks, jack, jack);
 484
 485         if (u->profile_set->input_paths)
 486             PA_HASHMAP_FOREACH(path, u->profile_set->input_paths, state)
 487                 PA_LLIST_FOREACH(jack, path->jacks)
 488                     if (jack->has_control)
 489                         pa_hashmap_put(u->jacks, jack, jack);
 490     }
 491
 492     pa_log_debug("Found %d jacks.", pa_hashmap_size(u->jacks));
 493
 494     if (pa_hashmap_size(u->jacks) == 0)
 495         return;
 496
 497     u->mixer_fdl = pa_alsa_fdlist_new();
 498
 499     u->mixer_handle = pa_alsa_open_mixer(u->alsa_card_index, NULL, &u->hctl_handle);
 500     if (u->mixer_handle && pa_alsa_fdlist_set_handle(u->mixer_fdl, NULL, u->hctl_handle, u->core->mainloop) >= 0) {
 501         PA_HASHMAP_FOREACH(jack, u->jacks, state) {
 502             jack->hctl_elem = pa_alsa_find_jack(u->hctl_handle, jack->alsa_name);
 503             if (!jack->hctl_elem) {
 504                 pa_log_warn("Jack '%s' seems to have disappeared.", jack->alsa_name);
 505                 jack->has_control = false;
 506                 continue;
 507             }
 508             snd_hctl_elem_set_callback_private(jack->hctl_elem, u);
 509             snd_hctl_elem_set_callback(jack->hctl_elem, report_jack_state);
 510             report_jack_state(jack->hctl_elem, 0);
 511         }
 512
 513     } else
 514         pa_log("Failed to open hctl/mixer for jack detection");
 515
 516 }
 517
 518 static void set_card_name(pa_card_new_data *data, pa_modargs *ma, const char *device_id) {
 519     char *t;
 520     const char *n;
 521
 522     pa_assert(data);
 523     pa_assert(ma);
 524     pa_assert(device_id);
 525
 526     if ((n = pa_modargs_get_value(ma, "card_name", NULL))) {
 527         pa_card_new_data_set_name(data, n);
 528         data->namereg_fail = true;
 529         return;
 530     }
 531
 532     if ((n = pa_modargs_get_value(ma, "name", NULL)))
 533         data->namereg_fail = true;
 534     else {
 535         n = device_id;
 536         data->namereg_fail = false;
 537     }
 538
 539     t = pa_sprintf_malloc("alsa_card.%s", n);
 540     pa_card_new_data_set_name(data, t);
 541     pa_xfree(t);
 542 }
 543
 544 static pa_hook_result_t sink_input_put_hook_callback(pa_core *c, pa_sink_input *sink_input, struct userdata *u) {
 545     const char *role;
 546     pa_sink *sink = sink_input->sink;
 547
 548     pa_assert(sink);
 549
 550     role = pa_proplist_gets(sink_input->proplist, PA_PROP_MEDIA_ROLE);
 551
 552     /* new sink input linked to sink of this card */
 553     if (role && sink->card == u->card)
 554         pa_alsa_ucm_roled_stream_begin(&u->ucm, role, PA_DIRECTION_OUTPUT);
 555
 556     return PA_HOOK_OK;
 557 }
 558
 559 static pa_hook_result_t source_output_put_hook_callback(pa_core *c, pa_source_output *source_output, struct userdata *u) {
 560     const char *role;
 561     pa_source *source = source_output->source;
 562
 563     pa_assert(source);
 564
 565     role = pa_proplist_gets(source_output->proplist, PA_PROP_MEDIA_ROLE);
 566
 567     /* new source output linked to source of this card */
 568     if (role && source->card == u->card)
 569         pa_alsa_ucm_roled_stream_begin(&u->ucm, role, PA_DIRECTION_INPUT);
 570
 571     return PA_HOOK_OK;
 572 }
 573
 574 static pa_hook_result_t sink_input_unlink_hook_callback(pa_core *c, pa_sink_input *sink_input, struct userdata *u) {
 575     const char *role;
 576     pa_sink *sink = sink_input->sink;
 577
 578     pa_assert(sink);
 579
 580     role = pa_proplist_gets(sink_input->proplist, PA_PROP_MEDIA_ROLE);
 581
 582     /* new sink input unlinked from sink of this card */
 583     if (role && sink->card == u->card)
 584         pa_alsa_ucm_roled_stream_end(&u->ucm, role, PA_DIRECTION_OUTPUT);
 585
 586     return PA_HOOK_OK;
 587 }
 588
 589 static pa_hook_result_t source_output_unlink_hook_callback(pa_core *c, pa_source_output *source_output, struct userdata *u) {
 590     const char *role;
 591     pa_source *source = source_output->source;
 592
 593     pa_assert(source);
 594
 595     role = pa_proplist_gets(source_output->proplist, PA_PROP_MEDIA_ROLE);
 596
 597     /* new source output unlinked from source of this card */
 598     if (role && source->card == u->card)
 599         pa_alsa_ucm_roled_stream_end(&u->ucm, role, PA_DIRECTION_INPUT);
 600
 601     return PA_HOOK_OK;
 602 }
 603
 604 int pa__init(pa_module *m) {
 605     pa_card_new_data data;
 606     pa_modargs *ma;
 607     bool ignore_dB = false;
 608     struct userdata *u;
 609     pa_reserve_wrapper *reserve = NULL;
 610     const char *description;
 611     const char *profile = NULL;
 612     char *fn = NULL;
 613     bool namereg_fail = false;
 614
 615     pa_alsa_refcnt_inc();
 616
 617     pa_assert(m);
 618
 619     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 620         pa_log("Failed to parse module arguments");
 621         goto fail;
 622     }
 623
 624     if (pa_modargs_get_value_boolean(ma, "ignore_dB", &ignore_dB) < 0) {
 625         pa_log("Failed to parse ignore_dB argument.");
 626         goto fail;
 627     }
 628
 629     m->userdata = u = pa_xnew0(struct userdata, 1);
 630     u->core = m->core;
 631     u->module = m;
 632     u->device_id = pa_xstrdup(pa_modargs_get_value(ma, "device_id", DEFAULT_DEVICE_ID));
 633     u->modargs = ma;
 634
 635     u->use_ucm = true;
 636     u->ucm.core = m->core;
 637
 638     if ((u->alsa_card_index = snd_card_get_index(u->device_id)) < 0) {
 639         pa_log("Card '%s' doesn't exist: %s", u->device_id, pa_alsa_strerror(u->alsa_card_index));
 640         goto fail;
 641     }
 642
 643     if (!pa_in_system_mode()) {
 644         char *rname;
 645
 646         if ((rname = pa_alsa_get_reserve_name(u->device_id))) {
 647             reserve = pa_reserve_wrapper_get(m->core, rname);
 648             pa_xfree(rname);
 649
 650             if (!reserve)
 651                 goto fail;
 652         }
 653     }
 654
 655     pa_modargs_get_value_boolean(ma, "use_ucm", &u->use_ucm);
 656     if (u->use_ucm && !pa_alsa_ucm_query_profiles(&u->ucm, u->alsa_card_index)) {
 657         pa_log_info("Found UCM profiles");
 658
 659         u->profile_set = pa_alsa_ucm_add_profile_set(&u->ucm, &u->core->default_channel_map);
 660
 661         /* hook start of sink input/source output to enable modifiers */
 662         /* A little bit later than module-role-cork */
 663         u->sink_input_put_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_PUT], PA_HOOK_LATE+10,
 664                 (pa_hook_cb_t) sink_input_put_hook_callback, u);
 665         u->source_output_put_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_PUT], PA_HOOK_LATE+10,
 666                 (pa_hook_cb_t) source_output_put_hook_callback, u);
 667
 668         /* hook end of sink input/source output to disable modifiers */
 669         /* A little bit later than module-role-cork */
 670         u->sink_input_unlink_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_UNLINK], PA_HOOK_LATE+10,
 671                 (pa_hook_cb_t) sink_input_unlink_hook_callback, u);
 672         u->source_output_unlink_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK], PA_HOOK_LATE+10,
 673                 (pa_hook_cb_t) source_output_unlink_hook_callback, u);
 674     }
 675     else {
 676         u->use_ucm = false;
 677 #ifdef HAVE_UDEV
 678         fn = pa_udev_get_property(u->alsa_card_index, "PULSE_PROFILE_SET");
 679 #endif
 680
 681         if (pa_modargs_get_value(ma, "profile_set", NULL)) {
 682             pa_xfree(fn);
 683             fn = pa_xstrdup(pa_modargs_get_value(ma, "profile_set", NULL));
 684         }
 685
 686         u->profile_set = pa_alsa_profile_set_new(fn, &u->core->default_channel_map);
 687         pa_xfree(fn);
 688     }
 689
 690     if (!u->profile_set)
 691         goto fail;
 692
 693     u->profile_set->ignore_dB = ignore_dB;
 694
 695     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);
 696     pa_alsa_profile_set_dump(u->profile_set);
 697
 698     pa_card_new_data_init(&data);
 699     data.driver = __FILE__;
 700     data.module = m;
 701
 702     pa_alsa_init_proplist_card(m->core, data.proplist, u->alsa_card_index);
 703
 704     pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, u->device_id);
 705     pa_alsa_init_description(data.proplist);
 706     set_card_name(&data, ma, u->device_id);
 707
 708     /* We need to give pa_modargs_get_value_boolean() a pointer to a local
 709      * variable instead of using &data.namereg_fail directly, because
 710      * data.namereg_fail is a bitfield and taking the address of a bitfield
 711      * variable is impossible. */
 712     namereg_fail = data.namereg_fail;
 713     if (pa_modargs_get_value_boolean(ma, "namereg_fail", &namereg_fail) < 0) {
 714         pa_log("Failed to parse namereg_fail argument.");
 715         pa_card_new_data_done(&data);
 716         goto fail;
 717     }
 718     data.namereg_fail = namereg_fail;
 719
 720     if (reserve)
 721         if ((description = pa_proplist_gets(data.proplist, PA_PROP_DEVICE_DESCRIPTION)))
 722             pa_reserve_wrapper_set_application_device_name(reserve, description);
 723
 724     add_profiles(u, data.profiles, data.ports);
 725
 726     if (pa_hashmap_isempty(data.profiles)) {
 727         pa_log("Failed to find a working profile.");
 728         pa_card_new_data_done(&data);
 729         goto fail;
 730     }
 731
 732     add_disabled_profile(data.profiles);
 733
 734     if (pa_modargs_get_proplist(ma, "card_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
 735         pa_log("Invalid properties");
 736         pa_card_new_data_done(&data);
 737         goto fail;
 738     }
 739
 740     if ((profile = pa_modargs_get_value(ma, "profile", NULL)))
 741         pa_card_new_data_set_profile(&data, profile);
 742
 743     u->card = pa_card_new(m->core, &data);
 744     pa_card_new_data_done(&data);
 745
 746     if (!u->card)
 747         goto fail;
 748
 749     u->card->userdata = u;
 750     u->card->set_profile = card_set_profile;
 751
 752     init_jacks(u);
 753     init_profile(u);
 754     init_eld_ctls(u);
 755
 756     if (reserve)
 757         pa_reserve_wrapper_unref(reserve);
 758
 759     if (!pa_hashmap_isempty(u->profile_set->decibel_fixes))
 760         pa_log_warn("Card %s uses decibel fixes (i.e. overrides the decibel information for some alsa volume elements). "
 761                     "Please note that this feature is meant just as a help for figuring out the correct decibel values. "
 762                     "PulseAudio is not the correct place to maintain the decibel mappings! The fixed decibel values "
 763                     "should be sent to ALSA developers so that they can fix the driver. If it turns out that this feature "
 764                     "is abused (i.e. fixes are not pushed to ALSA), the decibel fix feature may be removed in some future "
 765                     "PulseAudio version.", u->card->name);
 766
 767     return 0;
 768
 769 fail:
 770     if (reserve)
 771         pa_reserve_wrapper_unref(reserve);
 772
 773     pa__done(m);
 774
 775     return -1;
 776 }
 777
 778 int pa__get_n_used(pa_module *m) {
 779     struct userdata *u;
 780     int n = 0;
 781     uint32_t idx;
 782     pa_sink *sink;
 783     pa_source *source;
 784
 785     pa_assert(m);
 786     pa_assert_se(u = m->userdata);
 787     pa_assert(u->card);
 788
 789     PA_IDXSET_FOREACH(sink, u->card->sinks, idx)
 790         n += pa_sink_linked_by(sink);
 791
 792     PA_IDXSET_FOREACH(source, u->card->sources, idx)
 793         n += pa_source_linked_by(source);
 794
 795     return n;
 796 }
 797
 798 void pa__done(pa_module*m) {
 799     struct userdata *u;
 800
 801     pa_assert(m);
 802
 803     if (!(u = m->userdata))
 804         goto finish;
 805
 806     if (u->sink_input_put_hook_slot)
 807         pa_hook_slot_free(u->sink_input_put_hook_slot);
 808
 809     if (u->sink_input_unlink_hook_slot)
 810         pa_hook_slot_free(u->sink_input_unlink_hook_slot);
 811
 812     if (u->source_output_put_hook_slot)
 813         pa_hook_slot_free(u->source_output_put_hook_slot);
 814
 815     if (u->source_output_unlink_hook_slot)
 816         pa_hook_slot_free(u->source_output_unlink_hook_slot);
 817
 818     if (u->mixer_fdl)
 819         pa_alsa_fdlist_free(u->mixer_fdl);
 820     if (u->mixer_handle)
 821         snd_mixer_close(u->mixer_handle);
 822     if (u->jacks)
 823         pa_hashmap_free(u->jacks, NULL);
 824
 825     if (u->card && u->card->sinks)
 826         pa_idxset_remove_all(u->card->sinks, (pa_free_cb_t) pa_alsa_sink_free);
 827
 828     if (u->card && u->card->sources)
 829         pa_idxset_remove_all(u->card->sources, (pa_free_cb_t) pa_alsa_source_free);
 830
 831     if (u->card)
 832         pa_card_free(u->card);
 833
 834     if (u->modargs)
 835         pa_modargs_free(u->modargs);
 836
 837     if (u->profile_set)
 838         pa_alsa_profile_set_free(u->profile_set);
 839
 840     pa_alsa_ucm_free(&u->ucm);
 841
 842     pa_xfree(u->device_id);
 843     pa_xfree(u);
 844
 845 finish:
 846     pa_alsa_refcnt_dec();
 847 }