car-parser-deepmap2 0.1.0

Parser for DeepMap2 data structures in Apple .car asset catalogs
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
use std::collections::BTreeMap;

use crate::model::PixelFormat;
use crate::{DecodedImage, Deepmap2Error, Deepmap2Result};

/// KCBC 块信息
struct KcbcBlock<'a> {
    #[allow(dead_code)]
    offset: usize,
    /// 0x04 字段:列索引(tile 在网格中的列号,从 0 开始)
    #[allow(dead_code)]
    col_index: u32,
    /// 0x08 字段:行索引(tile 在网格中的行号,从 0 开始)
    #[allow(dead_code)]
    row_index: u32,
    /// row_hint:该块实际输出的行数(从 offset+0x0C 读取)
    row_hint: u32,
    /// 该块包含的 dmp2 原始数据(从 dmp2 magic 到下一个块开始或数据末尾)
    dmp2_data: &'a [u8],
}

/// 扫描 data 中所有 "KCBC" magic,返回块信息列表。
///
/// 如果发现 KCBC magic 但头部不完整(截断),返回错误。
fn parse_kcbc_blocks(data: &[u8]) -> Deepmap2Result<Vec<KcbcBlock<'_>>> {
    let mut blocks = Vec::new();
    let mut search_offset = 0;

    while let Some(rel) = find_bytes(&data[search_offset..], b"KCBC") {
        let block_offset = search_offset + rel;
        if block_offset + 20 > data.len() {
            return Err(Deepmap2Error::InvalidData(
                "KCBC 块头被截断:数据不足 20 字节".to_string(),
            ));
        }

        let col_index = u32::from_le_bytes(
            data[block_offset + 0x04..block_offset + 0x08]
                .try_into()
                .unwrap(),
        );
        let row_index = u32::from_le_bytes(
            data[block_offset + 0x08..block_offset + 0x0C]
                .try_into()
                .unwrap(),
        );
        let row_hint = u32::from_le_bytes(
            data[block_offset + 0x0C..block_offset + 0x10]
                .try_into()
                .unwrap(),
        );
        let block_length = u32::from_le_bytes(
            data[block_offset + 0x10..block_offset + 0x14]
                .try_into()
                .unwrap(),
        ) as usize;

        // 确定块的数据范围
        let block_end = if block_length >= 0x20 && block_offset + block_length <= data.len() {
            block_offset + block_length
        } else {
            // 找到下一个 KCBC 或使用剩余全部数据
            find_bytes(&data[block_offset + 4..], b"KCBC")
                .map(|r| block_offset + 4 + r)
                .unwrap_or(data.len())
        };

        let block_span = &data[block_offset..block_end];

        // 在块范围内查找 dmp2 magic(缺失则报错,不静默跳过)
        let dmp2_rel = find_bytes(block_span, b"dmp2")
            .ok_or_else(|| Deepmap2Error::InvalidData("KCBC 块中未找到 dmp2 头部".to_string()))?;
        let dmp2_data = &block_span[dmp2_rel..];
        blocks.push(KcbcBlock {
            offset: block_offset,
            col_index,
            row_index,
            row_hint,
            dmp2_data,
        });

        search_offset = block_end;
    }

    Ok(blocks)
}

/// 在切片中搜索子序列,返回第一次出现的偏移量
pub fn find_bytes(haystack: &[u8], needle: &[u8]) -> Option<usize> {
    haystack.windows(needle.len()).position(|w| w == needle)
}

/// 从包含 KCBC 块的 data 中解析各块内嵌的 dmp2 数据切片
///
/// 返回每个 tile 的原始 dmp2 字节(可直接传给 `decode()`)
pub fn parse_kcbc(data: &[u8]) -> Deepmap2Result<Vec<Vec<u8>>> {
    let blocks = parse_kcbc_blocks(data)?;
    if blocks.is_empty() {
        return Err(Deepmap2Error::InvalidData(
            "输入数据中未找到 KCBC 块".to_string(),
        ));
    }
    Ok(blocks.into_iter().map(|b| b.dmp2_data.to_vec()).collect())
}

/// 解码 KCBC 序列,按 row_index/col_index 还原 tile 网格。
pub fn decode_kcbc_sequence(data: &[u8]) -> Deepmap2Result<DecodedImage> {
    decode_kcbc_sequence_with_options(data, None, None, None)
}

