BizHawk/BizHawk.Emulation.Cores/Consoles/Nintendo/NES/APU.cs

//TODO - so many integers in the square wave output keep us from exactly unbiasing the waveform. also other waves probably. consider improving the unbiasing.
//ALSO - consider whether we should even be doing it: the nonlinear-mixing behaviour probably depends on those biases being there. 
//if we have a better high-pass filter somewhere then we might could cope with the weird biases 
//(mix higher integer precision with the non-linear mixer and then highpass filter befoure outputting s16s)
//TODO - DMC cpu suspending - http://forums.nesdev.com/viewtopic.php?p=62690#p62690

//http://wiki.nesdev.com/w/index.php/APU_Mixer_Emulation
//http://wiki.nesdev.com/w/index.php/APU
//http://wiki.nesdev.com/w/index.php/APU_Pulse
//sequencer ref: http://wiki.nesdev.com/w/index.php/APU_Frame_Counter

//TODO - refactor length counter to be separate component

using System;
using System.Collections.Generic;

using BizHawk.Common;
using BizHawk.Common.NumberExtensions;

namespace BizHawk.Emulation.Cores.Nintendo.NES
{

	sealed partial class NES
	{
		public sealed class APU 
		{
			public static bool CFG_DECLICK = true;

			public int Square1V = 376;
			public int Square2V = 376;
			public int TriangleV = 426;
			public int NoiseV = 247;
			public int DMCV = 167;

			public bool recalculate = false;

			NES nes;
			public APU(NES nes, APU old, bool pal)
			{
				this.nes = nes;
				dmc = new DMCUnit(this, pal);
				noise = new NoiseUnit(this, pal);
				triangle = new TriangleUnit(this);
				pulse[0] = new PulseUnit(this, 0);
				pulse[1] = new PulseUnit(this, 1);
				if (old != null)
				{
					Square1V = old.Square1V;
					Square2V = old.Square2V;
					TriangleV = old.TriangleV;
					NoiseV = old.NoiseV;
					DMCV = old.DMCV;
				}
			}

			static int[] DMC_RATE_NTSC = { 428, 380, 340, 320, 286, 254, 226, 214, 190, 160, 142, 128, 106, 84, 72, 54 };
			static int[] DMC_RATE_PAL = { 398, 354, 316, 298, 276, 236, 210, 198, 176, 148, 132, 118, 98, 78, 66, 50 };
			static int[] LENGTH_TABLE = { 10, 254, 20, 2, 40, 4, 80, 6, 160, 8, 60, 10, 14, 12, 26, 14, 12, 16, 24, 18, 48, 20, 96, 22, 192, 24, 72, 26, 16, 28, 32, 30 };
			static byte[,] PULSE_DUTY = {
				{0,1,0,0,0,0,0,0}, //(12.5%)
				{0,1,1,0,0,0,0,0}, //(25%)
				{0,1,1,1,1,0,0,0}, //(50%)
				{1,0,0,1,1,1,1,1}, //(25% negated (75%))
			};
			static byte[] TRIANGLE_TABLE = 
			{
				15, 14, 13, 12, 11, 10,  9,  8,  7,  6,  5,  4,  3,  2,  1,  0,
 				0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14, 15
			};
			static int[] NOISE_TABLE_NTSC = 
			{
				4, 8, 16, 32, 64, 96, 128, 160, 202, 254, 380, 508, 762, 1016, 2034, 4068
			};
			static int[] NOISE_TABLE_PAL = 
			{
				4, 7, 14, 30, 60, 88, 118, 148, 188, 236, 354, 472, 708,  944, 1890, 3778
			};


			sealed class PulseUnit
			{
				public PulseUnit(APU apu, int unit) { this.unit = unit; this.apu = apu; }
				public int unit;
				APU apu;

				//reg0
				int duty_cnt, env_loop, env_constant, env_cnt_value;
				//reg1
				int sweep_en, sweep_divider_cnt, sweep_negate, sweep_shiftcount;
				bool sweep_reload;
				//reg2/3
				int len_cnt;
				int timer_raw_reload_value, timer_reload_value;

				//misc..
				int lenctr_en;

