Updated the API docs.

Original commit message from CVS:
Updated the API docs.
This commit is contained in:
Wim Taymans 2000-12-28 21:42:23 +00:00
parent c706b66123
commit 9655c3b593
44 changed files with 1518 additions and 578 deletions

View file

@ -102,7 +102,7 @@ tmpl: scanobj scan
sgml: tmpl
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
html:
html: sgml
if ! test -d html ; then mkdir html ; fi
-cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)

File diff suppressed because it is too large Load diff

View file

@ -14,6 +14,7 @@
<!entity GstObject SYSTEM "sgml/gstobject.sgml">
<!entity GstPad SYSTEM "sgml/gstpad.sgml">
<!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
<!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml">
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
<!entity GstSink SYSTEM "sgml/gstsink.sgml">
<!entity GstSrc SYSTEM "sgml/gstsrc.sgml">
@ -21,6 +22,8 @@
<!entity GstThread SYSTEM "sgml/gstthread.sgml">
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
<!entity GstType SYSTEM "sgml/gsttype.sgml">
<!entity GstCaps SYSTEM "sgml/gstcaps.sgml">
<!entity GstProps SYSTEM "sgml/gstprops.sgml">
<!entity GstUtils SYSTEM "sgml/gstutils.sgml">
<!entity GstXml SYSTEM "sgml/gstxml.sgml">
<!entity cothreads SYSTEM "sgml/cothreads.sgml">
@ -66,6 +69,7 @@ with some more specialized elements.</para>
&GstElement;
&GstBin;
&GstPipeline;
&GstAutoplug;
&GstFilter;
&GstSink;
&GstSrc;
@ -78,6 +82,8 @@ with some more specialized elements.</para>
&GstTee;
&GstType;
&GstCaps;
&GstProps;
&GstMeta;
&GstUtils;
&GstCpu;

View file

@ -14,6 +14,7 @@ cothread_init
cothread_create
cothread_setfunc
cothread_switch
cothread_getcurrent
cothread_main
cothread_set_data
cothread_get_data
@ -48,11 +49,19 @@ gst_extra_get_filename_type
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstscheduler</FILE>
<TITLE>GstScheduler</TITLE>
gst_bin_schedule_func
</SECTION>
<SECTION>
<FILE>gstbin</FILE>
<TITLE>GstBin</TITLE>
GstBinFlags
GstBin
gst_bin_new
gst_bin_destroy
gst_bin_add
gst_bin_remove
gst_bin_get_by_name
@ -60,6 +69,7 @@ gst_bin_get_list
gst_bin_set_state_type
gst_bin_iterate
gst_bin_create_plan
gst_bin_schedule
<SUBSECTION Standard>
GstBinClass
gst_bin_get_type
@ -69,8 +79,8 @@ GST_BIN_CLASS
GST_IS_BIN
GST_IS_BIN_CLASS
gst_bin_details
gst_bin_destroy
gst_bin_use_cothreads
_GstBinChain
</SECTION>
<SECTION>
@ -145,41 +155,49 @@ GstElementState
GstElementStateReturn
GST_STATE
GST_STATE_PENDING
GST_STATE_TRANSITION
GST_STATE_NULL_TO_READY
GST_STATE_READY_TO_PLAYING
GST_STATE_PLAYING_TO_PAUSED
GST_STATE_PAUSED_TO_PLAYING
GST_STATE_PLAYING_TO_READY
GST_STATE_READY_TO_NULL
GstElementFlags
GST_ELEMENT_IS_MULTI_IN
GST_ELEMENT_IS_THREAD_SUGGESTED
GST_ELEMENT_IS_COTHREAD_STOPPING
GstElement
GstElementDetails
GstElementFactory
GstElementLoopFunction
gst_element_new
gst_element_destroy
gst_element_set_loop_function
gst_element_set_name
gst_element_get_name
gst_element_set_manager
gst_element_get_manager
gst_element_add_pad
gst_element_add_ghost_pad
gst_element_get_pad
gst_element_get_pad_list
gst_element_get_padtemplate_list
gst_element_add_ghost_pad
gst_element_connect
gst_element_set_state
gst_element_error
gst_element_get_factory
gst_element_destroy
gst_element_save_thyself
gst_element_load_thyself
gst_elementfactory_new
gst_elementfactory_register
gst_elementfactory_add_sink
gst_elementfactory_add_src
gst_elementfactory_destroy
gst_elementfactory_add_padtemplate
gst_elementfactory_find
gst_elementfactory_get_list
gst_elementfactory_can_src_caps
gst_elementfactory_can_sink_caps
gst_elementfactory_create
gst_elementfactory_make
gst_elementfactory_save_thyself
gst_elementfactory_load_thyself
gst_element_loopfunc_wrapper
<SUBSECTION Standard>
GstElementClass
GST_TYPE_ELEMENT
@ -194,6 +212,7 @@ gst_element_get_type
<FILE>gstfilter</FILE>
<TITLE>GstFilter</TITLE>
GstFilter
GST_FILTER_FLAG_LAST
gst_filter_new
<SUBSECTION Standard>
GstFilterClass
@ -246,6 +265,7 @@ GST_META
<SECTION>
<FILE>gstobject</FILE>
<TITLE>GstObject</TITLE>
GST_OBJECT_FLAG_LAST
GstObject
GST_FLAGS
GST_FLAG_IS_SET
@ -279,24 +299,32 @@ GST_PAD_CONNECTED
GST_PAD_CAN_PULL
GstPad
GstPadChainFunction
GstPadGetFunction
GstPadGetRegionFunction
GstPadQoSFunction
GstPadPushFunction
GstPadPullFunction
GstPadPullRegionFunction
GstPadPushFunction
GstPadQoSFunction
GstPadDirection
GstPadFlags
gst_pad_new
gst_pad_destroy
gst_pad_new_from_template
gst_pad_get_direction
gst_pad_set_chain_function
gst_pad_set_pull_function
gst_pad_get_type_id
gst_pad_set_type_id
gst_pad_set_get_function
gst_pad_set_getregion_function
gst_pad_set_qos_function
gst_pad_set_caps
gst_pad_get_caps
gst_pad_set_name
gst_pad_get_name
gst_pad_set_parent
gst_pad_get_parent
gst_pad_add_ghost_parent
gst_pad_remove_ghost_parent
gst_pad_get_parent
gst_pad_get_ghost_parents
gst_pad_get_peer
gst_pad_connect
@ -304,10 +332,25 @@ gst_pad_disconnect
gst_pad_push
gst_pad_pull
gst_pad_pull_region
gst_pad_set_qos_function
gst_pad_pullregion
gst_pad_handle_qos
gst_pad_save_thyself
gst_pad_load_and_connect
GstPadFactoryEntry
GstPadFactory[]
GST_PAD_FACTORY_SOMETIMES
GST_PAD_FACTORY_ALWAYS
GST_PAD_FACTORY_SINK
GST_PAD_FACTORY_SRC
GstPadPresence
GstPadTemplate
gst_padtemplate_new
gst_padtemplate_create
gst_padtemplate_load_thyself
gst_padtemplate_save_thyself
<SUBSECTION Standard>
GstPadClass
GST_TYPE_PAD
@ -316,6 +359,14 @@ GST_PAD_CLASS
GST_IS_PAD
GST_IS_PAD_CLASS
gst_pad_get_type
GstPadTemplateClass
GST_TYPE_PADTEMPLATE
GST_PADTEMPLATE
GST_PADTEMPLATE_CLASS
GST_IS_PADTEMPLATE
GST_IS_PADTEMPLATE_CLASS
gst_padtemplate_get_type
</SECTION>
<SECTION>
@ -339,6 +390,23 @@ GST_IS_PIPELINE_CLASS
gst_pipeline_details
</SECTION>
<SECTION>
<FILE>gstautoplug</FILE>
<TITLE>GstAutoplug</TITLE>
GST_AUTOPLUG_MAX_COST
GstAutoplugCostFunction
GstAutoplugListFunction
gst_autoplug_caps
<SUBSECTION Standard>
GstAutoplug
GST_AUTOPLUG
GST_IS_AUTOPLUG
GST_TYPE_AUTOPLUG
gst_autoplug_get_type
GST_AUTOPLUG_CLASS
GST_IS_AUTOPLUG_CLASS
</SECTION>
<SECTION>
<FILE>gstplugin</FILE>
<TITLE>GstPlugin</TITLE>
@ -349,10 +417,10 @@ gst_plugin_new
gst_plugin_set_longname
gst_plugin_load_all
gst_plugin_load
gst_plugin_add_type
gst_library_load
gst_plugin_load_absolute
gst_library_load
gst_plugin_add_factory
gst_plugin_add_type
gst_plugin_find
gst_plugin_get_list
gst_plugin_find_elementfactory
@ -367,6 +435,7 @@ gst_plugin_save_thyself
<FILE>gstsink</FILE>
<TITLE>GstSink</TITLE>
GstSink
GST_SINK_FLAG_LAST
gst_sink_new
<SUBSECTION Standard>
GstSinkClass
@ -382,14 +451,9 @@ GST_IS_SINK_CLASS
<FILE>gstsrc</FILE>
<TITLE>GstSrc</TITLE>
GstSrcFlags
GST_SRC_FLAGS
GST_SRC_ASYNC
GST_SRC_SET_FLAGS
GST_SRC_UNSET_FLAGS
GST_SRC_IS_ASYNC
GstSrc
gst_src_signal_eos
gst_src_push
gst_src_push_region
<SUBSECTION Standard>
gst_src_get_type
GstSrcClass
@ -461,25 +525,64 @@ GstTypeFactory
gst_type_register
gst_type_find_by_mime
gst_type_find_by_ext
gst_type_add_src
gst_type_add_sink
gst_type_get_srcs
gst_type_get_sinks
gst_type_find_by_id
gst_type_get_list
gst_type_save_thyself
gst_type_get_sink_to_src
gst_type_dump
gst_type_load_thyself
gst_typefactory_load_thyself
gst_typefactory_save_thyself
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstcaps</FILE>
<TITLE>GstCaps</TITLE>
GstCaps
GstCapsFactoryEntry
GstCapsFactory[]
gst_caps_new
gst_caps_new_with_props
gst_caps_register
gst_caps_set_props
gst_caps_get_props
gst_caps_check_compatibility
gst_caps_save_thyself
gst_caps_load_thyself
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstprops</FILE>
<TITLE>GstProps</TITLE>
GstProps
GstPropsFactoryEntry
GstPropsFactory[]
GST_PROPS_LIST
GST_PROPS_INT
GST_PROPS_INT_RANGE
GST_PROPS_FOURCC
GST_PROPS_FOURCC_INT
GST_PROPS_BOOLEAN
gst_props_register
gst_props_new
gst_props_merge
gst_props_check_compatibility
gst_props_save_thyself
gst_props_load_thyself
<SUBSECTION Standard>
GstPropsEntry
GstPropsListFactory[]
GstPropsId
GST_PROPS_LIST_ID
GST_PROPS_INT_ID
GST_PROPS_INT_RANGE_ID
GST_PROPS_FOURCC_ID
GST_PROPS_BOOL_ID
</SECTION>
<SECTION>
<FILE>gstutils</FILE>
<TITLE>GstUtils</TITLE>
gst_util_get_int_arg
gst_util_get_bool_arg
gst_util_get_long_arg
gst_util_get_float_arg
gst_util_get_double_arg
@ -497,6 +600,7 @@ GstXML
gst_xml_new
gst_xml_write
gst_xml_get_element
gst_xml_get_topelements
<SUBSECTION Standard>
gst_xml_get_type
GST_XML
@ -609,6 +713,7 @@ GST_IS_FAKESINK_CLASS
<TITLE>GstFakeSrc</TITLE>
<SUBSECTION Standard>
GstFakeSrc
GstFakeSrcOutputType
gst_fakesrc_get_type
GstFakeSrcClass
GST_TYPE_FAKESRC

