|  |  |  | GStreamer 0.10 Core Reference Manual |  | 
|---|---|---|---|---|
#include <gst/gst.h> #define GST_BOILERPLATE_WITH_INTERFACE (type, type_as_function, parent_type, parent_type_as_macro, interface_type, interface_type_as_macro, interface_as_function) #define GST_BOILERPLATE_FULL (type, type_as_function, parent_type, parent_type_macro, additional_initializations) #define GST_BOILERPLATE (type,type_as_function,parent_type,parent_type_macro) #define GST_CALL_PARENT (parent_class_cast, name, args) #define GST_CALL_PARENT_WITH_DEFAULT (parent_class_cast, name, args, def_return) #define GST_READ_UINT8 (data) #define GST_READ_UINT16_LE (data) #define GST_READ_UINT16_BE (data) #define GST_READ_UINT32_LE (data) #define GST_READ_UINT32_BE (data) #define GST_READ_UINT64_LE (data) #define GST_READ_UINT64_BE (data) #define GST_WRITE_UINT8 (data, num) #define GST_WRITE_UINT16_LE (data, num) #define GST_WRITE_UINT16_BE (data, num) #define GST_WRITE_UINT32_LE (data, num) #define GST_WRITE_UINT32_BE (data, num) #define GST_WRITE_UINT64_LE (data, num) #define GST_WRITE_UINT64_BE (data, num) #define GST_ROUND_UP_2 (num) #define GST_ROUND_UP_4 (num) #define GST_ROUND_UP_8 (num) #define GST_ROUND_UP_16 (num) #define GST_ROUND_UP_32 (num) #define GST_ROUND_UP_64 (num) #define GST_ROUND_DOWN_2 (num) #define GST_ROUND_DOWN_4 (num) #define GST_ROUND_DOWN_8 (num) #define GST_ROUND_DOWN_16 (num) #define GST_ROUND_DOWN_32 (num) #define GST_ROUND_DOWN_64 (num) void gst_atomic_int_set (gint *atomic_int, gint value); const gchar* gst_flow_get_name (GstFlowReturn ret); GQuark gst_flow_to_quark (GstFlowReturn ret); void gst_print_element_args (GString *buf, gint indent, GstElement *element); void gst_print_pad_caps (GString *buf, gint indent, GstPad *pad); #define gst_guint64_to_gdouble (value) #define gst_gdouble_to_guint64 (value) GType gst_type_register_static_full (GType parent_type, const gchar *type_name, guint class_size, GBaseInitFunc base_init, GBaseFinalizeFunc base_finalize, GClassInitFunc class_init, GClassFinalizeFunc class_finalize, gconstpointer class_data, guint instance_size, guint16 n_preallocs, GInstanceInitFunc instance_init, const GTypeValueTable *value_table, GTypeFlags flags); void gst_util_dump_mem (const guchar *mem, guint size); guint64 gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom); guint64 gst_util_uint64_scale_int (guint64 val, gint num, gint denom); void gst_util_set_object_arg (GObject *object, const gchar *name, const gchar *value); void gst_util_set_value_from_string (GValue *value, const gchar *value_str); GstClockTime gst_util_get_timestamp (void);
#define             GST_BOILERPLATE_WITH_INTERFACE(type, type_as_function,		\
                parent_type, parent_type_as_macro, interface_type,			\
                interface_type_as_macro, interface_as_function)
Like GST_BOILERPLATE, but makes the type 1) implement an interface, and 2) implement GstImplementsInterface for that type.
After this you will need to implement interface_as_function ## _supported and interface_as_function ## _interface_init
| 
 | the name of the type struct | 
| 
 | the prefix for the functions | 
| 
 | the parent type struct name | 
| 
 | the parent type macro | 
| 
 | the name of the interface type struct | 
| 
 | the interface type macro | 
| 
 | the interface function name prefix | 
