mp4forge 0.8.0

Rust library and CLI for inspecting, probing, extracting, muxing, and rewriting MP4 structures
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
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
use std::fs::File;
use std::io::{Read, Seek, SeekFrom};
use std::path::Path;

#[cfg(feature = "async")]
use tokio::fs::File as TokioFile;
#[cfg(feature = "async")]
use tokio::io::{AsyncReadExt, AsyncSeekExt};

use crate::FourCc;

use super::super::MuxError;
use super::super::import::StagedSample;
use super::raw_visual::build_mjp2_sample_entry_box;

const JP_SIGNATURE: FourCc = FourCc::from_bytes(*b"jP  ");
const JP2H: FourCc = FourCc::from_bytes(*b"jp2h");
const IHDR: FourCc = FourCc::from_bytes(*b"ihdr");
const JP2C: FourCc = FourCc::from_bytes(*b"jp2c");

pub(in crate::mux) struct ParsedJ2kTrack {
    pub(in crate::mux) width: u16,
    pub(in crate::mux) height: u16,
    pub(in crate::mux) sample_entry_box: Vec<u8>,
    pub(in crate::mux) samples: Vec<StagedSample>,
}

pub(in crate::mux) fn scan_j2k_file_sync(
    path: &Path,
    spec: &str,
) -> Result<ParsedJ2kTrack, MuxError> {
    let mut file = File::open(path)?;
    let file_size = file.metadata()?.len();
    parse_j2k_file_sync(spec, &mut file, file_size)
}

#[cfg(feature = "async")]
pub(in crate::mux) async fn scan_j2k_file_async(
    path: &Path,
    spec: &str,
) -> Result<ParsedJ2kTrack, MuxError> {
    let mut file = TokioFile::open(path).await?;
    let file_size = file.metadata().await?.len();
    parse_j2k_file_async(spec, &mut file, file_size).await
}

fn parse_j2k_file_sync(
    spec: &str,
    file: &mut File,
    file_size: u64,
) -> Result<ParsedJ2kTrack, MuxError> {
    let prefix = read_j2k_prefix_sync(file, file_size)?;
    if prefix.len() >= 12
        && u32::from_be_bytes(prefix[0..4].try_into().unwrap()) == 12
        && prefix[4..8] == *JP_SIGNATURE.as_bytes()
        && u32::from_be_bytes(prefix[8..12].try_into().unwrap()) == 0x0D0A_870A
    {
        return parse_jp2_file_sync(spec, file, file_size);
    }
    if prefix.len() >= 16 && u32::from_be_bytes(prefix[0..4].try_into().unwrap()) == 0xFF4F_FF51 {
        return parse_j2k_codestream_prefix(spec, &prefix, file_size);
    }
    Err(invalid_j2k(
        spec,
        "input is neither a JP2 image file nor a raw JPEG 2000 codestream",
    ))
}

#[cfg(feature = "async")]
async fn parse_j2k_file_async(
    spec: &str,
    file: &mut TokioFile,
    file_size: u64,
) -> Result<ParsedJ2kTrack, MuxError> {
    let prefix = read_j2k_prefix_async(file, file_size).await?;
    if prefix.len() >= 12
        && u32::from_be_bytes(prefix[0..4].try_into().unwrap()) == 12
        && prefix[4..8] == *JP_SIGNATURE.as_bytes()
        && u32::from_be_bytes(prefix[8..12].try_into().unwrap()) == 0x0D0A_870A
    {
        return parse_jp2_file_async(spec, file, file_size).await;
    }
    if prefix.len() >= 16 && u32::from_be_bytes(prefix[0..4].try_into().unwrap()) == 0xFF4F_FF51 {
        return parse_j2k_codestream_prefix(spec, &prefix, file_size);
    }
    Err(invalid_j2k(
        spec,
        "input is neither a JP2 image file nor a raw JPEG 2000 codestream",
    ))
}

