mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-16 19:25:18 +00:00
Code Issues 1 Projects Releases Wiki Activity

Docs updates: remove sink, src, filter, connection added gstinfo to docs.

Browse source 
Original commit message from CVS:
Docs updates: remove sink, src, filter, connection
added gstinfo to docs.
Updated some core files for the docs
gsttypefind did not include gst_private
Added CFlags to Makefile.am in gst/elements
This commit is contained in:
Wim Taymans 2000-12-30 16:13:17 +00:00
parent 75ac013312
commit 3b805b9209
28 changed files with 865 additions and 3959 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/gst/.gitignore vendored
View file

@ -7,5 +7,6 @@ gstreamer.types
gstreamer.html gstreamer.html
gstreamer-unused.txt gstreamer-unused.txt
gstreamer-decl-list.txt gstreamer-decl-list.txt
gstreamer-decl.txt
gstreamer.args gstreamer.args
*.tgz

3585
docs/gst/gstreamer-decl.txt
View file

File diff suppressed because it is too large Load diff

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

@ -2,13 +2,12 @@
<!entity gstreamer-cothreads SYSTEM "sgml/cothreads.sgml"> <!entity gstreamer-cothreads SYSTEM "sgml/cothreads.sgml">
<!entity Gst SYSTEM "sgml/gst.sgml"> <!entity Gst SYSTEM "sgml/gst.sgml">
<!entity GstInfo SYSTEM "sgml/gstinfo.sgml">
<!entity GstBin SYSTEM "sgml/gstbin.sgml"> <!entity GstBin SYSTEM "sgml/gstbin.sgml">
<!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml"> <!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
<!entity GstBufferPool SYSTEM "sgml/gstbufferpool.sgml"> <!entity GstBufferPool SYSTEM "sgml/gstbufferpool.sgml">
<!entity GstConnection SYSTEM "sgml/gstconnection.sgml">
<!entity GstCpu SYSTEM "sgml/gstcpu.sgml"> <!entity GstCpu SYSTEM "sgml/gstcpu.sgml">
<!entity GstElement SYSTEM "sgml/gstelement.sgml"> <!entity GstElement SYSTEM "sgml/gstelement.sgml">
<!entity GstFilter SYSTEM "sgml/gstfilter.sgml">
<!entity GstLog SYSTEM "sgml/gstlog.sgml"> <!entity GstLog SYSTEM "sgml/gstlog.sgml">
<!entity GstMeta SYSTEM "sgml/gstmeta.sgml"> <!entity GstMeta SYSTEM "sgml/gstmeta.sgml">
<!entity GstObject SYSTEM "sgml/gstobject.sgml"> <!entity GstObject SYSTEM "sgml/gstobject.sgml">
@ -16,8 +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 GstSink SYSTEM "sgml/gstsink.sgml">
<!entity GstSrc SYSTEM "sgml/gstsrc.sgml">
<!entity GstTee SYSTEM "sgml/gsttee.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">
@ -65,18 +62,15 @@ well as the object hiarchy that defines elements and bins, along
with some more specialized elements.</para> with some more specialized elements.</para>
&Gst; &Gst;
&GstInfo;
&GstObject; &GstObject;
&GstElement; &GstElement;
&GstBin; &GstBin;
&GstPipeline; &GstPipeline;
&GstAutoplug; &GstAutoplug;
&GstFilter;
&GstSink;
&GstSrc;
&GstBuffer; &GstBuffer;
&GstBufferPool; &GstBufferPool;
&GstPad; &GstPad;
&GstConnection;
&GstPlugin; &GstPlugin;
&GstThread; &GstThread;
&GstTee; &GstTee;

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

