Explaining what or who may use it, and in what scenarios.
Showing the changes to libavcodec (1 of 1 file). Show all
Unified · Split
| @@ -312,6 +312,33 @@ enum AVPacketSideDataType { · 311 unmodified lines | ||
| 312 | 312 | |
| 313 | 313 | #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED |
| 314 | 314 | |
| 315 | +/** | |
| 316 | + * This structure stores auxiliary information for decoding, presenting, or | |
| 317 | + * otherwise processing the coded stream. It is typically exported by demuxers | |
| 318 | + * and encoders and can be fed to decoders and muxers either in a per packet | |
| 319 | + * basis, or as global side data (applying to the entire coded stream). | |
| 320 | + * | |
| 321 | + * Global side data is handled as follows: | |
| 322 | + * - During demuxing, it may be exported through | |
| 323 | + * @ref AVStream.codecpar.side_data "AVStream's codec parameters", which can | |
| 324 | + * then be passed as input to decoders through the | |
| 325 | + * @ref AVCodecContext.coded_side_data "decoder context's side data", for | |
| 326 | + * initialization. | |
| 327 | + * - For muxing, it can be fed through @ref AVStream.codecpar.side_data | |
| 328 | + * "AVStream's codec parameters", typically the output of encoders through | |
| 329 | + * the @ref AVCodecContext.coded_side_data "encoder context's side data", for | |
| 330 | + * initialization. | |
| 331 | + * | |
| 332 | + * Packet specific side data is handled as follows: | |
| 333 | + * - During demuxing, it may be exported through @ref AVPacket.side_data | |
| 334 | + * "AVPacket's side data", which can then be passed as input to decoders. | |
| 335 | + * - For muxing, it can be fed through @ref AVPacket.side_data "AVPacket's | |
| 336 | + * side data", typically the output of encoders. | |
| 337 | + * | |
| 338 | + * Different modules may accept or export different types of side data | |
| 339 | + * depending on media type and codec. Refer to @ref AVPacketSideDataType for a | |
| 340 | + * list of defined types and where they may be found or used. | |
| 341 | + */ | |
| 315 | 342 | typedef struct AVPacketSideData { |
| 316 | 343 | uint8_t *data; |
| 317 | 344 | size_t size; |