NFO files/Music: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(type-o's)
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{NFO_content}}
{{mininav|[[NFO files]]}}
{{mininav|[[NFO files]]}}
== Music .nfo files ==


=== Music .nfo Files containing XML data ===


==== Artists ====
artist.nfo in the artist folder containing:


<syntaxhighlight lang="xml" enclose="div">
= 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:
<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" />
*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.
 
 
 
= 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
 
 
<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>
 


= Artists =
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.
{|class="prettytable"
! 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. <br />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. <br />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. <br />A scraped listing not releated to the albums in the library
|}
{|class="prettytable"
!'''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
|}
== 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>
<artist>
  <name>Artist/Band Name</name>
    <name></name>
  <genre clear=true>First Genre</genre>
    <sortname></sortname>
  <genre>Second Genre</genre>
    <type></type>
  ...
    <gender></gender>
  <genre>Nth Genre</genre>
    <disambiguation></disambiguation>
  <style clear=true>First Style</style>
    <genre></genre>
  <style>Second Style</style>
    <style></style>
  ...
    <mood></mood>
  <style>Nth Style<style>
    <yearsactive></yearsactive>  
  <mood clear=true>First Mood</mood>
    <born></born>
  <mood>Second Mood</mood>
    <formed></formed>
  ...
    <biography></biography>
  <mood>Nth Mood</mood>
    <died></died>
  <yearsactive clear=true>First year active (1993)</yearsactive>
    <disbanded></disbanded>
  <yearsactive>Second year active (1995)</yearsactive>
  ...
  <yearsactive>Nth year active (2000)</yearsactive>
  <born>Birth date of artist</born>
  <formed>Date band formed</formed>
  <instruments>Musical instruments used by artist/band</instruments>
  <biography>Artist/Band biography text</biography>
  <died>Date artist died</died>
  <disbanded>Date band broke up<disbanded>
  <thumb>/path/to/unix/style/artist/thumb1.tbn</thumb>
  <thumb>C:\path\to\win32\style\artist\thumb2.png</thumb>
  <thumb>http://path.to/www/remote/artist/thumb3.jpg</thumb>
  <thumb>smb://path/to/smb/remote/artist/thumbN.tbn</thumb>
  <album>
    <title>First Album Title</title>
    <year>Release year of first album</year>
  </album>
  ...
  <album>
    <title>Nth Album Title</title>
    <year>Release year of Nth album</year>
  </album>
</artist>
</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"
! 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 <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 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.<br> 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.
|}
{|class="prettytable"
!'''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
|}




== 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" ?>
<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>
</syntaxhighlight>
</syntaxhighlight>


{{note|Where indicated, tags can accept an optional "clear" boolean (true/false) attribute which clears corresponding scraped data and all values of similar tags up to that point.}}
==== Albums ====
album.nfo in the album folder containing:
<syntaxhighlight lang="xml" enclose="div">


