]> git.nihav.org Git - nihav.git/blobdiff - nihav-core/src/register.rs
core: document register module
[nihav.git] / nihav-core / src / register.rs
index 8d6bab4c693e4985be22ab693eb05bc1e2409e54..c54ce584d7b63367b55f1db235d57a30bc81db69 100644 (file)
@@ -1,12 +1,21 @@
+//! Global registry of codec information.
+//!
+//! 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.
 use std::fmt;
 
+/// Codec types.
 #[derive(Debug,Clone,Copy,PartialEq)]
 #[allow(dead_code)]
 pub enum CodecType {
+    /// Video codec.
     Video,
+    /// Audio codec.
     Audio,
+    /// Subtitle codec.
     Subtitles,
+    /// Some special codec (e.g. some event stream or separate timecodes stream).
     Data,
+    /// Dummy codec.
     None,
 }
 
@@ -22,34 +31,51 @@ impl fmt::Display for CodecType {
     }
 }
 
-const CODEC_CAP_INTRAONLY:u32   = 0x000001;
-const CODEC_CAP_LOSSLESS:u32    = 0x000002;
-const CODEC_CAP_REORDER:u32     = 0x000004;
-const CODEC_CAP_HYBRID:u32      = 0x000008;
-const CODEC_CAP_SCALABLE:u32    = 0x000010;
+const CODEC_CAP_INTRAONLY:u32   = 0x0001;
+const CODEC_CAP_LOSSLESS:u32    = 0x0002;
+const CODEC_CAP_REORDER:u32     = 0x0004;
+const CODEC_CAP_HYBRID:u32      = 0x0008;
+const CODEC_CAP_SCALABLE:u32    = 0x0010;
 
