unbundle 5.2.0

Unbundle media files - extract still frames, audio tracks, and subtitles from video files
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
//! Video extraction integration tests.
//!
//! These tests require the fixture files generated by
//! `tests/fixtures/generate_fixtures.sh` (or `.bat` on Windows).

use std::{path::Path, time::Duration};

use unbundle::{FrameRange, MediaFile, UnbundleError};

/// Path to the standard test video fixture (5s, 640×480, 30 fps, with audio).
fn sample_video_path() -> &'static str {
    "tests/fixtures/sample_video.mp4"
}

/// Skip the test if the fixture file does not exist.
fn require_fixture(path: &str) {
    if !Path::new(path).exists() {
        eprintln!(
            "Skipping test: fixture '{path}' not found. \
             Run tests/fixtures/generate_fixtures.sh first."
        );
        return;
    }
}

#[test]
fn extract_first_frame() {
    let path = sample_video_path();
    require_fixture(path);
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let frame = unbundler
        .video()
        .frame(0)
        .expect("Failed to extract first frame");

    // Verify dimensions match metadata.
    let video_metadata = unbundler.metadata().video.as_ref().unwrap();
    assert_eq!(frame.width(), video_metadata.width);
    assert_eq!(frame.height(), video_metadata.height);
}

#[test]
fn extract_frame_by_timestamp() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let frame = unbundler
        .video()
        .frame_at(Duration::from_secs(2))
        .expect("Failed to extract frame at 2s");

    let video_metadata = unbundler.metadata().video.as_ref().unwrap();
    assert_eq!(frame.width(), video_metadata.width);
    assert_eq!(frame.height(), video_metadata.height);
}

#[test]
fn extract_frame_range() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let frames = unbundler
        .video()
        .frames(FrameRange::Range(0, 9))
        .expect("Failed to extract frame range");

    assert!(
        !frames.is_empty(),
        "Expected at least one frame from range 0..9"
    );
    assert!(
        frames.len() <= 10,
        "Expected at most 10 frames from range 0..9, got {}",
        frames.len()
    );
}

#[test]
fn extract_frames_by_interval() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let frames = unbundler
        .video()
        .frames(FrameRange::Interval(30))
        .expect("Failed to extract interval frames");

    // 5 seconds at 30 fps = 150 frames; every 30th = at least 5 frames.
    assert!(
        !frames.is_empty(),
        "Expected at least one frame from interval extraction"
    );
}

#[test]
fn extract_frames_by_time_range() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let frames = unbundler
        .video()
        .frames(FrameRange::TimeRange(
            Duration::from_secs(1),
            Duration::from_secs(2),
        ))
        .expect("Failed to extract time range frames");

    assert!(
        !frames.is_empty(),
        "Expected frames in the 1s–2s time range"
    );
}

#[test]
fn extract_frames_by_time_interval() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let frames = unbundler
        .video()
        .frames(FrameRange::TimeInterval(Duration::from_secs(1)))
        .expect("Failed to extract time interval frames");

    // 5 seconds → frames at 0s, 1s, 2s, 3s, 4s, 5s → up to 6 frames.
    assert!(
        frames.len() >= 4,
        "Expected at least 4 frames at 1-second intervals, got {}",
        frames.len()
    );
}

#[test]
fn extract_specific_frames() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let frames = unbundler
        .video()
        .frames(FrameRange::Specific(vec![0, 30, 60]))
        .expect("Failed to extract specific frames");

    assert!(
        !frames.is_empty(),
        "Expected frames for specific frame numbers"
    );
}

#[test]
fn extract_keyframes_only() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let frames = unbundler
        .video()
        .frames(FrameRange::KeyframesOnly)
        .expect("Failed to extract keyframes");

    assert!(!frames.is_empty(), "Expected at least one keyframe");
}

#[test]
fn for_each_raw_frame_processes_all() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let mut seen = 0_u64;

    unbundler
        .video()
        .for_each_raw_frame(FrameRange::Range(0, 4), |view| {
            seen += 1;
            assert!(view.width > 0);
            assert!(view.height > 0);
            assert!(!view.data.is_empty());
            assert!(view.stride > 0);
            Ok(())
        })
        .expect("Failed to process raw frames");

    assert!(seen > 0, "Expected at least one raw frame callback");
}

#[test]
fn frame_out_of_range_returns_error() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let result = unbundler.video().frame(999_999);

    assert!(
        result.is_err(),
        "Expected error for out-of-range frame number"
    );
}

