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: Base class for mixers and muxers, manages a set of input
26 * pads and aggregates their streams
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 * * Installs a #GstPadChainFunction, a #GstPadEventFullFunction and a
36 * #GstPadQueryFunction to queue all serialized data packets per sink pad.
37 * Subclasses should not overwrite those, but instead implement
38 * #GstAggregatorClass.sink_event() and #GstAggregatorClass.sink_query() as
41 * * When data is queued on all pads, the aggregate vmethod is called.
43 * * One can peek at the data on any given GstAggregatorPad with the
44 * gst_aggregator_pad_peek_buffer () method, and remove it from the pad
45 * with the gst_aggregator_pad_pop_buffer () method. When a buffer
46 * has been taken with pop_buffer (), a new buffer can be queued
49 * * If the subclass wishes to push a buffer downstream in its aggregate
50 * implementation, it should do so through the
51 * gst_aggregator_finish_buffer () method. This method will take care
52 * of sending and ordering mandatory events such as stream start, caps
55 * * Same goes for EOS events, which should not be pushed directly by the
56 * subclass, it should instead return GST_FLOW_EOS in its aggregate
59 * * Note that the aggregator logic regarding gap event handling is to turn
60 * these into gap buffers with matching PTS and duration. It will also
61 * flag these buffers with GST_BUFFER_FLAG_GAP and GST_BUFFER_FLAG_DROPPABLE
62 * to ease their identification and subsequent processing.
64 * * Subclasses must use (a subclass of) #GstAggregatorPad for both their
65 * sink and source pads.
66 * See gst_element_class_add_static_pad_template_with_gtype().
68 * This class used to live in gst-plugins-bad and was moved to core.
74 * SECTION: gstaggregatorpad
75 * @title: GstAggregatorPad
76 * @short_description: #GstPad subclass for pads managed by #GstAggregator
77 * @see_also: gstcollectpads for historical reasons.
79 * Pads managed by a #GstAggregor subclass.
81 * This class used to live in gst-plugins-bad and was moved to core.
90 #include <string.h> /* strlen */
92 #include "gstaggregator.h"
96 GST_AGGREGATOR_START_TIME_SELECTION_ZERO,
97 GST_AGGREGATOR_START_TIME_SELECTION_FIRST,
98 GST_AGGREGATOR_START_TIME_SELECTION_SET
99 } GstAggregatorStartTimeSelection;
102 gst_aggregator_start_time_selection_get_type (void)
104 static GType gtype = 0;
107 static const GEnumValue values[] = {
108 {GST_AGGREGATOR_START_TIME_SELECTION_ZERO,
109 "Start at 0 running time (default)", "zero"},
110 {GST_AGGREGATOR_START_TIME_SELECTION_FIRST,
111 "Start at first observed input running time", "first"},
112 {GST_AGGREGATOR_START_TIME_SELECTION_SET,
113 "Set start time with start-time property", "set"},
117 gtype = g_enum_register_static ("GstAggregatorStartTimeSelection", values);
122 /* Might become API */
124 static void gst_aggregator_merge_tags (GstAggregator * aggregator,
125 const GstTagList * tags, GstTagMergeMode mode);
127 static void gst_aggregator_set_latency_property (GstAggregator * agg,
128 GstClockTime latency);
129 static GstClockTime gst_aggregator_get_latency_property (GstAggregator * agg);
131 static GstClockTime gst_aggregator_get_latency_unlocked (GstAggregator * self);
133 static void gst_aggregator_pad_buffer_consumed (GstAggregatorPad * pad);
135 GST_DEBUG_CATEGORY_STATIC (aggregator_debug);
136 #define GST_CAT_DEFAULT aggregator_debug
138 /* Locking order, locks in this element must always be taken in this order
140 * standard sink pad stream lock -> GST_PAD_STREAM_LOCK (aggpad)
141 * Aggregator pad flush lock -> PAD_FLUSH_LOCK(aggpad)
142 * standard src pad stream lock -> GST_PAD_STREAM_LOCK (srcpad)
143 * Aggregator src lock -> SRC_LOCK(agg) w/ SRC_WAIT/BROADCAST
144 * standard element object lock -> GST_OBJECT_LOCK(agg)
145 * Aggregator pad lock -> PAD_LOCK (aggpad) w/ PAD_WAIT/BROADCAST_EVENT(aggpad)
146 * standard src pad object lock -> GST_OBJECT_LOCK(srcpad)
147 * standard sink pad object lock -> GST_OBJECT_LOCK(aggpad)
150 /* GstAggregatorPad definitions */
151 #define PAD_LOCK(pad) G_STMT_START { \
152 GST_TRACE_OBJECT (pad, "Taking PAD lock from thread %p", \
154 g_mutex_lock(&pad->priv->lock); \
155 GST_TRACE_OBJECT (pad, "Took PAD lock from thread %p", \
159 #define PAD_UNLOCK(pad) G_STMT_START { \
160 GST_TRACE_OBJECT (pad, "Releasing PAD lock from thread %p", \
162 g_mutex_unlock(&pad->priv->lock); \
163 GST_TRACE_OBJECT (pad, "Release PAD lock from thread %p", \
168 #define PAD_WAIT_EVENT(pad) G_STMT_START { \
169 GST_LOG_OBJECT (pad, "Waiting for buffer to be consumed thread %p", \
171 g_cond_wait(&(((GstAggregatorPad* )pad)->priv->event_cond), \
172 (&((GstAggregatorPad*)pad)->priv->lock)); \
173 GST_LOG_OBJECT (pad, "DONE Waiting for buffer to be consumed on thread %p", \
177 #define PAD_BROADCAST_EVENT(pad) G_STMT_START { \
178 GST_LOG_OBJECT (pad, "Signaling buffer consumed from thread %p", \
180 g_cond_broadcast(&(((GstAggregatorPad* )pad)->priv->event_cond)); \
184 #define PAD_FLUSH_LOCK(pad) G_STMT_START { \
185 GST_TRACE_OBJECT (pad, "Taking lock from thread %p", \
187 g_mutex_lock(&pad->priv->flush_lock); \
188 GST_TRACE_OBJECT (pad, "Took lock from thread %p", \
192 #define PAD_FLUSH_UNLOCK(pad) G_STMT_START { \
193 GST_TRACE_OBJECT (pad, "Releasing lock from thread %p", \
195 g_mutex_unlock(&pad->priv->flush_lock); \
196 GST_TRACE_OBJECT (pad, "Release lock from thread %p", \
200 #define SRC_LOCK(self) G_STMT_START { \
201 GST_TRACE_OBJECT (self, "Taking src lock from thread %p", \
203 g_mutex_lock(&self->priv->src_lock); \
204 GST_TRACE_OBJECT (self, "Took src lock from thread %p", \
208 #define SRC_UNLOCK(self) G_STMT_START { \
209 GST_TRACE_OBJECT (self, "Releasing src lock from thread %p", \
211 g_mutex_unlock(&self->priv->src_lock); \
212 GST_TRACE_OBJECT (self, "Released src lock from thread %p", \
216 #define SRC_WAIT(self) G_STMT_START { \
217 GST_LOG_OBJECT (self, "Waiting for src on thread %p", \
219 g_cond_wait(&(self->priv->src_cond), &(self->priv->src_lock)); \
220 GST_LOG_OBJECT (self, "DONE Waiting for src on thread %p", \
224 #define SRC_BROADCAST(self) G_STMT_START { \
225 GST_LOG_OBJECT (self, "Signaling src from thread %p", \
227 if (self->priv->aggregate_id) \
228 gst_clock_id_unschedule (self->priv->aggregate_id); \
229 g_cond_broadcast(&(self->priv->src_cond)); \
232 struct _GstAggregatorPadPrivate
234 /* Following fields are protected by the PAD_LOCK */
235 GstFlowReturn flow_return;
236 gboolean pending_flush_start;
237 gboolean pending_flush_stop;
239 gboolean first_buffer;
241 GQueue data; /* buffers, events and queries */
242 GstBuffer *clipped_buffer;
245 /* used to track fill state of queues, only used with live-src and when
246 * latency property is set to > 0 */
247 GstClockTime head_position;
248 GstClockTime tail_position;
249 GstClockTime head_time; /* running time */
250 GstClockTime tail_time;
251 GstClockTime time_level; /* how much head is ahead of tail */
252 GstSegment head_segment; /* segment before the queue */
260 /* This lock prevents a flush start processing happening while
261 * the chain function is also happening.
266 /* Must be called with PAD_LOCK held */
268 gst_aggregator_pad_reset_unlocked (GstAggregatorPad * aggpad)
270 aggpad->priv->eos = FALSE;
271 aggpad->priv->flow_return = GST_FLOW_OK;
272 GST_OBJECT_LOCK (aggpad);
273 gst_segment_init (&aggpad->segment, GST_FORMAT_UNDEFINED);
274 gst_segment_init (&aggpad->priv->head_segment, GST_FORMAT_UNDEFINED);
275 GST_OBJECT_UNLOCK (aggpad);
276 aggpad->priv->head_position = GST_CLOCK_TIME_NONE;
277 aggpad->priv->tail_position = GST_CLOCK_TIME_NONE;
278 aggpad->priv->head_time = GST_CLOCK_TIME_NONE;
279 aggpad->priv->tail_time = GST_CLOCK_TIME_NONE;
280 aggpad->priv->time_level = 0;
281 aggpad->priv->first_buffer = TRUE;
285 gst_aggregator_pad_flush (GstAggregatorPad * aggpad, GstAggregator * agg)
287 GstAggregatorPadClass *klass = GST_AGGREGATOR_PAD_GET_CLASS (aggpad);
290 gst_aggregator_pad_reset_unlocked (aggpad);
294 return klass->flush (aggpad, agg);
299 /*************************************
300 * GstAggregator implementation *
301 *************************************/
302 static GstElementClass *aggregator_parent_class = NULL;
303 static gint aggregator_private_offset = 0;
305 /* All members are protected by the object lock unless otherwise noted */
307 struct _GstAggregatorPrivate
311 /* Our state is >= PAUSED */
312 gboolean running; /* protected by src_lock */
314 /* seqnum from seek or segment,
315 * to be applied to synthetic segment/eos events */
317 gboolean send_stream_start; /* protected by srcpad stream lock */
318 gboolean send_segment;
319 gboolean flush_seeking;
320 gboolean pending_flush_start;
321 gboolean send_eos; /* protected by srcpad stream lock */
323 GstCaps *srccaps; /* protected by the srcpad stream lock */
326 gboolean tags_changed;
328 gboolean peer_latency_live; /* protected by src_lock */
329 GstClockTime peer_latency_min; /* protected by src_lock */
330 GstClockTime peer_latency_max; /* protected by src_lock */
331 gboolean has_peer_latency; /* protected by src_lock */
333 GstClockTime sub_latency_min; /* protected by src_lock */
334 GstClockTime sub_latency_max; /* protected by src_lock */
337 GstClockID aggregate_id; /* protected by src_lock */
341 gboolean first_buffer; /* protected by object lock */
342 GstAggregatorStartTimeSelection start_time_selection;
343 GstClockTime start_time;
345 /* protected by the object lock */
346 GstQuery *allocation_query;
347 GstAllocator *allocator;
349 GstAllocationParams allocation_params;
352 gint64 latency; /* protected by both src_lock and all pad locks */
355 /* Seek event forwarding helper */
361 gboolean only_to_active_pads;
365 gboolean one_actually_seeked;
368 #define DEFAULT_LATENCY 0
369 #define DEFAULT_START_TIME_SELECTION GST_AGGREGATOR_START_TIME_SELECTION_ZERO
370 #define DEFAULT_START_TIME (-1)
376 PROP_START_TIME_SELECTION,
381 static GstFlowReturn gst_aggregator_pad_chain_internal (GstAggregator * self,
382 GstAggregatorPad * aggpad, GstBuffer * buffer, gboolean head);
385 gst_aggregator_pad_queue_is_empty (GstAggregatorPad * pad)
387 return (g_queue_peek_tail (&pad->priv->data) == NULL &&
388 pad->priv->clipped_buffer == NULL);
392 gst_aggregator_check_pads_ready (GstAggregator * self)
394 GstAggregatorPad *pad = NULL;
396 gboolean have_buffer = TRUE;
397 gboolean have_event_or_query = FALSE;
399 GST_LOG_OBJECT (self, "checking pads");
401 GST_OBJECT_LOCK (self);
403 sinkpads = GST_ELEMENT_CAST (self)->sinkpads;
404 if (sinkpads == NULL)
407 for (l = sinkpads; l != NULL; l = l->next) {
412 if (pad->priv->num_buffers == 0) {
413 if (!gst_aggregator_pad_queue_is_empty (pad))
414 have_event_or_query = TRUE;
415 if (!pad->priv->eos) {
418 /* If not live we need data on all pads, so leave the loop */
419 if (!self->priv->peer_latency_live) {
424 } else if (self->priv->peer_latency_live) {
425 /* In live mode, having a single pad with buffers is enough to
426 * generate a start time from it. In non-live mode all pads need
429 self->priv->first_buffer = FALSE;
435 if (!have_buffer && !have_event_or_query)
439 self->priv->first_buffer = FALSE;
441 GST_OBJECT_UNLOCK (self);
442 GST_LOG_OBJECT (self, "pads are ready");
447 GST_LOG_OBJECT (self, "pads not ready: no sink pads");
448 GST_OBJECT_UNLOCK (self);
453 if (have_event_or_query)
454 GST_LOG_OBJECT (pad, "pad not ready to be aggregated yet,"
455 " but waking up for serialized event");
457 GST_LOG_OBJECT (pad, "pad not ready to be aggregated yet");
458 GST_OBJECT_UNLOCK (self);
459 return have_event_or_query;
464 gst_aggregator_reset_flow_values (GstAggregator * self)
466 GST_OBJECT_LOCK (self);
467 self->priv->send_stream_start = TRUE;
468 self->priv->send_segment = TRUE;
469 gst_segment_init (&GST_AGGREGATOR_PAD (self->srcpad)->segment,
471 self->priv->first_buffer = TRUE;
472 GST_OBJECT_UNLOCK (self);
476 gst_aggregator_push_mandatory_events (GstAggregator * self)
478 GstAggregatorPrivate *priv = self->priv;
479 GstEvent *segment = NULL;
480 GstEvent *tags = NULL;
482 if (self->priv->send_stream_start) {
485 GST_INFO_OBJECT (self, "pushing stream start");
486 /* stream-start (FIXME: create id based on input ids) */
487 g_snprintf (s_id, sizeof (s_id), "agg-%08x", g_random_int ());
488 if (!gst_pad_push_event (GST_PAD (self->srcpad),
489 gst_event_new_stream_start (s_id))) {
490 GST_WARNING_OBJECT (self->srcpad, "Sending stream start event failed");
492 self->priv->send_stream_start = FALSE;
495 if (self->priv->srccaps) {
497 GST_INFO_OBJECT (self, "pushing caps: %" GST_PTR_FORMAT,
498 self->priv->srccaps);
499 if (!gst_pad_push_event (GST_PAD (self->srcpad),
500 gst_event_new_caps (self->priv->srccaps))) {
501 GST_WARNING_OBJECT (self->srcpad, "Sending caps event failed");
503 gst_caps_unref (self->priv->srccaps);
504 self->priv->srccaps = NULL;
507 GST_OBJECT_LOCK (self);
508 if (self->priv->send_segment && !self->priv->flush_seeking) {
510 gst_event_new_segment (&GST_AGGREGATOR_PAD (self->srcpad)->segment);
512 if (!self->priv->seqnum)
513 /* This code-path is in preparation to be able to run without a source
514 * connected. Then we won't have a seq-num from a segment event. */
515 self->priv->seqnum = gst_event_get_seqnum (segment);
517 gst_event_set_seqnum (segment, self->priv->seqnum);
518 self->priv->send_segment = FALSE;
520 GST_DEBUG_OBJECT (self, "pushing segment %" GST_PTR_FORMAT, segment);
523 if (priv->tags && priv->tags_changed && !self->priv->flush_seeking) {
524 tags = gst_event_new_tag (gst_tag_list_ref (priv->tags));
525 priv->tags_changed = FALSE;
527 GST_OBJECT_UNLOCK (self);
530 gst_pad_push_event (self->srcpad, segment);
532 gst_pad_push_event (self->srcpad, tags);
537 * gst_aggregator_set_src_caps:
538 * @self: The #GstAggregator
539 * @caps: The #GstCaps to set on the src pad.
541 * Sets the caps to be used on the src pad.
544 gst_aggregator_set_src_caps (GstAggregator * self, GstCaps * caps)
546 GST_PAD_STREAM_LOCK (self->srcpad);
547 gst_caps_replace (&self->priv->srccaps, caps);
548 gst_aggregator_push_mandatory_events (self);
549 GST_PAD_STREAM_UNLOCK (self->srcpad);
553 gst_aggregator_default_finish_buffer (GstAggregator * self, GstBuffer * buffer)
555 gst_aggregator_push_mandatory_events (self);
557 GST_OBJECT_LOCK (self);
558 if (!self->priv->flush_seeking && gst_pad_is_active (self->srcpad)) {
559 GST_TRACE_OBJECT (self, "pushing buffer %" GST_PTR_FORMAT, buffer);
560 GST_OBJECT_UNLOCK (self);
561 return gst_pad_push (self->srcpad, buffer);
563 GST_INFO_OBJECT (self, "Not pushing (active: %i, flushing: %i)",
564 self->priv->flush_seeking, gst_pad_is_active (self->srcpad));
565 GST_OBJECT_UNLOCK (self);
566 gst_buffer_unref (buffer);
572 * gst_aggregator_finish_buffer:
573 * @aggregator: The #GstAggregator
574 * @buffer: (transfer full): the #GstBuffer to push.
576 * This method will push the provided output buffer downstream. If needed,
577 * mandatory events such as stream-start, caps, and segment events will be
578 * sent before pushing the buffer.
581 gst_aggregator_finish_buffer (GstAggregator * aggregator, GstBuffer * buffer)
583 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (aggregator);
585 g_assert (klass->finish_buffer != NULL);
587 return klass->finish_buffer (aggregator, buffer);
591 gst_aggregator_push_eos (GstAggregator * self)
594 gst_aggregator_push_mandatory_events (self);
596 event = gst_event_new_eos ();
598 GST_OBJECT_LOCK (self);
599 self->priv->send_eos = FALSE;
600 gst_event_set_seqnum (event, self->priv->seqnum);
601 GST_OBJECT_UNLOCK (self);
603 gst_pad_push_event (self->srcpad, event);
607 gst_aggregator_get_next_time (GstAggregator * self)
609 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
611 if (klass->get_next_time)
612 return klass->get_next_time (self);
614 return GST_CLOCK_TIME_NONE;
618 gst_aggregator_wait_and_check (GstAggregator * self, gboolean * timeout)
620 GstClockTime latency;
628 latency = gst_aggregator_get_latency_unlocked (self);
630 if (gst_aggregator_check_pads_ready (self)) {
631 GST_DEBUG_OBJECT (self, "all pads have data");
637 /* Before waiting, check if we're actually still running */
638 if (!self->priv->running || !self->priv->send_eos) {
644 start = gst_aggregator_get_next_time (self);
646 /* If we're not live, or if we use the running time
647 * of the first buffer as start time, we wait until
648 * all pads have buffers.
649 * Otherwise (i.e. if we are live!), we wait on the clock
650 * and if a pad does not have a buffer in time we ignore
653 GST_OBJECT_LOCK (self);
654 if (!GST_CLOCK_TIME_IS_VALID (latency) ||
655 !GST_IS_CLOCK (GST_ELEMENT_CLOCK (self)) ||
656 !GST_CLOCK_TIME_IS_VALID (start) ||
657 (self->priv->first_buffer
658 && self->priv->start_time_selection ==
659 GST_AGGREGATOR_START_TIME_SELECTION_FIRST)) {
660 /* We wake up here when something happened, and below
661 * then check if we're ready now. If we return FALSE,
662 * we will be directly called again.
664 GST_OBJECT_UNLOCK (self);
667 GstClockTime base_time, time;
669 GstClockReturn status;
670 GstClockTimeDiff jitter;
672 GST_DEBUG_OBJECT (self, "got subclass start time: %" GST_TIME_FORMAT,
673 GST_TIME_ARGS (start));
675 base_time = GST_ELEMENT_CAST (self)->base_time;
676 clock = gst_object_ref (GST_ELEMENT_CLOCK (self));
677 GST_OBJECT_UNLOCK (self);
679 time = base_time + start;
682 GST_DEBUG_OBJECT (self, "possibly waiting for clock to reach %"
683 GST_TIME_FORMAT " (base %" GST_TIME_FORMAT " start %" GST_TIME_FORMAT
684 " latency %" GST_TIME_FORMAT " current %" GST_TIME_FORMAT ")",
685 GST_TIME_ARGS (time),
686 GST_TIME_ARGS (base_time),
687 GST_TIME_ARGS (start), GST_TIME_ARGS (latency),
688 GST_TIME_ARGS (gst_clock_get_time (clock)));
690 self->priv->aggregate_id = gst_clock_new_single_shot_id (clock, time);
691 gst_object_unref (clock);
695 status = gst_clock_id_wait (self->priv->aggregate_id, &jitter);
698 if (self->priv->aggregate_id) {
699 gst_clock_id_unref (self->priv->aggregate_id);
700 self->priv->aggregate_id = NULL;
703 GST_DEBUG_OBJECT (self,
704 "clock returned %d (jitter: %" GST_STIME_FORMAT ")",
705 status, GST_STIME_ARGS (jitter));
708 if (status == GST_CLOCK_OK || status == GST_CLOCK_EARLY) {
715 res = gst_aggregator_check_pads_ready (self);
722 gst_aggregator_do_events_and_queries (GstElement * self, GstPad * epad,
725 GstAggregatorPad *pad = GST_AGGREGATOR_PAD_CAST (epad);
726 GstAggregator *aggregator = GST_AGGREGATOR_CAST (self);
727 GstEvent *event = NULL;
728 GstQuery *query = NULL;
729 GstAggregatorClass *klass = NULL;
730 gboolean *processed_event = user_data;
737 if (pad->priv->clipped_buffer == NULL &&
738 !GST_IS_BUFFER (g_queue_peek_tail (&pad->priv->data))) {
739 if (GST_IS_EVENT (g_queue_peek_tail (&pad->priv->data)))
740 event = gst_event_ref (g_queue_peek_tail (&pad->priv->data));
741 if (GST_IS_QUERY (g_queue_peek_tail (&pad->priv->data)))
742 query = g_queue_peek_tail (&pad->priv->data);
745 if (event || query) {
749 *processed_event = TRUE;
751 klass = GST_AGGREGATOR_GET_CLASS (self);
754 GST_LOG_OBJECT (pad, "Processing %" GST_PTR_FORMAT, event);
755 gst_event_ref (event);
756 ret = klass->sink_event (aggregator, pad, event);
759 if (GST_EVENT_TYPE (event) == GST_EVENT_CAPS)
760 pad->priv->negotiated = ret;
761 if (g_queue_peek_tail (&pad->priv->data) == event)
762 gst_event_unref (g_queue_pop_tail (&pad->priv->data));
763 gst_event_unref (event);
765 GST_LOG_OBJECT (pad, "Processing %" GST_PTR_FORMAT, query);
766 ret = klass->sink_query (aggregator, pad, query);
769 if (g_queue_peek_tail (&pad->priv->data) == query) {
772 s = gst_query_writable_structure (query);
773 gst_structure_set (s, "gst-aggregator-retval", G_TYPE_BOOLEAN, ret,
775 g_queue_pop_tail (&pad->priv->data);
779 PAD_BROADCAST_EVENT (pad);
782 } while (event || query);
788 gst_aggregator_pad_skip_buffers (GstElement * self, GstPad * epad,
792 GstAggregatorPad *aggpad = (GstAggregatorPad *) epad;
793 GstAggregator *agg = (GstAggregator *) self;
794 GstAggregatorPadClass *klass = GST_AGGREGATOR_PAD_GET_CLASS (aggpad);
796 if (!klass->skip_buffer)
801 item = g_queue_peek_head_link (&aggpad->priv->data);
803 GList *next = item->next;
805 if (GST_IS_BUFFER (item->data)
806 && klass->skip_buffer (aggpad, agg, item->data)) {
807 GST_LOG_OBJECT (aggpad, "Skipping %" GST_PTR_FORMAT, item->data);
808 gst_aggregator_pad_buffer_consumed (aggpad);
809 gst_buffer_unref (item->data);
810 g_queue_delete_link (&aggpad->priv->data, item);
824 gst_aggregator_pad_set_flushing (GstAggregatorPad * aggpad,
825 GstFlowReturn flow_return, gboolean full)
830 if (flow_return == GST_FLOW_NOT_LINKED)
831 aggpad->priv->flow_return = MIN (flow_return, aggpad->priv->flow_return);
833 aggpad->priv->flow_return = flow_return;
835 item = g_queue_peek_head_link (&aggpad->priv->data);
837 GList *next = item->next;
839 /* In partial flush, we do like the pad, we get rid of non-sticky events
842 if (full || GST_IS_BUFFER (item->data) ||
843 GST_EVENT_TYPE (item->data) == GST_EVENT_EOS ||
844 GST_EVENT_TYPE (item->data) == GST_EVENT_SEGMENT ||
845 !GST_EVENT_IS_STICKY (item->data)) {
846 if (!GST_IS_QUERY (item->data))
847 gst_mini_object_unref (item->data);
848 g_queue_delete_link (&aggpad->priv->data, item);
852 aggpad->priv->num_buffers = 0;
853 gst_buffer_replace (&aggpad->priv->clipped_buffer, NULL);
855 PAD_BROADCAST_EVENT (aggpad);
860 gst_aggregator_default_update_src_caps (GstAggregator * agg, GstCaps * caps,
863 *ret = gst_caps_ref (caps);
869 gst_aggregator_default_fixate_src_caps (GstAggregator * agg, GstCaps * caps)
871 caps = gst_caps_fixate (caps);
877 gst_aggregator_default_negotiated_src_caps (GstAggregator * agg, GstCaps * caps)
883 /* takes ownership of the pool, allocator and query */
885 gst_aggregator_set_allocation (GstAggregator * self,
886 GstBufferPool * pool, GstAllocator * allocator,
887 GstAllocationParams * params, GstQuery * query)
889 GstAllocator *oldalloc;
890 GstBufferPool *oldpool;
893 GST_DEBUG ("storing allocation query");
895 GST_OBJECT_LOCK (self);
896 oldpool = self->priv->pool;
897 self->priv->pool = pool;
899 oldalloc = self->priv->allocator;
900 self->priv->allocator = allocator;
902 oldquery = self->priv->allocation_query;
903 self->priv->allocation_query = query;
906 self->priv->allocation_params = *params;
908 gst_allocation_params_init (&self->priv->allocation_params);
909 GST_OBJECT_UNLOCK (self);
912 GST_DEBUG_OBJECT (self, "deactivating old pool %p", oldpool);
913 gst_buffer_pool_set_active (oldpool, FALSE);
914 gst_object_unref (oldpool);
917 gst_object_unref (oldalloc);
920 gst_query_unref (oldquery);
927 gst_aggregator_decide_allocation (GstAggregator * self, GstQuery * query)
929 GstAggregatorClass *aggclass = GST_AGGREGATOR_GET_CLASS (self);
931 if (aggclass->decide_allocation)
932 if (!aggclass->decide_allocation (self, query))
939 gst_aggregator_do_allocation (GstAggregator * self, GstCaps * caps)
942 gboolean result = TRUE;
943 GstBufferPool *pool = NULL;
944 GstAllocator *allocator;
945 GstAllocationParams params;
947 /* find a pool for the negotiated caps now */
948 GST_DEBUG_OBJECT (self, "doing allocation query");
949 query = gst_query_new_allocation (caps, TRUE);
950 if (!gst_pad_peer_query (self->srcpad, query)) {
951 /* not a problem, just debug a little */
952 GST_DEBUG_OBJECT (self, "peer ALLOCATION query failed");
955 GST_DEBUG_OBJECT (self, "calling decide_allocation");
956 result = gst_aggregator_decide_allocation (self, query);
958 GST_DEBUG_OBJECT (self, "ALLOCATION (%d) params: %" GST_PTR_FORMAT, result,
962 goto no_decide_allocation;
964 /* we got configuration from our peer or the decide_allocation method,
966 if (gst_query_get_n_allocation_params (query) > 0) {
967 gst_query_parse_nth_allocation_param (query, 0, &allocator, ¶ms);
970 gst_allocation_params_init (¶ms);
973 if (gst_query_get_n_allocation_pools (query) > 0)
974 gst_query_parse_nth_allocation_pool (query, 0, &pool, NULL, NULL, NULL);
978 gst_aggregator_set_allocation (self, pool, allocator, ¶ms, query);
983 no_decide_allocation:
985 GST_WARNING_OBJECT (self, "Failed to decide allocation");
986 gst_query_unref (query);
993 /* WITH SRC_LOCK held */
995 gst_aggregator_update_src_caps (GstAggregator * self)
997 GstAggregatorClass *agg_klass = GST_AGGREGATOR_GET_CLASS (self);
998 GstCaps *downstream_caps, *template_caps, *caps = NULL;
999 GstFlowReturn ret = GST_FLOW_OK;
1001 template_caps = gst_pad_get_pad_template_caps (self->srcpad);
1002 downstream_caps = gst_pad_peer_query_caps (self->srcpad, template_caps);
1004 if (gst_caps_is_empty (downstream_caps)) {
1005 GST_INFO_OBJECT (self, "Downstream caps (%"
1006 GST_PTR_FORMAT ") not compatible with pad template caps (%"
1007 GST_PTR_FORMAT ")", downstream_caps, template_caps);
1008 ret = GST_FLOW_NOT_NEGOTIATED;
1012 g_assert (agg_klass->update_src_caps);
1013 GST_DEBUG_OBJECT (self, "updating caps from %" GST_PTR_FORMAT,
1015 ret = agg_klass->update_src_caps (self, downstream_caps, &caps);
1016 if (ret < GST_FLOW_OK) {
1017 GST_WARNING_OBJECT (self, "Subclass failed to update provided caps");
1020 if ((caps == NULL || gst_caps_is_empty (caps)) && ret >= GST_FLOW_OK) {
1021 ret = GST_FLOW_NOT_NEGOTIATED;
1024 GST_DEBUG_OBJECT (self, " to %" GST_PTR_FORMAT, caps);
1026 #ifdef GST_ENABLE_EXTRA_CHECKS
1027 if (!gst_caps_is_subset (caps, template_caps)) {
1028 GstCaps *intersection;
1030 GST_ERROR_OBJECT (self,
1031 "update_src_caps returned caps %" GST_PTR_FORMAT
1032 " which are not a real subset of the template caps %"
1033 GST_PTR_FORMAT, caps, template_caps);
1034 g_warning ("%s: update_src_caps returned caps which are not a real "
1035 "subset of the filter caps", GST_ELEMENT_NAME (self));
1038 gst_caps_intersect_full (template_caps, caps, GST_CAPS_INTERSECT_FIRST);
1039 gst_caps_unref (caps);
1040 caps = intersection;
1044 if (gst_caps_is_any (caps)) {
1048 if (!gst_caps_is_fixed (caps)) {
1049 g_assert (agg_klass->fixate_src_caps);
1051 GST_DEBUG_OBJECT (self, "fixate caps from %" GST_PTR_FORMAT, caps);
1052 if (!(caps = agg_klass->fixate_src_caps (self, caps))) {
1053 GST_WARNING_OBJECT (self, "Subclass failed to fixate provided caps");
1054 ret = GST_FLOW_NOT_NEGOTIATED;
1057 GST_DEBUG_OBJECT (self, " to %" GST_PTR_FORMAT, caps);
1060 if (agg_klass->negotiated_src_caps) {
1061 if (!agg_klass->negotiated_src_caps (self, caps)) {
1062 GST_WARNING_OBJECT (self, "Subclass failed to accept negotiated caps");
1063 ret = GST_FLOW_NOT_NEGOTIATED;
1068 gst_aggregator_set_src_caps (self, caps);
1070 if (!gst_aggregator_do_allocation (self, caps)) {
1071 GST_WARNING_OBJECT (self, "Allocation negotiation failed");
1072 ret = GST_FLOW_NOT_NEGOTIATED;
1076 gst_caps_unref (downstream_caps);
1077 gst_caps_unref (template_caps);
1080 gst_caps_unref (caps);
1086 gst_aggregator_aggregate_func (GstAggregator * self)
1088 GstAggregatorPrivate *priv = self->priv;
1089 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
1090 gboolean timeout = FALSE;
1092 if (self->priv->running == FALSE) {
1093 GST_DEBUG_OBJECT (self, "Not running anymore");
1097 GST_LOG_OBJECT (self, "Checking aggregate");
1098 while (priv->send_eos && priv->running) {
1099 GstFlowReturn flow_return = GST_FLOW_OK;
1100 gboolean processed_event = FALSE;
1102 gst_element_foreach_sink_pad (GST_ELEMENT_CAST (self),
1103 gst_aggregator_do_events_and_queries, NULL);
1105 if (self->priv->peer_latency_live)
1106 gst_element_foreach_sink_pad (GST_ELEMENT_CAST (self),
1107 gst_aggregator_pad_skip_buffers, NULL);
1109 /* Ensure we have buffers ready (either in clipped_buffer or at the head of
1111 if (!gst_aggregator_wait_and_check (self, &timeout))
1114 gst_element_foreach_sink_pad (GST_ELEMENT_CAST (self),
1115 gst_aggregator_do_events_and_queries, &processed_event);
1117 if (processed_event)
1120 if (gst_pad_check_reconfigure (GST_AGGREGATOR_SRC_PAD (self))) {
1121 flow_return = gst_aggregator_update_src_caps (self);
1122 if (flow_return != GST_FLOW_OK)
1123 gst_pad_mark_reconfigure (GST_AGGREGATOR_SRC_PAD (self));
1126 if (timeout || flow_return >= GST_FLOW_OK) {
1127 GST_TRACE_OBJECT (self, "Actually aggregating!");
1128 flow_return = klass->aggregate (self, timeout);
1131 if (flow_return == GST_AGGREGATOR_FLOW_NEED_DATA)
1134 GST_OBJECT_LOCK (self);
1135 if (flow_return == GST_FLOW_FLUSHING && priv->flush_seeking) {
1136 /* We don't want to set the pads to flushing, but we want to
1137 * stop the thread, so just break here */
1138 GST_OBJECT_UNLOCK (self);
1141 GST_OBJECT_UNLOCK (self);
1143 if (flow_return == GST_FLOW_EOS || flow_return == GST_FLOW_ERROR) {
1144 gst_aggregator_push_eos (self);
1147 GST_LOG_OBJECT (self, "flow return is %s", gst_flow_get_name (flow_return));
1149 if (flow_return != GST_FLOW_OK) {
1152 GST_OBJECT_LOCK (self);
1153 for (item = GST_ELEMENT (self)->sinkpads; item; item = item->next) {
1154 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (item->data);
1156 gst_aggregator_pad_set_flushing (aggpad, flow_return, TRUE);
1158 GST_OBJECT_UNLOCK (self);
1163 /* Pause the task here, the only ways to get here are:
1164 * 1) We're stopping, in which case the task is stopped anyway
1165 * 2) We got a flow error above, in which case it might take
1166 * some time to forward the flow return upstream and we
1167 * would otherwise call the task function over and over
1168 * again without doing anything
1170 gst_pad_pause_task (self->srcpad);
1174 gst_aggregator_start (GstAggregator * self)
1176 GstAggregatorClass *klass;
1179 self->priv->send_stream_start = TRUE;
1180 self->priv->send_segment = TRUE;
1181 self->priv->send_eos = TRUE;
1182 self->priv->srccaps = NULL;
1184 gst_aggregator_set_allocation (self, NULL, NULL, NULL, NULL);
1186 klass = GST_AGGREGATOR_GET_CLASS (self);
1189 result = klass->start (self);
1197 _check_pending_flush_stop (GstAggregatorPad * pad)
1202 res = (!pad->priv->pending_flush_stop && !pad->priv->pending_flush_start);
1209 gst_aggregator_stop_srcpad_task (GstAggregator * self, GstEvent * flush_start)
1211 gboolean res = TRUE;
1213 GST_INFO_OBJECT (self, "%s srcpad task",
1214 flush_start ? "Pausing" : "Stopping");
1217 self->priv->running = FALSE;
1218 SRC_BROADCAST (self);
1222 res = gst_pad_push_event (self->srcpad, flush_start);
1225 gst_pad_stop_task (self->srcpad);
1231 gst_aggregator_start_srcpad_task (GstAggregator * self)
1233 GST_INFO_OBJECT (self, "Starting srcpad task");
1235 self->priv->running = TRUE;
1236 gst_pad_start_task (GST_PAD (self->srcpad),
1237 (GstTaskFunction) gst_aggregator_aggregate_func, self, NULL);
1240 static GstFlowReturn
1241 gst_aggregator_flush (GstAggregator * self)
1243 GstFlowReturn ret = GST_FLOW_OK;
1244 GstAggregatorPrivate *priv = self->priv;
1245 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (self);
1247 GST_DEBUG_OBJECT (self, "Flushing everything");
1248 GST_OBJECT_LOCK (self);
1249 priv->send_segment = TRUE;
1250 priv->flush_seeking = FALSE;
1251 priv->tags_changed = FALSE;
1252 GST_OBJECT_UNLOCK (self);
1254 ret = klass->flush (self);
1260 /* Called with GstAggregator's object lock held */
1263 gst_aggregator_all_flush_stop_received_locked (GstAggregator * self)
1266 GstAggregatorPad *tmppad;
1268 for (tmp = GST_ELEMENT (self)->sinkpads; tmp; tmp = tmp->next) {
1269 tmppad = (GstAggregatorPad *) tmp->data;
1271 if (_check_pending_flush_stop (tmppad) == FALSE) {
1272 GST_DEBUG_OBJECT (tmppad, "Is not last %i -- %i",
1273 tmppad->priv->pending_flush_start, tmppad->priv->pending_flush_stop);
1282 gst_aggregator_flush_start (GstAggregator * self, GstAggregatorPad * aggpad,
1285 GstAggregatorPrivate *priv = self->priv;
1286 GstAggregatorPadPrivate *padpriv = aggpad->priv;
1288 gst_aggregator_pad_set_flushing (aggpad, GST_FLOW_FLUSHING, FALSE);
1290 PAD_FLUSH_LOCK (aggpad);
1292 if (padpriv->pending_flush_start) {
1293 GST_DEBUG_OBJECT (aggpad, "Expecting FLUSH_STOP now");
1295 padpriv->pending_flush_start = FALSE;
1296 padpriv->pending_flush_stop = TRUE;
1298 PAD_UNLOCK (aggpad);
1300 GST_OBJECT_LOCK (self);
1301 if (priv->flush_seeking) {
1302 /* If flush_seeking we forward the first FLUSH_START */
1303 if (priv->pending_flush_start) {
1304 priv->pending_flush_start = FALSE;
1305 GST_OBJECT_UNLOCK (self);
1307 GST_INFO_OBJECT (self, "Flushing, pausing srcpad task");
1308 gst_aggregator_stop_srcpad_task (self, event);
1310 GST_INFO_OBJECT (self, "Getting STREAM_LOCK while seeking");
1311 GST_PAD_STREAM_LOCK (self->srcpad);
1312 GST_LOG_OBJECT (self, "GOT STREAM_LOCK");
1315 GST_OBJECT_UNLOCK (self);
1316 gst_event_unref (event);
1319 GST_OBJECT_UNLOCK (self);
1320 gst_event_unref (event);
1322 PAD_FLUSH_UNLOCK (aggpad);
1325 /* Must be called with the the PAD_LOCK held */
1327 update_time_level (GstAggregatorPad * aggpad, gboolean head)
1329 GstAggregatorPadPrivate *priv = aggpad->priv;
1332 if (GST_CLOCK_TIME_IS_VALID (priv->head_position) &&
1333 priv->head_segment.format == GST_FORMAT_TIME)
1334 priv->head_time = gst_segment_to_running_time (&priv->head_segment,
1335 GST_FORMAT_TIME, priv->head_position);
1337 priv->head_time = GST_CLOCK_TIME_NONE;
1339 if (!GST_CLOCK_TIME_IS_VALID (priv->tail_time))
1340 priv->tail_time = priv->head_time;
1342 if (GST_CLOCK_TIME_IS_VALID (priv->tail_position) &&
1343 aggpad->segment.format == GST_FORMAT_TIME)
1344 priv->tail_time = gst_segment_to_running_time (&aggpad->segment,
1345 GST_FORMAT_TIME, priv->tail_position);
1347 priv->tail_time = priv->head_time;
1350 if (priv->head_time == GST_CLOCK_TIME_NONE ||
1351 priv->tail_time == GST_CLOCK_TIME_NONE) {
1352 priv->time_level = 0;
1356 if (priv->tail_time > priv->head_time)
1357 priv->time_level = 0;
1359 priv->time_level = priv->head_time - priv->tail_time;
1363 /* GstAggregator vmethods default implementations */
1365 gst_aggregator_default_sink_event (GstAggregator * self,
1366 GstAggregatorPad * aggpad, GstEvent * event)
1368 gboolean res = TRUE;
1369 GstPad *pad = GST_PAD (aggpad);
1370 GstAggregatorPrivate *priv = self->priv;
1372 GST_DEBUG_OBJECT (aggpad, "Got event: %" GST_PTR_FORMAT, event);
1374 switch (GST_EVENT_TYPE (event)) {
1375 case GST_EVENT_FLUSH_START:
1377 gst_aggregator_flush_start (self, aggpad, event);
1378 /* We forward only in one case: right after flush_seeking */
1382 case GST_EVENT_FLUSH_STOP:
1384 gst_aggregator_pad_flush (aggpad, self);
1385 GST_OBJECT_LOCK (self);
1386 if (priv->flush_seeking) {
1387 g_atomic_int_set (&aggpad->priv->pending_flush_stop, FALSE);
1388 if (gst_aggregator_all_flush_stop_received_locked (self)) {
1389 GST_OBJECT_UNLOCK (self);
1390 /* That means we received FLUSH_STOP/FLUSH_STOP on
1391 * all sinkpads -- Seeking is Done... sending FLUSH_STOP */
1392 gst_aggregator_flush (self);
1393 gst_pad_push_event (self->srcpad, event);
1396 priv->send_eos = TRUE;
1397 SRC_BROADCAST (self);
1400 GST_INFO_OBJECT (self, "Releasing source pad STREAM_LOCK");
1401 GST_PAD_STREAM_UNLOCK (self->srcpad);
1402 gst_aggregator_start_srcpad_task (self);
1404 GST_OBJECT_UNLOCK (self);
1407 GST_OBJECT_UNLOCK (self);
1410 /* We never forward the event */
1417 g_assert (aggpad->priv->num_buffers == 0);
1418 aggpad->priv->eos = TRUE;
1419 PAD_UNLOCK (aggpad);
1420 SRC_BROADCAST (self);
1424 case GST_EVENT_SEGMENT:
1427 GST_OBJECT_LOCK (aggpad);
1428 gst_event_copy_segment (event, &aggpad->segment);
1429 /* We've got a new segment, tail_position is now meaningless
1430 * and may interfere with the time_level calculation
1432 aggpad->priv->tail_position = GST_CLOCK_TIME_NONE;
1433 update_time_level (aggpad, FALSE);
1434 GST_OBJECT_UNLOCK (aggpad);
1435 PAD_UNLOCK (aggpad);
1437 GST_OBJECT_LOCK (self);
1438 self->priv->seqnum = gst_event_get_seqnum (event);
1439 GST_OBJECT_UNLOCK (self);
1442 case GST_EVENT_STREAM_START:
1448 GstClockTime pts, endpts;
1449 GstClockTime duration;
1452 gst_event_parse_gap (event, &pts, &duration);
1453 gapbuf = gst_buffer_new ();
1455 if (GST_CLOCK_TIME_IS_VALID (duration))
1456 endpts = pts + duration;
1458 endpts = GST_CLOCK_TIME_NONE;
1460 GST_OBJECT_LOCK (aggpad);
1461 res = gst_segment_clip (&aggpad->segment, GST_FORMAT_TIME, pts, endpts,
1463 GST_OBJECT_UNLOCK (aggpad);
1466 GST_WARNING_OBJECT (self, "GAP event outside segment, dropping");
1470 if (GST_CLOCK_TIME_IS_VALID (endpts) && GST_CLOCK_TIME_IS_VALID (pts))
1471 duration = endpts - pts;
1473 duration = GST_CLOCK_TIME_NONE;
1475 GST_BUFFER_PTS (gapbuf) = pts;
1476 GST_BUFFER_DURATION (gapbuf) = duration;
1477 GST_BUFFER_FLAG_SET (gapbuf, GST_BUFFER_FLAG_GAP);
1478 GST_BUFFER_FLAG_SET (gapbuf, GST_BUFFER_FLAG_DROPPABLE);
1480 /* Remove GAP event so we can replace it with the buffer */
1481 if (g_queue_peek_tail (&aggpad->priv->data) == event)
1482 gst_event_unref (g_queue_pop_tail (&aggpad->priv->data));
1484 if (gst_aggregator_pad_chain_internal (self, aggpad, gapbuf, FALSE) !=
1486 GST_WARNING_OBJECT (self, "Failed to chain gap buffer");
1500 GST_DEBUG_OBJECT (pad, "Forwarding event: %" GST_PTR_FORMAT, event);
1501 return gst_pad_event_default (pad, GST_OBJECT (self), event);
1504 GST_DEBUG_OBJECT (pad, "Eating event: %" GST_PTR_FORMAT, event);
1506 gst_event_unref (event);
1512 gst_aggregator_stop_pad (GstElement * self, GstPad * epad, gpointer user_data)
1514 GstAggregatorPad *pad = GST_AGGREGATOR_PAD_CAST (epad);
1515 GstAggregator *agg = GST_AGGREGATOR_CAST (self);
1517 gst_aggregator_pad_flush (pad, agg);
1520 pad->priv->flow_return = GST_FLOW_FLUSHING;
1521 pad->priv->negotiated = FALSE;
1522 PAD_BROADCAST_EVENT (pad);
1529 gst_aggregator_stop (GstAggregator * agg)
1531 GstAggregatorClass *klass;
1534 gst_aggregator_reset_flow_values (agg);
1536 /* Application needs to make sure no pads are added while it shuts us down */
1537 gst_element_foreach_sink_pad (GST_ELEMENT_CAST (agg),
1538 gst_aggregator_stop_pad, NULL);
1540 klass = GST_AGGREGATOR_GET_CLASS (agg);
1543 result = klass->stop (agg);
1547 agg->priv->has_peer_latency = FALSE;
1548 agg->priv->peer_latency_live = FALSE;
1549 agg->priv->peer_latency_min = agg->priv->peer_latency_max = 0;
1551 if (agg->priv->tags)
1552 gst_tag_list_unref (agg->priv->tags);
1553 agg->priv->tags = NULL;
1555 gst_aggregator_set_allocation (agg, NULL, NULL, NULL, NULL);
1560 /* GstElement vmethods implementations */
1561 static GstStateChangeReturn
1562 gst_aggregator_change_state (GstElement * element, GstStateChange transition)
1564 GstStateChangeReturn ret;
1565 GstAggregator *self = GST_AGGREGATOR (element);
1567 switch (transition) {
1568 case GST_STATE_CHANGE_READY_TO_PAUSED:
1569 if (!gst_aggregator_start (self))
1577 GST_ELEMENT_CLASS (aggregator_parent_class)->change_state (element,
1578 transition)) == GST_STATE_CHANGE_FAILURE)
1582 switch (transition) {
1583 case GST_STATE_CHANGE_PAUSED_TO_READY:
1584 if (!gst_aggregator_stop (self)) {
1585 /* What to do in this case? Error out? */
1586 GST_ERROR_OBJECT (self, "Subclass failed to stop.");
1598 GST_ERROR_OBJECT (element, "parent failed state change");
1603 GST_ERROR_OBJECT (element, "Subclass failed to start");
1604 return GST_STATE_CHANGE_FAILURE;
1609 gst_aggregator_release_pad (GstElement * element, GstPad * pad)
1611 GstAggregator *self = GST_AGGREGATOR (element);
1612 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1614 GST_INFO_OBJECT (pad, "Removing pad");
1617 gst_aggregator_pad_set_flushing (aggpad, GST_FLOW_FLUSHING, TRUE);
1618 gst_element_remove_pad (element, pad);
1620 self->priv->has_peer_latency = FALSE;
1621 SRC_BROADCAST (self);
1625 static GstAggregatorPad *
1626 gst_aggregator_default_create_new_pad (GstAggregator * self,
1627 GstPadTemplate * templ, const gchar * req_name, const GstCaps * caps)
1629 GstAggregatorPad *agg_pad;
1630 GstAggregatorPrivate *priv = self->priv;
1634 GST_PAD_TEMPLATE_GTYPE (templ) ==
1635 G_TYPE_NONE ? GST_TYPE_AGGREGATOR_PAD : GST_PAD_TEMPLATE_GTYPE (templ);
1637 if (templ->direction != GST_PAD_SINK)
1640 if (templ->presence != GST_PAD_REQUEST)
1643 GST_OBJECT_LOCK (self);
1644 if (req_name == NULL || strlen (req_name) < 6
1645 || !g_str_has_prefix (req_name, "sink_")) {
1646 /* no name given when requesting the pad, use next available int */
1647 serial = ++priv->max_padserial;
1649 /* parse serial number from requested padname */
1650 serial = g_ascii_strtoull (&req_name[5], NULL, 10);
1651 if (serial > priv->max_padserial)
1652 priv->max_padserial = serial;
1655 name = g_strdup_printf ("sink_%u", serial);
1656 agg_pad = g_object_new (pad_type,
1657 "name", name, "direction", GST_PAD_SINK, "template", templ, NULL);
1660 GST_OBJECT_UNLOCK (self);
1667 GST_WARNING_OBJECT (self, "request new pad that is not a SINK pad");
1672 GST_WARNING_OBJECT (self, "request new pad that is not a REQUEST pad");
1678 gst_aggregator_request_new_pad (GstElement * element,
1679 GstPadTemplate * templ, const gchar * req_name, const GstCaps * caps)
1681 GstAggregator *self;
1682 GstAggregatorPad *agg_pad;
1683 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (element);
1684 GstAggregatorPrivate *priv = GST_AGGREGATOR (element)->priv;
1686 self = GST_AGGREGATOR (element);
1688 agg_pad = klass->create_new_pad (self, templ, req_name, caps);
1690 GST_ERROR_OBJECT (element, "Couldn't create new pad");
1694 GST_DEBUG_OBJECT (element, "Adding pad %s", GST_PAD_NAME (agg_pad));
1697 gst_pad_set_active (GST_PAD (agg_pad), TRUE);
1699 /* add the pad to the element */
1700 gst_element_add_pad (element, GST_PAD (agg_pad));
1702 return GST_PAD (agg_pad);
1705 /* Must be called with SRC_LOCK held */
1708 gst_aggregator_query_latency_unlocked (GstAggregator * self, GstQuery * query)
1710 gboolean query_ret, live;
1711 GstClockTime our_latency, min, max;
1713 query_ret = gst_pad_query_default (self->srcpad, GST_OBJECT (self), query);
1716 GST_WARNING_OBJECT (self, "Latency query failed");
1720 gst_query_parse_latency (query, &live, &min, &max);
1722 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (min))) {
1723 GST_ERROR_OBJECT (self, "Invalid minimum latency %" GST_TIME_FORMAT
1724 ". Please file a bug at " PACKAGE_BUGREPORT ".", GST_TIME_ARGS (min));
1728 if (min > max && GST_CLOCK_TIME_IS_VALID (max)) {
1729 GST_ELEMENT_WARNING (self, CORE, CLOCK, (NULL),
1730 ("Impossible to configure latency: max %" GST_TIME_FORMAT " < min %"
1731 GST_TIME_FORMAT ". Add queues or other buffering elements.",
1732 GST_TIME_ARGS (max), GST_TIME_ARGS (min)));
1736 our_latency = self->priv->latency;
1738 self->priv->peer_latency_live = live;
1739 self->priv->peer_latency_min = min;
1740 self->priv->peer_latency_max = max;
1741 self->priv->has_peer_latency = TRUE;
1745 min += self->priv->sub_latency_min;
1746 if (GST_CLOCK_TIME_IS_VALID (self->priv->sub_latency_max)
1747 && GST_CLOCK_TIME_IS_VALID (max))
1748 max += self->priv->sub_latency_max + our_latency;
1750 max = GST_CLOCK_TIME_NONE;
1752 SRC_BROADCAST (self);
1754 GST_DEBUG_OBJECT (self, "configured latency live:%s min:%" G_GINT64_FORMAT
1755 " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
1757 gst_query_set_latency (query, live, min, max);
1763 * MUST be called with the src_lock held.
1765 * See gst_aggregator_get_latency() for doc
1768 gst_aggregator_get_latency_unlocked (GstAggregator * self)
1770 GstClockTime latency;
1772 g_return_val_if_fail (GST_IS_AGGREGATOR (self), 0);
1774 if (!self->priv->has_peer_latency) {
1775 GstQuery *query = gst_query_new_latency ();
1778 ret = gst_aggregator_query_latency_unlocked (self, query);
1779 gst_query_unref (query);
1781 return GST_CLOCK_TIME_NONE;
1784 if (!self->priv->has_peer_latency || !self->priv->peer_latency_live)
1785 return GST_CLOCK_TIME_NONE;
1787 /* latency_min is never GST_CLOCK_TIME_NONE by construction */
1788 latency = self->priv->peer_latency_min;
1791 latency += self->priv->latency;
1792 latency += self->priv->sub_latency_min;
1798 * gst_aggregator_get_latency:
1799 * @self: a #GstAggregator
1801 * Retrieves the latency values reported by @self in response to the latency
1802 * query, or %GST_CLOCK_TIME_NONE if there is not live source connected and the element
1803 * will not wait for the clock.
1805 * Typically only called by subclasses.
1807 * Returns: The latency or %GST_CLOCK_TIME_NONE if the element does not sync
1810 gst_aggregator_get_latency (GstAggregator * self)
1815 ret = gst_aggregator_get_latency_unlocked (self);
1822 gst_aggregator_send_event (GstElement * element, GstEvent * event)
1824 GstAggregator *self = GST_AGGREGATOR (element);
1826 GST_STATE_LOCK (element);
1827 if (GST_EVENT_TYPE (event) == GST_EVENT_SEEK &&
1828 GST_STATE (element) < GST_STATE_PAUSED) {
1832 GstSeekType start_type, stop_type;
1835 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1836 &start, &stop_type, &stop);
1838 GST_OBJECT_LOCK (self);
1839 gst_segment_do_seek (&GST_AGGREGATOR_PAD (self->srcpad)->segment, rate, fmt,
1840 flags, start_type, start, stop_type, stop, NULL);
1841 self->priv->seqnum = gst_event_get_seqnum (event);
1842 self->priv->first_buffer = FALSE;
1843 GST_OBJECT_UNLOCK (self);
1845 GST_DEBUG_OBJECT (element, "Storing segment %" GST_PTR_FORMAT, event);
1847 GST_STATE_UNLOCK (element);
1850 return GST_ELEMENT_CLASS (aggregator_parent_class)->send_event (element,
1855 gst_aggregator_default_src_query (GstAggregator * self, GstQuery * query)
1857 gboolean res = TRUE;
1859 switch (GST_QUERY_TYPE (query)) {
1860 case GST_QUERY_SEEKING:
1864 /* don't pass it along as some (file)sink might claim it does
1865 * whereas with a collectpads in between that will not likely work */
1866 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
1867 gst_query_set_seeking (query, format, FALSE, 0, -1);
1872 case GST_QUERY_LATENCY:
1874 res = gst_aggregator_query_latency_unlocked (self, query);
1878 return gst_pad_query_default (self->srcpad, GST_OBJECT (self), query);
1885 gst_aggregator_event_forward_func (GstPad * pad, gpointer user_data)
1887 EventData *evdata = user_data;
1888 gboolean ret = TRUE;
1889 GstPad *peer = gst_pad_get_peer (pad);
1890 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
1893 if (evdata->only_to_active_pads && aggpad->priv->first_buffer) {
1894 GST_DEBUG_OBJECT (pad, "not sending event to inactive pad");
1897 ret = gst_pad_send_event (peer, gst_event_ref (evdata->event));
1898 GST_DEBUG_OBJECT (pad, "return of event push is %d", ret);
1899 gst_object_unref (peer);
1904 if (GST_EVENT_TYPE (evdata->event) == GST_EVENT_SEEK) {
1905 GstQuery *seeking = gst_query_new_seeking (GST_FORMAT_TIME);
1907 GST_DEBUG_OBJECT (pad, "Event %" GST_PTR_FORMAT " failed", evdata->event);
1909 if (gst_pad_query (peer, seeking)) {
1912 gst_query_parse_seeking (seeking, NULL, &seekable, NULL, NULL);
1914 if (seekable == FALSE) {
1915 GST_INFO_OBJECT (pad,
1916 "Source not seekable, We failed but it does not matter!");
1921 GST_ERROR_OBJECT (pad, "Query seeking FAILED");
1924 gst_query_unref (seeking);
1927 if (evdata->flush) {
1929 aggpad->priv->pending_flush_start = FALSE;
1930 aggpad->priv->pending_flush_stop = FALSE;
1931 PAD_UNLOCK (aggpad);
1934 evdata->one_actually_seeked = TRUE;
1937 evdata->result &= ret;
1939 /* Always send to all pads */
1944 gst_aggregator_forward_event_to_all_sinkpads (GstAggregator * self,
1947 evdata->result = TRUE;
1948 evdata->one_actually_seeked = FALSE;
1950 /* We first need to set all pads as flushing in a first pass
1951 * as flush_start flush_stop is sometimes sent synchronously
1952 * while we send the seek event */
1953 if (evdata->flush) {
1956 GST_OBJECT_LOCK (self);
1957 for (l = GST_ELEMENT_CAST (self)->sinkpads; l != NULL; l = l->next) {
1958 GstAggregatorPad *pad = l->data;
1961 pad->priv->pending_flush_start = TRUE;
1962 pad->priv->pending_flush_stop = FALSE;
1965 GST_OBJECT_UNLOCK (self);
1968 gst_pad_forward (self->srcpad, gst_aggregator_event_forward_func, evdata);
1970 gst_event_unref (evdata->event);
1974 gst_aggregator_do_seek (GstAggregator * self, GstEvent * event)
1979 GstSeekType start_type, stop_type;
1982 EventData evdata = { 0, };
1983 GstAggregatorPrivate *priv = self->priv;
1985 gst_event_parse_seek (event, &rate, &fmt, &flags, &start_type,
1986 &start, &stop_type, &stop);
1988 GST_INFO_OBJECT (self, "starting SEEK");
1990 flush = flags & GST_SEEK_FLAG_FLUSH;
1992 GST_OBJECT_LOCK (self);
1994 priv->pending_flush_start = TRUE;
1995 priv->flush_seeking = TRUE;
1998 gst_segment_do_seek (&GST_AGGREGATOR_PAD (self->srcpad)->segment, rate, fmt,
1999 flags, start_type, start, stop_type, stop, NULL);
2001 /* Seeking sets a position */
2002 self->priv->first_buffer = FALSE;
2003 GST_OBJECT_UNLOCK (self);
2005 /* forward the seek upstream */
2006 evdata.event = event;
2007 evdata.flush = flush;
2008 evdata.only_to_active_pads = FALSE;
2009 gst_aggregator_forward_event_to_all_sinkpads (self, &evdata);
2012 if (!evdata.result || !evdata.one_actually_seeked) {
2013 GST_OBJECT_LOCK (self);
2014 priv->flush_seeking = FALSE;
2015 priv->pending_flush_start = FALSE;
2016 GST_OBJECT_UNLOCK (self);
2019 GST_INFO_OBJECT (self, "seek done, result: %d", evdata.result);
2021 return evdata.result;
2025 gst_aggregator_default_src_event (GstAggregator * self, GstEvent * event)
2027 EventData evdata = { 0, };
2029 switch (GST_EVENT_TYPE (event)) {
2030 case GST_EVENT_SEEK:
2031 /* _do_seek() unrefs the event. */
2032 return gst_aggregator_do_seek (self, event);
2033 case GST_EVENT_NAVIGATION:
2034 /* navigation is rather pointless. */
2035 gst_event_unref (event);
2041 /* Don't forward QOS events to pads that had no active buffer yet. Otherwise
2042 * they will receive a QOS event that has earliest_time=0 (because we can't
2043 * have negative timestamps), and consider their buffer as too late */
2044 evdata.event = event;
2045 evdata.flush = FALSE;
2046 evdata.only_to_active_pads = GST_EVENT_TYPE (event) == GST_EVENT_QOS;
2047 gst_aggregator_forward_event_to_all_sinkpads (self, &evdata);
2048 return evdata.result;
2052 gst_aggregator_src_pad_event_func (GstPad * pad, GstObject * parent,
2055 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
2057 return klass->src_event (GST_AGGREGATOR (parent), event);
2061 gst_aggregator_src_pad_query_func (GstPad * pad, GstObject * parent,
2064 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
2066 return klass->src_query (GST_AGGREGATOR (parent), query);
2070 gst_aggregator_src_pad_activate_mode_func (GstPad * pad,
2071 GstObject * parent, GstPadMode mode, gboolean active)
2073 GstAggregator *self = GST_AGGREGATOR (parent);
2074 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
2076 if (klass->src_activate) {
2077 if (klass->src_activate (self, mode, active) == FALSE) {
2082 if (active == TRUE) {
2084 case GST_PAD_MODE_PUSH:
2086 GST_INFO_OBJECT (pad, "Activating pad!");
2087 gst_aggregator_start_srcpad_task (self);
2092 GST_ERROR_OBJECT (pad, "Only supported mode is PUSH");
2099 GST_INFO_OBJECT (self, "Deactivating srcpad");
2100 gst_aggregator_stop_srcpad_task (self, FALSE);
2106 gst_aggregator_default_sink_query (GstAggregator * self,
2107 GstAggregatorPad * aggpad, GstQuery * query)
2109 GstPad *pad = GST_PAD (aggpad);
2111 if (GST_QUERY_TYPE (query) == GST_QUERY_ALLOCATION) {
2112 GstQuery *decide_query = NULL;
2113 GstAggregatorClass *agg_class;
2116 GST_OBJECT_LOCK (self);
2118 if (G_UNLIKELY (!aggpad->priv->negotiated)) {
2119 GST_DEBUG_OBJECT (self,
2120 "not negotiated yet, can't answer ALLOCATION query");
2121 PAD_UNLOCK (aggpad);
2122 GST_OBJECT_UNLOCK (self);
2127 if ((decide_query = self->priv->allocation_query))
2128 gst_query_ref (decide_query);
2129 PAD_UNLOCK (aggpad);
2130 GST_OBJECT_UNLOCK (self);
2132 GST_DEBUG_OBJECT (self,
2133 "calling propose allocation with query %" GST_PTR_FORMAT, decide_query);
2135 agg_class = GST_AGGREGATOR_GET_CLASS (self);
2137 /* pass the query to the propose_allocation vmethod if any */
2138 if (agg_class->propose_allocation)
2139 ret = agg_class->propose_allocation (self, aggpad, decide_query, query);
2144 gst_query_unref (decide_query);
2146 GST_DEBUG_OBJECT (self, "ALLOCATION ret %d, %" GST_PTR_FORMAT, ret, query);
2150 return gst_pad_query_default (pad, GST_OBJECT (self), query);
2154 gst_aggregator_finalize (GObject * object)
2156 GstAggregator *self = (GstAggregator *) object;
2158 g_mutex_clear (&self->priv->src_lock);
2159 g_cond_clear (&self->priv->src_cond);
2161 G_OBJECT_CLASS (aggregator_parent_class)->finalize (object);
2165 * gst_aggregator_set_latency_property:
2166 * @agg: a #GstAggregator
2167 * @latency: the new latency value (in nanoseconds).
2169 * Sets the new latency value to @latency. This value is used to limit the
2170 * amount of time a pad waits for data to appear before considering the pad
2174 gst_aggregator_set_latency_property (GstAggregator * self, GstClockTime latency)
2178 g_return_if_fail (GST_IS_AGGREGATOR (self));
2179 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (latency));
2182 changed = (self->priv->latency != latency);
2187 GST_OBJECT_LOCK (self);
2188 /* First lock all the pads */
2189 for (item = GST_ELEMENT_CAST (self)->sinkpads; item; item = item->next) {
2190 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (item->data);
2194 self->priv->latency = latency;
2196 SRC_BROADCAST (self);
2198 /* Now wake up the pads */
2199 for (item = GST_ELEMENT_CAST (self)->sinkpads; item; item = item->next) {
2200 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (item->data);
2201 PAD_BROADCAST_EVENT (aggpad);
2202 PAD_UNLOCK (aggpad);
2204 GST_OBJECT_UNLOCK (self);
2210 gst_element_post_message (GST_ELEMENT_CAST (self),
2211 gst_message_new_latency (GST_OBJECT_CAST (self)));
2215 * gst_aggregator_get_latency_property:
2216 * @agg: a #GstAggregator
2218 * Gets the latency value. See gst_aggregator_set_latency for
2221 * Returns: The time in nanoseconds to wait for data to arrive on a sink pad
2222 * before a pad is deemed unresponsive. A value of -1 means an
2226 gst_aggregator_get_latency_property (GstAggregator * agg)
2230 g_return_val_if_fail (GST_IS_AGGREGATOR (agg), GST_CLOCK_TIME_NONE);
2232 GST_OBJECT_LOCK (agg);
2233 res = agg->priv->latency;
2234 GST_OBJECT_UNLOCK (agg);
2240 gst_aggregator_set_property (GObject * object, guint prop_id,
2241 const GValue * value, GParamSpec * pspec)
2243 GstAggregator *agg = GST_AGGREGATOR (object);
2247 gst_aggregator_set_latency_property (agg, g_value_get_uint64 (value));
2249 case PROP_START_TIME_SELECTION:
2250 agg->priv->start_time_selection = g_value_get_enum (value);
2252 case PROP_START_TIME:
2253 agg->priv->start_time = g_value_get_uint64 (value);
2256 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2262 gst_aggregator_get_property (GObject * object, guint prop_id,
2263 GValue * value, GParamSpec * pspec)
2265 GstAggregator *agg = GST_AGGREGATOR (object);
2269 g_value_set_uint64 (value, gst_aggregator_get_latency_property (agg));
2271 case PROP_START_TIME_SELECTION:
2272 g_value_set_enum (value, agg->priv->start_time_selection);
2274 case PROP_START_TIME:
2275 g_value_set_uint64 (value, agg->priv->start_time);
2278 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2283 /* GObject vmethods implementations */
2285 gst_aggregator_class_init (GstAggregatorClass * klass)
2287 GObjectClass *gobject_class = (GObjectClass *) klass;
2288 GstElementClass *gstelement_class = (GstElementClass *) klass;
2290 aggregator_parent_class = g_type_class_peek_parent (klass);
2292 GST_DEBUG_CATEGORY_INIT (aggregator_debug, "aggregator",
2293 GST_DEBUG_FG_MAGENTA, "GstAggregator");
2295 if (aggregator_private_offset != 0)
2296 g_type_class_adjust_private_offset (klass, &aggregator_private_offset);
2298 klass->finish_buffer = gst_aggregator_default_finish_buffer;
2300 klass->sink_event = gst_aggregator_default_sink_event;
2301 klass->sink_query = gst_aggregator_default_sink_query;
2303 klass->src_event = gst_aggregator_default_src_event;
2304 klass->src_query = gst_aggregator_default_src_query;
2306 klass->create_new_pad = gst_aggregator_default_create_new_pad;
2307 klass->update_src_caps = gst_aggregator_default_update_src_caps;
2308 klass->fixate_src_caps = gst_aggregator_default_fixate_src_caps;
2309 klass->negotiated_src_caps = gst_aggregator_default_negotiated_src_caps;
2311 gstelement_class->request_new_pad =
2312 GST_DEBUG_FUNCPTR (gst_aggregator_request_new_pad);
2313 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_aggregator_send_event);
2314 gstelement_class->release_pad =
2315 GST_DEBUG_FUNCPTR (gst_aggregator_release_pad);
2316 gstelement_class->change_state =
2317 GST_DEBUG_FUNCPTR (gst_aggregator_change_state);
2319 gobject_class->set_property = gst_aggregator_set_property;
2320 gobject_class->get_property = gst_aggregator_get_property;
2321 gobject_class->finalize = gst_aggregator_finalize;
2323 g_object_class_install_property (gobject_class, PROP_LATENCY,
2324 g_param_spec_uint64 ("latency", "Buffer latency",
2325 "Additional latency in live mode to allow upstream "
2326 "to take longer to produce buffers for the current "
2327 "position (in nanoseconds)", 0, G_MAXUINT64,
2328 DEFAULT_LATENCY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
2330 g_object_class_install_property (gobject_class, PROP_START_TIME_SELECTION,
2331 g_param_spec_enum ("start-time-selection", "Start Time Selection",
2332 "Decides which start time is output",
2333 gst_aggregator_start_time_selection_get_type (),
2334 DEFAULT_START_TIME_SELECTION,
2335 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
2337 g_object_class_install_property (gobject_class, PROP_START_TIME,
2338 g_param_spec_uint64 ("start-time", "Start Time",
2339 "Start time to use if start-time-selection=set", 0,
2341 DEFAULT_START_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
2344 static inline gpointer
2345 gst_aggregator_get_instance_private (GstAggregator * self)
2347 return (G_STRUCT_MEMBER_P (self, aggregator_private_offset));
2351 gst_aggregator_init (GstAggregator * self, GstAggregatorClass * klass)
2353 GstPadTemplate *pad_template;
2354 GstAggregatorPrivate *priv;
2356 g_return_if_fail (klass->aggregate != NULL);
2358 self->priv = gst_aggregator_get_instance_private (self);
2363 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (klass), "src");
2364 g_return_if_fail (pad_template != NULL);
2366 priv->max_padserial = -1;
2367 priv->tags_changed = FALSE;
2369 self->priv->peer_latency_live = FALSE;
2370 self->priv->peer_latency_min = self->priv->sub_latency_min = 0;
2371 self->priv->peer_latency_max = self->priv->sub_latency_max = 0;
2372 self->priv->has_peer_latency = FALSE;
2374 self->srcpad = gst_pad_new_from_template (pad_template, "src");
2376 gst_aggregator_reset_flow_values (self);
2378 gst_pad_set_event_function (self->srcpad,
2379 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_event_func));
2380 gst_pad_set_query_function (self->srcpad,
2381 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_query_func));
2382 gst_pad_set_activatemode_function (self->srcpad,
2383 GST_DEBUG_FUNCPTR (gst_aggregator_src_pad_activate_mode_func));
2385 gst_element_add_pad (GST_ELEMENT (self), self->srcpad);
2387 self->priv->latency = DEFAULT_LATENCY;
2388 self->priv->start_time_selection = DEFAULT_START_TIME_SELECTION;
2389 self->priv->start_time = DEFAULT_START_TIME;
2391 g_mutex_init (&self->priv->src_lock);
2392 g_cond_init (&self->priv->src_cond);
2395 /* we can't use G_DEFINE_ABSTRACT_TYPE because we need the klass in the _init
2396 * method to get to the padtemplates */
2398 gst_aggregator_get_type (void)
2400 static volatile gsize type = 0;
2402 if (g_once_init_enter (&type)) {
2404 static const GTypeInfo info = {
2405 sizeof (GstAggregatorClass),
2408 (GClassInitFunc) gst_aggregator_class_init,
2411 sizeof (GstAggregator),
2413 (GInstanceInitFunc) gst_aggregator_init,
2416 _type = g_type_register_static (GST_TYPE_ELEMENT,
2417 "GstAggregator", &info, G_TYPE_FLAG_ABSTRACT);
2419 aggregator_private_offset =
2420 g_type_add_instance_private (_type, sizeof (GstAggregatorPrivate));
2422 g_once_init_leave (&type, _type);
2427 /* Must be called with SRC lock and PAD lock held */
2429 gst_aggregator_pad_has_space (GstAggregator * self, GstAggregatorPad * aggpad)
2431 /* Empty queue always has space */
2432 if (aggpad->priv->num_buffers == 0 && aggpad->priv->clipped_buffer == NULL)
2435 /* We also want at least two buffers, one is being processed and one is ready
2436 * for the next iteration when we operate in live mode. */
2437 if (self->priv->peer_latency_live && aggpad->priv->num_buffers < 2)
2440 /* zero latency, if there is a buffer, it's full */
2441 if (self->priv->latency == 0)
2444 /* Allow no more buffers than the latency */
2445 return (aggpad->priv->time_level <= self->priv->latency);
2448 /* Must be called with the PAD_LOCK held */
2450 apply_buffer (GstAggregatorPad * aggpad, GstBuffer * buffer, gboolean head)
2452 GstClockTime timestamp;
2454 if (GST_BUFFER_DTS_IS_VALID (buffer))
2455 timestamp = GST_BUFFER_DTS (buffer);
2457 timestamp = GST_BUFFER_PTS (buffer);
2459 if (timestamp == GST_CLOCK_TIME_NONE) {
2461 timestamp = aggpad->priv->head_position;
2463 timestamp = aggpad->priv->tail_position;
2467 if (GST_BUFFER_DURATION_IS_VALID (buffer))
2468 timestamp += GST_BUFFER_DURATION (buffer);
2471 aggpad->priv->head_position = timestamp;
2473 aggpad->priv->tail_position = timestamp;
2475 update_time_level (aggpad, head);
2479 * Can be called either from the sinkpad's chain function or from the srcpad's
2480 * thread in the case of a buffer synthetized from a GAP event.
2481 * Because of this second case, FLUSH_LOCK can't be used here.
2484 static GstFlowReturn
2485 gst_aggregator_pad_chain_internal (GstAggregator * self,
2486 GstAggregatorPad * aggpad, GstBuffer * buffer, gboolean head)
2488 GstFlowReturn flow_return;
2489 GstClockTime buf_pts;
2492 flow_return = aggpad->priv->flow_return;
2493 if (flow_return != GST_FLOW_OK)
2496 PAD_UNLOCK (aggpad);
2498 buf_pts = GST_BUFFER_PTS (buffer);
2502 GST_OBJECT_LOCK (self);
2505 if (aggpad->priv->first_buffer) {
2506 self->priv->has_peer_latency = FALSE;
2507 aggpad->priv->first_buffer = FALSE;
2510 if ((gst_aggregator_pad_has_space (self, aggpad) || !head)
2511 && aggpad->priv->flow_return == GST_FLOW_OK) {
2513 g_queue_push_head (&aggpad->priv->data, buffer);
2515 g_queue_push_tail (&aggpad->priv->data, buffer);
2516 apply_buffer (aggpad, buffer, head);
2517 aggpad->priv->num_buffers++;
2519 SRC_BROADCAST (self);
2523 flow_return = aggpad->priv->flow_return;
2524 if (flow_return != GST_FLOW_OK) {
2525 GST_OBJECT_UNLOCK (self);
2529 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
2530 GST_OBJECT_UNLOCK (self);
2532 PAD_WAIT_EVENT (aggpad);
2534 PAD_UNLOCK (aggpad);
2537 if (self->priv->first_buffer) {
2538 GstClockTime start_time;
2539 GstAggregatorPad *srcpad = GST_AGGREGATOR_PAD (self->srcpad);
2541 switch (self->priv->start_time_selection) {
2542 case GST_AGGREGATOR_START_TIME_SELECTION_ZERO:
2546 case GST_AGGREGATOR_START_TIME_SELECTION_FIRST:
2547 GST_OBJECT_LOCK (aggpad);
2548 if (aggpad->priv->head_segment.format == GST_FORMAT_TIME) {
2549 start_time = buf_pts;
2550 if (start_time != -1) {
2551 start_time = MAX (start_time, aggpad->priv->head_segment.start);
2553 gst_segment_to_running_time (&aggpad->priv->head_segment,
2554 GST_FORMAT_TIME, start_time);
2558 GST_WARNING_OBJECT (aggpad,
2559 "Ignoring request of selecting the first start time "
2560 "as the segment is a %s segment instead of a time segment",
2561 gst_format_get_name (aggpad->segment.format));
2563 GST_OBJECT_UNLOCK (aggpad);
2565 case GST_AGGREGATOR_START_TIME_SELECTION_SET:
2566 start_time = self->priv->start_time;
2567 if (start_time == -1)
2572 if (start_time != -1) {
2573 if (srcpad->segment.position == -1)
2574 srcpad->segment.position = start_time;
2576 srcpad->segment.position = MIN (start_time, srcpad->segment.position);
2578 GST_DEBUG_OBJECT (self, "Selecting start time %" GST_TIME_FORMAT,
2579 GST_TIME_ARGS (start_time));
2583 PAD_UNLOCK (aggpad);
2584 GST_OBJECT_UNLOCK (self);
2587 GST_DEBUG_OBJECT (aggpad, "Done chaining");
2592 PAD_UNLOCK (aggpad);
2594 GST_DEBUG_OBJECT (aggpad, "Pad is %s, dropping buffer",
2595 gst_flow_get_name (flow_return));
2597 gst_buffer_unref (buffer);
2602 static GstFlowReturn
2603 gst_aggregator_pad_chain (GstPad * pad, GstObject * object, GstBuffer * buffer)
2606 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
2608 PAD_FLUSH_LOCK (aggpad);
2610 ret = gst_aggregator_pad_chain_internal (GST_AGGREGATOR_CAST (object),
2611 aggpad, buffer, TRUE);
2613 PAD_FLUSH_UNLOCK (aggpad);
2619 gst_aggregator_pad_query_func (GstPad * pad, GstObject * parent,
2622 GstAggregator *self = GST_AGGREGATOR (parent);
2623 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
2625 if (GST_QUERY_IS_SERIALIZED (query)) {
2627 gboolean ret = FALSE;
2632 if (aggpad->priv->flow_return != GST_FLOW_OK) {
2637 g_queue_push_head (&aggpad->priv->data, query);
2638 SRC_BROADCAST (self);
2641 while (!gst_aggregator_pad_queue_is_empty (aggpad)
2642 && aggpad->priv->flow_return == GST_FLOW_OK) {
2643 GST_DEBUG_OBJECT (aggpad, "Waiting for buffer to be consumed");
2644 PAD_WAIT_EVENT (aggpad);
2647 s = gst_query_writable_structure (query);
2648 if (gst_structure_get_boolean (s, "gst-aggregator-retval", &ret))
2649 gst_structure_remove_field (s, "gst-aggregator-retval");
2651 g_queue_remove (&aggpad->priv->data, query);
2653 if (aggpad->priv->flow_return != GST_FLOW_OK)
2656 PAD_UNLOCK (aggpad);
2660 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
2662 return klass->sink_query (self, aggpad, query);
2666 GST_DEBUG_OBJECT (aggpad, "Pad is %s, dropping query",
2667 gst_flow_get_name (aggpad->priv->flow_return));
2668 PAD_UNLOCK (aggpad);
2673 /* Queue serialized events and let the others go through directly.
2674 * The queued events with be handled from the src-pad task in
2675 * gst_aggregator_do_events_and_queries().
2677 static GstFlowReturn
2678 gst_aggregator_pad_event_func (GstPad * pad, GstObject * parent,
2681 GstFlowReturn ret = GST_FLOW_OK;
2682 GstAggregator *self = GST_AGGREGATOR (parent);
2683 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
2685 if (GST_EVENT_IS_SERIALIZED (event)
2686 && GST_EVENT_TYPE (event) != GST_EVENT_FLUSH_STOP) {
2690 if (aggpad->priv->flow_return != GST_FLOW_OK)
2693 if (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT) {
2694 GST_OBJECT_LOCK (aggpad);
2695 gst_event_copy_segment (event, &aggpad->priv->head_segment);
2696 aggpad->priv->head_position = aggpad->priv->head_segment.position;
2697 update_time_level (aggpad, TRUE);
2698 GST_OBJECT_UNLOCK (aggpad);
2701 GST_DEBUG_OBJECT (aggpad, "Store event in queue: %" GST_PTR_FORMAT, event);
2702 g_queue_push_head (&aggpad->priv->data, event);
2703 SRC_BROADCAST (self);
2704 PAD_UNLOCK (aggpad);
2707 GstAggregatorClass *klass = GST_AGGREGATOR_GET_CLASS (parent);
2709 if (!klass->sink_event (self, aggpad, event)) {
2710 /* Copied from GstPad to convert boolean to a GstFlowReturn in
2711 * the event handling func */
2712 ret = GST_FLOW_ERROR;
2719 GST_DEBUG_OBJECT (aggpad, "Pad is %s, dropping event",
2720 gst_flow_get_name (aggpad->priv->flow_return));
2721 PAD_UNLOCK (aggpad);
2723 if (GST_EVENT_IS_STICKY (event))
2724 gst_pad_store_sticky_event (pad, event);
2725 gst_event_unref (event);
2727 return aggpad->priv->flow_return;
2731 gst_aggregator_pad_activate_mode_func (GstPad * pad,
2732 GstObject * parent, GstPadMode mode, gboolean active)
2734 GstAggregator *self = GST_AGGREGATOR (parent);
2735 GstAggregatorPad *aggpad = GST_AGGREGATOR_PAD (pad);
2737 if (active == FALSE) {
2739 gst_aggregator_pad_set_flushing (aggpad, GST_FLOW_FLUSHING, TRUE);
2740 SRC_BROADCAST (self);
2744 aggpad->priv->flow_return = GST_FLOW_OK;
2745 PAD_BROADCAST_EVENT (aggpad);
2746 PAD_UNLOCK (aggpad);
2752 /***********************************
2753 * GstAggregatorPad implementation *
2754 ************************************/
2755 G_DEFINE_TYPE_WITH_PRIVATE (GstAggregatorPad, gst_aggregator_pad, GST_TYPE_PAD);
2758 gst_aggregator_pad_constructed (GObject * object)
2760 GstPad *pad = GST_PAD (object);
2762 if (GST_PAD_IS_SINK (pad)) {
2763 gst_pad_set_chain_function (pad,
2764 GST_DEBUG_FUNCPTR (gst_aggregator_pad_chain));
2765 gst_pad_set_event_full_function_full (pad,
2766 GST_DEBUG_FUNCPTR (gst_aggregator_pad_event_func), NULL, NULL);
2767 gst_pad_set_query_function (pad,
2768 GST_DEBUG_FUNCPTR (gst_aggregator_pad_query_func));
2769 gst_pad_set_activatemode_function (pad,
2770 GST_DEBUG_FUNCPTR (gst_aggregator_pad_activate_mode_func));
2775 gst_aggregator_pad_finalize (GObject * object)
2777 GstAggregatorPad *pad = (GstAggregatorPad *) object;
2779 g_cond_clear (&pad->priv->event_cond);
2780 g_mutex_clear (&pad->priv->flush_lock);
2781 g_mutex_clear (&pad->priv->lock);
2783 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->finalize (object);
2787 gst_aggregator_pad_dispose (GObject * object)
2789 GstAggregatorPad *pad = (GstAggregatorPad *) object;
2791 gst_aggregator_pad_set_flushing (pad, GST_FLOW_FLUSHING, TRUE);
2793 G_OBJECT_CLASS (gst_aggregator_pad_parent_class)->dispose (object);
2797 gst_aggregator_pad_class_init (GstAggregatorPadClass * klass)
2799 GObjectClass *gobject_class = (GObjectClass *) klass;
2801 gobject_class->constructed = gst_aggregator_pad_constructed;
2802 gobject_class->finalize = gst_aggregator_pad_finalize;
2803 gobject_class->dispose = gst_aggregator_pad_dispose;
2807 gst_aggregator_pad_init (GstAggregatorPad * pad)
2809 pad->priv = gst_aggregator_pad_get_instance_private (pad);
2811 g_queue_init (&pad->priv->data);
2812 g_cond_init (&pad->priv->event_cond);
2814 g_mutex_init (&pad->priv->flush_lock);
2815 g_mutex_init (&pad->priv->lock);
2817 gst_aggregator_pad_reset_unlocked (pad);
2818 pad->priv->negotiated = FALSE;
2821 /* Must be called with the PAD_LOCK held */
2823 gst_aggregator_pad_buffer_consumed (GstAggregatorPad * pad)
2825 pad->priv->num_buffers--;
2826 GST_TRACE_OBJECT (pad, "Consuming buffer");
2827 PAD_BROADCAST_EVENT (pad);
2830 /* Must be called with the PAD_LOCK held */
2832 gst_aggregator_pad_clip_buffer_unlocked (GstAggregatorPad * pad)
2834 GstAggregator *self = NULL;
2835 GstAggregatorClass *aggclass = NULL;
2836 GstBuffer *buffer = NULL;
2838 while (pad->priv->clipped_buffer == NULL &&
2839 GST_IS_BUFFER (g_queue_peek_tail (&pad->priv->data))) {
2840 buffer = g_queue_pop_tail (&pad->priv->data);
2842 apply_buffer (pad, buffer, FALSE);
2844 /* We only take the parent here so that it's not taken if the buffer is
2845 * already clipped or if the queue is empty.
2848 self = GST_AGGREGATOR (gst_pad_get_parent_element (GST_PAD (pad)));
2850 gst_buffer_unref (buffer);
2854 aggclass = GST_AGGREGATOR_GET_CLASS (self);
2857 if (aggclass->clip) {
2858 GST_TRACE_OBJECT (pad, "Clipping: %" GST_PTR_FORMAT, buffer);
2860 buffer = aggclass->clip (self, pad, buffer);
2862 if (buffer == NULL) {
2863 gst_aggregator_pad_buffer_consumed (pad);
2864 GST_TRACE_OBJECT (pad, "Clipping consumed the buffer");
2868 pad->priv->clipped_buffer = buffer;
2872 gst_object_unref (self);
2876 * gst_aggregator_pad_pop_buffer:
2877 * @pad: the pad to get buffer from
2879 * Steal the ref to the buffer currently queued in @pad.
2881 * Returns: (transfer full): The buffer in @pad or NULL if no buffer was
2882 * queued. You should unref the buffer after usage.
2885 gst_aggregator_pad_pop_buffer (GstAggregatorPad * pad)
2891 gst_aggregator_pad_clip_buffer_unlocked (pad);
2893 buffer = pad->priv->clipped_buffer;
2896 pad->priv->clipped_buffer = NULL;
2897 gst_aggregator_pad_buffer_consumed (pad);
2898 GST_DEBUG_OBJECT (pad, "Consumed: %" GST_PTR_FORMAT, buffer);
2907 * gst_aggregator_pad_drop_buffer:
2908 * @pad: the pad where to drop any pending buffer
2910 * Drop the buffer currently queued in @pad.
2912 * Returns: TRUE if there was a buffer queued in @pad, or FALSE if not.
2915 gst_aggregator_pad_drop_buffer (GstAggregatorPad * pad)
2919 buf = gst_aggregator_pad_pop_buffer (pad);
2924 gst_buffer_unref (buf);
2929 * gst_aggregator_pad_peek_buffer:
2930 * @pad: the pad to get buffer from
2932 * Returns: (transfer full): A reference to the buffer in @pad or
2933 * NULL if no buffer was queued. You should unref the buffer after
2937 gst_aggregator_pad_peek_buffer (GstAggregatorPad * pad)
2943 gst_aggregator_pad_clip_buffer_unlocked (pad);
2945 if (pad->priv->clipped_buffer) {
2946 buffer = gst_buffer_ref (pad->priv->clipped_buffer);
2956 * gst_aggregator_pad_has_buffer:
2957 * @pad: the pad to check the buffer on
2959 * This checks if a pad has a buffer available that will be returned by
2960 * a call to gst_aggregator_pad_peek_buffer() or
2961 * gst_aggregator_pad_pop_buffer().
2963 * Returns: %TRUE if the pad has a buffer available as the next thing.
2968 gst_aggregator_pad_has_buffer (GstAggregatorPad * pad)
2970 gboolean has_buffer;
2973 gst_aggregator_pad_clip_buffer_unlocked (pad);
2974 has_buffer = (pad->priv->clipped_buffer != NULL);
2981 * gst_aggregator_pad_is_eos:
2982 * @pad: an aggregator pad
2984 * Returns: %TRUE if the pad is EOS, otherwise %FALSE.
2987 gst_aggregator_pad_is_eos (GstAggregatorPad * pad)
2992 is_eos = pad->priv->eos;
3000 * gst_aggregator_merge_tags:
3001 * @self: a #GstAggregator
3002 * @tags: a #GstTagList to merge
3003 * @mode: the #GstTagMergeMode to use
3005 * Adds tags to so-called pending tags, which will be processed
3006 * before pushing out data downstream.
3008 * Note that this is provided for convenience, and the subclass is
3009 * not required to use this and can still do tag handling on its own.
3014 gst_aggregator_merge_tags (GstAggregator * self,
3015 const GstTagList * tags, GstTagMergeMode mode)
3019 g_return_if_fail (GST_IS_AGGREGATOR (self));
3020 g_return_if_fail (tags == NULL || GST_IS_TAG_LIST (tags));
3022 /* FIXME Check if we can use OBJECT lock here! */
3023 GST_OBJECT_LOCK (self);
3025 GST_DEBUG_OBJECT (self, "merging tags %" GST_PTR_FORMAT, tags);
3026 otags = self->priv->tags;
3027 self->priv->tags = gst_tag_list_merge (self->priv->tags, tags, mode);
3029 gst_tag_list_unref (otags);
3030 self->priv->tags_changed = TRUE;
3031 GST_OBJECT_UNLOCK (self);
3036 * gst_aggregator_set_latency:
3037 * @self: a #GstAggregator
3038 * @min_latency: minimum latency
3039 * @max_latency: maximum latency
3041 * Lets #GstAggregator sub-classes tell the baseclass what their internal
3042 * latency is. Will also post a LATENCY message on the bus so the pipeline
3043 * can reconfigure its global latency.
3046 gst_aggregator_set_latency (GstAggregator * self,
3047 GstClockTime min_latency, GstClockTime max_latency)
3049 gboolean changed = FALSE;
3051 g_return_if_fail (GST_IS_AGGREGATOR (self));
3052 g_return_if_fail (GST_CLOCK_TIME_IS_VALID (min_latency));
3053 g_return_if_fail (max_latency >= min_latency);
3056 if (self->priv->sub_latency_min != min_latency) {
3057 self->priv->sub_latency_min = min_latency;
3060 if (self->priv->sub_latency_max != max_latency) {
3061 self->priv->sub_latency_max = max_latency;
3066 SRC_BROADCAST (self);
3070 gst_element_post_message (GST_ELEMENT_CAST (self),
3071 gst_message_new_latency (GST_OBJECT_CAST (self)));
3076 * gst_aggregator_get_buffer_pool:
3077 * @self: a #GstAggregator
3079 * Returns: (transfer full): the instance of the #GstBufferPool used
3080 * by @trans; free it after use it
3083 gst_aggregator_get_buffer_pool (GstAggregator * self)
3085 GstBufferPool *pool;
3087 g_return_val_if_fail (GST_IS_AGGREGATOR (self), NULL);
3089 GST_OBJECT_LOCK (self);
3090 pool = self->priv->pool;
3092 gst_object_ref (pool);
3093 GST_OBJECT_UNLOCK (self);
3099 * gst_aggregator_get_allocator:
3100 * @self: a #GstAggregator
3101 * @allocator: (out) (allow-none) (transfer full): the #GstAllocator
3103 * @params: (out) (allow-none) (transfer full): the
3104 * #GstAllocationParams of @allocator
3106 * Lets #GstAggregator sub-classes get the memory @allocator
3107 * acquired by the base class and its @params.
3109 * Unref the @allocator after use it.
3112 gst_aggregator_get_allocator (GstAggregator * self,
3113 GstAllocator ** allocator, GstAllocationParams * params)
3115 g_return_if_fail (GST_IS_AGGREGATOR (self));
3118 *allocator = self->priv->allocator ?
3119 gst_object_ref (self->priv->allocator) : NULL;
3122 *params = self->priv->allocation_params;
3126 * gst_aggregator_simple_get_next_time:
3127 * @self: A #GstAggregator
3129 * This is a simple #GstAggregator::get_next_time implementation that
3130 * just looks at the #GstSegment on the srcpad of the aggregator and bases
3131 * the next time on the running there there.
3133 * This is the desired behaviour in most cases where you have a live source
3134 * and you have a dead line based aggregator subclass.
3136 * Returns: The running time based on the position
3141 gst_aggregator_simple_get_next_time (GstAggregator * self)
3143 GstClockTime next_time;
3144 GstAggregatorPad *srcpad = GST_AGGREGATOR_PAD (self->srcpad);
3145 GstSegment *segment = &srcpad->segment;
3147 GST_OBJECT_LOCK (self);
3148 if (segment->position == -1 || segment->position < segment->start)
3149 next_time = segment->start;
3151 next_time = segment->position;
3153 if (segment->stop != -1 && next_time > segment->stop)
3154 next_time = segment->stop;
3156 next_time = gst_segment_to_running_time (segment, GST_FORMAT_TIME, next_time);
3157 GST_OBJECT_UNLOCK (self);