EightBit/LR35902/inc/Audio.h

#pragma once

#include <array>
#include <memory>
#include <iostream>
#include <cassert>

#include <Processor.h>

#include "AudioFrame.h"

namespace EightBit {
	namespace GameBoy {

		class Envelope final {
		public:
			Envelope() {}

			enum Direction { Attenuate, Amplify };

			void reset() {
				m_defaultValue = m_direction = m_stepLength = 0;
			}

			bool zeroed() const {
				return (default() == 0) && (stepLength() == 0) && (direction() == Attenuate);
			}

			int default() const { return m_defaultValue; }
			void setDefault(int value) { m_defaultValue = value; }

			Direction direction() const { return (Direction)m_direction; }
			void setDirection(int value) { m_direction = value; }
			void setDirection(Direction value) { setDirection((int)value); }

			int stepLength() const { return m_stepLength; }
			void setStepLength(int value) { m_stepLength = value; }

			void dump() const {
				std::cout << "Envelope: default=" << default() << ",direction=" << direction() << ",step length=" << stepLength() << std::endl;
			}

		private:
			int m_defaultValue;
			int m_direction;
			int m_stepLength;
		};

		class Sweep final {
		public:
			Sweep() {}

			enum Direction { Addition, Subtraction };

			void reset() {
				m_time = m_direction = m_shift = 0;
			}

			bool zeroed() const {
				return (time() == 0) && (shift() == 0) && (direction() == Addition);
			}

			int time() const { return m_time; }
			void setTime(int value) { m_time = value; }

			Direction direction() const { return (Direction)m_direction; }
			void setDirection(int value) { m_direction = value; }
			void setDirection(Direction value) { setDirection((int)value); }

			int shift() const { return m_shift; }
			void setShift(int value) { m_shift = value; }

			void dump() const {
				std::cout << "Sweep: time=" << time() << ",direction=" << direction() << ",shift=" << shift() << std::endl;
			}

		private:
			int m_time;
			int m_direction;
			int m_shift;
		};

		class AudioVoice {
		public:
			AudioVoice() {}

			virtual void reset() {
				m_counterContinuous = m_initialise = 0;
			}

			virtual bool zeroed() const {
				return !initialise() && (type() == Continuous);
			}

			enum Type { Continuous, Counter };

			Type type() const { return (Type)m_counterContinuous; }
			void setType(int value) { m_counterContinuous = value; }
			void setType(Type value) { setType((int)value); }

			bool initialise() const { return !!m_initialise; }
			void setInitialise(bool value) { m_initialise = value; }

			virtual void dump() const {
				std::cout << "Audio Voice: type=" << type() << ",initialise=" << initialise() << std::endl;
			}

		private:
			int m_counterContinuous;
			int m_initialise;
		};

		class WaveVoice : public AudioVoice {
		public:
			WaveVoice(int cyclesPerSecond)
			: m_cyclesPerSecond(cyclesPerSecond) {}

			virtual void reset() override {
				AudioVoice::reset();
				m_frequencyLowOrder = m_frequencyHighOrder = 0;
			}

			virtual bool zeroed() const override {
				return AudioVoice::zeroed() && (frequency() == 0);
			}

			int frequencyLowOrder() const { return m_frequencyLowOrder; }

			void setFrequencyLowOrder(int value) {
				assert(value < Processor::Bit8);
				m_frequencyLowOrder = value;
			}

			int frequencyHighOrder() const { return m_frequencyHighOrder; }

			void setFrequencyHighOrder(int value) {
				assert(value < Processor::Bit3);
				m_frequencyHighOrder = value;
			}

			int frequency() const {
				return (m_frequencyHighOrder << 8) | m_frequencyLowOrder;
			}

			int hertz() const {
				// f = 4194304 / (4 x 8 x (2048 - X)) Hz
				auto division = 4 * 8 * (2048 - frequency());
				return m_cyclesPerSecond / division;
			}

			void setFrequency(int value) {
				assert(value < Processor::Bit11);
				m_frequencyHighOrder = (value >> 8) & Processor::Mask3;
				m_frequencyLowOrder = value & Processor::Mask8;
			}

			virtual void dump() const override {
				AudioVoice::dump();
				std::cout << "Wave Voice: frequency=" << frequency() << " (" << hertz() << ")" << std::endl;
			}

