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  * <informalexample>
  40  * <programlisting>
  41  * guint32 fourcc = GST_MAKE_FOURCC ('M', 'J', 'P', 'G');
  42  * </programlisting>
  43  * </informalexample>
  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  * <informalexample>
  56  * <programlisting>
  57  * guint32 fourcc = GST_STR_FOURCC ("MJPG");
  58  * </programlisting>
  59  * </informalexample>
  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  * <informalexample>
  69  * <programlisting>
  70  * printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
  71  * </programlisting>
  72  * </informalexample>
  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 GST_EXPORT GType _gst_int_range_type;
 204
 205 /**
 206  * GST_TYPE_INT_RANGE:
 207  *
 208  * a #GValue type that represents an integer range
 209  *
 210  * Returns: the #GType of GstIntRange
 211  */
 212 #define GST_TYPE_INT_RANGE               (_gst_int_range_type)
 213
 214 GST_EXPORT GType _gst_int64_range_type;
 215
 216 /**
 217  * GST_TYPE_INT64_RANGE:
 218  *
 219  * a #GValue type that represents an #gint64 range
 220  *
 221  * Returns: the #GType of GstInt64Range
 222  */
 223 #define GST_TYPE_INT64_RANGE             (_gst_int64_range_type)
 224
 225 GST_EXPORT GType _gst_double_range_type;
 226
 227 /**
 228  * GST_TYPE_DOUBLE_RANGE:
 229  *
 230  * a #GValue type that represents a floating point range with double precision
 231  *
 232  * Returns: the #GType of GstIntRange
 233  */
 234 #define GST_TYPE_DOUBLE_RANGE            (_gst_double_range_type)
 235
 236 GST_EXPORT GType _gst_fraction_range_type;
 237
 238 /**
 239  * GST_TYPE_FRACTION_RANGE:
 240  *
 241  * a #GValue type that represents a GstFraction range
 242  *
 243  * Returns: the #GType of GstFractionRange
 244  */
 245 #define GST_TYPE_FRACTION_RANGE           (_gst_fraction_range_type)
 246
 247 GST_EXPORT GType _gst_value_list_type;
 248
 249 /**
 250  * GST_TYPE_LIST:
 251  *
 252  * a #GValue type that represents an unordered list of #GValue values. This
 253  * is used for example to express a list of possible values for a field in
 254  * a caps structure, like a list of possible sample rates, of which only one
 255  * will be chosen in the end. This means that all values in the list are
 256  * meaningful on their own.
 257  *
 258  * Returns: the #GType of GstValueList (which is not explicitly typed)
 259  */
 260 #define GST_TYPE_LIST                    (_gst_value_list_type)
 261
 262 GST_EXPORT GType _gst_value_array_type;
 263
 264 /**
 265  * GST_TYPE_ARRAY:
 266  *
 267  * a #GValue type that represents an ordered list of #GValue values. This is
 268  * used to express a set of values that is meaningful only in their specific
 269  * combination and order of values. Each value on its own is not particularly
 270  * meaningful, only the ordered array in its entirety is meaningful. This is
 271  * used for example to express channel layouts for multichannel audio where
 272  * each channel needs to be mapped to a position in the room.
 273  *
 274  * Returns: the #GType of GstArrayList (which is not explicitly typed)
 275  */
 276 #define GST_TYPE_ARRAY                   (_gst_value_array_type)
 277
 278 GST_EXPORT GType _gst_fraction_type;
 279
 280 /**
 281  * GST_TYPE_FRACTION:
 282  *
 283  * a #GValue type that represents a fraction of an integer numerator over
 284  * an integer denominator
 285  *
 286  * Returns: the #GType of GstFraction (which is not explicitly typed)
 287  */
 288
 289 #define GST_TYPE_FRACTION                (_gst_fraction_type)
 290
 291 GST_EXPORT GType _gst_bitmask_type;
 292
 293 /**
 294  * GST_TYPE_BITMASK:
 295  *
 296  * a #GValue type that represents a 64-bit bitmask.
 297  *
 298  * Returns: the #GType of GstBitmask (which is not explicitly typed)
 299  */
 300
 301 #define GST_TYPE_BITMASK                 (_gst_bitmask_type)
 302
 303 /**
 304  * GST_TYPE_G_THREAD:
 305  *
 306  * a boxed #GValue type for #GThread that represents a thread.
 307  *
 308  * Returns: the #GType of GstGThread
 309  */
 310
 311 #define GST_TYPE_G_THREAD                gst_g_thread_get_type ()
 312
 313 /**
 314  * GST_VALUE_LESS_THAN:
 315  *
 316  * Indicates that the first value provided to a comparison function
 317  * (gst_value_compare()) is lesser than the second one.
 318  */
 319 #define GST_VALUE_LESS_THAN              (-1)
 320
 321 /**
 322  * GST_VALUE_EQUAL:
 323  *
 324  * Indicates that the first value provided to a comparison function
 325  * (gst_value_compare()) is equal to the second one.
 326  */
 327 #define GST_VALUE_EQUAL                   0
 328
 329 /**
 330  * GST_VALUE_GREATER_THAN:
 331  *
 332  * Indicates that the first value provided to a comparison function
 333  * (gst_value_compare()) is greater than the second one.
 334  */
 335 #define GST_VALUE_GREATER_THAN            1
 336
 337 /**
 338  * GST_VALUE_UNORDERED:
 339  *
 340  * Indicates that the comparison function (gst_value_compare()) can not
 341  * determine a order for the two provided values.
 342  */
 343 #define GST_VALUE_UNORDERED               2
 344
 345 /**
 346  * GstValueCompareFunc:
 347  * @value1: first value for comparison
 348  * @value2: second value for comparison
 349  *
 350  * Used together with gst_value_compare() to compare #GValue items.
 351  *
 352  * Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL, GST_VALUE_GREATER_THAN
 353  * or GST_VALUE_UNORDERED
 354  */
 355 typedef gint     (* GstValueCompareFunc)     (const GValue *value1,
 356                                               const GValue *value2);
 357
 358 /**
 359  * GstValueSerializeFunc:
 360  * @value1: a #GValue
 361  *
 362  * Used by gst_value_serialize() to obtain a non-binary form of the #GValue.
 363  *
 364  * Free-function: g_free
 365  *
 366  * Returns: (transfer full): the string representation of the value
 367  */
 368 typedef gchar *  (* GstValueSerializeFunc)   (const GValue *value1);
 369
 370 /**
 371  * GstValueDeserializeFunc:
 372  * @dest: a #GValue
 373  * @s: a string
 374  *
 375  * Used by gst_value_deserialize() to parse a non-binary form into the #GValue.
 376  *
 377  * Returns: %TRUE for success
 378  */
 379 typedef gboolean (* GstValueDeserializeFunc) (GValue       *dest,
 380                                               const gchar  *s);
 381
 382 typedef struct _GstValueTable GstValueTable;
 383 /**
 384  * GstValueTable:
 385  * @type: a #GType
 386  * @compare: a #GstValueCompareFunc
 387  * @serialize: a #GstValueSerializeFunc
 388  * @deserialize: a #GstValueDeserializeFunc
 389  *
 390  * VTable for the #GValue @type.
 391  */
 392 struct _GstValueTable {
 393   GType type;
 394   GstValueCompareFunc compare;
 395   GstValueSerializeFunc serialize;
 396   GstValueDeserializeFunc deserialize;
 397
 398   /*< private >*/
 399   gpointer _gst_reserved [GST_PADDING];
 400 };
 401
 402 GType gst_int_range_get_type (void);
 403 GType gst_int64_range_get_type (void);
 404 GType gst_double_range_get_type (void);
 405 GType gst_fraction_range_get_type (void);
 406 GType gst_fraction_get_type (void);
 407 GType gst_value_list_get_type (void);
 408 GType gst_value_array_get_type (void);
 409 GType gst_bitmask_get_type (void);
 410
 411 /* Hide this compatibility type from introspection */
 412 #ifndef __GI_SCANNER__
 413 GType gst_g_thread_get_type (void);
 414 #endif
 415
 416 void            gst_value_register              (const GstValueTable   *table);
 417 void            gst_value_init_and_copy         (GValue                *dest,
 418                                                  const GValue          *src);
 419
 420 gchar *         gst_value_serialize             (const GValue          *value) G_GNUC_MALLOC;
 421 gboolean        gst_value_deserialize           (GValue                *dest,
 422                                                  const gchar           *src);
 423
 424 /* list */
 425 void            gst_value_list_append_value     (GValue         *value,
 426                                                  const GValue   *append_value);
 427 void            gst_value_list_append_and_take_value (GValue         *value,
 428                                                  GValue   *append_value);
 429 void            gst_value_list_prepend_value    (GValue         *value,
 430                                                  const GValue   *prepend_value);
 431 void            gst_value_list_concat           (GValue         *dest,
 432                                                  const GValue   *value1,
 433                                                  const GValue   *value2);
 434 void            gst_value_list_merge            (GValue         *dest,
 435                                                  const GValue   *value1,
 436                                                  const GValue   *value2);
 437 guint           gst_value_list_get_size         (const GValue   *value);
 438 const GValue *  gst_value_list_get_value        (const GValue   *value,
 439                                                  guint          index);
 440
 441 /* array */
 442 void            gst_value_array_append_value    (GValue         *value,
 443                                                  const GValue   *append_value);
 444 void            gst_value_array_append_and_take_value    (GValue         *value,
 445                                                  GValue   *append_value);
 446 void            gst_value_array_prepend_value   (GValue         *value,
 447                                                  const GValue   *prepend_value);
 448 guint           gst_value_array_get_size        (const GValue   *value);
 449 const GValue *  gst_value_array_get_value       (const GValue   *value,
 450                                                  guint          index);
 451
 452 /* int range */
 453 void            gst_value_set_int_range         (GValue         *value,
 454                                                  gint           start,
 455                                                  gint           end);
 456 void            gst_value_set_int_range_step    (GValue         *value,
 457                                                  gint           start,
 458                                                  gint           end,
 459                                                  gint           step);
 460 gint            gst_value_get_int_range_min     (const GValue   *value);
 461 gint            gst_value_get_int_range_max     (const GValue   *value);
 462 gint            gst_value_get_int_range_step    (const GValue   *value);
 463
 464 /* int64 range */
 465 void            gst_value_set_int64_range       (GValue         *value,
 466                                                  gint64         start,
 467                                                  gint64         end);
 468 void            gst_value_set_int64_range_step  (GValue         *value,
 469                                                  gint64         start,
 470                                                  gint64         end,
 471                                                  gint64         step);
 472 gint64          gst_value_get_int64_range_min   (const GValue   *value);
 473 gint64          gst_value_get_int64_range_max   (const GValue   *value);
 474 gint64          gst_value_get_int64_range_step  (const GValue   *value);
 475
 476 /* double range */
 477 void            gst_value_set_double_range      (GValue         *value,
 478                                                  gdouble        start,
 479                                                  gdouble        end);
 480 gdouble         gst_value_get_double_range_min  (const GValue   *value);
 481 gdouble         gst_value_get_double_range_max  (const GValue   *value);
 482
 483 /* caps */
 484 const GstCaps * gst_value_get_caps              (const GValue   *value);
 485 void            gst_value_set_caps              (GValue         *value,
 486                                                  const GstCaps  *caps);
 487
 488 /* structure */
 489 const GstStructure *
 490                 gst_value_get_structure         (const GValue   *value);
 491 void            gst_value_set_structure         (GValue         *value,
 492                                                  const GstStructure  *structure);
 493
 494 /* caps features */
 495 const GstCapsFeatures *
 496                 gst_value_get_caps_features     (const GValue   *value);
 497 void            gst_value_set_caps_features     (GValue         *value,
 498                                                  const GstCapsFeatures  *features);
 499
 500 /* fraction */
 501 void            gst_value_set_fraction          (GValue         *value,
 502                                                  gint           numerator,
 503                                                  gint           denominator);
 504 gint            gst_value_get_fraction_numerator   (const GValue  *value);
 505 gint            gst_value_get_fraction_denominator (const GValue *value);
 506 gboolean        gst_value_fraction_multiply        (GValue         *product,
 507                                                     const GValue   *factor1,
 508                                                     const GValue   *factor2);
 509 gboolean        gst_value_fraction_subtract     (GValue * dest,
 510                                                  const GValue * minuend,
 511                                                  const GValue * subtrahend);
 512
 513 /* fraction range */
 514 void            gst_value_set_fraction_range    (GValue         *value,
 515                                                  const GValue   *start,
 516                                                  const GValue   *end);
 517 void            gst_value_set_fraction_range_full (GValue       *value,
 518                                                  gint numerator_start,
 519                                                  gint denominator_start,
 520                                                  gint numerator_end,
 521                                                  gint denominator_end);
 522 const GValue    *gst_value_get_fraction_range_min (const GValue *value);
 523 const GValue    *gst_value_get_fraction_range_max (const GValue *value);
 524
 525 /* bitmask */
 526 guint64         gst_value_get_bitmask           (const GValue   *value);
 527 void            gst_value_set_bitmask           (GValue         *value,
 528                                                  guint64         bitmask);
 529
 530 /* compare */
 531 gint            gst_value_compare               (const GValue   *value1,
 532                                                  const GValue   *value2);
 533 gboolean        gst_value_can_compare           (const GValue   *value1,
 534                                                  const GValue   *value2);
 535 gboolean        gst_value_is_subset             (const GValue   *value1,
 536                                                  const GValue   *value2);
 537
 538 /* union */
 539 gboolean        gst_value_union                 (GValue         *dest,
 540                                                  const GValue   *value1,
 541                                                  const GValue   *value2);
 542 gboolean        gst_value_can_union             (const GValue   *value1,
 543                                                  const GValue   *value2);
 544
 545 /* intersection */
 546 gboolean        gst_value_intersect             (GValue         *dest,
 547                                                  const GValue   *value1,
 548                                                  const GValue   *value2);
 549 gboolean        gst_value_can_intersect         (const GValue   *value1,
 550                                                  const GValue   *value2);
 551
 552 /* subtraction */
 553 gboolean        gst_value_subtract              (GValue         *dest,
 554                                                  const GValue   *minuend,
 555                                                  const GValue   *subtrahend);
 556 gboolean        gst_value_can_subtract          (const GValue   *minuend,
 557                                                  const GValue   *subtrahend);
 558
 559 /* fixation */
 560 gboolean        gst_value_is_fixed              (const GValue   *value);
 561 gboolean        gst_value_fixate                (GValue         *dest,
 562                                                  const GValue   *src);
 563
 564 G_END_DECLS
 565
 566 #endif
 567
 568