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