baseparse: tweak some documentation
authorMark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>
Wed, 15 Feb 2012 16:12:09 +0000 (17:12 +0100)
committerMark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>
Wed, 15 Feb 2012 16:12:09 +0000 (17:12 +0100)
libs/gst/base/gstbaseparse.c
libs/gst/base/gstbaseparse.h

index e5576ad..c4bdc63 100644 (file)
@@ -656,8 +656,7 @@ gst_base_parse_frame_init (GstBaseParseFrame * frame)
  * then use gst_base_parse_frame_init() to initialise it.
  *
  * Returns: a newly-allocated #GstBaseParseFrame. Free with
- *     gst_base_parse_frame_free() when no longer needed, unless you gave
- *     away ownership to gst_base_parse_push_frame().
+ *     gst_base_parse_frame_free() when no longer needed.
  *
  * Since: 0.10.33
  */
@@ -2163,7 +2162,8 @@ no_caps:
  * If @frame's out_buffer is set, that will be used as subsequent frame data.
  * Otherwise, @size samples will be taken from the input and used for output,
  * and the output's metadata (timestamps etc) will be taken as (optionally)
- * set by the subclass on @frame's (input) buffer.
+ * set by the subclass on @frame's (input) buffer (which is otherwise
+ * ignored for any but the above purpose/information).
  *
  * Note that the latter buffer is invalidated by this call, whereas the
  * caller retains ownership of @frame.
index 5bef570..9d65185 100644 (file)
@@ -203,10 +203,9 @@ struct _GstBaseParse {
  *                  The frame's input buffer is guaranteed writable,
  *                  whereas the input frame ownership is held by caller
  *                  (so subclass should make a copy if it needs to hang on).
- *                  Input buffer (data) is equally managed by baseclass and should also be
- *                  copied (e.g. gst_buffer_copy_region()) when needed.
- *                  Time metadata will already be set as much as possible by baseclass
- *                  according to upstream information and/or subclass settings,
+ *                  Input buffer (data) is provided by baseclass with as much
+ *                  metadata set as possible by baseclass according to upstream
+ *                  information and/or subclass settings,
  *                  though subclass may still set buffer timestamp and duration
  *                  if desired.
  * @convert:        Optional.