Import-export library/Music - Revision history

Karellen: Updated for v20

2023-02-07T22:00:12Z

Updated for v20

← Older revision		Revision as of 22:00, 7 February 2023
Line 270:		Line 270:

	{{top}}		{{top}}
			{{updated\|20}}

	~~{{updated\|18}}~~
	~~[[Category:FAQ]]~~
	~~[[Category:Index]]~~
	~~[[Category:Guides]]~~
	~~[[Category:Manual]]~~
	[[Category:Karellen]]		[[Category:Karellen]]
	[[Category:Music library]]		[[Category:Music library]]
	~~[[Category:Advanced topics]]~~
	~~[[Category:First time user]]~~
	~~[[Category:Quick Start Guide]]~~

Karellen at 21:07, 21 May 2020

2020-05-21T21:07:34Z

← Older revision		Revision as of 21:07, 21 May 2020
Line 95:		Line 95:
	</gallery>		</gallery>

	{{red\|Note: This option requires the [[Artist ~~Information Folder~~]] to be set.}}		{{red\|Note: This option requires the [[Artist information folder]] to be set.}}
	:'''''See: [[Settings/Media/Music#Library\|Artist Information Folder Setting]]'''''		:'''''See: [[Settings/Media/Music#Library\|Artist Information Folder Setting]]'''''

Karellen at 02:46, 21 February 2020

2020-02-21T02:46:25Z

← Older revision		Revision as of 02:46, 21 February 2020
Line 57:		Line 57:
	*Exports a single ''.xml'' file saved to a destination folder specified by the user.		*Exports a single ''.xml'' file saved to a destination folder specified by the user.
	*Each export is a full export. There are no incremental exports.		*Each export is a full export. There are no incremental exports.
	*The only method to export user rating, play counts, last played and scraped ratings and votes		*The only method to export user rating, play counts, last played and scraped ratings and votes. Requires v18.2 or later <ref name="PR15864" />
	*No artwork is exported.		*No artwork is exported.
	*Each file is named ''kodi_musicdbyyyymmdd_hhmmss''. The date is appended to all export files, and the time is only appended to subsequent exports on the same day. <ref>https://forum.kodi.tv/showthread.php?tid=319284&pid=2644557#pid2644557</ref>		*Each file is named ''kodi_musicdbyyyymmdd_hhmmss''. The date is appended to all export files, and the time is only appended to subsequent exports on the same day. <ref>https://forum.kodi.tv/showthread.php?tid=319284&pid=2644557#pid2644557</ref>
Line 73:		Line 73:

	:;Songs		:;Songs
	::Will export song rating and history information. This includes:		::Will export song rating and history information. Requires v18.2 or later <ref name="PR15864">https://github.com/xbmc/xbmc/pull/15864</ref>. This includes:
	::*User rating		::*User rating
	::*Scraped rating and votes		::*Scraped rating and votes

Karellen at 02:26, 16 February 2020

2020-02-16T02:26:35Z

← Older revision		Revision as of 02:26, 16 February 2020
Line 10:		Line 10:

	{{mininav\|[[Music_library\|Music Library]] \| [[Import-export_library\|Import Export Library]]}}		{{mininav\|[[Music_library\|Music Library]] \| [[Import-export_library\|Import Export Library]]}}
	{{see also\|NFO files\|Artwork\|~~HOW-TO:~~Backup ~~the video library~~}}		{{see also\|NFO files\|Artwork\|Backup}}

Karellen at 07:18, 7 September 2019

2019-09-07T07:18:56Z

← Older revision		Revision as of 07:18, 7 September 2019
Line 212:		Line 212:
	*Used to add new artist folders when new music is added to your library		*Used to add new artist folders when new music is added to your library
	*Requires setting the [[Artist information folder]]		*Requires setting the [[Artist information folder]]
			*Introduced in v18.2 <ref>https://github.com/xbmc/xbmc/pull/15821</ref>

Karellen at 19:07, 19 April 2019

2019-04-19T19:07:58Z

← Older revision		Revision as of 19:07, 19 April 2019
Line 19:		Line 19:
	The Import-Export function has been overhauled for v18 and adds more functionality and integrates the new '''[[Artist information folder]]'''.		The Import-Export function has been overhauled for v18 and adds more functionality and integrates the new '''[[Artist information folder]]'''.

	Song history and ratings are exported when using the Single File method in v18 and later. advancedsettings.xml entries are not required.		Song history and ratings are exported when using the Single File method in v18.2 and later. advancedsettings.xml entries are not required.


