modules/audio_output/pulse.c

   1 /*****************************************************************************
   2  * pulse.c : Pulseaudio output plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2008 the VideoLAN team
   5  *
   6  * Authors: Martin Hamrle <hamrle @ post . cz>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 /*****************************************************************************
  24  * Preamble
  25  *****************************************************************************/
  26 #ifdef HAVE_CONFIG_H
  27 # include "config.h"
  28 #endif
  29
  30 #include <vlc_common.h>
  31 #include <vlc_plugin.h>
  32
  33 #include <vlc_aout.h>
  34 #include <vlc_cpu.h>
  35
  36 #include <pulse/pulseaudio.h>
  37 #ifdef X_DISPLAY_MISSING
  38 # error Xlib required due to PulseAudio bug 799!
  39 #endif
  40 #include <vlc_xlib.h>
  41
  42 #include <assert.h>
  43
  44 /*****************************************************************************
  45  * aout_sys_t: Pulseaudio output method descriptor
  46  *****************************************************************************
  47  * This structure is part of the audio output thread descriptor.
  48  * It describes the specific properties of an audio device.
  49  *****************************************************************************/
  50 struct aout_sys_t
  51 {
  52     /** PulseAudio playback stream object */
  53     struct pa_stream *stream;
  54
  55     /** PulseAudio connection context */
  56     struct pa_context *context;
  57
  58     /** Main event loop object */
  59     struct pa_threaded_mainloop *mainloop;
  60
  61     int started;
  62     size_t buffer_size;
  63     mtime_t start_date;
  64 };
  65
  66 #if 0
  67 #define PULSE_DEBUG( ...) \
  68     msg_Dbg( p_aout, __VA_ARGS__ )
  69 #else
  70 #define PULSE_DEBUG( ...) \
  71     (void) 0
  72 #endif
  73
  74
  75 #define CHECK_DEAD_GOTO(label) do { \
  76 if (!p_sys->context || pa_context_get_state(p_sys->context) != PA_CONTEXT_READY || \
  77     !p_sys->stream || pa_stream_get_state(p_sys->stream) != PA_STREAM_READY) { \
  78         msg_Err(p_aout, "Connection died: %s", p_sys->context ? pa_strerror(pa_context_errno(p_sys->context)) : "NULL"); \
  79         goto label; \
  80     }  \
  81 } while(0);
  82
  83 /*****************************************************************************
  84  * Local prototypes
  85  *****************************************************************************/
  86 static int  Open        ( vlc_object_t * );
  87 static void Close       ( vlc_object_t * );
  88 static void Play        ( aout_instance_t * );
  89
  90 static void context_state_cb(pa_context *c, void *userdata);
  91 static void stream_state_cb(pa_stream *s, void * userdata);
  92 static void stream_request_cb(pa_stream *s, size_t length, void *userdata);
  93 static void stream_latency_update_cb(pa_stream *s, void *userdata);
  94 static void success_cb(pa_stream *s, int sucess, void *userdata);
  95 static void uninit(aout_instance_t *p_aout);
  96
  97 /*****************************************************************************
  98  * Module descriptor
  99  *****************************************************************************/
 100 vlc_module_begin ()
 101     set_shortname( "PulseAudio" )
 102     set_description( N_("Pulseaudio audio output") )
 103     set_capability( "audio output", 160 )
 104     set_category( CAT_AUDIO )
 105     set_subcategory( SUBCAT_AUDIO_AOUT )
 106     add_shortcut( "pulseaudio", "pa" )
 107     set_callbacks( Open, Close )
 108 vlc_module_end ()
 109
 110 /*****************************************************************************
 111  * Open: open the audio device
 112  *****************************************************************************/
 113 static int Open ( vlc_object_t *p_this )
 114 {
 115     aout_instance_t *p_aout = (aout_instance_t *)p_this;
 116     struct aout_sys_t * p_sys;
 117     struct pa_sample_spec ss;
 118     const struct pa_buffer_attr *buffer_attr;
 119     struct pa_buffer_attr a;
 120     struct pa_channel_map map;
 121     char * p_client_name;
 122
 123     if( !vlc_xlib_init( p_this ) )
 124         return VLC_EGENERIC;
 125
 126     /* Allocate structures */
 127     p_aout->output.p_sys = p_sys = calloc( 1, sizeof( aout_sys_t ) );
 128     if( p_sys == NULL )
 129         return VLC_ENOMEM;
 130
 131     PULSE_DEBUG( "Pulse start initialization");
 132
 133     ss.channels = aout_FormatNbChannels( &p_aout->output.output ); /* Get the input stream channel count */
 134
 135     /* Setup the pulse audio stream based on the input stream count */
 136     switch(ss.channels)
 137     {
 138         case 8:
 139             p_aout->output.output.i_physical_channels
 140                 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 141                 | AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT
 142                 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
 143                 | AOUT_CHAN_LFE;
 144             break;
 145         case 6:
 146             p_aout->output.output.i_physical_channels
 147                 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 148                 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
 149                 | AOUT_CHAN_LFE;
 150             break;
 151
 152         case 4:
 153             p_aout->output.output.i_physical_channels
 154                 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
 155                 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
 156             break;
 157
 158         case 2:
 159             p_aout->output.output.i_physical_channels
 160                 = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
 161             break;
 162
 163         case 1:
 164             p_aout->output.output.i_physical_channels = AOUT_CHAN_CENTER;
 165             break;
 166
 167         default:
 168             msg_Err(p_aout,"Invalid number of channels");
 169         goto fail;
 170     }
 171
 172     /* Add a quick command line info message */
 173     msg_Dbg(p_aout, "%d audio channels", ss.channels);
 174
 175     ss.rate = p_aout->output.output.i_rate;
 176     if (HAVE_FPU)
 177     {
 178         ss.format = PA_SAMPLE_FLOAT32NE;
 179         p_aout->output.output.i_format = VLC_CODEC_FL32;
 180     }
 181     else
 182     {
 183         ss.format = PA_SAMPLE_S16NE;
 184         p_aout->output.output.i_format = VLC_CODEC_S16N;
 185     }
 186
 187     if (!pa_sample_spec_valid(&ss)) {
 188         msg_Err(p_aout,"Invalid sample spec");
 189         goto fail;
 190     }
 191
 192     /* Reduce overall latency to 200mS to reduce audible clicks
 193      * Also pulse minreq and internal buffers are now 20mS which reduces resampling
 194      */
 195     a.tlength = pa_bytes_per_second(&ss)/5;
 196     a.maxlength = a.tlength * 2;
 197     a.prebuf = a.tlength / 2;
 198     a.minreq = a.tlength / 10;
 199
 200     /* Buffer size is 20mS */
 201     p_sys->buffer_size = a.minreq;
 202
 203     /* Initialise the speaker map setup above */
 204     pa_channel_map_init_auto(&map, ss.channels, PA_CHANNEL_MAP_ALSA);
 205
 206     if (!(p_sys->mainloop = pa_threaded_mainloop_new())) {
 207         msg_Err(p_aout, "Failed to allocate main loop");
 208         goto fail;
 209     }
 210
 211     if ((p_client_name = var_InheritString(p_aout, "user-agent")) == NULL) {
 212         msg_Err(p_aout, "No user-agent string available.");
 213         goto fail;
 214     }
 215
 216     p_sys->context = pa_context_new(pa_threaded_mainloop_get_api(p_sys->mainloop), p_client_name);
 217     free(p_client_name);
 218     if(!p_sys->context)
 219     {
 220         msg_Err(p_aout, "Failed to allocate context");
 221         goto fail;
 222     }
 223
 224     pa_context_set_state_callback(p_sys->context, context_state_cb, p_aout);
 225
 226     PULSE_DEBUG( "Pulse before context connect");
 227
 228     if (pa_context_connect(p_sys->context, NULL, 0, NULL) < 0) {
 229         msg_Err(p_aout, "Failed to connect to server: %s", pa_strerror(pa_context_errno(p_sys->context)));
 230         goto fail;
 231     }
 232
 233     PULSE_DEBUG( "Pulse after context connect");
 234
 235     pa_threaded_mainloop_lock(p_sys->mainloop);
 236
 237     if (pa_threaded_mainloop_start(p_sys->mainloop) < 0) {
 238         msg_Err(p_aout, "Failed to start main loop");
 239         goto unlock_and_fail;
 240     }
 241
 242     msg_Dbg(p_aout, "Pulse mainloop started");
 243
 244     /* Wait until the context is ready */
 245     pa_threaded_mainloop_wait(p_sys->mainloop);
 246
 247     if (pa_context_get_state(p_sys->context) != PA_CONTEXT_READY) {
 248         msg_Dbg(p_aout, "Failed to connect to server: %s", pa_strerror(pa_context_errno(p_sys->context)));
 249         goto unlock_and_fail;
 250     }
 251
 252     if (!(p_sys->stream = pa_stream_new(p_sys->context, "audio stream", &ss, &map))) {
 253         msg_Err(p_aout, "Failed to create stream: %s", pa_strerror(pa_context_errno(p_sys->context)));
 254         goto unlock_and_fail;
 255     }
 256
 257     PULSE_DEBUG( "Pulse after new stream");
 258
 259     pa_stream_set_state_callback(p_sys->stream, stream_state_cb, p_aout);
 260     pa_stream_set_write_callback(p_sys->stream, stream_request_cb, p_aout);
 261     pa_stream_set_latency_update_callback(p_sys->stream, stream_latency_update_cb, p_aout);
 262
 263     if (pa_stream_connect_playback(p_sys->stream, NULL, &a, PA_STREAM_INTERPOLATE_TIMING|PA_STREAM_AUTO_TIMING_UPDATE|PA_STREAM_ADJUST_LATENCY, NULL, NULL) < 0) {
 264         msg_Err(p_aout, "Failed to connect stream: %s", pa_strerror(pa_context_errno(p_sys->context)));
 265         goto unlock_and_fail;
 266     }
 267
 268      PULSE_DEBUG("Pulse stream connect");
 269
 270     /* Wait until the stream is ready */
 271     pa_threaded_mainloop_wait(p_sys->mainloop);
 272
 273     msg_Dbg(p_aout,"Pulse stream connected");
 274
 275     if (pa_stream_get_state(p_sys->stream) != PA_STREAM_READY) {
 276         msg_Err(p_aout, "Failed to connect to server: %s", pa_strerror(pa_context_errno(p_sys->context)));
 277         goto unlock_and_fail;
 278     }
 279
 280
 281     PULSE_DEBUG("Pulse after stream get status");
 282
 283     pa_threaded_mainloop_unlock(p_sys->mainloop);
 284
 285     buffer_attr = pa_stream_get_buffer_attr(p_sys->stream);
 286     p_aout->output.i_nb_samples = buffer_attr->minreq / pa_frame_size(&ss);
 287     p_aout->output.pf_play = Play;
 288     aout_VolumeSoftInit(p_aout);
 289     msg_Dbg(p_aout, "Pulse initialized successfully");
 290     {
 291         char cmt[PA_CHANNEL_MAP_SNPRINT_MAX], sst[PA_SAMPLE_SPEC_SNPRINT_MAX];
 292
 293         msg_Dbg(p_aout, "Buffer metrics: maxlength=%u, tlength=%u, prebuf=%u, minreq=%u", buffer_attr->maxlength, buffer_attr->tlength, buffer_attr->prebuf, buffer_attr->minreq);
 294         msg_Dbg(p_aout, "Using sample spec '%s', channel map '%s'.",
 295                 pa_sample_spec_snprint(sst, sizeof(sst), pa_stream_get_sample_spec(p_sys->stream)),
 296                 pa_channel_map_snprint(cmt, sizeof(cmt), pa_stream_get_channel_map(p_sys->stream)));
 297
 298             msg_Dbg(p_aout, "Connected to device %s (%u, %ssuspended).",
 299                         pa_stream_get_device_name(p_sys->stream),
 300                         pa_stream_get_device_index(p_sys->stream),
 301                         pa_stream_is_suspended(p_sys->stream) ? "" : "not ");
 302     }
 303
 304     return VLC_SUCCESS;
 305
 306 unlock_and_fail:
 307     msg_Dbg(p_aout, "Pulse initialization unlock and fail");
 308
 309     if (p_sys->mainloop)
 310         pa_threaded_mainloop_unlock(p_sys->mainloop);
 311 fail:
 312     msg_Dbg(p_aout, "Pulse initialization failed");
 313     uninit(p_aout);
 314     return VLC_EGENERIC;
 315 }
 316
 317 /*****************************************************************************
 318  * Play: play a sound samples buffer
 319  *****************************************************************************/
 320 static void Play( aout_instance_t * p_aout )
 321 {
 322     struct aout_sys_t * p_sys = (struct aout_sys_t *) p_aout->output.p_sys;
 323
 324     if(!p_sys->started){
 325         msg_Dbg(p_aout, "Pulse stream started");
 326         pa_threaded_mainloop_lock(p_sys->mainloop);
 327         p_sys->start_date =
 328             aout_FifoFirstDate( p_aout, &p_aout->output.fifo );
 329         p_sys->started = 1;
 330
 331         pa_threaded_mainloop_signal(p_sys->mainloop, 0);
 332         pa_threaded_mainloop_unlock(p_sys->mainloop);
 333     }
 334 }
 335
 336 /*****************************************************************************
 337  * Close: close the audio device
 338  *****************************************************************************/
 339 static void Close ( vlc_object_t *p_this )
 340 {
 341     aout_instance_t *p_aout = (aout_instance_t *)p_this;
 342     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 343
 344     msg_Dbg(p_aout, "Pulse Close");
 345
 346     if(p_sys->stream){
 347         pa_threaded_mainloop_lock(p_sys->mainloop);
 348         pa_stream_set_write_callback(p_sys->stream, NULL, NULL);
 349
 350         pa_operation *o;
 351
 352         o = pa_stream_flush(p_sys->stream, success_cb, p_aout);
 353         while( pa_operation_get_state(o) == PA_OPERATION_RUNNING )
 354             pa_threaded_mainloop_wait(p_sys->mainloop);
 355         pa_operation_unref(o);
 356
 357         o = pa_stream_drain(p_sys->stream, success_cb, p_aout);
 358         while( pa_operation_get_state(o) == PA_OPERATION_RUNNING )
 359             pa_threaded_mainloop_wait(p_sys->mainloop);
 360         pa_operation_unref(o);
 361
 362         pa_threaded_mainloop_unlock(p_sys->mainloop);
 363     }
 364     uninit(p_aout);
 365 }
 366
 367 static void uninit(aout_instance_t *p_aout){
 368     struct aout_sys_t * p_sys = p_aout->output.p_sys;
 369
 370     if (p_sys->mainloop)
 371         pa_threaded_mainloop_stop(p_sys->mainloop);
 372
 373     if (p_sys->stream) {
 374         pa_stream_disconnect(p_sys->stream);
 375         pa_stream_unref(p_sys->stream);
 376         p_sys->stream = NULL;
 377     }
 378
 379     if (p_sys->context) {
 380         pa_context_disconnect(p_sys->context);
 381         pa_context_unref(p_sys->context);
 382         p_sys->context = NULL;
 383     }
 384
 385     if (p_sys->mainloop) {
 386         pa_threaded_mainloop_free(p_sys->mainloop);
 387         p_sys->mainloop = NULL;
 388     }
 389
 390     free(p_sys);
 391     p_aout->output.p_sys = NULL;
 392 }
 393
 394 static void context_state_cb(pa_context *c, void *userdata) {
 395     aout_instance_t *p_aout = (aout_instance_t *)userdata;
 396     struct aout_sys_t * p_sys = (struct aout_sys_t *) p_aout->output.p_sys;
 397
 398     assert(c);
 399
 400     PULSE_DEBUG( "Pulse context state changed");
 401
 402     switch (pa_context_get_state(c)) {
 403         case PA_CONTEXT_READY:
 404         case PA_CONTEXT_TERMINATED:
 405         case PA_CONTEXT_FAILED:
 406         PULSE_DEBUG( "Pulse context state changed signal");
 407             pa_threaded_mainloop_signal(p_sys->mainloop, 0);
 408             break;
 409
 410         case PA_CONTEXT_UNCONNECTED:
 411         case PA_CONTEXT_CONNECTING:
 412         case PA_CONTEXT_AUTHORIZING:
 413         case PA_CONTEXT_SETTING_NAME:
 414         PULSE_DEBUG( "Pulse context state changed no signal");
 415             break;
 416     }
 417 }
 418
 419 static void stream_state_cb(pa_stream *s, void * userdata) {
 420     aout_instance_t *p_aout = (aout_instance_t *)userdata;
 421     struct aout_sys_t * p_sys = (struct aout_sys_t *) p_aout->output.p_sys;
 422
 423     assert(s);
 424
 425     PULSE_DEBUG( "Pulse stream state changed");
 426
 427     switch (pa_stream_get_state(s)) {
 428
 429         case PA_STREAM_READY:
 430         case PA_STREAM_FAILED:
 431         case PA_STREAM_TERMINATED:
 432             pa_threaded_mainloop_signal(p_sys->mainloop, 0);
 433             break;
 434
 435         case PA_STREAM_UNCONNECTED:
 436         case PA_STREAM_CREATING:
 437             break;
 438     }
 439 }
 440
 441 static void stream_request_cb(pa_stream *s, size_t length, void *userdata) {
 442     VLC_UNUSED( s );
 443     aout_instance_t *p_aout = (aout_instance_t *)userdata;
 444     struct aout_sys_t * p_sys = (struct aout_sys_t *) p_aout->output.p_sys;
 445     mtime_t next_date;
 446
 447     assert(s);
 448     assert(p_sys);
 449
 450     size_t buffer_size = p_sys->buffer_size;
 451
 452     PULSE_DEBUG( "Pulse stream request %d", length);
 453
 454     do{
 455         aout_buffer_t *   p_buffer = NULL;
 456         if(p_sys->started){
 457             pa_usec_t latency;
 458             int negative;
 459             if(pa_stream_get_latency(p_sys->stream, &latency, &negative)<0){
 460                 if (pa_context_errno(p_sys->context) != PA_ERR_NODATA) {
 461                     msg_Err(p_aout, "pa_stream_get_latency() failed: %s", pa_strerror(pa_context_errno(p_sys->context)));
 462                 }
 463                 latency = 0;
 464
 465             }
 466
 467             PULSE_DEBUG( "Pulse stream request latency=%"PRId64"", latency);
 468             next_date = mdate() + latency;
 469
 470             if(p_sys->start_date < next_date + AOUT_PTS_TOLERANCE ){
 471                 p_buffer = aout_OutputNextBuffer( p_aout, next_date, 0);
 472             }
 473         }
 474
 475         if ( p_buffer != NULL )
 476         {
 477             PULSE_DEBUG( "Pulse stream request write buffer %d", p_buffer->i_buffer);
 478             pa_stream_write(p_sys->stream, p_buffer->p_buffer, p_buffer->i_buffer, NULL, 0, PA_SEEK_RELATIVE);
 479             length -= p_buffer->i_buffer;
 480             aout_BufferFree( p_buffer );
 481         }
 482         else
 483         {
 484             PULSE_DEBUG( "Pulse stream request write zeroes");
 485             void *data = pa_xmalloc(buffer_size);
 486             bzero(data, buffer_size);
 487             pa_stream_write(p_sys->stream, data, buffer_size, pa_xfree, 0, PA_SEEK_RELATIVE);
 488             length -= buffer_size;
 489         }
 490     }while(length > buffer_size);
 491
 492     pa_threaded_mainloop_signal(p_sys->mainloop, 0);
 493 }
 494
 495 static void stream_latency_update_cb(pa_stream *s, void *userdata) {
 496     VLC_UNUSED( s );
 497     aout_instance_t *p_aout = (aout_instance_t *)userdata;
 498     struct aout_sys_t * p_sys = (struct aout_sys_t *) p_aout->output.p_sys;
 499
 500     assert(s);
 501
 502     PULSE_DEBUG( "Pulse stream latency update");
 503
 504     pa_threaded_mainloop_signal(p_sys->mainloop, 0);
 505 }
 506
 507 static void success_cb(pa_stream *s, int sucess, void *userdata)
 508 {
 509     VLC_UNUSED( s );
 510     aout_instance_t *p_aout = (aout_instance_t *)userdata;
 511     struct aout_sys_t * p_sys = (struct aout_sys_t *) p_aout->output.p_sys;
 512
 513     VLC_UNUSED(sucess);
 514
 515     assert(s);
 516
 517     pa_threaded_mainloop_signal(p_sys->mainloop, 0);
 518 }
 519
 520 #undef PULSE_DEBUG