Next big merge.
[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/gsttypes.h>
28 #include <gst/gstbin.h>
29 #include <gst/gstbus.h>
30
31 G_BEGIN_DECLS
32
33 #define GST_TYPE_PIPELINE               (gst_pipeline_get_type ())
34 #define GST_PIPELINE(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PIPELINE, GstPipeline))
35 #define GST_IS_PIPELINE(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PIPELINE))
36 #define GST_PIPELINE_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PIPELINE, GstPipelineClass))
37 #define GST_IS_PIPELINE_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PIPELINE))
38 #define GST_PIPELINE_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PIPELINE, GstPipelineClass))
39
40 typedef enum {
41   /* this pipeline works with a fixed clock */
42   GST_PIPELINE_FLAG_FIXED_CLOCK        = GST_BIN_FLAG_LAST,
43
44   /* padding */
45   GST_PIPELINE_FLAG_LAST               = GST_BIN_FLAG_LAST + 4
46 } GstPipelineFlags;
47
48 struct _GstPipeline {
49   GstBin         bin;
50
51   /*< public >*/ /* with LOCK */
52   GstClock      *fixed_clock;   /* fixed clock if any */
53   GstClockTime   stream_time;
54   GstClockTime   delay;
55   GstClockTime   play_timeout;
56
57   GList         *eosed;         /* list of elements that posted EOS */
58
59   /*< private >*/
60   gpointer _gst_reserved[GST_PADDING];
61 };
62
63 struct _GstPipelineClass {
64   GstBinClass parent_class;
65
66   /*< private >*/
67   gpointer _gst_reserved[GST_PADDING];
68 };
69
70 GType           gst_pipeline_get_type           (void);
71 GstElement*     gst_pipeline_new                (const gchar *name);
72
73 GstScheduler*   gst_pipeline_get_scheduler      (GstPipeline *pipeline);
74 GstBus*         gst_pipeline_get_bus            (GstPipeline *pipeline);
75
76 void            gst_pipeline_use_clock          (GstPipeline *pipeline, GstClock *clock);
77 void            gst_pipeline_set_clock          (GstPipeline *pipeline, GstClock *clock);
78 GstClock*       gst_pipeline_get_clock          (GstPipeline *pipeline);
79 void            gst_pipeline_auto_clock         (GstPipeline *pipeline);
80
81 G_END_DECLS
82
83 #endif /* __GST_PIPELINE_H__ */
84