git.sesse.net Git - vlc/blob - modules/audio_output/pulse.c

   1 /*****************************************************************************
   2  * pulse.c : Pulseaudio output plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2008 VLC authors and VideoLAN
   5  * Copyright (C) 2009-2011 Rémi Denis-Courmont
   6  *
   7  * Authors: Martin Hamrle <hamrle @ post . cz>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <math.h>
  29 #include <vlc_common.h>
  30 #include <vlc_plugin.h>
  31 #include <vlc_aout.h>
  32 #include <vlc_cpu.h>
  33
  34 #include <pulse/pulseaudio.h>
  35 #include "vlcpulse.h"
  36 #if !PA_CHECK_VERSION(0,9,22)
  37 # include <vlc_xlib.h>
  38 #endif
  39
  40 static int  Open        ( vlc_object_t * );
  41 static void Close       ( vlc_object_t * );
  42
  43 vlc_module_begin ()
  44     set_shortname( "PulseAudio" )
  45     set_description( N_("Pulseaudio audio output") )
  46     set_capability( "audio output", 160 )
  47     set_category( CAT_AUDIO )
  48     set_subcategory( SUBCAT_AUDIO_AOUT )
  49     add_shortcut( "pulseaudio", "pa" )
  50     set_callbacks( Open, Close )
  51 vlc_module_end ()
  52
  53 /* NOTE:
  54  * Be careful what you do when the PulseAudio mainloop is held, which is to say
  55  * within PulseAudio callbacks, or after pa_threaded_mainloop_lock().
  56  * In particular, a VLC variable callback cannot be triggered nor deleted with
  57  * the PulseAudio mainloop lock held, if the callback acquires the lock. */
  58
  59 struct aout_sys_t
  60 {
  61     pa_stream *stream; /**< PulseAudio playback stream object */
  62     pa_context *context; /**< PulseAudio connection context */
  63     pa_threaded_mainloop *mainloop; /**< PulseAudio thread */
  64     pa_time_event *trigger; /**< Deferred stream trigger */
  65     pa_volume_t base_volume; /**< 0dB reference volume */
  66     pa_cvolume cvolume; /**< actual sink input volume */
  67     mtime_t first_pts; /**< Play time of buffer start */
  68     mtime_t paused; /**< Time when (last) paused */
  69 };
  70
  71 static void sink_list_cb(pa_context *, const pa_sink_info *, int, void *);
  72 static void sink_input_info_cb(pa_context *, const pa_sink_input_info *,
  73                                int, void *);
  74
  75 /*** Context ***/
  76 static void context_cb(pa_context *ctx, pa_subscription_event_type_t type,
  77                        uint32_t idx, void *userdata)
  78 {
  79     audio_output_t *aout = userdata;
  80     aout_sys_t *sys = aout->sys;
  81     pa_operation *op;
  82
  83     switch (type & PA_SUBSCRIPTION_EVENT_FACILITY_MASK)
  84     {
  85       case PA_SUBSCRIPTION_EVENT_SINK:
  86         switch (type & PA_SUBSCRIPTION_EVENT_TYPE_MASK)
  87         {
  88           case PA_SUBSCRIPTION_EVENT_NEW:
  89           case PA_SUBSCRIPTION_EVENT_CHANGE:
  90             op = pa_context_get_sink_info_by_index(ctx, idx, sink_list_cb, aout);
  91             if (likely(op != NULL))
  92                 pa_operation_unref(op);
  93             break;
  94
  95           case PA_SUBSCRIPTION_EVENT_REMOVE:
  96             var_Change(aout, "audio-device", VLC_VAR_DELCHOICE,
  97                        &(vlc_value_t){ .i_int = idx }, NULL);
  98             break;
  99         }
 100         break;
 101
 102       case PA_SUBSCRIPTION_EVENT_SINK_INPUT:
 103         if (sys->stream == NULL || idx != pa_stream_get_index(sys->stream))
 104             break; /* only interested in our sink input */
 105
 106         /* Gee... PA will not provide the infos directly in the event. */
 107         switch (type & PA_SUBSCRIPTION_EVENT_TYPE_MASK)
 108         {
 109           case PA_SUBSCRIPTION_EVENT_REMOVE:
 110             msg_Err(aout, "sink input killed!");
 111             break;
 112
 113           default:
 114             op = pa_context_get_sink_input_info(ctx, idx, sink_input_info_cb,
 115                                                 aout);
 116             if (likely(op != NULL))
 117                 pa_operation_unref(op);
 118             break;
 119         }
 120         break;
 121
 122       default: /* unsubscribed facility?! */
 123         assert(0);
 124     }
 125 }
 126
 127
 128 /*** Sink ***/
 129 static void sink_list_cb(pa_context *c, const pa_sink_info *i, int eol,
 130                          void *userdata)
 131 {
 132     audio_output_t *aout = userdata;
 133     aout_sys_t *sys = aout->sys;
 134     vlc_value_t val, text;
 135
 136     if (eol)
 137         return;
 138     (void) c;
 139
 140     msg_Dbg(aout, "listing sink %s (%"PRIu32"): %s", i->name, i->index,
 141             i->description);
 142     val.i_int = i->index;
 143     text.psz_string = (char *)i->description;
 144     /* FIXME: There is no way to replace a choice explicitly. */
 145     var_Change(aout, "audio-device", VLC_VAR_DELCHOICE, &val, NULL);
 146     var_Change(aout, "audio-device", VLC_VAR_ADDCHOICE, &val, &text);
 147     /* FIXME: var_Change() can change the variable value if we remove the
 148      * current value from the choice list, or if we add a choice while there
 149      * was none. So force the correct value back. */
 150     if (sys->stream != NULL)
 151     {
 152         val.i_int = pa_stream_get_device_index(sys->stream);
 153         var_Change(aout, "audio-device", VLC_VAR_SETVALUE, &val, NULL);
 154     }
 155 }
 156
 157 static void sink_info_cb(pa_context *c, const pa_sink_info *i, int eol,
 158                          void *userdata)
 159 {
 160     audio_output_t *aout = userdata;
 161     aout_sys_t *sys = aout->sys;
 162
 163     if (eol)
 164         return;
 165     (void) c;
 166
 167     /* PulseAudio flat volume NORM / 100% / 0dB corresponds to no software
 168      * amplification and maximum hardware amplification.
 169      * VLC maps DEFAULT / 100% to no gain at all (software/hardware).
 170      * Thus we need to use the sink base_volume as a multiplier,
 171      * if and only if flat volume is active for our current sink. */
 172     if (i->flags & PA_SINK_FLAT_VOLUME)
 173         sys->base_volume = i->base_volume;
 174     else
 175         sys->base_volume = PA_VOLUME_NORM;
 176     msg_Dbg(aout, "base volume: %"PRIu32, sys->base_volume);
 177 }
 178
 179
 180 /*** Latency management and lip synchronization ***/
 181 static void stream_start_now(pa_stream *s, audio_output_t *aout)
 182 {
 183     aout_sys_t *sys = aout->sys;
 184     pa_operation *op;
 185
 186     assert (sys->trigger == NULL);
 187
 188     op = pa_stream_cork(s, 0, NULL, NULL);
 189     if (op != NULL)
 190         pa_operation_unref(op);
 191     op = pa_stream_trigger(s, NULL, NULL);
 192     if (likely(op != NULL))
 193         pa_operation_unref(op);
 194 }
 195
 196 static void stream_stop(pa_stream *s, audio_output_t *aout)
 197 {
 198     aout_sys_t *sys = aout->sys;
 199     pa_operation *op;
 200
 201     if (sys->trigger != NULL) {
 202         vlc_pa_rttime_free(sys->mainloop, sys->trigger);
 203         sys->trigger = NULL;
 204     }
 205
 206     op = pa_stream_cork(s, 1, NULL, NULL);
 207     if (op != NULL)
 208         pa_operation_unref(op);
 209 }
 210
 211 static void stream_trigger_cb(pa_mainloop_api *api, pa_time_event *e,
 212                               const struct timeval *tv, void *userdata)
 213 {
 214     audio_output_t *aout = userdata;
 215     aout_sys_t *sys = aout->sys;
 216
 217     assert (sys->trigger == e);
 218
 219     msg_Dbg(aout, "starting deferred");
 220     vlc_pa_rttime_free(sys->mainloop, sys->trigger);
 221     sys->trigger = NULL;
 222     stream_start_now(sys->stream, aout);
 223     (void) api; (void) e; (void) tv;
 224 }
 225
 226 /**
 227  * Starts or resumes the playback stream.
 228  * Tries start playing back audio samples at the most accurate time
 229  * in order to minimize desync and resampling during early playback.
 230  * @note PulseAudio lock required.
 231  */
 232 static void stream_start(pa_stream *s, audio_output_t *aout)
 233 {
 234     aout_sys_t *sys = aout->sys;
 235     mtime_t delta;
 236
 237     assert (sys->first_pts != VLC_TS_INVALID);
 238
 239     if (sys->trigger != NULL) {
 240         vlc_pa_rttime_free(sys->mainloop, sys->trigger);
 241         sys->trigger = NULL;
 242     }
 243
 244     delta = vlc_pa_get_latency(aout, sys->context, s);
 245     if (unlikely(delta == VLC_TS_INVALID)) {
 246         msg_Dbg(aout, "cannot synchronize start");
 247         delta = 0; /* screwed */
 248     }
 249
 250     delta = (sys->first_pts - mdate()) - delta;
 251     if (delta > 0) {
 252         msg_Dbg(aout, "deferring start (%"PRId64" us)", delta);
 253         delta += pa_rtclock_now();
 254         sys->trigger = pa_context_rttime_new(sys->context, delta,
 255                                              stream_trigger_cb, aout);
 256     } else {
 257         msg_Warn(aout, "starting late (%"PRId64" us)", delta);
 258         stream_start_now(s, aout);
 259     }
 260 }
 261
 262 static void stream_latency_cb(pa_stream *s, void *userdata)
 263 {
 264     audio_output_t *aout = userdata;
 265     aout_sys_t *sys = aout->sys;
 266
 267     if (sys->paused != VLC_TS_INVALID)
 268         return; /* nothing to do while paused */
 269     if (sys->first_pts == VLC_TS_INVALID)
 270         return; /* nothing to do if buffers are (still) empty */
 271     if (pa_stream_is_corked(s) > 0)
 272         stream_start(s, aout);
 273 }
 274
 275
 276 /*** Stream helpers ***/
 277 static void stream_state_cb(pa_stream *s, void *userdata)
 278 {
 279     pa_threaded_mainloop *mainloop = userdata;
 280
 281     switch (pa_stream_get_state(s)) {
 282         case PA_STREAM_READY:
 283         case PA_STREAM_FAILED:
 284         case PA_STREAM_TERMINATED:
 285             pa_threaded_mainloop_signal(mainloop, 0);
 286         default:
 287             break;
 288     }
 289 }
 290
 291 static void stream_buffer_attr_cb(pa_stream *s, void *userdata)
 292 {
 293     audio_output_t *aout = userdata;
 294     const pa_buffer_attr *pba = pa_stream_get_buffer_attr(s);
 295
 296     msg_Dbg(aout, "changed buffer metrics: maxlength=%u, tlength=%u, "
 297             "prebuf=%u, minreq=%u",
 298             pba->maxlength, pba->tlength, pba->prebuf, pba->minreq);
 299 }
 300
 301 static void stream_event_cb(pa_stream *s, const char *name, pa_proplist *pl,
 302                             void *userdata)
 303 {
 304     audio_output_t *aout = userdata;
 305
 306     if (!strcmp(name, PA_STREAM_EVENT_REQUEST_CORK))
 307         aout_PolicyReport(aout, true);
 308     else
 309     if (!strcmp(name, PA_STREAM_EVENT_REQUEST_UNCORK))
 310         aout_PolicyReport(aout, false);
 311     else
 312 #if PA_CHECK_VERSION(1,0,0)
 313     /* FIXME: expose aout_Restart() directly */
 314     if (!strcmp(name, PA_STREAM_EVENT_FORMAT_LOST)) {
 315         vlc_value_t dummy = { .i_int = 0 };
 316
 317         msg_Dbg (aout, "format lost");
 318         aout_RestartRequest (aout, AOUT_RESTART_OUTPUT);
 319     } else
 320 #endif
 321         msg_Warn (aout, "unhandled stream event \"%s\"", name);
 322     (void) s;
 323     (void) pl;
 324 }
 325
 326 static void stream_moved_cb(pa_stream *s, void *userdata)
 327 {
 328     audio_output_t *aout = userdata;
 329     aout_sys_t *sys = aout->sys;
 330     pa_operation *op;
 331     uint32_t idx = pa_stream_get_device_index(s);
 332
 333     msg_Dbg(aout, "connected to sink %"PRIu32": %s", idx,
 334                   pa_stream_get_device_name(s));
 335     op = pa_context_get_sink_info_by_index(sys->context, idx,
 336                                            sink_info_cb, aout);
 337     if (likely(op != NULL))
 338         pa_operation_unref(op);
 339
 340     /* Update the variable if someone else moved our stream */
 341     var_Change(aout, "audio-device", VLC_VAR_SETVALUE,
 342                &(vlc_value_t){ .i_int = idx }, NULL);
 343
 344     /* Sink unknown as yet, create stub choice for it */
 345     if (var_GetInteger(aout, "audio-device") != idx)
 346     {
 347         var_Change(aout, "audio-device", VLC_VAR_ADDCHOICE,
 348                    &(vlc_value_t){ .i_int = idx },
 349                    &(vlc_value_t){ .psz_string = (char *)"?" });
 350         var_Change(aout, "audio-device", VLC_VAR_SETVALUE,
 351                    &(vlc_value_t){ .i_int = idx }, NULL);
 352     }
 353 }
 354
 355 static void stream_overflow_cb(pa_stream *s, void *userdata)
 356 {
 357     audio_output_t *aout = userdata;
 358     aout_sys_t *sys = aout->sys;
 359     pa_operation *op;
 360
 361     msg_Err(aout, "overflow, flushing");
 362     op = pa_stream_flush(s, NULL, NULL);
 363     if (unlikely(op == NULL))
 364         return;
 365     pa_operation_unref(op);
 366     sys->first_pts = VLC_TS_INVALID;
 367 }
 368
 369 static void stream_started_cb(pa_stream *s, void *userdata)
 370 {
 371     audio_output_t *aout = userdata;
 372
 373     msg_Dbg(aout, "started");
 374     (void) s;
 375 }
 376
 377 static void stream_suspended_cb(pa_stream *s, void *userdata)
 378 {
 379     audio_output_t *aout = userdata;
 380
 381     msg_Dbg(aout, "suspended");
 382     (void) s;
 383 }
 384
 385 static void stream_underflow_cb(pa_stream *s, void *userdata)
 386 {
 387     audio_output_t *aout = userdata;
 388
 389     msg_Dbg(aout, "underflow");
 390     (void) s;
 391 }
 392
 393 static int stream_wait(pa_stream *stream, pa_threaded_mainloop *mainloop)
 394 {
 395     pa_stream_state_t state;
 396
 397     while ((state = pa_stream_get_state(stream)) != PA_STREAM_READY) {
 398         if (state == PA_STREAM_FAILED || state == PA_STREAM_TERMINATED)
 399             return -1;
 400         pa_threaded_mainloop_wait(mainloop);
 401     }
 402     return 0;
 403 }
 404
 405
 406 /*** Sink input ***/
 407 static void sink_input_info_cb(pa_context *ctx, const pa_sink_input_info *i,
 408                                int eol, void *userdata)
 409 {
 410     audio_output_t *aout = userdata;
 411     aout_sys_t *sys = aout->sys;
 412
 413     if (eol)
 414         return;
 415     (void) ctx;
 416
 417     sys->cvolume = i->volume; /* cache volume for balance preservation */
 418
 419     pa_volume_t volume = pa_cvolume_max(&i->volume);
 420     volume = pa_sw_volume_divide(volume, sys->base_volume);
 421     aout_VolumeReport(aout, (float)volume / PA_VOLUME_NORM);
 422     aout_MuteReport(aout, i->mute);
 423 }
 424
 425
 426 /*** VLC audio output callbacks ***/
 427
 428 static int TimeGet(audio_output_t *aout, mtime_t *restrict delay)
 429 {
 430     aout_sys_t *sys = aout->sys;
 431     pa_stream *s = sys->stream;
 432
 433     if (pa_stream_is_corked(s) > 0)
 434         return -1; /* latency is irrelevant if corked */
 435
 436     mtime_t delta = vlc_pa_get_latency(aout, sys->context, s);
 437     if (delta == VLC_TS_INVALID)
 438         return -1;
 439
 440     *delay = delta;
 441     return 0;
 442 }
 443
 444 /* Memory free callback. The block_t address is in front of the data. */
 445 static void data_free(void *data)
 446 {
 447     block_t **pp = data, *block;
 448
 449     memcpy(&block, pp - 1, sizeof (block));
 450     block_Release(block);
 451 }
 452
 453 static void *data_convert(block_t **pp)
 454 {
 455     block_t *block = *pp;
 456     /* In most cases, there is enough head room, and this is really cheap: */
 457     block = block_Realloc(block, sizeof (block), block->i_buffer);
 458     *pp = block;
 459     if (unlikely(block == NULL))
 460         return NULL;
 461
 462     memcpy(block->p_buffer, &block, sizeof (block));
 463     block->p_buffer += sizeof (block);
 464     block->i_buffer -= sizeof (block);
 465     return block->p_buffer;
 466 }
 467
 468 /**
 469  * Queue one audio frame to the playback stream
 470  */
 471 static void Play(audio_output_t *aout, block_t *block)
 472 {
 473     aout_sys_t *sys = aout->sys;
 474     pa_stream *s = sys->stream;
 475
 476     assert (sys->paused == VLC_TS_INVALID);
 477
 478     const void *ptr = data_convert(&block);
 479     if (unlikely(ptr == NULL))
 480         return;
 481
 482     size_t len = block->i_buffer;
 483
 484     /* Note: The core already holds the output FIFO lock at this point.
 485      * Therefore we must not under any circumstances (try to) acquire the
 486      * output FIFO lock while the PulseAudio threaded main loop lock is held
 487      * (including from PulseAudio stream callbacks). Otherwise lock inversion
 488      * will take place, and sooner or later a deadlock. */
 489     pa_threaded_mainloop_lock(sys->mainloop);
 490
 491     if (sys->first_pts == VLC_TS_INVALID)
 492         sys->first_pts = block->i_pts;
 493
 494     if (pa_stream_is_corked(s) > 0)
 495         stream_start(s, aout);
 496
 497 #if 0 /* Fault injector to test underrun recovery */
 498     static volatile unsigned u = 0;
 499     if ((++u % 1000) == 0) {
 500         msg_Err(aout, "fault injection");
 501         pa_operation_unref(pa_stream_flush(s, NULL, NULL));
 502     }
 503 #endif
 504
 505     if (pa_stream_write(s, ptr, len, data_free, 0, PA_SEEK_RELATIVE) < 0) {
 506         vlc_pa_error(aout, "cannot write", sys->context);
 507         block_Release(block);
 508     }
 509
 510     pa_threaded_mainloop_unlock(sys->mainloop);
 511 }
 512
 513 /**
 514  * Cork or uncork the playback stream
 515  */
 516 static void Pause(audio_output_t *aout, bool paused, mtime_t date)
 517 {
 518     aout_sys_t *sys = aout->sys;
 519     pa_stream *s = sys->stream;
 520
 521     pa_threaded_mainloop_lock(sys->mainloop);
 522
 523     if (paused) {
 524         sys->paused = date;
 525         stream_stop(s, aout);
 526     } else {
 527         assert (sys->paused != VLC_TS_INVALID);
 528         date -= sys->paused;
 529         msg_Dbg(aout, "resuming after %"PRId64" us", date);
 530         sys->paused = VLC_TS_INVALID;
 531
 532         if (sys->first_pts != VLC_TS_INVALID) {
 533             sys->first_pts += date;
 534             stream_start(s, aout);
 535         }
 536     }
 537
 538     pa_threaded_mainloop_unlock(sys->mainloop);
 539 }
 540
 541 /**
 542  * Flush or drain the playback stream
 543  */
 544 static void Flush(audio_output_t *aout, bool wait)
 545 {
 546     aout_sys_t *sys = aout->sys;
 547     pa_stream *s = sys->stream;
 548     pa_operation *op;
 549
 550     pa_threaded_mainloop_lock(sys->mainloop);
 551
 552     if (wait)
 553         op = pa_stream_drain(s, NULL, NULL);
 554         /* TODO: wait for drain completion*/
 555     else
 556         op = pa_stream_flush(s, NULL, NULL);
 557     if (op != NULL)
 558         pa_operation_unref(op);
 559     pa_threaded_mainloop_unlock(sys->mainloop);
 560 }
 561
 562 static int VolumeSet(audio_output_t *aout, float vol)
 563 {
 564     aout_sys_t *sys = aout->sys;
 565     if (sys->stream == NULL)
 566     {
 567         msg_Err (aout, "cannot change volume while not playing");
 568         return -1;
 569     }
 570
 571     /* VLC provides the software volume so convert directly to PulseAudio
 572      * software volume, pa_volume_t. This is not a linear amplification factor
 573      * so do not use PulseAudio linear amplification! */
 574     vol *= PA_VOLUME_NORM;
 575     if (unlikely(vol >= PA_VOLUME_MAX))
 576         vol = PA_VOLUME_MAX;
 577     pa_volume_t volume = pa_sw_volume_multiply(lround(vol), sys->base_volume);
 578
 579     /* Preserve the balance (VLC does not support it). */
 580     pa_cvolume cvolume = sys->cvolume;
 581     pa_cvolume_scale(&cvolume, PA_VOLUME_NORM);
 582     pa_sw_cvolume_multiply_scalar(&cvolume, &cvolume, volume);
 583     assert(pa_cvolume_valid(&cvolume));
 584
 585     pa_operation *op;
 586     uint32_t idx = pa_stream_get_index(sys->stream);
 587     pa_threaded_mainloop_lock(sys->mainloop);
 588     op = pa_context_set_sink_input_volume(sys->context, idx, &cvolume,
 589                                           NULL, NULL);
 590     if (likely(op != NULL))
 591         pa_operation_unref(op);
 592     pa_threaded_mainloop_unlock(sys->mainloop);
 593
 594     return 0;
 595 }
 596
 597 static int MuteSet(audio_output_t *aout, bool mute)
 598 {
 599     aout_sys_t *sys = aout->sys;
 600     if (sys->stream == NULL)
 601     {
 602         msg_Err (aout, "cannot change volume while not playing");
 603         return -1;
 604     }
 605
 606     pa_operation *op;
 607     uint32_t idx = pa_stream_get_index(sys->stream);
 608     pa_threaded_mainloop_lock(sys->mainloop);
 609     op = pa_context_set_sink_input_mute(sys->context, idx, mute, NULL, NULL);
 610     if (likely(op != NULL))
 611         pa_operation_unref(op);
 612     pa_threaded_mainloop_unlock(sys->mainloop);
 613
 614     return 0;
 615 }
 616
 617 static int StreamMove(vlc_object_t *obj, const char *varname, vlc_value_t old,
 618                       vlc_value_t val, void *userdata)
 619 {
 620     audio_output_t *aout = (audio_output_t *)obj;
 621     aout_sys_t *sys = aout->sys;
 622     pa_stream *s = userdata;
 623     pa_operation *op;
 624     uint32_t idx = pa_stream_get_index(s);
 625     uint32_t sink_idx = val.i_int;
 626
 627     (void) varname; (void) old;
 628
 629     pa_threaded_mainloop_lock(sys->mainloop);
 630     op = pa_context_move_sink_input_by_index(sys->context, idx, sink_idx,
 631                                              NULL, NULL);
 632     if (likely(op != NULL)) {
 633         pa_operation_unref(op);
 634         msg_Dbg(aout, "moving to sink %"PRIu32, sink_idx);
 635     } else
 636         vlc_pa_error(obj, "cannot move sink", sys->context);
 637     pa_threaded_mainloop_unlock(sys->mainloop);
 638
 639     return (op != NULL) ? VLC_SUCCESS : VLC_EGENERIC;
 640 }
 641
 642 static void Stop(audio_output_t *);
 643
 644 /**
 645  * Create a PulseAudio playback stream, a.k.a. a sink input.
 646  */
 647 static int Start(audio_output_t *aout, audio_sample_format_t *restrict fmt)
 648 {
 649     aout_sys_t *sys = aout->sys;
 650
 651     /* Sample format specification */
 652     struct pa_sample_spec ss;
 653 #if PA_CHECK_VERSION(1,0,0)
 654     pa_encoding_t encoding = PA_ENCODING_INVALID;
 655 #endif
 656
 657     switch (fmt->i_format)
 658     {
 659         case VLC_CODEC_F64B:
 660             fmt->i_format = VLC_CODEC_F32B;
 661         case VLC_CODEC_F32B:
 662             ss.format = PA_SAMPLE_FLOAT32BE;
 663             break;
 664         case VLC_CODEC_F64L:
 665             fmt->i_format = VLC_CODEC_F32L;
 666         case VLC_CODEC_F32L:
 667             ss.format = PA_SAMPLE_FLOAT32LE;
 668             break;
 669         case VLC_CODEC_S32B:
 670             ss.format = PA_SAMPLE_S32BE;
 671             break;
 672         case VLC_CODEC_S32L:
 673             ss.format = PA_SAMPLE_S32LE;
 674             break;
 675         case VLC_CODEC_S24B:
 676             ss.format = PA_SAMPLE_S24BE;
 677             break;
 678         case VLC_CODEC_S24L:
 679             ss.format = PA_SAMPLE_S24LE;
 680             break;
 681         case VLC_CODEC_S16B:
 682             ss.format = PA_SAMPLE_S16BE;
 683             break;
 684         case VLC_CODEC_S16L:
 685             ss.format = PA_SAMPLE_S16LE;
 686             break;
 687         case VLC_CODEC_S8:
 688             fmt->i_format = VLC_CODEC_U8;
 689         case VLC_CODEC_U8:
 690             ss.format = PA_SAMPLE_U8;
 691             break;
 692 #if PA_CHECK_VERSION(1,0,0)
 693         case VLC_CODEC_A52:
 694             fmt->i_format = VLC_CODEC_SPDIFL;
 695             encoding = PA_ENCODING_AC3_IEC61937;
 696             ss.format = HAVE_FPU ? PA_SAMPLE_FLOAT32NE : PA_SAMPLE_S16NE;
 697             break;
 698         /*case VLC_CODEC_EAC3:
 699             fmt->i_format = VLC_CODEC_SPDIFL FIXME;
 700             encoding = PA_ENCODING_EAC3_IEC61937;
 701             ss.format = HAVE_FPU ? PA_SAMPLE_FLOAT32NE : PA_SAMPLE_S16NE;
 702             break;
 703         case VLC_CODEC_MPGA:
 704             fmt->i_format = VLC_CODEC_SPDIFL FIXME;
 705             encoding = PA_ENCODING_MPEG_IEC61937;
 706             ss.format = HAVE_FPU ? PA_SAMPLE_FLOAT32NE : PA_SAMPLE_S16NE;
 707             break;*/
 708         case VLC_CODEC_DTS:
 709             fmt->i_format = VLC_CODEC_SPDIFL;
 710             encoding = PA_ENCODING_DTS_IEC61937;
 711             ss.format = HAVE_FPU ? PA_SAMPLE_FLOAT32NE : PA_SAMPLE_S16NE;
 712             break;
 713 #endif
 714         default:
 715             if (HAVE_FPU)
 716             {
 717                 fmt->i_format = VLC_CODEC_FL32;
 718                 ss.format = PA_SAMPLE_FLOAT32NE;
 719             }
 720             else
 721             {
 722                 fmt->i_format = VLC_CODEC_S16N;
 723                 ss.format = PA_SAMPLE_S16NE;
 724             }
 725             break;
 726     }
 727
 728     ss.rate = fmt->i_rate;
 729     ss.channels = aout_FormatNbChannels(fmt);
 730     if (!pa_sample_spec_valid(&ss)) {
 731         msg_Err(aout, "unsupported sample specification");
 732         return VLC_EGENERIC;
 733     }
 734
 735     /* Channel mapping (order defined in vlc_aout.h) */
 736     struct pa_channel_map map;
 737     map.channels = 0;
 738
 739     if (fmt->i_physical_channels & AOUT_CHAN_LEFT)
 740         map.map[map.channels++] = PA_CHANNEL_POSITION_FRONT_LEFT;
 741     if (fmt->i_physical_channels & AOUT_CHAN_RIGHT)
 742         map.map[map.channels++] = PA_CHANNEL_POSITION_FRONT_RIGHT;
 743     if (fmt->i_physical_channels & AOUT_CHAN_MIDDLELEFT)
 744         map.map[map.channels++] = PA_CHANNEL_POSITION_SIDE_LEFT;
 745     if (fmt->i_physical_channels & AOUT_CHAN_MIDDLERIGHT)
 746         map.map[map.channels++] = PA_CHANNEL_POSITION_SIDE_RIGHT;
 747     if (fmt->i_physical_channels & AOUT_CHAN_REARLEFT)
 748         map.map[map.channels++] = PA_CHANNEL_POSITION_REAR_LEFT;
 749     if (fmt->i_physical_channels & AOUT_CHAN_REARRIGHT)
 750         map.map[map.channels++] = PA_CHANNEL_POSITION_REAR_RIGHT;
 751     if (fmt->i_physical_channels & AOUT_CHAN_REARCENTER)
 752         map.map[map.channels++] = PA_CHANNEL_POSITION_REAR_CENTER;
 753     if (fmt->i_physical_channels & AOUT_CHAN_CENTER)
 754     {
 755         if (ss.channels == 1)
 756             map.map[map.channels++] = PA_CHANNEL_POSITION_MONO;
 757         else
 758             map.map[map.channels++] = PA_CHANNEL_POSITION_FRONT_CENTER;
 759     }
 760     if (fmt->i_physical_channels & AOUT_CHAN_LFE)
 761         map.map[map.channels++] = PA_CHANNEL_POSITION_LFE;
 762
 763     for (unsigned i = 0; map.channels < ss.channels; i++) {
 764         map.map[map.channels++] = PA_CHANNEL_POSITION_AUX0 + i;
 765         msg_Warn(aout, "mapping channel %"PRIu8" to AUX%u", map.channels, i);
 766     }
 767
 768     if (!pa_channel_map_valid(&map)) {
 769         msg_Err(aout, "unsupported channel map");
 770         return VLC_EGENERIC;
 771     } else {
 772         const char *name = pa_channel_map_to_name(&map);
 773         msg_Dbg(aout, "using %s channel map", (name != NULL) ? name : "?");
 774     }
 775
 776     /* Stream parameters */
 777     const pa_stream_flags_t flags = PA_STREAM_START_CORKED
 778                                   | PA_STREAM_INTERPOLATE_TIMING
 779                                   | PA_STREAM_NOT_MONOTONIC
 780                                   | PA_STREAM_AUTO_TIMING_UPDATE
 781                                   | PA_STREAM_FIX_RATE;
 782
 783     struct pa_buffer_attr attr;
 784     attr.maxlength = -1;
 785     /* PulseAudio goes berserk if the target length (tlength) is not
 786      * significantly longer than 2 periods (minreq), or when the period length
 787      * is unspecified and the target length is short. */
 788     attr.tlength = pa_usec_to_bytes(3 * AOUT_MIN_PREPARE_TIME, &ss);
 789     attr.prebuf = 0; /* trigger manually */
 790     attr.minreq = pa_usec_to_bytes(AOUT_MIN_PREPARE_TIME, &ss);
 791     attr.fragsize = 0; /* not used for output */
 792
 793     sys->stream = NULL;
 794     sys->trigger = NULL;
 795     sys->first_pts = VLC_TS_INVALID;
 796     sys->paused = VLC_TS_INVALID;
 797
 798     /* Channel volume */
 799     sys->base_volume = PA_VOLUME_NORM;
 800     pa_cvolume_set(&sys->cvolume, ss.channels, PA_VOLUME_NORM);
 801
 802 #if PA_CHECK_VERSION(1,0,0)
 803     pa_format_info *formatv[2];
 804     unsigned formatc = 0;
 805
 806     /* Favor digital pass-through if available*/
 807     if (encoding != PA_ENCODING_INVALID) {
 808         formatv[formatc] = pa_format_info_new();
 809         formatv[formatc]->encoding = encoding;
 810         pa_format_info_set_rate(formatv[formatc], ss.rate);
 811         pa_format_info_set_channels(formatv[formatc], ss.channels);
 812         pa_format_info_set_channel_map(formatv[formatc], &map);
 813         formatc++;
 814     }
 815
 816     /* Fallback to PCM */
 817     formatv[formatc] = pa_format_info_new();
 818     formatv[formatc]->encoding = PA_ENCODING_PCM;
 819     pa_format_info_set_sample_format(formatv[formatc], ss.format);
 820     pa_format_info_set_rate(formatv[formatc], ss.rate);
 821     pa_format_info_set_channels(formatv[formatc], ss.channels);
 822     pa_format_info_set_channel_map(formatv[formatc], &map);
 823     formatc++;
 824
 825     /* Create a playback stream */
 826     pa_stream *s;
 827     pa_proplist *props = pa_proplist_new();
 828     if (likely(props != NULL))
 829         /* TODO: set other stream properties */
 830         pa_proplist_sets (props, PA_PROP_MEDIA_ROLE, "video");
 831
 832     pa_threaded_mainloop_lock(sys->mainloop);
 833     s = pa_stream_new_extended(sys->context, "audio stream", formatv, formatc,
 834                                props);
 835     if (likely(props != NULL))
 836         pa_proplist_free(props);
 837
 838     for (unsigned i = 0; i < formatc; i++)
 839         pa_format_info_free(formatv[i]);
 840 #else
 841     pa_threaded_mainloop_lock(sys->mainloop);
 842     pa_stream *s = pa_stream_new(sys->context, "audio stream", &ss, &map);
 843 #endif
 844     if (s == NULL) {
 845         pa_threaded_mainloop_unlock(sys->mainloop);
 846         vlc_pa_error(aout, "stream creation failure", sys->context);
 847         return VLC_EGENERIC;
 848     }
 849     sys->stream = s;
 850     pa_stream_set_state_callback(s, stream_state_cb, sys->mainloop);
 851     pa_stream_set_buffer_attr_callback(s, stream_buffer_attr_cb, aout);
 852     pa_stream_set_event_callback(s, stream_event_cb, aout);
 853     pa_stream_set_latency_update_callback(s, stream_latency_cb, aout);
 854     pa_stream_set_moved_callback(s, stream_moved_cb, aout);
 855     pa_stream_set_overflow_callback(s, stream_overflow_cb, aout);
 856     pa_stream_set_started_callback(s, stream_started_cb, aout);
 857     pa_stream_set_suspended_callback(s, stream_suspended_cb, aout);
 858     pa_stream_set_underflow_callback(s, stream_underflow_cb, aout);
 859
 860     if (pa_stream_connect_playback(s, NULL, &attr, flags, NULL, NULL) < 0
 861      || stream_wait(s, sys->mainloop)) {
 862         vlc_pa_error(aout, "stream connection failure", sys->context);
 863         goto fail;
 864     }
 865
 866     const struct pa_sample_spec *spec = pa_stream_get_sample_spec(s);
 867 #if PA_CHECK_VERSION(1,0,0)
 868     if (encoding != PA_ENCODING_INVALID) {
 869         const pa_format_info *info = pa_stream_get_format_info(s);
 870
 871         assert (info != NULL);
 872         if (pa_format_info_is_pcm (info)) {
 873             msg_Dbg(aout, "digital pass-through not available");
 874             fmt->i_format = HAVE_FPU ? VLC_CODEC_FL32 : VLC_CODEC_S16N;
 875         } else {
 876             msg_Dbg(aout, "digital pass-through enabled");
 877             spec = NULL;
 878         }
 879     }
 880 #endif
 881     if (spec != NULL)
 882         fmt->i_rate = spec->rate;
 883
 884     stream_buffer_attr_cb(s, aout);
 885     stream_moved_cb(s, aout);
 886     pa_threaded_mainloop_unlock(sys->mainloop);
 887     var_AddCallback (aout, "audio-device", StreamMove, s);
 888
 889     return VLC_SUCCESS;
 890
 891 fail:
 892     pa_threaded_mainloop_unlock(sys->mainloop);
 893     var_AddCallback (aout, "audio-device", StreamMove, s);
 894     Stop(aout);
 895     return VLC_EGENERIC;
 896 }
 897
 898 /**
 899  * Removes a PulseAudio playback stream
 900  */
 901 static void Stop(audio_output_t *aout)
 902 {
 903     aout_sys_t *sys = aout->sys;
 904     pa_stream *s = sys->stream;
 905
 906     /* The callback takes mainloop lock, so it CANNOT be held here! */
 907     var_DelCallback (aout, "audio-device", StreamMove, s);
 908
 909     pa_threaded_mainloop_lock(sys->mainloop);
 910     if (unlikely(sys->trigger != NULL))
 911         vlc_pa_rttime_free(sys->mainloop, sys->trigger);
 912     pa_stream_disconnect(s);
 913
 914     /* Clear all callbacks */
 915     pa_stream_set_state_callback(s, NULL, NULL);
 916     pa_stream_set_buffer_attr_callback(s, NULL, NULL);
 917     pa_stream_set_event_callback(s, NULL, NULL);
 918     pa_stream_set_latency_update_callback(s, NULL, NULL);
 919     pa_stream_set_moved_callback(s, NULL, NULL);
 920     pa_stream_set_overflow_callback(s, NULL, NULL);
 921     pa_stream_set_started_callback(s, NULL, NULL);
 922     pa_stream_set_suspended_callback(s, NULL, NULL);
 923     pa_stream_set_underflow_callback(s, NULL, NULL);
 924
 925     pa_stream_unref(s);
 926     sys->stream = NULL;
 927     pa_threaded_mainloop_unlock(sys->mainloop);
 928 }
 929
 930 static int Open(vlc_object_t *obj)
 931 {
 932     audio_output_t *aout = (audio_output_t *)obj;
 933     aout_sys_t *sys = malloc(sizeof (*sys));
 934     pa_operation *op;
 935
 936 #if !PA_CHECK_VERSION(0,9,22)
 937     if (!vlc_xlib_init(obj))
 938         return VLC_EGENERIC;
 939 #endif
 940     if (unlikely(sys == NULL))
 941         return VLC_ENOMEM;
 942
 943     /* Allocate structures */
 944     pa_context *ctx = vlc_pa_connect(obj, &sys->mainloop);
 945     if (ctx == NULL)
 946     {
 947         free(sys);
 948         return VLC_EGENERIC;
 949     }
 950     sys->stream = NULL;
 951     sys->context = ctx;
 952
 953     aout->sys = sys;
 954     aout->start = Start;
 955     aout->stop = Stop;
 956     aout->time_get = TimeGet;
 957     aout->play = Play;
 958     aout->pause = Pause;
 959     aout->flush = Flush;
 960     aout->volume_set = VolumeSet;
 961     aout->mute_set = MuteSet;
 962
 963     /* Devices (sinks) */
 964     var_Create(aout, "audio-device", VLC_VAR_INTEGER|VLC_VAR_HASCHOICE);
 965     var_Change(aout, "audio-device", VLC_VAR_SETTEXT,
 966                &(vlc_value_t){ .psz_string = (char *)_("Audio device") },
 967                NULL);
 968
 969     pa_threaded_mainloop_lock(sys->mainloop);
 970     op = pa_context_get_sink_info_list(sys->context, sink_list_cb, aout);
 971     if (op != NULL)
 972         pa_operation_unref(op);
 973
 974     /* Context events */
 975     const pa_subscription_mask_t mask = PA_SUBSCRIPTION_MASK_SINK
 976                                       | PA_SUBSCRIPTION_MASK_SINK_INPUT;
 977     pa_context_set_subscribe_callback(sys->context, context_cb, aout);
 978     op = pa_context_subscribe(sys->context, mask, NULL, NULL);
 979     if (likely(op != NULL))
 980        pa_operation_unref(op);
 981     pa_threaded_mainloop_unlock(sys->mainloop);
 982
 983     return VLC_SUCCESS;
 984 }
 985
 986 static void Close(vlc_object_t *obj)
 987 {
 988     audio_output_t *aout = (audio_output_t *)obj;
 989     aout_sys_t *sys = aout->sys;
 990     pa_context *ctx = sys->context;
 991
 992     pa_threaded_mainloop_lock(sys->mainloop);
 993     pa_context_set_subscribe_callback(sys->context, NULL, NULL);
 994     pa_threaded_mainloop_unlock(sys->mainloop);
 995     vlc_pa_disconnect(obj, ctx, sys->mainloop);
 996
 997     var_Destroy (aout, "audio-device");
 998     free(sys);
 999 }