summaryrefslogtreecommitdiffstats
path: root/gst/equalizer
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sf.net>2009-01-28 12:29:42 +0200
committerStefan Kost <ensonic@users.sf.net>2009-01-28 12:32:59 +0200
commita99d3f8769ed3fd1266d5216ecefebfd1bdcf663 (patch)
tree4a5cf5e0f2f44b1f9ccea5344c38ef98f0a92990 /gst/equalizer
parent00fdca0c14eb9a5fe6b8b9f2d5ce2313e3b32f23 (diff)
Update and add documentation for plugins with no deps (gst).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered.
Diffstat (limited to 'gst/equalizer')
-rw-r--r--gst/equalizer/gstiirequalizer10bands.c13
-rw-r--r--gst/equalizer/gstiirequalizer3bands.c13
-rw-r--r--gst/equalizer/gstiirequalizernbands.c100
3 files changed, 54 insertions, 72 deletions
diff --git a/gst/equalizer/gstiirequalizer10bands.c b/gst/equalizer/gstiirequalizer10bands.c
index 833c8069..e56bf19e 100644
--- a/gst/equalizer/gstiirequalizer10bands.c
+++ b/gst/equalizer/gstiirequalizer10bands.c
@@ -19,20 +19,15 @@
/**
* SECTION:element-equalizer-10bands
- * @short_description: 10-band equalizer
*
- * <refsect2>
- * <para>
* The 10 band equalizer element allows to change the gain of 10 equally distributed
* frequency bands between 30 Hz and 15 kHz.
- * </para>
+ *
+ * <refsect2>
* <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
* gst-launch filesrc location=song.ogg ! oggdemux ! vorbisdec ! audioconvert ! equalizer-10bands band2=3.0 ! alsasink
- * </programlisting>
- * This raises the volume of the 3rd band which is at 119 Hz by 3 db.
- * </para>
+ * ]| This raises the volume of the 3rd band which is at 119 Hz by 3 db.
* </refsect2>
*/
diff --git a/gst/equalizer/gstiirequalizer3bands.c b/gst/equalizer/gstiirequalizer3bands.c
index c550f786..91129525 100644
--- a/gst/equalizer/gstiirequalizer3bands.c
+++ b/gst/equalizer/gstiirequalizer3bands.c
@@ -19,20 +19,15 @@
/**
* SECTION:element-equalizer-3bands
- * @short_description: 3-band equalizer
*
- * <refsect2>
- * <para>
* The 3-band equalizer element allows to change the gain of a low frequency,
* medium frequency and high frequency band.
- * </para>
+ *
+ * <refsect2>
* <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
* gst-launch filesrc location=song.ogg ! oggdemux ! vorbisdec ! audioconvert ! equalizer-3bands band1=6.0 ! alsasink
- * </programlisting>
- * This raises the volume of the 2nd band, which is at 1110 Hz, by 6 db.
- * </para>
+ * ]| This raises the volume of the 2nd band, which is at 1110 Hz, by 6 db.
* </refsect2>
*/
diff --git a/gst/equalizer/gstiirequalizernbands.c b/gst/equalizer/gstiirequalizernbands.c
index 316cd029..e2af57ef 100644
--- a/gst/equalizer/gstiirequalizernbands.c
+++ b/gst/equalizer/gstiirequalizernbands.c
@@ -20,67 +20,59 @@
/**
* SECTION:element-equalizer-nbands
- * @short_description: Fully parametric N-band equalizer
*
- * <refsect2>
- * <para>
* The n-band equalizer element is a fully parametric equalizer. It allows to
* select between 1 and 64 bands and has properties on each band to change
* the center frequency, band width and gain.
- * </para>
+ *
+ * <refsect2>
* <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
* gst-launch filesrc location=song.ogg ! oggdemux ! vorbisdec ! audioconvert ! equalizer-nbands num-bands=15 band5::gain=6.0 ! alsasink
- * </programlisting>
- * This make the equalizer use 15 bands and raises the volume of the 5th band by 6 db.
- * </para>
+ * ]| This make the equalizer use 15 bands and raises the volume of the 5th band by 6 db.
+ * </refsect2>
+ * <refsect2>
* <title>Example code</title>
- * <para>
- * <programlisting>
-
-#include &lt;gst/gst.h&gt;
-
-...
-typedef struct {
- gfloat freq;
- gfloat width;
- gfloat gain;
-} GstEqualizerBandState;
-
-...
-
- GstElement *equalizer;
- GstObject *band;
- gint i;
- GstEqualizerBandState state[] = {
- { 120.0, 50.0, - 3.0},
- { 500.0, 20.0, 12.0},
- {1503.0, 2.0, -20.0},
- {6000.0, 1000.0, 6.0},
- {3000.0, 120.0, 2.0}
- };
-
-...
-
-
- equalizer = gst_element_factory_make ("equalizer-nbands", "equalizer");
- g_object_set (G_OBJECT (equalizer), "num-bands", 5, NULL);
-
-...
-
- for (i = 0; i &lt; 5; i++) {
- band = gst_child_proxy_get_child_by_index (GST_CHILD_PROXY (equalizer), i);
- g_object_set (G_OBJECT (band), "freq", state[i].freq,
- "bandwidth", state[i].width,
- "gain", state[i].gain);
- g_object_unref (G_OBJECT (band));
- }
-
-...
-
- * </programlisting>
- * </para>
+ * |[
+ * #include &lt;gst/gst.h&gt;
+ *
+ * ...
+ * typedef struct {
+ * gfloat freq;
+ * gfloat width;
+ * gfloat gain;
+ * } GstEqualizerBandState;
+ *
+ * ...
+ *
+ * GstElement *equalizer;
+ * GstObject *band;
+ * gint i;
+ * GstEqualizerBandState state[] = {
+ * { 120.0, 50.0, - 3.0},
+ * { 500.0, 20.0, 12.0},
+ * {1503.0, 2.0, -20.0},
+ * {6000.0, 1000.0, 6.0},
+ * {3000.0, 120.0, 2.0}
+ * };
+ *
+ * ...
+ *
+ * equalizer = gst_element_factory_make ("equalizer-nbands", "equalizer");
+ * g_object_set (G_OBJECT (equalizer), "num-bands", 5, NULL);
+ *
+ * ...
+ *
+ * for (i = 0; i &lt; 5; i++) {
+ * band = gst_child_proxy_get_child_by_index (GST_CHILD_PROXY (equalizer), i);
+ * g_object_set (G_OBJECT (band), "freq", state[i].freq,
+ * "bandwidth", state[i].width,
+ * "gain", state[i].gain);
+ * g_object_unref (G_OBJECT (band));
+ * }
+ *
+ * ...
+ * ]|
* </refsect2>
*/