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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
// 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::Edge;
use crate::EditMode;
use crate::Extractable;
use crate::Layer;
use crate::MetaContainer;
use crate::TimelineElement;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib::StaticType;
use std::boxed::Box as Box_;
use std::mem::transmute;

glib::wrapper! {
    /// A [`Container`][crate::Container] is a timeline element that controls other
    /// [`TimelineElement`][crate::TimelineElement]-s, which are its children. In particular, it is
    /// responsible for maintaining the relative `property::TimelineElement::start` and
    /// `property::TimelineElement::duration` times of its children. Therefore, if a
    /// container is temporally adjusted or moved to a new layer, it may
    /// accordingly adjust and move its children. Similarly, a change in one of
    /// its children may prompt the parent to correspondingly change its
    /// siblings.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// # Implements
    ///
    /// [`GESContainerExt`][trait@crate::prelude::GESContainerExt], [`TimelineElementExt`][trait@crate::prelude::TimelineElementExt], [`trait@glib::ObjectExt`], [`ExtractableExt`][trait@crate::prelude::ExtractableExt], [`MetaContainerExt`][trait@crate::prelude::MetaContainerExt], [`TimelineElementExtManual`][trait@crate::prelude::TimelineElementExtManual]
    #[doc(alias = "GESContainer")]
    pub struct Container(Object<ffi::GESContainer, ffi::GESContainerClass>) @extends TimelineElement, @implements Extractable, MetaContainer;

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

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

    /// Groups the containers into a single container by merging them. The
    /// containers must all belong to the same `property::TimelineElement::timeline`.
    ///
    /// If the elements are all [`Clip`][crate::Clip]-s then this method will attempt to
    /// combine them all into a single [`Clip`][crate::Clip]. This should succeed if they:
    /// share the same `property::TimelineElement::start`, `property::TimelineElement::duration`
    /// and `property::TimelineElement::in-point`; exist in the same layer; and all of
    /// the sources share the same [`Asset`][crate::Asset]. If this fails, or one of the
    /// elements is not a [`Clip`][crate::Clip], this method will try to create a [`Group`][crate::Group]
    /// instead.
    /// ## `containers`
    ///
    /// The [`Container`][crate::Container]-s to group
    ///
    /// # Returns
    ///
    /// The container created by merging
    /// `containers`, or [`None`] if they could not be merged into a single
    /// container.
    #[doc(alias = "ges_container_group")]
    pub fn group(containers: &[Container]) -> Option<Container> {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::ges_container_group(containers.to_glib_none().0)) }
    }
}

/// Trait containing all [`struct@Container`] methods.
///
/// # Implementors
///
/// [`Clip`][struct@crate::Clip], [`Container`][struct@crate::Container], [`Group`][struct@crate::Group]
pub trait GESContainerExt: 'static {
    /// Adds a timeline element to the container. The element will now be a
    /// child of the container (and the container will be the
    /// `property::TimelineElement::parent` of the added element), which means that it
    /// is now controlled by the container. This may change the properties of
    /// the child or the container, depending on the subclass.
    ///
    /// Additionally, the children properties of the newly added element will
    /// be shared with the container, meaning they can also be read and set
    /// using [`TimelineElementExt::child_property()`][crate::prelude::TimelineElementExt::child_property()] and
    /// [`TimelineElementExt::set_child_property()`][crate::prelude::TimelineElementExt::set_child_property()] on the container.
    /// ## `child`
    /// The element to add as a child
    ///
    /// # Returns
    ///
    /// [`true`] if `child` was successfully added to `self`.
    #[doc(alias = "ges_container_add")]
    fn add(&self, child: &impl IsA<TimelineElement>) -> Result<(), glib::error::BoolError>;

    /// Edits the container within its timeline.
    ///
    /// # Deprecated since 1.18
    ///
    /// use `ges_timeline_element_edit` instead.
    /// ## `layers`
    /// A whitelist of layers
    /// where the edit can be performed, [`None`] allows all layers in the
    /// timeline
    /// ## `new_layer_priority`
    /// The priority/index of the layer `self` should
    /// be moved to. -1 means no move
    /// ## `mode`
    /// The edit mode
    /// ## `edge`
    /// The edge of `self` where the edit should occur
    /// ## `position`
    /// The edit position: a new location for the edge of `self`
    /// (in nanoseconds)
    ///
    /// # Returns
    ///
    /// [`true`] if the edit of `self` completed, [`false`] on failure.
    #[cfg_attr(feature = "v1_18", deprecated = "Since 1.18")]
    #[doc(alias = "ges_container_edit")]
    fn edit(
        &self,
        layers: &[Layer],
        new_layer_priority: i32,
        mode: EditMode,
        edge: Edge,
        position: u64,
    ) -> Result<(), glib::error::BoolError>;

    /// Get the list of timeline elements contained in the container. If
    /// `recursive` is [`true`], and the container contains other containers as
    /// children, then their children will be added to the list, in addition to
    /// themselves, and so on.
    /// ## `recursive`
    /// Whether to recursively get children in `self`
    ///
    /// # Returns
    ///
    /// The list of
    /// [`TimelineElement`][crate::TimelineElement]-s contained in `self`.
    #[doc(alias = "ges_container_get_children")]
    #[doc(alias = "get_children")]
    fn children(&self, recursive: bool) -> Vec<TimelineElement>;

    /// Removes a timeline element from the container. The element will no
    /// longer be controlled by the container.
    /// ## `child`
    /// The child to remove
    ///
    /// # Returns
    ///
    /// [`true`] if `child` was successfully removed from `self`.
    #[doc(alias = "ges_container_remove")]
    fn remove(&self, child: &impl IsA<TimelineElement>) -> Result<(), glib::error::BoolError>;

    /// Ungroups the container by splitting it into several containers
    /// containing various children of the original. The rules for how the
    /// container splits depends on the subclass. A [`Group`][crate::Group] will simply split
    /// into its children. A [`Clip`][crate::Clip] will split into one [`Clip`][crate::Clip] per
    /// [`TrackType`][crate::TrackType] it overlaps with (so an audio-video clip will split into
    /// an audio clip and a video clip), where each clip contains all the
    /// [`TrackElement`][crate::TrackElement]-s from the original clip with a matching
    /// `property::TrackElement::track-type`.
    ///
    /// If `recursive` is [`true`], and the container contains other containers as
    /// children, then they will also be ungrouped, and so on.
    /// ## `recursive`
    /// Whether to recursively ungroup `self`
    ///
    /// # Returns
    ///
    /// The list of
    /// new [`Container`][crate::Container]-s created from the splitting of `self`.
    #[doc(alias = "ges_container_ungroup")]
    fn ungroup(&self, recursive: bool) -> Vec<Container>;

    /// The span of the container's children's `property::TimelineElement::priority`
    /// values, which is the number of integers that lie between (inclusive)
    /// the minimum and maximum priorities found amongst the container's
    /// children (maximum - minimum + 1).
    fn height(&self) -> u32;

    /// Will be emitted after a child is added to the container. Usually,
    /// you should connect with `g_signal_connect_after()` since the signal
    /// may be stopped internally.
    /// ## `element`
    /// The child that was added
    #[doc(alias = "child-added")]
    fn connect_child_added<F: Fn(&Self, &TimelineElement) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;

    /// Will be emitted after a child is removed from the container.
    /// ## `element`
    /// The child that was removed
    #[doc(alias = "child-removed")]
    fn connect_child_removed<F: Fn(&Self, &TimelineElement) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId;

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

