File: ges-timeline-element.h

package info (click to toggle)
gstreamer-editing-services1.0 1.14.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 8,388 kB
  • sloc: ansic: 43,396; sh: 4,773; perl: 1,583; makefile: 1,172; python: 581; xml: 80; lex: 44
file content (322 lines) | stat: -rw-r--r-- 13,142 bytes parent folder | download
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
/*
 * gst-editing-services
 * Copyright (C) <2013> Thibault Saunier <thibault.saunier@collabora.com>
 *               <2013> Collabora Ltd.
 *
 * gst-editing-services is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * gst-editing-services is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _GES_TIMELINE_ELEMENT_H_
#define _GES_TIMELINE_ELEMENT_H_

#include <glib-object.h>
#include <gst/gst.h>
#include "ges-enums.h"
#include "ges-types.h"

G_BEGIN_DECLS

#define GES_TYPE_TIMELINE_ELEMENT             (ges_timeline_element_get_type ())
#define GES_TIMELINE_ELEMENT(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GES_TYPE_TIMELINE_ELEMENT, GESTimelineElement))
#define GES_TIMELINE_ELEMENT_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GES_TYPE_TIMELINE_ELEMENT, GESTimelineElementClass))
#define GES_IS_TIMELINE_ELEMENT(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GES_TYPE_TIMELINE_ELEMENT))
#define GES_IS_TIMELINE_ELEMENT_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GES_TYPE_TIMELINE_ELEMENT))
#define GES_TIMELINE_ELEMENT_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TIMELINE_ELEMENT, GESTimelineElementClass))

typedef struct _GESTimelineElementPrivate GESTimelineElementPrivate;

/**
 * GES_TIMELINE_ELEMENT_START:
 * @obj: a #GESTimelineElement
 *
 * The start position of the object (in nanoseconds).
 */
#define GES_TIMELINE_ELEMENT_START(obj) (((GESTimelineElement*)obj)->start)

/**
 * GES_TIMELINE_ELEMENT_END:
 * @obj: a #GESTimelineElement
 *
 * The end position of the object (in nanoseconds).
 */
#define GES_TIMELINE_ELEMENT_END(obj) ((((GESTimelineElement*)obj)->start) + (((GESTimelineElement*)obj)->duration))

/**
 * GES_TIMELINE_ELEMENT_INPOINT:
 * @obj: a #GESTimelineElement
 *
 * The in-point of the object (in nanoseconds).
 */
#define GES_TIMELINE_ELEMENT_INPOINT(obj) (((GESTimelineElement*)obj)->inpoint)

/**
 * GES_TIMELINE_ELEMENT_DURATION:
 * @obj: a #GESTimelineElement
 *
 * The duration of the object (in nanoseconds).
 */
#define GES_TIMELINE_ELEMENT_DURATION(obj) (((GESTimelineElement*)obj)->duration)

/**
 * GES_TIMELINE_ELEMENT_MAX_DURATION:
 * @obj: a #GESTimelineElement
 *
 * The maximun duration of the object (in nanoseconds).
 */
#define GES_TIMELINE_ELEMENT_MAX_DURATION(obj) (((GESTimelineElement*)obj)->maxduration)

/**
 * GES_TIMELINE_ELEMENT_PRIORITY:
 * @obj: a #GESTimelineElement
 *
 * The priority of the object.
 */
#define GES_TIMELINE_ELEMENT_PRIORITY(obj) (((GESTimelineElement*)obj)->priority)

/**
 * GES_TIMELINE_ELEMENT_PARENT:
 * @obj: a #GESTimelineElement
 *
 * The parent of the object.
 */
#define GES_TIMELINE_ELEMENT_PARENT(obj) (((GESTimelineElement*)obj)->parent)

/**
 * GES_TIMELINE_ELEMENT_TIMELINE:
 * @obj: a #GESTimelineElement
 *
 * The timeline in which the object is.
 */
#define GES_TIMELINE_ELEMENT_TIMELINE(obj) (((GESTimelineElement*)obj)->timeline)

/**
 * GES_TIMELINE_ELEMENT_NAME:
 * @obj: a #GESTimelineElement
 *
 * The name of the object.
 */
#define GES_TIMELINE_ELEMENT_NAME(obj) (((GESTimelineElement*)obj)->name)

