mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-11 09:55:36 +00:00
Code Issues 1 Projects Releases Wiki Activity

inlied another one and added some obvious docs

Browse source 
Original commit message from CVS:
* docs/gst/tmpl/.cvsignore:
* docs/gst/tmpl/gstvalue.sgml:
* gst/gstvalue.c:
* gst/gstvalue.h:
inlied another one and added  some obvious docs
This commit is contained in:
Stefan Kost 2005-09-21 09:48:40 +00:00
parent 71491998d5
commit d13c1a7b10
5 changed files with 115 additions and 623 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
ChangeLog
View file

@ -1,3 +1,11 @@
2005-09-21 Stefan Kost <ensonic@users.sf.net>
* docs/gst/tmpl/.cvsignore:
* docs/gst/tmpl/gstvalue.sgml:
* gst/gstvalue.c:
* gst/gstvalue.h:
inlied another one and added some obvious docs
2005-09-21 Wim Taymans <wim@fluendo.com>
* gst/elements/gstfdsrc.c: (gst_fdsrc_class_init),

1
docs/gst/tmpl/.gitignore vendored
View file

@ -56,6 +56,7 @@ gsttypes.sgml
gsturihandler.sgml
gsturitype.sgml
gstutils.sgml
gstvalue.sgml
gstversion.sgml
gstxml.sgml
gstxmlregistry.sgml

622
docs/gst/tmpl/gstvalue.sgml
View file

