gstreamer/ges/ges-track.h

/* 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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef _GES_TRACK
#define _GES_TRACK

#include <glib-object.h>
#include <gst/gst.h>
#include <ges/ges-types.h>
#include <ges/ges-enums.h>

G_BEGIN_DECLS

#define GES_TYPE_TRACK ges_track_get_type()

#define GES_TRACK(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GES_TYPE_TRACK, GESTrack))

#define GES_TRACK_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST ((klass), GES_TYPE_TRACK, GESTrackClass))

#define GES_IS_TRACK(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GES_TYPE_TRACK))

#define GES_IS_TRACK_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), GES_TYPE_TRACK))

#define GES_TRACK_GET_CLASS(obj) \
  (G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK, GESTrackClass))

typedef struct _GESTrackPrivate GESTrackPrivate;

/**
 * GESCreateElementForGapFunc:
 * @track: the #GESTrack
 *
 * A function that will be called to create the #GstElement that will be used
 * as a source to fill the gaps in @track.
 *
 * Returns: A #GstElement (must be a source) that will be used to
 * fill the gaps (periods of time in @track that containes no source).
 */
typedef GstElement* (*GESCreateElementForGapFunc) (GESTrack *track);

/**
 * GESTrack:
 * @type: a #GESTrackType indicting the basic type of the track.
 *
 */

struct _GESTrack {
  GstBin parent;

  /*< public >*/
  /* READ-ONLY */
  GESTrackType type;

  /*< private >*/
  GESTrackPrivate * priv;

  /* Padding for API extension */
  gpointer _ges_reserved[GES_PADDING];
};

/**
 * GESTrackClass:
 */

struct _GESTrackClass {
  /*< private >*/
  GstBinClass parent_class;

  /* Padding for API extension */
  gpointer _ges_reserved[GES_PADDING];
};

GType ges_track_get_type                  (void);

GESTrack* ges_track_new                   (GESTrackType type, GstCaps * caps);

void    ges_track_set_timeline            (GESTrack * track,
                                           GESTimeline *timeline);

void    ges_track_set_caps                (GESTrack * track,
                                           const GstCaps * caps);

const GstCaps * ges_track_get_caps        (GESTrack *track);

const GESTimeline *ges_track_get_timeline (GESTrack *track);

gboolean ges_track_add_object             (GESTrack * track,
                                           GESTrackObject * object);

gboolean ges_track_remove_object          (GESTrack * track,
                                           GESTrackObject * object);

GESTrack *ges_track_video_raw_new         (void);
GESTrack *ges_track_audio_raw_new         (void);

gboolean ges_track_enable_update          (GESTrack * track, gboolean enabled);
gboolean ges_track_is_updating            (GESTrack * track);

GList* ges_track_get_objects              (GESTrack *track);

void
ges_track_set_create_element_for_gap_func (GESTrack *track,
                                           GESCreateElementForGapFunc func);

G_END_DECLS

#endif /* _GES_TRACK */