View file

@ -129,6 +129,14 @@ Indicates the cothread is started
@thread:
<!-- ##### FUNCTION cothread_getcurrent ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION cothread_main ##### -->
<para>

View file

@ -65,3 +65,51 @@ g_print messages.
@args...: arguments
<!-- ##### MACRO GST_DEBUG_ENABLED ##### -->
<para>
</para>
<!-- ##### MACRO DEBUG_SET_STRING ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO DEBUG_ENTER_STRING ##### -->
<para>
</para>
<!-- ##### MACRO DEBUG_ENTER ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
<para>
</para>
<!-- ##### MACRO DEBUG_LEAVE ##### -->
<para>
</para>
@format:
@args...:

View file

@ -30,6 +30,7 @@ the offset.
</para>
@GST_ASYNCDISKSRC_OPEN:
@GST_ASYNCDISKSRC_FLAG_LAST:
<!-- ##### ARG GstAsyncDiskSrc:location ##### -->
<para>

View file

@ -17,6 +17,15 @@ allowing for deep nesting of predefined sub-pipelines.
</para>
<!-- ##### ENUM GstBinFlags ##### -->
<para>
Flags for a bin
</para>
@GST_BIN_FLAG_MANAGER:
@GST_BIN_FLAG_PREFER_COTHREADS:
@GST_BIN_FLAG_LAST:
<!-- ##### STRUCT GstBin ##### -->
<para>
@ -32,6 +41,14 @@ allowing for deep nesting of predefined sub-pipelines.
@Returns:
<!-- ##### MACRO gst_bin_destroy ##### -->
<para>
</para>
@bin:
<!-- ##### FUNCTION gst_bin_add ##### -->
<para>
@ -96,6 +113,14 @@ allowing for deep nesting of predefined sub-pipelines.
@bin:
<!-- ##### FUNCTION gst_bin_schedule ##### -->
<para>
</para>
@bin:
<!-- ##### SIGNAL GstBin::object-added ##### -->
<para>
is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>

View file

@ -167,11 +167,12 @@ used when data in a stream has been skipped</entry>
</para>
@GST_BUFFER_READONLY:
@GST_BUFFER_EOS:
@GST_BUFFER_ORIGINAL:
@GST_BUFFER_DONTFREE:
@GST_BUFFER_FLUSH:
@GST_BUFFER_READONLY: the buffer is read only
@GST_BUFFER_ORIGINAL: this buffer not a copy
@GST_BUFFER_DONTFREE: do not try to free the data when this buffer is unref-ed
@GST_BUFFER_FLUSH: this buffer is not related to previous buffers. This flag is mainly
used when data in a stream has been skipped
@GST_BUFFER_EOS: this buffer is the last one in the stream
<!-- ##### STRUCT GstBuffer ##### -->
<para>

View file

@ -31,6 +31,7 @@ with seeking capabilities use a <classname>GstAsynDiskSrc</classname> instead.
</para>
@GST_DISKSRC_OPEN:
@GST_DISKSRC_FLAG_LAST:
<!-- ##### ARG GstDiskSrc:location ##### -->
<para>

View file

