libva 0.1.4

Safe bindings over libva
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198

// Copyright 2025 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

//! Wrappers around `VAProcPipeline` types.

use crate::bindings;
use std::ptr;

/// Wrapper over the `VABlendState` ffi type.
pub struct BlendState(bindings::VABlendState);

impl BlendState {
    /// Creates the bindgen field
    pub fn new(flags: u32, global_alpha: f32, min_luma: f32, max_luma: f32) -> Self {
        Self(bindings::VABlendState {
            flags,
            global_alpha,
            min_luma,
            max_luma,
        })
    }
}

/// Wrapper over the `VAProcColorProperties` ffi type.
pub struct ProcColorProperties(bindings::VAProcColorProperties);

impl ProcColorProperties {
    /// Creates the bindgen field
    pub fn new(
        chroma_sample_location: u8,
        color_range: u8,
        colour_primaries: u8,
        transfer_characteristics: u8,
        matrix_coefficients: u8,
    ) -> Self {
        Self(bindings::VAProcColorProperties {
            chroma_sample_location,
            color_range,
            colour_primaries,
            transfer_characteristics,
            matrix_coefficients,
            reserved: Default::default(),
        })
    }
}

impl Default for ProcColorProperties {
    fn default() -> Self {
        Self::new(0, 0, 0, 0, 0)
    }
}

/// Wrapper over the `VAHdrMetaData` ffi type.
pub struct HdrMetaData(bindings::VAHdrMetaData);

impl<'a> HdrMetaData {
    /// Creates the bindgen field
    pub fn new(metadata_type: u32, metadata: Option<&'a [u8]>, metadata_size: u32) -> Self {
        Self(bindings::VAHdrMetaData {
            metadata_type: metadata_type as _,
            metadata: metadata.map_or(ptr::null_mut(), |f| f.as_ptr() as *mut _),
            metadata_size,
            reserved: Default::default(),
        })
    }
}

/// Wrapper over the `VAProcPipelineParameterBuffer` FFI type.
pub struct ProcPipelineParameterBuffer {
    c_params: Box<bindings::VAProcPipelineParameterBuffer>,

    // Fields that own the data for the pointers in `c_params`.
    surface_region: Option<Box<bindings::VARectangle>>,
    output_region: Option<Box<bindings::VARectangle>>,
    filters: Option<Vec<bindings::VABufferID>>,
    forward_references: Option<Vec<bindings::VASurfaceID>>,
    backward_references: Option<Vec<bindings::VASurfaceID>>,
    blend_state: Option<Vec<BlendState>>,
    additional_outputs: Option<Vec<bindings::VASurfaceID>>,
    output_hdr_metadata: Option<Vec<HdrMetaData>>,
}

impl ProcPipelineParameterBuffer {
    /// Creates the wrapper.
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        surface: bindings::VASurfaceID,
        surface_region: Option<bindings::VARectangle>,
        surface_color_standard: u8,
        output_region: Option<bindings::VARectangle>,
        output_background_color: u32,
        output_color_standard: u8,
        pipeline_flags: u32,
        filter_flags: u32,
        filters: Option<Vec<bindings::VABufferID>>,
        forward_references: Option<Vec<bindings::VASurfaceID>>,
        backward_references: Option<Vec<bindings::VASurfaceID>>,
        rotation_state: u32,
        blend_state: Option<Vec<BlendState>>,
        mirror_state: u32,
        additional_outputs: Option<Vec<bindings::VASurfaceID>>,
        input_surface_flag: u32,
        output_surface_flag: u32,
        input_color_properties: ProcColorProperties,
        output_color_properties: ProcColorProperties,
        processing_mode: u32,
        output_hdr_metadata: Option<Vec<HdrMetaData>>,
    ) -> Self {
        let mut slf = Self {
            // SAFETY: The VA-API structures are C-compatible so zeroing is safe.
            c_params: Box::new(unsafe { std::mem::zeroed() }),
            surface_region: surface_region.map(Box::new),
            output_region: output_region.map(Box::new),
            filters,
            forward_references,
            backward_references,
            blend_state,
            additional_outputs,
            output_hdr_metadata,
        };

        slf.c_params = Box::new(bindings::VAProcPipelineParameterBuffer {
            surface,
            surface_region: slf
                .surface_region
                .as_deref()
                .map_or(ptr::null_mut(), |r| r as *const _ as *mut _),
            surface_color_standard: surface_color_standard as _,
            output_region: slf
                .output_region
                .as_deref()
                .map_or(ptr::null_mut(), |r| r as *const _ as *mut _),
            output_background_color,
            output_color_standard: output_color_standard as _,
            pipeline_flags,
            filter_flags,
            filters: slf
                .filters
                .as_deref()
                .map_or(ptr::null_mut(), |f| f.as_ptr() as *mut _),
            num_filters: slf.filters.as_ref().map_or(0, |f| f.len() as u32),
            forward_references: slf
                .forward_references
                .as_deref()
                .map_or(ptr::null_mut(), |r| r.as_ptr() as *mut _),
            num_forward_references: slf
                .forward_references
                .as_ref()
                .map_or(0, |f| f.len() as u32),
            backward_references: slf
                .backward_references
                .as_deref()
                .map_or(ptr::null_mut(), |r| r.as_ptr() as *mut _),
            num_backward_references: slf
                .backward_references
                .as_ref()
                .map_or(0, |b| b.len() as u32),
            rotation_state,
            blend_state: slf
                .blend_state
                .as_deref()
                .map_or(ptr::null(), |b| b.as_ptr() as *const bindings::VABlendState),
            mirror_state,
            additional_outputs: slf
                .additional_outputs
                .as_deref()
                .map_or(ptr::null_mut(), |a| a.as_ptr() as *mut _),
            num_additional_outputs: slf
                .additional_outputs
                .as_ref()
                .map_or(0, |a| a.len() as u32),
            input_surface_flag,
            output_surface_flag,
            input_color_properties: input_color_properties.0,
            output_color_properties: output_color_properties.0,
            processing_mode,
            output_hdr_metadata: slf
                .output_hdr_metadata
                .as_deref()
                .map_or(ptr::null_mut(), |o| {
                    o.as_ptr() as *mut bindings::VAHdrMetaData
                }),
            va_reserved: Default::default(),
        });

        slf
    }

    pub(crate) fn inner_mut(&mut self) -> &mut bindings::VAProcPipelineParameterBuffer {
        self.c_params.as_mut()
    }

    /// Returns the inner FFI type. Useful for testing purposes.
    pub fn inner(&self) -> &bindings::VAProcPipelineParameterBuffer {
        self.c_params.as_ref()
    }
}