Merge branch 'music-assistant:main' into main

Author: OzGav

docs/music-providers/filesystem.md

@@ -5,7 +5,7 @@ description: Features, Configuration, Issues and More for the File System Player
 
 # Filesystem Provider ![Preview image](../assets/icons/localfiles-icon.png){ width=70 align=right }
 
-Music Assistant has full support for reading your own (local) music files on disk or a remote server and will catalog it into the library, allowing playback to all player providers supported by Music Assistant. 
+Music Assistant has full support for reading local music files on disk or a remote server and will catalog it into the library, allowing playback to all player providers supported by Music Assistant. 
 
 When streaming providers are also availabe in MA linking will only occur when the same item is found in the "Library" of that streaming provider. However, additional tracks and albums will be seen in various views or via the global search which can then be added separately to the MA Library.
 
@@ -35,16 +35,16 @@ When streaming providers are also availabe in MA linking will only occur when th
 
 Separate providers must be added for Music, Audiobooks and Podcasts.
 
-**Your files are on a disk/folder of the device running Music Assistant Server**
+**Audio files are on a disk/folder of the device running the Music Assistant Server**
 
-If your files are actually stored on the device running Music Assistant, for example the `/media` folder in Home Assistant OS, you should select the filesystem (local disk) provider and enter the path to the files. 
+If the files are stored on the device running Music Assistant, for example the `/media` folder in Home Assistant OS, the filesystem (local disk) provider should be selected and then the path to the files provided. 
 
 !!! note
-    For Home Assistant OS you can only access the `/media` folder. Docker users can mount their own folder paths. You can not mount a folder from Home Assistant into the `/media` path.
+    For Home Assistant OS only the `/media` folder can be accessed. Docker users can mount their own folder paths. It is not possible to mount a folder from Home Assistant into the `/media` path.
 
-**Your files are on a remote share, such as a NAS or other (SMB/CIFS) server**
+**Audio files are on a remote share, such as a NAS or other (SMB/CIFS) server**
 
-Music Assistant has support for SMB (also known as samba or CIFS) shares and DFS. Select the music provider "Filesystem (remote share)" and configure the (fqdn) hostname (or alternatively the IP address) to your server, the name of the share and optionally any subfolders.
+Music Assistant has support for SMB (also known as samba or CIFS) shares and DFS. Select the music provider "Filesystem (remote share)" and configure the (fqdn) hostname (or alternatively the IP address) to the server, the name of the share and optionally any subfolders.
 
 ### Settings
 
@@ -63,20 +63,20 @@ In addition to the settings outlined above to configure the provider there are a
 
 ## Known Issues / Notes
 
-- Write access to the share is required in order to edit or create playlists which are stored locally. You can still save playlists into the MA built-in provider if only read access is granted
-- If you are using the remote share connection, be aware that use of SMB1 (which is very old) is not recommended. If the connection keeps failing, look in your NAS settings to see if you can somehow disable SMB1
+- Write access to the share is required in order to edit or create playlists which are stored locally. Playlists can still be saved to the MA built-in provider if only read access is granted
+- When using the remote share connection, be aware that use of SMB1 (which is very old) is not recommended. If the connection keeps failing, look at the NAS settings to see if SMB1 can be disabled
 - Use the following naming convention for local artwork
     - Artist thumb: folder.jpg or artist.jpg (or png)
     - Album thumb: folder.jpg or cover.jpg (or png)
     - Fan Art (used as background in banners): fanart.jpg (or png)
     - Logo (used on Artist view): logo.png
 - Artist thumb, Fanart and Logo should be in the folder with the artist name. Album thumbs should be in the folder with the album name or in the disc folders below that. More about artwork file types can be found here https://kodi.wiki/view/Artwork_types
-- Embedded album thumbs will be extracted from audio files. However, you can improve performance and save disk space by providing a single local artwork file vs. embedding the same artwork in all files
+- Embedded album thumbs will be extracted from audio files. However, performance can be improved and disk space saved by providing a single local artwork file vs. embedding the same artwork in all files
 
 !!! tip "Local Artwork is Optimal" 
     Using embedded images on every track of the same album is suboptimal for both disk space and performance. Use a single folder.jpg in the album's folder instead
 
-- Artwork which needs to be downloaded will be done very slowly in the background. You can force the download by selecting "Update Metadata" from the ⋮ menu in the banner at the top of a view
+- Artwork which needs to be downloaded will be done very slowly in the background. It is possible to force the download by selecting "Update Metadata" from the ⋮ menu in the banner at the top of a view
 - Local tracks and albums will be linked to the same tracks or albums on any provider (local or streaming). Note that same is not simply same name. The tags are reviewed to ascertain whether it is indeed the exact same track. Without tag information MA will attempt to identify identical tracks based on the other information it has such as artist name, album, and track length. However, poor tag information may lead to poor matches
 - A setting, enabled by default, allows the skipping of playlists which are more than one level below the root (normally this is the album folder). This is preferred as these playlists (normally all album tracks in the folder) serve no function in MA and clutter the Playlists view. Excessive numbers of playlists can have a negative impact on other parts of the MA experience
 - Folders commencing with an underscore will be ignored
