GstPad

typedef struct {
  gpointer			element_private;

  GstPadTemplate		*padtemplate;

  GstPadDirection		 direction;

  /* streaming rec_lock */
  GStaticRecMutex		*stream_rec_lock;
  GstTask			*task;
  GMutex			*preroll_lock;
  GCond				*preroll_cond;

  /* block cond, mutex is from the object */
  GCond				*block_cond;
  GstPadBlockCallback		 block_callback;
  gpointer			 block_data;

  /* the pad capabilities */
  GstCaps			*caps;
  GstPadGetCapsFunction		getcapsfunc;
  GstPadSetCapsFunction		setcapsfunc;
  GstPadAcceptCapsFunction	 acceptcapsfunc;
  GstPadFixateCapsFunction	 fixatecapsfunc;

  GstPadActivateFunction	 activatefunc;
  GstPadActivateModeFunction	 activatepushfunc;
  GstPadActivateModeFunction	 activatepullfunc;

  /* pad link */
  GstPadLinkFunction		 linkfunc;
  GstPadUnlinkFunction		 unlinkfunc;
  GstPad			*peer;

  gpointer			 sched_private;

  /* data transport functions */
  GstPadChainFunction		 chainfunc;
  GstPadCheckGetRangeFunction	 checkgetrangefunc;
  GstPadGetRangeFunction	 getrangefunc;
  GstPadEventFunction		 eventfunc;

  GstActivateMode		 mode;

  /* generic query method */
  GstPadQueryTypeFunction	 querytypefunc;
  GstPadQueryFunction		 queryfunc;

  /* internal links */
  GstPadIntLinkFunction		 intlinkfunc;

  GstPadBufferAllocFunction      bufferallocfunc;

  /* whether to emit signals for have-data. counts number
   * of handlers attached. */
  gint				 do_buffer_signals;
  gint				 do_event_signals;

  /* ABI added */
  /* iterate internal links */
  GstPadIterIntLinkFunction     iterintlinkfunc;

  /* free block_data */
  GDestroyNotify block_destroy_data;
} GstPad;

The GstPad structure. Use the functions to update the variables.

enum GstPadDirection

typedef enum {
  GST_PAD_UNKNOWN,
  GST_PAD_SRC,
  GST_PAD_SINK
} GstPadDirection;

The direction of a pad.

enum GstPadFlags

typedef enum {
  GST_PAD_BLOCKED       = (GST_OBJECT_FLAG_LAST << 0),
  GST_PAD_FLUSHING      = (GST_OBJECT_FLAG_LAST << 1),
  GST_PAD_IN_GETCAPS    = (GST_OBJECT_FLAG_LAST << 2),
  GST_PAD_IN_SETCAPS    = (GST_OBJECT_FLAG_LAST << 3),
  GST_PAD_BLOCKING	= (GST_OBJECT_FLAG_LAST << 4),
  /* padding */
  GST_PAD_FLAG_LAST     = (GST_OBJECT_FLAG_LAST << 8)
} GstPadFlags;

Pad state flags

enum GstPadLinkReturn

typedef enum {
  GST_PAD_LINK_OK               =  0,
  GST_PAD_LINK_WRONG_HIERARCHY  = -1,
  GST_PAD_LINK_WAS_LINKED       = -2,
  GST_PAD_LINK_WRONG_DIRECTION  = -3,
  GST_PAD_LINK_NOFORMAT         = -4,
  GST_PAD_LINK_NOSCHED          = -5,
  GST_PAD_LINK_REFUSED          = -6
} GstPadLinkReturn;

Result values from gst_pad_link and friends.

GST_PAD_LINK_FAILED()

#define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)

Macro to test if the given GstPadLinkReturn value indicates a failed link step.

GST_PAD_LINK_SUCCESSFUL()

#define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)

Macro to test if the given GstPadLinkReturn value indicates a successful link step.

enum GstFlowReturn

typedef enum {
  /* custom success starts here */
  GST_FLOW_CUSTOM_SUCCESS = 100,

  /* core predefined */
  GST_FLOW_RESEND	  =  1,
  GST_FLOW_OK		  =  0,
  /* expected failures */
  GST_FLOW_NOT_LINKED     = -1,
  GST_FLOW_WRONG_STATE    = -2,
  /* error cases */
  GST_FLOW_UNEXPECTED     = -3,
  GST_FLOW_NOT_NEGOTIATED = -4,
  GST_FLOW_ERROR	  = -5,
  GST_FLOW_NOT_SUPPORTED  = -6,

  /* custom error starts here */
  GST_FLOW_CUSTOM_ERROR   = -100
} GstFlowReturn;

The result of passing data to a pad.

Note that the custom return values should not be exposed outside of the element scope and are available since 0.10.7.

enum GstActivateMode

typedef enum {
  GST_ACTIVATE_NONE,
  GST_ACTIVATE_PUSH,
  GST_ACTIVATE_PULL
} GstActivateMode;

The status of a GstPad. After activating a pad, which usually happens when the parent element goes from READY to PAUSED, the GstActivateMode defines if the pad operates in push or pull mode.

gst_pad_get_name()

#define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))

Get a copy of the name of the pad. g_free() after usage.

MT safe.

gst_pad_get_direction ()

GstPadDirection     gst_pad_get_direction               (GstPad *pad);

Gets the direction of the pad. The direction of the pad is decided at construction time so this function does not take the LOCK.

gst_pad_get_parent()

#define gst_pad_get_parent(pad) gst_object_get_parent (GST_OBJECT_CAST (pad))

Get the parent of pad. This function increases the refcount of the parent object so you should gst_object_unref() it after usage. Can return NULL if the pad did not have a parent.

MT safe.

gst_pad_get_parent_element ()

GstElement*         gst_pad_get_parent_element          (GstPad *pad);

Gets the parent of pad, cast to a GstElement. If a pad has no parent or its parent is not an element, return NULL.

gst_pad_get_pad_template ()

GstPadTemplate*     gst_pad_get_pad_template            (GstPad *pad);

Gets the template for pad.

gst_pad_link ()

GstPadLinkReturn    gst_pad_link                        (GstPad *srcpad,
                                                         GstPad *sinkpad);

