oximedia 0.1.0

Patent-free multimedia framework for Rust
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

//! # `OxiMedia`
//!
//! A patent-free multimedia framework for Rust.
//!
//! `OxiMedia` provides safe, async-first media processing with focus on
//! royalty-free codecs (AV1, VP9, Opus, FLAC) and clean room implementation.
//!
//! ## Features
//!
//! - **Patent-Free**: Only supports royalty-free codecs (Green List)
//! - **Memory Safe**: Pure Rust with zero unsafe code
//! - **Async-First**: Built on tokio for high concurrency
//! - **Zero-Copy**: Efficient buffer management throughout
//!
//! ## Example
//!
//! ```ignore
//! use oximedia::prelude::*;
//!
//! // Probe a media file
//! let format = probe_format(&data)?;
//! println!("Detected: {:?}", format);
//! ```

#![forbid(unsafe_code)]
#![warn(missing_docs)]

// Re-export core types
pub use oximedia_core::{
    CodecId, MediaType, OxiError, OxiResult, PixelFormat, Rational, SampleFormat, Timestamp,
};

// Re-export I/O types
pub use oximedia_io::{BitReader, FileSource, MediaSource, MemorySource};

// Re-export container types
pub use oximedia_container::{
    probe_format, CodecParams, ContainerFormat, Demuxer, Metadata, Packet, PacketFlags,
    ProbeResult, StreamInfo,
};

/// Prelude module for convenient imports.
///
/// Provides convenient re-exports for common usage.
///
/// ```ignore
/// use oximedia::prelude::*;
/// ```
pub mod prelude {

    pub use crate::{
        probe_format, CodecId, ContainerFormat, MediaType, OxiError, OxiResult, Packet,
        PacketFlags, PixelFormat, Rational, SampleFormat, Timestamp,
    };

    pub use oximedia_container::Demuxer;
    pub use oximedia_io::MediaSource;
}