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