fn parse_jp2_file_sync(
    spec: &str,
    file: &mut File,
    file_size: u64,
) -> Result<ParsedJ2kTrack, MuxError> {
    let mut offset = 0_u64;
    let mut width = None::<u32>;
    let mut height = None::<u32>;
    let mut jp2h_payload = None::<Vec<u8>>;
    let mut jp2c_offset = None::<u64>;
    while offset < file_size {
        let (box_type, data_offset, end_offset) =
            read_be_box_range_sync(file, file_size, offset, spec)?;
        match box_type {
            JP2H => {
                let payload_len = usize::try_from(end_offset - data_offset)
                    .map_err(|_| MuxError::LayoutOverflow("JP2H payload size"))?;
                let mut payload = vec![0_u8; payload_len];
                file.seek(SeekFrom::Start(data_offset))?;
                file.read_exact(&mut payload)?;
                let (parsed_width, parsed_height) = parse_jp2h_dimensions(spec, &payload)?;
                width = Some(parsed_width);
                height = Some(parsed_height);
                jp2h_payload = Some(payload);
            }
            JP2C => {
                jp2c_offset = Some(offset);
                break;
            }
            _ => {}
        }
        offset = end_offset;
    }

    let width = width
        .ok_or_else(|| invalid_j2k(spec, "JP2 input did not carry a jp2h/ihdr image header"))?;
    let height = height.ok_or_else(|| {
        invalid_j2k(
            spec,
            "JP2 input did not expose image dimensions before codestream data",
        )
    })?;
    let jp2h_payload = jp2h_payload.ok_or_else(|| {
        invalid_j2k(
            spec,
            "JP2 input did not carry a jp2h decoder-configuration box",
        )
    })?;
    let jp2c_offset = jp2c_offset
        .ok_or_else(|| invalid_j2k(spec, "JP2 input did not carry a jp2c codestream box"))?;
    let width_u16 = u16::try_from(width)
        .map_err(|_| invalid_j2k(spec, "JP2 width does not fit in an MP4 visual sample entry"))?;
    let height_u16 = u16::try_from(height).map_err(|_| {
        invalid_j2k(
            spec,
            "JP2 height does not fit in an MP4 visual sample entry",
        )
    })?;
    let sample_size = u32::try_from(file_size - jp2c_offset).map_err(|_| {
        MuxError::LayoutOverflow("JP2 codestream payload exceeds MP4 sample limits")
    })?;
    let sample_entry_box =
        build_mjp2_sample_entry_box(width_u16, height_u16, b"", Some(&jp2h_payload))?;
    Ok(ParsedJ2kTrack {
        width: width_u16,
        height: height_u16,
        sample_entry_box,
        samples: vec![StagedSample {
            data_offset: jp2c_offset,
            data_size: sample_size,
            duration: 1_000,
            composition_time_offset: 0,
            is_sync_sample: true,
        }],
    })
}

