NFO files/Music

From Official Kodi Wiki
Jump to: navigation, search
Steps to create your Music Library
1. Music File Tagging
2. Scanning Music Into Library
3. Scraping Additional Music Information
4. NFO Files
  • Music
5. Music_artwork

Report NFO corrections:
[https:// here in the forum]

Home icon grey.png   ▶ NFO_files ▶ Music


Contents

1 Requirements

As the Music section of Kodi has many differences to the Video section of Kodi, please read this section to ensure your music and artwork are correctly scraped and displayed.


1.1 Understanding the Music Library

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. It ignores the folder structure and file names you have created to store your music files. Basic and correct tagging is essential to ensure the library is populated correctly. Having slight variations in the tags for artist and album names could mean duplicated and unwanted entries.


1.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 files. This is referred to as scraping.


  • Scraping of additional artist and album information does not happen when you run a library update (including when first adding a source) unless "Fetch additional info on update" is enabled. Currently this defaults to disabled. It is recommended to keep this 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.



1.3 Music nfo Specific Requirements

  • A number of database fields can be populated initially by music file tags, but then be overwritten by online or nfo scraping. Whether this occurs depends on the setting Prefer Online Information in Settings>Media Settings>Music. If disabled, these fields will remain with the data scanned from the Music File tags. If enabled these fields will be overwritten by information obtained from either the online or local nfo file scrape. The affected fields are shown below in the section Available nfo Tags
  • In the album.nfo the top level <artist> tag has been deprecated and is not shown in any sample nfo files. Applies to v12 and prior.
  • There is no XML tag for votes of individual Songs. This can only come from the music file tags. Album votes can come from either online or local nfo scraping.
  • FLAC rating contained within the Music File Tag is scored out of 100. Kodi converts this value to its equivalent value out of 10. Values less than 10 in the FLAC music file tag will return a rating of 0 in Kodi.


2 nfo Placement

Music will fetch additional album and album artist information from nfo files.

For additional album information each album needs to be in its own unique folder, and have a separate album.nfo file located there. See the first table below.

For additional album artist information each artist needs a separate artist.nfo file located in what Kodi determines as the unique common folder for that artist. Kodi does not fetch additional artist data for artists that only feature on songs, either on compilation albums or as guest artists on songs in albums by others, and you do not have any albums by them in your collection.

Note: There are weaknesses in the way that Kodi determines the location of the artist folder. It looks for the folder that is common to all the songs with that album artist, the name of that folder is irrelevent. If you have multiple albums by an artist all under an artist folder then this works perfectly. However the algorithm does not work for collaboration albums, those that have more than one album artist e.g. "Riding with the King" by Eric Clapton and BB King, or classical music with composer, orchestra and conductor given as the album artist. Also if you have not kept all songs by an artist under a unique folder, then the artist directory will probably be mis-identified. The result is that Kodi can find the wrong artist.nfo file, and give the artist some other artist's information, or fail to fine the artist.nfo you created

Naming & Saving conventions for your Music Artist *.nfo files:

Saved Artist as File Name Save Location
Artist\Album\Songs artist.nfo f:\MyMusic\Stevie Nicks\artist.nfo


Naming & Saving conventions for your Music Album *.nfo files:

Saved Album as File Name Save Location
Artist\Album\Songs album.nfo f:\MyMusic\Stevie Nicks\Crystal Visions\album.nfo
  • The PERFORMER tag can contain many different kinds of musician tags, including ARTIST, ARRANGER, COMPOSER, CONDUCTOR, DJMIXER, ENGINEER, LYRICIST, MIXER, PRODUCER, REMIXER and PERFORMER


3 Available nfo Tags

The following two tables list the available tags that can be used in each nfo file. The Album nfo section includes an example nfo for collaboration type albums.


3.1 Artist nfo

NFO (xml) Tag Required Overwrites Multiple ** Notes
<artist></artist> Yes No No The top level parent tag for the nfo file. All other tags must be contained within these two tags
<name></name> No Yes No Overwrites artist name in artist table, when "prefer online info" is "enabled". Does not change that name anywhere else
<musicBrainzArtistID></musicBrainzArtistID> No No No Exported but not imported
<genre></genre> No No Yes Artist genre is not related to song genre.
Used for display only.
<style></style> No No Yes
<mood></mood> No No Yes
<yearsactive></yearsactive> No No Yes
<instruments></instruments> No No Yes
<born></born> No No No
<formed></formed> No No No
<biography></biography> No No No
<died></died> No No No
<disbanded></disbanded> No No No
<thumb preview="path"></thumb> No No Yes Path to available online artist images.
Importing will also accept paths to local art files which can subsequently be exported

Export to Single File will export a single path. Export to Separate Files will export multiple paths.

<path></path> No No No Exported but not used on Import
<fanart>
  <thumb preview=""></thumb>
</fanart> 
No No Yes Path to available online artist images.
Importing will also accept paths to local art files which can subsequently be exported

Export to Single File will not export any paths. Export to Separate Files will export multiple paths.

<album>
  <title></title>
  <year></year>
</album>
No No Yes Artist discography.
A scraped listing not releated to the albums in the library
<art>
  <fanart></fanart>
  <thumb preview="path"></thumb>
</art>
No No Yes Path to currently selected artwork. Exported to single file nfo only. Not used on import.
Notes
** With multiple value fields those values are entered using XML tag per value, and when no data exists, the XML tag will not be created on expor


3.2 Album nfo

NFO (xml) Tag Required Overwrites Multiple ** Notes
<album></album> Yes No No The top level parent tag for the nfo file. All other tags must be contained within these two tags
<title></title> Yes Yes No
<musicBrainzAlbumID></musicBrainzAlbumID> No Yes No
<artistdesc></artistdesc> Yes No No XML Tag created on Export, not used on Import
<genre></genre> No Yes Yes
<style></style> No Yes Yes
<mood></mood> No Yes Yes
<theme></theme> No Yes Yes
<compilation></compilation> Yes Yes No
<review></review> No Yes No
<type></type> No Yes No
<releasedate></releasedate> No No No Empty XML Tag created on Export, not used on Import/scrape
<label></label> No Yes No
<thumb preview="path"></thumb> No No Yes Path to available online artwork
Importing will also accept paths to local art files which can subsequently be exported
<path></path> Yes No No Exported but not used on Import
<rating max="10"></rating> No Yes No
<userrating max="10"></userrating> No No No
<votes></votes> No Yes No
<year></year> No Yes No
<albumArtistCredits>
  <artist></artist>
  <musicBrainzArtistID></musicBrainzArtistID>
</albumArtistCredits>
Yes Yes Yes
<track>
   <musicBrainzTrackID></musicBrainzTrackID>
   <title></title>
   <position></position>
   <duration></duration>
 </track>
Yes Yes Yes Not related in any way to the songs in the music library.

It is used by the albuminfosong table which simply provides descriptive data used by some skins.
musicBrainzTrackID is exported in error and will always be empty.
Can be safely ignored if creating your own nfo files.

<releasetype></releasetype> No No No Appears by mistake. Is not used
Notes
** With multiple value fields those values are entered using XML tag per value, and when no data exists, the XML tag will not be created on export


4 Sample nfo Files

An example of the artist.nfo and the album.nfo are provided. Use these as a guide to create your own nfo files, or to determine errors in your own files.


4.1 Artist nfo

Sample Music Artist nfo extracted from Single File Export. Click the Expand button, to the right, to view


4.2 Music Album nfo

Sample Music Album nfo. Click Expand, to the right, to view.


5 Technical Details

The information in this section is provided for technical interest and reference only. It can be safely disregarded if you have no technical interest in nfo and database functions

  • The data within the nfo file should, theoretically, all go to/come from somewhere in the database but, because the content source of the data field can be diverse, the data does not always come from a single source or go to a single database field. Scanning is not just about reading data but processing it too. As some fields are initially set from tags and can then be overwritten by nfo data, there is also a merge process involved in scraping.
  • There exist peculiarities with some XML tags in the nfo files:
    • <name> in artist.nfo can overwrite the name of the artist in the artist table, if "prefer online info" is "enabled", but does not change that name anywhere else
    • <releasedate> is required as part of the internal function of the online scraping process. It does not map directly to any db field, and nothing (currently) happens with its data. Exporting the library to nfo files will create an empty XML tag. It is not used during import/scrape.
    • <artistdesc> tag in the album.nfo file is related to the strArtists field of the album table of the database. It is derived from ALBUMARTIST and ALBLUMARTISTS tags from the music file tags. If those two tags are empty, then it will be derived from ARTIST and ARTISTS tags in the music files. It is exported to album.nfo as <artistdesc> but the value is not imported/scraped.
    • <releasetype> appears in the album.nfo by mistake. It is an internal flag that, in nfo files, will always be output as <releasetype>album</releasetype>, and it is ignored during import/scrape of the nfo file. It relates to the strReleaseType field of the album table in the database. It does not relate to the RELEASETYPE tag in the MusicFile, which connects to <type> in album.nfo.
    • <track> XML tag, and its children tags in the album.nfo, are not related in any way to the songs in the music library or in the Song table of the database. This XML tag and its children are related to the albuminfosong table which simply provides more descriptive details of the album, which can be displayed by some skins. The presence of <musicBrainzTrackID> under <track> is a mistake and is always empty. It is recommended that when creating your own nfo, that these XML tags be omitted from the album.nfo. These XML tags have been removed in v18.
  • There are music file tags that are not saved to the database, therefore there are no XML tags. The music file tags are accessed by the music player at the commencement of playback.
Music File Tags Not Stored In DB
MUSICBRAINZ_TRACKID
CUESHEET
LYRICS
REPLAYGAIN_TRACK_GAIN
REPLAYGAIN_ALBUM_GAIN
REPLAYGAIN_TRACK_PEAK
REPLAYGAIN_ALBUM_PEAK
METADATA_BLOCK_PICTURE or COVERART or COVERARTMIME
  • In music the only XML tags with a qualifier is Rating and User Rating. It limits the maximum score that is possible for the given rating. This is relevant as Kodi switched from a maximum 5 rating to a maximum of 10 rating.
  • A FLAC file can have a cuesheet embedded in the CUESHEET tag. In v17 and prior there is a Cue table in the Database to make possible replaygain handling during playback for those kinds of files, but this slowed down Kodi for all users, even when no cuesheets were in the music file. v17 removed ReplayGain handling, so there is no replay gain applied for songs from FLAC with embedded cuesheets. This made the songs node 30% faster. This function has been redesigned and will be re-implemented in v18.


There are differences in tags used by Single File Export and Separate File Export. Though testing reveals that transposing tages between the two has no detrimental affect on the scrape.

Artist nfo
XML Tag Exported in

Single File

Exported in

Separate File

Notes
<art>
  <fanart></fanart>
  <poster></poster>
</art>
Yes No Path to currently selected artwork. Exported to single file nfo only. Not used on import.


Return to top


Personal tools
Namespaces

Variants
Actions
Navigation
Wiki help
Toolbox