mention AVPROBE_PADDING_SIZE at the read_probe() doxy

Originally committed as revision 10061 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Michael Niedermayer 2007-08-10 16:15:23 +00:00
parent d1a4544de9
commit 65d7d68b99
1 changed files with 5 additions and 1 deletions

View 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