* <itemizedlist>
* <listitem><para>
* Collectpads are created with gst_collect_pads_new(). A callback should then
- * be installed with gst_collect_pads_set_function ().
+ * be installed with gst_collect_pads_set_function ().
* </para></listitem>
* <listitem><para>
* Pads are added to the collection with gst_collect_pads_add_pad()/
* event itself.
* </para></listitem>
* <listitem><para>
- * Data can also be dequeued in byte units using the gst_collect_pads_available(),
+ * Data can also be dequeued in byte units using the gst_collect_pads_available(),
* gst_collect_pads_read() and gst_collect_pads_flush() calls.
* </para></listitem>
* <listitem><para>
*
* Create a new instance of #GstCollectPads.
*
- * Returns: (transfer full): a new #GstCollectPads, or NULL in case of an error.
- *
* MT safe.
+ *
+ * Returns: (transfer full): a new #GstCollectPads, or NULL in case of an error.
*/
GstCollectPads *
gst_collect_pads_new (void)
* This function calls gst_collect_pads_add_pad_full() passing a value of NULL
* for destroy_notify.
*
+ * MT safe.
+ *
* Returns: a new #GstCollectData to identify the new pad. Or NULL
* if wrong parameters are supplied.
- *
- * MT safe.
*/
GstCollectData *
gst_collect_pads_add_pad (GstCollectPads * pads, GstPad * pad, guint size)
* The pad will be automatically activated in push mode when @pads is
* started.
*
+ * MT safe.
+ *
* Since: 0.10.12
*
* Returns: a new #GstCollectData to identify the new pad. Or NULL
* if wrong parameters are supplied.
- *
- * MT safe.
*/
GstCollectData *
gst_collect_pads_add_pad_full (GstCollectPads * pads, GstPad * pad, guint size,
* @user_data: (closure): user data to pass to @clip_func
*
* Install a clipping function that is called right after a buffer is received
- * on a pad managed by @pads. See #GstCollectDataClipFunction for more info.
+ * on a pad managed by @pads. See #GstCollectPadsClipFunction for more info.
*
* Since: 0.10.26
*/
* @pad: (transfer none): the pad to remove
*
* Remove a pad from the collection of collect pads. This function will also
- * free the #GstCollectData and all the resources that were allocated with
+ * 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.
*
- * Returns: %TRUE if the pad could be removed.
- *
* MT safe.
+ *
+ * Returns: %TRUE if the pad could be removed.
*/
gboolean
gst_collect_pads_remove_pad (GstCollectPads * pads, GstPad * pad)
*
* This function is currently not implemented.
*
- * Returns: %TRUE if the pad is active.
- *
* MT safe.
+ *
+ * Returns: %TRUE if the pad is active.
*/
gboolean
gst_collect_pads_is_active (GstCollectPads * pads, GstPad * pad)
* @pads: the collectspads to use
*
* Collect data on all pads. This function is usually called
- * from a #GstTask function in an element.
+ * from a #GstTask function in an element.
*
* This function is currently not implemented.
*
- * Returns: #GstFlowReturn of the operation.
- *
* MT safe.
+ *
+ * Returns: #GstFlowReturn of the operation.
*/
GstFlowReturn
gst_collect_pads_collect (GstCollectPads * pads)
* @length: the length to collect
*
* Collect data with @offset and @length on all pads. This function
- * is typically called in the getrange function of an element.
+ * is typically called in the getrange function of an element.
*
* This function is currently not implemented.
*
- * Returns: #GstFlowReturn of the operation.
- *
* MT safe.
+ *
+ * Returns: #GstFlowReturn of the operation.
*/
GstFlowReturn
gst_collect_pads_collect_range (GstCollectPads * pads, guint64 offset,
}
}
/* Setting the pads to flushing means that we changed the values which
- * are 'protected' by the cookie. We therefore update it to force a
+ * are 'protected' by the cookie. We therefore update it to force a
* recalculation of the current pad status. */
pads->abidata.ABI.pad_cookie++;
}
* should be called with the @pads LOCK held, such as in the callback
* handler.
*
+ * MT safe.
+ *
* Returns: (transfer full): The buffer in @data or NULL if no buffer is queued.
* should unref the buffer after usage.
- *
- * MT safe.
*/
GstBuffer *
gst_collect_pads_peek (GstCollectPads * pads, GstCollectData * data)
*
* Free-function: gst_buffer_unref
*
+ * MT safe.
+ *
* Returns: (transfer full): The buffer in @data or NULL if no buffer was
* queued. You should unref the buffer after usage.
- *
- * MT safe.
*/
GstBuffer *
gst_collect_pads_pop (GstCollectPads * pads, GstCollectData * data)
* This function should be called with @pads LOCK held, such as
* in the callback.
*
+ * MT safe.
+ *
* Returns: The maximum number of bytes queued on all pads. This function
* returns 0 if a pad has no queued buffer.
- *
- * MT safe.
*/
/* FIXME, we can do this in the _chain functions */
guint
* This function should be called with @pads LOCK held, such as
* in the callback.
*
+ * MT safe.
+ *
* Returns: The number of bytes available for consumption in the
* memory pointed to by @bytes. This can be less than @size and
* is 0 if the pad is end-of-stream.
- *
- * MT safe.
*/
guint
gst_collect_pads_read (GstCollectPads * pads, GstCollectData * data,
* that requested. A return of NULL signals that the pad is end-of-stream.
* Unref the buffer with gst_buffer_unref() after use.
*
- * Since: 0.10.18
- *
* MT safe.
+ *
+ * Since: 0.10.18
*/
GstBuffer *
gst_collect_pads_read_buffer (GstCollectPads * pads, GstCollectData * data,
*
* Free-function: gst_buffer_unref
*
+ * MT safe.
+ *
* Returns: (transfer full): a #GstBuffer. The size of the buffer can be less
* that requested. A return of NULL signals that the pad is end-of-stream.
* Unref the buffer after use.
*
* Since: 0.10.18
- *
- * MT safe.
*/
GstBuffer *
gst_collect_pads_take_buffer (GstCollectPads * pads, GstCollectData * data,
* This function should be called with @pads LOCK held, such as
* in the callback.
*
+ * MT safe.
+ *
* Returns: The number of bytes flushed. This can be less than @size and
* is 0 if the pad was end-of-stream.
- *
- * MT safe.
*/
guint
gst_collect_pads_flush (GstCollectPads * pads, GstCollectData * data,
gst_pad_event_default (pad, event);
/* now unblock the chain function.
- * no cond per pad, so they all unblock,
+ * no cond per pad, so they all unblock,
* non-flushing block again */
GST_OBJECT_LOCK (pads);
data->abidata.ABI.flushing = TRUE;
data->abidata.ABI.new_segment = TRUE;
- /* we must not forward this event since multiple segments will be
+ /* we must not forward this event since multiple segments will be
* accumulated and this is certainly not what we want. */
gst_event_unref (event);
/* FIXME: collect-pads based elements need to create their own newsegment
* and if so we call the collected function. When this is done we check if
* data has been unqueued. If data is still queued we wait holding the stream
* lock to make sure no EOS event can happen while we are ready to be
- * collected
+ * collected
*/
static GstFlowReturn
gst_collect_pads_chain (GstPad * pad, GstBuffer * buffer)
/* wait to be collected, this must happen from another thread triggered
* by the _chain function of another pad. We release the lock so we
* can get stopped or flushed as well. We can however not get EOS
- * because we still hold the STREAM_LOCK.
+ * because we still hold the STREAM_LOCK.
*/
GST_COLLECT_PADS_WAIT (pads);
projects / platform / upstream / gstreamer.git / commitdiff