Line 57:		Line 57:
	*Exports a single ''.xml'' file saved to a destination folder specified by the user.		*Exports a single ''.xml'' file saved to a destination folder specified by the user.
	*Each export is a full export. There are no incremental exports.		*Each export is a full export. There are no incremental exports.
			*The only method to export user rating, play counts, last played and scraped ratings and votes
	*No artwork is exported.		*No artwork is exported.
	*Each file is named ''kodi_musicdbyyyymmdd_hhmmss''. The date is appended to all export files, and the time is only appended to subsequent exports on the same day. <ref>https://forum.kodi.tv/showthread.php?tid=319284&pid=2644557#pid2644557</ref>		*Each file is named ''kodi_musicdbyyyymmdd_hhmmss''. The date is appended to all export files, and the time is only appended to subsequent exports on the same day. <ref>https://forum.kodi.tv/showthread.php?tid=319284&pid=2644557#pid2644557</ref>

Karellen: Changes requested by daveblake

2019-04-19T09:16:19Z

Changes requested by daveblake

← Older revision		Revision as of 09:16, 19 April 2019
Line 19:		Line 19:
	The Import-Export function has been overhauled for v18 and adds more functionality and integrates the new '''[[Artist information folder]]'''.		The Import-Export function has been overhauled for v18 and adds more functionality and integrates the new '''[[Artist information folder]]'''.

	Song history and ratings are exported when using the Single File method in v18.2 and later. advancedsettings.xml entries are not required.		Song history and ratings are exported when using the Single File method in v18 and later. advancedsettings.xml entries are not required.


