/***********************************************************************************************************************
*                                                                                                                      *
* libscopeprotocols                                                                                                    *
*                                                                                                                      *
* Copyright (c) 2012-2021 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/

/**
	@file
	@author Andrew D. Zonenberg
	@brief Declaration of FFTFilter
 */
#ifndef FFTFilter_h
#define FFTFilter_h

#include <ffts.h>

#ifdef HAVE_CLFFT
#include <clFFT.h>
#endif

class FFTFilter : public PeakDetectionFilter
{
public:
	FFTFilter(const std::string& color);
	virtual ~FFTFilter();

	virtual void Refresh();

	virtual bool NeedsConfig();
	virtual bool IsOverlay();

	static std::string GetProtocolName();
	virtual void SetDefaultName();

	virtual double GetVoltageRange();
	virtual double GetOffset();
	virtual bool ValidateChannel(size_t i, StreamDescriptor stream);

	virtual void SetVoltageRange(double range);
	virtual void SetOffset(double offset);

	virtual bool UsesCLFFT();

	enum WindowFunction
	{
		WINDOW_RECTANGULAR,
		WINDOW_HANN,
		WINDOW_HAMMING,
		WINDOW_BLACKMAN_HARRIS
	};

	//Window function helpers
	static void ApplyWindow(const float* data, size_t len, float* out, WindowFunction func);
	static void HannWindow(const float* data, size_t len, float* out);
	static void HammingWindow(const float* data, size_t len, float* out);
	static void CosineSumWindow(const float* data, size_t len, float* out, float alpha0);
	static void CosineSumWindowAVX2(const float* data, size_t len, float* out, float alpha0);
	static void BlackmanHarrisWindow(const float* data, size_t len, float* out);
	static void BlackmanHarrisWindowAVX2(const float* data, size_t len, float* out);

	PROTOCOL_DECODER_INITPROC(FFTFilter)

protected:
	void NormalizeOutputLog(AnalogWaveform* cap, size_t nouts, float scale);
	void NormalizeOutputLogAVX2(AnalogWaveform* cap, size_t nouts, float scale);
	void NormalizeOutputLinear(AnalogWaveform* cap, size_t nouts, float scale);
	void NormalizeOutputLinearAVX2(AnalogWaveform* cap, size_t nouts, float scale);

	void ReallocateBuffers(size_t npoints_raw, size_t npoints, size_t nouts);

	void DoRefresh(
		AnalogWaveform* din,
		std::vector<EmptyConstructorWrapper<float>, AlignedAllocator<EmptyConstructorWrapper<float>, 64>>& data,
		double fs_per_sample, size_t npoints, size_t nouts, bool log_output);

	size_t m_cachedNumPoints;
	size_t m_cachedNumPointsFFT;
	std::vector<float, AlignedAllocator<float, 64> > m_rdinbuf;
	std::vector<float, AlignedAllocator<float, 64> > m_rdoutbuf;
	ffts_plan_t* m_plan;

	float m_range;
	float m_offset;

	std::string m_windowName;

	#ifdef HAVE_CLFFT
	cl::CommandQueue* m_queue;

	clfftPlanHandle m_clfftPlan;

	cl::Program* m_windowProgram;
	cl::Kernel* m_rectangularWindowKernel;
	cl::Kernel* m_cosineSumWindowKernel;
	cl::Kernel* m_blackmanHarrisWindowKernel;

	cl::Program* m_normalizeProgram;
	cl::Kernel* m_normalizeMagnitudeKernel;
	cl::Kernel* m_normalizeLogMagnitudeKernel;

	#endif
};

#endif
