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