gstreamer/auto/

buffer_pool.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::{ffi, Buffer, Object};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// A [`BufferPool`][crate::BufferPool] is an object that can be used to pre-allocate and recycle
    /// buffers of the same size and with the same properties.
    ///
    /// A [`BufferPool`][crate::BufferPool] is created with [`new()`][Self::new()].
    ///
    /// Once a pool is created, it needs to be configured. A call to
    /// [`BufferPoolExtManual::config()`][crate::prelude::BufferPoolExtManual::config()] returns the current configuration structure from
    /// the pool. With `gst_buffer_pool_config_set_params()` and
    /// `gst_buffer_pool_config_set_allocator()` the bufferpool parameters and
    /// allocator can be configured. Other properties can be configured in the pool
    /// depending on the pool implementation.
    ///
    /// A bufferpool can have extra options that can be enabled with
    /// `gst_buffer_pool_config_add_option()`. The available options can be retrieved
    /// with [`BufferPoolExt::options()`][crate::prelude::BufferPoolExt::options()]. Some options allow for additional
    /// configuration properties to be set.
    ///
    /// After the configuration structure has been configured,
    /// [`BufferPoolExtManual::set_config()`][crate::prelude::BufferPoolExtManual::set_config()] updates the configuration in the pool. This can
    /// fail when the configuration structure is not accepted.
    ///
    /// After the pool has been configured, it can be activated with
    /// [`BufferPoolExt::set_active()`][crate::prelude::BufferPoolExt::set_active()]. This will preallocate the configured resources
    /// in the pool.
    ///
    /// When the pool is active, [`BufferPoolExtManual::acquire_buffer()`][crate::prelude::BufferPoolExtManual::acquire_buffer()] can be used to
    /// retrieve a buffer from the pool.
    ///
    /// Buffers allocated from a bufferpool will automatically be returned to the
    /// pool with [`BufferPoolExt::release_buffer()`][crate::prelude::BufferPoolExt::release_buffer()] when their refcount drops to 0.
    ///
    /// The bufferpool can be deactivated again with [`BufferPoolExt::set_active()`][crate::prelude::BufferPoolExt::set_active()].
    /// All further [`BufferPoolExtManual::acquire_buffer()`][crate::prelude::BufferPoolExtManual::acquire_buffer()] calls will return an error. When
    /// all buffers are returned to the pool they will be freed.
    ///
    /// # Implements
    ///
    /// [`BufferPoolExt`][trait@crate::prelude::BufferPoolExt], [`GstObjectExt`][trait@crate::prelude::GstObjectExt], [`trait@glib::ObjectExt`], [`BufferPoolExtManual`][trait@crate::prelude::BufferPoolExtManual]
    #[doc(alias = "GstBufferPool")]
    pub struct BufferPool(Object<ffi::GstBufferPool, ffi::GstBufferPoolClass>) @extends Object;

    match fn {
        type_ => || ffi::gst_buffer_pool_get_type(),
    }
}

impl BufferPool {
    pub const NONE: Option<&'static BufferPool> = None;

    /// Creates a new [`BufferPool`][crate::BufferPool] instance.
    ///
    /// # Returns
    ///
    /// a new [`BufferPool`][crate::BufferPool] instance
    #[doc(alias = "gst_buffer_pool_new")]
    pub fn new() -> BufferPool {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gst_buffer_pool_new()) }
    }
}

impl Default for BufferPool {
    fn default() -> Self {
        Self::new()
    }
}

unsafe impl Send for BufferPool {}
unsafe impl Sync for BufferPool {}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::BufferPool>> Sealed for T {}
}

/// Trait containing all [`struct@BufferPool`] methods.
///
/// # Implementors
///
/// [`BufferPool`][struct@crate::BufferPool]
pub trait BufferPoolExt: IsA<BufferPool> + sealed::Sealed + 'static {
    /// Gets a [`None`] terminated array of string with supported bufferpool options for
    /// `self`. An option would typically be enabled with
    /// `gst_buffer_pool_config_add_option()`.
    ///
    /// # Returns
    ///
    /// a [`None`] terminated array
    ///  of strings.
    #[doc(alias = "gst_buffer_pool_get_options")]
    #[doc(alias = "get_options")]
    fn options(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::gst_buffer_pool_get_options(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Checks if the bufferpool supports `option`.
    /// ## `option`
    /// an option
    ///
    /// # Returns
    ///
    /// [`true`] if the buffer pool contains `option`.
    #[doc(alias = "gst_buffer_pool_has_option")]
    fn has_option(&self, option: &str) -> bool {
        unsafe {
            from_glib(ffi::gst_buffer_pool_has_option(
                self.as_ref().to_glib_none().0,
                option.to_glib_none().0,
            ))
        }
    }

    /// Checks if `self` is active. A pool can be activated with the
    /// [`set_active()`][Self::set_active()] call.
    ///
    /// # Returns
    ///
    /// [`true`] when the pool is active.
    #[doc(alias = "gst_buffer_pool_is_active")]
    fn is_active(&self) -> bool {
        unsafe {
            from_glib(ffi::gst_buffer_pool_is_active(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Releases `buffer` to `self`. `buffer` should have previously been allocated from
    /// `self` with [`BufferPoolExtManual::acquire_buffer()`][crate::prelude::BufferPoolExtManual::acquire_buffer()].
    ///
    /// This function is usually called automatically when the last ref on `buffer`
    /// disappears.
    /// ## `buffer`
    /// a [`Buffer`][crate::Buffer]
    #[doc(alias = "gst_buffer_pool_release_buffer")]
    fn release_buffer(&self, buffer: Buffer) {
        unsafe {
            ffi::gst_buffer_pool_release_buffer(
                self.as_ref().to_glib_none().0,
                buffer.into_glib_ptr(),
            );
        }
    }

    /// Controls the active state of `self`. When the pool is inactive, new calls to
    /// [`BufferPoolExtManual::acquire_buffer()`][crate::prelude::BufferPoolExtManual::acquire_buffer()] will return with [`FlowReturn::Flushing`][crate::FlowReturn::Flushing].
    ///
    /// Activating the bufferpool will preallocate all resources in the pool based on
    /// the configuration of the pool.
    ///
    /// Deactivating will free the resources again when there are no outstanding
    /// buffers. When there are outstanding buffers, they will be freed as soon as
    /// they are all returned to the pool.
    /// ## `active`
    /// the new active state
    ///
    /// # Returns
    ///
    /// [`false`] when the pool was not configured or when preallocation of the
    /// buffers failed.
    #[doc(alias = "gst_buffer_pool_set_active")]
    fn set_active(&self, active: bool) -> Result<(), glib::error::BoolError> {
        unsafe {
            glib::result_from_gboolean!(
                ffi::gst_buffer_pool_set_active(self.as_ref().to_glib_none().0, active.into_glib()),
                "Failed to activate buffer pool"
            )
        }
    }

    /// Enables or disables the flushing state of a `self` without freeing or
    /// allocating buffers.
    /// ## `flushing`
    /// whether to start or stop flushing
    #[doc(alias = "gst_buffer_pool_set_flushing")]
    fn set_flushing(&self, flushing: bool) {
        unsafe {
            ffi::gst_buffer_pool_set_flushing(self.as_ref().to_glib_none().0, flushing.into_glib());
        }
    }
}

impl<O: IsA<BufferPool>> BufferPoolExt for O {}