gstreamer/gst/gstutils.h
Wim Taymans 7612a38449 gst/: API change fix.
Original commit message from CVS:
* gst/base/gstbasesink.c: (gst_base_sink_commit_state),
(gst_base_sink_handle_object), (gst_base_sink_query), (do_playing):
* gst/base/gstbasesrc.c: (gst_base_src_query):
* gst/elements/gstfilesink.c: (gst_file_sink_query):
* gst/elements/gsttypefindelement.c:
(gst_type_find_handle_src_query), (find_element_get_length),
(gst_type_find_element_activate):
API change fix.

* gst/gstquery.c: (gst_query_new_position),
(gst_query_set_position), (gst_query_parse_position),
(gst_query_new_duration), (gst_query_set_duration),
(gst_query_parse_duration), (gst_query_set_segment),
(gst_query_parse_segment):
* gst/gstquery.h:
Bundling query position/duration is not a good idea since duration
does not change much and we don't want to recalculate it for every
position query, so they are separated again..
Base value in segment query is not needed.

* gst/gstqueue.c: (gst_queue_handle_src_query):
* gst/gstutils.c: (gst_element_query_position),
(gst_element_query_duration), (gst_pad_query_position),
(gst_pad_query_duration):
* gst/gstutils.h:
Updates for query API change.
Added some docs here and there.
2005-10-19 15:50:10 +00:00

578 lines
22 KiB
C

