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

// 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::StreamVolumeFormat;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::mem::transmute;

glib::wrapper! {
    /// This interface is implemented by elements that provide a stream volume. Examples for
    /// such elements are `volume` and `playbin`.
    ///
    /// Applications can use this interface to get or set the current stream volume. For this
    /// the "volume" [`crate::glib::object::Object`] property can be used or the helper functions [`Self::set_volume()`]
    /// and [`Self::get_volume()`]. This volume is always a linear factor, i.e. 0.0 is muted
    /// 1.0 is 100%. For showing the volume in a GUI it might make sense to convert it to
    /// a different format by using [`Self::convert_volume()`]. Volume sliders should usually
    /// use a cubic volume.
    ///
    /// Separate from the volume the stream can also be muted by the "mute" [`crate::glib::object::Object`] property or
    /// [`Self::set_mute()`] and [`Self::get_mute()`].
    ///
    /// Elements that provide some kind of stream volume should implement the "volume" and
    /// "mute" [`crate::glib::object::Object`] properties and handle setting and getting of them properly.
    /// The volume property is defined to be a linear volume factor.
    ///
    /// # Implements
    ///
    /// [`trait@crate::prelude::StreamVolumeExt`]
    pub struct StreamVolume(Interface<ffi::GstStreamVolume, ffi::GstStreamVolumeInterface>);

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

impl StreamVolume {
    /// ## `from`
    /// [`crate::StreamVolumeFormat`] to convert from
    /// ## `to`
    /// [`crate::StreamVolumeFormat`] to convert to
    /// ## `val`
    /// Volume in `from` format that should be converted
    ///
    /// # Returns
    ///
    /// the converted volume
    #[doc(alias = "gst_stream_volume_convert_volume")]
    pub fn convert_volume(from: StreamVolumeFormat, to: StreamVolumeFormat, val: f64) -> f64 {
        assert_initialized_main_thread!();
        unsafe { ffi::gst_stream_volume_convert_volume(from.into_glib(), to.into_glib(), val) }
    }
}

unsafe impl Send for StreamVolume {}
unsafe impl Sync for StreamVolume {}

pub const NONE_STREAM_VOLUME: Option<&StreamVolume> = None;

/// Trait containing all `StreamVolume` methods.
///
/// # Implementors
///
/// [`struct@crate::StreamVolume`]
pub trait StreamVolumeExt: 'static {
    ///
    /// # Returns
    ///
    /// Returns [`true`] if the stream is muted
    #[doc(alias = "gst_stream_volume_get_mute")]
    #[doc(alias = "get_mute")]
    fn is_muted(&self) -> bool;

    /// ## `format`
    /// [`crate::StreamVolumeFormat`] which should be returned
    ///
    /// # Returns
    ///
    /// The current stream volume as linear factor
    #[doc(alias = "gst_stream_volume_get_volume")]
    #[doc(alias = "get_volume")]
    fn volume(&self, format: StreamVolumeFormat) -> f64;

    /// ## `mute`
    /// Mute state that should be set
    #[doc(alias = "gst_stream_volume_set_mute")]
    fn set_mute(&self, mute: bool);

    /// ## `format`
    /// [`crate::StreamVolumeFormat`] of `val`
    /// ## `val`
    /// Linear volume factor that should be set
    #[doc(alias = "gst_stream_volume_set_volume")]
    fn set_volume(&self, format: StreamVolumeFormat, val: f64);

    #[doc(alias = "mute")]
    fn connect_mute_notify<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId;

    #[doc(alias = "volume")]
    fn connect_volume_notify<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId;
}

impl<O: IsA<StreamVolume>> StreamVolumeExt for O {
    fn is_muted(&self) -> bool {
        unsafe {
            from_glib(ffi::gst_stream_volume_get_mute(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn volume(&self, format: StreamVolumeFormat) -> f64 {
        unsafe {
            ffi::gst_stream_volume_get_volume(self.as_ref().to_glib_none().0, format.into_glib())
        }
    }

    fn set_mute(&self, mute: bool) {
        unsafe {
            ffi::gst_stream_volume_set_mute(self.as_ref().to_glib_none().0, mute.into_glib());
        }
    }

    fn set_volume(&self, format: StreamVolumeFormat, val: f64) {
        unsafe {
            ffi::gst_stream_volume_set_volume(
                self.as_ref().to_glib_none().0,
                format.into_glib(),
                val,
            );
        }
    }

    #[doc(alias = "mute")]
    fn connect_mute_notify<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_mute_trampoline<P, F: Fn(&P) + Send + Sync + 'static>(
            this: *mut ffi::GstStreamVolume,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) where
            P: IsA<StreamVolume>,
        {
            let f: &F = &*(f as *const F);
            f(&StreamVolume::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::mute\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_mute_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "volume")]
    fn connect_volume_notify<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_volume_trampoline<P, F: Fn(&P) + Send + Sync + 'static>(
            this: *mut ffi::GstStreamVolume,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) where
            P: IsA<StreamVolume>,
        {
            let f: &F = &*(f as *const F);
            f(&StreamVolume::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::volume\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_volume_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}