Skip to content

Commit

Permalink
document new tagging options
Browse files Browse the repository at this point in the history
  • Loading branch information
jiixyj committed Dec 24, 2021
1 parent 7c77876 commit ca5efe2
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 3 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,18 @@ or:
Use the option "-r" to search recursively for music files and tag them as one
album per subfolder.

The reference volume is -18 LUFS (5 dB louder than the EBU R 128 reference level
of -23 LUFS).
Some more advanced tagging options are supported as well:

- incremental tagging
- forcing files to be treated as a single album (even though the files might be
scattered over multiple folders)
- `REPLAYGAIN_*` tags for Opus files (may be useful for older player software)
- fine control over what values are written into the Opus header gain field

The reference volume for tagging is -18 LUFS (5 dB louder than the EBU R 128
reference level of -23 LUFS). See
[here](<https://wiki.hydrogenaud.io/index.php?title=ReplayGain_2.0_specification>)
for more details and sources.

Use the option "-p" to print information about peak values. Use "-p sample" for
sample peaks, "-p true" for true peaks, "-p dbtp" for true peaks in dBTP and
Expand Down
56 changes: 55 additions & 1 deletion scanner/scanner.c
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ print_help(void)
" --no-sort do not sort command line arguments alphabetically\n");
printf(
" --force-plugin=PLUGIN force input plugin; PLUGIN is one of:\n");
printf(
printf(/**/
" sndfile, ffmpeg\n");
#ifdef USE_SNDFILE
printf(
Expand All @@ -105,6 +105,60 @@ print_help(void)
" -t, --track write only track gain (album gain is default)\n");
printf(
" -n, --dry-run perform a trial run with no changes made\n");
printf(
" --incremental skip files that are already tagged\n");
printf(
" --force-as-album treat all given files as one album\n");
printf(
" --opus-vorbisgain-compat for compatibility with older software,\n");
printf(
" write 'REPLAYGAIN_*' tags to Opus files\n");
printf(/**/
" in addition to 'R128_*' tags\n");
printf(
" --opus-header-gain=ABS_DB|r128[,track][,offset=DB]|rg[,track][,offset=DB]\n");
printf(/**/
" write specific values into Opus header gain field,\n");
printf(/**/
" adjusting 'R128_*'/'REPLAYGAIN_*' tag values\n");
printf(/**/
" as needed\n");
printf(/**/
" examples:\n");
printf(/**/
" --opus-header-gain=r128\n");
printf(/**/
" R128 album/track gain (depending\n");
printf(/**/
" on '-t' parameter) in gain field,\n");
printf(/**/
" this setting is the default\n");
printf(/**/
" --opus-header-gain=r128,track\n");
printf(/**/
" R128 track gain in gain field\n");
printf(/**/
" --opus-header-gain=rg\n");
printf(/**/
" ReplayGain compatible album/track gain\n");
printf(/**/
" (depending on '-t' parameter) in\n");
printf(/**/
" gain field\n");
printf(/**/
" --opus-header-gain=rg,offset=3\n");
printf(/**/
" ReplayGain compatible album/track gain\n");
printf(/**/
" (depending on '-t' parameter) in\n");
printf(/**/
" gain field, plus 3dB\n");
printf(/**/
" --opus-header-gain=0: 0dB in gain field\n");
printf(/**/
" --opus-header-gain=2: 2dB in gain field\n");
printf(/**/
" --opus-header-gain=-3: -3dB in gain field\n");
printf("\n");
#endif
printf(" Dump options:\n");
Expand Down

0 comments on commit ca5efe2

Please sign in to comment.