nihed-cros-libva: introduce more enums instead of constants

[nihav-player.git] / nihed-cros-libva / src / surface.rs

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

use std::rc::Rc;

use crate::bindings;
use crate::display::Display;
use crate::formats::{RTFormat, VAFourcc};
use crate::status::*;
use crate::UsageHints;

/// An owned VA surface that is tied to the lifetime of a particular VADisplay
pub struct Surface {
    display: Rc<Display>,
    id: bindings::VASurfaceID,
    width: u32,
    height: u32,
}

impl Surface {
    /// Create `Surfaces` by wrapping around a `vaCreateSurfaces` call. This is just a helper for
    /// [`Display::create_surfaces`].
    pub(crate) fn new(
        display: Rc<Display>,
        rt_format: RTFormat,
        va_fourcc: Option<VAFourcc>,
        width: u32,
        height: u32,
        usage_hints: Option<UsageHints>,
        num_surfaces: u32,
    ) -> VAResult<Vec<Self>> {
        let mut attrs = vec![];

        if let Some(usage_hints) = usage_hints {
            let attr = bindings::VASurfaceAttrib {
                type_: bindings::VASurfaceAttribType::VASurfaceAttribUsageHint,
                flags: bindings::constants::VA_SURFACE_ATTRIB_SETTABLE,
                value: bindings::VAGenericValue {
                    type_: bindings::VAGenericValueType::VAGenericValueTypeInteger,
                    value: bindings::_VAGenericValue__bindgen_ty_1 {
                        i: usage_hints.bits() as i32,
                    },
                },
            };

            attrs.push(attr);
        }

        if let Some(fourcc) = va_fourcc {
            let attr = bindings::VASurfaceAttrib {
                type_: bindings::VASurfaceAttribType::VASurfaceAttribPixelFormat,
                flags: bindings::constants::VA_DISPLAY_ATTRIB_SETTABLE,
                value: bindings::VAGenericValue {
                    type_: bindings::VAGenericValueType::VAGenericValueTypeInteger,
                    value: bindings::_VAGenericValue__bindgen_ty_1 { i: fourcc as i32 },
                },
            };

            attrs.push(attr);
        }

        let mut surfaces = Vec::with_capacity(num_surfaces as usize);

        // Safe because `self` represents a valid VADisplay. The `surface` and `attrs` vectors are
        // properly initialized and valid sizes are passed to the C function, so it is impossible to
        // write past the end of their storage by mistake.
        (unsafe {
            bindings::vaCreateSurfaces(
                display.handle(),
                rt_format.into(),
                width,
                height,
                surfaces.as_mut_ptr(),
                num_surfaces,
                attrs.as_mut_ptr(),
                attrs.len() as u32,
            )
        })
        .check()?;

        // Safe because the C function will have written to exactly `num_surfaces` entries, which is
        // known to be within the vector's capacity.
        unsafe {
            surfaces.set_len(num_surfaces as usize);
        }

        let va_surfaces = surfaces
            .iter()
            .map(|&id| Self {
                display: Rc::clone(&display),
                id,
                width,
                height,
            })
            .collect();

        Ok(va_surfaces)
    }

    /// Blocks until all pending operations on the render target have been completed. Upon return it
    /// is safe to use the render target for a different picture.
    pub fn sync(&self) -> VAResult<()> {
        // Safe because `self` represents a valid VASurface.
        (unsafe { bindings::vaSyncSurface(self.display.handle(), self.id) }).check()
    }

    /// Convenience function to return a VASurfaceID vector. Useful to interface with the C API
    /// where a surface array might be needed.
    pub fn as_id_vec(surfaces: &[Self]) -> Vec<bindings::VASurfaceID> {
        surfaces.iter().map(|surface| surface.id).collect()
    }

    /// Wrapper over `vaQuerySurfaceStatus` to find out any pending ops on the render target.
    pub fn query_status(&self) -> VAResult<VASurfaceStatus> {
        let mut status: bindings::VASurfaceStatus::Type = 0;
        // Safe because `self` represents a valid VASurface.
        (unsafe {
            bindings::vaQuerySurfaceStatus(self.display.handle(), self.id, &mut status)
        })
        .check()?;
        match status {
            bindings::VASurfaceStatus::VASurfaceRendering => Ok(VASurfaceStatus::Rendering),
            bindings::VASurfaceStatus::VASurfaceDisplaying => Ok(VASurfaceStatus::Displaying),
            bindings::VASurfaceStatus::VASurfaceReady => Ok(VASurfaceStatus::Ready),
            bindings::VASurfaceStatus::VASurfaceSkipped => Ok(VASurfaceStatus::Skipped),
            _ => Err(VAError::Unknown),
        }
    }

    /// Returns the ID of this surface.
    pub fn id(&self) -> bindings::VASurfaceID {
        self.id
    }

    /// Returns the dimensions of this surface.
    pub fn size(&self) -> (u32, u32) {
        (self.width, self.height)
    }
}

impl Drop for Surface {
    fn drop(&mut self) {
        // Safe because `self` represents a valid VASurface.
        unsafe { bindings::vaDestroySurfaces(self.display.handle(), &mut self.id, 1) };
    }
}