Settings/Media/Music: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
(Updated for v20)
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{bigger|This category contains the settings for how information for music is collected, stored, shown and navigated.}}
{{mininav| [[Settings]] | [[Settings/Media|Media]]  }}
 
__TOC__
__TOC__


= Library Display and Navigation =
[[File:Settings-Media-Music-01.jpg|600px]]
== Show "All items" entry ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show an "All items" entry in the music library views. eg. ''All albums'' or ''All artists''.
|}
== Show song and album artists ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When enabled both song and album artists are shown. When disabled only album artists are shown.
When disabled, artists that appear only on songs on compliation albums or as guest artist on an album by another artist are not listed.
|}




== All ==
== Split albums into individual discs ==
[[File:Settings_media_music_all.JPG|500px|right]]
=== Track naming template ===
{|
{|
|- valign="top"
|- valign="top"
Line 13: Line 38:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Controls the way that the names of songs are displayed in the UI. In order to function properly, ID3 tags need to be enabled.
| When enabled, opening an album that contains two or more discs will list the avaialble discs in the album or boxset. Select a disc to view the songs.
Disable the setting to display the songs instead of the discs. <ref>https://github.com/xbmc/xbmc/pull/16915</ref>
|}
 
 
== Use artist sortname when sorting by artist ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When Enabled, this setting will change the sort order of artists from name (''Taylor Swift'') to sortname (''Swift, Taylor''). Band/Group names are not affected.
|}
 
 
== Use original release date of albums for year ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled it allows albums to be sorted by the original album release date instead of the album re-release date.<ref>https://github.com/xbmc/xbmc/pull/17437</ref>
|}
|}




=== Search for thumbs on remote shares ===
 
= Library Information Sources =
[[File:Settings-Media-Music-02.jpg|600px]]
 
 
== Fetch additional information during updates ==
{|
{|
|- valign="top"
|- valign="top"
Line 24: Line 77:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| When this option is on, Kodi will search for thumbs on remote shares (which as of the time of writing includes DVD and CD media as well, due to the long seek/read times). This can often slow down listing of network folders quite dramatically (particularly if there are many items that have no thumbs), hence the option to turn it off.  
| When enabled album and artist additional information will be automatically fetched via scrapers from remote sites or NFO files, as the final phase of library scanning. This can be a slow process if you have a large music collection.
If this is the initial creation of your library, and you are unsure about the quality of your music file tagging, leave this setting disabled and first check the accuracy of your scanned music and fix tagging errors where required. The additional information can be fetched later from the Context Menu in the Artists and Albums listing.
|}
|}




== Files ==
== Artist information folder ==
[[File:Settings_media_music_files.JPG|500px|right]]
=== Enable tag reading ===
{|
{|
|- valign="top"
|- valign="top"
Line 37: Line 89:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Read the tag information from song files. For large directories this can increase read time, especially over a network.
| Select the folder where artist nfo files and local artwork are stored.  
|-
| '''See Also:'''
| '''''[[Artist information folder]]'''''
|}
|}
- Enabling tag reading will read the tag-information written in every song. This will slow down read time of large directories (particularly over a network), but will give, if properly named, a better description of your music files. If you wish to have the tag information without having to wait for them to load each time, you can “Scan” your songs from My Music:Songs. This will read the tags of all songs in this directory (and it's subdirectories) and add the information to the database (stored in the “albums” folder). Next time you go into that directory, Kodi will first look for the tag information in the database, which should speed up the directory loading.
{{-}}


== Library ==
 
[[File:Settings_media_music_library.JPG|500px|right]]
== Default provider for album information ==
=== Show "All items" entry ===
{|
{|
|- valign="top"
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}  
| width=120px | {{nowrap|'''Settings level:'''}}  
| Advanced
| Standard
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Show "All items" entry in directory, e. g. "All albums" or "All seasons".
| Selects the default album information provider (scraper) for albums.
|}
|}




=== Show song and album artists ===
== Default provider for artist information ==
{|
{|
|- valign="top"
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}  
| width=120px | {{nowrap|'''Settings level:'''}}  
| Basic
| Standard
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| When enabled, both song adn album artists are shown. When disabled, only album artists are shown and artists that appear only on individual song from an album are excluded.
| Selects the default album information provider (scraper) for artists.
|}
|}




=== Prefer online information ====
== Prefer online information ==
{|
{|
|- valign="top"
|- valign="top"
Line 73: Line 125:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Whith this enabled, any information that is downloaded for albums and artists will override anything you have set in your song tags, such as genres, year, song artist etc. useful if you have MusicBrainz identifiers in your song tags.
| When enabled some artist and album data in the library, which had been derived from music file tags, will be overwritten by information that is downloaded from the scraper site or from a NFO file.
For a list of library fields and tags that will be overwritten see '''[[NFO files/Music]]'''.
This will not modify the music file themselves in any way, only the library entries. However this option is being deprecated, only enable if you are absolutely sure you want to do it and understand the consequences. It can not be used to fix bad tagging of music files.
|}
|}




