[nihav.git] / nihav-registry / src / register.rs

//! 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,
}

impl fmt::Display for CodecType {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            CodecType::Video => write!(f, "Video"),
            CodecType::Audio => write!(f, "Audio"),
            CodecType::Subtitles => write!(f, "Subtitles"),
            CodecType::Data => write!(f, "Data"),
            CodecType::None => write!(f, "-"),
        }
    }
}

/// Codec capability flag for intra-only codecs.
pub const CODEC_CAP_INTRAONLY:u32   = 0x0001;
/// Codec capability flag for lossless codecs.
pub const CODEC_CAP_LOSSLESS:u32    = 0x0002;
/// Codec capability flag for codecs with frame reordering.
pub const CODEC_CAP_REORDER:u32     = 0x0004;
/// Codec capability flag for codecs that can be both lossy and lossless.
pub const CODEC_CAP_HYBRID:u32      = 0x0008;
/// Codec capability flag for codecs with scalability features.
pub const CODEC_CAP_SCALABLE:u32    = 0x0010;
/// Codec capability flag for codecs with complex frame reordering.
pub const CODEC_CAP_COMPLEX_REORDER:u32 = 0x0020;

/// 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 = self.fname.to_string();
        if self.caps != 0 {
            let mut capfmt = "".to_string();
            if (self.caps & CODEC_CAP_INTRAONLY) != 0 {
                capfmt = format!("{} Intra-only", capfmt);
            }
            if (self.caps & CODEC_CAP_LOSSLESS) != 0 {
                capfmt = format!("{} Lossless", capfmt);
            }
            if (self.caps & CODEC_CAP_REORDER) != 0 {
                capfmt = format!("{} Frame reorder", capfmt);
            }
            if (self.caps & CODEC_CAP_HYBRID) != 0 {
                capfmt = format!("{} Can be lossy and lossless", capfmt);
            }
            if (self.caps & CODEC_CAP_SCALABLE) != 0 {
                capfmt = format!("{} Scalable", capfmt);
            }
            out = format!("{} ({})", out, capfmt);
        }
        write!(f, "{}", out)
    }
}

macro_rules! desc {
    (video; $n:expr, $fn:expr) => ({
        CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
                          caps: 0 }
    });
    (video; $n:expr, $fn:expr, $c:expr) => ({
        CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
                          caps: $c }
    });
    (video-ll; $n:expr, $fn:expr) => ({
        CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
                          caps: CODEC_CAP_LOSSLESS | CODEC_CAP_INTRAONLY }
    });
    (video-llp; $n:expr, $fn:expr) => ({
        CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
                          caps: CODEC_CAP_LOSSLESS }
    });
    (video-im; $n:expr, $fn:expr) => ({
        CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
                          caps: CODEC_CAP_INTRAONLY }
    });
    (video-modern; $n:expr, $fn:expr) => ({
        CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Video,
                          caps: CODEC_CAP_REORDER | CODEC_CAP_HYBRID }
    });
    (audio; $n:expr, $fn:expr) => ({
        CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Audio,
                          caps: 0 }
    });
    (audio-ll; $n:expr, $fn:expr) => ({
        CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Audio,
                          caps: CODEC_CAP_LOSSLESS | CODEC_CAP_INTRAONLY }
    });
    (audio-hyb; $n:expr, $fn:expr) => ({
        CodecDescription{ name: $n, fname: $fn, ctype: CodecType::Audio,
                          caps: CODEC_CAP_HYBRID }
    });
}

/// 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 {
            return Some(reg);
        }
    }
    None
}

