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

embedart: docs. explain 'compare_threshold' option

Browse source
This commit is contained in:
Fabrice Laporte 2014-09-17 22:07:35 +02:00
parent 3ec8902ea4
commit 187497c8c6
1 changed files with 31 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
docs/plugins/embedart.rst
View file

@ -19,6 +19,27 @@ embedded after each album is added to the library.
This behavior can be disabled with the ``auto`` config option (see below).
.. _image-similarity-check:
Checking image similarity before embedding
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
When importing a lot of files with the ``auto`` option, one may be reluctant to
overwrite existing embedded art for all of them.
It's possible to tell beets to embed fetched art only if it corresponds to a
similar image than already embedded art. This works by computing the perceptual
hashes (`PHASH`_) of the two images and checking that the difference between
the two does not exceed a given threshold.
The threshold used is given by the ``compare_threshold`` option:
* use '0' to always embed image (disable similarity check)
* use any positive integer to define a similarity threshold. The smaller the
value, the more similar the images must be. A value in the range [10,100] is
recommended.
Requires `ImageMagick`_
Manually Embedding and Extracting Art
-------------------------------------
@ -51,9 +72,17 @@ To do so, add this to your ``config.yaml``::
A maximum image width can be configured as ``maxwidth`` to downscale images
before embedding them (the original image file is not altered). The resize
operation reduces image width to ``maxwidth`` pixels. The height is recomputed
so that the aspect ratio is preserved. `PIL`_ or `ImageMagick`_ is required to
use the ``maxwidth`` config option. See also :ref:`image-resizing` for further
so that the aspect ratio is preserved.
Requires `ImageMagick`_ or `PIL`_, see :ref:`image-resizing` for further
caveats about image resizing.
The ``compare_threshold`` option defines how similar must candidate art be
regarding to embedded art to be written to the file, see
:ref:`image-similarity-check` for more infos.
By default the option is set to '0' (candidate art is always written to file).
Requires `ImageMagick`_
.. _PIL: http://www.pythonware.com/products/pil/
.. _ImageMagick: http://www.imagemagick.org/
.. _PHASH: http://www.fmwconcepts.com/misc_tests/perceptual_hash_test_results_510/