]> git.nihav.org Git - nihav.git/blame - nihav-registry/src/detect.rs
Legend Entertainment Q format demuxer and decoder
[nihav.git] / nihav-registry / src / detect.rs
CommitLineData
1b5ebe1d
KS
1//! Container format detection.
2//!
3//! Usually user does not know the container format of the opened file.
4//! That is why format detection functionality is needed.
5//! This module contains the set of rules to detect container not merely by file extension but also by its content if possible.
6//!
7//! # Examples
8//!
9//! ```no_run
01f55c6a 10//! use nihav_registry::detect::detect_format;
1b5ebe1d
KS
11//! use std::fs::File;
12//! use nihav_core::io::byteio::*;
13//!
14//! let name = "mediafile.ogv";
15//! let mut file = File::open(name).unwrap();
16//! let mut filereader = FileReader::new_read(&mut file);
17//! let mut br = ByteReader::new(&mut filereader);
18//! let result = detect_format(name, &mut br);
19//! if let Some((name, score)) = result {
20//! println!("detected format {} with score {:?}", name, score);
21//! }
22//! ```
d8ce0de0 23use std::io::SeekFrom;
32f7cbe5 24use nihav_core::io::byteio::ByteReader;
d8ce0de0 25
1b5ebe1d 26/// Format detection score.
d8ce0de0
KS
27#[derive(Debug,Clone,Copy,PartialEq)]
28pub enum DetectionScore {
1b5ebe1d 29 /// Format is not detected.
d8ce0de0 30 No,
1b5ebe1d 31 /// Format matched by file extension.
d8ce0de0 32 ExtensionMatches,
1b5ebe1d 33 /// Format matches by markers inside the file.
d8ce0de0
KS
34 MagicMatches,
35}
36
37impl DetectionScore {
1b5ebe1d 38 /// Checks whether current detection score is less than a value it is compared against.
e243ceb4
KS
39 pub fn less(self, other: DetectionScore) -> bool {
40 (self as i32) < (other as i32)
d8ce0de0
KS
41 }
42}
43
44#[allow(dead_code)]
b5bd2ae4 45enum Arg {
d8ce0de0
KS
46 Byte(u8),
47 U16BE(u16),
48 U16LE(u16),
49 U24BE(u32),
50 U24LE(u32),
51 U32BE(u32),
52 U32LE(u32),
53 U64BE(u64),
54 U64LE(u64),
55}
56
b5bd2ae4 57impl Arg {
d8ce0de0
KS
58 fn val(&self) -> u64 {
59 match *self {
e243ceb4
KS
60 Arg::Byte(b) => { u64::from(b) }
61 Arg::U16BE(v) => { u64::from(v) }
62 Arg::U16LE(v) => { u64::from(v) }
63 Arg::U24BE(v) => { u64::from(v) }
64 Arg::U24LE(v) => { u64::from(v) }
65 Arg::U32BE(v) => { u64::from(v) }
66 Arg::U32LE(v) => { u64::from(v) }
b5bd2ae4
KS
67 Arg::U64BE(v) => { v }
68 Arg::U64LE(v) => { v }
d8ce0de0
KS
69 }
70 }
71 fn read_val(&self, src: &mut ByteReader) -> Option<u64> {
72 match *self {
b5bd2ae4 73 Arg::Byte(_) => {
d8ce0de0 74 let res = src.peek_byte();
e243ceb4
KS
75 if res.is_err() { return None; }
76 Some(u64::from(res.unwrap()))
d8ce0de0 77 }
b5bd2ae4 78 Arg::U16BE(_) => {
d8ce0de0 79 let res = src.peek_u16be();
e243ceb4
KS
80 if res.is_err() { return None; }
81 Some(u64::from(res.unwrap()))
d8ce0de0 82 }
b5bd2ae4 83 Arg::U16LE(_) => {
d8ce0de0 84 let res = src.peek_u16le();
e243ceb4
KS
85 if res.is_err() { return None; }
86 Some(u64::from(res.unwrap()))
d8ce0de0 87 }
b5bd2ae4 88 Arg::U24BE(_) => {
d8ce0de0 89 let res = src.peek_u24be();
e243ceb4
KS
90 if res.is_err() { return None; }
91 Some(u64::from(res.unwrap()))
d8ce0de0 92 }
b5bd2ae4 93 Arg::U24LE(_) => {
d8ce0de0 94 let res = src.peek_u24le();
e243ceb4
KS
95 if res.is_err() { return None; }
96 Some(u64::from(res.unwrap()))
d8ce0de0 97 }
b5bd2ae4 98 Arg::U32BE(_) => {
d8ce0de0 99 let res = src.peek_u32be();
e243ceb4
KS
100 if res.is_err() { return None; }
101 Some(u64::from(res.unwrap()))
d8ce0de0 102 }
b5bd2ae4 103 Arg::U32LE(_) => {
d8ce0de0 104 let res = src.peek_u32le();
e243ceb4
KS
105 if res.is_err() { return None; }
106 Some(u64::from(res.unwrap()))
d8ce0de0 107 }
b5bd2ae4 108 Arg::U64BE(_) => {
d8ce0de0 109 let res = src.peek_u64be();
e243ceb4 110 if res.is_err() { return None; }
d8ce0de0
KS
111 Some(res.unwrap())
112 }
b5bd2ae4 113 Arg::U64LE(_) => {
d8ce0de0 114 let res = src.peek_u64le();
e243ceb4 115 if res.is_err() { return None; }
d8ce0de0
KS
116 Some(res.unwrap())
117 }
118 }
119 }
120 fn eq(&self, src: &mut ByteReader) -> bool {
01f55c6a
KS
121 if let Some(rval) = self.read_val(src) {
122 rval == self.val()
123 } else {
124 false
125 }
d8ce0de0
KS
126 }
127 fn ge(&self, src: &mut ByteReader) -> bool {
01f55c6a
KS
128 if let Some(rval) = self.read_val(src) {
129 rval >= self.val()
130 } else {
131 false
132 }
d8ce0de0
KS
133 }
134 fn gt(&self, src: &mut ByteReader) -> bool {
01f55c6a
KS
135 if let Some(rval) = self.read_val(src) {
136 rval > self.val()
137 } else {
138 false
139 }
d8ce0de0
KS
140 }
141 fn le(&self, src: &mut ByteReader) -> bool {
01f55c6a
KS
142 if let Some(rval) = self.read_val(src) {
143 rval <= self.val()
144 } else {
145 false
146 }
d8ce0de0
KS
147 }
148 fn lt(&self, src: &mut ByteReader) -> bool {
01f55c6a
KS
149 if let Some(rval) = self.read_val(src) {
150 rval < self.val()
151 } else {
152 false
153 }
d8ce0de0
KS
154 }
155}
156
157#[allow(dead_code)]
b5bd2ae4
KS
158enum CC<'a> {
159 Or(&'a CC<'a>, &'a CC<'a>),
160 Eq(Arg),
161 Str(&'static [u8]),
162 In(Arg, Arg),
163 Lt(Arg),
164 Le(Arg),
165 Gt(Arg),
166 Ge(Arg),
d8ce0de0
KS
167}
168
b5bd2ae4 169impl<'a> CC<'a> {
d8ce0de0
KS
170 fn eval(&self, src: &mut ByteReader) -> bool {
171 match *self {
b5bd2ae4
KS
172 CC::Or (ref a, ref b) => { a.eval(src) || b.eval(src) },
173 CC::Eq(ref arg) => { arg.eq(src) },
4d477e23 174 CC::In(ref a, ref b) => { a.ge(src) && b.le(src) },
b5bd2ae4
KS
175 CC::Lt(ref arg) => { arg.lt(src) },
176 CC::Le(ref arg) => { arg.le(src) },
177 CC::Gt(ref arg) => { arg.gt(src) },
178 CC::Ge(ref arg) => { arg.ge(src) },
179 CC::Str(str) => {
e243ceb4 180 let mut val: Vec<u8> = vec![0; str.len()];
d8ce0de0 181 let res = src.peek_buf(val.as_mut_slice());
e243ceb4 182 if res.is_err() { return false; }
d8ce0de0
KS
183 val == str
184 }
185 }
186 }
187}
188
189struct CheckItem<'a> {
190 offs: u32,
b5bd2ae4 191 cond: &'a CC<'a>,
d8ce0de0
KS
192}
193
194#[allow(dead_code)]
195struct DetectConditions<'a> {
196 demux_name: &'static str,
197 extensions: &'static str,
198 conditions: &'a [CheckItem<'a>],
199}
200
201const DETECTORS: &[DetectConditions] = &[
202 DetectConditions {
203 demux_name: "avi",
204 extensions: ".avi",
b5bd2ae4
KS
205 conditions: &[CheckItem{offs: 0, cond: &CC::Or(&CC::Str(b"RIFF"), &CC::Str(b"ON2 ")) },
206 CheckItem{offs: 8, cond: &CC::Or(&CC::Or(&CC::Str(b"AVI LIST"),
207 &CC::Str(b"AVIXLIST")),
208 &CC::Str(b"ON2fLIST")) },
209 ]
d8ce0de0 210 },
283abfa6
KS
211 DetectConditions {
212 demux_name: "wav",
213 extensions: ".wav",
214 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b"RIFF") },
215 CheckItem{offs: 8, cond: &CC::Str(b"WAVEfmt ") }
216 ]
217 },
bdf66deb
KS
218 DetectConditions {
219 demux_name: "mov",
220 extensions: ".mov",
221 conditions: &[CheckItem{offs: 4, cond: &CC::Or(&CC::Or(&CC::Str(b"mdat"),
222 &CC::Str(b"moov")),
223 &CC::Str(b"ftyp")) }],
224 },
225 DetectConditions {
226 demux_name: "mov",
227 extensions: ".mov",
228 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b"\x00\x00\x00\x08wide") },
229 CheckItem{offs: 12, cond: &CC::Or(&CC::Or(&CC::Str(b"mdat"),
230 &CC::Str(b"moov")),
231 &CC::Str(b"ftyp")) }],
232 },
8d91d85f
KS
233 DetectConditions {
234 demux_name: "fcmp",
235 extensions: ".cmp",
236 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b"FCMP")}],
237 },
238 DetectConditions {
239 demux_name: "fst",
240 extensions: ".fst",
241 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b"2TSF")}],
242 },
d8ce0de0
KS
243 DetectConditions {
244 demux_name: "gdv",
245 extensions: ".gdv",
b5bd2ae4 246 conditions: &[CheckItem{offs: 0, cond: &CC::Eq(Arg::U32LE(0x29111994))}],
d8ce0de0 247 },
3813fe8a
KS
248 DetectConditions {
249 demux_name: "fable-imax",
250 extensions: ".imx",
251 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b"IMAX") },
252 CheckItem{offs: 10, cond: &CC::Eq(Arg::U16LE(0x102)) }],
253 },
afe1e5ba
KS
254 DetectConditions {
255 demux_name: "legend-q",
256 extensions: ".q",
257 conditions: &[CheckItem{offs: 0, cond: &CC::Eq(Arg::U16LE(0x6839))},
258 CheckItem{offs: 2, cond: &CC::In(Arg::Byte(3), Arg::Byte(5))}],
259 },
ce52b3b5
KS
260 DetectConditions {
261 demux_name: "realaudio",
262 extensions: ".ra,.ram",
263 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b".ra\xFD")}],
264 },
265 DetectConditions {
266 demux_name: "realmedia",
267 extensions: ".rm,.rmvb,.rma,.ra,.ram",
db5cc44b 268 conditions: &[CheckItem{offs: 0, cond: &CC::Or(&CC::Str(b".RMF"), &CC::Str(b".RMP")) },
ce52b3b5
KS
269 CheckItem{offs: 4, cond: &CC::Ge(Arg::U32BE(10))}],
270 },
271 DetectConditions {
272 demux_name: "real_ivr",
273 extensions: ".ivr",
274 conditions: &[CheckItem{offs: 0, cond: &CC::Or(&CC::Str(b".R1M"), &CC::Str(b".REC"))}],
275 },
c6c21059
KS
276 DetectConditions {
277 demux_name: "bink",
4d477e23 278 extensions: ".bik,.bk2",
4998874b
KS
279 conditions: &[CheckItem{offs: 0, cond: &CC::Or(&CC::In(Arg::U32BE(0x42494B62), // BIKb
280 Arg::U32BE(0x42494B7B)), // BIKz
c6c21059
KS
281 &CC::In(Arg::U32BE(0x4B423261), // KB2a
282 Arg::U32BE(0x4B42327B)))}], // KB2z
283 },
606c448e
KS
284 DetectConditions {
285 demux_name: "smacker",
286 extensions: ".smk",
287 conditions: &[CheckItem{offs: 0, cond: &CC::Or(&CC::Str(b"SMK2"), &CC::Str(b"SMK4"))}],
288 },
87927c57
KS
289 DetectConditions {
290 demux_name: "ape",
291 extensions: ".ape",
292 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b"MAC ") },
293 CheckItem{offs: 4, cond: &CC::In(Arg::U16LE(3800), Arg::U16LE(3990))}],
294 },
295 DetectConditions {
296 demux_name: "flac",
297 extensions: ".flac",
298 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b"fLaC") }],
299 },
300 DetectConditions {
301 demux_name: "tta",
302 extensions: ".tta",
303 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b"TTA1") }],
304 },
305 DetectConditions {
306 demux_name: "wavpack",
307 extensions: ".wv",
308 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b"wvpk") },
309 CheckItem{offs: 8, cond: &CC::In(Arg::U16LE(0x402), Arg::U16LE(0x410))}],
310 },
128253cc 311 DetectConditions {
31cf33ac
KS
312 demux_name: "vivo",
313 extensions: ".viv",
314 conditions: &[CheckItem{offs: 0, cond: &CC::In(Arg::U16BE(1), Arg::U16BE(0xFF))},
315 CheckItem{offs: 2, cond: &CC::Str(b"\x0D\x0AVersion:Vivo/")}],
316 },
317 DetectConditions {
318 demux_name: "vivo",
319 extensions: ".viv",
320 conditions: &[CheckItem{offs: 0, cond: &CC::In(Arg::U16BE(1), Arg::U16BE(0xFF))},
321 CheckItem{offs: 3, cond: &CC::Str(b"\x0D\x0AVersion:Vivo/")}],
322 },
323 DetectConditions {
128253cc
KS
324 demux_name: "bmv",
325 extensions: ".bmv",
326 conditions: &[],
327 },
ecda1cc1
KS
328 DetectConditions {
329 demux_name: "bmv3",
330 extensions: ".bmv",
331 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b"BMVi") },
332 CheckItem{offs: 32, cond: &CC::Str(b"DATA")}],
333 },
9895bd7b
KS
334 DetectConditions {
335 demux_name: "vmd",
336 extensions: ".vmd",
337 conditions: &[],
338 },
55d85231
KS
339 DetectConditions {
340 demux_name: "vx",
341 extensions: ".vx",
342 conditions: &[CheckItem{offs: 0, cond: &CC::Str(b"VXDS") }],
343 },
d8ce0de0
KS
344];
345
1b5ebe1d
KS
346/// Tries to detect container format.
347///
348/// This function tries to determine container format using both file extension and checking against container specific markers inside.
349/// In case of success the function returns short container name and the detection score.
350/// Result should have the highest detection score among tested.
d8ce0de0
KS
351pub fn detect_format(name: &str, src: &mut ByteReader) -> Option<(&'static str, DetectionScore)> {
352 let mut result = None;
353 let lname = name.to_lowercase();
354 for detector in DETECTORS {
355 let mut score = DetectionScore::No;
e243ceb4 356 if !name.is_empty() {
d8ce0de0
KS
357 for ext in detector.extensions.split(',') {
358 if lname.ends_with(ext) {
359 score = DetectionScore::ExtensionMatches;
360 break;
361 }
362 }
363 }
e243ceb4 364 let mut passed = !detector.conditions.is_empty();
d8ce0de0 365 for ck in detector.conditions {
e243ceb4
KS
366 let ret = src.seek(SeekFrom::Start(u64::from(ck.offs)));
367 if ret.is_err() {
d8ce0de0
KS
368 passed = false;
369 break;
370 }
371 if !ck.cond.eval(src) {
372 passed = false;
373 break;
374 }
375 }
376 if passed {
377 score = DetectionScore::MagicMatches;
378 }
379 if score == DetectionScore::MagicMatches {
380 return Some((detector.demux_name, score));
381 }
4d477e23 382 if result.is_none() && score != DetectionScore::No {
d8ce0de0 383 result = Some((detector.demux_name, score));
4d477e23 384 } else if result.is_some() {
d8ce0de0
KS
385 let (_, oldsc) = result.unwrap();
386 if oldsc.less(score) {
387 result = Some((detector.demux_name, score));
388 }
389 }
390 }
391 result
392}
393
4b56e8c9 394/// Tries to detect container format for provided file name.
ac818eac 395pub fn detect_format_by_name(name: &str) -> Option<&'static str> {
4b56e8c9
KS
396 if name.is_empty() {
397 return None;
398 }
399 let lname = name.to_lowercase();
400 for detector in DETECTORS {
401 for ext in detector.extensions.split(',') {
402 if lname.ends_with(ext) {
403 return Some(detector.demux_name);
404 }
405 }
406 }
407 None
408}
409
d8ce0de0
KS
410#[cfg(test)]
411mod test {
412 use super::*;
413 use std::fs::File;
01f55c6a 414 use nihav_core::io::byteio::*;
d8ce0de0
KS
415
416 #[test]
417 fn test_avi_detect() {
250c49f6 418 let name = "assets/Indeo/laser05.avi";
d8ce0de0
KS
419 let mut file = File::open(name).unwrap();
420 let mut fr = FileReader::new_read(&mut file);
421 let mut br = ByteReader::new(&mut fr);
422 let (name, score) = detect_format(name, &mut br).unwrap();
423 assert_eq!(name, "avi");
424 assert_eq!(score, DetectionScore::MagicMatches);
425 }
426
427 #[test]
428 fn test_gdv_detect() {
250c49f6 429 let name = "assets/Game/intro1.gdv";
d8ce0de0
KS
430 let mut file = File::open(name).unwrap();
431 let mut fr = FileReader::new_read(&mut file);
432 let mut br = ByteReader::new(&mut fr);
433 let (name, score) = detect_format(name, &mut br).unwrap();
434 assert_eq!(name, "gdv");
435 assert_eq!(score, DetectionScore::MagicMatches);
436 }
b5bd2ae4 437}