Difference between revisions of "NFO files/Music"

From Official Kodi Wiki
Jump to: navigation, search
(Technical Details: Correct music files tags not stored in DB)
(type-o's)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{|class="infobox" style="width:280px"
+
{{NFO_content}}
! Steps to create your Music Library
 
|-
 
|<small>1. [[Music_tagging|Music File Tagging]]</small>
 
|-
 
|<small>2. Scanning Music Into Library</small>
 
|-
 
|<small>3. Scraping Additional Music Information</small>
 
|-
 
|4. '''[[NFO_files|NFO Files]]'''
 
:*'''[[NFO files/Music|Music]]'''
 
|-
 
|<small>5. [[Music_artwork]]</small>
 
 
 
<small>Report NFO corrections:<br />
 
[https:// here in the forum]</small>
 
|}
 
{{mininav|[[NFO_files]]}}
 
 
 
 
 
 
 
= Requirements =
 
{{Red|'''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.'''}}
 
 
 
 
 
 
 
== Understanding the Music Library ==
 
{{#lst:Music_artwork|understanding}}
 
 
 
  
 +
{{mininav|[[NFO files]]}}
  
== Adding Music to Library ==
 
{{#lst:Music_artwork|adding}}
 
  
  
 +
= General =
 +
Unlike the video library, {{kodi}} cannot create library entries for music from nfo files. Instead, {{kodi}} scans the embedded tags in the song files to create the library entries. The nfo files can then be used to add additional information to what has already been scanned into the library from the embedded music file tags. The music library uses two types of NFO files- one for artists (''artist.nfo'') and one for albums (''album.nfo'').
  
== Music nfo Specific Requirements ==
+
Some additional points:
*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 [[NFO_files/Music#Available_nfo_Tags|Available nfo Tags]]  
+
<section begin="MusicNFOSpecific" />*A number of database fields can be populated initially by music file tags, but then be overwritten by online scraping or nfo scanning. Whether this occurs depends on the setting '''Prefer Online Information''' in ''[[Settings/Media/Music#Prefer_online_information|Settings>Media>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 scrape or local nfo file scan. The affected fields are shown in the tables below. If you are satisfied with your tagging, leave this item disabled.<section end="MusicNFOSpecific" />
*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.
+
*v18 introduces the '''''[[Artist information folder]]''''' which enables the use of local artwork and information (nfo files) for all artists, not just album artists as in previous versions. This is of benefit for collaboration albums, various artist releases and classical recordings to name a few.
 
*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.
 
*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.<br />
 
 
 
 
= 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}}
+
= nfo Name and Location =
 +
Music scanners will fetch additional artist and album information from nfo files when available.
  
<div style="{{linear-gradient|bottom|#f5d3ff, #12b2e7}}">
+
For additional '''artist''' information each artist needs a separate ''artist.nfo'' file inside the artist subfolder located in the '''''[[Artist information folder]]'''''. The correct name of the artist subfolder does matter. See left image below
'''''Naming & Saving conventions for your Music Artist *.nfo files:'''''
 
{|
 
|- valign="top"
 
| width=200px |'''''Saved Artist as'''''
 
| width=300px |'''''File Name'''''
 
| width=600px |'''''Save Location'''''
 
|- valign="top"
 
| width=200px |Artist\Album\Songs
 
| width=300px |artist.nfo
 
| width=600px |f:\MyMusic\Stevie Nicks\artist.nfo
 
|}
 
</div>
 
  
 +
For additional '''album''' information each album needs to be in its own unique folder, and have a separate ''album.nfo'' file located there. See right image below
  
<div style="{{linear-gradient|top|#f5d3ff, #12b2e7}}">
 
'''''Naming & Saving conventions for your Music Album *.nfo files:'''''
 
{|
 
|- valign="top"
 
| width=200px |'''''Saved Album as'''''
 
| width=300px |'''''File Name'''''
 
| width=600px |'''''Save Location'''''
 
|- valign="top"
 
| width=200px |Artist\Album\Songs
 
| width=300px |album.nfo
 
| width=600px |f:\MyMusic\Stevie Nicks\Crystal Visions\album.nfo
 
|}
 
</div>
 
*The PERFORMER tag can contain many different kinds of musician tags, including ARTIST, ARRANGER, COMPOSER, CONDUCTOR, DJMIXER, ENGINEER, LYRICIST, MIXER, PRODUCER, REMIXER and PERFORMER
 
  
 +
<gallery mode="packed" widths="1000px" heights="562px">
 +
File:LocalMusicArtwork01.jpg| '''''Artist Information Folder in use detailing artwork and nfo file (left image)<br> Album folder containing songs from a single album along with artwork and nfo file (right image)'''''
 +
</gallery>
  
  
= Available nfo Tags =
+
= Artists =
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.
+
This section deals with the requirement for the artist.nfo file.  
  
  
 +
== nfo Tags ==
 +
The following table lists the available tags that can be used in the artist.nfo file.
  
== Artist nfo ==
 
  
 
{|class="prettytable"
 
{|class="prettytable"
! NFO (xml) Tag || Required || Overwrites || Multiple ** || Notes
+
! 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
 
|<artist></artist> || Yes || No || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
Line 100: Line 45:
 
|<musicBrainzArtistID></musicBrainzArtistID> || No || No || No || Exported but not imported  
 
|<musicBrainzArtistID></musicBrainzArtistID> || No || No || No || Exported but not imported  
 
|-
 
|-
|<genre></genre> || No || No || Yes || Artist genre is not related to song genre. <br />Used for display only.
+
|<sortname></sortname> || No || Yes || No ||
 +
|-
 +
|<type></type> || No || No || No ||
 +
|-
 +
|<gender></gender> || No || No || No ||
 +
|-
 +
|<disambiguation></disambiguation> || No || No || No ||
 +
|-
 +
|<genre></genre> || No || No || Yes || Artist genre is not related to song genre
 
|-
 
|-
 
|<style></style> || No || No || Yes ||  
 
|<style></style> || No || No || Yes ||  
Line 120: Line 73:
 
|<disbanded></disbanded> || No || No || No ||  
 
|<disbanded></disbanded> || No || No || No ||  
 
|-
 
|-
|<thumb preview="path"></thumb> || No || No || Yes || Path to available online artist images. <br />Importing will also accept paths to local art files which can subsequently be exported <br />
+
|<thumb aspect="" preview="""></thumb> || No || No || Yes || Path to available online artist images. <br />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  
 
|<path></path> || No || No || No || Exported but not used on Import  
Line 129: Line 81:
 
   <thumb preview=""></thumb>
 
   <thumb preview=""></thumb>
 
  </fanart>  
 
  </fanart>  
|| No || No || Yes || Path to available online artist images. <br />Importing will also accept paths to local art files which can subsequently be exported <br />
+
|| No || No || Yes || Path to available online artist images. <br />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.
 
 
|-
 
|-
 
|
 
|
Line 138: Line 89:
 
  </album>
 
  </album>
 
|| No || No || Yes || Artist discography. <br />A scraped listing not releated to the albums in the library  
 
|| No || No || Yes || Artist discography. <br />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.
 
 
|}
 
|}
  
Line 150: Line 94:
 
!'''Notes'''
 
!'''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
+
|* || If the setting Prefer Online Information in Settings>Media>Music. If enabled, these items may be overwritten in the library database.
 +
|-
 +
|** || With multiple value fields those values are entered using an XML tag per value. When no data exists the XML tag will not be created on export
 
|}
 
|}
  
  
  
== Album nfo ==
+
== Template nfo ==
 +
A template NFO File is provided below that can be copied into your own file and completed.
 +
 
 +
<syntaxhighlight lang="xml">
 +
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
 +
<artist>
 +
    <name></name>
 +
    <sortname></sortname>
 +
    <type></type>
 +
    <gender></gender>
 +
    <disambiguation></disambiguation>
 +
    <genre></genre>
 +
    <style></style>
 +
    <mood></mood>
 +
    <yearsactive></yearsactive>
 +
    <born></born>
 +
    <formed></formed>
 +
    <biography></biography>
 +
    <died></died>
 +
    <disbanded></disbanded>
 +
</artist>
 +
</syntaxhighlight>
 +
 
 +
 
 +
 
 +
== Sample nfo ==
 +
An example of the ''artist.nfo'' is provided below. Click '''Expand''' to view.
 +
 
 +
{{collapse top| Music Artist nfo file  (click 'expand' to view)}}
 +
<syntaxhighlight lang="xml">
 +
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
 +
<artist>
 +
    <name>U2</name>
 +
    <musicBrainzArtistID>a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432</musicBrainzArtistID>
 +
    <sortname>U2</sortname>
 +
    <type></type>
 +
    <gender></gender>
 +
    <disambiguation>Irish rock band</disambiguation>
 +
    <genre>Rock</genre>
 +
    <style>Rock/Pop</style>
 +
    <mood>Political</mood>
 +
    <born></born>
 +
    <formed>Dublin, Ireland (1976)</formed>
 +
    <biography>U2 are an Irish rock band from Dublin. Formed in 1976, the group consists of Bono (vocals and rhythm guitar), the Edge (lead guitar, keyboards, and vocals), Adam Clayton (bass guitar), and Larry Mullen, Jr. (drums and percussion). U2&apos;s early sound was rooted in post-punk but eventually grew to incorporate influences from many genres of popular music. Throughout the group&apos;s musical pursuits, they have maintained a sound built on melodic instrumentals. Their lyrics, often embellished with spiritual imagery, focus on personal themes and sociopolitical concerns.&#x0A;The band formed at Mount Temple Comprehensive School in 1976 when the members were teenagers with limited musical proficiency. Within four years, they signed with Island Records and released their debut album Boy. By the mid-1980s, U2 had become a top international act. They were more successful as a touring act than they were at selling records until their 1987 album The Joshua Tree which, according to Rolling Stone, elevated the band&apos;s stature &quot;from heroes to superstars&quot;. Reacting to musical stagnation and criticism of their earnest image and musical direction in the late 1980s, U2 reinvented themselves with their 1991 album, Achtung Baby, and the accompanying Zoo TV Tour; they integrated dance, industrial, and alternative rock influences into their sound, and embraced a more ironic and self-deprecating image. They embraced similar experimentation for the remainder of the 1990s with varying levels of success. U2 regained critical and commercial favour in the 2000s with the records All That You Can&apos;t Leave Behind (2000) and How to Dismantle an Atomic Bomb (2004), which established a more conventional, mainstream sound for the group. Their U2 360° Tour of 2009–2011 is the highest-attended and highest-grossing concert tour in history.&#x0A;U2 have released 13 studio albums and are one of the world&apos;s best-selling music artists of all time, having sold more than 170 million records worldwide. They have won 22 Grammy Awards, more than any other band; and, in 2005, were inducted into the Rock and Roll Hall of Fame in their first year of eligibility. Rolling Stone ranked U2 at number 22 in its list of the &quot;100 Greatest Artists of All Time&quot;, and labelled them the &quot;Biggest Band in the World&quot;. Throughout their career, as a band and as individuals, they have campaigned for human rights and philanthropic causes, including Amnesty International, the ONE/DATA campaigns, Product Red, War Child and the Edge&apos;s Music Rising.</biography>
 +
    <died></died>
 +
    <disbanded></disbanded>
 +
    <thumb aspect="poster" preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistthumb/u2-50104c356fd2b.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistthumb/u2-50104c356fd2b.jpg</thumb>
 +
    <thumb aspect="poster" preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistthumb/u2-4fdf7ab5bfa99.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistthumb/u2-4fdf7ab5bfa99.jpg</thumb>
 +
    <thumb aspect="clearlogo" preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/hdmusiclogo/u2-538b320283c98.png">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/hdmusiclogo/u2-538b320283c98.png</thumb>
 +
    <thumb aspect="clearlogo" preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/hdmusiclogo/u2-538b3268cc581.png">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/hdmusiclogo/u2-538b3268cc581.png</thumb>
 +
    <thumb aspect="clearlogo" preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/hdmusiclogo/u2-55b02a97170c7.png">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/hdmusiclogo/u2-55b02a97170c7.png</thumb>
 +
    <thumb aspect="clearlogo" preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/hdmusiclogo/u2-538b39954caf1.png">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/hdmusiclogo/u2-538b39954caf1.png</thumb>
 +
    <thumb aspect="banner" preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/musicbanner/u2-59e65cba172de.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/musicbanner/u2-59e65cba172de.jpg</thumb>
 +
    <thumb aspect="banner" preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/musicbanner/u2-54063da8ca135.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/musicbanner/u2-54063da8ca135.jpg</thumb>
 +
    <thumb aspect="banner" preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/musicbanner/u2-503f9e062c802.JPG">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/musicbanner/u2-503f9e062c802.JPG</thumb>
 +
    <thumb aspect="banner" preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/musicbanner/u2-591ce819c91a5.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/musicbanner/u2-591ce819c91a5.jpg</thumb>
 +
    <thumb preview="https://www.theaudiodb.com/images/media/artist/thumb/qvuxvs1347997318.jpg/preview">https://www.theaudiodb.com/images/media/artist/thumb/qvuxvs1347997318.jpg</thumb>
 +
    <thumb aspect="clearlogo" preview="https://www.theaudiodb.com/images/media/artist/logo/qywsvv1347997327.png/preview">https://www.theaudiodb.com/images/media/artist/logo/qywsvv1347997327.png</thumb>
 +
    <thumb aspect="clearart" preview="https://www.theaudiodb.com/images/media/artist/clearart/vwpyxv1511531849.png/preview">https://www.theaudiodb.com/images/media/artist/clearart/vwpyxv1511531849.png</thumb>
 +
    <thumb aspect="landscape" preview="https://www.theaudiodb.com/images/media/artist/widethumb/wxsxwq1524669620.jpg/preview">https://www.theaudiodb.com/images/media/artist/widethumb/wxsxwq1524669620.jpg</thumb>
 +
    <thumb aspect="banner" preview="https://www.theaudiodb.com/images/media/artist/banner/rpqwpu1488384726.jpg/preview">https://www.theaudiodb.com/images/media/artist/banner/rpqwpu1488384726.jpg</thumb>
 +
    <path>E:\z-Music Artists\U2</path>
 +
    <fanart>
 +
        <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-4f805e377b181.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-4f805e377b181.jpg</thumb>
 +
        <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-5058bffb80200.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-5058bffb80200.jpg</thumb>
 +
        <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-4f805e377b5a0.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-4f805e377b5a0.jpg</thumb>
 +
        <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-4df96804ad0f3.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-4df96804ad0f3.jpg</thumb>
 +
        <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-5487022bd1524.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-5487022bd1524.jpg</thumb>
 +
        <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-50104bf699b84.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-50104bf699b84.jpg</thumb>
 +
        <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-4f805e377acdb.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/artistbackground/u2-4f805e377acdb.jpg</thumb>
 +
    </fanart>
 +
    <album>
 +
        <title>Pop</title>
 +
        <year>1997</year>
 +
    </album>
 +
    <album>
 +
        <title>How to Dismantle an Atomic Bomb</title>
 +
        <year>2004</year>
 +
    </album>
 +
    <album>
 +
        <title>Boy</title>
 +
        <year>1980</year>
 +
    </album>
 +
    <album>
 +
        <title>Pop</title>
 +
        <year>1997</year>
 +
    </album>
 +
    <album>
 +
        <title>The Joshua Tree</title>
 +
        <year>1987</year>
 +
    </album>
 +
    <album>
 +
        <title>Achtung Baby</title>
 +
        <year>1991</year>
 +
    </album>
 +
    <album>
 +
        <title>Zooropa</title>
 +
        <year>1993</year>
 +
    </album>
 +
</artist>
 +
 
 +
 
 +
</syntaxhighlight>
 +
{{collapse bottom}}
 +
 
 +
 
 +
 
 +
= Albums =
 +
This section deals with the requirement for the album.nfo file.
 +
 
 +
 
 +
== nfo Tags ==
 +
The following table lists the available tags that can be used in the album.nfo file.
 +
 
  
 
{|class="prettytable"
 
{|class="prettytable"
! NFO (xml) Tag || Required || Overwrites || Multiple ** || Notes
+
! 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
 
|<album></album> || Yes || No || No || The top level parent tag for the nfo file. All other tags must be contained within these two tags
Line 164: Line 223:
 
|<title></title> || No || Yes || No ||  
 
|<title></title> || No || Yes || No ||  
 
|-
 
|-
|<musicBrainzAlbumID></musicBrainzAlbumID> || No || No || No || Exported but tag not merged when scraped or imported
+
|<musicBrainzAlbumID></musicBrainzAlbumID> || No || No || No || Exported but tag not merged when scanned
 +
|-
 +
|<musicbrainzreleasegroupid></musicbrainzreleasegroupid> || No || No || No ||
 +
|-
 +
|<scrapedmbid></scrapedmbid> || No || No || No ||
 
|-
 
|-
|<artistdesc></artistdesc> || No || No || No || Exported but tag not merged when scraped or imported
+
|<artistdesc></artistdesc> || No || No || No || Exported but tag not merged when scanned
 
|-
 
|-
 
|<genre></genre> || No || Yes || Yes ||  
 
|<genre></genre> || No || Yes || Yes ||  
Line 182: Line 245:
 
|<type></type> || No || Yes || No ||  
 
|<type></type> || No || Yes || No ||  
 
|-
 
|-
|<releasedate></releasedate> || No || No || No || Empty XML tag exported, not not used when scraped or imported
+
|<releasedate></releasedate> || No || No || No || Empty XML tag exported, not not used when scanned
 
|-
 
|-
 
|<label></label> || No || Yes || No ||
 
|<label></label> || No || Yes || No ||
Line 188: Line 251:
 
|<thumb preview="path"></thumb> || No || No || Yes || Path to available online artwork <br />Importing will also accept paths to local art files which can subsequently be exported  
 
|<thumb preview="path"></thumb> || No || No || Yes || Path to available online artwork <br />Importing will also accept paths to local art files which can subsequently be exported  
 
|-
 
|-
|<path></path> || No || No || No || Exported but tag not used when scraped or imported
+
|<path></path> || No || No || No || Exported but tag not used when scanned
 
|-
 
|-
 
|<rating max="10"></rating> || No || No || No || Optional qualifier gives maximum value score is out of
 
|<rating max="10"></rating> || No || No || No || Optional qualifier gives maximum value score is out of
Line 203: Line 266:
 
   <musicBrainzArtistID></musicBrainzArtistID>
 
   <musicBrainzArtistID></musicBrainzArtistID>
 
  </albumArtistCredits>
 
  </albumArtistCredits>
|| No || Yes || Yes || Scraped album artist credits can replace those derrived from music file tags. Note even when overwrite is disabled missing album artists will be added
+
|| No || Yes || Yes || Scraped album artist credits can replace those derrived from music file tags.<br> Note even when overwrite is disabled missing album artists will be added
|-
 
|
 
<track>
 
    <musicBrainzTrackID></musicBrainzTrackID>
 
    <title></title>
 
    <position></position>
 
    <duration></duration>
 
  </track>
 
|| No || No || Yes || Album track listing. </br>
 
Not related in any way to the songs in the music library, it simply provides descriptive info used by some skins.<br />
 
<musicBrainzTrackID> will always be empty and can be safely ignored if creating your own nfo files.
 
 
|-
 
|-
|<releasetype></releasetype> || No || No || No || Exported with value "album", not used when scraped or imported. </br>
+
|<releasetype></releasetype> || No || No || No || Exported with value "album", not used when scanned. </br>
 
This is an internal flag.
 
This is an internal flag.
 
|}
 
|}
Line 223: Line 275:
 
!'''Notes'''
 
!'''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  
+
|* || If the setting Prefer Online Information in Settings>Media>Music. If enabled, these items may be overwritten in the library database.
 +
|-
 +
|** || With multiple value fields those values are entered using an XML tag per value. When no data exists the XML tag will not be created on export  
 
|}
 
|}
  
= 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.
 
  
  
 +
== Template nfo ==
 +
A template NFO File is provided below that can be copied into your own file and completed.
  
== Artist nfo ==
+
<syntaxhighlight lang="xml">
Sample Music Artist nfo extracted from Single File Export. Click the '''Expand''' button, to the right, to view
+
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
 
+
<album>
{{collapse top| Music Artist nfo file  (click 'expand' to view)}}
+
    <title></title>
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
+
    <genre></genre>
    <artist>
+
    <style></style>
        <name>Annie Lennox</name>
+
    <mood></mood>
        <musicBrainzArtistID>3e30aebd-0557-4cfd-8fb9-3945afa5d72b</musicBrainzArtistID>
+
    <theme></theme>  
        <genre>Soul</genre>
+
    <compilation></compilation>
        <style>Rock</style>
+
    <review></review>
        <style>Pop</style>
+
    <type></type>
        <mood>Bittersweet</mood>
+
    <label></label>
        <yearsactive>1970s - 2010s</yearsactive>
+
    <rating max="10"></rating>
        <born>Aberdeen, Scotland (1954)</born>
+
    <userrating max="10"></userrating>
        <formed></formed>
+
    <votes></votes>
        <biography>Ann &quot;Annie&quot; Lennox, OBE (born 25 December 1954) is a Scottish singer-songwriter, political activist and philanthropist. After achieving minor success in the late 1970s...</biography>
+
    <year></year>
        <died></died>
+
    <albumArtistCredits>
        <disbanded></disbanded>
+
         <artist></artist>
        <thumb preview="http://www.theaudiodb.com/images/media/artist/thumb/vtquqv1353945074.jpg/preview">http://www.theaudiodb.com/images/media/artist/thumb/vtquqv1353945074.jpg</thumb>
+
         <musicBrainzArtistID></musicBrainzArtistID>
        <path>E:\Music-Picard\Annie Lennox\</path>
+
    </albumArtistCredits>
        <fanart />
+
</album>
        <album>
+
</syntaxhighlight>
            <title>Medusa / Live in Central Park</title>
 
            <year>1995</year>
 
        </album>
 
         <album>
 
            <title>Medusa</title>
 
            <year>1995</year>
 
         </album>
 
        <album>
 
            <title>Songs of Mass Destruction</title>
 
            <year>2007</year>
 
        </album>
 
        <album>
 
            <title>Annie Lennox &amp; the BBC Concert Orchestra</title>
 
            <year>2007</year>
 
        </album>
 
        <album>
 
            <title>Nostalgia</title>
 
            <year>2014</year>
 
        </album>
 
        <album>
 
            <title>A Christmas Cornucopia</title>
 
            <year>2010</year>
 
        </album>
 
        <album>
 
            <title>Diva</title>
 
            <year>1992</year>
 
        </album>
 
        <album>
 
            <title>An Evening of Nostalgia With Annie Lennox</title>
 
            <year>2015</year>
 
        </album>
 
        <album>
 
            <title>Die Nixe • The Mermaid</title>
 
            <year>2001</year>
 
        </album>
 
        <art>
 
            <fanart>E:\Music-Picard\Annie Lennox\fanart.jpg</fanart>
 
            <thumb>E:\Music-Picard\Annie Lennox\folder.jpg</thumb>
 
        </art>
 
    </artist>
 
{{collapse bottom}}
 
  
  
  
== Music Album nfo ==
+
== Sample nfo ==
Sample Music Album nfo. Click '''Expand''', to the right, to view.
+
An example of the ''album.nfo'' is provided below. Click '''Expand''' to view.
  
 
{{collapse top| Music Album nfo file  (click 'expand' to view)}}
 
{{collapse top| Music Album nfo file  (click 'expand' to view)}}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
+
<syntaxhighlight lang="xml">
<album>
+
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
     <title>Symphony no. 5 & The Water Goblin</title>
+
<album>
     <musicBrainzAlbumID>df943086-8bb9-41fa-a984-b70be7286701</musicBrainzAlbumID>
+
     <title>The Best of 1980-1990</title>
     <artistdesc>Dvořák; Antonín Leopold</artistdesc>
+
     <musicbrainzalbumid>59b5a40b-e2fd-3f18-a218-e8c9aae12ab5</musicbrainzalbumid>
     <genre>Classical</genre>
+
     <musicbrainzreleasegroupid>6c301dbd-6ccb-3403-a6c4-6a22240a0297</musicbrainzreleasegroupid>
     <genre>Romantic</genre>
+
     <scrapedmbid>false</scrapedmbid>
     <style>Pastoral</style>
+
     <artistdesc>U2</artistdesc>
     <style>Old and slow</style>
+
     <genre>Pop</genre>
     <mood>Happy</mood>
+
     <style>Rock/Pop</style>
    <mood>Dramatic</mood>
+
     <mood>Political</mood>
    <theme>Fantasy theme of water gobin</theme>
 
    <theme>Gratefulness</theme>
 
 
     <compilation>false</compilation>
 
     <compilation>false</compilation>
     <review>Dvořák composed his fifth symphony in the summer months in June and July 1875. The opus number is actually incorrect. The autograph was marked with number 24, but the publisher Simrock gave this symphony a high...</review>
+
     <review>The Best of 1980-1990 is the first greatest hits compilation by Irish rock band U2, released in November 1998. It mostly contains the group&apos;s hit singles from the eighties but also mixes in some live staples as well as one new recording, Sweetest Thing. In April 1999, a companion video (featuring music videos and live footage) was released. The album was followed by another compilation, The Best of 1990-2000, in 2002.&#x0A;A limited edition version containing a special B-sides disc was released on the same date as the single-disc version. At the time of release, the official word was that the 2-disc album would be available the first week the album went on sale, then pulled from the stores. While this threat never materialized, it did result in the 2-disc version being in very high demand. Both versions charted in the Billboard 200.&#x0A;The boy on the cover is Peter Rowan, brother of Bono&apos;s friend Guggi (real name Derek Rowan) of the Virgin Prunes. He also appears on the covers of the early EP Three, two of the band&apos;s first three albums (Boy and War), and Early Demos.</review>
     <type>album; live recording</type>
+
     <type>album / compilation</type>
     <label>Chandos</label>
+
    <releasedate></releasedate>
     <thumb preview="http://www.theaudiodb.com/images/media/album/thumb/uuvuvt1389633744.jpg/preview">http://www.theaudiodb.com/images/media/album/thumb/uuvuvt1389633744.jpg</thumb>
+
     <label>Island</label>
     <path>N:\Music\Lib\Classical\Dvořák\Symphony no. 5 , The Water Goblin\</path>
+
     <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/albumcover/the-best-of-1980-1990-4e43a22cab023.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/albumcover/the-best-of-1980-1990-4e43a22cab023.jpg</thumb>
     <rating max="10">3.500000</rating>
+
    <thumb preview="https://assets.fanart.tv/preview/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/albumcover/the-best-of-1980-1990-5bc4301068645.jpg">https://assets.fanart.tv/fanart/music/a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432/albumcover/the-best-of-1980-1990-5bc4301068645.jpg</thumb>
     <userrating max="10">6</userrating>
+
    <thumb preview="https://www.theaudiodb.com/images/media/album/thumb/the-best-of-1980-1990-4e43a22cab023.jpg/preview">https://www.theaudiodb.com/images/media/album/thumb/the-best-of-1980-1990-4e43a22cab023.jpg</thumb>
     <votes>502</votes>
+
     <path>C:\KODI\Test- Music\U2\Best Of 1980-1990, The\</path>
     <year>1987</year>
+
     <rating max="10">-1.000000</rating>
    <albumArtistCredits>
+
     <userrating max="10">-1</userrating>
        <artist>Antonín Leopold Dvořák</artist>
+
     <votes>-1</votes>
        <musicBrainzArtistID>819eaeb2-8dd8-48a5-ad07-0bcd137985ef</musicBrainzArtistID>
+
     <year>1989</year>
    </albumArtistCredits>
 
    <albumArtistCredits>
 
        <artist>Scottish National Orchestra</artist>
 
        <musicBrainzArtistID>c6c4103b-cf07-42ad-91a7-b7eab7586e56</musicBrainzArtistID>
 
    </albumArtistCredits>
 
 
     <albumArtistCredits>
 
     <albumArtistCredits>
         <artist>Neeme J├ñrvi</artist>
+
         <artist>U2</artist>
         <musicBrainzArtistID>8a1d9496-603f-40b1-a38d-2e8985834940</musicBrainzArtistID>
+
         <musicBrainzArtistID>a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432</musicBrainzArtistID>
 
     </albumArtistCredits>
 
     </albumArtistCredits>
    <track>
 
        <musicBrainzTrackID></musicBrainzTrackID>
 
        <title>Symphony no. 5 in F major, op. 76: I. Allegro ma non troppo</title>
 
        <position>1</position>
 
        <duration>12:50</duration>
 
    </track>
 
    <track>
 
        <musicBrainzTrackID></musicBrainzTrackID>
 
        <title>Symphony no. 5 in F major, op. 76: II. Andante con moto</title>
 
        <position>2</position>
 
        <duration>07:49</duration>
 
    </track>
 
    <track>
 
        <musicBrainzTrackID></musicBrainzTrackID>
 
        <title>Symphony no. 5 in F major, op. 76: III. Scherzo. Allegro scherzando</title>
 
        <position>3</position>
 
        <duration>07:39</duration>
 
    </track>
 
    <track>
 
        <musicBrainzTrackID></musicBrainzTrackID>
 
        <title>Symphony no. 5 in F major, op. 76: IV. Finale. Allegro molto</title>
 
        <position>4</position>
 
        <duration>12:08</duration>
 
    </track>
 
    <track>
 
        <musicBrainzTrackID></musicBrainzTrackID>
 
        <title>The Water Goblin, op. 107</title>
 
        <position>5</position>
 
        <duration>20:39</duration>
 
    </track>
 
 
     <releasetype>album</releasetype>
 
     <releasetype>album</releasetype>
</album>
+
</album>
  
 +
</syntaxhighlight>
 
{{collapse bottom}}
 
{{collapse bottom}}
  
Line 403: Line 380:
  
  
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.
 
  
{|class="prettytable"
 
! colspan="23" style="background-color:#E6E6E6;" | '''Artist nfo<br/>'''
 
|-
 
! 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.
 
|}
 
  
  
Line 428: Line 387:
  
  
{{updated|17}}
+
{{updated|18}}
 
[[Category:FAQ]]
 
[[Category:FAQ]]
 
[[Category:Index]]
 
[[Category:Index]]
 
[[Category:Guides]]
 
[[Category:Guides]]
 
[[Category:Manual]]
 
[[Category:Manual]]
 +
[[Category:Karellen]]
 
[[Category:First time user]]
 
[[Category:First time user]]
 
[[Category:Music library]]
 
[[Category:Music library]]
 
[[Category:Advanced topics]]
 
[[Category:Advanced topics]]
 
[[Category:Quick Start Guide]]
 
[[Category:Quick Start Guide]]

Latest revision as of 22:45, 9 November 2019

NFO Contents

See also:


Return to:

Home icon grey.png   ▶ NFO files ▶ Music


1 General

Unlike the video library, Kodi cannot create library entries for music from nfo files. Instead, Kodi scans the embedded tags in the song files to create the library entries. The nfo files can then be used to add additional information to what has already been scanned into the library from the embedded music file tags. The music library uses two types of NFO files- one for artists (artist.nfo) and one for albums (album.nfo).

Some additional points:

  • A number of database fields can be populated initially by music file tags, but then be overwritten by online scraping or nfo scanning. Whether this occurs depends on the setting Prefer Online Information in Settings>Media>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 scrape or local nfo file scan. The affected fields are shown in the tables below. If you are satisfied with your tagging, leave this item disabled.
  • v18 introduces the Artist information folder which enables the use of local artwork and information (nfo files) for all artists, not just album artists as in previous versions. This is of benefit for collaboration albums, various artist releases and classical recordings to name a few.
  • 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.


2 nfo Name and Location

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

For additional artist information each artist needs a separate artist.nfo file inside the artist subfolder located in the Artist information folder. The correct name of the artist subfolder does matter. See left image below

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



3 Artists

This section deals with the requirement for the artist.nfo file.


3.1 nfo Tags

The following table lists the available tags that can be used in the artist.nfo file.


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
<sortname></sortname> No Yes No
<type></type> No No No
<gender></gender> No No No
<disambiguation></disambiguation> No No No
<genre></genre> No No Yes Artist genre is not related to song genre
<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 aspect="" preview="""></thumb> No No Yes Path to available online artist images.
Importing will also accept paths to local art files which can subsequently be exported
<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
<album>
  <title></title>
  <year></year>
</album>
No No Yes Artist discography.
A scraped listing not releated to the albums in the library
Notes
* If the setting Prefer Online Information in Settings>Media>Music. If enabled, these items may be overwritten in the library database.
** With multiple value fields those values are entered using an XML tag per value. When no data exists the XML tag will not be created on export


3.2 Template nfo

A template NFO File is provided below that can be copied into your own file and completed.

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<artist>
    <name></name>
    <sortname></sortname>
    <type></type>
    <gender></gender>
    <disambiguation></disambiguation>
    <genre></genre>
    <style></style>
    <mood></mood>
    <yearsactive></yearsactive> 
    <born></born>
    <formed></formed>
    <biography></biography>
    <died></died>
    <disbanded></disbanded>
</artist>


3.3 Sample nfo

An example of the artist.nfo is provided below. Click Expand to view.


4 Albums

This section deals with the requirement for the album.nfo file.


4.1 nfo Tags

The following table lists the available tags that can be used in the album.nfo file.


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> No Yes No
<musicBrainzAlbumID></musicBrainzAlbumID> No No No Exported but tag not merged when scanned
<musicbrainzreleasegroupid></musicbrainzreleasegroupid> No No No
<scrapedmbid></scrapedmbid> No No No
<artistdesc></artistdesc> No No No Exported but tag not merged when scanned
<genre></genre> No Yes Yes
<style></style> No No Yes
<mood></mood> No No Yes
<theme></theme> No No Yes
<compilation></compilation> No Yes No
<review></review> No No No
<type></type> No Yes No
<releasedate></releasedate> No No No Empty XML tag exported, not not used when scanned
<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> No No No Exported but tag not used when scanned
<rating max="10"></rating> No No No Optional qualifier gives maximum value score is out of
<userrating max="10"></userrating> No No No Optional qualifier gives maximum value score is out of
<votes></votes> No No No
<year></year> No Yes No
<albumArtistCredits>
  <artist></artist>
  <musicBrainzArtistID></musicBrainzArtistID>
</albumArtistCredits>
No Yes Yes Scraped album artist credits can replace those derrived from music file tags.
Note even when overwrite is disabled missing album artists will be added
<releasetype></releasetype> No No No Exported with value "album", not used when scanned. </br>

This is an internal flag.

Notes
* If the setting Prefer Online Information in Settings>Media>Music. If enabled, these items may be overwritten in the library database.
** With multiple value fields those values are entered using an XML tag per value. When no data exists the XML tag will not be created on export


4.2 Template nfo

A template NFO File is provided below that can be copied into your own file and completed.

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<album>
    <title></title>
    <genre></genre>
    <style></style>
    <mood></mood>
    <theme></theme> 
    <compilation></compilation>
    <review></review>
    <type></type>
    <label></label>
    <rating max="10"></rating>
    <userrating max="10"></userrating>
    <votes></votes>
    <year></year>
    <albumArtistCredits>
        <artist></artist>
        <musicBrainzArtistID></musicBrainzArtistID>
    </albumArtistCredits>
</album>


4.3 Sample nfo

An example of the album.nfo is provided below. Click Expand 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
LYRICS
REPLAYGAIN_TRACK_GAIN
REPLAYGAIN_ALBUM_GAIN
REPLAYGAIN_TRACK_PEAK
REPLAYGAIN_ALBUM_PEAK
  • 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.




Return to top