Links the source pad and the sink pad.

gst_pad_unlink ()

gboolean            gst_pad_unlink                      (GstPad *srcpad,
                                                         GstPad *sinkpad);

Unlinks the source pad from the sink pad. Will emit the "unlinked" signal on both pads.

gst_pad_is_linked ()

gboolean            gst_pad_is_linked                   (GstPad *pad);

Checks if a pad is linked to another pad or not.

gst_pad_can_link ()

gboolean            gst_pad_can_link                    (GstPad *srcpad,
                                                         GstPad *sinkpad);

Checks if the source pad and the sink pad are compatible so they can be linked.

gst_pad_get_caps ()

GstCaps*            gst_pad_get_caps                    (GstPad *pad);

Gets the capabilities this pad can produce or consume. Note that this method doesn't necessarily return the caps set by gst_pad_set_caps() - use GST_PAD_CAPS() for that instead. gst_pad_get_caps returns all possible caps a pad can operate with, using the pad's get_caps function; this returns the pad template caps if not explicitly set.

gst_pad_get_allowed_caps ()

GstCaps*            gst_pad_get_allowed_caps            (GstPad *pad);

Gets the capabilities of the allowed media types that can flow through pad and its peer.

The allowed capabilities is calculated as the intersection of the results of calling gst_pad_get_caps() on pad and its peer. The caller owns a reference on the resulting caps.

gst_pad_get_negotiated_caps ()

GstCaps*            gst_pad_get_negotiated_caps         (GstPad *pad);

Gets the capabilities of the media type that currently flows through pad and its peer.

This function can be used on both src and sinkpads. Note that srcpads are always negotiated before sinkpads so it is possible that the negotiated caps on the srcpad do not match the negotiated caps of the peer.

gst_pad_get_pad_template_caps ()

const GstCaps*      gst_pad_get_pad_template_caps       (GstPad *pad);

Gets the capabilities for pad's template.

gst_pad_set_caps ()

gboolean            gst_pad_set_caps                    (GstPad *pad,
                                                         GstCaps *caps);

Sets the capabilities of this pad. The caps must be fixed. Any previous caps on the pad will be unreffed. This function refs the caps so you should unref if as soon as you don't need it anymore. It is possible to set NULL caps, which will make the pad unnegotiated again.

gst_pad_get_peer ()

GstPad*             gst_pad_get_peer                    (GstPad *pad);

Gets the peer of pad. This function refs the peer pad so you need to unref it after use.

gst_pad_peer_get_caps ()

GstCaps*            gst_pad_peer_get_caps               (GstPad *pad);

Gets the capabilities of the peer connected to this pad.

gst_pad_use_fixed_caps ()

void                gst_pad_use_fixed_caps              (GstPad *pad);

A helper function you can use that sets the gst_pad_get_fixed_caps_func as the getcaps function for the pad. This way the function will always return the negotiated caps or in case the pad is not negotiated, the padtemplate caps.

Use this function on a pad that, once _set_caps() has been called on it, cannot be renegotiated to something else.

gst_pad_is_active ()

gboolean            gst_pad_is_active                   (GstPad *pad);

Query if a pad is active

gst_pad_set_blocked ()

gboolean            gst_pad_set_blocked                 (GstPad *pad,
                                                         gboolean blocked);

Blocks or unblocks the dataflow on a pad. This function is a shortcut for gst_pad_set_blocked_async() with a NULL callback.

gst_pad_set_blocked_async ()

gboolean            gst_pad_set_blocked_async           (GstPad *pad,
                                                         gboolean blocked,
                                                         GstPadBlockCallback callback,
                                                         gpointer user_data);

Blocks or unblocks the dataflow on a pad. The provided callback is called when the operation succeeds; this happens right before the next attempt at pushing a buffer on the pad.

This can take a while as the pad can only become blocked when real dataflow is happening. When the pipeline is stalled, for example in PAUSED, this can take an indeterminate amount of time. You can pass NULL as the callback to make this call block. Be careful with this blocking call as it might not return for reasons stated above.

gst_pad_set_blocked_async_full ()

gboolean            gst_pad_set_blocked_async_full      (GstPad *pad,
                                                         gboolean blocked,
                                                         GstPadBlockCallback callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy_data);

Blocks or unblocks the dataflow on a pad. The provided callback is called when the operation succeeds; this happens right before the next attempt at pushing a buffer on the pad.

This can take a while as the pad can only become blocked when real dataflow is happening. When the pipeline is stalled, for example in PAUSED, this can take an indeterminate amount of time. You can pass NULL as the callback to make this call block. Be careful with this blocking call as it might not return for reasons stated above.

Since 0.10.23

GstPadBlockCallback ()

void                (*GstPadBlockCallback)              (GstPad *pad,
                                                         gboolean blocked,
                                                         gpointer user_data);

Callback used by gst_pad_set_blocked_async(). Gets called when the blocking operation succeeds.

gst_pad_is_blocked ()

gboolean            gst_pad_is_blocked                  (GstPad *pad);

Checks if the pad is blocked or not. This function returns the last requested state of the pad. It is not certain that the pad is actually blocking at this point (see gst_pad_is_blocking()).

gst_pad_is_blocking ()

gboolean            gst_pad_is_blocking                 (GstPad *pad);

Checks if the pad is blocking or not. This is a guaranteed state of whether the pad is actually blocking on a GstBuffer or a GstEvent.

Since 0.10.11

gst_pad_add_data_probe ()

gulong              gst_pad_add_data_probe              (GstPad *pad,
                                                         GCallback handler,
                                                         gpointer data);

Adds a "data probe" to a pad. This function will be called whenever data passes through a pad. In this case data means both events and buffers. The probe will be called with the data as an argument, meaning handler should have the same callback signature as the "have-data" signal. Note that the data will have a reference count greater than 1, so it will be immutable -- you must not change it.

For source pads, the probe will be called after the blocking function, if any (see gst_pad_set_blocked_async()), but before looking up the peer to chain to. For sink pads, the probe function will be called before configuring the sink with new caps, if any, and before calling the pad's chain function.

Your data probe should return TRUE to let the data continue to flow, or FALSE to drop it. Dropping data is rarely useful, but occasionally comes in handy with events.

