Commit graph

54 commits

Author SHA1 Message Date
Šarūnas Nejus
7bbd215efc
Update all docs with Poetry 2024-06-10 13:10:16 +01:00
luzpaz
8419149c7a
Fix various typos 2023-08-09 21:26:15 -04:00
wisp3rwind
3eb49fca2e 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.
2022-01-22 14:00:32 +01:00
ybnd
93101e7ea6 Disable replaygain parallelism during import 2020-12-21 19:19:20 +01:00
ybnd
b39df01d35 Add to documentation 2020-01-30 20:31:12 +01:00
Samuel Nilsson
60c174101f ffmpeg replaygain backend: Only calculate replaygain for audio stream. Fixed documentation for backend option. 2019-07-29 10:32:19 +02:00
Zsin Skri
a9f70f8151 apply suggested improvements
Apply improvements suggested in GitHub PullRequest #3065:
- be idiomatic
  - 0 is falsy
  - check enum equality, not identity
  - mutate list by constructing a new one
- improve documentation
  - fix a typo
  - do not mention deprecation of a config option
2019-07-26 01:02:03 +02:00
Zsin Skri
fbc8cc484d update replaygain target level documentation
- document `r128_targetlevel`
- explain difference between `targetlevel` and `r128_targetlevel`
- deprecate `method` option: use `targetlevel` instead.
2019-07-22 13:42:26 +02:00
Zsin Skri
f9ff56f496 improve wording in the ffmpeg replaygain backend
This commit mostly addresses feedback:
- remove some unused parenthesis
- fix a typo
- expand some docstrings
- document that ffmpeg is usually easy to install
2019-07-21 01:18:49 +02:00
Zsin Skri
c3af5b3763 replaygain: add ffmpeg backend
Add replaygain backend using ffmpeg's ebur128 filter.

The album gain is calculated as the mean of all BS.1770 gating block powers.
Besides differences in gating block offset, this should be equivalent to a
BS.1770 analysis of a proper concatenation of all tracks.

Just calculating the mean of all track gains (as implemented by the bs1770gain
backend) yields incorrect results as that would:
- completely ignore track lengths
  - just using length in seconds won't work either (e.g. BS.1770 ignores
    passages below a threshold)
- take the mean of track loudness, not power

When using the ffmpeg replaygain backend to create R128_*_GAIN tags, the
targetlevel will be set to -23 LUFS. GitHub PullRequest #3065 will make this
configurable.
It will also skip peak calculation, as there is no R128_*_PEAK tag.

It is checked if the libavfilter library supports replaygain calculation. Before
version 6.67.100 that did require the `--enable-libebur128` compile-time-option,
after that the ebur128 library is included in libavfilter itself. Thus we
require either a recent enough libavfilter version or the `--enable-libebur128`
option.
2019-07-19 21:54:47 +02:00
Samuel Nilsson
b8b99d9396 Merge branch 'master' into replaygain 2019-06-08 16:15:27 +02:00
FichteFoll
aa31fea037
Update a lot of URLs to use HTTPS
*All* URLs were checked manually, but only once per domain!

I mostly concerned myself with URLs in documentation rather than source
code because the latter may or may not have impactful changes, while the
former should be straight forward.

Changes in addition to simply adding an s:

- changed pip and pypi references as their location has changed
- MPoD (iOS app) url redirects to Regelian, so I replaced those
- updated homebrew references

Notable observations:

- beets.io does have HTTPS set up properly (via gh-pages)
- beatport.py uses the old HTTP url for beatport
- as does lyrics.py for lyrics.wikia.com
- https://tomahawk-player.org/ expired long ago, but the http page
  redirects to https regardless