pub fn decode_kcbc_sequence_with_options(
    data: &[u8],
    expected_width: Option<u16>,
    expected_height: Option<u16>,
    pixel_format_override: Option<PixelFormat>,
) -> Deepmap2Result<DecodedImage> {
    use crate::raw::Deepmap2Header;
    use deku::prelude::*;

    let blocks = parse_kcbc_blocks(data)?;
    if blocks.is_empty() {
        return Err(Deepmap2Error::InvalidData(
            "输入数据中未找到 KCBC 块".to_string(),
        ));
    }

    struct TileInfo {
        col_index: u32,
        row_index: u32,
        width: usize,
        height: usize,
        rgba: Vec<u8>,
        header: Deepmap2Header,
    }

    let mut tiles = Vec::with_capacity(blocks.len());
    let mut column_widths: BTreeMap<u32, usize> = BTreeMap::new();
    let mut row_heights: BTreeMap<u32, usize> = BTreeMap::new();

    for block in &blocks {
        let (tw, th, rgba, header) =
            decode_tile(block.dmp2_data, block.row_hint, pixel_format_override)?;
        let width = tw as usize;
        let height = th as usize;
        column_widths
            .entry(block.col_index)
            .and_modify(|existing| *existing = (*existing).max(width))
            .or_insert(width);
        row_heights
            .entry(block.row_index)
            .and_modify(|existing| *existing = (*existing).max(height))
            .or_insert(height);

        tiles.push(TileInfo {
            col_index: block.col_index,
            row_index: block.row_index,
            width: tw as usize,
            height: th as usize,
            rgba,
            header,
        });
    }

    let mut x_offsets = BTreeMap::new();
    let mut total_width = 0usize;
    for (&col_index, &width) in &column_widths {
        x_offsets.insert(col_index, total_width);
        total_width = total_width
            .checked_add(width)
            .filter(|&value| value <= u16::MAX as usize)
            .ok_or_else(|| Deepmap2Error::InvalidData("KCBC 输出宽度超出 u16 范围".to_string()))?;
    }

    let mut y_offsets = BTreeMap::new();
    let mut total_height = 0usize;
    for (&row_index, &height) in &row_heights {
        y_offsets.insert(row_index, total_height);
        total_height = total_height
            .checked_add(height)
            .filter(|&value| value <= u16::MAX as usize)
            .ok_or_else(|| Deepmap2Error::InvalidData("KCBC 输出高度超出 u16 范围".to_string()))?;
    }

    if let Some(expected_width) = expected_width
        && total_width != expected_width as usize
    {
        return Err(Deepmap2Error::InvalidData(format!(
            "KCBC 输出宽度不一致: 期望 {}, 实际 {}",
            expected_width, total_width
        )));
    }
    if let Some(expected_height) = expected_height
        && total_height != expected_height as usize
    {
        return Err(Deepmap2Error::InvalidData(format!(
            "KCBC 输出高度不一致: 期望 {}, 实际 {}",
            expected_height, total_height
        )));
    }

    let rgba_len = total_width
        .checked_mul(total_height)
        .and_then(|pixels| pixels.checked_mul(4))
        .ok_or_else(|| Deepmap2Error::InvalidData("KCBC 输出像素缓冲区大小溢出".to_string()))?;
    let mut rgba = vec![0u8; rgba_len];
    for tile in &tiles {
        let Some(&dst_x) = x_offsets.get(&tile.col_index) else {
            return Err(Deepmap2Error::InvalidData(format!(
                "KCBC 缺少列偏移: col_index={}",
                tile.col_index
            )));
        };
        let Some(&dst_y) = y_offsets.get(&tile.row_index) else {
            return Err(Deepmap2Error::InvalidData(format!(
                "KCBC 缺少行偏移: row_index={}",
                tile.row_index
            )));
        };

        for row in 0..tile.height {
            let src_start = row * tile.width * 4;
            let src_end = src_start + tile.width * 4;
            let dst_start = ((dst_y + row) * total_width + dst_x) * 4;
            let dst_end = dst_start + tile.width * 4;
            rgba[dst_start..dst_end].copy_from_slice(&tile.rgba[src_start..src_end]);
        }
    }

    let mut cursor = std::io::Cursor::new(blocks[0].dmp2_data);
    let mut reader = Reader::new(&mut cursor);
    let source_header = tiles
        .first()
        .map(|tile| tile.header.clone())
        .unwrap_or_else(|| Deepmap2Header::from_reader_with_ctx(&mut reader, ()).unwrap());

    Ok(DecodedImage {
        source_header: source_header.clone(),
        width: total_width as u16,
        height: total_height as u16,
        pixel_format: pixel_format_override.unwrap_or(source_header.pixel_format),
        rgba,
    })
}

