From: Andoni Morales Alastruey Date: Mon, 8 Oct 2012 10:43:03 +0000 (+0200) Subject: audio/video: update documentation for vfunc's that require chaining up X-Git-Tag: 1.19.3~511^2~5853 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8a5cf5ef4db12811068808ede59f383cdd25d8c3;p=platform%2Fupstream%2Fgstreamer.git audio/video: update documentation for vfunc's that require chaining up --- diff --git a/gst-libs/gst/audio/gstaudiodecoder.h b/gst-libs/gst/audio/gstaudiodecoder.h index 90d3d05..27e1fab 100644 --- a/gst-libs/gst/audio/gstaudiodecoder.h +++ b/gst-libs/gst/audio/gstaudiodecoder.h @@ -215,12 +215,18 @@ struct _GstAudioDecoder * Allows closing external resources. * @negotiate: Optional. * Negotiate with downstream and configure buffer pools, etc. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @decide_allocation: Optional. * Setup the allocation parameters for allocating output * buffers. The passed in query contains the result of the * downstream allocation query. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @propose_allocation: Optional. * Propose buffer allocation parameters for upstream elements. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * * Subclasses can override any of the available virtual methods or not, as * needed. At minimum @handle_frame (and likely @set_format) needs to be diff --git a/gst-libs/gst/audio/gstaudioencoder.h b/gst-libs/gst/audio/gstaudioencoder.h index d989bf9..e4973af 100644 --- a/gst-libs/gst/audio/gstaudioencoder.h +++ b/gst-libs/gst/audio/gstaudioencoder.h @@ -159,12 +159,18 @@ struct _GstAudioEncoder { * Allows closing external resources. * @negotiate: Optional. * Negotiate with downstream and configure buffer pools, etc. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @decide_allocation: Optional. * Setup the allocation parameters for allocating output * buffers. The passed in query contains the result of the * downstream allocation query. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @propose_allocation: Optional. * Propose buffer allocation parameters for upstream elements. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * * Subclasses can override any of the available virtual methods or not, as * needed. At minimum @set_format and @handle_frame needs to be overridden. diff --git a/gst-libs/gst/video/gstvideodecoder.h b/gst-libs/gst/video/gstvideodecoder.h index 26dd86d..56b0f1d 100644 --- a/gst-libs/gst/video/gstvideodecoder.h +++ b/gst-libs/gst/video/gstvideodecoder.h @@ -219,18 +219,28 @@ struct _GstVideoDecoder * Event handler on the sink pad. This function should return * TRUE if the event was handled and should be discarded * (i.e. not unref'ed). + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @src_event: Optional. * Event handler on the source pad. This function should return * TRUE if the event was handled and should be discarded * (i.e. not unref'ed). + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @negotiate: Optional. * Negotiate with downstream and configure buffer pools, etc. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @decide_allocation: Optional. * Setup the allocation parameters for allocating output * buffers. The passed in query contains the result of the * downstream allocation query. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @propose_allocation: Optional. * Propose buffer allocation parameters for upstream elements. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * * Subclasses can override any of the available virtual methods or not, as * needed. At minimum @handle_frame needs to be overridden, and @set_format diff --git a/gst-libs/gst/video/gstvideoencoder.h b/gst-libs/gst/video/gstvideoencoder.h index ca9c9cf..da42036 100644 --- a/gst-libs/gst/video/gstvideoencoder.h +++ b/gst-libs/gst/video/gstvideoencoder.h @@ -188,18 +188,28 @@ struct _GstVideoEncoder * Event handler on the sink pad. This function should return * TRUE if the event was handled and should be discarded * (i.e. not unref'ed). + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @src_event: Optional. * Event handler on the source pad. This function should return * TRUE if the event was handled and should be discarded * (i.e. not unref'ed). + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @negotiate: Optional. * Negotiate with downstream and configure buffer pools, etc. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @decide_allocation: Optional. * Setup the allocation parameters for allocating output * buffers. The passed in query contains the result of the * downstream allocation query. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * @propose_allocation: Optional. * Propose buffer allocation parameters for upstream elements. + * Subclasses should chain up to the parent implementation to + * invoke the default handler. * * Subclasses can override any of the available virtual methods or not, as * needed. At minimum @handle_frame needs to be overridden, and @set_format