ffmpeg_next/codec/packet/
side_data.rs1use 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
78impl From<AVPacketSideDataType> for Type {
79 fn from(value: AVPacketSideDataType) -> Self {
80 match value {
81 AV_PKT_DATA_PALETTE => Type::Palette,
82 AV_PKT_DATA_NEW_EXTRADATA => Type::NewExtraData,
83 AV_PKT_DATA_PARAM_CHANGE => Type::ParamChange,
84 AV_PKT_DATA_H263_MB_INFO => Type::H263MbInfo,
85 AV_PKT_DATA_REPLAYGAIN => Type::ReplayGain,
86 AV_PKT_DATA_DISPLAYMATRIX => Type::DisplayMatrix,
87 AV_PKT_DATA_STEREO3D => Type::Stereo3d,
88 AV_PKT_DATA_AUDIO_SERVICE_TYPE => Type::AudioServiceType,
89 AV_PKT_DATA_QUALITY_STATS => Type::QualityStats,
90 AV_PKT_DATA_FALLBACK_TRACK => Type::FallbackTrack,
91 AV_PKT_DATA_CPB_PROPERTIES => Type::CBPProperties,
92 AV_PKT_DATA_SKIP_SAMPLES => Type::SkipSamples,
93 AV_PKT_DATA_JP_DUALMONO => Type::JpDualMono,
94 AV_PKT_DATA_STRINGS_METADATA => Type::StringsMetadata,
95 AV_PKT_DATA_SUBTITLE_POSITION => Type::SubtitlePosition,
96 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL => Type::MatroskaBlockAdditional,
97 AV_PKT_DATA_WEBVTT_IDENTIFIER => Type::WebVTTIdentifier,
98 AV_PKT_DATA_WEBVTT_SETTINGS => Type::WebVTTSettings,
99 AV_PKT_DATA_METADATA_UPDATE => Type::MetadataUpdate,
100 AV_PKT_DATA_MPEGTS_STREAM_ID => Type::MPEGTSStreamID,
101 AV_PKT_DATA_MASTERING_DISPLAY_METADATA => Type::MasteringDisplayMetadata,
102 AV_PKT_DATA_SPHERICAL => Type::DataSpherical,
103 AV_PKT_DATA_NB => Type::DataNb,
104
105 AV_PKT_DATA_CONTENT_LIGHT_LEVEL => Type::ContentLightLevel,
106 AV_PKT_DATA_A53_CC => Type::A53CC,
107
108 #[cfg(feature = "ffmpeg_4_0")]
109 AV_PKT_DATA_ENCRYPTION_INIT_INFO => Type::EncryptionInitInfo,
110 #[cfg(feature = "ffmpeg_4_0")]
111 AV_PKT_DATA_ENCRYPTION_INFO => Type::EncryptionInfo,
112
113 #[cfg(feature = "ffmpeg_4_1")]
114 AV_PKT_DATA_AFD => Type::AFD,
115
116 #[cfg(feature = "ffmpeg_4_3")]
117 AV_PKT_DATA_PRFT => Type::PRFT,
118 #[cfg(feature = "ffmpeg_4_3")]
119 AV_PKT_DATA_ICC_PROFILE => Type::ICC_PROFILE,
120 #[cfg(feature = "ffmpeg_4_3")]
121 AV_PKT_DATA_DOVI_CONF => Type::DOVI_CONF,
122
123 #[cfg(feature = "ffmpeg_4_4")]
124 AV_PKT_DATA_S12M_TIMECODE => Type::S12M_TIMECODE,
125
126 #[cfg(feature = "ffmpeg_5_0")]
127 AV_PKT_DATA_DYNAMIC_HDR10_PLUS => Type::DYNAMIC_HDR10_PLUS,
128
129 #[cfg(feature = "ffmpeg_7_0")]
130 AV_PKT_DATA_IAMF_MIX_GAIN_PARAM => Type::IAMF_MIX_GAIN_PARAM,
131 #[cfg(feature = "ffmpeg_7_0")]
132 AV_PKT_DATA_IAMF_DEMIXING_INFO_PARAM => Type::IAMF_DEMIXING_INFO_PARAM,
133 #[cfg(feature = "ffmpeg_7_0")]
134 AV_PKT_DATA_IAMF_RECON_GAIN_INFO_PARAM => Type::IAMF_RECON_GAIN_INFO_PARAM,
135 #[cfg(feature = "ffmpeg_7_0")]
136 AV_PKT_DATA_AMBIENT_VIEWING_ENVIRONMENT => Type::AMBIENT_VIEWING_ENVIRONMENT,
137
138 #[cfg(feature = "ffmpeg_7_1")]
139 AV_PKT_DATA_FRAME_CROPPING => Type::FRAME_CROPPING,
140 #[cfg(feature = "ffmpeg_7_1")]
141 AV_PKT_DATA_LCEVC => Type::LCEVC,
142
143 #[cfg(feature = "ffmpeg_8_0")]
144 AV_PKT_DATA_3D_REFERENCE_DISPLAYS => Type::THREE_D_REFERENCE_DISPLAYS,
145 #[cfg(feature = "ffmpeg_8_0")]
146 AV_PKT_DATA_RTCP_SR => Type::RTCP_SR,
147 }
148 }
149}
150
151impl From<Type> for AVPacketSideDataType {
152 fn from(value: Type) -> AVPacketSideDataType {
153 match value {
154 Type::Palette => AV_PKT_DATA_PALETTE,
155 Type::NewExtraData => AV_PKT_DATA_NEW_EXTRADATA,
156 Type::ParamChange => AV_PKT_DATA_PARAM_CHANGE,
157 Type::H263MbInfo => AV_PKT_DATA_H263_MB_INFO,
158 Type::ReplayGain => AV_PKT_DATA_REPLAYGAIN,
159 Type::DisplayMatrix => AV_PKT_DATA_DISPLAYMATRIX,
160 Type::Stereo3d => AV_PKT_DATA_STEREO3D,
161 Type::AudioServiceType => AV_PKT_DATA_AUDIO_SERVICE_TYPE,
162 Type::QualityStats => AV_PKT_DATA_QUALITY_STATS,
163 Type::FallbackTrack => AV_PKT_DATA_FALLBACK_TRACK,
164 Type::CBPProperties => AV_PKT_DATA_CPB_PROPERTIES,
165 Type::SkipSamples => AV_PKT_DATA_SKIP_SAMPLES,
166 Type::JpDualMono => AV_PKT_DATA_JP_DUALMONO,
167 Type::StringsMetadata => AV_PKT_DATA_STRINGS_METADATA,
168 Type::SubtitlePosition => AV_PKT_DATA_SUBTITLE_POSITION,
169 Type::MatroskaBlockAdditional => AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
170 Type::WebVTTIdentifier => AV_PKT_DATA_WEBVTT_IDENTIFIER,
171 Type::WebVTTSettings => AV_PKT_DATA_WEBVTT_SETTINGS,
172 Type::MetadataUpdate => AV_PKT_DATA_METADATA_UPDATE,
173 Type::MPEGTSStreamID => AV_PKT_DATA_MPEGTS_STREAM_ID,
174 Type::MasteringDisplayMetadata => AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
175 Type::DataSpherical => AV_PKT_DATA_SPHERICAL,
176 Type::DataNb => AV_PKT_DATA_NB,
177
178 Type::ContentLightLevel => AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
179 Type::A53CC => AV_PKT_DATA_A53_CC,
180
181 #[cfg(feature = "ffmpeg_4_0")]
182 Type::EncryptionInitInfo => AV_PKT_DATA_ENCRYPTION_INIT_INFO,
183 #[cfg(feature = "ffmpeg_4_0")]
184 Type::EncryptionInfo => AV_PKT_DATA_ENCRYPTION_INFO,
185
186 #[cfg(feature = "ffmpeg_4_1")]
187 Type::AFD => AV_PKT_DATA_AFD,
188
189 #[cfg(feature = "ffmpeg_4_3")]
190 Type::PRFT => AV_PKT_DATA_PRFT,
191 #[cfg(feature = "ffmpeg_4_3")]
192 Type::ICC_PROFILE => AV_PKT_DATA_ICC_PROFILE,
193 #[cfg(feature = "ffmpeg_4_3")]
194 Type::DOVI_CONF => AV_PKT_DATA_DOVI_CONF,
195
196 #[cfg(feature = "ffmpeg_4_4")]
197 Type::S12M_TIMECODE => AV_PKT_DATA_S12M_TIMECODE,
198
199 #[cfg(feature = "ffmpeg_5_0")]
200 Type::DYNAMIC_HDR10_PLUS => AV_PKT_DATA_DYNAMIC_HDR10_PLUS,
201
202 #[cfg(feature = "ffmpeg_7_0")]
203 Type::IAMF_MIX_GAIN_PARAM => AV_PKT_DATA_IAMF_MIX_GAIN_PARAM,
204 #[cfg(feature = "ffmpeg_7_0")]
205 Type::IAMF_DEMIXING_INFO_PARAM => AV_PKT_DATA_IAMF_DEMIXING_INFO_PARAM,
206 #[cfg(feature = "ffmpeg_7_0")]
207 Type::IAMF_RECON_GAIN_INFO_PARAM => AV_PKT_DATA_IAMF_RECON_GAIN_INFO_PARAM,
208 #[cfg(feature = "ffmpeg_7_0")]
209 Type::AMBIENT_VIEWING_ENVIRONMENT => AV_PKT_DATA_AMBIENT_VIEWING_ENVIRONMENT,
210
211 #[cfg(feature = "ffmpeg_7_1")]
212 Type::FRAME_CROPPING => AV_PKT_DATA_FRAME_CROPPING,
213 #[cfg(feature = "ffmpeg_7_1")]
214 Type::LCEVC => AV_PKT_DATA_LCEVC,
215
216 #[cfg(feature = "ffmpeg_8_0")]
217 Type::THREE_D_REFERENCE_DISPLAYS => AV_PKT_DATA_3D_REFERENCE_DISPLAYS,
218 #[cfg(feature = "ffmpeg_8_0")]
219 Type::RTCP_SR => AV_PKT_DATA_RTCP_SR,
220 }
221 }
222}
223
224pub struct SideData<'a> {
225 ptr: *mut AVPacketSideData,
226
227 _marker: PhantomData<&'a Packet>,
228}
229
230impl<'a> SideData<'a> {
231 pub unsafe fn wrap(ptr: *mut AVPacketSideData) -> Self {
232 SideData {
233 ptr,
234 _marker: PhantomData,
235 }
236 }
237
238 pub unsafe fn as_ptr(&self) -> *const AVPacketSideData {
239 self.ptr as *const _
240 }
241}
242
243impl<'a> SideData<'a> {
244 pub fn kind(&self) -> Type {
245 unsafe { Type::from((*self.as_ptr()).type_) }
246 }
247
248 pub fn data(&self) -> &[u8] {
249 #[allow(clippy::unnecessary_cast)]
250 unsafe {
251 slice::from_raw_parts((*self.as_ptr()).data, (*self.as_ptr()).size as usize)
252 }
253 }
254}