Skip to content

Commit 3398eae

Browse files
elelayelelay
authored
Merge pull request #57 from dconrad5/mutagen_coverart
tagging.py: coverart rework documentation
2 parents 3b6ea8d + d24ab45 commit 3398eae

File tree

1 file changed

+27
-17
lines changed

1 file changed

+27
-17
lines changed

‎docs/extensions/tagging.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Tag downloaded files using Mutagen
33
---
44

5-
Add episode and podcast titles to MP3/OGG tags.
5+
Add tags to MP3/MP4/OGG files after download.
66

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

19-
This extension can optionally embed coverart - note that the coverart will not be
20-
standardized in any way, so Rockbox users be wary. This is disabled by default.
19+
This extension can optionally embed coverart - art can either be the channel artwork
20+
or episode-specific artwork already embedded in the file. By default, the episode
21+
artwork will be preferred if it is present - if not, the channel artwork will be used.
22+
23+
Note that episode-specific artwork in MP4 files is currently not implemented.
24+
25+
The artwork can optionally be normalized to the desired size and file type.
26+
By default, it will write Baseline (Non-Progressive) JPEGs with the larger side scaled to 500px and the aspect ratio maintained.
2127

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

2531
## Dependencies
2632

27-
This extension requires python module `mutagen`.
33+
This extension requires python modules `mutagen` and `pillow`.
2834

2935
| setting | value | description | version |
3036
|----------------------------------------------|------------|-------------------------------------------------------------------------------------------|-------------------|
31-
| 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 |
37+
| 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 |
3238
| extensions.tagging.genre\_tag | Podcast | Value for the Genre tag | all |
33-
| extensions.tagging.always\_remove\_tags | true/**false** | Remove all tags instead of creating/adding tag information | 3.5.0 and newer |
34-
| extensions.tagging.auto\_embed\_coverart | true/**false** | Embed channel cover art in file | git master branch |
35-
| extensions.tagging.set\_artist\_to\_album | **True**/False | Set the Artist tag to the same as the existing Album tag | git master branch |
36-
| extensions.tagging.set\_version | 4 | Sets the id3 version which will be written | git master branch |
37-
| 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 |
38-
| extensions.tagging.remove\_before\_modify | **True**/False | Delete all existing tags prior to writing new tags | git master branch |
39-
| extensions.tagging.write\_title | **True**/False | Write the title field | git master branch |
40-
| extensions.tagging.write\_album | **True**/False | Write the album field | git master branch |
41-
| extensions.tagging.write\_subtitle | True/**False** | Write the subtitle field | git master branch |
42-
| extensions.tagging.write\_comments | True/**False** | Write the comments field (with the subtitle) | git master branch |
43-
| extensions.tagging.write\_genre | **True**/False | Write the genre with the genre\_tag setting | git master branch |
44-
| extensions.tagging.write\_pubdate | **True**/False | Write the published date | git master branch |
39+
| extensions.tagging.always\_remove\_tags | True/**False** | Remove all tags instead of creating/adding tag information | 3.5.0 and newer |
40+
| 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 |
41+
| extensions.tagging.set\_version | 4 | Sets the id3 version which will be written | 3.10.8 and newer |
42+
| 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 |
43+
| extensions.tagging.remove\_before\_modify | **True**/False | Delete all existing tags prior to writing new tags | 3.11.1 and newer |
44+
| extensions.tagging.auto\_embed\_coverart | True/**False** | Embed cover art in file | 3.9.4 and newer |
45+
| extensions.tagging.prefer\_channel\_coverart | True/**False** | Prefer embedding the channel coverart if available over the episode coverart | newer than 3.11.5 |
46+
| extensions.tagging.normalize\_coverart | **True**/False | Normalize the coverart to the desired size and file type before embedding it | newer than 3.11.5 |
47+
| extensions.tagging.episode\_coverart\_size | 500 | Desired size (in pixels) of coverart. Only used if normalize\_coverart is True | newer than 3.11.5 |
48+
| 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 |
49+
| extensions.tagging.write\_title | **True**/False | Write the title field | newer than 3.11.5 |
50+
| extensions.tagging.write\_album | **True**/False | Write the album field | newer than 3.11.5 |
51+
| extensions.tagging.write\_subtitle | True/**False** | Write the subtitle field | newer than 3.11.5 |
52+
| extensions.tagging.write\_comments | True/**False** | Write the comments field (with the subtitle) | newer than 3.11.5 |
53+
| extensions.tagging.write\_genre | **True**/False | Write the genre with the genre\_tag setting | newer than 3.11.5 |
54+
| extensions.tagging.write\_pubdate | **True**/False | Write the published date | newer than 3.11.5 |
4555

4656

4757

0 commit comments

Comments
 (0)