static CODEC_REGISTER: &[CodecDescription] = &[
    desc!(audio-ll; "pcm", "PCM"),
    desc!(audio;    "alaw", "A-law PCM"),
    desc!(audio;    "ulaw", "mu-law PCM"),

    desc!(video-im; "indeo1", "Intel Raw IF09"),
    desc!(video-im; "indeo2", "Intel Indeo 2"),
    desc!(video;    "indeo3", "Intel Indeo 3"),
    desc!(video;    "indeo4", "Intel Indeo 4", CODEC_CAP_REORDER | CODEC_CAP_SCALABLE),
    desc!(video;    "indeo5", "Intel Indeo 5", CODEC_CAP_REORDER | CODEC_CAP_SCALABLE),
    desc!(video;    "indeo5s", "Intel Indeo 5 Scalable", CODEC_CAP_SCALABLE),
    desc!(video;    "intel263", "Intel I263", CODEC_CAP_REORDER),
    desc!(audio;    "iac",    "Intel Indeo audio"),
    desc!(audio;    "imc",    "Intel Music Coder"),

    desc!(video;    "realvideo1", "Real Video 1"),
    desc!(video;    "realvideo2", "Real Video 2", CODEC_CAP_REORDER),
    desc!(video;    "realvideo3", "Real Video 3", CODEC_CAP_REORDER),
    desc!(video;    "realvideo4", "Real Video 4", CODEC_CAP_REORDER),
    desc!(video;    "realvideo6", "Real Video 6", CODEC_CAP_REORDER),
    desc!(video;    "clearvideo", "ClearVideo"),
    desc!(video;    "clearvideo_rm", "ClearVideo"),
    desc!(audio;    "ra14.4",     "RealAudio 14.4"),
    desc!(audio;    "ra28.8",     "RealAudio 28.8"),
    desc!(audio;    "cook",       "RealAudio Cooker"),
    desc!(audio;    "ralf",       "RealAudio Lossless"),
    desc!(audio;    "aac",        "AAC"),
    desc!(audio;    "ac3",        "ETSI TS 102 366"),
    desc!(audio;    "atrac3",     "Sony Atrac3"),
    desc!(audio;    "sipro",      "Sipro Labs ADPCM"),


    desc!(video-ll; "rawvideo",   "Raw video data"),
    desc!(video-ll; "rawvideo-ms", "Raw video data"),

    desc!(video;    "cinepak",    "Cinepak"),

    desc!(video-llp; "zmbv",      "Zip Motion Blocks Video"),

    desc!(video;    "msvideo1",      "MS Video 1"),
    desc!(video;    "msrle",         "MS RLE"),
    desc!(audio;    "ms-adpcm",      "MS ADPCM"),
    desc!(audio;    "ima-adpcm-ms",  "IMA ADPCM (MS variant)"),

    desc!(video;    "qt-smc",               "Apple Graphics"),
    desc!(video;    "qt-rle",               "Apple Animation"),
    desc!(video;    "apple-video",          "Apple video"),
    desc!(video;    "sorenson-video",       "Sorenson Video"),
    desc!(video;    "sorenson-video3",      "Sorenson Video 3", CODEC_CAP_REORDER),
    desc!(audio-ll; "alac",                 "Apple Lossless Audio Codec"),
    desc!(audio;    "mace-3",               "MACE 3:1"),
    desc!(audio;    "mace-6",               "MACE 6:1"),
    desc!(audio;    "ima-adpcm-qt",         "IMA ADPCM (Apple variant)"),
    desc!(audio;    "qdesign-music",        "QDesign Music"),
    desc!(audio;    "qdesign-music2",       "QDesign Music v2"),
    desc!(audio;    "qualcomm-purevoice",   "Qualcomm PureVoice"),

    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;    "vp6f",          "VP6 (in Flash)"),
    desc!(video;    "vp6a",          "VP6 with alpha"),
    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;    "on2avc-500",    "On2 AVC"),
    desc!(audio;    "on2avc-501",    "On2 AVC"),

    desc!(video;     "flv263",       "Sorenson H.263"),
    desc!(video-llp; "flashsv",      "Flash Screen Video"),
    desc!(video-llp; "flashsv2",     "Flash Screen Video 2"),
    desc!(audio;     "asao",         "N*llym*s*r ASAO"),
    desc!(audio;     "flv-adpcm",    "Flash ADPCM"),

    desc!(audio;     "mp1",          "MPEG Audio Layer I"),
    desc!(audio;     "mp2",          "MPEG Audio Layer II"),
    desc!(audio;     "mp3",          "MPEG Audio Layer III"),
    desc!(audio;     "speex",        "Speex"),

    desc!(video;    "gdv-video",     "Gremlin Digital Video - video"),
    desc!(audio;    "gdv-audio",     "Gremlin Digital Video - audio"),
    desc!(video;    "beam-fcp",      "Beam Software Animation"),
    desc!(video;    "beam-video",    "Beam Software Video"),
    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;    "fable-imax",    "Fable IMAX video"),
    desc!(video;    "fst-video",     "FutureVision video"),
    desc!(audio;    "fst-audio",     "FutureVision audio"),
    desc!(video;    "hl-fmv-video",  "Highlander FMV video"),
    desc!(video-llp; "ipma",         "Imagination Pilots Matte Animation"),
    desc!(video-llp; "ipma2",        "Imagination Pilots Matte Animation v2"),
    desc!(video;    "legend-q-video", "Legend Entertainment Q video"),
    desc!(video;    "midivid",       "MidiVid"),
    desc!(video;    "midivid3",      "MidiVid 3"),
    desc!(video-ll; "midivid-ll",    "MidiVid Lossless"),
    desc!(video;    "smushv1",       "SMUSH Video paletted"),
    desc!(video;    "smushv2",       "SMUSH Video 16-bit"),
    desc!(video;    "smush-iact",    "SMUSH IACT Audio"),
    desc!(video;    "smush-vima",    "SMUSH VIMA Audio"),
    desc!(video;    "vmd-video",     "VMD video"),
    desc!(audio;    "vmd-audio",     "VMD audio"),
    desc!(video;    "vxvideo",       "Actimagine Vx"),
    desc!(audio;    "vxaudio",       "Actimagine Sx"),

    desc!(video;    "smacker-video", "Smacker video"),
    desc!(audio;    "smacker-audio", "Smacker audio"),
    desc!(video;    "bink-video",    "Bink video"),
    desc!(video;    "bink2-video",   "Bink2 video"),
    desc!(audio;    "bink-audio-dct",   "Bink audio (DCT)"),
    desc!(audio;    "bink-audio-rdft",  "Bink audio (RDFT)"),

    desc!(audio;    "lhst15f8",      "L&H StreamTalk 15kbps at 8 kHz"),
    desc!(audio;    "lhst250f11",    "L&H StreamTalk 25kbps at 11 kHz"),
    desc!(audio;    "lhst500f22",    "L&H StreamTalk 50kpbs at 22 kHz"),
    desc!(audio;    "lhst48",        "L&H StreamTalk CELP Codec 4.8kbps at 8 kHz"),

    desc!(video;    "vivo1",         "VivoActive Video 1.0"),
    desc!(video;    "vivo2",         "VivoActive Video 2.0", CODEC_CAP_REORDER),
    desc!(audio;    "g723.1",        "ITU G.723.1"),
    desc!(audio;    "siren",         "Polycom Siren"),

    desc!(audio-ll;  "ape",          "Monkey's Audio"),
    desc!(audio-ll;  "flac",         "Free Lossless Audio Codec"),
    desc!(audio-ll;  "tta",          "True Audio codec"),
    desc!(audio-hyb; "wavpack",      "WavPack"),

    desc!(video-im; "jpeg",          "JPEG"),
    desc!(video;    "h264",          "ITU H.264", CODEC_CAP_COMPLEX_REORDER | CODEC_CAP_HYBRID),

    desc!(video-im; "mwv1",          "Aware MotionWavelets"),
];

