From 6dbf8906b5d2153e0304de9300ecf62a49f1a772 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Olivier=20Cr=C3=AAte?= Date: Tue, 3 Mar 2009 14:30:53 -0500 Subject: [PATCH] Add Doc for mimic plugin --- docs/plugins/Makefile.am | 2 + .../plugins/gst-plugins-bad-plugins-docs.sgml | 3 + .../gst-plugins-bad-plugins-sections.txt | 27 +++++++++ docs/plugins/inspect/plugin-mimic.xml | 55 +++++++++++++++++++ ext/mimic/gstmimdec.c | 9 +++ ext/mimic/gstmimenc.c | 51 ++++++++++------- 6 files changed, 126 insertions(+), 21 deletions(-) create mode 100644 docs/plugins/inspect/plugin-mimic.xml diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index f4ede8057f..0651ca2aa0 100644 --- 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 51debaa3ba..3f296c6cac 100644 --- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml @@ -53,6 +53,8 @@ + + @@ -121,6 +123,7 @@ + diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt index 404ddac124..f2718d6312 100644 --- 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 +
+element-mimdec +mimdec +GstMimDec + +GstMimDecClass +GST_IS_MIMDEC +GST_IS_MIMDEC_CLASS +GST_MIMDEC +GST_MIMDEC_CLASS +GST_TYPE_MIMDEC +gst_mimdec_get_type +
+ +
+element-mimenc +mimenc +GstMimEnc + +GstMimEncClass +GST_IS_MIMENC +GST_IS_MIMENC_CLASS +GST_MIMENC +GST_MIMENC_CLASS +GST_TYPE_MIMENC +gst_mimenc_get_type +
diff --git a/docs/plugins/inspect/plugin-mimic.xml b/docs/plugins/inspect/plugin-mimic.xml new file mode 100644 index 0000000000..736b710e01 --- /dev/null +++ b/docs/plugins/inspect/plugin-mimic.xml @@ -0,0 +1,55 @@ + + mimic + Mimic codec + ../../ext/mimic/.libs/libgstmimic.so + libgstmimic.so + 0.10.10.1 + LGPL + gst-plugins-bad + GStreamer Bad Plug-ins CVS/prerelease + Unknown package origin + + + mimdec + MimDec + Codec/Decoder/Video + Mimic decoder + Andre Moreira Magalhaes <andre.magalhaes@indt.org.br>, Rob Taylor <robtaylor@fastmail.fm>, Philippe Khalaf <burger@speedy.org>, Ole André Vadla Ravnås <oleavr@gmail.com> + + + sink + sink + always +
video/x-mimic
+ + + src + source + always +
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 ]
+ + + + + mimenc + MimEnc + Codec/Encoder/Video + Mimic encoder + Andre Moreira Magalhaes <andre.magalhaes@indt.org.br> + + + sink + sink + always +
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
+ + + src + source + always +
video/x-mimic
+ + + + + \ No newline at end of file diff --git a/ext/mimic/gstmimdec.c b/ext/mimic/gstmimdec.c index 37bafc2269..c7f1ec87a2 100644 --- 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 3f3210cc68..a69ab2cc36 100644 --- a/ext/mimic/gstmimenc.c +++ b/ext/mimic/gstmimenc.c @@ -1,24 +1,33 @@ - /* - * GStreamer - * Copyright (c) 2005 INdT. - * @author Andre Moreira Magalhaes - * @author Philippe Khalaf - * - * 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 + * @author Philippe Khalaf + * + * 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"