mediaway-encoder 0.1.1

Hardware-accelerated video/audio encoding (OS-native backends)
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//! Intel Quick Sync / Arc (oneVPL) video encode backend.
//!
//! - [`VideoInputPreference::CpuUploadOk`](crate::VideoInputPreference::CpuUploadOk):
//!   H.264 Baseline profile, real I/P GOP structure (driver-managed
//!   reference lists — not all-IDR), CPU NV12 `upload_cpu_nv12` (copy).
//! - [`VideoInputPreference::ZeroCopyGpu`](crate::VideoInputPreference::ZeroCopyGpu):
//!   not implemented — returns [`EncodeError::Unsupported`]. Deferred to the
//!   D3D11 external-allocator Zero-Copy stage; see
//!   [`docs/roadmap.md`](../docs/roadmap.md).
//!
//! Windows only this stage (real oneVPL runtime + hardware verification both
//! only available on this workspace's Windows dev box) — this crate must stay
//! buildable (as an honest `Unsupported` stub) on non-Windows hosts running
//! `cargo check --workspace`. Mirrors `mediaway-encoder-linux`'s
//! `cfg(not(target_os = "linux"))` stub pattern.
//!
//! Policy: [ADR-0001](../adr/0001-onevpl-quicksync-encode-surface.md) — binding
//! choice (`vpl-sys`, hand-rolled `libloading` MVP dispatcher), scope, and the
//! 2026-07-29 addendum documenting what was actually built/hardware-verified.

// Not `forbid`: `quicksync` (Windows real backend) needs one localized
// `#[allow(unsafe_code)]` for a raw-slice read of the oneVPL output
// bitstream — `forbid` cannot be overridden downstream (see AGENTS.md
// Absolute rules § Safety & code hygiene). This module itself writes no
// `unsafe` and stays on the workspace-default `unsafe_code = "deny"`.

#[cfg(not(feature = "video"))]
compile_error!("enable the `video` feature on mediaway-encoder-quicksync");

use crate::EncodeError;
use crate::{VideoEncoder, VideoEncoderConfig};
use mediaway_common::VideoFrame;
use mediaway_common::{Bytes, Packet, StreamInfo};

#[cfg(windows)]
mod session;

/// Quick Sync / Arc video encode session (oneVPL H.264 CPU-upload when opened on Windows).
pub struct QuickSyncVideoEncoder {
    #[cfg(windows)]
    inner: Option<session::QuickSyncSession>,
    #[cfg(not(windows))]
    _priv: (),
}

impl QuickSyncVideoEncoder {
    /// Open a Quick Sync / Arc (oneVPL) video encoder for `config`.
    ///
    /// # Errors
    ///
    /// Returns [`EncodeError::Unsupported`] when the codec/input path is not
    /// wired (currently: anything but H.264 +
    /// [`VideoInputPreference::CpuUploadOk`](crate::VideoInputPreference::CpuUploadOk)),
    /// or [`EncodeError::Backend`] when no oneVPL runtime / Intel GPU
    /// implementation is available (expected on any host without the Intel
    /// graphics driver package installed — see this crate's `adr/0001`).
    #[cfg(windows)]
    pub fn open(config: &VideoEncoderConfig) -> Result<Self, EncodeError> {
        let inner = session::QuickSyncSession::open(config)?;
        Ok(Self { inner: Some(inner) })
    }

    /// Host / non-Windows build: encoder unavailable.
    #[cfg(not(windows))]
    pub const fn open(_config: &VideoEncoderConfig) -> Result<Self, EncodeError> {
        Err(EncodeError::Unsupported)
    }
}

#[cfg(windows)]
impl VideoEncoder for QuickSyncVideoEncoder {
    fn stream_info(&self) -> &StreamInfo {
        #[allow(
            clippy::option_if_let_else,
            reason = "map_or_else forces 'static vs 'self lifetime clash"
        )]
        if let Some(e) = self.inner.as_ref() {
            e.stream_info()
        } else {
            closed_stream_info()
        }
    }

    fn push_frame(&mut self, frame: &VideoFrame) -> Result<(), EncodeError> {
        self.inner
            .as_mut()
            .ok_or(EncodeError::Closed)?
            .push_frame(frame)
    }

    fn poll_packet(&mut self) -> Result<Option<Packet>, EncodeError> {
        self.inner
            .as_mut()
            .ok_or(EncodeError::Closed)?
            .poll_packet()
    }

    fn flush(&mut self) -> Result<(), EncodeError> {
        self.inner.as_mut().ok_or(EncodeError::Closed)?.flush()
    }
}

#[cfg(not(windows))]
impl VideoEncoder for QuickSyncVideoEncoder {
    fn stream_info(&self) -> &StreamInfo {
        closed_stream_info()
    }

    fn push_frame(&mut self, _frame: &VideoFrame) -> Result<(), EncodeError> {
        Err(EncodeError::Unsupported)
    }

    fn poll_packet(&mut self) -> Result<Option<Packet>, EncodeError> {
        Ok(None)
    }

    fn flush(&mut self) -> Result<(), EncodeError> {
        Err(EncodeError::Unsupported)
    }
}

fn closed_stream_info() -> &'static StreamInfo {
    use std::sync::OnceLock;
    static INFO: OnceLock<StreamInfo> = OnceLock::new();
    INFO.get_or_init(|| StreamInfo::Video {
        id: 0,
        codec: mediaway_common::CodecKind::H264,
        time_base: mediaway_common::Rational::new(1, 30),
        geometry: mediaway_common::VideoGeometry {
            width: 0,
            height: 0,
        },
        extra_data: Bytes::new(),
    })
}

#[cfg(all(test, windows))]
#[path = "lib_tests.rs"]
mod tests;