mirror of https://git.ffmpeg.org/ffmpeg.git
avcodec/packet: add some documentation for AVPacketSideData
Explaining what or who may use it, and in what scenarios. Signed-off-by: James Almer <jamrial@gmail.com>
This commit is contained in:
parent
5432d2aaca
commit
e500eb5a95
|
@ -312,6 +312,33 @@ enum AVPacketSideDataType {
|
||||||
|
|
||||||
#define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
|
#define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This structure stores auxiliary information for decoding, presenting, or
|
||||||
|
* otherwise processing the coded stream. It is typically exported by demuxers
|
||||||
|
* and encoders and can be fed to decoders and muxers either in a per packet
|
||||||
|
* basis, or as global side data (applying to the entire coded stream).
|
||||||
|
*
|
||||||
|
* Global side data is handled as follows:
|
||||||
|
* - During demuxing, it may be exported through
|
||||||
|
* @ref AVStream.codecpar.side_data "AVStream's codec parameters", which can
|
||||||
|
* then be passed as input to decoders through the
|
||||||
|
* @ref AVCodecContext.coded_side_data "decoder context's side data", for
|
||||||
|
* initialization.
|
||||||
|
* - For muxing, it can be fed through @ref AVStream.codecpar.side_data
|
||||||
|
* "AVStream's codec parameters", typically the output of encoders through
|
||||||
|
* the @ref AVCodecContext.coded_side_data "encoder context's side data", for
|
||||||
|
* initialization.
|
||||||
|
*
|
||||||
|
* Packet specific side data is handled as follows:
|
||||||
|
* - During demuxing, it may be exported through @ref AVPacket.side_data
|
||||||
|
* "AVPacket's side data", which can then be passed as input to decoders.
|
||||||
|
* - For muxing, it can be fed through @ref AVPacket.side_data "AVPacket's
|
||||||
|
* side data", typically the output of encoders.
|
||||||
|
*
|
||||||
|
* Different modules may accept or export different types of side data
|
||||||
|
* depending on media type and codec. Refer to @ref AVPacketSideDataType for a
|
||||||
|
* list of defined types and where they may be found or used.
|
||||||
|
*/
|
||||||
typedef struct AVPacketSideData {
|
typedef struct AVPacketSideData {
|
||||||
uint8_t *data;
|
uint8_t *data;
|
||||||
size_t size;
|
size_t size;
|
||||||
|
|
Loading…
Reference in New Issue