// samplv1_controls.cpp
//
/****************************************************************************
   Copyright (C) 2012-2021, rncbc aka Rui Nuno Capela. All rights reserved.

   This program 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 2
   of the License, or (at your option) any later version.

   This program 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 this program; if not, write to the Free Software Foundation, Inc.,
   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

*****************************************************************************/

#include "samplv1_controls.h"

#include <QHash>


#define RPN_MSB   0x65
#define RPN_LSB   0x64

#define NRPN_MSB  0x63
#define NRPN_LSB  0x62

#define DATA_MSB  0x06
#define DATA_LSB  0x26


#define CC14_MSB_MIN    0x00
#define CC14_MSB_MAX    0x20

#define CC14_LSB_MIN    CC14_MSB_MAX
#define CC14_LSB_MAX   (CC14_MSB_MAX << 1)


//---------------------------------------------------------------------
// xrpn_data14 - decl.
//
class xrpn_data14
{
public:

	xrpn_data14()
		: m_msb(0), m_lsb(0) {}

	xrpn_data14 ( const xrpn_data14& data )
		: m_msb(data.m_msb), m_lsb(data.m_lsb) {}

	void clear() { m_msb = m_lsb = 0; }

	bool is_msb () const
		{ return (m_msb & 0x80); }
	void set_msb ( unsigned char msb )
		{ m_msb = (msb & 0x7f) | 0x80; }
	unsigned msb() const
		{ return (m_msb & 0x7f); }

	bool is_lsb () const
		{ return (m_lsb & 0x80); }
	void set_lsb ( unsigned char lsb )
		{ m_lsb = (lsb & 0x7f) | 0x80; }
	unsigned lsb() const
		{ return (m_lsb & 0x7f); }

	unsigned short data() const
	{
		unsigned short val = 0;

		if (is_lsb()) {
			val += (m_lsb & 0x7f);
			if (is_msb())
				val += (m_msb & 0x7f) << 7;
		}
		else
		if (is_msb())
			val += (m_msb & 0x7f);

		return val;
	}

	bool is_any() const
		{ return is_msb() || is_lsb(); }
	bool is_7bit() const
		{ return is_any() && !is_14bit(); }
	bool is_14bit() const
		{ return is_msb() && is_lsb(); }

private:

	unsigned char m_msb;
	unsigned char m_lsb;
};


//---------------------------------------------------------------------
// xrpn_item - decl.
//
class xrpn_item
{
public:

	xrpn_item() : m_status(0) {}

	xrpn_item ( const xrpn_item& item ) :
		m_status(item.m_status),
		m_param(item.m_param),
		m_value(item.m_value) {}

	void clear()
	{
		m_status = 0;
		m_param.clear();
		m_value.clear();
	}

	bool is_status () const
		{ return (m_status & 0x800) && (m_status & 0x700); }
	void set_status(unsigned short status)
		{ m_status = (status & 0x7ff) | 0x800; }
	unsigned short status() const
		{ return (m_status & 0x7ff); }

	samplv1_controls::Type type() const
		{ return samplv1_controls::Type(status() & 0x700); }
	unsigned short channel() const
		{ return (status() & 0x1f); }

	bool is_param_msb() const
		{ return m_param.is_msb(); }
	bool is_param_lsb() const
		{ return m_param.is_lsb(); }

	void set_param_msb(unsigned char msb)
		{ m_param.set_msb(msb); }
	void set_param_lsb(unsigned char lsb)
		{ m_param.set_lsb(lsb); }

	unsigned char param_msb() const
		{ return m_param.msb(); }
	unsigned char param_lsb() const
		{ return m_param.lsb(); }

	unsigned short param() const
		{ return m_param.data(); }

	bool is_value_msb() const
		{ return m_value.is_msb(); }
	bool is_value_lsb() const
		{ return m_value.is_lsb(); }

	void set_value_msb(unsigned char msb)
		{ m_value.set_msb(msb); }
	void set_value_lsb(unsigned char lsb)
		{ m_value.set_lsb(lsb); }

