ges/ges-timeline-layer.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-layer
  23  * @short_description: Non-overlaping sequence of #GESTimelineObject
  24  *
  25  * Responsible for the ordering of the various contained TimelineObject(s). A
  26  * timeline layer has a "priority" property, which is used to manage the
  27  * priorities of individual TimelineObjects. Two layers should not have the
  28  * same priority within a given timeline.
  29  */
  30
  31 #include "ges-internal.h"
  32 #include "gesmarshal.h"
  33 #include "ges-timeline-layer.h"
  34 #include "ges.h"
  35
  36 G_DEFINE_TYPE (GESTimelineLayer, ges_timeline_layer, G_TYPE_OBJECT);
  37
  38 enum
  39 {
  40   PROP_0,
  41   PROP_PRIORITY,
  42 };
  43
  44 enum
  45 {
  46   OBJECT_ADDED,
  47   OBJECT_REMOVED,
  48   LAST_SIGNAL
  49 };
  50
  51 static guint ges_timeline_layer_signals[LAST_SIGNAL] = { 0 };
  52
  53 static gboolean ges_timeline_layer_resync_priorities (GESTimelineLayer * layer);
  54
  55 static void
  56 ges_timeline_layer_get_property (GObject * object, guint property_id,
  57     GValue * value, GParamSpec * pspec)
  58 {
  59   GESTimelineLayer *layer = GES_TIMELINE_LAYER (object);
  60
  61   switch (property_id) {
  62     case PROP_PRIORITY:
  63       g_value_set_uint (value, layer->priority);
  64       break;
  65     default:
  66       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
  67   }
  68 }
  69
  70 static void
  71 ges_timeline_layer_set_property (GObject * object, guint property_id,
  72     const GValue * value, GParamSpec * pspec)
  73 {
  74   GESTimelineLayer *layer = GES_TIMELINE_LAYER (object);
  75
  76   switch (property_id) {
  77     case PROP_PRIORITY:
  78       ges_timeline_layer_set_priority (layer, g_value_get_uint (value));
  79       break;
  80     default:
  81       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
  82   }
  83 }
  84
  85 static void
  86 ges_timeline_layer_dispose (GObject * object)
  87 {
  88   GESTimelineLayer *layer = GES_TIMELINE_LAYER (object);
  89
  90   GST_DEBUG ("Disposing layer");
  91
  92   while (layer->objects_start) {
  93     GESTimelineObject *obj = (GESTimelineObject *) layer->objects_start->data;
  94     ges_timeline_layer_remove_object (layer, obj);
  95   }
  96
  97   G_OBJECT_CLASS (ges_timeline_layer_parent_class)->dispose (object);
  98 }
  99
 100 static void
 101 ges_timeline_layer_finalize (GObject * object)
 102 {
 103   G_OBJECT_CLASS (ges_timeline_layer_parent_class)->finalize (object);
 104 }
 105
 106 static void
 107 ges_timeline_layer_class_init (GESTimelineLayerClass * klass)
 108 {
 109   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 110
 111   object_class->get_property = ges_timeline_layer_get_property;
 112   object_class->set_property = ges_timeline_layer_set_property;
 113   object_class->dispose = ges_timeline_layer_dispose;
 114   object_class->finalize = ges_timeline_layer_finalize;
 115
 116   /**
 117    * GESTimelineLayer:priority
 118    *
 119    * The priority of the layer in the #GESTimeline. 0 is the highest
 120    * priority. Conceptually, a #GESTimeline is a stack of GESTimelineLayers,
 121    * and the priority of the layer represents its position in the stack. Two
 122    * layers should not have the same priority within a given GESTimeline.
 123    */
 124   g_object_class_install_property (object_class, PROP_PRIORITY,
 125       g_param_spec_uint ("priority", "Priority",
 126           "The priority of the layer", 0, G_MAXUINT, 0, G_PARAM_READWRITE));
 127
 128   /**
 129    * GESTimelineLayer::object-added
 130    * @layer: the #GESTimelineLayer
 131    * @object: the #GESTimelineObject that was added.
 132    *
 133    * Will be emitted after the object was added to the layer.
 134    */
 135   ges_timeline_layer_signals[OBJECT_ADDED] =
 136       g_signal_new ("object-added", G_TYPE_FROM_CLASS (klass),
 137       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESTimelineLayerClass, object_added),
 138       NULL, NULL, ges_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
 139       GES_TYPE_TIMELINE_OBJECT);
 140
 141   /**
 142    * GESTimelineLayer::object-removed
 143    * @layer: the #GESTimelineLayer
 144    * @object: the #GESTimelineObject that was removed
 145    *
 146    * Will be emitted after the object was removed from the layer.
 147    */
 148   ges_timeline_layer_signals[OBJECT_REMOVED] =
 149       g_signal_new ("object-removed", G_TYPE_FROM_CLASS (klass),
 150       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GESTimelineLayerClass,
 151           object_removed), NULL, NULL, ges_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
 152       GES_TYPE_TIMELINE_OBJECT);
 153
 154 }
 155
 156 static void
 157 ges_timeline_layer_init (GESTimelineLayer * self)
 158 {
 159   /* TODO : Keep those 3 values in sync */
 160   self->priority = 0;
 161   self->min_gnl_priority = 0;
 162   self->max_gnl_priority = 9;
 163 }
 164
 165 /**
 166  * ges_timeline_layer_new:
 167  *
 168  * Creates a new #GESTimelineLayer.
 169  *
 170  * Returns: A new #GESTimelineLayer
 171  */
 172 GESTimelineLayer *
 173 ges_timeline_layer_new (void)
 174 {
 175   return g_object_new (GES_TYPE_TIMELINE_LAYER, NULL);
 176 }
 177
 178 void
 179 ges_timeline_layer_set_timeline (GESTimelineLayer * layer,
 180     GESTimeline * timeline)
 181 {
 182   GST_DEBUG ("layer:%p, timeline:%p", layer, timeline);
 183
 184   layer->timeline = timeline;
 185 }
 186
 187 static gint
 188 objects_start_compare (GESTimelineObject * a, GESTimelineObject * b)
 189 {
 190   if (a->start == b->start) {
 191     if (a->priority < b->priority)
 192       return -1;
 193     if (a->priority > b->priority)
 194       return 1;
 195     return 0;
 196   }
 197   if (a->start < b->start)
 198     return -1;
 199   if (a->start > b->start)
 200     return 1;
 201   return 0;
 202 }
 203
 204 /**
 205  * ges_timeline_layer_add_object:
 206  * @layer: a #GESTimelineLayer
 207  * @object: the #GESTimelineObject to add.
 208  *
 209  * Adds the object to the layer. The layer will steal a reference to the
 210  * provided object.
 211  *
 212  * Returns: TRUE if the object was properly added to the layer, or FALSE
 213  * if the @layer refused to add the object.
 214  */
 215
 216 gboolean
 217 ges_timeline_layer_add_object (GESTimelineLayer * layer,
 218     GESTimelineObject * object)
 219 {
 220   GST_DEBUG ("layer:%p, object:%p", layer, object);
 221
 222   if (G_UNLIKELY (object->layer)) {
 223     GST_WARNING ("TimelineObject %p already belongs to another layer");
 224     return FALSE;
 225   }
 226
 227   /* Take a reference to the object and store it stored by start/priority */
 228   layer->objects_start =
 229       g_slist_insert_sorted (layer->objects_start, object,
 230       (GCompareFunc) objects_start_compare);
 231
 232   /* Inform the object it's now in this layer */
 233   ges_timeline_object_set_layer (object, layer);
 234
 235   /* Set the priority. */
 236   if (GES_TIMELINE_OBJECT_PRIORITY (object) > (layer->max_gnl_priority)) {
 237     ges_timeline_object_set_priority (object, layer->max_gnl_priority);
 238   }
 239
 240   else if (GES_TIMELINE_OBJECT_PRIORITY (object) < (layer->min_gnl_priority)) {
 241     ges_timeline_object_set_priority (object, layer->min_gnl_priority);
 242   }
 243
 244   /* emit 'object-added' */
 245   g_signal_emit (layer, ges_timeline_layer_signals[OBJECT_ADDED], 0, object);
 246
 247   return TRUE;
 248 }
 249
 250 /**
 251  * ges_timeline_layer_remove_object:
 252  * @layer: a #GESTimelineLayer
 253  * @object: the #GESTimelineObject to remove
 254  *
 255  * Removes the given @object from the @layer. The reference stolen by the @layer
 256  * when the object was added will be removed. If you wish to use the object after
 257  * this function, make sure you take an extra reference to the object before
 258  * calling this function.
 259  *
 260  * Returns: TRUE if the object was properly remove, else FALSE.
 261  */
 262 gboolean
 263 ges_timeline_layer_remove_object (GESTimelineLayer * layer,
 264     GESTimelineObject * object)
 265 {
 266   GST_DEBUG ("layer:%p, object:%p", layer, object);
 267
 268   if (G_UNLIKELY (object->layer != layer)) {
 269     GST_WARNING ("TimelineObject doesn't belong to this layer");
 270     return FALSE;
 271   }
 272
 273   /* emit 'object-removed' */
 274   g_signal_emit (layer, ges_timeline_layer_signals[OBJECT_REMOVED], 0, object);
 275
 276   /* inform the object it's no longer in a layer */
 277   ges_timeline_object_set_layer (object, NULL);
 278
 279   /* Remove it from our list of controlled objects */
 280   layer->objects_start = g_slist_remove (layer->objects_start, object);
 281
 282   /* Remove our reference to the object */
 283   g_object_unref (object);
 284
 285   return TRUE;
 286 }
 287
 288 /**
 289  * ges_timeline_layer_resync_priorities:
 290  * @layer: a #GESTimelineLayer
 291  *
 292  * Resyncs the priorities of the objects controlled by @layer.
 293  * This method */
 294 gboolean
 295 ges_timeline_layer_resync_priorities (GESTimelineLayer * layer)
 296 {
 297   GSList *tmp;
 298
 299   /* TODO : Inhibit composition updates while doing this.
 300    * Ideally we want to do it from an even higher level, but here will
 301    * do in the meantime. */
 302
 303   /* TODO : This is the dumb version where we put everything linearly,
 304    * will need to be adjusted for more complex usages (like with
 305    * transitions).  */
 306   for (tmp = layer->objects_start; tmp; tmp = tmp->next) {
 307     ges_timeline_object_set_priority ((GESTimelineObject *) tmp->data,
 308         layer->min_gnl_priority);
 309   }
 310
 311   return TRUE;
 312 }
 313
 314 void
 315 ges_timeline_layer_set_priority (GESTimelineLayer * layer, guint priority)
 316 {
 317   GST_DEBUG ("layer:%p, priority:%d", layer, priority);
 318
 319   if (priority != layer->priority) {
 320     layer->priority = priority;
 321     layer->min_gnl_priority = (priority * 10);
 322     layer->max_gnl_priority = ((priority + 1) * 10) - 1;
 323
 324     /* FIXME : Update controlled object's gnl priority accordingly */
 325     ges_timeline_layer_resync_priorities (layer);
 326   }
 327 }