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;
575 if (GST_CLOCK_TIME_IS_VALID (latency_min)) {
578 time += self->priv->latency;
581 GST_DEBUG_OBJECT (self, "possibly waiting for clock to reach %"
582 GST_TIME_FORMAT " (base %" GST_TIME_FORMAT " start %" GST_TIME_FORMAT
583 " latency max %" GST_TIME_FORMAT " latency min %" GST_TIME_FORMAT
584 " current %" GST_TIME_FORMAT ")", GST_TIME_ARGS (time),
585 GST_TIME_ARGS (GST_ELEMENT_CAST (self)->base_time),
586 GST_TIME_ARGS (start), GST_TIME_ARGS (latency_max),
587 GST_TIME_ARGS (latency_min),
588 GST_TIME_ARGS (gst_clock_get_time (clock)));
590 GST_OBJECT_UNLOCK (self);
592 self->priv->aggregate_id = gst_clock_new_single_shot_id (clock, time);
593 gst_object_unref (clock);
594 SRC_STREAM_UNLOCK (self);
597 status = gst_clock_id_wait (self->priv->aggregate_id, &jitter);
599 SRC_STREAM_LOCK (self);
600 if (self->priv->aggregate_id) {
601 gst_clock_id_unref (self->priv->aggregate_id);
602 self->priv->aggregate_id = NULL;
605 GST_DEBUG_OBJECT (self,
606 "clock returned %d (jitter: %s%" GST_TIME_FORMAT ")",
607 status, (jitter < 0 ? "-" : " "),
608 GST_TIME_ARGS ((jitter < 0 ? -jitter : jitter)));
611 if (status == GST_CLOCK_OK || status == GST_CLOCK_EARLY) {
612 SRC_STREAM_UNLOCK (self);
618 res = gst_aggregator_check_pads_ready (self);
619 SRC_STREAM_UNLOCK (self);
625 gst_aggregator_aggregate_func (GstAggregator * self)
627 GstAggregatorPrivate *priv = self->priv;
628 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
629 gboolean timeout = FALSE;
631 if (self->priv->running == FALSE) {
632 GST_DEBUG_OBJECT (self, "Not running anymore");
636 GST_LOG_OBJECT (self, "Checking aggregate");
637 while (priv->send_eos && priv->running) {
638 GstFlowReturn flow_return;
640 if (!gst_aggregator_wait_and_check (self, &timeout))
643 GST_TRACE_OBJECT (self, "Actually aggregating!");
645 flow_return = klass->aggregate (self, timeout);
647 GST_OBJECT_LOCK (self);
648 if (flow_return == GST_FLOW_FLUSHING && priv->flush_seeking)
649 priv->flow_return = GST_FLOW_OK;
651 priv->flow_return = flow_return;
652 GST_OBJECT_UNLOCK (self);
654 if (flow_return == GST_FLOW_EOS) {
655 gst_aggregator_push_eos (self);
658 GST_LOG_OBJECT (self, "flow return is %s", gst_flow_get_name (flow_return));
660 if (flow_return != GST_FLOW_OK)
666 gst_aggregator_start (GstAggregator * self)
668 GstAggregatorClass *klass;
671 self->priv->running = TRUE;
672 self->priv->send_stream_start = TRUE;
673 self->priv->send_segment = TRUE;
674 self->priv->send_eos = TRUE;
675 self->priv->srccaps = NULL;
676 self->priv->flow_return = GST_FLOW_OK;
678 klass = GST_AGGREGATOR_GET_CLASS (self);
681 result = klass->start (self);
689 _check_pending_flush_stop (GstAggregatorPad * pad)
694 res = (!pad->priv->pending_flush_stop && !pad->priv->pending_flush_start);
701 gst_aggregator_stop_srcpad_task (GstAggregator * self, GstEvent * flush_start)
705 GST_INFO_OBJECT (self, "%s srcpad task",
706 flush_start ? "Pausing" : "Stopping");
708 SRC_STREAM_LOCK (self);
709 self->priv->running = FALSE;
710 SRC_STREAM_BROADCAST (self);
711 SRC_STREAM_UNLOCK (self);
714 res = gst_pad_push_event (self->srcpad, flush_start);
717 gst_pad_stop_task (self->srcpad);
723 gst_aggregator_start_srcpad_task (GstAggregator * self)
725 GST_INFO_OBJECT (self, "Starting srcpad task");
727 self->priv->running = TRUE;
728 gst_pad_start_task (GST_PAD (self->srcpad),
729 (GstTaskFunction) gst_aggregator_aggregate_func, self, NULL);
733 gst_aggregator_flush (GstAggregator * self)
735 GstFlowReturn ret = GST_FLOW_OK;
736 GstAggregatorPrivate *priv = self->priv;
737 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
739 GST_DEBUG_OBJECT (self, "Flushing everything");
740 GST_OBJECT_LOCK (self);
741 priv->send_segment = TRUE;
742 priv->flush_seeking = FALSE;
743 priv->tags_changed = FALSE;
744 GST_OBJECT_UNLOCK (self);
746 ret = klass->flush (self);
752 /* Called with GstAggregator's object lock held */
755 gst_aggregator_all_flush_stop_received_locked (GstAggregator * self)
758 GstAggregatorPad *tmppad;
760 for (tmp = GST_ELEMENT (self)->sinkpads; tmp; tmp = tmp->next) {
761 tmppad = (GstAggregatorPad *) tmp->data;
763 if (_check_pending_flush_stop (tmppad) == FALSE) {
764 GST_DEBUG_OBJECT (tmppad, "Is not last %i -- %i",
765 tmppad->priv->pending_flush_start, tmppad->priv->pending_flush_stop);
774 gst_aggregator_flush_start (GstAggregator * self, GstAggregatorPad * aggpad,
778 GstAggregatorPrivate *priv = self->priv;
779 GstAggregatorPadPrivate *padpriv = aggpad->priv;
781 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
782 /* Remove pad buffer and wake up the streaming thread */
783 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
784 gst_buffer_replace (&tmpbuf, NULL);
786 PAD_STREAM_LOCK (aggpad);
788 if (padpriv->pending_flush_start) {
789 GST_DEBUG_OBJECT (aggpad, "Expecting FLUSH_STOP now");
791 padpriv->pending_flush_start = FALSE;
792 padpriv->pending_flush_stop = TRUE;
796 GST_OBJECT_LOCK (self);
797 if (priv->flush_seeking) {
798 /* If flush_seeking we forward the first FLUSH_START */
799 if (priv->pending_flush_start) {
800 priv->pending_flush_start = FALSE;
801 GST_OBJECT_UNLOCK (self);
803 GST_INFO_OBJECT (self, "Flushing, pausing srcpad task");
804 gst_aggregator_stop_srcpad_task (self, event);
805 priv->flow_return = GST_FLOW_OK;
807 GST_INFO_OBJECT (self, "Getting STREAM_LOCK while seeking");
808 GST_PAD_STREAM_LOCK (self->srcpad);
809 GST_LOG_OBJECT (self, "GOT STREAM_LOCK");
812 GST_OBJECT_UNLOCK (self);
813 gst_event_unref (event);
816 GST_OBJECT_UNLOCK (self);
817 gst_event_unref (event);
819 PAD_STREAM_UNLOCK (aggpad);
821 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
822 gst_buffer_replace (&tmpbuf, NULL);
825 /* GstAggregator vmethods default implementations */
827 gst_aggregator_default_sink_event (GstAggregator * self,
828 GstAggregatorPad * aggpad, GstEvent * event)
831 GstPad *pad = GST_PAD (aggpad);
832 GstAggregatorPrivate *priv = self->priv;
834 switch (GST_EVENT_TYPE (event)) {
835 case GST_EVENT_FLUSH_START:
837 gst_aggregator_flush_start (self, aggpad, event);
838 /* We forward only in one case: right after flush_seeking */
842 case GST_EVENT_FLUSH_STOP:
844 GST_DEBUG_OBJECT (aggpad, "Got FLUSH_STOP");
846 gst_aggregator_pad_flush (aggpad, self);
847 GST_OBJECT_LOCK (self);
848 if (priv->flush_seeking) {
849 g_atomic_int_set (&aggpad->priv->pending_flush_stop, FALSE);
850 if (gst_aggregator_all_flush_stop_received_locked (self)) {
851 GST_OBJECT_UNLOCK (self);
852 /* That means we received FLUSH_STOP/FLUSH_STOP on
853 * all sinkpads -- Seeking is Done... sending FLUSH_STOP */
854 gst_aggregator_flush (self);
855 gst_pad_push_event (self->srcpad, event);
857 SRC_STREAM_LOCK (self);
858 priv->send_eos = TRUE;
859 SRC_STREAM_BROADCAST (self);
860 SRC_STREAM_UNLOCK (self);
862 GST_INFO_OBJECT (self, "Releasing source pad STREAM_LOCK");
863 GST_PAD_STREAM_UNLOCK (self->srcpad);
864 gst_aggregator_start_srcpad_task (self);
866 GST_OBJECT_UNLOCK (self);
869 GST_OBJECT_UNLOCK (self);
872 /* We never forward the event */
877 GST_DEBUG_OBJECT (aggpad, "EOS");
879 /* We still have a buffer, and we don't want the subclass to have to
880 * check for it. Mark pending_eos, eos will be set when steal_buffer is
883 SRC_STREAM_LOCK (self);
885 if (!aggpad->priv->buffer) {
886 aggpad->priv->eos = TRUE;
888 aggpad->priv->pending_eos = TRUE;
892 SRC_STREAM_BROADCAST (self);
893 SRC_STREAM_UNLOCK (self);
896 case GST_EVENT_SEGMENT:
898 GST_OBJECT_LOCK (aggpad);
899 gst_event_copy_segment (event, &aggpad->segment);
900 GST_OBJECT_UNLOCK (aggpad);
902 GST_OBJECT_LOCK (self);
903 self->priv->seqnum = gst_event_get_seqnum (event);
904 GST_OBJECT_UNLOCK (self);
907 case GST_EVENT_STREAM_START:
915 gst_event_parse_tag (event, &tags);
917 if (gst_tag_list_get_scope (tags) == GST_TAG_SCOPE_STREAM) {
918 gst_aggregator_merge_tags (self, tags, GST_TAG_MERGE_REPLACE);
919 gst_event_unref (event);
931 GST_DEBUG_OBJECT (pad, "Forwarding event: %" GST_PTR_FORMAT, event);
932 return gst_pad_event_default (pad, GST_OBJECT (self), event);
935 GST_DEBUG_OBJECT (pad, "Eating event: %" GST_PTR_FORMAT, event);
937 gst_event_unref (event);
942 static inline gboolean
943 gst_aggregator_stop_pad (GstAggregator * self, GstAggregatorPad * pad,
944 gpointer unused_udata)
946 gst_aggregator_pad_flush (pad, self);
952 gst_aggregator_stop (GstAggregator * agg)
954 GstAggregatorClass *klass;
957 gst_aggregator_reset_flow_values (agg);
959 gst_aggregator_iterate_sinkpads (agg, gst_aggregator_stop_pad, NULL);
961 klass = GST_AGGREGATOR_GET_CLASS (agg);
964 result = klass->stop (agg);
969 gst_tag_list_unref (agg->priv->tags);
970 agg->priv->tags = NULL;
975 /* GstElement vmethods implementations */
976 static GstStateChangeReturn
977 gst_aggregator_change_state (GstElement * element, GstStateChange transition)
979 GstStateChangeReturn ret;
980 GstAggregator *self = GST_AGGREGATOR (element);
982 switch (transition) {
983 case GST_STATE_CHANGE_READY_TO_PAUSED:
984 if (!gst_aggregator_start (self))
992 GST_ELEMENT_CLASS (aggregator_parent_class)->change_state (element,
993 transition)) == GST_STATE_CHANGE_FAILURE)
997 switch (transition) {
998 case GST_STATE_CHANGE_PAUSED_TO_READY:
999 if (!gst_aggregator_stop (self)) {
1000 /* What to do in this case? Error out? */
1001 GST_ERROR_OBJECT (self, "Subclass failed to stop.");
1013 GST_ERROR_OBJECT (element, "parent failed state change");
1018 GST_ERROR_OBJECT (element, "Subclass failed to start");
1019 return GST_STATE_CHANGE_FAILURE;
1024 gst_aggregator_release_pad (GstElement * element, GstPad * pad)
1026 GstAggregator *self = GST_AGGREGATOR (element);
1029 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1031 GST_INFO_OBJECT (pad, "Removing pad");
1033 SRC_STREAM_LOCK (self);
1034 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
1035 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
1036 gst_buffer_replace (&tmpbuf, NULL);
1037 gst_element_remove_pad (element, pad);
1039 SRC_STREAM_BROADCAST (self);
1040 SRC_STREAM_UNLOCK (self);
1044 gst_aggregator_request_new_pad (GstElement * element,
1045 GstPadTemplate * templ, const gchar * req_name, const GstCaps * caps)
1047 GstAggregator *self;
1048 GstAggregatorPad *agg_pad;
1050 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
1051 GstAggregatorPrivate *priv = GST_AGGREGATOR (element)->priv;
1053 self = GST_AGGREGATOR (element);
1055 if (templ == gst_element_class_get_pad_template (klass, "sink_%u")) {
1059 GST_OBJECT_LOCK (element);
1060 if (req_name == NULL || strlen (req_name) < 6
1061 || !g_str_has_prefix (req_name, "sink_")) {
1062 /* no name given when requesting the pad, use next available int */
1065 /* parse serial number from requested padname */
1066 serial = g_ascii_strtoull (&req_name[5], NULL, 10);
1067 if (serial >= priv->padcount)
1068 priv->padcount = serial;
1071 name = g_strdup_printf ("sink_%u", priv->padcount);
1072 agg_pad = g_object_new (GST_AGGREGATOR_GET_CLASS (self)->sinkpads_type,
1073 "name", name, "direction", GST_PAD_SINK, "template", templ, NULL);
1076 GST_OBJECT_UNLOCK (element);
1082 GST_DEBUG_OBJECT (element, "Adding pad %s", GST_PAD_NAME (agg_pad));
1085 gst_pad_set_active (GST_PAD (agg_pad), TRUE);
1087 /* add the pad to the element */
1088 gst_element_add_pad (element, GST_PAD (agg_pad));
1090 return GST_PAD (agg_pad);
1095 GstClockTime min, max;
1100 gst_aggregator_query_sink_latency_foreach (GstAggregator * self,
1101 GstAggregatorPad * pad, gpointer user_data)
1103 LatencyData *data = user_data;
1104 GstClockTime min, max;
1108 query = gst_query_new_latency ();
1109 res = gst_pad_peer_query (GST_PAD_CAST (pad), query);
1112 gst_query_parse_latency (query, &live, &min, &max);
1114 GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
1115 " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
1117 if (min != GST_CLOCK_TIME_NONE && min > data->min)
1120 if (max != GST_CLOCK_TIME_NONE &&
1121 ((data->max != GST_CLOCK_TIME_NONE && max < data->max) ||
1122 (data->max == GST_CLOCK_TIME_NONE)))
1128 gst_query_unref (query);
1134 * gst_aggregator_get_latency_unlocked:
1135 * @self: a #GstAggregator
1136 * @live: (out) (allow-none): whether @self is live
1137 * @min_latency: (out) (allow-none): the configured minimum latency of @self
1138 * @max_latency: (out) (allow-none): the configured maximum latency of @self
1140 * Retreives the latency values reported by @self in response to the latency
1143 * Typically only called by subclasses.
1145 * MUST be called with the object lock held.
1148 gst_aggregator_get_latency_unlocked (GstAggregator * self, gboolean * live,
1149 GstClockTime * min_latency, GstClockTime * max_latency)
1151 GstClockTime our_latency;
1152 GstClockTime min, max;
1154 g_return_if_fail (GST_IS_AGGREGATOR (self));
1156 /* latency_min is never GST_CLOCK_TIME_NONE by construction */
1157 min = self->priv->latency_min;
1158 max = self->priv->latency_max;
1160 min += self->priv->sub_latency_min;
1161 if (GST_CLOCK_TIME_IS_VALID (max)
1162 && GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max))
1163 max += self->priv->sub_latency_max;
1165 our_latency = self->priv->latency;
1166 if (GST_CLOCK_TIME_IS_VALID (our_latency)) {
1168 if (GST_CLOCK_TIME_IS_VALID (max))
1173 *live = self->priv->latency_live;
1181 gst_aggregator_query_latency (GstAggregator * self, GstQuery * query)
1183 GstClockTime our_latency;
1187 data.max = GST_CLOCK_TIME_NONE;
1190 /* query upstream's latency */
1191 SRC_STREAM_LOCK (self);
1192 gst_aggregator_iterate_sinkpads (self,
1193 gst_aggregator_query_sink_latency_foreach, &data);
1194 SRC_STREAM_UNLOCK (self);
1196 GST_OBJECT_LOCK (self);
1197 our_latency = self->priv->latency;
1199 if (data.live && GST_CLOCK_TIME_IS_VALID (our_latency) &&
1200 our_latency > data.max) {
1201 GST_ELEMENT_WARNING (self, CORE, NEGOTIATION,
1202 ("%s", "Latency too big"),
1203 ("The requested latency value is too big for the current pipeline. "
1204 "Limiting to %" G_GINT64_FORMAT, data.max));
1205 self->priv->latency = data.max;
1206 /* FIXME: shouldn't we g_object_notify() the change here? */
1209 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (data.min))) {
1210 GST_WARNING_OBJECT (self, "Invalid minimum latency, using 0");
1214 if (G_UNLIKELY (data.min > data.max)) {
1215 GST_WARNING_OBJECT (self, "Minimum latency is greater than maximum latency "
1216 "(%" G_GINT64_FORMAT " > %" G_GINT64_FORMAT "). "
1217 "Clamping it at the maximum latency", data.min, data.max);
1218 data.min = data.max;
1221 self->priv->latency_live = data.live;
1222 self->priv->latency_min = data.min;
1223 self->priv->latency_max = data.max;
1226 if (GST_CLOCK_TIME_IS_VALID (our_latency)) {
1227 if (GST_CLOCK_TIME_IS_VALID (data.min))
1228 data.min += our_latency;
1229 if (GST_CLOCK_TIME_IS_VALID (data.max))
1230 data.max += our_latency;
1233 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_min)
1234 && GST_CLOCK_TIME_IS_VALID (data.min))
1235 data.min += self->priv->sub_latency_min;
1236 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max)
1237 && GST_CLOCK_TIME_IS_VALID (data.max))
1238 data.max += self->priv->sub_latency_max;
1240 GST_OBJECT_UNLOCK (self);
1242 GST_DEBUG_OBJECT (self, "configured latency live:%s min:%" G_GINT64_FORMAT
1243 " max:%" G_GINT64_FORMAT, data.live ? "true" : "false", data.min,
1246 gst_query_set_latency (query, data.live, data.min, data.max);
1252 gst_aggregator_send_event (GstElement * element, GstEvent * event)
1254 GstAggregator *self = GST_AGGREGATOR (element);
1256 GST_STATE_LOCK (element);
1257 if (GST_EVENT_TYPE (event) == GST_EVENT_SEEK &&
1258 GST_STATE (element) < GST_STATE_PAUSED) {
1262 GstSeekType start_type, stop_type;
1265 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1266 &start, &stop_type, &stop);
1268 GST_OBJECT_LOCK (self);
1269 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
1270 stop_type, stop, NULL);
1271 self->priv->seqnum = gst_event_get_seqnum (event);
1272 GST_OBJECT_UNLOCK (self);
1274 GST_DEBUG_OBJECT (element, "Storing segment %" GST_PTR_FORMAT, event);
1276 GST_STATE_UNLOCK (element);
1279 return GST_ELEMENT_CLASS (aggregator_parent_class)->send_event (element,
1284 gst_aggregator_default_src_query (GstAggregator * self, GstQuery * query)
1286 gboolean res = TRUE;
1288 switch (GST_QUERY_TYPE (query)) {
1289 case GST_QUERY_SEEKING:
1293 /* don't pass it along as some (file)sink might claim it does
1294 * whereas with a collectpads in between that will not likely work */
1295 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
1296 gst_query_set_seeking (query, format, FALSE, 0, -1);
1301 case GST_QUERY_LATENCY:
1305 ret = gst_aggregator_query_latency (self, query);
1306 /* Wake up the src thread again, due to changed latencies
1307 * or changed live-ness we might have to adjust if we wait
1308 * on a deadline at all and how long.
1309 * This is only to unschedule the clock id, we don't really care
1310 * about the GCond here.
1312 SRC_STREAM_LOCK (self);
1313 SRC_STREAM_BROADCAST (self);
1314 SRC_STREAM_UNLOCK (self);
1321 return gst_pad_query_default (self->srcpad, GST_OBJECT (self), query);
1328 gst_aggregator_event_forward_func (GstPad * pad, gpointer user_data)
1330 EventData *evdata = user_data;
1331 gboolean ret = TRUE;
1332 GstPad *peer = gst_pad_get_peer (pad);
1333 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1336 ret = gst_pad_send_event (peer, gst_event_ref (evdata->event));
1337 GST_DEBUG_OBJECT (pad, "return of event push is %d", ret);
1338 gst_object_unref (peer);
1342 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK)
1343 GST_ERROR_OBJECT (pad, "Event %" GST_PTR_FORMAT " failed", evdata->event);
1345 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK) {
1346 GstQuery *seeking = gst_query_new_seeking (GST_FORMAT_TIME);
1348 if (gst_pad_query (peer, seeking)) {
1351 gst_query_parse_seeking (seeking, NULL, &seekable, NULL, NULL);
1353 if (seekable == FALSE) {
1354 GST_INFO_OBJECT (pad,
1355 "Source not seekable, We failed but it does not matter!");
1360 GST_ERROR_OBJECT (pad, "Query seeking FAILED");
1363 gst_query_unref (seeking);
1366 if (evdata->flush) {
1368 aggpad->priv->pending_flush_start = FALSE;
1369 aggpad->priv->pending_flush_stop = FALSE;
1370 PAD_UNLOCK (aggpad);
1373 evdata->one_actually_seeked = TRUE;
1376 evdata->result &= ret;
1378 /* Always send to all pads */
1383 gst_aggregator_forward_event_to_all_sinkpads (GstAggregator * self,
1384 GstEvent * event, gboolean flush)
1388 evdata.event = event;
1389 evdata.result = TRUE;
1390 evdata.flush = flush;
1391 evdata.one_actually_seeked = FALSE;
1393 /* We first need to set all pads as flushing in a first pass
1394 * as flush_start flush_stop is sometimes sent synchronously
1395 * while we send the seek event */
1399 GST_OBJECT_LOCK (self);
1400 for (l = GST_ELEMENT_CAST (self)->sinkpads; l != NULL; l = l->next) {
1401 GstAggregatorPad *pad = l->data;
1404 pad->priv->pending_flush_start = TRUE;
1405 pad->priv->pending_flush_stop = FALSE;
1408 GST_OBJECT_UNLOCK (self);
1411 gst_pad_forward (self->srcpad, gst_aggregator_event_forward_func, &evdata);
1413 gst_event_unref (event);
1419 gst_aggregator_do_seek (GstAggregator * self, GstEvent * event)
1424 GstSeekType start_type, stop_type;
1428 GstAggregatorPrivate *priv = self->priv;
1430 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1431 &start, &stop_type, &stop);
1433 GST_INFO_OBJECT (self, "starting SEEK");
1435 flush = flags & GST_SEEK_FLAG_FLUSH;
1437 GST_OBJECT_LOCK (self);
1439 priv->pending_flush_start = TRUE;
1440 priv->flush_seeking = TRUE;
1443 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
1444 stop_type, stop, NULL);
1445 GST_OBJECT_UNLOCK (self);
1447 /* forward the seek upstream */
1448 evdata = gst_aggregator_forward_event_to_all_sinkpads (self, event, flush);
1451 if (!evdata.result || !evdata.one_actually_seeked) {
1452 GST_OBJECT_LOCK (self);
1453 priv->flush_seeking = FALSE;
1454 priv->pending_flush_start = FALSE;
1455 GST_OBJECT_UNLOCK (self);
1458 GST_INFO_OBJECT (self, "seek done, result: %d", evdata.result);
1460 return evdata.result;
1464 gst_aggregator_default_src_event (GstAggregator * self, GstEvent * event)
1467 gboolean res = TRUE;
1469 switch (GST_EVENT_TYPE (event)) {
1470 case GST_EVENT_SEEK:
1472 gst_event_ref (event);
1473 res = gst_aggregator_do_seek (self, event);
1474 gst_event_unref (event);
1478 case GST_EVENT_NAVIGATION:
1480 /* navigation is rather pointless. */
1482 gst_event_unref (event);
1491 evdata = gst_aggregator_forward_event_to_all_sinkpads (self, event, FALSE);
1492 res = evdata.result;
1499 gst_aggregator_src_pad_event_func (GstPad * pad, GstObject * parent,
1502 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1504 return klass->src_event (GST_AGGREGATOR (parent), event);
1508 gst_aggregator_src_pad_query_func (GstPad * pad, GstObject * parent,
1511 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1513 return klass->src_query (GST_AGGREGATOR (parent), query);
1517 gst_aggregator_src_pad_activate_mode_func (GstPad * pad,
1518 GstObject * parent, GstPadMode mode, gboolean active)
1520 GstAggregator *self = GST_AGGREGATOR (parent);
1521 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1523 if (klass->src_activate) {
1524 if (klass->src_activate (self, mode, active) == FALSE) {
1529 if (active == TRUE) {
1531 case GST_PAD_MODE_PUSH:
1533 GST_INFO_OBJECT (pad, "Activating pad!");
1534 gst_aggregator_start_srcpad_task (self);
1539 GST_ERROR_OBJECT (pad, "Only supported mode is PUSH");
1546 GST_INFO_OBJECT (self, "Deactivating srcpad");
1547 gst_aggregator_stop_srcpad_task (self, FALSE);
1553 gst_aggregator_default_sink_query (GstAggregator * self,
1554 GstAggregatorPad * aggpad, GstQuery * query)
1556 GstPad *pad = GST_PAD (aggpad);
1558 return gst_pad_query_default (pad, GST_OBJECT (self), query);
1562 gst_aggregator_finalize (GObject * object)
1564 GstAggregator *self = (GstAggregator *) object;
1566 g_mutex_clear (&self->priv->src_lock);
1567 g_cond_clear (&self->priv->src_cond);
1569 G_OBJECT_CLASS (aggregator_parent_class)->finalize (object);
1573 * gst_aggregator_set_latency_property:
1574 * @agg: a #GstAggregator
1575 * @latency: the new latency value.
1577 * Sets the new latency value to @latency. This value is used to limit the
1578 * amount of time a pad waits for data to appear before considering the pad
1582 gst_aggregator_set_latency_property (GstAggregator * self, gint64 latency)
1586 g_return_if_fail (GST_IS_AGGREGATOR (self));
1588 GST_OBJECT_LOCK (self);
1590 if (self->priv->latency_live && self->priv->latency_max != 0 &&
1591 GST_CLOCK_TIME_IS_VALID (latency) && latency > self->priv->latency_max) {
1592 GST_ELEMENT_WARNING (self, CORE, NEGOTIATION,
1593 ("%s", "Latency too big"),
1594 ("The requested latency value is too big for the latency in the "
1595 "current pipeline. Limiting to %" G_GINT64_FORMAT,
1596 self->priv->latency_max));
1597 latency = self->priv->latency_max;
1600 changed = (self->priv->latency != latency);
1601 self->priv->latency = latency;
1602 GST_OBJECT_UNLOCK (self);
1605 gst_element_post_message (GST_ELEMENT_CAST (self),
1606 gst_message_new_latency (GST_OBJECT_CAST (self)));
1610 * gst_aggregator_get_latency_property:
1611 * @agg: a #GstAggregator
1613 * Gets the latency value. See gst_aggregator_set_latency for
1616 * Returns: The time in nanoseconds to wait for data to arrive on a sink pad
1617 * before a pad is deemed unresponsive. A value of -1 means an
1621 gst_aggregator_get_latency_property (GstAggregator * agg)
1625 g_return_val_if_fail (GST_IS_AGGREGATOR (agg), -1);
1627 GST_OBJECT_LOCK (agg);
1628 res = agg->priv->latency;
1629 GST_OBJECT_UNLOCK (agg);
1635 gst_aggregator_set_property (GObject * object, guint prop_id,
1636 const GValue * value, GParamSpec * pspec)
1638 GstAggregator *agg = GST_AGGREGATOR (object);
1642 gst_aggregator_set_latency_property (agg, g_value_get_int64 (value));
1645 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1651 gst_aggregator_get_property (GObject * object, guint prop_id,
1652 GValue * value, GParamSpec * pspec)
1654 GstAggregator *agg = GST_AGGREGATOR (object);
1658 g_value_set_int64 (value, gst_aggregator_get_latency_property (agg));
1661 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1666 /* GObject vmethods implementations */
1668 gst_aggregator_class_init (GstAggregatorClass * klass)
1670 GObjectClass *gobject_class = (GObjectClass *) klass;
1671 GstElementClass *gstelement_class = (GstElementClass *) klass;
1673 aggregator_parent_class = g_type_class_peek_parent (klass);
1674 g_type_class_add_private (klass, sizeof (GstAggregatorPrivate));
1676 GST_DEBUG_CATEGORY_INIT (aggregator_debug, "aggregator",
1677 GST_DEBUG_FG_MAGENTA, "GstAggregator");
1679 klass->sinkpads_type = GST_TYPE_AGGREGATOR_PAD;
1681 klass->sink_event = gst_aggregator_default_sink_event;
1682 klass->sink_query = gst_aggregator_default_sink_query;
1684 klass->src_event = gst_aggregator_default_src_event;
1685 klass->src_query = gst_aggregator_default_src_query;
1687 gstelement_class->request_new_pad =
1688 GST_DEBUG_FUNCPTR (gst_aggregator_request_new_pad);
1689 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_aggregator_send_event);
1690 gstelement_class->release_pad =
1691 GST_DEBUG_FUNCPTR (gst_aggregator_release_pad);
1692 gstelement_class->change_state =
1693 GST_DEBUG_FUNCPTR (gst_aggregator_change_state);
1695 gobject_class->set_property = gst_aggregator_set_property;
1696 gobject_class->get_property = gst_aggregator_get_property;
1697 gobject_class->finalize = gst_aggregator_finalize;
1699 g_object_class_install_property (gobject_class, PROP_LATENCY,
1700 g_param_spec_int64 ("latency", "Buffer latency",
1701 "Additional latency in live mode to allow upstream "
1702 "to take longer to produce buffers for the current "
1704 (G_MAXLONG == G_MAXINT64) ? G_MAXINT64 : (G_MAXLONG * GST_SECOND - 1),
1705 DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1707 GST_DEBUG_REGISTER_FUNCPTR (gst_aggregator_stop_pad);
1708 GST_DEBUG_REGISTER_FUNCPTR (gst_aggregator_query_sink_latency_foreach);
1712 gst_aggregator_init (GstAggregator * self, GstAggregatorClass * klass)
1714 GstPadTemplate *pad_template;
1715 GstAggregatorPrivate *priv;
1717 g_return_if_fail (klass->aggregate != NULL);
1720 G_TYPE_INSTANCE_GET_PRIVATE (self, GST_TYPE_AGGREGATOR,
1721 GstAggregatorPrivate);
1726 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "src");
1727 g_return_if_fail (pad_template != NULL);
1729 priv->padcount = -1;
1730 priv->tags_changed = FALSE;
1732 self->priv->latency_live = FALSE;
1733 self->priv->latency_min = self->priv->sub_latency_min = 0;
1734 self->priv->latency_max = self->priv->sub_latency_max = GST_CLOCK_TIME_NONE;
1735 gst_aggregator_reset_flow_values (self);
1737 self->srcpad = gst_pad_new_from_template (pad_template, "src");
1739 gst_pad_set_event_function (self->srcpad,
1740 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_event_func));
1741 gst_pad_set_query_function (self->srcpad,
1742 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_query_func));
1743 gst_pad_set_activatemode_function (self->srcpad,
1744 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_activate_mode_func));
1746 gst_element_add_pad (GST_ELEMENT (self), self->srcpad);
1748 self->priv->latency = DEFAULT_LATENCY;
1750 g_mutex_init (&self->priv->src_lock);
1751 g_cond_init (&self->priv->src_cond);
1754 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
1755 * method to get to the padtemplates */
1757 gst_aggregator_get_type (void)
1759 static volatile gsize type = 0;
1761 if (g_once_init_enter (&type)) {
1763 static const GTypeInfo info = {
1764 sizeof (GstAggregatorClass),
1767 (GClassInitFunc) gst_aggregator_class_init,
1770 sizeof (GstAggregator),
1772 (GInstanceInitFunc) gst_aggregator_init,
1775 _type = g_type_register_static (GST_TYPE_ELEMENT,
1776 "GstAggregator", &info, G_TYPE_FLAG_ABSTRACT);
1777 g_once_init_leave (&type, _type);
1782 static GstFlowReturn
1783 gst_aggregator_pad_chain (GstPad * pad, GstObject * object, GstBuffer * buffer)
1785 GstBuffer *actual_buf = buffer;
1786 GstAggregator *self = GST_AGGREGATOR (object);
1787 GstAggregatorPrivate *priv = self->priv;
1788 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1789 GstAggregatorClass *aggclass = GST_AGGREGATOR_GET_CLASS (object);
1790 GstFlowReturn flow_return;
1792 GST_DEBUG_OBJECT (aggpad, "Start chaining a buffer %" GST_PTR_FORMAT, buffer);
1794 PAD_STREAM_LOCK (aggpad);
1796 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1800 if (aggpad->priv->pending_eos == TRUE)
1803 while (aggpad->priv->buffer
1804 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1805 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1806 PAD_WAIT_EVENT (aggpad);
1808 PAD_UNLOCK (aggpad);
1810 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1813 if (aggclass->clip) {
1814 aggclass->clip (self, aggpad, buffer, &actual_buf);
1817 SRC_STREAM_LOCK (self);
1819 if (aggpad->priv->buffer)
1820 gst_buffer_unref (aggpad->priv->buffer);
1821 aggpad->priv->buffer = actual_buf;
1822 PAD_UNLOCK (aggpad);
1823 PAD_STREAM_UNLOCK (aggpad);
1825 SRC_STREAM_BROADCAST (self);
1826 SRC_STREAM_UNLOCK (self);
1828 GST_DEBUG_OBJECT (aggpad, "Done chaining");
1830 GST_OBJECT_LOCK (self);
1831 flow_return = priv->flow_return;
1832 GST_OBJECT_UNLOCK (self);
1837 PAD_STREAM_UNLOCK (aggpad);
1839 gst_buffer_unref (buffer);
1840 GST_DEBUG_OBJECT (aggpad, "We are flushing");
1842 return GST_FLOW_FLUSHING;
1845 PAD_UNLOCK (aggpad);
1846 PAD_STREAM_UNLOCK (aggpad);
1848 gst_buffer_unref (buffer);
1849 GST_DEBUG_OBJECT (pad, "We are EOS already...");
1851 return GST_FLOW_EOS;
1855 gst_aggregator_pad_query_func (GstPad * pad, GstObject * parent,
1858 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1859 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1861 if (GST_QUERY_IS_SERIALIZED (query)) {
1864 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE) {
1865 PAD_UNLOCK (aggpad);
1869 while (aggpad->priv->buffer
1870 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1871 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1872 PAD_WAIT_EVENT (aggpad);
1874 PAD_UNLOCK (aggpad);
1876 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1880 return klass->sink_query (GST_AGGREGATOR (parent),
1881 GST_AGGREGATOR_PAD (pad), query);
1884 GST_DEBUG_OBJECT (aggpad, "Pad is flushing, dropping query");
1889 gst_aggregator_pad_event_func (GstPad * pad, GstObject * parent,
1892 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1893 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1895 if (GST_EVENT_IS_SERIALIZED (event) && GST_EVENT_TYPE (event) != GST_EVENT_EOS
1896 && GST_EVENT_TYPE (event) != GST_EVENT_SEGMENT_DONE) {
1899 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE
1900 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP) {
1901 PAD_UNLOCK (aggpad);
1905 while (aggpad->priv->buffer
1906 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1907 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1908 PAD_WAIT_EVENT (aggpad);
1910 PAD_UNLOCK (aggpad);
1912 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE
1913 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP)
1917 return klass->sink_event (GST_AGGREGATOR (parent),
1918 GST_AGGREGATOR_PAD (pad), event);
1921 GST_DEBUG_OBJECT (aggpad, "Pad is flushing, dropping event");
1922 if (GST_EVENT_IS_STICKY (event))
1923 gst_pad_store_sticky_event (pad, event);
1924 gst_event_unref (event);
1929 gst_aggregator_pad_activate_mode_func (GstPad * pad,
1930 GstObject * parent, GstPadMode mode, gboolean active)
1932 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1934 if (active == FALSE) {
1936 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
1937 gst_buffer_replace (&aggpad->priv->buffer, NULL);
1938 PAD_BROADCAST_EVENT (aggpad);
1939 PAD_UNLOCK (aggpad);
1942 g_atomic_int_set (&aggpad->priv->flushing, FALSE);
1943 PAD_BROADCAST_EVENT (aggpad);
1944 PAD_UNLOCK (aggpad);
1950 /***********************************
1951 * GstAggregatorPad implementation *
1952 ************************************/
1953 G_DEFINE_TYPE (GstAggregatorPad, gst_aggregator_pad, GST_TYPE_PAD);
1956 gst_aggregator_pad_constructed (GObject * object)
1958 GstPad *pad = GST_PAD (object);
1960 gst_pad_set_chain_function (pad,
1961 GST_DEBUG_FUNCPTR (gst_aggregator_pad_chain));
1962 gst_pad_set_event_function (pad,
1963 GST_DEBUG_FUNCPTR (gst_aggregator_pad_event_func));
1964 gst_pad_set_query_function (pad,
1965 GST_DEBUG_FUNCPTR (gst_aggregator_pad_query_func));
1966 gst_pad_set_activatemode_function (pad,
1967 GST_DEBUG_FUNCPTR (gst_aggregator_pad_activate_mode_func));
1971 gst_aggregator_pad_finalize (GObject * object)
1973 GstAggregatorPad *pad = (GstAggregatorPad *) object;
1975 g_cond_clear (&pad->priv->event_cond);
1976 g_mutex_clear (&pad->priv->stream_lock);
1977 g_mutex_clear (&pad->priv->lock);
1979 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->finalize (object);
1983 gst_aggregator_pad_dispose (GObject * object)
1985 GstAggregatorPad *pad = (GstAggregatorPad *) object;
1988 buf = gst_aggregator_pad_steal_buffer (pad);
1990 gst_buffer_unref (buf);
1992 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->dispose (object);
1996 gst_aggregator_pad_class_init (GstAggregatorPadClass * klass)
1998 GObjectClass *gobject_class = (GObjectClass *) klass;
2000 g_type_class_add_private (klass, sizeof (GstAggregatorPadPrivate));
2002 gobject_class->constructed = gst_aggregator_pad_constructed;
2003 gobject_class->finalize = gst_aggregator_pad_finalize;
2004 gobject_class->dispose = gst_aggregator_pad_dispose;
2008 gst_aggregator_pad_init (GstAggregatorPad * pad)
2011 G_TYPE_INSTANCE_GET_PRIVATE (pad, GST_TYPE_AGGREGATOR_PAD,
2012 GstAggregatorPadPrivate);
2014 pad->priv->buffer = NULL;
2015 g_cond_init (&pad->priv->event_cond);
2017 g_mutex_init (&pad->priv->stream_lock);
2018 g_mutex_init (&pad->priv->lock);
2022 * gst_aggregator_pad_steal_buffer:
2023 * @pad: the pad to get buffer from
2025 * Steal the ref to the buffer currently queued in @pad.
2027 * Returns: (transfer full): The buffer in @pad or NULL if no buffer was
2028 * queued. You should unref the buffer after usage.
2031 gst_aggregator_pad_steal_buffer (GstAggregatorPad * pad)
2033 GstBuffer *buffer = NULL;
2036 if (pad->priv->buffer) {
2037 GST_TRACE_OBJECT (pad, "Consuming buffer");
2038 buffer = pad->priv->buffer;
2039 pad->priv->buffer = NULL;
2040 if (pad->priv->pending_eos) {
2041 pad->priv->pending_eos = FALSE;
2042 pad->priv->eos = TRUE;
2044 PAD_BROADCAST_EVENT (pad);
2045 GST_DEBUG_OBJECT (pad, "Consumed: %" GST_PTR_FORMAT, buffer);
2053 * gst_aggregator_pad_get_buffer:
2054 * @pad: the pad to get buffer from
2056 * Returns: (transfer full): A reference to the buffer in @pad or
2057 * NULL if no buffer was queued. You should unref the buffer after
2061 gst_aggregator_pad_get_buffer (GstAggregatorPad * pad)
2063 GstBuffer *buffer = NULL;
2066 if (pad->priv->buffer)
2067 buffer = gst_buffer_ref (pad->priv->buffer);
2074 gst_aggregator_pad_is_eos (GstAggregatorPad * pad)
2079 is_eos = pad->priv->eos;
2086 * gst_aggregator_merge_tags:
2087 * @self: a #GstAggregator
2088 * @tags: a #GstTagList to merge
2089 * @mode: the #GstTagMergeMode to use
2091 * Adds tags to so-called pending tags, which will be processed
2092 * before pushing out data downstream.
2094 * Note that this is provided for convenience, and the subclass is
2095 * not required to use this and can still do tag handling on its own.
2100 gst_aggregator_merge_tags (GstAggregator * self,
2101 const GstTagList * tags, GstTagMergeMode mode)
2105 g_return_if_fail (GST_IS_AGGREGATOR (self));
2106 g_return_if_fail (tags == NULL || GST_IS_TAG_LIST (tags));
2108 /* FIXME Check if we can use OBJECT lock here! */
2109 GST_OBJECT_LOCK (self);
2111 GST_DEBUG_OBJECT (self, "merging tags %" GST_PTR_FORMAT, tags);
2112 otags = self->priv->tags;
2113 self->priv->tags = gst_tag_list_merge (self->priv->tags, tags, mode);
2115 gst_tag_list_unref (otags);
2116 self->priv->tags_changed = TRUE;
2117 GST_OBJECT_UNLOCK (self);
2121 * gst_aggregator_set_latency:
2122 * @self: a #GstAggregator
2123 * @min_latency: minimum latency
2124 * @max_latency: maximum latency
2126 * Lets #GstAggregator sub-classes tell the baseclass what their internal
2127 * latency is. Will also post a LATENCY message on the bus so the pipeline
2128 * can reconfigure its global latency.
2131 gst_aggregator_set_latency (GstAggregator * self,
2132 GstClockTime min_latency, GstClockTime max_latency)
2134 g_return_if_fail (GST_IS_AGGREGATOR (self));
2135 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (min_latency));
2136 g_return_if_fail (max_latency >= min_latency);
2138 GST_OBJECT_LOCK (self);
2139 self->priv->sub_latency_min = min_latency;
2140 self->priv->sub_latency_max = max_latency;
2141 GST_OBJECT_UNLOCK (self);
2143 gst_element_post_message (GST_ELEMENT_CAST (self),
2144 gst_message_new_latency (GST_OBJECT_CAST (self)));