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_UNLOCKED(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 #define SRC_STREAM_BROADCAST(self) G_STMT_START { \
178 SRC_STREAM_LOCK (self); \
179 SRC_STREAM_BROADCAST_UNLOCKED (self); \
180 SRC_STREAM_UNLOCK (self); \
183 struct _GstAggregatorPadPrivate
185 gboolean pending_flush_start;
186 gboolean pending_flush_stop;
187 gboolean pending_eos;
197 gst_aggregator_pad_flush (GstAggregatorPad * aggpad, GstAggregator * agg)
199 GstAggregatorPadClass *klass = GST_AGGREGATOR_PAD_GET_CLASS (aggpad);
202 aggpad->priv->flushing = FALSE;
205 return klass->flush (aggpad, agg);
210 /*************************************
211 * GstAggregator implementation *
212 *************************************/
213 static GstElementClass *aggregator_parent_class = NULL;
215 struct _GstAggregatorPrivate
219 /* Our state is >= PAUSED */
224 gboolean send_stream_start;
225 gboolean send_segment;
226 gboolean flush_seeking;
227 gboolean pending_flush_start;
229 GstFlowReturn flow_return;
234 gboolean tags_changed;
236 /* Lock to prevent two src setcaps from happening at the same time */
239 gboolean latency_live;
240 GstClockTime latency_min;
241 GstClockTime latency_max;
243 GstClockTime sub_latency_min;
244 GstClockTime sub_latency_max;
247 GstClockID aggregate_id;
261 gboolean one_actually_seeked;
264 #define DEFAULT_LATENCY 0
274 * gst_aggregator_iterate_sinkpads:
275 * @self: The #GstAggregator
276 * @func: (scope call): The function to call.
277 * @user_data: (closure): The data to pass to @func.
279 * Iterate the sinkpads of aggregator to call a function on them.
281 * This method guarantees that @func will be called only once for each
285 gst_aggregator_iterate_sinkpads (GstAggregator * self,
286 GstAggregatorPadForeachFunc func, gpointer user_data)
288 gboolean result = FALSE;
290 gboolean done = FALSE;
291 GValue item = { 0, };
292 GList *seen_pads = NULL;
294 iter = gst_element_iterate_sink_pads (GST_ELEMENT (self));
300 switch (gst_iterator_next (iter, &item)) {
301 case GST_ITERATOR_OK:
303 GstAggregatorPad *pad;
305 pad = g_value_get_object (&item);
307 /* if already pushed, skip. FIXME, find something faster to tag pads */
308 if (pad == NULL || g_list_find (seen_pads, pad)) {
309 g_value_reset (&item);
313 GST_LOG_OBJECT (pad, "calling function %s on pad",
314 GST_DEBUG_FUNCPTR_NAME (func));
316 result = func (self, pad, user_data);
320 seen_pads = g_list_prepend (seen_pads, pad);
322 g_value_reset (&item);
325 case GST_ITERATOR_RESYNC:
326 gst_iterator_resync (iter);
328 case GST_ITERATOR_ERROR:
329 GST_ERROR_OBJECT (self,
330 "Could not iterate over internally linked pads");
333 case GST_ITERATOR_DONE:
338 g_value_unset (&item);
339 gst_iterator_free (iter);
341 if (seen_pads == NULL) {
342 GST_DEBUG_OBJECT (self, "No pad seen");
346 g_list_free (seen_pads);
353 gst_aggregator_check_pads_ready (GstAggregator * self)
355 GstAggregatorPad *pad;
358 GST_LOG_OBJECT (self, "checking pads");
360 GST_OBJECT_LOCK (self);
362 sinkpads = GST_ELEMENT_CAST (self)->sinkpads;
363 if (sinkpads == NULL)
366 for (l = sinkpads; l != NULL; l = l->next) {
369 if (pad->buffer == NULL && !pad->eos)
373 GST_OBJECT_UNLOCK (self);
374 GST_LOG_OBJECT (self, "pads are ready");
379 GST_LOG_OBJECT (self, "pads not ready: no sink pads");
380 GST_OBJECT_UNLOCK (self);
385 GST_LOG_OBJECT (pad, "pad not ready to be aggregated yet");
386 GST_OBJECT_UNLOCK (self);
392 gst_aggregator_reset_flow_values (GstAggregator * self)
394 self->priv->flow_return = GST_FLOW_FLUSHING;
395 self->priv->send_stream_start = TRUE;
396 self->priv->send_segment = TRUE;
397 gst_segment_init (&self->segment, GST_FORMAT_TIME);
401 gst_aggregator_push_mandatory_events (GstAggregator * self)
403 GstAggregatorPrivate *priv = self->priv;
405 if (self->priv->send_stream_start) {
408 GST_INFO_OBJECT (self, "pushing stream start");
409 /* stream-start (FIXME: create id based on input ids) */
410 g_snprintf (s_id, sizeof (s_id), "agg-%08x", g_random_int ());
411 if (!gst_pad_push_event (self->srcpad, gst_event_new_stream_start (s_id))) {
412 GST_WARNING_OBJECT (self->srcpad, "Sending stream start event failed");
414 self->priv->send_stream_start = FALSE;
417 if (self->priv->srccaps) {
419 GST_INFO_OBJECT (self, "pushing caps: %" GST_PTR_FORMAT,
420 self->priv->srccaps);
421 if (!gst_pad_push_event (self->srcpad,
422 gst_event_new_caps (self->priv->srccaps))) {
423 GST_WARNING_OBJECT (self->srcpad, "Sending caps event failed");
425 gst_caps_unref (self->priv->srccaps);
426 self->priv->srccaps = NULL;
429 if (g_atomic_int_get (&self->priv->send_segment)) {
430 if (!g_atomic_int_get (&self->priv->flush_seeking)) {
431 GstEvent *segev = gst_event_new_segment (&self->segment);
433 if (!self->priv->seqnum)
434 self->priv->seqnum = gst_event_get_seqnum (segev);
436 gst_event_set_seqnum (segev, self->priv->seqnum);
438 GST_DEBUG_OBJECT (self, "pushing segment %" GST_PTR_FORMAT, segev);
439 gst_pad_push_event (self->srcpad, segev);
440 g_atomic_int_set (&self->priv->send_segment, FALSE);
444 if (priv->tags && priv->tags_changed) {
445 gst_pad_push_event (self->srcpad,
446 gst_event_new_tag (gst_tag_list_ref (priv->tags)));
447 priv->tags_changed = FALSE;
452 * gst_aggregator_set_src_caps:
453 * @self: The #GstAggregator
454 * @caps: The #GstCaps to set on the src pad.
456 * Sets the caps to be used on the src pad.
459 gst_aggregator_set_src_caps (GstAggregator * self, GstCaps * caps)
461 GST_AGGREGATOR_SETCAPS_LOCK (self);
462 gst_caps_replace (&self->priv->srccaps, caps);
463 gst_aggregator_push_mandatory_events (self);
464 GST_AGGREGATOR_SETCAPS_UNLOCK (self);
468 * gst_aggregator_finish_buffer:
469 * @self: The #GstAggregator
470 * @buffer: (transfer full): the #GstBuffer to push.
472 * This method will push the provided output buffer downstream. If needed,
473 * mandatory events such as stream-start, caps, and segment events will be
474 * sent before pushing the buffer.
477 gst_aggregator_finish_buffer (GstAggregator * self, GstBuffer * buffer)
479 gst_aggregator_push_mandatory_events (self);
481 if (!g_atomic_int_get (&self->priv->flush_seeking) &&
482 gst_pad_is_active (self->srcpad)) {
483 GST_TRACE_OBJECT (self, "pushing buffer %" GST_PTR_FORMAT, buffer);
484 return gst_pad_push (self->srcpad, buffer);
486 GST_INFO_OBJECT (self, "Not pushing (active: %i, flushing: %i)",
487 g_atomic_int_get (&self->priv->flush_seeking),
488 gst_pad_is_active (self->srcpad));
489 gst_buffer_unref (buffer);
495 gst_aggregator_push_eos (GstAggregator * self)
498 gst_aggregator_push_mandatory_events (self);
500 self->priv->send_eos = FALSE;
501 event = gst_event_new_eos ();
502 gst_event_set_seqnum (event, self->priv->seqnum);
503 gst_pad_push_event (self->srcpad, event);
507 gst_aggregator_get_next_time (GstAggregator * self)
509 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
511 if (klass->get_next_time)
512 return klass->get_next_time (self);
514 return GST_CLOCK_TIME_NONE;
517 /* called with the src STREAM lock */
519 gst_aggregator_wait_and_check (GstAggregator * self, gboolean * timeout)
521 GstClockTime latency_max, latency_min;
527 SRC_STREAM_LOCK (self);
529 gst_aggregator_get_latency (self, &live, &latency_min, &latency_max);
531 if (gst_aggregator_check_pads_ready (self)) {
532 GST_DEBUG_OBJECT (self, "all pads have data");
533 SRC_STREAM_UNLOCK (self);
538 /* Before waiting, check if we're actually still running */
539 if (!self->priv->running || !self->priv->send_eos) {
540 SRC_STREAM_UNLOCK (self);
545 start = gst_aggregator_get_next_time (self);
547 if (!live || !GST_IS_CLOCK (GST_ELEMENT_CLOCK (self))
548 || !GST_CLOCK_TIME_IS_VALID (start)) {
549 /* We wake up here when something happened, and below
550 * then check if we're ready now. If we return FALSE,
551 * we will be directly called again.
553 SRC_STREAM_WAIT (self);
555 GstClockTime base_time, time;
557 GstClockReturn status;
558 GstClockTimeDiff jitter;
560 GST_DEBUG_OBJECT (self, "got subclass start time: %" GST_TIME_FORMAT,
561 GST_TIME_ARGS (start));
563 GST_OBJECT_LOCK (self);
564 base_time = GST_ELEMENT_CAST (self)->base_time;
565 clock = GST_ELEMENT_CLOCK (self);
567 gst_object_ref (clock);
568 GST_OBJECT_UNLOCK (self);
570 time = base_time + start;
572 if (GST_CLOCK_TIME_IS_VALID (latency_min)) {
575 time += self->priv->latency;
578 GST_DEBUG_OBJECT (self, "possibly waiting for clock to reach %"
579 GST_TIME_FORMAT " (base %" GST_TIME_FORMAT " start %" GST_TIME_FORMAT
580 " latency max %" GST_TIME_FORMAT " latency min %" GST_TIME_FORMAT
581 " current %" GST_TIME_FORMAT ")", GST_TIME_ARGS (time),
582 GST_TIME_ARGS (GST_ELEMENT_CAST (self)->base_time),
583 GST_TIME_ARGS (start), GST_TIME_ARGS (latency_max),
584 GST_TIME_ARGS (latency_min),
585 GST_TIME_ARGS (gst_clock_get_time (clock)));
587 self->priv->aggregate_id = gst_clock_new_single_shot_id (clock, time);
588 gst_object_unref (clock);
589 SRC_STREAM_UNLOCK (self);
592 status = gst_clock_id_wait (self->priv->aggregate_id, &jitter);
594 SRC_STREAM_LOCK (self);
595 if (self->priv->aggregate_id) {
596 gst_clock_id_unref (self->priv->aggregate_id);
597 self->priv->aggregate_id = NULL;
600 GST_DEBUG_OBJECT (self, "clock returned %d (jitter: %s%" GST_TIME_FORMAT,
601 status, (jitter < 0 ? "-" : ""),
602 GST_TIME_ARGS ((jitter < 0 ? -jitter : jitter)));
605 if (status == GST_CLOCK_OK || status == GST_CLOCK_EARLY) {
606 SRC_STREAM_UNLOCK (self);
612 res = gst_aggregator_check_pads_ready (self);
613 SRC_STREAM_UNLOCK (self);
619 gst_aggregator_aggregate_func (GstAggregator * self)
621 GstAggregatorPrivate *priv = self->priv;
622 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
623 gboolean timeout = FALSE;
625 if (self->priv->running == FALSE) {
626 GST_DEBUG_OBJECT (self, "Not running anymore");
630 GST_LOG_OBJECT (self, "Checking aggregate");
631 while (priv->send_eos && priv->running) {
632 if (!gst_aggregator_wait_and_check (self, &timeout))
635 GST_TRACE_OBJECT (self, "Actually aggregating!");
637 priv->flow_return = klass->aggregate (self, timeout);
639 if (priv->flow_return == GST_FLOW_EOS) {
640 gst_aggregator_push_eos (self);
643 if (priv->flow_return == GST_FLOW_FLUSHING &&
644 g_atomic_int_get (&priv->flush_seeking))
645 priv->flow_return = GST_FLOW_OK;
647 GST_LOG_OBJECT (self, "flow return is %s",
648 gst_flow_get_name (priv->flow_return));
650 if (priv->flow_return != GST_FLOW_OK)
656 gst_aggregator_start (GstAggregator * self)
658 GstAggregatorClass *klass;
661 self->priv->running = TRUE;
662 self->priv->send_stream_start = TRUE;
663 self->priv->send_segment = TRUE;
664 self->priv->send_eos = TRUE;
665 self->priv->srccaps = NULL;
666 self->priv->flow_return = GST_FLOW_OK;
668 klass = GST_AGGREGATOR_GET_CLASS (self);
671 result = klass->start (self);
679 _check_pending_flush_stop (GstAggregatorPad * pad)
681 return (!pad->priv->pending_flush_stop && !pad->priv->pending_flush_start);
685 gst_aggregator_stop_srcpad_task (GstAggregator * self, GstEvent * flush_start)
689 GST_INFO_OBJECT (self, "%s srcpad task",
690 flush_start ? "Pausing" : "Stopping");
692 self->priv->running = FALSE;
693 SRC_STREAM_BROADCAST (self);
696 res = gst_pad_push_event (self->srcpad, flush_start);
699 gst_pad_stop_task (self->srcpad);
700 SRC_STREAM_BROADCAST (self);
706 gst_aggregator_start_srcpad_task (GstAggregator * self)
708 GST_INFO_OBJECT (self, "Starting srcpad task");
710 self->priv->running = TRUE;
711 gst_pad_start_task (GST_PAD (self->srcpad),
712 (GstTaskFunction) gst_aggregator_aggregate_func, self, NULL);
716 gst_aggregator_flush (GstAggregator * self)
718 GstFlowReturn ret = GST_FLOW_OK;
719 GstAggregatorPrivate *priv = self->priv;
720 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
722 GST_DEBUG_OBJECT (self, "Flushing everything");
723 g_atomic_int_set (&priv->send_segment, TRUE);
724 g_atomic_int_set (&priv->flush_seeking, FALSE);
725 g_atomic_int_set (&priv->tags_changed, FALSE);
727 ret = klass->flush (self);
733 gst_aggregator_all_flush_stop_received (GstAggregator * self)
736 GstAggregatorPad *tmppad;
738 GST_OBJECT_LOCK (self);
739 for (tmp = GST_ELEMENT (self)->sinkpads; tmp; tmp = tmp->next) {
740 tmppad = (GstAggregatorPad *) tmp->data;
742 if (_check_pending_flush_stop (tmppad) == FALSE) {
743 GST_DEBUG_OBJECT (tmppad, "Is not last %i -- %i",
744 tmppad->priv->pending_flush_start, tmppad->priv->pending_flush_stop);
745 GST_OBJECT_UNLOCK (self);
749 GST_OBJECT_UNLOCK (self);
755 gst_aggregator_flush_start (GstAggregator * self, GstAggregatorPad * aggpad,
759 GstAggregatorPrivate *priv = self->priv;
760 GstAggregatorPadPrivate *padpriv = aggpad->priv;
762 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
763 /* Remove pad buffer and wake up the streaming thread */
764 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
765 gst_buffer_replace (&tmpbuf, NULL);
766 PAD_STREAM_LOCK (aggpad);
767 if (g_atomic_int_compare_and_exchange (&padpriv->pending_flush_start,
768 TRUE, FALSE) == TRUE) {
769 GST_DEBUG_OBJECT (aggpad, "Expecting FLUSH_STOP now");
770 g_atomic_int_set (&padpriv->pending_flush_stop, TRUE);
773 if (g_atomic_int_get (&priv->flush_seeking)) {
774 /* If flush_seeking we forward the first FLUSH_START */
775 if (g_atomic_int_compare_and_exchange (&priv->pending_flush_start,
776 TRUE, FALSE) == TRUE) {
778 GST_INFO_OBJECT (self, "Flushing, pausing srcpad task");
779 gst_aggregator_stop_srcpad_task (self, event);
780 priv->flow_return = GST_FLOW_OK;
782 GST_INFO_OBJECT (self, "Getting STREAM_LOCK while seeking");
783 GST_PAD_STREAM_LOCK (self->srcpad);
784 GST_LOG_OBJECT (self, "GOT STREAM_LOCK");
787 gst_event_unref (event);
790 gst_event_unref (event);
792 PAD_STREAM_UNLOCK (aggpad);
794 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
795 gst_buffer_replace (&tmpbuf, NULL);
798 /* GstAggregator vmethods default implementations */
800 gst_aggregator_default_sink_event (GstAggregator * self,
801 GstAggregatorPad * aggpad, GstEvent * event)
804 GstPad *pad = GST_PAD (aggpad);
805 GstAggregatorPrivate *priv = self->priv;
807 switch (GST_EVENT_TYPE (event)) {
808 case GST_EVENT_FLUSH_START:
810 gst_aggregator_flush_start (self, aggpad, event);
811 /* We forward only in one case: right after flush_seeking */
815 case GST_EVENT_FLUSH_STOP:
817 GST_DEBUG_OBJECT (aggpad, "Got FLUSH_STOP");
819 gst_aggregator_pad_flush (aggpad, self);
820 if (g_atomic_int_get (&priv->flush_seeking)) {
821 g_atomic_int_set (&aggpad->priv->pending_flush_stop, FALSE);
823 if (g_atomic_int_get (&priv->flush_seeking)) {
824 if (gst_aggregator_all_flush_stop_received (self)) {
825 /* That means we received FLUSH_STOP/FLUSH_STOP on
826 * all sinkpads -- Seeking is Done... sending FLUSH_STOP */
827 gst_aggregator_flush (self);
828 gst_pad_push_event (self->srcpad, event);
829 priv->send_eos = TRUE;
831 SRC_STREAM_BROADCAST (self);
833 GST_INFO_OBJECT (self, "Releasing source pad STREAM_LOCK");
834 GST_PAD_STREAM_UNLOCK (self->srcpad);
835 gst_aggregator_start_srcpad_task (self);
840 /* We never forward the event */
845 GST_DEBUG_OBJECT (aggpad, "EOS");
847 /* We still have a buffer, and we don't want the subclass to have to
848 * check for it. Mark pending_eos, eos will be set when steal_buffer is
851 PAD_LOCK_EVENT (aggpad);
852 if (!aggpad->buffer) {
855 aggpad->priv->pending_eos = TRUE;
857 PAD_UNLOCK_EVENT (aggpad);
859 SRC_STREAM_BROADCAST (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 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
997 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
998 gst_buffer_replace (&tmpbuf, NULL);
999 gst_element_remove_pad (element, pad);
1001 SRC_STREAM_BROADCAST (self);
1005 gst_aggregator_request_new_pad (GstElement * element,
1006 GstPadTemplate * templ, const gchar * req_name, const GstCaps * caps)
1008 GstAggregator *self;
1009 GstAggregatorPad *agg_pad;
1011 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
1012 GstAggregatorPrivate *priv = GST_AGGREGATOR (element)->priv;
1014 self = GST_AGGREGATOR (element);
1016 if (templ == gst_element_class_get_pad_template (klass, "sink_%u")) {
1020 GST_OBJECT_LOCK (element);
1021 if (req_name == NULL || strlen (req_name) < 6
1022 || !g_str_has_prefix (req_name, "sink_")) {
1023 /* no name given when requesting the pad, use next available int */
1026 /* parse serial number from requested padname */
1027 serial = g_ascii_strtoull (&req_name[5], NULL, 10);
1028 if (serial >= priv->padcount)
1029 priv->padcount = serial;
1032 name = g_strdup_printf ("sink_%u", priv->padcount);
1033 agg_pad = g_object_new (GST_AGGREGATOR_GET_CLASS (self)->sinkpads_type,
1034 "name", name, "direction", GST_PAD_SINK, "template", templ, NULL);
1037 GST_OBJECT_UNLOCK (element);
1043 GST_DEBUG_OBJECT (element, "Adding pad %s", GST_PAD_NAME (agg_pad));
1046 gst_pad_set_active (GST_PAD (agg_pad), TRUE);
1048 /* add the pad to the element */
1049 gst_element_add_pad (element, GST_PAD (agg_pad));
1051 return GST_PAD (agg_pad);
1056 GstClockTime min, max;
1061 gst_aggregator_query_sink_latency_foreach (GstAggregator * self,
1062 GstAggregatorPad * pad, gpointer user_data)
1064 LatencyData *data = user_data;
1065 GstClockTime min, max;
1069 query = gst_query_new_latency ();
1070 res = gst_pad_peer_query (GST_PAD_CAST (pad), query);
1073 gst_query_parse_latency (query, &live, &min, &max);
1075 GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
1076 " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
1078 if (min != GST_CLOCK_TIME_NONE && min > data->min)
1081 if (max != GST_CLOCK_TIME_NONE &&
1082 ((data->max != GST_CLOCK_TIME_NONE && max < data->max) ||
1083 (data->max == GST_CLOCK_TIME_NONE)))
1089 gst_query_unref (query);
1095 * gst_aggregator_get_latency:
1096 * @self: a #GstAggregator
1097 * @live: (out) (allow-none): whether @self is live
1098 * @min_latency: (out) (allow-none): the configured minimum latency of @self
1099 * @max_latency: (out) (allow-none): the configured maximum latency of @self
1101 * Retreives the latency values reported by @self in response to the latency
1104 * Typically only called by subclasses.
1107 gst_aggregator_get_latency (GstAggregator * self, gboolean * live,
1108 GstClockTime * min_latency, GstClockTime * max_latency)
1110 GstClockTime our_latency;
1111 GstClockTime min, max;
1113 g_return_if_fail (GST_IS_AGGREGATOR (self));
1115 /* latency_min is never GST_CLOCK_TIME_NONE by construction */
1116 min = self->priv->latency_min;
1117 max = self->priv->latency_max;
1119 min += self->priv->sub_latency_min;
1120 if (GST_CLOCK_TIME_IS_VALID (max)
1121 && GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max))
1122 max += self->priv->sub_latency_max;
1124 our_latency = self->priv->latency;
1125 if (GST_CLOCK_TIME_IS_VALID (our_latency)) {
1127 if (GST_CLOCK_TIME_IS_VALID (max))
1132 *live = self->priv->latency_live;
1140 gst_aggregator_query_latency (GstAggregator * self, GstQuery * query)
1142 GstClockTime our_latency;
1146 data.max = GST_CLOCK_TIME_NONE;
1149 /* query upstream's latency */
1150 SRC_STREAM_LOCK (self);
1151 gst_aggregator_iterate_sinkpads (self,
1152 gst_aggregator_query_sink_latency_foreach, &data);
1153 SRC_STREAM_UNLOCK (self);
1155 our_latency = self->priv->latency;
1157 if (data.live && GST_CLOCK_TIME_IS_VALID (our_latency) &&
1158 our_latency > data.max) {
1159 GST_ELEMENT_WARNING (self, CORE, NEGOTIATION,
1160 ("%s", "Latency too big"),
1161 ("The requested latency value is too big for the current pipeline. "
1162 "Limiting to %" G_GINT64_FORMAT, data.max));
1163 self->priv->latency = data.max;
1164 /* FIXME: shouldn't we g_object_notify() the change here? */
1167 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (data.min))) {
1168 GST_WARNING_OBJECT (self, "Invalid minimum latency, using 0");
1172 if (G_UNLIKELY (data.min > data.max)) {
1173 GST_WARNING_OBJECT (self, "Minimum latency is greater than maximum latency "
1174 "(%" G_GINT64_FORMAT " > %" G_GINT64_FORMAT "). "
1175 "Clamping it at the maximum latency", data.min, data.max);
1176 data.min = data.max;
1179 self->priv->latency_live = data.live;
1180 self->priv->latency_min = data.min;
1181 self->priv->latency_max = data.max;
1184 if (GST_CLOCK_TIME_IS_VALID (our_latency)) {
1185 if (GST_CLOCK_TIME_IS_VALID (data.min))
1186 data.min += our_latency;
1187 if (GST_CLOCK_TIME_IS_VALID (data.max))
1188 data.max += our_latency;
1191 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_min)
1192 && GST_CLOCK_TIME_IS_VALID (data.min))
1193 data.min += self->priv->sub_latency_min;
1194 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max)
1195 && GST_CLOCK_TIME_IS_VALID (data.max))
1196 data.max += self->priv->sub_latency_max;
1198 GST_DEBUG_OBJECT (self, "configured latency live:%s min:%" G_GINT64_FORMAT
1199 " max:%" G_GINT64_FORMAT, data.live ? "true" : "false", data.min,
1202 gst_query_set_latency (query, data.live, data.min, data.max);
1208 gst_aggregator_send_event (GstElement * element, GstEvent * event)
1210 GstAggregator *self = GST_AGGREGATOR (element);
1212 GST_STATE_LOCK (element);
1213 if (GST_EVENT_TYPE (event) == GST_EVENT_SEEK &&
1214 GST_STATE (element) < GST_STATE_PAUSED) {
1218 GstSeekType start_type, stop_type;
1221 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1222 &start, &stop_type, &stop);
1223 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
1224 stop_type, stop, NULL);
1226 self->priv->seqnum = gst_event_get_seqnum (event);
1227 GST_DEBUG_OBJECT (element, "Storing segment %" GST_PTR_FORMAT, event);
1229 GST_STATE_UNLOCK (element);
1232 return GST_ELEMENT_CLASS (aggregator_parent_class)->send_event (element,
1237 gst_aggregator_default_src_query (GstAggregator * self, GstQuery * query)
1239 gboolean res = TRUE;
1241 switch (GST_QUERY_TYPE (query)) {
1242 case GST_QUERY_SEEKING:
1246 /* don't pass it along as some (file)sink might claim it does
1247 * whereas with a collectpads in between that will not likely work */
1248 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
1249 gst_query_set_seeking (query, format, FALSE, 0, -1);
1254 case GST_QUERY_LATENCY:
1258 ret = gst_aggregator_query_latency (self, query);
1259 /* Wake up the src thread again, due to changed latencies
1260 * or changed live-ness we might have to adjust if we wait
1261 * on a deadline at all and how long.
1263 SRC_STREAM_BROADCAST (self);
1270 return gst_pad_query_default (self->srcpad, GST_OBJECT (self), query);
1277 gst_aggregator_event_forward_func (GstPad * pad, gpointer user_data)
1279 EventData *evdata = user_data;
1280 gboolean ret = TRUE;
1281 GstPad *peer = gst_pad_get_peer (pad);
1282 GstAggregatorPadPrivate *padpriv = GST_AGGREGATOR_PAD (pad)->priv;
1285 ret = gst_pad_send_event (peer, gst_event_ref (evdata->event));
1286 GST_DEBUG_OBJECT (pad, "return of event push is %d", ret);
1287 gst_object_unref (peer);
1291 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK)
1292 GST_ERROR_OBJECT (pad, "Event %" GST_PTR_FORMAT " failed", evdata->event);
1294 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK) {
1295 GstQuery *seeking = gst_query_new_seeking (GST_FORMAT_TIME);
1297 if (gst_pad_query (peer, seeking)) {
1300 gst_query_parse_seeking (seeking, NULL, &seekable, NULL, NULL);
1302 if (seekable == FALSE) {
1303 GST_INFO_OBJECT (pad,
1304 "Source not seekable, We failed but it does not matter!");
1309 GST_ERROR_OBJECT (pad, "Query seeking FAILED");
1312 gst_query_unref (seeking);
1315 if (evdata->flush) {
1316 padpriv->pending_flush_start = FALSE;
1317 padpriv->pending_flush_stop = FALSE;
1320 evdata->one_actually_seeked = TRUE;
1323 evdata->result &= ret;
1325 /* Always send to all pads */
1330 gst_aggregator_forward_event_to_all_sinkpads (GstAggregator * self,
1331 GstEvent * event, gboolean flush)
1335 evdata.event = event;
1336 evdata.result = TRUE;
1337 evdata.flush = flush;
1338 evdata.one_actually_seeked = FALSE;
1340 /* We first need to set all pads as flushing in a first pass
1341 * as flush_start flush_stop is sometimes sent synchronously
1342 * while we send the seek event */
1346 GST_OBJECT_LOCK (self);
1347 for (l = GST_ELEMENT_CAST (self)->sinkpads; l != NULL; l = l->next) {
1348 GstAggregatorPad *pad = l->data;
1350 pad->priv->pending_flush_start = TRUE;
1351 pad->priv->pending_flush_stop = FALSE;
1353 GST_OBJECT_UNLOCK (self);
1356 gst_pad_forward (self->srcpad, gst_aggregator_event_forward_func, &evdata);
1358 gst_event_unref (event);
1364 gst_aggregator_do_seek (GstAggregator * self, GstEvent * event)
1369 GstSeekType start_type, stop_type;
1373 GstAggregatorPrivate *priv = self->priv;
1375 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1376 &start, &stop_type, &stop);
1378 GST_INFO_OBJECT (self, "starting SEEK");
1380 flush = flags & GST_SEEK_FLAG_FLUSH;
1383 g_atomic_int_set (&priv->pending_flush_start, TRUE);
1384 g_atomic_int_set (&priv->flush_seeking, TRUE);
1387 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
1388 stop_type, stop, NULL);
1390 /* forward the seek upstream */
1391 evdata = gst_aggregator_forward_event_to_all_sinkpads (self, event, flush);
1394 if (!evdata.result || !evdata.one_actually_seeked) {
1395 g_atomic_int_set (&priv->flush_seeking, FALSE);
1396 g_atomic_int_set (&priv->pending_flush_start, FALSE);
1399 GST_INFO_OBJECT (self, "seek done, result: %d", evdata.result);
1401 return evdata.result;
1405 gst_aggregator_default_src_event (GstAggregator * self, GstEvent * event)
1408 gboolean res = TRUE;
1410 switch (GST_EVENT_TYPE (event)) {
1411 case GST_EVENT_SEEK:
1413 gst_event_ref (event);
1414 res = gst_aggregator_do_seek (self, event);
1415 gst_event_unref (event);
1419 case GST_EVENT_NAVIGATION:
1421 /* navigation is rather pointless. */
1423 gst_event_unref (event);
1432 evdata = gst_aggregator_forward_event_to_all_sinkpads (self, event, FALSE);
1433 res = evdata.result;
1440 gst_aggregator_src_pad_event_func (GstPad * pad, GstObject * parent,
1443 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1445 return klass->src_event (GST_AGGREGATOR (parent), event);
1449 gst_aggregator_src_pad_query_func (GstPad * pad, GstObject * parent,
1452 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1454 return klass->src_query (GST_AGGREGATOR (parent), query);
1458 gst_aggregator_src_pad_activate_mode_func (GstPad * pad,
1459 GstObject * parent, GstPadMode mode, gboolean active)
1461 GstAggregator *self = GST_AGGREGATOR (parent);
1462 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1464 if (klass->src_activate) {
1465 if (klass->src_activate (self, mode, active) == FALSE) {
1470 if (active == TRUE) {
1472 case GST_PAD_MODE_PUSH:
1474 GST_INFO_OBJECT (pad, "Activating pad!");
1475 gst_aggregator_start_srcpad_task (self);
1480 GST_ERROR_OBJECT (pad, "Only supported mode is PUSH");
1487 GST_INFO_OBJECT (self, "Deactivating srcpad");
1488 gst_aggregator_stop_srcpad_task (self, FALSE);
1494 gst_aggregator_default_sink_query (GstAggregator * self,
1495 GstAggregatorPad * aggpad, GstQuery * query)
1497 GstPad *pad = GST_PAD (aggpad);
1499 return gst_pad_query_default (pad, GST_OBJECT (self), query);
1503 gst_aggregator_finalize (GObject * object)
1505 GstAggregator *self = (GstAggregator *) object;
1507 g_mutex_clear (&self->priv->setcaps_lock);
1508 g_mutex_clear (&self->priv->src_lock);
1509 g_cond_clear (&self->priv->src_cond);
1511 G_OBJECT_CLASS (aggregator_parent_class)->finalize (object);
1515 * gst_aggregator_set_latency_property:
1516 * @agg: a #GstAggregator
1517 * @latency: the new latency value.
1519 * Sets the new latency value to @latency. This value is used to limit the
1520 * amount of time a pad waits for data to appear before considering the pad
1524 gst_aggregator_set_latency_property (GstAggregator * self, gint64 latency)
1528 g_return_if_fail (GST_IS_AGGREGATOR (self));
1530 GST_OBJECT_LOCK (self);
1532 if (self->priv->latency_live && self->priv->latency_max != 0 &&
1533 GST_CLOCK_TIME_IS_VALID (latency) && latency > self->priv->latency_max) {
1534 GST_ELEMENT_WARNING (self, CORE, NEGOTIATION,
1535 ("%s", "Latency too big"),
1536 ("The requested latency value is too big for the latency in the "
1537 "current pipeline. Limiting to %" G_GINT64_FORMAT,
1538 self->priv->latency_max));
1539 latency = self->priv->latency_max;
1542 changed = (self->priv->latency != latency);
1543 self->priv->latency = latency;
1544 GST_OBJECT_UNLOCK (self);
1547 gst_element_post_message (GST_ELEMENT_CAST (self),
1548 gst_message_new_latency (GST_OBJECT_CAST (self)));
1552 * gst_aggregator_get_latency_property:
1553 * @agg: a #GstAggregator
1555 * Gets the latency value. See gst_aggregator_set_latency for
1558 * Returns: The time in nanoseconds to wait for data to arrive on a sink pad
1559 * before a pad is deemed unresponsive. A value of -1 means an
1563 gst_aggregator_get_latency_property (GstAggregator * agg)
1567 g_return_val_if_fail (GST_IS_AGGREGATOR (agg), -1);
1569 GST_OBJECT_LOCK (agg);
1570 res = agg->priv->latency;
1571 GST_OBJECT_UNLOCK (agg);
1577 gst_aggregator_set_property (GObject * object, guint prop_id,
1578 const GValue * value, GParamSpec * pspec)
1580 GstAggregator *agg = GST_AGGREGATOR (object);
1584 gst_aggregator_set_latency_property (agg, g_value_get_int64 (value));
1587 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1593 gst_aggregator_get_property (GObject * object, guint prop_id,
1594 GValue * value, GParamSpec * pspec)
1596 GstAggregator *agg = GST_AGGREGATOR (object);
1600 g_value_set_int64 (value, gst_aggregator_get_latency_property (agg));
1603 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1608 /* GObject vmethods implementations */
1610 gst_aggregator_class_init (GstAggregatorClass * klass)
1612 GObjectClass *gobject_class = (GObjectClass *) klass;
1613 GstElementClass *gstelement_class = (GstElementClass *) klass;
1615 aggregator_parent_class = g_type_class_peek_parent (klass);
1616 g_type_class_add_private (klass, sizeof (GstAggregatorPrivate));
1618 GST_DEBUG_CATEGORY_INIT (aggregator_debug, "aggregator",
1619 GST_DEBUG_FG_MAGENTA, "GstAggregator");
1621 klass->sinkpads_type = GST_TYPE_AGGREGATOR_PAD;
1623 klass->sink_event = gst_aggregator_default_sink_event;
1624 klass->sink_query = gst_aggregator_default_sink_query;
1626 klass->src_event = gst_aggregator_default_src_event;
1627 klass->src_query = gst_aggregator_default_src_query;
1629 gstelement_class->request_new_pad =
1630 GST_DEBUG_FUNCPTR (gst_aggregator_request_new_pad);
1631 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_aggregator_send_event);
1632 gstelement_class->release_pad =
1633 GST_DEBUG_FUNCPTR (gst_aggregator_release_pad);
1634 gstelement_class->change_state =
1635 GST_DEBUG_FUNCPTR (gst_aggregator_change_state);
1637 gobject_class->set_property = gst_aggregator_set_property;
1638 gobject_class->get_property = gst_aggregator_get_property;
1639 gobject_class->finalize = gst_aggregator_finalize;
1641 g_object_class_install_property (gobject_class, PROP_LATENCY,
1642 g_param_spec_int64 ("latency", "Buffer latency",
1643 "Additional latency in live mode to allow upstream "
1644 "to take longer to produce buffers for the current "
1646 (G_MAXLONG == G_MAXINT64) ? G_MAXINT64 : (G_MAXLONG * GST_SECOND - 1),
1647 DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1649 GST_DEBUG_REGISTER_FUNCPTR (gst_aggregator_stop_pad);
1650 GST_DEBUG_REGISTER_FUNCPTR (gst_aggregator_query_sink_latency_foreach);
1654 gst_aggregator_init (GstAggregator * self, GstAggregatorClass * klass)
1656 GstPadTemplate *pad_template;
1657 GstAggregatorPrivate *priv;
1659 g_return_if_fail (klass->aggregate != NULL);
1662 G_TYPE_INSTANCE_GET_PRIVATE (self, GST_TYPE_AGGREGATOR,
1663 GstAggregatorPrivate);
1668 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "src");
1669 g_return_if_fail (pad_template != NULL);
1671 priv->padcount = -1;
1672 priv->tags_changed = FALSE;
1674 self->priv->latency_live = FALSE;
1675 self->priv->latency_min = self->priv->sub_latency_min = 0;
1676 self->priv->latency_max = self->priv->sub_latency_max = GST_CLOCK_TIME_NONE;
1677 gst_aggregator_reset_flow_values (self);
1679 self->srcpad = gst_pad_new_from_template (pad_template, "src");
1681 gst_pad_set_event_function (self->srcpad,
1682 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_event_func));
1683 gst_pad_set_query_function (self->srcpad,
1684 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_query_func));
1685 gst_pad_set_activatemode_function (self->srcpad,
1686 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_activate_mode_func));
1688 gst_element_add_pad (GST_ELEMENT (self), self->srcpad);
1690 self->priv->latency = DEFAULT_LATENCY;
1692 g_mutex_init (&self->priv->setcaps_lock);
1693 g_mutex_init (&self->priv->src_lock);
1694 g_cond_init (&self->priv->src_cond);
1697 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
1698 * method to get to the padtemplates */
1700 gst_aggregator_get_type (void)
1702 static volatile gsize type = 0;
1704 if (g_once_init_enter (&type)) {
1706 static const GTypeInfo info = {
1707 sizeof (GstAggregatorClass),
1710 (GClassInitFunc) gst_aggregator_class_init,
1713 sizeof (GstAggregator),
1715 (GInstanceInitFunc) gst_aggregator_init,
1718 _type = g_type_register_static (GST_TYPE_ELEMENT,
1719 "GstAggregator", &info, G_TYPE_FLAG_ABSTRACT);
1720 g_once_init_leave (&type, _type);
1725 static GstFlowReturn
1726 gst_aggregator_pad_chain (GstPad * pad, GstObject * object, GstBuffer * buffer)
1728 GstBuffer *actual_buf = buffer;
1729 GstAggregator *self = GST_AGGREGATOR (object);
1730 GstAggregatorPrivate *priv = self->priv;
1731 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1732 GstAggregatorClass *aggclass = GST_AGGREGATOR_GET_CLASS (object);
1734 GST_DEBUG_OBJECT (aggpad, "Start chaining a buffer %" GST_PTR_FORMAT, buffer);
1736 PAD_STREAM_LOCK (aggpad);
1738 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1741 if (g_atomic_int_get (&aggpad->priv->pending_eos) == TRUE)
1744 PAD_LOCK_EVENT (aggpad);
1746 while (aggpad->buffer && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1747 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1748 PAD_WAIT_EVENT (aggpad);
1750 PAD_UNLOCK_EVENT (aggpad);
1752 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1755 if (aggclass->clip) {
1756 aggclass->clip (self, aggpad, buffer, &actual_buf);
1759 PAD_LOCK_EVENT (aggpad);
1761 gst_buffer_unref (aggpad->buffer);
1762 aggpad->buffer = actual_buf;
1763 PAD_UNLOCK_EVENT (aggpad);
1764 PAD_STREAM_UNLOCK (aggpad);
1766 SRC_STREAM_LOCK (self);
1767 if (gst_aggregator_check_pads_ready (self))
1768 SRC_STREAM_BROADCAST_UNLOCKED (self);
1769 SRC_STREAM_UNLOCK (self);
1771 GST_DEBUG_OBJECT (aggpad, "Done chaining");
1773 return priv->flow_return;
1776 PAD_STREAM_UNLOCK (aggpad);
1778 gst_buffer_unref (buffer);
1779 GST_DEBUG_OBJECT (aggpad, "We are flushing");
1781 return GST_FLOW_FLUSHING;
1784 PAD_STREAM_UNLOCK (aggpad);
1786 gst_buffer_unref (buffer);
1787 GST_DEBUG_OBJECT (pad, "We are EOS already...");
1789 return GST_FLOW_EOS;
1793 gst_aggregator_pad_query_func (GstPad * pad, GstObject * parent,
1796 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1797 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1799 if (GST_QUERY_IS_SERIALIZED (query)) {
1800 PAD_LOCK_EVENT (aggpad);
1802 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE) {
1803 PAD_UNLOCK_EVENT (aggpad);
1807 while (aggpad->buffer
1808 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1809 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1810 PAD_WAIT_EVENT (aggpad);
1812 PAD_UNLOCK_EVENT (aggpad);
1814 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1818 return klass->sink_query (GST_AGGREGATOR (parent),
1819 GST_AGGREGATOR_PAD (pad), query);
1822 GST_DEBUG_OBJECT (aggpad, "Pad is flushing, dropping query");
1827 gst_aggregator_pad_event_func (GstPad * pad, GstObject * parent,
1830 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1831 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1833 if (GST_EVENT_IS_SERIALIZED (event) && GST_EVENT_TYPE (event) != GST_EVENT_EOS
1834 && GST_EVENT_TYPE (event) != GST_EVENT_SEGMENT_DONE) {
1835 PAD_LOCK_EVENT (aggpad);
1837 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE
1838 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP) {
1839 PAD_UNLOCK_EVENT (aggpad);
1843 while (aggpad->buffer
1844 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1845 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1846 PAD_WAIT_EVENT (aggpad);
1848 PAD_UNLOCK_EVENT (aggpad);
1850 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE
1851 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP)
1855 return klass->sink_event (GST_AGGREGATOR (parent),
1856 GST_AGGREGATOR_PAD (pad), event);
1859 GST_DEBUG_OBJECT (aggpad, "Pad is flushing, dropping event");
1860 if (GST_EVENT_IS_STICKY (event))
1861 gst_pad_store_sticky_event (pad, event);
1862 gst_event_unref (event);
1867 gst_aggregator_pad_activate_mode_func (GstPad * pad,
1868 GstObject * parent, GstPadMode mode, gboolean active)
1870 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1872 if (active == FALSE) {
1873 PAD_LOCK_EVENT (aggpad);
1874 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
1875 gst_buffer_replace (&aggpad->buffer, NULL);
1876 PAD_BROADCAST_EVENT (aggpad);
1877 PAD_UNLOCK_EVENT (aggpad);
1879 g_atomic_int_set (&aggpad->priv->flushing, FALSE);
1880 PAD_LOCK_EVENT (aggpad);
1881 PAD_BROADCAST_EVENT (aggpad);
1882 PAD_UNLOCK_EVENT (aggpad);
1888 /***********************************
1889 * GstAggregatorPad implementation *
1890 ************************************/
1891 G_DEFINE_TYPE (GstAggregatorPad, gst_aggregator_pad, GST_TYPE_PAD);
1894 gst_aggregator_pad_constructed (GObject * object)
1896 GstPad *pad = GST_PAD (object);
1898 gst_pad_set_chain_function (pad,
1899 GST_DEBUG_FUNCPTR (gst_aggregator_pad_chain));
1900 gst_pad_set_event_function (pad,
1901 GST_DEBUG_FUNCPTR (gst_aggregator_pad_event_func));
1902 gst_pad_set_query_function (pad,
1903 GST_DEBUG_FUNCPTR (gst_aggregator_pad_query_func));
1904 gst_pad_set_activatemode_function (pad,
1905 GST_DEBUG_FUNCPTR (gst_aggregator_pad_activate_mode_func));
1909 gst_aggregator_pad_finalize (GObject * object)
1911 GstAggregatorPad *pad = (GstAggregatorPad *) object;
1913 g_mutex_clear (&pad->priv->event_lock);
1914 g_cond_clear (&pad->priv->event_cond);
1915 g_mutex_clear (&pad->priv->stream_lock);
1917 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->finalize (object);
1921 gst_aggregator_pad_dispose (GObject * object)
1923 GstAggregatorPad *pad = (GstAggregatorPad *) object;
1926 buf = gst_aggregator_pad_steal_buffer (pad);
1928 gst_buffer_unref (buf);
1930 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->dispose (object);
1934 gst_aggregator_pad_class_init (GstAggregatorPadClass * klass)
1936 GObjectClass *gobject_class = (GObjectClass *) klass;
1938 g_type_class_add_private (klass, sizeof (GstAggregatorPadPrivate));
1940 gobject_class->constructed = gst_aggregator_pad_constructed;
1941 gobject_class->finalize = gst_aggregator_pad_finalize;
1942 gobject_class->dispose = gst_aggregator_pad_dispose;
1946 gst_aggregator_pad_init (GstAggregatorPad * pad)
1949 G_TYPE_INSTANCE_GET_PRIVATE (pad, GST_TYPE_AGGREGATOR_PAD,
1950 GstAggregatorPadPrivate);
1953 g_mutex_init (&pad->priv->event_lock);
1954 g_cond_init (&pad->priv->event_cond);
1956 g_mutex_init (&pad->priv->stream_lock);
1960 * gst_aggregator_pad_steal_buffer:
1961 * @pad: the pad to get buffer from
1963 * Steal the ref to the buffer currently queued in @pad.
1965 * Returns: (transfer full): The buffer in @pad or NULL if no buffer was
1966 * queued. You should unref the buffer after usage.
1969 gst_aggregator_pad_steal_buffer (GstAggregatorPad * pad)
1971 GstBuffer *buffer = NULL;
1973 PAD_LOCK_EVENT (pad);
1975 GST_TRACE_OBJECT (pad, "Consuming buffer");
1976 buffer = pad->buffer;
1978 if (pad->priv->pending_eos) {
1979 pad->priv->pending_eos = FALSE;
1982 PAD_BROADCAST_EVENT (pad);
1983 GST_DEBUG_OBJECT (pad, "Consumed: %" GST_PTR_FORMAT, buffer);
1985 PAD_UNLOCK_EVENT (pad);
1991 * gst_aggregator_pad_get_buffer:
1992 * @pad: the pad to get buffer from
1994 * Returns: (transfer full): A reference to the buffer in @pad or
1995 * NULL if no buffer was queued. You should unref the buffer after
1999 gst_aggregator_pad_get_buffer (GstAggregatorPad * pad)
2001 GstBuffer *buffer = NULL;
2003 PAD_LOCK_EVENT (pad);
2005 buffer = gst_buffer_ref (pad->buffer);
2006 PAD_UNLOCK_EVENT (pad);
2012 * gst_aggregator_merge_tags:
2013 * @self: a #GstAggregator
2014 * @tags: a #GstTagList to merge
2015 * @mode: the #GstTagMergeMode to use
2017 * Adds tags to so-called pending tags, which will be processed
2018 * before pushing out data downstream.
2020 * Note that this is provided for convenience, and the subclass is
2021 * not required to use this and can still do tag handling on its own.
2026 gst_aggregator_merge_tags (GstAggregator * self,
2027 const GstTagList * tags, GstTagMergeMode mode)
2031 g_return_if_fail (GST_IS_AGGREGATOR (self));
2032 g_return_if_fail (tags == NULL || GST_IS_TAG_LIST (tags));
2034 /* FIXME Check if we can use OBJECT lock here! */
2035 GST_OBJECT_LOCK (self);
2037 GST_DEBUG_OBJECT (self, "merging tags %" GST_PTR_FORMAT, tags);
2038 otags = self->priv->tags;
2039 self->priv->tags = gst_tag_list_merge (self->priv->tags, tags, mode);
2041 gst_tag_list_unref (otags);
2042 self->priv->tags_changed = TRUE;
2043 GST_OBJECT_UNLOCK (self);
2047 * gst_aggregator_set_latency:
2048 * @self: a #GstAggregator
2049 * @min_latency: minimum latency
2050 * @max_latency: maximum latency
2052 * Lets #GstAggregator sub-classes tell the baseclass what their internal
2053 * latency is. Will also post a LATENCY message on the bus so the pipeline
2054 * can reconfigure its global latency.
2057 gst_aggregator_set_latency (GstAggregator * self,
2058 GstClockTime min_latency, GstClockTime max_latency)
2060 g_return_if_fail (GST_IS_AGGREGATOR (self));
2061 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (min_latency));
2062 g_return_if_fail (max_latency >= min_latency);
2064 GST_OBJECT_LOCK (self);
2065 self->priv->sub_latency_min = min_latency;
2066 self->priv->sub_latency_max = max_latency;
2067 GST_OBJECT_UNLOCK (self);
2069 gst_element_post_message (GST_ELEMENT_CAST (self),
2070 gst_message_new_latency (GST_OBJECT_CAST (self)));