				public void SyncState(Serializer ser)
				{
					ser.BeginSection("Pulse" + unit);
					ser.Sync("duty_cnt", ref duty_cnt);
					ser.Sync("env_loop", ref env_loop);
					ser.Sync("env_constant", ref env_constant);
					ser.Sync("env_cnt_value", ref env_cnt_value);

					ser.Sync("sweep_en", ref sweep_en);
					ser.Sync("sweep_divider_cnt", ref sweep_divider_cnt);
					ser.Sync("sweep_negate", ref sweep_negate);
					ser.Sync("sweep_shiftcount", ref sweep_shiftcount);
					ser.Sync("sweep_reload", ref sweep_reload);

					ser.Sync("len_cnt", ref len_cnt);
					ser.Sync("timer_raw_reload_value", ref timer_raw_reload_value);
					ser.Sync("timer_reload_value", ref timer_reload_value);

					ser.Sync("lenctr_en", ref lenctr_en);

					ser.Sync("swp_divider_counter", ref swp_divider_counter);
					ser.Sync("swp_silence", ref swp_silence);
					ser.Sync("duty_step", ref duty_step);
					ser.Sync("timer_counter", ref timer_counter);
					ser.Sync("sample", ref sample);
					ser.Sync("duty_value", ref duty_value);

					ser.Sync("env_start_flag", ref env_start_flag);
					ser.Sync("env_divider", ref env_divider);
					ser.Sync("env_counter", ref env_counter);
					ser.Sync("env_output", ref env_output);
					ser.EndSection();
				}

				public bool IsLenCntNonZero() { return len_cnt > 0; }

				public void WriteReg(int addr, byte val)
				{
					//Console.WriteLine("write pulse {0:X} {1:X}", addr, val);
					switch (addr)
					{
						case 0:
							env_cnt_value = val & 0xF;
							env_constant = (val >> 4) & 1;
							env_loop = (val >> 5) & 1;
							duty_cnt = (val >> 6) & 3;
							break;
						case 1:
							sweep_shiftcount = val & 7;
							sweep_negate = (val >> 3) & 1;
							sweep_divider_cnt = (val >> 4) & 7;
							sweep_en = (val >> 7) & 1;
							sweep_reload = true;
							break;
						case 2:
							timer_reload_value = (timer_reload_value & ~0xFF) | val;
							timer_raw_reload_value = timer_reload_value * 2 + 2;
							//if (unit == 1) Console.WriteLine("{0} timer_reload_value: {1}", unit, timer_reload_value);
							break;
						case 3:
							len_cnt = LENGTH_TABLE[(val >> 3) & 0x1F];
							timer_reload_value = (timer_reload_value & 0xFF) | ((val & 0x07) << 8);
							timer_raw_reload_value = timer_reload_value * 2 + 2;
							//duty_step = 0; //?just a guess?
							timer_counter = timer_raw_reload_value;
							env_start_flag = 1;

							//allow the lenctr_en to kill the len_cnt
							set_lenctr_en(lenctr_en);

							//serves as a useful note-on diagnostic
							//if(unit==1) Console.WriteLine("{0} timer_reload_value: {1}", unit, timer_reload_value);
							break;
					}
				}

				public void set_lenctr_en(int value)
				{
					lenctr_en = value;
					//if the length counter is not enabled, then we must disable the length system in this way
					if (lenctr_en == 0) len_cnt = 0;
				}

				//state
				//why was all of this stuff not in the savestate???????
				int swp_divider_counter;
				bool swp_silence;
				int duty_step;
				int timer_counter;
				public int sample;
				bool duty_value;

				int env_start_flag, env_divider, env_counter, env_output;

				public void clock_length_and_sweep()
				{
					//this should be optimized to update only when `timer_reload_value` changes
					int sweep_shifter = timer_reload_value >> sweep_shiftcount;
					if (sweep_negate == 1)
						sweep_shifter = ~sweep_shifter + unit;
					sweep_shifter += timer_reload_value;

					//this sweep logic is always enabled:
					swp_silence = (timer_reload_value < 8 || (sweep_shifter > 0x7FF && sweep_negate == 0));

					//does enable only block the pitch bend? does the clocking proceed?
					if (sweep_en == 1)
					{
						//clock divider
						if (swp_divider_counter != 0) swp_divider_counter--;
						if (swp_divider_counter == 0)
						{
							swp_divider_counter = sweep_divider_cnt + 1;

							//divider was clocked: process sweep pitch bend
							if (sweep_shiftcount != 0 && !swp_silence)
							{
								timer_reload_value = sweep_shifter;
								timer_raw_reload_value = (timer_reload_value << 1) + 2;
							}
							//TODO - does this change the user's reload value or the latched reload value?
						}

						//handle divider reload, after clocking happens
						if (sweep_reload)
						{
							swp_divider_counter = sweep_divider_cnt + 1;
							sweep_reload = false;
						}
					}

					//env_loopdoubles as "halt length counter"
					if (env_loop == 0 && len_cnt > 0)
						len_cnt--;
				}

				public void clock_env()
				{
					if (env_start_flag == 1)
					{
						env_start_flag = 0;
						env_divider = (env_cnt_value + 1);
						env_counter = 15;
					}
					else
					{
						if (env_divider != 0) env_divider--;
						if (env_divider == 0)
						{
							env_divider = (env_cnt_value + 1);
							if (env_counter == 0)
							{
								if (env_loop == 1)
								{
									env_counter = 15;
								}
							}
							else env_counter--;
						}
					}
				}

				public void Run()
				{
					if (env_constant == 1)
						env_output = env_cnt_value;
					else env_output = env_counter;

					if (timer_counter > 0) timer_counter--;
					if (timer_counter == 0 && timer_raw_reload_value != 0)
					{
						duty_step = (duty_step + 1) & 7;
						duty_value = PULSE_DUTY[duty_cnt, duty_step] == 1;
						//reload timer
						timer_counter = timer_raw_reload_value;
					}

					int newsample;

					if (duty_value) //high state of duty cycle
					{
						newsample = env_output;
						if (swp_silence || len_cnt == 0)
							newsample = 0; // silenced
					}
					else
						newsample = 0; //duty cycle is 0, silenced.

					//newsample -= env_output >> 1; //unbias
					if (newsample != sample)
					{
						apu.recalculate = true;
						sample = newsample;
					}
				}
			}

			sealed class NoiseUnit
			{
				APU apu;

				//reg0 (sweep)
				int env_cnt_value, env_loop, env_constant;

				//reg2 (mode and period)
				int mode_cnt, period_cnt;

				//reg3 (length counter and envelop trigger)
				int len_cnt;

				//set from apu:
				int lenctr_en;

				//state
				int shift_register = 1;
				int timer_counter;
				public int sample;
				int env_output, env_start_flag, env_divider, env_counter;
				bool noise_bit = true;

				int[] NOISE_TABLE;

				public NoiseUnit(APU apu, bool pal)
				{
					this.apu = apu;
					NOISE_TABLE = pal ? NOISE_TABLE_PAL : NOISE_TABLE_NTSC;
				}

				public void SyncState(Serializer ser)
				{
					ser.BeginSection("Noise");
					ser.Sync("env_cnt_value", ref env_cnt_value);
					ser.Sync("env_loop", ref env_loop);
					ser.Sync("env_constant", ref env_constant);
					ser.Sync("mode_cnt", ref mode_cnt);
					ser.Sync("period_cnt", ref period_cnt);

					//ser.Sync("mode_cnt", ref mode_cnt);
					//ser.Sync("period_cnt", ref period_cnt);

					ser.Sync("len_cnt", ref len_cnt);

					ser.Sync("lenctr_en", ref lenctr_en);

					ser.Sync("shift_register", ref shift_register);
					ser.Sync("timer_counter", ref timer_counter);
					ser.Sync("sample", ref sample);

					ser.Sync("env_output", ref env_output);
					ser.Sync("env_start_flag", ref env_start_flag);
					ser.Sync("env_divider", ref env_divider);
					ser.Sync("env_counter", ref env_counter);
					ser.Sync("noise_bit", ref noise_bit);
					ser.EndSection();
				}


				public bool IsLenCntNonZero() { return len_cnt > 0; }

				public void WriteReg(int addr, byte val)
				{
					switch (addr)
					{
						case 0:
							env_cnt_value = val & 0xF;
							env_constant = (val >> 4) & 1;
							env_loop = (val >> 5) & 1;
							break;
						case 1:
							break;
						case 2:
							period_cnt = NOISE_TABLE[val & 0xF];
							mode_cnt = (val >> 7) & 1;
							//Console.WriteLine("noise period: {0}, vol: {1}", (val & 0xF), env_cnt_value);
							break;
						case 3:
							len_cnt = LENGTH_TABLE[(val >> 3) & 0x1F];
							set_lenctr_en(lenctr_en);
							env_start_flag = 1;
							break;
					}
				}

				public void set_lenctr_en(int value)
				{
					lenctr_en = value;
					//Console.WriteLine("noise lenctr_en: " + lenctr_en);
					//if the length counter is not enabled, then we must disable the length system in this way
					if (lenctr_en == 0) len_cnt = 0;
				}

				public void clock_env()
				{
					if (env_start_flag == 1)
					{
						env_start_flag = 0;
						env_divider = (env_cnt_value + 1);
						env_counter = 15;
					}
					else
					{
						if (env_divider != 0) env_divider--;
						if (env_divider == 0)
						{
							env_divider = (env_cnt_value + 1);
							if (env_counter == 0)
							{
								if (env_loop == 1)
								{
									env_counter = 15;
								}
							}
							else env_counter--;
						}
					}

				}
				public void clock_length_and_sweep()
				{

					if (len_cnt > 0 && env_loop == 0)
						len_cnt--;
				}

