First step at adding docs

Original commit message from CVS:

* configure.ac:
* docs/Makefile.am:
* docs/plugins/.cvsignore:
* docs/plugins/gst-ffmpeg-plugins-docs.sgml:
* docs/plugins/gst-ffmpeg-plugins.args:
* docs/plugins/gst-ffmpeg-plugins.hierarchy:
* docs/plugins/gst-ffmpeg-plugins.interfaces:
* docs/plugins/gst-ffmpeg-plugins.prerequisites:
* docs/plugins/gst-ffmpeg-plugins.types:
* docs/plugins/inspect.stamp:
* docs/plugins/inspect/plugin-ffmpeg.xml:
* docs/version.entities.in:
First step at adding docs

ChangeLog

@@ -1,3 +1,19 @@
+2006-01-31  Thomas Vander Stichele  <thomas at apestaart dot org>
+
+	* configure.ac:
+	* docs/Makefile.am:
+	* docs/plugins/.cvsignore:
+	* docs/plugins/gst-ffmpeg-plugins-docs.sgml:
+	* docs/plugins/gst-ffmpeg-plugins.args:
+	* docs/plugins/gst-ffmpeg-plugins.hierarchy:
+	* docs/plugins/gst-ffmpeg-plugins.interfaces:
+	* docs/plugins/gst-ffmpeg-plugins.prerequisites:
+	* docs/plugins/gst-ffmpeg-plugins.types:
+	* docs/plugins/inspect.stamp:
+	* docs/plugins/inspect/plugin-ffmpeg.xml:
+	* docs/version.entities.in:
+	  First step at adding docs
+
 2006-01-26  Tim-Philipp Müller  <tim at centricular dot net>
 
 	* ext/ffmpeg/gstffmpegcodecmap.c: (gst_ffmpeg_caps_with_codecid):

common

@@ -1 +1 @@
-Subproject commit bc4325349e8d0ec90aa5c5e74566880cc2e82527
+Subproject commit 0b93085188e83fe678ec5ded2823cd7c24dfa843

configure.ac

@@ -19,7 +19,7 @@ dnl we cheat here so we don't have to change the actual configure code bit
 GST_PLUGINS_VERSION_NANO=$GST_FFMPEG_VERSION_NANO
 
 dnl required GStreamer version
-GST_REQ=0.9.7
+GST_REQ=0.10.0
 
 AM_INIT_AUTOMAKE($PACKAGE,$VERSION)
 
@@ -62,10 +62,10 @@ fi
 AC_HEADER_STDC([])
 
 
-dnl check for gstreamer; uninstalled is selected preferentially -- see pkg-config(1)
+dnl check for gstreamer
-PKG_CHECK_MODULES(GST, gstreamer-$GST_MAJORMINOR >= $GST_REQ \
+dnl uninstalled is selected preferentially -- see pkg-config(1)
-		       gstreamer-plugins-base-$GST_MAJORMINOR,
+GST_CHECK_GST($GST_MAJORMINOR, [$GST_REQ])
-  HAVE_GST="yes", HAVE_GST="no")
+GST_CHECK_GST_BASE($GST_MAJORMINOR, [$GST_REQ])
 
 if test "x$HAVE_GST" = "xno"; then
   AC_MSG_ERROR(no GStreamer found)
@@ -84,6 +84,10 @@ GST_ARCH()
 
 GST_ARG_WITH_PKG_CONFIG_PATH
 
+dnl check for documentation tools
+GTK_DOC_CHECK([1.3])
+AS_PATH_PYTHON([2.1])
+
 dnl ###########################
 dnl # Configure external libs #
 dnl ###########################
@@ -101,5 +105,7 @@ ext/ffmpeg/Makefile
 ext/libpostproc/Makefile
 gst-libs/Makefile
 gst-libs/ext/Makefile
+docs/Makefile
+docs/plugins/Makefile
 )
 AC_OUTPUT

