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

API docs updates

Browse source 
Original commit message from CVS:
API docs updates
This commit is contained in:
Wim Taymans 2001-01-19 22:15:21 +00:00
parent 74f8050844
commit 9b3f1277ce
21 changed files with 573 additions and 126 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/gst/Makefile.am
View file

@ -13,6 +13,9 @@ EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt $
HTML_DIR=$(datadir)/gstreamer/html HTML_DIR=$(datadir)/gstreamer/html
GST_LIBS += ../../gst/elements/libgstelements.la
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
tmpl_sources = \ tmpl_sources = \
@ -85,7 +88,9 @@ gstreamer-decl.txt:
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="" gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers=""
scanobj: $(srcdir)/$(DOC_MODULE).types scanobj: $(srcdir)/$(DOC_MODULE).types
-CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" gtkdoc-scanobj --module=$(DOC_MODULE) rm gstreamer-scan.o; ln -s gstreamer-scan.lo gstreamer-scan.o
env CC="$(LIBTOOL) $(CC)" CFLAGS="$(GST_CFLAGS) $(GLIB_CFLAGS) $(XML_CFLAGS) -I../../" LDFLAGS="$(GST_LIBS)"\
gtkdoc-scanobj --module=$(DOC_MODULE)
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
tmpl: scanobj gstreamer-decl.txt tmpl: scanobj gstreamer-decl.txt

12
docs/gst/gstreamer-docs.sgml
View file

@ -15,7 +15,6 @@
<!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml"> <!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
<!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml"> <!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml">
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml"> <!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
<!entity GstTee SYSTEM "sgml/gsttee.sgml">
<!entity GstThread SYSTEM "sgml/gstthread.sgml"> <!entity GstThread SYSTEM "sgml/gstthread.sgml">
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml"> <!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
<!entity GstType SYSTEM "sgml/gsttype.sgml"> <!entity GstType SYSTEM "sgml/gsttype.sgml">
@ -23,6 +22,8 @@
<!entity GstProps SYSTEM "sgml/gstprops.sgml"> <!entity GstProps SYSTEM "sgml/gstprops.sgml">
<!entity GstUtils SYSTEM "sgml/gstutils.sgml"> <!entity GstUtils SYSTEM "sgml/gstutils.sgml">
<!entity GstXml SYSTEM "sgml/gstxml.sgml"> <!entity GstXml SYSTEM "sgml/gstxml.sgml">
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
<!entity cothreads SYSTEM "sgml/cothreads.sgml"> <!entity cothreads SYSTEM "sgml/cothreads.sgml">
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml"> <!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
@ -37,8 +38,7 @@
<!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml"> <!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml"> <!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
<!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml"> <!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml"> <!entity GstTee SYSTEM "sgml/gsttee.sgml">
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
<!entity audioraw SYSTEM "sgml/audioraw.sgml"> <!entity audioraw SYSTEM "sgml/audioraw.sgml">
<!entity spectrum SYSTEM "sgml/spectrum.sgml"> <!entity spectrum SYSTEM "sgml/spectrum.sgml">
@ -72,7 +72,8 @@ with some more specialized elements.</para>
&GstPad; &GstPad;
&GstPlugin; &GstPlugin;
&GstThread; &GstThread;
&GstTee; &GstQueue;
&GstTypeFind;
&GstType; &GstType;
&GstCaps; &GstCaps;
@ -136,9 +137,8 @@ with some more specialized elements.</para>
&GstPipefilter; &GstPipefilter;
&GstIdentity; &GstIdentity;
&GstQueue;
&GstTypeFind; &GstTee;
</chapter> </chapter>
<chapter id="metatdata-types"> <chapter id="metatdata-types">

80
docs/gst/gstreamer-sections.txt
View file