		private:
			const int m_cyclesPerSecond;
			int m_frequencyLowOrder;	// 8 bits
			int m_frequencyHighOrder;	// 3 bits
		};

		class RectangularVoice : public WaveVoice {
		public:
			RectangularVoice(int cyclesPerSecond)
			: WaveVoice(cyclesPerSecond) {}

			virtual void reset() override {
				WaveVoice::reset();
				m_waveFormDutyCycle = m_soundLength = 0;
			}

			virtual bool zeroed() const override {
				return WaveVoice::zeroed() && (waveFormDutyCycle() == 0) && (length() == 0);
			}

			int waveFormDutyCycle() const { return m_waveFormDutyCycle; }
			void setWaveFormDutyCycle(int value) { m_waveFormDutyCycle = value; }

			int length() const { return m_soundLength; }
			void setLength(int value) { m_soundLength = value; }

			virtual void dump() const override {
				WaveVoice::dump();
				std::cout << "Rectangular Voice: wave form duty=" << waveFormDutyCycle() << ",length=" << length() << std::endl;
			}

		private:
			int m_waveFormDutyCycle;
			int m_soundLength;
		};

		// NR2X
		class EnvelopedRectangularVoice : public RectangularVoice {
		public:
			EnvelopedRectangularVoice(int cyclesPerSecond)
			: RectangularVoice(cyclesPerSecond) {}

			virtual void reset() override {
				RectangularVoice::reset();
				m_envelope.reset();
			}

			virtual bool zeroed() const override {
				return RectangularVoice::zeroed() && m_envelope.zeroed();
			}

			Envelope& envelope() { return m_envelope; }

			virtual void dump() const override {
				RectangularVoice::dump();
				m_envelope.dump();
			}

		private:
			Envelope m_envelope;
		};

		// NR1X
		class SweptEnvelopedRectangularVoice : public EnvelopedRectangularVoice {
		public:
			SweptEnvelopedRectangularVoice(int cyclesPerSecond)
			: EnvelopedRectangularVoice(cyclesPerSecond) {}

			virtual void reset() override {
				EnvelopedRectangularVoice::reset();
				m_sweep.reset();
			}

			virtual bool zeroed() const override {
				return EnvelopedRectangularVoice::zeroed() && m_sweep.zeroed();
			}

			Sweep& sweep() { return m_sweep; }

			virtual void dump() const override {
				EnvelopedRectangularVoice::dump();
				m_sweep.dump();
			}

		private:
			Sweep m_sweep;
		};

		// NR3X
		class UserDefinedWaveVoice : public WaveVoice {
		public:
			UserDefinedWaveVoice(int cyclesPerSecond)
			: WaveVoice(cyclesPerSecond) {}

			virtual void reset() override {
				WaveVoice::reset();
				m_enabled = m_soundLength = m_outputLevel = 0;
				for (auto& datum : m_waveData)
					datum = 0;
			}

			virtual bool zeroed() const override {
				bool dataZeroed = true;
				for (const auto& datum : m_waveData) {
					if (datum != 0) {
						dataZeroed = false;
						break;
					}
				}
				return
					WaveVoice::zeroed()
					&& dataZeroed
					&& !enabled()
					&& (length() == 0)
					&& (level() == 0);
			}

			bool enabled() const { return !!m_enabled; }
			void setEnabled(bool value) { m_enabled = value; }
				
			int length() const { return m_soundLength; }
			void setLength(int value) { m_soundLength = value; }

			int level() const { return m_outputLevel; }
			void setLevel(int value) { m_outputLevel = value; }

			int packedWaveDatum(int i) const {
				assert(i < 16);
				return m_waveData[i];
			}

			void setPackedWaveDatum(int i, uint8_t value) {
				assert(i < 16);
				m_waveData[i] = value;
			}

			int waveDatum(int i) const {
				assert(i < 32);
				const auto packed = packedWaveDatum(i >> 1);
				return i & 1 ? Processor::lowNibble(packed) : Processor::highNibble(packed);
			}

		private:
			int m_enabled;
			int m_soundLength;
			int m_outputLevel;
			std::array<uint8_t, 16> m_waveData;
		};

