moap ignore
[platform/upstream/gstreamer.git] / gst / gstpipeline.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstpipeline.h: Header for GstPipeline element
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23
24 #ifndef __GST_PIPELINE_H__
25 #define __GST_PIPELINE_H__
26
27 #include <gst/gstbin.h>
28
29 G_BEGIN_DECLS
30
31 #define GST_TYPE_PIPELINE               (gst_pipeline_get_type ())
32 #define GST_PIPELINE(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PIPELINE, GstPipeline))
33 #define GST_IS_PIPELINE(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PIPELINE))
34 #define GST_PIPELINE_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PIPELINE, GstPipelineClass))
35 #define GST_IS_PIPELINE_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PIPELINE))
36 #define GST_PIPELINE_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PIPELINE, GstPipelineClass))
37
38 typedef struct _GstPipeline GstPipeline;
39 typedef struct _GstPipelineClass GstPipelineClass;
40 typedef struct _GstPipelinePrivate GstPipelinePrivate;
41
42 /**
43  * GstPipelineFlags:
44  * @GST_PIPELINE_FLAG_FIXED_CLOCK: this pipeline works with a fixed clock
45  * @GST_PIPELINE_FLAG_LAST: offset to define more flags
46  *
47  * Pipeline flags
48  */
49 typedef enum {
50   GST_PIPELINE_FLAG_FIXED_CLOCK        = (GST_BIN_FLAG_LAST << 0),
51   /* padding */
52   GST_PIPELINE_FLAG_LAST               = (GST_BIN_FLAG_LAST << 4)
53 } GstPipelineFlags;
54
55 /**
56  * GstPipeline:
57  * @fixed_clock: The fixed clock of the pipeline, used when 
58  *               GST_PIPELINE_FLAG_FIXED_CLOCK is set.
59  * @stream_time: The stream time of the pipeline.
60  * @delay: Extra delay added to base time to compensate for delay
61  *         when setting elements to PLAYING.
62  *
63  * The #GstPipeline structure.
64  */
65 struct _GstPipeline {
66   GstBin         bin;
67
68   /*< public >*/ /* with LOCK */
69   GstClock      *fixed_clock;   /* fixed clock if any */
70   GstClockTime   stream_time;
71   GstClockTime   delay;
72
73   /*< private >*/
74   GstPipelinePrivate *priv;
75
76   gpointer _gst_reserved[GST_PADDING-1];
77 };
78
79 struct _GstPipelineClass {
80   GstBinClass parent_class;
81
82   /*< private >*/
83   gpointer _gst_reserved[GST_PADDING];
84 };
85
86 GType           gst_pipeline_get_type           (void);
87 GstElement*     gst_pipeline_new                (const gchar *name);
88
89 GstBus*         gst_pipeline_get_bus            (GstPipeline *pipeline);
90
91 void            gst_pipeline_set_new_stream_time  (GstPipeline *pipeline, GstClockTime time);
92 GstClockTime    gst_pipeline_get_last_stream_time (GstPipeline *pipeline);
93
94 void            gst_pipeline_use_clock          (GstPipeline *pipeline, GstClock *clock);
95 gboolean        gst_pipeline_set_clock          (GstPipeline *pipeline, GstClock *clock);
96 GstClock*       gst_pipeline_get_clock          (GstPipeline *pipeline);
97 void            gst_pipeline_auto_clock         (GstPipeline *pipeline);
98
99 void            gst_pipeline_set_delay          (GstPipeline *pipeline, GstClockTime delay);
100 GstClockTime    gst_pipeline_get_delay          (GstPipeline *pipeline);
101
102 void            gst_pipeline_set_auto_flush_bus (GstPipeline *pipeline, gboolean auto_flush);
103 gboolean        gst_pipeline_get_auto_flush_bus (GstPipeline *pipeline);
104
105 G_END_DECLS
106
107 #endif /* __GST_PIPELINE_H__ */
108