/// 解码单个 tile 的 dmp2 数据,row_hint=0 时使用 header.height
fn decode_tile(
    dmp2_data: &[u8],
    row_hint: u32,
    pixel_format_override: Option<PixelFormat>,
) -> Deepmap2Result<(u16, u16, Vec<u8>, crate::model::Deepmap2Header)> {
    use crate::raw::Deepmap2Header;
    use deku::prelude::*;

    let mut cursor = std::io::Cursor::new(dmp2_data);
    let mut reader = Reader::new(&mut cursor);
    let header = Deepmap2Header::from_reader_with_ctx(&mut reader, ())?;
    let header_size = header.header_size();
    let payload = dmp2_data
        .get(header_size..)
        .ok_or(Deepmap2Error::Truncated)?;

    let output_height = if row_hint > 0 {
        u16::try_from(row_hint).map_err(|_| {
            Deepmap2Error::InvalidData(format!("KCBC row_hint 超出 u16 范围: {row_hint}"))
        })?
    } else {
        header.height
    };

    let output_width = header.width;
    let rgba = crate::codec::decode_raw_with_options(
        &header,
        payload,
        Some(output_width),
        Some(output_height),
        pixel_format_override,
    )?;

    let mut header = header;
    header.width = output_width;
    header.height = output_height;
    if let Some(pixel_format) = pixel_format_override {
        header.pixel_format = pixel_format;
    }

    Ok((output_width, output_height, rgba, header))
}

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

    /// 构造最小 dmp2 数据(Type 1=None, G8, 无压缩)
    fn build_dmp2_none_g8(width: u16, height: u16, pixels: &[u8]) -> Vec<u8> {
        assert_eq!(pixels.len(), width as usize * height as usize);
        let mut data = Vec::new();
        data.extend_from_slice(b"dmp2");
        data.push(0x01); // decode_type = None
        data.push(0x00); // version
        data.push(0x00); // predictor_type
        data.push(0x01); // pixel_format = G8
        data.extend_from_slice(&width.to_le_bytes());
        data.extend_from_slice(&height.to_le_bytes());
        data.extend_from_slice(pixels);
        data
    }

    /// 构造 KCBC 容器,tiles: &[(row, col, row_hint, dmp2_data)]
    fn build_kcbc(tiles: &[(u32, u32, u32, &[u8])]) -> Vec<u8> {
        let mut data = Vec::new();
        for &(row, col, row_hint, dmp2) in tiles {
            let block_len = (20 + dmp2.len()) as u32;
            data.extend_from_slice(b"KCBC");
            data.extend_from_slice(&col.to_le_bytes());
            data.extend_from_slice(&row.to_le_bytes());
            data.extend_from_slice(&row_hint.to_le_bytes());
            data.extend_from_slice(&block_len.to_le_bytes());
            data.extend_from_slice(dmp2);
        }
        data
    }

    #[test]
    fn decode_kcbc_single_tile_matches_decode() {
        let pixels = [10u8, 20, 30, 40];
        let dmp2 = build_dmp2_none_g8(2, 2, &pixels);

        let kcbc = build_kcbc(&[(0, 0, 2, &dmp2)]);
        let kcbc_img = crate::decode_kcbc(&kcbc).unwrap();
        let raw_img = crate::decode(&dmp2).unwrap();

        assert_eq!(kcbc_img.width, raw_img.width);
        assert_eq!(kcbc_img.height, raw_img.height);
        assert_eq!(kcbc_img.rgba, raw_img.rgba);
    }

    #[test]
    fn decode_kcbc_multi_band_vertical_stitch() {
        let top = build_dmp2_none_g8(2, 2, &[1, 2, 3, 4]);
        let middle = build_dmp2_none_g8(2, 1, &[5, 6]);
        let bottom = build_dmp2_none_g8(2, 2, &[7, 8, 9, 10]);

        let kcbc = build_kcbc(&[(0, 0, 2, &top), (1, 0, 1, &middle), (2, 0, 2, &bottom)]);

        let img = crate::decode_kcbc(&kcbc).unwrap();
        assert_eq!(img.width, 2);
        assert_eq!(img.height, 5);

        let px = |gray: u8| -> [u8; 4] { [gray, gray, gray, 0xFF] };
        let expected: Vec<u8> = [
            px(1),
            px(2),
            px(3),
            px(4),
            px(5),
            px(6),
            px(7),
            px(8),
            px(9),
            px(10),
        ]
        .concat();
        assert_eq!(img.rgba, expected);
    }

    #[test]
    fn decode_kcbc_grid_tiles_respect_row_and_col_indices() {
        let top_left = build_dmp2_none_g8(1, 1, &[1]);
        let top_right = build_dmp2_none_g8(1, 1, &[2]);
        let bottom_left = build_dmp2_none_g8(1, 1, &[3]);
        let bottom_right = build_dmp2_none_g8(1, 1, &[4]);

        let kcbc = build_kcbc(&[
            (0, 0, 1, &top_left),
            (0, 1, 1, &top_right),
            (1, 0, 1, &bottom_left),
            (1, 1, 1, &bottom_right),
        ]);

        let img = decode_kcbc_sequence_with_options(&kcbc, Some(2), Some(2), None).unwrap();
        assert_eq!(img.width, 2);
        assert_eq!(img.height, 2);

        let px = |gray: u8| -> [u8; 4] { [gray, gray, gray, 0xFF] };
        let expected: Vec<u8> = [px(1), px(2), px(3), px(4)].concat();
        assert_eq!(img.rgba, expected);
    }

    #[test]
    fn decode_kcbc_rejects_stitched_dimensions_exceeding_u16() {
        for vertical in [false, true] {
            let (width, height) = if vertical {
                (1, u16::MAX)
            } else {
                (u16::MAX, 1)
            };
            let large = build_dmp2_none_g8(width, height, &vec![5; u16::MAX as usize]);
            let extra = build_dmp2_none_g8(1, 1, &[6]);
            let (row, col) = if vertical { (1, 0) } else { (0, 1) };
            let kcbc = build_kcbc(&[(0, 0, 0, &large), (row, col, 0, &extra)]);
            let err = crate::decode_kcbc(&kcbc)
                .err()
                .expect("stitched dimensions must fit u16");
            assert!(format!("{err}").contains("u16"));
        }
    }

    #[test]
    fn decode_kcbc_accepts_stitched_dimensions_at_u16_limit() {
        for vertical in [false, true] {
            let (width, height) = if vertical {
                (1, u16::MAX - 1)
            } else {
                (u16::MAX - 1, 1)
            };
            let large = build_dmp2_none_g8(width, height, &vec![5; (u16::MAX - 1) as usize]);
            let extra = build_dmp2_none_g8(1, 1, &[6]);
            let (row, col) = if vertical { (1, 0) } else { (0, 1) };
            let kcbc = build_kcbc(&[(0, 0, 0, &large), (row, col, 0, &extra)]);
            let image = crate::decode_kcbc(&kcbc).unwrap();
            let expected_size = if vertical {
                (1, u16::MAX)
            } else {
                (u16::MAX, 1)
            };
            assert_eq!((image.width, image.height), expected_size);
            assert_eq!(image.rgba.len(), u16::MAX as usize * 4);
            assert_eq!(&image.rgba[image.rgba.len() - 4..], &[6, 6, 6, 255]);
        }
    }

    #[test]
    fn decode_tile_rejects_row_hint_exceeding_u16() {
        let dmp2 = build_dmp2_none_g8(2, 2, &[0; 4]);
        let kcbc = build_kcbc(&[(0, 0, 65536, &dmp2)]); // u16::MAX + 1
        let result = crate::decode_kcbc(&kcbc);
        let err = result.err().expect("should error on oversized row_hint");
        let msg = format!("{err}");
        assert!(msg.contains("u16"), "should mention u16 overflow: {msg}");
    }

    #[test]
    fn parse_kcbc_empty_data_returns_error() {
        let result = parse_kcbc(b"no kcbc here");
        assert!(result.is_err());
    }

    #[test]
    fn parse_kcbc_truncated_header_returns_error() {
        // KCBC magic 后面只有 10 字节(不足 16 字节头部数据),应返回错误
        let mut data = b"KCBC".to_vec();
        data.extend_from_slice(&[0u8; 10]);
        let result = parse_kcbc(&data);
        assert!(result.is_err());
        let err_msg = format!("{}", result.unwrap_err());
        assert!(
            err_msg.contains("截断"),
            "error should mention truncation: {err_msg}"
        );
    }

    #[test]
    fn parse_kcbc_truncated_second_block_returns_error() {
        // 第一个完整 KCBC 块 + 第二个截断的 KCBC 块
        let mut data = Vec::new();
        // Block 1: KCBC header (20 bytes) + "dmp2" magic + some payload
        data.extend_from_slice(b"KCBC");
        data.extend_from_slice(&0u32.to_le_bytes()); // col_index
        data.extend_from_slice(&0u32.to_le_bytes()); // row_index
        data.extend_from_slice(&10u32.to_le_bytes()); // row_hint
        data.extend_from_slice(&0u32.to_le_bytes()); // block_length=0 (will use next KCBC)
        data.extend_from_slice(b"dmp2");
        data.extend_from_slice(&[0u8; 8]); // some dmp2 data
        // Block 2: truncated KCBC (only magic + 8 bytes, need 16 more)
        data.extend_from_slice(b"KCBC");
        data.extend_from_slice(&[0u8; 8]); // only 8 bytes, need 16

        let result = parse_kcbc(&data);
        assert!(result.is_err(), "should error on truncated second block");
    }

    #[test]
    fn find_bytes_found() {
        assert_eq!(find_bytes(b"hello world", b"world"), Some(6));
    }

    #[test]
    fn find_bytes_not_found() {
        assert_eq!(find_bytes(b"hello", b"xyz"), None);
    }
}