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 #else
 146   pa_sample_spec sample_spec;
 147 #endif
 148   gboolean is_pcm;
 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 #else
 236   pa_sample_spec_init (&pbuf->sample_spec);
 237 #endif
 238   pbuf->is_pcm = FALSE;
 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 ("pulse-sink-changed", NULL));
 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 ("pulse-format-lost", NULL));
 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   pbuf->is_pcm = TRUE;
 832 #endif
 833
 834   pa_threaded_mainloop_lock (mainloop);
 835
 836   /* we need a context and a no stream */
 837   g_assert (pbuf->context);
 838   g_assert (!pbuf->stream);
 839
 840   /* enable event notifications */
 841   GST_LOG_OBJECT (psink, "subscribing to context events");
 842   if (!(o = pa_context_subscribe (pbuf->context,
 843               PA_SUBSCRIPTION_MASK_SINK_INPUT, NULL, NULL)))
 844     goto subscribe_failed;
 845
 846   pa_operation_unref (o);
 847
 848   /* initialize the channel map */
 849 #ifdef HAVE_PULSE_1_0
 850   if (pbuf->is_pcm && gst_pulse_gst_to_channel_map (&channel_map, spec))
 851     pa_format_info_set_channel_map (pbuf->format, &channel_map);
 852 #else
 853   gst_pulse_gst_to_channel_map (&channel_map, spec);
 854 #endif
 855
 856   /* find a good name for the stream */
 857   if (psink->stream_name)
 858     name = psink->stream_name;
 859   else
 860     name = "Playback Stream";
 861
 862   /* create a stream */
 863 #ifdef HAVE_PULSE_1_0
 864   formats[0] = pbuf->format;
 865   if (!(pbuf->stream = pa_stream_new_extended (pbuf->context, name, formats, 1,
 866               psink->proplist)))
 867     goto stream_failed;
 868 #else
 869   GST_LOG_OBJECT (psink, "creating stream with name %s", name);
 870   if (!(pbuf->stream = pa_stream_new_with_proplist (pbuf->context, name,
 871               &pbuf->sample_spec, &channel_map, psink->proplist)))
 872     goto stream_failed;
 873 #endif
 874
 875   /* install essential callbacks */
 876   pa_stream_set_state_callback (pbuf->stream,
 877       gst_pulsering_stream_state_cb, pbuf);
 878   pa_stream_set_write_callback (pbuf->stream,
 879       gst_pulsering_stream_request_cb, pbuf);
 880   pa_stream_set_underflow_callback (pbuf->stream,
 881       gst_pulsering_stream_underflow_cb, pbuf);
 882   pa_stream_set_overflow_callback (pbuf->stream,
 883       gst_pulsering_stream_overflow_cb, pbuf);
 884   pa_stream_set_latency_update_callback (pbuf->stream,
 885       gst_pulsering_stream_latency_cb, pbuf);
 886   pa_stream_set_suspended_callback (pbuf->stream,
 887       gst_pulsering_stream_suspended_cb, pbuf);
 888   pa_stream_set_started_callback (pbuf->stream,
 889       gst_pulsering_stream_started_cb, pbuf);
 890   pa_stream_set_event_callback (pbuf->stream,
 891       gst_pulsering_stream_event_cb, pbuf);
 892
 893   /* buffering requirements. When setting prebuf to 0, the stream will not pause
 894    * when we cause an underrun, which causes time to continue. */
 895   memset (&wanted, 0, sizeof (wanted));
 896   wanted.tlength = spec->segtotal * spec->segsize;
 897   wanted.maxlength = -1;
 898   wanted.prebuf = 0;
 899   wanted.minreq = spec->segsize;
 900
 901   GST_INFO_OBJECT (psink, "tlength:   %d", wanted.tlength);
 902   GST_INFO_OBJECT (psink, "maxlength: %d", wanted.maxlength);
 903   GST_INFO_OBJECT (psink, "prebuf:    %d", wanted.prebuf);
 904   GST_INFO_OBJECT (psink, "minreq:    %d", wanted.minreq);
 905
 906 #ifdef HAVE_PULSE_0_9_20
 907   /* configure volume when we changed it, else we leave the default */
 908   if (psink->volume_set) {
 909     GST_LOG_OBJECT (psink, "have volume of %f", psink->volume);
 910     pv = &v;
 911 #ifdef HAVE_PULSE_1_0
 912     if (pbuf->is_pcm)
 913       gst_pulse_cvolume_from_linear (pv, pbuf->channels, psink->volume);
 914     else {
 915       GST_DEBUG_OBJECT (psink, "passthrough stream, not setting volume");
 916       pv = NULL;
 917     }
 918 #else
 919     gst_pulse_cvolume_from_linear (pv, pbuf->sample_spec.channels,
 920         psink->volume);
 921 #endif
 922   } else {
 923     pv = NULL;
 924   }
 925 #endif
 926
 927   /* construct the flags */
 928   flags = PA_STREAM_INTERPOLATE_TIMING | PA_STREAM_AUTO_TIMING_UPDATE |
 929       PA_STREAM_ADJUST_LATENCY | PA_STREAM_START_CORKED;
 930
 931   if (psink->mute_set && psink->mute)
 932     flags |= PA_STREAM_START_MUTED;
 933
 934   /* we always start corked (see flags above) */
 935   pbuf->corked = TRUE;
 936
 937   /* try to connect now */
 938   GST_LOG_OBJECT (psink, "connect for playback to device %s",
 939       GST_STR_NULL (psink->device));
 940   if (pa_stream_connect_playback (pbuf->stream, psink->device,
 941           &wanted, flags, pv, NULL) < 0)
 942     goto connect_failed;
 943
 944   /* our clock will now start from 0 again */
 945   clock = GST_AUDIO_CLOCK (GST_BASE_AUDIO_SINK (psink)->provided_clock);
 946   gst_audio_clock_reset (clock, 0);
 947
 948   if (!gst_pulsering_wait_for_stream_ready (psink, pbuf->stream))
 949     goto connect_failed;
 950
 951 #ifdef HAVE_PULSE_1_0
 952   g_free (psink->device);
 953   psink->device = g_strdup (pa_stream_get_device_name (pbuf->stream));
 954
 955 #ifndef GST_DISABLE_GST_DEBUG
 956   pa_format_info_snprint (print_buf, sizeof (print_buf),
 957       pa_stream_get_format_info (pbuf->stream));
 958   GST_INFO_OBJECT (psink, "negotiated to: %s", print_buf);
 959 #endif
 960 #endif
 961
 962   /* After we passed the volume off of to PA we never want to set it
 963      again, since it is PA's job to save/restore volumes.  */
 964   psink->volume_set = psink->mute_set = FALSE;
 965
 966   GST_LOG_OBJECT (psink, "stream is acquired now");
 967
 968   /* get the actual buffering properties now */
 969   actual = pa_stream_get_buffer_attr (pbuf->stream);
 970
 971   GST_INFO_OBJECT (psink, "tlength:   %d (wanted: %d)", actual->tlength,
 972       wanted.tlength);
 973   GST_INFO_OBJECT (psink, "maxlength: %d", actual->maxlength);
 974   GST_INFO_OBJECT (psink, "prebuf:    %d", actual->prebuf);
 975   GST_INFO_OBJECT (psink, "minreq:    %d (wanted %d)", actual->minreq,
 976       wanted.minreq);
 977
 978   spec->segsize = actual->minreq;
 979   spec->segtotal = actual->tlength / spec->segsize;
 980
 981   pa_threaded_mainloop_unlock (mainloop);
 982
 983   return TRUE;
 984
 985   /* ERRORS */
 986 unlock_and_fail:
 987   {
 988     gst_pulsering_destroy_stream (pbuf);
 989     pa_threaded_mainloop_unlock (mainloop);
 990
 991     return FALSE;
 992   }
 993 invalid_spec:
 994   {
 995     GST_ELEMENT_ERROR (psink, RESOURCE, SETTINGS,
 996         ("Invalid sample specification."), (NULL));
 997     return FALSE;
 998   }
 999 subscribe_failed:
