mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 19:51:11 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs/gst/: rearrange gstvalue section

Browse source 
Original commit message from CVS:

* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/gstvalue.sgml:
rearrange gstvalue section
* gst/gstutils.c: (gst_element_state_get_name):
NONE -> VOID
* gst/gstvalue.c: (_gst_value_initialize):
* gst/gstvalue.h:
doc updates
This commit is contained in:
Thomas Vander Stichele 2005-09-11 12:01:12 +00:00
parent 574cabacba
commit ff783ad5fa
6 changed files with 453 additions and 317 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
ChangeLog
View file

@ -1,3 +1,14 @@
2005-09-11 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/gstvalue.sgml:
rearrange gstvalue section
* gst/gstutils.c: (gst_element_state_get_name):
NONE -> VOID
* gst/gstvalue.c: (_gst_value_initialize):
* gst/gstvalue.h:
doc updates
2005-09-10 Jan Schmidt <thaytan@mad.scientist.com>
* check/gst-libs/controller.c:

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

@ -2059,19 +2059,65 @@ GST_HAVE_UNALIGNED_ACCESS
<SECTION>
<FILE>gstvalue</FILE>
<TITLE>GstValue</TITLE>
<TITLE>GStreamer GValue types</TITLE>
<SUBSECTION fourcc>
GST_VALUE_HOLDS_FOURCC
GST_MAKE_FOURCC
GST_STR_FOURCC
GST_FOURCC_FORMAT
GST_FOURCC_ARGS
GST_VALUE_HOLDS_FOURCC
GST_TYPE_FOURCC
gst_value_set_fourcc
gst_value_get_fourcc
<SUBSECTION intrange>
GST_VALUE_HOLDS_INT_RANGE
GST_TYPE_INT_RANGE
gst_value_set_int_range
gst_value_get_int_range_min
gst_value_get_int_range_max
<SUBSECTION doublerange>
GST_VALUE_HOLDS_DOUBLE_RANGE
GST_TYPE_DOUBLE_RANGE
gst_value_set_double_range
gst_value_get_double_range_min
gst_value_get_double_range_max
<SUBSECTION valuelist>
GST_VALUE_HOLDS_LIST
GST_VALUE_HOLDS_CAPS
GST_VALUE_HOLDS_FRACTION
GST_TYPE_LIST
GST_VALUE_HOLDS_ARRAY
GST_TYPE_ARRAY
gst_value_list_append_value
gst_value_list_prepend_value
gst_value_list_concat
gst_value_list_get_size
gst_value_list_get_value
<SUBSECTION fraction>
GST_VALUE_HOLDS_FRACTION
GST_TYPE_FRACTION
gst_value_set_fraction
gst_value_get_fraction_numerator
gst_value_get_fraction_denominator
gst_value_fraction_multiply
<SUBSECTION caps>
GST_VALUE_HOLDS_CAPS
gst_value_set_caps
gst_value_get_caps
<SUBSECTION miniobject>
GST_VALUE_HOLDS_MINI_OBJECT
GST_VALUE_HOLDS_BUFFER
gst_value_get_buffer
gst_value_set_buffer
gst_value_take_buffer
<SUBSECTION>
GST_VALUE_LESS_THAN
GST_VALUE_EQUAL
GST_VALUE_GREATER_THAN
@ -2090,28 +2136,6 @@ gst_value_register
gst_value_init_and_copy
gst_value_serialize
gst_value_deserialize
gst_value_list_append_value
gst_value_list_prepend_value
gst_value_list_concat
gst_value_list_get_size
gst_value_list_get_value
gst_value_set_fourcc
gst_value_get_fourcc
gst_value_set_int_range
gst_value_get_int_range_min
gst_value_get_int_range_max
gst_value_set_double_range
gst_value_get_double_range_min
gst_value_get_double_range_max
gst_value_get_caps
gst_value_set_caps
gst_value_get_fraction_numerator
gst_value_get_fraction_denominator
gst_value_set_fraction
gst_value_get_buffer
gst_value_set_buffer
gst_value_take_buffer
gst_value_fraction_multiply
gst_value_compare
gst_value_can_compare
gst_value_union
@ -2124,15 +2148,8 @@ gst_value_intersect
gst_value_can_intersect
gst_value_register_intersect_func
<SUBSECTION Standard>
GST_TYPE_FOURCC
GST_TYPE_INT_RANGE
GST_TYPE_DOUBLE_RANGE
GST_TYPE_LIST
GST_TYPE_FRACTION
GST_TYPE_ARRAY
</SECTION>
<SECTION>
<FILE>gstversion</FILE>
<TITLE>GstVersion</TITLE>

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