Although probes are implemented internally by connecting handler to the have-data signal on the pad, if you want to remove a probe it is insufficient to only call g_signal_handler_disconnect on the returned handler id. To remove a probe, use the appropriate function, such as gst_pad_remove_data_probe().

gst_pad_add_data_probe_full ()

gulong              gst_pad_add_data_probe_full         (GstPad *pad,
                                                         GCallback handler,
                                                         gpointer data,
                                                         GDestroyNotify notify);

Adds a "data probe" to a pad. This function will be called whenever data passes through a pad. In this case data means both events and buffers. The probe will be called with the data as an argument, meaning handler should have the same callback signature as the "have-data" signal. Note that the data will have a reference count greater than 1, so it will be immutable -- you must not change it.

For source pads, the probe will be called after the blocking function, if any (see gst_pad_set_blocked_async()), but before looking up the peer to chain to. For sink pads, the probe function will be called before configuring the sink with new caps, if any, and before calling the pad's chain function.

Your data probe should return TRUE to let the data continue to flow, or FALSE to drop it. Dropping data is rarely useful, but occasionally comes in handy with events.

Although probes are implemented internally by connecting handler to the have-data signal on the pad, if you want to remove a probe it is insufficient to only call g_signal_handler_disconnect on the returned handler id. To remove a probe, use the appropriate function, such as gst_pad_remove_data_probe().

The notify function is called when the probe is disconnected and usually used to free data.

Since 0.10.20

gst_pad_add_buffer_probe ()

gulong              gst_pad_add_buffer_probe            (GstPad *pad,
                                                         GCallback handler,
                                                         gpointer data);

Adds a probe that will be called for all buffers passing through a pad. See gst_pad_add_data_probe() for more information.

gst_pad_add_buffer_probe_full ()

gulong              gst_pad_add_buffer_probe_full       (GstPad *pad,
                                                         GCallback handler,
                                                         gpointer data,
                                                         GDestroyNotify notify);

Adds a probe that will be called for all buffers passing through a pad. See gst_pad_add_data_probe() for more information.

The notify function is called when the probe is disconnected and usually used to free data.

Since 0.10.20

gst_pad_add_event_probe ()

gulong              gst_pad_add_event_probe             (GstPad *pad,
                                                         GCallback handler,
                                                         gpointer data);

Adds a probe that will be called for all events passing through a pad. See gst_pad_add_data_probe() for more information.

gst_pad_add_event_probe_full ()

gulong              gst_pad_add_event_probe_full        (GstPad *pad,
                                                         GCallback handler,
                                                         gpointer data,
                                                         GDestroyNotify notify);

Adds a probe that will be called for all events passing through a pad. See gst_pad_add_data_probe() for more information.

The notify function is called when the probe is disconnected and usually used to free data.

Since 0.10.20

gst_pad_remove_data_probe ()

void                gst_pad_remove_data_probe           (GstPad *pad,
                                                         guint handler_id);

Removes a data probe from pad.

gst_pad_remove_buffer_probe ()

void                gst_pad_remove_buffer_probe         (GstPad *pad,
                                                         guint handler_id);

Removes a buffer probe from pad.

gst_pad_remove_event_probe ()

void                gst_pad_remove_event_probe          (GstPad *pad,
                                                         guint handler_id);

Removes an event probe from pad.

gst_pad_new ()

GstPad*             gst_pad_new                         (const gchar *name,
                                                         GstPadDirection direction);

Creates a new pad with the given name in the given direction. If name is NULL, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name.

gst_pad_new_from_template ()

GstPad*             gst_pad_new_from_template           (GstPadTemplate *templ,
                                                         const gchar *name);

Creates a new pad with the given name from the given template. If name is NULL, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name.

gst_pad_new_from_static_template ()

GstPad*             gst_pad_new_from_static_template    (GstStaticPadTemplate *templ,
                                                         const gchar *name);

Creates a new pad with the given name from the given static template. If name is NULL, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name.

gst_pad_alloc_buffer ()

GstFlowReturn       gst_pad_alloc_buffer                (GstPad *pad,
                                                         guint64 offset,
                                                         gint size,
                                                         GstCaps *caps,
                                                         GstBuffer **buf);

Allocates a new, empty buffer optimized to push to pad pad. This function only works if pad is a source pad and has a peer.

A new, empty GstBuffer will be put in the buf argument. You need to check the caps of the buffer after performing this function and renegotiate to the format if needed. If the caps changed, it is possible that the buffer returned in buf is not of the right size for the new format, buf needs to be unreffed and reallocated if this is the case.

gst_pad_alloc_buffer_and_set_caps ()

GstFlowReturn       gst_pad_alloc_buffer_and_set_caps   (GstPad *pad,
                                                         guint64 offset,
                                                         gint size,
                                                         GstCaps *caps,
                                                         GstBuffer **buf);

In addition to the function gst_pad_alloc_buffer(), this function automatically calls gst_pad_set_caps() when the caps of the newly allocated buffer are different from the pad caps.

After a renegotiation, the size of the new buffer returned in buf could be of the wrong size for the new format and must be unreffed an reallocated in that case.

gst_pad_set_bufferalloc_function ()

void                gst_pad_set_bufferalloc_function    (GstPad *pad,
                                                         GstPadBufferAllocFunction bufalloc);

Sets the given bufferalloc function for the pad. Note that the bufferalloc function can only be set on sinkpads.

GstPadBufferAllocFunction ()

GstFlowReturn       (*GstPadBufferAllocFunction)        (GstPad *pad,
                                                         guint64 offset,
                                                         guint size,
                                                         GstCaps *caps,
                                                         GstBuffer **buf);

Ask the sinkpad pad to allocate a buffer with offset, size and caps. The result will be stored in buf.

The purpose of this function is to allocate a buffer that is optimal to be processed by pad. The function is mostly overridden by elements that can provide a hardware buffer in order to avoid additional memcpy operations.

The function can return a buffer that has caps different from the requested caps, in which case the upstream element requests a format change to this new caps. If a format change was requested, the returned buffer will be one to hold the data of said new caps, so its size might be different from the requested size.

