oximedia-conform 0.2.1

Professional media conforming system for OxiMedia - EDL/XML/AAF timeline reconstruction
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
//! Media file scanner for discovering and cataloging source files.

use crate::error::ConformResult;
use crate::media::fingerprint::{extract_media_info, generate_fingerprint};
use crate::types::MediaFile;
use rayon::prelude::*;
use std::path::{Path, PathBuf};
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
use tracing::{debug, info, warn};
use walkdir::WalkDir;

/// Supported media file extensions.
const MEDIA_EXTENSIONS: &[&str] = &[
    "mov", "mp4", "m4v", "avi", "mkv", "mxf", "dpx", "tiff", "tif", "png", "jpg", "jpeg", "exr",
    "r3d", "arri", "braw", "wav", "aif", "aiff", "mp3", "aac", "flac",
];

/// Progress callback for scanning.
#[derive(Clone)]
pub struct ScanProgress {
    /// Total files found.
    pub total_files: Arc<AtomicUsize>,
    /// Files processed.
    pub processed_files: Arc<AtomicUsize>,
    /// Errors encountered.
    pub errors: Arc<AtomicUsize>,
}

impl ScanProgress {
    /// Create a new progress tracker.
    #[must_use]
    pub fn new() -> Self {
        Self {
            total_files: Arc::new(AtomicUsize::new(0)),
            processed_files: Arc::new(AtomicUsize::new(0)),
            errors: Arc::new(AtomicUsize::new(0)),
        }
    }

    /// Get the current progress as a percentage.
    #[must_use]
    pub fn percentage(&self) -> f64 {
        let total = self.total_files.load(Ordering::Relaxed);
        if total == 0 {
            return 0.0;
        }
        let processed = self.processed_files.load(Ordering::Relaxed);
        (processed as f64 / total as f64) * 100.0
    }

    /// Check if scanning is complete.
    #[must_use]
    pub fn is_complete(&self) -> bool {
        let total = self.total_files.load(Ordering::Relaxed);
        let processed = self.processed_files.load(Ordering::Relaxed);
        total > 0 && processed >= total
    }
}

impl Default for ScanProgress {
    fn default() -> Self {
        Self::new()
    }
}

/// Media file scanner.
pub struct MediaScanner {
    /// Whether to follow symbolic links.
    follow_links: bool,
    /// Maximum recursion depth (0 = unlimited).
    max_depth: usize,
    /// Generate checksums during scanning.
    generate_checksums: bool,
    /// Extract metadata during scanning.
    extract_metadata: bool,
    /// Custom file extensions to scan.
    custom_extensions: Vec<String>,
}

impl MediaScanner {
    /// Create a new media scanner with default settings.
    #[must_use]
    pub fn new() -> Self {
        Self {
            follow_links: false,
            max_depth: 0,
            generate_checksums: false,
            extract_metadata: true,
            custom_extensions: Vec::new(),
        }
    }

    /// Set whether to follow symbolic links.
    pub fn follow_links(&mut self, follow: bool) -> &mut Self {
        self.follow_links = follow;
        self
    }

    /// Set maximum recursion depth.
    pub fn max_depth(&mut self, depth: usize) -> &mut Self {
        self.max_depth = depth;
        self
    }

    /// Enable checksum generation.
    pub fn generate_checksums(&mut self, generate: bool) -> &mut Self {
        self.generate_checksums = generate;
        self
    }

    /// Enable metadata extraction.
    pub fn extract_metadata(&mut self, extract: bool) -> &mut Self {
        self.extract_metadata = extract;
        self
    }

    /// Add custom file extensions to scan.
    pub fn add_extension(&mut self, ext: String) -> &mut Self {
        self.custom_extensions.push(ext);
        self
    }

    /// Scan a directory for media files.
    ///
    /// # Errors
    ///
    /// Returns an error if the directory cannot be read.
    pub fn scan<P: AsRef<Path>>(
        &self,
        path: P,
        progress: Option<Arc<ScanProgress>>,
    ) -> ConformResult<Vec<MediaFile>> {
        let path = path.as_ref();
        info!("Scanning directory: {}", path.display());

        // Find all media files
        let file_paths = self.find_media_files(path)?;

        if let Some(ref prog) = progress {
            prog.total_files.store(file_paths.len(), Ordering::Relaxed);
        }

        info!("Found {} media files", file_paths.len());

        // Process files in parallel
        let media_files: Vec<MediaFile> = file_paths
            .par_iter()
            .filter_map(|file_path| match self.process_file(file_path) {
                Ok(media) => {
                    if let Some(ref prog) = progress {
                        prog.processed_files.fetch_add(1, Ordering::Relaxed);
                    }
                    Some(media)
                }
                Err(e) => {
                    warn!("Failed to process {}: {}", file_path.display(), e);
                    if let Some(ref prog) = progress {
                        prog.errors.fetch_add(1, Ordering::Relaxed);
                        prog.processed_files.fetch_add(1, Ordering::Relaxed);
                    }
                    None
                }
            })
            .collect();

        info!("Successfully processed {} files", media_files.len());
        Ok(media_files)
    }

