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