shithub: sox

Download patch

ref: b607b8332c7d251d97faa45d5601ddbe983bb191
parent: 097f6fb0f83ac8bd2094f2f0131fe09f55c22ad2
author: robs <robs>
date: Sun May 31 12:27:41 EDT 2009

doc updates

--- a/ChangeLog
+++ b/ChangeLog
@@ -84,12 +84,12 @@
   o New `fir' filter effect using external coefficients/file.  (robs)
   o New `biquad' filter effect using external coefficients.  (robs)
   o New `overdrive' effect.  (robs)
-  o New `pluck' and `tpdf' types for `synth'.  (robs)
+  o `synth' enhancements: can now set common parameters for multiple
+    channels, new `pluck' and `tpdf' types, `scientific' note
+    notation, [2778142] just intonation.  (robs)
   o New multi-channel support and revised sizing options for `spectrogram'.
     N.B. revised options are not directly backwards compatible -- see the
     man page for details of the new syntax.  (robs)
-  o [2778142] just intonation for `synth'.  (robs)
-  o Can now set common parameters for multiple `synth' channels.  (robs)
   o Richer gain/normalise options.  (robs)
   o [2704442] Slight change to `riaa' gain: now norm'd to 0dB @ 1k
     (previously 19.9dB @ DC).  (Glenn Davis)
--- a/NEWS
+++ b/NEWS
@@ -23,7 +23,7 @@
   o Can now auto-detect file-type even when inputing from a pipe.
 
 For the complete list of changes, see the ChangeLog at
-  http://sox.cvs.sourceforge.net/sox/sox/ChangeLog?revision=1.228&view=markup
+  http://sox.cvs.sourceforge.net/sox/sox/ChangeLog?revision=SOX_14_3_0&view=markup
 
 Thanks to all who contributed to this release.
 
--- a/sox.1
+++ b/sox.1
@@ -3714,10 +3714,10 @@
 .ne 2
    play -n synth 0.5 sine 200-500 synth 0.5 sine fmod 700-100
 .EE
-Frequencies can also be given as a number of semitones
-relative to `middle A' (440\ Hz) by prefixing a `%' character;  for
-example, the following could be used to help tune a guitar's low `E'
-string:
+Frequencies can also be given in `scientific' note notation, or, by
+prefixing a `%' character, as a number of semitones relative to
+`middle A' (440\ Hz).  For example, the following could be used to
+help tune a guitar's low `E' string:
 .EX
    play -n synth 4 pluck %-29
 .EE
@@ -3724,8 +3724,8 @@
 or with a (Bourne shell) loop, the whole guitar:
 .EX
 .ne 2
-   for s in -29 -24 -19 -14 -10 -5; do
-	play -n synth 4 pluck %$s repeat 2; done
+   for n in E2 A2 D3 G3 B3 E4; do
+	play -n synth 4 pluck $n repeat 2; done
 .EE
 See the
 .B delay
@@ -3770,14 +3770,16 @@
 .SP
 \fIfreq\fR/\fIfreq2\fR are the frequencies at the beginning/end of
 synthesis in Hz or, if preceded with `%', semitones relative to A
-(440\ Hz); for both, default=%0.  By default, the tuning used for the
-semitone notation is equal temperament; the
+(440\ Hz); alternatively, `scientific' note notation (e.g. E2) may
+be used.  The default frequency is 440Hz.  By default, the tuning used
+with the note notations is `equal temperament'; the
 .B \-j
 .I KEY
-option selects just intonation, where
+option selects `just intonation', where
 .I KEY
-is an integer number of semitones relative to A.
-So for example, \-9 or 3 selects the key of C.
+is an integer number of semitones relative to A (so for example, \-9
+or 3 selects the key of C), or a note in scientific notation.
+.SP
 If
 .I freq2
 is given, then
@@ -3811,11 +3813,11 @@
 default=10 (trapezium), or sustain (pluck); default=40.
 .SP
 \fIp2\fR (trapezium): the percentage through each cycle at which `falling'
-begins; default=50. exp: the amplitude in multiples of 2dB; default=50, or
-tone (pluck) default=0.
+begins; default=50. exp: the amplitude in multiples of 2dB; default=50,
+or tone-1 (pluck); default=20.
 .SP
 \fIp3\fR (trapezium): the percentage through each cycle at which `falling'
-ends; default=60.
+ends; default=60, or tone-2 (pluck); default=90.
 .TP
 \fBtempo \fR[\fB\-q\fR] \fIfactor\fR [\fIsegment\fR [\fIsearch\fR [\fIoverlap\fR]]]
 Change the audio tempo (but not its pitch).