ext/pulse/pulsesink.c

   1 /*-*- Mode: C; c-basic-offset: 2 -*-*/
   2
   3 /*  GStreamer pulseaudio plugin
   4  *
   5  *  Copyright (c) 2004-2008 Lennart Poettering
   6  *            (c) 2009      Wim Taymans
   7  *
   8  *  gst-pulse is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU Lesser General Public License as
  10  *  published by the Free Software Foundation; either version 2.1 of the
  11  *  License, or (at your option) any later version.
  12  *
  13  *  gst-pulse is distributed in the hope that it will be useful, but
  14  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16  *  Lesser General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU Lesser General Public
  19  *  License along with gst-pulse; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21  *  USA.
  22  */
  23
  24 /**
  25  * SECTION:element-pulsesink
  26  * @see_also: pulsesrc
  27  *
  28  * This element outputs audio to a
  29  * <ulink href="http://www.pulseaudio.org">PulseAudio sound server</ulink>.
  30  *
  31  * <refsect2>
  32  * <title>Example pipelines</title>
  33  * |[
  34  * gst-launch-1.0 -v filesrc location=sine.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! pulsesink
  35  * ]| Play an Ogg/Vorbis file.
  36  * |[
  37  * gst-launch-1.0 -v audiotestsrc ! audioconvert ! volume volume=0.4 ! pulsesink
  38  * ]| Play a 440Hz sine wave.
  39  * |[
  40  * gst-launch-1.0 -v audiotestsrc ! pulsesink stream-properties="props,media.title=test"
  41  * ]| Play a sine wave and set a stream property. The property can be checked
  42  * with "pactl list".
  43  * </refsect2>
  44  */
  45
  46 #ifdef HAVE_CONFIG_H
  47 #include "config.h"
  48 #endif
  49
  50 #include <string.h>
  51 #include <stdio.h>
  52
  53 #include <gst/base/gstbasesink.h>
  54 #include <gst/gsttaglist.h>
  55 #include <gst/audio/streamvolume.h>
  56 #include <gst/gst-i18n-plugin.h>
  57 #include <gst/audio/gstaudioiec61937.h>
  58
  59 #include <gst/pbutils/pbutils.h>        /* only used for GST_PLUGINS_BASE_VERSION_* */
  60
  61 #include <gst/glib-compat-private.h>
  62
  63 #include "pulsesink.h"
  64 #include "pulseutil.h"
  65
  66 GST_DEBUG_CATEGORY_EXTERN (pulse_debug);
  67 #define GST_CAT_DEFAULT pulse_debug
  68
  69 #define DEFAULT_SERVER          NULL
  70 #define DEFAULT_DEVICE          NULL
  71 #define DEFAULT_DEVICE_NAME     NULL
  72 #define DEFAULT_VOLUME          1.0
  73 #define DEFAULT_MUTE            FALSE
  74 #define MAX_VOLUME              10.0
  75
  76 enum
  77 {
  78   PROP_0,
  79   PROP_SERVER,
  80   PROP_DEVICE,
  81   PROP_DEVICE_NAME,
  82   PROP_VOLUME,
  83   PROP_MUTE,
  84   PROP_CLIENT_NAME,
  85   PROP_STREAM_PROPERTIES,
  86   PROP_LAST
  87 };
  88
  89 #define GST_TYPE_PULSERING_BUFFER        \
  90         (gst_pulseringbuffer_get_type())
  91 #define GST_PULSERING_BUFFER(obj)        \
  92         (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PULSERING_BUFFER,GstPulseRingBuffer))
  93 #define GST_PULSERING_BUFFER_CLASS(klass) \
  94         (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PULSERING_BUFFER,GstPulseRingBufferClass))
  95 #define GST_PULSERING_BUFFER_GET_CLASS(obj) \
  96         (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PULSERING_BUFFER, GstPulseRingBufferClass))
  97 #define GST_PULSERING_BUFFER_CAST(obj)        \
  98         ((GstPulseRingBuffer *)obj)
  99 #define GST_IS_PULSERING_BUFFER(obj)     \
 100         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PULSERING_BUFFER))
 101 #define GST_IS_PULSERING_BUFFER_CLASS(klass)\
 102         (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PULSERING_BUFFER))
 103
 104 typedef struct _GstPulseRingBuffer GstPulseRingBuffer;
 105 typedef struct _GstPulseRingBufferClass GstPulseRingBufferClass;
 106
 107 typedef struct _GstPulseContext GstPulseContext;
 108
 109 /* Store the PA contexts in a hash table to allow easy sharing among
 110  * multiple instances of the sink. Keys are $context_name@$server_name
 111  * (strings) and values should be GstPulseContext pointers.
 112  */
 113 struct _GstPulseContext
 114 {
 115   pa_context *context;
 116   GSList *ring_buffers;
 117 };
 118
 119 static GHashTable *gst_pulse_shared_contexts = NULL;
 120
 121 /* use one static main-loop for all instances
 122  * this is needed to make the context sharing work as the contexts are
 123  * released when releasing their parent main-loop
 124  */
 125 static pa_threaded_mainloop *mainloop = NULL;
 126 static guint mainloop_ref_ct = 0;
 127
 128 /* lock for access to shared resources */
 129 static GMutex pa_shared_resource_mutex;
 130
 131 /* We keep a custom ringbuffer that is backed up by data allocated by
 132  * pulseaudio. We must also overide the commit function to write into
 133  * pulseaudio memory instead. */
 134 struct _GstPulseRingBuffer
 135 {
 136   GstAudioRingBuffer object;
 137
 138   gchar *context_name;
 139   gchar *stream_name;
 140
 141   pa_context *context;
 142   pa_stream *stream;
 143
 144   pa_format_info *format;
 145   guint channels;
 146   gboolean is_pcm;
 147
 148   void *m_data;
 149   size_t m_towrite;
 150   size_t m_writable;
 151   gint64 m_offset;
 152   gint64 m_lastoffset;
 153
 154   gboolean corked:1;
 155   gboolean in_commit:1;
 156   gboolean paused:1;
 157 };
 158 struct _GstPulseRingBufferClass
 159 {
 160   GstAudioRingBufferClass parent_class;
 161 };
 162
 163 static GType gst_pulseringbuffer_get_type (void);
 164 static void gst_pulseringbuffer_finalize (GObject * object);
 165
 166 static GstAudioRingBufferClass *ring_parent_class = NULL;
 167
 168 static gboolean gst_pulseringbuffer_open_device (GstAudioRingBuffer * buf);
 169 static gboolean gst_pulseringbuffer_close_device (GstAudioRingBuffer * buf);
 170 static gboolean gst_pulseringbuffer_acquire (GstAudioRingBuffer * buf,
 171     GstAudioRingBufferSpec * spec);
 172 static gboolean gst_pulseringbuffer_release (GstAudioRingBuffer * buf);
 173 static gboolean gst_pulseringbuffer_start (GstAudioRingBuffer * buf);
 174 static gboolean gst_pulseringbuffer_pause (GstAudioRingBuffer * buf);
 175 static gboolean gst_pulseringbuffer_stop (GstAudioRingBuffer * buf);
 176 static void gst_pulseringbuffer_clear (GstAudioRingBuffer * buf);
 177 static guint gst_pulseringbuffer_commit (GstAudioRingBuffer * buf,
 178     guint64 * sample, guchar * data, gint in_samples, gint out_samples,
 179     gint * accum);
 180
 181 G_DEFINE_TYPE (GstPulseRingBuffer, gst_pulseringbuffer,
 182     GST_TYPE_AUDIO_RING_BUFFER);
 183
 184 static void
 185 gst_pulsesink_init_contexts (void)
 186 {
 187   g_mutex_init (&pa_shared_resource_mutex);
 188   gst_pulse_shared_contexts = g_hash_table_new_full (g_str_hash, g_str_equal,
 189       g_free, NULL);
 190 }
 191
 192 static void
 193 gst_pulseringbuffer_class_init (GstPulseRingBufferClass * klass)
 194 {
 195   GObjectClass *gobject_class;
 196   GstAudioRingBufferClass *gstringbuffer_class;
 197
 198   gobject_class = (GObjectClass *) klass;
 199   gstringbuffer_class = (GstAudioRingBufferClass *) klass;
 200
 201   ring_parent_class = g_type_class_peek_parent (klass);
 202
 203   gobject_class->finalize = gst_pulseringbuffer_finalize;
 204
 205   gstringbuffer_class->open_device =
 206       GST_DEBUG_FUNCPTR (gst_pulseringbuffer_open_device);
 207   gstringbuffer_class->close_device =
 208       GST_DEBUG_FUNCPTR (gst_pulseringbuffer_close_device);
 209   gstringbuffer_class->acquire =
 210       GST_DEBUG_FUNCPTR (gst_pulseringbuffer_acquire);
 211   gstringbuffer_class->release =
 212       GST_DEBUG_FUNCPTR (gst_pulseringbuffer_release);
 213   gstringbuffer_class->start = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_start);
 214   gstringbuffer_class->pause = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_pause);
 215   gstringbuffer_class->resume = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_start);
 216   gstringbuffer_class->stop = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_stop);
 217   gstringbuffer_class->clear_all =
 218       GST_DEBUG_FUNCPTR (gst_pulseringbuffer_clear);
 219
 220   gstringbuffer_class->commit = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_commit);
 221 }
 222
 223 static void
 224 gst_pulseringbuffer_init (GstPulseRingBuffer * pbuf)
 225 {
 226   pbuf->stream_name = NULL;
 227   pbuf->context = NULL;
 228   pbuf->stream = NULL;
 229
 230   pbuf->format = NULL;
 231   pbuf->channels = 0;
 232   pbuf->is_pcm = FALSE;
 233
 234   pbuf->m_data = NULL;
 235   pbuf->m_towrite = 0;
 236   pbuf->m_writable = 0;
 237   pbuf->m_offset = 0;
 238   pbuf->m_lastoffset = 0;
 239
 240   pbuf->corked = TRUE;
 241   pbuf->in_commit = FALSE;
 242   pbuf->paused = FALSE;
 243 }
 244
 245 static void
 246 gst_pulsering_destroy_stream (GstPulseRingBuffer * pbuf)
 247 {
 248   if (pbuf->stream) {
 249
 250     if (pbuf->m_data) {
 251       /* drop shm memory buffer */
 252       pa_stream_cancel_write (pbuf->stream);
 253
 254       /* reset internal variables */
 255       pbuf->m_data = NULL;
 256       pbuf->m_towrite = 0;
 257       pbuf->m_writable = 0;
 258       pbuf->m_offset = 0;
 259       pbuf->m_lastoffset = 0;
 260     }
 261     if (pbuf->format) {
 262       pa_format_info_free (pbuf->format);
 263       pbuf->format = NULL;
 264       pbuf->channels = 0;
 265       pbuf->is_pcm = FALSE;
 266     }
 267
 268     pa_stream_disconnect (pbuf->stream);
 269
 270     /* Make sure we don't get any further callbacks */
 271     pa_stream_set_state_callback (pbuf->stream, NULL, NULL);
 272     pa_stream_set_write_callback (pbuf->stream, NULL, NULL);
 273     pa_stream_set_underflow_callback (pbuf->stream, NULL, NULL);
 274     pa_stream_set_overflow_callback (pbuf->stream, NULL, NULL);
 275
 276     pa_stream_unref (pbuf->stream);
 277     pbuf->stream = NULL;
 278   }
 279
 280   g_free (pbuf->stream_name);
 281   pbuf->stream_name = NULL;
 282 }
 283
 284 static void
 285 gst_pulsering_destroy_context (GstPulseRingBuffer * pbuf)
 286 {
 287   g_mutex_lock (&pa_shared_resource_mutex);
 288
 289   GST_DEBUG_OBJECT (pbuf, "destroying ringbuffer %p", pbuf);
 290
 291   gst_pulsering_destroy_stream (pbuf);
 292
 293   if (pbuf->context) {
 294     pa_context_unref (pbuf->context);
 295     pbuf->context = NULL;
 296   }
 297
 298   if (pbuf->context_name) {
 299     GstPulseContext *pctx;
 300
 301     pctx = g_hash_table_lookup (gst_pulse_shared_contexts, pbuf->context_name);
 302
 303     GST_DEBUG_OBJECT (pbuf, "releasing context with name %s, pbuf=%p, pctx=%p",
 304         pbuf->context_name, pbuf, pctx);
 305
 306     if (pctx) {
 307       pctx->ring_buffers = g_slist_remove (pctx->ring_buffers, pbuf);
 308       if (pctx->ring_buffers == NULL) {
 309         GST_DEBUG_OBJECT (pbuf,
 310             "destroying final context with name %s, pbuf=%p, pctx=%p",
 311             pbuf->context_name, pbuf, pctx);
 312
 313         pa_context_disconnect (pctx->context);
 314
 315         /* Make sure we don't get any further callbacks */
 316         pa_context_set_state_callback (pctx->context, NULL, NULL);
 317         pa_context_set_subscribe_callback (pctx->context, NULL, NULL);
 318
 319         g_hash_table_remove (gst_pulse_shared_contexts, pbuf->context_name);
 320
 321         pa_context_unref (pctx->context);
 322         g_slice_free (GstPulseContext, pctx);
 323       }
 324     }
 325     g_free (pbuf->context_name);
 326     pbuf->context_name = NULL;
 327   }
 328   g_mutex_unlock (&pa_shared_resource_mutex);
 329 }
 330
 331 static void
 332 gst_pulseringbuffer_finalize (GObject * object)
 333 {
 334   GstPulseRingBuffer *ringbuffer;
 335
 336   ringbuffer = GST_PULSERING_BUFFER_CAST (object);
 337
 338   gst_pulsering_destroy_context (ringbuffer);
 339   G_OBJECT_CLASS (ring_parent_class)->finalize (object);
 340 }
 341
 342
 343 #define CONTEXT_OK(c) ((c) && PA_CONTEXT_IS_GOOD (pa_context_get_state ((c))))
 344 #define STREAM_OK(s) ((s) && PA_STREAM_IS_GOOD (pa_stream_get_state ((s))))
 345
 346 static gboolean
 347 gst_pulsering_is_dead (GstPulseSink * psink, GstPulseRingBuffer * pbuf,
 348     gboolean check_stream)
 349 {
 350   if (!CONTEXT_OK (pbuf->context))
 351     goto error;
 352
 353   if (check_stream && !STREAM_OK (pbuf->stream))
 354     goto error;
 355
 356   return FALSE;
 357
 358 error:
 359   {
 360     const gchar *err_str =
 361         pbuf->context ? pa_strerror (pa_context_errno (pbuf->context)) : NULL;
 362     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED, ("Disconnected: %s",
 363             err_str), (NULL));
 364     return TRUE;
 365   }
 366 }
 367
 368 static void
 369 gst_pulsering_context_state_cb (pa_context * c, void *userdata)
 370 {
 371   pa_context_state_t state;
 372   pa_threaded_mainloop *mainloop = (pa_threaded_mainloop *) userdata;
 373
 374   state = pa_context_get_state (c);
 375
 376   GST_LOG ("got new context state %d", state);
 377
 378   switch (state) {
 379     case PA_CONTEXT_READY:
 380     case PA_CONTEXT_TERMINATED:
 381     case PA_CONTEXT_FAILED:
 382       GST_LOG ("signaling");
 383       pa_threaded_mainloop_signal (mainloop, 0);
 384       break;
 385
 386     case PA_CONTEXT_UNCONNECTED:
 387     case PA_CONTEXT_CONNECTING:
 388     case PA_CONTEXT_AUTHORIZING:
 389     case PA_CONTEXT_SETTING_NAME:
 390       break;
 391   }
 392 }
 393
 394 static void
 395 gst_pulsering_context_subscribe_cb (pa_context * c,
 396     pa_subscription_event_type_t t, uint32_t idx, void *userdata)
 397 {
 398   GstPulseSink *psink;
 399   GstPulseContext *pctx = (GstPulseContext *) userdata;
 400   GSList *walk;
 401
 402   if (t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT | PA_SUBSCRIPTION_EVENT_CHANGE) &&
 403       t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT | PA_SUBSCRIPTION_EVENT_NEW))
 404     return;
 405
 406   for (walk = pctx->ring_buffers; walk; walk = g_slist_next (walk)) {
 407     GstPulseRingBuffer *pbuf = (GstPulseRingBuffer *) walk->data;
 408     psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
 409
 410     GST_LOG_OBJECT (psink, "type %04x, idx %u", t, idx);
 411
 412     if (!pbuf->stream)
 413       continue;
 414
 415     if (idx != pa_stream_get_index (pbuf->stream))
 416       continue;
 417
 418     if (psink->device && pbuf->is_pcm &&
 419         !g_str_equal (psink->device,
 420             pa_stream_get_device_name (pbuf->stream))) {
 421       /* Underlying sink changed. And this is not a passthrough stream. Let's
 422        * see if someone upstream wants to try to renegotiate. */
 423       GstEvent *renego;
 424
 425       g_free (psink->device);
 426       psink->device = g_strdup (pa_stream_get_device_name (pbuf->stream));
 427
 428       GST_INFO_OBJECT (psink, "emitting sink-changed");
 429
 430       /* FIXME: send reconfigure event instead and let decodebin/playbin
 431        * handle that. Also take care of ac3 alignment. See "pulse-format-lost" */
 432       renego = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM,
 433           gst_structure_new_empty ("pulse-sink-changed"));
 434
 435       if (!gst_pad_push_event (GST_BASE_SINK (psink)->sinkpad, renego))
 436         GST_DEBUG_OBJECT (psink, "Emitted sink-changed - nobody was listening");
 437     }
 438
 439     /* Actually this event is also triggered when other properties of
 440      * the stream change that are unrelated to the volume. However it is
 441      * probably cheaper to signal the change here and check for the
 442      * volume when the GObject property is read instead of querying it always. */
 443
 444     /* inform streaming thread to notify */
 445     g_atomic_int_compare_and_exchange (&psink->notify, 0, 1);
 446   }
 447 }
 448
 449 /* will be called when the device should be opened. In this case we will connect
 450  * to the server. We should not try to open any streams in this state. */
 451 static gboolean
 452 gst_pulseringbuffer_open_device (GstAudioRingBuffer * buf)
 453 {
 454   GstPulseSink *psink;
 455   GstPulseRingBuffer *pbuf;
 456   GstPulseContext *pctx;
 457   pa_mainloop_api *api;
 458   gboolean need_unlock_shared;
 459
 460   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (buf));
 461   pbuf = GST_PULSERING_BUFFER_CAST (buf);
 462
 463   g_assert (!pbuf->stream);
 464   g_assert (psink->client_name);
 465
 466   if (psink->server)
 467     pbuf->context_name = g_strdup_printf ("%s@%s", psink->client_name,
 468         psink->server);
 469   else
 470     pbuf->context_name = g_strdup (psink->client_name);
 471
 472   pa_threaded_mainloop_lock (mainloop);
 473
 474   g_mutex_lock (&pa_shared_resource_mutex);
 475   need_unlock_shared = TRUE;
 476
 477   pctx = g_hash_table_lookup (gst_pulse_shared_contexts, pbuf->context_name);
 478   if (pctx == NULL) {
 479     pctx = g_slice_new0 (GstPulseContext);
 480
 481     /* get the mainloop api and create a context */
 482     GST_INFO_OBJECT (psink, "new context with name %s, pbuf=%p, pctx=%p",
 483         pbuf->context_name, pbuf, pctx);
 484     api = pa_threaded_mainloop_get_api (mainloop);
 485     if (!(pctx->context = pa_context_new (api, pbuf->context_name)))
 486       goto create_failed;
 487
 488     pctx->ring_buffers = g_slist_prepend (pctx->ring_buffers, pbuf);
 489     g_hash_table_insert (gst_pulse_shared_contexts,
 490         g_strdup (pbuf->context_name), (gpointer) pctx);
 491     /* register some essential callbacks */
 492     pa_context_set_state_callback (pctx->context,
 493         gst_pulsering_context_state_cb, mainloop);
 494     pa_context_set_subscribe_callback (pctx->context,
 495         gst_pulsering_context_subscribe_cb, pctx);
 496
 497     /* try to connect to the server and wait for completion, we don't want to
 498      * autospawn a deamon */
 499     GST_LOG_OBJECT (psink, "connect to server %s",
 500         GST_STR_NULL (psink->server));
 501     if (pa_context_connect (pctx->context, psink->server,
 502             PA_CONTEXT_NOAUTOSPAWN, NULL) < 0)
 503       goto connect_failed;
 504   } else {
 505     GST_INFO_OBJECT (psink,
 506         "reusing shared context with name %s, pbuf=%p, pctx=%p",
 507         pbuf->context_name, pbuf, pctx);
 508     pctx->ring_buffers = g_slist_prepend (pctx->ring_buffers, pbuf);
 509   }
 510
 511   g_mutex_unlock (&pa_shared_resource_mutex);
 512   need_unlock_shared = FALSE;
 513
 514   /* context created or shared okay */
 515   pbuf->context = pa_context_ref (pctx->context);
 516
 517   for (;;) {
 518     pa_context_state_t state;
 519
 520     state = pa_context_get_state (pbuf->context);
 521
 522     GST_LOG_OBJECT (psink, "context state is now %d", state);
 523
 524     if (!PA_CONTEXT_IS_GOOD (state))
 525       goto connect_failed;
 526
 527     if (state == PA_CONTEXT_READY)
 528       break;
 529
 530     /* Wait until the context is ready */
 531     GST_LOG_OBJECT (psink, "waiting..");
 532     pa_threaded_mainloop_wait (mainloop);
 533   }
 534
 535   GST_LOG_OBJECT (psink, "opened the device");
 536
 537   pa_threaded_mainloop_unlock (mainloop);
 538
 539   return TRUE;
 540
 541   /* ERRORS */
 542 unlock_and_fail:
 543   {
 544     if (need_unlock_shared)
 545       g_mutex_unlock (&pa_shared_resource_mutex);
 546     gst_pulsering_destroy_context (pbuf);
 547     pa_threaded_mainloop_unlock (mainloop);
 548     return FALSE;
 549   }
 550 create_failed:
 551   {
 552     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
 553         ("Failed to create context"), (NULL));
 554     g_slice_free (GstPulseContext, pctx);
 555     goto unlock_and_fail;
 556   }
 557 connect_failed:
 558   {
 559     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED, ("Failed to connect: %s",
 560             pa_strerror (pa_context_errno (pctx->context))), (NULL));
 561     goto unlock_and_fail;
 562   }
 563 }
 564
 565 /* close the device */
 566 static gboolean
 567 gst_pulseringbuffer_close_device (GstAudioRingBuffer * buf)
 568 {
 569   GstPulseSink *psink;
 570   GstPulseRingBuffer *pbuf;
 571
 572   pbuf = GST_PULSERING_BUFFER_CAST (buf);
 573   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (buf));
 574
 575   GST_LOG_OBJECT (psink, "closing device");
 576
 577   pa_threaded_mainloop_lock (mainloop);
 578   gst_pulsering_destroy_context (pbuf);
 579   pa_threaded_mainloop_unlock (mainloop);
 580
 581   GST_LOG_OBJECT (psink, "closed device");
 582
 583   return TRUE;
 584 }
 585
 586 static void
 587 gst_pulsering_stream_state_cb (pa_stream * s, void *userdata)
 588 {
 589   GstPulseSink *psink;
 590   GstPulseRingBuffer *pbuf;
 591   pa_stream_state_t state;
 592
 593   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
 594   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
 595
 596   state = pa_stream_get_state (s);
 597   GST_LOG_OBJECT (psink, "got new stream state %d", state);
 598
 599   switch (state) {
 600     case PA_STREAM_READY:
 601     case PA_STREAM_FAILED:
 602     case PA_STREAM_TERMINATED:
 603       GST_LOG_OBJECT (psink, "signaling");
 604       pa_threaded_mainloop_signal (mainloop, 0);
 605       break;
 606     case PA_STREAM_UNCONNECTED:
 607     case PA_STREAM_CREATING:
 608       break;
 609   }
 610 }
 611
 612 static void
 613 gst_pulsering_stream_request_cb (pa_stream * s, size_t length, void *userdata)
 614 {
 615   GstPulseSink *psink;
 616   GstAudioRingBuffer *rbuf;
 617   GstPulseRingBuffer *pbuf;
 618
 619   rbuf = GST_AUDIO_RING_BUFFER_CAST (userdata);
 620   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
 621   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
 622
 623   GST_LOG_OBJECT (psink, "got request for length %" G_GSIZE_FORMAT, length);
 624
 625   if (pbuf->in_commit && (length >= rbuf->spec.segsize)) {
 626     /* only signal when we are waiting in the commit thread
 627      * and got request for atleast a segment */
 628     pa_threaded_mainloop_signal (mainloop, 0);
 629   }
 630 }
 631
 632 static void
 633 gst_pulsering_stream_underflow_cb (pa_stream * s, void *userdata)
 634 {
 635   GstPulseSink *psink;
 636   GstPulseRingBuffer *pbuf;
 637
 638   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
 639   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
 640
 641   GST_WARNING_OBJECT (psink, "Got underflow");
 642 }
 643
 644 static void
 645 gst_pulsering_stream_overflow_cb (pa_stream * s, void *userdata)
 646 {
 647   GstPulseSink *psink;
 648   GstPulseRingBuffer *pbuf;
 649
 650   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
 651   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
 652
 653   GST_WARNING_OBJECT (psink, "Got overflow");
 654 }
 655
 656 static void
 657 gst_pulsering_stream_latency_cb (pa_stream * s, void *userdata)
 658 {
 659   GstPulseSink *psink;
 660   GstPulseRingBuffer *pbuf;
 661   const pa_timing_info *info;
 662   pa_usec_t sink_usec;
 663
 664   info = pa_stream_get_timing_info (s);
 665
 666   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
 667   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
 668
 669   if (!info) {
 670     GST_LOG_OBJECT (psink, "latency update (information unknown)");
 671     return;
 672   }
 673   sink_usec = info->configured_sink_usec;
 674
 675   GST_LOG_OBJECT (psink,
 676       "latency_update, %" G_GUINT64_FORMAT ", %d:%" G_GINT64_FORMAT ", %d:%"
 677       G_GUINT64_FORMAT ", %" G_GUINT64_FORMAT ", %" G_GUINT64_FORMAT,
 678       GST_TIMEVAL_TO_TIME (info->timestamp), info->write_index_corrupt,
 679       info->write_index, info->read_index_corrupt, info->read_index,
 680       info->sink_usec, sink_usec);
 681 }
 682
 683 static void
 684 gst_pulsering_stream_suspended_cb (pa_stream * p, void *userdata)
 685 {
 686   GstPulseSink *psink;
 687   GstPulseRingBuffer *pbuf;
 688
 689   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
 690   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
 691
 692   if (pa_stream_is_suspended (p))
 693     GST_DEBUG_OBJECT (psink, "stream suspended");
 694   else
 695     GST_DEBUG_OBJECT (psink, "stream resumed");
 696 }
 697
 698 static void
 699 gst_pulsering_stream_started_cb (pa_stream * p, void *userdata)
 700 {
 701   GstPulseSink *psink;
 702   GstPulseRingBuffer *pbuf;
 703
 704   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
 705   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
 706
 707   GST_DEBUG_OBJECT (psink, "stream started");
 708 }
 709
 710 static void
 711 gst_pulsering_stream_event_cb (pa_stream * p, const char *name,
 712     pa_proplist * pl, void *userdata)
 713 {
 714   GstPulseSink *psink;
 715   GstPulseRingBuffer *pbuf;
 716
 717   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
 718   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
 719
 720   if (!strcmp (name, PA_STREAM_EVENT_REQUEST_CORK)) {
 721     /* the stream wants to PAUSE, post a message for the application. */
 722     GST_DEBUG_OBJECT (psink, "got request for CORK");
 723     gst_element_post_message (GST_ELEMENT_CAST (psink),
 724         gst_message_new_request_state (GST_OBJECT_CAST (psink),
 725             GST_STATE_PAUSED));
 726
 727   } else if (!strcmp (name, PA_STREAM_EVENT_REQUEST_UNCORK)) {
 728     GST_DEBUG_OBJECT (psink, "got request for UNCORK");
 729     gst_element_post_message (GST_ELEMENT_CAST (psink),
 730         gst_message_new_request_state (GST_OBJECT_CAST (psink),
 731             GST_STATE_PLAYING));
 732   } else if (!strcmp (name, PA_STREAM_EVENT_FORMAT_LOST)) {
 733     GstEvent *renego;
 734
 735     if (g_atomic_int_get (&psink->format_lost)) {
 736       /* Duplicate event before we're done reconfiguring, discard */
 737       return;
 738     }
 739
 740     GST_DEBUG_OBJECT (psink, "got FORMAT LOST");
 741     g_atomic_int_set (&psink->format_lost, 1);
 742     psink->format_lost_time = g_ascii_strtoull (pa_proplist_gets (pl,
 743             "stream-time"), NULL, 0) * 1000;
 744
 745     g_free (psink->device);
 746     psink->device = g_strdup (pa_proplist_gets (pl, "device"));
 747
 748     /* FIXME: send reconfigure event instead and let decodebin/playbin
 749      * handle that. Also take care of ac3 alignment */
 750     renego = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM,
 751         gst_structure_new_empty ("pulse-format-lost"));
 752
 753 #if 0
 754     if (g_str_equal (gst_structure_get_name (st), "audio/x-eac3")) {
 755       GstStructure *event_st = gst_structure_new ("ac3parse-set-alignment",
 756           "alignment", G_TYPE_STRING, pbin->dbin ? "frame" : "iec61937", NULL);
 757
 758       if (!gst_pad_push_event (pbin->sinkpad,
 759               gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM, event_st)))
 760         GST_WARNING_OBJECT (pbin->sinkpad, "Could not update alignment");
 761     }
 762 #endif
 763
 764     if (!gst_pad_push_event (GST_BASE_SINK (psink)->sinkpad, renego)) {
 765       /* Nobody handled the format change - emit an error */
 766       GST_ELEMENT_ERROR (psink, STREAM, FORMAT, ("Sink format changed"),
 767           ("Sink format changed"));
 768     }
 769   } else {
 770     GST_DEBUG_OBJECT (psink, "got unknown event %s", name);
 771   }
 772 }
 773
 774 /* Called with the mainloop locked */
 775 static gboolean
 776 gst_pulsering_wait_for_stream_ready (GstPulseSink * psink, pa_stream * stream)
 777 {
 778   pa_stream_state_t state;
 779
 780   for (;;) {
 781     state = pa_stream_get_state (stream);
 782
 783     GST_LOG_OBJECT (psink, "stream state is now %d", state);
 784
 785     if (!PA_STREAM_IS_GOOD (state))
 786       return FALSE;
 787
 788     if (state == PA_STREAM_READY)
 789       return TRUE;
 790
 791     /* Wait until the stream is ready */
 792     pa_threaded_mainloop_wait (mainloop);
 793   }
 794 }
 795
 796
 797 /* This method should create a new stream of the given @spec. No playback should
 798  * start yet so we start in the corked state. */
 799 static gboolean
 800 gst_pulseringbuffer_acquire (GstAudioRingBuffer * buf,
 801     GstAudioRingBufferSpec * spec)
 802 {
 803   GstPulseSink *psink;
 804   GstPulseRingBuffer *pbuf;
 805   pa_buffer_attr wanted;
 806   const pa_buffer_attr *actual;
 807   pa_channel_map channel_map;
 808   pa_operation *o = NULL;
 809   pa_cvolume v;
 810   pa_cvolume *pv = NULL;
 811   pa_stream_flags_t flags;
 812   const gchar *name;
 813   GstAudioClock *clock;
 814   pa_format_info *formats[1];
 815 #ifndef GST_DISABLE_GST_DEBUG
 816   gchar print_buf[PA_FORMAT_INFO_SNPRINT_MAX];
 817 #endif
 818
 819   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (buf));
 820   pbuf = GST_PULSERING_BUFFER_CAST (buf);
 821
 822   GST_LOG_OBJECT (psink, "creating sample spec");
 823   /* convert the gstreamer sample spec to the pulseaudio format */
 824   if (!gst_pulse_fill_format_info (spec, &pbuf->format, &pbuf->channels))
 825     goto invalid_spec;
 826   pbuf->is_pcm = pa_format_info_is_pcm (pbuf->format);
 827
 828   pa_threaded_mainloop_lock (mainloop);
 829
 830   /* we need a context and a no stream */
 831   g_assert (pbuf->context);
 832   g_assert (!pbuf->stream);
 833
 834   /* enable event notifications */
 835   GST_LOG_OBJECT (psink, "subscribing to context events");
 836   if (!(o = pa_context_subscribe (pbuf->context,
 837               PA_SUBSCRIPTION_MASK_SINK_INPUT, NULL, NULL)))
 838     goto subscribe_failed;
 839
 840   pa_operation_unref (o);
 841
 842   /* initialize the channel map */
 843   if (pbuf->is_pcm && gst_pulse_gst_to_channel_map (&channel_map, spec))
 844     pa_format_info_set_channel_map (pbuf->format, &channel_map);
 845
 846   /* find a good name for the stream */
 847   if (psink->stream_name)
 848     name = psink->stream_name;
 849   else
 850     name = "Playback Stream";
 851
 852   /* create a stream */
 853   formats[0] = pbuf->format;
 854   if (!(pbuf->stream = pa_stream_new_extended (pbuf->context, name, formats, 1,
 855               psink->proplist)))
 856     goto stream_failed;
 857
 858   /* install essential callbacks */
 859   pa_stream_set_state_callback (pbuf->stream,
 860       gst_pulsering_stream_state_cb, pbuf);
 861   pa_stream_set_write_callback (pbuf->stream,
 862       gst_pulsering_stream_request_cb, pbuf);
 863   pa_stream_set_underflow_callback (pbuf->stream,
 864       gst_pulsering_stream_underflow_cb, pbuf);
 865   pa_stream_set_overflow_callback (pbuf->stream,
 866       gst_pulsering_stream_overflow_cb, pbuf);
 867   pa_stream_set_latency_update_callback (pbuf->stream,
 868       gst_pulsering_stream_latency_cb, pbuf);
 869   pa_stream_set_suspended_callback (pbuf->stream,
 870       gst_pulsering_stream_suspended_cb, pbuf);
 871   pa_stream_set_started_callback (pbuf->stream,
 872       gst_pulsering_stream_started_cb, pbuf);
 873   pa_stream_set_event_callback (pbuf->stream,
 874       gst_pulsering_stream_event_cb, pbuf);
 875
 876   /* buffering requirements. When setting prebuf to 0, the stream will not pause
 877    * when we cause an underrun, which causes time to continue. */
 878   memset (&wanted, 0, sizeof (wanted));
 879   wanted.tlength = spec->segtotal * spec->segsize;
 880   wanted.maxlength = -1;
 881   wanted.prebuf = 0;
 882   wanted.minreq = spec->segsize;
 883
 884   GST_INFO_OBJECT (psink, "tlength:   %d", wanted.tlength);
 885   GST_INFO_OBJECT (psink, "maxlength: %d", wanted.maxlength);
 886   GST_INFO_OBJECT (psink, "prebuf:    %d", wanted.prebuf);
 887   GST_INFO_OBJECT (psink, "minreq:    %d", wanted.minreq);
 888
 889   /* configure volume when we changed it, else we leave the default */
 890   if (psink->volume_set) {
 891     GST_LOG_OBJECT (psink, "have volume of %f", psink->volume);
 892     pv = &v;
 893     if (pbuf->is_pcm)
 894       gst_pulse_cvolume_from_linear (pv, pbuf->channels, psink->volume);
 895     else {
 896       GST_DEBUG_OBJECT (psink, "passthrough stream, not setting volume");
 897       pv = NULL;
 898     }
 899   } else {
 900     pv = NULL;
 901   }
 902
 903   /* construct the flags */
 904   flags = PA_STREAM_INTERPOLATE_TIMING | PA_STREAM_AUTO_TIMING_UPDATE |
 905       PA_STREAM_ADJUST_LATENCY | PA_STREAM_START_CORKED;
 906
 907   if (psink->mute_set) {
 908     if (psink->mute)
 909       flags |= PA_STREAM_START_MUTED;
 910     else
 911       flags |= PA_STREAM_START_UNMUTED;
 912   }
 913
 914   /* we always start corked (see flags above) */
 915   pbuf->corked = TRUE;
 916
 917   /* try to connect now */
 918   GST_LOG_OBJECT (psink, "connect for playback to device %s",
 919       GST_STR_NULL (psink->device));
 920   if (pa_stream_connect_playback (pbuf->stream, psink->device,
 921           &wanted, flags, pv, NULL) < 0)
 922     goto connect_failed;
 923
 924   /* our clock will now start from 0 again */
 925   clock = GST_AUDIO_CLOCK (GST_AUDIO_BASE_SINK (psink)->provided_clock);
 926   gst_audio_clock_reset (clock, 0);
 927
 928   if (!gst_pulsering_wait_for_stream_ready (psink, pbuf->stream))
 929     goto connect_failed;
 930
 931   g_free (psink->device);
 932   psink->device = g_strdup (pa_stream_get_device_name (pbuf->stream));
 933
 934 #ifndef GST_DISABLE_GST_DEBUG
 935   pa_format_info_snprint (print_buf, sizeof (print_buf),
 936       pa_stream_get_format_info (pbuf->stream));
 937   GST_INFO_OBJECT (psink, "negotiated to: %s", print_buf);
 938 #endif
 939
 940   /* After we passed the volume off of to PA we never want to set it
 941      again, since it is PA's job to save/restore volumes.  */
 942   psink->volume_set = psink->mute_set = FALSE;
 943
 944   GST_LOG_OBJECT (psink, "stream is acquired now");
 945
 946   /* get the actual buffering properties now */
 947   actual = pa_stream_get_buffer_attr (pbuf->stream);
 948
 949   GST_INFO_OBJECT (psink, "tlength:   %d (wanted: %d)", actual->tlength,
 950       wanted.tlength);
 951   GST_INFO_OBJECT (psink, "maxlength: %d", actual->maxlength);
 952   GST_INFO_OBJECT (psink, "prebuf:    %d", actual->prebuf);
 953   GST_INFO_OBJECT (psink, "minreq:    %d (wanted %d)", actual->minreq,
 954       wanted.minreq);
 955
 956   spec->segsize = actual->minreq;
 957   spec->segtotal = actual->tlength / spec->segsize;
 958
 959   pa_threaded_mainloop_unlock (mainloop);
 960
 961   return TRUE;
 962
 963   /* ERRORS */
 964 unlock_and_fail:
 965   {
 966     gst_pulsering_destroy_stream (pbuf);
 967     pa_threaded_mainloop_unlock (mainloop);
 968
 969     return FALSE;
 970   }
 971 invalid_spec:
 972   {
 973     GST_ELEMENT_ERROR (psink, RESOURCE, SETTINGS,
 974         ("Invalid sample specification."), (NULL));
 975     return FALSE;
 976   }
 977 subscribe_failed:
 978   {
 979     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
 980         ("pa_context_subscribe() failed: %s",
 981             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
 982     goto unlock_and_fail;
 983   }
 984 stream_failed:
 985   {
 986     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
 987         ("Failed to create stream: %s",
 988             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
 989     goto unlock_and_fail;
 990   }
 991 connect_failed:
 992   {
 993     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
 994         ("Failed to connect stream: %s",
 995             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
 996     goto unlock_and_fail;
 997   }
 998 }
 999
1000 /* free the stream that we acquired before */
1001 static gboolean
1002 gst_pulseringbuffer_release (GstAudioRingBuffer * buf)
1003 {
1004   GstPulseRingBuffer *pbuf;
1005
1006   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1007
1008   pa_threaded_mainloop_lock (mainloop);
1009   gst_pulsering_destroy_stream (pbuf);
1010   pa_threaded_mainloop_unlock (mainloop);
1011
1012   {
1013     GstPulseSink *psink;
1014
1015     psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1016     g_atomic_int_set (&psink->format_lost, FALSE);
1017     psink->format_lost_time = GST_CLOCK_TIME_NONE;
1018   }
1019
1020   return TRUE;
1021 }
1022
1023 static void
1024 gst_pulsering_success_cb (pa_stream * s, int success, void *userdata)
1025 {
1026   pa_threaded_mainloop_signal (mainloop, 0);
1027 }
1028
1029 /* update the corked state of a stream, must be called with the mainloop
1030  * lock */
1031 static gboolean
1032 gst_pulsering_set_corked (GstPulseRingBuffer * pbuf, gboolean corked,
1033     gboolean wait)
1034 {
1035   pa_operation *o = NULL;
1036   GstPulseSink *psink;
1037   gboolean res = FALSE;
1038
1039   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1040
1041   if (g_atomic_int_get (&psink->format_lost)) {
1042     /* Sink format changed, stream's gone so fake being paused */
1043     return TRUE;
1044   }
1045
1046   GST_DEBUG_OBJECT (psink, "setting corked state to %d", corked);
1047   if (pbuf->corked != corked) {
1048     if (!(o = pa_stream_cork (pbuf->stream, corked,
1049                 gst_pulsering_success_cb, pbuf)))
1050       goto cork_failed;
1051
1052     while (wait && pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
1053       pa_threaded_mainloop_wait (mainloop);
1054       if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1055         goto server_dead;
1056     }
1057     pbuf->corked = corked;
1058   } else {
1059     GST_DEBUG_OBJECT (psink, "skipping, already in requested state");
1060   }
1061   res = TRUE;
1062
1063 cleanup:
1064   if (o)
1065     pa_operation_unref (o);
1066
1067   return res;
1068
1069   /* ERRORS */
1070 server_dead:
1071   {
1072     GST_DEBUG_OBJECT (psink, "the server is dead");
1073     goto cleanup;
1074   }
1075 cork_failed:
1076   {
1077     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1078         ("pa_stream_cork() failed: %s",
1079             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1080     goto cleanup;
1081   }
1082 }
1083
1084 static void
1085 gst_pulseringbuffer_clear (GstAudioRingBuffer * buf)
1086 {
1087   GstPulseSink *psink;
1088   GstPulseRingBuffer *pbuf;
1089   pa_operation *o = NULL;
1090
1091   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1092   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1093
1094   pa_threaded_mainloop_lock (mainloop);
1095   GST_DEBUG_OBJECT (psink, "clearing");
1096   if (pbuf->stream) {
1097     /* don't wait for the flush to complete */
1098     if ((o = pa_stream_flush (pbuf->stream, NULL, pbuf)))
1099       pa_operation_unref (o);
1100   }
1101   pa_threaded_mainloop_unlock (mainloop);
1102 }
1103
1104 /* called from pulse with the mainloop lock */
1105 static void
1106 mainloop_enter_defer_cb (pa_mainloop_api * api, void *userdata)
1107 {
1108   GstPulseSink *pulsesink = GST_PULSESINK (userdata);
1109   GstMessage *message;
1110   GValue val = { 0 };
1111
1112   g_value_init (&val, G_TYPE_POINTER);
1113   g_value_set_pointer (&val, g_thread_self ());
1114
1115   GST_DEBUG_OBJECT (pulsesink, "posting ENTER stream status");
1116   message = gst_message_new_stream_status (GST_OBJECT (pulsesink),
1117       GST_STREAM_STATUS_TYPE_ENTER, GST_ELEMENT (pulsesink));
1118   gst_message_set_stream_status_object (message, &val);
1119
1120   gst_element_post_message (GST_ELEMENT (pulsesink), message);
1121
1122   g_return_if_fail (pulsesink->defer_pending);
1123   pulsesink->defer_pending--;
1124   pa_threaded_mainloop_signal (mainloop, 0);
1125 }
1126
1127 /* start/resume playback ASAP, we don't uncork here but in the commit method */
1128 static gboolean
1129 gst_pulseringbuffer_start (GstAudioRingBuffer * buf)
1130 {
1131   GstPulseSink *psink;
1132   GstPulseRingBuffer *pbuf;
1133
1134   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1135   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1136
1137   pa_threaded_mainloop_lock (mainloop);
1138
1139   GST_DEBUG_OBJECT (psink, "scheduling stream status");
1140   psink->defer_pending++;
1141   pa_mainloop_api_once (pa_threaded_mainloop_get_api (mainloop),
1142       mainloop_enter_defer_cb, psink);
1143
1144   GST_DEBUG_OBJECT (psink, "starting");
1145   pbuf->paused = FALSE;
1146
1147   /* EOS needs running clock */
1148   if (GST_BASE_SINK_CAST (psink)->eos ||
1149       g_atomic_int_get (&GST_AUDIO_BASE_SINK (psink)->eos_rendering))
1150     gst_pulsering_set_corked (pbuf, FALSE, FALSE);
1151
1152   pa_threaded_mainloop_unlock (mainloop);
1153
1154   return TRUE;
1155 }
1156
1157 /* pause/stop playback ASAP */
1158 static gboolean
1159 gst_pulseringbuffer_pause (GstAudioRingBuffer * buf)
1160 {
1161   GstPulseSink *psink;
1162   GstPulseRingBuffer *pbuf;
1163   gboolean res;
1164
1165   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1166   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1167
1168   pa_threaded_mainloop_lock (mainloop);
1169   GST_DEBUG_OBJECT (psink, "pausing and corking");
1170   /* make sure the commit method stops writing */
1171   pbuf->paused = TRUE;
1172   res = gst_pulsering_set_corked (pbuf, TRUE, TRUE);
1173   if (pbuf->in_commit) {
1174     /* we are waiting in a commit, signal */
1175     GST_DEBUG_OBJECT (psink, "signal commit");
1176     pa_threaded_mainloop_signal (mainloop, 0);
1177   }
1178   pa_threaded_mainloop_unlock (mainloop);
1179
1180   return res;
1181 }
1182
1183 /* called from pulse with the mainloop lock */
1184 static void
1185 mainloop_leave_defer_cb (pa_mainloop_api * api, void *userdata)
1186 {
1187   GstPulseSink *pulsesink = GST_PULSESINK (userdata);
1188   GstMessage *message;
1189   GValue val = { 0 };
1190
1191   g_value_init (&val, G_TYPE_POINTER);
1192   g_value_set_pointer (&val, g_thread_self ());
1193
1194   GST_DEBUG_OBJECT (pulsesink, "posting LEAVE stream status");
1195   message = gst_message_new_stream_status (GST_OBJECT (pulsesink),
1196       GST_STREAM_STATUS_TYPE_LEAVE, GST_ELEMENT (pulsesink));
1197   gst_message_set_stream_status_object (message, &val);
1198   gst_element_post_message (GST_ELEMENT (pulsesink), message);
1199
1200   g_return_if_fail (pulsesink->defer_pending);
1201   pulsesink->defer_pending--;
1202   pa_threaded_mainloop_signal (mainloop, 0);
1203 }
1204
1205 /* stop playback, we flush everything. */
1206 static gboolean
1207 gst_pulseringbuffer_stop (GstAudioRingBuffer * buf)
1208 {
1209   GstPulseSink *psink;
1210   GstPulseRingBuffer *pbuf;
1211   gboolean res = FALSE;
1212   pa_operation *o = NULL;
1213
1214   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1215   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1216
1217   pa_threaded_mainloop_lock (mainloop);
1218
1219   pbuf->paused = TRUE;
1220   res = gst_pulsering_set_corked (pbuf, TRUE, TRUE);
1221
1222   /* Inform anyone waiting in _commit() call that it shall wakeup */
1223   if (pbuf->in_commit) {
1224     GST_DEBUG_OBJECT (psink, "signal commit thread");
1225     pa_threaded_mainloop_signal (mainloop, 0);
1226   }
1227   if (g_atomic_int_get (&psink->format_lost)) {
1228     /* Don't try to flush, the stream's probably gone by now */
1229     res = TRUE;
1230     goto cleanup;
1231   }
1232
1233   /* then try to flush, it's not fatal when this fails */
1234   GST_DEBUG_OBJECT (psink, "flushing");
1235   if ((o = pa_stream_flush (pbuf->stream, gst_pulsering_success_cb, pbuf))) {
1236     while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
1237       GST_DEBUG_OBJECT (psink, "wait for completion");
1238       pa_threaded_mainloop_wait (mainloop);
1239       if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1240         goto server_dead;
1241     }
1242     GST_DEBUG_OBJECT (psink, "flush completed");
1243   }
1244   res = TRUE;
1245
1246 cleanup:
1247   if (o) {
1248     pa_operation_cancel (o);
1249     pa_operation_unref (o);
1250   }
1251
1252   GST_DEBUG_OBJECT (psink, "scheduling stream status");
1253   psink->defer_pending++;
1254   pa_mainloop_api_once (pa_threaded_mainloop_get_api (mainloop),
1255       mainloop_leave_defer_cb, psink);
1256
1257   pa_threaded_mainloop_unlock (mainloop);
1258
1259   return res;
1260
1261   /* ERRORS */
1262 server_dead:
1263   {
1264     GST_DEBUG_OBJECT (psink, "the server is dead");
1265     goto cleanup;
1266   }
1267 }
1268
1269 /* in_samples >= out_samples, rate > 1.0 */
1270 #define FWD_UP_SAMPLES(s,se,d,de)               \
1271 G_STMT_START {                                  \
1272   guint8 *sb = s, *db = d;                      \
1273   while (s <= se && d < de) {                   \
1274     memcpy (d, s, bpf);                         \
1275     s += bpf;                                   \
1276     *accum += outr;                             \
1277     if ((*accum << 1) >= inr) {                 \
1278       *accum -= inr;                            \
1279       d += bpf;                                 \
1280     }                                           \
1281   }                                             \
1282   in_samples -= (s - sb)/bpf;                   \
1283   out_samples -= (d - db)/bpf;                  \
1284   GST_DEBUG ("fwd_up end %d/%d",*accum,*toprocess);     \
1285 } G_STMT_END
1286
1287 /* out_samples > in_samples, for rates smaller than 1.0 */
1288 #define FWD_DOWN_SAMPLES(s,se,d,de)             \
1289 G_STMT_START {                                  \
1290   guint8 *sb = s, *db = d;                      \
1291   while (s <= se && d < de) {                   \
1292     memcpy (d, s, bpf);                         \
1293     d += bpf;                                   \
1294     *accum += inr;                              \
1295     if ((*accum << 1) >= outr) {                \
1296       *accum -= outr;                           \
1297       s += bpf;                                 \
1298     }                                           \
1299   }                                             \
1300   in_samples -= (s - sb)/bpf;                   \
1301   out_samples -= (d - db)/bpf;                  \
1302   GST_DEBUG ("fwd_down end %d/%d",*accum,*toprocess);   \
1303 } G_STMT_END
1304
1305 #define REV_UP_SAMPLES(s,se,d,de)               \
1306 G_STMT_START {                                  \
1307   guint8 *sb = se, *db = d;                     \
1308   while (s <= se && d < de) {                   \
1309     memcpy (d, se, bpf);                        \
1310     se -= bpf;                                  \
1311     *accum += outr;                             \
1312     while (d < de && (*accum << 1) >= inr) {    \
1313       *accum -= inr;                            \
1314       d += bpf;                                 \
1315     }                                           \
1316   }                                             \
1317   in_samples -= (sb - se)/bpf;                  \
1318   out_samples -= (d - db)/bpf;                  \
1319   GST_DEBUG ("rev_up end %d/%d",*accum,*toprocess);     \
1320 } G_STMT_END
1321
1322 #define REV_DOWN_SAMPLES(s,se,d,de)             \
1323 G_STMT_START {                                  \
1324   guint8 *sb = se, *db = d;                     \
1325   while (s <= se && d < de) {                   \
1326     memcpy (d, se, bpf);                        \
1327     d += bpf;                                   \
1328     *accum += inr;                              \
1329     while (s <= se && (*accum << 1) >= outr) {  \
1330       *accum -= outr;                           \
1331       se -= bpf;                                \
1332     }                                           \
1333   }                                             \
1334   in_samples -= (sb - se)/bpf;                  \
1335   out_samples -= (d - db)/bpf;                  \
1336   GST_DEBUG ("rev_down end %d/%d",*accum,*toprocess);   \
1337 } G_STMT_END
1338
1339 /* our custom commit function because we write into the buffer of pulseaudio
1340  * instead of keeping our own buffer */
1341 static guint
1342 gst_pulseringbuffer_commit (GstAudioRingBuffer * buf, guint64 * sample,
1343     guchar * data, gint in_samples, gint out_samples, gint * accum)
1344 {
1345   GstPulseSink *psink;
1346   GstPulseRingBuffer *pbuf;
1347   guint result;
1348   guint8 *data_end;
1349   gboolean reverse;
1350   gint *toprocess;
1351   gint inr, outr, bpf;
1352   gint64 offset;
1353   guint bufsize;
1354
1355   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1356   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1357
1358   /* FIXME post message rather than using a signal (as mixer interface) */
1359   if (g_atomic_int_compare_and_exchange (&psink->notify, 1, 0)) {
1360     g_object_notify (G_OBJECT (psink), "volume");
1361     g_object_notify (G_OBJECT (psink), "mute");
1362   }
1363
1364   /* make sure the ringbuffer is started */
1365   if (G_UNLIKELY (g_atomic_int_get (&buf->state) !=
1366           GST_AUDIO_RING_BUFFER_STATE_STARTED)) {
1367     /* see if we are allowed to start it */
1368     if (G_UNLIKELY (g_atomic_int_get (&buf->may_start) == FALSE))
1369       goto no_start;
1370
1371     GST_DEBUG_OBJECT (buf, "start!");
1372     if (!gst_audio_ring_buffer_start (buf))
1373       goto start_failed;
1374   }
1375
1376   pa_threaded_mainloop_lock (mainloop);
1377
1378   GST_DEBUG_OBJECT (psink, "entering commit");
1379   pbuf->in_commit = TRUE;
1380
1381   bpf = GST_AUDIO_INFO_BPF (&buf->spec.info);
1382   bufsize = buf->spec.segsize * buf->spec.segtotal;
1383
1384   /* our toy resampler for trick modes */
1385   reverse = out_samples < 0;
1386   out_samples = ABS (out_samples);
1387
1388   if (in_samples >= out_samples)
1389     toprocess = &in_samples;
1390   else
1391     toprocess = &out_samples;
1392
1393   inr = in_samples - 1;
1394   outr = out_samples - 1;
1395
1396   GST_DEBUG_OBJECT (psink, "in %d, out %d", inr, outr);
1397
1398   /* data_end points to the last sample we have to write, not past it. This is
1399    * needed to properly handle reverse playback: it points to the last sample. */
1400   data_end = data + (bpf * inr);
1401
1402   if (g_atomic_int_get (&psink->format_lost)) {
1403     /* Sink format changed, drop the data and hope upstream renegotiates */
1404     goto fake_done;
1405   }
1406
1407   if (pbuf->paused)
1408     goto was_paused;
1409
1410   /* offset is in bytes */
1411   offset = *sample * bpf;
1412
1413   while (*toprocess > 0) {
1414     size_t avail;
1415     guint towrite;
1416
1417     GST_LOG_OBJECT (psink,
1418         "need to write %d samples at offset %" G_GINT64_FORMAT, *toprocess,
1419         offset);
1420
1421     if (offset != pbuf->m_lastoffset)
1422       GST_LOG_OBJECT (psink, "discontinuity, offset is %" G_GINT64_FORMAT ", "
1423           "last offset was %" G_GINT64_FORMAT, offset, pbuf->m_lastoffset);
1424
1425     towrite = out_samples * bpf;
1426
1427     /* Wait for at least segsize bytes to become available */
1428     if (towrite > buf->spec.segsize)
1429       towrite = buf->spec.segsize;
1430
1431     if ((pbuf->m_writable < towrite) || (offset != pbuf->m_lastoffset)) {
1432       /* if no room left or discontinuity in offset,
1433          we need to flush data and get a new buffer */
1434
1435       /* flush the buffer if possible */
1436       if ((pbuf->m_data != NULL) && (pbuf->m_towrite > 0)) {
1437
1438         GST_LOG_OBJECT (psink,
1439             "flushing %u samples at offset %" G_GINT64_FORMAT,
1440             (guint) pbuf->m_towrite / bpf, pbuf->m_offset);
1441
1442         if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1443                 pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1444           goto write_failed;
1445         }
1446       }
1447       pbuf->m_towrite = 0;
1448       pbuf->m_offset = offset;  /* keep track of current offset */
1449
1450       /* get a buffer to write in for now on */
1451       for (;;) {
1452         pbuf->m_writable = pa_stream_writable_size (pbuf->stream);
1453
1454         if (g_atomic_int_get (&psink->format_lost)) {
1455           /* Sink format changed, give up and hope upstream renegotiates */
1456           goto fake_done;
1457         }
1458
1459         if (pbuf->m_writable == (size_t) - 1)
1460           goto writable_size_failed;
1461
1462         pbuf->m_writable /= bpf;
1463         pbuf->m_writable *= bpf;        /* handle only complete samples */
1464
1465         if (pbuf->m_writable >= towrite)
1466           break;
1467
1468         /* see if we need to uncork because we have no free space */
1469         if (pbuf->corked) {
1470           if (!gst_pulsering_set_corked (pbuf, FALSE, FALSE))
1471             goto uncork_failed;
1472         }
1473
1474         /* we can't write segsize bytes, wait a bit */
1475         GST_LOG_OBJECT (psink, "waiting for free space");
1476         pa_threaded_mainloop_wait (mainloop);
1477
1478         if (pbuf->paused)
1479           goto was_paused;
1480       }
1481
1482       /* Recalculate what we can write in the next chunk */
1483       towrite = out_samples * bpf;
1484       if (pbuf->m_writable > towrite)
1485         pbuf->m_writable = towrite;
1486
1487       GST_LOG_OBJECT (psink, "requesting %" G_GSIZE_FORMAT " bytes of "
1488           "shared memory", pbuf->m_writable);
1489
1490       if (pa_stream_begin_write (pbuf->stream, &pbuf->m_data,
1491               &pbuf->m_writable) < 0) {
1492         GST_LOG_OBJECT (psink, "pa_stream_begin_write() failed");
1493         goto writable_size_failed;
1494       }
1495
1496       GST_LOG_OBJECT (psink, "got %" G_GSIZE_FORMAT " bytes of shared memory",
1497           pbuf->m_writable);
1498
1499     }
1500
1501     if (towrite > pbuf->m_writable)
1502       towrite = pbuf->m_writable;
1503     avail = towrite / bpf;
1504
1505     GST_LOG_OBJECT (psink, "writing %u samples at offset %" G_GUINT64_FORMAT,
1506         (guint) avail, offset);
1507
1508     /* No trick modes for passthrough streams */
1509     if (G_UNLIKELY (!pbuf->is_pcm && (inr != outr || reverse))) {
1510       GST_WARNING_OBJECT (psink, "Passthrough stream can't run in trick mode");
1511       goto unlock_and_fail;
1512     }
1513
1514     if (G_LIKELY (inr == outr && !reverse)) {
1515       /* no rate conversion, simply write out the samples */
1516       /* copy the data into internal buffer */
1517
1518       memcpy ((guint8 *) pbuf->m_data + pbuf->m_towrite, data, towrite);
1519       pbuf->m_towrite += towrite;
1520       pbuf->m_writable -= towrite;
1521
1522       data += towrite;
1523       in_samples -= avail;
1524       out_samples -= avail;
1525     } else {
1526       guint8 *dest, *d, *d_end;
1527
1528       /* write into the PulseAudio shm buffer */
1529       dest = d = (guint8 *) pbuf->m_data + pbuf->m_towrite;
1530       d_end = d + towrite;
1531
1532       if (!reverse) {
1533         if (inr >= outr)
1534           /* forward speed up */
1535           FWD_UP_SAMPLES (data, data_end, d, d_end);
1536         else
1537           /* forward slow down */
1538           FWD_DOWN_SAMPLES (data, data_end, d, d_end);
1539       } else {
1540         if (inr >= outr)
1541           /* reverse speed up */
1542           REV_UP_SAMPLES (data, data_end, d, d_end);
1543         else
1544           /* reverse slow down */
1545           REV_DOWN_SAMPLES (data, data_end, d, d_end);
1546       }
1547       /* see what we have left to write */
1548       towrite = (d - dest);
1549       pbuf->m_towrite += towrite;
1550       pbuf->m_writable -= towrite;
1551
1552       avail = towrite / bpf;
1553     }
1554
1555     /* flush the buffer if it's full */
1556     if ((pbuf->m_data != NULL) && (pbuf->m_towrite > 0)
1557         && (pbuf->m_writable == 0)) {
1558       GST_LOG_OBJECT (psink, "flushing %u samples at offset %" G_GINT64_FORMAT,
1559           (guint) pbuf->m_towrite / bpf, pbuf->m_offset);
1560
1561       if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1562               pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1563         goto write_failed;
1564       }
1565       pbuf->m_towrite = 0;
1566       pbuf->m_offset = offset + towrite;        /* keep track of current offset */
1567     }
1568
1569     *sample += avail;
1570     offset += avail * bpf;
1571     pbuf->m_lastoffset = offset;
1572
1573     /* check if we need to uncork after writing the samples */
1574     if (pbuf->corked) {
1575       const pa_timing_info *info;
1576
1577       if ((info = pa_stream_get_timing_info (pbuf->stream))) {
1578         GST_LOG_OBJECT (psink,
1579             "read_index at %" G_GUINT64_FORMAT ", offset %" G_GINT64_FORMAT,
1580             info->read_index, offset);
1581
1582         /* we uncork when the read_index is too far behind the offset we need
1583          * to write to. */
1584         if (info->read_index + bufsize <= offset) {
1585           if (!gst_pulsering_set_corked (pbuf, FALSE, FALSE))
1586             goto uncork_failed;
1587         }
1588       } else {
1589         GST_LOG_OBJECT (psink, "no timing info available yet");
1590       }
1591     }
1592   }
1593
1594 fake_done:
1595   /* we consumed all samples here */
1596   data = data_end + bpf;
1597
1598   pbuf->in_commit = FALSE;
1599   pa_threaded_mainloop_unlock (mainloop);
1600
1601 done:
1602   result = inr - ((data_end - data) / bpf);
1603   GST_LOG_OBJECT (psink, "wrote %d samples", result);
1604
1605   return result;
1606
1607   /* ERRORS */
1608 unlock_and_fail:
1609   {
1610     pbuf->in_commit = FALSE;
1611     GST_LOG_OBJECT (psink, "we are reset");
1612     pa_threaded_mainloop_unlock (mainloop);
1613     goto done;
1614   }
1615 no_start:
1616   {
1617     GST_LOG_OBJECT (psink, "we can not start");
1618     return 0;
1619   }
1620 start_failed:
1621   {
1622     GST_LOG_OBJECT (psink, "failed to start the ringbuffer");
1623     return 0;
1624   }
1625 uncork_failed:
1626   {
1627     pbuf->in_commit = FALSE;
1628     GST_ERROR_OBJECT (psink, "uncork failed");
1629     pa_threaded_mainloop_unlock (mainloop);
1630     goto done;
1631   }
1632 was_paused:
1633   {
1634     pbuf->in_commit = FALSE;
1635     GST_LOG_OBJECT (psink, "we are paused");
1636     pa_threaded_mainloop_unlock (mainloop);
1637     goto done;
1638   }
1639 writable_size_failed:
1640   {
1641     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1642         ("pa_stream_writable_size() failed: %s",
1643             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1644     goto unlock_and_fail;
1645   }
1646 write_failed:
1647   {
1648     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1649         ("pa_stream_write() failed: %s",
1650             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1651     goto unlock_and_fail;
1652   }
1653 }
1654
1655 /* write pending local samples, must be called with the mainloop lock */
1656 static void
1657 gst_pulsering_flush (GstPulseRingBuffer * pbuf)
1658 {
1659   GstPulseSink *psink;
1660
1661   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1662   GST_DEBUG_OBJECT (psink, "entering flush");
1663
1664   /* flush the buffer if possible */
1665   if (pbuf->stream && (pbuf->m_data != NULL) && (pbuf->m_towrite > 0)) {
1666 #ifndef GST_DISABLE_GST_DEBUG
1667     gint bpf;
1668
1669     bpf = (GST_AUDIO_RING_BUFFER_CAST (pbuf))->spec.info.bpf;
1670     GST_LOG_OBJECT (psink,
1671         "flushing %u samples at offset %" G_GINT64_FORMAT,
1672         (guint) pbuf->m_towrite / bpf, pbuf->m_offset);
1673 #endif
1674
1675     if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1676             pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1677       goto write_failed;
1678     }
1679
1680     pbuf->m_towrite = 0;
1681     pbuf->m_offset += pbuf->m_towrite;  /* keep track of current offset */
1682   }
1683
1684 done:
1685   return;
1686
1687   /* ERRORS */
1688 write_failed:
1689   {
1690     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1691         ("pa_stream_write() failed: %s",
1692             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1693     goto done;
1694   }
1695 }
1696
1697 static void gst_pulsesink_set_property (GObject * object, guint prop_id,
1698     const GValue * value, GParamSpec * pspec);
1699 static void gst_pulsesink_get_property (GObject * object, guint prop_id,
1700     GValue * value, GParamSpec * pspec);
1701 static void gst_pulsesink_finalize (GObject * object);
1702
1703 static gboolean gst_pulsesink_event (GstBaseSink * sink, GstEvent * event);
1704 static gboolean gst_pulsesink_query (GstBaseSink * sink, GstQuery * query);
1705
1706 static GstStateChangeReturn gst_pulsesink_change_state (GstElement * element,
1707     GstStateChange transition);
1708
1709 static GstStaticPadTemplate pad_template = GST_STATIC_PAD_TEMPLATE ("sink",
1710     GST_PAD_SINK,
1711     GST_PAD_ALWAYS,
1712     GST_STATIC_CAPS (PULSE_SINK_TEMPLATE_CAPS));
1713
1714 #define gst_pulsesink_parent_class parent_class
1715 G_DEFINE_TYPE_WITH_CODE (GstPulseSink, gst_pulsesink, GST_TYPE_AUDIO_BASE_SINK,
1716     gst_pulsesink_init_contexts ();
1717     G_IMPLEMENT_INTERFACE (GST_TYPE_STREAM_VOLUME, NULL)
1718     );
1719
1720 static GstAudioRingBuffer *
1721 gst_pulsesink_create_ringbuffer (GstAudioBaseSink * sink)
1722 {
1723   GstAudioRingBuffer *buffer;
1724
1725   GST_DEBUG_OBJECT (sink, "creating ringbuffer");
1726   buffer = g_object_new (GST_TYPE_PULSERING_BUFFER, NULL);
1727   GST_DEBUG_OBJECT (sink, "created ringbuffer @%p", buffer);
1728
1729   return buffer;
1730 }
1731
1732 static GstBuffer *
1733 gst_pulsesink_payload (GstAudioBaseSink * sink, GstBuffer * buf)
1734 {
1735   switch (sink->ringbuffer->spec.type) {
1736     case GST_AUDIO_RING_BUFFER_FORMAT_TYPE_AC3:
1737     case GST_AUDIO_RING_BUFFER_FORMAT_TYPE_EAC3:
1738     case GST_AUDIO_RING_BUFFER_FORMAT_TYPE_DTS:
1739     case GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG:
1740     {
1741       /* FIXME: alloc memory from PA if possible */
1742       gint framesize = gst_audio_iec61937_frame_size (&sink->ringbuffer->spec);
1743       GstBuffer *out;
1744       GstMapInfo inmap, outmap;
1745       gboolean res;
1746
1747       if (framesize <= 0)
1748         return NULL;
1749
1750       out = gst_buffer_new_and_alloc (framesize);
1751
1752       gst_buffer_map (buf, &inmap, GST_MAP_READ);
1753       gst_buffer_map (out, &outmap, GST_MAP_WRITE);
1754
1755       res = gst_audio_iec61937_payload (inmap.data, inmap.size,
1756           outmap.data, outmap.size, &sink->ringbuffer->spec);
1757
1758       gst_buffer_unmap (buf, &inmap);
1759       gst_buffer_unmap (out, &outmap);
1760
1761       if (!res) {
1762         gst_buffer_unref (out);
1763         return NULL;
1764       }
1765
1766       gst_buffer_copy_into (out, buf, GST_BUFFER_COPY_METADATA, 0, -1);
1767       return out;
1768     }
1769
1770     default:
1771       return gst_buffer_ref (buf);
1772   }
1773 }
1774
1775 static void
1776 gst_pulsesink_class_init (GstPulseSinkClass * klass)
1777 {
1778   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
1779   GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
1780   GstBaseSinkClass *bc;
1781   GstAudioBaseSinkClass *gstaudiosink_class = GST_AUDIO_BASE_SINK_CLASS (klass);
1782   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
1783   gchar *clientname;
1784
1785   gobject_class->finalize = gst_pulsesink_finalize;
1786   gobject_class->set_property = gst_pulsesink_set_property;
1787   gobject_class->get_property = gst_pulsesink_get_property;
1788
1789   gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_pulsesink_event);
1790   gstbasesink_class->query = GST_DEBUG_FUNCPTR (gst_pulsesink_query);
1791
1792   /* restore the original basesink pull methods */
1793   bc = g_type_class_peek (GST_TYPE_BASE_SINK);
1794   gstbasesink_class->activate_pull = GST_DEBUG_FUNCPTR (bc->activate_pull);
1795
1796   gstelement_class->change_state =
1797       GST_DEBUG_FUNCPTR (gst_pulsesink_change_state);
1798
1799   gstaudiosink_class->create_ringbuffer =
1800       GST_DEBUG_FUNCPTR (gst_pulsesink_create_ringbuffer);
1801   gstaudiosink_class->payload = GST_DEBUG_FUNCPTR (gst_pulsesink_payload);
1802
1803   /* Overwrite GObject fields */
1804   g_object_class_install_property (gobject_class,
1805       PROP_SERVER,
1806       g_param_spec_string ("server", "Server",
1807           "The PulseAudio server to connect to", DEFAULT_SERVER,
1808           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1809
1810   g_object_class_install_property (gobject_class, PROP_DEVICE,
1811       g_param_spec_string ("device", "Device",
1812           "The PulseAudio sink device to connect to", DEFAULT_DEVICE,
1813           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1814
1815   g_object_class_install_property (gobject_class,
1816       PROP_DEVICE_NAME,
1817       g_param_spec_string ("device-name", "Device name",
1818           "Human-readable name of the sound device", DEFAULT_DEVICE_NAME,
1819           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1820
1821   g_object_class_install_property (gobject_class,
1822       PROP_VOLUME,
1823       g_param_spec_double ("volume", "Volume",
1824           "Linear volume of this stream, 1.0=100%", 0.0, MAX_VOLUME,
1825           DEFAULT_VOLUME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1826   g_object_class_install_property (gobject_class,
1827       PROP_MUTE,
1828       g_param_spec_boolean ("mute", "Mute",
1829           "Mute state of this stream", DEFAULT_MUTE,
1830           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1831
1832   /**
1833    * GstPulseSink:client-name
1834    *
1835    * The PulseAudio client name to use.
1836    */
1837   clientname = gst_pulse_client_name ();
1838   g_object_class_install_property (gobject_class,
1839       PROP_CLIENT_NAME,
1840       g_param_spec_string ("client-name", "Client Name",
1841           "The PulseAudio client name to use", clientname,
1842           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
1843           GST_PARAM_MUTABLE_READY));
1844   g_free (clientname);
1845
1846   /**
1847    * GstPulseSink:stream-properties
1848    *
1849    * List of pulseaudio stream properties. A list of defined properties can be
1850    * found in the <ulink url="http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html">pulseaudio api docs</ulink>.
1851    *
1852    * Below is an example for registering as a music application to pulseaudio.
1853    * |[
1854    * GstStructure *props;
1855    *
1856    * props = gst_structure_from_string ("props,media.role=music", NULL);
1857    * g_object_set (pulse, "stream-properties", props, NULL);
1858    * gst_structure_free
1859    * ]|
1860    *
1861    * Since: 0.10.26
1862    */
1863   g_object_class_install_property (gobject_class,
1864       PROP_STREAM_PROPERTIES,
1865       g_param_spec_boxed ("stream-properties", "stream properties",
1866           "list of pulseaudio stream properties",
1867           GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1868
1869   gst_element_class_set_static_metadata (gstelement_class,
1870       "PulseAudio Audio Sink",
1871       "Sink/Audio", "Plays audio to a PulseAudio server", "Lennart Poettering");
1872   gst_element_class_add_pad_template (gstelement_class,
1873       gst_static_pad_template_get (&pad_template));
1874 }
1875
1876 /* returns the current time of the sink ringbuffer */
1877 static GstClockTime
1878 gst_pulsesink_get_time (GstClock * clock, GstAudioBaseSink * sink)
1879 {
1880   GstPulseSink *psink;
1881   GstPulseRingBuffer *pbuf;
1882   pa_usec_t time;
1883
1884   if (!sink->ringbuffer || !sink->ringbuffer->acquired)
1885     return GST_CLOCK_TIME_NONE;
1886
1887   pbuf = GST_PULSERING_BUFFER_CAST (sink->ringbuffer);
1888   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1889
1890   if (g_atomic_int_get (&psink->format_lost)) {
1891     /* Stream was lost in a format change, it'll get set up again once
1892      * upstream renegotiates */
1893     return psink->format_lost_time;
1894   }
1895
1896   pa_threaded_mainloop_lock (mainloop);
1897   if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1898     goto server_dead;
1899
1900   /* if we don't have enough data to get a timestamp, just return NONE, which
1901    * will return the last reported time */
1902   if (pa_stream_get_time (pbuf->stream, &time) < 0) {
1903     GST_DEBUG_OBJECT (psink, "could not get time");
1904     time = GST_CLOCK_TIME_NONE;
1905   } else
1906     time *= 1000;
1907   pa_threaded_mainloop_unlock (mainloop);
1908
1909   GST_LOG_OBJECT (psink, "current time is %" GST_TIME_FORMAT,
1910       GST_TIME_ARGS (time));
1911
1912   return time;
1913
1914   /* ERRORS */
1915 server_dead:
1916   {
1917     GST_DEBUG_OBJECT (psink, "the server is dead");
1918     pa_threaded_mainloop_unlock (mainloop);
1919
1920     return GST_CLOCK_TIME_NONE;
1921   }
1922 }
1923
1924 static void
1925 gst_pulsesink_sink_info_cb (pa_context * c, const pa_sink_info * i, int eol,
1926     void *userdata)
1927 {
1928   GstPulseRingBuffer *pbuf;
1929   GstPulseSink *psink;
1930   GList *l;
1931   guint8 j;
1932
1933   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
1934   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1935
1936   if (!i)
1937     goto done;
1938
1939   g_free (psink->device_description);
1940   psink->device_description = g_strdup (i->description);
1941
1942   g_mutex_lock (&psink->sink_formats_lock);
1943
1944   for (l = g_list_first (psink->sink_formats); l; l = g_list_next (l))
1945     pa_format_info_free ((pa_format_info *) l->data);
1946
1947   g_list_free (psink->sink_formats);
1948   psink->sink_formats = NULL;
1949
1950   for (j = 0; j < i->n_formats; j++)
1951     psink->sink_formats = g_list_prepend (psink->sink_formats,
1952         pa_format_info_copy (i->formats[j]));
1953
1954   g_mutex_unlock (&psink->sink_formats_lock);
1955
1956 done:
1957   pa_threaded_mainloop_signal (mainloop, 0);
1958 }
1959
1960 static gboolean
1961 gst_pulsesink_query_acceptcaps (GstPulseSink * psink, GstCaps * caps)
1962 {
1963   GstPulseRingBuffer *pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK
1964       (psink)->ringbuffer);
1965   GstPad *pad = GST_BASE_SINK_PAD (psink);
1966   GstCaps *pad_caps;
1967   GstStructure *st;
1968   gboolean ret = FALSE;
1969
1970   GstAudioRingBufferSpec spec = { 0 };
1971   pa_stream *stream = NULL;
1972   pa_operation *o = NULL;
1973   pa_channel_map channel_map;
1974   pa_stream_flags_t flags;
1975   pa_format_info *format = NULL, *formats[1];
1976   guint channels;
1977
1978   pad_caps = gst_pad_query_caps (pad, caps);
1979   ret = pad_caps != NULL;
1980   gst_caps_unref (pad_caps);
1981
1982   /* Either template caps didn't match, or we're still in NULL state */
1983   if (!ret || !pbuf->context)
1984     goto done;
1985
1986   /* If we've not got fixed caps, creating a stream might fail, so let's just
1987    * return from here with default acceptcaps behaviour */
1988   if (!gst_caps_is_fixed (caps))
1989     goto done;
1990
1991   ret = FALSE;
1992
1993   pa_threaded_mainloop_lock (mainloop);
1994
1995   spec.latency_time = GST_AUDIO_BASE_SINK (psink)->latency_time;
1996   if (!gst_audio_ring_buffer_parse_caps (&spec, caps))
1997     goto out;
1998
1999   if (!gst_pulse_fill_format_info (&spec, &format, &channels))
2000     goto out;
2001
2002   /* Make sure input is framed (one frame per buffer) and can be payloaded */
2003   if (!pa_format_info_is_pcm (format)) {
2004     gboolean framed = FALSE, parsed = FALSE;
2005     st = gst_caps_get_structure (caps, 0);
2006
2007     gst_structure_get_boolean (st, "framed", &framed);
2008     gst_structure_get_boolean (st, "parsed", &parsed);
2009     if ((!framed && !parsed) || gst_audio_iec61937_frame_size (&spec) <= 0)
2010       goto out;
2011   }
2012
2013   /* initialize the channel map */
2014   if (pa_format_info_is_pcm (format) &&
2015       gst_pulse_gst_to_channel_map (&channel_map, &spec))
2016     pa_format_info_set_channel_map (format, &channel_map);
2017
2018   if (pbuf->stream) {
2019     /* We're already in PAUSED or above, so just reuse this stream to query
2020      * sink formats and use those. */
2021     GList *i;
2022
2023     if (!(o = pa_context_get_sink_info_by_name (pbuf->context, psink->device,
2024                 gst_pulsesink_sink_info_cb, pbuf)))
2025       goto info_failed;
2026
2027     while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2028       pa_threaded_mainloop_wait (mainloop);
2029       if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2030         goto out;
2031     }
2032
2033     g_mutex_lock (&psink->sink_formats_lock);
2034     for (i = g_list_first (psink->sink_formats); i; i = g_list_next (i)) {
2035       if (pa_format_info_is_compatible ((pa_format_info *) i->data, format)) {
2036         ret = TRUE;
2037         break;
2038       }
2039     }
2040     g_mutex_unlock (&psink->sink_formats_lock);
2041   } else {
2042     /* We're in READY, let's connect a stream to see if the format is
2043      * accpeted by whatever sink we're routed to */
2044     formats[0] = format;
2045
2046     if (!(stream = pa_stream_new_extended (pbuf->context, "pulsesink probe",
2047                 formats, 1, psink->proplist)))
2048       goto out;
2049
2050     /* construct the flags */
2051     flags = PA_STREAM_INTERPOLATE_TIMING | PA_STREAM_AUTO_TIMING_UPDATE |
2052         PA_STREAM_ADJUST_LATENCY | PA_STREAM_START_CORKED;
2053
2054     pa_stream_set_state_callback (stream, gst_pulsering_stream_state_cb, pbuf);
2055
2056     if (pa_stream_connect_playback (stream, psink->device, NULL, flags, NULL,
2057             NULL) < 0)
2058       goto out;
2059
2060     ret = gst_pulsering_wait_for_stream_ready (psink, stream);
2061   }
2062
2063 out:
2064   if (format)
2065     pa_format_info_free (format);
2066
2067   if (o)
2068     pa_operation_unref (o);
2069
2070   if (stream) {
2071     pa_stream_set_state_callback (stream, NULL, NULL);
2072     pa_stream_disconnect (stream);
2073     pa_stream_unref (stream);
2074   }
2075
2076   pa_threaded_mainloop_unlock (mainloop);
2077
2078 done:
2079   return ret;
2080
2081 info_failed:
2082   {
2083     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2084         ("pa_context_get_sink_input_info() failed: %s",
2085             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2086     goto out;
2087   }
2088 }
2089
2090 static void
2091 gst_pulsesink_init (GstPulseSink * pulsesink)
2092 {
2093   pulsesink->server = NULL;
2094   pulsesink->device = NULL;
2095   pulsesink->device_description = NULL;
2096   pulsesink->client_name = gst_pulse_client_name ();
2097
2098   g_mutex_init (&pulsesink->sink_formats_lock);
2099   pulsesink->sink_formats = NULL;
2100
2101   pulsesink->volume = DEFAULT_VOLUME;
2102   pulsesink->volume_set = FALSE;
2103
2104   pulsesink->mute = DEFAULT_MUTE;
2105   pulsesink->mute_set = FALSE;
2106
2107   pulsesink->notify = 0;
2108
2109   g_atomic_int_set (&pulsesink->format_lost, FALSE);
2110   pulsesink->format_lost_time = GST_CLOCK_TIME_NONE;
2111
2112   pulsesink->properties = NULL;
2113   pulsesink->proplist = NULL;
2114
2115   /* override with a custom clock */
2116   if (GST_AUDIO_BASE_SINK (pulsesink)->provided_clock)
2117     gst_object_unref (GST_AUDIO_BASE_SINK (pulsesink)->provided_clock);
2118
2119   GST_AUDIO_BASE_SINK (pulsesink)->provided_clock =
2120       gst_audio_clock_new ("GstPulseSinkClock",
2121       (GstAudioClockGetTimeFunc) gst_pulsesink_get_time, pulsesink, NULL);
2122
2123   /* TRUE for sinks, FALSE for sources */
2124   pulsesink->probe = gst_pulseprobe_new (G_OBJECT (pulsesink),
2125       G_OBJECT_GET_CLASS (pulsesink), PROP_DEVICE, pulsesink->device,
2126       TRUE, FALSE);
2127 }
2128
2129 static void
2130 gst_pulsesink_finalize (GObject * object)
2131 {
2132   GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2133   GList *i;
2134
2135   g_free (pulsesink->server);
2136   g_free (pulsesink->device);
2137   g_free (pulsesink->device_description);
2138   g_free (pulsesink->client_name);
2139
2140   for (i = g_list_first (pulsesink->sink_formats); i; i = g_list_next (i))
2141     pa_format_info_free ((pa_format_info *) i->data);
2142
2143   g_list_free (pulsesink->sink_formats);
2144   g_mutex_clear (&pulsesink->sink_formats_lock);
2145
2146   if (pulsesink->properties)
2147     gst_structure_free (pulsesink->properties);
2148   if (pulsesink->proplist)
2149     pa_proplist_free (pulsesink->proplist);
2150
2151   if (pulsesink->probe) {
2152     gst_pulseprobe_free (pulsesink->probe);
2153     pulsesink->probe = NULL;
2154   }
2155
2156   G_OBJECT_CLASS (parent_class)->finalize (object);
2157 }
2158
2159 static void
2160 gst_pulsesink_set_volume (GstPulseSink * psink, gdouble volume)
2161 {
2162   pa_cvolume v;
2163   pa_operation *o = NULL;
2164   GstPulseRingBuffer *pbuf;
2165   uint32_t idx;
2166
2167   if (!mainloop)
2168     goto no_mainloop;
2169
2170   pa_threaded_mainloop_lock (mainloop);
2171
2172   GST_DEBUG_OBJECT (psink, "setting volume to %f", volume);
2173
2174   pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2175   if (pbuf == NULL || pbuf->stream == NULL)
2176     goto no_buffer;
2177
2178   if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2179     goto no_index;
2180
2181   if (pbuf->is_pcm)
2182     gst_pulse_cvolume_from_linear (&v, pbuf->channels, volume);
2183   else
2184     /* FIXME: this will eventually be superceded by checks to see if the volume
2185      * is readable/writable */
2186     goto unlock;
2187
2188   if (!(o = pa_context_set_sink_input_volume (pbuf->context, idx,
2189               &v, NULL, NULL)))
2190     goto volume_failed;
2191
2192   /* We don't really care about the result of this call */
2193 unlock:
2194
2195   if (o)
2196     pa_operation_unref (o);
2197
2198   pa_threaded_mainloop_unlock (mainloop);
2199
2200   return;
2201
2202   /* ERRORS */
2203 no_mainloop:
2204   {
2205     psink->volume = volume;
2206     psink->volume_set = TRUE;
2207
2208     GST_DEBUG_OBJECT (psink, "we have no mainloop");
2209     return;
2210   }
2211 no_buffer:
2212   {
2213     psink->volume = volume;
2214     psink->volume_set = TRUE;
2215
2216     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2217     goto unlock;
2218   }
2219 no_index:
2220   {
2221     GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2222     goto unlock;
2223   }
2224 volume_failed:
2225   {
2226     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2227         ("pa_stream_set_sink_input_volume() failed: %s",
2228             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2229     goto unlock;
2230   }
2231 }
2232
2233 static void
2234 gst_pulsesink_set_mute (GstPulseSink * psink, gboolean mute)
2235 {
2236   pa_operation *o = NULL;
2237   GstPulseRingBuffer *pbuf;
2238   uint32_t idx;
2239
2240   if (!mainloop)
2241     goto no_mainloop;
2242
2243   pa_threaded_mainloop_lock (mainloop);
2244
2245   GST_DEBUG_OBJECT (psink, "setting mute state to %d", mute);
2246
2247   pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2248   if (pbuf == NULL || pbuf->stream == NULL)
2249     goto no_buffer;
2250
2251   if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2252     goto no_index;
2253
2254   if (!(o = pa_context_set_sink_input_mute (pbuf->context, idx,
2255               mute, NULL, NULL)))
2256     goto mute_failed;
2257
2258   /* We don't really care about the result of this call */
2259 unlock:
2260
2261   if (o)
2262     pa_operation_unref (o);
2263
2264   pa_threaded_mainloop_unlock (mainloop);
2265
2266   return;
2267
2268   /* ERRORS */
2269 no_mainloop:
2270   {
2271     psink->mute = mute;
2272     psink->mute_set = TRUE;
2273
2274     GST_DEBUG_OBJECT (psink, "we have no mainloop");
2275     return;
2276   }
2277 no_buffer:
2278   {
2279     psink->mute = mute;
2280     psink->mute_set = TRUE;
2281
2282     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2283     goto unlock;
2284   }
2285 no_index:
2286   {
2287     GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2288     goto unlock;
2289   }
2290 mute_failed:
2291   {
2292     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2293         ("pa_stream_set_sink_input_mute() failed: %s",
2294             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2295     goto unlock;
2296   }
2297 }
2298
2299 static void
2300 gst_pulsesink_sink_input_info_cb (pa_context * c, const pa_sink_input_info * i,
2301     int eol, void *userdata)
2302 {
2303   GstPulseRingBuffer *pbuf;
2304   GstPulseSink *psink;
2305
2306   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
2307   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
2308
2309   if (!i)
2310     goto done;
2311
2312   if (!pbuf->stream)
2313     goto done;
2314
2315   /* If the index doesn't match our current stream,
2316    * it implies we just recreated the stream (caps change)
2317    */
2318   if (i->index == pa_stream_get_index (pbuf->stream)) {
2319     psink->volume = pa_sw_volume_to_linear (pa_cvolume_max (&i->volume));
2320     psink->mute = i->mute;
2321   }
2322
2323 done:
2324   pa_threaded_mainloop_signal (mainloop, 0);
2325 }
2326
2327 static gdouble
2328 gst_pulsesink_get_volume (GstPulseSink * psink)
2329 {
2330   GstPulseRingBuffer *pbuf;
2331   pa_operation *o = NULL;
2332   gdouble v = DEFAULT_VOLUME;
2333   uint32_t idx;
2334
2335   if (!mainloop)
2336     goto no_mainloop;
2337
2338   pa_threaded_mainloop_lock (mainloop);
2339
2340   pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2341   if (pbuf == NULL || pbuf->stream == NULL)
2342     goto no_buffer;
2343
2344   if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2345     goto no_index;
2346
2347   if (!(o = pa_context_get_sink_input_info (pbuf->context, idx,
2348               gst_pulsesink_sink_input_info_cb, pbuf)))
2349     goto info_failed;
2350
2351   while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2352     pa_threaded_mainloop_wait (mainloop);
2353     if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2354       goto unlock;
2355   }
2356
2357 unlock:
2358   v = psink->volume;
2359
2360   if (o)
2361     pa_operation_unref (o);
2362
2363   pa_threaded_mainloop_unlock (mainloop);
2364
2365   if (v > MAX_VOLUME) {
2366     GST_WARNING_OBJECT (psink, "Clipped volume from %f to %f", v, MAX_VOLUME);
2367     v = MAX_VOLUME;
2368   }
2369
2370   return v;
2371
2372   /* ERRORS */
2373 no_mainloop:
2374   {
2375     v = psink->volume;
2376     GST_DEBUG_OBJECT (psink, "we have no mainloop");
2377     return v;
2378   }
2379 no_buffer:
2380   {
2381     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2382     goto unlock;
2383   }
2384 no_index:
2385   {
2386     GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2387     goto unlock;
2388   }
2389 info_failed:
2390   {
2391     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2392         ("pa_context_get_sink_input_info() failed: %s",
2393             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2394     goto unlock;
2395   }
2396 }
2397
2398 static gboolean
2399 gst_pulsesink_get_mute (GstPulseSink * psink)
2400 {
2401   GstPulseRingBuffer *pbuf;
2402   pa_operation *o = NULL;
2403   uint32_t idx;
2404   gboolean mute = FALSE;
2405
2406   if (!mainloop)
2407     goto no_mainloop;
2408
2409   pa_threaded_mainloop_lock (mainloop);
2410   mute = psink->mute;
2411
2412   pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2413   if (pbuf == NULL || pbuf->stream == NULL)
2414     goto no_buffer;
2415
2416   if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2417     goto no_index;
2418
2419   if (!(o = pa_context_get_sink_input_info (pbuf->context, idx,
2420               gst_pulsesink_sink_input_info_cb, pbuf)))
2421     goto info_failed;
2422
2423   while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2424     pa_threaded_mainloop_wait (mainloop);
2425     if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2426       goto unlock;
2427   }
2428
2429 unlock:
2430   if (o)
2431     pa_operation_unref (o);
2432
2433   pa_threaded_mainloop_unlock (mainloop);
2434
2435   return mute;
2436
2437   /* ERRORS */
2438 no_mainloop:
2439   {
2440     mute = psink->mute;
2441     GST_DEBUG_OBJECT (psink, "we have no mainloop");
2442     return mute;
2443   }
2444 no_buffer:
2445   {
2446     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2447     goto unlock;
2448   }
2449 no_index:
2450   {
2451     GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2452     goto unlock;
2453   }
2454 info_failed:
2455   {
2456     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2457         ("pa_context_get_sink_input_info() failed: %s",
2458             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2459     goto unlock;
2460   }
2461 }
2462
2463 static gchar *
2464 gst_pulsesink_device_description (GstPulseSink * psink)
2465 {
2466   GstPulseRingBuffer *pbuf;
2467   pa_operation *o = NULL;
2468   gchar *t;
2469
2470   if (!mainloop)
2471     goto no_mainloop;
2472
2473   pa_threaded_mainloop_lock (mainloop);
2474   pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2475   if (pbuf == NULL)
2476     goto no_buffer;
2477
2478   if (!(o = pa_context_get_sink_info_by_name (pbuf->context,
2479               psink->device, gst_pulsesink_sink_info_cb, pbuf)))
2480     goto info_failed;
2481
2482   while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2483     pa_threaded_mainloop_wait (mainloop);
2484     if (gst_pulsering_is_dead (psink, pbuf, FALSE))
2485       goto unlock;
2486   }
2487
2488 unlock:
2489   if (o)
2490     pa_operation_unref (o);
2491
2492   t = g_strdup (psink->device_description);
2493   pa_threaded_mainloop_unlock (mainloop);
2494
2495   return t;
2496
2497   /* ERRORS */
2498 no_mainloop:
2499   {
2500     GST_DEBUG_OBJECT (psink, "we have no mainloop");
2501     return NULL;
2502   }
2503 no_buffer:
2504   {
2505     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2506     goto unlock;
2507   }
2508 info_failed:
2509   {
2510     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2511         ("pa_context_get_sink_info_by_index() failed: %s",
2512             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2513     goto unlock;
2514   }
2515 }
2516
2517 static void
2518 gst_pulsesink_set_property (GObject * object,
2519     guint prop_id, const GValue * value, GParamSpec * pspec)
2520 {
2521   GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2522
2523   switch (prop_id) {
2524     case PROP_SERVER:
2525       g_free (pulsesink->server);
2526       pulsesink->server = g_value_dup_string (value);
2527       if (pulsesink->probe)
2528         gst_pulseprobe_set_server (pulsesink->probe, pulsesink->server);
2529       break;
2530     case PROP_DEVICE:
2531       g_free (pulsesink->device);
2532       pulsesink->device = g_value_dup_string (value);
2533       break;
2534     case PROP_VOLUME:
2535       gst_pulsesink_set_volume (pulsesink, g_value_get_double (value));
2536       break;
2537     case PROP_MUTE:
2538       gst_pulsesink_set_mute (pulsesink, g_value_get_boolean (value));
2539       break;
2540     case PROP_CLIENT_NAME:
2541       g_free (pulsesink->client_name);
2542       if (!g_value_get_string (value)) {
2543         GST_WARNING_OBJECT (pulsesink,
2544             "Empty PulseAudio client name not allowed. Resetting to default value");
2545         pulsesink->client_name = gst_pulse_client_name ();
2546       } else
2547         pulsesink->client_name = g_value_dup_string (value);
2548       break;
2549     case PROP_STREAM_PROPERTIES:
2550       if (pulsesink->properties)
2551         gst_structure_free (pulsesink->properties);
2552       pulsesink->properties =
2553           gst_structure_copy (gst_value_get_structure (value));
2554       if (pulsesink->proplist)
2555         pa_proplist_free (pulsesink->proplist);
2556       pulsesink->proplist = gst_pulse_make_proplist (pulsesink->properties);
2557       break;
2558     default:
2559       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2560       break;
2561   }
2562 }
2563
2564 static void
2565 gst_pulsesink_get_property (GObject * object,
2566     guint prop_id, GValue * value, GParamSpec * pspec)
2567 {
2568
2569   GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2570
2571   switch (prop_id) {
2572     case PROP_SERVER:
2573       g_value_set_string (value, pulsesink->server);
2574       break;
2575     case PROP_DEVICE:
2576       g_value_set_string (value, pulsesink->device);
2577       break;
2578     case PROP_DEVICE_NAME:
2579       g_value_take_string (value, gst_pulsesink_device_description (pulsesink));
2580       break;
2581     case PROP_VOLUME:
2582       g_value_set_double (value, gst_pulsesink_get_volume (pulsesink));
2583       break;
2584     case PROP_MUTE:
2585       g_value_set_boolean (value, gst_pulsesink_get_mute (pulsesink));
2586       break;
2587     case PROP_CLIENT_NAME:
2588       g_value_set_string (value, pulsesink->client_name);
2589       break;
2590     case PROP_STREAM_PROPERTIES:
2591       gst_value_set_structure (value, pulsesink->properties);
2592       break;
2593     default:
2594       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2595       break;
2596   }
2597 }
2598
2599 static void
2600 gst_pulsesink_change_title (GstPulseSink * psink, const gchar * t)
2601 {
2602   pa_operation *o = NULL;
2603   GstPulseRingBuffer *pbuf;
2604
2605   pa_threaded_mainloop_lock (mainloop);
2606
2607   pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2608
2609   if (pbuf == NULL || pbuf->stream == NULL)
2610     goto no_buffer;
2611
2612   g_free (pbuf->stream_name);
2613   pbuf->stream_name = g_strdup (t);
2614
2615   if (!(o = pa_stream_set_name (pbuf->stream, pbuf->stream_name, NULL, NULL)))
2616     goto name_failed;
2617
2618   /* We're not interested if this operation failed or not */
2619 unlock:
2620
2621   if (o)
2622     pa_operation_unref (o);
2623   pa_threaded_mainloop_unlock (mainloop);
2624
2625   return;
2626
2627   /* ERRORS */
2628 no_buffer:
2629   {
2630     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2631     goto unlock;
2632   }
2633 name_failed:
2634   {
2635     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2636         ("pa_stream_set_name() failed: %s",
2637             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2638     goto unlock;
2639   }
2640 }
2641
2642 static void
2643 gst_pulsesink_change_props (GstPulseSink * psink, GstTagList * l)
2644 {
2645   static const gchar *const map[] = {
2646     GST_TAG_TITLE, PA_PROP_MEDIA_TITLE,
2647
2648     /* might get overriden in the next iteration by GST_TAG_ARTIST */
2649     GST_TAG_PERFORMER, PA_PROP_MEDIA_ARTIST,
2650
2651     GST_TAG_ARTIST, PA_PROP_MEDIA_ARTIST,
2652     GST_TAG_LANGUAGE_CODE, PA_PROP_MEDIA_LANGUAGE,
2653     GST_TAG_LOCATION, PA_PROP_MEDIA_FILENAME,
2654     /* We might add more here later on ... */
2655     NULL
2656   };
2657   pa_proplist *pl = NULL;
2658   const gchar *const *t;
2659   gboolean empty = TRUE;
2660   pa_operation *o = NULL;
2661   GstPulseRingBuffer *pbuf;
2662
2663   pl = pa_proplist_new ();
2664
2665   for (t = map; *t; t += 2) {
2666     gchar *n = NULL;
2667
2668     if (gst_tag_list_get_string (l, *t, &n)) {
2669
2670       if (n && *n) {
2671         pa_proplist_sets (pl, *(t + 1), n);
2672         empty = FALSE;
2673       }
2674
2675       g_free (n);
2676     }
2677   }
2678   if (empty)
2679     goto finish;
2680
2681   pa_threaded_mainloop_lock (mainloop);
2682   pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2683   if (pbuf == NULL || pbuf->stream == NULL)
2684     goto no_buffer;
2685
2686   if (!(o = pa_stream_proplist_update (pbuf->stream, PA_UPDATE_REPLACE,
2687               pl, NULL, NULL)))
2688     goto update_failed;
2689
2690   /* We're not interested if this operation failed or not */
2691 unlock:
2692
2693   if (o)
2694     pa_operation_unref (o);
2695
2696   pa_threaded_mainloop_unlock (mainloop);
2697
2698 finish:
2699
2700   if (pl)
2701     pa_proplist_free (pl);
2702
2703   return;
2704
2705   /* ERRORS */
2706 no_buffer:
2707   {
2708     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2709     goto unlock;
2710   }
2711 update_failed:
2712   {
2713     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2714         ("pa_stream_proplist_update() failed: %s",
2715             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2716     goto unlock;
2717   }
2718 }
2719
2720 static void
2721 gst_pulsesink_flush_ringbuffer (GstPulseSink * psink)
2722 {
2723   GstPulseRingBuffer *pbuf;
2724
2725   pa_threaded_mainloop_lock (mainloop);
2726
2727   pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2728
2729   if (pbuf == NULL || pbuf->stream == NULL)
2730     goto no_buffer;
2731
2732   gst_pulsering_flush (pbuf);
2733
2734   /* Uncork if we haven't already (happens when waiting to get enough data
2735    * to send out the first time) */
2736   if (pbuf->corked)
2737     gst_pulsering_set_corked (pbuf, FALSE, FALSE);
2738
2739   /* We're not interested if this operation failed or not */
2740 unlock:
2741   pa_threaded_mainloop_unlock (mainloop);
2742
2743   return;
2744
2745   /* ERRORS */
2746 no_buffer:
2747   {
2748     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2749     goto unlock;
2750   }
2751 }
2752
2753 static gboolean
2754 gst_pulsesink_event (GstBaseSink * sink, GstEvent * event)
2755 {
2756   GstPulseSink *pulsesink = GST_PULSESINK_CAST (sink);
2757
2758   switch (GST_EVENT_TYPE (event)) {
2759     case GST_EVENT_TAG:{
2760       gchar *title = NULL, *artist = NULL, *location = NULL, *description =
2761           NULL, *t = NULL, *buf = NULL;
2762       GstTagList *l;
2763
2764       gst_event_parse_tag (event, &l);
2765
2766       gst_tag_list_get_string (l, GST_TAG_TITLE, &title);
2767       gst_tag_list_get_string (l, GST_TAG_ARTIST, &artist);
2768       gst_tag_list_get_string (l, GST_TAG_LOCATION, &location);
2769       gst_tag_list_get_string (l, GST_TAG_DESCRIPTION, &description);
2770
2771       if (!artist)
2772         gst_tag_list_get_string (l, GST_TAG_PERFORMER, &artist);
2773
2774       if (title && artist)
2775         /* TRANSLATORS: 'song title' by 'artist name' */
2776         t = buf = g_strdup_printf (_("'%s' by '%s'"), g_strstrip (title),
2777             g_strstrip (artist));
2778       else if (title)
2779         t = g_strstrip (title);
2780       else if (description)
2781         t = g_strstrip (description);
2782       else if (location)
2783         t = g_strstrip (location);
2784
2785       if (t)
2786         gst_pulsesink_change_title (pulsesink, t);
2787
2788       g_free (title);
2789       g_free (artist);
2790       g_free (location);
2791       g_free (description);
2792       g_free (buf);
2793
2794       gst_pulsesink_change_props (pulsesink, l);
2795
2796       break;
2797     }
2798     case GST_EVENT_EOS:
2799       gst_pulsesink_flush_ringbuffer (pulsesink);
2800       break;
2801     default:
2802       ;
2803   }
2804
2805   return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
2806 }
2807
2808 static gboolean
2809 gst_pulsesink_query (GstBaseSink * sink, GstQuery * query)
2810 {
2811   GstPulseSink *pulsesink = GST_PULSESINK_CAST (sink);
2812   gboolean ret;
2813
2814   switch (GST_QUERY_TYPE (query)) {
2815     case GST_QUERY_ACCEPT_CAPS:
2816     {
2817       GstCaps *caps;
2818
2819       gst_query_parse_accept_caps (query, &caps);
2820       ret = gst_pulsesink_query_acceptcaps (pulsesink, caps);
2821       gst_query_set_accept_caps_result (query, ret);
2822       ret = TRUE;
2823       break;
2824     }
2825     default:
2826       ret = GST_BASE_SINK_CLASS (parent_class)->query (sink, query);
2827       break;
2828   }
2829   return ret;
2830 }
2831
2832 static void
2833 gst_pulsesink_release_mainloop (GstPulseSink * psink)
2834 {
2835   if (!mainloop)
2836     return;
2837
2838   pa_threaded_mainloop_lock (mainloop);
2839   while (psink->defer_pending) {
2840     GST_DEBUG_OBJECT (psink, "waiting for stream status message emission");
2841     pa_threaded_mainloop_wait (mainloop);
2842   }
2843   pa_threaded_mainloop_unlock (mainloop);
2844
2845   g_mutex_lock (&pa_shared_resource_mutex);
2846   mainloop_ref_ct--;
2847   if (!mainloop_ref_ct) {
2848     GST_INFO_OBJECT (psink, "terminating pa main loop thread");
2849     pa_threaded_mainloop_stop (mainloop);
2850     pa_threaded_mainloop_free (mainloop);
2851     mainloop = NULL;
2852   }
2853   g_mutex_unlock (&pa_shared_resource_mutex);
2854 }
2855
2856 static GstStateChangeReturn
2857 gst_pulsesink_change_state (GstElement * element, GstStateChange transition)
2858 {
2859   GstPulseSink *pulsesink = GST_PULSESINK (element);
2860   GstStateChangeReturn ret;
2861
2862   switch (transition) {
2863     case GST_STATE_CHANGE_NULL_TO_READY:
2864       g_mutex_lock (&pa_shared_resource_mutex);
2865       if (!mainloop_ref_ct) {
2866         GST_INFO_OBJECT (element, "new pa main loop thread");
2867         if (!(mainloop = pa_threaded_mainloop_new ()))
2868           goto mainloop_failed;
2869         if (pa_threaded_mainloop_start (mainloop) < 0) {
2870           pa_threaded_mainloop_free (mainloop);
2871           goto mainloop_start_failed;
2872         }
2873         mainloop_ref_ct = 1;
2874         g_mutex_unlock (&pa_shared_resource_mutex);
2875       } else {
2876         GST_INFO_OBJECT (element, "reusing pa main loop thread");
2877         mainloop_ref_ct++;
2878         g_mutex_unlock (&pa_shared_resource_mutex);
2879       }
2880       break;
2881     case GST_STATE_CHANGE_READY_TO_PAUSED:
2882       gst_element_post_message (element,
2883           gst_message_new_clock_provide (GST_OBJECT_CAST (element),
2884               GST_AUDIO_BASE_SINK (pulsesink)->provided_clock, TRUE));
2885       break;
2886
2887     default:
2888       break;
2889   }
2890
2891   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2892   if (ret == GST_STATE_CHANGE_FAILURE)
2893     goto state_failure;
2894
2895   switch (transition) {
2896     case GST_STATE_CHANGE_PAUSED_TO_READY:
2897       /* format_lost is reset in release() in audiobasesink */
2898       gst_element_post_message (element,
2899           gst_message_new_clock_lost (GST_OBJECT_CAST (element),
2900               GST_AUDIO_BASE_SINK (pulsesink)->provided_clock));
2901       break;
2902     case GST_STATE_CHANGE_READY_TO_NULL:
2903       gst_pulsesink_release_mainloop (pulsesink);
2904       break;
2905     default:
2906       break;
2907   }
2908
2909   return ret;
2910
2911   /* ERRORS */
2912 mainloop_failed:
2913   {
2914     g_mutex_unlock (&pa_shared_resource_mutex);
2915     GST_ELEMENT_ERROR (pulsesink, RESOURCE, FAILED,
2916         ("pa_threaded_mainloop_new() failed"), (NULL));
2917     return GST_STATE_CHANGE_FAILURE;
2918   }
2919 mainloop_start_failed:
2920   {
2921     g_mutex_unlock (&pa_shared_resource_mutex);
2922     GST_ELEMENT_ERROR (pulsesink, RESOURCE, FAILED,
2923         ("pa_threaded_mainloop_start() failed"), (NULL));
2924     return GST_STATE_CHANGE_FAILURE;
2925   }
2926 state_failure:
2927   {
2928     if (transition == GST_STATE_CHANGE_NULL_TO_READY) {
2929       /* Clear the PA mainloop if audiobasesink failed to open the ring_buffer */
2930       g_assert (mainloop);
2931       gst_pulsesink_release_mainloop (pulsesink);
2932     }
2933     return ret;
2934   }
2935 }