&GstElementFactory;
&GstEvent;
&GstFormat;
+ &GstIndex;
+ &GstIndexFactory;
&GstInfo;
&GstObject;
&GstPad;
&GstPluginFeature;
&GstProbe;
&GstProps;
- &GstQueue;
&GstQuery;
+ &GstQueue;
&GstRegistry;
&GstScheduler;
&GstSchedulerFactory;
&GstSystemClock;
&GstThread;
- &GstIndex;
- &GstIndexFactory;
&GstType;
&GstTypeFactory;
&GstTypeFind;
<SECTION>
<FILE>gstatomic</FILE>
GstAtomicInt
-GST_ATOMIC_INT_INIT
-GST_ATOMIC_INT_FREE
-GST_ATOMIC_INT_SET
-GST_ATOMIC_INT_VALUE
-GST_ATOMIC_INT_READ
-GST_ATOMIC_INT_INC
-GST_ATOMIC_INT_DEC_AND_TEST
-GST_ATOMIC_INT_ADD
+gst_atomic_int_init
+gst_atomic_int_destroy
+gst_atomic_int_set
+gst_atomic_int_read
+gst_atomic_int_add
+gst_atomic_int_inc
+gst_atomic_int_dec_and_test
<SUBSECTION Standard>
</SECTION>
<FILE>gstformat</FILE>
<TITLE>GstFormat</TITLE>
GstFormat
+GST_FORMAT_PERCENT_MAX
+GST_FORMAT_PERCENT_SCALE
GstFormatDefinition
GST_FORMATS_FUNCTION
gst_format_register
gst_format_get_by_nick
+gst_formats_contains
gst_format_get_details
gst_format_get_definitions
<SUBSECTION Standard>
GST_DATA_IS_READONLY
GST_DATA_REFCOUNT
GST_DATA_REFCOUNT_VALUE
-GST_DATA_REFCOUNT_READ
GST_DATA_COPY_FUNC
GST_DATA_FREE_FUNC
gst_data_init
<SECTION>
<FILE>gstquery</FILE>
GstQueryType
+GST_QUERY_TYPE_RATE_DEN
+GstQueryTypeDefinition
GST_QUERY_TYPE_FUNCTION
+gst_query_type_register
+gst_query_type_get_by_nick
+gst_query_types_contains
+gst_query_type_get_details
+gst_query_type_get_definitions
</SECTION>
<SECTION>
GstAtomic
<!-- ##### SECTION Short_Description ##### -->
-Macros that implement atomic operations
+Functions that implement atomic operations.
<!-- ##### SECTION Long_Description ##### -->
<para>
-GstAtomic contains a set of macros that can be used to implement
-atomic algorithms that are thread safe and don't use heavyweight
-locking mechanisms.
+Functions that implement atomic operations on a #GstAtomicInt structure.
+Atomic operations are thread safe and don't use heavyweight locking mechanisms.
+</para>
+<para>
+These functions will be inlined in the GStreamer core but are available to plugins
+as external methods.
</para>
<!-- ##### SECTION See_Also ##### -->
atomically.
</para>
+@lock:
-<!-- ##### MACRO GST_ATOMIC_INT_INIT ##### -->
-<para>
-Initialize an atomic int
-</para>
-
-@ref: a reference to a #GstAtomicInt
-@val: The initial value for the integer
-
-
-<!-- ##### MACRO GST_ATOMIC_INT_FREE ##### -->
+<!-- ##### FUNCTION gst_atomic_int_init ##### -->
<para>
-Free the memory allocated by #GST_ATOMIC_INT_INIT
+Initialize an allocated #GstAtomicInt with a value. Call this method
+only once as it will allocate a mutex in the C-fallback case.
</para>
-@ref: A reference to a #GstAtomicInt
+@aint: a #GstAtomicInt
+@val: a new value
-<!-- ##### MACRO GST_ATOMIC_INT_SET ##### -->
+<!-- ##### FUNCTION gst_atomic_int_destroy ##### -->
<para>
-Set the value of a #GstAtomicInt atomically
+Destroy a #GstAtomicInt. Call this method only once as it will
+free the mutex in the C-fallback case.
</para>
-@ref: a reference to a #GstAtomicInt
-@val: The value for the integer
+@aint: a #GstAtomicInt
-<!-- ##### MACRO GST_ATOMIC_INT_VALUE ##### -->
+<!-- ##### FUNCTION gst_atomic_int_set ##### -->
<para>
-Get the value of a #GstAtomicInt atomically
+Atomically set the value on the #GstAtomicInt.
</para>
-@ref: a reference to a #GstAtomicInt
+@aint: a #GstAtomicInt
+@val: The new value
-<!-- ##### MACRO GST_ATOMIC_INT_READ ##### -->
+<!-- ##### FUNCTION gst_atomic_int_read ##### -->
<para>
-Get the value of a #GstAtomicInt atomically into a variable
+Atomically read the contents of a #GstAtomicInt
</para>
-@ref: a reference to a #GstAtomicInt
-@res: a pointer to a gint to hold the value
+@aint: a #GstAtomicInt
+@Returns: the value of the atomic int
-<!-- ##### MACRO GST_ATOMIC_INT_INC ##### -->
+<!-- ##### FUNCTION gst_atomic_int_add ##### -->
<para>
-Increment the value of a #GstAtomicInt atomically
+Atomically add the given value to the #GstAtomicInt.
</para>
-@ref: a reference to a #GstAtomicInt
+@aint: a #GstAtomicInt
+@val: the value to add
-<!-- ##### MACRO GST_ATOMIC_INT_DEC_AND_TEST ##### -->
+<!-- ##### FUNCTION gst_atomic_int_inc ##### -->
<para>
-Decrement the value of a #GstAtomicInt atomically and test
-for zero.
+Atomically increment the #GstAtomicInt
</para>
-@ref: a reference to a #GstAtomicInt
-@zero: a gpointer to a gboolean to hold the value of the test
+@aint: a #GstAtomicInt
-<!-- ##### MACRO GST_ATOMIC_INT_ADD ##### -->
+<!-- ##### FUNCTION gst_atomic_int_dec_and_test ##### -->
<para>
-Atomically add a value to a #GstAtomicInt
+Atomically decrement the #GstAtomicInt and test if it is zero.
</para>
-@ref: a reference to a #GstAtomicInt
-@count: The value to add
+@aint: a #GstAtomicInt
+@Returns: TRUE if the atomic int is 0
gst_bin_iterate() is used to process the elements in the bin.
</para>
<para>
-The "object_added" signal is fired whenever a new object is added to the bin.
+The "element_added" signal is fired whenever a new element is added to the bin.
+</para>
+<para>
+The "element_removed" signal is fired whenever an element is removed from the bin.
</para>
<para>
gst_bin_destroy() is used to destroy the bin.
</para>
@gstbin: the object which received the signal.
-@arg1:
+@arg1: the element that was added to the bin
<!-- ##### SIGNAL GstBin::element-removed ##### -->
<para>
</para>
@gstbin: the object which received the signal.
-@arg1:
+@arg1: the element that was removed from the bin
@data: The GstData to query
-<!-- ##### MACRO GST_DATA_REFCOUNT_READ ##### -->
-<para>
-Read the current refcount value into the specified value
-</para>
-
-@data: The GstData to get the refcount value of
-@value: A pointer to a gint to hold the refcount value
-
-
<!-- ##### MACRO GST_DATA_COPY_FUNC ##### -->
<para>
Get access to the copy function of the data
A convenience macro to create event mask functions
</para>
-@type:
+@type: The type of the first argument of the function
@functionname: the name of the function
@...: event masks, the last element is marked with 0
<!-- ##### SECTION See_Also ##### -->
<para>
-
+#GstPad, #GstElement
</para>
<!-- ##### ENUM GstFormat ##### -->
@GST_FORMAT_UNITS: frames for video, samples for audio, other definitions as
defined by the media type.
+<!-- ##### MACRO GST_FORMAT_PERCENT_MAX ##### -->
+<para>
+The PERCENT format is between 0 and this value
+</para>
+
+
+
+<!-- ##### MACRO GST_FORMAT_PERCENT_SCALE ##### -->
+<para>
+The value used to scale down the reported PERCENT format value to
+its real value.
+</para>
+
+
+
<!-- ##### STRUCT GstFormatDefinition ##### -->
<para>
A format definition
@Returns:
+<!-- ##### FUNCTION gst_formats_contains ##### -->
+<para>
+
+</para>
+
+@formats:
+@format:
+@Returns:
+
+
<!-- ##### FUNCTION gst_format_get_details ##### -->
<para>
<!-- ##### SECTION See_Also ##### -->
<para>
-
+#GstIndexFactory
</para>
<!-- ##### STRUCT GstIndexEntry ##### -->
flags for an association entry
</para>
-@GST_ACCOCIATION_FLAG_NONE: no flags
-@GST_ACCOCIATION_FLAG_KEY_UNIT: this entry marks a key unit.
-@GST_ACCOCIATION_FLAG_LAST:
+@GST_ASSOCIATION_FLAG_NONE: no extra flags
+@GST_ASSOCIATION_FLAG_KEY_UNIT: the entry marks a key unit, a key unit is one
+ that marks a place where one can randomly seek to.
+@GST_ASSOCIATION_FLAG_LAST: extra user defined flags should start here.
<!-- ##### MACRO GST_INDEX_FORMAT_FORMAT ##### -->
<para>
</para>
@GST_PAD_DISABLED: the pad is disabled.
-@GST_PAD_EOS: the pad is in end of stream state.
+@GST_PAD_NEGOTIATING:
@GST_PAD_FLAG_LAST: subclasses can use this number to enumerate their flags.
<!-- ##### FUNCTION gst_pad_new ##### -->
Standard predefined Query types
</para>
-@GST_QUERY_NONE:
-@GST_QUERY_TOTAL:
-@GST_QUERY_POSITION:
-@GST_QUERY_LATENCY:
-@GST_QUERY_JITTER:
-@GST_QUERY_START:
-@GST_QUERY_SEGMENT_END:
-@GST_QUERY_RATE:
+@GST_QUERY_NONE: invalid query type
+@GST_QUERY_TOTAL: total length of stream
+@GST_QUERY_POSITION: current position in stream
+@GST_QUERY_LATENCY: latency of stream
+@GST_QUERY_JITTER: current jitter of stream
+@GST_QUERY_START: start of configured segment
+@GST_QUERY_SEGMENT_END: end of configured segment
+@GST_QUERY_RATE: current rate of the stream
+
+<!-- ##### MACRO GST_QUERY_TYPE_RATE_DEN ##### -->
+<para>
+Rates are relative to this value
+</para>
+
+
+
+<!-- ##### STRUCT GstQueryTypeDefinition ##### -->
+<para>
+A Query Type definition
+</para>
+
+@value: the unique id of the Query type
+@nick: a short nick
+@description: a longer description of the query type
<!-- ##### MACRO GST_QUERY_TYPE_FUNCTION ##### -->
<para>
@...: query types, 0 to end the list
+<!-- ##### FUNCTION gst_query_type_register ##### -->
+<para>
+
+</para>
+
+@nick:
+@description:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_query_type_get_by_nick ##### -->
+<para>
+
+</para>
+
+@nick:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_query_types_contains ##### -->
+<para>
+
+</para>
+
+@types:
+@type:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_query_type_get_details ##### -->
+<para>
+
+</para>
+
+@type:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_query_type_get_definitions ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
@klass:
+<!-- ##### MACRO GST_ATOMIC_INT_ADD ##### -->
+<para>
+Atomically add a value to a #GstAtomicInt
+</para>
+
+@ref: a reference to a #GstAtomicInt
+@count: The value to add
+
+<!-- ##### MACRO GST_ATOMIC_INT_DEC_AND_TEST ##### -->
+<para>
+Decrement the value of a #GstAtomicInt atomically and test
+for zero.
+</para>
+
+@ref: a reference to a #GstAtomicInt
+@zero: a gpointer to a gboolean to hold the value of the test
+
+<!-- ##### MACRO GST_ATOMIC_INT_FREE ##### -->
+<para>
+Free the memory allocated by #GST_ATOMIC_INT_INIT
+</para>
+
+@ref: A reference to a #GstAtomicInt
+
+<!-- ##### MACRO GST_ATOMIC_INT_INC ##### -->
+<para>
+Increment the value of a #GstAtomicInt atomically
+</para>
+
+@ref: a reference to a #GstAtomicInt
+
+<!-- ##### MACRO GST_ATOMIC_INT_INIT ##### -->
+<para>
+Initialize an atomic int
+</para>
+
+@ref: a reference to a #GstAtomicInt
+@val: The initial value for the integer
+
+<!-- ##### MACRO GST_ATOMIC_INT_READ ##### -->
+<para>
+Get the value of a #GstAtomicInt atomically into a variable
+</para>
+
+@ref: a reference to a #GstAtomicInt
+@res: a pointer to a gint to hold the value
+
+<!-- ##### MACRO GST_ATOMIC_INT_SET ##### -->
+<para>
+Set the value of a #GstAtomicInt atomically
+</para>
+
+@ref: a reference to a #GstAtomicInt
+@val: The value for the integer
+
+<!-- ##### MACRO GST_ATOMIC_INT_VALUE ##### -->
+<para>
+Get the value of a #GstAtomicInt atomically
+</para>
+
+@ref: a reference to a #GstAtomicInt
+
<!-- ##### MACRO GST_ATOMIC_LOCK ##### -->
<para>
</para>
+<!-- ##### MACRO GST_DATA_REFCOUNT_READ ##### -->
+<para>
+Read the current refcount value into the specified value
+</para>
+
+@data: The GstData to get the refcount value of
+@value: A pointer to a gint to hold the refcount value
+
<!-- ##### MACRO GST_DEBUG_CHAR_MODE ##### -->
<para>
</para>
+@:
+@:
+@:
+
@gstxml: the object which received the signal.
@arg1:
@arg2:
</para>
-@:
-@:
-@:
+@gstxml: the object which received the signal.
+@arg1:
+@arg2:
}
/**
- * gst_queries_contains:
- * @queries: The query array to search
- * @query: the query to find
+ * gst_query_types_contains:
+ * @types: The query array to search
+ * @type: the querytype to find
*
* See if the given query is inside the query array.
*
* Returns: TRUE if the query is found inside the array
*/
gboolean
-gst_queries_contains (const GstQueryType *queries, GstQueryType query)
+gst_query_types_contains (const GstQueryType *types, GstQueryType type)
{
- if (!queries)
+ if (!types)
return FALSE;
- while (*queries) {
- if (*queries == query)
+ while (*types) {
+ if (*types == type)
return TRUE;
- queries++;
+ types++;
}
return FALSE;
}
/**
* gst_query_type_get_details:
- * @query: The query to get details of
+ * @type: The query to get details of
*
* Get details about the given query.
*
* Returns: The #GstQueryTypeDefinition for @query or NULL on failure.
*/
const GstQueryTypeDefinition*
-gst_query_type_get_details (GstQueryType query)
+gst_query_type_get_details (GstQueryType type)
{
- return g_hash_table_lookup (_query_type_to_nick, GINT_TO_POINTER (query));
+ return g_hash_table_lookup (_query_type_to_nick, GINT_TO_POINTER (type));
}
/**