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/audio/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 <gst/glib-compat-private.h>
63 #include "pulsesink.h"
64 #include "pulseutil.h"
66 GST_DEBUG_CATEGORY_EXTERN (pulse_debug);
67 #define GST_CAT_DEFAULT pulse_debug
69 #define DEFAULT_SERVER NULL
70 #define DEFAULT_DEVICE NULL
71 #define DEFAULT_DEVICE_NAME NULL
72 #define DEFAULT_VOLUME 1.0
73 #define DEFAULT_MUTE FALSE
74 #define MAX_VOLUME 10.0
85 PROP_STREAM_PROPERTIES,
89 #define GST_TYPE_PULSERING_BUFFER \
90 (gst_pulseringbuffer_get_type())
91 #define GST_PULSERING_BUFFER(obj) \
92 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PULSERING_BUFFER,GstPulseRingBuffer))
93 #define GST_PULSERING_BUFFER_CLASS(klass) \
94 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PULSERING_BUFFER,GstPulseRingBufferClass))
95 #define GST_PULSERING_BUFFER_GET_CLASS(obj) \
96 (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PULSERING_BUFFER, GstPulseRingBufferClass))
97 #define GST_PULSERING_BUFFER_CAST(obj) \
98 ((GstPulseRingBuffer *)obj)
99 #define GST_IS_PULSERING_BUFFER(obj) \
100 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PULSERING_BUFFER))
101 #define GST_IS_PULSERING_BUFFER_CLASS(klass)\
102 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PULSERING_BUFFER))
104 typedef struct _GstPulseRingBuffer GstPulseRingBuffer;
105 typedef struct _GstPulseRingBufferClass GstPulseRingBufferClass;
107 typedef struct _GstPulseContext GstPulseContext;
109 /* Store the PA contexts in a hash table to allow easy sharing among
110 * multiple instances of the sink. Keys are $context_name@$server_name
111 * (strings) and values should be GstPulseContext pointers.
113 struct _GstPulseContext
116 GSList *ring_buffers;
119 static GHashTable *gst_pulse_shared_contexts = NULL;
121 /* use one static main-loop for all instances
122 * this is needed to make the context sharing work as the contexts are
123 * released when releasing their parent main-loop
125 static pa_threaded_mainloop *mainloop = NULL;
126 static guint mainloop_ref_ct = 0;
128 /* lock for access to shared resources */
129 static GMutex pa_shared_resource_mutex;
131 /* We keep a custom ringbuffer that is backed up by data allocated by
132 * pulseaudio. We must also overide the commit function to write into
133 * pulseaudio memory instead. */
134 struct _GstPulseRingBuffer
136 GstAudioRingBuffer object;
144 pa_format_info *format;
155 gboolean in_commit:1;
158 struct _GstPulseRingBufferClass
160 GstAudioRingBufferClass parent_class;
163 static GType gst_pulseringbuffer_get_type (void);
164 static void gst_pulseringbuffer_finalize (GObject * object);
166 static GstAudioRingBufferClass *ring_parent_class = NULL;
168 static gboolean gst_pulseringbuffer_open_device (GstAudioRingBuffer * buf);
169 static gboolean gst_pulseringbuffer_close_device (GstAudioRingBuffer * buf);
170 static gboolean gst_pulseringbuffer_acquire (GstAudioRingBuffer * buf,
171 GstAudioRingBufferSpec * spec);
172 static gboolean gst_pulseringbuffer_release (GstAudioRingBuffer * buf);
173 static gboolean gst_pulseringbuffer_start (GstAudioRingBuffer * buf);
174 static gboolean gst_pulseringbuffer_pause (GstAudioRingBuffer * buf);
175 static gboolean gst_pulseringbuffer_stop (GstAudioRingBuffer * buf);
176 static void gst_pulseringbuffer_clear (GstAudioRingBuffer * buf);
177 static guint gst_pulseringbuffer_commit (GstAudioRingBuffer * buf,
178 guint64 * sample, guchar * data, gint in_samples, gint out_samples,
181 G_DEFINE_TYPE (GstPulseRingBuffer, gst_pulseringbuffer,
182 GST_TYPE_AUDIO_RING_BUFFER);
185 gst_pulsesink_init_contexts (void)
187 g_mutex_init (&pa_shared_resource_mutex);
188 gst_pulse_shared_contexts = g_hash_table_new_full (g_str_hash, g_str_equal,
193 gst_pulseringbuffer_class_init (GstPulseRingBufferClass * klass)
195 GObjectClass *gobject_class;
196 GstAudioRingBufferClass *gstringbuffer_class;
198 gobject_class = (GObjectClass *) klass;
199 gstringbuffer_class = (GstAudioRingBufferClass *) klass;
201 ring_parent_class = g_type_class_peek_parent (klass);
203 gobject_class->finalize = gst_pulseringbuffer_finalize;
205 gstringbuffer_class->open_device =
206 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_open_device);
207 gstringbuffer_class->close_device =
208 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_close_device);
209 gstringbuffer_class->acquire =
210 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_acquire);
211 gstringbuffer_class->release =
212 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_release);
213 gstringbuffer_class->start = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_start);
214 gstringbuffer_class->pause = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_pause);
215 gstringbuffer_class->resume = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_start);
216 gstringbuffer_class->stop = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_stop);
217 gstringbuffer_class->clear_all =
218 GST_DEBUG_FUNCPTR (gst_pulseringbuffer_clear);
220 gstringbuffer_class->commit = GST_DEBUG_FUNCPTR (gst_pulseringbuffer_commit);
224 gst_pulseringbuffer_init (GstPulseRingBuffer * pbuf)
226 pbuf->stream_name = NULL;
227 pbuf->context = NULL;
232 pbuf->is_pcm = FALSE;
236 pbuf->m_writable = 0;
238 pbuf->m_lastoffset = 0;
241 pbuf->in_commit = FALSE;
242 pbuf->paused = FALSE;
246 gst_pulsering_destroy_stream (GstPulseRingBuffer * pbuf)
251 /* drop shm memory buffer */
252 pa_stream_cancel_write (pbuf->stream);
254 /* reset internal variables */
257 pbuf->m_writable = 0;
259 pbuf->m_lastoffset = 0;
262 pa_format_info_free (pbuf->format);
265 pbuf->is_pcm = FALSE;
268 pa_stream_disconnect (pbuf->stream);
270 /* Make sure we don't get any further callbacks */
271 pa_stream_set_state_callback (pbuf->stream, NULL, NULL);
272 pa_stream_set_write_callback (pbuf->stream, NULL, NULL);
273 pa_stream_set_underflow_callback (pbuf->stream, NULL, NULL);
274 pa_stream_set_overflow_callback (pbuf->stream, NULL, NULL);
276 pa_stream_unref (pbuf->stream);
280 g_free (pbuf->stream_name);
281 pbuf->stream_name = NULL;
285 gst_pulsering_destroy_context (GstPulseRingBuffer * pbuf)
287 g_mutex_lock (&pa_shared_resource_mutex);
289 GST_DEBUG_OBJECT (pbuf, "destroying ringbuffer %p", pbuf);
291 gst_pulsering_destroy_stream (pbuf);
294 pa_context_unref (pbuf->context);
295 pbuf->context = NULL;
298 if (pbuf->context_name) {
299 GstPulseContext *pctx;
301 pctx = g_hash_table_lookup (gst_pulse_shared_contexts, pbuf->context_name);
303 GST_DEBUG_OBJECT (pbuf, "releasing context with name %s, pbuf=%p, pctx=%p",
304 pbuf->context_name, pbuf, pctx);
307 pctx->ring_buffers = g_slist_remove (pctx->ring_buffers, pbuf);
308 if (pctx->ring_buffers == NULL) {
309 GST_DEBUG_OBJECT (pbuf,
310 "destroying final context with name %s, pbuf=%p, pctx=%p",
311 pbuf->context_name, pbuf, pctx);
313 pa_context_disconnect (pctx->context);
315 /* Make sure we don't get any further callbacks */
316 pa_context_set_state_callback (pctx->context, NULL, NULL);
317 pa_context_set_subscribe_callback (pctx->context, NULL, NULL);
319 g_hash_table_remove (gst_pulse_shared_contexts, pbuf->context_name);
321 pa_context_unref (pctx->context);
322 g_slice_free (GstPulseContext, pctx);
325 g_free (pbuf->context_name);
326 pbuf->context_name = NULL;
328 g_mutex_unlock (&pa_shared_resource_mutex);
332 gst_pulseringbuffer_finalize (GObject * object)
334 GstPulseRingBuffer *ringbuffer;
336 ringbuffer = GST_PULSERING_BUFFER_CAST (object);
338 gst_pulsering_destroy_context (ringbuffer);
339 G_OBJECT_CLASS (ring_parent_class)->finalize (object);
343 #define CONTEXT_OK(c) ((c) && PA_CONTEXT_IS_GOOD (pa_context_get_state ((c))))
344 #define STREAM_OK(s) ((s) && PA_STREAM_IS_GOOD (pa_stream_get_state ((s))))
347 gst_pulsering_is_dead (GstPulseSink * psink, GstPulseRingBuffer * pbuf,
348 gboolean check_stream)
350 if (!CONTEXT_OK (pbuf->context))
353 if (check_stream && !STREAM_OK (pbuf->stream))
360 const gchar *err_str =
361 pbuf->context ? pa_strerror (pa_context_errno (pbuf->context)) : NULL;
362 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED, ("Disconnected: %s",
369 gst_pulsering_context_state_cb (pa_context * c, void *userdata)
371 pa_context_state_t state;
372 pa_threaded_mainloop *mainloop = (pa_threaded_mainloop *) userdata;
374 state = pa_context_get_state (c);
376 GST_LOG ("got new context state %d", state);
379 case PA_CONTEXT_READY:
380 case PA_CONTEXT_TERMINATED:
381 case PA_CONTEXT_FAILED:
382 GST_LOG ("signaling");
383 pa_threaded_mainloop_signal (mainloop, 0);
386 case PA_CONTEXT_UNCONNECTED:
387 case PA_CONTEXT_CONNECTING:
388 case PA_CONTEXT_AUTHORIZING:
389 case PA_CONTEXT_SETTING_NAME:
395 gst_pulsering_context_subscribe_cb (pa_context * c,
396 pa_subscription_event_type_t t, uint32_t idx, void *userdata)
399 GstPulseContext *pctx = (GstPulseContext *) userdata;
402 if (t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT | PA_SUBSCRIPTION_EVENT_CHANGE) &&
403 t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT | PA_SUBSCRIPTION_EVENT_NEW))
406 for (walk = pctx->ring_buffers; walk; walk = g_slist_next (walk)) {
407 GstPulseRingBuffer *pbuf = (GstPulseRingBuffer *) walk->data;
408 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
410 GST_LOG_OBJECT (psink, "type %d, idx %u", t, idx);
415 if (idx != pa_stream_get_index (pbuf->stream))
418 if (psink->device && pbuf->is_pcm &&
419 !g_str_equal (psink->device,
420 pa_stream_get_device_name (pbuf->stream))) {
421 /* Underlying sink changed. And this is not a passthrough stream. Let's
422 * see if someone upstream wants to try to renegotiate. */
425 g_free (psink->device);
426 psink->device = g_strdup (pa_stream_get_device_name (pbuf->stream));
428 GST_INFO_OBJECT (psink, "emitting sink-changed");
430 /* FIXME: send reconfigure event instead and let decodebin/playbin
431 * handle that. Also take care of ac3 alignment. See "pulse-format-lost" */
432 renego = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM,
433 gst_structure_new_empty ("pulse-sink-changed"));
435 if (!gst_pad_push_event (GST_BASE_SINK (psink)->sinkpad, renego))
436 GST_DEBUG_OBJECT (psink, "Emitted sink-changed - nobody was listening");
439 /* Actually this event is also triggered when other properties of
440 * the stream change that are unrelated to the volume. However it is
441 * probably cheaper to signal the change here and check for the
442 * volume when the GObject property is read instead of querying it always. */
444 /* inform streaming thread to notify */
445 g_atomic_int_compare_and_exchange (&psink->notify, 0, 1);
449 /* will be called when the device should be opened. In this case we will connect
450 * to the server. We should not try to open any streams in this state. */
452 gst_pulseringbuffer_open_device (GstAudioRingBuffer * buf)
455 GstPulseRingBuffer *pbuf;
456 GstPulseContext *pctx;
457 pa_mainloop_api *api;
458 gboolean need_unlock_shared;
460 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (buf));
461 pbuf = GST_PULSERING_BUFFER_CAST (buf);
463 g_assert (!pbuf->stream);
464 g_assert (psink->client_name);
467 pbuf->context_name = g_strdup_printf ("%s@%s", psink->client_name,
470 pbuf->context_name = g_strdup (psink->client_name);
472 pa_threaded_mainloop_lock (mainloop);
474 g_mutex_lock (&pa_shared_resource_mutex);
475 need_unlock_shared = TRUE;
477 pctx = g_hash_table_lookup (gst_pulse_shared_contexts, pbuf->context_name);
479 pctx = g_slice_new0 (GstPulseContext);
481 /* get the mainloop api and create a context */
482 GST_INFO_OBJECT (psink, "new context with name %s, pbuf=%p, pctx=%p",
483 pbuf->context_name, pbuf, pctx);
484 api = pa_threaded_mainloop_get_api (mainloop);
485 if (!(pctx->context = pa_context_new (api, pbuf->context_name)))
488 pctx->ring_buffers = g_slist_prepend (pctx->ring_buffers, pbuf);
489 g_hash_table_insert (gst_pulse_shared_contexts,
490 g_strdup (pbuf->context_name), (gpointer) pctx);
491 /* register some essential callbacks */
492 pa_context_set_state_callback (pctx->context,
493 gst_pulsering_context_state_cb, mainloop);
494 pa_context_set_subscribe_callback (pctx->context,
495 gst_pulsering_context_subscribe_cb, pctx);
497 /* try to connect to the server and wait for completion, we don't want to
498 * autospawn a deamon */
499 GST_LOG_OBJECT (psink, "connect to server %s",
500 GST_STR_NULL (psink->server));
501 if (pa_context_connect (pctx->context, psink->server,
502 PA_CONTEXT_NOAUTOSPAWN, NULL) < 0)
505 GST_INFO_OBJECT (psink,
506 "reusing shared context with name %s, pbuf=%p, pctx=%p",
507 pbuf->context_name, pbuf, pctx);
508 pctx->ring_buffers = g_slist_prepend (pctx->ring_buffers, pbuf);
511 g_mutex_unlock (&pa_shared_resource_mutex);
512 need_unlock_shared = FALSE;
514 /* context created or shared okay */
515 pbuf->context = pa_context_ref (pctx->context);
518 pa_context_state_t state;
520 state = pa_context_get_state (pbuf->context);
522 GST_LOG_OBJECT (psink, "context state is now %d", state);
524 if (!PA_CONTEXT_IS_GOOD (state))
527 if (state == PA_CONTEXT_READY)
530 /* Wait until the context is ready */
531 GST_LOG_OBJECT (psink, "waiting..");
532 pa_threaded_mainloop_wait (mainloop);
535 GST_LOG_OBJECT (psink, "opened the device");
537 pa_threaded_mainloop_unlock (mainloop);
544 if (need_unlock_shared)
545 g_mutex_unlock (&pa_shared_resource_mutex);
546 gst_pulsering_destroy_context (pbuf);
547 pa_threaded_mainloop_unlock (mainloop);
552 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
553 ("Failed to create context"), (NULL));
554 g_slice_free (GstPulseContext, pctx);
555 goto unlock_and_fail;
559 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED, ("Failed to connect: %s",
560 pa_strerror (pa_context_errno (pctx->context))), (NULL));
561 goto unlock_and_fail;
565 /* close the device */
567 gst_pulseringbuffer_close_device (GstAudioRingBuffer * buf)
570 GstPulseRingBuffer *pbuf;
572 pbuf = GST_PULSERING_BUFFER_CAST (buf);
573 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (buf));
575 GST_LOG_OBJECT (psink, "closing device");
577 pa_threaded_mainloop_lock (mainloop);
578 gst_pulsering_destroy_context (pbuf);
579 pa_threaded_mainloop_unlock (mainloop);
581 GST_LOG_OBJECT (psink, "closed device");
587 gst_pulsering_stream_state_cb (pa_stream * s, void *userdata)
590 GstPulseRingBuffer *pbuf;
591 pa_stream_state_t state;
593 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
594 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
596 state = pa_stream_get_state (s);
597 GST_LOG_OBJECT (psink, "got new stream state %d", state);
600 case PA_STREAM_READY:
601 case PA_STREAM_FAILED:
602 case PA_STREAM_TERMINATED:
603 GST_LOG_OBJECT (psink, "signaling");
604 pa_threaded_mainloop_signal (mainloop, 0);
606 case PA_STREAM_UNCONNECTED:
607 case PA_STREAM_CREATING:
613 gst_pulsering_stream_request_cb (pa_stream * s, size_t length, void *userdata)
616 GstAudioRingBuffer *rbuf;
617 GstPulseRingBuffer *pbuf;
619 rbuf = GST_AUDIO_RING_BUFFER_CAST (userdata);
620 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
621 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
623 GST_LOG_OBJECT (psink, "got request for length %" G_GSIZE_FORMAT, length);
625 if (pbuf->in_commit && (length >= rbuf->spec.segsize)) {
626 /* only signal when we are waiting in the commit thread
627 * and got request for atleast a segment */
628 pa_threaded_mainloop_signal (mainloop, 0);
633 gst_pulsering_stream_underflow_cb (pa_stream * s, void *userdata)
636 GstPulseRingBuffer *pbuf;
638 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
639 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
641 GST_WARNING_OBJECT (psink, "Got underflow");
645 gst_pulsering_stream_overflow_cb (pa_stream * s, void *userdata)
648 GstPulseRingBuffer *pbuf;
650 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
651 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
653 GST_WARNING_OBJECT (psink, "Got overflow");
657 gst_pulsering_stream_latency_cb (pa_stream * s, void *userdata)
660 GstPulseRingBuffer *pbuf;
661 const pa_timing_info *info;
664 info = pa_stream_get_timing_info (s);
666 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
667 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
670 GST_LOG_OBJECT (psink, "latency update (information unknown)");
673 sink_usec = info->configured_sink_usec;
675 GST_LOG_OBJECT (psink,
676 "latency_update, %" G_GUINT64_FORMAT ", %d:%" G_GINT64_FORMAT ", %d:%"
677 G_GUINT64_FORMAT ", %" G_GUINT64_FORMAT ", %" G_GUINT64_FORMAT,
678 GST_TIMEVAL_TO_TIME (info->timestamp), info->write_index_corrupt,
679 info->write_index, info->read_index_corrupt, info->read_index,
680 info->sink_usec, sink_usec);
684 gst_pulsering_stream_suspended_cb (pa_stream * p, void *userdata)
687 GstPulseRingBuffer *pbuf;
689 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
690 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
692 if (pa_stream_is_suspended (p))
693 GST_DEBUG_OBJECT (psink, "stream suspended");
695 GST_DEBUG_OBJECT (psink, "stream resumed");
699 gst_pulsering_stream_started_cb (pa_stream * p, void *userdata)
702 GstPulseRingBuffer *pbuf;
704 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
705 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
707 GST_DEBUG_OBJECT (psink, "stream started");
711 gst_pulsering_stream_event_cb (pa_stream * p, const char *name,
712 pa_proplist * pl, void *userdata)
715 GstPulseRingBuffer *pbuf;
717 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
718 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
720 if (!strcmp (name, PA_STREAM_EVENT_REQUEST_CORK)) {
721 /* the stream wants to PAUSE, post a message for the application. */
722 GST_DEBUG_OBJECT (psink, "got request for CORK");
723 gst_element_post_message (GST_ELEMENT_CAST (psink),
724 gst_message_new_request_state (GST_OBJECT_CAST (psink),
727 } else if (!strcmp (name, PA_STREAM_EVENT_REQUEST_UNCORK)) {
728 GST_DEBUG_OBJECT (psink, "got request for UNCORK");
729 gst_element_post_message (GST_ELEMENT_CAST (psink),
730 gst_message_new_request_state (GST_OBJECT_CAST (psink),
732 } else if (!strcmp (name, PA_STREAM_EVENT_FORMAT_LOST)) {
735 if (g_atomic_int_get (&psink->format_lost)) {
736 /* Duplicate event before we're done reconfiguring, discard */
740 GST_DEBUG_OBJECT (psink, "got FORMAT LOST");
741 g_atomic_int_set (&psink->format_lost, 1);
742 psink->format_lost_time = g_ascii_strtoull (pa_proplist_gets (pl,
743 "stream-time"), NULL, 0) * 1000;
745 g_free (psink->device);
746 psink->device = g_strdup (pa_proplist_gets (pl, "device"));
748 /* FIXME: send reconfigure event instead and let decodebin/playbin
749 * handle that. Also take care of ac3 alignment */
750 renego = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM,
751 gst_structure_new_empty ("pulse-format-lost"));
754 if (g_str_equal (gst_structure_get_name (st), "audio/x-eac3")) {
755 GstStructure *event_st = gst_structure_new ("ac3parse-set-alignment",
756 "alignment", G_TYPE_STRING, pbin->dbin ? "frame" : "iec61937", NULL);
758 if (!gst_pad_push_event (pbin->sinkpad,
759 gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM, event_st)))
760 GST_WARNING_OBJECT (pbin->sinkpad, "Could not update alignment");
764 if (!gst_pad_push_event (GST_BASE_SINK (psink)->sinkpad, renego)) {
765 /* Nobody handled the format change - emit an error */
766 GST_ELEMENT_ERROR (psink, STREAM, FORMAT, ("Sink format changed"),
767 ("Sink format changed"));
770 GST_DEBUG_OBJECT (psink, "got unknown event %s", name);
774 /* Called with the mainloop locked */
776 gst_pulsering_wait_for_stream_ready (GstPulseSink * psink, pa_stream * stream)
778 pa_stream_state_t state;
781 state = pa_stream_get_state (stream);
783 GST_LOG_OBJECT (psink, "stream state is now %d", state);
785 if (!PA_STREAM_IS_GOOD (state))
788 if (state == PA_STREAM_READY)
791 /* Wait until the stream is ready */
792 pa_threaded_mainloop_wait (mainloop);
797 /* This method should create a new stream of the given @spec. No playback should
798 * start yet so we start in the corked state. */
800 gst_pulseringbuffer_acquire (GstAudioRingBuffer * buf,
801 GstAudioRingBufferSpec * spec)
804 GstPulseRingBuffer *pbuf;
805 pa_buffer_attr wanted;
806 const pa_buffer_attr *actual;
807 pa_channel_map channel_map;
808 pa_operation *o = NULL;
810 pa_cvolume *pv = NULL;
811 pa_stream_flags_t flags;
813 GstAudioClock *clock;
814 pa_format_info *formats[1];
815 #ifndef GST_DISABLE_GST_DEBUG
816 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 if (!gst_pulse_fill_format_info (spec, &pbuf->format, &pbuf->channels))
826 pbuf->is_pcm = pa_format_info_is_pcm (pbuf->format);
828 pa_threaded_mainloop_lock (mainloop);
830 /* we need a context and a no stream */
831 g_assert (pbuf->context);
832 g_assert (!pbuf->stream);
834 /* enable event notifications */
835 GST_LOG_OBJECT (psink, "subscribing to context events");
836 if (!(o = pa_context_subscribe (pbuf->context,
837 PA_SUBSCRIPTION_MASK_SINK_INPUT, NULL, NULL)))
838 goto subscribe_failed;
840 pa_operation_unref (o);
842 /* initialize the channel map */
843 if (pbuf->is_pcm && gst_pulse_gst_to_channel_map (&channel_map, spec))
844 pa_format_info_set_channel_map (pbuf->format, &channel_map);
846 /* find a good name for the stream */
847 if (psink->stream_name)
848 name = psink->stream_name;
850 name = "Playback Stream";
852 /* create a stream */
853 formats[0] = pbuf->format;
854 if (!(pbuf->stream = pa_stream_new_extended (pbuf->context, name, formats, 1,
858 /* install essential callbacks */
859 pa_stream_set_state_callback (pbuf->stream,
860 gst_pulsering_stream_state_cb, pbuf);
861 pa_stream_set_write_callback (pbuf->stream,
862 gst_pulsering_stream_request_cb, pbuf);
863 pa_stream_set_underflow_callback (pbuf->stream,
864 gst_pulsering_stream_underflow_cb, pbuf);
865 pa_stream_set_overflow_callback (pbuf->stream,
866 gst_pulsering_stream_overflow_cb, pbuf);
867 pa_stream_set_latency_update_callback (pbuf->stream,
868 gst_pulsering_stream_latency_cb, pbuf);
869 pa_stream_set_suspended_callback (pbuf->stream,
870 gst_pulsering_stream_suspended_cb, pbuf);
871 pa_stream_set_started_callback (pbuf->stream,
872 gst_pulsering_stream_started_cb, pbuf);
873 pa_stream_set_event_callback (pbuf->stream,
874 gst_pulsering_stream_event_cb, pbuf);
876 /* buffering requirements. When setting prebuf to 0, the stream will not pause
877 * when we cause an underrun, which causes time to continue. */
878 memset (&wanted, 0, sizeof (wanted));
879 wanted.tlength = spec->segtotal * spec->segsize;
880 wanted.maxlength = -1;
882 wanted.minreq = spec->segsize;
884 GST_INFO_OBJECT (psink, "tlength: %d", wanted.tlength);
885 GST_INFO_OBJECT (psink, "maxlength: %d", wanted.maxlength);
886 GST_INFO_OBJECT (psink, "prebuf: %d", wanted.prebuf);
887 GST_INFO_OBJECT (psink, "minreq: %d", wanted.minreq);
889 /* configure volume when we changed it, else we leave the default */
890 if (psink->volume_set) {
891 GST_LOG_OBJECT (psink, "have volume of %f", psink->volume);
894 gst_pulse_cvolume_from_linear (pv, pbuf->channels, psink->volume);
896 GST_DEBUG_OBJECT (psink, "passthrough stream, not setting volume");
903 /* construct the flags */
904 flags = PA_STREAM_INTERPOLATE_TIMING | PA_STREAM_AUTO_TIMING_UPDATE |
905 PA_STREAM_ADJUST_LATENCY | PA_STREAM_START_CORKED;
907 if (psink->mute_set && psink->mute)
908 flags |= PA_STREAM_START_MUTED;
910 /* we always start corked (see flags above) */
913 /* try to connect now */
914 GST_LOG_OBJECT (psink, "connect for playback to device %s",
915 GST_STR_NULL (psink->device));
916 if (pa_stream_connect_playback (pbuf->stream, psink->device,
917 &wanted, flags, pv, NULL) < 0)
920 /* our clock will now start from 0 again */
921 clock = GST_AUDIO_CLOCK (GST_AUDIO_BASE_SINK (psink)->provided_clock);
922 gst_audio_clock_reset (clock, 0);
924 if (!gst_pulsering_wait_for_stream_ready (psink, pbuf->stream))
927 g_free (psink->device);
928 psink->device = g_strdup (pa_stream_get_device_name (pbuf->stream));
930 #ifndef GST_DISABLE_GST_DEBUG
931 pa_format_info_snprint (print_buf, sizeof (print_buf),
932 pa_stream_get_format_info (pbuf->stream));
933 GST_INFO_OBJECT (psink, "negotiated to: %s", print_buf);
936 /* After we passed the volume off of to PA we never want to set it
937 again, since it is PA's job to save/restore volumes. */
938 psink->volume_set = psink->mute_set = FALSE;
940 GST_LOG_OBJECT (psink, "stream is acquired now");
942 /* get the actual buffering properties now */
943 actual = pa_stream_get_buffer_attr (pbuf->stream);
945 GST_INFO_OBJECT (psink, "tlength: %d (wanted: %d)", actual->tlength,
947 GST_INFO_OBJECT (psink, "maxlength: %d", actual->maxlength);
948 GST_INFO_OBJECT (psink, "prebuf: %d", actual->prebuf);
949 GST_INFO_OBJECT (psink, "minreq: %d (wanted %d)", actual->minreq,
952 spec->segsize = actual->minreq;
953 spec->segtotal = actual->tlength / spec->segsize;
955 pa_threaded_mainloop_unlock (mainloop);
962 gst_pulsering_destroy_stream (pbuf);
963 pa_threaded_mainloop_unlock (mainloop);
969 GST_ELEMENT_ERROR (psink, RESOURCE, SETTINGS,
970 ("Invalid sample specification."), (NULL));
975 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
976 ("pa_context_subscribe() failed: %s",
977 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
978 goto unlock_and_fail;
982 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
983 ("Failed to create stream: %s",
984 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
985 goto unlock_and_fail;
989 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
990 ("Failed to connect stream: %s",
991 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
992 goto unlock_and_fail;
996 /* free the stream that we acquired before */
998 gst_pulseringbuffer_release (GstAudioRingBuffer * buf)
1000 GstPulseRingBuffer *pbuf;
1002 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1004 pa_threaded_mainloop_lock (mainloop);
1005 gst_pulsering_destroy_stream (pbuf);
1006 pa_threaded_mainloop_unlock (mainloop);
1009 GstPulseSink *psink;
1011 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1012 g_atomic_int_set (&psink->format_lost, FALSE);
1013 psink->format_lost_time = GST_CLOCK_TIME_NONE;
1020 gst_pulsering_success_cb (pa_stream * s, int success, void *userdata)
1022 pa_threaded_mainloop_signal (mainloop, 0);
1025 /* update the corked state of a stream, must be called with the mainloop
1028 gst_pulsering_set_corked (GstPulseRingBuffer * pbuf, gboolean corked,
1031 pa_operation *o = NULL;
1032 GstPulseSink *psink;
1033 gboolean res = FALSE;
1035 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1037 if (g_atomic_int_get (&psink->format_lost)) {
1038 /* Sink format changed, stream's gone so fake being paused */
1042 GST_DEBUG_OBJECT (psink, "setting corked state to %d", corked);
1043 if (pbuf->corked != corked) {
1044 if (!(o = pa_stream_cork (pbuf->stream, corked,
1045 gst_pulsering_success_cb, pbuf)))
1048 while (wait && pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
1049 pa_threaded_mainloop_wait (mainloop);
1050 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1053 pbuf->corked = corked;
1055 GST_DEBUG_OBJECT (psink, "skipping, already in requested state");
1061 pa_operation_unref (o);
1068 GST_DEBUG_OBJECT (psink, "the server is dead");
1073 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1074 ("pa_stream_cork() failed: %s",
1075 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1081 gst_pulseringbuffer_clear (GstAudioRingBuffer * buf)
1083 GstPulseSink *psink;
1084 GstPulseRingBuffer *pbuf;
1085 pa_operation *o = NULL;
1087 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1088 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1090 pa_threaded_mainloop_lock (mainloop);
1091 GST_DEBUG_OBJECT (psink, "clearing");
1093 /* don't wait for the flush to complete */
1094 if ((o = pa_stream_flush (pbuf->stream, NULL, pbuf)))
1095 pa_operation_unref (o);
1097 pa_threaded_mainloop_unlock (mainloop);
1100 /* called from pulse with the mainloop lock */
1102 mainloop_enter_defer_cb (pa_mainloop_api * api, void *userdata)
1104 GstPulseSink *pulsesink = GST_PULSESINK (userdata);
1105 GstMessage *message;
1108 g_value_init (&val, G_TYPE_POINTER);
1109 g_value_set_pointer (&val, g_thread_self ());
1111 GST_DEBUG_OBJECT (pulsesink, "posting ENTER stream status");
1112 message = gst_message_new_stream_status (GST_OBJECT (pulsesink),
1113 GST_STREAM_STATUS_TYPE_ENTER, GST_ELEMENT (pulsesink));
1114 gst_message_set_stream_status_object (message, &val);
1116 gst_element_post_message (GST_ELEMENT (pulsesink), message);
1118 g_return_if_fail (pulsesink->defer_pending);
1119 pulsesink->defer_pending--;
1120 pa_threaded_mainloop_signal (mainloop, 0);
1123 /* start/resume playback ASAP, we don't uncork here but in the commit method */
1125 gst_pulseringbuffer_start (GstAudioRingBuffer * buf)
1127 GstPulseSink *psink;
1128 GstPulseRingBuffer *pbuf;
1130 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1131 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1133 pa_threaded_mainloop_lock (mainloop);
1135 GST_DEBUG_OBJECT (psink, "scheduling stream status");
1136 psink->defer_pending++;
1137 pa_mainloop_api_once (pa_threaded_mainloop_get_api (mainloop),
1138 mainloop_enter_defer_cb, psink);
1140 GST_DEBUG_OBJECT (psink, "starting");
1141 pbuf->paused = FALSE;
1143 /* EOS needs running clock */
1144 if (GST_BASE_SINK_CAST (psink)->eos ||
1145 g_atomic_int_get (&GST_AUDIO_BASE_SINK (psink)->eos_rendering))
1146 gst_pulsering_set_corked (pbuf, FALSE, FALSE);
1148 pa_threaded_mainloop_unlock (mainloop);
1153 /* pause/stop playback ASAP */
1155 gst_pulseringbuffer_pause (GstAudioRingBuffer * buf)
1157 GstPulseSink *psink;
1158 GstPulseRingBuffer *pbuf;
1161 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1162 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1164 pa_threaded_mainloop_lock (mainloop);
1165 GST_DEBUG_OBJECT (psink, "pausing and corking");
1166 /* make sure the commit method stops writing */
1167 pbuf->paused = TRUE;
1168 res = gst_pulsering_set_corked (pbuf, TRUE, TRUE);
1169 if (pbuf->in_commit) {
1170 /* we are waiting in a commit, signal */
1171 GST_DEBUG_OBJECT (psink, "signal commit");
1172 pa_threaded_mainloop_signal (mainloop, 0);
1174 pa_threaded_mainloop_unlock (mainloop);
1179 /* called from pulse with the mainloop lock */
1181 mainloop_leave_defer_cb (pa_mainloop_api * api, void *userdata)
1183 GstPulseSink *pulsesink = GST_PULSESINK (userdata);
1184 GstMessage *message;
1187 g_value_init (&val, G_TYPE_POINTER);
1188 g_value_set_pointer (&val, g_thread_self ());
1190 GST_DEBUG_OBJECT (pulsesink, "posting LEAVE stream status");
1191 message = gst_message_new_stream_status (GST_OBJECT (pulsesink),
1192 GST_STREAM_STATUS_TYPE_LEAVE, GST_ELEMENT (pulsesink));
1193 gst_message_set_stream_status_object (message, &val);
1194 gst_element_post_message (GST_ELEMENT (pulsesink), message);
1196 g_return_if_fail (pulsesink->defer_pending);
1197 pulsesink->defer_pending--;
1198 pa_threaded_mainloop_signal (mainloop, 0);
1201 /* stop playback, we flush everything. */
1203 gst_pulseringbuffer_stop (GstAudioRingBuffer * buf)
1205 GstPulseSink *psink;
1206 GstPulseRingBuffer *pbuf;
1207 gboolean res = FALSE;
1208 pa_operation *o = NULL;
1210 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1211 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1213 pa_threaded_mainloop_lock (mainloop);
1215 pbuf->paused = TRUE;
1216 res = gst_pulsering_set_corked (pbuf, TRUE, TRUE);
1218 /* Inform anyone waiting in _commit() call that it shall wakeup */
1219 if (pbuf->in_commit) {
1220 GST_DEBUG_OBJECT (psink, "signal commit thread");
1221 pa_threaded_mainloop_signal (mainloop, 0);
1223 if (g_atomic_int_get (&psink->format_lost)) {
1224 /* Don't try to flush, the stream's probably gone by now */
1229 /* then try to flush, it's not fatal when this fails */
1230 GST_DEBUG_OBJECT (psink, "flushing");
1231 if ((o = pa_stream_flush (pbuf->stream, gst_pulsering_success_cb, pbuf))) {
1232 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
1233 GST_DEBUG_OBJECT (psink, "wait for completion");
1234 pa_threaded_mainloop_wait (mainloop);
1235 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1238 GST_DEBUG_OBJECT (psink, "flush completed");
1244 pa_operation_cancel (o);
1245 pa_operation_unref (o);
1248 GST_DEBUG_OBJECT (psink, "scheduling stream status");
1249 psink->defer_pending++;
1250 pa_mainloop_api_once (pa_threaded_mainloop_get_api (mainloop),
1251 mainloop_leave_defer_cb, psink);
1253 pa_threaded_mainloop_unlock (mainloop);
1260 GST_DEBUG_OBJECT (psink, "the server is dead");
1265 /* in_samples >= out_samples, rate > 1.0 */
1266 #define FWD_UP_SAMPLES(s,se,d,de) \
1268 guint8 *sb = s, *db = d; \
1269 while (s <= se && d < de) { \
1270 memcpy (d, s, bpf); \
1273 if ((*accum << 1) >= inr) { \
1278 in_samples -= (s - sb)/bpf; \
1279 out_samples -= (d - db)/bpf; \
1280 GST_DEBUG ("fwd_up end %d/%d",*accum,*toprocess); \
1283 /* out_samples > in_samples, for rates smaller than 1.0 */
1284 #define FWD_DOWN_SAMPLES(s,se,d,de) \
1286 guint8 *sb = s, *db = d; \
1287 while (s <= se && d < de) { \
1288 memcpy (d, s, bpf); \
1291 if ((*accum << 1) >= outr) { \
1296 in_samples -= (s - sb)/bpf; \
1297 out_samples -= (d - db)/bpf; \
1298 GST_DEBUG ("fwd_down end %d/%d",*accum,*toprocess); \
1301 #define REV_UP_SAMPLES(s,se,d,de) \
1303 guint8 *sb = se, *db = d; \
1304 while (s <= se && d < de) { \
1305 memcpy (d, se, bpf); \
1308 while (d < de && (*accum << 1) >= inr) { \
1313 in_samples -= (sb - se)/bpf; \
1314 out_samples -= (d - db)/bpf; \
1315 GST_DEBUG ("rev_up end %d/%d",*accum,*toprocess); \
1318 #define REV_DOWN_SAMPLES(s,se,d,de) \
1320 guint8 *sb = se, *db = d; \
1321 while (s <= se && d < de) { \
1322 memcpy (d, se, bpf); \
1325 while (s <= se && (*accum << 1) >= outr) { \
1330 in_samples -= (sb - se)/bpf; \
1331 out_samples -= (d - db)/bpf; \
1332 GST_DEBUG ("rev_down end %d/%d",*accum,*toprocess); \
1335 /* our custom commit function because we write into the buffer of pulseaudio
1336 * instead of keeping our own buffer */
1338 gst_pulseringbuffer_commit (GstAudioRingBuffer * buf, guint64 * sample,
1339 guchar * data, gint in_samples, gint out_samples, gint * accum)
1341 GstPulseSink *psink;
1342 GstPulseRingBuffer *pbuf;
1347 gint inr, outr, bpf;
1351 pbuf = GST_PULSERING_BUFFER_CAST (buf);
1352 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1354 /* FIXME post message rather than using a signal (as mixer interface) */
1355 if (g_atomic_int_compare_and_exchange (&psink->notify, 1, 0)) {
1356 g_object_notify (G_OBJECT (psink), "volume");
1357 g_object_notify (G_OBJECT (psink), "mute");
1360 /* make sure the ringbuffer is started */
1361 if (G_UNLIKELY (g_atomic_int_get (&buf->state) !=
1362 GST_AUDIO_RING_BUFFER_STATE_STARTED)) {
1363 /* see if we are allowed to start it */
1364 if (G_UNLIKELY (g_atomic_int_get (&buf->may_start) == FALSE))
1367 GST_DEBUG_OBJECT (buf, "start!");
1368 if (!gst_audio_ring_buffer_start (buf))
1372 pa_threaded_mainloop_lock (mainloop);
1374 GST_DEBUG_OBJECT (psink, "entering commit");
1375 pbuf->in_commit = TRUE;
1377 bpf = GST_AUDIO_INFO_BPF (&buf->spec.info);
1378 bufsize = buf->spec.segsize * buf->spec.segtotal;
1380 /* our toy resampler for trick modes */
1381 reverse = out_samples < 0;
1382 out_samples = ABS (out_samples);
1384 if (in_samples >= out_samples)
1385 toprocess = &in_samples;
1387 toprocess = &out_samples;
1389 inr = in_samples - 1;
1390 outr = out_samples - 1;
1392 GST_DEBUG_OBJECT (psink, "in %d, out %d", inr, outr);
1394 /* data_end points to the last sample we have to write, not past it. This is
1395 * needed to properly handle reverse playback: it points to the last sample. */
1396 data_end = data + (bpf * inr);
1398 if (g_atomic_int_get (&psink->format_lost)) {
1399 /* Sink format changed, drop the data and hope upstream renegotiates */
1406 /* offset is in bytes */
1407 offset = *sample * bpf;
1409 while (*toprocess > 0) {
1413 GST_LOG_OBJECT (psink,
1414 "need to write %d samples at offset %" G_GINT64_FORMAT, *toprocess,
1417 if (offset != pbuf->m_lastoffset)
1418 GST_LOG_OBJECT (psink, "discontinuity, offset is %" G_GINT64_FORMAT ", "
1419 "last offset was %" G_GINT64_FORMAT, offset, pbuf->m_lastoffset);
1421 towrite = out_samples * bpf;
1423 /* Wait for at least segsize bytes to become available */
1424 if (towrite > buf->spec.segsize)
1425 towrite = buf->spec.segsize;
1427 if ((pbuf->m_writable < towrite) || (offset != pbuf->m_lastoffset)) {
1428 /* if no room left or discontinuity in offset,
1429 we need to flush data and get a new buffer */
1431 /* flush the buffer if possible */
1432 if ((pbuf->m_data != NULL) && (pbuf->m_towrite > 0)) {
1434 GST_LOG_OBJECT (psink,
1435 "flushing %u samples at offset %" G_GINT64_FORMAT,
1436 (guint) pbuf->m_towrite / bpf, pbuf->m_offset);
1438 if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1439 pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1443 pbuf->m_towrite = 0;
1444 pbuf->m_offset = offset; /* keep track of current offset */
1446 /* get a buffer to write in for now on */
1448 pbuf->m_writable = pa_stream_writable_size (pbuf->stream);
1450 if (g_atomic_int_get (&psink->format_lost)) {
1451 /* Sink format changed, give up and hope upstream renegotiates */
1455 if (pbuf->m_writable == (size_t) - 1)
1456 goto writable_size_failed;
1458 pbuf->m_writable /= bpf;
1459 pbuf->m_writable *= bpf; /* handle only complete samples */
1461 if (pbuf->m_writable >= towrite)
1464 /* see if we need to uncork because we have no free space */
1466 if (!gst_pulsering_set_corked (pbuf, FALSE, FALSE))
1470 /* we can't write segsize bytes, wait a bit */
1471 GST_LOG_OBJECT (psink, "waiting for free space");
1472 pa_threaded_mainloop_wait (mainloop);
1478 /* Recalculate what we can write in the next chunk */
1479 towrite = out_samples * bpf;
1480 if (pbuf->m_writable > towrite)
1481 pbuf->m_writable = towrite;
1483 GST_LOG_OBJECT (psink, "requesting %" G_GSIZE_FORMAT " bytes of "
1484 "shared memory", pbuf->m_writable);
1486 if (pa_stream_begin_write (pbuf->stream, &pbuf->m_data,
1487 &pbuf->m_writable) < 0) {
1488 GST_LOG_OBJECT (psink, "pa_stream_begin_write() failed");
1489 goto writable_size_failed;
1492 GST_LOG_OBJECT (psink, "got %" G_GSIZE_FORMAT " bytes of shared memory",
1497 if (towrite > pbuf->m_writable)
1498 towrite = pbuf->m_writable;
1499 avail = towrite / bpf;
1501 GST_LOG_OBJECT (psink, "writing %u samples at offset %" G_GUINT64_FORMAT,
1502 (guint) avail, offset);
1504 /* No trick modes for passthrough streams */
1505 if (G_UNLIKELY (!pbuf->is_pcm && (inr != outr || reverse))) {
1506 GST_WARNING_OBJECT (psink, "Passthrough stream can't run in trick mode");
1507 goto unlock_and_fail;
1510 if (G_LIKELY (inr == outr && !reverse)) {
1511 /* no rate conversion, simply write out the samples */
1512 /* copy the data into internal buffer */
1514 memcpy ((guint8 *) pbuf->m_data + pbuf->m_towrite, data, towrite);
1515 pbuf->m_towrite += towrite;
1516 pbuf->m_writable -= towrite;
1519 in_samples -= avail;
1520 out_samples -= avail;
1522 guint8 *dest, *d, *d_end;
1524 /* write into the PulseAudio shm buffer */
1525 dest = d = (guint8 *) pbuf->m_data + pbuf->m_towrite;
1526 d_end = d + towrite;
1530 /* forward speed up */
1531 FWD_UP_SAMPLES (data, data_end, d, d_end);
1533 /* forward slow down */
1534 FWD_DOWN_SAMPLES (data, data_end, d, d_end);
1537 /* reverse speed up */
1538 REV_UP_SAMPLES (data, data_end, d, d_end);
1540 /* reverse slow down */
1541 REV_DOWN_SAMPLES (data, data_end, d, d_end);
1543 /* see what we have left to write */
1544 towrite = (d - dest);
1545 pbuf->m_towrite += towrite;
1546 pbuf->m_writable -= towrite;
1548 avail = towrite / bpf;
1551 /* flush the buffer if it's full */
1552 if ((pbuf->m_data != NULL) && (pbuf->m_towrite > 0)
1553 && (pbuf->m_writable == 0)) {
1554 GST_LOG_OBJECT (psink, "flushing %u samples at offset %" G_GINT64_FORMAT,
1555 (guint) pbuf->m_towrite / bpf, pbuf->m_offset);
1557 if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1558 pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1561 pbuf->m_towrite = 0;
1562 pbuf->m_offset = offset + towrite; /* keep track of current offset */
1566 offset += avail * bpf;
1567 pbuf->m_lastoffset = offset;
1569 /* check if we need to uncork after writing the samples */
1571 const pa_timing_info *info;
1573 if ((info = pa_stream_get_timing_info (pbuf->stream))) {
1574 GST_LOG_OBJECT (psink,
1575 "read_index at %" G_GUINT64_FORMAT ", offset %" G_GINT64_FORMAT,
1576 info->read_index, offset);
1578 /* we uncork when the read_index is too far behind the offset we need
1580 if (info->read_index + bufsize <= offset) {
1581 if (!gst_pulsering_set_corked (pbuf, FALSE, FALSE))
1585 GST_LOG_OBJECT (psink, "no timing info available yet");
1591 /* we consumed all samples here */
1592 data = data_end + bpf;
1594 pbuf->in_commit = FALSE;
1595 pa_threaded_mainloop_unlock (mainloop);
1598 result = inr - ((data_end - data) / bpf);
1599 GST_LOG_OBJECT (psink, "wrote %d samples", result);
1606 pbuf->in_commit = FALSE;
1607 GST_LOG_OBJECT (psink, "we are reset");
1608 pa_threaded_mainloop_unlock (mainloop);
1613 GST_LOG_OBJECT (psink, "we can not start");
1618 GST_LOG_OBJECT (psink, "failed to start the ringbuffer");
1623 pbuf->in_commit = FALSE;
1624 GST_ERROR_OBJECT (psink, "uncork failed");
1625 pa_threaded_mainloop_unlock (mainloop);
1630 pbuf->in_commit = FALSE;
1631 GST_LOG_OBJECT (psink, "we are paused");
1632 pa_threaded_mainloop_unlock (mainloop);
1635 writable_size_failed:
1637 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1638 ("pa_stream_writable_size() failed: %s",
1639 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1640 goto unlock_and_fail;
1644 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1645 ("pa_stream_write() failed: %s",
1646 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1647 goto unlock_and_fail;
1651 /* write pending local samples, must be called with the mainloop lock */
1653 gst_pulsering_flush (GstPulseRingBuffer * pbuf)
1655 GstPulseSink *psink;
1657 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1658 GST_DEBUG_OBJECT (psink, "entering flush");
1660 /* flush the buffer if possible */
1661 if (pbuf->stream && (pbuf->m_data != NULL) && (pbuf->m_towrite > 0)) {
1662 #ifndef GST_DISABLE_GST_DEBUG
1665 bpf = (GST_AUDIO_RING_BUFFER_CAST (pbuf))->spec.info.bpf;
1666 GST_LOG_OBJECT (psink,
1667 "flushing %u samples at offset %" G_GINT64_FORMAT,
1668 (guint) pbuf->m_towrite / bpf, pbuf->m_offset);
1671 if (pa_stream_write (pbuf->stream, (uint8_t *) pbuf->m_data,
1672 pbuf->m_towrite, NULL, pbuf->m_offset, PA_SEEK_ABSOLUTE) < 0) {
1676 pbuf->m_towrite = 0;
1677 pbuf->m_offset += pbuf->m_towrite; /* keep track of current offset */
1686 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
1687 ("pa_stream_write() failed: %s",
1688 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
1693 static void gst_pulsesink_set_property (GObject * object, guint prop_id,
1694 const GValue * value, GParamSpec * pspec);
1695 static void gst_pulsesink_get_property (GObject * object, guint prop_id,
1696 GValue * value, GParamSpec * pspec);
1697 static void gst_pulsesink_finalize (GObject * object);
1699 static gboolean gst_pulsesink_event (GstBaseSink * sink, GstEvent * event);
1700 static gboolean gst_pulsesink_query (GstBaseSink * sink, GstQuery * query);
1702 static GstStateChangeReturn gst_pulsesink_change_state (GstElement * element,
1703 GstStateChange transition);
1705 static GstStaticPadTemplate pad_template = GST_STATIC_PAD_TEMPLATE ("sink",
1708 GST_STATIC_CAPS (PULSE_SINK_TEMPLATE_CAPS));
1710 #define gst_pulsesink_parent_class parent_class
1711 G_DEFINE_TYPE_WITH_CODE (GstPulseSink, gst_pulsesink, GST_TYPE_AUDIO_BASE_SINK,
1712 gst_pulsesink_init_contexts ();
1713 G_IMPLEMENT_INTERFACE (GST_TYPE_STREAM_VOLUME, NULL)
1716 static GstAudioRingBuffer *
1717 gst_pulsesink_create_ringbuffer (GstAudioBaseSink * sink)
1719 GstAudioRingBuffer *buffer;
1721 GST_DEBUG_OBJECT (sink, "creating ringbuffer");
1722 buffer = g_object_new (GST_TYPE_PULSERING_BUFFER, NULL);
1723 GST_DEBUG_OBJECT (sink, "created ringbuffer @%p", buffer);
1729 gst_pulsesink_payload (GstAudioBaseSink * sink, GstBuffer * buf)
1731 switch (sink->ringbuffer->spec.type) {
1732 case GST_AUDIO_RING_BUFFER_FORMAT_TYPE_AC3:
1733 case GST_AUDIO_RING_BUFFER_FORMAT_TYPE_EAC3:
1734 case GST_AUDIO_RING_BUFFER_FORMAT_TYPE_DTS:
1735 case GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG:
1737 /* FIXME: alloc memory from PA if possible */
1738 gint framesize = gst_audio_iec61937_frame_size (&sink->ringbuffer->spec);
1740 guint8 *indata, *outdata;
1741 gsize insize, outsize;
1747 out = gst_buffer_new_and_alloc (framesize);
1749 indata = gst_buffer_map (buf, &insize, NULL, GST_MAP_READ);
1750 outdata = gst_buffer_map (out, &outsize, NULL, GST_MAP_WRITE);
1752 res = gst_audio_iec61937_payload (indata, insize,
1753 outdata, outsize, &sink->ringbuffer->spec);
1755 gst_buffer_unmap (buf, indata, insize);
1756 gst_buffer_unmap (out, outdata, outsize);
1759 gst_buffer_unref (out);
1763 gst_buffer_copy_into (out, buf, GST_BUFFER_COPY_METADATA, 0, -1);
1768 return gst_buffer_ref (buf);
1773 gst_pulsesink_class_init (GstPulseSinkClass * klass)
1775 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
1776 GstBaseSinkClass *gstbasesink_class = GST_BASE_SINK_CLASS (klass);
1777 GstBaseSinkClass *bc;
1778 GstAudioBaseSinkClass *gstaudiosink_class = GST_AUDIO_BASE_SINK_CLASS (klass);
1779 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
1782 gobject_class->finalize = gst_pulsesink_finalize;
1783 gobject_class->set_property = gst_pulsesink_set_property;
1784 gobject_class->get_property = gst_pulsesink_get_property;
1786 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_pulsesink_event);
1787 gstbasesink_class->query = GST_DEBUG_FUNCPTR (gst_pulsesink_query);
1789 /* restore the original basesink pull methods */
1790 bc = g_type_class_peek (GST_TYPE_BASE_SINK);
1791 gstbasesink_class->activate_pull = GST_DEBUG_FUNCPTR (bc->activate_pull);
1793 gstelement_class->change_state =
1794 GST_DEBUG_FUNCPTR (gst_pulsesink_change_state);
1796 gstaudiosink_class->create_ringbuffer =
1797 GST_DEBUG_FUNCPTR (gst_pulsesink_create_ringbuffer);
1798 gstaudiosink_class->payload = GST_DEBUG_FUNCPTR (gst_pulsesink_payload);
1800 /* Overwrite GObject fields */
1801 g_object_class_install_property (gobject_class,
1803 g_param_spec_string ("server", "Server",
1804 "The PulseAudio server to connect to", DEFAULT_SERVER,
1805 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1807 g_object_class_install_property (gobject_class, PROP_DEVICE,
1808 g_param_spec_string ("device", "Device",
1809 "The PulseAudio sink device to connect to", DEFAULT_DEVICE,
1810 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1812 g_object_class_install_property (gobject_class,
1814 g_param_spec_string ("device-name", "Device name",
1815 "Human-readable name of the sound device", DEFAULT_DEVICE_NAME,
1816 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1818 g_object_class_install_property (gobject_class,
1820 g_param_spec_double ("volume", "Volume",
1821 "Linear volume of this stream, 1.0=100%", 0.0, MAX_VOLUME,
1822 DEFAULT_VOLUME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1823 g_object_class_install_property (gobject_class,
1825 g_param_spec_boolean ("mute", "Mute",
1826 "Mute state of this stream", DEFAULT_MUTE,
1827 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1830 * GstPulseSink:client-name
1832 * The PulseAudio client name to use.
1834 clientname = gst_pulse_client_name ();
1835 g_object_class_install_property (gobject_class,
1837 g_param_spec_string ("client-name", "Client Name",
1838 "The PulseAudio client name to use", clientname,
1839 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
1840 GST_PARAM_MUTABLE_READY));
1841 g_free (clientname);
1844 * GstPulseSink:stream-properties
1846 * List of pulseaudio stream properties. A list of defined properties can be
1847 * found in the <ulink url="http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html">pulseaudio api docs</ulink>.
1849 * Below is an example for registering as a music application to pulseaudio.
1851 * GstStructure *props;
1853 * props = gst_structure_from_string ("props,media.role=music", NULL);
1854 * g_object_set (pulse, "stream-properties", props, NULL);
1855 * gst_structure_free
1860 g_object_class_install_property (gobject_class,
1861 PROP_STREAM_PROPERTIES,
1862 g_param_spec_boxed ("stream-properties", "stream properties",
1863 "list of pulseaudio stream properties",
1864 GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1866 gst_element_class_set_details_simple (gstelement_class,
1867 "PulseAudio Audio Sink",
1868 "Sink/Audio", "Plays audio to a PulseAudio server", "Lennart Poettering");
1869 gst_element_class_add_pad_template (gstelement_class,
1870 gst_static_pad_template_get (&pad_template));
1873 /* returns the current time of the sink ringbuffer */
1875 gst_pulsesink_get_time (GstClock * clock, GstAudioBaseSink * sink)
1877 GstPulseSink *psink;
1878 GstPulseRingBuffer *pbuf;
1881 if (!sink->ringbuffer || !sink->ringbuffer->acquired)
1882 return GST_CLOCK_TIME_NONE;
1884 pbuf = GST_PULSERING_BUFFER_CAST (sink->ringbuffer);
1885 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1887 if (g_atomic_int_get (&psink->format_lost)) {
1888 /* Stream was lost in a format change, it'll get set up again once
1889 * upstream renegotiates */
1890 return psink->format_lost_time;
1893 pa_threaded_mainloop_lock (mainloop);
1894 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
1897 /* if we don't have enough data to get a timestamp, just return NONE, which
1898 * will return the last reported time */
1899 if (pa_stream_get_time (pbuf->stream, &time) < 0) {
1900 GST_DEBUG_OBJECT (psink, "could not get time");
1901 time = GST_CLOCK_TIME_NONE;
1904 pa_threaded_mainloop_unlock (mainloop);
1906 GST_LOG_OBJECT (psink, "current time is %" GST_TIME_FORMAT,
1907 GST_TIME_ARGS (time));
1914 GST_DEBUG_OBJECT (psink, "the server is dead");
1915 pa_threaded_mainloop_unlock (mainloop);
1917 return GST_CLOCK_TIME_NONE;
1922 gst_pulsesink_sink_info_cb (pa_context * c, const pa_sink_info * i, int eol,
1925 GstPulseRingBuffer *pbuf;
1926 GstPulseSink *psink;
1930 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
1931 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
1936 g_free (psink->device_description);
1937 psink->device_description = g_strdup (i->description);
1939 g_mutex_lock (&psink->sink_formats_lock);
1941 for (l = g_list_first (psink->sink_formats); l; l = g_list_next (l))
1942 pa_format_info_free ((pa_format_info *) l->data);
1944 g_list_free (psink->sink_formats);
1945 psink->sink_formats = NULL;
1947 for (j = 0; j < i->n_formats; j++)
1948 psink->sink_formats = g_list_prepend (psink->sink_formats,
1949 pa_format_info_copy (i->formats[j]));
1951 g_mutex_unlock (&psink->sink_formats_lock);
1954 pa_threaded_mainloop_signal (mainloop, 0);
1958 gst_pulsesink_query_acceptcaps (GstPulseSink * psink, GstCaps * caps)
1960 GstPulseRingBuffer *pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK
1961 (psink)->ringbuffer);
1962 GstPad *pad = GST_BASE_SINK_PAD (psink);
1965 gboolean ret = FALSE;
1967 GstAudioRingBufferSpec spec = { 0 };
1968 pa_stream *stream = NULL;
1969 pa_operation *o = NULL;
1970 pa_channel_map channel_map;
1971 pa_stream_flags_t flags;
1972 pa_format_info *format = NULL, *formats[1];
1975 pad_caps = gst_pad_query_caps (pad, caps);
1976 ret = pad_caps != NULL;
1977 gst_caps_unref (pad_caps);
1979 /* Either template caps didn't match, or we're still in NULL state */
1980 if (!ret || !pbuf->context)
1983 /* If we've not got fixed caps, creating a stream might fail, so let's just
1984 * return from here with default acceptcaps behaviour */
1985 if (!gst_caps_is_fixed (caps))
1990 pa_threaded_mainloop_lock (mainloop);
1992 spec.latency_time = GST_AUDIO_BASE_SINK (psink)->latency_time;
1993 if (!gst_audio_ring_buffer_parse_caps (&spec, caps))
1996 if (!gst_pulse_fill_format_info (&spec, &format, &channels))
1999 /* Make sure input is framed (one frame per buffer) and can be payloaded */
2000 if (!pa_format_info_is_pcm (format)) {
2001 gboolean framed = FALSE, parsed = FALSE;
2002 st = gst_caps_get_structure (caps, 0);
2004 gst_structure_get_boolean (st, "framed", &framed);
2005 gst_structure_get_boolean (st, "parsed", &parsed);
2006 if ((!framed && !parsed) || gst_audio_iec61937_frame_size (&spec) <= 0)
2010 /* initialize the channel map */
2011 if (pa_format_info_is_pcm (format) &&
2012 gst_pulse_gst_to_channel_map (&channel_map, &spec))
2013 pa_format_info_set_channel_map (format, &channel_map);
2016 /* We're already in PAUSED or above, so just reuse this stream to query
2017 * sink formats and use those. */
2020 if (!(o = pa_context_get_sink_info_by_name (pbuf->context, psink->device,
2021 gst_pulsesink_sink_info_cb, pbuf)))
2024 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2025 pa_threaded_mainloop_wait (mainloop);
2026 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2030 g_mutex_lock (&psink->sink_formats_lock);
2031 for (i = g_list_first (psink->sink_formats); i; i = g_list_next (i)) {
2032 if (pa_format_info_is_compatible ((pa_format_info *) i->data, format)) {
2037 g_mutex_unlock (&psink->sink_formats_lock);
2039 /* We're in READY, let's connect a stream to see if the format is
2040 * accpeted by whatever sink we're routed to */
2041 formats[0] = format;
2043 if (!(stream = pa_stream_new_extended (pbuf->context, "pulsesink probe",
2044 formats, 1, psink->proplist)))
2047 /* construct the flags */
2048 flags = PA_STREAM_INTERPOLATE_TIMING | PA_STREAM_AUTO_TIMING_UPDATE |
2049 PA_STREAM_ADJUST_LATENCY | PA_STREAM_START_CORKED;
2051 pa_stream_set_state_callback (stream, gst_pulsering_stream_state_cb, pbuf);
2053 if (pa_stream_connect_playback (stream, psink->device, NULL, flags, NULL,
2057 ret = gst_pulsering_wait_for_stream_ready (psink, stream);
2062 pa_format_info_free (format);
2065 pa_operation_unref (o);
2068 pa_stream_set_state_callback (stream, NULL, NULL);
2069 pa_stream_disconnect (stream);
2070 pa_stream_unref (stream);
2073 pa_threaded_mainloop_unlock (mainloop);
2080 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2081 ("pa_context_get_sink_input_info() failed: %s",
2082 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2088 gst_pulsesink_init (GstPulseSink * pulsesink)
2090 pulsesink->server = NULL;
2091 pulsesink->device = NULL;
2092 pulsesink->device_description = NULL;
2093 pulsesink->client_name = gst_pulse_client_name ();
2095 g_mutex_init (&pulsesink->sink_formats_lock);
2096 pulsesink->sink_formats = NULL;
2098 pulsesink->volume = DEFAULT_VOLUME;
2099 pulsesink->volume_set = FALSE;
2101 pulsesink->mute = DEFAULT_MUTE;
2102 pulsesink->mute_set = FALSE;
2104 pulsesink->notify = 0;
2106 g_atomic_int_set (&pulsesink->format_lost, FALSE);
2107 pulsesink->format_lost_time = GST_CLOCK_TIME_NONE;
2109 pulsesink->properties = NULL;
2110 pulsesink->proplist = NULL;
2112 /* override with a custom clock */
2113 if (GST_AUDIO_BASE_SINK (pulsesink)->provided_clock)
2114 gst_object_unref (GST_AUDIO_BASE_SINK (pulsesink)->provided_clock);
2116 GST_AUDIO_BASE_SINK (pulsesink)->provided_clock =
2117 gst_audio_clock_new ("GstPulseSinkClock",
2118 (GstAudioClockGetTimeFunc) gst_pulsesink_get_time, pulsesink, NULL);
2120 /* TRUE for sinks, FALSE for sources */
2121 pulsesink->probe = gst_pulseprobe_new (G_OBJECT (pulsesink),
2122 G_OBJECT_GET_CLASS (pulsesink), PROP_DEVICE, pulsesink->device,
2127 gst_pulsesink_finalize (GObject * object)
2129 GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2132 g_free (pulsesink->server);
2133 g_free (pulsesink->device);
2134 g_free (pulsesink->device_description);
2135 g_free (pulsesink->client_name);
2137 for (i = g_list_first (pulsesink->sink_formats); i; i = g_list_next (i))
2138 pa_format_info_free ((pa_format_info *) i->data);
2140 g_list_free (pulsesink->sink_formats);
2141 g_mutex_clear (&pulsesink->sink_formats_lock);
2143 if (pulsesink->properties)
2144 gst_structure_free (pulsesink->properties);
2145 if (pulsesink->proplist)
2146 pa_proplist_free (pulsesink->proplist);
2148 if (pulsesink->probe) {
2149 gst_pulseprobe_free (pulsesink->probe);
2150 pulsesink->probe = NULL;
2153 G_OBJECT_CLASS (parent_class)->finalize (object);
2157 gst_pulsesink_set_volume (GstPulseSink * psink, gdouble volume)
2160 pa_operation *o = NULL;
2161 GstPulseRingBuffer *pbuf;
2167 pa_threaded_mainloop_lock (mainloop);
2169 GST_DEBUG_OBJECT (psink, "setting volume to %f", volume);
2171 pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2172 if (pbuf == NULL || pbuf->stream == NULL)
2175 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2179 gst_pulse_cvolume_from_linear (&v, pbuf->channels, volume);
2181 /* FIXME: this will eventually be superceded by checks to see if the volume
2182 * is readable/writable */
2185 if (!(o = pa_context_set_sink_input_volume (pbuf->context, idx,
2189 /* We don't really care about the result of this call */
2193 pa_operation_unref (o);
2195 pa_threaded_mainloop_unlock (mainloop);
2202 psink->volume = volume;
2203 psink->volume_set = TRUE;
2205 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2210 psink->volume = volume;
2211 psink->volume_set = TRUE;
2213 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2218 GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2223 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2224 ("pa_stream_set_sink_input_volume() failed: %s",
2225 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2231 gst_pulsesink_set_mute (GstPulseSink * psink, gboolean mute)
2233 pa_operation *o = NULL;
2234 GstPulseRingBuffer *pbuf;
2240 pa_threaded_mainloop_lock (mainloop);
2242 GST_DEBUG_OBJECT (psink, "setting mute state to %d", mute);
2244 pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2245 if (pbuf == NULL || pbuf->stream == NULL)
2248 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2251 if (!(o = pa_context_set_sink_input_mute (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);
2269 psink->mute_set = TRUE;
2271 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2277 psink->mute_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_mute() failed: %s",
2291 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2297 gst_pulsesink_sink_input_info_cb (pa_context * c, const pa_sink_input_info * i,
2298 int eol, void *userdata)
2300 GstPulseRingBuffer *pbuf;
2301 GstPulseSink *psink;
2303 pbuf = GST_PULSERING_BUFFER_CAST (userdata);
2304 psink = GST_PULSESINK_CAST (GST_OBJECT_PARENT (pbuf));
2312 /* If the index doesn't match our current stream,
2313 * it implies we just recreated the stream (caps change)
2315 if (i->index == pa_stream_get_index (pbuf->stream)) {
2316 psink->volume = pa_sw_volume_to_linear (pa_cvolume_max (&i->volume));
2317 psink->mute = i->mute;
2321 pa_threaded_mainloop_signal (mainloop, 0);
2325 gst_pulsesink_get_volume (GstPulseSink * psink)
2327 GstPulseRingBuffer *pbuf;
2328 pa_operation *o = NULL;
2329 gdouble v = DEFAULT_VOLUME;
2335 pa_threaded_mainloop_lock (mainloop);
2337 pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2338 if (pbuf == NULL || pbuf->stream == NULL)
2341 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2344 if (!(o = pa_context_get_sink_input_info (pbuf->context, idx,
2345 gst_pulsesink_sink_input_info_cb, pbuf)))
2348 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2349 pa_threaded_mainloop_wait (mainloop);
2350 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2358 pa_operation_unref (o);
2360 pa_threaded_mainloop_unlock (mainloop);
2362 if (v > MAX_VOLUME) {
2363 GST_WARNING_OBJECT (psink, "Clipped volume from %f to %f", v, MAX_VOLUME);
2373 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2378 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2383 GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2388 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2389 ("pa_context_get_sink_input_info() failed: %s",
2390 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2396 gst_pulsesink_get_mute (GstPulseSink * psink)
2398 GstPulseRingBuffer *pbuf;
2399 pa_operation *o = NULL;
2401 gboolean mute = FALSE;
2406 pa_threaded_mainloop_lock (mainloop);
2409 pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2410 if (pbuf == NULL || pbuf->stream == NULL)
2413 if ((idx = pa_stream_get_index (pbuf->stream)) == PA_INVALID_INDEX)
2416 if (!(o = pa_context_get_sink_input_info (pbuf->context, idx,
2417 gst_pulsesink_sink_input_info_cb, pbuf)))
2420 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2421 pa_threaded_mainloop_wait (mainloop);
2422 if (gst_pulsering_is_dead (psink, pbuf, TRUE))
2428 pa_operation_unref (o);
2430 pa_threaded_mainloop_unlock (mainloop);
2438 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2443 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2448 GST_DEBUG_OBJECT (psink, "we don't have a stream index");
2453 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2454 ("pa_context_get_sink_input_info() failed: %s",
2455 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2461 gst_pulsesink_device_description (GstPulseSink * psink)
2463 GstPulseRingBuffer *pbuf;
2464 pa_operation *o = NULL;
2470 pa_threaded_mainloop_lock (mainloop);
2471 pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2475 if (!(o = pa_context_get_sink_info_by_name (pbuf->context,
2476 psink->device, gst_pulsesink_sink_info_cb, pbuf)))
2479 while (pa_operation_get_state (o) == PA_OPERATION_RUNNING) {
2480 pa_threaded_mainloop_wait (mainloop);
2481 if (gst_pulsering_is_dead (psink, pbuf, FALSE))
2487 pa_operation_unref (o);
2489 t = g_strdup (psink->device_description);
2490 pa_threaded_mainloop_unlock (mainloop);
2497 GST_DEBUG_OBJECT (psink, "we have no mainloop");
2502 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2507 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2508 ("pa_context_get_sink_info_by_index() failed: %s",
2509 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2515 gst_pulsesink_set_property (GObject * object,
2516 guint prop_id, const GValue * value, GParamSpec * pspec)
2518 GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2522 g_free (pulsesink->server);
2523 pulsesink->server = g_value_dup_string (value);
2524 if (pulsesink->probe)
2525 gst_pulseprobe_set_server (pulsesink->probe, pulsesink->server);
2528 g_free (pulsesink->device);
2529 pulsesink->device = g_value_dup_string (value);
2532 gst_pulsesink_set_volume (pulsesink, g_value_get_double (value));
2535 gst_pulsesink_set_mute (pulsesink, g_value_get_boolean (value));
2537 case PROP_CLIENT_NAME:
2538 g_free (pulsesink->client_name);
2539 if (!g_value_get_string (value)) {
2540 GST_WARNING_OBJECT (pulsesink,
2541 "Empty PulseAudio client name not allowed. Resetting to default value");
2542 pulsesink->client_name = gst_pulse_client_name ();
2544 pulsesink->client_name = g_value_dup_string (value);
2546 case PROP_STREAM_PROPERTIES:
2547 if (pulsesink->properties)
2548 gst_structure_free (pulsesink->properties);
2549 pulsesink->properties =
2550 gst_structure_copy (gst_value_get_structure (value));
2551 if (pulsesink->proplist)
2552 pa_proplist_free (pulsesink->proplist);
2553 pulsesink->proplist = gst_pulse_make_proplist (pulsesink->properties);
2556 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2562 gst_pulsesink_get_property (GObject * object,
2563 guint prop_id, GValue * value, GParamSpec * pspec)
2566 GstPulseSink *pulsesink = GST_PULSESINK_CAST (object);
2570 g_value_set_string (value, pulsesink->server);
2573 g_value_set_string (value, pulsesink->device);
2575 case PROP_DEVICE_NAME:
2576 g_value_take_string (value, gst_pulsesink_device_description (pulsesink));
2579 g_value_set_double (value, gst_pulsesink_get_volume (pulsesink));
2582 g_value_set_boolean (value, gst_pulsesink_get_mute (pulsesink));
2584 case PROP_CLIENT_NAME:
2585 g_value_set_string (value, pulsesink->client_name);
2587 case PROP_STREAM_PROPERTIES:
2588 gst_value_set_structure (value, pulsesink->properties);
2591 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2597 gst_pulsesink_change_title (GstPulseSink * psink, const gchar * t)
2599 pa_operation *o = NULL;
2600 GstPulseRingBuffer *pbuf;
2602 pa_threaded_mainloop_lock (mainloop);
2604 pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2606 if (pbuf == NULL || pbuf->stream == NULL)
2609 g_free (pbuf->stream_name);
2610 pbuf->stream_name = g_strdup (t);
2612 if (!(o = pa_stream_set_name (pbuf->stream, pbuf->stream_name, NULL, NULL)))
2615 /* We're not interested if this operation failed or not */
2619 pa_operation_unref (o);
2620 pa_threaded_mainloop_unlock (mainloop);
2627 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2632 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2633 ("pa_stream_set_name() failed: %s",
2634 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2640 gst_pulsesink_change_props (GstPulseSink * psink, GstTagList * l)
2642 static const gchar *const map[] = {
2643 GST_TAG_TITLE, PA_PROP_MEDIA_TITLE,
2645 /* might get overriden in the next iteration by GST_TAG_ARTIST */
2646 GST_TAG_PERFORMER, PA_PROP_MEDIA_ARTIST,
2648 GST_TAG_ARTIST, PA_PROP_MEDIA_ARTIST,
2649 GST_TAG_LANGUAGE_CODE, PA_PROP_MEDIA_LANGUAGE,
2650 GST_TAG_LOCATION, PA_PROP_MEDIA_FILENAME,
2651 /* We might add more here later on ... */
2654 pa_proplist *pl = NULL;
2655 const gchar *const *t;
2656 gboolean empty = TRUE;
2657 pa_operation *o = NULL;
2658 GstPulseRingBuffer *pbuf;
2660 pl = pa_proplist_new ();
2662 for (t = map; *t; t += 2) {
2665 if (gst_tag_list_get_string (l, *t, &n)) {
2668 pa_proplist_sets (pl, *(t + 1), n);
2678 pa_threaded_mainloop_lock (mainloop);
2679 pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2680 if (pbuf == NULL || pbuf->stream == NULL)
2683 if (!(o = pa_stream_proplist_update (pbuf->stream, PA_UPDATE_REPLACE,
2687 /* We're not interested if this operation failed or not */
2691 pa_operation_unref (o);
2693 pa_threaded_mainloop_unlock (mainloop);
2698 pa_proplist_free (pl);
2705 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2710 GST_ELEMENT_ERROR (psink, RESOURCE, FAILED,
2711 ("pa_stream_proplist_update() failed: %s",
2712 pa_strerror (pa_context_errno (pbuf->context))), (NULL));
2718 gst_pulsesink_flush_ringbuffer (GstPulseSink * psink)
2720 GstPulseRingBuffer *pbuf;
2722 pa_threaded_mainloop_lock (mainloop);
2724 pbuf = GST_PULSERING_BUFFER_CAST (GST_AUDIO_BASE_SINK (psink)->ringbuffer);
2726 if (pbuf == NULL || pbuf->stream == NULL)
2729 gst_pulsering_flush (pbuf);
2731 /* Uncork if we haven't already (happens when waiting to get enough data
2732 * to send out the first time) */
2734 gst_pulsering_set_corked (pbuf, FALSE, FALSE);
2736 /* We're not interested if this operation failed or not */
2738 pa_threaded_mainloop_unlock (mainloop);
2745 GST_DEBUG_OBJECT (psink, "we have no ringbuffer");
2751 gst_pulsesink_event (GstBaseSink * sink, GstEvent * event)
2753 GstPulseSink *pulsesink = GST_PULSESINK_CAST (sink);
2755 switch (GST_EVENT_TYPE (event)) {
2756 case GST_EVENT_TAG:{
2757 gchar *title = NULL, *artist = NULL, *location = NULL, *description =
2758 NULL, *t = NULL, *buf = NULL;
2761 gst_event_parse_tag (event, &l);
2763 gst_tag_list_get_string (l, GST_TAG_TITLE, &title);
2764 gst_tag_list_get_string (l, GST_TAG_ARTIST, &artist);
2765 gst_tag_list_get_string (l, GST_TAG_LOCATION, &location);
2766 gst_tag_list_get_string (l, GST_TAG_DESCRIPTION, &description);
2769 gst_tag_list_get_string (l, GST_TAG_PERFORMER, &artist);
2771 if (title && artist)
2772 /* TRANSLATORS: 'song title' by 'artist name' */
2773 t = buf = g_strdup_printf (_("'%s' by '%s'"), g_strstrip (title),
2774 g_strstrip (artist));
2776 t = g_strstrip (title);
2777 else if (description)
2778 t = g_strstrip (description);
2780 t = g_strstrip (location);
2783 gst_pulsesink_change_title (pulsesink, t);
2788 g_free (description);
2791 gst_pulsesink_change_props (pulsesink, l);
2796 gst_pulsesink_flush_ringbuffer (pulsesink);
2802 return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
2806 gst_pulsesink_query (GstBaseSink * sink, GstQuery * query)
2808 GstPulseSink *pulsesink = GST_PULSESINK_CAST (sink);
2811 switch (GST_QUERY_TYPE (query)) {
2812 case GST_QUERY_ACCEPT_CAPS:
2816 gst_query_parse_accept_caps (query, &caps);
2817 ret = gst_pulsesink_query_acceptcaps (pulsesink, caps);
2818 gst_query_set_accept_caps_result (query, ret);
2823 ret = GST_BASE_SINK_CLASS (parent_class)->query (sink, query);
2830 gst_pulsesink_release_mainloop (GstPulseSink * psink)
2835 pa_threaded_mainloop_lock (mainloop);
2836 while (psink->defer_pending) {
2837 GST_DEBUG_OBJECT (psink, "waiting for stream status message emission");
2838 pa_threaded_mainloop_wait (mainloop);
2840 pa_threaded_mainloop_unlock (mainloop);
2842 g_mutex_lock (&pa_shared_resource_mutex);
2844 if (!mainloop_ref_ct) {
2845 GST_INFO_OBJECT (psink, "terminating pa main loop thread");
2846 pa_threaded_mainloop_stop (mainloop);
2847 pa_threaded_mainloop_free (mainloop);
2850 g_mutex_unlock (&pa_shared_resource_mutex);
2853 static GstStateChangeReturn
2854 gst_pulsesink_change_state (GstElement * element, GstStateChange transition)
2856 GstPulseSink *pulsesink = GST_PULSESINK (element);
2857 GstStateChangeReturn ret;
2859 switch (transition) {
2860 case GST_STATE_CHANGE_NULL_TO_READY:
2861 g_mutex_lock (&pa_shared_resource_mutex);
2862 if (!mainloop_ref_ct) {
2863 GST_INFO_OBJECT (element, "new pa main loop thread");
2864 if (!(mainloop = pa_threaded_mainloop_new ()))
2865 goto mainloop_failed;
2866 mainloop_ref_ct = 1;
2867 pa_threaded_mainloop_start (mainloop);
2868 g_mutex_unlock (&pa_shared_resource_mutex);
2870 GST_INFO_OBJECT (element, "reusing pa main loop thread");
2872 g_mutex_unlock (&pa_shared_resource_mutex);
2875 case GST_STATE_CHANGE_READY_TO_PAUSED:
2876 gst_element_post_message (element,
2877 gst_message_new_clock_provide (GST_OBJECT_CAST (element),
2878 GST_AUDIO_BASE_SINK (pulsesink)->provided_clock, TRUE));
2885 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2886 if (ret == GST_STATE_CHANGE_FAILURE)
2889 switch (transition) {
2890 case GST_STATE_CHANGE_PAUSED_TO_READY:
2891 /* format_lost is reset in release() in audiobasesink */
2892 gst_element_post_message (element,
2893 gst_message_new_clock_lost (GST_OBJECT_CAST (element),
2894 GST_AUDIO_BASE_SINK (pulsesink)->provided_clock));
2896 case GST_STATE_CHANGE_READY_TO_NULL:
2897 gst_pulsesink_release_mainloop (pulsesink);
2908 g_mutex_unlock (&pa_shared_resource_mutex);
2909 GST_ELEMENT_ERROR (pulsesink, RESOURCE, FAILED,
2910 ("pa_threaded_mainloop_new() failed"), (NULL));
2911 return GST_STATE_CHANGE_FAILURE;
2915 if (transition == GST_STATE_CHANGE_NULL_TO_READY) {
2916 /* Clear the PA mainloop if audiobasesink failed to open the ring_buffer */
2917 g_assert (mainloop);
2918 gst_pulsesink_release_mainloop (pulsesink);