/* GStreamer
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2000 Wim Taymans <wtay@chello.be>
*
* gstutils.h: Header for various utility functions
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __GST_UTILS_H__
#define __GST_UTILS_H__
#include <glib.h>
#include <gst/gstbin.h>
G_BEGIN_DECLS
void gst_util_set_value_from_string (GValue *value, const gchar *value_str);
void gst_util_set_object_arg (GObject *object, const gchar *name, const gchar *value);
void gst_util_dump_mem (const guchar *mem, guint size);
#ifdef WIN32
guint64 gst_gdouble_to_guint64 (gdouble value);
gdouble gst_guint64_to_gdouble (guint64 value);
#else
#define gst_gdouble_to_guint64(value) ((guint64) (value))
#define gst_guint64_to_gdouble(value) ((gdouble) (value))
#endif
guint64 gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom);
void gst_print_pad_caps (GString *buf, gint indent, GstPad *pad);
void gst_print_element_args (GString *buf, gint indent, GstElement *element);
/* Macros for defining classes. Ideas taken from Bonobo, which took theirs
from Nautilus and GOB. */
/**
* GST_BOILERPLATE_FULL:
* @type: the name of the type struct
* @type_as_function: the prefix for the functions
* @parent_type: the parent type struct name
* @parent_type_macro: the parent type macro
* @additional_initializations: function pointer in the form of
* void additional_initializations (GType type) that can be used for
* initializing interfaces and the like
*
* Define the boilerplate type stuff to reduce typos and code size. Defines
* the get_type method and the parent_class static variable.
*
* <informalexample>
* <programlisting>
* GST_BOILERPLATE_FULL (GstFdSink, gst_fdsink, GstElement, GST_TYPE_ELEMENT, _do_init);
* </programlisting>
* </informalexample>
*/
#define GST_BOILERPLATE_FULL(type, type_as_function, parent_type, parent_type_macro, additional_initializations) \
\
static void type_as_function ## _base_init (gpointer g_class); \
static void type_as_function ## _class_init (type ## Class *g_class);\
static void type_as_function ## _init (type *object, \
type ## Class *g_class);\
static parent_type ## Class *parent_class = NULL; \
static void \
type_as_function ## _class_init_trampoline (gpointer g_class, \
gpointer data) \
{ \
parent_class = (parent_type ## Class *) \
g_type_class_peek_parent (g_class); \
type_as_function ## _class_init ((type ## Class *)g_class); \
} \
\
GType \
type_as_function ## _get_type (void) \
{ \
static GType object_type = 0; \
if (object_type == 0) { \
static const GTypeInfo object_info = { \
sizeof (type ## Class), \
type_as_function ## _base_init, \
NULL, /* base_finalize */ \
type_as_function ## _class_init_trampoline, \
NULL, /* class_finalize */ \
NULL, /* class_data */ \
sizeof (type), \
0, /* n_preallocs */ \
(GInstanceInitFunc) type_as_function ## _init \
}; \
object_type = g_type_register_static (parent_type_macro, #type, \
&object_info, (GTypeFlags) 0); \
additional_initializations (object_type); \
} \
return object_type; \
}
#define __GST_DO_NOTHING(type) /* NOP */
/**
* GST_BOILERPLATE:
* @type: the name of the type struct
* @type_as_function: the prefix for the functions
* @parent_type: the parent type struct name
* @parent_type_macro: the 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.
*
* <informalexample>
* <programlisting>
* GST_BOILERPLATE (GstFdSink, gst_fdsink, GstElement, GST_TYPE_ELEMENT);
* </programlisting>
* </informalexample>
*/
#define GST_BOILERPLATE(type,type_as_function,parent_type,parent_type_macro) \
GST_BOILERPLATE_FULL (type, type_as_function, parent_type, parent_type_macro, \
__GST_DO_NOTHING)
/* 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
*/
/**
* GST_BOILERPLATE_WITH_INTERFACE:
* @type: the name of the type struct
* @type_as_function: the prefix for the functions
* @parent_type: the parent type struct name
* @parent_type_as_macro: the parent type macro
* @interface_type: the name of the interface type struct
* @interface_type_as_macro: the interface type macro
* @interface_as_function: the interface function name prefix
*
* 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
*/
#define GST_BOILERPLATE_WITH_INTERFACE(type, type_as_function, \
parent_type, parent_type_as_macro, interface_type, \
interface_type_as_macro, interface_as_function) \
\
static void interface_as_function ## _interface_init (interface_type ## Class *klass); \
static gboolean interface_as_function ## _supported (type *object, GType iface_type); \
\
static void \
type_as_function ## _implements_interface_init (GstImplementsInterfaceClass *klass) \
{ \
klass->supported = (gpointer)interface_as_function ## _supported; \
} \
\
static void \
type_as_function ## _init_interfaces (GType type) \
{ \
static const GInterfaceInfo implements_iface_info = { \
(GInterfaceInitFunc) type_as_function ## _implements_interface_init,\
NULL, \
NULL, \
}; \
static const GInterfaceInfo iface_info = { \
(GInterfaceInitFunc) interface_as_function ## _interface_init, \
NULL, \
NULL, \
}; \
\
g_type_add_interface_static (type, GST_TYPE_IMPLEMENTS_INTERFACE, \
&implements_iface_info); \
g_type_add_interface_static (type, interface_type_as_macro, \
&iface_info); \
} \
\
GST_BOILERPLATE_FULL (type, type_as_function, parent_type, \
parent_type_as_macro, type_as_function ## _init_interfaces)
/* 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 */
#define GST_CALL_PARENT(parent_class_cast, name, args) \
((parent_class_cast(parent_class)->name != NULL) ? \
parent_class_cast(parent_class)->name args : (void) 0)
/* Same as above, but in case there is no implementation, it evaluates
* to def_return */
#define GST_CALL_PARENT_WITH_DEFAULT(parent_class_cast, name, args, \
def_return) \
((parent_class_cast(parent_class)->name != NULL) ? \
parent_class_cast(parent_class)->name args : def_return)
/* Define possibly unaligned memory access method whether the type of
* architecture. */
#if GST_HAVE_UNALIGNED_ACCESS
#define _GST_GET(__data, __size, __end) \
(GUINT##__size##_FROM_##__end (* ((guint##__size *) (__data))))
/**
* GST_READ_UINT64_BE:
* @data: memory location
*
* Read a 64 bit unsigned integer value in big endian format from the memory buffer.
*/
#define GST_READ_UINT64_BE(data) _GST_GET (data, 64, BE)
/**
* GST_READ_UINT64_LE:
* @data: memory location
*
* Read a 64 bit unsigned integer value in little endian format from the memory buffer.
*/
#define GST_READ_UINT64_LE(data) _GST_GET (data, 64, LE)
/**
* GST_READ_UINT32_BE:
* @data: memory location
*
* Read a 32 bit unsigned integer value in big endian format from the memory buffer.
*/
#define GST_READ_UINT32_BE(data) _GST_GET (data, 32, BE)
/**
* GST_READ_UINT32_LE:
* @data: memory location
*
* Read a 32 bit unsigned integer value in little endian format from the memory buffer.
*/
#define GST_READ_UINT32_LE(data) _GST_GET (data, 32, LE)
/**
* GST_READ_UINT16_BE:
* @data: memory location
*
* Read a 16 bit unsigned integer value in big endian format from the memory buffer.
*/
#define GST_READ_UINT16_BE(data) _GST_GET (data, 16, BE)
/**
* GST_READ_UINT16_LE:
* @data: memory location
*
* Read a 16 bit unsigned integer value in little endian format from the memory buffer.
*/
#define GST_READ_UINT16_LE(data) _GST_GET (data, 16, LE)
/**
* GST_READ_UINT8:
* @data: memory location
*
* Read an 8 bit unsigned integer value from the memory buffer.
*/
#define GST_READ_UINT8(data) (* ((guint8 *) (data)))
#define _GST_PUT(__data, __size, __end, __num) \
((* (guint##__size *) (__data)) = GUINT##__size##_TO_##__end (__num))
/**
* GST_WRITE_UINT64_BE:
* @data: memory location
* @num: value to store
*
* Store a 64 bit unsigned integer value in big endian format into the memory buffer.
*/
#define GST_WRITE_UINT64_BE(data, num) _GST_PUT(data, 64, BE, num)
/**
* GST_WRITE_UINT64_LE:
* @data: memory location
* @num: value to store
*
* Store a 64 bit unsigned integer value in little endian format into the memory buffer.
*/
#define GST_WRITE_UINT64_LE(data, num) _GST_PUT(data, 64, LE, num)
/**
* GST_WRITE_UINT32_BE:
* @data: memory location
* @num: value to store
*
* Store a 32 bit unsigned integer value in big endian format into the memory buffer.
*/
#define GST_WRITE_UINT32_BE(data, num) _GST_PUT(data, 32, BE, num)
/**
* GST_WRITE_UINT32_LE:
* @data: memory location
* @num: value to store
*
* Store a 32 bit unsigned integer value in little endian format into the memory buffer.
*/
#define GST_WRITE_UINT32_LE(data, num) _GST_PUT(data, 32, LE, num)
/**
* GST_WRITE_UINT16_BE:
* @data: memory location
* @num: value to store
*
* Store a 16 bit unsigned integer value in big endian format into the memory buffer.
*/
#define GST_WRITE_UINT16_BE(data, num) _GST_PUT(data, 16, BE, num)
/**
* GST_WRITE_UINT16_LE:
* @data: memory location
* @num: value to store
*
* Store a 16 bit unsigned integer value in little endian format into the memory buffer.
*/
#define GST_WRITE_UINT16_LE(data, num) _GST_PUT(data, 16, LE, num)
/**
* GST_WRITE_UINT8:
* @data: memory location
* @num: value to store
*
* Store an 8 bit unsigned integer value into the memory buffer.
*/
#define GST_WRITE_UINT8(data, num) ((* (guint8 *) (data)) = (num))
#else /* GST_HAVE_UNALIGNED_ACCESS */
#define _GST_GET(__data, __idx, __size, __shift) \
(((guint##__size) (((guint8 *) (__data))[__idx])) << __shift)
#define GST_READ_UINT64_BE(data) (_GST_GET (data, 0, 64, 56) | \
_GST_GET (data, 1, 64, 48) | \
_GST_GET (data, 2, 64, 40) | \
_GST_GET (data, 3, 64, 32) | \
_GST_GET (data, 4, 64, 24) | \
_GST_GET (data, 5, 64, 16) | \
_GST_GET (data, 6, 64, 8) | \
_GST_GET (data, 7, 64, 0))
#define GST_READ_UINT64_LE(data) (_GST_GET (data, 7, 64, 56) | \
_GST_GET (data, 6, 64, 48) | \
_GST_GET (data, 5, 64, 40) | \
_GST_GET (data, 4, 64, 32) | \
_GST_GET (data, 3, 64, 24) | \
_GST_GET (data, 2, 64, 16) | \
_GST_GET (data, 1, 64, 8) | \
_GST_GET (data, 0, 64, 0))
#define GST_READ_UINT32_BE(data) (_GST_GET (data, 0, 32, 24) | \
_GST_GET (data, 1, 32, 16) | \
_GST_GET (data, 2, 32, 8) | \
_GST_GET (data, 3, 32, 0))
#define GST_READ_UINT32_LE(data) (_GST_GET (data, 3, 32, 24) | \
_GST_GET (data, 2, 32, 16) | \
_GST_GET (data, 1, 32, 8) | \
_GST_GET (data, 0, 32, 0))
#define GST_READ_UINT16_BE(data) (_GST_GET (data, 0, 16, 8) | \
_GST_GET (data, 1, 16, 0))
#define GST_READ_UINT16_LE(data) (_GST_GET (data, 1, 16, 8) | \
_GST_GET (data, 0, 16, 0))
#define GST_READ_UINT8(data) (_GST_GET (data, 0, 8, 0))
#define _GST_PUT(__data, __idx, __size, __shift, __num) \
(((guint8 *) (__data))[__idx] = (((guint##__size) __num) >> __shift) & 0xff)
#define GST_WRITE_UINT64_BE(data, num) do { \
_GST_PUT (data, 0, 64, 56, num); \
_GST_PUT (data, 1, 64, 48, num); \
_GST_PUT (data, 2, 64, 40, num); \
_GST_PUT (data, 3, 64, 32, num); \
_GST_PUT (data, 4, 64, 24, num); \
_GST_PUT (data, 5, 64, 16, num); \
_GST_PUT (data, 6, 64, 8, num); \
_GST_PUT (data, 7, 64, 0, num); \
} while (0)
#define GST_WRITE_UINT64_LE(data, num) do { \
_GST_PUT (data, 0, 64, 0, num); \
_GST_PUT (data, 1, 64, 8, num); \
_GST_PUT (data, 2, 64, 16, num); \
_GST_PUT (data, 3, 64, 24, num); \
_GST_PUT (data, 4, 64, 32, num); \
_GST_PUT (data, 5, 64, 40, num); \
_GST_PUT (data, 6, 64, 48, num); \
_GST_PUT (data, 7, 64, 56, num); \
} while (0)
#define GST_WRITE_UINT32_BE(data, num) do { \
_GST_PUT (data, 0, 32, 24, num); \
_GST_PUT (data, 1, 32, 16, num); \
_GST_PUT (data, 2, 32, 8, num); \
_GST_PUT (data, 3, 32, 0, num); \
} while (0)
#define GST_WRITE_UINT32_LE(data, num) do { \
_GST_PUT (data, 0, 32, 0, num); \
_GST_PUT (data, 1, 32, 8, num); \
_GST_PUT (data, 2, 32, 16, num); \
_GST_PUT (data, 3, 32, 24, num); \
} while (0)
#define GST_WRITE_UINT16_BE(data, num) do { \
_GST_PUT (data, 0, 16, 8, num); \
_GST_PUT (data, 1, 16, 0, num); \
} while (0)
#define GST_WRITE_UINT16_LE(data, num) do { \
_GST_PUT (data, 0, 16, 0, num); \
_GST_PUT (data, 1, 16, 8, num); \
} while (0)
#define GST_WRITE_UINT8(data, num) do { \
_GST_PUT (data, 0, 8, 0, num); \
} while (0)
#endif /* GST_HAVE_UNALIGNED_ACCESS */
/* Miscellaneous utility macros */
/**
* GST_ROUND_UP_2:
* @num: value round up
*
* Make number divideable by two without a rest.
*/
#define GST_ROUND_UP_2(num) (((num)+1)&~1)
/**
* GST_ROUND_UP_4:
* @num: value round up
*
* Make number divideable by four without a rest.
*/
#define GST_ROUND_UP_4(num) (((num)+3)&~3)
/**
* GST_ROUND_UP_8:
* @num: value round up
*
* Make number divideable by eight without a rest.
*/
#define GST_ROUND_UP_8(num) (((num)+7)&~7)
/**
* GST_ROUND_UP_16:
* @num: value round up
*
* Make number divideable by 16 without a rest.
*/
#define GST_ROUND_UP_16(num) (((num)+15)&~15)
/**
* GST_ROUND_UP_32:
* @num: value round up
*
* Make number divideable by 32 without a rest.
*/
#define GST_ROUND_UP_32(num) (((num)+31)&~31)
/**
* GST_ROUND_UP_64:
* @num: value round up
*
* Make number divideable by 64 without a rest.
*/
#define GST_ROUND_UP_64(num) (((num)+63)&~63)
void gst_object_default_error (GstObject * source,
GError * error, gchar * debug);
/* rec mutex */
#ifndef g_static_rec_cond_wait
#define GST_COMPILE_STATIC_REC_COND_WAIT
void g_static_rec_cond_wait (GCond *cond,
GStaticRecMutex *mutex);
gboolean g_static_rec_cond_timed_wait (GCond *cond,
GStaticRecMutex *mutex,
GTimeVal *end_time);
#endif
/* element functions */
GstFlowReturn gst_element_abort_preroll (GstElement *element);
GstFlowReturn gst_element_finish_preroll (GstElement *element, GstPad *pad);
void gst_element_create_all_pads (GstElement *element);
GstPad* gst_element_get_compatible_pad (GstElement *element, GstPad *pad,
const GstCaps *caps);
GstPadTemplate* gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
G_CONST_RETURN gchar* gst_element_state_get_name (GstState state);
gboolean gst_element_link (GstElement *src, GstElement *dest);
gboolean gst_element_link_many (GstElement *element_1,
GstElement *element_2, ...);
gboolean gst_element_link_filtered (GstElement * src,
GstElement * dest,
GstCaps *filter);
void gst_element_unlink (GstElement *src, GstElement *dest);
void gst_element_unlink_many (GstElement *element_1,
GstElement *element_2, ...);
gboolean gst_element_link_pads (GstElement *src, const gchar *srcpadname,
GstElement *dest, const gchar *destpadname);
void gst_element_unlink_pads (GstElement *src, const gchar *srcpadname,
GstElement *dest, const gchar *destpadname);
gboolean gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
GstElement * dest, const gchar * destpadname,
GstCaps *filter);
/* util elementfactory functions */
gboolean gst_element_factory_can_src_caps(GstElementFactory *factory, const GstCaps *caps);
gboolean gst_element_factory_can_sink_caps(GstElementFactory *factory, const GstCaps *caps);
/* util query functions */
gboolean gst_element_query_position (GstElement *element, GstFormat *format,
gint64 *cur);
gboolean gst_element_query_duration (GstElement *element, GstFormat *format,
gint64 *duration);
gboolean gst_element_query_convert (GstElement *element, GstFormat src_format, gint64 src_val,
GstFormat *dest_fmt, gint64 *dest_val);
/* element class functions */
void gst_element_class_install_std_props (GstElementClass * klass,
const gchar * first_name, ...);
/* pad functions */
gboolean gst_pad_can_link (GstPad *srcpad, GstPad *sinkpad);
void gst_pad_use_fixed_caps (GstPad *pad);
GstCaps* gst_pad_get_fixed_caps_func (GstPad *pad);
GstCaps* gst_pad_proxy_getcaps (GstPad * pad);
gboolean gst_pad_proxy_setcaps (GstPad * pad, GstCaps * caps);
GstElement* gst_pad_get_parent_element (GstPad *pad);
/* util query functions */
gboolean gst_pad_query_position (GstPad *pad, GstFormat *format,
gint64 *cur);
gboolean gst_pad_query_duration (GstPad *pad, GstFormat *format,
gint64 *duration);
gboolean gst_pad_query_convert (GstPad *pad, GstFormat src_format, gint64 src_val,
GstFormat *dest_format, gint64 *dest_val);
/* bin functions */
void gst_bin_add_many (GstBin *bin, GstElement *element_1, ...);
void gst_bin_remove_many (GstBin *bin, GstElement *element_1, ...);
/* buffer functions */
GstBuffer * gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2);
GstBuffer * gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2);
void gst_buffer_stamp (GstBuffer * dest, const GstBuffer * src);
/* atomic functions */
void gst_atomic_int_set (gint * atomic_int, gint value);
/* probes */
gulong gst_pad_add_data_probe (GstPad * pad,
GCallback handler,
gpointer data);
void gst_pad_remove_data_probe (GstPad * pad, guint handler_id);
gulong gst_pad_add_event_probe (GstPad * pad,
GCallback handler,
gpointer data);
void gst_pad_remove_event_probe (GstPad * pad, guint handler_id);
gulong gst_pad_add_buffer_probe (GstPad * pad,
GCallback handler,
gpointer data);
void gst_pad_remove_buffer_probe (GstPad * pad, guint handler_id);
/* tag emission utility functions */
void gst_element_found_tags_for_pad (GstElement * element,
GstPad * pad,
GstTagList * list);
void gst_element_found_tags (GstElement * element,
GstTagList * list);
G_END_DECLS
#endif /* __GST_UTILS_H__ */