@ -19,6 +19,7 @@ cothread_main
cothread_set_data cothread_set_data
cothread_get_data cothread_get_data
<SUBSECTION Standard> <SUBSECTION Standard>
SETUP_STACK
GET_SP GET_SP
JUMP JUMP
SET_SP SET_SP
@ -30,15 +31,32 @@ SET_SP
gst_init gst_init
gst_main gst_main
gst_main_quit gst_main_quit
DEBUG <SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstinfo</FILE>
<TITLE>gstinfo</TITLE>
GST_DEBUG_ENABLED GST_DEBUG_ENABLED
GST_DEBUG_PREFIX
DEBUG
DEBUG_NOPREFIX
DEBUG_ENTER
DEBUG_SET_STRING DEBUG_SET_STRING
DEBUG_ENTER_STRING DEBUG_ENTER_STRING
DEBUG_ENTER
DEBUG_LEAVE_STRING
DEBUG_LEAVE DEBUG_LEAVE
<SUBSECTION Standard> DEBUG_LEAVE_STRING
SETUP_STACK GST_DEBUG_PAD_NAME
GST_DEBUG_FUNCPTR
GST_DEBUG_FUNCPTR_NAME
GstInfoHandler
gst_default_info_handler
INFO
INFO_ELEMENT
GstErrorHandler
gst_default_error_handler
ERROR
ERROR_OBJECT
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -132,22 +150,6 @@ gst_buffer_pool_destroy
GST_BUFFER_POOL GST_BUFFER_POOL
</SECTION> </SECTION>
<SECTION>
<FILE>gstconnection</FILE>
<TITLE>GstConnection</TITLE>
GstConnection
gst_connection_new
gst_connection_push
<SUBSECTION Standard>
GST_TYPE_CONNECTION
gst_connection_get_type
GST_CONNECTION
GST_CONNECTION_CLASS
GST_IS_CONNECTION
GST_IS_CONNECTION_CLASS
GstConnectionClass
</SECTION>
<SECTION> <SECTION>
<FILE>gstelement</FILE> <FILE>gstelement</FILE>
<TITLE>GstElement</TITLE> <TITLE>GstElement</TITLE>
@ -185,6 +187,7 @@ gst_element_connect
gst_element_set_state gst_element_set_state
gst_element_error gst_element_error
gst_element_get_factory gst_element_get_factory
gst_element_signal_eos
gst_element_save_thyself gst_element_save_thyself
gst_element_load_thyself gst_element_load_thyself
gst_elementfactory_new gst_elementfactory_new
@ -208,22 +211,6 @@ GST_IS_ELEMENT_CLASS
gst_element_get_type gst_element_get_type
</SECTION> </SECTION>
<SECTION>
<FILE>gstfilter</FILE>
<TITLE>GstFilter</TITLE>
GstFilter
GST_FILTER_FLAG_LAST
gst_filter_new
<SUBSECTION Standard>
GstFilterClass
gst_filter_get_type
GST_TYPE_FILTER
GST_FILTER
GST_FILTER_CLASS
GST_IS_FILTER
GST_IS_FILTER_CLASS
</SECTION>
<SECTION> <SECTION>
<FILE>gstclock</FILE> <FILE>gstclock</FILE>
GstClockTime GstClockTime
@ -282,6 +269,7 @@ gst_object_ref
gst_object_unref gst_object_unref
gst_object_sink gst_object_sink
gst_object_destroy gst_object_destroy
gst_object_get_path_string
<SUBSECTION Standard> <SUBSECTION Standard>
gst_object_get_type gst_object_get_type
GstObjectClass GstObjectClass
@ -431,39 +419,6 @@ gst_plugin_save_thyself
<SUBSECTION Standard> <SUBSECTION Standard>
</SECTION> </SECTION>
<SECTION>
<FILE>gstsink</FILE>
<TITLE>GstSink</TITLE>
GstSink
GST_SINK_FLAG_LAST
gst_sink_new
<SUBSECTION Standard>
GstSinkClass
gst_sink_get_type
GST_TYPE_SINK
GST_SINK
GST_SINK_CLASS
GST_IS_SINK
GST_IS_SINK_CLASS
</SECTION>
<SECTION>
<FILE>gstsrc</FILE>
<TITLE>GstSrc</TITLE>
GstSrcFlags
GST_SRC_IS_ASYNC
GstSrc
gst_src_signal_eos
<SUBSECTION Standard>
gst_src_get_type
GstSrcClass
GST_TYPE_SRC
GST_SRC
GST_SRC_CLASS
GST_IS_SRC
GST_IS_SRC_CLASS
</SECTION>
<SECTION> <SECTION>
<FILE>gsttee</FILE> <FILE>gsttee</FILE>
<TITLE>GstTee</TITLE> <TITLE>GstTee</TITLE>
@ -571,6 +526,7 @@ gst_props_load_thyself
GstPropsEntry GstPropsEntry
GstPropsListFactory[] GstPropsListFactory[]
GstPropsId GstPropsId
GST_PROPS_END_ID
GST_PROPS_LIST_ID GST_PROPS_LIST_ID
GST_PROPS_INT_ID GST_PROPS_INT_ID
GST_PROPS_INT_RANGE_ID GST_PROPS_INT_RANGE_ID

34
docs/gst/gstreamer.hierarchy
View file

@ -4,23 +4,19 @@ GtkObject
GstBin GstBin
GstPipeline GstPipeline
GstThread GstThread
GstFilter GstTee
GstTee GstFakeSrc
GstPipefilter GstFakeSink
GstIdentity GstDiskSrc
GstSink GstAsyncDiskSrc
GstFakeSink GstHttpSrc
GstAudioSink GstFdSrc
GstFdSink GstAudioSrc
GstTypeFind GstSineSrc
GstSrc GstAudioSink
GstFakeSrc GstFdSink
GstDiskSrc GstPipefilter
GstAsyncDiskSrc GstIdentity
GstHttpSrc GstQueue
GstFdSrc GstTypeFind
GstAudioSrc
GstSineSrc
GstConnection
GstQueue
GstPad GstPad

4
docs/gst/gstreamer.types.in
View file

@ -7,11 +7,7 @@ gst_object_get_type
gst_element_get_type gst_element_get_type
gst_bin_get_type gst_bin_get_type
gst_pipeline_get_type gst_pipeline_get_type
gst_filter_get_type
gst_sink_get_type
gst_src_get_type
gst_pad_get_type gst_pad_get_type
gst_connection_get_type
gst_thread_get_type gst_thread_get_type
gst_tee_get_type gst_tee_get_type

60
docs/gst/tmpl/gst.sgml
View file

@ -53,63 +53,3 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
<!-- ##### MACRO DEBUG ##### -->
<para>
Use this macro to show debugging info. This is only usefull when developing new
plugin elements.
If you #define DEBUG_ENABLED before including gst/gst.h, this macro will produce
g_print messages.
</para>
@format: the format specification as in g_print
@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...:

54
docs/gst/tmpl/gstautoplug.sgml Normal file
View file