/**
 * GESTimelineElement:
 * @parent: The #GESTimelineElement that controls the object
 * @asset: The #GESAsset from which the object has been extracted
 * @start: position (in time) of the object
 * @inpoint: Position in the media from which the object should be used
 * @duration: duration of the object to be used
 * @maxduration: The maximum duration the object can have
 * @priority: priority of the object in the layer (0:top priority)
 *
 * Those filed can be accessed from outside but in no case should
 * be changed from there. Subclasses can write them but should make
 * sure to properly call g_object_notify.
 */
struct _GESTimelineElement
{
  GInitiallyUnowned parent_instance;

  /*< public > */
  /*< read only >*/
  GESTimelineElement *parent;
  GESAsset *asset;
  GstClockTime start;
  GstClockTime inpoint;
  GstClockTime duration;
  GstClockTime maxduration;
  guint32 priority;
  GESTimeline *timeline;
  gchar *name;

  /*< private >*/
  GESTimelineElementPrivate *priv;

  /* Padding for API extension */
  gpointer _ges_reserved[GES_PADDING_LARGE];
};

/**
 * GESTimelineElementClass:
 * @set_parent: method to set the parent of a #GESTimelineElement.
 * @set_start: method to set the start of a #GESTimelineElement
 * @set_duration: method to set the duration of a #GESTimelineElement
 * @set_inpoint: method to set the inpoint of a #GESTimelineElement
 * @set_max_duration: method to set the maximun duration of a #GESTimelineElement
 * @set_priority: method to set the priority of a #GESTimelineElement
 * @ripple: method to ripple an object
 * @ripple_end: method to ripple an object on its #GES_EDGE_END edge
 * @roll_start: method to roll an object on its #GES_EDGE_START edge
 * @roll_end: method to roll an object on its #GES_EDGE_END edge
 * @trim: method to trim an object
 * @deep_copy: Copy the children properties of @self into @copy
 *
 * The GESTimelineElement base class. Subclasses should override at least
 * @set_start @set_inpoint @set_duration @ripple @ripple_end @roll_start
 * @roll_end and @trim.
 *
 * Vmethods in subclasses should apply all the operation they need to but
 * the real method implementation is in charge of setting the proper field,
 * and emit the notify signal.
 */
struct _GESTimelineElementClass
{
  GInitiallyUnownedClass parent_class;

  /*< public > */
  gboolean (*set_parent)       (GESTimelineElement * self, GESTimelineElement *parent);
  gboolean (*set_start)        (GESTimelineElement * self, GstClockTime start);
  gboolean (*set_inpoint)      (GESTimelineElement * self, GstClockTime inpoint);
  gboolean (*set_duration)     (GESTimelineElement * self, GstClockTime duration);
  gboolean (*set_max_duration) (GESTimelineElement * self, GstClockTime maxduration);
  gboolean (*set_priority)     (GESTimelineElement * self, guint32 priority); /* set_priority is now protected */

  gboolean (*ripple)           (GESTimelineElement *self, guint64  start);
  gboolean (*ripple_end)       (GESTimelineElement *self, guint64  end);
  gboolean (*roll_start)       (GESTimelineElement *self, guint64  start);
  gboolean (*roll_end)         (GESTimelineElement *self, guint64  end);
  gboolean (*trim)             (GESTimelineElement *self, guint64  start);
  void     (*deep_copy)        (GESTimelineElement *self, GESTimelineElement *copy);

  GESTimelineElement * (*paste) (GESTimelineElement *self,
                                   GESTimelineElement *ref_element,
                                   GstClockTime paste_position);

  GParamSpec** (*list_children_properties) (GESTimelineElement * self, guint *n_properties);
  gboolean (*lookup_child)                 (GESTimelineElement *self, const gchar *prop_name,
                                            GObject **child, GParamSpec **pspec);
  GESTrackType (*get_track_types)          (GESTimelineElement * self);

  /*< private > */
  /* Padding for API extension */
  gpointer _ges_reserved[GES_PADDING_LARGE - 2];
};

GES_API
GType ges_timeline_element_get_type (void) G_GNUC_CONST;