	unsigned char value_msb() const
		{ return m_value.msb(); }
	unsigned char value_lsb() const
		{ return m_value.lsb(); }

	unsigned short value() const
		{ return m_value.data(); }

	bool is_any() const
		{ return m_param.is_any() || m_value.is_any(); }
	bool is_ready() const
		{ return m_param.is_any() && m_value.is_any(); }
	bool is_7bit() const
		{ return m_param.is_any() && m_value.is_7bit(); }
	bool is_14bit() const
		{ return m_param.is_any() && m_value.is_14bit(); }

	void clear_value()
		{ m_status &= 0x7ff; m_value.clear(); }

private:

	unsigned short m_status;
	xrpn_data14    m_param;
	xrpn_data14    m_value;
};

typedef QHash<unsigned int, xrpn_item> xrpn_cache;


//---------------------------------------------------------------------
// xrpn_queue - decl.
//
class xrpn_queue
{
public:

	xrpn_queue ( unsigned int size = 0 )
		: m_size(0), m_mask(0), m_read(0), m_write(0), m_events(0)
		{ resize(size); }

	~xrpn_queue () { if (m_events) delete [] m_events; }

	void resize ( unsigned int size )
	{
		unsigned int new_size = 4; // must be a power-of-2...
		while (new_size < size)
			new_size <<= 1;
		if (new_size > m_size) {
			const unsigned int old_size = m_size;
			samplv1_controls::Event *new_events
				= new samplv1_controls::Event [new_size];
			samplv1_controls::Event *old_events = m_events;
			if (old_events) {
				if (m_write > m_read) {
					::memcpy(
						(void *) (new_events + m_read),
						(void *) (old_events + m_read),
						(m_write - m_read) * sizeof(samplv1_controls::Event));
				}
				else
				if (m_write < m_read) {
					::memcpy(
						(void *) (new_events + m_read),
						(void *) (old_events + m_read),
						(old_size - m_read) * sizeof(samplv1_controls::Event));
					if (m_write > 0) {
						::memcpy(
							(void *) (new_events + old_size),
							(void *) (old_events),
							m_write * sizeof(samplv1_controls::Event));
					}
					m_write += old_size;
				}
			}
			m_size = new_size;
			m_mask = new_size - 1;
			m_events = new_events;
			if (old_events)
				delete [] old_events;
		}
	}

	void clear() { m_read = m_write = 0; }

	bool push (
		unsigned short status,
		unsigned short param,
		unsigned short value )
	{
		samplv1_controls::Event event;

		event.key.status = status;
		event.key.param  = param;
		event.value = value;

		return push(event);
	}

	bool push ( const samplv1_controls::Event& event )
	{
		if (count() >= m_mask)
			resize(m_size + 4);
		const unsigned int w = (m_write + 1) & m_mask;
		if (w == m_read)
			return false;
		m_events[m_write] = event;
		m_write = w;
		return true;
	}

	bool pop ( samplv1_controls::Event& event )
	{
		const unsigned int r = m_read;
		if (r == m_write)
			return false;
		event = m_events[r];
		m_read = (r + 1) & m_mask;
		return true;
	}

	bool is_pending () const
		{ return (m_read != m_write); }

	unsigned int count() const
	{
		if (m_write < m_read)
			return (m_write + m_size - m_read) & m_mask;
		else
			return (m_write - m_read);
	}

private:

	unsigned int m_size;
	unsigned int m_mask;
	unsigned int m_read;
	unsigned int m_write;

	samplv1_controls::Event *m_events;
};


//---------------------------------------------------------------------
// samplv1_controls:Impl - decl.
//

class samplv1_controls::Impl
{
public:

	Impl() : m_count(0) {}

	bool is_pending () const
		{ return m_queue.is_pending(); }

	bool dequeue ( samplv1_controls::Event& event )
		{ return m_queue.pop(event); }

	void flush()
	{
		if (m_count > 0) {
			xrpn_cache::Iterator iter = m_cache.begin();
			const xrpn_cache::Iterator& iter_end = m_cache.end();
			for ( ; iter != iter_end; ++iter)
				enqueue(iter.value());
			m_cache.clear();
		//	m_count = 0;
		}
	}