@ -19,10 +19,6 @@ cothread_main
cothread_set_data cothread_set_data
cothread_get_data cothread_get_data
<SUBSECTION Standard> <SUBSECTION Standard>
SETUP_STACK
GET_SP
JUMP
SET_SP
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -36,7 +32,7 @@ gst_main_quit
<SECTION> <SECTION>
<FILE>gstinfo</FILE> <FILE>gstinfo</FILE>
<TITLE>gstinfo</TITLE> <TITLE>GstInfo</TITLE>
gst_get_category_name gst_get_category_name
gst_info_get_categories gst_info_get_categories
gst_info_set_categories gst_info_set_categories
@ -109,9 +105,24 @@ GST_IS_BIN
GST_IS_BIN_CLASS GST_IS_BIN_CLASS
gst_bin_details gst_bin_details
gst_bin_use_cothreads gst_bin_use_cothreads
gst_bin_remove_eos_provider
gst_bin_add_eos_provider
_GstBinChain _GstBinChain
</SECTION> </SECTION>
<SECTION>
<FILE>gstparse</FILE>
<TITLE>GstParse</TITLE>
gst_parse_launch
</SECTION>
<SECTION>
<FILE>gstarch</FILE>
GST_ARCH_CALL
GST_ARCH_SET_SP
GST_ARCH_SETUP_STACK
</SECTION>
<SECTION> <SECTION>
<FILE>gstbuffer</FILE> <FILE>gstbuffer</FILE>
<TITLE>GstBuffer</TITLE> <TITLE>GstBuffer</TITLE>
@ -193,8 +204,11 @@ gst_element_add_pad
gst_element_get_pad gst_element_get_pad
gst_element_get_pad_list gst_element_get_pad_list
gst_element_get_padtemplate_list gst_element_get_padtemplate_list
gst_element_get_padtemplate_by_name
gst_element_add_ghost_pad gst_element_add_ghost_pad
gst_element_remove_ghost_pad gst_element_remove_ghost_pad
gst_element_request_pad
gst_element_request_pad_by_name
gst_element_connect gst_element_connect
gst_element_disconnect gst_element_disconnect
gst_element_set_state gst_element_set_state
@ -224,6 +238,7 @@ GST_ELEMENT_CLASS
GST_IS_ELEMENT GST_IS_ELEMENT
GST_IS_ELEMENT_CLASS GST_IS_ELEMENT_CLASS
gst_element_get_type gst_element_get_type
gst_element_announce_eos
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -298,8 +313,17 @@ GST_IS_OBJECT_CLASS
<SECTION> <SECTION>
<FILE>gstpad</FILE> <FILE>gstpad</FILE>
<TITLE>GstPad</TITLE> <TITLE>GstPad</TITLE>
GST_PAD_NAME
GST_PAD_ELEMENT_PRIVATE
GST_PAD_PARENT
GST_PAD_PADTEMPLATE
GST_PAD_REALIZE
GST_PAD_DIRECTION
GST_PAD_CAPS
GST_PAD_PEER
GST_PAD_CONNECTED GST_PAD_CONNECTED
GST_PAD_CAN_PULL GST_PAD_CAN_PULL
GstPad GstPad
GstPadChainFunction GstPadChainFunction
GstPadGetFunction GstPadGetFunction
@ -328,6 +352,8 @@ gst_pad_get_caps_by_name
gst_pad_check_compatibility gst_pad_check_compatibility
gst_pad_set_name gst_pad_set_name
gst_pad_get_name gst_pad_get_name
gst_pad_set_element_private
gst_pad_get_element_private
gst_pad_set_parent gst_pad_set_parent
gst_pad_get_parent gst_pad_get_parent
gst_pad_add_ghost_parent gst_pad_add_ghost_parent
@ -348,15 +374,32 @@ gst_pad_eos
gst_pad_save_thyself gst_pad_save_thyself
gst_pad_load_and_connect gst_pad_load_and_connect
GstRealPad
GST_RPAD_DIRECTION
GST_RPAD_CAPS
GST_RPAD_PEER
GST_RPAD_BUFPEN
GST_RPAD_CHAINFUNC
GST_RPAD_GETFUNC
GST_RPAD_GETREGIONFUNC
GST_RPAD_PUSHFUNC
GST_RPAD_PULLFUNC
GST_RPAD_PULLREGIONFUNC
GST_RPAD_QOSFUNC
GST_RPAD_EOSFUNC
GST_GPAD_REALPAD
GstGhostPad
GstPadFactoryEntry GstPadFactoryEntry
GstPadFactory[] GstPadFactory[]
GST_PAD_FACTORY_SOMETIMES GST_PAD_FACTORY_SOMETIMES
GST_PAD_FACTORY_ALWAYS GST_PAD_FACTORY_ALWAYS
GST_PAD_FACTORY_REQUEST
GST_PAD_FACTORY_SINK GST_PAD_FACTORY_SINK
GST_PAD_FACTORY_SRC GST_PAD_FACTORY_SRC
GST_PAD_FACTORY_CAPS GST_PAD_FACTORY_CAPS
GstPadPresence GstPadPresence
GstPadTemplate GstPadTemplate
gst_padtemplate_new gst_padtemplate_new
@ -373,6 +416,22 @@ GST_IS_PAD
GST_IS_PAD_CLASS GST_IS_PAD_CLASS
gst_pad_get_type gst_pad_get_type
GstRealPadClass
GST_TYPE_REAL_PAD
GST_REAL_PAD
GST_REAL_PAD_CLASS
GST_IS_REAL_PAD
GST_IS_REAL_PAD_CLASS
gst_real_pad_get_type
GstGhostPadClass
GST_TYPE_GHOST_PAD
GST_GHOST_PAD
GST_GHOST_PAD_CLASS
GST_IS_GHOST_PAD
GST_IS_GHOST_PAD_CLASS
gst_ghost_pad_get_type
GstPadTemplateClass GstPadTemplateClass
GST_TYPE_PADTEMPLATE GST_TYPE_PADTEMPLATE
GST_PADTEMPLATE GST_PADTEMPLATE
@ -456,12 +515,11 @@ gst_plugin_save_thyself
<SECTION> <SECTION>
<FILE>gsttee</FILE> <FILE>gsttee</FILE>
<TITLE>GstTee</TITLE> <TITLE>GstTee</TITLE>
GstTee
gst_tee_new
gst_tee_chain
gst_tee_new_pad
<SUBSECTION Standard> <SUBSECTION Standard>
gst_tee_factory_init
GstTee
gst_tee_get_type gst_tee_get_type
gst_tee_details
GstTeeClass GstTeeClass
GST_TYPE_TEE GST_TYPE_TEE
GST_TEE GST_TEE
@ -609,6 +667,8 @@ GST_IS_XML_CLASS
GST_TYPE_XML GST_TYPE_XML
GST_XML_CLASS GST_XML_CLASS
GstXMLClass GstXMLClass
xmlChildrenNode
xmlRootNode
</SECTION> </SECTION>
<SECTION> <SECTION>

