using System; using System.Collections.Generic; using System.Globalization; using System.IO; using System.Linq; using System.Threading.Tasks; using LrcParser.Model; using LrcParser.Parser; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Lyrics; using MediaBrowser.Controller.Resolvers; using Microsoft.Extensions.Logging; namespace MediaBrowser.Providers.Lyric; /// /// LRC Lyric Provider. /// public class LrcLyricProvider : ILyricProvider { private readonly ILogger _logger; private readonly LyricParser _lrcLyricParser; private static readonly string[] _acceptedTimeFormats = { "HH:mm:ss", "H:mm:ss", "mm:ss", "m:ss" }; /// /// Initializes a new instance of the class. /// /// Instance of the interface. public LrcLyricProvider(ILogger logger) { _logger = logger; _lrcLyricParser = new LrcParser.Parser.Lrc.LrcParser(); } /// public string Name => "LrcLyricProvider"; /// /// Gets the priority. /// /// The priority. public ResolverPriority Priority => ResolverPriority.First; /// public IReadOnlyCollection SupportedMediaTypes { get; } = new[] { "lrc", "elrc" }; /// /// Opens lyric file for the requested item, and processes it for API return. /// /// The item to to process. /// If provider can determine lyrics, returns a with or without metadata; otherwise, null. public async Task GetLyrics(BaseItem item) { string? lyricFilePath = this.GetLyricFilePath(item.Path); if (string.IsNullOrEmpty(lyricFilePath)) { return null; } var fileMetaData = new Dictionary(StringComparer.OrdinalIgnoreCase); string lrcFileContent = await File.ReadAllTextAsync(lyricFilePath).ConfigureAwait(false); Song lyricData; try { lyricData = _lrcLyricParser.Decode(lrcFileContent); } catch (Exception ex) { _logger.LogError(ex, "Error parsing lyric file {LyricFilePath} from {Provider}", lyricFilePath, Name); return null; } List sortedLyricData = lyricData.Lyrics.Where(x => x.TimeTags.Count > 0).OrderBy(x => x.TimeTags.First().Value).ToList(); // Parse metadata rows var metaDataRows = lyricData.Lyrics .Where(x => x.TimeTags.Count == 0) .Where(x => x.Text.StartsWith('[') && x.Text.EndsWith(']')) .Select(x => x.Text) .ToList(); foreach (string metaDataRow in metaDataRows) { var index = metaDataRow.IndexOf(':', StringComparison.OrdinalIgnoreCase); if (index == -1) { continue; } // Remove square bracket before field name, and after field value // Example 1: [au: 1hitsong] // Example 2: [ar: Calabrese] var metaDataFieldName = GetMetadataFieldName(metaDataRow, index); var metaDataFieldValue = GetMetadataValue(metaDataRow, index); if (string.IsNullOrEmpty(metaDataFieldName) || string.IsNullOrEmpty(metaDataFieldValue)) { continue; } fileMetaData[metaDataFieldName] = metaDataFieldValue; } if (sortedLyricData.Count == 0) { return null; } List lyricList = new(); for (int i = 0; i < sortedLyricData.Count; i++) { var timeData = sortedLyricData[i].TimeTags.First().Value; if (timeData is null) { continue; } long ticks = TimeSpan.FromMilliseconds(timeData.Value).Ticks; lyricList.Add(new LyricLine(sortedLyricData[i].Text, ticks)); } if (fileMetaData.Count != 0) { // Map metaData values from LRC file to LyricMetadata properties LyricMetadata lyricMetadata = MapMetadataValues(fileMetaData); return new LyricResponse { Metadata = lyricMetadata, Lyrics = lyricList }; } return new LyricResponse { Lyrics = lyricList }; } /// /// Converts metadata from an LRC file to LyricMetadata properties. /// /// The metadata from the LRC file. /// A lyricMetadata object with mapped property data. private static LyricMetadata MapMetadataValues(IDictionary metaData) { LyricMetadata lyricMetadata = new(); if (metaData.TryGetValue("ar", out var artist) && !string.IsNullOrEmpty(artist)) { lyricMetadata.Artist = artist; } if (metaData.TryGetValue("al", out var album) && !string.IsNullOrEmpty(album)) { lyricMetadata.Album = album; } if (metaData.TryGetValue("ti", out var title) && !string.IsNullOrEmpty(title)) { lyricMetadata.Title = title; } if (metaData.TryGetValue("au", out var author) && !string.IsNullOrEmpty(author)) { lyricMetadata.Author = author; } if (metaData.TryGetValue("length", out var length) && !string.IsNullOrEmpty(length)) { if (DateTime.TryParseExact(length, _acceptedTimeFormats, null, DateTimeStyles.None, out var value)) { lyricMetadata.Length = value.TimeOfDay.Ticks; } } if (metaData.TryGetValue("by", out var by) && !string.IsNullOrEmpty(by)) { lyricMetadata.By = by; } if (metaData.TryGetValue("offset", out var offset) && !string.IsNullOrEmpty(offset)) { if (int.TryParse(offset, out var value)) { lyricMetadata.Offset = TimeSpan.FromMilliseconds(value).Ticks; } } if (metaData.TryGetValue("re", out var creator) && !string.IsNullOrEmpty(creator)) { lyricMetadata.Creator = creator; } if (metaData.TryGetValue("ve", out var version) && !string.IsNullOrEmpty(version)) { lyricMetadata.Version = version; } return lyricMetadata; } private static string GetMetadataFieldName(string metaDataRow, int index) { var metadataFieldName = metaDataRow.AsSpan(1, index - 1).Trim(); return metadataFieldName.IsEmpty ? string.Empty : metadataFieldName.ToString(); } private static string GetMetadataValue(string metaDataRow, int index) { var metadataValue = metaDataRow.AsSpan(index + 1, metaDataRow.Length - index - 2).Trim(); return metadataValue.IsEmpty ? string.Empty : metadataValue.ToString(); } }