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