#define GST_BOILERPLATE_FULL(type, type_as_function, parent_type, parent_type_macro, additional_initializations)
Define the boilerplate type stuff to reduce typos and code size. Defines the get_type method and the parent_class static variable.
GST_BOILERPLATE_FULL (GstFdSink, gst_fdsink, GstElement, GST_TYPE_ELEMENT, _do_init);
| 
 | the name of the type struct | 
| 
 | the prefix for the functions | 
| 
 | the parent type struct name | 
| 
 | the parent type macro | 
| 
 | function pointer in the form of void additional_initializations (GType type) that can be used for initializing interfaces and the like | 
#define GST_BOILERPLATE(type,type_as_function,parent_type,parent_type_macro)
Define the boilerplate type stuff to reduce typos and code size. Defines the get_type method and the parent_class static variable.
GST_BOILERPLATE (GstFdSink, gst_fdsink, GstElement, GST_TYPE_ELEMENT);
| 
 | the name of the type struct | 
| 
 | the prefix for the functions | 
| 
 | the parent type struct name | 
| 
 | the parent type macro | 
#define GST_CALL_PARENT(parent_class_cast, name, args)
Just call the parent handler. This assumes that there is a variable named parent_class that points to the (duh!) parent class. Note that this macro is not to be used with things that return something, use the _WITH_DEFAULT version for that
| 
 | the name of the class cast macro for the parent type | 
| 
 | name of the function to call | 
| 
 | arguments enclosed in '( )' | 
#define GST_CALL_PARENT_WITH_DEFAULT(parent_class_cast, name, args, def_return)
Same as GST_CALL_PARENT(), but in case there is no implementation, it
evaluates to def_return.
| 
 | the name of the class cast macro for the parent type | 
| 
 | name of the function to call | 
| 
 | arguments enclosed in '( )' | 
| 
 | default result | 
#define GST_READ_UINT8(data)
Read an 8 bit unsigned integer value from the memory buffer.
| 
 | memory location | 
#define GST_READ_UINT16_LE(data)
Read a 16 bit unsigned integer value in little endian format from the memory buffer.
| 
 | memory location | 
#define GST_READ_UINT16_BE(data)
Read a 16 bit unsigned integer value in big endian format from the memory buffer.
| 
 | memory location | 
#define GST_READ_UINT32_LE(data)
Read a 32 bit unsigned integer value in little endian format from the memory buffer.
| 
 | memory location | 
#define GST_READ_UINT32_BE(data)
Read a 32 bit unsigned integer value in big endian format from the memory buffer.
| 
 | memory location | 
#define GST_READ_UINT64_LE(data)
Read a 64 bit unsigned integer value in little endian format from the memory buffer.
| 
 | memory location | 
#define GST_READ_UINT64_BE(data)
Read a 64 bit unsigned integer value in big endian format from the memory buffer.
| 
 | memory location | 
#define GST_WRITE_UINT8(data, num)
Store an 8 bit unsigned integer value into the memory buffer.
| 
 | memory location | 
| 
 | value to store | 
#define GST_WRITE_UINT16_LE(data, num)
Store a 16 bit unsigned integer value in little endian format into the memory buffer.
| 
 | memory location | 
| 
 | value to store | 
#define GST_WRITE_UINT16_BE(data, num)
Store a 16 bit unsigned integer value in big endian format into the memory buffer.
| 
 | memory location | 
| 
 | value to store | 
#define GST_WRITE_UINT32_LE(data, num)
Store a 32 bit unsigned integer value in little endian format into the memory buffer.
| 
 | memory location | 
| 
 | value to store | 
#define GST_WRITE_UINT32_BE(data, num)
Store a 32 bit unsigned integer value in big endian format into the memory buffer.
| 
 | memory location | 
| 
 | value to store | 
#define GST_WRITE_UINT64_LE(data, num)
Store a 64 bit unsigned integer value in little endian format into the memory buffer.
| 
 | memory location | 
| 
 | value to store | 
