From 2438f5851e8c0d6e98cf45fc50300ca4387bc470 Mon Sep 17 00:00:00 2001 From: Julien Moutte Date: Sun, 6 Nov 2005 21:55:01 +0000 Subject: Enable documentation. Original commit message from CVS: 2005-11-06 Julien MOUTTE * Makefile.am: * autogen.sh: * configure.ac: * docs/Makefile.am: * docs/plugins/.cvsignore: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-bad-plugins-decl-list.txt: * docs/plugins/gst-plugins-bad-plugins-decl.txt: * docs/plugins/gst-plugins-bad-plugins-docs.sgml: * docs/plugins/gst-plugins-bad-plugins-sections.txt: * docs/plugins/gst-plugins-bad-plugins-undocumented.txt: * docs/plugins/gst-plugins-bad-plugins.args: * docs/plugins/gst-plugins-bad-plugins.hierarchy: * docs/plugins/gst-plugins-bad-plugins.interfaces: * docs/plugins/gst-plugins-bad-plugins.prerequisites: * docs/plugins/gst-plugins-bad-plugins.signals: * docs/plugins/gst-plugins-bad-plugins.types: * docs/plugins/inspect/plugin-dfbvideosink.xml: * docs/version.entities.in: Enable documentation. * examples/Makefile.am: * examples/directfb/Makefile.am: * examples/directfb/decker.ttf: * examples/directfb/dfblogo.png: * examples/directfb/gstdfb.c: (myclock), (dynamic_link), (size_changed), (setup_dynamic_link), (main): Add an example application for DirectFB. --- docs/Makefile.am | 12 +++ docs/plugins/.gitignore | 18 ++++ docs/plugins/Makefile.am | 113 +++++++++++++++++++ docs/plugins/gst-plugins-bad-plugins-decl-list.txt | 18 ++++ docs/plugins/gst-plugins-bad-plugins-decl.txt | 119 +++++++++++++++++++++ docs/plugins/gst-plugins-bad-plugins-docs.sgml | 25 +++++ docs/plugins/gst-plugins-bad-plugins-overrides.txt | 0 docs/plugins/gst-plugins-bad-plugins-sections.txt | 8 ++ .../gst-plugins-bad-plugins-undocumented.txt | 9 ++ docs/plugins/gst-plugins-bad-plugins.args | 9 ++ docs/plugins/gst-plugins-bad-plugins.hierarchy | 20 ++++ docs/plugins/gst-plugins-bad-plugins.interfaces | 2 + docs/plugins/gst-plugins-bad-plugins.prerequisites | 1 + docs/plugins/gst-plugins-bad-plugins.signals | 1 + docs/plugins/gst-plugins-bad-plugins.types | 1 + docs/plugins/inspect/plugin-dfbvideosink.xml | 20 ++++ docs/version.entities.in | 2 + 17 files changed, 378 insertions(+) create mode 100644 docs/Makefile.am create mode 100644 docs/plugins/.gitignore create mode 100644 docs/plugins/Makefile.am create mode 100644 docs/plugins/gst-plugins-bad-plugins-decl-list.txt create mode 100644 docs/plugins/gst-plugins-bad-plugins-decl.txt create mode 100644 docs/plugins/gst-plugins-bad-plugins-docs.sgml create mode 100644 docs/plugins/gst-plugins-bad-plugins-overrides.txt create mode 100644 docs/plugins/gst-plugins-bad-plugins-sections.txt create mode 100644 docs/plugins/gst-plugins-bad-plugins-undocumented.txt create mode 100644 docs/plugins/gst-plugins-bad-plugins.args create mode 100644 docs/plugins/gst-plugins-bad-plugins.hierarchy create mode 100644 docs/plugins/gst-plugins-bad-plugins.interfaces create mode 100644 docs/plugins/gst-plugins-bad-plugins.prerequisites create mode 100644 docs/plugins/gst-plugins-bad-plugins.signals create mode 100644 docs/plugins/gst-plugins-bad-plugins.types create mode 100644 docs/plugins/inspect/plugin-dfbvideosink.xml create mode 100644 docs/version.entities.in (limited to 'docs') diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 00000000..2b9075b7 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,12 @@ +if ENABLE_GTK_DOC +GTK_DOC_DIRS = plugins +else +GTK_DOC_DIRS = +endif + +SUBDIRS = $(GTK_DOC_DIRS) +DIST_SUBDIRS = plugins + +EXTRA_DIST = \ + random/ChangeLog-0.8 \ + version.entities.in diff --git a/docs/plugins/.gitignore b/docs/plugins/.gitignore new file mode 100644 index 00000000..2ef1402d --- /dev/null +++ b/docs/plugins/.gitignore @@ -0,0 +1,18 @@ +Makefile +Makefile.in + +*-decl.txt +*-decl-list.txt +*-undocumented.txt +*-unused.txt + +*.args +*.hierarchy +*.interfaces +*.prerequisites +*.signals + +html +sgml +xml +*.stamp diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am new file mode 100644 index 00000000..3ac322d5 --- /dev/null +++ b/docs/plugins/Makefile.am @@ -0,0 +1,113 @@ +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=gst-plugins-bad +DOC_MODULE=$(MODULE)-plugins + +# for upload.mak +DOC=$(MODULE)-plugins +FORMATS=html +html: html-build.stamp +include $(top_srcdir)/common/upload-doc.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) + +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS= + +# FIXME : +# there's something wrong with gstreamer-sections.txt not being in the dist +# maybe it doesn't resolve; we're adding it below for now +#EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE) + +# 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 + +# FIXME: not ported yet +# $(top_srcdir)/ext/gnomevfs/gstgnomevfssink.c + +# example code that needs to be converted to xml and placed in xml/ +EXAMPLE_CFILES = \ + $(top_srcdir)/ext/directfb/dfb-example.c + +EXTRA_HFILES = \ + $(top_srcdir)/ext/directfb/dfbvideosink.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_BASE_CFLAGS) -I$(top_builddir) +GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_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 diff --git a/docs/plugins/gst-plugins-bad-plugins-decl-list.txt b/docs/plugins/gst-plugins-bad-plugins-decl-list.txt new file mode 100644 index 00000000..ad63ed4b --- /dev/null +++ b/docs/plugins/gst-plugins-bad-plugins-decl-list.txt @@ -0,0 +1,18 @@ +
+dfbvideosink +GST_TYPE_DFBSURFACE +GST_IS_DFBSURFACE +GST_DFBSURFACE +GstDfbSurface +GstDfbVMode +GstDfbVideoSink +gst_dfbsurface_get_type + +GST_DFBVIDEOSINK +GST_IS_DFBVIDEOSINK +GST_TYPE_DFBVIDEOSINK +gst_dfbvideosink_get_type +GST_DFBVIDEOSINK_CLASS +GST_IS_DFBVIDEOSINK_CLASS +
+ diff --git a/docs/plugins/gst-plugins-bad-plugins-decl.txt b/docs/plugins/gst-plugins-bad-plugins-decl.txt new file mode 100644 index 00000000..4e7cf514 --- /dev/null +++ b/docs/plugins/gst-plugins-bad-plugins-decl.txt @@ -0,0 +1,119 @@ + +GST_TYPE_DFBVIDEOSINK +#define GST_TYPE_DFBVIDEOSINK (gst_dfbvideosink_get_type()) + + +GST_DFBVIDEOSINK +#define GST_DFBVIDEOSINK(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_DFBVIDEOSINK, GstDfbVideoSink)) + + +GST_DFBVIDEOSINK_CLASS +#define GST_DFBVIDEOSINK_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_DFBVIDEOSINK, GstDfbVideoSink)) + + +GST_IS_DFBVIDEOSINK +#define GST_IS_DFBVIDEOSINK(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_DFBVIDEOSINK)) + + +GST_IS_DFBVIDEOSINK_CLASS +#define GST_IS_DFBVIDEOSINK_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_DFBVIDEOSINK)) + + +GstDfbVideoSink + + +GstDfbVideoSinkClass + + +GST_TYPE_DFBSURFACE +#define GST_TYPE_DFBSURFACE (gst_dfbsurface_get_type()) + + +GST_IS_DFBSURFACE +#define GST_IS_DFBSURFACE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_DFBSURFACE)) + + +GST_DFBSURFACE +#define GST_DFBSURFACE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_DFBSURFACE, GstDfbSurface)) + + +GstDfbSurface + + +GstDfbSurface +struct _GstDfbSurface { + GstBuffer buffer; /* We extend GstBuffer */ + + IDirectFBSurface *surface; + + gint width; + gint height; + + gboolean locked; + + DFBSurfacePixelFormat pixel_format; + + GstDfbVideoSink *dfbvideosink; +}; + + +GstDfbVMode + + +GstDfbVMode +struct _GstDfbVMode { + gint width; + gint height; + gint bpp; +}; + + +GstDfbVideoSink +struct _GstDfbVideoSink { + /* Our element stuff */ + GstVideoSink videosink; + + GSList *buffer_pool; + + gdouble framerate; + gint video_width, video_height; /* size of incoming video */ + gint out_width, out_height; + + /* Standalone */ + IDirectFB *dfb; + + GSList *vmodes; /* Video modes */ + + gint layer_id; + IDirectFBDisplayLayer *layer; + IDirectFBSurface *primary; + IDirectFBEventBuffer *event_buffer; + GThread *event_thread; + + /* Embedded */ + IDirectFBSurface *ext_surface; + + DFBSurfacePixelFormat pixel_format; + + gboolean hw_scaling; + gboolean backbuffer; + gboolean setup; + gboolean running; +}; + + +GstDfbVideoSinkClass +struct _GstDfbVideoSinkClass { + GstVideoSinkClass parent_class; +}; + + +gst_dfbvideosink_get_type +GType +void + + +gst_dfbsurface_get_type +GType +void + diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml new file mode 100644 index 00000000..44c115fa --- /dev/null +++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml @@ -0,0 +1,25 @@ + + +%version-entities; +]> + + + + GStreamer Bad Plugins &GST_MAJORMINOR; Plugins Reference Manual + + + + gst-plugins-bad Elements + + + + + + gst-plugins-bad Plugins + + + + + diff --git a/docs/plugins/gst-plugins-bad-plugins-overrides.txt b/docs/plugins/gst-plugins-bad-plugins-overrides.txt new file mode 100644 index 00000000..e69de29b diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt new file mode 100644 index 00000000..da82aa0c --- /dev/null +++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt @@ -0,0 +1,8 @@ +
+element-dfbvideosink +GstDfbVideoSink +dfbvideosink + +GstDfbVideoSinkClass +
+ diff --git a/docs/plugins/gst-plugins-bad-plugins-undocumented.txt b/docs/plugins/gst-plugins-bad-plugins-undocumented.txt new file mode 100644 index 00000000..298053be --- /dev/null +++ b/docs/plugins/gst-plugins-bad-plugins-undocumented.txt @@ -0,0 +1,9 @@ +75% symbol docs coverage. +3 symbols documented. +0 symbols incomplete. +1 not documented. + + +GstDfbVideoSink + + diff --git a/docs/plugins/gst-plugins-bad-plugins.args b/docs/plugins/gst-plugins-bad-plugins.args new file mode 100644 index 00000000..91294e2a --- /dev/null +++ b/docs/plugins/gst-plugins-bad-plugins.args @@ -0,0 +1,9 @@ + +GstDfbVideoSink::surface +gpointer + +w +Destination surface +Render video frames to this surface. The pointer you pass here has to point to an IDirectFBSurface * interface +NULL + diff --git a/docs/plugins/gst-plugins-bad-plugins.hierarchy b/docs/plugins/gst-plugins-bad-plugins.hierarchy new file mode 100644 index 00000000..5f18922a --- /dev/null +++ b/docs/plugins/gst-plugins-bad-plugins.hierarchy @@ -0,0 +1,20 @@ +GObject + GstObject + GstPad + GstPluginFeature + GstElementFactory + GstTypeFindFactory + GstIndexFactory + GstElement + GstBin + GstPipeline + GstQueue + GstBaseSink + GstVideoSink + GstDfbVideoSink + GstPlugin + GstRegistry + GstPadTemplate + GstSignalObject +GInterface + GstChildProxy diff --git a/docs/plugins/gst-plugins-bad-plugins.interfaces b/docs/plugins/gst-plugins-bad-plugins.interfaces new file mode 100644 index 00000000..fc9ba12c --- /dev/null +++ b/docs/plugins/gst-plugins-bad-plugins.interfaces @@ -0,0 +1,2 @@ +GstBin GstChildProxy +GstPipeline GstChildProxy diff --git a/docs/plugins/gst-plugins-bad-plugins.prerequisites b/docs/plugins/gst-plugins-bad-plugins.prerequisites new file mode 100644 index 00000000..f526a9f6 --- /dev/null +++ b/docs/plugins/gst-plugins-bad-plugins.prerequisites @@ -0,0 +1 @@ +GstChildProxy GstObject diff --git a/docs/plugins/gst-plugins-bad-plugins.signals b/docs/plugins/gst-plugins-bad-plugins.signals new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/docs/plugins/gst-plugins-bad-plugins.signals @@ -0,0 +1 @@ + diff --git a/docs/plugins/gst-plugins-bad-plugins.types b/docs/plugins/gst-plugins-bad-plugins.types new file mode 100644 index 00000000..9f4950e7 --- /dev/null +++ b/docs/plugins/gst-plugins-bad-plugins.types @@ -0,0 +1 @@ +#include diff --git a/docs/plugins/inspect/plugin-dfbvideosink.xml b/docs/plugins/inspect/plugin-dfbvideosink.xml new file mode 100644 index 00000000..83f5fb4e --- /dev/null +++ b/docs/plugins/inspect/plugin-dfbvideosink.xml @@ -0,0 +1,20 @@ + + dfbvideosink + DirectFB video sink + ../../ext/directfb/.libs/libgstdfbvideosink.so + libgstdfbvideosink.so + 0.9.4 + LGPL + gst-plugins-bad + GStreamer source release + http://gstreamer.freedesktop.org/ + + + dfbvideosink + DirectFB video sink + Sink/Video + DirectFB video sink + Julien Moutte <julien@moutte.net> + + + diff --git a/docs/version.entities.in b/docs/version.entities.in new file mode 100644 index 00000000..79a68981 --- /dev/null +++ b/docs/version.entities.in @@ -0,0 +1,2 @@ + + -- cgit v1.2.1