cridecoder 0.1.2

CRI codec library for ACB/AWB, HCA audio, and USM video extraction
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
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
//! UTF table parser (CRI's custom table format)

use crate::acb::consts::*;
use crate::reader::Reader;
use std::collections::HashMap;
use std::io::{Read, Seek, SeekFrom};
use thiserror::Error;

#[derive(Error, Debug)]
pub enum UtfError {
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),
    #[error("Invalid UTF magic: 0x{0:08X}")]
    BadMagic(u32),
    #[error("UTF table has no columns")]
    NoColumns,
    #[error("UTF schema too large: {0}")]
    SchemaTooLarge(u32),
    #[error("UTF offset out of bounds")]
    OffsetOutOfBounds,
    #[error("Unknown column flag: 0x{0:02X}")]
    UnknownColumnFlag(u8),
    #[error("Unknown column type: 0x{0:02X}")]
    UnknownColumnType(u8),
    #[error("Field not found: {0}")]
    FieldNotFound(String),
}

/// UTF table header
#[derive(Debug, Clone, Default)]
pub struct UtfHeader {
    pub table_size: u32,
    pub version: u16,
    pub row_offset: u16,
    pub string_table_offset: u32,
    pub data_offset: u32,
    pub table_name_offset: u32,
    pub number_of_fields: u16,
    pub row_size: u16,
    pub number_of_rows: u32,
}

/// Dynamic value type for UTF table columns
#[derive(Debug, Clone)]
pub enum Value {
    U8(u8),
    I8(i8),
    U16(u16),
    I16(i16),
    U32(u32),
    I32(i32),
    U64(u64),
    F32(f32),
    String(String),
    Data(Vec<u8>),
}

impl Value {
    pub fn as_bytes(&self) -> Option<&[u8]> {
        match self {
            Value::Data(v) => Some(v),
            _ => None,
        }
    }

    pub fn as_string(&self) -> Option<&str> {
        match self {
            Value::String(s) => Some(s),
            _ => None,
        }
    }

    pub fn as_int(&self) -> Option<i64> {
        match self {
            Value::U8(v) => Some(*v as i64),
            Value::I8(v) => Some(*v as i64),
            Value::U16(v) => Some(*v as i64),
            Value::I16(v) => Some(*v as i64),
            Value::U32(v) => Some(*v as i64),
            Value::I32(v) => Some(*v as i64),
            Value::U64(v) => Some(*v as i64),
            _ => None,
        }
    }
}

/// Column schema information
#[derive(Debug, Clone)]
struct ColumnSchema {
    flag: u8,
    typ: u8,
    name: String,
    offset: u32, // for ROW: offset within row
}

/// Deferred data references (for constants)
#[derive(Debug, Clone)]
enum Promise {
    Data { offset: u32, size: u32 },
    String { offset: u32 },
}

/// UTF table
#[derive(Debug, Clone)]
pub struct UtfTable {
    pub header: UtfHeader,
    pub name: String,
    pub dynamic_keys: Vec<String>,
    pub constants: HashMap<String, Value>,
    pub rows: Vec<HashMap<String, Value>>,
}

const UTF_MAX_SCHEMA_SIZE: u32 = 0x8000;

impl UtfTable {
    /// Parse a UTF table from a reader
    pub fn new<R: Read + Seek>(r: R) -> Result<Self, UtfError> {
        let mut buf = Reader::new(r);

        // Read and validate magic
        let magic = buf.read_u32()?;
        if magic != 0x40555446 {
            // "@UTF"
            return Err(UtfError::BadMagic(magic));
        }

        // Read header fields (all big-endian)
        let header = UtfHeader {
            table_size: buf.read_u32()?,
            version: buf.read_u16()?,
            row_offset: buf.read_u16()?,
            string_table_offset: buf.read_u32()?,
            data_offset: buf.read_u32()?,
            table_name_offset: buf.read_u32()?,
            number_of_fields: buf.read_u16()?,
            row_size: buf.read_u16()?,
            number_of_rows: buf.read_u32()?,
        };

        // Offsets in the header are relative to byte 8 (after magic + table_size)
        let abs_row_offset = header.row_offset as u32 + 8;
        let abs_string_offset = header.string_table_offset + 8;
        let abs_data_offset = header.data_offset + 8;

        // Validation (matching vgmstream)
        let schema_offset: u32 = 0x20;
        let schema_size = abs_row_offset - schema_offset;
        if header.number_of_fields == 0 {
            return Err(UtfError::NoColumns);
        }
        if schema_size >= UTF_MAX_SCHEMA_SIZE {
            return Err(UtfError::SchemaTooLarge(schema_size));
        }
        if abs_row_offset > header.table_size + 8
            || abs_string_offset > header.table_size + 8
            || abs_data_offset > header.table_size + 8
        {
            return Err(UtfError::OffsetOutOfBounds);
        }

        // Read table name
        let table_name =
            buf.read_string0_at(abs_string_offset as u64 + header.table_name_offset as u64)?;

        // Parse schema
        let (schema, dynamic_keys, constants) =
            Self::parse_schema(&mut buf, &header, abs_string_offset, abs_data_offset)?;

        // Read rows
        let rows = Self::read_rows(
            &mut buf,
            &header,
            &schema,
            &constants,
            abs_row_offset,
            abs_string_offset,
            abs_data_offset,
        )?;

        Ok(Self {
            header,
            name: table_name,
            dynamic_keys,
            constants,
            rows,
        })
    }

