1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
|
# 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."""
import os.path
import tempfile
from mimetypes import guess_extension
import requests
from beets import config, ui
from beets.plugins import BeetsPlugin
from beets.ui import print_
from beets.util import bytestring_path, displayable_path, normpath, syspath
from beets.util.artresizer import ArtResizer
from beetsplug._utils 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 = "album" if album else "file"
prompt = (
"Modify artwork for"
f" {len(objs)} {noun}{'s' if len(objs) > 1 else ''} (Y/n)?"
)
# 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().__init__()
self.config.add(
{
"maxwidth": 0,
"auto": True,
"compare_threshold": 0,
"ifempty": False,
"remove_art_file": False,
"quality": 0,
}
)
if self.config["maxwidth"].get(int) and not ArtResizer.shared.local:
self.config["maxwidth"] = 0
self._log.warning(
"ImageMagick or PIL not found; 'maxwidth' option ignored"
)
if (
self.config["compare_threshold"].get(int)
and not ArtResizer.shared.can_compare
):
self.config["compare_threshold"] = 0
self._log.warning(
"ImageMagick 6.8.7 or higher not installed; "
"'compare_threshold' option ignored"
)
self.register_listener("art_set", self.process_album)
def commands(self):
# Embed command.
embed_cmd = ui.Subcommand(
"embedart", help="embed image files into file metadata"
)
embed_cmd.parser.add_option(
"-f", "--file", metavar="PATH", help="the image file to embed"
)
embed_cmd.parser.add_option(
"-y", "--yes", action="store_true", help="skip confirmation"
)
embed_cmd.parser.add_option(
"-u",
"--url",
metavar="URL",
help="the URL of the image file to embed",
)
maxwidth = self.config["maxwidth"].get(int)
quality = self.config["quality"].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(
f"image file {displayable_path(imagepath)} not found"
)
items = lib.items(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,
quality=quality,
)
elif opts.url:
try:
response = requests.get(opts.url, timeout=5)
response.raise_for_status()
except requests.exceptions.RequestException as e:
self._log.error("{}", e)
return
extension = guess_extension(response.headers["Content-Type"])
if extension is None:
self._log.error("Invalid image file")
return
file = f"image{extension}"
tempimg = os.path.join(tempfile.gettempdir(), file)
try:
with open(tempimg, "wb") as f:
f.write(response.content)
except Exception as e:
self._log.error("Unable to save image: {}", e)
return
items = lib.items(args)
# Confirm with user.
if not opts.yes and not _confirm(items, not opts.url):
os.remove(tempimg)
return
for item in items:
art.embed_item(
self._log,
item,
tempimg,
maxwidth,
None,
compare_threshold,
ifempty,
quality=quality,
)
os.remove(tempimg)
else:
albums = lib.albums(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,
quality=quality,
)
self.remove_artfile(album)
embed_cmd.func = embed_func
# Extract command.
extract_cmd = ui.Subcommand(
"extractart",
help="extract an image from file metadata",
)
extract_cmd.parser.add_option(
"-o",
dest="outpath",
help="image output file",
)
extract_cmd.parser.add_option(
"-n",
dest="filename",
help="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(args)
)
else:
filename = bytestring_path(
opts.filename or config["art_filename"].get()
)
if os.path.dirname(filename) != b"":
self._log.error(
"Only specify a name rather than a path for -n"
)
return
for album in lib.albums(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="remove images from file metadata",
)
clear_cmd.parser.add_option(
"-y", "--yes", action="store_true", help="skip confirmation"
)
def clear_func(lib, opts, args):
items = lib.items(args)
# Confirm with user.
if not opts.yes and not _confirm(items, False):
return
art.clear(self._log, lib, 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(syspath(album.artpath)):
self._log.debug("Removing album art file for {}", album)
os.remove(syspath(album.artpath))
album.artpath = None
album.store()
|