2 * Copyright (C) 2005 Wim Taymans <wim@fluendo.com>
3 * Copyright (C) 2008 Mark Nauwelaerts <mnauw@users.sourceforge.net>
4 * Copyright (C) 2010 Sebastian Dröge <sebastian.droege@collabora.co.uk>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 * SECTION:gstcollectpads
25 * @short_description: manages a set of pads that operate in collect mode
28 * Manages a set of pads that operate in collect mode. This means that control
29 * is given to the manager of this object when all pads have data.
32 * Collectpads are created with gst_collect_pads_new(). A callback should then
33 * be installed with gst_collect_pads_set_function ().
36 * Pads are added to the collection with gst_collect_pads_add_pad()/
37 * gst_collect_pads_remove_pad(). The pad
38 * has to be a sinkpad. The chain and event functions of the pad are
39 * overridden. The element_private of the pad is used to store
40 * private information for the collectpads.
43 * For each pad, data is queued in the _chain function or by
44 * performing a pull_range.
47 * When data is queued on all pads in waiting mode, the callback function is called.
50 * Data can be dequeued from the pad with the gst_collect_pads_pop() method.
51 * One can peek at the data with the gst_collect_pads_peek() function.
52 * These functions will return NULL if the pad received an EOS event. When all
53 * pads return NULL from a gst_collect_pads_peek(), the element can emit an EOS
57 * Data can also be dequeued in byte units using the gst_collect_pads_available(),
58 * gst_collect_pads_read() and gst_collect_pads_flush() calls.
61 * Elements should call gst_collect_pads_start() and gst_collect_pads_stop() in
62 * their state change functions to start and stop the processing of the collectpads.
63 * The gst_collect_pads_stop() call should be called before calling the parent
64 * element state change function in the PAUSED_TO_READY state change to ensure
65 * no pad is blocked and the element can finish streaming.
68 * gst_collect_pads_collect() and gst_collect_pads_collect_range() can be used by
69 * elements that start a #GstTask to drive the collect_pads. This feature is however
70 * not yet implemented.
73 * gst_collect_pads_set_waiting() sets a pad to waiting or non-waiting mode.
74 * CollectPads element is not waiting for data to be collected on non-waiting pads.
75 * Thus these pads may but need not have data when the callback is called.
76 * All pads are in waiting mode by default.
80 * Last reviewed on 2011-10-28 (0.10.36)
89 #include <gst/gst_private.h>
91 #include "gstcollectpads.h"
93 #include "../../../gst/glib-compat-private.h"
95 GST_DEBUG_CATEGORY_STATIC (collect_pads_debug);
96 #define GST_CAT_DEFAULT collect_pads_debug
98 #define parent_class gst_collect_pads_parent_class
99 G_DEFINE_TYPE (GstCollectPads, gst_collect_pads, GST_TYPE_OBJECT);
101 struct _GstCollectDataPrivate
103 /* refcounting for struct, and destroy callback */
104 GstCollectDataDestroyNotify destroy_notify;
108 struct _GstCollectPadsPrivate
110 /* with LOCK and/or STREAM_LOCK */
113 /* with STREAM_LOCK */
114 guint32 cookie; /* @data list cookie */
115 guint numpads; /* number of pads in @data */
116 guint queuedpads; /* number of pads with a buffer */
117 guint eospads; /* number of pads that are EOS */
118 GstClockTime earliest_time; /* Current earliest time */
119 GstCollectData *earliest_data; /* Pad data for current earliest time */
122 GSList *pad_list; /* updated pad list */
123 guint32 pad_cookie; /* updated cookie */
125 GstCollectPadsFunction func; /* function and user_data for callback */
127 GstCollectPadsBufferFunction buffer_func; /* function and user_data for buffer callback */
128 gpointer buffer_user_data;
129 GstCollectPadsCompareFunction compare_func;
130 gpointer compare_user_data;
131 GstCollectPadsEventFunction event_func; /* function and data for event callback */
132 gpointer event_user_data;
133 GstCollectPadsQueryFunction query_func;
134 gpointer query_user_data;
135 GstCollectPadsClipFunction clip_func;
136 gpointer clip_user_data;
138 /* no other lock needed */
139 GMutex evt_lock; /* these make up sort of poor man's event signaling */
144 static void gst_collect_pads_clear (GstCollectPads * pads,
145 GstCollectData * data);
146 static GstFlowReturn gst_collect_pads_chain (GstPad * pad, GstObject * parent,
148 static gboolean gst_collect_pads_event (GstPad * pad, GstObject * parent,
150 static gboolean gst_collect_pads_query (GstPad * pad, GstObject * parent,
152 static void gst_collect_pads_finalize (GObject * object);
153 static GstFlowReturn gst_collect_pads_default_collected (GstCollectPads *
154 pads, gpointer user_data);
155 static gint gst_collect_pads_default_compare_func (GstCollectPads * pads,
156 GstCollectData * data1, GstClockTime timestamp1, GstCollectData * data2,
157 GstClockTime timestamp2, gpointer user_data);
158 static gboolean gst_collect_pads_recalculate_full (GstCollectPads * pads);
159 static void ref_data (GstCollectData * data);
160 static void unref_data (GstCollectData * data);
162 static gboolean gst_collect_pads_event_default_internal (GstCollectPads *
163 pads, GstCollectData * data, GstEvent * event, gpointer user_data);
164 static gboolean gst_collect_pads_query_default_internal (GstCollectPads *
165 pads, GstCollectData * data, GstQuery * query, gpointer user_data);
168 /* Some properties are protected by LOCK, others by STREAM_LOCK
169 * However, manipulating either of these partitions may require
170 * to signal/wake a _WAIT, so use a separate (sort of) event to prevent races
171 * Alternative implementations are possible, e.g. some low-level re-implementing
172 * of the 2 above locks to drop both of them atomically when going into _WAIT.
174 #define GST_COLLECT_PADS_GET_EVT_COND(pads) (&((GstCollectPads *)pads)->priv->evt_cond)
175 #define GST_COLLECT_PADS_GET_EVT_LOCK(pads) (&((GstCollectPads *)pads)->priv->evt_lock)
176 #define GST_COLLECT_PADS_EVT_WAIT(pads, cookie) G_STMT_START { \
177 g_mutex_lock (GST_COLLECT_PADS_GET_EVT_LOCK (pads)); \
178 /* should work unless a lot of event'ing and thread starvation */\
179 while (cookie == ((GstCollectPads *) pads)->priv->evt_cookie) \
180 g_cond_wait (GST_COLLECT_PADS_GET_EVT_COND (pads), \
181 GST_COLLECT_PADS_GET_EVT_LOCK (pads)); \
182 cookie = ((GstCollectPads *) pads)->priv->evt_cookie; \
183 g_mutex_unlock (GST_COLLECT_PADS_GET_EVT_LOCK (pads)); \
185 #define GST_COLLECT_PADS_EVT_WAIT_TIMED(pads, cookie, timeout) G_STMT_START { \
188 g_get_current_time (&tv); \
189 g_time_val_add (&tv, timeout); \
191 g_mutex_lock (GST_COLLECT_PADS_GET_EVT_LOCK (pads)); \
192 /* should work unless a lot of event'ing and thread starvation */\
193 while (cookie == ((GstCollectPads *) pads)->priv->evt_cookie) \
194 g_cond_timed_wait (GST_COLLECT_PADS_GET_EVT_COND (pads), \
195 GST_COLLECT_PADS_GET_EVT_LOCK (pads), &tv); \
196 cookie = ((GstCollectPads *) pads)->priv->evt_cookie; \
197 g_mutex_unlock (GST_COLLECT_PADS_GET_EVT_LOCK (pads)); \
199 #define GST_COLLECT_PADS_EVT_BROADCAST(pads) G_STMT_START { \
200 g_mutex_lock (GST_COLLECT_PADS_GET_EVT_LOCK (pads)); \
201 /* never mind wrap-around */ \
202 ++(((GstCollectPads *) pads)->priv->evt_cookie); \
203 g_cond_broadcast (GST_COLLECT_PADS_GET_EVT_COND (pads)); \
204 g_mutex_unlock (GST_COLLECT_PADS_GET_EVT_LOCK (pads)); \
206 #define GST_COLLECT_PADS_EVT_INIT(cookie) G_STMT_START { \
207 g_mutex_lock (GST_COLLECT_PADS_GET_EVT_LOCK (pads)); \
208 cookie = ((GstCollectPads *) pads)->priv->evt_cookie; \
209 g_mutex_unlock (GST_COLLECT_PADS_GET_EVT_LOCK (pads)); \
213 gst_collect_pads_class_init (GstCollectPadsClass * klass)
215 GObjectClass *gobject_class = (GObjectClass *) klass;
217 g_type_class_add_private (klass, sizeof (GstCollectPadsPrivate));
219 GST_DEBUG_CATEGORY_INIT (collect_pads_debug, "collectpads", 0,
222 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_collect_pads_finalize);
226 gst_collect_pads_init (GstCollectPads * pads)
229 G_TYPE_INSTANCE_GET_PRIVATE (pads, GST_TYPE_COLLECT_PADS,
230 GstCollectPadsPrivate);
233 pads->priv->cookie = 0;
234 pads->priv->numpads = 0;
235 pads->priv->queuedpads = 0;
236 pads->priv->eospads = 0;
237 pads->priv->started = FALSE;
239 g_rec_mutex_init (&pads->stream_lock);
241 pads->priv->func = gst_collect_pads_default_collected;
242 pads->priv->user_data = NULL;
243 pads->priv->event_func = NULL;
244 pads->priv->event_user_data = NULL;
246 /* members for default muxing */
247 pads->priv->buffer_func = NULL;
248 pads->priv->buffer_user_data = NULL;
249 pads->priv->compare_func = gst_collect_pads_default_compare_func;
250 pads->priv->compare_user_data = NULL;
251 pads->priv->earliest_data = NULL;
252 pads->priv->earliest_time = GST_CLOCK_TIME_NONE;
254 pads->priv->event_func = gst_collect_pads_event_default_internal;
255 pads->priv->query_func = gst_collect_pads_query_default_internal;
257 /* members to manage the pad list */
258 pads->priv->pad_cookie = 0;
259 pads->priv->pad_list = NULL;
261 /* members for event */
262 g_mutex_init (&pads->priv->evt_lock);
263 g_cond_init (&pads->priv->evt_cond);
264 pads->priv->evt_cookie = 0;
268 gst_collect_pads_finalize (GObject * object)
270 GstCollectPads *pads = GST_COLLECT_PADS (object);
272 GST_DEBUG_OBJECT (object, "finalize");
274 g_rec_mutex_clear (&pads->stream_lock);
276 g_cond_clear (&pads->priv->evt_cond);
277 g_mutex_clear (&pads->priv->evt_lock);
279 /* Remove pads and free pads list */
280 g_slist_foreach (pads->priv->pad_list, (GFunc) unref_data, NULL);
281 g_slist_foreach (pads->data, (GFunc) unref_data, NULL);
282 g_slist_free (pads->data);
283 g_slist_free (pads->priv->pad_list);
285 G_OBJECT_CLASS (parent_class)->finalize (object);
289 * gst_collect_pads_new:
291 * Create a new instance of #GstCollectsPads.
295 * Returns: (transfer full): a new #GstCollectPads, or NULL in case of an error.
300 gst_collect_pads_new (void)
302 GstCollectPads *newcoll;
304 newcoll = g_object_new (GST_TYPE_COLLECT_PADS, NULL);
309 /* Must be called with GstObject lock! */
311 gst_collect_pads_set_buffer_function_locked (GstCollectPads * pads,
312 GstCollectPadsBufferFunction func, gpointer user_data)
314 pads->priv->buffer_func = func;
315 pads->priv->buffer_user_data = user_data;
319 * gst_collect_pads_set_buffer_function:
320 * @pads: the collectpads to use
321 * @func: the function to set
322 * @user_data: (closure): user data passed to the function
324 * Set the callback function and user data that will be called with
325 * the oldest buffer when all pads have been collected.
332 gst_collect_pads_set_buffer_function (GstCollectPads * pads,
333 GstCollectPadsBufferFunction func, gpointer user_data)
335 g_return_if_fail (pads != NULL);
336 g_return_if_fail (GST_IS_COLLECT_PADS (pads));
338 GST_OBJECT_LOCK (pads);
339 gst_collect_pads_set_buffer_function_locked (pads, func, user_data);
340 GST_OBJECT_UNLOCK (pads);
344 * gst_collect_pads_set_compare_function:
345 * @pads: the pads to use
346 * @func: the function to set
347 * @user_data: (closure): user data passed to the function
349 * Set the timestamp comparison function.
355 /* NOTE allowing to change comparison seems not advisable;
356 no known use-case, and collaboration with default algorithm is unpredictable.
357 If custom compairing/operation is needed, just use a collect function of
360 gst_collect_pads_set_compare_function (GstCollectPads * pads,
361 GstCollectPadsCompareFunction func, gpointer user_data)
363 g_return_if_fail (pads != NULL);
364 g_return_if_fail (GST_IS_COLLECT_PADS (pads));
366 GST_OBJECT_LOCK (pads);
367 pads->priv->compare_func = func;
368 pads->priv->compare_user_data = user_data;
369 GST_OBJECT_UNLOCK (pads);
373 * gst_collect_pads_set_function:
374 * @pads: the collectspads to use
375 * @func: the function to set
376 * @user_data: user data passed to the function
378 * CollectPads provides a default collection algorithm that will determine
379 * the oldest buffer available on all of its pads, and then delegate
380 * to a configured callback.
381 * However, if circumstances are more complicated and/or more control
382 * is desired, this sets a callback that will be invoked instead when
383 * all the pads added to the collection have buffers queued.
384 * Evidently, this callback is not compatible with
385 * gst_collect_pads_set_buffer_function() callback.
386 * If this callback is set, the former will be unset.
393 gst_collect_pads_set_function (GstCollectPads * pads,
394 GstCollectPadsFunction func, gpointer user_data)
396 g_return_if_fail (pads != NULL);
397 g_return_if_fail (GST_IS_COLLECT_PADS (pads));
399 GST_OBJECT_LOCK (pads);
400 pads->priv->func = func;
401 pads->priv->user_data = user_data;
402 gst_collect_pads_set_buffer_function_locked (pads, NULL, NULL);
403 GST_OBJECT_UNLOCK (pads);
407 ref_data (GstCollectData * data)
409 g_assert (data != NULL);
411 g_atomic_int_inc (&(data->priv->refcount));
415 unref_data (GstCollectData * data)
417 g_assert (data != NULL);
418 g_assert (data->priv->refcount > 0);
420 if (!g_atomic_int_dec_and_test (&(data->priv->refcount)))
423 if (data->priv->destroy_notify)
424 data->priv->destroy_notify (data);
426 g_object_unref (data->pad);
428 gst_buffer_unref (data->buffer);
435 * gst_collect_pads_set_event_function:
436 * @pads: the collectspads to use
437 * @func: the function to set
438 * @user_data: user data passed to the function
440 * Set the event callback function and user data that will be called when
441 * collectpads has received an event originating from one of the collected
442 * pads. If the event being processed is a serialized one, this callback is
443 * called with @pads STREAM_LOCK held, otherwise not. As this lock should be
444 * held when calling a number of CollectPads functions, it should be acquired
445 * if so (unusually) needed.
452 gst_collect_pads_set_event_function (GstCollectPads * pads,
453 GstCollectPadsEventFunction func, gpointer user_data)
455 g_return_if_fail (pads != NULL);
456 g_return_if_fail (GST_IS_COLLECT_PADS (pads));
458 GST_OBJECT_LOCK (pads);
459 pads->priv->event_func = func;
460 pads->priv->event_user_data = user_data;
461 GST_OBJECT_UNLOCK (pads);
465 * gst_collect_pads_set_query_function:
466 * @pads: the collectspads to use
467 * @func: the function to set
468 * @user_data: user data passed to the function
470 * Set the query callback function and user data that will be called after
471 * collectpads has received a query originating from one of the collected
472 * pads. If the query being processed is a serialized one, this callback is
473 * called with @pads STREAM_LOCK held, otherwise not. As this lock should be
474 * held when calling a number of CollectPads functions, it should be acquired
475 * if so (unusually) needed.
482 gst_collect_pads_set_query_function (GstCollectPads * pads,
483 GstCollectPadsQueryFunction func, gpointer user_data)
485 g_return_if_fail (pads != NULL);
486 g_return_if_fail (GST_IS_COLLECT_PADS (pads));
488 GST_OBJECT_LOCK (pads);
489 pads->priv->query_func = func;
490 pads->priv->query_user_data = user_data;
491 GST_OBJECT_UNLOCK (pads);
495 * gst_collect_pads_clip_running_time:
496 * @pads: the collectspads to use
497 * @cdata: collect data of corresponding pad
498 * @buf: buffer being clipped
499 * @outbuf: output buffer with running time, or NULL if clipped
500 * @user_data: user data (unused)
502 * Convenience clipping function that converts incoming buffer's timestamp
503 * to running time, or clips the buffer if outside configured segment.
508 gst_collect_pads_clip_running_time (GstCollectPads * pads,
509 GstCollectData * cdata, GstBuffer * buf, GstBuffer ** outbuf,
515 time = GST_BUFFER_TIMESTAMP (buf);
517 /* invalid left alone and passed */
518 if (G_LIKELY (GST_CLOCK_TIME_IS_VALID (time))) {
519 time = gst_segment_to_running_time (&cdata->segment, GST_FORMAT_TIME, time);
520 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time))) {
521 GST_DEBUG_OBJECT (cdata->pad, "clipping buffer on pad outside segment");
522 gst_buffer_unref (buf);
525 GST_LOG_OBJECT (cdata->pad, "buffer ts %" GST_TIME_FORMAT " -> %"
526 GST_TIME_FORMAT " running time",
527 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)), GST_TIME_ARGS (time));
528 *outbuf = gst_buffer_make_writable (buf);
529 GST_BUFFER_TIMESTAMP (*outbuf) = time;
537 * gst_collect_pads_set_clip_function:
538 * @pads: the collectspads to use
539 * @clipfunc: clip function to install
540 * @user_data: user data to pass to @clip_func
542 * Install a clipping function that is called right after a buffer is received
543 * on a pad managed by @pads. See #GstCollectPad2ClipFunction for more info.
548 gst_collect_pads_set_clip_function (GstCollectPads * pads,
549 GstCollectPadsClipFunction clipfunc, gpointer user_data)
551 g_return_if_fail (pads != NULL);
552 g_return_if_fail (GST_IS_COLLECT_PADS (pads));
554 pads->priv->clip_func = clipfunc;
555 pads->priv->clip_user_data = user_data;
559 * gst_collect_pads_add_pad:
560 * @pads: the collectspads to use
561 * @pad: (transfer none): the pad to add
562 * @size: the size of the returned #GstCollectData structure
564 * Add a pad to the collection of collect pads. The pad has to be
565 * a sinkpad. The refcount of the pad is incremented. Use
566 * gst_collect_pads_remove_pad() to remove the pad from the collection
569 * You specify a size for the returned #GstCollectData structure
570 * so that you can use it to store additional information.
572 * The pad will be automatically activated in push mode when @pads is
575 * This function calls gst_collect_pads_add_pad_full() passing a value of NULL
576 * for destroy_notify and TRUE for locked.
580 * Returns: a new #GstCollectData to identify the new pad. Or NULL
581 * if wrong parameters are supplied.
586 gst_collect_pads_add_pad (GstCollectPads * pads, GstPad * pad, guint size)
588 return gst_collect_pads_add_pad_full (pads, pad, size, NULL, TRUE);
592 * gst_collect_pads_add_pad_full:
593 * @pads: the collectspads to use
594 * @pad: (transfer none): the pad to add
595 * @size: the size of the returned #GstCollectData structure
596 * @destroy_notify: function to be called before the returned #GstCollectData
598 * @lock: whether to lock this pad in usual waiting state
600 * Add a pad to the collection of collect pads. The pad has to be
601 * a sinkpad. The refcount of the pad is incremented. Use
602 * gst_collect_pads_remove_pad() to remove the pad from the collection
605 * You specify a size for the returned #GstCollectData structure
606 * so that you can use it to store additional information.
608 * You can also specify a #GstCollectDataDestroyNotify that will be called
609 * just before the #GstCollectData structure is freed. It is passed the
610 * pointer to the structure and should free any custom memory and resources
613 * Keeping a pad locked in waiting state is only relevant when using
614 * the default collection algorithm (providing the oldest buffer).
615 * It ensures a buffer must be available on this pad for a collection
616 * to take place. This is of typical use to a muxer element where
617 * non-subtitle streams should always be in waiting state,
618 * e.g. to assure that caps information is available on all these streams
619 * when initial headers have to be written.
621 * The pad will be automatically activated in push mode when @pads is
628 * Returns: a new #GstCollectData to identify the new pad. Or NULL
629 * if wrong parameters are supplied.
632 gst_collect_pads_add_pad_full (GstCollectPads * pads, GstPad * pad,
633 guint size, GstCollectDataDestroyNotify destroy_notify, gboolean lock)
635 GstCollectData *data;
637 g_return_val_if_fail (pads != NULL, NULL);
638 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), NULL);
639 g_return_val_if_fail (pad != NULL, NULL);
640 g_return_val_if_fail (GST_PAD_IS_SINK (pad), NULL);
641 g_return_val_if_fail (size >= sizeof (GstCollectData), NULL);
643 GST_DEBUG_OBJECT (pads, "adding pad %s:%s", GST_DEBUG_PAD_NAME (pad));
645 data = g_malloc0 (size);
646 data->priv = g_new0 (GstCollectDataPrivate, 1);
647 data->collect = pads;
648 data->pad = gst_object_ref (pad);
651 gst_segment_init (&data->segment, GST_FORMAT_UNDEFINED);
652 data->state = GST_COLLECT_PADS_STATE_WAITING;
653 data->state |= lock ? GST_COLLECT_PADS_STATE_LOCKED : 0;
654 data->priv->refcount = 1;
655 data->priv->destroy_notify = destroy_notify;
657 GST_OBJECT_LOCK (pads);
658 GST_OBJECT_LOCK (pad);
659 gst_pad_set_element_private (pad, data);
660 GST_OBJECT_UNLOCK (pad);
661 pads->priv->pad_list = g_slist_append (pads->priv->pad_list, data);
662 gst_pad_set_chain_function (pad, GST_DEBUG_FUNCPTR (gst_collect_pads_chain));
663 gst_pad_set_event_function (pad, GST_DEBUG_FUNCPTR (gst_collect_pads_event));
664 gst_pad_set_query_function (pad, GST_DEBUG_FUNCPTR (gst_collect_pads_query));
665 /* backward compat, also add to data if stopped, so that the element already
666 * has this in the public data list before going PAUSED (typically)
667 * this can only be done when we are stopped because we don't take the
668 * STREAM_LOCK to protect the pads->data list. */
669 if (!pads->priv->started) {
670 pads->data = g_slist_append (pads->data, data);
673 /* activate the pad when needed */
674 if (pads->priv->started)
675 gst_pad_set_active (pad, TRUE);
676 pads->priv->pad_cookie++;
677 GST_OBJECT_UNLOCK (pads);
683 find_pad (GstCollectData * data, GstPad * pad)
685 if (data->pad == pad)
691 * gst_collect_pads_remove_pad:
692 * @pads: the collectspads to use
693 * @pad: (transfer none): the pad to remove
695 * Remove a pad from the collection of collect pads. This function will also
696 * free the #GstCollectData and all the resources that were allocated with
697 * gst_collect_pads_add_pad().
699 * The pad will be deactivated automatically when @pads is stopped.
703 * Returns: %TRUE if the pad could be removed.
708 gst_collect_pads_remove_pad (GstCollectPads * pads, GstPad * pad)
710 GstCollectData *data;
713 g_return_val_if_fail (pads != NULL, FALSE);
714 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), FALSE);
715 g_return_val_if_fail (pad != NULL, FALSE);
716 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
718 GST_DEBUG_OBJECT (pads, "removing pad %s:%s", GST_DEBUG_PAD_NAME (pad));
720 GST_OBJECT_LOCK (pads);
722 g_slist_find_custom (pads->priv->pad_list, pad, (GCompareFunc) find_pad);
726 data = (GstCollectData *) list->data;
728 GST_DEBUG_OBJECT (pads, "found pad %s:%s at %p", GST_DEBUG_PAD_NAME (pad),
731 /* clear the stuff we configured */
732 gst_pad_set_chain_function (pad, NULL);
733 gst_pad_set_event_function (pad, NULL);
734 GST_OBJECT_LOCK (pad);
735 gst_pad_set_element_private (pad, NULL);
736 GST_OBJECT_UNLOCK (pad);
738 /* backward compat, also remove from data if stopped, note that this function
739 * can only be called when we are stopped because we don't take the
740 * STREAM_LOCK to protect the pads->data list. */
741 if (!pads->priv->started) {
744 dlist = g_slist_find_custom (pads->data, pad, (GCompareFunc) find_pad);
746 GstCollectData *pdata = dlist->data;
748 pads->data = g_slist_delete_link (pads->data, dlist);
752 /* remove from the pad list */
753 pads->priv->pad_list = g_slist_delete_link (pads->priv->pad_list, list);
754 pads->priv->pad_cookie++;
756 /* signal waiters because something changed */
757 GST_COLLECT_PADS_EVT_BROADCAST (pads);
759 /* deactivate the pad when needed */
760 if (!pads->priv->started)
761 gst_pad_set_active (pad, FALSE);
763 /* clean and free the collect data */
766 GST_OBJECT_UNLOCK (pads);
772 GST_WARNING_OBJECT (pads, "cannot remove unknown pad %s:%s",
773 GST_DEBUG_PAD_NAME (pad));
774 GST_OBJECT_UNLOCK (pads);
780 * gst_collect_pads_is_active:
781 * @pads: the collectspads to use
782 * @pad: the pad to check
784 * Check if a pad is active.
786 * This function is currently not implemented.
790 * Returns: %TRUE if the pad is active.
795 gst_collect_pads_is_active (GstCollectPads * pads, GstPad * pad)
797 g_return_val_if_fail (pads != NULL, FALSE);
798 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), FALSE);
799 g_return_val_if_fail (pad != NULL, FALSE);
800 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
802 g_warning ("gst_collect_pads_is_active() is not implemented");
808 * gst_collect_pads_collect:
809 * @pads: the collectspads to use
811 * Collect data on all pads. This function is usually called
812 * from a #GstTask function in an element.
814 * This function is currently not implemented.
818 * Returns: #GstFlowReturn of the operation.
823 gst_collect_pads_collect (GstCollectPads * pads)
825 g_return_val_if_fail (pads != NULL, GST_FLOW_ERROR);
826 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), GST_FLOW_ERROR);
828 g_warning ("gst_collect_pads_collect() is not implemented");
830 return GST_FLOW_NOT_SUPPORTED;
834 * gst_collect_pads_collect_range:
835 * @pads: the collectspads to use
836 * @offset: the offset to collect
837 * @length: the length to collect
839 * Collect data with @offset and @length on all pads. This function
840 * is typically called in the getrange function of an element.
842 * This function is currently not implemented.
846 * Returns: #GstFlowReturn of the operation.
851 gst_collect_pads_collect_range (GstCollectPads * pads, guint64 offset,
854 g_return_val_if_fail (pads != NULL, GST_FLOW_ERROR);
855 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), GST_FLOW_ERROR);
857 g_warning ("gst_collect_pads_collect_range() is not implemented");
859 return GST_FLOW_NOT_SUPPORTED;
863 * Must be called with STREAM_LOCK.
866 gst_collect_pads_set_flushing_unlocked (GstCollectPads * pads,
871 /* Update the pads flushing flag */
872 for (walk = pads->data; walk; walk = g_slist_next (walk)) {
873 GstCollectData *cdata = walk->data;
875 if (GST_IS_PAD (cdata->pad)) {
876 GST_OBJECT_LOCK (cdata->pad);
878 GST_PAD_SET_FLUSHING (cdata->pad);
880 GST_PAD_UNSET_FLUSHING (cdata->pad);
882 GST_COLLECT_PADS_STATE_SET (cdata, GST_COLLECT_PADS_STATE_FLUSHING);
884 GST_COLLECT_PADS_STATE_UNSET (cdata, GST_COLLECT_PADS_STATE_FLUSHING);
885 gst_collect_pads_clear (pads, cdata);
886 GST_OBJECT_UNLOCK (cdata->pad);
890 /* inform _chain of changes */
891 GST_COLLECT_PADS_EVT_BROADCAST (pads);
895 * gst_collect_pads_set_flushing:
896 * @pads: the collectspads to use
897 * @flushing: desired state of the pads
899 * Change the flushing state of all the pads in the collection. No pad
900 * is able to accept anymore data when @flushing is %TRUE. Calling this
901 * function with @flushing %FALSE makes @pads accept data again.
902 * Caller must ensure that downstream streaming (thread) is not blocked,
903 * e.g. by sending a FLUSH_START downstream.
910 gst_collect_pads_set_flushing (GstCollectPads * pads, gboolean flushing)
912 g_return_if_fail (pads != NULL);
913 g_return_if_fail (GST_IS_COLLECT_PADS (pads));
915 /* NOTE since this eventually calls _pop, some (STREAM_)LOCK is needed here */
916 GST_COLLECT_PADS_STREAM_LOCK (pads);
917 gst_collect_pads_set_flushing_unlocked (pads, flushing);
918 GST_COLLECT_PADS_STREAM_UNLOCK (pads);
922 * gst_collect_pads_start:
923 * @pads: the collectspads to use
925 * Starts the processing of data in the collect_pads.
932 gst_collect_pads_start (GstCollectPads * pads)
936 g_return_if_fail (pads != NULL);
937 g_return_if_fail (GST_IS_COLLECT_PADS (pads));
939 GST_DEBUG_OBJECT (pads, "starting collect pads");
941 /* make sure stop and collect cannot be called anymore */
942 GST_COLLECT_PADS_STREAM_LOCK (pads);
944 /* make pads streamable */
945 GST_OBJECT_LOCK (pads);
947 /* loop over the master pad list and reset the segment */
948 collected = pads->priv->pad_list;
949 for (; collected; collected = g_slist_next (collected)) {
950 GstCollectData *data;
952 data = collected->data;
953 gst_segment_init (&data->segment, GST_FORMAT_UNDEFINED);
956 gst_collect_pads_set_flushing_unlocked (pads, FALSE);
958 /* Start collect pads */
959 pads->priv->started = TRUE;
960 GST_OBJECT_UNLOCK (pads);
961 GST_COLLECT_PADS_STREAM_UNLOCK (pads);
965 * gst_collect_pads_stop:
966 * @pads: the collectspads to use
968 * Stops the processing of data in the collect_pads. this function
969 * will also unblock any blocking operations.
976 gst_collect_pads_stop (GstCollectPads * pads)
980 g_return_if_fail (pads != NULL);
981 g_return_if_fail (GST_IS_COLLECT_PADS (pads));
983 GST_DEBUG_OBJECT (pads, "stopping collect pads");
985 /* make sure collect and start cannot be called anymore */
986 GST_COLLECT_PADS_STREAM_LOCK (pads);
988 /* make pads not accept data anymore */
989 GST_OBJECT_LOCK (pads);
990 gst_collect_pads_set_flushing_unlocked (pads, TRUE);
992 /* Stop collect pads */
993 pads->priv->started = FALSE;
994 pads->priv->eospads = 0;
995 pads->priv->queuedpads = 0;
997 /* loop over the master pad list and flush buffers */
998 collected = pads->priv->pad_list;
999 for (; collected; collected = g_slist_next (collected)) {
1000 GstCollectData *data;
1001 GstBuffer **buffer_p;
1003 data = collected->data;
1005 buffer_p = &data->buffer;
1006 gst_buffer_replace (buffer_p, NULL);
1009 GST_COLLECT_PADS_STATE_UNSET (data, GST_COLLECT_PADS_STATE_EOS);
1012 if (pads->priv->earliest_data)
1013 unref_data (pads->priv->earliest_data);
1014 pads->priv->earliest_data = NULL;
1015 pads->priv->earliest_time = GST_CLOCK_TIME_NONE;
1017 GST_OBJECT_UNLOCK (pads);
1018 /* Wake them up so they can end the chain functions. */
1019 GST_COLLECT_PADS_EVT_BROADCAST (pads);
1021 GST_COLLECT_PADS_STREAM_UNLOCK (pads);
1025 * gst_collect_pads_peek:
1026 * @pads: the collectspads to peek
1027 * @data: the data to use
1029 * Peek at the buffer currently queued in @data. This function
1030 * should be called with the @pads STREAM_LOCK held, such as in the callback
1035 * Returns: The buffer in @data or NULL if no buffer is queued.
1036 * should unref the buffer after usage.
1041 gst_collect_pads_peek (GstCollectPads * pads, GstCollectData * data)
1045 g_return_val_if_fail (pads != NULL, NULL);
1046 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), NULL);
1047 g_return_val_if_fail (data != NULL, NULL);
1049 if ((result = data->buffer))
1050 gst_buffer_ref (result);
1052 GST_DEBUG_OBJECT (pads, "Peeking at pad %s:%s: buffer=%p",
1053 GST_DEBUG_PAD_NAME (data->pad), result);
1059 * gst_collect_pads_pop:
1060 * @pads: the collectspads to pop
1061 * @data: the data to use
1063 * Pop the buffer currently queued in @data. This function
1064 * should be called with the @pads STREAM_LOCK held, such as in the callback
1069 * Returns: (transfer full): The buffer in @data or NULL if no buffer was
1070 * queued. You should unref the buffer after usage.
1075 gst_collect_pads_pop (GstCollectPads * pads, GstCollectData * data)
1079 g_return_val_if_fail (pads != NULL, NULL);
1080 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), NULL);
1081 g_return_val_if_fail (data != NULL, NULL);
1083 if ((result = data->buffer)) {
1084 data->buffer = NULL;
1086 /* one less pad with queued data now */
1087 if (GST_COLLECT_PADS_STATE_IS_SET (data, GST_COLLECT_PADS_STATE_WAITING))
1088 pads->priv->queuedpads--;
1091 GST_COLLECT_PADS_EVT_BROADCAST (pads);
1093 GST_DEBUG_OBJECT (pads, "Pop buffer on pad %s:%s: buffer=%p",
1094 GST_DEBUG_PAD_NAME (data->pad), result);
1099 /* pop and unref the currently queued buffer, should be called with STREAM_LOCK
1102 gst_collect_pads_clear (GstCollectPads * pads, GstCollectData * data)
1106 if ((buf = gst_collect_pads_pop (pads, data)))
1107 gst_buffer_unref (buf);
1111 * gst_collect_pads_available:
1112 * @pads: the collectspads to query
1114 * Query how much bytes can be read from each queued buffer. This means
1115 * that the result of this call is the maximum number of bytes that can
1116 * be read from each of the pads.
1118 * This function should be called with @pads STREAM_LOCK held, such as
1123 * Returns: The maximum number of bytes queued on all pads. This function
1124 * returns 0 if a pad has no queued buffer.
1128 /* we might pre-calculate this in some struct field,
1129 * but would then have to maintain this in _chain and particularly _pop, etc,
1130 * even if element is never interested in this information */
1132 gst_collect_pads_available (GstCollectPads * pads)
1135 guint result = G_MAXUINT;
1137 g_return_val_if_fail (pads != NULL, 0);
1138 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), 0);
1140 collected = pads->data;
1141 for (; collected; collected = g_slist_next (collected)) {
1142 GstCollectData *pdata;
1146 pdata = (GstCollectData *) collected->data;
1148 /* ignore pad with EOS */
1149 if (G_UNLIKELY (GST_COLLECT_PADS_STATE_IS_SET (pdata,
1150 GST_COLLECT_PADS_STATE_EOS))) {
1151 GST_DEBUG_OBJECT (pads, "pad %p is EOS", pdata);
1155 /* an empty buffer without EOS is weird when we get here.. */
1156 if (G_UNLIKELY ((buffer = pdata->buffer) == NULL)) {
1157 GST_WARNING_OBJECT (pads, "pad %p has no buffer", pdata);
1161 /* this is the size left of the buffer */
1162 size = gst_buffer_get_size (buffer) - pdata->pos;
1163 GST_DEBUG_OBJECT (pads, "pad %p has %d bytes left", pdata, size);
1165 /* need to return the min of all available data */
1169 /* nothing changed, all must be EOS then, return 0 */
1170 if (G_UNLIKELY (result == G_MAXUINT))
1182 * gst_collect_pads_flush:
1183 * @pads: the collectspads to query
1184 * @data: the data to use
1185 * @size: the number of bytes to flush
1187 * Flush @size bytes from the pad @data.
1189 * This function should be called with @pads STREAM_LOCK held, such as
1194 * Returns: The number of bytes flushed This can be less than @size and
1195 * is 0 if the pad was end-of-stream.
1200 gst_collect_pads_flush (GstCollectPads * pads, GstCollectData * data,
1207 g_return_val_if_fail (pads != NULL, 0);
1208 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), 0);
1209 g_return_val_if_fail (data != NULL, 0);
1211 /* no buffer, must be EOS */
1212 if ((buffer = data->buffer) == NULL)
1215 bsize = gst_buffer_get_size (buffer);
1217 /* this is what we can flush at max */
1218 flushsize = MIN (size, bsize - data->pos);
1222 if (data->pos >= bsize)
1223 /* _clear will also reset data->pos to 0 */
1224 gst_collect_pads_clear (pads, data);
1230 * gst_collect_pads_read_buffer:
1231 * @pads: the collectspads to query
1232 * @data: the data to use
1233 * @size: the number of bytes to read
1235 * Get a subbuffer of @size bytes from the given pad @data.
1237 * This function should be called with @pads STREAM_LOCK held, such as in the
1244 * Returns: (transfer full): A sub buffer. The size of the buffer can be less that requested.
1245 * A return of NULL signals that the pad is end-of-stream.
1246 * Unref the buffer after use.
1249 gst_collect_pads_read_buffer (GstCollectPads * pads, GstCollectData * data,
1255 g_return_val_if_fail (pads != NULL, NULL);
1256 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), NULL);
1257 g_return_val_if_fail (data != NULL, NULL);
1259 /* no buffer, must be EOS */
1260 if ((buffer = data->buffer) == NULL)
1263 readsize = MIN (size, gst_buffer_get_size (buffer) - data->pos);
1265 return gst_buffer_copy_region (buffer, GST_BUFFER_COPY_ALL, data->pos,
1270 * gst_collect_pads_take_buffer:
1271 * @pads: the collectspads to query
1272 * @data: the data to use
1273 * @size: the number of bytes to read
1275 * Get a subbuffer of @size bytes from the given pad @data. Flushes the amount
1278 * This function should be called with @pads STREAM_LOCK held, such as in the
1285 * Returns: A sub buffer. The size of the buffer can be less that requested.
1286 * A return of NULL signals that the pad is end-of-stream.
1287 * Unref the buffer after use.
1290 gst_collect_pads_take_buffer (GstCollectPads * pads, GstCollectData * data,
1293 GstBuffer *buffer = gst_collect_pads_read_buffer (pads, data, size);
1296 gst_collect_pads_flush (pads, data, gst_buffer_get_size (buffer));
1302 * gst_collect_pads_set_waiting:
1303 * @pads: the collectspads
1304 * @data: the data to use
1305 * @waiting: boolean indicating whether this pad should operate
1306 * in waiting or non-waiting mode
1308 * Sets a pad to waiting or non-waiting mode, if at least this pad
1309 * has not been created with locked waiting state,
1310 * in which case nothing happens.
1312 * This function should be called with @pads STREAM_LOCK held, such as
1320 gst_collect_pads_set_waiting (GstCollectPads * pads, GstCollectData * data,
1323 g_return_if_fail (pads != NULL);
1324 g_return_if_fail (GST_IS_COLLECT_PADS (pads));
1325 g_return_if_fail (data != NULL);
1327 GST_DEBUG_OBJECT (pads, "Setting pad %s to waiting %d, locked %d",
1328 GST_PAD_NAME (data->pad), waiting,
1329 GST_COLLECT_PADS_STATE_IS_SET (data, GST_COLLECT_PADS_STATE_LOCKED));
1331 /* Do something only on a change and if not locked */
1332 if (!GST_COLLECT_PADS_STATE_IS_SET (data, GST_COLLECT_PADS_STATE_LOCKED) &&
1333 (GST_COLLECT_PADS_STATE_IS_SET (data, GST_COLLECT_PADS_STATE_WAITING) !=
1335 /* Set waiting state for this pad */
1337 GST_COLLECT_PADS_STATE_SET (data, GST_COLLECT_PADS_STATE_WAITING);
1339 GST_COLLECT_PADS_STATE_UNSET (data, GST_COLLECT_PADS_STATE_WAITING);
1340 /* Update number of queued pads if needed */
1341 if (!data->buffer &&
1342 !GST_COLLECT_PADS_STATE_IS_SET (data, GST_COLLECT_PADS_STATE_EOS)) {
1344 pads->priv->queuedpads--;
1346 pads->priv->queuedpads++;
1349 /* signal waiters because something changed */
1350 GST_COLLECT_PADS_EVT_BROADCAST (pads);
1354 /* see if pads were added or removed and update our stats. Any pad
1355 * added after releasing the LOCK will get collected in the next
1358 * We can do a quick check by checking the cookies, that get changed
1359 * whenever the pad list is updated.
1361 * Must be called with STREAM_LOCK.
1364 gst_collect_pads_check_pads (GstCollectPads * pads)
1366 /* the master list and cookie are protected with LOCK */
1367 GST_OBJECT_LOCK (pads);
1368 if (G_UNLIKELY (pads->priv->pad_cookie != pads->priv->cookie)) {
1371 /* clear list and stats */
1372 g_slist_foreach (pads->data, (GFunc) unref_data, NULL);
1373 g_slist_free (pads->data);
1375 pads->priv->numpads = 0;
1376 pads->priv->queuedpads = 0;
1377 pads->priv->eospads = 0;
1378 if (pads->priv->earliest_data)
1379 unref_data (pads->priv->earliest_data);
1380 pads->priv->earliest_data = NULL;
1381 pads->priv->earliest_time = GST_CLOCK_TIME_NONE;
1383 /* loop over the master pad list */
1384 collected = pads->priv->pad_list;
1385 for (; collected; collected = g_slist_next (collected)) {
1386 GstCollectData *data;
1388 /* update the stats */
1389 pads->priv->numpads++;
1390 data = collected->data;
1391 if (GST_COLLECT_PADS_STATE_IS_SET (data, GST_COLLECT_PADS_STATE_EOS))
1392 pads->priv->eospads++;
1393 else if (data->buffer || !GST_COLLECT_PADS_STATE_IS_SET (data,
1394 GST_COLLECT_PADS_STATE_WAITING))
1395 pads->priv->queuedpads++;
1397 /* add to the list of pads to collect */
1399 /* preserve order of adding/requesting pads */
1400 pads->data = g_slist_append (pads->data, data);
1402 /* and update the cookie */
1403 pads->priv->cookie = pads->priv->pad_cookie;
1405 GST_OBJECT_UNLOCK (pads);
1408 /* checks if all the pads are collected and call the collectfunction
1410 * Should be called with STREAM_LOCK.
1412 * Returns: The #GstFlowReturn of collection.
1414 static GstFlowReturn
1415 gst_collect_pads_check_collected (GstCollectPads * pads)
1417 GstFlowReturn flow_ret = GST_FLOW_OK;
1418 GstCollectPadsFunction func;
1421 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), GST_FLOW_ERROR);
1423 GST_OBJECT_LOCK (pads);
1424 func = pads->priv->func;
1425 user_data = pads->priv->user_data;
1426 GST_OBJECT_UNLOCK (pads);
1428 g_return_val_if_fail (pads->priv->func != NULL, GST_FLOW_NOT_SUPPORTED);
1430 /* check for new pads, update stats etc.. */
1431 gst_collect_pads_check_pads (pads);
1433 if (G_UNLIKELY (pads->priv->eospads == pads->priv->numpads)) {
1434 /* If all our pads are EOS just collect once to let the element
1435 * do its final EOS handling. */
1436 GST_DEBUG_OBJECT (pads, "All active pads (%d) are EOS, calling %s",
1437 pads->priv->numpads, GST_DEBUG_FUNCPTR_NAME (func));
1439 flow_ret = func (pads, user_data);
1441 gboolean collected = FALSE;
1443 /* We call the collected function as long as our condition matches. */
1444 while (((pads->priv->queuedpads + pads->priv->eospads) >=
1445 pads->priv->numpads)) {
1446 GST_DEBUG_OBJECT (pads,
1447 "All active pads (%d + %d >= %d) have data, " "calling %s",
1448 pads->priv->queuedpads, pads->priv->eospads, pads->priv->numpads,
1449 GST_DEBUG_FUNCPTR_NAME (func));
1451 flow_ret = func (pads, user_data);
1454 /* break on error */
1455 if (flow_ret != GST_FLOW_OK)
1457 /* Don't keep looping after telling the element EOS or flushing */
1458 if (pads->priv->queuedpads == 0)
1462 GST_DEBUG_OBJECT (pads, "Not all active pads (%d) have data, continuing",
1463 pads->priv->numpads);
1469 /* General overview:
1470 * - only pad with a buffer can determine earliest_data (and earliest_time)
1471 * - only segment info determines (non-)waiting state
1472 * - ? perhaps use _stream_time for comparison
1473 * (which muxers might have use as well ?)
1477 * Function to recalculate the waiting state of all pads.
1479 * Must be called with STREAM_LOCK.
1481 * Returns TRUE if a pad was set to waiting
1482 * (from non-waiting state).
1485 gst_collect_pads_recalculate_waiting (GstCollectPads * pads)
1488 gboolean result = FALSE;
1490 /* If earliest time is not known, there is nothing to do. */
1491 if (pads->priv->earliest_data == NULL)
1494 for (collected = pads->data; collected; collected = g_slist_next (collected)) {
1495 GstCollectData *data = (GstCollectData *) collected->data;
1498 /* check if pad has a segment */
1499 if (data->segment.format == GST_FORMAT_UNDEFINED) {
1500 GST_WARNING_OBJECT (pads,
1501 "GstCollectPads has no time segment, assuming 0 based.");
1502 gst_segment_init (&data->segment, GST_FORMAT_TIME);
1503 GST_COLLECT_PADS_STATE_SET (data, GST_COLLECT_PADS_STATE_NEW_SEGMENT);
1506 /* check segment format */
1507 if (data->segment.format != GST_FORMAT_TIME) {
1508 GST_ERROR_OBJECT (pads, "GstCollectPads can handle only time segments.");
1512 /* check if the waiting state should be changed */
1513 cmp_res = pads->priv->compare_func (pads, data, data->segment.start,
1514 pads->priv->earliest_data, pads->priv->earliest_time,
1515 pads->priv->compare_user_data);
1518 gst_collect_pads_set_waiting (pads, data, FALSE);
1520 if (!GST_COLLECT_PADS_STATE_IS_SET (data, GST_COLLECT_PADS_STATE_WAITING)) {
1522 gst_collect_pads_set_waiting (pads, data, TRUE);
1532 * gst_collect_pads_find_best_pad:
1533 * @pads: the collectpads to use
1534 * @data: returns the collectdata for earliest data
1535 * @time: returns the earliest available buffertime
1537 * Find the oldest/best pad, i.e. pad holding the oldest buffer and
1538 * and return the corresponding #GstCollectData and buffertime.
1540 * This function should be called with STREAM_LOCK held,
1541 * such as in the callback.
1546 gst_collect_pads_find_best_pad (GstCollectPads * pads,
1547 GstCollectData ** data, GstClockTime * time)
1550 GstCollectData *best = NULL;
1551 GstClockTime best_time = GST_CLOCK_TIME_NONE;
1553 g_return_if_fail (data != NULL);
1554 g_return_if_fail (time != NULL);
1556 for (collected = pads->data; collected; collected = g_slist_next (collected)) {
1558 GstCollectData *data = (GstCollectData *) collected->data;
1559 GstClockTime timestamp;
1561 buffer = gst_collect_pads_peek (pads, data);
1562 /* if we have a buffer check if it is better then the current best one */
1563 if (buffer != NULL) {
1564 timestamp = GST_BUFFER_TIMESTAMP (buffer);
1565 gst_buffer_unref (buffer);
1566 if (best == NULL || pads->priv->compare_func (pads, data, timestamp,
1567 best, best_time, pads->priv->compare_user_data) < 0) {
1569 best_time = timestamp;
1574 /* set earliest time */
1578 GST_DEBUG_OBJECT (pads, "best pad %s, best time %" GST_TIME_FORMAT,
1579 best ? GST_PAD_NAME (((GstCollectData *) best)->pad) : "(nil)",
1580 GST_TIME_ARGS (best_time));
1584 * Function to recalculate earliest_data and earliest_timestamp. This also calls
1585 * gst_collect_pads_recalculate_waiting
1587 * Must be called with STREAM_LOCK.
1590 gst_collect_pads_recalculate_full (GstCollectPads * pads)
1592 if (pads->priv->earliest_data)
1593 unref_data (pads->priv->earliest_data);
1594 gst_collect_pads_find_best_pad (pads, &pads->priv->earliest_data,
1595 &pads->priv->earliest_time);
1596 if (pads->priv->earliest_data)
1597 ref_data (pads->priv->earliest_data);
1598 return gst_collect_pads_recalculate_waiting (pads);
1602 * Default collect callback triggered when #GstCollectPads gathered all data.
1604 * Called with STREAM_LOCK.
1606 static GstFlowReturn
1607 gst_collect_pads_default_collected (GstCollectPads * pads, gpointer user_data)
1609 GstCollectData *best = NULL;
1611 GstFlowReturn ret = GST_FLOW_OK;
1612 GstCollectPadsBufferFunction func;
1613 gpointer buffer_user_data;
1615 g_return_val_if_fail (GST_IS_COLLECT_PADS (pads), GST_FLOW_ERROR);
1617 GST_OBJECT_LOCK (pads);
1618 func = pads->priv->buffer_func;
1619 buffer_user_data = pads->priv->buffer_user_data;
1620 GST_OBJECT_UNLOCK (pads);
1622 g_return_val_if_fail (func != NULL, GST_FLOW_NOT_SUPPORTED);
1624 /* Find the oldest pad at all cost */
1625 if (gst_collect_pads_recalculate_full (pads)) {
1626 /* waiting was switched on,
1627 * so give another thread a chance to deliver a possibly
1628 * older buffer; don't charge on yet with the current oldest */
1633 best = pads->priv->earliest_data;
1635 /* No data collected means EOS. */
1636 if (G_UNLIKELY (best == NULL)) {
1637 ret = func (pads, best, NULL, buffer_user_data);
1638 if (ret == GST_FLOW_OK)
1643 /* make sure that the pad we take a buffer from is waiting;
1644 * otherwise popping a buffer will seem not to have happened
1645 * and collectpads can get into a busy loop */
1646 gst_collect_pads_set_waiting (pads, best, TRUE);
1649 buffer = gst_collect_pads_pop (pads, best);
1650 ret = func (pads, best, buffer, buffer_user_data);
1652 /* maybe non-waiting was forced to waiting above due to
1653 * newsegment events coming too sparsely,
1654 * so re-check to restore state to avoid hanging/waiting */
1655 gst_collect_pads_recalculate_full (pads);
1662 * Default timestamp compare function.
1665 gst_collect_pads_default_compare_func (GstCollectPads * pads,
1666 GstCollectData * data1, GstClockTime timestamp1,
1667 GstCollectData * data2, GstClockTime timestamp2, gpointer user_data)
1670 GST_LOG_OBJECT (pads, "comparing %" GST_TIME_FORMAT
1671 " and %" GST_TIME_FORMAT, GST_TIME_ARGS (timestamp1),
1672 GST_TIME_ARGS (timestamp2));
1673 /* non-valid timestamps go first as they are probably headers or so */
1674 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (timestamp1)))
1675 return GST_CLOCK_TIME_IS_VALID (timestamp2) ? -1 : 0;
1677 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (timestamp2)))
1680 /* compare timestamp */
1681 if (timestamp1 < timestamp2)
1684 if (timestamp1 > timestamp2)
1691 * gst_collect_pads_event_default:
1692 * @pads: the collectspads to use
1693 * @data: collect data of corresponding pad
1694 * @event: event being processed
1695 * @discard: process but do not send event downstream
1697 * Default GstCollectPads event handling that elements should always
1698 * chain up to to ensure proper operation. Element might however indicate
1699 * event should not be forwarded downstream.
1704 gst_collect_pads_event_default (GstCollectPads * pads, GstCollectData * data,
1705 GstEvent * event, gboolean discard)
1707 gboolean res = TRUE;
1708 GstCollectPadsBufferFunction buffer_func;
1712 GST_OBJECT_LOCK (pads);
1713 buffer_func = pads->priv->buffer_func;
1714 GST_OBJECT_UNLOCK (pads);
1717 parent = GST_OBJECT_PARENT (pad);
1719 switch (GST_EVENT_TYPE (event)) {
1720 case GST_EVENT_FLUSH_START:
1722 /* forward event to unblock check_collected */
1723 GST_DEBUG_OBJECT (pad, "forwarding flush start");
1724 res = gst_pad_event_default (pad, parent, event);
1726 /* now unblock the chain function.
1727 * no cond per pad, so they all unblock,
1728 * non-flushing block again */
1729 GST_COLLECT_PADS_STREAM_LOCK (pads);
1730 GST_COLLECT_PADS_STATE_SET (data, GST_COLLECT_PADS_STATE_FLUSHING);
1731 gst_collect_pads_clear (pads, data);
1733 /* cater for possible default muxing functionality */
1735 /* restore to initial state */
1736 gst_collect_pads_set_waiting (pads, data, TRUE);
1737 /* if the current pad is affected, reset state, recalculate later */
1738 if (pads->priv->earliest_data == data) {
1740 pads->priv->earliest_data = NULL;
1741 pads->priv->earliest_time = GST_CLOCK_TIME_NONE;
1745 GST_COLLECT_PADS_STREAM_UNLOCK (pads);
1749 case GST_EVENT_FLUSH_STOP:
1751 /* flush the 1 buffer queue */
1752 GST_COLLECT_PADS_STREAM_LOCK (pads);
1753 GST_COLLECT_PADS_STATE_UNSET (data, GST_COLLECT_PADS_STATE_FLUSHING);
1754 gst_collect_pads_clear (pads, data);
1755 /* we need new segment info after the flush */
1756 gst_segment_init (&data->segment, GST_FORMAT_UNDEFINED);
1757 GST_COLLECT_PADS_STATE_UNSET (data, GST_COLLECT_PADS_STATE_NEW_SEGMENT);
1758 /* if the pad was EOS, remove the EOS flag and
1759 * decrement the number of eospads */
1760 if (G_UNLIKELY (GST_COLLECT_PADS_STATE_IS_SET (data,
1761 GST_COLLECT_PADS_STATE_EOS))) {
1762 if (!GST_COLLECT_PADS_STATE_IS_SET (data,
1763 GST_COLLECT_PADS_STATE_WAITING))
1764 pads->priv->queuedpads++;
1765 pads->priv->eospads--;
1766 GST_COLLECT_PADS_STATE_UNSET (data, GST_COLLECT_PADS_STATE_EOS);
1768 GST_COLLECT_PADS_STREAM_UNLOCK (pads);
1774 GST_COLLECT_PADS_STREAM_LOCK (pads);
1775 /* if the pad was not EOS, make it EOS and so we
1776 * have one more eospad */
1777 if (G_LIKELY (!GST_COLLECT_PADS_STATE_IS_SET (data,
1778 GST_COLLECT_PADS_STATE_EOS))) {
1779 GST_COLLECT_PADS_STATE_SET (data, GST_COLLECT_PADS_STATE_EOS);
1780 if (!GST_COLLECT_PADS_STATE_IS_SET (data,
1781 GST_COLLECT_PADS_STATE_WAITING))
1782 pads->priv->queuedpads--;
1783 pads->priv->eospads++;
1785 /* check if we need collecting anything, we ignore the result. */
1786 gst_collect_pads_check_collected (pads);
1787 GST_COLLECT_PADS_STREAM_UNLOCK (pads);
1791 case GST_EVENT_SEGMENT:
1796 GST_COLLECT_PADS_STREAM_LOCK (pads);
1798 gst_event_copy_segment (event, &seg);
1800 GST_DEBUG_OBJECT (data->pad, "got segment %" GST_SEGMENT_FORMAT, &seg);
1802 /* default collection can not handle other segment formats than time */
1803 if (buffer_func && seg.format != GST_FORMAT_TIME) {
1804 GST_WARNING_OBJECT (pads, "GstCollectPads default collecting "
1805 "can only handle time segments. Non time segment ignored.");
1806 goto newsegment_done;
1809 data->segment = seg;
1810 GST_COLLECT_PADS_STATE_SET (data, GST_COLLECT_PADS_STATE_NEW_SEGMENT);
1812 /* default muxing functionality */
1814 goto newsegment_done;
1816 /* If oldest time is not known, or current pad got newsegment;
1817 * recalculate the state */
1818 if (!pads->priv->earliest_data || pads->priv->earliest_data == data) {
1819 gst_collect_pads_recalculate_full (pads);
1820 goto newsegment_done;
1823 /* Check if the waiting state of the pad should change. */
1825 pads->priv->compare_func (pads, data, seg.start,
1826 pads->priv->earliest_data, pads->priv->earliest_time,
1827 pads->priv->compare_user_data);
1831 gst_collect_pads_set_waiting (pads, data, FALSE);
1834 GST_COLLECT_PADS_STREAM_UNLOCK (pads);
1835 /* we must not forward this event since multiple segments will be
1836 * accumulated and this is certainly not what we want. */
1839 case GST_EVENT_CAPS:
1840 case GST_EVENT_STREAM_START:
1841 case GST_EVENT_STREAM_CONFIG:
1844 /* forward other events */
1849 gst_event_unref (event);
1856 return gst_pad_event_default (pad, parent, event);
1860 gst_collect_pads_event_default_internal (GstCollectPads * pads,
1861 GstCollectData * data, GstEvent * event, gpointer user_data)
1863 return gst_collect_pads_event_default (pads, data, event, FALSE);
1867 gst_collect_pads_event (GstPad * pad, GstObject * parent, GstEvent * event)
1869 gboolean res = FALSE, need_unlock = FALSE;
1870 GstCollectData *data;
1871 GstCollectPads *pads;
1872 GstCollectPadsEventFunction event_func;
1873 gpointer event_user_data;
1875 /* some magic to get the managing collect_pads */
1876 GST_OBJECT_LOCK (pad);
1877 data = (GstCollectData *) gst_pad_get_element_private (pad);
1878 if (G_UNLIKELY (data == NULL))
1881 GST_OBJECT_UNLOCK (pad);
1885 pads = data->collect;
1887 GST_DEBUG_OBJECT (data->pad, "Got %s event on sink pad",
1888 GST_EVENT_TYPE_NAME (event));
1890 GST_OBJECT_LOCK (pads);
1891 event_func = pads->priv->event_func;
1892 event_user_data = pads->priv->event_user_data;
1893 GST_OBJECT_UNLOCK (pads);
1895 if (GST_EVENT_IS_SERIALIZED (event)) {
1896 GST_COLLECT_PADS_STREAM_LOCK (pads);
1900 if (G_LIKELY (event_func)) {
1901 res = event_func (pads, data, event, event_user_data);
1905 GST_COLLECT_PADS_STREAM_UNLOCK (pads);
1913 GST_DEBUG ("%s got removed from collectpads", GST_OBJECT_NAME (pad));
1914 GST_OBJECT_UNLOCK (pad);
1920 * gst_collect_pads_query_default:
1921 * @pads: the collectspads to use
1922 * @data: collect data of corresponding pad
1923 * @query: query being processed
1924 * @discard: process but do not send event downstream
1926 * Default GstCollectPads query handling that elements should always
1927 * chain up to to ensure proper operation. Element might however indicate
1928 * query should not be forwarded downstream.
1933 gst_collect_pads_query_default (GstCollectPads * pads, GstCollectData * data,
1934 GstQuery * query, gboolean discard)
1936 gboolean res = TRUE;
1941 parent = GST_OBJECT_PARENT (pad);
1943 switch (GST_QUERY_TYPE (query)) {
1944 case GST_QUERY_SEEKING:
1948 /* don't pass it along as some (file)sink might claim it does
1949 * whereas with a collectpads in between that will not likely work */
1950 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
1951 gst_query_set_seeking (query, format, FALSE, 0, -1);
1961 return gst_pad_query_default (pad, parent, query);
1967 gst_collect_pads_query_default_internal (GstCollectPads * pads,
1968 GstCollectData * data, GstQuery * query, gpointer user_data)
1970 return gst_collect_pads_query_default (pads, data, query, FALSE);
1974 gst_collect_pads_query (GstPad * pad, GstObject * parent, GstQuery * query)
1976 gboolean res = FALSE, need_unlock = FALSE;
1977 GstCollectData *data;
1978 GstCollectPads *pads;
1979 GstCollectPadsQueryFunction query_func;
1980 gpointer query_user_data;
1982 GST_DEBUG_OBJECT (pad, "Got %s query on sink pad",
1983 GST_QUERY_TYPE_NAME (query));
1985 /* some magic to get the managing collect_pads */
1986 GST_OBJECT_LOCK (pad);
1987 data = (GstCollectData *) gst_pad_get_element_private (pad);
1988 if (G_UNLIKELY (data == NULL))
1991 GST_OBJECT_UNLOCK (pad);
1993 pads = data->collect;
1995 GST_OBJECT_LOCK (pads);
1996 query_func = pads->priv->query_func;
1997 query_user_data = pads->priv->query_user_data;
1998 GST_OBJECT_UNLOCK (pads);
2000 if (GST_QUERY_IS_SERIALIZED (query)) {
2001 GST_COLLECT_PADS_STREAM_LOCK (pads);
2005 if (G_LIKELY (query_func)) {
2006 res = query_func (pads, data, query, query_user_data);
2010 GST_COLLECT_PADS_STREAM_UNLOCK (pads);
2018 GST_DEBUG ("%s got removed from collectpads", GST_OBJECT_NAME (pad));
2019 GST_OBJECT_UNLOCK (pad);
2025 /* For each buffer we receive we check if our collected condition is reached
2026 * and if so we call the collected function. When this is done we check if
2027 * data has been unqueued. If data is still queued we wait holding the stream
2028 * lock to make sure no EOS event can happen while we are ready to be
2031 static GstFlowReturn
2032 gst_collect_pads_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
2034 GstCollectData *data;
2035 GstCollectPads *pads;
2037 GstBuffer **buffer_p;
2040 GST_DEBUG ("Got buffer for pad %s:%s", GST_DEBUG_PAD_NAME (pad));
2042 /* some magic to get the managing collect_pads */
2043 GST_OBJECT_LOCK (pad);
2044 data = (GstCollectData *) gst_pad_get_element_private (pad);
2045 if (G_UNLIKELY (data == NULL))
2048 GST_OBJECT_UNLOCK (pad);
2050 pads = data->collect;
2052 GST_COLLECT_PADS_STREAM_LOCK (pads);
2053 /* if not started, bail out */
2054 if (G_UNLIKELY (!pads->priv->started))
2056 /* check if this pad is flushing */
2057 if (G_UNLIKELY (GST_COLLECT_PADS_STATE_IS_SET (data,
2058 GST_COLLECT_PADS_STATE_FLUSHING)))
2060 /* pad was EOS, we can refuse this data */
2061 if (G_UNLIKELY (GST_COLLECT_PADS_STATE_IS_SET (data,
2062 GST_COLLECT_PADS_STATE_EOS)))
2065 /* see if we need to clip */
2066 if (pads->priv->clip_func) {
2067 GstBuffer *outbuf = NULL;
2069 pads->priv->clip_func (pads, data, buffer, &outbuf,
2070 pads->priv->clip_user_data);
2073 if (G_UNLIKELY (outbuf == NULL))
2076 if (G_UNLIKELY (ret == GST_FLOW_EOS))
2078 else if (G_UNLIKELY (ret != GST_FLOW_OK))
2082 GST_DEBUG_OBJECT (pads, "Queuing buffer %p for pad %s:%s", buffer,
2083 GST_DEBUG_PAD_NAME (pad));
2085 /* One more pad has data queued */
2086 if (GST_COLLECT_PADS_STATE_IS_SET (data, GST_COLLECT_PADS_STATE_WAITING))
2087 pads->priv->queuedpads++;
2088 buffer_p = &data->buffer;
2089 gst_buffer_replace (buffer_p, buffer);
2091 /* update segment last position if in TIME */
2092 if (G_LIKELY (data->segment.format == GST_FORMAT_TIME)) {
2093 GstClockTime timestamp = GST_BUFFER_TIMESTAMP (buffer);
2095 if (GST_CLOCK_TIME_IS_VALID (timestamp))
2096 data->segment.position = timestamp;
2099 /* While we have data queued on this pad try to collect stuff */
2101 /* Check if our collected condition is matched and call the collected
2102 * function if it is */
2103 ret = gst_collect_pads_check_collected (pads);
2104 /* when an error occurs, we want to report this back to the caller ASAP
2105 * without having to block if the buffer was not popped */
2106 if (G_UNLIKELY (ret != GST_FLOW_OK))
2109 /* data was consumed, we can exit and accept new data */
2110 if (data->buffer == NULL)
2113 /* Having the _INIT here means we don't care about any broadcast up to here
2114 * (most of which occur with STREAM_LOCK held, so could not have happened
2115 * anyway). We do care about e.g. a remove initiated broadcast as of this
2116 * point. Putting it here also makes this thread ignores any evt it raised
2117 * itself (as is a usual WAIT semantic).
2119 GST_COLLECT_PADS_EVT_INIT (cookie);
2121 /* pad could be removed and re-added */
2123 GST_OBJECT_LOCK (pad);
2124 if (G_UNLIKELY ((data = gst_pad_get_element_private (pad)) == NULL))
2127 GST_OBJECT_UNLOCK (pad);
2129 GST_DEBUG_OBJECT (pads, "Pad %s:%s has a buffer queued, waiting",
2130 GST_DEBUG_PAD_NAME (pad));
2132 /* wait to be collected, this must happen from another thread triggered
2133 * by the _chain function of another pad. We release the lock so we
2134 * can get stopped or flushed as well. We can however not get EOS
2135 * because we still hold the STREAM_LOCK.
2137 GST_COLLECT_PADS_STREAM_UNLOCK (pads);
2138 GST_COLLECT_PADS_EVT_WAIT (pads, cookie);
2139 GST_COLLECT_PADS_STREAM_LOCK (pads);
2141 GST_DEBUG_OBJECT (pads, "Pad %s:%s resuming", GST_DEBUG_PAD_NAME (pad));
2143 /* after a signal, we could be stopped */
2144 if (G_UNLIKELY (!pads->priv->started))
2146 /* check if this pad is flushing */
2147 if (G_UNLIKELY (GST_COLLECT_PADS_STATE_IS_SET (data,
2148 GST_COLLECT_PADS_STATE_FLUSHING)))
2151 while (data->buffer != NULL);
2154 GST_COLLECT_PADS_STREAM_UNLOCK (pads);
2157 gst_buffer_unref (buffer);
2162 GST_WARNING ("%s got removed from collectpads", GST_OBJECT_NAME (pad));
2163 GST_OBJECT_UNLOCK (pad);
2164 ret = GST_FLOW_NOT_LINKED;
2170 GST_DEBUG ("%s got removed from collectpads", GST_OBJECT_NAME (pad));
2171 GST_OBJECT_UNLOCK (pad);
2172 gst_buffer_unref (buffer);
2173 return GST_FLOW_NOT_LINKED;
2177 GST_DEBUG ("not started");
2178 gst_collect_pads_clear (pads, data);
2179 ret = GST_FLOW_FLUSHING;
2184 GST_DEBUG ("pad %s:%s is flushing", GST_DEBUG_PAD_NAME (pad));
2185 gst_collect_pads_clear (pads, data);
2186 ret = GST_FLOW_FLUSHING;
2191 /* we should not post an error for this, just inform upstream that
2192 * we don't expect anything anymore */
2193 GST_DEBUG ("pad %s:%s is eos", GST_DEBUG_PAD_NAME (pad));
2199 GST_DEBUG ("clipped buffer on pad %s:%s", GST_DEBUG_PAD_NAME (pad));
2205 /* we print the error, the element should post a reasonable error
2206 * message for fatal errors */
2207 GST_DEBUG ("collect failed, reason %d (%s)", ret, gst_flow_get_name (ret));
2208 gst_collect_pads_clear (pads, data);