#define GST_WRITE_UINT64_BE(data, num)
Store a 64 bit unsigned integer value in big endian format into the memory buffer.
| 
 | memory location | 
| 
 | value to store | 
#define GST_ROUND_UP_2(num) (((num)+1)&~1)
Rounds an integer value up to the next multiple of 2.
| 
 | integer value to round up | 
#define GST_ROUND_UP_4(num) (((num)+3)&~3)
Rounds an integer value up to the next multiple of 4.
| 
 | integer value to round up | 
#define GST_ROUND_UP_8(num) (((num)+7)&~7)
Rounds an integer value up to the next multiple of 8.
| 
 | integer value to round up | 
#define GST_ROUND_UP_16(num) (((num)+15)&~15)
Rounds an integer value up to the next multiple of 16.
| 
 | integer value to round up | 
#define GST_ROUND_UP_32(num) (((num)+31)&~31)
Rounds an integer value up to the next multiple of 32.
| 
 | integer value to round up | 
#define GST_ROUND_UP_64(num) (((num)+63)&~63)
Rounds an integer value up to the next multiple of 64.
| 
 | integer value to round up | 
#define GST_ROUND_DOWN_2(num) ((num)&(~1))
Rounds an integer value down to the next multiple of 2.
| 
 | integer value to round down | 
Since 0.10.12
#define GST_ROUND_DOWN_4(num) ((num)&(~3))
Rounds an integer value down to the next multiple of 4.
| 
 | integer value to round down | 
Since 0.10.12
#define GST_ROUND_DOWN_8(num) ((num)&(~7))
Rounds an integer value down to the next multiple of 8.
| 
 | integer value to round down | 
Since 0.10.12
#define GST_ROUND_DOWN_16(num) ((num)&(~15))
Rounds an integer value down to the next multiple of 16.
| 
 | integer value to round down | 
Since 0.10.12
#define GST_ROUND_DOWN_32(num) ((num)&(~31))
Rounds an integer value down to the next multiple of 32.
| 
 | integer value to round down | 
Since 0.10.12
#define GST_ROUND_DOWN_64(num) ((num)&(~63))
Rounds an integer value down to the next multiple of 64.
| 
 | integer value to round down | 
Since 0.10.12
void                gst_atomic_int_set                  (gint *atomic_int,
                                                         gint value);
gst_atomic_int_set is deprecated and should not be used in newly-written code. Use g_atomic_int_set().
Unconditionally sets the atomic integer to value.
| 
 | pointer to an atomic integer | 
| 
 | value to set | 
const gchar* gst_flow_get_name (GstFlowReturn ret);
Gets a string representing the given flow return.
| 
 | a GstFlowReturn to get the name of. | 
| Returns : | a static string with the name of the flow return. | 
GQuark gst_flow_to_quark (GstFlowReturn ret);
Get the unique quark for the given GstFlowReturn.
| 
 | a GstFlowReturn to get the quark of. | 
| Returns : | the quark associated with the flow return or 0 if an invalid return was specified. | 
void                gst_print_element_args              (GString *buf,
                                                         gint indent,
                                                         GstElement *element);
Print the element argument in a human readable format in the given GString.
| 
 | the buffer to print the args in | 
| 
 | initial indentation | 
| 
 | the element to print the args of | 
void                gst_print_pad_caps                  (GString *buf,
                                                         gint indent,
                                                         GstPad *pad);
Write the pad capabilities in a human readable format into the given GString.
| 
 | the buffer to print the caps in | 
| 
 | initial indentation | 
| 
 | the pad to print the caps from | 
#define gst_guint64_to_gdouble(value)
Convert value to a gdouble.
| 
 | the guint64 value to convert | 
#define gst_gdouble_to_guint64(value)
Convert value to a guint64.
| 
 | the gdouble value to convert | 