static AVI_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
    (&[1, 0, 0, 0], "msrle"),
    (&[2, 0, 0, 0], "msrle"),

    (b"CRAM", "msvideo1"),
    (b"MSVC", "msvideo1"),
    (b"WHAM", "msvideo1"),

    (b"MJPG", "jpeg"),

    (b"IF09", "indeo1"),
    (b"RT21", "indeo2"),
    (b"IV31", "indeo3"),
    (b"IV32", "indeo3"),
    (b"IV41", "indeo4"),
    (b"IV50", "indeo5"),
    (b"I263", "intel263"),

    (b"UCOD", "clearvideo"),
    (b"cvid", "cinepak"),
    (b"ZMBV", "zmbv"),

    (b"Ipma", "ipma"),
    (b"Ip20", "ipma2"),

    (b"MVDV", "midivid"),
    (b"MV30", "midivid3"),
    (b"MVLZ", "midivid-ll"),

    (b"DUCK", "truemotion1"),
    (b"TR20", "truemotionrt"),
    (b"TM20", "truemotion2"),
    (b"TM2A", "truemotion2x"),
    (b"TM2X", "truemotion2x"),
    (b"VP30", "vp3"),
    (b"VP31", "vp3"),
    (b"VP40", "vp4"),
    (b"VP50", "vp5"),
    (b"VP60", "vp6"),
    (b"VP61", "vp6"),
    (b"VP62", "vp6"),
    (b"VP6A", "vp6a"),
    (b"VP70", "vp7"),

    (b"MWV1", "mwv1"),
];

static WAV_CODEC_REGISTER: &[(u16, &str)] = &[
    (0x0000, "unknown"),
    (0x0001, "pcm"),
    (0x0002, "ms-adpcm"),
    (0x0003, "pcm"),
    (0x0011, "ima-adpcm-ms"),
    (0x0061, "adpcm-dk4"),
    (0x0062, "adpcm-dk3"),
    (0x0401, "imc"),
    (0x0402, "iac"),
    (0x0500, "on2avc-500"),
    (0x0501, "on2avc-501"),
];

