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>
This commit is contained in:
Andreas Rheinhardt 2022-01-16 00:00:22 +01:00
parent 396efc73e3
commit 5f973193e5

View File

@ -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);