libfreemkv 0.7.2

Open source raw disc access library for optical drives
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
521
522
523
524
525
526
527
528
529
530
531
//! Integration tests for the IOStream pipeline.

use std::io::{Cursor, Read, Write, Seek, SeekFrom};
use libfreemkv::*;
use libfreemkv::mux::meta::M2tsMeta;

fn sample_disc_title() -> DiscTitle {
    DiscTitle {
        playlist: "Test Movie".into(),
        playlist_id: 0,
        duration_secs: 7200.0,
        size_bytes: 0,
        clips: Vec::new(),
        streams: vec![
            Stream::Video(VideoStream {
                pid: 0x1011, codec: Codec::Hevc,
                resolution: "2160p".into(), frame_rate: "23.976".into(),
                hdr: HdrFormat::Hdr10, color_space: ColorSpace::Bt709,
                secondary: false, label: "Main".into(),
            }),
            Stream::Audio(AudioStream {
                pid: 0x1100, codec: Codec::TrueHd,
                channels: "7.1".into(), language: "eng".into(),
                sample_rate: "48kHz".into(), secondary: false,
                label: "English Atmos".into(),
            }),
            Stream::Audio(AudioStream {
                pid: 0x1101, codec: Codec::Ac3,
                channels: "5.1".into(), language: "fra".into(),
                sample_rate: "48kHz".into(), secondary: false,
                label: "French".into(),
            }),
            Stream::Subtitle(SubtitleStream {
                pid: 0x1200, codec: Codec::Pgs,
                language: "eng".into(), forced: false,
            }),
        ],
        extents: Vec::new(),
    }
}

// ── URL parsing ────────────────────────────────────────────────

#[test]
fn parse_url_disc() {
    let u = parse_url("disc://");
    assert_eq!(u.scheme, "disc");
    assert_eq!(u.path, "");
}

#[test]
fn parse_url_disc_device() {
    let u = parse_url("disc:///dev/sg4");
    assert_eq!(u.scheme, "disc");
    assert_eq!(u.path, "/dev/sg4");
}

#[test]
fn parse_url_mkv() {
    let u = parse_url("mkv://Dune.mkv");
    assert_eq!(u.scheme, "mkv");
    assert_eq!(u.path, "Dune.mkv");
}

#[test]
fn parse_url_network() {
    let u = parse_url("network://10.1.7.11:9000");
    assert_eq!(u.scheme, "network");
    assert_eq!(u.path, "10.1.7.11:9000");
}

#[test]
fn parse_url_bare_path_rejected() {
    let u = parse_url("Dune.mkv");
    assert_eq!(u.scheme, "unknown");
}

#[test]
fn parse_url_null() {
    let u = parse_url("null://");
    assert_eq!(u.scheme, "null");
    assert_eq!(u.path, "");
}

#[test]
fn parse_url_m2ts_with_path() {
    let u = parse_url("m2ts:///tmp/Dune.m2ts");
    assert_eq!(u.scheme, "m2ts");
    assert_eq!(u.path, "/tmp/Dune.m2ts");
}

#[test]
fn parse_url_m2ts_relative() {
    let u = parse_url("m2ts://Dune.m2ts");
    assert_eq!(u.scheme, "m2ts");
    assert_eq!(u.path, "Dune.m2ts");
}

#[test]
fn open_input_bare_path_errors() {
    let result = libfreemkv::open_input("Dune.mkv", &libfreemkv::InputOptions::default());
    assert!(result.is_err());
    let msg = match result { Err(e) => e.to_string(), Ok(_) => panic!("expected error") };
    assert!(msg.contains("not a valid stream URL"), "got: {}", msg);
}

#[test]
fn open_output_bare_path_errors() {
    let dt = sample_disc_title();
    let result = libfreemkv::open_output("Dune.mkv", &dt);
    assert!(result.is_err());
    let msg = match result { Err(e) => e.to_string(), Ok(_) => panic!("expected error") };
    assert!(msg.contains("not a valid stream URL"), "got: {}", msg);
}

#[test]
fn open_input_m2ts_empty_path_errors() {
    let result = libfreemkv::open_input("m2ts://", &libfreemkv::InputOptions::default());
    assert!(result.is_err());
    let msg = match result { Err(e) => e.to_string(), Ok(_) => panic!("expected error") };
    assert!(msg.contains("requires a file path"), "got: {}", msg);
}

#[test]
fn open_output_null_input_errors() {
    let result = libfreemkv::open_input("null://", &libfreemkv::InputOptions::default());
    assert!(result.is_err());
    let msg = match result { Err(e) => e.to_string(), Ok(_) => panic!("expected error") };
    assert!(msg.contains("write-only"), "got: {}", msg);
}

