From 1fa9726cf6442879ebb61452d30d240d710e3580 Mon Sep 17 00:00:00 2001 From: David Conrad Date: Sat, 21 Mar 2009 08:03:30 +0000 Subject: Document ogg_codec's header function Originally committed as revision 18100 to svn://svn.ffmpeg.org/ffmpeg/trunk --- libavformat/oggdec.h | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'libavformat/oggdec.h') diff --git a/libavformat/oggdec.h b/libavformat/oggdec.h index d238e99a4b..1d65ba7979 100644 --- a/libavformat/oggdec.h +++ b/libavformat/oggdec.h @@ -31,6 +31,12 @@ struct ogg_codec { const int8_t *magic; uint8_t magicsize; const int8_t *name; + /** + * Attempt to process a packet as a header + * @return 1 if the packet was a valid header, + * 0 if the packet was not a header (was a data packet) + * -1 if an error occurred or for unsupported stream + */ int (*header)(AVFormatContext *, int); int (*packet)(AVFormatContext *, int); uint64_t (*gptopts)(AVFormatContext *, int, uint64_t); -- cgit v1.2.3