static MOV_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
    (b"cvid", "cinepak"),
    (b"jpeg", "jpeg"),
    //(b"raw ", "raw"),
    //(b"Yuv2", "raw"),
    (b"smc ", "qt-smc"),
    (b"rle ", "qt-rle"),
    (b"rpza", "apple-video"),
    (b"kpcd", "kodak-photocd"),
    //(b"mpeg", "mpeg-video"),
    (b"mjpa", "mjpeg-a"),
    (b"mjpb", "mjpeg-b"),
    (b"svqi", "sorenson-video"),
    (b"SVQ1", "sorenson-video"),
    (b"svq3", "sorenson-video3"),
    (b"SVQ3", "sorenson-video3"),

    (b"IV31", "indeo3"),
    (b"IV32", "indeo3"),

    (b"UCOD", "clearvideo"),

    (b"VP30", "vp3"),
    (b"VP31", "vp3"),

    (b"avc1", "h264"),
];

static MOV_AUDIO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
    (b"NONE", "pcm"),
    (b"raw ", "pcm"),
    (b"twos", "pcm"),
    (b"sowt", "pcm"),
    (b"fl32", "pcm"),
    (b"fl64", "pcm"),
    (b"in24", "pcm"),
    (b"in32", "pcm"),
    (b"MAC3", "mace-3"),
    (b"MAC6", "mace-6"),
    (b"ima4", "ima-adpcm-qt"),
    (b"ulaw", "ulaw"),
    (b"alaw", "alaw"),
    (b"dvca", "dv-audio"),
    (b"QDMC", "qdesign-music"),
    (b"QDM2", "qdesign-music2"),
    (b"Qclp", "qualcomm-purevoice"),
    //(b".mp3", "mpeg-layer3"),

    (b"mp4a", "aac"),

    (b"alac", "alac"),
];

/// 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 (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
        if *fourcc == fcc { return Some(name); }
    }
    None
}

/// Returns FOURCC (used in AVI format) for provided codec name.
pub fn find_avi_fourcc(codecname: &str) -> Option<[u8; 4]> {
    for (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
        if *name == codecname { return Some(**fourcc); }
    }
    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 (twocc, name) in WAV_CODEC_REGISTER.iter() {
        if *twocc == tcc { return Some(name); }
    }
    None
}

/// Returns TWOCC (used in WAV and AVI format for provided codec name.
pub fn find_wav_twocc(codecname: &str) -> Option<u16> {
    for (twocc, name) in WAV_CODEC_REGISTER.iter() {
        if *name == codecname { return Some(*twocc); }
    }
    None
}

/// Returns video codec short name for provided FOURCC (used in MOV format).
pub fn find_codec_from_mov_video_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
    for (fourcc, name) in MOV_VIDEO_CODEC_REGISTER.iter() {
        if *fourcc == fcc { return Some(name); }
    }
    None
}

/// Returns known audio codec short name for provided FOURCC (used in MOV format).
pub fn find_codec_from_mov_audio_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
    for (fourcc, name) in MOV_AUDIO_CODEC_REGISTER.iter() {
        if *fourcc == fcc { return Some(name); }
    }
    None
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn test_register() {
        let c1 = find_codec_from_avi_fourcc(b"IV41").unwrap();
        let c2 = find_codec_from_wav_twocc(0x401).unwrap();
        println!("found {} and {}", c1, c2);
        let cd1 = get_codec_description(c1).unwrap();
        let cd2 = get_codec_description(c2).unwrap();
        println!("got {} and {}", cd1, cd2);
    }
}
Commit	Line	Data
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	4	use std::fmt;
d48ee414 KS	5
285f4c72	6	/// Codec types.
34829caa	7	#[derive(Debug,Clone,Copy,PartialEq)]
d48ee414 KS	8	#[allow(dead_code)]
d48ee414 KS	9	pub 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
	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
