added hard clipping distortion

HephAudio/HeaderFiles/AudioEffects/HardClipDistortion.h

@@ -0,0 +1,55 @@
+#pragma once
+#include "HephAudioShared.h"
+#include "AudioEffect.h"
+
+/** @file */
+
+namespace HephAudio
+{
+	/**
+	 * @brief applies hard-clipping distortion.
+	 * 
+	 */
+	class HardClipDistortion : public AudioEffect
+	{
+	protected:
+		/**
+		 * threshold value.
+		 * 
+		 */
+		heph_audio_sample_t clippingLevel;
+
+	public:
+		/** @copydoc default_constructor */
+		HardClipDistortion();
+
+		/**
+		 * @copydoc constructor
+		 *
+		 * @param clippingLevel threshold value in decibels.
+		 *
+		 */
+		explicit HardClipDistortion(double clippingLevel);
+
+		/** @copydoc destructor */
+		virtual ~HardClipDistortion() = default;
+
+		virtual std::string Name() const override;
+
+		/**
+		 * gets the clipping level in decibels.
+		 * 
+		 */
+		virtual double GetClippingLevel() const;
+
+		/**
+		 * sets the clipping level.
+		 * 
+		 * @param clippingLevel threshold value in decibels.
+		 */
+		virtual void SetClippingLevel(double clippingLevel);
+
+	protected:
+		virtual void ProcessST(const AudioBuffer& inputBuffer, AudioBuffer& outputBuffer, size_t startIndex, size_t frameCount) override;
+	};
+}

HephAudio/HeaderFiles/AudioEffects/PanningEffect.h

@@ -55,6 +55,6 @@ namespace HephAudio
 		virtual void SetFactor(double factor) = 0;
 
 	protected:
-		virtual void ProcessST(const AudioBuffer& inputBuffer, AudioBuffer& outputBuffer, size_t startIndex, size_t endIndex) override;
+		virtual void ProcessST(const AudioBuffer& inputBuffer, AudioBuffer& outputBuffer, size_t startIndex, size_t frameCount) override;
 	};
 }

HephAudio/HeaderFiles/AudioEffects/SineLawPanning.h

@@ -18,6 +18,7 @@ namespace HephAudio
 
 		/**
 		 * @copydoc constructor
+		 * 
 		 * @param factor determines how the channels' volume will be changed.
 		 * Ranges between -1 and 1.<br>
 		 * -1 means only the left channel will be audible and 1 means only the right channel will be audible.

HephAudio/HeaderFiles/AudioEffects/Tremolo.h

@@ -24,10 +24,9 @@ namespace HephAudio
 		virtual ~Tremolo() = default;
 
 		virtual std::string Name() const override;
-
 		virtual void Process(AudioBuffer& buffer, size_t startIndex, size_t frameCount) override;
 
 	protected:
-		virtual void ProcessST(const AudioBuffer& inputBuffer, AudioBuffer& outputBuffer, size_t startIndex, size_t endIndex) override;
+		virtual void ProcessST(const AudioBuffer& inputBuffer, AudioBuffer& outputBuffer, size_t startIndex, size_t frameCount) override;
 	};
 }

HephAudio/HephAudio.vcxitems

@@ -14,6 +14,7 @@
     <ProjectCapability Include="SourceItemsFromImports" />
   </ItemGroup>
   <ItemGroup>
+    <ClInclude Include="$(MSBuildThisFileDirectory)HeaderFiles\AudioEffects\HardClipDistortion.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)HeaderFiles\AudioEffects\Chorus.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)HeaderFiles\AudioEffects\Flanger.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)HeaderFiles\AudioEffects\DoubleBufferedAudioEffect.h" />
@@ -95,6 +96,7 @@
     <ClInclude Include="$(MSBuildThisFileDirectory)HeaderFiles\AudioEffects\RmsNormalizer.h" />
   </ItemGroup>
   <ItemGroup>
+    <ClCompile Include="$(MSBuildThisFileDirectory)SourceFiles\AudioEffects\HardClipDistortion.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)SourceFiles\AudioEffects\RmsNormalizer.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)SourceFiles\AudioEffects\Normalizer.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)SourceFiles\AudioEffects\Chorus.cpp" />

HephAudio/HephAudio.vcxitems.filters

@@ -247,6 +247,7 @@
     <ClInclude Include="$(MSBuildThisFileDirectory)HeaderFiles\AudioEffects\Chorus.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)HeaderFiles\AudioEffects\Normalizer.h" />
     <ClInclude Include="$(MSBuildThisFileDirectory)HeaderFiles\AudioEffects\RmsNormalizer.h" />
+    <ClInclude Include="$(MSBuildThisFileDirectory)HeaderFiles\AudioEffects\HardClipDistortion.h" />
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="$(MSBuildThisFileDirectory)SourceFiles\AudioProcessor.cpp">
@@ -410,5 +411,6 @@
     <ClCompile Include="$(MSBuildThisFileDirectory)SourceFiles\AudioEffects\Chorus.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)SourceFiles\AudioEffects\Normalizer.cpp" />
     <ClCompile Include="$(MSBuildThisFileDirectory)SourceFiles\AudioEffects\RmsNormalizer.cpp" />
+    <ClCompile Include="$(MSBuildThisFileDirectory)SourceFiles\AudioEffects\HardClipDistortion.cpp" />
   </ItemGroup>
 </Project>

HephAudio/SourceFiles/AudioEffects/HardClipDistortion.cpp

@@ -0,0 +1,56 @@
+#include "AudioEffects/HardClipDistortion.h"
+#include "Exceptions/InvalidArgumentException.h"
+
+using namespace Heph;
+
+namespace HephAudio
+{
+	HardClipDistortion::HardClipDistortion() : HardClipDistortion(0) {}
+
+	HardClipDistortion::HardClipDistortion(double clippingLevel) : AudioEffect()
+	{
+		this->SetClippingLevel(clippingLevel);
+	}
+
+	std::string HardClipDistortion::Name() const
+	{
+		return "Hard Clipping Distortion";
+	}
+
+	double HardClipDistortion::GetClippingLevel() const
+	{
+		return HephAudio::GainToDecibel(this->clippingLevel / (double)HEPH_AUDIO_SAMPLE_MAX);
+	}
+
+	void HardClipDistortion::SetClippingLevel(double clippingLevel)
+	{
+		if (clippingLevel > 0)
+		{
+			HEPH_RAISE_AND_THROW_EXCEPTION(this, InvalidArgumentException(HEPH_FUNC, "clippingLevel must be negative or zero."));
+		}
+
+		this->clippingLevel = HephAudio::DecibelToGain(clippingLevel) * HEPH_AUDIO_SAMPLE_MAX;
+	}
+
+	void HardClipDistortion::ProcessST(const AudioBuffer& inputBuffer, AudioBuffer& outputBuffer, size_t startIndex, size_t frameCount)
+	{
+		const size_t endIndex = startIndex + frameCount;
+		const AudioFormatInfo& formatInfo = outputBuffer.FormatInfo();
+
+		for (size_t i = startIndex; i < endIndex; ++i)
+		{
+			for (size_t j = 0; j < formatInfo.channelLayout.count; ++j)
+			{
+				heph_audio_sample_t& sample = outputBuffer[i][j];
+				if (sample > this->clippingLevel)
+				{
+					sample = this->clippingLevel;
+				}
+				else if (sample < -this->clippingLevel)
+				{
+					sample = -this->clippingLevel;
+				}
+			}
+		}
+	}
+}