diff --git a/docs/changelog.rst b/docs/changelog.rst index a15ca69d6..cd084a282 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -26,6 +26,8 @@ New features: - :doc:`plugins/mbpseudo`: Add a new `mbpseudo` plugin to proactively receive MusicBrainz pseudo-releases as recommendations during import. - Added support for Python 3.13. +- :doc:`/plugins/convert`: ``force`` can be passed to override checks like + no_convert, never_convert_lossy_files, same format, and max_bitrate Bug fixes: @@ -47,11 +49,6 @@ Bug fixes: endpoints. Previously, due to single-quotes (ie. string literal) in the SQL query, the query eg. `GET /item/values/albumartist` would return the literal "albumartist" instead of a list of unique album artists. - :doc:`/plugins/convert`: beet convert ignored an explicit --format option when - never_convert_lossy_files was enabled. Now, --force wil override this config - setting. Lossy files selected by a query and given a target format on the CLI - are now transcoded when given the --force flag instead of being copied - unchanged. :bug:`5625` For plugin developers: diff --git a/docs/plugins/convert.rst b/docs/plugins/convert.rst index abf31529d..14b545b28 100644 --- a/docs/plugins/convert.rst +++ b/docs/plugins/convert.rst @@ -52,9 +52,9 @@ embedding is disabled for files that are linked. Refer to the ``link`` and ``hardlink`` options below. The ``-F`` (or ``--force``) option forces transcoding even when safety options -such as ``no_convert`` or ``never_convert_lossy_files`` would normally cause a -file to be copied or skipped instead. This can be combined with ``--format`` to -explicitly transcode lossy inputs to a chosen target format. +such as ``no_convert``, ``never_convert_lossy_files``, or ``max_bitrate`` would +normally cause a file to be copied or skipped instead. This can be combined with +``--format`` to explicitly transcode lossy inputs to a chosen target format. The ``-m`` (or ``--playlist``) option enables the plugin to create an m3u8 playlist file in the destination folder given by the ``-d`` (``--dest``) option @@ -109,11 +109,13 @@ The available options are: with high bitrates, even if they are already in the same format as the output. Note that this does not guarantee that all converted files will have a lower bitrate---that depends on the encoder and its configuration. Default: none. + This option will be overridden by the ``--force`` flag - **no_convert**: Does not transcode items matching the query string provided (see :doc:`/reference/query`). For example, to not convert AAC or WMA formats, you can use ``format:AAC, format:WMA`` or ``path::\.(m4a|wma)$``. If you only want to transcode WMA format, you can use a negative query, e.g., - ``^path::\.(wma)$``, to not convert any other format except WMA. + ``^path::\.(wma)$``, to not convert any other format except WMA. This option + will be overridden by the ``--force`` flag - **never_convert_lossy_files**: Cross-conversions between lossy codecs---such as mp3, ogg vorbis, etc.---makes little sense as they will decrease quality even further. If set to ``yes``, lossy files are always copied. Default: