gst/gstparamspecs.c

   1 /* GStreamer - GParamSpecs for some of our types
   2  * Copyright (C) 2007 Tim-Philipp Müller  <tim centricular net>
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #include "config.h"
  22 #endif
  23
  24 #include "gst_private.h"
  25 #include "glib-compat-private.h"
  26 #include "gstparamspecs.h"
  27
  28 /* --- GstParamSpecFraction --- */
  29
  30 static void
  31 _gst_param_fraction_init (GParamSpec * pspec)
  32 {
  33   GstParamSpecFraction *fspec = GST_PARAM_SPEC_FRACTION (pspec);
  34
  35   fspec->min_num = 0;
  36   fspec->min_den = 1;
  37   fspec->max_num = G_MAXINT;
  38   fspec->max_den = 1;
  39   fspec->def_num = 1;
  40   fspec->def_den = 1;
  41 }
  42
  43 static void
  44 _gst_param_fraction_set_default (GParamSpec * pspec, GValue * value)
  45 {
  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;
  48 }
  49
  50 static gboolean
  51 _gst_param_fraction_validate (GParamSpec * pspec, GValue * value)
  52 {
  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, };
  58   gint res;
  59
  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);
  62
  63   g_value_init (&f_min, GST_TYPE_FRACTION);
  64   gst_value_set_fraction (&f_min, fspec->min_num, fspec->min_den);
  65
  66   g_value_init (&f_max, GST_TYPE_FRACTION);
  67   gst_value_set_fraction (&f_max, fspec->max_num, fspec->max_den);
  68
  69   res = gst_value_compare (&f_min, &f_this);
  70   GST_LOG ("comparing %d/%d to %d/%d, result = %d", fspec->min_num,
  71       fspec->min_den, value->data[0].v_int, value->data[1].v_int, res);
  72   if (res != GST_VALUE_LESS_THAN && res != GST_VALUE_EQUAL)
  73     goto out;
  74
  75   GST_LOG ("comparing %d/%d to %d/%d, result = %d", value->data[0].v_int,
  76       value->data[1].v_int, fspec->max_num, fspec->max_den, res);
  77   res = gst_value_compare (&f_this, &f_max);
  78   if (res != GST_VALUE_LESS_THAN && res != GST_VALUE_EQUAL)
  79     goto out;
  80
  81   within_range = TRUE;
  82
  83 out:
  84
  85   g_value_unset (&f_min);
  86   g_value_unset (&f_max);
  87   g_value_unset (&f_this);
  88
  89   GST_LOG ("%swithin range", (within_range) ? "" : "not ");
  90
  91   /* return FALSE if everything ok, otherwise TRUE */
  92   return !within_range;
  93 }
  94
  95 static gint
  96 _gst_param_fraction_values_cmp (GParamSpec * pspec, const GValue * value1,
  97     const GValue * value2)
  98 {
  99   gint res;
 100
 101   res = gst_value_compare (value1, value2);
 102
 103   g_assert (res != GST_VALUE_UNORDERED);
 104
 105   /* GST_VALUE_LESS_THAN is -1, EQUAL is 0, and GREATER_THAN is 1 */
 106   return res;
 107 }
 108
 109 GType
 110 gst_param_spec_fraction_get_type (void)
 111 {
 112   static GType type;            /* 0 */
 113
 114   /* register GST_TYPE_PARAM_FRACTION */
 115   if (type == 0) {
 116     static GParamSpecTypeInfo pspec_info = {
 117       sizeof (GstParamSpecFraction),    /* instance_size     */
 118       0,                        /* n_preallocs       */
 119       _gst_param_fraction_init, /* instance_init     */
 120       G_TYPE_INVALID,           /* value_type        */
 121       NULL,                     /* finalize          */
 122       _gst_param_fraction_set_default,  /* value_set_default */
 123       _gst_param_fraction_validate,     /* value_validate    */
 124       _gst_param_fraction_values_cmp,   /* values_cmp        */
 125     };
 126     pspec_info.value_type = GST_TYPE_FRACTION;
 127     type = g_param_type_register_static ("GstParamFraction", &pspec_info);
 128   }
 129   return type;
 130 }
 131
 132 /**
 133  * gst_param_spec_fraction:
 134  * @name: canonical name of the property specified
 135  * @nick: nick name for the property specified
 136  * @blurb: description of the property specified
 137  * @min_num: minimum value (fraction numerator)
 138  * @min_denom: minimum value (fraction denominator)
 139  * @max_num: maximum value (fraction numerator)
 140  * @max_denom: maximum value (fraction denominator)
 141  * @default_num: default value (fraction numerator)
 142  * @default_denom: default value (fraction denominator)
 143  * @flags: flags for the property specified
 144  *
 145  * This function creates a fraction GParamSpec for use by objects/elements
 146  * that want to expose properties of fraction type. This function is typically
 147  * used in connection with g_object_class_install_property() in a GObjects's
 148  * instance_init function.
 149  *
 150  * Returns: a newly created parameter specification
 151  *
 152  * Since: 0.10.14
 153  */
 154 GParamSpec *
 155 gst_param_spec_fraction (const gchar * name, const gchar * nick,
 156     const gchar * blurb, gint min_num, gint min_denom, gint max_num,
 157     gint max_denom, gint default_num, gint default_denom, GParamFlags flags)
 158 {
 159   GstParamSpecFraction *fspec;
 160   GParamSpec *pspec;
 161   GValue default_val = { 0, };
 162
 163   fspec =
 164       g_param_spec_internal (GST_TYPE_PARAM_FRACTION, name, nick, blurb, flags);
 165
 166   fspec->min_num = min_num;
 167   fspec->min_den = min_denom;
 168   fspec->max_num = max_num;
 169   fspec->max_den = max_denom;
 170   fspec->def_num = default_num;
 171   fspec->def_den = default_denom;
 172
 173   pspec = G_PARAM_SPEC (fspec);
 174
 175   /* check that min <= default <= max */
 176   g_value_init (&default_val, GST_TYPE_FRACTION);
 177   gst_value_set_fraction (&default_val, default_num, default_denom);
 178   /* validate returns TRUE if the validation fails */
 179   if (_gst_param_fraction_validate (pspec, &default_val)) {
 180     g_critical ("GstParamSpec of type 'fraction' for property '%s' has a "
 181         "default value of %d/%d, which is not within the allowed range of "
 182         "%d/%d to %d/%d", name, default_num, default_denom, min_num,
 183         min_denom, max_num, max_denom);
 184     g_param_spec_ref (pspec);
 185     g_param_spec_sink (pspec);
 186     g_param_spec_unref (pspec);
 187     pspec = NULL;
 188   }
 189   g_value_unset (&default_val);
 190
 191   return pspec;
 192 }