Merge pull request #54 from dconrad5/danas_changes

Add documentation for rockbox_coverart extension

Author: elelay

docs/extensions.md

@@ -21,6 +21,7 @@ The following extensions are included with gPodder 3:
 -   **Notification Bubbles for Windows** - 'Display notification bubbles for different events.
 -   [**Remove cover art from OGG files**] - removes coverart from all downloaded ogg files
 -   [**Rename episodes after download**] - Rename episodes to “<Episode Title>.<ext>” on download
+-   [**Rockbox Cover Art Sync**] - Normalize and sync channel coverart to Rockbox or other portable media players
 -   [**Search for new episodes on startup**] - Starts the search for new episodes on startup
 -   **Sonos** - Stream podcasts to Sonos speakers
 -   **Subtitle Downloader for TED Talks** - Downloads .srt subtitles for TED Talks Videos
@@ -98,6 +99,7 @@ This is OK: no need to recompile anything: just edit the **.py** and restart...
 [**Normalize audio with re-encoding**]: extensions/normalizeaudio.md
 [**Rename episodes after download**]: extensions/renameafterdownload.md
 [**Remove cover art from OGG files**]: extensions/removeoggcover.md
+[**Rockbox Cover Art Sync**]: extensions/rockbox_coverart.md
 [**Tag downloaded files using Mutagen**]: extensions/tagging.md
 [**Search for new episodes on startup**]: extensions/searchepisodeonstartup.md
 [**Video Converter**]: extensions/videoconverter.md

docs/extensions/rockbox_coverart.md

@@ -0,0 +1,35 @@
+---
+title: Rockbox Cover Art Sync
+---
+
+This extension writes podcast subscription cover art to a media player.
+This extension assumes that each podcast has its own folder on device.
+Only folder-wide coverart is written - this extension does not do anything about
+embedded cover art.
+
+Cover art is converted to the desired file format and image size
+via the python "pillow" module, and written to the desired filename.
+
+Existing files (of the correct name) will be checked to see if they
+need to be overwritten to conform to the size, baseline/progressive,
+and file format parameters.
+
+All jpegs will be written as "baseline" (rather than "progressive") type. Rockbox
+only supports baseline jpegs.
+
+## Dependencies
+
+Requires python modules `pillow` and `filelock`. These are available on pip.
+
+## Settings
+
+| setting | value | description |
+|---------|-------|-------------|
+| extensions.rockbox_coverart.art_name_on_device  | cover.jpg | Desired filename on device. Only jpg, jpeg, and png filetypes allowed. |
+| extensions.rockbox_coverart.convert_and_resize_art | **True**/False | Enable conversion and resize operations |
+| extensions.rockbox_coverart.convert_size | 500 | Cover art will be resized so that the larger of (height, width) is equal to this size. If convert_allow_upscale_art=False, art smaller than this size will retain its size. Only used if convert_and_resize_art=True. |
+| extensions.rockbox_coverart.convert_allow_upscale_art | True/**False** | Allow upscaling of art. If set to true, will allow images smaller than convert_size to be upscaled to convert_size. Only used if convert_and_resize_art=True. |
+
+Links:
+
+- [Extension Source](https://github.com/gpodder/gpodder/blob/master/share/gpodder/extensions/rockbox_coverart.py)