mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-27 12:11:13 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: clarify the pull_range functions

Browse source 
Clarify the gst_pad_pull_range(), GstBaseSrc::create(), gst_pad_get_range()
and GstPadGetRange functions a little.

Fixes #617733
This commit is contained in:
Wim Taymans 2010-05-05 12:01:50 +02:00
parent d00e97b7ea
commit 6e4fde7195
3 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
gst/gstpad.c
View file

@ -4588,7 +4588,7 @@ not_connected:
* @buffer: a pointer to hold the #GstBuffer, returns #GST_FLOW_ERROR if %NULL. * @buffer: a pointer to hold the #GstBuffer, returns #GST_FLOW_ERROR if %NULL.
* *
* When @pad is flushing this function returns #GST_FLOW_WRONG_STATE * When @pad is flushing this function returns #GST_FLOW_WRONG_STATE
* immediatly. * immediatly and @buffer is %NULL.
* *
* Calls the getrange function of @pad, see #GstPadGetRangeFunction for a * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
* description of a getrange function. If @pad has no getrange function * description of a getrange function. If @pad has no getrange function

8
gst/gstpad.h
View file

@ -291,8 +291,9 @@ typedef GstFlowReturn (*GstPadChainListFunction) (GstPad *pad, GstBufferList *l
* #GST_FLOW_UNEXPECTED, which corresponds to EOS. In this case @buffer does not * #GST_FLOW_UNEXPECTED, which corresponds to EOS. In this case @buffer does not
* contain a valid buffer. * contain a valid buffer.
* *
* The buffer size of @buffer might be smaller than @length when @offset is near * The buffer size of @buffer will only be smaller than @length when @offset is
* the end of the stream. * near the end of the stream. In all other cases, the size of @buffer must be
* exactly the requested size.
* *
* It is allowed to call this function with a 0 @length and valid @offset, in * 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 * which case @buffer will contain a 0-sized buffer and the function returns
@ -305,7 +306,8 @@ typedef GstFlowReturn (*GstPadChainListFunction) (GstPad *pad, GstBufferList *l
* optimal length is returned in @buffer. The length might depend on the value * optimal length is returned in @buffer. The length might depend on the value
* of @offset. * of @offset.
* *
* Returns: #GST_FLOW_OK for success * Returns: #GST_FLOW_OK for success and a valid buffer in @buffer. Any other
* return value leaves @buffer undefined.
*/ */
typedef GstFlowReturn (*GstPadGetRangeFunction) (GstPad *pad, guint64 offset, typedef GstFlowReturn (*GstPadGetRangeFunction) (GstPad *pad, guint64 offset,
guint length, GstBuffer **buffer); guint length, GstBuffer **buffer);

10
libs/gst/base/gstbasesrc.h
View file

@ -132,11 +132,19 @@ struct _GstBaseSrc {
* @get_size: Return the total size of the resource, in the configured format. * @get_size: Return the total size of the resource, in the configured format.
* @is_seekable: Check if the source can seek * @is_seekable: Check if the source can seek
* @unlock: Unlock any pending access to the resource. Subclasses should * @unlock: Unlock any pending access to the resource. Subclasses should
* unblock any blocked function ASAP * unblock any blocked function ASAP. In particular, any create() function in
* progress should be unblocked and should return GST_FLOW_WRONG_STATE. Any
* future create() function call should also return GST_FLOW_WRONG_STATE
* until the unlock_stop() function has been called.
* @unlock_stop: Clear the previous unlock request. Subclasses should clear * @unlock_stop: Clear the previous unlock request. Subclasses should clear
* any state they set during unlock(), such as clearing command queues. * any state they set during unlock(), such as clearing command queues.
* @event: Override this to implement custom event handling. * @event: Override this to implement custom event handling.
* @create: Ask the subclass to create a buffer with offset and size. * @create: Ask the subclass to create a buffer with offset and size.
* When the subclass returns GST_FLOW_OK, it MUST return a buffer of the
* requested size unless fewer bytes are available because an EOS condition
* is near. No buffer should be returned when the return value is different
* from GST_FLOW_OK. A return value of GST_FLOW_UNEXPECTED signifies that the
* end of stream is reached.
* @do_seek: Perform seeking on the resource to the indicated segment. * @do_seek: Perform seeking on the resource to the indicated segment.
* @prepare_seek_segment: Prepare the GstSegment that will be passed to the * @prepare_seek_segment: Prepare the GstSegment that will be passed to the
* do_seek vmethod for executing a seek request. Sub-classes should override * do_seek vmethod for executing a seek request. Sub-classes should override