Commit | Line | Data |
---|---|---|
33b5689a KS |
1 | //! Audio and image sample format definitions. |
2 | //! | |
3 | //! NihAV does not have a fixed list of supported formats but rather accepts format definitions both for audio and video. | |
4 | //! In result exotic formats like YUV410+alpha plane that is used by Indeo 4 are supported without any additional case handing. | |
5 | //! Some common format definitions are provided as constants for convenience. | |
32ce974d | 6 | use std::str::FromStr; |
fba6f8e4 KS |
7 | use std::string::*; |
8 | use std::fmt; | |
9 | ||
33b5689a KS |
10 | /// Audio format definition. |
11 | /// | |
12 | /// The structure describes how audio samples are stored and what characteristics they have. | |
b68ff5ae | 13 | #[derive(Debug,Copy,Clone,PartialEq)] |
fba6f8e4 | 14 | pub struct NASoniton { |
33b5689a | 15 | /// Bits per sample. |
a92a5113 | 16 | pub bits: u8, |
33b5689a | 17 | /// Audio format is big-endian. |
a92a5113 | 18 | pub be: bool, |
33b5689a | 19 | /// Audio samples are packed (e.g. 20-bit audio samples). |
a92a5113 | 20 | pub packed: bool, |
33b5689a | 21 | /// Audio data is stored in planar format instead of interleaving samples for different channels. |
a92a5113 | 22 | pub planar: bool, |
33b5689a | 23 | /// Audio data is in floating point format. |
a92a5113 | 24 | pub float: bool, |
33b5689a | 25 | /// Audio data is signed (usually only 8-bit audio is unsigned). |
a92a5113 | 26 | pub signed: bool, |
fba6f8e4 KS |
27 | } |
28 | ||
33b5689a KS |
29 | /// Flag for specifying that audio format is big-endian in `NASoniton::`[`new`]`()`. Related to [`be`] field of `NASoniton`. |
30 | /// | |
31 | /// [`new`]: ./struct.NASoniton.html#method.new | |
32 | /// [`be`]: ./struct.NASoniton.html#structfield.be | |
9e9a3af1 | 33 | pub const SONITON_FLAG_BE :u32 = 0x01; |
33b5689a KS |
34 | /// Flag for specifying that audio format has packed samples in `NASoniton::`[`new`]`()`. Related to [`packed`] field of `NASoniton`. |
35 | /// | |
36 | /// [`new`]: ./struct.NASoniton.html#method.new | |
37 | /// [`packed`]: ./struct.NASoniton.html#structfield.packed | |
9e9a3af1 | 38 | pub const SONITON_FLAG_PACKED :u32 = 0x02; |
33b5689a KS |
39 | /// Flag for specifying that audio data is stored as planar in `NASoniton::`[`new`]`()`. Related to [`planar`] field of `NASoniton`. |
40 | /// | |
41 | /// [`new`]: ./struct.NASoniton.html#method.new | |
42 | /// [`planar`]: ./struct.NASoniton.html#structfield.planar | |
9e9a3af1 | 43 | pub const SONITON_FLAG_PLANAR :u32 = 0x04; |
33b5689a KS |
44 | /// Flag for specifying that audio samples are in floating point format in `NASoniton::`[`new`]`()`. Related to [`float`] field of `NASoniton`. |
45 | /// | |
46 | /// [`new`]: ./struct.NASoniton.html#method.new | |
47 | /// [`float`]: ./struct.NASoniton.html#structfield.float | |
9e9a3af1 | 48 | pub const SONITON_FLAG_FLOAT :u32 = 0x08; |
33b5689a KS |
49 | /// Flag for specifying that audio format is signed in `NASoniton::`[`new`]`()`. Related to [`signed`] field of `NASoniton`. |
50 | /// | |
51 | /// [`new`]: ./struct.NASoniton.html#method.new | |
52 | /// [`signed`]: ./struct.NASoniton.html#structfield.signed | |
9e9a3af1 | 53 | pub const SONITON_FLAG_SIGNED :u32 = 0x10; |
fba6f8e4 | 54 | |
33b5689a | 55 | /// Predefined format for interleaved 8-bit unsigned audio. |
fba6f8e4 | 56 | pub const SND_U8_FORMAT: NASoniton = NASoniton { bits: 8, be: false, packed: false, planar: false, float: false, signed: false }; |
33b5689a | 57 | /// Predefined format for interleaved 16-bit signed audio. |
fba6f8e4 | 58 | pub const SND_S16_FORMAT: NASoniton = NASoniton { bits: 16, be: false, packed: false, planar: false, float: false, signed: true }; |
33b5689a | 59 | /// Predefined format for planar 16-bit signed audio. |
49fde921 | 60 | pub const SND_S16P_FORMAT: NASoniton = NASoniton { bits: 16, be: false, packed: false, planar: true, float: false, signed: true }; |
33b5689a | 61 | /// Predefined format for planar 32-bit floating point audio. |
126b7eb8 | 62 | pub const SND_F32P_FORMAT: NASoniton = NASoniton { bits: 32, be: false, packed: false, planar: true, float: true, signed: true }; |
fba6f8e4 KS |
63 | |
64 | impl NASoniton { | |
33b5689a KS |
65 | /// Constructs a new audio format definition using flags like [`SONITON_FLAG_BE`]. |
66 | /// | |
67 | /// [`SONITON_FLAG_BE`]: ./constant.SONITON_FLAG_BE.html | |
9e9a3af1 KS |
68 | pub fn new(bits: u8, flags: u32) -> Self { |
69 | let is_be = (flags & SONITON_FLAG_BE) != 0; | |
70 | let is_pk = (flags & SONITON_FLAG_PACKED) != 0; | |
71 | let is_pl = (flags & SONITON_FLAG_PLANAR) != 0; | |
72 | let is_fl = (flags & SONITON_FLAG_FLOAT) != 0; | |
73 | let is_sg = (flags & SONITON_FLAG_SIGNED) != 0; | |
e243ceb4 | 74 | NASoniton { bits, be: is_be, packed: is_pk, planar: is_pl, float: is_fl, signed: is_sg } |
fba6f8e4 KS |
75 | } |
76 | ||
33b5689a | 77 | /// Returns the number of bits per sample. |
e243ceb4 | 78 | pub fn get_bits(self) -> u8 { self.bits } |
33b5689a | 79 | /// Reports whether the format is big-endian. |
e243ceb4 | 80 | pub fn is_be(self) -> bool { self.be } |
33b5689a | 81 | /// Reports whether the format has packed samples. |
e243ceb4 | 82 | pub fn is_packed(self) -> bool { self.packed } |
33b5689a | 83 | /// Reports whether audio data is planar instead of interleaved. |
e243ceb4 | 84 | pub fn is_planar(self) -> bool { self.planar } |
33b5689a | 85 | /// Reports whether audio samples are in floating point format. |
e243ceb4 | 86 | pub fn is_float(self) -> bool { self.float } |
33b5689a | 87 | /// Reports whether audio samples are signed. |
e243ceb4 | 88 | pub fn is_signed(self) -> bool { self.signed } |
15e41b31 | 89 | |
33b5689a | 90 | /// Returns the amount of bytes needed to store the audio of requested length (in samples). |
e243ceb4 | 91 | pub fn get_audio_size(self, length: u64) -> usize { |
15e41b31 | 92 | if self.packed { |
e243ceb4 | 93 | ((length * u64::from(self.bits) + 7) >> 3) as usize |
15e41b31 | 94 | } else { |
e243ceb4 | 95 | (length * u64::from((self.bits + 7) >> 3)) as usize |
15e41b31 KS |
96 | } |
97 | } | |
11d889bb KS |
98 | |
99 | /// Returns soniton description as a short string. | |
100 | pub fn to_short_string(&self) -> String { | |
101 | let ltype = if self.float { 'f' } else if self.signed { 's' } else { 'u' }; | |
102 | let endianness = if self.bits == 8 { "" } else if self.be { "be" } else { "le" }; | |
103 | let planar = if self.planar { "p" } else { "" }; | |
104 | let packed = if self.packed { "x" } else { "" }; | |
105 | format!("{}{}{}{}{}", ltype, self.bits, endianness, planar, packed) | |
106 | } | |
fba6f8e4 KS |
107 | } |
108 | ||
109 | impl fmt::Display for NASoniton { | |
110 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |
111 | let fmt = if self.float { "float" } else if self.signed { "int" } else { "uint" }; | |
112 | let end = if self.be { "BE" } else { "LE" }; | |
113 | write!(f, "({} bps, {} planar: {} packed: {} {})", self.bits, end, self.packed, self.planar, fmt) | |
114 | } | |
115 | } | |
116 | ||
11d889bb KS |
117 | /// Generic soniton parsing error. |
118 | #[derive(Clone,Copy,Debug,PartialEq)] | |
119 | pub struct SonitonParseError {} | |
120 | ||
121 | impl FromStr for NASoniton { | |
122 | type Err = SonitonParseError; | |
123 | ||
124 | fn from_str(s: &str) -> Result<Self, Self::Err> { | |
125 | match s { | |
126 | "u8" => Ok(NASoniton { bits: 8, be: true, packed: false, planar: false, float: false, signed: false }), | |
127 | "s16be" => Ok(NASoniton { bits: 16, be: true, packed: false, planar: false, float: false, signed: true }), | |
128 | "s16le" => Ok(NASoniton { bits: 16, be: false, packed: false, planar: false, float: false, signed: true }), | |
129 | "s24be" => Ok(NASoniton { bits: 24, be: true, packed: false, planar: false, float: false, signed: true }), | |
130 | "s24le" => Ok(NASoniton { bits: 24, be: false, packed: false, planar: false, float: false, signed: true }), | |
131 | "s32be" => Ok(NASoniton { bits: 32, be: true, packed: false, planar: false, float: false, signed: true }), | |
132 | "s32le" => Ok(NASoniton { bits: 32, be: false, packed: false, planar: false, float: false, signed: true }), | |
133 | "f32be" => Ok(NASoniton { bits: 32, be: true, packed: false, planar: false, float: true, signed: true }), | |
134 | "f32le" => Ok(NASoniton { bits: 32, be: false, packed: false, planar: false, float: true, signed: true }), | |
135 | _ => Err(SonitonParseError{}), | |
136 | } | |
137 | } | |
138 | } | |
139 | ||
33b5689a | 140 | /// Known channel types. |
10a00d52 | 141 | #[derive(Debug,Clone,Copy,PartialEq)] |
fba6f8e4 KS |
142 | pub enum NAChannelType { |
143 | C, L, R, Cs, Ls, Rs, Lss, Rss, LFE, Lc, Rc, Lh, Rh, Ch, LFE2, Lw, Rw, Ov, Lhs, Rhs, Chs, Ll, Rl, Cl, Lt, Rt, Lo, Ro | |
144 | } | |
145 | ||
146 | impl NAChannelType { | |
33b5689a | 147 | /// Reports whether this is some center channel. |
e243ceb4 KS |
148 | pub fn is_center(self) -> bool { |
149 | match self { | |
fba6f8e4 KS |
150 | NAChannelType::C => true, NAChannelType::Ch => true, |
151 | NAChannelType::Cl => true, NAChannelType::Ov => true, | |
152 | NAChannelType::LFE => true, NAChannelType::LFE2 => true, | |
153 | NAChannelType::Cs => true, NAChannelType::Chs => true, | |
154 | _ => false, | |
155 | } | |
156 | } | |
33b5689a | 157 | /// Reports whether this is some left channel. |
e243ceb4 KS |
158 | pub fn is_left(self) -> bool { |
159 | match self { | |
fba6f8e4 KS |
160 | NAChannelType::L => true, NAChannelType::Ls => true, |
161 | NAChannelType::Lss => true, NAChannelType::Lc => true, | |
162 | NAChannelType::Lh => true, NAChannelType::Lw => true, | |
163 | NAChannelType::Lhs => true, NAChannelType::Ll => true, | |
164 | NAChannelType::Lt => true, NAChannelType::Lo => true, | |
165 | _ => false, | |
166 | } | |
167 | } | |
33b5689a | 168 | /// Reports whether this is some right channel. |
e243ceb4 KS |
169 | pub fn is_right(self) -> bool { |
170 | match self { | |
fba6f8e4 KS |
171 | NAChannelType::R => true, NAChannelType::Rs => true, |
172 | NAChannelType::Rss => true, NAChannelType::Rc => true, | |
173 | NAChannelType::Rh => true, NAChannelType::Rw => true, | |
174 | NAChannelType::Rhs => true, NAChannelType::Rl => true, | |
175 | NAChannelType::Rt => true, NAChannelType::Ro => true, | |
176 | _ => false, | |
177 | } | |
178 | } | |
179 | } | |
180 | ||
33b5689a | 181 | /// Generic channel configuration parsing error. |
32ce974d KS |
182 | #[derive(Clone,Copy,Debug,PartialEq)] |
183 | pub struct ChannelParseError {} | |
184 | ||
185 | impl FromStr for NAChannelType { | |
186 | type Err = ChannelParseError; | |
187 | ||
188 | fn from_str(s: &str) -> Result<Self, Self::Err> { | |
189 | match s { | |
190 | "C" => Ok(NAChannelType::C), | |
191 | "L" => Ok(NAChannelType::L), | |
192 | "R" => Ok(NAChannelType::R), | |
193 | "Cs" => Ok(NAChannelType::Cs), | |
194 | "Ls" => Ok(NAChannelType::Ls), | |
195 | "Rs" => Ok(NAChannelType::Rs), | |
196 | "Lss" => Ok(NAChannelType::Lss), | |
197 | "Rss" => Ok(NAChannelType::Rss), | |
198 | "LFE" => Ok(NAChannelType::LFE), | |
199 | "Lc" => Ok(NAChannelType::Lc), | |
200 | "Rc" => Ok(NAChannelType::Rc), | |
201 | "Lh" => Ok(NAChannelType::Lh), | |
202 | "Rh" => Ok(NAChannelType::Rh), | |
203 | "Ch" => Ok(NAChannelType::Ch), | |
204 | "LFE2" => Ok(NAChannelType::LFE2), | |
205 | "Lw" => Ok(NAChannelType::Lw), | |
206 | "Rw" => Ok(NAChannelType::Rw), | |
207 | "Ov" => Ok(NAChannelType::Ov), | |
208 | "Lhs" => Ok(NAChannelType::Lhs), | |
209 | "Rhs" => Ok(NAChannelType::Rhs), | |
210 | "Chs" => Ok(NAChannelType::Chs), | |
211 | "Ll" => Ok(NAChannelType::Ll), | |
212 | "Rl" => Ok(NAChannelType::Rl), | |
213 | "Cl" => Ok(NAChannelType::Cl), | |
214 | "Lt" => Ok(NAChannelType::Lt), | |
215 | "Rt" => Ok(NAChannelType::Rt), | |
216 | "Lo" => Ok(NAChannelType::Lo), | |
217 | "Ro" => Ok(NAChannelType::Ro), | |
218 | _ => Err(ChannelParseError{}), | |
1a151e53 | 219 | } |
32ce974d KS |
220 | } |
221 | } | |
222 | ||
81b94329 KS |
223 | impl ToString for NAChannelType { |
224 | fn to_string(&self) -> String { | |
225 | match *self { | |
fba6f8e4 KS |
226 | NAChannelType::C => "C".to_string(), |
227 | NAChannelType::L => "L".to_string(), | |
228 | NAChannelType::R => "R".to_string(), | |
229 | NAChannelType::Cs => "Cs".to_string(), | |
230 | NAChannelType::Ls => "Ls".to_string(), | |
231 | NAChannelType::Rs => "Rs".to_string(), | |
232 | NAChannelType::Lss => "Lss".to_string(), | |
233 | NAChannelType::Rss => "Rss".to_string(), | |
234 | NAChannelType::LFE => "LFE".to_string(), | |
235 | NAChannelType::Lc => "Lc".to_string(), | |
236 | NAChannelType::Rc => "Rc".to_string(), | |
237 | NAChannelType::Lh => "Lh".to_string(), | |
238 | NAChannelType::Rh => "Rh".to_string(), | |
239 | NAChannelType::Ch => "Ch".to_string(), | |
240 | NAChannelType::LFE2 => "LFE2".to_string(), | |
241 | NAChannelType::Lw => "Lw".to_string(), | |
242 | NAChannelType::Rw => "Rw".to_string(), | |
243 | NAChannelType::Ov => "Ov".to_string(), | |
244 | NAChannelType::Lhs => "Lhs".to_string(), | |
245 | NAChannelType::Rhs => "Rhs".to_string(), | |
246 | NAChannelType::Chs => "Chs".to_string(), | |
247 | NAChannelType::Ll => "Ll".to_string(), | |
248 | NAChannelType::Rl => "Rl".to_string(), | |
249 | NAChannelType::Cl => "Cl".to_string(), | |
250 | NAChannelType::Lt => "Lt".to_string(), | |
251 | NAChannelType::Rt => "Rt".to_string(), | |
252 | NAChannelType::Lo => "Lo".to_string(), | |
253 | NAChannelType::Ro => "Ro".to_string(), | |
81b94329 | 254 | } |
fba6f8e4 KS |
255 | } |
256 | } | |
257 | ||
33b5689a KS |
258 | /// Channel map. |
259 | /// | |
260 | /// This is essentially an ordered sequence of channels. | |
e243ceb4 | 261 | #[derive(Clone,Default)] |
fba6f8e4 KS |
262 | pub struct NAChannelMap { |
263 | ids: Vec<NAChannelType>, | |
264 | } | |
265 | ||
62b33487 KS |
266 | const MS_CHANNEL_MAP: [NAChannelType; 11] = [ |
267 | NAChannelType::L, | |
268 | NAChannelType::R, | |
269 | NAChannelType::C, | |
270 | NAChannelType::LFE, | |
271 | NAChannelType::Ls, | |
272 | NAChannelType::Rs, | |
273 | NAChannelType::Lss, | |
274 | NAChannelType::Rss, | |
275 | NAChannelType::Cs, | |
276 | NAChannelType::Lc, | |
277 | NAChannelType::Rc, | |
278 | ]; | |
279 | ||
fba6f8e4 | 280 | impl NAChannelMap { |
33b5689a | 281 | /// Constructs a new `NAChannelMap` instance. |
fba6f8e4 | 282 | pub fn new() -> Self { NAChannelMap { ids: Vec::new() } } |
33b5689a | 283 | /// Adds a new channel to the map. |
fba6f8e4 KS |
284 | pub fn add_channel(&mut self, ch: NAChannelType) { |
285 | self.ids.push(ch); | |
286 | } | |
33b5689a | 287 | /// Adds several channels to the map at once. |
10a00d52 | 288 | pub fn add_channels(&mut self, chs: &[NAChannelType]) { |
e243ceb4 KS |
289 | for e in chs.iter() { |
290 | self.ids.push(*e); | |
10a00d52 KS |
291 | } |
292 | } | |
33b5689a | 293 | /// Returns the total number of channels. |
fba6f8e4 KS |
294 | pub fn num_channels(&self) -> usize { |
295 | self.ids.len() | |
296 | } | |
33b5689a | 297 | /// Reports channel type for a requested index. |
fba6f8e4 KS |
298 | pub fn get_channel(&self, idx: usize) -> NAChannelType { |
299 | self.ids[idx] | |
300 | } | |
33b5689a | 301 | /// Tries to find position of the channel with requested type. |
fba6f8e4 KS |
302 | pub fn find_channel_id(&self, t: NAChannelType) -> Option<u8> { |
303 | for i in 0..self.ids.len() { | |
304 | if self.ids[i] as i32 == t as i32 { return Some(i as u8); } | |
305 | } | |
306 | None | |
307 | } | |
33b5689a | 308 | /// Creates a new `NAChannelMap` using the channel mapping flags from WAVE format. |
62b33487 KS |
309 | pub fn from_ms_mapping(chmap: u32) -> Self { |
310 | let mut cm = NAChannelMap::new(); | |
e243ceb4 | 311 | for (i, ch) in MS_CHANNEL_MAP.iter().enumerate() { |
62b33487 | 312 | if ((chmap >> i) & 1) != 0 { |
e243ceb4 | 313 | cm.add_channel(*ch); |
62b33487 KS |
314 | } |
315 | } | |
316 | cm | |
317 | } | |
fba6f8e4 KS |
318 | } |
319 | ||
32ce974d KS |
320 | impl fmt::Display for NAChannelMap { |
321 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |
322 | let mut map = String::new(); | |
323 | for el in self.ids.iter() { | |
e243ceb4 | 324 | if !map.is_empty() { map.push(','); } |
32ce974d KS |
325 | map.push_str(&*el.to_string()); |
326 | } | |
327 | write!(f, "{}", map) | |
328 | } | |
329 | } | |
330 | ||
331 | impl FromStr for NAChannelMap { | |
332 | type Err = ChannelParseError; | |
333 | ||
334 | fn from_str(s: &str) -> Result<Self, Self::Err> { | |
335 | let mut chm = NAChannelMap::new(); | |
336 | for tok in s.split(',') { | |
337 | chm.add_channel(NAChannelType::from_str(tok)?); | |
338 | } | |
339 | Ok(chm) | |
340 | } | |
341 | } | |
342 | ||
33b5689a | 343 | /// A list of RGB colour model variants. |
b68ff5ae | 344 | #[derive(Debug,Clone,Copy,PartialEq)] |
fba6f8e4 KS |
345 | pub enum RGBSubmodel { |
346 | RGB, | |
347 | SRGB, | |
348 | } | |
349 | ||
350 | impl fmt::Display for RGBSubmodel { | |
351 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |
352 | let name = match *self { | |
353 | RGBSubmodel::RGB => "RGB".to_string(), | |
354 | RGBSubmodel::SRGB => "sRGB".to_string(), | |
355 | }; | |
356 | write!(f, "{}", name) | |
357 | } | |
358 | } | |
359 | ||
33b5689a | 360 | /// A list of YUV colour model variants. |
b68ff5ae | 361 | #[derive(Debug,Clone,Copy,PartialEq)] |
fba6f8e4 KS |
362 | pub enum YUVSubmodel { |
363 | YCbCr, | |
33b5689a | 364 | /// NTSC variant. |
fba6f8e4 | 365 | YIQ, |
33b5689a | 366 | /// The YUV variant used by JPEG. |
fba6f8e4 KS |
367 | YUVJ, |
368 | } | |
369 | ||
370 | impl fmt::Display for YUVSubmodel { | |
371 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |
372 | let name = match *self { | |
373 | YUVSubmodel::YCbCr => "YCbCr".to_string(), | |
374 | YUVSubmodel::YIQ => "YIQ".to_string(), | |
375 | YUVSubmodel::YUVJ => "YUVJ".to_string(), | |
376 | }; | |
377 | write!(f, "{}", name) | |
378 | } | |
379 | } | |
380 | ||
33b5689a | 381 | /// A list of known colour models. |
b68ff5ae | 382 | #[derive(Debug, Clone,Copy,PartialEq)] |
fba6f8e4 KS |
383 | pub enum ColorModel { |
384 | RGB(RGBSubmodel), | |
385 | YUV(YUVSubmodel), | |
386 | CMYK, | |
387 | HSV, | |
388 | LAB, | |
389 | XYZ, | |
390 | } | |
391 | ||
392 | impl ColorModel { | |
33b5689a KS |
393 | /// Returns the number of colour model components. |
394 | /// | |
395 | /// The actual image may have more components e.g. alpha component. | |
e243ceb4 KS |
396 | pub fn get_default_components(self) -> usize { |
397 | match self { | |
fba6f8e4 KS |
398 | ColorModel::CMYK => 4, |
399 | _ => 3, | |
400 | } | |
401 | } | |
33b5689a | 402 | /// Reports whether the current colour model is RGB. |
e243ceb4 KS |
403 | pub fn is_rgb(self) -> bool { |
404 | match self { | |
386957f1 KS |
405 | ColorModel::RGB(_) => true, |
406 | _ => false, | |
407 | } | |
408 | } | |
33b5689a | 409 | /// Reports whether the current colour model is YUV. |
e243ceb4 KS |
410 | pub fn is_yuv(self) -> bool { |
411 | match self { | |
386957f1 KS |
412 | ColorModel::YUV(_) => true, |
413 | _ => false, | |
414 | } | |
415 | } | |
33b5689a | 416 | /// Returns short name for the current colour mode. |
e243ceb4 KS |
417 | pub fn get_short_name(self) -> &'static str { |
418 | match self { | |
8efb7386 KS |
419 | ColorModel::RGB(_) => "rgb", |
420 | ColorModel::YUV(_) => "yuv", | |
421 | ColorModel::CMYK => "cmyk", | |
422 | ColorModel::HSV => "hsv", | |
423 | ColorModel::LAB => "lab", | |
424 | ColorModel::XYZ => "xyz", | |
425 | } | |
426 | } | |
fba6f8e4 KS |
427 | } |
428 | ||
429 | impl fmt::Display for ColorModel { | |
430 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |
431 | let name = match *self { | |
432 | ColorModel::RGB(fmt) => format!("RGB({})", fmt).to_string(), | |
433 | ColorModel::YUV(fmt) => format!("YUV({})", fmt).to_string(), | |
434 | ColorModel::CMYK => "CMYK".to_string(), | |
435 | ColorModel::HSV => "HSV".to_string(), | |
436 | ColorModel::LAB => "LAB".to_string(), | |
437 | ColorModel::XYZ => "XYZ".to_string(), | |
438 | }; | |
439 | write!(f, "{}", name) | |
440 | } | |
441 | } | |
442 | ||
33b5689a KS |
443 | /// Single colourspace component definition. |
444 | /// | |
445 | /// This structure defines how components of a colourspace are subsampled and where and how they are stored. | |
b68ff5ae | 446 | #[derive(Clone,Copy,PartialEq)] |
fba6f8e4 | 447 | pub struct NAPixelChromaton { |
33b5689a | 448 | /// Horizontal subsampling in power of two (e.g. `0` = no subsampling, `1` = only every second value is stored). |
386957f1 | 449 | pub h_ss: u8, |
33b5689a | 450 | /// Vertial subsampling in power of two (e.g. `0` = no subsampling, `1` = only every second value is stored). |
386957f1 | 451 | pub v_ss: u8, |
33b5689a | 452 | /// A flag to signal that component is packed. |
386957f1 | 453 | pub packed: bool, |
33b5689a | 454 | /// Bit depth of current component. |
386957f1 | 455 | pub depth: u8, |
33b5689a | 456 | /// Shift for packed components. |
386957f1 | 457 | pub shift: u8, |
33b5689a | 458 | /// Component offset for byte-packed components. |
386957f1 | 459 | pub comp_offs: u8, |
33b5689a | 460 | /// The distance to the next packed element in bytes. |
386957f1 | 461 | pub next_elem: u8, |
fba6f8e4 KS |
462 | } |
463 | ||
33b5689a KS |
464 | /// Flag for specifying that image data is stored big-endian in `NAPixelFormaton::`[`new`]`()`. Related to its [`be`] field. |
465 | /// | |
466 | /// [`new`]: ./struct.NAPixelFormaton.html#method.new | |
467 | /// [`be`]: ./struct.NAPixelFormaton.html#structfield.new | |
9e9a3af1 | 468 | pub const FORMATON_FLAG_BE :u32 = 0x01; |
33b5689a KS |
469 | /// Flag for specifying that image data has alpha plane in `NAPixelFormaton::`[`new`]`()`. Related to its [`alpha`] field. |
470 | /// | |
471 | /// [`new`]: ./struct.NAPixelFormaton.html#method.new | |
472 | /// [`alpha`]: ./struct.NAPixelFormaton.html#structfield.alpha | |
9e9a3af1 | 473 | pub const FORMATON_FLAG_ALPHA :u32 = 0x02; |
33b5689a KS |
474 | /// Flag for specifying that image data is stored in paletted form for `NAPixelFormaton::`[`new`]`()`. Related to its [`palette`] field. |
475 | /// | |
476 | /// [`new`]: ./struct.NAPixelFormaton.html#method.new | |
477 | /// [`palette`]: ./struct.NAPixelFormaton.html#structfield.palette | |
9e9a3af1 | 478 | pub const FORMATON_FLAG_PALETTE :u32 = 0x04; |
fba6f8e4 | 479 | |
33b5689a | 480 | /// The current limit on number of components in image colourspace model (including alpha component). |
8efb7386 | 481 | pub const MAX_CHROMATONS: usize = 5; |
fba6f8e4 | 482 | |
33b5689a KS |
483 | /// Image colourspace representation. |
484 | /// | |
485 | /// This structure includes both definitions for each component and some common definitions. | |
486 | /// For example the format can be paletted and then components describe the palette storage format while actual data is 8-bit palette indices. | |
b68ff5ae | 487 | #[derive(Clone,Copy,PartialEq)] |
fba6f8e4 | 488 | pub struct NAPixelFormaton { |
33b5689a | 489 | /// Image colour model. |
386957f1 | 490 | pub model: ColorModel, |
33b5689a | 491 | /// Actual number of components present. |
386957f1 | 492 | pub components: u8, |
33b5689a | 493 | /// Format definition for each component. |
8efb7386 | 494 | pub comp_info: [Option<NAPixelChromaton>; MAX_CHROMATONS], |
33b5689a | 495 | /// Single pixel size for packed formats. |
386957f1 | 496 | pub elem_size: u8, |
33b5689a | 497 | /// A flag signalling that data is stored as big-endian. |
386957f1 | 498 | pub be: bool, |
33b5689a | 499 | /// A flag signalling that image has alpha component. |
386957f1 | 500 | pub alpha: bool, |
33b5689a KS |
501 | /// A flag signalling that data is paletted. |
502 | /// | |
503 | /// This means that image data is stored as 8-bit indices (in the first image component) for the palette stored as second component of the image and actual palette format is described in this structure. | |
386957f1 | 504 | pub palette: bool, |
fba6f8e4 KS |
505 | } |
506 | ||
507 | macro_rules! chromaton { | |
508 | ($hs: expr, $vs: expr, $pck: expr, $d: expr, $sh: expr, $co: expr, $ne: expr) => ({ | |
509 | Some(NAPixelChromaton{ h_ss: $hs, v_ss: $vs, packed: $pck, depth: $d, shift: $sh, comp_offs: $co, next_elem: $ne }) | |
510 | }); | |
511 | (yuv8; $hs: expr, $vs: expr, $co: expr) => ({ | |
512 | Some(NAPixelChromaton{ h_ss: $hs, v_ss: $vs, packed: false, depth: 8, shift: 0, comp_offs: $co, next_elem: 1 }) | |
513 | }); | |
514 | (packrgb; $d: expr, $s: expr, $co: expr, $ne: expr) => ({ | |
515 | Some(NAPixelChromaton{ h_ss: 0, v_ss: 0, packed: true, depth: $d, shift: $s, comp_offs: $co, next_elem: $ne }) | |
516 | }); | |
517 | (pal8; $co: expr) => ({ | |
518 | Some(NAPixelChromaton{ h_ss: 0, v_ss: 0, packed: true, depth: 8, shift: 0, comp_offs: $co, next_elem: 3 }) | |
519 | }); | |
520 | } | |
521 | ||
33b5689a | 522 | /// Predefined format for planar 8-bit YUV with 4:2:0 subsampling. |
fba6f8e4 KS |
523 | pub const YUV420_FORMAT: NAPixelFormaton = NAPixelFormaton { model: ColorModel::YUV(YUVSubmodel::YUVJ), components: 3, |
524 | comp_info: [ | |
525 | chromaton!(0, 0, false, 8, 0, 0, 1), | |
526 | chromaton!(yuv8; 1, 1, 1), | |
527 | chromaton!(yuv8; 1, 1, 2), | |
528 | None, None], | |
529 | elem_size: 0, be: false, alpha: false, palette: false }; | |
530 | ||
33b5689a | 531 | /// Predefined format for planar 8-bit YUV with 4:1:0 subsampling. |
b68ff5ae KS |
532 | pub const YUV410_FORMAT: NAPixelFormaton = NAPixelFormaton { model: ColorModel::YUV(YUVSubmodel::YUVJ), components: 3, |
533 | comp_info: [ | |
534 | chromaton!(0, 0, false, 8, 0, 0, 1), | |
535 | chromaton!(yuv8; 2, 2, 1), | |
536 | chromaton!(yuv8; 2, 2, 2), | |
537 | None, None], | |
538 | elem_size: 0, be: false, alpha: false, palette: false }; | |
33b5689a | 539 | /// Predefined format for planar 8-bit YUV with 4:1:0 subsampling and alpha component. |
a2a9732a KS |
540 | pub const YUVA410_FORMAT: NAPixelFormaton = NAPixelFormaton { model: ColorModel::YUV(YUVSubmodel::YUVJ), components: 4, |
541 | comp_info: [ | |
542 | chromaton!(0, 0, false, 8, 0, 0, 1), | |
543 | chromaton!(yuv8; 2, 2, 1), | |
544 | chromaton!(yuv8; 2, 2, 2), | |
545 | chromaton!(0, 0, false, 8, 0, 3, 1), | |
546 | None], | |
547 | elem_size: 0, be: false, alpha: true, palette: false }; | |
b68ff5ae | 548 | |
33b5689a | 549 | /// Predefined format with RGB24 palette. |
fba6f8e4 KS |
550 | pub const PAL8_FORMAT: NAPixelFormaton = NAPixelFormaton { model: ColorModel::RGB(RGBSubmodel::RGB), components: 3, |
551 | comp_info: [ | |
552 | chromaton!(pal8; 0), | |
553 | chromaton!(pal8; 1), | |
554 | chromaton!(pal8; 2), | |
555 | None, None], | |
556 | elem_size: 3, be: false, alpha: false, palette: true }; | |
557 | ||
33b5689a | 558 | /// Predefined format for RGB565 packed video. |
fba6f8e4 KS |
559 | pub const RGB565_FORMAT: NAPixelFormaton = NAPixelFormaton { model: ColorModel::RGB(RGBSubmodel::RGB), components: 3, |
560 | comp_info: [ | |
561 | chromaton!(packrgb; 5, 11, 0, 2), | |
562 | chromaton!(packrgb; 6, 5, 0, 2), | |
563 | chromaton!(packrgb; 5, 0, 0, 2), | |
564 | None, None], | |
565 | elem_size: 2, be: false, alpha: false, palette: false }; | |
566 | ||
33b5689a | 567 | /// Predefined format for RGB24. |
653e5afd KS |
568 | pub const RGB24_FORMAT: NAPixelFormaton = NAPixelFormaton { model: ColorModel::RGB(RGBSubmodel::RGB), components: 3, |
569 | comp_info: [ | |
653e5afd | 570 | chromaton!(packrgb; 8, 0, 0, 3), |
c6297d1f KS |
571 | chromaton!(packrgb; 8, 0, 1, 3), |
572 | chromaton!(packrgb; 8, 0, 2, 3), | |
653e5afd KS |
573 | None, None], |
574 | elem_size: 3, be: false, alpha: false, palette: false }; | |
575 | ||
fba6f8e4 | 576 | impl NAPixelChromaton { |
33b5689a | 577 | /// Constructs a new `NAPixelChromaton` instance. |
0cc09358 KS |
578 | pub fn new(h_ss: u8, v_ss: u8, packed: bool, depth: u8, shift: u8, comp_offs: u8, next_elem: u8) -> Self { |
579 | Self { h_ss, v_ss, packed, depth, shift, comp_offs, next_elem } | |
580 | } | |
33b5689a | 581 | /// Returns subsampling for the current component. |
e243ceb4 | 582 | pub fn get_subsampling(self) -> (u8, u8) { (self.h_ss, self.v_ss) } |
33b5689a | 583 | /// Reports whether current component is packed. |
e243ceb4 | 584 | pub fn is_packed(self) -> bool { self.packed } |
33b5689a | 585 | /// Returns bit depth of current component. |
e243ceb4 | 586 | pub fn get_depth(self) -> u8 { self.depth } |
33b5689a | 587 | /// Returns bit shift for packed component. |
e243ceb4 | 588 | pub fn get_shift(self) -> u8 { self.shift } |
33b5689a | 589 | /// Returns byte offset for packed component. |
e243ceb4 | 590 | pub fn get_offset(self) -> u8 { self.comp_offs } |
33b5689a | 591 | /// Returns byte offset to the next element of current packed component. |
e243ceb4 | 592 | pub fn get_step(self) -> u8 { self.next_elem } |
b68ff5ae | 593 | |
33b5689a | 594 | /// Calculates the width for current component from general image width. |
e243ceb4 | 595 | pub fn get_width(self, width: usize) -> usize { |
15e41b31 KS |
596 | (width + ((1 << self.h_ss) - 1)) >> self.h_ss |
597 | } | |
33b5689a | 598 | /// Calculates the height for current component from general image height. |
e243ceb4 | 599 | pub fn get_height(self, height: usize) -> usize { |
15e41b31 KS |
600 | (height + ((1 << self.v_ss) - 1)) >> self.v_ss |
601 | } | |
33b5689a | 602 | /// Calculates the minimal stride for current component from general image width. |
e243ceb4 | 603 | pub fn get_linesize(self, width: usize) -> usize { |
b68ff5ae | 604 | let d = self.depth as usize; |
6c8e5c40 KS |
605 | if self.packed { |
606 | (self.get_width(width) * d + d - 1) >> 3 | |
607 | } else { | |
608 | self.get_width(width) | |
609 | } | |
b68ff5ae | 610 | } |
33b5689a | 611 | /// Calculates the required image size in pixels for current component from general image width. |
e243ceb4 | 612 | pub fn get_data_size(self, width: usize, height: usize) -> usize { |
b68ff5ae KS |
613 | let nh = (height + ((1 << self.v_ss) - 1)) >> self.v_ss; |
614 | self.get_linesize(width) * nh | |
615 | } | |
fba6f8e4 KS |
616 | } |
617 | ||
618 | impl fmt::Display for NAPixelChromaton { | |
619 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |
620 | let pfmt = if self.packed { | |
621 | let mask = ((1 << self.depth) - 1) << self.shift; | |
622 | format!("packed(+{},{:X}, step {})", self.comp_offs, mask, self.next_elem) | |
623 | } else { | |
624 | format!("planar({},{})", self.comp_offs, self.next_elem) | |
625 | }; | |
626 | write!(f, "({}x{}, {})", self.h_ss, self.v_ss, pfmt) | |
627 | } | |
628 | } | |
629 | ||
630 | impl NAPixelFormaton { | |
33b5689a | 631 | /// Constructs a new instance of `NAPixelFormaton`. |
fba6f8e4 KS |
632 | pub fn new(model: ColorModel, |
633 | comp1: Option<NAPixelChromaton>, | |
634 | comp2: Option<NAPixelChromaton>, | |
635 | comp3: Option<NAPixelChromaton>, | |
636 | comp4: Option<NAPixelChromaton>, | |
637 | comp5: Option<NAPixelChromaton>, | |
9e9a3af1 | 638 | flags: u32, elem_size: u8) -> Self { |
8efb7386 | 639 | let mut chromatons: [Option<NAPixelChromaton>; MAX_CHROMATONS] = [None; MAX_CHROMATONS]; |
fba6f8e4 | 640 | let mut ncomp = 0; |
9e9a3af1 KS |
641 | let be = (flags & FORMATON_FLAG_BE) != 0; |
642 | let alpha = (flags & FORMATON_FLAG_ALPHA) != 0; | |
643 | let palette = (flags & FORMATON_FLAG_PALETTE) != 0; | |
fba6f8e4 KS |
644 | if let Some(c) = comp1 { chromatons[0] = Some(c); ncomp += 1; } |
645 | if let Some(c) = comp2 { chromatons[1] = Some(c); ncomp += 1; } | |
646 | if let Some(c) = comp3 { chromatons[2] = Some(c); ncomp += 1; } | |
647 | if let Some(c) = comp4 { chromatons[3] = Some(c); ncomp += 1; } | |
648 | if let Some(c) = comp5 { chromatons[4] = Some(c); ncomp += 1; } | |
e243ceb4 | 649 | NAPixelFormaton { model, |
fba6f8e4 KS |
650 | components: ncomp, |
651 | comp_info: chromatons, | |
e243ceb4 KS |
652 | elem_size, |
653 | be, alpha, palette } | |
fba6f8e4 KS |
654 | } |
655 | ||
33b5689a | 656 | /// Returns current colour model. |
fba6f8e4 | 657 | pub fn get_model(&self) -> ColorModel { self.model } |
33b5689a | 658 | /// Returns the number of components. |
b68ff5ae | 659 | pub fn get_num_comp(&self) -> usize { self.components as usize } |
33b5689a | 660 | /// Returns selected component information. |
fba6f8e4 KS |
661 | pub fn get_chromaton(&self, idx: usize) -> Option<NAPixelChromaton> { |
662 | if idx < self.comp_info.len() { return self.comp_info[idx]; } | |
663 | None | |
664 | } | |
33b5689a | 665 | /// Reports whether the packing format is big-endian. |
e243ceb4 | 666 | pub fn is_be(self) -> bool { self.be } |
33b5689a | 667 | /// Reports whether colourspace has alpha component. |
e243ceb4 | 668 | pub fn has_alpha(self) -> bool { self.alpha } |
33b5689a | 669 | /// Reports whether this is paletted format. |
e243ceb4 | 670 | pub fn is_paletted(self) -> bool { self.palette } |
33b5689a | 671 | /// Returns single packed pixel size. |
e243ceb4 | 672 | pub fn get_elem_size(self) -> u8 { self.elem_size } |
33b5689a | 673 | /// Reports whether the format is not packed. |
8efb7386 | 674 | pub fn is_unpacked(&self) -> bool { |
c7d8d948 | 675 | if self.palette { return false; } |
8efb7386 KS |
676 | for chr in self.comp_info.iter() { |
677 | if let Some(ref chromaton) = chr { | |
678 | if chromaton.is_packed() { return false; } | |
679 | } | |
680 | } | |
681 | true | |
682 | } | |
33b5689a | 683 | /// Returns the maximum component bit depth. |
8efb7386 KS |
684 | pub fn get_max_depth(&self) -> u8 { |
685 | let mut mdepth = 0; | |
686 | for chr in self.comp_info.iter() { | |
687 | if let Some(ref chromaton) = chr { | |
688 | mdepth = mdepth.max(chromaton.depth); | |
689 | } | |
690 | } | |
691 | mdepth | |
692 | } | |
8b746bf7 KS |
693 | /// Returns the total amount of bits needed for components. |
694 | pub fn get_total_depth(&self) -> u8 { | |
695 | let mut depth = 0; | |
696 | for chr in self.comp_info.iter() { | |
697 | if let Some(ref chromaton) = chr { | |
698 | depth += chromaton.depth; | |
699 | } | |
700 | } | |
701 | depth | |
702 | } | |
33b5689a | 703 | /// Returns the maximum component subsampling. |
8efb7386 KS |
704 | pub fn get_max_subsampling(&self) -> u8 { |
705 | let mut ssamp = 0; | |
706 | for chr in self.comp_info.iter() { | |
707 | if let Some(ref chromaton) = chr { | |
708 | let (ss_v, ss_h) = chromaton.get_subsampling(); | |
709 | ssamp = ssamp.max(ss_v).max(ss_h); | |
710 | } | |
711 | } | |
712 | ssamp | |
713 | } | |
fba6f8e4 KS |
714 | } |
715 | ||
716 | impl fmt::Display for NAPixelFormaton { | |
717 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | |
718 | let end = if self.be { "BE" } else { "LE" }; | |
719 | let palstr = if self.palette { "palette " } else { "" }; | |
720 | let astr = if self.alpha { "alpha " } else { "" }; | |
721 | let mut str = format!("Formaton for {} ({}{}elem {} size {}): ", self.model, palstr, astr,end, self.elem_size); | |
722 | for i in 0..self.comp_info.len() { | |
723 | if let Some(chr) = self.comp_info[i] { | |
724 | str = format!("{} {}", str, chr); | |
725 | } | |
726 | } | |
727 | write!(f, "[{}]", str) | |
728 | } | |
729 | } | |
730 | ||
731 | #[cfg(test)] | |
732 | mod test { | |
733 | use super::*; | |
734 | ||
735 | #[test] | |
736 | fn test_fmt() { | |
737 | println!("{}", SND_S16_FORMAT); | |
738 | println!("{}", SND_U8_FORMAT); | |
126b7eb8 | 739 | println!("{}", SND_F32P_FORMAT); |
11d889bb KS |
740 | assert_eq!(SND_U8_FORMAT.to_short_string(), "u8"); |
741 | assert_eq!(SND_F32P_FORMAT.to_short_string(), "f32lep"); | |
742 | let s16fmt = SND_S16_FORMAT.to_short_string(); | |
743 | assert_eq!(NASoniton::from_str(s16fmt.as_str()).unwrap(), SND_S16_FORMAT); | |
fba6f8e4 KS |
744 | println!("formaton yuv- {}", YUV420_FORMAT); |
745 | println!("formaton pal- {}", PAL8_FORMAT); | |
746 | println!("formaton rgb565- {}", RGB565_FORMAT); | |
747 | } | |
748 | } |