@ -33,79 +33,25 @@ simpler to connect pads of two elements together.
This enum defines the standard states an element may be in. You will normally
use gst_element_set_state() to change the state of an element.
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_STATE_NONE_PENDING</entry>
<entry>The element is in the desired state.</entry>
</row>
<row>
<entry>GST_STATE_NULL</entry>
<entry>Reset the state of an element.</entry>
</row>
<row>
<entry>GST_STATE_READY</entry>
<entry>will make the element ready to start processing data. some
elements might have a non trivial way to initialize themselves.
</entry>
</row>
<row>
<entry>GST_STATE_PLAYING</entry>
<entry>means there really is data flowing through the graph.
</entry>
</row>
<row>
<entry>GST_STATE_PAUSED</entry>
<entry>means there really is data flowing
temporary stops the data flow.
</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@GST_STATE_NONE_PENDING:
@GST_STATE_NULL:
@GST_STATE_READY:
@GST_STATE_PLAYING:
@GST_STATE_PAUSED:
@GST_STATE_NONE_PENDING: The element is in the desired state.
@GST_STATE_NULL: Reset the state of an element.
@GST_STATE_READY: will make the element ready to start processing data. some
elements might have a non trivial way to initialize themselves.
@GST_STATE_PLAYING: means there really is data flowing through the graph.
@GST_STATE_PAUSED: means there really is data flowing temporary stops the data flow.
<!-- ##### ENUM GstElementStateReturn ##### -->
<para>
This enum defines the standard return values that an element
can return after a state change.
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_STATE_FAILURE</entry>
<entry>the element could not perform the state change</entry>
</row>
<row>
<entry>GST_STATE_SUCCESS</entry>
<entry>the element successfully changed its state</entry>
</row>
<row>
<entry>GST_STATE_ASYNC</entry>
<entry>the element will asynchronously change its state as soon as possible
</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@GST_STATE_FAILURE:
@GST_STATE_SUCCESS:
@GST_STATE_ASYNC:
@GST_STATE_FAILURE: the element could not perform the state change
@GST_STATE_SUCCESS: the element successfully changed its state
@GST_STATE_ASYNC: the element will asynchronously change its state as soon as possible
<!-- ##### MACRO GST_STATE ##### -->
<para>
@ -123,44 +69,85 @@ This macro returns the currently pending state of the element.
@obj: Element to return the pending state for.
<!-- ##### MACRO GST_STATE_TRANSITION ##### -->
<para>
Returns the state transition this object is going through
</para>
@obj: the Element to return the tate transition for
<!-- ##### MACRO GST_STATE_NULL_TO_READY ##### -->
<para>
The Element is going from the NULL state to the READY state
</para>
<!-- ##### MACRO GST_STATE_READY_TO_PLAYING ##### -->
<para>
The Element is going from the READY state to the PLAYING state
</para>
<!-- ##### MACRO GST_STATE_PLAYING_TO_PAUSED ##### -->
<para>
The Element is going from the PLAYING state to the PAUSED state
</para>
<!-- ##### MACRO GST_STATE_PAUSED_TO_PLAYING ##### -->
<para>
The Element is going from the PAUSED state to the PLAYING state
</para>
<!-- ##### MACRO GST_STATE_PLAYING_TO_READY ##### -->
<para>
The Element is going from the PLAYING state to the READY state
</para>
<!-- ##### MACRO GST_STATE_READY_TO_NULL ##### -->
<para>
The Element is going from the READY state to the NULL state
</para>
<!-- ##### ENUM GstElementFlags ##### -->
<para>
This enum defines the standard flags that an element
may have.
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_ELEMENT_MULTI_IN</entry>
<entry>the element has multiple input pads</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@GST_ELEMENT_MULTI_IN:
@GST_ELEMENT_COMPLEX:
@GST_ELEMENT_DECOUPLED:
@GST_ELEMENT_THREAD_SUGGESTED:
@GST_ELEMENT_NO_SEEK:
@GST_ELEMENT_NEW_LOOPFUNC:
@GST_ELEMENT_COTHREAD_STOPPING:
<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
<para>
Query whether this object has multiple input pads.
</para>
@obj: Element to query for multiple input pads.
@GST_ELEMENT_USE_COTHREAD:
@GST_ELEMENT_FLAG_LAST:
<!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### -->
<para>
Queries whether the Element should be placed in a thread
</para>
@obj:
@obj: The element to query
<!-- ##### MACRO GST_ELEMENT_IS_COTHREAD_STOPPING ##### -->
<para>
Queries whether the cothread holding this element needs to be stopped
</para>
@obj: The element to query
<!-- ##### STRUCT GstElement ##### -->
@ -192,7 +179,7 @@ GstElementDetails struct for the element.
@name:
@type:
@details:
@padfactories:
@padtemplates:
<!-- ##### USER_FUNCTION GstElementLoopFunction ##### -->
<para>
@ -212,6 +199,14 @@ circumstances.
@Returns:
<!-- ##### MACRO gst_element_destroy ##### -->
<para>
</para>
@element: the element to destroy
<!-- ##### FUNCTION gst_element_set_loop_function ##### -->
<para>
@ -266,15 +261,6 @@ circumstances.
@pad:
<!-- ##### FUNCTION gst_element_add_ghost_pad ##### -->
<para>
</para>
@element:
@pad:
<!-- ##### FUNCTION gst_element_get_pad ##### -->
<para>
@ -294,6 +280,24 @@ circumstances.
@Returns:
<!-- ##### FUNCTION gst_element_get_padtemplate_list ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_add_ghost_pad ##### -->
<para>
</para>
@element:
@pad:
<!-- ##### FUNCTION gst_element_connect ##### -->
<para>
@ -333,14 +337,6 @@ circumstances.
@Returns:
<!-- ##### MACRO gst_element_destroy ##### -->
<para>
</para>
@element: the element to destroy
<!-- ##### FUNCTION gst_element_save_thyself ##### -->
<para>
@ -372,7 +368,7 @@ circumstances.
@Returns:
<!-- ##### FUNCTION gst_elementfactory_register ##### -->
<!-- ##### FUNCTION gst_elementfactory_destroy ##### -->
<para>
</para>
@ -380,6 +376,17 @@ circumstances.
@elementfactory:
<!-- ##### FUNCTION gst_elementfactory_add_padtemplate ##### -->
<para>
</para>
@elementfactory:
@temp:
<!-- # Unused Parameters # -->
@pad:
<!-- ##### FUNCTION gst_elementfactory_find ##### -->
<para>
@ -397,6 +404,26 @@ circumstances.
@Returns:
<!-- ##### FUNCTION gst_elementfactory_can_src_caps ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_can_sink_caps ##### -->
<para>
</para>
@factory:
@caps:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_create ##### -->
<para>
@ -436,15 +463,6 @@ circumstances.
@Returns:
<!-- ##### FUNCTION gst_element_loopfunc_wrapper ##### -->
<para>
</para>
@argc:
@argv:
@Returns:
<!-- ##### SIGNAL GstElement::state-change ##### -->
<para>
Is trigered whenever the state of an element changes

View file

@ -16,3 +16,10 @@ with the buffer. (fakesink)
</para>
<!-- ##### SIGNAL GstFakeSink::handoff ##### -->
<para>
</para>
@gstfakesink: the object which received the signal.

View file

@ -14,3 +14,30 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</para>
<!-- ##### SIGNAL GstFakeSrc::handoff ##### -->
<para>
</para>
@gstfakesrc: the object which received the signal.
<!-- ##### ARG GstFakeSrc:num_sources ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:loop_based ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:output ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:patern ##### -->
<para>
</para>

View file

@ -23,6 +23,13 @@ on its own.
</para>
<!-- ##### MACRO GST_FILTER_FLAG_LAST ##### -->
<para>
subclass use this to start their flag enumeration
</para>
<!-- ##### FUNCTION gst_filter_new ##### -->
<para>

View file

@ -14,3 +14,8 @@ Pass data without modification.
</para>
<!-- ##### ARG GstIdentity:loop_based ##### -->
<para>
</para>

View file

@ -25,6 +25,13 @@ down <classname>GtkObject</classname> to re-parent the hierarchy.
</para>
<!-- ##### MACRO GST_OBJECT_FLAG_LAST ##### -->
<para>
subclasses can use this value to start the enumeration of their flags
</para>
<!-- ##### STRUCT GstObject ##### -->
<para>