#[cfg(feature = "async")]
async fn parse_jp2_file_async(
    spec: &str,
    file: &mut TokioFile,
    file_size: u64,
) -> Result<ParsedJ2kTrack, MuxError> {
    let mut offset = 0_u64;
    let mut width = None::<u32>;
    let mut height = None::<u32>;
    let mut jp2h_payload = None::<Vec<u8>>;
    let mut jp2c_offset = None::<u64>;
    while offset < file_size {
        let (box_type, data_offset, end_offset) =
            read_be_box_range_async(file, file_size, offset, spec).await?;
        match box_type {
            JP2H => {
                let payload_len = usize::try_from(end_offset - data_offset)
                    .map_err(|_| MuxError::LayoutOverflow("JP2H payload size"))?;
                let mut payload = vec![0_u8; payload_len];
                file.seek(SeekFrom::Start(data_offset)).await?;
                file.read_exact(&mut payload).await?;
                let (parsed_width, parsed_height) = parse_jp2h_dimensions(spec, &payload)?;
                width = Some(parsed_width);
                height = Some(parsed_height);
                jp2h_payload = Some(payload);
            }
            JP2C => {
                jp2c_offset = Some(offset);
                break;
            }
            _ => {}
        }
        offset = end_offset;
    }

    let width = width
        .ok_or_else(|| invalid_j2k(spec, "JP2 input did not carry a jp2h/ihdr image header"))?;
    let height = height.ok_or_else(|| {
        invalid_j2k(
            spec,
            "JP2 input did not expose image dimensions before codestream data",
        )
    })?;
    let jp2h_payload = jp2h_payload.ok_or_else(|| {
        invalid_j2k(
            spec,
            "JP2 input did not carry a jp2h decoder-configuration box",
        )
    })?;
    let jp2c_offset = jp2c_offset
        .ok_or_else(|| invalid_j2k(spec, "JP2 input did not carry a jp2c codestream box"))?;
    let width_u16 = u16::try_from(width)
        .map_err(|_| invalid_j2k(spec, "JP2 width does not fit in an MP4 visual sample entry"))?;
    let height_u16 = u16::try_from(height).map_err(|_| {
        invalid_j2k(
            spec,
            "JP2 height does not fit in an MP4 visual sample entry",
        )
    })?;
    let sample_size = u32::try_from(file_size - jp2c_offset).map_err(|_| {
        MuxError::LayoutOverflow("JP2 codestream payload exceeds MP4 sample limits")
    })?;
    let sample_entry_box =
        build_mjp2_sample_entry_box(width_u16, height_u16, b"", Some(&jp2h_payload))?;
    Ok(ParsedJ2kTrack {
        width: width_u16,
        height: height_u16,
        sample_entry_box,
        samples: vec![StagedSample {
            data_offset: jp2c_offset,
            data_size: sample_size,
            duration: 1_000,
            composition_time_offset: 0,
            is_sync_sample: true,
        }],
    })
}

fn parse_jp2h_dimensions(spec: &str, payload: &[u8]) -> Result<(u32, u32), MuxError> {
    let mut offset = 0_u64;
    let payload_size =
        u64::try_from(payload.len()).map_err(|_| MuxError::LayoutOverflow("JP2H byte length"))?;
    while offset < payload_size {
        let (box_type, data_offset, end_offset) = read_be_box_range_bytes(payload, offset, spec)?;
        if box_type == IHDR {
            if end_offset - data_offset < 14 {
                return Err(invalid_j2k(spec, "JP2 ihdr payload is truncated"));
            }
            let data_offset_usize = usize::try_from(data_offset)
                .map_err(|_| MuxError::LayoutOverflow("JP2 ihdr offset"))?;
            let height = u32::from_be_bytes(
                payload[data_offset_usize..data_offset_usize + 4]
                    .try_into()
                    .unwrap(),
            );
            let width = u32::from_be_bytes(
                payload[data_offset_usize + 4..data_offset_usize + 8]
                    .try_into()
                    .unwrap(),
            );
            if width == 0 || height == 0 {
                return Err(invalid_j2k(
                    spec,
                    "JP2 ihdr declared zero width or zero height",
                ));
            }
            return Ok((width, height));
        }
        offset = end_offset;
    }
    Err(invalid_j2k(
        spec,
        "JP2 input did not carry an ihdr image header inside jp2h",
    ))
}