    /// Find all media files in a directory.
    fn find_media_files<P: AsRef<Path>>(&self, path: P) -> ConformResult<Vec<PathBuf>> {
        let mut walker = WalkDir::new(path).follow_links(self.follow_links);

        if self.max_depth > 0 {
            walker = walker.max_depth(self.max_depth);
        }

        let files: Vec<PathBuf> = walker
            .into_iter()
            .filter_map(std::result::Result::ok)
            .filter(|entry| entry.file_type().is_file())
            .filter(|entry| self.is_media_file(entry.path()))
            .map(|entry| entry.path().to_path_buf())
            .collect();

        Ok(files)
    }

    /// Check if a file is a media file based on extension.
    fn is_media_file<P: AsRef<Path>>(&self, path: P) -> bool {
        if let Some(ext) = path.as_ref().extension() {
            let ext_str = ext.to_string_lossy().to_lowercase();
            MEDIA_EXTENSIONS.contains(&ext_str.as_str())
                || self.custom_extensions.contains(&ext_str)
        } else {
            false
        }
    }

    /// Process a single file and extract metadata.
    fn process_file(&self, path: &Path) -> ConformResult<MediaFile> {
        debug!("Processing file: {}", path.display());

        let mut media = MediaFile::new(path.to_path_buf());

        // Get file size
        if let Ok(metadata) = std::fs::metadata(path) {
            media.size = Some(metadata.len());
        }

        // Generate fingerprints if enabled
        if self.generate_checksums {
            if let Ok(fingerprint) = generate_fingerprint(path) {
                media.md5 = Some(fingerprint.md5);
                media.xxhash = Some(fingerprint.xxhash);
            }
        }

        // Extract media metadata if enabled
        if self.extract_metadata {
            if let Ok(info) = extract_media_info(path) {
                media.duration = info.duration;
                media.width = info.width;
                media.height = info.height;
                media.fps = info.fps;
                media.timecode_start = info.timecode_start;
            }
        }

        Ok(media)
    }

    /// Scan a directory for media files with a custom extension filter, using
    /// rayon for parallel processing.
    ///
    /// Unlike `scan`, this function accepts an explicit list of file
    /// extensions (without leading dot, e.g. `&["mov", "mp4"]`) and walks the
    /// directory tree sequentially before processing files in parallel via
    /// rayon.
    ///
    /// # Errors
    ///
    /// Returns an error if the root directory cannot be read.
    pub fn scan_parallel<P: AsRef<Path>>(
        &self,
        root: P,
        extensions: &[&str],
    ) -> ConformResult<Vec<MediaFile>> {
        let root = root.as_ref();
        info!(
            "scan_parallel: walking {} for {:?}",
            root.display(),
            extensions
        );

        // Phase 1 — sequential directory walk (WalkDir is not Send).
        let paths: Vec<PathBuf> = {
            let mut walker = WalkDir::new(root).follow_links(self.follow_links);
            if self.max_depth > 0 {
                walker = walker.max_depth(self.max_depth);
            }
            walker
                .into_iter()
                .filter_map(std::result::Result::ok)
                .filter(|entry| entry.file_type().is_file())
                .filter(|entry| {
                    if let Some(ext) = entry.path().extension() {
                        let ext_lc = ext.to_string_lossy().to_lowercase();
                        extensions.iter().any(|e| *e == ext_lc.as_str())
                    } else {
                        false
                    }
                })
                .map(|entry| entry.path().to_path_buf())
                .collect()
        };

        info!("scan_parallel: found {} candidate paths", paths.len());

        // Phase 2 — parallel processing via rayon.
        let media_files: Vec<MediaFile> = paths
            .par_iter()
            .filter_map(|path| match self.process_file(path) {
                Ok(media) => Some(media),
                Err(e) => {
                    warn!("scan_parallel: failed to process {}: {}", path.display(), e);
                    None
                }
            })
            .collect();

        info!(
            "scan_parallel: successfully processed {} files",
            media_files.len()
        );
        Ok(media_files)
    }
}

impl Default for MediaScanner {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fs;
    use tempfile::TempDir;

