History

Use a single space after an ending period and the beginning of the next sentence, consistent with the FFmpeg documentation style.

Originally committed as revision 18824 to svn://svn.ffmpeg.org/ffmpeg/trunk

Stefano Sabatini committed 17 years ago

Commit 38efe761 parent c5c6f621 file · +36 −36Browse files

Unified · Split

libavfilter/avfilter.h+36−36
@@ -50,7 +50,7 @@ typedef struct AVFilterPad AVFilterPad; · 49 unmodified lines
5050 * flags, etc)
5151 */
5252 /**
53− * A reference-counted picture data type used by the filter system. Filters
53+ * A reference-counted picture data type used by the filter system. Filters
5454 * should not store pointers to this structure directly, but instead use the
5555 * AVFilterPicRef structure below.
5656 */
@@ -66,7 +66,7 @@ typedef struct AVFilterPic · 9 unmodified lines
6666 void *priv;
6767 /**
6868 * A pointer to the function to deallocate this image if the default
69− * function is not sufficient. This could, for example, add the memory
69+ * function is not sufficient. This could, for example, add the memory
7070 * back into a memory pool to be reused later without the overhead of
7171 * reallocating it from scratch.
7272 */
@@ -74,9 +74,9 @@ typedef struct AVFilterPic · 1 unmodified line
7474 } AVFilterPic;
7575
7676 /**
77− * A reference to an AVFilterPic. Since filters can manipulate the origin of
77+ * A reference to an AVFilterPic. Since filters can manipulate the origin of
7878 * a picture to, for example, crop image without any memcpy, the picture origin
79− * and dimensions are per-reference properties. Linesize is also useful for
79+ * and dimensions are per-reference properties. Linesize is also useful for
8080 * image flipping, frame to field filters, etc, and so is also per-reference.
8181 *
8282 * TODO: add anything necessary for frame reordering
@@ -244,20 +244,20 @@ void avfilter_formats_changeref(AVFilterFormats **oldref, · 161 unmodified lines
244244 struct AVFilterPad
245245 {
246246 /**
247− * Pad name. The name is unique among inputs and among outputs, but an
248− * input may have the same name as an output. This may be NULL if this
247+ * Pad name. The name is unique among inputs and among outputs, but an
248+ * input may have the same name as an output. This may be NULL if this
249249 * pad has no need to ever be referenced by name.
250250 */
251251 const char *name;
252252
253253 /**
254− * AVFilterPad type. Only video supported now, hopefully someone will
254+ * AVFilterPad type. Only video supported now, hopefully someone will
255255 * add audio in the future.
256256 */
257257 enum CodecType type;
258258
259259 /**
260− * Minimum required permissions on incoming buffers. Any buffer with
260+ * Minimum required permissions on incoming buffers. Any buffer with
261261 * insufficient permissions will be automatically copied by the filter
262262 * system to a new buffer which provides the needed access permissions.
263263 *
@@ -266,10 +266,10 @@ struct AVFilterPad · 2 unmodified lines
266266 int min_perms;
267267
268268 /**
269− * Permissions which are not accepted on incoming buffers. Any buffer
269+ * Permissions which are not accepted on incoming buffers. Any buffer
270270 * which has any of these permissions set will be automatically copied
271271 * by the filter system to a new buffer which does not have those
272− * permissions. This can be used to easily disallow buffers with
272+ * permissions. This can be used to easily disallow buffers with
273273 * AV_PERM_REUSE.
274274 *
275275 * Input pads only.
@@ -277,7 +277,7 @@ struct AVFilterPad · 1 unmodified line
277277 int rej_perms;
278278
279279 /**
280− * Callback called before passing the first slice of a new frame. If
280+ * Callback called before passing the first slice of a new frame. If
281281 * NULL, the filter layer will default to storing a reference to the
282282 * picture inside the link structure.
283283 *
@@ -286,7 +286,7 @@ struct AVFilterPad · 2 unmodified lines
286286 void (*start_frame)(AVFilterLink *link, AVFilterPicRef *picref);
287287
288288 /**
289− * Callback function to get a buffer. If NULL, the filter system will
289+ * Callback function to get a buffer. If NULL, the filter system will
290290 * handle buffer requests.
291291 *
292292 * Input video pads only.
@@ -294,7 +294,7 @@ struct AVFilterPad · 1 unmodified line
294294 AVFilterPicRef *(*get_video_buffer)(AVFilterLink *link, int perms);
295295
296296 /**
297− * Callback called after the slices of a frame are completely sent. If
297+ * Callback called after the slices of a frame are completely sent. If
298298 * NULL, the filter layer will default to releasing the reference stored
299299 * in the link structure during start_frame().
300300 *
@@ -303,7 +303,7 @@ struct AVFilterPad · 2 unmodified lines
303303 void (*end_frame)(AVFilterLink *link);
304304
305305 /**
306− * Slice drawing callback. This is where a filter receives video data
306+ * Slice drawing callback. This is where a filter receives video data
307307 * and should do its processing.
308308 *
309309 * Input video pads only.
@@ -311,7 +311,7 @@ struct AVFilterPad · 1 unmodified line
311311 void (*draw_slice)(AVFilterLink *link, int y, int height);
312312
313313 /**
314− * Frame poll callback. This returns the number of immediately available
314+ * Frame poll callback. This returns the number of immediately available
315315 * frames. It should return a positive value if the next request_frame()
316316 * is guaranteed to return one frame (with no delay).
317317 *
@@ -322,8 +322,8 @@ struct AVFilterPad · 4 unmodified lines
322322 int (*poll_frame)(AVFilterLink *link);
323323
324324 /**
325− * Frame request callback. A call to this should result in at least one
326− * frame being output over the given link. This should return zero on
325+ * Frame request callback. A call to this should result in at least one
326+ * frame being output over the given link. This should return zero on
327327 * success, and another value on error.
328328 *
329329 * Output video pads only.
@@ -334,7 +334,7 @@ struct AVFilterPad · 4 unmodified lines
334334 * Link configuration callback.
335335 *
336336 * For output pads, this should set the link properties such as
337− * width/height. This should NOT set the format property - that is
337+ * width/height. This should NOT set the format property - that is
338338 * negotiated between filters by the filter system using the
339339 * query_formats() callback before this function is called.
340340 *
@@ -370,7 +370,7 @@ void avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats) · 29 unmodified lines
370370 int avfilter_default_query_formats(AVFilterContext *ctx);
371371
372372 /**
373− * Filter definition. This defines the pads a filter contains, and all the
373+ * Filter definition. This defines the pads a filter contains, and all the
374374 * callback functions used to interact with the filter.
375375 */
376376 typedef struct
@@ -380,16 +380,16 @@ typedef struct · 3 unmodified lines
380380 int priv_size; ///< size of private data to allocate for the filter
381381
382382 /**
383− * Filter initialization function. Args contains the user-supplied
384− * parameters. FIXME: maybe an AVOption-based system would be better?
383+ * Filter initialization function. Args contains the user-supplied
384+ * parameters. FIXME: maybe an AVOption-based system would be better?
385385 * opaque is data provided by the code requesting creation of the filter,
386386 * and is used to pass data to the filter.
387387 */
388388 int (*init)(AVFilterContext *ctx, const char *args, void *opaque);
389389
390390 /**
391− * Filter uninitialization function. Should deallocate any memory held
392− * by the filter, release any picture references, etc. This does not need
391+ * Filter uninitialization function. Should deallocate any memory held
392+ * by the filter, release any picture references, etc. This does not need
393393 * to deallocate the AVFilterContext->priv memory itself.
394394 */
395395 void (*uninit)(AVFilterContext *ctx);
@@ -428,9 +428,9 @@ struct AVFilterContext · 32 unmodified lines
428428 };
429429
430430 /**
431− * A link between two filters. This contains pointers to the source and
431+ * A link between two filters. This contains pointers to the source and
432432 * destination filters between which this link exists, and the indexes of
433− * the pads involved. In addition, this link also contains the parameters
433+ * the pads involved. In addition, this link also contains the parameters
434434 * which have been negotiated and agreed upon between the filter, such as
435435 * image dimensions, format, etc.
436436 */
@@ -463,9 +463,9 @@ struct AVFilterLink · 26 unmodified lines
463463
464464 /**
465465 * The picture reference currently being sent across the link by the source
466− * filter. This is used internally by the filter system to allow
466+ * filter. This is used internally by the filter system to allow
467467 * automatic copying of pictures which do not have sufficient permissions
468− * for the destination. This should not be accessed directly by the
468+ * for the destination. This should not be accessed directly by the
469469 * filters.
470470 */
471471 AVFilterPicRef *srcpic;
@@ -497,7 +497,7 @@ int avfilter_config_links(AVFilterContext *filter); · 25 unmodified lines
497497 * @param link the output link to the filter from which the picture will
498498 * be requested
499499 * @param perms the required access permissions
500− * @return A reference to the picture. This must be unreferenced with
500+ * @return A reference to the picture. This must be unreferenced with
501501 * avfilter_unref_pic when you are finished with it.
502502 */
503503 AVFilterPicRef *avfilter_get_video_buffer(AVFilterLink *link, int perms);
@@ -520,9 +520,9 @@ int avfilter_poll_frame(AVFilterLink *link); · 16 unmodified lines
520520 /**
521521 * Notifies the next filter of the start of a frame.
522522 * @param link the output link the frame will be sent over
523− * @param picref A reference to the frame about to be sent. The data for this
523+ * @param picref A reference to the frame about to be sent. The data for this
524524 * frame need only be valid once draw_slice() is called for that
525− * portion. The receiving filter will free this reference when
525+ * portion. The receiving filter will free this reference when
526526 * it no longer needs it.
527527 */
528528 void avfilter_start_frame(AVFilterLink *link, AVFilterPicRef *picref);
@@ -541,10 +541,10 @@ void avfilter_end_frame(AVFilterLink *link); · 12 unmodified lines
541541 */
542542 void avfilter_draw_slice(AVFilterLink *link, int y, int h);
543543
544−/** Initialize the filter system. Registers all builtin filters */
544+/** Initialize the filter system. Registers all builtin filters */
545545 void avfilter_register_all(void);
546546
547−/** Uninitialize the filter system. Unregisters all filters */
547+/** Uninitialize the filter system. Unregisters all filters */
548548 void avfilter_uninit(void);
549549
550550 /**
@@ -567,8 +567,8 @@ AVFilter *avfilter_get_by_name(const char *name); · 16 unmodified lines
567567 /**
568568 * Creates a filter instance.
569569 * @param filter the filter to create an instance of
570− * @param inst_name Name to give to the new instance. Can be NULL for none.
571− * @return Pointer to the new instance on success. NULL on failure.
570+ * @param inst_name Name to give to the new instance. Can be NULL for none.
571+ * @return Pointer to the new instance on success. NULL on failure.
572572 */
573573 AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name);
574574
@@ -577,7 +577,7 @@ AVFilterContext *avfilter_open(AVFilter *filter, const char *inst_name); · 2 unmodified lines
577577 * @param filter the filter to initialize
578578 * @param args A string of parameters to use when initializing the filter.
579579 * The format and meaning of this string varies by filter.
580− * @param opaque Any extra non-string data needed by the filter. The meaning
580+ * @param opaque Any extra non-string data needed by the filter. The meaning
581581 * of this parameter varies by filter.
582582 * @return zero on success
583583 */
@@ -602,7 +602,7 @@ int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt, · 18 unmodified lines
602602
603603 /**
604604 * Inserts a new pad.
605− * @param idx Insertion point. Pad is inserted at the end if this point
605+ * @param idx Insertion point. Pad is inserted at the end if this point
606606 * is beyond the end of the list of pads.
607607 * @param count Pointer to the number of pads in the list
608608 * @param padidx_off Offset within an AVFilterLink structure to the element

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t