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. Implementers should at least implement
33 * the aggregate () vmethod.
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: The function to call.
277 * @user_data: 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);
352 static inline gboolean
353 gst_aggregator_check_all_pads_with_data_or_eos (GstAggregator * self,
354 GstAggregatorPad * aggpad, gpointer user_data)
356 if (aggpad->buffer || aggpad->eos) {
360 GST_LOG_OBJECT (aggpad, "Not ready to be aggregated");
366 gst_aggregator_reset_flow_values (GstAggregator * self)
368 self->priv->flow_return = GST_FLOW_FLUSHING;
369 self->priv->send_stream_start = TRUE;
370 self->priv->send_segment = TRUE;
371 gst_segment_init (&self->segment, GST_FORMAT_TIME);
375 gst_aggregator_push_mandatory_events (GstAggregator * self)
377 GstAggregatorPrivate *priv = self->priv;
379 if (g_atomic_int_get (&self->priv->send_stream_start)) {
382 GST_INFO_OBJECT (self, "pushing stream start");
383 /* stream-start (FIXME: create id based on input ids) */
384 g_snprintf (s_id, sizeof (s_id), "agg-%08x", g_random_int ());
385 if (!gst_pad_push_event (self->srcpad, gst_event_new_stream_start (s_id))) {
386 GST_WARNING_OBJECT (self->srcpad, "Sending stream start event failed");
388 g_atomic_int_set (&self->priv->send_stream_start, FALSE);
391 if (self->priv->srccaps) {
393 GST_INFO_OBJECT (self, "pushing caps: %" GST_PTR_FORMAT,
394 self->priv->srccaps);
395 if (!gst_pad_push_event (self->srcpad,
396 gst_event_new_caps (self->priv->srccaps))) {
397 GST_WARNING_OBJECT (self->srcpad, "Sending caps event failed");
399 gst_caps_unref (self->priv->srccaps);
400 self->priv->srccaps = NULL;
403 if (g_atomic_int_get (&self->priv->send_segment)) {
404 if (!g_atomic_int_get (&self->priv->flush_seeking)) {
405 GstEvent *segev = gst_event_new_segment (&self->segment);
407 if (!self->priv->seqnum)
408 self->priv->seqnum = gst_event_get_seqnum (segev);
410 gst_event_set_seqnum (segev, self->priv->seqnum);
412 GST_DEBUG_OBJECT (self, "pushing segment %" GST_PTR_FORMAT, segev);
413 gst_pad_push_event (self->srcpad, segev);
414 g_atomic_int_set (&self->priv->send_segment, FALSE);
418 if (priv->tags && priv->tags_changed) {
419 gst_pad_push_event (self->srcpad,
420 gst_event_new_tag (gst_tag_list_ref (priv->tags)));
421 priv->tags_changed = FALSE;
426 * gst_aggregator_set_src_caps:
427 * @self: The #GstAggregator
428 * @caps: The #GstCaps to set on the src pad.
430 * Sets the caps to be used on the src pad.
433 gst_aggregator_set_src_caps (GstAggregator * self, GstCaps * caps)
435 GST_AGGREGATOR_SETCAPS_LOCK (self);
436 gst_caps_replace (&self->priv->srccaps, caps);
437 gst_aggregator_push_mandatory_events (self);
438 GST_AGGREGATOR_SETCAPS_UNLOCK (self);
442 * gst_aggregator_finish_buffer:
443 * @self: The #GstAggregator
444 * @buffer: the #GstBuffer to push.
446 * This method will take care of sending mandatory events before pushing
447 * the provided buffer.
450 gst_aggregator_finish_buffer (GstAggregator * self, GstBuffer * buffer)
452 gst_aggregator_push_mandatory_events (self);
454 if (!g_atomic_int_get (&self->priv->flush_seeking) &&
455 gst_pad_is_active (self->srcpad)) {
456 GST_TRACE_OBJECT (self, "pushing buffer %" GST_PTR_FORMAT, buffer);
457 return gst_pad_push (self->srcpad, buffer);
459 GST_INFO_OBJECT (self, "Not pushing (active: %i, flushing: %i)",
460 g_atomic_int_get (&self->priv->flush_seeking),
461 gst_pad_is_active (self->srcpad));
462 gst_buffer_unref (buffer);
468 gst_aggregator_push_eos (GstAggregator * self)
471 gst_aggregator_push_mandatory_events (self);
473 self->priv->send_eos = FALSE;
474 event = gst_event_new_eos ();
475 gst_event_set_seqnum (event, self->priv->seqnum);
476 gst_pad_push_event (self->srcpad, event);
480 gst_aggregator_get_next_time (GstAggregator * self)
482 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
484 if (klass->get_next_time)
485 return klass->get_next_time (self);
487 return GST_CLOCK_TIME_NONE;
490 /* called with the src STREAM lock */
492 gst_aggregator_wait_and_check (GstAggregator * self, gboolean * timeout)
494 GstClockTime latency_max, latency_min;
500 SRC_STREAM_LOCK (self);
502 gst_aggregator_get_latency (self, &live, &latency_min, &latency_max);
504 if (gst_aggregator_iterate_sinkpads (self,
505 gst_aggregator_check_all_pads_with_data_or_eos, NULL)) {
506 GST_DEBUG_OBJECT (self, "all pads have data");
507 SRC_STREAM_UNLOCK (self);
512 /* Before waiting, check if we're actually still running */
513 if (!self->priv->running || !self->priv->send_eos) {
514 SRC_STREAM_UNLOCK (self);
519 start = gst_aggregator_get_next_time (self);
521 if (!live || !GST_IS_CLOCK (GST_ELEMENT_CLOCK (self))
522 || !GST_CLOCK_TIME_IS_VALID (start)) {
523 /* We wake up here when something happened, and below
524 * then check if we're ready now. If we return FALSE,
525 * we will be directly called again.
527 SRC_STREAM_WAIT (self);
529 GstClockTime base_time, time;
531 GstClockReturn status;
533 GST_DEBUG_OBJECT (self, "got subclass start time: %" GST_TIME_FORMAT,
534 GST_TIME_ARGS (start));
536 GST_OBJECT_LOCK (self);
537 base_time = GST_ELEMENT_CAST (self)->base_time;
538 clock = GST_ELEMENT_CLOCK (self);
540 gst_object_ref (clock);
541 GST_OBJECT_UNLOCK (self);
543 time = base_time + start;
545 if (GST_CLOCK_TIME_IS_VALID (latency_min)) {
548 time += self->priv->latency;
551 GST_DEBUG_OBJECT (self, "possibly waiting for clock to reach %"
552 GST_TIME_FORMAT " (base %" GST_TIME_FORMAT " start %" GST_TIME_FORMAT
553 " latency max %" GST_TIME_FORMAT " latency min %" GST_TIME_FORMAT
554 " current %" GST_TIME_FORMAT ")", GST_TIME_ARGS (time),
555 GST_TIME_ARGS (GST_ELEMENT_CAST (self)->base_time),
556 GST_TIME_ARGS (start), GST_TIME_ARGS (latency_max),
557 GST_TIME_ARGS (latency_min),
558 GST_TIME_ARGS (gst_clock_get_time (clock)));
560 self->priv->aggregate_id = gst_clock_new_single_shot_id (clock, time);
561 gst_object_unref (clock);
562 SRC_STREAM_UNLOCK (self);
564 status = gst_clock_id_wait (self->priv->aggregate_id, NULL);
566 SRC_STREAM_LOCK (self);
567 if (self->priv->aggregate_id) {
568 gst_clock_id_unref (self->priv->aggregate_id);
569 self->priv->aggregate_id = NULL;
572 GST_DEBUG_OBJECT (self, "clock returned %d", status);
575 if (status == GST_CLOCK_OK || status == GST_CLOCK_EARLY) {
576 SRC_STREAM_UNLOCK (self);
582 res = gst_aggregator_iterate_sinkpads (self,
583 gst_aggregator_check_all_pads_with_data_or_eos, NULL);
584 SRC_STREAM_UNLOCK (self);
590 gst_aggregator_aggregate_func (GstAggregator * self)
592 GstAggregatorPrivate *priv = self->priv;
593 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
594 gboolean timeout = FALSE;
596 if (self->priv->running == FALSE) {
597 GST_DEBUG_OBJECT (self, "Not running anymore");
601 GST_LOG_OBJECT (self, "Checking aggregate");
602 while (priv->send_eos && priv->running) {
603 if (!gst_aggregator_wait_and_check (self, &timeout))
606 GST_TRACE_OBJECT (self, "Actually aggregating!");
608 priv->flow_return = klass->aggregate (self, timeout);
610 if (priv->flow_return == GST_FLOW_EOS) {
611 gst_aggregator_push_eos (self);
614 if (priv->flow_return == GST_FLOW_FLUSHING &&
615 g_atomic_int_get (&priv->flush_seeking))
616 priv->flow_return = GST_FLOW_OK;
618 GST_LOG_OBJECT (self, "flow return is %s",
619 gst_flow_get_name (priv->flow_return));
621 if (priv->flow_return != GST_FLOW_OK)
627 gst_aggregator_start (GstAggregator * self)
629 GstAggregatorClass *klass;
632 self->priv->running = TRUE;
633 self->priv->send_stream_start = TRUE;
634 self->priv->send_segment = TRUE;
635 self->priv->send_eos = TRUE;
636 self->priv->srccaps = NULL;
637 self->priv->flow_return = GST_FLOW_OK;
639 klass = GST_AGGREGATOR_GET_CLASS (self);
642 result = klass->start (self);
650 _check_pending_flush_stop (GstAggregatorPad * pad)
652 return (!pad->priv->pending_flush_stop && !pad->priv->pending_flush_start);
656 gst_aggregator_stop_srcpad_task (GstAggregator * self, GstEvent * flush_start)
660 GST_INFO_OBJECT (self, "%s srcpad task",
661 flush_start ? "Pausing" : "Stopping");
663 self->priv->running = FALSE;
664 SRC_STREAM_BROADCAST (self);
667 res = gst_pad_push_event (self->srcpad, flush_start);
670 gst_pad_stop_task (self->srcpad);
671 SRC_STREAM_BROADCAST (self);
677 gst_aggregator_start_srcpad_task (GstAggregator * self)
679 GST_INFO_OBJECT (self, "Starting srcpad task");
681 self->priv->running = TRUE;
682 gst_pad_start_task (GST_PAD (self->srcpad),
683 (GstTaskFunction) gst_aggregator_aggregate_func, self, NULL);
687 gst_aggregator_flush (GstAggregator * self)
689 GstFlowReturn ret = GST_FLOW_OK;
690 GstAggregatorPrivate *priv = self->priv;
691 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
693 GST_DEBUG_OBJECT (self, "Flushing everything");
694 g_atomic_int_set (&priv->send_segment, TRUE);
695 g_atomic_int_set (&priv->flush_seeking, FALSE);
696 g_atomic_int_set (&priv->tags_changed, FALSE);
698 ret = klass->flush (self);
704 gst_aggregator_all_flush_stop_received (GstAggregator * self)
707 GstAggregatorPad *tmppad;
709 GST_OBJECT_LOCK (self);
710 for (tmp = GST_ELEMENT (self)->sinkpads; tmp; tmp = tmp->next) {
711 tmppad = (GstAggregatorPad *) tmp->data;
713 if (_check_pending_flush_stop (tmppad) == FALSE) {
714 GST_DEBUG_OBJECT (tmppad, "Is not last %i -- %i",
715 tmppad->priv->pending_flush_start, tmppad->priv->pending_flush_stop);
716 GST_OBJECT_UNLOCK (self);
720 GST_OBJECT_UNLOCK (self);
726 gst_aggregator_flush_start (GstAggregator * self, GstAggregatorPad * aggpad,
730 GstAggregatorPrivate *priv = self->priv;
731 GstAggregatorPadPrivate *padpriv = aggpad->priv;
733 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
734 /* Remove pad buffer and wake up the streaming thread */
735 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
736 gst_buffer_replace (&tmpbuf, NULL);
737 PAD_STREAM_LOCK (aggpad);
738 if (g_atomic_int_compare_and_exchange (&padpriv->pending_flush_start,
739 TRUE, FALSE) == TRUE) {
740 GST_DEBUG_OBJECT (aggpad, "Expecting FLUSH_STOP now");
741 g_atomic_int_set (&padpriv->pending_flush_stop, TRUE);
744 if (g_atomic_int_get (&priv->flush_seeking)) {
745 /* If flush_seeking we forward the first FLUSH_START */
746 if (g_atomic_int_compare_and_exchange (&priv->pending_flush_start,
747 TRUE, FALSE) == TRUE) {
749 GST_INFO_OBJECT (self, "Flushing, pausing srcpad task");
750 gst_aggregator_stop_srcpad_task (self, event);
751 priv->flow_return = GST_FLOW_OK;
753 GST_INFO_OBJECT (self, "Getting STREAM_LOCK while seeking");
754 GST_PAD_STREAM_LOCK (self->srcpad);
755 GST_LOG_OBJECT (self, "GOT STREAM_LOCK");
758 gst_event_unref (event);
761 gst_event_unref (event);
763 PAD_STREAM_UNLOCK (aggpad);
765 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
766 gst_buffer_replace (&tmpbuf, NULL);
769 /* GstAggregator vmethods default implementations */
771 gst_aggregator_default_sink_event (GstAggregator * self,
772 GstAggregatorPad * aggpad, GstEvent * event)
775 GstPad *pad = GST_PAD (aggpad);
776 GstAggregatorPrivate *priv = self->priv;
778 switch (GST_EVENT_TYPE (event)) {
779 case GST_EVENT_FLUSH_START:
781 gst_aggregator_flush_start (self, aggpad, event);
782 /* We forward only in one case: right after flush_seeking */
786 case GST_EVENT_FLUSH_STOP:
788 GST_DEBUG_OBJECT (aggpad, "Got FLUSH_STOP");
790 gst_aggregator_pad_flush (aggpad, self);
791 if (g_atomic_int_get (&priv->flush_seeking)) {
792 g_atomic_int_set (&aggpad->priv->pending_flush_stop, FALSE);
794 if (g_atomic_int_get (&priv->flush_seeking)) {
795 if (gst_aggregator_all_flush_stop_received (self)) {
796 /* That means we received FLUSH_STOP/FLUSH_STOP on
797 * all sinkpads -- Seeking is Done... sending FLUSH_STOP */
798 gst_aggregator_flush (self);
799 gst_pad_push_event (self->srcpad, event);
800 priv->send_eos = TRUE;
802 SRC_STREAM_BROADCAST (self);
804 GST_INFO_OBJECT (self, "Releasing source pad STREAM_LOCK");
805 GST_PAD_STREAM_UNLOCK (self->srcpad);
806 gst_aggregator_start_srcpad_task (self);
811 /* We never forward the event */
816 GST_DEBUG_OBJECT (aggpad, "EOS");
818 /* We still have a buffer, and we don't want the subclass to have to
819 * check for it. Mark pending_eos, eos will be set when steal_buffer is
822 PAD_LOCK_EVENT (aggpad);
823 if (!aggpad->buffer) {
826 aggpad->priv->pending_eos = TRUE;
828 PAD_UNLOCK_EVENT (aggpad);
830 SRC_STREAM_BROADCAST (self);
833 case GST_EVENT_SEGMENT:
835 PAD_LOCK_EVENT (aggpad);
836 gst_event_copy_segment (event, &aggpad->segment);
837 self->priv->seqnum = gst_event_get_seqnum (event);
838 PAD_UNLOCK_EVENT (aggpad);
841 case GST_EVENT_STREAM_START:
849 gst_event_parse_tag (event, &tags);
851 if (gst_tag_list_get_scope (tags) == GST_TAG_SCOPE_STREAM) {
852 gst_aggregator_merge_tags (self, tags, GST_TAG_MERGE_REPLACE);
853 gst_event_unref (event);
865 GST_DEBUG_OBJECT (pad, "Forwarding event: %" GST_PTR_FORMAT, event);
866 return gst_pad_event_default (pad, GST_OBJECT (self), event);
869 GST_DEBUG_OBJECT (pad, "Eating event: %" GST_PTR_FORMAT, event);
871 gst_event_unref (event);
876 static inline gboolean
877 gst_aggregator_stop_pad (GstAggregator * self, GstAggregatorPad * pad,
878 gpointer unused_udata)
880 gst_aggregator_pad_flush (pad, self);
886 gst_aggregator_stop (GstAggregator * agg)
888 GstAggregatorClass *klass;
891 gst_aggregator_reset_flow_values (agg);
893 gst_aggregator_iterate_sinkpads (agg, gst_aggregator_stop_pad, NULL);
896 gst_tag_list_unref (agg->priv->tags);
897 agg->priv->tags = NULL;
899 klass = GST_AGGREGATOR_GET_CLASS (agg);
902 result = klass->stop (agg);
909 /* GstElement vmethods implementations */
910 static GstStateChangeReturn
911 gst_aggregator_change_state (GstElement * element, GstStateChange transition)
913 GstStateChangeReturn ret;
914 GstAggregator *self = GST_AGGREGATOR (element);
916 switch (transition) {
917 case GST_STATE_CHANGE_READY_TO_PAUSED:
918 if (!gst_aggregator_start (self))
926 GST_ELEMENT_CLASS (aggregator_parent_class)->change_state (element,
927 transition)) == GST_STATE_CHANGE_FAILURE)
931 switch (transition) {
932 case GST_STATE_CHANGE_PAUSED_TO_READY:
933 if (!gst_aggregator_stop (self)) {
934 /* What to do in this case? Error out? */
935 GST_ERROR_OBJECT (self, "Subclass failed to stop.");
947 GST_ERROR_OBJECT (element, "parent failed state change");
952 GST_ERROR_OBJECT (element, "Subclass failed to start");
953 return GST_STATE_CHANGE_FAILURE;
958 gst_aggregator_release_pad (GstElement * element, GstPad * pad)
960 GstAggregator *self = GST_AGGREGATOR (element);
963 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
965 GST_INFO_OBJECT (pad, "Removing pad");
967 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
968 tmpbuf = gst_aggregator_pad_steal_buffer (aggpad);
969 gst_buffer_replace (&tmpbuf, NULL);
970 gst_element_remove_pad (element, pad);
972 SRC_STREAM_BROADCAST (self);
976 gst_aggregator_request_new_pad (GstElement * element,
977 GstPadTemplate * templ, const gchar * req_name, const GstCaps * caps)
980 GstAggregatorPad *agg_pad;
982 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
983 GstAggregatorPrivate *priv = GST_AGGREGATOR (element)->priv;
985 self = GST_AGGREGATOR (element);
987 if (templ == gst_element_class_get_pad_template (klass, "sink_%u")) {
991 GST_OBJECT_LOCK (element);
992 if (req_name == NULL || strlen (req_name) < 6
993 || !g_str_has_prefix (req_name, "sink_")) {
994 /* no name given when requesting the pad, use next available int */
997 /* parse serial number from requested padname */
998 serial = g_ascii_strtoull (&req_name[5], NULL, 10);
999 if (serial >= priv->padcount)
1000 priv->padcount = serial;
1003 name = g_strdup_printf ("sink_%u", priv->padcount);
1004 agg_pad = g_object_new (GST_AGGREGATOR_GET_CLASS (self)->sinkpads_type,
1005 "name", name, "direction", GST_PAD_SINK, "template", templ, NULL);
1008 GST_OBJECT_UNLOCK (element);
1014 GST_DEBUG_OBJECT (element, "Adding pad %s", GST_PAD_NAME (agg_pad));
1017 gst_pad_set_active (GST_PAD (agg_pad), TRUE);
1019 /* add the pad to the element */
1020 gst_element_add_pad (element, GST_PAD (agg_pad));
1022 return GST_PAD (agg_pad);
1027 GstClockTime min, max;
1032 gst_aggregator_query_sink_latency_foreach (GstAggregator * self,
1033 GstAggregatorPad * pad, gpointer user_data)
1035 LatencyData *data = user_data;
1036 GstClockTime min, max;
1040 query = gst_query_new_latency ();
1041 res = gst_pad_peer_query (GST_PAD_CAST (pad), query);
1044 gst_query_parse_latency (query, &live, &min, &max);
1046 GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
1047 " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
1049 if (min != GST_CLOCK_TIME_NONE && min > data->min)
1052 if (max != GST_CLOCK_TIME_NONE &&
1053 ((data->max != GST_CLOCK_TIME_NONE && max < data->max) ||
1054 (data->max == GST_CLOCK_TIME_NONE)))
1060 gst_query_unref (query);
1066 * gst_aggregator_get_latency:
1067 * @self: a #GstAggregator
1068 * @live: (out) (allow-none): whether @self is live
1069 * @min_latency: (out) (allow-none): the configured minimum latency of @self
1070 * @max_latency: (out) (allow-none): the configured maximum latency of @self
1072 * Retreives the latency values reported by @self in response to the latency
1075 * Typically only called by subclasses.
1078 gst_aggregator_get_latency (GstAggregator * self, gboolean * live,
1079 GstClockTime * min_latency, GstClockTime * max_latency)
1081 GstClockTime our_latency;
1082 GstClockTime min, max;
1084 g_return_if_fail (GST_IS_AGGREGATOR (self));
1086 /* latency_min is never GST_CLOCK_TIME_NONE by construction */
1087 min = self->priv->latency_min;
1088 max = self->priv->latency_max;
1090 min += self->priv->sub_latency_min;
1091 if (GST_CLOCK_TIME_IS_VALID (max)
1092 && GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max))
1093 max += self->priv->sub_latency_max;
1095 our_latency = self->priv->latency;
1096 if (GST_CLOCK_TIME_IS_VALID (our_latency)) {
1098 if (GST_CLOCK_TIME_IS_VALID (max))
1103 *live = self->priv->latency_live;
1111 gst_aggregator_query_latency (GstAggregator * self, GstQuery * query)
1113 GstClockTime our_latency;
1117 data.max = GST_CLOCK_TIME_NONE;
1120 /* query upstream's latency */
1121 SRC_STREAM_LOCK (self);
1122 gst_aggregator_iterate_sinkpads (self,
1123 gst_aggregator_query_sink_latency_foreach, &data);
1124 SRC_STREAM_UNLOCK (self);
1126 our_latency = self->priv->latency;
1128 if (data.live && GST_CLOCK_TIME_IS_VALID (our_latency) &&
1129 our_latency > data.max) {
1130 GST_ELEMENT_WARNING (self, CORE, NEGOTIATION,
1131 ("%s", "Latency too big"),
1132 ("The requested latency value is too big for the current pipeline. "
1133 "Limiting to %" G_GINT64_FORMAT, data.max));
1134 self->priv->latency = data.max;
1135 /* FIXME: shouldn't we g_object_notify() the change here? */
1138 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (data.min))) {
1139 GST_WARNING_OBJECT (self, "Invalid minimum latency, using 0");
1143 if (G_UNLIKELY (data.min > data.max)) {
1144 GST_WARNING_OBJECT (self, "Minimum latency is greater than maximum latency "
1145 "(%" G_GINT64_FORMAT " > %" G_GINT64_FORMAT "). "
1146 "Clamping it at the maximum latency", data.min, data.max);
1147 data.min = data.max;
1150 self->priv->latency_live = data.live;
1151 self->priv->latency_min = data.min;
1152 self->priv->latency_max = data.max;
1155 if (GST_CLOCK_TIME_IS_VALID (our_latency)) {
1156 if (GST_CLOCK_TIME_IS_VALID (data.min))
1157 data.min += our_latency;
1158 if (GST_CLOCK_TIME_IS_VALID (data.max))
1159 data.max += our_latency;
1162 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_min)
1163 && GST_CLOCK_TIME_IS_VALID (data.min))
1164 data.min += self->priv->sub_latency_min;
1165 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max)
1166 && GST_CLOCK_TIME_IS_VALID (data.max))
1167 data.max += self->priv->sub_latency_max;
1169 GST_DEBUG_OBJECT (self, "configured latency live:%s min:%" G_GINT64_FORMAT
1170 " max:%" G_GINT64_FORMAT, data.live ? "true" : "false", data.min,
1173 gst_query_set_latency (query, data.live, data.min, data.max);
1179 gst_aggregator_send_event (GstElement * element, GstEvent * event)
1181 GstAggregator *self = GST_AGGREGATOR (element);
1183 GST_STATE_LOCK (element);
1184 if (GST_EVENT_TYPE (event) == GST_EVENT_SEEK &&
1185 GST_STATE (element) < GST_STATE_PAUSED) {
1189 GstSeekType start_type, stop_type;
1192 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1193 &start, &stop_type, &stop);
1194 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
1195 stop_type, stop, NULL);
1197 self->priv->seqnum = gst_event_get_seqnum (event);
1198 GST_DEBUG_OBJECT (element, "Storing segment %" GST_PTR_FORMAT, event);
1200 GST_STATE_UNLOCK (element);
1203 return GST_ELEMENT_CLASS (aggregator_parent_class)->send_event (element,
1208 gst_aggregator_default_src_query (GstAggregator * self, GstQuery * query)
1210 gboolean res = TRUE;
1212 switch (GST_QUERY_TYPE (query)) {
1213 case GST_QUERY_SEEKING:
1217 /* don't pass it along as some (file)sink might claim it does
1218 * whereas with a collectpads in between that will not likely work */
1219 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
1220 gst_query_set_seeking (query, format, FALSE, 0, -1);
1225 case GST_QUERY_LATENCY:
1229 ret = gst_aggregator_query_latency (self, query);
1230 /* Wake up the src thread again, due to changed latencies
1231 * or changed live-ness we might have to adjust if we wait
1232 * on a deadline at all and how long.
1234 SRC_STREAM_BROADCAST (self);
1241 return gst_pad_query_default (self->srcpad, GST_OBJECT (self), query);
1248 gst_aggregator_event_forward_func (GstPad * pad, gpointer user_data)
1250 EventData *evdata = user_data;
1251 gboolean ret = TRUE;
1252 GstPad *peer = gst_pad_get_peer (pad);
1253 GstAggregatorPadPrivate *padpriv = GST_AGGREGATOR_PAD (pad)->priv;
1256 ret = gst_pad_send_event (peer, gst_event_ref (evdata->event));
1257 GST_DEBUG_OBJECT (pad, "return of event push is %d", ret);
1258 gst_object_unref (peer);
1262 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK)
1263 GST_ERROR_OBJECT (pad, "Event %" GST_PTR_FORMAT " failed", evdata->event);
1265 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK) {
1266 GstQuery *seeking = gst_query_new_seeking (GST_FORMAT_TIME);
1268 if (gst_pad_query (peer, seeking)) {
1271 gst_query_parse_seeking (seeking, NULL, &seekable, NULL, NULL);
1273 if (seekable == FALSE) {
1274 GST_INFO_OBJECT (pad,
1275 "Source not seekable, We failed but it does not matter!");
1280 GST_ERROR_OBJECT (pad, "Query seeking FAILED");
1284 if (evdata->flush) {
1285 padpriv->pending_flush_start = FALSE;
1286 padpriv->pending_flush_stop = FALSE;
1289 evdata->one_actually_seeked = TRUE;
1292 evdata->result &= ret;
1294 /* Always send to all pads */
1299 gst_aggregator_set_flush_pending (GstAggregator * self, GstAggregatorPad * pad,
1302 pad->priv->pending_flush_start = TRUE;
1303 pad->priv->pending_flush_stop = FALSE;
1309 gst_aggregator_forward_event_to_all_sinkpads (GstAggregator * self,
1310 GstEvent * event, gboolean flush)
1314 evdata.event = event;
1315 evdata.result = TRUE;
1316 evdata.flush = flush;
1317 evdata.one_actually_seeked = FALSE;
1319 /* We first need to set all pads as flushing in a first pass
1320 * as flush_start flush_stop is sometimes sent synchronously
1321 * while we send the seek event */
1323 gst_aggregator_iterate_sinkpads (self,
1324 gst_aggregator_set_flush_pending, NULL);
1326 gst_pad_forward (self->srcpad, gst_aggregator_event_forward_func, &evdata);
1328 gst_event_unref (event);
1334 gst_aggregator_do_seek (GstAggregator * self, GstEvent * event)
1339 GstSeekType start_type, stop_type;
1343 GstAggregatorPrivate *priv = self->priv;
1345 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1346 &start, &stop_type, &stop);
1348 GST_INFO_OBJECT (self, "starting SEEK");
1350 flush = flags & GST_SEEK_FLAG_FLUSH;
1353 g_atomic_int_set (&priv->pending_flush_start, TRUE);
1354 g_atomic_int_set (&priv->flush_seeking, TRUE);
1357 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
1358 stop_type, stop, NULL);
1360 /* forward the seek upstream */
1361 evdata = gst_aggregator_forward_event_to_all_sinkpads (self, event, flush);
1364 if (!evdata.result || !evdata.one_actually_seeked) {
1365 g_atomic_int_set (&priv->flush_seeking, FALSE);
1366 g_atomic_int_set (&priv->pending_flush_start, FALSE);
1369 GST_INFO_OBJECT (self, "seek done, result: %d", evdata.result);
1371 return evdata.result;
1375 gst_aggregator_default_src_event (GstAggregator * self, GstEvent * event)
1378 gboolean res = TRUE;
1380 switch (GST_EVENT_TYPE (event)) {
1381 case GST_EVENT_SEEK:
1383 gst_event_ref (event);
1384 res = gst_aggregator_do_seek (self, event);
1385 gst_event_unref (event);
1389 case GST_EVENT_NAVIGATION:
1391 /* navigation is rather pointless. */
1393 gst_event_unref (event);
1402 evdata = gst_aggregator_forward_event_to_all_sinkpads (self, event, FALSE);
1403 res = evdata.result;
1410 gst_aggregator_src_pad_event_func (GstPad * pad, GstObject * parent,
1413 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1415 return klass->src_event (GST_AGGREGATOR (parent), event);
1419 gst_aggregator_src_pad_query_func (GstPad * pad, GstObject * parent,
1422 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1424 return klass->src_query (GST_AGGREGATOR (parent), query);
1428 gst_aggregator_src_pad_activate_mode_func (GstPad * pad,
1429 GstObject * parent, GstPadMode mode, gboolean active)
1431 GstAggregator *self = GST_AGGREGATOR (parent);
1432 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1434 if (klass->src_activate) {
1435 if (klass->src_activate (self, mode, active) == FALSE) {
1440 if (active == TRUE) {
1442 case GST_PAD_MODE_PUSH:
1444 GST_INFO_OBJECT (pad, "Activating pad!");
1445 gst_aggregator_start_srcpad_task (self);
1450 GST_ERROR_OBJECT (pad, "Only supported mode is PUSH");
1457 GST_INFO_OBJECT (self, "Deactivating srcpad");
1458 gst_aggregator_stop_srcpad_task (self, FALSE);
1464 gst_aggregator_default_sink_query (GstAggregator * self,
1465 GstAggregatorPad * aggpad, GstQuery * query)
1467 GstPad *pad = GST_PAD (aggpad);
1469 return gst_pad_query_default (pad, GST_OBJECT (self), query);
1473 gst_aggregator_finalize (GObject * object)
1475 GstAggregator *self = (GstAggregator *) object;
1477 g_mutex_clear (&self->priv->setcaps_lock);
1478 g_mutex_clear (&self->priv->src_lock);
1479 g_cond_clear (&self->priv->src_cond);
1481 G_OBJECT_CLASS (aggregator_parent_class)->finalize (object);
1485 * gst_aggregator_set_latency_property:
1486 * @agg: a #GstAggregator
1487 * @latency: the new latency value.
1489 * Sets the new latency value to @latency. This value is used to limit the
1490 * amount of time a pad waits for data to appear before considering the pad
1494 gst_aggregator_set_latency_property (GstAggregator * self, gint64 latency)
1498 g_return_if_fail (GST_IS_AGGREGATOR (self));
1500 GST_OBJECT_LOCK (self);
1502 if (self->priv->latency_live && self->priv->latency_max != 0 &&
1503 GST_CLOCK_TIME_IS_VALID (latency) && latency > self->priv->latency_max) {
1504 GST_ELEMENT_WARNING (self, CORE, NEGOTIATION,
1505 ("%s", "Latency too big"),
1506 ("The requested latency value is too big for the latency in the "
1507 "current pipeline. Limiting to %" G_GINT64_FORMAT,
1508 self->priv->latency_max));
1509 latency = self->priv->latency_max;
1512 changed = (self->priv->latency != latency);
1513 self->priv->latency = latency;
1514 GST_OBJECT_UNLOCK (self);
1517 gst_element_post_message (GST_ELEMENT_CAST (self),
1518 gst_message_new_latency (GST_OBJECT_CAST (self)));
1522 * gst_aggregator_get_latency_property:
1523 * @agg: a #GstAggregator
1525 * Gets the latency value. See gst_aggregator_set_latency for
1528 * Returns: The time in nanoseconds to wait for data to arrive on a sink pad
1529 * before a pad is deemed unresponsive. A value of -1 means an
1533 gst_aggregator_get_latency_property (GstAggregator * agg)
1537 g_return_val_if_fail (GST_IS_AGGREGATOR (agg), -1);
1539 GST_OBJECT_LOCK (agg);
1540 res = agg->priv->latency;
1541 GST_OBJECT_UNLOCK (agg);
1547 gst_aggregator_set_property (GObject * object, guint prop_id,
1548 const GValue * value, GParamSpec * pspec)
1550 GstAggregator *agg = GST_AGGREGATOR (object);
1554 gst_aggregator_set_latency_property (agg, g_value_get_int64 (value));
1557 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1563 gst_aggregator_get_property (GObject * object, guint prop_id,
1564 GValue * value, GParamSpec * pspec)
1566 GstAggregator *agg = GST_AGGREGATOR (object);
1570 g_value_set_int64 (value, gst_aggregator_get_latency_property (agg));
1573 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1578 /* GObject vmethods implementations */
1580 gst_aggregator_class_init (GstAggregatorClass * klass)
1582 GObjectClass *gobject_class = (GObjectClass *) klass;
1583 GstElementClass *gstelement_class = (GstElementClass *) klass;
1585 aggregator_parent_class = g_type_class_peek_parent (klass);
1586 g_type_class_add_private (klass, sizeof (GstAggregatorPrivate));
1588 GST_DEBUG_CATEGORY_INIT (aggregator_debug, "aggregator",
1589 GST_DEBUG_FG_MAGENTA, "GstAggregator");
1591 klass->sinkpads_type = GST_TYPE_AGGREGATOR_PAD;
1593 klass->sink_event = gst_aggregator_default_sink_event;
1594 klass->sink_query = gst_aggregator_default_sink_query;
1596 klass->src_event = gst_aggregator_default_src_event;
1597 klass->src_query = gst_aggregator_default_src_query;
1599 gstelement_class->request_new_pad =
1600 GST_DEBUG_FUNCPTR (gst_aggregator_request_new_pad);
1601 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_aggregator_send_event);
1602 gstelement_class->release_pad =
1603 GST_DEBUG_FUNCPTR (gst_aggregator_release_pad);
1604 gstelement_class->change_state =
1605 GST_DEBUG_FUNCPTR (gst_aggregator_change_state);
1607 gobject_class->set_property = gst_aggregator_set_property;
1608 gobject_class->get_property = gst_aggregator_get_property;
1609 gobject_class->finalize = gst_aggregator_finalize;
1611 g_object_class_install_property (gobject_class, PROP_LATENCY,
1612 g_param_spec_int64 ("latency", "Buffer latency",
1613 "Additional latency in live mode to allow upstream "
1614 "to take longer to produce buffers for the current "
1616 (G_MAXLONG == G_MAXINT64) ? G_MAXINT64 : (G_MAXLONG * GST_SECOND - 1),
1617 DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1621 gst_aggregator_init (GstAggregator * self, GstAggregatorClass * klass)
1623 GstPadTemplate *pad_template;
1624 GstAggregatorPrivate *priv;
1626 g_return_if_fail (klass->aggregate != NULL);
1629 G_TYPE_INSTANCE_GET_PRIVATE (self, GST_TYPE_AGGREGATOR,
1630 GstAggregatorPrivate);
1635 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "src");
1636 g_return_if_fail (pad_template != NULL);
1638 priv->padcount = -1;
1639 priv->tags_changed = FALSE;
1641 self->priv->latency_live = FALSE;
1642 self->priv->latency_min = self->priv->sub_latency_min = 0;
1643 self->priv->latency_max = self->priv->sub_latency_max = GST_CLOCK_TIME_NONE;
1644 gst_aggregator_reset_flow_values (self);
1646 self->srcpad = gst_pad_new_from_template (pad_template, "src");
1648 gst_pad_set_event_function (self->srcpad,
1649 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_event_func));
1650 gst_pad_set_query_function (self->srcpad,
1651 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_query_func));
1652 gst_pad_set_activatemode_function (self->srcpad,
1653 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_activate_mode_func));
1655 gst_element_add_pad (GST_ELEMENT (self), self->srcpad);
1657 self->priv->latency = DEFAULT_LATENCY;
1659 g_mutex_init (&self->priv->setcaps_lock);
1660 g_mutex_init (&self->priv->src_lock);
1661 g_cond_init (&self->priv->src_cond);
1664 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
1665 * method to get to the padtemplates */
1667 gst_aggregator_get_type (void)
1669 static volatile gsize type = 0;
1671 if (g_once_init_enter (&type)) {
1673 static const GTypeInfo info = {
1674 sizeof (GstAggregatorClass),
1677 (GClassInitFunc) gst_aggregator_class_init,
1680 sizeof (GstAggregator),
1682 (GInstanceInitFunc) gst_aggregator_init,
1685 _type = g_type_register_static (GST_TYPE_ELEMENT,
1686 "GstAggregator", &info, G_TYPE_FLAG_ABSTRACT);
1687 g_once_init_leave (&type, _type);
1692 static GstFlowReturn
1693 gst_aggregator_pad_chain (GstPad * pad, GstObject * object, GstBuffer * buffer)
1695 GstBuffer *actual_buf = buffer;
1696 GstAggregator *self = GST_AGGREGATOR (object);
1697 GstAggregatorPrivate *priv = self->priv;
1698 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1699 GstAggregatorClass *aggclass = GST_AGGREGATOR_GET_CLASS (object);
1701 GST_DEBUG_OBJECT (aggpad, "Start chaining a buffer %" GST_PTR_FORMAT, buffer);
1703 PAD_STREAM_LOCK (aggpad);
1705 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1708 if (g_atomic_int_get (&aggpad->priv->pending_eos) == TRUE)
1711 PAD_LOCK_EVENT (aggpad);
1713 while (aggpad->buffer && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1714 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1715 PAD_WAIT_EVENT (aggpad);
1717 PAD_UNLOCK_EVENT (aggpad);
1719 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1722 if (aggclass->clip) {
1723 aggclass->clip (self, aggpad, buffer, &actual_buf);
1726 PAD_LOCK_EVENT (aggpad);
1728 gst_buffer_unref (aggpad->buffer);
1729 aggpad->buffer = actual_buf;
1730 PAD_UNLOCK_EVENT (aggpad);
1731 PAD_STREAM_UNLOCK (aggpad);
1733 SRC_STREAM_LOCK (self);
1734 if (gst_aggregator_iterate_sinkpads (self,
1735 gst_aggregator_check_all_pads_with_data_or_eos, NULL))
1736 SRC_STREAM_BROADCAST_UNLOCKED (self);
1737 SRC_STREAM_UNLOCK (self);
1739 GST_DEBUG_OBJECT (aggpad, "Done chaining");
1741 return priv->flow_return;
1744 PAD_STREAM_UNLOCK (aggpad);
1746 gst_buffer_unref (buffer);
1747 GST_DEBUG_OBJECT (aggpad, "We are flushing");
1749 return GST_FLOW_FLUSHING;
1752 PAD_STREAM_UNLOCK (aggpad);
1754 gst_buffer_unref (buffer);
1755 GST_DEBUG_OBJECT (pad, "We are EOS already...");
1757 return GST_FLOW_EOS;
1761 gst_aggregator_pad_query_func (GstPad * pad, GstObject * parent,
1764 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1765 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1767 if (GST_QUERY_IS_SERIALIZED (query)) {
1768 PAD_LOCK_EVENT (aggpad);
1770 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE) {
1771 PAD_UNLOCK_EVENT (aggpad);
1775 while (aggpad->buffer
1776 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1777 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1778 PAD_WAIT_EVENT (aggpad);
1780 PAD_UNLOCK_EVENT (aggpad);
1782 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE)
1786 return klass->sink_query (GST_AGGREGATOR (parent),
1787 GST_AGGREGATOR_PAD (pad), query);
1790 GST_DEBUG_OBJECT (aggpad, "Pad is flushing, dropping query");
1795 gst_aggregator_pad_event_func (GstPad * pad, GstObject * parent,
1798 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1799 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
1801 if (GST_EVENT_IS_SERIALIZED (event) && GST_EVENT_TYPE (event) != GST_EVENT_EOS
1802 && GST_EVENT_TYPE (event) != GST_EVENT_SEGMENT_DONE) {
1803 PAD_LOCK_EVENT (aggpad);
1805 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE
1806 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP) {
1807 PAD_UNLOCK_EVENT (aggpad);
1811 while (aggpad->buffer
1812 && g_atomic_int_get (&aggpad->priv->flushing) == FALSE) {
1813 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
1814 PAD_WAIT_EVENT (aggpad);
1816 PAD_UNLOCK_EVENT (aggpad);
1818 if (g_atomic_int_get (&aggpad->priv->flushing) == TRUE
1819 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP)
1823 return klass->sink_event (GST_AGGREGATOR (parent),
1824 GST_AGGREGATOR_PAD (pad), event);
1827 GST_DEBUG_OBJECT (aggpad, "Pad is flushing, dropping event");
1828 if (GST_EVENT_IS_STICKY (event))
1829 gst_pad_store_sticky_event (pad, event);
1830 gst_event_unref (event);
1835 gst_aggregator_pad_activate_mode_func (GstPad * pad,
1836 GstObject * parent, GstPadMode mode, gboolean active)
1838 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1840 if (active == FALSE) {
1841 PAD_LOCK_EVENT (aggpad);
1842 g_atomic_int_set (&aggpad->priv->flushing, TRUE);
1843 gst_buffer_replace (&aggpad->buffer, NULL);
1844 PAD_BROADCAST_EVENT (aggpad);
1845 PAD_UNLOCK_EVENT (aggpad);
1847 g_atomic_int_set (&aggpad->priv->flushing, FALSE);
1848 PAD_LOCK_EVENT (aggpad);
1849 PAD_BROADCAST_EVENT (aggpad);
1850 PAD_UNLOCK_EVENT (aggpad);
1856 /***********************************
1857 * GstAggregatorPad implementation *
1858 ************************************/
1859 G_DEFINE_TYPE (GstAggregatorPad, gst_aggregator_pad, GST_TYPE_PAD);
1862 gst_aggregator_pad_constructed (GObject * object)
1864 GstPad *pad = GST_PAD (object);
1866 gst_pad_set_chain_function (pad,
1867 GST_DEBUG_FUNCPTR (gst_aggregator_pad_chain));
1868 gst_pad_set_event_function (pad,
1869 GST_DEBUG_FUNCPTR (gst_aggregator_pad_event_func));
1870 gst_pad_set_query_function (pad,
1871 GST_DEBUG_FUNCPTR (gst_aggregator_pad_query_func));
1872 gst_pad_set_activatemode_function (pad,
1873 GST_DEBUG_FUNCPTR (gst_aggregator_pad_activate_mode_func));
1877 gst_aggregator_pad_finalize (GObject * object)
1879 GstAggregatorPad *pad = (GstAggregatorPad *) object;
1881 g_mutex_clear (&pad->priv->event_lock);
1882 g_cond_clear (&pad->priv->event_cond);
1883 g_mutex_clear (&pad->priv->stream_lock);
1885 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->finalize (object);
1889 gst_aggregator_pad_dispose (GObject * object)
1891 GstAggregatorPad *pad = (GstAggregatorPad *) object;
1894 buf = gst_aggregator_pad_steal_buffer (pad);
1896 gst_buffer_unref (buf);
1898 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->dispose (object);
1902 gst_aggregator_pad_class_init (GstAggregatorPadClass * klass)
1904 GObjectClass *gobject_class = (GObjectClass *) klass;
1906 g_type_class_add_private (klass, sizeof (GstAggregatorPadPrivate));
1908 gobject_class->constructed = gst_aggregator_pad_constructed;
1909 gobject_class->finalize = gst_aggregator_pad_finalize;
1910 gobject_class->dispose = gst_aggregator_pad_dispose;
1914 gst_aggregator_pad_init (GstAggregatorPad * pad)
1917 G_TYPE_INSTANCE_GET_PRIVATE (pad, GST_TYPE_AGGREGATOR_PAD,
1918 GstAggregatorPadPrivate);
1921 g_mutex_init (&pad->priv->event_lock);
1922 g_cond_init (&pad->priv->event_cond);
1924 g_mutex_init (&pad->priv->stream_lock);
1928 * gst_aggregator_pad_steal_buffer:
1929 * @pad: the pad to get buffer from
1931 * Steal the ref to the buffer currently queued in @pad.
1933 * Returns: (transfer full): The buffer in @pad or NULL if no buffer was
1934 * queued. You should unref the buffer after usage.
1937 gst_aggregator_pad_steal_buffer (GstAggregatorPad * pad)
1939 GstBuffer *buffer = NULL;
1941 PAD_LOCK_EVENT (pad);
1943 GST_TRACE_OBJECT (pad, "Consuming buffer");
1944 buffer = pad->buffer;
1946 if (pad->priv->pending_eos) {
1947 pad->priv->pending_eos = FALSE;
1950 PAD_BROADCAST_EVENT (pad);
1951 GST_DEBUG_OBJECT (pad, "Consumed: %" GST_PTR_FORMAT, buffer);
1953 PAD_UNLOCK_EVENT (pad);
1959 * gst_aggregator_pad_get_buffer:
1960 * @pad: the pad to get buffer from
1962 * Returns: (transfer full): A reference to the buffer in @pad or
1963 * NULL if no buffer was queued. You should unref the buffer after
1967 gst_aggregator_pad_get_buffer (GstAggregatorPad * pad)
1969 GstBuffer *buffer = NULL;
1971 PAD_LOCK_EVENT (pad);
1973 buffer = gst_buffer_ref (pad->buffer);
1974 PAD_UNLOCK_EVENT (pad);
1980 * gst_aggregator_merge_tags:
1981 * @self: a #GstAggregator
1982 * @tags: a #GstTagList to merge
1983 * @mode: the #GstTagMergeMode to use
1985 * Adds tags to so-called pending tags, which will be processed
1986 * before pushing out data downstream.
1988 * Note that this is provided for convenience, and the subclass is
1989 * not required to use this and can still do tag handling on its own.
1994 gst_aggregator_merge_tags (GstAggregator * self,
1995 const GstTagList * tags, GstTagMergeMode mode)
1999 g_return_if_fail (GST_IS_AGGREGATOR (self));
2000 g_return_if_fail (tags == NULL || GST_IS_TAG_LIST (tags));
2002 /* FIXME Check if we can use OBJECT lock here! */
2003 GST_OBJECT_LOCK (self);
2005 GST_DEBUG_OBJECT (self, "merging tags %" GST_PTR_FORMAT, tags);
2006 otags = self->priv->tags;
2007 self->priv->tags = gst_tag_list_merge (self->priv->tags, tags, mode);
2009 gst_tag_list_unref (otags);
2010 self->priv->tags_changed = TRUE;
2011 GST_OBJECT_UNLOCK (self);
2015 * gst_aggregator_set_latency:
2016 * @self: a #GstAggregator
2017 * @min_latency: minimum latency
2018 * @max_latency: maximum latency
2020 * Lets #GstAggregator sub-classes tell the baseclass what their internal
2021 * latency is. Will also post a LATENCY message on the bus so the pipeline
2022 * can reconfigure its global latency.
2025 gst_aggregator_set_latency (GstAggregator * self,
2026 GstClockTime min_latency, GstClockTime max_latency)
2028 g_return_if_fail (GST_IS_AGGREGATOR (self));
2029 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (min_latency));
2030 g_return_if_fail (max_latency >= min_latency);
2032 GST_OBJECT_LOCK (self);
2033 self->priv->sub_latency_min = min_latency;
2034 self->priv->sub_latency_max = max_latency;
2035 GST_OBJECT_UNLOCK (self);
2037 gst_element_post_message (GST_ELEMENT_CAST (self),
2038 gst_message_new_latency (GST_OBJECT_CAST (self)));