1000   {
1001     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1002         ("pa_context_subscribe() failed: %s",
1003             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1004     goto unlock_and_fail;
1005   }
1006 stream_failed:
1007   {
1008     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1009         ("Failed to create stream: %s",
1010             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1011     goto unlock_and_fail;
1012   }
1013 connect_failed:
1014   {
1015     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1016         ("Failed to connect stream: %s",
1017             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1018     goto unlock_and_fail;
1019   }
1020 }
1021
1022 /* free the stream that we acquired before */
1023 static gboolean
1024 gst_pulseringbuffer_release (GstRingBuffer * buf)
1025 {
1026   GstPulseRingBuffer *pbuf;
1027
1028   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1029
1030   pa_threaded_mainloop_lock (mainloop);
1031   gst_pulsering_destroy_stream (pbuf);
1032   pa_threaded_mainloop_unlock (mainloop);
1033
1034 #ifdef HAVE_PULSE_1_0
1035   {
1036     GstPulseSink *psink;
1037
1038     psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1039     g_atomic_int_set (&psink->format_lost, FALSE);
1040     psink->format_lost_time = GST_CLOCK_TIME_NONE;
1041   }
1042 #endif
1043
1044   return TRUE;
1045 }
1046
1047 static void
1048 gst_pulsering_success_cb (pa_stream * s, int success, void *userdata)
1049 {
1050   pa_threaded_mainloop_signal (mainloop, 0);
1051 }
1052
1053 /* update the corked state of a stream, must be called with the mainloop
1054  * lock */
1055 static gboolean
1056 gst_pulsering_set_corked (GstPulseRingBuffer * pbuf, gboolean corked,
1057     gboolean wait)
1058 {
1059   pa_operation *o = NULL;
1060   GstPulseSink *psink;
1061   gboolean res = FALSE;
1062
1063   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1064
1065 #ifdef HAVE_PULSE_1_0
1066   if (g_atomic_int_get (&psink->format_lost)) {
1067     /* Sink format changed, stream's gone so fake being paused */
1068     return TRUE;
1069   }
1070 #endif
1071
1072   GST_DEBUG_OBJECT (psink, "setting corked state to %d", corked);
1073   if (pbuf->corked != corked) {
1074     if (!(o = pa_stream_cork (pbuf->stream, corked,
1075                 gst_pulsering_success_cb, pbuf)))
1076       goto cork_failed;
1077
1078     while (wait && pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
1079       pa_threaded_mainloop_wait (mainloop);
1080       if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1081         goto server_dead;
1082     }
1083     pbuf->corked = corked;
1084   } else {
1085     GST_DEBUG_OBJECT (psink, "skipping, already in requested state");
1086   }
1087   res = TRUE;
1088
1089 cleanup:
1090   if (o)
1091     pa_operation_unref (o);
1092
1093   return res;
1094
1095   /* ERRORS */
1096 server_dead:
1097   {
1098     GST_DEBUG_OBJECT (psink, "the server is dead");
1099     goto cleanup;
1100   }
1101 cork_failed:
1102   {
1103     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1104         ("pa_stream_cork() failed: %s",
1105             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1106     goto cleanup;
1107   }
1108 }
1109
1110 static void
1111 gst_pulseringbuffer_clear (GstRingBuffer * buf)
1112 {
1113   GstPulseSink *psink;
1114   GstPulseRingBuffer *pbuf;
1115   pa_operation *o = NULL;
1116
1117   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1118   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1119
1120   pa_threaded_mainloop_lock (mainloop);
1121   GST_DEBUG_OBJECT (psink, "clearing");
1122   if (pbuf->stream) {
1123     /* don't wait for the flush to complete */
1124     if ((o = pa_stream_flush (pbuf->stream, NULL, pbuf)))
1125       pa_operation_unref (o);
1126   }
1127   pa_threaded_mainloop_unlock (mainloop);
1128 }
1129
1130 /* called from pulse with the mainloop lock */
1131 static void
1132 mainloop_enter_defer_cb (pa_mainloop_api * api, void *userdata)
1133 {
1134   GstPulseSink *pulsesink = GST_PULSESINK (userdata);
1135   GstMessage *message;
1136   GValue val = { 0 };
1137
1138   g_value_init (&val, G_TYPE_POINTER);
1139   g_value_set_pointer (&val, g_thread_self ());
1140
1141   GST_DEBUG_OBJECT (pulsesink, "posting ENTER stream status");
1142   message = gst_message_new_stream_status (GST_OBJECT (pulsesink),
1143       GST_STREAM_STATUS_TYPE_ENTER, GST_ELEMENT (pulsesink));
1144   gst_message_set_stream_status_object (message, &val);
1145
1146   gst_element_post_message (GST_ELEMENT (pulsesink), message);
1147
1148   g_return_if_fail (pulsesink->defer_pending);
1149   pulsesink->defer_pending--;
1150   pa_threaded_mainloop_signal (mainloop, 0);
1151 }
1152
1153 /* start/resume playback ASAP, we don't uncork here but in the commit method */
1154 static gboolean
1155 gst_pulseringbuffer_start (GstRingBuffer * buf)
1156 {
1157   GstPulseSink *psink;
1158   GstPulseRingBuffer *pbuf;
1159
1160   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1161   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1162
1163   pa_threaded_mainloop_lock (mainloop);
1164
1165   GST_DEBUG_OBJECT (psink, "scheduling stream status");
1166   psink->defer_pending++;
1167   pa_mainloop_api_once (pa_threaded_mainloop_get_api (mainloop),
1168       mainloop_enter_defer_cb, psink);
1169
1170   GST_DEBUG_OBJECT (psink, "starting");
1171   pbuf->paused = FALSE;
1172
1173   /* EOS needs running clock */
1174   if (GST_BASE_SINK_CAST (psink)->eos ||
1175       g_atomic_int_get (&GST_BASE_AUDIO_SINK (psink)->abidata.
1176           ABI.eos_rendering))
1177     gst_pulsering_set_corked (pbuf, FALSE, FALSE);
1178
1179   pa_threaded_mainloop_unlock (mainloop);
1180
1181   return TRUE;
1182 }
1183
1184 /* pause/stop playback ASAP */
1185 static gboolean
1186 gst_pulseringbuffer_pause (GstRingBuffer * buf)
1187 {
1188   GstPulseSink *psink;
1189   GstPulseRingBuffer *pbuf;
1190   gboolean res;
1191
1192   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1193   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1194
1195   pa_threaded_mainloop_lock (mainloop);
1196   GST_DEBUG_OBJECT (psink, "pausing and corking");
1197   /* make sure the commit method stops writing */
1198   pbuf->paused = TRUE;
1199   res = gst_pulsering_set_corked (pbuf, TRUE, TRUE);
1200   if (pbuf->in_commit) {
1201     /* we are waiting in a commit, signal */
1202     GST_DEBUG_OBJECT (psink, "signal commit");
1203     pa_threaded_mainloop_signal (mainloop, 0);
1204   }
1205   pa_threaded_mainloop_unlock (mainloop);
1206
1207   return res;
1208 }
1209
1210 /* called from pulse with the mainloop lock */
1211 static void
1212 mainloop_leave_defer_cb (pa_mainloop_api * api, void *userdata)
1213 {
1214   GstPulseSink *pulsesink = GST_PULSESINK (userdata);
1215   GstMessage *message;
1216   GValue val = { 0 };
1217
1218   g_value_init (&val, G_TYPE_POINTER);
1219   g_value_set_pointer (&val, g_thread_self ());
1220
1221   GST_DEBUG_OBJECT (pulsesink, "posting LEAVE stream status");
1222   message = gst_message_new_stream_status (GST_OBJECT (pulsesink),
1223       GST_STREAM_STATUS_TYPE_LEAVE, GST_ELEMENT (pulsesink));
1224   gst_message_set_stream_status_object (message, &val);
1225   gst_element_post_message (GST_ELEMENT (pulsesink), message);
1226
1227   g_return_if_fail (pulsesink->defer_pending);
1228   pulsesink->defer_pending--;
1229   pa_threaded_mainloop_signal (mainloop, 0);
1230 }
1231
1232 /* stop playback, we flush everything. */
1233 static gboolean
1234 gst_pulseringbuffer_stop (GstRingBuffer * buf)
1235 {
1236   GstPulseSink *psink;
1237   GstPulseRingBuffer *pbuf;
1238   gboolean res = FALSE;
1239   pa_operation *o = NULL;
1240
1241   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1242   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1243
1244   pa_threaded_mainloop_lock (mainloop);
1245
1246   pbuf->paused = TRUE;
1247   res = gst_pulsering_set_corked (pbuf, TRUE, TRUE);
1248
1249   /* Inform anyone waiting in _commit() call that it shall wakeup */
1250   if (pbuf->in_commit) {
1251     GST_DEBUG_OBJECT (psink, "signal commit thread");
1252     pa_threaded_mainloop_signal (mainloop, 0);
1253   }
1254 #ifdef HAVE_PULSE_1_0
1255   if (g_atomic_int_get (&psink->format_lost)) {
1256     /* Don't try to flush, the stream's probably gone by now */
1257     res = TRUE;
1258     goto cleanup;
1259   }
1260 #endif
1261
1262   /* then try to flush, it's not fatal when this fails */
1263   GST_DEBUG_OBJECT (psink, "flushing");
1264   if ((o = pa_stream_flush (pbuf->stream, gst_pulsering_success_cb, pbuf))) {
1265     while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
1266       GST_DEBUG_OBJECT (psink, "wait for completion");
1267       pa_threaded_mainloop_wait (mainloop);
1268       if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1269         goto server_dead;
1270     }
1271     GST_DEBUG_OBJECT (psink, "flush completed");
1272   }
1273   res = TRUE;
1274
1275 cleanup:
1276   if (o) {
1277     pa_operation_cancel (o);
1278     pa_operation_unref (o);
1279   }
1280
1281   GST_DEBUG_OBJECT (psink, "scheduling stream status");
1282   psink->defer_pending++;
1283   pa_mainloop_api_once (pa_threaded_mainloop_get_api (mainloop),
1284       mainloop_leave_defer_cb, psink);
1285
1286   pa_threaded_mainloop_unlock (mainloop);
1287
1288   return res;
1289
1290   /* ERRORS */
1291 server_dead:
1292   {
1293     GST_DEBUG_OBJECT (psink, "the server is dead");
1294     goto cleanup;
1295   }
1296 }
1297
1298 /* in_samples >= out_samples, rate > 1.0 */
1299 #define FWD_UP_SAMPLES(s,se,d,de)               \
1300 G_STMT_START {                                  \
1301   guint8 *sb = s, *db = d;                      \
1302   while (s <= se && d < de) {                   \
1303     memcpy (d, s, bps);                         \
1304     s += bps;                                   \
1305     *accum += outr;                             \
1306     if ((*accum << 1) >= inr) {                 \
1307       *accum -= inr;                            \
1308       d += bps;                                 \
1309     }                                           \
1310   }                                             \
1311   in_samples -= (s - sb)/bps;                   \
1312   out_samples -= (d - db)/bps;                  \
1313   GST_DEBUG ("fwd_up end %d/%d",*accum,*toprocess);     \
1314 } G_STMT_END
1315
1316 /* out_samples > in_samples, for rates smaller than 1.0 */
1317 #define FWD_DOWN_SAMPLES(s,se,d,de)             \
1318 G_STMT_START {                                  \
1319   guint8 *sb = s, *db = d;                      \
1320   while (s <= se && d < de) {                   \
1321     memcpy (d, s, bps);                         \
1322     d += bps;                                   \
1323     *accum += inr;                              \
1324     if ((*accum << 1) >= outr) {                \
1325       *accum -= outr;                           \
1326       s += bps;                                 \
1327     }                                           \
1328   }                                             \
1329   in_samples -= (s - sb)/bps;                   \
1330   out_samples -= (d - db)/bps;                  \
1331   GST_DEBUG ("fwd_down end %d/%d",*accum,*toprocess);   \
1332 } G_STMT_END
1333
1334 #define REV_UP_SAMPLES(s,se,d,de)               \
1335 G_STMT_START {                                  \
1336   guint8 *sb = se, *db = d;                     \
1337   while (s <= se && d < de) {                   \
1338     memcpy (d, se, bps);                        \
1339     se -= bps;                                  \
1340     *accum += outr;                             \
1341     while (d < de && (*accum << 1) >= inr) {    \
1342       *accum -= inr;                            \
1343       d += bps;                                 \
1344     }                                           \
1345   }                                             \
1346   in_samples -= (sb - se)/bps;                  \
1347   out_samples -= (d - db)/bps;                  \
1348   GST_DEBUG ("rev_up end %d/%d",*accum,*toprocess);     \
1349 } G_STMT_END
1350
1351 #define REV_DOWN_SAMPLES(s,se,d,de)             \
1352 G_STMT_START {                                  \
1353   guint8 *sb = se, *db = d;                     \
1354   while (s <= se && d < de) {                   \
1355     memcpy (d, se, bps);                        \
1356     d += bps;                                   \
1357     *accum += inr;                              \
1358     while (s <= se && (*accum << 1) >= outr) {  \
1359       *accum -= outr;                           \
1360       se -= bps;                                \
1361     }                                           \
1362   }                                             \
1363   in_samples -= (sb - se)/bps;                  \
1364   out_samples -= (d - db)/bps;                  \
1365   GST_DEBUG ("rev_down end %d/%d",*accum,*toprocess);   \
1366 } G_STMT_END
1367
1368 /* our custom commit function because we write into the buffer of pulseaudio
1369  * instead of keeping our own buffer */
1370 static guint
1371 gst_pulseringbuffer_commit (GstRingBuffer * buf, guint64 * sample,
1372     guchar * data, gint in_samples, gint out_samples, gint * accum)
1373 {
1374   GstPulseSink *psink;
1375   GstPulseRingBuffer *pbuf;
1376   guint result;
1377   guint8 *data_end;
1378   gboolean reverse;
1379   gint *toprocess;
1380   gint inr, outr, bps;
1381   gint64 offset;
1382   guint bufsize;
1383
1384   pbuf = GST_PULSERING_BUFFER_CAST (buf);
1385   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1386
1387   /* FIXME post message rather than using a signal (as mixer interface) */
1388   if (g_atomic_int_compare_and_exchange (&psink->notify, 1, 0)) {
1389     g_object_notify (G_OBJECT (psink), "volume");
1390     g_object_notify (G_OBJECT (psink), "mute");
1391   }
1392
1393   /* make sure the ringbuffer is started */
1394   if (G_UNLIKELY (g_atomic_int_get (&buf->state) !=
1395           GST_RING_BUFFER_STATE_STARTED)) {
1396     /* see if we are allowed to start it */
1397     if (G_UNLIKELY (g_atomic_int_get (&buf->abidata.ABI.may_start) == FALSE))
1398       goto no_start;
1399
1400     GST_DEBUG_OBJECT (buf, "start!");
1401     if (!gst_ring_buffer_start (buf))
1402       goto start_failed;
1403   }
1404
1405   pa_threaded_mainloop_lock (mainloop);
1406
1407   GST_DEBUG_OBJECT (psink, "entering commit");
1408   pbuf->in_commit = TRUE;
1409
1410   bps = buf->spec.bytes_per_sample;
1411   bufsize = buf->spec.segsize * buf->spec.segtotal;
1412
1413   /* our toy resampler for trick modes */
1414   reverse = out_samples < 0;
1415   out_samples = ABS (out_samples);
1416
1417   if (in_samples >= out_samples)
1418     toprocess = &in_samples;
1419   else
1420     toprocess = &out_samples;
1421
1422   inr = in_samples - 1;
1423   outr = out_samples - 1;
1424
1425   GST_DEBUG_OBJECT (psink, "in %d, out %d", inr, outr);
1426
1427   /* data_end points to the last sample we have to write, not past it. This is
1428    * needed to properly handle reverse playback: it points to the last sample. */
1429   data_end = data + (bps * inr);
1430
1431 #ifdef HAVE_PULSE_1_0
1432   if (g_atomic_int_get (&psink->format_lost)) {
1433     /* Sink format changed, drop the data and hope upstream renegotiates */
1434     goto fake_done;
1435   }
1436 #endif
1437
1438   if (pbuf->paused)
1439     goto was_paused;
1440
1441   /* offset is in bytes */
1442   offset = *sample * bps;
1443
1444   while (*toprocess > 0) {
1445     size_t avail;
1446     guint towrite;
1447
1448     GST_LOG_OBJECT (psink,
1449         "need to write %d samples at offset %" G_GINT64_FORMAT, *toprocess,
1450         offset);
1451
1452     if (offset != pbuf->m_lastoffset)
1453       GST_LOG_OBJECT (psink, "discontinuity, offset is %" G_GINT64_FORMAT ", "
1454           "last offset was %" G_GINT64_FORMAT, offset, pbuf->m_lastoffset);
1455
1456     towrite = out_samples * bps;
1457
1458     /* Wait for at least segsize bytes to become available */
1459     if (towrite > buf->spec.segsize)
1460       towrite = buf->spec.segsize;
1461
1462     if ((pbuf->m_writable < towrite) || (offset != pbuf->m_lastoffset)) {
1463       /* if no room left or discontinuity in offset,
1464          we need to flush data and get a new buffer */
1465
1466       /* flush the buffer if possible */
1467       if ((pbuf->m_data != NULL) && (pbuf->m_towrite > 0)) {
1468
1469         GST_LOG_OBJECT (psink,
1470             "flushing %u samples at offset %" G_GINT64_FORMAT,
1471             (guint) pbuf->m_towrite / bps, pbuf->m_offset);
1472
1473         if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1474                 pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1475           goto write_failed;
1476         }
1477       }
1478       pbuf->m_towrite = 0;
1479       pbuf->m_offset = offset;  /* keep track of current offset */
1480
1481       /* get a buffer to write in for now on */
1482       for (;;) {
1483         pbuf->m_writable = pa_stream_writable_size (pbuf->stream);
1484
1485 #ifdef HAVE_PULSE_1_0
1486         if (g_atomic_int_get (&psink->format_lost)) {
1487           /* Sink format changed, give up and hope upstream renegotiates */
1488           goto fake_done;
1489         }
1490 #endif
1491
1492         if (pbuf->m_writable == (size_t) - 1)
1493           goto writable_size_failed;
1494
1495         pbuf->m_writable /= bps;
1496         pbuf->m_writable *= bps;        /* handle only complete samples */
1497
1498         if (pbuf->m_writable >= towrite)
1499           break;
1500
1501         /* see if we need to uncork because we have no free space */
1502         if (pbuf->corked) {
1503           if (!gst_pulsering_set_corked (pbuf, FALSE, FALSE))
1504             goto uncork_failed;
1505         }
1506
1507         /* we can't write segsize bytes, wait a bit */
1508         GST_LOG_OBJECT (psink, "waiting for free space");
1509         pa_threaded_mainloop_wait (mainloop);
1510
1511         if (pbuf->paused)
1512           goto was_paused;
1513       }
1514
1515       /* Recalculate what we can write in the next chunk */
1516       towrite = out_samples * bps;
1517       if (pbuf->m_writable > towrite)
1518         pbuf->m_writable = towrite;
1519
1520       GST_LOG_OBJECT (psink, "requesting %" G_GSIZE_FORMAT " bytes of "
1521           "shared memory", pbuf->m_writable);
1522
1523       if (pa_stream_begin_write (pbuf->stream, &pbuf->m_data,
1524               &pbuf->m_writable) < 0) {
1525         GST_LOG_OBJECT (psink, "pa_stream_begin_write() failed");
1526         goto writable_size_failed;
1527       }
1528
1529       GST_LOG_OBJECT (psink, "got %" G_GSIZE_FORMAT " bytes of shared memory",
1530           pbuf->m_writable);
1531
1532     }
1533
1534     if (towrite > pbuf->m_writable)
1535       towrite = pbuf->m_writable;
1536     avail = towrite / bps;
1537
1538     GST_LOG_OBJECT (psink, "writing %u samples at offset %" G_GUINT64_FORMAT,
1539         (guint) avail, offset);
1540
1541 #ifdef HAVE_PULSE_1_0
1542     /* No trick modes for passthrough streams */
1543     if (G_UNLIKELY (!pbuf->is_pcm && (inr != outr || reverse))) {
1544       GST_WARNING_OBJECT (psink, "Passthrough stream can't run in trick mode");
1545       goto unlock_and_fail;
1546     }
1547 #endif
1548
1549     if (G_LIKELY (inr == outr && !reverse)) {
1550       /* no rate conversion, simply write out the samples */
1551       /* copy the data into internal buffer */
1552
1553       memcpy ((guint8 *) pbuf->m_data + pbuf->m_towrite, data, towrite);
1554       pbuf->m_towrite += towrite;
1555       pbuf->m_writable -= towrite;
1556
1557       data += towrite;
1558       in_samples -= avail;
1559       out_samples -= avail;
1560     } else {
1561       guint8 *dest, *d, *d_end;
1562
1563       /* write into the PulseAudio shm buffer */
1564       dest = d = (guint8 *) pbuf->m_data + pbuf->m_towrite;
1565       d_end = d + towrite;
1566
1567       if (!reverse) {
1568         if (inr >= outr)
1569           /* forward speed up */
1570           FWD_UP_SAMPLES (data, data_end, d, d_end);
1571         else
1572           /* forward slow down */
1573           FWD_DOWN_SAMPLES (data, data_end, d, d_end);
1574       } else {
1575         if (inr >= outr)
1576           /* reverse speed up */
1577           REV_UP_SAMPLES (data, data_end, d, d_end);
1578         else
1579           /* reverse slow down */
1580           REV_DOWN_SAMPLES (data, data_end, d, d_end);
1581       }
1582       /* see what we have left to write */
1583       towrite = (d - dest);
1584       pbuf->m_towrite += towrite;
1585       pbuf->m_writable -= towrite;
1586
1587       avail = towrite / bps;
1588     }
1589
1590     /* flush the buffer if it's full */
1591     if ((pbuf->m_data != NULL) && (pbuf->m_towrite > 0)
1592         && (pbuf->m_writable == 0)) {
1593       GST_LOG_OBJECT (psink, "flushing %u samples at offset %" G_GINT64_FORMAT,
1594           (guint) pbuf->m_towrite / bps, pbuf->m_offset);
1595
1596       if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1597               pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1598         goto write_failed;
1599       }
1600       pbuf->m_towrite = 0;
1601       pbuf->m_offset = offset + towrite;        /* keep track of current offset */
1602     }
1603
1604     *sample += avail;
1605     offset += avail * bps;
1606     pbuf->m_lastoffset = offset;
1607
1608     /* check if we need to uncork after writing the samples */
1609     if (pbuf->corked) {
1610       const pa_timing_info *info;
1611
1612       if ((info = pa_stream_get_timing_info (pbuf->stream))) {
1613         GST_LOG_OBJECT (psink,
1614             "read_index at %" G_GUINT64_FORMAT ", offset %" G_GINT64_FORMAT,
1615             info->read_index, offset);
1616
1617         /* we uncork when the read_index is too far behind the offset we need
1618          * to write to. */
1619         if (info->read_index + bufsize <= offset) {
1620           if (!gst_pulsering_set_corked (pbuf, FALSE, FALSE))
1621             goto uncork_failed;
1622         }
1623       } else {
1624         GST_LOG_OBJECT (psink, "no timing info available yet");
1625       }
1626     }
1627   }
1628
1629 #ifdef HAVE_PULSE_1_0
1630 fake_done:
1631 #endif
1632   /* we consumed all samples here */
1633   data = data_end + bps;
1634
1635   pbuf->in_commit = FALSE;
1636   pa_threaded_mainloop_unlock (mainloop);
1637
1638 done:
1639   result = inr - ((data_end - data) / bps);
1640   GST_LOG_OBJECT (psink, "wrote %d samples", result);
1641
1642   return result;
1643
1644   /* ERRORS */
1645 unlock_and_fail:
1646   {
1647     pbuf->in_commit = FALSE;
1648     GST_LOG_OBJECT (psink, "we are reset");
1649     pa_threaded_mainloop_unlock (mainloop);
1650     goto done;
1651   }
1652 no_start:
1653   {
1654     GST_LOG_OBJECT (psink, "we can not start");
1655     return 0;
1656   }
1657 start_failed:
1658   {
1659     GST_LOG_OBJECT (psink, "failed to start the ringbuffer");
1660     return 0;
1661   }
1662 uncork_failed:
1663   {
1664     pbuf->in_commit = FALSE;
1665     GST_ERROR_OBJECT (psink, "uncork failed");
1666     pa_threaded_mainloop_unlock (mainloop);
1667     goto done;
1668   }
1669 was_paused:
1670   {
1671     pbuf->in_commit = FALSE;
1672     GST_LOG_OBJECT (psink, "we are paused");
1673     pa_threaded_mainloop_unlock (mainloop);
1674     goto done;
1675   }
1676 writable_size_failed:
1677   {
1678     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1679         ("pa_stream_writable_size() failed: %s",
1680             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1681     goto unlock_and_fail;
1682   }
1683 write_failed:
1684   {
1685     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1686         ("pa_stream_write() failed: %s",
1687             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1688     goto unlock_and_fail;
1689   }
1690 }
1691
1692 /* write pending local samples, must be called with the mainloop lock */
1693 static void
1694 gst_pulsering_flush (GstPulseRingBuffer * pbuf)
1695 {
1696   GstPulseSink *psink;
1697
1698   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1699   GST_DEBUG_OBJECT (psink, "entering flush");
1700
1701   /* flush the buffer if possible */
1702   if (pbuf->stream && (pbuf->m_data != NULL) && (pbuf->m_towrite > 0)) {
1703 #ifndef GST_DISABLE_GST_DEBUG
1704     gint bps;
1705
1706     bps = (GST_RING_BUFFER_CAST (pbuf))->spec.bytes_per_sample;
1707     GST_LOG_OBJECT (psink,
1708         "flushing %u samples at offset %" G_GINT64_FORMAT,
1709         (guint) pbuf->m_towrite / bps, pbuf->m_offset);
1710 #endif
1711
1712     if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1713             pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1714       goto write_failed;
1715     }
1716
1717     pbuf->m_towrite = 0;
1718     pbuf->m_offset += pbuf->m_towrite;  /* keep track of current offset */
1719   }
1720
1721 done:
1722   return;
1723
1724   /* ERRORS */
1725 write_failed:
1726   {
1727     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1728         ("pa_stream_write() failed: %s",
1729             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1730     goto done;
1731   }
1732 }
1733
1734 static void gst_pulsesink_set_property (GObject * object, guint prop_id,
1735     const GValue * value, GParamSpec * pspec);
1736 static void gst_pulsesink_get_property (GObject * object, guint prop_id,
1737     GValue * value, GParamSpec * pspec);
1738 static void gst_pulsesink_finalize (GObject * object);
1739
1740 static gboolean gst_pulsesink_event (GstBaseSink * sink, GstEvent * event);
1741
1742 static GstStateChangeReturn gst_pulsesink_change_state (GstElement * element,
1743     GstStateChange transition);
1744
1745 static void gst_pulsesink_init_interfaces (GType type);
1746
1747 GST_IMPLEMENT_PULSEPROBE_METHODS (GstPulseSink, gst_pulsesink);
1748
1749 #define _do_init(type) \
1750   gst_pulsesink_init_contexts (); \
1751   gst_pulsesink_init_interfaces (type);
1752
1753 GST_BOILERPLATE_FULL (GstPulseSink, gst_pulsesink, GstBaseAudioSink,
1754     GST_TYPE_BASE_AUDIO_SINK, _do_init);
1755
1756 static gboolean
1757 gst_pulsesink_interface_supported (GstImplementsInterface *
1758     iface, GType interface_type)
1759 {
1760   GstPulseSink *this = GST_PULSESINK_CAST (iface);
1761
1762   if (interface_type == GST_TYPE_PROPERTY_PROBE && this->probe)
1763     return TRUE;
1764   if (interface_type == GST_TYPE_STREAM_VOLUME)
1765     return TRUE;
1766
1767   return FALSE;
1768 }
1769
1770 static void
1771 gst_pulsesink_implements_interface_init (GstImplementsInterfaceClass * klass)
1772 {
1773   klass->supported = gst_pulsesink_interface_supported;
1774 }
1775
1776 static void
1777 gst_pulsesink_init_interfaces (GType type)
1778 {
1779   static const GInterfaceInfo implements_iface_info = {
1780     (GInterfaceInitFunc) gst_pulsesink_implements_interface_init,
1781     NULL,
1782     NULL,
1783   };
1784   static const GInterfaceInfo probe_iface_info = {
1785     (GInterfaceInitFunc) gst_pulsesink_property_probe_interface_init,
1786     NULL,
1787     NULL,
1788   };
1789   static const GInterfaceInfo svol_iface_info = {
1790     NULL, NULL, NULL
1791   };
1792
1793   g_type_add_interface_static (type, GST_TYPE_STREAM_VOLUME, &svol_iface_info);
1794   g_type_add_interface_static (type, GST_TYPE_IMPLEMENTS_INTERFACE,
1795       &implements_iface_info);
1796   g_type_add_interface_static (type, GST_TYPE_PROPERTY_PROBE,
1797       &probe_iface_info);
1798 }
1799
1800 static void
1801 gst_pulsesink_base_init (gpointer g_class)
1802 {
1803   static GstStaticPadTemplate pad_template = GST_STATIC_PAD_TEMPLATE ("sink",
1804       GST_PAD_SINK,
1805       GST_PAD_ALWAYS,
1806       GST_STATIC_CAPS (PULSE_SINK_TEMPLATE_CAPS));
1807
1808   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
1809
1810   gst_element_class_set_details_simple (element_class,
1811       "PulseAudio Audio Sink",
1812       "Sink/Audio", "Plays audio to a PulseAudio server", "Lennart Poettering");
1813   gst_element_class_add_pad_template (element_class,
1814       gst_static_pad_template_get (&pad_template));
1815 }
1816
1817 static GstRingBuffer *
1818 gst_pulsesink_create_ringbuffer (GstBaseAudioSink * sink)
1819 {
1820   GstRingBuffer *buffer;
1821
1822   GST_DEBUG_OBJECT (sink, "creating ringbuffer");
1823   buffer = g_object_new (GST_TYPE_PULSERING_BUFFER, NULL);
1824   GST_DEBUG_OBJECT (sink, "created ringbuffer @%p", buffer);
1825
1826   return buffer;
1827 }
1828
1829 static GstBuffer *
1830 gst_pulsesink_payload (GstBaseAudioSink * sink, GstBuffer * buf)
1831 {
1832   switch (sink->ringbuffer->spec.type) {
1833     case GST_BUFTYPE_AC3:
1834     case GST_BUFTYPE_EAC3:
1835     case GST_BUFTYPE_DTS:
1836     case GST_BUFTYPE_MPEG:
1837     {
1838       /* FIXME: alloc memory from PA if possible */
1839       gint framesize = gst_audio_iec61937_frame_size (&sink->ringbuffer->spec);
1840       GstBuffer *out;
1841
1842       if (framesize <= 0)
1843         return NULL;
1844
1845       out = gst_buffer_new_and_alloc (framesize);
1846
1847       if (!gst_audio_iec61937_payload (GST_BUFFER_DATA (buf),
1848               GST_BUFFER_SIZE (buf), GST_BUFFER_DATA (out),
1849               GST_BUFFER_SIZE (out), &sink->ringbuffer->spec)) {
1850         gst_buffer_unref (out);
1851         return NULL;
1852       }
1853
1854       gst_buffer_copy_metadata (out, buf, GST_BUFFER_COPY_ALL);
1855       return out;
1856     }
1857
1858     default:
1859       return gst_buffer_ref (buf);
1860   }
1861 }
1862
1863 static void
1864 gst_pulsesink_class_init (GstPulseSinkClass * klass)
1865 {
1866   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
1867   GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
1868   GstBaseSinkClass *bc;
1869   GstBaseAudioSinkClass *gstaudiosink_class = GST_BASE_AUDIO_SINK_CLASS (klass);
1870   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
1871
1872   gobject_class->finalize = gst_pulsesink_finalize;
1873   gobject_class->set_property = gst_pulsesink_set_property;
1874   gobject_class->get_property = gst_pulsesink_get_property;
1875
1876   gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_pulsesink_event);
1877
1878   /* restore the original basesink pull methods */
1879   bc = g_type_class_peek (GST_TYPE_BASE_SINK);
1880   gstbasesink_class->activate_pull = GST_DEBUG_FUNCPTR (bc->activate_pull);
1881
1882   gstelement_class->change_state =
1883       GST_DEBUG_FUNCPTR (gst_pulsesink_change_state);
1884
1885   gstaudiosink_class->create_ringbuffer =
1886       GST_DEBUG_FUNCPTR (gst_pulsesink_create_ringbuffer);
1887   gstaudiosink_class->payload = GST_DEBUG_FUNCPTR (gst_pulsesink_payload);
1888
1889   /* Overwrite GObject fields */
1890   g_object_class_install_property (gobject_class,
1891       PROP_SERVER,
1892       g_param_spec_string ("server", "Server",
1893           "The PulseAudio server to connect to", DEFAULT_SERVER,
1894           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1895
1896   g_object_class_install_property (gobject_class, PROP_DEVICE,
1897       g_param_spec_string ("device", "Device",
1898           "The PulseAudio sink device to connect to", DEFAULT_DEVICE,
1899           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1900
1901   g_object_class_install_property (gobject_class,
1902       PROP_DEVICE_NAME,
1903       g_param_spec_string ("device-name", "Device name",
1904           "Human-readable name of the sound device", DEFAULT_DEVICE_NAME,
1905           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1906
1907   g_object_class_install_property (gobject_class,
1908       PROP_VOLUME,
1909       g_param_spec_double ("volume", "Volume",
1910           "Linear volume of this stream, 1.0=100%", 0.0, MAX_VOLUME,
1911           DEFAULT_VOLUME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1912   g_object_class_install_property (gobject_class,
1913       PROP_MUTE,
1914       g_param_spec_boolean ("mute", "Mute",
1915           "Mute state of this stream", DEFAULT_MUTE,
1916           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1917
1918   /**
1919    * GstPulseSink:client
1920    *
1921    * The PulseAudio client name to use.
1922    *
1923    * Since: 0.10.25
1924    */
1925   g_object_class_install_property (gobject_class,
1926       PROP_CLIENT,
1927       g_param_spec_string ("client", "Client",
1928           "The PulseAudio client name to use", gst_pulse_client_name (),
1929           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
1930           GST_PARAM_MUTABLE_READY));
1931
1932   /**
1933    * GstPulseSink:stream-properties
1934    *
1935    * List of pulseaudio stream properties. A list of defined properties can be
1936    * found in the <ulink url="http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html">pulseaudio api docs</ulink>.
1937    *
1938    * Below is an example for registering as a music application to pulseaudio.
1939    * |[
1940    * GstStructure *props;
1941    *
1942    * props = gst_structure_from_string ("props,media.role=music", NULL);
1943    * g_object_set (pulse, "stream-properties", props, NULL);
1944    * gst_structure_free
1945    * ]|
1946    *
1947    * Since: 0.10.26
1948    */
1949   g_object_class_install_property (gobject_class,
1950       PROP_STREAM_PROPERTIES,
1951       g_param_spec_boxed ("stream-properties", "stream properties",
1952           "list of pulseaudio stream properties",
1953           GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1954 }
1955
1956 /* returns the current time of the sink ringbuffer */
1957 static GstClockTime
1958 gst_pulsesink_get_time (GstClock * clock, GstBaseAudioSink * sink)
1959 {
1960   GstPulseSink *psink;
1961   GstPulseRingBuffer *pbuf;
1962   pa_usec_t time;
1963
1964   if (!sink->ringbuffer || !sink->ringbuffer->acquired)
1965     return GST_CLOCK_TIME_NONE;
1966
1967   pbuf = GST_PULSERING_BUFFER_CAST (sink->ringbuffer);
1968   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1969
1970 #ifdef HAVE_PULSE_1_0
1971   if (g_atomic_int_get (&psink->format_lost)) {
1972     /* Stream was lost in a format change, it'll get set up again once
1973      * upstream renegotiates */
1974     return psink->format_lost_time;
1975   }
1976 #endif
1977
1978   pa_threaded_mainloop_lock (mainloop);
1979   if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1980     goto server_dead;
1981
1982   /* if we don't have enough data to get a timestamp, just return NONE, which
1983    * will return the last reported time */
1984   if (pa_stream_get_time (pbuf->stream, &time) < 0) {
1985     GST_DEBUG_OBJECT (psink, "could not get time");
1986     time = GST_CLOCK_TIME_NONE;
1987   } else
1988     time *= 1000;
1989   pa_threaded_mainloop_unlock (mainloop);
1990
1991   GST_LOG_OBJECT (psink, "current time is %" GST_TIME_FORMAT,
1992       GST_TIME_ARGS (time));
1993
1994   return time;
1995
1996   /* ERRORS */
1997 server_dead:
1998   {
1999     GST_DEBUG_OBJECT (psink, "the server is dead");
2000     pa_threaded_mainloop_unlock (mainloop);
2001
2002     return GST_CLOCK_TIME_NONE;
2003   }
2004 }
2005
2006 static void
2007 gst_pulsesink_sink_info_cb (pa_context * c, const pa_sink_info * i, int eol,
2008     void *userdata)
2009 {
2010   GstPulseRingBuffer *pbuf;
2011   GstPulseSink *psink;
2012 #ifdef HAVE_PULSE_1_0
2013   GList *l;
2014   guint8 j;
2015 #endif
2016
2017   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
2018   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
2019
2020   if (!i)
2021     goto done;
2022
2023   g_free (psink->device_description);
2024   psink->device_description = g_strdup (i->description);
2025
2026 #ifdef HAVE_PULSE_1_0
2027   g_mutex_lock (psink->sink_formats_lock);
2028
2029   for (l = g_list_first (psink->sink_formats); l; l = g_list_next (l))
2030     pa_format_info_free ((pa_format_info *) l->data);
2031
2032   g_list_free (psink->sink_formats);
2033   psink->sink_formats = NULL;
2034
2035   for (j = 0; j < i->n_formats; j++)
2036     psink->sink_formats = g_list_prepend (psink->sink_formats,
2037         pa_format_info_copy (i->formats[j]));
2038
2039   g_mutex_unlock (psink->sink_formats_lock);
2040 #endif
2041
2042 done:
2043   pa_threaded_mainloop_signal (mainloop, 0);
2044 }
2045
2046 #ifdef HAVE_PULSE_1_0
2047 /* NOTE: If you're making changes here, see if pulseaudiosink acceptcaps also
2048  * needs to be changed accordingly. */
2049 static gboolean
2050 gst_pulsesink_pad_acceptcaps (GstPad * pad, GstCaps * caps)
2051 {
2052   GstPulseSink *psink = GST_PULSESINK (gst_pad_get_parent_element (pad));
2053   GstPulseRingBuffer *pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK
2054       (psink)->ringbuffer);
2055   GstCaps *pad_caps;
2056   GstStructure *st;
2057   gboolean ret = FALSE;
2058
2059   GstRingBufferSpec spec = { 0 };
2060   pa_stream *stream = NULL;
2061   pa_operation *o = NULL;
2062   pa_channel_map channel_map;
2063   pa_stream_flags_t flags;
2064   pa_format_info *format = NULL, *formats[1];
2065   guint channels;
2066
2067   pad_caps = gst_pad_get_caps_reffed (pad);
2068   if (pad_caps) {
2069     ret = gst_caps_can_intersect (pad_caps, caps);
2070     gst_caps_unref (pad_caps);
2071   }
2072
2073   /* Either template caps didn't match, or we're still in NULL state */
2074   if (!ret || !pbuf->context)
2075     goto done;
2076
2077   /* If we've not got fixed caps, creating a stream might fail, so let's just
2078    * return from here with default acceptcaps behaviour */
2079   if (!gst_caps_is_fixed (caps))
2080     goto done;
2081
2082   ret = FALSE;
2083
2084   pa_threaded_mainloop_lock (mainloop);
2085
2086   spec.latency_time = GST_BASE_AUDIO_SINK (psink)->latency_time;
2087   if (!gst_ring_buffer_parse_caps (&spec, caps))
2088     goto out;
2089
2090   if (!gst_pulse_fill_format_info (&spec, &format, &channels))
2091     goto out;
2092
2093   /* Make sure input is framed (one frame per buffer) and can be payloaded */
2094   if (!pa_format_info_is_pcm (format)) {
2095     gboolean framed = FALSE, parsed = FALSE;
2096     st = gst_caps_get_structure (caps, 0);
2097
2098     gst_structure_get_boolean (st, "framed", &framed);
2099     gst_structure_get_boolean (st, "parsed", &parsed);
2100     if ((!framed && !parsed) || gst_audio_iec61937_frame_size (&spec) <= 0)
2101       goto out;
2102   }
2103
2104   /* initialize the channel map */
2105   if (pa_format_info_is_pcm (format) &&
2106       gst_pulse_gst_to_channel_map (&channel_map, &spec))
2107     pa_format_info_set_channel_map (format, &channel_map);
2108
2109   if (pbuf->stream) {
2110     /* We're already in PAUSED or above, so just reuse this stream to query
2111      * sink formats and use those. */
2112     GList *i;
2113
2114     if (!(o = pa_context_get_sink_info_by_name (pbuf->context, psink->device,
2115                 gst_pulsesink_sink_info_cb, pbuf)))
2116       goto info_failed;
2117
2118     while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2119       pa_threaded_mainloop_wait (mainloop);
2120       if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2121         goto out;
2122     }
2123
2124     g_mutex_lock (psink->sink_formats_lock);
2125     for (i = g_list_first (psink->sink_formats); i; i = g_list_next (i)) {
2126       if (pa_format_info_is_compatible ((pa_format_info *) i->data, format)) {
2127         ret = TRUE;
2128         break;
2129       }
2130     }
2131     g_mutex_unlock (psink->sink_formats_lock);
2132   } else {
2133     /* We're in READY, let's connect a stream to see if the format is
2134      * accpeted by whatever sink we're routed to */
2135     formats[0] = format;
2136
2137     if (!(stream = pa_stream_new_extended (pbuf->context, "pulsesink probe",
2138                 formats, 1, psink->proplist)))
2139       goto out;
2140
2141     /* construct the flags */
2142     flags = PA_STREAM_INTERPOLATE_TIMING | PA_STREAM_AUTO_TIMING_UPDATE |
2143         PA_STREAM_ADJUST_LATENCY | PA_STREAM_START_CORKED;
2144
2145     pa_stream_set_state_callback (stream, gst_pulsering_stream_state_cb, pbuf);
2146
2147     if (pa_stream_connect_playback (stream, psink->device, NULL, flags, NULL,
2148             NULL) < 0)
2149       goto out;
2150
2151     ret = gst_pulsering_wait_for_stream_ready (psink, stream);
2152   }
2153
2154 out:
2155   if (format)
2156     pa_format_info_free (format);
2157
2158   if (o)
2159     pa_operation_unref (o);
2160
2161   if (stream) {
2162     pa_stream_set_state_callback (stream, NULL, NULL);
2163     pa_stream_disconnect (stream);
2164     pa_stream_unref (stream);
2165   }
2166
2167   pa_threaded_mainloop_unlock (mainloop);
2168
2169 done:
2170   gst_object_unref (psink);
2171   return ret;
2172
2173 info_failed:
2174   {
2175     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2176         ("pa_context_get_sink_input_info() failed: %s",
2177             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2178     goto out;
2179   }
2180 }
2181 #endif
2182
2183 static void
2184 gst_pulsesink_init (GstPulseSink * pulsesink, GstPulseSinkClass * klass)
2185 {
2186   pulsesink->server = NULL;
2187   pulsesink->device = NULL;
2188   pulsesink->device_description = NULL;
2189   pulsesink->client_name = gst_pulse_client_name ();
2190
2191 #ifdef HAVE_PULSE_1_0
2192   pulsesink->sink_formats_lock = g_mutex_new ();
2193   pulsesink->sink_formats = NULL;
2194 #endif
2195
2196   pulsesink->volume = DEFAULT_VOLUME;
2197   pulsesink->volume_set = FALSE;
2198
2199   pulsesink->mute = DEFAULT_MUTE;
2200   pulsesink->mute_set = FALSE;
2201
2202   pulsesink->notify = 0;
2203
2204 #ifdef HAVE_PULSE_1_0
2205   g_atomic_int_set (&pulsesink->format_lost, FALSE);
2206   pulsesink->format_lost_time = GST_CLOCK_TIME_NONE;
2207 #endif
2208
2209   pulsesink->properties = NULL;
2210   pulsesink->proplist = NULL;
2211
2212   /* override with a custom clock */
2213   if (GST_BASE_AUDIO_SINK (pulsesink)->provided_clock)
2214     gst_object_unref (GST_BASE_AUDIO_SINK (pulsesink)->provided_clock);
2215
2216   GST_BASE_AUDIO_SINK (pulsesink)->provided_clock =
2217       gst_audio_clock_new ("GstPulseSinkClock",
2218       (GstAudioClockGetTimeFunc) gst_pulsesink_get_time, pulsesink);
2219
2220 #ifdef HAVE_PULSE_1_0
2221   gst_pad_set_acceptcaps_function (GST_BASE_SINK (pulsesink)->sinkpad,
2222       GST_DEBUG_FUNCPTR (gst_pulsesink_pad_acceptcaps));
2223 #endif
2224
2225   /* TRUE for sinks, FALSE for sources */
2226   pulsesink->probe = gst_pulseprobe_new (G_OBJECT (pulsesink),
2227       G_OBJECT_GET_CLASS (pulsesink), PROP_DEVICE, pulsesink->device,
2228       TRUE, FALSE);
2229 }
2230
2231 static void
2232 gst_pulsesink_finalize (GObject * object)
2233 {
2234   GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2235 #ifdef HAVE_PULSE_1_0
2236   GList *i;
2237 #endif
2238
2239   g_free (pulsesink->server);
2240   g_free (pulsesink->device);
2241   g_free (pulsesink->device_description);
2242   g_free (pulsesink->client_name);
2243
2244 #ifdef HAVE_PULSE_1_0
2245   for (i = g_list_first (pulsesink->sink_formats); i; i = g_list_next (i))
2246     pa_format_info_free ((pa_format_info *) i->data);
2247
2248   g_list_free (pulsesink->sink_formats);
2249   g_mutex_free (pulsesink->sink_formats_lock);
2250 #endif
2251
2252   if (pulsesink->properties)
2253     gst_structure_free (pulsesink->properties);
2254   if (pulsesink->proplist)
2255     pa_proplist_free (pulsesink->proplist);
2256
2257   if (pulsesink->probe) {
2258     gst_pulseprobe_free (pulsesink->probe);
2259     pulsesink->probe = NULL;
2260   }
2261
2262   G_OBJECT_CLASS (parent_class)->finalize (object);
2263 }
2264
2265 static void
2266 gst_pulsesink_set_volume (GstPulseSink * psink, gdouble volume)
2267 {
2268   pa_cvolume v;
2269   pa_operation *o = NULL;
2270   GstPulseRingBuffer *pbuf;
2271   uint32_t idx;
2272
2273   if (!mainloop)
2274     goto no_mainloop;
2275
2276   pa_threaded_mainloop_lock (mainloop);
2277
2278   GST_DEBUG_OBJECT (psink, "setting volume to %f", volume);
2279
2280   pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2281   if (pbuf == NULL || pbuf->stream == NULL)
2282     goto no_buffer;
2283
2284   if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2285     goto no_index;
2286
2287 #ifdef HAVE_PULSE_1_0
2288   if (pbuf->is_pcm)
2289     gst_pulse_cvolume_from_linear (&v, pbuf->channels, volume);
2290   else
2291     /* FIXME: this will eventually be superceded by checks to see if the volume
2292      * is readable/writable */
2293     goto unlock;
2294 #else
2295   gst_pulse_cvolume_from_linear (&v, pbuf->sample_spec.channels, volume);
2296 #endif
2297
2298   if (!(o = pa_context_set_sink_input_volume (pbuf->context, idx,
2299               &v, NULL, NULL)))
2300     goto volume_failed;
2301
2302   /* We don't really care about the result of this call */
2303 unlock:
2304
2305   if (o)
2306     pa_operation_unref (o);
2307
2308   pa_threaded_mainloop_unlock (mainloop);
2309
2310   return;
2311
2312   /* ERRORS */
2313 no_mainloop:
2314   {
2315     psink->volume = volume;
2316     psink->volume_set = TRUE;
2317
2318     GST_DEBUG_OBJECT (psink, "we have no mainloop");
2319     return;
2320   }
2321 no_buffer:
2322   {
2323     psink->volume = volume;
2324     psink->volume_set = TRUE;
2325
2326     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2327     goto unlock;
2328   }
2329 no_index:
2330   {
2331     GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2332     goto unlock;
2333   }
2334 volume_failed:
2335   {
2336     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2337         ("pa_stream_set_sink_input_volume() failed: %s",
2338             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2339     goto unlock;
2340   }
2341 }
2342
2343 static void
2344 gst_pulsesink_set_mute (GstPulseSink * psink, gboolean mute)
2345 {
2346   pa_operation *o = NULL;
2347   GstPulseRingBuffer *pbuf;
2348   uint32_t idx;
2349
2350   if (!mainloop)
2351     goto no_mainloop;
2352
2353   pa_threaded_mainloop_lock (mainloop);
2354
2355   GST_DEBUG_OBJECT (psink, "setting mute state to %d", mute);
2356
2357   pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2358   if (pbuf == NULL || pbuf->stream == NULL)
2359     goto no_buffer;
2360
2361   if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2362     goto no_index;
2363
2364   if (!(o = pa_context_set_sink_input_mute (pbuf->context, idx,
2365               mute, NULL, NULL)))
2366     goto mute_failed;
2367
2368   /* We don't really care about the result of this call */
2369 unlock:
2370
2371   if (o)
2372     pa_operation_unref (o);
2373
2374   pa_threaded_mainloop_unlock (mainloop);
2375
2376   return;
2377
2378   /* ERRORS */
2379 no_mainloop:
2380   {
2381     psink->mute = mute;
2382     psink->mute_set = TRUE;
2383
2384     GST_DEBUG_OBJECT (psink, "we have no mainloop");
2385     return;
2386   }
2387 no_buffer:
2388   {
2389     psink->mute = mute;
2390     psink->mute_set = TRUE;
2391
2392     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2393     goto unlock;
2394   }
2395 no_index:
2396   {
2397     GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2398     goto unlock;
2399   }
2400 mute_failed:
2401   {
2402     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2403         ("pa_stream_set_sink_input_mute() failed: %s",
2404             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2405     goto unlock;
2406   }
2407 }
2408
2409 static void
2410 gst_pulsesink_sink_input_info_cb (pa_context * c, const pa_sink_input_info * i,
2411     int eol, void *userdata)
2412 {
2413   GstPulseRingBuffer *pbuf;
2414   GstPulseSink *psink;
2415
2416   pbuf = GST_PULSERING_BUFFER_CAST (userdata);
2417   psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
2418
2419   if (!i)
2420     goto done;
2421
2422   if (!pbuf->stream)
2423     goto done;
2424
2425   /* If the index doesn't match our current stream,
2426    * it implies we just recreated the stream (caps change)
2427    */
2428   if (i->index == pa_stream_get_index (pbuf->stream)) {
2429     psink->volume = pa_sw_volume_to_linear (pa_cvolume_max (&i->volume));
2430     psink->mute = i->mute;
2431   }
2432
2433 done:
2434   pa_threaded_mainloop_signal (mainloop, 0);
2435 }
2436
2437 static gdouble
2438 gst_pulsesink_get_volume (GstPulseSink * psink)
2439 {
2440   GstPulseRingBuffer *pbuf;
2441   pa_operation *o = NULL;
2442   gdouble v = DEFAULT_VOLUME;
2443   uint32_t idx;
2444
2445   if (!mainloop)
2446     goto no_mainloop;
2447
2448   pa_threaded_mainloop_lock (mainloop);
2449
2450   pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2451   if (pbuf == NULL || pbuf->stream == NULL)
2452     goto no_buffer;
2453
2454   if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2455     goto no_index;
2456
2457   if (!(o = pa_context_get_sink_input_info (pbuf->context, idx,
2458               gst_pulsesink_sink_input_info_cb, pbuf)))
2459     goto info_failed;
2460
2461   while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2462     pa_threaded_mainloop_wait (mainloop);
2463     if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2464       goto unlock;
2465   }
2466
2467 unlock:
2468   v = psink->volume;
2469
2470   if (o)
2471     pa_operation_unref (o);
2472
2473   pa_threaded_mainloop_unlock (mainloop);
2474
2475   if (v > MAX_VOLUME) {
2476     GST_WARNING_OBJECT (psink, "Clipped volume from %f to %f", v, MAX_VOLUME);
2477     v = MAX_VOLUME;
2478   }
2479
2480   return v;
2481
2482   /* ERRORS */
2483 no_mainloop:
2484   {
2485     v = psink->volume;
2486     GST_DEBUG_OBJECT (psink, "we have no mainloop");
2487     return v;
2488   }
2489 no_buffer:
2490   {
2491     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2492     goto unlock;
2493   }
2494 no_index:
2495   {
2496     GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2497     goto unlock;
2498   }
2499 info_failed:
2500   {
2501     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2502         ("pa_context_get_sink_input_info() failed: %s",
2503             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2504     goto unlock;
2505   }
2506 }
2507
2508 static gboolean
2509 gst_pulsesink_get_mute (GstPulseSink * psink)
2510 {
2511   GstPulseRingBuffer *pbuf;
2512   pa_operation *o = NULL;
2513   uint32_t idx;
2514   gboolean mute = FALSE;
2515
2516   if (!mainloop)
2517     goto no_mainloop;
2518
2519   pa_threaded_mainloop_lock (mainloop);
2520   mute = psink->mute;
2521
2522   pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2523   if (pbuf == NULL || pbuf->stream == NULL)
2524     goto no_buffer;
2525
2526   if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2527     goto no_index;
2528
2529   if (!(o = pa_context_get_sink_input_info (pbuf->context, idx,
2530               gst_pulsesink_sink_input_info_cb, pbuf)))
2531     goto info_failed;
2532
2533   while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2534     pa_threaded_mainloop_wait (mainloop);
2535     if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2536       goto unlock;
2537   }
2538
2539 unlock:
2540   if (o)
2541     pa_operation_unref (o);
2542
2543   pa_threaded_mainloop_unlock (mainloop);
2544
2545   return mute;
2546
2547   /* ERRORS */
2548 no_mainloop:
2549   {
2550     mute = psink->mute;
2551     GST_DEBUG_OBJECT (psink, "we have no mainloop");
2552     return mute;
2553   }
2554 no_buffer:
2555   {
2556     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2557     goto unlock;
2558   }
2559 no_index:
2560   {
2561     GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2562     goto unlock;
2563   }
2564 info_failed:
2565   {
2566     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2567         ("pa_context_get_sink_input_info() failed: %s",
2568             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2569     goto unlock;
2570   }
2571 }
2572
2573 static gchar *
2574 gst_pulsesink_device_description (GstPulseSink * psink)
2575 {
2576   GstPulseRingBuffer *pbuf;
2577   pa_operation *o = NULL;
2578   gchar *t;
2579
2580   if (!mainloop)
2581     goto no_mainloop;
2582
2583   pa_threaded_mainloop_lock (mainloop);
2584   pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2585   if (pbuf == NULL)
2586     goto no_buffer;
2587
2588   if (!(o = pa_context_get_sink_info_by_name (pbuf->context,
2589               psink->device, gst_pulsesink_sink_info_cb, pbuf)))
2590     goto info_failed;
2591
2592   while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2593     pa_threaded_mainloop_wait (mainloop);
2594     if (gst_pulsering_is_dead (psink, pbuf, FALSE))
2595       goto unlock;
2596   }
2597
2598 unlock:
2599   if (o)
2600     pa_operation_unref (o);
2601
2602   t = g_strdup (psink->device_description);
2603   pa_threaded_mainloop_unlock (mainloop);
2604
2605   return t;
2606
2607   /* ERRORS */
2608 no_mainloop:
2609   {
2610     GST_DEBUG_OBJECT (psink, "we have no mainloop");
2611     return NULL;
2612   }
2613 no_buffer:
2614   {
2615     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2616     goto unlock;
2617   }
2618 info_failed:
2619   {
2620     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2621         ("pa_context_get_sink_info_by_index() failed: %s",
2622             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2623     goto unlock;
2624   }
2625 }
2626
2627 static void
2628 gst_pulsesink_set_property (GObject * object,
2629     guint prop_id, const GValue * value, GParamSpec * pspec)
2630 {
2631   GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2632
2633   switch (prop_id) {
2634     case PROP_SERVER:
2635       g_free (pulsesink->server);
2636       pulsesink->server = g_value_dup_string (value);
2637       if (pulsesink->probe)
2638         gst_pulseprobe_set_server (pulsesink->probe, pulsesink->server);
2639       break;
2640     case PROP_DEVICE:
2641       g_free (pulsesink->device);
2642       pulsesink->device = g_value_dup_string (value);
2643       break;
2644     case PROP_VOLUME:
2645       gst_pulsesink_set_volume (pulsesink, g_value_get_double (value));
2646       break;
2647     case PROP_MUTE:
2648       gst_pulsesink_set_mute (pulsesink, g_value_get_boolean (value));
2649       break;
2650     case PROP_CLIENT:
2651       g_free (pulsesink->client_name);
2652       if (!g_value_get_string (value)) {
2653         GST_WARNING_OBJECT (pulsesink,
2654             "Empty PulseAudio client name not allowed. Resetting to default value");
2655         pulsesink->client_name = gst_pulse_client_name ();
2656       } else
2657         pulsesink->client_name = g_value_dup_string (value);
2658       break;
2659     case PROP_STREAM_PROPERTIES:
2660       if (pulsesink->properties)
2661         gst_structure_free (pulsesink->properties);
2662       pulsesink->properties =
2663           gst_structure_copy (gst_value_get_structure (value));
2664       if (pulsesink->proplist)
2665         pa_proplist_free (pulsesink->proplist);
2666       pulsesink->proplist = gst_pulse_make_proplist (pulsesink->properties);
2667       break;
2668     default:
2669       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2670       break;
2671   }
2672 }
2673
2674 static void
2675 gst_pulsesink_get_property (GObject * object,
2676     guint prop_id, GValue * value, GParamSpec * pspec)
2677 {
2678
2679   GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2680
2681   switch (prop_id) {
2682     case PROP_SERVER:
2683       g_value_set_string (value, pulsesink->server);
2684       break;
2685     case PROP_DEVICE:
2686       g_value_set_string (value, pulsesink->device);
2687       break;
2688     case PROP_DEVICE_NAME:
2689       g_value_take_string (value, gst_pulsesink_device_description (pulsesink));
2690       break;
2691     case PROP_VOLUME:
2692       g_value_set_double (value, gst_pulsesink_get_volume (pulsesink));
2693       break;
2694     case PROP_MUTE:
2695       g_value_set_boolean (value, gst_pulsesink_get_mute (pulsesink));
2696       break;
2697     case PROP_CLIENT:
2698       g_value_set_string (value, pulsesink->client_name);
2699       break;
2700     case PROP_STREAM_PROPERTIES:
2701       gst_value_set_structure (value, pulsesink->properties);
2702       break;
2703     default:
2704       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2705       break;
2706   }
2707 }
2708
2709 static void
2710 gst_pulsesink_change_title (GstPulseSink * psink, const gchar * t)
2711 {
2712   pa_operation *o = NULL;
2713   GstPulseRingBuffer *pbuf;
2714
2715   pa_threaded_mainloop_lock (mainloop);
2716
2717   pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2718
2719   if (pbuf == NULL || pbuf->stream == NULL)
2720     goto no_buffer;
2721
2722   g_free (pbuf->stream_name);
2723   pbuf->stream_name = g_strdup (t);
2724
2725   if (!(o = pa_stream_set_name (pbuf->stream, pbuf->stream_name, NULL, NULL)))
2726     goto name_failed;
2727
2728   /* We're not interested if this operation failed or not */
2729 unlock:
2730
2731   if (o)
2732     pa_operation_unref (o);
2733   pa_threaded_mainloop_unlock (mainloop);
2734
2735   return;
2736
2737   /* ERRORS */
2738 no_buffer:
2739   {
2740     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2741     goto unlock;
2742   }
2743 name_failed:
2744   {
2745     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2746         ("pa_stream_set_name() failed: %s",
2747             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2748     goto unlock;
2749   }
2750 }
2751
2752 static void
2753 gst_pulsesink_change_props (GstPulseSink * psink, GstTagList * l)
2754 {
2755   static const gchar *const map[] = {
2756     GST_TAG_TITLE, PA_PROP_MEDIA_TITLE,
2757
2758     /* might get overriden in the next iteration by GST_TAG_ARTIST */
2759     GST_TAG_PERFORMER, PA_PROP_MEDIA_ARTIST,
2760
2761     GST_TAG_ARTIST, PA_PROP_MEDIA_ARTIST,
2762     GST_TAG_LANGUAGE_CODE, PA_PROP_MEDIA_LANGUAGE,
2763     GST_TAG_LOCATION, PA_PROP_MEDIA_FILENAME,
2764     /* We might add more here later on ... */
2765     NULL
2766   };
2767   pa_proplist *pl = NULL;
2768   const gchar *const *t;
2769   gboolean empty = TRUE;
2770   pa_operation *o = NULL;
2771   GstPulseRingBuffer *pbuf;
2772
2773   pl = pa_proplist_new ();
2774
2775   for (t = map; *t; t += 2) {
2776     gchar *n = NULL;
2777
2778     if (gst_tag_list_get_string (l, *t, &n)) {
2779
2780       if (n && *n) {
2781         pa_proplist_sets (pl, *(t + 1), n);
2782         empty = FALSE;
2783       }
2784
2785       g_free (n);
2786     }
2787   }
2788   if (empty)
2789     goto finish;
2790
2791   pa_threaded_mainloop_lock (mainloop);
2792   pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2793   if (pbuf == NULL || pbuf->stream == NULL)
2794     goto no_buffer;
2795
2796   if (!(o = pa_stream_proplist_update (pbuf->stream, PA_UPDATE_REPLACE,
2797               pl, NULL, NULL)))
2798     goto update_failed;
2799
2800   /* We're not interested if this operation failed or not */
2801 unlock:
2802
2803   if (o)
2804     pa_operation_unref (o);
2805
2806   pa_threaded_mainloop_unlock (mainloop);
2807
2808 finish:
2809
2810   if (pl)
2811     pa_proplist_free (pl);
2812
2813   return;
2814
2815   /* ERRORS */
2816 no_buffer:
2817   {
2818     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2819     goto unlock;
2820   }
2821 update_failed:
2822   {
2823     GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2824         ("pa_stream_proplist_update() failed: %s",
2825             pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2826     goto unlock;
2827   }
2828 }
2829
2830 static void
2831 gst_pulsesink_flush_ringbuffer (GstPulseSink * psink)
2832 {
2833   GstPulseRingBuffer *pbuf;
2834
2835   pa_threaded_mainloop_lock (mainloop);
2836
2837   pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2838
2839   if (pbuf == NULL || pbuf->stream == NULL)
2840     goto no_buffer;
2841
2842   gst_pulsering_flush (pbuf);
2843
2844   /* Uncork if we haven't already (happens when waiting to get enough data
2845    * to send out the first time) */
2846   if (pbuf->corked)
2847     gst_pulsering_set_corked (pbuf, FALSE, FALSE);
2848
2849   /* We're not interested if this operation failed or not */
2850 unlock:
2851   pa_threaded_mainloop_unlock (mainloop);
2852
2853   return;
2854
2855   /* ERRORS */
2856 no_buffer:
2857   {
2858     GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2859     goto unlock;
2860   }
2861 }
2862
2863 static gboolean
2864 gst_pulsesink_event (GstBaseSink * sink, GstEvent * event)
2865 {
2866   GstPulseSink *pulsesink = GST_PULSESINK_CAST (sink);
2867
2868   switch (GST_EVENT_TYPE (event)) {
2869     case GST_EVENT_TAG:{
2870       gchar *title = NULL, *artist = NULL, *location = NULL, *description =
2871           NULL, *t = NULL, *buf = NULL;
2872       GstTagList *l;
2873
2874       gst_event_parse_tag (event, &l);
2875
2876       gst_tag_list_get_string (l, GST_TAG_TITLE, &title);
2877       gst_tag_list_get_string (l, GST_TAG_ARTIST, &artist);
2878       gst_tag_list_get_string (l, GST_TAG_LOCATION, &location);
2879       gst_tag_list_get_string (l, GST_TAG_DESCRIPTION, &description);
2880
2881       if (!artist)
2882         gst_tag_list_get_string (l, GST_TAG_PERFORMER, &artist);
2883
2884       if (title && artist)
2885         /* TRANSLATORS: 'song title' by 'artist name' */
2886         t = buf = g_strdup_printf (_("'%s' by '%s'"), g_strstrip (title),
2887             g_strstrip (artist));
2888       else if (title)
2889         t = g_strstrip (title);
2890       else if (description)
2891         t = g_strstrip (description);
2892       else if (location)
2893         t = g_strstrip (location);
2894
2895       if (t)
2896         gst_pulsesink_change_title (pulsesink, t);
2897
2898       g_free (title);
2899       g_free (artist);
2900       g_free (location);
2901       g_free (description);
2902       g_free (buf);
2903
2904       gst_pulsesink_change_props (pulsesink, l);
2905
2906       break;
2907     }
2908     case GST_EVENT_EOS:
2909       gst_pulsesink_flush_ringbuffer (pulsesink);
2910       break;
2911     default:
2912       ;
2913   }
2914
2915   return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
2916 }
2917
2918 static void
2919 gst_pulsesink_release_mainloop (GstPulseSink * psink)
2920 {
2921   if (!mainloop)
2922     return;
2923
2924   pa_threaded_mainloop_lock (mainloop);
2925   while (psink->defer_pending) {
2926     GST_DEBUG_OBJECT (psink, "waiting for stream status message emission");
2927     pa_threaded_mainloop_wait (mainloop);
2928   }
2929   pa_threaded_mainloop_unlock (mainloop);
2930
2931   g_mutex_lock (pa_shared_resource_mutex);
2932   mainloop_ref_ct--;
2933   if (!mainloop_ref_ct) {
2934     GST_INFO_OBJECT (psink, "terminating pa main loop thread");
2935     pa_threaded_mainloop_stop (mainloop);
2936     pa_threaded_mainloop_free (mainloop);
2937     mainloop = NULL;
2938   }
2939   g_mutex_unlock (pa_shared_resource_mutex);
2940 }
2941
2942 static GstStateChangeReturn
2943 gst_pulsesink_change_state (GstElement * element, GstStateChange transition)
2944 {
2945   GstPulseSink *pulsesink = GST_PULSESINK (element);
2946   GstStateChangeReturn ret;
2947
2948   switch (transition) {
2949     case GST_STATE_CHANGE_NULL_TO_READY:
2950       g_mutex_lock (pa_shared_resource_mutex);
2951       if (!mainloop_ref_ct) {
2952         GST_INFO_OBJECT (element, "new pa main loop thread");
2953         if (!(mainloop = pa_threaded_mainloop_new ()))
2954           goto mainloop_failed;
2955         mainloop_ref_ct = 1;
2956         pa_threaded_mainloop_start (mainloop);
2957         g_mutex_unlock (pa_shared_resource_mutex);
2958       } else {
2959         GST_INFO_OBJECT (element, "reusing pa main loop thread");
2960         mainloop_ref_ct++;
2961         g_mutex_unlock (pa_shared_resource_mutex);
2962       }
2963       break;
2964     case GST_STATE_CHANGE_READY_TO_PAUSED:
2965       gst_element_post_message (element,
2966           gst_message_new_clock_provide (GST_OBJECT_CAST (element),
2967               GST_BASE_AUDIO_SINK (pulsesink)->provided_clock, TRUE));
2968       break;
2969
2970     default:
2971       break;
2972   }
2973
2974   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2975   if (ret == GST_STATE_CHANGE_FAILURE)
2976     goto state_failure;
2977
2978   switch (transition) {
2979     case GST_STATE_CHANGE_PAUSED_TO_READY:
2980       /* format_lost is reset in release() in baseaudiosink */
2981       gst_element_post_message (element,
2982           gst_message_new_clock_lost (GST_OBJECT_CAST (element),
2983               GST_BASE_AUDIO_SINK (pulsesink)->provided_clock));
2984       break;
2985     case GST_STATE_CHANGE_READY_TO_NULL:
2986       gst_pulsesink_release_mainloop (pulsesink);
2987       break;
2988     default:
2989       break;
2990   }
2991
2992   return ret;
2993
2994   /* ERRORS */
2995 mainloop_failed:
2996   {
2997     g_mutex_unlock (pa_shared_resource_mutex);
2998     GST_ELEMENT_ERROR (pulsesink, RESOURCE, FAILED,
2999         ("pa_threaded_mainloop_new() failed"), (NULL));
3000     return GST_STATE_CHANGE_FAILURE;
3001   }
3002 state_failure:
3003   {
3004     if (transition == GST_STATE_CHANGE_NULL_TO_READY) {
3005       /* Clear the PA mainloop if baseaudiosink failed to open the ring_buffer */
3006       g_assert (mainloop);
3007       gst_pulsesink_release_mainloop (pulsesink);
3008     }
3009     return ret;
3010   }
3011 }