Added after song start event

Author: Splamy

TS3ABotUnitTests/TS3ABotUnitTests.csproj

@@ -12,8 +12,8 @@
 
   <ItemGroup>
     <PackageReference Include="NUnit" Version="3.12.0" />
-    <PackageReference Include="NUnit3TestAdapter" Version="3.16.1" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
+    <PackageReference Include="NUnit3TestAdapter" Version="3.17.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.7.0" />
   </ItemGroup>
 
   <ItemGroup>

TS3AudioBot/Audio/FfmpegProducer.cs

@@ -66,9 +66,9 @@ public void AudioStop()
 			StopFfmpegProcess();
 		}
 
-		public TimeSpan Length => GetCurrentSongLength();
+		public TimeSpan? Length => GetCurrentSongLength();
 
-		public TimeSpan Position => ffmpegInstance?.AudioTimer.SongPosition ?? TimeSpan.Zero;
+		public TimeSpan? Position => ffmpegInstance?.AudioTimer.SongPosition;
 
 		public Task Seek(TimeSpan position) { SetPosition(position); return Task.CompletedTask; }
 
@@ -310,14 +310,7 @@ private void StopFfmpegProcess()
 			}
 		}
 
-		private TimeSpan GetCurrentSongLength()
-		{
-			var instance = ffmpegInstance;
-			if (instance is null)
-				return TimeSpan.Zero;
-
-			return instance.ParsedSongLength ?? TimeSpan.Zero;
-		}
+		private TimeSpan? GetCurrentSongLength() => ffmpegInstance?.ParsedSongLength;
 
 		private void AssertNotMainScheduler()
 		{

TS3AudioBot/Audio/IPlayerSource.cs

@@ -18,8 +18,8 @@ public interface IPlayerSource : IAudioPassiveProducer
 		event EventHandler OnSongEnd;
 		event EventHandler<SongInfoChanged> OnSongUpdated;
 
-		TimeSpan Length { get; }
-		TimeSpan Position { get; }
+		TimeSpan? Length { get; }
+		TimeSpan? Position { get; }
 
 		Task Seek(TimeSpan position);
 	}

TS3AudioBot/Audio/MetaData.cs TS3AudioBot/Audio/PlayInfo.cs

