code.delx.au - pulseaudio/blob - src/modules/module-alsa-source.c

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