Music artwork

From Official Kodi Wiki
Revision as of 02:54, 10 July 2017 by Karellen (talk | contribs) (Numerous Edits)
Jump to: navigation, search
Artwork contents

See also:


Return to:

Report Artwork corrections:
here in the forum

Home icon grey.png   ▶ Artwork ▶ Music artwork


Music artwork are images directly related to an Artist or an Album, that are either scraped into the Music library from extenal sources or, in the case of Album art, scanned from the appropriate tags embedded in the music files. 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.

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.
  • 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.
  • The base line for all artwork is the default skin Estuary. By default, Estuary displays the Basic artwork. Estuary can not display the Extended artwork. Another skin must be used.
  • 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.


1 Requirements

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.

It is important to understand the fundamental difference between video library operation and the music library operation:

  • The video library is based on using the filenames to obtain online data. If the video files are incorrectly named, then there are no scraper results and there will be no library entry.
  • The music library is based on scanning tags embedded in the music files, not the filenames. Basic tagging is essential, the artists and albums in the library are derived from these tags.
  • Although you may have your music saved in an Artist\Album\Song folder hierarchy, Kodi does not use this structure to create albums or artists.
  • Populating the music library is a two step process.
    • The first step reads the tags embedded in the music files. This is referred to as scanning. If there is any embedded artwork, this will also be scanned and cached.
    • The second optional step fetches additional artwork, artist and album information. This information and artwork can be downloaded from either online sources or fetched from local files. This is referred to as scraping.
  • Scraping of additional artist and album information does not happen on library update (including when 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 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. In reality it is slowed down by the online scraping, and not the local tag scanning. This will be changed in v18 where Kodi will perform the initial tag scan then, once complete, will commence the online scrape.
    • The strategy of immediately scraping each album and artist as it is added can also have unwanted consequences. A common example involves compilation albums. Say for example you have both Fetch additional info on update and Show song and album artists is enabled, and a folder called "Compilations" containing all your Various Artist compliation albums. As the processing takes place in alphabetical order, this folder gets processed before the albums of artists in folders beginning with a letter later in the alphabet. The additional information for the song artists from these compilation albums gets added to the library and scraped before the other albums by that artist had been scanned, and so any artist.nfo file is never found and applied.
    • 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.
    • Scraping online also often leaves many gaps on first pass, then the user has to manually query for all anyway, often several times, to fill these gaps. This was because lack of correct throttling, and general server overload has meant that online scraping often failed (seen in the log as 503 server errors). This is expected to be fixed for v17.4 if released or v18.


This page details the following:

  • Adding and removing Sources
  • Scan (import) your music collection into the Music Library.
  • Troubleshooting common problems

A reminder of the following:


2 Adding Music to Library

  • Populating the music library is a two step process.
    • The first step reads the tags embedded in the music files. This is referred to as scanning. If there is any embedded artwork, this will also be scanned and cached.
    • The second optional step fetches additional artwork, artist and album information. This information and artwork can be downloaded from either online sources or fetched from local nfo files. This is referred to as scraping and is covered in detail in the next step of the guide.



2.1 Initial Set Source & Scan

This process achieves the following:

  • Sets your music source(s) in Kodi. Simply explained, this points Kodi to your music files
  • Allows Kodi to scan the tags in the music files and import that data into the library



At this point you should have a functioning Music Library


2.2 Adding Additional Music Sources


2.3 Scan to Library

In step 6 above, you were asked Do you want to add the media from this source to your library?

Click the below link if you selected No and would now like to add the music files into the library

See: Scan Source to Library


3 Troubleshooting


3.1 Library contains random or duplicated entries

This is a result of errors in tagging.

  1. Take note of the errors and correct them by following the recommended procedure in the previous step of the guide- Music Files and Tagging
  2. Once errors are corrected follow the steps detailed in Remove A Source
  3. Re-add the source using the Initial Set Source & Scan procedure detailed above


3.2 I cannot add a source on my network

Seek further information in Section 5 - Network Sources, below


If you have successfully scanned your music library, then you can safely ignore the next section and proceed to Scraping Additional Music Data


Next step: Artist Information Folder


4 Network Sources

Kodi gives you the ability to listen to music from a variety of sources.

See Types of Media Sources


Some examples of sources that allow you to easily access all your digital music collection:

  • On your computer or a NAS (Network Attached Storage) device/system, which supports SMB file sharing
  • Stored directly on the hard drive
  • On CDs/DVDs
  • Streamed from the Internet


If you use an non-standard network protocol to stream your media from a network, or for information on how to configure remote file shares


Return to top


Next step: Artist Information Folder



4.1 Caching

All music artwork is cached. If artwork is cached from local files Kodi will not access the local files again. The only exception to this is Extra Fanart which is not cached, and the skin access the image files directly.

Also be aware of image adjustments made by Kodi during the caching process. See Cache

Music artwork for the library is cached in the following order:

  • Artist
    1. Local artwork correctly named and placed as detailed paragraph 2
    2. Online artwork from the scraper site
  • Album
    1. Embedded artwork within the music file
    2. Local artwork correctly named and placed as detailed paragraph 2
    3. Online artwork from the scraper site


5 Basic Music Artwork

The artwork in the Basic section is the only artwork displayed by the default skin Estuary with a standard install.

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, the music files must be arranged in a certain folder heirarchy. There must be a unique Artist folder which then contains Album folders for all albums by that artist. These album folders contain the individual songs for that album.
  • This folder structure is only important if you want to use local artwork or NFO files for providing additional data, it does not contribute to the basic library contents. The library is populated with Artists and Albums by reading tags embedded in the music files, not the folder names or hierarchy.
  • Kodi does not use folder names to identify artists or albums, so you can name them however you like. It determines the location of the artist and album folders by analysing the file location of songs, and the artist and album of the song from music tags.
  • The algorthim used to determine the location of the artist and album folders has weaknesses. It can not handle collaborations (albums by more than one album artist e.g. orchestra and conductor), non-unique artist names, disc sets or singles. If local art is not being found then often it is because of the location of some of the song files connected to that artist or album.
  • It is useful to have separate/multiple music sources that separates standard artists and albums, that can easily be organised in a artist\album\song folder heirarchy, from those such as classical music, soundtracks, and compilations which can not.
See alsoThe AudioDB


5.1 Fanart- Artist

Artwork-MusicFanart01.jpg

Fanart, also known as Wallpapers, Backdrops or Backgrounds, are images that have, in most cases, been created by fans.

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.

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.

Required file properties:
Note: The resolution may be increased but ensure the aspect ratio is maintained

File Type Aspect Ratio Resolution- recommended
*.jpg or png 16:9 1920x1080

Naming and Saving conventions for your own manually sourced artwork:

Music saved as File Name Save name & location example
Artist\Album\Songs fanart.jpg (or *.png) f:\Music\Madonna\fanart.jpg (or *.png)


5.2 Artist Image

Artwork-MusicArtist01.jpg

The Artist Image is also known as Poster, Artist Thumb or just Thumb within Kodi, and is saved as folder.jpg within the artist folder. 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.

Required file properties:
Note: The resolution may be increased but ensure the aspect ratio is maintained

File Type Aspect Ratio Resolution- recommended
*.jpg or png 1:1 1000x1000

Naming and Saving conventions for your own manually sourced artwork:

Music saved as File Name Save name & location example
Artist\Album\Songs folder.jpg (or *.png) f:\Music\Madonna\folder.jpg (or *.png)


5.2.1 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.


5.3 Album Image

Artwork-MusicAlbum01.jpg

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 folder would have its own album Folder image. They are saved as folder.jpg inside the album folder. The image to the right is displaying the album images using the Infowall view in Estuary.

Required file properties:
Note: The resolution may be increased but ensure the aspect ratio is maintained

File Type Aspect Ratio Resolution- recommended
*.jpg or png 1:1 1000x1000

Naming and Saving conventions for your own manually sourced artwork:

Music saved as File Name Save name & location example
Artist\Album\Songs folder.jpg (or *.png) f:\Music\Madonna\Like A Prayer\folder.jpg (or *.png)


5.3.1 Manually Adding Album Artwork

From within Kodi, you have the ability to manually change the Album 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.


5.4 Source Folder Artwork

Artwork-VideoFolder01.jpg

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

<source>
   <name>music</name>
   <path>xbms://192.168.1.100:1400/Music/</path>
   <thumbnail>F:\Apps\XBMC\thumbs\shares\thumb.png</thumbnail>
</source>

Required file properties:
Note: The resolution may be increased but ensure the aspect ratio is maintained

File Type Aspect Ratio Resolution- recommended
*.jpg 16:9 640x360
*.jpg 1:1.5 400x600
*.jpg 1:1 500x500

Naming conventions for your own manually sourced artwork:

Source File Name Save name & location example
Folder Artwork: folder.jpg f:\Music\folder.jpg
Alternative name: <foldername>.jpg f:\Musc\Music.jpg


6 Extended Music Artwork

To display the Extended Music Artwork, the cdART Manager add-on must be installed via the Kodi official repository. A skin capable of handling the artwork must also be installed. Normally, installing a suitable skin will also install the cdART Manager add-on.

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, the music files must be arranged in a certain folder hierarchy. There must be a unique Artist folder which then contains Album folders for all albums by that artist. These album folders contain the individual songs for that album.
  • This folder structure is only important if you want to use local artwork or NFO files for providing additional data, it does not contribute to the basic library contents. The library is populated with Artists and Albums by reading tags embedded in the music files, not the folder names or hierarchy.
  • Kodi does not use folder names to identify artists or albums, so you can name them however you like. It determines the location of the artist and album folders by analysing the file location of songs, and the artist and album of the song from music tags.
  • The algorthim used to determine the location of the artist and album folders has weaknesses. It can not handle collaborations (albums by more than one album artist e.g. orchestra and conductor), non-unique artist names, disc sets or singles. If local art is not being found then often it is because of the location of some of the song files connected to that artist or album.
  • It is useful to have separate/multiple music sources that separates standard artists and albums, that can easily be organised in a artist\album\song folder heirarchy, from those such as classical music, soundtracks, and compilations which can not.
  • 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.
See alsoThe AudioDB


Artwork-MusicBanner01.jpg

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

Required file properties:
Note: The resolution may be increased but ensure the aspect ratio is maintained

File Type Aspect Ratio Resolution- recommended
*.jpg or png 1:0.185 1000x185

Naming and Saving conventions for your own manually sourced artwork:

Music saved as File Name Save name & location example
Artist\Album\Songs banner.jpg or *.png) f:\Music\Madonna\banner.jpg (or *.png)