    #[test]
    fn test_scanner_creation() {
        let scanner = MediaScanner::new();
        assert!(!scanner.follow_links);
        assert_eq!(scanner.max_depth, 0);
    }

    #[test]
    fn test_scanner_configuration() {
        let mut scanner = MediaScanner::new();
        scanner.follow_links(true).max_depth(5);
        assert!(scanner.follow_links);
        assert_eq!(scanner.max_depth, 5);
    }

    #[test]
    fn test_is_media_file() {
        let scanner = MediaScanner::new();
        assert!(scanner.is_media_file(Path::new("test.mov")));
        assert!(scanner.is_media_file(Path::new("test.mp4")));
        assert!(scanner.is_media_file(Path::new("test.MOV")));
        assert!(!scanner.is_media_file(Path::new("test.txt")));
    }

    #[test]
    fn test_scan_empty_directory() {
        let temp_dir = TempDir::new().expect("temp_dir should be valid");
        let scanner = MediaScanner::new();
        let result = scanner
            .scan(temp_dir.path(), None)
            .expect("result should be valid");
        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_scan_with_progress() {
        let temp_dir = TempDir::new().expect("temp_dir should be valid");

        // Create some test files
        fs::write(temp_dir.path().join("test1.mov"), b"test").expect("test expectation failed");
        fs::write(temp_dir.path().join("test2.mp4"), b"test").expect("test expectation failed");
        fs::write(temp_dir.path().join("test.txt"), b"test").expect("test expectation failed");

        let scanner = MediaScanner::new();
        let progress = Arc::new(ScanProgress::new());
        let result = scanner
            .scan(temp_dir.path(), Some(progress.clone()))
            .expect("test expectation failed");

        assert_eq!(result.len(), 2);
        assert!(progress.is_complete());
    }

    #[test]
    fn test_custom_extensions() {
        let mut scanner = MediaScanner::new();
        scanner.add_extension("custom".to_string());
        assert!(scanner.is_media_file(Path::new("test.custom")));
    }

    // ── scan_parallel tests ───────────────────────────────────────────────────

    #[test]
    fn test_scan_parallel_empty_directory() {
        let temp_dir = TempDir::new().expect("temp_dir should be valid");
        let scanner = MediaScanner::new();
        let result = scanner
            .scan_parallel(temp_dir.path(), &["mov", "mp4"])
            .expect("scan_parallel should succeed on empty dir");
        assert_eq!(result.len(), 0);
    }

    #[test]
    fn test_scan_parallel_finds_matching_extensions() {
        let temp_dir = TempDir::new().expect("temp_dir should be valid");

        fs::write(temp_dir.path().join("clip1.mov"), b"dummy").expect("write should succeed");
        fs::write(temp_dir.path().join("clip2.mp4"), b"dummy").expect("write should succeed");
        // Should be ignored
        fs::write(temp_dir.path().join("readme.txt"), b"ignore").expect("write should succeed");
        fs::write(temp_dir.path().join("audio.wav"), b"ignore").expect("write should succeed");

        let scanner = MediaScanner::new();
        let result = scanner
            .scan_parallel(temp_dir.path(), &["mov", "mp4"])
            .expect("scan_parallel should succeed");

        assert_eq!(
            result.len(),
            2,
            "only .mov and .mp4 should be returned, got {}",
            result.len()
        );
    }

    #[test]
    fn test_scan_parallel_case_insensitive_extensions() {
        let temp_dir = TempDir::new().expect("temp_dir should be valid");

        fs::write(temp_dir.path().join("clip.MOV"), b"dummy").expect("write should succeed");
        fs::write(temp_dir.path().join("clip.Mp4"), b"dummy").expect("write should succeed");

        let scanner = MediaScanner::new();
        let result = scanner
            .scan_parallel(temp_dir.path(), &["mov", "mp4"])
            .expect("scan_parallel should succeed");

        assert_eq!(result.len(), 2);
    }

    #[test]
    fn test_scan_parallel_recursive() {
        let temp_dir = TempDir::new().expect("temp_dir should be valid");
        let sub = temp_dir.path().join("subdir");
        fs::create_dir(&sub).expect("mkdir should succeed");

        fs::write(temp_dir.path().join("top.mov"), b"dummy").expect("write should succeed");
        fs::write(sub.join("nested.mov"), b"dummy").expect("write should succeed");

        let scanner = MediaScanner::new();
        let result = scanner
            .scan_parallel(temp_dir.path(), &["mov"])
            .expect("scan_parallel should succeed");

        assert_eq!(result.len(), 2);
    }
}