GES_API GESTimelineElement *
ges_timeline_element_get_toplevel_parent             (GESTimelineElement *self);
GES_API
GESTimelineElement * ges_timeline_element_get_parent (GESTimelineElement * self);
GES_API
gboolean ges_timeline_element_set_parent             (GESTimelineElement *self, GESTimelineElement *parent);
GES_API
gboolean ges_timeline_element_set_timeline           (GESTimelineElement *self, GESTimeline *timeline);
GES_API
void ges_timeline_element_set_start                  (GESTimelineElement *self, GstClockTime start);
GES_API
void ges_timeline_element_set_inpoint                (GESTimelineElement *self, GstClockTime inpoint);
GES_API
void ges_timeline_element_set_duration               (GESTimelineElement *self, GstClockTime duration);
GES_API
void ges_timeline_element_set_max_duration           (GESTimelineElement *self, GstClockTime maxduration);
GES_API
void ges_timeline_element_set_priority               (GESTimelineElement *self, guint32 priority);

GES_API
GstClockTime ges_timeline_element_get_start          (GESTimelineElement *self);
GES_API
GstClockTime ges_timeline_element_get_inpoint        (GESTimelineElement *self);
GES_API
GstClockTime ges_timeline_element_get_duration       (GESTimelineElement *self);
GES_API
GstClockTime ges_timeline_element_get_max_duration   (GESTimelineElement *self);
GES_API
GESTimeline * ges_timeline_element_get_timeline      (GESTimelineElement *self);
GES_API
guint32 ges_timeline_element_get_priority            (GESTimelineElement *self);

GES_API
gboolean ges_timeline_element_ripple                 (GESTimelineElement *self, GstClockTime  start);
GES_API
gboolean ges_timeline_element_ripple_end             (GESTimelineElement *self, GstClockTime  end);
GES_API
gboolean ges_timeline_element_roll_start             (GESTimelineElement *self, GstClockTime  start);
GES_API
gboolean ges_timeline_element_roll_end               (GESTimelineElement *self, GstClockTime  end);
GES_API
gboolean ges_timeline_element_trim                   (GESTimelineElement *self, GstClockTime  start);
GES_API
GESTimelineElement * ges_timeline_element_copy       (GESTimelineElement *self, gboolean deep);
GES_API
gchar  * ges_timeline_element_get_name               (GESTimelineElement *self);
GES_API
gboolean  ges_timeline_element_set_name              (GESTimelineElement *self, const gchar *name);
GES_API GParamSpec **
ges_timeline_element_list_children_properties        (GESTimelineElement *self,
                                                      guint *n_properties);

GES_API
gboolean ges_timeline_element_lookup_child           (GESTimelineElement *self,
                                                      const gchar *prop_name,
                                                      GObject  **child,
                                                      GParamSpec **pspec);

GES_API void
ges_timeline_element_get_child_property_by_pspec     (GESTimelineElement * self,
                                                      GParamSpec * pspec,
                                                      GValue * value);

GES_API void
ges_timeline_element_get_child_property_valist       (GESTimelineElement * self,
                                                      const gchar * first_property_name,
                                                      va_list var_args);

GES_API void
ges_timeline_element_get_child_properties           (GESTimelineElement *self,
                                                      const gchar * first_property_name,
                                                      ...) G_GNUC_NULL_TERMINATED;

GES_API void
ges_timeline_element_set_child_property_valist      (GESTimelineElement * self,
                                                     const gchar * first_property_name,
                                                     va_list var_args);

GES_API void
ges_timeline_element_set_child_property_by_pspec    (GESTimelineElement * self,
                                                     GParamSpec * pspec,
                                                     GValue * value);
GES_API
void ges_timeline_element_set_child_properties     (GESTimelineElement * self,
                                                     const gchar * first_property_name,
                                                     ...) G_GNUC_NULL_TERMINATED;

GES_API
gboolean ges_timeline_element_set_child_property   (GESTimelineElement *self,
                                                    const gchar *property_name,
                                                    GValue * value);

GES_API
gboolean ges_timeline_element_get_child_property   (GESTimelineElement *self,
                                                    const gchar *property_name,
                                                    GValue * value);

GES_API
gboolean ges_timeline_element_add_child_property   (GESTimelineElement * self,
                                                    GParamSpec *pspec,
                                                    GObject *child);

GES_API
gboolean ges_timeline_element_remove_child_property(GESTimelineElement * self,
                                                    GParamSpec *pspec);

GES_API
GESTimelineElement * ges_timeline_element_paste    (GESTimelineElement * self,
                                                    GstClockTime paste_position);

GES_API
GESTrackType ges_timeline_element_get_track_types  (GESTimelineElement * self);

G_END_DECLS

#endif /* _GES_TIMELINE_ELEMENT_H_ */