When this function returns anything else than GST_FLOW_OK, the buffer allocation failed and buf does not contain valid data. If the function returns GST_FLOW_OK and the buf is NULL, a GstBuffer will be created with caps, offset and size.

By default this function returns a new buffer of size and with caps containing purely malloced data. The buffer should be freed with gst_buffer_unref() after usage.

gst_pad_set_chain_function ()

void                gst_pad_set_chain_function          (GstPad *pad,
                                                         GstPadChainFunction chain);

Sets the given chain function for the pad. The chain function is called to process a GstBuffer input buffer. see GstPadChainFunction for more details.

GstPadChainFunction ()

GstFlowReturn       (*GstPadChainFunction)              (GstPad *pad,
                                                         GstBuffer *buffer);

A function that will be called on sinkpads when chaining buffers. The function typically processes the data contained in the buffer and either consumes the data or passes it on to the internally linked pad(s).

The implementer of this function receives a refcount to buffer and should gst_buffer_unref() when the buffer is no longer needed.

When a chain function detects an error in the data stream, it must post an error on the bus and return an appropriate GstFlowReturn value.

gst_pad_set_chain_list_function ()

void                gst_pad_set_chain_list_function     (GstPad *pad,
                                                         GstPadChainListFunction chainlist);

Sets the given chain list function for the pad. The chainlist function is called to process a GstBufferList input buffer list. See GstPadChainListFunction for more details.

Since 0.10.24

GstPadChainListFunction ()

GstFlowReturn       (*GstPadChainListFunction)          (GstPad *pad,
                                                         GstBufferList *list);

A function that will be called on sinkpads when chaining buffer lists. The function typically processes the data contained in the buffer list and either consumes the data or passes it on to the internally linked pad(s).

The implementer of this function receives a refcount to list and should gst_buffer_list_unref() when the list is no longer needed.

When a chainlist function detects an error in the data stream, it must post an error on the bus and return an appropriate GstFlowReturn value.

gst_pad_set_checkgetrange_function ()

void                gst_pad_set_checkgetrange_function  (GstPad *pad,
                                                         GstPadCheckGetRangeFunction check);

Sets the given checkgetrange function for the pad. Implement this function on a pad if you dynamically support getrange based scheduling on the pad.

GstPadCheckGetRangeFunction ()

gboolean            (*GstPadCheckGetRangeFunction)      (GstPad *pad);

Check if pad can be activated in pull mode.

This function will be deprecated after 0.10; use the seeking query to check if a pad can support random access.

gst_pad_get_range ()

GstFlowReturn       gst_pad_get_range                   (GstPad *pad,
                                                         guint64 offset,
                                                         guint size,
                                                         GstBuffer **buffer);

When pad is flushing this function returns GST_FLOW_WRONG_STATE immediatly.

Calls the getrange function of pad, see GstPadGetRangeFunction for a description of a getrange function. If pad has no getrange function installed (see gst_pad_set_getrange_function()) this function returns GST_FLOW_NOT_SUPPORTED.

This is a lowlevel function. Usualy gst_pad_pull_range() is used.

gst_pad_set_getrange_function ()

void                gst_pad_set_getrange_function       (GstPad *pad,
                                                         GstPadGetRangeFunction get);

Sets the given getrange function for the pad. The getrange function is called to produce a new GstBuffer to start the processing pipeline. see GstPadGetRangeFunction for a description of the getrange function.

GstPadGetRangeFunction ()

GstFlowReturn       (*GstPadGetRangeFunction)           (GstPad *pad,
                                                         guint64 offset,
                                                         guint length,
                                                         GstBuffer **buffer);

This function will be called on source pads when a peer element request a buffer at the specified offset and length. If this function returns GST_FLOW_OK, the result buffer will be stored in buffer. The contents of buffer is invalid for any other return value.

This function is installed on a source pad with gst_pad_set_getrange_function() and can only be called on source pads after they are successfully activated with gst_pad_activate_pull().

offset and length are always given in byte units. offset must normally be a value between 0 and the length in bytes of the data available on pad. The length (duration in bytes) can be retrieved with a GST_QUERY_DURATION or with a GST_QUERY_SEEKING.

Any offset larger or equal than the length will make the function return GST_FLOW_UNEXPECTED, which corresponds to EOS. In this case buffer does not contain a valid buffer.

The buffer size of buffer might be smaller than length when offset is near the end of the stream.

It is allowed to call this function with a 0 length and valid offset, in which case buffer will contain a 0-sized buffer and the function returns GST_FLOW_OK.

When this function is called with a -1 offset, the sequentially next buffer of length length in the stream is returned.

When this function is called with a -1 length, a buffer with a default optimal length is returned in buffer. The length might depend on the value of offset.

gst_pad_set_event_function ()

void                gst_pad_set_event_function          (GstPad *pad,
                                                         GstPadEventFunction event);

Sets the given event handler for the pad.

GstPadEventFunction ()

gboolean            (*GstPadEventFunction)              (GstPad *pad,
                                                         GstEvent *event);

Function signature to handle an event for the pad.

gst_pad_set_link_function ()

void                gst_pad_set_link_function           (GstPad *pad,
                                                         GstPadLinkFunction link);

Sets the given link function for the pad. It will be called when the pad is linked with another pad.

The return value GST_PAD_LINK_OK should be used when the connection can be made.

The return value GST_PAD_LINK_REFUSED should be used when the connection cannot be made for some reason.

If link is installed on a source pad, it should call the GstPadLinkFunction of the peer sink pad, if present.

GstPadLinkFunction ()

GstPadLinkReturn    (*GstPadLinkFunction)               (GstPad *pad,
                                                         GstPad *peer);

Function signature to handle a new link on the pad.

gst_pad_set_unlink_function ()

void                gst_pad_set_unlink_function         (GstPad *pad,
                                                         GstPadUnlinkFunction unlink);

Sets the given unlink function for the pad. It will be called when the pad is unlinked.

GstPadUnlinkFunction ()

void                (*GstPadUnlinkFunction)             (GstPad *pad);

Function signature to handle a unlinking the pad prom its peer.

gst_pad_accept_caps ()

gboolean            gst_pad_accept_caps                 (GstPad *pad,
                                                         GstCaps *caps);

