[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> {
    CODEC_REGISTER.iter().find(|&reg| reg.name == name)
}

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-im; "arxel-video",   "Arxel Tribe Video"),
    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> {
e6aaad5c	150	CODEC_REGISTER.iter().find(\|&reg\| reg.name == name)
d48ee414 KS	151	}
d48ee414 KS	152
b7c882c1	153	static CODEC_REGISTER: &[CodecDescription] = &[
e8e022f4	154	desc!(audio-ll; "pcm", "PCM"),
3d5fb08f KS	155	desc!(audio; "alaw", "A-law PCM"),
3d5fb08f KS	156	desc!(audio; "ulaw", "mu-law PCM"),
e8e022f4	157
45e794c4 KS	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),
f7686373	163	desc!(video; "indeo5s", "Intel Indeo 5 Scalable", CODEC_CAP_SCALABLE),
1a36a05d	164	desc!(video; "intel263", "Intel I263", CODEC_CAP_REORDER),
45e794c4 KS	165	desc!(audio; "iac", "Intel Indeo audio"),
45e794c4 KS	166	desc!(audio; "imc", "Intel Music Coder"),
ce52b3b5 KS	167
ce52b3b5 KS	168	desc!(video; "realvideo1", "Real Video 1"),
6b2cdc84	169	desc!(video; "realvideo2", "Real Video 2", CODEC_CAP_REORDER),
ce52b3b5 KS	170	desc!(video; "realvideo3", "Real Video 3", CODEC_CAP_REORDER),
ce52b3b5 KS	171	desc!(video; "realvideo4", "Real Video 4", CODEC_CAP_REORDER),
0b791d5c	172	desc!(video; "realvideo6", "Real Video 6", CODEC_CAP_REORDER),
ce52b3b5	173	desc!(video; "clearvideo", "ClearVideo"),
750b299c	174	desc!(video; "clearvideo_rm", "ClearVideo"),
ce52b3b5 KS	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"),
16dd4f44	180	desc!(audio; "ac3", "ETSI TS 102 366"),
ce52b3b5 KS	181	desc!(audio; "atrac3", "Sony Atrac3"),
ce52b3b5 KS	182	desc!(audio; "sipro", "Sipro Labs ADPCM"),
e8e022f4	183
a715e99f KS	184
a715e99f KS	185	desc!(video-ll; "rawvideo", "Raw video data"),
9a59c451	186	desc!(video-ll; "rawvideo-ms", "Raw video data"),
a715e99f	187
57777a0a KS	188	desc!(video; "cinepak", "Cinepak"),
57777a0a KS	189
19336baf KS	190	desc!(video-llp; "zmbv", "Zip Motion Blocks Video"),
19336baf KS	191
4abcd842	192	desc!(video; "msvideo1", "MS Video 1"),
03c406ea	193	desc!(video; "msrle", "MS RLE"),
4abcd842 KS	194	desc!(audio; "ms-adpcm", "MS ADPCM"),
	195	desc!(audio; "ima-adpcm-ms", "IMA ADPCM (MS variant)"),
	196
3d5fb08f KS	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"),
8251c0ab	201	desc!(video; "sorenson-video3", "Sorenson Video 3", CODEC_CAP_REORDER),
40494a85	202	desc!(audio-ll; "alac", "Apple Lossless Audio Codec"),
3d5fb08f KS	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
d24468d9 KS	210	desc!(video; "truemotion1", "TrueMotion 1"),
	211	desc!(video-im; "truemotionrt", "TrueMotion RT"),
	212	desc!(video; "truemotion2", "TrueMotion 2"),
e8e022f4 KS	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"),
92d9fb69 KS	218	desc!(video; "vp6f", "VP6 (in Flash)"),
92d9fb69 KS	219	desc!(video; "vp6a", "VP6 with alpha"),
e8e022f4 KS	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"),
629a1025 KS	225	desc!(audio; "on2avc-500", "On2 AVC"),
629a1025 KS	226	desc!(audio; "on2avc-501", "On2 AVC"),
e8e022f4	227
92d9fb69 KS	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", "Nllyms*r ASAO"),
	232	desc!(audio; "flv-adpcm", "Flash ADPCM"),
	233
9f9a08fb KS	234	desc!(audio; "mp1", "MPEG Audio Layer I"),
9f9a08fb KS	235	desc!(audio; "mp2", "MPEG Audio Layer II"),
92d9fb69 KS	236	desc!(audio; "mp3", "MPEG Audio Layer III"),
	237	desc!(audio; "speex", "Speex"),
	238
