ffmpeg_next/codec/packet/
side_data.rs

1use std::marker::PhantomData;
2use std::slice;
3
4use super::Packet;
5use ffi::AVPacketSideDataType::*;
6use ffi::*;
7
8#[derive(Eq, PartialEq, Copy, Clone, Debug)]
9pub enum Type {
10    Palette,
11    NewExtraData,
12    ParamChange,
13    H263MbInfo,
14    ReplayGain,
15    DisplayMatrix,
16    Stereo3d,
17    AudioServiceType,
18    QualityStats,
19    FallbackTrack,
20    CBPProperties,
21    SkipSamples,
22    JpDualMono,
23    StringsMetadata,
24    SubtitlePosition,
25    MatroskaBlockAdditional,
26    WebVTTIdentifier,
27    WebVTTSettings,
28    MetadataUpdate,
29    MPEGTSStreamID,
30    MasteringDisplayMetadata,
31    DataSpherical,
32    DataNb,
33
34    ContentLightLevel,
35    A53CC,
36
37    #[cfg(feature = "ffmpeg_4_0")]
38    EncryptionInitInfo,
39    #[cfg(feature = "ffmpeg_4_0")]
40    EncryptionInfo,
41
42    #[cfg(feature = "ffmpeg_4_1")]
43    AFD,
44
45    #[cfg(feature = "ffmpeg_4_3")]
46    PRFT,
47    #[cfg(feature = "ffmpeg_4_3")]
48    ICC_PROFILE,
49    #[cfg(feature = "ffmpeg_4_3")]
50    DOVI_CONF,
51
52    #[cfg(feature = "ffmpeg_4_4")]
53    S12M_TIMECODE,
54
55    #[cfg(feature = "ffmpeg_5_0")]
56    DYNAMIC_HDR10_PLUS,
57
58    #[cfg(feature = "ffmpeg_7_0")]
59    IAMF_MIX_GAIN_PARAM,
60    #[cfg(feature = "ffmpeg_7_0")]
61    IAMF_DEMIXING_INFO_PARAM,
62    #[cfg(feature = "ffmpeg_7_0")]
63    IAMF_RECON_GAIN_INFO_PARAM,
64    #[cfg(feature = "ffmpeg_7_0")]
65    AMBIENT_VIEWING_ENVIRONMENT,
66
67    #[cfg(feature = "ffmpeg_7_1")]
68    FRAME_CROPPING,
69    #[cfg(feature = "ffmpeg_7_1")]
70    LCEVC,
71
72    #[cfg(feature = "ffmpeg_8_0")]
73    THREE_D_REFERENCE_DISPLAYS,
74    #[cfg(feature = "ffmpeg_8_0")]
75    RTCP_SR,
76
77    #[cfg(feature = "ffmpeg_8_1")]
78    EXIF,
79}
80
81impl From<AVPacketSideDataType> for Type {
82    fn from(value: AVPacketSideDataType) -> Self {
83        match value {
84            AV_PKT_DATA_PALETTE => Type::Palette,
85            AV_PKT_DATA_NEW_EXTRADATA => Type::NewExtraData,
86            AV_PKT_DATA_PARAM_CHANGE => Type::ParamChange,
87            AV_PKT_DATA_H263_MB_INFO => Type::H263MbInfo,
88            AV_PKT_DATA_REPLAYGAIN => Type::ReplayGain,
89            AV_PKT_DATA_DISPLAYMATRIX => Type::DisplayMatrix,
90            AV_PKT_DATA_STEREO3D => Type::Stereo3d,
91            AV_PKT_DATA_AUDIO_SERVICE_TYPE => Type::AudioServiceType,
92            AV_PKT_DATA_QUALITY_STATS => Type::QualityStats,
93            AV_PKT_DATA_FALLBACK_TRACK => Type::FallbackTrack,
94            AV_PKT_DATA_CPB_PROPERTIES => Type::CBPProperties,
95            AV_PKT_DATA_SKIP_SAMPLES => Type::SkipSamples,
96            AV_PKT_DATA_JP_DUALMONO => Type::JpDualMono,
97            AV_PKT_DATA_STRINGS_METADATA => Type::StringsMetadata,
98            AV_PKT_DATA_SUBTITLE_POSITION => Type::SubtitlePosition,
99            AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL => Type::MatroskaBlockAdditional,
100            AV_PKT_DATA_WEBVTT_IDENTIFIER => Type::WebVTTIdentifier,
101            AV_PKT_DATA_WEBVTT_SETTINGS => Type::WebVTTSettings,
102            AV_PKT_DATA_METADATA_UPDATE => Type::MetadataUpdate,
103            AV_PKT_DATA_MPEGTS_STREAM_ID => Type::MPEGTSStreamID,
104            AV_PKT_DATA_MASTERING_DISPLAY_METADATA => Type::MasteringDisplayMetadata,
105            AV_PKT_DATA_SPHERICAL => Type::DataSpherical,
106            AV_PKT_DATA_NB => Type::DataNb,
107
108            AV_PKT_DATA_CONTENT_LIGHT_LEVEL => Type::ContentLightLevel,
109            AV_PKT_DATA_A53_CC => Type::A53CC,
110
111            #[cfg(feature = "ffmpeg_4_0")]
112            AV_PKT_DATA_ENCRYPTION_INIT_INFO => Type::EncryptionInitInfo,
113            #[cfg(feature = "ffmpeg_4_0")]
114            AV_PKT_DATA_ENCRYPTION_INFO => Type::EncryptionInfo,
115
116            #[cfg(feature = "ffmpeg_4_1")]
117            AV_PKT_DATA_AFD => Type::AFD,
118
119            #[cfg(feature = "ffmpeg_4_3")]
120            AV_PKT_DATA_PRFT => Type::PRFT,
121            #[cfg(feature = "ffmpeg_4_3")]
122            AV_PKT_DATA_ICC_PROFILE => Type::ICC_PROFILE,
123            #[cfg(feature = "ffmpeg_4_3")]
124            AV_PKT_DATA_DOVI_CONF => Type::DOVI_CONF,
125
126            #[cfg(feature = "ffmpeg_4_4")]
127            AV_PKT_DATA_S12M_TIMECODE => Type::S12M_TIMECODE,
128
129            #[cfg(feature = "ffmpeg_5_0")]
130            AV_PKT_DATA_DYNAMIC_HDR10_PLUS => Type::DYNAMIC_HDR10_PLUS,
131
132            #[cfg(feature = "ffmpeg_7_0")]
133            AV_PKT_DATA_IAMF_MIX_GAIN_PARAM => Type::IAMF_MIX_GAIN_PARAM,
134            #[cfg(feature = "ffmpeg_7_0")]
135            AV_PKT_DATA_IAMF_DEMIXING_INFO_PARAM => Type::IAMF_DEMIXING_INFO_PARAM,
136            #[cfg(feature = "ffmpeg_7_0")]
137            AV_PKT_DATA_IAMF_RECON_GAIN_INFO_PARAM => Type::IAMF_RECON_GAIN_INFO_PARAM,
138            #[cfg(feature = "ffmpeg_7_0")]
139            AV_PKT_DATA_AMBIENT_VIEWING_ENVIRONMENT => Type::AMBIENT_VIEWING_ENVIRONMENT,
140
141            #[cfg(feature = "ffmpeg_7_1")]
142            AV_PKT_DATA_FRAME_CROPPING => Type::FRAME_CROPPING,
143            #[cfg(feature = "ffmpeg_7_1")]
144            AV_PKT_DATA_LCEVC => Type::LCEVC,
145
146            #[cfg(feature = "ffmpeg_8_0")]
147            AV_PKT_DATA_3D_REFERENCE_DISPLAYS => Type::THREE_D_REFERENCE_DISPLAYS,
148            #[cfg(feature = "ffmpeg_8_0")]
149            AV_PKT_DATA_RTCP_SR => Type::RTCP_SR,
150
151            #[cfg(feature = "ffmpeg_8_1")]
152            AV_PKT_DATA_EXIF => Type::EXIF,
153        }
154    }
155}
156
157impl From<Type> for AVPacketSideDataType {
158    fn from(value: Type) -> AVPacketSideDataType {
159        match value {
160            Type::Palette => AV_PKT_DATA_PALETTE,
161            Type::NewExtraData => AV_PKT_DATA_NEW_EXTRADATA,
162            Type::ParamChange => AV_PKT_DATA_PARAM_CHANGE,
163            Type::H263MbInfo => AV_PKT_DATA_H263_MB_INFO,
164            Type::ReplayGain => AV_PKT_DATA_REPLAYGAIN,
165            Type::DisplayMatrix => AV_PKT_DATA_DISPLAYMATRIX,
166            Type::Stereo3d => AV_PKT_DATA_STEREO3D,
167            Type::AudioServiceType => AV_PKT_DATA_AUDIO_SERVICE_TYPE,
168            Type::QualityStats => AV_PKT_DATA_QUALITY_STATS,
169            Type::FallbackTrack => AV_PKT_DATA_FALLBACK_TRACK,
170            Type::CBPProperties => AV_PKT_DATA_CPB_PROPERTIES,
171            Type::SkipSamples => AV_PKT_DATA_SKIP_SAMPLES,
172            Type::JpDualMono => AV_PKT_DATA_JP_DUALMONO,
173            Type::StringsMetadata => AV_PKT_DATA_STRINGS_METADATA,
174            Type::SubtitlePosition => AV_PKT_DATA_SUBTITLE_POSITION,
175            Type::MatroskaBlockAdditional => AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
176            Type::WebVTTIdentifier => AV_PKT_DATA_WEBVTT_IDENTIFIER,
177            Type::WebVTTSettings => AV_PKT_DATA_WEBVTT_SETTINGS,
178            Type::MetadataUpdate => AV_PKT_DATA_METADATA_UPDATE,
179            Type::MPEGTSStreamID => AV_PKT_DATA_MPEGTS_STREAM_ID,
180            Type::MasteringDisplayMetadata => AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
181            Type::DataSpherical => AV_PKT_DATA_SPHERICAL,
182            Type::DataNb => AV_PKT_DATA_NB,
183
184            Type::ContentLightLevel => AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
185            Type::A53CC => AV_PKT_DATA_A53_CC,
186
187            #[cfg(feature = "ffmpeg_4_0")]
188            Type::EncryptionInitInfo => AV_PKT_DATA_ENCRYPTION_INIT_INFO,
189            #[cfg(feature = "ffmpeg_4_0")]
190            Type::EncryptionInfo => AV_PKT_DATA_ENCRYPTION_INFO,
191
192            #[cfg(feature = "ffmpeg_4_1")]
193            Type::AFD => AV_PKT_DATA_AFD,
194
195            #[cfg(feature = "ffmpeg_4_3")]
196            Type::PRFT => AV_PKT_DATA_PRFT,
197            #[cfg(feature = "ffmpeg_4_3")]
198            Type::ICC_PROFILE => AV_PKT_DATA_ICC_PROFILE,
199            #[cfg(feature = "ffmpeg_4_3")]
200            Type::DOVI_CONF => AV_PKT_DATA_DOVI_CONF,
201
202            #[cfg(feature = "ffmpeg_4_4")]
203            Type::S12M_TIMECODE => AV_PKT_DATA_S12M_TIMECODE,
204
205            #[cfg(feature = "ffmpeg_5_0")]
206            Type::DYNAMIC_HDR10_PLUS => AV_PKT_DATA_DYNAMIC_HDR10_PLUS,
207
208            #[cfg(feature = "ffmpeg_7_0")]
209            Type::IAMF_MIX_GAIN_PARAM => AV_PKT_DATA_IAMF_MIX_GAIN_PARAM,
210            #[cfg(feature = "ffmpeg_7_0")]
211            Type::IAMF_DEMIXING_INFO_PARAM => AV_PKT_DATA_IAMF_DEMIXING_INFO_PARAM,
212            #[cfg(feature = "ffmpeg_7_0")]
213            Type::IAMF_RECON_GAIN_INFO_PARAM => AV_PKT_DATA_IAMF_RECON_GAIN_INFO_PARAM,
214            #[cfg(feature = "ffmpeg_7_0")]
215            Type::AMBIENT_VIEWING_ENVIRONMENT => AV_PKT_DATA_AMBIENT_VIEWING_ENVIRONMENT,
216
217            #[cfg(feature = "ffmpeg_7_1")]
218            Type::FRAME_CROPPING => AV_PKT_DATA_FRAME_CROPPING,
219            #[cfg(feature = "ffmpeg_7_1")]
220            Type::LCEVC => AV_PKT_DATA_LCEVC,
221
222            #[cfg(feature = "ffmpeg_8_0")]
223            Type::THREE_D_REFERENCE_DISPLAYS => AV_PKT_DATA_3D_REFERENCE_DISPLAYS,
224            #[cfg(feature = "ffmpeg_8_0")]
225            Type::RTCP_SR => AV_PKT_DATA_RTCP_SR,
226
227            #[cfg(feature = "ffmpeg_8_1")]
228            Type::EXIF => AV_PKT_DATA_EXIF,
229        }
230    }
231}
232
233pub struct SideData<'a> {
234    ptr: *mut AVPacketSideData,
235
236    _marker: PhantomData<&'a Packet>,
237}
238
239impl<'a> SideData<'a> {
240    pub unsafe fn wrap(ptr: *mut AVPacketSideData) -> Self {
241        SideData {
242            ptr,
243            _marker: PhantomData,
244        }
245    }
246
247    pub unsafe fn as_ptr(&self) -> *const AVPacketSideData {
248        self.ptr as *const _
249    }
250}
251
252impl<'a> SideData<'a> {
253    pub fn kind(&self) -> Type {
254        unsafe { Type::from((*self.as_ptr()).type_) }
255    }
256
257    pub fn data(&self) -> &[u8] {
258        #[allow(clippy::unnecessary_cast)]
259        unsafe {
260            slice::from_raw_parts((*self.as_ptr()).data, (*self.as_ptr()).size as usize)
261        }
262    }
263}
ffmpeg_next/codec/packet/side_data.rs

ffmpeg_next/codec/packet/
side_data.rs
