struct GstCollectPads

struct GstCollectPads {
  GSList        *data;                  /* list of CollectData items */
};

Collectpads object.

Since 0.10.36

struct GstCollectData

struct GstCollectData {
  /* with STREAM_LOCK of @collect */
  GstCollectPads       *collect;
  GstPad                *pad;
  GstBuffer             *buffer;
  guint                  pos;
  GstSegment             segment;
};

Structure used by the collect_pads.

Since 0.10.36

GstCollectDataDestroyNotify ()

void                (*GstCollectDataDestroyNotify)      (GstCollectData *data);

A function that will be called when the GstCollectData will be freed. It is passed the pointer to the structure and should free any custom memory and resources allocated for it.

Since 0.10.36

GstCollectPadsBufferFunction ()

GstFlowReturn       (*GstCollectPadsBufferFunction)     (GstCollectPads *pads,
                                                         GstCollectData *data,
                                                         GstBuffer *buffer,
                                                         gpointer user_data);

A function that will be called when a (considered oldest) buffer can be muxed. If all pads have reached EOS, this function is called with NULL buffer and NULL data.

Since 0.10.36

GstCollectPadsCompareFunction ()

gint                (*GstCollectPadsCompareFunction)    (GstCollectPads *pads,
                                                         GstCollectData *data1,
                                                         GstClockTime timestamp1,
                                                         GstCollectData *data2,
                                                         GstClockTime timestamp2,
                                                         gpointer user_data);

A function for comparing two timestamps of buffers or newsegments collected on one pad.

Since 0.10.36

GstCollectPadsEventFunction ()

gboolean            (*GstCollectPadsEventFunction)      (GstCollectPads *pads,
                                                         GstCollectData *pad,
                                                         GstEvent *event,
                                                         gpointer user_data);

A function that will be called while processing an event. It takes ownership of the event and is responsible for chaining up (to gst_collect_pads_event_default()) or dropping events (such typical cases being handled by the default handler).

Since 0.10.36

GstCollectPadsClipFunction ()

GstFlowReturn       (*GstCollectPadsClipFunction)       (GstCollectPads *pads,
                                                         GstCollectData *data,
                                                         GstBuffer *inbuffer,
                                                         GstBuffer **outbuffer,
                                                         gpointer user_data);

A function that will be called when inbuffer is received on the pad managed by data in the collecpad object pads.

The function should use the segment of data and the negotiated media type on the pad to perform clipping of inbuffer.

This function takes ownership of inbuffer and should output a buffer in outbuffer or return NULL in outbuffer if the buffer should be dropped.

Since 0.10.36

GstCollectPadsFunction ()

GstFlowReturn       (*GstCollectPadsFunction)           (GstCollectPads *pads,
                                                         gpointer user_data);

A function that will be called when all pads have received data.

Since 0.10.36

enum GstCollectPadsStateFlags

typedef enum {
  GST_COLLECT_PADS_STATE_EOS = 1 << 0,
  GST_COLLECT_PADS_STATE_FLUSHING = 1 << 1,
  GST_COLLECT_PADS_STATE_NEW_SEGMENT = 1 << 2,
  GST_COLLECT_PADS_STATE_WAITING = 1 << 3,
  GST_COLLECT_PADS_STATE_LOCKED = 1 << 4
} GstCollectPadsStateFlags;

Since 0.10.36

GST_COLLECT_PADS_STATE()

#define GST_COLLECT_PADS_STATE(data)                 (((GstCollectData *) data)->state)

A flags word containing GstCollectPadsStateFlags flags set on this collected pad.

Since 0.10.36

GST_COLLECT_PADS_STATE_IS_SET()

#define GST_COLLECT_PADS_STATE_IS_SET(data,flag)     !!(GST_COLLECT_PADS_STATE (data) & flag)

Gives the status of a specific flag on a collected pad.

Since 0.10.36

GST_COLLECT_PADS_STATE_SET()

#define GST_COLLECT_PADS_STATE_SET(data,flag)        (GST_COLLECT_PADS_STATE (data) |= flag)

Sets a state flag on a collected pad.

Since 0.10.36

GST_COLLECT_PADS_STATE_UNSET()

#define GST_COLLECT_PADS_STATE_UNSET(data,flag)      (GST_COLLECT_PADS_STATE (data) &= ~(flag))

Clears a state flag on a collected pad.

Since 0.10.36

GST_COLLECT_PADS_GET_STREAM_LOCK()

#define GST_COLLECT_PADS_GET_STREAM_LOCK(pads) (&((GstCollectPads *)pads)->stream_lock)

