gstpipeline.h 4.03 KB
Newer Older
1 2 3 4 5
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wtay@chello.be>
 *
 * gstpipeline.h: Header for GstPipeline element
Erik Walthinsen's avatar
Erik Walthinsen committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
 *
 * 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 __GST_PIPELINE_H__
#define __GST_PIPELINE_H__

#include <gst/gstbin.h>

29
G_BEGIN_DECLS
30

Wim Taymans's avatar
Wim Taymans committed
31 32 33 34 35 36
#define GST_TYPE_PIPELINE 		(gst_pipeline_get_type ())
#define GST_PIPELINE(obj) 		(G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PIPELINE, GstPipeline))
#define GST_IS_PIPELINE(obj) 		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PIPELINE))
#define GST_PIPELINE_CLASS(klass) 	(G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PIPELINE, GstPipelineClass))
#define GST_IS_PIPELINE_CLASS(klass) 	(G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PIPELINE))
#define GST_PIPELINE_GET_CLASS(obj) 	(G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PIPELINE, GstPipelineClass))
37
#define GST_PIPELINE_CAST(obj) 		((GstPipeline*)(obj))
38

Wim Taymans's avatar
Wim Taymans committed
39 40
typedef struct _GstPipeline GstPipeline;
typedef struct _GstPipelineClass GstPipelineClass;
41
typedef struct _GstPipelinePrivate GstPipelinePrivate;
Wim Taymans's avatar
Wim Taymans committed
42

43 44 45 46 47 48 49
/**
 * GstPipelineFlags:
 * @GST_PIPELINE_FLAG_FIXED_CLOCK: this pipeline works with a fixed clock
 * @GST_PIPELINE_FLAG_LAST: offset to define more flags
 *
 * Pipeline flags
 */
50
typedef enum {
51
  GST_PIPELINE_FLAG_FIXED_CLOCK        = (GST_BIN_FLAG_LAST << 0),
52
  /* padding */
53
  GST_PIPELINE_FLAG_LAST               = (GST_BIN_FLAG_LAST << 4)
54
} GstPipelineFlags;
Erik Walthinsen's avatar
Erik Walthinsen committed
55

Wim Taymans's avatar
Wim Taymans committed
56 57 58 59
/**
 * GstPipeline:
 * @fixed_clock: The fixed clock of the pipeline, used when 
 *               GST_PIPELINE_FLAG_FIXED_CLOCK is set.
60 61
 * @stream_time: The stream time of the pipeline. A better name for this
 *         property would be the running_time, the total time spent in the
62 63
 *         PLAYING state without being flushed. (deprecated, use the start_time
 *         on GstElement).
64
 * @delay: Extra delay added to base_time to compensate for computing delays
Wim Taymans's avatar
Wim Taymans committed
65 66 67 68
 *         when setting elements to PLAYING.
 *
 * The #GstPipeline structure.
 */
69 70
struct _GstPipeline {
  GstBin 	 bin;
Wim Taymans's avatar
Wim Taymans committed
71

72
  /*< public >*/ /* with LOCK */
73 74 75
  GstClock      *fixed_clock;

  GstClockTime   stream_time;	
76 77 78
  GstClockTime   delay;

  /*< private >*/
79
  GstPipelinePrivate *priv;
Wim Taymans's avatar
Wim Taymans committed
80

81
  gpointer _gst_reserved[GST_PADDING-1];
Erik Walthinsen's avatar
Erik Walthinsen committed
82 83
};

84
struct _GstPipelineClass {
Erik Walthinsen's avatar
Erik Walthinsen committed
85
  GstBinClass parent_class;
Wim Taymans's avatar
Wim Taymans committed
86

87
  /*< private >*/
88
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
89 90
};

91
GType		gst_pipeline_get_type		(void);
92
GstElement*	gst_pipeline_new		(const gchar *name) G_GNUC_MALLOC;
93

Wim Taymans's avatar
Wim Taymans committed
94
GstBus*		gst_pipeline_get_bus		(GstPipeline *pipeline);
95

96
#ifndef GST_DISABLE_DEPRECATED
97 98
void		gst_pipeline_set_new_stream_time  (GstPipeline *pipeline, GstClockTime time);
GstClockTime	gst_pipeline_get_last_stream_time (GstPipeline *pipeline);
99
#endif
100

101
void            gst_pipeline_use_clock          (GstPipeline *pipeline, GstClock *clock);
102
gboolean        gst_pipeline_set_clock          (GstPipeline *pipeline, GstClock *clock);
103 104 105
GstClock*       gst_pipeline_get_clock          (GstPipeline *pipeline);
void            gst_pipeline_auto_clock         (GstPipeline *pipeline);

Wim Taymans's avatar
Wim Taymans committed
106 107 108
void            gst_pipeline_set_delay          (GstPipeline *pipeline, GstClockTime delay);
GstClockTime    gst_pipeline_get_delay          (GstPipeline *pipeline);

109 110 111
void            gst_pipeline_set_auto_flush_bus (GstPipeline *pipeline, gboolean auto_flush);
gboolean        gst_pipeline_get_auto_flush_bus (GstPipeline *pipeline);

112
G_END_DECLS
113

Wim Taymans's avatar
Wim Taymans committed
114
#endif /* __GST_PIPELINE_H__ */
115