fn parse_j2k_codestream_prefix(
    spec: &str,
    prefix: &[u8],
    file_size: u64,
) -> Result<ParsedJ2kTrack, MuxError> {
    if prefix.len() < 16 {
        return Err(invalid_j2k(
            spec,
            "JPEG 2000 codestream is truncated before the SIZ image dimensions",
        ));
    }
    let width = u32::from_be_bytes(prefix[8..12].try_into().unwrap());
    let height = u32::from_be_bytes(prefix[12..16].try_into().unwrap());
    if width == 0 || height == 0 {
        return Err(invalid_j2k(
            spec,
            "JPEG 2000 codestream declared zero width or zero height",
        ));
    }
    let width_u16 = u16::try_from(width).map_err(|_| {
        invalid_j2k(
            spec,
            "JPEG 2000 codestream width does not fit in an MP4 visual sample entry",
        )
    })?;
    let height_u16 = u16::try_from(height).map_err(|_| {
        invalid_j2k(
            spec,
            "JPEG 2000 codestream height does not fit in an MP4 visual sample entry",
        )
    })?;
    let sample_entry_box = build_mjp2_sample_entry_box(width_u16, height_u16, b"", None)?;
    let data_size = u32::try_from(file_size)
        .map_err(|_| MuxError::LayoutOverflow("JPEG 2000 codestream exceeds MP4 sample limits"))?;
    Ok(ParsedJ2kTrack {
        width: width_u16,
        height: height_u16,
        sample_entry_box,
        samples: vec![StagedSample {
            data_offset: 0,
            data_size,
            duration: 1_000,
            composition_time_offset: 0,
            is_sync_sample: true,
        }],
    })
}

fn read_be_box_range_bytes(
    bytes: &[u8],
    offset: u64,
    spec: &str,
) -> Result<(FourCc, u64, u64), MuxError> {
    let offset_usize =
        usize::try_from(offset).map_err(|_| MuxError::LayoutOverflow("JPEG 2000 box offset"))?;
    if bytes.len().saturating_sub(offset_usize) < 8 {
        return Err(invalid_j2k(spec, "JPEG 2000 box header is truncated"));
    }
    let size32 = u32::from_be_bytes(bytes[offset_usize..offset_usize + 4].try_into().unwrap());
    let box_type = FourCc::from_bytes(
        bytes[offset_usize + 4..offset_usize + 8]
            .try_into()
            .unwrap(),
    );
    let (header_size, end_offset) = if size32 == 1 {
        if bytes.len().saturating_sub(offset_usize) < 16 {
            return Err(invalid_j2k(
                spec,
                "JPEG 2000 extended-size box header is truncated",
            ));
        }
        let size64 = u64::from_be_bytes(
            bytes[offset_usize + 8..offset_usize + 16]
                .try_into()
                .unwrap(),
        );
        if size64 < 16 {
            return Err(invalid_j2k(
                spec,
                &format!("JPEG 2000 box `{box_type}` declared an invalid extended size"),
            ));
        }
        (16_u64, offset + size64)
    } else if size32 == 0 {
        (
            8_u64,
            u64::try_from(bytes.len())
                .map_err(|_| MuxError::LayoutOverflow("JPEG 2000 byte length"))?,
        )
    } else {
        if size32 < 8 {
            return Err(invalid_j2k(
                spec,
                &format!("JPEG 2000 box `{box_type}` declared a size smaller than its header"),
            ));
        }
        (8_u64, offset + u64::from(size32))
    };
    if end_offset
        > u64::try_from(bytes.len())
            .map_err(|_| MuxError::LayoutOverflow("JPEG 2000 byte length"))?
    {
        return Err(invalid_j2k(
            spec,
            &format!("JPEG 2000 box `{box_type}` overruns the input length"),
        ));
    }
    Ok((box_type, offset + header_size, end_offset))
}