View file

@ -47,31 +47,24 @@ The function that will be called when chaining buffers.
@buf: the buffer that is chained
<!-- ##### USER_FUNCTION GstPadPullFunction ##### -->
<!-- ##### USER_FUNCTION GstPadGetFunction ##### -->
<para>
The function that will be called when pulling buffers.
The function that will be called when pulling a buffer.
</para>
@pad: the pad to pull
@pad: the pad to get a buffer from
@Returns: a GstBuffer
<!-- ##### USER_FUNCTION GstPadPullRegionFunction ##### -->
<!-- ##### USER_FUNCTION GstPadGetRegionFunction ##### -->
<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>
The function that will be called when pulling buffers.
</para>
@pad: the pad to push
@pad: the pad to get a buffer from
@offset: the offset of the region to get
@size: the size of the region to get
@Returns: a GstBuffer
<!-- ##### USER_FUNCTION GstPadQoSFunction ##### -->
@ -83,14 +76,53 @@ the function that will be called when a QoS message is sent.
@qos_message: the message
<!-- ##### ENUM GstPadDirection ##### -->
<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
<para>
The function that will be called when pushing a buffers.
</para>
@GST_PAD_UNKNOWN:
@GST_PAD_SRC:
@GST_PAD_SINK:
@pad: the pad to push
@buf: a GstBuffer to push
<!-- ##### USER_FUNCTION GstPadPullFunction ##### -->
<para>
The function that will be called when pulling buffers.
</para>
@pad: the pad to pull
@Returns: a GstBuffer
<!-- ##### 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
@Returns: a GstBuffer
<!-- ##### ENUM GstPadDirection ##### -->
<para>
The direction this pad is
</para>
@GST_PAD_UNKNOWN: direction is unknown
@GST_PAD_SRC: this is a source pad
@GST_PAD_SINK: this is a sink pad
<!-- ##### ENUM GstPadFlags ##### -->
<para>
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_FLAG_LAST: subclasses can use this number to enumerate their flags
<!-- ##### FUNCTION gst_pad_new ##### -->
<para>
@ -104,10 +136,20 @@ the function that will be called when a QoS message is sent.
<!-- ##### MACRO gst_pad_destroy ##### -->
<para>
Destroy the pad
</para>
@pad: the pad to destroy
<!-- ##### FUNCTION gst_pad_new_from_template ##### -->
<para>
</para>
@pad:
@temp:
@name:
@Returns:
<!-- ##### FUNCTION gst_pad_get_direction ##### -->
@ -128,13 +170,49 @@ the function that will be called when a QoS message is sent.
@chain:
<!-- ##### FUNCTION gst_pad_set_pull_function ##### -->
<!-- ##### FUNCTION gst_pad_set_get_function ##### -->
<para>
</para>
@pad:
@pull:
@get:
<!-- ##### FUNCTION gst_pad_set_getregion_function ##### -->
<para>
</para>
@pad:
@getregion:
<!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
<para>
</para>
@pad:
@qos:
<!-- ##### FUNCTION gst_pad_set_caps ##### -->
<para>
</para>
@pad:
@caps:
<!-- ##### FUNCTION gst_pad_get_caps ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_set_name ##### -->
@ -164,6 +242,15 @@ the function that will be called when a QoS message is sent.
@parent:
<!-- ##### FUNCTION gst_pad_get_parent ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_add_ghost_parent ##### -->
<para>
@ -182,15 +269,6 @@ the function that will be called when a QoS message is sent.
@parent:
<!-- ##### FUNCTION gst_pad_get_parent ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_ghost_parents ##### -->
<para>
@ -256,13 +334,14 @@ the function that will be called when a QoS message is sent.
@Returns:
<!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
<!-- ##### MACRO gst_pad_pullregion ##### -->
<para>
</para>
@pad:
@qos:
@offset:
@size:
<!-- ##### FUNCTION gst_pad_handle_qos ##### -->
@ -294,8 +373,109 @@ the function that will be called when a QoS message is sent.
@elements:
<!-- ##### ARG GstPad:active ##### -->
<!-- ##### TYPEDEF GstPadFactoryEntry ##### -->
<para>
Defines an entry for a padfactory
</para>
<!-- ##### TYPEDEF GstPadFactory[] ##### -->
<para>
The padfactory
</para>
<!-- ##### MACRO GST_PAD_FACTORY_SOMETIMES ##### -->
<para>
Indicate that this pad will become available depending
on the media type. Use this in the factory definition
</para>
<!-- ##### MACRO GST_PAD_FACTORY_ALWAYS ##### -->
<para>
Indicate that this pad will always be available.
Use this in the factory definition
</para>
<!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
<para>
Indicates a sinkpad for the padfactory.
</para>
<!-- ##### MACRO GST_PAD_FACTORY_SRC ##### -->
<para>
Indicates a srcpad for the padfactory.
</para>
<!-- ##### ENUM GstPadPresence ##### -->
<para>
Indicates when this pad will become available
</para>
@GST_PAD_ALWAYS: the pad is always available
@GST_PAD_SOMETIMES: the pad will become available depending on the media stream
<!-- ##### STRUCT GstPadTemplate ##### -->
<para>
</para>
@object:
@name_template:
@direction:
@presence:
@caps:
<!-- ##### FUNCTION gst_padtemplate_new ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_padtemplate_create ##### -->
<para>
</para>
@name_template:
@direction:
@presence:
@caps:
@Returns:
<!-- ##### FUNCTION gst_padtemplate_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_padtemplate_save_thyself ##### -->
<para>
</para>
@pad:
@parent:
@Returns:
<!-- ##### ARG GstPad:active ##### -->
<para>
Indicates this pad is active
</para>

View file

@ -77,13 +77,13 @@ by the loader at statup.
@Returns:
<!-- ##### FUNCTION gst_plugin_add_type ##### -->
<!-- ##### FUNCTION gst_plugin_load_absolute ##### -->
<para>
</para>
@plugin:
@factory:
@name:
@Returns:
<!-- ##### FUNCTION gst_library_load ##### -->
@ -95,16 +95,16 @@ by the loader at statup.
@Returns:
<!-- ##### FUNCTION gst_plugin_load_absolute ##### -->
<!-- ##### FUNCTION gst_plugin_add_factory ##### -->
<para>
</para>
@name:
@Returns:
@plugin:
@factory:
<!-- ##### FUNCTION gst_plugin_add_factory ##### -->
<!-- ##### FUNCTION gst_plugin_add_type ##### -->
<para>
</para>

View file

@ -32,3 +32,8 @@ Specify the maximum number of buffers in the queue before the queue
blocks.
</para>
<!-- ##### ARG GstQueue:block ##### -->
<para>
</para>

View file

