Merge remote-tracking branch 'origin/0.10'
[platform/upstream/gstreamer.git] / gst / gstvalue.h
1 /* GStreamer
2  * Copyright (C) <2003> David A. Schleef <ds@schleef.org>
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_VALUE_H__
21 #define __GST_VALUE_H__
22
23 #include <gst/gstconfig.h>
24 #include <gst/gstcaps.h>
25 #include <gst/gststructure.h>
26
27 G_BEGIN_DECLS
28
29 /**
30  * GST_MAKE_FOURCC:
31  * @a: the first character
32  * @b: the second character
33  * @c: the third character
34  * @d: the fourth character
35  *
36  * Transform four characters into a #guint32 fourcc value with host
37  * endianness.
38  * <informalexample>
39  * <programlisting>
40  * guint32 fourcc = GST_MAKE_FOURCC ('M', 'J', 'P', 'G');
41  * </programlisting>
42  * </informalexample>
43  */
44 #define GST_MAKE_FOURCC(a,b,c,d)        ((guint32)((a)|(b)<<8|(c)<<16|(d)<<24))
45
46 /**
47  * GST_STR_FOURCC:
48  * @f: a string with at least four characters
49  *
50  * Transform an input string into a #guint32 fourcc value with host
51  * endianness.
52  * Caller is responsible for ensuring the input string consists of at least
53  * four characters.
54  * <informalexample>
55  * <programlisting>
56  * guint32 fourcc = GST_STR_FOURCC ("MJPG");
57  * </programlisting>
58  * </informalexample>
59  */
60 #define GST_STR_FOURCC(f)               ((guint32)(((f)[0])|((f)[1]<<8)|((f)[2]<<16)|((f)[3]<<24)))
61
62 /**
63  * GST_FOURCC_FORMAT:
64  *
65  * Can be used together with #GST_FOURCC_ARGS to properly output a
66  * #guint32 fourcc value in a printf()-style text message.
67  * <informalexample>
68  * <programlisting>
69  * printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
70  * </programlisting>
71  * </informalexample>
72  */
73 #define GST_FOURCC_FORMAT "c%c%c%c"
74
75 /**
76  * GST_FOURCC_ARGS:
77  * @fourcc: a #guint32 fourcc value to output
78  *
79  * Can be used together with #GST_FOURCC_FORMAT to properly output a
80  * #guint32 fourcc value in a printf()-style text message.
81  */
82 #define GST_FOURCC_ARGS(fourcc) \
83         ((gchar) ((fourcc)     &0xff)), \
84         ((gchar) (((fourcc)>>8 )&0xff)), \
85         ((gchar) (((fourcc)>>16)&0xff)), \
86         ((gchar) (((fourcc)>>24)&0xff))
87
88 /**
89  * GST_VALUE_HOLDS_INT_RANGE:
90  * @x: the #GValue to check
91  *
92  * Checks if the given #GValue contains a #GST_TYPE_INT_RANGE value.
93  */
94 #define GST_VALUE_HOLDS_INT_RANGE(x)    (G_VALUE_HOLDS((x), gst_int_range_get_type ()))
95
96 /**
97  * GST_VALUE_HOLDS_INT64_RANGE:
98  * @x: the #GValue to check
99  *
100  * Checks if the given #GValue contains a #GST_TYPE_INT64_RANGE value.
101  *
102  * Since: 0.10.31
103  */
104 #define GST_VALUE_HOLDS_INT64_RANGE(x)    (G_VALUE_HOLDS((x), gst_int64_range_get_type ()))
105
106 /**
107  * GST_VALUE_HOLDS_DOUBLE_RANGE:
108  * @x: the #GValue to check
109  *
110  * Checks if the given #GValue contains a #GST_TYPE_DOUBLE_RANGE value.
111  */
112 #define GST_VALUE_HOLDS_DOUBLE_RANGE(x) (G_VALUE_HOLDS((x), gst_double_range_get_type ()))
113
114 /**
115  * GST_VALUE_HOLDS_FRACTION_RANGE:
116  * @x: the #GValue to check
117  *
118  * Checks if the given #GValue contains a #GST_TYPE_FRACTION_RANGE value.
119  */
120 #define GST_VALUE_HOLDS_FRACTION_RANGE(x)    (G_VALUE_HOLDS((x), gst_fraction_range_get_type ()))
121
122 /**
123  * GST_VALUE_HOLDS_LIST:
124  * @x: the #GValue to check
125  *
126  * Checks if the given #GValue contains a #GST_TYPE_LIST value.
127  */
128 #define GST_VALUE_HOLDS_LIST(x)         (G_VALUE_HOLDS((x), gst_value_list_get_type ()))
129
130 /**
131  * GST_VALUE_HOLDS_ARRAY:
132  * @x: the #GValue to check
133  *
134  * Checks if the given #GValue contains a #GST_TYPE_ARRAY value.
135  */
136 #define GST_VALUE_HOLDS_ARRAY(x)        (G_VALUE_HOLDS((x), gst_value_array_get_type ()))
137
138 /**
139  * GST_VALUE_HOLDS_CAPS:
140  * @x: the #GValue to check
141  *
142  * Checks if the given #GValue contains a #GST_TYPE_CAPS value.
143  */
144 #define GST_VALUE_HOLDS_CAPS(x)         (G_VALUE_HOLDS((x), GST_TYPE_CAPS))
145
146 /**
147  * GST_VALUE_HOLDS_STRUCTURE:
148  * @x: the #GValue to check
149  *
150  * Checks if the given #GValue contains a #GST_TYPE_STRUCTURE value.
151  *
152  * Since: 0.10.15
153  */
154 #define GST_VALUE_HOLDS_STRUCTURE(x)            (G_VALUE_HOLDS((x), GST_TYPE_STRUCTURE))
155
156 /**
157  * GST_VALUE_HOLDS_BUFFER:
158  * @x: the #GValue to check
159  *
160  * Checks if the given #GValue contains a #GST_TYPE_BUFFER value.
161  */
162 #define GST_VALUE_HOLDS_BUFFER(x)       (G_VALUE_HOLDS((x), GST_TYPE_BUFFER))
163
164 /**
165  * GST_VALUE_HOLDS_SAMPLE:
166  * @x: the #GValue to check
167  *
168  * Checks if the given #GValue contains a #GST_TYPE_SAMPLE value.
169  */
170 #define GST_VALUE_HOLDS_SAMPLE(x)       (G_VALUE_HOLDS((x), GST_TYPE_SAMPLE))
171
172 /**
173  * GST_VALUE_HOLDS_FRACTION:
174  * @x: the #GValue to check
175  *
176  * Checks if the given #GValue contains a #GST_TYPE_FRACTION value.
177  */
178 #define GST_VALUE_HOLDS_FRACTION(x)     (G_VALUE_HOLDS((x), gst_fraction_get_type ()))
179
180 /**
181  * GST_VALUE_HOLDS_DATE_TIME:
182  * @x: the #GValue to check
183  *
184  * Checks if the given #GValue contains a #GST_TYPE_DATE_TIME value.
185  *
186  * Since: 0.10.31
187  */
188 #define GST_VALUE_HOLDS_DATE_TIME(x)    (G_VALUE_HOLDS((x), gst_date_time_get_type ()))
189
190 /**
191  * GST_VALUE_HOLDS_BITMASK:
192  * @x: the #GValue to check
193  *
194  * Checks if the given #GValue contains a #GST_TYPE_BITMASK value.
195  */
196 #define GST_VALUE_HOLDS_BITMASK(x)      (G_VALUE_HOLDS((x), gst_bitmask_get_type ()))
197
198 /**
199  * GST_TYPE_INT_RANGE:
200  *
201  * a #GValue type that represents an integer range
202  *
203  * Returns: the #GType of GstIntRange
204  */
205 #define GST_TYPE_INT_RANGE               gst_int_range_get_type ()
206
207 /**
208  * GST_TYPE_INT64_RANGE:
209  *
210  * a #GValue type that represents an #gint64 range
211  *
212  * Returns: the #GType of GstInt64Range
213  *
214  * Since: 0.10.31
215  */
216 #define GST_TYPE_INT64_RANGE             gst_int64_range_get_type ()
217
218 /**
219  * GST_TYPE_DOUBLE_RANGE:
220  *
221  * a #GValue type that represents a floating point range with double precission
222  *
223  * Returns: the #GType of GstIntRange
224  */
225 #define GST_TYPE_DOUBLE_RANGE            gst_double_range_get_type ()
226
227 /**
228  * GST_TYPE_FRACTION_RANGE:
229  *
230  * a #GValue type that represents a GstFraction range
231  *
232  * Returns: the #GType of GstFractionRange
233  */
234 #define GST_TYPE_FRACTION_RANGE            gst_fraction_range_get_type ()
235
236 /**
237  * GST_TYPE_LIST:
238  *
239  * a #GValue type that represents an unordered list of #GValue values. This
240  * is used for example to express a list of possible values for a field in
241  * a caps structure, like a list of possible sample rates, of which only one
242  * will be chosen in the end. This means that all values in the list are
243  * meaningful on their own.
244  *
245  * Returns: the #GType of GstValueList (which is not explicitly typed)
246  */
247 #define GST_TYPE_LIST                    gst_value_list_get_type ()
248
249 /**
250  * GST_TYPE_ARRAY:
251  *
252  * a #GValue type that represents an ordered list of #GValue values. This is
253  * used to express a set of values that is meaningful only in their specific
254  * combination and order of values. Each value on its own is not particularly
255  * meaningful, only the ordered array in its entirety is meaningful. This is
256  * used for example to express channel layouts for multichannel audio where
257  * each channel needs to be mapped to a position in the room.
258  *
259  * Returns: the #GType of GstArrayList (which is not explicitly typed)
260  */
261 #define GST_TYPE_ARRAY                   gst_value_array_get_type ()
262
263 /**
264  * GST_TYPE_FRACTION:
265  *
266  * a #GValue type that represents a fraction of an integer numerator over
267  * an integer denominator
268  *
269  * Returns: the #GType of GstFraction (which is not explicitly typed)
270  */
271
272 #define GST_TYPE_FRACTION                gst_fraction_get_type ()
273
274 /**
275  * GST_TYPE_DATE_TIME:
276  *
277  * a boxed #GValue type for #GstDateTime that represents a date and time.
278  *
279  * Returns: the #GType of GstDateTime
280  * Since: 0.10.31
281  */
282
283 #define GST_TYPE_DATE_TIME               gst_date_time_get_type ()
284
285 /**
286  * GST_TYPE_BITMASK:
287  *
288  * a #GValue type that represents a 64-bit bitmask.
289  *
290  * Returns: the #GType of GstBitmask (which is not explicitly typed)
291  */
292
293 #define GST_TYPE_BITMASK                 gst_bitmask_get_type ()
294
295 /**
296  * GST_VALUE_LESS_THAN:
297  *
298  * Indicates that the first value provided to a comparison function
299  * (gst_value_compare()) is lesser than the second one.
300  */
301 #define GST_VALUE_LESS_THAN              (-1)
302
303 /**
304  * GST_VALUE_EQUAL:
305  *
306  * Indicates that the first value provided to a comparison function
307  * (gst_value_compare()) is equal to the second one.
308  */
309 #define GST_VALUE_EQUAL                   0
310
311 /**
312  * GST_VALUE_GREATER_THAN:
313  *
314  * Indicates that the first value provided to a comparison function
315  * (gst_value_compare()) is greater than the second one.
316  */
317 #define GST_VALUE_GREATER_THAN            1
318
319 /**
320  * GST_VALUE_UNORDERED:
321  *
322  * Indicates that the comparison function (gst_value_compare()) can not
323  * determine a order for the two provided values.
324  */
325 #define GST_VALUE_UNORDERED               2
326
327 /**
328  * GstValueCompareFunc:
329  * @value1: first value for comparison
330  * @value2: second value for comparison
331  *
332  * Used together with gst_value_compare() to compare #GValue items.
333  *
334  * Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL, GST_VALUE_GREATER_THAN
335  * or GST_VALUE_UNORDERED
336  */
337 typedef gint     (* GstValueCompareFunc)     (const GValue *value1,
338                                               const GValue *value2);
339
340 /**
341  * GstValueSerializeFunc:
342  * @value1: a #GValue
343  *
344  * Used by gst_value_serialize() to obtain a non-binary form of the #GValue.
345  *
346  * Free-function: g_free
347  *
348  * Returns: (transfer full): the string representation of the value
349  */
350 typedef gchar *  (* GstValueSerializeFunc)   (const GValue *value1);
351
352 /**
353  * GstValueDeserializeFunc:
354  * @dest: a #GValue
355  * @s: a string
356  *
357  * Used by gst_value_deserialize() to parse a non-binary form into the #GValue.
358  *
359  * Returns: %TRUE for success
360  */
361 typedef gboolean (* GstValueDeserializeFunc) (GValue       *dest,
362                                               const gchar  *s);
363
364 typedef struct _GstValueTable GstValueTable;
365 /**
366  * GstValueTable:
367  * @type: a #GType
368  * @compare: a #GstValueCompareFunc
369  * @serialize: a #GstValueSerializeFunc
370  * @deserialize: a #GstValueDeserializeFunc
371  *
372  * VTable for the #GValue @type.
373  */
374 struct _GstValueTable {
375   GType type;
376   GstValueCompareFunc compare;
377   GstValueSerializeFunc serialize;
378   GstValueDeserializeFunc deserialize;
379
380   /*< private >*/
381   gpointer _gst_reserved [GST_PADDING];
382 };
383
384 GType gst_int_range_get_type (void);
385 GType gst_int64_range_get_type (void);
386 GType gst_double_range_get_type (void);
387 GType gst_fraction_range_get_type (void);
388 GType gst_fraction_get_type (void);
389 GType gst_value_list_get_type (void);
390 GType gst_value_array_get_type (void);
391 GType gst_bitmask_get_type (void);
392
393 GType gst_date_time_get_type (void);
394
395 void            gst_value_register              (const GstValueTable   *table);
396 void            gst_value_init_and_copy         (GValue                *dest,
397                                                  const GValue          *src);
398
399 gchar *         gst_value_serialize             (const GValue          *value) G_GNUC_MALLOC;
400 gboolean        gst_value_deserialize           (GValue                *dest,
401                                                  const gchar           *src);
402
403 /* list */
404 void            gst_value_list_append_value     (GValue         *value,
405                                                  const GValue   *append_value);
406 void            gst_value_list_prepend_value    (GValue         *value,
407                                                  const GValue   *prepend_value);
408 void            gst_value_list_concat           (GValue         *dest,
409                                                  const GValue   *value1,
410                                                  const GValue   *value2);
411 void            gst_value_list_merge            (GValue         *dest,
412                                                  const GValue   *value1,
413                                                  const GValue   *value2);
414 guint           gst_value_list_get_size         (const GValue   *value);
415 const GValue *  gst_value_list_get_value        (const GValue   *value,
416                                                  guint          index);
417
418 /* array */
419 void            gst_value_array_append_value    (GValue         *value,
420                                                  const GValue   *append_value);
421 void            gst_value_array_prepend_value   (GValue         *value,
422                                                  const GValue   *prepend_value);
423 guint           gst_value_array_get_size        (const GValue   *value);
424 const GValue *  gst_value_array_get_value       (const GValue   *value,
425                                                  guint          index);
426
427 /* int range */
428 void            gst_value_set_int_range         (GValue         *value,
429                                                  gint           start,
430                                                  gint           end);
431 void            gst_value_set_int_range_step    (GValue         *value,
432                                                  gint           start,
433                                                  gint           end,
434                                                  gint           step);
435 gint            gst_value_get_int_range_min     (const GValue   *value);
436 gint            gst_value_get_int_range_max     (const GValue   *value);
437 gint            gst_value_get_int_range_step    (const GValue   *value);
438
439 /* int64 range */
440 void            gst_value_set_int64_range       (GValue         *value,
441                                                  gint64         start,
442                                                  gint64         end);
443 void            gst_value_set_int64_range_step  (GValue         *value,
444                                                  gint64         start,
445                                                  gint64         end,
446                                                  gint64         step);
447 gint64          gst_value_get_int64_range_min   (const GValue   *value);
448 gint64          gst_value_get_int64_range_max   (const GValue   *value);
449 gint64          gst_value_get_int64_range_step  (const GValue   *value);
450
451 /* double range */
452 void            gst_value_set_double_range      (GValue         *value,
453                                                  gdouble        start,
454                                                  gdouble        end);
455 gdouble         gst_value_get_double_range_min  (const GValue   *value);
456 gdouble         gst_value_get_double_range_max  (const GValue   *value);
457
458 /* caps */
459 const GstCaps * gst_value_get_caps              (const GValue   *value);
460 void            gst_value_set_caps              (GValue         *value,
461                                                  const GstCaps  *caps);
462
463 /* structure */
464 const GstStructure *
465                 gst_value_get_structure         (const GValue   *value);
466 void            gst_value_set_structure         (GValue         *value,
467                                                  const GstStructure  *structure);
468
469 /* fraction */
470 void            gst_value_set_fraction          (GValue         *value,
471                                                  gint           numerator,
472                                                  gint           denominator);
473 gint            gst_value_get_fraction_numerator   (const GValue  *value);
474 gint            gst_value_get_fraction_denominator (const GValue *value);
475 gboolean        gst_value_fraction_multiply        (GValue         *product,
476                                                     const GValue   *factor1,
477                                                     const GValue   *factor2);
478 gboolean        gst_value_fraction_subtract     (GValue * dest,
479                                                  const GValue * minuend,
480                                                  const GValue * subtrahend);
481
482 /* fraction range */
483 void            gst_value_set_fraction_range    (GValue         *value,
484                                                  const GValue   *start,
485                                                  const GValue   *end);
486 void            gst_value_set_fraction_range_full (GValue       *value,
487                                                  gint numerator_start,
488                                                  gint denominator_start,
489                                                  gint numerator_end,
490                                                  gint denominator_end);
491 const GValue    *gst_value_get_fraction_range_min (const GValue *value);
492 const GValue    *gst_value_get_fraction_range_max (const GValue *value);
493
494 /* bitmask */
495 guint64         gst_value_get_bitmask           (const GValue   *value);
496 void            gst_value_set_bitmask           (GValue         *value,
497                                                  guint64         bitmask);
498
499 /* compare */
500 gint            gst_value_compare               (const GValue   *value1,
501                                                  const GValue   *value2);
502 gboolean        gst_value_can_compare           (const GValue   *value1,
503                                                  const GValue   *value2);
504 gboolean        gst_value_is_subset             (const GValue   *value1,
505                                                  const GValue   *value2);
506
507 /* union */
508 gboolean        gst_value_union                 (GValue         *dest,
509                                                  const GValue   *value1,
510                                                  const GValue   *value2);
511 gboolean        gst_value_can_union             (const GValue   *value1,
512                                                  const GValue   *value2);
513
514 /* intersection */
515 gboolean        gst_value_intersect             (GValue         *dest,
516                                                  const GValue   *value1,
517                                                  const GValue   *value2);
518 gboolean        gst_value_can_intersect         (const GValue   *value1,
519                                                  const GValue   *value2);
520
521 /* subtraction */
522 gboolean        gst_value_subtract              (GValue         *dest,
523                                                  const GValue   *minuend,
524                                                  const GValue   *subtrahend);
525 gboolean        gst_value_can_subtract          (const GValue   *minuend,
526                                                  const GValue   *subtrahend);
527
528 /* fixation */
529 gboolean        gst_value_is_fixed              (const GValue   *value);
530 gboolean        gst_value_fixate                (GValue         *dest,
531                                                  const GValue   *src);
532
533 G_END_DECLS
534
535 #endif
536
537