	bool process ( const samplv1_controls::Event& event )
	{
		const unsigned short channel = event.key.channel();

		if (event.key.param == RPN_MSB) {
			xrpn_item& item = get_item(channel);
			if (item.is_any() && item.type() != samplv1_controls::RPN)
				enqueue(item);
			if (item.is_status() // RPN nullptr [MSB]
				&& item.type() == samplv1_controls::RPN && item.is_param_lsb()
				&& item.param_lsb() == 0x7f && event.value == 0x7f) {
				item.clear();
				--m_count;
				return true;
			}
			if (item.type() == samplv1_controls::NRPN) {
				item.clear();
				item.set_status(samplv1_controls::RPN | channel);
			}
			else
			if (!item.is_status()) {
				item.set_status(samplv1_controls::RPN | channel);
				++m_count;
			}
			item.set_param_msb(event.value);
			return true;
		}
		else
		if (event.key.param == RPN_LSB) {
			xrpn_item& item = get_item(channel);
			if (item.is_any() && item.type() != samplv1_controls::RPN)
				enqueue(item);
			if (item.is_status() // RPN nullptr [LSB]
				&& item.type() == samplv1_controls::RPN && item.is_param_msb()
				&& item.param_msb() == 0x7f && event.value == 0x7f) {
				item.clear();
				--m_count;
				return true;
			}
			if (item.type() == samplv1_controls::NRPN) {
				item.clear();
				item.set_status(samplv1_controls::RPN | channel);
			}
			else
			if (!item.is_status()) {
				item.set_status(samplv1_controls::RPN | channel);
				++m_count;
			}
			item.set_param_lsb(event.value);
			return true;
		}
		else
		if (event.key.param == NRPN_MSB) {
			xrpn_item& item = get_item(channel);
			if (item.is_any() && item.type() != samplv1_controls::NRPN)
				enqueue(item);
			if (item.type() == samplv1_controls::RPN) {
				item.clear();
				item.set_status(samplv1_controls::NRPN | channel);
			}
			else
			if (!item.is_status()) {
				item.set_status(samplv1_controls::NRPN | channel);
				++m_count;
			}
			item.set_param_msb(event.value);
			return true;
		}
		else
		if (event.key.param == NRPN_LSB) {
			xrpn_item& item = get_item(channel);
			if (item.is_any() && item.type() != samplv1_controls::NRPN)
				enqueue(item);
			if (item.type() == samplv1_controls::RPN) {
				item.clear();
				item.set_status(samplv1_controls::NRPN | channel);
			}
			else
			if (!item.is_status()) {
				item.set_status(samplv1_controls::NRPN | channel);
				++m_count;
			}
			item.set_param_lsb(event.value);
			return true;
		}
		else
		if (event.key.param == DATA_MSB) {
			xrpn_item& item = get_item(channel);
			if (item.type() != samplv1_controls::RPN &&
				item.type() != samplv1_controls::NRPN) {
				enqueue(item);
				return false;
			}
			if (!item.is_status())
				item.set_status(item.type() | channel);
			item.set_value_msb(event.value);
			if (item.is_14bit())
				enqueue(item);
			return true;
		}
		else
		if (event.key.param == DATA_LSB) {
			xrpn_item& item = get_item(channel);
			if (item.type() != samplv1_controls::RPN &&
				item.type() != samplv1_controls::NRPN) {
				enqueue(item);
				return false;
			}
			if (!item.is_status())
				item.set_status(item.type() | channel);
			item.set_value_lsb(event.value);
			if (item.is_14bit())
				enqueue(item);
			return true;
		}
		else
		if (event.key.param > CC14_MSB_MIN && event.key.param < CC14_MSB_MAX) {
			xrpn_item& item = get_item(channel);
			if (item.is_any() && item.type() != samplv1_controls::CC14) {
				enqueue(item);
				item.clear();
				--m_count;
			}
			else
			if ((item.is_param_msb() && item.is_value_msb())
				|| (item.type() == samplv1_controls::CC14 && item.is_param_lsb()
					&& item.param_lsb() != event.key.param + CC14_LSB_MIN))
				enqueue(item);
			if (!item.is_status()) {
				item.set_status(samplv1_controls::CC14 | channel);
				++m_count;
			}
			item.set_param_lsb(event.key.param + CC14_LSB_MIN);
			item.set_param_msb(event.key.param);
			item.set_value_msb(event.value);
			if (item.is_14bit())
				enqueue(item);
			return true;
		}
		else
		if (event.key.param > CC14_LSB_MIN && event.key.param < CC14_LSB_MAX) {
			xrpn_item& item = get_item(channel);
			if (item.is_any() && item.type() != samplv1_controls::CC14) {
				enqueue(item);
				item.clear();
				--m_count;
			}
			else
			if ((item.is_param_lsb() && item.is_value_lsb())
				|| (item.type() == samplv1_controls::CC14 && item.is_param_msb()
					&& item.param_msb() != event.key.param - CC14_LSB_MIN))
				enqueue(item);
			if (!item.is_status()) {
				item.set_status(samplv1_controls::CC14 | channel);
				++m_count;
			}
			item.set_param_msb(event.key.param - CC14_LSB_MIN);
			item.set_param_lsb(event.key.param);
			item.set_value_lsb(event.value);
			if (item.is_14bit())
				enqueue(item);
			return true;
		}

		return false;
	}

protected:

