Small performance improvements

- tiny performance improvement in the encoder
- added early chain abort check
- readded stall checker

TS3AudioBot/Audio/CustomTargetPipe.cs

@@ -14,8 +14,8 @@ namespace TS3AudioBot.Audio
 	using System.Collections.Generic;
 	using System.Linq;
 	using TS3Client;
+	using TS3Client.Audio;
 	using TS3Client.Full;
-	using TS3Client.Full.Audio;
 
 	internal class CustomTargetPipe : ITargetManager, IAudioPassiveConsumer
 	{
@@ -24,6 +24,23 @@ internal class CustomTargetPipe : ITargetManager, IAudioPassiveConsumer
 		public GroupWhisperType GroupWhisperType { get; set; }
 		public GroupWhisperTarget GroupWhisperTarget { get; set; }
 
+		public bool Active
+		{
+			get
+			{
+				switch (SendMode)
+				{
+				case TargetSendMode.None:
+					return false;
+				case TargetSendMode.Whisper:
+					UpdatedSubscriptionCache();
+					return channelSubscriptionsCache.Length > 0 || clientSubscriptionsCache.Length > 0;
+				default:
+					return true;
+				}
+			}
+		}
+
 		private readonly Dictionary<ulong, bool> channelSubscriptionsSetup;
 		private readonly List<ushort> clientSubscriptionsSetup;
 		private ulong[] channelSubscriptionsCache;
@@ -64,10 +81,6 @@ public void Write(Span<byte> data, Meta meta)
 			}
 		}
 
-		// TODO get this somehow to the front of the pipechain, to prevent further chain execution
-		// if (SendMode == TargetSendMode.Whisper)
-		// doSend &= channelSubscriptionsCache.Length > 0 || clientSubscriptionsCache.Length > 0;
-
 		#region ITargetManager
 
 		public void SetGroupWhisper(GroupWhisperType type, GroupWhisperTarget target, ulong targetId = 0)
