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
  31 G_BEGIN_DECLS
  32
  33 void            gst_util_set_value_from_string  (GValue *value, const gchar *value_str);
  34 void            gst_util_set_object_arg         (GObject *object, const gchar *name, const gchar *value);
  35 void            gst_util_dump_mem               (const guchar *mem, guint size);
  36
  37 guint64         gst_util_gdouble_to_guint64     (gdouble value);
  38 gdouble         gst_util_guint64_to_gdouble     (guint64 value);
  39
  40 /**
  41  * gst_guint64_to_gdouble:
  42  * @value: the #guint64 value to convert
  43  *
  44  * Convert @value to a gdouble.
  45  *
  46  * Returns: @value converted to a #gdouble.
  47  */
  48
  49 /**
  50  * gst_gdouble_to_guint64:
  51  * @value: the #gdouble value to convert
  52  *
  53  * Convert @value to a guint64.
  54  *
  55  * Returns: @value converted to a #guint64.
  56  */
  57 #ifdef WIN32
  58 #define         gst_gdouble_to_guint64(value)   gst_util_gdouble_to_guint64(value)
  59 #define         gst_guint64_to_gdouble(value)   gst_util_guint64_to_gdouble(value)
  60 #else
  61 #define         gst_gdouble_to_guint64(value)   ((guint64) (value))
  62 #define         gst_guint64_to_gdouble(value)   ((gdouble) (value))
  63 #endif
  64
  65 guint64         gst_util_uint64_scale           (guint64 val, guint64 num, guint64 denom);
  66
  67 guint64         gst_util_uint64_scale_int       (guint64 val, gint num, gint denom);
  68
  69 void            gst_print_pad_caps              (GString *buf, gint indent, GstPad *pad);
  70 void            gst_print_element_args          (GString *buf, gint indent, GstElement *element);
  71
  72
  73 /* Macros for defining classes.  Ideas taken from Bonobo, which took theirs
  74    from Nautilus and GOB. */
  75
  76 /**
  77  * GST_BOILERPLATE_FULL:
  78  * @type: the name of the type struct
  79  * @type_as_function: the prefix for the functions
  80  * @parent_type: the parent type struct name
  81  * @parent_type_macro: the parent type macro
  82  * @additional_initializations: function pointer in the form of
  83  * void additional_initializations (GType type) that can be used for
  84  * initializing interfaces and the like
  85  *
  86  * Define the boilerplate type stuff to reduce typos and code size.  Defines
  87  * the get_type method and the parent_class static variable.
  88  *
  89  * <informalexample>
  90  * <programlisting>
  91  *   GST_BOILERPLATE_FULL (GstFdSink, gst_fdsink, GstElement, GST_TYPE_ELEMENT, _do_init);
  92  * </programlisting>
  93  * </informalexample>
  94  */
  95 #define GST_BOILERPLATE_FULL(type, type_as_function, parent_type, parent_type_macro, additional_initializations)        \
  96                                                                         \
  97 static void type_as_function ## _base_init     (gpointer      g_class); \
  98 static void type_as_function ## _class_init    (type ## Class *g_class);\
  99 static void type_as_function ## _init          (type          *object,  \
 100                                                 type ## Class *g_class);\
 101 static parent_type ## Class *parent_class = NULL;                       \
 102 static void                                                             \
 103 type_as_function ## _class_init_trampoline (gpointer g_class,           \
 104                                             gpointer data)              \
 105 {                                                                       \
 106   parent_class = (parent_type ## Class *)                               \
 107       g_type_class_peek_parent (g_class);                               \
 108   type_as_function ## _class_init ((type ## Class *)g_class);           \
 109 }                                                                       \
 110                                                                         \
 111 GType type_as_function ## _get_type (void);                             \
 112                                                                         \
 113 GType                                                                   \
 114 type_as_function ## _get_type (void)                                    \
 115 {                                                                       \
 116   static GType object_type = 0;                                         \
 117   if (G_UNLIKELY (object_type == 0)) {                                  \
 118     static const GTypeInfo object_info = {                              \
 119       sizeof (type ## Class),                                           \
 120       type_as_function ## _base_init,                                   \
 121       NULL,               /* base_finalize */                           \
 122       type_as_function ## _class_init_trampoline,                       \
 123       NULL,               /* class_finalize */                          \
 124       NULL,               /* class_data */                              \
 125       sizeof (type),                                                    \
 126       0,                  /* n_preallocs */                             \
 127       (GInstanceInitFunc) type_as_function ## _init                     \
 128     };                                                                  \
 129     object_type = g_type_register_static (parent_type_macro, #type,     \
 130         &object_info, (GTypeFlags) 0);                                  \
 131     additional_initializations (object_type);                           \
 132   }                                                                     \
 133   return object_type;                                                   \
 134 }
 135
 136 #define __GST_DO_NOTHING(type)  /* NOP */
 137
 138 /**
 139  * GST_BOILERPLATE:
 140  * @type: the name of the type struct
 141  * @type_as_function: the prefix for the functions
 142  * @parent_type: the parent type struct name
 143  * @parent_type_macro: the parent type macro
 144  *
 145  * Define the boilerplate type stuff to reduce typos and code size.  Defines
 146  * the get_type method and the parent_class static variable.
 147  *
 148  * <informalexample>
 149  * <programlisting>
 150  *   GST_BOILERPLATE (GstFdSink, gst_fdsink, GstElement, GST_TYPE_ELEMENT);
 151  * </programlisting>
 152  * </informalexample>
 153  */
 154 #define GST_BOILERPLATE(type,type_as_function,parent_type,parent_type_macro)    \
 155   GST_BOILERPLATE_FULL (type, type_as_function, parent_type, parent_type_macro, \
 156       __GST_DO_NOTHING)
 157
 158 /* Like GST_BOILERPLATE, but makes the type 1) implement an interface, and 2)
 159  * implement GstImplementsInterface for that type
 160  *
 161  * After this you will need to implement interface_as_function ## _supported
 162  * and interface_as_function ## _interface_init
 163  */
 164 /**
 165  * GST_BOILERPLATE_WITH_INTERFACE:
 166  * @type: the name of the type struct
 167  * @type_as_function: the prefix for the functions
 168  * @parent_type: the parent type struct name
 169  * @parent_type_as_macro: the parent type macro
 170  * @interface_type: the name of the interface type struct
 171  * @interface_type_as_macro: the interface type macro
 172  * @interface_as_function: the interface function name prefix
 173  *
 174  * Like GST_BOILERPLATE, but makes the type 1) implement an interface, and 2)
 175  * implement GstImplementsInterface for that type.
 176  *
 177  * After this you will need to implement interface_as_function ## _supported
 178  * and interface_as_function ## _interface_init
 179  */
 180 #define GST_BOILERPLATE_WITH_INTERFACE(type, type_as_function,          \
 181     parent_type, parent_type_as_macro, interface_type,                  \
 182     interface_type_as_macro, interface_as_function)                     \
 183                                                                         \
 184 static void interface_as_function ## _interface_init (interface_type ## Class *klass);  \
 185 static gboolean interface_as_function ## _supported (type *object, GType iface_type);   \
 186                                                                         \
 187 static void                                                             \
 188 type_as_function ## _implements_interface_init (GstImplementsInterfaceClass *klass)     \
 189 {                                                                       \
 190   klass->supported = (gboolean (*)(GstImplementsInterface*, GType))interface_as_function ## _supported;     \
 191 }                                                                       \
 192                                                                         \
 193 static void                                                             \
 194 type_as_function ## _init_interfaces (GType type)                       \
 195 {                                                                       \
 196   static const GInterfaceInfo implements_iface_info = {                 \
 197     (GInterfaceInitFunc) type_as_function ## _implements_interface_init,\
 198     NULL,                                                               \
 199     NULL,                                                               \
 200   };                                                                    \
 201   static const GInterfaceInfo iface_info = {                            \
 202     (GInterfaceInitFunc) interface_as_function ## _interface_init,      \
 203     NULL,                                                               \
 204     NULL,                                                               \
 205   };                                                                    \
 206                                                                         \
 207   g_type_add_interface_static (type, GST_TYPE_IMPLEMENTS_INTERFACE,     \
 208       &implements_iface_info);                                          \
 209   g_type_add_interface_static (type, interface_type_as_macro,           \
 210       &iface_info);                                                     \
 211 }                                                                       \
 212                                                                         \
 213 GST_BOILERPLATE_FULL (type, type_as_function, parent_type,              \
 214     parent_type_as_macro, type_as_function ## _init_interfaces)
 215
 216 /**
 217  * GST_CALL_PARENT:
 218  * @parent_class_cast: the name of the class cast macro for the parent type
 219  * @name: name of the function to call
 220  * @args: arguments enclosed in '( )'
 221  *
 222  * Just call the parent handler.  This assumes that there is a variable
 223  * named parent_class that points to the (duh!) parent class.  Note that
 224  * this macro is not to be used with things that return something, use
 225  * the _WITH_DEFAULT version for that
 226  */
 227 #define GST_CALL_PARENT(parent_class_cast, name, args)                  \
 228         ((parent_class_cast(parent_class)->name != NULL) ?              \
 229          parent_class_cast(parent_class)->name args : (void) 0)
 230
 231 /**
 232  * GST_CALL_PARENT_WITH_DEFAULT:
 233  * @parent_class_cast: the name of the class cast macro for the parent type
 234  * @name: name of the function to call
 235  * @args: arguments enclosed in '( )'
 236  * @def_return: default result
 237  *
 238  * Same as GST_CALL_PARENT(), but in case there is no implementation, it
 239  * evaluates to @def_return.
 240  */
 241 #define GST_CALL_PARENT_WITH_DEFAULT(parent_class_cast, name, args, def_return)\
 242         ((parent_class_cast(parent_class)->name != NULL) ?              \
 243          parent_class_cast(parent_class)->name args : def_return)
 244
 245 /* Define possibly unaligned memory access method whether the type of
 246  * architecture. */
 247 #if GST_HAVE_UNALIGNED_ACCESS
 248
 249 #define _GST_GET(__data, __size, __end) \
 250     (GUINT##__size##_FROM_##__end (* ((guint##__size *) (__data))))
 251
 252 /**
 253  * GST_READ_UINT64_BE:
 254  * @data: memory location
 255  *
 256  * Read a 64 bit unsigned integer value in big endian format from the memory buffer.
 257  */
 258 #define GST_READ_UINT64_BE(data)        _GST_GET (data, 64, BE)
 259 /**
 260  * GST_READ_UINT64_LE:
 261  * @data: memory location
 262  *
 263  * Read a 64 bit unsigned integer value in little endian format from the memory buffer.
 264  */
 265 #define GST_READ_UINT64_LE(data)        _GST_GET (data, 64, LE)
 266 /**
 267  * GST_READ_UINT32_BE:
 268  * @data: memory location
 269  *
 270  * Read a 32 bit unsigned integer value in big endian format from the memory buffer.
 271  */
 272 #define GST_READ_UINT32_BE(data)        _GST_GET (data, 32, BE)
 273 /**
 274  * GST_READ_UINT32_LE:
 275  * @data: memory location
 276  *
 277  * Read a 32 bit unsigned integer value in little endian format from the memory buffer.
 278  */
 279 #define GST_READ_UINT32_LE(data)        _GST_GET (data, 32, LE)
 280 /**
 281  * GST_READ_UINT16_BE:
 282  * @data: memory location
 283  *
 284  * Read a 16 bit unsigned integer value in big endian format from the memory buffer.
 285  */
 286 #define GST_READ_UINT16_BE(data)        _GST_GET (data, 16, BE)
 287 /**
 288  * GST_READ_UINT16_LE:
 289  * @data: memory location
 290  *
 291  * Read a 16 bit unsigned integer value in little endian format from the memory buffer.
 292  */
 293 #define GST_READ_UINT16_LE(data)        _GST_GET (data, 16, LE)
 294 /**
 295  * GST_READ_UINT8:
 296  * @data: memory location
 297  *
 298  * Read an 8 bit unsigned integer value from the memory buffer.
 299  */
 300 #define GST_READ_UINT8(data)            (* ((guint8 *) (data)))
 301
 302 #define _GST_PUT(__data, __size, __end, __num) \
 303     ((* (guint##__size *) (__data)) = GUINT##__size##_TO_##__end (__num))
 304
 305 /**
 306  * GST_WRITE_UINT64_BE:
 307  * @data: memory location
 308  * @num: value to store
 309  *
 310  * Store a 64 bit unsigned integer value in big endian format into the memory buffer.
 311  */
 312 #define GST_WRITE_UINT64_BE(data, num)  _GST_PUT(data, 64, BE, num)
 313 /**
 314  * GST_WRITE_UINT64_LE:
 315  * @data: memory location
 316  * @num: value to store
 317  *
 318  * Store a 64 bit unsigned integer value in little endian format into the memory buffer.
 319  */
 320 #define GST_WRITE_UINT64_LE(data, num)  _GST_PUT(data, 64, LE, num)
 321 /**
 322  * GST_WRITE_UINT32_BE:
 323  * @data: memory location
 324  * @num: value to store
 325  *
 326  * Store a 32 bit unsigned integer value in big endian format into the memory buffer.
 327  */
 328 #define GST_WRITE_UINT32_BE(data, num)  _GST_PUT(data, 32, BE, num)
 329 /**
 330  * GST_WRITE_UINT32_LE:
 331  * @data: memory location
 332  * @num: value to store
 333  *
 334  * Store a 32 bit unsigned integer value in little endian format into the memory buffer.
 335  */
 336 #define GST_WRITE_UINT32_LE(data, num)  _GST_PUT(data, 32, LE, num)
 337 /**
 338  * GST_WRITE_UINT16_BE:
 339  * @data: memory location
 340  * @num: value to store
 341  *
 342  * Store a 16 bit unsigned integer value in big endian format into the memory buffer.
 343  */
 344 #define GST_WRITE_UINT16_BE(data, num)  _GST_PUT(data, 16, BE, num)
 345 /**
 346  * GST_WRITE_UINT16_LE:
 347  * @data: memory location
 348  * @num: value to store
 349  *
 350  * Store a 16 bit unsigned integer value in little endian format into the memory buffer.
 351  */
 352 #define GST_WRITE_UINT16_LE(data, num)  _GST_PUT(data, 16, LE, num)
 353 /**
 354  * GST_WRITE_UINT8:
 355  * @data: memory location
 356  * @num: value to store
 357  *
 358  * Store an 8 bit unsigned integer value into the memory buffer.
 359  */
 360 #define GST_WRITE_UINT8(data, num)      ((* (guint8 *) (data)) = (num))
 361
 362 #else /* GST_HAVE_UNALIGNED_ACCESS */
 363
 364 #define _GST_GET(__data, __idx, __size, __shift) \
 365     (((guint##__size) (((guint8 *) (__data))[__idx])) << __shift)
 366
 367 #define GST_READ_UINT64_BE(data)        (_GST_GET (data, 0, 64, 56) | \
 368                                          _GST_GET (data, 1, 64, 48) | \
 369                                          _GST_GET (data, 2, 64, 40) | \
 370                                          _GST_GET (data, 3, 64, 32) | \
 371                                          _GST_GET (data, 4, 64, 24) | \
 372                                          _GST_GET (data, 5, 64, 16) | \
 373                                          _GST_GET (data, 6, 64,  8) | \
 374                                          _GST_GET (data, 7, 64,  0))
 375
 376 #define GST_READ_UINT64_LE(data)        (_GST_GET (data, 7, 64, 56) | \
 377                                          _GST_GET (data, 6, 64, 48) | \
 378                                          _GST_GET (data, 5, 64, 40) | \
 379                                          _GST_GET (data, 4, 64, 32) | \
 380                                          _GST_GET (data, 3, 64, 24) | \
 381                                          _GST_GET (data, 2, 64, 16) | \
 382                                          _GST_GET (data, 1, 64,  8) | \
 383                                          _GST_GET (data, 0, 64,  0))
 384
 385 #define GST_READ_UINT32_BE(data)        (_GST_GET (data, 0, 32, 24) | \
 386                                          _GST_GET (data, 1, 32, 16) | \
 387                                          _GST_GET (data, 2, 32,  8) | \
 388                                          _GST_GET (data, 3, 32,  0))
 389
 390 #define GST_READ_UINT32_LE(data)        (_GST_GET (data, 3, 32, 24) | \
 391                                          _GST_GET (data, 2, 32, 16) | \
 392                                          _GST_GET (data, 1, 32,  8) | \
 393                                          _GST_GET (data, 0, 32,  0))
 394
 395 #define GST_READ_UINT16_BE(data)        (_GST_GET (data, 0, 16,  8) | \
 396                                          _GST_GET (data, 1, 16,  0))
 397
 398 #define GST_READ_UINT16_LE(data)        (_GST_GET (data, 1, 16,  8) | \
 399                                          _GST_GET (data, 0, 16,  0))
 400
 401 #define GST_READ_UINT8(data)            (_GST_GET (data, 0,  8,  0))
 402
 403 #define _GST_PUT(__data, __idx, __size, __shift, __num) \
 404     (((guint8 *) (__data))[__idx] = (((guint##__size) __num) >> __shift) & 0xff)
 405
 406 #define GST_WRITE_UINT64_BE(data, num)  do { \
 407                                           _GST_PUT (data, 0, 64, 56, num); \
 408                                           _GST_PUT (data, 1, 64, 48, num); \
 409                                           _GST_PUT (data, 2, 64, 40, num); \
 410                                           _GST_PUT (data, 3, 64, 32, num); \
 411                                           _GST_PUT (data, 4, 64, 24, num); \
 412                                           _GST_PUT (data, 5, 64, 16, num); \
 413                                           _GST_PUT (data, 6, 64,  8, num); \
 414                                           _GST_PUT (data, 7, 64,  0, num); \
 415                                         } while (0)
 416
 417 #define GST_WRITE_UINT64_LE(data, num)  do { \
 418                                           _GST_PUT (data, 0, 64,  0, num); \
 419                                           _GST_PUT (data, 1, 64,  8, num); \
 420                                           _GST_PUT (data, 2, 64, 16, num); \
 421                                           _GST_PUT (data, 3, 64, 24, num); \
 422                                           _GST_PUT (data, 4, 64, 32, num); \
 423                                           _GST_PUT (data, 5, 64, 40, num); \
 424                                           _GST_PUT (data, 6, 64, 48, num); \
 425                                           _GST_PUT (data, 7, 64, 56, num); \
 426                                         } while (0)
 427
 428 #define GST_WRITE_UINT32_BE(data, num)  do { \
 429                                           _GST_PUT (data, 0, 32, 24, num); \
 430                                           _GST_PUT (data, 1, 32, 16, num); \
 431                                           _GST_PUT (data, 2, 32,  8, num); \
 432                                           _GST_PUT (data, 3, 32,  0, num); \
 433                                         } while (0)
 434
 435 #define GST_WRITE_UINT32_LE(data, num)  do { \
 436                                           _GST_PUT (data, 0, 32,  0, num); \
 437                                           _GST_PUT (data, 1, 32,  8, num); \
 438                                           _GST_PUT (data, 2, 32, 16, num); \
 439                                           _GST_PUT (data, 3, 32, 24, num); \
 440                                         } while (0)
 441
 442 #define GST_WRITE_UINT16_BE(data, num)  do { \
 443                                           _GST_PUT (data, 0, 16,  8, num); \
 444                                           _GST_PUT (data, 1, 16,  0, num); \
 445                                         } while (0)
 446
 447 #define GST_WRITE_UINT16_LE(data, num)  do { \
 448                                           _GST_PUT (data, 0, 16,  0, num); \
 449                                           _GST_PUT (data, 1, 16,  8, num); \
 450                                         } while (0)
 451
 452 #define GST_WRITE_UINT8(data, num)      do { \
 453                                           _GST_PUT (data, 0,  8,  0, num); \
 454                                         } while (0)
 455
 456 #endif /* GST_HAVE_UNALIGNED_ACCESS */
 457
 458
 459 /* Miscellaneous utility macros */
 460
 461 /**
 462  * GST_ROUND_UP_2:
 463  * @num: integer value to round up
 464  *
 465  * Make number divideable by two without a rest.
 466  */
 467 #define GST_ROUND_UP_2(num)  (((num)+1)&~1)
 468 /**
 469  * GST_ROUND_UP_4:
 470  * @num: integer value to round up
 471  *
 472  * Make number divideable by four without a rest.
 473  */
 474 #define GST_ROUND_UP_4(num)  (((num)+3)&~3)
 475 /**
 476  * GST_ROUND_UP_8:
 477  * @num: integer value to round up
 478  *
 479  * Make number divideable by eight without a rest.
 480  */
 481 #define GST_ROUND_UP_8(num)  (((num)+7)&~7)
 482 /**
 483  * GST_ROUND_UP_16:
 484  * @num: integer value to round up
 485  *
 486  * Make number divideable by 16 without a rest.
 487  */
 488 #define GST_ROUND_UP_16(num) (((num)+15)&~15)
 489 /**
 490  * GST_ROUND_UP_32:
 491  * @num: integer value to round up
 492  *
 493  * Make number divideable by 32 without a rest.
 494  */
 495 #define GST_ROUND_UP_32(num) (((num)+31)&~31)
 496 /**
 497  * GST_ROUND_UP_64:
 498  * @num: integer value to round up
 499  *
 500  * Make number divideable by 64 without a rest.
 501  */
 502 #define GST_ROUND_UP_64(num) (((num)+63)&~63)
 503
 504 /**
 505  * GST_ROUND_DOWN_2:
 506  * @num: integer value to round down
 507  *
 508  * Make number divisible by two without a rest by rounding it down
 509  *
 510  * Since: 0.10.12
 511  */
 512 #define GST_ROUND_DOWN_2(num)  ((num)&(~1))
 513 /**
 514  * GST_ROUND_DOWN_4:
 515  * @num: integer value to round down
 516  *
 517  * Make number divisible by four without a rest by rounding it down
 518  *
 519  * Since: 0.10.12
 520  */
 521 #define GST_ROUND_DOWN_4(num)  ((num)&(~3))
 522 /**
 523  * GST_ROUND_DOWN_8:
 524  * @num: integer value to round down
 525  *
 526  * Make number divisible by eight without a rest by rounding it down
 527  *
 528  * Since: 0.10.12
 529  */
 530 #define GST_ROUND_DOWN_8(num)  ((num)&(~7))
 531 /**
 532  * GST_ROUND_DOWN_16:
 533  * @num: integer value to round down
 534  *
 535  * Make number divisible by 16 without a rest by rounding it down
 536  *
 537  * Since: 0.10.12
 538  */
 539 #define GST_ROUND_DOWN_16(num) ((num)&(~15))
 540 /**
 541  * GST_ROUND_DOWN_32:
 542  * @num: integer value to round down
 543  *
 544  * Make number divisible by 32 without a rest by rounding it down
 545  *
 546  * Since: 0.10.12
 547  */
 548 #define GST_ROUND_DOWN_32(num) ((num)&(~31))
 549 /**
 550  * GST_ROUND_DOWN_64:
 551  * @num: integer value to round down
 552  *
 553  * Make number divisible by 64 without a rest by rounding it down
 554  *
 555  * Since: 0.10.12
 556  */
 557 #define GST_ROUND_DOWN_64(num) ((num)&(~63))
 558
 559 void                    gst_object_default_error        (GstObject * source,
 560                                                          GError * error, gchar * debug);
 561
 562 /* element functions */
 563 void                    gst_element_create_all_pads     (GstElement *element);
 564 GstPad*                 gst_element_get_compatible_pad  (GstElement *element, GstPad *pad,
 565                                                          const GstCaps *caps);
 566
 567 GstPadTemplate*         gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
 568
 569 G_CONST_RETURN gchar*   gst_element_state_get_name      (GstState state);
 570 G_CONST_RETURN gchar *  gst_element_state_change_return_get_name (GstStateChangeReturn state_ret);
 571
 572 gboolean                gst_element_link                (GstElement *src, GstElement *dest);
 573 gboolean                gst_element_link_many           (GstElement *element_1,
 574                                                          GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
 575 gboolean                gst_element_link_filtered       (GstElement * src,
 576                                                          GstElement * dest,
 577                                                          GstCaps *filter);
 578 void                    gst_element_unlink              (GstElement *src, GstElement *dest);
 579 void                    gst_element_unlink_many         (GstElement *element_1,
 580                                                          GstElement *element_2, ...) G_GNUC_NULL_TERMINATED;
 581
 582 gboolean                gst_element_link_pads           (GstElement *src, const gchar *srcpadname,
 583                                                          GstElement *dest, const gchar *destpadname);
 584 void                    gst_element_unlink_pads         (GstElement *src, const gchar *srcpadname,
 585                                                          GstElement *dest, const gchar *destpadname);
 586
 587 gboolean                gst_element_link_pads_filtered  (GstElement * src, const gchar * srcpadname,
 588                                                          GstElement * dest, const gchar * destpadname,
 589                                                          GstCaps *filter);
 590
 591 gboolean        gst_element_seek_simple (GstElement   *element,
 592                                          GstFormat     format,
 593                                          GstSeekFlags  seek_flags,
 594                                          gint64        seek_pos);
 595
 596 /* util elementfactory functions */
 597 gboolean                gst_element_factory_can_src_caps(GstElementFactory *factory, const GstCaps *caps);
 598 gboolean                gst_element_factory_can_sink_caps(GstElementFactory *factory, const GstCaps *caps);
 599
 600 /* util query functions */
 601 gboolean                gst_element_query_position      (GstElement *element, GstFormat *format,
 602                                                          gint64 *cur);
 603 gboolean                gst_element_query_duration      (GstElement *element, GstFormat *format,
 604                                                          gint64 *duration);
 605 gboolean                gst_element_query_convert       (GstElement *element, GstFormat src_format, gint64 src_val,
 606                                                          GstFormat *dest_format, gint64 *dest_val);
 607
 608 /* element class functions */
 609 void                    gst_element_class_install_std_props (GstElementClass * klass,
 610                                                          const gchar * first_name, ...) G_GNUC_NULL_TERMINATED;
 611
 612 /* pad functions */
 613 gboolean                gst_pad_can_link                (GstPad *srcpad, GstPad *sinkpad);
 614
 615 void                    gst_pad_use_fixed_caps          (GstPad *pad);
 616 GstCaps*                gst_pad_get_fixed_caps_func     (GstPad *pad);
 617 GstCaps*                gst_pad_proxy_getcaps           (GstPad * pad);
 618 gboolean                gst_pad_proxy_setcaps           (GstPad * pad, GstCaps * caps);
 619
 620 GstElement*             gst_pad_get_parent_element      (GstPad *pad);
 621
 622 /* util query functions */
 623 gboolean                gst_pad_query_position          (GstPad *pad, GstFormat *format,
 624                                                          gint64 *cur);
 625 gboolean                gst_pad_query_duration          (GstPad *pad, GstFormat *format,
 626                                                          gint64 *duration);
 627 gboolean                gst_pad_query_convert           (GstPad *pad, GstFormat src_format, gint64 src_val,
 628                                                          GstFormat *dest_format, gint64 *dest_val);
 629
 630 gboolean                gst_pad_query_peer_position     (GstPad *pad, GstFormat *format,
 631                                                          gint64 *cur);
 632 gboolean                gst_pad_query_peer_duration     (GstPad *pad, GstFormat *format,
 633                                                          gint64 *duration);
 634 gboolean                gst_pad_query_peer_convert      (GstPad *pad, GstFormat src_format, gint64 src_val,
 635                                                          GstFormat *dest_format, gint64 *dest_val);
 636
 637 /* bin functions */
 638 void                    gst_bin_add_many                (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
 639 void                    gst_bin_remove_many             (GstBin *bin, GstElement *element_1, ...) G_GNUC_NULL_TERMINATED;
 640 GstPad *                gst_bin_find_unconnected_pad    (GstBin *bin, GstPadDirection direction);
 641
 642 /* buffer functions */
 643 GstBuffer *             gst_buffer_merge                (GstBuffer * buf1, GstBuffer * buf2);
 644 GstBuffer *             gst_buffer_join                 (GstBuffer * buf1, GstBuffer * buf2);
 645 void                    gst_buffer_stamp                (GstBuffer * dest, const GstBuffer * src);
 646
 647 /* atomic functions */
 648 void                    gst_atomic_int_set              (gint * atomic_int, gint value);
 649
 650 /* probes */
 651 gulong                  gst_pad_add_data_probe          (GstPad * pad,
 652                                                          GCallback handler,
 653                                                          gpointer data);
 654 void                    gst_pad_remove_data_probe       (GstPad * pad, guint handler_id);
 655 gulong                  gst_pad_add_event_probe         (GstPad * pad,
 656                                                          GCallback handler,
 657                                                          gpointer data);
 658 void                    gst_pad_remove_event_probe      (GstPad * pad, guint handler_id);
 659 gulong                  gst_pad_add_buffer_probe        (GstPad * pad,
 660                                                          GCallback handler,
 661                                                          gpointer data);
 662 void                    gst_pad_remove_buffer_probe     (GstPad * pad, guint handler_id);
 663
 664 /* tag emission utility functions */
 665 void                    gst_element_found_tags_for_pad  (GstElement * element,
 666                                                          GstPad * pad,
 667                                                          GstTagList * list);
 668 void                    gst_element_found_tags          (GstElement * element,
 669                                                          GstTagList * list);
 670
 671 /* parse utility functions */
 672 GstElement *            gst_parse_bin_from_description  (const gchar * bin_description,
 673                                                          gboolean ghost_unconnected_pads,
 674                                                          GError ** err);
 675
 676 G_END_DECLS
 677
 678 #endif /* __GST_UTILS_H__ */