Check if the given pad accepts the caps.

gst_pad_set_acceptcaps_function ()

void                gst_pad_set_acceptcaps_function     (GstPad *pad,
                                                         GstPadAcceptCapsFunction acceptcaps);

Sets the given acceptcaps function for the pad. The acceptcaps function will be called to check if the pad can accept the given caps. Setting the acceptcaps function to NULL restores the default behaviour of allowing any caps that matches the caps from gst_pad_get_caps.

GstPadAcceptCapsFunction ()

gboolean            (*GstPadAcceptCapsFunction)         (GstPad *pad,
                                                         GstCaps *caps);

Check if pad can accept caps. By default this function will see if caps intersect with the result from gst_pad_get_caps() by can be overridden to perform extra checks.

gst_pad_set_getcaps_function ()

void                gst_pad_set_getcaps_function        (GstPad *pad,
                                                         GstPadGetCapsFunction getcaps);

Sets the given getcaps function for the pad. getcaps should return the allowable caps for a pad in the context of the element's state, its link to other elements, and the devices or files it has opened. These caps must be a subset of the pad template caps. In the NULL state with no links, getcaps should ideally return the same caps as the pad template. In rare circumstances, an object property can affect the caps returned by getcaps, but this is discouraged.

You do not need to call this function if pad's allowed caps are always the same as the pad template caps. This can only be true if the padtemplate has fixed simple caps.

For most filters, the caps returned by getcaps is directly affected by the allowed caps on other pads. For demuxers and decoders, the caps returned by the srcpad's getcaps function is directly related to the stream data. Again, getcaps should return the most specific caps it reasonably can, since this helps with autoplugging.

Note that the return value from getcaps is owned by the caller, so the caller should unref the caps after usage.

GstPadGetCapsFunction ()

GstCaps*            (*GstPadGetCapsFunction)            (GstPad *pad);

Returns a copy of the capabilities of the specified pad. By default this function will return the pad template capabilities, but can optionally be overridden by elements.

gst_pad_proxy_getcaps ()

GstCaps*            gst_pad_proxy_getcaps               (GstPad *pad);

Calls gst_pad_get_allowed_caps() for every other pad belonging to the same element as pad, and returns the intersection of the results.

This function is useful as a default getcaps function for an element that can handle any stream format, but requires all its pads to have the same caps. Two such elements are tee and aggregator.

gst_pad_set_setcaps_function ()

void                gst_pad_set_setcaps_function        (GstPad *pad,
                                                         GstPadSetCapsFunction setcaps);

Sets the given setcaps function for the pad. The setcaps function will be called whenever a buffer with a new media type is pushed or pulled from the pad. The pad/element needs to update its internal structures to process the new media type. If this new type is not acceptable, the setcaps function should return FALSE.

GstPadSetCapsFunction ()

gboolean            (*GstPadSetCapsFunction)            (GstPad *pad,
                                                         GstCaps *caps);

Set caps on pad. By default this function updates the caps of the pad but the function can be overriden by elements to perform extra actions or verifications.

gst_pad_proxy_setcaps ()

gboolean            gst_pad_proxy_setcaps               (GstPad *pad,
                                                         GstCaps *caps);

Calls gst_pad_set_caps() for every other pad belonging to the same element as pad. If gst_pad_set_caps() fails on any pad, the proxy setcaps fails. May be used only during negotiation.

gst_pad_fixate_caps ()

void                gst_pad_fixate_caps                 (GstPad *pad,
                                                         GstCaps *caps);

Fixate a caps on the given pad. Modifies the caps in place, so you should make sure that the caps are actually writable (see gst_caps_make_writable()).

gst_pad_set_fixatecaps_function ()

void                gst_pad_set_fixatecaps_function     (GstPad *pad,
                                                         GstPadFixateCapsFunction fixatecaps);

Sets the given fixatecaps function for the pad. The fixatecaps function will be called whenever the default values for a GstCaps needs to be filled in.

GstPadFixateCapsFunction ()

void                (*GstPadFixateCapsFunction)         (GstPad *pad,
                                                         GstCaps *caps);

Given possibly unfixed caps caps, let pad use its default prefered format to make a fixed caps. caps should be writable. By default this function will pick the first value of any ranges or lists in the caps but elements can override this function to perform other behaviour.

gst_pad_get_fixed_caps_func ()

GstCaps*            gst_pad_get_fixed_caps_func         (GstPad *pad);

A helper function you can use as a GetCaps function that will return the currently negotiated caps or the padtemplate when NULL.

gst_pad_peer_accept_caps ()

gboolean            gst_pad_peer_accept_caps            (GstPad *pad,
                                                         GstCaps *caps);

Check if the peer of pad accepts caps. If pad has no peer, this function returns TRUE.

gst_pad_set_activate_function ()

void                gst_pad_set_activate_function       (GstPad *pad,
                                                         GstPadActivateFunction activate);

Sets the given activate function for pad. The activate function will dispatch to gst_pad_activate_push() or gst_pad_activate_pull() to perform the actual activation. Only makes sense to set on sink pads.

Call this function if your sink pad can start a pull-based task.

GstPadActivateFunction ()

gboolean            (*GstPadActivateFunction)           (GstPad *pad);

This function is called when the pad is activated during the element READY to PAUSED state change. By default this function will call the activate function that puts the pad in push mode but elements can override this function to activate the pad in pull mode if they wish.

gst_pad_set_activatepush_function ()

void                gst_pad_set_activatepush_function   (GstPad *pad,
                                                         GstPadActivateModeFunction activatepush);

Sets the given activate_push function for the pad. An activate_push function prepares the element for pushing. See XXX part-activation.txt for details.

gst_pad_set_activatepull_function ()

void                gst_pad_set_activatepull_function   (GstPad *pad,
                                                         GstPadActivateModeFunction activatepull);

Sets the given activate_pull function for the pad. An activate_pull function prepares the element and any upstream connections for pulling. See XXX part-activation.txt for details.

GstPadActivateModeFunction ()

gboolean            (*GstPadActivateModeFunction)       (GstPad *pad,
                                                         gboolean active);

The prototype of the push and pull activate functions.

gst_pad_push ()

