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 #include <pulse/i18n.h>
  28
  29 #include <pulsecore/core-util.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-sink.h"
  41 #include "alsa-source.h"
  42 #include "module-alsa-card-symdef.h"
  43
  44 PA_MODULE_AUTHOR("Lennart Poettering");
  45 PA_MODULE_DESCRIPTION("ALSA Card");
  46 PA_MODULE_VERSION(PACKAGE_VERSION);
  47 PA_MODULE_LOAD_ONCE(FALSE);
  48 PA_MODULE_USAGE(
  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> "
  59         "rate=<sample rate> "
  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> ");
  70
  71 static const char* const valid_modargs[] = {
  72     "name",
  73     "card_name",
  74     "card_properties",
  75     "sink_name",
  76     "sink_properties",
  77     "source_name",
  78     "source_properties",
  79     "namereg_fail",
  80     "device_id",
  81     "format",
  82     "rate",
  83     "fragments",
  84     "fragment_size",
  85     "mmap",
  86     "tsched",
  87     "tsched_buffer_size",
  88     "tsched_buffer_watermark",
  89     "profile",
  90     "ignore_dB",
  91     "sync_volume",
  92     "profile_set",
  93     NULL
  94 };
  95
  96 #define DEFAULT_DEVICE_ID "0"
  97
  98 struct userdata {
  99     pa_core *core;
 100     pa_module *module;
 101
 102     char *device_id;
 103
 104     pa_card *card;
 105
 106     pa_modargs *modargs;
 107
 108     pa_alsa_profile_set *profile_set;
 109 };
 110
 111 struct profile_data {
 112     pa_alsa_profile *profile;
 113 };
 114
 115 static void add_profiles(struct userdata *u, pa_hashmap *h) {
 116     pa_alsa_profile *ap;
 117     void *state;
 118
 119     pa_assert(u);
 120     pa_assert(h);
 121
 122     PA_HASHMAP_FOREACH(ap, u->profile_set->profiles, state) {
 123         struct profile_data *d;
 124         pa_card_profile *cp;
 125         pa_alsa_mapping *m;
 126         uint32_t idx;
 127
 128         cp = pa_card_profile_new(ap->name, ap->description, sizeof(struct profile_data));
 129         cp->priority = ap->priority;
 130
 131         if (ap->output_mappings) {
 132             cp->n_sinks = pa_idxset_size(ap->output_mappings);
 133
 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;
 137         }
 138
 139         if (ap->input_mappings) {
 140             cp->n_sources = pa_idxset_size(ap->input_mappings);
 141
 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;
 145         }
 146
 147         d = PA_CARD_PROFILE_DATA(cp);
 148         d->profile = ap;
 149
 150         pa_hashmap_put(h, cp->name, cp);
 151     }
 152 }
 153
 154 static void add_disabled_profile(pa_hashmap *profiles) {
 155     pa_card_profile *p;
 156     struct profile_data *d;
 157
 158     p = pa_card_profile_new("off", _("Off"), sizeof(struct profile_data));
 159
 160     d = PA_CARD_PROFILE_DATA(p);
 161     d->profile = NULL;
 162
 163     pa_hashmap_put(profiles, p->name, p);
 164 }
 165
 166 static int card_set_profile(pa_card *c, pa_card_profile *new_profile) {
 167     struct userdata *u;
 168     struct profile_data *nd, *od;
 169     uint32_t idx;
 170     pa_alsa_mapping *am;
 171     pa_queue *sink_inputs = NULL, *source_outputs = NULL;
 172
 173     pa_assert(c);
 174     pa_assert(new_profile);
 175     pa_assert_se(u = c->userdata);
 176
 177     nd = PA_CARD_PROFILE_DATA(new_profile);
 178     od = PA_CARD_PROFILE_DATA(c->active_profile);
 179
 180     if (od->profile && od->profile->output_mappings)
 181         PA_IDXSET_FOREACH(am, od->profile->output_mappings, idx) {
 182             if (!am->sink)
 183                 continue;
 184
 185             if (nd->profile &&
 186                 nd->profile->output_mappings &&
 187                 pa_idxset_get_by_data(nd->profile->output_mappings, am, NULL))
 188                 continue;
 189
 190             sink_inputs = pa_sink_move_all_start(am->sink, sink_inputs);
 191             pa_alsa_sink_free(am->sink);
 192             am->sink = NULL;
 193         }
 194
 195     if (od->profile && od->profile->input_mappings)
 196         PA_IDXSET_FOREACH(am, od->profile->input_mappings, idx) {
 197             if (!am->source)
 198                 continue;
 199
 200             if (nd->profile &&
 201                 nd->profile->input_mappings &&
 202                 pa_idxset_get_by_data(nd->profile->input_mappings, am, NULL))
 203                 continue;
 204
 205             source_outputs = pa_source_move_all_start(am->source, source_outputs);
 206             pa_alsa_source_free(am->source);
 207             am->source = NULL;
 208         }
 209
 210     if (nd->profile && nd->profile->output_mappings)
 211         PA_IDXSET_FOREACH(am, nd->profile->output_mappings, idx) {
 212
 213             if (!am->sink)
 214                 am->sink = pa_alsa_sink_new(c->module, u->modargs, __FILE__, c, am);
 215
 216             if (sink_inputs && am->sink) {
 217                 pa_sink_move_all_finish(am->sink, sink_inputs, FALSE);
 218                 sink_inputs = NULL;
 219             }
 220         }
 221
 222     if (nd->profile && nd->profile->input_mappings)
 223         PA_IDXSET_FOREACH(am, nd->profile->input_mappings, idx) {
 224
 225             if (!am->source)
 226                 am->source = pa_alsa_source_new(c->module, u->modargs, __FILE__, c, am);
 227
 228             if (source_outputs && am->source) {
 229                 pa_source_move_all_finish(am->source, source_outputs, FALSE);
 230                 source_outputs = NULL;
 231             }
 232         }
 233
 234     if (sink_inputs)
 235         pa_sink_move_all_fail(sink_inputs);
 236
 237     if (source_outputs)
 238         pa_source_move_all_fail(source_outputs);
 239
 240     return 0;
 241 }
 242
 243 static void init_profile(struct userdata *u) {
 244     uint32_t idx;
 245     pa_alsa_mapping *am;
 246     struct profile_data *d;
 247
 248     pa_assert(u);
 249
 250     d = PA_CARD_PROFILE_DATA(u->card->active_profile);
 251
 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);
 255
 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);
 259 }
 260
 261 static void set_card_name(pa_card_new_data *data, pa_modargs *ma, const char *device_id) {
 262     char *t;
 263     const char *n;
 264
 265     pa_assert(data);
 266     pa_assert(ma);
 267     pa_assert(device_id);
 268
 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;
 272         return;
 273     }
 274
 275     if ((n = pa_modargs_get_value(ma, "name", NULL)))
 276         data->namereg_fail = TRUE;
 277     else {
 278         n = device_id;
 279         data->namereg_fail = FALSE;
 280     }
 281
 282     t = pa_sprintf_malloc("alsa_card.%s", n);
 283     pa_card_new_data_set_name(data, t);
 284     pa_xfree(t);
 285 }
 286
 287 int pa__init(pa_module *m) {
 288     pa_card_new_data data;
 289     pa_modargs *ma;
 290     int alsa_card_index;
 291     struct userdata *u;
 292     pa_reserve_wrapper *reserve = NULL;
 293     const char *description;
 294     char *fn = NULL;
 295     pa_bool_t namereg_fail = FALSE;
 296
 297     pa_alsa_refcnt_inc();
 298
 299     pa_assert(m);
 300
 301     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 302         pa_log("Failed to parse module arguments");
 303         goto fail;
 304     }
 305
 306     m->userdata = u = pa_xnew0(struct userdata, 1);
 307     u->core = m->core;
 308     u->module = m;
 309     u->device_id = pa_xstrdup(pa_modargs_get_value(ma, "device_id", DEFAULT_DEVICE_ID));
 310     u->modargs = ma;
 311
 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));
 314         goto fail;
 315     }
 316
 317     if (!pa_in_system_mode()) {
 318         char *rname;
 319
 320         if ((rname = pa_alsa_get_reserve_name(u->device_id))) {
 321             reserve = pa_reserve_wrapper_get(m->core, rname);
 322             pa_xfree(rname);
 323
 324             if (!reserve)
 325                 goto fail;
 326         }
 327     }
 328
 329 #ifdef HAVE_UDEV
 330     fn = pa_udev_get_property(alsa_card_index, "PULSE_PROFILE_SET");
 331 #endif
 332
 333     if (pa_modargs_get_value(ma, "profile_set", NULL)) {
 334         pa_xfree(fn);
 335         fn = pa_xstrdup(pa_modargs_get_value(ma, "profile_set", NULL));
 336     }
 337
 338     u->profile_set = pa_alsa_profile_set_new(fn, &u->core->default_channel_map);
 339     pa_xfree(fn);
 340
 341     if (!u->profile_set)
 342         goto fail;
 343
 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
 346     pa_card_new_data_init(&data);
 347     data.driver = __FILE__;
 348     data.module = m;
 349
 350     pa_alsa_init_proplist_card(m->core, data.proplist, alsa_card_index);
 351
 352     pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING, u->device_id);
 353     pa_alsa_init_description(data.proplist);
 354     set_card_name(&data, ma, u->device_id);
 355
 356     /* We need to give pa_modargs_get_value_boolean() a pointer to a local
 357      * variable instead of using &data.namereg_fail directly, because
 358      * data.namereg_fail is a bitfield and taking the address of a bitfield
 359      * variable is impossible. */
 360     namereg_fail = data.namereg_fail;
 361     if (pa_modargs_get_value_boolean(ma, "namereg_fail", &namereg_fail) < 0) {
 362         pa_log("Failed to parse boolean argument namereg_fail.");
 363         pa_card_new_data_done(&data);
 364         goto fail;
 365     }
 366     data.namereg_fail = namereg_fail;
 367
 368     if (reserve)
 369         if ((description = pa_proplist_gets(data.proplist, PA_PROP_DEVICE_DESCRIPTION)))
 370             pa_reserve_wrapper_set_application_device_name(reserve, description);
 371
 372     data.profiles = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
 373     add_profiles(u, data.profiles);
 374
 375     if (pa_hashmap_isempty(data.profiles)) {
 376         pa_log("Failed to find a working profile.");
 377         pa_card_new_data_done(&data);
 378         goto fail;
 379     }
 380
 381     add_disabled_profile(data.profiles);
 382
 383     if (pa_modargs_get_proplist(ma, "card_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
 384         pa_log("Invalid properties");
 385         pa_card_new_data_done(&data);
 386         goto fail;
 387     }
 388
 389     u->card = pa_card_new(m->core, &data);
 390     pa_card_new_data_done(&data);
 391
 392     if (!u->card)
 393         goto fail;
 394
 395     u->card->userdata = u;
 396     u->card->set_profile = card_set_profile;
 397
 398     init_profile(u);
 399
 400     if (reserve)
 401         pa_reserve_wrapper_unref(reserve);
 402
 403     return 0;
 404
 405 fail:
 406     if (reserve)
 407         pa_reserve_wrapper_unref(reserve);
 408
 409     pa__done(m);
 410
 411     return -1;
 412 }
 413
 414 int pa__get_n_used(pa_module *m) {
 415     struct userdata *u;
 416     int n = 0;
 417     uint32_t idx;
 418     pa_sink *sink;
 419     pa_source *source;
 420
 421     pa_assert(m);
 422     pa_assert_se(u = m->userdata);
 423     pa_assert(u->card);
 424
 425     PA_IDXSET_FOREACH(sink, u->card->sinks, idx)
 426         n += pa_sink_linked_by(sink);
 427
 428     PA_IDXSET_FOREACH(source, u->card->sources, idx)
 429         n += pa_source_linked_by(source);
 430
 431     return n;
 432 }
 433
 434 void pa__done(pa_module*m) {
 435     struct userdata *u;
 436
 437     pa_assert(m);
 438
 439     if (!(u = m->userdata))
 440         goto finish;
 441
 442     if (u->card && u->card->sinks) {
 443         pa_sink *s;
 444
 445         while ((s = pa_idxset_steal_first(u->card->sinks, NULL)))
 446             pa_alsa_sink_free(s);
 447     }
 448
 449     if (u->card && u->card->sources) {
 450         pa_source *s;
 451
 452         while ((s = pa_idxset_steal_first(u->card->sources, NULL)))
 453             pa_alsa_source_free(s);
 454     }
 455
 456     if (u->card)
 457         pa_card_free(u->card);
 458
 459     if (u->modargs)
 460         pa_modargs_free(u->modargs);
 461
 462     if (u->profile_set)
 463         pa_alsa_profile_set_free(u->profile_set);
 464
 465     pa_xfree(u->device_id);
 466     pa_xfree(u);
 467
 468 finish:
 469     pa_alsa_refcnt_dec();
 470 }