	xrpn_item& get_item ( unsigned short channel )
		{ return m_cache[channel]; }

	void enqueue ( xrpn_item& item )
	{
		if (!item.is_status())
			return;

		if (item.type() == samplv1_controls::CC14) {
			if (item.is_14bit()) {
				m_queue.push(item.status(), item.param_msb(), item.value());
				const unsigned char value_msb = item.value_msb();
				item.clear_value();
				item.set_value_msb(value_msb);
			//	--m_count;
			} else  {
				const unsigned short status
					= samplv1_controls::CC | item.channel();
				if (item.is_param_msb() && item.is_value_msb())
					m_queue.push(status, item.param_msb(), item.value_msb());
				if (item.is_param_lsb() && item.is_value_lsb())
					m_queue.push(status, item.param_lsb(), item.value_lsb());
				item.clear();
				--m_count;
			}
		}
		else
		if (item.is_ready()) {
			m_queue.push(item.status(), item.param(), item.value());
			item.clear_value();
		//	--m_count;
		} else {
			const unsigned short status
				= samplv1_controls::CC | item.channel();
			if (item.type() == samplv1_controls::RPN) {
				if (item.is_param_msb())
					m_queue.push(status, RPN_MSB, item.param_msb());
				if (item.is_param_lsb())
					m_queue.push(status, RPN_LSB, item.param_lsb());
			}
			else
			if (item.type() == samplv1_controls::NRPN) {
				if (item.is_param_msb())
					m_queue.push(status, NRPN_MSB, item.param_msb());
				if (item.is_param_lsb())
					m_queue.push(status, NRPN_LSB, item.param_lsb());
			}
			if (item.is_value_msb())
				m_queue.push(status, DATA_MSB, item.value_msb());
			if (item.is_value_lsb())
				m_queue.push(status, DATA_LSB, item.value_lsb());
			item.clear();
			--m_count;
		}
	}

private:

	unsigned int m_count;

	xrpn_cache m_cache;
	xrpn_queue m_queue;
};


//---------------------------------------------------------------------
// samplv1_controls - impl.
//

samplv1_controls::samplv1_controls ( samplv1 *pSampl )
	: m_pImpl(new samplv1_controls::Impl()), m_enabled(false),
		m_sched_in(pSampl), m_sched_out(pSampl),
		m_timeout(0), m_timein(0)
{
}


samplv1_controls::~samplv1_controls (void)
{
	delete m_pImpl;
}