@ -0,0 +1,54 @@
<!-- ##### SECTION Title ##### -->
GstAutoplug
<!-- ##### SECTION Short_Description ##### -->
Provide automatic element selection
<!-- ##### SECTION Long_Description ##### -->
<para>
The autoplugger can select a list of elements that are needed
to convert a certain GstCaps to another one.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_AUTOPLUG_MAX_COST ##### -->
<para>
The max cost of a certain connection
</para>
<!-- ##### USER_FUNCTION GstAutoplugCostFunction ##### -->
<para>
Calculate the cost between two elements
</para>
@src: the source element
@dest: the destination element
@data: optional user data
@Returns: the cost for a connection between the two elements
<!-- ##### USER_FUNCTION GstAutoplugListFunction ##### -->
<para>
Get a list of all elements. These elements will be used in autoplugging
</para>
@data: user data
@Returns: a GList of elements
<!-- ##### FUNCTION gst_autoplug_caps ##### -->
<para>
Perform autoplugging between the two given caps.
</para>
@srccaps: the source capability structure
@sinkcaps: the sink capability structure
@Returns: th GList of elements that convert srccaps into sinkcaps.

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

@ -173,6 +173,7 @@ used when data in a stream has been skipped</entry>
@GST_BUFFER_FLUSH: this buffer is not related to previous buffers. This flag is mainly @GST_BUFFER_FLUSH: this buffer is not related to previous buffers. This flag is mainly
used when data in a stream has been skipped used when data in a stream has been skipped
@GST_BUFFER_EOS: this buffer is the last one in the stream @GST_BUFFER_EOS: this buffer is the last one in the stream
@GST_BUFFER_DISCONTINUOUS:
<!-- ##### STRUCT GstBuffer ##### --> <!-- ##### STRUCT GstBuffer ##### -->
<para> <para>

116
docs/gst/tmpl/gstcaps.sgml Normal file
View file

@ -0,0 +1,116 @@
<!-- ##### SECTION Title ##### -->
GstCaps
<!-- ##### SECTION Short_Description ##### -->
Capabilities of pads
<!-- ##### SECTION Long_Description ##### -->
<para>
GstCaps is used to attach capabilities to a pad. Capabilities are made of
a mime-type and a set of properties.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstCaps ##### -->
<para>
</para>
@id: the typeid of the capability
@properties: the properties of the capability
<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
<para>
</para>
<!-- ##### TYPEDEF GstCapsFactory[] ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_caps_new ##### -->
<para>
</para>
@mime:
@Returns:
<!-- ##### FUNCTION gst_caps_new_with_props ##### -->
<para>
</para>
@mime:
@props:
@Returns:
<!-- ##### FUNCTION gst_caps_register ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_caps_set_props ##### -->
<para>
</para>
@caps:
@props:
@Returns:
<!-- ##### FUNCTION gst_caps_get_props ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_check_compatibility ##### -->
<para>
</para>
@fromcaps:
@tocaps:
@Returns:
<!-- # Unused Parameters # -->
@caps1:
@caps2:
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
<para>
</para>
@caps:
@parent:
@Returns:
<!-- ##### FUNCTION gst_caps_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:

33
docs/gst/tmpl/gstconnection.sgml
View file

@ -1,33 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstConnection
<!-- ##### SECTION Short_Description ##### -->
Generic connection between elements.
<!-- ##### SECTION Long_Description ##### -->
<para>
A connection is a bas class for a generic connection between
elements. A connection is typically a bas class for queues.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstConnection ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_connection_new ##### -->
<para>
</para>
@name:
@Returns:

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

@ -337,6 +337,14 @@ circumstances.
@Returns: @Returns:
<!-- ##### FUNCTION gst_element_signal_eos ##### -->
<para>
</para>
@element:
<!-- ##### FUNCTION gst_element_save_thyself ##### --> <!-- ##### FUNCTION gst_element_save_thyself ##### -->
<para> <para>
@ -497,3 +505,10 @@ Is trigered whenever an error occured
@gstelement: the object which received the signal. @gstelement: the object which received the signal.
@arg1: the error message @arg1: the error message
<!-- ##### SIGNAL GstElement::eos ##### -->
<para>
</para>
@gstelement: the object which received the signal.

41
docs/gst/tmpl/gstfilter.sgml
View file

@ -1,41 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstFilter
<!-- ##### SECTION Short_Description ##### -->
Take data in and spit data out
<!-- ##### SECTION Long_Description ##### -->
<para>
Filters take data in and spit data out. They are the main Element in a filter graph.
Filters have zero or more inputs and zero or more outputs. Filters are connected
together to form filter graphs. A GstFilter is the base class and is not very usefull
on its own.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstFilter ##### -->
<para>
</para>
<!-- ##### MACRO GST_FILTER_FLAG_LAST ##### -->
<para>
subclass use this to start their flag enumeration
</para>
<!-- ##### FUNCTION gst_filter_new ##### -->
<para>
</para>
@name:
@Returns:

217
docs/gst/tmpl/gstinfo.sgml Normal file
View file