				public void Run()
				{
					if (env_constant == 1)
						env_output = env_cnt_value;
					else env_output = env_counter;

					if (timer_counter > 0) timer_counter--;
					if (timer_counter == 0 && period_cnt != 0)
					{
						//reload timer
						timer_counter = period_cnt;
						int feedback_bit;
						if (mode_cnt == 1) feedback_bit = (shift_register >> 6) & 1;
						else feedback_bit = (shift_register >> 1) & 1;
						int feedback = feedback_bit ^ (shift_register & 1);
						shift_register >>= 1;
						shift_register &= ~(1 << 14);
						shift_register |= (feedback << 14);
						noise_bit = (shift_register & 1) != 0;
					}

					int newsample;
					if (len_cnt == 0) newsample = 0;
					else if (noise_bit) newsample = env_output; // switched, was 0?
					else newsample = 0;
					if (newsample != sample)
					{
						apu.recalculate = true;
						sample = newsample;
					}
				}
			}

			sealed class TriangleUnit
			{
				//reg0
				int linear_counter_reload, control_flag;
				//reg1 (n/a)
				//reg2/3
				int timer_cnt, halt_flag, len_cnt;

				//misc..
				int lenctr_en;
				int linear_counter, timer, timer_cnt_reload;
				int seq = 15;
				public int sample;

				APU apu;
				public TriangleUnit(APU apu) { this.apu = apu; }

				public void SyncState(Serializer ser)
				{
					ser.BeginSection("Triangle");
					ser.Sync("linear_counter_reload", ref linear_counter_reload);
					ser.Sync("control_flag", ref control_flag);
					ser.Sync("timer_cnt", ref timer_cnt);
					ser.Sync("halt_flag", ref halt_flag);
					ser.Sync("len_cnt", ref len_cnt);

					ser.Sync("lenctr_en", ref lenctr_en);
					ser.Sync("linear_counter", ref linear_counter);
					ser.Sync("timer", ref timer);
					ser.Sync("timer_cnt_reload", ref timer_cnt_reload);
					ser.Sync("seq", ref seq);
					ser.Sync("sample", ref sample);
					ser.EndSection();
				}

				public bool IsLenCntNonZero() { return len_cnt > 0; }

				public void set_lenctr_en(int value)
				{
					lenctr_en = value;
					//if the length counter is not enabled, then we must disable the length system in this way
					if (lenctr_en == 0) len_cnt = 0;
				}

				public void WriteReg(int addr, byte val)
				{
					//Console.WriteLine("tri writes addr={0}, val={1:x2}", addr, val);
					switch (addr)
					{
						case 0:
							linear_counter_reload = (val & 0x7F);
							control_flag = (val >> 7) & 1;
							break;
						case 1: break;
						case 2:
							timer_cnt = (timer_cnt & ~0xFF) | val;
							timer_cnt_reload = timer_cnt + 1;
							break;
						case 3:
							timer_cnt = (timer_cnt & 0xFF) | ((val & 0x7) << 8);
							timer_cnt_reload = timer_cnt + 1;
							len_cnt = LENGTH_TABLE[(val >> 3) & 0x1F];
							halt_flag = 1;

							//allow the lenctr_en to kill the len_cnt
							set_lenctr_en(lenctr_en);
							break;
					}
					//Console.WriteLine("tri timer_reload_value: {0}", timer_cnt_reload);
				}

				public void Run()
				{
					//when clocked by timer
					//seq steps forward
					//except when linear counter or
					//length counter is 0

					//dont stop the triangle channel until its level is 0. makes it sound nicer.
					bool need_declick = (seq != 16 && seq != 15);
					bool en = len_cnt != 0 && linear_counter != 0 || need_declick;

					//length counter and linear counter 
					//is clocked in frame counter.
					if (en)
					{
						int newsample;
						if (timer > 0) timer--;
						if (timer == 0)
						{
							seq = (seq + 1) & 0x1F;
							timer = timer_cnt_reload;
						}
						if(CFG_DECLICK) // this looks ugly...
							newsample = TRIANGLE_TABLE[(seq + 8) & 0x1F];
						else
							newsample = TRIANGLE_TABLE[seq];
						
						//special hack: frequently, games will use the maximum frequency triangle in order to mute it
						//apparently this results in the DAC for the triangle wave outputting a steady level at about 7.5
						//so we'll emulate it at the digital level
						if (timer_cnt_reload == 1) newsample = 8;

						//newsample -= 8; //unbias
						if (newsample != sample)
						{
							apu.recalculate = true;
							sample = newsample;
						}
					}

				}


				public void clock_length_and_sweep()
				{
					//env_loopdoubles as "halt length counter"
					if (len_cnt > 0 && halt_flag == 0)
						len_cnt--;
				}

				public void clock_linear_counter()
				{
					//	Console.WriteLine("linear_counter: {0}", linear_counter);
					if (halt_flag == 1)
					{
						linear_counter = linear_counter_reload;
					}
					else if (linear_counter != 0)
					{
						linear_counter--;
					}

					//declick when the sound begins
					//if (halt_flag == 1 && control_flag == 0)
					//{
					//    seq = 16;
					//   Console.WriteLine("declicked triangle");
					//}

					//declick on end of sound
					//bool en = len_cnt != 0 && linear_counter != 0;
					//if (!en)
					//    if (sample < 0) sample++; else if (sample > 0) sample--;

					halt_flag = control_flag;
				}
			} //class TriangleUnit

