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., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
24 #include "gst_private.h"
25 #include "glib-compat-private.h"
26 #include "gstparamspecs.h"
28 /* --- GstParamSpecFraction --- */
31 _gst_param_fraction_init (GParamSpec * pspec)
33 GstParamSpecFraction *fspec = GST_PARAM_SPEC_FRACTION (pspec);
37 fspec->max_num = G_MAXINT;
44 _gst_param_fraction_set_default (GParamSpec * pspec, GValue * value)
46 value->data[0].v_int = GST_PARAM_SPEC_FRACTION (pspec)->def_num;
47 value->data[1].v_int = GST_PARAM_SPEC_FRACTION (pspec)->def_den;
51 _gst_param_fraction_validate (GParamSpec * pspec, GValue * value)
53 GstParamSpecFraction *fspec = GST_PARAM_SPEC_FRACTION (pspec);
54 gboolean within_range = FALSE;
55 GValue f_this = { 0, };
56 GValue f_min = { 0, };
57 GValue f_max = { 0, };
60 g_value_init (&f_this, GST_TYPE_FRACTION);
61 gst_value_set_fraction (&f_this, value->data[0].v_int, value->data[1].v_int);
63 g_value_init (&f_min, GST_TYPE_FRACTION);
64 gst_value_set_fraction (&f_min, fspec->min_num, fspec->min_den);
66 g_value_init (&f_max, GST_TYPE_FRACTION);
67 gst_value_set_fraction (&f_max, fspec->max_num, fspec->max_den);
69 res = gst_value_compare (&f_min, &f_this);
70 #ifndef GST_DISABLE_GST_DEBUG
71 GST_LOG ("comparing %d/%d to %d/%d, result = %d", fspec->min_num,
72 fspec->min_den, value->data[0].v_int, value->data[1].v_int, res);
74 if (res != GST_VALUE_LESS_THAN && res != GST_VALUE_EQUAL)
77 #ifndef GST_DISABLE_GST_DEBUG
78 GST_LOG ("comparing %d/%d to %d/%d, result = %d", value->data[0].v_int,
79 value->data[1].v_int, fspec->max_num, fspec->max_den, res);
81 res = gst_value_compare (&f_this, &f_max);
82 if (res != GST_VALUE_LESS_THAN && res != GST_VALUE_EQUAL)
89 g_value_unset (&f_min);
90 g_value_unset (&f_max);
91 g_value_unset (&f_this);
93 #ifndef GST_DISABLE_GST_DEBUG
94 GST_LOG ("%swithin range", (within_range) ? "" : "not ");
97 /* return FALSE if everything ok, otherwise TRUE */
102 _gst_param_fraction_values_cmp (GParamSpec * pspec, const GValue * value1,
103 const GValue * value2)
107 res = gst_value_compare (value1, value2);
109 g_assert (res != GST_VALUE_UNORDERED);
111 /* GST_VALUE_LESS_THAN is -1, EQUAL is 0, and GREATER_THAN is 1 */
116 gst_param_spec_fraction_get_type (void)
118 static GType type; /* 0 */
120 /* register GST_TYPE_PARAM_FRACTION */
122 static GParamSpecTypeInfo pspec_info = {
123 sizeof (GstParamSpecFraction), /* instance_size */
125 _gst_param_fraction_init, /* instance_init */
126 G_TYPE_INVALID, /* value_type */
128 _gst_param_fraction_set_default, /* value_set_default */
129 _gst_param_fraction_validate, /* value_validate */
130 _gst_param_fraction_values_cmp, /* values_cmp */
132 pspec_info.value_type = GST_TYPE_FRACTION;
133 type = g_param_type_register_static ("GstParamFraction", &pspec_info);
139 * gst_param_spec_fraction:
140 * @name: canonical name of the property specified
141 * @nick: nick name for the property specified
142 * @blurb: description of the property specified
143 * @min_num: minimum value (fraction numerator)
144 * @min_denom: minimum value (fraction denominator)
145 * @max_num: maximum value (fraction numerator)
146 * @max_denom: maximum value (fraction denominator)
147 * @default_num: default value (fraction numerator)
148 * @default_denom: default value (fraction denominator)
149 * @flags: flags for the property specified
151 * This function creates a fraction GParamSpec for use by objects/elements
152 * that want to expose properties of fraction type. This function is typically
153 * used in connection with g_object_class_install_property() in a GObjects's
154 * instance_init function.
156 * Returns: a newly created parameter specification
161 gst_param_spec_fraction (const gchar * name, const gchar * nick,
162 const gchar * blurb, gint min_num, gint min_denom, gint max_num,
163 gint max_denom, gint default_num, gint default_denom, GParamFlags flags)
165 GstParamSpecFraction *fspec;
167 GValue default_val = { 0, };
170 g_param_spec_internal (GST_TYPE_PARAM_FRACTION, name, nick, blurb, flags);
172 fspec->min_num = min_num;
173 fspec->min_den = min_denom;
174 fspec->max_num = max_num;
175 fspec->max_den = max_denom;
176 fspec->def_num = default_num;
177 fspec->def_den = default_denom;
179 pspec = G_PARAM_SPEC (fspec);
181 /* check that min <= default <= max */
182 g_value_init (&default_val, GST_TYPE_FRACTION);
183 gst_value_set_fraction (&default_val, default_num, default_denom);
184 /* validate returns TRUE if the validation fails */
185 if (_gst_param_fraction_validate (pspec, &default_val)) {
186 g_critical ("GstParamSpec of type 'fraction' for property '%s' has a "
187 "default value of %d/%d, which is not within the allowed range of "
188 "%d/%d to %d/%d", name, default_num, default_denom, min_num,
189 min_denom, max_num, max_denom);
190 g_param_spec_ref (pspec);
191 g_param_spec_sink (pspec);
192 g_param_spec_unref (pspec);
195 g_value_unset (&default_val);