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