fn read_be_box_range_sync(
    file: &mut File,
    file_size: u64,
    offset: u64,
    spec: &str,
) -> Result<(FourCc, u64, u64), MuxError> {
    if file_size.saturating_sub(offset) < 8 {
        return Err(invalid_j2k(spec, "JPEG 2000 box header is truncated"));
    }
    let mut header = [0_u8; 16];
    file.seek(SeekFrom::Start(offset))?;
    file.read_exact(&mut header[..8])?;
    let size32 = u32::from_be_bytes(header[..4].try_into().unwrap());
    let box_type = FourCc::from_bytes(header[4..8].try_into().unwrap());
    let (header_size, end_offset) = if size32 == 1 {
        if file_size.saturating_sub(offset) < 16 {
            return Err(invalid_j2k(
                spec,
                "JPEG 2000 extended-size box header is truncated",
            ));
        }
        file.read_exact(&mut header[8..16])?;
        let size64 = u64::from_be_bytes(header[8..16].try_into().unwrap());
        if size64 < 16 {
            return Err(invalid_j2k(
                spec,
                &format!("JPEG 2000 box `{box_type}` declared an invalid extended size"),
            ));
        }
        (16_u64, offset + size64)
    } else if size32 == 0 {
        (8_u64, file_size)
    } else {
        if size32 < 8 {
            return Err(invalid_j2k(
                spec,
                &format!("JPEG 2000 box `{box_type}` declared a size smaller than its header"),
            ));
        }
        (8_u64, offset + u64::from(size32))
    };
    if end_offset > file_size {
        return Err(invalid_j2k(
            spec,
            &format!("JPEG 2000 box `{box_type}` overruns the input length"),
        ));
    }
    Ok((box_type, offset + header_size, end_offset))
}

#[cfg(feature = "async")]
async fn read_be_box_range_async(
    file: &mut TokioFile,
    file_size: u64,
    offset: u64,
    spec: &str,
) -> Result<(FourCc, u64, u64), MuxError> {
    if file_size.saturating_sub(offset) < 8 {
        return Err(invalid_j2k(spec, "JPEG 2000 box header is truncated"));
    }
    let mut header = [0_u8; 16];
    file.seek(SeekFrom::Start(offset)).await?;
    file.read_exact(&mut header[..8]).await?;
    let size32 = u32::from_be_bytes(header[..4].try_into().unwrap());
    let box_type = FourCc::from_bytes(header[4..8].try_into().unwrap());
    let (header_size, end_offset) = if size32 == 1 {
        if file_size.saturating_sub(offset) < 16 {
            return Err(invalid_j2k(
                spec,
                "JPEG 2000 extended-size box header is truncated",
            ));
        }
        file.read_exact(&mut header[8..16]).await?;
        let size64 = u64::from_be_bytes(header[8..16].try_into().unwrap());
        if size64 < 16 {
            return Err(invalid_j2k(
                spec,
                &format!("JPEG 2000 box `{box_type}` declared an invalid extended size"),
            ));
        }
        (16_u64, offset + size64)
    } else if size32 == 0 {
        (8_u64, file_size)
    } else {
        if size32 < 8 {
            return Err(invalid_j2k(
                spec,
                &format!("JPEG 2000 box `{box_type}` declared a size smaller than its header"),
            ));
        }
        (8_u64, offset + u64::from(size32))
    };
    if end_offset > file_size {
        return Err(invalid_j2k(
            spec,
            &format!("JPEG 2000 box `{box_type}` overruns the input length"),
        ));
    }
    Ok((box_type, offset + header_size, end_offset))
}

fn read_j2k_prefix_sync(file: &mut File, file_size: u64) -> Result<Vec<u8>, MuxError> {
    let prefix_len = usize::try_from(file_size.min(16))
        .map_err(|_| MuxError::LayoutOverflow("JPEG 2000 prefix length"))?;
    let mut prefix = vec![0_u8; prefix_len];
    file.seek(SeekFrom::Start(0))?;
    file.read_exact(&mut prefix)?;
    Ok(prefix)
}

#[cfg(feature = "async")]
async fn read_j2k_prefix_async(file: &mut TokioFile, file_size: u64) -> Result<Vec<u8>, MuxError> {
    let prefix_len = usize::try_from(file_size.min(16))
        .map_err(|_| MuxError::LayoutOverflow("JPEG 2000 prefix length"))?;
    let mut prefix = vec![0_u8; prefix_len];
    file.seek(SeekFrom::Start(0)).await?;
    file.read_exact(&mut prefix).await?;
    Ok(prefix)
}

fn invalid_j2k(spec: &str, message: &str) -> MuxError {
    MuxError::UnsupportedTrackImport {
        spec: spec.to_string(),
        message: message.to_string(),
    }
}