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