Artwork-MusicBanner01.jpg

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

Required file properties:
Note: The resolution may be increased but ensure the aspect ratio is maintained

File Type Aspect Ratio Resolution- recommended
*.png 1:0.388 800x310

Naming and Saving conventions for your own manually sourced artwork:

Music saved as File Name Save name & location example
Artist\Album\Songs logo.png f:\Music\Madonna\logo.png


6.3 CD Art

Artwork-MusicBanner01.jpg

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.

Required file properties:
Note: The resolution may be increased but ensure the aspect ratio is maintained

File Type Aspect Ratio Resolution- recommended
*.png 1:1 1000x1000

Naming and Saving conventions for your own manually sourced artwork:

Music saved as File Name Save name & location example
Artist\Album\Songs cdart.png f:\Music\Madonna\Like A Prayer\cdart.png
or disc.png f:\Music\Madonna\Like A Prayer\disc.png


6.4 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.


7 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.

Maybe give the actual tag names in a table?
Perhaps explain the priority of embedded artwork over/under external local art files


8 Best Practice for Local Artwork

How to organise your music to work around the current limitations Kodi has in identifying where local art (and NFO files) may be located, and what can go wrong.

For a great deal of music, where albums have one album artist, using a unique artist\album\song folder hierarchy is the obvious way to organise your music, and Kodi will have no problems finding correctly named image files located in that structure. It can often happen without an user intervention too, as much tagging software such as Musicbrainz Picard will create a local album art files as part of the tagging process.


