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_FRACTION:
 166  * @x: the #GValue to check
 167  *
 168  * Checks if the given #GValue contains a #GST_TYPE_FRACTION value.
 169  */
 170 #define GST_VALUE_HOLDS_FRACTION(x)     (G_VALUE_HOLDS((x), gst_fraction_get_type ()))
 171
 172 /**
 173  * GST_VALUE_HOLDS_DATE:
 174  * @x: the #GValue to check
 175  *
 176  * Checks if the given #GValue contains a #GST_TYPE_DATE value.
 177  */
 178 #define GST_VALUE_HOLDS_DATE(x)         (G_VALUE_HOLDS((x), gst_date_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_TYPE_INT_RANGE:
 192  *
 193  * a #GValue type that represents an integer range
 194  *
 195  * Returns: the #GType of GstIntRange
 196  */
 197 #define GST_TYPE_INT_RANGE               gst_int_range_get_type ()
 198
 199 /**
 200  * GST_TYPE_INT64_RANGE:
 201  *
 202  * a #GValue type that represents an #gint64 range
 203  *
 204  * Returns: the #GType of GstInt64Range
 205  *
 206  * Since: 0.10.31
 207  */
 208 #define GST_TYPE_INT64_RANGE             gst_int64_range_get_type ()
 209
 210 /**
 211  * GST_TYPE_DOUBLE_RANGE:
 212  *
 213  * a #GValue type that represents a floating point range with double precission
 214  *
 215  * Returns: the #GType of GstIntRange
 216  */
 217 #define GST_TYPE_DOUBLE_RANGE            gst_double_range_get_type ()
 218
 219 /**
 220  * GST_TYPE_FRACTION_RANGE:
 221  *
 222  * a #GValue type that represents a GstFraction range
 223  *
 224  * Returns: the #GType of GstFractionRange
 225  */
 226 #define GST_TYPE_FRACTION_RANGE            gst_fraction_range_get_type ()
 227
 228 /**
 229  * GST_TYPE_LIST:
 230  *
 231  * a #GValue type that represents an unordered list of #GValue values. This
 232  * is used for example to express a list of possible values for a field in
 233  * a caps structure, like a list of possible sample rates, of which only one
 234  * will be chosen in the end. This means that all values in the list are
 235  * meaningful on their own.
 236  *
 237  * Returns: the #GType of GstValueList (which is not explicitly typed)
 238  */
 239 #define GST_TYPE_LIST                    gst_value_list_get_type ()
 240
 241 /**
 242  * GST_TYPE_ARRAY:
 243  *
 244  * a #GValue type that represents an ordered list of #GValue values. This is
 245  * used to express a set of values that is meaningful only in their specific
 246  * combination and order of values. Each value on its own is not particularly
 247  * meaningful, only the ordered array in its entirety is meaningful. This is
 248  * used for example to express channel layouts for multichannel audio where
 249  * each channel needs to be mapped to a position in the room.
 250  *
 251  * Returns: the #GType of GstArrayList (which is not explicitly typed)
 252  */
 253 #define GST_TYPE_ARRAY                   gst_value_array_get_type ()
 254
 255 /**
 256  * GST_TYPE_FRACTION:
 257  *
 258  * a #GValue type that represents a fraction of an integer numerator over
 259  * an integer denominator
 260  *
 261  * Returns: the #GType of GstFraction (which is not explicitly typed)
 262  */
 263
 264 #define GST_TYPE_FRACTION                gst_fraction_get_type ()
 265
 266 /**
 267  * GST_TYPE_DATE:
 268  *
 269  * a boxed #GValue type for #GDate that represents a date.
 270  *
 271  * Returns: the #GType of GstDate
 272  */
 273
 274 #define GST_TYPE_DATE                    gst_date_get_type ()
 275
 276 /**
 277  * GST_TYPE_DATE_TIME:
 278  *
 279  * a boxed #GValue type for #GstDateTime that represents a date and time.
 280  *
 281  * Returns: the #GType of GstDateTime
 282  * Since: 0.10.31
 283  */
 284
 285 #define GST_TYPE_DATE_TIME               gst_date_time_get_type ()
 286
 287 /**
 288  * GST_VALUE_LESS_THAN:
 289  *
 290  * Indicates that the first value provided to a comparison function
 291  * (gst_value_compare()) is lesser than the second one.
 292  */
 293 #define GST_VALUE_LESS_THAN              (-1)
 294
 295 /**
 296  * GST_VALUE_EQUAL:
 297  *
 298  * Indicates that the first value provided to a comparison function
 299  * (gst_value_compare()) is equal to the second one.
 300  */
 301 #define GST_VALUE_EQUAL                   0
 302
 303 /**
 304  * GST_VALUE_GREATER_THAN:
 305  *
 306  * Indicates that the first value provided to a comparison function
 307  * (gst_value_compare()) is greater than the second one.
 308  */
 309 #define GST_VALUE_GREATER_THAN            1
 310
 311 /**
 312  * GST_VALUE_UNORDERED:
 313  *
 314  * Indicates that the comparison function (gst_value_compare()) can not
 315  * determine a order for the two provided values.
 316  */
 317 #define GST_VALUE_UNORDERED               2
 318
 319 /**
 320  * GstValueCompareFunc:
 321  * @value1: first value for comparison
 322  * @value2: second value for comparison
 323  *
 324  * Used together with gst_value_compare() to compare #GValue items.
 325  *
 326  * Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL, GST_VALUE_GREATER_THAN
 327  * or GST_VALUE_UNORDERED
 328  */
 329 typedef gint     (* GstValueCompareFunc)     (const GValue *value1,
 330                                               const GValue *value2);
 331
 332 /**
 333  * GstValueSerializeFunc:
 334  * @value1: a #GValue
 335  *
 336  * Used by gst_value_serialize() to obtain a non-binary form of the #GValue.
 337  *
 338  * Free-function: g_free
 339  *
 340  * Returns: (transfer full): the string representation of the value
 341  */
 342 typedef gchar *  (* GstValueSerializeFunc)   (const GValue *value1);
 343
 344 /**
 345  * GstValueDeserializeFunc:
 346  * @dest: a #GValue
 347  * @s: a string
 348  *
 349  * Used by gst_value_deserialize() to parse a non-binary form into the #GValue.
 350  *
 351  * Returns: %TRUE for success
 352  */
 353 typedef gboolean (* GstValueDeserializeFunc) (GValue       *dest,
 354                                               const gchar  *s);
 355
 356 /**
 357  * GstValueUnionFunc:
 358  * @dest: a #GValue for the result
 359  * @value1: a #GValue operand
 360  * @value2: a #GValue operand
 361  *
 362  * Used by gst_value_union() to perform unification for a specific #GValue
 363  * type. Register a new implementation with gst_value_register_union_func().
 364  *
 365  * Returns: %TRUE if a union was successful
 366  */
 367 typedef gboolean (* GstValueUnionFunc)       (GValue       *dest,
 368                                               const GValue *value1,
 369                                               const GValue *value2);
 370
 371 /**
 372  * GstValueIntersectFunc:
 373  * @dest: (out caller-allocates): a #GValue for the result
 374  * @value1: a #GValue operand
 375  * @value2: a #GValue operand
 376  *
 377  * Used by gst_value_intersect() to perform intersection for a specific #GValue
 378  * type. If the intersection is non-empty, the result is
 379  * placed in @dest and TRUE is returned.  If the intersection is
 380  * empty, @dest is unmodified and FALSE is returned.
 381  * Register a new implementation with gst_value_register_intersect_func().
 382  *
 383  * Returns: %TRUE if the values can intersect
 384  */
 385 typedef gboolean (* GstValueIntersectFunc)   (GValue       *dest,
 386                                               const GValue *value1,
 387                                               const GValue *value2);
 388
 389 /**
 390  * GstValueSubtractFunc:
 391  * @dest: (out caller-allocates): a #GValue for the result
 392  * @minuend: a #GValue operand
 393  * @subtrahend: a #GValue operand
 394  *
 395  * Used by gst_value_subtract() to perform subtraction for a specific #GValue
 396  * type. Register a new implementation with gst_value_register_subtract_func().
 397  *
 398  * Returns: %TRUE if the subtraction is not empty
 399  */
 400 typedef gboolean (* GstValueSubtractFunc)    (GValue       *dest,
 401                                               const GValue *minuend,
 402                                               const GValue *subtrahend);
 403
 404 typedef struct _GstValueTable GstValueTable;
 405 /**
 406  * GstValueTable:
 407  * @type: a #GType
 408  * @compare: a #GstValueCompareFunc
 409  * @serialize: a #GstValueSerializeFunc
 410  * @deserialize: a #GstValueDeserializeFunc
 411  *
 412  * VTable for the #GValue @type.
 413  */
 414 struct _GstValueTable {
 415   GType type;
 416   GstValueCompareFunc compare;
 417   GstValueSerializeFunc serialize;
 418   GstValueDeserializeFunc deserialize;
 419
 420   /*< private >*/
 421   gpointer _gst_reserved [GST_PADDING];
 422 };
 423
 424 GType gst_int_range_get_type (void);
 425 GType gst_int64_range_get_type (void);
 426 GType gst_double_range_get_type (void);
 427 GType gst_fraction_range_get_type (void);
 428 GType gst_fraction_get_type (void);
 429 GType gst_value_list_get_type (void);
 430 GType gst_value_array_get_type (void);
 431
 432 GType gst_date_get_type (void);
 433 GType gst_date_time_get_type (void);
 434
 435 void            gst_value_register              (const GstValueTable   *table);
 436 void            gst_value_init_and_copy         (GValue                *dest,
 437                                                  const GValue          *src);
 438
 439 gchar *         gst_value_serialize             (const GValue          *value) G_GNUC_MALLOC;
 440 gboolean        gst_value_deserialize           (GValue                *dest,
 441                                                  const gchar           *src);
 442
 443 /* list */
 444 void            gst_value_list_append_value     (GValue         *value,
 445                                                  const GValue   *append_value);
 446 void            gst_value_list_prepend_value    (GValue         *value,
 447                                                  const GValue   *prepend_value);
 448 void            gst_value_list_concat           (GValue         *dest,
 449                                                  const GValue   *value1,
 450                                                  const GValue   *value2);
 451 void            gst_value_list_merge            (GValue         *dest,
 452                                                  const GValue   *value1,
 453                                                  const GValue   *value2);
 454 guint           gst_value_list_get_size         (const GValue   *value);
 455 const GValue *  gst_value_list_get_value        (const GValue   *value,
 456                                                  guint          index);
 457
 458 /* array */
 459 void            gst_value_array_append_value    (GValue         *value,
 460                                                  const GValue   *append_value);
 461 void            gst_value_array_prepend_value   (GValue         *value,
 462                                                  const GValue   *prepend_value);
 463 guint           gst_value_array_get_size        (const GValue   *value);
 464 const GValue *  gst_value_array_get_value       (const GValue   *value,
 465                                                  guint          index);
 466
 467 /* int range */
 468 void            gst_value_set_int_range         (GValue         *value,
 469                                                  gint           start,
 470                                                  gint           end);
 471 gint            gst_value_get_int_range_min     (const GValue   *value);
 472 gint            gst_value_get_int_range_max     (const GValue   *value);
 473
 474 /* int64 range */
 475 void            gst_value_set_int64_range       (GValue         *value,
 476                                                  gint64         start,
 477                                                  gint64         end);
 478 gint64          gst_value_get_int64_range_min   (const GValue   *value);
 479 gint64          gst_value_get_int64_range_max   (const GValue   *value);
 480
 481 /* double range */
 482 void            gst_value_set_double_range      (GValue         *value,
 483                                                  gdouble        start,
 484                                                  gdouble        end);
 485 gdouble         gst_value_get_double_range_min  (const GValue   *value);
 486 gdouble         gst_value_get_double_range_max  (const GValue   *value);
 487
 488 /* caps */
 489 const GstCaps * gst_value_get_caps              (const GValue   *value);
 490 void            gst_value_set_caps              (GValue         *value,
 491                                                  const GstCaps  *caps);
 492
 493 /* structure */
 494 const GstStructure *
 495                 gst_value_get_structure         (const GValue   *value);
 496 void            gst_value_set_structure         (GValue         *value,
 497                                                  const GstStructure  *structure);
 498
 499 /* fraction */
 500 void            gst_value_set_fraction          (GValue         *value,
 501                                                  gint           numerator,
 502                                                  gint           denominator);
 503 gint            gst_value_get_fraction_numerator   (const GValue  *value);
 504 gint            gst_value_get_fraction_denominator (const GValue *value);
 505 gboolean        gst_value_fraction_multiply        (GValue         *product,
 506                                                     const GValue   *factor1,
 507                                                     const GValue   *factor2);
 508 gboolean        gst_value_fraction_subtract     (GValue * dest,
 509                                                  const GValue * minuend,
 510                                                  const GValue * subtrahend);
 511
 512 /* fraction range */
 513 void            gst_value_set_fraction_range    (GValue         *value,
 514                                                  const GValue   *start,
 515                                                  const GValue   *end);
 516 void            gst_value_set_fraction_range_full (GValue       *value,
 517                                                  gint numerator_start,
 518                                                  gint denominator_start,
 519                                                  gint numerator_end,
 520                                                  gint denominator_end);
 521 const GValue    *gst_value_get_fraction_range_min (const GValue *value);
 522 const GValue    *gst_value_get_fraction_range_max (const GValue *value);
 523
 524 /* date */
 525 const GDate *   gst_value_get_date              (const GValue   *value);
 526 void            gst_value_set_date              (GValue         *value,
 527                                                  const GDate    *date);
 528
 529 /* compare */
 530 gint            gst_value_compare               (const GValue   *value1,
 531                                                  const GValue   *value2);
 532 gboolean        gst_value_can_compare           (const GValue   *value1,
 533                                                  const GValue   *value2);
 534 /* union */
 535 gboolean        gst_value_union                 (GValue         *dest,
 536                                                  const GValue   *value1,
 537                                                  const GValue   *value2);
 538 gboolean        gst_value_can_union             (const GValue   *value1,
 539                                                  const GValue   *value2);
 540 void            gst_value_register_union_func   (GType          type1,
 541                                                  GType          type2,
 542                                                  GstValueUnionFunc func);
 543
 544 /* intersection */
 545 gboolean        gst_value_intersect             (GValue         *dest,
 546                                                  const GValue   *value1,
 547                                                  const GValue   *value2);
 548 gboolean        gst_value_can_intersect         (const GValue   *value1,
 549                                                  const GValue   *value2);
 550 void            gst_value_register_intersect_func (GType        type1,
 551                                                 GType           type2,
 552                                                 GstValueIntersectFunc func);
 553
 554 /* subtraction */
 555 gboolean        gst_value_subtract              (GValue         *dest,
 556                                                  const GValue   *minuend,
 557                                                  const GValue   *subtrahend);
 558 gboolean        gst_value_can_subtract          (const GValue   *minuend,
 559                                                  const GValue   *subtrahend);
 560 void            gst_value_register_subtract_func (GType         minuend_type,
 561                                                 GType           subtrahend_type,
 562                                                 GstValueSubtractFunc func);
 563
 564 /* fixation */
 565 gboolean        gst_value_is_fixed              (const GValue   *value);
 566 gboolean        gst_value_fixate                (GValue         *dest,
 567                                                  const GValue   *src);
 568
 569 G_END_DECLS
 570
 571 #endif
 572
 573