Document that it can be used with a NULL AVIOContext to
get the output size in a first pass.
Signed-off-by: Andreas Rheinhardt <andreas.rheinha...@outlook.com>
---
libavformat/av1.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/libavformat/av1.h b/libavformat/av1.h
index dd5b47dc25..f57dabe986 100644
--- a/libavformat/av1.h
+++ b/libavformat/av1.h
@@ -46,12 +46,14 @@ typedef struct AV1SequenceParameters {
* the resulting bitstream to the provided AVIOContext.
*
* @param pb pointer to the AVIOContext where the filtered bitstream shall be
- * written
+ * written; may be NULL, in which case nothing is written.
* @param buf input data buffer
* @param size size of the input data buffer
*
- * @return the amount of bytes written in case of success, a negative AVERROR
+ * @return the amount of bytes written (or would have been written in case
+ * pb had been supplied) in case of success, a negative AVERROR
* code in case of failure
+ * @note One can use NULL for pb to just get the output size.
*/
int ff_av1_filter_obus(AVIOContext *pb, const uint8_t *buf, int size);
--
2.32.0
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
