Skip to main content

Mopidy local library proxy extension for handling embedded album art

Project description

Mopidy-Local-Images is a Mopidy local library extension that allows Web clients access to album art embedded in local media files. It does so by acting as a proxy between Mopidy’s local scan command and the actual local library provider being used. Images are extracted from media files and stored separately while scanning, and corresponding image URIs are inserted into Mopidy data models, so clients can access these images through Mopidy’s integrated Web server. Other requests are delegated to the actual local library provider as-is.

Album art stored in separate files is also supported. External image files will be considered if they reside in the same directory as the scanned media files, and file names match a configurable pattern.

Please note, however, that support for local album art depends on whether your client supports album image URIs as provided by Mopidy’s data model. For example, some clients still ignore any images provided by this extension, and will try to retrieve matching album art from external services instead.

Installation

Mopidy-Local-Images can be installed using pip by running:

pip install Mopidy-Local-Images

Configuration

Before starting Mopidy, you must change your configuration to switch to using Mopidy-Local-Images as your local library provider:

[local]
library = images

By default, Mopidy-Local-Images delegates any requests to the standard json local library provider. To use a third-party library, such as Mopidy-Local-SQLite, you have to set this in the local-images configuration section:

[local-images]
library = sqlite

Once this has been set, you need to clear and re-scan your library for images to be extracted:

mopidy local clear
mopidy local scan

This extension also provides some other configuration settings, but beware that these are subject to change for now:

[local-images]
enabled = true

# the actual local library provider to use
library = json

# base URI for images; change this if you want to serve images using
# an alternative Web server
base_uri = /images/

# directory where local image files are stored; if not set, defaults
# to a subdirectory of `local/data_dir`
image_dir =

# list of file names to check for when searching for external album
# art; may contain UNIX shell patterns, i.e. "*", "?", etc.
album_art_files = *.jpg, *.jpeg, *.png

Project Resources

Latest PyPI version Number of PyPI downloads Travis CI build status Test coverage

License

Copyright (c) 2014 Thomas Kemmer.

Licensed under the Apache License, Version 2.0.

Known Bugs and Limitations

Using this extension will slow down mopidy local scan considerably, since every media file added has to be scanned twice. This is a limitation of the Mopidy local library provider interface.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Mopidy-Local-Images-0.1.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

Mopidy_Local_Images-0.1.0-py2-none-any.whl (10.1 kB view details)

Uploaded Python 2

File details

Details for the file Mopidy-Local-Images-0.1.0.tar.gz.

File metadata

File hashes

Hashes for Mopidy-Local-Images-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8e61ba147991d33c3a827247e92412001d216ab51c73ac6d896b79bf6a5ea6d0
MD5 6a022e3240888c5283cbbe6c3c6030de
BLAKE2b-256 2dc12c16cbd5a078a2fdd268a80aae88e8a54fb7e2b3e3b7839203f94ca4edfc

See more details on using hashes here.

File details

Details for the file Mopidy_Local_Images-0.1.0-py2-none-any.whl.

File metadata

File hashes

Hashes for Mopidy_Local_Images-0.1.0-py2-none-any.whl
Algorithm Hash digest
SHA256 e73eb578024ed751e2dc988617c1a4c4bf69ca29b9ac0278a9996b841c84f2e7
MD5 790be23973452df614c7f126008bd5cc
BLAKE2b-256 09022d323611e6167ac7f1bc8083cdf03f4077de63d725fbd55bd727f1c1f8bc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page