40
docs/gst/tmpl/gstarch.sgml Normal file
View file

@ -0,0 +1,40 @@
<!-- ##### SECTION Title ##### -->
gstarch
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_ARCH_CALL ##### -->
<para>
</para>
@target:
<!-- ##### MACRO GST_ARCH_SET_SP ##### -->
<para>
</para>
@stackpointer:
<!-- ##### MACRO GST_ARCH_SETUP_STACK ##### -->
<para>
</para>
@sp:

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

@ -289,6 +289,16 @@ circumstances.
@Returns: @Returns:
<!-- ##### FUNCTION gst_element_get_padtemplate_by_name ##### -->
<para>
</para>
@element:
@name:
@Returns:
<!-- ##### FUNCTION gst_element_add_ghost_pad ##### --> <!-- ##### FUNCTION gst_element_add_ghost_pad ##### -->
<para> <para>
@ -307,6 +317,28 @@ circumstances.
@pad: @pad:
<!-- ##### FUNCTION gst_element_request_pad ##### -->
<para>
</para>
@element:
@templ:
@Returns:
<!-- # Unused Parameters # -->
@temp:
<!-- ##### FUNCTION gst_element_request_pad_by_name ##### -->
<para>
</para>
@element:
@name:
@Returns:
<!-- ##### FUNCTION gst_element_connect ##### --> <!-- ##### FUNCTION gst_element_connect ##### -->
<para> <para>
@ -410,8 +442,9 @@ circumstances.
</para> </para>
@elementfactory: @elementfactory:
@temp: @templ:
<!-- # Unused Parameters # --> <!-- # Unused Parameters # -->
@temp:
@pad: @pad:

2
docs/gst/tmpl/gstfakesrc.sgml
View file

@ -36,7 +36,7 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</para> </para>
<!-- ##### ARG GstFakeSrc:patern ##### --> <!-- ##### ARG GstFakeSrc:pattern ##### -->
<para> <para>
</para> </para>

5
docs/gst/tmpl/gstidentity.sgml
View file

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

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

