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_PURE;
  39 gdouble         gst_util_guint64_to_gdouble     (guint64 value)  G_GNUC_PURE;
  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) G_GNUC_PURE;
  67
  68 guint64         gst_util_uint64_scale_int       (guint64 val, gint num, gint denom) G_GNUC_PURE;
  69
  70 guint32         gst_util_seqnum_next            (void);
  71 gint32          gst_util_seqnum_compare         (guint32 s1, guint32 s2);
  72
  73 void            gst_print_pad_caps              (GString *buf, gint indent, GstPad *pad);
  74 void            gst_print_element_args          (GString *buf, gint indent, GstElement *element);
  75
  76
  77 GType gst_type_register_static_full (GType parent_type,
  78                                            const gchar       *type_name,
  79                                guint              class_size,
  80                                GBaseInitFunc      base_init,
  81                                GBaseFinalizeFunc  base_finalize,
  82                                GClassInitFunc     class_init,
  83                                GClassFinalizeFunc class_finalize,
  84                                gconstpointer      class_data,
  85                                guint              instance_size,
  86                                guint16            n_preallocs,
  87                                GInstanceInitFunc  instance_init,
  88                                const GTypeValueTable *value_table,
  89                                GTypeFlags        flags);
  90
  91
  92 /* Macros for defining classes.  Ideas taken from Bonobo, which took theirs
  93    from Nautilus and GOB. */
  94
  95 #define __gst_once_init_enter(val) (g_once_init_enter (val))
  96 #define __gst_once_init_leave(val,newval) (g_once_init_leave (val, newval))
  97
  98 /**
  99  * GST_BOILERPLATE_FULL:
 100  * @type: the name of the type struct
 101  * @type_as_function: the prefix for the functions
 102  * @parent_type: the parent type struct name
 103  * @parent_type_macro: the parent type macro
 104  * @additional_initializations: function pointer in the form of
 105  * void additional_initializations (GType type) that can be used for
 106  * initializing interfaces and the like
 107  *
 108  * Define the boilerplate type stuff to reduce typos and code size.  Defines
 109  * the get_type method and the parent_class static variable.
 110  *
 111  * <informalexample>
 112  * <programlisting>
 113  *   GST_BOILERPLATE_FULL (GstFdSink, gst_fdsink, GstElement, GST_TYPE_ELEMENT, _do_init);
 114  * </programlisting>
 115  * </informalexample>
 116  */
 117 #define GST_BOILERPLATE_FULL(type, type_as_function, parent_type, parent_type_macro, additional_initializations)        \
 118                                                                         \
 119 static void type_as_function ## _base_init     (gpointer      g_class); \
 120 static void type_as_function ## _class_init    (type ## Class *g_class);\
 121 static void type_as_function ## _init          (type          *object,  \
 122                                                 type ## Class *g_class);\
 123 static parent_type ## Class *parent_class = NULL;                       \
 124 static void                                                             \
 125 type_as_function ## _class_init_trampoline (gpointer g_class,           \
 126                                             gpointer data)              \
 127 {                                                                       \
 128   parent_class = (parent_type ## Class *)                               \
 129       g_type_class_peek_parent (g_class);                               \
 130   type_as_function ## _class_init ((type ## Class *)g_class);           \
 131 }                                                                       \
 132                                                                         \
 133 GType type_as_function ## _get_type (void);                             \
 134                                                                         \
 135 GType                                                                   \
 136 type_as_function ## _get_type (void)                                    \
 137 {                                                                       \
 138   /* The typedef for GType may be gulong or gsize, depending on the     \
 139    * system and whether the compiler is c++ or not. The g_once_init_*   \
 140    * functions always take a gsize * though ... */                      \
 141   static volatile gsize gonce_data = 0;                                 \
 142   if (__gst_once_init_enter (&gonce_data)) {                            \
 143     GType _type;                                                        \
 144     _type = gst_type_register_static_full (parent_type_macro,           \
 145         g_intern_static_string (#type),                                 \
 146         sizeof (type ## Class),                                         \
 147         type_as_function ## _base_init,                                 \
 148         NULL,             /* base_finalize */                           \
 149         type_as_function ## _class_init_trampoline,                     \
 150         NULL,             /* class_finalize */                          \
 151         NULL,               /* class_data */                            \
 152         sizeof (type),                                                  \
 153         0,                  /* n_preallocs */                           \
 154         (GInstanceInitFunc) type_as_function ## _init,                  \
 155         NULL,                                                           \
 156         (GTypeFlags) 0);                                                \
 157     additional_initializations (_type);                                 \
 158     __gst_once_init_leave (&gonce_data, (gsize) _type);                 \
 159   }                                                                     \
 160   return (GType) gonce_data;                                            \
 161 }
 162
 163 #define __GST_DO_NOTHING(type)  /* NOP */
 164
 165 /**
 166  * GST_BOILERPLATE:
 167  * @type: the name of the type struct
 168  * @type_as_function: the prefix for the functions
 169  * @parent_type: the parent type struct name
 170  * @parent_type_macro: the parent type macro
 171  *
 172  * Define the boilerplate type stuff to reduce typos and code size.  Defines
 173  * the get_type method and the parent_class static variable.
 174  *
 175  * <informalexample>
 176  * <programlisting>
 177  *   GST_BOILERPLATE (GstFdSink, gst_fdsink, GstElement, GST_TYPE_ELEMENT);
 178  * </programlisting>
 179  * </informalexample>
 180  */
 181 #define GST_BOILERPLATE(type,type_as_function,parent_type,parent_type_macro)    \
 182   GST_BOILERPLATE_FULL (type, type_as_function, parent_type, parent_type_macro, \
 183       __GST_DO_NOTHING)
 184
 185 /* Like GST_BOILERPLATE, but makes the type 1) implement an interface, and 2)
 186  * implement GstImplementsInterface for that type
 187  *
 188  * After this you will need to implement interface_as_function ## _supported
 189  * and interface_as_function ## _interface_init
 190  */
 191 /**
 192  * GST_BOILERPLATE_WITH_INTERFACE:
 193  * @type: the name of the type struct
 194  * @type_as_function: the prefix for the functions
 195  * @parent_type: the parent type struct name
 196  * @parent_type_as_macro: the parent type macro
 197  * @interface_type: the name of the interface type struct
 198  * @interface_type_as_macro: the interface type macro
 199  * @interface_as_function: the interface function name prefix
 200  *
 201  * Like GST_BOILERPLATE, but makes the type 1) implement an interface, and 2)
 202  * implement GstImplementsInterface for that type.
 203  *
 204  * After this you will need to implement interface_as_function ## _supported
 205  * and interface_as_function ## _interface_init
 206  */
 207 #define GST_BOILERPLATE_WITH_INTERFACE(type, type_as_function,          \
 208     parent_type, parent_type_as_macro, interface_type,                  \
 209     interface_type_as_macro, interface_as_function)                     \
 210                                                                         \
 211 static void interface_as_function ## _interface_init (interface_type ## Class *klass);  \
 212 static gboolean interface_as_function ## _supported (type *object, GType iface_type);   \
 213                                                                         \
 214 static void                                                             \
 215 type_as_function ## _implements_interface_init (GstImplementsInterfaceClass *klass)     \
 216 {                                                                       \
 217   klass->supported = (gboolean (*)(GstImplementsInterface*, GType))interface_as_function ## _supported;     \
 218 }                                                                       \
 219                                                                         \
 220 static void                                                             \
 221 type_as_function ## _init_interfaces (GType type)                       \
 222 {                                                                       \
 223   static const GInterfaceInfo implements_iface_info = {                 \
 224     (GInterfaceInitFunc) type_as_function ## _implements_interface_init,\
 225     NULL,                                                               \
 226     NULL,                                                               \
 227   };                                                                    \
 228   static const GInterfaceInfo iface_info = {                            \
 229     (GInterfaceInitFunc) interface_as_function ## _interface_init,      \
 230     NULL,                                                               \
 231     NULL,                                                               \
 232   };                                                                    \
 233                                                                         \
 234   g_type_add_interface_static (type, GST_TYPE_IMPLEMENTS_INTERFACE,     \
 235       &implements_iface_info);                                          \
 236   g_type_add_interface_static (type, interface_type_as_macro,           \
 237       &iface_info);                                                     \
 238 }                                                                       \
 239                                                                         \
 240 GST_BOILERPLATE_FULL (type, type_as_function, parent_type,              \
 241     parent_type_as_macro, type_as_function ## _init_interfaces)
 242
 243 /**
 244  * GST_CALL_PARENT:
 245  * @parent_class_cast: the name of the class cast macro for the parent type
 246  * @name: name of the function to call
 247  * @args: arguments enclosed in '( )'
 248  *
 249  * Just call the parent handler.  This assumes that there is a variable
 250  * named parent_class that points to the (duh!) parent class.  Note that
 251  * this macro is not to be used with things that return something, use
 252  * the _WITH_DEFAULT version for that
 253  */
 254 #define GST_CALL_PARENT(parent_class_cast, name, args)                  \
 255         ((parent_class_cast(parent_class)->name != NULL) ?              \
 256          parent_class_cast(parent_class)->name args : (void) 0)
 257
 258 /**
 259  * GST_CALL_PARENT_WITH_DEFAULT:
 260  * @parent_class_cast: the name of the class cast macro for the parent type
 261  * @name: name of the function to call
 262  * @args: arguments enclosed in '( )'
 263  * @def_return: default result
 264  *
 265  * Same as GST_CALL_PARENT(), but in case there is no implementation, it
 266  * evaluates to @def_return.
 267  */
 268 #define GST_CALL_PARENT_WITH_DEFAULT(parent_class_cast, name, args, def_return)\
 269         ((parent_class_cast(parent_class)->name != NULL) ?              \
 270          parent_class_cast(parent_class)->name args : def_return)
 271
 272 /* Define PUT and GET functions for unaligned memory */
 273 #define _GST_GET(__data, __idx, __size, __shift) \
 274     (((guint##__size) (((guint8 *) (__data))[__idx])) << __shift)
 275
 276 #define _GST_PUT(__data, __idx, __size, __shift, __num) \
 277     (((guint8 *) (__data))[__idx] = (((guint##__size) __num) >> __shift) & 0xff)
 278
 279 /**
 280  * GST_READ_UINT64_BE:
 281  * @data: memory location
 282  *
 283  * Read a 64 bit unsigned integer value in big endian format from the memory buffer.
 284  */
 285 #define GST_READ_UINT64_BE(data)        (_GST_GET (data, 0, 64, 56) | \
 286                                          _GST_GET (data, 1, 64, 48) | \
 287                                          _GST_GET (data, 2, 64, 40) | \
 288                                          _GST_GET (data, 3, 64, 32) | \
 289                                          _GST_GET (data, 4, 64, 24) | \
 290                                          _GST_GET (data, 5, 64, 16) | \
 291                                          _GST_GET (data, 6, 64,  8) | \
 292                                          _GST_GET (data, 7, 64,  0))
 293
 294 /**
 295  * GST_READ_UINT64_LE:
 296  * @data: memory location
 297  *
 298  * Read a 64 bit unsigned integer value in little endian format from the memory buffer.
 299  */
 300 #define GST_READ_UINT64_LE(data)        (_GST_GET (data, 7, 64, 56) | \
 301                                          _GST_GET (data, 6, 64, 48) | \
 302                                          _GST_GET (data, 5, 64, 40) | \
 303                                          _GST_GET (data, 4, 64, 32) | \
 304                                          _GST_GET (data, 3, 64, 24) | \
 305                                          _GST_GET (data, 2, 64, 16) | \
 306                                          _GST_GET (data, 1, 64,  8) | \
 307                                          _GST_GET (data, 0, 64,  0))
 308
 309 /**
 310  * GST_READ_UINT32_BE:
 311  * @data: memory location
 312  *
 313  * Read a 32 bit unsigned integer value in big endian format from the memory buffer.
 314  */
 315 #define GST_READ_UINT32_BE(data)        (_GST_GET (data, 0, 32, 24) | \
 316                                          _GST_GET (data, 1, 32, 16) | \
 317                                          _GST_GET (data, 2, 32,  8) | \
 318                                          _GST_GET (data, 3, 32,  0))
 319
 320 /**
 321  * GST_READ_UINT32_LE:
 322  * @data: memory location
 323  *
 324  * Read a 32 bit unsigned integer value in little endian format from the memory buffer.
 325  */
 326 #define GST_READ_UINT32_LE(data)        (_GST_GET (data, 3, 32, 24) | \
 327                                          _GST_GET (data, 2, 32, 16) | \
 328                                          _GST_GET (data, 1, 32,  8) | \
 329                                          _GST_GET (data, 0, 32,  0))
 330
 331 /**
 332  * GST_READ_UINT24_BE:
 333  * @data: memory location
 334  *
 335  * Read a 24 bit unsigned integer value in big endian format from the memory buffer.
 336  *
 337  * Since: 0.10.22
 338  */
 339 #define GST_READ_UINT24_BE(data)        (_GST_GET (data, 0, 32, 16) | \
 340                                          _GST_GET (data, 1, 32,  8) | \
 341                                          _GST_GET (data, 2, 32,  0))
 342
 343 /**
 344  * GST_READ_UINT24_LE:
 345  * @data: memory location
 346  *
 347  * Read a 24 bit unsigned integer value in little endian format from the memory buffer.
 348  *
 349  * Since: 0.10.22
 350  */
 351 #define GST_READ_UINT24_LE(data)        (_GST_GET (data, 2, 32, 16) | \
 352                                          _GST_GET (data, 1, 32,  8) | \
 353                                          _GST_GET (data, 0, 32,  0))
 354
 355 /**
 356  * GST_READ_UINT16_BE:
 357  * @data: memory location
 358  *
 359  * Read a 16 bit unsigned integer value in big endian format from the memory buffer.
 360  */
 361 #define GST_READ_UINT16_BE(data)        (_GST_GET (data, 0, 16,  8) | \
 362                                          _GST_GET (data, 1, 16,  0))
 363
 364 /**
 365  * GST_READ_UINT16_LE:
 366  * @data: memory location
 367  *
 368  * Read a 16 bit unsigned integer value in little endian format from the memory buffer.
 369  */
 370 #define GST_READ_UINT16_LE(data)        (_GST_GET (data, 1, 16,  8) | \
 371                                          _GST_GET (data, 0, 16,  0))
 372
 373 /**
 374  * GST_READ_UINT8:
 375  * @data: memory location
 376  *
 377  * Read an 8 bit unsigned integer value from the memory buffer.
 378  */
 379 #define GST_READ_UINT8(data)            (_GST_GET (data, 0,  8,  0))
 380
 381 /**
 382  * GST_WRITE_UINT64_BE:
 383  * @data: memory location
 384  * @num: value to store
 385  *
 386  * Store a 64 bit unsigned integer value in big endian format into the memory buffer.
 387  */
 388 #define GST_WRITE_UINT64_BE(data, num)  do { \
 389                                           _GST_PUT (data, 0, 64, 56, num); \
 390                                           _GST_PUT (data, 1, 64, 48, num); \
 391                                           _GST_PUT (data, 2, 64, 40, num); \
 392                                           _GST_PUT (data, 3, 64, 32, num); \
 393                                           _GST_PUT (data, 4, 64, 24, num); \
 394                                           _GST_PUT (data, 5, 64, 16, num); \
 395                                           _GST_PUT (data, 6, 64,  8, num); \
 396                                           _GST_PUT (data, 7, 64,  0, num); \
 397                                         } while (0)
 398
 399 /**
 400  * GST_WRITE_UINT64_LE:
 401  * @data: memory location
 402  * @num: value to store
 403  *
 404  * Store a 64 bit unsigned integer value in little endian format into the memory buffer.
 405  */
 406 #define GST_WRITE_UINT64_LE(data, num)  do { \
 407                                           _GST_PUT (data, 0, 64,  0, num); \
 408                                           _GST_PUT (data, 1, 64,  8, num); \
 409                                           _GST_PUT (data, 2, 64, 16, num); \
 410                                           _GST_PUT (data, 3, 64, 24, num); \
 411                                           _GST_PUT (data, 4, 64, 32, num); \
 412                                           _GST_PUT (data, 5, 64, 40, num); \
 413                                           _GST_PUT (data, 6, 64, 48, num); \
 414                                           _GST_PUT (data, 7, 64, 56, num); \
 415                                         } while (0)
 416
 417 /**
 418  * GST_WRITE_UINT32_BE:
 419  * @data: memory location
 420  * @num: value to store
 421  *
 422  * Store a 32 bit unsigned integer value in big endian format into the memory buffer.
 423  */
 424 #define GST_WRITE_UINT32_BE(data, num)  do { \
 425                                           _GST_PUT (data, 0, 32, 24, num); \
 426                                           _GST_PUT (data, 1, 32, 16, num); \
 427                                           _GST_PUT (data, 2, 32,  8, num); \
 428                                           _GST_PUT (data, 3, 32,  0, num); \
 429                                         } while (0)
 430
 431 /**
 432  * GST_WRITE_UINT32_LE:
 433  * @data: memory location
 434  * @num: value to store
 435  *
 436  * Store a 32 bit unsigned integer value in little endian format into the memory buffer.
 437  */
 438 #define GST_WRITE_UINT32_LE(data, num)  do { \
 439                                           _GST_PUT (data, 0, 32,  0, num); \
 440                                           _GST_PUT (data, 1, 32,  8, num); \
 441                                           _GST_PUT (data, 2, 32, 16, num); \
 442                                           _GST_PUT (data, 3, 32, 24, num); \
 443                                         } while (0)
 444
 445 /**
 446  * GST_WRITE_UINT24_BE:
 447  * @data: memory location
 448  * @num: value to store
 449  *
 450  * Store a 24 bit unsigned integer value in big endian format into the memory buffer.
 451  *
 452  * Since: 0.10.22
 453  */
 454 #define GST_WRITE_UINT24_BE(data, num)  do { \
 455                                           _GST_PUT (data, 0, 32,  16, num); \
 456                                           _GST_PUT (data, 1, 32,  8, num); \
 457                                           _GST_PUT (data, 2, 32,  0, num); \
 458                                         } while (0)
 459
 460 /**
 461  * GST_WRITE_UINT24_LE:
 462  * @data: memory location
 463  * @num: value to store
 464  *
 465  * Store a 24 bit unsigned integer value in little endian format into the memory buffer.
 466  *
 467  * Since: 0.10.22
 468  */
 469 #define GST_WRITE_UINT24_LE(data, num)  do { \
 470                                           _GST_PUT (data, 0, 32,  0, num); \
 471                                           _GST_PUT (data, 1, 32,  8, num); \
 472                                           _GST_PUT (data, 2, 32,  16, num); \
 473                                         } while (0)
 474
 475 /**
 476  * GST_WRITE_UINT16_BE:
 477  * @data: memory location
 478  * @num: value to store
 479  *
 480  * Store a 16 bit unsigned integer value in big endian format into the memory buffer.
 481  */
 482 #define GST_WRITE_UINT16_BE(data, num)  do { \
 483                                           _GST_PUT (data, 0, 16,  8, num); \
 484                                           _GST_PUT (data, 1, 16,  0, num); \
 485                                         } while (0)
 486
 487 /**
 488  * GST_WRITE_UINT16_LE:
 489  * @data: memory location
 490  * @num: value to store
 491  *
 492  * Store a 16 bit unsigned integer value in little endian format into the memory buffer.
 493  */
 494 #define GST_WRITE_UINT16_LE(data, num)  do { \
 495                                           _GST_PUT (data, 0, 16,  0, num); \
 496                                           _GST_PUT (data, 1, 16,  8, num); \
 497                                         } while (0)
 498
 499 /**
 500  * GST_WRITE_UINT8:
 501  * @data: memory location
 502  * @num: value to store
 503  *
 504  * Store an 8 bit unsigned integer value into the memory buffer.
 505  */
 506 #define GST_WRITE_UINT8(data, num)      do { \
 507                                           _GST_PUT (data, 0,  8,  0, num); \
 508                                         } while (0)
 509
 510 /* Float endianess conversion macros */
 511
 512 /* FIXME: Remove this once we depend on a GLib version with this */
 513 #ifndef GFLOAT_FROM_LE
 514 /**
 515  * GFLOAT_SWAP_LE_BE:
 516  * @in: input value
 517  *
 518  * Swap byte order of a 32-bit floating point value (float).
 519  *
 520  * Since: 0.10.22
 521  *
 522  */
 523 #ifdef _FOOL_GTK_DOC_
 524 G_INLINE_FUNC gfloat GFLOAT_SWAP_LE_BE (gfloat in);
 525 #endif
 526
 527 inline static gfloat
 528 GFLOAT_SWAP_LE_BE(gfloat in)
 529 {
 530   union
 531   {
 532     guint32 i;
 533     gfloat f;
 534   } u;
 535
 536   u.f = in;
 537   u.i = GUINT32_SWAP_LE_BE (u.i);
 538   return u.f;
 539 }
 540
 541 /**
 542  * GDOUBLE_SWAP_LE_BE:
 543  * @in: input value
 544  *
 545  * Swap byte order of a 64-bit floating point value (double).
 546  *
 547  * Since: 0.10.22
 548  *
 549  */
 550 #ifdef _FOOL_GTK_DOC_
 551 G_INLINE_FUNC gdouble GDOUBLE_SWAP_LE_BE (gdouble in);
 552 #endif
 553
 554 inline static gdouble
 555 GDOUBLE_SWAP_LE_BE(gdouble in)
 556 {
 557   union
 558   {
 559     guint64 i;
 560     gdouble d;
 561   } u;
 562
 563   u.d = in;
 564   u.i = GUINT64_SWAP_LE_BE (u.i);
 565   return u.d;
 566 }
 567
 568 /**
 569  * GDOUBLE_TO_LE:
 570  * @val: value
 571  *
 572  * Convert 64-bit floating point value (double) from native byte order into
 573  * little endian byte order.
 574  *
 575  * Since: 0.10.22
 576  *
 577  */
 578 /**
 579  * GDOUBLE_TO_BE:
 580  * @val: value
 581  *
 582  * Convert 64-bit floating point value (double) from native byte order into
 583  * big endian byte order.
 584  *
 585  * Since: 0.10.22
 586  *
 587  */
 588 /**
 589  * GDOUBLE_FROM_LE:
 590  * @val: value
 591  *
 592  * Convert 64-bit floating point value (double) from little endian byte order
 593  * into native byte order.
 594  *
 595  * Since: 0.10.22
 596  *
 597  */
 598 /**
 599  * GDOUBLE_FROM_BE:
 600  * @val: value
 601  *
 602  * Convert 64-bit floating point value (double) from big endian byte order
 603  * into native byte order.
 604  *
 605  * Since: 0.10.22
 606  *
 607  */
 608
 609 /**
 610  * GFLOAT_TO_LE:
 611  * @val: value
 612  *
 613  * Convert 32-bit floating point value (float) from native byte order into
 614  * little endian byte order.
 615  *
 616  * Since: 0.10.22
 617  *
 618  */
 619 /**
 620  * GFLOAT_TO_BE:
 621  * @val: value
 622  *
 623  * Convert 32-bit floating point value (float) from native byte order into
 624  * big endian byte order.
 625  *
 626  * Since: 0.10.22
 627  *
 628  */
 629 /**
 630  * GFLOAT_FROM_LE:
 631  * @val: value
 632  *
 633  * Convert 32-bit floating point value (float) from little endian byte order
 634  * into native byte order.
 635  *
 636  * Since: 0.10.22
 637  *
 638  */
 639 /**
 640  * GFLOAT_FROM_BE:
 641  * @val: value
 642  *
 643  * Convert 32-bit floating point value (float) from big endian byte order
 644  * into native byte order.
 645  *
 646  * Since: 0.10.22
 647  *
 648  */
 649
 650 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
 651 #define GFLOAT_TO_LE(val)    ((gfloat) (val))
 652 #define GFLOAT_TO_BE(val)    (GFLOAT_SWAP_LE_BE (val))
 653 #define GDOUBLE_TO_LE(val)   ((gdouble) (val))
 654 #define GDOUBLE_TO_BE(val)   (GDOUBLE_SWAP_LE_BE (val))
 655
 656 #elif G_BYTE_ORDER == G_BIG_ENDIAN
 657 #define GFLOAT_TO_LE(val)    (GFLOAT_SWAP_LE_BE (val))
 658 #define GFLOAT_TO_BE(val)    ((gfloat) (val))
 659 #define GDOUBLE_TO_LE(val)   (GDOUBLE_SWAP_LE_BE (val))
 660 #define GDOUBLE_TO_BE(val)   ((gdouble) (val))
 661
 662 #else /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
 663 #error unknown ENDIAN type
 664 #endif /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
 665
 666 #define GFLOAT_FROM_LE(val)  (GFLOAT_TO_LE (val))
 667 #define GFLOAT_FROM_BE(val)  (GFLOAT_TO_BE (val))
 668 #define GDOUBLE_FROM_LE(val) (GDOUBLE_TO_LE (val))
 669 #define GDOUBLE_FROM_BE(val) (GDOUBLE_TO_BE (val))
 670
 671 #endif /* !defined(GFLOAT_FROM_LE) */
 672
 673 /**
 674  * GST_READ_FLOAT_LE:
 675  * @data: memory location
 676  *
 677  * Read a 32 bit float value in little endian format from the memory buffer.
 678  *
 679  * Since: 0.10.22
 680  *
 681  */
 682 #ifdef _FOOL_GTK_DOC_
 683 G_INLINE_FUNC gfloat GST_READ_FLOAT_LE (const guint8 *data);
 684 #endif
 685
 686 inline static gfloat
 687 GST_READ_FLOAT_LE(const guint8 *data)
 688 {
 689   union
 690   {
 691     guint32 i;
 692     gfloat f;
 693   } u;
 694
 695   u.i = GST_READ_UINT32_LE (data);
 696   return u.f;
 697 }
 698
 699 /**
 700  * GST_READ_FLOAT_BE:
 701  * @data: memory location
 702  *
 703  * Read a 32 bit float value in big endian format from the memory buffer.
 704  *
 705  * Since: 0.10.22
 706  *
 707  */
 708 #ifdef _FOOL_GTK_DOC_
 709 G_INLINE_FUNC gfloat GST_READ_FLOAT_BE (const guint8 *data);
 710 #endif
 711
 712 inline static gfloat
 713 GST_READ_FLOAT_BE(const guint8 *data)
 714 {
 715   union
 716   {
 717     guint32 i;
 718     gfloat f;
 719   } u;
 720
 721   u.i = GST_READ_UINT32_BE (data);
 722   return u.f;
 723 }
 724
 725 /**
 726  * GST_READ_DOUBLE_LE:
 727  * @data: memory location
 728  *
 729  * Read a 64 bit double value in little endian format from the memory buffer.
 730  *
 731  * Since: 0.10.22
 732  *
 733  */
 734 #ifdef _FOOL_GTK_DOC_
 735 G_INLINE_FUNC gdouble GST_READ_DOUBLE_LE (const guint8 *data);
 736 #endif
 737
 738 inline static gdouble
 739 GST_READ_DOUBLE_LE(const guint8 *data)
 740 {
 741   union
 742   {
 743     guint64 i;
 744     gdouble d;
 745   } u;
 746
 747   u.i = GST_READ_UINT64_LE (data);
 748   return u.d;
 749 }
 750
 751 /**
 752  * GST_READ_DOUBLE_BE:
 753  * @data: memory location
 754  *
 755  * Read a 64 bit double value in big endian format from the memory buffer.
 756  *
 757  * Since: 0.10.22
 758  *
 759  */
 760 #ifdef _FOOL_GTK_DOC_
 761 G_INLINE_FUNC gdouble GST_READ_DOUBLE_BE (const guint8 *data);
 762 #endif
 763
 764 inline static gdouble
 765 GST_READ_DOUBLE_BE(const guint8 *data)
 766 {
 767   union
 768   {
 769     guint64 i;
 770     gdouble d;
 771   } u;
 772
 773   u.i = GST_READ_UINT64_BE (data);
 774   return u.d;
 775 }
 776
 777 /**
 778  * GST_WRITE_FLOAT_LE:
 779  * @data: memory location
 780  * @num: value to store
 781  *
 782  * Store a 32 bit float value in little endian format into the memory buffer.
 783  *
 784  * Since: 0.10.22
 785  *
 786  */
 787 #ifdef _FOOL_GTK_DOC_
 788 G_INLINE_FUNC void GST_WRITE_FLOAT_LE (guint8 *data, gfloat num);
 789 #endif
 790
 791 inline static void
 792 GST_WRITE_FLOAT_LE(guint8 *data, gfloat num)
 793 {
 794   union
 795   {
 796     guint32 i;
 797     gfloat f;
 798   } u;
 799
 800   u.f = num;
 801   GST_WRITE_UINT32_LE (data, u.i);
 802 }
 803
 804 /**
 805  * GST_WRITE_FLOAT_BE:
 806  * @data: memory location
 807  * @num: value to store
 808  *
 809  * Store a 32 bit float value in big endian format into the memory buffer.
 810  *
 811  * Since: 0.10.22
 812  *
 813  */
 814 #ifdef _FOOL_GTK_DOC_
 815 G_INLINE_FUNC void GST_WRITE_FLOAT_BE (guint8 *data, gfloat num);
 816 #endif
 817
 818 inline static void
 819 GST_WRITE_FLOAT_BE(guint8 *data, gfloat num)
 820 {
 821   union
 822   {
 823     guint32 i;
 824     gfloat f;
 825   } u;
 826
 827   u.f = num;
 828   GST_WRITE_UINT32_BE (data, u.i);
 829 }
 830
 831 /**
 832  * GST_WRITE_DOUBLE_LE:
 833  * @data: memory location
 834  * @num: value to store
 835  *
 836  * Store a 64 bit double value in little endian format into the memory buffer.
 837  *
 838  * Since: 0.10.22
 839  *
 840  */
 841 #ifdef _FOOL_GTK_DOC_
 842 G_INLINE_FUNC void GST_WRITE_DOUBLE_LE (guint8 *data, gdouble num);
 843 #endif
 844
 845 inline static void
 846 GST_WRITE_DOUBLE_LE(guint8 *data, gdouble num)
 847 {
 848   union
 849   {
 850     guint64 i;
 851     gdouble d;
 852   } u;
 853
 854   u.d = num;
 855   GST_WRITE_UINT64_LE (data, u.i);
 856 }
 857
 858 /**
 859  * GST_WRITE_DOUBLE_BE:
 860  * @data: memory location
 861  * @num: value to store
 862  *
 863  * Store a 64 bit double value in big endian format into the memory buffer.
 864  *
 865  * Since: 0.10.22
 866  *
 867  */
 868 #ifdef _FOOL_GTK_DOC_
 869 G_INLINE_FUNC void GST_WRITE_DOUBLE_BE (guint8 *data, gdouble num);
 870 #endif
 871
 872 inline static void
 873 GST_WRITE_DOUBLE_BE(guint8 *data, gdouble num)
 874 {
 875   union
 876   {
 877     guint64 i;
 878     gdouble d;
 879   } u;
 880
 881   u.d = num;
 882   GST_WRITE_UINT64_BE (data, u.i);
 883 }
 884
 885 /* Miscellaneous utility macros */
 886
 887 /**
 888  * GST_ROUND_UP_2:
 889  * @num: integer value to round up
 890  *
 891  * Rounds an integer value up to the next multiple of 2.
 892  */
 893 #define GST_ROUND_UP_2(num)  (((num)+1)&~1)
 894 /**
 895  * GST_ROUND_UP_4:
 896  * @num: integer value to round up
 897  *
 898  * Rounds an integer value up to the next multiple of 4.
 899  */
 900 #define GST_ROUND_UP_4(num)  (((num)+3)&~3)
 901 /**
 902  * GST_ROUND_UP_8:
 903  * @num: integer value to round up
 904  *
 905  * Rounds an integer value up to the next multiple of 8.
 906  */
 907 #define GST_ROUND_UP_8(num)  (((num)+7)&~7)
 908 /**
 909  * GST_ROUND_UP_16:
 910  * @num: integer value to round up
 911  *
 912  * Rounds an integer value up to the next multiple of 16.
 913  */
 914 #define GST_ROUND_UP_16(num) (((num)+15)&~15)
 915 /**
 916  * GST_ROUND_UP_32:
 917  * @num: integer value to round up
 918  *
 919  * Rounds an integer value up to the next multiple of 32.
 920  */
 921 #define GST_ROUND_UP_32(num) (((num)+31)&~31)
 922 /**
 923  * GST_ROUND_UP_64:
 924  * @num: integer value to round up
 925  *
 926  * Rounds an integer value up to the next multiple of 64.
 927  */
 928 #define GST_ROUND_UP_64(num) (((num)+63)&~63)
 929
 930 /**
 931  * GST_ROUND_DOWN_2:
 932  * @num: integer value to round down
 933  *
 934  * Rounds an integer value down to the next multiple of 2.
 935  *
 936  * Since: 0.10.12
 937  */
 938 #define GST_ROUND_DOWN_2(num)  ((num)&(~1))
 939 /**
 940  * GST_ROUND_DOWN_4:
 941  * @num: integer value to round down
 942  *
 943  * Rounds an integer value down to the next multiple of 4.
 944  *
 945  * Since: 0.10.12
 946  */
 947 #define GST_ROUND_DOWN_4(num)  ((num)&(~3))
 948 /**
 949  * GST_ROUND_DOWN_8:
 950  * @num: integer value to round down
 951  *
 952  * Rounds an integer value down to the next multiple of 8.
 953  *
 954  * Since: 0.10.12
 955  */
 956 #define GST_ROUND_DOWN_8(num)  ((num)&(~7))
 957 /**
 958  * GST_ROUND_DOWN_16:
 959  * @num: integer value to round down
 960  *
 961  * Rounds an integer value down to the next multiple of 16.
 962  *
 963  * Since: 0.10.12
 964  */
 965 #define GST_ROUND_DOWN_16(num) ((num)&(~15))
 966 /**
 967  * GST_ROUND_DOWN_32:
 968  * @num: integer value to round down
 969  *
 970  * Rounds an integer value down to the next multiple of 32.
 971  *
 972  * Since: 0.10.12
 973  */
 974 #define GST_ROUND_DOWN_32(num) ((num)&(~31))
 975 /**
 976  * GST_ROUND_DOWN_64:
 977  * @num: integer value to round down
 978  *
 979  * Rounds an integer value down to the next multiple of 64.
 980  *
 981  * Since: 0.10.12
 982  */
 983 #define GST_ROUND_DOWN_64(num) ((num)&(~63))
 984
 985 void                    gst_object_default_error        (GstObject * source,
 986                                                          GError * error, gchar * debug);
 987
 988 /* element functions */
 989 void                    gst_element_create_all_pads     (GstElement *element);
 990 GstPad*                 gst_element_get_compatible_pad  (GstElement *element, GstPad *pad,
 991                                                          const GstCaps *caps);
 992
 993 GstPadTemplate*         gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
 994
 995 G_CONST_RETURN gchar*   gst_element_state_get_name      (GstState state);
 996 G_CONST_RETURN gchar *  gst_element_state_change_return_get_name (GstStateChangeReturn state_ret);
 997
 998 gboolean                gst_element_link                (GstElement *src, GstElement *dest);
 999 gboolean                gst_element_link_many           (GstElement *element_1,
1000                                                          GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
1001 gboolean                gst_element_link_filtered       (GstElement * src,
1002                                                          GstElement * dest,
1003                                                          GstCaps *filter);
1004 void                    gst_element_unlink              (GstElement *src, GstElement *dest);
1005 void                    gst_element_unlink_many         (GstElement *element_1,
1006                                                          GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
1007
1008 gboolean                gst_element_link_pads           (GstElement *src, const gchar *srcpadname,
1009                                                          GstElement *dest, const gchar *destpadname);
1010 void                    gst_element_unlink_pads         (GstElement *src, const gchar *srcpadname,
1011                                                          GstElement *dest, const gchar *destpadname);
1012
1013 gboolean                gst_element_link_pads_filtered  (GstElement * src, const gchar * srcpadname,
1014                                                          GstElement * dest, const gchar * destpadname,
1015                                                          GstCaps *filter);
1016
1017 gboolean        gst_element_seek_simple (GstElement   *element,
1018                                          GstFormat     format,
1019                                          GstSeekFlags  seek_flags,
1020                                          gint64        seek_pos);
1021
1022 /* util elementfactory functions */
1023 gboolean                gst_element_factory_can_src_caps(GstElementFactory *factory, const GstCaps *caps);
1024 gboolean                gst_element_factory_can_sink_caps(GstElementFactory *factory, const GstCaps *caps);
1025
1026 /* util query functions */
1027 gboolean                gst_element_query_position      (GstElement *element, GstFormat *format,
1028                                                          gint64 *cur);
1029 gboolean                gst_element_query_duration      (GstElement *element, GstFormat *format,
1030                                                          gint64 *duration);
1031 gboolean                gst_element_query_convert       (GstElement *element, GstFormat src_format, gint64 src_val,
1032                                                          GstFormat *dest_format, gint64 *dest_val);
1033
1034 /* element class functions */
1035 void                    gst_element_class_install_std_props (GstElementClass * klass,
1036                                                          const gchar * first_name, ...) G_GNUC_NULL_TERMINATED;
1037
1038 /* pad functions */
1039 gboolean                gst_pad_can_link                (GstPad *srcpad, GstPad *sinkpad);
1040
1041 void                    gst_pad_use_fixed_caps          (GstPad *pad);
1042 GstCaps*                gst_pad_get_fixed_caps_func     (GstPad *pad);
1043 GstCaps*                gst_pad_proxy_getcaps           (GstPad * pad);
1044 gboolean                gst_pad_proxy_setcaps           (GstPad * pad, GstCaps * caps);
1045
1046 GstElement*             gst_pad_get_parent_element      (GstPad *pad);
1047
1048 /* util query functions */
1049 gboolean                gst_pad_query_position          (GstPad *pad, GstFormat *format,
1050                                                          gint64 *cur);
1051 gboolean                gst_pad_query_duration          (GstPad *pad, GstFormat *format,
1052                                                          gint64 *duration);
1053 gboolean                gst_pad_query_convert           (GstPad *pad, GstFormat src_format, gint64 src_val,
1054                                                          GstFormat *dest_format, gint64 *dest_val);
1055
1056 gboolean                gst_pad_query_peer_position     (GstPad *pad, GstFormat *format,
1057                                                          gint64 *cur);
1058 gboolean                gst_pad_query_peer_duration     (GstPad *pad, GstFormat *format,
1059                                                          gint64 *duration);
1060 gboolean                gst_pad_query_peer_convert      (GstPad *pad, GstFormat src_format, gint64 src_val,
1061                                                          GstFormat *dest_format, gint64 *dest_val);
1062
1063 /* bin functions */
1064 void                    gst_bin_add_many                (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
1065 void                    gst_bin_remove_many             (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
1066 GstPad *                gst_bin_find_unlinked_pad       (GstBin *bin, GstPadDirection direction);
1067 #ifndef GST_DISABLE_DEPRECATED
1068 GstPad *                gst_bin_find_unconnected_pad    (GstBin *bin, GstPadDirection direction);
1069 #endif
1070
1071 /* buffer functions */
1072 GstBuffer *             gst_buffer_merge                (GstBuffer * buf1, GstBuffer * buf2);
1073 GstBuffer *             gst_buffer_join                 (GstBuffer * buf1, GstBuffer * buf2);
1074 #ifndef GST_DISABLE_DEPRECATED
1075 void                    gst_buffer_stamp                (GstBuffer * dest, const GstBuffer * src);
1076 #endif /* GST_DISABLE_DEPRECATED */
1077
1078 /* atomic functions */
1079 #ifndef GST_DISABLE_DEPRECATED
1080 void                    gst_atomic_int_set              (gint * atomic_int, gint value);
1081 #endif
1082
1083 /* probes */
1084 gulong                  gst_pad_add_data_probe          (GstPad   * pad,
1085                                                          GCallback  handler,
1086                                                          gpointer   data);
1087
1088 gulong                  gst_pad_add_data_probe_full     (GstPad       * pad,
1089                                                          GCallback      handler,
1090                                                          gpointer       data,
1091                                                          GDestroyNotify notify);
1092
1093 void                    gst_pad_remove_data_probe       (GstPad * pad, guint handler_id);
1094
1095 gulong                  gst_pad_add_event_probe         (GstPad   * pad,
1096                                                          GCallback  handler,
1097                                                          gpointer   data);
1098
1099 gulong                  gst_pad_add_event_probe_full    (GstPad       * pad,
1100                                                          GCallback      handler,
1101                                                          gpointer       data,
1102                                                          GDestroyNotify notify);
1103
1104 void                    gst_pad_remove_event_probe      (GstPad * pad, guint handler_id);
1105
1106 gulong                  gst_pad_add_buffer_probe        (GstPad   * pad,
1107                                                          GCallback  handler,
1108                                                          gpointer   data);
1109
1110 gulong                  gst_pad_add_buffer_probe_full   (GstPad       * pad,
1111                                                          GCallback      handler,
1112                                                          gpointer       data,
1113                                                          GDestroyNotify notify);
1114
1115 void                    gst_pad_remove_buffer_probe     (GstPad * pad, guint handler_id);
1116
1117 /* tag emission utility functions */
1118 void                    gst_element_found_tags_for_pad  (GstElement * element,
1119                                                          GstPad * pad,
1120                                                          GstTagList * list);
1121 void                    gst_element_found_tags          (GstElement * element,
1122                                                          GstTagList * list);
1123
1124 /* parse utility functions */
1125 GstElement *            gst_parse_bin_from_description      (const gchar     * bin_description,
1126                                                              gboolean          ghost_unlinked_pads,
1127                                                              GError         ** err);
1128
1129 GstElement *            gst_parse_bin_from_description_full (const gchar     * bin_description,
1130                                                              gboolean          ghost_unlinked_pads,
1131                                                              GstParseContext * context,
1132                                                              GstParseFlags     flags,
1133                                                              GError         ** err);
1134
1135 GstClockTime gst_util_get_timestamp (void);
1136
1137 /**
1138  * GstSearchMode:
1139  * @GST_SEARCH_MODE_EXACT : Only search for exact matches.
1140  * @GST_SEARCH_MODE_BEFORE: Search for an exact match or the element just before.
1141  * @GST_SEARCH_MODE_AFTER : Search for an exact match or the element just after.
1142  *
1143  * The different search modes.
1144  *
1145  * Since: 0.10.23
1146  */
1147 typedef enum {
1148   GST_SEARCH_MODE_EXACT = 0,
1149   GST_SEARCH_MODE_BEFORE,
1150   GST_SEARCH_MODE_AFTER
1151 } GstSearchMode;
1152
1153 gpointer gst_util_array_binary_search (gpointer array, guint num_elements, gsize element_size, GCompareDataFunc search_func, GstSearchMode mode, gconstpointer search_data, gpointer user_data);
1154
1155 G_END_DECLS
1156
1157 #endif /* __GST_UTILS_H__ */