[FFmpeg-cvslog] r10061 - trunk/libavformat/avformat.h

[michael]

Author: michael
Date: Fri Aug 10 18:15:23 2007
New Revision: 10061

Log:
mention AVPROBE_PADDING_SIZE at the read_probe() doxy


Modified:
   trunk/libavformat/avformat.h

Modified: trunk/libavformat/avformat.h
==============================================================================
--- trunk/libavformat/avformat.h	(original)
+++ trunk/libavformat/avformat.h	Fri Aug 10 18:15:23 2007
@@ -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