[FFmpeg-cvslog] libavformat/oggdec.h: Document packet function return value.

[Romain Beauxis]

ffmpeg | branch: master | Romain Beauxis <romain.beauxis at gmail.com> | Fri May  9 18:43:21 2025 -0500| [6d54af6599cae41f0948eb84ece4a57ffe3a73a6] | committer: Michael Niedermayer

libavformat/oggdec.h: Document packet function return value.

Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=6d54af6599cae41f0948eb84ece4a57ffe3a73a6
---

 libavformat/oggdec.h | 6 ++++++
 1 file changed, 6 insertions(+)

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.