mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-10 18:14:15 +00:00
Code Issues 1 Projects Releases Wiki Activity

more docs added

Browse source 
Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gstcaps.h:
* gst/gstinfo.c:
* gst/gstminiobject.h:
* gst/gstobject.h:
* gst/gstutils.h:
more docs added
This commit is contained in:
Stefan Kost 2005-11-04 20:12:01 +00:00
parent 875b25482c
commit fd15eb56af
7 changed files with 54 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
ChangeLog
View file

@ -1,3 +1,13 @@
2005-11-04 Stefan Kost <ensonic@users.sf.net>
* docs/gst/gstreamer-sections.txt:
* gst/gstcaps.h:
* gst/gstinfo.c:
* gst/gstminiobject.h:
* gst/gstobject.h:
* gst/gstutils.h:
more docs added
2005-11-04 Wim Taymans <wim@fluendo.com>
* gst/base/gstbasesrc.c: (gst_base_src_get_range):

8
docs/gst/gstreamer-sections.txt
View file

@ -2317,10 +2317,6 @@ gst_collectpads_pop
gst_collectpads_available
gst_collectpads_read
gst_collectpads_flush
GST_COLLECTPADS_BROADCAST
GST_COLLECTPADS_GET_COND
GST_COLLECTPADS_SIGNAL
GST_COLLECTPADS_WAIT
<SUBSECTION Standard>
GstCollectPadsClass
GST_COLLECTPADS
@ -2331,6 +2327,10 @@ GST_IS_COLLECTPADS_CLASS
GST_COLLECTPADS_GET_CLASS
<SUBSECTION Private>
gst_collectpads_get_type
GST_COLLECTPADS_BROADCAST
GST_COLLECTPADS_GET_COND
GST_COLLECTPADS_SIGNAL
GST_COLLECTPADS_WAIT
</SECTION>

12
gst/gstcaps.h
View file

@ -106,7 +106,19 @@ typedef struct _GstCaps GstCaps;
typedef struct _GstStaticCaps GstStaticCaps;
/* refcount */
/**
* GST_CAPS_REFCOUNT:
* @caps: a #GstCaps
*
* Get access to the reference count field of the caps
*/
#define GST_CAPS_REFCOUNT(caps) ((GST_CAPS(caps))->refcount)
/**
* GST_CAPS_REFCOUNT_VALUE:
* @caps: a #GstCaps
*
* Get the reference count value of the caps.
*/
#define GST_CAPS_REFCOUNT_VALUE(caps) (g_atomic_int_get (&(GST_CAPS(caps))->refcount))
struct _GstCaps {

9
gst/gstinfo.c
View file

@ -69,10 +69,9 @@
*
* The whole debugging subsystem can be disabled at build time with passing the
* --disable-gst-debug switch to configure. If this is done, every function,
* macro
* and even structs described in this file evaluate to default values or
* nothing
* at all. So don't take addresses of these functions or use other tricks.
* macro and even structs described in this file evaluate to default values or
* nothing at all.
* So don't take addresses of these functions or use other tricks.
* If you must do that for some reason, there is still an option.
* If the debugging
* subsystem was compiled out, #GST_DISABLE_GST_DEBUG is defined in
@ -264,7 +263,7 @@ __gst_in_valgrind (void)
* _gst_debug_init:
*
* Initializes the debugging system.
* Normally you don't want to call this, because gst_init does it for you.
* Normally you don't want to call this, because gst_init() does it for you.
*/
void
_gst_debug_init (void)

4
gst/gstminiobject.h
View file

@ -115,14 +115,14 @@ typedef enum
/**
* GST_MINI_OBJECT_REFCOUNT:
* @obj: MiniObject get the refcount for.
* @obj: a #GstMiniObject
*
* Get access to the reference count field of the mini-object.
*/
#define GST_MINI_OBJECT_REFCOUNT(obj) ((GST_MINI_OBJECT_CAST(obj))->refcount)
/**
* GST_MINI_OBJECT_REFCOUNT_VALUE:
* @obj: MiniObject get the refcount value for.
* @obj: a #GstMiniObject
*
* Get the reference count value of the mini-object.
*/

4
gst/gstobject.h
View file

@ -65,14 +65,14 @@ typedef enum
#ifdef GST_HAVE_GLIB_2_8
/**
* GST_OBJECT_REFCOUNT:
* @obj: Object get the refcount for.
* @obj: a #GstObject
*
* Get access to the reference count field of the object.
*/
#define GST_OBJECT_REFCOUNT(obj) (((GObject*)(obj))->ref_count)
/**
* GST_OBJECT_REFCOUNT_VALUE:
* @obj: Object get the refcount value for.
* @obj: a #GstObject
*
* Get the reference count value of the object.
*/

26
gst/gstutils.h
View file

@ -188,18 +188,32 @@ type_as_function ## _init_interfaces (GType type) \
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
/**
* GST_CALL_PARENT:
* @parent_class_cast: the name of the class cast macro for the parent type
* @name: name of the function to call
* @args: arguments enclosed in '( )'
*
* 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 _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) \
/**
* GST_CALL_PARENT_WITH_DEFAULT:
* @parent_class_cast: the name of the class cast macro for the parent type
* @name: name of the function to call
* @args: arguments enclosed in '( )'
* @def_return: default result
*
* Same as GST_CALL_PARENT(), 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)