Line 26:		Line 26:
	:{{main\|Artist information folder}}		:{{main\|Artist information folder}}
	{{#lst:Artist_information_folder\|intro}}		{{#lst:Artist_information_folder\|intro}}

			{{#lst:Artist_information_folder\|intro1}}


Line 55:		Line 57:
	*Exports a single ''.xml'' file saved to a destination folder specified by the user.		*Exports a single ''.xml'' file saved to a destination folder specified by the user.
	*Each export is a full export. There are no incremental exports.		*Each export is a full export. There are no incremental exports.
	*The only method to export user rating, play counts, last played and scraped ratings and votes
	*No artwork is exported.		*No artwork is exported.
	*Each file is named ''kodi_musicdbyyyymmdd_hhmmss''. The date is appended to all export files, and the time is only appended to subsequent exports on the same day. <ref>https://forum.kodi.tv/showthread.php?tid=319284&pid=2644557#pid2644557</ref>		*Each file is named ''kodi_musicdbyyyymmdd_hhmmss''. The date is appended to all export files, and the time is only appended to subsequent exports on the same day. <ref>https://forum.kodi.tv/showthread.php?tid=319284&pid=2644557#pid2644557</ref>
Line 124:		Line 125:

	;Include art works such as thumbnails and fanart		;Include art works such as thumbnails and fanart
	:When enabled~~, will export~~ all ~~cached~~ artwork		:When enabled this also exports all the artwork associated with the exported artists and or albums as separate image files
	:~~{{red\|If you intend to export artwork~~ from cache, be ~~aware of~~ the ~~modifications that {{kodi}} makes to cached artwork~~. If you have local artwork, do ~~not export artwork~~.}}		:Note that Kodi exports the images from cache in the resolution that it uses them, and this may be lower than the original images. If you have original local artwork in higher resolutions take great care with this export option. It will overwrite these higher images if you tell it to do so and they will be lost
			:'''''See: [[Advancedsettings.xml#Library_artwork\|Library Artwork in advancedsettings.xml]]'''''

	;Overwrite existing files		;Overwrite existing files
Line 187:		Line 189:
	:If an artist or album has not been scraped from online or other sources, then there is no information available to export.		:If an artist or album has not been scraped from online or other sources, then there is no information available to export.
	:Enabling this setting will force an export by creating a blank template style NFO file. This template can be used to easily add information to be refreshed into the library.		:Enabling this setting will force an export by creating a blank template style NFO file. This template can be used to easily add information to be refreshed into the library.
	:{{red\|This option has been incorrectly added to the wrong section and should be in the '''To library folders''' export as Kodi cannot read from this export folder. This will be fixed in a later release.}}

	;Include art works such as thumbnails and fanart		;Include art works such as thumbnails and fanart
Line 227:		Line 228:


	= Import =		= Import - Single File =
	~~How you import the exported data will depend on which method you used to export.~~		<gallery mode="packed-overlay" widths="500px" heights="283px">



	== Single ~~file =~~=
	<gallery mode="packed" widths="500px" heights="283px">
	~~File:LibExp01.jpg\|Location of options~~
	File:LibExp06.jpg\|Selecting the location of the single file		File:LibExp06.jpg\|Selecting the location of the single file
	</gallery>		</gallery>

	If you exported your library using the '''Single File''' method, use the Music Library Import option to import the data		If you exported your library using the '''Single File''' method, use the Music Library Import option to import the data
	*Select '''Import''' from the settings page ~~as shown above~~		*Select '''Import''' from the settings page
	*Navigate to the folder where you previously saved the single file export		*Navigate to the folder where you previously saved the single file export
	*Select the appropriate ''kodi_musicdbyyyymmdd_hhmmss'' file		*Select the appropriate ''kodi_musicdbyyyymmdd_hhmmss'' file
Line 249:		Line 244:


			<!-- Not wanted by @daveblake
	== To library folders ==		== To library folders ==
	If you exported your library using the '''To library folders''' option, then use the normal scraping process to re-import the data.		If you exported your library using the '''To library folders''' option, then use the normal scraping process to re-import the data.
Line 261:		Line 256:
	== Separate Files for each items ==		== Separate Files for each items ==
	This is a diagnostic type export which is not created to be imported by {{kodi}}.		This is a diagnostic type export which is not created to be imported by {{kodi}}.
			-->

Karellen at 20:44, 18 April 2019

2019-04-18T20:44:50Z

← Older revision		Revision as of 20:44, 18 April 2019
Line 19:		Line 19:
	The Import-Export function has been overhauled for v18 and adds more functionality and integrates the new '''[[Artist information folder]]'''.		The Import-Export function has been overhauled for v18 and adds more functionality and integrates the new '''[[Artist information folder]]'''.

	Song history and ratings are exported when using the Single File method in v18 and later. advancedsettings.xml entries are not required.		Song history and ratings are exported when using the Single File method in v18.2 and later. advancedsettings.xml entries are not required.


Line 55:		Line 55:
	*Exports a single ''.xml'' file saved to a destination folder specified by the user.		*Exports a single ''.xml'' file saved to a destination folder specified by the user.
	*Each export is a full export. There are no incremental exports.		*Each export is a full export. There are no incremental exports.
			*The only method to export user rating, play counts, last played and scraped ratings and votes
	*No artwork is exported.		*No artwork is exported.
	*Each file is named ''kodi_musicdbyyyymmdd_hhmmss''. The date is appended to all export files, and the time is only appended to subsequent exports on the same day. <ref>https://forum.kodi.tv/showthread.php?tid=319284&pid=2644557#pid2644557</ref>		*Each file is named ''kodi_musicdbyyyymmdd_hhmmss''. The date is appended to all export files, and the time is only appended to subsequent exports on the same day. <ref>https://forum.kodi.tv/showthread.php?tid=319284&pid=2644557#pid2644557</ref>

Karellen: Page created for v18

2019-04-14T03:36:47Z

Page created for v18

New page

{|class="infobox" style="width:200px"
! Import-Export Contents
|-
|
* '''[[Import-export_library|Import-Export]]'''
** '''[[Import-export_library/Music|Music Library]]'''
** '''[[Import-export_library/Video|Video Library]]'''
* '''[[HOW-TO:Create_Music_Library|Return to Music Guide]]'''
|}

{{mininav|[[Music_library|Music Library]] | [[Import-export_library|Import Export Library]]}}
{{see also|NFO files|Artwork|HOW-TO:Backup the video library}}

= Introduction =
The main data in the music library comes from metadata embedded in the music files, and the export facility does not export this data at all. Likewise import will not populate an empty library as it requires scanning the music file tags into the library first. What is imported and exported is any additional artist and album information that has been previously scraped from NFO files or online sources.

The Import-Export function has been overhauled for v18 and adds more functionality and integrates the new '''[[Artist information folder]]'''.

Song history and ratings are exported when using the Single File method in v18 and later. advancedsettings.xml entries are not required.

= Artist Information Folder =
:{{main|Artist information folder}}
{{#lst:Artist_information_folder|intro}}

= Export =
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:LibExp01.jpg|Location of options
File:MusicExport01.jpg|Export types
</gallery>

The Export and Import Library options are accessed via the Settings menu as detailed in the first image above.

The Export Library function has a number of options as depicted in the second image above. Each one is explained below.

{{red|If you intend to export artwork from cache, be aware of the modifications that {{kodi}} makes to cached artwork. If you have local artwork, do not export artwork.}}

'''''See: [[Artwork#Cache|Artwork Cache]]'''''

== Single File ==
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:MusicExport02.jpg|Available options
File:LibExp06.jpg|Selecting the destination folder
File:MusicExport03.jpg|Selection of items to export
</gallery>

'''Summary:'''
*Exports a single ''.xml'' file saved to a destination folder specified by the user.
*Each export is a full export. There are no incremental exports.
*No artwork is exported.
*Each file is named ''kodi_musicdbyyyymmdd_hhmmss''. The date is appended to all export files, and the time is only appended to subsequent exports on the same day. <ref>https://forum.kodi.tv/showthread.php?tid=319284&pid=2644557#pid2644557</ref>

'''Using:'''
;Destination folder
:Enter the location where Kodi will save the single xml file.

;Items to export
:Select what type of information to be exported

:;Albums
::Additional data for albums

:;Songs
::Will export song rating and history information. This includes:
::*User rating
::*Scraped rating and votes
::*Last played and play count

:;Album artists
::Will export the artist that released the album, but will not include guest or collaboration artists on the album

:;Song artists
::Will export the guest or collaboration artists that appear on an album

:;Other artists
::Will create folders for the remaining artists that do not fall into Album or Song artist category. This may include those artists (individual people or groups of individuals) with a specific '''role''' but not credited with being album or song artists. For example musicians, orchestra, choir, producer, lyricist, composer, DJ mixer, engineer etc.

== To library folders ==
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:MusicExport04.jpg|Available options
File:MusicExport05.jpg|Selection of items to export
</gallery>

{{red|Note: This option requires the [[Artist Information Folder]] to be set.}}
:'''''See: [[Settings/Media/Music#Library|Artist Information Folder Setting]]'''''

'''Summary'''
*Artists will be exported to the Artist Information Folder.
*Additional Album metadata will be exported to the album folder containing the song files.
*Disambiguation of Artists is by appending the first 4 digits of the ''<musicBrainzArtistID>'' to the folder name.
*Disambiguation of Albums is by appending the first 4 digits of the ''<musicbrainzalbumid>'' to the folder name. <ref name="PR14257" />

'''Using:'''
;Items to export
:Select what type of information to be exported

:;Albums
::Additional data for albums

:;Album artists
::Will export the artist that released the album, but will not include guest or collaboration artists on the album

:;Song artists
::Will export the guest or collaboration artists that appear on an album

:;Other artists
::Will create folders for the remaining artists that do not fall into Album or Song artist category. This may include those artists (individual people or groups of individuals) with a specific '''role''' but not credited with being album or song artists. For example musicians, orchestra, choir, producer, lyricist, composer, DJ mixer, engineer etc.

;Output information to NFO files
:When enabled the export will create NFO files containing the metadata

;Include art works such as thumbnails and fanart
:When enabled, will export all cached artwork
:{{red|If you intend to export artwork from cache, be aware of the modifications that {{kodi}} makes to cached artwork. If you have local artwork, do not export artwork.}}

;Overwrite existing files
:Affects the previous two settings
:When disabled, no NFO files (and artwork if enabled) will be exported for albums and artists that already have them. Only those Albums and Artists that do not have them will recieve the export.
:When enabled, all existing NFO files (and artwork if enabled) will be overwritten.

'''Note:''' When the last three settings are all disabled, the export becomes the '''Artist folders only''' type export

== Separate Files for each item ==
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:MusicExport06.jpg|Available options
File:LibExp06.jpg|Selecting the destination folder
File:MusicExport05.jpg|Selection of items to export
</gallery>

'''Summary'''
*A diagnostic export that can be used to check the status of your library without interfering with your live folders and files
*Will '''not''' export to your existing Artist Information Folder and music sources
*Exports to a user nominated destination
*Kodi does not use this export in any way. It can be deleted once you have no further use for it

It will export the selected items to the user nominated Destination folder as follows:
*Artist folder name is derived from artist name as scanned into the library
*For each Artist, a folder will be created containing the NFO File and Artwork, if these options were enabled.
*Album Artists will contain sub-folders for each album. The album NFO file is exported to these album sub-folders.
*The album folder name is taken from the music folder containing the music files if there is a unique one, otherwise from the album name.
*Collaboration albums (more than 1 album artist) are placed under the first album artist.
*Disambiguation of Artists is by appending the first 4 digits of the ''<musicBrainzArtistID>'' to the folder name.
*Disambiguation of Albums is by appending the first 4 digits of the ''<musicbrainzalbumid>'' to the folder name. <ref name="PR14257">https://github.com/xbmc/xbmc/pull/14257</ref>

'''Using:'''
;Destination folder
:Enter the location where Kodi will save the export to.

;Items to export
:Select what type of information to be exported

:;Albums
::Additional data for albums

:;Album artists
::Will export the artist that released the album, but will not include guest or collaboration artists on the album

:;Song artists
::Will export the guest or collaboration artists that appear on an album

:;Other artists
::Will create folders for the remaining artists that do not fall into Album or Song artist category. This may include those artists (individual people or groups of individuals) with a specific '''role''' but not credited with being album or song artists. For example musicians, orchestra, choir, producer, lyricist, composer, DJ mixer, engineer etc.

;Output information to NFO files
:When enabled the export will create NFO files containing the metadata

;Include items that have not been scraped (to create template NFO files)
:If an artist or album has not been scraped from online or other sources, then there is no information available to export.
:Enabling this setting will force an export by creating a blank template style NFO file. This template can be used to easily add information to be refreshed into the library.
:{{red|This option has been incorrectly added to the wrong section and should be in the '''To library folders''' export as Kodi cannot read from this export folder. This will be fixed in a later release.}}

;Include art works such as thumbnails and fanart
:When enabled, will export all cached artwork

;Overwrite existing files
:Affects the previous two settings
:When disabled, no NFO files (and artwork if enabled) will be exported for albums and artists that already have them. Only those Albums and Artists that do not have them will recieve the export.
:When enabled, all existing NFO files (and artwork if enabled) will be overwritten.

== Artist folders only ==
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:MusicExport07.jpg|Available options
File:MusicExport08.jpg|Selection of items to export
</gallery>

'''Summary'''
*Used to create '''empty''' artist folders in your new [[Artist information folder]]
*Used to add new artist folders when new music is added to your library
*Requires setting the [[Artist information folder]]

'''Using:'''
;Items to export
:Select which artists will have folders created

:;Album artists
::Will create a folder for the artist that released the album.

:;Song artists
::Will create a folder for guest or collaboration artists that appear on an album

:;Other artists
::Will create folders for the remaining artists that do not fall into Album or Song artist category. This may include those artists (individual people or groups of individuals) with a specific '''role''' but not credited with being album or song artists. For example musicians, orchestra, choir, producer, lyricist, composer, DJ mixer, engineer etc.

= Import =
How you import the exported data will depend on which method you used to export.

== Single file ==
<gallery mode="packed" widths="500px" heights="283px">
File:LibExp01.jpg|Location of options
File:LibExp06.jpg|Selecting the location of the single file
</gallery>

If you exported your library using the '''Single File''' method, use the Music Library Import option to import the data
*Select '''Import''' from the settings page as shown above
*Navigate to the folder where you previously saved the single file export
*Select the appropriate ''kodi_musicdbyyyymmdd_hhmmss'' file
*Select '''OK''' and the import process will commence
*Once complete, your library should be functional again

Be aware:
*if you have removed Albums or Artists since the export, the metadata for those Albums and Album Artists will be re-imported. To remove the unwanted entries, run the '''Clean Library''' option as shown in the above image.

== To library folders ==
If you exported your library using the '''To library folders''' option, then use the normal scraping process to re-import the data.

{{red|If songs from two or more albums are contained in one album folder, the NFO file in this folder will be ignored as {{kodi}} will not know which album the NFO file applies to. Ensure there is only one album per folder.}}

:'''''See: [[Update_Music_Library#Scrape_Library|Update Music Library - Scraping]]'''''

== Separate Files for each items ==
This is a diagnostic type export which is not created to be imported by {{kodi}}.

= References =
<references />

{{top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]