1 //! Global registry of codec information.
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.
7 #[derive(Debug,Clone,Copy,PartialEq)]
16 /// Some special codec (e.g. some event stream or separate timecodes stream).
22 impl fmt::Display for CodecType {
23 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
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, "-"),
34 /// Codec capability flag for intra-only codecs.
35 pub const CODEC_CAP_INTRAONLY:u32 = 0x0001;
36 /// Codec capability flag for lossless codecs.
37 pub const CODEC_CAP_LOSSLESS:u32 = 0x0002;
38 /// Codec capability flag for codecs with frame reordering.
39 pub const CODEC_CAP_REORDER:u32 = 0x0004;
40 /// Codec capability flag for codecs that can be both lossy and lossless.
41 pub const CODEC_CAP_HYBRID:u32 = 0x0008;
42 /// Codec capability flag for codecs with scalability features.
43 pub const CODEC_CAP_SCALABLE:u32 = 0x0010;
44 /// Codec capability flag for codecs with complex frame reordering.
45 pub const CODEC_CAP_COMPLEX_REORDER:u32 = 0x0020;
47 /// Codec description structure.
49 pub struct CodecDescription {
52 /// Short codec name is used inside NihAV as the unique identifier.
53 pub name: &'static str,
55 pub fname: &'static str,
58 /// Codec capabilities.
62 impl CodecDescription {
63 /// Returns short codec name.
64 pub fn get_name(&self) -> &'static str { self.name }
65 /// Returns full codec name.
66 pub fn get_full_name(&self) -> &'static str { self.fname }
67 /// Returns codec type.
68 pub fn get_codec_type(&self) -> CodecType { self.ctype }
69 /// Reports whether the codec has only intra frames or not.
70 pub fn is_intraonly(&self) -> bool { (self.caps & CODEC_CAP_INTRAONLY) != 0 }
71 /// Reports whether the codec is lossless.
72 pub fn is_lossless(&self) -> bool { (self.caps & CODEC_CAP_LOSSLESS) != 0 }
73 /// Reports whether the codec requires frame reordering.
74 pub fn has_reorder(&self) -> bool { (self.caps & CODEC_CAP_REORDER) != 0 }
75 /// Reports whether the codec can be either lossless or lossy.
76 pub fn is_hybrid(&self) -> bool { (self.caps & CODEC_CAP_HYBRID) != 0 }
77 /// Reports whether codec supports scalability.
79 /// Scalability means that codec can be decoded in reduced resolution by design.
80 pub fn is_scalable(&self) -> bool { (self.caps & CODEC_CAP_SCALABLE) != 0 }
83 impl fmt::Display for CodecDescription {
84 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
85 let mut out = self.fname.to_string();
87 let mut capfmt = "".to_string();
88 if (self.caps & CODEC_CAP_INTRAONLY) != 0 {
89 capfmt = format!("{} Intra-only", capfmt);
91 if (self.caps & CODEC_CAP_LOSSLESS) != 0 {
92 capfmt = format!("{} Lossless", capfmt);
94 if (self.caps & CODEC_CAP_REORDER) != 0 {
95 capfmt = format!("{} Frame reorder", capfmt);
97 if (self.caps & CODEC_CAP_HYBRID) != 0 {
98 capfmt = format!("{} Can be lossy and lossless", capfmt);
100 if (self.caps & CODEC_CAP_SCALABLE) != 0 {
101 capfmt = format!("{} Scalable", capfmt);
103 out = format!("{} ({})", out, capfmt);
110 (video; $n:expr, $fn:expr) => ({
111 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
114 (video; $n:expr, $fn:expr, $c:expr) => ({
115 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
118 (video-ll; $n:expr, $fn:expr) => ({
119 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
120 caps: CODEC_CAP_LOSSLESS | CODEC_CAP_INTRAONLY }
122 (video-llp; $n:expr, $fn:expr) => ({
123 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
124 caps: CODEC_CAP_LOSSLESS }
126 (video-im; $n:expr, $fn:expr) => ({
127 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
128 caps: CODEC_CAP_INTRAONLY }
130 (video-modern; $n:expr, $fn:expr) => ({
131 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
132 caps: CODEC_CAP_REORDER | CODEC_CAP_HYBRID }
134 (audio; $n:expr, $fn:expr) => ({
135 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Audio,
138 (audio-ll; $n:expr, $fn:expr) => ({
139 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Audio,
140 caps: CODEC_CAP_LOSSLESS | CODEC_CAP_INTRAONLY }
142 (audio-hyb; $n:expr, $fn:expr) => ({
143 CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Audio,
144 caps: CODEC_CAP_HYBRID }
148 /// Returns codec description for the provided codec short name if it is found.
149 pub fn get_codec_description(name: &str) -> Option<&'static CodecDescription> {
150 for reg in CODEC_REGISTER {
151 if reg.name == name {
158 static CODEC_REGISTER: &[CodecDescription] = &[
159 desc!(audio-ll; "pcm", "PCM"),
160 desc!(audio; "alaw", "A-law PCM"),
161 desc!(audio; "ulaw", "mu-law PCM"),
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),
168 desc!(video; "intel263", "Intel I263", CODEC_CAP_REORDER),
169 desc!(audio; "iac", "Intel Indeo audio"),
170 desc!(audio; "imc", "Intel Music Coder"),
172 desc!(video; "realvideo1", "Real Video 1"),
173 desc!(video; "realvideo2", "Real Video 2", CODEC_CAP_REORDER),
174 desc!(video; "realvideo3", "Real Video 3", CODEC_CAP_REORDER),
175 desc!(video; "realvideo4", "Real Video 4", CODEC_CAP_REORDER),
176 desc!(video; "realvideo6", "Real Video 6", CODEC_CAP_REORDER),
177 desc!(video; "clearvideo", "ClearVideo"),
178 desc!(video; "clearvideo_rm", "ClearVideo"),
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"),
184 desc!(audio; "ac3", "ETSI TS 102 366"),
185 desc!(audio; "atrac3", "Sony Atrac3"),
186 desc!(audio; "sipro", "Sipro Labs ADPCM"),
189 desc!(video-ll; "rawvideo", "Raw video data"),
190 desc!(video-ll; "rawvideo-ms", "Raw video data"),
192 desc!(video; "cinepak", "Cinepak"),
194 desc!(video-llp; "zmbv", "Zip Motion Blocks Video"),
196 desc!(video; "msvideo1", "MS Video 1"),
197 desc!(video; "msrle", "MS RLE"),
198 desc!(audio; "ms-adpcm", "MS ADPCM"),
199 desc!(audio; "ima-adpcm-ms", "IMA ADPCM (MS variant)"),
201 desc!(video; "qt-smc", "Apple Graphics"),
202 desc!(video; "qt-rle", "Apple Animation"),
203 desc!(video; "apple-video", "Apple video"),
204 desc!(video; "sorenson-video", "Sorenson Video"),
205 desc!(video; "sorenson-video3", "Sorenson Video 3", CODEC_CAP_REORDER),
206 desc!(audio-ll; "alac", "Apple Lossless Audio Codec"),
207 desc!(audio; "mace-3", "MACE 3:1"),
208 desc!(audio; "mace-6", "MACE 6:1"),
209 desc!(audio; "ima-adpcm-qt", "IMA ADPCM (Apple variant)"),
210 desc!(audio; "qdesign-music", "QDesign Music"),
211 desc!(audio; "qdesign-music2", "QDesign Music v2"),
212 desc!(audio; "qualcomm-purevoice", "Qualcomm PureVoice"),
214 desc!(video; "truemotion1", "TrueMotion 1"),
215 desc!(video-im; "truemotionrt", "TrueMotion RT"),
216 desc!(video; "truemotion2", "TrueMotion 2"),
217 desc!(video; "truemotion2x", "TrueMotion 2X"),
218 desc!(video; "vp3", "VP3"),
219 desc!(video; "vp4", "VP4"),
220 desc!(video; "vp5", "VP5"),
221 desc!(video; "vp6", "VP6"),
222 desc!(video; "vp6f", "VP6 (in Flash)"),
223 desc!(video; "vp6a", "VP6 with alpha"),
224 desc!(video; "vp7", "VP7"),
225 desc!(video; "vp8", "VP8"),
226 desc!(video; "vp9", "VP9"),
227 desc!(audio; "adpcm-dk3", "Duck DK3 ADPCM"),
228 desc!(audio; "adpcm-dk4", "Duck DK4 ADPCM"),
229 desc!(audio; "on2avc-500", "On2 AVC"),
230 desc!(audio; "on2avc-501", "On2 AVC"),
232 desc!(video; "flv263", "Sorenson H.263"),
233 desc!(video-llp; "flashsv", "Flash Screen Video"),
234 desc!(video-llp; "flashsv2", "Flash Screen Video 2"),
235 desc!(audio; "asao", "N*llym*s*r ASAO"),
236 desc!(audio; "flv-adpcm", "Flash ADPCM"),
238 desc!(audio; "mp1", "MPEG Audio Layer I"),
239 desc!(audio; "mp2", "MPEG Audio Layer II"),
240 desc!(audio; "mp3", "MPEG Audio Layer III"),
241 desc!(audio; "speex", "Speex"),
243 desc!(video; "gdv-video", "Gremlin Digital Video - video"),
244 desc!(audio; "gdv-audio", "Gremlin Digital Video - audio"),
245 desc!(video; "bmv-video", "BMV video"),
246 desc!(audio; "bmv-audio", "BMV audio"),
247 desc!(video; "bmv3-video", "DW Noir BMV video"),
248 desc!(audio; "bmv3-audio", "DW Noir BMV audio"),
249 desc!(video; "fable-imax", "Fable IMAX video"),
250 desc!(video; "fst-video", "FutureVision video"),
251 desc!(audio; "fst-audio", "FutureVision audio"),
252 desc!(video-llp; "ipma", "Imagination Pilots Matte Animation"),
253 desc!(video-llp; "ipma2", "Imagination Pilots Matte Animation v2"),
254 desc!(video; "legend-q-video", "Legend Entertainment Q video"),
255 desc!(video; "midivid", "MidiVid"),
256 desc!(video; "midivid3", "MidiVid 3"),
257 desc!(video-ll; "midivid-ll", "MidiVid Lossless"),
258 desc!(video; "smushv1", "SMUSH Video paletted"),
259 desc!(video; "smushv2", "SMUSH Video 16-bit"),
260 desc!(video; "smush-iact", "SMUSH IACT Audio"),
261 desc!(video; "smush-vima", "SMUSH VIMA Audio"),
262 desc!(video; "vmd-video", "VMD video"),
263 desc!(audio; "vmd-audio", "VMD audio"),
264 desc!(video; "vxvideo", "Actimagine Vx"),
265 desc!(audio; "vxaudio", "Actimagine Sx"),
267 desc!(video; "smacker-video", "Smacker video"),
268 desc!(audio; "smacker-audio", "Smacker audio"),
269 desc!(video; "bink-video", "Bink video"),
270 desc!(video; "bink2-video", "Bink2 video"),
271 desc!(audio; "bink-audio-dct", "Bink audio (DCT)"),
272 desc!(audio; "bink-audio-rdft", "Bink audio (RDFT)"),
274 desc!(audio; "lhst15f8", "L&H StreamTalk 15kbps at 8 kHz"),
275 desc!(audio; "lhst250f11", "L&H StreamTalk 25kbps at 11 kHz"),
276 desc!(audio; "lhst500f22", "L&H StreamTalk 50kpbs at 22 kHz"),
277 desc!(audio; "lhst48", "L&H StreamTalk CELP Codec 4.8kbps at 8 kHz"),
279 desc!(video; "vivo1", "VivoActive Video 1.0"),
280 desc!(video; "vivo2", "VivoActive Video 2.0", CODEC_CAP_REORDER),
281 desc!(audio; "g723.1", "ITU G.723.1"),
282 desc!(audio; "siren", "Polycom Siren"),
284 desc!(audio-ll; "ape", "Monkey's Audio"),
285 desc!(audio-ll; "flac", "Free Lossless Audio Codec"),
286 desc!(audio-ll; "tta", "True Audio codec"),
287 desc!(audio-hyb; "wavpack", "WavPack"),
289 desc!(video-im; "jpeg", "JPEG"),
290 desc!(video; "h264", "ITU H.264", CODEC_CAP_COMPLEX_REORDER | CODEC_CAP_HYBRID),
292 desc!(video-im; "mwv1", "Aware MotionWavelets"),
295 static AVI_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
296 (&[1, 0, 0, 0], "msrle"),
297 (&[2, 0, 0, 0], "msrle"),
299 (b"CRAM", "msvideo1"),
300 (b"MSVC", "msvideo1"),
301 (b"WHAM", "msvideo1"),
311 (b"I263", "intel263"),
313 (b"UCOD", "clearvideo"),
314 (b"cvid", "cinepak"),
320 (b"MVDV", "midivid"),
321 (b"MV30", "midivid3"),
322 (b"MVLZ", "midivid-ll"),
324 (b"DUCK", "truemotion1"),
325 (b"TR20", "truemotionrt"),
326 (b"TM20", "truemotion2"),
327 (b"TM2A", "truemotion2x"),
328 (b"TM2X", "truemotion2x"),
342 static WAV_CODEC_REGISTER: &[(u16, &str)] = &[
345 (0x0002, "ms-adpcm"),
347 (0x0011, "ima-adpcm-ms"),
348 (0x0061, "adpcm-dk4"),
349 (0x0062, "adpcm-dk3"),
352 (0x0500, "on2avc-500"),
353 (0x0501, "on2avc-501"),
356 static MOV_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
357 (b"cvid", "cinepak"),
363 (b"rpza", "apple-video"),
364 (b"kpcd", "kodak-photocd"),
365 //(b"mpeg", "mpeg-video"),
366 (b"mjpa", "mjpeg-a"),
367 (b"mjpb", "mjpeg-b"),
368 (b"svqi", "sorenson-video"),
369 (b"SVQ1", "sorenson-video"),
370 (b"svq3", "sorenson-video3"),
371 (b"SVQ3", "sorenson-video3"),
376 (b"UCOD", "clearvideo"),
384 static MOV_AUDIO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
395 (b"ima4", "ima-adpcm-qt"),
398 (b"dvca", "dv-audio"),
399 (b"QDMC", "qdesign-music"),
400 (b"QDM2", "qdesign-music2"),
401 (b"Qclp", "qualcomm-purevoice"),
402 //(b".mp3", "mpeg-layer3"),
409 /// Returns video codec short name for provided FOURCC (used in AVI format).
410 pub fn find_codec_from_avi_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
411 for (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
412 if *fourcc == fcc { return Some(name); }
417 /// Returns FOURCC (used in AVI format) for provided codec name.
418 pub fn find_avi_fourcc(codecname: &str) -> Option<[u8; 4]> {
419 for (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
420 if *name == codecname { return Some(**fourcc); }
425 /// Returns known audio codec short name for provided TWOCC (used in WAV and AVI format).
426 pub fn find_codec_from_wav_twocc(tcc: u16) -> Option<&'static str> {
427 for (twocc, name) in WAV_CODEC_REGISTER.iter() {
428 if *twocc == tcc { return Some(name); }
433 /// Returns TWOCC (used in WAV and AVI format for provided codec name.
434 pub fn find_wav_twocc(codecname: &str) -> Option<u16> {
435 for (twocc, name) in WAV_CODEC_REGISTER.iter() {
436 if *name == codecname { return Some(*twocc); }
441 /// Returns video codec short name for provided FOURCC (used in MOV format).
442 pub fn find_codec_from_mov_video_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
443 for (fourcc, name) in MOV_VIDEO_CODEC_REGISTER.iter() {
444 if *fourcc == fcc { return Some(name); }
449 /// Returns known audio codec short name for provided FOURCC (used in MOV format).
450 pub fn find_codec_from_mov_audio_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
451 for (fourcc, name) in MOV_AUDIO_CODEC_REGISTER.iter() {
452 if *fourcc == fcc { return Some(name); }
463 let c1 = find_codec_from_avi_fourcc(b"IV41").unwrap();
464 let c2 = find_codec_from_wav_twocc(0x401).unwrap();
465 println!("found {} and {}", c1, c2);
466 let cd1 = get_codec_description(c1).unwrap();
467 let cd2 = get_codec_description(c2).unwrap();
468 println!("got {} and {}", cd1, cd2);