#[test]
fn open_output_disc_errors() {
    let dt = sample_disc_title();
    let result = libfreemkv::open_output("disc://", &dt);
    assert!(result.is_err());
    let msg = match result { Err(e) => e.to_string(), Ok(_) => panic!("expected error") };
    assert!(msg.contains("read-only"), "got: {}", msg);
}

#[test]
fn open_input_network_no_port_errors() {
    let result = libfreemkv::open_input("network://10.0.0.1", &libfreemkv::InputOptions::default());
    assert!(result.is_err());
    let msg = match result { Err(e) => e.to_string(), Ok(_) => panic!("expected error") };
    assert!(msg.contains("missing port"), "got: {}", msg);
}

#[test]
fn parse_url_stdio() {
    let u = parse_url("stdio://");
    assert_eq!(u.scheme, "stdio");
    assert_eq!(u.path, "");
}

// ── M2TS metadata roundtrip ───────────────────────────────────

#[test]
fn m2ts_meta_roundtrip() {
    let dt = sample_disc_title();
    let meta = M2tsMeta::from_title(&dt);
    let restored = meta.to_title();

    assert_eq!(restored.playlist, dt.playlist);
    assert_eq!(restored.duration_secs, dt.duration_secs);
    assert_eq!(restored.streams.len(), dt.streams.len());

    // Check video
    if let Stream::Video(v) = &restored.streams[0] {
        assert_eq!(v.codec, Codec::Hevc);
        assert_eq!(v.resolution, "2160p");
        assert_eq!(v.label, "Main");
    } else { panic!("expected video"); }

    // Check audio
    if let Stream::Audio(a) = &restored.streams[1] {
        assert_eq!(a.codec, Codec::TrueHd);
        assert_eq!(a.language, "eng");
        assert_eq!(a.label, "English Atmos");
    } else { panic!("expected audio"); }

    // Check subtitle
    if let Stream::Subtitle(s) = &restored.streams[3] {
        assert_eq!(s.language, "eng");
        assert!(!s.forced);
    } else { panic!("expected subtitle"); }
}

// ── M2TS header write + read ──────────────────────────────────

#[test]
fn m2ts_header_write_read() {
    let dt = sample_disc_title();
    let meta = M2tsMeta::from_title(&dt);

    // Write header to buffer
    let mut buf = Vec::new();
    libfreemkv::mux::meta::write_header(&mut buf, &meta).unwrap();

    // Verify magic
    assert_eq!(&buf[..4], b"FMKV");

    // Verify 192-byte alignment
    assert_eq!(buf.len() % 192, 0);

    // Read it back
    let mut cursor = Cursor::new(&buf);
    let read_back = libfreemkv::mux::meta::read_header(&mut cursor).unwrap().unwrap();
    assert_eq!(read_back.title, "Test Movie");
    assert_eq!(read_back.duration, 7200.0);
    assert_eq!(read_back.streams.len(), 4);

    // Cursor should be at end of header (192-aligned)
    assert_eq!(cursor.position() as usize, buf.len());
}

// ── M2tsStream write + read ───────────────────────────────────

#[test]
fn m2ts_stream_write_read() {
    let dt = sample_disc_title();

    // Build fake BD-TS packets
    let mut ts_data = Vec::new();
    for i in 0..10u8 {
        let mut pkt = [0u8; 192];
        pkt[4] = 0x47;
        pkt[5] = 0x10;
        pkt[6] = 0x11;
        pkt[7] = 0x10;
        pkt[8] = i;
        ts_data.extend_from_slice(&pkt);
    }

    // Write through M2tsStream to a Cursor
    let output = Cursor::new(Vec::new());
    let mut stream = M2tsStream::new(output).meta(&dt);
    stream.write_all(&ts_data).unwrap();
    stream.finish().unwrap();

    // M2tsStream consumed the cursor — we need the inner data.
    // For this test, write to a shared buffer instead.
    // Use a second pass: write header + data manually to verify read side.
    let mut encoded = Vec::new();
    let meta = M2tsMeta::from_title(&dt);
    libfreemkv::mux::meta::write_header(&mut encoded, &meta).unwrap();
    encoded.extend_from_slice(&ts_data);

    // Read back
    let cursor = Cursor::new(encoded);
    let mut stream = M2tsStream::open(cursor).unwrap();
    let info = stream.info();
    assert_eq!(info.streams.len(), 4);
    assert_eq!(info.duration_secs, 7200.0);

    // Read BD-TS data
    let mut read_buf = vec![0u8; 192 * 10];
    let mut total = 0;
    loop {
        match stream.read(&mut read_buf[total..]) {
            Ok(0) => break,
            Ok(n) => total += n,
            Err(_) => break,
        }
    }

    assert_eq!(total, 192 * 10);
    for i in 0..10u8 {
        assert_eq!(read_buf[i as usize * 192 + 4], 0x47);
        assert_eq!(read_buf[i as usize * 192 + 8], i);
    }
}

