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 * @title: GstAggregator
25 * @short_description: manages a set of pads with the purpose of
26 * aggregating their buffers.
27 * @see_also: gstcollectpads for historical reasons.
29 * Manages a set of pads with the purpose of aggregating their buffers.
30 * 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.
35 * * When data is queued on all pads, the aggregate vmethod is called.
37 * * One can peek at the data on any given GstAggregatorPad with the
38 * gst_aggregator_pad_get_buffer () method, and take ownership of it
39 * with the gst_aggregator_pad_steal_buffer () method. When a buffer
40 * has been taken with steal_buffer (), a new buffer can be queued
43 * * If the subclass wishes to push a buffer downstream in its aggregate
44 * implementation, it should do so through the
45 * gst_aggregator_finish_buffer () method. This method will take care
46 * of sending and ordering mandatory events such as stream start, caps
49 * * Same goes for EOS events, which should not be pushed directly by the
50 * subclass, it should instead return GST_FLOW_EOS in its aggregate
53 * * Note that the aggregator logic regarding gap event handling is to turn
54 * these into gap buffers with matching PTS and duration. It will also
55 * flag these buffers with GST_BUFFER_FLAG_GAP and GST_BUFFER_FLAG_DROPPABLE
56 * to ease their identification and subsequent processing.
64 #include <string.h> /* strlen */
66 #include "gstaggregator.h"
70 GST_AGGREGATOR_START_TIME_SELECTION_ZERO,
71 GST_AGGREGATOR_START_TIME_SELECTION_FIRST,
72 GST_AGGREGATOR_START_TIME_SELECTION_SET
73 } GstAggregatorStartTimeSelection;
76 gst_aggregator_start_time_selection_get_type (void)
78 static GType gtype = 0;
81 static const GEnumValue values[] = {
82 {GST_AGGREGATOR_START_TIME_SELECTION_ZERO,
83 "Start at 0 running time (default)", "zero"},
84 {GST_AGGREGATOR_START_TIME_SELECTION_FIRST,
85 "Start at first observed input running time", "first"},
86 {GST_AGGREGATOR_START_TIME_SELECTION_SET,
87 "Set start time with start-time property", "set"},
91 gtype = g_enum_register_static ("GstAggregatorStartTimeSelection", values);
96 /* Might become API */
97 static void gst_aggregator_merge_tags (GstAggregator * aggregator,
98 const GstTagList * tags, GstTagMergeMode mode);
99 static void gst_aggregator_set_latency_property (GstAggregator * agg,
101 static gint64 gst_aggregator_get_latency_property (GstAggregator * agg);
104 /* Locking order, locks in this element must always be taken in this order
106 * standard sink pad stream lock -> GST_PAD_STREAM_LOCK (aggpad)
107 * Aggregator pad flush lock -> PAD_FLUSH_LOCK(aggpad)
108 * standard src pad stream lock -> GST_PAD_STREAM_LOCK (srcpad)
109 * Aggregator src lock -> SRC_LOCK(agg) w/ SRC_WAIT/BROADCAST
110 * standard element object lock -> GST_OBJECT_LOCK(agg)
111 * Aggregator pad lock -> PAD_LOCK (aggpad) w/ PAD_WAIT/BROADCAST_EVENT(aggpad)
112 * standard src pad object lock -> GST_OBJECT_LOCK(srcpad)
113 * standard sink pad object lock -> GST_OBJECT_LOCK(aggpad)
117 static GstClockTime gst_aggregator_get_latency_unlocked (GstAggregator * self);
119 GST_DEBUG_CATEGORY_STATIC (aggregator_debug);
120 #define GST_CAT_DEFAULT aggregator_debug
122 /* GstAggregatorPad definitions */
123 #define PAD_LOCK(pad) G_STMT_START { \
124 GST_TRACE_OBJECT (pad, "Taking PAD lock from thread %p", \
126 g_mutex_lock(&pad->priv->lock); \
127 GST_TRACE_OBJECT (pad, "Took PAD lock from thread %p", \
131 #define PAD_UNLOCK(pad) G_STMT_START { \
132 GST_TRACE_OBJECT (pad, "Releasing PAD lock from thread %p", \
134 g_mutex_unlock(&pad->priv->lock); \
135 GST_TRACE_OBJECT (pad, "Release PAD lock from thread %p", \
140 #define PAD_WAIT_EVENT(pad) G_STMT_START { \
141 GST_LOG_OBJECT (pad, "Waiting for buffer to be consumed thread %p", \
143 g_cond_wait(&(((GstAggregatorPad* )pad)->priv->event_cond), \
144 (&((GstAggregatorPad*)pad)->priv->lock)); \
145 GST_LOG_OBJECT (pad, "DONE Waiting for buffer to be consumed on thread %p", \
149 #define PAD_BROADCAST_EVENT(pad) G_STMT_START { \
150 GST_LOG_OBJECT (pad, "Signaling buffer consumed from thread %p", \
152 g_cond_broadcast(&(((GstAggregatorPad* )pad)->priv->event_cond)); \
156 #define PAD_FLUSH_LOCK(pad) G_STMT_START { \
157 GST_TRACE_OBJECT (pad, "Taking lock from thread %p", \
159 g_mutex_lock(&pad->priv->flush_lock); \
160 GST_TRACE_OBJECT (pad, "Took lock from thread %p", \
164 #define PAD_FLUSH_UNLOCK(pad) G_STMT_START { \
165 GST_TRACE_OBJECT (pad, "Releasing lock from thread %p", \
167 g_mutex_unlock(&pad->priv->flush_lock); \
168 GST_TRACE_OBJECT (pad, "Release lock from thread %p", \
172 #define SRC_LOCK(self) G_STMT_START { \
173 GST_TRACE_OBJECT (self, "Taking src lock from thread %p", \
175 g_mutex_lock(&self->priv->src_lock); \
176 GST_TRACE_OBJECT (self, "Took src lock from thread %p", \
180 #define SRC_UNLOCK(self) G_STMT_START { \
181 GST_TRACE_OBJECT (self, "Releasing src lock from thread %p", \
183 g_mutex_unlock(&self->priv->src_lock); \
184 GST_TRACE_OBJECT (self, "Released src lock from thread %p", \
188 #define SRC_WAIT(self) G_STMT_START { \
189 GST_LOG_OBJECT (self, "Waiting for src on thread %p", \
191 g_cond_wait(&(self->priv->src_cond), &(self->priv->src_lock)); \
192 GST_LOG_OBJECT (self, "DONE Waiting for src on thread %p", \
196 #define SRC_BROADCAST(self) G_STMT_START { \
197 GST_LOG_OBJECT (self, "Signaling src from thread %p", \
199 if (self->priv->aggregate_id) \
200 gst_clock_id_unschedule (self->priv->aggregate_id); \
201 g_cond_broadcast(&(self->priv->src_cond)); \
204 struct _GstAggregatorPadPrivate
206 /* Following fields are protected by the PAD_LOCK */
207 GstFlowReturn flow_return;
208 gboolean pending_flush_start;
209 gboolean pending_flush_stop;
210 gboolean pending_eos;
212 gboolean first_buffer;
214 GQueue data; /* buffers, events and queries */
215 GstBuffer *clipped_buffer;
217 GstClockTime head_position;
218 GstClockTime tail_position;
219 GstClockTime head_time; /* running time */
220 GstClockTime tail_time;
221 GstClockTime time_level; /* how much head is ahead of tail */
222 GstSegment head_segment; /* segment before the queue */
230 /* This lock prevents a flush start processing happening while
231 * the chain function is also happening.
236 /* Must be called with PAD_LOCK held */
238 gst_aggregator_pad_reset_unlocked (GstAggregatorPad * aggpad)
240 aggpad->priv->pending_eos = FALSE;
241 aggpad->priv->eos = FALSE;
242 aggpad->priv->flow_return = GST_FLOW_OK;
243 GST_OBJECT_LOCK (aggpad);
244 gst_segment_init (&aggpad->segment, GST_FORMAT_UNDEFINED);
245 gst_segment_init (&aggpad->priv->head_segment, GST_FORMAT_UNDEFINED);
246 GST_OBJECT_UNLOCK (aggpad);
247 aggpad->priv->head_position = GST_CLOCK_TIME_NONE;
248 aggpad->priv->tail_position = GST_CLOCK_TIME_NONE;
249 aggpad->priv->head_time = GST_CLOCK_TIME_NONE;
250 aggpad->priv->tail_time = GST_CLOCK_TIME_NONE;
251 aggpad->priv->time_level = 0;
252 aggpad->priv->first_buffer = TRUE;
256 gst_aggregator_pad_flush (GstAggregatorPad * aggpad, GstAggregator * agg)
258 GstAggregatorPadClass *klass = GST_AGGREGATOR_PAD_GET_CLASS (aggpad);
261 gst_aggregator_pad_reset_unlocked (aggpad);
265 return klass->flush (aggpad, agg);
270 /*************************************
271 * GstAggregator implementation *
272 *************************************/
273 static GstElementClass *aggregator_parent_class = NULL;
275 /* All members are protected by the object lock unless otherwise noted */
277 struct _GstAggregatorPrivate
281 /* Our state is >= PAUSED */
282 gboolean running; /* protected by src_lock */
285 gboolean send_stream_start; /* protected by srcpad stream lock */
286 gboolean send_segment;
287 gboolean flush_seeking;
288 gboolean pending_flush_start;
289 gboolean send_eos; /* protected by srcpad stream lock */
291 GstCaps *srccaps; /* protected by the srcpad stream lock */
294 gboolean tags_changed;
296 gboolean peer_latency_live; /* protected by src_lock */
297 GstClockTime peer_latency_min; /* protected by src_lock */
298 GstClockTime peer_latency_max; /* protected by src_lock */
299 gboolean has_peer_latency; /* protected by src_lock */
301 GstClockTime sub_latency_min; /* protected by src_lock */
302 GstClockTime sub_latency_max; /* protected by src_lock */
305 GstClockID aggregate_id; /* protected by src_lock */
309 gboolean first_buffer; /* protected by object lock */
310 GstAggregatorStartTimeSelection start_time_selection;
311 GstClockTime start_time;
313 /* protected by the object lock */
314 GstQuery *allocation_query;
315 GstAllocator *allocator;
317 GstAllocationParams allocation_params;
320 gint64 latency; /* protected by both src_lock and all pad locks */
328 gboolean only_to_active_pads;
330 gboolean one_actually_seeked;
333 #define DEFAULT_LATENCY 0
334 #define DEFAULT_START_TIME_SELECTION GST_AGGREGATOR_START_TIME_SELECTION_ZERO
335 #define DEFAULT_START_TIME (-1)
341 PROP_START_TIME_SELECTION,
346 static GstFlowReturn gst_aggregator_pad_chain_internal (GstAggregator * self,
347 GstAggregatorPad * aggpad, GstBuffer * buffer, gboolean head);
350 * gst_aggregator_iterate_sinkpads:
351 * @self: The #GstAggregator
352 * @func: (scope call): The function to call.
353 * @user_data: (closure): The data to pass to @func.
355 * Iterate the sinkpads of aggregator to call a function on them.
357 * This method guarantees that @func will be called only once for each
360 * Returns: %FALSE if there are no sinkpads or if @func returned %FALSE
363 gst_aggregator_iterate_sinkpads (GstAggregator * self,
364 GstAggregatorPadForeachFunc func, gpointer user_data)
366 gboolean result = FALSE;
368 gboolean done = FALSE;
369 GValue item = { 0, };
370 GList *seen_pads = NULL;
372 iter = gst_element_iterate_sink_pads (GST_ELEMENT (self));
378 switch (gst_iterator_next (iter, &item)) {
379 case GST_ITERATOR_OK:
381 GstAggregatorPad *pad;
383 pad = g_value_get_object (&item);
385 /* if already pushed, skip. FIXME, find something faster to tag pads */
386 if (pad == NULL || g_list_find (seen_pads, pad)) {
387 g_value_reset (&item);
391 GST_LOG_OBJECT (pad, "calling function %s on pad",
392 GST_DEBUG_FUNCPTR_NAME (func));
394 result = func (self, pad, user_data);
398 seen_pads = g_list_prepend (seen_pads, pad);
400 g_value_reset (&item);
403 case GST_ITERATOR_RESYNC:
404 gst_iterator_resync (iter);
406 case GST_ITERATOR_ERROR:
407 GST_ERROR_OBJECT (self,
408 "Could not iterate over internally linked pads");
411 case GST_ITERATOR_DONE:
416 g_value_unset (&item);
417 gst_iterator_free (iter);
419 if (seen_pads == NULL) {
420 GST_DEBUG_OBJECT (self, "No pad seen");
424 g_list_free (seen_pads);
431 gst_aggregator_pad_queue_is_empty (GstAggregatorPad * pad)
433 return (g_queue_peek_tail (&pad->priv->data) == NULL &&
434 pad->priv->clipped_buffer == NULL);
438 gst_aggregator_check_pads_ready (GstAggregator * self)
440 GstAggregatorPad *pad;
442 gboolean have_buffer = TRUE;
443 gboolean have_event = FALSE;
445 GST_LOG_OBJECT (self, "checking pads");
447 GST_OBJECT_LOCK (self);
449 sinkpads = GST_ELEMENT_CAST (self)->sinkpads;
450 if (sinkpads == NULL)
453 for (l = sinkpads; l != NULL; l = l->next) {
458 if (pad->priv->num_buffers == 0) {
459 if (!gst_aggregator_pad_queue_is_empty (pad))
461 if (!pad->priv->eos) {
464 /* If not live we need data on all pads, so leave the loop */
465 if (!self->priv->peer_latency_live) {
470 } else if (self->priv->peer_latency_live) {
471 /* In live mode, having a single pad with buffers is enough to
472 * generate a start time from it. In non-live mode all pads need
475 self->priv->first_buffer = FALSE;
481 if (!have_buffer && !have_event)
485 self->priv->first_buffer = FALSE;
487 GST_OBJECT_UNLOCK (self);
488 GST_LOG_OBJECT (self, "pads are ready");
493 GST_LOG_OBJECT (self, "pads not ready: no sink pads");
494 GST_OBJECT_UNLOCK (self);
500 GST_LOG_OBJECT (pad, "pad not ready to be aggregated yet,"
501 " but waking up for serialized event");
503 GST_LOG_OBJECT (pad, "pad not ready to be aggregated yet");
504 GST_OBJECT_UNLOCK (self);
510 gst_aggregator_reset_flow_values (GstAggregator * self)
512 GST_OBJECT_LOCK (self);
513 self->priv->send_stream_start = TRUE;
514 self->priv->send_segment = TRUE;
515 gst_segment_init (&self->segment, GST_FORMAT_TIME);
516 self->priv->first_buffer = TRUE;
517 GST_OBJECT_UNLOCK (self);
521 gst_aggregator_push_mandatory_events (GstAggregator * self)
523 GstAggregatorPrivate *priv = self->priv;
524 GstEvent *segment = NULL;
525 GstEvent *tags = NULL;
527 if (self->priv->send_stream_start) {
530 GST_INFO_OBJECT (self, "pushing stream start");
531 /* stream-start (FIXME: create id based on input ids) */
532 g_snprintf (s_id, sizeof (s_id), "agg-%08x", g_random_int ());
533 if (!gst_pad_push_event (self->srcpad, gst_event_new_stream_start (s_id))) {
534 GST_WARNING_OBJECT (self->srcpad, "Sending stream start event failed");
536 self->priv->send_stream_start = FALSE;
539 if (self->priv->srccaps) {
541 GST_INFO_OBJECT (self, "pushing caps: %" GST_PTR_FORMAT,
542 self->priv->srccaps);
543 if (!gst_pad_push_event (self->srcpad,
544 gst_event_new_caps (self->priv->srccaps))) {
545 GST_WARNING_OBJECT (self->srcpad, "Sending caps event failed");
547 gst_caps_unref (self->priv->srccaps);
548 self->priv->srccaps = NULL;
551 GST_OBJECT_LOCK (self);
552 if (self->priv->send_segment && !self->priv->flush_seeking) {
553 segment = gst_event_new_segment (&self->segment);
555 if (!self->priv->seqnum)
556 self->priv->seqnum = gst_event_get_seqnum (segment);
558 gst_event_set_seqnum (segment, self->priv->seqnum);
559 self->priv->send_segment = FALSE;
561 GST_DEBUG_OBJECT (self, "pushing segment %" GST_PTR_FORMAT, segment);
564 if (priv->tags && priv->tags_changed && !self->priv->flush_seeking) {
565 tags = gst_event_new_tag (gst_tag_list_ref (priv->tags));
566 priv->tags_changed = FALSE;
568 GST_OBJECT_UNLOCK (self);
571 gst_pad_push_event (self->srcpad, segment);
573 gst_pad_push_event (self->srcpad, tags);
578 * gst_aggregator_set_src_caps:
579 * @self: The #GstAggregator
580 * @caps: The #GstCaps to set on the src pad.
582 * Sets the caps to be used on the src pad.
585 gst_aggregator_set_src_caps (GstAggregator * self, GstCaps * caps)
587 GST_PAD_STREAM_LOCK (self->srcpad);
588 gst_caps_replace (&self->priv->srccaps, caps);
589 gst_aggregator_push_mandatory_events (self);
590 GST_PAD_STREAM_UNLOCK (self->srcpad);
594 * gst_aggregator_finish_buffer:
595 * @self: The #GstAggregator
596 * @buffer: (transfer full): the #GstBuffer to push.
598 * This method will push the provided output buffer downstream. If needed,
599 * mandatory events such as stream-start, caps, and segment events will be
600 * sent before pushing the buffer.
603 gst_aggregator_finish_buffer (GstAggregator * self, GstBuffer * buffer)
605 gst_aggregator_push_mandatory_events (self);
607 GST_OBJECT_LOCK (self);
608 if (!self->priv->flush_seeking && gst_pad_is_active (self->srcpad)) {
609 GST_TRACE_OBJECT (self, "pushing buffer %" GST_PTR_FORMAT, buffer);
610 GST_OBJECT_UNLOCK (self);
611 return gst_pad_push (self->srcpad, buffer);
613 GST_INFO_OBJECT (self, "Not pushing (active: %i, flushing: %i)",
614 self->priv->flush_seeking, gst_pad_is_active (self->srcpad));
615 GST_OBJECT_UNLOCK (self);
616 gst_buffer_unref (buffer);
622 gst_aggregator_push_eos (GstAggregator * self)
625 gst_aggregator_push_mandatory_events (self);
627 event = gst_event_new_eos ();
629 GST_OBJECT_LOCK (self);
630 self->priv->send_eos = FALSE;
631 gst_event_set_seqnum (event, self->priv->seqnum);
632 GST_OBJECT_UNLOCK (self);
634 gst_pad_push_event (self->srcpad, event);
638 gst_aggregator_get_next_time (GstAggregator * self)
640 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
642 if (klass->get_next_time)
643 return klass->get_next_time (self);
645 return GST_CLOCK_TIME_NONE;
649 gst_aggregator_wait_and_check (GstAggregator * self, gboolean * timeout)
651 GstClockTime latency;
659 latency = gst_aggregator_get_latency_unlocked (self);
661 if (gst_aggregator_check_pads_ready (self)) {
662 GST_DEBUG_OBJECT (self, "all pads have data");
668 /* Before waiting, check if we're actually still running */
669 if (!self->priv->running || !self->priv->send_eos) {
675 start = gst_aggregator_get_next_time (self);
677 /* If we're not live, or if we use the running time
678 * of the first buffer as start time, we wait until
679 * all pads have buffers.
680 * Otherwise (i.e. if we are live!), we wait on the clock
681 * and if a pad does not have a buffer in time we ignore
684 GST_OBJECT_LOCK (self);
685 if (!GST_CLOCK_TIME_IS_VALID (latency) ||
686 !GST_IS_CLOCK (GST_ELEMENT_CLOCK (self)) ||
687 !GST_CLOCK_TIME_IS_VALID (start) ||
688 (self->priv->first_buffer
689 && self->priv->start_time_selection ==
690 GST_AGGREGATOR_START_TIME_SELECTION_FIRST)) {
691 /* We wake up here when something happened, and below
692 * then check if we're ready now. If we return FALSE,
693 * we will be directly called again.
695 GST_OBJECT_UNLOCK (self);
698 GstClockTime base_time, time;
700 GstClockReturn status;
701 GstClockTimeDiff jitter;
703 GST_DEBUG_OBJECT (self, "got subclass start time: %" GST_TIME_FORMAT,
704 GST_TIME_ARGS (start));
706 base_time = GST_ELEMENT_CAST (self)->base_time;
707 clock = gst_object_ref (GST_ELEMENT_CLOCK (self));
708 GST_OBJECT_UNLOCK (self);
710 time = base_time + start;
713 GST_DEBUG_OBJECT (self, "possibly waiting for clock to reach %"
714 GST_TIME_FORMAT " (base %" GST_TIME_FORMAT " start %" GST_TIME_FORMAT
715 " latency %" GST_TIME_FORMAT " current %" GST_TIME_FORMAT ")",
716 GST_TIME_ARGS (time),
717 GST_TIME_ARGS (base_time),
718 GST_TIME_ARGS (start), GST_TIME_ARGS (latency),
719 GST_TIME_ARGS (gst_clock_get_time (clock)));
721 self->priv->aggregate_id = gst_clock_new_single_shot_id (clock, time);
722 gst_object_unref (clock);
726 status = gst_clock_id_wait (self->priv->aggregate_id, &jitter);
729 if (self->priv->aggregate_id) {
730 gst_clock_id_unref (self->priv->aggregate_id);
731 self->priv->aggregate_id = NULL;
734 GST_DEBUG_OBJECT (self,
735 "clock returned %d (jitter: %" GST_STIME_FORMAT ")",
736 status, GST_STIME_ARGS (jitter));
739 if (status == GST_CLOCK_OK || status == GST_CLOCK_EARLY) {
746 res = gst_aggregator_check_pads_ready (self);
753 do_events_and_queries (GstAggregator * self, GstAggregatorPad * pad,
756 GstEvent *event = NULL;
757 GstQuery *query = NULL;
758 GstAggregatorClass *klass = NULL;
759 gboolean *processed_event = user_data;
766 if (pad->priv->num_buffers == 0 && pad->priv->pending_eos) {
767 pad->priv->pending_eos = FALSE;
768 pad->priv->eos = TRUE;
770 if (pad->priv->clipped_buffer == NULL &&
771 !GST_IS_BUFFER (g_queue_peek_tail (&pad->priv->data))) {
772 if (GST_IS_EVENT (g_queue_peek_tail (&pad->priv->data)))
773 event = gst_event_ref (g_queue_peek_tail (&pad->priv->data));
774 if (GST_IS_QUERY (g_queue_peek_tail (&pad->priv->data)))
775 query = g_queue_peek_tail (&pad->priv->data);
778 if (event || query) {
782 *processed_event = TRUE;
784 klass = GST_AGGREGATOR_GET_CLASS (self);
787 GST_LOG_OBJECT (pad, "Processing %" GST_PTR_FORMAT, event);
788 gst_event_ref (event);
789 ret = klass->sink_event (self, pad, event);
792 if (GST_EVENT_TYPE (event) == GST_EVENT_CAPS)
793 pad->priv->negotiated = ret;
794 if (g_queue_peek_tail (&pad->priv->data) == event)
795 gst_event_unref (g_queue_pop_tail (&pad->priv->data));
796 gst_event_unref (event);
798 GST_LOG_OBJECT (pad, "Processing %" GST_PTR_FORMAT, query);
799 ret = klass->sink_query (self, pad, query);
802 if (g_queue_peek_tail (&pad->priv->data) == query) {
805 s = gst_query_writable_structure (query);
806 gst_structure_set (s, "gst-aggregator-retval", G_TYPE_BOOLEAN, ret,
808 g_queue_pop_tail (&pad->priv->data);
812 PAD_BROADCAST_EVENT (pad);
815 } while (event || query);
821 gst_aggregator_pad_set_flushing (GstAggregatorPad * aggpad,
822 GstFlowReturn flow_return, gboolean full)
827 if (flow_return == GST_FLOW_NOT_LINKED)
828 aggpad->priv->flow_return = MIN (flow_return, aggpad->priv->flow_return);
830 aggpad->priv->flow_return = flow_return;
832 item = g_queue_peek_head_link (&aggpad->priv->data);
834 GList *next = item->next;
836 /* In partial flush, we do like the pad, we get rid of non-sticky events
839 if (full || GST_IS_BUFFER (item->data) ||
840 GST_EVENT_TYPE (item->data) == GST_EVENT_EOS ||
841 GST_EVENT_TYPE (item->data) == GST_EVENT_SEGMENT ||
842 !GST_EVENT_IS_STICKY (item->data)) {
843 if (!GST_IS_QUERY (item->data))
844 gst_mini_object_unref (item->data);
845 g_queue_delete_link (&aggpad->priv->data, item);
849 aggpad->priv->num_buffers = 0;
850 gst_buffer_replace (&aggpad->priv->clipped_buffer, NULL);
852 PAD_BROADCAST_EVENT (aggpad);
857 gst_aggregator_default_update_src_caps (GstAggregator * agg, GstCaps * caps,
860 *ret = gst_caps_ref (caps);
866 gst_aggregator_default_fixate_src_caps (GstAggregator * agg, GstCaps * caps)
868 caps = gst_caps_fixate (caps);
874 gst_aggregator_default_negotiated_src_caps (GstAggregator * agg, GstCaps * caps)
880 /* takes ownership of the pool, allocator and query */
882 gst_aggregator_set_allocation (GstAggregator * self,
883 GstBufferPool * pool, GstAllocator * allocator,
884 GstAllocationParams * params, GstQuery * query)
886 GstAllocator *oldalloc;
887 GstBufferPool *oldpool;
890 GST_DEBUG ("storing allocation query");
892 GST_OBJECT_LOCK (self);
893 oldpool = self->priv->pool;
894 self->priv->pool = pool;
896 oldalloc = self->priv->allocator;
897 self->priv->allocator = allocator;
899 oldquery = self->priv->allocation_query;
900 self->priv->allocation_query = query;
903 self->priv->allocation_params = *params;
905 gst_allocation_params_init (&self->priv->allocation_params);
906 GST_OBJECT_UNLOCK (self);
909 GST_DEBUG_OBJECT (self, "deactivating old pool %p", oldpool);
910 gst_buffer_pool_set_active (oldpool, FALSE);
911 gst_object_unref (oldpool);
914 gst_object_unref (oldalloc);
917 gst_query_unref (oldquery);
924 gst_aggregator_decide_allocation (GstAggregator * self, GstQuery * query)
926 GstAggregatorClass *aggclass = GST_AGGREGATOR_GET_CLASS (self);
928 if (aggclass->decide_allocation)
929 if (!aggclass->decide_allocation (self, query))
936 gst_aggregator_do_allocation (GstAggregator * self, GstCaps * caps)
939 gboolean result = TRUE;
940 GstBufferPool *pool = NULL;
941 GstAllocator *allocator;
942 GstAllocationParams params;
944 /* find a pool for the negotiated caps now */
945 GST_DEBUG_OBJECT (self, "doing allocation query");
946 query = gst_query_new_allocation (caps, TRUE);
947 if (!gst_pad_peer_query (self->srcpad, query)) {
948 /* not a problem, just debug a little */
949 GST_DEBUG_OBJECT (self, "peer ALLOCATION query failed");
952 GST_DEBUG_OBJECT (self, "calling decide_allocation");
953 result = gst_aggregator_decide_allocation (self, query);
955 GST_DEBUG_OBJECT (self, "ALLOCATION (%d) params: %" GST_PTR_FORMAT, result,
959 goto no_decide_allocation;
961 /* we got configuration from our peer or the decide_allocation method,
963 if (gst_query_get_n_allocation_params (query) > 0) {
964 gst_query_parse_nth_allocation_param (query, 0, &allocator, ¶ms);
967 gst_allocation_params_init (¶ms);
970 if (gst_query_get_n_allocation_pools (query) > 0)
971 gst_query_parse_nth_allocation_pool (query, 0, &pool, NULL, NULL, NULL);
975 gst_aggregator_set_allocation (self, pool, allocator, ¶ms, query);
980 no_decide_allocation:
982 GST_WARNING_OBJECT (self, "Failed to decide allocation");
983 gst_query_unref (query);
990 /* WITH SRC_LOCK held */
992 gst_aggregator_update_src_caps (GstAggregator * self)
994 GstAggregatorClass *agg_klass = GST_AGGREGATOR_GET_CLASS (self);
995 GstCaps *downstream_caps, *template_caps, *caps = NULL;
996 GstFlowReturn ret = GST_FLOW_OK;
998 template_caps = gst_pad_get_pad_template_caps (self->srcpad);
999 downstream_caps = gst_pad_peer_query_caps (self->srcpad, template_caps);
1001 if (gst_caps_is_empty (downstream_caps)) {
1002 GST_INFO_OBJECT (self, "Downstream caps (%"
1003 GST_PTR_FORMAT ") not compatible with pad template caps (%"
1004 GST_PTR_FORMAT ")", downstream_caps, template_caps);
1005 ret = GST_FLOW_NOT_NEGOTIATED;
1009 g_assert (agg_klass->update_src_caps);
1010 GST_DEBUG_OBJECT (self, "updating caps from %" GST_PTR_FORMAT,
1012 ret = agg_klass->update_src_caps (self, downstream_caps, &caps);
1013 if (ret < GST_FLOW_OK) {
1014 GST_WARNING_OBJECT (self, "Subclass failed to update provided caps");
1017 if ((caps == NULL || gst_caps_is_empty (caps)) && ret >= GST_FLOW_OK) {
1018 ret = GST_FLOW_NOT_NEGOTIATED;
1021 GST_DEBUG_OBJECT (self, " to %" GST_PTR_FORMAT, caps);
1023 #ifdef GST_ENABLE_EXTRA_CHECKS
1024 if (!gst_caps_is_subset (caps, template_caps)) {
1025 GstCaps *intersection;
1027 GST_ERROR_OBJECT (self,
1028 "update_src_caps returned caps %" GST_PTR_FORMAT
1029 " which are not a real subset of the template caps %"
1030 GST_PTR_FORMAT, caps, template_caps);
1031 g_warning ("%s: update_src_caps returned caps which are not a real "
1032 "subset of the filter caps", GST_ELEMENT_NAME (self));
1035 gst_caps_intersect_full (template_caps, caps, GST_CAPS_INTERSECT_FIRST);
1036 gst_caps_unref (caps);
1037 caps = intersection;
1041 if (gst_caps_is_any (caps)) {
1045 if (!gst_caps_is_fixed (caps)) {
1046 g_assert (agg_klass->fixate_src_caps);
1048 GST_DEBUG_OBJECT (self, "fixate caps from %" GST_PTR_FORMAT, caps);
1049 if (!(caps = agg_klass->fixate_src_caps (self, caps))) {
1050 GST_WARNING_OBJECT (self, "Subclass failed to fixate provided caps");
1051 ret = GST_FLOW_NOT_NEGOTIATED;
1054 GST_DEBUG_OBJECT (self, " to %" GST_PTR_FORMAT, caps);
1057 if (agg_klass->negotiated_src_caps) {
1058 if (!agg_klass->negotiated_src_caps (self, caps)) {
1059 GST_WARNING_OBJECT (self, "Subclass failed to accept negotiated caps");
1060 ret = GST_FLOW_NOT_NEGOTIATED;
1065 gst_aggregator_set_src_caps (self, caps);
1067 if (!gst_aggregator_do_allocation (self, caps)) {
1068 GST_WARNING_OBJECT (self, "Allocation negotiation failed");
1069 ret = GST_FLOW_NOT_NEGOTIATED;
1073 gst_caps_unref (downstream_caps);
1074 gst_caps_unref (template_caps);
1077 gst_caps_unref (caps);
1083 gst_aggregator_aggregate_func (GstAggregator * self)
1085 GstAggregatorPrivate *priv = self->priv;
1086 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
1087 gboolean timeout = FALSE;
1089 if (self->priv->running == FALSE) {
1090 GST_DEBUG_OBJECT (self, "Not running anymore");
1094 GST_LOG_OBJECT (self, "Checking aggregate");
1095 while (priv->send_eos && priv->running) {
1096 GstFlowReturn flow_return = GST_FLOW_OK;
1097 gboolean processed_event = FALSE;
1099 gst_aggregator_iterate_sinkpads (self, do_events_and_queries, NULL);
1101 if (!gst_aggregator_wait_and_check (self, &timeout))
1104 gst_aggregator_iterate_sinkpads (self, do_events_and_queries,
1106 if (processed_event)
1109 if (gst_pad_check_reconfigure (GST_AGGREGATOR_SRC_PAD (self))) {
1110 flow_return = gst_aggregator_update_src_caps (self);
1111 if (flow_return != GST_FLOW_OK)
1112 gst_pad_mark_reconfigure (GST_AGGREGATOR_SRC_PAD (self));
1115 if (timeout || flow_return >= GST_FLOW_OK) {
1116 GST_TRACE_OBJECT (self, "Actually aggregating!");
1117 flow_return = klass->aggregate (self, timeout);
1120 if (flow_return == GST_AGGREGATOR_FLOW_NEED_DATA)
1123 GST_OBJECT_LOCK (self);
1124 if (flow_return == GST_FLOW_FLUSHING && priv->flush_seeking) {
1125 /* We don't want to set the pads to flushing, but we want to
1126 * stop the thread, so just break here */
1127 GST_OBJECT_UNLOCK (self);
1130 GST_OBJECT_UNLOCK (self);
1132 if (flow_return == GST_FLOW_EOS || flow_return == GST_FLOW_ERROR) {
1133 gst_aggregator_push_eos (self);
1136 GST_LOG_OBJECT (self, "flow return is %s", gst_flow_get_name (flow_return));
1138 if (flow_return != GST_FLOW_OK) {
1141 GST_OBJECT_LOCK (self);
1142 for (item = GST_ELEMENT (self)->sinkpads; item; item = item->next) {
1143 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (item->data);
1145 gst_aggregator_pad_set_flushing (aggpad, flow_return, TRUE);
1147 GST_OBJECT_UNLOCK (self);
1152 /* Pause the task here, the only ways to get here are:
1153 * 1) We're stopping, in which case the task is stopped anyway
1154 * 2) We got a flow error above, in which case it might take
1155 * some time to forward the flow return upstream and we
1156 * would otherwise call the task function over and over
1157 * again without doing anything
1159 gst_pad_pause_task (self->srcpad);
1163 gst_aggregator_start (GstAggregator * self)
1165 GstAggregatorClass *klass;
1168 self->priv->send_stream_start = TRUE;
1169 self->priv->send_segment = TRUE;
1170 self->priv->send_eos = TRUE;
1171 self->priv->srccaps = NULL;
1173 gst_aggregator_set_allocation (self, NULL, NULL, NULL, NULL);
1175 klass = GST_AGGREGATOR_GET_CLASS (self);
1178 result = klass->start (self);
1186 _check_pending_flush_stop (GstAggregatorPad * pad)
1191 res = (!pad->priv->pending_flush_stop && !pad->priv->pending_flush_start);
1198 gst_aggregator_stop_srcpad_task (GstAggregator * self, GstEvent * flush_start)
1200 gboolean res = TRUE;
1202 GST_INFO_OBJECT (self, "%s srcpad task",
1203 flush_start ? "Pausing" : "Stopping");
1206 self->priv->running = FALSE;
1207 SRC_BROADCAST (self);
1211 res = gst_pad_push_event (self->srcpad, flush_start);
1214 gst_pad_stop_task (self->srcpad);
1220 gst_aggregator_start_srcpad_task (GstAggregator * self)
1222 GST_INFO_OBJECT (self, "Starting srcpad task");
1224 self->priv->running = TRUE;
1225 gst_pad_start_task (GST_PAD (self->srcpad),
1226 (GstTaskFunction) gst_aggregator_aggregate_func, self, NULL);
1229 static GstFlowReturn
1230 gst_aggregator_flush (GstAggregator * self)
1232 GstFlowReturn ret = GST_FLOW_OK;
1233 GstAggregatorPrivate *priv = self->priv;
1234 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
1236 GST_DEBUG_OBJECT (self, "Flushing everything");
1237 GST_OBJECT_LOCK (self);
1238 priv->send_segment = TRUE;
1239 priv->flush_seeking = FALSE;
1240 priv->tags_changed = FALSE;
1241 GST_OBJECT_UNLOCK (self);
1243 ret = klass->flush (self);
1249 /* Called with GstAggregator's object lock held */
1252 gst_aggregator_all_flush_stop_received_locked (GstAggregator * self)
1255 GstAggregatorPad *tmppad;
1257 for (tmp = GST_ELEMENT (self)->sinkpads; tmp; tmp = tmp->next) {
1258 tmppad = (GstAggregatorPad *) tmp->data;
1260 if (_check_pending_flush_stop (tmppad) == FALSE) {
1261 GST_DEBUG_OBJECT (tmppad, "Is not last %i -- %i",
1262 tmppad->priv->pending_flush_start, tmppad->priv->pending_flush_stop);
1271 gst_aggregator_flush_start (GstAggregator * self, GstAggregatorPad * aggpad,
1274 GstAggregatorPrivate *priv = self->priv;
1275 GstAggregatorPadPrivate *padpriv = aggpad->priv;
1277 gst_aggregator_pad_set_flushing (aggpad, GST_FLOW_FLUSHING, FALSE);
1279 PAD_FLUSH_LOCK (aggpad);
1281 if (padpriv->pending_flush_start) {
1282 GST_DEBUG_OBJECT (aggpad, "Expecting FLUSH_STOP now");
1284 padpriv->pending_flush_start = FALSE;
1285 padpriv->pending_flush_stop = TRUE;
1287 PAD_UNLOCK (aggpad);
1289 GST_OBJECT_LOCK (self);
1290 if (priv->flush_seeking) {
1291 /* If flush_seeking we forward the first FLUSH_START */
1292 if (priv->pending_flush_start) {
1293 priv->pending_flush_start = FALSE;
1294 GST_OBJECT_UNLOCK (self);
1296 GST_INFO_OBJECT (self, "Flushing, pausing srcpad task");
1297 gst_aggregator_stop_srcpad_task (self, event);
1299 GST_INFO_OBJECT (self, "Getting STREAM_LOCK while seeking");
1300 GST_PAD_STREAM_LOCK (self->srcpad);
1301 GST_LOG_OBJECT (self, "GOT STREAM_LOCK");
1304 GST_OBJECT_UNLOCK (self);
1305 gst_event_unref (event);
1308 GST_OBJECT_UNLOCK (self);
1309 gst_event_unref (event);
1311 PAD_FLUSH_UNLOCK (aggpad);
1314 /* Must be called with the the PAD_LOCK held */
1316 update_time_level (GstAggregatorPad * aggpad, gboolean head)
1319 if (GST_CLOCK_TIME_IS_VALID (aggpad->priv->head_position) &&
1320 aggpad->priv->head_segment.format == GST_FORMAT_TIME)
1321 aggpad->priv->head_time =
1322 gst_segment_to_running_time (&aggpad->priv->head_segment,
1323 GST_FORMAT_TIME, aggpad->priv->head_position);
1325 aggpad->priv->head_time = GST_CLOCK_TIME_NONE;
1327 if (!GST_CLOCK_TIME_IS_VALID (aggpad->priv->tail_time))
1328 aggpad->priv->tail_time = aggpad->priv->head_time;
1330 if (GST_CLOCK_TIME_IS_VALID (aggpad->priv->tail_position) &&
1331 aggpad->segment.format == GST_FORMAT_TIME)
1332 aggpad->priv->tail_time =
1333 gst_segment_to_running_time (&aggpad->segment,
1334 GST_FORMAT_TIME, aggpad->priv->tail_position);
1336 aggpad->priv->tail_time = aggpad->priv->head_time;
1339 if (aggpad->priv->head_time == GST_CLOCK_TIME_NONE ||
1340 aggpad->priv->tail_time == GST_CLOCK_TIME_NONE) {
1341 aggpad->priv->time_level = 0;
1345 if (aggpad->priv->tail_time > aggpad->priv->head_time)
1346 aggpad->priv->time_level = 0;
1348 aggpad->priv->time_level = aggpad->priv->head_time -
1349 aggpad->priv->tail_time;
1353 /* GstAggregator vmethods default implementations */
1355 gst_aggregator_default_sink_event (GstAggregator * self,
1356 GstAggregatorPad * aggpad, GstEvent * event)
1358 gboolean res = TRUE;
1359 GstPad *pad = GST_PAD (aggpad);
1360 GstAggregatorPrivate *priv = self->priv;
1362 GST_DEBUG_OBJECT (aggpad, "Got event: %" GST_PTR_FORMAT, event);
1364 switch (GST_EVENT_TYPE (event)) {
1365 case GST_EVENT_FLUSH_START:
1367 gst_aggregator_flush_start (self, aggpad, event);
1368 /* We forward only in one case: right after flush_seeking */
1372 case GST_EVENT_FLUSH_STOP:
1374 gst_aggregator_pad_flush (aggpad, self);
1375 GST_OBJECT_LOCK (self);
1376 if (priv->flush_seeking) {
1377 g_atomic_int_set (&aggpad->priv->pending_flush_stop, FALSE);
1378 if (gst_aggregator_all_flush_stop_received_locked (self)) {
1379 GST_OBJECT_UNLOCK (self);
1380 /* That means we received FLUSH_STOP/FLUSH_STOP on
1381 * all sinkpads -- Seeking is Done... sending FLUSH_STOP */
1382 gst_aggregator_flush (self);
1383 gst_pad_push_event (self->srcpad, event);
1386 priv->send_eos = TRUE;
1387 SRC_BROADCAST (self);
1390 GST_INFO_OBJECT (self, "Releasing source pad STREAM_LOCK");
1391 GST_PAD_STREAM_UNLOCK (self->srcpad);
1392 gst_aggregator_start_srcpad_task (self);
1394 GST_OBJECT_UNLOCK (self);
1397 GST_OBJECT_UNLOCK (self);
1400 /* We never forward the event */
1405 /* We still have a buffer, and we don't want the subclass to have to
1406 * check for it. Mark pending_eos, eos will be set when steal_buffer is
1411 if (aggpad->priv->num_buffers == 0) {
1412 aggpad->priv->eos = TRUE;
1414 aggpad->priv->pending_eos = TRUE;
1416 PAD_UNLOCK (aggpad);
1418 SRC_BROADCAST (self);
1422 case GST_EVENT_SEGMENT:
1425 GST_OBJECT_LOCK (aggpad);
1426 gst_event_copy_segment (event, &aggpad->segment);
1427 /* We've got a new segment, tail_position is now meaningless
1428 * and may interfere with the time_level calculation
1430 aggpad->priv->tail_position = GST_CLOCK_TIME_NONE;
1431 update_time_level (aggpad, FALSE);
1432 GST_OBJECT_UNLOCK (aggpad);
1433 PAD_UNLOCK (aggpad);
1435 GST_OBJECT_LOCK (self);
1436 self->priv->seqnum = gst_event_get_seqnum (event);
1437 GST_OBJECT_UNLOCK (self);
1440 case GST_EVENT_STREAM_START:
1446 GstClockTime pts, endpts;
1447 GstClockTime duration;
1450 gst_event_parse_gap (event, &pts, &duration);
1451 gapbuf = gst_buffer_new ();
1453 if (GST_CLOCK_TIME_IS_VALID (duration))
1454 endpts = pts + duration;
1456 endpts = GST_CLOCK_TIME_NONE;
1458 GST_OBJECT_LOCK (aggpad);
1459 res = gst_segment_clip (&aggpad->segment, GST_FORMAT_TIME, pts, endpts,
1461 GST_OBJECT_UNLOCK (aggpad);
1464 GST_WARNING_OBJECT (self, "GAP event outside segment, dropping");
1468 if (GST_CLOCK_TIME_IS_VALID (endpts) && GST_CLOCK_TIME_IS_VALID (pts))
1469 duration = endpts - pts;
1471 duration = GST_CLOCK_TIME_NONE;
1473 GST_BUFFER_PTS (gapbuf) = pts;
1474 GST_BUFFER_DURATION (gapbuf) = duration;
1475 GST_BUFFER_FLAG_SET (gapbuf, GST_BUFFER_FLAG_GAP);
1476 GST_BUFFER_FLAG_SET (gapbuf, GST_BUFFER_FLAG_DROPPABLE);
1478 /* Remove GAP event so we can replace it with the buffer */
1479 if (g_queue_peek_tail (&aggpad->priv->data) == event)
1480 gst_event_unref (g_queue_pop_tail (&aggpad->priv->data));
1482 if (gst_aggregator_pad_chain_internal (self, aggpad, gapbuf, FALSE) !=
1484 GST_WARNING_OBJECT (self, "Failed to chain gap buffer");
1494 gst_event_parse_tag (event, &tags);
1496 if (gst_tag_list_get_scope (tags) == GST_TAG_SCOPE_STREAM) {
1497 gst_aggregator_merge_tags (self, tags, GST_TAG_MERGE_REPLACE);
1498 gst_event_unref (event);
1510 GST_DEBUG_OBJECT (pad, "Forwarding event: %" GST_PTR_FORMAT, event);
1511 return gst_pad_event_default (pad, GST_OBJECT (self), event);
1514 GST_DEBUG_OBJECT (pad, "Eating event: %" GST_PTR_FORMAT, event);
1516 gst_event_unref (event);
1521 static inline gboolean
1522 gst_aggregator_stop_pad (GstAggregator * self, GstAggregatorPad * pad,
1523 gpointer unused_udata)
1525 gst_aggregator_pad_flush (pad, self);
1528 pad->priv->flow_return = GST_FLOW_FLUSHING;
1529 pad->priv->negotiated = FALSE;
1530 PAD_BROADCAST_EVENT (pad);
1537 gst_aggregator_stop (GstAggregator * agg)
1539 GstAggregatorClass *klass;
1542 gst_aggregator_reset_flow_values (agg);
1544 gst_aggregator_iterate_sinkpads (agg, gst_aggregator_stop_pad, NULL);
1546 klass = GST_AGGREGATOR_GET_CLASS (agg);
1549 result = klass->stop (agg);
1553 agg->priv->has_peer_latency = FALSE;
1554 agg->priv->peer_latency_live = FALSE;
1555 agg->priv->peer_latency_min = agg->priv->peer_latency_max = FALSE;
1557 if (agg->priv->tags)
1558 gst_tag_list_unref (agg->priv->tags);
1559 agg->priv->tags = NULL;
1561 gst_aggregator_set_allocation (agg, NULL, NULL, NULL, NULL);
1566 /* GstElement vmethods implementations */
1567 static GstStateChangeReturn
1568 gst_aggregator_change_state (GstElement * element, GstStateChange transition)
1570 GstStateChangeReturn ret;
1571 GstAggregator *self = GST_AGGREGATOR (element);
1573 switch (transition) {
1574 case GST_STATE_CHANGE_READY_TO_PAUSED:
1575 if (!gst_aggregator_start (self))
1583 GST_ELEMENT_CLASS (aggregator_parent_class)->change_state (element,
1584 transition)) == GST_STATE_CHANGE_FAILURE)
1588 switch (transition) {
1589 case GST_STATE_CHANGE_PAUSED_TO_READY:
1590 if (!gst_aggregator_stop (self)) {
1591 /* What to do in this case? Error out? */
1592 GST_ERROR_OBJECT (self, "Subclass failed to stop.");
1604 GST_ERROR_OBJECT (element, "parent failed state change");
1609 GST_ERROR_OBJECT (element, "Subclass failed to start");
1610 return GST_STATE_CHANGE_FAILURE;
1615 gst_aggregator_release_pad (GstElement * element, GstPad * pad)
1617 GstAggregator *self = GST_AGGREGATOR (element);
1618 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1620 GST_INFO_OBJECT (pad, "Removing pad");
1623 gst_aggregator_pad_set_flushing (aggpad, GST_FLOW_FLUSHING, TRUE);
1624 gst_element_remove_pad (element, pad);
1626 self->priv->has_peer_latency = FALSE;
1627 SRC_BROADCAST (self);
1631 static GstAggregatorPad *
1632 gst_aggregator_default_create_new_pad (GstAggregator * self,
1633 GstPadTemplate * templ, const gchar * req_name, const GstCaps * caps)
1635 GstAggregatorPad *agg_pad;
1636 GstAggregatorPrivate *priv = self->priv;
1640 if (templ->direction != GST_PAD_SINK)
1643 if (templ->presence != GST_PAD_REQUEST)
1646 GST_OBJECT_LOCK (self);
1647 if (req_name == NULL || strlen (req_name) < 6
1648 || !g_str_has_prefix (req_name, "sink_")) {
1649 /* no name given when requesting the pad, use next available int */
1650 serial = ++priv->max_padserial;
1652 /* parse serial number from requested padname */
1653 serial = g_ascii_strtoull (&req_name[5], NULL, 10);
1654 if (serial > priv->max_padserial)
1655 priv->max_padserial = serial;
1658 name = g_strdup_printf ("sink_%u", serial);
1659 agg_pad = g_object_new (GST_AGGREGATOR_GET_CLASS (self)->sinkpads_type,
1660 "name", name, "direction", GST_PAD_SINK, "template", templ, NULL);
1663 GST_OBJECT_UNLOCK (self);
1670 GST_WARNING_OBJECT (self, "request new pad that is not a SINK pad");
1675 GST_WARNING_OBJECT (self, "request new pad that is not a REQUEST pad");
1681 gst_aggregator_request_new_pad (GstElement * element,
1682 GstPadTemplate * templ, const gchar * req_name, const GstCaps * caps)
1684 GstAggregator *self;
1685 GstAggregatorPad *agg_pad;
1686 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (element);
1687 GstAggregatorPrivate *priv = GST_AGGREGATOR (element)->priv;
1689 self = GST_AGGREGATOR (element);
1691 agg_pad = klass->create_new_pad (self, templ, req_name, caps);
1693 GST_ERROR_OBJECT (element, "Couldn't create new pad");
1697 GST_DEBUG_OBJECT (element, "Adding pad %s", GST_PAD_NAME (agg_pad));
1700 gst_pad_set_active (GST_PAD (agg_pad), TRUE);
1702 /* add the pad to the element */
1703 gst_element_add_pad (element, GST_PAD (agg_pad));
1705 return GST_PAD (agg_pad);
1708 /* Must be called with SRC_LOCK held */
1711 gst_aggregator_query_latency_unlocked (GstAggregator * self, GstQuery * query)
1713 gboolean query_ret, live;
1714 GstClockTime our_latency, min, max;
1716 query_ret = gst_pad_query_default (self->srcpad, GST_OBJECT (self), query);
1719 GST_WARNING_OBJECT (self, "Latency query failed");
1723 gst_query_parse_latency (query, &live, &min, &max);
1725 our_latency = self->priv->latency;
1727 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (min))) {
1728 GST_ERROR_OBJECT (self, "Invalid minimum latency %" GST_TIME_FORMAT
1729 ". Please file a bug at " PACKAGE_BUGREPORT ".", GST_TIME_ARGS (min));
1733 if (min > max && GST_CLOCK_TIME_IS_VALID (max)) {
1734 GST_ELEMENT_WARNING (self, CORE, CLOCK, (NULL),
1735 ("Impossible to configure latency: max %" GST_TIME_FORMAT " < min %"
1736 GST_TIME_FORMAT ". Add queues or other buffering elements.",
1737 GST_TIME_ARGS (max), GST_TIME_ARGS (min)));
1741 self->priv->peer_latency_live = live;
1742 self->priv->peer_latency_min = min;
1743 self->priv->peer_latency_max = max;
1744 self->priv->has_peer_latency = TRUE;
1748 min += self->priv->sub_latency_min;
1749 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max)
1750 && GST_CLOCK_TIME_IS_VALID (max))
1751 max += self->priv->sub_latency_max + our_latency;
1753 max = GST_CLOCK_TIME_NONE;
1755 SRC_BROADCAST (self);
1757 GST_DEBUG_OBJECT (self, "configured latency live:%s min:%" G_GINT64_FORMAT
1758 " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
1760 gst_query_set_latency (query, live, min, max);
1766 * MUST be called with the src_lock held.
1768 * See gst_aggregator_get_latency() for doc
1771 gst_aggregator_get_latency_unlocked (GstAggregator * self)
1773 GstClockTime latency;
1775 g_return_val_if_fail (GST_IS_AGGREGATOR (self), 0);
1777 if (!self->priv->has_peer_latency) {
1778 GstQuery *query = gst_query_new_latency ();
1781 ret = gst_aggregator_query_latency_unlocked (self, query);
1782 gst_query_unref (query);
1784 return GST_CLOCK_TIME_NONE;
1787 if (!self->priv->has_peer_latency || !self->priv->peer_latency_live)
1788 return GST_CLOCK_TIME_NONE;
1790 /* latency_min is never GST_CLOCK_TIME_NONE by construction */
1791 latency = self->priv->peer_latency_min;
1794 latency += self->priv->latency;
1795 latency += self->priv->sub_latency_min;
1801 * gst_aggregator_get_latency:
1802 * @self: a #GstAggregator
1804 * Retrieves the latency values reported by @self in response to the latency
1805 * query, or %GST_CLOCK_TIME_NONE if there is not live source connected and the element
1806 * will not wait for the clock.
1808 * Typically only called by subclasses.
1810 * Returns: The latency or %GST_CLOCK_TIME_NONE if the element does not sync
1813 gst_aggregator_get_latency (GstAggregator * self)
1818 ret = gst_aggregator_get_latency_unlocked (self);
1825 gst_aggregator_send_event (GstElement * element, GstEvent * event)
1827 GstAggregator *self = GST_AGGREGATOR (element);
1829 GST_STATE_LOCK (element);
1830 if (GST_EVENT_TYPE (event) == GST_EVENT_SEEK &&
1831 GST_STATE (element) < GST_STATE_PAUSED) {
1835 GstSeekType start_type, stop_type;
1838 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1839 &start, &stop_type, &stop);
1841 GST_OBJECT_LOCK (self);
1842 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
1843 stop_type, stop, NULL);
1844 self->priv->seqnum = gst_event_get_seqnum (event);
1845 self->priv->first_buffer = FALSE;
1846 GST_OBJECT_UNLOCK (self);
1848 GST_DEBUG_OBJECT (element, "Storing segment %" GST_PTR_FORMAT, event);
1850 GST_STATE_UNLOCK (element);
1853 return GST_ELEMENT_CLASS (aggregator_parent_class)->send_event (element,
1858 gst_aggregator_default_src_query (GstAggregator * self, GstQuery * query)
1860 gboolean res = TRUE;
1862 switch (GST_QUERY_TYPE (query)) {
1863 case GST_QUERY_SEEKING:
1867 /* don't pass it along as some (file)sink might claim it does
1868 * whereas with a collectpads in between that will not likely work */
1869 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
1870 gst_query_set_seeking (query, format, FALSE, 0, -1);
1875 case GST_QUERY_LATENCY:
1877 res = gst_aggregator_query_latency_unlocked (self, query);
1881 return gst_pad_query_default (self->srcpad, GST_OBJECT (self), query);
1888 gst_aggregator_event_forward_func (GstPad * pad, gpointer user_data)
1890 EventData *evdata = user_data;
1891 gboolean ret = TRUE;
1892 GstPad *peer = gst_pad_get_peer (pad);
1893 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1896 if (evdata->only_to_active_pads && aggpad->priv->first_buffer) {
1897 GST_DEBUG_OBJECT (pad, "not sending event to inactive pad");
1900 ret = gst_pad_send_event (peer, gst_event_ref (evdata->event));
1901 GST_DEBUG_OBJECT (pad, "return of event push is %d", ret);
1902 gst_object_unref (peer);
1907 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK) {
1908 GstQuery *seeking = gst_query_new_seeking (GST_FORMAT_TIME);
1910 GST_DEBUG_OBJECT (pad, "Event %" GST_PTR_FORMAT " failed", evdata->event);
1912 if (gst_pad_query (peer, seeking)) {
1915 gst_query_parse_seeking (seeking, NULL, &seekable, NULL, NULL);
1917 if (seekable == FALSE) {
1918 GST_INFO_OBJECT (pad,
1919 "Source not seekable, We failed but it does not matter!");
1924 GST_ERROR_OBJECT (pad, "Query seeking FAILED");
1927 gst_query_unref (seeking);
1930 if (evdata->flush) {
1932 aggpad->priv->pending_flush_start = FALSE;
1933 aggpad->priv->pending_flush_stop = FALSE;
1934 PAD_UNLOCK (aggpad);
1937 evdata->one_actually_seeked = TRUE;
1940 evdata->result &= ret;
1942 /* Always send to all pads */
1947 gst_aggregator_forward_event_to_all_sinkpads (GstAggregator * self,
1948 GstEvent * event, gboolean flush, gboolean only_to_active_pads)
1952 evdata.event = event;
1953 evdata.result = TRUE;
1954 evdata.flush = flush;
1955 evdata.one_actually_seeked = FALSE;
1956 evdata.only_to_active_pads = only_to_active_pads;
1958 /* We first need to set all pads as flushing in a first pass
1959 * as flush_start flush_stop is sometimes sent synchronously
1960 * while we send the seek event */
1964 GST_OBJECT_LOCK (self);
1965 for (l = GST_ELEMENT_CAST (self)->sinkpads; l != NULL; l = l->next) {
1966 GstAggregatorPad *pad = l->data;
1969 pad->priv->pending_flush_start = TRUE;
1970 pad->priv->pending_flush_stop = FALSE;
1973 GST_OBJECT_UNLOCK (self);
1976 gst_pad_forward (self->srcpad, gst_aggregator_event_forward_func, &evdata);
1978 gst_event_unref (event);
1984 gst_aggregator_do_seek (GstAggregator * self, GstEvent * event)
1989 GstSeekType start_type, stop_type;
1993 GstAggregatorPrivate *priv = self->priv;
1995 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1996 &start, &stop_type, &stop);
1998 GST_INFO_OBJECT (self, "starting SEEK");
2000 flush = flags & GST_SEEK_FLAG_FLUSH;
2002 GST_OBJECT_LOCK (self);
2004 priv->pending_flush_start = TRUE;
2005 priv->flush_seeking = TRUE;
2008 gst_segment_do_seek (&self->segment, rate, fmt, flags, start_type, start,
2009 stop_type, stop, NULL);
2011 /* Seeking sets a position */
2012 self->priv->first_buffer = FALSE;
2013 GST_OBJECT_UNLOCK (self);
2015 /* forward the seek upstream */
2017 gst_aggregator_forward_event_to_all_sinkpads (self, event, flush, FALSE);
2020 if (!evdata.result || !evdata.one_actually_seeked) {
2021 GST_OBJECT_LOCK (self);
2022 priv->flush_seeking = FALSE;
2023 priv->pending_flush_start = FALSE;
2024 GST_OBJECT_UNLOCK (self);
2027 GST_INFO_OBJECT (self, "seek done, result: %d", evdata.result);
2029 return evdata.result;
2033 gst_aggregator_default_src_event (GstAggregator * self, GstEvent * event)
2036 gboolean res = TRUE;
2038 switch (GST_EVENT_TYPE (event)) {
2039 case GST_EVENT_SEEK:
2041 gst_event_ref (event);
2042 res = gst_aggregator_do_seek (self, event);
2043 gst_event_unref (event);
2047 case GST_EVENT_NAVIGATION:
2049 /* navigation is rather pointless. */
2051 gst_event_unref (event);
2060 /* Don't forward QOS events to pads that had no active buffer yet. Otherwise
2061 * they will receive a QOS event that has earliest_time=0 (because we can't
2062 * have negative timestamps), and consider their buffer as too late */
2064 gst_aggregator_forward_event_to_all_sinkpads (self, event, FALSE,
2065 GST_EVENT_TYPE (event) == GST_EVENT_QOS);
2066 res = evdata.result;
2073 gst_aggregator_src_pad_event_func (GstPad * pad, GstObject * parent,
2076 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
2078 return klass->src_event (GST_AGGREGATOR (parent), event);
2082 gst_aggregator_src_pad_query_func (GstPad * pad, GstObject * parent,
2085 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
2087 return klass->src_query (GST_AGGREGATOR (parent), query);
2091 gst_aggregator_src_pad_activate_mode_func (GstPad * pad,
2092 GstObject * parent, GstPadMode mode, gboolean active)
2094 GstAggregator *self = GST_AGGREGATOR (parent);
2095 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
2097 if (klass->src_activate) {
2098 if (klass->src_activate (self, mode, active) == FALSE) {
2103 if (active == TRUE) {
2105 case GST_PAD_MODE_PUSH:
2107 GST_INFO_OBJECT (pad, "Activating pad!");
2108 gst_aggregator_start_srcpad_task (self);
2113 GST_ERROR_OBJECT (pad, "Only supported mode is PUSH");
2120 GST_INFO_OBJECT (self, "Deactivating srcpad");
2121 gst_aggregator_stop_srcpad_task (self, FALSE);
2127 gst_aggregator_default_sink_query (GstAggregator * self,
2128 GstAggregatorPad * aggpad, GstQuery * query)
2130 GstPad *pad = GST_PAD (aggpad);
2132 if (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION) {
2133 GstQuery *decide_query = NULL;
2134 GstAggregatorClass *agg_class;
2137 GST_OBJECT_LOCK (self);
2139 if (G_UNLIKELY (!aggpad->priv->negotiated)) {
2140 GST_DEBUG_OBJECT (self,
2141 "not negotiated yet, can't answer ALLOCATION query");
2142 PAD_UNLOCK (aggpad);
2143 GST_OBJECT_UNLOCK (self);
2148 if ((decide_query = self->priv->allocation_query))
2149 gst_query_ref (decide_query);
2150 PAD_UNLOCK (aggpad);
2151 GST_OBJECT_UNLOCK (self);
2153 GST_DEBUG_OBJECT (self,
2154 "calling propose allocation with query %" GST_PTR_FORMAT, decide_query);
2156 agg_class = GST_AGGREGATOR_GET_CLASS (self);
2158 /* pass the query to the propose_allocation vmethod if any */
2159 if (agg_class->propose_allocation)
2160 ret = agg_class->propose_allocation (self, aggpad, decide_query, query);
2165 gst_query_unref (decide_query);
2167 GST_DEBUG_OBJECT (self, "ALLOCATION ret %d, %" GST_PTR_FORMAT, ret, query);
2171 return gst_pad_query_default (pad, GST_OBJECT (self), query);
2175 gst_aggregator_finalize (GObject * object)
2177 GstAggregator *self = (GstAggregator *) object;
2179 g_mutex_clear (&self->priv->src_lock);
2180 g_cond_clear (&self->priv->src_cond);
2182 G_OBJECT_CLASS (aggregator_parent_class)->finalize (object);
2186 * gst_aggregator_set_latency_property:
2187 * @agg: a #GstAggregator
2188 * @latency: the new latency value (in nanoseconds).
2190 * Sets the new latency value to @latency. This value is used to limit the
2191 * amount of time a pad waits for data to appear before considering the pad
2195 gst_aggregator_set_latency_property (GstAggregator * self, gint64 latency)
2199 g_return_if_fail (GST_IS_AGGREGATOR (self));
2200 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (latency));
2203 changed = (self->priv->latency != latency);
2208 GST_OBJECT_LOCK (self);
2209 /* First lock all the pads */
2210 for (item = GST_ELEMENT_CAST (self)->sinkpads; item; item = item->next) {
2211 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (item->data);
2215 self->priv->latency = latency;
2217 SRC_BROADCAST (self);
2219 /* Now wake up the pads */
2220 for (item = GST_ELEMENT_CAST (self)->sinkpads; item; item = item->next) {
2221 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (item->data);
2222 PAD_BROADCAST_EVENT (aggpad);
2223 PAD_UNLOCK (aggpad);
2225 GST_OBJECT_UNLOCK (self);
2231 gst_element_post_message (GST_ELEMENT_CAST (self),
2232 gst_message_new_latency (GST_OBJECT_CAST (self)));
2236 * gst_aggregator_get_latency_property:
2237 * @agg: a #GstAggregator
2239 * Gets the latency value. See gst_aggregator_set_latency for
2242 * Returns: The time in nanoseconds to wait for data to arrive on a sink pad
2243 * before a pad is deemed unresponsive. A value of -1 means an
2247 gst_aggregator_get_latency_property (GstAggregator * agg)
2251 g_return_val_if_fail (GST_IS_AGGREGATOR (agg), -1);
2253 GST_OBJECT_LOCK (agg);
2254 res = agg->priv->latency;
2255 GST_OBJECT_UNLOCK (agg);
2261 gst_aggregator_set_property (GObject * object, guint prop_id,
2262 const GValue * value, GParamSpec * pspec)
2264 GstAggregator *agg = GST_AGGREGATOR (object);
2268 gst_aggregator_set_latency_property (agg, g_value_get_int64 (value));
2270 case PROP_START_TIME_SELECTION:
2271 agg->priv->start_time_selection = g_value_get_enum (value);
2273 case PROP_START_TIME:
2274 agg->priv->start_time = g_value_get_uint64 (value);
2277 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2283 gst_aggregator_get_property (GObject * object, guint prop_id,
2284 GValue * value, GParamSpec * pspec)
2286 GstAggregator *agg = GST_AGGREGATOR (object);
2290 g_value_set_int64 (value, gst_aggregator_get_latency_property (agg));
2292 case PROP_START_TIME_SELECTION:
2293 g_value_set_enum (value, agg->priv->start_time_selection);
2295 case PROP_START_TIME:
2296 g_value_set_uint64 (value, agg->priv->start_time);
2299 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2304 /* GObject vmethods implementations */
2306 gst_aggregator_class_init (GstAggregatorClass * klass)
2308 GObjectClass *gobject_class = (GObjectClass *) klass;
2309 GstElementClass *gstelement_class = (GstElementClass *) klass;
2311 aggregator_parent_class = g_type_class_peek_parent (klass);
2312 g_type_class_add_private (klass, sizeof (GstAggregatorPrivate));
2314 GST_DEBUG_CATEGORY_INIT (aggregator_debug, "aggregator",
2315 GST_DEBUG_FG_MAGENTA, "GstAggregator");
2317 klass->sinkpads_type = GST_TYPE_AGGREGATOR_PAD;
2319 klass->sink_event = gst_aggregator_default_sink_event;
2320 klass->sink_query = gst_aggregator_default_sink_query;
2322 klass->src_event = gst_aggregator_default_src_event;
2323 klass->src_query = gst_aggregator_default_src_query;
2325 klass->create_new_pad = gst_aggregator_default_create_new_pad;
2326 klass->update_src_caps = gst_aggregator_default_update_src_caps;
2327 klass->fixate_src_caps = gst_aggregator_default_fixate_src_caps;
2328 klass->negotiated_src_caps = gst_aggregator_default_negotiated_src_caps;
2330 gstelement_class->request_new_pad =
2331 GST_DEBUG_FUNCPTR (gst_aggregator_request_new_pad);
2332 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_aggregator_send_event);
2333 gstelement_class->release_pad =
2334 GST_DEBUG_FUNCPTR (gst_aggregator_release_pad);
2335 gstelement_class->change_state =
2336 GST_DEBUG_FUNCPTR (gst_aggregator_change_state);
2338 gobject_class->set_property = gst_aggregator_set_property;
2339 gobject_class->get_property = gst_aggregator_get_property;
2340 gobject_class->finalize = gst_aggregator_finalize;
2342 g_object_class_install_property (gobject_class, PROP_LATENCY,
2343 g_param_spec_int64 ("latency", "Buffer latency",
2344 "Additional latency in live mode to allow upstream "
2345 "to take longer to produce buffers for the current "
2346 "position (in nanoseconds)", 0,
2347 (G_MAXLONG == G_MAXINT64) ? G_MAXINT64 : (G_MAXLONG * GST_SECOND - 1),
2348 DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
2350 g_object_class_install_property (gobject_class, PROP_START_TIME_SELECTION,
2351 g_param_spec_enum ("start-time-selection", "Start Time Selection",
2352 "Decides which start time is output",
2353 gst_aggregator_start_time_selection_get_type (),
2354 DEFAULT_START_TIME_SELECTION,
2355 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
2357 g_object_class_install_property (gobject_class, PROP_START_TIME,
2358 g_param_spec_uint64 ("start-time", "Start Time",
2359 "Start time to use if start-time-selection=set", 0,
2361 DEFAULT_START_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
2363 GST_DEBUG_REGISTER_FUNCPTR (gst_aggregator_stop_pad);
2367 gst_aggregator_init (GstAggregator * self, GstAggregatorClass * klass)
2369 GstPadTemplate *pad_template;
2370 GstAggregatorPrivate *priv;
2372 g_return_if_fail (klass->aggregate != NULL);
2375 G_TYPE_INSTANCE_GET_PRIVATE (self, GST_TYPE_AGGREGATOR,
2376 GstAggregatorPrivate);
2381 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "src");
2382 g_return_if_fail (pad_template != NULL);
2384 priv->max_padserial = -1;
2385 priv->tags_changed = FALSE;
2387 self->priv->peer_latency_live = FALSE;
2388 self->priv->peer_latency_min = self->priv->sub_latency_min = 0;
2389 self->priv->peer_latency_max = self->priv->sub_latency_max = 0;
2390 self->priv->has_peer_latency = FALSE;
2391 gst_aggregator_reset_flow_values (self);
2393 self->srcpad = gst_pad_new_from_template (pad_template, "src");
2395 gst_pad_set_event_function (self->srcpad,
2396 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_event_func));
2397 gst_pad_set_query_function (self->srcpad,
2398 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_query_func));
2399 gst_pad_set_activatemode_function (self->srcpad,
2400 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_activate_mode_func));
2402 gst_element_add_pad (GST_ELEMENT (self), self->srcpad);
2404 self->priv->latency = DEFAULT_LATENCY;
2405 self->priv->start_time_selection = DEFAULT_START_TIME_SELECTION;
2406 self->priv->start_time = DEFAULT_START_TIME;
2408 g_mutex_init (&self->priv->src_lock);
2409 g_cond_init (&self->priv->src_cond);
2412 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
2413 * method to get to the padtemplates */
2415 gst_aggregator_get_type (void)
2417 static volatile gsize type = 0;
2419 if (g_once_init_enter (&type)) {
2421 static const GTypeInfo info = {
2422 sizeof (GstAggregatorClass),
2425 (GClassInitFunc) gst_aggregator_class_init,
2428 sizeof (GstAggregator),
2430 (GInstanceInitFunc) gst_aggregator_init,
2433 _type = g_type_register_static (GST_TYPE_ELEMENT,
2434 "GstAggregator", &info, G_TYPE_FLAG_ABSTRACT);
2435 g_once_init_leave (&type, _type);
2440 /* Must be called with SRC lock and PAD lock held */
2442 gst_aggregator_pad_has_space (GstAggregator * self, GstAggregatorPad * aggpad)
2444 /* Empty queue always has space */
2445 if (aggpad->priv->num_buffers == 0 && aggpad->priv->clipped_buffer == NULL)
2448 /* We also want at least two buffers, one is being processed and one is ready
2449 * for the next iteration when we operate in live mode. */
2450 if (self->priv->peer_latency_live && aggpad->priv->num_buffers < 2)
2453 /* zero latency, if there is a buffer, it's full */
2454 if (self->priv->latency == 0)
2457 /* Allow no more buffers than the latency */
2458 return (aggpad->priv->time_level <= self->priv->latency);
2461 /* Must be called with the PAD_LOCK held */
2463 apply_buffer (GstAggregatorPad * aggpad, GstBuffer * buffer, gboolean head)
2465 GstClockTime timestamp;
2467 if (GST_BUFFER_DTS_IS_VALID (buffer))
2468 timestamp = GST_BUFFER_DTS (buffer);
2470 timestamp = GST_BUFFER_PTS (buffer);
2472 if (timestamp == GST_CLOCK_TIME_NONE) {
2474 timestamp = aggpad->priv->head_position;
2476 timestamp = aggpad->priv->tail_position;
2480 if (GST_BUFFER_DURATION_IS_VALID (buffer))
2481 timestamp += GST_BUFFER_DURATION (buffer);
2484 aggpad->priv->head_position = timestamp;
2486 aggpad->priv->tail_position = timestamp;
2488 update_time_level (aggpad, head);
2491 static GstFlowReturn
2492 gst_aggregator_pad_chain_internal (GstAggregator * self,
2493 GstAggregatorPad * aggpad, GstBuffer * buffer, gboolean head)
2495 GstFlowReturn flow_return;
2496 GstClockTime buf_pts;
2498 GST_DEBUG_OBJECT (aggpad, "Start chaining a buffer %" GST_PTR_FORMAT, buffer);
2500 PAD_FLUSH_LOCK (aggpad);
2503 flow_return = aggpad->priv->flow_return;
2504 if (flow_return != GST_FLOW_OK)
2507 if (aggpad->priv->pending_eos == TRUE)
2510 PAD_UNLOCK (aggpad);
2512 buf_pts = GST_BUFFER_PTS (buffer);
2516 GST_OBJECT_LOCK (self);
2519 if (aggpad->priv->first_buffer) {
2520 self->priv->has_peer_latency = FALSE;
2521 aggpad->priv->first_buffer = FALSE;
2524 if (gst_aggregator_pad_has_space (self, aggpad)
2525 && aggpad->priv->flow_return == GST_FLOW_OK) {
2527 g_queue_push_head (&aggpad->priv->data, buffer);
2529 g_queue_push_tail (&aggpad->priv->data, buffer);
2530 apply_buffer (aggpad, buffer, head);
2531 aggpad->priv->num_buffers++;
2533 SRC_BROADCAST (self);
2537 flow_return = aggpad->priv->flow_return;
2538 if (flow_return != GST_FLOW_OK) {
2539 GST_OBJECT_UNLOCK (self);
2543 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
2544 GST_OBJECT_UNLOCK (self);
2546 PAD_WAIT_EVENT (aggpad);
2548 PAD_UNLOCK (aggpad);
2551 if (self->priv->first_buffer) {
2552 GstClockTime start_time;
2554 switch (self->priv->start_time_selection) {
2555 case GST_AGGREGATOR_START_TIME_SELECTION_ZERO:
2559 case GST_AGGREGATOR_START_TIME_SELECTION_FIRST:
2560 GST_OBJECT_LOCK (aggpad);
2561 if (aggpad->priv->head_segment.format == GST_FORMAT_TIME) {
2562 start_time = buf_pts;
2563 if (start_time != -1) {
2564 start_time = MAX (start_time, aggpad->priv->head_segment.start);
2566 gst_segment_to_running_time (&aggpad->priv->head_segment,
2567 GST_FORMAT_TIME, start_time);
2571 GST_WARNING_OBJECT (aggpad,
2572 "Ignoring request of selecting the first start time "
2573 "as the segment is a %s segment instead of a time segment",
2574 gst_format_get_name (aggpad->segment.format));
2576 GST_OBJECT_UNLOCK (aggpad);
2578 case GST_AGGREGATOR_START_TIME_SELECTION_SET:
2579 start_time = self->priv->start_time;
2580 if (start_time == -1)
2585 if (start_time != -1) {
2586 if (self->segment.position == -1)
2587 self->segment.position = start_time;
2589 self->segment.position = MIN (start_time, self->segment.position);
2591 GST_DEBUG_OBJECT (self, "Selecting start time %" GST_TIME_FORMAT,
2592 GST_TIME_ARGS (start_time));
2596 PAD_UNLOCK (aggpad);
2597 GST_OBJECT_UNLOCK (self);
2600 PAD_FLUSH_UNLOCK (aggpad);
2602 GST_DEBUG_OBJECT (aggpad, "Done chaining");
2607 PAD_UNLOCK (aggpad);
2608 PAD_FLUSH_UNLOCK (aggpad);
2610 GST_DEBUG_OBJECT (aggpad, "Pad is %s, dropping buffer",
2611 gst_flow_get_name (flow_return));
2613 gst_buffer_unref (buffer);
2618 PAD_UNLOCK (aggpad);
2619 PAD_FLUSH_UNLOCK (aggpad);
2621 gst_buffer_unref (buffer);
2622 GST_DEBUG_OBJECT (aggpad, "We are EOS already...");
2624 return GST_FLOW_EOS;
2627 static GstFlowReturn
2628 gst_aggregator_pad_chain (GstPad * pad, GstObject * object, GstBuffer * buffer)
2630 return gst_aggregator_pad_chain_internal (GST_AGGREGATOR_CAST (object),
2631 GST_AGGREGATOR_PAD_CAST (pad), buffer, TRUE);
2635 gst_aggregator_pad_query_func (GstPad * pad, GstObject * parent,
2638 GstAggregator *self = GST_AGGREGATOR (parent);
2639 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
2640 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
2642 if (GST_QUERY_IS_SERIALIZED (query)) {
2644 gboolean ret = FALSE;
2649 if (aggpad->priv->flow_return != GST_FLOW_OK) {
2654 g_queue_push_head (&aggpad->priv->data, query);
2655 SRC_BROADCAST (self);
2658 while (!gst_aggregator_pad_queue_is_empty (aggpad)
2659 && aggpad->priv->flow_return == GST_FLOW_OK) {
2660 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
2661 PAD_WAIT_EVENT (aggpad);
2664 s = gst_query_writable_structure (query);
2665 if (gst_structure_get_boolean (s, "gst-aggregator-retval", &ret))
2666 gst_structure_remove_field (s, "gst-aggregator-retval");
2668 g_queue_remove (&aggpad->priv->data, query);
2670 if (aggpad->priv->flow_return != GST_FLOW_OK)
2673 PAD_UNLOCK (aggpad);
2678 return klass->sink_query (self, aggpad, query);
2681 GST_DEBUG_OBJECT (aggpad, "Pad is %s, dropping query",
2682 gst_flow_get_name (aggpad->priv->flow_return));
2683 PAD_UNLOCK (aggpad);
2688 static GstFlowReturn
2689 gst_aggregator_pad_event_func (GstPad * pad, GstObject * parent,
2692 GstFlowReturn ret = GST_FLOW_OK;
2693 GstAggregator *self = GST_AGGREGATOR (parent);
2694 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
2695 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
2697 if (GST_EVENT_IS_SERIALIZED (event) && GST_EVENT_TYPE (event) != GST_EVENT_EOS
2698 /* && GST_EVENT_TYPE (event) != GST_EVENT_SEGMENT_DONE */ ) {
2702 if (aggpad->priv->flow_return != GST_FLOW_OK
2703 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP) {
2704 ret = aggpad->priv->flow_return;
2708 if (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT) {
2709 GST_OBJECT_LOCK (aggpad);
2710 gst_event_copy_segment (event, &aggpad->priv->head_segment);
2711 aggpad->priv->head_position = aggpad->priv->head_segment.position;
2712 update_time_level (aggpad, TRUE);
2713 GST_OBJECT_UNLOCK (aggpad);
2716 if (GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP) {
2717 GST_DEBUG_OBJECT (aggpad, "Store event in queue: %" GST_PTR_FORMAT,
2719 g_queue_push_head (&aggpad->priv->data, event);
2721 SRC_BROADCAST (self);
2723 PAD_UNLOCK (aggpad);
2728 if (!klass->sink_event (self, aggpad, event)) {
2729 /* Copied from GstPad to convert boolean to a GstFlowReturn in
2730 * the event handling func */
2731 ret = GST_FLOW_ERROR;
2738 GST_DEBUG_OBJECT (aggpad, "Pad is %s, dropping event",
2739 gst_flow_get_name (aggpad->priv->flow_return));
2740 PAD_UNLOCK (aggpad);
2742 if (GST_EVENT_IS_STICKY (event))
2743 gst_pad_store_sticky_event (pad, event);
2744 gst_event_unref (event);
2750 gst_aggregator_pad_activate_mode_func (GstPad * pad,
2751 GstObject * parent, GstPadMode mode, gboolean active)
2753 GstAggregator *self = GST_AGGREGATOR (parent);
2754 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
2756 if (active == FALSE) {
2758 gst_aggregator_pad_set_flushing (aggpad, GST_FLOW_FLUSHING, TRUE);
2759 SRC_BROADCAST (self);
2763 aggpad->priv->flow_return = GST_FLOW_OK;
2764 PAD_BROADCAST_EVENT (aggpad);
2765 PAD_UNLOCK (aggpad);
2771 /***********************************
2772 * GstAggregatorPad implementation *
2773 ************************************/
2774 G_DEFINE_TYPE (GstAggregatorPad, gst_aggregator_pad, GST_TYPE_PAD);
2777 gst_aggregator_pad_constructed (GObject * object)
2779 GstPad *pad = GST_PAD (object);
2781 gst_pad_set_chain_function (pad,
2782 GST_DEBUG_FUNCPTR (gst_aggregator_pad_chain));
2783 gst_pad_set_event_full_function_full (pad,
2784 GST_DEBUG_FUNCPTR (gst_aggregator_pad_event_func), NULL, NULL);
2785 gst_pad_set_query_function (pad,
2786 GST_DEBUG_FUNCPTR (gst_aggregator_pad_query_func));
2787 gst_pad_set_activatemode_function (pad,
2788 GST_DEBUG_FUNCPTR (gst_aggregator_pad_activate_mode_func));
2792 gst_aggregator_pad_finalize (GObject * object)
2794 GstAggregatorPad *pad = (GstAggregatorPad *) object;
2796 g_cond_clear (&pad->priv->event_cond);
2797 g_mutex_clear (&pad->priv->flush_lock);
2798 g_mutex_clear (&pad->priv->lock);
2800 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->finalize (object);
2804 gst_aggregator_pad_dispose (GObject * object)
2806 GstAggregatorPad *pad = (GstAggregatorPad *) object;
2808 gst_aggregator_pad_set_flushing (pad, GST_FLOW_FLUSHING, TRUE);
2810 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->dispose (object);
2814 gst_aggregator_pad_class_init (GstAggregatorPadClass * klass)
2816 GObjectClass *gobject_class = (GObjectClass *) klass;
2818 g_type_class_add_private (klass, sizeof (GstAggregatorPadPrivate));
2820 gobject_class->constructed = gst_aggregator_pad_constructed;
2821 gobject_class->finalize = gst_aggregator_pad_finalize;
2822 gobject_class->dispose = gst_aggregator_pad_dispose;
2826 gst_aggregator_pad_init (GstAggregatorPad * pad)
2829 G_TYPE_INSTANCE_GET_PRIVATE (pad, GST_TYPE_AGGREGATOR_PAD,
2830 GstAggregatorPadPrivate);
2832 g_queue_init (&pad->priv->data);
2833 g_cond_init (&pad->priv->event_cond);
2835 g_mutex_init (&pad->priv->flush_lock);
2836 g_mutex_init (&pad->priv->lock);
2838 gst_aggregator_pad_reset_unlocked (pad);
2839 pad->priv->negotiated = FALSE;
2842 /* Must be called with the PAD_LOCK held */
2844 gst_aggregator_pad_buffer_consumed (GstAggregatorPad * pad)
2846 pad->priv->num_buffers--;
2847 GST_TRACE_OBJECT (pad, "Consuming buffer");
2848 if (gst_aggregator_pad_queue_is_empty (pad) && pad->priv->pending_eos) {
2849 pad->priv->pending_eos = FALSE;
2850 pad->priv->eos = TRUE;
2852 PAD_BROADCAST_EVENT (pad);
2855 /* Must be called with the PAD_LOCK held */
2857 gst_aggregator_pad_clip_buffer_unlocked (GstAggregatorPad * pad)
2859 GstAggregator *self = NULL;
2860 GstAggregatorClass *aggclass = NULL;
2861 GstBuffer *buffer = NULL;
2863 while (pad->priv->clipped_buffer == NULL &&
2864 GST_IS_BUFFER (g_queue_peek_tail (&pad->priv->data))) {
2865 buffer = g_queue_pop_tail (&pad->priv->data);
2867 apply_buffer (pad, buffer, FALSE);
2869 /* We only take the parent here so that it's not taken if the buffer is
2870 * already clipped or if the queue is empty.
2873 self = GST_AGGREGATOR (gst_pad_get_parent_element (GST_PAD (pad)));
2875 gst_buffer_unref (buffer);
2879 aggclass = GST_AGGREGATOR_GET_CLASS (self);
2882 if (aggclass->clip) {
2883 GST_TRACE_OBJECT (pad, "Clipping: %" GST_PTR_FORMAT, buffer);
2885 buffer = aggclass->clip (self, pad, buffer);
2887 if (buffer == NULL) {
2888 gst_aggregator_pad_buffer_consumed (pad);
2889 GST_TRACE_OBJECT (pad, "Clipping consumed the buffer");
2893 pad->priv->clipped_buffer = buffer;
2897 gst_object_unref (self);
2901 * gst_aggregator_pad_steal_buffer:
2902 * @pad: the pad to get buffer from
2904 * Steal the ref to the buffer currently queued in @pad.
2906 * Returns: (transfer full): The buffer in @pad or NULL if no buffer was
2907 * queued. You should unref the buffer after usage.
2910 gst_aggregator_pad_steal_buffer (GstAggregatorPad * pad)
2916 gst_aggregator_pad_clip_buffer_unlocked (pad);
2918 buffer = pad->priv->clipped_buffer;
2919 pad->priv->clipped_buffer = NULL;
2922 gst_aggregator_pad_buffer_consumed (pad);
2923 GST_DEBUG_OBJECT (pad, "Consumed: %" GST_PTR_FORMAT, buffer);
2932 * gst_aggregator_pad_drop_buffer:
2933 * @pad: the pad where to drop any pending buffer
2935 * Drop the buffer currently queued in @pad.
2937 * Returns: TRUE if there was a buffer queued in @pad, or FALSE if not.
2940 gst_aggregator_pad_drop_buffer (GstAggregatorPad * pad)
2944 buf = gst_aggregator_pad_steal_buffer (pad);
2949 gst_buffer_unref (buf);
2954 * gst_aggregator_pad_get_buffer:
2955 * @pad: the pad to get buffer from
2957 * Returns: (transfer full): A reference to the buffer in @pad or
2958 * NULL if no buffer was queued. You should unref the buffer after
2962 gst_aggregator_pad_get_buffer (GstAggregatorPad * pad)
2968 gst_aggregator_pad_clip_buffer_unlocked (pad);
2970 if (pad->priv->clipped_buffer) {
2971 buffer = gst_buffer_ref (pad->priv->clipped_buffer);
2981 gst_aggregator_pad_is_eos (GstAggregatorPad * pad)
2986 is_eos = pad->priv->eos;
2993 * gst_aggregator_merge_tags:
2994 * @self: a #GstAggregator
2995 * @tags: a #GstTagList to merge
2996 * @mode: the #GstTagMergeMode to use
2998 * Adds tags to so-called pending tags, which will be processed
2999 * before pushing out data downstream.
3001 * Note that this is provided for convenience, and the subclass is
3002 * not required to use this and can still do tag handling on its own.
3007 gst_aggregator_merge_tags (GstAggregator * self,
3008 const GstTagList * tags, GstTagMergeMode mode)
3012 g_return_if_fail (GST_IS_AGGREGATOR (self));
3013 g_return_if_fail (tags == NULL || GST_IS_TAG_LIST (tags));
3015 /* FIXME Check if we can use OBJECT lock here! */
3016 GST_OBJECT_LOCK (self);
3018 GST_DEBUG_OBJECT (self, "merging tags %" GST_PTR_FORMAT, tags);
3019 otags = self->priv->tags;
3020 self->priv->tags = gst_tag_list_merge (self->priv->tags, tags, mode);
3022 gst_tag_list_unref (otags);
3023 self->priv->tags_changed = TRUE;
3024 GST_OBJECT_UNLOCK (self);
3028 * gst_aggregator_set_latency:
3029 * @self: a #GstAggregator
3030 * @min_latency: minimum latency
3031 * @max_latency: maximum latency
3033 * Lets #GstAggregator sub-classes tell the baseclass what their internal
3034 * latency is. Will also post a LATENCY message on the bus so the pipeline
3035 * can reconfigure its global latency.
3038 gst_aggregator_set_latency (GstAggregator * self,
3039 GstClockTime min_latency, GstClockTime max_latency)
3041 gboolean changed = FALSE;
3043 g_return_if_fail (GST_IS_AGGREGATOR (self));
3044 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (min_latency));
3045 g_return_if_fail (max_latency >= min_latency);
3048 if (self->priv->sub_latency_min != min_latency) {
3049 self->priv->sub_latency_min = min_latency;
3052 if (self->priv->sub_latency_max != max_latency) {
3053 self->priv->sub_latency_max = max_latency;
3058 SRC_BROADCAST (self);
3062 gst_element_post_message (GST_ELEMENT_CAST (self),
3063 gst_message_new_latency (GST_OBJECT_CAST (self)));
3068 * gst_aggregator_get_buffer_pool:
3069 * @self: a #GstAggregator
3071 * Returns: (transfer full): the instance of the #GstBufferPool used
3072 * by @trans; free it after use it
3075 gst_aggregator_get_buffer_pool (GstAggregator * self)
3077 GstBufferPool *pool;
3079 g_return_val_if_fail (GST_IS_AGGREGATOR (self), NULL);
3081 GST_OBJECT_LOCK (self);
3082 pool = self->priv->pool;
3084 gst_object_ref (pool);
3085 GST_OBJECT_UNLOCK (self);
3091 * gst_aggregator_get_allocator:
3092 * @self: a #GstAggregator
3093 * @allocator: (out) (allow-none) (transfer full): the #GstAllocator
3095 * @params: (out) (allow-none) (transfer full): the
3096 * #GstAllocationParams of @allocator
3098 * Lets #GstAggregator sub-classes get the memory @allocator
3099 * acquired by the base class and its @params.
3101 * Unref the @allocator after use it.
3104 gst_aggregator_get_allocator (GstAggregator * self,
3105 GstAllocator ** allocator, GstAllocationParams * params)
3107 g_return_if_fail (GST_IS_AGGREGATOR (self));
3110 *allocator = self->priv->allocator ?
3111 gst_object_ref (self->priv->allocator) : NULL;
3114 *params = self->priv->allocation_params;