			sealed class DMCUnit
			{
				APU apu;
				int[] DMC_RATE;
				public DMCUnit(APU apu, bool pal)
				{
					this.apu = apu;
					out_silence = true;
					DMC_RATE = pal ? DMC_RATE_PAL : DMC_RATE_NTSC;
					timer_reload = DMC_RATE[0];
					sample_buffer_filled = false;
					out_deltacounter = 64;
					out_bits_remaining = 0;
				}

				bool irq_enabled;
				bool loop_flag;
				int timer_reload;

				int timer;
				int user_address, user_length;
				int sample_address, sample_length, sample_buffer;
				bool sample_buffer_filled;

				int out_shift, out_bits_remaining, out_deltacounter;
				bool out_silence;

				public int sample { get { return out_deltacounter /* - 64*/; } }

				public void SyncState(Serializer ser)
				{
					ser.BeginSection("DMC");
					ser.Sync("irq_enabled", ref irq_enabled);
					ser.Sync("loop_flag", ref loop_flag);
					ser.Sync("timer_reload", ref timer_reload);

					ser.Sync("timer", ref timer);
					ser.Sync("user_address", ref user_address);
					ser.Sync("user_length", ref user_length);

					ser.Sync("sample_address", ref sample_address);
					ser.Sync("sample_length", ref sample_length);
					ser.Sync("sample_buffer", ref sample_buffer);
					ser.Sync("sample_buffer_filled", ref sample_buffer_filled);

					ser.Sync("out_shift", ref out_shift);
					ser.Sync("out_bits_remaining", ref out_bits_remaining);
					ser.Sync("out_deltacounter", ref out_deltacounter);
					ser.Sync("out_silence", ref out_silence);

					//int sample = 0; //junk
					//ser.Sync("sample", ref sample);
					ser.EndSection();
				}

				public void Run()
				{
					if (timer > 0) timer--;
					if (timer == 0)
					{
						timer = timer_reload;
						Clock();
					}
				}


				void Clock()
				{
					//If the silence flag is clear, bit 0 of the shift register is applied to the counter as follows: 
					//if bit 0 is clear and the delta-counter is greater than 1, the counter is decremented by 2; 
					//otherwise, if bit 0 is set and the delta-counter is less than 126, the counter is incremented by 2
					if (!out_silence)
					{
						//apply current sample bit to delta counter
						if (out_shift.Bit(0))
						{
							if (out_deltacounter < 126)
								out_deltacounter += 2;
						}
						else
						{
							if (out_deltacounter > 1)
								out_deltacounter -= 2;
						}
						//apu.nes.LogLine("dmc out sample: {0}", out_deltacounter);
						apu.recalculate = true;
					}

					//The right shift register is clocked. 
					out_shift >>= 1;

					//The bits-remaining counter is decremented. If it becomes zero, a new cycle is started. 
					if (out_bits_remaining == 0)
					{
						//The bits-remaining counter is loaded with 8. 
						out_bits_remaining = 7;
						//If the sample buffer is empty then the silence flag is set
						if (!sample_buffer_filled)
						{
							out_silence = true;
							//out_deltacounter = 64; //gonna go out on a limb here and guess this gets reset. could make some things pop, though, if they dont end at 0.
						}
						else
						//otherwise, the silence flag is cleared and the sample buffer is emptied into the shift register. 
						{
							out_silence = false;
							out_shift = sample_buffer;
							sample_buffer_filled = false;
						}
					}
					else out_bits_remaining--;

						
					//Any time the sample buffer is in an empty state and bytes remaining is not zero, the following occur: 
					if (!sample_buffer_filled && sample_length > 0)
						Fetch();
				}

				public void set_lenctr_en(bool en)
				{
					if (!en)
					{
						//If the DMC bit is clear, the DMC bytes remaining will be set to 0 
						sample_length = 0;
						//and the DMC will silence when it empties.
						//  (what does this mean? does out_deltacounter get reset to 0? maybe just that the out_silence flag gets set, but this is natural)
					}
					else
					{
						//only start playback if playback is stopped
						if (sample_length == 0)
						{
							sample_address = user_address;
							sample_length = user_length;
							if (out_silence)
							{
								timer = 0;
								out_bits_remaining = 0;
							}
						}
					}

					//irq is acknowledged or sure to be clear, in either case
					apu.dmc_irq = false;
					apu.SyncIRQ();
				}

				public bool IsLenCntNonZero()
				{
					return sample_length != 0;
				}

