Skip to content

Commit

Permalink
Audio player support lyric (.lrc) #1506
Browse files Browse the repository at this point in the history
  • Loading branch information
emako committed Dec 14, 2024
1 parent 31075e4 commit 09bd9bc
Show file tree
Hide file tree
Showing 6 changed files with 385 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,7 @@
using System;
using System.Collections.Generic;

#pragma warning disable IDE0130 // Namespace does not match folder structure

namespace QuickLook.Plugin.VideoViewer;

#pragma warning restore IDE0130 // Namespace does not match folder structure
namespace QuickLook.Plugin.VideoViewer.Extensions;

internal static class StringExtension
{
Expand Down
171 changes: 171 additions & 0 deletions QuickLook.Plugin/QuickLook.Plugin.VideoViewer/LyricTrack/LrcHelper.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
// Copyright © 2024 ema
//
// This file is part of QuickLook program.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Text.RegularExpressions;

namespace QuickLook.Plugin.VideoViewer.LyricTrack;

/// <summary>
/// https://github.com/lemutec/LyricStudio
/// </summary>
public static class LrcHelper
{
public static IEnumerable<LrcLine> ParseText(string text)
{
List<LrcLine> lrcList = [];

if (string.IsNullOrWhiteSpace(text))
{
return [];
}

string[] lines = new Regex(@"\r?\n").Split(text);

// The text does not contain timecode
if (!new Regex(@"\[\d+\:\d+\.\d+\]").IsMatch(text))
{
foreach (string line in lines)
{
if (new Regex(@"\[\w+\:.*\]").IsMatch(line))
{
lrcList.Add(new LrcLine(null, line.Trim('[', ']')));
}
else
{
lrcList.Add(new LrcLine(0, line));
}
}
}
// The text contain timecode
else
{
bool multiLrc = false;

int lineNumber = 1;
try
{
foreach (string line in lines)
{
if (string.IsNullOrWhiteSpace(line))
{
lineNumber++;
continue;
}

MatchCollection matches = new Regex(@"\[\d+\:\d+\.\d+\]").Matches(line);

// Such as [00:00.000][00:01.000]
if (matches.Count > 1)
{
string lrc = new Regex(@"(?<=\])[^\]]+$").Match(line).ToString();

lrcList.AddRange(matches.OfType<Match>().Select(match => new LrcLine(ParseTimeSpan(match.ToString().Trim('[', ']')), lrc)));
multiLrc = true;
}
// Normal line like [00:00.000]
else if (matches.Count == 1)
{
lrcList.Add(LrcLine.Parse(line));
}
// Info line
else if (new Regex(@"\[\w+\:.*\]").IsMatch(line))
{
lrcList.Add(new LrcLine(null, new Regex(@"\[\w+\:.*\]").Match(line).ToString().Trim('[', ']')));
}
// Not an empty line but no any timecode was found, so add an empty timecode
else
{
lrcList.Add(new LrcLine(TimeSpan.Zero, line));
}
lineNumber++;
}
// Multi timecode and sort it auto
if (multiLrc)
{
lrcList = [.. lrcList.OrderBy(x => x.LrcTime)];
}
}
catch (Exception e)
{
// Some error occurred in {{ lineNumber }}
Debug.WriteLine(e);
}
}

return lrcList;
}

public static LrcLine GetNearestLrc(IEnumerable<LrcLine> lrcList, TimeSpan time)
{
LrcLine line = lrcList
.Where(x => x.LrcTime != null && x.LrcTime <= time)
.OrderByDescending(x => x.LrcTime)
.FirstOrDefault();

return line;
}

/// <summary>
/// Try to resolve the timestamp string to TimeSpan, see
/// <seealso cref="ParseTimeSpan(string)"/>
/// </summary>
public static bool TryParseTimeSpan(string s, out TimeSpan ts)
{
try
{
ts = ParseTimeSpan(s);
return true;
}
catch
{
ts = TimeSpan.Zero;
return false;
}
}

/// <summary>
/// Resolves the timestamp string to a TimeSpan
/// </summary>
public static TimeSpan ParseTimeSpan(string s)
{
// If the millisecond is two-digit, add an extra 0 at the end
if (s.Split('.')[1].Length == 2)
{
s += '0';
}
return TimeSpan.Parse("00:" + s);
}

/// <summary>
/// Change the timestamp to a two-digit millisecond format
/// </summary>
public static string ToShortString(this TimeSpan ts, bool isShort = false)
{
if (isShort)
{
return $"{ts.Minutes:00}:{ts.Seconds:00}.{ts.Milliseconds / 10:00}";
}
else
{
return $"{ts.Minutes:00}:{ts.Seconds:00}.{ts.Milliseconds:000}";
}
}
}
161 changes: 161 additions & 0 deletions QuickLook.Plugin/QuickLook.Plugin.VideoViewer/LyricTrack/LrcLine.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
// Copyright © 2024 ema
//
// This file is part of QuickLook program.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

using System;
using System.Diagnostics;

namespace QuickLook.Plugin.VideoViewer.LyricTrack;

/// <summary>
/// https://github.com/lemutec/LyricStudio
/// https://en.wikipedia.org/wiki/LRC_(file_format)
/// </summary>
[DebuggerDisplay("{PreviewText}")]
public class LrcLine : IComparable<LrcLine>
{
public static readonly LrcLine Empty = new();

public TimeSpan? LrcTime { get; set; } = default;

public static bool IsShort { get; set; } = false;

public string LrcTimeText
{
get => LrcTime.HasValue ? LrcHelper.ToShortString(LrcTime.Value, IsShort) : string.Empty;
set
{
if (LrcHelper.TryParseTimeSpan(value, out TimeSpan ts))
{
LrcTime = ts;
}
else
{
LrcTime = null;
}
}
}

public string LrcText { get; set; }

/// <summary>
/// Preview such as [{LrcTime:mm:ss.fff}]{LyricText}
/// </summary>
public string PreviewText
{
get
{
if (LrcTime.HasValue)
{
return $"[{LrcHelper.ToShortString(LrcTime.Value, IsShort)}]{LrcText}";
}
else if (!string.IsNullOrWhiteSpace(LrcText))
{
return $"[{LrcText}]";
}
else
{
return string.Empty;
}
}
}

public LrcLine(double time, string text)
{
LrcTime = new TimeSpan(0, 0, 0, 0, (int)(time * 1000));
LrcText = text;
}

public LrcLine(TimeSpan? time, string text)
{
LrcTime = time;
LrcText = text;
}

public LrcLine(TimeSpan? time)
: this(time, string.Empty)
{
}

public LrcLine(LrcLine lrcLine)
{
LrcTime = lrcLine.LrcTime;
LrcText = lrcLine.LrcText;
}

public LrcLine(string line)
: this(Parse(line))
{
}

public LrcLine()
{
LrcTime = null;
LrcText = string.Empty;
}

public static LrcLine Parse(string line)
{
if (string.IsNullOrWhiteSpace(line))
{
return Empty;
}

if (CheckMultiLine(line))
{
throw new FormatException();
}

string[] slices = line.TrimStart().TrimStart('[').Split(']');

if (!LrcHelper.TryParseTimeSpan(slices[0], out TimeSpan time))
{
return new LrcLine(null, slices[0]);
}

return new LrcLine(time, slices[1]);
}

public static bool TryParse(string line, out LrcLine lrcLine)
{
try
{
lrcLine = Parse(line);
return true;
}
catch
{
lrcLine = Empty;
return false;
}
}

public static bool CheckMultiLine(string line)
{
if (line.TrimStart().IndexOf('[', 1) != -1) return true;
else return false;
}

public override string ToString() => PreviewText;

public int CompareTo(LrcLine other)
{
// Sort order: null < TimeSpan < string
if (!LrcTime.HasValue) return -1;
if (!other.LrcTime.HasValue) return 1;
return LrcTime.Value.CompareTo(other.LrcTime.Value);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
<SpecificVersion>False</SpecificVersion>
<HintPath>Mediakit\Assemblies\DirectShowLib-2005.dll</HintPath>
</Reference>
<PackageReference Include="UTF.Unknown" Version="2.5.1" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,14 @@
Foreground="{DynamicResource WindowTextForeground}"
Text="{Binding ElementName=mediaElement, Path=MediaDuration, Converter={StaticResource TimeTickToShortStringConverter}}"
TextTrimming="CharacterEllipsis" />
<TextBlock x:Name="metaLyric"
Grid.Row="6"
Margin="0,0,8,0"
Padding="3"
FontSize="14"
Foreground="{DynamicResource WindowTextForeground}"
TextWrapping="Wrap"
Visibility="Collapsed" />
</Grid>
</Grid>

Expand Down
Loading

0 comments on commit 09bd9bc

Please sign in to comment.