=== Fetch additional information during updates ===
 
= Artwork =
<gallery mode="packed" widths="600px" heights="337px">
File:Settings-Media-Music-03.jpg| Image 4 - Available settings for '''Maximum''' artwork level
File:Settings-Media-Music-04.jpg| Image 5 - Avaialble settings for the '''Custom''' artwork level
</gallery>
 
These are '''new artwork settings for v19'''. These settings replace the artwork settings in scrapers and the artwork tags in the advancedsettings.xml file which are no longer needed.<ref>https://github.com/xbmc/xbmc/pull/18173</ref>
 
 
== Artwork level ==
{|
{|
|- valign="top"
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}  
| width=120px | {{nowrap|'''Settings level:'''}}  
| Advanced
| Standard
|- valign="top"
| '''Description:'''
| Allows you to choose the types of artwork to be added to {{kodi}}. Options are:
* '''Maximum'''- (default) Scan or scrape all available '''[[Artwork types]]'''. When scanning local artwork, this setting is indiscriminate and will add ''all'' artwork found, even artwork that does not conform to {{kodi}}'s naming scheme, which will not be displayed unless you have modified the skin to do so. Users with messy folders should use the Custom option instead.
* '''Basic'''- For users with low powered and low storage devices, scrape the minimum of ''album/artist thumbs'' and ''fanart'' only.
* '''Custom'''- (image 2) Create a whitelist of artwork to be scanned or scraped. These advanced settings can be used to control where individual artwork types are scanned or scraped from. If artwork tags are available in the advancedsettings.xml file, these will be read and added to the custom settings on first run of {{kodi}}
* '''None'''- No artwork will be scanned or scraped.
|}
 
{{see|Artwork}}
 
The following four settings relate to the '''Custom''' setting.
 
 
== Use all local image files as artwork ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| The same as the ''Maximum'' setting but only applies to ''local'' artwork.
|}
 
 
== Use all remote artwork fetched by scrapers ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| The same as the ''Maximum'' setting but only applies to ''online'' artwork.
|}
 
 
== Artist art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Create a whitelist of Artist artwork to be used in the {{kodi}} library. Kodi standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}
 
 
== Album art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Create a whitelist of Album artwork to be used in the {{kodi}} library. Kodi standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}
 
 
== Thumbnail image files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Automatically fetches album and artist information via scrapers during scan.
| Nominate the name of album image files that {{kodi}} should search for in your album folders. The most common are pre-selected.
|}
|}




=== Default service for album information ===
== Prefer online album art ==
{|
{|
|- valign="top"
|- valign="top"
Line 95: Line 222:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Selects the default album information source, see the add-ons manager for options.
| When enabled and when no local album cover exists:
* Online art will be fetched from online providers and
* Embedded images in music files will only be used when neither local art or online art is available.<br>
This is useful if the covers embedded in music files are low resolution and the user would prefer the higher quality results fetched by the scraper.
|-
| '''See Also:'''
| '''''[[Music artwork#Library_Artwork_Source_Priority| Library Artwork Source Priority]]'''''
|}
|}




=== Default service for artist information ===
 
