liboxen 0.53.0

Oxen is a fast data version control system, built with machine learning training data in mind. Designed to handle terabytes of data with ease, using a workflow similar to git. Version both structured and unstructured data of any modality: text, images, video, audio, CSV, Parquet, JSONL, model checkpoints, and more. liboxen is the embeddable core library behind the oxen CLI and server, which power fine tuning and inference pipelines for multimodal LLMs, image models, and video models on Oxen.ai.
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

//! Helper functions to get metadata from the video files.
//!

use crate::{error::OxenError, model::metadata::MetadataVideo};

use mp4::{Mp4Track, TrackType};
use std::fs::File;
use std::io::BufReader;
use std::path::Path;

/// Detects the video metadata for the given file.
pub fn get_metadata(path: impl AsRef<Path>) -> Result<MetadataVideo, OxenError> {
    let path = path.as_ref();
    let f = match File::open(path) {
        Ok(f) => f,
        Err(e) => return Err(OxenError::file_error(path, e)),
    };

    let size = f.metadata()?.len();
    let reader = BufReader::new(f);

    match mp4::Mp4Reader::read_header(reader, size) {
        Ok(video) => {
            let duration = video.duration().as_secs_f64();

            let video_tracks: Vec<&Mp4Track> = video
                .tracks()
                .values()
                .filter_map(|t| match t.track_type() {
                    Ok(TrackType::Video) => Some(Ok(t)),
                    Ok(_) => None,
                    Err(e) => Some(Err(OxenError::basic_str(format!(
                        "Could not get track type: {e:?}"
                    )))),
                })
                .collect::<Result<Vec<_>, _>>()?;

            let video = video_tracks
                .first()
                .ok_or_else(|| OxenError::basic_str("Could not get video track"))?;

            Ok(MetadataVideo::new(
                duration,
                video.width() as usize,
                video.height() as usize,
            ))
        }
        Err(err) => {
            let err = format!("Could not get video metadata {err:?}");
            Err(OxenError::basic_str(err))
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::model::EntryDataType;
    use crate::model::metadata::MetadataVideo;
    use crate::model::metadata::generic_metadata::GenericMetadata;
    use crate::repositories;
    use crate::test;

    use approx::assert_relative_eq;

    #[test]
    fn test_get_metadata_video_mp4() {
        let file = test::test_video_file_with_name("basketball.mp4");
        let metadata = repositories::metadata::get(file).unwrap();
        println!("metadata: {metadata:?}");

        assert_eq!(metadata.size, 23599);
        assert_eq!(metadata.data_type, EntryDataType::Video);
        assert_eq!(metadata.mime_type, "video/mp4");

        let metadata: MetadataVideo = match metadata.metadata.unwrap() {
            GenericMetadata::MetadataVideo(metadata) => metadata,
            _ => panic!("Wrong metadata type"),
        };

        assert_eq!(metadata.video.width, 128);
        assert_eq!(metadata.video.height, 176);
        assert_relative_eq!(metadata.video.num_seconds, 1.6);
    }

    #[test]
    fn test_get_metadata_video_mov() {
        let file = test::test_video_file_with_name("dog_skatez.mov");
        let expected_size = std::fs::metadata(&file).unwrap().len();
        let metadata = repositories::metadata::get(&file).unwrap();
        println!("metadata: {metadata:?}");

        assert_eq!(metadata.size, expected_size);
        assert_eq!(metadata.data_type, EntryDataType::Video);
        assert_eq!(metadata.mime_type, "video/quicktime");

        let metadata: MetadataVideo = match metadata.metadata.unwrap() {
            GenericMetadata::MetadataVideo(metadata) => metadata,
            _ => panic!("Wrong metadata type"),
        };

        assert_eq!(metadata.video.width, 64);
        assert_eq!(metadata.video.height, 64);
        assert_relative_eq!(metadata.video.num_seconds, 1.0);
    }
}