diff options
author | Andreas Rheinhardt <andreas.rheinhardt@outlook.com> | 2022-01-16 00:00:22 +0100 |
---|---|---|
committer | Andreas Rheinhardt <andreas.rheinhardt@outlook.com> | 2022-01-19 11:57:58 +0100 |
commit | 5f973193e56ef0a8506dc2ff2784a25948154a69 (patch) | |
tree | bdef8eddead5f2d18a6bd9084226b8e106f60c9e | |
parent | 396efc73e33662ec22bd9b2f83ce33599e58f49c (diff) | |
download | ffmpeg-5f973193e56ef0a8506dc2ff2784a25948154a69.tar.gz |
avformat/av1: Document actual behaviour of ff_av1_filter_obus()
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.rheinhardt@outlook.com>
-rw-r--r-- | libavformat/av1.h | 6 |
1 files 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); |