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     pa_io_event **io_events;
  61     unsigned n_io_events;
  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");
 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 io_callback(pa_mainloop_api*a, pa_io_event *e, PA_GCC_UNUSED int fd, PA_GCC_UNUSED pa_io_event_flags_t f, void *userdata) {
 148     struct userdata *u = userdata;
 149     assert(u && a && e);
 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 pa_usec_t sink_get_latency_cb(pa_sink *s) {
 158     pa_usec_t r = 0;
 159     struct userdata *u = s->userdata;
 160     snd_pcm_sframes_t frames;
 161     assert(s && u && u->sink);
 162
 163     if (snd_pcm_delay(u->pcm_handle, &frames) < 0) {
 164         pa_log(__FILE__": failed to get delay");
 165         s->get_latency = NULL;
 166         return 0;
 167     }
 168
 169     if (frames < 0)
 170         frames = 0;
 171
 172     r += pa_bytes_to_usec(frames * u->frame_size, &s->sample_spec);
 173
 174     if (u->memchunk.memblock)
 175         r += pa_bytes_to_usec(u->memchunk.length, &s->sample_spec);
 176
 177     return r;
 178 }
 179
 180 static int sink_get_hw_volume_cb(pa_sink *s) {
 181     struct userdata *u = s->userdata;
 182     long vol;
 183     int err;
 184
 185     assert(u && u->mixer_elem);
 186
 187     if (snd_mixer_selem_has_playback_volume_joined(u->mixer_elem)) {
 188         err = snd_mixer_selem_get_playback_volume(u->mixer_elem, 0, &vol);
 189         if (err < 0)
 190             goto fail;
 191         pa_cvolume_set(&s->hw_volume, s->hw_volume.channels,
 192             (vol - u->hw_volume_min) * PA_VOLUME_NORM / (u->hw_volume_max - u->hw_volume_min));
 193     } else {
 194         int i;
 195
 196         for (i = 0;i < s->hw_volume.channels;i++) {
 197             err = snd_mixer_selem_get_playback_volume(u->mixer_elem, i, &vol);
 198             if (err < 0)
 199                 goto fail;
 200             s->hw_volume.values[i] =
 201                 (vol - u->hw_volume_min) * PA_VOLUME_NORM / (u->hw_volume_max - u->hw_volume_min);
 202         }
 203     }
 204
 205     return 0;
 206
 207 fail:
 208     pa_log_error(__FILE__": Unable to read volume: %s", snd_strerror(err));
 209     s->get_hw_volume = NULL;
 210     s->set_hw_volume = NULL;
 211     return -1;
 212 }
 213
 214 static int sink_set_hw_volume_cb(pa_sink *s) {
 215     struct userdata *u = s->userdata;
 216     int err;
 217     pa_volume_t vol;
 218
 219     assert(u && u->mixer_elem);
 220
 221     if (snd_mixer_selem_has_playback_volume_joined(u->mixer_elem)) {
 222         vol = pa_cvolume_avg(&s->hw_volume) * (u->hw_volume_max - u->hw_volume_min) /
 223             PA_VOLUME_NORM + u->hw_volume_min;
 224         err = snd_mixer_selem_set_playback_volume_all(u->mixer_elem, vol);
 225         if (err < 0)
 226             goto fail;
 227     } else {
 228         int i;
 229
 230         for (i = 0;i < s->hw_volume.channels;i++) {
 231             vol = s->hw_volume.values[i] * (u->hw_volume_max - u->hw_volume_min) /
 232                 PA_VOLUME_NORM + u->hw_volume_min;
 233             err = snd_mixer_selem_set_playback_volume(u->mixer_elem, i, vol);
 234             if (err < 0)
 235                 goto fail;
 236         }
 237     }
 238
 239     return 0;
 240
 241 fail:
 242     pa_log_error(__FILE__": Unable to set volume: %s", snd_strerror(err));
 243     s->get_hw_volume = NULL;
 244     s->set_hw_volume = NULL;
 245     return -1;
 246 }
 247
 248 static int sink_get_hw_mute_cb(pa_sink *s) {
 249     struct userdata *u = s->userdata;
 250     int err, sw;
 251
 252     assert(u && u->mixer_elem);
 253
 254     err = snd_mixer_selem_get_playback_switch(u->mixer_elem, 0, &sw);
 255     if (err) {
 256         pa_log_error(__FILE__": Unable to get switch: %s", snd_strerror(err));
 257         s->get_hw_mute = NULL;
 258         s->set_hw_mute = NULL;
 259         return -1;
 260     }
 261
 262     s->hw_muted = !sw;
 263
 264     return 0;
 265 }
 266
 267 static int sink_set_hw_mute_cb(pa_sink *s) {
 268     struct userdata *u = s->userdata;
 269     int err;
 270
 271     assert(u && u->mixer_elem);
 272
 273     err = snd_mixer_selem_set_playback_switch_all(u->mixer_elem, !s->hw_muted);
 274     if (err) {
 275         pa_log_error(__FILE__": Unable to set switch: %s", snd_strerror(err));
 276         s->get_hw_mute = NULL;
 277         s->set_hw_mute = NULL;
 278         return -1;
 279     }
 280
 281     return 0;
 282 }
 283
 284 int pa__init(pa_core *c, pa_module*m) {
 285     pa_modargs *ma = NULL;
 286     int ret = -1;
 287     struct userdata *u = NULL;
 288     const char *dev;
 289     pa_sample_spec ss;
 290     uint32_t periods, fragsize;
 291     snd_pcm_uframes_t period_size;
 292     size_t frame_size;
 293     int err;
 294
 295     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 296         pa_log(__FILE__": failed to parse module arguments");
 297         goto fail;
 298     }
 299
 300     ss = c->default_sample_spec;
 301     if (pa_modargs_get_sample_spec(ma, &ss) < 0) {
 302         pa_log(__FILE__": failed to parse sample specification");
 303         goto fail;
 304     }
 305     frame_size = pa_frame_size(&ss);
 306
 307     periods = 8;
 308     fragsize = 1024;
 309     if (pa_modargs_get_value_u32(ma, "fragments", &periods) < 0 || pa_modargs_get_value_u32(ma, "fragment_size", &fragsize) < 0) {
 310         pa_log(__FILE__": failed to parse buffer metrics");
 311         goto fail;
 312     }
 313     period_size = fragsize;
 314
 315     u = pa_xmalloc0(sizeof(struct userdata));
 316     m->userdata = u;
 317     u->module = m;
 318
 319     snd_config_update_free_global();
 320     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) {
 321         pa_log(__FILE__": Error opening PCM device %s: %s", dev, snd_strerror(err));
 322         goto fail;
 323     }
 324
 325     if ((err = pa_alsa_set_hw_params(u->pcm_handle, &ss, &periods, &period_size)) < 0) {
 326         pa_log(__FILE__": Failed to set hardware parameters: %s", snd_strerror(err));
 327         goto fail;
 328     }
 329
 330     if ((err = snd_mixer_open(&u->mixer_handle, 0)) < 0) {
 331         pa_log(__FILE__": Error opening mixer: %s", snd_strerror(err));
 332         goto fail;
 333     }
 334
 335     if ((pa_alsa_prepare_mixer(u->mixer_handle, dev) < 0) ||
 336         !(u->mixer_elem = pa_alsa_find_elem(u->mixer_handle, "PCM"))) {
 337         snd_mixer_close(u->mixer_handle);
 338         u->mixer_handle = NULL;
 339     }
 340
 341     u->sink = pa_sink_new(c, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, NULL);
 342     assert(u->sink);
 343
 344     u->sink->get_latency = sink_get_latency_cb;
 345     if (u->mixer_handle) {
 346         assert(u->mixer_elem);
 347         if (snd_mixer_selem_has_playback_volume(u->mixer_elem)) {
 348             u->sink->get_hw_volume = sink_get_hw_volume_cb;
 349             u->sink->set_hw_volume = sink_set_hw_volume_cb;
 350             snd_mixer_selem_get_playback_volume_range(
 351                 u->mixer_elem, &u->hw_volume_min, &u->hw_volume_max);
 352         }
 353         if (snd_mixer_selem_has_playback_switch(u->mixer_elem)) {
 354             u->sink->get_hw_mute = sink_get_hw_mute_cb;
 355             u->sink->set_hw_mute = sink_set_hw_mute_cb;
 356         }
 357     }
 358     u->sink->userdata = u;
 359     pa_sink_set_owner(u->sink, m);
 360     u->sink->description = pa_sprintf_malloc("Advanced Linux Sound Architecture PCM on '%s'", dev);
 361
 362     if (pa_create_io_events(u->pcm_handle, c->mainloop, &u->io_events, &u->n_io_events, io_callback, u) < 0) {
 363         pa_log(__FILE__": failed to obtain file descriptors");
 364         goto fail;
 365     }
 366
 367     u->frame_size = frame_size;
 368     u->fragment_size = period_size;
 369
 370     pa_log_info(__FILE__": using %u fragments of size %u bytes.", periods, u->fragment_size);
 371
 372     u->silence.memblock = pa_memblock_new(u->silence.length = u->fragment_size, c->memblock_stat);
 373     assert(u->silence.memblock);
 374     pa_silence_memblock(u->silence.memblock, &ss);
 375     u->silence.index = 0;
 376
 377     u->memchunk.memblock = NULL;
 378     u->memchunk.index = u->memchunk.length = 0;
 379
 380     ret = 0;
 381
 382 finish:
 383      if (ma)
 384          pa_modargs_free(ma);
 385
 386     /* Get initial mixer settings */
 387     if (u->sink->get_hw_volume)
 388         u->sink->get_hw_volume(u->sink);
 389     if (u->sink->get_hw_mute)
 390         u->sink->get_hw_mute(u->sink);
 391
 392     return ret;
 393
 394 fail:
 395
 396     if (u)
 397         pa__done(c, m);
 398
 399     goto finish;
 400 }
 401
 402 void pa__done(pa_core *c, pa_module*m) {
 403     struct userdata *u;
 404     assert(c && m);
 405
 406     if (!(u = m->userdata))
 407         return;
 408
 409     if (u->sink) {
 410         pa_sink_disconnect(u->sink);
 411         pa_sink_unref(u->sink);
 412     }
 413
 414     if (u->io_events)
 415         pa_free_io_events(c->mainloop, u->io_events, u->n_io_events);
 416
 417     if (u->mixer_handle)
 418         snd_mixer_close(u->mixer_handle);
 419
 420     if (u->pcm_handle) {
 421         snd_pcm_drop(u->pcm_handle);
 422         snd_pcm_close(u->pcm_handle);
 423     }
 424
 425     if (u->memchunk.memblock)
 426         pa_memblock_unref(u->memchunk.memblock);
 427     if (u->silence.memblock)
 428         pa_memblock_unref(u->silence.memblock);
 429
 430     pa_xfree(u);
 431 }
 432