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
// 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::{Extractable, MetaContainer, Source, TimelineElement, TrackElement, VideoSource};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// This won't be used anymore and has been replaced by
    /// `GESUriSource` instead which now plugs an `imagefreeze` element when
    /// `ges_uri_source_asset_is_image` returns [`true`].
    /// Outputs the video stream from a given file as a still frame. The frame chosen
    /// will be determined by the in-point property on the track element. For image
    /// files, do not set the in-point property.
    ///
    /// ## Properties
    ///
    ///
    /// #### `uri`
    ///  The location of the file/resource to use.
    ///
    /// Readable | Writeable | Construct Only
    /// <details><summary><h4>TrackElement</h4></summary>
    ///
    ///
    /// #### `active`
    ///  Whether the effect of the element should be applied in its
    /// [`track`][struct@crate::TrackElement#track]. If set to [`false`], it will not be used in
    /// the output of the track.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `auto-clamp-control-sources`
    ///  Whether the control sources on the element (see
    /// [`TrackElementExt::set_control_source()`][crate::prelude::TrackElementExt::set_control_source()]) will be automatically
    /// updated whenever the [`in-point`][struct@crate::TimelineElement#in-point] or out-point of the
    /// element change in value.
    ///
    /// See [`TrackElementExt::clamp_control_source()`][crate::prelude::TrackElementExt::clamp_control_source()] for how this is done
    /// per control source.
    ///
    /// Default value: [`true`]
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `has-internal-source`
    ///  This property is used to determine whether the 'internal time'
    /// properties of the element have any meaning. In particular, unless
    /// this is set to [`true`], the [`in-point`][struct@crate::TimelineElement#in-point] and
    /// [`max-duration`][struct@crate::TimelineElement#max-duration] can not be set to any value other
    /// than the default 0 and `GST_CLOCK_TIME_NONE`, respectively.
    ///
    /// If an element has some *internal* *timed* source [`gst::Element`][crate::gst::Element] that it
    /// reads stream data from as part of its function in a [`Track`][crate::Track], then
    /// you'll likely want to set this to [`true`] to allow the
    /// [`in-point`][struct@crate::TimelineElement#in-point] and [`max-duration`][struct@crate::TimelineElement#max-duration] to
    /// be set.
    ///
    /// The default value is determined by the `GESTrackElementClass`
    /// `default_has_internal_source` class property. For most
    /// `GESSourceClass`-es, this will be [`true`], with the exception of those
    /// that have a potentially *static* source, such as `GESImageSourceClass`
    /// and `GESTitleSourceClass`. Otherwise, this will usually be [`false`].
    ///
    /// For most [`Operation`][crate::Operation]-s you will likely want to leave this set to
    /// [`false`]. The exception may be for an operation that reads some stream
    /// data from some private internal source as part of manipulating the
    /// input data from the usual linked upstream [`TrackElement`][crate::TrackElement].
    ///
    /// For example, you may want to set this to [`true`] for a
    /// [`TrackType::VIDEO`][crate::TrackType::VIDEO] operation that wraps a `textoverlay` that reads
    /// from a subtitle file and places its text on top of the received video
    /// data. The [`in-point`][struct@crate::TimelineElement#in-point] of the element would be used
    /// to shift the initial seek time on the `textoverlay` away from 0, and
    /// the [`max-duration`][struct@crate::TimelineElement#max-duration] could be set to reflect the
    /// time at which the subtitle file runs out of data.
    ///
    /// Note that GES can not support track elements that have both internal
    /// content and manipulate the timing of their data streams (time
    /// effects).
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `track`
    ///  The track that this element belongs to, or [`None`] if it does not
    /// belong to a track.
    ///
    /// Readable
    ///
    ///
    /// #### `track-type`
    ///  The track type of the element, which determines the type of track the
    /// element can be added to (see [`track-type`][struct@crate::Track#track-type]). This should
    /// correspond to the type of data that the element can produce or
    /// process.
    ///
    /// Readable | Writeable | Construct
    /// </details>
    /// <details><summary><h4>TimelineElement</h4></summary>
    ///
    ///
    /// #### `duration`
    ///  The duration that the element is in effect for in the timeline (a
    /// time difference in nanoseconds using the time coordinates of the
    /// timeline). For example, for a source element, this would determine
    /// for how long it should output its internal content for. For an
    /// operation element, this would determine for how long its effect
    /// should be applied to any source content.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `in-point`
    ///  The initial offset to use internally when outputting content (in
    /// nanoseconds, but in the time coordinates of the internal content).
    ///
    /// For example, for a [`VideoUriSource`][crate::VideoUriSource] that references some media
    /// file, the "internal content" is the media file data, and the
    /// in-point would correspond to some timestamp in the media file.
    /// When playing the timeline, and when the element is first reached at
    /// timeline-time [`start`][struct@crate::TimelineElement#start], it will begin outputting the
    /// data from the timestamp in-point **onwards**, until it reaches the
    /// end of its [`duration`][struct@crate::TimelineElement#duration] in the timeline.
    ///
    /// For elements that have no internal content, this should be kept
    /// as 0.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `max-duration`
    ///  The full duration of internal content that is available (a time
    /// difference in nanoseconds using the time coordinates of the internal
    /// content).
    ///
    /// This will act as a cap on the [`in-point`][struct@crate::TimelineElement#in-point] of the
    /// element (which is in the same time coordinates), and will sometimes
    /// be used to limit the [`duration`][struct@crate::TimelineElement#duration] of the element in
    /// the timeline.
    ///
    /// For example, for a [`VideoUriSource`][crate::VideoUriSource] that references some media
    /// file, this would be the length of the media file.
    ///
    /// For elements that have no internal content, or whose content is
    /// indefinite, this should be kept as `GST_CLOCK_TIME_NONE`.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `name`
    ///  The name of the element. This should be unique within its timeline.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `parent`
    ///  The parent container of the element.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `priority`
    ///  The priority of the element.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `serialize`
    ///  Whether the element should be serialized.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `start`
    ///  The starting position of the element in the timeline (in nanoseconds
    /// and in the time coordinates of the timeline). For example, for a
    /// source element, this would determine the time at which it should
    /// start outputting its internal content. For an operation element, this
    /// would determine the time at which it should start applying its effect
    /// to any source content.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `timeline`
    ///  The timeline that the element lies within.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`ImageSourceExt`][trait@crate::prelude::ImageSourceExt], [`VideoSourceExt`][trait@crate::prelude::VideoSourceExt], [`SourceExt`][trait@crate::prelude::SourceExt], [`TrackElementExt`][trait@crate::prelude::TrackElementExt], [`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 = "GESImageSource")]
    pub struct ImageSource(Object<ffi::GESImageSource, ffi::GESImageSourceClass>) @extends VideoSource, Source, TrackElement, TimelineElement, @implements Extractable, MetaContainer;

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

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

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

/// Trait containing all [`struct@ImageSource`] methods.
///
/// # Implementors
///
/// [`ImageSource`][struct@crate::ImageSource]
pub trait ImageSourceExt: IsA<ImageSource> + sealed::Sealed + 'static {
    /// The location of the file/resource to use.
    fn uri(&self) -> Option<glib::GString> {
        ObjectExt::property(self.as_ref(), "uri")
    }
}

impl<O: IsA<ImageSource>> ImageSourceExt for O {}