// ── M2tsStream passthrough identity ───────────────────────────

#[test]
fn m2ts_passthrough_preserves_data() {
    let dt = sample_disc_title();

    // Create original BD-TS data
    let mut original = Vec::new();
    for i in 0..100u8 {
        let mut pkt = [0u8; 192];
        pkt[4] = 0x47;
        pkt[5] = (i % 3) << 4;
        pkt[6] = i;
        for j in 8..192 { pkt[j] = i.wrapping_add(j as u8); }
        original.extend_from_slice(&pkt);
    }

    // Build encoded: header + original data
    let mut encoded = Vec::new();
    let meta = M2tsMeta::from_title(&dt);
    libfreemkv::mux::meta::write_header(&mut encoded, &meta).unwrap();
    encoded.extend_from_slice(&original);

    // Read back through M2tsStream
    let cursor = Cursor::new(encoded);
    let mut stream = M2tsStream::open(cursor).unwrap();
    let mut decoded = vec![0u8; original.len()];
    let mut total = 0;
    loop {
        match stream.read(&mut decoded[total..]) {
            Ok(0) => break,
            Ok(n) => total += n,
            Err(_) => break,
        }
    }

    // BD-TS data must be byte-identical
    assert_eq!(total, original.len());
    assert_eq!(decoded, original);
}

// ── IOStream trait ────────────────────────────────────────────

#[test]
fn m2ts_implements_iostream() {
    let dt = sample_disc_title();
    let output = Cursor::new(Vec::new());
    let stream = M2tsStream::new(output).meta(&dt);

    let mut boxed: Box<dyn IOStream> = Box::new(stream);
    let meta = boxed.info();
    assert_eq!(meta.streams.len(), 4);

    let pkt = [0u8; 192];
    boxed.write_all(&pkt).unwrap();
    boxed.finish().unwrap();
}

#[test]
fn m2ts_read_returns_error_on_write_stream() {
    let output = Cursor::new(Vec::new());
    let stream = M2tsStream::new(output);
    let mut boxed: Box<dyn IOStream> = Box::new(stream);
    let mut buf = [0u8; 10];
    assert!(boxed.read(&mut buf).is_err());
}

// ── DiscTitle::empty ──────────────────────────────────────────

#[test]
fn disc_title_empty() {
    let dt = DiscTitle::empty();
    assert_eq!(dt.streams.len(), 0);
    assert_eq!(dt.duration_secs, 0.0);
    assert!(dt.playlist.is_empty());
}

// ── Meta codec roundtrip ─────────────────────────────────────

#[test]
fn meta_codec_roundtrip() {
    // Test that all codec types survive from_title -> to_title
    let codecs_video = &[Codec::Hevc, Codec::H264, Codec::Vc1, Codec::Mpeg2];
    let codecs_audio = &[Codec::Ac3, Codec::Ac3Plus, Codec::TrueHd, Codec::DtsHdMa, Codec::DtsHdHr, Codec::Dts, Codec::Lpcm];
    let codecs_sub = &[Codec::Pgs];

    let mut streams = Vec::new();
    for (i, &codec) in codecs_video.iter().enumerate() {
        streams.push(Stream::Video(VideoStream {
            pid: (0x1011 + i) as u16, codec,
            resolution: "1080p".into(), frame_rate: "23.976".into(),
            hdr: HdrFormat::Sdr, color_space: ColorSpace::Bt709,
            secondary: false, label: String::new(),
        }));
    }
    for (i, &codec) in codecs_audio.iter().enumerate() {
        streams.push(Stream::Audio(AudioStream {
            pid: (0x1100 + i) as u16, codec,
            channels: "5.1".into(), language: "eng".into(),
            sample_rate: "48kHz".into(), secondary: false,
            label: String::new(),
        }));
    }
    for (i, &codec) in codecs_sub.iter().enumerate() {
        streams.push(Stream::Subtitle(SubtitleStream {
            pid: (0x1200 + i) as u16, codec,
            language: "eng".into(), forced: false,
        }));
    }

    let dt = DiscTitle {
        playlist: "Codec Test".into(),
        playlist_id: 0,
        duration_secs: 100.0,
        size_bytes: 0,
        clips: Vec::new(),
        streams,
        extents: Vec::new(),
    };

    let meta = M2tsMeta::from_title(&dt);
    let restored = meta.to_title();

    assert_eq!(restored.streams.len(), dt.streams.len());
    for (orig, rest) in dt.streams.iter().zip(restored.streams.iter()) {
        match (orig, rest) {
            (Stream::Video(o), Stream::Video(r)) => assert_eq!(o.codec, r.codec, "video codec mismatch"),
            (Stream::Audio(o), Stream::Audio(r)) => assert_eq!(o.codec, r.codec, "audio codec mismatch"),
            (Stream::Subtitle(o), Stream::Subtitle(r)) => assert_eq!(o.codec, r.codec, "subtitle codec mismatch"),
            _ => panic!("stream type mismatch"),
        }
    }
}

