src/modules/module-alsa-sink.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   PulseAudio 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   PulseAudio 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 PulseAudio; 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 <pulse/xmalloc.h>
  38
  39 #include <pulsecore/core.h>
  40 #include <pulsecore/module.h>
  41 #include <pulsecore/memchunk.h>
  42 #include <pulsecore/sink.h>
  43 #include <pulsecore/modargs.h>
  44 #include <pulsecore/core-util.h>
  45 #include <pulsecore/sample-util.h>
  46 #include <pulsecore/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 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(__FILE__": *** ALSA-XRUN (playback) ***");
 132
 133     if ((ret = snd_pcm_prepare(u->pcm_handle)) < 0) {
 134         pa_log(__FILE__": 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 void do_write(struct userdata *u) {
 145     assert(u);
 146
 147     update_usage(u);
 148
 149     for (;;) {
 150         pa_memchunk *memchunk = NULL;
 151         snd_pcm_sframes_t frames;
 152
 153         if (u->memchunk.memblock)
 154             memchunk = &u->memchunk;
 155         else {
 156             if (pa_sink_render(u->sink, u->fragment_size, &u->memchunk) < 0)
 157                 memchunk = &u->silence;
 158             else
 159                 memchunk = &u->memchunk;
 160         }
 161
 162         assert(memchunk->memblock && memchunk->memblock->data && memchunk->length && memchunk->memblock->length && (memchunk->length % u->frame_size) == 0);
 163
 164         if ((frames = snd_pcm_writei(u->pcm_handle, (uint8_t*) memchunk->memblock->data + memchunk->index, memchunk->length / u->frame_size)) < 0) {
 165             if (frames == -EAGAIN)
 166                 return;
 167
 168             if (frames == -EPIPE) {
 169                 if (xrun_recovery(u) < 0)
 170                     return;
 171
 172                 continue;
 173             }
 174
 175             pa_log(__FILE__": snd_pcm_writei() failed: %s", snd_strerror(-frames));
 176
 177             clear_up(u);
 178             pa_module_unload_request(u->module);
 179             return;
 180         }
 181
 182         if (memchunk == &u->memchunk) {
 183             size_t l = frames * u->frame_size;
 184             memchunk->index += l;
 185             memchunk->length -= l;
 186
 187             if (memchunk->length == 0) {
 188                 pa_memblock_unref(memchunk->memblock);
 189                 memchunk->memblock = NULL;
 190                 memchunk->index = memchunk->length = 0;
 191             }
 192         }
 193
 194         break;
 195     }
 196 }
 197
 198 static void fdl_callback(void *userdata) {
 199     struct userdata *u = userdata;
 200     assert(u);
 201
 202     if (snd_pcm_state(u->pcm_handle) == SND_PCM_STATE_XRUN)
 203         if (xrun_recovery(u) < 0)
 204             return;
 205
 206     do_write(u);
 207 }
 208
 209 static int mixer_callback(snd_mixer_elem_t *elem, unsigned int mask) {
 210     struct userdata *u = snd_mixer_elem_get_callback_private(elem);
 211
 212     assert(u && u->mixer_handle);
 213
 214     if (mask == SND_CTL_EVENT_MASK_REMOVE)
 215         return 0;
 216
 217     if (mask & SND_CTL_EVENT_MASK_VALUE) {
 218         if (u->sink->get_hw_volume)
 219             u->sink->get_hw_volume(u->sink);
 220         if (u->sink->get_hw_mute)
 221             u->sink->get_hw_mute(u->sink);
 222         pa_subscription_post(u->sink->core,
 223             PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE,
 224             u->sink->index);
 225     }
 226
 227     return 0;
 228 }
 229
 230 static pa_usec_t sink_get_latency_cb(pa_sink *s) {
 231     pa_usec_t r = 0;
 232     struct userdata *u = s->userdata;
 233     snd_pcm_sframes_t frames;
 234     int err;
 235
 236     assert(s && u && u->sink);
 237
 238     if ((err = snd_pcm_delay(u->pcm_handle, &frames)) < 0) {
 239         pa_log(__FILE__": failed to get delay: %s", snd_strerror(err));
 240         s->get_latency = NULL;
 241         return 0;
 242     }
 243
 244     if (frames < 0)
 245         frames = 0;
 246
 247     r += pa_bytes_to_usec(frames * u->frame_size, &s->sample_spec);
 248
 249     if (u->memchunk.memblock)
 250         r += pa_bytes_to_usec(u->memchunk.length, &s->sample_spec);
 251
 252     return r;
 253 }
 254
 255 static int sink_get_hw_volume_cb(pa_sink *s) {
 256     struct userdata *u = s->userdata;
 257     int err;
 258     int i;
 259
 260     assert(u);
 261     assert(u->mixer_elem);
 262
 263     for (i = 0; i < s->hw_volume.channels; i++) {
 264         long set_vol, vol;
 265
 266         assert(snd_mixer_selem_has_playback_channel(u->mixer_elem, i));
 267
 268         if ((err = snd_mixer_selem_get_playback_volume(u->mixer_elem, i, &vol)) < 0)
 269             goto fail;
 270
 271         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;
 272
 273         /* Try to avoid superfluous volume changes */
 274         if (set_vol != vol)
 275             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));
 276     }
 277
 278     return 0;
 279
 280 fail:
 281     pa_log_error(__FILE__": Unable to read volume: %s", snd_strerror(err));
 282     s->get_hw_volume = NULL;
 283     s->set_hw_volume = NULL;
 284     return -1;
 285 }
 286
 287 static int sink_set_hw_volume_cb(pa_sink *s) {
 288     struct userdata *u = s->userdata;
 289     int err;
 290     int i;
 291     pa_volume_t vol;
 292
 293     assert(u);
 294     assert(u->mixer_elem);
 295
 296     for (i = 0; i < s->hw_volume.channels; i++) {
 297         long alsa_vol;
 298
 299         assert(snd_mixer_selem_has_playback_channel(u->mixer_elem, i));
 300
 301         vol = s->hw_volume.values[i];
 302
 303         if (vol > PA_VOLUME_NORM)
 304             vol = PA_VOLUME_NORM;
 305
 306         alsa_vol = (long) roundf(((float) vol * (u->hw_volume_max - u->hw_volume_min)) / PA_VOLUME_NORM) + u->hw_volume_min;
 307
 308         if ((err = snd_mixer_selem_set_playback_volume(u->mixer_elem, i, alsa_vol)) < 0)
 309             goto fail;
 310     }
 311
 312     return 0;
 313
 314 fail:
 315     pa_log_error(__FILE__": Unable to set volume: %s", snd_strerror(err));
 316     s->get_hw_volume = NULL;
 317     s->set_hw_volume = NULL;
 318     return -1;
 319 }
 320
 321 static int sink_get_hw_mute_cb(pa_sink *s) {
 322     struct userdata *u = s->userdata;
 323     int err, sw;
 324
 325     assert(u && u->mixer_elem);
 326
 327     err = snd_mixer_selem_get_playback_switch(u->mixer_elem, 0, &sw);
 328     if (err) {
 329         pa_log_error(__FILE__": Unable to get switch: %s", snd_strerror(err));
 330         s->get_hw_mute = NULL;
 331         s->set_hw_mute = NULL;
 332         return -1;
 333     }
 334
 335     s->hw_muted = !sw;
 336
 337     return 0;
 338 }
 339
 340 static int sink_set_hw_mute_cb(pa_sink *s) {
 341     struct userdata *u = s->userdata;
 342     int err;
 343
 344     assert(u && u->mixer_elem);
 345
 346     err = snd_mixer_selem_set_playback_switch_all(u->mixer_elem, !s->hw_muted);
 347     if (err) {
 348         pa_log_error(__FILE__": Unable to set switch: %s", snd_strerror(err));
 349         s->get_hw_mute = NULL;
 350         s->set_hw_mute = NULL;
 351         return -1;
 352     }
 353
 354     return 0;
 355 }
 356
 357 int pa__init(pa_core *c, pa_module*m) {
 358     pa_modargs *ma = NULL;
 359     int ret = -1;
 360     struct userdata *u = NULL;
 361     const char *dev;
 362     pa_sample_spec ss;
 363     pa_channel_map map;
 364     uint32_t periods, fragsize;
 365     snd_pcm_uframes_t period_size;
 366     size_t frame_size;
 367     snd_pcm_info_t *pcm_info = NULL;
 368     int err;
 369
 370     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 371         pa_log(__FILE__": failed to parse module arguments");
 372         goto fail;
 373     }
 374
 375     ss = c->default_sample_spec;
 376     if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_ALSA) < 0) {
 377         pa_log(__FILE__": failed to parse sample specification and channel map");
 378         goto fail;
 379     }
 380
 381     frame_size = pa_frame_size(&ss);
 382
 383     /* Fix latency to 100ms */
 384     periods = 8;
 385     fragsize = pa_bytes_per_second(&ss)/128;
 386
 387     if (pa_modargs_get_value_u32(ma, "fragments", &periods) < 0 || pa_modargs_get_value_u32(ma, "fragment_size", &fragsize) < 0) {
 388         pa_log(__FILE__": failed to parse buffer metrics");
 389         goto fail;
 390     }
 391     period_size = fragsize/frame_size;
 392
 393     u = pa_xnew0(struct userdata, 1);
 394     m->userdata = u;
 395     u->module = m;
 396
 397     snd_config_update_free_global();
 398     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) {
 399         pa_log(__FILE__": Error opening PCM device %s: %s", dev, snd_strerror(err));
 400         goto fail;
 401     }
 402
 403     if ((err = snd_pcm_info_malloc(&pcm_info)) < 0 ||
 404         (err = snd_pcm_info(u->pcm_handle, pcm_info)) < 0) {
 405         pa_log(__FILE__": Error fetching PCM info: %s", snd_strerror(err));
 406         goto fail;
 407     }
 408
 409     if ((err = pa_alsa_set_hw_params(u->pcm_handle, &ss, &periods, &period_size)) < 0) {
 410         pa_log(__FILE__": Failed to set hardware parameters: %s", snd_strerror(err));
 411         goto fail;
 412     }
 413
 414     if (ss.channels != map.channels)
 415         /* Seems ALSA didn't like the channel number, so let's fix the channel map */
 416         pa_channel_map_init_auto(&map, ss.channels, PA_CHANNEL_MAP_ALSA);
 417
 418     if ((err = snd_mixer_open(&u->mixer_handle, 0)) < 0) {
 419         pa_log(__FILE__": Error opening mixer: %s", snd_strerror(err));
 420         goto fail;
 421     }
 422
 423     if ((pa_alsa_prepare_mixer(u->mixer_handle, dev) < 0) ||
 424         !(u->mixer_elem = pa_alsa_find_elem(u->mixer_handle, "PCM", "Master"))) {
 425         snd_mixer_close(u->mixer_handle);
 426         u->mixer_handle = NULL;
 427     }
 428
 429     if (!(u->sink = pa_sink_new(c, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, &map))) {
 430         pa_log(__FILE__": Failed to create sink object");
 431         goto fail;
 432     }
 433
 434     u->sink->is_hardware = 1;
 435     u->sink->get_latency = sink_get_latency_cb;
 436     if (u->mixer_handle) {
 437         assert(u->mixer_elem);
 438         if (snd_mixer_selem_has_playback_volume(u->mixer_elem)) {
 439             int i;
 440
 441             for (i = 0;i < ss.channels;i++) {
 442                 if (!snd_mixer_selem_has_playback_channel(u->mixer_elem, i))
 443                     break;
 444             }
 445
 446             if (i == ss.channels) {
 447                 u->sink->get_hw_volume = sink_get_hw_volume_cb;
 448                 u->sink->set_hw_volume = sink_set_hw_volume_cb;
 449                 snd_mixer_selem_get_playback_volume_range(
 450                     u->mixer_elem, &u->hw_volume_min, &u->hw_volume_max);
 451             }
 452         }
 453         if (snd_mixer_selem_has_playback_switch(u->mixer_elem)) {
 454             u->sink->get_hw_mute = sink_get_hw_mute_cb;
 455             u->sink->set_hw_mute = sink_set_hw_mute_cb;
 456         }
 457     }
 458     u->sink->userdata = u;
 459     pa_sink_set_owner(u->sink, m);
 460     u->sink->description = pa_sprintf_malloc("ALSA PCM on %s (%s)", dev, snd_pcm_info_get_name(pcm_info));
 461
 462     u->pcm_fdl = pa_alsa_fdlist_new();
 463     assert(u->pcm_fdl);
 464     if (pa_alsa_fdlist_init_pcm(u->pcm_fdl, u->pcm_handle, c->mainloop, fdl_callback, u) < 0) {
 465         pa_log(__FILE__": failed to initialise file descriptor monitoring");
 466         goto fail;
 467     }
 468
 469     if (u->mixer_handle) {
 470         u->mixer_fdl = pa_alsa_fdlist_new();
 471         assert(u->mixer_fdl);
 472         if (pa_alsa_fdlist_init_mixer(u->mixer_fdl, u->mixer_handle, c->mainloop) < 0) {
 473             pa_log(__FILE__": failed to initialise file descriptor monitoring");
 474             goto fail;
 475         }
 476         snd_mixer_elem_set_callback(u->mixer_elem, mixer_callback);
 477         snd_mixer_elem_set_callback_private(u->mixer_elem, u);
 478     } else
 479         u->mixer_fdl = NULL;
 480
 481     u->frame_size = frame_size;
 482     u->fragment_size = period_size * frame_size;
 483
 484     pa_log_info(__FILE__": using %u fragments of size %lu bytes.", periods, (long unsigned)u->fragment_size);
 485
 486     u->silence.memblock = pa_memblock_new(u->silence.length = u->fragment_size, c->memblock_stat);
 487     assert(u->silence.memblock);
 488     pa_silence_memblock(u->silence.memblock, &ss);
 489     u->silence.index = 0;
 490
 491     u->memchunk.memblock = NULL;
 492     u->memchunk.index = u->memchunk.length = 0;
 493
 494     ret = 0;
 495
 496     /* Get initial mixer settings */
 497     if (u->sink->get_hw_volume)
 498         u->sink->get_hw_volume(u->sink);
 499     if (u->sink->get_hw_mute)
 500         u->sink->get_hw_mute(u->sink);
 501
 502 finish:
 503      if (ma)
 504          pa_modargs_free(ma);
 505
 506     if (pcm_info)
 507         snd_pcm_info_free(pcm_info);
 508
 509     return ret;
 510
 511 fail:
 512
 513     if (u)
 514         pa__done(c, m);
 515
 516     goto finish;
 517 }
 518
 519 void pa__done(pa_core *c, pa_module*m) {
 520     struct userdata *u;
 521     assert(c && m);
 522
 523     if (!(u = m->userdata))
 524         return;
 525
 526     clear_up(u);
 527
 528     if (u->memchunk.memblock)
 529         pa_memblock_unref(u->memchunk.memblock);
 530     if (u->silence.memblock)
 531         pa_memblock_unref(u->silence.memblock);
 532
 533     pa_xfree(u);
 534 }
 535