e8e022f4 KS	239	desc!(video; "gdv-video", "Gremlin Digital Video - video"),
e8e022f4 KS	240	desc!(audio; "gdv-audio", "Gremlin Digital Video - audio"),
1991b7da	241	desc!(video-im; "arxel-video", "Arxel Tribe Video"),
561d0f79 KS	242	desc!(video; "beam-fcp", "Beam Software Animation"),
561d0f79 KS	243	desc!(video; "beam-video", "Beam Software Video"),
e8e022f4 KS	244	desc!(video; "bmv-video", "BMV video"),
e8e022f4 KS	245	desc!(audio; "bmv-audio", "BMV audio"),
ecda1cc1 KS	246	desc!(video; "bmv3-video", "DW Noir BMV video"),
ecda1cc1 KS	247	desc!(audio; "bmv3-audio", "DW Noir BMV audio"),
3813fe8a	248	desc!(video; "fable-imax", "Fable IMAX video"),
8d91d85f KS	249	desc!(video; "fst-video", "FutureVision video"),
8d91d85f KS	250	desc!(audio; "fst-audio", "FutureVision audio"),
ff6a914f	251	desc!(video; "hl-fmv-video", "Highlander FMV video"),
d66e6055 KS	252	desc!(video-llp; "ipma", "Imagination Pilots Matte Animation"),
d66e6055 KS	253	desc!(video-llp; "ipma2", "Imagination Pilots Matte Animation v2"),
afe1e5ba	254	desc!(video; "legend-q-video", "Legend Entertainment Q video"),
801bba83 KS	255	desc!(video; "midivid", "MidiVid"),
	256	desc!(video; "midivid3", "MidiVid 3"),
	257	desc!(video-ll; "midivid-ll", "MidiVid Lossless"),
c17769db KS	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"),
9895bd7b KS	262	desc!(video; "vmd-video", "VMD video"),
9895bd7b KS	263	desc!(audio; "vmd-audio", "VMD audio"),
55d85231 KS	264	desc!(video; "vxvideo", "Actimagine Vx"),
55d85231 KS	265	desc!(audio; "vxaudio", "Actimagine Sx"),
e8e022f4 KS	266
	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)"),
ed374345 KS	273
	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"),
31cf33ac KS	278
	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"),
87927c57 KS	283
	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"),
696e4e20	288
b5e49861	289	desc!(video-im; "jpeg", "JPEG"),
696e4e20	290	desc!(video; "h264", "ITU H.264", CODEC_CAP_COMPLEX_REORDER \| CODEC_CAP_HYBRID),
54915296 KS	291
54915296 KS	292	desc!(video-im; "mwv1", "Aware MotionWavelets"),
d48ee414 KS	293	];
d48ee414 KS	294
b7c882c1	295	static AVI_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
423005dc KS	296	(&[1, 0, 0, 0], "msrle"),
	297	(&[2, 0, 0, 0], "msrle"),
	298
4abcd842 KS	299	(b"CRAM", "msvideo1"),
	300	(b"MSVC", "msvideo1"),
	301	(b"WHAM", "msvideo1"),
	302
b5e49861 KS	303	(b"MJPG", "jpeg"),
b5e49861 KS	304
45e794c4 KS	305	(b"IF09", "indeo1"),
	306	(b"RT21", "indeo2"),
	307	(b"IV31", "indeo3"),
	308	(b"IV32", "indeo3"),
	309	(b"IV41", "indeo4"),
	310	(b"IV50", "indeo5"),
836bf150	311	(b"I263", "intel263"),
ce52b3b5	312
750b299c	313	(b"UCOD", "clearvideo"),
57777a0a	314	(b"cvid", "cinepak"),
19336baf	315	(b"ZMBV", "zmbv"),
b2d656d0	316
d66e6055 KS	317	(b"Ipma", "ipma"),
	318	(b"Ip20", "ipma2"),
	319
801bba83 KS	320	(b"MVDV", "midivid"),
	321	(b"MV30", "midivid3"),
	322	(b"MVLZ", "midivid-ll"),
	323
b2d656d0 KS	324	(b"DUCK", "truemotion1"),
	325	(b"TR20", "truemotionrt"),
	326	(b"TM20", "truemotion2"),
	327	(b"TM2A", "truemotion2x"),
	328	(b"TM2X", "truemotion2x"),
40e95291 KS	329	(b"VP30", "vp3"),
	330	(b"VP31", "vp3"),
	331	(b"VP40", "vp4"),
	332	(b"VP50", "vp5"),
	333	(b"VP60", "vp6"),
	334	(b"VP61", "vp6"),
	335	(b"VP62", "vp6"),
