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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
// 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::EncodingProfile;
use glib::translate::*;
use std::fmt;
use std::ptr;

glib::wrapper! {
    /// Collection of [`crate::EncodingProfile`] for a specific target or use-case.
    ///
    /// When being stored/loaded, targets come from a specific category, like
    /// `GST_ENCODING_CATEGORY_DEVICE`.
    ///
    /// # Implements
    ///
    /// [`trait@glib::object::ObjectExt`]
    pub struct EncodingTarget(Object<ffi::GstEncodingTarget>);

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

impl EncodingTarget {
    /// Creates a new [`crate::EncodingTarget`].
    ///
    /// The name and category can only consist of lowercase ASCII letters for the
    /// first character, followed by either lowercase ASCII letters, digits or
    /// hyphens ('-').
    ///
    /// The `category` *should* be one of the existing
    /// well-defined categories, like `GST_ENCODING_CATEGORY_DEVICE`, but it
    /// *can* be a application or user specific category if
    /// needed.
    /// ## `name`
    /// The name of the target.
    /// ## `category`
    /// The name of the category to which this `target`
    /// belongs. For example: `GST_ENCODING_CATEGORY_DEVICE`.
    /// ## `description`
    /// A description of [`crate::EncodingTarget`] in the
    /// current locale.
    /// ## `profiles`
    /// A [`crate::glib::List`] of
    /// [`crate::EncodingProfile`].
    ///
    /// # Returns
    ///
    /// The newly created [`crate::EncodingTarget`] or [`None`] if
    /// there was an error.
    #[doc(alias = "gst_encoding_target_new")]
    pub fn new(
        name: &str,
        category: &str,
        description: &str,
        profiles: &[EncodingProfile],
    ) -> EncodingTarget {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gst_encoding_target_new(
                name.to_glib_none().0,
                category.to_glib_none().0,
                description.to_glib_none().0,
                profiles.to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// The category of the `self`. For example:
    /// `GST_ENCODING_CATEGORY_DEVICE`.
    #[doc(alias = "gst_encoding_target_get_category")]
    #[doc(alias = "get_category")]
    pub fn category(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gst_encoding_target_get_category(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// The description of the `self`.
    #[doc(alias = "gst_encoding_target_get_description")]
    #[doc(alias = "get_description")]
    pub fn description(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::gst_encoding_target_get_description(
                self.to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// The name of the `self`.
    #[doc(alias = "gst_encoding_target_get_name")]
    #[doc(alias = "get_name")]
    pub fn name(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::gst_encoding_target_get_name(self.to_glib_none().0)) }
    }

    ///
    /// # Returns
    ///
    /// The path to the `self` file.
    #[cfg(any(feature = "v1_18", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v1_18")))]
    #[doc(alias = "gst_encoding_target_get_path")]
    #[doc(alias = "get_path")]
    pub fn path(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::gst_encoding_target_get_path(self.to_glib_none().0)) }
    }

    /// ## `name`
    /// the name of the profile to retrieve
    ///
    /// # Returns
    ///
    /// The matching [`crate::EncodingProfile`], or [`None`].
    #[doc(alias = "gst_encoding_target_get_profile")]
    #[doc(alias = "get_profile")]
    pub fn profile(&self, name: &str) -> Option<EncodingProfile> {
        unsafe {
            from_glib_full(ffi::gst_encoding_target_get_profile(
                self.to_glib_none().0,
                name.to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// A list of
    /// [`crate::EncodingProfile`](s) this `self` handles.
    #[doc(alias = "gst_encoding_target_get_profiles")]
    #[doc(alias = "get_profiles")]
    pub fn profiles(&self) -> Vec<EncodingProfile> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::gst_encoding_target_get_profiles(
                self.to_glib_none().0,
            ))
        }
    }

    /// Saves the `self` to a default user-local directory.
    ///
    /// # Returns
    ///
    /// [`true`] if the target was correctly saved, else [`false`].
    #[doc(alias = "gst_encoding_target_save")]
    pub fn save(&self) -> Result<(), glib::Error> {
        unsafe {
            let mut error = ptr::null_mut();
            let _ = ffi::gst_encoding_target_save(self.to_glib_none().0, &mut error);
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Saves the `self` to the provided file location.
    /// ## `filepath`
    /// the location to store the `self` at.
    ///
    /// # Returns
    ///
    /// [`true`] if the target was correctly saved, else [`false`].
    #[doc(alias = "gst_encoding_target_save_to_file")]
    pub fn save_to_file<P: AsRef<std::path::Path>>(&self, filepath: P) -> Result<(), glib::Error> {
        unsafe {
            let mut error = ptr::null_mut();
            let _ = ffi::gst_encoding_target_save_to_file(
                self.to_glib_none().0,
                filepath.as_ref().to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Searches for the [`crate::EncodingTarget`] with the given name, loads it
    /// and returns it.
    ///
    /// If the category name is specified only targets from that category will be
    /// searched for.
    /// ## `name`
    /// the name of the [`crate::EncodingTarget`] to load (automatically
    /// converted to lower case internally as capital letters are not
    /// valid for target names).
    /// ## `category`
    /// the name of the target category, like
    /// `GST_ENCODING_CATEGORY_DEVICE`. Can be [`None`]
    ///
    /// # Returns
    ///
    /// The [`crate::EncodingTarget`] if available, else [`None`].
    #[doc(alias = "gst_encoding_target_load")]
    pub fn load(name: &str, category: Option<&str>) -> Result<EncodingTarget, glib::Error> {
        assert_initialized_main_thread!();
        unsafe {
            let mut error = ptr::null_mut();
            let ret = ffi::gst_encoding_target_load(
                name.to_glib_none().0,
                category.to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Opens the provided file and returns the contained [`crate::EncodingTarget`].
    /// ## `filepath`
    /// The file location to load the [`crate::EncodingTarget`] from
    ///
    /// # Returns
    ///
    /// The [`crate::EncodingTarget`] contained in the file, else
    /// [`None`]
    #[doc(alias = "gst_encoding_target_load_from_file")]
    pub fn load_from_file<P: AsRef<std::path::Path>>(
        filepath: P,
    ) -> Result<EncodingTarget, glib::Error> {
        assert_initialized_main_thread!();
        unsafe {
            let mut error = ptr::null_mut();
            let ret = ffi::gst_encoding_target_load_from_file(
                filepath.as_ref().to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }
}

impl fmt::Display for EncodingTarget {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str(&self.name())
    }
}

unsafe impl Send for EncodingTarget {}
unsafe impl Sync for EncodingTarget {}