src/modules/module-alsa-source.c

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