Get the stream lock of pads. The stream lock is used to coordinate and serialize execution among the various streams being collected, and in protecting the resources used to accomplish this.

Since 0.10.36

GST_COLLECT_PADS_STREAM_LOCK()

#define GST_COLLECT_PADS_STREAM_LOCK(pads)     g_rec_mutex_lock(GST_COLLECT_PADS_GET_STREAM_LOCK (pads))

Lock the stream lock of pads.

Since 0.10.36

GST_COLLECT_PADS_STREAM_UNLOCK()

#define GST_COLLECT_PADS_STREAM_UNLOCK(pads)   g_rec_mutex_unlock(GST_COLLECT_PADS_GET_STREAM_LOCK (pads))

Unlock the stream lock of pads.

Since 0.10.36

gst_collect_pads_new ()

GstCollectPads *    gst_collect_pads_new                (void);

Create a new instance of GstCollectsPads.

MT safe.

Since 0.10.36

gst_collect_pads_add_pad ()

GstCollectData *    gst_collect_pads_add_pad            (GstCollectPads *pads,
                                                         GstPad *pad,
                                                         guint size);

Add a pad to the collection of collect pads. The pad has to be a sinkpad. The refcount of the pad is incremented. Use gst_collect_pads_remove_pad() to remove the pad from the collection again.

You specify a size for the returned GstCollectData structure so that you can use it to store additional information.

The pad will be automatically activated in push mode when pads is started.

This function calls gst_collect_pads_add_pad_full() passing a value of NULL for destroy_notify and TRUE for locked.

MT safe.

Since 0.10.36

gst_collect_pads_add_pad_full ()

GstCollectData *    gst_collect_pads_add_pad_full       (GstCollectPads *pads,
                                                         GstPad *pad,
                                                         guint size,
                                                         GstCollectDataDestroyNotify destroy_notify,
                                                         gboolean lock);

Add a pad to the collection of collect pads. The pad has to be a sinkpad. The refcount of the pad is incremented. Use gst_collect_pads_remove_pad() to remove the pad from the collection again.

You specify a size for the returned GstCollectData structure so that you can use it to store additional information.

You can also specify a GstCollectDataDestroyNotify that will be called just before the GstCollectData structure is freed. It is passed the pointer to the structure and should free any custom memory and resources allocated for it.

Keeping a pad locked in waiting state is only relevant when using the default collection algorithm (providing the oldest buffer). It ensures a buffer must be available on this pad for a collection to take place. This is of typical use to a muxer element where non-subtitle streams should always be in waiting state, e.g. to assure that caps information is available on all these streams when initial headers have to be written.

The pad will be automatically activated in push mode when pads is started.

MT safe.

Since 0.10.36

gst_collect_pads_remove_pad ()

gboolean            gst_collect_pads_remove_pad         (GstCollectPads *pads,
                                                         GstPad *pad);

Remove a pad from the collection of collect pads. This function will also free the GstCollectData and all the resources that were allocated with gst_collect_pads_add_pad().

The pad will be deactivated automatically when pads is stopped.

MT safe.

Since 0.10.36

gst_collect_pads_start ()

void                gst_collect_pads_start              (GstCollectPads *pads);

Starts the processing of data in the collect_pads.

MT safe.

Since 0.10.36

gst_collect_pads_stop ()

void                gst_collect_pads_stop               (GstCollectPads *pads);

Stops the processing of data in the collect_pads. this function will also unblock any blocking operations.

MT safe.

Since 0.10.36

gst_collect_pads_available ()

guint               gst_collect_pads_available          (GstCollectPads *pads);

Query how much bytes can be read from each queued buffer. This means that the result of this call is the maximum number of bytes that can be read from each of the pads.

This function should be called with pads STREAM_LOCK held, such as in the callback.

MT safe.

Since 0.10.36

gst_collect_pads_is_active ()

gboolean            gst_collect_pads_is_active          (GstCollectPads *pads,
                                                         GstPad *pad);

Check if a pad is active.

This function is currently not implemented.

MT safe.

Since 0.10.36

gst_collect_pads_collect ()

GstFlowReturn       gst_collect_pads_collect            (GstCollectPads *pads);

Collect data on all pads. This function is usually called from a GstTask function in an element.

This function is currently not implemented.

MT safe.

Since 0.10.36

gst_collect_pads_collect_range ()

GstFlowReturn       gst_collect_pads_collect_range      (GstCollectPads *pads,
                                                         guint64 offset,
                                                         guint length);

Collect data with offset and length on all pads. This function is typically called in the getrange function of an element.

This function is currently not implemented.

MT safe.

Since 0.10.36

