tim2 0.3.1

An image loader for TIM2 (.tm2) image files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use crate::common::*;
use crate::error::Error;
use crate::frame::Frame;

use byteorder::{ByteOrder, BigEndian, LittleEndian};
use std::fs::File;
use std::io::prelude::*;
use std::path::Path;

const IDENT: u32 = 0x54494d32;

#[derive(Debug)]
struct Header {
	identifier: u32,
	version: u16,
	count: usize,
}

impl Header {
	fn read(buffer: &[u8], offset: &mut usize) -> Result<Header, Error> {
		let mut load_part = |size| { get_slice(&buffer, offset, size) };
		let identifier = BigEndian::read_u32(load_part(4));
		let version = LittleEndian::read_u16(load_part(2));
		let count = LittleEndian::read_u16(load_part(2)) as usize;

		load_part(8);
		if identifier != IDENT {
			return Err(Error::InvalidIdentifier(identifier))
		}

		Ok(Header { identifier, version, count })
	}
}

#[derive(Debug)]
pub struct Image {
	header: Header,
	frames: Vec::<Frame>,
}

impl Image {
	fn read(buffer: &[u8], offset: &mut usize) -> Result<Image, Error> {
		let header = Header::read(buffer, offset)?;
		let mut frames = Vec::with_capacity(header.count);

		for _ in 0..header.count {
			frames.push(Frame::read(buffer, offset)?);
		}

		Ok(Image { header, frames })
	}

	pub fn frames(&self) -> &Vec::<Frame> {
		&self.frames
	}

	pub fn get_frame(&self, index: usize) -> &Frame {
		&self.frames[index]
	}
}

/// Loads a TIM2 image file into memory from buffer.
///
/// # Examples
///
/// ```
/// use std::fs::File;
/// use std::io::prelude::*;
/// 
/// fn main() {
///     let mut buffer = Vec::new();
///     let mut file = File::open("../assets/test.tm2").unwrap();
///     file.read_to_end(&mut buffer).unwrap();
/// 
///     let image = tim2::from_buffer(&buffer).unwrap();
/// 
///     /* print the header info for each frame found */
///     for (i, frame) in image.frames().iter().enumerate() {
///         println!("frame[{}]: <{}  {}>", i, frame.width(), frame.height());
///     }
/// }
/// ```
pub fn from_buffer(buffer: &[u8]) -> Result<Image, Error> {
	let mut offset = 0usize;

	Image::read(&buffer, &mut offset)
}

/// Loads a TIM2 image file into memory.
///
/// # Examples
///
/// ```
/// fn main() {
///     let image = tim2::load("../assets/test.tm2").unwrap();
/// 
///     /* print the header info for each frame found */
///     for (i, frame) in image.frames().iter().enumerate() {
///         println!("frame[{}]: <{}  {}>", i, frame.width(), frame.height());
///     }
/// }
/// ```
pub fn load<P: AsRef<Path>>(path: P) -> Result<Image, Error> {
	let mut offset = 0usize;
	let mut buffer = Vec::new();
	let mut file = File::open(path)?;

	file.read_to_end(&mut buffer)?;
	Image::read(&buffer, &mut offset)
}