Add Doc for mimic plugin

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index f4ede80..0651ca2 100644 (file)
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -104,6 +104,8 @@ EXTRA_HFILES = \
        $(top_srcdir)/ext/metadata/gstbasemetadata.h \
        $(top_srcdir)/ext/metadata/gstmetadatademux.h \
        $(top_srcdir)/ext/metadata/gstmetadatamux.h \
+       $(top_srcdir)/ext/mimic/gstmimenc.h \
+       $(top_srcdir)/ext/mimic/gstmimdec.h \
        $(top_srcdir)/ext/modplug/gstmodplug.h \
        $(top_srcdir)/ext/mpeg2enc/gstmpeg2enc.hh \
        $(top_srcdir)/ext/mplex/gstmplex.hh \

diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
index 51debaa..3f296c6 100644 (file)
--- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -53,6 +53,8 @@
     <xi:include href="xml/element-liveadder.xml" />
     <xi:include href="xml/element-metadatademux.xml" />
     <xi:include href="xml/element-metadatamux.xml" />
+    <xi:include href="xml/element-mimenc.xml" />
+    <xi:include href="xml/element-mimdec.xml" />
     <xi:include href="xml/element-modplug.xml" />
     <xi:include href="xml/element-mpeg2enc.xml" />
     <xi:include href="xml/element-mplex.xml" />
@@ -121,6 +123,7 @@
     <xi:include href="xml/plugin-ladspa.xml" />
     <xi:include href="xml/plugin-liveadder.xml" />
     <xi:include href="xml/plugin-metadata.xml" />
+    <xi:include href="xml/plugin-mimic.xml" />
     <xi:include href="xml/plugin-mms.xml" />
     <xi:include href="xml/plugin-modplug.xml" />
     <xi:include href="xml/plugin-mpeg2enc.xml" />

diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
index 404ddac..f2718d6 100644 (file)
--- a/docs/plugins/gst-plugins-bad-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -1020,3 +1020,30 @@ GST_TYPE_Y4M_ENCODE
 gst_y4m_encode_get_type
 </SECTION>
 
+<SECTION>
+<FILE>element-mimdec</FILE>
+<TITLE>mimdec</TITLE>
+GstMimDec
+<SUBSECTION Standard>
+GstMimDecClass
+GST_IS_MIMDEC
+GST_IS_MIMDEC_CLASS
+GST_MIMDEC
+GST_MIMDEC_CLASS
+GST_TYPE_MIMDEC
+gst_mimdec_get_type
+</SECTION>
+
+<SECTION>
+<FILE>element-mimenc</FILE>
+<TITLE>mimenc</TITLE>
+GstMimEnc
+<SUBSECTION Standard>
+GstMimEncClass
+GST_IS_MIMENC
+GST_IS_MIMENC_CLASS
+GST_MIMENC
+GST_MIMENC_CLASS
+GST_TYPE_MIMENC
+gst_mimenc_get_type
+</SECTION>