@@ -13,23 +13,23 @@
 
 namespace TS3AudioBot.Audio
 {
-	public sealed class MetaData
+	public sealed class PlayInfo
 	{
 		/// <summary>Defaults to: invoker.Uid - Can be set if the owner of a song differs from the invoker.</summary>
 		public Uid? ResourceOwnerUid { get; set; }
 		/// <summary>Starts the song at the specified time if set.</summary>
 		public TimeSpan? StartOffset { get; set; }
 
-		public MetaData(TimeSpan? startOffset = null)
+		public PlayInfo(TimeSpan? startOffset = null)
 		{
 			StartOffset = startOffset;
 		}
 
-		public MetaData Merge(MetaData other) => Merge(this, other);
+		public PlayInfo Merge(PlayInfo other) => Merge(this, other);
 
 		[return: NotNullIfNotNull("self")]
 		[return: NotNullIfNotNull("other")]
-		public static MetaData? Merge(MetaData? self, MetaData? other)
+		public static PlayInfo? Merge(PlayInfo? self, PlayInfo? other)
 		{
 			if (other is null)
 				return self;
@@ -40,20 +40,20 @@ public MetaData(TimeSpan? startOffset = null)
 			return self;
 		}
 
-		public static MetaData MergeDefault(MetaData? self, MetaData? other)
-			=> Merge(self, other) ?? new MetaData();
+		public static PlayInfo MergeDefault(PlayInfo? self, PlayInfo? other)
+			=> Merge(self, other) ?? new PlayInfo();
 	}
 
 	public interface IMetaContainer
 	{
-		public MetaData? Meta { get; set; }
+		public PlayInfo? PlayInfo { get; set; }
 	}
 
 	public static class MetaContainerExtensions
 	{
-		public static T MergeMeta<T>(this T container, MetaData? other) where T : IMetaContainer
+		public static T MergeMeta<T>(this T container, PlayInfo? other) where T : IMetaContainer
 		{
-			container.Meta = MetaData.Merge(container.Meta, other);
+			container.PlayInfo = PlayInfo.Merge(container.PlayInfo, other);
 			return container;
 		}
 	}

TS3AudioBot/Audio/PlayInfoEventArgs.cs

@@ -17,7 +17,7 @@ public sealed class PlayInfoEventArgs : EventArgs
 		public InvokerData Invoker { get; }
 		public PlayResource PlayResource { get; }
 		public AudioResource ResourceData => PlayResource.AudioResource;
-		public MetaData? MetaData => PlayResource.Meta;
+		public PlayInfo? PlayInfo => PlayResource.PlayInfo;
 		public string? SourceLink { get; }
 
 		public PlayInfoEventArgs(InvokerData invoker, PlayResource playResource, string? sourceLink)

TS3AudioBot/Audio/PlayManager.cs

@@ -50,8 +50,8 @@ public PlayManager(ConfBot config, Player playerConnection, PlaylistManager play
 			this.stats = stats;
 		}
 
-		public Task Enqueue(InvokerData invoker, AudioResource ar, MetaData? meta = null) => Enqueue(invoker, new PlaylistItem(ar, meta));
-		public async Task Enqueue(InvokerData invoker, string message, string? audioType = null, MetaData? meta = null)
+		public Task Enqueue(InvokerData invoker, AudioResource ar, PlayInfo? meta = null) => Enqueue(invoker, new PlaylistItem(ar, meta));
+		public async Task Enqueue(InvokerData invoker, string message, string? audioType = null, PlayInfo? meta = null)
 		{
 			PlayResource playResource;
 			try { playResource = await resourceResolver.Load(message, audioType); }
@@ -77,8 +77,8 @@ public Task Enqueue(InvokerData invoker, PlaylistItem item)
 
 		private static PlaylistItem UpdateItem(InvokerData invoker, PlaylistItem item)
 		{
-			item.Meta ??= new MetaData();
-			item.Meta.ResourceOwnerUid = invoker.ClientUid;
+			item.PlayInfo ??= new PlayInfo();
+			item.PlayInfo.ResourceOwnerUid = invoker.ClientUid;
 			return item;
 		}
 
@@ -95,7 +95,7 @@ private async Task PostEnqueue(InvokerData invoker, int startIndex)
 		/// <param name="ar">The resource to load and play.</param>
 		/// <param name="meta">Allows overriding certain settings for the resource. Can be null.</param>
 		/// <returns>Ok if successful, or an error message otherwise.</returns>
-		public async Task Play(InvokerData invoker, AudioResource ar, MetaData? meta = null)
+		public async Task Play(InvokerData invoker, AudioResource ar, PlayInfo? meta = null)
 		{
 			if (ar is null)
 				throw new ArgumentNullException(nameof(ar));
@@ -116,7 +116,7 @@ public async Task Play(InvokerData invoker, AudioResource ar, MetaData? meta = n
 		/// <param name="audioType">The associated resource type string to a factory.</param>
 		/// <param name="meta">Allows overriding certain settings for the resource. Can be null.</param>
 		/// <returns>Ok if successful, or an error message otherwise.</returns>
-		public async Task Play(InvokerData invoker, string link, string? audioType = null, MetaData? meta = null)
+		public async Task Play(InvokerData invoker, string link, string? audioType = null, PlayInfo? meta = null)
 		{
 			PlayResource playResource;
 			try { playResource = await resourceResolver.Load(link, audioType); }
@@ -175,7 +175,7 @@ private async Task StartResource(InvokerData invoker, PlaylistItem item)
 				throw;
 			}
 			stats.TrackSongLoad(item.AudioResource.AudioType, true, false);
-			await StartResource(invoker, playResource.MergeMeta(item.Meta));
+			await StartResource(invoker, playResource.MergeMeta(item.PlayInfo));
 		}
 
 		private async Task StartResource(InvokerData invoker, PlayResource play)
@@ -299,12 +299,12 @@ public async Task Update(SongInfoChanged newInfo)
 			}
 		}
 
-		public static MetaData? ParseAttributes(string[] attrs)
+		public static PlayInfo? ParseAttributes(string[] attrs)
 		{
 			if (attrs is null || attrs.Length == 0)
 				return null;
 
-			var meta = new MetaData();
+			var meta = new PlayInfo();
 			foreach (var attr in attrs)
 			{
 				if (attr.StartsWith("@"))

TS3AudioBot/Audio/Player.cs

@@ -69,7 +69,7 @@ public async Task Play(PlayResource res)
 			if (res is MediaPlayResource mres && mres.IsIcyStream)
 				await FfmpegProducer.AudioStartIcy(res.PlayUri);
 			else
-				await FfmpegProducer.AudioStart(res.PlayUri, res.Meta?.StartOffset);
+				await FfmpegProducer.AudioStart(res.PlayUri, res.PlayInfo?.StartOffset);
 			Play(FfmpegProducer);
 		}
 
@@ -116,9 +116,9 @@ public void StopAll()
 			MergePipe.Dispose();
 		}
 
-		public TimeSpan Length => CurrentPlayerSource?.Length ?? TimeSpan.Zero;
+		public TimeSpan? Length => CurrentPlayerSource?.Length;
 
-		public TimeSpan Position => CurrentPlayerSource?.Position ?? TimeSpan.Zero;
+		public TimeSpan? Position => CurrentPlayerSource?.Position;
 
 		public Task Seek(TimeSpan position) => CurrentPlayerSource?.Seek(position) ?? Task.CompletedTask;
 

TS3AudioBot/Audio/StreamAudioPlayerSource.cs

@@ -18,8 +18,8 @@ public class StreamAudioPlayerSource : IPlayerSource, IAudioActiveConsumer
 		private bool hasFired = false;
 
 		public IAudioPassiveProducer? InStream { get; set; }
-		public TimeSpan Length => TimeSpan.Zero;
-		public TimeSpan Position => TimeSpan.Zero;
+		public TimeSpan? Length => null;
+		public TimeSpan? Position => null;
 
 		public event EventHandler? OnSongEnd;
 		event EventHandler<SongInfoChanged> IPlayerSource.OnSongUpdated { add { } remove { } }

TS3AudioBot/Bot.cs

@@ -133,8 +133,9 @@ public Bot(Id id, ConfBot config, BotInjector injector)
 			// Update idle status events
 			playManager.BeforeResourceStarted += (s, e) => { DisableIdleTickWorker(); return Task.CompletedTask; };
 			playManager.PlaybackStopped += (s, e) => { EnableIdleTickWorker(); return Task.CompletedTask; };
-			// Used for the voice_mode script
+			// Used for custom scripts, like voice_mode, onsongstart
 			playManager.BeforeResourceStarted += BeforeResourceStarted;
+			playManager.AfterResourceStarted += AfterResourceStarted;
 			// Update the own status text to the current song title
 			playManager.AfterResourceStarted += (s, e) => UpdateBotStatus();
 			playManager.PlaybackStopped += (s, e) => UpdateBotStatus();
@@ -143,8 +144,8 @@ public Bot(Id id, ConfBot config, BotInjector injector)
 			if (Injector.TryGet<HistoryManager>(out var historyManager))
 				playManager.AfterResourceStarted += (s, e) =>
 				{
-					if (e.MetaData != null)
-						historyManager.LogAudioResource(new HistorySaveData(e.PlayResource.AudioResource, e.MetaData.ResourceOwnerUid));
+					if (e.PlayInfo != null)
+						historyManager.LogAudioResource(new HistorySaveData(e.PlayResource.AudioResource, e.PlayInfo.ResourceOwnerUid));
 					return Task.CompletedTask;
 				};
 			// Update our thumbnail
@@ -338,6 +339,39 @@ private void OnClientLeftView(object? sender, ClientLeftView eventArgs)
 			sessionManager.RemoveSession(eventArgs.ClientId);
 		}
 
