Skip to content

tagging.py: coverart rework documentation #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 25 additions & 15 deletions docs/extensions/tagging.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Tag downloaded files using Mutagen
---

Add episode and podcast titles to MP3/OGG tags.
Add tags to MP3/MP4/OGG files after download.

By default, this extension will:
- Remove existing tags
Expand All @@ -16,32 +16,42 @@ Also available are writing the Subtitle tag and the Comments tag (both with the
subtitle field), but the subtitle is often so long that it may cause problems with
certain audio players, such as Rockbox players. These are disabled by default.

This extension can optionally embed coverart - note that the coverart will not be
standardized in any way, so Rockbox users be wary. This is disabled by default.
This extension can optionally embed coverart - art can either be the channel artwork
or episode-specific artwork already embedded in the file. By default, the episode
artwork will be preferred if it is present - if not, the channel artwork will be used.

Note that episode-specific artwork in MP4 files is currently not implemented.

The artwork can optionally be normalized to the desired parameters - size and file type.
By default, it will write Baseline (Non-Progressive) JPEGs with the larger side scaled to 500px and the aspect ratio maintained.

This extension can optionally remove all tags instead of doing any of the above.
This is disabled by default.

## Dependencies

This extension requires python module `mutagen`.
This extension requires python modules `mutagen` and `pillow`.

| setting | value | description | version |
|----------------------------------------------|------------|-------------------------------------------------------------------------------------------|-------------------|
| extensions.tagging.strip\_album\_from\_title | **true**/false | Remove the Album tag from the Title tag if the Title begins with the same string as the Album tag | all |
| extensions.tagging.genre\_tag | Podcast | Value for the Genre tag | all |
| extensions.tagging.always\_remove\_tags | true/**false** | Remove all tags instead of creating/adding tag information | 3.5.0 and newer |
| extensions.tagging.auto\_embed\_coverart | true/**false** | Embed channel cover art in file | git master branch |
| extensions.tagging.set\_artist\_to\_album | **True**/False | Set the Artist tag to the same as the existing Album tag | git master branch |
| extensions.tagging.set\_version | 4 | Sets the id3 version which will be written | git master branch |
| extensions.tagging.modify\_tags | **True**/False | Allow tags to be modified rather than simply added. If set to False, remove\_before\_modify has no effect | git master branch |
| extensions.tagging.remove\_before\_modify | **True**/False | Delete all existing tags prior to writing new tags | git master branch |
| extensions.tagging.write\_title | **True**/False | Write the title field | git master branch |
| extensions.tagging.write\_album | **True**/False | Write the album field | git master branch |
| extensions.tagging.write\_subtitle | True/**False** | Write the subtitle field | git master branch |
| extensions.tagging.write\_comments | True/**False** | Write the comments field (with the subtitle) | git master branch |
| extensions.tagging.write\_genre | **True**/False | Write the genre with the genre\_tag setting | git master branch |
| extensions.tagging.write\_pubdate | **True**/False | Write the published date | git master branch |
| extensions.tagging.set\_artist\_to\_album | **True**/False | Set the Artist tag to the same as the existing Album tag | 3.9.3 and newer |
| extensions.tagging.set\_version | 4 | Sets the id3 version which will be written | 3.10.8 and newer |
| extensions.tagging.modify\_tags | **True**/False | Allow tags to be modified rather than simply added. If set to False, remove\_before\_modify has no effect | 3.10.8 and newer |
| extensions.tagging.remove\_before\_modify | **True**/False | Delete all existing tags prior to writing new tags | 3.11.1 and newer |
| extensions.tagging.auto\_embed\_coverart | true/**false** | Embed cover art in file | 3.9.4 and newer |
| extensions.tagging.prefer\_channel\_coverart | true/**false** | Prefer embedding the channel coverart if available over the episode coverart | newer than 3.11.5 |
| extensions.tagging.normalize\_coverart | **true**/false | Normalize the coverart to the desired size and file type before embedding it | newer than 3.11.5 |
| extensions.tagging.episode\_coverart\_size | 500 | Desired size (in pixels) of coverart. Only used if normalize\_coverart is True | newer than 3.11.5 |
| extensions.tagging.episode\_coverart\_filetype | 0 (JPEG) | Desired filetype of coverart. integer value, maps to 0=JPEG, 1=PNG. Only used if normalize\_coverart is True | newer than 3.11.5 |
| extensions.tagging.write\_title | **True**/False | Write the title field | newer than 3.11.5 |
| extensions.tagging.write\_album | **True**/False | Write the album field | newer than 3.11.5 |
| extensions.tagging.write\_subtitle | True/**False** | Write the subtitle field | newer than 3.11.5 |
| extensions.tagging.write\_comments | True/**False** | Write the comments field (with the subtitle) | newer than 3.11.5 |
| extensions.tagging.write\_genre | **True**/False | Write the genre with the genre\_tag setting | newer than 3.11.5 |
| extensions.tagging.write\_pubdate | **True**/False | Write the published date | newer than 3.11.5 |



Expand Down