Initial commit

This commit is contained in:
Thord Johansson 2024-06-02 17:42:01 +02:00
commit 78a1ff1b3b
6 changed files with 758 additions and 0 deletions

401
.gitignore vendored Normal file
View file

@ -0,0 +1,401 @@
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
# User-specific files
*.rsuser
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Mono auto generated files
mono_crash.*
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
[Ww][Ii][Nn]32/
[Aa][Rr][Mm]/
[Aa][Rr][Mm]64/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
[Ll]ogs/
# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# Visual Studio 2017 auto generated files
Generated\ Files/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUnit
*.VisualState.xml
TestResult.xml
nunit-*.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# Benchmark Results
BenchmarkDotNet.Artifacts/
# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/
# ASP.NET Scaffolding
ScaffoldingReadMe.txt
# StyleCop
StyleCopReport.xml
# Files built by Visual Studio
*_i.c
*_p.c
*_h.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*_wpftmp.csproj
*.log
*.tlog
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# Visual Studio Trace Files
*.e2e
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json
# Coverlet is a free, cross platform Code Coverage Tool
coverage*.json
coverage*.xml
coverage*.info
# Visual Studio code coverage results
*.coverage
*.coveragexml
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# NuGet Symbol Packages
*.snupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
*.appxbundle
*.appxupload
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!?*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs
# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak
# SQL Server files
*.mdf
*.ldf
*.ndf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser
*- [Bb]ackup.rdl
*- [Bb]ackup ([0-9]).rdl
*- [Bb]ackup ([0-9][0-9]).rdl
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw
# Visual Studio 6 auto-generated project file (contains which files were open etc.)
*.vbp
# Visual Studio 6 workspace and project file (working project files containing files to include in project)
*.dsw
*.dsp
# Visual Studio 6 technical files
*.ncb
*.aps
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# CodeRush personal settings
.cr/personal
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Tabs Studio
*.tss
# Telerik's JustMock configuration file
*.jmconfig
# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs
# OpenCover UI analysis results
OpenCover/
# Azure Stream Analytics local run output
ASALocalRun/
# MSBuild Binary and Structured Log
*.binlog
# NVidia Nsight GPU debugger configuration file
*.nvuser
# MFractors (Xamarin productivity tool) working folder
.mfractor/
# Local History for Visual Studio
.localhistory/
# Visual Studio History (VSHistory) files
.vshistory/
# BeatPulse healthcheck temp database
healthchecksdb
# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/
# Ionide (cross platform F# VS Code tools) working folder
.ionide/
# Fody - auto-generated XML schema
FodyWeavers.xsd
# VS Code files for those working on multiple tools
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace
# Local History for Visual Studio Code
.history/
# Windows Installer files from build outputs
*.cab
*.msi
*.msix
*.msm
*.msp
# JetBrains Rider
*.sln.iml
# Example files
*.ini

249
Program.cs Normal file
View file