= General =
[[File:Settings-Media-Music-05.jpg|600px]]
 
 
== Switch to visualisation on playback ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Automatically switch to the fullscreen visualisation when playback commences.<ref>https://github.com/xbmc/xbmc/pull/17225</ref>
|}
 
 
== Track naming template ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Expert
|- valign="top"
| '''Description:'''
| The track naming template controls how names of songs are displayed in library views '''when sorted by track number'''.<br>
In order to extend this function to File view mode, the setting ''Enable tag reading in file view'' must be enabled.<br>
The default setting is '''[%N.]%A-%T''' which displays as '''''Track No.Artist name-Track name'''''
<section begin="Track naming template" />
{| class="prettytable"
|-
! scope="row"| Music Data
|  TrackNumber ||  DiscNumber ||  Artist ||  Title ||  Album ||  Genre ||  Year ||  FileName ||  Duration ||  Date ||  Rating ||  File Size ||  User Rating
|-
! scope="row"| Mask Characters
| style="text-align:center;" |  %N
| style="text-align:center;" |  %S
| style="text-align:center;" |  %A
| style="text-align:center;" |  %T
| style="text-align:center;" |  %B
| style="text-align:center;" |  %G
| style="text-align:center;" |  %Y
| style="text-align:center;" |  %F
| style="text-align:center;" |  %D
| style="text-align:center;" |  %J
| style="text-align:center;" |  %R
| style="text-align:center;" |  %I
| style="text-align:center;" |  %r
|}
'''Note:''' The above table details the commonly used masks for the music library.
A full list can be found in the Master branch [https://github.com/xbmc/xbmc/blob/master/xbmc/utils/LabelFormatter.cpp#L66 here]. This Master list is a combined video and music library listing for the current Master branch which may be a newer Kodi version to the one you have installed.
<section end="Track naming template" />
{| class="prettytable"
!colspan="2" style="width:150px; text-align:left" | Format Characters
!style="width:10px; text-align:left;" |
!colspan="2" style="text-align:left"| Usage Example
|-
! scope="row"| Bold
|  [[B]...[/B]] ||
| style="background-color:#d3d3d3;" | Raw tag
| [%N] [[I]%A[/I]] - %B : [[B]%T[/B]]
|-
! scope="row"| Italic
|  [[I]...[/I]] ||
| style="background-color:#d3d3d3;" | Output
| [track nr.] ''artist'' - album : '''title'''
|}
|-
|
| An example using coloured and italic text:<br>
''(note: the closing [/color] tag is intentionally omitted to overcome a bug)''
<syntaxhighlight lang="xml">
[[COLOR yellow][COLOR red]%A[/COLOR][COLOR white][B]] - %B[[/B][I] - %T[/I][/COLOR]][ - %N]
</syntaxhighlight>
With the more complex templates, it may be easier to directly edit the '''[[Userdata#guisettings.xml|GUI settings.xml]]''' file located in the '''[[Userdata]]''' folder, as shown in the below image. '''Exit {{kodi}} before performing this edit.'''
[[File:TrackNamingTemplate-01.jpg|1000px]]
|}
 
 
== Search for thumbs on remote shares ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When this option is enabled, Kodi will search for thumbs on network shares including DVD and CD.<br>
Due to the long seek/read times required to perform this function this will slow the listing of network folders quite dramatically (particularly if there are many items that have no thumbs).
|}
 
 
== Enable tag reading in file view ==
{|
{|
|- valign="top"
|- valign="top"
Line 106: Line 328:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Selects the default artist information source.
| Applies to File View only. When enabled, File view will display the song name from the embedded metadata along with other details rather than just the file name. However reading tags from every music file in real time can slow browsing the music files, especially for folders with a lot of music files or when accessed over a network. It is recommended that you can “Scan” your songs into the library by following the guide. Among many advantages this will allow File View to show additional song details without having to re-read tags everytime.
|}
|}
{{-}}
= References =
<references />
{{top}}
{{updated|20}}
[[Category:Settings]]

Latest revision as of 00:21, 17 January 2023

Home icon grey.png   ▶ Settings ▶ Media ▶ Music


Library Display and Navigation

Settings-Media-Music-01.jpg


Show "All items" entry

Settings level: Advanced
Description: Show an "All items" entry in the music library views. eg. All albums or All artists.


Show song and album artists

Settings level: Standard
Description: When enabled both song and album artists are shown. When disabled only album artists are shown.

When disabled, artists that appear only on songs on compliation albums or as guest artist on an album by another artist are not listed.


Split albums into individual discs

Settings level: Basic
Description: When enabled, opening an album that contains two or more discs will list the avaialble discs in the album or boxset. Select a disc to view the songs.

Disable the setting to display the songs instead of the discs. [1]


Use artist sortname when sorting by artist

Settings level: Standard
Description: When Enabled, this setting will change the sort order of artists from name (Taylor Swift) to sortname (Swift, Taylor). Band/Group names are not affected.


Use original release date of albums for year

Settings level: Advanced
Description: When enabled it allows albums to be sorted by the original album release date instead of the album re-release date.[2]


Library Information Sources

Settings-Media-Music-02.jpg


Fetch additional information during updates

Settings level: Advanced
Description: When enabled album and artist additional information will be automatically fetched via scrapers from remote sites or NFO files, as the final phase of library scanning. This can be a slow process if you have a large music collection.

If this is the initial creation of your library, and you are unsure about the quality of your music file tagging, leave this setting disabled and first check the accuracy of your scanned music and fix tagging errors where required. The additional information can be fetched later from the Context Menu in the Artists and Albums listing.


Artist information folder

Settings level: Standard
Description: Select the folder where artist nfo files and local artwork are stored.
See Also: Artist information folder


Default provider for album information

Settings level: Standard
Description: Selects the default album information provider (scraper) for albums.


Default provider for artist information

Settings level: Standard
Description: Selects the default album information provider (scraper) for artists.


Prefer online information

