1 /* GStreamer - GParamSpecs for some of our types
2 * Copyright (C) 2007 Tim-Philipp Müller <tim centricular net>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
20 * SECTION:gstparamspec
21 * @title: GstParamSpec
22 * @short_description: GParamSpec implementations specific
25 * GParamSpec implementations specific to GStreamer.
32 #include "gst_private.h"
33 #include "glib-compat-private.h"
34 #include "gstparamspecs.h"
36 /* --- GstParamSpecFraction --- */
39 _gst_param_fraction_init (GParamSpec * pspec)
41 GstParamSpecFraction *fspec = GST_PARAM_SPEC_FRACTION (pspec);
45 fspec->max_num = G_MAXINT;
52 _gst_param_fraction_set_default (GParamSpec * pspec, GValue * value)
54 value->data[0].v_int = GST_PARAM_SPEC_FRACTION (pspec)->def_num;
55 value->data[1].v_int = GST_PARAM_SPEC_FRACTION (pspec)->def_den;
59 _gst_param_fraction_validate (GParamSpec * pspec, GValue * value)
61 GstParamSpecFraction *fspec = GST_PARAM_SPEC_FRACTION (pspec);
62 gboolean within_range = FALSE;
63 GValue f_this = { 0, };
64 GValue f_min = { 0, };
65 GValue f_max = { 0, };
68 g_value_init (&f_this, GST_TYPE_FRACTION);
69 gst_value_set_fraction (&f_this, value->data[0].v_int, value->data[1].v_int);
71 g_value_init (&f_min, GST_TYPE_FRACTION);
72 gst_value_set_fraction (&f_min, fspec->min_num, fspec->min_den);
74 g_value_init (&f_max, GST_TYPE_FRACTION);
75 gst_value_set_fraction (&f_max, fspec->max_num, fspec->max_den);
77 res = gst_value_compare (&f_min, &f_this);
78 #ifndef GST_DISABLE_GST_DEBUG
79 GST_LOG ("comparing %d/%d to %d/%d, result = %d", fspec->min_num,
80 fspec->min_den, value->data[0].v_int, value->data[1].v_int, res);
82 if (res != GST_VALUE_LESS_THAN && res != GST_VALUE_EQUAL)
85 #ifndef GST_DISABLE_GST_DEBUG
86 GST_LOG ("comparing %d/%d to %d/%d, result = %d", value->data[0].v_int,
87 value->data[1].v_int, fspec->max_num, fspec->max_den, res);
89 res = gst_value_compare (&f_this, &f_max);
90 if (res != GST_VALUE_LESS_THAN && res != GST_VALUE_EQUAL)
97 g_value_unset (&f_min);
98 g_value_unset (&f_max);
99 g_value_unset (&f_this);
101 #ifndef GST_DISABLE_GST_DEBUG
102 GST_LOG ("%swithin range", (within_range) ? "" : "not ");
105 /* return FALSE if everything ok, otherwise TRUE */
106 return !within_range;
110 _gst_param_fraction_values_cmp (GParamSpec * pspec, const GValue * value1,
111 const GValue * value2)
115 res = gst_value_compare (value1, value2);
117 g_assert (res != GST_VALUE_UNORDERED);
119 /* GST_VALUE_LESS_THAN is -1, EQUAL is 0, and GREATER_THAN is 1 */
124 gst_param_spec_fraction_get_type (void)
126 static volatile GType gst_faction_type = 0;
128 /* register GST_TYPE_PARAM_FRACTION */
129 if (g_once_init_enter (&gst_faction_type)) {
131 static GParamSpecTypeInfo pspec_info = {
132 sizeof (GstParamSpecFraction), /* instance_size */
134 _gst_param_fraction_init, /* instance_init */
135 G_TYPE_INVALID, /* value_type */
137 _gst_param_fraction_set_default, /* value_set_default */
138 _gst_param_fraction_validate, /* value_validate */
139 _gst_param_fraction_values_cmp, /* values_cmp */
141 pspec_info.value_type = gst_fraction_get_type ();
142 type = g_param_type_register_static ("GstParamFraction", &pspec_info);
143 g_once_init_leave (&gst_faction_type, type);
146 return gst_faction_type;
150 * gst_param_spec_fraction:
151 * @name: canonical name of the property specified
152 * @nick: nick name for the property specified
153 * @blurb: description of the property specified
154 * @min_num: minimum value (fraction numerator)
155 * @min_denom: minimum value (fraction denominator)
156 * @max_num: maximum value (fraction numerator)
157 * @max_denom: maximum value (fraction denominator)
158 * @default_num: default value (fraction numerator)
159 * @default_denom: default value (fraction denominator)
160 * @flags: flags for the property specified
162 * This function creates a fraction GParamSpec for use by objects/elements
163 * that want to expose properties of fraction type. This function is typically
164 * used in connection with g_object_class_install_property() in a GObjects's
165 * instance_init function.
167 * Returns: (transfer full): a newly created parameter specification
170 gst_param_spec_fraction (const gchar * name, const gchar * nick,
171 const gchar * blurb, gint min_num, gint min_denom, gint max_num,
172 gint max_denom, gint default_num, gint default_denom, GParamFlags flags)
174 GstParamSpecFraction *fspec;
176 GValue default_val = { 0, };
179 g_param_spec_internal (GST_TYPE_PARAM_FRACTION, name, nick, blurb, flags);
181 fspec->min_num = min_num;
182 fspec->min_den = min_denom;
183 fspec->max_num = max_num;
184 fspec->max_den = max_denom;
185 fspec->def_num = default_num;
186 fspec->def_den = default_denom;
188 pspec = G_PARAM_SPEC (fspec);
190 /* check that min <= default <= max */
191 g_value_init (&default_val, GST_TYPE_FRACTION);
192 gst_value_set_fraction (&default_val, default_num, default_denom);
193 /* validate returns TRUE if the validation fails */
194 if (_gst_param_fraction_validate (pspec, &default_val)) {
195 g_critical ("GstParamSpec of type 'fraction' for property '%s' has a "
196 "default value of %d/%d, which is not within the allowed range of "
197 "%d/%d to %d/%d", name, default_num, default_denom, min_num,
198 min_denom, max_num, max_denom);
199 g_param_spec_ref (pspec);
200 g_param_spec_sink (pspec);
201 g_param_spec_unref (pspec);
204 g_value_unset (&default_val);
210 _gst_param_array_init (GParamSpec * pspec)
212 GstParamSpecArray *aspec = GST_PARAM_SPEC_ARRAY_LIST (pspec);
214 aspec->element_spec = NULL;
218 _gst_param_array_finalize (GParamSpec * pspec)
220 GstParamSpecArray *aspec = GST_PARAM_SPEC_ARRAY_LIST (pspec);
221 GParamSpecClass *parent_class =
222 g_type_class_peek (g_type_parent (GST_TYPE_PARAM_ARRAY_LIST));
224 if (aspec->element_spec) {
225 g_param_spec_unref (aspec->element_spec);
226 aspec->element_spec = NULL;
229 parent_class->finalize (pspec);
233 _gst_param_array_validate (GParamSpec * pspec, GValue * value)
235 GstParamSpecArray *aspec = GST_PARAM_SPEC_ARRAY_LIST (pspec);
237 /* ensure array values validity against a present element spec */
238 if (aspec->element_spec) {
239 GParamSpec *element_spec = aspec->element_spec;
242 for (i = 0; i < gst_value_array_get_size (value); i++) {
243 GValue *element = (GValue *) gst_value_array_get_value (value, i);
245 /* need to fixup value type, or ensure that the array value is initialized at all */
246 if (!g_value_type_compatible (G_VALUE_TYPE (element),
247 G_PARAM_SPEC_VALUE_TYPE (element_spec))) {
248 if (G_VALUE_TYPE (element) != 0)
249 g_value_unset (element);
250 g_value_init (element, G_PARAM_SPEC_VALUE_TYPE (element_spec));
251 g_param_value_set_default (element_spec, element);
254 /* validate array value against element_spec */
255 if (!g_param_value_validate (element_spec, element))
264 _gst_param_array_values_cmp (GParamSpec * pspec, const GValue * value1,
265 const GValue * value2)
267 GstParamSpecArray *aspec = GST_PARAM_SPEC_ARRAY_LIST (pspec);
270 if (!value1 || !value2)
271 return value2 ? -1 : value1 != value2;
273 size1 = gst_value_array_get_size (value1);
274 size2 = gst_value_array_get_size (value2);
277 return size1 < size2 ? -1 : 1;
278 else if (!aspec->element_spec) {
279 /* we need an element specification for comparisons, so there's not much
280 * to compare here, try to at least provide stable lesser/greater result
282 return size1 < size2 ? -1 : size1 > size2;
283 } else { /* size1 == size2 */
286 for (i = 0; i < size1; i++) {
287 const GValue *element1 = gst_value_array_get_value (value1, i);
288 const GValue *element2 = gst_value_array_get_value (value2, i);
291 /* need corresponding element types, provide stable result otherwise */
292 if (G_VALUE_TYPE (element1) != G_VALUE_TYPE (element2))
293 return G_VALUE_TYPE (element1) < G_VALUE_TYPE (element2) ? -1 : 1;
294 cmp = g_param_values_cmp (aspec->element_spec, element1, element2);
303 gst_param_spec_array_get_type (void)
305 static volatile GType gst_array_type = 0;
307 /* register GST_TYPE_PARAM_FRACTION */
308 if (g_once_init_enter (&gst_array_type)) {
310 static GParamSpecTypeInfo pspec_info = {
311 sizeof (GstParamSpecArray), /* instance_size */
313 _gst_param_array_init, /* instance_init */
314 G_TYPE_INVALID, /* value_type */
315 _gst_param_array_finalize, /* finalize */
316 NULL, /* value_set_default */
317 _gst_param_array_validate, /* value_validate */
318 _gst_param_array_values_cmp, /* values_cmp */
320 pspec_info.value_type = gst_value_array_get_type ();
321 type = g_param_type_register_static ("GstParamArray", &pspec_info);
322 g_once_init_leave (&gst_array_type, type);
325 return gst_array_type;
329 * gst_param_spec_array:
330 * @name: canonical name of the property specified
331 * @nick: nick name for the property specified
332 * @blurb: description of the property specified
333 * @element_spec: GParamSpec of the array
334 * @flags: flags for the property specified
336 * This function creates a GstArray GParamSpec for use by objects/elements
337 * that want to expose properties of GstArray type. This function is
338 * typically * used in connection with g_object_class_install_property() in a
339 * GObjects's instance_init function.
341 * Returns: (transfer full): a newly created parameter specification
345 gst_param_spec_array (const gchar * name,
347 const gchar * blurb, GParamSpec * element_spec, GParamFlags flags)
349 GstParamSpecArray *aspec;
352 g_return_val_if_fail (G_IS_PARAM_SPEC (element_spec), NULL);
354 aspec = g_param_spec_internal (GST_TYPE_PARAM_ARRAY_LIST,
355 name, nick, blurb, flags);
360 aspec->element_spec = g_param_spec_ref (element_spec);
361 g_param_spec_sink (element_spec);
364 return G_PARAM_SPEC (aspec);