@ -16,6 +16,71 @@ connections.
</para> </para>
<!-- ##### MACRO GST_PAD_NAME ##### -->
<para>
Get the name of the pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_ELEMENT_PRIVATE ##### -->
<para>
Get the private data set by the element that owns the pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_PARENT ##### -->
<para>
Get the parent element of this pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_PADTEMPLATE ##### -->
<para>
Get the padtemplate that was used to create this pad. NULL if no padtemplate
was used.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_REALIZE ##### -->
<para>
Return the real pad of this pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_DIRECTION ##### -->
<para>
Get the pad direction.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_CAPS ##### -->
<para>
Get the capabilities of a pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_PEER ##### -->
<para>
Get the peerpad of this pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_CONNECTED ##### --> <!-- ##### MACRO GST_PAD_CONNECTED ##### -->
<para> <para>
Is this pad connected. Is this pad connected.
@ -156,9 +221,11 @@ Destroy the pad.
</para> </para>
@temp: @templ:
@name: @name:
@Returns: @Returns:
<!-- # Unused Parameters # -->
@temp:
<!-- ##### FUNCTION gst_pad_get_direction ##### --> <!-- ##### FUNCTION gst_pad_get_direction ##### -->
@ -271,6 +338,24 @@ Destroy the pad.
@Returns: @Returns:
<!-- ##### FUNCTION gst_pad_set_element_private ##### -->
<para>
</para>
@pad:
@priv:
<!-- ##### FUNCTION gst_pad_get_element_private ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_set_parent ##### --> <!-- ##### FUNCTION gst_pad_set_parent ##### -->
<para> <para>
@ -447,6 +532,139 @@ Destroy the pad.
@elements: @elements:
<!-- ##### STRUCT GstRealPad ##### -->
<para>
</para>
@pad:
@caps:
@direction:
@threadstate:
@peer:
@bufpen:
@chainfunc:
@getfunc:
@getregionfunc:
@qosfunc:
@eosfunc:
@pushfunc:
@pullfunc:
@pullregionfunc:
@ghostparents:
<!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
<para>
Get the direction of the real pad.
</para>
@pad: the realpad to query.
<!-- ##### MACRO GST_RPAD_CAPS ##### -->
<para>
Get the caps of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_PEER ##### -->
<para>
Get the peer element of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_BUFPEN ##### -->
<para>
Get the bufpen of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_CHAINFUNC ##### -->
<para>
Get the chain function of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_GETFUNC ##### -->
<para>
Get get getfunction of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_GETREGIONFUNC ##### -->
<para>
Get the getregion function of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_PUSHFUNC ##### -->
<para>
Get the pushfunction of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_PULLFUNC ##### -->
<para>
Get the pullfunction of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_PULLREGIONFUNC ##### -->
<para>
Get the pullregion function of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_QOSFUNC ##### -->
<para>
Get the QoS function of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_EOSFUNC ##### -->
<para>
Get the EOS function of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
<para>
Get the real pad of this ghost pad.
</para>
@pad: the real pad to query.
<!-- ##### STRUCT GstGhostPad ##### -->
<para>
</para>
@pad:
@realpad:
<!-- ##### TYPEDEF GstPadFactoryEntry ##### --> <!-- ##### TYPEDEF GstPadFactoryEntry ##### -->
<para> <para>
Defines an entry for a padfactory. Defines an entry for a padfactory.
@ -475,6 +693,14 @@ Use this in the factory definition.
<!-- ##### MACRO GST_PAD_FACTORY_REQUEST ##### -->
<para>
Indicates that this pad will be available on request. Use
this in the factory definition.
</para>
<!-- ##### MACRO GST_PAD_FACTORY_SINK ##### --> <!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
<para> <para>
Indicates a sinkpad for the padfactory. Indicates a sinkpad for the padfactory.
@ -504,6 +730,7 @@ Indicates when this pad will become available.
@GST_PAD_ALWAYS: the pad is always available @GST_PAD_ALWAYS: the pad is always available
@GST_PAD_SOMETIMES: the pad will become available depending on the media stream @GST_PAD_SOMETIMES: the pad will become available depending on the media stream
@GST_PAD_REQUEST:
<!-- ##### STRUCT GstPadTemplate ##### --> <!-- ##### STRUCT GstPadTemplate ##### -->
<para> <para>
@ -551,13 +778,10 @@ Indicates when this pad will become available.
</para> </para>
@pad: @templ:
@parent: @parent:
@Returns: @Returns:
<!-- # Unused Parameters # -->
@pad:
<!-- ##### ARG GstPad:active ##### -->
<para>
Indicates this pad is active
</para>

