everything related to duct tape audio suite (dtas)
 help / color / Atom feed
* [PATCH] doc: favor the "gain" effect over "vol"
@ 2015-05-10  9:16 Eric Wong
  0 siblings, 0 replies; only message in thread
From: Eric Wong @ 2015-05-10  9:16 UTC (permalink / raw)
  To: dtas-all; +Cc: Eric Wong

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 f8cbe5e..b58adec 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
-- 
EW



^ permalink raw reply	[flat|nested] only message in thread

only message in thread, back to index

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-05-10  9:16 [PATCH] doc: favor the "gain" effect over "vol" Eric Wong

everything related to duct tape audio suite (dtas)

Archives are clonable:
	git clone --mirror https://80x24.org/dtas-all
	git clone --mirror http://ou63pmih66umazou.onion/dtas-all

Example config snippet for mirrors

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.audio.dtas
	nntp://ou63pmih66umazou.onion/inbox.comp.audio.dtas

 note: .onion URLs require Tor: https://www.torproject.org/

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git