+		private async Task BeforeResourceStarted(object? sender, PlayInfoEventArgs e)
+		{
+			const string DefaultVoiceScript = "!whisper off";
+			const string DefaultWhisperScript = "!xecute (!whisper subscription) (!unsubscribe temporary) (!subscribe channeltemp (!getmy channel))";
+
+			var mode = config.Audio.SendMode.Value;
+			string script;
+			if (mode.StartsWith("!", StringComparison.Ordinal))
+				script = mode;
+			else if (mode.Equals("voice", StringComparison.OrdinalIgnoreCase))
+				script = DefaultVoiceScript;
+			else if (mode.Equals("whisper", StringComparison.OrdinalIgnoreCase))
+				script = DefaultWhisperScript;
+			else
+			{
+				Log.Error("Invalid voice mode");
+				return;
+			}
+
+			var info = CreateExecInfo(e.Invoker);
+			await CallScript(info, script, false, true);
+		}
+
+		private async Task AfterResourceStarted(object? sender, PlayInfoEventArgs e)
+		{
+			var onSongStart = config.Events.OnSongStart.Value;
+			if (!string.IsNullOrEmpty(onSongStart))
+			{
+				var info = CreateExecInfo();
+				await CallScript(info, onSongStart, false, true);
+			}
+		}
+
 		#region Status: Description, Avatar
 
 		public Task UpdateBotStatus()