26
docs/gst/tmpl/gstparse.sgml Normal file
View file

@ -0,0 +1,26 @@
<!-- ##### SECTION Title ##### -->
GstParse
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_parse_launch ##### -->
<para>
</para>
@cmdline:
@parent:
@Returns:

5
docs/gst/tmpl/gstqueue.sgml
View file

@ -37,3 +37,8 @@ blocks.
</para> </para>
<!-- ##### ARG GstQueue:timeout ##### -->
<para>
</para>

42
docs/gst/tmpl/gstreamer-unused.sgml
View file

@ -758,6 +758,12 @@ GstGetbits
@name: @name:
@Returns: @Returns:
<!-- ##### STRUCT GstTee ##### -->
<para>
</para>
<!-- ##### MACRO GST_ELEMENT_CLASS ##### --> <!-- ##### MACRO GST_ELEMENT_CLASS ##### -->
<para> <para>
@ -908,6 +914,14 @@ This macro returns the entire set of flags for the object.
@Returns: @Returns:
<!-- ##### FUNCTION gst_tee_new_pad ##### -->
<para>
</para>
@tee:
@Returns:
<!-- ##### MACRO GST_TYPE_AUDIOSRC ##### --> <!-- ##### MACRO GST_TYPE_AUDIOSRC ##### -->
<para> <para>
@ -1221,6 +1235,14 @@ This macro usets the given flags.
@audiosink: @audiosink:
<!-- ##### FUNCTION gst_tee_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### MACRO GST_IS_OBJECT_CLASS ##### --> <!-- ##### MACRO GST_IS_OBJECT_CLASS ##### -->
<para> <para>
@ -1553,6 +1575,12 @@ Query the element for the current mime type
<!-- ##### ARG GstFakeSrc:patern ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Long_Description ##### --> <!-- ##### SECTION ./tmpl/gstgetbits.sgml:Long_Description ##### -->
<para> <para>
@ -1752,6 +1780,14 @@ Flags for the GstSrc element
@Returns: @Returns:
<!-- ##### FUNCTION gst_tee_chain ##### -->
<para>
</para>
@pad:
@buf:
<!-- ##### TYPEDEF GstPropsListFactory[] ##### --> <!-- ##### TYPEDEF GstPropsListFactory[] ##### -->
<para> <para>
@ -1794,6 +1830,12 @@ Flags for the GstSrc element
@pad: @pad:
@buf: @buf:
<!-- ##### ARG GstPad:active ##### -->
<para>
Indicates this pad is active
</para>
<!-- ##### MACRO GST_OBJECT_CLASS ##### --> <!-- ##### MACRO GST_OBJECT_CLASS ##### -->
<para> <para>

30
docs/gst/tmpl/gsttee.sgml
View file

@ -14,36 +14,8 @@ A tee can be used to split out the filter graph.
</para> </para>
<!-- ##### STRUCT GstTee ##### --> <!-- ##### ARG GstTee:num_pads ##### -->
<para> <para>
</para> </para>
<!-- ##### FUNCTION gst_tee_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_tee_chain ##### -->
<para>
</para>
@pad:
@buf:
<!-- ##### FUNCTION gst_tee_new_pad ##### -->
<para>
</para>
@tee:
@Returns:

2
gst/cothreads.h
View file

