1 /*-*- Mode: C; c-basic-offset: 2 -*-*/
3 /* GStreamer pulseaudio plugin
5 * Copyright (c) 2004-2008 Lennart Poettering
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.
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.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with gst-pulse; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
25 * SECTION:element-pulsesink
26 * @see_also: pulsesrc, pulsemixer
28 * This element outputs audio to a
29 * <ulink href="http://www.pulseaudio.org">PulseAudio sound server</ulink>.
32 * <title>Example pipelines</title>
34 * gst-launch -v filesrc location=sine.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! pulsesink
35 * ]| Play an Ogg/Vorbis file.
37 * gst-launch -v audiotestsrc ! audioconvert ! volume volume=0.4 ! pulsesink
38 * ]| Play a 440Hz sine wave.
40 * gst-launch -v audiotestsrc ! pulsesink stream-properties="props,media.title=test"
41 * ]| Play a sine wave and set a stream property. The property can be checked
53 #include <gst/base/gstbasesink.h>
54 #include <gst/gsttaglist.h>
55 #include <gst/interfaces/streamvolume.h>
56 #include <gst/gst-i18n-plugin.h>
57 #include <gst/audio/gstaudioiec61937.h>
59 #include <gst/pbutils/pbutils.h> /* only used for GST_PLUGINS_BASE_VERSION_* */
61 #include "pulsesink.h"
62 #include "pulseutil.h"
64 GST_DEBUG_CATEGORY_EXTERN (pulse_debug);
65 #define GST_CAT_DEFAULT pulse_debug
67 #define DEFAULT_SERVER NULL
68 #define DEFAULT_DEVICE NULL
69 #define DEFAULT_DEVICE_NAME NULL
70 #define DEFAULT_VOLUME 1.0
71 #define DEFAULT_MUTE FALSE
72 #define MAX_VOLUME 10.0
83 PROP_STREAM_PROPERTIES,
87 #define GST_TYPE_PULSERING_BUFFER \
88 (gst_pulseringbuffer_get_type())
89 #define GST_PULSERING_BUFFER(obj) \
90 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PULSERING_BUFFER,GstPulseRingBuffer))
91 #define GST_PULSERING_BUFFER_CLASS(klass) \
92 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PULSERING_BUFFER,GstPulseRingBufferClass))
93 #define GST_PULSERING_BUFFER_GET_CLASS(obj) \
94 (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PULSERING_BUFFER, GstPulseRingBufferClass))
95 #define GST_PULSERING_BUFFER_CAST(obj) \
96 ((GstPulseRingBuffer *)obj)
97 #define GST_IS_PULSERING_BUFFER(obj) \
98 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PULSERING_BUFFER))
99 #define GST_IS_PULSERING_BUFFER_CLASS(klass)\
100 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PULSERING_BUFFER))
102 typedef struct _GstPulseRingBuffer GstPulseRingBuffer;
103 typedef struct _GstPulseRingBufferClass GstPulseRingBufferClass;
105 typedef struct _GstPulseContext GstPulseContext;
107 /* Store the PA contexts in a hash table to allow easy sharing among
108 * multiple instances of the sink. Keys are $context_name@$server_name
109 * (strings) and values should be GstPulseContext pointers.
111 struct _GstPulseContext
114 GSList *ring_buffers;
117 static GHashTable *gst_pulse_shared_contexts = NULL;
119 /* use one static main-loop for all instances
120 * this is needed to make the context sharing work as the contexts are
121 * released when releasing their parent main-loop
123 static pa_threaded_mainloop *mainloop = NULL;
124 static guint mainloop_ref_ct = 0;
126 /* lock for access to shared resources */
127 static GMutex *pa_shared_resource_mutex = NULL;
129 /* We keep a custom ringbuffer that is backed up by data allocated by
130 * pulseaudio. We must also overide the commit function to write into
131 * pulseaudio memory instead. */
132 struct _GstPulseRingBuffer
134 GstRingBuffer object;
142 #ifdef HAVE_PULSE_1_0
143 pa_format_info *format;
147 pa_sample_spec sample_spec;
157 gboolean in_commit:1;
160 struct _GstPulseRingBufferClass
162 GstRingBufferClass parent_class;
165 static GType gst_pulseringbuffer_get_type (void);
166 static void gst_pulseringbuffer_finalize (GObject * object);
168 static GstRingBufferClass *ring_parent_class = NULL;
170 static gboolean gst_pulseringbuffer_open_device (GstRingBuffer * buf);
171 static gboolean gst_pulseringbuffer_close_device (GstRingBuffer * buf);
172 static gboolean gst_pulseringbuffer_acquire (GstRingBuffer * buf,
173 GstRingBufferSpec * spec);
174 static gboolean gst_pulseringbuffer_release (GstRingBuffer * buf);
175 static gboolean gst_pulseringbuffer_start (GstRingBuffer * buf);
176 static gboolean gst_pulseringbuffer_pause (GstRingBuffer * buf);
177 static gboolean gst_pulseringbuffer_stop (GstRingBuffer * buf);
178 static void gst_pulseringbuffer_clear (GstRingBuffer * buf);
179 static guint gst_pulseringbuffer_commit (GstRingBuffer * buf,
180 guint64 * sample, guchar * data, gint in_samples, gint out_samples,
183 G_DEFINE_TYPE (GstPulseRingBuffer, gst_pulseringbuffer, GST_TYPE_RING_BUFFER);
186 gst_pulsesink_init_contexts (void)
188 g_assert (pa_shared_resource_mutex == NULL);
189 pa_shared_resource_mutex = g_mutex_new ();
190 gst_pulse_shared_contexts = g_hash_table_new_full (g_str_hash, g_str_equal,
195 gst_pulseringbuffer_class_init (GstPulseRingBufferClass * klass)
197 GObjectClass *gobject_class;
198 GstRingBufferClass *gstringbuffer_class;
200 gobject_class = (GObjectClass *) klass;
201 gstringbuffer_class = (GstRingBufferClass *) klass;
203 ring_parent_class = g_type_class_peek_parent (klass);
205 gobject_class->finalize = gst_pulseringbuffer_finalize;
207 gstringbuffer_class->open_device =
208 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_open_device);
209 gstringbuffer_class->close_device =
210 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_close_device);
211 gstringbuffer_class->acquire =
212 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_acquire);
213 gstringbuffer_class->release =
214 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_release);
215 gstringbuffer_class->start = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_start);
216 gstringbuffer_class->pause = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_pause);
217 gstringbuffer_class->resume = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_start);
218 gstringbuffer_class->stop = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_stop);
219 gstringbuffer_class->clear_all =
220 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_clear);
222 gstringbuffer_class->commit = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_commit);
226 gst_pulseringbuffer_init (GstPulseRingBuffer * pbuf)
228 pbuf->stream_name = NULL;
229 pbuf->context = NULL;
232 #ifdef HAVE_PULSE_1_0
235 pbuf->is_pcm = FALSE;
237 pa_sample_spec_init (&pbuf->sample_spec);
242 pbuf->m_writable = 0;
244 pbuf->m_lastoffset = 0;
247 pbuf->in_commit = FALSE;
248 pbuf->paused = FALSE;
252 gst_pulsering_destroy_stream (GstPulseRingBuffer * pbuf)
257 /* drop shm memory buffer */
258 pa_stream_cancel_write (pbuf->stream);
260 /* reset internal variables */
263 pbuf->m_writable = 0;
265 pbuf->m_lastoffset = 0;
267 #ifdef HAVE_PULSE_1_0
269 pa_format_info_free (pbuf->format);
272 pbuf->is_pcm = FALSE;
276 pa_stream_disconnect (pbuf->stream);
278 /* Make sure we don't get any further callbacks */
279 pa_stream_set_state_callback (pbuf->stream, NULL, NULL);
280 pa_stream_set_write_callback (pbuf->stream, NULL, NULL);
281 pa_stream_set_underflow_callback (pbuf->stream, NULL, NULL);
282 pa_stream_set_overflow_callback (pbuf->stream, NULL, NULL);
284 pa_stream_unref (pbuf->stream);
288 g_free (pbuf->stream_name);
289 pbuf->stream_name = NULL;
293 gst_pulsering_destroy_context (GstPulseRingBuffer * pbuf)
295 g_mutex_lock (pa_shared_resource_mutex);
297 GST_DEBUG_OBJECT (pbuf, "destroying ringbuffer %p", pbuf);
299 gst_pulsering_destroy_stream (pbuf);
302 pa_context_unref (pbuf->context);
303 pbuf->context = NULL;
306 if (pbuf->context_name) {
307 GstPulseContext *pctx;
309 pctx = g_hash_table_lookup (gst_pulse_shared_contexts, pbuf->context_name);
311 GST_DEBUG_OBJECT (pbuf, "releasing context with name %s, pbuf=%p, pctx=%p",
312 pbuf->context_name, pbuf, pctx);
315 pctx->ring_buffers = g_slist_remove (pctx->ring_buffers, pbuf);
316 if (pctx->ring_buffers == NULL) {
317 GST_DEBUG_OBJECT (pbuf,
318 "destroying final context with name %s, pbuf=%p, pctx=%p",
319 pbuf->context_name, pbuf, pctx);
321 pa_context_disconnect (pctx->context);
323 /* Make sure we don't get any further callbacks */
324 pa_context_set_state_callback (pctx->context, NULL, NULL);
325 pa_context_set_subscribe_callback (pctx->context, NULL, NULL);
327 g_hash_table_remove (gst_pulse_shared_contexts, pbuf->context_name);
329 pa_context_unref (pctx->context);
330 g_slice_free (GstPulseContext, pctx);
333 g_free (pbuf->context_name);
334 pbuf->context_name = NULL;
336 g_mutex_unlock (pa_shared_resource_mutex);
340 gst_pulseringbuffer_finalize (GObject * object)
342 GstPulseRingBuffer *ringbuffer;
344 ringbuffer = GST_PULSERING_BUFFER_CAST (object);
346 gst_pulsering_destroy_context (ringbuffer);
347 G_OBJECT_CLASS (ring_parent_class)->finalize (object);
351 #define CONTEXT_OK(c) ((c) && PA_CONTEXT_IS_GOOD (pa_context_get_state ((c))))
352 #define STREAM_OK(s) ((s) && PA_STREAM_IS_GOOD (pa_stream_get_state ((s))))
355 gst_pulsering_is_dead (GstPulseSink * psink, GstPulseRingBuffer * pbuf,
356 gboolean check_stream)
358 if (!CONTEXT_OK (pbuf->context))
361 if (check_stream && !STREAM_OK (pbuf->stream))
368 const gchar *err_str =
369 pbuf->context ? pa_strerror (pa_context_errno (pbuf->context)) : NULL;
370 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED, ("Disconnected: %s",
377 gst_pulsering_context_state_cb (pa_context * c, void *userdata)
379 pa_context_state_t state;
380 pa_threaded_mainloop *mainloop = (pa_threaded_mainloop *) userdata;
382 state = pa_context_get_state (c);
384 GST_LOG ("got new context state %d", state);
387 case PA_CONTEXT_READY:
388 case PA_CONTEXT_TERMINATED:
389 case PA_CONTEXT_FAILED:
390 GST_LOG ("signaling");
391 pa_threaded_mainloop_signal (mainloop, 0);
394 case PA_CONTEXT_UNCONNECTED:
395 case PA_CONTEXT_CONNECTING:
396 case PA_CONTEXT_AUTHORIZING:
397 case PA_CONTEXT_SETTING_NAME:
403 gst_pulsering_context_subscribe_cb (pa_context * c,
404 pa_subscription_event_type_t t, uint32_t idx, void *userdata)
407 GstPulseContext *pctx = (GstPulseContext *) userdata;
410 if (t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT | PA_SUBSCRIPTION_EVENT_CHANGE) &&
411 t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT | PA_SUBSCRIPTION_EVENT_NEW))
414 for (walk = pctx->ring_buffers; walk; walk = g_slist_next (walk)) {
415 GstPulseRingBuffer *pbuf = (GstPulseRingBuffer *) walk->data;
416 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
418 GST_LOG_OBJECT (psink, "type %d, idx %u", t, idx);
423 if (idx != pa_stream_get_index (pbuf->stream))
426 #ifdef HAVE_PULSE_1_0
427 if (psink->device && pbuf->is_pcm &&
428 !g_str_equal (psink->device,
429 pa_stream_get_device_name (pbuf->stream))) {
430 /* Underlying sink changed. And this is not a passthrough stream. Let's
431 * see if someone upstream wants to try to renegotiate. */
434 g_free (psink->device);
435 psink->device = g_strdup (pa_stream_get_device_name (pbuf->stream));
437 GST_INFO_OBJECT (psink, "emitting sink-changed");
439 renego = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM,
440 gst_structure_new ("pulse-sink-changed", NULL));
442 if (!gst_pad_push_event (GST_BASE_SINK (psink)->sinkpad, renego))
443 GST_DEBUG_OBJECT (psink, "Emitted sink-changed - nobody was listening");
447 /* Actually this event is also triggered when other properties of
448 * the stream change that are unrelated to the volume. However it is
449 * probably cheaper to signal the change here and check for the
450 * volume when the GObject property is read instead of querying it always. */
452 /* inform streaming thread to notify */
453 g_atomic_int_compare_and_exchange (&psink->notify, 0, 1);
457 /* will be called when the device should be opened. In this case we will connect
458 * to the server. We should not try to open any streams in this state. */
460 gst_pulseringbuffer_open_device (GstRingBuffer * buf)
463 GstPulseRingBuffer *pbuf;
464 GstPulseContext *pctx;
465 pa_mainloop_api *api;
466 gboolean need_unlock_shared;
468 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (buf));
469 pbuf = GST_PULSERING_BUFFER_CAST (buf);
471 g_assert (!pbuf->stream);
472 g_assert (psink->client_name);
475 pbuf->context_name = g_strdup_printf ("%s@%s", psink->client_name,
478 pbuf->context_name = g_strdup (psink->client_name);
480 pa_threaded_mainloop_lock (mainloop);
482 g_mutex_lock (pa_shared_resource_mutex);
483 need_unlock_shared = TRUE;
485 pctx = g_hash_table_lookup (gst_pulse_shared_contexts, pbuf->context_name);
487 pctx = g_slice_new0 (GstPulseContext);
489 /* get the mainloop api and create a context */
490 GST_INFO_OBJECT (psink, "new context with name %s, pbuf=%p, pctx=%p",
491 pbuf->context_name, pbuf, pctx);
492 api = pa_threaded_mainloop_get_api (mainloop);
493 if (!(pctx->context = pa_context_new (api, pbuf->context_name)))
496 pctx->ring_buffers = g_slist_prepend (pctx->ring_buffers, pbuf);
497 g_hash_table_insert (gst_pulse_shared_contexts,
498 g_strdup (pbuf->context_name), (gpointer) pctx);
499 /* register some essential callbacks */
500 pa_context_set_state_callback (pctx->context,
501 gst_pulsering_context_state_cb, mainloop);
502 pa_context_set_subscribe_callback (pctx->context,
503 gst_pulsering_context_subscribe_cb, pctx);
505 /* try to connect to the server and wait for completion, we don't want to
506 * autospawn a deamon */
507 GST_LOG_OBJECT (psink, "connect to server %s",
508 GST_STR_NULL (psink->server));
509 if (pa_context_connect (pctx->context, psink->server,
510 PA_CONTEXT_NOAUTOSPAWN, NULL) < 0)
513 GST_INFO_OBJECT (psink,
514 "reusing shared context with name %s, pbuf=%p, pctx=%p",
515 pbuf->context_name, pbuf, pctx);
516 pctx->ring_buffers = g_slist_prepend (pctx->ring_buffers, pbuf);
519 g_mutex_unlock (pa_shared_resource_mutex);
520 need_unlock_shared = FALSE;
522 /* context created or shared okay */
523 pbuf->context = pa_context_ref (pctx->context);
526 pa_context_state_t state;
528 state = pa_context_get_state (pbuf->context);
530 GST_LOG_OBJECT (psink, "context state is now %d", state);
532 if (!PA_CONTEXT_IS_GOOD (state))
535 if (state == PA_CONTEXT_READY)
538 /* Wait until the context is ready */
539 GST_LOG_OBJECT (psink, "waiting..");
540 pa_threaded_mainloop_wait (mainloop);
543 GST_LOG_OBJECT (psink, "opened the device");
545 pa_threaded_mainloop_unlock (mainloop);
552 if (need_unlock_shared)
553 g_mutex_unlock (pa_shared_resource_mutex);
554 gst_pulsering_destroy_context (pbuf);
555 pa_threaded_mainloop_unlock (mainloop);
560 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
561 ("Failed to create context"), (NULL));
562 g_slice_free (GstPulseContext, pctx);
563 goto unlock_and_fail;
567 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED, ("Failed to connect: %s",
568 pa_strerror (pa_context_errno (pctx->context))), (NULL));
569 goto unlock_and_fail;
573 /* close the device */
575 gst_pulseringbuffer_close_device (GstRingBuffer * buf)
578 GstPulseRingBuffer *pbuf;
580 pbuf = GST_PULSERING_BUFFER_CAST (buf);
581 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (buf));
583 GST_LOG_OBJECT (psink, "closing device");
585 pa_threaded_mainloop_lock (mainloop);
586 gst_pulsering_destroy_context (pbuf);
587 pa_threaded_mainloop_unlock (mainloop);
589 GST_LOG_OBJECT (psink, "closed device");
595 gst_pulsering_stream_state_cb (pa_stream * s, void *userdata)
598 GstPulseRingBuffer *pbuf;
599 pa_stream_state_t state;
601 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
602 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
604 state = pa_stream_get_state (s);
605 GST_LOG_OBJECT (psink, "got new stream state %d", state);
608 case PA_STREAM_READY:
609 case PA_STREAM_FAILED:
610 case PA_STREAM_TERMINATED:
611 GST_LOG_OBJECT (psink, "signaling");
612 pa_threaded_mainloop_signal (mainloop, 0);
614 case PA_STREAM_UNCONNECTED:
615 case PA_STREAM_CREATING:
621 gst_pulsering_stream_request_cb (pa_stream * s, size_t length, void *userdata)
625 GstPulseRingBuffer *pbuf;
627 rbuf = GST_RING_BUFFER_CAST (userdata);
628 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
629 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
631 GST_LOG_OBJECT (psink, "got request for length %" G_GSIZE_FORMAT, length);
633 if (pbuf->in_commit && (length >= rbuf->spec.segsize)) {
634 /* only signal when we are waiting in the commit thread
635 * and got request for atleast a segment */
636 pa_threaded_mainloop_signal (mainloop, 0);
641 gst_pulsering_stream_underflow_cb (pa_stream * s, void *userdata)
644 GstPulseRingBuffer *pbuf;
646 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
647 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
649 GST_WARNING_OBJECT (psink, "Got underflow");
653 gst_pulsering_stream_overflow_cb (pa_stream * s, void *userdata)
656 GstPulseRingBuffer *pbuf;
658 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
659 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
661 GST_WARNING_OBJECT (psink, "Got overflow");
665 gst_pulsering_stream_latency_cb (pa_stream * s, void *userdata)
668 GstPulseRingBuffer *pbuf;
669 const pa_timing_info *info;
672 info = pa_stream_get_timing_info (s);
674 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
675 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
678 GST_LOG_OBJECT (psink, "latency update (information unknown)");
681 sink_usec = info->configured_sink_usec;
683 GST_LOG_OBJECT (psink,
684 "latency_update, %" G_GUINT64_FORMAT ", %d:%" G_GINT64_FORMAT ", %d:%"
685 G_GUINT64_FORMAT ", %" G_GUINT64_FORMAT ", %" G_GUINT64_FORMAT,
686 GST_TIMEVAL_TO_TIME (info->timestamp), info->write_index_corrupt,
687 info->write_index, info->read_index_corrupt, info->read_index,
688 info->sink_usec, sink_usec);
692 gst_pulsering_stream_suspended_cb (pa_stream * p, void *userdata)
695 GstPulseRingBuffer *pbuf;
697 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
698 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
700 if (pa_stream_is_suspended (p))
701 GST_DEBUG_OBJECT (psink, "stream suspended");
703 GST_DEBUG_OBJECT (psink, "stream resumed");
707 gst_pulsering_stream_started_cb (pa_stream * p, void *userdata)
710 GstPulseRingBuffer *pbuf;
712 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
713 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
715 GST_DEBUG_OBJECT (psink, "stream started");
719 gst_pulsering_stream_event_cb (pa_stream * p, const char *name,
720 pa_proplist * pl, void *userdata)
723 GstPulseRingBuffer *pbuf;
725 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
726 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
728 if (!strcmp (name, PA_STREAM_EVENT_REQUEST_CORK)) {
729 /* the stream wants to PAUSE, post a message for the application. */
730 GST_DEBUG_OBJECT (psink, "got request for CORK");
731 gst_element_post_message (GST_ELEMENT_CAST (psink),
732 gst_message_new_request_state (GST_OBJECT_CAST (psink),
735 } else if (!strcmp (name, PA_STREAM_EVENT_REQUEST_UNCORK)) {
736 GST_DEBUG_OBJECT (psink, "got request for UNCORK");
737 gst_element_post_message (GST_ELEMENT_CAST (psink),
738 gst_message_new_request_state (GST_OBJECT_CAST (psink),
740 #ifdef HAVE_PULSE_1_0
741 } else if (!strcmp (name, PA_STREAM_EVENT_FORMAT_LOST)) {
744 if (g_atomic_int_get (&psink->format_lost)) {
745 /* Duplicate event before we're done reconfiguring, discard */
749 GST_DEBUG_OBJECT (psink, "got FORMAT LOST");
750 g_atomic_int_set (&psink->format_lost, 1);
751 psink->format_lost_time = g_ascii_strtoull (pa_proplist_gets (pl,
752 "stream-time"), NULL, 0) * 1000;
754 g_free (psink->device);
755 psink->device = g_strdup (pa_proplist_gets (pl, "device"));
757 renego = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM,
758 gst_structure_new ("pulse-format-lost", NULL));
760 if (!gst_pad_push_event (GST_BASE_SINK (psink)->sinkpad, renego)) {
761 /* Nobody handled the format change - emit an error */
762 GST_ELEMENT_ERROR (psink, STREAM, FORMAT, ("Sink format changed"),
763 ("Sink format changed"));
767 GST_DEBUG_OBJECT (psink, "got unknown event %s", name);
771 /* Called with the mainloop locked */
773 gst_pulsering_wait_for_stream_ready (GstPulseSink * psink, pa_stream * stream)
775 pa_stream_state_t state;
778 state = pa_stream_get_state (stream);
780 GST_LOG_OBJECT (psink, "stream state is now %d", state);
782 if (!PA_STREAM_IS_GOOD (state))
785 if (state == PA_STREAM_READY)
788 /* Wait until the stream is ready */
789 pa_threaded_mainloop_wait (mainloop);
794 /* This method should create a new stream of the given @spec. No playback should
795 * start yet so we start in the corked state. */
797 gst_pulseringbuffer_acquire (GstRingBuffer * buf, GstRingBufferSpec * spec)
800 GstPulseRingBuffer *pbuf;
801 pa_buffer_attr wanted;
802 const pa_buffer_attr *actual;
803 pa_channel_map channel_map;
804 pa_operation *o = NULL;
805 #ifdef HAVE_PULSE_0_9_20
808 pa_cvolume *pv = NULL;
809 pa_stream_flags_t flags;
811 GstAudioClock *clock;
812 #ifdef HAVE_PULSE_1_0
813 pa_format_info *formats[1];
814 #ifndef GST_DISABLE_GST_DEBUG
815 gchar print_buf[PA_FORMAT_INFO_SNPRINT_MAX];
819 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (buf));
820 pbuf = GST_PULSERING_BUFFER_CAST (buf);
822 GST_LOG_OBJECT (psink, "creating sample spec");
823 /* convert the gstreamer sample spec to the pulseaudio format */
824 #ifdef HAVE_PULSE_1_0
825 if (!gst_pulse_fill_format_info (spec, &pbuf->format, &pbuf->channels))
827 pbuf->is_pcm = pa_format_info_is_pcm (pbuf->format);
829 if (!gst_pulse_fill_sample_spec (spec, &pbuf->sample_spec))
833 pa_threaded_mainloop_lock (mainloop);
835 /* we need a context and a no stream */
836 g_assert (pbuf->context);
837 g_assert (!pbuf->stream);
839 /* enable event notifications */
840 GST_LOG_OBJECT (psink, "subscribing to context events");
841 if (!(o = pa_context_subscribe (pbuf->context,
842 PA_SUBSCRIPTION_MASK_SINK_INPUT, NULL, NULL)))
843 goto subscribe_failed;
845 pa_operation_unref (o);
847 /* initialize the channel map */
848 #ifdef HAVE_PULSE_1_0
849 if (pbuf->is_pcm && gst_pulse_gst_to_channel_map (&channel_map, spec))
850 pa_format_info_set_channel_map (pbuf->format, &channel_map);
852 gst_pulse_gst_to_channel_map (&channel_map, spec);
855 /* find a good name for the stream */
856 if (psink->stream_name)
857 name = psink->stream_name;
859 name = "Playback Stream";
861 /* create a stream */
862 #ifdef HAVE_PULSE_1_0
863 formats[0] = pbuf->format;
864 if (!(pbuf->stream = pa_stream_new_extended (pbuf->context, name, formats, 1,
868 GST_LOG_OBJECT (psink, "creating stream with name %s", name);
869 if (!(pbuf->stream = pa_stream_new_with_proplist (pbuf->context, name,
870 &pbuf->sample_spec, &channel_map, psink->proplist)))
874 /* install essential callbacks */
875 pa_stream_set_state_callback (pbuf->stream,
876 gst_pulsering_stream_state_cb, pbuf);
877 pa_stream_set_write_callback (pbuf->stream,
878 gst_pulsering_stream_request_cb, pbuf);
879 pa_stream_set_underflow_callback (pbuf->stream,
880 gst_pulsering_stream_underflow_cb, pbuf);
881 pa_stream_set_overflow_callback (pbuf->stream,
882 gst_pulsering_stream_overflow_cb, pbuf);
883 pa_stream_set_latency_update_callback (pbuf->stream,
884 gst_pulsering_stream_latency_cb, pbuf);
885 pa_stream_set_suspended_callback (pbuf->stream,
886 gst_pulsering_stream_suspended_cb, pbuf);
887 pa_stream_set_started_callback (pbuf->stream,
888 gst_pulsering_stream_started_cb, pbuf);
889 pa_stream_set_event_callback (pbuf->stream,
890 gst_pulsering_stream_event_cb, pbuf);
892 /* buffering requirements. When setting prebuf to 0, the stream will not pause
893 * when we cause an underrun, which causes time to continue. */
894 memset (&wanted, 0, sizeof (wanted));
895 wanted.tlength = spec->segtotal * spec->segsize;
896 wanted.maxlength = -1;
898 wanted.minreq = spec->segsize;
900 GST_INFO_OBJECT (psink, "tlength: %d", wanted.tlength);
901 GST_INFO_OBJECT (psink, "maxlength: %d", wanted.maxlength);
902 GST_INFO_OBJECT (psink, "prebuf: %d", wanted.prebuf);
903 GST_INFO_OBJECT (psink, "minreq: %d", wanted.minreq);
905 #ifdef HAVE_PULSE_0_9_20
906 /* configure volume when we changed it, else we leave the default */
907 if (psink->volume_set) {
908 GST_LOG_OBJECT (psink, "have volume of %f", psink->volume);
910 #ifdef HAVE_PULSE_1_0
912 gst_pulse_cvolume_from_linear (pv, pbuf->channels, psink->volume);
914 GST_DEBUG_OBJECT (psink, "passthrough stream, not setting volume");
918 gst_pulse_cvolume_from_linear (pv, pbuf->sample_spec.channels,
926 /* construct the flags */
927 flags = PA_STREAM_INTERPOLATE_TIMING | PA_STREAM_AUTO_TIMING_UPDATE |
928 PA_STREAM_ADJUST_LATENCY | PA_STREAM_START_CORKED;
930 if (psink->mute_set && psink->mute)
931 flags |= PA_STREAM_START_MUTED;
933 /* we always start corked (see flags above) */
936 /* try to connect now */
937 GST_LOG_OBJECT (psink, "connect for playback to device %s",
938 GST_STR_NULL (psink->device));
939 if (pa_stream_connect_playback (pbuf->stream, psink->device,
940 &wanted, flags, pv, NULL) < 0)
943 /* our clock will now start from 0 again */
944 clock = GST_AUDIO_CLOCK (GST_BASE_AUDIO_SINK (psink)->provided_clock);
945 gst_audio_clock_reset (clock, 0);
947 if (!gst_pulsering_wait_for_stream_ready (psink, pbuf->stream))
950 #ifdef HAVE_PULSE_1_0
951 g_free (psink->device);
952 psink->device = g_strdup (pa_stream_get_device_name (pbuf->stream));
954 #ifndef GST_DISABLE_GST_DEBUG
955 pa_format_info_snprint (print_buf, sizeof (print_buf),
956 pa_stream_get_format_info (pbuf->stream));
957 GST_INFO_OBJECT (psink, "negotiated to: %s", print_buf);
961 /* After we passed the volume off of to PA we never want to set it
962 again, since it is PA's job to save/restore volumes. */
963 psink->volume_set = psink->mute_set = FALSE;
965 GST_LOG_OBJECT (psink, "stream is acquired now");
967 /* get the actual buffering properties now */
968 actual = pa_stream_get_buffer_attr (pbuf->stream);
970 GST_INFO_OBJECT (psink, "tlength: %d (wanted: %d)", actual->tlength,
972 GST_INFO_OBJECT (psink, "maxlength: %d", actual->maxlength);
973 GST_INFO_OBJECT (psink, "prebuf: %d", actual->prebuf);
974 GST_INFO_OBJECT (psink, "minreq: %d (wanted %d)", actual->minreq,
977 spec->segsize = actual->minreq;
978 spec->segtotal = actual->tlength / spec->segsize;
980 pa_threaded_mainloop_unlock (mainloop);
987 gst_pulsering_destroy_stream (pbuf);
988 pa_threaded_mainloop_unlock (mainloop);
994 GST_ELEMENT_ERROR (psink, RESOURCE, SETTINGS,
995 ("Invalid sample specification."), (NULL));
1000 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1001 ("pa_context_subscribe() failed: %s",
1002 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1003 goto unlock_and_fail;
1007 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1008 ("Failed to create stream: %s",
1009 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1010 goto unlock_and_fail;
1014 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1015 ("Failed to connect stream: %s",
1016 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1017 goto unlock_and_fail;
1021 /* free the stream that we acquired before */
1023 gst_pulseringbuffer_release (GstRingBuffer * buf)
1025 GstPulseRingBuffer *pbuf;
1027 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1029 pa_threaded_mainloop_lock (mainloop);
1030 gst_pulsering_destroy_stream (pbuf);
1031 pa_threaded_mainloop_unlock (mainloop);
1033 #ifdef HAVE_PULSE_1_0
1035 GstPulseSink *psink;
1037 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1038 g_atomic_int_set (&psink->format_lost, FALSE);
1039 psink->format_lost_time = GST_CLOCK_TIME_NONE;
1047 gst_pulsering_success_cb (pa_stream * s, int success, void *userdata)
1049 pa_threaded_mainloop_signal (mainloop, 0);
1052 /* update the corked state of a stream, must be called with the mainloop
1055 gst_pulsering_set_corked (GstPulseRingBuffer * pbuf, gboolean corked,
1058 pa_operation *o = NULL;
1059 GstPulseSink *psink;
1060 gboolean res = FALSE;
1062 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1064 #ifdef HAVE_PULSE_1_0
1065 if (g_atomic_int_get (&psink->format_lost)) {
1066 /* Sink format changed, stream's gone so fake being paused */
1071 GST_DEBUG_OBJECT (psink, "setting corked state to %d", corked);
1072 if (pbuf->corked != corked) {
1073 if (!(o = pa_stream_cork (pbuf->stream, corked,
1074 gst_pulsering_success_cb, pbuf)))
1077 while (wait && pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
1078 pa_threaded_mainloop_wait (mainloop);
1079 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1082 pbuf->corked = corked;
1084 GST_DEBUG_OBJECT (psink, "skipping, already in requested state");
1090 pa_operation_unref (o);
1097 GST_DEBUG_OBJECT (psink, "the server is dead");
1102 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1103 ("pa_stream_cork() failed: %s",
1104 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1110 gst_pulseringbuffer_clear (GstRingBuffer * buf)
1112 GstPulseSink *psink;
1113 GstPulseRingBuffer *pbuf;
1114 pa_operation *o = NULL;
1116 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1117 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1119 pa_threaded_mainloop_lock (mainloop);
1120 GST_DEBUG_OBJECT (psink, "clearing");
1122 /* don't wait for the flush to complete */
1123 if ((o = pa_stream_flush (pbuf->stream, NULL, pbuf)))
1124 pa_operation_unref (o);
1126 pa_threaded_mainloop_unlock (mainloop);
1129 /* called from pulse with the mainloop lock */
1131 mainloop_enter_defer_cb (pa_mainloop_api * api, void *userdata)
1133 GstPulseSink *pulsesink = GST_PULSESINK (userdata);
1134 GstMessage *message;
1137 g_value_init (&val, G_TYPE_POINTER);
1138 g_value_set_pointer (&val, g_thread_self ());
1140 GST_DEBUG_OBJECT (pulsesink, "posting ENTER stream status");
1141 message = gst_message_new_stream_status (GST_OBJECT (pulsesink),
1142 GST_STREAM_STATUS_TYPE_ENTER, GST_ELEMENT (pulsesink));
1143 gst_message_set_stream_status_object (message, &val);
1145 gst_element_post_message (GST_ELEMENT (pulsesink), message);
1147 g_return_if_fail (pulsesink->defer_pending);
1148 pulsesink->defer_pending--;
1149 pa_threaded_mainloop_signal (mainloop, 0);
1152 /* start/resume playback ASAP, we don't uncork here but in the commit method */
1154 gst_pulseringbuffer_start (GstRingBuffer * buf)
1156 GstPulseSink *psink;
1157 GstPulseRingBuffer *pbuf;
1159 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1160 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1162 pa_threaded_mainloop_lock (mainloop);
1164 GST_DEBUG_OBJECT (psink, "scheduling stream status");
1165 psink->defer_pending++;
1166 pa_mainloop_api_once (pa_threaded_mainloop_get_api (mainloop),
1167 mainloop_enter_defer_cb, psink);
1169 GST_DEBUG_OBJECT (psink, "starting");
1170 pbuf->paused = FALSE;
1172 /* EOS needs running clock */
1173 if (GST_BASE_SINK_CAST (psink)->eos ||
1174 g_atomic_int_get (&GST_BASE_AUDIO_SINK (psink)->abidata.
1176 gst_pulsering_set_corked (pbuf, FALSE, FALSE);
1178 pa_threaded_mainloop_unlock (mainloop);
1183 /* pause/stop playback ASAP */
1185 gst_pulseringbuffer_pause (GstRingBuffer * buf)
1187 GstPulseSink *psink;
1188 GstPulseRingBuffer *pbuf;
1191 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1192 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1194 pa_threaded_mainloop_lock (mainloop);
1195 GST_DEBUG_OBJECT (psink, "pausing and corking");
1196 /* make sure the commit method stops writing */
1197 pbuf->paused = TRUE;
1198 res = gst_pulsering_set_corked (pbuf, TRUE, TRUE);
1199 if (pbuf->in_commit) {
1200 /* we are waiting in a commit, signal */
1201 GST_DEBUG_OBJECT (psink, "signal commit");
1202 pa_threaded_mainloop_signal (mainloop, 0);
1204 pa_threaded_mainloop_unlock (mainloop);
1209 /* called from pulse with the mainloop lock */
1211 mainloop_leave_defer_cb (pa_mainloop_api * api, void *userdata)
1213 GstPulseSink *pulsesink = GST_PULSESINK (userdata);
1214 GstMessage *message;
1217 g_value_init (&val, G_TYPE_POINTER);
1218 g_value_set_pointer (&val, g_thread_self ());
1220 GST_DEBUG_OBJECT (pulsesink, "posting LEAVE stream status");
1221 message = gst_message_new_stream_status (GST_OBJECT (pulsesink),
1222 GST_STREAM_STATUS_TYPE_LEAVE, GST_ELEMENT (pulsesink));
1223 gst_message_set_stream_status_object (message, &val);
1224 gst_element_post_message (GST_ELEMENT (pulsesink), message);
1226 g_return_if_fail (pulsesink->defer_pending);
1227 pulsesink->defer_pending--;
1228 pa_threaded_mainloop_signal (mainloop, 0);
1231 /* stop playback, we flush everything. */
1233 gst_pulseringbuffer_stop (GstRingBuffer * buf)
1235 GstPulseSink *psink;
1236 GstPulseRingBuffer *pbuf;
1237 gboolean res = FALSE;
1238 pa_operation *o = NULL;
1240 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1241 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1243 pa_threaded_mainloop_lock (mainloop);
1245 pbuf->paused = TRUE;
1246 res = gst_pulsering_set_corked (pbuf, TRUE, TRUE);
1248 /* Inform anyone waiting in _commit() call that it shall wakeup */
1249 if (pbuf->in_commit) {
1250 GST_DEBUG_OBJECT (psink, "signal commit thread");
1251 pa_threaded_mainloop_signal (mainloop, 0);
1253 #ifdef HAVE_PULSE_1_0
1254 if (g_atomic_int_get (&psink->format_lost)) {
1255 /* Don't try to flush, the stream's probably gone by now */
1261 /* then try to flush, it's not fatal when this fails */
1262 GST_DEBUG_OBJECT (psink, "flushing");
1263 if ((o = pa_stream_flush (pbuf->stream, gst_pulsering_success_cb, pbuf))) {
1264 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
1265 GST_DEBUG_OBJECT (psink, "wait for completion");
1266 pa_threaded_mainloop_wait (mainloop);
1267 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1270 GST_DEBUG_OBJECT (psink, "flush completed");
1276 pa_operation_cancel (o);
1277 pa_operation_unref (o);
1280 GST_DEBUG_OBJECT (psink, "scheduling stream status");
1281 psink->defer_pending++;
1282 pa_mainloop_api_once (pa_threaded_mainloop_get_api (mainloop),
1283 mainloop_leave_defer_cb, psink);
1285 pa_threaded_mainloop_unlock (mainloop);
1292 GST_DEBUG_OBJECT (psink, "the server is dead");
1297 /* in_samples >= out_samples, rate > 1.0 */
1298 #define FWD_UP_SAMPLES(s,se,d,de) \
1300 guint8 *sb = s, *db = d; \
1301 while (s <= se && d < de) { \
1302 memcpy (d, s, bps); \
1305 if ((*accum << 1) >= inr) { \
1310 in_samples -= (s - sb)/bps; \
1311 out_samples -= (d - db)/bps; \
1312 GST_DEBUG ("fwd_up end %d/%d",*accum,*toprocess); \
1315 /* out_samples > in_samples, for rates smaller than 1.0 */
1316 #define FWD_DOWN_SAMPLES(s,se,d,de) \
1318 guint8 *sb = s, *db = d; \
1319 while (s <= se && d < de) { \
1320 memcpy (d, s, bps); \
1323 if ((*accum << 1) >= outr) { \
1328 in_samples -= (s - sb)/bps; \
1329 out_samples -= (d - db)/bps; \
1330 GST_DEBUG ("fwd_down end %d/%d",*accum,*toprocess); \
1333 #define REV_UP_SAMPLES(s,se,d,de) \
1335 guint8 *sb = se, *db = d; \
1336 while (s <= se && d < de) { \
1337 memcpy (d, se, bps); \
1340 while (d < de && (*accum << 1) >= inr) { \
1345 in_samples -= (sb - se)/bps; \
1346 out_samples -= (d - db)/bps; \
1347 GST_DEBUG ("rev_up end %d/%d",*accum,*toprocess); \
1350 #define REV_DOWN_SAMPLES(s,se,d,de) \
1352 guint8 *sb = se, *db = d; \
1353 while (s <= se && d < de) { \
1354 memcpy (d, se, bps); \
1357 while (s <= se && (*accum << 1) >= outr) { \
1362 in_samples -= (sb - se)/bps; \
1363 out_samples -= (d - db)/bps; \
1364 GST_DEBUG ("rev_down end %d/%d",*accum,*toprocess); \
1367 /* our custom commit function because we write into the buffer of pulseaudio
1368 * instead of keeping our own buffer */
1370 gst_pulseringbuffer_commit (GstRingBuffer * buf, guint64 * sample,
1371 guchar * data, gint in_samples, gint out_samples, gint * accum)
1373 GstPulseSink *psink;
1374 GstPulseRingBuffer *pbuf;
1379 gint inr, outr, bps;
1383 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1384 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1386 /* FIXME post message rather than using a signal (as mixer interface) */
1387 if (g_atomic_int_compare_and_exchange (&psink->notify, 1, 0)) {
1388 g_object_notify (G_OBJECT (psink), "volume");
1389 g_object_notify (G_OBJECT (psink), "mute");
1392 /* make sure the ringbuffer is started */
1393 if (G_UNLIKELY (g_atomic_int_get (&buf->state) !=
1394 GST_RING_BUFFER_STATE_STARTED)) {
1395 /* see if we are allowed to start it */
1396 if (G_UNLIKELY (g_atomic_int_get (&buf->abidata.ABI.may_start) == FALSE))
1399 GST_DEBUG_OBJECT (buf, "start!");
1400 if (!gst_ring_buffer_start (buf))
1404 pa_threaded_mainloop_lock (mainloop);
1406 GST_DEBUG_OBJECT (psink, "entering commit");
1407 pbuf->in_commit = TRUE;
1409 bps = buf->spec.bytes_per_sample;
1410 bufsize = buf->spec.segsize * buf->spec.segtotal;
1412 /* our toy resampler for trick modes */
1413 reverse = out_samples < 0;
1414 out_samples = ABS (out_samples);
1416 if (in_samples >= out_samples)
1417 toprocess = &in_samples;
1419 toprocess = &out_samples;
1421 inr = in_samples - 1;
1422 outr = out_samples - 1;
1424 GST_DEBUG_OBJECT (psink, "in %d, out %d", inr, outr);
1426 /* data_end points to the last sample we have to write, not past it. This is
1427 * needed to properly handle reverse playback: it points to the last sample. */
1428 data_end = data + (bps * inr);
1430 #ifdef HAVE_PULSE_1_0
1431 if (g_atomic_int_get (&psink->format_lost)) {
1432 /* Sink format changed, drop the data and hope upstream renegotiates */
1440 /* offset is in bytes */
1441 offset = *sample * bps;
1443 while (*toprocess > 0) {
1447 GST_LOG_OBJECT (psink,
1448 "need to write %d samples at offset %" G_GINT64_FORMAT, *toprocess,
1451 if (offset != pbuf->m_lastoffset)
1452 GST_LOG_OBJECT (psink, "discontinuity, offset is %" G_GINT64_FORMAT ", "
1453 "last offset was %" G_GINT64_FORMAT, offset, pbuf->m_lastoffset);
1455 towrite = out_samples * bps;
1457 /* Wait for at least segsize bytes to become available */
1458 if (towrite > buf->spec.segsize)
1459 towrite = buf->spec.segsize;
1461 if ((pbuf->m_writable < towrite) || (offset != pbuf->m_lastoffset)) {
1462 /* if no room left or discontinuity in offset,
1463 we need to flush data and get a new buffer */
1465 /* flush the buffer if possible */
1466 if ((pbuf->m_data != NULL) && (pbuf->m_towrite > 0)) {
1468 GST_LOG_OBJECT (psink,
1469 "flushing %u samples at offset %" G_GINT64_FORMAT,
1470 (guint) pbuf->m_towrite / bps, pbuf->m_offset);
1472 if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1473 pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1477 pbuf->m_towrite = 0;
1478 pbuf->m_offset = offset; /* keep track of current offset */
1480 /* get a buffer to write in for now on */
1482 pbuf->m_writable = pa_stream_writable_size (pbuf->stream);
1484 #ifdef HAVE_PULSE_1_0
1485 if (g_atomic_int_get (&psink->format_lost)) {
1486 /* Sink format changed, give up and hope upstream renegotiates */
1491 if (pbuf->m_writable == (size_t) - 1)
1492 goto writable_size_failed;
1494 pbuf->m_writable /= bps;
1495 pbuf->m_writable *= bps; /* handle only complete samples */
1497 if (pbuf->m_writable >= towrite)
1500 /* see if we need to uncork because we have no free space */
1502 if (!gst_pulsering_set_corked (pbuf, FALSE, FALSE))
1506 /* we can't write segsize bytes, wait a bit */
1507 GST_LOG_OBJECT (psink, "waiting for free space");
1508 pa_threaded_mainloop_wait (mainloop);
1514 /* Recalculate what we can write in the next chunk */
1515 towrite = out_samples * bps;
1516 if (pbuf->m_writable > towrite)
1517 pbuf->m_writable = towrite;
1519 GST_LOG_OBJECT (psink, "requesting %" G_GSIZE_FORMAT " bytes of "
1520 "shared memory", pbuf->m_writable);
1522 if (pa_stream_begin_write (pbuf->stream, &pbuf->m_data,
1523 &pbuf->m_writable) < 0) {
1524 GST_LOG_OBJECT (psink, "pa_stream_begin_write() failed");
1525 goto writable_size_failed;
1528 GST_LOG_OBJECT (psink, "got %" G_GSIZE_FORMAT " bytes of shared memory",
1533 if (towrite > pbuf->m_writable)
1534 towrite = pbuf->m_writable;
1535 avail = towrite / bps;
1537 GST_LOG_OBJECT (psink, "writing %u samples at offset %" G_GUINT64_FORMAT,
1538 (guint) avail, offset);
1540 #ifdef HAVE_PULSE_1_0
1541 /* No trick modes for passthrough streams */
1542 if (G_UNLIKELY (!pbuf->is_pcm && (inr != outr || reverse))) {
1543 GST_WARNING_OBJECT (psink, "Passthrough stream can't run in trick mode");
1544 goto unlock_and_fail;
1548 if (G_LIKELY (inr == outr && !reverse)) {
1549 /* no rate conversion, simply write out the samples */
1550 /* copy the data into internal buffer */
1552 memcpy ((guint8 *) pbuf->m_data + pbuf->m_towrite, data, towrite);
1553 pbuf->m_towrite += towrite;
1554 pbuf->m_writable -= towrite;
1557 in_samples -= avail;
1558 out_samples -= avail;
1560 guint8 *dest, *d, *d_end;
1562 /* write into the PulseAudio shm buffer */
1563 dest = d = (guint8 *) pbuf->m_data + pbuf->m_towrite;
1564 d_end = d + towrite;
1568 /* forward speed up */
1569 FWD_UP_SAMPLES (data, data_end, d, d_end);
1571 /* forward slow down */
1572 FWD_DOWN_SAMPLES (data, data_end, d, d_end);
1575 /* reverse speed up */
1576 REV_UP_SAMPLES (data, data_end, d, d_end);
1578 /* reverse slow down */
1579 REV_DOWN_SAMPLES (data, data_end, d, d_end);
1581 /* see what we have left to write */
1582 towrite = (d - dest);
1583 pbuf->m_towrite += towrite;
1584 pbuf->m_writable -= towrite;
1586 avail = towrite / bps;
1589 /* flush the buffer if it's full */
1590 if ((pbuf->m_data != NULL) && (pbuf->m_towrite > 0)
1591 && (pbuf->m_writable == 0)) {
1592 GST_LOG_OBJECT (psink, "flushing %u samples at offset %" G_GINT64_FORMAT,
1593 (guint) pbuf->m_towrite / bps, pbuf->m_offset);
1595 if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1596 pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1599 pbuf->m_towrite = 0;
1600 pbuf->m_offset = offset + towrite; /* keep track of current offset */
1604 offset += avail * bps;
1605 pbuf->m_lastoffset = offset;
1607 /* check if we need to uncork after writing the samples */
1609 const pa_timing_info *info;
1611 if ((info = pa_stream_get_timing_info (pbuf->stream))) {
1612 GST_LOG_OBJECT (psink,
1613 "read_index at %" G_GUINT64_FORMAT ", offset %" G_GINT64_FORMAT,
1614 info->read_index, offset);
1616 /* we uncork when the read_index is too far behind the offset we need
1618 if (info->read_index + bufsize <= offset) {
1619 if (!gst_pulsering_set_corked (pbuf, FALSE, FALSE))
1623 GST_LOG_OBJECT (psink, "no timing info available yet");
1628 #ifdef HAVE_PULSE_1_0
1631 /* we consumed all samples here */
1632 data = data_end + bps;
1634 pbuf->in_commit = FALSE;
1635 pa_threaded_mainloop_unlock (mainloop);
1638 result = inr - ((data_end - data) / bps);
1639 GST_LOG_OBJECT (psink, "wrote %d samples", result);
1646 pbuf->in_commit = FALSE;
1647 GST_LOG_OBJECT (psink, "we are reset");
1648 pa_threaded_mainloop_unlock (mainloop);
1653 GST_LOG_OBJECT (psink, "we can not start");
1658 GST_LOG_OBJECT (psink, "failed to start the ringbuffer");
1663 pbuf->in_commit = FALSE;
1664 GST_ERROR_OBJECT (psink, "uncork failed");
1665 pa_threaded_mainloop_unlock (mainloop);
1670 pbuf->in_commit = FALSE;
1671 GST_LOG_OBJECT (psink, "we are paused");
1672 pa_threaded_mainloop_unlock (mainloop);
1675 writable_size_failed:
1677 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1678 ("pa_stream_writable_size() failed: %s",
1679 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1680 goto unlock_and_fail;
1684 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1685 ("pa_stream_write() failed: %s",
1686 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1687 goto unlock_and_fail;
1691 /* write pending local samples, must be called with the mainloop lock */
1693 gst_pulsering_flush (GstPulseRingBuffer * pbuf)
1695 GstPulseSink *psink;
1697 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1698 GST_DEBUG_OBJECT (psink, "entering flush");
1700 /* flush the buffer if possible */
1701 if (pbuf->stream && (pbuf->m_data != NULL) && (pbuf->m_towrite > 0)) {
1702 #ifndef GST_DISABLE_GST_DEBUG
1705 bps = (GST_RING_BUFFER_CAST (pbuf))->spec.bytes_per_sample;
1706 GST_LOG_OBJECT (psink,
1707 "flushing %u samples at offset %" G_GINT64_FORMAT,
1708 (guint) pbuf->m_towrite / bps, pbuf->m_offset);
1711 if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1712 pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1716 pbuf->m_towrite = 0;
1717 pbuf->m_offset += pbuf->m_towrite; /* keep track of current offset */
1726 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1727 ("pa_stream_write() failed: %s",
1728 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1733 static void gst_pulsesink_set_property (GObject * object, guint prop_id,
1734 const GValue * value, GParamSpec * pspec);
1735 static void gst_pulsesink_get_property (GObject * object, guint prop_id,
1736 GValue * value, GParamSpec * pspec);
1737 static void gst_pulsesink_finalize (GObject * object);
1739 static gboolean gst_pulsesink_event (GstBaseSink * sink, GstEvent * event);
1741 static GstStateChangeReturn gst_pulsesink_change_state (GstElement * element,
1742 GstStateChange transition);
1744 static void gst_pulsesink_init_interfaces (GType type);
1746 GST_IMPLEMENT_PULSEPROBE_METHODS (GstPulseSink, gst_pulsesink);
1748 #define _do_init(type) \
1749 gst_pulsesink_init_contexts (); \
1750 gst_pulsesink_init_interfaces (type);
1752 GST_BOILERPLATE_FULL (GstPulseSink, gst_pulsesink, GstBaseAudioSink,
1753 GST_TYPE_BASE_AUDIO_SINK, _do_init);
1756 gst_pulsesink_interface_supported (GstImplementsInterface *
1757 iface, GType interface_type)
1759 GstPulseSink *this = GST_PULSESINK_CAST (iface);
1761 if (interface_type == GST_TYPE_PROPERTY_PROBE && this->probe)
1763 if (interface_type == GST_TYPE_STREAM_VOLUME)
1770 gst_pulsesink_implements_interface_init (GstImplementsInterfaceClass * klass)
1772 klass->supported = gst_pulsesink_interface_supported;
1776 gst_pulsesink_init_interfaces (GType type)
1778 static const GInterfaceInfo implements_iface_info = {
1779 (GInterfaceInitFunc) gst_pulsesink_implements_interface_init,
1783 static const GInterfaceInfo probe_iface_info = {
1784 (GInterfaceInitFunc) gst_pulsesink_property_probe_interface_init,
1788 static const GInterfaceInfo svol_iface_info = {
1792 g_type_add_interface_static (type, GST_TYPE_STREAM_VOLUME, &svol_iface_info);
1793 g_type_add_interface_static (type, GST_TYPE_IMPLEMENTS_INTERFACE,
1794 &implements_iface_info);
1795 g_type_add_interface_static (type, GST_TYPE_PROPERTY_PROBE,
1800 gst_pulsesink_base_init (gpointer g_class)
1802 static GstStaticPadTemplate pad_template = GST_STATIC_PAD_TEMPLATE ("sink",
1805 GST_STATIC_CAPS (PULSE_SINK_TEMPLATE_CAPS));
1807 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
1809 gst_element_class_set_details_simple (element_class,
1810 "PulseAudio Audio Sink",
1811 "Sink/Audio", "Plays audio to a PulseAudio server", "Lennart Poettering");
1812 gst_element_class_add_static_pad_template (element_class, &pad_template);
1815 static GstRingBuffer *
1816 gst_pulsesink_create_ringbuffer (GstBaseAudioSink * sink)
1818 GstRingBuffer *buffer;
1820 GST_DEBUG_OBJECT (sink, "creating ringbuffer");
1821 buffer = g_object_new (GST_TYPE_PULSERING_BUFFER, NULL);
1822 GST_DEBUG_OBJECT (sink, "created ringbuffer @%p", buffer);
1828 gst_pulsesink_payload (GstBaseAudioSink * sink, GstBuffer * buf)
1830 switch (sink->ringbuffer->spec.type) {
1831 case GST_BUFTYPE_AC3:
1832 case GST_BUFTYPE_EAC3:
1833 case GST_BUFTYPE_DTS:
1834 case GST_BUFTYPE_MPEG:
1836 /* FIXME: alloc memory from PA if possible */
1837 gint framesize = gst_audio_iec61937_frame_size (&sink->ringbuffer->spec);
1843 out = gst_buffer_new_and_alloc (framesize);
1845 if (!gst_audio_iec61937_payload (GST_BUFFER_DATA (buf),
1846 GST_BUFFER_SIZE (buf), GST_BUFFER_DATA (out),
1847 GST_BUFFER_SIZE (out), &sink->ringbuffer->spec)) {
1848 gst_buffer_unref (out);
1852 gst_buffer_copy_metadata (out, buf, GST_BUFFER_COPY_ALL);
1857 return gst_buffer_ref (buf);
1862 gst_pulsesink_class_init (GstPulseSinkClass * klass)
1864 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
1865 GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
1866 GstBaseSinkClass *bc;
1867 GstBaseAudioSinkClass *gstaudiosink_class = GST_BASE_AUDIO_SINK_CLASS (klass);
1868 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
1871 gobject_class->finalize = gst_pulsesink_finalize;
1872 gobject_class->set_property = gst_pulsesink_set_property;
1873 gobject_class->get_property = gst_pulsesink_get_property;
1875 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_pulsesink_event);
1877 /* restore the original basesink pull methods */
1878 bc = g_type_class_peek (GST_TYPE_BASE_SINK);
1879 gstbasesink_class->activate_pull = GST_DEBUG_FUNCPTR (bc->activate_pull);
1881 gstelement_class->change_state =
1882 GST_DEBUG_FUNCPTR (gst_pulsesink_change_state);
1884 gstaudiosink_class->create_ringbuffer =
1885 GST_DEBUG_FUNCPTR (gst_pulsesink_create_ringbuffer);
1886 gstaudiosink_class->payload = GST_DEBUG_FUNCPTR (gst_pulsesink_payload);
1888 /* Overwrite GObject fields */
1889 g_object_class_install_property (gobject_class,
1891 g_param_spec_string ("server", "Server",
1892 "The PulseAudio server to connect to", DEFAULT_SERVER,
1893 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1895 g_object_class_install_property (gobject_class, PROP_DEVICE,
1896 g_param_spec_string ("device", "Device",
1897 "The PulseAudio sink device to connect to", DEFAULT_DEVICE,
1898 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1900 g_object_class_install_property (gobject_class,
1902 g_param_spec_string ("device-name", "Device name",
1903 "Human-readable name of the sound device", DEFAULT_DEVICE_NAME,
1904 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1906 g_object_class_install_property (gobject_class,
1908 g_param_spec_double ("volume", "Volume",
1909 "Linear volume of this stream, 1.0=100%", 0.0, MAX_VOLUME,
1910 DEFAULT_VOLUME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1911 g_object_class_install_property (gobject_class,
1913 g_param_spec_boolean ("mute", "Mute",
1914 "Mute state of this stream", DEFAULT_MUTE,
1915 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1918 * GstPulseSink:client
1920 * The PulseAudio client name to use.
1924 clientname = gst_pulse_client_name ();
1925 g_object_class_install_property (gobject_class,
1927 g_param_spec_string ("client", "Client",
1928 "The PulseAudio client name to use", clientname,
1929 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
1930 GST_PARAM_MUTABLE_READY));
1931 g_free (clientname);
1934 * GstPulseSink:stream-properties
1936 * List of pulseaudio stream properties. A list of defined properties can be
1937 * found in the <ulink url="http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html">pulseaudio api docs</ulink>.
1939 * Below is an example for registering as a music application to pulseaudio.
1941 * GstStructure *props;
1943 * props = gst_structure_from_string ("props,media.role=music", NULL);
1944 * g_object_set (pulse, "stream-properties", props, NULL);
1945 * gst_structure_free
1950 g_object_class_install_property (gobject_class,
1951 PROP_STREAM_PROPERTIES,
1952 g_param_spec_boxed ("stream-properties", "stream properties",
1953 "list of pulseaudio stream properties",
1954 GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1957 /* returns the current time of the sink ringbuffer */
1959 gst_pulsesink_get_time (GstClock * clock, GstBaseAudioSink * sink)
1961 GstPulseSink *psink;
1962 GstPulseRingBuffer *pbuf;
1965 if (!sink->ringbuffer || !sink->ringbuffer->acquired)
1966 return GST_CLOCK_TIME_NONE;
1968 pbuf = GST_PULSERING_BUFFER_CAST (sink->ringbuffer);
1969 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1971 #ifdef HAVE_PULSE_1_0
1972 if (g_atomic_int_get (&psink->format_lost)) {
1973 /* Stream was lost in a format change, it'll get set up again once
1974 * upstream renegotiates */
1975 return psink->format_lost_time;
1979 pa_threaded_mainloop_lock (mainloop);
1980 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1983 /* if we don't have enough data to get a timestamp, just return NONE, which
1984 * will return the last reported time */
1985 if (pa_stream_get_time (pbuf->stream, &time) < 0) {
1986 GST_DEBUG_OBJECT (psink, "could not get time");
1987 time = GST_CLOCK_TIME_NONE;
1990 pa_threaded_mainloop_unlock (mainloop);
1992 GST_LOG_OBJECT (psink, "current time is %" GST_TIME_FORMAT,
1993 GST_TIME_ARGS (time));
2000 GST_DEBUG_OBJECT (psink, "the server is dead");
2001 pa_threaded_mainloop_unlock (mainloop);
2003 return GST_CLOCK_TIME_NONE;
2008 gst_pulsesink_sink_info_cb (pa_context * c, const pa_sink_info * i, int eol,
2011 GstPulseRingBuffer *pbuf;
2012 GstPulseSink *psink;
2013 #ifdef HAVE_PULSE_1_0
2018 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
2019 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
2024 g_free (psink->device_description);
2025 psink->device_description = g_strdup (i->description);
2027 #ifdef HAVE_PULSE_1_0
2028 g_mutex_lock (psink->sink_formats_lock);
2030 for (l = g_list_first (psink->sink_formats); l; l = g_list_next (l))
2031 pa_format_info_free ((pa_format_info *) l->data);
2033 g_list_free (psink->sink_formats);
2034 psink->sink_formats = NULL;
2036 for (j = 0; j < i->n_formats; j++)
2037 psink->sink_formats = g_list_prepend (psink->sink_formats,
2038 pa_format_info_copy (i->formats[j]));
2040 g_mutex_unlock (psink->sink_formats_lock);
2044 pa_threaded_mainloop_signal (mainloop, 0);
2047 #ifdef HAVE_PULSE_1_0
2048 /* NOTE: If you're making changes here, see if pulseaudiosink acceptcaps also
2049 * needs to be changed accordingly. */
2051 gst_pulsesink_pad_acceptcaps (GstPad * pad, GstCaps * caps)
2053 GstPulseSink *psink = GST_PULSESINK (gst_pad_get_parent_element (pad));
2054 GstPulseRingBuffer *pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK
2055 (psink)->ringbuffer);
2058 gboolean ret = FALSE;
2060 GstRingBufferSpec spec = { 0 };
2061 pa_stream *stream = NULL;
2062 pa_operation *o = NULL;
2063 pa_channel_map channel_map;
2064 pa_stream_flags_t flags;
2065 pa_format_info *format = NULL, *formats[1];
2068 pad_caps = gst_pad_get_caps_reffed (pad);
2070 ret = gst_caps_can_intersect (pad_caps, caps);
2071 gst_caps_unref (pad_caps);
2074 /* Either template caps didn't match, or we're still in NULL state */
2075 if (!ret || !pbuf->context)
2078 /* If we've not got fixed caps, creating a stream might fail, so let's just
2079 * return from here with default acceptcaps behaviour */
2080 if (!gst_caps_is_fixed (caps))
2085 pa_threaded_mainloop_lock (mainloop);
2087 spec.latency_time = GST_BASE_AUDIO_SINK (psink)->latency_time;
2088 if (!gst_ring_buffer_parse_caps (&spec, caps))
2091 if (!gst_pulse_fill_format_info (&spec, &format, &channels))
2094 /* Make sure input is framed (one frame per buffer) and can be payloaded */
2095 if (!pa_format_info_is_pcm (format)) {
2096 gboolean framed = FALSE, parsed = FALSE;
2097 st = gst_caps_get_structure (caps, 0);
2099 gst_structure_get_boolean (st, "framed", &framed);
2100 gst_structure_get_boolean (st, "parsed", &parsed);
2101 if ((!framed && !parsed) || gst_audio_iec61937_frame_size (&spec) <= 0)
2105 /* initialize the channel map */
2106 if (pa_format_info_is_pcm (format) &&
2107 gst_pulse_gst_to_channel_map (&channel_map, &spec))
2108 pa_format_info_set_channel_map (format, &channel_map);
2111 /* We're already in PAUSED or above, so just reuse this stream to query
2112 * sink formats and use those. */
2115 if (!(o = pa_context_get_sink_info_by_name (pbuf->context, psink->device,
2116 gst_pulsesink_sink_info_cb, pbuf)))
2119 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2120 pa_threaded_mainloop_wait (mainloop);
2121 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2125 g_mutex_lock (psink->sink_formats_lock);
2126 for (i = g_list_first (psink->sink_formats); i; i = g_list_next (i)) {
2127 if (pa_format_info_is_compatible ((pa_format_info *) i->data, format)) {
2132 g_mutex_unlock (psink->sink_formats_lock);
2134 /* We're in READY, let's connect a stream to see if the format is
2135 * accpeted by whatever sink we're routed to */
2136 formats[0] = format;
2138 if (!(stream = pa_stream_new_extended (pbuf->context, "pulsesink probe",
2139 formats, 1, psink->proplist)))
2142 /* construct the flags */
2143 flags = PA_STREAM_INTERPOLATE_TIMING | PA_STREAM_AUTO_TIMING_UPDATE |
2144 PA_STREAM_ADJUST_LATENCY | PA_STREAM_START_CORKED;
2146 pa_stream_set_state_callback (stream, gst_pulsering_stream_state_cb, pbuf);
2148 if (pa_stream_connect_playback (stream, psink->device, NULL, flags, NULL,
2152 ret = gst_pulsering_wait_for_stream_ready (psink, stream);
2157 pa_format_info_free (format);
2160 pa_operation_unref (o);
2163 pa_stream_set_state_callback (stream, NULL, NULL);
2164 pa_stream_disconnect (stream);
2165 pa_stream_unref (stream);
2168 pa_threaded_mainloop_unlock (mainloop);
2171 gst_object_unref (psink);
2176 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2177 ("pa_context_get_sink_input_info() failed: %s",
2178 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2185 gst_pulsesink_init (GstPulseSink * pulsesink, GstPulseSinkClass * klass)
2187 pulsesink->server = NULL;
2188 pulsesink->device = NULL;
2189 pulsesink->device_description = NULL;
2190 pulsesink->client_name = gst_pulse_client_name ();
2192 #ifdef HAVE_PULSE_1_0
2193 pulsesink->sink_formats_lock = g_mutex_new ();
2194 pulsesink->sink_formats = NULL;
2197 pulsesink->volume = DEFAULT_VOLUME;
2198 pulsesink->volume_set = FALSE;
2200 pulsesink->mute = DEFAULT_MUTE;
2201 pulsesink->mute_set = FALSE;
2203 pulsesink->notify = 0;
2205 #ifdef HAVE_PULSE_1_0
2206 g_atomic_int_set (&pulsesink->format_lost, FALSE);
2207 pulsesink->format_lost_time = GST_CLOCK_TIME_NONE;
2210 pulsesink->properties = NULL;
2211 pulsesink->proplist = NULL;
2213 /* override with a custom clock */
2214 if (GST_BASE_AUDIO_SINK (pulsesink)->provided_clock)
2215 gst_object_unref (GST_BASE_AUDIO_SINK (pulsesink)->provided_clock);
2217 GST_BASE_AUDIO_SINK (pulsesink)->provided_clock =
2218 gst_audio_clock_new ("GstPulseSinkClock",
2219 (GstAudioClockGetTimeFunc) gst_pulsesink_get_time, pulsesink);
2221 #ifdef HAVE_PULSE_1_0
2222 gst_pad_set_acceptcaps_function (GST_BASE_SINK (pulsesink)->sinkpad,
2223 GST_DEBUG_FUNCPTR (gst_pulsesink_pad_acceptcaps));
2226 /* TRUE for sinks, FALSE for sources */
2227 pulsesink->probe = gst_pulseprobe_new (G_OBJECT (pulsesink),
2228 G_OBJECT_GET_CLASS (pulsesink), PROP_DEVICE, pulsesink->device,
2233 gst_pulsesink_finalize (GObject * object)
2235 GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2236 #ifdef HAVE_PULSE_1_0
2240 g_free (pulsesink->server);
2241 g_free (pulsesink->device);
2242 g_free (pulsesink->device_description);
2243 g_free (pulsesink->client_name);
2245 #ifdef HAVE_PULSE_1_0
2246 for (i = g_list_first (pulsesink->sink_formats); i; i = g_list_next (i))
2247 pa_format_info_free ((pa_format_info *) i->data);
2249 g_list_free (pulsesink->sink_formats);
2250 g_mutex_free (pulsesink->sink_formats_lock);
2253 if (pulsesink->properties)
2254 gst_structure_free (pulsesink->properties);
2255 if (pulsesink->proplist)
2256 pa_proplist_free (pulsesink->proplist);
2258 if (pulsesink->probe) {
2259 gst_pulseprobe_free (pulsesink->probe);
2260 pulsesink->probe = NULL;
2263 G_OBJECT_CLASS (parent_class)->finalize (object);
2267 gst_pulsesink_set_volume (GstPulseSink * psink, gdouble volume)
2270 pa_operation *o = NULL;
2271 GstPulseRingBuffer *pbuf;
2277 pa_threaded_mainloop_lock (mainloop);
2279 GST_DEBUG_OBJECT (psink, "setting volume to %f", volume);
2281 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2282 if (pbuf == NULL || pbuf->stream == NULL)
2285 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2288 #ifdef HAVE_PULSE_1_0
2290 gst_pulse_cvolume_from_linear (&v, pbuf->channels, volume);
2292 /* FIXME: this will eventually be superceded by checks to see if the volume
2293 * is readable/writable */
2296 gst_pulse_cvolume_from_linear (&v, pbuf->sample_spec.channels, volume);
2299 if (!(o = pa_context_set_sink_input_volume (pbuf->context, idx,
2303 /* We don't really care about the result of this call */
2307 pa_operation_unref (o);
2309 pa_threaded_mainloop_unlock (mainloop);
2316 psink->volume = volume;
2317 psink->volume_set = TRUE;
2319 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2324 psink->volume = volume;
2325 psink->volume_set = TRUE;
2327 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2332 GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2337 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2338 ("pa_stream_set_sink_input_volume() failed: %s",
2339 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2345 gst_pulsesink_set_mute (GstPulseSink * psink, gboolean mute)
2347 pa_operation *o = NULL;
2348 GstPulseRingBuffer *pbuf;
2354 pa_threaded_mainloop_lock (mainloop);
2356 GST_DEBUG_OBJECT (psink, "setting mute state to %d", mute);
2358 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2359 if (pbuf == NULL || pbuf->stream == NULL)
2362 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2365 if (!(o = pa_context_set_sink_input_mute (pbuf->context, idx,
2369 /* We don't really care about the result of this call */
2373 pa_operation_unref (o);
2375 pa_threaded_mainloop_unlock (mainloop);
2383 psink->mute_set = TRUE;
2385 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2391 psink->mute_set = TRUE;
2393 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2398 GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2403 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2404 ("pa_stream_set_sink_input_mute() failed: %s",
2405 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2411 gst_pulsesink_sink_input_info_cb (pa_context * c, const pa_sink_input_info * i,
2412 int eol, void *userdata)
2414 GstPulseRingBuffer *pbuf;
2415 GstPulseSink *psink;
2417 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
2418 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
2426 /* If the index doesn't match our current stream,
2427 * it implies we just recreated the stream (caps change)
2429 if (i->index == pa_stream_get_index (pbuf->stream)) {
2430 psink->volume = pa_sw_volume_to_linear (pa_cvolume_max (&i->volume));
2431 psink->mute = i->mute;
2435 pa_threaded_mainloop_signal (mainloop, 0);
2439 gst_pulsesink_get_volume (GstPulseSink * psink)
2441 GstPulseRingBuffer *pbuf;
2442 pa_operation *o = NULL;
2443 gdouble v = DEFAULT_VOLUME;
2449 pa_threaded_mainloop_lock (mainloop);
2451 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2452 if (pbuf == NULL || pbuf->stream == NULL)
2455 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2458 if (!(o = pa_context_get_sink_input_info (pbuf->context, idx,
2459 gst_pulsesink_sink_input_info_cb, pbuf)))
2462 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2463 pa_threaded_mainloop_wait (mainloop);
2464 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2472 pa_operation_unref (o);
2474 pa_threaded_mainloop_unlock (mainloop);
2476 if (v > MAX_VOLUME) {
2477 GST_WARNING_OBJECT (psink, "Clipped volume from %f to %f", v, MAX_VOLUME);
2487 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2492 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2497 GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2502 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2503 ("pa_context_get_sink_input_info() failed: %s",
2504 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2510 gst_pulsesink_get_mute (GstPulseSink * psink)
2512 GstPulseRingBuffer *pbuf;
2513 pa_operation *o = NULL;
2515 gboolean mute = FALSE;
2520 pa_threaded_mainloop_lock (mainloop);
2523 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2524 if (pbuf == NULL || pbuf->stream == NULL)
2527 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2530 if (!(o = pa_context_get_sink_input_info (pbuf->context, idx,
2531 gst_pulsesink_sink_input_info_cb, pbuf)))
2534 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2535 pa_threaded_mainloop_wait (mainloop);
2536 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2542 pa_operation_unref (o);
2544 pa_threaded_mainloop_unlock (mainloop);
2552 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2557 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2562 GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2567 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2568 ("pa_context_get_sink_input_info() failed: %s",
2569 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2575 gst_pulsesink_device_description (GstPulseSink * psink)
2577 GstPulseRingBuffer *pbuf;
2578 pa_operation *o = NULL;
2584 pa_threaded_mainloop_lock (mainloop);
2585 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2589 if (!(o = pa_context_get_sink_info_by_name (pbuf->context,
2590 psink->device, gst_pulsesink_sink_info_cb, pbuf)))
2593 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2594 pa_threaded_mainloop_wait (mainloop);
2595 if (gst_pulsering_is_dead (psink, pbuf, FALSE))
2601 pa_operation_unref (o);
2603 t = g_strdup (psink->device_description);
2604 pa_threaded_mainloop_unlock (mainloop);
2611 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2616 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2621 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2622 ("pa_context_get_sink_info_by_index() failed: %s",
2623 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2629 gst_pulsesink_set_property (GObject * object,
2630 guint prop_id, const GValue * value, GParamSpec * pspec)
2632 GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2636 g_free (pulsesink->server);
2637 pulsesink->server = g_value_dup_string (value);
2638 if (pulsesink->probe)
2639 gst_pulseprobe_set_server (pulsesink->probe, pulsesink->server);
2642 g_free (pulsesink->device);
2643 pulsesink->device = g_value_dup_string (value);
2646 gst_pulsesink_set_volume (pulsesink, g_value_get_double (value));
2649 gst_pulsesink_set_mute (pulsesink, g_value_get_boolean (value));
2652 g_free (pulsesink->client_name);
2653 if (!g_value_get_string (value)) {
2654 GST_WARNING_OBJECT (pulsesink,
2655 "Empty PulseAudio client name not allowed. Resetting to default value");
2656 pulsesink->client_name = gst_pulse_client_name ();
2658 pulsesink->client_name = g_value_dup_string (value);
2660 case PROP_STREAM_PROPERTIES:
2661 if (pulsesink->properties)
2662 gst_structure_free (pulsesink->properties);
2663 pulsesink->properties =
2664 gst_structure_copy (gst_value_get_structure (value));
2665 if (pulsesink->proplist)
2666 pa_proplist_free (pulsesink->proplist);
2667 pulsesink->proplist = gst_pulse_make_proplist (pulsesink->properties);
2670 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2676 gst_pulsesink_get_property (GObject * object,
2677 guint prop_id, GValue * value, GParamSpec * pspec)
2680 GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2684 g_value_set_string (value, pulsesink->server);
2687 g_value_set_string (value, pulsesink->device);
2689 case PROP_DEVICE_NAME:
2690 g_value_take_string (value, gst_pulsesink_device_description (pulsesink));
2693 g_value_set_double (value, gst_pulsesink_get_volume (pulsesink));
2696 g_value_set_boolean (value, gst_pulsesink_get_mute (pulsesink));
2699 g_value_set_string (value, pulsesink->client_name);
2701 case PROP_STREAM_PROPERTIES:
2702 gst_value_set_structure (value, pulsesink->properties);
2705 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2711 gst_pulsesink_change_title (GstPulseSink * psink, const gchar * t)
2713 pa_operation *o = NULL;
2714 GstPulseRingBuffer *pbuf;
2716 pa_threaded_mainloop_lock (mainloop);
2718 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2720 if (pbuf == NULL || pbuf->stream == NULL)
2723 g_free (pbuf->stream_name);
2724 pbuf->stream_name = g_strdup (t);
2726 if (!(o = pa_stream_set_name (pbuf->stream, pbuf->stream_name, NULL, NULL)))
2729 /* We're not interested if this operation failed or not */
2733 pa_operation_unref (o);
2734 pa_threaded_mainloop_unlock (mainloop);
2741 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2746 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2747 ("pa_stream_set_name() failed: %s",
2748 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2754 gst_pulsesink_change_props (GstPulseSink * psink, GstTagList * l)
2756 static const gchar *const map[] = {
2757 GST_TAG_TITLE, PA_PROP_MEDIA_TITLE,
2759 /* might get overriden in the next iteration by GST_TAG_ARTIST */
2760 GST_TAG_PERFORMER, PA_PROP_MEDIA_ARTIST,
2762 GST_TAG_ARTIST, PA_PROP_MEDIA_ARTIST,
2763 GST_TAG_LANGUAGE_CODE, PA_PROP_MEDIA_LANGUAGE,
2764 GST_TAG_LOCATION, PA_PROP_MEDIA_FILENAME,
2765 /* We might add more here later on ... */
2768 pa_proplist *pl = NULL;
2769 const gchar *const *t;
2770 gboolean empty = TRUE;
2771 pa_operation *o = NULL;
2772 GstPulseRingBuffer *pbuf;
2774 pl = pa_proplist_new ();
2776 for (t = map; *t; t += 2) {
2779 if (gst_tag_list_get_string (l, *t, &n)) {
2782 pa_proplist_sets (pl, *(t + 1), n);
2792 pa_threaded_mainloop_lock (mainloop);
2793 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2794 if (pbuf == NULL || pbuf->stream == NULL)
2797 if (!(o = pa_stream_proplist_update (pbuf->stream, PA_UPDATE_REPLACE,
2801 /* We're not interested if this operation failed or not */
2805 pa_operation_unref (o);
2807 pa_threaded_mainloop_unlock (mainloop);
2812 pa_proplist_free (pl);
2819 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2824 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2825 ("pa_stream_proplist_update() failed: %s",
2826 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2832 gst_pulsesink_flush_ringbuffer (GstPulseSink * psink)
2834 GstPulseRingBuffer *pbuf;
2836 pa_threaded_mainloop_lock (mainloop);
2838 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2840 if (pbuf == NULL || pbuf->stream == NULL)
2843 gst_pulsering_flush (pbuf);
2845 /* Uncork if we haven't already (happens when waiting to get enough data
2846 * to send out the first time) */
2848 gst_pulsering_set_corked (pbuf, FALSE, FALSE);
2850 /* We're not interested if this operation failed or not */
2852 pa_threaded_mainloop_unlock (mainloop);
2859 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2865 gst_pulsesink_event (GstBaseSink * sink, GstEvent * event)
2867 GstPulseSink *pulsesink = GST_PULSESINK_CAST (sink);
2869 switch (GST_EVENT_TYPE (event)) {
2870 case GST_EVENT_TAG:{
2871 gchar *title = NULL, *artist = NULL, *location = NULL, *description =
2872 NULL, *t = NULL, *buf = NULL;
2875 gst_event_parse_tag (event, &l);
2877 gst_tag_list_get_string (l, GST_TAG_TITLE, &title);
2878 gst_tag_list_get_string (l, GST_TAG_ARTIST, &artist);
2879 gst_tag_list_get_string (l, GST_TAG_LOCATION, &location);
2880 gst_tag_list_get_string (l, GST_TAG_DESCRIPTION, &description);
2883 gst_tag_list_get_string (l, GST_TAG_PERFORMER, &artist);
2885 if (title && artist)
2886 /* TRANSLATORS: 'song title' by 'artist name' */
2887 t = buf = g_strdup_printf (_("'%s' by '%s'"), g_strstrip (title),
2888 g_strstrip (artist));
2890 t = g_strstrip (title);
2891 else if (description)
2892 t = g_strstrip (description);
2894 t = g_strstrip (location);
2897 gst_pulsesink_change_title (pulsesink, t);
2902 g_free (description);
2905 gst_pulsesink_change_props (pulsesink, l);
2910 gst_pulsesink_flush_ringbuffer (pulsesink);
2916 return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
2920 gst_pulsesink_release_mainloop (GstPulseSink * psink)
2925 pa_threaded_mainloop_lock (mainloop);
2926 while (psink->defer_pending) {
2927 GST_DEBUG_OBJECT (psink, "waiting for stream status message emission");
2928 pa_threaded_mainloop_wait (mainloop);
2930 pa_threaded_mainloop_unlock (mainloop);
2932 g_mutex_lock (pa_shared_resource_mutex);
2934 if (!mainloop_ref_ct) {
2935 GST_INFO_OBJECT (psink, "terminating pa main loop thread");
2936 pa_threaded_mainloop_stop (mainloop);
2937 pa_threaded_mainloop_free (mainloop);
2940 g_mutex_unlock (pa_shared_resource_mutex);
2943 static GstStateChangeReturn
2944 gst_pulsesink_change_state (GstElement * element, GstStateChange transition)
2946 GstPulseSink *pulsesink = GST_PULSESINK (element);
2947 GstStateChangeReturn ret;
2949 switch (transition) {
2950 case GST_STATE_CHANGE_NULL_TO_READY:
2951 g_mutex_lock (pa_shared_resource_mutex);
2952 if (!mainloop_ref_ct) {
2953 GST_INFO_OBJECT (element, "new pa main loop thread");
2954 if (!(mainloop = pa_threaded_mainloop_new ()))
2955 goto mainloop_failed;
2956 mainloop_ref_ct = 1;
2957 pa_threaded_mainloop_start (mainloop);
2958 g_mutex_unlock (pa_shared_resource_mutex);
2960 GST_INFO_OBJECT (element, "reusing pa main loop thread");
2962 g_mutex_unlock (pa_shared_resource_mutex);
2965 case GST_STATE_CHANGE_READY_TO_PAUSED:
2966 gst_element_post_message (element,
2967 gst_message_new_clock_provide (GST_OBJECT_CAST (element),
2968 GST_BASE_AUDIO_SINK (pulsesink)->provided_clock, TRUE));
2975 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2976 if (ret == GST_STATE_CHANGE_FAILURE)
2979 switch (transition) {
2980 case GST_STATE_CHANGE_PAUSED_TO_READY:
2981 /* format_lost is reset in release() in baseaudiosink */
2982 gst_element_post_message (element,
2983 gst_message_new_clock_lost (GST_OBJECT_CAST (element),
2984 GST_BASE_AUDIO_SINK (pulsesink)->provided_clock));
2986 case GST_STATE_CHANGE_READY_TO_NULL:
2987 gst_pulsesink_release_mainloop (pulsesink);
2998 g_mutex_unlock (pa_shared_resource_mutex);
2999 GST_ELEMENT_ERROR (pulsesink, RESOURCE, FAILED,
3000 ("pa_threaded_mainloop_new() failed"), (NULL));
3001 return GST_STATE_CHANGE_FAILURE;
3005 if (transition == GST_STATE_CHANGE_NULL_TO_READY) {
3006 /* Clear the PA mainloop if baseaudiosink failed to open the ring_buffer */
3007 g_assert (mainloop);
3008 gst_pulsesink_release_mainloop (pulsesink);