diff --git a/Jellyfin.Api/Controllers/LyricsController.cs b/Jellyfin.Api/Controllers/LyricsController.cs index 4fccf2cb42..f2b312b478 100644 --- a/Jellyfin.Api/Controllers/LyricsController.cs +++ b/Jellyfin.Api/Controllers/LyricsController.cs @@ -146,13 +146,11 @@ public class LyricsController : BaseJellyfinApiController await using (stream.ConfigureAwait(false)) { await Request.Body.CopyToAsync(stream).ConfigureAwait(false); - var uploadedLyric = await _lyricManager.UploadLyricAsync( - audio, - new LyricResponse - { - Format = format, - Stream = stream - }).ConfigureAwait(false); + var uploadedLyric = await _lyricManager.SaveLyricAsync( + audio, + format, + stream) + .ConfigureAwait(false); if (uploadedLyric is null) { diff --git a/MediaBrowser.Controller/Lyrics/ILyricManager.cs b/MediaBrowser.Controller/Lyrics/ILyricManager.cs index f4376a1eeb..1e71b87ebb 100644 --- a/MediaBrowser.Controller/Lyrics/ILyricManager.cs +++ b/MediaBrowser.Controller/Lyrics/ILyricManager.cs @@ -1,5 +1,6 @@ using System; using System.Collections.Generic; +using System.IO; using System.Threading; using System.Threading.Tasks; using MediaBrowser.Controller.Entities; @@ -69,12 +70,22 @@ public interface ILyricManager CancellationToken cancellationToken); /// - /// Upload new lyrics. + /// Saves new lyrics. /// /// The audio file the lyrics belong to. - /// The lyric response. + /// The lyrics format. + /// The lyrics. /// A representing the asynchronous operation. - Task UploadLyricAsync(Audio audio, LyricResponse lyricResponse); + Task SaveLyricAsync(Audio audio, string format, string lyrics); + + /// + /// Saves new lyrics. + /// + /// The audio file the lyrics belong to. + /// The lyrics format. + /// The lyrics. + /// A representing the asynchronous operation. + Task SaveLyricAsync(Audio audio, string format, Stream lyrics); /// /// Get the remote lyrics. diff --git a/MediaBrowser.Providers/Lyric/LyricManager.cs b/MediaBrowser.Providers/Lyric/LyricManager.cs index 60734b89ae..f4b18a8c14 100644 --- a/MediaBrowser.Providers/Lyric/LyricManager.cs +++ b/MediaBrowser.Providers/Lyric/LyricManager.cs @@ -155,13 +155,13 @@ public class LyricManager : ILyricManager return null; } - var parsedLyrics = await InternalParseRemoteLyricsAsync(response, cancellationToken).ConfigureAwait(false); + var parsedLyrics = await InternalParseRemoteLyricsAsync(response.Format, response.Stream, cancellationToken).ConfigureAwait(false); if (parsedLyrics is null) { return null; } - await TrySaveLyric(audio, libraryOptions, response).ConfigureAwait(false); + await TrySaveLyric(audio, libraryOptions, response.Format, response.Stream).ConfigureAwait(false); return parsedLyrics; } catch (RateLimitExceededException) @@ -182,19 +182,33 @@ public class LyricManager : ILyricManager } /// - public async Task UploadLyricAsync(Audio audio, LyricResponse lyricResponse) + public async Task SaveLyricAsync(Audio audio, string format, string lyrics) { ArgumentNullException.ThrowIfNull(audio); - ArgumentNullException.ThrowIfNull(lyricResponse); + ArgumentException.ThrowIfNullOrEmpty(format); + ArgumentException.ThrowIfNullOrEmpty(lyrics); + + var bytes = Encoding.UTF8.GetBytes(lyrics); + using var lyricStream = new MemoryStream(bytes, 0, bytes.Length, false, true); + return await SaveLyricAsync(audio, format, lyricStream).ConfigureAwait(false); + } + + /// + public async Task SaveLyricAsync(Audio audio, string format, Stream lyrics) + { + ArgumentNullException.ThrowIfNull(audio); + ArgumentException.ThrowIfNullOrEmpty(format); + ArgumentNullException.ThrowIfNull(lyrics); + var libraryOptions = BaseItem.LibraryManager.GetLibraryOptions(audio); - var parsed = await InternalParseRemoteLyricsAsync(lyricResponse, CancellationToken.None).ConfigureAwait(false); + var parsed = await InternalParseRemoteLyricsAsync(format, lyrics, CancellationToken.None).ConfigureAwait(false); if (parsed is null) { return null; } - await TrySaveLyric(audio, libraryOptions, lyricResponse).ConfigureAwait(false); + await TrySaveLyric(audio, libraryOptions, format, lyrics).ConfigureAwait(false); return parsed; } @@ -209,7 +223,7 @@ public class LyricManager : ILyricManager return null; } - return await InternalParseRemoteLyricsAsync(lyricResponse, cancellationToken).ConfigureAwait(false); + return await InternalParseRemoteLyricsAsync(lyricResponse.Format, lyricResponse.Stream, cancellationToken).ConfigureAwait(false); } /// @@ -289,12 +303,12 @@ public class LyricManager : ILyricManager private string GetProviderId(string name) => name.ToLowerInvariant().GetMD5().ToString("N", CultureInfo.InvariantCulture); - private async Task InternalParseRemoteLyricsAsync(LyricResponse lyricResponse, CancellationToken cancellationToken) + private async Task InternalParseRemoteLyricsAsync(string format, Stream lyricStream, CancellationToken cancellationToken) { - lyricResponse.Stream.Seek(0, SeekOrigin.Begin); - using var streamReader = new StreamReader(lyricResponse.Stream, leaveOpen: true); + lyricStream.Seek(0, SeekOrigin.Begin); + using var streamReader = new StreamReader(lyricStream, leaveOpen: true); var lyrics = await streamReader.ReadToEndAsync(cancellationToken).ConfigureAwait(false); - var lyricFile = new LyricFile($"lyric.{lyricResponse.Format}", lyrics); + var lyricFile = new LyricFile($"lyric.{format}", lyrics); foreach (var parser in _lyricParsers) { var parsedLyrics = parser.ParseLyrics(lyricFile); @@ -334,7 +348,7 @@ public class LyricManager : ILyricManager var parsedResults = new List(); foreach (var result in searchResults) { - var parsedLyrics = await InternalParseRemoteLyricsAsync(result.Lyrics, cancellationToken).ConfigureAwait(false); + var parsedLyrics = await InternalParseRemoteLyricsAsync(result.Lyrics.Format, result.Lyrics.Stream, cancellationToken).ConfigureAwait(false); if (parsedLyrics is null) { continue; @@ -361,24 +375,23 @@ public class LyricManager : ILyricManager private async Task TrySaveLyric( Audio audio, LibraryOptions libraryOptions, - LyricResponse lyricResponse) + string format, + Stream lyricStream) { var saveInMediaFolder = libraryOptions.SaveLyricsWithMedia; var memoryStream = new MemoryStream(); await using (memoryStream.ConfigureAwait(false)) { - var stream = lyricResponse.Stream; - - await using (stream.ConfigureAwait(false)) + await using (lyricStream.ConfigureAwait(false)) { - stream.Seek(0, SeekOrigin.Begin); - await stream.CopyToAsync(memoryStream).ConfigureAwait(false); + lyricStream.Seek(0, SeekOrigin.Begin); + await lyricStream.CopyToAsync(memoryStream).ConfigureAwait(false); memoryStream.Seek(0, SeekOrigin.Begin); } var savePaths = new List(); - var saveFileName = Path.GetFileNameWithoutExtension(audio.Path) + "." + lyricResponse.Format.ReplaceLineEndings(string.Empty).ToLowerInvariant(); + var saveFileName = Path.GetFileNameWithoutExtension(audio.Path) + "." + format.ReplaceLineEndings(string.Empty).ToLowerInvariant(); if (saveInMediaFolder) { diff --git a/MediaBrowser.Providers/MediaInfo/AudioFileProber.cs b/MediaBrowser.Providers/MediaInfo/AudioFileProber.cs index 0df624bdbe..4d4b59b8cf 100644 --- a/MediaBrowser.Providers/MediaInfo/AudioFileProber.cs +++ b/MediaBrowser.Providers/MediaInfo/AudioFileProber.cs @@ -10,6 +10,7 @@ using Jellyfin.Data.Enums; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.Audio; using MediaBrowser.Controller.Library; +using MediaBrowser.Controller.Lyrics; using MediaBrowser.Controller.MediaEncoding; using MediaBrowser.Controller.Persistence; using MediaBrowser.Controller.Providers; @@ -36,6 +37,7 @@ namespace MediaBrowser.Providers.MediaInfo private readonly ILibraryManager _libraryManager; private readonly IMediaSourceManager _mediaSourceManager; private readonly LyricResolver _lyricResolver; + private readonly ILyricManager _lyricManager; /// /// Initializes a new instance of the class. @@ -46,13 +48,15 @@ namespace MediaBrowser.Providers.MediaInfo /// Instance of the interface. /// Instance of the interface. /// Instance of the interface. + /// Instance of the interface. public AudioFileProber( ILogger logger, IMediaSourceManager mediaSourceManager, IMediaEncoder mediaEncoder, IItemRepository itemRepo, ILibraryManager libraryManager, - LyricResolver lyricResolver) + LyricResolver lyricResolver, + ILyricManager lyricManager) { _logger = logger; _mediaEncoder = mediaEncoder; @@ -60,6 +64,7 @@ namespace MediaBrowser.Providers.MediaInfo _libraryManager = libraryManager; _mediaSourceManager = mediaSourceManager; _lyricResolver = lyricResolver; + _lyricManager = lyricManager; } [GeneratedRegex(@"I:\s+(.*?)\s+LUFS")] @@ -107,7 +112,7 @@ namespace MediaBrowser.Providers.MediaInfo cancellationToken.ThrowIfCancellationRequested(); - Fetch(item, result, options, cancellationToken); + await FetchAsync(item, result, options, cancellationToken).ConfigureAwait(false); } var libraryOptions = _libraryManager.GetLibraryOptions(item); @@ -211,7 +216,8 @@ namespace MediaBrowser.Providers.MediaInfo /// The . /// The . /// The . - protected void Fetch( + /// A representing the asynchronous operation. + private async Task FetchAsync( Audio audio, Model.MediaInfo.MediaInfo mediaInfo, MetadataRefreshOptions options, @@ -225,7 +231,7 @@ namespace MediaBrowser.Providers.MediaInfo if (!audio.IsLocked) { - FetchDataFromTags(audio, options); + await FetchDataFromTags(audio, options).ConfigureAwait(false); } var mediaStreams = new List(mediaInfo.MediaStreams); @@ -241,9 +247,9 @@ namespace MediaBrowser.Providers.MediaInfo /// /// The . /// The . - private void FetchDataFromTags(Audio audio, MetadataRefreshOptions options) + private async Task FetchDataFromTags(Audio audio, MetadataRefreshOptions options) { - var file = TagLib.File.Create(audio.Path); + using var file = TagLib.File.Create(audio.Path); var tagTypes = file.TagTypesOnDisk; Tag? tags = null; @@ -398,6 +404,14 @@ namespace MediaBrowser.Providers.MediaInfo { audio.SetProviderId(MetadataProvider.MusicBrainzTrack, tags.MusicBrainzTrackId); } + + // Save extracted lyrics if they exist, + // and if we are replacing all metadata or the audio doesn't yet have lyrics. + if (!string.IsNullOrWhiteSpace(tags.Lyrics) + && (options.ReplaceAllMetadata || audio.GetMediaStreams().All(s => s.Type != MediaStreamType.Lyric))) + { + await _lyricManager.SaveLyricAsync(audio, "lrc", tags.Lyrics).ConfigureAwait(false); + } } } diff --git a/MediaBrowser.Providers/MediaInfo/ProbeProvider.cs b/MediaBrowser.Providers/MediaInfo/ProbeProvider.cs index 8bb874f0d3..8bb8d5bb4c 100644 --- a/MediaBrowser.Providers/MediaInfo/ProbeProvider.cs +++ b/MediaBrowser.Providers/MediaInfo/ProbeProvider.cs @@ -13,6 +13,7 @@ using MediaBrowser.Controller.Entities.Audio; using MediaBrowser.Controller.Entities.Movies; using MediaBrowser.Controller.Entities.TV; using MediaBrowser.Controller.Library; +using MediaBrowser.Controller.Lyrics; using MediaBrowser.Controller.MediaEncoding; using MediaBrowser.Controller.Persistence; using MediaBrowser.Controller.Providers; @@ -64,6 +65,7 @@ namespace MediaBrowser.Providers.MediaInfo /// Instance of the . /// Instance of the interface. /// The . + /// Instance of the interface. public ProbeProvider( IMediaSourceManager mediaSourceManager, IMediaEncoder mediaEncoder, @@ -77,7 +79,8 @@ namespace MediaBrowser.Providers.MediaInfo ILibraryManager libraryManager, IFileSystem fileSystem, ILoggerFactory loggerFactory, - NamingOptions namingOptions) + NamingOptions namingOptions, + ILyricManager lyricManager) { _logger = loggerFactory.CreateLogger(); _audioResolver = new AudioResolver(loggerFactory.CreateLogger(), localization, mediaEncoder, fileSystem, namingOptions); @@ -105,7 +108,8 @@ namespace MediaBrowser.Providers.MediaInfo mediaEncoder, itemRepo, libraryManager, - _lyricResolver); + _lyricResolver, + lyricManager); } ///