ges: Some debug logging enhancements
[platform/upstream/gstreamer.git] / ges / ges-timeline.c
1 /* GStreamer Editing Services
2  * Copyright (C) 2009 Edward Hervey <edward.hervey@collabora.co.uk>
3  *               2009 Nokia Corporation
4  *
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.
9  *
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.
14  *
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.
19  */
20
21 /**
22  * SECTION:ges-timeline
23  * @short_description: Multimedia timeline
24  *
25  * #GESTimeline is the central object for any multimedia timeline.
26  *
27  * Contains a list of #GESTimelineLayer which users should use to arrange the
28  * various timeline objects through time.
29  *
30  * The output type is determined by the #GESTrack that are set on
31  * the #GESTimeline.
32  *
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.
37  */
38
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"
44 #include "ges.h"
45
46 static void track_duration_cb (GstElement * track,
47     GParamSpec * arg G_GNUC_UNUSED, GESTimeline * timeline);
48
49 G_DEFINE_TYPE (GESTimeline, ges_timeline, GST_TYPE_BIN);
50
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)))
57
58 struct _GESTimelinePrivate
59 {
60   GList *layers;                /* A list of GESTimelineLayer sorted by priority */
61   GList *tracks;                /* A list of private track data */
62
63   /* The duration of the timeline */
64   gint64 duration;
65
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;
71
72   /* Whether we are changing state asynchronously or not */
73   gboolean async_pending;
74 };
75
76 /* private structure to contain our track-related information */
77
78 typedef struct
79 {
80   GESTimeline *timeline;
81   GESTrack *track;
82   GstPad *pad;                  /* Pad from the track */
83   GstPad *ghostpad;
84 } TrackPrivate;
85
86 enum
87 {
88   PROP_0,
89   PROP_DURATION,
90   PROP_LAST
91 };
92
93 static GParamSpec *properties[PROP_LAST];
94
95 enum
96 {
97   TRACK_ADDED,
98   TRACK_REMOVED,
99   LAYER_ADDED,
100   LAYER_REMOVED,
101   LAST_SIGNAL
102 };
103
104 static GstBinClass *parent_class;
105
106 static guint ges_timeline_signals[LAST_SIGNAL] = { 0 };
107
108 static gint custom_find_track (TrackPrivate * tr_priv, GESTrack * track);
109 static GstStateChangeReturn
110 ges_timeline_change_state (GstElement * element, GstStateChange transition);
111 static void
112 discoverer_finished_cb (GstDiscoverer * discoverer, GESTimeline * timeline);
113 static void
114 discoverer_discovered_cb (GstDiscoverer * discoverer,
115     GstDiscovererInfo * info, GError * err, GESTimeline * timeline);
116
117 static void
118 ges_timeline_get_property (GObject * object, guint property_id,
119     GValue * value, GParamSpec * pspec)
120 {
121   GESTimeline *timeline = GES_TIMELINE (object);
122
123   switch (property_id) {
124     default:
125       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
126     case PROP_DURATION:
127       g_value_set_uint64 (value, timeline->priv->duration);
128       break;
129   }
130 }
131
132 static void
133 ges_timeline_set_property (GObject * object, guint property_id,
134     const GValue * value, GParamSpec * pspec)
135 {
136   switch (property_id) {
137     default:
138       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
139   }
140 }
141
142 static void
143 ges_timeline_dispose (GObject * object)
144 {
145   GESTimelinePrivate *priv = GES_TIMELINE (object)->priv;
146
147   if (priv->discoverer) {
148     gst_discoverer_stop (priv->discoverer);
149     g_object_unref (priv->discoverer);
150     priv->discoverer = NULL;
151   }
152
153   while (priv->layers) {
154     GESTimelineLayer *layer = (GESTimelineLayer *) priv->layers->data;
155     ges_timeline_remove_layer (GES_TIMELINE (object), layer);
156   }
157
158   /* FIXME: it should be possible to remove tracks before removing
159    * layers, but at the moment this creates a problem because the track
160    * objects aren't notified that their gnlobjects have been destroyed.
161    */
162
163   while (priv->tracks) {
164     TrackPrivate *tr_priv = (TrackPrivate *) priv->tracks->data;
165     ges_timeline_remove_track (GES_TIMELINE (object), tr_priv->track);
166   }
167
168   G_OBJECT_CLASS (ges_timeline_parent_class)->dispose (object);
169 }
170
171 static void
172 ges_timeline_finalize (GObject * object)
173 {
174   GESTimeline *timeline = GES_TIMELINE (object);
175
176   g_mutex_free (timeline->priv->pendingobjects_lock);
177
178   G_OBJECT_CLASS (ges_timeline_parent_class)->finalize (object);
179 }
180
181 static void
182 ges_timeline_class_init (GESTimelineClass * klass)
183 {
184   GObjectClass *object_class = G_OBJECT_CLASS (klass);
185   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
186
187   g_type_class_add_private (klass, sizeof (GESTimelinePrivate));
188
189   parent_class = g_type_class_peek_parent (klass);
190
191   element_class->change_state = ges_timeline_change_state;
192
193   object_class->get_property = ges_timeline_get_property;
194   object_class->set_property = ges_timeline_set_property;
195   object_class->dispose = ges_timeline_dispose;
196   object_class->finalize = ges_timeline_finalize;
197
198   /**
199    * GESTimelineObject:duration
200    *
201    * Current duration (in nanoseconds) of the #GESTimeline
202    *
203    * Default value: 0
204    */
205   properties[PROP_DURATION] =
206       g_param_spec_uint64 ("duration", "Duration",
207       "The duration of the timeline", 0, G_MAXUINT64,
208       GST_CLOCK_TIME_NONE, G_PARAM_READABLE);
209   g_object_class_install_property (object_class, PROP_DURATION,
210       properties[PROP_DURATION]);
211
212   /**
213    * GESTimeline::track-added
214    * @timeline: the #GESTimeline
215    * @track: the #GESTrack that was added to the timeline
216    *
217    * Will be emitted after the track was added to the timeline.
218    */
219   ges_timeline_signals[TRACK_ADDED] =
220       g_signal_new ("track-added", G_TYPE_FROM_CLASS (klass),
221       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESTimelineClass, track_added), NULL,
222       NULL, ges_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GES_TYPE_TRACK);
223
224   /**
225    * GESTimeline::track-removed
226    * @timeline: the #GESTimeline
227    * @track: the #GESTrack that was removed from the timeline
228    *
229    * Will be emitted after the track was removed from the timeline.
230    */
231   ges_timeline_signals[TRACK_REMOVED] =
232       g_signal_new ("track-removed", G_TYPE_FROM_CLASS (klass),
233       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESTimelineClass, track_removed),
234       NULL, NULL, ges_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GES_TYPE_TRACK);
235
236   /**
237    * GESTimeline::layer-added
238    * @timeline: the #GESTimeline
239    * @layer: the #GESTimelineLayer that was added to the timeline
240    *
241    * Will be emitted after the layer was added to the timeline.
242    */
243   ges_timeline_signals[LAYER_ADDED] =
244       g_signal_new ("layer-added", G_TYPE_FROM_CLASS (klass),
245       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESTimelineClass, layer_added), NULL,
246       NULL, ges_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GES_TYPE_TIMELINE_LAYER);
247
248   /**
249    * GESTimeline::layer-removed
250    * @timeline: the #GESTimeline
251    * @layer: the #GESTimelineLayer that was removed from the timeline
252    *
253    * Will be emitted after the layer was removed from the timeline.
254    */
255   ges_timeline_signals[LAYER_REMOVED] =
256       g_signal_new ("layer-removed", G_TYPE_FROM_CLASS (klass),
257       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESTimelineClass, layer_removed),
258       NULL, NULL, ges_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
259       GES_TYPE_TIMELINE_LAYER);
260 }
261
262 static void
263 ges_timeline_init (GESTimeline * self)
264 {
265
266   self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
267       GES_TYPE_TIMELINE, GESTimelinePrivate);
268
269   self->priv->layers = NULL;
270   self->priv->tracks = NULL;
271   self->priv->duration = 0;
272
273   self->priv->pendingobjects_lock = g_mutex_new ();
274   /* New discoverer with a 15s timeout */
275   self->priv->discoverer = gst_discoverer_new (15 * GST_SECOND, NULL);
276   g_signal_connect (self->priv->discoverer, "finished",
277       G_CALLBACK (discoverer_finished_cb), self);
278   g_signal_connect (self->priv->discoverer, "discovered",
279       G_CALLBACK (discoverer_discovered_cb), self);
280   gst_discoverer_start (self->priv->discoverer);
281 }
282
283 static gint
284 sort_layers (gpointer a, gpointer b)
285 {
286   GESTimelineLayer *layer_a, *layer_b;
287   guint prio_a, prio_b;
288
289   layer_a = GES_TIMELINE_LAYER (a);
290   layer_b = GES_TIMELINE_LAYER (b);
291
292   prio_a = ges_timeline_layer_get_priority (layer_a);
293   prio_b = ges_timeline_layer_get_priority (layer_b);
294
295   if ((gint) prio_a > (guint) prio_b)
296     return 1;
297   if ((guint) prio_a < (guint) prio_b)
298     return -1;
299
300   return 0;
301 }
302
303 /**
304  * ges_timeline_new:
305  *
306  * Creates a new empty #GESTimeline.
307  *
308  * Returns: The new timeline.
309  */
310
311 GESTimeline *
312 ges_timeline_new (void)
313 {
314   return g_object_new (GES_TYPE_TIMELINE, NULL);
315 }
316
317 /**
318  * ges_timeline_new_from_uri:
319  * @uri: the URI to load from
320  *
321  * Creates a timeline from the given URI.
322  *
323  * Returns: A new timeline if the uri was loaded successfully, or NULL if the
324  * uri could not be loaded
325  */
326
327 GESTimeline *
328 ges_timeline_new_from_uri (const gchar * uri)
329 {
330   GESTimeline *ret;
331
332   /* FIXME : we should have a GError** argument so the user can know why
333    * it wasn't able to load the uri
334    */
335
336   ret = ges_timeline_new ();
337
338   if (!ges_timeline_load_from_uri (ret, uri)) {
339     g_object_unref (ret);
340     return NULL;
341   }
342
343   return ret;
344 }
345
346
347 /**
348  * ges_timeline_load_from_uri:
349  * @timeline: an empty #GESTimeline into which to load the formatter
350  * @uri: The URI to load from
351  *
352  * Loads the contents of URI into the given timeline.
353  *
354  * Returns: TRUE if the timeline was loaded successfully, or FALSE if the uri
355  * could not be loaded.
356  */
357
358 gboolean
359 ges_timeline_load_from_uri (GESTimeline * timeline, const gchar * uri)
360 {
361   GESFormatter *p = NULL;
362   gboolean ret = FALSE;
363
364   /* FIXME : we should have a GError** argument so the user can know why
365    * it wasn't able to load the uri
366    */
367
368   if (!(p = ges_formatter_new_for_uri (uri))) {
369     GST_ERROR ("unsupported uri '%s'", uri);
370     goto fail;
371   }
372
373   if (!ges_formatter_load_from_uri (p, timeline, uri)) {
374     GST_ERROR ("error deserializing formatter");
375     goto fail;
376   }
377
378   ret = TRUE;
379
380 fail:
381   if (p)
382     g_object_unref (p);
383   return ret;
384 }
385
386 /**
387  * ges_timeline_save_to_uri:
388  * @timeline: a #GESTimeline
389  * @uri: The location to save to
390  *
391  * Saves the timeline to the given location
392  *
393  * Returns: TRUE if the timeline was successfully saved to the given location,
394  * else FALSE.
395  */
396
397 gboolean
398 ges_timeline_save_to_uri (GESTimeline * timeline, const gchar * uri)
399 {
400   GESFormatter *p = NULL;
401   gboolean ret = FALSE;
402
403   /* FIXME : How will the user be able to chose the format he
404    * wishes to store to ? */
405
406   /* FIXME : How will we ensure a timeline loaded with a certain format
407    * will be saved with the same one by default ? We need to make this
408    * easy from an API perspective */
409
410   /* FIXME : we should have a GError** argument so the user can know why
411    * it wasn't able to save
412    */
413
414   if (!(p = ges_formatter_new_for_uri (uri))) {
415     GST_ERROR ("unsupported uri '%s'", uri);
416     goto fail;
417   }
418
419   if (!ges_formatter_save_to_uri (p, timeline, uri)) {
420     GST_ERROR ("error serializing formatter");
421     goto fail;
422   }
423
424   ret = TRUE;
425
426 fail:
427   if (p)
428     g_object_unref (p);
429   return ret;
430 }
431
432 static void
433 add_object_to_track (GESTimelineObject * object, GESTrack * track)
434 {
435   if (!ges_timeline_object_create_track_objects (object, track)) {
436     GST_WARNING ("error creating track objects");
437   }
438 }
439
440 static void
441 add_object_to_tracks (GESTimeline * timeline, GESTimelineObject * object)
442 {
443   GList *tmp;
444
445   for (tmp = timeline->priv->tracks; tmp; tmp = g_list_next (tmp)) {
446     TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
447     GESTrack *track = tr_priv->track;
448
449     GST_LOG ("Trying with track %p", track);
450     add_object_to_track (object, track);
451   }
452 }
453
454
455 static void
456 do_async_start (GESTimeline * timeline)
457 {
458   GstMessage *message;
459   GList *tmp;
460
461   timeline->priv->async_pending = TRUE;
462
463   /* Freeze state of tracks */
464   for (tmp = timeline->priv->tracks; tmp; tmp = tmp->next) {
465     TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
466     gst_element_set_locked_state ((GstElement *) tr_priv->track, TRUE);
467   }
468
469   message = gst_message_new_async_start (GST_OBJECT_CAST (timeline), FALSE);
470   parent_class->handle_message (GST_BIN_CAST (timeline), message);
471 }
472
473 static void
474 do_async_done (GESTimeline * timeline)
475 {
476   GstMessage *message;
477
478   if (timeline->priv->async_pending) {
479     GList *tmp;
480     /* Unfreeze state of tracks */
481     for (tmp = timeline->priv->tracks; tmp; tmp = tmp->next) {
482       TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
483       gst_element_set_locked_state ((GstElement *) tr_priv->track, FALSE);
484       gst_element_sync_state_with_parent ((GstElement *) tr_priv->track);
485     }
486
487     GST_DEBUG_OBJECT (timeline, "Emitting async-done");
488     message = gst_message_new_async_done (GST_OBJECT_CAST (timeline));
489     parent_class->handle_message (GST_BIN_CAST (timeline), message);
490
491     timeline->priv->async_pending = FALSE;
492   }
493 }
494
495 static void
496 discoverer_finished_cb (GstDiscoverer * discoverer, GESTimeline * timeline)
497 {
498   do_async_done (timeline);
499 }
500
501 static void
502 discoverer_discovered_cb (GstDiscoverer * discoverer,
503     GstDiscovererInfo * info, GError * err, GESTimeline * timeline)
504 {
505   GList *tmp;
506   gboolean found = FALSE;
507   gboolean is_image = FALSE;
508   GESTimelineFileSource *tfs = NULL;
509   GESTimelinePrivate *priv = timeline->priv;
510   const gchar *uri = gst_discoverer_info_get_uri (info);
511
512
513   if (err) {
514     GST_WARNING ("Error while discovering %s: %s", uri, err->message);
515     return;
516   } else
517     GST_DEBUG ("Discovered uri %s", uri);
518
519   GES_TIMELINE_PENDINGOBJS_LOCK (timeline);
520
521   /* Find corresponding TimelineFileSource in the sources */
522   for (tmp = priv->pendingobjects; tmp; tmp = tmp->next) {
523     tfs = (GESTimelineFileSource *) tmp->data;
524
525     if (!g_strcmp0 (ges_timeline_filesource_get_uri (tfs), uri)) {
526       found = TRUE;
527       break;
528     }
529   }
530
531   if (found) {
532     GList *stream_list;
533     GESTrackType tfs_supportedformats;
534
535     /* The timeline file source will be updated with discovered information
536      * so it needs to not be finalized during this process */
537     g_object_ref (tfs);
538
539     /* Remove object from list */
540     priv->pendingobjects = g_list_delete_link (priv->pendingobjects, tmp);
541     GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
542
543     /* FIXME : Handle errors in discovery */
544     stream_list = gst_discoverer_info_get_stream_list (info);
545
546     tfs_supportedformats = ges_timeline_filesource_get_supported_formats (tfs);
547     if (tfs_supportedformats != GES_TRACK_TYPE_UNKNOWN)
548       goto check_image;
549
550     /* Update timelinefilesource properties based on info */
551     for (tmp = stream_list; tmp; tmp = tmp->next) {
552       GstDiscovererStreamInfo *sinf = (GstDiscovererStreamInfo *) tmp->data;
553
554       if (GST_IS_DISCOVERER_AUDIO_INFO (sinf)) {
555         tfs_supportedformats |= GES_TRACK_TYPE_AUDIO;
556         ges_timeline_filesource_set_supported_formats (tfs,
557             tfs_supportedformats);
558       } else if (GST_IS_DISCOVERER_VIDEO_INFO (sinf)) {
559         tfs_supportedformats |= GES_TRACK_TYPE_VIDEO;
560         ges_timeline_filesource_set_supported_formats (tfs,
561             tfs_supportedformats);
562         if (gst_discoverer_video_info_is_image ((GstDiscovererVideoInfo *)
563                 sinf)) {
564           tfs_supportedformats |= GES_TRACK_TYPE_AUDIO;
565           ges_timeline_filesource_set_supported_formats (tfs,
566               tfs_supportedformats);
567           is_image = TRUE;
568         }
569       }
570     }
571
572     if (stream_list)
573       gst_discoverer_stream_info_list_free (stream_list);
574
575   check_image:
576
577     if (is_image) {
578       /* don't set max-duration on still images */
579       g_object_set (tfs, "is_image", (gboolean) TRUE, NULL);
580     }
581
582     else {
583       g_object_set (tfs, "max-duration",
584           gst_discoverer_info_get_duration (info), NULL);
585     }
586
587     /* Continue the processing on tfs */
588     add_object_to_tracks (timeline, GES_TIMELINE_OBJECT (tfs));
589
590     /* Remove the ref as the timeline file source is no longer needed here */
591     g_object_unref (tfs);
592   } else {
593     GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
594   }
595 }
596
597 static GstStateChangeReturn
598 ges_timeline_change_state (GstElement * element, GstStateChange transition)
599 {
600   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
601   GESTimeline *timeline = GES_TIMELINE (element);
602
603   switch (transition) {
604     case GST_STATE_CHANGE_READY_TO_PAUSED:
605       GES_TIMELINE_PENDINGOBJS_LOCK (timeline);
606       if (timeline->priv->pendingobjects) {
607         GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
608         do_async_start (timeline);
609         ret = GST_STATE_CHANGE_ASYNC;
610       } else {
611         GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
612       }
613       break;
614     default:
615       break;
616   }
617
618   {
619     GstStateChangeReturn bret;
620
621     bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
622     if (G_UNLIKELY (bret == GST_STATE_CHANGE_NO_PREROLL)) {
623       do_async_done (timeline);
624       ret = bret;
625     }
626   }
627
628   switch (transition) {
629     case GST_STATE_CHANGE_PAUSED_TO_READY:
630       do_async_done (timeline);
631       break;
632     default:
633       break;
634   }
635
636   return ret;
637
638 }
639
640 static void
641 layer_object_added_cb (GESTimelineLayer * layer, GESTimelineObject * object,
642     GESTimeline * timeline)
643 {
644   if (ges_timeline_object_is_moving_from_layer (object)) {
645     GST_DEBUG ("TimelineObject %p is moving from a layer to another, not doing"
646         " anything on it", object);
647     return;
648   }
649
650   GST_DEBUG ("New TimelineObject %p added to layer %p", object, layer);
651
652   if (GES_IS_TIMELINE_FILE_SOURCE (object)) {
653     GESTimelineFileSource *tfs = GES_TIMELINE_FILE_SOURCE (object);
654     GESTrackType tfs_supportedformats =
655         ges_timeline_filesource_get_supported_formats (tfs);
656     guint64 tfs_maxdur = ges_timeline_filesource_get_max_duration (tfs);
657     const gchar *tfs_uri;
658
659     /* Send the filesource to the discoverer if:
660      * * it doesn't have specified supported formats
661      * * OR it doesn't have a specified max-duration
662      * * OR it doesn't have a valid duration  */
663
664     if (tfs_supportedformats == GES_TRACK_TYPE_UNKNOWN ||
665         tfs_maxdur == GST_CLOCK_TIME_NONE || object->duration == 0) {
666       GST_LOG ("Incomplete TimelineFileSource, discovering it");
667       tfs_uri = ges_timeline_filesource_get_uri (tfs);
668
669       GES_TIMELINE_PENDINGOBJS_LOCK (timeline);
670       timeline->priv->pendingobjects =
671           g_list_append (timeline->priv->pendingobjects, object);
672       GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
673
674       gst_discoverer_discover_uri_async (timeline->priv->discoverer, tfs_uri);
675     } else
676       add_object_to_tracks (timeline, object);
677   } else {
678     add_object_to_tracks (timeline, object);
679   }
680
681   GST_DEBUG ("done");
682 }
683
684 static void
685 layer_priority_changed_cb (GESTimelineLayer * layer,
686     GParamSpec * arg G_GNUC_UNUSED, GESTimeline * timeline)
687 {
688   timeline->priv->layers = g_list_sort (timeline->priv->layers, (GCompareFunc)
689       sort_layers);
690 }
691
692 static void
693 layer_object_removed_cb (GESTimelineLayer * layer, GESTimelineObject * object,
694     GESTimeline * timeline)
695 {
696   GList *tmp, *trackobjects;
697
698   if (ges_timeline_object_is_moving_from_layer (object)) {
699     GST_DEBUG ("TimelineObject %p is moving from a layer to another, not doing"
700         " anything on it", object);
701     return;
702   }
703
704   GST_DEBUG ("TimelineObject %p removed from layer %p", object, layer);
705
706   /* Go over the object's track objects and figure out which one belongs to
707    * the list of tracks we control */
708
709   trackobjects = ges_timeline_object_get_track_objects (object);
710   for (tmp = trackobjects; tmp; tmp = tmp->next) {
711     GESTrackObject *trobj = (GESTrackObject *) tmp->data;
712
713     GST_DEBUG ("Trying to remove TrackObject %p", trobj);
714     if (G_LIKELY (g_list_find_custom (timeline->priv->tracks,
715                 ges_track_object_get_track (trobj),
716                 (GCompareFunc) custom_find_track))) {
717       GST_DEBUG ("Belongs to one of the tracks we control");
718       ges_track_remove_object (ges_track_object_get_track (trobj), trobj);
719
720       ges_timeline_object_release_track_object (object, trobj);
721     }
722
723     /* removing the reference added by _get_track_objects() */
724     g_object_unref (trobj);
725   }
726   g_list_free (trackobjects);
727
728   /* if the object is a timeline file source that has not yet been discovered,
729    * it no longer needs to be discovered so remove it from the pendingobjects
730    * list if it belongs to this layer */
731   if (GES_IS_TIMELINE_FILE_SOURCE (object)) {
732     GES_TIMELINE_PENDINGOBJS_LOCK (timeline);
733     timeline->priv->pendingobjects =
734         g_list_remove_all (timeline->priv->pendingobjects, object);
735     GES_TIMELINE_PENDINGOBJS_UNLOCK (timeline);
736   }
737
738   GST_DEBUG ("Done");
739 }
740
741 /**
742  * ges_timeline_append_layer:
743  * @timeline: a #GESTimeline
744  * @layer: the #GESTimelineLayer to add
745  *
746  * Convenience method to append @layer to @timeline which means that the
747  * priority of @layer is changed to correspond to the last layer of @timeline.
748  * The reference to the @layer will be stolen by @timeline.
749  *
750  * Returns: TRUE if the layer was properly added, else FALSE.
751  */
752 gboolean
753 ges_timeline_append_layer (GESTimeline * timeline, GESTimelineLayer * layer)
754 {
755   guint32 priority;
756   GESTimelinePrivate *priv = timeline->priv;
757
758   GST_DEBUG ("Appending layer to layer:%p, timeline:%p", timeline, layer);
759   priority = g_list_length (priv->layers);
760
761   ges_timeline_layer_set_priority (layer, priority);
762
763   return ges_timeline_add_layer (timeline, layer);
764 }
765
766 /**
767  * ges_timeline_add_layer:
768  * @timeline: a #GESTimeline
769  * @layer: the #GESTimelineLayer to add
770  *
771  * Add the layer to the timeline. The reference to the @layer will be stolen
772  * by the @timeline.
773  *
774  * Returns: TRUE if the layer was properly added, else FALSE.
775  */
776 gboolean
777 ges_timeline_add_layer (GESTimeline * timeline, GESTimelineLayer * layer)
778 {
779   GList *objects, *tmp;
780   GESTimelinePrivate *priv = timeline->priv;
781
782   GST_DEBUG ("timeline:%p, layer:%p", timeline, layer);
783
784   /* We can only add a layer that doesn't already belong to another timeline */
785   if (G_UNLIKELY (layer->timeline)) {
786     GST_WARNING ("Layer belongs to another timeline, can't add it");
787     return FALSE;
788   }
789
790   /* Add to the list of layers, make sure we don't already control it */
791   if (G_UNLIKELY (g_list_find (priv->layers, (gconstpointer) layer))) {
792     GST_WARNING ("Layer is already controlled by this timeline");
793     return FALSE;
794   }
795
796   g_object_ref_sink (layer);
797   priv->layers = g_list_insert_sorted (priv->layers, layer,
798       (GCompareFunc) sort_layers);
799
800   /* Inform the layer that it belongs to a new timeline */
801   ges_timeline_layer_set_timeline (layer, timeline);
802
803   /* Connect to 'object-added'/'object-removed' signal from the new layer */
804   g_signal_connect (layer, "object-added", G_CALLBACK (layer_object_added_cb),
805       timeline);
806   g_signal_connect (layer, "object-removed",
807       G_CALLBACK (layer_object_removed_cb), timeline);
808   g_signal_connect (layer, "notify::priority",
809       G_CALLBACK (layer_priority_changed_cb), timeline);
810
811   GST_DEBUG ("Done adding layer, emitting 'layer-added' signal");
812   g_signal_emit (timeline, ges_timeline_signals[LAYER_ADDED], 0, layer);
813
814   /* add any existing timeline objects to the timeline */
815   objects = ges_timeline_layer_get_objects (layer);
816   for (tmp = objects; tmp; tmp = tmp->next) {
817     layer_object_added_cb (layer, tmp->data, timeline);
818     g_object_unref (tmp->data);
819     tmp->data = NULL;
820   }
821   g_list_free (objects);
822
823   return TRUE;
824 }
825
826 /**
827  * ges_timeline_remove_layer:
828  * @timeline: a #GESTimeline
829  * @layer: the #GESTimelineLayer to remove
830  *
831  * Removes the layer from the timeline. The reference that the @timeline holds on
832  * the layer will be dropped. If you wish to use the @layer after calling this
833  * method, you need to take a reference before calling.
834  *
835  * Returns: TRUE if the layer was properly removed, else FALSE.
836  */
837
838 gboolean
839 ges_timeline_remove_layer (GESTimeline * timeline, GESTimelineLayer * layer)
840 {
841   GList *layer_objects, *tmp;
842   GESTimelinePrivate *priv = timeline->priv;
843
844   GST_DEBUG ("timeline:%p, layer:%p", timeline, layer);
845
846   if (G_UNLIKELY (!g_list_find (priv->layers, layer))) {
847     GST_WARNING ("Layer doesn't belong to this timeline");
848     return FALSE;
849   }
850
851   /* remove objects from any private data structures */
852
853   layer_objects = ges_timeline_layer_get_objects (layer);
854   for (tmp = layer_objects; tmp; tmp = tmp->next) {
855     layer_object_removed_cb (layer, GES_TIMELINE_OBJECT (tmp->data), timeline);
856     g_object_unref (G_OBJECT (tmp->data));
857     tmp->data = NULL;
858   }
859   g_list_free (layer_objects);
860
861   /* Disconnect signals */
862   GST_DEBUG ("Disconnecting signal callbacks");
863   g_signal_handlers_disconnect_by_func (layer, layer_object_added_cb, timeline);
864   g_signal_handlers_disconnect_by_func (layer, layer_object_removed_cb,
865       timeline);
866
867   priv->layers = g_list_remove (priv->layers, layer);
868
869   ges_timeline_layer_set_timeline (layer, NULL);
870
871   g_signal_emit (timeline, ges_timeline_signals[LAYER_REMOVED], 0, layer);
872
873   g_object_unref (layer);
874
875   return TRUE;
876 }
877
878 static void
879 pad_added_cb (GESTrack * track, GstPad * pad, TrackPrivate * tr_priv)
880 {
881   gchar *padname;
882
883
884   GST_DEBUG ("track:%p, pad:%s:%s", track, GST_DEBUG_PAD_NAME (pad));
885
886   if (G_UNLIKELY (tr_priv->pad)) {
887     GST_WARNING ("We are already controlling a pad for this track");
888     return;
889   }
890
891   /* Remember the pad */
892   tr_priv->pad = pad;
893
894   /* ghost it ! */
895   GST_DEBUG ("Ghosting pad and adding it to ourself");
896   padname = g_strdup_printf ("track_%p_src", track);
897   tr_priv->ghostpad = gst_ghost_pad_new (padname, pad);
898   g_free (padname);
899   gst_pad_set_active (tr_priv->ghostpad, TRUE);
900   gst_element_add_pad (GST_ELEMENT (tr_priv->timeline), tr_priv->ghostpad);
901 }
902
903 static void
904 pad_removed_cb (GESTrack * track, GstPad * pad, TrackPrivate * tr_priv)
905 {
906   GST_DEBUG ("track:%p, pad:%s:%s", track, GST_DEBUG_PAD_NAME (pad));
907
908   if (G_UNLIKELY (tr_priv->pad != pad)) {
909     GST_WARNING ("Not the pad we're controlling");
910     return;
911   }
912
913   if (G_UNLIKELY (tr_priv->ghostpad == NULL)) {
914     GST_WARNING ("We don't have a ghostpad for this pad !");
915     return;
916   }
917
918   GST_DEBUG ("Removing ghostpad");
919   gst_pad_set_active (tr_priv->ghostpad, FALSE);
920   gst_element_remove_pad (GST_ELEMENT (tr_priv->timeline), tr_priv->ghostpad);
921   tr_priv->ghostpad = NULL;
922   tr_priv->pad = NULL;
923 }
924
925 static gint
926 custom_find_track (TrackPrivate * tr_priv, GESTrack * track)
927 {
928   if (tr_priv->track == track)
929     return 0;
930   return -1;
931 }
932
933 /**
934  * ges_timeline_add_track:
935  * @timeline: a #GESTimeline
936  * @track: the #GESTrack to add
937  *
938  * Add a track to the timeline. The reference to the track will be stolen by the
939  * pipeline.
940  *
941  * Returns: TRUE if the track was properly added, else FALSE.
942  */
943
944 /* FIXME: create track objects for timeline objects which have already been
945  * added to existing layers.
946  */
947
948 gboolean
949 ges_timeline_add_track (GESTimeline * timeline, GESTrack * track)
950 {
951   TrackPrivate *tr_priv;
952   GESTimelinePrivate *priv = timeline->priv;
953   GList *tmp;
954
955   GST_DEBUG ("timeline:%p, track:%p", timeline, track);
956
957   /* make sure we don't already control it */
958   if (G_UNLIKELY (g_list_find_custom (priv->tracks, (gconstpointer) track,
959               (GCompareFunc) custom_find_track))) {
960     GST_WARNING ("Track is already controlled by this timeline");
961     return FALSE;
962   }
963
964   /* Add the track to ourself (as a GstBin)
965    * Reference is stolen ! */
966   if (G_UNLIKELY (!gst_bin_add (GST_BIN (timeline), GST_ELEMENT (track)))) {
967     GST_WARNING ("Couldn't add track to ourself (GST)");
968     return FALSE;
969   }
970
971   tr_priv = g_new0 (TrackPrivate, 1);
972   tr_priv->timeline = timeline;
973   tr_priv->track = track;
974
975   /* Add the track to the list of tracks we track */
976   priv->tracks = g_list_append (priv->tracks, tr_priv);
977
978   /* Listen to pad-added/-removed */
979   g_signal_connect (track, "pad-added", (GCallback) pad_added_cb, tr_priv);
980   g_signal_connect (track, "pad-removed", (GCallback) pad_removed_cb, tr_priv);
981
982   /* Inform the track that it's currently being used by ourself */
983   ges_track_set_timeline (track, timeline);
984
985   GST_DEBUG ("Done adding track, emitting 'track-added' signal");
986
987   /* emit 'track-added' */
988   g_signal_emit (timeline, ges_timeline_signals[TRACK_ADDED], 0, track);
989
990   /* ensure that each existing timeline object has the opportunity to create a
991    * track object for this track*/
992
993   for (tmp = priv->layers; tmp; tmp = tmp->next) {
994     GList *objects, *obj;
995     objects = ges_timeline_layer_get_objects (tmp->data);
996
997     for (obj = objects; obj; obj = obj->next) {
998       add_object_to_track (obj->data, track);
999       g_object_unref (obj->data);
1000       obj->data = NULL;
1001     }
1002     g_list_free (objects);
1003   }
1004
1005   /* We connect to the duration change notify, so we can update
1006    * our duration accordingly */
1007   g_signal_connect (G_OBJECT (track), "notify::duration",
1008       G_CALLBACK (track_duration_cb), timeline);
1009   track_duration_cb (GST_ELEMENT (track), NULL, timeline);
1010
1011   return TRUE;
1012 }
1013
1014 /**
1015  * ges_timeline_remove_track:
1016  * @timeline: a #GESTimeline
1017  * @track: the #GESTrack to remove
1018  *
1019  * Remove the @track from the @timeline. The reference stolen when adding the
1020  * @track will be removed. If you wish to use the @track after calling this
1021  * function you must ensure that you have a reference to it.
1022  *
1023  * Returns: TRUE if the @track was properly removed, else FALSE.
1024  */
1025
1026 /* FIXME: release any track objects associated with this layer. currenly this
1027  * will not happen if you remove the track before removing *all*
1028  * timelineobjects which have a track object in this track.
1029  */
1030
1031 gboolean
1032 ges_timeline_remove_track (GESTimeline * timeline, GESTrack * track)
1033 {
1034   GList *tmp;
1035   TrackPrivate *tr_priv;
1036   GESTimelinePrivate *priv = timeline->priv;
1037
1038   GST_DEBUG ("timeline:%p, track:%p", timeline, track);
1039
1040   if (G_UNLIKELY (!(tmp =
1041               g_list_find_custom (priv->tracks, (gconstpointer) track,
1042                   (GCompareFunc) custom_find_track)))) {
1043     GST_WARNING ("Track doesn't belong to this timeline");
1044     return FALSE;
1045   }
1046
1047   tr_priv = tmp->data;
1048   priv->tracks = g_list_remove (priv->tracks, tr_priv);
1049
1050   ges_track_set_timeline (track, NULL);
1051
1052   /* Remove ghost pad */
1053   if (tr_priv->ghostpad) {
1054     GST_DEBUG ("Removing ghostpad");
1055     gst_pad_set_active (tr_priv->ghostpad, FALSE);
1056     gst_ghost_pad_set_target ((GstGhostPad *) tr_priv->ghostpad, NULL);
1057     gst_element_remove_pad (GST_ELEMENT (timeline), tr_priv->ghostpad);
1058   }
1059
1060   /* Remove pad-added/-removed handlers */
1061   g_signal_handlers_disconnect_by_func (track, pad_added_cb, tr_priv);
1062   g_signal_handlers_disconnect_by_func (track, pad_removed_cb, tr_priv);
1063   g_signal_handlers_disconnect_by_func (track, track_duration_cb,
1064       tr_priv->track);
1065
1066   /* Signal track removal to all layers/objects */
1067   g_signal_emit (timeline, ges_timeline_signals[TRACK_REMOVED], 0, track);
1068
1069   /* remove track from our bin */
1070   gst_object_ref (track);
1071   if (G_UNLIKELY (!gst_bin_remove (GST_BIN (timeline), GST_ELEMENT (track)))) {
1072     GST_WARNING ("Couldn't remove track to ourself (GST)");
1073     gst_object_unref (track);
1074     return FALSE;
1075   }
1076
1077   /* set track state to NULL */
1078
1079   gst_element_set_state (GST_ELEMENT (track), GST_STATE_NULL);
1080
1081   gst_object_unref (track);
1082
1083   g_free (tr_priv);
1084
1085   return TRUE;
1086 }
1087
1088 /**
1089  * ges_timeline_get_track_for_pad:
1090  * @timeline: The #GESTimeline
1091  * @pad: The #GstPad
1092  *
1093  * Search the #GESTrack corresponding to the given @timeline's @pad.
1094  *
1095  * Returns: (transfer none): The corresponding #GESTrack if it is found,
1096  * or %NULL if there is an error.
1097  */
1098
1099 GESTrack *
1100 ges_timeline_get_track_for_pad (GESTimeline * timeline, GstPad * pad)
1101 {
1102   GList *tmp;
1103
1104   for (tmp = timeline->priv->tracks; tmp; tmp = g_list_next (tmp)) {
1105     TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
1106     if (pad == tr_priv->ghostpad)
1107       return tr_priv->track;
1108   }
1109
1110   return NULL;
1111 }
1112
1113 /**
1114  * ges_timeline_get_tracks:
1115  * @timeline: a #GESTimeline
1116  *
1117  * Returns the list of #GESTrack used by the Timeline.
1118  *
1119  * Returns: (transfer full) (element-type GESTrack): A list of #GESTrack.
1120  * The caller should unref each track once he is done with them.
1121  */
1122 GList *
1123 ges_timeline_get_tracks (GESTimeline * timeline)
1124 {
1125   GList *tmp, *res = NULL;
1126
1127   for (tmp = timeline->priv->tracks; tmp; tmp = g_list_next (tmp)) {
1128     TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
1129     res = g_list_append (res, g_object_ref (tr_priv->track));
1130   }
1131
1132   return res;
1133 }
1134
1135 /**
1136  * ges_timeline_get_layers:
1137  * @timeline: a #GESTimeline
1138  *
1139  * Get the list of #GESTimelineLayer present in the Timeline.
1140  *
1141  * Returns: (transfer full) (element-type GESTimelineLayer): the list of
1142  * #GESTimelineLayer present in the Timeline sorted by priority.
1143  * The caller should unref each Layer once he is done with them.
1144  */
1145 GList *
1146 ges_timeline_get_layers (GESTimeline * timeline)
1147 {
1148   GList *tmp, *res = NULL;
1149
1150   for (tmp = timeline->priv->layers; tmp; tmp = g_list_next (tmp)) {
1151     res = g_list_insert_sorted (res, g_object_ref (tmp->data),
1152         (GCompareFunc) sort_layers);
1153   }
1154
1155   return res;
1156 }
1157
1158 /**
1159  * ges_timeline_enable_update:
1160  * @timeline: a #GESTimeline
1161  * @enabled: TRUE if the timeline must be updated, FALSE otherwise.
1162  *
1163  * Calls the enable_update function of the tracks contained by the timeline.
1164  *
1165  * Returns: True if success, FALSE otherwise.
1166  */
1167 gboolean
1168 ges_timeline_enable_update (GESTimeline * timeline, gboolean enabled)
1169 {
1170   GList *tmp, *tracks;
1171   gboolean res = TRUE;
1172
1173   GST_DEBUG_OBJECT (timeline, "%s updates", enabled ? "Enabling" : "Disabling");
1174
1175   tracks = ges_timeline_get_tracks (timeline);
1176
1177   for (tmp = tracks; tmp; tmp = tmp->next) {
1178     if (!ges_track_enable_update (tmp->data, enabled)) {
1179       res = FALSE;
1180     }
1181   }
1182
1183   g_list_free (tracks);
1184
1185   return res;
1186 }
1187
1188 static void
1189 track_duration_cb (GstElement * track,
1190     GParamSpec * arg G_GNUC_UNUSED, GESTimeline * timeline)
1191 {
1192   guint64 duration, max_duration = 0;
1193   GList *tmp;
1194
1195   for (tmp = timeline->priv->tracks; tmp; tmp = g_list_next (tmp)) {
1196     TrackPrivate *tr_priv = (TrackPrivate *) tmp->data;
1197     g_object_get (tr_priv->track, "duration", &duration, NULL);
1198     GST_DEBUG ("track duration : %" GST_TIME_FORMAT, GST_TIME_ARGS (duration));
1199     max_duration = MAX (duration, max_duration);
1200   }
1201
1202   if (timeline->priv->duration != max_duration) {
1203     GST_DEBUG ("track duration : %" GST_TIME_FORMAT " current : %"
1204         GST_TIME_FORMAT, GST_TIME_ARGS (max_duration),
1205         GST_TIME_ARGS (timeline->priv->duration));
1206
1207     timeline->priv->duration = max_duration;
1208
1209 #if GLIB_CHECK_VERSION(2,26,0)
1210     g_object_notify_by_pspec (G_OBJECT (timeline), properties[PROP_DURATION]);
1211 #else
1212     g_object_notify (G_OBJECT (timeline), "duration");
1213 #endif
1214   }
1215 }