				public void WriteReg(int addr, byte val)
				{
					//Console.WriteLine("DMC writes addr={0}, val={1:x2}", addr, val);
					switch (addr)
					{
						case 0:
							irq_enabled = val.Bit(7);
							loop_flag = val.Bit(6);
							timer_reload = DMC_RATE[val & 0xF];
							if (!irq_enabled) apu.dmc_irq = false;
							apu.SyncIRQ();
							break;
						case 1:
							out_deltacounter = val & 0x7F;
							//apu.nes.LogLine("~~ out_deltacounter set to {0}", out_deltacounter);
							apu.recalculate = true;
							break;
						case 2:
							user_address = 0xC000 | (val << 6);
							break;
						case 3:
							user_length = (val << 4) + 1;
							break;
					}
				}

				public void Fetch()
				{
					//TODO - cpu/apu DMC reads need to be emulated better!
					sample_buffer = apu.nes.ReadMemory((ushort)sample_address);
					sample_buffer_filled = true;
					sample_address = (ushort)(sample_address + 1);
					sample_length--;
					if (sample_length == 0)
					{
						if (loop_flag)
						{
							sample_address = user_address;
							sample_length = user_length;
						}
						else if (irq_enabled) apu.dmc_irq = true;
					}
					//Console.WriteLine("fetching dmc byte: {0:X2}", sample_buffer);
				}
			}

			public void SyncState(Serializer ser)
			{
				ser.Sync("irq_pending", ref irq_pending);
				ser.Sync("dmc_irq", ref dmc_irq);
				ser.Sync("pending_reg", ref pending_reg);
				ser.Sync("pending_val", ref pending_val);

				ser.Sync("sequencer_counter", ref sequencer_counter);
				ser.Sync("sequencer_step", ref sequencer_step);
				ser.Sync("sequencer_mode", ref sequencer_mode);
				ser.Sync("sequencer_irq_inhibit;", ref sequencer_irq_inhibit);
				ser.Sync("sequencer_irq", ref sequencer_irq);
				ser.Sync("sequence_reset_pending", ref sequence_reset_pending);
				ser.Sync("sequencer_irq_clear_pending", ref sequencer_irq_clear_pending);
				ser.Sync("sequencer_irq_assert", ref sequencer_irq_assert);

				pulse[0].SyncState(ser);
				pulse[1].SyncState(ser);
				triangle.SyncState(ser);
				noise.SyncState(ser);
				dmc.SyncState(ser);
				SyncIRQ();
			}

			PulseUnit[] pulse = new PulseUnit[2];
			TriangleUnit triangle;
			NoiseUnit noise; //= new NoiseUnit();
			DMCUnit dmc;

			bool irq_pending;
			bool dmc_irq;
			int pending_reg = -1;
			byte pending_val = 0;

			int sequencer_counter, sequencer_step, sequencer_mode, sequencer_irq_inhibit;
			bool sequencer_irq, sequence_reset_pending, sequencer_irq_clear_pending, sequencer_irq_assert;

			public void RunDMCFetch()
			{
				dmc.Fetch();
			}

			void sequencer_reset()
			{
				sequencer_counter = 0;

				if (sequencer_mode == 1)
				{
					sequencer_step = 0;
					QuarterFrame();
					HalfFrame();
				}
				else
					sequencer_step = 0;
			}

			//these figures are not valid for PAL. they must be recalculated with nintendulator's values above
			//these values (the NTSC at least) are derived from nintendulator. they are all 2 higher than the specifications, due to some shortcoming in the emulation
			//this is probably a hint that we're doing something a little wrong but making up for it with curcuitous chaos in other ways
			static int[][] sequencer_lut = new int[][]{
				new int[]{7458,14914,22372,29830},
				new int[]{7458,14914,22372,29830,37282}
			};

			void sequencer_tick()
			{
				sequencer_counter++;
				if (sequence_reset_pending)
				{
					sequencer_reset();
					sequence_reset_pending = false;
				}
				if (sequencer_lut[sequencer_mode][sequencer_step] != sequencer_counter)
					return;
				sequencer_check();
			}

			public void SyncIRQ()
			{
				irq_pending = sequencer_irq | dmc_irq;
			}

			void sequencer_check()
			{
				//Console.WriteLine("sequencer mode {0} step {1}", sequencer_mode, sequencer_step);
				bool quarter, half, reset;
				switch (sequencer_mode)
				{
					case 0: //4-step
						quarter = true;
						half = (sequencer_step == 1 || sequencer_step == 3);
						reset = sequencer_step == 3;
						if (reset && sequencer_irq_inhibit == 0)
						{
							//Console.WriteLine("{0} {1,5} set irq_assert", nes.Frame, sequencer_counter);
							sequencer_irq_assert = true;
						}
						break;

					case 1: //5-step
						quarter = sequencer_step != 3;
						half = (sequencer_step == 1 || sequencer_step == 4);
						reset = sequencer_step == 4;
						break;

					default:
						throw new InvalidOperationException();
				}

				if (reset)
				{
					sequencer_counter = 0;
					sequencer_step = 0;
				}
				else sequencer_step++;

				if (quarter) QuarterFrame();
				if (half) HalfFrame();
			}