1bf8e0fc	336	(b"VP6A", "vp6a"),
40e95291	337	(b"VP70", "vp7"),
54915296 KS	338
54915296 KS	339	(b"MWV1", "mwv1"),
d48ee414 KS	340	];
d48ee414 KS	341
b7c882c1	342	static WAV_CODEC_REGISTER: &[(u16, &str)] = &[
9d9c811b	343	(0x0000, "unknown"),
45e794c4	344	(0x0001, "pcm"),
4abcd842	345	(0x0002, "ms-adpcm"),
45e794c4	346	(0x0003, "pcm"),
4abcd842	347	(0x0011, "ima-adpcm-ms"),
fadee95f KS	348	(0x0061, "adpcm-dk4"),
fadee95f KS	349	(0x0062, "adpcm-dk3"),
45e794c4 KS	350	(0x0401, "imc"),
45e794c4 KS	351	(0x0402, "iac"),
a38be6e4 KS	352	(0x0500, "on2avc-500"),
a38be6e4 KS	353	(0x0501, "on2avc-501"),
d48ee414 KS	354	];
d48ee414 KS	355
b7c882c1	356	static MOV_VIDEO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
646f4c43 KS	357	(b"cvid", "cinepak"),
	358	(b"jpeg", "jpeg"),
	359	//(b"raw ", "raw"),
	360	//(b"Yuv2", "raw"),
	361	(b"smc ", "qt-smc"),
	362	(b"rle ", "qt-rle"),
	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"),
b2689495	369	(b"SVQ1", "sorenson-video"),
3d5fb08f	370	(b"svq3", "sorenson-video3"),
b2689495	371	(b"SVQ3", "sorenson-video3"),
646f4c43 KS	372
	373	(b"IV31", "indeo3"),
	374	(b"IV32", "indeo3"),
	375
	376	(b"UCOD", "clearvideo"),
	377
	378	(b"VP30", "vp3"),
	379	(b"VP31", "vp3"),
696e4e20 KS	380
696e4e20 KS	381	(b"avc1", "h264"),
646f4c43 KS	382	];
646f4c43 KS	383
b7c882c1	384	static MOV_AUDIO_CODEC_REGISTER: &[(&[u8;4], &str)] = &[
646f4c43 KS	385	(b"NONE", "pcm"),
	386	(b"raw ", "pcm"),
	387	(b"twos", "pcm"),
	388	(b"sowt", "pcm"),
	389	(b"fl32", "pcm"),
	390	(b"fl64", "pcm"),
	391	(b"in24", "pcm"),
	392	(b"in32", "pcm"),
	393	(b"MAC3", "mace-3"),
	394	(b"MAC6", "mace-6"),
	395	(b"ima4", "ima-adpcm-qt"),
	396	(b"ulaw", "ulaw"),
	397	(b"alaw", "alaw"),
	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"),
12881f89 KS	403
12881f89 KS	404	(b"mp4a", "aac"),
40494a85 KS	405
40494a85 KS	406	(b"alac", "alac"),
646f4c43 KS	407	];
646f4c43 KS	408
285f4c72	409	/// Returns video codec short name for provided FOURCC (used in AVI format).
d48ee414	410	pub fn find_codec_from_avi_fourcc(fcc: &[u8;4]) -> Option<&'static str> {
e243ceb4 KS	411	for (fourcc, name) in AVI_VIDEO_CODEC_REGISTER.iter() {
e243ceb4 KS	412	if *fourcc == fcc { return Some(name); }
d48ee414 KS	413	}
	414	None
	415	}
	416
9a3ce86c KS	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); }
	421	}
	422	None
	423	}
	424
285f4c72	425	/// Returns known audio codec short name for provided TWOCC (used in WAV and AVI format).
d48ee414	426	pub fn find_codec_from_wav_twocc(tcc: u16) -> Option<&'static str> {
e243ceb4 KS	427	for (twocc, name) in WAV_CODEC_REGISTER.iter() {
e243ceb4 KS	428	if *twocc == tcc { return Some(name); }
d48ee414 KS	429	}
	430	None
	431	}
	432
9a3ce86c KS	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); }
	437	}
	438	None
	439	}
	440
646f4c43 KS	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); }
	445	}
	446	None
	447	}
	448
	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); }
	453	}
	454	None
	455	}
	456
d48ee414 KS	457	#[cfg(test)]
	458	mod test {
	459	use super::*;
	460
	461	#[test]
	462	fn test_register() {
	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);
	469	}
b58d7656	470	}