@ -0,0 +1,217 @@
<!-- ##### SECTION Title ##### -->
gstinfo
<!-- ##### SECTION Short_Description ##### -->
info/debugging/error handling
<!-- ##### SECTION Long_Description ##### -->
<para>
GstInfo contains a lot of functions to add debugging information
to your application.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_DEBUG_ENABLED ##### -->
<para>
</para>
<!-- ##### MACRO GST_DEBUG_PREFIX ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO DEBUG ##### -->
<para>
Use this macro to show debugging info. This is only usefull when developing new
plugin elements.
If you #define DEBUG_ENABLED before including gst/gst.h, this macro will produce
g_print messages.
</para>
@format: the format specification as in g_print
@args...: arguments
<!-- ##### MACRO DEBUG_NOPREFIX ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO DEBUG_ENTER ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO DEBUG_SET_STRING ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO DEBUG_ENTER_STRING ##### -->
<para>
</para>
<!-- ##### MACRO DEBUG_LEAVE ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
<para>
</para>
<!-- ##### MACRO GST_DEBUG_PAD_NAME ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_DEBUG_FUNCPTR ##### -->
<para>
</para>
@ptr:
<!-- ##### MACRO GST_DEBUG_FUNCPTR_NAME ##### -->
<para>
</para>
@ptr:
<!-- ##### USER_FUNCTION GstInfoHandler ##### -->
<para>
</para>
@category:
@file:
@function:
@line:
@debug_string:
@element:
@string:
<!-- ##### FUNCTION gst_default_info_handler ##### -->
<para>
</para>
@category:
@file:
@function:
@line:
@debug_string:
@element:
@string:
<!-- ##### MACRO INFO ##### -->
<para>
</para>
@cat:
@format:
@args...:
<!-- ##### MACRO INFO_ELEMENT ##### -->
<para>
</para>
@cat:
@element:
@format:
@args...:
<!-- ##### USER_FUNCTION GstErrorHandler ##### -->
<para>
</para>
@file:
@function:
@line:
@debug_string:
@element:
@object:
@string:
<!-- ##### FUNCTION gst_default_error_handler ##### -->
<para>
</para>
@file:
@function:
@line:
@debug_string:
@element:
@object:
@string:
<!-- ##### MACRO ERROR ##### -->
<para>
</para>
@element:
@format:
@args...:
<!-- ##### MACRO ERROR_OBJECT ##### -->
<para>
</para>
@element:
@object:
@format:
@args...:

9
docs/gst/tmpl/gstobject.sgml
View file

@ -165,6 +165,15 @@ This macro releases a lock on the object.
@object: the object @object: the object
<!-- ##### FUNCTION gst_object_get_path_string ##### -->
<para>
</para>
@object:
@Returns:
<!-- ##### SIGNAL GstObject::parent-set ##### --> <!-- ##### SIGNAL GstObject::parent-set ##### -->
<para> <para>

149
docs/gst/tmpl/gstprops.sgml Normal file
View file

@ -0,0 +1,149 @@
<!-- ##### SECTION Title ##### -->
GstProps
<!-- ##### SECTION Short_Description ##### -->
Properties
<!-- ##### SECTION Long_Description ##### -->
<para>
GstProps is used to attach certain properties to a pad. Properties
are usually used in conjunction with GstCaps.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
GstCaps
</para>
<!-- ##### STRUCT GstProps ##### -->
<para>
</para>
@properties: the properties
<!-- ##### TYPEDEF GstPropsFactoryEntry ##### -->
<para>
</para>
<!-- ##### TYPEDEF GstPropsFactory[] ##### -->
<para>
</para>
<!-- ##### MACRO GST_PROPS_LIST ##### -->
<para>
Create a list of properties
</para>
@a...: the list of GstProps
<!-- ##### MACRO GST_PROPS_INT ##### -->
<para>
Create an integer property
</para>
@a: the integer property
<!-- ##### MACRO GST_PROPS_INT_RANGE ##### -->
<para>
Create an integer range property
</para>
@a: the min value for the range
@b: the max value for the range
<!-- ##### MACRO GST_PROPS_FOURCC ##### -->
<para>
Construct a fourcc property out of four bytes
</para>
@a: first byte
@b: second byte
@c: third byte
@d: fourth byte
<!-- ##### MACRO GST_PROPS_FOURCC_INT ##### -->
<para>
Create a fourcc property out of an integer value
</para>
@a: the integer value
<!-- ##### MACRO GST_PROPS_BOOLEAN ##### -->
<para>
Create a boolean property
</para>
@a: the boolean property
<!-- ##### FUNCTION gst_props_register ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_props_new ##### -->
<para>
</para>
@entry:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_props_merge ##### -->
<para>
</para>
@props:
@tomerge:
@Returns:
<!-- ##### FUNCTION gst_props_check_compatibility ##### -->
<para>
</para>
@fromprops:
@toprops:
@Returns:
<!-- # Unused Parameters # -->
@props1:
@props2:
<!-- ##### FUNCTION gst_props_save_thyself ##### -->
<para>
</para>
@props:
@parent:
@Returns:
<!-- ##### FUNCTION gst_props_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:

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

