mvdparser 0.18.1

Extract information from QuakeWorld MVD demos.
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 std::io::Cursor;
use std::ops::Range;

use anyhow::{anyhow as e, Result};

use crate::qw::primitives::{numsize, ReadPrimitives};
use crate::qw::prot::{Command, Target};

pub const HEADER_SIZE: usize = numsize::SHORT + numsize::LONG;
pub const MULTI_HEADER_SIZE: usize = HEADER_SIZE + numsize::LONG;

#[derive(Clone, Debug, PartialEq)]
pub struct Info {
    pub duration: u32,
    pub target: Target,
    pub command: Command,
    pub index: usize,
    pub size: usize,
    pub header_size: usize,
    pub header_range: Range<usize>,
    pub body_size: usize,
    pub body_range: Range<usize>,
}

impl Info {
    pub fn from_data_and_index(data: &[u8], index: usize) -> Result<Self> {
        let mut cur = Cursor::new(&data[index..]);

        let duration = cur.read_byte()? as u32;

        let (target, command) = {
            let byte = cur.read_byte()?;
            (Target::from(&byte), Command::from(&byte))
        };

        let multi_bytes = match target {
            Target::Multiple => numsize::LONG, // skip multi target bytes [0,0,0,0]
            _ => 0,
        };
        cur.set_position(cur.position() + multi_bytes as u64);

        let body_size = match command {
            Command::Read => cur.read_u32()? as usize,
            Command::Set => 2 * numsize::LONG, // reads 2 longs (8 bytes)
            _ => 0,                            // should not happen
        };

        let header_size = cur.position() as usize;
        let size = header_size + body_size;

        if data.len() < size {
            return Err(e!("Frame is smaller than expected size"));
        }

        Ok(Self {
            index,
            duration,
            target,
            command,
            size,
            header_size,
            header_range: index..index + header_size,
            body_size,
            body_range: index + header_size..index + size,
        })
    }
}

#[cfg(test)]
mod tests {
    use std::fs::read;

    use anyhow::Result;
    use pretty_assertions::assert_eq;

    use super::*;

    #[test]
    fn test_from_data_and_index() -> Result<()> {
        let data = read("tests/files/4on4_oeks_vs_tsq[dm2]20240426-1716.mvd")?;

        {
            assert_eq!(
                Info::from_data_and_index(&data[0..10], 0)
                    .unwrap_err()
                    .to_string(),
                "Frame is smaller than expected size".to_string()
            );
        }

        {
            assert_eq!(
                Info::from_data_and_index(&data, 456)?,
                Info {
                    index: 456,
                    duration: 0,
                    target: Target::All,
                    command: Command::Read,
                    size: 743,
                    header_size: 6,
                    header_range: 456..462,
                    body_size: 737,
                    body_range: 462..1199,
                }
            );
        }

        Ok(())
    }
}