@ -1,622 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstValue
<!-- ##### SECTION Short_Description ##### -->
GValue implementations specific to GStreamer
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
@x:
<!-- ##### MACRO GST_MAKE_FOURCC ##### -->
@a:
@b:
@c:
@d:
<!-- ##### MACRO GST_STR_FOURCC ##### -->
@f:
<!-- ##### MACRO GST_FOURCC_FORMAT ##### -->
<!-- ##### MACRO GST_FOURCC_ARGS ##### -->
@fourcc:
<!-- ##### MACRO GST_TYPE_FOURCC ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_value_set_fourcc ##### -->
<para>
</para>
@value:
@fourcc:
<!-- ##### FUNCTION gst_value_get_fourcc ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### MACRO GST_VALUE_HOLDS_INT_RANGE ##### -->
@x:
<!-- ##### MACRO GST_TYPE_INT_RANGE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_value_set_int_range ##### -->
<para>
</para>
@value:
@start:
@end:
<!-- ##### FUNCTION gst_value_get_int_range_min ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_get_int_range_max ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### MACRO GST_VALUE_HOLDS_DOUBLE_RANGE ##### -->
@x:
<!-- ##### MACRO GST_TYPE_DOUBLE_RANGE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_value_set_double_range ##### -->
<para>
</para>
@value:
@start:
@end:
<!-- ##### FUNCTION gst_value_get_double_range_min ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_get_double_range_max ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### MACRO GST_VALUE_HOLDS_LIST ##### -->
<para>
Checks if the give GValue contains a LIST value.
</para>
@x: the #GValue to check
<!-- ##### MACRO GST_TYPE_LIST ##### -->
<para>
</para>
<!-- ##### MACRO GST_VALUE_HOLDS_ARRAY ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GST_TYPE_ARRAY ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_value_list_append_value ##### -->
<para>
</para>
@value:
@append_value:
<!-- ##### FUNCTION gst_value_list_prepend_value ##### -->
<para>
</para>
@value:
@prepend_value:
<!-- ##### FUNCTION gst_value_list_concat ##### -->
<para>
</para>
@dest:
@value1:
@value2:
<!-- ##### FUNCTION gst_value_list_get_size ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_list_get_value ##### -->
<para>
</para>
@value:
@index:
@Returns:
<!-- ##### MACRO GST_VALUE_HOLDS_FRACTION ##### -->
<para>
Checks if the give GValue contains a FRACTION value.
</para>
@x: the #GValue to check
<!-- ##### MACRO GST_TYPE_FRACTION ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_value_set_fraction ##### -->
<para>
</para>
@value:
@numerator:
@denominator:
<!-- ##### FUNCTION gst_value_get_fraction_numerator ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_get_fraction_denominator ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_fraction_multiply ##### -->
<para>
</para>
@product:
@factor1:
@factor2:
@Returns:
<!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
<para>
Checks if the give GValue contains a CAPS value.
</para>
@x: the #GValue to check
<!-- ##### FUNCTION gst_value_set_caps ##### -->
<para>
</para>
@value:
@caps:
<!-- # Unused Parameters # -->
@calue:
<!-- ##### FUNCTION gst_value_get_caps ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### MACRO GST_VALUE_HOLDS_MINI_OBJECT ##### -->
<para>
</para>
@value:
<!-- ##### MACRO GST_VALUE_HOLDS_BUFFER ##### -->
<para>
</para>
@x:
<!-- ##### MACRO gst_value_get_buffer ##### -->
<para>
</para>
@v:
<!-- ##### MACRO gst_value_set_buffer ##### -->
<para>
</para>
@v:
@b:
<!-- ##### MACRO gst_value_take_buffer ##### -->
<para>
</para>
@v:
@b:
<!-- ##### MACRO GST_VALUE_LESS_THAN ##### -->
<para>
Indicates that the first value provided to a comparison function
(gst_value_compare()) is lesser than the second one.
</para>
<!-- ##### MACRO GST_VALUE_EQUAL ##### -->
<para>
Indicates that the first value provided to a comparison function
(gst_value_compare()) is equal to the second one.
</para>
<!-- ##### MACRO GST_VALUE_GREATER_THAN ##### -->
<para>
Indicates that the first value provided to a comparison function
(gst_value_compare()) is greater than the second one.
</para>
<!-- ##### MACRO GST_VALUE_UNORDERED ##### -->
<para>
Indicates that the comparison function (gst_value_compare()) can not
determine a order for the two provided values.
</para>
<!-- ##### USER_FUNCTION GstValueCompareFunc ##### -->
<para>
</para>
@value1:
@value2:
@Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL,
GST_VALUE_GREATER_THAN or GST_VALUE_UNORDERED
<!-- ##### USER_FUNCTION GstValueSerializeFunc ##### -->
<para>
</para>
@value1:
@Returns:
<!-- ##### USER_FUNCTION GstValueDeserializeFunc ##### -->
<para>
</para>
@dest:
@s:
@Returns:
<!-- ##### USER_FUNCTION GstValueUnionFunc ##### -->
<para>
</para>
@dest:
@value1:
@value2:
@Returns:
<!-- ##### USER_FUNCTION GstValueIntersectFunc ##### -->
<para>
</para>
@dest:
@value1:
@value2:
@Returns:
<!-- ##### USER_FUNCTION GstValueSubtractFunc ##### -->
<para>
</para>
@dest:
@minuend:
@subtrahend:
@Returns:
<!-- ##### STRUCT GstValueTable ##### -->
<para>
</para>
@type:
@compare:
@serialize:
@deserialize:
<!-- ##### FUNCTION gst_value_is_fixed ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_register ##### -->
<para>
</para>
@table:
<!-- ##### FUNCTION gst_value_init_and_copy ##### -->
<para>
</para>
@dest:
@src:
<!-- ##### FUNCTION gst_value_serialize ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_deserialize ##### -->
<para>
</para>
@dest:
@src:
@Returns:
<!-- ##### FUNCTION gst_value_compare ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_can_compare ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_union ##### -->
<para>
</para>
@dest:
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_can_union ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_register_union_func ##### -->
<para>
</para>
@type1:
@type2:
@func:
<!-- ##### FUNCTION gst_value_subtract ##### -->
<para>
</para>
@dest:
@minuend:
@subtrahend:
@Returns:
<!-- ##### FUNCTION gst_value_can_subtract ##### -->
<para>
</para>
@minuend:
@subtrahend:
@Returns:
<!-- ##### FUNCTION gst_value_register_subtract_func ##### -->
<para>
</para>
@minuend_type:
@subtrahend_type:
@func:
<!-- ##### FUNCTION gst_value_intersect ##### -->
<para>
</para>
@dest:
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_can_intersect ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_register_intersect_func ##### -->
<para>
</para>
@type1:
@type2:
@func:

5
gst/gstvalue.c
View file

@ -16,6 +16,11 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gstvalue
* @short_description: GValue implementations specific to GStreamer
*
*/
#ifdef HAVE_CONFIG_H
#include "config.h"

102
gst/gstvalue.h
View file