@@ -449,28 +483,7 @@ await resourceResolver.GetThumbnail(startEvent.PlayResource,
 
 		#endregion
 
-		private async Task BeforeResourceStarted(object? sender, PlayInfoEventArgs e)
-		{
-			const string DefaultVoiceScript = "!whisper off";
-			const string DefaultWhisperScript = "!xecute (!whisper subscription) (!unsubscribe temporary) (!subscribe channeltemp (!getmy channel))";
-
-			var mode = config.Audio.SendMode.Value;
-			string script;
-			if (mode.StartsWith("!", StringComparison.Ordinal))
-				script = mode;
-			else if (mode.Equals("voice", StringComparison.OrdinalIgnoreCase))
-				script = DefaultVoiceScript;
-			else if (mode.Equals("whisper", StringComparison.OrdinalIgnoreCase))
-				script = DefaultWhisperScript;
-			else
-			{
-				Log.Error("Invalid voice mode");
-				return;
-			}
-
-			var info = CreateExecInfo(e.Invoker);
-			await CallScript(info, script, false, true);
-		}
+		#region Script Execution
 
 		private async Task CallScript(ExecutionInformation info, string command, bool answer, bool skipRights)
 		{
@@ -510,6 +523,35 @@ private ExecutionInformation CreateExecInfo(InvokerData? invoker = null, UserSes
 			return info;
 		}
 
+		private async Task TryCatchCommand(ExecutionInformation info, bool answer, Func<Task> action)
+		{
+			try
+			{
+				await action.Invoke();
+			}
+			catch (AudioBotException ex)
+			{
+				NLog.LogLevel commandErrorLevel = answer ? NLog.LogLevel.Debug : NLog.LogLevel.Warn;
+				Log.Log(commandErrorLevel, ex, "Command Error ({0})", ex.Message);
+				if (answer)
+				{
+					await info.Write(TextMod.Format(config.Commands.Color, strings.error_call_error.Mod().Color(Color.Red).Bold(), ex.Message))
+						.CatchToLog(Log);
+				}
+			}
+			catch (Exception ex)
+			{
+				Log.Error(ex, "Unexpected command error: {0}", ex.Message);
+				if (answer)
+				{
+					await info.Write(TextMod.Format(config.Commands.Color, strings.error_call_unexpected_error.Mod().Color(Color.Red).Bold(), ex.Message))
+						.CatchToLog(Log);
+				}
+			}
+		}
+
+		#endregion
+
 		#region Event: Idle
 
 		private async void OnIdle()
@@ -570,33 +612,6 @@ private async Task OnAloneChanged(object? sender, AloneChanged e)
 
 		#endregion
 
-		private async Task TryCatchCommand(ExecutionInformation info, bool answer, Func<Task> action)
-		{
-			try
-			{
-				await action.Invoke();
-			}
-			catch (AudioBotException ex)
-			{
-				NLog.LogLevel commandErrorLevel = answer ? NLog.LogLevel.Debug : NLog.LogLevel.Warn;
-				Log.Log(commandErrorLevel, ex, "Command Error ({0})", ex.Message);
-				if (answer)
-				{
-					await info.Write(TextMod.Format(config.Commands.Color, strings.error_call_error.Mod().Color(Color.Red).Bold(), ex.Message))
-						.CatchToLog(Log);
-				}
-			}
-			catch (Exception ex)
-			{
-				Log.Error(ex, "Unexpected command error: {0}", ex.Message);
-				if (answer)
-				{
-					await info.Write(TextMod.Format(config.Commands.Color, strings.error_call_unexpected_error.Mod().Color(Color.Red).Bold(), ex.Message))
-						.CatchToLog(Log);
-				}
-			}
-		}
-
 		public BotInfo GetInfo() => new BotInfo
 		{
 			Id = Id,

TS3AudioBot/Config/ConfigStructs.cs

@@ -291,6 +291,8 @@ public class ConfEvents : ConfigTable
 		public ConfigValue<TimeSpan> PartyDelay { get; } = new ConfigValue<TimeSpan>("party_delay", TimeSpan.Zero,
 			"Specifies how long the bot has to be alone until the 'onalone' event gets fired.\n" +
 			"You can specify the time in the ISO-8601 format \"PT30S\" or like: 15s, 1h, 3m30s");
+		public ConfigValue<string> OnSongStart { get; } = new ConfigValue<string>("onsongstart", "",
+			"Called when a new song starts.");
 	}
 
 	// Utility config structs

TS3AudioBot/Core.cs

@@ -82,6 +82,7 @@ public async Task Run(ParameterData setup)
 			if (!builder.Build())
 				throw new Exception("Could not load all core modules");
 
+			Upgrader.PerformUpgrades(injector);
 			YoutubeDlHelper.DataObj = config.Tools.YoutubeDl;
 
 			injector.GetModuleOrThrow<CommandManager>().RegisterCollection(MainCommands.Bag);