gst/gstparamspecs.h

   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 #ifndef __GST_PARAMSPECS_H__
  21 #define __GST_PARAMSPECS_H__
  22
  23 #include <gst/gstvalue.h>
  24
  25 G_BEGIN_DECLS
  26
  27 /* --- paramspec flags */
  28
  29 /**
  30  * GST_PARAM_CONTROLLABLE: (value 512)
  31  *
  32  * Use this flag on GObject properties to signal they can make sense to be.
  33  * controlled over time. This hint is used by the GstController.
  34  */
  35 #define GST_PARAM_CONTROLLABLE  (1 << (G_PARAM_USER_SHIFT + 1))
  36
  37 /**
  38  * GST_PARAM_MUTABLE_READY: (value 1024)
  39  *
  40  * Use this flag on GObject properties of GstElements to indicate that
  41  * they can be changed when the element is in the READY or lower state.
  42  */
  43 #define GST_PARAM_MUTABLE_READY  (1 << (G_PARAM_USER_SHIFT + 2))
  44
  45 /**
  46  * GST_PARAM_MUTABLE_PAUSED: (value 2048)
  47  *
  48  * Use this flag on GObject properties of GstElements to indicate that
  49  * they can be changed when the element is in the PAUSED or lower state.
  50  * This flag implies GST_PARAM_MUTABLE_READY.
  51  */
  52 #define GST_PARAM_MUTABLE_PAUSED  (1 << (G_PARAM_USER_SHIFT + 3))
  53
  54 /**
  55  * GST_PARAM_MUTABLE_PLAYING: (value 4096)
  56  *
  57  * Use this flag on GObject properties of GstElements to indicate that
  58  * they can be changed when the element is in the PLAYING or lower state.
  59  * This flag implies GST_PARAM_MUTABLE_PAUSED.
  60  */
  61 #define GST_PARAM_MUTABLE_PLAYING  (1 << (G_PARAM_USER_SHIFT + 4))
  62
  63 /**
  64  * GST_PARAM_USER_SHIFT: (value 65536)
  65  *
  66  * Bits based on GST_PARAM_USER_SHIFT can be used by 3rd party applications.
  67  */
  68 #define GST_PARAM_USER_SHIFT    (1 << (G_PARAM_USER_SHIFT + 8))
  69
  70
  71 /* --- type macros --- */
  72
  73 #define GST_TYPE_PARAM_FRACTION           (gst_param_spec_fraction_get_type ())
  74 #define GST_IS_PARAM_SPEC_FRACTION(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GST_TYPE_PARAM_FRACTION))
  75 #define GST_PARAM_SPEC_FRACTION(pspec)    (G_TYPE_CHECK_INSTANCE_CAST ((pspec), GST_TYPE_PARAM_FRACTION, GstParamSpecFraction))
  76
  77
  78 #define GST_TYPE_PARAM_ARRAY_LIST           (gst_param_spec_array_get_type ())
  79 #define GST_IS_PARAM_SPEC_ARRAY_LIST(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GST_TYPE_PARAM_ARRAY_LIST))
  80 #define GST_PARAM_SPEC_ARRAY_LIST(pspec)    (G_TYPE_CHECK_INSTANCE_CAST ((pspec), GST_TYPE_PARAM_ARRAY_LIST, GstParamSpecArray))
  81
  82
  83 /* --- get_type functions --- */
  84
  85 GST_API
  86 GType  gst_param_spec_fraction_get_type (void);
  87
  88 GST_API
  89 GType  gst_param_spec_array_get_type (void);
  90
  91
  92 /* --- typedefs & structures --- */
  93
  94 typedef struct _GstParamSpecFraction GstParamSpecFraction;
  95 typedef struct _GstParamSpecArray GstParamSpecArray;
  96
  97 /**
  98  * GstParamSpecFraction:
  99  * @parent_instance: super class
 100  * @min_num: minimal numerator
 101  * @min_den: minimal denominator
 102  * @max_num: maximal numerator
 103  * @max_den: maximal denominator
 104  * @def_num: default numerator
 105  * @def_den: default denominator
 106  *
 107  * A GParamSpec derived structure that contains the meta data for fractional
 108  * properties.
 109  */
 110 struct _GstParamSpecFraction {
 111   GParamSpec    parent_instance;
 112
 113   gint          min_num, min_den;
 114   gint          max_num, max_den;
 115   gint          def_num, def_den;
 116 };
 117
 118 /**
 119  * GstParamSpecArray:
 120  * @parent_instance: super class
 121  * @element_spec: the #GParamSpec of the type of values in the array
 122  *
 123  * A GParamSpec derived structure for arrays of values.
 124  */
 125 struct _GstParamSpecArray {
 126   GParamSpec    parent_instance;
 127
 128   GParamSpec * element_spec;
 129 };
 130
 131
 132 /* --- GParamSpec prototypes --- */
 133
 134 GST_API
 135 GParamSpec  * gst_param_spec_fraction (const gchar * name,
 136                                        const gchar * nick,
 137                                        const gchar * blurb,
 138                                        gint min_num, gint min_denom,
 139                                        gint max_num, gint max_denom,
 140                                        gint default_num, gint default_denom,
 141                                        GParamFlags flags) G_GNUC_MALLOC;
 142 GST_API
 143 GParamSpec  * gst_param_spec_array    (const gchar * name,
 144                                        const gchar * nick,
 145                                        const gchar * blurb,
 146                                        GParamSpec * element_spec,
 147                                        GParamFlags flags) G_GNUC_MALLOC;
 148
 149 G_END_DECLS
 150
 151 #endif /* __GST_PARAMSPECS_H__ */
 152