8.1 No Suitable Artist Folder

However it is not always possible to create a unique artist folder, with all the albums by that artist, and only that artist, in folders beneath it.

  • Collaborations

The obvious example is when an album has more than one album artist, this is very common with Classical music where the composer, orchestra and conductor are tagged as album artists, but also happens in popular music e.g. "Riding With The King" is a collaboration between BB King and Eric clapton, or "The Juliet Letters" by Elvis Costello and The Brodsky Quartet. There is no work around for providing local art for artists involved in collaborations like this. However the artist scraper will still be able to fetch online artwork for these artists.

  • Song Artists without Albums

Some artists may appear only on songs from Various Artists compilation albums, or as featured artist on songs on an album by another artist, but do not have any albums in your collection. These artists also do not have a unique folder containing all the songs they perform on, and so again there is no place to store local art.

The cdART Manager addon does support a way to provide local art for song artists that do not have albums of their own. It involves creating empty (no music files) Artist folders for those artists, and is sensive to the folder name matching the artist name exactly. However, cdART Manager will create such an empty folder for every song artist in your collection, that can be a lot of folders!

  • Other Artists: Composers, Producers, Mixers, Musicians etc.

From v17 Kodi processes the tags that descibe the other people involved and musicians etc. in a song. These may be artists with songs and albums in their own right, but often will include people that are do not appear in your music collection in any other role. Again no unique folder containing all the songs they perform on, and no place to store local art.


8.2 Compilations

Compliation albums also have a reputation for causing difficulties with scraping local artist art. This is mostly because of the unwanted consequences of immediately scraping each album and artist as each is added. (This is solved in v18).

One way to minimise this problem is to leave Fetch additional info on update disabled, and initiate scraping of album and artist information and artwork using "Query Information for All" from the context menu after scanning a new source has completed.

Another is to group all compilation albums under a separate folder, named so that, alphabetically, it is the last folder in the list to be processed. So for example if your normal album artists have folders Musicpath\artistname\ then use Musicpath\zzzCompilations\

It can also be useful to put the compliations folder on a completely separate path to where the normal album artist folders are located, and add it as a separate music source. So for example if your normal album artists have folders Musicpath1\artistname\ then use Musicpath2\zzzCompilations\


Return to top