+/// Codec description structure.
 #[derive(Clone)]
 pub struct CodecDescription {
+    /// Short codec name.
+    ///
+    /// Short codec name is used inside NihAV as the unique identifier.
     pub name:  &'static str,
+    /// Full codec name.
     pub fname: &'static str,
+    /// Codec type.
     pub ctype: CodecType,
+    /// Codec capabilities.
     pub caps:  u32,
 }
 
 impl CodecDescription {
+    /// Returns short codec name.
     pub fn get_name(&self) -> &'static str { self.name }
+    /// Returns full codec name.
     pub fn get_full_name(&self) -> &'static str { self.fname }
+    /// Returns codec type.
     pub fn get_codec_type(&self) -> CodecType { self.ctype }
+    /// Reports whether the codec has only intra frames or not.
     pub fn is_intraonly(&self) -> bool { (self.caps & CODEC_CAP_INTRAONLY) != 0 }
+    /// Reports whether the codec is lossless.
     pub fn is_lossless(&self)  -> bool { (self.caps & CODEC_CAP_LOSSLESS)  != 0 }
+    /// Reports whether the codec requires frame reordering.
     pub fn has_reorder(&self)  -> bool { (self.caps & CODEC_CAP_REORDER)   != 0 }
+    /// Reports whether the codec can be either lossless or lossy.
     pub fn is_hybrid(&self)    -> bool { (self.caps & CODEC_CAP_HYBRID)    != 0 }
+    /// Reports whether codec supports scalability.
+    ///
+    /// Scalability means that codec can be decoded in reduced resolution by design.
     pub fn is_scalable(&self)  -> bool { (self.caps & CODEC_CAP_SCALABLE)  != 0 }
 }
 
 impl fmt::Display for CodecDescription {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        let mut out = format!("{}", self.fname);
+        let mut out = self.fname.to_string();
         if self.caps != 0 {
             let mut capfmt = "".to_string();
             if (self.caps & CODEC_CAP_INTRAONLY) != 0 {
@@ -108,6 +134,7 @@ macro_rules! desc {
     });
 }
 
+/// Returns codec description for the provided codec short name if it is found.
 pub fn get_codec_description(name: &str) -> Option<&'static CodecDescription> {
     for reg in CODEC_REGISTER {
         if reg.name == name {
@@ -145,26 +172,34 @@ static CODEC_REGISTER: &'static [CodecDescription] = &[
     desc!(audio;    "atrac3",     "Sony Atrac3"),
     desc!(audio;    "sipro",      "Sipro Labs ADPCM"),
 
-    desc!(video;    "truemotion1",   "TrueMotion 1"), 
-    desc!(video-im; "truemotionrt",  "TrueMotion RT"), 
-    desc!(video;    "truemotion2",   "TrueMotion 2"), 
+    desc!(video;    "truemotion1",   "TrueMotion 1"),
+    desc!(video-im; "truemotionrt",  "TrueMotion RT"),
+    desc!(video;    "truemotion2",   "TrueMotion 2"),
     desc!(video;    "truemotion2x",  "TrueMotion 2X"),
     desc!(video;    "vp3",           "VP3"),
     desc!(video;    "vp4",           "VP4"),
     desc!(video;    "vp5",           "VP5"),
     desc!(video;    "vp6",           "VP6"),
+    desc!(video;    "vp6a",          "VP6"),
     desc!(video;    "vp7",           "VP7"),
     desc!(video;    "vp8",           "VP8"),
     desc!(video;    "vp9",           "VP9"),
     desc!(audio;    "adpcm-dk3",     "Duck DK3 ADPCM"),
     desc!(audio;    "adpcm-dk4",     "Duck DK4 ADPCM"),
-    desc!(audio;    "on2-avc-500",   "On2 AVC"),
-    desc!(audio;    "on2-avc-501",   "On2 AVC"),
+    desc!(audio;    "on2avc-500",    "On2 AVC"),
+    desc!(audio;    "on2avc-501",    "On2 AVC"),
 
     desc!(video;    "gdv-video",     "Gremlin Digital Video - video"),
     desc!(audio;    "gdv-audio",     "Gremlin Digital Video - audio"),
     desc!(video;    "bmv-video",     "BMV video"),
     desc!(audio;    "bmv-audio",     "BMV audio"),
+    desc!(video;    "bmv3-video",    "DW Noir BMV video"),
+    desc!(audio;    "bmv3-audio",    "DW Noir BMV audio"),
+    desc!(video;    "midivid",       "MidiVid"),
+    desc!(video;    "midivid3",      "MidiVid 3"),
+    desc!(video-ll; "midivid-ll",    "MidiVid Lossless"),
+    desc!(video;    "vmd-video",     "VMD video"),
+    desc!(audio;    "vmd-audio",     "VMD audio"),
 
     desc!(video;    "smacker-video", "Smacker video"),
     desc!(audio;    "smacker-audio", "Smacker audio"),
@@ -185,6 +220,10 @@ static AVI_VIDEO_CODEC_REGISTER: &'static [(&[u8;4], &str)] = &[
 
     (b"UCOD", "clearvideo"),
 
+    (b"MVDV", "midivid"),
+    (b"MV30", "midivid3"),
+    (b"MVLZ", "midivid-ll"),
+
     (b"DUCK", "truemotion1"),
     (b"TR20", "truemotionrt"),
     (b"TM20", "truemotion2"),
@@ -197,6 +236,7 @@ static AVI_VIDEO_CODEC_REGISTER: &'static [(&[u8;4], &str)] = &[
     (b"VP60", "vp6"),
     (b"VP61", "vp6"),
     (b"VP62", "vp6"),
+    (b"VP6A", "vp6a"),
     (b"VP70", "vp7"),
 ];
 
@@ -212,18 +252,18 @@ static WAV_CODEC_REGISTER: &'static [(u16, &str)] = &[
     (0x0501, "on2avc-501"),
 ];
 
+/// Returns video codec short name for provided FOURCC (used in AVI format).
 pub fn find_codec_from_avi_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
-    for i in 0..AVI_VIDEO_CODEC_REGISTER.len() {
-        let (fourcc, name) = AVI_VIDEO_CODEC_REGISTER[i];
-        if fourcc == fcc { return Some(name); }
+    for (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
+        if *fourcc == fcc { return Some(name); }
     }
     None
 }
 
+/// Returns known audio codec short name for provided TWOCC (used in WAV and AVI format).
 pub fn find_codec_from_wav_twocc(tcc: u16) -> Option<&'static str> {
-    for i in 0..WAV_CODEC_REGISTER.len() {
-        let (twocc, name) = WAV_CODEC_REGISTER[i];
-        if twocc == tcc { return Some(name); }
+    for (twocc, name) in WAV_CODEC_REGISTER.iter() {
+        if *twocc == tcc { return Some(name); }
     }
     None
 }