libao2/ao_pulse.c

   1 /*
   2  * PulseAudio audio output driver.
   3  * Copyright (C) 2006 Lennart Poettering
   4  * Copyright (C) 2007 Reimar Doeffinger
   5  *
   6  * This file is part of MPlayer.
   7  *
   8  * MPlayer 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  * MPlayer 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 along
  19  * with MPlayer; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 #include <string.h>
  24
  25 #include <pulse/pulseaudio.h>
  26
  27 #include "config.h"
  28 #include "libaf/af_format.h"
  29 #include "mp_msg.h"
  30 #include "audio_out.h"
  31 #include "audio_out_internal.h"
  32
  33 #define PULSE_CLIENT_NAME "MPlayer"
  34
  35 /** General driver info */
  36 static const ao_info_t info = {
  37     "PulseAudio audio output",
  38     "pulse",
  39     "Lennart Poettering",
  40     ""
  41 };
  42
  43 /** PulseAudio playback stream object */
  44 static struct pa_stream *stream;
  45
  46 /** PulseAudio connection context */
  47 static struct pa_context *context;
  48
  49 /** Main event loop object */
  50 static struct pa_threaded_mainloop *mainloop;
  51
  52 /** A temporary variable to store the current volume */
  53 static pa_cvolume volume;
  54
  55 static int broken_pause;
  56
  57 LIBAO_EXTERN(pulse)
  58
  59 #define GENERIC_ERR_MSG(ctx, str) \
  60     mp_msg(MSGT_AO, MSGL_ERR, "AO: [pulse] "str": %s\n", \
  61     pa_strerror(pa_context_errno(ctx)))
  62
  63 static void context_state_cb(pa_context *c, void *userdata) {
  64     switch (pa_context_get_state(c)) {
  65         case PA_CONTEXT_READY:
  66         case PA_CONTEXT_TERMINATED:
  67         case PA_CONTEXT_FAILED:
  68             pa_threaded_mainloop_signal(mainloop, 0);
  69             break;
  70     }
  71 }
  72
  73 static void stream_state_cb(pa_stream *s, void *userdata) {
  74     switch (pa_stream_get_state(s)) {
  75         case PA_STREAM_READY:
  76         case PA_STREAM_FAILED:
  77         case PA_STREAM_TERMINATED:
  78             pa_threaded_mainloop_signal(mainloop, 0);
  79             break;
  80     }
  81 }
  82
  83 static void stream_request_cb(pa_stream *s, size_t length, void *userdata) {
  84     pa_threaded_mainloop_signal(mainloop, 0);
  85 }
  86
  87 static void stream_latency_update_cb(pa_stream *s, void *userdata) {
  88     pa_threaded_mainloop_signal(mainloop, 0);
  89 }
  90
  91 static void success_cb(pa_stream *s, int success, void *userdata) {
  92     if (userdata)
  93         *(int *)userdata = success;
  94     pa_threaded_mainloop_signal(mainloop, 0);
  95 }
  96
  97 /**
  98  * \brief waits for a pulseaudio operation to finish, frees it and
  99  *        unlocks the mainloop
 100  * \param op operation to wait for
 101  * \return 1 if operation has finished normally (DONE state), 0 otherwise
 102  */
 103 static int waitop(pa_operation *op) {
 104     pa_operation_state_t state;
 105     if (!op) return 0;
 106     state = pa_operation_get_state(op);
 107     while (state == PA_OPERATION_RUNNING) {
 108         pa_threaded_mainloop_wait(mainloop);
 109         state = pa_operation_get_state(op);
 110     }
 111     pa_operation_unref(op);
 112     pa_threaded_mainloop_unlock(mainloop);
 113     return state == PA_OPERATION_DONE;
 114 }
 115
 116 static const struct format_map_s {
 117     int mp_format;
 118     pa_sample_format_t pa_format;
 119 } format_maps[] = {
 120     {AF_FORMAT_S16_LE, PA_SAMPLE_S16LE},
 121     {AF_FORMAT_S16_BE, PA_SAMPLE_S16BE},
 122 #ifdef PA_SAMPLE_S32NE
 123     {AF_FORMAT_S32_LE, PA_SAMPLE_S32LE},
 124     {AF_FORMAT_S32_BE, PA_SAMPLE_S32BE},
 125 #endif
 126 #ifdef PA_SAMPLE_FLOAT32NE
 127     {AF_FORMAT_FLOAT_LE, PA_SAMPLE_FLOAT32LE},
 128     {AF_FORMAT_FLOAT_BE, PA_SAMPLE_FLOAT32BE},
 129 #endif
 130     {AF_FORMAT_U8, PA_SAMPLE_U8},
 131     {AF_FORMAT_MU_LAW, PA_SAMPLE_ULAW},
 132     {AF_FORMAT_A_LAW, PA_SAMPLE_ALAW},
 133     {AF_FORMAT_UNKNOWN, 0}
 134 };
 135
 136 static int init(int rate_hz, int channels, int format, int flags) {
 137     struct pa_sample_spec ss;
 138     struct pa_channel_map map;
 139     const struct format_map_s *fmt_map;
 140     char *devarg = NULL;
 141     char *host = NULL;
 142     char *sink = NULL;
 143     char *version = pa_get_library_version();
 144
 145     if (ao_subdevice) {
 146         devarg = strdup(ao_subdevice);
 147         sink = strchr(devarg, ':');
 148         if (sink) *sink++ = 0;
 149         if (devarg[0]) host = devarg;
 150     }
 151
 152     broken_pause = 0;
 153     // not sure which versions are affected, assume 0.9.1*
 154     // known bad: 0.9.14, 0.9.13
 155     // known good: 0.9.9, 0.9.10
 156     // to test: pause, wait ca. 5 seconds framestep and see if MPlayer hangs somewhen
 157     if (strncmp(version, "0.9.1", 5) == 0 && strncmp(version, "0.9.10", 6) != 0) {
 158         mp_msg(MSGT_AO, MSGL_WARN, "[pulse] working around probably broken pause functionality,\n"
 159                                    "        see http://www.pulseaudio.org/ticket/440\n");
 160         broken_pause = 1;
 161     }
 162
 163     ss.channels = channels;
 164     ss.rate = rate_hz;
 165
 166     ao_data.samplerate = rate_hz;
 167     ao_data.channels = channels;
 168
 169     fmt_map = format_maps;
 170     while (fmt_map->mp_format != format) {
 171         if (fmt_map->mp_format == AF_FORMAT_UNKNOWN) {
 172             mp_msg(MSGT_AO, MSGL_V, "AO: [pulse] Unsupported format, using default\n");
 173             fmt_map = format_maps;
 174             break;
 175         }
 176         fmt_map++;
 177     }
 178     ao_data.format = fmt_map->mp_format;
 179     ss.format = fmt_map->pa_format;
 180
 181     if (!pa_sample_spec_valid(&ss)) {
 182         mp_msg(MSGT_AO, MSGL_ERR, "AO: [pulse] Invalid sample spec\n");
 183         goto fail;
 184     }
 185
 186     pa_channel_map_init_auto(&map, ss.channels, PA_CHANNEL_MAP_ALSA);
 187     ao_data.bps = pa_bytes_per_second(&ss);
 188
 189     pa_cvolume_reset(&volume, ss.channels);
 190
 191     if (!(mainloop = pa_threaded_mainloop_new())) {
 192         mp_msg(MSGT_AO, MSGL_ERR, "AO: [pulse] Failed to allocate main loop\n");
 193         goto fail;
 194     }
 195
 196     if (!(context = pa_context_new(pa_threaded_mainloop_get_api(mainloop), PULSE_CLIENT_NAME))) {
 197         mp_msg(MSGT_AO, MSGL_ERR, "AO: [pulse] Failed to allocate context\n");
 198         goto fail;
 199     }
 200
 201     pa_context_set_state_callback(context, context_state_cb, NULL);
 202
 203     if (pa_context_connect(context, host, 0, NULL) < 0)
 204         goto fail;
 205
 206     pa_threaded_mainloop_lock(mainloop);
 207
 208     if (pa_threaded_mainloop_start(mainloop) < 0)
 209         goto unlock_and_fail;
 210
 211     /* Wait until the context is ready */
 212     pa_threaded_mainloop_wait(mainloop);
 213
 214     if (pa_context_get_state(context) != PA_CONTEXT_READY)
 215         goto unlock_and_fail;
 216
 217     if (!(stream = pa_stream_new(context, "audio stream", &ss, &map)))
 218         goto unlock_and_fail;
 219
 220     pa_stream_set_state_callback(stream, stream_state_cb, NULL);
 221     pa_stream_set_write_callback(stream, stream_request_cb, NULL);
 222     pa_stream_set_latency_update_callback(stream, stream_latency_update_cb, NULL);
 223
 224     if (pa_stream_connect_playback(stream, sink, NULL, PA_STREAM_INTERPOLATE_TIMING|PA_STREAM_AUTO_TIMING_UPDATE, &volume, NULL) < 0)
 225         goto unlock_and_fail;
 226
 227     /* Wait until the stream is ready */
 228     pa_threaded_mainloop_wait(mainloop);
 229
 230     if (pa_stream_get_state(stream) != PA_STREAM_READY)
 231         goto unlock_and_fail;
 232
 233     pa_threaded_mainloop_unlock(mainloop);
 234
 235     free(devarg);
 236     return 1;
 237
 238 unlock_and_fail:
 239
 240     if (mainloop)
 241         pa_threaded_mainloop_unlock(mainloop);
 242
 243 fail:
 244     if (context)
 245         GENERIC_ERR_MSG(context, "Init failed");
 246     free(devarg);
 247     uninit(1);
 248     return 0;
 249 }
 250
 251 /** Destroy libao driver */
 252 static void uninit(int immed) {
 253     if (stream && !immed) {
 254             pa_threaded_mainloop_lock(mainloop);
 255             waitop(pa_stream_drain(stream, success_cb, NULL));
 256     }
 257
 258     if (mainloop)
 259         pa_threaded_mainloop_stop(mainloop);
 260
 261     if (stream) {
 262         pa_stream_disconnect(stream);
 263         pa_stream_unref(stream);
 264         stream = NULL;
 265     }
 266
 267     if (context) {
 268         pa_context_disconnect(context);
 269         pa_context_unref(context);
 270         context = NULL;
 271     }
 272
 273     if (mainloop) {
 274         pa_threaded_mainloop_free(mainloop);
 275         mainloop = NULL;
 276     }
 277 }
 278
 279 /** Play the specified data to the pulseaudio server */
 280 static int play(void* data, int len, int flags) {
 281     pa_threaded_mainloop_lock(mainloop);
 282     if (pa_stream_write(stream, data, len, NULL, 0, PA_SEEK_RELATIVE) < 0) {
 283         GENERIC_ERR_MSG(context, "pa_stream_write() failed");
 284         len = -1;
 285     }
 286     pa_threaded_mainloop_unlock(mainloop);
 287     return len;
 288 }
 289
 290 static void cork(int b) {
 291     int success = 0;
 292     pa_threaded_mainloop_lock(mainloop);
 293     if (!waitop(pa_stream_cork(stream, b, success_cb, &success)) ||
 294         !success)
 295         GENERIC_ERR_MSG(context, "pa_stream_cork() failed");
 296 }
 297
 298 /** Pause the audio stream by corking it on the server */
 299 static void audio_pause(void) {
 300     cork(1);
 301 }
 302
 303 /** Resume the audio stream by uncorking it on the server */
 304 static void audio_resume(void) {
 305     // without this, certain versions will cause an infinite hang because
 306     // pa_stream_writable_size returns 0 always.
 307     // Note that this workaround causes A-V desync after pause
 308     if (broken_pause) reset();
 309     cork(0);
 310 }
 311
 312 /** Reset the audio stream, i.e. flush the playback buffer on the server side */
 313 static void reset(void) {
 314     int success = 0;
 315     pa_threaded_mainloop_lock(mainloop);
 316     if (!waitop(pa_stream_flush(stream, success_cb, &success)) ||
 317         !success)
 318         GENERIC_ERR_MSG(context, "pa_stream_flush() failed");
 319 }
 320
 321 /** Return number of bytes that may be written to the server without blocking */
 322 static int get_space(void) {
 323     size_t l;
 324     pa_threaded_mainloop_lock(mainloop);
 325     l = pa_stream_writable_size(stream);
 326     pa_threaded_mainloop_unlock(mainloop);
 327     return l;
 328 }
 329
 330 /** Return the current latency in seconds */
 331 static float get_delay(void) {
 332     pa_usec_t latency = (pa_usec_t) -1;
 333     pa_threaded_mainloop_lock(mainloop);
 334     while (pa_stream_get_latency(stream, &latency, NULL) < 0) {
 335         if (pa_context_errno(context) != PA_ERR_NODATA) {
 336             GENERIC_ERR_MSG(context, "pa_stream_get_latency() failed");
 337             break;
 338         }
 339         /* Wait until latency data is available again */
 340         pa_threaded_mainloop_wait(mainloop);
 341     }
 342     pa_threaded_mainloop_unlock(mainloop);
 343     return latency == (pa_usec_t) -1 ? 0 : latency / 1000000.0;
 344 }
 345
 346 /** A callback function that is called when the
 347  * pa_context_get_sink_input_info() operation completes. Saves the
 348  * volume field of the specified structure to the global variable volume. */
 349 static void info_func(struct pa_context *c, const struct pa_sink_input_info *i, int is_last, void *userdata) {
 350     if (is_last < 0) {
 351         GENERIC_ERR_MSG(context, "Failed to get sink input info");
 352         return;
 353     }
 354     if (!i)
 355         return;
 356     volume = i->volume;
 357     pa_threaded_mainloop_signal(mainloop, 0);
 358 }
 359
 360 static int control(int cmd, void *arg) {
 361     switch (cmd) {
 362         case AOCONTROL_GET_VOLUME: {
 363             ao_control_vol_t *vol = arg;
 364             uint32_t devidx = pa_stream_get_index(stream);
 365             pa_threaded_mainloop_lock(mainloop);
 366             if (!waitop(pa_context_get_sink_input_info(context, devidx, info_func, NULL))) {
 367                 GENERIC_ERR_MSG(context, "pa_stream_get_sink_input_info() failed");
 368                 return CONTROL_ERROR;
 369             }
 370
 371             if (volume.channels != 2)
 372                 vol->left = vol->right = pa_cvolume_avg(&volume)*100/PA_VOLUME_NORM;
 373             else {
 374                 vol->left = volume.values[0]*100/PA_VOLUME_NORM;
 375                 vol->right = volume.values[1]*100/PA_VOLUME_NORM;
 376             }
 377
 378             return CONTROL_OK;
 379         }
 380
 381         case AOCONTROL_SET_VOLUME: {
 382             const ao_control_vol_t *vol = arg;
 383             pa_operation *o;
 384
 385             if (volume.channels != 2)
 386                 pa_cvolume_set(&volume, volume.channels, (pa_volume_t)vol->left*PA_VOLUME_NORM/100);
 387             else {
 388                 volume.values[0] = (pa_volume_t)vol->left*PA_VOLUME_NORM/100;
 389                 volume.values[1] = (pa_volume_t)vol->right*PA_VOLUME_NORM/100;
 390             }
 391
 392             if (!(o = pa_context_set_sink_input_volume(context, pa_stream_get_index(stream), &volume, NULL, NULL))) {
 393                 GENERIC_ERR_MSG(context, "pa_context_set_sink_input_volume() failed");
 394                 return CONTROL_ERROR;
 395             }
 396             /* We don't wait for completion here */
 397             pa_operation_unref(o);
 398             return CONTROL_OK;
 399         }
 400
 401         default:
 402             return CONTROL_UNKNOWN;
 403     }
 404 }