Show / Hide Table of Contents

Enum FrameSideDataType

Types of side data that can be associated with an AVFrame.

Namespace: FFmpeg.SideData
Assembly: FFmpeg.dll
Syntax
public enum FrameSideDataType

Fields

Name Description
A53CC

ATSC A53 Part 4 Closed Captions. The caption bitstream is stored as a byte array, and the size of the side data indicates the number of bytes.

AFD

Active Format Description data consisting of a single byte as specified by ETSI TS 101 154.

AmbientViewingEnvironment

Ambient viewing environment metadata as defined by H.274.

AudioServiceType

The data must be associated with an audio frame and specifies its AVAudioServiceType.

ContentLightLevel

Content light level metadata based on CTA-861.3. The payload is an AVContentLightMetadata structure.

DOVIMetadata

Parsed Dolby Vision metadata suitable for passing to a software implementation. The payload is an AVDOVIMetadata structure.

DOVIRPUBuffer

Raw Dolby Vision RPU data suitable for passing to x265 or other libraries. The data is a byte array with NAL emulation bytes intact.

DetectionBBoxes

Bounding boxes for object detection and classification, as described by AVDetectionBBoxHeader.

DisplayMatrix

A 3x3 transformation matrix describing an affine transformation that needs to be applied to the frame for correct presentation.

DownmixInfo

The data is an AVDownmixInfo structure containing metadata relevant to an audio downmix procedure.

DynamicHDRPlus

HDR dynamic metadata associated with a video frame. The payload is an AVDynamicHDRPlus structure containing color volume transform information as specified by application 4 of SMPTE 2094-40:2016.

DynamicHDRSmpte2094App5

HDR dynamic metadata associated with a video frame. The payload is an AVDynamicHDRSmpte2094App5 structure containing color volume transform information as specified by SMPTE 2094-50.

DynamicHDRVivid

HDR Vivid dynamic metadata associated with a video frame. The payload is an AVDynamicHDRVivid structure containing color volume transform information as specified by CUVA 005.1-2021.

EXIF

Exchangeable Image File Format (EXIF) metadata. The payload is a buffer containing EXIF metadata beginning with a TIFF header that specifies the byte order.

FilmGrainParams

Film grain parameters for a frame, described by an AVFilmGrainParams structure. This side data must be present for every frame that should have film grain applied.

GOPTimecode

GOP timecode in 25-bit timecode format. The data is stored as a 64-bit integer and is set on the first frame of a GOP with a temporal reference of 0.

IAMFDemixingInfoParam

IAMF Demixing Info parameter data associated with an audio frame. The payload is an AVIAMFParamDefinition structure containing information defined in sections 3.6.1 and 3.8.2 of the Immersive Audio Model and Formats standard.

IAMFMixGainParam

IAMF Mix Gain parameter data associated with an audio frame. The payload is an AVIAMFParamDefinition structure containing information defined in sections 3.6.1 and 3.8.1 of the Immersive Audio Model and Formats standard.

IAMFReconGainInfoParam

IAMF Recon Gain Info parameter data associated with an audio frame. The payload is an AVIAMFParamDefinition structure containing information defined in sections 3.6.1 and 3.8.3 of the Immersive Audio Model and Formats standard.

ICCProfile

An ICC profile stored as an opaque byte buffer following ISO 15076-1, optionally accompanied by a name in the name metadata entry.

LCEVC

Raw LCEVC payload data stored as a byte array with NAL emulation bytes intact.

MasteringDisplayMetadata

Mastering display metadata associated with a video frame. The payload is an AVMasteringDisplayMetadata structure containing information about the mastering display color volume.

MatrixEncoding

The data is an AVMatrixEncoding value.

MotionVectors

Motion vectors exported by some codecs when requested through the export_mvs option. The data consists of AVMotionVector structures.

PanScan

The data is an AVPanScan structure defined in libavcodec.

RawColorParams

Color information from a RAW camera codec, needed to correctly process the video data. The payload is an AVRawColorParams structure defined in libavutil/raw_color_params.h.

ReferenceDisplays3D

Information about reference display widths and viewing distances, as well as the corresponding reference stereo pairs. The payload is an AV3DReferenceDisplaysInfo structure.

RegionsOfInterest

Regions of interest represented by an array of AVRegionOfInterest structures.

ReplayGain

The data is an AVReplayGain structure containing ReplayGain information.

S12MTimecode

Timecode conforming to SMPTE ST 12-1. The data is an array of four uint32 values describing up to three timecodes.

SEIUnregistered

User data unregistered metadata associated with a video frame. This is the H.264/H.265 user data unregistered SEI message.

SkipSamples

Recommends skipping the specified number of samples. This is exported only when the skip_manual option is enabled and uses the same format as AV_PKT_DATA_SKIP_SAMPLES.

Spherical

The data is an AVSphericalMapping structure containing spherical video mapping information.

Stereo3D

The data is an AVStereo3D structure containing stereoscopic 3D metadata.

VideoEncParams

Encoding parameters for a video frame, as described by AVVideoEncParams.

VideoHint

Encoder-specific hinting information about changed or unchanged portions of a frame. This can be used to identify portions that can be skipped because they have not changed from the corresponding portions of the previous frame.

ViewID

Identifies the view of a multi-view video frame. The data is an integer containing the view ID.

  • View Source
In this article
Back to top Generated by DocFX