<!-- ##### SECTION Stability_Level ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
+
+
+@x:
+
+
<!-- ##### 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>
-@a: the first component
-@b: the second component
-@c: the third component
-@d: the fourth component
+
+@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 ##### -->
+
+
+
+
+<!-- ##### 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>
-<!-- ##### MACRO GST_FOURCC_ARGS ##### -->
+<!-- ##### FUNCTION gst_value_set_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
+@value:
+@fourcc:
-<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
+<!-- ##### FUNCTION gst_value_get_fourcc ##### -->
<para>
-Checks if the give GValue contains a FOURCC value.
+
</para>
-@x: the #GValue to check
+@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
-<!-- ##### MACRO GST_VALUE_HOLDS_DOUBLE_RANGE ##### -->
+<!-- ##### FUNCTION gst_value_set_int_range ##### -->
<para>
-Checks if the give GValue contains a DOUBLE_RANGE value.
+
</para>
-@x: the #GValue to check
+@value:
+@start:
+@end:
-<!-- ##### MACRO GST_VALUE_HOLDS_LIST ##### -->
+<!-- ##### FUNCTION gst_value_get_int_range_min ##### -->
<para>
-Checks if the give GValue contains a LIST value.
+
</para>
-@x: the #GValue to check
+@value:
+@Returns:
-<!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
+<!-- ##### FUNCTION gst_value_get_int_range_max ##### -->
<para>
-Checks if the give GValue contains a CAPS value.
+
</para>
-@x: the #GValue to check
+@value:
+@Returns:
-<!-- ##### MACRO GST_VALUE_HOLDS_FRACTION ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_DOUBLE_RANGE ##### -->
+
+
+@x:
+
+
+<!-- ##### MACRO GST_TYPE_DOUBLE_RANGE ##### -->
<para>
-Checks if the give GValue contains a FRACTION value.
+
</para>
-@x: the #GValue to check
-<!-- ##### MACRO GST_VALUE_HOLDS_ARRAY ##### -->
+<!-- ##### FUNCTION gst_value_set_double_range ##### -->
<para>
</para>
-@x:
+@value:
+@start:
+@end:
-<!-- ##### MACRO GST_VALUE_HOLDS_MINI_OBJECT ##### -->
+<!-- ##### FUNCTION gst_value_get_double_range_min ##### -->
<para>
</para>
@value:
+@Returns:
-<!-- ##### MACRO GST_VALUE_LESS_THAN ##### -->
+<!-- ##### FUNCTION gst_value_get_double_range_max ##### -->
<para>
-Indicates that the first value provided to a comparison function
-(gst_value_compare()) is lesser than the second one.
+
</para>
+@value:
+@Returns:
-<!-- ##### MACRO GST_VALUE_EQUAL ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_LIST ##### -->
<para>
-Indicates that the first value provided to a comparison function
-(gst_value_compare()) is equal to the second one.
+Checks if the give GValue contains a LIST value.
</para>
+@x: the #GValue to check
-<!-- ##### MACRO GST_VALUE_GREATER_THAN ##### -->
+<!-- ##### MACRO GST_TYPE_LIST ##### -->
<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 ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_ARRAY ##### -->
<para>
-Indicates that the comparison function (gst_value_compare()) can not
-determine a order for the two provided values.
+
</para>
+@x:
-<!-- ##### USER_FUNCTION GstValueCompareFunc ##### -->
+<!-- ##### MACRO GST_TYPE_ARRAY ##### -->
<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 ##### -->
+<!-- ##### FUNCTION gst_value_list_append_value ##### -->
<para>
</para>
-@value1:
-@Returns:
+@value:
+@append_value:
-<!-- ##### USER_FUNCTION GstValueDeserializeFunc ##### -->
+<!-- ##### FUNCTION gst_value_list_prepend_value ##### -->
<para>
</para>
-@dest:
-@s:
-@Returns:
+@value:
+@prepend_value:
-<!-- ##### USER_FUNCTION GstValueUnionFunc ##### -->
+<!-- ##### FUNCTION gst_value_list_concat ##### -->
<para>
</para>
@dest:
@value1:
@value2:
-@Returns:
-<!-- ##### USER_FUNCTION GstValueIntersectFunc ##### -->
+<!-- ##### FUNCTION gst_value_list_get_size ##### -->
<para>
</para>
-@dest:
-@value1:
-@value2:
+@value:
@Returns:
-<!-- ##### USER_FUNCTION GstValueSubtractFunc ##### -->
+<!-- ##### FUNCTION gst_value_list_get_value ##### -->
<para>
</para>
-@dest:
-@minuend:
-@subtrahend:
+@value:
+@index:
@Returns:
-<!-- ##### STRUCT GstValueTable ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_FRACTION ##### -->
<para>
-
+Checks if the give GValue contains a FRACTION value.
</para>
-@type:
-@compare:
-@serialize:
-@deserialize:
+@x: the #GValue to check
-<!-- ##### FUNCTION gst_value_is_fixed ##### -->
+
+<!-- ##### MACRO GST_TYPE_FRACTION ##### -->
<para>
</para>
-@value:
-@Returns:
-<!-- ##### FUNCTION gst_value_register ##### -->
+<!-- ##### FUNCTION gst_value_set_fraction ##### -->
<para>
</para>
-@table:
+@value:
+@numerator:
+@denominator:
-<!-- ##### FUNCTION gst_value_init_and_copy ##### -->
+<!-- ##### FUNCTION gst_value_get_fraction_numerator ##### -->
<para>
</para>
-@dest:
-@src:
+@value:
+@Returns:
-<!-- ##### FUNCTION gst_value_serialize ##### -->
+<!-- ##### FUNCTION gst_value_get_fraction_denominator ##### -->
<para>
</para>
@Returns:
-<!-- ##### FUNCTION gst_value_deserialize ##### -->
+<!-- ##### FUNCTION gst_value_fraction_multiply ##### -->
<para>
</para>
-@dest:
-@src:
+@product:
+@factor1:
+@factor2:
@Returns:
-<!-- ##### FUNCTION gst_value_list_append_value ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
<para>
-
+Checks if the give GValue contains a CAPS value.
</para>
-@value:
-@append_value:
+@x: the #GValue to check
-<!-- ##### FUNCTION gst_value_list_prepend_value ##### -->
+<!-- ##### FUNCTION gst_value_set_caps ##### -->
<para>
</para>
@value:
-@prepend_value:
+@caps:
+<!-- # Unused Parameters # -->
+@calue:
-<!-- ##### FUNCTION gst_value_list_concat ##### -->
+<!-- ##### FUNCTION gst_value_get_caps ##### -->
<para>
</para>
-@dest:
-@value1:
-@value2:
+@value:
+@Returns:
-<!-- ##### FUNCTION gst_value_list_get_size ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_MINI_OBJECT ##### -->
<para>
</para>
@value:
-@Returns:
-<!-- ##### FUNCTION gst_value_list_get_value ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_BUFFER ##### -->
<para>
</para>
-@value:
-@index:
-@Returns:
+@x:
-<!-- ##### FUNCTION gst_value_set_fourcc ##### -->
+<!-- ##### MACRO gst_value_get_buffer ##### -->
<para>
</para>
-@value:
-@fourcc:
+@v:
-<!-- ##### FUNCTION gst_value_get_fourcc ##### -->
+<!-- ##### MACRO gst_value_set_buffer ##### -->
<para>
</para>
-@value:
-@Returns:
+@v:
+@b:
-<!-- ##### FUNCTION gst_value_set_int_range ##### -->
+<!-- ##### MACRO gst_value_take_buffer ##### -->
<para>
</para>
-@value:
-@start:
-@end:
+@v:
+@b:
-<!-- ##### FUNCTION gst_value_get_int_range_min ##### -->
+<!-- ##### 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>
-@value:
-@Returns:
-<!-- ##### FUNCTION gst_value_get_int_range_max ##### -->
+<!-- ##### 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>
-@value:
-@Returns:
-<!-- ##### FUNCTION gst_value_set_double_range ##### -->
+<!-- ##### USER_FUNCTION GstValueCompareFunc ##### -->
<para>
</para>
-@value:
-@start:
-@end:
+@value1:
+@value2:
+@Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL,
+GST_VALUE_GREATER_THAN or GST_VALUE_UNORDERED
-<!-- ##### FUNCTION gst_value_get_double_range_min ##### -->
+<!-- ##### USER_FUNCTION GstValueSerializeFunc ##### -->
<para>
</para>
-@value:
+@value1:
@Returns:
-<!-- ##### FUNCTION gst_value_get_double_range_max ##### -->
+<!-- ##### USER_FUNCTION GstValueDeserializeFunc ##### -->
<para>
</para>
-@value:
+@dest:
+@s:
@Returns:
-<!-- ##### FUNCTION gst_value_get_caps ##### -->
+<!-- ##### USER_FUNCTION GstValueUnionFunc ##### -->
<para>
</para>
-@value:
+@dest:
+@value1:
+@value2:
@Returns:
-<!-- ##### FUNCTION gst_value_set_caps ##### -->
+<!-- ##### USER_FUNCTION GstValueIntersectFunc ##### -->
<para>
</para>
-@value:
-@caps:
-<!-- # Unused Parameters # -->
-@calue:
+@dest:
+@value1:
+@value2:
+@Returns:
-<!-- ##### FUNCTION gst_value_get_fraction_numerator ##### -->
+<!-- ##### USER_FUNCTION GstValueSubtractFunc ##### -->
<para>
</para>
-@value:
+@dest:
+@minuend:
+@subtrahend:
@Returns:
-<!-- ##### FUNCTION gst_value_get_fraction_denominator ##### -->
+<!-- ##### STRUCT GstValueTable ##### -->
<para>
</para>
-@value:
-@Returns:
-
+@type:
+@compare:
+@serialize:
+@deserialize:
-<!-- ##### FUNCTION gst_value_set_fraction ##### -->
+<!-- ##### FUNCTION gst_value_is_fixed ##### -->
<para>
</para>
@value:
-@numerator:
-@denominator:
+@Returns:
-<!-- ##### MACRO gst_value_get_buffer ##### -->
+<!-- ##### FUNCTION gst_value_register ##### -->
<para>
</para>
-@v:
+@table:
-<!-- ##### MACRO gst_value_set_buffer ##### -->
+<!-- ##### FUNCTION gst_value_init_and_copy ##### -->
<para>
</para>
-@v:
-@b:
+@dest:
+@src:
-<!-- ##### MACRO gst_value_take_buffer ##### -->
+<!-- ##### FUNCTION gst_value_serialize ##### -->
<para>
</para>
-@v:
-@b:
+@value:
+@Returns:
-<!-- ##### FUNCTION gst_value_fraction_multiply ##### -->
+<!-- ##### FUNCTION gst_value_deserialize ##### -->
<para>
</para>
-@product:
-@factor1:
-@factor2:
+@dest:
+@src:
@Returns:
/**
* 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.
*
/**
* 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
/**
* 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.
*/
/**
* 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)
/**
* 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
*
/**
* 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.
*
/**
* 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.
*
/**
* 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.
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);
}
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)
projects / platform / upstream / gstreamer.git / commitdiff