GType               gst_type_register_static_full       (GType parent_type,
                                                         const gchar *type_name,
                                                         guint class_size,
                                                         GBaseInitFunc base_init,
                                                         GBaseFinalizeFunc base_finalize,
                                                         GClassInitFunc class_init,
                                                         GClassFinalizeFunc class_finalize,
                                                         gconstpointer class_data,
                                                         guint instance_size,
                                                         guint16 n_preallocs,
                                                         GInstanceInitFunc instance_init,
                                                         const GTypeValueTable *value_table,
                                                         GTypeFlags flags);
Helper function which constructs a GTypeInfo structure and registers a GType, but which generates less linker overhead than a static const GTypeInfo structure. For further details of the parameters, please see GTypeInfo in the GLib documentation.
Registers type_name as the name of a new static type derived from 
parent_type. The value of flags determines the nature (e.g. abstract or 
not) of the type. It works by filling a GTypeInfo struct and calling 
g_type_info_register_static().
| 
 | The GType of the parent type the newly registered type will derive from | 
| 
 | NULL-terminated string used as the name of the new type | 
| 
 | Size of the class structure. | 
| 
 | Location of the base initialization function (optional). | 
| 
 | Location of the base finalization function (optional). | 
| 
 | Location of the class initialization function for class types Location of the default vtable inititalization function for interface types. (optional) | 
| 
 | Location of the class finalization function for class types. Location of the default vtable finalization function for interface types. (optional) | 
| 
 | User-supplied data passed to the class init/finalize functions. | 
| 
 | Size of the instance (object) structure (required for instantiatable types only). | 
| 
 | The number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Ignored on recent GLib's. | 
| 
 | Location of the instance initialization function (optional, for instantiatable types only). | 
| 
 | A GTypeValueTable function table for generic handling of GValues of this type (usually only useful for fundamental types). | 
| 
 | GTypeFlags for this GType. E.g: G_TYPE_FLAG_ABSTRACT | 
| Returns : | A GType for the newly-registered type. | 
Since 0.10.14
void                gst_util_dump_mem                   (const guchar *mem,
                                                         guint size);
Dumps the memory block into a hex representation. Useful for debugging.
| 
 | a pointer to the memory to dump | 
| 
 | the size of the memory block to dump | 
guint64             gst_util_uint64_scale               (guint64 val,
                                                         guint64 num,
                                                         guint64 denom);
Scale val by num / denom, trying to avoid overflows.
This function can potentially be very slow if denom > G_MAXUINT32.
| 
 | the number to scale | 
| 
 | the numerator of the scale ratio | 
| 
 | the denominator of the scale ratio | 
| Returns : | val*num/denom, trying to avoid overflows.
In the case of an overflow, this function returns G_MAXUINT64. | 
guint64             gst_util_uint64_scale_int           (guint64 val,
                                                         gint num,
                                                         gint denom);
Scale a guint64 by a factor expressed as a fraction (num/denom), avoiding overflows and loss of precision.
num and denom must be positive integers. denom cannot be 0.
| 
 | guint64 (such as a GstClockTime) to scale. | 
| 
 | numerator of the scale factor. | 
| 
 | denominator of the scale factor. | 
| Returns : | val*num/denom, avoiding overflow and loss of precision.
In the case of an overflow, this function returns G_MAXUINT64. | 
void                gst_util_set_object_arg             (GObject *object,
                                                         const gchar *name,
                                                         const gchar *value);
Convertes the string value to the type of the objects argument and sets the argument with it.
| 
 | the object to set the argument of | 
| 
 | the name of the argument to set | 
| 
 | the string value to set | 
void                gst_util_set_value_from_string      (GValue *value,
                                                         const gchar *value_str);
Converts the string to the type of the value and sets the value with it.
| 
 | the value to set | 
| 
 | the string to get the value from | 
GstClockTime gst_util_get_timestamp (void);
Get a timestamp as GstClockTime to be used for interval meassurements. The timestamp should not be interpreted in any other way.
| Returns : | the timestamp | 
Since 0.10.16