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