s2protocol 3.5.3

A parser for Starcraft II - Replay format, exports to different target formats
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

//! The known protocol versions

use crate::details::Details;
use crate::game_events::GameEvent;
use crate::message_events::MessageEvent;
use crate::tracker_events::TrackerEvent;
use crate::{InitData, S2ProtocolError};
use nom_mpq::MPQ;

pub mod protocol75689;
pub mod protocol87702;

/// Attempts to read the tracker events, panics under unknown protocol
#[tracing::instrument(level = "error", skip(mpq, file_contents, file_name))]
pub fn read_tracker_events(
    file_name: &str,
    mpq: &MPQ,
    file_contents: &[u8],
) -> Result<Vec<TrackerEvent>, S2ProtocolError> {
    let (_tail, proto_header) = crate::read_protocol_header(mpq)?;
    tracing::debug!(
        "Proto version: {:?} reading TrackerEvents from {:?}",
        proto_header.m_version.m_base_build,
        file_name
    );
    assert_eq!(proto_header.m_signature, b"StarCraft II replay\x1b11"[..]);
    match proto_header.m_version.m_base_build {
        0..=75689 => protocol75689::byte_aligned::ReplayTrackerEEventId::read_tracker_events(
            mpq,
            file_contents,
        ),
        83830 | 84643 | 88500 | 86383 | 87702 | 89634 | 89165 | 89720 | 90136 | 90779 | 90870
        | 91115 => protocol87702::byte_aligned::ReplayTrackerEEventId::read_tracker_events(
            mpq,
            file_contents,
        ),
        _ => protocol87702::byte_aligned::ReplayTrackerEEventId::read_tracker_events(
            mpq,
            file_contents,
        ),
    }
}

/// Attempts to read the game events, panics under unknown protocol
#[tracing::instrument(level = "error", skip(mpq, file_contents, file_name))]
pub fn read_game_events(
    file_name: &str,
    mpq: &MPQ,
    file_contents: &[u8],
) -> Result<Vec<GameEvent>, S2ProtocolError> {
    let (_tail, proto_header) = crate::read_protocol_header(mpq)?;
    tracing::debug!(
        "Proto version: {:?} reading GameEvents from {:?}",
        proto_header.m_version.m_base_build,
        file_name
    );
    assert_eq!(proto_header.m_signature, b"StarCraft II replay\x1b11"[..]);
    match proto_header.m_version.m_base_build {
        0..=75689 => protocol75689::bit_packed::GameEEventId::read_events(mpq, file_contents),
        83830 | 84643 | 88500 | 86383 | 87702 | 89634 | 89165 | 89720 | 90136 | 90779 | 90870
        | 91115 => protocol87702::bit_packed::GameEEventId::read_events(mpq, file_contents),
        _ => protocol87702::bit_packed::GameEEventId::read_events(mpq, file_contents),
    }
}

/// Attempts to read the message events, panics under unknown protocol
#[tracing::instrument(level = "error", skip(mpq, file_contents, file_name))]
pub fn read_message_events(
    file_name: &str,
    mpq: &MPQ,
    file_contents: &[u8],
) -> Result<Vec<MessageEvent>, S2ProtocolError> {
    let (_tail, proto_header) = crate::read_protocol_header(mpq)?;
    tracing::debug!(
        "Proto version: {:?} reading MessageEvents from {:?}",
        proto_header.m_version.m_base_build,
        file_name
    );
    assert_eq!(proto_header.m_signature, b"StarCraft II replay\x1b11"[..]);
    match proto_header.m_version.m_base_build {
        0..=75689 => protocol75689::bit_packed::GameEMessageId::read_events(mpq, file_contents),
        83830 | 84643 | 88500 | 86383 | 87702 | 89634 | 89165 | 89720 | 90136 | 90779 | 90870
        | 91115 => protocol87702::bit_packed::GameEMessageId::read_events(mpq, file_contents),
        _ => protocol87702::bit_packed::GameEMessageId::read_events(mpq, file_contents),
    }
}

