gst/gstutils.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2002 Thomas Vander Stichele <thomas@apestaart.org>
   5  *
   6  * gstutils.h: Header for various utility functions
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24
  25 #ifndef __GST_UTILS_H__
  26 #define __GST_UTILS_H__
  27
  28 #include <glib.h>
  29 #include <gst/gstbin.h>
  30 #include <gst/gstparse.h>
  31
  32 G_BEGIN_DECLS
  33
  34 void            gst_util_set_value_from_string  (GValue *value, const gchar *value_str);
  35 void            gst_util_set_object_arg         (GObject *object, const gchar *name, const gchar *value);
  36 void            gst_util_dump_mem               (const guchar *mem, guint size);
  37
  38 guint64         gst_util_gdouble_to_guint64     (gdouble value)  G_GNUC_CONST;
  39 gdouble         gst_util_guint64_to_gdouble     (guint64 value)  G_GNUC_CONST;
  40
  41 /**
  42  * gst_guint64_to_gdouble:
  43  * @value: the #guint64 value to convert
  44  *
  45  * Convert @value to a gdouble.
  46  *
  47  * Returns: @value converted to a #gdouble.
  48  */
  49
  50 /**
  51  * gst_gdouble_to_guint64:
  52  * @value: the #gdouble value to convert
  53  *
  54  * Convert @value to a guint64.
  55  *
  56  * Returns: @value converted to a #guint64.
  57  */
  58 #ifdef WIN32
  59 #define         gst_gdouble_to_guint64(value)   gst_util_gdouble_to_guint64(value)
  60 #define         gst_guint64_to_gdouble(value)   gst_util_guint64_to_gdouble(value)
  61 #else
  62 #define         gst_gdouble_to_guint64(value)   ((guint64) (value))
  63 #define         gst_guint64_to_gdouble(value)   ((gdouble) (value))
  64 #endif
  65
  66 guint64         gst_util_uint64_scale           (guint64 val, guint64 num, guint64 denom);
  67 guint64         gst_util_uint64_scale_round     (guint64 val, guint64 num, guint64 denom);
  68 guint64         gst_util_uint64_scale_ceil      (guint64 val, guint64 num, guint64 denom);
  69
  70 guint64         gst_util_uint64_scale_int       (guint64 val, gint num, gint denom);
  71 guint64         gst_util_uint64_scale_int_round (guint64 val, gint num, gint denom);
  72 guint64         gst_util_uint64_scale_int_ceil  (guint64 val, gint num, gint denom);
  73
  74 guint32         gst_util_seqnum_next            (void);
  75 gint32          gst_util_seqnum_compare         (guint32 s1, guint32 s2);
  76
  77 void            gst_print_pad_caps              (GString *buf, gint indent, GstPad *pad);
  78 void            gst_print_element_args          (GString *buf, gint indent, GstElement *element);
  79
  80
  81 /**
  82  * GST_CALL_PARENT:
  83  * @parent_class_cast: the name of the class cast macro for the parent type
  84  * @name: name of the function to call
  85  * @args: arguments enclosed in '( )'
  86  *
  87  * Just call the parent handler.  This assumes that there is a variable
  88  * named parent_class that points to the (duh!) parent class.  Note that
  89  * this macro is not to be used with things that return something, use
  90  * the _WITH_DEFAULT version for that
  91  */
  92 #define GST_CALL_PARENT(parent_class_cast, name, args)                  \
  93         ((parent_class_cast(parent_class)->name != NULL) ?              \
  94          parent_class_cast(parent_class)->name args : (void) 0)
  95
  96 /**
  97  * GST_CALL_PARENT_WITH_DEFAULT:
  98  * @parent_class_cast: the name of the class cast macro for the parent type
  99  * @name: name of the function to call
 100  * @args: arguments enclosed in '( )'
 101  * @def_return: default result
 102  *
 103  * Same as GST_CALL_PARENT(), but in case there is no implementation, it
 104  * evaluates to @def_return.
 105  */
 106 #define GST_CALL_PARENT_WITH_DEFAULT(parent_class_cast, name, args, def_return)\
 107         ((parent_class_cast(parent_class)->name != NULL) ?              \
 108          parent_class_cast(parent_class)->name args : def_return)
 109
 110 /* Define PUT and GET functions for unaligned memory */
 111 #define _GST_GET(__data, __idx, __size, __shift) \
 112     (((guint##__size) (((const guint8 *) (__data))[__idx])) << (__shift))
 113
 114 #define _GST_PUT(__data, __idx, __size, __shift, __num) \
 115     (((guint8 *) (__data))[__idx] = (((guint##__size) (__num)) >> (__shift)) & 0xff)
 116
 117 /**
 118  * GST_READ_UINT64_BE:
 119  * @data: memory location
 120  *
 121  * Read a 64 bit unsigned integer value in big endian format from the memory buffer.
 122  */
 123 #define GST_READ_UINT64_BE(data)        (_GST_GET (data, 0, 64, 56) | \
 124                                          _GST_GET (data, 1, 64, 48) | \
 125                                          _GST_GET (data, 2, 64, 40) | \
 126                                          _GST_GET (data, 3, 64, 32) | \
 127                                          _GST_GET (data, 4, 64, 24) | \
 128                                          _GST_GET (data, 5, 64, 16) | \
 129                                          _GST_GET (data, 6, 64,  8) | \
 130                                          _GST_GET (data, 7, 64,  0))
 131
 132 /**
 133  * GST_READ_UINT64_LE:
 134  * @data: memory location
 135  *
 136  * Read a 64 bit unsigned integer value in little endian format from the memory buffer.
 137  */
 138 #define GST_READ_UINT64_LE(data)        (_GST_GET (data, 7, 64, 56) | \
 139                                          _GST_GET (data, 6, 64, 48) | \
 140                                          _GST_GET (data, 5, 64, 40) | \
 141                                          _GST_GET (data, 4, 64, 32) | \
 142                                          _GST_GET (data, 3, 64, 24) | \
 143                                          _GST_GET (data, 2, 64, 16) | \
 144                                          _GST_GET (data, 1, 64,  8) | \
 145                                          _GST_GET (data, 0, 64,  0))
 146
 147 /**
 148  * GST_READ_UINT32_BE:
 149  * @data: memory location
 150  *
 151  * Read a 32 bit unsigned integer value in big endian format from the memory buffer.
 152  */
 153 #define GST_READ_UINT32_BE(data)        (_GST_GET (data, 0, 32, 24) | \
 154                                          _GST_GET (data, 1, 32, 16) | \
 155                                          _GST_GET (data, 2, 32,  8) | \
 156                                          _GST_GET (data, 3, 32,  0))
 157
 158 /**
 159  * GST_READ_UINT32_LE:
 160  * @data: memory location
 161  *
 162  * Read a 32 bit unsigned integer value in little endian format from the memory buffer.
 163  */
 164 #define GST_READ_UINT32_LE(data)        (_GST_GET (data, 3, 32, 24) | \
 165                                          _GST_GET (data, 2, 32, 16) | \
 166                                          _GST_GET (data, 1, 32,  8) | \
 167                                          _GST_GET (data, 0, 32,  0))
 168
 169 /**
 170  * GST_READ_UINT24_BE:
 171  * @data: memory location
 172  *
 173  * Read a 24 bit unsigned integer value in big endian format from the memory buffer.
 174  *
 175  * Since: 0.10.22
 176  */
 177 #define GST_READ_UINT24_BE(data)        (_GST_GET (data, 0, 32, 16) | \
 178                                          _GST_GET (data, 1, 32,  8) | \
 179                                          _GST_GET (data, 2, 32,  0))
 180
 181 /**
 182  * GST_READ_UINT24_LE:
 183  * @data: memory location
 184  *
 185  * Read a 24 bit unsigned integer value in little endian format from the memory buffer.
 186  *
 187  * Since: 0.10.22
 188  */
 189 #define GST_READ_UINT24_LE(data)        (_GST_GET (data, 2, 32, 16) | \
 190                                          _GST_GET (data, 1, 32,  8) | \
 191                                          _GST_GET (data, 0, 32,  0))
 192
 193 /**
 194  * GST_READ_UINT16_BE:
 195  * @data: memory location
 196  *
 197  * Read a 16 bit unsigned integer value in big endian format from the memory buffer.
 198  */
 199 #define GST_READ_UINT16_BE(data)        (_GST_GET (data, 0, 16,  8) | \
 200                                          _GST_GET (data, 1, 16,  0))
 201
 202 /**
 203  * GST_READ_UINT16_LE:
 204  * @data: memory location
 205  *
 206  * Read a 16 bit unsigned integer value in little endian format from the memory buffer.
 207  */
 208 #define GST_READ_UINT16_LE(data)        (_GST_GET (data, 1, 16,  8) | \
 209                                          _GST_GET (data, 0, 16,  0))
 210
 211 /**
 212  * GST_READ_UINT8:
 213  * @data: memory location
 214  *
 215  * Read an 8 bit unsigned integer value from the memory buffer.
 216  */
 217 #define GST_READ_UINT8(data)            (_GST_GET (data, 0,  8,  0))
 218
 219 /**
 220  * GST_WRITE_UINT64_BE:
 221  * @data: memory location
 222  * @num: value to store
 223  *
 224  * Store a 64 bit unsigned integer value in big endian format into the memory buffer.
 225  */
 226 #define GST_WRITE_UINT64_BE(data, num)  do { \
 227                                           _GST_PUT (data, 0, 64, 56, num); \
 228                                           _GST_PUT (data, 1, 64, 48, num); \
 229                                           _GST_PUT (data, 2, 64, 40, num); \
 230                                           _GST_PUT (data, 3, 64, 32, num); \
 231                                           _GST_PUT (data, 4, 64, 24, num); \
 232                                           _GST_PUT (data, 5, 64, 16, num); \
 233                                           _GST_PUT (data, 6, 64,  8, num); \
 234                                           _GST_PUT (data, 7, 64,  0, num); \
 235                                         } while (0)
 236
 237 /**
 238  * GST_WRITE_UINT64_LE:
 239  * @data: memory location
 240  * @num: value to store
 241  *
 242  * Store a 64 bit unsigned integer value in little endian format into the memory buffer.
 243  */
 244 #define GST_WRITE_UINT64_LE(data, num)  do { \
 245                                           _GST_PUT (data, 0, 64,  0, num); \
 246                                           _GST_PUT (data, 1, 64,  8, num); \
 247                                           _GST_PUT (data, 2, 64, 16, num); \
 248                                           _GST_PUT (data, 3, 64, 24, num); \
 249                                           _GST_PUT (data, 4, 64, 32, num); \
 250                                           _GST_PUT (data, 5, 64, 40, num); \
 251                                           _GST_PUT (data, 6, 64, 48, num); \
 252                                           _GST_PUT (data, 7, 64, 56, num); \
 253                                         } while (0)
 254
 255 /**
 256  * GST_WRITE_UINT32_BE:
 257  * @data: memory location
 258  * @num: value to store
 259  *
 260  * Store a 32 bit unsigned integer value in big endian format into the memory buffer.
 261  */
 262 #define GST_WRITE_UINT32_BE(data, num)  do { \
 263                                           _GST_PUT (data, 0, 32, 24, num); \
 264                                           _GST_PUT (data, 1, 32, 16, num); \
 265                                           _GST_PUT (data, 2, 32,  8, num); \
 266                                           _GST_PUT (data, 3, 32,  0, num); \
 267                                         } while (0)
 268
 269 /**
 270  * GST_WRITE_UINT32_LE:
 271  * @data: memory location
 272  * @num: value to store
 273  *
 274  * Store a 32 bit unsigned integer value in little endian format into the memory buffer.
 275  */
 276 #define GST_WRITE_UINT32_LE(data, num)  do { \
 277                                           _GST_PUT (data, 0, 32,  0, num); \
 278                                           _GST_PUT (data, 1, 32,  8, num); \
 279                                           _GST_PUT (data, 2, 32, 16, num); \
 280                                           _GST_PUT (data, 3, 32, 24, num); \
 281                                         } while (0)
 282
 283 /**
 284  * GST_WRITE_UINT24_BE:
 285  * @data: memory location
 286  * @num: value to store
 287  *
 288  * Store a 24 bit unsigned integer value in big endian format into the memory buffer.
 289  *
 290  * Since: 0.10.22
 291  */
 292 #define GST_WRITE_UINT24_BE(data, num)  do { \
 293                                           _GST_PUT (data, 0, 32,  16, num); \
 294                                           _GST_PUT (data, 1, 32,  8, num); \
 295                                           _GST_PUT (data, 2, 32,  0, num); \
 296                                         } while (0)
 297
 298 /**
 299  * GST_WRITE_UINT24_LE:
 300  * @data: memory location
 301  * @num: value to store
 302  *
 303  * Store a 24 bit unsigned integer value in little endian format into the memory buffer.
 304  *
 305  * Since: 0.10.22
 306  */
 307 #define GST_WRITE_UINT24_LE(data, num)  do { \
 308                                           _GST_PUT (data, 0, 32,  0, num); \
 309                                           _GST_PUT (data, 1, 32,  8, num); \
 310                                           _GST_PUT (data, 2, 32,  16, num); \
 311                                         } while (0)
 312
 313 /**
 314  * GST_WRITE_UINT16_BE:
 315  * @data: memory location
 316  * @num: value to store
 317  *
 318  * Store a 16 bit unsigned integer value in big endian format into the memory buffer.
 319  */
 320 #define GST_WRITE_UINT16_BE(data, num)  do { \
 321                                           _GST_PUT (data, 0, 16,  8, num); \
 322                                           _GST_PUT (data, 1, 16,  0, num); \
 323                                         } while (0)
 324
 325 /**
 326  * GST_WRITE_UINT16_LE:
 327  * @data: memory location
 328  * @num: value to store
 329  *
 330  * Store a 16 bit unsigned integer value in little endian format into the memory buffer.
 331  */
 332 #define GST_WRITE_UINT16_LE(data, num)  do { \
 333                                           _GST_PUT (data, 0, 16,  0, num); \
 334                                           _GST_PUT (data, 1, 16,  8, num); \
 335                                         } while (0)
 336
 337 /**
 338  * GST_WRITE_UINT8:
 339  * @data: memory location
 340  * @num: value to store
 341  *
 342  * Store an 8 bit unsigned integer value into the memory buffer.
 343  */
 344 #define GST_WRITE_UINT8(data, num)      do { \
 345                                           _GST_PUT (data, 0,  8,  0, num); \
 346                                         } while (0)
 347
 348 /* Float endianness conversion macros */
 349
 350 /* FIXME: Remove this once we depend on a GLib version with this */
 351 #ifndef GFLOAT_FROM_LE
 352 /**
 353  * GFLOAT_SWAP_LE_BE:
 354  * @in: input value
 355  *
 356  * Swap byte order of a 32-bit floating point value (float).
 357  *
 358  * Returns: @in byte-swapped.
 359  *
 360  * Since: 0.10.22
 361  *
 362  */
 363 #ifdef _FOOL_GTK_DOC_
 364 G_INLINE_FUNC gfloat GFLOAT_SWAP_LE_BE (gfloat in);
 365 #endif
 366
 367 inline static gfloat
 368 GFLOAT_SWAP_LE_BE(gfloat in)
 369 {
 370   union
 371   {
 372     guint32 i;
 373     gfloat f;
 374   } u;
 375
 376   u.f = in;
 377   u.i = GUINT32_SWAP_LE_BE (u.i);
 378   return u.f;
 379 }
 380
 381 /**
 382  * GDOUBLE_SWAP_LE_BE:
 383  * @in: input value
 384  *
 385  * Swap byte order of a 64-bit floating point value (double).
 386  *
 387  * Returns: @in byte-swapped.
 388  *
 389  * Since: 0.10.22
 390  *
 391  */
 392 #ifdef _FOOL_GTK_DOC_
 393 G_INLINE_FUNC gdouble GDOUBLE_SWAP_LE_BE (gdouble in);
 394 #endif
 395
 396 inline static gdouble
 397 GDOUBLE_SWAP_LE_BE(gdouble in)
 398 {
 399   union
 400   {
 401     guint64 i;
 402     gdouble d;
 403   } u;
 404
 405   u.d = in;
 406   u.i = GUINT64_SWAP_LE_BE (u.i);
 407   return u.d;
 408 }
 409
 410 /**
 411  * GDOUBLE_TO_LE:
 412  * @val: value
 413  *
 414  * Convert 64-bit floating point value (double) from native byte order into
 415  * little endian byte order.
 416  *
 417  * Since: 0.10.22
 418  *
 419  */
 420 /**
 421  * GDOUBLE_TO_BE:
 422  * @val: value
 423  *
 424  * Convert 64-bit floating point value (double) from native byte order into
 425  * big endian byte order.
 426  *
 427  * Since: 0.10.22
 428  *
 429  */
 430 /**
 431  * GDOUBLE_FROM_LE:
 432  * @val: value
 433  *
 434  * Convert 64-bit floating point value (double) from little endian byte order
 435  * into native byte order.
 436  *
 437  * Since: 0.10.22
 438  *
 439  */
 440 /**
 441  * GDOUBLE_FROM_BE:
 442  * @val: value
 443  *
 444  * Convert 64-bit floating point value (double) from big endian byte order
 445  * into native byte order.
 446  *
 447  * Since: 0.10.22
 448  *
 449  */
 450
 451 /**
 452  * GFLOAT_TO_LE:
 453  * @val: value
 454  *
 455  * Convert 32-bit floating point value (float) from native byte order into
 456  * little endian byte order.
 457  *
 458  * Since: 0.10.22
 459  *
 460  */
 461 /**
 462  * GFLOAT_TO_BE:
 463  * @val: value
 464  *
 465  * Convert 32-bit floating point value (float) from native byte order into
 466  * big endian byte order.
 467  *
 468  * Since: 0.10.22
 469  *
 470  */
 471 /**
 472  * GFLOAT_FROM_LE:
 473  * @val: value
 474  *
 475  * Convert 32-bit floating point value (float) from little endian byte order
 476  * into native byte order.
 477  *
 478  * Since: 0.10.22
 479  *
 480  */
 481 /**
 482  * GFLOAT_FROM_BE:
 483  * @val: value
 484  *
 485  * Convert 32-bit floating point value (float) from big endian byte order
 486  * into native byte order.
 487  *
 488  * Since: 0.10.22
 489  *
 490  */
 491
 492 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
 493 #define GFLOAT_TO_LE(val)    ((gfloat) (val))
 494 #define GFLOAT_TO_BE(val)    (GFLOAT_SWAP_LE_BE (val))
 495 #define GDOUBLE_TO_LE(val)   ((gdouble) (val))
 496 #define GDOUBLE_TO_BE(val)   (GDOUBLE_SWAP_LE_BE (val))
 497
 498 #elif G_BYTE_ORDER == G_BIG_ENDIAN
 499 #define GFLOAT_TO_LE(val)    (GFLOAT_SWAP_LE_BE (val))
 500 #define GFLOAT_TO_BE(val)    ((gfloat) (val))
 501 #define GDOUBLE_TO_LE(val)   (GDOUBLE_SWAP_LE_BE (val))
 502 #define GDOUBLE_TO_BE(val)   ((gdouble) (val))
 503
 504 #else /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
 505 #error unknown ENDIAN type
 506 #endif /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
 507
 508 #define GFLOAT_FROM_LE(val)  (GFLOAT_TO_LE (val))
 509 #define GFLOAT_FROM_BE(val)  (GFLOAT_TO_BE (val))
 510 #define GDOUBLE_FROM_LE(val) (GDOUBLE_TO_LE (val))
 511 #define GDOUBLE_FROM_BE(val) (GDOUBLE_TO_BE (val))
 512
 513 #endif /* !defined(GFLOAT_FROM_LE) */
 514
 515 /**
 516  * GST_READ_FLOAT_LE:
 517  * @data: memory location
 518  *
 519  * Read a 32 bit float value in little endian format from the memory buffer.
 520  *
 521  * Returns: The floating point value read from @data
 522  *
 523  * Since: 0.10.22
 524  *
 525  */
 526 #ifdef _FOOL_GTK_DOC_
 527 G_INLINE_FUNC gfloat GST_READ_FLOAT_LE (const guint8 *data);
 528 #endif
 529
 530 inline static gfloat
 531 GST_READ_FLOAT_LE(const guint8 *data)
 532 {
 533   union
 534   {
 535     guint32 i;
 536     gfloat f;
 537   } u;
 538
 539   u.i = GST_READ_UINT32_LE (data);
 540   return u.f;
 541 }
 542
 543 /**
 544  * GST_READ_FLOAT_BE:
 545  * @data: memory location
 546  *
 547  * Read a 32 bit float value in big endian format from the memory buffer.
 548  *
 549  * Returns: The floating point value read from @data
 550  *
 551  * Since: 0.10.22
 552  *
 553  */
 554 #ifdef _FOOL_GTK_DOC_
 555 G_INLINE_FUNC gfloat GST_READ_FLOAT_BE (const guint8 *data);
 556 #endif
 557
 558 inline static gfloat
 559 GST_READ_FLOAT_BE(const guint8 *data)
 560 {
 561   union
 562   {
 563     guint32 i;
 564     gfloat f;
 565   } u;
 566
 567   u.i = GST_READ_UINT32_BE (data);
 568   return u.f;
 569 }
 570
 571 /**
 572  * GST_READ_DOUBLE_LE:
 573  * @data: memory location
 574  *
 575  * Read a 64 bit double value in little endian format from the memory buffer.
 576  *
 577  * Returns: The double-precision floating point value read from @data
 578  *
 579  * Since: 0.10.22
 580  *
 581  */
 582 #ifdef _FOOL_GTK_DOC_
 583 G_INLINE_FUNC gdouble GST_READ_DOUBLE_LE (const guint8 *data);
 584 #endif
 585
 586 inline static gdouble
 587 GST_READ_DOUBLE_LE(const guint8 *data)
 588 {
 589   union
 590   {
 591     guint64 i;
 592     gdouble d;
 593   } u;
 594
 595   u.i = GST_READ_UINT64_LE (data);
 596   return u.d;
 597 }
 598
 599 /**
 600  * GST_READ_DOUBLE_BE:
 601  * @data: memory location
 602  *
 603  * Read a 64 bit double value in big endian format from the memory buffer.
 604  *
 605  * Returns: The double-precision floating point value read from @data
 606  *
 607  * Since: 0.10.22
 608  *
 609  */
 610 #ifdef _FOOL_GTK_DOC_
 611 G_INLINE_FUNC gdouble GST_READ_DOUBLE_BE (const guint8 *data);
 612 #endif
 613
 614 inline static gdouble
 615 GST_READ_DOUBLE_BE(const guint8 *data)
 616 {
 617   union
 618   {
 619     guint64 i;
 620     gdouble d;
 621   } u;
 622
 623   u.i = GST_READ_UINT64_BE (data);
 624   return u.d;
 625 }
 626
 627 /**
 628  * GST_WRITE_FLOAT_LE:
 629  * @data: memory location
 630  * @num: value to store
 631  *
 632  * Store a 32 bit float value in little endian format into the memory buffer.
 633  *
 634  * Since: 0.10.22
 635  *
 636  */
 637 #ifdef _FOOL_GTK_DOC_
 638 G_INLINE_FUNC void GST_WRITE_FLOAT_LE (guint8 *data, gfloat num);
 639 #endif
 640
 641 inline static void
 642 GST_WRITE_FLOAT_LE(guint8 *data, gfloat num)
 643 {
 644   union
 645   {
 646     guint32 i;
 647     gfloat f;
 648   } u;
 649
 650   u.f = num;
 651   GST_WRITE_UINT32_LE (data, u.i);
 652 }
 653
 654 /**
 655  * GST_WRITE_FLOAT_BE:
 656  * @data: memory location
 657  * @num: value to store
 658  *
 659  * Store a 32 bit float value in big endian format into the memory buffer.
 660  *
 661  * Since: 0.10.22
 662  *
 663  */
 664 #ifdef _FOOL_GTK_DOC_
 665 G_INLINE_FUNC void GST_WRITE_FLOAT_BE (guint8 *data, gfloat num);
 666 #endif
 667
 668 inline static void
 669 GST_WRITE_FLOAT_BE(guint8 *data, gfloat num)
 670 {
 671   union
 672   {
 673     guint32 i;
 674     gfloat f;
 675   } u;
 676
 677   u.f = num;
 678   GST_WRITE_UINT32_BE (data, u.i);
 679 }
 680
 681 /**
 682  * GST_WRITE_DOUBLE_LE:
 683  * @data: memory location
 684  * @num: value to store
 685  *
 686  * Store a 64 bit double value in little endian format into the memory buffer.
 687  *
 688  * Since: 0.10.22
 689  *
 690  */
 691 #ifdef _FOOL_GTK_DOC_
 692 G_INLINE_FUNC void GST_WRITE_DOUBLE_LE (guint8 *data, gdouble num);
 693 #endif
 694
 695 inline static void
 696 GST_WRITE_DOUBLE_LE(guint8 *data, gdouble num)
 697 {
 698   union
 699   {
 700     guint64 i;
 701     gdouble d;
 702   } u;
 703
 704   u.d = num;
 705   GST_WRITE_UINT64_LE (data, u.i);
 706 }
 707
 708 /**
 709  * GST_WRITE_DOUBLE_BE:
 710  * @data: memory location
 711  * @num: value to store
 712  *
 713  * Store a 64 bit double value in big endian format into the memory buffer.
 714  *
 715  * Since: 0.10.22
 716  *
 717  */
 718 #ifdef _FOOL_GTK_DOC_
 719 G_INLINE_FUNC void GST_WRITE_DOUBLE_BE (guint8 *data, gdouble num);
 720 #endif
 721
 722 inline static void
 723 GST_WRITE_DOUBLE_BE(guint8 *data, gdouble num)
 724 {
 725   union
 726   {
 727     guint64 i;
 728     gdouble d;
 729   } u;
 730
 731   u.d = num;
 732   GST_WRITE_UINT64_BE (data, u.i);
 733 }
 734
 735 /* Miscellaneous utility macros */
 736
 737 /**
 738  * GST_ROUND_UP_2:
 739  * @num: integer value to round up
 740  *
 741  * Rounds an integer value up to the next multiple of 2.
 742  */
 743 #define GST_ROUND_UP_2(num)  (((num)+1)&~1)
 744 /**
 745  * GST_ROUND_UP_4:
 746  * @num: integer value to round up
 747  *
 748  * Rounds an integer value up to the next multiple of 4.
 749  */
 750 #define GST_ROUND_UP_4(num)  (((num)+3)&~3)
 751 /**
 752  * GST_ROUND_UP_8:
 753  * @num: integer value to round up
 754  *
 755  * Rounds an integer value up to the next multiple of 8.
 756  */
 757 #define GST_ROUND_UP_8(num)  (((num)+7)&~7)
 758 /**
 759  * GST_ROUND_UP_16:
 760  * @num: integer value to round up
 761  *
 762  * Rounds an integer value up to the next multiple of 16.
 763  */
 764 #define GST_ROUND_UP_16(num) (((num)+15)&~15)
 765 /**
 766  * GST_ROUND_UP_32:
 767  * @num: integer value to round up
 768  *
 769  * Rounds an integer value up to the next multiple of 32.
 770  */
 771 #define GST_ROUND_UP_32(num) (((num)+31)&~31)
 772 /**
 773  * GST_ROUND_UP_64:
 774  * @num: integer value to round up
 775  *
 776  * Rounds an integer value up to the next multiple of 64.
 777  */
 778 #define GST_ROUND_UP_64(num) (((num)+63)&~63)
 779
 780 /**
 781  * GST_ROUND_DOWN_2:
 782  * @num: integer value to round down
 783  *
 784  * Rounds an integer value down to the next multiple of 2.
 785  *
 786  * Since: 0.10.12
 787  */
 788 #define GST_ROUND_DOWN_2(num)  ((num)&(~1))
 789 /**
 790  * GST_ROUND_DOWN_4:
 791  * @num: integer value to round down
 792  *
 793  * Rounds an integer value down to the next multiple of 4.
 794  *
 795  * Since: 0.10.12
 796  */
 797 #define GST_ROUND_DOWN_4(num)  ((num)&(~3))
 798 /**
 799  * GST_ROUND_DOWN_8:
 800  * @num: integer value to round down
 801  *
 802  * Rounds an integer value down to the next multiple of 8.
 803  *
 804  * Since: 0.10.12
 805  */
 806 #define GST_ROUND_DOWN_8(num)  ((num)&(~7))
 807 /**
 808  * GST_ROUND_DOWN_16:
 809  * @num: integer value to round down
 810  *
 811  * Rounds an integer value down to the next multiple of 16.
 812  *
 813  * Since: 0.10.12
 814  */
 815 #define GST_ROUND_DOWN_16(num) ((num)&(~15))
 816 /**
 817  * GST_ROUND_DOWN_32:
 818  * @num: integer value to round down
 819  *
 820  * Rounds an integer value down to the next multiple of 32.
 821  *
 822  * Since: 0.10.12
 823  */
 824 #define GST_ROUND_DOWN_32(num) ((num)&(~31))
 825 /**
 826  * GST_ROUND_DOWN_64:
 827  * @num: integer value to round down
 828  *
 829  * Rounds an integer value down to the next multiple of 64.
 830  *
 831  * Since: 0.10.12
 832  */
 833 #define GST_ROUND_DOWN_64(num) ((num)&(~63))
 834
 835 void                    gst_object_default_error        (GstObject    * source,
 836                                                          const GError * error,
 837                                                          const gchar  * debug);
 838
 839 /* element functions */
 840 void                    gst_element_create_all_pads     (GstElement *element);
 841 GstPad*                 gst_element_get_compatible_pad  (GstElement *element, GstPad *pad,
 842                                                          GstCaps *caps);
 843
 844 GstPadTemplate*         gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
 845
 846 const gchar*            gst_element_state_get_name      (GstState state);
 847 const gchar *           gst_element_state_change_return_get_name (GstStateChangeReturn state_ret);
 848
 849 gboolean                gst_element_link                (GstElement *src, GstElement *dest);
 850 gboolean                gst_element_link_many           (GstElement *element_1,
 851                                                          GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
 852 gboolean                gst_element_link_filtered       (GstElement * src,
 853                                                          GstElement * dest,
 854                                                          GstCaps *filter);
 855 void                    gst_element_unlink              (GstElement *src, GstElement *dest);
 856 void                    gst_element_unlink_many         (GstElement *element_1,
 857                                                          GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
 858
 859 gboolean                gst_element_link_pads           (GstElement *src, const gchar *srcpadname,
 860                                                          GstElement *dest, const gchar *destpadname);
 861 gboolean                gst_element_link_pads_full      (GstElement *src, const gchar *srcpadname,
 862                                                          GstElement *dest, const gchar *destpadname,
 863                                                          GstPadLinkCheck flags);
 864 void                    gst_element_unlink_pads         (GstElement *src, const gchar *srcpadname,
 865                                                          GstElement *dest, const gchar *destpadname);
 866
 867 gboolean                gst_element_link_pads_filtered  (GstElement * src, const gchar * srcpadname,
 868                                                          GstElement * dest, const gchar * destpadname,
 869                                                          GstCaps *filter);
 870
 871 gboolean                gst_element_seek_simple         (GstElement   *element,
 872                                                          GstFormat     format,
 873                                                          GstSeekFlags  seek_flags,
 874                                                          gint64        seek_pos);
 875
 876 /* util elementfactory functions */
 877 gboolean gst_element_factory_can_sink_all_caps (GstElementFactory *factory, const GstCaps *caps);
 878 gboolean gst_element_factory_can_src_all_caps  (GstElementFactory *factory, const GstCaps *caps);
 879 gboolean gst_element_factory_can_sink_any_caps (GstElementFactory *factory, const GstCaps *caps);
 880 gboolean gst_element_factory_can_src_any_caps  (GstElementFactory *factory, const GstCaps *caps);
 881
 882 /* util query functions */
 883 gboolean                gst_element_query_position      (GstElement *element, GstFormat format, gint64 *cur);
 884 gboolean                gst_element_query_duration      (GstElement *element, GstFormat format, gint64 *duration);
 885 gboolean                gst_element_query_convert       (GstElement *element, GstFormat src_format, gint64 src_val,
 886                                                          GstFormat dest_format, gint64 *dest_val);
 887
 888 /* pad functions */
 889 void                    gst_pad_use_fixed_caps          (GstPad *pad);
 890 GstElement*             gst_pad_get_parent_element      (GstPad *pad);
 891
 892 /* util query functions */
 893 gboolean                gst_pad_proxy_query_accept_caps (GstPad *pad, GstQuery *query);
 894 gboolean                gst_pad_proxy_query_caps        (GstPad *pad, GstQuery *query);
 895
 896 gboolean                gst_pad_query_position          (GstPad *pad, GstFormat format, gint64 *cur);
 897 gboolean                gst_pad_query_duration          (GstPad *pad, GstFormat format, gint64 *duration);
 898 gboolean                gst_pad_query_convert           (GstPad *pad, GstFormat src_format, gint64 src_val,
 899                                                          GstFormat dest_format, gint64 *dest_val);
 900 GstCaps *               gst_pad_query_caps              (GstPad *pad, GstCaps *filter);
 901 gboolean                gst_pad_query_accept_caps       (GstPad *pad, GstCaps *caps);
 902
 903
 904 gboolean                gst_pad_peer_query_position     (GstPad *pad, GstFormat format, gint64 *cur);
 905 gboolean                gst_pad_peer_query_duration     (GstPad *pad, GstFormat format, gint64 *duration);
 906 gboolean                gst_pad_peer_query_convert      (GstPad *pad, GstFormat src_format, gint64 src_val,
 907                                                          GstFormat dest_format, gint64 *dest_val);
 908 GstCaps *               gst_pad_peer_query_caps         (GstPad * pad, GstCaps *filter);
 909 gboolean                gst_pad_peer_query_accept_caps  (GstPad * pad, GstCaps *caps);
 910
 911 /* bin functions */
 912 void                    gst_bin_add_many                (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
 913 void                    gst_bin_remove_many             (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
 914 GstPad *                gst_bin_find_unlinked_pad       (GstBin *bin, GstPadDirection direction);
 915
 916 /* parse utility functions */
 917 GstElement *            gst_parse_bin_from_description      (const gchar     * bin_description,
 918                                                              gboolean          ghost_unlinked_pads,
 919                                                              GError         ** err);
 920
 921 GstElement *            gst_parse_bin_from_description_full (const gchar     * bin_description,
 922                                                              gboolean          ghost_unlinked_pads,
 923                                                              GstParseContext * context,
 924                                                              GstParseFlags     flags,
 925                                                              GError         ** err);
 926
 927 GstClockTime            gst_util_get_timestamp          (void);
 928
 929 /**
 930  * GstSearchMode:
 931  * @GST_SEARCH_MODE_EXACT : Only search for exact matches.
 932  * @GST_SEARCH_MODE_BEFORE: Search for an exact match or the element just before.
 933  * @GST_SEARCH_MODE_AFTER : Search for an exact match or the element just after.
 934  *
 935  * The different search modes.
 936  *
 937  * Since: 0.10.23
 938  */
 939 typedef enum {
 940   GST_SEARCH_MODE_EXACT = 0,
 941   GST_SEARCH_MODE_BEFORE,
 942   GST_SEARCH_MODE_AFTER
 943 } GstSearchMode;
 944
 945 gpointer      gst_util_array_binary_search      (gpointer array, guint num_elements,
 946                                                  gsize element_size, GCompareDataFunc search_func,
 947                                                  GstSearchMode mode, gconstpointer search_data,
 948                                                  gpointer user_data);
 949
 950 /* fraction operations */
 951 gint          gst_util_greatest_common_divisor  (gint a, gint b);
 952 gint64        gst_util_greatest_common_divisor_int64 (gint64 a, gint64 b);
 953
 954 void          gst_util_fraction_to_double       (gint src_n, gint src_d, gdouble *dest);
 955 void          gst_util_double_to_fraction       (gdouble src, gint *dest_n, gint *dest_d);
 956
 957 gboolean      gst_util_fraction_multiply        (gint a_n, gint a_d, gint b_n, gint b_d,
 958                                                  gint *res_n, gint *res_d);
 959 gboolean      gst_util_fraction_add             (gint a_n, gint a_d, gint b_n, gint b_d,
 960                                                  gint *res_n, gint *res_d);
 961 gint          gst_util_fraction_compare         (gint a_n, gint a_d, gint b_n, gint b_d);
 962
 963
 964 G_END_DECLS
 965
 966 #endif /* __GST_UTILS_H__ */