@ -0,0 +1,249 @@
using DiscordRPC.Logging;
using DiscordRPC;
using MetaBrainz.ListenBrainz;
using MetaBrainz.MusicBrainz;
using IniParser;
using IniParser.Model;
using Topshelf;
using Microsoft.VisualBasic;
using System.Web;
using MetaBrainz.MusicBrainz.Interfaces.Entities;
using MetaBrainz.MusicBrainz.Interfaces.Searches;
public class LbzRpcService
{
DiscordRpcClient? client = null;
ListenBrainz? listenBrainz = null;
Thread t;
bool running = false;
public LbzRpcService()
{
t = new Thread(MainThread);
}
public void Start()
{
running = true;
t.Start();
}
public void Stop()
{
running = false;
client?.Dispose();
listenBrainz?.Dispose();
}
public void MainThread()
{
FileIniDataParser config = new FileIniDataParser();
if (!File.Exists("config.ini"))
{
throw new ApplicationException("Configuration file not found. Please create a config.ini file with your tokens and user information.");
}
IniData data = config.ReadFile("config.ini");
listenBrainz = new ListenBrainz();
client = new DiscordRpcClient(data["general"]["discord_token"]);
void InitializeDiscordRpc()
{
client.Logger = new ConsoleLogger() { Level = LogLevel.Warning };
client.SkipIdenticalPresence = true;
client.OnReady += (sender, e) =>
{
Console.WriteLine("Received Ready from user {0}", e.User.Username);
};
client.Initialize();
}
bool connected = false;
client.OnConnectionEstablished += (sender, e) =>
{
Console.WriteLine("Connected to Discord");
connected = true;
};
InitializeDiscordRpc();
string? lastRecording = null;
List<Button> buttons = new List<Button>();
string albumArtUrl = "";
while (running)
{
if (!connected)
{
// Wait for Discord client to connect
Thread.Sleep(2000);
continue;
}
var username = data["general"]["listenbrainz_username"];
var ignoredPlayers = data["general"]["ignored_sources"].Split(",", StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
var listen = listenBrainz.GetPlayingNow(username);
if (listen != null)
{
//check ignored players
if (listen.Track?.Info?.AdditionalInfo?.MediaPlayer != null && ignoredPlayers.Any(player => player.ToLower() == listen.Track.Info.AdditionalInfo.MediaPlayer.ToLower()))
{
Console.WriteLine("Ignoring player {0}", listen.Track.Info.AdditionalInfo.MediaPlayer);
client.ClearPresence();
}
else
{
var listenData = listen.Track?.Info;
if (listenData != null)
{
if (listenData.AdditionalInfo.OriginUrl != null && (listenData.AdditionalInfo.OriginUrl?.Host == "music.youtube.com" || listenData.AdditionalInfo.OriginUrl?.Host == "www.youtube.com") && lastRecording != GetYoutubeId(listenData.AdditionalInfo.OriginUrl))
{
lastRecording = GetYoutubeId(listenData.AdditionalInfo.OriginUrl);
Console.WriteLine("Searching for release {0} on MusicBrainz", listenData.Release);
Query q = new("LBZ-DRPC", new Version(1, 0, 0));
ISearchResult<IRelease>? release = null;
if (listenData.Release != null || listenData.Artist != null)
{
release = q.FindReleases(listenData.Release ?? listenData.Artist, 1).Results?.FirstOrDefault();
if (release?.Item.CoverArtArchive == null || !release.Item.CoverArtArchive.Front)
{
if (release?.Item.Aliases != null)
foreach (IAlias alias in release.Item.Aliases)
{
if (alias.Primary == true)
{
var r = q.FindReleases(alias.Name, 1).Results?.FirstOrDefault();
if (release != null && release.Item.CoverArtArchive?.Front == true)
{
release = r;
}
}
};
}
}
if (release != null)
{
albumArtUrl = "https://coverartarchive.org/release/" + release.Item.Id + "/front-250.jpg";
//albumArtUrl = "https://coverartarchive.org/release/" + release?.Item.Id + "/front-250.jpg";
}
else
{
var youtubeId = GetYoutubeId(listenData.AdditionalInfo.OriginUrl);
albumArtUrl = "https://img.youtube.com/vi/" + youtubeId + "/0.jpg";
}
}
else if (lastRecording != listenData.AdditionalInfo?.RecordingId.ToString()) // MusicBrainz ID available
{
Console.WriteLine("Listening to {0} by {1}", listenData.Name, listenData.Artist);
lastRecording = listenData.AdditionalInfo?.RecordingId.ToString();
buttons = new List<Button>();
if (listenData.AdditionalInfo?.RecordingId != null)
{
buttons.Add(new Button() { Label = "Listen on MusicBrainz", Url = $"https://listenbrainz.org/player/?recording_mbids={listenData.AdditionalInfo?.RecordingId}" });
}
buttons.Add(new Button() { Label = $"{username} on ListenBrainz", Url = $"https://listenbrainz.org/user/{username}" });
if (listenData.AdditionalInfo?.ReleaseId != null)
{
albumArtUrl = "https://coverartarchive.org/release/" + listenData.AdditionalInfo?.ReleaseId + "/front-250.jpg";
}
else if (listenData.Release != null)
{
Console.WriteLine("Searching for release {0} on MusicBrainz", listenData.Release);
Query q = new("LBZ-DRPC", new Version(1, 0, 0));
var release = q.FindReleases(listenData.Release, 1).Results?.FirstOrDefault();
if (release != null)
{
albumArtUrl = "https://coverartarchive.org/release/" + release?.Item.Id + "/front-250.jpg";
}
}
Console.WriteLine("Album art URL: " + albumArtUrl);
}
client.SetPresence(new RichPresence()
{
Details = $"{listenData.Name}",
State = (listenData.Release != null && listenData.Release != listenData.Name) ? $"{listenData.Artist} ({listenData.Release})" : listenData.Artist,
Buttons = buttons.ToArray(),
Assets = new Assets()
{
SmallImageKey = "play",
LargeImageKey = albumArtUrl,
LargeImageText = $"Listening to {listenData.Name} by {listenData.Artist}{(listenData.AdditionalInfo?.MediaPlayer != null ? " (via " + listenData.AdditionalInfo.MediaPlayer + ")" : "")}"
}
});
}
else
{
Console.WriteLine("Not listening to anything");
client.ClearPresence();
}
}
}
else
{
Console.WriteLine("Not listening to anything");
client.ClearPresence();
}
var interval = int.Parse(data["general"]["poll_interval"]);
while (interval > 0 && running)
{
Thread.Sleep(1000);
interval--;
}
}
}
private string? GetYoutubeId(Uri originUrl)
{
var query = HttpUtility.ParseQueryString(originUrl.Query);
if (query["v"] != null)
{
return query["v"];
}
return null;
}
}
internal static class ConfigureService
{
internal static void Configure()
{
HostFactory.Run(configure =>
{
configure.Service<LbzRpcService>(service =>
{
service.ConstructUsing(s => new LbzRpcService());
service.WhenStarted(s => s.Start());
service.WhenStopped(s => s.Stop());
});
//Setup Account that window service use to run.
configure.RunAsLocalSystem();
configure.SetServiceName("ListenBrainzDiscordRpc");
configure.SetDisplayName("ListenBrainz Discord Rich Presence");
configure.SetDescription("Updates your Discord Rich Presence with your currently playing track on ListenBrainz.");
});
}
}
public class Program
{
public static void Main(string[] args)
{
ConfigureService.Configure();
}
}

52
README.md Normal file
View file

@ -0,0 +1,52 @@
# ListenBrainz-DiscordRPC Broker
This is a simple broker that watches a ListenBrainz now-playing status and sends it to Discord RPC.
## Usage as standalone application
> **NOTE:** This project has not been tested on Linux but should work with minimal changes. The Windows service functionality will not work on Linux.
The project can be run directly by simply running `dotnet run` in the project directory. This will start the broker and begin sending now-playing status to Discord RPC.
You can also start the executable directly from the binary output directory; note that a valid configuration file must be present in the same directory as the executable.
## Installation as a Windows Service
Alternatively, this project uses Topshelf to install as a Windows service. To install it, run the following command (as administrator):
```
lbz-rpc.exe install
```
To uninstall the service, run the following command:
```
lbz-rpc.exe uninstall
```
While installed you can manage the service using Services (`services.msc`) or the Topshelf command line (`lbz-rpc.exe start`, `lbz-rpc.exe stop`, `lbz-rpc.exe restart`).
## Configuration
In a file called `config.ini`, provide the necessary details:
```ini
[general]
discord_token = ###
listenbrainz_username = your_username_here
poll_interval = 10
ignored_sources = jellyfin
```
Explanation of the fields:
- `discord_token`: The token of your Discord application. You can create a new application and get the token from the Discord Developer Portal.
- `listenbrainz_username`: Your ListenBrainz username.
- `poll_interval`: The interval in seconds at which the broker will poll ListenBrainz for now-playing status.
- `ignored_sources`: A comma-separated list of sources to ignore. This is useful if you want to ignore certain sources from being sent to Discord RPC (such as if you're already using jellyfin-rpc and want this to catch everything else).
## Scrobbling
**An account on ListenBrainz will be required to use this broker.**
This broker does not scrobble tracks to ListenBrainz. If you want to scrobble tracks, here are some suggestions:
- [Web Scrobbler for Firefox](https://addons.mozilla.org/en-US/firefox/addon/web-scrobbler/) - A browser extension that scrobbles tracks from various sources. Recommend configuring to ignore media that is not categorised as music.
- [jellyfin-plugin-listenbrainz](https://github.com/lyarenei/jellyfin-plugin-listenbrainz) - A Jellyfin plugin that scrobbles tracks from Jellyfin to ListenBrainz.
For more suggestions, see the [official ListenBrainz website](https://listenbrainz.org/add-data/).

5
config.ini.example Normal file
View file

@ -0,0 +1,5 @@
[general]
discord_token =
listenbrainz_username =
poll_interval =
; Polling interval is specified in seconds

26
lbz-rpc.csproj Normal file
View file

@ -0,0 +1,26 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<RootNamespace>lbz_rpc</RootNamespace>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<StartupObject>Program</StartupObject>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="DiscordRichPresence" Version="1.2.1.24" />
<PackageReference Include="INIFileParserDotNetCore" Version="2.5.2" />
<PackageReference Include="MetaBrainz.ListenBrainz" Version="4.0.0" />
<PackageReference Include="MetaBrainz.MusicBrainz" Version="6.1.0" />
<PackageReference Include="Topshelf" Version="4.3.0" />
</ItemGroup>
<ItemGroup>
<None Update="config.ini">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
</ItemGroup>
</Project>

25
lbz-rpc.sln Normal file
View file

@ -0,0 +1,25 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.9.34902.65
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "lbz-rpc", "lbz-rpc.csproj", "{79004880-81EC-44FE-AB34-AD109028E585}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{79004880-81EC-44FE-AB34-AD109028E585}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{79004880-81EC-44FE-AB34-AD109028E585}.Debug|Any CPU.Build.0 = Debug|Any CPU
{79004880-81EC-44FE-AB34-AD109028E585}.Release|Any CPU.ActiveCfg = Release|Any CPU
{79004880-81EC-44FE-AB34-AD109028E585}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {7F63ED64-6A90-408B-BD9B-3ABE375A038A}
EndGlobalSection
EndGlobal