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