2793026b KS	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;
8480761d KS	44	/// Codec capability flag for codecs with complex frame reordering.
8480761d KS	45	pub const CODEC_CAP_COMPLEX_REORDER:u32 = 0x0020;
d48ee414	46
285f4c72	47	/// Codec description structure.
34829caa	48	#[derive(Clone)]
d48ee414	49	pub 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
	62	impl 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
	83	impl 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
	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	});
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	}
d48ee414 KS	147
285f4c72	148	/// Returns codec description for the provided codec short name if it is found.
d48ee414	149	pub 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	158	static CODEC_REGISTER: &[CodecDescription] = &[
e8e022f4	159	desc!(audio-ll; "pcm", "PCM"),
3d5fb08f KS	160	desc!(audio; "alaw", "A-law PCM"),
3d5fb08f KS	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),
f7686373	168	desc!(video; "indeo5s", "Intel Indeo 5 Scalable", CODEC_CAP_SCALABLE),
1a36a05d	169	desc!(video; "intel263", "Intel I263", CODEC_CAP_REORDER),
45e794c4 KS	170	desc!(audio; "iac", "Intel Indeo audio"),
45e794c4 KS	171	desc!(audio; "imc", "Intel Music Coder"),
ce52b3b5 KS	172
ce52b3b5 KS	173	desc!(video; "realvideo1", "Real Video 1"),
6b2cdc84	174	desc!(video; "realvideo2", "Real Video 2", CODEC_CAP_REORDER),
ce52b3b5 KS	175	desc!(video; "realvideo3", "Real Video 3", CODEC_CAP_REORDER),
ce52b3b5 KS	176	desc!(video; "realvideo4", "Real Video 4", CODEC_CAP_REORDER),
0b791d5c	177	desc!(video; "realvideo6", "Real Video 6", CODEC_CAP_REORDER),
ce52b3b5	178	desc!(video; "clearvideo", "ClearVideo"),
750b299c	179	desc!(video; "clearvideo_rm", "ClearVideo"),
ce52b3b5 KS	180	desc!(audio; "ra14.4", "RealAudio 14.4"),
	181	desc!(audio; "ra28.8", "RealAudio 28.8"),
	182	desc!(audio; "cook", "RealAudio Cooker"),
	183	desc!(audio; "ralf", "RealAudio Lossless"),
	184	desc!(audio; "aac", "AAC"),
16dd4f44	185	desc!(audio; "ac3", "ETSI TS 102 366"),
ce52b3b5 KS	186	desc!(audio; "atrac3", "Sony Atrac3"),
ce52b3b5 KS	187	desc!(audio; "sipro", "Sipro Labs ADPCM"),
e8e022f4	188
a715e99f KS	189
a715e99f KS	190	desc!(video-ll; "rawvideo", "Raw video data"),
9a59c451	191	desc!(video-ll; "rawvideo-ms", "Raw video data"),
a715e99f	192
57777a0a KS	193	desc!(video; "cinepak", "Cinepak"),
57777a0a KS	194
19336baf KS	195	desc!(video-llp; "zmbv", "Zip Motion Blocks Video"),
19336baf KS	196
4abcd842	197	desc!(video; "msvideo1", "MS Video 1"),
03c406ea	198	desc!(video; "msrle", "MS RLE"),
4abcd842 KS	199	desc!(audio; "ms-adpcm", "MS ADPCM"),
	200	desc!(audio; "ima-adpcm-ms", "IMA ADPCM (MS variant)"),
	201
3d5fb08f KS	202	desc!(video; "qt-smc", "Apple Graphics"),
	203	desc!(video; "qt-rle", "Apple Animation"),
	204	desc!(video; "apple-video", "Apple video"),
	205	desc!(video; "sorenson-video", "Sorenson Video"),
8251c0ab	206	desc!(video; "sorenson-video3", "Sorenson Video 3", CODEC_CAP_REORDER),
40494a85	207	desc!(audio-ll; "alac", "Apple Lossless Audio Codec"),
3d5fb08f KS	208	desc!(audio; "mace-3", "MACE 3:1"),
	209	desc!(audio; "mace-6", "MACE 6:1"),
	210	desc!(audio; "ima-adpcm-qt", "IMA ADPCM (Apple variant)"),
	211	desc!(audio; "qdesign-music", "QDesign Music"),
	212	desc!(audio; "qdesign-music2", "QDesign Music v2"),
	213	desc!(audio; "qualcomm-purevoice", "Qualcomm PureVoice"),
	214
d24468d9 KS	215	desc!(video; "truemotion1", "TrueMotion 1"),
	216	desc!(video-im; "truemotionrt", "TrueMotion RT"),
	217	desc!(video; "truemotion2", "TrueMotion 2"),
e8e022f4 KS	218	desc!(video; "truemotion2x", "TrueMotion 2X"),
	219	desc!(video; "vp3", "VP3"),
	220	desc!(video; "vp4", "VP4"),
	221	desc!(video; "vp5", "VP5"),
	222	desc!(video; "vp6", "VP6"),
92d9fb69 KS	223	desc!(video; "vp6f", "VP6 (in Flash)"),
92d9fb69 KS	224	desc!(video; "vp6a", "VP6 with alpha"),
e8e022f4 KS	225	desc!(video; "vp7", "VP7"),
	226	desc!(video; "vp8", "VP8"),
	227	desc!(video; "vp9", "VP9"),
	228	desc!(audio; "adpcm-dk3", "Duck DK3 ADPCM"),
	229	desc!(audio; "adpcm-dk4", "Duck DK4 ADPCM"),
