Merge pull request #2 from Eimaen/master

Plugin system prototype
AlexanderDotH · May 5, 2023 · 5b36a2a · 5b36a2a
2 parents 24a956a + f144bcc
commit 5b36a2a
Show file tree

Hide file tree

Showing 198 changed files with 892 additions and 418 deletions.
diff --git a/OpenLyricsClient.Plugin/ExamplePlugin.cs b/OpenLyricsClient.Plugin/ExamplePlugin.cs
@@ -0,0 +1,62 @@
+using DevBase.Format.Structure;
+using DevBase.Generics;
+using OpenLyricsClient.Shared.Plugin;
+using OpenLyricsClient.Shared.Structure.Artwork;
+using OpenLyricsClient.Shared.Structure.Lyrics;
+using OpenLyricsClient.Shared.Structure.Song;
+
+namespace OpenLyricsClient.Plugin
+{
+    public class ExamplePlugin : IPlugin
+    {
+        public PluginScope Scope => PluginScope.LyricsCollector;
+
+        public Task<Artwork?> CollectArtwork(SongResponseObject songResponseObject)
+        {
+            throw new NotImplementedException();
+        }
+
+        public async Task<LyricData?> CollectLyrics(SongResponseObject songResponseObject)
+        {
+            AList<LyricElement> lyrics = new AList<LyricElement>();
+            lyrics.Add(new LyricElement(533, "Here's my line"));
+            lyrics.Add(new LyricElement(536, "Here's another"));
+            lyrics.Add(new LyricElement(573, "Here's my line"));
+            lyrics.Add(new LyricElement(83, "Here's another"));
+            lyrics.Add(new LyricElement(5563, "Here's my line"));
+            lyrics.Add(new LyricElement(333, "Here's another"));
+            lyrics.Add(new LyricElement(43, "Here's another"));
+            lyrics.Add(new LyricElement(5323, "Here's another"));
+            lyrics.Add(new LyricElement(6333, "Here's another"));
+            lyrics.Add(new LyricElement(7453, "Here's another"));
+            lyrics.Add(new LyricElement(84583, "Here's another"));
+            lyrics.Add(new LyricElement(45743, "Here's another"));
+            return await LyricData.ConvertToData(lyrics, songResponseObject.SongRequestObject.Song.SongMetadata, "Plugin");
+        }
+
+        public Task<SongResponseObject?> CollectSong(SongRequestObject songRequestObject)
+        {
+            throw new NotImplementedException();
+        }
+
+        public int GetCollectedArtworkQuality()
+        {
+            throw new NotImplementedException();
+        }
+
+        public int GetCollectedLyricsQuality()
+        {
+            return 1337;
+        }
+
+        public int GetCollectedSongQuality()
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task<LyricData> ProcessLyrics(SongResponseObject songResponse, LyricData lyrics)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}
diff --git a/OpenLyricsClient.Plugin/OpenLyricsClient.Plugin.csproj b/OpenLyricsClient.Plugin/OpenLyricsClient.Plugin.csproj
@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net7.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\OpenLyricsClient.Shared\OpenLyricsClient.Shared.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/OpenLyricsClient.Shared/OpenLyricsClient.Shared.csproj b/OpenLyricsClient.Shared/OpenLyricsClient.Shared.csproj
@@ -0,0 +1,27 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net7.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Avalonia" Version="0.10.19" />
+    <PackageReference Include="Avalonia.X11" Version="0.10.19" />
+    <PackageReference Include="DevBase" Version="1.1.1" />
+    <PackageReference Include="DevBase.Api" Version="1.1.5" />
+    <PackageReference Include="DevBase.Avalonia" Version="1.0.1" />
+    <PackageReference Include="DevBase.Format" Version="1.2.1" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+    <PackageReference Include="SpotifyAPI.Web" Version="7.0.0" />
+    <PackageReference Include="Squalr.Engine" Version="2.3.0.1" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Reference Include="XWindowManager">
+      <HintPath>..\Libraries\XWindowManager.dll</HintPath>
+    </Reference>
+  </ItemGroup>
+
+</Project>
diff --git a/OpenLyricsClient.Shared/Plugin/IPlugin.cs b/OpenLyricsClient.Shared/Plugin/IPlugin.cs
@@ -0,0 +1,22 @@
+using OpenLyricsClient.Shared.Structure.Lyrics;
+using OpenLyricsClient.Shared.Structure.Song;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace OpenLyricsClient.Shared.Plugin
+{
+    public interface IPlugin
+    {
+        PluginScope Scope { get; }
+        Task<LyricData> ProcessLyrics(SongResponseObject songResponse, LyricData lyrics);
+        Task<LyricData?> CollectLyrics(SongResponseObject songResponseObject);
+        int GetCollectedLyricsQuality();
+        Task<SongResponseObject?> CollectSong(SongRequestObject songRequestObject);
+        int GetCollectedSongQuality();
+        Task<Structure.Artwork.Artwork?> CollectArtwork(SongResponseObject songResponseObject);
+        int GetCollectedArtworkQuality();
+    }
+}
diff --git a/OpenLyricsClient.Shared/Plugin/PluginScope.cs b/OpenLyricsClient.Shared/Plugin/PluginScope.cs
@@ -0,0 +1,15 @@
+using System;
+
+namespace OpenLyricsClient.Shared.Plugin
+{
+    [Flags]
+    public enum PluginScope
+    {
+        Dummy = 1,
+        LyricsPostprocess = 2,
+        LyricsViewRendering = 4,
+        LyricsCollector = 8,
+        SongCollector = 16,
+        ArtworkCollector = 32
+    }
+}
diff --git a/...ient/Backend/Structure/Artwork/Artwork.cs → ...lient.Shared/Structure/Artwork/Artwork.cs b/...ient/Backend/Structure/Artwork/Artwork.cs → ...lient.Shared/Structure/Artwork/Artwork.cs
@@ -13,7 +13,7 @@
 using Bitmap = Avalonia.Media.Imaging.Bitmap;
 using Color = Avalonia.Media.Color;
 
-namespace OpenLyricsClient.Backend.Structure.Artwork
+namespace OpenLyricsClient.Shared.Structure.Artwork
 {
     [Serializable]
     public class Artwork

diff --git a/...nd/Structure/Artwork/ArtworkReturnCode.cs → ...ed/Structure/Artwork/ArtworkReturnCode.cs b/...nd/Structure/Artwork/ArtworkReturnCode.cs → ...ed/Structure/Artwork/ArtworkReturnCode.cs
@@ -1,4 +1,4 @@
-namespace OpenLyricsClient.Backend.Structure.Artwork
+namespace OpenLyricsClient.Shared.Structure.Artwork
 {
     public enum ArtworkReturnCode
     {

diff --git a/OpenLyricsClient.Shared/Structure/Enum/DataOrigin.cs b/OpenLyricsClient.Shared/Structure/Enum/DataOrigin.cs
@@ -0,0 +1,6 @@
+namespace OpenLyricsClient.Shared.Structure.Enum;
+
+public enum DataOrigin
+{
+    SPOTIFY, TIDAL   
+}
diff --git a/...d/Structure/Enum/EnumLyricsDisplayMode.cs → ...d/Structure/Enum/EnumLyricsDisplayMode.cs b/...d/Structure/Enum/EnumLyricsDisplayMode.cs → ...d/Structure/Enum/EnumLyricsDisplayMode.cs
@@ -1,4 +1,4 @@
-namespace OpenLyricsClient.Backend.Structure.Enum;
+namespace OpenLyricsClient.Shared.Structure.Enum;
 
 public enum EnumLyricsDisplayMode
 {

diff --git a/...nt/Backend/Structure/Enum/EnumPlayback.cs → ...ent.Shared/Structure/Enum/EnumPlayback.cs b/...nt/Backend/Structure/Enum/EnumPlayback.cs → ...ent.Shared/Structure/Enum/EnumPlayback.cs
@@ -1,4 +1,4 @@
-namespace OpenLyricsClient.Backend.Structure.Enum;
+namespace OpenLyricsClient.Shared.Structure.Enum;
 
 public enum EnumPlayback
 {

diff --git a/...ckend/Structure/Enum/EnumRegisterTypes.cs → ...hared/Structure/Enum/EnumRegisterTypes.cs b/...ckend/Structure/Enum/EnumRegisterTypes.cs → ...hared/Structure/Enum/EnumRegisterTypes.cs
@@ -1,4 +1,4 @@
-namespace OpenLyricsClient.Backend.Structure.Enum
+namespace OpenLyricsClient.Shared.Structure.Enum
 {
     public enum EnumRegisterTypes
     {

diff --git a/...ent/Backend/Structure/Json/JsonArtwork.cs → ...ient.Shared/Structure/Json/JsonArtwork.cs b/...ent/Backend/Structure/Json/JsonArtwork.cs → ...ient.Shared/Structure/Json/JsonArtwork.cs
@@ -1,7 +1,7 @@
 using Avalonia.Media;
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json;
+namespace OpenLyricsClient.Shared.Structure.Json;
 
 public class JsonArtwork
 {

diff --git a/...t/Backend/Structure/Json/JsonCacheData.cs → ...nt.Shared/Structure/Json/JsonCacheData.cs b/...t/Backend/Structure/Json/JsonCacheData.cs → ...nt.Shared/Structure/Json/JsonCacheData.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json;
+namespace OpenLyricsClient.Shared.Structure.Json;
 
 public class JsonCacheData
 {

diff --git a/...t/Backend/Structure/Json/JsonLyricData.cs → ...nt.Shared/Structure/Json/JsonLyricData.cs b/...t/Backend/Structure/Json/JsonLyricData.cs → ...nt.Shared/Structure/Json/JsonLyricData.cs
@@ -1,12 +1,12 @@
 using Newtonsoft.Json;
-using OpenLyricsClient.Backend.Structure.Lyrics;
+using OpenLyricsClient.Shared.Structure.Lyrics;
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
 
-namespace OpenLyricsClient.Backend.Structure.Json
+namespace OpenLyricsClient.Shared.Structure.Json
 {
     public class JsonLyricData
     {

diff --git a/...ackend/Structure/Json/JsonSongMetadata.cs → ...Shared/Structure/Json/JsonSongMetadata.cs b/...ackend/Structure/Json/JsonSongMetadata.cs → ...Shared/Structure/Json/JsonSongMetadata.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json;
+namespace OpenLyricsClient.Shared.Structure.Json;
 
 public class JsonSongMetadata
 {

diff --git a/...t/Backend/Structure/Json/JsonSongState.cs → ...nt.Shared/Structure/Json/JsonSongState.cs b/...t/Backend/Structure/Json/JsonSongState.cs → ...nt.Shared/Structure/Json/JsonSongState.cs
@@ -1,8 +1,7 @@
-
 using Newtonsoft.Json;
-using OpenLyricsClient.Backend.Structure.Song;
+using OpenLyricsClient.Shared.Structure.Song;
 
-namespace OpenLyricsClient.Backend.Structure.Json;
+namespace OpenLyricsClient.Shared.Structure.Json;
 
 public class JsonSongState
 {

diff --git a/...on/Musixmatch/Json/MusixMatchAryGenres.cs → ...on/Musixmatch/Json/MusixMatchAryGenres.cs b/...on/Musixmatch/Json/MusixMatchAryGenres.cs → ...on/Musixmatch/Json/MusixMatchAryGenres.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchAryGenres
     {

diff --git a/...usixmatch/Json/MusixMatchFetchResponse.cs → ...usixmatch/Json/MusixMatchFetchResponse.cs b/...usixmatch/Json/MusixMatchFetchResponse.cs → ...usixmatch/Json/MusixMatchFetchResponse.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchFetchResponse
     {

diff --git a/...ch/Json/MusixMatchFetchResponseMessage.cs → ...ch/Json/MusixMatchFetchResponseMessage.cs b/...ch/Json/MusixMatchFetchResponseMessage.cs → ...ch/Json/MusixMatchFetchResponseMessage.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchFetchResponseMessage
     {

diff --git a/...son/MusixMatchFetchResponseMessageBody.cs → ...son/MusixMatchFetchResponseMessageBody.cs b/...son/MusixMatchFetchResponseMessageBody.cs → ...son/MusixMatchFetchResponseMessageBody.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchFetchResponseMessageBody
     {

diff --git a/...n/MusixMatchFetchResponseMessageHeader.cs → ...n/MusixMatchFetchResponseMessageHeader.cs b/...n/MusixMatchFetchResponseMessageHeader.cs → ...n/MusixMatchFetchResponseMessageHeader.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchFetchResponseMessageHeader
     {

diff --git a/.../Json/Musixmatch/Json/MusixMatchLyrics.cs → .../Json/Musixmatch/Json/MusixMatchLyrics.cs b/.../Json/Musixmatch/Json/MusixMatchLyrics.cs → .../Json/Musixmatch/Json/MusixMatchLyrics.cs
@@ -1,7 +1,7 @@
 using System;
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchLyrics
     {

diff --git a/...n/Musixmatch/Json/MusixMatchMacroCalls.cs → ...n/Musixmatch/Json/MusixMatchMacroCalls.cs b/...n/Musixmatch/Json/MusixMatchMacroCalls.cs → ...n/Musixmatch/Json/MusixMatchMacroCalls.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchMacroCalls
     {

diff --git a/...ixmatch/Json/MusixMatchMatcherTrackGet.cs → ...ixmatch/Json/MusixMatchMatcherTrackGet.cs b/...ixmatch/Json/MusixMatchMatcherTrackGet.cs → ...ixmatch/Json/MusixMatchMatcherTrackGet.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchMatcherTrackGet
     {

diff --git a/.../Json/MusixMatchMatcherTrackGetMessage.cs → .../Json/MusixMatchMatcherTrackGetMessage.cs b/.../Json/MusixMatchMatcherTrackGetMessage.cs → .../Json/MusixMatchMatcherTrackGetMessage.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchMatcherTrackGetMessage
     {

diff --git a/...n/MusixMatchMatcherTrackGetMessageBody.cs → ...n/MusixMatchMatcherTrackGetMessageBody.cs b/...n/MusixMatchMatcherTrackGetMessageBody.cs → ...n/MusixMatchMatcherTrackGetMessageBody.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusicMatchMatcherTrackGetMessageBody
     {

diff --git a/...MusixMatchMatcherTrackGetMessageHeader.cs → ...MusixMatchMatcherTrackGetMessageHeader.cs b/...MusixMatchMatcherTrackGetMessageHeader.cs → ...MusixMatchMatcherTrackGetMessageHeader.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchMatcherTrackGetMessageHeader
     {

diff --git a/...re/Json/Musixmatch/Json/MusixMatchMeta.cs → ...re/Json/Musixmatch/Json/MusixMatchMeta.cs b/...re/Json/Musixmatch/Json/MusixMatchMeta.cs → ...re/Json/Musixmatch/Json/MusixMatchMeta.cs
@@ -1,7 +1,7 @@
 using System;
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchMeta
     {

diff --git a/...n/Musixmatch/Json/MusixMatchMusicGenre.cs → ...n/Musixmatch/Json/MusixMatchMusicGenre.cs b/...n/Musixmatch/Json/MusixMatchMusicGenre.cs → ...n/Musixmatch/Json/MusixMatchMusicGenre.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchMusicGenre
     {

diff --git a/...sixmatch/Json/MusixMatchMusicGenreList.cs → ...sixmatch/Json/MusixMatchMusicGenreList.cs b/...sixmatch/Json/MusixMatchMusicGenreList.cs → ...sixmatch/Json/MusixMatchMusicGenreList.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchMusicGenreList
     {

diff --git a/...Json/Musixmatch/Json/MusixMatchSnippet.cs → ...Json/Musixmatch/Json/MusixMatchSnippet.cs b/...Json/Musixmatch/Json/MusixMatchSnippet.cs → ...Json/Musixmatch/Json/MusixMatchSnippet.cs
@@ -1,7 +1,7 @@
 using System;
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchSnippet
     {

diff --git a/...son/Musixmatch/Json/MusixMatchSubtitle.cs → ...son/Musixmatch/Json/MusixMatchSubtitle.cs b/...son/Musixmatch/Json/MusixMatchSubtitle.cs → ...son/Musixmatch/Json/MusixMatchSubtitle.cs
@@ -1,7 +1,7 @@
 using System;
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchSubtitle
     {

diff --git a/...Musixmatch/Json/MusixMatchSubtitleList.cs → ...Musixmatch/Json/MusixMatchSubtitleList.cs b/...Musixmatch/Json/MusixMatchSubtitleList.cs → ...Musixmatch/Json/MusixMatchSubtitleList.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchSubtitleList
     {

diff --git a/...e/Json/Musixmatch/Json/MusixMatchTrack.cs → ...e/Json/Musixmatch/Json/MusixMatchTrack.cs b/...e/Json/Musixmatch/Json/MusixMatchTrack.cs → ...e/Json/Musixmatch/Json/MusixMatchTrack.cs
@@ -1,7 +1,7 @@
 using System;
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchTrack
     {

diff --git a/...sixmatch/Json/MusixMatchTrackLyricsGet.cs → ...sixmatch/Json/MusixMatchTrackLyricsGet.cs b/...sixmatch/Json/MusixMatchTrackLyricsGet.cs → ...sixmatch/Json/MusixMatchTrackLyricsGet.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenLyricsClient.Backend.Structure.Json.Musixmatch.Json
+namespace OpenLyricsClient.Shared.Structure.Json.Musixmatch.Json
 {
     public class MusixMatchTrackLyricsGet
     {