docs/Makefile.am

@@ -0,0 +1,15 @@
+if ENABLE_GTK_DOC
+GTK_DOC_DIRS = plugins
+else
+GTK_DOC_DIRS =
+endif
+
+SUBDIRS = $(GTK_DOC_DIRS)
+DIST_SUBDIRS = plugins
+
+EXTRA_DIST = \
+        upload.mak \
+        version.entities.in
+
+upload:
+	@if test "x$(SUBDIRS)" != x; then for a in $(SUBDIRS); do cd $$a; make upload; cd ..; done; fi

docs/plugins/.gitignore

@@ -0,0 +1,17 @@
+*-plugins-decl-list.txt
+*-plugins-decl.txt
+*-plugins-overrides.txt
+*-plugins-undocumented.txt
+*-plugins.args.new
+*-plugins.signals.new
+*-plugins-unused.txt
+html
+html-build.stamp
+html.stamp
+scan-build.stamp
+sgml-build.stamp
+sgml.stamp
+tmpl
+tmpl-build.stamp
+tmpl.stamp
+xml

docs/plugins/gst-ffmpeg-plugins-docs.sgml

@@ -0,0 +1,21 @@
+<?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 FFMPeg &GST_MAJORMINOR; Plugins Reference Manual</title>
+  </bookinfo>
+
+  <chapter>
+    <title>gst-ffmpeg Elements</title>
+  </chapter>
+
+  <chapter>
+    <title>gst-ffmpeg Plugins</title>
+    <xi:include href="xml/plugin-ffmpeg.xml" />
+  </chapter>
+</book>

docs/plugins/gst-ffmpeg-plugins.hierarchy