#[test]
fn frame_dimensions_match_metadata() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let video_metadata = unbundler.metadata().video.clone().unwrap();
    let frame = unbundler
        .video()
        .frame(10)
        .expect("Failed to extract frame 10");

    assert_eq!(frame.width(), video_metadata.width);
    assert_eq!(frame.height(), video_metadata.height);
}

#[test]
fn no_video_stream_returns_error() {
    let path = "tests/fixtures/sample_audio_only.mp4";
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open audio-only file");
    let result = unbundler.video().frame(0);

    assert!(result.is_err(), "Expected NoVideoStream error");
}

#[test]
fn video_only_file_works() {
    let path = "tests/fixtures/sample_video_only.mp4";
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open video-only file");
    assert!(unbundler.metadata().video.is_some());
    assert!(unbundler.metadata().audio.is_none());

    let frame = unbundler
        .video()
        .frame(0)
        .expect("Failed to extract frame from video-only file");
    assert!(frame.width() > 0);
    assert!(frame.height() > 0);
}

#[test]
fn invalid_range_returns_error() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let result = unbundler.video().frames(FrameRange::Range(10, 5));

    assert!(result.is_err(), "Expected InvalidRange error");
    assert!(
        matches!(result.unwrap_err(), UnbundleError::InvalidRange { .. }),
        "Expected InvalidRange variant",
    );
}

#[test]
fn zero_interval_returns_error() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let result = unbundler.video().frames(FrameRange::Interval(0));

    assert!(result.is_err(), "Expected InvalidInterval error");
    assert!(
        matches!(result.unwrap_err(), UnbundleError::InvalidInterval),
        "Expected InvalidInterval variant",
    );
}

#[test]
fn invalid_time_range_returns_error() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let result = unbundler.video().frames(FrameRange::TimeRange(
        Duration::from_secs(3),
        Duration::from_secs(1),
    ));

    assert!(
        result.is_err(),
        "Expected InvalidRange error for time range"
    );
    assert!(
        matches!(result.unwrap_err(), UnbundleError::InvalidRange { .. }),
        "Expected InvalidRange variant",
    );
}

#[test]
fn zero_time_interval_returns_error() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let result = unbundler
        .video()
        .frames(FrameRange::TimeInterval(Duration::ZERO));

    assert!(
        result.is_err(),
        "Expected InvalidInterval error for zero time interval"
    );
    assert!(
        matches!(result.unwrap_err(), UnbundleError::InvalidInterval),
        "Expected InvalidInterval variant",
    );
}

#[test]
fn save_frame_to_file() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let output = tempfile::NamedTempFile::new().expect("Failed to create temp file");
    let output_path = output.path().with_extension("png");

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    unbundler
        .video()
        .save_frame(0, &output_path)
        .expect("Failed to save frame");

    let written_bytes = std::fs::read(&output_path).expect("Failed to read output file");
    assert!(!written_bytes.is_empty(), "Expected non-empty PNG file");

    let _ = std::fs::remove_file(&output_path);
}

#[test]
fn save_frame_at_to_file() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let output = tempfile::NamedTempFile::new().expect("Failed to create temp file");
    let output_path = output.path().with_extension("png");

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    unbundler
        .video()
        .save_frame_at(Duration::from_secs(1), &output_path)
        .expect("Failed to save frame at timestamp");

    let written_bytes = std::fs::read(&output_path).expect("Failed to read output file");
    assert!(!written_bytes.is_empty(), "Expected non-empty PNG file");

    let _ = std::fs::remove_file(&output_path);
}

#[test]
fn for_each_frame_processes_all() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");

    let mut count = 0u64;
    unbundler
        .video()
        .for_each_frame(FrameRange::Range(0, 4), |frame_number, image| {
            assert!(image.width() > 0);
            assert!(image.height() > 0);
            assert!(frame_number <= 4);
            count += 1;
            Ok(())
        })
        .expect("Failed to process frames");

    assert!(count > 0, "Expected at least one frame to be processed");
}

#[test]
fn for_each_frame_matches_frames() {
    let path = sample_video_path();
    if !Path::new(path).exists() {
        return;
    }

    // Verify for_each_frame processes the same number of frames as frames().
    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let collected = unbundler
        .video()
        .frames(FrameRange::Range(0, 9))
        .expect("Failed to extract frames");

    let mut unbundler = MediaFile::open(path).expect("Failed to open test video");
    let mut streaming_count = 0u64;
    unbundler
        .video()
        .for_each_frame(FrameRange::Range(0, 9), |_, _| {
            streaming_count += 1;
            Ok(())
        })
        .expect("Failed to process frames");

    assert_eq!(
        collected.len() as u64,
        streaming_count,
        "for_each_frame and frames() should produce the same count",
    );
}