From 6734a9980e844d56b6c4b0bdad9dc2ce91e2dd1c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= <sebastian.droege@collabora.co.uk>
Date: Wed, 22 Apr 2009 19:52:05 +0200
Subject: flv: Add documentation to flvmux and flvdemux

Partially fixes bug #573737.
---
 docs/plugins/Makefile.am                          |  2 ++
 docs/plugins/gst-plugins-bad-plugins-docs.sgml    |  4 ++-
 docs/plugins/gst-plugins-bad-plugins-sections.txt | 30 +++++++++++++++++++++++
 gst/flv/gstflvdemux.c                             | 13 ++++++++++
 gst/flv/gstflvdemux.h                             |  2 ++
 gst/flv/gstflvmux.c                               | 13 ++++++++++
 gst/flv/gstflvmux.h                               |  2 ++
 7 files changed, 65 insertions(+), 1 deletion(-)

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index d723b6ac..bef7f6d1 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -131,6 +131,8 @@ EXTRA_HFILES = \
 	$(top_srcdir)/gst/dtmf/gstrtpdtmfdepay.h \
 	$(top_srcdir)/gst/dvdspu/gstdvdspu.h \
 	$(top_srcdir)/gst/festival/gstfestival.h \
+	$(top_srcdir)/gst/flv/gstflvdemux.h \
+	$(top_srcdir)/gst/flv/gstflvmux.h \
 	$(top_srcdir)/gst/legacyresample/gstlegacyresample.h \
 	$(top_srcdir)/gst/liveadder/liveadder.h \
 	$(top_srcdir)/gst/mxf/mxfdemux.h \
diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
index f9178b00..04b5828b 100644
--- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -40,6 +40,8 @@
     <xi:include href="xml/element-dvbsrc.xml" />
     <xi:include href="xml/element-dvdspu.xml" />
     <xi:include href="xml/element-festival.xml" />
+    <xi:include href="xml/element-flvdemux.xml" />
+    <xi:include href="xml/element-flvmux.xml" />
     <xi:include href="xml/element-gstrtpbin.xml" />
     <xi:include href="xml/element-gstrtpclient.xml" />
     <xi:include href="xml/element-gstrtpjitterbuffer.xml" />
@@ -115,7 +117,7 @@
     <xi:include href="xml/plugin-fbdevsink.xml" />
     <xi:include href="xml/plugin-festival.xml" />
     <xi:include href="xml/plugin-filter.xml" />
-    <xi:include href="xml/plugin-flvdemux.xml" />
+    <xi:include href="xml/plugin-flv.xml" />
     <xi:include href="xml/plugin-freeze.xml" />
     <xi:include href="xml/plugin-gsm.xml" />
     <xi:include href="xml/plugin-gstinterlace.xml" />
diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
index 0973d7ef..689ffd82 100644
--- a/docs/plugins/gst-plugins-bad-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -356,6 +356,36 @@ FESTIVAL_DEFAULT_SERVER_PORT
 FESTIVAL_DEFAULT_TEXT_MODE
 </SECTION>
 
+<SECTION>
+<FILE>element-flvdemux</FILE>
+<TITLE>flvdemux</TITLE>
+GstFLVDemux
+<SUBSECTION Standard>
+GstFLVDemuxClass
+GstFLVDemuxFlags
+GST_FLV_DEMUX
+GST_FLV_DEMUX_CLASS
+GST_IS_FLV_DEMUX
+GST_IS_FLV_DEMUX_CLASS
+GST_TYPE_FLV_DEMUX
+gst_flv_demux_get_type
+</SECTION>
+
+<SECTION>
+<FILE>element-flvmux</FILE>
+<TITLE>flvmux</TITLE>
+GstFlvMux
+<SUBSECTION Standard>
+GstFlvMuxClass
+GstFlvMuxFlags
+GST_FLV_MUX
+GST_FLV_MUX_CLASS
+GST_IS_FLV_MUX
+GST_IS_FLV_MUX_CLASS
+GST_TYPE_FLV_MUX
+gst_flv_mux_get_type
+</SECTION>
+
 <SECTION>
 <FILE>element-input-selector</FILE>
 <TITLE>input-selector</TITLE>
diff --git a/gst/flv/gstflvdemux.c b/gst/flv/gstflvdemux.c
index a2bbd7cb..f31a22e8 100644
--- a/gst/flv/gstflvdemux.c
+++ b/gst/flv/gstflvdemux.c
@@ -17,6 +17,19 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-flvdemux
+ *
+ * flvdemux demuxes an FLV file into the different contained streams.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch -v filesrc location=/path/to/flv ! flvdemux ! audioconvert ! autoaudiosink
+ * ]| This pipeline demuxes an FLV file and outputs the contained raw audio streams.
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/gst/flv/gstflvdemux.h b/gst/flv/gstflvdemux.h
index 1a675e7c..72c0bcd4 100644
--- a/gst/flv/gstflvdemux.h
+++ b/gst/flv/gstflvdemux.h
@@ -56,6 +56,8 @@ struct _GstFLVDemux
 
   GstPad *audio_pad;
   GstPad *video_pad;
+
+  /* <private> */
   
   GstIndex *index;
   gint index_id;
diff --git a/gst/flv/gstflvmux.c b/gst/flv/gstflvmux.c
index 2a7c9169..c1bd1205 100644
--- a/gst/flv/gstflvmux.c
+++ b/gst/flv/gstflvmux.c
@@ -18,6 +18,19 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-flvmux
+ *
+ * flvmux muxes different streams into an FLV file.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch -v filesrc location=/path/to/audio ! decodebin2 ! queue ! flvmux name=m ! filesink location=file.flv   filesrc location=/path/to/video ! decodebin2 ! queue ! m. 
+ * ]| This pipeline muxes an audio and video file into a single FLV file.
+ * </refsect2>
+ */
+
 /* TODO:
  *   - Write metadata for the file, see FLV spec page 13
  */
diff --git a/gst/flv/gstflvmux.h b/gst/flv/gstflvmux.h
index c0af8e8f..3d634a4c 100644
--- a/gst/flv/gstflvmux.h
+++ b/gst/flv/gstflvmux.h
@@ -67,6 +67,8 @@ typedef struct _GstFlvMux {
 
   GstPad         *srcpad;
   GstCollectPads *collect;
+
+  /* <private> */
   GstPadEventFunction collect_event;
 
   GstFlvMuxState state;
-- 
cgit v1.2.1