Difference between revisions of "Music artwork"

From Official Kodi Wiki
Jump to: navigation, search
(Page Creation)
 
m (Library Artwork Source Ppriority)
 
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Artwork_Contents}}
 
{{Artwork_Contents}}
{{mininav|[[Artwork]]}}
+
{{mininav|[[:Category:Music_library|Music Library Index]] |[[Artwork]]}}
  
  
<section begin="intro" />Music artwork are images directly related to an Artist and Album scraped into the Music library. The images are, preferably, of high quality, that are displayed when viewing the Album or Artist entry in the library. They may also be used as visualisations while playing music. The Music section in Kodi is able to display up to six types of artwork. This page will describe the different types of artwork available in the Music category of Kodi.<section end="intro" />
+
<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:'''}}
*Artwork is skin dependent. This means that some skins display a small number of artwork types, while other skins will display most of the available artwork types.
+
* To enable '''local artwork''' from separate image files to be added when scanning new media items, the image files must be arranged in a certain folder hierarchy.  
*In previous versions of Kodi and in older wiki pages, the term Thumbnails was used to describe Artwork. Kodi has now moved away from referring to thumbnails due to the amount of confusion and concern it caused users.
+
** For Albums see '''''[[Music tagging#Folder_and_File_Structure| Music folder and file structure]]''''' for a basic option
*The base line for all artwork is the default skin Estuary. By default, Estuary displays the Basic artwork. Estuary can display the Extended artwork via additional add-ons.
+
** For Artists see '''''[[Artist information folder]]''''' which is new for v18 and separates Artist artwork from music files and overcomes the inherent limitations of that previous method.
*While high resolution images do look impressive on HDTV's it is important to be aware that the increased artwork size can negatively affect low powered hardware.
+
* Each artwork type, other than the basic thumb and fanart types (that are sufficient for Estuary), must be '''[[Advancedsettings.xml#Music library extra artwork| whitelisted in advancedsettings.xml]]''' in order to be added to the library automatically during scanning or scraping.
; {{see also|Music_library}}
+
* Kodi 18 is required for expanded artwork type support in the music library.
  
  
  
= Requirements =
+
= Artist Information Folder =
{{Red|'''As the Music section of Kodi has many differences to the Video section of Kodi, please read the following to ensure your music and artwork are correctly scraped and displayed.'''}}
+
:{{main|Artist information folder}}
 +
{{#lst:Artist_information_folder|intro}}
  
It is important to understand the fundamental difference between video library operation and the music library operation:
 
*The video library scraping is based on the file names to get online data. If the video files are incorrectly named, then there are no scraper results, thus no library entry.
 
*The music library scraping is based on scanning tags embedded in the music files. The library then has enough information to create a minimal library entry.
 
*Although you may have your music saved in Artist\Album\Song type directory, Kodi ignores this and uses only the filename and the tags in the music files. According to Kodi, there are no album or artist files per se, they are creations of Kodi from the tags.
 
*'''Scraping to populate the library is a two step process.'''
 
**The first scrape reads the tags embedded in the music files. If there is any embedded artwork, this will also be scraped and cached.
 
**The second scrape downloads the online artist and album metadata and artwork which is added to the library and cached.
 
*'''Scraping of additional artist and album metadata does not happen on library update (including first adding a source) unless "Fetch additional info on update" is enabled.''' Currently this defaults to '''disabled''', for several reasons:
 
**It allows you to perform the initial tag scan quickly. In v17 and below, when ''Fetch additional info on update'' is ''enabled'', the two scraping steps happen immediately each album and artist is added. This slows down populating the library. It is a background task, but still gives the impression that it is taking a considerable time to populate the library. This may cause users to believe that Kodi has stopped working and leads to many users stopping the scrape prematurely which causes further problems with library corruption. In reality it is slowed down by the online scraping, and not the local tag scrape. This will be changed in v18 where Kodi will perform the initial tag scan then, once complete, will commence the online scrape.
 
**Bad tagging makes a messy library and then the online scrape compounds errors and makes the library difficult to unscramble. It is far better for the user to perform the initial scan, find and fix the bad tags, then perform the on-line scrape knowing there will be no further errors.
 
**When scraping failed due to ''503 server errors'', this means that the initial tag scraping process has been interrupted, and the user had to manually ''query for all'' to fill gaps anyway. This is expected to be fixed for v17.4 if released or v18.
 
  
  
 +
= Fetching Additional Artwork =
 +
v18 introduces an '''experimental''' feature that will auto-load extended artwork from local files without the use of additional add-ons, and can be adapted to future changes in the results returned by the music information providers (album and artist scrapers) without changes to Kodi itself. It is considered an advanced feature. Usage and practicality of this feature are being monitored and may change in later releases.
  
{{#lst:Adding_music_to_the_library|intro}} {{see also|Adding_music_to_the_library}}
+
The common types of art available for items in the Music library can be categorised as follows:
  
{{#lst:Music_tagging|intro}}{{see also|Music_tagging}}
+
{| class="prettytable"
 
+
! colspan="8" style="text-align:left; background-color:#72d2f7;" | Artist Artwork
 
+
|-
 
+
! colspan="2" style="text-align:left;" | Basic Art Types
== Caching ==
+
! colspan="1" style="text-align:left;" |
All music artwork is cached. If artwork is scraped from local files, once it is cached, Kodi will not access the local files again.
+
! colspan="5" style="text-align:left;" | Extended Art Types
 
+
|-
Also be aware of image adjustments made by Kodi during the caching process. See [[Artwork#Cache|Cache]]
+
|style="width:80px; text-align:left;"|fanart
 
+
|style="width:80px; text-align:left;"|thumb
<div style="{{linear-gradient|left|#ffaba5, #ffaba5 50%, #ffaba5}}">
+
! colspan="1" style="text-align:left;" |
Music artwork is cached as part of a multi-tier process. The code which assigns images to files runs and assigns images in the following order:
+
|style="width:80px; text-align:left;"|banner
#Cached Album image
+
|style="width:80px; text-align:left;"|clearart
#*This is all the embedded album art read by the tag reader and cached using the album name and album artist.
+
|style="width:80px; text-align:left;"|clearlogo
#Cached filename.jpg
+
|style="width:100px; text-align:left;"|fanart''xx'' (extrafanart)
#*This includes an embedded image cached with the fully qualified name.
+
|style="width:80px; text-align:left;"|landscape
#Remote filename.jpg
+
|-
#*This is a filename.jpg on a remote share/folder which is then cached.
+
! colspan="12" style="text-align:left; background-color:#72d2f7;" | Album Artwork
#Cached folder.jpg
+
|-
#*This is a folder.jpg which is cached based off the folder path.
+
! colspan="2" style="text-align:left;" | Basic Art Types
#Remote folder.jpg
+
! colspan="1" style="text-align:left;" |
#*This is a folder.jpg on a remote share/folder which is then cached.
+
! colspan="8" style="text-align:left;" | Extended Art Types
#Remote foldername.jpg
+
|-
#*This is a foldername.jpg on a remote share/folder which is then cached.
+
|style="width:80px; text-align:left;"|thumb
</div>
+
|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'''- These types of artwork require no special setup as they have always been natively fetched by {{kodi}} from local files and by the default music scrapers. These are displayed by Estuary.
  
 +
'''Extended'''- Many skins are more rich in art than Estuary and can show extended artwork as well. Historically cdART (now defunct) was used to fetch and apply this art, and more recently '''''[https://forum.kodi.tv/showthread.php?tid=258886 Artwork Beef]''''' is used.
  
= Basic Music Artwork =
+
Users now have the facility to load any type of artwork without add-ons providing either they have that art locally or use a scraper that returns that type of art. However the default skin Estuary does not display the extended art types, '''if you are using Estuary then there is no need to consider this feature.'''
The artwork in the Basic section is the minimum artwork displayed by the default skin Estuary with a standard install.
 
  
{{red|'''Note the following:'''}}
+
To enable this feature first the art types must be whitelisted in advancedsettings.xml, an example is given below.
*The following naming schemes apply '''only''' to the artwork you have manually sourced and saved. It does not apply to artwork downloaded by the Kodi scraper or any add-on processes.
 
*To ensure auto-scraping of local artwork, there must be an Artist directory which then contains the Album directories. These album directories contain the individual songs for that album.
 
*Folder structure is only important if you want to use NFOs or local artwork. The scraper ignores directory names and will '''only''' read music tags.
 
*The folder structure is not too important to Kodi as long as you are not using local artwork or NFO files which currently depends on an artist>album hierarchy and handles compilations, collaborations, non-unique artist names and singles badly.
 
*It is useful having separate/multiple music sources that separates standard artists and albums from the more complex systems used by classical music, soundtracks, and compilations.
 
  
 +
<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>
 +
<arttype>landscape</arttype>
 +
</artistextraart>
 +
<albumextraart>
 +
<arttype>back</arttype>
 +
<arttype>discart</arttype>
 +
<arttype>spine</arttype>
 +
</albumextraart>
 +
</musiclibrary>
 +
</advancedsettings>
 +
</syntaxhighlight>
  
== Fanart- Artist ==
+
:'''Note:''' The code box adds common extended artwork that many 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.
[[File:Artwork-MusicFanart01.jpg|400px|right]]
 
Fanart, also known as Wallpapers, Backdrops or Backgrounds, are images that have, in most cases, been created by fans.
 
;{{see also|wikipedia:Fanart|l1=Fanart on Wikipedia}}
 
  
For Kodi, it means digital images, of high quality, that are used as full screen displays to enhance the user experience. The fanart displays the artist or band.
 
;{{see also|FanArt}}
 
  
The image to the right is a typical example of music fanart. It is specifically designed to match the 16:9 ratio of current generation televisions and monitors. This allows the screen to be completely filled by the image.  
+
Then decide where the art is going to come from, most likely this will be via the music scrapers. The '''[[Add-on:Universal_Artist_Scraper|Universal Artist Scraper]]''' and '''[[Add-on:Universal_Album_Scraper|Universal Album Scraper]]''' for v18 can fetch extended types of artwork. They currently have settings that enable what art types are fetched as well as the remote sources these come from (see images below). This over complicates matters, where things come from will always be part of the scraper settings, but the decision what to apply belongs to Kodi and the whitelist. For now ensure that the types of art you want are enabled here too, so the scraper fetches a full list of the art available, but these settings should be simplified in due course.  
  
<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
+
Extended artwork can also be provide in correctly located and named local files. The general rule for local extended artwork file naming is <arttype>.<ext>, for where these need to be located see below.
'''Required file properties:'''<br />
 
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
 
{|
 
|- valign="top"
 
| '''''File Type'''''
 
| '''''Aspect Ratio'''''
 
| '''''Resolution- <small>recommended</small>'''''
 
|- valign="top"
 
| width=150px | {{nowrap|*.jpg or png}}
 
| width=200px | {{nowrap|16:9}}
 
| width=200px | {{nowrap|1920x1080}}
 
|}
 
</div><br />
 
  
<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
+
Extended art from local files is automatically picked up and applied as part of music library scanning or scrapin When local art of the types in the whitelist is not found  then the first avialable art of that type returned by the scraper is automatically applied as part of scraping.
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
 
{|
 
|- valign="top"
 
| width=300px |'''''Music saved as'''''
 
| width=250px |'''''File Name'''''
 
| width=600px |'''''Save name & location example'''''
 
|- valign="top"
 
| width=300px |Artist\Album\Songs
 
| width=250px |fanart.jpg/png
 
| width=600px |f:\Music\Madonna\fanart.jpg/png
 
|}
 
</div>
 
{{highlight|'''Bug''': Linux users- In releases upto v17, there exists a bug in ''URIUtils::GetParentPath''. It effects artists with single albums (any number of tracks). The issue prevents the algorithm from returning to the artist directory once the music files are found. This means the Artist Fanart is not located. The temporary solution is to place the Artist Fanart in the Album directory|color=#f59f7a}}
 
  
 +
The process applied is as described in ''[[Artwork#What Artwork is Used Automatically | What Artwork is Used Automatically]]''
  
 
+
<gallery mode="packed-overlay" widths="500px" heights="283px">
== Artist Image ==
+
File:UniversalArtistScraper03.jpg|Artist Scraper- Enable Extra Artwork
[[File:Artwork-MusicArtist01.jpg|400px|right]]
+
File:UniversalAlbumScraper02.jpg|Album Scraper- Enable Extra Artwork
The Artist Image is also known as Artist Thumb or just Thumb within Kodi, and is saved as ''folder.jpg'' within the artist directory. They are high quality images of the artist or band members. The image to the right is displaying the Artist Image using the Infowall view in Estuary.
 
 
 
<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
 
'''Required file properties:'''<br />
 
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
 
{|
 
|- valign="top"
 
| '''''File Type'''''
 
| '''''Aspect Ratio'''''
 
| '''''Resolution- <small>recommended</small>'''''
 
|- valign="top"
 
| width=150px | {{nowrap|*.jpg or png}}
 
| width=200px | {{nowrap|1:1}}
 
| width=200px | {{nowrap|1000x1000}}
 
|}
 
</div><br />
 
 
 
<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
 
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
 
{|
 
|- valign="top"
 
| width=300px |'''''Music saved as'''''
 
| width=250px |'''''File Name'''''
 
| width=600px |'''''Save name & location example'''''
 
|- valign="top"
 
| width=300px |Artist\Album\Songs
 
| width=250px |folder.jpg/png
 
| width=600px |f:\Music\Madonna\folder.jpg/png
 
|}
 
</div>
 
{{highlight|'''Bug''': Linux users- In releases upto v17, there exists a bug in ''URIUtils::GetParentPath''. It effects artists with single albums (any number of tracks). The issue prevents the algorithm from returning to the artist directory once the music files are found. This means the Artist Folder image is not located. There is no temporary solution as placing the artist folder.jpg in the album directory will interfere with the album folder.jpg. In these cases, either an online scrape or manual placement of artwork is required|color=#f59f7a}}
 
 
 
 
 
 
 
== Manually Adding Artist Artwork ==
 
From within Kodi, you have the ability to manually change the artwork at any time.
 
 
 
Select the Artist whose artwork you would like to add or change. Call up the Artist Information page. As seen in the images below, there are two options titled ''Get Thumb'' and ''Get Fanart''. Selecting either of these will present you the options as seen in the second and third images.  Once selected, you will then be provided with a list of available artworks at the scraper site, or you can navigate to a local or network location as shown in the following images.
 
<gallery widths=450px heights=250px>
 
File:Artwork-MusicAdd01.jpg|Choose either Get thumb or Get fanart on the Artist Information Page
 
File:Artwork-MusicAdd02.jpg|The browse screen for Get Thumb (Artist Image). Select from Current, Local or Remote (online) sources
 
File:Artwork-MusicAdd03.jpg|The browse screen for Get Fanart. Select from Current, Local or Remote (online) sources
 
 
</gallery>
 
</gallery>
  
  
  
== Album Image ==
+
= Local Artwork =
[[File:Artwork-MusicAlbum01.jpg|400px|right]]
+
All types of artwork can be read from and saved to local artwork files.
The album image is also known as the Album Thumb, Album Cover or as Thumb within Kodi. They are high quality images of the Album cover and each album directory would have its own album Folder image. They are saved as ''folder.jpg'' inside the album directory. The image to the right is displaying the album images using the Infowall view in Estuary.
 
 
 
<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
 
'''Required file properties:'''<br />
 
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
 
{|
 
|- valign="top"
 
| '''''File Type'''''
 
| '''''Aspect Ratio'''''
 
| '''''Resolution- <small>recommended</small>'''''
 
|- valign="top"
 
| width=150px | {{nowrap|*.jpg or png}}
 
| width=200px | {{nowrap|1:1}}
 
| width=200px | {{nowrap|1000x1000}}
 
|}
 
</div><br />
 
 
 
<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
 
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
 
{|
 
|- valign="top"
 
| width=300px |'''''Music saved as'''''
 
| width=250px |'''''File Name'''''
 
| width=600px |'''''Save name & location example'''''
 
|- valign="top"
 
| width=300px |Artist\Album\Songs
 
| width=250px |folder.jpg/png
 
| width=600px |f:\Music\Madonna\Like A Prayer\folder.jpg/png
 
|}
 
</div>
 
 
 
  
 +
Local artist artwork can be located in the '''[[Artist information folder]]''' (shown in image) where the name of the artist subfolder does matter, '''or''' a '''[[Music tagging#Folder and File Structure| common unique artist folder]]''' among your music files if Kodi can find one (where the name of the subfolder does not matter).
  
== Manually Adding Album Artwork ==
+
Local album artwork can be located in the '''[[Music tagging#Folder and File Structure| album folder]]''' (shown in image). This folder is identified from the music files it contains, not the folder name.
From within Kodi, you have the ability to manually change the artwork at any time.
 
  
Select the Album whose artwork you would like to add or change. Call up the Album Information page. As seen in the images below, select ''Get Thumb'' which will present you the options as seen in the second image. You will then be provided with a list of available artworks at the scraper site, or you can navigate to a local or network location as shown in the following images.
+
<gallery mode="packed" widths="1000px" heights="562px">
<gallery widths=450px heights=250px>
+
File:LocalMusicArtwork01.jpg
File:Artwork-MusicAdd04.jpg|Choose Get thumb on the Album Information Page
 
File:Artwork-MusicAdd05.jpg|The browse screen for Get Thumb (Album Image). Select from Current, Local or Remote (online) sources
 
 
</gallery>
 
</gallery>
  
  
 
== Source Folder Artwork ==
 
[[File:Artwork-VideoFolder01.jpg|400px|right]]
 
 
The Folder Artwork, also known as Source Folder thumb,  can be landscape, portrait or square images that are used to replace the standard folder icons when browsing your music sources in the files section. You will not see this artwork in the Music menu. This image file is saved directly within the Source directory.
 
 
To enable the image, navigate to Music>Files in the menu system. Highlight a source and call up the Context Menu. Select Choose Thumbnail. If you have saved the image in the correct location, it will be available to select immediately. If not, you will need to navigate to locate and select it. The image must remain in its original location once selected as it will not be cached. Deleting the image will remove it from view in the folder icon.
 
 
You are able to also apply the folder thumb by modifying the '''\userdata\sources.xml''' as follows
 
 
<pre><nowiki>
 
<source>
 
  <name>music</name>
 
  <path>xbms://192.168.1.100:1400/Music/</path>
 
  <thumbnail>F:\Apps\XBMC\thumbs\shares\thumb.png</thumbnail>
 
</source>
 
</nowiki></pre>
 
 
<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
 
'''Required file properties:'''<br />
 
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
 
{|
 
|- valign="top"
 
| '''''File Type'''''
 
| '''''Aspect Ratio'''''
 
| '''''Resolution- <small>recommended</small>'''''
 
|- valign="top"
 
| width=150px | {{nowrap|*.jpg}}
 
| width=200px | {{nowrap|16:9}}
 
| width=200px | {{nowrap|640x360}}
 
|- valign="top"
 
| width=150px | {{nowrap|*.jpg}}
 
| width=200px | {{nowrap|1:1.5}}
 
| width=200px | {{nowrap|400x600}}
 
|- valign="top"
 
| width=150px | {{nowrap|*.jpg}}
 
| width=200px | {{nowrap|1:1}}
 
| width=200px | {{nowrap|500x500}}
 
|}
 
</div><br />
 
 
<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
 
'''''Naming conventions for your own manually sourced artwork:'''''
 
{|
 
|- valign="top"
 
| width=200px |'''''Source'''''
 
| width=250px |'''''File Name'''''
 
| width=600px |'''''Save name & location example'''''
 
|- valign="top"
 
| width=200px |Folder Artwork:
 
| width=250px |folder.jpg
 
| width=600px |f:\Music\folder.jpg
 
|- valign="top"
 
| width=200px |Alternative name:
 
| width=250px |<foldername>.jpg
 
| width=600px |f:\Musc\Music.jpg
 
|}
 
</div>
 
  
  
 +
= Embedded Artwork =
 +
<section begin="EmbeddedArtwork" />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.<section end="EmbeddedArtwork" />
  
 +
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.
  
= Extended Music Artwork =
+
A list of embedded tags recognised by Kodi is available
To display the Extended Music Artwork, an add-on will need to be installed to extend the image handling capabilities of Kodi and the skins. Once this is installed, it will insert extra artwork fields which become available to use in the Skins.
+
; '''''see also: [[Music_tagging#Tags_Kodi_reads|Tags Kodi Reads]]'''''
One example is the cdART Manager add-on which can be installed from the official Kodi repository.
 
; {{see also|Add-on:CdART_Manager}}
 
  
{{red|'''Note the following:'''}}
 
*The following naming schemes apply '''only''' to the artwork you have manually sourced and saved. It does not apply to artwork downloaded by the Kodi scraper or any add-on processes.
 
*To ensure auto-scraping of local artwork, there must be an Artist directory which then contains the Album directories. These album directories contain the individual songs for that album.
 
*Compilation Albums are problematic for local artwork and metadata. See chapter 5 below for further information.
 
*All Extended Artwork, except Extra Fanart, is cached by Kodi. Once cached the local original files will no longer be accessed.
 
*If using the cdART Manager add-on, it is important to note the following
 
**The add-on has the option to use local artwork (if correctly named and saved) or online artwork. When viewing the Album and Artist information page for the first time, the cdART Manager will automatically scrape local artwork. If no local artwork is available, it will scrape online sources.
 
**Using the Kodi scraper will not download extended artwork. The cdART Manager add-on is required to be run after the Kodi scrape process. i.e. you are performing two or three scrapes depending upon settings.
 
  
  
== Banner ==
+
= Library Artwork Source Priority =
[[File:Artwork-MusicBanner01.jpg|400px|right]]
+
Music artwork is automatically allocated using the following order:
  
Also known as Wide Banner Icons and Artist Banner. The image to the right shows the Banner view at the top right position. They are images that contain the artist or band. The banner image normally displays the artist or band logo which is of a size that is clearly legible. The view is from the Aeon MQ7- Krypton Mod skin
+
# Local artwork files
; {{see also|Wide_banner_icons}}
+
#* Album and artist artwork from local files always takes precedence.  
 +
# Album cover artwork embedded in tracks (when "Prefer scraped album art" is disabled)
 +
#* By default the first embedded front cover art found while processing the music files of the album is taken as the album cover.
 +
# First available scraped art
 +
#* The music information providers (scrapers) return lists of available artist and album artwork. The first of each the type of art for that artist or album is applied as the art if none has already been found locally.
 +
#* Scraping only happens as part of library update if the option in Kodi ''Settings -> Media -> Music -> "Fetch additional information during updates"'' is enabled
 +
# Album cover artwork embedded in tracks (when"Prefer scraped album art" is enabled)
 +
#* Use of cover art from the music files can be unprioritised by enabling the "Prefer scraped album art" setting. This could be desirable if the embedded art is of low quality compared to what the scrapers may return.
  
<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
 
'''Required file properties:'''<br />
 
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
 
{|
 
|- valign="top"
 
| '''''File Type'''''
 
| '''''Aspect Ratio'''''
 
| '''''Resolution- <small>recommended</small>'''''
 
|- valign="top"
 
| width=150px | {{nowrap|*.jpg or png}}
 
| width=200px | {{nowrap|1:0.185}}
 
| width=200px | {{nowrap|1000x185}}
 
|}
 
</div><br />
 
  
<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
+
Songs also have associated art, most of it is the art of the related album and artists but they can also have individual “thumb” type art automatically set. The thumb type artwork displayed for a '''song''' on both player OSD and library screens has a fallback strategy:
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
+
# Art embedded in that music file provided that all songs on an album do '''not''' have the same embedded art
{|
+
# Falls back to album thumb. This is either from
|- valign="top"
+
## Local image file ''e.g. folder.jpg''
| width=300px |'''''Music saved as'''''
+
## The common embedded art when that is the same in every music file in the album and "Prefer scraped album art" is disabled
| width=250px |'''''File Name'''''
+
## The remotely scraped album thumb result (when "Prefer scraped album art" is enabled or neither a) or b) are found)
| width=600px |'''''Save name & location example'''''
 
|- valign="top"
 
| width=300px |Artist\Album\Songs
 
| width=250px |banner.jpg/png
 
| width=600px |f:\Music\Madonna\Like A Prayer\banner.jpg/png
 
|}
 
</div>
 
  
 +
This means that if the embedded art is a jumble, say one music file with a different image, then the musc player OSD will show the individual embedded art not the album cover however it is set.
  
 +
= File View Mode =
 +
File View 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 only provides the added benefits of album and artist extended artwork and information when viewing music files that have been scanned into the library (so album and artist enries exist) and these have been sucessfully scraped. However basic artwork from local files is supported for music files that are not scanned into the library.
  
== Logo ==
+
For non-scanned music files and folders artwork in file view mode is as follows:
[[File:Artwork-MusicBanner01.jpg|400px|right]]
+
*The only type of art supported is ''[[Artwork_types#thumb|thumb]]'' artwork
 +
*Every folder in the hierarchical structure can have an associated “thumb” artwork. The “thumb” for the folder on display is picked up from any suitably named image file found in that folder.  
 +
*A thumb for individual music files will be read from tag data embedded in the music file providing the '''''[[Settings/Media/Music#Enable_tag_reading|Enable tag reading]]''''' setting is enabled. Only front cover is currently supported.
 +
*These images are loaded automatically and cached when the folder or music file is first viewed
  
Also known as Clear Logo. This is the logo or name of the artist or band on a transparent background. The logo uses the distinctive font associated with the musicians and is uncluttered by other images. The transparent background allows it to be overlayed on other images or video with minimal impact. The image to the right shows the logo at the far right of the image, roughly in the centre and looks like a signature. The view is from the Aeon MQ7- Krypton Mod skin
 
  
<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
 
'''Required file properties:'''<br />
 
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
 
{|
 
|- valign="top"
 
| '''''File Type'''''
 
| '''''Aspect Ratio'''''
 
| '''''Resolution- <small>recommended</small>'''''
 
|- valign="top"
 
| width=150px | {{nowrap|*.png}}
 
| width=200px | {{nowrap|1:0.388}}
 
| width=200px | {{nowrap|800x310}}
 
|}
 
</div><br />
 
  
<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
+
= {{Kodi}} version updates =
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
+
* {{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.
|- valign="top"
+
** 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.
| width=300px |'''''Music saved as'''''
+
* {{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.
| width=250px |'''''File Name'''''
 
| width=600px |'''''Save name & location example'''''
 
|- valign="top"
 
| width=300px |Artist\Album\Songs
 
| width=250px |logo.png
 
| width=600px |f:\Music\Madonna\Like A Prayer\logo.png
 
|}
 
</div>
 
 
 
 
 
 
 
== CD Art ==
 
[[File:Artwork-MusicBanner01.jpg|400px|right]]
 
CD Art, also known as Disc Art, is the image that is visible on the physical CD. It uses a transparent background.
 
 
 
The image to the right displays the CD Art in two locations- bottom left and bottom right corners of the image.
 
 
 
<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
 
'''Required file properties:'''<br />
 
<small>Note: The resolution may be increased but ensure the aspect ratio is maintained</small>
 
{|
 
|- valign="top"
 
| '''''File Type'''''
 
| '''''Aspect Ratio'''''
 
| '''''Resolution- <small>recommended</small>'''''
 
|- valign="top"
 
| width=150px | {{nowrap|*.png}}
 
| width=200px | {{nowrap|1:1}}
 
| width=200px | {{nowrap|1000x1000}}
 
|}
 
</div><br />
 
 
 
<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
 
'''''Naming and Saving conventions for your own manually sourced artwork:'''''
 
{|
 
|- valign="top"
 
| width=300px |'''''Music saved as'''''
 
| width=250px |'''''File Name'''''
 
| width=600px |'''''Save name & location example'''''
 
|- valign="top"
 
| width=300px |Artist\Album\Songs
 
| width=250px |cdart.png
 
| width=600px |f:\Music\Madonna\Like A Prayer\cdart.png
 
|- valign="top"
 
| width=300px |or
 
| width=250px |disc.png
 
| width=600px |f:\Music\Madonna\Like A Prayer\disc.png
 
|}
 
</div>
 
 
 
 
 
 
 
== Extra fanart ==
 
Extra fanart is reliant on a supporting skin and have exactly the same properties as the standard Fanart.
 
 
 
It is possible to download and save additional high quality Fanart which the skin can display, usually in a slideshow.
 
; {{see also|Extra_Fanart}}
 
 
 
 
 
 
 
= Embedded Artwork =
 
<div style="{{linear-gradient|left|#ffaba5, #ffaba5 50%, #ffaba5}}">
 
<section begin="EmbeddedArtwork" />As of v17, Kodi supports embedded album art in files with ID3 tags, WMA tags, FLAC and MP4 tags only. It does not support embedded album art in APE or Ogg tags currently.<section end="EmbeddedArtwork" />
 
</div>
 
 
 
 
 
 
 
= Compilation Albums =
 
Compilation albums, various artists, classical music and other collaborative type albums are problematic for Kodi in the following cases:
 
#When using local artwork and nfo files
 
#When using the Import/Export function ''See [[Import-Export_library]]''
 
 
 
If you are '''not''' using either one of those functions, then Kodi has no problem scraping online metadata and artwork of correctly named and tagged music files.
 
 
 
There currently is no workaround or fix for this issue, but steps can be taken so that these compilation albums do not affect the remainder of the library of normal single artist albums.
 
#Group all compilation type albums in one or more directories- eg Compilations, Soundtracks, Classical etc
 
#Add these compilation directories as  separate sources in Kodi and ensure it is named so that, alphabetically, it is the last directory in the list. (f:\zzMusic\zzCompilations\)
 
#Create Artist directories for artists that appear only on compilation albums, and place their artwork in those empty artist directories. This will allow Kodi to scrape the artwork, and then match it to the compilation artists when it eventually reaches the last directories. This method only works with cdART Manager.
 
  
  
Line 430: Line 173:
 
{{Top}}
 
{{Top}}
  
 
+
{{updated|18}}
{{updated|17}}
 
 
[[Category:FAQ]]
 
[[Category:FAQ]]
 
[[Category:Index]]
 
[[Category:Index]]
 
[[Category:Guides]]
 
[[Category:Guides]]
 
[[Category:Manual]]
 
[[Category:Manual]]
[[Category:Video library]]
+
[[Category:Karellen]]
[[Category:First Time User]]
+
[[Category:Music library]]
[[Category:Music library|*]]
+
[[Category:First time user]]
 
[[Category:Advanced topics]]
 
[[Category:Advanced topics]]
 
[[Category:Quick Start Guide]]
 
[[Category:Quick Start Guide]]

Latest revision as of 15:24, 26 May 2019

Artwork contents

See also:


Return to:

Report Artwork corrections:
here in the forum

Home icon grey.png   ▶ 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 enable local artwork from separate image files to be added when scanning new media items, the image files must be arranged in a certain folder hierarchy.
  • Each artwork type, other than the basic thumb and fanart types (that are sufficient for Estuary), must be whitelisted in advancedsettings.xml in order to be added to the library automatically during scanning or scraping.
  • Kodi 18 is required for expanded artwork type support in the music library.


1 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


2 Fetching Additional Artwork

v18 introduces an experimental feature that will auto-load extended artwork from local files without the use of additional add-ons, and can be adapted to future changes in the results returned by the music information providers (album and artist scrapers) without changes to Kodi itself. It is considered an advanced feature. Usage and practicality of this feature are being monitored and may change in later releases.

The common types of art available for items in the Music library can be categorised as follows:

Artist Artwork
Basic Art Types Extended Art Types
fanart thumb banner clearart clearlogo fanartxx (extrafanart) landscape
Album Artwork
Basic Art Types Extended Art Types
thumb back discart spine

Basic- These types of artwork require no special setup as they have always been natively fetched by Kodi from local files and by the default music scrapers. These are displayed by Estuary.

Extended- Many skins are more rich in art than Estuary and can show extended artwork as well. Historically cdART (now defunct) was used to fetch and apply this art, and more recently Artwork Beef is used.

Users now have the facility to load any type of artwork without add-ons providing either they have that art locally or use a scraper that returns that type of art. However the default skin Estuary does not display the extended art types, if you are using Estuary then there is no need to consider this feature.

To enable this feature first the art types must be whitelisted in advancedsettings.xml, an example is given below.

 1 <advancedsettings>
 2 	<musiclibrary>
 3 		<artistextraart>
 4 			<arttype>banner</arttype>
 5 			<arttype>clearart</arttype>
 6 			<arttype>clearlogo</arttype>
 7          <arttype>fanart1</arttype> <!-- Multiple fanart -->
 8          <arttype>fanart2</arttype> <!-- Add as many as required. -->
 9          <arttype>fanart3</arttype> 
10 			<arttype>landscape</arttype>
11 		</artistextraart>
12 		<albumextraart>
13 			<arttype>back</arttype>
14 			<arttype>discart</arttype>
15 			<arttype>spine</arttype>
16 		</albumextraart>
17 	</musiclibrary>
18 </advancedsettings>
Note: The code box adds common extended artwork that many 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.


Then decide where the art is going to come from, most likely this will be via the music scrapers. The Universal Artist Scraper and Universal Album Scraper for v18 can fetch extended types of artwork. They currently have settings that enable what art types are fetched as well as the remote sources these come from (see images below). This over complicates matters, where things come from will always be part of the scraper settings, but the decision what to apply belongs to Kodi and the whitelist. For now ensure that the types of art you want are enabled here too, so the scraper fetches a full list of the art available, but these settings should be simplified in due course.

Extended artwork can also be provide in correctly located and named local files. The general rule for local extended artwork file naming is <arttype>.<ext>, for where these need to be located see below.

Extended art from local files is automatically picked up and applied as part of music library scanning or scrapin When local art of the types in the whitelist is not found then the first avialable art of that type returned by the scraper is automatically applied as part of scraping.

The process applied is as described in What Artwork is Used Automatically


3 Local Artwork

All types of artwork can be read from and saved to local artwork files.

Local artist artwork can be located in the Artist information folder (shown in image) where the name of the artist subfolder does matter, or a common unique artist folder among your music files if Kodi can find one (where the name of the subfolder does not matter).

Local album artwork can be located in the album folder (shown in image). This folder is identified from the music files it contains, not the folder name.



4 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


5 Library Artwork Source Priority

Music artwork is automatically allocated using the following order:

  1. Local artwork files
    • Album and artist artwork from local files always takes precedence.
  2. Album cover artwork embedded in tracks (when "Prefer scraped album art" is disabled)
    • By default the first embedded front cover art found while processing the music files of the album is taken as the album cover.
  3. First available scraped art
    • The music information providers (scrapers) return lists of available artist and album artwork. The first of each the type of art for that artist or album is applied as the art if none has already been found locally.
    • Scraping only happens as part of library update if the option in Kodi Settings -> Media -> Music -> "Fetch additional information during updates" is enabled
  4. Album cover artwork embedded in tracks (when"Prefer scraped album art" is enabled)
    • Use of cover art from the music files can be unprioritised by enabling the "Prefer scraped album art" setting. This could be desirable if the embedded art is of low quality compared to what the scrapers may return.


Songs also have associated art, most of it is the art of the related album and artists but they can also have individual “thumb” type art automatically set. The thumb type artwork displayed for a song on both player OSD and library screens has a fallback strategy:

  1. Art embedded in that music file provided that all songs on an album do not have the same embedded art
  2. Falls back to album thumb. This is either from
    1. Local image file e.g. folder.jpg
    2. The common embedded art when that is the same in every music file in the album and "Prefer scraped album art" is disabled
    3. The remotely scraped album thumb result (when "Prefer scraped album art" is enabled or neither a) or b) are found)

This means that if the embedded art is a jumble, say one music file with a different image, then the musc player OSD will show the individual embedded art not the album cover however it is set.

6 File View Mode

File View 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 only provides the added benefits of album and artist extended artwork and information when viewing music files that have been scanned into the library (so album and artist enries exist) and these have been sucessfully scraped. However basic artwork from local files is supported for music files that are not scanned into the library.

For non-scanned music files and folders artwork in file view mode is as follows:

  • The only type of art supported is thumb artwork
  • Every folder in the hierarchical structure can have an associated “thumb” artwork. The “thumb” for the folder on display is picked up from any suitably named image file found in that folder.
  • A thumb for individual music files will be read from tag data embedded in the music file providing the Enable tag reading setting is enabled. Only front cover is currently supported.
  • These images are loaded automatically and cached when the folder or music file is first viewed


7 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