mention AVPROBE_PADDING_SIZE at the read_probe() doxy
authorMichael Niedermayer <michaelni@gmx.at>
Fri, 10 Aug 2007 16:15:23 +0000 (16:15 +0000)
committerMichael Niedermayer <michaelni@gmx.at>
Fri, 10 Aug 2007 16:15:23 +0000 (16:15 +0000)
Originally committed as revision 10061 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavformat/avformat.h

index ea93e85f08c5e78fd2722c2c2f22b91fef87937f..6a73e7609626bc769d587882d1e07d9797e172d3 100644 (file)
@@ -197,7 +197,11 @@ typedef struct AVInputFormat {
     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