moq-video 0.1.1

Native video capture/encoding/decoding for Media over QUIC
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

//! Encode captured video and publish it as a moq video track.
//!
//! The output codec is selected via [`Codec`] (H.264 or H.265); see its docs
//! for which backends cover each on this platform.
//!
//! Entry points, high to low level:
//! - `publish_capture` captures and publishes a webcam (turnkey). Requires the
//!   `capture` feature.
//! - [`Encoder`] encodes raw [`Frame`](crate::Frame)s you supply into
//!   [`Encoded`] access units, and [`Producer`] publishes those (bring your own
//!   frames). Build both for the same [`Codec`].
//! - [`Sink`] is an [`Encoder`] that owns the thread it runs on, for an encoder
//!   outliving a single thread's stack (a shared object, an FFI handle, a task
//!   that migrates between workers).
//! - [`Producer`] alone publishes frames you already encoded.
//!
//! A [`Producer`] advertises its catalog rendition as soon as the track exists,
//! resolved from the encoder itself via [`Config::probe`], so a subscriber can
//! discover a track nothing has encoded yet. That's what makes on-demand
//! encoding possible at all.
//!
//! `Options` (with `capture`) / [`Kind`] / [`Config`] configure them. The decode/consume
//! counterpart (mirror of `moq-audio`'s consumer) lives in the sibling
//! [`decode`](crate::decode) module.
//!
//! The shared [`moq_mux::rate`] policy maps a congestion-control bandwidth
//! estimate onto the encoder's bitrate, which `publish_capture` drives for you.

mod backend;
mod encoded;
mod encoder;
mod producer;
mod sink;

pub use backend::NAMES;
pub use encoded::Encoded;
pub use encoder::{Codec, Config, Encoder, Gop, Kind};
pub use producer::Producer;
#[cfg(feature = "capture")]
pub use producer::{Options, publish_capture};
pub use sink::Sink;

#[cfg(test)]
mod tests {
	/// The worker-backed API is the supported way to move an encoder between
	/// tasks or threads, so keep that contract checked on every platform.
	#[test]
	fn sink_is_send() {
		fn assert_send<T: Send>() {}
		assert_send::<super::Sink>();
	}
}