@@ -0,0 +1,170 @@
+GObject
+  GstObject
+    GstPad
+    GstPluginFeature
+      GstElementFactory
+      GstTypeFindFactory
+      GstIndexFactory
+    GstElement
+      GstBin
+        GstPipeline
+      ffenc_ac3
+      ffenc_mp2
+      ffenc_mpeg1video
+      ffenc_mpeg2video
+      ffenc_h261
+      ffenc_h263
+      ffenc_h263p
+      ffenc_flv
+      ffenc_rv10
+      ffenc_rv20
+      ffenc_mpeg4
+      ffenc_msmpeg4v1
+      ffenc_msmpeg4v2
+      ffenc_msmpeg4
+      ffenc_wmv1
+      ffenc_wmv2
+      ffenc_svq1
+      ffenc_mjpeg
+      ffenc_ljpeg
+      ffenc_png
+      ffenc_ppm
+      ffenc_pgm
+      ffenc_pgmyuv
+      ffenc_pbm
+      ffenc_pam
+      ffenc_huffyuv
+      ffenc_ffvhuff
+      ffenc_asv1
+      ffenc_asv2
+      ffenc_ffv1
+      ffenc_snow
+      ffenc_dvvideo
+      ffenc_sonic
+      ffenc_sonicls
+      ffenc_adpcm_ima_qt
+      ffenc_adpcm_ima_wav
+      ffenc_adpcm_ima_dk3
+      ffenc_adpcm_ima_dk4
+      ffenc_adpcm_ima_ws
+      ffenc_adpcm_ima_smjpeg
+      ffenc_adpcm_ms
+      ffenc_adpcm_4xm
+      ffenc_adpcm_xa
+      ffenc_adpcm_adx
+      ffenc_adpcm_ea
+      ffenc_g726
+      ffenc_adpcm_ct
+      ffenc_adpcm_swf
+      ffenc_adpcm_yamaha
+      ffdec_ppm
+      ffdec_pgm
+      ffdec_pgmyuv
+      ffdec_pbm
+      ffdec_pam
+      ffdec_h263
+      ffdec_h261
+      ffdec_mpeg4
+      ffdec_msmpeg4v1
+      ffdec_msmpeg4v2
+      ffdec_msmpeg4
+      ffdec_wmv1
+      ffdec_wmv2
+      ffdec_vc9
+      ffdec_wmv3
+      ffdec_h263i
+      ffdec_flv
+      ffdec_rv10
+      ffdec_rv20
+      ffdec_svq1
+      ffdec_svq3
+      ffdec_wmav1
+      ffdec_wmav2
+      ffdec_indeo2
+      ffdec_indeo3
+      ffdec_camtasia
+      ffdec_ultimotion
+      ffdec_qdraw
+      ffdec_xl
+      ffdec_loco
+      ffdec_wnv1
+      ffdec_aasc
+      ffdec_fraps
+      ffdec_mpeg2video
+      ffdec_mpegvideo
+      ffdec_dvvideo
+      ffdec_mjpeg
+      ffdec_sp5x
+      ffdec_png
+      ffdec_mp3
+      ffdec_mp3adu
+      ffdec_mp3on4
+      ffdec_mace3
+      ffdec_mace6
+      ffdec_huffyuv
+      ffdec_ffvhuff
+      ffdec_ffv1
+      ffdec_snow
+      ffdec_cyuv
+      ffdec_h264
+      ffdec_vp3
+      ffdec_theora
+      ffdec_asv1
+      ffdec_asv2
+      ffdec_vcr1
+      ffdec_cljr
+      ffdec_4xm
+      ffdec_mdec
+      ffdec_roqvideo
+      ffdec_interplayvideo
+      ffdec_xan_wc3
+      ffdec_rpza
+      ffdec_cinepak
+      ffdec_msrle
+      ffdec_msvideo1
+      ffdec_vqavideo
+      ffdec_idcinvideo
+      ffdec_8bps
+      ffdec_smc
+      ffdec_flic
+      ffdec_truemotion1
+      ffdec_truemotion2
+      ffdec_vmdvideo
+      ffdec_vmdaudio
+      ffdec_mszh
+      ffdec_zlib
+      ffdec_sonic
+      ffdec_real_144
+      ffdec_real_288
+      ffdec_roq_dpcm
+      ffdec_interplay_dpcm
+      ffdec_xan_dpcm
+      ffdec_sol_dpcm
+      ffdec_qtrle
+      ffdec_flac
+      ffdec_shorten
+      ffdec_alac
+      ffdec_ws_snd1
+      ffdec_qdm2
+      ffdec_adpcm_ima_qt
+      ffdec_adpcm_ima_wav
+      ffdec_adpcm_ima_dk3
+      ffdec_adpcm_ima_dk4
+      ffdec_adpcm_ima_ws
+      ffdec_adpcm_ima_smjpeg
+      ffdec_adpcm_ms
+      ffdec_adpcm_4xm
+      ffdec_adpcm_xa
+      ffdec_adpcm_adx
+      ffdec_adpcm_ea
+      ffdec_g726
+      ffdec_adpcm_ct
+      ffdec_adpcm_swf
+      ffdec_adpcm_yamaha
+    GstPlugin
+    GstRegistry
+    GstPadTemplate
+  GstSignalObject
+GInterface
+  GstChildProxy
+  GstURIHandler

docs/plugins/gst-ffmpeg-plugins.interfaces

@@ -0,0 +1,2 @@
+GstBin GstChildProxy
+GstPipeline GstChildProxy

docs/plugins/gst-ffmpeg-plugins.prerequisites

@@ -0,0 +1 @@
+GstChildProxy GstObject

docs/plugins/gst-ffmpeg-plugins.types

@@ -0,0 +1 @@
+#include <gst/gst.h>

docs/plugins/inspect.stamp

@@ -0,0 +1 @@
+timestamp

docs/version.entities.in

@@ -0,0 +1,2 @@
+<!ENTITY GST_MAJORMINOR "@GST_MAJORMINOR@">
+<!ENTITY GST_VERSION "@VERSION@">