== Sample nfo  ==
An example of the ''album.nfo'' is provided below. Click '''Expand''' to view.
{{collapse top| Music Album nfo file  (click 'expand' to view)}}
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<album>
<album>
  <title>The Album Title</title>
    <title>The Best of 1980-1990</title>
  <artist clear=true>First Artist</artist>
    <musicbrainzalbumid>59b5a40b-e2fd-3f18-a218-e8c9aae12ab5</musicbrainzalbumid>
  <artist>Second Artist</artist>
    <musicbrainzreleasegroupid>6c301dbd-6ccb-3403-a6c4-6a22240a0297</musicbrainzreleasegroupid>
  ...
    <scrapedmbid>false</scrapedmbid>
  <artist>Nth Artist</artist>
    <artistdesc>U2</artistdesc>
  <genre clear=true>First Genre</genre>
    <genre>Pop</genre>
  <genre>Second Genre</genre>
    <style>Rock/Pop</style>
  ...
    <mood>Political</mood>
  <genre>Nth Genre</genre>
    <compilation>false</compilation>
  <style clear=true>First Style</style>
    <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>
  <style>Second Style</style>
    <type>album / compilation</type>
  ...
    <releasedate></releasedate>
  <style>Nth Style<style>
    <label>Island</label>
  <mood clear=true>First Mood</mood>
    <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>
  <mood>Second Mood</mood>
    <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>
  ...
    <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>
  <mood>Nth Mood</mood>
    <path>C:\KODI\Test- Music\U2\Best Of 1980-1990, The\</path>
  <theme clear=true>First Theme</theme>
     <rating max="10">-1.000000</rating>
  <theme>Second Theme</theme>
     <userrating max="10">-1</userrating>
  ...
     <votes>-1</votes>
  <theme>Nth Theme</theme>
    <year>1989</year>
  <review>Album review text</review>
    <albumArtistCredits>
  <releasedate>Album release date</releasedate>
        <artist>U2</artist>
  <label>Record label the album was released under</label>
        <musicBrainzArtistID>a3cb23fc-acd3-4ce0-8f36-1e5aa6a18432</musicBrainzArtistID>
  <type>Erm...EP/LP? CD,Vinyl,DVDA,etc? I dunno</type>
     </albumArtistCredits>
  <year>Year album was released</year>
    <releasetype>album</releasetype>
  <rating>Rating out of 5?<rating>
  <thumb>/path/to/unix/style/album/thumb1.tbn</thumb>
  <thumb>C:\path\to\win32\style\album\thumb2.png</thumb>
  <thumb>http://path.to/www/remote/album/thumb3.jpg</thumb>
  ...
  <thumb>smb://path/to/smb/remote/thumbN.tbn</thumb>
  <track>
     <position>Track Number (1)</position>
     <title>Title of first track</title>
     <duration>Length of first track (XXX min, MM:SS)</duration>
  </track>
  ...
  <track>
    <position>Track Number (N)</position>
    <title>Title of Nth track</title>
     <duration>Length of Nth track</duration>
  </track>
</album>
</album>


</syntaxhighlight>
</syntaxhighlight>
{{collapse bottom}}


{{note|Where indicated, tags can accept an optional "clear" boolean (true/false) attribute which clears corresponding scraped data and all values of similar tags up to that point.}}


=== Music .nfo files containing an URL ===
= Technical Details =
{{Red|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}}<br />


==== Artists ====
*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.<br />
artist.nfo in the artist folder that points to the corresponding artist page on a supported scraper site, such as [http://www.allmusic.com Allmusic.com].
*There exist peculiarities with some XML tags in the nfo files:
<nowiki>http://www.allmusic.com/cg/amg.dll?p=amg&sql=11:gifoxqwkldae</nowiki>
**'''<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
artist.nfo assumes an artist/album directory layout
**'''<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 [[Databases#albuminfosong|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.<br />
*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.


==== Albums ====
{|class="prettytable"
album.nfo in the album folder that points to the corresponding album page on a supported scraper site, such as [http://www.allmusic.com Allmusic.com].
! Music File Tags Not Stored In DB
<nowiki>http://www.allmusic.com/cg/amg.dll?p=amg&sql=10:kifoxqualdde</nowiki>
|-
{{frodo updated}}
|LYRICS
|-
|REPLAYGAIN_TRACK_GAIN
|-
|REPLAYGAIN_ALBUM_GAIN
|-
|REPLAYGAIN_TRACK_PEAK
|-
|REPLAYGAIN_ALBUM_PEAK
|}


[[Category:Scraper]]
*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.
 
 
 
 
 
 
{{Top}}
 
 
{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:First time user]]
[[Category:Music library]]
[[Category:Music library]]
[[Category:Manual]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Revision as of 22:45, 9 November 2019

NFO Contents

NFO Main Page


See also:


Return to:

Home icon grey.png   ▶ NFO files ▶ Music


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.


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



Artists

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.


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


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>


Sample nfo

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


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.


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.

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


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>


Sample nfo

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


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