		// NR4X
		class WhiteNoiseWaveVoice : public AudioVoice {
		public:
			WhiteNoiseWaveVoice() {}

			virtual void reset() override {
				AudioVoice::reset();
				m_envelope.reset();
				m_soundLength = m_polynomialShiftClockFrequency = m_polynomialCounterSteps = m_frequencyDivisionRatio = 0;
			}

			virtual bool zeroed() const override {
				return
					AudioVoice::zeroed()
					&& m_envelope.zeroed()
					&& (length() == 0)
					&& (polynomialShiftClockFrequency() == 0)
					&& (polynomialCounterSteps() == 0)
					&& (frequencyDivisionRatio() == 0);
			}

			Envelope& envelope() { return m_envelope;  }

			int length() const { return m_soundLength; }
			void setLength(int value) { m_soundLength = value; }

			int polynomialShiftClockFrequency() const { return m_polynomialShiftClockFrequency; }
			void setPolynomialShiftClockFrequency(int value) { m_polynomialShiftClockFrequency = value; }

			int polynomialCounterSteps() const { return m_polynomialCounterSteps; }
			void setPolynomialCounterSteps(int value) { m_polynomialCounterSteps = value; }

			int frequencyDivisionRatio() const { return m_frequencyDivisionRatio; }
			void setFrequencyDivisionRatio(int value) { m_frequencyDivisionRatio = value; }

		private:
			Envelope m_envelope;
			int m_soundLength;
			int m_polynomialShiftClockFrequency;
			int m_polynomialCounterSteps;
			int m_frequencyDivisionRatio;
		};

		class OutputChannel final {
		public:
			OutputChannel() {}

			void reset() {
				m_vin = false;
				m_outputLevel = 0;
				for (auto& outputVoice : m_outputVoices)
					outputVoice = false;
			}

			bool zeroed() const {
				return
					!vin()
					&& outputLevel() == 0
					&& !m_outputVoices[0] && !m_outputVoices[1] && !m_outputVoices[2] && !m_outputVoices[3];
			}

			bool vin() const { return m_vin; }
			void setVin(bool value) { m_vin = value; }

			int outputLevel() const { return m_outputLevel; }
			void setOutputLevel(int value) { m_outputLevel = value; }

			bool& outputVoice(int voice) { return m_outputVoices[voice]; }
			bool& outputVoice1() { return m_outputVoices[0]; }
			bool& outputVoice2() { return m_outputVoices[1]; }
			bool& outputVoice3() { return m_outputVoices[2]; }
			bool& outputVoice4() { return m_outputVoices[3]; }

			void dump() const {
				std::cout
					<< "Output channel: "
					<< "Vin:" << vin()
					<< ",Output level=" << outputLevel()
					<< ",Voices:" << (int)m_outputVoices[0] << (int)m_outputVoices[1] << (int)m_outputVoices[2] << (int)m_outputVoices[3]
					<< std::endl;
			}

		private:
			bool m_vin;
			int m_outputLevel;
			std::array<bool, 4> m_outputVoices;
		};

		class Audio final {
		public:
			Audio(int cyclesPerSecond)
			: m_frameSequencer(cyclesPerSecond),
			  m_enabled(false) {

				m_voices[0] = std::make_shared<SweptEnvelopedRectangularVoice>(cyclesPerSecond);
				m_voices[1] = std::make_shared<EnvelopedRectangularVoice>(cyclesPerSecond);
				m_voices[2] = std::make_shared<UserDefinedWaveVoice>(cyclesPerSecond);
				m_voices[3] = std::make_shared<WhiteNoiseWaveVoice>();

				m_frameSequencer.FrameStep.connect(std::bind(&Audio::Sequencer_FrameStep, this, std::placeholders::_1));
				m_frameSequencer.LengthStep.connect(std::bind(&Audio::Sequencer_LengthStep, this, std::placeholders::_1));
				m_frameSequencer.VolumeStep.connect(std::bind(&Audio::Sequencer_VolumeStep, this, std::placeholders::_1));
				m_frameSequencer.SweepStep.connect(std::bind(&Audio::Sequencer_SweepStep, this, std::placeholders::_1));
			}

			std::shared_ptr<AudioVoice> voice(int i) { return m_voices[i]; }

