fix clippy warnings for update to rustc 1.46
[nihav.git] / nihav-registry / src / register.rs
CommitLineData
285f4c72
KS
1//! Global registry of codec information.
2//!
3//! This module contains codec information from technical level that allows user to retrieve information about codec type and features without creating and invoking a decoder for such codec.
d48ee414
KS
4use std::fmt;
5
285f4c72 6/// Codec types.
34829caa 7#[derive(Debug,Clone,Copy,PartialEq)]
d48ee414
KS
8#[allow(dead_code)]
9pub enum CodecType {
285f4c72 10 /// Video codec.
d48ee414 11 Video,
285f4c72 12 /// Audio codec.
d48ee414 13 Audio,
285f4c72 14 /// Subtitle codec.
d48ee414 15 Subtitles,
285f4c72 16 /// Some special codec (e.g. some event stream or separate timecodes stream).
d48ee414 17 Data,
285f4c72 18 /// Dummy codec.
d48ee414
KS
19 None,
20}
21
22impl fmt::Display for CodecType {
23 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
24 match *self {
25 CodecType::Video => write!(f, "Video"),
26 CodecType::Audio => write!(f, "Audio"),
27 CodecType::Subtitles => write!(f, "Subtitles"),
28 CodecType::Data => write!(f, "Data"),
29 CodecType::None => write!(f, "-"),
30 }
31 }
32}
33
2793026b
KS
34/// Codec capability flag for intra-only codecs.
35pub const CODEC_CAP_INTRAONLY:u32 = 0x0001;
36/// Codec capability flag for lossless codecs.
37pub const CODEC_CAP_LOSSLESS:u32 = 0x0002;
38/// Codec capability flag for codecs with frame reordering.
39pub const CODEC_CAP_REORDER:u32 = 0x0004;
40/// Codec capability flag for codecs that can be both lossy and lossless.
41pub const CODEC_CAP_HYBRID:u32 = 0x0008;
42/// Codec capability flag for codecs with scalability features.
43pub const CODEC_CAP_SCALABLE:u32 = 0x0010;
8480761d
KS
44/// Codec capability flag for codecs with complex frame reordering.
45pub const CODEC_CAP_COMPLEX_REORDER:u32 = 0x0020;
d48ee414 46
285f4c72 47/// Codec description structure.
34829caa 48#[derive(Clone)]
d48ee414 49pub struct CodecDescription {
285f4c72
KS
50 /// Short codec name.
51 ///
52 /// Short codec name is used inside NihAV as the unique identifier.
5641dccf 53 pub name: &'static str,
285f4c72 54 /// Full codec name.
5641dccf 55 pub fname: &'static str,
285f4c72 56 /// Codec type.
5641dccf 57 pub ctype: CodecType,
285f4c72 58 /// Codec capabilities.
5641dccf 59 pub caps: u32,
d48ee414
KS
60}
61
62impl CodecDescription {
285f4c72 63 /// Returns short codec name.
d48ee414 64 pub fn get_name(&self) -> &'static str { self.name }
285f4c72 65 /// Returns full codec name.
d48ee414 66 pub fn get_full_name(&self) -> &'static str { self.fname }
285f4c72 67 /// Returns codec type.
d48ee414 68 pub fn get_codec_type(&self) -> CodecType { self.ctype }
285f4c72 69 /// Reports whether the codec has only intra frames or not.
d48ee414 70 pub fn is_intraonly(&self) -> bool { (self.caps & CODEC_CAP_INTRAONLY) != 0 }
285f4c72 71 /// Reports whether the codec is lossless.
d48ee414 72 pub fn is_lossless(&self) -> bool { (self.caps & CODEC_CAP_LOSSLESS) != 0 }
285f4c72 73 /// Reports whether the codec requires frame reordering.
d48ee414 74 pub fn has_reorder(&self) -> bool { (self.caps & CODEC_CAP_REORDER) != 0 }
285f4c72 75 /// Reports whether the codec can be either lossless or lossy.
d48ee414 76 pub fn is_hybrid(&self) -> bool { (self.caps & CODEC_CAP_HYBRID) != 0 }
285f4c72
KS
77 /// Reports whether codec supports scalability.
78 ///
79 /// Scalability means that codec can be decoded in reduced resolution by design.
d48ee414
KS
80 pub fn is_scalable(&self) -> bool { (self.caps & CODEC_CAP_SCALABLE) != 0 }
81}
82
83impl fmt::Display for CodecDescription {
84 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
e243ceb4 85 let mut out = self.fname.to_string();
d48ee414
KS
86 if self.caps != 0 {
87 let mut capfmt = "".to_string();
88 if (self.caps & CODEC_CAP_INTRAONLY) != 0 {
89 capfmt = format!("{} Intra-only", capfmt);
90 }
91 if (self.caps & CODEC_CAP_LOSSLESS) != 0 {
92 capfmt = format!("{} Lossless", capfmt);
93 }
94 if (self.caps & CODEC_CAP_REORDER) != 0 {
95 capfmt = format!("{} Frame reorder", capfmt);
96 }
97 if (self.caps & CODEC_CAP_HYBRID) != 0 {
98 capfmt = format!("{} Can be lossy and lossless", capfmt);
99 }
100 if (self.caps & CODEC_CAP_SCALABLE) != 0 {
101 capfmt = format!("{} Scalable", capfmt);
102 }
103 out = format!("{} ({})", out, capfmt);
104 }
105 write!(f, "{}", out)
106 }
107}
108
109macro_rules! desc {
110 (video; $n:expr, $fn:expr) => ({
111 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
112 caps: 0 }
113 });
114 (video; $n:expr, $fn:expr, $c:expr) => ({
115 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
116 caps: $c }
117 });
118 (video-ll; $n:expr, $fn:expr) => ({
119 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
120 caps: CODEC_CAP_LOSSLESS | CODEC_CAP_INTRAONLY }
121 });
122 (video-llp; $n:expr, $fn:expr) => ({
123 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
124 caps: CODEC_CAP_LOSSLESS }
125 });
126 (video-im; $n:expr, $fn:expr) => ({
127 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
128 caps: CODEC_CAP_INTRAONLY }
129 });
130 (video-modern; $n:expr, $fn:expr) => ({
131 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
132 caps: CODEC_CAP_REORDER | CODEC_CAP_HYBRID }
133 });
134 (audio; $n:expr, $fn:expr) => ({
135 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Audio,
136 caps: 0 }
137 });
138 (audio-ll; $n:expr, $fn:expr) => ({
139 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Audio,
140 caps: CODEC_CAP_LOSSLESS | CODEC_CAP_INTRAONLY }
141 });
87927c57
KS
142 (audio-hyb; $n:expr, $fn:expr) => ({
143 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Audio,
144 caps: CODEC_CAP_HYBRID }
145 });
d48ee414
KS
146}
147
285f4c72 148/// Returns codec description for the provided codec short name if it is found.
d48ee414 149pub fn get_codec_description(name: &str) -> Option<&'static CodecDescription> {
34829caa
KS
150 for reg in CODEC_REGISTER {
151 if reg.name == name {
152 return Some(reg);
d48ee414
KS
153 }
154 }
155 None
156}
157
b7c882c1 158static CODEC_REGISTER: &[CodecDescription] = &[
e8e022f4 159 desc!(audio-ll; "pcm", "PCM"),
3d5fb08f
KS
160 desc!(audio; "alaw", "A-law PCM"),
161 desc!(audio; "ulaw", "mu-law PCM"),
e8e022f4 162
45e794c4
KS
163 desc!(video-im; "indeo1", "Intel Raw IF09"),
164 desc!(video-im; "indeo2", "Intel Indeo 2"),
165 desc!(video; "indeo3", "Intel Indeo 3"),
166 desc!(video; "indeo4", "Intel Indeo 4", CODEC_CAP_REORDER | CODEC_CAP_SCALABLE),
167 desc!(video; "indeo5", "Intel Indeo 5", CODEC_CAP_REORDER | CODEC_CAP_SCALABLE),
1a36a05d 168 desc!(video; "intel263", "Intel I263", CODEC_CAP_REORDER),
45e794c4
KS
169 desc!(audio; "iac", "Intel Indeo audio"),
170 desc!(audio; "imc", "Intel Music Coder"),
ce52b3b5
KS
171
172 desc!(video; "realvideo1", "Real Video 1"),
6b2cdc84 173 desc!(video; "realvideo2", "Real Video 2", CODEC_CAP_REORDER),
ce52b3b5
KS
174 desc!(video; "realvideo3", "Real Video 3", CODEC_CAP_REORDER),
175 desc!(video; "realvideo4", "Real Video 4", CODEC_CAP_REORDER),
0b791d5c 176 desc!(video; "realvideo6", "Real Video 6", CODEC_CAP_REORDER),
ce52b3b5 177 desc!(video; "clearvideo", "ClearVideo"),
750b299c 178 desc!(video; "clearvideo_rm", "ClearVideo"),
ce52b3b5
KS
179 desc!(audio; "ra14.4", "RealAudio 14.4"),
180 desc!(audio; "ra28.8", "RealAudio 28.8"),
181 desc!(audio; "cook", "RealAudio Cooker"),
182 desc!(audio; "ralf", "RealAudio Lossless"),
183 desc!(audio; "aac", "AAC"),
16dd4f44 184 desc!(audio; "ac3", "ETSI TS 102 366"),
ce52b3b5
KS
185 desc!(audio; "atrac3", "Sony Atrac3"),
186 desc!(audio; "sipro", "Sipro Labs ADPCM"),
e8e022f4 187
57777a0a
KS
188 desc!(video; "cinepak", "Cinepak"),
189
4abcd842 190 desc!(video; "msvideo1", "MS Video 1"),
03c406ea 191 desc!(video; "msrle", "MS RLE"),
4abcd842
KS
192 desc!(audio; "ms-adpcm", "MS ADPCM"),
193 desc!(audio; "ima-adpcm-ms", "IMA ADPCM (MS variant)"),
194
3d5fb08f
KS
195 desc!(video; "qt-smc", "Apple Graphics"),
196 desc!(video; "qt-rle", "Apple Animation"),
197 desc!(video; "apple-video", "Apple video"),
198 desc!(video; "sorenson-video", "Sorenson Video"),
8251c0ab 199 desc!(video; "sorenson-video3", "Sorenson Video 3", CODEC_CAP_REORDER),
3d5fb08f
KS
200 desc!(audio; "mace-3", "MACE 3:1"),
201 desc!(audio; "mace-6", "MACE 6:1"),
202 desc!(audio; "ima-adpcm-qt", "IMA ADPCM (Apple variant)"),
203 desc!(audio; "qdesign-music", "QDesign Music"),
204 desc!(audio; "qdesign-music2", "QDesign Music v2"),
205 desc!(audio; "qualcomm-purevoice", "Qualcomm PureVoice"),
206
d24468d9
KS
207 desc!(video; "truemotion1", "TrueMotion 1"),
208 desc!(video-im; "truemotionrt", "TrueMotion RT"),
209 desc!(video; "truemotion2", "TrueMotion 2"),
e8e022f4
KS
210 desc!(video; "truemotion2x", "TrueMotion 2X"),
211 desc!(video; "vp3", "VP3"),
212 desc!(video; "vp4", "VP4"),
213 desc!(video; "vp5", "VP5"),
214 desc!(video; "vp6", "VP6"),
629a1025 215 desc!(video; "vp6a", "VP6"),
e8e022f4
KS
216 desc!(video; "vp7", "VP7"),
217 desc!(video; "vp8", "VP8"),
218 desc!(video; "vp9", "VP9"),
219 desc!(audio; "adpcm-dk3", "Duck DK3 ADPCM"),
220 desc!(audio; "adpcm-dk4", "Duck DK4 ADPCM"),
629a1025
KS
221 desc!(audio; "on2avc-500", "On2 AVC"),
222 desc!(audio; "on2avc-501", "On2 AVC"),
e8e022f4
KS
223
224 desc!(video; "gdv-video", "Gremlin Digital Video - video"),
225 desc!(audio; "gdv-audio", "Gremlin Digital Video - audio"),
226 desc!(video; "bmv-video", "BMV video"),
227 desc!(audio; "bmv-audio", "BMV audio"),
ecda1cc1
KS
228 desc!(video; "bmv3-video", "DW Noir BMV video"),
229 desc!(audio; "bmv3-audio", "DW Noir BMV audio"),
3813fe8a 230 desc!(video; "fable-imax", "Fable IMAX video"),
8d91d85f
KS
231 desc!(video; "fst-video", "FutureVision video"),
232 desc!(audio; "fst-audio", "FutureVision audio"),
801bba83
KS
233 desc!(video; "midivid", "MidiVid"),
234 desc!(video; "midivid3", "MidiVid 3"),
235 desc!(video-ll; "midivid-ll", "MidiVid Lossless"),
9895bd7b
KS
236 desc!(video; "vmd-video", "VMD video"),
237 desc!(audio; "vmd-audio", "VMD audio"),
55d85231
KS
238 desc!(video; "vxvideo", "Actimagine Vx"),
239 desc!(audio; "vxaudio", "Actimagine Sx"),
e8e022f4
KS
240
241 desc!(video; "smacker-video", "Smacker video"),
242 desc!(audio; "smacker-audio", "Smacker audio"),
243 desc!(video; "bink-video", "Bink video"),
244 desc!(video; "bink2-video", "Bink2 video"),
245 desc!(audio; "bink-audio-dct", "Bink audio (DCT)"),
246 desc!(audio; "bink-audio-rdft", "Bink audio (RDFT)"),
ed374345
KS
247
248 desc!(audio; "lhst15f8", "L&H StreamTalk 15kbps at 8 kHz"),
249 desc!(audio; "lhst250f11", "L&H StreamTalk 25kbps at 11 kHz"),
250 desc!(audio; "lhst500f22", "L&H StreamTalk 50kpbs at 22 kHz"),
251 desc!(audio; "lhst48", "L&H StreamTalk CELP Codec 4.8kbps at 8 kHz"),
31cf33ac
KS
252
253 desc!(video; "vivo1", "VivoActive Video 1.0"),
254 desc!(video; "vivo2", "VivoActive Video 2.0", CODEC_CAP_REORDER),
255 desc!(audio; "g723.1", "ITU G.723.1"),
256 desc!(audio; "siren", "Polycom Siren"),
87927c57
KS
257
258 desc!(audio-ll; "ape", "Monkey's Audio"),
259 desc!(audio-ll; "flac", "Free Lossless Audio Codec"),
260 desc!(audio-ll; "tta", "True Audio codec"),
261 desc!(audio-hyb; "wavpack", "WavPack"),
696e4e20
KS
262
263 desc!(video; "h264", "ITU H.264", CODEC_CAP_COMPLEX_REORDER | CODEC_CAP_HYBRID),
d48ee414
KS
264];
265
b7c882c1 266static AVI_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
423005dc
KS
267 (&[1, 0, 0, 0], "msrle"),
268 (&[2, 0, 0, 0], "msrle"),
269
4abcd842
KS
270 (b"CRAM", "msvideo1"),
271 (b"MSVC", "msvideo1"),
272 (b"WHAM", "msvideo1"),
273
45e794c4
KS
274 (b"IF09", "indeo1"),
275 (b"RT21", "indeo2"),
276 (b"IV31", "indeo3"),
277 (b"IV32", "indeo3"),
278 (b"IV41", "indeo4"),
279 (b"IV50", "indeo5"),
836bf150 280 (b"I263", "intel263"),
ce52b3b5 281
750b299c 282 (b"UCOD", "clearvideo"),
57777a0a 283 (b"cvid", "cinepak"),
b2d656d0 284
801bba83
KS
285 (b"MVDV", "midivid"),
286 (b"MV30", "midivid3"),
287 (b"MVLZ", "midivid-ll"),
288
b2d656d0
KS
289 (b"DUCK", "truemotion1"),
290 (b"TR20", "truemotionrt"),
291 (b"TM20", "truemotion2"),
292 (b"TM2A", "truemotion2x"),
293 (b"TM2X", "truemotion2x"),
40e95291
KS
294 (b"VP30", "vp3"),
295 (b"VP31", "vp3"),
296 (b"VP40", "vp4"),
297 (b"VP50", "vp5"),
298 (b"VP60", "vp6"),
299 (b"VP61", "vp6"),
300 (b"VP62", "vp6"),
1bf8e0fc 301 (b"VP6A", "vp6a"),
40e95291 302 (b"VP70", "vp7"),
d48ee414
KS
303];
304
b7c882c1 305static WAV_CODEC_REGISTER: &[(u16, &str)] = &[
9d9c811b 306 (0x0000, "unknown"),
45e794c4 307 (0x0001, "pcm"),
4abcd842 308 (0x0002, "ms-adpcm"),
45e794c4 309 (0x0003, "pcm"),
4abcd842 310 (0x0011, "ima-adpcm-ms"),
fadee95f
KS
311 (0x0061, "adpcm-dk4"),
312 (0x0062, "adpcm-dk3"),
45e794c4
KS
313 (0x0401, "imc"),
314 (0x0402, "iac"),
a38be6e4
KS
315 (0x0500, "on2avc-500"),
316 (0x0501, "on2avc-501"),
d48ee414
KS
317];
318
b7c882c1 319static MOV_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
646f4c43
KS
320 (b"cvid", "cinepak"),
321 (b"jpeg", "jpeg"),
322 //(b"raw ", "raw"),
323 //(b"Yuv2", "raw"),
324 (b"smc ", "qt-smc"),
325 (b"rle ", "qt-rle"),
326 (b"rpza", "apple-video"),
327 (b"kpcd", "kodak-photocd"),
328 //(b"mpeg", "mpeg-video"),
329 (b"mjpa", "mjpeg-a"),
330 (b"mjpb", "mjpeg-b"),
331 (b"svqi", "sorenson-video"),
b2689495 332 (b"SVQ1", "sorenson-video"),
3d5fb08f 333 (b"svq3", "sorenson-video3"),
b2689495 334 (b"SVQ3", "sorenson-video3"),
646f4c43
KS
335
336 (b"IV31", "indeo3"),
337 (b"IV32", "indeo3"),
338
339 (b"UCOD", "clearvideo"),
340
341 (b"VP30", "vp3"),
342 (b"VP31", "vp3"),
696e4e20
KS
343
344 (b"avc1", "h264"),
646f4c43
KS
345];
346
b7c882c1 347static MOV_AUDIO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
646f4c43
KS
348 (b"NONE", "pcm"),
349 (b"raw ", "pcm"),
350 (b"twos", "pcm"),
351 (b"sowt", "pcm"),
352 (b"fl32", "pcm"),
353 (b"fl64", "pcm"),
354 (b"in24", "pcm"),
355 (b"in32", "pcm"),
356 (b"MAC3", "mace-3"),
357 (b"MAC6", "mace-6"),
358 (b"ima4", "ima-adpcm-qt"),
359 (b"ulaw", "ulaw"),
360 (b"alaw", "alaw"),
361 (b"dvca", "dv-audio"),
362 (b"QDMC", "qdesign-music"),
363 (b"QDM2", "qdesign-music2"),
364 (b"Qclp", "qualcomm-purevoice"),
365 //(b".mp3", "mpeg-layer3"),
12881f89
KS
366
367 (b"mp4a", "aac"),
646f4c43
KS
368];
369
285f4c72 370/// Returns video codec short name for provided FOURCC (used in AVI format).
d48ee414 371pub fn find_codec_from_avi_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
e243ceb4
KS
372 for (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
373 if *fourcc == fcc { return Some(name); }
d48ee414
KS
374 }
375 None
376}
377
9a3ce86c
KS
378/// Returns FOURCC (used in AVI format) for provided codec name.
379pub fn find_avi_fourcc(codecname: &str) -> Option<[u8; 4]> {
380 for (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
381 if *name == codecname { return Some(**fourcc); }
382 }
383 None
384}
385
285f4c72 386/// Returns known audio codec short name for provided TWOCC (used in WAV and AVI format).
d48ee414 387pub fn find_codec_from_wav_twocc(tcc: u16) -> Option<&'static str> {
e243ceb4
KS
388 for (twocc, name) in WAV_CODEC_REGISTER.iter() {
389 if *twocc == tcc { return Some(name); }
d48ee414
KS
390 }
391 None
392}
393
9a3ce86c
KS
394/// Returns TWOCC (used in WAV and AVI format for provided codec name.
395pub fn find_wav_twocc(codecname: &str) -> Option<u16> {
396 for (twocc, name) in WAV_CODEC_REGISTER.iter() {
397 if *name == codecname { return Some(*twocc); }
398 }
399 None
400}
401
646f4c43
KS
402/// Returns video codec short name for provided FOURCC (used in MOV format).
403pub fn find_codec_from_mov_video_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
404 for (fourcc, name) in MOV_VIDEO_CODEC_REGISTER.iter() {
405 if *fourcc == fcc { return Some(name); }
406 }
407 None
408}
409
410/// Returns known audio codec short name for provided FOURCC (used in MOV format).
411pub fn find_codec_from_mov_audio_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
412 for (fourcc, name) in MOV_AUDIO_CODEC_REGISTER.iter() {
413 if *fourcc == fcc { return Some(name); }
414 }
415 None
416}
417
d48ee414
KS
418#[cfg(test)]
419mod test {
420 use super::*;
421
422 #[test]
423 fn test_register() {
424 let c1 = find_codec_from_avi_fourcc(b"IV41").unwrap();
425 let c2 = find_codec_from_wav_twocc(0x401).unwrap();
426 println!("found {} and {}", c1, c2);
427 let cd1 = get_codec_description(c1).unwrap();
428 let cd2 = get_codec_description(c2).unwrap();
429 println!("got {} and {}", cd1, cd2);
430 }
b58d7656 431}