629a1025 KS	230	desc!(audio; "on2avc-500", "On2 AVC"),
629a1025 KS	231	desc!(audio; "on2avc-501", "On2 AVC"),
e8e022f4	232
92d9fb69 KS	233	desc!(video; "flv263", "Sorenson H.263"),
	234	desc!(video-llp; "flashsv", "Flash Screen Video"),
	235	desc!(video-llp; "flashsv2", "Flash Screen Video 2"),
	236	desc!(audio; "asao", "Nllyms*r ASAO"),
	237	desc!(audio; "flv-adpcm", "Flash ADPCM"),
	238
9f9a08fb KS	239	desc!(audio; "mp1", "MPEG Audio Layer I"),
9f9a08fb KS	240	desc!(audio; "mp2", "MPEG Audio Layer II"),
92d9fb69 KS	241	desc!(audio; "mp3", "MPEG Audio Layer III"),
	242	desc!(audio; "speex", "Speex"),
	243
e8e022f4 KS	244	desc!(video; "gdv-video", "Gremlin Digital Video - video"),
e8e022f4 KS	245	desc!(audio; "gdv-audio", "Gremlin Digital Video - audio"),
561d0f79 KS	246	desc!(video; "beam-fcp", "Beam Software Animation"),
561d0f79 KS	247	desc!(video; "beam-video", "Beam Software Video"),
e8e022f4 KS	248	desc!(video; "bmv-video", "BMV video"),
e8e022f4 KS	249	desc!(audio; "bmv-audio", "BMV audio"),
ecda1cc1 KS	250	desc!(video; "bmv3-video", "DW Noir BMV video"),
ecda1cc1 KS	251	desc!(audio; "bmv3-audio", "DW Noir BMV audio"),
3813fe8a	252	desc!(video; "fable-imax", "Fable IMAX video"),
8d91d85f KS	253	desc!(video; "fst-video", "FutureVision video"),
8d91d85f KS	254	desc!(audio; "fst-audio", "FutureVision audio"),
ff6a914f	255	desc!(video; "hl-fmv-video", "Highlander FMV video"),
d66e6055 KS	256	desc!(video-llp; "ipma", "Imagination Pilots Matte Animation"),
d66e6055 KS	257	desc!(video-llp; "ipma2", "Imagination Pilots Matte Animation v2"),
afe1e5ba	258	desc!(video; "legend-q-video", "Legend Entertainment Q video"),
801bba83 KS	259	desc!(video; "midivid", "MidiVid"),
	260	desc!(video; "midivid3", "MidiVid 3"),
	261	desc!(video-ll; "midivid-ll", "MidiVid Lossless"),
c17769db KS	262	desc!(video; "smushv1", "SMUSH Video paletted"),
	263	desc!(video; "smushv2", "SMUSH Video 16-bit"),
	264	desc!(video; "smush-iact", "SMUSH IACT Audio"),
	265	desc!(video; "smush-vima", "SMUSH VIMA Audio"),
9895bd7b KS	266	desc!(video; "vmd-video", "VMD video"),
9895bd7b KS	267	desc!(audio; "vmd-audio", "VMD audio"),
55d85231 KS	268	desc!(video; "vxvideo", "Actimagine Vx"),
55d85231 KS	269	desc!(audio; "vxaudio", "Actimagine Sx"),
e8e022f4 KS	270
	271	desc!(video; "smacker-video", "Smacker video"),
	272	desc!(audio; "smacker-audio", "Smacker audio"),
	273	desc!(video; "bink-video", "Bink video"),
	274	desc!(video; "bink2-video", "Bink2 video"),
	275	desc!(audio; "bink-audio-dct", "Bink audio (DCT)"),
	276	desc!(audio; "bink-audio-rdft", "Bink audio (RDFT)"),
ed374345 KS	277
	278	desc!(audio; "lhst15f8", "L&H StreamTalk 15kbps at 8 kHz"),
	279	desc!(audio; "lhst250f11", "L&H StreamTalk 25kbps at 11 kHz"),
	280	desc!(audio; "lhst500f22", "L&H StreamTalk 50kpbs at 22 kHz"),
	281	desc!(audio; "lhst48", "L&H StreamTalk CELP Codec 4.8kbps at 8 kHz"),
