[FFmpeg-devel] [PATCH 4/5] avformat/avformat: Improve documentation of av_stream_get_side_data

Andreas Rheinhardt andreas.rheinhardt at gmail.com
Sun Jun 21 11:53:48 EEST 2020


Document that it also sets the size in case the desired side data is
absent (if the pointer has been supplied).

Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt at gmail.com>
---
 libavformat/avformat.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 21c282a100..e91e7f1d33 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -2189,7 +2189,8 @@ uint8_t *av_stream_new_side_data(AVStream *stream,
  *
  * @param stream stream
  * @param type desired side information type
- * @param size pointer for side information size to store (optional)
+ * @param size If supplied, *size will be set to the size of the side data
+ *             or to zero if the desired side data is not present.
  * @return pointer to data if present or NULL otherwise
  */
 uint8_t *av_stream_get_side_data(const AVStream *stream,
-- 
2.20.1



More information about the ffmpeg-devel mailing list