src/modules/module-alsa-sink.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.h>
  43 #include <pulsecore/module.h>
  44 #include <pulsecore/memchunk.h>
  45 #include <pulsecore/sink.h>
  46 #include <pulsecore/modargs.h>
  47 #include <pulsecore/core-util.h>
  48 #include <pulsecore/sample-util.h>
  49 #include <pulsecore/log.h>
  50
  51 #include "alsa-util.h"
  52 #include "module-alsa-sink-symdef.h"
  53
  54 PA_MODULE_AUTHOR("Lennart Poettering")
  55 PA_MODULE_DESCRIPTION("ALSA Sink")
  56 PA_MODULE_VERSION(PACKAGE_VERSION)
  57 PA_MODULE_USAGE(
  58         "sink_name=<name for the sink> "
  59         "device=<ALSA device> "
  60         "format=<sample format> "
  61         "channels=<number of channels> "
  62         "rate=<sample rate> "
  63         "fragments=<number of fragments> "
  64         "fragment_size=<fragment size> "
  65         "channel_map=<channel map>")
  66
  67 struct userdata {
  68     snd_pcm_t *pcm_handle;
  69     snd_mixer_t *mixer_handle;
  70     snd_mixer_elem_t *mixer_elem;
  71     pa_sink *sink;
  72     struct pa_alsa_fdlist *pcm_fdl;
  73     struct pa_alsa_fdlist *mixer_fdl;
  74     long hw_volume_max, hw_volume_min;
  75
  76     size_t frame_size, fragment_size;
  77     pa_memchunk memchunk, silence;
  78     pa_module *module;
  79 };
  80
  81 static const char* const valid_modargs[] = {
  82     "device",
  83     "sink_name",
  84     "format",
  85     "channels",
  86     "rate",
  87     "fragments",
  88     "fragment_size",
  89     "channel_map",
  90     NULL
  91 };
  92
  93 #define DEFAULT_DEVICE "default"
  94
  95 static void update_usage(struct userdata *u) {
  96     pa_module_set_used(u->module, u->sink ? pa_sink_used_by(u->sink) : 0);
  97 }
  98
  99 static void clear_up(struct userdata *u) {
 100     assert(u);
 101
 102     if (u->sink) {
 103         pa_sink_disconnect(u->sink);
 104         pa_sink_unref(u->sink);
 105         u->sink = 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("*** ALSA-XRUN (playback) ***");
 132
 133     if ((ret = snd_pcm_prepare(u->pcm_handle)) < 0) {
 134         pa_log("snd_pcm_prepare() failed: %s", snd_strerror(-ret));
 135
 136         clear_up(u);
 137         pa_module_unload_request(u->module);
 138         return -1;
 139     }
 140
 141     return ret;
 142 }
 143
 144 static int suspend_recovery(struct userdata *u) {
 145     int ret;
 146     assert(u);
 147
 148     pa_log_info("*** ALSA-SUSPEND (playback) ***");
 149
 150     if ((ret = snd_pcm_resume(u->pcm_handle)) < 0) {
 151         if (ret == -EAGAIN)
 152             return -1;
 153
 154         if (ret != -ENOSYS)
 155             pa_log("snd_pcm_resume() failed: %s", snd_strerror(-ret));
 156         else {
 157             if ((ret = snd_pcm_prepare(u->pcm_handle)) < 0)
 158                 pa_log("snd_pcm_prepare() failed: %s", snd_strerror(-ret));
 159         }
 160
 161         if (ret < 0) {
 162             clear_up(u);
 163             pa_module_unload_request(u->module);
 164             return -1;
 165         }
 166     }
 167
 168     return ret;
 169 }
 170
 171 static void do_write(struct userdata *u) {
 172     assert(u);
 173
 174     update_usage(u);
 175
 176     for (;;) {
 177         pa_memchunk *memchunk = NULL;
 178         snd_pcm_sframes_t frames;
 179
 180         if (u->memchunk.memblock)
 181             memchunk = &u->memchunk;
 182         else {
 183             if (pa_sink_render(u->sink, u->fragment_size, &u->memchunk) < 0)
 184                 memchunk = &u->silence;
 185             else
 186                 memchunk = &u->memchunk;
 187         }
 188
 189         assert(memchunk->memblock);
 190         assert(memchunk->memblock->data);
 191         assert(memchunk->length);
 192         assert(memchunk->memblock->length);
 193         assert((memchunk->length % u->frame_size) == 0);
 194
 195         if ((frames = snd_pcm_writei(u->pcm_handle, (uint8_t*) memchunk->memblock->data + memchunk->index, 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_writei() failed: %s", snd_strerror(-frames));
 214
 215             clear_up(u);
 216             pa_module_unload_request(u->module);
 217             return;
 218         }
 219
 220         if (memchunk == &u->memchunk) {
 221             size_t l = frames * u->frame_size;
 222             memchunk->index += l;
 223             memchunk->length -= l;
 224
 225             if (memchunk->length == 0) {
 226                 pa_memblock_unref(memchunk->memblock);
 227                 memchunk->memblock = NULL;
 228                 memchunk->index = memchunk->length = 0;
 229             }
 230         }
 231
 232         break;
 233     }
 234 }
 235
 236 static void fdl_callback(void *userdata) {
 237     struct userdata *u = userdata;
 238     assert(u);
 239
 240     if (snd_pcm_state(u->pcm_handle) == SND_PCM_STATE_XRUN)
 241         if (xrun_recovery(u) < 0)
 242             return;
 243
 244     if (snd_pcm_state(u->pcm_handle) == SND_PCM_STATE_SUSPENDED)
 245         if (suspend_recovery(u) < 0)
 246             return;
 247
 248     do_write(u);
 249 }
 250
 251 static int mixer_callback(snd_mixer_elem_t *elem, unsigned int mask) {
 252     struct userdata *u = snd_mixer_elem_get_callback_private(elem);
 253
 254     assert(u && u->mixer_handle);
 255
 256     if (mask == SND_CTL_EVENT_MASK_REMOVE)
 257         return 0;
 258
 259     if (mask & SND_CTL_EVENT_MASK_VALUE) {
 260         if (u->sink->get_hw_volume)
 261             u->sink->get_hw_volume(u->sink);
 262         if (u->sink->get_hw_mute)
 263             u->sink->get_hw_mute(u->sink);
 264         pa_subscription_post(u->sink->core,
 265             PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE,
 266             u->sink->index);
 267     }
 268
 269     return 0;
 270 }
 271
 272 static pa_usec_t sink_get_latency_cb(pa_sink *s) {
 273     pa_usec_t r = 0;
 274     struct userdata *u = s->userdata;
 275     snd_pcm_sframes_t frames;
 276     int err;
 277
 278     assert(s && u && u->sink);
 279
 280     if ((err = snd_pcm_delay(u->pcm_handle, &frames)) < 0) {
 281         pa_log("failed to get delay: %s", snd_strerror(err));
 282         s->get_latency = NULL;
 283         return 0;
 284     }
 285
 286     if (frames < 0)
 287         frames = 0;
 288
 289     r += pa_bytes_to_usec(frames * u->frame_size, &s->sample_spec);
 290
 291     if (u->memchunk.memblock)
 292         r += pa_bytes_to_usec(u->memchunk.length, &s->sample_spec);
 293
 294     return r;
 295 }
 296
 297 static int sink_get_hw_volume_cb(pa_sink *s) {
 298     struct userdata *u = s->userdata;
 299     int err;
 300     int i;
 301
 302     assert(u);
 303     assert(u->mixer_elem);
 304
 305     for (i = 0; i < s->hw_volume.channels; i++) {
 306         long set_vol, vol;
 307
 308         assert(snd_mixer_selem_has_playback_channel(u->mixer_elem, i));
 309
 310         if ((err = snd_mixer_selem_get_playback_volume(u->mixer_elem, i, &vol)) < 0)
 311             goto fail;
 312
 313         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;
 314
 315         /* Try to avoid superfluous volume changes */
 316         if (set_vol != vol)
 317             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));
 318     }
 319
 320     return 0;
 321
 322 fail:
 323     pa_log_error("Unable to read volume: %s", snd_strerror(err));
 324     s->get_hw_volume = NULL;
 325     s->set_hw_volume = NULL;
 326     return -1;
 327 }
 328
 329 static int sink_set_hw_volume_cb(pa_sink *s) {
 330     struct userdata *u = s->userdata;
 331     int err;
 332     int i;
 333     pa_volume_t vol;
 334
 335     assert(u);
 336     assert(u->mixer_elem);
 337
 338     for (i = 0; i < s->hw_volume.channels; i++) {
 339         long alsa_vol;
 340
 341         assert(snd_mixer_selem_has_playback_channel(u->mixer_elem, i));
 342
 343         vol = s->hw_volume.values[i];
 344
 345         if (vol > PA_VOLUME_NORM)
 346             vol = PA_VOLUME_NORM;
 347
 348         alsa_vol = (long) roundf(((float) vol * (u->hw_volume_max - u->hw_volume_min)) / PA_VOLUME_NORM) + u->hw_volume_min;
 349
 350         if ((err = snd_mixer_selem_set_playback_volume(u->mixer_elem, i, alsa_vol)) < 0)
 351             goto fail;
 352     }
 353
 354     return 0;
 355
 356 fail:
 357     pa_log_error("Unable to set volume: %s", snd_strerror(err));
 358     s->get_hw_volume = NULL;
 359     s->set_hw_volume = NULL;
 360     return -1;
 361 }
 362
 363 static int sink_get_hw_mute_cb(pa_sink *s) {
 364     struct userdata *u = s->userdata;
 365     int err, sw;
 366
 367     assert(u && u->mixer_elem);
 368
 369     err = snd_mixer_selem_get_playback_switch(u->mixer_elem, 0, &sw);
 370     if (err) {
 371         pa_log_error("Unable to get switch: %s", snd_strerror(err));
 372         s->get_hw_mute = NULL;
 373         s->set_hw_mute = NULL;
 374         return -1;
 375     }
 376
 377     s->hw_muted = !sw;
 378
 379     return 0;
 380 }
 381
 382 static int sink_set_hw_mute_cb(pa_sink *s) {
 383     struct userdata *u = s->userdata;
 384     int err;
 385
 386     assert(u && u->mixer_elem);
 387
 388     err = snd_mixer_selem_set_playback_switch_all(u->mixer_elem, !s->hw_muted);
 389     if (err) {
 390         pa_log_error("Unable to set switch: %s", snd_strerror(err));
 391         s->get_hw_mute = NULL;
 392         s->set_hw_mute = NULL;
 393         return -1;
 394     }
 395
 396     return 0;
 397 }
 398
 399 int pa__init(pa_core *c, pa_module*m) {
 400     pa_modargs *ma = NULL;
 401     int ret = -1;
 402     struct userdata *u = NULL;
 403     const char *dev;
 404     pa_sample_spec ss;
 405     pa_channel_map map;
 406     uint32_t periods, fragsize;
 407     snd_pcm_uframes_t period_size;
 408     size_t frame_size;
 409     snd_pcm_info_t *pcm_info = NULL;
 410     int err;
 411     char *t;
 412     const char *name;
 413     char *name_buf = NULL;
 414     int namereg_fail;
 415
 416     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 417         pa_log("failed to parse module arguments");
 418         goto fail;
 419     }
 420
 421     ss = c->default_sample_spec;
 422     if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_ALSA) < 0) {
 423         pa_log("failed to parse sample specification and channel map");
 424         goto fail;
 425     }
 426
 427     frame_size = pa_frame_size(&ss);
 428
 429     /* Fix latency to 100ms */
 430     periods = 8;
 431     fragsize = pa_bytes_per_second(&ss)/128;
 432
 433     if (pa_modargs_get_value_u32(ma, "fragments", &periods) < 0 || pa_modargs_get_value_u32(ma, "fragment_size", &fragsize) < 0) {
 434         pa_log("failed to parse buffer metrics");
 435         goto fail;
 436     }
 437     period_size = fragsize/frame_size;
 438
 439     u = pa_xnew0(struct userdata, 1);
 440     m->userdata = u;
 441     u->module = m;
 442
 443     snd_config_update_free_global();
 444     if ((err = snd_pcm_open(&u->pcm_handle, dev = pa_modargs_get_value(ma, "device", DEFAULT_DEVICE), SND_PCM_STREAM_PLAYBACK, SND_PCM_NONBLOCK)) < 0) {
 445         pa_log("Error opening PCM device %s: %s", dev, snd_strerror(err));
 446         goto fail;
 447     }
 448
 449     if ((err = snd_pcm_info_malloc(&pcm_info)) < 0 ||
 450         (err = snd_pcm_info(u->pcm_handle, pcm_info)) < 0) {
 451         pa_log("Error fetching PCM info: %s", snd_strerror(err));
 452         goto fail;
 453     }
 454
 455     if ((err = pa_alsa_set_hw_params(u->pcm_handle, &ss, &periods, &period_size)) < 0) {
 456         pa_log("Failed to set hardware parameters: %s", snd_strerror(err));
 457         goto fail;
 458     }
 459
 460     /* ALSA might tweak the sample spec, so recalculate the frame size */
 461     frame_size = pa_frame_size(&ss);
 462
 463     if (ss.channels != map.channels)
 464         /* Seems ALSA didn't like the channel number, so let's fix the channel map */
 465         pa_channel_map_init_auto(&map, ss.channels, PA_CHANNEL_MAP_ALSA);
 466
 467     if ((err = snd_mixer_open(&u->mixer_handle, 0)) < 0) {
 468         pa_log("Error opening mixer: %s", snd_strerror(err));
 469         goto fail;
 470     }
 471
 472     if ((pa_alsa_prepare_mixer(u->mixer_handle, dev) < 0) ||
 473         !(u->mixer_elem = pa_alsa_find_elem(u->mixer_handle, "PCM", "Master"))) {
 474         snd_mixer_close(u->mixer_handle);
 475         u->mixer_handle = NULL;
 476     }
 477
 478     if ((name = pa_modargs_get_value(ma, "sink_name", NULL)))
 479         namereg_fail = 1;
 480     else {
 481         name = name_buf = pa_sprintf_malloc("alsa_output.%s", dev);
 482         namereg_fail = 0;
 483     }
 484
 485     if (!(u->sink = pa_sink_new(c, __FILE__, name, namereg_fail, &ss, &map))) {
 486         pa_log("Failed to create sink object");
 487         goto fail;
 488     }
 489
 490     u->sink->is_hardware = 1;
 491     u->sink->get_latency = sink_get_latency_cb;
 492     if (u->mixer_handle) {
 493         assert(u->mixer_elem);
 494         if (snd_mixer_selem_has_playback_volume(u->mixer_elem)) {
 495             int i;
 496
 497             for (i = 0;i < ss.channels;i++) {
 498                 if (!snd_mixer_selem_has_playback_channel(u->mixer_elem, i))
 499                     break;
 500             }
 501
 502             if (i == ss.channels) {
 503                 u->sink->get_hw_volume = sink_get_hw_volume_cb;
 504                 u->sink->set_hw_volume = sink_set_hw_volume_cb;
 505                 snd_mixer_selem_get_playback_volume_range(
 506                     u->mixer_elem, &u->hw_volume_min, &u->hw_volume_max);
 507             }
 508         }
 509         if (snd_mixer_selem_has_playback_switch(u->mixer_elem)) {
 510             u->sink->get_hw_mute = sink_get_hw_mute_cb;
 511             u->sink->set_hw_mute = sink_set_hw_mute_cb;
 512         }
 513     }
 514     u->sink->userdata = u;
 515     pa_sink_set_owner(u->sink, m);
 516     pa_sink_set_description(u->sink, t = pa_sprintf_malloc("ALSA PCM on %s (%s)", dev, snd_pcm_info_get_name(pcm_info)));
 517     pa_xfree(t);
 518
 519     u->pcm_fdl = pa_alsa_fdlist_new();
 520     assert(u->pcm_fdl);
 521     if (pa_alsa_fdlist_init_pcm(u->pcm_fdl, u->pcm_handle, c->mainloop, fdl_callback, u) < 0) {
 522         pa_log("failed to initialise file descriptor monitoring");
 523         goto fail;
 524     }
 525
 526     if (u->mixer_handle) {
 527         u->mixer_fdl = pa_alsa_fdlist_new();
 528         assert(u->mixer_fdl);
 529         if (pa_alsa_fdlist_init_mixer(u->mixer_fdl, u->mixer_handle, c->mainloop) < 0) {
 530             pa_log("failed to initialise file descriptor monitoring");
 531             goto fail;
 532         }
 533         snd_mixer_elem_set_callback(u->mixer_elem, mixer_callback);
 534         snd_mixer_elem_set_callback_private(u->mixer_elem, u);
 535     } else
 536         u->mixer_fdl = NULL;
 537
 538     u->frame_size = frame_size;
 539     u->fragment_size = period_size * frame_size;
 540
 541     pa_log_info("using %u fragments of size %lu bytes.", periods, (long unsigned)u->fragment_size);
 542
 543     u->silence.memblock = pa_memblock_new(c->mempool, u->silence.length = u->fragment_size);
 544     assert(u->silence.memblock);
 545     pa_silence_memblock(u->silence.memblock, &ss);
 546     u->silence.index = 0;
 547
 548     u->memchunk.memblock = NULL;
 549     u->memchunk.index = u->memchunk.length = 0;
 550
 551     ret = 0;
 552
 553     /* Get initial mixer settings */
 554     if (u->sink->get_hw_volume)
 555         u->sink->get_hw_volume(u->sink);
 556     if (u->sink->get_hw_mute)
 557         u->sink->get_hw_mute(u->sink);
 558
 559 finish:
 560
 561     pa_xfree(name_buf);
 562
 563      if (ma)
 564          pa_modargs_free(ma);
 565
 566     if (pcm_info)
 567         snd_pcm_info_free(pcm_info);
 568
 569     return ret;
 570
 571 fail:
 572
 573     if (u)
 574         pa__done(c, m);
 575
 576     goto finish;
 577 }
 578
 579 void pa__done(pa_core *c, pa_module*m) {
 580     struct userdata *u;
 581     assert(c && m);
 582
 583     if (!(u = m->userdata))
 584         return;
 585
 586     clear_up(u);
 587
 588     if (u->memchunk.memblock)
 589         pa_memblock_unref(u->memchunk.memblock);
 590     if (u->silence.memblock)
 591         pa_memblock_unref(u->silence.memblock);
 592
 593     pa_xfree(u);
 594 }
 595