nihav-registry/src/register.rs

   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.
   4 use std::fmt;
   5
   6 /// Codec types.
   7 #[derive(Debug,Clone,Copy,PartialEq)]
   8 #[allow(dead_code)]
   9 pub enum CodecType {
  10     /// Video codec.
  11     Video,
  12     /// Audio codec.
  13     Audio,
  14     /// Subtitle codec.
  15     Subtitles,
  16     /// Some special codec (e.g. some event stream or separate timecodes stream).
  17     Data,
  18     /// Dummy codec.
  19     None,
  20 }
  21
  22 impl 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
  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;
  46
  47 /// Codec description structure.
  48 #[derive(Clone)]
  49 pub struct CodecDescription {
  50     /// Short codec name.
  51     ///
  52     /// Short codec name is used inside NihAV as the unique identifier.
  53     pub name:  &'static str,
  54     /// Full codec name.
  55     pub fname: &'static str,
  56     /// Codec type.
  57     pub ctype: CodecType,
  58     /// Codec capabilities.
  59     pub caps:  u32,
  60 }
  61
  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.
  78     ///
  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 }
  81 }
  82
  83 impl fmt::Display for CodecDescription {
  84     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  85         let mut out = self.fname.to_string();
  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
 109 macro_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     });
 142     (audio-hyb; $n:expr, $fn:expr) => ({
 143         CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Audio,
 144                           caps: CODEC_CAP_HYBRID }
 145     });
 146 }
 147
 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     CODEC_REGISTER.iter().find(|&reg| reg.name == name)
 151 }
 152
 153 static CODEC_REGISTER: &[CodecDescription] = &[
 154     desc!(audio-ll; "pcm", "PCM"),
 155     desc!(audio;    "alaw", "A-law PCM"),
 156     desc!(audio;    "ulaw", "mu-law PCM"),
 157
 158     desc!(video-im; "indeo1", "Intel Raw IF09"),
 159     desc!(video-im; "indeo2", "Intel Indeo 2"),
 160     desc!(video;    "indeo3", "Intel Indeo 3"),
 161     desc!(video;    "indeo4", "Intel Indeo 4", CODEC_CAP_REORDER | CODEC_CAP_SCALABLE),
 162     desc!(video;    "indeo5", "Intel Indeo 5", CODEC_CAP_REORDER | CODEC_CAP_SCALABLE),
 163     desc!(video;    "indeo5s", "Intel Indeo 5 Scalable", CODEC_CAP_SCALABLE),
 164     desc!(video;    "intel263", "Intel I263", CODEC_CAP_REORDER),
 165     desc!(audio;    "iac",    "Intel Indeo audio"),
 166     desc!(audio;    "imc",    "Intel Music Coder"),
 167
 168     desc!(video;    "realvideo1", "Real Video 1"),
 169     desc!(video;    "realvideo2", "Real Video 2", CODEC_CAP_REORDER),
 170     desc!(video;    "realvideo3", "Real Video 3", CODEC_CAP_REORDER),
 171     desc!(video;    "realvideo4", "Real Video 4", CODEC_CAP_REORDER),
 172     desc!(video;    "realvideo6", "Real Video 6", CODEC_CAP_REORDER),
 173     desc!(video;    "clearvideo", "ClearVideo"),
 174     desc!(video;    "clearvideo_rm", "ClearVideo"),
 175     desc!(audio;    "ra14.4",     "RealAudio 14.4"),
 176     desc!(audio;    "ra28.8",     "RealAudio 28.8"),
 177     desc!(audio;    "cook",       "RealAudio Cooker"),
 178     desc!(audio;    "ralf",       "RealAudio Lossless"),
 179     desc!(audio;    "aac",        "AAC"),
 180     desc!(audio;    "ac3",        "ETSI TS 102 366"),
 181     desc!(audio;    "atrac3",     "Sony Atrac3"),
 182     desc!(audio;    "sipro",      "Sipro Labs ADPCM"),
 183
 184
 185     desc!(video-ll; "rawvideo",   "Raw video data"),
 186     desc!(video-ll; "rawvideo-ms", "Raw video data"),
 187
 188     desc!(video;    "cinepak",    "Cinepak"),
 189
 190     desc!(video-llp; "zmbv",      "Zip Motion Blocks Video"),
 191
 192     desc!(video;    "msvideo1",      "MS Video 1"),
 193     desc!(video;    "msrle",         "MS RLE"),
 194     desc!(audio;    "ms-adpcm",      "MS ADPCM"),
 195     desc!(audio;    "ima-adpcm-ms",  "IMA ADPCM (MS variant)"),
 196
 197     desc!(video;    "qt-smc",               "Apple Graphics"),
 198     desc!(video;    "qt-rle",               "Apple Animation"),
 199     desc!(video;    "apple-video",          "Apple video"),
 200     desc!(video;    "sorenson-video",       "Sorenson Video"),
 201     desc!(video;    "sorenson-video3",      "Sorenson Video 3", CODEC_CAP_REORDER),
 202     desc!(audio-ll; "alac",                 "Apple Lossless Audio Codec"),
 203     desc!(audio;    "mace-3",               "MACE 3:1"),
 204     desc!(audio;    "mace-6",               "MACE 6:1"),
 205     desc!(audio;    "ima-adpcm-qt",         "IMA ADPCM (Apple variant)"),
 206     desc!(audio;    "qdesign-music",        "QDesign Music"),
 207     desc!(audio;    "qdesign-music2",       "QDesign Music v2"),
 208     desc!(audio;    "qualcomm-purevoice",   "Qualcomm PureVoice"),
 209
 210     desc!(video;    "truemotion1",   "TrueMotion 1"),
 211     desc!(video-im; "truemotionrt",  "TrueMotion RT"),
 212     desc!(video;    "truemotion2",   "TrueMotion 2"),
 213     desc!(video;    "truemotion2x",  "TrueMotion 2X"),
 214     desc!(video;    "vp3",           "VP3"),
 215     desc!(video;    "vp4",           "VP4"),
 216     desc!(video;    "vp5",           "VP5"),
 217     desc!(video;    "vp6",           "VP6"),
 218     desc!(video;    "vp6f",          "VP6 (in Flash)"),
 219     desc!(video;    "vp6a",          "VP6 with alpha"),
 220     desc!(video;    "vp7",           "VP7"),
 221     desc!(video;    "vp8",           "VP8"),
 222     desc!(video;    "vp9",           "VP9"),
 223     desc!(audio;    "adpcm-dk3",     "Duck DK3 ADPCM"),
 224     desc!(audio;    "adpcm-dk4",     "Duck DK4 ADPCM"),
 225     desc!(audio;    "on2avc-500",    "On2 AVC"),
 226     desc!(audio;    "on2avc-501",    "On2 AVC"),
 227
 228     desc!(video;     "flv263",       "Sorenson H.263"),
 229     desc!(video-llp; "flashsv",      "Flash Screen Video"),
 230     desc!(video-llp; "flashsv2",     "Flash Screen Video 2"),
 231     desc!(audio;     "asao",         "N*llym*s*r ASAO"),
 232     desc!(audio;     "flv-adpcm",    "Flash ADPCM"),
 233
 234     desc!(audio;     "mp1",          "MPEG Audio Layer I"),
 235     desc!(audio;     "mp2",          "MPEG Audio Layer II"),
 236     desc!(audio;     "mp3",          "MPEG Audio Layer III"),
 237     desc!(audio;     "speex",        "Speex"),
 238
 239     desc!(video;    "gdv-video",     "Gremlin Digital Video - video"),
 240     desc!(audio;    "gdv-audio",     "Gremlin Digital Video - audio"),
 241     desc!(video-im; "arxel-video",   "Arxel Tribe Video"),
 242     desc!(video;    "beam-fcp",      "Beam Software Animation"),
 243     desc!(video;    "beam-video",    "Beam Software Video"),
 244     desc!(video;    "bmv-video",     "BMV video"),
 245     desc!(audio;    "bmv-audio",     "BMV audio"),
 246     desc!(video;    "bmv3-video",    "DW Noir BMV video"),
 247     desc!(audio;    "bmv3-audio",    "DW Noir BMV audio"),
 248     desc!(video;    "dp-sga",        "Digital Pictures SGA video"),
 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;    "hl-fmv-video",  "Highlander FMV video"),
 253     desc!(video-llp; "ipma",         "Imagination Pilots Matte Animation"),
 254     desc!(video-llp; "ipma2",        "Imagination Pilots Matte Animation v2"),
 255     desc!(video;    "legend-q-video", "Legend Entertainment Q video"),
 256     desc!(video;    "midivid",       "MidiVid"),
 257     desc!(video;    "midivid3",      "MidiVid 3"),
 258     desc!(video-ll; "midivid-ll",    "MidiVid Lossless"),
 259     desc!(video;    "smushv1",       "SMUSH Video paletted"),
 260     desc!(video;    "smushv2",       "SMUSH Video 16-bit"),
 261     desc!(video;    "smush-iact",    "SMUSH IACT Audio"),
 262     desc!(video;    "smush-vima",    "SMUSH VIMA Audio"),
 263     desc!(video;    "vmd-video",     "VMD video"),
 264     desc!(audio;    "vmd-audio",     "VMD audio"),
 265     desc!(video;    "vxvideo",       "Actimagine Vx"),
 266     desc!(audio;    "vxaudio",       "Actimagine Sx"),
 267
 268     desc!(video;    "smacker-video", "Smacker video"),
 269     desc!(audio;    "smacker-audio", "Smacker audio"),
 270     desc!(video;    "bink-video",    "Bink video"),
 271     desc!(video;    "bink2-video",   "Bink2 video"),
 272     desc!(audio;    "bink-audio-dct",   "Bink audio (DCT)"),
 273     desc!(audio;    "bink-audio-rdft",  "Bink audio (RDFT)"),
 274
 275     desc!(audio;    "lhst15f8",      "L&H StreamTalk 15kbps at 8 kHz"),
 276     desc!(audio;    "lhst250f11",    "L&H StreamTalk 25kbps at 11 kHz"),
 277     desc!(audio;    "lhst500f22",    "L&H StreamTalk 50kpbs at 22 kHz"),
 278     desc!(audio;    "lhst48",        "L&H StreamTalk CELP Codec 4.8kbps at 8 kHz"),
 279
 280     desc!(video;    "vivo1",         "VivoActive Video 1.0"),
 281     desc!(video;    "vivo2",         "VivoActive Video 2.0", CODEC_CAP_REORDER),
 282     desc!(audio;    "g723.1",        "ITU G.723.1"),
 283     desc!(audio;    "siren",         "Polycom Siren"),
 284
 285     desc!(audio-ll;  "ape",          "Monkey's Audio"),
 286     desc!(audio-ll;  "flac",         "Free Lossless Audio Codec"),
 287     desc!(audio-ll;  "tta",          "True Audio codec"),
 288     desc!(audio-hyb; "wavpack",      "WavPack"),
 289
 290     desc!(video-ll; "gif",           "GIF"),
 291     desc!(video-im; "jpeg",          "JPEG"),
 292     desc!(video;    "h264",          "ITU H.264", CODEC_CAP_COMPLEX_REORDER | CODEC_CAP_HYBRID),
 293
 294     desc!(video-im; "mwv1",          "Aware MotionWavelets"),
 295 ];
 296
 297 static AVI_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
 298     (&[1, 0, 0, 0], "msrle"),
 299     (&[2, 0, 0, 0], "msrle"),
 300
 301     (b"CRAM", "msvideo1"),
 302     (b"MSVC", "msvideo1"),
 303     (b"WHAM", "msvideo1"),
 304
 305     (b"MJPG", "jpeg"),
 306
 307     (b"IF09", "indeo1"),
 308     (b"RT21", "indeo2"),
 309     (b"IV31", "indeo3"),
 310     (b"IV32", "indeo3"),
 311     (b"IV41", "indeo4"),
 312     (b"IV50", "indeo5"),
 313     (b"I263", "intel263"),
 314
 315     (b"UCOD", "clearvideo"),
 316     (b"cvid", "cinepak"),
 317     (b"ZMBV", "zmbv"),
 318
 319     (b"Ipma", "ipma"),
 320     (b"Ip20", "ipma2"),
 321
 322     (b"MVDV", "midivid"),
 323     (b"MV30", "midivid3"),
 324     (b"MVLZ", "midivid-ll"),
 325
 326     (b"DUCK", "truemotion1"),
 327     (b"TR20", "truemotionrt"),
 328     (b"TM20", "truemotion2"),
 329     (b"TM2A", "truemotion2x"),
 330     (b"TM2X", "truemotion2x"),
 331     (b"VP30", "vp3"),
 332     (b"VP31", "vp3"),
 333     (b"VP40", "vp4"),
 334     (b"VP50", "vp5"),
 335     (b"VP60", "vp6"),
 336     (b"VP61", "vp6"),
 337     (b"VP62", "vp6"),
 338     (b"VP6A", "vp6a"),
 339     (b"VP70", "vp7"),
 340
 341     (b"MWV1", "mwv1"),
 342 ];
 343
 344 static WAV_CODEC_REGISTER: &[(u16, &str)] = &[
 345     (0x0000, "unknown"),
 346     (0x0001, "pcm"),
 347     (0x0002, "ms-adpcm"),
 348     (0x0003, "pcm"),
 349     (0x0011, "ima-adpcm-ms"),
 350     (0x0061, "adpcm-dk4"),
 351     (0x0062, "adpcm-dk3"),
 352     (0x0401, "imc"),
 353     (0x0402, "iac"),
 354     (0x0500, "on2avc-500"),
 355     (0x0501, "on2avc-501"),
 356 ];
 357
 358 static MOV_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
 359     (b"cvid", "cinepak"),
 360     (b"jpeg", "jpeg"),
 361     //(b"raw ", "raw"),
 362     //(b"Yuv2", "raw"),
 363     (b"smc ", "qt-smc"),
 364     (b"rle ", "qt-rle"),
 365     (b"rpza", "apple-video"),
 366     (b"kpcd", "kodak-photocd"),
 367     //(b"mpeg", "mpeg-video"),
 368     (b"mjpa", "mjpeg-a"),
 369     (b"mjpb", "mjpeg-b"),
 370     (b"svqi", "sorenson-video"),
 371     (b"SVQ1", "sorenson-video"),
 372     (b"svq3", "sorenson-video3"),
 373     (b"SVQ3", "sorenson-video3"),
 374
 375     (b"IV31", "indeo3"),
 376     (b"IV32", "indeo3"),
 377
 378     (b"UCOD", "clearvideo"),
 379
 380     (b"VP30", "vp3"),
 381     (b"VP31", "vp3"),
 382
 383     (b"avc1", "h264"),
 384 ];
 385
 386 static MOV_AUDIO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
 387     (b"NONE", "pcm"),
 388     (b"raw ", "pcm"),
 389     (b"twos", "pcm"),
 390     (b"sowt", "pcm"),
 391     (b"fl32", "pcm"),
 392     (b"fl64", "pcm"),
 393     (b"in24", "pcm"),
 394     (b"in32", "pcm"),
 395     (b"MAC3", "mace-3"),
 396     (b"MAC6", "mace-6"),
 397     (b"ima4", "ima-adpcm-qt"),
 398     (b"ulaw", "ulaw"),
 399     (b"alaw", "alaw"),
 400     (b"dvca", "dv-audio"),
 401     (b"QDMC", "qdesign-music"),
 402     (b"QDM2", "qdesign-music2"),
 403     (b"Qclp", "qualcomm-purevoice"),
 404     //(b".mp3", "mpeg-layer3"),
 405
 406     (b"mp4a", "aac"),
 407
 408     (b"alac", "alac"),
 409 ];
 410
 411 /// Returns video codec short name for provided FOURCC (used in AVI format).
 412 pub fn find_codec_from_avi_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
 413     for (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
 414         if *fourcc == fcc { return Some(name); }
 415     }
 416     None
 417 }
 418
 419 /// Returns FOURCC (used in AVI format) for provided codec name.
 420 pub fn find_avi_fourcc(codecname: &str) -> Option<[u8; 4]> {
 421     for (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
 422         if *name == codecname { return Some(**fourcc); }
 423     }
 424     None
 425 }
 426
 427 /// Returns known audio codec short name for provided TWOCC (used in WAV and AVI format).
 428 pub fn find_codec_from_wav_twocc(tcc: u16) -> Option<&'static str> {
 429     for (twocc, name) in WAV_CODEC_REGISTER.iter() {
 430         if *twocc == tcc { return Some(name); }
 431     }
 432     None
 433 }
 434
 435 /// Returns TWOCC (used in WAV and AVI format for provided codec name.
 436 pub fn find_wav_twocc(codecname: &str) -> Option<u16> {
 437     for (twocc, name) in WAV_CODEC_REGISTER.iter() {
 438         if *name == codecname { return Some(*twocc); }
 439     }
 440     None
 441 }
 442
 443 /// Returns video codec short name for provided FOURCC (used in MOV format).
 444 pub fn find_codec_from_mov_video_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
 445     for (fourcc, name) in MOV_VIDEO_CODEC_REGISTER.iter() {
 446         if *fourcc == fcc { return Some(name); }
 447     }
 448     None
 449 }
 450
 451 /// Returns known audio codec short name for provided FOURCC (used in MOV format).
 452 pub fn find_codec_from_mov_audio_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
 453     for (fourcc, name) in MOV_AUDIO_CODEC_REGISTER.iter() {
 454         if *fourcc == fcc { return Some(name); }
 455     }
 456     None
 457 }
 458
 459 #[cfg(test)]
 460 mod test {
 461     use super::*;
 462
 463     #[test]
 464     fn test_register() {
 465         let c1 = find_codec_from_avi_fourcc(b"IV41").unwrap();
 466         let c2 = find_codec_from_wav_twocc(0x401).unwrap();
 467         println!("found {} and {}", c1, c2);
 468         let cd1 = get_codec_description(c1).unwrap();
 469         let cd2 = get_codec_description(c2).unwrap();
 470         println!("got {} and {}", cd1, cd2);
 471     }
 472 }