			void HalfFrame()
			{
				pulse[0].clock_length_and_sweep();
				pulse[1].clock_length_and_sweep();
				triangle.clock_length_and_sweep();
				noise.clock_length_and_sweep();
			}

			void QuarterFrame()
			{
				pulse[0].clock_env();
				pulse[1].clock_env();
				triangle.clock_linear_counter();
				noise.clock_env();
			}

			public void NESSoftReset()
			{
				//need to study what happens to apu and stuff..
				sequencer_irq = false;
				_WriteReg(0x4015, 0);
			}

			public void WriteReg(int addr, byte val)
			{
				pending_reg = addr;
				pending_val = val;
			}

			void _WriteReg(int addr, byte val)
			{
				//Console.WriteLine("{0:X4} = {1:X2}", addr, val);
				int index = addr - 0x4000;
				int reg = index & 3;
				int channel = index >> 2;
				switch (channel)
				{
					case 0: 
						pulse[0].WriteReg(reg, val); 
						break;
					case 1: 
						pulse[1].WriteReg(reg, val); 
						break;
					case 2: 
						triangle.WriteReg(reg, val); 
						break;
					case 3: 
						noise.WriteReg(reg, val); 
						break;
					case 4: 
						dmc.WriteReg(reg, val); 
						break;
					case 5:
						if (addr == 0x4015)
						{
							pulse[0].set_lenctr_en(val & 1);
							pulse[1].set_lenctr_en((val >> 1) & 1);
							triangle.set_lenctr_en((val >> 2) & 1);
							noise.set_lenctr_en((val >> 3) & 1);
							dmc.set_lenctr_en(val.Bit(4));
						}
						else if (addr == 0x4017)
						{
							//Console.WriteLine("apu 4017 = {0:X2}", val);
							sequencer_mode = (val >> 7) & 1;
							sequencer_irq_inhibit = (val >> 6) & 1;
							if (sequencer_irq_inhibit == 1)
							{
								sequencer_irq_clear_pending = true;
							}
							sequence_reset_pending = true;
							break;
						}
						break;
				}
			}


			public byte PeekReg(int addr)
			{
				switch (addr)
				{
					case 0x4015:
						{
							//notice a missing bit here. should properly emulate with empty / Data bus
							//if an interrupt flag was set at the same moment of the read, it will read back as 1 but it will not be cleared. 
							int dmc_nonzero = dmc.IsLenCntNonZero() ? 1 : 0;
							int noise_nonzero = noise.IsLenCntNonZero() ? 1 : 0;
							int tri_nonzero = triangle.IsLenCntNonZero() ? 1 : 0;
							int pulse1_nonzero = pulse[1].IsLenCntNonZero() ? 1 : 0;
							int pulse0_nonzero = pulse[0].IsLenCntNonZero() ? 1 : 0;
							int ret = ((dmc_irq ? 1 : 0) << 7) | ((sequencer_irq ? 1 : 0) << 6) | (dmc_nonzero << 4) | (noise_nonzero << 3) | (tri_nonzero << 2) | (pulse1_nonzero << 1) | (pulse0_nonzero);
							return (byte)ret;
						}
					default:
						//don't return 0xFF here or SMB will break
						return 0x00;
				}
			}

			public byte ReadReg(int addr)
			{
				switch (addr)
				{
					case 0x4015:
						{
							byte ret = PeekReg(0x4015);
							//Console.WriteLine("{0} {1,5} $4015 clear irq, was at {2}", nes.Frame, sequencer_counter, sequencer_irq);
							sequencer_irq = false;
							SyncIRQ();
							return ret;
						}
					default:
						//don't return 0xFF here or SMB will break
						return 0x00;
				}
			}

