Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-02-21 14:56:02 +01:00
Code Issues Projects Releases Wiki Activity

replaygain: Update documentation to include some info regarding the GStreamer backend

Browse source
This commit is contained in:
Yevgeny Bezman 2014-03-27 15:37:25 +02:00 committed by Thomas Scholtes
parent 08b2bff28d
commit 71a447fac1
1 changed files with 36 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
docs/plugins/replaygain.rst
View file

@ -9,8 +9,37 @@ playback levels.
Installation
------------
This plugin uses the `mp3gain`_ command-line tool or the `aacgain`_ fork
thereof. To get started, install this tool:
This plugin can use one of two backends to compute the ReplayGain values
GStreamer
`````````
This backend uses the popular `GStreamer`_ multimedia framework.
In order to use this backend, you will need to install the GStreamer library
as well as a set of plugins for handling your selection of audio files.
Some linux distributions don't package plugins for some popular formats in
their default repositories, and packages for those plugins need to be
downloaded from elsewhere or compiled from source.
The minimal version of the GStreamer library supported by this backend is 1.0
The 0.x branch (which is the default on some older distributions) is not
supported.
.. _GStreamer: http://gstreamer.freedesktop.org/
Then enable the GStreamer backend of the ``replaygain`` plugin
(see :doc:`/reference/config`) add the following to your config file::
replaygain:
backend: gstreamer
MP3Gain-based command-line tools
````````````````````````````````
In order to use this backend, you will need to install the `mp3gain`_
command-line tool or the `aacgain`_ fork thereof. To get started, install this
tool:
* On Mac OS X, you can use `Homebrew`_. Type ``brew install aacgain``.
* On Linux, `mp3gain`_ is probably in your repositories. On Debian or Ubuntu,
@ -21,11 +50,12 @@ thereof. To get started, install this tool:
.. _aacgain: http://aacgain.altosdesign.com
.. _Homebrew: http://mxcl.github.com/homebrew/
Then enable the ``replaygain`` plugin (see :doc:`/reference/config`). If beets
Then enable the MP3gain backend of the ``replaygain`` plugin (see :doc:`/reference/config`). If beets
doesn't automatically find the ``mp3gain`` or ``aacgain`` executable, you can
configure the path explicitly like so::
replaygain:
backend: command
command: /Applications/MacMP3Gain.app/Contents/Resources/aacgain
Usage & Configuration
@ -35,6 +65,9 @@ The plugin will automatically analyze albums and individual tracks as you import
them. It writes tags to each file according to the `ReplayGain`_ specification;
if your player supports these tags, it can use them to do level adjustment.
Note that some of these options are backend specific and are not currently
supported on all backends.
By default, files that already have ReplayGain tags will not be re-analyzed. If
you want to analyze *every* file on import, you can set the ``overwrite`` option
for the plugin in your :doc:`configuration file </reference/config>`, like so::