Allow NULL for read_header in AVInputFormat. See discussion in "[PATCH] allow

[ffmpeg] / libavfilter / avfilter.h

diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
index ab3214825ad48965bfee555c6c50884eca1b3499..6f6c41155f5aa419c54bf20ca0382bccb2b0dc5b 100644 (file)
--- a/libavfilter/avfilter.h
+++ b/libavfilter/avfilter.h
@@ -35,7 +35,7 @@
 #define LIBAVFILTER_BUILD       LIBAVFILTER_VERSION_INT
 
 #include <stddef.h>
-#include "avcodec.h"
+#include "libavcodec/avcodec.h"
 
 typedef struct AVFilterContext AVFilterContext;
 typedef struct AVFilterLink    AVFilterLink;
@@ -188,22 +188,32 @@ AVFilterFormats *avfilter_all_colorspaces(void);
 AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
 
 /**
- * Adds *ref as a new reference to f.
+ * Adds *ref as a new reference to formats.
  * That is the pointers will point like in the ascii art below:
  *   ________
- *  |   f    |<--------.
- *  |  ____  |         |
- *  | |refs| |       __|_
- *  | |* * | |      |  | |
+ *  |formats |<--------.
+ *  |  ____  |     ____|___________________
+ *  | |refs| |    |  __|_
+ *  | |* * | |    | |  | |  AVFilterLink
  *  | |* *--------->|*ref|
- *  | |____| |      |____|
- *  |________|
+ *  | |____| |    | |____|
+ *  |________|    |________________________
  */
-void avfilter_formats_ref(AVFilterFormats *f, AVFilterFormats **ref);
+void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref);
 
 /**
  * Remove *ref as a reference to the format list it currently points to,
  * deallocate that list if this was the last reference, and set *ref to NULL.
+ *
+ *         Before                                 After
+ *   ________                               ________         NULL
+ *  |formats |<--------.                   |formats |         ^
+ *  |  ____  |     ____|________________   |  ____  |     ____|________________
+ *  | |refs| |    |  __|_                  | |refs| |    |  __|_
+ *  | |* * | |    | |  | |  AVFilterLink   | |* * | |    | |  | |  AVFilterLink
+ *  | |* *--------->|*ref|                 | |*   | |    | |*ref|
+ *  | |____| |    | |____|                 | |____| |    | |____|
+ *  |________|    |_____________________   |________|    |_____________________
  */
 void avfilter_formats_unref(AVFilterFormats **ref);
 
@@ -211,7 +221,7 @@ void avfilter_formats_unref(AVFilterFormats **ref);
  *
  *         Before                                 After
  *   ________                         ________
- *  |   f    |<---------.            |   f    |<---------.
+ *  |formats |<---------.            |formats |<---------.
  *  |  ____  |       ___|___         |  ____  |       ___|___
  *  | |refs| |      |   |   |        | |refs| |      |   |   |   NULL
  *  | |* *--------->|*oldref|        | |* *--------->|*newref|     ^
@@ -411,7 +421,7 @@ struct AVFilterContext
 
 /**
  * A link between two filters.  This contains pointers to the source and
- * destination filters between which this link exists, and the indices of
+ * destination filters between which this link exists, and the indexes of
  * the pads involved.  In addition, this link also contains the parameters
  * which have been negotiated and agreed upon between the filter, such as
  * image dimensions, format, etc