[nihav.git] / nihav-codec-support / src / test / mod.rs

//! Decoder testing functionality.
//!
//! This module provides functions that may be used in internal test to check that decoders produce output and that they produce expected output.
pub mod dec_video;
pub mod wavwriter;

mod md5; // for internal checksums only

/// Decoder testing modes.
///
/// NihAV has its own MD5 hasher that calculates hash for input frame in a deterministic way (i.e. no endianness issues) and it outputs hash as `[u32; 4]`. During testing the resulting hash will be printed out so when the test fails you can find what was the calculated hash (and use it as a reference if you are implementing a new test).
pub enum ExpectedTestResult {
    /// Decoding runs without errors.
    Decodes,
    /// Full decoded output is expected to be equal to this MD5 hash.
    MD5([u32; 4]),
    /// Each decoded frame hash should be equal to the corresponding MD5 hash.
    MD5Frames(Vec<[u32; 4]>),
    /// Test function should report decoded frame hashes to be used as the reference later.
    GenerateMD5Frames,
}
Commit	Line	Data
fb8e3177 KS	1	//! Decoder testing functionality.
	2	//!
	3	//! This module provides functions that may be used in internal test to check that decoders produce output and that they produce expected output.
379fd781	4	pub mod dec_video;
cc0859d6	5	pub mod wavwriter;
eca0802b KS	6
	7	mod md5; // for internal checksums only
	8
fb8e3177 KS	9	/// Decoder testing modes.
	10	///
	11	/// NihAV has its own MD5 hasher that calculates hash for input frame in a deterministic way (i.e. no endianness issues) and it outputs hash as `[u32; 4]`. During testing the resulting hash will be printed out so when the test fails you can find what was the calculated hash (and use it as a reference if you are implementing a new test).
eca0802b	12	pub enum ExpectedTestResult {
fb8e3177	13	/// Decoding runs without errors.
eca0802b	14	Decodes,
fb8e3177	15	/// Full decoded output is expected to be equal to this MD5 hash.
eca0802b	16	MD5([u32; 4]),
fb8e3177	17	/// Each decoded frame hash should be equal to the corresponding MD5 hash.
eca0802b	18	MD5Frames(Vec<[u32; 4]>),
fb8e3177	19	/// Test function should report decoded frame hashes to be used as the reference later.
eca0802b KS	20	GenerateMD5Frames,
eca0802b KS	21	}