impl<O: IsA<Container>> GESContainerExt for O {
    fn add(&self, child: &impl IsA<TimelineElement>) -> Result<(), glib::error::BoolError> {
        unsafe {
            glib::result_from_gboolean!(
                ffi::ges_container_add(
                    self.as_ref().to_glib_none().0,
                    child.as_ref().to_glib_none().0
                ),
                "Failed to add element"
            )
        }
    }

    fn edit(
        &self,
        layers: &[Layer],
        new_layer_priority: i32,
        mode: EditMode,
        edge: Edge,
        position: u64,
    ) -> Result<(), glib::error::BoolError> {
        unsafe {
            glib::result_from_gboolean!(
                ffi::ges_container_edit(
                    self.as_ref().to_glib_none().0,
                    layers.to_glib_none().0,
                    new_layer_priority,
                    mode.into_glib(),
                    edge.into_glib(),
                    position
                ),
                "Failed to edit container"
            )
        }
    }

    fn children(&self, recursive: bool) -> Vec<TimelineElement> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::ges_container_get_children(
                self.as_ref().to_glib_none().0,
                recursive.into_glib(),
            ))
        }
    }

    fn remove(&self, child: &impl IsA<TimelineElement>) -> Result<(), glib::error::BoolError> {
        unsafe {
            glib::result_from_gboolean!(
                ffi::ges_container_remove(
                    self.as_ref().to_glib_none().0,
                    child.as_ref().to_glib_none().0
                ),
                "Failed to remove element"
            )
        }
    }

    fn ungroup(&self, recursive: bool) -> Vec<Container> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::ges_container_ungroup(
                self.as_ref().to_glib_full(),
                recursive.into_glib(),
            ))
        }
    }

    fn height(&self) -> u32 {
        glib::ObjectExt::property(self.as_ref(), "height")
    }

    fn connect_child_added<F: Fn(&Self, &TimelineElement) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn child_added_trampoline<
            P: IsA<Container>,
            F: Fn(&P, &TimelineElement) + 'static,
        >(
            this: *mut ffi::GESContainer,
            element: *mut ffi::GESTimelineElement,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                Container::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(element),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"child-added\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    child_added_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_child_removed<F: Fn(&Self, &TimelineElement) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn child_removed_trampoline<
            P: IsA<Container>,
            F: Fn(&P, &TimelineElement) + 'static,
        >(
            this: *mut ffi::GESContainer,
            element: *mut ffi::GESTimelineElement,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                Container::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(element),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"child-removed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    child_removed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_height_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_height_trampoline<P: IsA<Container>, F: Fn(&P) + 'static>(
            this: *mut ffi::GESContainer,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Container::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::height\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_height_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}