//
// rotaryencoder.h
//
// mt32-pi - A baremetal MIDI synthesizer for Raspberry Pi
// Copyright (C) 2020-2023 Dale Whinham <daleyo@gmail.com>
//
// This file is part of mt32-pi.
//
// mt32-pi is free software: you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the Free Software
// Foundation, either version 3 of the License, or (at your option) any later
// version.
//
// mt32-pi is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
// details.
//
// You should have received a copy of the GNU General Public License along with
// mt32-pi. If not, see <http://www.gnu.org/licenses/>.
//

#ifndef _rotaryencoder_h
#define _rotaryencoder_h

#include <circle/gpiopin.h>
#include <circle/types.h>

#include "utility.h"

class CRotaryEncoder
{
public:
	#define ENUM_ENCODERTYPE(ENUM) \
		ENUM(Full, full)       \
		ENUM(Half, half)       \
		ENUM(Quarter, quarter)

	CONFIG_ENUM(TEncoderType, ENUM_ENCODERTYPE);

	CRotaryEncoder(TEncoderType Type, bool bReversed, unsigned GPIOPinCLK, unsigned GPIOPinDAT);

	s8 Read();
	void ReadGPIOPins();
	void ReadGPIOPins(bool bCLKValue, bool bDATValue);

private:
	CGPIOPin m_CLKPin;
	CGPIOPin m_DATPin;

	TEncoderType m_Type;
	bool m_bReversed;

	s8 m_nDelta;
	u8 m_nState;

	// Bitmask of which valid 4-bit transition codes we have seen in each direction (CW and CCW)
	u16 nPreviousTransitions[2];

	unsigned int m_nLastReadTime;
};

#endif