			SweptEnvelopedRectangularVoice* voice1() {
				return (SweptEnvelopedRectangularVoice*)voice(0).get();
			}

			EnvelopedRectangularVoice* voice2() {
				return (EnvelopedRectangularVoice*)voice(1).get();
			}

			UserDefinedWaveVoice* voice3() {
				return (UserDefinedWaveVoice*)voice(2).get();
			}

			WhiteNoiseWaveVoice* voice4() {
				return (WhiteNoiseWaveVoice*)voice(3).get();
			}

			OutputChannel& channel(int i) { return m_channels[i]; }
			OutputChannel& channel1() { return channel(0); }
			OutputChannel& channel2() { return channel(1); }

			bool enabled() const { return m_enabled; }

			void setEnabled(bool value) {
				m_enabled = value;
				if (!enabled())
					reset();
			}

			void reset() {
				m_enabled = false;
				for (auto voice : m_voices)
					voice->reset();
				for (auto& channel : m_channels)
					channel.reset();
			}

			bool zeroed() const {
				auto channelsZeroed = m_channels[0].zeroed() && m_channels[1].zeroed();
				auto voice1Zero = m_voices[0]->zeroed();
				auto voice2Zero = m_voices[1]->zeroed();
				auto voice3Zero = m_voices[2]->zeroed();
				auto voice4Zero = m_voices[3]->zeroed();
				auto voicesZeroed = voice1Zero && voice2Zero && voice3Zero && voice4Zero;
				return !enabled() && channelsZeroed && voicesZeroed;
			}

			void dumpVoice(int i) const {
				std::cout << "** Voice " << i + 1 << std::endl;
				m_voices[i]->dump();
			}

			void dumpVoices() const {
				for (int i = 0; i < 4; ++i)
					dumpVoice(i);
			}

			void dumpChannel(int i) const {
				std::cout << "** Channel " << i + 1 << std::endl;
				m_channels[i].dump();
			}

			void dumpChannels() const {
				for (int i = 0; i < 2; ++i)
					dumpChannel(i);
			}

			void dump() const {
				dumpVoices();
				dumpChannels();
			}

			//

			bool voice1On() const { return true; }
			bool voice2On() const { return true; }
			bool voice3On() const { return true; }
			bool voice4On() const { return true; }

			//

			uint8_t toNRx1(int i) {
				auto voice = (RectangularVoice*)m_voices[i].get();
				return
					(voice->waveFormDutyCycle() << 6)
					| Processor::Mask6;
			}

			void fromNRx1(int i, uint8_t value) {
				auto voice = (RectangularVoice*)m_voices[i].get();
				voice->setWaveFormDutyCycle((value >> 6) & Processor::Mask2);	// Bits 6-7
				voice->setLength(value & Processor::Mask6);						// Bits 0-5
			}

			uint8_t toNRx2(int i) {
				auto voice = (EnvelopedRectangularVoice*)m_voices[i].get();
				auto& envelope = voice->envelope();
				return
					(envelope.default() << 4)
					| (envelope.direction() << 3)
					| envelope.stepLength();
			}

			void fromNRx2(int i, uint8_t value) {
				auto voice = (EnvelopedRectangularVoice*)m_voices[i].get();
				auto& envelope = voice->envelope();
				envelope.setDefault((value >> 4) & Processor::Mask4);	// Bits 4-7
				envelope.setDirection((value >> 3) & Processor::Mask1);	// Bit 3
				envelope.setStepLength(value & Processor::Mask3); 		// Bits 0-2
			}

			uint8_t toNRx3(int i) {
				return Processor::Mask8;
			}

			void fromNRx3(int i, uint8_t value) {
				auto voice = (WaveVoice*)m_voices[i].get();
				voice->setFrequencyLowOrder(value);
			}

			// Sound mode 1 register: Sweep

			uint8_t toNR10() {
				auto& sweep = voice1()->sweep();
				return
					Processor::Bit7
					| (sweep.time() << 4)
					| (sweep.direction() << 3)
					| sweep.shift();
			}