@ -17,85 +17,143 @@ GValue implementations specific to GStreamer
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO GST_MAKE_FOURCC ##### -->
<para>
will transform four characters into a host-endiannness guint32 fourcc:
<informalexample>
<programlisting>
guint32 fourcc = GST_MAKE_FOURCC ('M','J','P','G');
</programlisting>
</informalexample>
</para>
<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
@a: the first component
@b: the second component
@c: the third component
@d: the fourth component
@x:
<!-- ##### MACRO GST_MAKE_FOURCC ##### -->
@a:
@b:
@c:
@d:
<!-- ##### MACRO GST_STR_FOURCC ##### -->
<para>
Creates a fourcc from an input string. The input string should consisnt
of at least four characters (this is not checked for!).
<informalexample>
<programlisting>
guint32 fourcc = GST_STR_FOURCC("MJPG");
</programlisting>
</informalexample>
</para>
@f: a string with four characters
@f:
<!-- ##### MACRO GST_FOURCC_FORMAT ##### -->
<para>
Can be used to properly output a fourcc (a guint32) value in a
printf()-style text message.
<informalexample>
<programlisting>
printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
</programlisting>
</informalexample>
</para>
<!-- ##### MACRO GST_FOURCC_ARGS ##### -->
@fourcc:
<!-- ##### MACRO GST_TYPE_FOURCC ##### -->
<para>
Can be used to properly output a fourcc (a guint32) value in a
printf()-style text message.
<informalexample>
<programlisting>
printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
</programlisting>
</informalexample>
</para>
@fourcc: the fourcc value to print
<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
<!-- ##### FUNCTION gst_value_set_fourcc ##### -->
<para>
Checks if the give GValue contains a FOURCC value.
</para>
@x: the #GValue to check
@value:
@fourcc:
<!-- ##### FUNCTION gst_value_get_fourcc ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### MACRO GST_VALUE_HOLDS_INT_RANGE ##### -->
@x:
<!-- ##### MACRO GST_TYPE_INT_RANGE ##### -->
<para>
Checks if the give GValue contains a INT_RANGE value.
</para>
@x: the #GValue to check
<!-- ##### 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>
Checks if the give GValue contains a DOUBLE_RANGE value.
</para>
@x: the #GValue to check
<!-- ##### 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 ##### -->
@ -106,20 +164,11 @@ Checks if the give GValue contains a LIST value.
@x: the #GValue to check
<!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
<!-- ##### MACRO GST_TYPE_LIST ##### -->
<para>
Checks if the give GValue contains a CAPS value.
</para>
@x: the #GValue to check
<!-- ##### MACRO GST_VALUE_HOLDS_FRACTION ##### -->
<para>
Checks if the give GValue contains a FRACTION value.
</para>
@x: the #GValue to check
<!-- ##### MACRO GST_VALUE_HOLDS_ARRAY ##### -->
@ -130,6 +179,142 @@ Checks if the give GValue contains a FRACTION value.
@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>
@ -138,6 +323,40 @@ Checks if the give GValue contains a FRACTION value.
@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
@ -288,212 +507,6 @@ GST_VALUE_GREATER_THAN or GST_VALUE_UNORDERED
@Returns:
<!-- ##### 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:
<!-- ##### FUNCTION gst_value_set_fourcc ##### -->
<para>
</para>
@value:
@fourcc:
<!-- ##### FUNCTION gst_value_get_fourcc ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### 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:
<!-- ##### 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:
<!-- ##### FUNCTION gst_value_get_caps ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_set_caps ##### -->
<para>
</para>
@value:
@caps:
<!-- # Unused Parameters # -->
@calue:
<!-- ##### FUNCTION gst_value_get_fraction_numerator ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_get_fraction_denominator ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_set_fraction ##### -->
<para>
</para>
@value:
@numerator:
@denominator:
<!-- ##### 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:
<!-- ##### FUNCTION gst_value_fraction_multiply ##### -->
<para>
</para>
@product:
@factor1:
@factor2:
@Returns:
<!-- ##### FUNCTION gst_value_compare ##### -->
<para>

4
gst/gstutils.c
View file