- none of the sourceforge subdomains have https (in 2019!)
2019-06-05 03:11:49 +02:00
Carl Suster
2e0230789f docs: fix some markup issues and typos 2019-04-27 12:43:13 +10:00
Samuel Nilsson
1619761bd6 Updated docs with per_disc ReplayGain configuration. 2019-02-06 09:38:03 +01:00
nichobi
37d918a19e
docs: restore replaygain option for ffmpeg backend 2019-01-25 15:48:49 +01:00
nichobi
b7f75878b0
docs: remove references to bs1770gain for #3127 2019-01-24 16:07:44 +01:00
Jack Wilsdon
5ad16983d4
Fix miscellaneous typos 2018-10-09 01:11:06 +01:00
Adrian Sampson
b28e0b43ff Merge pull request #2778 from ylep/replaygain-options
Add --force, --write and --nowrite options to replaygain plugin
2018-01-02 14:50:27 -05:00
Yann Leprince
1b247dffff Document new options to the replaygain sub-command 2018-01-02 12:34:34 +01:00
Yann Leprince
8975234cd8 Add version requirement for bs1770gain to the documentation 2018-01-02 10:54:13 +01:00
Michal Koutenský
8168a88a7f update replaygain docs with info about r128 2017-05-17 21:58:41 +02:00
Fabrice Laporte
53029a0ed6 edit docs for replaygain audio tools backend 2016-02-08 00:48:00 +01:00
Adrian Sampson
821c5bf3df Documentation pass for #1398 2015-04-09 17:06:35 -07:00
jmwatte
f1f7094938 fix bs1770gain for windows and exceptionally big albums 2015-04-09 17:18:26 +02:00
jmwatte
da4a5d0797 fix bs1770gain link 2015-03-06 22:28:59 +01:00
jean-marie winters
f376d3c2a8 Merge branch 'bs1770gainsupport' of https://github.com/jmwatte/beets into bs1770gainsupport 2015-03-06 22:05:45 +01:00
jmwatte
0d70db3966 Update replaygain.rst 2015-03-06 20:36:06 +01:00
Adrian Sampson
8113c7ba85 Roll back whitespace changes from #1343 2015-03-03 10:41:30 -08:00
jean-marie winters
5bc8ef7009 fix some formating 2015-03-02 22:11:33 +01:00
jean-marie winters
72c5db8876 add doc, clean-up code 2015-03-02 15:38:33 +01:00
Arturo R
60b1819db0 Stop applying mp3gain directly to files. Fixes #1316
Update docs to remove non-existent `apply` option.
2015-02-09 12:51:27 -08:00
Adrian Sampson
d77ac45fef Fix up docs, changelog for #1070 2014-11-09 18:49:56 -08:00
Francesco Rubino
e4dfd23092 Fix to documentation after merge of upstream repo 2014-11-09 14:50:26 +00:00
Francesco Rubino
be43f629bf Merge branch 'master' of https://github.com/sampsyo/beets
Conflicts:
	docs/plugins/replaygain.rst
2014-11-09 14:48:32 +00:00
Francesco Rubino
4bf17486eb Fixed line lengths, typo in documentation. 2014-11-09 10:29:46 +00:00
Fabrice Laporte
f7ecb9cbae doc: emphasize options names by using bold font instead of fixed width 2014-11-07 22:13:25 +01:00
Francesco Rubino
8af5b0e6c3 Added backed audiotools to replaygain module and updated documentation 2014-11-07 18:14:56 +00:00
Adrian Sampson
930581ac99 Finish the pass over all plugin docs 2014-10-30 22:42:11 -07:00
Fabrice Laporte
b922abef06 docs: remove space before colon 2014-10-28 23:23:44 +01:00
Fabrice Laporte
2cd76b6714 docs: add plugin name in "how to configure" sentences 2014-10-28 23:23:10 +01:00
Fabrice Laporte
cb350de2ea harmonize all plugins docs
Add a configuration section that lists all options for each plugin.
List options in alphabetic order.
Mention the default value for each option.
Use same sentences to describe concepts common to different plugins eg 'auto
option, install description
2014-10-26 22:29:10 +01:00
Adrian Sampson
32a3da5961 Clarify dependencies for RG GStreamer backend 2014-05-17 13:21:55 -07:00
Adrian Sampson
8fb5ddc3b9 revise docs for expanded RG plugin
Among other things, this clarifies which options are available with each
backend.
2014-04-07 20:07:39 -07:00
Yevgeny Bezman
71a447fac1 replaygain: Update documentation to include some info regarding the GStreamer backend 2014-04-04 19:17:41 +02:00
Adrian Sampson
11e1fd1bd8 document new Confit-based configuration 2012-12-20 21:56:47 -08:00
Adrian Sampson
9368075756 replaygain: reinstate albumgain config option 2012-10-20 16:49:52 -07:00
Adrian Sampson
0ab3426bd9 replaygain: add command
You can now disable automatic analysis and instead use a command to manually
analyze albums or tracks.
2012-10-17 22:12:38 -07:00
Adrian Sampson
83f3069d57 replaygain: remove albumgain setting
We now always calculate album gain when importing an album. This is "free" (no
performance cost) now and players are free to ignore the setting if they so
choose.
2012-10-17 20:11:20 -07:00
Adrian Sampson
b9e2beddec replaygain: changelog & doc enhancements for GH-55 2012-10-12 22:42:08 -07:00
kraymer
6208c453c6 add apply_gain option (was default) 2012-10-12 08:52:12 +02:00