From d3e2d5cfa8ab2c4e8f65ac6b2bdb6212b8b4ea8b Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sun, 10 May 2015 09:15:27 +0000 Subject: doc: favor the "gain" effect over "vol" Followup-to commit 403ed90e2e7bed3e017938d76e17037b0d5059b6 (replaygain uses the "gain" effect instead of "vol") The `gain' effect seems superior as it can "see" across the effects chain to take into account extra/lost headroom. --- Documentation/dtas-env.txt | 2 +- Documentation/dtas-player_effects.txt | 6 +++--- Documentation/dtas-splitfx.txt | 8 ++++---- examples/splitfx.sample.yml | 2 +- examples/tfx.sample.yml | 4 ++-- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/Documentation/dtas-env.txt b/Documentation/dtas-env.txt index 374f626..0f59709 100644 --- a/Documentation/dtas-env.txt +++ b/Documentation/dtas-env.txt @@ -24,7 +24,7 @@ INFILE - the primary input file for playback or processing. (e.g. "/path/to/ex.flac") RGFX - the sox effect used for applying ReplayGain compensation. -Only used during playback in dtas-player. (e.g. "vol -6.0dB"). +Only used during playback in dtas-player. (e.g. "gain -6.0"). Removing this prevents ReplayGain from working and may damage playback equipment with loudly mastered music. diff --git a/Documentation/dtas-player_effects.txt b/Documentation/dtas-player_effects.txt index 9bfc525..58b69c7 100644 --- a/Documentation/dtas-player_effects.txt +++ b/Documentation/dtas-player_effects.txt @@ -7,9 +7,9 @@ They are applied in the order described. rely on inter-track information. Examples include: - - ReplayGain (simple vol/gain changes) + - ReplayGain (simple gain changes) - anything which does not change the length of the audio: - vol, stereo, highpass, lowpass, loudness, bass, treble, equalizer, ... + gain, stereo, highpass, lowpass, loudness, bass, treble, equalizer, ... Modifying source effects should introduce no extra gaps in playback. Effects which modify the length of the audio is not recommended here, @@ -34,7 +34,7 @@ They are applied in the order described. - delaying a certain channel or frequency range for time-alignment - compressors/limiters - reverb - - vol + - gain - remix (for stereo image adjustments) Additionally, effects which are necessary due to the limitation of the diff --git a/Documentation/dtas-splitfx.txt b/Documentation/dtas-splitfx.txt index a6a1f7d..27e6007 100644 --- a/Documentation/dtas-splitfx.txt +++ b/Documentation/dtas-splitfx.txt @@ -46,7 +46,7 @@ to use ecasound(1), too. * infile - string, the pathname of the original audio file * env - ordered hash of environment variables to set for all commands env: !omap - FX: vol +3dB stats + FX: gain 3 stats * comments - hash of common tags for all audio (e.g. ARTIST, ALBUM, YEAR) comments: ARTIST: John Smith @@ -118,7 +118,7 @@ use in targets: * 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") + (e.g. "highpass 35 gain 3 stats") # TARGETS @@ -150,8 +150,8 @@ imbalance in a live concert recording from the audience: targets: flac24: command: sox -M - "|sox $INFILE -c1 -p $TRIMFX remix 1v1 vol +9.5dB" - "|sox $INFILE -c1 -p $TRIMFX remix 2v1 vol +8.5dB" + "|sox $INFILE -c1 -p $TRIMFX remix 1v1 gain 9.5" + "|sox $INFILE -c1 -p $TRIMFX remix 2v1 gain 8.5" $COMMENTS $OUTFMT ${OUTDIR}bandYYYY-MM-DD.FOO.t0"$TRACKNUMBER.$SUFFIX" $RATEFX $DITHERFX stats diff --git a/examples/splitfx.sample.yml b/examples/splitfx.sample.yml index bbd224b..9c29df2 100644 --- a/examples/splitfx.sample.yml +++ b/examples/splitfx.sample.yml @@ -17,7 +17,7 @@ env: !omap SOX_OPTS: $SOX_OPTS -R FX: # highpass -1 120 highpass 40 highpass 40 - # vol +1.5dB + # gain 1.5 stats track_start: 1 # 0 for pregap/intro tracks cdda_align: true diff --git a/examples/tfx.sample.yml b/examples/tfx.sample.yml index 205a0a1..b8add0b 100644 --- a/examples/tfx.sample.yml +++ b/examples/tfx.sample.yml @@ -16,8 +16,8 @@ comments: track_start: 1 effects: # the following commands are equivalent -- trim 52 =53 sh sox $SOXIN $SOXOUT $TRIMFX vol -6dB -- trim 52 1 sox vol -6dB # shorthand +- trim 52 =53 sh sox $SOXIN $SOXOUT $TRIMFX gain -6 +- trim 52 1 sox gain -6 # shorthand # as are the following (for little endian machines) - trim 52 1 eca -eadb:-6 -- cgit v1.2.3-24-ge0c7