Move common libs to libs/common

libs/common/beetsplug/embedart.py

@@ -0,0 +1,199 @@
+# -*- coding: utf-8 -*-
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+"""Allows beets to embed album art into file metadata."""
+from __future__ import division, absolute_import, print_function
+
+import os.path
+
+from beets.plugins import BeetsPlugin
+from beets import ui
+from beets.ui import print_, decargs
+from beets.util import syspath, normpath, displayable_path, bytestring_path
+from beets.util.artresizer import ArtResizer
+from beets import config
+from beets import art
+
+
+def _confirm(objs, album):
+    """Show the list of affected objects (items or albums) and confirm
+    that the user wants to modify their artwork.
+
+    `album` is a Boolean indicating whether these are albums (as opposed
+    to items).
+    """
+    noun = u'album' if album else u'file'
+    prompt = u'Modify artwork for {} {}{} (Y/n)?'.format(
+        len(objs),
+        noun,
+        u's' if len(objs) > 1 else u''
+    )
+
+    # Show all the items or albums.
+    for obj in objs:
+        print_(format(obj))
+
+    # Confirm with user.
+    return ui.input_yn(prompt)
+
+
+class EmbedCoverArtPlugin(BeetsPlugin):
+    """Allows albumart to be embedded into the actual files.
+    """
+    def __init__(self):
+        super(EmbedCoverArtPlugin, self).__init__()
+        self.config.add({
+            'maxwidth': 0,
+            'auto': True,
+            'compare_threshold': 0,
+            'ifempty': False,
+            'remove_art_file': False
+        })
+
+        if self.config['maxwidth'].get(int) and not ArtResizer.shared.local:
+            self.config['maxwidth'] = 0
+            self._log.warning(u"ImageMagick or PIL not found; "
+                              u"'maxwidth' option ignored")
+        if self.config['compare_threshold'].get(int) and not \
+                ArtResizer.shared.can_compare:
+            self.config['compare_threshold'] = 0
+            self._log.warning(u"ImageMagick 6.8.7 or higher not installed; "
+                              u"'compare_threshold' option ignored")
+
+        self.register_listener('art_set', self.process_album)
+
+    def commands(self):
+        # Embed command.
+        embed_cmd = ui.Subcommand(
+            'embedart', help=u'embed image files into file metadata'
+        )
+        embed_cmd.parser.add_option(
+            u'-f', u'--file', metavar='PATH', help=u'the image file to embed'
+        )
+        embed_cmd.parser.add_option(
+            u"-y", u"--yes", action="store_true", help=u"skip confirmation"
+        )
+        maxwidth = self.config['maxwidth'].get(int)
+        compare_threshold = self.config['compare_threshold'].get(int)
+        ifempty = self.config['ifempty'].get(bool)
+
+        def embed_func(lib, opts, args):
+            if opts.file:
+                imagepath = normpath(opts.file)
+                if not os.path.isfile(syspath(imagepath)):
+                    raise ui.UserError(u'image file {0} not found'.format(
+                        displayable_path(imagepath)
+                    ))
+
+                items = lib.items(decargs(args))
+
+                # Confirm with user.
+                if not opts.yes and not _confirm(items, not opts.file):
+                    return
+
+                for item in items:
+                    art.embed_item(self._log, item, imagepath, maxwidth, None,
+                                   compare_threshold, ifempty)
+            else:
+                albums = lib.albums(decargs(args))
+
+                # Confirm with user.
+                if not opts.yes and not _confirm(albums, not opts.file):
+                    return
+
+                for album in albums:
+                    art.embed_album(self._log, album, maxwidth, False,
+                                    compare_threshold, ifempty)
+                    self.remove_artfile(album)
+
+        embed_cmd.func = embed_func
+
+        # Extract command.
+        extract_cmd = ui.Subcommand(
+            'extractart',
+            help=u'extract an image from file metadata',
+        )
+        extract_cmd.parser.add_option(
+            u'-o', dest='outpath',
+            help=u'image output file',
+        )
+        extract_cmd.parser.add_option(
+            u'-n', dest='filename',
+            help=u'image filename to create for all matched albums',
+        )
+        extract_cmd.parser.add_option(
+            '-a', dest='associate', action='store_true',
+            help='associate the extracted images with the album',
+        )
+
+        def extract_func(lib, opts, args):
+            if opts.outpath:
+                art.extract_first(self._log, normpath(opts.outpath),
+                                  lib.items(decargs(args)))
+            else:
+                filename = bytestring_path(opts.filename or
+                                           config['art_filename'].get())
+                if os.path.dirname(filename) != b'':
+                    self._log.error(
+                        u"Only specify a name rather than a path for -n")
+                    return
+                for album in lib.albums(decargs(args)):
+                    artpath = normpath(os.path.join(album.path, filename))
+                    artpath = art.extract_first(self._log, artpath,
+                                                album.items())
+                    if artpath and opts.associate:
+                        album.set_art(artpath)
+                        album.store()
+        extract_cmd.func = extract_func
+
+        # Clear command.
+        clear_cmd = ui.Subcommand(
+            'clearart',
+            help=u'remove images from file metadata',
+        )
+        clear_cmd.parser.add_option(
+            u"-y", u"--yes", action="store_true", help=u"skip confirmation"
+        )
+
+        def clear_func(lib, opts, args):
+            items = lib.items(decargs(args))
+            # Confirm with user.
+            if not opts.yes and not _confirm(items, False):
+                return
+            art.clear(self._log, lib, decargs(args))
+        clear_cmd.func = clear_func
+
+        return [embed_cmd, extract_cmd, clear_cmd]
+
+    def process_album(self, album):
+        """Automatically embed art after art has been set
+        """
+        if self.config['auto'] and ui.should_write():
+            max_width = self.config['maxwidth'].get(int)
+            art.embed_album(self._log, album, max_width, True,
+                            self.config['compare_threshold'].get(int),
+                            self.config['ifempty'].get(bool))
+            self.remove_artfile(album)
+
+    def remove_artfile(self, album):
+        """Possibly delete the album art file for an album (if the
+        appropriate configuration option is enabled.
+        """
+        if self.config['remove_art_file'] and album.artpath:
+            if os.path.isfile(album.artpath):
+                self._log.debug(u'Removing album art file for {0}', album)
+                os.remove(album.artpath)
+                album.artpath = None
+                album.store()