@ -53,6 +53,16 @@
@obj: @obj:
<!-- ##### SIGNAL GstSrc::eos ##### -->
<para>
An eos signal is triggered whenever the GstSrc has reached the end of
the stream.
</para>
@gstsrc: the object which received the signal.
@arg1: the object which received the signal
<!-- ##### STRUCT GstAsyncDiskSrcClass ##### --> <!-- ##### STRUCT GstAsyncDiskSrcClass ##### -->
<para> <para>
@ -86,6 +96,12 @@
</para> </para>
<!-- ##### STRUCT GstConnection ##### -->
<para>
</para>
<!-- ##### MACRO GST_FDSRC ##### --> <!-- ##### MACRO GST_FDSRC ##### -->
<para> <para>
@ -205,13 +221,6 @@
</para> </para>
<!-- ##### MACRO GST_QUEUE_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### FUNCTION gst_audiosrc_get_type ##### --> <!-- ##### FUNCTION gst_audiosrc_get_type ##### -->
<para> <para>
@ -219,6 +228,19 @@
@Returns: @Returns:
<!-- ##### MACRO GST_QUEUE_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### SECTION ./tmpl/gstconnection.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_QUEUE ##### --> <!-- ##### MACRO GST_IS_QUEUE ##### -->
<para> <para>
@ -226,6 +248,14 @@
@obj: @obj:
<!-- ##### SECTION ./tmpl/gstsink.sgml:Long_Description ##### -->
<para>
The sink is the end of the filter graph. A typical sink would be an audio
or a video card.
</para>
<!-- ##### FUNCTION gst_queue_new ##### --> <!-- ##### FUNCTION gst_queue_new ##### -->
<para> <para>
@ -288,6 +318,12 @@ This macro checks to see if the GST_SRC_ASYNC flag is set.
@obj: GstSrc to check for flag in. @obj: GstSrc to check for flag in.
<!-- ##### STRUCT GstFilter ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_ASYNCDISKSRC ##### --> <!-- ##### MACRO GST_TYPE_ASYNCDISKSRC ##### -->
<para> <para>
@ -327,6 +363,14 @@ This macro checks to see if the GST_SRC_ASYNC flag is set.
</para> </para>
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Long_Description ##### -->
<para>
A connection is a bas class for a generic connection between
elements. A connection is typically a bas class for queues.
</para>
<!-- ##### FUNCTION gst_fakesrc_new ##### --> <!-- ##### FUNCTION gst_fakesrc_new ##### -->
<para> <para>
@ -469,6 +513,12 @@ GstColorSpace
@obj: @obj:
<!-- ##### STRUCT GstSink ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_AUDIOSINK_CLASS ##### --> <!-- ##### MACRO GST_IS_AUDIOSINK_CLASS ##### -->
<para> <para>
@ -476,6 +526,12 @@ GstColorSpace
@obj: @obj:
<!-- ##### SECTION ./tmpl/gstsrc.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_type_get_srcs ##### --> <!-- ##### FUNCTION gst_type_get_srcs ##### -->
<para> <para>
@ -484,6 +540,19 @@ GstColorSpace
@id: @id:
@Returns: @Returns:
<!-- ##### SECTION ./tmpl/gstfilter.sgml:Long_Description ##### -->
<para>
Filters take data in and spit data out. They are the main Element in a filter graph.
Filters have zero or more inputs and zero or more outputs. Filters are connected
together to form filter graphs. A GstFilter is the base class and is not very usefull
on its own.
</para>
<!-- ##### SECTION ./tmpl/gstfilter.sgml:Short_Description ##### -->
Take data in and spit data out
<!-- ##### FUNCTION plugin_load_absolute ##### --> <!-- ##### FUNCTION plugin_load_absolute ##### -->
<para> <para>
@ -535,6 +604,14 @@ GstColorSpace
@src: @src:
<!-- ##### FUNCTION gst_filter_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### STRUCT GstThreadClass ##### --> <!-- ##### STRUCT GstThreadClass ##### -->
<para> <para>
@ -575,6 +652,13 @@ GstGetbits
@offset: @offset:
@size: @size:
<!-- ##### FUNCTION gst_src_signal_eos ##### -->
<para>
</para>
@src:
<!-- ##### MACRO GST_SINESRC_CLASS ##### --> <!-- ##### MACRO GST_SINESRC_CLASS ##### -->
<para> <para>
@ -589,6 +673,22 @@ GstGetbits
@obj: @obj:
<!-- ##### FUNCTION gst_connection_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_sink_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### MACRO GST_ELEMENT_CLASS ##### --> <!-- ##### MACRO GST_ELEMENT_CLASS ##### -->
<para> <para>
@ -596,6 +696,14 @@ GstGetbits
@klass: @klass:
<!-- ##### SECTION ./tmpl/gstsrc.sgml:Long_Description ##### -->
<para>
A GstSrc is the start of a filter graph. It typically is a file or an
audio source. It provides data for the next element in the graph.
</para>
<!-- ##### FUNCTION gst_fdsink_chain ##### --> <!-- ##### FUNCTION gst_fdsink_chain ##### -->
<para> <para>
@ -639,6 +747,10 @@ GstGetbits
</para> </para>
<!-- ##### SECTION ./tmpl/gstsrc.sgml:Title ##### -->
GstSrc
<!-- ##### MACRO GST_IS_FDSINK_CLASS ##### --> <!-- ##### MACRO GST_IS_FDSINK_CLASS ##### -->
<para> <para>
@ -740,6 +852,10 @@ This macro returns the entire set of flags for the object.
@klass: @klass:
<!-- ##### SECTION ./tmpl/gstsrc.sgml:Short_Description ##### -->
The start point of a filter graph
<!-- ##### MACRO GST_FAKESINK_CLASS ##### --> <!-- ##### MACRO GST_FAKESINK_CLASS ##### -->
<para> <para>
@ -791,14 +907,14 @@ This macro returns the entire set of flags for the object.
<!-- ##### MACRO GST_ESDSINK_CLASS ##### --> <!-- ##### MACRO GST_ASYNCDISKSRC_CLASS ##### -->
<para> <para>
</para> </para>
@klass: @klass:
<!-- ##### MACRO GST_ASYNCDISKSRC_CLASS ##### --> <!-- ##### MACRO GST_ESDSINK_CLASS ##### -->
<para> <para>
</para> </para>
@ -832,6 +948,10 @@ This macro returns the entire set of flags for the object.
@obj: @obj:
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Title ##### -->
GstConnection
<!-- ##### MACRO GST_TYPE_THREAD ##### --> <!-- ##### MACRO GST_TYPE_THREAD ##### -->
<para> <para>
@ -880,6 +1000,10 @@ This macro sets the given state on the element.
@obj: @obj:
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### MACRO GST_TYPE_AUDIOSINK ##### --> <!-- ##### MACRO GST_TYPE_AUDIOSINK ##### -->
<para> <para>
@ -1082,6 +1206,10 @@ A flag indicating that SSE instructions are supported.
</para> </para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Short_Description ##### -->
The end point of a filter graph
<!-- ##### FUNCTION gst_connection_get_type ##### --> <!-- ##### FUNCTION gst_connection_get_type ##### -->
<para> <para>
@ -1204,6 +1332,13 @@ This macro sets the given flags.
@Returns: @Returns:
<!-- ##### MACRO GST_SRC_IS_ASYNC ##### -->
<para>
Query a GstSrc for the ASYNC flag
</para>
@obj: The GstSrc to query
<!-- ##### MACRO GST_TYPE_IDENTITY ##### --> <!-- ##### MACRO GST_TYPE_IDENTITY ##### -->
<para> <para>
@ -1236,6 +1371,10 @@ This macro sets the given flags.
</para> </para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink
<!-- ##### FUNCTION gst_type_get_sink_to_src ##### --> <!-- ##### FUNCTION gst_type_get_sink_to_src ##### -->
<para> <para>
@ -1251,6 +1390,12 @@ This macro sets the given flags.
</para> </para>
<!-- ##### MACRO GST_SINK_FLAG_LAST ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_queue_get_type ##### --> <!-- ##### FUNCTION gst_queue_get_type ##### -->
<para> <para>
@ -1258,6 +1403,12 @@ This macro sets the given flags.
@Returns: @Returns:
<!-- ##### STRUCT GstSrc ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_connection_push ##### --> <!-- ##### FUNCTION gst_connection_push ##### -->
<para> <para>
@ -1271,6 +1422,12 @@ This macro sets the given flags.
</para> </para>
<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_AUDIOSRC ##### --> <!-- ##### MACRO GST_AUDIOSRC ##### -->
<para> <para>
@ -1387,6 +1544,20 @@ Get the size of the current file.
</para> </para>
<!-- ##### MACRO GST_FILTER_FLAG_LAST ##### -->
<para>
subclass use this to start their flag enumeration
</para>
<!-- ##### ENUM GstSrcFlags ##### -->
<para>
Flags for the GstSrc element
</para>
@GST_SRC_ASYNC: Indicates that this src is asynchronous
@GST_SRC_FLAG_LAST: subclasses can use this to number their flags
<!-- ##### MACRO GST_TYPE_PIPELINE ##### --> <!-- ##### MACRO GST_TYPE_PIPELINE ##### -->
<para> <para>
@ -1490,6 +1661,12 @@ Get the size of the current file.
@pad: @pad:
@Returns: @Returns:
<!-- ##### SECTION ./tmpl/gstsink.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_queue_chain ##### --> <!-- ##### FUNCTION gst_queue_chain ##### -->
<para> <para>
@ -1567,6 +1744,12 @@ Get the size of the current file.
@audiosink: @audiosink:
@frequency: @frequency:
<!-- ##### MACRO GST_TYPE_QUEUE ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_elementfactory_register ##### --> <!-- ##### FUNCTION gst_elementfactory_register ##### -->
<para> <para>
@ -1574,11 +1757,12 @@ Get the size of the current file.
@elementfactory: @elementfactory:
<!-- ##### MACRO GST_TYPE_QUEUE ##### --> <!-- ##### MACRO GST_META ##### -->
<para> <para>
</para> </para>
@meta:
<!-- ##### FUNCTION gst_audiosink_get_type ##### --> <!-- ##### FUNCTION gst_audiosink_get_type ##### -->
<para> <para>
@ -1587,13 +1771,6 @@ Get the size of the current file.
@Returns: @Returns:
<!-- ##### MACRO GST_META ##### -->
<para>
</para>
@meta:
<!-- ##### FUNCTION gst_httpsrc_get_type ##### --> <!-- ##### FUNCTION gst_httpsrc_get_type ##### -->
<para> <para>
@ -1635,12 +1812,6 @@ Get the size of the current file.
</para> </para>
<!-- ##### MACRO GST_TYPE_FILTER ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_SINESRC_CLASS ##### --> <!-- ##### MACRO GST_IS_SINESRC_CLASS ##### -->
<para> <para>
@ -1648,6 +1819,12 @@ Get the size of the current file.
@obj: @obj:
<!-- ##### MACRO GST_TYPE_FILTER ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_AUDIOSRC_CLASS ##### --> <!-- ##### MACRO GST_IS_AUDIOSRC_CLASS ##### -->
<para> <para>
@ -1808,6 +1985,10 @@ Query whether this object has multiple input pads.
@fd: @fd:
@Returns: @Returns:
<!-- ##### SECTION ./tmpl/gstfilter.sgml:Title ##### -->
GstFilter
<!-- ##### FUNCTION gst_elementfactory_add_src ##### --> <!-- ##### FUNCTION gst_elementfactory_add_src ##### -->
<para> <para>

