1
0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2024-12-07 11:13:41 +02:00
FFmpeg/libavformat/av1.h
Andreas Rheinhardt 5f973193e5 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>
2022-01-19 11:57:58 +01:00

105 lines
3.8 KiB
C

/*
* AV1 helper functions for muxers
*
* This file is part of FFmpeg.
*
* FFmpeg is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* FFmpeg is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with FFmpeg; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef AVFORMAT_AV1_H
#define AVFORMAT_AV1_H
#include <stdint.h>
#include "avio.h"
typedef struct AV1SequenceParameters {
uint8_t profile;
uint8_t level;
uint8_t tier;
uint8_t bitdepth;
uint8_t monochrome;
uint8_t chroma_subsampling_x;
uint8_t chroma_subsampling_y;
uint8_t chroma_sample_position;
uint8_t color_description_present_flag;
uint8_t color_primaries;
uint8_t transfer_characteristics;
uint8_t matrix_coefficients;
uint8_t color_range;
} AV1SequenceParameters;
/**
* Filter out AV1 OBUs not meant to be present in ISOBMFF sample data and write
* the resulting bitstream to the provided AVIOContext.
*
* @param pb pointer to the AVIOContext where the filtered bitstream shall be
* 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 (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);
/**
* Filter out AV1 OBUs not meant to be present in ISOBMFF sample data and return
* the result in a data buffer, avoiding allocations and copies if possible.
*
* @param in input data buffer
* @param out pointer to pointer for the returned buffer. In case of success,
* it is independently allocated if and only if `*out` differs from in.
* @param size size of the input data buffer. The size of the resulting output
* data buffer will be written here
* @param offset offset of the returned data inside `*out`: It runs from
* `*out + offset` (inclusive) to `*out + offset + size`
* (exclusive); is zero if `*out` is independently allocated.
*
* @return 0 in case of success, a negative AVERROR code in case of failure.
* On failure, *out and *size are unchanged
* @note *out will be treated as unintialized on input and will not be freed.
*/
int ff_av1_filter_obus_buf(const uint8_t *in, uint8_t **out,
int *size, int *offset);
/**
* Parses a Sequence Header from the the provided buffer.
*
* @param seq pointer to the AV1SequenceParameters where the parsed values will
* be written
* @param buf input data buffer
* @param size size in bytes of the input data buffer
*
* @return >= 0 in case of success, a negative AVERROR code in case of failure
*/
int ff_av1_parse_seq_header(AV1SequenceParameters *seq, const uint8_t *buf, int size);
/**
* Writes AV1 extradata (Sequence Header and Metadata OBUs) to the provided
* AVIOContext.
*
* @param pb pointer to the AVIOContext where the av1C box shall be written
* @param buf input data buffer
* @param size size in bytes of the input data buffer
*
* @return >= 0 in case of success, a negative AVERROR code in case of failure
*/
int ff_isom_write_av1c(AVIOContext *pb, const uint8_t *buf, int size);
#endif /* AVFORMAT_AV1_H */