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