Deluan f26448fb7c feat: add Cover Art Archive plugin as an example of Python plugin
Signed-off-by: Deluan <deluan@navidrome.org>
2026-01-12 08:16:05 -05:00

129 lines
3.9 KiB
Python

# Cover Art Archive Plugin for Navidrome
#
# This plugin fetches album cover art from the Cover Art Archive (https://coverartarchive.org/)
# using the MusicBrainz album MBID.
#
# Build with:
# extism-py plugin/__init__.py -o coverartarchive-py.wasm
#
# Test with:
# extism call coverartarchive-py.wasm nd_manifest --wasi
# extism call coverartarchive-py.wasm nd_get_album_images --wasi \
# --input '{"name":"Dummy","artist":"Portishead","mbid":"76df3287-6cda-33eb-8e9a-044b5e15ffdd"}' \
# --allow-host "coverartarchive.org" --allow-host "archive.org"
import extism
import json
# Plugin manifest - identifies this plugin to Navidrome
@extism.plugin_fn
def nd_manifest():
manifest = {
"name": "Cover Art Archive (Python)",
"author": "Navidrome",
"version": "1.0.0",
"description": "Album cover art from the Cover Art Archive - Python example",
"website": "https://coverartarchive.org",
"permissions": {
"http": {
"reason": "Fetch album cover art from Cover Art Archive API",
"allowedHosts": [
"coverartarchive.org",
"*.archive.org"
]
}
}
}
extism.output_str(json.dumps(manifest))
@extism.plugin_fn
def nd_get_album_images():
"""Retrieve album cover images from Cover Art Archive."""
input_data = extism.input_json()
mbid = input_data.get("mbid", "")
if not mbid:
raise Exception("not found: MBID required")
# Query Cover Art Archive API
url = f"https://coverartarchive.org/release/{mbid}"
response = extism.Http.request(url, meth="GET")
if response.status_code != 200:
raise Exception(f"not found: CAA returned status {response.status_code}")
try:
data = json.loads(response.data_str())
except json.JSONDecodeError:
raise Exception("not found: invalid JSON response")
caa_images = data.get("images", [])
if not caa_images:
raise Exception("not found: no images in response")
# Find the front cover image
front_image = find_front_image(caa_images)
if not front_image:
raise Exception("not found: no front cover image")
# Build the response with available image sizes
images = build_image_list(front_image)
if not images:
raise Exception("not found: no usable image URLs")
extism.output_str(json.dumps({"images": images}))
def find_front_image(images):
"""Find the front cover image from CAA response."""
# First, look for an image explicitly marked as front
for img in images:
if img.get("front", False):
return img
# Second, look for an image with "Front" in types
for img in images:
types = img.get("types", [])
if "Front" in types:
return img
# Fallback to first image
if images:
return images[0]
return None
def build_image_list(img):
"""Build list of images with URLs and sizes from CAA image data."""
images = []
thumbnails = img.get("thumbnails", {})
# First, try numeric sizes (250, 500, 1200, etc.)
for size_str, url in thumbnails.items():
if not url:
continue
try:
size = int(size_str)
images.append({"url": url, "size": size})
except ValueError:
pass # Not a numeric size
# If no numeric sizes, fallback to named sizes
if not images:
size_map = {"large": 500, "small": 250}
for size_name, size in size_map.items():
url = thumbnails.get(size_name)
if url:
images.append({"url": url, "size": size})
# If still no images, use the main image URL
if not images:
main_url = img.get("image")
if main_url:
images.append({"url": main_url, "size": 0})
return images