aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRomain Beauxis <romain.beauxis@gmail.com>2025-05-09 18:43:21 -0500
committerMichael Niedermayer <michael@niedermayer.cc>2025-05-15 03:03:53 +0200
commit6d54af6599cae41f0948eb84ece4a57ffe3a73a6 (patch)
tree0b15c5e989a7c9378e39c56a51a9e9970cdf1a76
parent0d7172a9ffd15577faebecedaabeff398f26ef40 (diff)
downloadffmpeg-6d54af6599cae41f0948eb84ece4a57ffe3a73a6.tar.gz
libavformat/oggdec.h: Document packet function return value.
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
-rw-r--r--libavformat/oggdec.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/libavformat/oggdec.h b/libavformat/oggdec.h
index 43df23f4cb..5225b77a07 100644
--- a/libavformat/oggdec.h
+++ b/libavformat/oggdec.h
@@ -38,6 +38,12 @@ struct ogg_codec {
* -1 if an error occurred or for unsupported stream
*/
int (*header)(AVFormatContext *, int);
+ /**
+ * Attempt to process a packet as a data packet
+ * @return < 0 (AVERROR) code or -1 on error
+ * == 0 if the packet was a regular data packet.
+ * == 0 or 1 if the packet was a header from a chained bitstream.
+ */
int (*packet)(AVFormatContext *, int);
/**
* Translate a granule into a timestamp.