From 7950499805315c637d7347a47f82d97af53a3a5a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Olivier=20Cr=C3=AAte?= <olivier.crete@collabora.co.uk>
Date: Mon, 14 Jun 2010 15:15:09 -0400
Subject: [PATCH] videomaxrate: Add to docs

---
 docs/plugins/Makefile.am                          |  1 +
 docs/plugins/gst-plugins-bad-plugins-docs.sgml    |  2 ++
 docs/plugins/gst-plugins-bad-plugins-sections.txt | 14 ++++++++++++++
 gst/videomaxrate/videomaxrate.c                   | 14 ++++++++++++++
 gst/videomaxrate/videomaxrate.h                   |  2 ++
 5 files changed, 33 insertions(+)

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 93aa454580..0f9a0651c8 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -161,6 +161,7 @@ EXTRA_HFILES = \
 	$(top_srcdir)/gst/selector/gstoutputselector.h \
 	$(top_srcdir)/gst/speed/gstspeed.h \
 	$(top_srcdir)/gst/stereo/gststereo.h \
+	$(top_srcdir)/gst/videomaxrate/videomaxrate.h \
 	$(top_srcdir)/gst/videosignal/gstvideoanalyse.h \
 	$(top_srcdir)/gst/videosignal/gstvideodetect.h \
 	$(top_srcdir)/gst/videosignal/gstvideomark.h \
diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
index c56545929b..342391dae0 100644
--- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -89,6 +89,7 @@
     <xi:include href="xml/element-videoanalyse.xml" />
     <xi:include href="xml/element-videodetect.xml" />
     <xi:include href="xml/element-videomark.xml" />
+    <xi:include href="xml/element-videomaxrate.xml" />
     <xi:include href="xml/element-videoparse.xml" />
     <xi:include href="xml/element-wildmidi.xml" />
     <xi:include href="xml/element-zbar.xml" />
@@ -171,6 +172,7 @@
     <xi:include href="xml/plugin-tta.xml" />
     <xi:include href="xml/plugin-valve.xml" />
     <xi:include href="xml/plugin-vcdsrc.xml" />
+    <xi:include href="xml/plugin-videomaxrate.xml" />
     <xi:include href="xml/plugin-videosignal.xml" />
     <xi:include href="xml/plugin-vmnc.xml" />
     <xi:include href="xml/plugin-wildmidi.xml" />
diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
index 4302877ba5..49535e60c3 100644
--- a/docs/plugins/gst-plugins-bad-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -1116,6 +1116,20 @@ GST_VIDEO_DETECT_CLASS
 GST_IS_VIDEO_DETECT_CLASS
 </SECTION>
 
+<SECTION>
+<FILE>element-videomaxrate</FILE>
+<TITLE>videomaxrate</TITLE>
+GstVideoMaxRate
+<SUBSECTION Standard>
+GstVideoMaxRateClass
+GST_VIDEO_MAX_RATE
+GST_IS_VIDEO_MAX_RATE
+GST_TYPE_VIDEO_MAX_RATE
+gst_video_max_rate_get_type
+GST_VIDEO_MAX_RATE_CLASS
+GST_IS_VIDEO_MAX_RATE_CLASS
+</SECTION>
+
 <SECTION>
 <FILE>element-videomark</FILE>
 <TITLE>videomark</TITLE>
diff --git a/gst/videomaxrate/videomaxrate.c b/gst/videomaxrate/videomaxrate.c
index 52edbceec4..0d7bb4f07e 100644
--- a/gst/videomaxrate/videomaxrate.c
+++ b/gst/videomaxrate/videomaxrate.c
@@ -24,6 +24,20 @@
  *
  */
 
+
+/**
+ * SECTION:element-videomaxrate
+ * @see_also: videorate
+ *
+ * This object will drop buffers that go beyond a certain buffer rate
+ * (ie frame rate). It should work with any kind of data where each buffer
+ * is independent. This currently means raw video frames and still image
+ * formats.
+ *
+ * The framerate is computed using a moving average. The period over which this
+ * average is computed is configurable using the "average-period" property.
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/gst/videomaxrate/videomaxrate.h b/gst/videomaxrate/videomaxrate.h
index 03b17337dd..ec8fb8d3a6 100644
--- a/gst/videomaxrate/videomaxrate.h
+++ b/gst/videomaxrate/videomaxrate.h
@@ -45,6 +45,8 @@ struct _GstVideoMaxRate
 {
   GstBaseTransform parent;
 
+  /*< private >*/
+
   GstClockTimeDiff wanted_diff;
   GstClockTime average_period;