mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 00:36:51 +00:00
Code Issues 1 Projects Releases Wiki Activity

I'm too lazy to comment this

Browse source 
Original commit message from CVS:
*** empty log message ***
This commit is contained in:
Wim Taymans 2000-11-07 21:24:12 +00:00
parent e990c2c7d5
commit 092db54409
4 changed files with 65 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
docs/gst/tmpl/cothreads.sgml
View file

@ -2,11 +2,18 @@
cothreads
<!-- ##### SECTION Short_Description ##### -->
userspace threads
<!-- ##### SECTION Long_Description ##### -->
<para>
Cothreads are a simple user-space method for switching between
subtasks. They're based on setjmp()/longjmp() in their current form.
</para>
<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.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -16,14 +23,14 @@ cothreads
<!-- ##### MACRO COTHREAD_STACKSIZE ##### -->
<para>
The default stack size of a cothread
</para>
<!-- ##### MACRO COTHREAD_MAXTHREADS ##### -->
<para>
The maximum number of cothreads we are going to support.
</para>
@ -66,10 +73,11 @@ cothreads
@threads:
@nthreads:
@current:
@data:
<!-- ##### USER_FUNCTION cothread_func ##### -->
<para>
the function that will be called when the cothread starts.
</para>
@argc:
@ -79,14 +87,13 @@ cothreads
<!-- ##### MACRO COTHREAD_STARTED ##### -->
<para>
Indicates the cothread is started
</para>
<!-- ##### FUNCTION cothread_init ##### -->
<para>
</para>
@Returns:
@ -129,3 +136,23 @@ cothreads
@Returns:
<!-- ##### FUNCTION cothread_set_data ##### -->
<para>
</para>
@thread:
@key:
@data:
<!-- ##### FUNCTION cothread_get_data ##### -->
<para>
</para>
@thread:
@key:
@Returns:

17
docs/gst/tmpl/gstbufferpool.sgml
View file

@ -35,22 +35,23 @@ the number of memcpy operations.
<!-- ##### USER_FUNCTION GstBufferPoolCreateFunction ##### -->
<para>
The function called when a buffer has to be created for this pool.
</para>
@pool:
@user_data:
@Returns:
@pool: the pool from which to create the buffer
@user_data: any user data
@Returns: a new buffer from the pool
<!-- ##### USER_FUNCTION GstBufferPoolDestroyFunction ##### -->
<para>
This function will be called when the given buffer has to be returned to
the pool.
</para>
@pool:
@buffer:
@user_data:
@pool: the pool to return the buffer to
@buffer: the buffer to return
@user_data: any user data
<!-- ##### FUNCTION gst_buffer_pool_new ##### -->

1
docs/gst/tmpl/gstelement.sgml
View file

@ -142,6 +142,7 @@ may have.
@GST_ELEMENT_MULTI_IN:
@GST_ELEMENT_THREAD_SUGGESTED:
@GST_ELEMENT_NO_SEEK:
<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
<para>

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

@ -55,6 +55,16 @@ The function that will be called when pulling buffers.
@pad: the pad to pull
<!-- ##### USER_FUNCTION GstPadPullRegionFunction ##### -->
<para>
The function that will be called when pulling a region buffer.
</para>
@pad: the pad to pull
@offset: the offset of the region to pull
@size: the size of the region to pull
<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
<para>
@ -92,7 +102,7 @@ the function that will be called when a QoS message is sent.
@Returns:
<!-- ##### FUNCTION gst_pad_destroy ##### -->
<!-- ##### MACRO gst_pad_destroy ##### -->
<para>
</para>
@ -253,6 +263,17 @@ the function that will be called when a QoS message is sent.
@Returns:
<!-- ##### FUNCTION gst_pad_pull_region ##### -->
<para>
</para>
@pad:
@offset:
@size:
@Returns:
<!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
<para>