    fn column_value_size(typ: u8) -> Result<u32, UtfError> {
        match typ {
            COLUMN_TYPE_1BYTE | COLUMN_TYPE_1BYTE2 => Ok(1),
            COLUMN_TYPE_2BYTE | COLUMN_TYPE_2BYTE2 => Ok(2),
            COLUMN_TYPE_4BYTE | COLUMN_TYPE_4BYTE2 | COLUMN_TYPE_FLOAT | COLUMN_TYPE_STRING => {
                Ok(4)
            }
            COLUMN_TYPE_8BYTE | COLUMN_TYPE_DATA => Ok(8),
            _ => Err(UtfError::UnknownColumnType(typ)),
        }
    }

    #[allow(clippy::type_complexity)]
    fn parse_schema<R: Read + Seek>(
        buf: &mut Reader<R>,
        header: &UtfHeader,
        abs_string_offset: u32,
        abs_data_offset: u32,
    ) -> Result<(Vec<ColumnSchema>, Vec<String>, HashMap<String, Value>), UtfError> {
        buf.seek(SeekFrom::Start(0x20))?;

        let mut dynamic_keys = Vec::new();
        let mut constants = HashMap::new();
        let mut schema = Vec::with_capacity(header.number_of_fields as usize);
        let mut row_column_offset: u32 = 0;

        for _i in 0..header.number_of_fields {
            let info = buf.read_u8()?;
            let name_offset = buf.read_u32()?;

            let flag = info & COLUMN_FLAG_MASK;
            let typ = info & COLUMN_TYPE_MASK;

            // Validate flags (matching vgmstream)
            if flag == 0 || (flag & COLUMN_FLAG_NAME) == 0 || (flag & COLUMN_FLAG_UNDEFINED) != 0 {
                return Err(UtfError::UnknownColumnFlag(flag));
            }

            // Read column name
            let name = buf.read_string0_at(abs_string_offset as u64 + name_offset as u64)?;

            let val_size = Self::column_value_size(typ)?;

            let mut col = ColumnSchema {
                flag,
                typ,
                name: name.clone(),
                offset: 0,
            };

            // Handle DEFAULT: data is inline in schema area (constant value for all rows)
            if flag & COLUMN_FLAG_DEFAULT != 0 {
                let val = Self::read_column_value(
                    buf,
                    typ,
                    header,
                    abs_string_offset,
                    abs_data_offset,
                    true,
                )?;
                if let Some(v) = Self::resolve_promise_to_value(
                    buf,
                    &val,
                    header,
                    abs_string_offset,
                    abs_data_offset,
                )? {
                    constants.insert(name, v);
                }
            } else if flag & COLUMN_FLAG_ROW != 0 {
                // ROW: data is in per-row area at this offset
                col.offset = row_column_offset;
                row_column_offset += val_size;
                dynamic_keys.push(col.name.clone());
            }
            // NAME-only (flag == 0x10): column exists but has no data

            schema.push(col);
        }

        Ok((schema, dynamic_keys, constants))
    }

