gstreamer_video/auto/

color_balance.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, ColorBalanceChannel, ColorBalanceType};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// This interface is implemented by elements which can perform some color
    /// balance operation on video frames they process. For example, modifying
    /// the brightness, contrast, hue or saturation.
    ///
    /// Example elements are 'xvimagesink' and 'colorbalance'
    ///
    /// ## Signals
    ///
    ///
    /// #### `value-changed`
    ///  Fired when the value of the indicated channel has changed.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`ColorBalanceExt`][trait@crate::prelude::ColorBalanceExt]
    #[doc(alias = "GstColorBalance")]
    pub struct ColorBalance(Interface<ffi::GstColorBalance, ffi::GstColorBalanceInterface>);

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

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

unsafe impl Send for ColorBalance {}
unsafe impl Sync for ColorBalance {}

/// Trait containing all [`struct@ColorBalance`] methods.
///
/// # Implementors
///
/// [`ColorBalance`][struct@crate::ColorBalance]
pub trait ColorBalanceExt: IsA<ColorBalance> + 'static {
    /// Get the [`ColorBalanceType`][crate::ColorBalanceType] of this implementation.
    ///
    /// # Returns
    ///
    /// A the [`ColorBalanceType`][crate::ColorBalanceType].
    #[doc(alias = "gst_color_balance_get_balance_type")]
    #[doc(alias = "get_balance_type")]
    fn balance_type(&self) -> ColorBalanceType {
        unsafe {
            from_glib(ffi::gst_color_balance_get_balance_type(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrieve the current value of the indicated channel, between min_value
    /// and max_value.
    ///
    /// See Also: The `GstColorBalanceChannel.min_value` and
    ///  `GstColorBalanceChannel.max_value` members of the
    ///  [`ColorBalanceChannel`][crate::ColorBalanceChannel] object.
    /// ## `channel`
    /// A [`ColorBalanceChannel`][crate::ColorBalanceChannel] instance
    ///
    /// # Returns
    ///
    /// The current value of the channel.
    #[doc(alias = "gst_color_balance_get_value")]
    #[doc(alias = "get_value")]
    fn value(&self, channel: &impl IsA<ColorBalanceChannel>) -> i32 {
        unsafe {
            ffi::gst_color_balance_get_value(
                self.as_ref().to_glib_none().0,
                channel.as_ref().to_glib_none().0,
            )
        }
    }

    /// Retrieve a list of the available channels.
    ///
    /// # Returns
    ///
    /// A
    ///  GList containing pointers to [`ColorBalanceChannel`][crate::ColorBalanceChannel]
    ///  objects. The list is owned by the [`ColorBalance`][crate::ColorBalance]
    ///  instance and must not be freed.
    #[doc(alias = "gst_color_balance_list_channels")]
    fn list_channels(&self) -> Vec<ColorBalanceChannel> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::gst_color_balance_list_channels(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Sets the current value of the channel to the passed value, which must
    /// be between min_value and max_value.
    ///
    /// See Also: The `GstColorBalanceChannel.min_value` and
    ///  `GstColorBalanceChannel.max_value` members of the
    ///  [`ColorBalanceChannel`][crate::ColorBalanceChannel] object.
    /// ## `channel`
    /// A [`ColorBalanceChannel`][crate::ColorBalanceChannel] instance
    /// ## `value`
    /// The new value for the channel.
    #[doc(alias = "gst_color_balance_set_value")]
    fn set_value(&self, channel: &impl IsA<ColorBalanceChannel>, value: i32) {
        unsafe {
            ffi::gst_color_balance_set_value(
                self.as_ref().to_glib_none().0,
                channel.as_ref().to_glib_none().0,
                value,
            );
        }
    }

    /// A helper function called by implementations of the GstColorBalance
    /// interface. It fires the [`value-changed`][struct@crate::ColorBalance#value-changed] signal on the
    /// instance, and the [`value-changed`][struct@crate::ColorBalanceChannel#value-changed] signal on the
    /// channel object.
    /// ## `channel`
    /// A [`ColorBalanceChannel`][crate::ColorBalanceChannel] whose value has changed
    /// ## `value`
    /// The new value of the channel
    #[doc(alias = "gst_color_balance_value_changed")]
    fn value_changed(&self, channel: &impl IsA<ColorBalanceChannel>, value: i32) {
        unsafe {
            ffi::gst_color_balance_value_changed(
                self.as_ref().to_glib_none().0,
                channel.as_ref().to_glib_none().0,
                value,
            );
        }
    }

    /// Fired when the value of the indicated channel has changed.
    /// ## `channel`
    /// The [`ColorBalanceChannel`][crate::ColorBalanceChannel]
    /// ## `value`
    /// The new value
    #[doc(alias = "value-changed")]
    fn connect_value_changed<F: Fn(&Self, &ColorBalanceChannel, i32) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn value_changed_trampoline<
            P: IsA<ColorBalance>,
            F: Fn(&P, &ColorBalanceChannel, i32) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstColorBalance,
            channel: *mut ffi::GstColorBalanceChannel,
            value: std::ffi::c_int,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                ColorBalance::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(channel),
                value,
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"value-changed".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    value_changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<ColorBalance>> ColorBalanceExt for O {}