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., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, 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:
  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:
  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  * Since: 0.10.23
  44  */
  45 #define GST_PARAM_MUTABLE_READY  (1 << (G_PARAM_USER_SHIFT + 2))
  46
  47 /**
  48  * GST_PARAM_MUTABLE_PAUSED:
  49  *
  50  * Use this flag on GObject properties of GstElements to indicate that
  51  * they can be changed when the element is in the PAUSED or lower state.
  52  * This flag implies GST_PARAM_MUTABLE_READY.
  53  *
  54  * Since: 0.10.23
  55  */
  56 #define GST_PARAM_MUTABLE_PAUSED  (1 << (G_PARAM_USER_SHIFT + 3))
  57
  58 /**
  59  * GST_PARAM_MUTABLE_PLAYING:
  60  *
  61  * Use this flag on GObject properties of GstElements to indicate that
  62  * they can be changed when the element is in the PLAYING or lower state.
  63  * This flag implies GST_PARAM_MUTABLE_PAUSED.
  64  *
  65  * Since: 0.10.23
  66  */
  67 #define GST_PARAM_MUTABLE_PLAYING  (1 << (G_PARAM_USER_SHIFT + 4))
  68
  69 /**
  70  * GST_PARAM_USER_SHIFT:
  71  *
  72  * Bits based on GST_PARAM_USER_SHIFT can be used by 3rd party applications.
  73  */
  74 #define GST_PARAM_USER_SHIFT    (1 << (G_PARAM_USER_SHIFT + 8))
  75
  76
  77 /* --- type macros --- */
  78
  79 #define GST_TYPE_PARAM_FRACTION           (gst_param_spec_fraction_get_type ())
  80 #define GST_IS_PARAM_SPEC_FRACTION(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GST_TYPE_PARAM_FRACTION))
  81 #define GST_PARAM_SPEC_FRACTION(pspec)    (G_TYPE_CHECK_INSTANCE_CAST ((pspec), GST_TYPE_PARAM_FRACTION, GstParamSpecFraction))
  82
  83
  84 /* --- get_type functions --- */
  85
  86 GType  gst_param_spec_fraction_get_type (void);
  87
  88
  89 /* --- typedefs & structures --- */
  90
  91 typedef struct _GstParamSpecFraction GstParamSpecFraction;
  92
  93 /**
  94  * GstParamSpecFraction:
  95  * @parent_instance: super class
  96  * @min_num: minimal numerator
  97  * @min_den: minimal denominator
  98  * @max_num: maximal numerator
  99  * @max_den: maximal denominator
 100  * @def_num: default numerator
 101  * @def_den: default denominator
 102  *
 103  * A GParamSpec derived structure that contains the meta data for fractional
 104  * properties.
 105  */
 106 struct _GstParamSpecFraction {
 107   GParamSpec    parent_instance;
 108
 109   gint          min_num, min_den;
 110   gint          max_num, max_den;
 111   gint          def_num, def_den;
 112 };
 113
 114
 115 /* --- GParamSpec prototypes --- */
 116
 117 GParamSpec  * gst_param_spec_fraction (const gchar * name,
 118                                        const gchar * nick,
 119                                        const gchar * blurb,
 120                                        gint min_num, gint min_denom,
 121                                        gint max_num, gint max_denom,
 122                                        gint default_num, gint default_denom,
 123                                        GParamFlags flags) G_GNUC_MALLOC;
 124
 125 G_END_DECLS
 126
 127 #endif /* __GST_PARAMSPECS_H__ */
 128