			void fromNR10(uint8_t value) {
				auto& sweep = voice1()->sweep();
				sweep.setTime((value >> 4) & Processor::Mask3);			// Bits 4-6
				sweep.setDirection((value >> 3) & Processor::Mask1);	// Bit 3
				sweep.setShift(value & Processor::Mask3);				// Bits 0-2
			}

			// Sound mode 1 register: Sound length / Wave pattern duty
			uint8_t toNR11() { return toNRx1(0); }
			void fromNR11(uint8_t value) { fromNRx1(0, value); }

			// Sound mode 1 register: Envelope
			uint8_t toNR12() { return toNRx2(0); }
			void fromNR12(uint8_t value) { fromNRx2(0, value); }

			// Sound mode 1 register: Frequency lo
			uint8_t toNR13() { return toNRx3(0); }
			void fromNR13(uint8_t value) { fromNRx3(0, value); }

			// Sound mode 1 register: Frequency hi

			uint8_t toNR14() {
				return
					Processor::Bit7
					| (voice1()->type() << 6)
					| Processor::Mask6;
			}

			void fromNR14(uint8_t value) {
				voice1()->setInitialise((value >> 7) & Processor::Mask1);	// Bits 7
				voice1()->setType((value >> 6) & Processor::Mask1);			// Bits 6
				voice1()->setFrequencyHighOrder(value & Processor::Mask3);	// Bits 0-2
			}

			// Sound mode 2 register: Sound length / Wave pattern duty
			uint8_t toNR21() { return toNRx1(1); }
			void fromNR21(uint8_t value) { fromNRx1(1, value); }

			// Sound mode 2 register: Envelope
			uint8_t toNR22() { return toNRx2(1); }
			void fromNR22(uint8_t value) { fromNRx2(1, value); }

			// Sound mode 2 register: Frequency lo
			uint8_t toNR23() { return toNRx3(1); }
			void fromNR23(uint8_t value) { fromNRx3(1, value); }

			// Sound mode 2 register: Frequency hi

			uint8_t toNR24() {
				return
					Processor::Bit7
					| (voice2()->type() << 6)
					| Processor::Mask6;
			}

			void fromNR24(uint8_t value) {
				voice2()->setInitialise((value >> 7) & Processor::Mask1);	// Bits 7
				voice2()->setType((value >> 6) & Processor::Mask1);			// Bits 6
				voice2()->setFrequencyHighOrder(value & Processor::Mask3);	// Bits 0-2
			}

			// Sound mode 3 register: Sound on/off

			uint8_t toNR30() {
				return
					(voice3()->enabled() << 7)
					| Processor::Mask7;
			}

			void fromNR30(uint8_t value) {
				voice3()->setEnabled((value >> 7) & Processor::Mask1);		// Bit 7
			}

			// Sound mode 3 register: Sound length

			uint8_t toNR31() {
				return voice3()->length();
			}

			void fromNR31(uint8_t value) {
				voice3()->setLength(value);
			}

			// Sound mode 3 register: Select output level

			uint8_t toNR32() {
				return
					Processor::Bit7
					| Processor::Bit6
					| voice3()->level() << 5
					| Processor::Mask5;
			}

			void fromNR32(uint8_t value) {
				voice3()->setLevel((value >> 5) & Processor::Mask2);	// Bits 6-5
			}

			// Sound mode 3 register: Frequency lo
			uint8_t toNR33() { return toNRx3(2); }
			void fromNR33(uint8_t value) { fromNRx3(2, value); }

			// Sound mode 3 register: Frequency hi

			uint8_t toNR34() {
				return
					Processor::Bit7
					| (voice3()->type() << 6)
					| Processor::Mask6;
			}

			void fromNR34(uint8_t value) {
				voice3()->setInitialise((value >> 7) & Processor::Mask1);	// Bits 7
				voice3()->setType((value >> 6) & Processor::Mask1);			// Bits 6
				voice3()->setFrequencyHighOrder(value & Processor::Mask3);	// Bits 0-2
			}

			// Sound mode 4 register: Sound length

			uint8_t toNR41() {
				return
					Processor::Bit7
					| Processor::Bit6
					| voice4()->length();
			}

			void fromNR41(uint8_t value) {
				voice4()->setLength(value);
			}

			// Sound mode 4 register: Envelope
			uint8_t toNR42() { return toNRx2(3); }
			void fromNR42(uint8_t value) { fromNRx2(3, value); }

