3 * Copyright (C) <2005> Stefan Kost <ensonic at users dot sf dot net>
5 * gst-controller.h: dynamic parameter control subsystem
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.
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.
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.
23 #ifndef __GST_CONTROLLER_H__
24 #define __GST_CONTROLLER_H__
29 #include <glib-object.h>
30 #include <glib/gprintf.h>
36 * GST_PARAM_CONTROLLABLE:
38 * Use this flag on GstElement properties you wish to be (eventually) handled
40 * TODO: needs to go to gstelemnt.h (to avoid clashes on G_PARAM_USER_SHIFT)
42 #define GST_PARAM_CONTROLLABLE (1 << (G_PARAM_USER_SHIFT + 1))
48 * a structure for value+time
50 typedef struct _GstTimedValue
52 GstClockTime timestamp; /* timestamp of the value change */
53 GValue value; /* the new value */
54 /* TODO what about storing the difference to next timestamp and value here
55 + make calculations slightly easier and faster
56 - determining the GType for the value_dif is not simple
57 e.g. if value is G_TYPE_UCHAR value_diff needs to be G_TYPE_INT
64 * @property_name: the name of the property this array belongs to
65 * @nbsamples: number of samples requested
66 * @sample_interval: interval between each sample
67 * @values: pointer to the array
69 * Structure to receive multiple values at once.
70 * If the pointer to the values array is NULL, it will be allocated (CHECKME).
72 typedef struct _GstValueArray
76 GstClockTime sample_interval;
83 * @GST_INTERPOLATE_NONE: steps-like interpolation, default
84 * @GST_INTERPOLATE_TRIGGER: returns the default value of the property,
85 * except for times with specific values
86 * @GST_INTERPOLATE_LINEAR: linear interpolation
87 * @GST_INTERPOLATE_QUADRATIC: square interpolation
88 * @GST_INTERPOLATE_CUBIC: cubic interpolation
89 * @GST_INTERPOLATE_USER: user-provided interpolation
91 * The various interpolation modes available.
96 GST_INTERPOLATE_TRIGGER,
97 GST_INTERPOLATE_LINEAR,
98 GST_INTERPOLATE_QUADRATIC,
99 GST_INTERPOLATE_CUBIC,
101 } GstInterpolateMode;
104 struct _GstControlledProperty;
106 typedef GValue *(*InterpolateGet) (struct _GstControlledProperty * prop,
107 GstClockTime timestamp);
108 typedef gboolean (*InterpolateGetValueArray) (struct _GstControlledProperty * prop,
109 GstClockTime timestamp, GstValueArray * value_array);
112 * GstInterpolateMethod:
114 * Function pointer structure to do user-defined interpolation methods
116 typedef struct _GstInterpolateMethod
118 InterpolateGet get_int;
119 InterpolateGetValueArray get_int_value_array;
120 InterpolateGet get_long;
121 InterpolateGetValueArray get_long_value_array;
122 InterpolateGet get_float;
123 InterpolateGetValueArray get_float_value_array;
124 InterpolateGet get_double;
125 InterpolateGetValueArray get_double_value_array;
126 InterpolateGet get_boolean;
127 InterpolateGetValueArray get_boolean_value_array;
128 } GstInterpolateMethod;
131 * GstControlledProperty:
133 typedef struct _GstControlledProperty
135 gchar *name; /* name of the property */
136 GType type; /* type of the handled property */
137 GValue default_value; /* default value for the handled property */
138 GValue result_value; /* result value location for the interpolation method */
139 GstTimedValue last_value; /* the last value a _sink call wrote */
140 GstTimedValue live_value; /* temporary value override for live input */
141 gulong notify_handler_id; /* id of the notify::<name> signal handler */
142 GstInterpolateMode interpolation; /* Interpolation mode */
143 /* TODO instead of *method, have pointers to get() and get_value_array() here
144 gst_controller_set_interpolation_mode() will pick the right ones for the
145 properties value type
146 GstInterpolateMethod *method; // User-implemented handler (if interpolation == GST_INTERPOLATE_USER)
149 InterpolateGetValueArray get_value_array;
151 GList *values; /* List of GstTimedValue */
152 /* TODO keep the last search result to be able to continue
153 GList *last_value; // last search result, can be used for incremental searches
157 gpointer _gst_reserved[GST_PADDING];
158 } GstControlledProperty;
160 #define GST_CONTROLLED_PROPERTY(obj) ((GstControlledProperty *)(obj))
164 #define GST_TYPE_CONTROLLER (gst_controller_get_type ())
165 #define GST_CONTROLLER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_CONTROLLER, GstController))
166 #define GST_CONTROLLER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_CONTROLLER, GstControllerClass))
167 #define GST_IS_CONTROLLER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_CONTROLLER))
168 #define GST_IS_CONTROLLER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_CONTROLLERE))
169 #define GST_CONTROLLER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_CONTROLLER, GstControllerClass))
171 typedef struct _GstController GstController;
172 typedef struct _GstControllerClass GstControllerClass;
177 * The instance structure of GstController
180 struct _GstController
184 GList *properties; /* List of GstControlledProperty */
185 GMutex *lock; /* Secure property access, elements will access from threads */
186 GObject *object; /* the object we control */
189 gpointer _gst_reserved[GST_PADDING];
192 struct _GstControllerClass
194 GObjectClass parent_class;
197 gpointer _gst_reserved[GST_PADDING];
200 GType gst_controller_get_type (void);
202 /* GstController functions */
204 GstController *gst_controller_new_valist (GObject * object, va_list var_args);
205 GstController *gst_controller_new_list (GObject * object, GList *list);
206 GstController *gst_controller_new (GObject * object, ...);
208 gboolean gst_controller_remove_properties_valist (GstController * self,
210 gboolean gst_controller_remove_properties_list (GstController * self,
212 gboolean gst_controller_remove_properties (GstController * self, ...);
214 gboolean gst_controller_set (GstController * self, gchar * property_name,
215 GstClockTime timestamp, GValue * value);
216 gboolean gst_controller_set_from_list (GstController * self,
217 gchar * property_name, GSList * timedvalues);
219 gboolean gst_controller_unset (GstController * self, gchar * property_name,
220 GstClockTime timestamp);
223 GValue *gst_controller_get (GstController * self, gchar * property_name,
224 GstClockTime timestamp);
225 const GList *gst_controller_get_all (GstController * self,
226 gchar * property_name);
229 gboolean gst_controller_sync_values (GstController * self,
230 GstClockTime timestamp);
232 gboolean gst_controller_get_value_arrays (GstController * self,
233 GstClockTime timestamp, GSList * value_arrays);
234 gboolean gst_controller_get_value_array (GstController * self,
235 GstClockTime timestamp, GstValueArray * value_array);
237 gboolean gst_controller_set_interpolation_mode (GstController * self,
238 gchar * property_name, GstInterpolateMode mode);
241 /* GObject convenience functions */
243 GstController *gst_object_control_properties (GObject * object, ...);
244 gboolean gst_object_uncontrol_properties (GObject * object, ...);
246 GstController *gst_object_get_controller (GObject * object);
247 gboolean gst_object_set_controller (GObject * object, GstController * controller);
249 gboolean gst_object_sync_values (GObject * object, GstClockTime timestamp);
251 gboolean gst_object_get_value_arrays (GObject * object,
252 GstClockTime timestamp, GSList * value_arrays);
253 gboolean gst_object_get_value_array (GObject * object,
254 GstClockTime timestamp, GstValueArray * value_array);
258 gboolean gst_controller_init (int * argc, char ***argv);
261 #endif /* __GST_CONTROLLER_H__ */