mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-06-08 17:19:25 +00:00
Code Issues 1 Projects Releases Wiki Activity

Documentation updates

Browse source 
Original commit message from CVS:
Documentation updates
This commit is contained in:
Wim Taymans 2003-01-02 18:56:09 +00:00
parent 6653167f11
commit 7462cb8787
13 changed files with 253 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/gst/gstreamer-docs.sgml
View file

@ -99,6 +99,8 @@ with some more specialized elements.</para>
&GstElementFactory;
&GstEvent;
&GstFormat;
&GstIndex;
&GstIndexFactory;
&GstInfo;
&GstObject;
&GstPad;
@ -109,15 +111,13 @@ with some more specialized elements.</para>
&GstPluginFeature;
&GstProbe;
&GstProps;
&GstQueue;
&GstQuery;
&GstQueue;
&GstRegistry;
&GstScheduler;
&GstSchedulerFactory;
&GstSystemClock;
&GstThread;
&GstIndex;
&GstIndexFactory;
&GstType;
&GstTypeFactory;
&GstTypeFind;

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

@ -32,14 +32,13 @@ cothread_current
<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>
@ -192,10 +191,13 @@ GstSchedulerFactoryClass
<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>
@ -277,7 +279,6 @@ GstDataFlags
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
@ -810,7 +811,14 @@ gst_object_flags_get_type
<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>

75
docs/gst/tmpl/gstatomic.sgml
View file

@ -2,13 +2,16 @@
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 ##### -->
@ -22,74 +25,68 @@ A structure that contains an integer that can be modified
atomically.
</para>
@lock:
<!-- ##### MACRO GST_ATOMIC_INT_INIT ##### -->
<!-- ##### FUNCTION gst_atomic_int_init ##### -->
<para>
Initialize an atomic int
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
@val: The initial value for the integer
@aint: a #GstAtomicInt
@val: a new value
<!-- ##### MACRO GST_ATOMIC_INT_FREE ##### -->
<!-- ##### FUNCTION gst_atomic_int_destroy ##### -->
<para>
Free the memory allocated by #GST_ATOMIC_INT_INIT
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
@aint: a #GstAtomicInt
<!-- ##### MACRO GST_ATOMIC_INT_SET ##### -->
<!-- ##### FUNCTION gst_atomic_int_set ##### -->
<para>
Set the value of a #GstAtomicInt atomically
Atomically set the value on the #GstAtomicInt.
</para>
@ref: a reference to a #GstAtomicInt
@val: The value for the integer
@aint: a #GstAtomicInt
@val: The new value
<!-- ##### MACRO GST_ATOMIC_INT_VALUE ##### -->
<!-- ##### FUNCTION gst_atomic_int_read ##### -->
<para>
Get the value of a #GstAtomicInt atomically
Atomically read the contents of a #GstAtomicInt
</para>
@ref: a reference to a #GstAtomicInt
@aint: a #GstAtomicInt
@Returns: the value of the atomic int
<!-- ##### MACRO GST_ATOMIC_INT_READ ##### -->
<!-- ##### FUNCTION gst_atomic_int_add ##### -->
<para>
Get the value of a #GstAtomicInt atomically into a variable
Atomically add the given value to the #GstAtomicInt.
</para>
@ref: a reference to a #GstAtomicInt
@res: a pointer to a gint to hold the value
@aint: a #GstAtomicInt
@val: the value to add
<!-- ##### MACRO GST_ATOMIC_INT_INC ##### -->
<!-- ##### FUNCTION gst_atomic_int_inc ##### -->
<para>
Increment the value of a #GstAtomicInt atomically
Atomically increment the #GstAtomicInt
</para>
@ref: a reference to a #GstAtomicInt
@aint: a #GstAtomicInt
<!-- ##### MACRO GST_ATOMIC_INT_DEC_AND_TEST ##### -->
<!-- ##### FUNCTION gst_atomic_int_dec_and_test ##### -->
<para>
Decrement the value of a #GstAtomicInt atomically and test
for zero.
Atomically decrement the #GstAtomicInt and test if it is 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_ADD ##### -->
<para>
Atomically add a value to a #GstAtomicInt
</para>
@ref: a reference to a #GstAtomicInt
@count: The value to add
@aint: a #GstAtomicInt
@Returns: TRUE if the atomic int is 0

9
docs/gst/tmpl/gstbin.sgml
View file

@ -34,7 +34,10 @@ After the bin has been set to the PLAYING state (with gst_element_set_state()),
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.
@ -225,7 +228,7 @@ Free the memory allocated by this bin
</para>
@gstbin: the object which received the signal.
@arg1:
@arg1: the element that was added to the bin
<!-- ##### SIGNAL GstBin::element-removed ##### -->
<para>
@ -233,5 +236,5 @@ Free the memory allocated by this bin
</para>
@gstbin: the object which received the signal.
@arg1:
@arg1: the element that was removed from the bin

9
docs/gst/tmpl/gstdata.sgml
View file

@ -137,15 +137,6 @@ Get the current refcount value
@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

2
docs/gst/tmpl/gstevent.sgml
View file

@ -382,7 +382,7 @@ Create a new flush event.
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

27
docs/gst/tmpl/gstformat.sgml
View file

@ -12,7 +12,7 @@ formats can be used to perform seeking or conversions/query operations.
<!-- ##### SECTION See_Also ##### -->
<para>
#GstPad, #GstElement
</para>
<!-- ##### ENUM GstFormat ##### -->
@ -29,6 +29,21 @@ Standard predefined formats
@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
@ -68,6 +83,16 @@ of formats.
@Returns:
<!-- ##### FUNCTION gst_formats_contains ##### -->
<para>
</para>
@formats:
@format:
@Returns:
<!-- ##### FUNCTION gst_format_get_details ##### -->
<para>

9
docs/gst/tmpl/gstindex.sgml
View file

@ -12,7 +12,7 @@ in a pipeline.
<!-- ##### SECTION See_Also ##### -->
<para>
#GstIndexFactory
</para>
<!-- ##### STRUCT GstIndexEntry ##### -->
@ -108,9 +108,10 @@ An association in an entry.
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>

2
docs/gst/tmpl/gstpad.sgml
View file

@ -374,7 +374,7 @@ Flags for the pad.
</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 ##### -->

78
docs/gst/tmpl/gstquery.sgml
View file

@ -20,14 +20,30 @@ Query types can be used to perform queries on pads and elements.
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>
@ -39,3 +55,49 @@ Convenience function to define a function that returns an array of query types.
@...: 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:

70
docs/gst/tmpl/gstreamer-unused.sgml
View file

@ -1443,6 +1443,68 @@ g_print messages.
@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>
@ -1735,6 +1797,14 @@ A flag indicating that SSE instructions are supported.
</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>

10
docs/gst/tmpl/gstxml.sgml
View file

@ -110,6 +110,10 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
</para>
@:
@:
@:
@gstxml: the object which received the signal.
@arg1:
@arg2:
@ -119,7 +123,7 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
</para>
@:
@:
@:
@gstxml: the object which received the signal.
@arg1:
@arg2:

22
gst/gstquery.c
View file

@ -124,25 +124,25 @@ gst_query_type_get_by_nick (const gchar *nick)
}
/**
* 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;
}
@ -150,16 +150,16 @@ gst_queries_contains (const GstQueryType *queries, GstQueryType query)
/**
* 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));
}
/**