From 02bccf468e554de9e7c6e217c776abd2a748db05 Mon Sep 17 00:00:00 2001 From: Dana Conrad Date: Wed, 1 Jan 2025 14:34:19 -0600 Subject: [PATCH 1/5] tagging: coverart updates --- docs/extensions/tagging.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/extensions/tagging.md b/docs/extensions/tagging.md index a4aaf6b..71f50fa 100644 --- a/docs/extensions/tagging.md +++ b/docs/extensions/tagging.md @@ -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 @@ -16,26 +16,36 @@ 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 500px x 500px baseline JPEGs. 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.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 | From 6703d26fd8e739d505706c63d20ca288c2884703 Mon Sep 17 00:00:00 2001 From: Dana Conrad Date: Sun, 16 Feb 2025 11:02:49 -0600 Subject: [PATCH 2/5] tagging.py now retains the art ratio when resizing --- docs/extensions/tagging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/extensions/tagging.md b/docs/extensions/tagging.md index 71f50fa..8a64b2d 100644 --- a/docs/extensions/tagging.md +++ b/docs/extensions/tagging.md @@ -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 x 500px baseline JPEGs. +By default, it will write 500px baseline JPEGs. This extension can optionally remove all tags instead of doing any of the above. This is disabled by default. From 6f5e63dfbe5edbe31de6f86034b374e55da206dc Mon Sep 17 00:00:00 2001 From: Dana Conrad Date: Tue, 4 Mar 2025 08:13:21 -0600 Subject: [PATCH 3/5] tagging.md: change embed_coverart to auto_embed_coverart --- docs/extensions/tagging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/extensions/tagging.md b/docs/extensions/tagging.md index 8a64b2d..76a518f 100644 --- a/docs/extensions/tagging.md +++ b/docs/extensions/tagging.md @@ -41,7 +41,7 @@ This extension requires python modules `mutagen` and `pillow`. | 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.embed\_coverart | true/**false** | Embed cover art in file | 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 | From 2ea5acd14e49b4c7de4541a03c1fc245eb2dce33 Mon Sep 17 00:00:00 2001 From: Dana Conrad Date: Fri, 18 Apr 2025 21:28:15 -0500 Subject: [PATCH 4/5] clarify jpeg operation and settings add versions --- docs/extensions/tagging.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/extensions/tagging.md b/docs/extensions/tagging.md index 76a518f..99c94cf 100644 --- a/docs/extensions/tagging.md +++ b/docs/extensions/tagging.md @@ -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. This extension can optionally remove all tags instead of doing any of the above. This is disabled by default. @@ -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 | From d1a89c75136046dbe129b9d85319da882cb9fe99 Mon Sep 17 00:00:00 2001 From: Dana Conrad Date: Sat, 19 Apr 2025 09:39:35 -0500 Subject: [PATCH 5/5] typos in tagging.md --- docs/extensions/tagging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/extensions/tagging.md b/docs/extensions/tagging.md index 99c94cf..1f2b9a3 100644 --- a/docs/extensions/tagging.md +++ b/docs/extensions/tagging.md @@ -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 baseline JPEGs with the larger side scaled to 500px with the aspect ratio maintained. +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.