Commit 1ac72387 authored by Wim Taymans's avatar Wim Taymans

Documentation updates

Original commit message from CVS:
Documentation updates
parent 8c546609
......@@ -3,7 +3,7 @@
<!entity Gst SYSTEM "sgml/gst.sgml">
<!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml">
<!entity GstAutoplugFactory SYSTEM "sgml/gstautoplugfactory.sgml">
<!entity GstInfo SYSTEM "sgml/gstinfo.sgml">
<!entity GstAtomic SYSTEM "sgml/gstatomic.sgml">
<!entity GstBin SYSTEM "sgml/gstbin.sgml">
<!entity GstData SYSTEM "sgml/gstdata.sgml">
<!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
......@@ -13,7 +13,9 @@
<!entity GstElement SYSTEM "sgml/gstelement.sgml">
<!entity GstElementFactory SYSTEM "sgml/gstelementfactory.sgml">
<!entity GstFormat SYSTEM "sgml/gstformat.sgml">
<!entity GstInfo SYSTEM "sgml/gstinfo.sgml">
<!entity GstLog SYSTEM "sgml/gstlog.sgml">
<!entity GstMemChunk SYSTEM "sgml/gstmemchunk.sgml">
<!entity GstObject SYSTEM "sgml/gstobject.sgml">
<!entity GstPad SYSTEM "sgml/gstpad.sgml">
<!entity GstPadTemplate SYSTEM "sgml/gstpadtemplate.sgml">
......@@ -64,6 +66,16 @@
<bookinfo>
<title>GStreamer Core Reference Manual</title>
</bookinfo>
<chapter id="gstreamer-support">
<title>GStreamer Core Support</title>
<para>
</para>
&cothreads;
&GstAtomic;
&GstMemChunk;
</chapter>
<chapter id="gstreamer">
<title>GStreamer Core Library</title>
......
......@@ -29,6 +29,37 @@ cothread_current
<SUBSECTION Standard>
</SECTION>
<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
GstAtomicSwap
GST_ATOMIC_SWAP_VALUE
GST_ATOMIC_SWAP_INIT
GST_ATOMIC_SWAP
GST_ATOMIC_SWAP_GET
<SUBSECTION Standard>
GST_ATOMIC_LOCK
</SECTION>
<SECTION>
<FILE>gstmemchunk</FILE>
GstMemChunk
GstMemChunkElement
gst_mem_chunk_new
gst_mem_chunk_destroy
gst_mem_chunk_alloc
gst_mem_chunk_alloc0
gst_mem_chunk_free
</SECTION>
<SECTION>
<FILE>gst</FILE>
<TITLE>Gst</TITLE>
......
......@@ -12,13 +12,12 @@ subtasks. They're based on setjmp()/longjmp() in their current form.
<para>
Cothreads are used for loop-based elements that pull data instead
of being fed with data. They can also be used to pull a specific region
of data out of their src element.
of being fed with data. Cothreads are usually used by a #GstScheduler.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstScheduler
</para>
<!-- ##### MACRO CURRENT_STACK_FRAME ##### -->
......@@ -99,8 +98,10 @@ Indicates the cothread is destroyed.
</para>
@thread:
@cothread:
@Returns:
<!-- # Unused Parameters # -->
@thread:
<!-- ##### FUNCTION cothread_set_private ##### -->
......@@ -108,8 +109,10 @@ Indicates the cothread is destroyed.
</para>
@thread:
@cothread:
@data:
<!-- # Unused Parameters # -->
@thread:
<!-- ##### FUNCTION cothread_create ##### -->
......@@ -126,6 +129,8 @@ Indicates the cothread is destroyed.
</para>
@cothread:
<!-- # Unused Parameters # -->
@thread:
......@@ -134,10 +139,12 @@ Indicates the cothread is destroyed.
</para>
@thread:
@cothread:
@func:
@argc:
@argv:
<!-- # Unused Parameters # -->
@thread:
<!-- ##### FUNCTION cothread_stop ##### -->
......@@ -145,6 +152,8 @@ Indicates the cothread is destroyed.
</para>
@cothread:
<!-- # Unused Parameters # -->
@thread:
......@@ -153,6 +162,8 @@ Indicates the cothread is destroyed.
</para>
@cothread:
<!-- # Unused Parameters # -->
@thread:
......@@ -161,9 +172,11 @@ Indicates the cothread is destroyed.
</para>
@thread:
@cothread:
@key:
@Returns:
<!-- # Unused Parameters # -->
@thread:
<!-- ##### FUNCTION cothread_context_set_data ##### -->
......@@ -171,9 +184,11 @@ Indicates the cothread is destroyed.
</para>
@thread:
@cothread:
@key:
@data:
<!-- # Unused Parameters # -->
@thread:
<!-- ##### FUNCTION cothread_lock ##### -->
......@@ -181,6 +196,8 @@ Indicates the cothread is destroyed.
</para>
@cothread:
<!-- # Unused Parameters # -->
@thread:
......@@ -189,8 +206,10 @@ Indicates the cothread is destroyed.
</para>
@thread:
@cothread:
@Returns:
<!-- # Unused Parameters # -->
@thread:
<!-- ##### FUNCTION cothread_unlock ##### -->
......@@ -198,6 +217,8 @@ Indicates the cothread is destroyed.
</para>
@cothread:
<!-- # Unused Parameters # -->
@thread:
......
<!-- ##### SECTION Title ##### -->
GstAtomic
<!-- ##### SECTION Short_Description ##### -->
Macros 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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstMemChunk
</para>
<!-- ##### STRUCT GstAtomicInt ##### -->
<para>
A structure that contains an integer that can be modified
atomically.
</para>
<!-- ##### 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 ##### -->
<para>
Free the memory allocated by #GST_ATOMIC_INT_INIT
</para>
@ref: A reference to a #GstAtomicInt
<!-- ##### 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_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_INC ##### -->
<para>
Increment the value of a #GstAtomicInt atomically
</para>
@ref: a reference to a #GstAtomicInt
<!-- ##### 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_ADD ##### -->
<para>
Atomically add a value to a #GstAtomicInt
</para>
@ref: a reference to a #GstAtomicInt
@count: The value to add
<!-- ##### STRUCT GstAtomicSwap ##### -->
<para>
The structure to handle values that can be swapped atomically
</para>
@lock:
<!-- ##### MACRO GST_ATOMIC_SWAP_VALUE ##### -->
<para>
Get the value of a #GstAtomicSwap
</para>
@swap: a reference to a #GstAtomicSwap
<!-- ##### MACRO GST_ATOMIC_SWAP_INIT ##### -->
<para>
Initialize an atomic swap structure
</para>
@swap: a reference to a #GstAtomicSwap
@val: the initial value
<!-- ##### MACRO GST_ATOMIC_SWAP ##### -->
<para>
Atomically swap the value of the #GstAtomicSwap with a new value
</para>
@swap: a reference to a #GstAtomicSwap
@val: the new value
<!-- ##### MACRO GST_ATOMIC_SWAP_GET ##### -->
<para>
Atomically swap the value of the #GstAtomicSwap with a new value and
get the old value.
</para>
@swap: a reference to a #GstAtomicSwap
@val: the new value
@res: the old value
<!-- ##### SECTION Title ##### -->
GstMemChunk
<!-- ##### SECTION Short_Description ##### -->
Atomic chunk allocator
<!-- ##### SECTION Long_Description ##### -->
<para>
GstMemChunk is an atomic chunk allocator. It uses atomic operations
to allocate fixed size memory regions and is therefore thread safe
without the overhead of mutexes or other heavyweight locking mechanisms.
</para>
<para>
The GstMemChunk is used to allocate critical resources for #GstBuffer and
#GstEvent.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstAtomic, #GstBuffer, #GstEvent, #GstData
</para>
<!-- ##### STRUCT GstMemChunk ##### -->
<para>
The memchunk structure
</para>
@swap:
@name:
@area_size:
@chunk_size:
@atom_size:
@cleanup:
@lock:
<!-- ##### STRUCT GstMemChunkElement ##### -->
<para>
An entry in the memchunk area
</para>
@link:
@area:
<!-- ##### FUNCTION gst_mem_chunk_new ##### -->
<para>
</para>
@name:
@atom_size:
@area_size:
@type:
@Returns:
<!-- ##### FUNCTION gst_mem_chunk_destroy ##### -->
<para>
</para>
@mem_chunk:
<!-- ##### FUNCTION gst_mem_chunk_alloc ##### -->
<para>
</para>
@mem_chunk:
@Returns:
<!-- ##### FUNCTION gst_mem_chunk_alloc0 ##### -->
<para>
</para>
@mem_chunk:
@Returns:
<!-- ##### FUNCTION gst_mem_chunk_free ##### -->
<para>
</para>
@mem_chunk:
@mem:
......@@ -156,26 +156,6 @@ the offset.
GstAsyncDiskSrc
<!-- ##### SECTION ./tmpl/gstatomic.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstatomic.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstatomic.sgml:Short_Description ##### -->
<!-- ##### SECTION ./tmpl/gstatomic.sgml:Title ##### -->
gstatomic
<!-- ##### SECTION ./tmpl/gstaudiosink.sgml:Long_Description ##### -->
<para>
......@@ -725,26 +705,6 @@ gstmarshal
GstMD5Sink
<!-- ##### SECTION ./tmpl/gstmemchunk.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstmemchunk.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstmemchunk.sgml:Short_Description ##### -->
<!-- ##### SECTION ./tmpl/gstmemchunk.sgml:Title ##### -->
gstmemchunk
<!-- ##### SECTION ./tmpl/gstmeta.sgml:Long_Description ##### -->
<para>
The point of the metadata is to provide some context for each buffer. In
......@@ -1483,105 +1443,12 @@ g_print messages.
@klass:
<!-- ##### MACRO GST_ATOMIC_INT_ADD ##### -->
<para>
</para>
@ref:
@count:
<!-- ##### MACRO GST_ATOMIC_INT_DEC_AND_TEST ##### -->
<para>
</para>
@ref:
@zero:
<!-- ##### MACRO GST_ATOMIC_INT_FREE ##### -->
<para>
</para>
@ref:
<!-- ##### MACRO GST_ATOMIC_INT_INC ##### -->
<para>
</para>
@ref:
<!-- ##### MACRO GST_ATOMIC_INT_INIT ##### -->
<para>
</para>
@ref:
@val:
<!-- ##### MACRO GST_ATOMIC_INT_READ ##### -->
<para>
</para>
@ref:
@res:
<!-- ##### MACRO GST_ATOMIC_INT_SET ##### -->
<para>
</para>
@ref:
@val:
<!-- ##### MACRO GST_ATOMIC_INT_VALUE ##### -->
<para>
</para>
@ref:
<!-- ##### MACRO GST_ATOMIC_LOCK ##### -->
<para>
</para>
<!-- ##### MACRO GST_ATOMIC_SWAP ##### -->
<para>
</para>
@swap:
@val:
<!-- ##### MACRO GST_ATOMIC_SWAP_GET ##### -->
<para>
</para>
@swap:
@val:
@res:
<!-- ##### MACRO GST_ATOMIC_SWAP_INIT ##### -->
<para>
</para>
@swap:
@val:
<!-- ##### MACRO GST_ATOMIC_SWAP_VALUE ##### -->
<para>
</para>
@swap:
<!-- ##### MACRO GST_AUDIOSINK ##### -->
<para>
......@@ -4160,19 +4027,6 @@ Specify the current offset in the file.
@GST_ASYNCDISKSRC_OPEN:
@GST_ASYNCDISKSRC_FLAG_LAST:
<!-- ##### STRUCT GstAtomicInt ##### -->
<para>
</para>
<!-- ##### STRUCT GstAtomicSwap ##### -->
<para>
</para>
@lock:
<!-- ##### STRUCT GstAudioSink ##### -->
<para>
......@@ -5046,27 +4900,6 @@ Specify the location of the file. The location must be a fully qualified URL.
</para>
<!-- ##### STRUCT GstMemChunk ##### -->
<para>
</para>
@swap:
@name:
@area_size:
@chunk_size:
@atom_size:
@cleanup:
@lock:
<!-- ##### STRUCT GstMemChunkElement ##### -->
<para>
</para>
@link:
@area:
<!-- ##### STRUCT GstMeta ##### -->
<para>
......@@ -8573,48 +8406,6 @@ must be defined to activate the tracing functionality.
@factory:
@Returns:
<!-- ##### FUNCTION gst_mem_chunk_alloc ##### -->
<para>
</para>
@mem_chunk:
@Returns:
<!-- ##### FUNCTION gst_mem_chunk_alloc0 ##### -->
<para>
</para>