From 1ac723870eb8979085180c71dcce17525fe6251a Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Sat, 14 Dec 2002 16:22:01 +0000 Subject: [PATCH] Documentation updates Original commit message from CVS: Documentation updates --- docs/gst/gstreamer-docs.sgml | 14 ++- docs/gst/gstreamer-sections.txt | 31 ++++++ docs/gst/tmpl/cothreads.sgml | 39 +++++-- docs/gst/tmpl/gstatomic.sgml | 139 ++++++++++++++++++++++++ docs/gst/tmpl/gstmemchunk.sgml | 91 ++++++++++++++++ docs/gst/tmpl/gstreamer-unused.sgml | 209 ------------------------------------ 6 files changed, 304 insertions(+), 219 deletions(-) create mode 100644 docs/gst/tmpl/gstatomic.sgml create mode 100644 docs/gst/tmpl/gstmemchunk.sgml diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 5f02fbf..8a98d92 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -3,7 +3,7 @@ - + @@ -13,7 +13,9 @@ + + @@ -64,6 +66,16 @@ GStreamer Core Reference Manual + + GStreamer Core Support + + + + &cothreads; + &GstAtomic; + &GstMemChunk; + + GStreamer Core Library diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index c070aed..a1858af 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -30,6 +30,37 @@ cothread_current
+gstatomic +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 + +GST_ATOMIC_LOCK +
+ +
+gstmemchunk +GstMemChunk +GstMemChunkElement +gst_mem_chunk_new +gst_mem_chunk_destroy +gst_mem_chunk_alloc +gst_mem_chunk_alloc0 +gst_mem_chunk_free +
+ +
gst Gst gst_init diff --git a/docs/gst/tmpl/cothreads.sgml b/docs/gst/tmpl/cothreads.sgml index b847f86..cb9988e 100644 --- a/docs/gst/tmpl/cothreads.sgml +++ b/docs/gst/tmpl/cothreads.sgml @@ -12,13 +12,12 @@ subtasks. They're based on setjmp()/longjmp() in their current form. 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. - +#GstScheduler @@ -99,8 +98,10 @@ Indicates the cothread is destroyed. -@thread: +@cothread: @Returns: + +@thread: @@ -108,8 +109,10 @@ Indicates the cothread is destroyed. -@thread: +@cothread: @data: + +@thread: @@ -126,6 +129,8 @@ Indicates the cothread is destroyed. +@cothread: + @thread: @@ -134,10 +139,12 @@ Indicates the cothread is destroyed. -@thread: +@cothread: @func: @argc: @argv: + +@thread: @@ -145,6 +152,8 @@ Indicates the cothread is destroyed. +@cothread: + @thread: @@ -153,6 +162,8 @@ Indicates the cothread is destroyed. +@cothread: + @thread: @@ -161,9 +172,11 @@ Indicates the cothread is destroyed. -@thread: +@cothread: @key: @Returns: + +@thread: @@ -171,9 +184,11 @@ Indicates the cothread is destroyed. -@thread: +@cothread: @key: @data: + +@thread: @@ -181,6 +196,8 @@ Indicates the cothread is destroyed. +@cothread: + @thread: @@ -189,8 +206,10 @@ Indicates the cothread is destroyed. -@thread: +@cothread: @Returns: + +@thread: @@ -198,6 +217,8 @@ Indicates the cothread is destroyed. +@cothread: + @thread: diff --git a/docs/gst/tmpl/gstatomic.sgml b/docs/gst/tmpl/gstatomic.sgml new file mode 100644 index 0000000..a863c08 --- /dev/null +++ b/docs/gst/tmpl/gstatomic.sgml @@ -0,0 +1,139 @@ + +GstAtomic + + +Macros that implement atomic operations + + + +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. + + + + +#GstMemChunk + + + + +A structure that contains an integer that can be modified +atomically. + + + + + +Initialize an atomic int + + +@ref: a reference to a #GstAtomicInt +@val: The initial value for the integer + + + + +Free the memory allocated by #GST_ATOMIC_INT_INIT + + +@ref: A reference to a #GstAtomicInt + + + + +Set the value of a #GstAtomicInt atomically + + +@ref: a reference to a #GstAtomicInt +@val: The value for the integer + + + + +Get the value of a #GstAtomicInt atomically + + +@ref: a reference to a #GstAtomicInt + + + + +Get the value of a #GstAtomicInt atomically into a variable + + +@ref: a reference to a #GstAtomicInt +@res: a pointer to a gint to hold the value + + + + +Increment the value of a #GstAtomicInt atomically + + +@ref: a reference to a #GstAtomicInt + + + + +Decrement the value of a #GstAtomicInt atomically and test +for zero. + + +@ref: a reference to a #GstAtomicInt +@zero: a gpointer to a gboolean to hold the value of the test + + + + +Atomically add a value to a #GstAtomicInt + + +@ref: a reference to a #GstAtomicInt +@count: The value to add + + + + +The structure to handle values that can be swapped atomically + + +@lock: + + + +Get the value of a #GstAtomicSwap + + +@swap: a reference to a #GstAtomicSwap + + + + +Initialize an atomic swap structure + + +@swap: a reference to a #GstAtomicSwap +@val: the initial value + + + + +Atomically swap the value of the #GstAtomicSwap with a new value + + +@swap: a reference to a #GstAtomicSwap +@val: the new value + + + + +Atomically swap the value of the #GstAtomicSwap with a new value and +get the old value. + + +@swap: a reference to a #GstAtomicSwap +@val: the new value +@res: the old value + + diff --git a/docs/gst/tmpl/gstmemchunk.sgml b/docs/gst/tmpl/gstmemchunk.sgml new file mode 100644 index 0000000..e220c35 --- /dev/null +++ b/docs/gst/tmpl/gstmemchunk.sgml @@ -0,0 +1,91 @@ + +GstMemChunk + + +Atomic chunk allocator + + + +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. + + + +The GstMemChunk is used to allocate critical resources for #GstBuffer and +#GstEvent. + + + + +#GstAtomic, #GstBuffer, #GstEvent, #GstData + + + + +The memchunk structure + + +@swap: +@name: +@area_size: +@chunk_size: +@atom_size: +@cleanup: +@lock: + + + +An entry in the memchunk area + + +@link: +@area: + + + + + + +@name: +@atom_size: +@area_size: +@type: +@Returns: + + + + + + + +@mem_chunk: + + + + + + + +@mem_chunk: +@Returns: + + + + + + + +@mem_chunk: +@Returns: + + + + + + + +@mem_chunk: +@mem: + + diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 32712c3..89c070b 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -156,26 +156,6 @@ the offset. GstAsyncDiskSrc - - - - - - - - - - - - - - - - - -gstatomic - - @@ -725,26 +705,6 @@ gstmarshal GstMD5Sink - - - - - - - - - - - - - - - - - -gstmemchunk - - The point of the metadata is to provide some context for each buffer. In @@ -1483,105 +1443,12 @@ g_print messages. @klass: - - - - - -@ref: -@count: - - - - - - -@ref: -@zero: - - - - - - -@ref: - - - - - - -@ref: - - - - - - -@ref: -@val: - - - - - - -@ref: -@res: - - - - - - -@ref: -@val: - - - - - - -@ref: - - - - - - -@swap: -@val: - - - - - - -@swap: -@val: -@res: - - - - - - -@swap: -@val: - - - - - - -@swap: - @@ -4160,19 +4027,6 @@ Specify the current offset in the file. @GST_ASYNCDISKSRC_OPEN: @GST_ASYNCDISKSRC_FLAG_LAST: - - - - - - - - - - - -@lock: - @@ -5046,27 +4900,6 @@ Specify the location of the file. The location must be a fully qualified URL. - - - - - -@swap: -@name: -@area_size: -@chunk_size: -@atom_size: -@cleanup: -@lock: - - - - - - -@link: -@area: - @@ -8573,48 +8406,6 @@ must be defined to activate the tracing functionality. @factory: @Returns: - - - - - -@mem_chunk: -@Returns: - - - - - - -@mem_chunk: -@Returns: - - - - - - -@mem_chunk: - - - - - - -@mem_chunk: -@mem: - - - - - - -@name: -@atom_size: -@area_size: -@type: -@Returns: - Create new meta data. -- 2.7.4