24
docs/gst/tmpl/gstscheduler.sgml Normal file
View file

@ -0,0 +1,24 @@
<!-- ##### SECTION Title ##### -->
GstScheduler
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_bin_schedule_func ##### -->
<para>
</para>
@bin:

40
docs/gst/tmpl/gstsink.sgml
View file

@ -1,40 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstSink
<!-- ##### SECTION Short_Description ##### -->
The end point of a filter graph
<!-- ##### SECTION Long_Description ##### -->
<para>
The sink is the end of the filter graph. A typical sink would be an audio
or a video card.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstSink ##### -->
<para>
</para>
<!-- ##### MACRO GST_SINK_FLAG_LAST ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_sink_new ##### -->
<para>
</para>
@name:
@Returns:

59
docs/gst/tmpl/gstsrc.sgml
View file

@ -1,59 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstSrc
<!-- ##### SECTION Short_Description ##### -->
The start point of a filter graph
<!-- ##### SECTION Long_Description ##### -->
<para>
A GstSrc is the start of a filter graph. It typically is a file or an
audio source. It provides data for the next element in the graph.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstSrcFlags ##### -->
<para>
Flags for the GstSrc element
</para>
@GST_SRC_ASYNC: Indicates that this src is asynchronous
@GST_SRC_FLAG_LAST: subclasses can use this to number their flags
<!-- ##### MACRO GST_SRC_IS_ASYNC ##### -->
<para>
Query a GstSrc for the ASYNC flag
</para>
@obj: The GstSrc to query
<!-- ##### STRUCT GstSrc ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_src_signal_eos ##### -->
<para>
</para>
@src:
<!-- ##### SIGNAL GstSrc::eos ##### -->
<para>
An eos signal is triggered whenever the GstSrc has reached the end of
the stream.
</para>
@gstsrc: the object which received the signal.
<!-- # Unused Parameters # -->
@arg1: the object which received the signal