GstFlowReturn       gst_pad_push                        (GstPad *pad,
                                                         GstBuffer *buffer);

Pushes a buffer to the peer of pad.

This function will call an installed pad block before triggering any installed pad probes.

If the caps on buffer are different from the currently configured caps on pad, this function will call any installed setcaps function on pad (see gst_pad_set_setcaps_function()). In case of failure to renegotiate the new format, this function returns GST_FLOW_NOT_NEGOTIATED.

The function proceeds calling gst_pad_chain() on the peer pad and returns the value from that function. If pad has no peer, GST_FLOW_NOT_LINKED will be returned.

In all cases, success or failure, the caller loses its reference to buffer after calling this function.

gst_pad_push_event ()

gboolean            gst_pad_push_event                  (GstPad *pad,
                                                         GstEvent *event);

Sends the event to the peer of the given pad. This function is mainly used by elements to send events to their peer elements.

This function takes owership of the provided event so you should gst_event_ref() it if you want to reuse the event after this call.

gst_pad_push_list ()

GstFlowReturn       gst_pad_push_list                   (GstPad *pad,
                                                         GstBufferList *list);

Pushes a buffer list to the peer of pad.

This function will call an installed pad block before triggering any installed pad probes.

If the caps on the first buffer in the first group of list are different from the currently configured caps on pad, this function will call any installed setcaps function on pad (see gst_pad_set_setcaps_function()). In case of failure to renegotiate the new format, this function returns GST_FLOW_NOT_NEGOTIATED.

If there are any probes installed on pad every group of the buffer list will be merged into a normal GstBuffer and pushed via gst_pad_push and the buffer list will be unreffed.

The function proceeds calling the chain function on the peer pad and returns the value from that function. If pad has no peer, GST_FLOW_NOT_LINKED will be returned. If the peer pad does not have any installed chainlist function every group buffer of the list will be merged into a normal GstBuffer and chained via gst_pad_chain().

In all cases, success or failure, the caller loses its reference to list after calling this function.

Since 0.10.24

gst_pad_check_pull_range ()

gboolean            gst_pad_check_pull_range            (GstPad *pad);

Checks if a gst_pad_pull_range() can be performed on the peer source pad. This function is used by plugins that want to check if they can use random access on the peer source pad.

The peer sourcepad can implement a custom GstPadCheckGetRangeFunction if it needs to perform some logic to determine if pull_range is possible.

gst_pad_pull_range ()

GstFlowReturn       gst_pad_pull_range                  (GstPad *pad,
                                                         guint64 offset,
                                                         guint size,
                                                         GstBuffer **buffer);

Pulls a buffer from the peer pad.

This function will first trigger the pad block signal if it was installed.

When pad is not linked GST_FLOW_NOT_LINKED is returned else this function returns the result of gst_pad_get_range() on the peer pad. See gst_pad_get_range() for a list of return values and for the semantics of the arguments of this function.

buffer's caps must either be unset or the same as what is already configured on pad. Renegotiation within a running pull-mode pipeline is not supported.

gst_pad_activate_pull ()

gboolean            gst_pad_activate_pull               (GstPad *pad,
                                                         gboolean active);

Activates or deactivates the given pad in pull mode via dispatching to the pad's activatepullfunc. For use from within pad activation functions only. When called on sink pads, will first proxy the call to the peer pad, which is expected to activate its internally linked pads from within its activate_pull function.

If you don't know what this is, you probably don't want to call it.

gst_pad_activate_push ()

gboolean            gst_pad_activate_push               (GstPad *pad,
                                                         gboolean active);

Activates or deactivates the given pad in push mode via dispatching to the pad's activatepushfunc. For use from within pad activation functions only.

If you don't know what this is, you probably don't want to call it.

gst_pad_send_event ()

gboolean            gst_pad_send_event                  (GstPad *pad,
                                                         GstEvent *event);

Sends the event to the pad. This function can be used by applications to send events in the pipeline.

If pad is a source pad, event should be an upstream event. If pad is a sink pad, event should be a downstream event. For example, you would not send a GST_EVENT_EOS on a src pad; EOS events only propagate downstream. Furthermore, some downstream events have to be serialized with data flow, like EOS, while some can travel out-of-band, like GST_EVENT_FLUSH_START. If the event needs to be serialized with data flow, this function will take the pad's stream lock while calling its event function.

To find out whether an event type is upstream, downstream, or downstream and serialized, see GstEventTypeFlags, gst_event_type_get_flags(), GST_EVENT_IS_UPSTREAM, GST_EVENT_IS_DOWNSTREAM, and GST_EVENT_IS_SERIALIZED. Note that in practice that an application or plugin doesn't need to bother itself with this information; the core handles all necessary locks and checks.

This function takes owership of the provided event so you should gst_event_ref() it if you want to reuse the event after this call.

gst_pad_event_default ()

gboolean            gst_pad_event_default               (GstPad *pad,
                                                         GstEvent *event);

Invokes the default event handler for the given pad. End-of-stream and discontinuity events are handled specially, and then the event is sent to all pads internally linked to pad. Note that if there are many possible sink pads that are internally linked to pad, only one will be sent an event. Multi-sinkpad elements should implement custom event handlers.

gst_pad_query ()

gboolean            gst_pad_query                       (GstPad *pad,
                                                         GstQuery *query);

Dispatches a query to a pad. The query should have been allocated by the caller via one of the type-specific allocation functions in gstquery.h. The element is responsible for filling the query with an appropriate response, which should then be parsed with a type-specific query parsing function.

Again, the caller is responsible for both the allocation and deallocation of the query structure.

gst_pad_peer_query ()

gboolean            gst_pad_peer_query                  (GstPad *pad,
                                                         GstQuery *query);

Performs gst_pad_query() on the peer of pad.

The caller is responsible for both the allocation and deallocation of the query structure.

Since 0.10.15

gst_pad_query_default ()

gboolean            gst_pad_query_default               (GstPad *pad,
                                                         GstQuery *query);

Invokes the default query handler for the given pad. The query is sent to all pads internally linked to pad. Note that if there are many possible sink pads that are internally linked to pad, only one will be sent the query. Multi-sinkpad elements should implement custom query handlers.

gst_pad_query_position ()