			// Sound mode 4 register: Polynomial counter

			uint8_t toNR43() {
				return
					(voice4()->polynomialShiftClockFrequency() << 4)
					| voice4()->polynomialCounterSteps() << 3
					| voice4()->frequencyDivisionRatio();
			}

			void fromNR43(uint8_t value) {
				voice4()->setPolynomialShiftClockFrequency((value >> 4) & Processor::Mask4);	// Bits 4-7
				voice4()->setPolynomialCounterSteps((value >> 3) & Processor::Mask1);			// Bit 3
				voice4()->setFrequencyDivisionRatio(value & Processor::Mask3);					// Bits 0-2
			}

			// Sound mode 4 register: counter/consecutive; inital

			uint8_t toNR44() {
				return
					Processor::Bit7
					| (voice4()->type() << 6)
					| Processor::Mask6;
			}

			void fromNR44(uint8_t value) {
				voice4()->setInitialise((value >> 7) & Processor::Mask1);	// Bit 7
				voice4()->setType((value >> 6) & Processor::Mask1);			// Bit 6
			}

			// Channel control: on-off/volume

			uint8_t toNR50() {
				return
					(channel2().vin() << 7)
					| (channel2().outputLevel() << 4)
					| (channel2().vin() << 3)
					| channel2().outputLevel();
			}

			void fromNR50(uint8_t value) {
				channel2().setVin((value >> 7) & Processor::Mask1);			// Bit 7
				channel2().setOutputLevel((value >> 4) & Processor::Mask3);	// Bits 4-6
				channel1().setVin((value >> 3) & Processor::Mask1);			// Bit 3
				channel1().setOutputLevel(value & Processor::Mask3);		// Bits 0-2
			}

			// Selection of Sound output terminal

			uint8_t toNR51() {
				return
					(channel2().outputVoice4() << 7)
					| (channel2().outputVoice3() << 6)
					| (channel2().outputVoice2() << 5)
					| (channel2().outputVoice1() << 4)
					| (channel1().outputVoice4() << 3)
					| (channel1().outputVoice3() << 2)
					| (channel1().outputVoice2() << 1)
					| (int)channel1().outputVoice1();
			}

			void fromNR51(uint8_t value) {
				channel2().outputVoice4() = (value >> 7) & Processor::Mask1;	// Bit 7
				channel2().outputVoice3() = (value >> 6) & Processor::Mask1;	// Bit 6
				channel2().outputVoice2() = (value >> 5) & Processor::Mask1;	// Bit 5
				channel2().outputVoice1() = (value >> 4) & Processor::Mask1;	// Bit 4
				channel1().outputVoice4() = (value >> 3) & Processor::Mask1;	// Bit 3
				channel1().outputVoice3() = (value >> 2) & Processor::Mask1;	// Bit 2
				channel1().outputVoice2() = (value >> 1) & Processor::Mask1;	// Bit 1
				channel1().outputVoice1() = value & Processor::Mask1;			// Bit 0
			}

			// Sound on/off

			uint8_t toNR52() {
				return
					(enabled() << 7)
					| Processor::Bit6 | Processor::Bit5 | Processor::Bit4
					| (voice4On() << 3)
					| (voice3On() << 2)
					| (voice2On() << 1)
					| (int)voice1On();
			}

			void fromNR52(uint8_t value) {
				setEnabled((value >> 7) & Processor::Mask1);	// Bit 7
			}

			void setPackedWaveDatum(int i, uint8_t value) {
				voice3()->setPackedWaveDatum(i, value);
			}

			uint8_t packedWaveDatum(int i) {
				return voice3()->packedWaveDatum(i);
			}

			void stepFrame(int cycles) {
				m_frameSequencer.step(cycles);
			}

			void Sequencer_FrameStep(const int step) {
			}

			void Sequencer_LengthStep(const int step) {
			}

			void Sequencer_VolumeStep(const int step) {
			}

			void Sequencer_SweepStep(const int step) {
			}

		private:
			AudioFrame m_frameSequencer;

			std::array<std::shared_ptr<AudioVoice>, 4> m_voices;
			std::array<OutputChannel, 2> m_channels;
			bool m_enabled;
		};
	}
}