1 /* GStreamer aggregator base class
2 * Copyright (C) 2014 Mathieu Duponchelle <mathieu.duponchelle@opencreed.com>
3 * Copyright (C) 2014 Thibault Saunier <tsaunier@gnome.org>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
23 * SECTION: gstaggregator
24 * @short_description: manages a set of pads with the purpose of
25 * aggregating their buffers.
26 * @see_also: gstcollectpads for historical reasons.
28 * Manages a set of pads with the purpose of aggregating their buffers.
29 * Control is given to the subclass when all pads have data.
32 * Base class for mixers and muxers. Subclasses should at least implement
33 * the #GstAggregatorClass.aggregate() virtual method.
36 * When data is queued on all pads, tha aggregate vmethod is called.
39 * One can peek at the data on any given GstAggregatorPad with the
40 * gst_aggregator_pad_get_buffer () method, and take ownership of it
41 * with the gst_aggregator_pad_steal_buffer () method. When a buffer
42 * has been taken with steal_buffer (), a new buffer can be queued
46 * If the subclass wishes to push a buffer downstream in its aggregate
47 * implementation, it should do so through the
48 * gst_aggregator_finish_buffer () method. This method will take care
49 * of sending and ordering mandatory events such as stream start, caps
53 * Same goes for EOS events, which should not be pushed directly by the
54 * subclass, it should instead return GST_FLOW_EOS in its aggregate
64 #include <string.h> /* strlen */
66 #include "gstaggregator.h"
69 /* Might become API */
70 static void gst_aggregator_merge_tags (GstAggregator * aggregator,
71 const GstTagList * tags, GstTagMergeMode mode);
72 static void gst_aggregator_set_latency_property (GstAggregator * agg,
74 static gint64 gst_aggregator_get_latency_property (GstAggregator * agg);
77 GST_DEBUG_CATEGORY_STATIC (aggregator_debug);
78 #define GST_CAT_DEFAULT aggregator_debug
80 /* GstAggregatorPad definitions */
81 #define PAD_LOCK(pad) G_STMT_START { \
82 GST_TRACE_OBJECT (pad, "Taking PAD lock from thread %p", \
84 g_mutex_lock(&pad->priv->lock); \
85 GST_TRACE_OBJECT (pad, "Took PAD lock from thread %p", \
89 #define PAD_UNLOCK(pad) G_STMT_START { \
90 GST_TRACE_OBJECT (pad, "Releasing PAD lock from thread %p", \
92 g_mutex_unlock(&pad->priv->lock); \
93 GST_TRACE_OBJECT (pad, "Release PAD lock from thread %p", \
98 #define PAD_WAIT_EVENT(pad) G_STMT_START { \
99 GST_LOG_OBJECT (pad, "Waiting for EVENT on thread %p", \
101 g_cond_wait(&(((GstAggregatorPad* )pad)->priv->event_cond), \
102 (&((GstAggregatorPad*)pad)->priv->lock)); \
103 GST_LOG_OBJECT (pad, "DONE Waiting for EVENT on thread %p", \
107 #define PAD_BROADCAST_EVENT(pad) G_STMT_START { \
108 GST_LOG_OBJECT (pad, "Signaling EVENT from thread %p", \
110 g_cond_broadcast(&(((GstAggregatorPad* )pad)->priv->event_cond)); \
114 #define PAD_STREAM_LOCK(pad) G_STMT_START { \
115 GST_TRACE_OBJECT (pad, "Taking lock from thread %p", \
117 g_mutex_lock(&pad->priv->stream_lock); \
118 GST_TRACE_OBJECT (pad, "Took lock from thread %p", \
122 #define PAD_STREAM_UNLOCK(pad) G_STMT_START { \
123 GST_TRACE_OBJECT (pad, "Releasing lock from thread %p", \
125 g_mutex_unlock(&pad->priv->stream_lock); \
126 GST_TRACE_OBJECT (pad, "Release lock from thread %p", \
130 #define SRC_STREAM_LOCK(self) G_STMT_START { \
131 GST_TRACE_OBJECT (self, "Taking src STREAM lock from thread %p", \
133 g_mutex_lock(&self->priv->src_lock); \
134 GST_TRACE_OBJECT (self, "Took src STREAM lock from thread %p", \
138 #define SRC_STREAM_UNLOCK(self) G_STMT_START { \
139 GST_TRACE_OBJECT (self, "Releasing src STREAM lock from thread %p", \
141 g_mutex_unlock(&self->priv->src_lock); \
142 GST_TRACE_OBJECT (self, "Released src STREAM lock from thread %p", \
146 #define SRC_STREAM_WAIT(self) G_STMT_START { \
147 GST_LOG_OBJECT (self, "Waiting for src STREAM on thread %p", \
149 g_cond_wait(&(self->priv->src_cond), &(self->priv->src_lock)); \
150 GST_LOG_OBJECT (self, "DONE Waiting for src STREAM on thread %p", \
154 #define SRC_STREAM_BROADCAST(self) G_STMT_START { \
155 GST_LOG_OBJECT (self, "Signaling src STREAM from thread %p", \
157 if (self->priv->aggregate_id) \
158 gst_clock_id_unschedule (self->priv->aggregate_id); \
159 g_cond_broadcast(&(self->priv->src_cond)); \
162 struct _GstAggregatorPadPrivate
164 /* To always be used atomically */
167 /* Following fields are protected by the PAD_LOCK */
168 gboolean pending_flush_start;
169 gboolean pending_flush_stop;
170 gboolean pending_eos;
181 gst_aggregator_pad_flush (GstAggregatorPad * aggpad, GstAggregator * agg)
183 GstAggregatorPadClass *klass = GST_AGGREGATOR_PAD_GET_CLASS (aggpad);
186 aggpad->priv->eos = FALSE;
187 aggpad->priv->flushing = FALSE;
191 return klass->flush (aggpad, agg);
196 /*************************************
197 * GstAggregator implementation *
198 *************************************/
199 static GstElementClass *aggregator_parent_class = NULL;
201 /* All members are protected by the object lock unless otherwise noted */
203 struct _GstAggregatorPrivate
207 /* Our state is >= PAUSED */
208 gboolean running; /* protected by SRC_STREAM_LOCK */
211 gboolean send_stream_start; /* protected by srcpad stream lock */
212 gboolean send_segment;
213 gboolean flush_seeking;
214 gboolean pending_flush_start;
215 gboolean send_eos; /* protected by srcpad stream lock */
216 GstFlowReturn flow_return;
218 GstCaps *srccaps; /* protected by the srcpad stream lock */
221 gboolean tags_changed;
223 gboolean latency_live;
224 GstClockTime latency_min;
225 GstClockTime latency_max;
227 GstClockTime sub_latency_min;
228 GstClockTime sub_latency_max;
231 GstClockID aggregate_id; /* protected by src_lock */
245 gboolean one_actually_seeked;
248 #define DEFAULT_LATENCY 0
258 * gst_aggregator_iterate_sinkpads:
259 * @self: The #GstAggregator
260 * @func: (scope call): The function to call.
261 * @user_data: (closure): The data to pass to @func.
263 * Iterate the sinkpads of aggregator to call a function on them.
265 * This method guarantees that @func will be called only once for each
269 gst_aggregator_iterate_sinkpads (GstAggregator * self,
270 GstAggregatorPadForeachFunc func, gpointer user_data)
272 gboolean result = FALSE;
274 gboolean done = FALSE;
275 GValue item = { 0, };
276 GList *seen_pads = NULL;
278 iter = gst_element_iterate_sink_pads (GST_ELEMENT (self));
284 switch (gst_iterator_next (iter, &item)) {
285 case GST_ITERATOR_OK:
287 GstAggregatorPad *pad;
289 pad = g_value_get_object (&item);
291 /* if already pushed, skip. FIXME, find something faster to tag pads */
292 if (pad == NULL || g_list_find (seen_pads, pad)) {
293 g_value_reset (&item);
297 GST_LOG_OBJECT (pad, "calling function %s on pad",
298 GST_DEBUG_FUNCPTR_NAME (func));
300 result = func (self, pad, user_data);
304 seen_pads = g_list_prepend (seen_pads, pad);
306 g_value_reset (&item);
309 case GST_ITERATOR_RESYNC:
310 gst_iterator_resync (iter);
312 case GST_ITERATOR_ERROR:
313 GST_ERROR_OBJECT (self,
314 "Could not iterate over internally linked pads");
317 case GST_ITERATOR_DONE:
322 g_value_unset (&item);
323 gst_iterator_free (iter);
325 if (seen_pads == NULL) {
326 GST_DEBUG_OBJECT (self, "No pad seen");
330 g_list_free (seen_pads);
337 gst_aggregator_check_pads_ready (GstAggregator * self)
339 GstAggregatorPad *pad;
342 GST_LOG_OBJECT (self, "checking pads");
344 GST_OBJECT_LOCK (self);
346 sinkpads = GST_ELEMENT_CAST (self)->sinkpads;
347 if (sinkpads == NULL)
350 for (l = sinkpads; l != NULL; l = l->next) {
354 if (pad->priv->buffer == NULL && !pad->priv->eos) {
362 GST_OBJECT_UNLOCK (self);
363 GST_LOG_OBJECT (self, "pads are ready");
368 GST_LOG_OBJECT (self, "pads not ready: no sink pads");
369 GST_OBJECT_UNLOCK (self);
374 GST_LOG_OBJECT (pad, "pad not ready to be aggregated yet");
375 GST_OBJECT_UNLOCK (self);
381 gst_aggregator_reset_flow_values (GstAggregator * self)
383 GST_OBJECT_LOCK (self);
384 self->priv->flow_return = GST_FLOW_FLUSHING;
385 self->priv->send_stream_start = TRUE;
386 self->priv->send_segment = TRUE;
387 gst_segment_init (&self->segment, GST_FORMAT_TIME);
388 GST_OBJECT_UNLOCK (self);
392 gst_aggregator_push_mandatory_events (GstAggregator * self)
394 GstAggregatorPrivate *priv = self->priv;
395 GstEvent *segment = NULL;
396 GstEvent *tags = NULL;
398 if (self->priv->send_stream_start) {
401 GST_INFO_OBJECT (self, "pushing stream start");
402 /* stream-start (FIXME: create id based on input ids) */
403 g_snprintf (s_id, sizeof (s_id), "agg-%08x", g_random_int ());
404 if (!gst_pad_push_event (self->srcpad, gst_event_new_stream_start (s_id))) {
405 GST_WARNING_OBJECT (self->srcpad, "Sending stream start event failed");
407 self->priv->send_stream_start = FALSE;
410 if (self->priv->srccaps) {
412 GST_INFO_OBJECT (self, "pushing caps: %" GST_PTR_FORMAT,
413 self->priv->srccaps);
414 if (!gst_pad_push_event (self->srcpad,
415 gst_event_new_caps (self->priv->srccaps))) {
416 GST_WARNING_OBJECT (self->srcpad, "Sending caps event failed");
418 gst_caps_unref (self->priv->srccaps);
419 self->priv->srccaps = NULL;
422 GST_OBJECT_LOCK (self);
423 if (self->priv->send_segment && !self->priv->flush_seeking) {
424 segment = gst_event_new_segment (&self->segment);
426 if (!self->priv->seqnum)
427 self->priv->seqnum = gst_event_get_seqnum (segment);
429 gst_event_set_seqnum (segment, self->priv->seqnum);
430 self->priv->send_segment = FALSE;
432 GST_DEBUG_OBJECT (self, "pushing segment %" GST_PTR_FORMAT, segment);
435 if (priv->tags && priv->tags_changed) {
436 tags = gst_event_new_tag (gst_tag_list_ref (priv->tags));
437 priv->tags_changed = FALSE;
439 GST_OBJECT_UNLOCK (self);
442 gst_pad_push_event (self->srcpad, segment);
444 gst_pad_push_event (self->srcpad, tags);
449 * gst_aggregator_set_src_caps:
450 * @self: The #GstAggregator
451 * @caps: The #GstCaps to set on the src pad.
453 * Sets the caps to be used on the src pad.
456 gst_aggregator_set_src_caps (GstAggregator * self, GstCaps * caps)
458 GST_PAD_STREAM_LOCK (self->srcpad);
459 gst_caps_replace (&self->priv->srccaps, caps);
460 gst_aggregator_push_mandatory_events (self);
461 GST_PAD_STREAM_UNLOCK (self->srcpad);
465 * gst_aggregator_finish_buffer:
466 * @self: The #GstAggregator
467 * @buffer: (transfer full): the #GstBuffer to push.
469 * This method will push the provided output buffer downstream. If needed,
470 * mandatory events such as stream-start, caps, and segment events will be
471 * sent before pushing the buffer.
474 gst_aggregator_finish_buffer (GstAggregator * self, GstBuffer * buffer)
476 gst_aggregator_push_mandatory_events (self);
478 GST_OBJECT_LOCK (self);
479 if (!self->priv->flush_seeking && gst_pad_is_active (self->srcpad)) {
480 GST_TRACE_OBJECT (self, "pushing buffer %" GST_PTR_FORMAT, buffer);
481 GST_OBJECT_UNLOCK (self);
482 return gst_pad_push (self->srcpad, buffer);
484 GST_INFO_OBJECT (self, "Not pushing (active: %i, flushing: %i)",
485 self->priv->flush_seeking, gst_pad_is_active (self->srcpad));
486 GST_OBJECT_UNLOCK (self);
487 gst_buffer_unref (buffer);
493 gst_aggregator_push_eos (GstAggregator * self)
496 gst_aggregator_push_mandatory_events (self);
498 event = gst_event_new_eos ();
500 GST_OBJECT_LOCK (self);
501 self->priv->send_eos = FALSE;
502 gst_event_set_seqnum (event, self->priv->seqnum);
503 GST_OBJECT_UNLOCK (self);
505 gst_pad_push_event (self->srcpad, event);
509 gst_aggregator_get_next_time (GstAggregator * self)
511 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
513 if (klass->get_next_time)
514 return klass->get_next_time (self);
516 return GST_CLOCK_TIME_NONE;
519 /* called with the src STREAM lock */
521 gst_aggregator_wait_and_check (GstAggregator * self, gboolean * timeout)
523 GstClockTime latency_max, latency_min;
529 SRC_STREAM_LOCK (self);
531 GST_OBJECT_LOCK (self);
532 gst_aggregator_get_latency_unlocked (self, &live, &latency_min, &latency_max);
533 GST_OBJECT_UNLOCK (self);
535 if (gst_aggregator_check_pads_ready (self)) {
536 GST_DEBUG_OBJECT (self, "all pads have data");
537 SRC_STREAM_UNLOCK (self);
542 /* Before waiting, check if we're actually still running */
543 if (!self->priv->running || !self->priv->send_eos) {
544 SRC_STREAM_UNLOCK (self);
549 start = gst_aggregator_get_next_time (self);
551 if (!live || !GST_IS_CLOCK (GST_ELEMENT_CLOCK (self))
552 || !GST_CLOCK_TIME_IS_VALID (start)) {
553 /* We wake up here when something happened, and below
554 * then check if we're ready now. If we return FALSE,
555 * we will be directly called again.
557 SRC_STREAM_WAIT (self);
559 GstClockTime base_time, time;
561 GstClockReturn status;
562 GstClockTimeDiff jitter;
564 GST_DEBUG_OBJECT (self, "got subclass start time: %" GST_TIME_FORMAT,
565 GST_TIME_ARGS (start));
567 GST_OBJECT_LOCK (self);
568 base_time = GST_ELEMENT_CAST (self)->base_time;
569 clock = GST_ELEMENT_CLOCK (self);
571 gst_object_ref (clock);
573 time = base_time + start;
576 GST_DEBUG_OBJECT (self, "possibly waiting for clock to reach %"
577 GST_TIME_FORMAT " (base %" GST_TIME_FORMAT " start %" GST_TIME_FORMAT
578 " latency max %" GST_TIME_FORMAT " latency min %" GST_TIME_FORMAT
579 " current %" GST_TIME_FORMAT ")", GST_TIME_ARGS (time),
580 GST_TIME_ARGS (GST_ELEMENT_CAST (self)->base_time),
581 GST_TIME_ARGS (start), GST_TIME_ARGS (latency_max),
582 GST_TIME_ARGS (latency_min),
583 GST_TIME_ARGS (gst_clock_get_time (clock)));
585 GST_OBJECT_UNLOCK (self);
587 self->priv->aggregate_id = gst_clock_new_single_shot_id (clock, time);
588 gst_object_unref (clock);
589 SRC_STREAM_UNLOCK (self);
592 status = gst_clock_id_wait (self->priv->aggregate_id, &jitter);
594 SRC_STREAM_LOCK (self);
595 if (self->priv->aggregate_id) {
596 gst_clock_id_unref (self->priv->aggregate_id);
597 self->priv->aggregate_id = NULL;
600 GST_DEBUG_OBJECT (self,
601 "clock returned %d (jitter: %s%" GST_TIME_FORMAT ")",
602 status, (jitter < 0 ? "-" : " "),
603 GST_TIME_ARGS ((jitter < 0 ? -jitter : jitter)));
606 if (status == GST_CLOCK_OK || status == GST_CLOCK_EARLY) {
607 SRC_STREAM_UNLOCK (self);
613 res = gst_aggregator_check_pads_ready (self);
614 SRC_STREAM_UNLOCK (self);
620 gst_aggregator_aggregate_func (GstAggregator * self)
622 GstAggregatorPrivate *priv = self->priv;
623 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
624 gboolean timeout = FALSE;
626 if (self->priv->running == FALSE) {
627 GST_DEBUG_OBJECT (self, "Not running anymore");
631 GST_LOG_OBJECT (self, "Checking aggregate");
632 while (priv->send_eos && priv->running) {
633 GstFlowReturn flow_return;
635 if (!gst_aggregator_wait_and_check (self, &timeout))
638 GST_TRACE_OBJECT (self, "Actually aggregating!");
640 flow_return = klass->aggregate (self, timeout);
642 GST_OBJECT_LOCK (self);
643 if (flow_return == GST_FLOW_FLUSHING && priv->flush_seeking)
644 priv->flow_return = GST_FLOW_OK;
646 priv->flow_return = flow_return;
647 GST_OBJECT_UNLOCK (self);
649 if (flow_return == GST_FLOW_EOS) {
650 gst_aggregator_push_eos (self);
653 GST_LOG_OBJECT (self, "flow return is %s", gst_flow_get_name (flow_return));
655 if (flow_return != GST_FLOW_OK)
659 /* Pause the task here, the only ways to get here are:
660 * 1) We're stopping, in which case the task is stopped anyway
661 * 2) We got a flow error above, in which case it might take
662 * some time to forward the flow return upstream and we
663 * would otherwise call the task function over and over
664 * again without doing anything
666 gst_pad_pause_task (self->srcpad);
670 gst_aggregator_start (GstAggregator * self)
672 GstAggregatorClass *klass;
675 self->priv->running = TRUE;
676 self->priv->send_stream_start = TRUE;
677 self->priv->send_segment = TRUE;
678 self->priv->send_eos = TRUE;
679 self->priv->srccaps = NULL;
680 self->priv->flow_return = GST_FLOW_OK;
682 klass = GST_AGGREGATOR_GET_CLASS (self);
685 result = klass->start (self);
693 _check_pending_flush_stop (GstAggregatorPad * pad)
698 res = (!pad->priv->pending_flush_stop && !pad->priv->pending_flush_start);
705 gst_aggregator_stop_srcpad_task (GstAggregator * self, GstEvent * flush_start)
709 GST_INFO_OBJECT (self, "%s srcpad task",
710 flush_start ? "Pausing" : "Stopping");
712 SRC_STREAM_LOCK (self);
713 self->priv->running = FALSE;
714 SRC_STREAM_BROADCAST (self);
715 SRC_STREAM_UNLOCK (self);
718 res = gst_pad_push_event (self->srcpad, flush_start);
721 gst_pad_stop_task (self->srcpad);
727 gst_aggregator_start_srcpad_task (GstAggregator * self)
729 GST_INFO_OBJECT (self, "Starting srcpad task");
731 self->priv->running = TRUE;
732 gst_pad_start_task (GST_PAD (self->srcpad),
733 (GstTaskFunction) gst_aggregator_aggregate_func, self, NULL);
737 gst_aggregator_flush (GstAggregator * self)
739 GstFlowReturn ret = GST_FLOW_OK;
740 GstAggregatorPrivate *priv = self->priv;
741 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
743 GST_DEBUG_OBJECT (self, "Flushing everything");
744 GST_OBJECT_LOCK (self);
745 priv->send_segment = TRUE;
746 priv->flush_seeking = FALSE;
747 priv->tags_changed = FALSE;
748 GST_OBJECT_UNLOCK (self);
750 ret = klass->flush (self);
756 /* Called with GstAggregator's object lock held */
759 gst_aggregator_all_flush_stop_received_locked (GstAggregator * self)
762 GstAggregatorPad *tmppad;
764 for (tmp = GST_ELEMENT (self)->sinkpads; tmp; tmp = tmp->next) {
765 tmppad = (GstAggregatorPad *) tmp->data;
767 if (_check_pending_flush_stop (tmppad) == FALSE) {
768 GST_DEBUG_OBJECT (tmppad, "Is not last %i -- %i",
769 tmppad->priv->pending_flush_start, tmppad->priv->pending_flush_stop);
778 gst_aggregator_flush_start (GstAggregator * self, GstAggregatorPad * aggpad,
781 GstAggregatorPrivate *priv = self->priv;
782 GstAggregatorPadPrivate *padpriv = aggpad->priv;
784 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
786 /* Remove pad buffer and wake up the streaming thread */
787 gst_aggregator_pad_drop_buffer (aggpad);
789 PAD_STREAM_LOCK (aggpad);
791 if (padpriv->pending_flush_start) {
792 GST_DEBUG_OBJECT (aggpad, "Expecting FLUSH_STOP now");
794 padpriv->pending_flush_start = FALSE;
795 padpriv->pending_flush_stop = TRUE;
799 GST_OBJECT_LOCK (self);
800 if (priv->flush_seeking) {
801 /* If flush_seeking we forward the first FLUSH_START */
802 if (priv->pending_flush_start) {
803 priv->pending_flush_start = FALSE;
804 GST_OBJECT_UNLOCK (self);
806 GST_INFO_OBJECT (self, "Flushing, pausing srcpad task");
807 gst_aggregator_stop_srcpad_task (self, event);
808 priv->flow_return = GST_FLOW_OK;
810 GST_INFO_OBJECT (self, "Getting STREAM_LOCK while seeking");
811 GST_PAD_STREAM_LOCK (self->srcpad);
812 GST_LOG_OBJECT (self, "GOT STREAM_LOCK");
815 GST_OBJECT_UNLOCK (self);
816 gst_event_unref (event);
819 GST_OBJECT_UNLOCK (self);
820 gst_event_unref (event);
822 PAD_STREAM_UNLOCK (aggpad);
824 gst_aggregator_pad_drop_buffer (aggpad);
827 /* GstAggregator vmethods default implementations */
829 gst_aggregator_default_sink_event (GstAggregator * self,
830 GstAggregatorPad * aggpad, GstEvent * event)
833 GstPad *pad = GST_PAD (aggpad);
834 GstAggregatorPrivate *priv = self->priv;
836 switch (GST_EVENT_TYPE (event)) {
837 case GST_EVENT_FLUSH_START:
839 gst_aggregator_flush_start (self, aggpad, event);
840 /* We forward only in one case: right after flush_seeking */
844 case GST_EVENT_FLUSH_STOP:
846 GST_DEBUG_OBJECT (aggpad, "Got FLUSH_STOP");
848 gst_aggregator_pad_flush (aggpad, self);
849 GST_OBJECT_LOCK (self);
850 if (priv->flush_seeking) {
851 g_atomic_int_set (&aggpad->priv->pending_flush_stop, FALSE);
852 if (gst_aggregator_all_flush_stop_received_locked (self)) {
853 GST_OBJECT_UNLOCK (self);
854 /* That means we received FLUSH_STOP/FLUSH_STOP on
855 * all sinkpads -- Seeking is Done... sending FLUSH_STOP */
856 gst_aggregator_flush (self);
857 gst_pad_push_event (self->srcpad, event);
859 SRC_STREAM_LOCK (self);
860 priv->send_eos = TRUE;
861 SRC_STREAM_BROADCAST (self);
862 SRC_STREAM_UNLOCK (self);
864 GST_INFO_OBJECT (self, "Releasing source pad STREAM_LOCK");
865 GST_PAD_STREAM_UNLOCK (self->srcpad);
866 gst_aggregator_start_srcpad_task (self);
868 GST_OBJECT_UNLOCK (self);
871 GST_OBJECT_UNLOCK (self);
874 /* We never forward the event */
879 GST_DEBUG_OBJECT (aggpad, "EOS");
881 /* We still have a buffer, and we don't want the subclass to have to
882 * check for it. Mark pending_eos, eos will be set when steal_buffer is
885 SRC_STREAM_LOCK (self);
887 if (!aggpad->priv->buffer) {
888 aggpad->priv->eos = TRUE;
890 aggpad->priv->pending_eos = TRUE;
894 SRC_STREAM_BROADCAST (self);
895 SRC_STREAM_UNLOCK (self);
898 case GST_EVENT_SEGMENT:
900 GST_OBJECT_LOCK (aggpad);
901 gst_event_copy_segment (event, &aggpad->segment);
902 GST_OBJECT_UNLOCK (aggpad);
904 GST_OBJECT_LOCK (self);
905 self->priv->seqnum = gst_event_get_seqnum (event);
906 GST_OBJECT_UNLOCK (self);
909 case GST_EVENT_STREAM_START:
915 /* FIXME: need API to handle GAP events properly */
916 GST_FIXME_OBJECT (self, "implement support for GAP events");
917 /* don't forward GAP events downstream */
924 gst_event_parse_tag (event, &tags);
926 if (gst_tag_list_get_scope (tags) == GST_TAG_SCOPE_STREAM) {
927 gst_aggregator_merge_tags (self, tags, GST_TAG_MERGE_REPLACE);
928 gst_event_unref (event);
940 GST_DEBUG_OBJECT (pad, "Forwarding event: %" GST_PTR_FORMAT, event);
941 return gst_pad_event_default (pad, GST_OBJECT (self), event);
944 GST_DEBUG_OBJECT (pad, "Eating event: %" GST_PTR_FORMAT, event);
946 gst_event_unref (event);
951 static inline gboolean
952 gst_aggregator_stop_pad (GstAggregator * self, GstAggregatorPad * pad,
953 gpointer unused_udata)
955 gst_aggregator_pad_flush (pad, self);
961 gst_aggregator_stop (GstAggregator * agg)
963 GstAggregatorClass *klass;
966 gst_aggregator_reset_flow_values (agg);
968 gst_aggregator_iterate_sinkpads (agg, gst_aggregator_stop_pad, NULL);
970 klass = GST_AGGREGATOR_GET_CLASS (agg);
973 result = klass->stop (agg);
978 gst_tag_list_unref (agg->priv->tags);
979 agg->priv->tags = NULL;
984 /* GstElement vmethods implementations */
985 static GstStateChangeReturn
986 gst_aggregator_change_state (GstElement * element, GstStateChange transition)
988 GstStateChangeReturn ret;
989 GstAggregator *self = GST_AGGREGATOR (element);
991 switch (transition) {
992 case GST_STATE_CHANGE_READY_TO_PAUSED:
993 if (!gst_aggregator_start (self))
1001 GST_ELEMENT_CLASS (aggregator_parent_class)->change_state (element,
1002 transition)) == GST_STATE_CHANGE_FAILURE)
1006 switch (transition) {
1007 case GST_STATE_CHANGE_PAUSED_TO_READY:
1008 if (!gst_aggregator_stop (self)) {
1009 /* What to do in this case? Error out? */
1010 GST_ERROR_OBJECT (self, "Subclass failed to stop.");
1022 GST_ERROR_OBJECT (element, "parent failed state change");
1027 GST_ERROR_OBJECT (element, "Subclass failed to start");
1028 return GST_STATE_CHANGE_FAILURE;
1033 gst_aggregator_release_pad (GstElement * element, GstPad * pad)
1035 GstAggregator *self = GST_AGGREGATOR (element);
1037 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1039 GST_INFO_OBJECT (pad, "Removing pad");
1041 SRC_STREAM_LOCK (self);
1042 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
1043 gst_aggregator_pad_drop_buffer (aggpad);
1044 gst_element_remove_pad (element, pad);
1046 SRC_STREAM_BROADCAST (self);
1047 SRC_STREAM_UNLOCK (self);
1051 gst_aggregator_request_new_pad (GstElement * element,
1052 GstPadTemplate * templ, const gchar * req_name, const GstCaps * caps)
1054 GstAggregator *self;
1055 GstAggregatorPad *agg_pad;
1057 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
1058 GstAggregatorPrivate *priv = GST_AGGREGATOR (element)->priv;
1060 self = GST_AGGREGATOR (element);
1062 if (templ == gst_element_class_get_pad_template (klass, "sink_%u")) {
1066 GST_OBJECT_LOCK (element);
1067 if (req_name == NULL || strlen (req_name) < 6
1068 || !g_str_has_prefix (req_name, "sink_")) {
1069 /* no name given when requesting the pad, use next available int */
1072 /* parse serial number from requested padname */
1073 serial = g_ascii_strtoull (&req_name[5], NULL, 10);
1074 if (serial >= priv->padcount)
1075 priv->padcount = serial;
1078 name = g_strdup_printf ("sink_%u", priv->padcount);
1079 agg_pad = g_object_new (GST_AGGREGATOR_GET_CLASS (self)->sinkpads_type,
1080 "name", name, "direction", GST_PAD_SINK, "template", templ, NULL);
1083 GST_OBJECT_UNLOCK (element);
1089 GST_DEBUG_OBJECT (element, "Adding pad %s", GST_PAD_NAME (agg_pad));
1092 gst_pad_set_active (GST_PAD (agg_pad), TRUE);
1094 /* add the pad to the element */
1095 gst_element_add_pad (element, GST_PAD (agg_pad));
1097 return GST_PAD (agg_pad);
1102 GstClockTime min, max;
1107 gst_aggregator_query_sink_latency_foreach (GstAggregator * self,
1108 GstAggregatorPad * pad, gpointer user_data)
1110 LatencyData *data = user_data;
1111 GstClockTime min, max;
1115 query = gst_query_new_latency ();
1116 res = gst_pad_peer_query (GST_PAD_CAST (pad), query);
1119 gst_query_parse_latency (query, &live, &min, &max);
1121 GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
1122 " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
1125 if (min > data->min)
1128 if (data->max == GST_CLOCK_TIME_NONE)
1130 else if (max < data->max)
1137 gst_query_unref (query);
1143 * gst_aggregator_get_latency_unlocked:
1144 * @self: a #GstAggregator
1145 * @live: (out) (allow-none): whether @self is live
1146 * @min_latency: (out) (allow-none): the configured minimum latency of @self
1147 * @max_latency: (out) (allow-none): the configured maximum latency of @self
1149 * Retreives the latency values reported by @self in response to the latency
1152 * Typically only called by subclasses.
1154 * MUST be called with the object lock held.
1157 gst_aggregator_get_latency_unlocked (GstAggregator * self, gboolean * live,
1158 GstClockTime * min_latency, GstClockTime * max_latency)
1160 GstClockTime min, max;
1162 g_return_if_fail (GST_IS_AGGREGATOR (self));
1164 /* latency_min is never GST_CLOCK_TIME_NONE by construction */
1165 min = self->priv->latency_min;
1166 max = self->priv->latency_max;
1169 min += self->priv->latency;
1170 min += self->priv->sub_latency_min;
1171 if (GST_CLOCK_TIME_IS_VALID (max)
1172 && GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max))
1173 max += self->priv->sub_latency_max;
1175 max = GST_CLOCK_TIME_NONE;
1178 *live = self->priv->latency_live;
1186 gst_aggregator_query_latency (GstAggregator * self, GstQuery * query)
1188 GstClockTime our_latency;
1192 data.max = GST_CLOCK_TIME_NONE;
1195 /* query upstream's latency */
1196 SRC_STREAM_LOCK (self);
1197 gst_aggregator_iterate_sinkpads (self,
1198 gst_aggregator_query_sink_latency_foreach, &data);
1199 SRC_STREAM_UNLOCK (self);
1201 GST_OBJECT_LOCK (self);
1202 our_latency = self->priv->latency;
1204 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (data.min))) {
1205 GST_WARNING_OBJECT (self, "Invalid minimum latency, using 0");
1209 if (G_UNLIKELY (data.min > data.max)) {
1210 GST_WARNING_OBJECT (self, "Minimum latency is greater than maximum latency "
1211 "(%" G_GINT64_FORMAT " > %" G_GINT64_FORMAT "). "
1212 "Clamping it at the maximum latency", data.min, data.max);
1213 data.min = data.max;
1216 self->priv->latency_live = data.live;
1217 self->priv->latency_min = data.min;
1218 self->priv->latency_max = data.max;
1221 data.min += our_latency;
1222 data.min += self->priv->sub_latency_min;
1223 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max)
1224 && GST_CLOCK_TIME_IS_VALID (data.max))
1225 data.max += self->priv->sub_latency_max;
1227 data.max = GST_CLOCK_TIME_NONE;
1229 if (data.live && data.min > data.max) {
1230 GST_ELEMENT_WARNING (self, CORE, NEGOTIATION,
1231 ("%s", "Latency too big"),
1232 ("The requested latency value is too big for the current pipeline. "
1233 "Limiting to %" G_GINT64_FORMAT, data.max));
1234 data.min = data.max;
1235 /* FIXME: This could in theory become negative, but in
1236 * that case all is lost anyway */
1237 self->priv->latency -= data.min - data.max;
1238 /* FIXME: shouldn't we g_object_notify() the change here? */
1241 GST_OBJECT_UNLOCK (self);
1243 GST_DEBUG_OBJECT (self, "configured latency live:%s min:%" G_GINT64_FORMAT
1244 " max:%" G_GINT64_FORMAT, data.live ? "true" : "false", data.min,
1247 gst_query_set_latency (query, data.live, data.min, data.max);
1253 gst_aggregator_send_event (GstElement * element, GstEvent * event)
1255 GstAggregator *self = GST_AGGREGATOR (element);
1257 GST_STATE_LOCK (element);
1258 if (GST_EVENT_TYPE (event) == GST_EVENT_SEEK &&
1259 GST_STATE (element) < GST_STATE_PAUSED) {
1263 GstSeekType start_type, stop_type;
1266 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1267 &start, &stop_type, &stop);
1269 GST_OBJECT_LOCK (self);
1270 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
1271 stop_type, stop, NULL);
1272 self->priv->seqnum = gst_event_get_seqnum (event);
1273 GST_OBJECT_UNLOCK (self);
1275 GST_DEBUG_OBJECT (element, "Storing segment %" GST_PTR_FORMAT, event);
1277 GST_STATE_UNLOCK (element);
1280 return GST_ELEMENT_CLASS (aggregator_parent_class)->send_event (element,
1285 gst_aggregator_default_src_query (GstAggregator * self, GstQuery * query)
1287 gboolean res = TRUE;
1289 switch (GST_QUERY_TYPE (query)) {
1290 case GST_QUERY_SEEKING:
1294 /* don't pass it along as some (file)sink might claim it does
1295 * whereas with a collectpads in between that will not likely work */
1296 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
1297 gst_query_set_seeking (query, format, FALSE, 0, -1);
1302 case GST_QUERY_LATENCY:
1306 ret = gst_aggregator_query_latency (self, query);
1307 /* Wake up the src thread again, due to changed latencies
1308 * or changed live-ness we might have to adjust if we wait
1309 * on a deadline at all and how long.
1310 * This is only to unschedule the clock id, we don't really care
1311 * about the GCond here.
1313 SRC_STREAM_LOCK (self);
1314 SRC_STREAM_BROADCAST (self);
1315 SRC_STREAM_UNLOCK (self);
1322 return gst_pad_query_default (self->srcpad, GST_OBJECT (self), query);
1329 gst_aggregator_event_forward_func (GstPad * pad, gpointer user_data)
1331 EventData *evdata = user_data;
1332 gboolean ret = TRUE;
1333 GstPad *peer = gst_pad_get_peer (pad);
1334 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1337 ret = gst_pad_send_event (peer, gst_event_ref (evdata->event));
1338 GST_DEBUG_OBJECT (pad, "return of event push is %d", ret);
1339 gst_object_unref (peer);
1343 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK)
1344 GST_ERROR_OBJECT (pad, "Event %" GST_PTR_FORMAT " failed", evdata->event);
1346 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK) {
1347 GstQuery *seeking = gst_query_new_seeking (GST_FORMAT_TIME);
1349 if (gst_pad_query (peer, seeking)) {
1352 gst_query_parse_seeking (seeking, NULL, &seekable, NULL, NULL);
1354 if (seekable == FALSE) {
1355 GST_INFO_OBJECT (pad,
1356 "Source not seekable, We failed but it does not matter!");
1361 GST_ERROR_OBJECT (pad, "Query seeking FAILED");
1364 gst_query_unref (seeking);
1367 if (evdata->flush) {
1369 aggpad->priv->pending_flush_start = FALSE;
1370 aggpad->priv->pending_flush_stop = FALSE;
1371 PAD_UNLOCK (aggpad);
1374 evdata->one_actually_seeked = TRUE;
1377 evdata->result &= ret;
1379 /* Always send to all pads */
1384 gst_aggregator_forward_event_to_all_sinkpads (GstAggregator * self,
1385 GstEvent * event, gboolean flush)
1389 evdata.event = event;
1390 evdata.result = TRUE;
1391 evdata.flush = flush;
1392 evdata.one_actually_seeked = FALSE;
1394 /* We first need to set all pads as flushing in a first pass
1395 * as flush_start flush_stop is sometimes sent synchronously
1396 * while we send the seek event */
1400 GST_OBJECT_LOCK (self);
1401 for (l = GST_ELEMENT_CAST (self)->sinkpads; l != NULL; l = l->next) {
1402 GstAggregatorPad *pad = l->data;
1405 pad->priv->pending_flush_start = TRUE;
1406 pad->priv->pending_flush_stop = FALSE;
1409 GST_OBJECT_UNLOCK (self);
1412 gst_pad_forward (self->srcpad, gst_aggregator_event_forward_func, &evdata);
1414 gst_event_unref (event);
1420 gst_aggregator_do_seek (GstAggregator * self, GstEvent * event)
1425 GstSeekType start_type, stop_type;
1429 GstAggregatorPrivate *priv = self->priv;
1431 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1432 &start, &stop_type, &stop);
1434 GST_INFO_OBJECT (self, "starting SEEK");
1436 flush = flags & GST_SEEK_FLAG_FLUSH;
1438 GST_OBJECT_LOCK (self);
1440 priv->pending_flush_start = TRUE;
1441 priv->flush_seeking = TRUE;
1444 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
1445 stop_type, stop, NULL);
1446 GST_OBJECT_UNLOCK (self);
1448 /* forward the seek upstream */
1449 evdata = gst_aggregator_forward_event_to_all_sinkpads (self, event, flush);
1452 if (!evdata.result || !evdata.one_actually_seeked) {
1453 GST_OBJECT_LOCK (self);
1454 priv->flush_seeking = FALSE;
1455 priv->pending_flush_start = FALSE;
1456 GST_OBJECT_UNLOCK (self);
1459 GST_INFO_OBJECT (self, "seek done, result: %d", evdata.result);
1461 return evdata.result;
1465 gst_aggregator_default_src_event (GstAggregator * self, GstEvent * event)
1468 gboolean res = TRUE;
1470 switch (GST_EVENT_TYPE (event)) {
1471 case GST_EVENT_SEEK:
1473 gst_event_ref (event);
1474 res = gst_aggregator_do_seek (self, event);
1475 gst_event_unref (event);
1479 case GST_EVENT_NAVIGATION:
1481 /* navigation is rather pointless. */
1483 gst_event_unref (event);
1492 evdata = gst_aggregator_forward_event_to_all_sinkpads (self, event, FALSE);
1493 res = evdata.result;
1500 gst_aggregator_src_pad_event_func (GstPad * pad, GstObject * parent,
1503 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1505 return klass->src_event (GST_AGGREGATOR (parent), event);
1509 gst_aggregator_src_pad_query_func (GstPad * pad, GstObject * parent,
1512 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1514 return klass->src_query (GST_AGGREGATOR (parent), query);
1518 gst_aggregator_src_pad_activate_mode_func (GstPad * pad,
1519 GstObject * parent, GstPadMode mode, gboolean active)
1521 GstAggregator *self = GST_AGGREGATOR (parent);
1522 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1524 if (klass->src_activate) {
1525 if (klass->src_activate (self, mode, active) == FALSE) {
1530 if (active == TRUE) {
1532 case GST_PAD_MODE_PUSH:
1534 GST_INFO_OBJECT (pad, "Activating pad!");
1535 gst_aggregator_start_srcpad_task (self);
1540 GST_ERROR_OBJECT (pad, "Only supported mode is PUSH");
1547 GST_INFO_OBJECT (self, "Deactivating srcpad");
1548 gst_aggregator_stop_srcpad_task (self, FALSE);
1554 gst_aggregator_default_sink_query (GstAggregator * self,
1555 GstAggregatorPad * aggpad, GstQuery * query)
1557 GstPad *pad = GST_PAD (aggpad);
1559 return gst_pad_query_default (pad, GST_OBJECT (self), query);
1563 gst_aggregator_finalize (GObject * object)
1565 GstAggregator *self = (GstAggregator *) object;
1567 g_mutex_clear (&self->priv->src_lock);
1568 g_cond_clear (&self->priv->src_cond);
1570 G_OBJECT_CLASS (aggregator_parent_class)->finalize (object);
1574 * gst_aggregator_set_latency_property:
1575 * @agg: a #GstAggregator
1576 * @latency: the new latency value.
1578 * Sets the new latency value to @latency. This value is used to limit the
1579 * amount of time a pad waits for data to appear before considering the pad
1583 gst_aggregator_set_latency_property (GstAggregator * self, gint64 latency)
1586 GstClockTime min, max;
1588 g_return_if_fail (GST_IS_AGGREGATOR (self));
1589 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (latency));
1591 GST_OBJECT_LOCK (self);
1592 if (self->priv->latency_live) {
1593 min = self->priv->latency_min;
1594 max = self->priv->latency_max;
1597 min += self->priv->sub_latency_min;
1598 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max)
1599 && GST_CLOCK_TIME_IS_VALID (max))
1600 max += self->priv->sub_latency_max;
1602 max = GST_CLOCK_TIME_NONE;
1604 if (GST_CLOCK_TIME_IS_VALID (max) && min > max) {
1605 GST_ELEMENT_WARNING (self, CORE, NEGOTIATION,
1606 ("%s", "Latency too big"),
1607 ("The requested latency value is too big for the latency in the "
1608 "current pipeline. Limiting to %" G_GINT64_FORMAT, max));
1609 /* FIXME: This could in theory become negative, but in
1610 * that case all is lost anyway */
1611 latency -= min - max;
1612 /* FIXME: shouldn't we g_object_notify() the change here? */
1616 changed = (self->priv->latency != latency);
1617 self->priv->latency = latency;
1618 GST_OBJECT_UNLOCK (self);
1621 gst_element_post_message (GST_ELEMENT_CAST (self),
1622 gst_message_new_latency (GST_OBJECT_CAST (self)));
1626 * gst_aggregator_get_latency_property:
1627 * @agg: a #GstAggregator
1629 * Gets the latency value. See gst_aggregator_set_latency for
1632 * Returns: The time in nanoseconds to wait for data to arrive on a sink pad
1633 * before a pad is deemed unresponsive. A value of -1 means an
1637 gst_aggregator_get_latency_property (GstAggregator * agg)
1641 g_return_val_if_fail (GST_IS_AGGREGATOR (agg), -1);
1643 GST_OBJECT_LOCK (agg);
1644 res = agg->priv->latency;
1645 GST_OBJECT_UNLOCK (agg);
1651 gst_aggregator_set_property (GObject * object, guint prop_id,
1652 const GValue * value, GParamSpec * pspec)
1654 GstAggregator *agg = GST_AGGREGATOR (object);
1658 gst_aggregator_set_latency_property (agg, g_value_get_int64 (value));
1661 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1667 gst_aggregator_get_property (GObject * object, guint prop_id,
1668 GValue * value, GParamSpec * pspec)
1670 GstAggregator *agg = GST_AGGREGATOR (object);
1674 g_value_set_int64 (value, gst_aggregator_get_latency_property (agg));
1677 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1682 /* GObject vmethods implementations */
1684 gst_aggregator_class_init (GstAggregatorClass * klass)
1686 GObjectClass *gobject_class = (GObjectClass *) klass;
1687 GstElementClass *gstelement_class = (GstElementClass *) klass;
1689 aggregator_parent_class = g_type_class_peek_parent (klass);
1690 g_type_class_add_private (klass, sizeof (GstAggregatorPrivate));
1692 GST_DEBUG_CATEGORY_INIT (aggregator_debug, "aggregator",
1693 GST_DEBUG_FG_MAGENTA, "GstAggregator");
1695 klass->sinkpads_type = GST_TYPE_AGGREGATOR_PAD;
1697 klass->sink_event = gst_aggregator_default_sink_event;
1698 klass->sink_query = gst_aggregator_default_sink_query;
1700 klass->src_event = gst_aggregator_default_src_event;
1701 klass->src_query = gst_aggregator_default_src_query;
1703 gstelement_class->request_new_pad =
1704 GST_DEBUG_FUNCPTR (gst_aggregator_request_new_pad);
1705 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_aggregator_send_event);
1706 gstelement_class->release_pad =
1707 GST_DEBUG_FUNCPTR (gst_aggregator_release_pad);
1708 gstelement_class->change_state =
1709 GST_DEBUG_FUNCPTR (gst_aggregator_change_state);
1711 gobject_class->set_property = gst_aggregator_set_property;
1712 gobject_class->get_property = gst_aggregator_get_property;
1713 gobject_class->finalize = gst_aggregator_finalize;
1715 g_object_class_install_property (gobject_class, PROP_LATENCY,
1716 g_param_spec_int64 ("latency", "Buffer latency",
1717 "Additional latency in live mode to allow upstream "
1718 "to take longer to produce buffers for the current "
1720 (G_MAXLONG == G_MAXINT64) ? G_MAXINT64 : (G_MAXLONG * GST_SECOND - 1),
1721 DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1723 GST_DEBUG_REGISTER_FUNCPTR (gst_aggregator_stop_pad);
1724 GST_DEBUG_REGISTER_FUNCPTR (gst_aggregator_query_sink_latency_foreach);
1728 gst_aggregator_init (GstAggregator * self, GstAggregatorClass * klass)
1730 GstPadTemplate *pad_template;
1731 GstAggregatorPrivate *priv;
1733 g_return_if_fail (klass->aggregate != NULL);
1736 G_TYPE_INSTANCE_GET_PRIVATE (self, GST_TYPE_AGGREGATOR,
1737 GstAggregatorPrivate);
1742 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "src");
1743 g_return_if_fail (pad_template != NULL);
1745 priv->padcount = -1;
1746 priv->tags_changed = FALSE;
1748 self->priv->latency_live = FALSE;
1749 self->priv->latency_min = self->priv->sub_latency_min = 0;
1750 self->priv->latency_max = self->priv->sub_latency_max = 0;
1751 gst_aggregator_reset_flow_values (self);
1753 self->srcpad = gst_pad_new_from_template (pad_template, "src");
1755 gst_pad_set_event_function (self->srcpad,
1756 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_event_func));
1757 gst_pad_set_query_function (self->srcpad,
1758 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_query_func));
1759 gst_pad_set_activatemode_function (self->srcpad,
1760 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_activate_mode_func));
1762 gst_element_add_pad (GST_ELEMENT (self), self->srcpad);
1764 self->priv->latency = DEFAULT_LATENCY;
1766 g_mutex_init (&self->priv->src_lock);
1767 g_cond_init (&self->priv->src_cond);
1770 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
1771 * method to get to the padtemplates */
1773 gst_aggregator_get_type (void)
1775 static volatile gsize type = 0;
1777 if (g_once_init_enter (&type)) {
1779 static const GTypeInfo info = {
1780 sizeof (GstAggregatorClass),
1783 (GClassInitFunc) gst_aggregator_class_init,
1786 sizeof (GstAggregator),
1788 (GInstanceInitFunc) gst_aggregator_init,
1791 _type = g_type_register_static (GST_TYPE_ELEMENT,
1792 "GstAggregator", &info, G_TYPE_FLAG_ABSTRACT);
1793 g_once_init_leave (&type, _type);
1798 static GstFlowReturn
1799 gst_aggregator_pad_chain (GstPad * pad, GstObject * object, GstBuffer * buffer)
1801 GstBuffer *actual_buf = buffer;
1802 GstAggregator *self = GST_AGGREGATOR (object);
1803 GstAggregatorPrivate *priv = self->priv;
1804 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1805 GstAggregatorClass *aggclass = GST_AGGREGATOR_GET_CLASS (object);
1806 GstFlowReturn flow_return;
1808 GST_DEBUG_OBJECT (aggpad, "Start chaining a buffer %" GST_PTR_FORMAT, buffer);
1810 PAD_STREAM_LOCK (aggpad);
1812 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1816 if (aggpad->priv->pending_eos == TRUE)
1819 while (aggpad->priv->buffer
1820 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1821 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1822 PAD_WAIT_EVENT (aggpad);
1824 PAD_UNLOCK (aggpad);
1826 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1829 if (aggclass->clip) {
1830 aggclass->clip (self, aggpad, buffer, &actual_buf);
1833 SRC_STREAM_LOCK (self);
1835 if (aggpad->priv->buffer)
1836 gst_buffer_unref (aggpad->priv->buffer);
1837 aggpad->priv->buffer = actual_buf;
1838 PAD_UNLOCK (aggpad);
1839 PAD_STREAM_UNLOCK (aggpad);
1841 SRC_STREAM_BROADCAST (self);
1842 SRC_STREAM_UNLOCK (self);
1844 GST_DEBUG_OBJECT (aggpad, "Done chaining");
1846 GST_OBJECT_LOCK (self);
1847 flow_return = priv->flow_return;
1848 GST_OBJECT_UNLOCK (self);
1853 PAD_STREAM_UNLOCK (aggpad);
1855 gst_buffer_unref (buffer);
1856 GST_DEBUG_OBJECT (aggpad, "We are flushing");
1858 return GST_FLOW_FLUSHING;
1861 PAD_UNLOCK (aggpad);
1862 PAD_STREAM_UNLOCK (aggpad);
1864 gst_buffer_unref (buffer);
1865 GST_DEBUG_OBJECT (pad, "We are EOS already...");
1867 return GST_FLOW_EOS;
1871 gst_aggregator_pad_query_func (GstPad * pad, GstObject * parent,
1874 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1875 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1877 if (GST_QUERY_IS_SERIALIZED (query)) {
1880 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE) {
1881 PAD_UNLOCK (aggpad);
1885 while (aggpad->priv->buffer
1886 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1887 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1888 PAD_WAIT_EVENT (aggpad);
1890 PAD_UNLOCK (aggpad);
1892 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1896 return klass->sink_query (GST_AGGREGATOR (parent),
1897 GST_AGGREGATOR_PAD (pad), query);
1900 GST_DEBUG_OBJECT (aggpad, "Pad is flushing, dropping query");
1905 gst_aggregator_pad_event_func (GstPad * pad, GstObject * parent,
1908 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1909 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1911 if (GST_EVENT_IS_SERIALIZED (event) && GST_EVENT_TYPE (event) != GST_EVENT_EOS
1912 && GST_EVENT_TYPE (event) != GST_EVENT_SEGMENT_DONE) {
1915 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE
1916 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP) {
1917 PAD_UNLOCK (aggpad);
1921 while (aggpad->priv->buffer
1922 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1923 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1924 PAD_WAIT_EVENT (aggpad);
1926 PAD_UNLOCK (aggpad);
1928 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE
1929 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP)
1933 return klass->sink_event (GST_AGGREGATOR (parent),
1934 GST_AGGREGATOR_PAD (pad), event);
1937 GST_DEBUG_OBJECT (aggpad, "Pad is flushing, dropping event");
1938 if (GST_EVENT_IS_STICKY (event))
1939 gst_pad_store_sticky_event (pad, event);
1940 gst_event_unref (event);
1945 gst_aggregator_pad_activate_mode_func (GstPad * pad,
1946 GstObject * parent, GstPadMode mode, gboolean active)
1948 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1950 if (active == FALSE) {
1952 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
1953 gst_buffer_replace (&aggpad->priv->buffer, NULL);
1954 PAD_BROADCAST_EVENT (aggpad);
1955 PAD_UNLOCK (aggpad);
1958 g_atomic_int_set (&aggpad->priv->flushing, FALSE);
1959 PAD_BROADCAST_EVENT (aggpad);
1960 PAD_UNLOCK (aggpad);
1966 /***********************************
1967 * GstAggregatorPad implementation *
1968 ************************************/
1969 G_DEFINE_TYPE (GstAggregatorPad, gst_aggregator_pad, GST_TYPE_PAD);
1972 gst_aggregator_pad_constructed (GObject * object)
1974 GstPad *pad = GST_PAD (object);
1976 gst_pad_set_chain_function (pad,
1977 GST_DEBUG_FUNCPTR (gst_aggregator_pad_chain));
1978 gst_pad_set_event_function (pad,
1979 GST_DEBUG_FUNCPTR (gst_aggregator_pad_event_func));
1980 gst_pad_set_query_function (pad,
1981 GST_DEBUG_FUNCPTR (gst_aggregator_pad_query_func));
1982 gst_pad_set_activatemode_function (pad,
1983 GST_DEBUG_FUNCPTR (gst_aggregator_pad_activate_mode_func));
1987 gst_aggregator_pad_finalize (GObject * object)
1989 GstAggregatorPad *pad = (GstAggregatorPad *) object;
1991 g_cond_clear (&pad->priv->event_cond);
1992 g_mutex_clear (&pad->priv->stream_lock);
1993 g_mutex_clear (&pad->priv->lock);
1995 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->finalize (object);
1999 gst_aggregator_pad_dispose (GObject * object)
2001 GstAggregatorPad *pad = (GstAggregatorPad *) object;
2003 gst_aggregator_pad_drop_buffer (pad);
2005 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->dispose (object);
2009 gst_aggregator_pad_class_init (GstAggregatorPadClass * klass)
2011 GObjectClass *gobject_class = (GObjectClass *) klass;
2013 g_type_class_add_private (klass, sizeof (GstAggregatorPadPrivate));
2015 gobject_class->constructed = gst_aggregator_pad_constructed;
2016 gobject_class->finalize = gst_aggregator_pad_finalize;
2017 gobject_class->dispose = gst_aggregator_pad_dispose;
2021 gst_aggregator_pad_init (GstAggregatorPad * pad)
2024 G_TYPE_INSTANCE_GET_PRIVATE (pad, GST_TYPE_AGGREGATOR_PAD,
2025 GstAggregatorPadPrivate);
2027 pad->priv->buffer = NULL;
2028 g_cond_init (&pad->priv->event_cond);
2030 g_mutex_init (&pad->priv->stream_lock);
2031 g_mutex_init (&pad->priv->lock);
2035 * gst_aggregator_pad_steal_buffer:
2036 * @pad: the pad to get buffer from
2038 * Steal the ref to the buffer currently queued in @pad.
2040 * Returns: (transfer full): The buffer in @pad or NULL if no buffer was
2041 * queued. You should unref the buffer after usage.
2044 gst_aggregator_pad_steal_buffer (GstAggregatorPad * pad)
2046 GstBuffer *buffer = NULL;
2049 if (pad->priv->buffer) {
2050 GST_TRACE_OBJECT (pad, "Consuming buffer");
2051 buffer = pad->priv->buffer;
2052 pad->priv->buffer = NULL;
2053 if (pad->priv->pending_eos) {
2054 pad->priv->pending_eos = FALSE;
2055 pad->priv->eos = TRUE;
2057 PAD_BROADCAST_EVENT (pad);
2058 GST_DEBUG_OBJECT (pad, "Consumed: %" GST_PTR_FORMAT, buffer);
2066 * gst_aggregator_pad_drop_buffer:
2067 * @pad: the pad where to drop any pending buffer
2069 * Drop the buffer currently queued in @pad.
2071 * Returns: TRUE if there was a buffer queued in @pad, or FALSE if not.
2074 gst_aggregator_pad_drop_buffer (GstAggregatorPad * pad)
2078 buf = gst_aggregator_pad_steal_buffer (pad);
2083 gst_buffer_unref (buf);
2088 * gst_aggregator_pad_get_buffer:
2089 * @pad: the pad to get buffer from
2091 * Returns: (transfer full): A reference to the buffer in @pad or
2092 * NULL if no buffer was queued. You should unref the buffer after
2096 gst_aggregator_pad_get_buffer (GstAggregatorPad * pad)
2098 GstBuffer *buffer = NULL;
2101 if (pad->priv->buffer)
2102 buffer = gst_buffer_ref (pad->priv->buffer);
2109 gst_aggregator_pad_is_eos (GstAggregatorPad * pad)
2114 is_eos = pad->priv->eos;
2121 * gst_aggregator_merge_tags:
2122 * @self: a #GstAggregator
2123 * @tags: a #GstTagList to merge
2124 * @mode: the #GstTagMergeMode to use
2126 * Adds tags to so-called pending tags, which will be processed
2127 * before pushing out data downstream.
2129 * Note that this is provided for convenience, and the subclass is
2130 * not required to use this and can still do tag handling on its own.
2135 gst_aggregator_merge_tags (GstAggregator * self,
2136 const GstTagList * tags, GstTagMergeMode mode)
2140 g_return_if_fail (GST_IS_AGGREGATOR (self));
2141 g_return_if_fail (tags == NULL || GST_IS_TAG_LIST (tags));
2143 /* FIXME Check if we can use OBJECT lock here! */
2144 GST_OBJECT_LOCK (self);
2146 GST_DEBUG_OBJECT (self, "merging tags %" GST_PTR_FORMAT, tags);
2147 otags = self->priv->tags;
2148 self->priv->tags = gst_tag_list_merge (self->priv->tags, tags, mode);
2150 gst_tag_list_unref (otags);
2151 self->priv->tags_changed = TRUE;
2152 GST_OBJECT_UNLOCK (self);
2156 * gst_aggregator_set_latency:
2157 * @self: a #GstAggregator
2158 * @min_latency: minimum latency
2159 * @max_latency: maximum latency
2161 * Lets #GstAggregator sub-classes tell the baseclass what their internal
2162 * latency is. Will also post a LATENCY message on the bus so the pipeline
2163 * can reconfigure its global latency.
2166 gst_aggregator_set_latency (GstAggregator * self,
2167 GstClockTime min_latency, GstClockTime max_latency)
2169 gboolean changed = FALSE;
2171 g_return_if_fail (GST_IS_AGGREGATOR (self));
2172 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (min_latency));
2173 g_return_if_fail (max_latency >= min_latency);
2175 GST_OBJECT_LOCK (self);
2176 if (self->priv->sub_latency_min != min_latency) {
2177 self->priv->sub_latency_min = min_latency;
2180 if (self->priv->sub_latency_max != max_latency) {
2181 self->priv->sub_latency_max = max_latency;
2184 GST_OBJECT_UNLOCK (self);
2187 gst_element_post_message (GST_ELEMENT_CAST (self),
2188 gst_message_new_latency (GST_OBJECT_CAST (self)));