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 GstAudioRingBuffer 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 GstAudioRingBufferClass parent_class;
165 static GType gst_pulseringbuffer_get_type (void);
166 static void gst_pulseringbuffer_finalize (GObject * object);
168 static GstAudioRingBufferClass *ring_parent_class = NULL;
170 static gboolean gst_pulseringbuffer_open_device (GstAudioRingBuffer * buf);
171 static gboolean gst_pulseringbuffer_close_device (GstAudioRingBuffer * buf);
172 static gboolean gst_pulseringbuffer_acquire (GstAudioRingBuffer * buf,
173 GstAudioRingBufferSpec * spec);
174 static gboolean gst_pulseringbuffer_release (GstAudioRingBuffer * buf);
175 static gboolean gst_pulseringbuffer_start (GstAudioRingBuffer * buf);
176 static gboolean gst_pulseringbuffer_pause (GstAudioRingBuffer * buf);
177 static gboolean gst_pulseringbuffer_stop (GstAudioRingBuffer * buf);
178 static void gst_pulseringbuffer_clear (GstAudioRingBuffer * buf);
179 static guint gst_pulseringbuffer_commit (GstAudioRingBuffer * buf,
180 guint64 * sample, guchar * data, gint in_samples, gint out_samples,
183 G_DEFINE_TYPE (GstPulseRingBuffer, gst_pulseringbuffer,
184 GST_TYPE_AUDIO_RING_BUFFER);
187 gst_pulsesink_init_contexts (void)
189 g_assert (pa_shared_resource_mutex == NULL);
190 pa_shared_resource_mutex = g_mutex_new ();
191 gst_pulse_shared_contexts = g_hash_table_new_full (g_str_hash, g_str_equal,
196 gst_pulseringbuffer_class_init (GstPulseRingBufferClass * klass)
198 GObjectClass *gobject_class;
199 GstAudioRingBufferClass *gstringbuffer_class;
201 gobject_class = (GObjectClass *) klass;
202 gstringbuffer_class = (GstAudioRingBufferClass *) klass;
204 ring_parent_class = g_type_class_peek_parent (klass);
206 gobject_class->finalize = gst_pulseringbuffer_finalize;
208 gstringbuffer_class->open_device =
209 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_open_device);
210 gstringbuffer_class->close_device =
211 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_close_device);
212 gstringbuffer_class->acquire =
213 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_acquire);
214 gstringbuffer_class->release =
215 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_release);
216 gstringbuffer_class->start = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_start);
217 gstringbuffer_class->pause = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_pause);
218 gstringbuffer_class->resume = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_start);
219 gstringbuffer_class->stop = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_stop);
220 gstringbuffer_class->clear_all =
221 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_clear);
223 gstringbuffer_class->commit = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_commit);
227 gst_pulseringbuffer_init (GstPulseRingBuffer * pbuf)
229 pbuf->stream_name = NULL;
230 pbuf->context = NULL;
233 #ifdef HAVE_PULSE_1_0
236 pbuf->is_pcm = FALSE;
238 pa_sample_spec_init (&pbuf->sample_spec);
243 pbuf->m_writable = 0;
245 pbuf->m_lastoffset = 0;
248 pbuf->in_commit = FALSE;
249 pbuf->paused = FALSE;
253 gst_pulsering_destroy_stream (GstPulseRingBuffer * pbuf)
258 /* drop shm memory buffer */
259 pa_stream_cancel_write (pbuf->stream);
261 /* reset internal variables */
264 pbuf->m_writable = 0;
266 pbuf->m_lastoffset = 0;
268 #ifdef HAVE_PULSE_1_0
270 pa_format_info_free (pbuf->format);
273 pbuf->is_pcm = FALSE;
277 pa_stream_disconnect (pbuf->stream);
279 /* Make sure we don't get any further callbacks */
280 pa_stream_set_state_callback (pbuf->stream, NULL, NULL);
281 pa_stream_set_write_callback (pbuf->stream, NULL, NULL);
282 pa_stream_set_underflow_callback (pbuf->stream, NULL, NULL);
283 pa_stream_set_overflow_callback (pbuf->stream, NULL, NULL);
285 pa_stream_unref (pbuf->stream);
289 g_free (pbuf->stream_name);
290 pbuf->stream_name = NULL;
294 gst_pulsering_destroy_context (GstPulseRingBuffer * pbuf)
296 g_mutex_lock (pa_shared_resource_mutex);
298 GST_DEBUG_OBJECT (pbuf, "destroying ringbuffer %p", pbuf);
300 gst_pulsering_destroy_stream (pbuf);
303 pa_context_unref (pbuf->context);
304 pbuf->context = NULL;
307 if (pbuf->context_name) {
308 GstPulseContext *pctx;
310 pctx = g_hash_table_lookup (gst_pulse_shared_contexts, pbuf->context_name);
312 GST_DEBUG_OBJECT (pbuf, "releasing context with name %s, pbuf=%p, pctx=%p",
313 pbuf->context_name, pbuf, pctx);
316 pctx->ring_buffers = g_slist_remove (pctx->ring_buffers, pbuf);
317 if (pctx->ring_buffers == NULL) {
318 GST_DEBUG_OBJECT (pbuf,
319 "destroying final context with name %s, pbuf=%p, pctx=%p",
320 pbuf->context_name, pbuf, pctx);
322 pa_context_disconnect (pctx->context);
324 /* Make sure we don't get any further callbacks */
325 pa_context_set_state_callback (pctx->context, NULL, NULL);
326 pa_context_set_subscribe_callback (pctx->context, NULL, NULL);
328 g_hash_table_remove (gst_pulse_shared_contexts, pbuf->context_name);
330 pa_context_unref (pctx->context);
331 g_slice_free (GstPulseContext, pctx);
334 g_free (pbuf->context_name);
335 pbuf->context_name = NULL;
337 g_mutex_unlock (pa_shared_resource_mutex);
341 gst_pulseringbuffer_finalize (GObject * object)
343 GstPulseRingBuffer *ringbuffer;
345 ringbuffer = GST_PULSERING_BUFFER_CAST (object);
347 gst_pulsering_destroy_context (ringbuffer);
348 G_OBJECT_CLASS (ring_parent_class)->finalize (object);
352 #define CONTEXT_OK(c) ((c) && PA_CONTEXT_IS_GOOD (pa_context_get_state ((c))))
353 #define STREAM_OK(s) ((s) && PA_STREAM_IS_GOOD (pa_stream_get_state ((s))))
356 gst_pulsering_is_dead (GstPulseSink * psink, GstPulseRingBuffer * pbuf,
357 gboolean check_stream)
359 if (!CONTEXT_OK (pbuf->context))
362 if (check_stream && !STREAM_OK (pbuf->stream))
369 const gchar *err_str =
370 pbuf->context ? pa_strerror (pa_context_errno (pbuf->context)) : NULL;
371 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED, ("Disconnected: %s",
378 gst_pulsering_context_state_cb (pa_context * c, void *userdata)
380 pa_context_state_t state;
381 pa_threaded_mainloop *mainloop = (pa_threaded_mainloop *) userdata;
383 state = pa_context_get_state (c);
385 GST_LOG ("got new context state %d", state);
388 case PA_CONTEXT_READY:
389 case PA_CONTEXT_TERMINATED:
390 case PA_CONTEXT_FAILED:
391 GST_LOG ("signaling");
392 pa_threaded_mainloop_signal (mainloop, 0);
395 case PA_CONTEXT_UNCONNECTED:
396 case PA_CONTEXT_CONNECTING:
397 case PA_CONTEXT_AUTHORIZING:
398 case PA_CONTEXT_SETTING_NAME:
404 gst_pulsering_context_subscribe_cb (pa_context * c,
405 pa_subscription_event_type_t t, uint32_t idx, void *userdata)
408 GstPulseContext *pctx = (GstPulseContext *) userdata;
411 if (t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT | PA_SUBSCRIPTION_EVENT_CHANGE) &&
412 t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT | PA_SUBSCRIPTION_EVENT_NEW))
415 for (walk = pctx->ring_buffers; walk; walk = g_slist_next (walk)) {
416 GstPulseRingBuffer *pbuf = (GstPulseRingBuffer *) walk->data;
417 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
419 GST_LOG_OBJECT (psink, "type %d, idx %u", t, idx);
424 if (idx != pa_stream_get_index (pbuf->stream))
427 #ifdef HAVE_PULSE_1_0
428 if (psink->device && pbuf->is_pcm &&
429 !g_str_equal (psink->device,
430 pa_stream_get_device_name (pbuf->stream))) {
431 /* Underlying sink changed. And this is not a passthrough stream. Let's
432 * see if someone upstream wants to try to renegotiate. */
435 g_free (psink->device);
436 psink->device = g_strdup (pa_stream_get_device_name (pbuf->stream));
438 GST_INFO_OBJECT (psink, "emitting sink-changed");
440 renego = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM,
441 gst_structure_new_empty ("pulse-sink-changed"));
443 if (!gst_pad_push_event (GST_BASE_SINK (psink)->sinkpad, renego))
444 GST_DEBUG_OBJECT (psink, "Emitted sink-changed - nobody was listening");
448 /* Actually this event is also triggered when other properties of
449 * the stream change that are unrelated to the volume. However it is
450 * probably cheaper to signal the change here and check for the
451 * volume when the GObject property is read instead of querying it always. */
453 /* inform streaming thread to notify */
454 g_atomic_int_compare_and_exchange (&psink->notify, 0, 1);
458 /* will be called when the device should be opened. In this case we will connect
459 * to the server. We should not try to open any streams in this state. */
461 gst_pulseringbuffer_open_device (GstAudioRingBuffer * buf)
464 GstPulseRingBuffer *pbuf;
465 GstPulseContext *pctx;
466 pa_mainloop_api *api;
467 gboolean need_unlock_shared;
469 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (buf));
470 pbuf = GST_PULSERING_BUFFER_CAST (buf);
472 g_assert (!pbuf->stream);
473 g_assert (psink->client_name);
476 pbuf->context_name = g_strdup_printf ("%s@%s", psink->client_name,
479 pbuf->context_name = g_strdup (psink->client_name);
481 pa_threaded_mainloop_lock (mainloop);
483 g_mutex_lock (pa_shared_resource_mutex);
484 need_unlock_shared = TRUE;
486 pctx = g_hash_table_lookup (gst_pulse_shared_contexts, pbuf->context_name);
488 pctx = g_slice_new0 (GstPulseContext);
490 /* get the mainloop api and create a context */
491 GST_INFO_OBJECT (psink, "new context with name %s, pbuf=%p, pctx=%p",
492 pbuf->context_name, pbuf, pctx);
493 api = pa_threaded_mainloop_get_api (mainloop);
494 if (!(pctx->context = pa_context_new (api, pbuf->context_name)))
497 pctx->ring_buffers = g_slist_prepend (pctx->ring_buffers, pbuf);
498 g_hash_table_insert (gst_pulse_shared_contexts,
499 g_strdup (pbuf->context_name), (gpointer) pctx);
500 /* register some essential callbacks */
501 pa_context_set_state_callback (pctx->context,
502 gst_pulsering_context_state_cb, mainloop);
503 pa_context_set_subscribe_callback (pctx->context,
504 gst_pulsering_context_subscribe_cb, pctx);
506 /* try to connect to the server and wait for completion, we don't want to
507 * autospawn a deamon */
508 GST_LOG_OBJECT (psink, "connect to server %s",
509 GST_STR_NULL (psink->server));
510 if (pa_context_connect (pctx->context, psink->server,
511 PA_CONTEXT_NOAUTOSPAWN, NULL) < 0)
514 GST_INFO_OBJECT (psink,
515 "reusing shared context with name %s, pbuf=%p, pctx=%p",
516 pbuf->context_name, pbuf, pctx);
517 pctx->ring_buffers = g_slist_prepend (pctx->ring_buffers, pbuf);
520 g_mutex_unlock (pa_shared_resource_mutex);
521 need_unlock_shared = FALSE;
523 /* context created or shared okay */
524 pbuf->context = pa_context_ref (pctx->context);
527 pa_context_state_t state;
529 state = pa_context_get_state (pbuf->context);
531 GST_LOG_OBJECT (psink, "context state is now %d", state);
533 if (!PA_CONTEXT_IS_GOOD (state))
536 if (state == PA_CONTEXT_READY)
539 /* Wait until the context is ready */
540 GST_LOG_OBJECT (psink, "waiting..");
541 pa_threaded_mainloop_wait (mainloop);
544 GST_LOG_OBJECT (psink, "opened the device");
546 pa_threaded_mainloop_unlock (mainloop);
553 if (need_unlock_shared)
554 g_mutex_unlock (pa_shared_resource_mutex);
555 gst_pulsering_destroy_context (pbuf);
556 pa_threaded_mainloop_unlock (mainloop);
561 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
562 ("Failed to create context"), (NULL));
563 g_slice_free (GstPulseContext, pctx);
564 goto unlock_and_fail;
568 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED, ("Failed to connect: %s",
569 pa_strerror (pa_context_errno (pctx->context))), (NULL));
570 goto unlock_and_fail;
574 /* close the device */
576 gst_pulseringbuffer_close_device (GstAudioRingBuffer * buf)
579 GstPulseRingBuffer *pbuf;
581 pbuf = GST_PULSERING_BUFFER_CAST (buf);
582 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (buf));
584 GST_LOG_OBJECT (psink, "closing device");
586 pa_threaded_mainloop_lock (mainloop);
587 gst_pulsering_destroy_context (pbuf);
588 pa_threaded_mainloop_unlock (mainloop);
590 GST_LOG_OBJECT (psink, "closed device");
596 gst_pulsering_stream_state_cb (pa_stream * s, void *userdata)
599 GstPulseRingBuffer *pbuf;
600 pa_stream_state_t state;
602 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
603 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
605 state = pa_stream_get_state (s);
606 GST_LOG_OBJECT (psink, "got new stream state %d", state);
609 case PA_STREAM_READY:
610 case PA_STREAM_FAILED:
611 case PA_STREAM_TERMINATED:
612 GST_LOG_OBJECT (psink, "signaling");
613 pa_threaded_mainloop_signal (mainloop, 0);
615 case PA_STREAM_UNCONNECTED:
616 case PA_STREAM_CREATING:
622 gst_pulsering_stream_request_cb (pa_stream * s, size_t length, void *userdata)
625 GstAudioRingBuffer *rbuf;
626 GstPulseRingBuffer *pbuf;
628 rbuf = GST_AUDIO_RING_BUFFER_CAST (userdata);
629 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
630 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
632 GST_LOG_OBJECT (psink, "got request for length %" G_GSIZE_FORMAT, length);
634 if (pbuf->in_commit && (length >= rbuf->spec.segsize)) {
635 /* only signal when we are waiting in the commit thread
636 * and got request for atleast a segment */
637 pa_threaded_mainloop_signal (mainloop, 0);
642 gst_pulsering_stream_underflow_cb (pa_stream * s, void *userdata)
645 GstPulseRingBuffer *pbuf;
647 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
648 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
650 GST_WARNING_OBJECT (psink, "Got underflow");
654 gst_pulsering_stream_overflow_cb (pa_stream * s, void *userdata)
657 GstPulseRingBuffer *pbuf;
659 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
660 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
662 GST_WARNING_OBJECT (psink, "Got overflow");
666 gst_pulsering_stream_latency_cb (pa_stream * s, void *userdata)
669 GstPulseRingBuffer *pbuf;
670 const pa_timing_info *info;
673 info = pa_stream_get_timing_info (s);
675 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
676 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
679 GST_LOG_OBJECT (psink, "latency update (information unknown)");
682 sink_usec = info->configured_sink_usec;
684 GST_LOG_OBJECT (psink,
685 "latency_update, %" G_GUINT64_FORMAT ", %d:%" G_GINT64_FORMAT ", %d:%"
686 G_GUINT64_FORMAT ", %" G_GUINT64_FORMAT ", %" G_GUINT64_FORMAT,
687 GST_TIMEVAL_TO_TIME (info->timestamp), info->write_index_corrupt,
688 info->write_index, info->read_index_corrupt, info->read_index,
689 info->sink_usec, sink_usec);
693 gst_pulsering_stream_suspended_cb (pa_stream * p, void *userdata)
696 GstPulseRingBuffer *pbuf;
698 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
699 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
701 if (pa_stream_is_suspended (p))
702 GST_DEBUG_OBJECT (psink, "stream suspended");
704 GST_DEBUG_OBJECT (psink, "stream resumed");
708 gst_pulsering_stream_started_cb (pa_stream * p, void *userdata)
711 GstPulseRingBuffer *pbuf;
713 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
714 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
716 GST_DEBUG_OBJECT (psink, "stream started");
720 gst_pulsering_stream_event_cb (pa_stream * p, const char *name,
721 pa_proplist * pl, void *userdata)
724 GstPulseRingBuffer *pbuf;
726 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
727 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
729 if (!strcmp (name, PA_STREAM_EVENT_REQUEST_CORK)) {
730 /* the stream wants to PAUSE, post a message for the application. */
731 GST_DEBUG_OBJECT (psink, "got request for CORK");
732 gst_element_post_message (GST_ELEMENT_CAST (psink),
733 gst_message_new_request_state (GST_OBJECT_CAST (psink),
736 } else if (!strcmp (name, PA_STREAM_EVENT_REQUEST_UNCORK)) {
737 GST_DEBUG_OBJECT (psink, "got request for UNCORK");
738 gst_element_post_message (GST_ELEMENT_CAST (psink),
739 gst_message_new_request_state (GST_OBJECT_CAST (psink),
741 #ifdef HAVE_PULSE_1_0
742 } else if (!strcmp (name, PA_STREAM_EVENT_FORMAT_LOST)) {
745 if (g_atomic_int_get (&psink->format_lost)) {
746 /* Duplicate event before we're done reconfiguring, discard */
750 GST_DEBUG_OBJECT (psink, "got FORMAT LOST");
751 g_atomic_int_set (&psink->format_lost, 1);
752 psink->format_lost_time = g_ascii_strtoull (pa_proplist_gets (pl,
753 "stream-time"), NULL, 0) * 1000;
755 g_free (psink->device);
756 psink->device = g_strdup (pa_proplist_gets (pl, "device"));
758 renego = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM,
759 gst_structure_new_empty ("pulse-format-lost"));
761 if (!gst_pad_push_event (GST_BASE_SINK (psink)->sinkpad, renego)) {
762 /* Nobody handled the format change - emit an error */
763 GST_ELEMENT_ERROR (psink, STREAM, FORMAT, ("Sink format changed"),
764 ("Sink format changed"));
768 GST_DEBUG_OBJECT (psink, "got unknown event %s", name);
772 /* Called with the mainloop locked */
774 gst_pulsering_wait_for_stream_ready (GstPulseSink * psink, pa_stream * stream)
776 pa_stream_state_t state;
779 state = pa_stream_get_state (stream);
781 GST_LOG_OBJECT (psink, "stream state is now %d", state);
783 if (!PA_STREAM_IS_GOOD (state))
786 if (state == PA_STREAM_READY)
789 /* Wait until the stream is ready */
790 pa_threaded_mainloop_wait (mainloop);
795 /* This method should create a new stream of the given @spec. No playback should
796 * start yet so we start in the corked state. */
798 gst_pulseringbuffer_acquire (GstAudioRingBuffer * buf,
799 GstAudioRingBufferSpec * spec)
802 GstPulseRingBuffer *pbuf;
803 pa_buffer_attr wanted;
804 const pa_buffer_attr *actual;
805 pa_channel_map channel_map;
806 pa_operation *o = NULL;
807 #ifdef HAVE_PULSE_0_9_20
810 pa_cvolume *pv = NULL;
811 pa_stream_flags_t flags;
813 GstAudioClock *clock;
814 #ifdef HAVE_PULSE_1_0
815 pa_format_info *formats[1];
816 #ifndef GST_DISABLE_GST_DEBUG
817 gchar print_buf[PA_FORMAT_INFO_SNPRINT_MAX];
821 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (buf));
822 pbuf = GST_PULSERING_BUFFER_CAST (buf);
824 GST_LOG_OBJECT (psink, "creating sample spec");
825 /* convert the gstreamer sample spec to the pulseaudio format */
826 #ifdef HAVE_PULSE_1_0
827 if (!gst_pulse_fill_format_info (spec, &pbuf->format, &pbuf->channels))
829 pbuf->is_pcm = pa_format_info_is_pcm (pbuf->format);
831 if (!gst_pulse_fill_sample_spec (spec, &pbuf->sample_spec))
835 pa_threaded_mainloop_lock (mainloop);
837 /* we need a context and a no stream */
838 g_assert (pbuf->context);
839 g_assert (!pbuf->stream);
841 /* enable event notifications */
842 GST_LOG_OBJECT (psink, "subscribing to context events");
843 if (!(o = pa_context_subscribe (pbuf->context,
844 PA_SUBSCRIPTION_MASK_SINK_INPUT, NULL, NULL)))
845 goto subscribe_failed;
847 pa_operation_unref (o);
849 /* initialize the channel map */
850 #ifdef HAVE_PULSE_1_0
851 if (pbuf->is_pcm && gst_pulse_gst_to_channel_map (&channel_map, spec))
852 pa_format_info_set_channel_map (pbuf->format, &channel_map);
854 gst_pulse_gst_to_channel_map (&channel_map, spec);
857 /* find a good name for the stream */
858 if (psink->stream_name)
859 name = psink->stream_name;
861 name = "Playback Stream";
863 /* create a stream */
864 #ifdef HAVE_PULSE_1_0
865 formats[0] = pbuf->format;
866 if (!(pbuf->stream = pa_stream_new_extended (pbuf->context, name, formats, 1,
870 GST_LOG_OBJECT (psink, "creating stream with name %s", name);
871 if (!(pbuf->stream = pa_stream_new_with_proplist (pbuf->context, name,
872 &pbuf->sample_spec, &channel_map, psink->proplist)))
876 /* install essential callbacks */
877 pa_stream_set_state_callback (pbuf->stream,
878 gst_pulsering_stream_state_cb, pbuf);
879 pa_stream_set_write_callback (pbuf->stream,
880 gst_pulsering_stream_request_cb, pbuf);
881 pa_stream_set_underflow_callback (pbuf->stream,
882 gst_pulsering_stream_underflow_cb, pbuf);
883 pa_stream_set_overflow_callback (pbuf->stream,
884 gst_pulsering_stream_overflow_cb, pbuf);
885 pa_stream_set_latency_update_callback (pbuf->stream,
886 gst_pulsering_stream_latency_cb, pbuf);
887 pa_stream_set_suspended_callback (pbuf->stream,
888 gst_pulsering_stream_suspended_cb, pbuf);
889 pa_stream_set_started_callback (pbuf->stream,
890 gst_pulsering_stream_started_cb, pbuf);
891 pa_stream_set_event_callback (pbuf->stream,
892 gst_pulsering_stream_event_cb, pbuf);
894 /* buffering requirements. When setting prebuf to 0, the stream will not pause
895 * when we cause an underrun, which causes time to continue. */
896 memset (&wanted, 0, sizeof (wanted));
897 wanted.tlength = spec->segtotal * spec->segsize;
898 wanted.maxlength = -1;
900 wanted.minreq = spec->segsize;
902 GST_INFO_OBJECT (psink, "tlength: %d", wanted.tlength);
903 GST_INFO_OBJECT (psink, "maxlength: %d", wanted.maxlength);
904 GST_INFO_OBJECT (psink, "prebuf: %d", wanted.prebuf);
905 GST_INFO_OBJECT (psink, "minreq: %d", wanted.minreq);
907 #ifdef HAVE_PULSE_0_9_20
908 /* configure volume when we changed it, else we leave the default */
909 if (psink->volume_set) {
910 GST_LOG_OBJECT (psink, "have volume of %f", psink->volume);
912 #ifdef HAVE_PULSE_1_0
914 gst_pulse_cvolume_from_linear (pv, pbuf->channels, psink->volume);
916 GST_DEBUG_OBJECT (psink, "passthrough stream, not setting volume");
920 gst_pulse_cvolume_from_linear (pv, pbuf->sample_spec.channels,
928 /* construct the flags */
929 flags = PA_STREAM_INTERPOLATE_TIMING | PA_STREAM_AUTO_TIMING_UPDATE |
930 PA_STREAM_ADJUST_LATENCY | PA_STREAM_START_CORKED;
932 if (psink->mute_set && psink->mute)
933 flags |= PA_STREAM_START_MUTED;
935 /* we always start corked (see flags above) */
938 /* try to connect now */
939 GST_LOG_OBJECT (psink, "connect for playback to device %s",
940 GST_STR_NULL (psink->device));
941 if (pa_stream_connect_playback (pbuf->stream, psink->device,
942 &wanted, flags, pv, NULL) < 0)
945 /* our clock will now start from 0 again */
946 clock = GST_AUDIO_CLOCK (GST_BASE_AUDIO_SINK (psink)->provided_clock);
947 gst_audio_clock_reset (clock, 0);
949 if (!gst_pulsering_wait_for_stream_ready (psink, pbuf->stream))
952 #ifdef HAVE_PULSE_1_0
953 g_free (psink->device);
954 psink->device = g_strdup (pa_stream_get_device_name (pbuf->stream));
956 #ifndef GST_DISABLE_GST_DEBUG
957 pa_format_info_snprint (print_buf, sizeof (print_buf),
958 pa_stream_get_format_info (pbuf->stream));
959 GST_INFO_OBJECT (psink, "negotiated to: %s", print_buf);
963 /* After we passed the volume off of to PA we never want to set it
964 again, since it is PA's job to save/restore volumes. */
965 psink->volume_set = psink->mute_set = FALSE;
967 GST_LOG_OBJECT (psink, "stream is acquired now");
969 /* get the actual buffering properties now */
970 actual = pa_stream_get_buffer_attr (pbuf->stream);
972 GST_INFO_OBJECT (psink, "tlength: %d (wanted: %d)", actual->tlength,
974 GST_INFO_OBJECT (psink, "maxlength: %d", actual->maxlength);
975 GST_INFO_OBJECT (psink, "prebuf: %d", actual->prebuf);
976 GST_INFO_OBJECT (psink, "minreq: %d (wanted %d)", actual->minreq,
979 spec->segsize = actual->minreq;
980 spec->segtotal = actual->tlength / spec->segsize;
982 pa_threaded_mainloop_unlock (mainloop);
989 gst_pulsering_destroy_stream (pbuf);
990 pa_threaded_mainloop_unlock (mainloop);
996 GST_ELEMENT_ERROR (psink, RESOURCE, SETTINGS,
997 ("Invalid sample specification."), (NULL));
1002 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1003 ("pa_context_subscribe() failed: %s",
1004 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1005 goto unlock_and_fail;
1009 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1010 ("Failed to create stream: %s",
1011 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1012 goto unlock_and_fail;
1016 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1017 ("Failed to connect stream: %s",
1018 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1019 goto unlock_and_fail;
1023 /* free the stream that we acquired before */
1025 gst_pulseringbuffer_release (GstAudioRingBuffer * buf)
1027 GstPulseRingBuffer *pbuf;
1029 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1031 pa_threaded_mainloop_lock (mainloop);
1032 gst_pulsering_destroy_stream (pbuf);
1033 pa_threaded_mainloop_unlock (mainloop);
1035 #ifdef HAVE_PULSE_1_0
1037 GstPulseSink *psink;
1039 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1040 g_atomic_int_set (&psink->format_lost, FALSE);
1041 psink->format_lost_time = GST_CLOCK_TIME_NONE;
1049 gst_pulsering_success_cb (pa_stream * s, int success, void *userdata)
1051 pa_threaded_mainloop_signal (mainloop, 0);
1054 /* update the corked state of a stream, must be called with the mainloop
1057 gst_pulsering_set_corked (GstPulseRingBuffer * pbuf, gboolean corked,
1060 pa_operation *o = NULL;
1061 GstPulseSink *psink;
1062 gboolean res = FALSE;
1064 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1066 #ifdef HAVE_PULSE_1_0
1067 if (g_atomic_int_get (&psink->format_lost)) {
1068 /* Sink format changed, stream's gone so fake being paused */
1073 GST_DEBUG_OBJECT (psink, "setting corked state to %d", corked);
1074 if (pbuf->corked != corked) {
1075 if (!(o = pa_stream_cork (pbuf->stream, corked,
1076 gst_pulsering_success_cb, pbuf)))
1079 while (wait && pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
1080 pa_threaded_mainloop_wait (mainloop);
1081 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1084 pbuf->corked = corked;
1086 GST_DEBUG_OBJECT (psink, "skipping, already in requested state");
1092 pa_operation_unref (o);
1099 GST_DEBUG_OBJECT (psink, "the server is dead");
1104 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1105 ("pa_stream_cork() failed: %s",
1106 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1112 gst_pulseringbuffer_clear (GstAudioRingBuffer * buf)
1114 GstPulseSink *psink;
1115 GstPulseRingBuffer *pbuf;
1116 pa_operation *o = NULL;
1118 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1119 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1121 pa_threaded_mainloop_lock (mainloop);
1122 GST_DEBUG_OBJECT (psink, "clearing");
1124 /* don't wait for the flush to complete */
1125 if ((o = pa_stream_flush (pbuf->stream, NULL, pbuf)))
1126 pa_operation_unref (o);
1128 pa_threaded_mainloop_unlock (mainloop);
1131 /* called from pulse with the mainloop lock */
1133 mainloop_enter_defer_cb (pa_mainloop_api * api, void *userdata)
1135 GstPulseSink *pulsesink = GST_PULSESINK (userdata);
1136 GstMessage *message;
1139 g_value_init (&val, G_TYPE_POINTER);
1140 g_value_set_pointer (&val, g_thread_self ());
1142 GST_DEBUG_OBJECT (pulsesink, "posting ENTER stream status");
1143 message = gst_message_new_stream_status (GST_OBJECT (pulsesink),
1144 GST_STREAM_STATUS_TYPE_ENTER, GST_ELEMENT (pulsesink));
1145 gst_message_set_stream_status_object (message, &val);
1147 gst_element_post_message (GST_ELEMENT (pulsesink), message);
1149 g_return_if_fail (pulsesink->defer_pending);
1150 pulsesink->defer_pending--;
1151 pa_threaded_mainloop_signal (mainloop, 0);
1154 /* start/resume playback ASAP, we don't uncork here but in the commit method */
1156 gst_pulseringbuffer_start (GstAudioRingBuffer * buf)
1158 GstPulseSink *psink;
1159 GstPulseRingBuffer *pbuf;
1161 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1162 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1164 pa_threaded_mainloop_lock (mainloop);
1166 GST_DEBUG_OBJECT (psink, "scheduling stream status");
1167 psink->defer_pending++;
1168 pa_mainloop_api_once (pa_threaded_mainloop_get_api (mainloop),
1169 mainloop_enter_defer_cb, psink);
1171 GST_DEBUG_OBJECT (psink, "starting");
1172 pbuf->paused = FALSE;
1174 /* EOS needs running clock */
1175 if (GST_BASE_SINK_CAST (psink)->eos ||
1176 g_atomic_int_get (&GST_BASE_AUDIO_SINK (psink)->eos_rendering))
1177 gst_pulsering_set_corked (pbuf, FALSE, FALSE);
1179 pa_threaded_mainloop_unlock (mainloop);
1184 /* pause/stop playback ASAP */
1186 gst_pulseringbuffer_pause (GstAudioRingBuffer * buf)
1188 GstPulseSink *psink;
1189 GstPulseRingBuffer *pbuf;
1192 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1193 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1195 pa_threaded_mainloop_lock (mainloop);
1196 GST_DEBUG_OBJECT (psink, "pausing and corking");
1197 /* make sure the commit method stops writing */
1198 pbuf->paused = TRUE;
1199 res = gst_pulsering_set_corked (pbuf, TRUE, TRUE);
1200 if (pbuf->in_commit) {
1201 /* we are waiting in a commit, signal */
1202 GST_DEBUG_OBJECT (psink, "signal commit");
1203 pa_threaded_mainloop_signal (mainloop, 0);
1205 pa_threaded_mainloop_unlock (mainloop);
1210 /* called from pulse with the mainloop lock */
1212 mainloop_leave_defer_cb (pa_mainloop_api * api, void *userdata)
1214 GstPulseSink *pulsesink = GST_PULSESINK (userdata);
1215 GstMessage *message;
1218 g_value_init (&val, G_TYPE_POINTER);
1219 g_value_set_pointer (&val, g_thread_self ());
1221 GST_DEBUG_OBJECT (pulsesink, "posting LEAVE stream status");
1222 message = gst_message_new_stream_status (GST_OBJECT (pulsesink),
1223 GST_STREAM_STATUS_TYPE_LEAVE, GST_ELEMENT (pulsesink));
1224 gst_message_set_stream_status_object (message, &val);
1225 gst_element_post_message (GST_ELEMENT (pulsesink), message);
1227 g_return_if_fail (pulsesink->defer_pending);
1228 pulsesink->defer_pending--;
1229 pa_threaded_mainloop_signal (mainloop, 0);
1232 /* stop playback, we flush everything. */
1234 gst_pulseringbuffer_stop (GstAudioRingBuffer * buf)
1236 GstPulseSink *psink;
1237 GstPulseRingBuffer *pbuf;
1238 gboolean res = FALSE;
1239 pa_operation *o = NULL;
1241 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1242 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1244 pa_threaded_mainloop_lock (mainloop);
1246 pbuf->paused = TRUE;
1247 res = gst_pulsering_set_corked (pbuf, TRUE, TRUE);
1249 /* Inform anyone waiting in _commit() call that it shall wakeup */
1250 if (pbuf->in_commit) {
1251 GST_DEBUG_OBJECT (psink, "signal commit thread");
1252 pa_threaded_mainloop_signal (mainloop, 0);
1254 #ifdef HAVE_PULSE_1_0
1255 if (g_atomic_int_get (&psink->format_lost)) {
1256 /* Don't try to flush, the stream's probably gone by now */
1262 /* then try to flush, it's not fatal when this fails */
1263 GST_DEBUG_OBJECT (psink, "flushing");
1264 if ((o = pa_stream_flush (pbuf->stream, gst_pulsering_success_cb, pbuf))) {
1265 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
1266 GST_DEBUG_OBJECT (psink, "wait for completion");
1267 pa_threaded_mainloop_wait (mainloop);
1268 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1271 GST_DEBUG_OBJECT (psink, "flush completed");
1277 pa_operation_cancel (o);
1278 pa_operation_unref (o);
1281 GST_DEBUG_OBJECT (psink, "scheduling stream status");
1282 psink->defer_pending++;
1283 pa_mainloop_api_once (pa_threaded_mainloop_get_api (mainloop),
1284 mainloop_leave_defer_cb, psink);
1286 pa_threaded_mainloop_unlock (mainloop);
1293 GST_DEBUG_OBJECT (psink, "the server is dead");
1298 /* in_samples >= out_samples, rate > 1.0 */
1299 #define FWD_UP_SAMPLES(s,se,d,de) \
1301 guint8 *sb = s, *db = d; \
1302 while (s <= se && d < de) { \
1303 memcpy (d, s, bpf); \
1306 if ((*accum << 1) >= inr) { \
1311 in_samples -= (s - sb)/bpf; \
1312 out_samples -= (d - db)/bpf; \
1313 GST_DEBUG ("fwd_up end %d/%d",*accum,*toprocess); \
1316 /* out_samples > in_samples, for rates smaller than 1.0 */
1317 #define FWD_DOWN_SAMPLES(s,se,d,de) \
1319 guint8 *sb = s, *db = d; \
1320 while (s <= se && d < de) { \
1321 memcpy (d, s, bpf); \
1324 if ((*accum << 1) >= outr) { \
1329 in_samples -= (s - sb)/bpf; \
1330 out_samples -= (d - db)/bpf; \
1331 GST_DEBUG ("fwd_down end %d/%d",*accum,*toprocess); \
1334 #define REV_UP_SAMPLES(s,se,d,de) \
1336 guint8 *sb = se, *db = d; \
1337 while (s <= se && d < de) { \
1338 memcpy (d, se, bpf); \
1341 while (d < de && (*accum << 1) >= inr) { \
1346 in_samples -= (sb - se)/bpf; \
1347 out_samples -= (d - db)/bpf; \
1348 GST_DEBUG ("rev_up end %d/%d",*accum,*toprocess); \
1351 #define REV_DOWN_SAMPLES(s,se,d,de) \
1353 guint8 *sb = se, *db = d; \
1354 while (s <= se && d < de) { \
1355 memcpy (d, se, bpf); \
1358 while (s <= se && (*accum << 1) >= outr) { \
1363 in_samples -= (sb - se)/bpf; \
1364 out_samples -= (d - db)/bpf; \
1365 GST_DEBUG ("rev_down end %d/%d",*accum,*toprocess); \
1368 /* our custom commit function because we write into the buffer of pulseaudio
1369 * instead of keeping our own buffer */
1371 gst_pulseringbuffer_commit (GstAudioRingBuffer * buf, guint64 * sample,
1372 guchar * data, gint in_samples, gint out_samples, gint * accum)
1374 GstPulseSink *psink;
1375 GstPulseRingBuffer *pbuf;
1380 gint inr, outr, bpf;
1384 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1385 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1387 /* FIXME post message rather than using a signal (as mixer interface) */
1388 if (g_atomic_int_compare_and_exchange (&psink->notify, 1, 0)) {
1389 g_object_notify (G_OBJECT (psink), "volume");
1390 g_object_notify (G_OBJECT (psink), "mute");
1393 /* make sure the ringbuffer is started */
1394 if (G_UNLIKELY (g_atomic_int_get (&buf->state) !=
1395 GST_AUDIO_RING_BUFFER_STATE_STARTED)) {
1396 /* see if we are allowed to start it */
1397 if (G_UNLIKELY (g_atomic_int_get (&buf->may_start) == FALSE))
1400 GST_DEBUG_OBJECT (buf, "start!");
1401 if (!gst_audio_ring_buffer_start (buf))
1405 pa_threaded_mainloop_lock (mainloop);
1407 GST_DEBUG_OBJECT (psink, "entering commit");
1408 pbuf->in_commit = TRUE;
1410 bpf = GST_AUDIO_INFO_BPF (&buf->spec.info);
1411 bufsize = buf->spec.segsize * buf->spec.segtotal;
1413 /* our toy resampler for trick modes */
1414 reverse = out_samples < 0;
1415 out_samples = ABS (out_samples);
1417 if (in_samples >= out_samples)
1418 toprocess = &in_samples;
1420 toprocess = &out_samples;
1422 inr = in_samples - 1;
1423 outr = out_samples - 1;
1425 GST_DEBUG_OBJECT (psink, "in %d, out %d", inr, outr);
1427 /* data_end points to the last sample we have to write, not past it. This is
1428 * needed to properly handle reverse playback: it points to the last sample. */
1429 data_end = data + (bpf * inr);
1431 #ifdef HAVE_PULSE_1_0
1432 if (g_atomic_int_get (&psink->format_lost)) {
1433 /* Sink format changed, drop the data and hope upstream renegotiates */
1441 /* offset is in bytes */
1442 offset = *sample * bpf;
1444 while (*toprocess > 0) {
1448 GST_LOG_OBJECT (psink,
1449 "need to write %d samples at offset %" G_GINT64_FORMAT, *toprocess,
1452 if (offset != pbuf->m_lastoffset)
1453 GST_LOG_OBJECT (psink, "discontinuity, offset is %" G_GINT64_FORMAT ", "
1454 "last offset was %" G_GINT64_FORMAT, offset, pbuf->m_lastoffset);
1456 towrite = out_samples * bpf;
1458 /* Wait for at least segsize bytes to become available */
1459 if (towrite > buf->spec.segsize)
1460 towrite = buf->spec.segsize;
1462 if ((pbuf->m_writable < towrite) || (offset != pbuf->m_lastoffset)) {
1463 /* if no room left or discontinuity in offset,
1464 we need to flush data and get a new buffer */
1466 /* flush the buffer if possible */
1467 if ((pbuf->m_data != NULL) && (pbuf->m_towrite > 0)) {
1469 GST_LOG_OBJECT (psink,
1470 "flushing %u samples at offset %" G_GINT64_FORMAT,
1471 (guint) pbuf->m_towrite / bpf, pbuf->m_offset);
1473 if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1474 pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1478 pbuf->m_towrite = 0;
1479 pbuf->m_offset = offset; /* keep track of current offset */
1481 /* get a buffer to write in for now on */
1483 pbuf->m_writable = pa_stream_writable_size (pbuf->stream);
1485 #ifdef HAVE_PULSE_1_0
1486 if (g_atomic_int_get (&psink->format_lost)) {
1487 /* Sink format changed, give up and hope upstream renegotiates */
1492 if (pbuf->m_writable == (size_t) - 1)
1493 goto writable_size_failed;
1495 pbuf->m_writable /= bpf;
1496 pbuf->m_writable *= bpf; /* handle only complete samples */
1498 if (pbuf->m_writable >= towrite)
1501 /* see if we need to uncork because we have no free space */
1503 if (!gst_pulsering_set_corked (pbuf, FALSE, FALSE))
1507 /* we can't write segsize bytes, wait a bit */
1508 GST_LOG_OBJECT (psink, "waiting for free space");
1509 pa_threaded_mainloop_wait (mainloop);
1515 /* Recalculate what we can write in the next chunk */
1516 towrite = out_samples * bpf;
1517 if (pbuf->m_writable > towrite)
1518 pbuf->m_writable = towrite;
1520 GST_LOG_OBJECT (psink, "requesting %" G_GSIZE_FORMAT " bytes of "
1521 "shared memory", pbuf->m_writable);
1523 if (pa_stream_begin_write (pbuf->stream, &pbuf->m_data,
1524 &pbuf->m_writable) < 0) {
1525 GST_LOG_OBJECT (psink, "pa_stream_begin_write() failed");
1526 goto writable_size_failed;
1529 GST_LOG_OBJECT (psink, "got %" G_GSIZE_FORMAT " bytes of shared memory",
1534 if (towrite > pbuf->m_writable)
1535 towrite = pbuf->m_writable;
1536 avail = towrite / bpf;
1538 GST_LOG_OBJECT (psink, "writing %u samples at offset %" G_GUINT64_FORMAT,
1539 (guint) avail, offset);
1541 #ifdef HAVE_PULSE_1_0
1542 /* No trick modes for passthrough streams */
1543 if (G_UNLIKELY (!pbuf->is_pcm && (inr != outr || reverse))) {
1544 GST_WARNING_OBJECT (psink, "Passthrough stream can't run in trick mode");
1545 goto unlock_and_fail;
1549 if (G_LIKELY (inr == outr && !reverse)) {
1550 /* no rate conversion, simply write out the samples */
1551 /* copy the data into internal buffer */
1553 memcpy ((guint8 *) pbuf->m_data + pbuf->m_towrite, data, towrite);
1554 pbuf->m_towrite += towrite;
1555 pbuf->m_writable -= towrite;
1558 in_samples -= avail;
1559 out_samples -= avail;
1561 guint8 *dest, *d, *d_end;
1563 /* write into the PulseAudio shm buffer */
1564 dest = d = (guint8 *) pbuf->m_data + pbuf->m_towrite;
1565 d_end = d + towrite;
1569 /* forward speed up */
1570 FWD_UP_SAMPLES (data, data_end, d, d_end);
1572 /* forward slow down */
1573 FWD_DOWN_SAMPLES (data, data_end, d, d_end);
1576 /* reverse speed up */
1577 REV_UP_SAMPLES (data, data_end, d, d_end);
1579 /* reverse slow down */
1580 REV_DOWN_SAMPLES (data, data_end, d, d_end);
1582 /* see what we have left to write */
1583 towrite = (d - dest);
1584 pbuf->m_towrite += towrite;
1585 pbuf->m_writable -= towrite;
1587 avail = towrite / bpf;
1590 /* flush the buffer if it's full */
1591 if ((pbuf->m_data != NULL) && (pbuf->m_towrite > 0)
1592 && (pbuf->m_writable == 0)) {
1593 GST_LOG_OBJECT (psink, "flushing %u samples at offset %" G_GINT64_FORMAT,
1594 (guint) pbuf->m_towrite / bpf, pbuf->m_offset);
1596 if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1597 pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1600 pbuf->m_towrite = 0;
1601 pbuf->m_offset = offset + towrite; /* keep track of current offset */
1605 offset += avail * bpf;
1606 pbuf->m_lastoffset = offset;
1608 /* check if we need to uncork after writing the samples */
1610 const pa_timing_info *info;
1612 if ((info = pa_stream_get_timing_info (pbuf->stream))) {
1613 GST_LOG_OBJECT (psink,
1614 "read_index at %" G_GUINT64_FORMAT ", offset %" G_GINT64_FORMAT,
1615 info->read_index, offset);
1617 /* we uncork when the read_index is too far behind the offset we need
1619 if (info->read_index + bufsize <= offset) {
1620 if (!gst_pulsering_set_corked (pbuf, FALSE, FALSE))
1624 GST_LOG_OBJECT (psink, "no timing info available yet");
1629 #ifdef HAVE_PULSE_1_0
1632 /* we consumed all samples here */
1633 data = data_end + bpf;
1635 pbuf->in_commit = FALSE;
1636 pa_threaded_mainloop_unlock (mainloop);
1639 result = inr - ((data_end - data) / bpf);
1640 GST_LOG_OBJECT (psink, "wrote %d samples", result);
1647 pbuf->in_commit = FALSE;
1648 GST_LOG_OBJECT (psink, "we are reset");
1649 pa_threaded_mainloop_unlock (mainloop);
1654 GST_LOG_OBJECT (psink, "we can not start");
1659 GST_LOG_OBJECT (psink, "failed to start the ringbuffer");
1664 pbuf->in_commit = FALSE;
1665 GST_ERROR_OBJECT (psink, "uncork failed");
1666 pa_threaded_mainloop_unlock (mainloop);
1671 pbuf->in_commit = FALSE;
1672 GST_LOG_OBJECT (psink, "we are paused");
1673 pa_threaded_mainloop_unlock (mainloop);
1676 writable_size_failed:
1678 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1679 ("pa_stream_writable_size() failed: %s",
1680 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1681 goto unlock_and_fail;
1685 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1686 ("pa_stream_write() failed: %s",
1687 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1688 goto unlock_and_fail;
1692 /* write pending local samples, must be called with the mainloop lock */
1694 gst_pulsering_flush (GstPulseRingBuffer * pbuf)
1696 GstPulseSink *psink;
1698 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1699 GST_DEBUG_OBJECT (psink, "entering flush");
1701 /* flush the buffer if possible */
1702 if (pbuf->stream && (pbuf->m_data != NULL) && (pbuf->m_towrite > 0)) {
1703 #ifndef GST_DISABLE_GST_DEBUG
1706 bpf = (GST_AUDIO_RING_BUFFER_CAST (pbuf))->spec.info.bpf;
1707 GST_LOG_OBJECT (psink,
1708 "flushing %u samples at offset %" G_GINT64_FORMAT,
1709 (guint) pbuf->m_towrite / bpf, pbuf->m_offset);
1712 if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1713 pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1717 pbuf->m_towrite = 0;
1718 pbuf->m_offset += pbuf->m_towrite; /* keep track of current offset */
1727 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1728 ("pa_stream_write() failed: %s",
1729 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1734 static void gst_pulsesink_set_property (GObject * object, guint prop_id,
1735 const GValue * value, GParamSpec * pspec);
1736 static void gst_pulsesink_get_property (GObject * object, guint prop_id,
1737 GValue * value, GParamSpec * pspec);
1738 static void gst_pulsesink_finalize (GObject * object);
1740 static gboolean gst_pulsesink_event (GstBaseSink * sink, GstEvent * event);
1741 static gboolean gst_pulsesink_query (GstBaseSink * sink, GstQuery * query);
1743 static GstStateChangeReturn gst_pulsesink_change_state (GstElement * element,
1744 GstStateChange transition);
1746 static GstStaticPadTemplate pad_template = GST_STATIC_PAD_TEMPLATE ("sink",
1749 GST_STATIC_CAPS (PULSE_SINK_TEMPLATE_CAPS));
1751 GST_IMPLEMENT_PULSEPROBE_METHODS (GstPulseSink, gst_pulsesink);
1753 #define gst_pulsesink_parent_class parent_class
1754 G_DEFINE_TYPE_WITH_CODE (GstPulseSink, gst_pulsesink, GST_TYPE_BASE_AUDIO_SINK,
1755 gst_pulsesink_init_contexts ();
1756 G_IMPLEMENT_INTERFACE (GST_TYPE_PROPERTY_PROBE,
1757 gst_pulsesink_property_probe_interface_init);
1758 G_IMPLEMENT_INTERFACE (GST_TYPE_STREAM_VOLUME, NULL)
1761 static GstAudioRingBuffer *
1762 gst_pulsesink_create_ringbuffer (GstBaseAudioSink * sink)
1764 GstAudioRingBuffer *buffer;
1766 GST_DEBUG_OBJECT (sink, "creating ringbuffer");
1767 buffer = g_object_new (GST_TYPE_PULSERING_BUFFER, NULL);
1768 GST_DEBUG_OBJECT (sink, "created ringbuffer @%p", buffer);
1774 gst_pulsesink_payload (GstBaseAudioSink * sink, GstBuffer * buf)
1776 switch (sink->ringbuffer->spec.type) {
1777 case GST_BUFTYPE_AC3:
1778 case GST_BUFTYPE_EAC3:
1779 case GST_BUFTYPE_DTS:
1780 case GST_BUFTYPE_MPEG:
1782 /* FIXME: alloc memory from PA if possible */
1783 gint framesize = gst_audio_iec61937_frame_size (&sink->ringbuffer->spec);
1785 guint8 *indata, *outdata;
1786 gsize insize, outsize;
1792 out = gst_buffer_new_and_alloc (framesize);
1794 indata = gst_buffer_map (buf, &insize, NULL, GST_MAP_READ);
1795 outdata = gst_buffer_map (out, &outsize, NULL, GST_MAP_WRITE);
1797 res = gst_audio_iec61937_payload (indata, insize,
1798 outdata, outsize, &sink->ringbuffer->spec);
1800 gst_buffer_unmap (buf, indata, insize);
1801 gst_buffer_unmap (out, outdata, outsize);
1804 gst_buffer_unref (out);
1808 gst_buffer_copy_into (out, buf, GST_BUFFER_COPY_METADATA, 0, -1);
1813 return gst_buffer_ref (buf);
1818 gst_pulsesink_class_init (GstPulseSinkClass * klass)
1820 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
1821 GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
1822 GstBaseSinkClass *bc;
1823 GstBaseAudioSinkClass *gstaudiosink_class = GST_BASE_AUDIO_SINK_CLASS (klass);
1824 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
1826 gobject_class->finalize = gst_pulsesink_finalize;
1827 gobject_class->set_property = gst_pulsesink_set_property;
1828 gobject_class->get_property = gst_pulsesink_get_property;
1830 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_pulsesink_event);
1831 gstbasesink_class->query = GST_DEBUG_FUNCPTR (gst_pulsesink_query);
1833 /* restore the original basesink pull methods */
1834 bc = g_type_class_peek (GST_TYPE_BASE_SINK);
1835 gstbasesink_class->activate_pull = GST_DEBUG_FUNCPTR (bc->activate_pull);
1837 gstelement_class->change_state =
1838 GST_DEBUG_FUNCPTR (gst_pulsesink_change_state);
1840 gstaudiosink_class->create_ringbuffer =
1841 GST_DEBUG_FUNCPTR (gst_pulsesink_create_ringbuffer);
1842 gstaudiosink_class->payload = GST_DEBUG_FUNCPTR (gst_pulsesink_payload);
1844 /* Overwrite GObject fields */
1845 g_object_class_install_property (gobject_class,
1847 g_param_spec_string ("server", "Server",
1848 "The PulseAudio server to connect to", DEFAULT_SERVER,
1849 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1851 g_object_class_install_property (gobject_class, PROP_DEVICE,
1852 g_param_spec_string ("device", "Device",
1853 "The PulseAudio sink device to connect to", DEFAULT_DEVICE,
1854 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1856 g_object_class_install_property (gobject_class,
1858 g_param_spec_string ("device-name", "Device name",
1859 "Human-readable name of the sound device", DEFAULT_DEVICE_NAME,
1860 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1862 g_object_class_install_property (gobject_class,
1864 g_param_spec_double ("volume", "Volume",
1865 "Linear volume of this stream, 1.0=100%", 0.0, MAX_VOLUME,
1866 DEFAULT_VOLUME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1867 g_object_class_install_property (gobject_class,
1869 g_param_spec_boolean ("mute", "Mute",
1870 "Mute state of this stream", DEFAULT_MUTE,
1871 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1874 * GstPulseSink:client
1876 * The PulseAudio client name to use.
1880 g_object_class_install_property (gobject_class,
1882 g_param_spec_string ("client", "Client",
1883 "The PulseAudio client name to use", gst_pulse_client_name (),
1884 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
1885 GST_PARAM_MUTABLE_READY));
1888 * GstPulseSink:stream-properties
1890 * List of pulseaudio stream properties. A list of defined properties can be
1891 * found in the <ulink url="http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html">pulseaudio api docs</ulink>.
1893 * Below is an example for registering as a music application to pulseaudio.
1895 * GstStructure *props;
1897 * props = gst_structure_from_string ("props,media.role=music", NULL);
1898 * g_object_set (pulse, "stream-properties", props, NULL);
1899 * gst_structure_free
1904 g_object_class_install_property (gobject_class,
1905 PROP_STREAM_PROPERTIES,
1906 g_param_spec_boxed ("stream-properties", "stream properties",
1907 "list of pulseaudio stream properties",
1908 GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1910 gst_element_class_set_details_simple (gstelement_class,
1911 "PulseAudio Audio Sink",
1912 "Sink/Audio", "Plays audio to a PulseAudio server", "Lennart Poettering");
1913 gst_element_class_add_pad_template (gstelement_class,
1914 gst_static_pad_template_get (&pad_template));
1917 /* returns the current time of the sink ringbuffer */
1919 gst_pulsesink_get_time (GstClock * clock, GstBaseAudioSink * sink)
1921 GstPulseSink *psink;
1922 GstPulseRingBuffer *pbuf;
1925 if (!sink->ringbuffer || !sink->ringbuffer->acquired)
1926 return GST_CLOCK_TIME_NONE;
1928 pbuf = GST_PULSERING_BUFFER_CAST (sink->ringbuffer);
1929 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1931 #ifdef HAVE_PULSE_1_0
1932 if (g_atomic_int_get (&psink->format_lost)) {
1933 /* Stream was lost in a format change, it'll get set up again once
1934 * upstream renegotiates */
1935 return psink->format_lost_time;
1939 pa_threaded_mainloop_lock (mainloop);
1940 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1943 /* if we don't have enough data to get a timestamp, just return NONE, which
1944 * will return the last reported time */
1945 if (pa_stream_get_time (pbuf->stream, &time) < 0) {
1946 GST_DEBUG_OBJECT (psink, "could not get time");
1947 time = GST_CLOCK_TIME_NONE;
1950 pa_threaded_mainloop_unlock (mainloop);
1952 GST_LOG_OBJECT (psink, "current time is %" GST_TIME_FORMAT,
1953 GST_TIME_ARGS (time));
1960 GST_DEBUG_OBJECT (psink, "the server is dead");
1961 pa_threaded_mainloop_unlock (mainloop);
1963 return GST_CLOCK_TIME_NONE;
1968 gst_pulsesink_sink_info_cb (pa_context * c, const pa_sink_info * i, int eol,
1971 GstPulseRingBuffer *pbuf;
1972 GstPulseSink *psink;
1973 #ifdef HAVE_PULSE_1_0
1978 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
1979 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1984 g_free (psink->device_description);
1985 psink->device_description = g_strdup (i->description);
1987 #ifdef HAVE_PULSE_1_0
1988 g_mutex_lock (psink->sink_formats_lock);
1990 for (l = g_list_first (psink->sink_formats); l; l = g_list_next (l))
1991 pa_format_info_free ((pa_format_info *) l->data);
1993 g_list_free (psink->sink_formats);
1994 psink->sink_formats = NULL;
1996 for (j = 0; j < i->n_formats; j++)
1997 psink->sink_formats = g_list_prepend (psink->sink_formats,
1998 pa_format_info_copy (i->formats[j]));
2000 g_mutex_unlock (psink->sink_formats_lock);
2004 pa_threaded_mainloop_signal (mainloop, 0);
2007 #ifdef HAVE_PULSE_1_0
2008 /* NOTE: If you're making changes here, see if pulseaudiosink acceptcaps also
2009 * needs to be changed accordingly. */
2011 gst_pulsesink_query_acceptcaps (GstPulseSink * psink, GstCaps * caps)
2013 GstPulseRingBuffer *pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK
2014 (psink)->ringbuffer);
2015 GstPad *pad = GST_BASE_SINK_PAD (psink);
2018 gboolean ret = FALSE;
2020 GstAudioRingBufferSpec spec = { 0 };
2021 pa_stream *stream = NULL;
2022 pa_operation *o = NULL;
2023 pa_channel_map channel_map;
2024 pa_stream_flags_t flags;
2025 pa_format_info *format = NULL, *formats[1];
2028 pad_caps = gst_pad_get_caps (pad, caps);
2029 ret = pad_caps != NULL;
2030 gst_caps_unref (pad_caps);
2032 /* Either template caps didn't match, or we're still in NULL state */
2033 if (!ret || !pbuf->context)
2036 /* If we've not got fixed caps, creating a stream might fail, so let's just
2037 * return from here with default acceptcaps behaviour */
2038 if (!gst_caps_is_fixed (caps))
2043 pa_threaded_mainloop_lock (mainloop);
2045 spec.latency_time = GST_BASE_AUDIO_SINK (psink)->latency_time;
2046 if (!gst_audio_ring_buffer_parse_caps (&spec, caps))
2049 if (!gst_pulse_fill_format_info (&spec, &format, &channels))
2052 /* Make sure input is framed (one frame per buffer) and can be payloaded */
2053 if (!pa_format_info_is_pcm (format)) {
2054 gboolean framed = FALSE, parsed = FALSE;
2055 st = gst_caps_get_structure (caps, 0);
2057 gst_structure_get_boolean (st, "framed", &framed);
2058 gst_structure_get_boolean (st, "parsed", &parsed);
2059 if ((!framed && !parsed) || gst_audio_iec61937_frame_size (&spec) <= 0)
2063 /* initialize the channel map */
2064 if (pa_format_info_is_pcm (format) &&
2065 gst_pulse_gst_to_channel_map (&channel_map, &spec))
2066 pa_format_info_set_channel_map (format, &channel_map);
2069 /* We're already in PAUSED or above, so just reuse this stream to query
2070 * sink formats and use those. */
2073 if (!(o = pa_context_get_sink_info_by_name (pbuf->context, psink->device,
2074 gst_pulsesink_sink_info_cb, pbuf)))
2077 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2078 pa_threaded_mainloop_wait (mainloop);
2079 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2083 g_mutex_lock (psink->sink_formats_lock);
2084 for (i = g_list_first (psink->sink_formats); i; i = g_list_next (i)) {
2085 if (pa_format_info_is_compatible ((pa_format_info *) i->data, format)) {
2090 g_mutex_unlock (psink->sink_formats_lock);
2092 /* We're in READY, let's connect a stream to see if the format is
2093 * accpeted by whatever sink we're routed to */
2094 formats[0] = format;
2096 if (!(stream = pa_stream_new_extended (pbuf->context, "pulsesink probe",
2097 formats, 1, psink->proplist)))
2100 /* construct the flags */
2101 flags = PA_STREAM_INTERPOLATE_TIMING | PA_STREAM_AUTO_TIMING_UPDATE |
2102 PA_STREAM_ADJUST_LATENCY | PA_STREAM_START_CORKED;
2104 pa_stream_set_state_callback (stream, gst_pulsering_stream_state_cb, pbuf);
2106 if (pa_stream_connect_playback (stream, psink->device, NULL, flags, NULL,
2110 ret = gst_pulsering_wait_for_stream_ready (psink, stream);
2115 pa_format_info_free (format);
2118 pa_operation_unref (o);
2121 pa_stream_set_state_callback (stream, NULL, NULL);
2122 pa_stream_disconnect (stream);
2123 pa_stream_unref (stream);
2126 pa_threaded_mainloop_unlock (mainloop);
2133 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2134 ("pa_context_get_sink_input_info() failed: %s",
2135 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2142 gst_pulsesink_init (GstPulseSink * pulsesink)
2144 pulsesink->server = NULL;
2145 pulsesink->device = NULL;
2146 pulsesink->device_description = NULL;
2147 pulsesink->client_name = gst_pulse_client_name ();
2149 #ifdef HAVE_PULSE_1_0
2150 pulsesink->sink_formats_lock = g_mutex_new ();
2151 pulsesink->sink_formats = NULL;
2154 pulsesink->volume = DEFAULT_VOLUME;
2155 pulsesink->volume_set = FALSE;
2157 pulsesink->mute = DEFAULT_MUTE;
2158 pulsesink->mute_set = FALSE;
2160 pulsesink->notify = 0;
2162 #ifdef HAVE_PULSE_1_0
2163 g_atomic_int_set (&pulsesink->format_lost, FALSE);
2164 pulsesink->format_lost_time = GST_CLOCK_TIME_NONE;
2167 pulsesink->properties = NULL;
2168 pulsesink->proplist = NULL;
2170 /* override with a custom clock */
2171 if (GST_BASE_AUDIO_SINK (pulsesink)->provided_clock)
2172 gst_object_unref (GST_BASE_AUDIO_SINK (pulsesink)->provided_clock);
2174 GST_BASE_AUDIO_SINK (pulsesink)->provided_clock =
2175 gst_audio_clock_new ("GstPulseSinkClock",
2176 (GstAudioClockGetTimeFunc) gst_pulsesink_get_time, pulsesink, NULL);
2178 /* TRUE for sinks, FALSE for sources */
2179 pulsesink->probe = gst_pulseprobe_new (G_OBJECT (pulsesink),
2180 G_OBJECT_GET_CLASS (pulsesink), PROP_DEVICE, pulsesink->device,
2185 gst_pulsesink_finalize (GObject * object)
2187 GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2188 #ifdef HAVE_PULSE_1_0
2192 g_free (pulsesink->server);
2193 g_free (pulsesink->device);
2194 g_free (pulsesink->device_description);
2195 g_free (pulsesink->client_name);
2197 #ifdef HAVE_PULSE_1_0
2198 for (i = g_list_first (pulsesink->sink_formats); i; i = g_list_next (i))
2199 pa_format_info_free ((pa_format_info *) i->data);
2201 g_list_free (pulsesink->sink_formats);
2202 g_mutex_free (pulsesink->sink_formats_lock);
2205 if (pulsesink->properties)
2206 gst_structure_free (pulsesink->properties);
2207 if (pulsesink->proplist)
2208 pa_proplist_free (pulsesink->proplist);
2210 if (pulsesink->probe) {
2211 gst_pulseprobe_free (pulsesink->probe);
2212 pulsesink->probe = NULL;
2215 G_OBJECT_CLASS (parent_class)->finalize (object);
2219 gst_pulsesink_set_volume (GstPulseSink * psink, gdouble volume)
2222 pa_operation *o = NULL;
2223 GstPulseRingBuffer *pbuf;
2229 pa_threaded_mainloop_lock (mainloop);
2231 GST_DEBUG_OBJECT (psink, "setting volume to %f", volume);
2233 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2234 if (pbuf == NULL || pbuf->stream == NULL)
2237 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2240 #ifdef HAVE_PULSE_1_0
2242 gst_pulse_cvolume_from_linear (&v, pbuf->channels, volume);
2244 /* FIXME: this will eventually be superceded by checks to see if the volume
2245 * is readable/writable */
2248 gst_pulse_cvolume_from_linear (&v, pbuf->sample_spec.channels, volume);
2251 if (!(o = pa_context_set_sink_input_volume (pbuf->context, idx,
2255 /* We don't really care about the result of this call */
2259 pa_operation_unref (o);
2261 pa_threaded_mainloop_unlock (mainloop);
2268 psink->volume = volume;
2269 psink->volume_set = TRUE;
2271 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2276 psink->volume = volume;
2277 psink->volume_set = TRUE;
2279 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2284 GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2289 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2290 ("pa_stream_set_sink_input_volume() failed: %s",
2291 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2297 gst_pulsesink_set_mute (GstPulseSink * psink, gboolean mute)
2299 pa_operation *o = NULL;
2300 GstPulseRingBuffer *pbuf;
2306 pa_threaded_mainloop_lock (mainloop);
2308 GST_DEBUG_OBJECT (psink, "setting mute state to %d", mute);
2310 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2311 if (pbuf == NULL || pbuf->stream == NULL)
2314 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2317 if (!(o = pa_context_set_sink_input_mute (pbuf->context, idx,
2321 /* We don't really care about the result of this call */
2325 pa_operation_unref (o);
2327 pa_threaded_mainloop_unlock (mainloop);
2335 psink->mute_set = TRUE;
2337 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2343 psink->mute_set = TRUE;
2345 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2350 GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2355 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2356 ("pa_stream_set_sink_input_mute() failed: %s",
2357 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2363 gst_pulsesink_sink_input_info_cb (pa_context * c, const pa_sink_input_info * i,
2364 int eol, void *userdata)
2366 GstPulseRingBuffer *pbuf;
2367 GstPulseSink *psink;
2369 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
2370 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
2378 /* If the index doesn't match our current stream,
2379 * it implies we just recreated the stream (caps change)
2381 if (i->index == pa_stream_get_index (pbuf->stream)) {
2382 psink->volume = pa_sw_volume_to_linear (pa_cvolume_max (&i->volume));
2383 psink->mute = i->mute;
2387 pa_threaded_mainloop_signal (mainloop, 0);
2391 gst_pulsesink_get_volume (GstPulseSink * psink)
2393 GstPulseRingBuffer *pbuf;
2394 pa_operation *o = NULL;
2395 gdouble v = DEFAULT_VOLUME;
2401 pa_threaded_mainloop_lock (mainloop);
2403 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2404 if (pbuf == NULL || pbuf->stream == NULL)
2407 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2410 if (!(o = pa_context_get_sink_input_info (pbuf->context, idx,
2411 gst_pulsesink_sink_input_info_cb, pbuf)))
2414 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2415 pa_threaded_mainloop_wait (mainloop);
2416 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2424 pa_operation_unref (o);
2426 pa_threaded_mainloop_unlock (mainloop);
2428 if (v > MAX_VOLUME) {
2429 GST_WARNING_OBJECT (psink, "Clipped volume from %f to %f", v, MAX_VOLUME);
2439 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2444 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2449 GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2454 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2455 ("pa_context_get_sink_input_info() failed: %s",
2456 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2462 gst_pulsesink_get_mute (GstPulseSink * psink)
2464 GstPulseRingBuffer *pbuf;
2465 pa_operation *o = NULL;
2467 gboolean mute = FALSE;
2472 pa_threaded_mainloop_lock (mainloop);
2475 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2476 if (pbuf == NULL || pbuf->stream == NULL)
2479 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2482 if (!(o = pa_context_get_sink_input_info (pbuf->context, idx,
2483 gst_pulsesink_sink_input_info_cb, pbuf)))
2486 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2487 pa_threaded_mainloop_wait (mainloop);
2488 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2494 pa_operation_unref (o);
2496 pa_threaded_mainloop_unlock (mainloop);
2504 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2509 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2514 GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2519 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2520 ("pa_context_get_sink_input_info() failed: %s",
2521 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2527 gst_pulsesink_device_description (GstPulseSink * psink)
2529 GstPulseRingBuffer *pbuf;
2530 pa_operation *o = NULL;
2536 pa_threaded_mainloop_lock (mainloop);
2537 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2541 if (!(o = pa_context_get_sink_info_by_name (pbuf->context,
2542 psink->device, gst_pulsesink_sink_info_cb, pbuf)))
2545 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2546 pa_threaded_mainloop_wait (mainloop);
2547 if (gst_pulsering_is_dead (psink, pbuf, FALSE))
2553 pa_operation_unref (o);
2555 t = g_strdup (psink->device_description);
2556 pa_threaded_mainloop_unlock (mainloop);
2563 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2568 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2573 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2574 ("pa_context_get_sink_info_by_index() failed: %s",
2575 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2581 gst_pulsesink_set_property (GObject * object,
2582 guint prop_id, const GValue * value, GParamSpec * pspec)
2584 GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2588 g_free (pulsesink->server);
2589 pulsesink->server = g_value_dup_string (value);
2590 if (pulsesink->probe)
2591 gst_pulseprobe_set_server (pulsesink->probe, pulsesink->server);
2594 g_free (pulsesink->device);
2595 pulsesink->device = g_value_dup_string (value);
2598 gst_pulsesink_set_volume (pulsesink, g_value_get_double (value));
2601 gst_pulsesink_set_mute (pulsesink, g_value_get_boolean (value));
2604 g_free (pulsesink->client_name);
2605 if (!g_value_get_string (value)) {
2606 GST_WARNING_OBJECT (pulsesink,
2607 "Empty PulseAudio client name not allowed. Resetting to default value");
2608 pulsesink->client_name = gst_pulse_client_name ();
2610 pulsesink->client_name = g_value_dup_string (value);
2612 case PROP_STREAM_PROPERTIES:
2613 if (pulsesink->properties)
2614 gst_structure_free (pulsesink->properties);
2615 pulsesink->properties =
2616 gst_structure_copy (gst_value_get_structure (value));
2617 if (pulsesink->proplist)
2618 pa_proplist_free (pulsesink->proplist);
2619 pulsesink->proplist = gst_pulse_make_proplist (pulsesink->properties);
2622 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2628 gst_pulsesink_get_property (GObject * object,
2629 guint prop_id, GValue * value, GParamSpec * pspec)
2632 GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2636 g_value_set_string (value, pulsesink->server);
2639 g_value_set_string (value, pulsesink->device);
2641 case PROP_DEVICE_NAME:
2642 g_value_take_string (value, gst_pulsesink_device_description (pulsesink));
2645 g_value_set_double (value, gst_pulsesink_get_volume (pulsesink));
2648 g_value_set_boolean (value, gst_pulsesink_get_mute (pulsesink));
2651 g_value_set_string (value, pulsesink->client_name);
2653 case PROP_STREAM_PROPERTIES:
2654 gst_value_set_structure (value, pulsesink->properties);
2657 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2663 gst_pulsesink_change_title (GstPulseSink * psink, const gchar * t)
2665 pa_operation *o = NULL;
2666 GstPulseRingBuffer *pbuf;
2668 pa_threaded_mainloop_lock (mainloop);
2670 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2672 if (pbuf == NULL || pbuf->stream == NULL)
2675 g_free (pbuf->stream_name);
2676 pbuf->stream_name = g_strdup (t);
2678 if (!(o = pa_stream_set_name (pbuf->stream, pbuf->stream_name, NULL, NULL)))
2681 /* We're not interested if this operation failed or not */
2685 pa_operation_unref (o);
2686 pa_threaded_mainloop_unlock (mainloop);
2693 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2698 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2699 ("pa_stream_set_name() failed: %s",
2700 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2706 gst_pulsesink_change_props (GstPulseSink * psink, GstTagList * l)
2708 static const gchar *const map[] = {
2709 GST_TAG_TITLE, PA_PROP_MEDIA_TITLE,
2711 /* might get overriden in the next iteration by GST_TAG_ARTIST */
2712 GST_TAG_PERFORMER, PA_PROP_MEDIA_ARTIST,
2714 GST_TAG_ARTIST, PA_PROP_MEDIA_ARTIST,
2715 GST_TAG_LANGUAGE_CODE, PA_PROP_MEDIA_LANGUAGE,
2716 GST_TAG_LOCATION, PA_PROP_MEDIA_FILENAME,
2717 /* We might add more here later on ... */
2720 pa_proplist *pl = NULL;
2721 const gchar *const *t;
2722 gboolean empty = TRUE;
2723 pa_operation *o = NULL;
2724 GstPulseRingBuffer *pbuf;
2726 pl = pa_proplist_new ();
2728 for (t = map; *t; t += 2) {
2731 if (gst_tag_list_get_string (l, *t, &n)) {
2734 pa_proplist_sets (pl, *(t + 1), n);
2744 pa_threaded_mainloop_lock (mainloop);
2745 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2746 if (pbuf == NULL || pbuf->stream == NULL)
2749 if (!(o = pa_stream_proplist_update (pbuf->stream, PA_UPDATE_REPLACE,
2753 /* We're not interested if this operation failed or not */
2757 pa_operation_unref (o);
2759 pa_threaded_mainloop_unlock (mainloop);
2764 pa_proplist_free (pl);
2771 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2776 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2777 ("pa_stream_proplist_update() failed: %s",
2778 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2784 gst_pulsesink_flush_ringbuffer (GstPulseSink * psink)
2786 GstPulseRingBuffer *pbuf;
2788 pa_threaded_mainloop_lock (mainloop);
2790 pbuf = GST_PULSERING_BUFFER_CAST (GST_BASE_AUDIO_SINK (psink)->ringbuffer);
2792 if (pbuf == NULL || pbuf->stream == NULL)
2795 gst_pulsering_flush (pbuf);
2797 /* Uncork if we haven't already (happens when waiting to get enough data
2798 * to send out the first time) */
2800 gst_pulsering_set_corked (pbuf, FALSE, FALSE);
2802 /* We're not interested if this operation failed or not */
2804 pa_threaded_mainloop_unlock (mainloop);
2811 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2817 gst_pulsesink_event (GstBaseSink * sink, GstEvent * event)
2819 GstPulseSink *pulsesink = GST_PULSESINK_CAST (sink);
2821 switch (GST_EVENT_TYPE (event)) {
2822 case GST_EVENT_TAG:{
2823 gchar *title = NULL, *artist = NULL, *location = NULL, *description =
2824 NULL, *t = NULL, *buf = NULL;
2827 gst_event_parse_tag (event, &l);
2829 gst_tag_list_get_string (l, GST_TAG_TITLE, &title);
2830 gst_tag_list_get_string (l, GST_TAG_ARTIST, &artist);
2831 gst_tag_list_get_string (l, GST_TAG_LOCATION, &location);
2832 gst_tag_list_get_string (l, GST_TAG_DESCRIPTION, &description);
2835 gst_tag_list_get_string (l, GST_TAG_PERFORMER, &artist);
2837 if (title && artist)
2838 /* TRANSLATORS: 'song title' by 'artist name' */
2839 t = buf = g_strdup_printf (_("'%s' by '%s'"), g_strstrip (title),
2840 g_strstrip (artist));
2842 t = g_strstrip (title);
2843 else if (description)
2844 t = g_strstrip (description);
2846 t = g_strstrip (location);
2849 gst_pulsesink_change_title (pulsesink, t);
2854 g_free (description);
2857 gst_pulsesink_change_props (pulsesink, l);
2862 gst_pulsesink_flush_ringbuffer (pulsesink);
2868 return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
2872 gst_pulsesink_query (GstBaseSink * sink, GstQuery * query)
2874 #ifdef HAVE_PULSE_1_0
2875 GstPulseSink *pulsesink = GST_PULSESINK_CAST (sink);
2878 switch (GST_QUERY_TYPE (query)) {
2879 case GST_QUERY_ACCEPT_CAPS:
2883 gst_query_parse_accept_caps (query, &caps);
2884 ret = gst_pulsesink_query_acceptcaps (pulsesink, caps);
2885 gst_query_set_accept_caps_result (query, ret);
2890 ret = GST_BASE_SINK_CLASS (parent_class)->query (sink, query);
2895 return GST_BASE_SINK_CLASS (parent_class)->query (sink, query);
2900 gst_pulsesink_release_mainloop (GstPulseSink * psink)
2905 pa_threaded_mainloop_lock (mainloop);
2906 while (psink->defer_pending) {
2907 GST_DEBUG_OBJECT (psink, "waiting for stream status message emission");
2908 pa_threaded_mainloop_wait (mainloop);
2910 pa_threaded_mainloop_unlock (mainloop);
2912 g_mutex_lock (pa_shared_resource_mutex);
2914 if (!mainloop_ref_ct) {
2915 GST_INFO_OBJECT (psink, "terminating pa main loop thread");
2916 pa_threaded_mainloop_stop (mainloop);
2917 pa_threaded_mainloop_free (mainloop);
2920 g_mutex_unlock (pa_shared_resource_mutex);
2923 static GstStateChangeReturn
2924 gst_pulsesink_change_state (GstElement * element, GstStateChange transition)
2926 GstPulseSink *pulsesink = GST_PULSESINK (element);
2927 GstStateChangeReturn ret;
2929 switch (transition) {
2930 case GST_STATE_CHANGE_NULL_TO_READY:
2931 g_mutex_lock (pa_shared_resource_mutex);
2932 if (!mainloop_ref_ct) {
2933 GST_INFO_OBJECT (element, "new pa main loop thread");
2934 if (!(mainloop = pa_threaded_mainloop_new ()))
2935 goto mainloop_failed;
2936 mainloop_ref_ct = 1;
2937 pa_threaded_mainloop_start (mainloop);
2938 g_mutex_unlock (pa_shared_resource_mutex);
2940 GST_INFO_OBJECT (element, "reusing pa main loop thread");
2942 g_mutex_unlock (pa_shared_resource_mutex);
2945 case GST_STATE_CHANGE_READY_TO_PAUSED:
2946 gst_element_post_message (element,
2947 gst_message_new_clock_provide (GST_OBJECT_CAST (element),
2948 GST_BASE_AUDIO_SINK (pulsesink)->provided_clock, TRUE));
2955 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2956 if (ret == GST_STATE_CHANGE_FAILURE)
2959 switch (transition) {
2960 case GST_STATE_CHANGE_PAUSED_TO_READY:
2961 /* format_lost is reset in release() in baseaudiosink */
2962 gst_element_post_message (element,
2963 gst_message_new_clock_lost (GST_OBJECT_CAST (element),
2964 GST_BASE_AUDIO_SINK (pulsesink)->provided_clock));
2966 case GST_STATE_CHANGE_READY_TO_NULL:
2967 gst_pulsesink_release_mainloop (pulsesink);
2978 g_mutex_unlock (pa_shared_resource_mutex);
2979 GST_ELEMENT_ERROR (pulsesink, RESOURCE, FAILED,
2980 ("pa_threaded_mainloop_new() failed"), (NULL));
2981 return GST_STATE_CHANGE_FAILURE;
2985 if (transition == GST_STATE_CHANGE_NULL_TO_READY) {
2986 /* Clear the PA mainloop if baseaudiosink failed to open the ring_buffer */
2987 g_assert (mainloop);
2988 gst_pulsesink_release_mainloop (pulsesink);