			int toggle = 0;
			public void RunOne()
			{
				pulse[0].Run();
				pulse[1].Run();
				triangle.Run();
				noise.Run();
				dmc.Run();

				EmitSample();

				//this (and the similar line below) is a crude hack
				//we should be generating logic to suppress the $4015 clear when the assert signal is set instead
				//be sure to test "apu_test" if you mess with this
				sequencer_irq |= sequencer_irq_assert;

				if (toggle == 0)
				{
					//handle sequencer irq clear signal
					sequencer_irq_assert = false;
					if (sequencer_irq_clear_pending)
					{
						//Console.WriteLine("{0} {1,5} $4017 clear irq (delayed)", nes.Frame, sequencer_counter);
						sequencer_irq_clear_pending = false;
						sequencer_irq = false;
						SyncIRQ();
					}

					//handle writes from the odd clock cycle
					if (pending_reg != -1) _WriteReg(pending_reg, pending_val);
					pending_reg = -1;
					toggle = 1;

					//latch whatever irq logic we had and send to cpu
					nes.irq_apu = irq_pending;
				}
				else toggle = 0;

				sequencer_tick();
				sequencer_irq |= sequencer_irq_assert;
				SyncIRQ();

				//since the units run concurrently, the APU frame sequencer is ran last because
				//it can change the ouput values of the pulse/triangle channels
				//we want the changes to affect it on the *next* cycle.
			}

			public struct Delta
			{
				public uint time;
				public int value;
				public Delta(uint time, int value)
				{
					this.time = time;
					this.value = value;
				}
			}
			public List<Delta> dlist = new List<Delta>();

			/// <summary>only call in board.ClockCPU()</summary>
			/// <param name="value"></param>
			public void ExternalQueue(int value)
			{
				// sampleclock is incremented right before board.ClockCPU()
				dlist.Add(new Delta(sampleclock - 1, value));
			}

			public uint sampleclock = 0;

			int oldmix = 0;

			// http://wiki.nesdev.com/w/index.php/APU_Mixer
			// in the end, doesn't help pass any tests, so canned
			/*
			static readonly int[] pulse_table;
			static readonly int[] tnd_table;
			static APU()
			{
				const double scale = 43803.0;

				pulse_table = new int[31];
				tnd_table = new int[203];
				pulse_table[0] = tnd_table[0] = 0;
				for (int i = 1; i < pulse_table.Length; i++)
					pulse_table[i] = (int)Math.Round(scale * 95.52 / (8128.0 / i + 100.0));
				for (int i = 1; i < tnd_table.Length; i++)
					tnd_table[i] = (int)Math.Round(scale * 163.67 / (24329.0 / i + 100.0));
			}
			*/

			void EmitSample()
			{
				if (recalculate)
				{
					recalculate = false;

					int s_pulse0 = pulse[0].sample;
					int s_pulse1 = pulse[1].sample;
					int s_tri = triangle.sample;
					int s_noise = noise.sample;
					int s_dmc = dmc.sample;
					//int s_ext = 0; //gamepak

					/*
					if (!EnableSquare1) s_pulse0 = 0;
					if (!EnableSquare2) s_pulse1 = 0;
					if (!EnableTriangle) s_tri = 0;
					if (!EnableNoise) s_noise = 0;
					if (!EnableDMC) s_dmc = 0;
					*/
					
					//const float NOISEADJUST = 0.5f;

					//linear approximation
					//float pulse_out = 0.00752f * (s_pulse0 + s_pulse1);
					//float tnd_out = 0.00851f * s_tri + 0.00494f * /*NOISEADJUST * */ s_noise + 0.00335f * s_dmc;
					//float output = pulse_out + tnd_out;
					//this needs to leave enough headroom for straying DC bias due to the DMC unit getting stuck outputs. smb3 is bad about that. 
					//int mix = (int)(50000 * output);

					int mix = Square1V * s_pulse0
						+ Square2V * s_pulse1
						+ TriangleV * s_tri
						+ NoiseV * s_noise
						+ DMCV * s_dmc;
					/*
					int pulse_out = 376 * (s_pulse0 + s_pulse1);
					int tnd_out = 426 * s_tri + 247 * s_noise + 167 * s_dmc;
					int mix = pulse_out + tnd_out;
					*/
					//int pulse_out = pulse_table[s_pulse0 + s_pulse1];
					//int tnd_out = tnd_table[3 * s_tri + 2 * s_noise + s_dmc];
					//int mix = pulse_out + tnd_out;

					dlist.Add(new Delta(sampleclock, mix - oldmix));
					oldmix = mix;
				}
				//more properly correct
				//float pulse_out, tnd_out;
				//if (s_pulse0 == 0 && s_pulse1 == 0)
				//  pulse_out = 0;
				//else pulse_out = 95.88f / ((8128.0f / (s_pulse0 + s_pulse1)) + 100.0f);
				//if (s_tri == 0 && s_noise == 0 && s_dmc == 0)
				//  tnd_out = 0;
				//else tnd_out = 159.79f / (1 / ((s_tri / 8227.0f) + (s_noise / 12241.0f * NOISEADJUST) + (s_dmc / 22638.0f)) + 100);
				//float output = pulse_out + tnd_out;
				//output = output * 2 - 1;
				//this needs to leave enough headroom for straying DC bias due to the DMC unit getting stuck outputs. smb3 is bad about that. 
				//int mix = (int)(20000 * output);


				sampleclock++;
			}
			
		} //class APU


	}

}