@ -715,7 +715,7 @@ gst_element_state_get_name (GstState state)
switch (state) {
#ifdef GST_DEBUG_COLOR
case GST_STATE_VOID_PENDING:
return "NONE_PENDING";
return "VOID_PENDING";
break;
case GST_STATE_NULL:
return "\033[01;34mNULL\033[00m";
@ -734,7 +734,7 @@ gst_element_state_get_name (GstState state)
return g_strdup_printf ("\033[01;35;41mUNKNOWN!\033[00m(%d)", state);
#else
case GST_STATE_VOID_PENDING:
return "NONE_PENDING";
return "VOID_PENDING";
break;
case GST_STATE_NULL:
return "NULL";

31
gst/gstvalue.c
View file

@ -274,7 +274,7 @@ gst_value_list_append_value (GValue * value, const GValue * append_value)
/**
* gst_value_list_get_size:
* @value: a GstValueList
* @value: a #GValue of type #GST_LIST_TYPE or #GST_ARRAY_TYPE
*
* Gets the number of values contained in @value.
*
@ -291,7 +291,7 @@ gst_value_list_get_size (const GValue * value)
/**
* gst_value_list_get_value:
* @value: a GstValueList
* @value: a #GValue of type #GST_LIST_TYPE or #GST_ARRAY_TYPE
* @index: index of value to get from the list
*
* Gets the value that is a member of the list contained in @value and
@ -466,8 +466,8 @@ gst_value_lcopy_fourcc (const GValue * value, guint n_collect_values,
/**
* gst_value_set_fourcc:
* @value: a GValue initialized to GST_TYPE_FOURCC
* @fourcc: the fourcc to set
* @value: a GValue initialized to #GST_TYPE_FOURCC
* @fourcc: the #guint32 fourcc to set
*
* Sets @value to @fourcc.
*/
@ -481,11 +481,11 @@ gst_value_set_fourcc (GValue * value, guint32 fourcc)
/**
* gst_value_get_fourcc:
* @value: a GValue initialized to GST_TYPE_FOURCC
* @value: a GValue initialized to #GST_TYPE_FOURCC
*
* Gets the fourcc contained in @value.
* Gets the #guint32 fourcc contained in @value.
*
* Returns: the fourcc contained in @value.
* Returns: the #guint32 fourcc contained in @value.
*/
guint32
gst_value_get_fourcc (const GValue * value)
@ -2685,7 +2685,7 @@ gst_value_lcopy_fraction (const GValue * value, guint n_collect_values,
/**
* gst_value_set_fraction:
* @value: a GValue initialized to GST_TYPE_FRACTION
* @value: a GValue initialized to #GST_TYPE_FRACTION
* @numerator: the numerator of the fraction
* @denominator: the denominator of the fraction
*
@ -2721,7 +2721,7 @@ gst_value_set_fraction (GValue * value, gint numerator, gint denominator)
/**
* gst_value_get_fraction_numerator:
* @value: a GValue initialized to GST_TYPE_FRACTION
* @value: a GValue initialized to #GST_TYPE_FRACTION
*
* Gets the numerator of the fraction specified by @value.
*
@ -2737,7 +2737,7 @@ gst_value_get_fraction_numerator (const GValue * value)
/**
* gst_value_get_fraction_denominator:
* @value: a GValue initialized to GST_TYPE_FRACTION
* @value: a GValue initialized to #GST_TYPE_FRACTION
*
* Gets the denominator of the fraction specified by @value.
*
@ -2753,9 +2753,9 @@ gst_value_get_fraction_denominator (const GValue * value)
/**
* gst_value_fraction_multiply:
* @product: a GValue initialized to GST_TYPE_FRACTION
* @factor1: a GValue initialized to GST_TYPE_FRACTION
* @factor2: a GValue initialized to GST_TYPE_FRACTION
* @product: a GValue initialized to #GST_TYPE_FRACTION
* @factor1: a GValue initialized to #GST_TYPE_FRACTION
* @factor2: a GValue initialized to #GST_TYPE_FRACTION
*
* Multiplies the two GValues containing a GstFraction and sets @product
* to the product of the two fractions.
@ -3142,11 +3142,6 @@ _gst_value_initialize (void)
gst_value_deserialize_buffer,
};
#if 0
info.value_table = &value_table;
gst_type_fourcc =
g_type_register_static (G_TYPE_BOXED, "GstFourcc", &info, 0);
#endif
gst_value.type = GST_TYPE_BUFFER;
gst_value_register (&gst_value);
}

100
gst/gstvalue.h
View file

@ -25,29 +25,129 @@
G_BEGIN_DECLS
/**
* GST_MAKE_FOURCC:
* @a: the first character
* @b: the second character
* @c: the third character
* @d: the fourth character
*
* Transform four characters into a #guint32 fourcc value with host
* endianness.
* <informalexample>
* <programlisting>
* guint32 fourcc = GST_MAKE_FOURCC ('M', 'J', 'P', 'G');
* </programlisting>
* </informalexample>
*/
#define GST_MAKE_FOURCC(a,b,c,d) (guint32)((a)|(b)<<8|(c)<<16|(d)<<24)
/**
* GST_STR_FOURCC:
* @f: a string with at least four characters
*
* Transform an input string into a #guint32 fourcc value with host
* endianness.
* Caller is responsible for ensuring the input string consists of at least
* four characters.
* <informalexample>
* <programlisting>
* guint32 fourcc = GST_STR_FOURCC ("MJPG");
* </programlisting>
* </informalexample>
*/
#define GST_STR_FOURCC(f) (guint32)(((f)[0])|((f)[1]<<8)|((f)[2]<<16)|((f)[3]<<24))
/**
* GST_FOURCC_FORMAT:
*
* Can be used together with #GST_FOURCC_ARGS to properly output a
* #guint32 fourcc value in a printf()-style text message.
* <informalexample>
* <programlisting>
* printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
* </programlisting>
* </informalexample>
*/
#define GST_FOURCC_FORMAT "%c%c%c%c"
/**
* GST_FOURCC_ARGS:
* @fourcc: a #guint32 fourcc value to output
*
* Can be used together with #GST_FOURCC_FORMAT to properly output a
* #guint32 fourcc value in a printf()-style text message.
*/
#define GST_FOURCC_ARGS(fourcc) \
((gchar) ((fourcc) &0xff)), \
((gchar) (((fourcc)>>8 )&0xff)), \
((gchar) (((fourcc)>>16)&0xff)), \
((gchar) (((fourcc)>>24)&0xff))
/**
* GST_VALUE_HOLDS_FOURCC:
*
* Checks if the given #GValue contains a #GST_TYPE_FOURCC value.
*
* @x: the #GValue to check
*/
#define GST_VALUE_HOLDS_FOURCC(x) (G_VALUE_HOLDS(x, gst_type_fourcc))
/**
* GST_VALUE_HOLDS_INT_RANGE:
*
* Checks if the given #GValue contains a #GST_TYPE_INT_RANGE value.
*
* @x: the #GValue to check
*/
#define GST_VALUE_HOLDS_INT_RANGE(x) (G_VALUE_HOLDS(x, gst_type_int_range))
/**
* GST_VALUE_HOLDS_DOUBLE_RANGE:
*
* Checks if the given #GValue contains a #GST_TYPE_DOUBLE_RANGE value.
*
* @x: the #GValue to check
*/
#define GST_VALUE_HOLDS_DOUBLE_RANGE(x) (G_VALUE_HOLDS(x, gst_type_double_range))
#define GST_VALUE_HOLDS_LIST(x) (G_VALUE_HOLDS(x, gst_type_list))
#define GST_VALUE_HOLDS_ARRAY(x) (G_VALUE_HOLDS(x, gst_type_array))
#define GST_VALUE_HOLDS_CAPS(x) (G_VALUE_HOLDS(x, GST_TYPE_CAPS))
#define GST_VALUE_HOLDS_BUFFER(x) (G_VALUE_HOLDS(x, GST_TYPE_BUFFER))
#define GST_VALUE_HOLDS_FRACTION(x) (G_VALUE_HOLDS(x, gst_type_fraction))
#define GST_TYPE_FOURCC gst_type_fourcc
#define GST_TYPE_INT_RANGE gst_type_int_range
#define GST_TYPE_DOUBLE_RANGE gst_type_double_range
/**
* GST_TYPE_LIST:
*
* a #GValue type that represents an unordered list of #GValue values
*
* Returns: the #GType of GstValueList (which is not explicitly typed)
*/
#define GST_TYPE_LIST gst_type_list
/**
* GST_TYPE_ARRAY:
*
* a #GValue type that represents an ordered list of #GValue values
*
* Returns: the #GType of GstArrayList (which is not explicitly typed)
*/
#define GST_TYPE_ARRAY gst_type_array
/**
* GST_TYPE_FRACTION:
*
* a #GValue type that represents a fraction of an integer numerator over
* an integer denominator
*
* Returns: the #GType of GstFraction (which is not explicitly typed)
*/
#define GST_TYPE_FRACTION gst_type_fraction
#define GST_VALUE_LESS_THAN (-1)