1 /* GStreamer Editing Services
2 * Copyright (C) 2009 Edward Hervey <edward.hervey@collabora.co.uk>
3 * 2009 Nokia Corporation
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * SECTION:ges-timeline
23 * @short_description: Multimedia timeline
25 * #GESTimeline is the central object for any multimedia timeline.
27 * Contains a list of #GESTimelineLayer which users should use to arrange the
28 * various timeline objects through time.
30 * The output type is determined by the #GESTrack that are set on
33 * To save/load a timeline, you can use the ges_timeline_load_from_uri() and
34 * ges_timeline_save_to_uri() methods to use the default format. If you wish
35 * to specify the format to save/load the timeline from, please consult the
36 * documentation about #GESFormatter.
39 #include "gesmarshal.h"
40 #include "ges-internal.h"
41 #include "ges-timeline.h"
42 #include "ges-track.h"
43 #include "ges-timeline-layer.h"
46 static void track_duration_cb (GstElement * track,
47 GParamSpec * arg G_GNUC_UNUSED, GESTimeline * timeline);
49 G_DEFINE_TYPE (GESTimeline, ges_timeline, GST_TYPE_BIN);
51 #define GES_TIMELINE_PENDINGOBJS_GET_LOCK(timeline) \
52 (GES_TIMELINE(timeline)->priv->pendingobjects_lock)
53 #define GES_TIMELINE_PENDINGOBJS_LOCK(timeline) \
54 (g_mutex_lock(GES_TIMELINE_PENDINGOBJS_GET_LOCK (timeline)))
55 #define GES_TIMELINE_PENDINGOBJS_UNLOCK(timeline) \
56 (g_mutex_unlock(GES_TIMELINE_PENDINGOBJS_GET_LOCK (timeline)))
58 struct _GESTimelinePrivate
60 GList *layers; /* A list of GESTimelineLayer sorted by priority */
61 GList *tracks; /* A list of private track data */
63 /* The duration of the timeline */
66 /* discoverer used for virgin sources */
67 GstDiscoverer *discoverer;
68 GList *pendingobjects;
69 /* lock to avoid discovery of objects that will be removed */
70 GMutex *pendingobjects_lock;
72 /* Whether we are changing state asynchronously or not */
73 gboolean async_pending;
76 /* private structure to contain our track-related information */
80 GESTimeline *timeline;
82 GstPad *pad; /* Pad from the track */
93 static GParamSpec *properties[PROP_LAST];
105 static GstBinClass *parent_class;
107 static guint ges_timeline_signals[LAST_SIGNAL] = { 0 };
109 static gint custom_find_track (TrackPrivate * tr_priv, GESTrack * track);
110 static GstStateChangeReturn
111 ges_timeline_change_state (GstElement * element, GstStateChange transition);
113 discoverer_finished_cb (GstDiscoverer * discoverer, GESTimeline * timeline);
115 discoverer_discovered_cb (GstDiscoverer * discoverer,
116 GstDiscovererInfo * info, GError * err, GESTimeline * timeline);
118 void look_for_transition (GESTrackObject * track_object,
119 GESTimelineLayer * layer);
120 void track_object_removed_cb (GESTrack * track, GESTrackObject * track_object,
121 GESTimeline * timeline);
124 ges_timeline_get_property (GObject * object, guint property_id,
125 GValue * value, GParamSpec * pspec)
127 GESTimeline *timeline = GES_TIMELINE (object);
129 switch (property_id) {
131 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
133 g_value_set_uint64 (value, timeline->priv->duration);
139 ges_timeline_set_property (GObject * object, guint property_id,
140 const GValue * value, GParamSpec * pspec)
142 switch (property_id) {
144 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
149 ges_timeline_dispose (GObject * object)
151 GESTimelinePrivate *priv = GES_TIMELINE (object)->priv;
153 if (priv->discoverer) {
154 gst_discoverer_stop (priv->discoverer);
155 g_object_unref (priv->discoverer);
156 priv->discoverer = NULL;
159 while (priv->layers) {
160 GESTimelineLayer *layer = (GESTimelineLayer *) priv->layers->data;
161 ges_timeline_remove_layer (GES_TIMELINE (object), layer);
164 /* FIXME: it should be possible to remove tracks before removing
165 * layers, but at the moment this creates a problem because the track
166 * objects aren't notified that their gnlobjects have been destroyed.
169 while (priv->tracks) {
170 TrackPrivate *tr_priv = (TrackPrivate *) priv->tracks->data;
171 ges_timeline_remove_track (GES_TIMELINE (object), tr_priv->track);
174 G_OBJECT_CLASS (ges_timeline_parent_class)->dispose (object);
178 ges_timeline_finalize (GObject * object)
180 GESTimeline *timeline = GES_TIMELINE (object);
182 g_mutex_free (timeline->priv->pendingobjects_lock);
184 G_OBJECT_CLASS (ges_timeline_parent_class)->finalize (object);
188 ges_timeline_class_init (GESTimelineClass * klass)
190 GObjectClass *object_class = G_OBJECT_CLASS (klass);
191 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
193 g_type_class_add_private (klass, sizeof (GESTimelinePrivate));
195 parent_class = g_type_class_peek_parent (klass);
197 element_class->change_state = ges_timeline_change_state;
199 object_class->get_property = ges_timeline_get_property;
200 object_class->set_property = ges_timeline_set_property;
201 object_class->dispose = ges_timeline_dispose;
202 object_class->finalize = ges_timeline_finalize;
205 * GESTimelineObject:duration
207 * Current duration (in nanoseconds) of the #GESTimeline
211 properties[PROP_DURATION] =
212 g_param_spec_uint64 ("duration", "Duration",
213 "The duration of the timeline", 0, G_MAXUINT64,
214 GST_CLOCK_TIME_NONE, G_PARAM_READABLE);
215 g_object_class_install_property (object_class, PROP_DURATION,
216 properties[PROP_DURATION]);
219 * GESTimeline::track-added
220 * @timeline: the #GESTimeline
221 * @track: the #GESTrack that was added to the timeline
223 * Will be emitted after the track was added to the timeline.
225 ges_timeline_signals[TRACK_ADDED] =
226 g_signal_new ("track-added", G_TYPE_FROM_CLASS (klass),
227 G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESTimelineClass, track_added), NULL,
228 NULL, ges_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GES_TYPE_TRACK);
231 * GESTimeline::track-removed
232 * @timeline: the #GESTimeline
233 * @track: the #GESTrack that was removed from the timeline
235 * Will be emitted after the track was removed from the timeline.
237 ges_timeline_signals[TRACK_REMOVED] =
238 g_signal_new ("track-removed", G_TYPE_FROM_CLASS (klass),
239 G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESTimelineClass, track_removed),
240 NULL, NULL, ges_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GES_TYPE_TRACK);
243 * GESTimeline::layer-added
244 * @timeline: the #GESTimeline
245 * @layer: the #GESTimelineLayer that was added to the timeline
247 * Will be emitted after the layer was added to the timeline.
249 ges_timeline_signals[LAYER_ADDED] =
250 g_signal_new ("layer-added", G_TYPE_FROM_CLASS (klass),
251 G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESTimelineClass, layer_added), NULL,
252 NULL, ges_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GES_TYPE_TIMELINE_LAYER);
255 * GESTimeline::layer-removed
256 * @timeline: the #GESTimeline
257 * @layer: the #GESTimelineLayer that was removed from the timeline
259 * Will be emitted after the layer was removed from the timeline.
261 ges_timeline_signals[LAYER_REMOVED] =
262 g_signal_new ("layer-removed", G_TYPE_FROM_CLASS (klass),
263 G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESTimelineClass, layer_removed),
264 NULL, NULL, ges_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
265 GES_TYPE_TIMELINE_LAYER);
268 * GESTimeline::discovery-error:
269 * @formatter: the #GESFormatter
270 * @source: The #GESTimelineFileSource that could not be discovered properly
271 * @error: (type GLib.Error): #GError, which will be non-NULL if an error
272 * occurred during discovery
274 ges_timeline_signals[DISCOVERY_ERROR] =
275 g_signal_new ("discovery-error", G_TYPE_FROM_CLASS (klass),
276 G_SIGNAL_RUN_FIRST, 0, NULL, NULL, gst_marshal_VOID__OBJECT_BOXED,
277 G_TYPE_NONE, 2, GES_TYPE_TIMELINE_FILE_SOURCE, GST_TYPE_G_ERROR);
281 ges_timeline_init (GESTimeline * self)
284 self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
285 GES_TYPE_TIMELINE, GESTimelinePrivate);
287 self->priv->layers = NULL;
288 self->priv->tracks = NULL;
289 self->priv->duration = 0;
291 self->priv->pendingobjects_lock = g_mutex_new ();
292 /* New discoverer with a 15s timeout */
293 self->priv->discoverer = gst_discoverer_new (15 * GST_SECOND, NULL);
294 g_signal_connect (self->priv->discoverer, "finished",
295 G_CALLBACK (discoverer_finished_cb), self);
296 g_signal_connect (self->priv->discoverer, "discovered",
297 G_CALLBACK (discoverer_discovered_cb), self);
298 gst_discoverer_start (self->priv->discoverer);
302 sort_layers (gpointer a, gpointer b)
304 GESTimelineLayer *layer_a, *layer_b;
305 guint prio_a, prio_b;
307 layer_a = GES_TIMELINE_LAYER (a);
308 layer_b = GES_TIMELINE_LAYER (b);
310 prio_a = ges_timeline_layer_get_priority (layer_a);
311 prio_b = ges_timeline_layer_get_priority (layer_b);
313 if ((gint) prio_a > (guint) prio_b)
315 if ((guint) prio_a < (guint) prio_b)
324 * Creates a new empty #GESTimeline.
326 * Returns: The new timeline.
330 ges_timeline_new (void)
332 return g_object_new (GES_TYPE_TIMELINE, NULL);
336 * ges_timeline_new_from_uri:
337 * @uri: the URI to load from
339 * Creates a timeline from the given URI.
341 * Returns: A new timeline if the uri was loaded successfully, or NULL if the
342 * uri could not be loaded
346 ges_timeline_new_from_uri (const gchar * uri)
350 /* FIXME : we should have a GError** argument so the user can know why
351 * it wasn't able to load the uri
354 ret = ges_timeline_new ();
356 if (!ges_timeline_load_from_uri (ret, uri)) {
357 g_object_unref (ret);
366 * ges_timeline_load_from_uri:
367 * @timeline: an empty #GESTimeline into which to load the formatter
368 * @uri: The URI to load from
370 * Loads the contents of URI into the given timeline.
372 * Returns: TRUE if the timeline was loaded successfully, or FALSE if the uri
373 * could not be loaded.
377 ges_timeline_load_from_uri (GESTimeline * timeline, const gchar * uri)
379 GESFormatter *p = NULL;
380 gboolean ret = FALSE;
382 /* FIXME : we should have a GError** argument so the user can know why
383 * it wasn't able to load the uri
386 if (!(p = ges_formatter_new_for_uri (uri))) {
387 GST_ERROR ("unsupported uri '%s'", uri);
391 if (!ges_formatter_load_from_uri (p, timeline, uri)) {
392 GST_ERROR ("error deserializing formatter");
405 * ges_timeline_save_to_uri:
406 * @timeline: a #GESTimeline
407 * @uri: The location to save to
409 * Saves the timeline to the given location
411 * Returns: TRUE if the timeline was successfully saved to the given location,
416 ges_timeline_save_to_uri (GESTimeline * timeline, const gchar * uri)
418 GESFormatter *p = NULL;
419 gboolean ret = FALSE;
421 /* FIXME : How will the user be able to chose the format he
422 * wishes to store to ? */
424 /* FIXME : How will we ensure a timeline loaded with a certain format
425 * will be saved with the same one by default ? We need to make this
426 * easy from an API perspective */
428 /* FIXME : we should have a GError** argument so the user can know why
429 * it wasn't able to save
432 if (!(p = ges_formatter_new_for_uri (uri))) {
433 GST_ERROR ("unsupported uri '%s'", uri);
437 if (!ges_formatter_save_to_uri (p, timeline, uri)) {
438 GST_ERROR ("error serializing formatter");
451 add_object_to_track (GESTimelineObject * object, GESTrack * track)
453 if (!ges_timeline_object_create_track_objects (object, track)) {
454 GST_WARNING ("error creating track objects");
459 add_object_to_tracks (GESTimeline * timeline, GESTimelineObject * object)
463 for (tmp = timeline->priv->tracks; tmp; tmp = g_list_next (tmp)) {
464 TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
465 GESTrack *track = tr_priv->track;
467 GST_LOG ("Trying with track %p", track);
468 add_object_to_track (object, track);
474 do_async_start (GESTimeline * timeline)
479 timeline->priv->async_pending = TRUE;
481 /* Freeze state of tracks */
482 for (tmp = timeline->priv->tracks; tmp; tmp = tmp->next) {
483 TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
484 gst_element_set_locked_state ((GstElement *) tr_priv->track, TRUE);
487 message = gst_message_new_async_start (GST_OBJECT_CAST (timeline), FALSE);
488 parent_class->handle_message (GST_BIN_CAST (timeline), message);
492 do_async_done (GESTimeline * timeline)
496 if (timeline->priv->async_pending) {
498 /* Unfreeze state of tracks */
499 for (tmp = timeline->priv->tracks; tmp; tmp = tmp->next) {
500 TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
501 gst_element_set_locked_state ((GstElement *) tr_priv->track, FALSE);
502 gst_element_sync_state_with_parent ((GstElement *) tr_priv->track);
505 GST_DEBUG_OBJECT (timeline, "Emitting async-done");
506 message = gst_message_new_async_done (GST_OBJECT_CAST (timeline));
507 parent_class->handle_message (GST_BIN_CAST (timeline), message);
509 timeline->priv->async_pending = FALSE;
514 discoverer_finished_cb (GstDiscoverer * discoverer, GESTimeline * timeline)
516 do_async_done (timeline);
520 discoverer_discovered_cb (GstDiscoverer * discoverer,
521 GstDiscovererInfo * info, GError * err, GESTimeline * timeline)
525 GESTrackType tfs_supportedformats;
527 gboolean found = FALSE;
528 gboolean is_image = FALSE;
529 GESTimelineFileSource *tfs = NULL;
530 GESTimelinePrivate *priv = timeline->priv;
531 const gchar *uri = gst_discoverer_info_get_uri (info);
533 GES_TIMELINE_PENDINGOBJS_LOCK (timeline);
535 /* Find corresponding TimelineFileSource in the sources */
536 for (tmp = priv->pendingobjects; tmp; tmp = tmp->next) {
537 tfs = (GESTimelineFileSource *) tmp->data;
539 if (!g_strcmp0 (ges_timeline_filesource_get_uri (tfs), uri)) {
546 GST_WARNING ("Discovered %s, that seems not to be in the list of sources"
548 GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
553 GError *propagate_error = NULL;
555 priv->pendingobjects = g_list_delete_link (priv->pendingobjects, tmp);
556 GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
557 GST_WARNING ("Error while discovering %s: %s", uri, err->message);
559 g_propagate_error (&propagate_error, err);
560 g_signal_emit (timeline, ges_timeline_signals[DISCOVERY_ERROR], 0, tfs,
566 /* Everything went fine... let's do our job! */
567 GST_DEBUG ("Discovered uri %s", uri);
569 /* The timeline file source will be updated with discovered information
570 * so it needs to not be finalized during this process */
573 /* Remove object from list */
574 priv->pendingobjects = g_list_delete_link (priv->pendingobjects, tmp);
575 GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
577 /* FIXME : Handle errors in discovery */
578 stream_list = gst_discoverer_info_get_stream_list (info);
580 tfs_supportedformats = ges_timeline_filesource_get_supported_formats (tfs);
581 if (tfs_supportedformats != GES_TRACK_TYPE_UNKNOWN)
584 /* Update timelinefilesource properties based on info */
585 for (tmp = stream_list; tmp; tmp = tmp->next) {
586 GstDiscovererStreamInfo *sinf = (GstDiscovererStreamInfo *) tmp->data;
588 if (GST_IS_DISCOVERER_AUDIO_INFO (sinf)) {
589 tfs_supportedformats |= GES_TRACK_TYPE_AUDIO;
590 ges_timeline_filesource_set_supported_formats (tfs, tfs_supportedformats);
591 } else if (GST_IS_DISCOVERER_VIDEO_INFO (sinf)) {
592 tfs_supportedformats |= GES_TRACK_TYPE_VIDEO;
593 ges_timeline_filesource_set_supported_formats (tfs, tfs_supportedformats);
594 if (gst_discoverer_video_info_is_image ((GstDiscovererVideoInfo *)
596 tfs_supportedformats |= GES_TRACK_TYPE_AUDIO;
597 ges_timeline_filesource_set_supported_formats (tfs,
598 tfs_supportedformats);
605 gst_discoverer_stream_info_list_free (stream_list);
610 /* don't set max-duration on still images */
611 g_object_set (tfs, "is_image", (gboolean) TRUE, NULL);
614 /* Continue the processing on tfs */
615 add_object_to_tracks (timeline, GES_TIMELINE_OBJECT (tfs));
618 g_object_set (tfs, "max-duration",
619 gst_discoverer_info_get_duration (info), NULL);
622 /* Remove the ref as the timeline file source is no longer needed here */
623 g_object_unref (tfs);
626 static GstStateChangeReturn
627 ges_timeline_change_state (GstElement * element, GstStateChange transition)
629 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
630 GESTimeline *timeline = GES_TIMELINE (element);
632 switch (transition) {
633 case GST_STATE_CHANGE_READY_TO_PAUSED:
634 GES_TIMELINE_PENDINGOBJS_LOCK (timeline);
635 if (timeline->priv->pendingobjects) {
636 GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
637 do_async_start (timeline);
638 ret = GST_STATE_CHANGE_ASYNC;
640 GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
648 GstStateChangeReturn bret;
650 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
651 if (G_UNLIKELY (bret == GST_STATE_CHANGE_NO_PREROLL)) {
652 do_async_done (timeline);
657 switch (transition) {
658 case GST_STATE_CHANGE_PAUSED_TO_READY:
659 do_async_done (timeline);
670 layer_object_added_cb (GESTimelineLayer * layer, GESTimelineObject * object,
671 GESTimeline * timeline)
673 if (ges_timeline_object_is_moving_from_layer (object)) {
674 GST_DEBUG ("TimelineObject %p is moving from a layer to another, not doing"
675 " anything on it", object);
679 GST_DEBUG ("New TimelineObject %p added to layer %p", object, layer);
681 if (GES_IS_TIMELINE_FILE_SOURCE (object)) {
682 GESTimelineFileSource *tfs = GES_TIMELINE_FILE_SOURCE (object);
683 GESTrackType tfs_supportedformats =
684 ges_timeline_filesource_get_supported_formats (tfs);
685 guint64 tfs_maxdur = ges_timeline_filesource_get_max_duration (tfs);
686 const gchar *tfs_uri;
688 /* Send the filesource to the discoverer if:
689 * * it doesn't have specified supported formats
690 * * OR it doesn't have a specified max-duration
691 * * OR it doesn't have a valid duration */
693 if (tfs_supportedformats == GES_TRACK_TYPE_UNKNOWN ||
694 tfs_maxdur == GST_CLOCK_TIME_NONE || object->duration == 0) {
695 GST_LOG ("Incomplete TimelineFileSource, discovering it");
696 tfs_uri = ges_timeline_filesource_get_uri (tfs);
698 GES_TIMELINE_PENDINGOBJS_LOCK (timeline);
699 timeline->priv->pendingobjects =
700 g_list_append (timeline->priv->pendingobjects, object);
701 GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
703 gst_discoverer_discover_uri_async (timeline->priv->discoverer, tfs_uri);
705 add_object_to_tracks (timeline, object);
707 add_object_to_tracks (timeline, object);
714 layer_priority_changed_cb (GESTimelineLayer * layer,
715 GParamSpec * arg G_GNUC_UNUSED, GESTimeline * timeline)
717 timeline->priv->layers = g_list_sort (timeline->priv->layers, (GCompareFunc)
722 layer_object_removed_cb (GESTimelineLayer * layer, GESTimelineObject * object,
723 GESTimeline * timeline)
725 GList *trackobjects, *tmp;
727 if (ges_timeline_object_is_moving_from_layer (object)) {
728 GST_DEBUG ("TimelineObject %p is moving from a layer to another, not doing"
729 " anything on it", object);
733 GST_DEBUG ("TimelineObject %p removed from layer %p", object, layer);
735 /* Go over the object's track objects and figure out which one belongs to
736 * the list of tracks we control */
738 trackobjects = ges_timeline_object_get_track_objects (object);
739 for (tmp = trackobjects; tmp; tmp = tmp->next) {
740 GESTrackObject *trobj = (GESTrackObject *) tmp->data;
742 GST_DEBUG ("Trying to remove TrackObject %p", trobj);
743 if (G_LIKELY (g_list_find_custom (timeline->priv->tracks,
744 ges_track_object_get_track (trobj),
745 (GCompareFunc) custom_find_track))) {
746 GST_DEBUG ("Belongs to one of the tracks we control");
747 ges_track_remove_object (ges_track_object_get_track (trobj), trobj);
749 ges_timeline_object_release_track_object (object, trobj);
751 /* removing the reference added by _get_track_objects() */
752 g_object_unref (trobj);
755 g_list_free (trackobjects);
757 /* if the object is a timeline file source that has not yet been discovered,
758 * it no longer needs to be discovered so remove it from the pendingobjects
759 * list if it belongs to this layer */
760 if (GES_IS_TIMELINE_FILE_SOURCE (object)) {
761 GES_TIMELINE_PENDINGOBJS_LOCK (timeline);
762 timeline->priv->pendingobjects =
763 g_list_remove_all (timeline->priv->pendingobjects, object);
764 GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
771 * ges_timeline_append_layer:
772 * @timeline: a #GESTimeline
773 * @layer: the #GESTimelineLayer to add
775 * Convenience method to append @layer to @timeline which means that the
776 * priority of @layer is changed to correspond to the last layer of @timeline.
777 * The reference to the @layer will be stolen by @timeline.
779 * Returns: TRUE if the layer was properly added, else FALSE.
782 ges_timeline_append_layer (GESTimeline * timeline, GESTimelineLayer * layer)
785 GESTimelinePrivate *priv = timeline->priv;
787 GST_DEBUG ("Appending layer to layer:%p, timeline:%p", timeline, layer);
788 priority = g_list_length (priv->layers);
790 ges_timeline_layer_set_priority (layer, priority);
792 return ges_timeline_add_layer (timeline, layer);
796 * ges_timeline_add_layer:
797 * @timeline: a #GESTimeline
798 * @layer: the #GESTimelineLayer to add
800 * Add the layer to the timeline. The reference to the @layer will be stolen
803 * Returns: TRUE if the layer was properly added, else FALSE.
806 ges_timeline_add_layer (GESTimeline * timeline, GESTimelineLayer * layer)
808 GList *objects, *tmp;
809 GESTimelinePrivate *priv = timeline->priv;
811 GST_DEBUG ("timeline:%p, layer:%p", timeline, layer);
813 /* We can only add a layer that doesn't already belong to another timeline */
814 if (G_UNLIKELY (layer->timeline)) {
815 GST_WARNING ("Layer belongs to another timeline, can't add it");
819 /* Add to the list of layers, make sure we don't already control it */
820 if (G_UNLIKELY (g_list_find (priv->layers, (gconstpointer) layer))) {
821 GST_WARNING ("Layer is already controlled by this timeline");
825 g_object_ref_sink (layer);
826 priv->layers = g_list_insert_sorted (priv->layers, layer,
827 (GCompareFunc) sort_layers);
829 /* Inform the layer that it belongs to a new timeline */
830 ges_timeline_layer_set_timeline (layer, timeline);
832 /* Connect to 'object-added'/'object-removed' signal from the new layer */
833 g_signal_connect (layer, "object-added", G_CALLBACK (layer_object_added_cb),
835 g_signal_connect (layer, "object-removed",
836 G_CALLBACK (layer_object_removed_cb), timeline);
837 g_signal_connect (layer, "notify::priority",
838 G_CALLBACK (layer_priority_changed_cb), timeline);
840 GST_DEBUG ("Done adding layer, emitting 'layer-added' signal");
841 g_signal_emit (timeline, ges_timeline_signals[LAYER_ADDED], 0, layer);
843 /* add any existing timeline objects to the timeline */
844 objects = ges_timeline_layer_get_objects (layer);
845 for (tmp = objects; tmp; tmp = tmp->next) {
846 layer_object_added_cb (layer, tmp->data, timeline);
847 g_object_unref (tmp->data);
850 g_list_free (objects);
856 * ges_timeline_remove_layer:
857 * @timeline: a #GESTimeline
858 * @layer: the #GESTimelineLayer to remove
860 * Removes the layer from the timeline. The reference that the @timeline holds on
861 * the layer will be dropped. If you wish to use the @layer after calling this
862 * method, you need to take a reference before calling.
864 * Returns: TRUE if the layer was properly removed, else FALSE.
868 ges_timeline_remove_layer (GESTimeline * timeline, GESTimelineLayer * layer)
870 GList *layer_objects, *tmp;
871 GESTimelinePrivate *priv = timeline->priv;
873 GST_DEBUG ("timeline:%p, layer:%p", timeline, layer);
875 if (G_UNLIKELY (!g_list_find (priv->layers, layer))) {
876 GST_WARNING ("Layer doesn't belong to this timeline");
880 /* remove objects from any private data structures */
882 layer_objects = ges_timeline_layer_get_objects (layer);
883 for (tmp = layer_objects; tmp; tmp = tmp->next) {
884 layer_object_removed_cb (layer, GES_TIMELINE_OBJECT (tmp->data), timeline);
885 g_object_unref (G_OBJECT (tmp->data));
888 g_list_free (layer_objects);
890 /* Disconnect signals */
891 GST_DEBUG ("Disconnecting signal callbacks");
892 g_signal_handlers_disconnect_by_func (layer, layer_object_added_cb, timeline);
893 g_signal_handlers_disconnect_by_func (layer, layer_object_removed_cb,
896 priv->layers = g_list_remove (priv->layers, layer);
898 ges_timeline_layer_set_timeline (layer, NULL);
900 g_signal_emit (timeline, ges_timeline_signals[LAYER_REMOVED], 0, layer);
902 g_object_unref (layer);
908 pad_added_cb (GESTrack * track, GstPad * pad, TrackPrivate * tr_priv)
913 GST_DEBUG ("track:%p, pad:%s:%s", track, GST_DEBUG_PAD_NAME (pad));
915 if (G_UNLIKELY (tr_priv->pad)) {
916 GST_WARNING ("We are already controlling a pad for this track");
920 /* Remember the pad */
924 GST_DEBUG ("Ghosting pad and adding it to ourself");
925 padname = g_strdup_printf ("track_%p_src", track);
926 tr_priv->ghostpad = gst_ghost_pad_new (padname, pad);
928 gst_pad_set_active (tr_priv->ghostpad, TRUE);
929 gst_element_add_pad (GST_ELEMENT (tr_priv->timeline), tr_priv->ghostpad);
933 pad_removed_cb (GESTrack * track, GstPad * pad, TrackPrivate * tr_priv)
935 GST_DEBUG ("track:%p, pad:%s:%s", track, GST_DEBUG_PAD_NAME (pad));
937 if (G_UNLIKELY (tr_priv->pad != pad)) {
938 GST_WARNING ("Not the pad we're controlling");
942 if (G_UNLIKELY (tr_priv->ghostpad == NULL)) {
943 GST_WARNING ("We don't have a ghostpad for this pad !");
947 GST_DEBUG ("Removing ghostpad");
948 gst_pad_set_active (tr_priv->ghostpad, FALSE);
949 gst_element_remove_pad (GST_ELEMENT (tr_priv->timeline), tr_priv->ghostpad);
950 tr_priv->ghostpad = NULL;
955 custom_find_track (TrackPrivate * tr_priv, GESTrack * track)
957 if (tr_priv->track == track)
963 * ges_timeline_add_track:
964 * @timeline: a #GESTimeline
965 * @track: the #GESTrack to add
967 * Add a track to the timeline. The reference to the track will be stolen by the
970 * Returns: TRUE if the track was properly added, else FALSE.
973 /* FIXME: create track objects for timeline objects which have already been
974 * added to existing layers.
978 ges_timeline_add_track (GESTimeline * timeline, GESTrack * track)
980 TrackPrivate *tr_priv;
981 GESTimelinePrivate *priv = timeline->priv;
984 GST_DEBUG ("timeline:%p, track:%p", timeline, track);
986 /* make sure we don't already control it */
987 if (G_UNLIKELY (g_list_find_custom (priv->tracks, (gconstpointer) track,
988 (GCompareFunc) custom_find_track))) {
989 GST_WARNING ("Track is already controlled by this timeline");
993 /* Add the track to ourself (as a GstBin)
994 * Reference is stolen ! */
995 if (G_UNLIKELY (!gst_bin_add (GST_BIN (timeline), GST_ELEMENT (track)))) {
996 GST_WARNING ("Couldn't add track to ourself (GST)");
1000 tr_priv = g_new0 (TrackPrivate, 1);
1001 tr_priv->timeline = timeline;
1002 tr_priv->track = track;
1004 /* Add the track to the list of tracks we track */
1005 priv->tracks = g_list_append (priv->tracks, tr_priv);
1007 /* Listen to pad-added/-removed */
1008 g_signal_connect (track, "pad-added", (GCallback) pad_added_cb, tr_priv);
1009 g_signal_connect (track, "pad-removed", (GCallback) pad_removed_cb, tr_priv);
1011 /* Inform the track that it's currently being used by ourself */
1012 ges_track_set_timeline (track, timeline);
1014 GST_DEBUG ("Done adding track, emitting 'track-added' signal");
1016 /* emit 'track-added' */
1017 g_signal_emit (timeline, ges_timeline_signals[TRACK_ADDED], 0, track);
1019 /* ensure that each existing timeline object has the opportunity to create a
1020 * track object for this track*/
1022 for (tmp = priv->layers; tmp; tmp = tmp->next) {
1023 GList *objects, *obj;
1024 objects = ges_timeline_layer_get_objects (tmp->data);
1026 for (obj = objects; obj; obj = obj->next) {
1027 add_object_to_track (obj->data, track);
1028 g_object_unref (obj->data);
1031 g_list_free (objects);
1034 /* We connect to the duration change notify, so we can update
1035 * our duration accordingly */
1036 g_signal_connect (G_OBJECT (track), "notify::duration",
1037 G_CALLBACK (track_duration_cb), timeline);
1038 track_duration_cb (GST_ELEMENT (track), NULL, timeline);
1044 * ges_timeline_remove_track:
1045 * @timeline: a #GESTimeline
1046 * @track: the #GESTrack to remove
1048 * Remove the @track from the @timeline. The reference stolen when adding the
1049 * @track will be removed. If you wish to use the @track after calling this
1050 * function you must ensure that you have a reference to it.
1052 * Returns: TRUE if the @track was properly removed, else FALSE.
1055 /* FIXME: release any track objects associated with this layer. currenly this
1056 * will not happen if you remove the track before removing *all*
1057 * timelineobjects which have a track object in this track.
1061 ges_timeline_remove_track (GESTimeline * timeline, GESTrack * track)
1064 TrackPrivate *tr_priv;
1065 GESTimelinePrivate *priv = timeline->priv;
1067 GST_DEBUG ("timeline:%p, track:%p", timeline, track);
1069 if (G_UNLIKELY (!(tmp =
1070 g_list_find_custom (priv->tracks, (gconstpointer) track,
1071 (GCompareFunc) custom_find_track)))) {
1072 GST_WARNING ("Track doesn't belong to this timeline");
1076 tr_priv = tmp->data;
1077 priv->tracks = g_list_remove (priv->tracks, tr_priv);
1079 ges_track_set_timeline (track, NULL);
1081 /* Remove ghost pad */
1082 if (tr_priv->ghostpad) {
1083 GST_DEBUG ("Removing ghostpad");
1084 gst_pad_set_active (tr_priv->ghostpad, FALSE);
1085 gst_ghost_pad_set_target ((GstGhostPad *) tr_priv->ghostpad, NULL);
1086 gst_element_remove_pad (GST_ELEMENT (timeline), tr_priv->ghostpad);
1089 /* Remove pad-added/-removed handlers */
1090 g_signal_handlers_disconnect_by_func (track, pad_added_cb, tr_priv);
1091 g_signal_handlers_disconnect_by_func (track, pad_removed_cb, tr_priv);
1092 g_signal_handlers_disconnect_by_func (track, track_duration_cb,
1095 /* Signal track removal to all layers/objects */
1096 g_signal_emit (timeline, ges_timeline_signals[TRACK_REMOVED], 0, track);
1098 /* remove track from our bin */
1099 gst_object_ref (track);
1100 if (G_UNLIKELY (!gst_bin_remove (GST_BIN (timeline), GST_ELEMENT (track)))) {
1101 GST_WARNING ("Couldn't remove track to ourself (GST)");
1102 gst_object_unref (track);
1106 /* set track state to NULL */
1108 gst_element_set_state (GST_ELEMENT (track), GST_STATE_NULL);
1110 gst_object_unref (track);
1118 * ges_timeline_get_track_for_pad:
1119 * @timeline: The #GESTimeline
1122 * Search the #GESTrack corresponding to the given @timeline's @pad.
1124 * Returns: (transfer none): The corresponding #GESTrack if it is found,
1125 * or %NULL if there is an error.
1129 ges_timeline_get_track_for_pad (GESTimeline * timeline, GstPad * pad)
1133 for (tmp = timeline->priv->tracks; tmp; tmp = g_list_next (tmp)) {
1134 TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
1135 if (pad == tr_priv->ghostpad)
1136 return tr_priv->track;
1143 * ges_timeline_get_tracks:
1144 * @timeline: a #GESTimeline
1146 * Returns the list of #GESTrack used by the Timeline.
1148 * Returns: (transfer full) (element-type GESTrack): A list of #GESTrack.
1149 * The caller should unref each track once he is done with them.
1152 ges_timeline_get_tracks (GESTimeline * timeline)
1154 GList *tmp, *res = NULL;
1156 for (tmp = timeline->priv->tracks; tmp; tmp = g_list_next (tmp)) {
1157 TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
1158 res = g_list_append (res, g_object_ref (tr_priv->track));
1165 * ges_timeline_get_layers:
1166 * @timeline: a #GESTimeline
1168 * Get the list of #GESTimelineLayer present in the Timeline.
1170 * Returns: (transfer full) (element-type GESTimelineLayer): the list of
1171 * #GESTimelineLayer present in the Timeline sorted by priority.
1172 * The caller should unref each Layer once he is done with them.
1175 ges_timeline_get_layers (GESTimeline * timeline)
1177 GList *tmp, *res = NULL;
1179 for (tmp = timeline->priv->layers; tmp; tmp = g_list_next (tmp)) {
1180 res = g_list_insert_sorted (res, g_object_ref (tmp->data),
1181 (GCompareFunc) sort_layers);
1188 * ges_timeline_enable_update:
1189 * @timeline: a #GESTimeline
1190 * @enabled: TRUE if the timeline must be updated, FALSE otherwise.
1192 * Calls the enable_update function of the tracks contained by the timeline.
1194 * Returns: True if success, FALSE otherwise.
1197 ges_timeline_enable_update (GESTimeline * timeline, gboolean enabled)
1199 GList *tmp, *tracks;
1200 gboolean res = TRUE;
1202 GST_DEBUG_OBJECT (timeline, "%s updates", enabled ? "Enabling" : "Disabling");
1204 tracks = ges_timeline_get_tracks (timeline);
1206 for (tmp = tracks; tmp; tmp = tmp->next) {
1207 if (!ges_track_enable_update (tmp->data, enabled)) {
1212 g_list_free (tracks);
1218 track_duration_cb (GstElement * track,
1219 GParamSpec * arg G_GNUC_UNUSED, GESTimeline * timeline)
1221 guint64 duration, max_duration = 0;
1224 for (tmp = timeline->priv->tracks; tmp; tmp = g_list_next (tmp)) {
1225 TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
1226 g_object_get (tr_priv->track, "duration", &duration, NULL);
1227 GST_DEBUG ("track duration : %" GST_TIME_FORMAT, GST_TIME_ARGS (duration));
1228 max_duration = MAX (duration, max_duration);
1231 if (timeline->priv->duration != max_duration) {
1232 GST_DEBUG ("track duration : %" GST_TIME_FORMAT " current : %"
1233 GST_TIME_FORMAT, GST_TIME_ARGS (max_duration),
1234 GST_TIME_ARGS (timeline->priv->duration));
1236 timeline->priv->duration = max_duration;
1238 #if GLIB_CHECK_VERSION(2,26,0)
1239 g_object_notify_by_pspec (G_OBJECT (timeline), properties[PROP_DURATION]);
1241 g_object_notify (G_OBJECT (timeline), "duration");