baseparse: update some documentation

Also add some more debug.
This commit is contained in:
Mark Nauwelaerts 2011-01-07 15:58:49 +01:00 committed by Tim-Philipp Müller
parent e567d1776c
commit efe6f065d6
2 changed files with 12 additions and 4 deletions

View file

@ -90,7 +90,8 @@
* <listitem><para>
* After valid frame is found, it will be passed again to subclass with
* @parse_frame call. Now subclass is responsible for parsing the
* frame contents and setting the caps, buffer timestamp and duration
* frame contents and setting the caps, and buffer metadata (e.g.
* buffer timestamp and duration, or keyframe if applicable).
* (although the latter can also be done by GstBaseParse if it is
* appropriately configured, see below).
* </para></listitem>
@ -2202,6 +2203,9 @@ gst_base_parse_scan_frame (GstBaseParse * parse, GstBaseParseClass * klass,
g_return_val_if_fail (buf != NULL, GST_FLOW_ERROR);
GST_LOG_OBJECT (parse, "scanning for frame at offset %" G_GUINT64_FORMAT
" (%#" G_GINT64_MODIFIER "x)", parse->priv->offset, parse->priv->offset);
while (TRUE) {
min_size = MAX (parse->priv->min_frame_size, fsize);
@ -2640,8 +2644,12 @@ gst_base_parse_set_min_frame_size (GstBaseParse * parse, guint min_size)
* @parse: the #GstBaseParse to set
* @passthrough: boolean indicating passthrough mode.
*
* Set passthrough mode for this parser. If operating in passthrough,
* incoming buffers are pushed through unmodified.
* Set passthrough mode for this parser (which only applies operating in pull
* mode). If operating in passthrough, incoming buffers are pushed through
* unmodified. That is, no @check_valid_frame or @parse_frame callbacks
* will be invoked. On the ohter hand, @pre_push_buffer is still invoked,
* where subclass can perform as much or as little is appropriate for
* "passthrough" semantics.
*/
void
gst_base_parse_set_passthrough (GstBaseParse * parse, gboolean passthrough)

View file

@ -200,7 +200,7 @@ struct _GstBaseParse {
* Called just prior to pushing a frame (after any pending
* events have been sent) to give subclass a chance to perform
* additional actions at this time (e.g. tag sending) or to
* decide whether this buffer should be dropped or no
* decide whether this buffer should be dropped or not
* (e.g. custom segment clipping).
*
* Subclasses can override any of the available virtual methods or not, as