summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorSebastian Dröge <slomo@circular-chaos.org>2007-03-08 10:02:12 +0000
committerSebastian Dröge <slomo@circular-chaos.org>2007-03-08 10:02:12 +0000
commitdbd1b8490f2b64085e5c56bf1b2aaf430eab5b0f (patch)
tree2044b1c05f99926dbf3ccd6dc843638494e32900 /docs
parentd5dbe58af2714c775f2be9fb69734193f1f8e871 (diff)
gst/audiofx/: Add new audiodynamic element which can act as a compressor or expander. Supported are hard-knee and sof...
Original commit message from CVS: reviewed by: Stefan Kost <ensonic@users.sf.net> * gst/audiofx/Makefile.am: * gst/audiofx/audiodynamic.c: (gst_audio_dynamic_characteristics_get_type), (gst_audio_dynamic_mode_get_type), (gst_audio_dynamic_set_process_function), (gst_audio_dynamic_base_init), (gst_audio_dynamic_class_init), (gst_audio_dynamic_init), (gst_audio_dynamic_set_property), (gst_audio_dynamic_get_property), (gst_audio_dynamic_setup), (gst_audio_dynamic_transform_hard_knee_compressor_int), (gst_audio_dynamic_transform_hard_knee_compressor_float), (gst_audio_dynamic_transform_soft_knee_compressor_int), (gst_audio_dynamic_transform_soft_knee_compressor_float), (gst_audio_dynamic_transform_hard_knee_expander_int), (gst_audio_dynamic_transform_hard_knee_expander_float), (gst_audio_dynamic_transform_soft_knee_expander_int), (gst_audio_dynamic_transform_soft_knee_expander_float), (gst_audio_dynamic_transform_ip): * gst/audiofx/audiodynamic.h: * gst/audiofx/audiofx.c: (plugin_init): Add new audiodynamic element which can act as a compressor or expander. Supported are hard-knee and soft-knee operation modes with user-specified ratio and threshold. Attack and release parameters are not yet implemented but will follow. * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-good-plugins-docs.sgml: * docs/plugins/gst-plugins-good-plugins-sections.txt: * docs/plugins/gst-plugins-good-plugins.args: * docs/plugins/inspect/plugin-audiofx.xml: Integrate audiodynamic into the docs. * tests/check/Makefile.am: * tests/check/elements/audiodynamic.c: (setup_dynamic), (cleanup_dynamic), (GST_START_TEST), (dynamic_suite), (main): Add unit test for audiodynamic.
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/Makefile.am1
-rw-r--r--docs/plugins/gst-plugins-good-plugins-docs.sgml1
-rw-r--r--docs/plugins/gst-plugins-good-plugins-sections.txt10
-rw-r--r--docs/plugins/gst-plugins-good-plugins.args40
-rw-r--r--docs/plugins/inspect/plugin-audiofx.xml7
5 files changed, 59 insertions, 0 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 640edbbb..174bb997 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -81,6 +81,7 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/audiofx/audiopanorama.h \
$(top_srcdir)/gst/audiofx/audioinvert.h \
$(top_srcdir)/gst/audiofx/audioamplify.h \
+ $(top_srcdir)/gst/audiofx/audiodynamic.h \
$(top_srcdir)/gst/autodetect/gstautoaudiosink.h \
$(top_srcdir)/gst/autodetect/gstautovideosink.h \
$(top_srcdir)/gst/avi/gstavidemux.h \
diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml
index 37d17dda..291cc465 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -17,6 +17,7 @@
<xi:include href="xml/element-audiopanorama.xml" />
<xi:include href="xml/element-audioinvert.xml" />
<xi:include href="xml/element-audioamplify.xml" />
+ <xi:include href="xml/element-audiodynamic.xml" />
<xi:include href="xml/element-autoaudiosink.xml" />
<xi:include href="xml/element-autovideosink.xml" />
<xi:include href="xml/element-avidemux.xml" />
diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt
index 066566c5..a092e485 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -58,6 +58,16 @@ GST_AUDIO_AMPLIFY_CLASS
</SECTION>
<SECTION>
+<FILE>element-audiodynamic</FILE>
+GstAudioDynamic
+<TITLE>audiodynamic</TITLE>
+<SUBSECTION Standard>
+GstAudioDynamicClass
+GST_AUDIO_DYNAMIC
+GST_AUDIO_DYNAMIC_CLASS
+</SECTION>
+
+<SECTION>
<FILE>element-autoaudiosink</FILE>
GstAutoAudioSink
<TITLE>autoaudiosink</TITLE>
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args
index 19537ee2..0486e22f 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -16668,3 +16668,43 @@
<DEFAULT>Normal Clipping (default)</DEFAULT>
</ARG>
+<ARG>
+<NAME>GstAudioDynamic::characteristics</NAME>
+<TYPE>GstAudioDynamicCharacteristics</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Characteristics</NICK>
+<BLURB>Selects whether the ratio should be applied smooth (soft-knee) or hard (hard-knee).</BLURB>
+<DEFAULT>Hard Knee (default)</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioDynamic::mode</NAME>
+<TYPE>GstAudioDynamicMode</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Mode</NICK>
+<BLURB>Selects whether the filter should work on loud samples (compressor) orquiet samples (expander).</BLURB>
+<DEFAULT>Compressor (default)</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioDynamic::ratio</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>[0,inf]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Ratio</NICK>
+<BLURB>Ratio that should be applied.</BLURB>
+<DEFAULT>1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioDynamic::threshold</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>[0,1]</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Threshold</NICK>
+<BLURB>Threshold until the filter is activated.</BLURB>
+<DEFAULT>0</DEFAULT>
+</ARG>
+
diff --git a/docs/plugins/inspect/plugin-audiofx.xml b/docs/plugins/inspect/plugin-audiofx.xml
index f860bd2b..9740da9e 100644
--- a/docs/plugins/inspect/plugin-audiofx.xml
+++ b/docs/plugins/inspect/plugin-audiofx.xml
@@ -17,6 +17,13 @@
<author>Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</author>
</element>
<element>
+ <name>audiodynamic</name>
+ <longname>AudioDynamic</longname>
+ <class>Filter/Effect/Audio</class>
+ <description>Compressor and Expander</description>
+ <author>Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</author>
+ </element>
+ <element>
<name>audioinvert</name>
<longname>AudioInvert</longname>
<class>Filter/Effect/Audio</class>