@ -179,6 +179,12 @@
@Returns:
<!-- ##### MACRO GST_PROPS_INT_RANGE_ID ##### -->
<para>
</para>
<!-- ##### MACRO GST_SINESRC ##### -->
<para>
@ -241,6 +247,12 @@
</para>
<!-- ##### MACRO GST_PROPS_LIST_ID ##### -->
<para>
</para>
<!-- ##### FUNCTION plugin_load ##### -->
<para>
@ -269,6 +281,13 @@
@connection:
<!-- ##### MACRO GST_SRC_ASYNC ##### -->
<para>
This macro checks to see if the GST_SRC_ASYNC flag is set.
</para>
@obj: GstSrc to check for flag in.
<!-- ##### MACRO GST_TYPE_ASYNCDISKSRC ##### -->
<para>
@ -323,6 +342,12 @@
@Returns:
<!-- ##### MACRO GST_PROPS_INT_ID ##### -->
<para>
</para>
<!-- ##### STRUCT GstDiskSrcClass ##### -->
<para>
@ -360,6 +385,14 @@
@pad:
@buf:
<!-- ##### FUNCTION gst_type_get_sinks ##### -->
<para>
</para>
@id:
@Returns:
<!-- ##### MACRO GST_TYPE_HTTPSRC ##### -->
<para>
@ -443,6 +476,14 @@ GstColorSpace
@obj:
<!-- ##### FUNCTION gst_type_get_srcs ##### -->
<para>
</para>
@id:
@Returns:
<!-- ##### FUNCTION plugin_load_absolute ##### -->
<para>
@ -672,6 +713,13 @@ This macro unsets the given state on the element.
</para>
<!-- ##### MACRO GST_SRC_FLAGS ##### -->
<para>
This macro returns the entire set of flags for the object.
</para>
@obj: GstSrc to return flags for.
<!-- ##### FUNCTION gst_sink_get_type ##### -->
<para>
@ -725,6 +773,14 @@ This macro unsets the given state on the element.
</para>
<!-- ##### FUNCTION gst_type_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_plugin_init ##### -->
<para>
@ -809,6 +865,14 @@ This macro sets the given state on the element.
@klass:
<!-- ##### ENUM GstCapsDefinition ##### -->
<para>
</para>
@GST_CAPS_ALWAYS:
@GST_CAPS_MAYBE:
<!-- ##### MACRO GST_DISKSRC ##### -->
<para>
@ -928,6 +992,21 @@ plugin
</para>
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
<para>
</para>
<!-- ##### MACRO GST_SRC_UNSET_FLAGS ##### -->
<para>
This macro usets the given flags.
</para>
@src:
@flag: Flag to set, must be a single bit in guint32.
@obj: GstSrc to unset flag in.
<!-- ##### FUNCTION gst_audiosink_sync_parms ##### -->
<para>
@ -1066,6 +1145,15 @@ This macro checks to see if the given state is set.
@obj: Element to check for state.
@flag: State to check for, must be a single bit in guint32.
<!-- ##### FUNCTION gst_type_save_thyself ##### -->
<para>
</para>
@type:
@parent:
@Returns:
<!-- ##### MACRO GST_IS_SINESRC ##### -->
<para>
@ -1100,6 +1188,15 @@ This macro checks to see if the given state is set.
@obj:
<!-- ##### MACRO GST_SRC_SET_FLAGS ##### -->
<para>
This macro sets the given flags.
</para>
@src:
@flag: Flag to set, can by any number of bits in guint32.
@obj: GstSrc to set flag in.
<!-- ##### FUNCTION gst_fdsink_get_type ##### -->
<para>
@ -1113,6 +1210,14 @@ This macro checks to see if the given state is set.
</para>
<!-- ##### FUNCTION gst_element_loopfunc_wrapper ##### -->
<para>
</para>
@argc:
@argv:
@Returns:
<!-- ##### MACRO GST_TYPE_FDSRC ##### -->
<para>
@ -1131,6 +1236,15 @@ This macro checks to see if the given state is set.
</para>
<!-- ##### FUNCTION gst_type_get_sink_to_src ##### -->
<para>
</para>
@sinkid:
@srcid:
@Returns:
<!-- ##### MACRO GST_TYPE_FAKESRC ##### -->
<para>
@ -1177,6 +1291,12 @@ This macro checks to see if the given state is set.
</para>
<!-- ##### ARG GstTypeFind:type ##### -->
<para>
Query the element for the current mime type
</para>
<!-- ##### SECTION ./tmpl/GstElement.sgml:Short_Description ##### -->
@ -1210,6 +1330,12 @@ This macro checks to see if the given state is set.
@klass:
<!-- ##### FUNCTION gst_type_dump ##### -->
<para>
</para>
<!-- ##### STRUCT GstAudioSinkClass ##### -->
<para>
@ -1229,6 +1355,18 @@ This macro checks to see if the given state is set.
</para>
<!-- ##### ENUM GstPropsId ##### -->
<para>
</para>
@GST_PROPS_END_ID_NUM:
@GST_PROPS_LIST_ID_NUM:
@GST_PROPS_INT_ID_NUM:
@GST_PROPS_INT_RANGE_ID_NUM:
@GST_PROPS_FOURCC_ID_NUM:
@GST_PROPS_BOOL_ID_NUM:
<!-- ##### STRUCT GstEsdSinkClass ##### -->
<para>
@ -1338,6 +1476,12 @@ Get the size of the current file.
@Returns:
<!-- ##### TYPEDEF GstPropsListFactory[] ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_pad_get_type_id ##### -->
<para>
@ -1423,6 +1567,13 @@ Get the size of the current file.
@audiosink:
@frequency:
<!-- ##### FUNCTION gst_elementfactory_register ##### -->
<para>
</para>
@elementfactory:
<!-- ##### MACRO GST_TYPE_QUEUE ##### -->
<para>
@ -1540,6 +1691,14 @@ GstElement
</para>
<!-- ##### FUNCTION gst_pad_set_pull_function ##### -->
<para>
</para>
@pad:
@pull:
<!-- ##### STRUCT GstFakeSinkClass ##### -->
<para>
@ -1554,6 +1713,14 @@ GstElement
@esdsink:
@format:
<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
<para>
Query whether this object has multiple input pads.
</para>
@obj: Element to query for multiple input pads.
<!-- ##### MACRO GST_DISKSRC_CLASS ##### -->
<para>
@ -1561,6 +1728,12 @@ GstElement
@klass:
<!-- ##### MACRO GST_PROPS_BOOL_ID ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_FAKESINK ##### -->
<para>
@ -1574,10 +1747,6 @@ GstElement
@obj:
<!-- ##### SECTION ./tmpl/plugin.sgml:Short_Description ##### -->
<!-- ##### FUNCTION gst_audiosrc_push ##### -->
<para>
@ -1585,6 +1754,10 @@ GstElement
@src:
<!-- ##### SECTION ./tmpl/plugin.sgml:Short_Description ##### -->
<!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
<para>
@ -1708,15 +1881,15 @@ GstElement
@name:
@Returns:
<!-- ##### MACRO GST_TYPE_ESDSINK ##### -->
<para>
</para>
<!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
<para>
A flag indicating that MMX instructions are supported.
</para>
<!-- ##### MACRO GST_TYPE_ESDSINK ##### -->
<para>
</para>

View file

@ -22,6 +22,13 @@ or a video card.
</para>
<!-- ##### MACRO GST_SINK_FLAG_LAST ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_sink_new ##### -->
<para>

View file

@ -18,56 +18,18 @@ audio source. It provides data for the next element in the graph.
<!-- ##### ENUM GstSrcFlags ##### -->
<para>
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_SRC_ASYNC</entry>
<entry>this source is assynchronous </entry>
</row>
</tbody></tgroup></informaltable>
Flags for the GstSrc element
</para>
@GST_SRC_ASYNC:
@GST_SRC_ASYNC: Indicates that this src is asynchronous
@GST_SRC_FLAG_LAST: subclasses can use this to number their flags
<!-- ##### MACRO GST_SRC_FLAGS ##### -->
<!-- ##### MACRO GST_SRC_IS_ASYNC ##### -->
<para>
This macro returns the entire set of flags for the object.
Query a GstSrc for the ASYNC flag
</para>
@obj: GstSrc to return flags for.
<!-- ##### MACRO GST_SRC_ASYNC ##### -->
<para>
This macro checks to see if the GST_SRC_ASYNC flag is set.
</para>
@obj: GstSrc to check for flag in.
<!-- ##### MACRO GST_SRC_SET_FLAGS ##### -->
<para>
This macro sets the given flags.
</para>
@src:
@flag: Flag to set, can by any number of bits in guint32.
<!-- # Unused Parameters # -->
@obj: GstSrc to set flag in.
<!-- ##### MACRO GST_SRC_UNSET_FLAGS ##### -->
<para>
This macro usets the given flags.
</para>
@src:
@flag: Flag to set, must be a single bit in guint32.
<!-- # Unused Parameters # -->
@obj: GstSrc to unset flag in.
@obj: The GstSrc to query
<!-- ##### STRUCT GstSrc ##### -->