2
gst/elements/Makefile.am
View file

@ -42,5 +42,7 @@ noinst_HEADERS = \
gsttypefind.h \ gsttypefind.h \
gstsinesrc.h gstsinesrc.h
CFLAGS += -O2 -Wall
libgstelements_la_LIBADD = $(GLIB_LIBS) $(GTK_LIBS) $(GHTTP_LIBS) libgstelements_la_LIBADD = $(GLIB_LIBS) $(GTK_LIBS) $(GHTTP_LIBS)
libgstelements_la_LDFLAGS = -version-info $(STREAMER_CURRENT):$(STREAMER_REVISION):$(STREAMER_AGE) libgstelements_la_LDFLAGS = -version-info $(STREAMER_CURRENT):$(STREAMER_REVISION):$(STREAMER_AGE)

2
gst/elements/gstqueue.c
View file

@ -28,7 +28,7 @@
#define STATUS(A) #define STATUS(A)
#endif #endif
#include <gstqueue.h> #include "gstqueue.h"
#include <gst/gstarch.h> #include <gst/gstarch.h>

18
gst/gstautoplug.c
View file

@ -89,18 +89,16 @@ gst_autoplug_can_match (GstElementFactory *src, GstElementFactory *dest)
if (srctemp->direction == GST_PAD_SRC && if (srctemp->direction == GST_PAD_SRC &&
desttemp->direction == GST_PAD_SINK) { desttemp->direction == GST_PAD_SINK) {
if (gst_caps_check_compatibility (srctemp->caps, desttemp->caps)) { if (gst_caps_check_compatibility (srctemp->caps, desttemp->caps)) {
DEBUG ("gstautoplug: \"%s\" connects with \"%s\"\n", src->name, dest->name); INFO(0,"factory \"%s\" can connect with factory \"%s\"", src->name, dest->name);
return TRUE; return TRUE;
} }
else {
DEBUG ("gstautoplug: \"%s\" does not connect with \"%s\"\n", src->name, dest->name);
}
} }
desttemps = g_list_next (desttemps); desttemps = g_list_next (desttemps);
} }
srctemps = g_list_next (srctemps); srctemps = g_list_next (srctemps);
} }
INFO(0,"factory \"%s\" cannot connect with factory \"%s\"", src->name, dest->name);
return FALSE; return FALSE;
} }
@ -125,15 +123,15 @@ gst_autoplug_caps_find_cost (gpointer src, gpointer dest, gpointer data)
if (IS_CAPS (src) && IS_CAPS (dest)) { if (IS_CAPS (src) && IS_CAPS (dest)) {
res = gst_caps_check_compatibility ((GstCaps *)src, (GstCaps *)dest); res = gst_caps_check_compatibility ((GstCaps *)src, (GstCaps *)dest);
DEBUG ("caps %d to caps %d %d\n", ((GstCaps *)src)->id, ((GstCaps *)dest)->id, res); INFO (0,"caps %d to caps %d %d", ((GstCaps *)src)->id, ((GstCaps *)dest)->id, res);
} }
else if (IS_CAPS (src)) { else if (IS_CAPS (src)) {
res = gst_elementfactory_can_sink_caps ((GstElementFactory *)dest, src); res = gst_elementfactory_can_sink_caps ((GstElementFactory *)dest, src);
DEBUG ("factory %s to sink caps %d %d\n", ((GstElementFactory *)dest)->name, ((GstCaps *)src)->id, res); INFO (0,"factory %s to sink caps %d %d", ((GstElementFactory *)dest)->name, ((GstCaps *)src)->id, res);
} }
else if (IS_CAPS (dest)) { else if (IS_CAPS (dest)) {
res = gst_elementfactory_can_src_caps ((GstElementFactory *)src, dest); res = gst_elementfactory_can_src_caps ((GstElementFactory *)src, dest);
DEBUG ("factory %s to src caps %d %d\n", ((GstElementFactory *)src)->name, ((GstCaps *)dest)->id, res); INFO (0,"factory %s to src caps %d %d", ((GstElementFactory *)src)->name, ((GstCaps *)dest)->id, res);
} }
else { else {
res = gst_autoplug_can_match ((GstElementFactory *)src, (GstElementFactory *)dest); res = gst_autoplug_can_match ((GstElementFactory *)src, (GstElementFactory *)dest);
@ -153,6 +151,8 @@ gst_autoplug_caps (GstCaps *srccaps, GstCaps *sinkcaps)
caps.src = srccaps; caps.src = srccaps;
caps.sink = sinkcaps; caps.sink = sinkcaps;
INFO (0,"autoplugging two caps structures");
return gst_autoplug_func (srccaps, sinkcaps, return gst_autoplug_func (srccaps, sinkcaps,
gst_autoplug_elementfactory_get_list, gst_autoplug_elementfactory_get_list,
gst_autoplug_caps_find_cost, gst_autoplug_caps_find_cost,
@ -179,6 +179,8 @@ construct_path (gst_autoplug_node *rgnNodes, gpointer factory)
current = rgnNodes[find_factory(rgnNodes, factory)].iPrev; current = rgnNodes[find_factory(rgnNodes, factory)].iPrev;
INFO (0,"factories found in autoplugging (reversed order)");
while (current != NULL) while (current != NULL)
{ {
gpointer next = NULL; gpointer next = NULL;
@ -186,7 +188,7 @@ construct_path (gst_autoplug_node *rgnNodes, gpointer factory)
next = rgnNodes[find_factory(rgnNodes, current)].iPrev; next = rgnNodes[find_factory(rgnNodes, current)].iPrev;
if (next) { if (next) {
factories = g_list_prepend (factories, current); factories = g_list_prepend (factories, current);
DEBUG ("%s %p\n", current->name, next); INFO (0,"factory: \"%s\"", current->name);
} }
current = next; current = next;
} }

4
gst/gstelement.c
View file

@ -840,8 +840,8 @@ gst_element_set_loop_function(GstElement *element,
} }
/** /**
* gst_src_signal_eos: * gst_element_signal_eos:
* @src: source to trigger the eos signal of * @element: element to trigger the eos signal of
* *
* singals the eos signal to indicate that the end of the stream * singals the eos signal to indicate that the end of the stream
* is reached. * is reached.

14
gst/gstobject.c
View file

@ -252,8 +252,18 @@ void gst_object_sink(GstObject *object) {
#endif /* gst_object_sink */ #endif /* gst_object_sink */
/**
gchar *gst_object_get_path_string(GstObject *object) { * gst_object_get_path_string:
* @object: GstObject to get the path from
*
* Generates a string describing the path of the object in
* the object hierarchy. Usefull for debugging
*
* Returns: a string describing the path of the object
*/
gchar*
gst_object_get_path_string(GstObject *object)
{
GSList *parentage = NULL; GSList *parentage = NULL;
GSList *parents; GSList *parents;
void *parent; void *parent;

3
gst/gstplugin.c
View file

@ -259,7 +259,7 @@ gst_plugin_load_absolute (gchar *name)
if (module != NULL) { if (module != NULL) {
if (g_module_symbol(module,"plugin_init",(gpointer *)&initfunc)) { if (g_module_symbol(module,"plugin_init",(gpointer *)&initfunc)) {
if ((plugin = (initfunc)(module))) { if ((plugin = (initfunc)(module))) {
INFO(0,"plugin %s loaded", plugin->name); INFO(GST_INFO_PLUGIN_LOADING,"plugin %s loaded", plugin->name);
plugin->filename = g_strdup(name); plugin->filename = g_strdup(name);
plugin->loaded = TRUE; plugin->loaded = TRUE;
_gst_modules = g_list_prepend(_gst_modules,module); _gst_modules = g_list_prepend(_gst_modules,module);
@ -628,7 +628,6 @@ gst_plugin_load_thyself (xmlNodePtr parent)
kinderen = kinderen->next; kinderen = kinderen->next;
} }
// DEBUG("gstplugin: added %d registered factories and %d types\n", elementcount, typecount);
INFO(GST_INFO_PLUGIN_LOADING,"added %d registered factories and %d types",elementcount,typecount); INFO(GST_INFO_PLUGIN_LOADING,"added %d registered factories and %d types",elementcount,typecount);
} }

2
plugins/elements/Makefile.am
View file

@ -42,5 +42,7 @@ noinst_HEADERS = \
gsttypefind.h \ gsttypefind.h \
gstsinesrc.h gstsinesrc.h
CFLAGS += -O2 -Wall
libgstelements_la_LIBADD = $(GLIB_LIBS) $(GTK_LIBS) $(GHTTP_LIBS) libgstelements_la_LIBADD = $(GLIB_LIBS) $(GTK_LIBS) $(GHTTP_LIBS)
libgstelements_la_LDFLAGS = -version-info $(STREAMER_CURRENT):$(STREAMER_REVISION):$(STREAMER_AGE) libgstelements_la_LDFLAGS = -version-info $(STREAMER_CURRENT):$(STREAMER_REVISION):$(STREAMER_AGE)

2
plugins/elements/gstqueue.c
View file

@ -28,7 +28,7 @@
#define STATUS(A) #define STATUS(A)
#endif #endif
#include <gstqueue.h> #include "gstqueue.h"
#include <gst/gstarch.h> #include <gst/gstarch.h>