gst_collect_pads_flush ()

guint               gst_collect_pads_flush              (GstCollectPads *pads,
                                                         GstCollectData *data,
                                                         guint size);

Flush size bytes from the pad data.

This function should be called with pads STREAM_LOCK held, such as in the callback.

MT safe.

Since 0.10.36

gst_collect_pads_peek ()

GstBuffer *         gst_collect_pads_peek               (GstCollectPads *pads,
                                                         GstCollectData *data);

Peek at the buffer currently queued in data. This function should be called with the pads STREAM_LOCK held, such as in the callback handler.

MT safe.

Since 0.10.36

gst_collect_pads_pop ()

GstBuffer *         gst_collect_pads_pop                (GstCollectPads *pads,
                                                         GstCollectData *data);

Pop the buffer currently queued in data. This function should be called with the pads STREAM_LOCK held, such as in the callback handler.

MT safe.

Since 0.10.36

gst_collect_pads_read_buffer ()

GstBuffer *         gst_collect_pads_read_buffer        (GstCollectPads *pads,
                                                         GstCollectData *data,
                                                         guint size);

Get a subbuffer of size bytes from the given pad data.

This function should be called with pads STREAM_LOCK held, such as in the callback.

MT safe.

Since 0.10.36

gst_collect_pads_take_buffer ()

GstBuffer *         gst_collect_pads_take_buffer        (GstCollectPads *pads,
                                                         GstCollectData *data,
                                                         guint size);

Get a subbuffer of size bytes from the given pad data. Flushes the amount of read bytes.

This function should be called with pads STREAM_LOCK held, such as in the callback.

MT safe.

Since 0.10.36

gst_collect_pads_set_buffer_function ()

void                gst_collect_pads_set_buffer_function
                                                        (GstCollectPads *pads,
                                                         GstCollectPadsBufferFunction func,
                                                         gpointer user_data);

Set the callback function and user data that will be called with the oldest buffer when all pads have been collected.

MT safe.

Since 0.10.36

gst_collect_pads_set_compare_function ()

void                gst_collect_pads_set_compare_function
                                                        (GstCollectPads *pads,
                                                         GstCollectPadsCompareFunction func,
                                                         gpointer user_data);

Set the timestamp comparison function.

MT safe.

Since 0.10.36

gst_collect_pads_set_event_function ()

void                gst_collect_pads_set_event_function (GstCollectPads *pads,
                                                         GstCollectPadsEventFunction func,
                                                         gpointer user_data);

Set the event callback function and user data that will be called when collectpads has received an event originating from one of the collected pads. If the event being processed is a serialized one, this callback is called with pads STREAM_LOCK held, otherwise not. As this lock should be held when calling a number of CollectPads functions, it should be acquired if so (unusually) needed.

MT safe.

Since 0.10.36

gst_collect_pads_set_clip_function ()

void                gst_collect_pads_set_clip_function  (GstCollectPads *pads,
                                                         GstCollectPadsClipFunction clipfunc,
                                                         gpointer user_data);

Install a clipping function that is called right after a buffer is received on a pad managed by pads. See GstCollectPad2ClipFunction for more info.

Since 0.10.36

gst_collect_pads_set_flushing ()

void                gst_collect_pads_set_flushing       (GstCollectPads *pads,
                                                         gboolean flushing);

Change the flushing state of all the pads in the collection. No pad is able to accept anymore data when flushing is TRUE. Calling this function with flushing FALSE makes pads accept data again. Caller must ensure that downstream streaming (thread) is not blocked, e.g. by sending a FLUSH_START downstream.

MT safe.

Since 0.10.36

gst_collect_pads_set_function ()

void                gst_collect_pads_set_function       (GstCollectPads *pads,
                                                         GstCollectPadsFunction func,
                                                         gpointer user_data);

CollectPads provides a default collection algorithm that will determine the oldest buffer available on all of its pads, and then delegate to a configured callback. However, if circumstances are more complicated and/or more control is desired, this sets a callback that will be invoked instead when all the pads added to the collection have buffers queued. Evidently, this callback is not compatible with gst_collect_pads_set_buffer_function() callback. If this callback is set, the former will be unset.

MT safe.

Since 0.10.36

gst_collect_pads_set_waiting ()

void                gst_collect_pads_set_waiting        (GstCollectPads *pads,
                                                         GstCollectData *data,
                                                         gboolean waiting);

Sets a pad to waiting or non-waiting mode, if at least this pad has not been created with locked waiting state, in which case nothing happens.

This function should be called with pads STREAM_LOCK held, such as in the callback.

MT safe.

Since 0.10.36