Skip to content

Commit ca5efe2

Browse files
committed
document new tagging options
1 parent 7c77876 commit ca5efe2

File tree

2 files changed

+67
-3
lines changed

2 files changed

+67
-3
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,18 @@ or:
7676
Use the option "-r" to search recursively for music files and tag them as one
7777
album per subfolder.
7878

79-
The reference volume is -18 LUFS (5 dB louder than the EBU R 128 reference level
80-
of -23 LUFS).
79+
Some more advanced tagging options are supported as well:
80+
81+
- incremental tagging
82+
- forcing files to be treated as a single album (even though the files might be
83+
scattered over multiple folders)
84+
- `REPLAYGAIN_*` tags for Opus files (may be useful for older player software)
85+
- fine control over what values are written into the Opus header gain field
86+
87+
The reference volume for tagging is -18 LUFS (5 dB louder than the EBU R 128
88+
reference level of -23 LUFS). See
89+
[here](<https://wiki.hydrogenaud.io/index.php?title=ReplayGain_2.0_specification>)
90+
for more details and sources.
8191

8292
Use the option "-p" to print information about peak values. Use "-p sample" for
8393
sample peaks, "-p true" for true peaks, "-p dbtp" for true peaks in dBTP and

scanner/scanner.c

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ print_help(void)
7878
" --no-sort do not sort command line arguments alphabetically\n");
7979
printf(
8080
" --force-plugin=PLUGIN force input plugin; PLUGIN is one of:\n");
81-
printf(
81+
printf(/**/
8282
" sndfile, ffmpeg\n");
8383
#ifdef USE_SNDFILE
8484
printf(
@@ -105,6 +105,60 @@ print_help(void)
105105
" -t, --track write only track gain (album gain is default)\n");
106106
printf(
107107
" -n, --dry-run perform a trial run with no changes made\n");
108+
printf(
109+
" --incremental skip files that are already tagged\n");
110+
printf(
111+
" --force-as-album treat all given files as one album\n");
112+
printf(
113+
" --opus-vorbisgain-compat for compatibility with older software,\n");
114+
printf(
115+
" write 'REPLAYGAIN_*' tags to Opus files\n");
116+
printf(/**/
117+
" in addition to 'R128_*' tags\n");
118+
printf(
119+
" --opus-header-gain=ABS_DB|r128[,track][,offset=DB]|rg[,track][,offset=DB]\n");
120+
printf(/**/
121+
" write specific values into Opus header gain field,\n");
122+
printf(/**/
123+
" adjusting 'R128_*'/'REPLAYGAIN_*' tag values\n");
124+
printf(/**/
125+
" as needed\n");
126+
printf(/**/
127+
" examples:\n");
128+
printf(/**/
129+
" --opus-header-gain=r128\n");
130+
printf(/**/
131+
" R128 album/track gain (depending\n");
132+
printf(/**/
133+
" on '-t' parameter) in gain field,\n");
134+
printf(/**/
135+
" this setting is the default\n");
136+
printf(/**/
137+
" --opus-header-gain=r128,track\n");
138+
printf(/**/
139+
" R128 track gain in gain field\n");
140+
printf(/**/
141+
" --opus-header-gain=rg\n");
142+
printf(/**/
143+
" ReplayGain compatible album/track gain\n");
144+
printf(/**/
145+
" (depending on '-t' parameter) in\n");
146+
printf(/**/
147+
" gain field\n");
148+
printf(/**/
149+
" --opus-header-gain=rg,offset=3\n");
150+
printf(/**/
151+
" ReplayGain compatible album/track gain\n");
152+
printf(/**/
153+
" (depending on '-t' parameter) in\n");
154+
printf(/**/
155+
" gain field, plus 3dB\n");
156+
printf(/**/
157+
" --opus-header-gain=0: 0dB in gain field\n");
158+
printf(/**/
159+
" --opus-header-gain=2: 2dB in gain field\n");
160+
printf(/**/
161+
" --opus-header-gain=-3: -3dB in gain field\n");
108162
printf("\n");
109163
#endif
110164
printf(" Dump options:\n");

0 commit comments

Comments
 (0)