/***********************************************************************************************************************
*                                                                                                                      *
* libscopeprotocols                                                                                                    *
*                                                                                                                      *
* Copyright (c) 2012-2024 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 RGBLEDDecoder
 */

#ifndef RGBLEDDecoder_h
#define RGBLEDDecoder_h

#include "PacketDecoder.h"

class RGBLEDSymbol
{
public:

	RGBLEDSymbol() {}

	RGBLEDSymbol(uint32_t d) : m_data(d) {}

	uint32_t m_data;

	bool operator==(const RGBLEDSymbol& s) const { return (m_data == s.m_data); }
};

class RGBLEDWaveform : public SparseWaveform<RGBLEDSymbol>
{
public:
	RGBLEDWaveform ()
		: SparseWaveform<RGBLEDSymbol>()
		, m_scale(1)
	{};
	virtual std::string GetText(size_t) override;
	virtual std::string GetColor(size_t) override;

	float m_scale;
};

class RGBLEDDecoder : public PacketDecoder
{
public:
	RGBLEDDecoder(const std::string& color);

	virtual void Refresh(vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue) override;

	static std::string GetProtocolName();

	virtual bool GetShowImageColumn() override;
	virtual std::vector<std::string> GetHeaders() override;

	virtual bool ValidateChannel(size_t i, StreamDescriptor stream) override;

	PROTOCOL_DECODER_INITPROC(RGBLEDDecoder)

	float GetScale()
	{ return m_displayscale.GetFloatVal(); }

protected:
	enum pwidth_t
	{
		SHORT,
		LONG,
		AMBIGUOUS
	};

	enum type_t
	{
		TYPE_19_C47,	//Everlight 19-C47/RSGHBC-5V01/2T and similar
		TYPE_WS2812
	};

	FilterParameter& m_type;

	FilterParameter& m_displayscale;
};

#endif
