mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-23 00:36:51 +00:00
I'm too lazy to comment this
Original commit message from CVS: *** empty log message ***
This commit is contained in:
parent
e990c2c7d5
commit
092db54409
4 changed files with 65 additions and 15 deletions
|
@ -2,11 +2,18 @@
|
||||||
cothreads
|
cothreads
|
||||||
|
|
||||||
<!-- ##### SECTION Short_Description ##### -->
|
<!-- ##### SECTION Short_Description ##### -->
|
||||||
|
userspace threads
|
||||||
|
|
||||||
<!-- ##### SECTION Long_Description ##### -->
|
<!-- ##### SECTION Long_Description ##### -->
|
||||||
<para>
|
<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>
|
</para>
|
||||||
|
|
||||||
<!-- ##### SECTION See_Also ##### -->
|
<!-- ##### SECTION See_Also ##### -->
|
||||||
|
@ -16,14 +23,14 @@ cothreads
|
||||||
|
|
||||||
<!-- ##### MACRO COTHREAD_STACKSIZE ##### -->
|
<!-- ##### MACRO COTHREAD_STACKSIZE ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
The default stack size of a cothread
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### MACRO COTHREAD_MAXTHREADS ##### -->
|
<!-- ##### MACRO COTHREAD_MAXTHREADS ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
The maximum number of cothreads we are going to support.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
@ -66,10 +73,11 @@ cothreads
|
||||||
@threads:
|
@threads:
|
||||||
@nthreads:
|
@nthreads:
|
||||||
@current:
|
@current:
|
||||||
|
@data:
|
||||||
|
|
||||||
<!-- ##### USER_FUNCTION cothread_func ##### -->
|
<!-- ##### USER_FUNCTION cothread_func ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
the function that will be called when the cothread starts.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@argc:
|
@argc:
|
||||||
|
@ -79,14 +87,13 @@ cothreads
|
||||||
|
|
||||||
<!-- ##### MACRO COTHREAD_STARTED ##### -->
|
<!-- ##### MACRO COTHREAD_STARTED ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
Indicates the cothread is started
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION cothread_init ##### -->
|
<!-- ##### FUNCTION cothread_init ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@Returns:
|
@Returns:
|
||||||
|
@ -129,3 +136,23 @@ cothreads
|
||||||
@Returns:
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION cothread_set_data ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@thread:
|
||||||
|
@key:
|
||||||
|
@data:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION cothread_get_data ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@thread:
|
||||||
|
@key:
|
||||||
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -35,22 +35,23 @@ the number of memcpy operations.
|
||||||
|
|
||||||
<!-- ##### USER_FUNCTION GstBufferPoolCreateFunction ##### -->
|
<!-- ##### USER_FUNCTION GstBufferPoolCreateFunction ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
The function called when a buffer has to be created for this pool.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@pool:
|
@pool: the pool from which to create the buffer
|
||||||
@user_data:
|
@user_data: any user data
|
||||||
@Returns:
|
@Returns: a new buffer from the pool
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### USER_FUNCTION GstBufferPoolDestroyFunction ##### -->
|
<!-- ##### USER_FUNCTION GstBufferPoolDestroyFunction ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
This function will be called when the given buffer has to be returned to
|
||||||
|
the pool.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@pool:
|
@pool: the pool to return the buffer to
|
||||||
@buffer:
|
@buffer: the buffer to return
|
||||||
@user_data:
|
@user_data: any user data
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_buffer_pool_new ##### -->
|
<!-- ##### FUNCTION gst_buffer_pool_new ##### -->
|
||||||
|
|
|
@ -142,6 +142,7 @@ may have.
|
||||||
|
|
||||||
@GST_ELEMENT_MULTI_IN:
|
@GST_ELEMENT_MULTI_IN:
|
||||||
@GST_ELEMENT_THREAD_SUGGESTED:
|
@GST_ELEMENT_THREAD_SUGGESTED:
|
||||||
|
@GST_ELEMENT_NO_SEEK:
|
||||||
|
|
||||||
<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
|
<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
|
@ -55,6 +55,16 @@ The function that will be called when pulling buffers.
|
||||||
@pad: the pad to pull
|
@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 ##### -->
|
<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
@ -92,7 +102,7 @@ the function that will be called when a QoS message is sent.
|
||||||
@Returns:
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_pad_destroy ##### -->
|
<!-- ##### MACRO gst_pad_destroy ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
@ -253,6 +263,17 @@ the function that will be called when a QoS message is sent.
|
||||||
@Returns:
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gst_pad_pull_region ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@pad:
|
||||||
|
@offset:
|
||||||
|
@size:
|
||||||
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
|
<!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue