summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorSebastian Dröge <slomo@circular-chaos.org>2007-01-24 12:41:03 +0000
committerSebastian Dröge <slomo@circular-chaos.org>2007-01-24 12:41:03 +0000
commit54b10ebf2a72af1ec366265e705279da399fd60d (patch)
tree2eefcac7f48b284901315c7a563d51bafa4d8309 /docs
parent1f51fd9785945f1b33c3464af363b42e445d32f3 (diff)
gst/audiofx/: Add new element "audioamplify". This allows scaling of raw audio samples, similar to the "volume" eleme...
Original commit message from CVS: reviewed by: Stefan Kost <ensonic@users.sf.net> * gst/audiofx/Makefile.am: * gst/audiofx/audioamplify.c: (gst_audio_amplify_clipping_method_get_type), (gst_audio_amplify_base_init), (gst_audio_amplify_class_init), (gst_audio_amplify_init), (gst_audio_amplify_set_process_function), (gst_audio_amplify_set_property), (gst_audio_amplify_get_property), (gst_audio_amplify_set_caps), (gst_audio_amplify_transform_int_clip), (gst_audio_amplify_transform_int_wrap_negative), (gst_audio_amplify_transform_int_wrap_positive), (gst_audio_amplify_transform_float_clip), (gst_audio_amplify_transform_float_wrap_negative), (gst_audio_amplify_transform_float_wrap_positive), (gst_audio_amplify_transform_ip): * gst/audiofx/audioamplify.h: * gst/audiofx/audiofx.c: (plugin_init): Add new element "audioamplify". This allows scaling of raw audio samples, similar to the "volume" element, but provides different modes for clipping and allows unlimited amplification. It's mainly targeted for creative sound design and not as a replacement of the "volume" element. Fixes #397162 * 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: Add docs for audioamplify and integrate them into the build system * tests/check/Makefile.am: * tests/check/elements/audioamplify.c: (setup_amplify), (cleanup_amplify), (GST_START_TEST), (amplify_suite), (main): Add fairly extensive unit test suite for audioamplify
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.args20
-rw-r--r--docs/plugins/inspect/plugin-audiofx.xml7
5 files changed, 39 insertions, 0 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index e7746e30..2a758478 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -77,6 +77,7 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/apetag/gstapedemux.h \
$(top_srcdir)/gst/audiofx/audiopanorama.h \
$(top_srcdir)/gst/audiofx/audioinvert.h \
+ $(top_srcdir)/gst/audiofx/audioamplify.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 5f7af731..39b97578 100644
--- a/docs/plugins/gst-plugins-good-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml
@@ -16,6 +16,7 @@
<xi:include href="xml/element-apev2mux.xml" />
<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-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 9da8dacf..bb8d1331 100644
--- a/docs/plugins/gst-plugins-good-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-good-plugins-sections.txt
@@ -48,6 +48,16 @@ GST_AUDIO_INVERT_CLASS
</SECTION>
<SECTION>
+<FILE>element-audioamplify</FILE>
+GstAudioAmplify
+<TITLE>audioamplify</TITLE>
+<SUBSECTION Standard>
+GstAudioAmplifyClass
+GST_AUDIO_AMPLIFY
+GST_AUDIO_AMPLIFY_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 19bc7f5d..19537ee2 100644
--- a/docs/plugins/gst-plugins-good-plugins.args
+++ b/docs/plugins/gst-plugins-good-plugins.args
@@ -16648,3 +16648,23 @@
<DEFAULT>0</DEFAULT>
</ARG>
+<ARG>
+<NAME>GstAudioAmplify::amplification</NAME>
+<TYPE>gfloat</TYPE>
+<RANGE>>= 0</RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Amplification</NICK>
+<BLURB>Factor of amplification.</BLURB>
+<DEFAULT>1</DEFAULT>
+</ARG>
+
+<ARG>
+<NAME>GstAudioAmplify::clipping-method</NAME>
+<TYPE>GstAudioPanoramaClippingMethod</TYPE>
+<RANGE></RANGE>
+<FLAGS>rw</FLAGS>
+<NICK>Clipping method</NICK>
+<BLURB>Selects how to handle values higher than the maximum.</BLURB>
+<DEFAULT>Normal Clipping (default)</DEFAULT>
+</ARG>
+
diff --git a/docs/plugins/inspect/plugin-audiofx.xml b/docs/plugins/inspect/plugin-audiofx.xml
index 54b4926c..f860bd2b 100644
--- a/docs/plugins/inspect/plugin-audiofx.xml
+++ b/docs/plugins/inspect/plugin-audiofx.xml
@@ -10,6 +10,13 @@
<origin>http://gstreamer.net/</origin>
<elements>
<element>
+ <name>audioamplify</name>
+ <longname>AudioAmplify</longname>
+ <class>Filter/Effect/Audio</class>
+ <description>Amplifies an audio stream by a given factor</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>