src/modules/module-alsa-source.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   Copyright 2004-2006 Lennart Poettering
   7   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   8
   9   PulseAudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as published
  11   by the Free Software Foundation; either version 2 of the License,
  12   or (at your option) any later version.
  13
  14   PulseAudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with PulseAudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include <config.h>
  27 #endif
  28
  29 #include <assert.h>
  30 #include <stdio.h>
  31
  32 #ifdef HAVE_SYS_POLL_H
  33 #include <sys/poll.h>
  34 #else
  35 #include "poll.h"
  36 #endif
  37
  38 #include <asoundlib.h>
  39
  40 #include <pulse/xmalloc.h>
  41
  42 #include <pulsecore/core-error.h>
  43 #include <pulsecore/core.h>
  44 #include <pulsecore/module.h>
  45 #include <pulsecore/memchunk.h>
  46 #include <pulsecore/sink.h>
  47 #include <pulsecore/modargs.h>
  48 #include <pulsecore/core-util.h>
  49 #include <pulsecore/sample-util.h>
  50 #include <pulsecore/log.h>
  51
  52 #include "alsa-util.h"
  53 #include "module-alsa-source-symdef.h"
  54
  55 PA_MODULE_AUTHOR("Lennart Poettering")
  56 PA_MODULE_DESCRIPTION("ALSA Source")
  57 PA_MODULE_VERSION(PACKAGE_VERSION)
  58 PA_MODULE_USAGE(
  59         "source_name=<name for the source> "
  60         "device=<ALSA device> "
  61         "format=<sample format> "
  62         "channels=<number of channels> "
  63         "rate=<sample rate> "
  64         "fragments=<number of fragments> "
  65         "fragment_size=<fragment size> "
  66         "channel_map=<channel map>")
  67
  68 struct userdata {
  69     snd_pcm_t *pcm_handle;
  70     snd_mixer_t *mixer_handle;
  71     snd_mixer_elem_t *mixer_elem;
  72     pa_source *source;
  73     struct pa_alsa_fdlist *pcm_fdl;
  74     struct pa_alsa_fdlist *mixer_fdl;
  75     long hw_volume_max, hw_volume_min;
  76
  77     size_t frame_size, fragment_size;
  78     pa_memchunk memchunk;
  79     pa_module *module;
  80 };
  81
  82 static const char* const valid_modargs[] = {
  83     "device",
  84     "source_name",
  85     "channels",
  86     "rate",
  87     "format",
  88     "fragments",
  89     "fragment_size",
  90     "channel_map",
  91     NULL
  92 };
  93
  94 #define DEFAULT_DEVICE "default"
  95
  96 static void update_usage(struct userdata *u) {
  97    pa_module_set_used(u->module, u->source ? pa_source_used_by(u->source) : 0);
  98 }
  99
 100 static void clear_up(struct userdata *u) {
 101     assert(u);
 102
 103     if (u->source) {
 104         pa_source_disconnect(u->source);
 105         pa_source_unref(u->source);
 106         u->source = NULL;
 107     }
 108
 109     if (u->pcm_fdl)
 110         pa_alsa_fdlist_free(u->pcm_fdl);
 111     if (u->mixer_fdl)
 112         pa_alsa_fdlist_free(u->mixer_fdl);
 113
 114     u->pcm_fdl = u->mixer_fdl = NULL;
 115
 116     if (u->mixer_handle) {
 117         snd_mixer_close(u->mixer_handle);
 118         u->mixer_handle = NULL;
 119     }
 120
 121     if (u->pcm_handle) {
 122         snd_pcm_drop(u->pcm_handle);
 123         snd_pcm_close(u->pcm_handle);
 124         u->pcm_handle = NULL;
 125     }
 126 }
 127
 128 static int xrun_recovery(struct userdata *u) {
 129     int ret;
 130     assert(u);
 131
 132     pa_log_info("*** ALSA-XRUN (capture) ***");
 133
 134     if ((ret = snd_pcm_prepare(u->pcm_handle)) < 0) {
 135         pa_log("snd_pcm_prepare() failed: %s", snd_strerror(-ret));
 136
 137         clear_up(u);
 138         pa_module_unload_request(u->module);
 139
 140         return -1;
 141     }
 142
 143     return 0;
 144 }
 145
 146
 147 static int suspend_recovery(struct userdata *u) {
 148     int ret;
 149     assert(u);
 150
 151     pa_log_info("*** ALSA-SUSPEND (capture) ***");
 152
 153     if ((ret = snd_pcm_resume(u->pcm_handle)) < 0) {
 154         if (ret == -EAGAIN)
 155             return -1;
 156
 157         if (ret != -ENOSYS)
 158             pa_log("snd_pcm_resume() failed: %s", snd_strerror(-ret));
 159         else {
 160             if ((ret = snd_pcm_prepare(u->pcm_handle)) < 0)
 161                 pa_log("snd_pcm_prepare() failed: %s", snd_strerror(-ret));
 162         }
 163
 164         if (ret < 0) {
 165             clear_up(u);
 166             pa_module_unload_request(u->module);
 167             return -1;
 168         }
 169     }
 170
 171     return ret;
 172 }
 173
 174 static void do_read(struct userdata *u) {
 175     assert(u);
 176
 177     update_usage(u);
 178
 179     for (;;) {
 180         pa_memchunk post_memchunk;
 181         snd_pcm_sframes_t frames;
 182         size_t l;
 183         void *p;
 184
 185         if (!u->memchunk.memblock) {
 186             u->memchunk.memblock = pa_memblock_new(u->source->core->mempool, u->memchunk.length = u->fragment_size);
 187             u->memchunk.index = 0;
 188         }
 189
 190         assert(u->memchunk.memblock);
 191         assert(u->memchunk.length);
 192         assert(u->memchunk.length % u->frame_size == 0);
 193
 194         p = pa_memblock_acquire(u->memchunk.memblock);
 195
 196         if ((frames = snd_pcm_readi(u->pcm_handle, (uint8_t*) p + u->memchunk.index, u->memchunk.length / u->frame_size)) < 0) {
 197             pa_memblock_release(u->memchunk.memblock);
 198
 199             if (frames == -EAGAIN)
 200                 return;
 201
 202             if (frames == -EPIPE) {
 203                 if (xrun_recovery(u) < 0)
 204                     return;
 205
 206                 continue;
 207             }
 208
 209             if (frames == -ESTRPIPE) {
 210                 if (suspend_recovery(u) < 0)
 211                     return;
 212
 213                 continue;
 214             }
 215
 216             pa_log("snd_pcm_readi() failed: %s", snd_strerror(-frames));
 217
 218             clear_up(u);
 219             pa_module_unload_request(u->module);
 220             return;
 221         }
 222         pa_memblock_release(u->memchunk.memblock);
 223
 224         l = frames * u->frame_size;
 225
 226         post_memchunk = u->memchunk;
 227         post_memchunk.length = l;
 228
 229         pa_source_post(u->source, &post_memchunk);
 230
 231         u->memchunk.index += l;
 232         u->memchunk.length -= l;
 233
 234         if (u->memchunk.length == 0) {
 235             pa_memblock_unref(u->memchunk.memblock);
 236             u->memchunk.memblock = NULL;
 237             u->memchunk.index = u->memchunk.length = 0;
 238         }
 239
 240         break;
 241     }
 242 }
 243
 244 static void fdl_callback(void *userdata) {
 245     struct userdata *u = userdata;
 246     assert(u);
 247
 248     if (snd_pcm_state(u->pcm_handle) == SND_PCM_STATE_XRUN)
 249         if (xrun_recovery(u) < 0)
 250             return;
 251
 252     if (snd_pcm_state(u->pcm_handle) == SND_PCM_STATE_SUSPENDED)
 253         if (suspend_recovery(u) < 0)
 254             return;
 255
 256     do_read(u);
 257 }
 258
 259 static int mixer_callback(snd_mixer_elem_t *elem, unsigned int mask) {
 260     struct userdata *u = snd_mixer_elem_get_callback_private(elem);
 261
 262     assert(u && u->mixer_handle);
 263
 264     if (mask == SND_CTL_EVENT_MASK_REMOVE)
 265         return 0;
 266
 267     if (mask & SND_CTL_EVENT_MASK_VALUE) {
 268         if (u->source->get_hw_volume)
 269             u->source->get_hw_volume(u->source);
 270         if (u->source->get_hw_mute)
 271             u->source->get_hw_mute(u->source);
 272
 273         pa_subscription_post(u->source->core,
 274             PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE,
 275             u->source->index);
 276     }
 277
 278     return 0;
 279 }
 280
 281 static pa_usec_t source_get_latency_cb(pa_source *s) {
 282     struct userdata *u = s->userdata;
 283     snd_pcm_sframes_t frames;
 284     assert(s && u && u->source);
 285
 286     if (snd_pcm_delay(u->pcm_handle, &frames) < 0) {
 287         pa_log("failed to get delay");
 288         s->get_latency = NULL;
 289         return 0;
 290     }
 291
 292     return pa_bytes_to_usec(frames * u->frame_size, &s->sample_spec);
 293 }
 294
 295 static int source_get_hw_volume_cb(pa_source *s) {
 296     struct userdata *u = s->userdata;
 297     long vol;
 298     int err;
 299     int i;
 300
 301     assert(u && u->mixer_elem);
 302
 303     for (i = 0;i < s->hw_volume.channels;i++) {
 304         long set_vol;
 305
 306         assert(snd_mixer_selem_has_capture_channel(u->mixer_elem, i));
 307
 308         if ((err = snd_mixer_selem_get_capture_volume(u->mixer_elem, i, &vol)) < 0)
 309             goto fail;
 310
 311         set_vol = (long) roundf(((float) s->hw_volume.values[i] * (u->hw_volume_max - u->hw_volume_min)) / PA_VOLUME_NORM) + u->hw_volume_min;
 312
 313         /* Try to avoid superfluous volume changes */
 314         if (set_vol != vol)
 315             s->hw_volume.values[i] = (pa_volume_t) roundf(((float) (vol - u->hw_volume_min) * PA_VOLUME_NORM) / (u->hw_volume_max - u->hw_volume_min));
 316     }
 317
 318     return 0;
 319
 320 fail:
 321     pa_log_error("Unable to read volume: %s", snd_strerror(err));
 322     s->get_hw_volume = NULL;
 323     s->set_hw_volume = NULL;
 324     return -1;
 325 }
 326
 327 static int source_set_hw_volume_cb(pa_source *s) {
 328     struct userdata *u = s->userdata;
 329     int err;
 330     pa_volume_t vol;
 331     int i;
 332
 333     assert(u && u->mixer_elem);
 334
 335     for (i = 0;i < s->hw_volume.channels;i++) {
 336         assert(snd_mixer_selem_has_capture_channel(u->mixer_elem, i));
 337
 338         vol = s->hw_volume.values[i];
 339
 340         if (vol > PA_VOLUME_NORM)
 341             vol = PA_VOLUME_NORM;
 342
 343         vol = (long) roundf(((float) vol * (u->hw_volume_max - u->hw_volume_min)) / PA_VOLUME_NORM) + u->hw_volume_min;
 344
 345         if ((err = snd_mixer_selem_set_capture_volume(u->mixer_elem, i, vol)) < 0)
 346             goto fail;
 347     }
 348
 349     return 0;
 350
 351 fail:
 352     pa_log_error("Unable to set volume: %s", snd_strerror(err));
 353     s->get_hw_volume = NULL;
 354     s->set_hw_volume = NULL;
 355     return -1;
 356 }
 357
 358 static int source_get_hw_mute_cb(pa_source *s) {
 359     struct userdata *u = s->userdata;
 360     int err, sw;
 361
 362     assert(u && u->mixer_elem);
 363
 364     err = snd_mixer_selem_get_capture_switch(u->mixer_elem, 0, &sw);
 365     if (err) {
 366         pa_log_error("Unable to get switch: %s", snd_strerror(err));
 367         s->get_hw_mute = NULL;
 368         s->set_hw_mute = NULL;
 369         return -1;
 370     }
 371
 372     s->hw_muted = !sw;
 373
 374     return 0;
 375 }
 376
 377 static int source_set_hw_mute_cb(pa_source *s) {
 378     struct userdata *u = s->userdata;
 379     int err;
 380
 381     assert(u && u->mixer_elem);
 382
 383     err = snd_mixer_selem_set_capture_switch_all(u->mixer_elem, !s->hw_muted);
 384     if (err) {
 385         pa_log_error("Unable to set switch: %s", snd_strerror(err));
 386         s->get_hw_mute = NULL;
 387         s->set_hw_mute = NULL;
 388         return -1;
 389     }
 390
 391     return 0;
 392 }
 393
 394 int pa__init(pa_core *c, pa_module*m) {
 395     pa_modargs *ma = NULL;
 396     int ret = -1;
 397     struct userdata *u = NULL;
 398     const char *dev;
 399     pa_sample_spec ss;
 400     pa_channel_map map;
 401     unsigned periods, fragsize;
 402     snd_pcm_uframes_t period_size;
 403     size_t frame_size;
 404     snd_pcm_info_t *pcm_info = NULL;
 405     int err;
 406     char *t;
 407     const char *name;
 408     char *name_buf = NULL;
 409     int namereg_fail;
 410
 411     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 412         pa_log("failed to parse module arguments");
 413         goto fail;
 414     }
 415
 416     ss = c->default_sample_spec;
 417     if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_ALSA) < 0) {
 418         pa_log("failed to parse sample specification");
 419         goto fail;
 420     }
 421
 422     frame_size = pa_frame_size(&ss);
 423
 424     /* Fix latency to 100ms */
 425     periods = 12;
 426     fragsize = pa_bytes_per_second(&ss)/128;
 427
 428     if (pa_modargs_get_value_u32(ma, "fragments", &periods) < 0 || pa_modargs_get_value_u32(ma, "fragment_size", &fragsize) < 0) {
 429         pa_log("failed to parse buffer metrics");
 430         goto fail;
 431     }
 432     period_size = fragsize/frame_size;
 433
 434     u = pa_xnew0(struct userdata, 1);
 435     m->userdata = u;
 436     u->module = m;
 437
 438     snd_config_update_free_global();
 439     if ((err = snd_pcm_open(&u->pcm_handle, dev = pa_modargs_get_value(ma, "device", DEFAULT_DEVICE), SND_PCM_STREAM_CAPTURE, SND_PCM_NONBLOCK)) < 0) {
 440         pa_log("Error opening PCM device %s: %s", dev, snd_strerror(err));
 441         goto fail;
 442     }
 443
 444     if ((err = snd_pcm_info_malloc(&pcm_info)) < 0 ||
 445         (err = snd_pcm_info(u->pcm_handle, pcm_info)) < 0) {
 446         pa_log("Error fetching PCM info: %s", snd_strerror(err));
 447         goto fail;
 448     }
 449
 450     if ((err = pa_alsa_set_hw_params(u->pcm_handle, &ss, &periods, &period_size)) < 0) {
 451         pa_log("Failed to set hardware parameters: %s", snd_strerror(err));
 452         goto fail;
 453     }
 454
 455     if (ss.channels != map.channels)
 456         /* Seems ALSA didn't like the channel number, so let's fix the channel map */
 457         pa_channel_map_init_auto(&map, ss.channels, PA_CHANNEL_MAP_ALSA);
 458
 459     if ((err = snd_mixer_open(&u->mixer_handle, 0)) < 0) {
 460         pa_log("Error opening mixer: %s", snd_strerror(err));
 461         goto fail;
 462     }
 463
 464     if ((pa_alsa_prepare_mixer(u->mixer_handle, dev) < 0) ||
 465         !(u->mixer_elem = pa_alsa_find_elem(u->mixer_handle, "Capture", "Mic"))) {
 466         snd_mixer_close(u->mixer_handle);
 467         u->mixer_handle = NULL;
 468     }
 469
 470     if ((name = pa_modargs_get_value(ma, "source_name", NULL)))
 471         namereg_fail = 1;
 472     else {
 473         name = name_buf = pa_sprintf_malloc("alsa_input.%s", dev);
 474         namereg_fail = 0;
 475     }
 476
 477     if (!(u->source = pa_source_new(c, __FILE__, name, namereg_fail, &ss, &map))) {
 478         pa_log("Failed to create source object");
 479         goto fail;
 480     }
 481
 482     u->source->is_hardware = 1;
 483     u->source->userdata = u;
 484     u->source->get_latency = source_get_latency_cb;
 485     if (u->mixer_handle) {
 486         assert(u->mixer_elem);
 487         if (snd_mixer_selem_has_capture_volume(u->mixer_elem)) {
 488             int i;
 489
 490             for (i = 0;i < ss.channels;i++) {
 491                 if (!snd_mixer_selem_has_capture_channel(u->mixer_elem, i))
 492                     break;
 493             }
 494
 495             if (i == ss.channels) {
 496                 u->source->get_hw_volume = source_get_hw_volume_cb;
 497                 u->source->set_hw_volume = source_set_hw_volume_cb;
 498                 snd_mixer_selem_get_capture_volume_range(
 499                     u->mixer_elem, &u->hw_volume_min, &u->hw_volume_max);
 500             }
 501         }
 502         if (snd_mixer_selem_has_capture_switch(u->mixer_elem)) {
 503             u->source->get_hw_mute = source_get_hw_mute_cb;
 504             u->source->set_hw_mute = source_set_hw_mute_cb;
 505         }
 506     }
 507     pa_source_set_owner(u->source, m);
 508     pa_source_set_description(u->source, t = pa_sprintf_malloc("ALSA PCM on %s (%s)", dev, snd_pcm_info_get_name(pcm_info)));
 509     pa_xfree(t);
 510
 511     u->pcm_fdl = pa_alsa_fdlist_new();
 512     assert(u->pcm_fdl);
 513     if (pa_alsa_fdlist_init_pcm(u->pcm_fdl, u->pcm_handle, c->mainloop, fdl_callback, u) < 0) {
 514         pa_log("failed to initialise file descriptor monitoring");
 515         goto fail;
 516     }
 517
 518     if (u->mixer_handle) {
 519         u->mixer_fdl = pa_alsa_fdlist_new();
 520         assert(u->mixer_fdl);
 521         if (pa_alsa_fdlist_init_mixer(u->mixer_fdl, u->mixer_handle, c->mainloop) < 0) {
 522             pa_log("failed to initialise file descriptor monitoring");
 523             goto fail;
 524         }
 525         snd_mixer_elem_set_callback(u->mixer_elem, mixer_callback);
 526         snd_mixer_elem_set_callback_private(u->mixer_elem, u);
 527     } else
 528         u->mixer_fdl = NULL;
 529
 530     u->frame_size = frame_size;
 531     u->fragment_size = period_size * frame_size;
 532
 533     pa_log_info("using %u fragments of size %lu bytes.", periods, (long unsigned) u->fragment_size);
 534
 535     u->memchunk.memblock = NULL;
 536     u->memchunk.index = u->memchunk.length = 0;
 537
 538     snd_pcm_start(u->pcm_handle);
 539
 540     ret = 0;
 541
 542     /* Get initial mixer settings */
 543     if (u->source->get_hw_volume)
 544         u->source->get_hw_volume(u->source);
 545     if (u->source->get_hw_mute)
 546         u->source->get_hw_mute(u->source);
 547
 548 finish:
 549     pa_xfree(name_buf);
 550
 551     if (ma)
 552          pa_modargs_free(ma);
 553
 554     if (pcm_info)
 555         snd_pcm_info_free(pcm_info);
 556
 557     return ret;
 558
 559 fail:
 560
 561     if (u)
 562         pa__done(c, m);
 563
 564     goto finish;
 565 }
 566
 567 void pa__done(pa_core *c, pa_module*m) {
 568     struct userdata *u;
 569     assert(c && m);
 570
 571     if (!(u = m->userdata))
 572         return;
 573
 574     clear_up(u);
 575
 576     if (u->memchunk.memblock)
 577         pa_memblock_unref(u->memchunk.memblock);
 578
 579     pa_xfree(u);
 580 }
 581