shithub: sox

Download patch

ref: ac5d719dd2cf55b3dbc6ca1c087a33eda7c3b1b5
parent: c35561001da2eccbf68c793c523db2fba1563fce
author: rrt <rrt>
date: Mon Nov 13 21:00:37 EST 2006

Add documentation for equalizer effect

--- a/Changelog
+++ b/Changelog
@@ -27,6 +27,7 @@
     by command-line arguments. (robs@users.sf.net)
   o More and better self-tests. (robs@users.sf.net)
   o Support Maxis's XA format. (Dwayne C. Litzenberger)
+  o Add equalizer effect (Pascal Giard)
 
 sox-12.18.2
 -----------
--- a/README
+++ b/README
@@ -65,6 +65,7 @@
   o Apply a flanger effect
   o Apply a high-pass filter
   o Apply a low-pass filter
+  @ Apply an equalizer effect
   o Add masking noise to a signal
   o Multi-band compander
   o Pan sound between channels
--- a/sox.1
+++ b/sox.1
@@ -863,7 +863,7 @@
 moved from inside
 your head (standard for headphones) to outside and in front of the
 listener (standard for speakers). See 
-www.geocities.com/beinges
+http://www.geocities.com/beinges
 for a full explanation.
 .TP 10
 echo \fIgain-in gain-out delay decay \fR[ \fIdelay decay ... \fR]
@@ -877,10 +877,11 @@
 Each delay/decay part gives the delay in milliseconds 
 and the decay (relative to gain-in) of that echo.
 Gain-out is the volume of the output.
-.TP
-fade [ \fItype\fR ] \fIfade-in-length\fR
 .TP 10
-     [ \fIstop-time\fR [ \fIfade-out-length\fR ] ]
+equalizer \fIcentral-frequency\fR \fIQ\fR \fIgain\fR
+Apply an equalizer effect. \fIcentral-frequency\fR gives the central frequency in Hz, \fIQ\fR is the Q-factor (see http://en.wikipedia.org/wiki/Q_factor), and \fIgain\fR is the gain or attenuation in dB.
+.TP 10
+fade [ \fItype\fR ] \fIfade-in-length\fR [ \fIstop-time\fR [ \fIfade-out-length\fR ] ]
 Add a fade effect to the beginning, end, or both of the audio data.  
 
 For fade-ins, this starts from the first sample and ramps the volume of the audio from 0 to full volume over \fIfade-in-length\fR seconds.  Specify 0 seconds if no fade-in is wanted.
--- a/src/equalizer.c
+++ b/src/equalizer.c
@@ -171,7 +171,7 @@
 
 static st_effect_t st_equalizer_effect = {
   "equalizer",
-  "Usage: equalizer central-freqency Q gain",
+  "Usage: equalizer central-frequency Q gain",
   0,
   st_equalizer_getopts, st_equalizer_start,
   st_equalizer_flow, st_effect_nothing_drain,