View file

@ -20,32 +20,13 @@ to be dealt with in the separate thread.
<!-- ##### ENUM GstThreadState ##### -->
<para>
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_THREAD_CREATE</entry>
<entry>The thread is being created. </entry>
</row>
<row>
<entry>GST_THREAD_STATE_SPINNING</entry>
<entry>The thread is runnning</entry>
</row>
<row>
<entry>GST_THREAD_STATE_REAPING</entry>
<entry>The thread is ending.</entry>
</row>
</tbody></tgroup></informaltable>
thread flags
</para>
@GST_THREAD_CREATE:
@GST_THREAD_STATE_SPINNING:
@GST_THREAD_STATE_REAPING:
@GST_THREAD_CREATE: The thread is being created.
@GST_THREAD_STATE_SPINNING: The thread is runnning
@GST_THREAD_STATE_REAPING: The thread is ending.
@GST_THREAD_FLAG_LAST: subclass use this to start their enumeration
<!-- ##### STRUCT GstThread ##### -->
<para>

View file

@ -72,9 +72,6 @@ A type
@mime:
@exts:
@typefindfuncs:
@srcs:
@sinks:
@converters:
<!-- ##### STRUCT GstTypeFactory ##### -->
<para>
@ -112,24 +109,6 @@ The struct with the typefactory information
@Returns:
<!-- ##### FUNCTION gst_type_get_srcs ##### -->
<para>
</para>
@id:
@Returns:
<!-- ##### FUNCTION gst_type_get_sinks ##### -->
<para>
</para>
@id:
@Returns:
<!-- ##### FUNCTION gst_type_find_by_id ##### -->
<para>
@ -147,42 +126,6 @@ The struct with the typefactory information
@Returns:
<!-- ##### FUNCTION gst_type_save_thyself ##### -->
<para>
</para>
@type:
@parent:
@Returns:
<!-- ##### FUNCTION gst_type_get_sink_to_src ##### -->
<para>
</para>
@sinkid:
@srcid:
@Returns:
<!-- ##### FUNCTION gst_type_dump ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_type_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_typefactory_load_thyself ##### -->
<para>

View file

@ -23,8 +23,8 @@ The signal to indicate the mime type was detected.
@gsttypefind: the object which received the signal.
@arg1: The mime type that was detected
<!-- ##### ARG GstTypeFind:type ##### -->
<!-- ##### ARG GstTypeFind:caps ##### -->
<para>
Query the element for the current mime type
</para>

View file

@ -24,6 +24,16 @@ Some convenience functions
@Returns:
<!-- ##### FUNCTION gst_util_get_bool_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_long_arg ##### -->
<para>

View file

@ -22,6 +22,7 @@ All GstElements can be serialized to an XML presentation
@object:
@elements:
@topelements:
<!-- ##### FUNCTION gst_xml_new ##### -->
<para>
@ -52,3 +53,12 @@ All GstElements can be serialized to an XML presentation
@Returns:
<!-- ##### FUNCTION gst_xml_get_topelements ##### -->
<para>
</para>
@xml:
@Returns:

View file

@ -22,19 +22,31 @@ Information about video buffers.
@meta:
@format:
@visual:
@width:
@height:
@overlay_info:
@dga_info:
<!-- ##### STRUCT MetaDGA ##### -->
<para>
</para>
@base:
@swidth:
@sheight:
@bytes_per_line:
<!-- ##### STRUCT MetaOverlay ##### -->
<para>
</para>
@wx:
@wy:
@overlay_element:
@clip_count:
@overlay_clip:
@width:
@height:
@did_overlay:

View file

