code.delx.au - pulseaudio/blob - src/modules/module-alsa-sink.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   Copyright 2004-2006 Lennart Poettering
   7   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   8
   9   PulseAudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as published
  11   by the Free Software Foundation; either version 2 of the License,
  12   or (at your option) any later version.
  13
  14   PulseAudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with PulseAudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include <config.h>
  27 #endif
  28
  29 #include <stdio.h>
  30
  31 #include <asoundlib.h>
  32
  33 #include <pulse/xmalloc.h>
  34 #include <pulse/util.h>
  35
  36 #include <pulsecore/core.h>
  37 #include <pulsecore/module.h>
  38 #include <pulsecore/memchunk.h>
  39 #include <pulsecore/sink.h>
  40 #include <pulsecore/modargs.h>
  41 #include <pulsecore/core-util.h>
  42 #include <pulsecore/sample-util.h>
  43 #include <pulsecore/log.h>
  44 #include <pulsecore/macro.h>
  45 #include <pulsecore/thread.h>
  46 #include <pulsecore/core-error.h>
  47 #include <pulsecore/thread-mq.h>
  48 #include <pulsecore/rtpoll.h>
  49
  50 #include "alsa-util.h"
  51 #include "module-alsa-sink-symdef.h"
  52
  53 PA_MODULE_AUTHOR("Lennart Poettering")
  54 PA_MODULE_DESCRIPTION("ALSA Sink")
  55 PA_MODULE_VERSION(PACKAGE_VERSION)
  56 PA_MODULE_USAGE(
  57         "sink_name=<name for the sink> "
  58         "device=<ALSA device> "
  59         "format=<sample format> "
  60         "channels=<number of channels> "
  61         "rate=<sample rate> "
  62         "fragments=<number of fragments> "
  63         "fragment_size=<fragment size> "
  64         "channel_map=<channel map> "
  65         "mmap=<enable memory mapping?>")
  66
  67 #define DEFAULT_DEVICE "default"
  68
  69 struct userdata {
  70     pa_core *core;
  71     pa_module *module;
  72     pa_sink *sink;
  73
  74     pa_thread *thread;
  75     pa_thread_mq thread_mq;
  76     pa_rtpoll *rtpoll;
  77
  78     snd_pcm_t *pcm_handle;
  79
  80     pa_alsa_fdlist *mixer_fdl;
  81     snd_mixer_t *mixer_handle;
  82     snd_mixer_elem_t *mixer_elem;
  83     long hw_volume_max, hw_volume_min;
  84
  85     size_t frame_size, fragment_size, hwbuf_size;
  86     unsigned nfragments;
  87     pa_memchunk memchunk;
  88
  89     char *device_name;
  90
  91     int use_mmap;
  92
  93     int first;
  94
  95     pa_rtpoll_item *alsa_rtpoll_item;
  96 };
  97
  98 static const char* const valid_modargs[] = {
  99     "device",
 100     "sink_name",
 101     "format",
 102     "channels",
 103     "rate",
 104     "fragments",
 105     "fragment_size",
 106     "channel_map",
 107     "mmap",
 108     NULL
 109 };
 110
 111 static int mmap_write(struct userdata *u) {
 112     int work_done = 0;
 113
 114     pa_assert(u);
 115     pa_sink_assert_ref(u->sink);
 116
 117     for (;;) {
 118         pa_memchunk chunk;
 119         void *p;
 120         snd_pcm_sframes_t n;
 121         int err;
 122         const snd_pcm_channel_area_t *areas;
 123         snd_pcm_uframes_t offset, frames;
 124
 125         if ((n = snd_pcm_avail_update(u->pcm_handle)) < 0) {
 126
 127             if (n == -EPIPE) {
 128                 pa_log_debug("snd_pcm_avail_update: Buffer underrun!");
 129                 u->first = 1;
 130             }
 131
 132             if ((err = snd_pcm_recover(u->pcm_handle, n, 1)) == 0)
 133                 continue;
 134
 135             if (err == -EAGAIN)
 136                 return work_done;
 137
 138             pa_log("snd_pcm_avail_update: %s", snd_strerror(err));
 139             return -1;
 140         }
 141
 142 /*         pa_log("Got request for %i samples", (int) n); */
 143
 144         if (n <= 0)
 145             return work_done;
 146
 147         frames = n;
 148
 149         if ((err = snd_pcm_mmap_begin(u->pcm_handle, &areas, &offset, &frames)) < 0) {
 150
 151             if (err == -EPIPE) {
 152                 pa_log_debug("snd_pcm_mmap_begin: Buffer underrun!");
 153                 u->first = 1;
 154             }
 155
 156             if ((err = snd_pcm_recover(u->pcm_handle, err, 1)) == 0)
 157                 continue;
 158
 159             if (err == -EAGAIN)
 160                 return work_done;
 161
 162             pa_log("Failed to write data to DSP: %s", snd_strerror(err));
 163             return -1;
 164         }
 165
 166         /* Check these are multiples of 8 bit */
 167         pa_assert((areas[0].first & 7) == 0);
 168         pa_assert((areas[0].step & 7)== 0);
 169
 170         /* We assume a single interleaved memory buffer */
 171         pa_assert((areas[0].first >> 3) == 0);
 172         pa_assert((areas[0].step >> 3) == u->frame_size);
 173
 174         p = (uint8_t*) areas[0].addr + (offset * u->frame_size);
 175
 176         chunk.memblock = pa_memblock_new_fixed(u->core->mempool, p, frames * u->frame_size, 1);
 177         chunk.length = pa_memblock_get_length(chunk.memblock);
 178         chunk.index = 0;
 179
 180         pa_sink_render_into_full(u->sink, &chunk);
 181
 182         /* FIXME: Maybe we can do something to keep this memory block
 183          * a little bit longer around? */
 184         pa_memblock_unref_fixed(chunk.memblock);
 185
 186         if ((err = snd_pcm_mmap_commit(u->pcm_handle, offset, frames)) < 0) {
 187
 188             if (err == -EPIPE) {
 189                 pa_log_debug("snd_pcm_mmap_commit: Buffer underrun!");
 190                 u->first = 1;
 191             }
 192
 193             if ((err = snd_pcm_recover(u->pcm_handle, err, 1)) == 0)
 194                 continue;
 195
 196             if (err == -EAGAIN)
 197                 return work_done;
 198
 199             pa_log("Failed to write data to DSP: %s", snd_strerror(err));
 200             return -1;
 201         }
 202
 203         work_done = 1;
 204
 205         if (frames >= (snd_pcm_uframes_t) n)
 206             return work_done;
 207
 208 /*         pa_log("wrote %i samples", (int) frames); */
 209     }
 210 }
 211
 212 static int unix_write(struct userdata *u) {
 213     snd_pcm_status_t *status;
 214     int work_done = 0;
 215
 216     snd_pcm_status_alloca(&status);
 217
 218     pa_assert(u);
 219     pa_sink_assert_ref(u->sink);
 220
 221     for (;;) {
 222         void *p;
 223         snd_pcm_sframes_t t;
 224         ssize_t l;
 225         int err;
 226
 227         if ((err = snd_pcm_status(u->pcm_handle, status)) < 0) {
 228             pa_log("Failed to query DSP status data: %s", snd_strerror(err));
 229             return -1;
 230         }
 231
 232         if (snd_pcm_status_get_avail_max(status)*u->frame_size >= u->hwbuf_size)
 233             pa_log_debug("Buffer underrun!");
 234
 235         l = snd_pcm_status_get_avail(status) * u->frame_size;
 236
 237 /*         pa_log("%u bytes to write", l); */
 238
 239         if (l <= 0)
 240             return work_done;
 241
 242         if (u->memchunk.length <= 0)
 243             pa_sink_render(u->sink, l, &u->memchunk);
 244
 245         pa_assert(u->memchunk.length > 0);
 246
 247         p = pa_memblock_acquire(u->memchunk.memblock);
 248         t = snd_pcm_writei(u->pcm_handle, (const uint8_t*) p + u->memchunk.index, u->memchunk.length / u->frame_size);
 249         pa_memblock_release(u->memchunk.memblock);
 250
 251 /*         pa_log("wrote %i bytes of %u (%u)", t*u->frame_size, u->memchunk.length, l); */
 252
 253         pa_assert(t != 0);
 254
 255         if (t < 0) {
 256
 257             if ((t = snd_pcm_recover(u->pcm_handle, t, 1)) == 0)
 258                 continue;
 259
 260             if (t == -EAGAIN) {
 261                 pa_log_debug("EAGAIN");
 262                 return work_done;
 263             } else {
 264                 pa_log("Failed to write data to DSP: %s", snd_strerror(t));
 265                 return -1;
 266             }
 267         }
 268
 269         u->memchunk.index += t * u->frame_size;
 270         u->memchunk.length -= t * u->frame_size;
 271
 272         if (u->memchunk.length <= 0) {
 273             pa_memblock_unref(u->memchunk.memblock);
 274             pa_memchunk_reset(&u->memchunk);
 275         }
 276
 277         work_done = 1;
 278
 279         if (t * u->frame_size >= (unsigned) l)
 280             return work_done;
 281     }
 282 }
 283
 284 static pa_usec_t sink_get_latency(struct userdata *u) {
 285     pa_usec_t r = 0;
 286     snd_pcm_status_t *status;
 287     snd_pcm_sframes_t frames = 0;
 288     int err;
 289
 290     snd_pcm_status_alloca(&status);
 291
 292     pa_assert(u);
 293     pa_assert(u->pcm_handle);
 294
 295     if ((err = snd_pcm_status(u->pcm_handle, status)) < 0)
 296         pa_log("Failed to get delay: %s", snd_strerror(err));
 297     else
 298         frames = snd_pcm_status_get_delay(status);
 299
 300     if (frames > 0)
 301         r = pa_bytes_to_usec(frames * u->frame_size, &u->sink->sample_spec);
 302
 303     if (u->memchunk.memblock)
 304         r += pa_bytes_to_usec(u->memchunk.length, &u->sink->sample_spec);
 305
 306     return r;
 307 }
 308
 309 static int build_pollfd(struct userdata *u) {
 310     int err;
 311     struct pollfd *pollfd;
 312     int n;
 313
 314     pa_assert(u);
 315     pa_assert(u->pcm_handle);
 316
 317     if ((n = snd_pcm_poll_descriptors_count(u->pcm_handle)) < 0) {
 318         pa_log("snd_pcm_poll_descriptors_count() failed: %s", snd_strerror(n));
 319         return -1;
 320     }
 321
 322     if (u->alsa_rtpoll_item)
 323         pa_rtpoll_item_free(u->alsa_rtpoll_item);
 324
 325     u->alsa_rtpoll_item = pa_rtpoll_item_new(u->rtpoll, PA_RTPOLL_NEVER, n);
 326     pollfd = pa_rtpoll_item_get_pollfd(u->alsa_rtpoll_item, NULL);
 327
 328     if ((err = snd_pcm_poll_descriptors(u->pcm_handle, pollfd, n)) < 0) {
 329         pa_log("snd_pcm_poll_descriptors() failed: %s", snd_strerror(err));
 330         return -1;
 331     }
 332
 333     return 0;
 334 }
 335
 336 static int suspend(struct userdata *u) {
 337     pa_assert(u);
 338     pa_assert(u->pcm_handle);
 339
 340     /* Let's suspend */
 341     snd_pcm_drain(u->pcm_handle);
 342     snd_pcm_close(u->pcm_handle);
 343     u->pcm_handle = NULL;
 344
 345     if (u->alsa_rtpoll_item) {
 346         pa_rtpoll_item_free(u->alsa_rtpoll_item);
 347         u->alsa_rtpoll_item = NULL;
 348     }
 349
 350     pa_log_info("Device suspended...");
 351
 352     return 0;
 353 }
 354
 355 static int unsuspend(struct userdata *u) {
 356     pa_sample_spec ss;
 357     int err, b;
 358     unsigned nfrags;
 359     snd_pcm_uframes_t period_size;
 360
 361     pa_assert(u);
 362     pa_assert(!u->pcm_handle);
 363
 364     pa_log_info("Trying resume...");
 365
 366     snd_config_update_free_global();
 367     if ((err = snd_pcm_open(&u->pcm_handle, u->device_name, SND_PCM_STREAM_PLAYBACK, SND_PCM_NONBLOCK)) < 0) {
 368         pa_log("Error opening PCM device %s: %s", u->device_name, snd_strerror(err));
 369         goto fail;
 370     }
 371
 372     ss = u->sink->sample_spec;
 373     nfrags = u->nfragments;
 374     period_size = u->fragment_size / u->frame_size;
 375     b = u->use_mmap;
 376
 377     if ((err = pa_alsa_set_hw_params(u->pcm_handle, &ss, &nfrags, &period_size, &b)) < 0) {
 378         pa_log("Failed to set hardware parameters: %s", snd_strerror(err));
 379         goto fail;
 380     }
 381
 382     if (b != u->use_mmap) {
 383         pa_log_warn("Resume failed, couldn't get original access mode.");
 384         goto fail;
 385     }
 386
 387     if (!pa_sample_spec_equal(&ss, &u->sink->sample_spec)) {
 388         pa_log_warn("Resume failed, couldn't restore original sample settings.");
 389         goto fail;
 390     }
 391
 392     if (nfrags != u->nfragments || period_size*u->frame_size != u->fragment_size) {
 393         pa_log_warn("Resume failed, couldn't restore original fragment settings.");
 394         goto fail;
 395     }
 396
 397     if ((err = pa_alsa_set_sw_params(u->pcm_handle)) < 0) {
 398         pa_log("Failed to set software parameters: %s", snd_strerror(err));
 399         goto fail;
 400     }
 401
 402     if (build_pollfd(u) < 0)
 403         goto fail;
 404
 405     /* FIXME: We need to reload the volume somehow */
 406
 407     u->first = 1;
 408
 409     pa_log_info("Resumed successfully...");
 410
 411     return 0;
 412
 413 fail:
 414     if (u->pcm_handle) {
 415         snd_pcm_close(u->pcm_handle);
 416         u->pcm_handle = NULL;
 417     }
 418
 419     return -1;
 420 }
 421
 422 static int sink_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
 423     struct userdata *u = PA_SINK(o)->userdata;
 424
 425     switch (code) {
 426
 427         case PA_SINK_MESSAGE_GET_LATENCY: {
 428             pa_usec_t r = 0;
 429
 430             if (u->pcm_handle)
 431                 r = sink_get_latency(u);
 432
 433             *((pa_usec_t*) data) = r;
 434
 435             return 0;
 436         }
 437
 438         case PA_SINK_MESSAGE_SET_STATE:
 439
 440             switch ((pa_sink_state_t) PA_PTR_TO_UINT(data)) {
 441
 442                 case PA_SINK_SUSPENDED:
 443                     pa_assert(PA_SINK_OPENED(u->sink->thread_info.state));
 444
 445                     if (suspend(u) < 0)
 446                         return -1;
 447
 448                     break;
 449
 450                 case PA_SINK_IDLE:
 451                 case PA_SINK_RUNNING:
 452
 453                     if (u->sink->thread_info.state == PA_SINK_INIT) {
 454                         if (build_pollfd(u) < 0)
 455                             return -1;
 456                     }
 457
 458                     if (u->sink->thread_info.state == PA_SINK_SUSPENDED) {
 459                         if (unsuspend(u) < 0)
 460                             return -1;
 461                     }
 462
 463                     break;
 464
 465                 case PA_SINK_UNLINKED:
 466                 case PA_SINK_INIT:
 467                     ;
 468             }
 469
 470             break;
 471     }
 472
 473     return pa_sink_process_msg(o, code, data, offset, chunk);
 474 }
 475
 476 static int mixer_callback(snd_mixer_elem_t *elem, unsigned int mask) {
 477     struct userdata *u = snd_mixer_elem_get_callback_private(elem);
 478
 479     pa_assert(u);
 480     pa_assert(u->mixer_handle);
 481
 482     if (mask == SND_CTL_EVENT_MASK_REMOVE)
 483         return 0;
 484
 485     if (mask & SND_CTL_EVENT_MASK_VALUE) {
 486         pa_sink_get_volume(u->sink);
 487         pa_sink_get_mute(u->sink);
 488     }
 489
 490     return 0;
 491 }
 492
 493 static int sink_get_volume_cb(pa_sink *s) {
 494     struct userdata *u = s->userdata;
 495     int err;
 496     int i;
 497
 498     pa_assert(u);
 499     pa_assert(u->mixer_elem);
 500
 501     for (i = 0; i < s->sample_spec.channels; i++) {
 502         long set_vol, vol;
 503
 504         pa_assert(snd_mixer_selem_has_playback_channel(u->mixer_elem, i));
 505
 506         if ((err = snd_mixer_selem_get_playback_volume(u->mixer_elem, i, &vol)) < 0)
 507             goto fail;
 508
 509         set_vol = (long) roundf(((float) s->volume.values[i] * (u->hw_volume_max - u->hw_volume_min)) / PA_VOLUME_NORM) + u->hw_volume_min;
 510
 511         /* Try to avoid superfluous volume changes */
 512         if (set_vol != vol)
 513             s->volume.values[i] = (pa_volume_t) roundf(((float) (vol - u->hw_volume_min) * PA_VOLUME_NORM) / (u->hw_volume_max - u->hw_volume_min));
 514     }
 515
 516     return 0;
 517
 518 fail:
 519     pa_log_error("Unable to read volume: %s", snd_strerror(err));
 520
 521     s->get_volume = NULL;
 522     s->set_volume = NULL;
 523     return -1;
 524 }
 525
 526 static int sink_set_volume_cb(pa_sink *s) {
 527     struct userdata *u = s->userdata;
 528     int err;
 529     int i;
 530
 531     pa_assert(u);
 532     pa_assert(u->mixer_elem);
 533
 534     for (i = 0; i < s->sample_spec.channels; i++) {
 535         long alsa_vol;
 536         pa_volume_t vol;
 537
 538         pa_assert(snd_mixer_selem_has_playback_channel(u->mixer_elem, i));
 539
 540         vol = s->volume.values[i];
 541
 542         if (vol > PA_VOLUME_NORM)
 543             vol = PA_VOLUME_NORM;
 544
 545         alsa_vol = (long) roundf(((float) vol * (u->hw_volume_max - u->hw_volume_min)) / PA_VOLUME_NORM) + u->hw_volume_min;
 546
 547         if ((err = snd_mixer_selem_set_playback_volume(u->mixer_elem, i, alsa_vol)) < 0)
 548             goto fail;
 549     }
 550
 551     return 0;
 552
 553 fail:
 554     pa_log_error("Unable to set volume: %s", snd_strerror(err));
 555
 556     s->get_volume = NULL;
 557     s->set_volume = NULL;
 558     return -1;
 559 }
 560
 561 static int sink_get_mute_cb(pa_sink *s) {
 562     struct userdata *u = s->userdata;
 563     int err, sw;
 564
 565     pa_assert(u);
 566     pa_assert(u->mixer_elem);
 567
 568     if ((err = snd_mixer_selem_get_playback_switch(u->mixer_elem, 0, &sw)) < 0) {
 569         pa_log_error("Unable to get switch: %s", snd_strerror(err));
 570
 571         s->get_mute = NULL;
 572         s->set_mute = NULL;
 573         return -1;
 574     }
 575
 576     s->muted = !sw;
 577
 578     return 0;
 579 }
 580
 581 static int sink_set_mute_cb(pa_sink *s) {
 582     struct userdata *u = s->userdata;
 583     int err;
 584
 585     pa_assert(u);
 586     pa_assert(u->mixer_elem);
 587
 588     if ((err = snd_mixer_selem_set_playback_switch_all(u->mixer_elem, !s->muted)) < 0) {
 589         pa_log_error("Unable to set switch: %s", snd_strerror(err));
 590
 591         s->get_mute = NULL;
 592         s->set_mute = NULL;
 593         return -1;
 594     }
 595
 596     return 0;
 597 }
 598
 599 static void thread_func(void *userdata) {
 600     struct userdata *u = userdata;
 601
 602     pa_assert(u);
 603
 604     pa_log_debug("Thread starting up");
 605
 606     if (u->core->high_priority)
 607         pa_make_realtime();
 608
 609     pa_thread_mq_install(&u->thread_mq);
 610     pa_rtpoll_install(u->rtpoll);
 611
 612     for (;;) {
 613         int ret;
 614
 615         /* Render some data and write it to the dsp */
 616         if (PA_SINK_OPENED(u->sink->thread_info.state)) {
 617             int work_done = 0;
 618
 619             if (u->use_mmap) {
 620                 if ((work_done = mmap_write(u)) < 0)
 621                     goto fail;
 622             } else {
 623                 if ((work_done = unix_write(u)) < 0)
 624                     goto fail;
 625             }
 626
 627             if (work_done && u->first) {
 628                 pa_log_info("Starting playback.");
 629                 snd_pcm_start(u->pcm_handle);
 630                 u->first = 0;
 631                 continue;
 632             }
 633         }
 634
 635         /* Hmm, nothing to do. Let's sleep */
 636         if ((ret = pa_rtpoll_run(u->rtpoll, 1)) < 0)
 637             goto fail;
 638
 639         if (ret == 0)
 640             goto finish;
 641
 642         /* Tell ALSA about this and process its response */
 643         if (PA_SINK_OPENED(u->sink->thread_info.state)) {
 644             struct pollfd *pollfd;
 645             unsigned short revents = 0;
 646             int err;
 647             unsigned n;
 648
 649             pollfd = pa_rtpoll_item_get_pollfd(u->alsa_rtpoll_item, &n);
 650
 651             if ((err = snd_pcm_poll_descriptors_revents(u->pcm_handle, pollfd, n, &revents)) < 0) {
 652                 pa_log("snd_pcm_poll_descriptors_revents() failed: %s", snd_strerror(err));
 653                 goto fail;
 654             }
 655
 656             if (revents & (POLLERR|POLLNVAL|POLLHUP)) {
 657
 658                 if (revents & POLLERR)
 659                     pa_log_warn("Got POLLERR from ALSA");
 660                 if (revents & POLLNVAL)
 661                     pa_log_warn("Got POLLNVAL from ALSA");
 662                 if (revents & POLLHUP)
 663                     pa_log_warn("Got POLLHUP from ALSA");
 664
 665                 /* Try to recover from this error */
 666
 667                 switch (snd_pcm_state(u->pcm_handle)) {
 668
 669                     case SND_PCM_STATE_XRUN:
 670                         if ((err = snd_pcm_recover(u->pcm_handle, -EPIPE, 1)) != 0) {
 671                             pa_log_warn("Could not recover from POLLERR|POLLNVAL|POLLHUP and XRUN: %s", snd_strerror(err));
 672                             goto fail;
 673                         }
 674                         break;
 675
 676                     case SND_PCM_STATE_SUSPENDED:
 677                         if ((err = snd_pcm_recover(u->pcm_handle, -ESTRPIPE, 1)) != 0) {
 678                             pa_log_warn("Could not recover from POLLERR|POLLNVAL|POLLHUP and SUSPENDED: %s", snd_strerror(err));
 679                             goto fail;
 680                         }
 681                         break;
 682
 683                     default:
 684
 685                         snd_pcm_drop(u->pcm_handle);
 686
 687                         if ((err = snd_pcm_prepare(u->pcm_handle)) < 0) {
 688                             pa_log_warn("Could not recover from POLLERR|POLLNVAL|POLLHUP with snd_pcm_prepare(): %s", snd_strerror(err));
 689                             goto fail;
 690                         }
 691                         break;
 692                 }
 693             }
 694         }
 695     }
 696
 697 fail:
 698     /* If this was no regular exit from the loop we have to continue
 699      * processing messages until we received PA_MESSAGE_SHUTDOWN */
 700     pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
 701     pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
 702
 703 finish:
 704     pa_log_debug("Thread shutting down");
 705 }
 706
 707 int pa__init(pa_module*m) {
 708
 709     pa_modargs *ma = NULL;
 710     struct userdata *u = NULL;
 711     char *dev;
 712     pa_sample_spec ss;
 713     pa_channel_map map;
 714     uint32_t nfrags, frag_size;
 715     snd_pcm_uframes_t period_size;
 716     size_t frame_size;
 717     snd_pcm_info_t *pcm_info = NULL;
 718     int err;
 719     char *t;
 720     const char *name;
 721     char *name_buf = NULL;
 722     int namereg_fail;
 723     int use_mmap = 1, b;
 724
 725     snd_pcm_info_alloca(&pcm_info);
 726
 727     pa_assert(m);
 728
 729     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 730         pa_log("Failed to parse module arguments");
 731         goto fail;
 732     }
 733
 734     ss = m->core->default_sample_spec;
 735     if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_ALSA) < 0) {
 736         pa_log("Failed to parse sample specification and channel map");
 737         goto fail;
 738     }
 739
 740     frame_size = pa_frame_size(&ss);
 741
 742     nfrags = m->core->default_n_fragments;
 743     frag_size = pa_usec_to_bytes(m->core->default_fragment_size_msec*1000, &ss);
 744     if (frag_size <= 0)
 745         frag_size = frame_size;
 746
 747     if (pa_modargs_get_value_u32(ma, "fragments", &nfrags) < 0 || pa_modargs_get_value_u32(ma, "fragment_size", &frag_size) < 0) {
 748         pa_log("Failed to parse buffer metrics");
 749         goto fail;
 750     }
 751     period_size = frag_size/frame_size;
 752
 753     if (pa_modargs_get_value_boolean(ma, "mmap", &use_mmap) < 0) {
 754         pa_log("Failed to parse mmap argument.");
 755         goto fail;
 756     }
 757
 758     u = pa_xnew0(struct userdata, 1);
 759     u->core = m->core;
 760     u->module = m;
 761     m->userdata = u;
 762     u->use_mmap = use_mmap;
 763     u->first = 1;
 764     pa_thread_mq_init(&u->thread_mq, m->core->mainloop);
 765     u->rtpoll = pa_rtpoll_new();
 766     u->alsa_rtpoll_item = NULL;
 767     pa_rtpoll_item_new_asyncmsgq(u->rtpoll, PA_RTPOLL_EARLY, u->thread_mq.inq);
 768
 769     snd_config_update_free_global();
 770
 771     dev = pa_xstrdup(pa_modargs_get_value(ma, "device", DEFAULT_DEVICE));
 772
 773     for (;;) {
 774
 775         if ((err = snd_pcm_open(&u->pcm_handle, dev, SND_PCM_STREAM_PLAYBACK, SND_PCM_NONBLOCK)) < 0) {
 776             pa_log("Error opening PCM device %s: %s", dev, snd_strerror(err));
 777             pa_xfree(dev);
 778             goto fail;
 779         }
 780
 781         b = use_mmap;
 782         if ((err = pa_alsa_set_hw_params(u->pcm_handle, &ss, &nfrags, &period_size, &b)) < 0) {
 783
 784             if (err == -EPERM) {
 785                 /* Hmm, some hw is very exotic, so we retry with plughw, if hw didn't work */
 786
 787                 if (pa_startswith(dev, "hw:")) {
 788                     char *d = pa_sprintf_malloc("plughw:%s", dev+3);
 789                     pa_log_debug("Opening the device as '%s' didn't work, retrying with '%s'.", dev, d);
 790                     pa_xfree(dev);
 791                     dev = d;
 792
 793                     snd_pcm_close(u->pcm_handle);
 794                     u->pcm_handle = NULL;
 795                     continue;
 796                 }
 797             }
 798
 799             pa_log("Failed to set hardware parameters: %s", snd_strerror(err));
 800             pa_xfree(dev);
 801             goto fail;
 802         }
 803
 804         break;
 805     }
 806
 807     u->device_name = dev;
 808
 809     if (use_mmap && !b) {
 810         pa_log_info("Device doesn't support mmap(), falling back to UNIX read/write mode.");
 811         u->use_mmap = use_mmap = b;
 812     }
 813
 814     if (u->use_mmap)
 815         pa_log_info("Successfully enabled mmap() mode.");
 816
 817     if ((err = snd_pcm_info(u->pcm_handle, pcm_info)) < 0) {
 818         pa_log("Error fetching PCM info: %s", snd_strerror(err));
 819         goto fail;
 820     }
 821
 822     if ((err = pa_alsa_set_sw_params(u->pcm_handle)) < 0) {
 823         pa_log("Failed to set software parameters: %s", snd_strerror(err));
 824         goto fail;
 825     }
 826
 827     /* ALSA might tweak the sample spec, so recalculate the frame size */
 828     frame_size = pa_frame_size(&ss);
 829
 830     if (ss.channels != map.channels)
 831         /* Seems ALSA didn't like the channel number, so let's fix the channel map */
 832         pa_channel_map_init_auto(&map, ss.channels, PA_CHANNEL_MAP_ALSA);
 833
 834     if ((err = snd_mixer_open(&u->mixer_handle, 0)) < 0)
 835         pa_log_warn("Error opening mixer: %s", snd_strerror(err));
 836     else {
 837
 838         if ((pa_alsa_prepare_mixer(u->mixer_handle, dev) < 0) ||
 839             !(u->mixer_elem = pa_alsa_find_elem(u->mixer_handle, "Master", "PCM"))) {
 840
 841             snd_mixer_close(u->mixer_handle);
 842             u->mixer_handle = NULL;
 843         }
 844     }
 845
 846     if ((name = pa_modargs_get_value(ma, "sink_name", NULL)))
 847         namereg_fail = 1;
 848     else {
 849         name = name_buf = pa_sprintf_malloc("alsa_output.%s", dev);
 850         namereg_fail = 0;
 851     }
 852
 853     u->sink = pa_sink_new(m->core, __FILE__, name, namereg_fail, &ss, &map);
 854     pa_xfree(name_buf);
 855
 856     if (!u->sink) {
 857         pa_log("Failed to create sink object");
 858         goto fail;
 859     }
 860
 861     u->sink->parent.process_msg = sink_process_msg;
 862     u->sink->userdata = u;
 863
 864     pa_sink_set_module(u->sink, m);
 865     pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq);
 866     pa_sink_set_rtpoll(u->sink, u->rtpoll);
 867     pa_sink_set_description(u->sink, t = pa_sprintf_malloc(
 868                                     "ALSA PCM on %s (%s)%s",
 869                                     dev,
 870                                     snd_pcm_info_get_name(pcm_info),
 871                                     use_mmap ? " via DMA" : ""));
 872     pa_xfree(t);
 873
 874     u->sink->flags = PA_SINK_HARDWARE|PA_SINK_HW_VOLUME_CTRL|PA_SINK_LATENCY;
 875
 876     u->frame_size = frame_size;
 877     u->fragment_size = frag_size = period_size * frame_size;
 878     u->nfragments = nfrags;
 879     u->hwbuf_size = u->fragment_size * nfrags;
 880
 881     pa_log_info("Using %u fragments of size %lu bytes.", nfrags, (long unsigned) u->fragment_size);
 882
 883     pa_memchunk_reset(&u->memchunk);
 884
 885     if (u->mixer_handle) {
 886         /* Initialize mixer code */
 887
 888         pa_assert(u->mixer_elem);
 889
 890         if (snd_mixer_selem_has_playback_volume(u->mixer_elem)) {
 891             int i;
 892
 893             for (i = 0; i < ss.channels; i++)
 894                 if (!snd_mixer_selem_has_playback_channel(u->mixer_elem, i))
 895                     break;
 896
 897             if (i == ss.channels) {
 898                 pa_log_debug("ALSA device has separate volumes controls for all %u channels.", ss.channels);
 899                 u->sink->get_volume = sink_get_volume_cb;
 900                 u->sink->set_volume = sink_set_volume_cb;
 901                 snd_mixer_selem_get_playback_volume_range(u->mixer_elem, &u->hw_volume_min, &u->hw_volume_max);
 902             } else
 903                 pa_log_info("ALSA device lacks separate volumes controls for all %u channels (%u available), falling back to software volume control.", ss.channels, i+1);
 904         }
 905
 906         if (snd_mixer_selem_has_playback_switch(u->mixer_elem)) {
 907             u->sink->get_mute = sink_get_mute_cb;
 908             u->sink->set_mute = sink_set_mute_cb;
 909         }
 910
 911         u->mixer_fdl = pa_alsa_fdlist_new();
 912
 913         if (pa_alsa_fdlist_set_mixer(u->mixer_fdl, u->mixer_handle, m->core->mainloop) < 0) {
 914             pa_log("failed to initialise file descriptor monitoring");
 915             goto fail;
 916         }
 917
 918         snd_mixer_elem_set_callback(u->mixer_elem, mixer_callback);
 919         snd_mixer_elem_set_callback_private(u->mixer_elem, u);
 920     } else
 921         u->mixer_fdl = NULL;
 922
 923     if (!(u->thread = pa_thread_new(thread_func, u))) {
 924         pa_log("Failed to create thread.");
 925         goto fail;
 926     }
 927
 928     /* Get initial mixer settings */
 929     if (u->sink->get_volume)
 930         u->sink->get_volume(u->sink);
 931     if (u->sink->get_mute)
 932         u->sink->get_mute(u->sink);
 933
 934     pa_sink_put(u->sink);
 935
 936     pa_modargs_free(ma);
 937
 938     return 0;
 939
 940 fail:
 941
 942     if (ma)
 943         pa_modargs_free(ma);
 944
 945     pa__done(m);
 946
 947     return -1;
 948 }
 949
 950 void pa__done(pa_module*m) {
 951     struct userdata *u;
 952
 953     pa_assert(m);
 954
 955     if (!(u = m->userdata))
 956         return;
 957
 958     if (u->sink)
 959         pa_sink_unlink(u->sink);
 960
 961     if (u->thread) {
 962         pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
 963         pa_thread_free(u->thread);
 964     }
 965
 966     pa_thread_mq_done(&u->thread_mq);
 967
 968     if (u->sink)
 969         pa_sink_unref(u->sink);
 970
 971     if (u->memchunk.memblock)
 972         pa_memblock_unref(u->memchunk.memblock);
 973
 974     if (u->alsa_rtpoll_item)
 975         pa_rtpoll_item_free(u->alsa_rtpoll_item);
 976
 977     if (u->rtpoll)
 978         pa_rtpoll_free(u->rtpoll);
 979
 980     if (u->mixer_fdl)
 981         pa_alsa_fdlist_free(u->mixer_fdl);
 982
 983     if (u->mixer_handle)
 984         snd_mixer_close(u->mixer_handle);
 985
 986     if (u->pcm_handle) {
 987         snd_pcm_drop(u->pcm_handle);
 988         snd_pcm_close(u->pcm_handle);
 989     }
 990
 991     pa_xfree(u->device_name);
 992     pa_xfree(u);
 993
 994     snd_config_update_free_global();
 995 }