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_EVENT(pad) G_STMT_START { \
82 GST_TRACE_OBJECT (pad, "Taking EVENT lock from thread %p", \
84 g_mutex_lock(&pad->priv->event_lock); \
85 GST_TRACE_OBJECT (pad, "Took EVENT lock from thread %p", \
89 #define PAD_UNLOCK_EVENT(pad) G_STMT_START { \
90 GST_TRACE_OBJECT (pad, "Releasing EVENT lock from thread %p", \
92 g_mutex_unlock(&pad->priv->event_lock); \
93 GST_TRACE_OBJECT (pad, "Release EVENT 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 &(pad->priv->event_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)); \
113 #define GST_AGGREGATOR_SETCAPS_LOCK(self) G_STMT_START { \
114 GST_TRACE_OBJECT (self, "Taking SETCAPS lock from thread %p", \
116 g_mutex_lock(&self->priv->setcaps_lock); \
117 GST_TRACE_OBJECT (self, "Took SETCAPS lock from thread %p", \
121 #define GST_AGGREGATOR_SETCAPS_UNLOCK(self) G_STMT_START { \
122 GST_TRACE_OBJECT (self, "Releasing SETCAPS lock from thread %p", \
124 g_mutex_unlock(&self->priv->setcaps_lock); \
125 GST_TRACE_OBJECT (self, "Took SETCAPS lock from thread %p", \
129 #define PAD_STREAM_LOCK(pad) G_STMT_START { \
130 GST_TRACE_OBJECT (pad, "Taking lock from thread %p", \
132 g_mutex_lock(&pad->priv->stream_lock); \
133 GST_TRACE_OBJECT (pad, "Took lock from thread %p", \
137 #define PAD_STREAM_UNLOCK(pad) G_STMT_START { \
138 GST_TRACE_OBJECT (pad, "Releasing lock from thread %p", \
140 g_mutex_unlock(&pad->priv->stream_lock); \
141 GST_TRACE_OBJECT (pad, "Release lock from thread %p", \
145 #define SRC_STREAM_LOCK(self) G_STMT_START { \
146 GST_TRACE_OBJECT (self, "Taking src STREAM lock from thread %p", \
148 g_mutex_lock(&self->priv->src_lock); \
149 GST_TRACE_OBJECT (self, "Took src STREAM lock from thread %p", \
153 #define SRC_STREAM_UNLOCK(self) G_STMT_START { \
154 GST_TRACE_OBJECT (self, "Releasing src STREAM lock from thread %p", \
156 g_mutex_unlock(&self->priv->src_lock); \
157 GST_TRACE_OBJECT (self, "Released src STREAM lock from thread %p", \
161 #define SRC_STREAM_WAIT(self) G_STMT_START { \
162 GST_LOG_OBJECT (self, "Waiting for src STREAM on thread %p", \
164 g_cond_wait(&(self->priv->src_cond), &(self->priv->src_lock)); \
165 GST_LOG_OBJECT (self, "DONE Waiting for src STREAM on thread %p", \
169 #define SRC_STREAM_BROADCAST(self) G_STMT_START { \
170 GST_LOG_OBJECT (self, "Signaling src STREAM from thread %p", \
172 if (self->priv->aggregate_id) \
173 gst_clock_id_unschedule (self->priv->aggregate_id); \
174 g_cond_broadcast(&(self->priv->src_cond)); \
177 struct _GstAggregatorPadPrivate
179 gboolean pending_flush_start;
180 gboolean pending_flush_stop;
181 gboolean pending_eos;
191 gst_aggregator_pad_flush (GstAggregatorPad * aggpad, GstAggregator * agg)
193 GstAggregatorPadClass *klass = GST_AGGREGATOR_PAD_GET_CLASS (aggpad);
196 aggpad->priv->flushing = FALSE;
199 return klass->flush (aggpad, agg);
204 /*************************************
205 * GstAggregator implementation *
206 *************************************/
207 static GstElementClass *aggregator_parent_class = NULL;
209 struct _GstAggregatorPrivate
213 /* Our state is >= PAUSED */
214 gboolean running; /* protected by SRC_STREAM_LOCK */
218 gboolean send_stream_start;
219 gboolean send_segment;
220 gboolean flush_seeking;
221 gboolean pending_flush_start;
223 GstFlowReturn flow_return;
228 gboolean tags_changed;
230 /* Lock to prevent two src setcaps from happening at the same time */
233 gboolean latency_live;
234 GstClockTime latency_min;
235 GstClockTime latency_max;
237 GstClockTime sub_latency_min;
238 GstClockTime sub_latency_max;
241 GstClockID aggregate_id;
255 gboolean one_actually_seeked;
258 #define DEFAULT_LATENCY 0
268 * gst_aggregator_iterate_sinkpads:
269 * @self: The #GstAggregator
270 * @func: (scope call): The function to call.
271 * @user_data: (closure): The data to pass to @func.
273 * Iterate the sinkpads of aggregator to call a function on them.
275 * This method guarantees that @func will be called only once for each
279 gst_aggregator_iterate_sinkpads (GstAggregator * self,
280 GstAggregatorPadForeachFunc func, gpointer user_data)
282 gboolean result = FALSE;
284 gboolean done = FALSE;
285 GValue item = { 0, };
286 GList *seen_pads = NULL;
288 iter = gst_element_iterate_sink_pads (GST_ELEMENT (self));
294 switch (gst_iterator_next (iter, &item)) {
295 case GST_ITERATOR_OK:
297 GstAggregatorPad *pad;
299 pad = g_value_get_object (&item);
301 /* if already pushed, skip. FIXME, find something faster to tag pads */
302 if (pad == NULL || g_list_find (seen_pads, pad)) {
303 g_value_reset (&item);
307 GST_LOG_OBJECT (pad, "calling function %s on pad",
308 GST_DEBUG_FUNCPTR_NAME (func));
310 result = func (self, pad, user_data);
314 seen_pads = g_list_prepend (seen_pads, pad);
316 g_value_reset (&item);
319 case GST_ITERATOR_RESYNC:
320 gst_iterator_resync (iter);
322 case GST_ITERATOR_ERROR:
323 GST_ERROR_OBJECT (self,
324 "Could not iterate over internally linked pads");
327 case GST_ITERATOR_DONE:
332 g_value_unset (&item);
333 gst_iterator_free (iter);
335 if (seen_pads == NULL) {
336 GST_DEBUG_OBJECT (self, "No pad seen");
340 g_list_free (seen_pads);
347 gst_aggregator_check_pads_ready (GstAggregator * self)
349 GstAggregatorPad *pad;
352 GST_LOG_OBJECT (self, "checking pads");
354 GST_OBJECT_LOCK (self);
356 sinkpads = GST_ELEMENT_CAST (self)->sinkpads;
357 if (sinkpads == NULL)
360 for (l = sinkpads; l != NULL; l = l->next) {
363 if (pad->buffer == NULL && !pad->eos)
367 GST_OBJECT_UNLOCK (self);
368 GST_LOG_OBJECT (self, "pads are ready");
373 GST_LOG_OBJECT (self, "pads not ready: no sink pads");
374 GST_OBJECT_UNLOCK (self);
379 GST_LOG_OBJECT (pad, "pad not ready to be aggregated yet");
380 GST_OBJECT_UNLOCK (self);
386 gst_aggregator_reset_flow_values (GstAggregator * self)
388 self->priv->flow_return = GST_FLOW_FLUSHING;
389 self->priv->send_stream_start = TRUE;
390 self->priv->send_segment = TRUE;
391 gst_segment_init (&self->segment, GST_FORMAT_TIME);
395 gst_aggregator_push_mandatory_events (GstAggregator * self)
397 GstAggregatorPrivate *priv = self->priv;
399 if (self->priv->send_stream_start) {
402 GST_INFO_OBJECT (self, "pushing stream start");
403 /* stream-start (FIXME: create id based on input ids) */
404 g_snprintf (s_id, sizeof (s_id), "agg-%08x", g_random_int ());
405 if (!gst_pad_push_event (self->srcpad, gst_event_new_stream_start (s_id))) {
406 GST_WARNING_OBJECT (self->srcpad, "Sending stream start event failed");
408 self->priv->send_stream_start = FALSE;
411 if (self->priv->srccaps) {
413 GST_INFO_OBJECT (self, "pushing caps: %" GST_PTR_FORMAT,
414 self->priv->srccaps);
415 if (!gst_pad_push_event (self->srcpad,
416 gst_event_new_caps (self->priv->srccaps))) {
417 GST_WARNING_OBJECT (self->srcpad, "Sending caps event failed");
419 gst_caps_unref (self->priv->srccaps);
420 self->priv->srccaps = NULL;
423 if (g_atomic_int_get (&self->priv->send_segment)) {
424 if (!g_atomic_int_get (&self->priv->flush_seeking)) {
425 GstEvent *segev = gst_event_new_segment (&self->segment);
427 if (!self->priv->seqnum)
428 self->priv->seqnum = gst_event_get_seqnum (segev);
430 gst_event_set_seqnum (segev, self->priv->seqnum);
432 GST_DEBUG_OBJECT (self, "pushing segment %" GST_PTR_FORMAT, segev);
433 gst_pad_push_event (self->srcpad, segev);
434 g_atomic_int_set (&self->priv->send_segment, FALSE);
438 if (priv->tags && priv->tags_changed) {
439 gst_pad_push_event (self->srcpad,
440 gst_event_new_tag (gst_tag_list_ref (priv->tags)));
441 priv->tags_changed = FALSE;
446 * gst_aggregator_set_src_caps:
447 * @self: The #GstAggregator
448 * @caps: The #GstCaps to set on the src pad.
450 * Sets the caps to be used on the src pad.
453 gst_aggregator_set_src_caps (GstAggregator * self, GstCaps * caps)
455 GST_AGGREGATOR_SETCAPS_LOCK (self);
456 gst_caps_replace (&self->priv->srccaps, caps);
457 gst_aggregator_push_mandatory_events (self);
458 GST_AGGREGATOR_SETCAPS_UNLOCK (self);
462 * gst_aggregator_finish_buffer:
463 * @self: The #GstAggregator
464 * @buffer: (transfer full): the #GstBuffer to push.
466 * This method will push the provided output buffer downstream. If needed,
467 * mandatory events such as stream-start, caps, and segment events will be
468 * sent before pushing the buffer.
471 gst_aggregator_finish_buffer (GstAggregator * self, GstBuffer * buffer)
473 gst_aggregator_push_mandatory_events (self);
475 if (!g_atomic_int_get (&self->priv->flush_seeking) &&
476 gst_pad_is_active (self->srcpad)) {
477 GST_TRACE_OBJECT (self, "pushing buffer %" GST_PTR_FORMAT, buffer);
478 return gst_pad_push (self->srcpad, buffer);
480 GST_INFO_OBJECT (self, "Not pushing (active: %i, flushing: %i)",
481 g_atomic_int_get (&self->priv->flush_seeking),
482 gst_pad_is_active (self->srcpad));
483 gst_buffer_unref (buffer);
489 gst_aggregator_push_eos (GstAggregator * self)
492 gst_aggregator_push_mandatory_events (self);
494 self->priv->send_eos = FALSE;
495 event = gst_event_new_eos ();
496 gst_event_set_seqnum (event, self->priv->seqnum);
497 gst_pad_push_event (self->srcpad, event);
501 gst_aggregator_get_next_time (GstAggregator * self)
503 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
505 if (klass->get_next_time)
506 return klass->get_next_time (self);
508 return GST_CLOCK_TIME_NONE;
511 /* called with the src STREAM lock */
513 gst_aggregator_wait_and_check (GstAggregator * self, gboolean * timeout)
515 GstClockTime latency_max, latency_min;
521 SRC_STREAM_LOCK (self);
523 gst_aggregator_get_latency (self, &live, &latency_min, &latency_max);
525 if (gst_aggregator_check_pads_ready (self)) {
526 GST_DEBUG_OBJECT (self, "all pads have data");
527 SRC_STREAM_UNLOCK (self);
532 /* Before waiting, check if we're actually still running */
533 if (!self->priv->running || !self->priv->send_eos) {
534 SRC_STREAM_UNLOCK (self);
539 start = gst_aggregator_get_next_time (self);
541 if (!live || !GST_IS_CLOCK (GST_ELEMENT_CLOCK (self))
542 || !GST_CLOCK_TIME_IS_VALID (start)) {
543 /* We wake up here when something happened, and below
544 * then check if we're ready now. If we return FALSE,
545 * we will be directly called again.
547 SRC_STREAM_WAIT (self);
549 GstClockTime base_time, time;
551 GstClockReturn status;
552 GstClockTimeDiff jitter;
554 GST_DEBUG_OBJECT (self, "got subclass start time: %" GST_TIME_FORMAT,
555 GST_TIME_ARGS (start));
557 GST_OBJECT_LOCK (self);
558 base_time = GST_ELEMENT_CAST (self)->base_time;
559 clock = GST_ELEMENT_CLOCK (self);
561 gst_object_ref (clock);
562 GST_OBJECT_UNLOCK (self);
564 time = base_time + start;
566 if (GST_CLOCK_TIME_IS_VALID (latency_min)) {
569 time += self->priv->latency;
572 GST_DEBUG_OBJECT (self, "possibly waiting for clock to reach %"
573 GST_TIME_FORMAT " (base %" GST_TIME_FORMAT " start %" GST_TIME_FORMAT
574 " latency max %" GST_TIME_FORMAT " latency min %" GST_TIME_FORMAT
575 " current %" GST_TIME_FORMAT ")", GST_TIME_ARGS (time),
576 GST_TIME_ARGS (GST_ELEMENT_CAST (self)->base_time),
577 GST_TIME_ARGS (start), GST_TIME_ARGS (latency_max),
578 GST_TIME_ARGS (latency_min),
579 GST_TIME_ARGS (gst_clock_get_time (clock)));
581 self->priv->aggregate_id = gst_clock_new_single_shot_id (clock, time);
582 gst_object_unref (clock);
583 SRC_STREAM_UNLOCK (self);
586 status = gst_clock_id_wait (self->priv->aggregate_id, &jitter);
588 SRC_STREAM_LOCK (self);
589 if (self->priv->aggregate_id) {
590 gst_clock_id_unref (self->priv->aggregate_id);
591 self->priv->aggregate_id = NULL;
594 GST_DEBUG_OBJECT (self,
595 "clock returned %d (jitter: %s%" GST_TIME_FORMAT ")",
596 status, (jitter < 0 ? "-" : " "),
597 GST_TIME_ARGS ((jitter < 0 ? -jitter : jitter)));
600 if (status == GST_CLOCK_OK || status == GST_CLOCK_EARLY) {
601 SRC_STREAM_UNLOCK (self);
607 res = gst_aggregator_check_pads_ready (self);
608 SRC_STREAM_UNLOCK (self);
614 gst_aggregator_aggregate_func (GstAggregator * self)
616 GstAggregatorPrivate *priv = self->priv;
617 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
618 gboolean timeout = FALSE;
620 if (self->priv->running == FALSE) {
621 GST_DEBUG_OBJECT (self, "Not running anymore");
625 GST_LOG_OBJECT (self, "Checking aggregate");
626 while (priv->send_eos && priv->running) {
627 if (!gst_aggregator_wait_and_check (self, &timeout))
630 GST_TRACE_OBJECT (self, "Actually aggregating!");
632 priv->flow_return = klass->aggregate (self, timeout);
634 if (priv->flow_return == GST_FLOW_EOS) {
635 gst_aggregator_push_eos (self);
638 if (priv->flow_return == GST_FLOW_FLUSHING &&
639 g_atomic_int_get (&priv->flush_seeking))
640 priv->flow_return = GST_FLOW_OK;
642 GST_LOG_OBJECT (self, "flow return is %s",
643 gst_flow_get_name (priv->flow_return));
645 if (priv->flow_return != GST_FLOW_OK)
651 gst_aggregator_start (GstAggregator * self)
653 GstAggregatorClass *klass;
656 self->priv->running = TRUE;
657 self->priv->send_stream_start = TRUE;
658 self->priv->send_segment = TRUE;
659 self->priv->send_eos = TRUE;
660 self->priv->srccaps = NULL;
661 self->priv->flow_return = GST_FLOW_OK;
663 klass = GST_AGGREGATOR_GET_CLASS (self);
666 result = klass->start (self);
674 _check_pending_flush_stop (GstAggregatorPad * pad)
676 return (!pad->priv->pending_flush_stop && !pad->priv->pending_flush_start);
680 gst_aggregator_stop_srcpad_task (GstAggregator * self, GstEvent * flush_start)
684 GST_INFO_OBJECT (self, "%s srcpad task",
685 flush_start ? "Pausing" : "Stopping");
687 SRC_STREAM_LOCK (self);
688 self->priv->running = FALSE;
689 SRC_STREAM_BROADCAST (self);
690 SRC_STREAM_UNLOCK (self);
693 res = gst_pad_push_event (self->srcpad, flush_start);
696 gst_pad_stop_task (self->srcpad);
702 gst_aggregator_start_srcpad_task (GstAggregator * self)
704 GST_INFO_OBJECT (self, "Starting srcpad task");
706 self->priv->running = TRUE;
707 gst_pad_start_task (GST_PAD (self->srcpad),
708 (GstTaskFunction) gst_aggregator_aggregate_func, self, NULL);
712 gst_aggregator_flush (GstAggregator * self)
714 GstFlowReturn ret = GST_FLOW_OK;
715 GstAggregatorPrivate *priv = self->priv;
716 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
718 GST_DEBUG_OBJECT (self, "Flushing everything");
719 g_atomic_int_set (&priv->send_segment, TRUE);
720 g_atomic_int_set (&priv->flush_seeking, FALSE);
721 g_atomic_int_set (&priv->tags_changed, FALSE);
723 ret = klass->flush (self);
729 gst_aggregator_all_flush_stop_received (GstAggregator * self)
732 GstAggregatorPad *tmppad;
734 GST_OBJECT_LOCK (self);
735 for (tmp = GST_ELEMENT (self)->sinkpads; tmp; tmp = tmp->next) {
736 tmppad = (GstAggregatorPad *) tmp->data;
738 if (_check_pending_flush_stop (tmppad) == FALSE) {
739 GST_DEBUG_OBJECT (tmppad, "Is not last %i -- %i",
740 tmppad->priv->pending_flush_start, tmppad->priv->pending_flush_stop);
741 GST_OBJECT_UNLOCK (self);
745 GST_OBJECT_UNLOCK (self);
751 gst_aggregator_flush_start (GstAggregator * self, GstAggregatorPad * aggpad,
755 GstAggregatorPrivate *priv = self->priv;
756 GstAggregatorPadPrivate *padpriv = aggpad->priv;
758 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
759 /* Remove pad buffer and wake up the streaming thread */
760 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
761 gst_buffer_replace (&tmpbuf, NULL);
762 PAD_STREAM_LOCK (aggpad);
763 if (g_atomic_int_compare_and_exchange (&padpriv->pending_flush_start,
764 TRUE, FALSE) == TRUE) {
765 GST_DEBUG_OBJECT (aggpad, "Expecting FLUSH_STOP now");
766 g_atomic_int_set (&padpriv->pending_flush_stop, TRUE);
769 if (g_atomic_int_get (&priv->flush_seeking)) {
770 /* If flush_seeking we forward the first FLUSH_START */
771 if (g_atomic_int_compare_and_exchange (&priv->pending_flush_start,
772 TRUE, FALSE) == TRUE) {
774 GST_INFO_OBJECT (self, "Flushing, pausing srcpad task");
775 gst_aggregator_stop_srcpad_task (self, event);
776 priv->flow_return = GST_FLOW_OK;
778 GST_INFO_OBJECT (self, "Getting STREAM_LOCK while seeking");
779 GST_PAD_STREAM_LOCK (self->srcpad);
780 GST_LOG_OBJECT (self, "GOT STREAM_LOCK");
783 gst_event_unref (event);
786 gst_event_unref (event);
788 PAD_STREAM_UNLOCK (aggpad);
790 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
791 gst_buffer_replace (&tmpbuf, NULL);
794 /* GstAggregator vmethods default implementations */
796 gst_aggregator_default_sink_event (GstAggregator * self,
797 GstAggregatorPad * aggpad, GstEvent * event)
800 GstPad *pad = GST_PAD (aggpad);
801 GstAggregatorPrivate *priv = self->priv;
803 switch (GST_EVENT_TYPE (event)) {
804 case GST_EVENT_FLUSH_START:
806 gst_aggregator_flush_start (self, aggpad, event);
807 /* We forward only in one case: right after flush_seeking */
811 case GST_EVENT_FLUSH_STOP:
813 GST_DEBUG_OBJECT (aggpad, "Got FLUSH_STOP");
815 gst_aggregator_pad_flush (aggpad, self);
816 if (g_atomic_int_get (&priv->flush_seeking)) {
817 g_atomic_int_set (&aggpad->priv->pending_flush_stop, FALSE);
819 if (g_atomic_int_get (&priv->flush_seeking)) {
820 if (gst_aggregator_all_flush_stop_received (self)) {
821 /* That means we received FLUSH_STOP/FLUSH_STOP on
822 * all sinkpads -- Seeking is Done... sending FLUSH_STOP */
823 gst_aggregator_flush (self);
824 gst_pad_push_event (self->srcpad, event);
826 SRC_STREAM_LOCK (self);
827 priv->send_eos = TRUE;
828 SRC_STREAM_BROADCAST (self);
829 SRC_STREAM_UNLOCK (self);
831 GST_INFO_OBJECT (self, "Releasing source pad STREAM_LOCK");
832 GST_PAD_STREAM_UNLOCK (self->srcpad);
833 gst_aggregator_start_srcpad_task (self);
838 /* We never forward the event */
843 GST_DEBUG_OBJECT (aggpad, "EOS");
845 /* We still have a buffer, and we don't want the subclass to have to
846 * check for it. Mark pending_eos, eos will be set when steal_buffer is
849 SRC_STREAM_LOCK (self);
850 PAD_LOCK_EVENT (aggpad);
851 if (!aggpad->buffer) {
854 aggpad->priv->pending_eos = TRUE;
856 PAD_UNLOCK_EVENT (aggpad);
858 SRC_STREAM_BROADCAST (self);
859 SRC_STREAM_UNLOCK (self);
862 case GST_EVENT_SEGMENT:
864 PAD_LOCK_EVENT (aggpad);
865 gst_event_copy_segment (event, &aggpad->segment);
866 self->priv->seqnum = gst_event_get_seqnum (event);
867 PAD_UNLOCK_EVENT (aggpad);
870 case GST_EVENT_STREAM_START:
878 gst_event_parse_tag (event, &tags);
880 if (gst_tag_list_get_scope (tags) == GST_TAG_SCOPE_STREAM) {
881 gst_aggregator_merge_tags (self, tags, GST_TAG_MERGE_REPLACE);
882 gst_event_unref (event);
894 GST_DEBUG_OBJECT (pad, "Forwarding event: %" GST_PTR_FORMAT, event);
895 return gst_pad_event_default (pad, GST_OBJECT (self), event);
898 GST_DEBUG_OBJECT (pad, "Eating event: %" GST_PTR_FORMAT, event);
900 gst_event_unref (event);
905 static inline gboolean
906 gst_aggregator_stop_pad (GstAggregator * self, GstAggregatorPad * pad,
907 gpointer unused_udata)
909 gst_aggregator_pad_flush (pad, self);
915 gst_aggregator_stop (GstAggregator * agg)
917 GstAggregatorClass *klass;
920 gst_aggregator_reset_flow_values (agg);
922 gst_aggregator_iterate_sinkpads (agg, gst_aggregator_stop_pad, NULL);
925 gst_tag_list_unref (agg->priv->tags);
926 agg->priv->tags = NULL;
928 klass = GST_AGGREGATOR_GET_CLASS (agg);
931 result = klass->stop (agg);
938 /* GstElement vmethods implementations */
939 static GstStateChangeReturn
940 gst_aggregator_change_state (GstElement * element, GstStateChange transition)
942 GstStateChangeReturn ret;
943 GstAggregator *self = GST_AGGREGATOR (element);
945 switch (transition) {
946 case GST_STATE_CHANGE_READY_TO_PAUSED:
947 if (!gst_aggregator_start (self))
955 GST_ELEMENT_CLASS (aggregator_parent_class)->change_state (element,
956 transition)) == GST_STATE_CHANGE_FAILURE)
960 switch (transition) {
961 case GST_STATE_CHANGE_PAUSED_TO_READY:
962 if (!gst_aggregator_stop (self)) {
963 /* What to do in this case? Error out? */
964 GST_ERROR_OBJECT (self, "Subclass failed to stop.");
976 GST_ERROR_OBJECT (element, "parent failed state change");
981 GST_ERROR_OBJECT (element, "Subclass failed to start");
982 return GST_STATE_CHANGE_FAILURE;
987 gst_aggregator_release_pad (GstElement * element, GstPad * pad)
989 GstAggregator *self = GST_AGGREGATOR (element);
992 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
994 GST_INFO_OBJECT (pad, "Removing pad");
996 SRC_STREAM_LOCK (self);
997 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
998 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
999 gst_buffer_replace (&tmpbuf, NULL);
1000 gst_element_remove_pad (element, pad);
1002 SRC_STREAM_BROADCAST (self);
1003 SRC_STREAM_UNLOCK (self);
1007 gst_aggregator_request_new_pad (GstElement * element,
1008 GstPadTemplate * templ, const gchar * req_name, const GstCaps * caps)
1010 GstAggregator *self;
1011 GstAggregatorPad *agg_pad;
1013 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
1014 GstAggregatorPrivate *priv = GST_AGGREGATOR (element)->priv;
1016 self = GST_AGGREGATOR (element);
1018 if (templ == gst_element_class_get_pad_template (klass, "sink_%u")) {
1022 GST_OBJECT_LOCK (element);
1023 if (req_name == NULL || strlen (req_name) < 6
1024 || !g_str_has_prefix (req_name, "sink_")) {
1025 /* no name given when requesting the pad, use next available int */
1028 /* parse serial number from requested padname */
1029 serial = g_ascii_strtoull (&req_name[5], NULL, 10);
1030 if (serial >= priv->padcount)
1031 priv->padcount = serial;
1034 name = g_strdup_printf ("sink_%u", priv->padcount);
1035 agg_pad = g_object_new (GST_AGGREGATOR_GET_CLASS (self)->sinkpads_type,
1036 "name", name, "direction", GST_PAD_SINK, "template", templ, NULL);
1039 GST_OBJECT_UNLOCK (element);
1045 GST_DEBUG_OBJECT (element, "Adding pad %s", GST_PAD_NAME (agg_pad));
1048 gst_pad_set_active (GST_PAD (agg_pad), TRUE);
1050 /* add the pad to the element */
1051 gst_element_add_pad (element, GST_PAD (agg_pad));
1053 return GST_PAD (agg_pad);
1058 GstClockTime min, max;
1063 gst_aggregator_query_sink_latency_foreach (GstAggregator * self,
1064 GstAggregatorPad * pad, gpointer user_data)
1066 LatencyData *data = user_data;
1067 GstClockTime min, max;
1071 query = gst_query_new_latency ();
1072 res = gst_pad_peer_query (GST_PAD_CAST (pad), query);
1075 gst_query_parse_latency (query, &live, &min, &max);
1077 GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
1078 " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
1080 if (min != GST_CLOCK_TIME_NONE && min > data->min)
1083 if (max != GST_CLOCK_TIME_NONE &&
1084 ((data->max != GST_CLOCK_TIME_NONE && max < data->max) ||
1085 (data->max == GST_CLOCK_TIME_NONE)))
1091 gst_query_unref (query);
1097 * gst_aggregator_get_latency:
1098 * @self: a #GstAggregator
1099 * @live: (out) (allow-none): whether @self is live
1100 * @min_latency: (out) (allow-none): the configured minimum latency of @self
1101 * @max_latency: (out) (allow-none): the configured maximum latency of @self
1103 * Retreives the latency values reported by @self in response to the latency
1106 * Typically only called by subclasses.
1109 gst_aggregator_get_latency (GstAggregator * self, gboolean * live,
1110 GstClockTime * min_latency, GstClockTime * max_latency)
1112 GstClockTime our_latency;
1113 GstClockTime min, max;
1115 g_return_if_fail (GST_IS_AGGREGATOR (self));
1117 /* latency_min is never GST_CLOCK_TIME_NONE by construction */
1118 min = self->priv->latency_min;
1119 max = self->priv->latency_max;
1121 min += self->priv->sub_latency_min;
1122 if (GST_CLOCK_TIME_IS_VALID (max)
1123 && GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max))
1124 max += self->priv->sub_latency_max;
1126 our_latency = self->priv->latency;
1127 if (GST_CLOCK_TIME_IS_VALID (our_latency)) {
1129 if (GST_CLOCK_TIME_IS_VALID (max))
1134 *live = self->priv->latency_live;
1142 gst_aggregator_query_latency (GstAggregator * self, GstQuery * query)
1144 GstClockTime our_latency;
1148 data.max = GST_CLOCK_TIME_NONE;
1151 /* query upstream's latency */
1152 SRC_STREAM_LOCK (self);
1153 gst_aggregator_iterate_sinkpads (self,
1154 gst_aggregator_query_sink_latency_foreach, &data);
1155 SRC_STREAM_UNLOCK (self);
1157 our_latency = self->priv->latency;
1159 if (data.live && GST_CLOCK_TIME_IS_VALID (our_latency) &&
1160 our_latency > data.max) {
1161 GST_ELEMENT_WARNING (self, CORE, NEGOTIATION,
1162 ("%s", "Latency too big"),
1163 ("The requested latency value is too big for the current pipeline. "
1164 "Limiting to %" G_GINT64_FORMAT, data.max));
1165 self->priv->latency = data.max;
1166 /* FIXME: shouldn't we g_object_notify() the change here? */
1169 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (data.min))) {
1170 GST_WARNING_OBJECT (self, "Invalid minimum latency, using 0");
1174 if (G_UNLIKELY (data.min > data.max)) {
1175 GST_WARNING_OBJECT (self, "Minimum latency is greater than maximum latency "
1176 "(%" G_GINT64_FORMAT " > %" G_GINT64_FORMAT "). "
1177 "Clamping it at the maximum latency", data.min, data.max);
1178 data.min = data.max;
1181 self->priv->latency_live = data.live;
1182 self->priv->latency_min = data.min;
1183 self->priv->latency_max = data.max;
1186 if (GST_CLOCK_TIME_IS_VALID (our_latency)) {
1187 if (GST_CLOCK_TIME_IS_VALID (data.min))
1188 data.min += our_latency;
1189 if (GST_CLOCK_TIME_IS_VALID (data.max))
1190 data.max += our_latency;
1193 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_min)
1194 && GST_CLOCK_TIME_IS_VALID (data.min))
1195 data.min += self->priv->sub_latency_min;
1196 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max)
1197 && GST_CLOCK_TIME_IS_VALID (data.max))
1198 data.max += self->priv->sub_latency_max;
1200 GST_DEBUG_OBJECT (self, "configured latency live:%s min:%" G_GINT64_FORMAT
1201 " max:%" G_GINT64_FORMAT, data.live ? "true" : "false", data.min,
1204 gst_query_set_latency (query, data.live, data.min, data.max);
1210 gst_aggregator_send_event (GstElement * element, GstEvent * event)
1212 GstAggregator *self = GST_AGGREGATOR (element);
1214 GST_STATE_LOCK (element);
1215 if (GST_EVENT_TYPE (event) == GST_EVENT_SEEK &&
1216 GST_STATE (element) < GST_STATE_PAUSED) {
1220 GstSeekType start_type, stop_type;
1223 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1224 &start, &stop_type, &stop);
1225 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
1226 stop_type, stop, NULL);
1228 self->priv->seqnum = gst_event_get_seqnum (event);
1229 GST_DEBUG_OBJECT (element, "Storing segment %" GST_PTR_FORMAT, event);
1231 GST_STATE_UNLOCK (element);
1234 return GST_ELEMENT_CLASS (aggregator_parent_class)->send_event (element,
1239 gst_aggregator_default_src_query (GstAggregator * self, GstQuery * query)
1241 gboolean res = TRUE;
1243 switch (GST_QUERY_TYPE (query)) {
1244 case GST_QUERY_SEEKING:
1248 /* don't pass it along as some (file)sink might claim it does
1249 * whereas with a collectpads in between that will not likely work */
1250 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
1251 gst_query_set_seeking (query, format, FALSE, 0, -1);
1256 case GST_QUERY_LATENCY:
1260 ret = gst_aggregator_query_latency (self, query);
1261 /* Wake up the src thread again, due to changed latencies
1262 * or changed live-ness we might have to adjust if we wait
1263 * on a deadline at all and how long.
1264 * This is only to unschedule the clock id, we don't really care
1265 * about the GCond here.
1267 SRC_STREAM_LOCK (self);
1268 SRC_STREAM_BROADCAST (self);
1269 SRC_STREAM_UNLOCK (self);
1276 return gst_pad_query_default (self->srcpad, GST_OBJECT (self), query);
1283 gst_aggregator_event_forward_func (GstPad * pad, gpointer user_data)
1285 EventData *evdata = user_data;
1286 gboolean ret = TRUE;
1287 GstPad *peer = gst_pad_get_peer (pad);
1288 GstAggregatorPadPrivate *padpriv = GST_AGGREGATOR_PAD (pad)->priv;
1291 ret = gst_pad_send_event (peer, gst_event_ref (evdata->event));
1292 GST_DEBUG_OBJECT (pad, "return of event push is %d", ret);
1293 gst_object_unref (peer);
1297 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK)
1298 GST_ERROR_OBJECT (pad, "Event %" GST_PTR_FORMAT " failed", evdata->event);
1300 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK) {
1301 GstQuery *seeking = gst_query_new_seeking (GST_FORMAT_TIME);
1303 if (gst_pad_query (peer, seeking)) {
1306 gst_query_parse_seeking (seeking, NULL, &seekable, NULL, NULL);
1308 if (seekable == FALSE) {
1309 GST_INFO_OBJECT (pad,
1310 "Source not seekable, We failed but it does not matter!");
1315 GST_ERROR_OBJECT (pad, "Query seeking FAILED");
1318 gst_query_unref (seeking);
1321 if (evdata->flush) {
1322 padpriv->pending_flush_start = FALSE;
1323 padpriv->pending_flush_stop = FALSE;
1326 evdata->one_actually_seeked = TRUE;
1329 evdata->result &= ret;
1331 /* Always send to all pads */
1336 gst_aggregator_forward_event_to_all_sinkpads (GstAggregator * self,
1337 GstEvent * event, gboolean flush)
1341 evdata.event = event;
1342 evdata.result = TRUE;
1343 evdata.flush = flush;
1344 evdata.one_actually_seeked = FALSE;
1346 /* We first need to set all pads as flushing in a first pass
1347 * as flush_start flush_stop is sometimes sent synchronously
1348 * while we send the seek event */
1352 GST_OBJECT_LOCK (self);
1353 for (l = GST_ELEMENT_CAST (self)->sinkpads; l != NULL; l = l->next) {
1354 GstAggregatorPad *pad = l->data;
1356 pad->priv->pending_flush_start = TRUE;
1357 pad->priv->pending_flush_stop = FALSE;
1359 GST_OBJECT_UNLOCK (self);
1362 gst_pad_forward (self->srcpad, gst_aggregator_event_forward_func, &evdata);
1364 gst_event_unref (event);
1370 gst_aggregator_do_seek (GstAggregator * self, GstEvent * event)
1375 GstSeekType start_type, stop_type;
1379 GstAggregatorPrivate *priv = self->priv;
1381 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1382 &start, &stop_type, &stop);
1384 GST_INFO_OBJECT (self, "starting SEEK");
1386 flush = flags & GST_SEEK_FLAG_FLUSH;
1389 g_atomic_int_set (&priv->pending_flush_start, TRUE);
1390 g_atomic_int_set (&priv->flush_seeking, TRUE);
1393 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
1394 stop_type, stop, NULL);
1396 /* forward the seek upstream */
1397 evdata = gst_aggregator_forward_event_to_all_sinkpads (self, event, flush);
1400 if (!evdata.result || !evdata.one_actually_seeked) {
1401 g_atomic_int_set (&priv->flush_seeking, FALSE);
1402 g_atomic_int_set (&priv->pending_flush_start, FALSE);
1405 GST_INFO_OBJECT (self, "seek done, result: %d", evdata.result);
1407 return evdata.result;
1411 gst_aggregator_default_src_event (GstAggregator * self, GstEvent * event)
1414 gboolean res = TRUE;
1416 switch (GST_EVENT_TYPE (event)) {
1417 case GST_EVENT_SEEK:
1419 gst_event_ref (event);
1420 res = gst_aggregator_do_seek (self, event);
1421 gst_event_unref (event);
1425 case GST_EVENT_NAVIGATION:
1427 /* navigation is rather pointless. */
1429 gst_event_unref (event);
1438 evdata = gst_aggregator_forward_event_to_all_sinkpads (self, event, FALSE);
1439 res = evdata.result;
1446 gst_aggregator_src_pad_event_func (GstPad * pad, GstObject * parent,
1449 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1451 return klass->src_event (GST_AGGREGATOR (parent), event);
1455 gst_aggregator_src_pad_query_func (GstPad * pad, GstObject * parent,
1458 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1460 return klass->src_query (GST_AGGREGATOR (parent), query);
1464 gst_aggregator_src_pad_activate_mode_func (GstPad * pad,
1465 GstObject * parent, GstPadMode mode, gboolean active)
1467 GstAggregator *self = GST_AGGREGATOR (parent);
1468 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1470 if (klass->src_activate) {
1471 if (klass->src_activate (self, mode, active) == FALSE) {
1476 if (active == TRUE) {
1478 case GST_PAD_MODE_PUSH:
1480 GST_INFO_OBJECT (pad, "Activating pad!");
1481 gst_aggregator_start_srcpad_task (self);
1486 GST_ERROR_OBJECT (pad, "Only supported mode is PUSH");
1493 GST_INFO_OBJECT (self, "Deactivating srcpad");
1494 gst_aggregator_stop_srcpad_task (self, FALSE);
1500 gst_aggregator_default_sink_query (GstAggregator * self,
1501 GstAggregatorPad * aggpad, GstQuery * query)
1503 GstPad *pad = GST_PAD (aggpad);
1505 return gst_pad_query_default (pad, GST_OBJECT (self), query);
1509 gst_aggregator_finalize (GObject * object)
1511 GstAggregator *self = (GstAggregator *) object;
1513 g_mutex_clear (&self->priv->setcaps_lock);
1514 g_mutex_clear (&self->priv->src_lock);
1515 g_cond_clear (&self->priv->src_cond);
1517 G_OBJECT_CLASS (aggregator_parent_class)->finalize (object);
1521 * gst_aggregator_set_latency_property:
1522 * @agg: a #GstAggregator
1523 * @latency: the new latency value.
1525 * Sets the new latency value to @latency. This value is used to limit the
1526 * amount of time a pad waits for data to appear before considering the pad
1530 gst_aggregator_set_latency_property (GstAggregator * self, gint64 latency)
1534 g_return_if_fail (GST_IS_AGGREGATOR (self));
1536 GST_OBJECT_LOCK (self);
1538 if (self->priv->latency_live && self->priv->latency_max != 0 &&
1539 GST_CLOCK_TIME_IS_VALID (latency) && latency > self->priv->latency_max) {
1540 GST_ELEMENT_WARNING (self, CORE, NEGOTIATION,
1541 ("%s", "Latency too big"),
1542 ("The requested latency value is too big for the latency in the "
1543 "current pipeline. Limiting to %" G_GINT64_FORMAT,
1544 self->priv->latency_max));
1545 latency = self->priv->latency_max;
1548 changed = (self->priv->latency != latency);
1549 self->priv->latency = latency;
1550 GST_OBJECT_UNLOCK (self);
1553 gst_element_post_message (GST_ELEMENT_CAST (self),
1554 gst_message_new_latency (GST_OBJECT_CAST (self)));
1558 * gst_aggregator_get_latency_property:
1559 * @agg: a #GstAggregator
1561 * Gets the latency value. See gst_aggregator_set_latency for
1564 * Returns: The time in nanoseconds to wait for data to arrive on a sink pad
1565 * before a pad is deemed unresponsive. A value of -1 means an
1569 gst_aggregator_get_latency_property (GstAggregator * agg)
1573 g_return_val_if_fail (GST_IS_AGGREGATOR (agg), -1);
1575 GST_OBJECT_LOCK (agg);
1576 res = agg->priv->latency;
1577 GST_OBJECT_UNLOCK (agg);
1583 gst_aggregator_set_property (GObject * object, guint prop_id,
1584 const GValue * value, GParamSpec * pspec)
1586 GstAggregator *agg = GST_AGGREGATOR (object);
1590 gst_aggregator_set_latency_property (agg, g_value_get_int64 (value));
1593 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1599 gst_aggregator_get_property (GObject * object, guint prop_id,
1600 GValue * value, GParamSpec * pspec)
1602 GstAggregator *agg = GST_AGGREGATOR (object);
1606 g_value_set_int64 (value, gst_aggregator_get_latency_property (agg));
1609 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1614 /* GObject vmethods implementations */
1616 gst_aggregator_class_init (GstAggregatorClass * klass)
1618 GObjectClass *gobject_class = (GObjectClass *) klass;
1619 GstElementClass *gstelement_class = (GstElementClass *) klass;
1621 aggregator_parent_class = g_type_class_peek_parent (klass);
1622 g_type_class_add_private (klass, sizeof (GstAggregatorPrivate));
1624 GST_DEBUG_CATEGORY_INIT (aggregator_debug, "aggregator",
1625 GST_DEBUG_FG_MAGENTA, "GstAggregator");
1627 klass->sinkpads_type = GST_TYPE_AGGREGATOR_PAD;
1629 klass->sink_event = gst_aggregator_default_sink_event;
1630 klass->sink_query = gst_aggregator_default_sink_query;
1632 klass->src_event = gst_aggregator_default_src_event;
1633 klass->src_query = gst_aggregator_default_src_query;
1635 gstelement_class->request_new_pad =
1636 GST_DEBUG_FUNCPTR (gst_aggregator_request_new_pad);
1637 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_aggregator_send_event);
1638 gstelement_class->release_pad =
1639 GST_DEBUG_FUNCPTR (gst_aggregator_release_pad);
1640 gstelement_class->change_state =
1641 GST_DEBUG_FUNCPTR (gst_aggregator_change_state);
1643 gobject_class->set_property = gst_aggregator_set_property;
1644 gobject_class->get_property = gst_aggregator_get_property;
1645 gobject_class->finalize = gst_aggregator_finalize;
1647 g_object_class_install_property (gobject_class, PROP_LATENCY,
1648 g_param_spec_int64 ("latency", "Buffer latency",
1649 "Additional latency in live mode to allow upstream "
1650 "to take longer to produce buffers for the current "
1652 (G_MAXLONG == G_MAXINT64) ? G_MAXINT64 : (G_MAXLONG * GST_SECOND - 1),
1653 DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1655 GST_DEBUG_REGISTER_FUNCPTR (gst_aggregator_stop_pad);
1656 GST_DEBUG_REGISTER_FUNCPTR (gst_aggregator_query_sink_latency_foreach);
1660 gst_aggregator_init (GstAggregator * self, GstAggregatorClass * klass)
1662 GstPadTemplate *pad_template;
1663 GstAggregatorPrivate *priv;
1665 g_return_if_fail (klass->aggregate != NULL);
1668 G_TYPE_INSTANCE_GET_PRIVATE (self, GST_TYPE_AGGREGATOR,
1669 GstAggregatorPrivate);
1674 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "src");
1675 g_return_if_fail (pad_template != NULL);
1677 priv->padcount = -1;
1678 priv->tags_changed = FALSE;
1680 self->priv->latency_live = FALSE;
1681 self->priv->latency_min = self->priv->sub_latency_min = 0;
1682 self->priv->latency_max = self->priv->sub_latency_max = GST_CLOCK_TIME_NONE;
1683 gst_aggregator_reset_flow_values (self);
1685 self->srcpad = gst_pad_new_from_template (pad_template, "src");
1687 gst_pad_set_event_function (self->srcpad,
1688 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_event_func));
1689 gst_pad_set_query_function (self->srcpad,
1690 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_query_func));
1691 gst_pad_set_activatemode_function (self->srcpad,
1692 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_activate_mode_func));
1694 gst_element_add_pad (GST_ELEMENT (self), self->srcpad);
1696 self->priv->latency = DEFAULT_LATENCY;
1698 g_mutex_init (&self->priv->setcaps_lock);
1699 g_mutex_init (&self->priv->src_lock);
1700 g_cond_init (&self->priv->src_cond);
1703 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
1704 * method to get to the padtemplates */
1706 gst_aggregator_get_type (void)
1708 static volatile gsize type = 0;
1710 if (g_once_init_enter (&type)) {
1712 static const GTypeInfo info = {
1713 sizeof (GstAggregatorClass),
1716 (GClassInitFunc) gst_aggregator_class_init,
1719 sizeof (GstAggregator),
1721 (GInstanceInitFunc) gst_aggregator_init,
1724 _type = g_type_register_static (GST_TYPE_ELEMENT,
1725 "GstAggregator", &info, G_TYPE_FLAG_ABSTRACT);
1726 g_once_init_leave (&type, _type);
1731 static GstFlowReturn
1732 gst_aggregator_pad_chain (GstPad * pad, GstObject * object, GstBuffer * buffer)
1734 GstBuffer *actual_buf = buffer;
1735 GstAggregator *self = GST_AGGREGATOR (object);
1736 GstAggregatorPrivate *priv = self->priv;
1737 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1738 GstAggregatorClass *aggclass = GST_AGGREGATOR_GET_CLASS (object);
1740 GST_DEBUG_OBJECT (aggpad, "Start chaining a buffer %" GST_PTR_FORMAT, buffer);
1742 PAD_STREAM_LOCK (aggpad);
1744 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1747 if (g_atomic_int_get (&aggpad->priv->pending_eos) == TRUE)
1750 PAD_LOCK_EVENT (aggpad);
1752 while (aggpad->buffer && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1753 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1754 PAD_WAIT_EVENT (aggpad);
1756 PAD_UNLOCK_EVENT (aggpad);
1758 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1761 if (aggclass->clip) {
1762 aggclass->clip (self, aggpad, buffer, &actual_buf);
1765 SRC_STREAM_LOCK (self);
1766 PAD_LOCK_EVENT (aggpad);
1768 gst_buffer_unref (aggpad->buffer);
1769 aggpad->buffer = actual_buf;
1770 PAD_UNLOCK_EVENT (aggpad);
1771 PAD_STREAM_UNLOCK (aggpad);
1773 if (gst_aggregator_check_pads_ready (self))
1774 SRC_STREAM_BROADCAST (self);
1775 SRC_STREAM_UNLOCK (self);
1777 GST_DEBUG_OBJECT (aggpad, "Done chaining");
1779 return priv->flow_return;
1782 PAD_STREAM_UNLOCK (aggpad);
1784 gst_buffer_unref (buffer);
1785 GST_DEBUG_OBJECT (aggpad, "We are flushing");
1787 return GST_FLOW_FLUSHING;
1790 PAD_STREAM_UNLOCK (aggpad);
1792 gst_buffer_unref (buffer);
1793 GST_DEBUG_OBJECT (pad, "We are EOS already...");
1795 return GST_FLOW_EOS;
1799 gst_aggregator_pad_query_func (GstPad * pad, GstObject * parent,
1802 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1803 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1805 if (GST_QUERY_IS_SERIALIZED (query)) {
1806 PAD_LOCK_EVENT (aggpad);
1808 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE) {
1809 PAD_UNLOCK_EVENT (aggpad);
1813 while (aggpad->buffer
1814 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1815 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1816 PAD_WAIT_EVENT (aggpad);
1818 PAD_UNLOCK_EVENT (aggpad);
1820 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1824 return klass->sink_query (GST_AGGREGATOR (parent),
1825 GST_AGGREGATOR_PAD (pad), query);
1828 GST_DEBUG_OBJECT (aggpad, "Pad is flushing, dropping query");
1833 gst_aggregator_pad_event_func (GstPad * pad, GstObject * parent,
1836 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1837 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1839 if (GST_EVENT_IS_SERIALIZED (event) && GST_EVENT_TYPE (event) != GST_EVENT_EOS
1840 && GST_EVENT_TYPE (event) != GST_EVENT_SEGMENT_DONE) {
1841 PAD_LOCK_EVENT (aggpad);
1843 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE
1844 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP) {
1845 PAD_UNLOCK_EVENT (aggpad);
1849 while (aggpad->buffer
1850 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1851 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1852 PAD_WAIT_EVENT (aggpad);
1854 PAD_UNLOCK_EVENT (aggpad);
1856 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE
1857 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP)
1861 return klass->sink_event (GST_AGGREGATOR (parent),
1862 GST_AGGREGATOR_PAD (pad), event);
1865 GST_DEBUG_OBJECT (aggpad, "Pad is flushing, dropping event");
1866 if (GST_EVENT_IS_STICKY (event))
1867 gst_pad_store_sticky_event (pad, event);
1868 gst_event_unref (event);
1873 gst_aggregator_pad_activate_mode_func (GstPad * pad,
1874 GstObject * parent, GstPadMode mode, gboolean active)
1876 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1878 if (active == FALSE) {
1879 PAD_LOCK_EVENT (aggpad);
1880 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
1881 gst_buffer_replace (&aggpad->buffer, NULL);
1882 PAD_BROADCAST_EVENT (aggpad);
1883 PAD_UNLOCK_EVENT (aggpad);
1885 PAD_LOCK_EVENT (aggpad);
1886 g_atomic_int_set (&aggpad->priv->flushing, FALSE);
1887 PAD_BROADCAST_EVENT (aggpad);
1888 PAD_UNLOCK_EVENT (aggpad);
1894 /***********************************
1895 * GstAggregatorPad implementation *
1896 ************************************/
1897 G_DEFINE_TYPE (GstAggregatorPad, gst_aggregator_pad, GST_TYPE_PAD);
1900 gst_aggregator_pad_constructed (GObject * object)
1902 GstPad *pad = GST_PAD (object);
1904 gst_pad_set_chain_function (pad,
1905 GST_DEBUG_FUNCPTR (gst_aggregator_pad_chain));
1906 gst_pad_set_event_function (pad,
1907 GST_DEBUG_FUNCPTR (gst_aggregator_pad_event_func));
1908 gst_pad_set_query_function (pad,
1909 GST_DEBUG_FUNCPTR (gst_aggregator_pad_query_func));
1910 gst_pad_set_activatemode_function (pad,
1911 GST_DEBUG_FUNCPTR (gst_aggregator_pad_activate_mode_func));
1915 gst_aggregator_pad_finalize (GObject * object)
1917 GstAggregatorPad *pad = (GstAggregatorPad *) object;
1919 g_mutex_clear (&pad->priv->event_lock);
1920 g_cond_clear (&pad->priv->event_cond);
1921 g_mutex_clear (&pad->priv->stream_lock);
1923 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->finalize (object);
1927 gst_aggregator_pad_dispose (GObject * object)
1929 GstAggregatorPad *pad = (GstAggregatorPad *) object;
1932 buf = gst_aggregator_pad_steal_buffer (pad);
1934 gst_buffer_unref (buf);
1936 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->dispose (object);
1940 gst_aggregator_pad_class_init (GstAggregatorPadClass * klass)
1942 GObjectClass *gobject_class = (GObjectClass *) klass;
1944 g_type_class_add_private (klass, sizeof (GstAggregatorPadPrivate));
1946 gobject_class->constructed = gst_aggregator_pad_constructed;
1947 gobject_class->finalize = gst_aggregator_pad_finalize;
1948 gobject_class->dispose = gst_aggregator_pad_dispose;
1952 gst_aggregator_pad_init (GstAggregatorPad * pad)
1955 G_TYPE_INSTANCE_GET_PRIVATE (pad, GST_TYPE_AGGREGATOR_PAD,
1956 GstAggregatorPadPrivate);
1959 g_mutex_init (&pad->priv->event_lock);
1960 g_cond_init (&pad->priv->event_cond);
1962 g_mutex_init (&pad->priv->stream_lock);
1966 * gst_aggregator_pad_steal_buffer:
1967 * @pad: the pad to get buffer from
1969 * Steal the ref to the buffer currently queued in @pad.
1971 * Returns: (transfer full): The buffer in @pad or NULL if no buffer was
1972 * queued. You should unref the buffer after usage.
1975 gst_aggregator_pad_steal_buffer (GstAggregatorPad * pad)
1977 GstBuffer *buffer = NULL;
1979 PAD_LOCK_EVENT (pad);
1981 GST_TRACE_OBJECT (pad, "Consuming buffer");
1982 buffer = pad->buffer;
1984 if (pad->priv->pending_eos) {
1985 pad->priv->pending_eos = FALSE;
1988 PAD_BROADCAST_EVENT (pad);
1989 GST_DEBUG_OBJECT (pad, "Consumed: %" GST_PTR_FORMAT, buffer);
1991 PAD_UNLOCK_EVENT (pad);
1997 * gst_aggregator_pad_get_buffer:
1998 * @pad: the pad to get buffer from
2000 * Returns: (transfer full): A reference to the buffer in @pad or
2001 * NULL if no buffer was queued. You should unref the buffer after
2005 gst_aggregator_pad_get_buffer (GstAggregatorPad * pad)
2007 GstBuffer *buffer = NULL;
2009 PAD_LOCK_EVENT (pad);
2011 buffer = gst_buffer_ref (pad->buffer);
2012 PAD_UNLOCK_EVENT (pad);
2018 * gst_aggregator_merge_tags:
2019 * @self: a #GstAggregator
2020 * @tags: a #GstTagList to merge
2021 * @mode: the #GstTagMergeMode to use
2023 * Adds tags to so-called pending tags, which will be processed
2024 * before pushing out data downstream.
2026 * Note that this is provided for convenience, and the subclass is
2027 * not required to use this and can still do tag handling on its own.
2032 gst_aggregator_merge_tags (GstAggregator * self,
2033 const GstTagList * tags, GstTagMergeMode mode)
2037 g_return_if_fail (GST_IS_AGGREGATOR (self));
2038 g_return_if_fail (tags == NULL || GST_IS_TAG_LIST (tags));
2040 /* FIXME Check if we can use OBJECT lock here! */
2041 GST_OBJECT_LOCK (self);
2043 GST_DEBUG_OBJECT (self, "merging tags %" GST_PTR_FORMAT, tags);
2044 otags = self->priv->tags;
2045 self->priv->tags = gst_tag_list_merge (self->priv->tags, tags, mode);
2047 gst_tag_list_unref (otags);
2048 self->priv->tags_changed = TRUE;
2049 GST_OBJECT_UNLOCK (self);
2053 * gst_aggregator_set_latency:
2054 * @self: a #GstAggregator
2055 * @min_latency: minimum latency
2056 * @max_latency: maximum latency
2058 * Lets #GstAggregator sub-classes tell the baseclass what their internal
2059 * latency is. Will also post a LATENCY message on the bus so the pipeline
2060 * can reconfigure its global latency.
2063 gst_aggregator_set_latency (GstAggregator * self,
2064 GstClockTime min_latency, GstClockTime max_latency)
2066 g_return_if_fail (GST_IS_AGGREGATOR (self));
2067 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (min_latency));
2068 g_return_if_fail (max_latency >= min_latency);
2070 GST_OBJECT_LOCK (self);
2071 self->priv->sub_latency_min = min_latency;
2072 self->priv->sub_latency_max = max_latency;
2073 GST_OBJECT_UNLOCK (self);
2075 gst_element_post_message (GST_ELEMENT_CAST (self),
2076 gst_message_new_latency (GST_OBJECT_CAST (self)));