@ -17,7 +17,7 @@
* Boston, MA 02111-1307, USA.
*/
#define GST_DEBUG_ENABLED
//#define GST_DEBUG_ENABLED
#include "gstbin.h"
#include "gstdebug.h"
@ -45,7 +45,6 @@ static gboolean gst_bin_change_state_type (GstBin *bin,
GtkType type);
static void gst_bin_create_plan_func (GstBin *bin);
//static void gst_bin_schedule_func (GstBin *bin);
static void gst_bin_iterate_func (GstBin *bin);
static xmlNodePtr gst_bin_save_thyself (GstElement *element, xmlNodePtr parent);
@ -678,7 +677,7 @@ gst_bin_create_plan_func (GstBin *bin)
DEBUG_LEAVE("(\"%s\")",gst_element_get_name(GST_ELEMENT(bin)));
}
void
static void
gst_bin_iterate_func (GstBin *bin)
{
GList *chains;

View file

@ -42,10 +42,10 @@ extern GstElementDetails gst_bin_details;
(GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_BIN))
typedef enum {
// this bin is a manager of child elements, i.e. a pipeline or thread
/* this bin is a manager of child elements, i.e. a pipeline or thread */
GST_BIN_FLAG_MANAGER = GST_ELEMENT_FLAG_LAST,
// we prefer to have cothreads when its an option, over chain-based
/* we prefer to have cothreads when its an option, over chain-based */
GST_BIN_FLAG_PREFER_COTHREADS,
/* padding */
@ -59,11 +59,11 @@ typedef struct __GstBinChain _GstBinChain;
struct _GstBin {
GstElement element;
// our children
/* our children */
gint numchildren;
GList *children;
// iteration state
/* iteration state */
gboolean need_cothreads;
GList *managed_elements;
gint num_managed_elements;
@ -128,7 +128,7 @@ gboolean gst_bin_set_state_type (GstBin *bin,
void gst_bin_iterate (GstBin *bin);
// hack FIXME
/* hack FIXME */
void gst_bin_use_cothreads (GstBin *bin,
gboolean enabled);

View file

@ -69,6 +69,16 @@ gst_caps_new (gchar *mime)
return caps;
}
/**
* gst_caps_new_with_props:
* @mime: the mime type to attach to the capability
* @props: the properties for this capability
*
* create a new capability with the given mime type
* and the given properties
*
* Returns: a new capability
*/
GstCaps*
gst_caps_new_with_props (gchar *mime, GstProps *props)
{
@ -113,6 +123,15 @@ gst_caps_register (GstCapsFactory *factory)
return caps;
}
/**
* gst_caps_set_props:
* @caps: the caps to attach the properties to
* @props: the properties to attach
*
* set the properties to the given caps
*
* Returns: The new caps structure
*/
GstCaps*
gst_caps_set_props (GstCaps *caps, GstProps *props)
{
@ -125,6 +144,14 @@ gst_caps_set_props (GstCaps *caps, GstProps *props)
return caps;
}
/**
* gst_caps_get_props:
* @caps: the caps to get the properties from
*
* get the properties of the given caps
*
* Returns: The properties of the caps
*/
GstProps*
gst_caps_get_props (GstCaps *caps)
{
@ -170,6 +197,15 @@ gst_caps_check_compatibility (GstCaps *fromcaps, GstCaps *tocaps)
}
/**
* gst_caps_save_thyself:
* @caps: a capabilty to save
* @parent: the parent XML node pointer
*
* save the capability into an XML representation
*
* Returns: a new XML node pointer
*/
xmlNodePtr
gst_caps_save_thyself (GstCaps *caps, xmlNodePtr parent)
{
@ -187,6 +223,14 @@ gst_caps_save_thyself (GstCaps *caps, xmlNodePtr parent)
return parent;
}
/**
* gst_caps_load_thyself:
* @parent: the parent XML node pointer
*
* load a new caps from the XML representation
*
* Returns: a new capability
*/
GstCaps*
gst_caps_load_thyself (xmlNodePtr parent)
{

View file

@ -27,12 +27,6 @@
typedef struct _GstCaps GstCaps;
typedef gpointer GstCapsFactoryEntry;
typedef GstCapsFactoryEntry GstCapsFactory[];
typedef GstCapsFactory *GstCapsListFactory[];
typedef enum {
GST_CAPS_ALWAYS = 1,
GST_CAPS_MAYBE = 2,
} GstCapsDefinition;
struct _GstCaps {
guint16 id; /* type id (major type) */
@ -50,7 +44,7 @@ GstCaps* gst_caps_register (GstCapsFactory *factory);
GstCaps* gst_caps_set_props (GstCaps *caps, GstProps *props);
GstProps* gst_caps_get_props (GstCaps *caps);
gboolean gst_caps_check_compatibility (GstCaps *caps1, GstCaps *caps2);
gboolean gst_caps_check_compatibility (GstCaps *fromcaps, GstCaps *tocaps);
xmlNodePtr gst_caps_save_thyself (GstCaps *caps, xmlNodePtr parent);
GstCaps* gst_caps_load_thyself (xmlNodePtr parent);

View file

@ -795,22 +795,6 @@ gst_element_get_manager (GstElement *element)
return element->manager;
}
// note that this casts a char ** to a GstElement *. Ick.
int
gst_element_loopfunc_wrapper (int argc, char **argv)
{
GstElement *element = GST_ELEMENT (argv);
while (1) {
/* if NEW_LOOPFUNC is set, clear it, we're implicitly updating */
if (GST_FLAG_IS_SET(element,GST_ELEMENT_NEW_LOOPFUNC))
GST_FLAG_UNSET(element,GST_ELEMENT_NEW_LOOPFUNC);
/* start up the loop function */
element->loopfunc (element);
}
return 0;
}
/**
* gst_element_set_loop_function:
* @element: Element to set loop function of.

View file

@ -83,21 +83,21 @@ static inline char *_gst_print_statename(int state) {
(GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT))
typedef enum {
// element is complex (for some def.) and generally require a cothread
/* element is complex (for some def.) and generally require a cothread */
GST_ELEMENT_COMPLEX = GST_OBJECT_FLAG_LAST,
// input and output pads aren't directly coupled to each other
// examples: queues, multi-output async readers, etc.
/* input and output pads aren't directly coupled to each other
examples: queues, multi-output async readers, etc. */
GST_ELEMENT_DECOUPLED,
// this element should be placed in a thread if at all possible
/* this element should be placed in a thread if at all possible */
GST_ELEMENT_THREAD_SUGGESTED,
// this element is incable of seeking (FIXME: does this apply to filters?)
/* this element is incable of seeking (FIXME: does this apply to filters?) */
GST_ELEMENT_NO_SEEK,
// there is a new loopfunction ready for placement
/* there is a new loopfunction ready for placement */
GST_ELEMENT_NEW_LOOPFUNC,
// the cothread holding this element needs to be stopped
/* the cothread holding this element needs to be stopped */
GST_ELEMENT_COTHREAD_STOPPING,
// the element has to be scheduled as a cothread for any sanity
/* the element has to be scheduled as a cothread for any sanity */
GST_ELEMENT_USE_COTHREAD,
/* use some padding for future expansion */
@ -146,10 +146,6 @@ struct _GstElementClass {
void (*new_ghost_pad) (GstElement *element,GstPad *pad);
void (*error) (GstElement *element,gchar *error);
/* events */
// gboolean (*start) (GstElement *element,GstElementState state);
// gboolean (*stop) (GstElement *element);
/* change the element state */
GstElementStateReturn (*change_state) (GstElement *element);
@ -204,7 +200,6 @@ gint gst_element_set_state (GstElement *element, GstElementState state);
void gst_element_error (GstElement *element, gchar *error);
GstElementFactory* gst_element_get_factory (GstElement *element);
int gst_element_loopfunc_wrapper (int argc,char **argv);
/* XML write and read */
xmlNodePtr gst_element_save_thyself (GstElement *element, xmlNodePtr parent);
@ -221,7 +216,7 @@ GstElementFactory* gst_elementfactory_new (gchar *name,GtkType type,
void gst_elementfactory_destroy (GstElementFactory *elementfactory);
void gst_elementfactory_add_padtemplate (GstElementFactory *elementfactory,
GstPadTemplate *pad);
GstPadTemplate *temp);
GstElementFactory* gst_elementfactory_find (gchar *name);
GList* gst_elementfactory_get_list (void);
@ -233,7 +228,7 @@ gboolean gst_elementfactory_can_sink_caps (GstElementFactory *factory,
GstElement* gst_elementfactory_create (GstElementFactory *factory,
gchar *name);
// FIXME this name is wrong, probably so is the one above it
/* FIXME this name is wrong, probably so is the one above it */
GstElement* gst_elementfactory_make (gchar *factoryname, gchar *name);
xmlNodePtr gst_elementfactory_save_thyself (GstElementFactory *factory, xmlNodePtr parent);

View file

@ -34,17 +34,17 @@ _gst_elementfactory_initialize (void)
}
/**
* gst_elementfactory_unregister:
* @elementfactory: factory to register
* gst_elementfactory_destroy:
* @elementfactory: factory to destroy
*
* Removes the elementfactory from the global list.
*/
void
gst_elementfactory_destroy (GstElementFactory *factory)
gst_elementfactory_destroy (GstElementFactory *elementfactory)
{
g_return_if_fail (factory != NULL);
g_return_if_fail (elementfactory != NULL);
_gst_elementfactories = g_list_remove (_gst_elementfactories, factory);
_gst_elementfactories = g_list_remove (_gst_elementfactories, elementfactory);
// we don't free the struct bacause someone might have a handle to it..
}
@ -200,20 +200,29 @@ gst_elementfactory_make (gchar *factoryname, gchar *name)
/**
* gst_elementfactory_add_padtemplate :
* @elementfactory: factory to add the src id to
* @template: the padtemplate to add
* @temp: the padtemplate to add
*
* Add the given padtemplate to this elementfactory.
*/
void
gst_elementfactory_add_padtemplate (GstElementFactory *factory,
GstPadTemplate *template)
GstPadTemplate *temp)
{
g_return_if_fail(factory != NULL);
g_return_if_fail(template != NULL);
g_return_if_fail(temp != NULL);
factory->padtemplates = g_list_append (factory->padtemplates, template);
factory->padtemplates = g_list_append (factory->padtemplates, temp);
}
/**
* gst_elementfactory_can_src_caps :
* @factory: factory to query
* @caps: the caps to check
*
* Checks if the factory can source the given capability
*
* Returns: true if it can src the capability
*/
gboolean
gst_elementfactory_can_src_caps (GstElementFactory *factory,
GstCaps *caps)
@ -238,6 +247,15 @@ gst_elementfactory_can_src_caps (GstElementFactory *factory,
return FALSE;
}
/**
* gst_elementfactory_can_sink_caps :
* @factory: factory to query
* @caps: the caps to check
*
* Checks if the factory can sink the given capability
*
* Returns: true if it can sink the capability
*/
gboolean
gst_elementfactory_can_sink_caps (GstElementFactory *factory,
GstCaps *caps)

View file

@ -284,7 +284,7 @@ void gst_pad_set_chain_function (GstPad *pad,
}
/**
* gst_pad_set_pull_function:
* gst_pad_set_get_function:
* @pad: the pad to set the get function for
* @get: the get function
*
@ -351,7 +351,6 @@ gst_pad_push_func(GstPad *pad, GstBuffer *buf)
}
}
/**
* gst_pad_chain:
* @pad: the pad to chain
@ -612,7 +611,7 @@ gst_pad_set_caps (GstPad *pad,
*
* get the capabilities of this pad
*
* Return; the capabilities of this pad
* Returns: the capabilities of this pad
*/
GstCaps *
gst_pad_get_caps (GstPad *pad)
@ -806,6 +805,14 @@ GstBuffer *gst_pad_pullregion(GstPad *pad,gulong offset,gulong size) {
*
*/
/**
* gst_padtemplate_new:
* @factory: the padfactory to use
*
* creates a new padtemplate from the factory
*
* Returns: the new padtemplate
*/
GstPadTemplate*
gst_padtemplate_new (GstPadFactory *factory)
{
@ -832,6 +839,17 @@ gst_padtemplate_new (GstPadFactory *factory)
return new;
}
/**
* gst_padtemplate_create:
* @name_template: the name template
* @direction: the direction for the template
* @presence: the presence of the pad
* @caps: the capabilities for the template
*
* creates a new padtemplate from the given arguments
*
* Returns: the new padtemplate
*/
GstPadTemplate*
gst_padtemplate_create (gchar *name_template,
GstPadDirection direction, GstPadPresence presence,
@ -850,6 +868,15 @@ gst_padtemplate_create (gchar *name_template,
}
/**
* gst_padtemplate_save_thyself:
* @pad: the padtemplate to save
* @parent: the parent XML tree
*
* saves the padtemplate into XML
*
* Returns: the new XML tree
*/
xmlNodePtr
gst_padtemplate_save_thyself (GstPadTemplate *pad, xmlNodePtr parent)
{
@ -865,6 +892,14 @@ gst_padtemplate_save_thyself (GstPadTemplate *pad, xmlNodePtr parent)
return parent;
}
/**
* gst_padtemplate_load_thyself:
* @parent: the source XML tree
*
* loads a padtemplate from the XML tree
*
* Returns: the new padtemplate
*/
GstPadTemplate*
gst_padtemplate_load_thyself (xmlNodePtr parent)
{

View file

@ -40,7 +40,7 @@ extern "C" {
#define GST_IS_PAD(obj) (GTK_CHECK_TYPE ((obj), GST_TYPE_PAD))
#define GST_IS_PAD_CLASS(obj) (GTK_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
// quick test to see if the pad is connected
/* quick test to see if the pad is connected */
#define GST_PAD_CONNECTED(pad) ((pad) && (pad)->peer != NULL)
#define GST_PAD_CAN_PULL(pad) ((pad) && (pad)->pullfunc != NULL)
@ -101,7 +101,7 @@ struct _GstPad {
GstObject *parent;
GList *ghostparents;
GstPadTemplate *padtemplate; // the template for this pad
GstPadTemplate *padtemplate; /* the template for this pad */
};
struct _GstPadClass {

View file

@ -48,8 +48,8 @@ typedef struct _GstPipelineClass GstPipelineClass;
struct _GstPipeline {
GstBin bin;
GstElement *src; // we only allow one src element
GList *sinks; // and multiple sinks
GstElement *src; /* we only allow one src element */
GList *sinks; /* and multiple sinks */
};
struct _GstPipelineClass {

View file

@ -91,7 +91,7 @@ props_compare_func (gconstpointer a,
*
* Register the factory.
*
* Returns: The registered capability
* Returns: The new property created from the factory
*/
GstProps *
gst_props_register (GstPropsFactory factory)
@ -158,6 +158,15 @@ gst_props_register (GstPropsFactory factory)
return props;
}
/**
* gst_props_new:
* @entry: the property entries for the property
* @...: the property entries for the property
*
* Create a new property from the list of entries
*
* Returns: The new property created from the list of entries
*/
GstProps *
gst_props_new (GstPropsFactoryEntry entry, ...)
{
@ -192,6 +201,15 @@ gst_props_new (GstPropsFactoryEntry entry, ...)
return gst_props_register (factory);
}
/**
* gst_props_merge:
* @props: the property to merge into
* @tomerge: the property to merge
*
* Merge the properties of tomerge into props
*
* Returns: The new merged property
*/
GstProps*
gst_props_merge (GstProps *props, GstProps *tomerge)
{
@ -313,8 +331,8 @@ gst_props_entry_check_compatibility (GstPropsEntry *entry1, GstPropsEntry *entry
/**
* gst_props_check_compatibility:
* @fromprops: a capabilty
* @toprops: a capabilty
* @fromprops: a property
* @toprops: a property
*
* Checks whether two capabilities are compatible
*
@ -411,6 +429,15 @@ gst_props_save_thyself_func (GstPropsEntry *entry, xmlNodePtr parent)
return parent;
}
/**
* gst_props_save_thyself:
* @props: a property to save
* @parent: the parent XML tree
*
* saves the property into an XML representation
*
* Returns: the new XML tree
*/
xmlNodePtr
gst_props_save_thyself (GstProps *props, xmlNodePtr parent)
{
@ -472,6 +499,14 @@ gst_props_load_thyself_func (xmlNodePtr field)
return entry;
}
/**
* gst_props_load_thyself:
* @parent: the XML tree to load from
*
* creates a new property out of an XML tree
*
* Returns: the new property
*/
GstProps*
gst_props_load_thyself (xmlNodePtr parent)
{

View file

@ -65,7 +65,7 @@ GstProps* gst_props_new (GstPropsFactoryEntry entry, ...);
GstProps* gst_props_merge (GstProps *props, GstProps *tomerge);
gboolean gst_props_check_compatibility (GstProps *props1, GstProps *props2);
gboolean gst_props_check_compatibility (GstProps *fromprops, GstProps *toprops);
xmlNodePtr gst_props_save_thyself (GstProps *props, xmlNodePtr parent);
GstProps* gst_props_load_thyself (xmlNodePtr parent);

View file

@ -17,7 +17,7 @@
* Boston, MA 02111-1307, USA.
*/
#define GST_DEBUG_ENABLED
//#define GST_DEBUG_ENABLED
#include "gstscheduler.h"
#include "gstdebug.h"

View file

@ -49,7 +49,7 @@ typedef enum {
typedef struct _GstSrc GstSrc;
typedef struct _GstSrcClass GstSrcClass;
#define GST_SRC_ASYNC(obj) (GST_FLAG_IS_SET(obj,GST_SRC_ASYNC))
#define GST_SRC_IS_ASYNC(obj) (GST_FLAG_IS_SET(obj,GST_SRC_ASYNC))
struct _GstSrc {
GstElement element;

View file

@ -187,7 +187,7 @@ gst_thread_get_arg (GtkObject *object,
*
* Create a new thrad with the given name
*
* Returns; The new thread
* Returns: The new thread
*/
GstElement*
gst_thread_new (guchar *name)

View file

@ -36,22 +36,22 @@ struct _OverlayClip {
};
struct _MetaDGA {
// the base address of the screen
/* the base address of the screen */
void *base;
// the dimensions of the screen
/* the dimensions of the screen */
int swidth, sheight;
// the number of bytes in a line
/* the number of bytes in a line */
int bytes_per_line;
};
struct _MetaOverlay {
// the position of the window
/* the position of the window */
int wx, wy;
// a reference to the object sending overlay change events
/* a reference to the object sending overlay change events */
GtkWidget *overlay_element;
// the number of overlay regions
/* the number of overlay regions */
int clip_count;
// the overlay regions of the display window
/* the overlay regions of the display window */
struct _OverlayClip overlay_clip[32];
gint width;
@ -67,12 +67,12 @@ struct _MetaVideoRaw {
/* formatting information */
GstColorSpaceType format;
GdkVisual *visual;
// dimensions of the video buffer
/* dimensions of the video buffer */
gint width;
gint height;
// a pointer to the overlay info if the sink supports this
/* a pointer to the overlay info if the sink supports this */
MetaOverlay *overlay_info;
// a pointer to the DGA info if the sink supports this
/* a pointer to the DGA info if the sink supports this */
MetaDGA *dga_info;
};