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