From 21e56edfbcb5fc882963fdda24b06d731ad055bc Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Wed, 21 Jul 2004 11:32:09 +0000 Subject: [PATCH] put symbols in the sections.txt into the right sections (so that we dont get wrong undocumented symbols) added TITLE ... Original commit message from CVS: put symbols in the sections.txt into the right sections (so that we dont get wrong undocumented symbols) added TITLE tags where they were missing fixed section names so that gtk-doc introspection works fixed typos in api docs and docbook docs added some thoughts about new interfaces (to personal notes) --- docs/README | 25 +- docs/gst/gstreamer-docs.sgml | 20 +- docs/gst/gstreamer-sections.txt | 435 ++++----- docs/gst/gstreamer.types | 23 +- docs/gst/tmpl/gstbin.sgml | 34 + docs/gst/tmpl/gstconfig.sgml | 2 +- docs/gst/tmpl/gstelement.sgml | 89 +- docs/gst/tmpl/gstenumtypes.sgml | 842 +++++------------- docs/gst/tmpl/gsterror.sgml | 8 - docs/gst/tmpl/gstevent.sgml | 27 +- ...rface.sgml => gstimplementsinterface.sgml} | 11 +- docs/gst/tmpl/gstindex.sgml | 56 -- docs/gst/tmpl/gstobject.sgml | 50 +- docs/gst/tmpl/gstpad.sgml | 174 +--- docs/gst/tmpl/gstparse.sgml | 2 +- docs/gst/tmpl/gstplugin.sgml | 16 - docs/gst/tmpl/gstqueue.sgml | 11 - docs/gst/tmpl/gstscheduler.sgml | 86 -- ...gsttaginterface.sgml => gsttagsetter.sgml} | 2 +- docs/gst/tmpl/gsttypefind.sgml | 2 +- docs/gst/tmpl/gsttypes.sgml | 294 ------ docs/gst/tmpl/gsturi.sgml | 43 +- docs/gst/tmpl/gsturitype.sgml | 8 - docs/gst/tmpl/gstutils.sgml | 2 +- docs/gst/tmpl/gstxml.sgml | 2 +- docs/pwg/advanced-dparams.xml | 16 +- docs/pwg/advanced-events.xml | 8 +- docs/pwg/building-boiler.xml | 4 +- docs/random/ensonic/dparams.txt | 10 + docs/random/ensonic/interfaces.txt | 32 + gst/gsterror.h | 2 +- gst/gstinterface.h | 6 +- gst/gstparse.h | 2 +- gst/gstxml.h | 2 +- libs/gst/control/control.c | 7 + 35 files changed, 715 insertions(+), 1638 deletions(-) rename docs/gst/tmpl/{gstinterface.sgml => gstimplementsinterface.sgml} (80%) rename docs/gst/tmpl/{gsttaginterface.sgml => gsttagsetter.sgml} (98%) create mode 100644 docs/random/ensonic/interfaces.txt diff --git a/docs/README b/docs/README index 3351b1d685..8ba6d20a88 100644 --- a/docs/README +++ b/docs/README @@ -87,6 +87,14 @@ HOW THE BUILD SYSTEM IS SET UP * ps and pdf are built in the current dir, in one file +DOCBOOK NOTES +============= + +* spell checking with aspell + * aspell -b -c --mode=sgml --lang=en .xml + unfortunately the curses-ui of aspell (0.50.5) has problems with the xml tags + + GTK-DOC NOTES ============= @@ -108,10 +116,21 @@ GTK-DOC NOTES - add both an entity and use the entity in gstreamer-docs.sgml - add a new section to gstreamer-sections.txt - add all documented symbols to gstreamer-sections.txt in the proper section + (default),, + - document at least the Short_Description in tmpl/.sgml + - signals: document them properly in tmpl/.sgml (or better in the c-source) - - signals: document them properly in tmpl/.sgml * checklist: - make sure -sections.txt has a set for each <FILE> + - the title should be named like the type, when it gets registered + (otherwise gtkdoc introspection fails) + - for clarity name the file like the title, but all lowercase + +* what to do when trying to improve the docs + - compare the output of + grep "_get_type" gstreamer-sections.txt | sort + with the types in XXX.types to detect entries that + are maybe missing * what happens during a gtk-doc build ? - headers are scanned based on $(MODULE).types @@ -120,12 +139,9 @@ GTK-DOC NOTES where the module name is $(MODULE) $(MODULE)-sections.txt is created if it doesn't exist yet (it should), as well as $(MODULE)-decl.txt and $(MODULE)-decl-list.txt - and .args, .hierarchy and .signals files are created gtkdoc-scan is called - (FIXME: why is there gstreamer.types.in and gst-plugins.types.in ?) - * Possible errors and how to fix them - Warning: multiple "IDs" for constraint linkend: gst-tag-register. - check if gst_tag_register is listed more than once in -sections.txt @@ -156,3 +172,4 @@ RANDOM THINGS I'VE LEARNED xsltproc has a --path option (that xmlto doesn't use yet), but it resolves single files to $(specified_path)/$(srcdir)/$(file) For now, we need to hack around it by copying xml to the build dir. + diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index af052c9d50..d14e8a4882 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -17,8 +17,8 @@ <!ENTITY GstEvent SYSTEM "xml/gstevent.xml"> <!ENTITY GstFormat SYSTEM "xml/gstformat.xml"> <!ENTITY GstIndex SYSTEM "xml/gstindex.xml"> +<!ENTITY GstImplementsInterface SYSTEM "xml/gstimplementsinterface.xml"> <!ENTITY GstInfo SYSTEM "xml/gstinfo.xml"> -<!ENTITY GstInterface SYSTEM "xml/gstinterface.xml"> <!ENTITY GstLog SYSTEM "xml/gstlog.xml"> <!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml"> <!ENTITY GstObject SYSTEM "xml/gstobject.xml"> @@ -35,7 +35,7 @@ <!ENTITY GstStructure SYSTEM "xml/gststructure.xml"> <!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml"> <!ENTITY GstTag SYSTEM "xml/gsttag.xml"> -<!ENTITY GstTagInterface SYSTEM "xml/gsttaginterface.xml"> +<!ENTITY GstTagSetter SYSTEM "xml/gsttagsetter.xml"> <!ENTITY GstThread SYSTEM "xml/gstthread.xml"> <!ENTITY GstTrace SYSTEM "xml/gsttrace.xml"> <!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml"> @@ -70,10 +70,12 @@ <chapter id="gstreamer"> <title>GStreamer Core Library - libgstreamer-0.8.so provides all the core GStreamer services, -including initialization, plugin management and types, as -well as the object hierarchy that defines elements and bins, along -with some more specialized elements. + + libgstreamer-&GST_MAJORMINOR;.so provides all the core GStreamer services, + including initialization, plugin management and types, + as well as the object hierarchy that defines elements and bins, + along with some more specialized elements. + &Gst; &GstBin; @@ -89,7 +91,7 @@ with some more specialized elements. &GstFormat; &GstIndex; &GstInfo; - &GstInterface; + &GstImplementsInterface; &GstObject; &GstPad; &GstParse; @@ -105,7 +107,7 @@ with some more specialized elements. &GstStructure; &GstSystemClock; &GstTag; - &GstTagInterface; + &GstTagSetter; &GstThread; &GstTypeFind; &GstUri; @@ -118,6 +120,7 @@ with some more specialized elements. GStreamer Core Support + Theses elements support the gstreamer core and applications using it. &GstAtomic; @@ -126,6 +129,7 @@ with some more specialized elements. + + + + + + + + + + +@gstbin: the object which received the signal. +@arg1: the element that was added to the bin + + + + + + +@gstbin: the object which received the signal. +@arg1: the element that was removed from the bin + + + +This signal is emitted when a bin iterates, either automatically or +due to a #gst_bin_iterate() call. The return value is used to +determine if the object method handler processed any data. +In most normal cases, a user-provided signal handler should return +FALSE. + + +@gstbin: the object which received the signal. +@Returns: TRUE if the state of the bin was advanced. + Flags for a bin. diff --git a/docs/gst/tmpl/gstconfig.sgml b/docs/gst/tmpl/gstconfig.sgml index 16c15e5236..83d755ff79 100644 --- a/docs/gst/tmpl/gstconfig.sgml +++ b/docs/gst/tmpl/gstconfig.sgml @@ -6,7 +6,7 @@ Configuration options -This describes the configureation options for GStreamer. When building +This describes the configuration options for GStreamer. When building GStreamer there are a lot of parts (known internally as "subsystems" ) that can be disabled for various reasons. The most common reasons are speed and size, which is important because GStreamer is designed to run on embedded systems. diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 6263b4e824..9cb0d30b10 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -152,41 +152,12 @@ and gst_element_set_clock(). You can wait for the clock to reach a given @arg1: @arg2: - + -@parent_class: -@details: -@elementfactory: -@padtemplates: -@numpadtemplates: -@state_change: -@new_pad: -@pad_removed: -@error: -@eos: -@found_tag: -@set_property: -@get_property: -@release_locks: -@get_event_masks: -@send_event: -@get_formats: -@convert: -@get_query_types: -@query: -@change_state: -@request_new_pad: -@release_pad: -@get_clock: -@set_clock: -@get_index: -@set_index: -@set_state: -@no_more_pads: -@_gst_reserved: + @@ -292,14 +263,6 @@ The Element is going from the READY state to the NULL state. - - - - - -@klass: - - Helper macro to create query type functions @@ -1255,14 +1218,6 @@ Sets the parent of an element. @element: - - - - - -@Returns: - - @@ -1413,14 +1368,6 @@ Sets the parent of an element. - - - - - -@parent_class: -@_gst_reserved: - @@ -1428,35 +1375,3 @@ Sets the parent of an element. - - - - - -@obj: - - - - - - - -@klass: - - - - - - - -@obj: - - - - - - - -@klass: - - diff --git a/docs/gst/tmpl/gstenumtypes.sgml b/docs/gst/tmpl/gstenumtypes.sgml index 1cd3b59858..7d12cec1f5 100644 --- a/docs/gst/tmpl/gstenumtypes.sgml +++ b/docs/gst/tmpl/gstenumtypes.sgml @@ -14,342 +14,11 @@ gstenumtypes - + -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: @@ -359,57 +28,67 @@ gstenumtypes - - - - - -@Returns: - - - + - - - - - -@Returns: - - - + - - - - - -@Returns: - - - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -@Returns: @@ -419,222 +98,18 @@ gstenumtypes - - - - - -@Returns: - - - + - + -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - - - -@Returns: @@ -644,14 +119,6 @@ gstenumtypes - - - - - -@Returns: - - @@ -659,72 +126,109 @@ gstenumtypes - - - - - -@Returns: - - - + - - - - - -@Returns: - - - + - - - - - -@Returns: - - - + - - - - - -@Returns: - - - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -@Returns: @@ -734,3 +238,115 @@ gstenumtypes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gsterror.sgml b/docs/gst/tmpl/gsterror.sgml index 369c59113c..6a59eec53e 100644 --- a/docs/gst/tmpl/gsterror.sgml +++ b/docs/gst/tmpl/gsterror.sgml @@ -126,14 +126,6 @@ Categorized error messages - - - - - -@Returns: - - diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml index c9e12a9009..7ba8e19018 100644 --- a/docs/gst/tmpl/gstevent.sgml +++ b/docs/gst/tmpl/gstevent.sgml @@ -27,6 +27,23 @@ gst_event_new_flush() creates a new flush event. #GstPad, #GstElement + + + + + + + + + + + + +@data: +@type: +@timestamp: +@src: + The different major types of events. @@ -308,16 +325,6 @@ Get access to the rate vale field @event: The event to query - - - - - -@data: -@type: -@timestamp: -@src: - diff --git a/docs/gst/tmpl/gstinterface.sgml b/docs/gst/tmpl/gstimplementsinterface.sgml similarity index 80% rename from docs/gst/tmpl/gstinterface.sgml rename to docs/gst/tmpl/gstimplementsinterface.sgml index 10754ef77f..907dfa11d2 100644 --- a/docs/gst/tmpl/gstinterface.sgml +++ b/docs/gst/tmpl/gstimplementsinterface.sgml @@ -1,8 +1,8 @@ -GstInterface +GstImplementsInterface -Core interfaces implemented by #GstElements +Core interface implemented by #GstElements that allows runtime querying of interface availabillity @@ -14,6 +14,13 @@ Core interfaces implemented by #GstElements + + + + + + + diff --git a/docs/gst/tmpl/gstindex.sgml b/docs/gst/tmpl/gstindex.sgml index 7e535c13cf..aef57d3252 100644 --- a/docs/gst/tmpl/gstindex.sgml +++ b/docs/gst/tmpl/gstindex.sgml @@ -445,68 +445,12 @@ Check if the index can be written to - - - - - -@obj: - - - - - - - -@obj: - - - - - - - -@klass: - - - - - - - -@klass: - - - - - - - -@obj: - - The GstIndexFactory object - - - - - -@parent: -@_gst_reserved: - - - - - - -@Returns: - - diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index e91a04c206..9bd3330586 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -25,12 +25,58 @@ object. - + + + + + + + + +The deep notify signal is used to be notified of property changes. +it is typically attached to the toplevel bin to receive notifications +from all the elements contained in that bin. + + +@gstobject: the object which received the signal. +@arg1: the object that originated the signal +@arg2: the property that changed + + + +Is trigered whenever a new object is saved to XML. You can connect to +this signal to insert custom XML tags into the core XML. + + +@gstobject: the object which received the signal. +@arg1: the xmlNodePtr of the parent node + + + +Is emitted when the parent of an object is set. + + +@gstobject: the object which received the signal. +@arg1: the new parent + + + +Is emitted when the parent of an object is unset. + + +@gstobject: the object which received the signal. +@arg1: the old parent + + + +The name of the object + + + -@klass: diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 509ad9885e..f59232e359 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -63,14 +63,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1) - - - - - -@parent_class: -@_gst_reserved: - @@ -88,40 +80,26 @@ Last reviewed on December 13th, 2002 (0.5.0.1) - + + +The padtemplate object. + + + + + +This signal is fired when an element creates a pad from this +template. + + +@gstpadtemplate: the object which received the signal. +@arg1: The pad that was created. + + -@parent_class: -@caps_nego_failed: -@linked: -@unlinked: -@appfixatefunc: -@_gst_reserved: - - - - - - -@parent_class: -@_gst_reserved: - - - - - - -@obj: - - - - - - - -@klass: @@ -131,14 +109,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1) - - - - - -@obj: - - @@ -147,32 +117,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1) @obj: - - - - - -@klass: - -@obj: - - - - - - - -@obj: - - - - - - - -@klass: - - @@ -180,14 +124,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1) - - - - - -@obj: - - @@ -196,17 +132,7 @@ Last reviewed on December 13th, 2002 (0.5.0.1) @obj: - - - - - -@klass: - -@obj: - - - + @@ -214,14 +140,6 @@ Last reviewed on December 13th, 2002 (0.5.0.1) @obj: - - - - - -@klass: - - @@ -807,40 +725,6 @@ Checks if the pad is a sink pad. - - - - - -@obj: - - - - - - - -@klass: - - - - - - - -@obj: - - - - - - - -@klass: - -@obj: - - Indicates when this pad will become available. @@ -910,22 +794,6 @@ Check if the properties of the padtemplate are fixed @caps: - - - - - -@Returns: - - - - - - - -@Returns: - - @@ -1786,14 +1654,6 @@ Remove the probe from the pad @Returns: - - - - - -@Returns: - - diff --git a/docs/gst/tmpl/gstparse.sgml b/docs/gst/tmpl/gstparse.sgml index 0eaf7a4789..0590e21501 100644 --- a/docs/gst/tmpl/gstparse.sgml +++ b/docs/gst/tmpl/gstparse.sgml @@ -2,7 +2,7 @@ gstparse - +get a pipeline from a text pipeline description diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml index ce74670217..764b6b8f07 100644 --- a/docs/gst/tmpl/gstplugin.sgml +++ b/docs/gst/tmpl/gstplugin.sgml @@ -58,14 +58,6 @@ The plugin loading errors @GST_PLUGIN_ERROR_DEPENDENCIES: The plugin has unresolved dependencies @GST_PLUGIN_ERROR_NAME_MISMATCH: - - - - - -@plugin: - - The plugin object @@ -173,14 +165,6 @@ It will be called by the loader at statup. - - - - - -@Returns: - - diff --git a/docs/gst/tmpl/gstqueue.sgml b/docs/gst/tmpl/gstqueue.sgml index 5eb283adb6..477e851f89 100644 --- a/docs/gst/tmpl/gstqueue.sgml +++ b/docs/gst/tmpl/gstqueue.sgml @@ -112,17 +112,6 @@ The queue blocks by default. - - - - - -@parent_class: -@underrun: -@running: -@overrun: -@_gst_reserved: - diff --git a/docs/gst/tmpl/gstscheduler.sgml b/docs/gst/tmpl/gstscheduler.sgml index 67a27a4071..46c5ff151d 100644 --- a/docs/gst/tmpl/gstscheduler.sgml +++ b/docs/gst/tmpl/gstscheduler.sgml @@ -20,34 +20,6 @@ This is a base class for custom schedulers. - - - - - -@parent_class: -@setup: -@reset: -@add_element: -@remove_element: -@add_scheduler: -@remove_scheduler: -@state_transition: -@scheduling_change: -@lock_element: -@unlock_element: -@yield: -@interrupt: -@error: -@pad_link: -@pad_unlink: -@pad_select: -@clock_wait: -@iterate: -@show: -@object_sync: -@_gst_reserved: - Flags for the scheduler @@ -307,48 +279,6 @@ The state of the scheduler - - - - - -@obj: - - - - - - - -@obj: - - - - - - - -@klass: - - - - - - - -@klass: - -@obj: - - - - - - - -@obj: - - @@ -362,22 +292,6 @@ The state of the scheduler - - - - - -@parent: -@_gst_reserved: - - - - - - -@Returns: - - diff --git a/docs/gst/tmpl/gsttaginterface.sgml b/docs/gst/tmpl/gsttagsetter.sgml similarity index 98% rename from docs/gst/tmpl/gsttaginterface.sgml rename to docs/gst/tmpl/gsttagsetter.sgml index 0dc5abbd2d..4c55270c64 100644 --- a/docs/gst/tmpl/gsttaginterface.sgml +++ b/docs/gst/tmpl/gsttagsetter.sgml @@ -1,5 +1,5 @@ -GstTagInterface +GstTagSetter Element interface that allows setting and retrieval of media metadata diff --git a/docs/gst/tmpl/gsttypefind.sgml b/docs/gst/tmpl/gsttypefind.sgml index 72f211e175..ee43012c65 100644 --- a/docs/gst/tmpl/gsttypefind.sgml +++ b/docs/gst/tmpl/gsttypefind.sgml @@ -2,7 +2,7 @@ GstTypeFindElement - +typefinding subsystem diff --git a/docs/gst/tmpl/gsttypes.sgml b/docs/gst/tmpl/gsttypes.sgml index dcf6af2d83..dbf8240dcb 100644 --- a/docs/gst/tmpl/gsttypes.sgml +++ b/docs/gst/tmpl/gsttypes.sgml @@ -14,300 +14,6 @@ gsttypes - - - - - - - - -The deep notify signal is used to be notified of property changes. -it is typically attached to the toplevel bin to receive notifications -from all the elements contained in that bin. - - -@gstobject: the object which received the signal. -@arg1: the object that originated the signal -@arg2: the property that changed - - - -Is trigered whenever a new object is saved to XML. You can connect to -this signal to insert custom XML tags into the core XML. - - -@gstobject: the object which received the signal. -@arg1: the xmlNodePtr of the parent node - - - -Is emitted when the parent of an object is set. - - -@gstobject: the object which received the signal. -@arg1: the new parent - - - -Is emitted when the parent of an object is unset. - - -@gstobject: the object which received the signal. -@arg1: the old parent - - - -The name of the object - - - - - - - -@parent_class: -@path_string_separator: -@signal_object: -@parent_set: -@parent_unset: -@object_saved: -@deep_notify: -@destroy: -@save_thyself: -@restore_thyself: -@_gst_reserved: - - - - - - - - - - - - -@parent_class: -@_gst_reserved: - - - -The padtemplate object. - - - - - -This signal is fired when an element creates a pad from this -template. - - -@gstpadtemplate: the object which received the signal. -@arg1: The pad that was created. - - - - - - -@parent_class: -@pad_created: -@_gst_reserved: - - - - - - - - - - - - -@gstelement: the object which received the signal. - - - - - - -@gstelement: the object which received the signal. -@arg1: -@arg2: -@arg3: - - - - - - -@gstelement: the object which received the signal. -@arg1: -@arg2: - - - - - - -@gstelement: the object which received the signal. -@arg1: - - - - - - -@gstelement: the object which received the signal. - - - - - - -@gstelement: the object which received the signal. -@arg1: - - - - - - -@gstelement: the object which received the signal. -@arg1: -@arg2: - - - - - - -@parent_class: -@details: -@elementfactory: -@padtemplates: -@numpadtemplates: -@state_change: -@new_pad: -@pad_removed: -@error: -@eos: -@found_tag: -@set_property: -@get_property: -@release_locks: -@get_event_masks: -@send_event: -@get_formats: -@convert: -@get_query_types: -@query: -@change_state: -@request_new_pad: -@release_pad: -@get_clock: -@set_clock: -@get_index: -@set_index: -@set_state: -@no_more_pads: -@_gst_reserved: - - - - - - - - - - - - -@gstbin: the object which received the signal. -@arg1: the element that was added to the bin - - - - - - -@gstbin: the object which received the signal. -@arg1: the element that was removed from the bin - - - -This signal is emitted when a bin iterates, either automatically or -due to a #gst_bin_iterate() call. The return value is used to -determine if the object method handler processed any data. -In most normal cases, a user-provided signal handler should return -FALSE. - - -@gstbin: the object which received the signal. -@Returns: TRUE if the state of the bin was advanced. - - - - - - -@parent_class: -@add_element: -@remove_element: -@child_state_change: -@iterate: -@element_added: -@element_removed: -@_gst_reserved: - - - - - - - - - - - - -@parent_class: -@setup: -@reset: -@add_element: -@remove_element: -@add_scheduler: -@remove_scheduler: -@state_transition: -@scheduling_change: -@lock_element: -@unlock_element: -@yield: -@interrupt: -@error: -@pad_link: -@pad_unlink: -@pad_select: -@clock_wait: -@iterate: -@show: -@object_sync: -@_gst_reserved: - - - - - - -@data: -@type: -@timestamp: -@src: - diff --git a/docs/gst/tmpl/gsturi.sgml b/docs/gst/tmpl/gsturi.sgml index 89646ae08f..8c75213488 100644 --- a/docs/gst/tmpl/gsturi.sgml +++ b/docs/gst/tmpl/gsturi.sgml @@ -31,56 +31,19 @@ and the element property that can handle a given URI. - - - - - -@obj: - - - - - - - -@obj: - - - - - - - -@obj: - - - - - - - -@obj: - - - + -@parent: -@new_uri: -@get_type: -@get_protocols: -@get_uri: -@set_uri: -@_gst_reserved: +@type: + diff --git a/docs/gst/tmpl/gsturitype.sgml b/docs/gst/tmpl/gsturitype.sgml index 15ad3c748c..6b9ca13f47 100644 --- a/docs/gst/tmpl/gsturitype.sgml +++ b/docs/gst/tmpl/gsturitype.sgml @@ -21,11 +21,3 @@ GstURIType - - - - - -@Returns: - - diff --git a/docs/gst/tmpl/gstutils.sgml b/docs/gst/tmpl/gstutils.sgml index 630ad43a5f..b05d1aadd1 100644 --- a/docs/gst/tmpl/gstutils.sgml +++ b/docs/gst/tmpl/gstutils.sgml @@ -2,7 +2,7 @@ gstutils - +various utility functions diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml index 7358e45125..ccad08d7d5 100644 --- a/docs/gst/tmpl/gstxml.sgml +++ b/docs/gst/tmpl/gstxml.sgml @@ -2,7 +2,7 @@ GstXML - +XML save/restore operations of pipelines diff --git a/docs/pwg/advanced-dparams.xml b/docs/pwg/advanced-dparams.xml index 973c1eb475..5e7abcc1a1 100644 --- a/docs/pwg/advanced-dparams.xml +++ b/docs/pwg/advanced-dparams.xml @@ -50,7 +50,7 @@ Frequency and resolution of updates Object properties will only be updated between calls to _get, _chain or _loop - dparams can be updated at any rate independant of calls to _get, _chain or _loop up to sample-level accuracy + dparams can be updated at any rate independent of calls to _get, _chain or _loop up to sample-level accuracy @@ -124,7 +124,7 @@ - Defining Parameter Specificiations + Defining Parameter Specifications You can define the dparams you need anywhere within your element but will usually need to do so in only a couple of places: @@ -139,7 +139,7 @@ Whenever a new pad is created so that parameters can affect data going into or out of a specific pad. An example of this would be a mixer - element where a seperate volume parameter is needed on every pad. + element where a separate volume parameter is needed on every pad. @@ -203,7 +203,7 @@ This method is the simplest and has the lowest overhead for parameters which change less frequently than the sample rate. First you need somewhere to store the parameter - this will usually be in your element's - stuct. + struct. struct _GstExample { @@ -248,7 +248,7 @@ The following code illustrates an instance where you might want to use the callback method. If you had a volume dparam which was represented by a - gfloat number, your element may only deal with integer arithmatic. The + gfloat number, your element may only deal with integer arithmetic. The callback could be used to calculate the integer scaler when the volume changes. First you will need somewhere to store these values. @@ -281,7 +281,7 @@ ); - The callback function needs to conform to this signiture + The callback function needs to conform to this signature typedef void (*GstDPMUpdateFunction) (GValue *value, gpointer data); @@ -335,7 +335,7 @@ gst_example_update_volume(GValue *value, gpointer data) The array method is currently the least mature of the three methods and is not yet ready to be used in elements, but plugin writers should be aware - of its existance for the future. + of its existence for the future. @@ -491,7 +491,7 @@ example_chain (GstPad *pad, GstBuffer *buf) - DParam Manager Modes + Dynamic Parameters for Video All of the explanation so far has presumed that the buffer contains audio data with many samples. Video should be regarded differently since a video diff --git a/docs/pwg/advanced-events.xml b/docs/pwg/advanced-events.xml index 3a63f20cd7..5c51e66a24 100644 --- a/docs/pwg/advanced-events.xml +++ b/docs/pwg/advanced-events.xml @@ -1,7 +1,7 @@ Events: Seeking, Navigation and More - There are many different event types but only 2 ways they can travel accross + There are many different event types but only 2 ways they can travel across the pipeline: downstream or upstream. It is very important to understand how both of those methods work because if one element in the pipeline is not handling them correctly the whole event system of the pipeline is broken. @@ -17,7 +17,7 @@ or directly in the function call arguments. So when receiving dataflow from the sink pad you have to check first if this data chunk is an event. If that's the case you check what kind of event it is to react on relevant - ones and then forward others dowstream using + ones and then forward others downstream using gst_pad_event_default. Here is an example for both loop and chain based elements. @@ -157,7 +157,7 @@ gst_my_filter_handle_src_event (GstPad *pad, All Events Together In this chapter follows a list of all defined events that are currently - being used, plus how they should be used/interpretted. Events are stored + being used, plus how they should be used/interpreted. Events are stored in a GstEvent structure, which is simply a big C union with the types for each event in it. For the next development cycle, we intend to switch events over to GstStructure, @@ -186,7 +186,7 @@ gst_my_filter_handle_src_event (GstPad *pad, downstream and set itself to EOS (gst_element_set_eos ()). gst_pad_event_default () takes care of all this, so most elements do not need to support this event. Exceptions are - elements that explicitely need to close a resource down on EOS, and + elements that explicitly need to close a resource down on EOS, and N-to-1 elements. Note that the stream itself is not a resource that should be closed down on EOS! Applications might seek back to a point before EOS and set the pipeline to PLAYING again. diff --git a/docs/pwg/building-boiler.xml b/docs/pwg/building-boiler.xml index 95df88f30e..8773102dfe 100644 --- a/docs/pwg/building-boiler.xml +++ b/docs/pwg/building-boiler.xml @@ -174,7 +174,7 @@ U gst-template/gst-app/src/Makefile.am GstElementDetails - The GstElementDetails structure gives a heirarchical type for the element, + The GstElementDetails structure gives a hierarchical type for the element, a human-readable description of the element, as well as author and version data. The entries are: @@ -182,7 +182,7 @@ U gst-template/gst-app/src/Makefile.am A long, english, name for the element. - The type of the element, as a heirarchy. The heirarchy is defined by + The type of the element, as a hierarchy. The hierarchy is defined by specifying the top level category, followed by a "/", followed by the next level category, etc. The type should be defined according to the guidelines elsewhere in this document. (FIXME: write the guidelines, and diff --git a/docs/random/ensonic/dparams.txt b/docs/random/ensonic/dparams.txt index 77a6cc6137..875b22330d 100644 --- a/docs/random/ensonic/dparams.txt +++ b/docs/random/ensonic/dparams.txt @@ -1,11 +1,21 @@ $Id$ * cleanup of dparams + * even though it is long try to stick to the prefix "dparam" for the whole library + * e.g. avoid namespace clashes with "dataprotocol" which is using "dp" as well :-( * resolve g_return_if_fail() into GST_WARNING and return() in cases where the caller has to handle the problem * rename GST_TYPE_DPSMOOTH to GST_TYPE_DPARAM_SMOOTH GST_TYPE_DP_LININT to GST_TYPE_DPARAM_LININT there seems to be nobody using them, as they still look unfinished + * move modes into extra modules + dparam_mode_synchronous + dparam_mode_asynchronous + dparam_mode_disabled + +* documentation + * state of unitconvert + * state of sychronous params * concept for global, voice params diff --git a/docs/random/ensonic/interfaces.txt b/docs/random/ensonic/interfaces.txt new file mode 100644 index 0000000000..4291f638e8 --- /dev/null +++ b/docs/random/ensonic/interfaces.txt @@ -0,0 +1,32 @@ +$Id$ + +* new general interfaces + * GST_TYPE_PRESET_MANAGER + - add preset managment + - API: + GList *get_presets(); + void activate_preset_by_index(glong index); + void activate_preset_by_name(const gchar *name); + void add_current(const gchar *name); + void remove_preset_by_index(glong index); + void remove_preset_by_name(const gchar *name); + - features + - there should always be a default preset + - questions + - were and how do we store the presets? + + * GST_TYPE_UI_HINT + - add hints to generate 'good' looking interfaces to elements + - API: + - features + - grouping of parameters + +* new interfaces for audio applications + * GST_TYPE_MUSIC_GENERATOR + - add hints so that application can find out which params to use to + play notes and/or to trigger sounds + - API: + DParam *get_note_dparam(); + DParam *get_trigger_dparam(); + - questions + - can we use this to support multiple voices? diff --git a/gst/gsterror.h b/gst/gsterror.h index ea7f124414..9ffac98751 100644 --- a/gst/gsterror.h +++ b/gst/gsterror.h @@ -38,7 +38,7 @@ G_BEGIN_DECLS * the core GStreamer library */ /* FIXME: should we divide in numerical blocks so we can easily add for example PAD errors later ? */ - typedef enum +typedef enum { GST_CORE_ERROR_FAILED = 1, GST_CORE_ERROR_TOO_LAZY, diff --git a/gst/gstinterface.h b/gst/gstinterface.h index 8cd5ba3b14..391a31236e 100644 --- a/gst/gstinterface.h +++ b/gst/gstinterface.h @@ -45,11 +45,13 @@ G_BEGIN_DECLS typedef struct _GstImplementsInterface GstImplementsInterface; +typedef struct _GstImplementsInterfaceClass GstImplementsInterfaceClass; + /* This small extra virtual function is here to provide an * interface functionality on a per-instance basis rather * than a per-class basis, which is the case for glib. */ -typedef struct _GstImplementsInterfaceClass { +struct _GstImplementsInterfaceClass { GTypeInterface parent; /* virtual functions */ @@ -57,7 +59,7 @@ typedef struct _GstImplementsInterfaceClass { GType iface_type); gpointer _gst_reserved[GST_PADDING]; -} GstImplementsInterfaceClass; +}; #define GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST(obj, type, cast_t) \ ((cast_t *) gst_implements_interface_cast ((obj), (type))) diff --git a/gst/gstparse.h b/gst/gstparse.h index a63fa24d45..b3221a9e82 100644 --- a/gst/gstparse.h +++ b/gst/gstparse.h @@ -2,7 +2,7 @@ * Copyright (C) 1999,2000 Erik Walthinsen * 2000 Wim Taymans * - * filename: + * gstparse.h: get a pipeline from a text pipeline description * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public diff --git a/gst/gstxml.h b/gst/gstxml.h index db34c26f1c..0ab06f8de2 100644 --- a/gst/gstxml.h +++ b/gst/gstxml.h @@ -2,7 +2,7 @@ * Copyright (C) 1999,2000 Erik Walthinsen * 2000 Wim Taymans * - * gstxml.h: Header for XML save/restore operations + * gstxml.h: Header for XML save/restore operations of pipelines * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public diff --git a/libs/gst/control/control.c b/libs/gst/control/control.c index e5c530e23d..750144443a 100644 --- a/libs/gst/control/control.c +++ b/libs/gst/control/control.c @@ -26,6 +26,13 @@ GST_DEBUG_CATEGORY (_gst_control_debug); #define GST_CAT_DEFAULT _gst_control_debug +/** + * gst_control_init: + * @argc: pointer to application's argc + * @argv: pointer to application's argv + * + * Initializes the GStreamer control library, registering modes and units + */ void gst_control_init (int *argc, char **argv[]) {