gstreamer/ges/ges-track-element.h
Thibault Saunier 20f76fe86f trackelement: Add a lookup_child vmethod
This method can be used for subclass to override the default behaviour
for child lookup. This vmethod can be used for example in the case where
you want the name of a child property to be 'overridden'.

As an example in the GESTitleSource where we have a videotestsrc
which has a 'foreground-color' property that is used in the TitleSource
to set the background color of the title, this vmethod is now used to
tweak the name passed as parameter to rename "background" to
"foreground-backend" making our API understandable.

API:
  GESTrackElement::lookup_child

https://bugzilla.gnome.org/show_bug.cgi?id=727880
2014-11-10 16:22:41 +01:00

213 lines
8.7 KiB
C

/* GStreamer Editing Services
* Copyright (C) 2009 Edward Hervey <edward.hervey@collabora.co.uk>
* 2009 Nokia Corporation
*
* 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
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef _GES_TRACK_ELEMENT
#define _GES_TRACK_ELEMENT
#include <glib-object.h>
#include <gst/gst.h>
#include <ges/ges-types.h>
#include <ges/ges-clip.h>
#include <ges/ges-track.h>
#include <gst/controller/gstdirectcontrolbinding.h>
#include <gst/controller/gstinterpolationcontrolsource.h>
G_BEGIN_DECLS
#define GES_TYPE_TRACK_ELEMENT ges_track_element_get_type()
#define GES_TRACK_ELEMENT(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), GES_TYPE_TRACK_ELEMENT, GESTrackElement))
#define GES_TRACK_ELEMENT_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), GES_TYPE_TRACK_ELEMENT, GESTrackElementClass))
#define GES_IS_TRACK_ELEMENT(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GES_TYPE_TRACK_ELEMENT))
#define GES_IS_TRACK_ELEMENT_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), GES_TYPE_TRACK_ELEMENT))
#define GES_TRACK_ELEMENT_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_ELEMENT, GESTrackElementClass))
typedef struct _GESTrackElementPrivate GESTrackElementPrivate;
/**
* GESTrackElement:
*
* The GESTrackElement base class.
*/
struct _GESTrackElement {
GESTimelineElement parent;
/*< private >*/
gboolean active;
GESTrackElementPrivate *priv;
GESAsset *asset;
/* Padding for API extension */
gpointer _ges_reserved[GES_PADDING_LARGE];
};
/**
* GESTrackElementClass:
* @nleobject_factorytype: name of the GNonLin GStElementFactory type to use.
* @create_nle_object: method to create the GNonLin container object.
* @create_element: method to return the GstElement to put in the nleobject.
* @active_changed: active property of nleobject has changed
* @list_children_properties: method to get children properties that user could
* like to configure.
* The default implementation will create an object
* of type @nleobject_factorytype and call
* @create_element.
* @lookup_child: method letting subclasses look for a child, overriding the
* simple standard behaviour. This vmethod can be used for example
* in the case where you want the name of a child property to be
* 'overriden'. A good example of where it is usefull is the
* GESTitleSource where we have a videotestsrc which has a
* 'foreground-color' property that is used in the TitleSource to
* set the background color of the title, in that case, this method
* has been overriden so that we tweak the name passed has parametter
* to rename "background" to "foreground-backend" making our API
* understandable.
*
* Subclasses can override the @create_nle_object method to override what type
* of GNonLin object will be created.
*/
struct _GESTrackElementClass {
/*< private >*/
GESTimelineElementClass parent_class;
/*< public >*/
/* virtual methods for subclasses */
const gchar *nleobject_factorytype;
GstElement* (*create_nle_object) (GESTrackElement * object);
GstElement* (*create_element) (GESTrackElement * object);
void (*active_changed) (GESTrackElement *object, gboolean active);
/*< private >*/
/* signals (currently unused) */
void (*changed) (GESTrackElement * object);
/*< public >*/
/* virtual methods for subclasses */
GParamSpec** (*list_children_properties) (GESTrackElement * object,
guint *n_properties);
gboolean (*lookup_child) (GESTrackElement *object,
const gchar *prop_name,
GstElement **element,
GParamSpec **pspec);
/*< private >*/
/* Padding for API extension */
gpointer _ges_reserved[GES_PADDING_LARGE];
};
GType ges_track_element_get_type (void);
GESTrack* ges_track_element_get_track (GESTrackElement * object);
GESTrackType ges_track_element_get_track_type (GESTrackElement * object);
void ges_track_element_set_track_type (GESTrackElement * object,
GESTrackType type);
GstElement * ges_track_element_get_nleobject (GESTrackElement * object);
GstElement * ges_track_element_get_element (GESTrackElement * object);
gboolean ges_track_element_set_active (GESTrackElement * object,
gboolean active);
gboolean ges_track_element_is_active (GESTrackElement * object);
GParamSpec **
ges_track_element_list_children_properties (GESTrackElement *object,
guint *n_properties);
gboolean ges_track_element_lookup_child (GESTrackElement *object,
const gchar *prop_name,
GstElement **element,
GParamSpec **pspec);
void
ges_track_element_get_child_property_by_pspec (GESTrackElement * object,
GParamSpec * pspec,
GValue * value);
void
ges_track_element_get_child_property_valist (GESTrackElement * object,
const gchar * first_property_name,
va_list var_args);
void ges_track_element_get_child_properties (GESTrackElement *object,
const gchar * first_property_name,
...) G_GNUC_NULL_TERMINATED;
void
ges_track_element_set_child_property_valist (GESTrackElement * object,
const gchar * first_property_name,
va_list var_args);
void
ges_track_element_set_child_property_by_pspec (GESTrackElement * object,
GParamSpec * pspec,
GValue * value);
void ges_track_element_set_child_properties (GESTrackElement * object,
const gchar * first_property_name,
...) G_GNUC_NULL_TERMINATED;
gboolean ges_track_element_set_child_property (GESTrackElement *object,
const gchar *property_name,
GValue * value);
gboolean ges_track_element_get_child_property (GESTrackElement *object,
const gchar *property_name,
GValue * value);
gboolean
ges_track_element_edit (GESTrackElement * object,
GList *layers, GESEditMode mode,
GESEdge edge, guint64 position);
gboolean
ges_track_element_set_control_source (GESTrackElement *object,
GstControlSource *source,
const gchar *property_name,
const gchar *binding_type);
GstControlBinding *
ges_track_element_get_control_binding (GESTrackElement *object,
const gchar *property_name);
void
ges_track_element_add_children_props (GESTrackElement *self,
GstElement *element,
const gchar ** wanted_categories,
const gchar **blacklist,
const gchar **whitelist);
GHashTable *
ges_track_element_get_all_control_bindings (GESTrackElement * trackelement);
G_END_DECLS
#endif /* _GES_TRACK_ELEMENT */