mirror of
https://github.com/clinton-hall/nzbToMedia.git
synced 2025-08-14 02:26:53 -07:00
Move common libs to libs/common
This commit is contained in:
Labrys of Knossos
parent
8dbb1a2451
commit
1f4bd41bcc
1612 changed files with 962 additions and 10 deletions
294
libs/common/beetsplug/thumbnails.py
Normal file
294
libs/common/beetsplug/thumbnails.py
Normal file
|
|
@ -0,0 +1,294 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
# This file is part of beets.
|
||||
# Copyright 2016, Bruno Cauet
|
||||
#
|
||||
# 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.
|
||||
|
||||
"""Create freedesktop.org-compliant thumbnails for album folders
|
||||
|
||||
This plugin is POSIX-only.
|
||||
Spec: standards.freedesktop.org/thumbnail-spec/latest/index.html
|
||||
"""
|
||||
|
||||
from __future__ import division, absolute_import, print_function
|
||||
|
||||
from hashlib import md5
|
||||
import os
|
||||
import shutil
|
||||
from itertools import chain
|
||||
from pathlib import PurePosixPath
|
||||
import ctypes
|
||||
import ctypes.util
|
||||
|
||||
from xdg import BaseDirectory
|
||||
|
||||
from beets.plugins import BeetsPlugin
|
||||
from beets.ui import Subcommand, decargs
|
||||
from beets import util
|
||||
from beets.util.artresizer import ArtResizer, get_im_version, get_pil_version
|
||||
import six
|
||||
|
||||
|
||||
BASE_DIR = os.path.join(BaseDirectory.xdg_cache_home, "thumbnails")
|
||||
NORMAL_DIR = util.bytestring_path(os.path.join(BASE_DIR, "normal"))
|
||||
LARGE_DIR = util.bytestring_path(os.path.join(BASE_DIR, "large"))
|
||||
|
||||
|
||||
class ThumbnailsPlugin(BeetsPlugin):
|
||||
def __init__(self):
|
||||
super(ThumbnailsPlugin, self).__init__()
|
||||
self.config.add({
|
||||
'auto': True,
|
||||
'force': False,
|
||||
'dolphin': False,
|
||||
})
|
||||
|
||||
self.write_metadata = None
|
||||
if self.config['auto'] and self._check_local_ok():
|
||||
self.register_listener('art_set', self.process_album)
|
||||
|
||||
def commands(self):
|
||||
thumbnails_command = Subcommand("thumbnails",
|
||||
help=u"Create album thumbnails")
|
||||
thumbnails_command.parser.add_option(
|
||||
u'-f', u'--force',
|
||||
dest='force', action='store_true', default=False,
|
||||
help=u'force regeneration of thumbnails deemed fine (existing & '
|
||||
u'recent enough)')
|
||||
thumbnails_command.parser.add_option(
|
||||
u'--dolphin', dest='dolphin', action='store_true', default=False,
|
||||
help=u"create Dolphin-compatible thumbnail information (for KDE)")
|
||||
thumbnails_command.func = self.process_query
|
||||
|
||||
return [thumbnails_command]
|
||||
|
||||
def process_query(self, lib, opts, args):
|
||||
self.config.set_args(opts)
|
||||
if self._check_local_ok():
|
||||
for album in lib.albums(decargs(args)):
|
||||
self.process_album(album)
|
||||
|
||||
def _check_local_ok(self):
|
||||
"""Check that's everythings ready:
|
||||
- local capability to resize images
|
||||
- thumbnail dirs exist (create them if needed)
|
||||
- detect whether we'll use PIL or IM
|
||||
- detect whether we'll use GIO or Python to get URIs
|
||||
"""
|
||||
if not ArtResizer.shared.local:
|
||||
self._log.warning(u"No local image resizing capabilities, "
|
||||
u"cannot generate thumbnails")
|
||||
return False
|
||||
|
||||
for dir in (NORMAL_DIR, LARGE_DIR):
|
||||
if not os.path.exists(dir):
|
||||
os.makedirs(dir)
|
||||
|
||||
if get_im_version():
|
||||
self.write_metadata = write_metadata_im
|
||||
tool = "IM"
|
||||
else:
|
||||
assert get_pil_version() # since we're local
|
||||
self.write_metadata = write_metadata_pil
|
||||
tool = "PIL"
|
||||
self._log.debug(u"using {0} to write metadata", tool)
|
||||
|
||||
uri_getter = GioURI()
|
||||
if not uri_getter.available:
|
||||
uri_getter = PathlibURI()
|
||||
self._log.debug(u"using {0.name} to compute URIs", uri_getter)
|
||||
self.get_uri = uri_getter.uri
|
||||
|
||||
return True
|
||||
|
||||
def process_album(self, album):
|
||||
"""Produce thumbnails for the album folder.
|
||||
"""
|
||||
self._log.debug(u'generating thumbnail for {0}', album)
|
||||
if not album.artpath:
|
||||
self._log.info(u'album {0} has no art', album)
|
||||
return
|
||||
|
||||
if self.config['dolphin']:
|
||||
self.make_dolphin_cover_thumbnail(album)
|
||||
|
||||
size = ArtResizer.shared.get_size(album.artpath)
|
||||
if not size:
|
||||
self._log.warning(u'problem getting the picture size for {0}',
|
||||
album.artpath)
|
||||
return
|
||||
|
||||
wrote = True
|
||||
if max(size) >= 256:
|
||||
wrote &= self.make_cover_thumbnail(album, 256, LARGE_DIR)
|
||||
wrote &= self.make_cover_thumbnail(album, 128, NORMAL_DIR)
|
||||
|
||||
if wrote:
|
||||
self._log.info(u'wrote thumbnail for {0}', album)
|
||||
else:
|
||||
self._log.info(u'nothing to do for {0}', album)
|
||||
|
||||
def make_cover_thumbnail(self, album, size, target_dir):
|
||||
"""Make a thumbnail of given size for `album` and put it in
|
||||
`target_dir`.
|
||||
"""
|
||||
target = os.path.join(target_dir, self.thumbnail_file_name(album.path))
|
||||
|
||||
if os.path.exists(target) and \
|
||||
os.stat(target).st_mtime > os.stat(album.artpath).st_mtime:
|
||||
if self.config['force']:
|
||||
self._log.debug(u"found a suitable {1}x{1} thumbnail for {0}, "
|
||||
u"forcing regeneration", album, size)
|
||||
else:
|
||||
self._log.debug(u"{1}x{1} thumbnail for {0} exists and is "
|
||||
u"recent enough", album, size)
|
||||
return False
|
||||
resized = ArtResizer.shared.resize(size, album.artpath,
|
||||
util.syspath(target))
|
||||
self.add_tags(album, util.syspath(resized))
|
||||
shutil.move(resized, target)
|
||||
return True
|
||||
|
||||
def thumbnail_file_name(self, path):
|
||||
"""Compute the thumbnail file name
|
||||
See http://standards.freedesktop.org/thumbnail-spec/latest/x227.html
|
||||
"""
|
||||
uri = self.get_uri(path)
|
||||
hash = md5(uri.encode('utf-8')).hexdigest()
|
||||
return util.bytestring_path("{0}.png".format(hash))
|
||||
|
||||
def add_tags(self, album, image_path):
|
||||
"""Write required metadata to the thumbnail
|
||||
See http://standards.freedesktop.org/thumbnail-spec/latest/x142.html
|
||||
"""
|
||||
mtime = os.stat(album.artpath).st_mtime
|
||||
metadata = {"Thumb::URI": self.get_uri(album.artpath),
|
||||
"Thumb::MTime": six.text_type(mtime)}
|
||||
try:
|
||||
self.write_metadata(image_path, metadata)
|
||||
except Exception:
|
||||
self._log.exception(u"could not write metadata to {0}",
|
||||
util.displayable_path(image_path))
|
||||
|
||||
def make_dolphin_cover_thumbnail(self, album):
|
||||
outfilename = os.path.join(album.path, b".directory")
|
||||
if os.path.exists(outfilename):
|
||||
return
|
||||
artfile = os.path.split(album.artpath)[1]
|
||||
with open(outfilename, 'w') as f:
|
||||
f.write('[Desktop Entry]\n')
|
||||
f.write('Icon=./{0}'.format(artfile.decode('utf-8')))
|
||||
f.close()
|
||||
self._log.debug(u"Wrote file {0}", util.displayable_path(outfilename))
|
||||
|
||||
|
||||
def write_metadata_im(file, metadata):
|
||||
"""Enrich the file metadata with `metadata` dict thanks to IM."""
|
||||
command = ['convert', file] + \
|
||||
list(chain.from_iterable(('-set', k, v)
|
||||
for k, v in metadata.items())) + [file]
|
||||
util.command_output(command)
|
||||
return True
|
||||
|
||||
|
||||
def write_metadata_pil(file, metadata):
|
||||
"""Enrich the file metadata with `metadata` dict thanks to PIL."""
|
||||
from PIL import Image, PngImagePlugin
|
||||
im = Image.open(file)
|
||||
meta = PngImagePlugin.PngInfo()
|
||||
for k, v in metadata.items():
|
||||
meta.add_text(k, v, 0)
|
||||
im.save(file, "PNG", pnginfo=meta)
|
||||
return True
|
||||
|
||||
|
||||
class URIGetter(object):
|
||||
available = False
|
||||
name = "Abstract base"
|
||||
|
||||
def uri(self, path):
|
||||
raise NotImplementedError()
|
||||
|
||||
|
||||
class PathlibURI(URIGetter):
|
||||
available = True
|
||||
name = "Python Pathlib"
|
||||
|
||||
def uri(self, path):
|
||||
return PurePosixPath(path).as_uri()
|
||||
|
||||
|
||||
def copy_c_string(c_string):
|
||||
"""Copy a `ctypes.POINTER(ctypes.c_char)` value into a new Python
|
||||
string and return it. The old memory is then safe to free.
|
||||
"""
|
||||
# This is a pretty dumb way to get a string copy, but it seems to
|
||||
# work. A more surefire way would be to allocate a ctypes buffer and copy
|
||||
# the data with `memcpy` or somesuch.
|
||||
s = ctypes.cast(c_string, ctypes.c_char_p).value
|
||||
return b'' + s
|
||||
|
||||
|
||||
class GioURI(URIGetter):
|
||||
"""Use gio URI function g_file_get_uri. Paths must be utf-8 encoded.
|
||||
"""
|
||||
name = "GIO"
|
||||
|
||||
def __init__(self):
|
||||
self.libgio = self.get_library()
|
||||
self.available = bool(self.libgio)
|
||||
if self.available:
|
||||
self.libgio.g_type_init() # for glib < 2.36
|
||||
|
||||
self.libgio.g_file_get_uri.argtypes = [ctypes.c_char_p]
|
||||
self.libgio.g_file_new_for_path.restype = ctypes.c_void_p
|
||||
|
||||
self.libgio.g_file_get_uri.argtypes = [ctypes.c_void_p]
|
||||
self.libgio.g_file_get_uri.restype = ctypes.POINTER(ctypes.c_char)
|
||||
|
||||
self.libgio.g_object_unref.argtypes = [ctypes.c_void_p]
|
||||
|
||||
def get_library(self):
|
||||
lib_name = ctypes.util.find_library("gio-2")
|
||||
try:
|
||||
if not lib_name:
|
||||
return False
|
||||
return ctypes.cdll.LoadLibrary(lib_name)
|
||||
except OSError:
|
||||
return False
|
||||
|
||||
def uri(self, path):
|
||||
g_file_ptr = self.libgio.g_file_new_for_path(path)
|
||||
if not g_file_ptr:
|
||||
raise RuntimeError(u"No gfile pointer received for {0}".format(
|
||||
util.displayable_path(path)))
|
||||
|
||||
try:
|
||||
uri_ptr = self.libgio.g_file_get_uri(g_file_ptr)
|
||||
finally:
|
||||
self.libgio.g_object_unref(g_file_ptr)
|
||||
if not uri_ptr:
|
||||
self.libgio.g_free(uri_ptr)
|
||||
raise RuntimeError(u"No URI received from the gfile pointer for "
|
||||
u"{0}".format(util.displayable_path(path)))
|
||||
|
||||
try:
|
||||
uri = copy_c_string(uri_ptr)
|
||||
finally:
|
||||
self.libgio.g_free(uri_ptr)
|
||||
|
||||
try:
|
||||
return uri.decode(util._fsencoding())
|
||||
except UnicodeDecodeError:
|
||||
raise RuntimeError(
|
||||
"Could not decode filename from GIO: {!r}".format(uri)
|
||||
)
|
||||
Loading…
Add table
Add a link
Reference in a new issue