Settings level: Standard
Description: When enabled some artist and album data in the library, which had been derived from music file tags, will be overwritten by information that is downloaded from the scraper site or from a NFO file.

For a list of library fields and tags that will be overwritten see NFO files/Music. This will not modify the music file themselves in any way, only the library entries. However this option is being deprecated, only enable if you are absolutely sure you want to do it and understand the consequences. It can not be used to fix bad tagging of music files.


Artwork

These are new artwork settings for v19. These settings replace the artwork settings in scrapers and the artwork tags in the advancedsettings.xml file which are no longer needed.[3]


Artwork level

Settings level: Standard
Description: Allows you to choose the types of artwork to be added to Kodi. Options are:
  • Maximum- (default) Scan or scrape all available Artwork types. When scanning local artwork, this setting is indiscriminate and will add all artwork found, even artwork that does not conform to Kodi's naming scheme, which will not be displayed unless you have modified the skin to do so. Users with messy folders should use the Custom option instead.
  • Basic- For users with low powered and low storage devices, scrape the minimum of album/artist thumbs and fanart only.
  • Custom- (image 2) Create a whitelist of artwork to be scanned or scraped. These advanced settings can be used to control where individual artwork types are scanned or scraped from. If artwork tags are available in the advancedsettings.xml file, these will be read and added to the custom settings on first run of Kodi
  • None- No artwork will be scanned or scraped.
See: Artwork

The following four settings relate to the Custom setting.


Use all local image files as artwork

Settings level: Standard
Description: The same as the Maximum setting but only applies to local artwork.


Use all remote artwork fetched by scrapers

Settings level: Standard
Description: The same as the Maximum setting but only applies to online artwork.


Artist art types whitelist

Settings level: Standard
Description: Create a whitelist of Artist artwork to be used in the Kodi library. Kodi standard artwork is available for selection. Additional types can be added using the Add art type button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.


Album art types whitelist

Settings level: Standard
Description: Create a whitelist of Album artwork to be used in the Kodi library. Kodi standard artwork is available for selection. Additional types can be added using the Add art type button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.


Thumbnail image files

Settings level: Expert
Description: Nominate the name of album image files that Kodi should search for in your album folders. The most common are pre-selected.


Prefer online album art

Settings level: Standard
Description: When enabled and when no local album cover exists:
  • Online art will be fetched from online providers and
  • Embedded images in music files will only be used when neither local art or online art is available.

This is useful if the covers embedded in music files are low resolution and the user would prefer the higher quality results fetched by the scraper.

See Also: Library Artwork Source Priority


General

Settings-Media-Music-05.jpg


Switch to visualisation on playback

Settings level: Basic
Description: Automatically switch to the fullscreen visualisation when playback commences.[4]


Track naming template

Settings level: Expert
Description: The track naming template controls how names of songs are displayed in library views when sorted by track number.

In order to extend this function to File view mode, the setting Enable tag reading in file view must be enabled.
The default setting is [%N.]%A-%T which displays as Track No.Artist name-Track name

Music Data TrackNumber DiscNumber Artist Title Album Genre Year FileName Duration Date Rating File Size User Rating
Mask Characters %N %S %A %T %B %G %Y %F %D %J %R %I %r

Note: The above table details the commonly used masks for the music library. A full list can be found in the Master branch here. This Master list is a combined video and music library listing for the current Master branch which may be a newer Kodi version to the one you have installed.

Format Characters Usage Example
Bold [[B]...[/B]] Raw tag [%N] [[I]%A[/I]] - %B : [[B]%T[/B]]
Italic [[I]...[/I]] Output [track nr.] artist - album : title
An example using coloured and italic text:

(note: the closing [/color] tag is intentionally omitted to overcome a bug)

[[COLOR yellow][COLOR red]%A[/COLOR][COLOR white][B]] - %B[[/B][I] - %T[/I][/COLOR]][ - %N]

With the more complex templates, it may be easier to directly edit the GUI settings.xml file located in the Userdata folder, as shown in the below image. Exit Kodi before performing this edit. TrackNamingTemplate-01.jpg


Search for thumbs on remote shares

Settings level: Advanced
Description: When this option is enabled, Kodi will search for thumbs on network shares including DVD and CD.

Due to the long seek/read times required to perform this function this will slow the listing of network folders quite dramatically (particularly if there are many items that have no thumbs).


Enable tag reading in file view

Settings level: Standard
Description: Applies to File View only. When enabled, File view will display the song name from the embedded metadata along with other details rather than just the file name. However reading tags from every music file in real time can slow browsing the music files, especially for folders with a lot of music files or when accessed over a network. It is recommended that you can “Scan” your songs into the library by following the guide. Among many advantages this will allow File View to show additional song details without having to re-read tags everytime.



References



Return to top