diff options
| author | wisp3rwind <17089248+wisp3rwind@users.noreply.github.com> | 2021-03-18 15:09:05 +0100 |
|---|---|---|
| committer | wisp3rwind <17089248+wisp3rwind@users.noreply.github.com> | 2022-01-22 14:00:32 +0100 |
| commit | 3eb49fca2e5d4934881ea3cea80473b362c02ad9 (patch) | |
| tree | 93aece0f9f985273d4de2c078044176afe48f886 | |
| parent | 6689502854056bb80125e629a0ef67d91a775c9b (diff) | |
replaygain: clarify docs for overwrite/force and actually respect it correctly
The code used to always check the 'overwrite' config value, while that
should only apply during imports. The manual 'replaygain' command has it's
own '-f' flag.
The logic for this flag was changed quite a few times recently, see
https://github.com/beetbox/beets/pull/3816
https://github.com/beetbox/beets/issues/3872
https://github.com/beetbox/beets/pull/3890
but apparently we (me and @ybnd) never really got it right...
If it is some comfort, the logic was never correct in the first place.
| -rw-r--r-- | beetsplug/replaygain.py | 14 | ||||
| -rw-r--r-- | docs/plugins/replaygain.rst | 5 |
2 files changed, 9 insertions, 10 deletions
diff --git a/beetsplug/replaygain.py b/beetsplug/replaygain.py index c1266f46f..eb322dadf 100644 --- a/beetsplug/replaygain.py +++ b/beetsplug/replaygain.py @@ -989,7 +989,9 @@ class ReplayGainPlugin(BeetsPlugin): 'r128_targetlevel': lufs_to_db(-23), }) - self.overwrite = self.config['overwrite'].get(bool) + # FIXME: Consider renaming the configuration option and deprecating the + # old name 'overwrite'. + self.force_on_import = self.config['overwrite'].get(bool) self.per_disc = self.config['per_disc'].get(bool) # Remember which backend is used for CLI feedback @@ -1047,9 +1049,6 @@ class ReplayGainPlugin(BeetsPlugin): and item.rg_track_peak is not None) def track_requires_gain(self, item): - if self.overwrite: - return True - if self.should_use_r128(item): if not self.has_r128_track_data(item): return True @@ -1074,9 +1073,6 @@ class ReplayGainPlugin(BeetsPlugin): # recalculation. This way, if any file among an album's tracks # needs recalculation, we still get an accurate album gain # value. - if self.overwrite: - return True - for item in album.items(): if self.should_use_r128(item): if not self.has_r128_album_data(item): @@ -1340,9 +1336,9 @@ class ReplayGainPlugin(BeetsPlugin): """ if self.config['auto']: if task.is_album: - self.handle_album(task.album, False) + self.handle_album(task.album, False, self.force_on_import) else: - self.handle_track(task.item, False) + self.handle_track(task.item, False, self.force_on_import) def command_func(self, lib, opts, args): try: diff --git a/docs/plugins/replaygain.rst b/docs/plugins/replaygain.rst index fa0e10b75..4ba882686 100644 --- a/docs/plugins/replaygain.rst +++ b/docs/plugins/replaygain.rst @@ -112,7 +112,10 @@ configuration file. The available options are: - **backend**: The analysis backend; either ``gstreamer``, ``command``, ``audiotools`` or ``ffmpeg``. Default: ``command``. -- **overwrite**: Re-analyze files that already have ReplayGain tags. +- **overwrite**: On import, re-analyze files that already have ReplayGain tags. + Note that, for historical reasons, the name of this option is somewhat + unfortunate: It does not decide whether tags are written to the files (which + is controlled by the :ref:`import.write <config-import-write>` option). Default: ``no``. - **targetlevel**: A number of decibels for the target loudness level for files using ``REPLAYGAIN_`` tags. |