Skip to main content

ffmpeg_the_third/codec/packet/
side_data.rs

1use std::marker::PhantomData;
2use std::slice;
3
4use super::Packet;
5use crate::ffi::*;
6#[cfg(feature = "serialize")]
7use serde::{Deserialize, Serialize};
8
9#[derive(Eq, PartialEq, Copy, Clone, Debug)]
10#[cfg_attr(feature = "serialize", derive(Serialize, Deserialize))]
11pub enum Type {
12    Palette,
13    NewExtraData,
14    ParamChange,
15    H263MbInfo,
16    ReplayGain,
17    DisplayMatrix,
18    Stereo3d,
19    AudioServiceType,
20    QualityStats,
21    FallbackTrack,
22    CBPProperties,
23    SkipSamples,
24    JpDualMono,
25    StringsMetadata,
26    SubtitlePosition,
27    MatroskaBlockAdditional,
28    WebVTTIdentifier,
29    WebVTTSettings,
30    MetadataUpdate,
31    MPEGTSStreamID,
32    MasteringDisplayMetadata,
33    DataSpherical,
34    DataNb,
35
36    ContentLightLevel,
37    A53CC,
38
39    EncryptionInitInfo,
40    EncryptionInfo,
41
42    AFD,
43
44    PRFT,
45    ICC_PROFILE,
46    DOVI_CONF,
47
48    S12M_TIMECODE,
49
50    DYNAMIC_HDR10_PLUS,
51
52    #[cfg(feature = "ffmpeg_7_0")]
53    IAMF_MIX_GAIN_PARAM,
54    #[cfg(feature = "ffmpeg_7_0")]
55    IAMF_DEMIXING_INFO_PARAM,
56    #[cfg(feature = "ffmpeg_7_0")]
57    IAMF_RECON_GAIN_INFO_PARAM,
58    #[cfg(feature = "ffmpeg_7_0")]
59    AMBIENT_VIEWING_ENVIRONMENT,
60
61    #[cfg(feature = "ffmpeg_7_1")]
62    FrameCropping,
63    #[cfg(feature = "ffmpeg_7_1")]
64    LCEVC,
65
66    #[cfg(feature = "ffmpeg_8_0")]
67    _3DReferenceDisplays,
68    #[cfg(feature = "ffmpeg_8_0")]
69    RTCP_SR,
70
71    #[cfg(feature = "ffmpeg_8_1")]
72    EXIF,
73}
74
75impl From<AVPacketSideDataType> for Type {
76    fn from(value: AVPacketSideDataType) -> Self {
77        use AVPacketSideDataType as AV;
78
79        match value {
80            AV::PALETTE => Type::Palette,
81            AV::NEW_EXTRADATA => Type::NewExtraData,
82            AV::PARAM_CHANGE => Type::ParamChange,
83            AV::H263_MB_INFO => Type::H263MbInfo,
84            AV::REPLAYGAIN => Type::ReplayGain,
85            AV::DISPLAYMATRIX => Type::DisplayMatrix,
86            AV::STEREO3D => Type::Stereo3d,
87            AV::AUDIO_SERVICE_TYPE => Type::AudioServiceType,
88            AV::QUALITY_STATS => Type::QualityStats,
89            AV::FALLBACK_TRACK => Type::FallbackTrack,
90            AV::CPB_PROPERTIES => Type::CBPProperties,
91            AV::SKIP_SAMPLES => Type::SkipSamples,
92            AV::JP_DUALMONO => Type::JpDualMono,
93            AV::STRINGS_METADATA => Type::StringsMetadata,
94            AV::SUBTITLE_POSITION => Type::SubtitlePosition,
95            AV::MATROSKA_BLOCKADDITIONAL => Type::MatroskaBlockAdditional,
96            AV::WEBVTT_IDENTIFIER => Type::WebVTTIdentifier,
97            AV::WEBVTT_SETTINGS => Type::WebVTTSettings,
98            AV::METADATA_UPDATE => Type::MetadataUpdate,
99            AV::MPEGTS_STREAM_ID => Type::MPEGTSStreamID,
100            AV::MASTERING_DISPLAY_METADATA => Type::MasteringDisplayMetadata,
101            AV::SPHERICAL => Type::DataSpherical,
102            AV::NB => Type::DataNb,
103
104            AV::CONTENT_LIGHT_LEVEL => Type::ContentLightLevel,
105            AV::A53_CC => Type::A53CC,
106
107            AV::ENCRYPTION_INIT_INFO => Type::EncryptionInitInfo,
108            AV::ENCRYPTION_INFO => Type::EncryptionInfo,
109
110            AV::AFD => Type::AFD,
111
112            AV::PRFT => Type::PRFT,
113            AV::ICC_PROFILE => Type::ICC_PROFILE,
114            AV::DOVI_CONF => Type::DOVI_CONF,
115
116            AV::S12M_TIMECODE => Type::S12M_TIMECODE,
117
118            AV::DYNAMIC_HDR10_PLUS => Type::DYNAMIC_HDR10_PLUS,
119
120            #[cfg(feature = "ffmpeg_7_0")]
121            AV::IAMF_MIX_GAIN_PARAM => Type::IAMF_MIX_GAIN_PARAM,
122            #[cfg(feature = "ffmpeg_7_0")]
123            AV::IAMF_DEMIXING_INFO_PARAM => Type::IAMF_DEMIXING_INFO_PARAM,
124            #[cfg(feature = "ffmpeg_7_0")]
125            AV::IAMF_RECON_GAIN_INFO_PARAM => Type::IAMF_RECON_GAIN_INFO_PARAM,
126            #[cfg(feature = "ffmpeg_7_0")]
127            AV::AMBIENT_VIEWING_ENVIRONMENT => Type::AMBIENT_VIEWING_ENVIRONMENT,
128
129            #[cfg(feature = "ffmpeg_7_1")]
130            AV::FRAME_CROPPING => Type::FrameCropping,
131            #[cfg(feature = "ffmpeg_7_1")]
132            AV::LCEVC => Type::LCEVC,
133
134            #[cfg(feature = "ffmpeg_8_0")]
135            AV::_3D_REFERENCE_DISPLAYS => Type::_3DReferenceDisplays,
136            #[cfg(feature = "ffmpeg_8_0")]
137            AV::RTCP_SR => Type::RTCP_SR,
138
139            #[cfg(feature = "ffmpeg_8_1")]
140            AV::EXIF => Type::EXIF,
141
142            _ => unimplemented!(),
143        }
144    }
145}
146
147impl From<Type> for AVPacketSideDataType {
148    fn from(value: Type) -> AVPacketSideDataType {
149        use AVPacketSideDataType as AV;
150
151        match value {
152            Type::Palette => AV::PALETTE,
153            Type::NewExtraData => AV::NEW_EXTRADATA,
154            Type::ParamChange => AV::PARAM_CHANGE,
155            Type::H263MbInfo => AV::H263_MB_INFO,
156            Type::ReplayGain => AV::REPLAYGAIN,
157            Type::DisplayMatrix => AV::DISPLAYMATRIX,
158            Type::Stereo3d => AV::STEREO3D,
159            Type::AudioServiceType => AV::AUDIO_SERVICE_TYPE,
160            Type::QualityStats => AV::QUALITY_STATS,
161            Type::FallbackTrack => AV::FALLBACK_TRACK,
162            Type::CBPProperties => AV::CPB_PROPERTIES,
163            Type::SkipSamples => AV::SKIP_SAMPLES,
164            Type::JpDualMono => AV::JP_DUALMONO,
165            Type::StringsMetadata => AV::STRINGS_METADATA,
166            Type::SubtitlePosition => AV::SUBTITLE_POSITION,
167            Type::MatroskaBlockAdditional => AV::MATROSKA_BLOCKADDITIONAL,
168            Type::WebVTTIdentifier => AV::WEBVTT_IDENTIFIER,
169            Type::WebVTTSettings => AV::WEBVTT_SETTINGS,
170            Type::MetadataUpdate => AV::METADATA_UPDATE,
171            Type::MPEGTSStreamID => AV::MPEGTS_STREAM_ID,
172            Type::MasteringDisplayMetadata => AV::MASTERING_DISPLAY_METADATA,
173            Type::DataSpherical => AV::SPHERICAL,
174            Type::DataNb => AV::NB,
175
176            Type::ContentLightLevel => AV::CONTENT_LIGHT_LEVEL,
177            Type::A53CC => AV::A53_CC,
178
179            Type::EncryptionInitInfo => AV::ENCRYPTION_INIT_INFO,
180            Type::EncryptionInfo => AV::ENCRYPTION_INFO,
181
182            Type::AFD => AV::AFD,
183
184            Type::PRFT => AV::PRFT,
185            Type::ICC_PROFILE => AV::ICC_PROFILE,
186            Type::DOVI_CONF => AV::DOVI_CONF,
187
188            Type::S12M_TIMECODE => AV::S12M_TIMECODE,
189
190            Type::DYNAMIC_HDR10_PLUS => AV::DYNAMIC_HDR10_PLUS,
191
192            #[cfg(feature = "ffmpeg_7_0")]
193            Type::IAMF_MIX_GAIN_PARAM => AV::IAMF_MIX_GAIN_PARAM,
194            #[cfg(feature = "ffmpeg_7_0")]
195            Type::IAMF_DEMIXING_INFO_PARAM => AV::IAMF_DEMIXING_INFO_PARAM,
196            #[cfg(feature = "ffmpeg_7_0")]
197            Type::IAMF_RECON_GAIN_INFO_PARAM => AV::IAMF_RECON_GAIN_INFO_PARAM,
198            #[cfg(feature = "ffmpeg_7_0")]
199            Type::AMBIENT_VIEWING_ENVIRONMENT => AV::AMBIENT_VIEWING_ENVIRONMENT,
200
201            #[cfg(feature = "ffmpeg_7_1")]
202            Type::FrameCropping => AV::FRAME_CROPPING,
203            #[cfg(feature = "ffmpeg_7_1")]
204            Type::LCEVC => AV::LCEVC,
205
206            #[cfg(feature = "ffmpeg_8_0")]
207            Type::_3DReferenceDisplays => AV::_3D_REFERENCE_DISPLAYS,
208            #[cfg(feature = "ffmpeg_8_0")]
209            Type::RTCP_SR => AV::RTCP_SR,
210
211            #[cfg(feature = "ffmpeg_8_1")]
212            Type::EXIF => AV::EXIF,
213        }
214    }
215}
216
217pub struct SideData<'a> {
218    ptr: *mut AVPacketSideData,
219
220    _marker: PhantomData<&'a Packet>,
221}
222
223impl<'a> SideData<'a> {
224    pub unsafe fn wrap(ptr: *mut AVPacketSideData) -> Self {
225        SideData {
226            ptr,
227            _marker: PhantomData,
228        }
229    }
230
231    pub unsafe fn as_ptr(&self) -> *const AVPacketSideData {
232        self.ptr as *const _
233    }
234}
235
236impl<'a> SideData<'a> {
237    pub fn kind(&self) -> Type {
238        unsafe { Type::from((*self.as_ptr()).type_) }
239    }
240
241    pub fn data(&self) -> &[u8] {
242        unsafe { slice::from_raw_parts((*self.as_ptr()).data, (*self.as_ptr()).size as usize) }
243    }
244}