about summary refs log tree commit homepage
path: root/Documentation/dtas-splitfx.txt
diff options
authorEric Wong <e@80x24.org>2015-01-19 07:05:00 +0000
committerEric Wong <e@80x24.org>2015-01-19 09:58:47 +0000
commit72977765a3c30f2a8a89ccbf23fde8289c81bdf9 (patch)
tree7345d5d89b6cae5baea569c38450a8c7b883a959 /Documentation/dtas-splitfx.txt
parent3e392aa8edf36a471f951b880e421be056d72587 (diff)
This rounds out the documentation a bit and hopefully
introduces/encourages some commonality between the playback
and processing/production components of dtas.

Clarify some splitfx-related environment variables while
we're at it.
Diffstat (limited to 'Documentation/dtas-splitfx.txt')
1 files changed, 4 insertions, 3 deletions
diff --git a/Documentation/dtas-splitfx.txt b/Documentation/dtas-splitfx.txt
index 0fd2f3a..beee4bf 100644
--- a/Documentation/dtas-splitfx.txt
+++ b/Documentation/dtas-splitfx.txt
@@ -99,17 +99,18 @@ dtas-splitfx sets several default environment variables for commands to
 use in targets:
 * INFILE - this matches the "infile" directive in the YAML file
-* INDIR - the directory INFILE belongs to
+* INDIR - the directory INFILE belongs to, without trailing slash
 * INBASE - the basename of INFILE
 * TRIMFX - essential, this supplys the necessary sox(1) trim effect to
   each track.
 * COMMENTS - expands to --comment-file=PATH for sox(1)
-* OUTFMT - sox(1) arguments for the output format (e.g. "-ts32 -c2 -r44100"
+* OUTFMT - sox(1) arguments for the output format (e.g. "-ts32 -c2 * -r44100")
 * SUFFIX - the suffix of the output format without "." (e.g. "flac", "ogg")
 * TRACKNUMBER - the track number, useful for comments and filenames
 * RATEFX - rate effect and arguments for sox(1) resampling
 * DITHERFX - dither effect and arguments for sox(1) dithering
+* FX - any user-specified sox effects which encompases the entire file.
+  (e.g. "highpass 35 vol +3dB stats")
 The default targets will split audio and avoid applying any effects.