Explaining what or who may use it, and in what scenarios.
Signed-off-by: James Almer <[email protected]>
---
libavcodec/packet.h | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/libavcodec/packet.h b/libavcodec/packet.h
index 96fc0084d6..85b3eeb728 100644
--- a/libavcodec/packet.h
+++ b/libavcodec/packet.h
@@ -312,6 +312,25 @@ enum AVPacketSideDataType {
#define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
+/**
+ * This structure stores 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 in a per packet basis, or as
+ * global side data (applying to the entire coded stream) as follows:
+ * - During demuxing, it will be exported through global side data in
+ * @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 global side data in
+ * @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.
+ *
+ * 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 {
uint8_t *data;
size_t size;
--
2.42.0
_______________________________________________
ffmpeg-devel mailing list
[email protected]
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
[email protected] with subject "unsubscribe".
