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
 184         if (!u->memchunk.memblock) {
 185             u->memchunk.memblock = pa_memblock_new(u->source->core->mempool, u->memchunk.length = u->fragment_size);
 186             u->memchunk.index = 0;
 187         }
 188
 189         assert(u->memchunk.memblock);
 190         assert(u->memchunk.length);
 191         assert(u->memchunk.memblock->data);
 192         assert(u->memchunk.memblock->length);
 193         assert(u->memchunk.length % u->frame_size == 0);
 194
 195         if ((frames = snd_pcm_readi(u->pcm_handle, (uint8_t*) u->memchunk.memblock->data + u->memchunk.index, u->memchunk.length / u->frame_size)) < 0) {
 196             if (frames == -EAGAIN)
 197                 return;
 198
 199             if (frames == -EPIPE) {
 200                 if (xrun_recovery(u) < 0)
 201                     return;
 202
 203                 continue;
 204             }
 205
 206             if (frames == -ESTRPIPE) {
 207                 if (suspend_recovery(u) < 0)
 208                     return;
 209
 210                 continue;
 211             }
 212
 213             pa_log("snd_pcm_readi() failed: %s", snd_strerror(-frames));
 214
 215             clear_up(u);
 216             pa_module_unload_request(u->module);
 217             return;
 218         }
 219
 220         l = frames * u->frame_size;
 221
 222         post_memchunk = u->memchunk;
 223         post_memchunk.length = l;
 224
 225         pa_source_post(u->source, &post_memchunk);
 226
 227         u->memchunk.index += l;
 228         u->memchunk.length -= l;
 229
 230         if (u->memchunk.length == 0) {
 231             pa_memblock_unref(u->memchunk.memblock);
 232             u->memchunk.memblock = NULL;
 233             u->memchunk.index = u->memchunk.length = 0;
 234         }
 235
 236         break;
 237     }
 238 }
 239
 240 static void fdl_callback(void *userdata) {
 241     struct userdata *u = userdata;
 242     assert(u);
 243
 244     if (snd_pcm_state(u->pcm_handle) == SND_PCM_STATE_XRUN)
 245         if (xrun_recovery(u) < 0)
 246             return;
 247
 248     if (snd_pcm_state(u->pcm_handle) == SND_PCM_STATE_SUSPENDED)
 249         if (suspend_recovery(u) < 0)
 250             return;
 251
 252     do_read(u);
 253 }
 254
 255 static int mixer_callback(snd_mixer_elem_t *elem, unsigned int mask) {
 256     struct userdata *u = snd_mixer_elem_get_callback_private(elem);
 257
 258     assert(u && u->mixer_handle);
 259
 260     if (mask == SND_CTL_EVENT_MASK_REMOVE)
 261         return 0;
 262
 263     if (mask & SND_CTL_EVENT_MASK_VALUE) {
 264         if (u->source->get_hw_volume)
 265             u->source->get_hw_volume(u->source);
 266         if (u->source->get_hw_mute)
 267             u->source->get_hw_mute(u->source);
 268
 269         pa_subscription_post(u->source->core,
 270             PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE,
 271             u->source->index);
 272     }
 273
 274     return 0;
 275 }
 276
 277 static pa_usec_t source_get_latency_cb(pa_source *s) {
 278     struct userdata *u = s->userdata;
 279     snd_pcm_sframes_t frames;
 280     assert(s && u && u->source);
 281
 282     if (snd_pcm_delay(u->pcm_handle, &frames) < 0) {
 283         pa_log("failed to get delay");
 284         s->get_latency = NULL;
 285         return 0;
 286     }
 287
 288     return pa_bytes_to_usec(frames * u->frame_size, &s->sample_spec);
 289 }
 290
 291 static int source_get_hw_volume_cb(pa_source *s) {
 292     struct userdata *u = s->userdata;
 293     long vol;
 294     int err;
 295     int i;
 296
 297     assert(u && u->mixer_elem);
 298
 299     for (i = 0;i < s->hw_volume.channels;i++) {
 300         long set_vol;
 301
 302         assert(snd_mixer_selem_has_capture_channel(u->mixer_elem, i));
 303
 304         if ((err = snd_mixer_selem_get_capture_volume(u->mixer_elem, i, &vol)) < 0)
 305             goto fail;
 306
 307         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;
 308
 309         /* Try to avoid superfluous volume changes */
 310         if (set_vol != vol)
 311             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));
 312     }
 313
 314     return 0;
 315
 316 fail:
 317     pa_log_error("Unable to read volume: %s", snd_strerror(err));
 318     s->get_hw_volume = NULL;
 319     s->set_hw_volume = NULL;
 320     return -1;
 321 }
 322
 323 static int source_set_hw_volume_cb(pa_source *s) {
 324     struct userdata *u = s->userdata;
 325     int err;
 326     pa_volume_t vol;
 327     int i;
 328
 329     assert(u && u->mixer_elem);
 330
 331     for (i = 0;i < s->hw_volume.channels;i++) {
 332         assert(snd_mixer_selem_has_capture_channel(u->mixer_elem, i));
 333
 334         vol = s->hw_volume.values[i];
 335
 336         if (vol > PA_VOLUME_NORM)
 337             vol = PA_VOLUME_NORM;
 338
 339         vol = (long) roundf(((float) vol * (u->hw_volume_max - u->hw_volume_min)) / PA_VOLUME_NORM) + u->hw_volume_min;
 340
 341         if ((err = snd_mixer_selem_set_capture_volume(u->mixer_elem, i, vol)) < 0)
 342             goto fail;
 343     }
 344
 345     return 0;
 346
 347 fail:
 348     pa_log_error("Unable to set volume: %s", snd_strerror(err));
 349     s->get_hw_volume = NULL;
 350     s->set_hw_volume = NULL;
 351     return -1;
 352 }
 353
 354 static int source_get_hw_mute_cb(pa_source *s) {
 355     struct userdata *u = s->userdata;
 356     int err, sw;
 357
 358     assert(u && u->mixer_elem);
 359
 360     err = snd_mixer_selem_get_capture_switch(u->mixer_elem, 0, &sw);
 361     if (err) {
 362         pa_log_error("Unable to get switch: %s", snd_strerror(err));
 363         s->get_hw_mute = NULL;
 364         s->set_hw_mute = NULL;
 365         return -1;
 366     }
 367
 368     s->hw_muted = !sw;
 369
 370     return 0;
 371 }
 372
 373 static int source_set_hw_mute_cb(pa_source *s) {
 374     struct userdata *u = s->userdata;
 375     int err;
 376
 377     assert(u && u->mixer_elem);
 378
 379     err = snd_mixer_selem_set_capture_switch_all(u->mixer_elem, !s->hw_muted);
 380     if (err) {
 381         pa_log_error("Unable to set switch: %s", snd_strerror(err));
 382         s->get_hw_mute = NULL;
 383         s->set_hw_mute = NULL;
 384         return -1;
 385     }
 386
 387     return 0;
 388 }
 389
 390 int pa__init(pa_core *c, pa_module*m) {
 391     pa_modargs *ma = NULL;
 392     int ret = -1;
 393     struct userdata *u = NULL;
 394     const char *dev;
 395     pa_sample_spec ss;
 396     pa_channel_map map;
 397     unsigned periods, fragsize;
 398     snd_pcm_uframes_t period_size;
 399     size_t frame_size;
 400     snd_pcm_info_t *pcm_info = NULL;
 401     int err;
 402     char *t;
 403     const char *name;
 404     char *name_buf = NULL;
 405     int namereg_fail;
 406
 407     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 408         pa_log("failed to parse module arguments");
 409         goto fail;
 410     }
 411
 412     ss = c->default_sample_spec;
 413     if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_ALSA) < 0) {
 414         pa_log("failed to parse sample specification");
 415         goto fail;
 416     }
 417
 418     frame_size = pa_frame_size(&ss);
 419
 420     /* Fix latency to 100ms */
 421     periods = 12;
 422     fragsize = pa_bytes_per_second(&ss)/128;
 423
 424     if (pa_modargs_get_value_u32(ma, "fragments", &periods) < 0 || pa_modargs_get_value_u32(ma, "fragment_size", &fragsize) < 0) {
 425         pa_log("failed to parse buffer metrics");
 426         goto fail;
 427     }
 428     period_size = fragsize/frame_size;
 429
 430     u = pa_xnew0(struct userdata, 1);
 431     m->userdata = u;
 432     u->module = m;
 433
 434     snd_config_update_free_global();
 435     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) {
 436         pa_log("Error opening PCM device %s: %s", dev, snd_strerror(err));
 437         goto fail;
 438     }
 439
 440     if ((err = snd_pcm_info_malloc(&pcm_info)) < 0 ||
 441         (err = snd_pcm_info(u->pcm_handle, pcm_info)) < 0) {
 442         pa_log("Error fetching PCM info: %s", snd_strerror(err));
 443         goto fail;
 444     }
 445
 446     if ((err = pa_alsa_set_hw_params(u->pcm_handle, &ss, &periods, &period_size)) < 0) {
 447         pa_log("Failed to set hardware parameters: %s", snd_strerror(err));
 448         goto fail;
 449     }
 450
 451     if (ss.channels != map.channels)
 452         /* Seems ALSA didn't like the channel number, so let's fix the channel map */
 453         pa_channel_map_init_auto(&map, ss.channels, PA_CHANNEL_MAP_ALSA);
 454
 455     if ((err = snd_mixer_open(&u->mixer_handle, 0)) < 0) {
 456         pa_log("Error opening mixer: %s", snd_strerror(err));
 457         goto fail;
 458     }
 459
 460     if ((pa_alsa_prepare_mixer(u->mixer_handle, dev) < 0) ||
 461         !(u->mixer_elem = pa_alsa_find_elem(u->mixer_handle, "Capture", "Mic"))) {
 462         snd_mixer_close(u->mixer_handle);
 463         u->mixer_handle = NULL;
 464     }
 465
 466     if ((name = pa_modargs_get_value(ma, "source_name", NULL)))
 467         namereg_fail = 1;
 468     else {
 469         name = name_buf = pa_sprintf_malloc("alsa_input.%s", dev);
 470         namereg_fail = 0;
 471     }
 472
 473     if (!(u->source = pa_source_new(c, __FILE__, name, namereg_fail, &ss, &map))) {
 474         pa_log("Failed to create source object");
 475         goto fail;
 476     }
 477
 478     u->source->is_hardware = 1;
 479     u->source->userdata = u;
 480     u->source->get_latency = source_get_latency_cb;
 481     if (u->mixer_handle) {
 482         assert(u->mixer_elem);
 483         if (snd_mixer_selem_has_capture_volume(u->mixer_elem)) {
 484             int i;
 485
 486             for (i = 0;i < ss.channels;i++) {
 487                 if (!snd_mixer_selem_has_capture_channel(u->mixer_elem, i))
 488                     break;
 489             }
 490
 491             if (i == ss.channels) {
 492                 u->source->get_hw_volume = source_get_hw_volume_cb;
 493                 u->source->set_hw_volume = source_set_hw_volume_cb;
 494                 snd_mixer_selem_get_capture_volume_range(
 495                     u->mixer_elem, &u->hw_volume_min, &u->hw_volume_max);
 496             }
 497         }
 498         if (snd_mixer_selem_has_capture_switch(u->mixer_elem)) {
 499             u->source->get_hw_mute = source_get_hw_mute_cb;
 500             u->source->set_hw_mute = source_set_hw_mute_cb;
 501         }
 502     }
 503     pa_source_set_owner(u->source, m);
 504     pa_source_set_description(u->source, t = pa_sprintf_malloc("ALSA PCM on %s (%s)", dev, snd_pcm_info_get_name(pcm_info)));
 505     pa_xfree(t);
 506
 507     u->pcm_fdl = pa_alsa_fdlist_new();
 508     assert(u->pcm_fdl);
 509     if (pa_alsa_fdlist_init_pcm(u->pcm_fdl, u->pcm_handle, c->mainloop, fdl_callback, u) < 0) {
 510         pa_log("failed to initialise file descriptor monitoring");
 511         goto fail;
 512     }
 513
 514     if (u->mixer_handle) {
 515         u->mixer_fdl = pa_alsa_fdlist_new();
 516         assert(u->mixer_fdl);
 517         if (pa_alsa_fdlist_init_mixer(u->mixer_fdl, u->mixer_handle, c->mainloop) < 0) {
 518             pa_log("failed to initialise file descriptor monitoring");
 519             goto fail;
 520         }
 521         snd_mixer_elem_set_callback(u->mixer_elem, mixer_callback);
 522         snd_mixer_elem_set_callback_private(u->mixer_elem, u);
 523     } else
 524         u->mixer_fdl = NULL;
 525
 526     u->frame_size = frame_size;
 527     u->fragment_size = period_size * frame_size;
 528
 529     pa_log_info("using %u fragments of size %lu bytes.", periods, (long unsigned) u->fragment_size);
 530
 531     u->memchunk.memblock = NULL;
 532     u->memchunk.index = u->memchunk.length = 0;
 533
 534     snd_pcm_start(u->pcm_handle);
 535
 536     ret = 0;
 537
 538     /* Get initial mixer settings */
 539     if (u->source->get_hw_volume)
 540         u->source->get_hw_volume(u->source);
 541     if (u->source->get_hw_mute)
 542         u->source->get_hw_mute(u->source);
 543
 544 finish:
 545     pa_xfree(name_buf);
 546
 547     if (ma)
 548          pa_modargs_free(ma);
 549
 550     if (pcm_info)
 551         snd_pcm_info_free(pcm_info);
 552
 553     return ret;
 554
 555 fail:
 556
 557     if (u)
 558         pa__done(c, m);
 559
 560     goto finish;
 561 }
 562
 563 void pa__done(pa_core *c, pa_module*m) {
 564     struct userdata *u;
 565     assert(c && m);
 566
 567     if (!(u = m->userdata))
 568         return;
 569
 570     clear_up(u);
 571
 572     if (u->memchunk.memblock)
 573         pa_memblock_unref(u->memchunk.memblock);
 574
 575     pa_xfree(u);
 576 }
 577