videocall-codecs 0.1.9

Cross-platform video codec library with VP8/VP9 support for native and WebAssembly environments
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

/*
 * Copyright 2025 Security Union LLC
 *
 * Licensed under either of
 *
 * * Apache License, Version 2.0
 *   (http://www.apache.org/licenses/LICENSE-2.0)
 * * MIT license
 *   (http://opensource.org/licenses/MIT)
 *
 * at your option.
 *
 * Unless you explicitly state otherwise, any contribution intentionally
 * submitted for inclusion in the work by you, as defined in the Apache-2.0
 * license, shall be dual licensed as above, without any additional terms or
 * conditions.
 */

//! The common interface for platform-specific decoders.

use crate::frame::FrameBuffer;
use serde::{Deserialize, Serialize};

/// An enumeration of the supported video codecs.
#[derive(Debug, Clone, Copy)]
pub enum VideoCodec {
    /// VP9 codec, using libvpx.
    VP9,
    /// A mock decoder that does nothing, for testing and simulation.
    Mock,
}

/// Represents a fully decoded frame, ready for rendering.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DecodedFrame {
    pub sequence_number: u64,
    pub width: u32,
    pub height: u32,
    // In a real implementation, this would hold image planes (e.g., YUV data).
    pub data: Vec<u8>,
}

/// A trait that abstracts over the platform-specific decoder implementation
/// (e.g., `std::thread` on native, Web Workers + WebCodecs in WASM).
pub trait Decodable: Send + Sync {
    /// The type of frame passed to the callback when a frame is decoded.
    type Frame;

    /// Creates a new decoder and starts its underlying thread or worker.
    /// The `on_decoded_frame` callback will be invoked whenever a frame is successfully decoded.
    fn new(codec: VideoCodec, on_decoded_frame: Box<dyn Fn(Self::Frame) + Send + Sync>) -> Self
    where
        Self: Sized;

    /// Sends a raw frame buffer to the decoder for processing.
    fn decode(&self, frame: FrameBuffer);
}

// Conditionally compile and expose the native implementation
#[cfg(feature = "native")]
mod native;
#[cfg(feature = "native")]
pub use self::native::NativeDecoder as Decoder;

// Conditionally compile and expose the WASM implementation
#[cfg(feature = "wasm")]
mod wasm;
#[cfg(feature = "wasm")]
pub use self::wasm::WasmDecoder; // Export WasmDecoder directly for VideoFrame callbacks