Mercurial > libavformat.hg

diff avformat.h @ 2367:43a4290a6d77 libavformat

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mention AVPROBE_PADDING_SIZE at the read_probe() doxy
author michael
date Fri, 10 Aug 2007 16:15:23 +0000
parents 2adc9f64ecfb
children f7cbf58427e1
line wrap: on
line diff
--- a/avformat.h	Fri Aug 10 16:12:50 2007 +0000
+++ b/avformat.h	Fri Aug 10 16:15:23 2007 +0000
@@ -197,7 +197,11 @@
     const char *long_name;
     /** size of private data so that it can be allocated in the wrapper */
     int priv_data_size;
-    /** tell if a given file has a chance of being parsed by this format */
+    /**
+     * tell if a given file has a chance of being parsed by this format.
+     * The buffer provided is guranteed to be AVPROBE_PADDING_SIZE bytes big
+     * so you dont have to check for that unless you need more.
+     */
     int (*read_probe)(AVProbeData *);
     /** read the format header and initialize the AVFormatContext
        structure. Return 0 if OK. 'ap' if non NULL contains