@ -51,7 +51,7 @@ struct _cothread_state {
int flags; int flags;
void *sp; void *sp;
// is this needed any more? /* is this needed any more? */
void *top_sp; void *top_sp;
void *pc; void *pc;
jmp_buf jmp; jmp_buf jmp;

30
gst/gstelement.c
View file

@ -336,24 +336,48 @@ gst_element_get_padtemplate_by_name (GstElement *element, const guchar *name)
return NULL; return NULL;
} }
/**
* gst_element_request_pad:
* @element: element to request a new pad from
* @templ: the padtemplate specifuing the pad to get.
*
* Request a new pad from the element. The template will
* be used to decide what type of pad to create. This function
* is typically used for elements with a padtemplate with presence
* GST_PAD_REQUEST.
*
* Returns: the new pad that was created.
*/
GstPad* GstPad*
gst_element_request_pad (GstElement *element, GstPadTemplate *temp) gst_element_request_pad (GstElement *element, GstPadTemplate *templ)
{ {
GstPad *newpad = NULL; GstPad *newpad = NULL;
GstElementClass *oclass; GstElementClass *oclass;
g_return_val_if_fail (element != NULL, NULL); g_return_val_if_fail (element != NULL, NULL);
g_return_val_if_fail (GST_IS_ELEMENT (element), NULL); g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
g_return_val_if_fail (temp != NULL, NULL); g_return_val_if_fail (templ != NULL, NULL);
/* call the state change function so it can set the state */ /* call the state change function so it can set the state */
oclass = GST_ELEMENT_CLASS (GTK_OBJECT (element)->klass); oclass = GST_ELEMENT_CLASS (GTK_OBJECT (element)->klass);
if (oclass->request_new_pad) if (oclass->request_new_pad)
newpad = (oclass->request_new_pad)(element, temp); newpad = (oclass->request_new_pad)(element, templ);
return newpad; return newpad;
} }
/**
* gst_element_request_pad_by_name:
* @element: element to request a new pad from
* @name: the name of the padtemplate to use.
*
* Request a new pad from the element. The name argument will
* be used to decide what padtemplate to use. This function
* is typically used for elements with a padtemplate with presence
* GST_PAD_REQUEST.
*
* Returns: the new pad that was created.
*/
GstPad* GstPad*
gst_element_request_pad_by_name (GstElement *element, const gchar *name) gst_element_request_pad_by_name (GstElement *element, const gchar *name)
{ {

6
gst/gstelement.h
View file

@ -160,7 +160,7 @@ struct _GstElementClass {
/* change the element state */ /* change the element state */
GstElementStateReturn (*change_state) (GstElement *element); GstElementStateReturn (*change_state) (GstElement *element);
/* request a new pad */ /* request a new pad */
GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *temp); GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ);
/* create or read XML representation of self */ /* create or read XML representation of self */
xmlNodePtr (*save_thyself) (GstElement *element, xmlNodePtr parent); xmlNodePtr (*save_thyself) (GstElement *element, xmlNodePtr parent);
@ -207,7 +207,7 @@ GstPadTemplate* gst_element_get_padtemplate_by_name (GstElement *element, const
void gst_element_add_ghost_pad (GstElement *element, GstPad *pad); void gst_element_add_ghost_pad (GstElement *element, GstPad *pad);
void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad); void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
GstPad* gst_element_request_pad (GstElement *element, GstPadTemplate *temp); GstPad* gst_element_request_pad (GstElement *element, GstPadTemplate *templ);
GstPad* gst_element_request_pad_by_name (GstElement *element, const gchar *name); GstPad* gst_element_request_pad_by_name (GstElement *element, const gchar *name);
void gst_element_connect (GstElement *src, const gchar *srcpadname, void gst_element_connect (GstElement *src, const gchar *srcpadname,
@ -244,7 +244,7 @@ GstElementFactory* gst_elementfactory_find (const gchar *name);
GList* gst_elementfactory_get_list (void); GList* gst_elementfactory_get_list (void);
void gst_elementfactory_add_padtemplate (GstElementFactory *elementfactory, void gst_elementfactory_add_padtemplate (GstElementFactory *elementfactory,
GstPadTemplate *temp); GstPadTemplate *templ);
gboolean gst_elementfactory_can_src_caps (GstElementFactory *factory, gboolean gst_elementfactory_can_src_caps (GstElementFactory *factory,
GstCaps *caps); GstCaps *caps);

8
gst/gstelementfactory.c
View file

@ -204,18 +204,18 @@ gst_elementfactory_make (const gchar *factoryname, const gchar *name)
/** /**
* gst_elementfactory_add_padtemplate : * gst_elementfactory_add_padtemplate :
* @elementfactory: factory to add the src id to * @elementfactory: factory to add the src id to
* @temp: the padtemplate to add * @templ: the padtemplate to add
* *
* Add the given padtemplate to this elementfactory. * Add the given padtemplate to this elementfactory.
*/ */
void void
gst_elementfactory_add_padtemplate (GstElementFactory *factory, gst_elementfactory_add_padtemplate (GstElementFactory *factory,
GstPadTemplate *temp) GstPadTemplate *templ)
{ {
g_return_if_fail(factory != NULL); g_return_if_fail(factory != NULL);
g_return_if_fail(temp != NULL); g_return_if_fail(templ != NULL);
factory->padtemplates = g_list_append (factory->padtemplates, temp); factory->padtemplates = g_list_append (factory->padtemplates, templ);
factory->numpadtemplates++; factory->numpadtemplates++;
} }

32
gst/gstpad.c
View file

@ -234,7 +234,7 @@ gst_pad_new (gchar *name,
/** /**
* gst_pad_new_from_template: * gst_pad_new_from_template:
* @temp: the pad template to use * @templ: the pad template to use
* @name: the name of the element * @name: the name of the element
* *
* Create a new pad with given name from the given template. * Create a new pad with given name from the given template.
@ -1023,7 +1023,7 @@ gst_padtemplate_create (gchar *name_template,
/** /**
* gst_padtemplate_save_thyself: * gst_padtemplate_save_thyself:
* @pad: the padtemplate to save * @templ: the padtemplate to save
* @parent: the parent XML tree * @parent: the parent XML tree
* *
* Saves the padtemplate into XML. * Saves the padtemplate into XML.
@ -1031,16 +1031,16 @@ gst_padtemplate_create (gchar *name_template,
* Returns: the new XML tree * Returns: the new XML tree
*/ */
xmlNodePtr xmlNodePtr
gst_padtemplate_save_thyself (GstPadTemplate *pad, xmlNodePtr parent) gst_padtemplate_save_thyself (GstPadTemplate *templ, xmlNodePtr parent)
{ {
xmlNodePtr subtree; xmlNodePtr subtree;
GList *caps; GList *caps;
guchar *presence; guchar *presence;
xmlNewChild(parent,NULL,"nametemplate", pad->name_template); xmlNewChild(parent,NULL,"nametemplate", templ->name_template);
xmlNewChild(parent,NULL,"direction", (pad->direction == GST_PAD_SINK? "sink":"src")); xmlNewChild(parent,NULL,"direction", (templ->direction == GST_PAD_SINK? "sink":"src"));
switch (pad->presence) { switch (templ->presence) {
case GST_PAD_ALWAYS: case GST_PAD_ALWAYS:
presence = "always"; presence = "always";
break; break;
@ -1056,7 +1056,7 @@ gst_padtemplate_save_thyself (GstPadTemplate *pad, xmlNodePtr parent)
} }
xmlNewChild(parent,NULL,"presence", presence); xmlNewChild(parent,NULL,"presence", presence);
caps = pad->caps; caps = templ->caps;
while (caps) { while (caps) {
GstCaps *cap = (GstCaps *)caps->data; GstCaps *cap = (GstCaps *)caps->data;
@ -1207,12 +1207,30 @@ gst_pad_select(GstPad *nextpad, ...) {
*/ */
/**
* gst_pad_set_element_private:
* @pad: the pad to set the private data to
* @priv: The private data to attach to the pad
*
* Set the given private data pointer to the pad. This
* function can only be used by the element that own the
* pad.
*/
void void
gst_pad_set_element_private (GstPad *pad, gpointer priv) gst_pad_set_element_private (GstPad *pad, gpointer priv)
{ {
pad->element_private = priv; pad->element_private = priv;
} }
/**
* gst_pad_get_element_private:
* @pad: the pad to get the private data of
*
* Get the private data of a pad. The private data can
* only be set by the parent element of this pad.
*
* Returns: a pointer to the private data.
*/
gpointer gpointer
gst_pad_get_element_private (GstPad *pad) gst_pad_get_element_private (GstPad *pad)
{ {

6
gst/gstpad.h
View file

@ -213,7 +213,7 @@ struct _GstPadTemplateClass {
GstObjectClass parent_class; GstObjectClass parent_class;
/* signal callbacks */ /* signal callbacks */
void (*pad_created) (GstPadTemplate *temp, GstPad *pad); void (*pad_created) (GstPadTemplate *templ, GstPad *pad);
}; };
@ -237,7 +237,7 @@ GtkType gst_ghost_pad_get_type (void);
GstPad* gst_pad_new (gchar *name, GstPadDirection direction); GstPad* gst_pad_new (gchar *name, GstPadDirection direction);
#define gst_pad_destroy(pad) gst_object_destroy (GST_OBJECT (pad)) #define gst_pad_destroy(pad) gst_object_destroy (GST_OBJECT (pad))
GstPad* gst_pad_new_from_template (GstPadTemplate *temp, gchar *name); GstPad* gst_pad_new_from_template (GstPadTemplate *templ, gchar *name);
GstPadDirection gst_pad_get_direction (GstPad *pad); GstPadDirection gst_pad_get_direction (GstPad *pad);
@ -309,7 +309,7 @@ GstPadTemplate* gst_padtemplate_create (gchar *name_template,
GstPadDirection direction, GstPadPresence presence, GstPadDirection direction, GstPadPresence presence,
GList *caps); GList *caps);
xmlNodePtr gst_padtemplate_save_thyself (GstPadTemplate *pad, xmlNodePtr parent); xmlNodePtr gst_padtemplate_save_thyself (GstPadTemplate *templ, xmlNodePtr parent);
GstPadTemplate* gst_padtemplate_load_thyself (xmlNodePtr parent); GstPadTemplate* gst_padtemplate_load_thyself (xmlNodePtr parent);
#ifdef __cplusplus #ifdef __cplusplus

9
test/mp1parse.c
View file

@ -26,8 +26,6 @@ void new_pad_created(GstElement *parse,GstPad *pad,GstElement *pipeline) {
// connect to audio pad // connect to audio pad
//if (0) { //if (0) {
if (strncmp(gst_pad_get_name(pad), "audio_", 6) == 0) { if (strncmp(gst_pad_get_name(pad), "audio_", 6) == 0) {
gst_plugin_load("mp3parse");
gst_plugin_load("mpg123");
// construct internal pipeline elements // construct internal pipeline elements
parse_audio = gst_elementfactory_make("mp3parse","parse_audio"); parse_audio = gst_elementfactory_make("mp3parse","parse_audio");
g_return_if_fail(parse_audio != NULL); g_return_if_fail(parse_audio != NULL);
@ -68,10 +66,6 @@ void new_pad_created(GstElement *parse,GstPad *pad,GstElement *pipeline) {
} else if (strncmp(gst_pad_get_name(pad), "video_", 6) == 0) { } else if (strncmp(gst_pad_get_name(pad), "video_", 6) == 0) {
//} else if (0) { //} else if (0) {
gst_plugin_load("mp1videoparse");
gst_plugin_load(VIDEO_DECODER);
gst_plugin_load("videoscale");
gst_plugin_load("videosink");
// construct internal pipeline elements // construct internal pipeline elements
parse_video = gst_elementfactory_make("mp1videoparse","parse_video"); parse_video = gst_elementfactory_make("mp1videoparse","parse_video");
g_return_if_fail(parse_video != NULL); g_return_if_fail(parse_video != NULL);
@ -96,7 +90,7 @@ void new_pad_created(GstElement *parse,GstPad *pad,GstElement *pipeline) {
g_return_if_fail(video_thread != NULL); g_return_if_fail(video_thread != NULL);
gst_bin_add(GST_BIN(video_thread),GST_ELEMENT(parse_video)); gst_bin_add(GST_BIN(video_thread),GST_ELEMENT(parse_video));
gst_bin_add(GST_BIN(video_thread),GST_ELEMENT(decode_video)); gst_bin_add(GST_BIN(video_thread),GST_ELEMENT(decode_video));
gst_bin_add(GST_BIN(video_thread),GST_ELEMENT(videoscale)); //gst_bin_add(GST_BIN(video_thread),GST_ELEMENT(videoscale));
gst_bin_add(GST_BIN(video_thread),GST_ELEMENT(show)); gst_bin_add(GST_BIN(video_thread),GST_ELEMENT(show));
// set up pad connections // set up pad connections
@ -137,7 +131,6 @@ int main(int argc,char *argv[]) {
g_thread_init(NULL); g_thread_init(NULL);
gst_init(&argc,&argv); gst_init(&argc,&argv);
gnome_init("MPEG1 Video player","0.0.1",argc,argv); gnome_init("MPEG1 Video player","0.0.1",argc,argv);
gst_plugin_load("mpeg1parse");
pipeline = gst_pipeline_new("pipeline"); pipeline = gst_pipeline_new("pipeline");
g_return_val_if_fail(pipeline != NULL, -1); g_return_val_if_fail(pipeline != NULL, -1);