    fn read_column_value<R: Read + Seek>(
        buf: &mut Reader<R>,
        type_key: u8,
        _header: &UtfHeader,
        abs_string_offset: u32,
        abs_data_offset: u32,
        is_constant: bool,
    ) -> Result<ValueOrPromise, UtfError> {
        match type_key {
            COLUMN_TYPE_DATA => {
                let offset = buf.read_u32()?;
                let size = buf.read_u32()?;
                if is_constant {
                    Ok(ValueOrPromise::Promise(Promise::Data { offset, size }))
                } else {
                    let data =
                        buf.read_bytes_at(size as usize, (abs_data_offset + offset) as u64)?;
                    Ok(ValueOrPromise::Value(Value::Data(data)))
                }
            }
            COLUMN_TYPE_STRING => {
                let offset = buf.read_u32()?;
                if is_constant {
                    Ok(ValueOrPromise::Promise(Promise::String { offset }))
                } else {
                    let s = buf.read_string0_at((abs_string_offset + offset) as u64)?;
                    Ok(ValueOrPromise::Value(Value::String(s)))
                }
            }
            COLUMN_TYPE_FLOAT => Ok(ValueOrPromise::Value(Value::F32(buf.read_f32()?))),
            COLUMN_TYPE_8BYTE => Ok(ValueOrPromise::Value(Value::U64(buf.read_u64()?))),
            COLUMN_TYPE_4BYTE2 => Ok(ValueOrPromise::Value(Value::I32(buf.read_i32()?))),
            COLUMN_TYPE_4BYTE => Ok(ValueOrPromise::Value(Value::U32(buf.read_u32()?))),
            COLUMN_TYPE_2BYTE2 => Ok(ValueOrPromise::Value(Value::I16(buf.read_i16()?))),
            COLUMN_TYPE_2BYTE => Ok(ValueOrPromise::Value(Value::U16(buf.read_u16()?))),
            COLUMN_TYPE_1BYTE2 => Ok(ValueOrPromise::Value(Value::I8(buf.read_i8()?))),
            COLUMN_TYPE_1BYTE => Ok(ValueOrPromise::Value(Value::U8(buf.read_u8()?))),
            _ => Err(UtfError::UnknownColumnType(type_key)),
        }
    }

    fn resolve_promise_to_value<R: Read + Seek>(
        buf: &mut Reader<R>,
        val: &ValueOrPromise,
        _header: &UtfHeader,
        abs_string_offset: u32,
        abs_data_offset: u32,
    ) -> Result<Option<Value>, UtfError> {
        match val {
            ValueOrPromise::Value(v) => Ok(Some(v.clone())),
            ValueOrPromise::Promise(Promise::Data { offset, size }) => {
                let data = buf.read_bytes_at(*size as usize, (abs_data_offset + offset) as u64)?;
                Ok(Some(Value::Data(data)))
            }
            ValueOrPromise::Promise(Promise::String { offset }) => {
                let s = buf.read_string0_at((abs_string_offset + offset) as u64)?;
                Ok(Some(Value::String(s)))
            }
        }
    }

    fn read_rows<R: Read + Seek>(
        buf: &mut Reader<R>,
        header: &UtfHeader,
        schema: &[ColumnSchema],
        constants: &HashMap<String, Value>,
        abs_row_offset: u32,
        abs_string_offset: u32,
        abs_data_offset: u32,
    ) -> Result<Vec<HashMap<String, Value>>, UtfError> {
        let mut rows = Vec::with_capacity(header.number_of_rows as usize);

        for row_idx in 0..header.number_of_rows {
            let mut row = HashMap::new();

            // Copy resolved constants into every row
            for (k, v) in constants.iter() {
                row.insert(k.clone(), v.clone());
            }

            // Read per-row dynamic fields using pre-parsed schema
            for col in schema.iter() {
                // Skip columns that are not ROW columns
                if col.flag & COLUMN_FLAG_ROW == 0 || col.flag & COLUMN_FLAG_DEFAULT != 0 {
                    continue;
                }

                // Seek to exact position: row start + column offset within row
                let row_start = abs_row_offset as u64 + (row_idx as u64 * header.row_size as u64);
                let field_pos = row_start + col.offset as u64;
                buf.seek(SeekFrom::Start(field_pos))?;

                let val = Self::read_column_value(
                    buf,
                    col.typ,
                    header,
                    abs_string_offset,
                    abs_data_offset,
                    false,
                )?;
                if let Some(v) = Self::resolve_promise_to_value(
                    buf,
                    &val,
                    header,
                    abs_string_offset,
                    abs_data_offset,
                )? {
                    row.insert(col.name.clone(), v);
                }
            }

            rows.push(row);
        }

        Ok(rows)
    }
}

#[derive(Debug, Clone)]
enum ValueOrPromise {
    Value(Value),
    Promise(Promise),
}

/// Helper to get bytes field from a row
pub fn get_bytes_field<'a>(row: &'a HashMap<String, Value>, key: &str) -> Option<&'a [u8]> {
    row.get(key).and_then(|v| v.as_bytes())
}

/// Helper to get string field from a row
pub fn get_string_field<'a>(row: &'a HashMap<String, Value>, key: &str) -> Option<&'a str> {
    row.get(key).and_then(|v| v.as_string())
}

/// Helper to get integer field from a row
pub fn get_int_field(row: &HashMap<String, Value>, key: &str) -> i64 {
    row.get(key).and_then(|v| v.as_int()).unwrap_or(0)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_value_conversions() {
        let v = Value::U32(42);
        assert_eq!(v.as_int(), Some(42));

        let v = Value::String("test".to_string());
        assert_eq!(v.as_string(), Some("test"));

        let v = Value::Data(vec![1, 2, 3]);
        assert_eq!(v.as_bytes(), Some(&[1u8, 2, 3][..]));
    }
}