diff --git a/docs/plugins/inspect/plugin-mimic.xml b/docs/plugins/inspect/plugin-mimic.xml
new file mode 100644 (file)
index 0000000..736b710
--- /dev/null
+++ b/docs/plugins/inspect/plugin-mimic.xml
@@ -0,0 +1,55 @@
+<plugin>
+  <name>mimic</name>
+  <description>Mimic codec</description>
+  <filename>../../ext/mimic/.libs/libgstmimic.so</filename>
+  <basename>libgstmimic.so</basename>
+  <version>0.10.10.1</version>
+  <license>LGPL</license>
+  <source>gst-plugins-bad</source>
+  <package>GStreamer Bad Plug-ins CVS/prerelease</package>
+  <origin>Unknown package origin</origin>
+  <elements>
+    <element>
+      <name>mimdec</name>
+      <longname>MimDec</longname>
+      <class>Codec/Decoder/Video</class>
+      <description>Mimic decoder</description>
+      <author>Andre Moreira Magalhaes &lt;andre.magalhaes@indt.org.br&gt;, Rob Taylor &lt;robtaylor@fastmail.fm&gt;, Philippe Khalaf &lt;burger@speedy.org&gt;, Ole André Vadla Ravnås &lt;oleavr@gmail.com&gt;</author>
+      <pads>
+        <caps>
+          <name>sink</name>
+          <direction>sink</direction>
+          <presence>always</presence>
+          <details>video/x-mimic</details>
+        </caps>
+        <caps>
+          <name>src</name>
+          <direction>source</direction>
+          <presence>always</presence>
+          <details>video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, framerate=(fraction)[ 0/1, 30/1 ], red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, height=(int)[ 16, 4096 ], width=(int)[ 16, 4096 ]</details>
+        </caps>
+      </pads>
+    </element>
+    <element>
+      <name>mimenc</name>
+      <longname>MimEnc</longname>
+      <class>Codec/Encoder/Video</class>
+      <description>Mimic encoder</description>
+      <author>Andre Moreira Magalhaes &lt;andre.magalhaes@indt.org.br&gt;</author>
+      <pads>
+        <caps>
+          <name>sink</name>
+          <direction>sink</direction>
+          <presence>always</presence>
+          <details>video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, framerate=(fraction)[ 1/1, 30/1 ], red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)320, height=(int)240; video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, framerate=(fraction)[ 1/1, 30/1 ], red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)160, height=(int)120</details>
+        </caps>
+        <caps>
+          <name>src</name>
+          <direction>source</direction>
+          <presence>always</presence>
+          <details>video/x-mimic</details>
+        </caps>
+      </pads>
+    </element>
+  </elements>
+</plugin>
\ No newline at end of file

diff --git a/ext/mimic/gstmimdec.c b/ext/mimic/gstmimdec.c
index 37bafc2..c7f1ec8 100644 (file)
--- a/ext/mimic/gstmimdec.c
+++ b/ext/mimic/gstmimdec.c
@@ -21,6 +21,15 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+/**
+ * SECTION:element-mimdec
+ * @see_also: mimenc
+ *
+ * The MIMIC codec is used by MSN Messenger's webcam support. It consumes the
+ * TCP header for the MIMIC codec.
+ *
+ * Its fourcc is ML20.
+ */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"

diff --git a/ext/mimic/gstmimenc.c b/ext/mimic/gstmimenc.c
index 3f3210c..a69ab2c 100644 (file)
--- a/ext/mimic/gstmimenc.c
+++ b/ext/mimic/gstmimenc.c
@@ -1,24 +1,33 @@
-   /*
-    * GStreamer
-    * Copyright (c) 2005 INdT.
-    * @author Andre Moreira Magalhaes <andre.magalhaes@indt.org.br>
-    * @author Philippe Khalaf <burger@speedy.org>
-    *
-    * This library is free software; you can redistribute it and/or
-    * modify it under the terms of the GNU Library General Public
-    * License as published by the Free Software Foundation; either
-    * version 2 of the License, or (at your option) any later version.
-    *
-    * This library is distributed in the hope that it will be useful,
-    * but WITHOUT ANY WARRANTY; without even the implied warranty of
-    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-    * Library General Public License for more details.
-    *
-    * You should have received a copy of the GNU Library General Public
-    * License along with this library; if not, write to the
-    * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-    * Boston, MA 02111-1307, USA.
-    */
+/*
+ * GStreamer
+ * Copyright (c) 2005 INdT.
+ * @author Andre Moreira Magalhaes <andre.magalhaes@indt.org.br>
+ * @author Philippe Khalaf <burger@speedy.org>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+/**
+ * SECTION:element-mimenc
+ * @see_also: mimdec
+ *
+ * The MIMIC codec is used by MSN Messenger's webcam support. It creates the
+ * TCP header for the MIMIC codec.
+ *
+ * Its fourcc is ML20.
+ */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"