shithub: sox

Download patch

ref: 4c789efcd4c3d37ea7ca2fbc833f54dc28f11d85
parent: 1a4da74823561e9ba7be153f9a3609ff5423d90c
author: robs <robs>
date: Wed Sep 10 16:50:32 EDT 2008

deprecate pan

--- a/ChangeLog
+++ b/ChangeLog
@@ -35,6 +35,7 @@
   ated in  [F(ormat)] [E(ffect)]   Replacement             due after
   -------  ----------------------  ----------------------  -------
   14.1.1   E key                   pitch                   14.1.1 + 6 months
+  14.1.1   E pan                   ~= mixer/remix          14.1.1 + 6 months
 
 Other new features:
 
--- a/README
+++ b/README
@@ -139,7 +139,6 @@
 
   o Mixing effects
     o mixer		Mix up to 4 channels in certain ways
-    o pan		Fade from one channel to another
     o remix		Produce arbirarily mixed output channels
     o swap		Swap stereo channels
 
--- a/soxeffect.7
+++ b/soxeffect.7
@@ -640,12 +640,6 @@
 .SP
 See also \fBfilter\fR for filters with a steeper roll-off.
 .TP
-\fBkey \fR[\fB\-q\fR] \fIshift\fR [\fIsegment\fR [\fIsearch\fR [\fIoverlap\fR]]]
-Change the audio key (i.e. pitch but not tempo).
-This is just an alias for the
-.B pitch
-effect.
-.TP
 \fBladspa\fR \fBmodule\fR [\fBplugin\fR] [\fBargument\fR...]
 Apply a LADSPA [5] (Linux Audio Developer's Simple Plugin API) plugin.
 Despite the name, LADSPA is not Linux-specific, and a wide range of
@@ -879,19 +873,6 @@
 If silence is wanted only at the end of the audio, specify either the end
 position or specify a zero-length pad at the start.
 .TP
-\fBpan \fIdirection\fR
-Pan the audio from one channel to another.  This is done by
-changing the volume of the input channels so that it fades out on one
-channel and fades-in on another.  If the number of input channels is
-different then the number of output channels then this effect tries to
-intelligently handle this.  For instance, if the input contains 1 channel
-and the output contains 2 channels, then it will create the missing channel
-itself.  The
-.I direction
-is a value from \-1 to 1.  \-1 represents
-far left and 1 represents far right.  Numbers in between will start the
-pan effect without totally muting the opposite channel.
-.TP
 \fBphaser \fIgain-in gain-out delay decay speed\fR [\fB\-s\fR\^|\^\fB\-t\fR]
 Add a phasing effect to the audio.
 See [3] for a detailed description of phasing.
@@ -1941,6 +1922,25 @@
 The following effects have been renamed or have their functionality
 included in another effect; they continue to work in this version of
 SoX but may be removed in future.
+.TP
+\fBkey \fR[\fB\-q\fR] \fIshift\fR [\fIsegment\fR [\fIsearch\fR [\fIoverlap\fR]]]
+Change the audio key (i.e. pitch but not tempo).
+This is just an alias for the
+.B pitch
+effect.
+.TP
+\fBpan \fIdirection\fR
+Pan the audio from one channel to another.  This is done by
+changing the volume of the input channels so that it fades out on one
+channel and fades-in on another.  If the number of input channels is
+different then the number of output channels then this effect tries to
+intelligently handle this.  For instance, if the input contains 1 channel
+and the output contains 2 channels, then it will create the missing channel
+itself.  The
+.I direction
+is a value from \-1 to 1.  \-1 represents
+far left and 1 represents far right.  Numbers in between will start the
+pan effect without totally muting the opposite channel.
 .TP
 \fBpolyphase\fR [\fB\-w nut\fR\^|\^\fBham\fR] [\fB\-width \fIn\fR] [\fB\-cut-off \fIc\fR]
 Change the sampling rate using `polyphase interpolation', a DSP algorithm.
--- a/src/pan.c
+++ b/src/pan.c
@@ -410,7 +410,7 @@
 static sox_effect_handler_t sox_pan_effect = {
   "pan",
   "direction (in [-1.0 .. 1.0])",
-  SOX_EFF_MCHAN | SOX_EFF_CHAN,
+  SOX_EFF_MCHAN | SOX_EFF_CHAN | SOX_EFF_DEPRECATED,
   sox_pan_getopts,
   sox_pan_start,
   sox_pan_flow,