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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
pub use crate::navmesh::NavArea;
use crate::navmesh::NavQuad;
use crate::{Connections, EncounterPath, LadderConnections, NavHidingSpot, VisibleArea};
use bitbuffer::{BitRead, BitReadStream, LittleEndian};
use err_derive::Error;

/// Errors that can occur when parsing the binary nav file
#[derive(Debug, Error)]
pub enum ParseError {
    /// An error ocured when reading from the source binary data
    #[error(display = "Error while reading from data: {}", _0)]
    ReadError(#[error(source)] bitbuffer::ReadError),
    #[error(
        display = "Invalid magic number ({:#8X}), not a nav file or corrupted",
        _0
    )]
    /// The binary data contained an invalid magic number and is probably not a nav file
    InvalidMagicNumber(u32),
    /// The version of the nav file is not supported by this parser
    #[error(display = "The major version for this nav ({}), is not supported", _0)]
    UnsupportedVersion(u32),
}

/// Parse all navigation areas from a nav file
///
/// ## Examples
///
/// ```no_run
/// use sourcenav::read_areas;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let file = std::fs::read("path/to/navfile.nav")?;
/// let tree = read_areas(file)?;
/// # Ok(())
/// # }
/// ```
pub fn read_areas(
    data: impl Into<BitReadStream<LittleEndian>>,
) -> Result<Vec<NavArea>, ParseError> {
    let mut data = data.into();
    let magic = data.read()?;
    if magic != 0xFEED_FACE {
        return Err(ParseError::InvalidMagicNumber(magic));
    }

    let major_version: u32 = data.read()?;

    if major_version < 6 || major_version > 16 {
        return Err(ParseError::UnsupportedVersion(major_version));
    }

    let _minor_version: u32 = if major_version >= 10 { data.read()? } else { 0 };

    let _size: u32 = data.read()?;

    let _is_analysed = if major_version >= 14 {
        data.read_int::<u8>(8)? == 1
    } else {
        false
    };

    let place_count: u16 = data.read()?;

    // let places = Vec::with_capacity(place_count as usize);
    for _id in 1..=place_count {
        let name_length: u16 = data.read()?;
        let _name = data.read_string(Some(name_length as usize))?;
        // TODO
    }

    let _has_unnamed_areas = if major_version >= 12 {
        data.read_int::<u8>(8)? == 1
    } else {
        false
    };

    let area_count: u32 = data.read()?;

    let mut areas = Vec::with_capacity(area_count as usize);

    for _ in 0..area_count {
        let id = data.read()?;

        let flags = if major_version <= 8 {
            data.read_int(8)?
        } else if major_version <= 12 {
            data.read_int(16)?
        } else {
            data.read_int(32)?
        };

        let north_west = data.read()?;
        let south_east = data.read()?;
        let north_east_z = data.read()?;
        let south_west_z = data.read()?;

        let connections = data.read()?;

        let hiding_spots_count: u8 = data.read()?;
        let hiding_spots = data.read_sized(hiding_spots_count as usize)?;

        let approach_areas = if major_version < 15 {
            let approach_area_count: u8 = data.read()?;

            data.read_sized(approach_area_count as usize)?
        } else {
            Vec::new()
        };

        let encounter_paths_count: u32 = data.read()?;
        let encounter_paths = data.read_sized(encounter_paths_count as usize)?;

        let place = data.read()?;

        let ladder_connections = data.read()?;

        let earliest_occupy_first_team = data.read()?;
        let earliest_occupy_second_team = data.read()?;

        let light_intensity = if major_version >= 11 {
            data.read()?
        } else {
            Default::default()
        };

        let visible_areas = if major_version >= 16 {
            let visible_areas_count: u32 = data.read()?;
            data.read_sized(visible_areas_count as usize)?
        } else {
            Vec::new()
        };

        let inherit_visibility_from_area_id = data.read()?;

        data.skip_bits(32)?;

        areas.push(NavArea {
            id,
            quad: NavQuad {
                north_west,
                south_east,
                north_east_z,
                south_west_z,
            },
            flags,
            connections,
            hiding_spots,
            approach_areas,
            encounter_paths,
            place,
            ladder_connections,
            earliest_occupy_first_team,
            earliest_occupy_second_team,
            light_intensity,
            visible_areas,
            inherit_visibility_from_area_id,
        });
    }

    debug_assert!(data.bits_left() <= 32);

    Ok(areas)
}

pub(crate) fn read_quads(
    mut data: BitReadStream<LittleEndian>,
) -> Result<Vec<NavQuad>, ParseError> {
    let magic = data.read()?;
    if magic != 0xFEED_FACE {
        return Err(ParseError::InvalidMagicNumber(magic));
    }

    let major_version: u32 = data.read()?;

    if major_version != 16 {
        return Err(ParseError::UnsupportedVersion(major_version));
    }

    let _minor_version: u32 = if major_version >= 10 { data.read()? } else { 0 };

    let _size: u32 = data.read()?;

    let _is_analysed = if major_version >= 14 {
        data.read_int::<u8>(8)? == 1
    } else {
        false
    };

    let place_count: u16 = data.read()?;

    // let places = Vec::with_capacity(place_count as usize);
    for _id in 1..=place_count {
        let name_length: u16 = data.read()?;
        let _name = data.read_string(Some(name_length as usize))?;
        // TODO
    }

    let _has_unnamed_areas = if major_version >= 12 {
        data.read_int::<u8>(8)? == 1
    } else {
        false
    };

    let area_count: u32 = data.read()?;

    let mut areas = Vec::with_capacity(area_count as usize);

    for _ in 0..area_count {
        data.skip_bits(32 * 2)?; // id and flags

        let north_west = data.read()?;
        let south_east = data.read()?;
        let north_east_z = data.read()?;
        let south_west_z = data.read()?;

        Connections::skip(&mut data)?;

        let hiding_spots_count: u8 = data.read()?;
        data.skip_bits(
            <NavHidingSpot as BitRead<LittleEndian>>::bit_size().unwrap()
                * hiding_spots_count as usize,
        )?;

        let encounter_paths_count: u32 = data.read()?;
        for _ in 0..encounter_paths_count {
            EncounterPath::skip(&mut data)?;
        }

        data.skip_bits(16)?; // place

        LadderConnections::skip(&mut data)?;

        data.skip_bits((32 * 2) + (32 * 4))?; // occupy time, light intensity

        let visible_areas_count: u32 = data.read()?;
        data.skip_bits(
            <VisibleArea as BitRead<LittleEndian>>::bit_size().unwrap()
                * visible_areas_count as usize,
        )?;

        data.skip_bits(32 * 2)?; // inherit visible, garbage

        areas.push(NavQuad {
            north_west,
            south_east,
            north_east_z,
            south_west_z,
        });
    }

    debug_assert!(data.bits_left() <= 32);

    Ok(areas)
}

#[test]
fn test() {
    let file = std::fs::read("data/pl_badwater.nav").unwrap();
    let data = BitReadStream::new(bitbuffer::BitReadBuffer::new(file, LittleEndian));
    let areas = read_areas(data).unwrap();
    assert_eq!(1930, areas.len());
}

#[test]
fn test_quads() {
    let file = std::fs::read("data/pl_badwater.nav").unwrap();
    let data = BitReadStream::new(bitbuffer::BitReadBuffer::new(file, LittleEndian));
    let quads = read_quads(data).unwrap();
    assert_eq!(1930, quads.len());
}