31cf33ac KS	282
	283	desc!(video; "vivo1", "VivoActive Video 1.0"),
	284	desc!(video; "vivo2", "VivoActive Video 2.0", CODEC_CAP_REORDER),
	285	desc!(audio; "g723.1", "ITU G.723.1"),
	286	desc!(audio; "siren", "Polycom Siren"),
87927c57 KS	287
	288	desc!(audio-ll; "ape", "Monkey's Audio"),
	289	desc!(audio-ll; "flac", "Free Lossless Audio Codec"),
	290	desc!(audio-ll; "tta", "True Audio codec"),
	291	desc!(audio-hyb; "wavpack", "WavPack"),
696e4e20	292
b5e49861	293	desc!(video-im; "jpeg", "JPEG"),
696e4e20	294	desc!(video; "h264", "ITU H.264", CODEC_CAP_COMPLEX_REORDER \| CODEC_CAP_HYBRID),
54915296 KS	295
54915296 KS	296	desc!(video-im; "mwv1", "Aware MotionWavelets"),
d48ee414 KS	297	];
d48ee414 KS	298
b7c882c1	299	static AVI_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
423005dc KS	300	(&[1, 0, 0, 0], "msrle"),
	301	(&[2, 0, 0, 0], "msrle"),
	302
4abcd842 KS	303	(b"CRAM", "msvideo1"),
	304	(b"MSVC", "msvideo1"),
	305	(b"WHAM", "msvideo1"),
	306
b5e49861 KS	307	(b"MJPG", "jpeg"),
b5e49861 KS	308
45e794c4 KS	309	(b"IF09", "indeo1"),
	310	(b"RT21", "indeo2"),
	311	(b"IV31", "indeo3"),
	312	(b"IV32", "indeo3"),
	313	(b"IV41", "indeo4"),
	314	(b"IV50", "indeo5"),
836bf150	315	(b"I263", "intel263"),
ce52b3b5	316
750b299c	317	(b"UCOD", "clearvideo"),
57777a0a	318	(b"cvid", "cinepak"),
19336baf	319	(b"ZMBV", "zmbv"),
b2d656d0	320
d66e6055 KS	321	(b"Ipma", "ipma"),
	322	(b"Ip20", "ipma2"),
	323
801bba83 KS	324	(b"MVDV", "midivid"),
	325	(b"MV30", "midivid3"),
	326	(b"MVLZ", "midivid-ll"),
	327
b2d656d0 KS	328	(b"DUCK", "truemotion1"),
	329	(b"TR20", "truemotionrt"),
	330	(b"TM20", "truemotion2"),
	331	(b"TM2A", "truemotion2x"),
	332	(b"TM2X", "truemotion2x"),
40e95291 KS	333	(b"VP30", "vp3"),
	334	(b"VP31", "vp3"),
	335	(b"VP40", "vp4"),
	336	(b"VP50", "vp5"),
	337	(b"VP60", "vp6"),
	338	(b"VP61", "vp6"),
	339	(b"VP62", "vp6"),
1bf8e0fc	340	(b"VP6A", "vp6a"),
40e95291	341	(b"VP70", "vp7"),
54915296 KS	342
54915296 KS	343	(b"MWV1", "mwv1"),
d48ee414 KS	344	];
d48ee414 KS	345
b7c882c1	346	static WAV_CODEC_REGISTER: &[(u16, &str)] = &[
9d9c811b	347	(0x0000, "unknown"),
45e794c4	348	(0x0001, "pcm"),
4abcd842	349	(0x0002, "ms-adpcm"),
45e794c4	350	(0x0003, "pcm"),
4abcd842	351	(0x0011, "ima-adpcm-ms"),
fadee95f KS	352	(0x0061, "adpcm-dk4"),
fadee95f KS	353	(0x0062, "adpcm-dk3"),
45e794c4 KS	354	(0x0401, "imc"),
45e794c4 KS	355	(0x0402, "iac"),
a38be6e4 KS	356	(0x0500, "on2avc-500"),
a38be6e4 KS	357	(0x0501, "on2avc-501"),
d48ee414 KS	358	];
d48ee414 KS	359
b7c882c1	360	static MOV_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
646f4c43 KS	361	(b"cvid", "cinepak"),
	362	(b"jpeg", "jpeg"),
	363	//(b"raw ", "raw"),
	364	//(b"Yuv2", "raw"),
	365	(b"smc ", "qt-smc"),
	366	(b"rle ", "qt-rle"),
	367	(b"rpza", "apple-video"),
	368	(b"kpcd", "kodak-photocd"),
	369	//(b"mpeg", "mpeg-video"),
	370	(b"mjpa", "mjpeg-a"),
	371	(b"mjpb", "mjpeg-b"),
	372	(b"svqi", "sorenson-video"),
