From 978c272fa3886f9fa2762028dd64dfc487840fc7 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Tue, 31 Aug 2004 17:14:03 +0000 Subject: [PATCH] moved docs to sgml files added first batch of docs provided by ronald Original commit message from CVS: moved docs to sgml files added first batch of docs provided by ronald --- docs/gst/tmpl/gstbuffer.sgml | 40 ++++++++++++-------- docs/gst/tmpl/gstelement.sgml | 8 ++-- docs/gst/tmpl/gstplugin.sgml | 60 +++++++++++++++--------------- docs/random/ensonic/interfaces.txt | 10 +++++ gst/gst.h | 7 +++- gst/gstplugin.h | 30 --------------- 6 files changed, 76 insertions(+), 79 deletions(-) diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index a528bb1d96..fda83c942b 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -213,15 +213,16 @@ Gets the timestamp for this buffer. - +Gets the duration in nanoseconds of the data in the buffer. +Value will be GST_CLOCK_TIME_NONE if the duration is unknown. -@buf: +@buf: a #GstBuffer to get the duration from. -Gets the offset in the source file of this buffer. +Gets the offset in the source file of the beinning of this buffer. @buf: a #GstBuffer to get offset of. @@ -229,10 +230,10 @@ Gets the offset in the source file of this buffer. - +Gets the offset in the source file of the end of this buffer. -@buf: +@buf: a #GstBuffer to get offset of. @@ -410,26 +411,35 @@ Calls the buffer-specific free function on the given buffer. - +A function that should be called if the buffer has no more references left. +Elements that utilize hardware memory could use this to re-queue +the buffer after it's been unreferenced. If no free_data_func has been +provided, the default will be used which simply deallocates the memory +region and the GstBuffer object. Manual implementations that want to +free their own memory but don't do anything special otherwise are +suggested to set the GST_BUFFER_DONTFREE flag on the buffer and call the +default data free function (gst_buffer_default_free()) from their manual +implementation. -@buf: +@buf: the #GstBuffer this function belongs to - +the type for the GST_BUFFER_FREE_DATA_FUNC -@buffer: +@buffer: the #GstBuffer on which it will operate, when called - +Private data for the buffer. This can be used to store a pointer to the +object that can then be retrieved in something like the BUFFER_FREE_DATA_FUNC. -@buf: +@buf: the #GstBuffer this data belongs to @@ -448,18 +458,18 @@ Calls the buffer-specific free function on the given buffer. - +Tests if the duration is known. -@buffer: +@buffer: the #GstBuffer to check for the duration - +Tests if the timestamp is known. -@buffer: +@buffer: the #GstBuffer to check for the timestamp diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index ee370e94b1..fe5f2b3247 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -343,13 +343,15 @@ Get the pads of this elements. - +Utility function that elements can use in case they encountered a fatal +data processing error. The pipeline will throw an error signal and the +application will be requested to stop further media processing. -@el: +@el: the element that throws the error @domain: @code: -@message: +@message: the message to display @debug: diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml index 764b6b8f07..126c96393c 100644 --- a/docs/gst/tmpl/gstplugin.sgml +++ b/docs/gst/tmpl/gstplugin.sgml @@ -77,16 +77,16 @@ A plugins should export a variable of this type called plugin_desc. This plugin loaded will use this variable to initialize the plugin. -@major_version: The minor version of the gstreamer library this plugin was created with -@minor_version: The minor version of the gstreamer library this plugin was created with -@name: The name of the plugin +@major_version: the major version number of core that plugin was compiled for +@minor_version: the minor version number of core that plugin was compiled for +@name: a unique name of the plugin @description: @plugin_init: The init function of this plugin. @plugin_exit: -@version: -@license: -@package: -@origin: +@version: version of the plugin +@license: effective license of plugin +@package: package plugin belongs to +@origin: URL to provider of plugin @_gst_reserved: @@ -103,42 +103,44 @@ It will be called by the loader at statup. - +Exiting function when plugin is unloaded. -@plugin: +@plugin: The plugin object that can be used to unregister stuff for this plugin. - +This macro needs to be used to define the entry point and meta data of a plugin. +One would use this macro to export a plugin, so that it can be used by other applications -@major: -@minor: -@name: -@description: -@init: -@version: -@license: -@package: -@origin: +@major: major version number of the gstreamer-core that plugin was compiled for +@minor: minor version number of the gstreamer-core that plugin was compiled for +@name: short, but unique name of the plugin +@description: information about the purpose of the plugin +@init: function pointer to the plugin_init method with the signature of static gboolean plugin_init (GstPlugin * plugin). +@version: full version string (e.g. VERSION from config.h) +@license: under which licence the package has been released, e.g. GPL, LGPL. +@package: the package-name (e.g. PACKAGE_NAME from config.h) +@origin: a description from where the package comes from (e.g. the homepage URL) - +This macro needs to be used to define the entry point and meta data of a local plugin. +One would use this macro to define a local plugin that can only be used by the own application. -@major: -@minor: -@name: -@description: -@init: -@version: -@license: -@package: -@origin: +@major: major version number of the gstreamer-core that plugin was compiled for +@minor: minor version number of the gstreamer-core that plugin was compiled for +@name: short, but unique name of the plugin +@description: information about the purpose of the plugin +@init: function pointer to the plugin_init method with the signature of static gboolean plugin_init (GstPlugin * plugin). +@version: full version string (e.g. VERSION from config.h) +@license: under which licence the package has been released, e.g. GPL, LGPL. +@package: the package-name (e.g. PACKAGE_NAME from config.h) +@origin: a description from where the package comes from (e.g. the homepage URL) diff --git a/docs/random/ensonic/interfaces.txt b/docs/random/ensonic/interfaces.txt index 726539d107..035f55fddf 100644 --- a/docs/random/ensonic/interfaces.txt +++ b/docs/random/ensonic/interfaces.txt @@ -1,5 +1,15 @@ $Id$ +* existing gstreamer interfaces + ./gstreamer/gst/gsttaginterface.c + ./gstreamer/gst/gstinterface.c + ./gstreamer/gst/gsturi.c + ./gst-plugins/gst-libs/gst/propertyprobe/propertyprobe.c + ./gst-plugins/gst-libs/gst/mixer/mixer.c + ./gst-plugins/gst-libs/gst/tuner/tuner.c + ./gst-plugins/gst-libs/gst/xoverlay/xoverlay.c + ./gst-plugins/gst-libs/gst/colorbalance/colorbalance.c + ./gst-plugins/gst-libs/gst/navigation/navigation.c * new general interfaces * GST_TYPE_PRESET_MANAGER - add preset managment diff --git a/gst/gst.h b/gst/gst.h index a38e9835ca..bbe8344836 100644 --- a/gst/gst.h +++ b/gst/gst.h @@ -70,9 +70,12 @@ G_BEGIN_DECLS -/* make our own type for poptOption because gtkdoc (1.2) can not handle functions with - * return types like 'struct abc' +/* make our own type for poptOption because gtkdoc-1.2 can not handle functions + * with return types like 'struct abc' * Filed as http://bugzilla.gnome.org/show_bug.cgi?id=148507 + * + * Btw. popt provides a typedef, but it is: + * typedef struct poptOption *poptOption */ typedef struct poptOption GstPoptOption; diff --git a/gst/gstplugin.h b/gst/gstplugin.h index 1dc5ee88ee..058cb1f352 100644 --- a/gst/gstplugin.h +++ b/gst/gstplugin.h @@ -80,21 +80,6 @@ struct _GstPlugin { gpointer _gst_reserved[GST_PADDING]; }; -/** - * GST_PLUGIN_DEFINE: - * @major: major version number - * @minor: minor version number - * @name: short name of the plugin - * @description: information about the purpose of the plugin - * @init: function pointer to the plugin_init method with the signature of static gboolean plugin_init (GstPlugin * plugin). - * @version: full version string (e.g. VERSION from config.h) - * @license: under which licence the package has been released, e.g. GPL, LGPL. - * @package: the package-name (e.g. PACKAGE_NAME from config.h) - * @origin: a description from where the package comes from (e.g. the homepage URL) - * - * This macro needs to be used to define the entry point and meta data of a plugin. - * One would use this macro to export a plugin, so that it can be used by other applications. - */ #define GST_PLUGIN_DEFINE(major,minor,name,description,init,version,license,package,origin) \ GST_PLUGIN_EXPORT GstPluginDesc gst_plugin_desc = { \ major, \ @@ -110,21 +95,6 @@ GST_PLUGIN_EXPORT GstPluginDesc gst_plugin_desc = { \ GST_PADDING_INIT \ }; -/** - * GST_PLUGIN_DEFINE_STATIC: - * @major: major version number - * @minor: minor version number - * @name: short name of the plugin - * @description: information about the purpose of the plugin - * @init: function pointer to the plugin_init method with the signature of static gboolean plugin_init (GstPlugin * plugin). - * @version: full version string (e.g. VERSION from config.h) - * @license: under which licence the package has been released, e.g. GPL, LGPL. - * @package: the package-name (e.g. PACKAGE_NAME from config.h) - * @origin: a description from where the package comes from (e.g. the homepage URL) - * - * This macro needs to be used to define the entry point and meta data of a local plugin. - * One would use this macro to define a local plugin that can only be used by the own application. - */ #define GST_PLUGIN_DEFINE_STATIC(major,minor,name,description,init,version,license,package,origin) \ static void GST_GNUC_CONSTRUCTOR \ _gst_plugin_static_init__ ##init (void) \