winamp/Src/external_dependencies/openmpt-trunk/soundlib/plugins/SymMODEcho.h

/*
 * SymMODEcho.h
 * ------------
 * Purpose: Implementation of the SymMOD Echo DSP
 * Notes  : (currently none)
 * Authors: OpenMPT Devs
 * The OpenMPT source code is released under the BSD license. Read LICENSE for more details.
 */


#ifndef NO_PLUGINS

#include "PlugInterface.h"

OPENMPT_NAMESPACE_BEGIN

class SymMODEcho final : public IMixPlugin
{
public:
	enum class DSPType : uint8
	{
		Off = 0,
		Normal,
		Cross,
		Cross2,
		Center,
		NumTypes
	};

	enum Parameters
	{
		kEchoType = 0,
		kEchoDelay,
		kEchoFeedback,
		kEchoNumParameters
	};

	// Our settings chunk for file I/O, as it will be written to files
	struct PluginChunk
	{
		char  id[4];
		uint8 param[kEchoNumParameters];

		static PluginChunk Create(uint8 type, uint8 delay, uint8 feedback)
		{
			static_assert(sizeof(PluginChunk) == 7);
			PluginChunk result;
			memcpy(result.id, "Echo", 4);
			result.param[kEchoType] = type;
			result.param[kEchoDelay] = delay;
			result.param[kEchoFeedback] = feedback;
			return result;
		}
		static PluginChunk Default()
		{
			return Create(0, 4, 1);
		}
	};

	std::vector<float> m_delayLine;
	uint32 m_writePos = 0;  // Current write position in the delay line
	float m_feedback  = 0.5f;

	// Settings chunk for file I/O
	PluginChunk m_chunk;

public:
	static IMixPlugin* Create(VSTPluginLib& factory, CSoundFile& sndFile, SNDMIXPLUGIN* mixStruct);
	SymMODEcho(VSTPluginLib& factory, CSoundFile& sndFile, SNDMIXPLUGIN* mixStruct);

	void Release() override { delete this; }
	void SaveAllParameters() override;
	void RestoreAllParameters(int32 program) override;
	int32 GetUID() const override { int32le id; memcpy(&id, "Echo", 4); return id; }
	int32 GetVersion() const override { return 0; }
	void Idle() override { }
	uint32 GetLatency() const override { return 0; }

	void Process(float* pOutL, float* pOutR, uint32 numFrames) override;

	float RenderSilence(uint32) override { return 0.0f; }

	int32 GetNumPrograms() const override { return 0; }
	int32 GetCurrentProgram() override { return 0; }
	void SetCurrentProgram(int32) override { }

	PlugParamIndex GetNumParameters() const override { return kEchoNumParameters; }
	PlugParamValue GetParameter(PlugParamIndex index) override;
	void SetParameter(PlugParamIndex index, PlugParamValue value) override;

	void Resume() override;
	void Suspend() override { m_isResumed = false; }
	void PositionChanged() override;

	bool IsInstrument() const override { return false; }
	bool CanRecieveMidiEvents() override { return false; }
	bool ShouldProcessSilence() override { return true; }

#ifdef MODPLUG_TRACKER
	CString GetDefaultEffectName() override { return _T("Echo"); }

	std::pair<PlugParamValue, PlugParamValue> GetParamUIRange(PlugParamIndex param) override;
	CString GetParamName(PlugParamIndex param) override;
	CString GetParamLabel(PlugParamIndex) override;
	CString GetParamDisplay(PlugParamIndex param) override;

	CString GetCurrentProgramName() override { return CString(); }
	void SetCurrentProgramName(const CString&) override { }
	CString GetProgramName(int32) override { return CString(); }

	bool HasEditor() const override { return false; }
#endif

	int GetNumInputChannels() const override { return 2; }
	int GetNumOutputChannels() const override { return 2; }

	bool ProgramsAreChunks() const override { return true; }
	ChunkData GetChunk(bool) override;
	void SetChunk(const ChunkData& chunk, bool) override;

protected:
	DSPType GetDSPType() const { return static_cast<DSPType>(m_chunk.param[kEchoType]); }
	void RecalculateEchoParams();
};

MPT_BINARY_STRUCT(SymMODEcho::PluginChunk, 7)


OPENMPT_NAMESPACE_END

#endif // NO_PLUGINS