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