@@ -79,8 +92,6 @@ public void SetGroupWhisper(GroupWhisperType type, GroupWhisperTarget target, ul
 
 		public void WhisperChannelSubscribe(ulong channel, bool temp)
 		{
-			// TODO move to requested channel
-			// TODO spawn new client
 			lock (subscriptionLockObj)
 			{
 				if (channelSubscriptionsSetup.TryGetValue(channel, out var subscriptionTemp))

TS3AudioBot/Audio/FfmpegProducer.cs

@@ -15,7 +15,7 @@ namespace TS3AudioBot.Audio
 	using System.Diagnostics;
 	using System.Globalization;
 	using System.Text.RegularExpressions;
-	using TS3Client.Full.Audio;
+	using TS3Client.Audio;
 
 	public class FfmpegProducer : IAudioPassiveProducer, ISampleInfo, IDisposable
 	{

TS3AudioBot/Audio/StallCheckPipe.cs

@@ -0,0 +1,64 @@
+// TS3AudioBot - An advanced Musicbot for Teamspeak 3
+// Copyright (C) 2017  TS3AudioBot contributors
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the Open Software License v. 3.0
+//
+// You should have received a copy of the Open Software License along with this
+// program. If not, see <https://opensource.org/licenses/OSL-3.0>.
+
+namespace TS3AudioBot.Audio
+{
+	using System;
+	using TS3Client.Audio;
+
+	public class StallCheckPipe : IAudioPipe
+	{
+		private const uint StallCountInterval = 10;
+		private const uint StallNoErrorCountMax = 5;
+
+		public bool Active => OutStream?.Active ?? false;
+		public IAudioPassiveConsumer OutStream { get; set; }
+
+		private bool isStall;
+		private uint stallCount;
+		private uint stallNoErrorCount;
+
+		public StallCheckPipe()
+		{
+			isStall = false;
+			stallCount = 0;
+		}
+
+		public void Write(Span<byte> data, Meta meta)
+		{
+			if (OutStream == null) return;
+
+			if (isStall)
+			{
+				// TODO maybe do time-cooldown instead of call-count-cooldown
+				if (++stallCount % StallCountInterval == 0)
+				{
+					stallNoErrorCount++;
+					if (stallNoErrorCount > StallNoErrorCountMax)
+					{
+						stallCount = 0;
+						isStall = false;
+					}
+				}
+				else
+				{
+					return;
+				}
+			}
+
+			OutStream?.Write(data, meta);
+		}
+
+		public void SetStall()
+		{
+			stallNoErrorCount = 0;
+			isStall = true;
+		}
+	}
+}

TS3AudioBot/Bot.cs

@@ -94,7 +94,6 @@ public R InitializeBot()
 
 			if (!Injector.AllResolved())
 			{
-				// TODO detailed log + for inner if
 				Log.Warn("Cyclic bot module dependency");
 				Injector.ForceCyclicResolve();
 				if (!Injector.AllResolved())

TS3AudioBot/Commands.cs

@@ -24,7 +24,7 @@ namespace TS3AudioBot
 	using System.Linq;
 	using System.Text;
 	using TS3Client;
-	using TS3Client.Full.Audio;
+	using TS3Client.Audio;
 	using TS3Client.Messages;
 	using Web.Api;
 

TS3AudioBot/Core.cs

@@ -158,7 +158,7 @@ private R InitializeCore()
 			Log.Info("[=== Version: {0}", SystemData.AssemblyData);
 			Log.Info("[=== Platform: {0}", SystemData.PlattformData);
 			Log.Info("[=== Runtime: {0}", SystemData.RuntimeData.FullName);
-			Log.Info("[=== Opus: {0}", TS3Client.Full.Audio.Opus.NativeMethods.Info);
+			Log.Info("[=== Opus: {0}", TS3Client.Audio.Opus.NativeMethods.Info);
 			Log.Info("[==============================================]");
 			if (SystemData.RuntimeData.Runtime == Runtime.Mono)
 			{
@@ -207,7 +207,6 @@ private R InitializeCore()
 
 			if (!Injector.AllResolved())
 			{
-				// TODO detailed log + for inner if
 				Log.Debug("Cyclic core module dependency");
 				Injector.ForceCyclicResolve();
 				if (!Injector.AllResolved())

TS3AudioBot/Dependency/DependencyRealm.cs

@@ -31,7 +31,8 @@ public DependencyRealm()
 			Util.Init(out modules);
 		}
 
-		// TODO doc
+		/// <summary>Will add the type to pool of registered types which can be injected into other dependencies.</summary>
+		/// <typeparam name="TModule">The type to add</typeparam>
 		public void RegisterType<TModule>() => RegisterType(typeof(TModule));
 
 		private void RegisterType(Type modType)
@@ -41,7 +42,13 @@ private void RegisterType(Type modType)
 			registeredTypes.Add(modType);
 		}
 
-		// TODO doc
+		/// <summary>Adds an object as a new module to the module pool.
+		/// The realm will inject all registered types into public propeties as soon as available.</summary>
+		/// <typeparam name="TMod">The type of the module to add</typeparam>
+		/// <param name="module">The object to add as a new module.</param>
+		/// <param name="onInit">An initialize method that gets called when all dependencies are inected into this module.
+		/// Note that declaring this param will force the realm to be more strict with this modul
+		/// and make cyclic dependencies harder to resolve.</param>
 		public void RegisterModule<TMod>(TMod module, Action<TMod> onInit = null) where TMod : class
 		{
 			var onInitObject = onInit != null ? new Action<object>(x => onInit((TMod)x)) : null;
@@ -54,7 +61,9 @@ private void RegisterModule(object module, Action<object> onInit = null)
 			DoQueueInitialize(false);
 		}
 
-		// TODO doc
+		/// <summary>Injects all dependencies into the passe object without registering it as a new module.</summary>
+		/// <param name="obj">The object to fill.</param>
+		/// <returns>True if all registered types were available and could be injected, false otherwise.</returns>
 		public bool TryInject(object obj) => TryResolve(obj, InitState.SetOnly, false);
 
 		// Maybe in future update child realm when parent gets updated
@@ -66,7 +75,7 @@ private void RegisterModule(object module, Action<object> onInit = null)
 			return child;
 		}
 
-		// TODO doc
+		/// <summary>Tries to initialize all modules while allowing undefined behaviour when resolving cyclic dependecies.</summary>
 		public void ForceCyclicResolve()
 		{
 			DoQueueInitialize(true);
@@ -144,15 +153,18 @@ private bool TryResolve(object obj, InitState state, bool force)
 			return true;
 		}
 
-		// TODO doc
-		public object GetModule<TModule>() where TModule : class => GetModule(typeof(TModule));
+		/// <summary>Gets a module assignable to the requested type.</summary>
+		/// <typeparam name="TModule">The type to get.</typeparam>
+		/// <returns>The object if found, null otherwiese.</returns>
+		public TModule GetModule<TModule>() where TModule : class => (TModule)GetModule(typeof(TModule));
 		public object GetModule(Type type) => FindInjectableModule(type, InitState.Done, false)?.Obj;
 
 		void IInjector.AddModule(object obj) => RegisterModule(obj);
 
 		public IEnumerable<object> GetAllModules() => modules.Select(x => x.Obj);
 
-		// TODO doc
+		/// <summary>Checks if all module could get initialized.</summary>
+		/// <returns>True if all are initialized, false otherwise.</returns>
 		public bool AllResolved() => modules.All(x => x.Status == InitState.Done);
 
 		public void Unregister(Type type)

TS3AudioBot/ITargetManager.cs

@@ -10,7 +10,7 @@
 namespace TS3AudioBot
 {
 	using TS3Client;
-	using TS3Client.Full.Audio;
+	using TS3Client.Audio;
 
 	/// <summary>Used to specify playing mode and active targets to send to.</summary>
 	public interface ITargetManager

TS3AudioBot/Plugins/Plugin.cs

@@ -336,7 +336,7 @@ public PluginResponse Start(Bot bot)
 				return PluginResponse.UnknownError;
 
 			case PluginStatus.NotAvailable:
-				return PluginResponse.MissingContext; // TODO
+				return PluginResponse.MissingContext;
 
 			default:
 				throw new ArgumentOutOfRangeException();

TS3AudioBot/TS3AudioBot.csproj

@@ -91,6 +91,7 @@
     <Compile Include="Algorithm\LinearFeedbackShiftRegister.cs" />
     <Compile Include="Audio\CustomTargetPipe.cs" />
     <Compile Include="Audio\FfmpegProducer.cs" />
+    <Compile Include="Audio\StallCheckPipe.cs" />
     <Compile Include="BotManager.cs" />
     <Compile Include="Commands.cs" />
     <Compile Include="CommandSystem\Ast\AstCommand.cs" />

TS3AudioBot/Ts3Full.cs

@@ -16,8 +16,8 @@ namespace TS3AudioBot
 	using System.Linq;
 	using System.Reflection;
 	using TS3Client;
+	using TS3Client.Audio;
 	using TS3Client.Full;
-	using TS3Client.Full.Audio;
 	using TS3Client.Helper;
 	using TS3Client.Messages;
 
@@ -28,8 +28,6 @@ internal sealed class Ts3Full : TeamspeakControl, IPlayerConnection
 		private ClientData self;
 
 		private const Codec SendCodec = Codec.OpusMusic;
-		private const uint StallCountInterval = 10;
-		private const uint StallNoErrorCountMax = 5;
 		private static readonly string[] QuitMessages = {
 			"I'm outta here", "You're boring", "Have a nice day", "Bye", "Good night",
 			"Nothing to do here", "Taking a break", "Lorem ipsum dolor sit amet…",
@@ -45,11 +43,10 @@ internal sealed class Ts3Full : TeamspeakControl, IPlayerConnection
 
 		private readonly Ts3FullClientData ts3FullClientData;
 
-		private bool isStall;
-		private uint stallCount;
-		private uint stallNoErrorCount;
 		private IdentityData identity;
 
+		private readonly StallCheckPipe stallCheckPipe;
+		private readonly ActiveCheckPipe activeCheckPipe;
 		private readonly VolumePipe volumePipe;
 		private readonly FfmpegProducer ffmpegProducer;
 		private readonly PreciseTimedPipe timePipe;
@@ -64,17 +61,17 @@ public Ts3Full(Ts3FullClientData tfcd) : base(ClientType.Full)
 			tfcd.PropertyChanged += Tfcd_PropertyChanged;
 
 			ffmpegProducer = new FfmpegProducer(tfcd);
+			stallCheckPipe = new StallCheckPipe();
+			activeCheckPipe = new ActiveCheckPipe();
 			volumePipe = new VolumePipe();
 			encoderPipe = new EncoderPipe(SendCodec) { Bitrate = ts3FullClientData.AudioBitrate * 1000 };
 			timePipe = new PreciseTimedPipe { ReadBufferSize = encoderPipe.PacketSize };
 			timePipe.Initialize(encoderPipe);
 			TargetPipe = new CustomTargetPipe(tsFullClient);
 
 			timePipe.InStream = ffmpegProducer;
-			timePipe.Chain(volumePipe).Chain(encoderPipe).Chain(TargetPipe);
+			timePipe.Chain(activeCheckPipe).Chain(stallCheckPipe).Chain(volumePipe).Chain(encoderPipe).Chain(TargetPipe);
 
-			isStall = false;
-			stallCount = 0;
 			identity = null;
 		}
 
@@ -188,8 +185,7 @@ private void TsFullClient_OnErrorEvent(object sender, CommandError error)
 			switch (error.Id)
 			{
 			case Ts3ErrorCode.whisper_no_targets:
-				stallNoErrorCount = 0;
-				isStall = true;
+				stallCheckPipe.SetStall();
 				break;
 
 			default:
@@ -264,44 +260,6 @@ public override R<ClientData> GetSelf()
 			return cd;
 		}
 
-		private void AudioSend()
-		{
-			// TODO Make a pipe for this
-			// Save cpu when we know there is noone to send to
-			bool doSend = true;
-
-			var SendMode = TargetSendMode.None;
-			switch (SendMode)
-			{
-			case TargetSendMode.None:
-				doSend = false;
-				break;
-			case TargetSendMode.Voice:
-				break;
-			case TargetSendMode.Whisper:
-			case TargetSendMode.WhisperGroup:
-				if (isStall)
-				{
-					if (++stallCount % StallCountInterval == 0)
-					{
-						stallNoErrorCount++;
-						if (stallNoErrorCount > StallNoErrorCountMax)
-						{
-							stallCount = 0;
-							isStall = false;
-						}
-					}
-					else
-					{
-						doSend = false;
-					}
-				}
-				break;
-			default:
-				throw new InvalidOperationException();
-			}
-		}
-
 		#region IPlayerConnection
 
 		public event EventHandler OnSongEnd

TS3Client/Audio/ActiveCheckPipe.cs

@@ -0,0 +1,27 @@
+// TS3Client - A free TeamSpeak3 client implementation
+// Copyright (C) 2017  TS3Client contributors
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the Open Software License v. 3.0
+//
+// You should have received a copy of the Open Software License along with this
+// program. If not, see <https://opensource.org/licenses/OSL-3.0>.
+
+namespace TS3Client.Audio
+{
+	using System;
+
+	public class ActiveCheckPipe : IAudioPipe
+	{
+		public bool Active => OutStream?.Active ?? false;
+		public IAudioPassiveConsumer OutStream { get; set; }
+
+		public void Write(Span<byte> data, Meta meta)
+		{
+			if (OutStream == null || !Active)
+				return;
+
+			OutStream?.Write(data, meta);
+		}
+	}
+}