mirror of
https://github.com/beetbox/beets.git
synced 2025-12-27 02:52:33 +01:00
87d71abc28
The major functional change here is how files move around when in keep_new mode. Now, files are first moved to the destination directory and then copied/transcoded back into the library. This avoids problems where naming conflicts could occur when transcoding from MP3 to MP3 (and thus not changing the filename).
71 lines
2.7 KiB
ReStructuredText
71 lines
2.7 KiB
ReStructuredText
Convert Plugin
|
|
==============
|
|
|
|
The ``convert`` plugin lets you convert parts of your collection to a directory
|
|
of your choice. It converts all input formats supported by `FFmpeg`_ to MP3.
|
|
It will skip files that are already present in the target directory. Converted
|
|
files follow the same path formats as your library.
|
|
|
|
.. _FFmpeg: http://ffmpeg.org
|
|
|
|
Installation
|
|
------------
|
|
|
|
First, enable the ``convert`` plugin (see :doc:`/plugins/index`).
|
|
|
|
To transcode music, this plugin requires the ``ffmpeg`` command-line
|
|
tool. If its executable is in your path, it will be found automatically
|
|
by the plugin. Otherwise, configure the plugin to locate the executable::
|
|
|
|
convert:
|
|
ffmpeg: /usr/bin/ffmpeg
|
|
|
|
Usage
|
|
-----
|
|
|
|
To convert a part of your collection, run ``beet convert QUERY``. This
|
|
will display all items matching ``QUERY`` and ask you for confirmation before
|
|
starting the conversion. The ``-a`` (or ``--album``) option causes the command
|
|
to match albums instead of tracks.
|
|
|
|
The ``-t`` (``--threads``) and ``-d`` (``--dest``) options allow you to specify
|
|
or overwrite the respective configuration options.
|
|
|
|
By default, the command places converted files into the destination directory
|
|
and leaves your library pristine. To instead back up your original files into
|
|
the destination directory and keep converted files in your library, use the
|
|
``-k`` (or ``--keep-new``) option.
|
|
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
The plugin offers several configuration options, all of which live under the
|
|
``convert:`` section:
|
|
|
|
* ``dest`` sets the directory the files will be converted (or copied) to.
|
|
A destination is required---you either have to provide it in the config file
|
|
or on the command line using the ``-d`` flag.
|
|
* ``embed`` indicates whether or not to embed album art in converted items.
|
|
Default: true.
|
|
* If you set ``max_bitrate``, all MP3 files with a higher bitrate will be
|
|
transcoded and those with a lower bitrate will simply be copied. Note that
|
|
this does not guarantee that all converted files will have a lower
|
|
bitrate---that depends on the encoder and its configuration. By default MP3s
|
|
will be copied without transcoding and all other formats will be converted.
|
|
* ``opts`` are the encoding options that are passed to ``ffmpeg``. Default:
|
|
"-aq 2". (Note that "-aq <num>" is equivalent to the LAME option "-V
|
|
<num>".) If you want to specify a bitrate, use "-ab <bitrate>". Refer to the
|
|
`FFmpeg`_ documentation for more details.
|
|
* Finally, ``threads`` determines the number of threads to use for parallel
|
|
encoding. By default, the plugin will detect the number of processors
|
|
available and use them all.
|
|
|
|
Here's an example configuration::
|
|
|
|
convert:
|
|
embed: false
|
|
max_bitrate: 200
|
|
opts: -aq 4
|
|
dest: /home/user/MusicForPhone
|
|
threads: 4
|