@@ -87,23 +87,23 @@ In addition to the settings outlined above to configure the provider there are a
 
 ## Tagging Files 
 
-- It is very important that all of your audio files contain correct, and ideally, extensive tag information. The more comprehensive the tagging the better the results will be when using MA. Note the following:
-    - Universal Tag Support: Music Assistant parses metadata from the industry-standard formats used by your files, including ID3 (v1/v2) for MP3s, Vorbis Comments for FLAC/Ogg/Opus, MP4 Atoms for M4A, and APEv2 tags
+- It is very important that all audio files contain correct, and ideally, extensive tag information. The more comprehensive the tagging the better the results will be when using MA. Note the following:
+    - Universal Tag Support: Music Assistant parses metadata from the industry-standard formats, including ID3 (v1/v2) for MP3s, Vorbis Comments for FLAC/Ogg/Opus, MP4 Atoms for M4A, and APEv2 tags
     - Primary Source of Truth: Embedded tags are treated as the definitive source for artist, album, and track names. External metadata providers (like MusicBrainz or Fanart.tv) are only used to supplement missing info, such as high-resolution artwork or artist bios
-    - Cross-Platform Linking: MA uses advanced tags like MusicBrainz IDs (MBID) and ISRC codes to seamlessly link your local files with matching tracks on streaming services like Spotify or Tidal
+    - Cross-Platform Linking: MA uses advanced tags like MusicBrainz IDs (MBID) and ISRC codes to seamlessly link local files with matching tracks on streaming services like Spotify or Tidal
     - Artwork Handling: It supports both embedded artwork within the file and local folder-based images (e.g., folder.jpg or artist.png)
     - Recommended Tagger: For the best results in Music Assistant, it is strongly recommended to use [MusicBrainz Picard](https://picard.musicbrainz.org) to ensure the files contain the specific IDs needed for library linking. Other programs such as [Mp3Tag](https://www.mp3tag.de/en/) are often also based on the Musicbrainz catalog and can work as well provided they include the tags shown in the [Tags used by MA](#tags-used-by-ma) table
 
 - Tags must have multiple items separated by a semi-colon (this is the only tag splitter supported). In Picard this is an option in OPTIONS >> TAGS >> ID3
-- MA requires the Album Artist tag to be set. If you do not have that tag set then what happens to those tracks when the provider is scanned depends on the `Action when a track is missing the Albumartist ID3 tag` setting for the local provider
+- MA requires the Album Artist tag to be set. If that tag is not set then what happens to those tracks when the provider is scanned depends on the `Action when a track is missing the Albumartist ID3 tag` setting for the local provider
 - Music Assistant puts you in control by fully trusting the tags you provide, only additional information is scraped from metadata providers.
 - Music Assistant has support for both embedded artwork and artwork stored in a common folder structure of Artist \ Album and `.nfo` files with enhanced metadata are also supported
 - For multi disc albums it is recommended (but not required) to add folders named “Disc 1”, “Disc 2”, etc beneath a folder with the album name. Artwork for the album can be added to the top level album folder or in the disc folders
 - If there is nothing added to the disc tag then the disc number will not be shown in the display
 
 ![image](../assets/screenshots/no-disc-tag.png)
 
-- To minimise the chance of problems with MA you should follow the Kodi guidelines here https://kodi.wiki/view/Music_tagging Just about all the tips, tricks and suggestions on that page are applicable to MA and if you follow it all to the letter you will have a much better experience
+- To minimise the chance of problems with MA the [Kodi guidelines](https://kodi.wiki/view/Music_tagging) should be followed. Just about all the tips, tricks and suggestions on that page are applicable to MA and if it is followed to the letter the UX will be much better
 
 ### Multi-Artist Tracks
 
@@ -127,9 +127,9 @@ The left column corresponds to the TAG NAME shown in the [MusicBrainz Picard Tag
 ### Manually Adjusting Tags
 
 !!! danger
-    The following should be considered as advanced. Making manual changes to the tags can have undesired effects to the MA library if you make mistakes. Additionally, matching may not occur or may occur incorrectly between providers
+    The following should be considered as advanced. Making manual changes to the tags can have undesired effects to the MA library if mistakes are made. Additionally, matching may not occur or may occur incorrectly between providers
 
-Normally it is best to leave the Picard tags unchanged. However, some people do not agree with Musicbrainz that [remasters are the same as the original recording.](https://musicbrainz.org/doc/Style/Recording#Recordings_with_different_mastering) To separate these out you can edit the tags as follows:
+Normally it is best to leave the Picard tags unchanged. However, some people do not agree with Musicbrainz that [remasters are the same as the original recording.](https://musicbrainz.org/doc/Style/Recording#Recordings_with_different_mastering) To separate these out the tags can be edited as follows:
 
 - Remove MusicBrainz Release ID and Recording ID
 - Keep MusicBrainz Artist ID