gstreamer/ges/ges-clip.h

218 lines
8.1 KiB
C
Raw Normal View History

2009-08-04 15:13:11 +00:00
/* GStreamer Editing Services
2009-11-30 14:14:25 +00:00
* Copyright (C) 2009 Edward Hervey <edward.hervey@collabora.co.uk>
* 2009 Nokia Corporation
2009-08-04 15:13:11 +00:00
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
2012-11-04 00:25:20 +00:00
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
2009-08-04 15:13:11 +00:00
*/
2013-01-20 15:42:29 +00:00
#ifndef _GES_CLIP
#define _GES_CLIP
2009-08-04 15:13:11 +00:00
#include <glib-object.h>
#include <gst/gst.h>
#include <ges/ges-timeline-element.h>
#include <ges/ges-types.h>
#include <ges/ges-track.h>
2009-08-04 15:13:11 +00:00
G_BEGIN_DECLS
2013-01-20 15:42:29 +00:00
#define GES_TYPE_CLIP ges_clip_get_type()
#define GES_CLIP(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GES_TYPE_CLIP, GESClip))
#define GES_CLIP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GES_TYPE_CLIP, GESClipClass))
#define GES_IS_CLIP(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GES_TYPE_CLIP))
#define GES_IS_CLIP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GES_TYPE_CLIP))
#define GES_CLIP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_CLIP, GESClipClass))
2009-08-04 15:13:11 +00:00
2013-01-20 15:42:29 +00:00
typedef struct _GESClipPrivate GESClipPrivate;
2009-09-16 10:37:45 +00:00
/**
* GESFillTrackObjectFunc:
2013-01-20 15:42:29 +00:00
* @object: the #GESClip controlling the track object
2009-09-16 10:37:45 +00:00
* @trobject: the #GESTrackObject
* @gnlobj: the GNonLin object that needs to be filled.
*
* A function that will be called when the GNonLin object of a corresponding
* track object needs to be filled.
*
* The implementer of this function shall add the proper #GstElement to @gnlobj
* using gst_bin_add().
*
* Returns: TRUE if the implementer succesfully filled the @gnlobj, else #FALSE.
*/
2013-01-20 15:42:29 +00:00
typedef gboolean (*GESFillTrackObjectFunc) (GESClip *object,
2012-11-27 16:54:54 +00:00
GESTrackObject *trobject,
GstElement *gnlobj);
/**
* GESCreateTrackObjectFunc:
2013-01-20 15:42:29 +00:00
* @object: a #GESClip
* @type: a #GESTrackType
*
* Creates the 'primary' track object for this @object.
*
* Subclasses should implement this method if they only provide a
* single #GESTrackObject per track.
*
* If the subclass needs to create more than one #GESTrackObject for a
* given track, then it should implement the 'create_track_objects'
* method instead.
*
* The implementer of this function shall return the proper #GESTrackObject
* that should be controlled by @object for the given @track.
*
* The returned #GESTrackObject will be automatically added to the list
2013-01-20 15:42:29 +00:00
* of objects controlled by the #GESClip.
*
* Returns: the #GESTrackObject to be used, or %NULL if it can't provide one
* for the given @track.
*/
2013-01-20 15:42:29 +00:00
typedef GESTrackObject *(*GESCreateTrackObjectFunc) (GESClip * object,
GESTrackType type);
2010-07-07 14:51:39 +00:00
/**
* GESCreateTrackObjectsFunc:
2013-01-20 15:42:29 +00:00
* @object: a #GESClip
* @type: a #GESTrackType
*
2010-07-07 14:51:39 +00:00
* Create all track objects this object handles for this type of track.
*
* Subclasses should implement this method if they potentially need to
* return more than one #GESTrackObject(s) for a given #GESTrack.
*
* For each object created, the subclass must call
2013-01-20 15:42:29 +00:00
* ges_clip_add_track_object() with the newly created object
* and provided @type.
*
2010-07-07 14:51:39 +00:00
* Returns: %TRUE on success %FALSE on failure.
*/
2013-01-20 15:42:29 +00:00
typedef GList * (*GESCreateTrackObjectsFunc) (GESClip * object, GESTrackType type);
2010-07-07 14:51:39 +00:00
2010-07-09 10:09:08 +00:00
/**
2013-01-20 15:42:29 +00:00
* GES_CLIP_HEIGHT:
* @obj: a #GESClip
2010-07-09 10:09:08 +00:00
*
* The span of priorities this object occupies.
*/
2013-01-20 15:42:29 +00:00
#define GES_CLIP_HEIGHT(obj) (((GESClip*)obj)->height)
2010-07-09 10:09:08 +00:00
2009-09-16 10:37:45 +00:00
/**
2013-01-20 15:42:29 +00:00
* GESClip:
2013-01-11 18:26:26 +00:00
* @trackobjects: (element-type GES.TrackObject): A list of TrackObject
2013-01-20 15:42:29 +00:00
* controlled by this Clip sorted by priority. NOTE: Do not modify.
*
2013-01-20 15:42:29 +00:00
* The #GESClip base class.
2009-09-16 10:37:45 +00:00
*/
2013-01-20 15:42:29 +00:00
struct _GESClip
2012-11-27 16:54:54 +00:00
{
GESTimelineElement parent;
/*< readonly >*/
GList *trackobjects;
/* We don't add those properties to the priv struct for optimization purposes
* start, inpoint, duration and fullduration are in nanoseconds */
2012-11-27 16:54:54 +00:00
guint32 height; /* the span of priorities this object needs */
guint64 fullduration; /* Full usable duration of the object (-1: no duration) */
2009-08-06 09:23:01 +00:00
/*< private >*/
2013-01-20 15:42:29 +00:00
GESClipPrivate *priv;
/* Padding for API extension */
gpointer _ges_reserved[GES_PADDING_LARGE];
2009-08-04 15:16:31 +00:00
};
2009-08-04 15:13:11 +00:00
2009-09-16 10:37:45 +00:00
/**
2013-01-20 15:42:29 +00:00
* GESClipClass:
2010-07-07 13:47:51 +00:00
* @create_track_object: method to create a single #GESTrackObject for a given #GESTrack.
* @create_track_objects: method to create multiple #GESTrackObjects for a
2010-07-07 13:47:51 +00:00
* #GESTrack.
2009-09-16 10:37:45 +00:00
* @fill_track_object: method to fill an associated #GESTrackObject.
* @need_fill_track: Set to TRUE if @fill_track_object needs to be called.
* @snaps: Set to %TRUE if the objects of this type snap with
* other objects in a timeline %FALSE otherwise (default is %FALSE). Basically only
* sources snap.
* @track_object_added: Should be overridden by subclasses if they need to perform an
2011-05-20 14:02:58 +00:00
* operation when a #GESTrackObject is added. Since: 0.10.2
* @track_object_released: Should be overridden by subclasses if they need to perform
2011-05-20 14:02:58 +00:00
* action when a #GESTrackObject is released. Since: 0.10.2
2009-09-16 10:37:45 +00:00
*
* Subclasses can override the @create_track_object and @fill_track_object methods.
*/
2013-01-20 15:42:29 +00:00
struct _GESClipClass
2012-11-27 16:54:54 +00:00
{
/*< private > */
GESTimelineElementClass parent_class;
2012-11-27 16:54:54 +00:00
/*< public > */
GESCreateTrackObjectFunc create_track_object;
GESCreateTrackObjectsFunc create_track_objects;
2010-07-07 13:47:51 +00:00
/* FIXME : might need a release_track_object */
2012-11-27 16:54:54 +00:00
GESFillTrackObjectFunc fill_track_object;
gboolean need_fill_track;
gboolean snaps;
2013-01-20 15:42:29 +00:00
void (*track_object_added) (GESClip *object,
GESTrackObject *tck_object);
2013-01-20 15:42:29 +00:00
void (*track_object_released) (GESClip *object,
GESTrackObject *tck_object);
/*< private >*/
/* Padding for API extension */
gpointer _ges_reserved[GES_PADDING_LARGE];
2009-08-04 15:16:31 +00:00
};
2009-08-04 15:13:11 +00:00
2013-01-20 15:42:29 +00:00
GType ges_clip_get_type (void);
2009-08-04 15:13:11 +00:00
2011-05-06 17:36:35 +00:00
/* Setters */
2013-01-20 15:42:29 +00:00
void ges_clip_set_layer (GESClip *object,
2012-11-27 16:54:54 +00:00
GESTimelineLayer *layer);
2011-05-06 17:36:35 +00:00
/* TrackObject handling */
2013-01-20 15:42:29 +00:00
GList* ges_clip_get_track_objects (GESClip *object);
GESTrackType ges_clip_get_supported_formats (GESClip *object);
GESTrackObject *ges_clip_create_track_object (GESClip *object, GESTrackType type);
GList * ges_clip_create_track_objects (GESClip *object, GESTrackType type);
gboolean ges_clip_release_track_object (GESClip *object, GESTrackObject *trackobject);
void ges_clip_set_supported_formats (GESClip *object, GESTrackType supportedformats);
gboolean ges_clip_add_asset (GESClip *object, GESAsset *asset);
gboolean ges_clip_add_track_object (GESClip *object, GESTrackObject *trobj);
gboolean ges_clip_fill_track_object (GESClip *object, GESTrackObject *trackobj, GstElement *gnlobj);
GESTrackObject *ges_clip_find_track_object (GESClip *object, GESTrack *track, GType type);
2011-05-06 17:36:35 +00:00
/* Layer */
2013-01-20 15:42:29 +00:00
GESTimelineLayer *ges_clip_get_layer (GESClip *object);
gboolean ges_clip_is_moving_from_layer (GESClip *object);
gboolean ges_clip_move_to_layer (GESClip *object, GESTimelineLayer *layer);
void ges_clip_set_moving_from_layer (GESClip *object, gboolean is_moving);
2011-05-06 17:36:35 +00:00
/* Effects */
2013-01-20 15:42:29 +00:00
GList* ges_clip_get_top_effects (GESClip *object);
gint ges_clip_get_top_effect_position (GESClip *object, GESTrackEffect *effect);
gboolean ges_clip_set_top_effect_priority (GESClip *object, GESTrackEffect *effect, guint newpriority);
2012-11-27 16:54:54 +00:00
/* Editing */
2013-01-20 15:42:29 +00:00
GESClip *ges_clip_split (GESClip *object, guint64 position);
void ges_clip_objects_set_locked (GESClip *object, gboolean locked);
2013-01-20 15:42:29 +00:00
gboolean ges_clip_edit (GESClip *object, GList *layers,
2012-11-27 16:54:54 +00:00
gint new_layer_priority, GESEditMode mode,
GESEdge edge, guint64 position);
2009-08-04 15:13:11 +00:00
G_END_DECLS
2013-01-20 15:42:29 +00:00
#endif /* _GES_CLIP */