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., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
20 #ifndef __GST_PARAMSPECS_H__
21 #define __GST_PARAMSPECS_H__
23 #include <gst/gstvalue.h>
27 /* --- paramspec flags */
30 * GST_PARAM_CONTROLLABLE: (value 512)
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.
35 #define GST_PARAM_CONTROLLABLE (1 << (G_PARAM_USER_SHIFT + 1))
38 * GST_PARAM_MUTABLE_READY: (value 1024)
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.
43 #define GST_PARAM_MUTABLE_READY (1 << (G_PARAM_USER_SHIFT + 2))
46 * GST_PARAM_MUTABLE_PAUSED: (value 2048)
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.
52 #define GST_PARAM_MUTABLE_PAUSED (1 << (G_PARAM_USER_SHIFT + 3))
55 * GST_PARAM_MUTABLE_PLAYING: (value 4096)
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.
61 #define GST_PARAM_MUTABLE_PLAYING (1 << (G_PARAM_USER_SHIFT + 4))
64 * GST_PARAM_DOC_SHOW_DEFAULT: (value 8192)
66 * Use this flag on GObject properties of GstObject to indicate that
67 * during `gst-inspect` and friends, the default value should be used
68 * as default instead of the current value.
72 #define GST_PARAM_DOC_SHOW_DEFAULT (1 << (G_PARAM_USER_SHIFT + 5))
75 * GST_PARAM_CONDITIONALLY_AVAILABLE: (value 16384)
77 * Use this flag on GObject properties of GstObject to indicate that
78 * they might not be available depending on environment such as OS, device, etc,
79 * so such properties will be installed conditionally only if the GstObject is
84 #define GST_PARAM_CONDITIONALLY_AVAILABLE (1 << (G_PARAM_USER_SHIFT + 6))
87 * GST_PARAM_USER_SHIFT: (value 65536)
89 * Bits based on GST_PARAM_USER_SHIFT can be used by 3rd party applications.
91 #define GST_PARAM_USER_SHIFT (1 << (G_PARAM_USER_SHIFT + 8))
94 /* --- type macros --- */
99 * A fundamental type that describes a #GParamSpec for fractional
103 #define GST_TYPE_PARAM_FRACTION (gst_param_spec_fraction_get_type ())
104 #define GST_IS_PARAM_SPEC_FRACTION(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GST_TYPE_PARAM_FRACTION))
105 #define GST_PARAM_SPEC_FRACTION(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), GST_TYPE_PARAM_FRACTION, GstParamSpecFraction))
110 * A fundamental type that describes a #GParamSpec for arrays of
116 #define GST_TYPE_PARAM_ARRAY_LIST (gst_param_spec_array_get_type ())
117 #define GST_IS_PARAM_SPEC_ARRAY_LIST(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GST_TYPE_PARAM_ARRAY_LIST))
118 #define GST_PARAM_SPEC_ARRAY_LIST(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), GST_TYPE_PARAM_ARRAY_LIST, GstParamSpecArray))
121 /* --- get_type functions --- */
124 GType gst_param_spec_fraction_get_type (void);
127 GType gst_param_spec_array_get_type (void);
130 /* --- typedefs & structures --- */
132 typedef struct _GstParamSpecFraction GstParamSpecFraction;
133 typedef struct _GstParamSpecArray GstParamSpecArray;
136 * GstParamSpecFraction:
137 * @parent_instance: super class
138 * @min_num: minimal numerator
139 * @min_den: minimal denominator
140 * @max_num: maximal numerator
141 * @max_den: maximal denominator
142 * @def_num: default numerator
143 * @def_den: default denominator
145 * A GParamSpec derived structure that contains the meta data for fractional
148 struct _GstParamSpecFraction {
149 GParamSpec parent_instance;
151 gint min_num, min_den;
152 gint max_num, max_den;
153 gint def_num, def_den;
158 * @parent_instance: super class
159 * @element_spec: the #GParamSpec of the type of values in the array
161 * A GParamSpec derived structure for arrays of values.
163 struct _GstParamSpecArray {
164 GParamSpec parent_instance;
166 GParamSpec * element_spec;
170 /* --- GParamSpec prototypes --- */
173 GParamSpec * gst_param_spec_fraction (const gchar * name,
176 gint min_num, gint min_denom,
177 gint max_num, gint max_denom,
178 gint default_num, gint default_denom,
179 GParamFlags flags) G_GNUC_MALLOC;
181 GParamSpec * gst_param_spec_array (const gchar * name,
184 GParamSpec * element_spec,
185 GParamFlags flags) G_GNUC_MALLOC;
189 #endif /* __GST_PARAMSPECS_H__ */