b2689495	373	(b"SVQ1", "sorenson-video"),
3d5fb08f	374	(b"svq3", "sorenson-video3"),
b2689495	375	(b"SVQ3", "sorenson-video3"),
646f4c43 KS	376
	377	(b"IV31", "indeo3"),
	378	(b"IV32", "indeo3"),
	379
	380	(b"UCOD", "clearvideo"),
	381
	382	(b"VP30", "vp3"),
	383	(b"VP31", "vp3"),
696e4e20 KS	384
696e4e20 KS	385	(b"avc1", "h264"),
646f4c43 KS	386	];
646f4c43 KS	387
b7c882c1	388	static MOV_AUDIO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
646f4c43 KS	389	(b"NONE", "pcm"),
	390	(b"raw ", "pcm"),
	391	(b"twos", "pcm"),
	392	(b"sowt", "pcm"),
	393	(b"fl32", "pcm"),
	394	(b"fl64", "pcm"),
	395	(b"in24", "pcm"),
	396	(b"in32", "pcm"),
	397	(b"MAC3", "mace-3"),
	398	(b"MAC6", "mace-6"),
	399	(b"ima4", "ima-adpcm-qt"),
	400	(b"ulaw", "ulaw"),
	401	(b"alaw", "alaw"),
	402	(b"dvca", "dv-audio"),
	403	(b"QDMC", "qdesign-music"),
	404	(b"QDM2", "qdesign-music2"),
	405	(b"Qclp", "qualcomm-purevoice"),
	406	//(b".mp3", "mpeg-layer3"),
12881f89 KS	407
12881f89 KS	408	(b"mp4a", "aac"),
40494a85 KS	409
40494a85 KS	410	(b"alac", "alac"),
646f4c43 KS	411	];
646f4c43 KS	412
285f4c72	413	/// Returns video codec short name for provided FOURCC (used in AVI format).
d48ee414	414	pub fn find_codec_from_avi_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
e243ceb4 KS	415	for (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
e243ceb4 KS	416	if *fourcc == fcc { return Some(name); }
d48ee414 KS	417	}
	418	None
	419	}
	420
9a3ce86c KS	421	/// Returns FOURCC (used in AVI format) for provided codec name.
	422	pub fn find_avi_fourcc(codecname: &str) -> Option<[u8; 4]> {
	423	for (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
	424	if name == codecname { return Some(*fourcc); }
	425	}
	426	None
	427	}
	428
285f4c72	429	/// Returns known audio codec short name for provided TWOCC (used in WAV and AVI format).
d48ee414	430	pub fn find_codec_from_wav_twocc(tcc: u16) -> Option<&'static str> {
e243ceb4 KS	431	for (twocc, name) in WAV_CODEC_REGISTER.iter() {
e243ceb4 KS	432	if *twocc == tcc { return Some(name); }
d48ee414 KS	433	}
	434	None
	435	}
	436
9a3ce86c KS	437	/// Returns TWOCC (used in WAV and AVI format for provided codec name.
	438	pub fn find_wav_twocc(codecname: &str) -> Option<u16> {
	439	for (twocc, name) in WAV_CODEC_REGISTER.iter() {
	440	if name == codecname { return Some(twocc); }
	441	}
	442	None
	443	}
	444
646f4c43 KS	445	/// Returns video codec short name for provided FOURCC (used in MOV format).
	446	pub fn find_codec_from_mov_video_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
	447	for (fourcc, name) in MOV_VIDEO_CODEC_REGISTER.iter() {
	448	if *fourcc == fcc { return Some(name); }
	449	}
	450	None
	451	}
	452
	453	/// Returns known audio codec short name for provided FOURCC (used in MOV format).
	454	pub fn find_codec_from_mov_audio_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
	455	for (fourcc, name) in MOV_AUDIO_CODEC_REGISTER.iter() {
	456	if *fourcc == fcc { return Some(name); }
	457	}
	458	None
	459	}
	460
d48ee414 KS	461	#[cfg(test)]
	462	mod test {
	463	use super::*;
	464
	465	#[test]
	466	fn test_register() {
	467	let c1 = find_codec_from_avi_fourcc(b"IV41").unwrap();
	468	let c2 = find_codec_from_wav_twocc(0x401).unwrap();
	469	println!("found {} and {}", c1, c2);
	470	let cd1 = get_codec_description(c1).unwrap();
	471	let cd2 = get_codec_description(c2).unwrap();
	472	println!("got {} and {}", cd1, cd2);
	473	}
b58d7656	474	}