virtualenv/FFmpeg
1
0
Fork 0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2024-12-23 12:43:46 +02:00
Code Issues Releases Activity

Use a single space after an ending period and the beginning of the

Browse Source 
next sentence, consistent with the FFmpeg documentation style.

Originally committed as revision 18824 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Stefano Sabatini 2009-05-14 18:19:42 +00:00
parent c5c6f62668
commit 38efe76877
1 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
libavfilter/avfilter.h
View File

@ -50,7 +50,7 @@ typedef struct AVFilterPad AVFilterPad;
* flags, etc) * flags, etc)
*/ */
/** /**
* A reference-counted picture data type used by the filter system. Filters * A reference-counted picture data type used by the filter system. Filters
* should not store pointers to this structure directly, but instead use the * should not store pointers to this structure directly, but instead use the
* AVFilterPicRef structure below. * AVFilterPicRef structure below.
*/ */
@ -66,7 +66,7 @@ typedef struct AVFilterPic
void *priv; void *priv;
/** /**
* A pointer to the function to deallocate this image if the default * A pointer to the function to deallocate this image if the default
* function is not sufficient. This could, for example, add the memory * function is not sufficient. This could, for example, add the memory
* back into a memory pool to be reused later without the overhead of * back into a memory pool to be reused later without the overhead of
* reallocating it from scratch. * reallocating it from scratch.
*/ */
@ -74,9 +74,9 @@ typedef struct AVFilterPic
} AVFilterPic; } AVFilterPic;
/** /**
* A reference to an AVFilterPic. Since filters can manipulate the origin of * A reference to an AVFilterPic. Since filters can manipulate the origin of
* a picture to, for example, crop image without any memcpy, the picture origin * a picture to, for example, crop image without any memcpy, the picture origin
* and dimensions are per-reference properties. Linesize is also useful for * and dimensions are per-reference properties. Linesize is also useful for
* image flipping, frame to field filters, etc, and so is also per-reference. * image flipping, frame to field filters, etc, and so is also per-reference.
* *
* TODO: add anything necessary for frame reordering * TODO: add anything necessary for frame reordering
@ -244,20 +244,20 @@ void avfilter_formats_changeref(AVFilterFormats **oldref,
struct AVFilterPad struct AVFilterPad
{ {
/** /**
* Pad name. The name is unique among inputs and among outputs, but an * Pad name. The name is unique among inputs and among outputs, but an
* input may have the same name as an output. This may be NULL if this * input may have the same name as an output. This may be NULL if this
* pad has no need to ever be referenced by name. * pad has no need to ever be referenced by name.
*/ */
const char *name; const char *name;
/** /**
* AVFilterPad type. Only video supported now, hopefully someone will * AVFilterPad type. Only video supported now, hopefully someone will
* add audio in the future. * add audio in the future.
*/ */
enum CodecType type; enum CodecType type;
/** /**
* Minimum required permissions on incoming buffers. Any buffer with * Minimum required permissions on incoming buffers. Any buffer with
* insufficient permissions will be automatically copied by the filter * insufficient permissions will be automatically copied by the filter
* system to a new buffer which provides the needed access permissions. * system to a new buffer which provides the needed access permissions.
* *
@ -266,10 +266,10 @@ struct AVFilterPad
int min_perms; int min_perms;
/** /**
* Permissions which are not accepted on incoming buffers. Any buffer * Permissions which are not accepted on incoming buffers. Any buffer
* which has any of these permissions set will be automatically copied * which has any of these permissions set will be automatically copied
* by the filter system to a new buffer which does not have those * by the filter system to a new buffer which does not have those
* permissions. This can be used to easily disallow buffers with * permissions. This can be used to easily disallow buffers with
* AV_PERM_REUSE. * AV_PERM_REUSE.
* *
* Input pads only. * Input pads only.
@ -277,7 +277,7 @@ struct AVFilterPad
int rej_perms; int rej_perms;
/** /**
* Callback called before passing the first slice of a new frame. If * Callback called before passing the first slice of a new frame. If
* NULL, the filter layer will default to storing a reference to the * NULL, the filter layer will default to storing a reference to the
* picture inside the link structure. * picture inside the link structure.
* *
@ -286,7 +286,7 @@ struct AVFilterPad
void (*start_frame)(AVFilterLink *link, AVFilterPicRef *picref); void (*start_frame)(AVFilterLink *link, AVFilterPicRef *picref);
/** /**
* Callback function to get a buffer. If NULL, the filter system will * Callback function to get a buffer. If NULL, the filter system will
* handle buffer requests. * handle buffer requests.
* *
* Input video pads only. * Input video pads only.
@ -294,7 +294,7 @@ struct AVFilterPad
AVFilterPicRef *(*get_video_buffer)(AVFilterLink *link, int perms); AVFilterPicRef *(*get_video_buffer)(AVFilterLink *link, int perms);
/** /**
* Callback called after the slices of a frame are completely sent. If * Callback called after the slices of a frame are completely sent. If
* NULL, the filter layer will default to releasing the reference stored * NULL, the filter layer will default to releasing the reference stored
* in the link structure during start_frame(). * in the link structure during start_frame().
* *
@ -303,7 +303,7 @@ struct AVFilterPad
void (*end_frame)(AVFilterLink *link); void (*end_frame)(AVFilterLink *link);
/** /**
* Slice drawing callback. This is where a filter receives video data * Slice drawing callback. This is where a filter receives video data
* and should do its processing. * and should do its processing.
* *
* Input video pads only. * Input video pads only.
@ -311,7 +311,7 @@ struct AVFilterPad
void (*draw_slice)(AVFilterLink *link, int y, int height); void (*draw_slice)(AVFilterLink *link, int y, int height);
/** /**
* Frame poll callback. This returns the number of immediately available * Frame poll callback. This returns the number of immediately available
* frames. It should return a positive value if the next request_frame() * frames. It should return a positive value if the next request_frame()
* is guaranteed to return one frame (with no delay). * is guaranteed to return one frame (with no delay).
* *
@ -322,8 +322,8 @@ struct AVFilterPad
int (*poll_frame)(AVFilterLink *link); int (*poll_frame)(AVFilterLink *link);
/** /**
* Frame request callback. A call to this should result in at least one * Frame request callback. A call to this should result in at least one
* frame being output over the given link. This should return zero on * frame being output over the given link. This should return zero on
* success, and another value on error. * success, and another value on error.
* *
* Output video pads only. * Output video pads only.
@ -334,7 +334,7 @@ struct AVFilterPad
* Link configuration callback. * Link configuration callback.
* *
* For output pads, this should set the link properties such as * For output pads, this should set the link properties such as
* width/height. This should NOT set the format property - that is * width/height. This should NOT set the format property - that is
* negotiated between filters by the filter system using the * negotiated between filters by the filter system using the
* query_formats() callback before this function is called. * query_formats() callback before this function is called.
* *
@ -370,7 +370,7 @@ void avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
int avfilter_default_query_formats(AVFilterContext *ctx); int avfilter_default_query_formats(AVFilterContext *ctx);
/** /**
* Filter definition. This defines the pads a filter contains, and all the * Filter definition. This defines the pads a filter contains, and all the
* callback functions used to interact with the filter. * callback functions used to interact with the filter.
*/ */
typedef struct typedef struct
@ -380,16 +380,16 @@ typedef struct
int priv_size; ///< size of private data to allocate for the filter int priv_size; ///< size of private data to allocate for the filter
/** /**
* Filter initialization function. Args contains the user-supplied * Filter initialization function. Args contains the user-supplied
* parameters. FIXME: maybe an AVOption-based system would be better? * parameters. FIXME: maybe an AVOption-based system would be better?
* opaque is data provided by the code requesting creation of the filter, * opaque is data provided by the code requesting creation of the filter,
* and is used to pass data to the filter. * and is used to pass data to the filter.
*/ */
int (*init)(AVFilterContext *ctx, const char *args, void *opaque); int (*init)(AVFilterContext *ctx, const char *args, void *opaque);
/** /**
* Filter uninitialization function. Should deallocate any memory held * Filter uninitialization function. Should deallocate any memory held
* by the filter, release any picture references, etc. This does not need * by the filter, release any picture references, etc. This does not need
* to deallocate the AVFilterContext->priv memory itself. * to deallocate the AVFilterContext->priv memory itself.
*/ */
void (*uninit)(AVFilterContext *ctx); void (*uninit)(AVFilterContext *ctx);
@ -428,9 +428,9 @@ struct AVFilterContext
}; };
/** /**
* A link between two filters. This contains pointers to the source and * A link between two filters. This contains pointers to the source and
* destination filters between which this link exists, and the indexes of * destination filters between which this link exists, and the indexes of
* the pads involved. In addition, this link also contains the parameters * the pads involved. In addition, this link also contains the parameters
* which have been negotiated and agreed upon between the filter, such as * which have been negotiated and agreed upon between the filter, such as
* image dimensions, format, etc. * image dimensions, format, etc.
*/ */
@ -463,9 +463,9 @@ struct AVFilterLink
/** /**
* The picture reference currently being sent across the link by the source * The picture reference currently being sent across the link by the source
* filter. This is used internally by the filter system to allow * filter. This is used internally by the filter system to allow
* automatic copying of pictures which do not have sufficient permissions * automatic copying of pictures which do not have sufficient permissions
* for the destination. This should not be accessed directly by the * for the destination. This should not be accessed directly by the
* filters. * filters.
*/ */
AVFilterPicRef *srcpic; AVFilterPicRef *srcpic;
@ -497,7 +497,7 @@ int avfilter_config_links(AVFilterContext *filter);
* @param link the output link to the filter from which the picture will * @param link the output link to the filter from which the picture will
* be requested * be requested
* @param perms the required access permissions * @param perms the required access permissions
* @return A reference to the picture. This must be unreferenced with * @return A reference to the picture. This must be unreferenced with
* avfilter_unref_pic when you are finished with it. * avfilter_unref_pic when you are finished with it.
*/ */
AVFilterPicRef *avfilter_get_video_buffer(AVFilterLink *link, int perms); AVFilterPicRef *avfilter_get_video_buffer(AVFilterLink *link, int perms);
@ -520,9 +520,9 @@ int avfilter_poll_frame(AVFilterLink *link);
/** /**
* Notifies the next filter of the start of a frame. * Notifies the next filter of the start of a frame.
* @param link the output link the frame will be sent over * @param link the output link the frame will be sent over
* @param picref A reference to the frame about to be sent. The data for this * @param picref A reference to the frame about to be sent. The data for this
* frame need only be valid once draw_slice() is called for that * frame need only be valid once draw_slice() is called for that
* portion. The receiving filter will free this reference when * portion. The receiving filter will free this reference when
* it no longer needs it. * it no longer needs it.
*/ */
void avfilter_start_frame(AVFilterLink *link, AVFilterPicRef *picref); void avfilter_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
@ -541,10 +541,10 @@ void avfilter_end_frame(AVFilterLink *link);
*/ */
void avfilter_draw_slice(AVFilterLink *link, int y, int h); void avfilter_draw_slice(AVFilterLink *link, int y, int h);
/** Initialize the filter system. Registers all builtin filters */ /** Initialize the filter system. Registers all builtin filters */
void avfilter_register_all(void); void avfilter_register_all(void);
/** Uninitialize the filter system. Unregisters all filters */ /** Uninitialize the filter system. Unregisters all filters */
void avfilter_uninit(void); void avfilter_uninit(void);
/** /**
@ -567,8 +567,8 @@ AVFilter *avfilter_get_by_name(const char *name);
/** /**
* Creates a filter instance. * Creates a filter instance.
* @param filter the filter to create an instance of * @param filter the filter to create an instance of
* @param inst_name Name to give to the new instance. Can be NULL for none. * @param inst_name Name to give to the new instance. Can be NULL for none.
* @return Pointer to the new instance on success. NULL on failure. * @return Pointer to the new instance on success. NULL on failure.
*/ */
AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name); AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name);
@ -577,7 +577,7 @@ AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name);
* @param filter the filter to initialize * @param filter the filter to initialize
* @param args A string of parameters to use when initializing the filter. * @param args A string of parameters to use when initializing the filter.
* The format and meaning of this string varies by filter. * The format and meaning of this string varies by filter.
* @param opaque Any extra non-string data needed by the filter. The meaning * @param opaque Any extra non-string data needed by the filter. The meaning
* of this parameter varies by filter. * of this parameter varies by filter.
* @return zero on success * @return zero on success
*/ */
@ -602,7 +602,7 @@ int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
/** /**
* Inserts a new pad. * Inserts a new pad.
* @param idx Insertion point. Pad is inserted at the end if this point * @param idx Insertion point. Pad is inserted at the end if this point
* is beyond the end of the list of pads. * is beyond the end of the list of pads.
* @param count Pointer to the number of pads in the list * @param count Pointer to the number of pads in the list
* @param padidx_off Offset within an AVFilterLink structure to the element * @param padidx_off Offset within an AVFilterLink structure to the element