gboolean            gst_pad_query_position              (GstPad *pad,
                                                         GstFormat *format,
                                                         gint64 *cur);

Queries a pad for the stream position.

gst_pad_query_duration ()

gboolean            gst_pad_query_duration              (GstPad *pad,
                                                         GstFormat *format,
                                                         gint64 *duration);

Queries a pad for the total stream duration.

gst_pad_query_convert ()

gboolean            gst_pad_query_convert               (GstPad *pad,
                                                         GstFormat src_format,
                                                         gint64 src_val,
                                                         GstFormat *dest_format,
                                                         gint64 *dest_val);

Queries a pad to convert src_val in src_format to dest_format.

gst_pad_query_peer_position ()

gboolean            gst_pad_query_peer_position         (GstPad *pad,
                                                         GstFormat *format,
                                                         gint64 *cur);

Queries the peer of a given sink pad for the stream position.

gst_pad_query_peer_duration ()

gboolean            gst_pad_query_peer_duration         (GstPad *pad,
                                                         GstFormat *format,
                                                         gint64 *duration);

Queries the peer pad of a given sink pad for the total stream duration.

gst_pad_query_peer_convert ()

gboolean            gst_pad_query_peer_convert          (GstPad *pad,
                                                         GstFormat src_format,
                                                         gint64 src_val,
                                                         GstFormat *dest_format,
                                                         gint64 *dest_val);

Queries the peer pad of a given sink pad to convert src_val in src_format to dest_format.

gst_pad_set_query_function ()

void                gst_pad_set_query_function          (GstPad *pad,
                                                         GstPadQueryFunction query);

Set the given query function for the pad.

GstPadQueryFunction ()

gboolean            (*GstPadQueryFunction)              (GstPad *pad,
                                                         GstQuery *query);

The signature of the query function.

gst_pad_set_query_type_function ()

void                gst_pad_set_query_type_function     (GstPad *pad,
                                                         GstPadQueryTypeFunction type_func);

Set the given query type function for the pad.

GstPadQueryTypeFunction ()

const GstQueryType* (*GstPadQueryTypeFunction)          (GstPad *pad);

The signature of the query types function.

gst_pad_get_query_types ()

const GstQueryType* gst_pad_get_query_types             (GstPad *pad);

Get an array of supported queries that can be performed on this pad.

gst_pad_get_query_types_default ()

const GstQueryType* gst_pad_get_query_types_default     (GstPad *pad);

Invoke the default dispatcher for the query types on the pad.

gst_pad_set_iterate_internal_links_function ()

void                gst_pad_set_iterate_internal_links_function
                                                        (GstPad *pad,
                                                         GstPadIterIntLinkFunction iterintlink);

Sets the given internal link iterator function for the pad.

Since 0.10.21

GstPadIterIntLinkFunction ()

GstIterator*        (*GstPadIterIntLinkFunction)        (GstPad *pad);

The signature of the internal pad link iterator function.

gst_pad_iterate_internal_links ()

GstIterator*        gst_pad_iterate_internal_links      (GstPad *pad);

Gets an iterator for the pads to which the given pad is linked to inside of the parent element.

Each GstPad element yielded by the iterator will have its refcount increased, so unref after use.

Since 0.10.21

gst_pad_iterate_internal_links_default ()

GstIterator*        gst_pad_iterate_internal_links_default
                                                        (GstPad *pad);

Iterate the list of pads to which the given pad is linked to inside of the parent element. This is the default handler, and thus returns an iterator of all of the pads inside the parent element with opposite direction.

The caller must free this iterator after use with gst_iterator_free().

Since 0.10.21

gst_pad_set_internal_link_function ()

void                gst_pad_set_internal_link_function  (GstPad *pad,
                                                         GstPadIntLinkFunction intlink);

Sets the given internal link function for the pad.

GstPadIntLinkFunction ()

GList*              (*GstPadIntLinkFunction)            (GstPad *pad);

The signature of the internal pad link function.

gst_pad_get_internal_links ()

GList*              gst_pad_get_internal_links          (GstPad *pad);

Gets a list of pads to which the given pad is linked to inside of the parent element. The caller must free this list after use.

Not MT safe.

gst_pad_get_internal_links_default ()

GList*              gst_pad_get_internal_links_default  (GstPad *pad);

Gets a list of pads to which the given pad is linked to inside of the parent element. This is the default handler, and thus returns a list of all of the pads inside the parent element with opposite direction.

The caller must free this list after use with g_list_free().

gst_pad_load_and_link ()

void                gst_pad_load_and_link               (xmlNodePtr self,
                                                         GstObject *parent);

Reads the pad definition from the XML node and links the given pad in the element to a pad of an element up in the hierarchy.

gst_pad_dispatcher ()

gboolean            gst_pad_dispatcher                  (GstPad *pad,
                                                         GstPadDispatcherFunction dispatch,
                                                         gpointer data);

Invokes the given dispatcher function on each respective peer of all pads that are internally linked to the given pad. The GstPadDispatcherFunction should return TRUE when no further pads need to be processed.

GstPadDispatcherFunction ()

gboolean            (*GstPadDispatcherFunction)         (GstPad *pad,
                                                         gpointer data);

A dispatcher function is called for all internally linked pads, see gst_pad_dispatcher().

gst_pad_set_element_private ()

void                gst_pad_set_element_private         (GstPad *pad,
                                                         gpointer priv);

Set the given private data gpointer on the pad. This function can only be used by the element that owns the pad. No locking is performed in this function.

gst_pad_get_element_private ()

gpointer            gst_pad_get_element_private         (GstPad *pad);

Gets the private data of a pad. No locking is performed in this function.

gst_pad_chain ()

GstFlowReturn       gst_pad_chain                       (GstPad *pad,
                                                         GstBuffer *buffer);

Chain a buffer to pad.

The function returns GST_FLOW_WRONG_STATE if the pad was flushing.

If the caps on buffer are different from the current caps on pad, this function will call any setcaps function (see gst_pad_set_setcaps_function()) installed on pad. If the new caps are not acceptable for pad, this function returns GST_FLOW_NOT_NEGOTIATED.

