Merge pull request #8381 from 1hitsong/lyric-lrc-file-support
Claus Vium
2 years ago
committed by
GitHub
commit
05c20001c8
@ -0,0 +1,24 @@
|
||||
using System.Threading.Tasks;
|
||||
using MediaBrowser.Controller.Entities;
|
||||
|
||||
namespace MediaBrowser.Controller.Lyrics;
|
||||
|
||||
/// <summary>
|
||||
/// Interface ILyricManager.
|
||||
/// </summary>
|
||||
public interface ILyricManager
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the lyrics.
|
||||
/// </summary>
|
||||
/// <param name="item">The media item.</param>
|
||||
/// <returns>A task representing found lyrics the passed item.</returns>
|
||||
Task<LyricResponse?> GetLyrics(BaseItem item);
|
||||
|
||||
/// <summary>
|
||||
/// Checks if requested item has a matching local lyric file.
|
||||
/// </summary>
|
||||
/// <param name="item">The media item.</param>
|
||||
/// <returns>True if item has a matching lyric file; otherwise false.</returns>
|
||||
bool HasLyricFile(BaseItem item);
|
||||
}
|
||||
@ -0,0 +1,36 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Threading.Tasks;
|
||||
using MediaBrowser.Controller.Entities;
|
||||
using MediaBrowser.Controller.Resolvers;
|
||||
|
||||
namespace MediaBrowser.Controller.Lyrics;
|
||||
|
||||
/// <summary>
|
||||
/// Interface ILyricsProvider.
|
||||
/// </summary>
|
||||
public interface ILyricProvider
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets a value indicating the provider name.
|
||||
/// </summary>
|
||||
string Name { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the priority.
|
||||
/// </summary>
|
||||
/// <value>The priority.</value>
|
||||
ResolverPriority Priority { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the supported media types for this provider.
|
||||
/// </summary>
|
||||
/// <value>The supported media types.</value>
|
||||
IReadOnlyCollection<string> SupportedMediaTypes { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the lyrics.
|
||||
/// </summary>
|
||||
/// <param name="item">The media item.</param>
|
||||
/// <returns>A task representing found lyrics.</returns>
|
||||
Task<LyricResponse?> GetLyrics(BaseItem item);
|
||||
}
|
||||
@ -0,0 +1,49 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using Jellyfin.Extensions;
|
||||
|
||||
namespace MediaBrowser.Controller.Lyrics;
|
||||
|
||||
/// <summary>
|
||||
/// Lyric helper methods.
|
||||
/// </summary>
|
||||
public static class LyricInfo
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets matching lyric file for a requested item.
|
||||
/// </summary>
|
||||
/// <param name="lyricProvider">The lyricProvider interface to use.</param>
|
||||
/// <param name="itemPath">Path of requested item.</param>
|
||||
/// <returns>Lyric file path if passed lyric provider's supported media type is found; otherwise, null.</returns>
|
||||
public static string? GetLyricFilePath(this ILyricProvider lyricProvider, string itemPath)
|
||||
{
|
||||
// Ensure we have a provider
|
||||
if (lyricProvider is null)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// Ensure the path to the item is not null
|
||||
string? itemDirectoryPath = Path.GetDirectoryName(itemPath);
|
||||
if (itemDirectoryPath is null)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// Ensure the directory path exists
|
||||
if (!Directory.Exists(itemDirectoryPath))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
foreach (var lyricFilePath in Directory.GetFiles(itemDirectoryPath, $"{Path.GetFileNameWithoutExtension(itemPath)}.*"))
|
||||
{
|
||||
if (lyricProvider.SupportedMediaTypes.Contains(Path.GetExtension(lyricFilePath.AsSpan())[1..], StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
return lyricFilePath;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,28 @@
|
||||
namespace MediaBrowser.Controller.Lyrics;
|
||||
|
||||
/// <summary>
|
||||
/// Lyric model.
|
||||
/// </summary>
|
||||
public class LyricLine
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="LyricLine"/> class.
|
||||
/// </summary>
|
||||
/// <param name="text">The lyric text.</param>
|
||||
/// <param name="start">The lyric start time in ticks.</param>
|
||||
public LyricLine(string text, long? start = null)
|
||||
{
|
||||
Text = text;
|
||||
Start = start;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the text of this lyric line.
|
||||
/// </summary>
|
||||
public string Text { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the start time in ticks.
|
||||
/// </summary>
|
||||
public long? Start { get; }
|
||||
}
|
||||
@ -0,0 +1,54 @@
|
||||
using System;
|
||||
|
||||
namespace MediaBrowser.Controller.Lyrics;
|
||||
|
||||
/// <summary>
|
||||
/// LyricMetadata model.
|
||||
/// </summary>
|
||||
public class LyricMetadata
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the song artist.
|
||||
/// </summary>
|
||||
public string? Artist { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the album this song is on.
|
||||
/// </summary>
|
||||
public string? Album { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the title of the song.
|
||||
/// </summary>
|
||||
public string? Title { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the author of the lyric data.
|
||||
/// </summary>
|
||||
public string? Author { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the length of the song in ticks.
|
||||
/// </summary>
|
||||
public long? Length { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets who the LRC file was created by.
|
||||
/// </summary>
|
||||
public string? By { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the lyric offset compared to audio in ticks.
|
||||
/// </summary>
|
||||
public long? Offset { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the software used to create the LRC file.
|
||||
/// </summary>
|
||||
public string? Creator { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the version of the creator used.
|
||||
/// </summary>
|
||||
public string? Version { get; set; }
|
||||
}
|
||||
@ -0,0 +1,20 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace MediaBrowser.Controller.Lyrics;
|
||||
|
||||
/// <summary>
|
||||
/// LyricResponse model.
|
||||
/// </summary>
|
||||
public class LyricResponse
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets Metadata for the lyrics.
|
||||
/// </summary>
|
||||
public LyricMetadata Metadata { get; set; } = new();
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a collection of individual lyric lines.
|
||||
/// </summary>
|
||||
public IReadOnlyList<LyricLine> Lyrics { get; set; } = Array.Empty<LyricLine>();
|
||||
}
|
||||
@ -0,0 +1,220 @@
|
||||
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;
|
||||
|
||||
/// <summary>
|
||||
/// LRC Lyric Provider.
|
||||
/// </summary>
|
||||
public class LrcLyricProvider : ILyricProvider
|
||||
{
|
||||
private readonly ILogger<LrcLyricProvider> _logger;
|
||||
|
||||
private readonly LyricParser _lrcLyricParser;
|
||||
|
||||
private static readonly string[] _acceptedTimeFormats = { "HH:mm:ss", "H:mm:ss", "mm:ss", "m:ss" };
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="LrcLyricProvider"/> class.
|
||||
/// </summary>
|
||||
/// <param name="logger">Instance of the <see cref="ILogger"/> interface.</param>
|
||||
public LrcLyricProvider(ILogger<LrcLyricProvider> logger)
|
||||
{
|
||||
_logger = logger;
|
||||
_lrcLyricParser = new LrcParser.Parser.Lrc.LrcParser();
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public string Name => "LrcLyricProvider";
|
||||
|
||||
/// <summary>
|
||||
/// Gets the priority.
|
||||
/// </summary>
|
||||
/// <value>The priority.</value>
|
||||
public ResolverPriority Priority => ResolverPriority.First;
|
||||
|
||||
/// <inheritdoc />
|
||||
public IReadOnlyCollection<string> SupportedMediaTypes { get; } = new[] { "lrc", "elrc" };
|
||||
|
||||
/// <summary>
|
||||
/// Opens lyric file for the requested item, and processes it for API return.
|
||||
/// </summary>
|
||||
/// <param name="item">The item to to process.</param>
|
||||
/// <returns>If provider can determine lyrics, returns a <see cref="LyricResponse"/> with or without metadata; otherwise, null.</returns>
|
||||
public async Task<LyricResponse?> GetLyrics(BaseItem item)
|
||||
{
|
||||
string? lyricFilePath = this.GetLyricFilePath(item.Path);
|
||||
|
||||
if (string.IsNullOrEmpty(lyricFilePath))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
var fileMetaData = new Dictionary<string, string>(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<LrcParser.Model.Lyric> 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<LyricLine> 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
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Converts metadata from an LRC file to LyricMetadata properties.
|
||||
/// </summary>
|
||||
/// <param name="metaData">The metadata from the LRC file.</param>
|
||||
/// <returns>A lyricMetadata object with mapped property data.</returns>
|
||||
private static LyricMetadata MapMetadataValues(IDictionary<string, string> 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();
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,58 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Threading.Tasks;
|
||||
using MediaBrowser.Controller.Entities;
|
||||
using MediaBrowser.Controller.Lyrics;
|
||||
|
||||
namespace MediaBrowser.Providers.Lyric;
|
||||
|
||||
/// <summary>
|
||||
/// Lyric Manager.
|
||||
/// </summary>
|
||||
public class LyricManager : ILyricManager
|
||||
{
|
||||
private readonly ILyricProvider[] _lyricProviders;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="LyricManager"/> class.
|
||||
/// </summary>
|
||||
/// <param name="lyricProviders">All found lyricProviders.</param>
|
||||
public LyricManager(IEnumerable<ILyricProvider> lyricProviders)
|
||||
{
|
||||
_lyricProviders = lyricProviders.OrderBy(i => i.Priority).ToArray();
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public async Task<LyricResponse?> GetLyrics(BaseItem item)
|
||||
{
|
||||
foreach (ILyricProvider provider in _lyricProviders)
|
||||
{
|
||||
var results = await provider.GetLyrics(item).ConfigureAwait(false);
|
||||
if (results is not null)
|
||||
{
|
||||
return results;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public bool HasLyricFile(BaseItem item)
|
||||
{
|
||||
foreach (ILyricProvider provider in _lyricProviders)
|
||||
{
|
||||
if (item is null)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
if (provider.GetLyricFilePath(item.Path) is not null)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,61 @@
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Threading.Tasks;
|
||||
using MediaBrowser.Controller.Entities;
|
||||
using MediaBrowser.Controller.Lyrics;
|
||||
using MediaBrowser.Controller.Resolvers;
|
||||
|
||||
namespace MediaBrowser.Providers.Lyric;
|
||||
|
||||
/// <summary>
|
||||
/// TXT Lyric Provider.
|
||||
/// </summary>
|
||||
public class TxtLyricProvider : ILyricProvider
|
||||
{
|
||||
/// <inheritdoc />
|
||||
public string Name => "TxtLyricProvider";
|
||||
|
||||
/// <summary>
|
||||
/// Gets the priority.
|
||||
/// </summary>
|
||||
/// <value>The priority.</value>
|
||||
public ResolverPriority Priority => ResolverPriority.Second;
|
||||
|
||||
/// <inheritdoc />
|
||||
public IReadOnlyCollection<string> SupportedMediaTypes { get; } = new[] { "lrc", "elrc", "txt" };
|
||||
|
||||
/// <summary>
|
||||
/// Opens lyric file for the requested item, and processes it for API return.
|
||||
/// </summary>
|
||||
/// <param name="item">The item to to process.</param>
|
||||
/// <returns>If provider can determine lyrics, returns a <see cref="LyricResponse"/>; otherwise, null.</returns>
|
||||
public async Task<LyricResponse?> GetLyrics(BaseItem item)
|
||||
{
|
||||
string? lyricFilePath = this.GetLyricFilePath(item.Path);
|
||||
|
||||
if (string.IsNullOrEmpty(lyricFilePath))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
string[] lyricTextLines = await File.ReadAllLinesAsync(lyricFilePath).ConfigureAwait(false);
|
||||
|
||||
if (lyricTextLines.Length == 0)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
LyricLine[] lyricList = new LyricLine[lyricTextLines.Length];
|
||||
|
||||
for (int lyricLineIndex = 0; lyricLineIndex < lyricTextLines.Length; lyricLineIndex++)
|
||||
{
|
||||
lyricList[lyricLineIndex] = new LyricLine(lyricTextLines[lyricLineIndex]);
|
||||
}
|
||||
|
||||
return new LyricResponse
|
||||
{
|
||||
Lyrics = lyricList
|
||||
};
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue