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