mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-23 16:50:47 +00:00
document core plugins in a separate document just like all the others rename these plugins to something starting with...
Original commit message from CVS: document core plugins in a separate document just like all the others rename these plugins to something starting with core
This commit is contained in:
parent
a5820445bf
commit
c37fca4fd4
27 changed files with 374 additions and 182 deletions
33
ChangeLog
33
ChangeLog
|
@ -1,3 +1,36 @@
|
||||||
|
2005-12-01 Thomas Vander Stichele <thomas (at) apestaart (dot) org>
|
||||||
|
|
||||||
|
* common/gst-xmlinspect.py:
|
||||||
|
* common/gtk-doc-plugins.mak:
|
||||||
|
* configure.ac:
|
||||||
|
* docs/Makefile.am:
|
||||||
|
* docs/gst/Makefile.am:
|
||||||
|
* docs/gst/gstreamer-docs.sgml:
|
||||||
|
* docs/gst/gstreamer-sections.txt:
|
||||||
|
* docs/gst/gstreamer.types:
|
||||||
|
* docs/gst/gstreamer.types.in:
|
||||||
|
* docs/plugins/Makefile.am:
|
||||||
|
* docs/plugins/gstreamer-plugins-docs.sgml:
|
||||||
|
* docs/plugins/gstreamer-plugins-sections.txt:
|
||||||
|
* docs/plugins/gstreamer-plugins.types:
|
||||||
|
* docs/plugins/inspect.stamp:
|
||||||
|
* docs/plugins/inspect/plugin-coreelements.xml:
|
||||||
|
* docs/plugins/inspect/plugin-coreindexers.xml:
|
||||||
|
* docs/plugins/scanobj-build.stamp:
|
||||||
|
* gstreamer.spec.in:
|
||||||
|
* plugins/elements/Makefile.am:
|
||||||
|
* plugins/elements/gstelements.c:
|
||||||
|
* plugins/elements/gstfakesink.c:
|
||||||
|
* plugins/elements/gstfakesrc.c:
|
||||||
|
* plugins/elements/gstfilesink.c:
|
||||||
|
* plugins/elements/gstfilesrc.c:
|
||||||
|
* plugins/elements/gstqueue.c:
|
||||||
|
* plugins/indexers/Makefile.am:
|
||||||
|
* plugins/indexers/gstindexers.c:
|
||||||
|
document core plugins in a separate document just like all the
|
||||||
|
others
|
||||||
|
rename these plugins to something starting with core
|
||||||
|
|
||||||
2005-12-01 Andy Wingo <wingo@pobox.com>
|
2005-12-01 Andy Wingo <wingo@pobox.com>
|
||||||
|
|
||||||
* gst/gstevent.h (struct _GstEvent): Meant to remove the extra
|
* gst/gstevent.h (struct _GstEvent): Meant to remove the extra
|
||||||
|
|
2
common
2
common
|
@ -1 +1 @@
|
||||||
Subproject commit f9f5f063728688cf455a1512d492b632c43963d7
|
Subproject commit 54bb21c57bb86941d80c15590e0a121405173156
|
|
@ -261,6 +261,7 @@ AM_CONDITIONAL(HAVE_VALGRIND, test ! "x$VALGRIND_PATH" = "xno")
|
||||||
dnl check for documentation tools
|
dnl check for documentation tools
|
||||||
GST_DOCBOOK_CHECK
|
GST_DOCBOOK_CHECK
|
||||||
GTK_DOC_CHECK([1.3])
|
GTK_DOC_CHECK([1.3])
|
||||||
|
AS_PATH_PYTHON([2.1])
|
||||||
|
|
||||||
dnl *** checks for libraries ***
|
dnl *** checks for libraries ***
|
||||||
|
|
||||||
|
@ -513,6 +514,7 @@ docs/faq/Makefile
|
||||||
docs/gst/Makefile
|
docs/gst/Makefile
|
||||||
docs/gst/gstreamer.types
|
docs/gst/gstreamer.types
|
||||||
docs/libs/Makefile
|
docs/libs/Makefile
|
||||||
|
docs/plugins/Makefile
|
||||||
docs/manual/Makefile
|
docs/manual/Makefile
|
||||||
docs/pwg/Makefile
|
docs/pwg/Makefile
|
||||||
docs/xsl/Makefile
|
docs/xsl/Makefile
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
if ENABLE_GTK_DOC
|
if ENABLE_GTK_DOC
|
||||||
SUBDIRS_GTK_DOC = gst libs
|
SUBDIRS_GTK_DOC = gst libs plugins
|
||||||
else
|
else
|
||||||
SUBDIRS_GTK_DOC =
|
SUBDIRS_GTK_DOC =
|
||||||
endif
|
endif
|
||||||
|
@ -13,7 +13,7 @@ endif
|
||||||
BUILT_SOURCES = version.entities
|
BUILT_SOURCES = version.entities
|
||||||
|
|
||||||
SUBDIRS = $(SUBDIRS_DOCBOOK) $(SUBDIRS_GTK_DOC)
|
SUBDIRS = $(SUBDIRS_DOCBOOK) $(SUBDIRS_GTK_DOC)
|
||||||
DIST_SUBDIRS = gst faq manual pwg libs xsl
|
DIST_SUBDIRS = gst libs plugins faq manual pwg xsl
|
||||||
|
|
||||||
EXTRA_DIST = \
|
EXTRA_DIST = \
|
||||||
slides manuals.mak htmlinstall.mak upload.mak \
|
slides manuals.mak htmlinstall.mak upload.mak \
|
||||||
|
|
|
@ -53,11 +53,7 @@ DOC_BUILD_DIR = $(top_builddir)/gst
|
||||||
HFILE_GLOB=$(top_srcdir)/gst/*.h $(top_srcdir)/libs/gst/*/*.h
|
HFILE_GLOB=$(top_srcdir)/gst/*.h $(top_srcdir)/libs/gst/*/*.h
|
||||||
CFILE_GLOB=$(top_srcdir)/gst/*.c $(top_srcdir)/libs/gst/*/*.c
|
CFILE_GLOB=$(top_srcdir)/gst/*.c $(top_srcdir)/libs/gst/*/*.c
|
||||||
|
|
||||||
# Dependencies for the intermediate scanobj tool
|
|
||||||
#SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \
|
|
||||||
# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
|
|
||||||
SCANOBJ_DEPS = \
|
SCANOBJ_DEPS = \
|
||||||
$(top_builddir)/plugins/elements/libgstelements.la \
|
|
||||||
$(top_builddir)/libs/gst/base/libgstbase-@GST_MAJORMINOR@.la \
|
$(top_builddir)/libs/gst/base/libgstbase-@GST_MAJORMINOR@.la \
|
||||||
$(top_builddir)/libs/gst/net/libgstnet-@GST_MAJORMINOR@.la
|
$(top_builddir)/libs/gst/net/libgstnet-@GST_MAJORMINOR@.la
|
||||||
|
|
||||||
|
|
|
@ -36,7 +36,6 @@
|
||||||
<!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
|
<!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
|
||||||
<!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
|
<!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
|
||||||
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
|
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
|
||||||
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
|
|
||||||
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
|
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
|
||||||
<!ENTITY GstSegment SYSTEM "xml/gstsegment.xml">
|
<!ENTITY GstSegment SYSTEM "xml/gstsegment.xml">
|
||||||
<!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
|
<!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
|
||||||
|
@ -53,10 +52,6 @@
|
||||||
<!ENTITY GstVersion SYSTEM "xml/gstversion.xml">
|
<!ENTITY GstVersion SYSTEM "xml/gstversion.xml">
|
||||||
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
|
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
|
||||||
|
|
||||||
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
|
|
||||||
<!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
|
|
||||||
<!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
|
|
||||||
<!ENTITY GstFileSink SYSTEM "xml/gstfilesink.xml">
|
|
||||||
<!--
|
<!--
|
||||||
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
|
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
|
||||||
<!ENTITY GstFdSrc SYSTEM "xml/gstfdsrc.xml">
|
<!ENTITY GstFdSrc SYSTEM "xml/gstfdsrc.xml">
|
||||||
|
@ -140,7 +135,6 @@ Windows. It is released under the GNU Library General Public License
|
||||||
&GstPlugin;
|
&GstPlugin;
|
||||||
&GstPluginFeature;
|
&GstPluginFeature;
|
||||||
&GstQuery;
|
&GstQuery;
|
||||||
&GstQueue;
|
|
||||||
&GstRegistry;
|
&GstRegistry;
|
||||||
&GstSegment;
|
&GstSegment;
|
||||||
&GstStructure;
|
&GstStructure;
|
||||||
|
@ -183,37 +177,6 @@ Windows. It is released under the GNU Library General Public License
|
||||||
</chapter>
|
</chapter>
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<chapter id="element-types">
|
|
||||||
<title>GStreamer Core Elements</title>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
libgstelements.so provide some basic elements like a file source
|
|
||||||
and sink. The use of these elements is strictly though the g_object_get() and
|
|
||||||
g_object_set() functions and the GStreamer Core Library functions.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
|
|
||||||
&GstFakeSrc;
|
|
||||||
&GstFakeSink;
|
|
||||||
&GstFileSrc;
|
|
||||||
&GstFileSink;
|
|
||||||
<!--
|
|
||||||
|
|
||||||
&GstAggregator;
|
|
||||||
|
|
||||||
&GstFdSrc;
|
|
||||||
&GstFdSink;
|
|
||||||
|
|
||||||
&GstPipefilter;
|
|
||||||
&GstIdentity;
|
|
||||||
|
|
||||||
&GstStatistics;
|
|
||||||
&GstMD5Sink;
|
|
||||||
|
|
||||||
&GstTee;
|
|
||||||
-->
|
|
||||||
</chapter>
|
|
||||||
|
|
||||||
<chapter id="gstreamer-hierarchy">
|
<chapter id="gstreamer-hierarchy">
|
||||||
<title>Object Hierarchy</title>
|
<title>Object Hierarchy</title>
|
||||||
&gstreamer-tree-index;
|
&gstreamer-tree-index;
|
||||||
|
|
|
@ -2171,94 +2171,3 @@ GST_TYPE_XML
|
||||||
<SUBSECTION Private>
|
<SUBSECTION Private>
|
||||||
gst_xml_get_type
|
gst_xml_get_type
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
# elements
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>gstfakesrc</FILE>
|
|
||||||
<TITLE>GstFakeSrc</TITLE>
|
|
||||||
<INCLUDE>plugins/elements/gstfakesrc.h</INCLUDE>
|
|
||||||
GstFakeSrc
|
|
||||||
GstFakeSrcDataType
|
|
||||||
GstFakeSrcFillType
|
|
||||||
GstFakeSrcOutputType
|
|
||||||
GstFakeSrcSizeType
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
GstFakeSrcClass
|
|
||||||
GST_FAKE_SRC
|
|
||||||
GST_IS_FAKE_SRC
|
|
||||||
GST_TYPE_FAKE_SRC
|
|
||||||
GST_FAKE_SRC_CLASS
|
|
||||||
GST_IS_FAKE_SRC_CLASS
|
|
||||||
<SUBSECTION Private>
|
|
||||||
gst_fake_src_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>gstfakesink</FILE>
|
|
||||||
<TITLE>GstFakeSink</TITLE>
|
|
||||||
<INCLUDE>plugins/elements/gstfakesink.h</INCLUDE>
|
|
||||||
GstFakeSink
|
|
||||||
GstFakeSinkStateError
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
GstFakeSinkClass
|
|
||||||
GST_FAKE_SINK
|
|
||||||
GST_IS_FAKE_SINK
|
|
||||||
GST_TYPE_FAKE_SINK
|
|
||||||
GST_FAKE_SINK_CLASS
|
|
||||||
GST_IS_FAKE_SINK_CLASS
|
|
||||||
<SUBSECTION Private>
|
|
||||||
gst_fake_sink_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>gstfilesrc</FILE>
|
|
||||||
<TITLE>GstFileSrc</TITLE>
|
|
||||||
<INCLUDE>plugins/elements/gstfilesrc.h</INCLUDE>
|
|
||||||
GstFileSrc
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
GstFileSrcClass
|
|
||||||
GST_FILE_SRC
|
|
||||||
GST_IS_FILE_SRC
|
|
||||||
GST_TYPE_FILE_SRC
|
|
||||||
GST_FILE_SRC_CLASS
|
|
||||||
GST_IS_FILE_SRC_CLASS
|
|
||||||
<SUBSECTION Private>
|
|
||||||
gst_file_src_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>gstfilesink</FILE>
|
|
||||||
<TITLE>GstFileSink</TITLE>
|
|
||||||
<INCLUDE>plugins/elements/gstfilesink.h</INCLUDE>
|
|
||||||
GstFileSink
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
GstFileSinkClass
|
|
||||||
GST_FILE_SINK
|
|
||||||
GST_IS_FILE_SINK
|
|
||||||
GST_TYPE_FILE_SINK
|
|
||||||
GST_FILE_SINK_CLASS
|
|
||||||
GST_IS_FILE_SINK_CLASS
|
|
||||||
<SUBSECTION Private>
|
|
||||||
gst_file_sink_get_type
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>gstqueue</FILE>
|
|
||||||
<TITLE>GstQueue</TITLE>
|
|
||||||
GstQueue
|
|
||||||
GstQueueSize
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
GstQueueClass
|
|
||||||
GST_QUEUE
|
|
||||||
GST_IS_QUEUE
|
|
||||||
GST_QUEUE_CLASS
|
|
||||||
GST_IS_QUEUE_CLASS
|
|
||||||
GST_TYPE_QUEUE
|
|
||||||
<SUBSECTION Private>
|
|
||||||
gst_queue_get_type
|
|
||||||
</SECTION>
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
|
|
|
@ -54,17 +54,3 @@ gst_push_src_get_type
|
||||||
|
|
||||||
gst_net_client_clock_get_type
|
gst_net_client_clock_get_type
|
||||||
gst_net_time_provider_get_type
|
gst_net_time_provider_get_type
|
||||||
|
|
||||||
% elements
|
|
||||||
|
|
||||||
#include <plugins/elements/gstfakesrc.h>
|
|
||||||
#include <plugins/elements/gstfakesink.h>
|
|
||||||
#include <plugins/elements/gstfilesrc.h>
|
|
||||||
#include <plugins/elements/gstfilesink.h>
|
|
||||||
#include <plugins/elements/gstqueue.h>
|
|
||||||
|
|
||||||
gst_fake_src_get_type
|
|
||||||
gst_fake_sink_get_type
|
|
||||||
gst_file_src_get_type
|
|
||||||
gst_file_sink_get_type
|
|
||||||
gst_queue_get_type
|
|
||||||
|
|
|
@ -54,17 +54,3 @@ gst_push_src_get_type
|
||||||
|
|
||||||
gst_net_client_clock_get_type
|
gst_net_client_clock_get_type
|
||||||
gst_net_time_provider_get_type
|
gst_net_time_provider_get_type
|
||||||
|
|
||||||
% elements
|
|
||||||
|
|
||||||
@GST_REGISTRY_DOC_TYPES@#include <plugins/elements/gstfakesrc.h>
|
|
||||||
@GST_REGISTRY_DOC_TYPES@#include <plugins/elements/gstfakesink.h>
|
|
||||||
@GST_REGISTRY_DOC_TYPES@#include <plugins/elements/gstfilesrc.h>
|
|
||||||
@GST_REGISTRY_DOC_TYPES@#include <plugins/elements/gstfilesink.h>
|
|
||||||
@GST_REGISTRY_DOC_TYPES@#include <plugins/elements/gstqueue.h>
|
|
||||||
|
|
||||||
@GST_REGISTRY_DOC_TYPES@gst_fake_src_get_type
|
|
||||||
@GST_REGISTRY_DOC_TYPES@gst_fake_sink_get_type
|
|
||||||
@GST_REGISTRY_DOC_TYPES@gst_file_src_get_type
|
|
||||||
@GST_REGISTRY_DOC_TYPES@gst_file_sink_get_type
|
|
||||||
@GST_REGISTRY_DOC_TYPES@gst_queue_get_type
|
|
||||||
|
|
105
docs/plugins/Makefile.am
Normal file
105
docs/plugins/Makefile.am
Normal file
|
@ -0,0 +1,105 @@
|
||||||
|
GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
|
||||||
|
|
||||||
|
## Process this file with automake to produce Makefile.in
|
||||||
|
|
||||||
|
# The name of the module, e.g. 'glib'.
|
||||||
|
#DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@
|
||||||
|
MODULE=gstreamer
|
||||||
|
DOC_MODULE=$(MODULE)-plugins
|
||||||
|
|
||||||
|
# for upload.mak
|
||||||
|
DOC=$(MODULE)-plugins
|
||||||
|
FORMATS=html
|
||||||
|
html: html-build.stamp
|
||||||
|
include $(srcdir)/../upload.mak
|
||||||
|
|
||||||
|
# generated basefiles
|
||||||
|
#basefiles = \
|
||||||
|
## $(DOC_MODULE).types \
|
||||||
|
# $(DOC_MODULE)-sections.txt \
|
||||||
|
# $(DOC_MODULE)-docs.sgml
|
||||||
|
|
||||||
|
# ugly hack to make -unused.sgml work
|
||||||
|
#unused-build.stamp:
|
||||||
|
# BUILDDIR=`pwd` && \
|
||||||
|
# cd $(srcdir)/tmpl && \
|
||||||
|
# ln -sf gstreamer-libs-unused.sgml \
|
||||||
|
# $$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
|
||||||
|
# touch unused-build.stamp
|
||||||
|
|
||||||
|
# these rules are added to create parallel docs using GST_MAJORMINOR
|
||||||
|
#$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
|
||||||
|
# cp $< $@
|
||||||
|
|
||||||
|
#CLEANFILES = $(basefiles)
|
||||||
|
|
||||||
|
# The top-level SGML file. Change it if you want.
|
||||||
|
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
|
||||||
|
|
||||||
|
# The directory containing the source code. Relative to $(top_srcdir).
|
||||||
|
# gtk-doc will search all .c & .h files beneath here for inline comments
|
||||||
|
# documenting functions and macros.
|
||||||
|
DOC_SOURCE_DIR = $(top_srcdir)/plugins
|
||||||
|
|
||||||
|
# Extra options to supply to gtkdoc-scan.
|
||||||
|
SCAN_OPTIONS=
|
||||||
|
|
||||||
|
# Extra options to supply to gtkdoc-mkdb.
|
||||||
|
MKDB_OPTIONS=--sgml-mode
|
||||||
|
|
||||||
|
# Extra options to supply to gtkdoc-fixref.
|
||||||
|
# FIXME get the location of the installed gstreamer docs
|
||||||
|
#FIXXREF_OPTIONS=--extra-dir=../gst/html
|
||||||
|
|
||||||
|
# Used for dependencies.
|
||||||
|
HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.h
|
||||||
|
CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
|
||||||
|
|
||||||
|
# this is a wingo addition
|
||||||
|
# thomasvs: another nice wingo addition would be an explanation on why
|
||||||
|
# this is useful ;)
|
||||||
|
|
||||||
|
SCANOBJ_DEPS =
|
||||||
|
|
||||||
|
# Header files to ignore when scanning.
|
||||||
|
IGNORE_HFILES =
|
||||||
|
IGNORE_CFILES =
|
||||||
|
|
||||||
|
# we add all .h files of elements that have signals/args we want
|
||||||
|
# sadly this also pulls in the private methods - maybe we should
|
||||||
|
# move those around in the source ?
|
||||||
|
# also, we should add some stuff here conditionally based on whether
|
||||||
|
# or not the plugin will actually build
|
||||||
|
# but I'm not sure about that - it might be this Just Works given that
|
||||||
|
# the registry won't have the element
|
||||||
|
|
||||||
|
EXTRA_HFILES = \
|
||||||
|
$(top_srcdir)/plugins/elements/gstfakesrc.h \
|
||||||
|
$(top_srcdir)/plugins/elements/gstfakesink.h \
|
||||||
|
$(top_srcdir)/plugins/elements/gstfilesrc.h \
|
||||||
|
$(top_srcdir)/plugins/elements/gstfilesink.h \
|
||||||
|
$(top_srcdir)/plugins/elements/gstqueue.h
|
||||||
|
|
||||||
|
# Images to copy into HTML directory.
|
||||||
|
HTML_IMAGES =
|
||||||
|
|
||||||
|
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
||||||
|
content_files =
|
||||||
|
|
||||||
|
# Other files to distribute.
|
||||||
|
extra_files =
|
||||||
|
|
||||||
|
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
|
||||||
|
# contains GtkObjects/GObjects and you want to document signals and properties.
|
||||||
|
GTKDOC_CFLAGS = $(GST_OBJ_CFLAGS) -I$(top_builddir) -I$(top_builddir)/libs
|
||||||
|
GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_OBJ_LIBS)
|
||||||
|
|
||||||
|
GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
|
||||||
|
GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
|
||||||
|
|
||||||
|
# If you need to override some of the declarations, place them in this file
|
||||||
|
# and uncomment this line.
|
||||||
|
#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
|
||||||
|
DOC_OVERRIDES =
|
||||||
|
|
||||||
|
include $(top_srcdir)/common/gtk-doc-plugins.mak
|
28
docs/plugins/gstreamer-plugins-docs.sgml
Normal file
28
docs/plugins/gstreamer-plugins-docs.sgml
Normal file
|
@ -0,0 +1,28 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||||
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||||
|
<!ENTITY % version-entities SYSTEM "version.entities">
|
||||||
|
%version-entities;
|
||||||
|
]>
|
||||||
|
|
||||||
|
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
||||||
|
<bookinfo>
|
||||||
|
<title>GStreamer Core Plugins &GST_MAJORMINOR; Plugins Reference Manual</title>
|
||||||
|
</bookinfo>
|
||||||
|
|
||||||
|
<chapter>
|
||||||
|
<title>gstreamer Elements</title>
|
||||||
|
<xi:include href="xml/element-fakesrc.xml" />
|
||||||
|
<xi:include href="xml/element-fakesink.xml" />
|
||||||
|
<xi:include href="xml/element-filesrc.xml" />
|
||||||
|
<xi:include href="xml/element-filesink.xml" />
|
||||||
|
<xi:include href="xml/element-queue.xml" />
|
||||||
|
</chapter>
|
||||||
|
|
||||||
|
<chapter>
|
||||||
|
<title>gstreamer Plugins</title>
|
||||||
|
<xi:include href="xml/plugin-coreelements.xml" />
|
||||||
|
<xi:include href="xml/plugin-coreindexers.xml" />
|
||||||
|
</chapter>
|
||||||
|
</book>
|
||||||
|
|
84
docs/plugins/gstreamer-plugins-sections.txt
Normal file
84
docs/plugins/gstreamer-plugins-sections.txt
Normal file
|
@ -0,0 +1,84 @@
|
||||||
|
<SECTION>
|
||||||
|
<FILE>element-fakesrc</FILE>
|
||||||
|
<TITLE>fakesrc</TITLE>
|
||||||
|
GstFakeSrc
|
||||||
|
GstFakeSrcDataType
|
||||||
|
GstFakeSrcFillType
|
||||||
|
GstFakeSrcOutputType
|
||||||
|
GstFakeSrcSizeType
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
GstFakeSrcClass
|
||||||
|
GST_FAKE_SRC
|
||||||
|
GST_IS_FAKE_SRC
|
||||||
|
GST_TYPE_FAKE_SRC
|
||||||
|
GST_FAKE_SRC_CLASS
|
||||||
|
GST_IS_FAKE_SRC_CLASS
|
||||||
|
<SUBSECTION Private>
|
||||||
|
gst_fake_src_get_type
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>element-fakesink</FILE>
|
||||||
|
<TITLE>fakesink</TITLE>
|
||||||
|
GstFakeSink
|
||||||
|
GstFakeSinkStateError
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
GstFakeSinkClass
|
||||||
|
GST_FAKE_SINK
|
||||||
|
GST_IS_FAKE_SINK
|
||||||
|
GST_TYPE_FAKE_SINK
|
||||||
|
GST_FAKE_SINK_CLASS
|
||||||
|
GST_IS_FAKE_SINK_CLASS
|
||||||
|
<SUBSECTION Private>
|
||||||
|
gst_fake_sink_get_type
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>element-filesrc</FILE>
|
||||||
|
<TITLE>filesrc</TITLE>
|
||||||
|
GstFileSrc
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
GstFileSrcClass
|
||||||
|
GST_FILE_SRC
|
||||||
|
GST_IS_FILE_SRC
|
||||||
|
GST_TYPE_FILE_SRC
|
||||||
|
GST_FILE_SRC_CLASS
|
||||||
|
GST_IS_FILE_SRC_CLASS
|
||||||
|
<SUBSECTION Private>
|
||||||
|
gst_file_src_get_type
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>element-filesink</FILE>
|
||||||
|
<TITLE>filesink</TITLE>
|
||||||
|
GstFileSink
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
GstFileSinkClass
|
||||||
|
GST_FILE_SINK
|
||||||
|
GST_IS_FILE_SINK
|
||||||
|
GST_TYPE_FILE_SINK
|
||||||
|
GST_FILE_SINK_CLASS
|
||||||
|
GST_IS_FILE_SINK_CLASS
|
||||||
|
<SUBSECTION Private>
|
||||||
|
gst_file_sink_get_type
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>element-queue</FILE>
|
||||||
|
<TITLE>queue</TITLE>
|
||||||
|
GstQueue
|
||||||
|
GstQueueSize
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
GstQueueClass
|
||||||
|
GST_QUEUE
|
||||||
|
GST_IS_QUEUE
|
||||||
|
GST_QUEUE_CLASS
|
||||||
|
GST_IS_QUEUE_CLASS
|
||||||
|
GST_TYPE_QUEUE
|
||||||
|
<SUBSECTION Private>
|
||||||
|
gst_queue_get_type
|
||||||
|
</SECTION>
|
||||||
|
<SUBSECTION Standard>
|
1
docs/plugins/gstreamer-plugins.types
Normal file
1
docs/plugins/gstreamer-plugins.types
Normal file
|
@ -0,0 +1 @@
|
||||||
|
#include <gst/gst.h>
|
1
docs/plugins/inspect.stamp
Normal file
1
docs/plugins/inspect.stamp
Normal file
|
@ -0,0 +1 @@
|
||||||
|
timestamp
|
83
docs/plugins/inspect/plugin-coreelements.xml
Normal file
83
docs/plugins/inspect/plugin-coreelements.xml
Normal file
|
@ -0,0 +1,83 @@
|
||||||
|
<plugin>
|
||||||
|
<name>coreelements</name>
|
||||||
|
<description>standard GStreamer elements</description>
|
||||||
|
<filename>../../plugins/elements/.libs/libgstcoreelements.so</filename>
|
||||||
|
<basename>libgstcoreelements.so</basename>
|
||||||
|
<version>0.9.6.1</version>
|
||||||
|
<license>LGPL</license>
|
||||||
|
<source>gstreamer</source>
|
||||||
|
<package>GStreamer CVS/prerelease</package>
|
||||||
|
<origin>Unknown package origin</origin>
|
||||||
|
<elements>
|
||||||
|
<element>
|
||||||
|
<name>capsfilter</name>
|
||||||
|
<longname>CapsFilter</longname>
|
||||||
|
<class>Generic</class>
|
||||||
|
<description>Pass data without modification, limiting formats</description>
|
||||||
|
<author>David Schleef <ds@schleef.org></author>
|
||||||
|
</element>
|
||||||
|
<element>
|
||||||
|
<name>fakesink</name>
|
||||||
|
<longname>Fake Sink</longname>
|
||||||
|
<class>Sink</class>
|
||||||
|
<description>Black hole for data</description>
|
||||||
|
<author>Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com>, Mr. 'frag-me-more' Vanderwingo <wingo@fluendo.com></author>
|
||||||
|
</element>
|
||||||
|
<element>
|
||||||
|
<name>fakesrc</name>
|
||||||
|
<longname>Fake Source</longname>
|
||||||
|
<class>Source</class>
|
||||||
|
<description>Push empty (no data) buffers around</description>
|
||||||
|
<author>Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim.taymans@chello.be></author>
|
||||||
|
</element>
|
||||||
|
<element>
|
||||||
|
<name>fdsrc</name>
|
||||||
|
<longname>Disk Source</longname>
|
||||||
|
<class>Source/File</class>
|
||||||
|
<description>Synchronous read from a file</description>
|
||||||
|
<author>Erik Walthinsen <omega@cse.ogi.edu></author>
|
||||||
|
</element>
|
||||||
|
<element>
|
||||||
|
<name>filesink</name>
|
||||||
|
<longname>File Sink</longname>
|
||||||
|
<class>Sink/File</class>
|
||||||
|
<description>Write stream to a file</description>
|
||||||
|
<author>Thomas <thomas@apestaart.org></author>
|
||||||
|
</element>
|
||||||
|
<element>
|
||||||
|
<name>filesrc</name>
|
||||||
|
<longname>File Source</longname>
|
||||||
|
<class>Source/File</class>
|
||||||
|
<description>Read from arbitrary point in a file</description>
|
||||||
|
<author>Erik Walthinsen <omega@cse.ogi.edu></author>
|
||||||
|
</element>
|
||||||
|
<element>
|
||||||
|
<name>identity</name>
|
||||||
|
<longname>Identity</longname>
|
||||||
|
<class>Generic</class>
|
||||||
|
<description>Pass data without modification</description>
|
||||||
|
<author>Erik Walthinsen <omega@cse.ogi.edu></author>
|
||||||
|
</element>
|
||||||
|
<element>
|
||||||
|
<name>queue</name>
|
||||||
|
<longname>Queue</longname>
|
||||||
|
<class>Generic</class>
|
||||||
|
<description>Simple data queue</description>
|
||||||
|
<author>Erik Walthinsen <omega@cse.ogi.edu></author>
|
||||||
|
</element>
|
||||||
|
<element>
|
||||||
|
<name>tee</name>
|
||||||
|
<longname>Tee pipe fitting</longname>
|
||||||
|
<class>Generic</class>
|
||||||
|
<description>1-to-N pipe fitting</description>
|
||||||
|
<author>Erik Walthinsen <omega@cse.ogi.edu>, Wim "Tim" Taymans <wim@fluendo.com></author>
|
||||||
|
</element>
|
||||||
|
<element>
|
||||||
|
<name>typefind</name>
|
||||||
|
<longname>TypeFind</longname>
|
||||||
|
<class>Generic</class>
|
||||||
|
<description>Finds the media type of a stream</description>
|
||||||
|
<author>Benjamin Otte <in7y118@public.uni-hamburg.de></author>
|
||||||
|
</element>
|
||||||
|
</elements>
|
||||||
|
</plugin>
|
14
docs/plugins/inspect/plugin-coreindexers.xml
Normal file
14
docs/plugins/inspect/plugin-coreindexers.xml
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
<plugin>
|
||||||
|
<name>coreindexers</name>
|
||||||
|
<description>GStreamer core indexers</description>
|
||||||
|
<filename>../../plugins/indexers/.libs/libgstcoreindexers.so</filename>
|
||||||
|
<basename>libgstcoreindexers.so</basename>
|
||||||
|
<version>0.9.6.1</version>
|
||||||
|
<license>LGPL</license>
|
||||||
|
<source>gstreamer</source>
|
||||||
|
<package>GStreamer CVS/prerelease</package>
|
||||||
|
<origin>Unknown package origin</origin>
|
||||||
|
<elements>
|
||||||
|
|
||||||
|
</elements>
|
||||||
|
</plugin>
|
0
docs/plugins/scanobj-build.stamp
Normal file
0
docs/plugins/scanobj-build.stamp
Normal file
|
@ -196,6 +196,7 @@ rm -rf $RPM_BUILD_ROOT
|
||||||
|
|
||||||
%doc %{_datadir}/gtk-doc/html/gstreamer-%{majorminor}
|
%doc %{_datadir}/gtk-doc/html/gstreamer-%{majorminor}
|
||||||
%doc %{_datadir}/gtk-doc/html/gstreamer-libs-%{majorminor}
|
%doc %{_datadir}/gtk-doc/html/gstreamer-libs-%{majorminor}
|
||||||
|
%doc %{_datadir}/gtk-doc/html/gstreamer-plugins-%{majorminor}
|
||||||
|
|
||||||
%changelog
|
%changelog
|
||||||
* Fri Sep 02 2005 Thomas Vander Stichele <thomas at apestaart dot org>
|
* Fri Sep 02 2005 Thomas Vander Stichele <thomas at apestaart dot org>
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
# This requires building libs/gst before this dir, which we currently don't
|
# This requires building libs/gst before this dir, which we currently don't
|
||||||
# do.
|
# do.
|
||||||
|
|
||||||
plugin_LTLIBRARIES = libgstelements.la
|
plugin_LTLIBRARIES = libgstcoreelements.la
|
||||||
|
|
||||||
if HAVE_SYS_SOCKET_H
|
if HAVE_SYS_SOCKET_H
|
||||||
GSTFDSRC = gstfdsrc.c
|
GSTFDSRC = gstfdsrc.c
|
||||||
|
@ -12,8 +12,8 @@ else
|
||||||
GSTFDSRC =
|
GSTFDSRC =
|
||||||
endif
|
endif
|
||||||
|
|
||||||
libgstelements_la_DEPENDENCIES = $(top_builddir)/gst/libgstreamer-@GST_MAJORMINOR@.la
|
libgstcoreelements_la_DEPENDENCIES = $(top_builddir)/gst/libgstreamer-@GST_MAJORMINOR@.la
|
||||||
libgstelements_la_SOURCES = \
|
libgstcoreelements_la_SOURCES = \
|
||||||
gstbufferstore.c \
|
gstbufferstore.c \
|
||||||
gstcapsfilter.c \
|
gstcapsfilter.c \
|
||||||
gstelements.c \
|
gstelements.c \
|
||||||
|
@ -27,11 +27,11 @@ libgstelements_la_SOURCES = \
|
||||||
gsttee.c \
|
gsttee.c \
|
||||||
gsttypefindelement.c
|
gsttypefindelement.c
|
||||||
|
|
||||||
libgstelements_la_CFLAGS = $(GST_OBJ_CFLAGS)
|
libgstcoreelements_la_CFLAGS = $(GST_OBJ_CFLAGS)
|
||||||
libgstelements_la_LIBADD = \
|
libgstcoreelements_la_LIBADD = \
|
||||||
$(top_builddir)/libs/gst/base/libgstbase-@GST_MAJORMINOR@.la \
|
$(top_builddir)/libs/gst/base/libgstbase-@GST_MAJORMINOR@.la \
|
||||||
$(GST_OBJ_LIBS)
|
$(GST_OBJ_LIBS)
|
||||||
libgstelements_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS)
|
libgstcoreelements_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS)
|
||||||
|
|
||||||
noinst_HEADERS = \
|
noinst_HEADERS = \
|
||||||
gstbufferstore.h \
|
gstbufferstore.h \
|
||||||
|
|
|
@ -81,6 +81,6 @@ plugin_init (GstPlugin * plugin)
|
||||||
|
|
||||||
GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
|
GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
|
||||||
GST_VERSION_MINOR,
|
GST_VERSION_MINOR,
|
||||||
"gstelements",
|
"coreelements",
|
||||||
"standard GStreamer elements",
|
"standard GStreamer elements",
|
||||||
plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);
|
plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
* Boston, MA 02111-1307, USA.
|
* Boston, MA 02111-1307, USA.
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* SECTION:gstfakesink
|
* SECTION:element-fakesink
|
||||||
* @short_description: black hole for data
|
* @short_description: black hole for data
|
||||||
* @see_also: #GstFakeSrc
|
* @see_also: #GstFakeSrc
|
||||||
*
|
*
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
* Boston, MA 02111-1307, USA.
|
* Boston, MA 02111-1307, USA.
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* SECTION:gstfakesrc
|
* SECTION:element-fakesrc
|
||||||
* @short_description: Push empty (no data) buffers around
|
* @short_description: Push empty (no data) buffers around
|
||||||
* @see_also: #GstFakeSink
|
* @see_also: #GstFakeSink
|
||||||
*
|
*
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
* Boston, MA 02111-1307, USA.
|
* Boston, MA 02111-1307, USA.
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* SECTION:gstfilesink
|
* SECTION:element-filesink
|
||||||
* @short_description: write stream to a file
|
* @short_description: write stream to a file
|
||||||
* @see_also: #GstFileSrc
|
* @see_also: #GstFileSrc
|
||||||
*
|
*
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
* Boston, MA 02111-1307, USA.
|
* Boston, MA 02111-1307, USA.
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* SECTION:gstfilesrc
|
* SECTION:element-filesrc
|
||||||
* @short_description: read from arbitrary point in a file
|
* @short_description: read from arbitrary point in a file
|
||||||
* @see_also: #GstFileSrc
|
* @see_also: #GstFileSrc
|
||||||
*
|
*
|
||||||
|
|
|
@ -23,7 +23,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:gstqueue
|
* SECTION:element-queue
|
||||||
* @short_description: Simple asynchronous data queue.
|
* @short_description: Simple asynchronous data queue.
|
||||||
*
|
*
|
||||||
* Data is queued till max_level buffers have been stored. Any subsequent
|
* Data is queued till max_level buffers have been stored. Any subsequent
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
plugin_LTLIBRARIES = libgstindexers.la
|
plugin_LTLIBRARIES = libgstcoreindexers.la
|
||||||
# file index uses xml
|
# file index uses xml
|
||||||
if GST_DISABLE_LOADSAVE
|
if GST_DISABLE_LOADSAVE
|
||||||
GST_LOADSAVE_SRC =
|
GST_LOADSAVE_SRC =
|
||||||
|
@ -11,8 +11,8 @@ else
|
||||||
GST_LOADSAVE_SRC =
|
GST_LOADSAVE_SRC =
|
||||||
endif
|
endif
|
||||||
|
|
||||||
libgstindexers_la_DEPENDENCIES = $(top_builddir)/gst/libgstreamer-@GST_MAJORMINOR@.la
|
libgstcoreindexers_la_DEPENDENCIES = $(top_builddir)/gst/libgstreamer-@GST_MAJORMINOR@.la
|
||||||
libgstindexers_la_SOURCES = gstindexers.c gstmemindex.c $(GST_LOADSAVE_SRC)
|
libgstcoreindexers_la_SOURCES = gstindexers.c gstmemindex.c $(GST_LOADSAVE_SRC)
|
||||||
libgstindexers_la_CFLAGS = $(GST_OBJ_CFLAGS)
|
libgstcoreindexers_la_CFLAGS = $(GST_OBJ_CFLAGS)
|
||||||
libgstindexers_la_LIBADD = $(GST_OBJ_LIBS)
|
libgstcoreindexers_la_LIBADD = $(GST_OBJ_LIBS)
|
||||||
libgstindexers_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS)
|
libgstcoreindexers_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS)
|
||||||
|
|
|
@ -39,6 +39,6 @@ plugin_init (GstPlugin * plugin)
|
||||||
|
|
||||||
GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
|
GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
|
||||||
GST_VERSION_MINOR,
|
GST_VERSION_MINOR,
|
||||||
"gstindexers",
|
"coreindexers",
|
||||||
"GStreamer core indexers",
|
"GStreamer core indexers",
|
||||||
plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);
|
plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);
|
||||||
|
|
Loading…
Reference in a new issue