ges/ges-layer.h

   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., 51 Franklin St, Fifth Floor,
  18  * Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifndef _GES_LAYER
  22 #define _GES_LAYER
  23
  24 #include <glib-object.h>
  25 #include <ges/ges-types.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GES_TYPE_LAYER ges_layer_get_type()
  30
  31 #define GES_LAYER(obj) \
  32   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GES_TYPE_LAYER, GESLayer))
  33
  34 #define GES_LAYER_CLASS(klass) \
  35   (G_TYPE_CHECK_CLASS_CAST ((klass), GES_TYPE_LAYER, GESLayerClass))
  36
  37 #define GES_IS_LAYER(obj) \
  38   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GES_TYPE_LAYER))
  39
  40 #define GES_IS_LAYER_CLASS(klass) \
  41   (G_TYPE_CHECK_CLASS_TYPE ((klass), GES_TYPE_LAYER))
  42
  43 #define GES_LAYER_GET_CLASS(obj) \
  44   (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_LAYER, GESLayerClass))
  45
  46 typedef struct _GESLayerPrivate GESLayerPrivate;
  47
  48 /**
  49  * GESLayer:
  50  * @timeline: the #GESTimeline where this layer is being used.
  51  */
  52 struct _GESLayer {
  53   GInitiallyUnowned parent;
  54
  55   /*< public >*/
  56
  57   GESTimeline *timeline;
  58
  59   /*< protected >*/
  60   guint32 min_nle_priority, max_nle_priority;
  61
  62   GESLayerPrivate *priv;
  63
  64   /* Padding for API extension */
  65   gpointer _ges_reserved[GES_PADDING];
  66 };
  67
  68 /**
  69  * GESLayerClass:
  70  * @get_objects: method to get the objects contained in the layer
  71  *
  72  * Subclasses can override the @get_objects if they can provide a more
  73  * efficient way of providing the list of contained #GESClip(s).
  74  */
  75 struct _GESLayerClass {
  76   /*< private >*/
  77   GInitiallyUnownedClass parent_class;
  78
  79   /*< public >*/
  80   /* virtual methods for subclasses */
  81   GList *(*get_objects) (GESLayer * layer);
  82
  83   /*< private >*/
  84   /* Signals */
  85   void  (*object_added)         (GESLayer * layer, GESClip * object);
  86   void  (*object_removed)       (GESLayer * layer, GESClip * object);
  87
  88   /* Padding for API extension */
  89   gpointer _ges_reserved[GES_PADDING];
  90 };
  91
  92 GType ges_layer_get_type (void);
  93
  94 GESLayer* ges_layer_new (void);
  95
  96 void     ges_layer_set_timeline  (GESLayer * layer,
  97                                            GESTimeline * timeline);
  98
  99 GESTimeline *
 100 ges_layer_get_timeline           (GESLayer * layer);
 101
 102 gboolean ges_layer_add_clip    (GESLayer * layer,
 103                                            GESClip * clip);
 104 GESClip * ges_layer_add_asset   (GESLayer *layer,
 105                                                        GESAsset *asset,
 106                                                        GstClockTime start,
 107                                                        GstClockTime inpoint,
 108                                                        GstClockTime duration,
 109                                                        GESTrackType track_types);
 110
 111 gboolean ges_layer_remove_clip (GESLayer * layer,
 112                                            GESClip * clip);
 113
 114 void     ges_layer_set_priority  (GESLayer * layer,
 115                                            guint priority);
 116
 117 gboolean ges_layer_is_empty      (GESLayer * layer);
 118
 119 guint   ges_layer_get_priority  (GESLayer * layer);
 120
 121 gboolean ges_layer_get_auto_transition (GESLayer * layer);
 122
 123 void ges_layer_set_auto_transition (GESLayer * layer,
 124                                              gboolean auto_transition);
 125
 126 GList*   ges_layer_get_clips   (GESLayer * layer);
 127 GstClockTime ges_layer_get_duration (GESLayer *layer);
 128
 129 G_END_DECLS
 130
 131 #endif /* _GES_LAYER */