/// Attempts to read the details, panics under unknown protocol
#[tracing::instrument(level = "error", skip(mpq, file_contents, file_name))]
pub fn read_details(
    file_name: &str,
    mpq: &MPQ,
    file_contents: &[u8],
) -> Result<Details, S2ProtocolError> {
    let (_tail, proto_header) = crate::read_protocol_header(mpq)?;
    tracing::debug!(
        "Proto version: {:?} reading Details from {:?}",
        proto_header.m_version.m_base_build,
        file_name
    );
    assert_eq!(proto_header.m_signature, b"StarCraft II replay\x1b11"[..]);
    match proto_header.m_version.m_base_build {
        0..=75689 => protocol75689::byte_aligned::GameSDetails::read_details(mpq, file_contents),
        83830 | 84643 | 88500 | 86383 | 87702 | 89634 | 89165 | 89720 | 90136 | 90779 | 90870
        | 91115 => protocol87702::byte_aligned::GameSDetails::read_details(mpq, file_contents),
        _ => protocol87702::byte_aligned::GameSDetails::read_details(mpq, file_contents),
    }
}

/// Attempts to read the initData, panics if signature doesn't match
#[tracing::instrument(level = "error", skip(mpq, file_contents, file_name))]
pub fn read_init_data(
    file_name: &str,
    mpq: &MPQ,
    file_contents: &[u8],
) -> Result<InitData, S2ProtocolError> {
    let (_tail, proto_header) = crate::read_protocol_header(mpq)?;
    tracing::debug!(
        "Proto version: {:?} reading InitData from {:?}",
        proto_header.m_version.m_base_build,
        file_name
    );
    assert_eq!(proto_header.m_signature, b"StarCraft II replay\x1b11"[..]);
    let res = match proto_header.m_version.m_base_build {
        0..=75689 => protocol75689::bit_packed::ReplaySInitData::read_init_data(mpq, file_contents),
        83830 | 84643 | 88500 | 86383 | 87702 | 89634 | 89165 | 89720 | 90136 | 90779 | 90870
        | 91115 => protocol87702::bit_packed::ReplaySInitData::read_init_data(mpq, file_contents),
        _ => protocol87702::bit_packed::ReplaySInitData::read_init_data(mpq, file_contents),
    };
    Ok(res?.with_version(proto_header.m_version.m_base_build))
}

#[cfg(test)]
mod tests {
    use crate::versions::protocol87702::byte_aligned::ReplayTrackerEEventId;

    #[test_log::test]
    fn it_reads_tracker_events() {
        let data: Vec<u8> = vec![
            0x03, 0x00, 0x09, 0x00, 0x09, 0x12, 0x05, 0x08, 0x00, 0x09, 0x02, 0x02, 0x09, 0x02,
            0x04, 0x04, 0x01, 0x09, 0x00, 0x06, 0x04, 0x01, 0x09, 0x00, 0x03, 0x00, 0x09, 0x00,
            0x09, 0x12, 0x05, 0x08, 0x00, 0x09, 0x04, 0x02, 0x09, 0x02, 0x04, 0x04, 0x01, 0x09,
            0x02, 0x06, 0x04, 0x01, 0x09, 0x02, 0x03, 0x00, 0x09, 0x00, 0x09, 0x12, 0x05, 0x08,
            0x00, 0x09, 0x06, 0x02, 0x09, 0x04, 0x04, 0x04, 0x00, 0x06, 0x04, 0x01, 0x09, 0x04,
        ];
        let (tail, (_delta, first_tracker_event)) =
            ReplayTrackerEEventId::parse_event_pair(&data).unwrap();
        if let ReplayTrackerEEventId::EPlayerSetup(setup_event) = first_tracker_event {
            assert_eq!(setup_event.m_player_id, 1);
            assert_eq!(setup_event.m_slot_id, Some(0));
            assert_eq!(setup_event.m_type, 1);
            assert_eq!(setup_event.m_user_id, Some(0));
        } else {
            unreachable!("Expected type EPlayerSetup from first event");
        }
        let (_event_tail, (_delta, second_tracker_event)) =
            ReplayTrackerEEventId::parse_event_pair(tail).expect("Unable to parse TrackerEvents");
        if let ReplayTrackerEEventId::EPlayerSetup(setup_event) = second_tracker_event {
            assert_eq!(setup_event.m_player_id, 2);
            assert_eq!(setup_event.m_slot_id, Some(1));
            assert_eq!(setup_event.m_type, 1);
            assert_eq!(setup_event.m_user_id, Some(1));
        } else {
            unreachable!("Expected type EPlayerSetup from first event");
        }
    }
}