Music artwork: Difference between revisions
(→Experimental music artwork: "extrafanart" folder hack doesn't work in the music library) |
(Overhaul) |
||
Line 1: | Line 1: | ||
{{ | {{Artwork_Contents}} | ||
{{mininav|[[:Category:Music_library|Music Library Index]] |[[Artwork]]}} | {{mininav|[[:Category:Music_library|Music Library Index]] |[[Artwork]]}} | ||
<section begin="intro" />Music artwork are images directly related to an artist or an album, preferably of high quality, that are displayed when viewing the album or artist entry in the library. They may also be used as visualizations while playing music. The artwork support in {{Kodi}}'s music library is very flexible and able to display many types of artwork, | <section begin="intro" />Music artwork are images directly related to an artist or an album, preferably of high quality, that are displayed when viewing the album or artist entry in the library. They may also be used as visualizations while playing music. The artwork support in {{Kodi}}'s music library is very flexible and able to display many types of artwork, depending on the skin in use.<section end="intro" /> | ||
{{red|'''It is important to note the following:'''}} | {{red|'''It is important to note the following:'''}} | ||
* To ensure '''local artwork''' is added when scanning new media items, the image files must be arranged in a certain folder hierarchy. | |||
** For Albums see '''''[[Music tagging#Folder_and_File_Structure| Music folder and file structure]]''''' for a basic option | |||
*To ensure '''local artwork''' is added when scanning new media items, the image files must be arranged in a certain folder hierarchy. | ** For Artists see '''''[[Artist information folder]]''''' which is new for v18 and separates Artists from music files and overcomes the inherent limitations of that previous method. | ||
* Each artwork type must be '''[[Advancedsettings.xml#Music library extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping. | * Each artwork type must be '''[[Advancedsettings.xml#Music library extra artwork| whitelisted in advancedsettings.xml]]''' to be added to the library automatically during scanning and scraping. | ||
* Kodi 18 is required for expanded artwork type support in the music library. | * Kodi 18 is required for expanded artwork type support in the music library. | ||
= Artist Information Folder = | |||
:{{main|Artist information folder}} | |||
{{#lst:Artist_information_folder|intro}} | |||
= | = Fetching Additional Artwork = | ||
v18 introduces an '''experimental''' feature that will auto-load extended artwork without the use of additional add-ons. It is considered an advanced feature. Usage and practicality of this feature are being monitored and may change in later releases. | |||
In the Music library, artwork is described as follows: | |||
== Artist "banner" == | {| class="prettytable" | ||
! colspan="8" style="text-align:left; background-color:#72d2f7;" | Artist Artwork | |||
|- | |||
! colspan="2" style="text-align:left;" | Basic Artwork | |||
! colspan="1" style="text-align:left;" | | |||
! colspan="5" style="text-align:left;" | Extended Artwork | |||
|- | |||
|style="width:80px; text-align:left;"|fanart | |||
|style="width:80px; text-align:left;"|folder | |||
! colspan="1" style="text-align:left;" | | |||
|style="width:80px; text-align:left;"|banner | |||
|style="width:80px; text-align:left;"|clearart | |||
|style="width:80px; text-align:left;"|clearlogo | |||
|style="width:100px; text-align:left;"|fanart''xx'' (extrafanart) | |||
|style="width:80px; text-align:left;"|landscape | |||
|- | |||
! colspan="12" style="text-align:left; background-color:#72d2f7;" | Album Artwork | |||
|- | |||
! colspan="2" style="text-align:left;" | Basic Artwork | |||
! colspan="1" style="text-align:left;" | | |||
! colspan="8" style="text-align:left;" | Extended Artwork | |||
|- | |||
|style="width:80px; text-align:left;"|folder | |||
|style="width:80px; text-align:left;"| | |||
! colspan="1" style="text-align:left;" | | |||
|style="width:80px; text-align:left;"|back | |||
|style="width:80px; text-align:left;"|discart | |||
|style="width:80px; text-align:left;"|spine | |||
|- | |||
|} | |||
'''Basic''' artwork requires no special setup as it has always been natively fetched by {{kodi}} | |||
= | '''Extended''' artwork required the use of additional add-ons in previous versions. cdART (now defunct) was used. More recently '''''[https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]''''' is used. | ||
Users now have the '''option''' of allowing {{kodi}} to load all artwork without add-ons. To use this feature... | |||
:'''1.''' Add the below code to the '''[[Advancedsettings.xml| advancedsettings.xml]]''' file, ensuring you do not duplicate any tags if they already exist... eg ''<advancedsettings></advancedsettings>, <musiclibrary></musiclibrary>'' | |||
Artist | :'''2.''' Install the '''[[Add-on:Universal_Artist_Scraper|Universal Artist Scraper]]''' and '''[[Add-on:Universal_Album_Scraper|Universal Album Scraper]]''' and ensure the settings to download extra art are enabled. | ||
:'''3.''' Scan as normal | |||
:'''Note:''' The code box adds common extended artwork that most skins will utilise. It is your choice which extended artwork you add. If you add additional to that shown, ensure the skin has support to display it. | |||
<syntaxhighlight lang="xml" line='line'> | |||
<advancedsettings> | |||
<musiclibrary> | |||
<artistextraart> | |||
<arttype>banner</arttype> | |||
<arttype>clearart</arttype> | |||
<arttype>clearlogo</arttype> | |||
<arttype>fanart1</arttype> <!-- Multiple fanart --> | |||
<arttype>fanart2</arttype> <!-- Add as many as required. --> | |||
<arttype>fanart3</arttype> <!-- See 9.1 Multiple Fanart section below --> | |||
<arttype>landscape</arttype> | |||
</artistextraart> | |||
<albumextraart> | |||
<arttype>back</arttype> | |||
<arttype>discart</arttype> | |||
<arttype>spine</arttype> | |||
</albumextraart> | |||
</musiclibrary> | |||
</advancedsettings> | |||
</syntaxhighlight> | |||
== | <gallery mode="packed-overlay" widths="500px" heights="283px"> | ||
File:UniversalArtistScraper03.jpg|Artist Scraper- Enable Extra Artwork | |||
File:UniversalAlbumScraper02.jpg|Album Scraper- Enable Extra Artwork | |||
</gallery> | |||
Local artist artwork can be saved in the '''[[Artist information folder]]''' or a '''[[Music tagging#Folder and File Structure| common artist folder among your music files]]''' if Kodi can find one | = Local Artwork = | ||
Local artist artwork can be saved in the '''[[Artist information folder]]''' (shown in image) or a '''[[Music tagging#Folder and File Structure| common artist folder among your music files]]''' if Kodi can find one. | |||
Local album artwork can be saved in the '''[[Music tagging#Folder and File Structure| album folder]]''' (shown in image). | |||
The general rule for artist and album artwork file naming is '''''<arttype>.<ext>'''''. | |||
<gallery mode="packed" widths=" | <gallery mode="packed" widths="1000px" heights="562px"> | ||
File: | File:LocalMusicArtwork01.jpg | ||
</gallery> | </gallery> | ||
= Embedded Artwork = | = Embedded Artwork = | ||
Line 271: | Line 115: | ||
A list of embedded tags recognised by Kodi is available | A list of embedded tags recognised by Kodi is available | ||
; '''''see also: [[Music_tagging#Tags_Kodi_reads|Tags Kodi Reads]] | ; '''''see also: [[Music_tagging#Tags_Kodi_reads|Tags Kodi Reads]]''''' | ||
= Library artwork source priority = | = Library artwork source priority = | ||
# Local artwork files | # Local artwork files | ||
#* Local artwork files next to your media items or in the "[[Artist information folder]]". These are expected to be mid-high quality level for display in an interface like Kodi. | #* Local artwork files next to your media items or in the "[[Artist information folder]]". These are expected to be mid-high quality level for display in an interface like Kodi. | ||
Line 282: | Line 127: | ||
#* Only supports the album front cover | #* Only supports the album front cover | ||
# Online source from "information provider"/scraper | # Online source from "information provider"/scraper | ||
#* only if the option in Kodi | #* only if the option in Kodi ''Settings -> Media -> Music -> "Fetch additional information during updates"'' is enabled | ||
#* will only be set if there is no local or embedded artwork unless the option in Kodi | #* will only be set if there is no local or embedded artwork unless the option in Kodi ''Settings -> Media -> Music -> "Prefer online information"'' is enabled | ||
#* all types of artwork can be added from information providers | #* all types of artwork can be added from information providers | ||
= File Mode = | = File Mode = | ||
File Mode is similar to using the file manager provided by your operating system- eg Explorer in Windows systems. It is simply a file browser that allows you to view and play your media even though it has not been scanned and/or scraped into the Library. This mode does not provide the added benefits of Extended Artwork and Album/Artist metadata that the properly scanned and scraped library provides. As a result, Music Artwork is handled differently using this mode as follows: | File Mode is similar to using the file manager provided by your operating system- eg Explorer in Windows systems. It is simply a file browser that allows you to view and play your media even though it has not been scanned and/or scraped into the Library. This mode does not provide the added benefits of Extended Artwork and Album/Artist metadata that the properly scanned and scraped library provides. As a result, Music Artwork is handled differently using this mode as follows: | ||
*The only artwork displayed in File Mode is artist thumb and album thumb. | *The only artwork displayed in File Mode is artist folder/thumb and album folder/thumb. | ||
*You must have local artwork named and saved as detailed in the sections above. | *You must have local artwork named and saved as detailed in the sections above. | ||
*These images are not loaded automatically. The Artist or Album must be viewed once to allow Kodi to locate and cache the image. | *These images are not loaded automatically. The Artist or Album must be viewed once to allow Kodi to locate and cache the image. | ||
*When '''Enable tag reading''' is '''''Enabled''''' the song must be viewed to allow Kodi to scan for embedded images if no local image is available. | *When '''Enable tag reading''' is '''''Enabled''''' the song must be viewed to allow Kodi to scan for embedded images if no local image is available. | ||
Kodi looks for and caches artwork in the following order: | |||
Kodi looks for, and caches, artwork in the following order: | |||
*'''For Artist artwork:''' | *'''For Artist artwork:''' | ||
*#Local artwork named and saved as detailed in the sections above. There is no fallback image | *#Local artwork named and saved as detailed in the sections above. There is no fallback image | ||
Line 300: | Line 148: | ||
*'''For Album artwork:''' | *'''For Album artwork:''' | ||
*#Local artwork named and saved as detailed in the sections above. If there is no local artwork then | *#Local artwork named and saved as detailed in the sections above. If there is no local artwork then | ||
*#If you have '''Enable tag reading''' set as '''''Disabled''''' in Settings>Media Settings>Music then there is no fallback image | *#If you have '''Enable tag reading''' set as '''''Disabled''''' in ''Settings>Media Settings>Music'' then there is no fallback image | ||
*#If you have '''Enable tag reading''' set as '''''Enabled''''' in Settings>Media Settings>Music then Kodi will search for an embedded image to cache. | *#If you have '''Enable tag reading''' set as '''''Enabled''''' in ''Settings>Media Settings>Music'' then Kodi will search for an embedded image to cache. | ||
'''Note:''' If you use File Mode, then upgrade to Library Mode at a later stage, your existing cached artwork may interfere with the correct scanning and scraping of new artwork. There is no simple fix for this. Your choices are | |||
#Manually amend the affected artwork | #Manually amend the affected artwork using the '''''[[Artwork#Kodi-_Choose_Art|Chooe Art]]''''' method. | ||
#Perform the [[Artwork/Cache#Advanced: delete textures13.db|delete textures13.db]] procedure. This will also affect your Video Library. | #Perform the [[Artwork/Cache#Advanced: delete textures13.db|delete textures13.db]] procedure. This will also affect your Video Library. | ||
= {{Kodi}} version updates = | = {{Kodi}} version updates = | ||
* {{Kodi}} 17 and before did not have the "Artist information folder" option, so could have trouble identifying a local folder for artist artwork in some cases. | * {{Kodi}} 17 and before did not have the "Artist information folder" option, so could have trouble identifying a local folder for artist artwork in some cases. | ||
* {{Kodi}} 17 and before was '''limited to just "fanart" and "thumb" for artist images''' and '''"thumb" for album images''', it did not have the flexibility to add a wide variety of artwork. Expanded artwork is new and still being explored from multiple angles, so not all skins or scrapers or tools will support a full selection. | * {{Kodi}} 17 and before was '''limited to just "fanart" and "thumb" for artist images''' and '''"thumb" for album images''', it did not have the flexibility to add a wide variety of artwork. Expanded artwork is new and still being explored from multiple angles, so not all skins or scrapers or tools will support a full selection. | ||
** Skins for versions of Kodi prior to v18 could use Skin Helper Service for some support of expanded artwork, but that has been superseded with this Kodi built-in functionality. | ** Skins for versions of Kodi prior to v18 could use Skin Helper Service for some support of expanded artwork, but that has been superseded with this Kodi built-in functionality. | ||
* {{Kodi}} 18 adds a flexible collection of artwork for music items, but each artwork type must be '''[[Advancedsettings.xml#Music library extra artwork| whitelisted in advancedsettings.xml]]''' so that {{Kodi}} will add the specified artwork from scrapers and the file system automatically. | * {{Kodi}} 18 adds a flexible collection of artwork for music items, but each artwork type must be '''[[Advancedsettings.xml#Music library extra artwork| whitelisted in advancedsettings.xml]]''' so that {{Kodi}} will add the specified artwork from scrapers and the file system automatically. | ||
{{Top}} | {{Top}} | ||
Line 322: | Line 175: | ||
[[Category:Manual]] | [[Category:Manual]] | ||
[[Category:Karellen]] | [[Category:Karellen]] | ||
[[Category:Music library]] | |||
[[Category:First time user]] | [[Category:First time user]] | ||
[[Category:Advanced topics]] | [[Category:Advanced topics]] | ||
[[Category:Quick Start Guide]] | [[Category:Quick Start Guide]] |
Revision as of 03:14, 18 May 2019
Artwork contents |
---|
See also: Return to: |
Music Library Index | Artwork | Music artwork |
Music artwork are images directly related to an artist or an album, preferably of high quality, that are displayed when viewing the album or artist entry in the library. They may also be used as visualizations while playing music. The artwork support in Kodi's music library is very flexible and able to display many types of artwork, depending on the skin in use.
It is important to note the following:
- To ensure local artwork is added when scanning new media items, the image files must be arranged in a certain folder hierarchy.
- For Albums see Music folder and file structure for a basic option
- For Artists see Artist information folder which is new for v18 and separates Artists from music files and overcomes the inherent limitations of that previous method.
- Each artwork type must be whitelisted in advancedsettings.xml to be added to the library automatically during scanning and scraping.
- Kodi 18 is required for expanded artwork type support in the music library.
Artist Information Folder
- Main page: Artist information folder
In v18 the concept of the Artist Information Folder is introduced as a new way to handle providing local artist artwork and information via nfo files. The Artist Information Folder is a user nominated folder that Kodi will look in first for artwork or NFO files for any artist.
This topic is of interest to those users that want to provide local artwork for artists, or capture their current artist art and additional data for transfer to another installation of Kodi
Fetching Additional Artwork
v18 introduces an experimental feature that will auto-load extended artwork without the use of additional add-ons. It is considered an advanced feature. Usage and practicality of this feature are being monitored and may change in later releases.
In the Music library, artwork is described as follows:
Artist Artwork | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Basic Artwork | Extended Artwork | ||||||||||
fanart | folder | banner | clearart | clearlogo | fanartxx (extrafanart) | landscape | |||||
Album Artwork | |||||||||||
Basic Artwork | Extended Artwork | ||||||||||
folder | back | discart | spine |
Basic artwork requires no special setup as it has always been natively fetched by Kodi
Extended artwork required the use of additional add-ons in previous versions. cdART (now defunct) was used. More recently Artwork Beef is used.
Users now have the option of allowing Kodi to load all artwork without add-ons. To use this feature...
- 1. Add the below code to the advancedsettings.xml file, ensuring you do not duplicate any tags if they already exist... eg <advancedsettings></advancedsettings>, <musiclibrary></musiclibrary>
- 2. Install the Universal Artist Scraper and Universal Album Scraper and ensure the settings to download extra art are enabled.
- 3. Scan as normal
- Note: The code box adds common extended artwork that most skins will utilise. It is your choice which extended artwork you add. If you add additional to that shown, ensure the skin has support to display it.
<advancedsettings> <musiclibrary> <artistextraart> <arttype>banner</arttype> <arttype>clearart</arttype> <arttype>clearlogo</arttype> <arttype>fanart1</arttype> <!-- Multiple fanart --> <arttype>fanart2</arttype> <!-- Add as many as required. --> <arttype>fanart3</arttype> <!-- See 9.1 Multiple Fanart section below --> <arttype>landscape</arttype> </artistextraart> <albumextraart> <arttype>back</arttype> <arttype>discart</arttype> <arttype>spine</arttype> </albumextraart> </musiclibrary> </advancedsettings>
Local Artwork
Local artist artwork can be saved in the Artist information folder (shown in image) or a common artist folder among your music files if Kodi can find one.
Local album artwork can be saved in the album folder (shown in image).
The general rule for artist and album artwork file naming is <arttype>.<ext>.
Embedded Artwork
As of v17, Kodi supports embedded album art in mp3 files with ID3v2 tags, WMA/WMV files with ASF tags, FLAC files with Vorbis comments/Xiph tags, and mp4 files with itunes tags. It does not currently support embedded album art in APEv2 tags or Ogg files.
Kodi cannot recognise multiple embedded images in a song file. It can only extract the "Front Cover" image assuming they have been tagged correctly within the file. All other images are ignored.
A list of embedded tags recognised by Kodi is available
- see also: Tags Kodi Reads
Library artwork source priority
- Local artwork files
- Local artwork files next to your media items or in the "Artist information folder". These are expected to be mid-high quality level for display in an interface like Kodi.
- all types of artwork can be saved to local artwork files
- Artwork embedded in tracks
- Artwork embedded in individual tracks of an album. These are expected to be lower quality to reduce the size of the image duplicated to many song files.
- Only supports the album front cover
- Online source from "information provider"/scraper
- only if the option in Kodi Settings -> Media -> Music -> "Fetch additional information during updates" is enabled
- will only be set if there is no local or embedded artwork unless the option in Kodi Settings -> Media -> Music -> "Prefer online information" is enabled
- all types of artwork can be added from information providers
File Mode
File Mode is similar to using the file manager provided by your operating system- eg Explorer in Windows systems. It is simply a file browser that allows you to view and play your media even though it has not been scanned and/or scraped into the Library. This mode does not provide the added benefits of Extended Artwork and Album/Artist metadata that the properly scanned and scraped library provides. As a result, Music Artwork is handled differently using this mode as follows:
- The only artwork displayed in File Mode is artist folder/thumb and album folder/thumb.
- You must have local artwork named and saved as detailed in the sections above.
- These images are not loaded automatically. The Artist or Album must be viewed once to allow Kodi to locate and cache the image.
- When Enable tag reading is Enabled the song must be viewed to allow Kodi to scan for embedded images if no local image is available.
Kodi looks for, and caches, artwork in the following order:
- For Artist artwork:
- Local artwork named and saved as detailed in the sections above. There is no fallback image
- For Album artwork:
- Local artwork named and saved as detailed in the sections above. If there is no local artwork then
- If you have Enable tag reading set as Disabled in Settings>Media Settings>Music then there is no fallback image
- If you have Enable tag reading set as Enabled in Settings>Media Settings>Music then Kodi will search for an embedded image to cache.
Note: If you use File Mode, then upgrade to Library Mode at a later stage, your existing cached artwork may interfere with the correct scanning and scraping of new artwork. There is no simple fix for this. Your choices are
- Manually amend the affected artwork using the Chooe Art method.
- Perform the delete textures13.db procedure. This will also affect your Video Library.
Kodi version updates
- Kodi 17 and before did not have the "Artist information folder" option, so could have trouble identifying a local folder for artist artwork in some cases.
- Kodi 17 and before was limited to just "fanart" and "thumb" for artist images and "thumb" for album images, it did not have the flexibility to add a wide variety of artwork. Expanded artwork is new and still being explored from multiple angles, so not all skins or scrapers or tools will support a full selection.
- Skins for versions of Kodi prior to v18 could use Skin Helper Service for some support of expanded artwork, but that has been superseded with this Kodi built-in functionality.
- Kodi 18 adds a flexible collection of artwork for music items, but each artwork type must be whitelisted in advancedsettings.xml so that Kodi will add the specified artwork from scrapers and the file system automatically.
Return to top |
---|