@ -107,16 +107,74 @@ G_BEGIN_DECLS
* Checks if the given #GValue contains a #GST_TYPE_DOUBLE_RANGE value.
*/
#define GST_VALUE_HOLDS_DOUBLE_RANGE(x) (G_VALUE_HOLDS(x, gst_type_double_range))
/**
* GST_VALUE_HOLDS_LIST:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_LIST value.
*/
#define GST_VALUE_HOLDS_LIST(x) (G_VALUE_HOLDS(x, gst_type_list))
/**
* GST_VALUE_HOLDS_ARRAY:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_ARRAY value.
*/
#define GST_VALUE_HOLDS_ARRAY(x) (G_VALUE_HOLDS(x, gst_type_array))
/**
* GST_VALUE_HOLDS_CAPS:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_CAPS value.
*/
#define GST_VALUE_HOLDS_CAPS(x) (G_VALUE_HOLDS(x, GST_TYPE_CAPS))
/**
* GST_VALUE_HOLDS_BUFFER:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_BUFFER value.
*/
#define GST_VALUE_HOLDS_BUFFER(x) (G_VALUE_HOLDS(x, GST_TYPE_BUFFER))
/**
* GST_VALUE_HOLDS_FRACTION:
* @x: the #GValue to check
*
* Checks if the given #GValue contains a #GST_TYPE_FRACTION value.
*/
#define GST_VALUE_HOLDS_FRACTION(x) (G_VALUE_HOLDS(x, gst_type_fraction))
/**
* GST_TYPE_FOURCC:
*
* a #GValue type that represents 4 byte identifier (e.g. used for codecs)
*
* Returns: the #GType of GstFourcc
*/
#define GST_TYPE_FOURCC gst_type_fourcc
/**
* GST_TYPE_INT_RANGE:
*
* a #GValue type that represents an integer range
*
* Returns: the #GType of GstIntRange
*/
#define GST_TYPE_INT_RANGE gst_type_int_range
/**
* GST_TYPE_DOUBLE_RANGE:
*
* a #GValue type that represents a floating point range with double precission
*
* Returns: the #GType of GstIntRange
*/
#define GST_TYPE_DOUBLE_RANGE gst_type_double_range
/**
* GST_TYPE_LIST:
*
@ -124,7 +182,6 @@ G_BEGIN_DECLS
*
* Returns: the #GType of GstValueList (which is not explicitly typed)
*/
#define GST_TYPE_LIST gst_type_list
/**
@ -147,22 +204,65 @@ G_BEGIN_DECLS
#define GST_TYPE_FRACTION gst_type_fraction
/**
* GST_VALUE_LESS_THAN:
*
* Indicates that the first value provided to a comparison function
* (gst_value_compare()) is lesser than the second one.
*/
#define GST_VALUE_LESS_THAN (-1)
/**
* GST_VALUE_EQUAL:
*
* Indicates that the first value provided to a comparison function
* (gst_value_compare()) is equal to the second one.
*/
#define GST_VALUE_EQUAL 0
/**
* GST_VALUE_GREATER_THAN:
*
* Indicates that the first value provided to a comparison function
* (gst_value_compare()) is greater than the second one.
*/
#define GST_VALUE_GREATER_THAN 1
/**
* GST_VALUE_UNORDERED:
*
* Indicates that the comparison function (gst_value_compare()) can not
* determine a order for the two provided values.
*/
#define GST_VALUE_UNORDERED 2
/**
* GstValueCompareFunc:
* @value1: first value for comparission
* @value2: second value for comparission
*
* Used together with gst_value_compare() to compare #GValues.
*
* Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL, GST_VALUE_GREATER_THAN
* or GST_VALUE_UNORDERED
*/
typedef int (* GstValueCompareFunc) (const GValue *value1,
const GValue *value2);
typedef char * (* GstValueSerializeFunc) (const GValue *value1);
typedef gboolean (* GstValueDeserializeFunc) (GValue *dest,
const char *s);
typedef int (* GstValueUnionFunc) (GValue *dest,
const GValue *value1,
const GValue *value2);
typedef int (* GstValueIntersectFunc) (GValue *dest,
const GValue *value1,
const GValue *value2);
typedef int (* GstValueSubtractFunc) (GValue *dest,
const GValue *minuend,
const GValue *subtrahend);