< Summary - Jellyfin

Information
Class: MediaBrowser.Providers.MediaInfo.AudioFileProber
Assembly: MediaBrowser.Providers
File(s): /srv/git/jellyfin/MediaBrowser.Providers/MediaInfo/AudioFileProber.cs
Line coverage
34%
Covered lines: 11
Uncovered lines: 21
Coverable lines: 32
Total lines: 489
Line coverage: 34.3%
Branch coverage
0%
Covered branches: 0
Total branches: 12
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%11100%
AddExternalLyrics(...)0%2040%
SplitWithCustomDelimiter(...)0%4260%
GetFirstMusicBrainzId(...)0%620%

File(s)

/srv/git/jellyfin/MediaBrowser.Providers/MediaInfo/AudioFileProber.cs

#LineLine coverage
 1using System;
 2using System.Collections.Generic;
 3using System.Globalization;
 4using System.Linq;
 5using System.Threading;
 6using System.Threading.Tasks;
 7using ATL;
 8using Jellyfin.Data.Enums;
 9using Jellyfin.Extensions;
 10using MediaBrowser.Controller.Entities;
 11using MediaBrowser.Controller.Entities.Audio;
 12using MediaBrowser.Controller.Library;
 13using MediaBrowser.Controller.Lyrics;
 14using MediaBrowser.Controller.MediaEncoding;
 15using MediaBrowser.Controller.Persistence;
 16using MediaBrowser.Controller.Providers;
 17using MediaBrowser.Model.Dlna;
 18using MediaBrowser.Model.Dto;
 19using MediaBrowser.Model.Entities;
 20using MediaBrowser.Model.Extensions;
 21using MediaBrowser.Model.MediaInfo;
 22using Microsoft.Extensions.Logging;
 23using static Jellyfin.Extensions.StringExtensions;
 24
 25namespace MediaBrowser.Providers.MediaInfo
 26{
 27    /// <summary>
 28    /// Probes audio files for metadata.
 29    /// </summary>
 30    public class AudioFileProber
 31    {
 32        private const char InternalValueSeparator = '\u001F';
 33
 34        private readonly IMediaEncoder _mediaEncoder;
 35        private readonly ILibraryManager _libraryManager;
 36        private readonly ILogger<AudioFileProber> _logger;
 37        private readonly IMediaSourceManager _mediaSourceManager;
 38        private readonly LyricResolver _lyricResolver;
 39        private readonly ILyricManager _lyricManager;
 40        private readonly IMediaStreamRepository _mediaStreamRepository;
 41
 42        /// <summary>
 43        /// Initializes a new instance of the <see cref="AudioFileProber"/> class.
 44        /// </summary>
 45        /// <param name="logger">Instance of the <see cref="ILogger"/> interface.</param>
 46        /// <param name="mediaSourceManager">Instance of the <see cref="IMediaSourceManager"/> interface.</param>
 47        /// <param name="mediaEncoder">Instance of the <see cref="IMediaEncoder"/> interface.</param>
 48        /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 49        /// <param name="lyricResolver">Instance of the <see cref="LyricResolver"/> interface.</param>
 50        /// <param name="lyricManager">Instance of the <see cref="ILyricManager"/> interface.</param>
 51        /// <param name="mediaStreamRepository">Instance of the <see cref="IMediaStreamRepository"/>.</param>
 52        public AudioFileProber(
 53            ILogger<AudioFileProber> logger,
 54            IMediaSourceManager mediaSourceManager,
 55            IMediaEncoder mediaEncoder,
 56            ILibraryManager libraryManager,
 57            LyricResolver lyricResolver,
 58            ILyricManager lyricManager,
 59            IMediaStreamRepository mediaStreamRepository)
 60        {
 2161            _mediaEncoder = mediaEncoder;
 2162            _libraryManager = libraryManager;
 2163            _logger = logger;
 2164            _mediaSourceManager = mediaSourceManager;
 2165            _lyricResolver = lyricResolver;
 2166            _lyricManager = lyricManager;
 2167            _mediaStreamRepository = mediaStreamRepository;
 2168            ATL.Settings.DisplayValueSeparator = InternalValueSeparator;
 2169            ATL.Settings.UseFileNameWhenNoTitle = false;
 2170            ATL.Settings.ID3v2_separatev2v3Values = false;
 2171        }
 72
 73        /// <summary>
 74        /// Probes the specified item for metadata.
 75        /// </summary>
 76        /// <param name="item">The item to probe.</param>
 77        /// <param name="options">The <see cref="MetadataRefreshOptions"/>.</param>
 78        /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
 79        /// <typeparam name="T">The type of item to resolve.</typeparam>
 80        /// <returns>A <see cref="Task"/> probing the item for metadata.</returns>
 81        public async Task<ItemUpdateType> Probe<T>(
 82            T item,
 83            MetadataRefreshOptions options,
 84            CancellationToken cancellationToken)
 85            where T : Audio
 86        {
 87            var path = item.Path;
 88            var protocol = item.PathProtocol ?? MediaProtocol.File;
 89
 90            if (!item.IsShortcut || options.EnableRemoteContentProbe)
 91            {
 92                if (item.IsShortcut)
 93                {
 94                    path = item.ShortcutPath;
 95                    protocol = _mediaSourceManager.GetPathProtocol(path);
 96                }
 97
 98                var result = await _mediaEncoder.GetMediaInfo(
 99                    new MediaInfoRequest
 100                    {
 101                        MediaType = DlnaProfileType.Audio,
 102                        MediaSource = new MediaSourceInfo
 103                        {
 104                            Path = path,
 105                            Protocol = protocol
 106                        }
 107                    },
 108                    cancellationToken).ConfigureAwait(false);
 109
 110                cancellationToken.ThrowIfCancellationRequested();
 111
 112                await FetchAsync(item, result, options, cancellationToken).ConfigureAwait(false);
 113            }
 114
 115            return ItemUpdateType.MetadataImport;
 116        }
 117
 118        /// <summary>
 119        /// Fetches the specified audio.
 120        /// </summary>
 121        /// <param name="audio">The <see cref="Audio"/>.</param>
 122        /// <param name="mediaInfo">The <see cref="Model.MediaInfo.MediaInfo"/>.</param>
 123        /// <param name="options">The <see cref="MetadataRefreshOptions"/>.</param>
 124        /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
 125        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
 126        private async Task FetchAsync(
 127            Audio audio,
 128            Model.MediaInfo.MediaInfo mediaInfo,
 129            MetadataRefreshOptions options,
 130            CancellationToken cancellationToken)
 131        {
 132            audio.Container = mediaInfo.Container;
 133            audio.TotalBitrate = mediaInfo.Bitrate;
 134
 135            audio.RunTimeTicks = mediaInfo.RunTimeTicks;
 136
 137            // Add external lyrics first to prevent the lrc file get overwritten on first scan
 138            var mediaStreams = new List<MediaStream>(mediaInfo.MediaStreams);
 139            AddExternalLyrics(audio, mediaStreams, options);
 140            var tryExtractEmbeddedLyrics = mediaStreams.All(s => s.Type != MediaStreamType.Lyric);
 141
 142            if (!audio.IsLocked)
 143            {
 144                await FetchDataFromTags(audio, mediaInfo, options, tryExtractEmbeddedLyrics).ConfigureAwait(false);
 145                if (tryExtractEmbeddedLyrics)
 146                {
 147                    AddExternalLyrics(audio, mediaStreams, options);
 148                }
 149            }
 150
 151            audio.HasLyrics = mediaStreams.Any(s => s.Type == MediaStreamType.Lyric);
 152
 153            _mediaStreamRepository.SaveMediaStreams(audio.Id, mediaStreams, cancellationToken);
 154        }
 155
 156        /// <summary>
 157        /// Fetches data from the tags.
 158        /// </summary>
 159        /// <param name="audio">The <see cref="Audio"/>.</param>
 160        /// <param name="mediaInfo">The <see cref="Model.MediaInfo.MediaInfo"/>.</param>
 161        /// <param name="options">The <see cref="MetadataRefreshOptions"/>.</param>
 162        /// <param name="tryExtractEmbeddedLyrics">Whether to extract embedded lyrics to lrc file. </param>
 163        private async Task FetchDataFromTags(Audio audio, Model.MediaInfo.MediaInfo mediaInfo, MetadataRefreshOptions op
 164        {
 165            var libraryOptions = _libraryManager.GetLibraryOptions(audio);
 166            Track track = new Track(audio.Path);
 167
 168            if (track.MetadataFormats
 169                .All(mf => string.Equals(mf.ShortName, "ID3v1", StringComparison.OrdinalIgnoreCase)))
 170            {
 171                _logger.LogWarning("File {File} only has ID3v1 tags, some fields may be truncated", audio.Path);
 172            }
 173
 174            // We should never use the property setter of the ATL.Track class.
 175            // That setter is meant for its own tag parser and external editor usage and will have unwanted side effects
 176            // For example, setting the Year property will also set the Date property, which is not what we want here.
 177            // To properly handle fallback values, we make a clone of those fields when valid.
 178            var trackTitle = (string.IsNullOrEmpty(track.Title) ? mediaInfo.Name : track.Title)?.Trim();
 179            var trackAlbum = (string.IsNullOrEmpty(track.Album) ? mediaInfo.Album : track.Album)?.Trim();
 180            var trackYear = track.Year is null or 0 ? mediaInfo.ProductionYear : track.Year;
 181            var trackTrackNumber = track.TrackNumber is null or 0 ? mediaInfo.IndexNumber : track.TrackNumber;
 182            var trackDiscNumber = track.DiscNumber is null or 0 ? mediaInfo.ParentIndexNumber : track.DiscNumber;
 183
 184            if (audio.SupportsPeople && !audio.LockedFields.Contains(MetadataField.Cast))
 185            {
 186                var people = new List<PersonInfo>();
 187                var albumArtists = string.IsNullOrEmpty(track.AlbumArtist) ? [] : track.AlbumArtist.Split(InternalValueS
 188
 189                if (libraryOptions.UseCustomTagDelimiters)
 190                {
 191                    albumArtists = albumArtists.SelectMany(a => SplitWithCustomDelimiter(a, libraryOptions.GetCustomTagD
 192                }
 193
 194                foreach (var albumArtist in albumArtists)
 195                {
 196                    if (!string.IsNullOrWhiteSpace(albumArtist))
 197                    {
 198                        PeopleHelper.AddPerson(people, new PersonInfo
 199                        {
 200                            Name = albumArtist.Trim(),
 201                            Type = PersonKind.AlbumArtist
 202                        });
 203                    }
 204                }
 205
 206                string[]? performers = null;
 207                if (libraryOptions.PreferNonstandardArtistsTag)
 208                {
 209                    track.AdditionalFields.TryGetValue("ARTISTS", out var artistsTagString);
 210                    if (artistsTagString is not null)
 211                    {
 212                        performers = artistsTagString.Split(InternalValueSeparator);
 213                    }
 214                }
 215
 216                if (performers is null || performers.Length == 0)
 217                {
 218                    performers = string.IsNullOrEmpty(track.Artist) ? [] : track.Artist.Split(InternalValueSeparator);
 219                }
 220
 221                if (libraryOptions.UseCustomTagDelimiters)
 222                {
 223                    performers = performers.SelectMany(p => SplitWithCustomDelimiter(p, libraryOptions.GetCustomTagDelim
 224                }
 225
 226                foreach (var performer in performers)
 227                {
 228                    if (!string.IsNullOrWhiteSpace(performer))
 229                    {
 230                        PeopleHelper.AddPerson(people, new PersonInfo
 231                        {
 232                            Name = performer.Trim(),
 233                            Type = PersonKind.Artist
 234                        });
 235                    }
 236                }
 237
 238                foreach (var composer in track.Composer.Split(InternalValueSeparator))
 239                {
 240                    if (!string.IsNullOrWhiteSpace(composer))
 241                    {
 242                        PeopleHelper.AddPerson(people, new PersonInfo
 243                        {
 244                            Name = composer.Trim(),
 245                            Type = PersonKind.Composer
 246                        });
 247                    }
 248                }
 249
 250                _libraryManager.UpdatePeople(audio, people);
 251
 252                if (options.ReplaceAllMetadata && performers.Length != 0)
 253                {
 254                    audio.Artists = performers;
 255                }
 256                else if (!options.ReplaceAllMetadata
 257                         && (audio.Artists is null || audio.Artists.Count == 0))
 258                {
 259                    audio.Artists = performers;
 260                }
 261
 262                if (albumArtists.Length == 0)
 263                {
 264                    // Album artists not provided, fall back to performers (artists).
 265                    albumArtists = performers;
 266                }
 267
 268                if (options.ReplaceAllMetadata && albumArtists.Length != 0)
 269                {
 270                    audio.AlbumArtists = albumArtists;
 271                }
 272                else if (!options.ReplaceAllMetadata
 273                         && (audio.AlbumArtists is null || audio.AlbumArtists.Count == 0))
 274                {
 275                    audio.AlbumArtists = albumArtists;
 276                }
 277            }
 278
 279            if (!audio.LockedFields.Contains(MetadataField.Name) && !string.IsNullOrEmpty(trackTitle))
 280            {
 281                audio.Name = trackTitle;
 282            }
 283
 284            if (options.ReplaceAllMetadata)
 285            {
 286                audio.Album = trackAlbum;
 287                audio.IndexNumber = trackTrackNumber;
 288                audio.ParentIndexNumber = trackDiscNumber;
 289            }
 290            else
 291            {
 292                audio.Album ??= trackAlbum;
 293                audio.IndexNumber ??= trackTrackNumber;
 294                audio.ParentIndexNumber ??= trackDiscNumber;
 295            }
 296
 297            if (track.Date.HasValue)
 298            {
 299                audio.PremiereDate = track.Date;
 300            }
 301
 302            if (trackYear.HasValue)
 303            {
 304                var year = trackYear.Value;
 305                audio.ProductionYear = year;
 306
 307                // ATL library handles such fallback this with its own internal logic, but we also need to handle it her
 308                if (!audio.PremiereDate.HasValue)
 309                {
 310                    try
 311                    {
 312                        audio.PremiereDate = new DateTime(year, 01, 01);
 313                    }
 314                    catch (ArgumentOutOfRangeException ex)
 315                    {
 316                        _logger.LogError(ex, "Error parsing YEAR tag in {File}. '{TagValue}' is an invalid year", audio.
 317                    }
 318                }
 319            }
 320
 321            if (!audio.LockedFields.Contains(MetadataField.Genres))
 322            {
 323                var genres = string.IsNullOrEmpty(track.Genre) ? [] : track.Genre.Split(InternalValueSeparator).Distinct
 324
 325                if (libraryOptions.UseCustomTagDelimiters)
 326                {
 327                    genres = genres.SelectMany(g => SplitWithCustomDelimiter(g, libraryOptions.GetCustomTagDelimiters(),
 328                }
 329
 330                genres = genres.Trimmed().Distinct(StringComparer.OrdinalIgnoreCase).ToArray();
 331
 332                audio.Genres = options.ReplaceAllMetadata || audio.Genres is null || audio.Genres.Length == 0
 333                    ? genres
 334                    : audio.Genres;
 335            }
 336
 337            track.AdditionalFields.TryGetValue("REPLAYGAIN_TRACK_GAIN", out var trackGainTag);
 338
 339            if (trackGainTag is not null)
 340            {
 341                if (trackGainTag.EndsWith("db", StringComparison.OrdinalIgnoreCase))
 342                {
 343                    trackGainTag = trackGainTag[..^2].Trim();
 344                }
 345
 346                if (float.TryParse(trackGainTag, NumberStyles.Float, CultureInfo.InvariantCulture, out var value) && flo
 347                {
 348                    audio.NormalizationGain = value;
 349                }
 350            }
 351
 352            if (options.ReplaceAllMetadata || !audio.TryGetProviderId(MetadataProvider.MusicBrainzArtist, out _))
 353            {
 354                if ((track.AdditionalFields.TryGetValue("MUSICBRAINZ_ARTISTID", out var musicBrainzArtistTag)
 355                     || track.AdditionalFields.TryGetValue("MusicBrainz Artist Id", out musicBrainzArtistTag))
 356                    && !string.IsNullOrEmpty(musicBrainzArtistTag))
 357                {
 358                    var id = GetFirstMusicBrainzId(musicBrainzArtistTag, libraryOptions.UseCustomTagDelimiters, libraryO
 359                    audio.TrySetProviderId(MetadataProvider.MusicBrainzArtist, id);
 360                }
 361            }
 362
 363            if (options.ReplaceAllMetadata || !audio.TryGetProviderId(MetadataProvider.MusicBrainzAlbumArtist, out _))
 364            {
 365                if ((track.AdditionalFields.TryGetValue("MUSICBRAINZ_ALBUMARTISTID", out var musicBrainzReleaseArtistIdT
 366                     || track.AdditionalFields.TryGetValue("MusicBrainz Album Artist Id", out musicBrainzReleaseArtistId
 367                    && !string.IsNullOrEmpty(musicBrainzReleaseArtistIdTag))
 368                {
 369                    var id = GetFirstMusicBrainzId(musicBrainzReleaseArtistIdTag, libraryOptions.UseCustomTagDelimiters,
 370                    audio.TrySetProviderId(MetadataProvider.MusicBrainzAlbumArtist, id);
 371                }
 372            }
 373
 374            if (options.ReplaceAllMetadata || !audio.TryGetProviderId(MetadataProvider.MusicBrainzAlbum, out _))
 375            {
 376                if ((track.AdditionalFields.TryGetValue("MUSICBRAINZ_ALBUMID", out var musicBrainzReleaseIdTag)
 377                     || track.AdditionalFields.TryGetValue("MusicBrainz Album Id", out musicBrainzReleaseIdTag))
 378                    && !string.IsNullOrEmpty(musicBrainzReleaseIdTag))
 379                {
 380                    var id = GetFirstMusicBrainzId(musicBrainzReleaseIdTag, libraryOptions.UseCustomTagDelimiters, libra
 381                    audio.TrySetProviderId(MetadataProvider.MusicBrainzAlbum, id);
 382                }
 383            }
 384
 385            if (options.ReplaceAllMetadata || !audio.TryGetProviderId(MetadataProvider.MusicBrainzReleaseGroup, out _))
 386            {
 387                if ((track.AdditionalFields.TryGetValue("MUSICBRAINZ_RELEASEGROUPID", out var musicBrainzReleaseGroupIdT
 388                     || track.AdditionalFields.TryGetValue("MusicBrainz Release Group Id", out musicBrainzReleaseGroupId
 389                    && !string.IsNullOrEmpty(musicBrainzReleaseGroupIdTag))
 390                {
 391                    var id = GetFirstMusicBrainzId(musicBrainzReleaseGroupIdTag, libraryOptions.UseCustomTagDelimiters, 
 392                    audio.TrySetProviderId(MetadataProvider.MusicBrainzReleaseGroup, id);
 393                }
 394            }
 395
 396            if (options.ReplaceAllMetadata || !audio.TryGetProviderId(MetadataProvider.MusicBrainzTrack, out _))
 397            {
 398                if ((track.AdditionalFields.TryGetValue("MUSICBRAINZ_RELEASETRACKID", out var trackMbId)
 399                     || track.AdditionalFields.TryGetValue("MusicBrainz Release Track Id", out trackMbId))
 400                    && !string.IsNullOrEmpty(trackMbId))
 401                {
 402                    var id = GetFirstMusicBrainzId(trackMbId, libraryOptions.UseCustomTagDelimiters, libraryOptions.GetC
 403                    audio.TrySetProviderId(MetadataProvider.MusicBrainzTrack, id);
 404                }
 405            }
 406
 407            if (options.ReplaceAllMetadata || !audio.TryGetProviderId(MetadataProvider.MusicBrainzRecording, out _))
 408            {
 409                if ((track.AdditionalFields.TryGetValue("MUSICBRAINZ_TRACKID", out var recordingMbId)
 410                     || track.AdditionalFields.TryGetValue("MusicBrainz Track Id", out recordingMbId))
 411                    && !string.IsNullOrEmpty(recordingMbId))
 412                {
 413                    audio.TrySetProviderId(MetadataProvider.MusicBrainzRecording, recordingMbId);
 414                }
 415                else if (track.AdditionalFields.TryGetValue("UFID", out var ufIdValue) && !string.IsNullOrEmpty(ufIdValu
 416                {
 417                    // If tagged with MB Picard, the format is 'http://musicbrainz.org\0<recording MBID>'
 418                    if (ufIdValue.Contains("musicbrainz.org", StringComparison.OrdinalIgnoreCase))
 419                    {
 420                        audio.TrySetProviderId(MetadataProvider.MusicBrainzRecording, ufIdValue.AsSpan().RightPart('\0')
 421                    }
 422                }
 423            }
 424
 425            // Save extracted lyrics if they exist,
 426            // and if the audio doesn't yet have lyrics.
 427            var lyrics = track.Lyrics.SynchronizedLyrics.Count > 0 ? track.Lyrics.FormatSynchToLRC() : track.Lyrics.Unsy
 428            if (!string.IsNullOrWhiteSpace(lyrics)
 429                && tryExtractEmbeddedLyrics)
 430            {
 431                await _lyricManager.SaveLyricAsync(audio, "lrc", lyrics).ConfigureAwait(false);
 432            }
 433        }
 434
 435        private void AddExternalLyrics(
 436            Audio audio,
 437            List<MediaStream> currentStreams,
 438            MetadataRefreshOptions options)
 439        {
 0440            var startIndex = currentStreams.Count == 0 ? 0 : (currentStreams.Select(i => i.Index).Max() + 1);
 0441            var externalLyricFiles = _lyricResolver.GetExternalStreams(audio, startIndex, options.DirectoryService, fals
 442
 0443            audio.LyricFiles = externalLyricFiles.Select(i => i.Path).Distinct().ToArray();
 0444            if (externalLyricFiles.Count > 0)
 445            {
 0446                currentStreams.Add(externalLyricFiles[0]);
 447            }
 0448        }
 449
 450        private List<string> SplitWithCustomDelimiter(string val, char[] tagDelimiters, string[] whitelist)
 451        {
 0452            var items = new List<string>();
 0453            var temp = val;
 0454            foreach (var whitelistItem in whitelist)
 455            {
 0456                if (string.IsNullOrWhiteSpace(whitelistItem))
 457                {
 458                    continue;
 459                }
 460
 0461                var originalTemp = temp;
 0462                temp = temp.Replace(whitelistItem, string.Empty, StringComparison.OrdinalIgnoreCase);
 463
 0464                if (!string.Equals(temp, originalTemp, StringComparison.OrdinalIgnoreCase))
 465                {
 0466                    items.Add(whitelistItem);
 467                }
 468            }
 469
 0470            var items2 = temp.Split(tagDelimiters, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntrie
 0471            items.AddRange(items2);
 472
 0473            return items;
 474        }
 475
 476        // MusicBrainz IDs are multi-value tags, so we need to split them
 477        // However, our current provider can only have one single ID, which means we need to pick the first one
 478        private string? GetFirstMusicBrainzId(string tag, bool useCustomTagDelimiters, char[] tagDelimiters, string[] wh
 479        {
 0480            var val = tag.Split(InternalValueSeparator).FirstOrDefault();
 0481            if (val is not null && useCustomTagDelimiters)
 482            {
 0483                val = SplitWithCustomDelimiter(val, tagDelimiters, whitelist).FirstOrDefault();
 484            }
 485
 0486            return val;
 487        }
 488    }
 489}