// controller queue methods.
void samplv1_controls::process_enqueue (
	unsigned short channel, unsigned short param, unsigned short value )
{
	if (!enabled())
		return;

	Event event;

	event.key.status = CC | (channel & 0x1f);
	event.key.param = param;
	event.value = value;

	if (!m_pImpl->process(event))
		process_event(event);

	if (m_timeout < 1) // make timeout ~200ms...
		m_timeout = (unsigned int) (0.2f * m_sched_in.instance()->sampleRate());
}


void samplv1_controls::process_dequeue (void)
{
	if (!enabled())
		return;

	while (m_pImpl->is_pending()) {
		Event event;
		if (m_pImpl->dequeue(event))
			process_event(event);
	}
}


// controller action.
void samplv1_controls::process_event ( const Event& event )
{
	Key key(event.key);

	m_sched_in.schedule_key(key);

	const Map::Iterator& iter_end = m_map.end();
	Map::Iterator iter = m_map.find(key);
	if (iter == iter_end && key.channel() > 0) {
		key.status = key.type(); // channel=0 (Auto)
		iter = m_map.find(key);
	}
	if (iter == iter_end)
		return;

	// reference to payload...
	Data& data = iter.value();

	// process controller event...
	float fScale = float(event.value) / 127.0f;
	if (key.type() != CC)
		fScale /= 127.0f;

	if (fScale > 1.0f)
		fScale = 1.0f;
	else
	if (fScale < 0.0f)
		fScale = 0.0f;

	if (data.flags & Invert)
		fScale = 1.0f - fScale;
	if (data.flags & Logarithmic)
		fScale *= (fScale * fScale);

	const samplv1::ParamIndex index
		= samplv1::ParamIndex(data.index);

	// catch-up testing begin...
	bool bSync = (data.flags & Hook) || !samplv1_param::paramFloat(index);
	if (!bSync)
		bSync = data.sync;
	if (!bSync) {
		const float v0 = data.val;
		const float v1 = samplv1_param::paramScale(index,
			m_sched_in.instance()->paramValue(index));
		const float d1 = qAbs(v1 - fScale);
		const float d2 = qAbs(v1 - v0) * d1;
		bSync = (d2 < 0.001f);
		if (bSync) {
			data.val = fScale;
			data.sync = true;
		}
	}

	if (bSync) {
		m_sched_out.schedule_event(index,
			samplv1_param::paramValue(index, fScale));
	}
}


// process timer counter.
void samplv1_controls::process ( unsigned int nframes )
{
	if (!enabled() || m_timeout < 1)
		return;

	m_timein += nframes;

	if (m_timein > m_timeout) {
		m_timein = 0;
		m_pImpl->flush();
		process_dequeue();
	}
}


// reset all controllers.
void samplv1_controls::reset (void)
{
	if (!enabled())
		return;

	const Map::Iterator& iter_end = m_map.end();
	Map::Iterator iter = m_map.begin();
	for ( ; iter != iter_end; ++iter) {
		Data& data = iter.value();
		if (data.flags & Hook)
			continue;
		const samplv1::ParamIndex index
			= samplv1::ParamIndex(data.index);
		data.val = samplv1_param::paramScale(index,
			m_sched_in.instance()->paramValue(index));
		data.sync = false;
	}
}


// text utilities.
samplv1_controls::Type samplv1_controls::typeFromText ( const QString& sText )
{
	if (sText == "CC")
		return CC;
	else
	if (sText == "RPN")
		return RPN;
	else
	if (sText == "NRPN")
		return NRPN;
	else
	if (sText == "CC14")
		return CC14;
	else
		return None;
}


QString samplv1_controls::textFromType ( Type ctype )
{
	QString sText;

	switch (ctype) {
	case CC:
		sText = "CC";
		break;
	case RPN:
		sText = "RPN";
		break;
	case NRPN:
		sText = "NRPN";
		break;
	case CC14:
		sText = "CC14";
		break;
	default:
		break;
	}

	return sText;
}


// current/last controller accessor.
const samplv1_controls::Key& samplv1_controls::current_key (void) const
{
	return m_sched_in.current_key();
}


// end of samplv1_controls.cpp
