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.

Sign up for GitHub

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

tagging.py: coverart rework documentation #57

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
02bccf4
tagging: coverart updates
dconrad5 Jan 1, 2025
6703d26
tagging.py now retains the art ratio when resizing
dconrad5 Feb 16, 2025
6f5e63d
tagging.md: change embed_coverart to auto_embed_coverart
dconrad5 Mar 4, 2025
fea3a27
Merge branch 'gpodder:master' into mutagen_coverart
dconrad5 Apr 19, 2025
2ea5acd
clarify jpeg operation and settings add versions
dconrad5 Apr 19, 2025
d1a89c7
typos in tagging.md
dconrad5 Apr 19, 2025
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
32 changes: 16 additions & 16 deletions docs/extensions/tagging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ artwork will be preferred if it is present - if not, the channel artwork will be
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 500px baseline JPEGs.
By default, it will baseline JPEGs with the larger side scaled to 500px with the aspect ratio maintained.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does "will baseline JPEGs" mean something, or was that meant to be "will write JPEGs"?

Copy link
Contributor Author

@dconrad5 dconrad5 Apr 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, "baseline" is the opposite of "progressive" JPEG, that being, it will be decoded all at once rather than in increasing resolution (if I recall correctly). Maybe I should say "non-progressive" to make that more clear...?

This probably doesn't matter to people opening the files on a computer, but those with old timey mp3 players often cannot open progressive album art.

Edit: I did miss a word in there as well though, I see now...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, "baseline" is the opposite of "progressive" JPEG, that being, it will be decoded all at once rather than in increasing resolution (if I recall correctly). Maybe I should say "non-progressive" to make that more clear...?

This probably doesn't matter to people opening the files on a computer, but those with old timey mp3 players often cannot open progressive album art.

Edit: I did miss a word in there as well though, I see now...

Done - please see d1a89c7


This extension can optionally remove all tags instead of doing any of the above.
This is disabled by default.
Expand All @@ -37,21 +37,21 @@ This extension requires python modules `mutagen` and `pillow`.
| 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.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.auto\_embed\_coverart | true/**false** | Embed cover art in file | git master branch |
| extensions.tagging.prefer\_channel\_coverart | true/**false** | Prefer embedding the channel coverart if available over the episode coverart | git master branch |
| extensions.tagging.normalize\_coverart | **true**/false | Normalize the coverart to the desired size and file type before embedding it | git master branch |
| extensions.tagging.episode\_coverart\_size | 500 | Desired size (in pixels) of coverart. Only used if normalize\_coverart is True | git master branch |
| 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 | 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