#[test]
fn meta_empty_streams() {
    let dt = DiscTitle {
        playlist: "Empty".into(),
        playlist_id: 0,
        duration_secs: 0.0,
        size_bytes: 0,
        clips: Vec::new(),
        streams: Vec::new(),
        extents: Vec::new(),
    };

    let meta = M2tsMeta::from_title(&dt);
    assert_eq!(meta.streams.len(), 0);
    let restored = meta.to_title();
    assert_eq!(restored.streams.len(), 0);
    assert_eq!(restored.playlist, "Empty");
}

#[test]
fn meta_all_stream_types() {
    let dt = DiscTitle {
        playlist: "Full".into(),
        playlist_id: 0,
        duration_secs: 3600.0,
        size_bytes: 0,
        clips: Vec::new(),
        streams: vec![
            Stream::Video(VideoStream {
                pid: 0x1011, codec: Codec::Hevc,
                resolution: "2160p".into(), frame_rate: "23.976".into(),
                hdr: HdrFormat::Hdr10, color_space: ColorSpace::Bt709,
                secondary: false, label: "Primary".into(),
            }),
            Stream::Audio(AudioStream {
                pid: 0x1100, codec: Codec::TrueHd,
                channels: "7.1".into(), language: "eng".into(),
                sample_rate: "48kHz".into(), secondary: false,
                label: "Primary Audio".into(),
            }),
            Stream::Subtitle(SubtitleStream {
                pid: 0x1200, codec: Codec::Pgs,
                language: "fra".into(), forced: true,
            }),
            Stream::Audio(AudioStream {
                pid: 0x1110, codec: Codec::Ac3,
                channels: "stereo".into(), language: "eng".into(),
                sample_rate: "48kHz".into(), secondary: true,
                label: "Commentary".into(),
            }),
        ],
        extents: Vec::new(),
    };

    let meta = M2tsMeta::from_title(&dt);
    let restored = meta.to_title();

    assert_eq!(restored.streams.len(), 4);

    // Video preserved
    if let Stream::Video(v) = &restored.streams[0] {
        assert_eq!(v.codec, Codec::Hevc);
        assert_eq!(v.resolution, "2160p");
        assert_eq!(v.label, "Primary");
        assert!(!v.secondary);
    } else { panic!("expected video"); }

    // Primary audio preserved
    if let Stream::Audio(a) = &restored.streams[1] {
        assert_eq!(a.codec, Codec::TrueHd);
        assert_eq!(a.channels, "7.1");
        assert!(!a.secondary);
    } else { panic!("expected audio"); }

    // Subtitle preserved (forced flag)
    if let Stream::Subtitle(s) = &restored.streams[2] {
        assert_eq!(s.language, "fra");
        assert!(s.forced);
    } else { panic!("expected subtitle"); }

    // Secondary audio preserved
    if let Stream::Audio(a) = &restored.streams[3] {
        assert_eq!(a.codec, Codec::Ac3);
        assert!(a.secondary);
        assert_eq!(a.label, "Commentary");
    } else { panic!("expected secondary audio"); }
}

// ── MkvStream tests ──────────────────────────────────────────

#[test]
fn mkvstream_write_finish() {
    let output = Cursor::new(Vec::new());
    let dt = sample_disc_title();
    let mut stream = MkvStream::new(output).meta(&dt).max_buffer(1024 * 1024);

    // Write some fake BD-TS packets (they won't produce valid MKV frames
    // since there is no real codec data, but it should not panic)
    for i in 0..20u8 {
        let mut pkt = [0u8; 192];
        pkt[4] = 0x47;
        // PID 0x1011 (video)
        pkt[5] = 0x10;
        pkt[6] = 0x11;
        pkt[7] = 0x10;
        pkt[8] = i;
        stream.write_all(&pkt).unwrap();
    }

    // finish should not panic even without valid codec data
    stream.finish().unwrap();
}

#[test]
fn mkvstream_meta_sets_title() {
    let output = Cursor::new(Vec::new());
    let dt = sample_disc_title();
    let stream = MkvStream::new(output).meta(&dt);

    let info = stream.info();
    assert_eq!(info.playlist, "Test Movie");
    assert_eq!(info.duration_secs, 7200.0);
    assert_eq!(info.streams.len(), 4);
}