The function proceeds calling the chain function installed on pad (see gst_pad_set_chain_function()) and the return value of that function is returned to the caller. GST_FLOW_NOT_SUPPORTED is returned if pad has no chain function.

In all cases, success or failure, the caller loses its reference to buffer after calling this function.

gst_pad_chain_list ()

GstFlowReturn       gst_pad_chain_list                  (GstPad *pad,
                                                         GstBufferList *list);

Chain a bufferlist to pad.

The function returns GST_FLOW_WRONG_STATE if the pad was flushing.

If the caps on the first buffer of list are different from the current caps on pad, this function will call any setcaps function (see gst_pad_set_setcaps_function()) installed on pad. If the new caps are not acceptable for pad, this function returns GST_FLOW_NOT_NEGOTIATED.

The function proceeds calling the chainlist function installed on pad (see gst_pad_set_chain_list_function()) and the return value of that function is returned to the caller. GST_FLOW_NOT_SUPPORTED is returned if pad has no chainlist function.

In all cases, success or failure, the caller loses its reference to list after calling this function.

MT safe.

Since 0.10.24

gst_pad_start_task ()

gboolean            gst_pad_start_task                  (GstPad *pad,
                                                         GstTaskFunction func,
                                                         gpointer data);

Starts a task that repeatedly calls func with data. This function is mostly used in pad activation functions to start the dataflow. The GST_PAD_STREAM_LOCK of pad will automatically be acquired before func is called.

gst_pad_pause_task ()

gboolean            gst_pad_pause_task                  (GstPad *pad);

Pause the task of pad. This function will also wait until the function executed by the task is finished if this function is not called from the task function.

gst_pad_stop_task ()

gboolean            gst_pad_stop_task                   (GstPad *pad);

Stop the task of pad. This function will also make sure that the function executed by the task will effectively stop if not called from the GstTaskFunction.

This function will deadlock if called from the GstTaskFunction of the task. Use gst_task_pause() instead.

Regardless of whether the pad has a task, the stream lock is acquired and released so as to ensure that streaming through this pad has finished.

gst_pad_set_active ()

gboolean            gst_pad_set_active                  (GstPad *pad,
                                                         gboolean active);

Activates or deactivates the given pad. Normally called from within core state change functions.

If active, makes sure the pad is active. If it is already active, either in push or pull mode, just return. Otherwise dispatches to the pad's activate function to perform the actual activation.

If not active, checks the pad's current mode and calls gst_pad_activate_push() or gst_pad_activate_pull(), as appropriate, with a FALSE argument.

GST_PAD_CAPS()

#define GST_PAD_CAPS(pad)		(GST_PAD_CAST(pad)->caps)

The caps for this pad.

GST_PAD_GET_STREAM_LOCK()

#define GST_PAD_GET_STREAM_LOCK(pad)    (GST_PAD_CAST(pad)->stream_rec_lock)

Get the stream lock of pad. The stream lock is protecting the resources used in the data processing functions of pad.

GST_PAD_STREAM_LOCK()

#define GST_PAD_STREAM_LOCK(pad)        (g_static_rec_mutex_lock(GST_PAD_GET_STREAM_LOCK(pad)))

Lock the stream lock of pad.

GST_PAD_STREAM_LOCK_FULL()

#define GST_PAD_STREAM_LOCK_FULL(pad,t) (g_static_rec_mutex_lock_full(GST_PAD_GET_STREAM_LOCK(pad), t))

Lock the stream lock of pad t times.

GST_PAD_STREAM_TRYLOCK()

#define GST_PAD_STREAM_TRYLOCK(pad)     (g_static_rec_mutex_trylock(GST_PAD_GET_STREAM_LOCK(pad)))

Try to Lock the stream lock of the pad, return TRUE if the lock could be taken.

GST_PAD_STREAM_UNLOCK()

#define GST_PAD_STREAM_UNLOCK(pad)      (g_static_rec_mutex_unlock(GST_PAD_GET_STREAM_LOCK(pad)))

Unlock the stream lock of pad.

GST_PAD_STREAM_UNLOCK_FULL()

#define GST_PAD_STREAM_UNLOCK_FULL(pad) (g_static_rec_mutex_unlock_full(GST_PAD_GET_STREAM_LOCK(pad)))

Fully unlock the recursive stream lock of pad, return the number of times pad was locked.

GST_FLOW_IS_FATAL()

#define GST_FLOW_IS_FATAL(ret) ((ret) <= GST_FLOW_UNEXPECTED)

Macro to test if the given GstFlowReturn value indicates a fatal error. This macro is mainly used in elements driving the pipeline to decide whether an error message should be posted on the bus. Note that such elements may also need to post an error message in the GST_FLOW_NOT_LINKED case which is not caught by this macro.

GST_FLOW_IS_SUCCESS()

#define GST_FLOW_IS_SUCCESS(ret) ((ret) >= GST_FLOW_OK)

Macro to test if the given GstFlowReturn value indicates a successfull result This macro is mainly used in elements to decide if the processing of a buffer was successfull.

Since 0.10.7

The "caps" property

  "caps"                     GstCaps*              : Read

The capabilities of the pad.

The "direction" property

  "direction"                GstPadDirection       : Read / Write / Construct Only

The direction of the pad.

Default value: GST_PAD_UNKNOWN

The "template" property

  "template"                 GstPadTemplate*       : Read / Write

The GstPadTemplate of this pad.

The "have-data" signal

gboolean            user_function                      (GstPad        *pad,
                                                        GstMiniObject *mini_obj,
                                                        gpointer       user_data)      : Run Last / Has Details

Signals that new data is available on the pad. This signal is used internally for implementing pad probes. See gst_pad_add_*_probe functions.

The "linked" signal

void                user_function                      (GstPad  *pad,
                                                        GstPad  *peer,
                                                        gpointer user_data)      : Run Last

Signals that a pad has been linked to the peer pad.

The "request-link" signal

void                user_function                      (GstPad  *pad,
                                                        gpointer user_data)      : Run Last

Signals that a pad connection has been requested.

The "unlinked" signal

void                user_function                      (GstPad  *pad,
                                                        GstPad  *peer,
                                                        gpointer user_data)      : Run Last

Signals that a pad has been unlinked from the peer pad.