controller: move GstControlledProperty into a separate class
[platform/upstream/gstreamer.git] / gst / gstcontrolbinding.h
1 /* GStreamer
2  *
3  * Copyright (C) 2011 Stefan Sauer <ensonic@users.sf.net>
4  *
5  * gstcontrolbinding.h: Attachment for control sources
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 #ifndef __GST_CONTROL_BINDING_H__
24 #define __GST_CONTROL_BINDING_H__
25
26 #include <gst/gstconfig.h>
27
28 #include <glib-object.h>
29
30 #include <gst/gstcontrolsource.h>
31
32 G_BEGIN_DECLS
33
34 #define GST_TYPE_CONTROL_BINDING \
35   (gst_control_binding_get_type())
36 #define GST_CONTROL_BINDING(obj) \
37   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_CONTROL_BINDING,GstControlBinding))
38 #define GST_CONTROL_BINDING_CLASS(klass) \
39   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_CONTROL_BINDING,GstControlBindingClass))
40 #define GST_IS_CONTROL_BINDING(obj) \
41   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_CONTROL_BINDING))
42 #define GST_IS_CONTROL_BINDING_CLASS(klass) \
43   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_CONTROL_BINDING))
44 #define GST_CONTROL_BINDING_GET_CLASS(obj) \
45   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_CONTOL_SOURCE, GstControlBindingClass))
46
47 typedef struct _GstControlBinding GstControlBinding;
48 typedef struct _GstControlBindingClass GstControlBindingClass;
49
50 /**
51  * GstControlBinding:
52  *
53  * The instance structure of #GstControlBinding.
54  */
55 struct _GstControlBinding {
56   GObject parent;
57
58   /*< public >*/
59   GParamSpec *pspec;            /* GParamSpec for this property */
60   const gchar *name;            /* name of the property */
61   GstControlSource *csource;    /* GstControlSource for this property */
62   gboolean disabled;
63   GValue cur_value, last_value;
64
65   /*< private >*/
66   gpointer _gst_reserved[GST_PADDING];
67 };
68
69 /**
70  * GstControlBindingClass:
71  * @parent_class: Parent class
72  *
73  * The class structure of #GstControlBinding.
74  */
75
76 struct _GstControlBindingClass
77 {
78   GObjectClass parent_class;
79
80   /*< private >*/
81   gpointer _gst_reserved[GST_PADDING];
82 };
83
84 GType gst_control_binding_get_type (void);
85
86 /* Functions */
87
88 GstControlBinding * gst_control_binding_new                (GstObject * object, const gchar * property_name,
89                                                             GstControlSource * csource);
90
91 gboolean            gst_control_binding_sync_values        (GstControlBinding * self, GstObject *object, 
92                                                             GstClockTime timestamp, GstClockTime last_sync);
93 GstControlSource *  gst_control_binding_get_control_source (GstControlBinding * self);
94 void                gst_control_binding_set_disabled       (GstControlBinding * self, gboolean disabled);
95 gboolean            gst_control_binding_is_disabled        (GstControlBinding * self);
96 G_END_DECLS
97
98 #endif /* __GST_CONTROL_BINDING_H__ */