[FFmpeg-devel] [PATCH 04/11] avcodec/packet: add some documentation for AVPacketSideData

[James Almer]

Explaining what or who may use it, and in what scenarios.

Signed-off-by: James Almer <jamrial at gmail.com>
---
 libavcodec/packet.h | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/libavcodec/packet.h b/libavcodec/packet.h
index 96fc0084d6..f88dad2b3c 100644
--- a/libavcodec/packet.h
+++ b/libavcodec/packet.h
@@ -312,6 +312,21 @@ enum AVPacketSideDataType {
 
 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
 
+/**
+ * This structure stores auxiliary data. It is typically exported by demuxers
+ * within @ref AVStream.codecpar.side_data "AVStream's codec parameters" or an
+ * @ref AVPacket.side_data "AVPacket" and then passed as input to decoders
+ * through the @ref AVCodecContext.coded_side_data "decoder context's side data"
+ * for initialization or through @ref AVPacket.side_data "AVPacket", or received
+ * as output from encoders within the @ref AVCodecContext.coded_side_data
+ * "encoder context's side data" or @ref AVPacket.side_data "AVPacket" and then
+ * passed to muxers through @ref AVStream.codecpar.side_data "AVStream's codec
+ * parameters" for initialization or through @ref AVPacket.side_data "AVPacket".
+ *
+ * Different modules may export or be provided 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