[FFmpeg-devel] [PATCH] [1/??] [2/3] Basic infrastructure

[Diego Biurrun]

On Sat, Feb 09, 2008 at 07:32:16PM +0100, Vitor Sessak wrote:
>
> /*
>  * video filters
>  * copyright (c) 2007 Bobby Bingham
>  *
>  * This file is part of FFmpeg.
>  *
>  * FFmpeg is free software; you can redistribute it and/or
>  * modify it under the terms of the GNU Lesser General Public
>  * License as published by the Free Software Foundation; either
>  * version 2.1 of the License, or (at your option) any later version.
>  *
>  * FFmpeg is distributed in the hope that it will be useful,
>  * but WITHOUT ANY WARRANTY; without even the implied warranty of
>  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
>  * Lesser General Public License for more details.
>  *
>  * You should have received a copy of the GNU Lesser General Public
>  * License along with FFmpeg; if not, write to the Free Software
>  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
>  */
> 
> #include "avfilter.h"
> 
> //extern AVFilter avfilter_vf_xxxxxxx;

This file is pointless (obfuscation).  Why add an empty header file?

> /*
>  * Filter layer

nit: filter

> /*
>  * Filter layer

nit: filter

> /**
>  * A reference-counted picture data type used by the filter system.  Filters
>  * should not store pointers to this structure directly, but instead use the
>  * AVFilterPicRef structure below

nit: missing period

> /**
>  * Add a new reference to a picture.
>  * @param ref   An existing reference to the picture
>  * @param pmask A bitmask containing the allowable permissions in the new
>  *              reference
>  * @return      A new reference to the picture with the same properties as the
>  *              old, excluding any permissions denied by pmask

nit: These should not be capitalized.

> /**
>  * A filter pad used for either input or output

nit: This should not be capitalized.

>     AVClass *av_class;              ///< Needed for av_log()
> 
>     AVFilter *filter;               ///< The AVFilter of which this is an instance

ditto

> /**
>  * A links between two filters.  This contains pointers to the source and

link

>     /**
>      * The picture reference currently being sent across the link by the source
>      * filter.  This is used internally by the filter system to allow
>      * automatic copying of pictures which d not have sufficient permissions

do not

> /**
>  * Link two filters together

nit: missing period

>  * @param src    The source filter
>  * @param srcpad Index of the output pad on the source filter
>  * @param dst    The destination filter
>  * @param dstpad Index of the input pad on the destination filter
>  * @return       Zero on success

nit: These should not be capitalized.

> /**
>  * Negotiate the colorspace, dimensions, etc of all inputs to a filter.
>  * @param filter The filter to negotiate the properties for its inputs
>  * @return       Zero on successful negotiation

ditto

>  * Request a picture buffer with a specific set of permissions
>  * @param link  The output link to the filter from which the picture will
>  *              be requested
>  * @param perms The required access permissions

ditto

> /**
>  * Request an input frame from the filter at the other end of the link.
>  * @param link The input link
>  * @return     Zero on success

ditto

> /**
>  * Notify the next filter that the current frame has finished
>  * @param link The output link the frame was sent over

ditto

> /**
>  * Send a slice to the next filter
>  * @param link The output link over which the frame is being sent
>  * @param y    Offset in pixels from the top of the image for this slice
>  * @param h    Height of this slice in pixels

ditto

> /**
>  * Gets a filter definition matching the given name
>  * @param name The filter name to find
>  * @return     The filter definition, if any matching one is registered.

ditto

> /**
>  * Create a filter instance
>  * @param filter    The filter to create an instance of

ditto

> /**
>  * Initialize a filter
>  * @param filter The filter to initialize

ditto

> /**
>  * Destroy a filter

missing period

>  * @param filter The filter to destroy

Do not capitalize.

> /**
>  * Insert a filter in the middle of an existing link.
>  * @param link The link into which the filter should be inserted
>  * @param filt The filter to be inserted
>  * @param in   The input pad on the filter to connect
>  * @param out  The output pad on the filter to connect
>  * @return     Zero on success

ditto

> /**
>  * Insert a new pad

missing period

Diego