oximedia

Facade crate for the OxiMedia multimedia framework.

Overview

oximedia is the main entry point for using the OxiMedia framework. It re-exports types from all component crates for convenient access:

• oximedia-core - Core types and traits
• oximedia-io - I/O and bit-level reading
• oximedia-container - Container demuxing/muxing

Usage

Basic Import

use oximedia::prelude::*;

Format Probing

use oximedia::prelude::*;

fn probe_file(path: &str) -> OxiResult<()> {
    let data = std::fs::read(path)?;
    let result = probe_format(&data)?;

    println!("Format: {:?}", result.format);
    println!("Confidence: {:.1}%", result.confidence * 100.0);

    Ok(())
}

Available Types

From oximedia-core:

From oximedia-io:

From oximedia-container:

Prelude

The prelude module exports the most commonly used types:

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

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

Example

use oximedia::prelude::*;

#[tokio::main]
async fn main() -> OxiResult<()> {
    // Create a timestamp
    let ts = Timestamp::new(1000, Rational::new(1, 1000));
    println!("Timestamp: {} seconds", ts.to_seconds());

    // Check codec type
    let codec = CodecId::Av1;
    println!("AV1 is video: {}", codec.is_video());

    // Probe a format
    let data = vec![0x1A, 0x45, 0xDF, 0xA3]; // EBML header
    if let Ok(result) = probe_format(&data) {
        println!("Detected: {:?}", result.format);
    }

    Ok(())
}

Feature matrix

Every optional feature gates in exactly one workspace crate (occasionally the same crate exposes more than one feature, e.g. oximedia-codec backs video, mjpeg, and apv). Enable only the features you need — the default build is core-only (probing, demuxing, computer vision):

Convenience presets that bundle several of the rows above:

Cookbook

Worked examples live in the workspace-level examples/ directory (built via cargo run --example <name> --features <flags>):

Every example above except ffmpeg_translate_demo lives in the workspace-root examples/ directory; ffmpeg_translate_demo lives in oximedia/examples/.

Policy

• No unsafe code (#![forbid(unsafe_code)])
• No warnings
• Apache 2.0 license

License

Apache-2.0