diff src/console/Spc_Dsp.h @ 1037:c31e94fefd2a trunk

[svn] - upstream updates regarding handling of SPC700 instructions and runtime length issues.

--- a/src/console/Spc_Dsp.h	Sat May 12 17:06:13 2007 -0700
+++ b/src/console/Spc_Dsp.h	Tue May 15 13:18:35 2007 -0700
@@ -1,152 +1,218 @@
-// Super Nintendo (SNES) SPC DSP emulator
+// Fast SNES SPC-700 DSP emulator (about 3x speed of accurate one)
 
-// Game_Music_Emu 0.5.2
+// snes_spc 0.9.0
 #ifndef SPC_DSP_H
 #define SPC_DSP_H
 
 #include "blargg_common.h"
 
 class Spc_Dsp {
-	typedef BOOST::int8_t int8_t;
+public:
 	typedef BOOST::uint8_t uint8_t;
-public:
+	
+// Setup
+	
+	// Initializes DSP and has it use the 64K RAM provided
+	void init( void* ram_64k );
+
+	// Sets destination for output samples. If out is NULL or out_size is 0,
+	// doesn't generate any.
+	typedef short sample_t;
+	void set_output( sample_t* out, int out_size );
+
+	// Number of samples written to output since it was last set, always
+	// a multiple of 2. Undefined if more samples were generated than
+	// output buffer could hold.
+	int sample_count() const;
+
+// Emulation
 	
-	// Keeps pointer to 64K ram
-	Spc_Dsp( uint8_t* ram );
+	// Resets DSP to power-on state
+	void reset();
+
+	// Emulates pressing reset switch on SNES
+	void soft_reset();
 	
-	// Mute voice n if bit n (1 << n) of mask is clear.
+	// Reads/writes DSP registers. For accuracy, you must first call spc_run_dsp()
+	// to catch the DSP up to present.
+	int  read ( int addr ) const;
+	void write( int addr, int data );
+
+	// Runs DSP for specified number of clocks (~1024000 per second). Every 32 clocks
+	// a pair of samples is be generated.
+	void run( int clock_count );
+
+// Sound control
+
+	// Mutes voices corresponding to non-zero bits in mask (overrides VxVOL with 0).
+	// Reduces emulation accuracy.
 	enum { voice_count = 8 };
 	void mute_voices( int mask );
-	
-	// Clear state and silence everything.
-	void reset();
-	
-	// Set gain, where 1.0 is normal. When greater than 1.0, output is clamped to
-	// the 16-bit sample range.
-	void set_gain( double );
+
+	// If true, prevents channels and global volumes from being phase-negated
+	void disable_surround( bool disable = true );
 	
-	// If true, prevent channels and global volumes from being phase-negated
-	void disable_surround( bool disable );
+	enum { gain_unit = 0x100 };
+	void set_gain( int gain );
 	
-	// Read/write register 'n', where n ranges from 0 to register_count - 1.
-	enum { register_count = 128 };
-	int  read ( int n );
-	void write( int n, int );
+// State
 	
-	// Run DSP for 'count' samples. Write resulting samples to 'buf' if not NULL.
-	void run( long count, short* buf = NULL );
-	
-	
-// End of public interface
-private:
+	// Resets DSP and uses supplied values to initialize registers
+	enum { register_count = 128 };
+	void load( uint8_t const regs [register_count] );
+
+// DSP register addresses
+
+	// Global registers
+	enum {
+	    r_mvoll = 0x0C, r_mvolr = 0x1C,
+	    r_evoll = 0x2C, r_evolr = 0x3C,
+	    r_kon   = 0x4C, r_koff  = 0x5C,
+	    r_flg   = 0x6C, r_endx  = 0x7C,
+	    r_efb   = 0x0D, r_pmon  = 0x2D,
+	    r_non   = 0x3D, r_eon   = 0x4D,
+	    r_dir   = 0x5D, r_esa   = 0x6D,
+	    r_edl   = 0x7D,
+	    r_fir   = 0x0F // 8 coefficients at 0x0F, 0x1F ... 0x7F
+	};
+
+	// Voice registers
+	enum {
+		v_voll   = 0x00, v_volr   = 0x01,
+		v_pitchl = 0x02, v_pitchh = 0x03,
+		v_srcn   = 0x04, v_adsr0  = 0x05,
+		v_adsr1  = 0x06, v_gain   = 0x07,
+		v_envx   = 0x08, v_outx   = 0x09
+	};
+
+public:
+	enum { extra_size = 16 };
+	sample_t* extra()               { return m.extra; }
+	sample_t const* out_pos() const { return m.out; }
+public:
+	BLARGG_DISABLE_NOTHROW
 	
-	struct raw_voice_t {
-		int8_t  left_vol;
-		int8_t  right_vol;
-		uint8_t rate [2];
-		uint8_t waveform;
-		uint8_t adsr [2];   // envelope rates for attack, decay, and sustain
-		uint8_t gain;       // envelope gain (if not using ADSR)
-		int8_t  envx;       // current envelope level
-		int8_t  outx;       // current sample
-		int8_t  unused [6];
-	};
+	typedef BOOST::int8_t   int8_t;
+	typedef BOOST::int16_t int16_t;
+	
+	enum { echo_hist_size = 8 };
 	
-	struct globals_t {
-		int8_t  unused1 [12];
-		int8_t  left_volume;        // 0C   Main Volume Left (-.7)
-		int8_t  echo_feedback;      // 0D   Echo Feedback (-.7)
-		int8_t  unused2 [14];
-		int8_t  right_volume;       // 1C   Main Volume Right (-.7)
-		int8_t  unused3 [15];
-		int8_t  left_echo_volume;   // 2C   Echo Volume Left (-.7)
-		uint8_t pitch_mods;         // 2D   Pitch Modulation on/off for each voice
-		int8_t  unused4 [14];
-		int8_t  right_echo_volume;  // 3C   Echo Volume Right (-.7)
-		uint8_t noise_enables;      // 3D   Noise output on/off for each voice
-		int8_t  unused5 [14];
-		uint8_t key_ons;            // 4C   Key On for each voice
-		uint8_t echo_ons;           // 4D   Echo on/off for each voice
-		int8_t  unused6 [14];
-		uint8_t key_offs;           // 5C   key off for each voice (instantiates release mode)
-		uint8_t wave_page;          // 5D   source directory (wave table offsets)
-		int8_t  unused7 [14];
-		uint8_t flags;              // 6C   flags and noise freq
-		uint8_t echo_page;          // 6D
-		int8_t  unused8 [14];
-		uint8_t wave_ended;         // 7C
-		uint8_t echo_delay;         // 7D   ms >> 4
-		char    unused9 [2];
+	enum env_mode_t { env_release, env_attack, env_decay, env_sustain };
+	enum { brr_buf_size = 12 };
+	struct voice_t
+	{
+		int buf [brr_buf_size*2];// decoded samples (twice the size to simplify wrap handling)
+		int* buf_pos;           // place in buffer where next samples will be decoded
+		int interp_pos;         // relative fractional position in sample (0x1000 = 1.0)
+		int brr_addr;           // address of current BRR block
+		int brr_offset;         // current decoding offset in BRR block
+		int kon_delay;          // KON delay/current setup phase
+		env_mode_t env_mode;
+		int env;                // current envelope level
+		int hidden_env;         // used by GAIN mode 7, very obscure quirk
+		int volume [2];         // copy of volume from DSP registers, with surround disabled
+		int enabled;            // -1 if enabled, 0 if muted
 	};
-	
-	union {
-		raw_voice_t voice [voice_count];
-		uint8_t reg [register_count];
-		globals_t g;
+private:
+	struct state_t
+	{
+		uint8_t regs [register_count];
+		
+		// Echo history keeps most recent 8 samples (twice the size to simplify wrap handling)
+		int echo_hist [echo_hist_size * 2] [2];
+		int (*echo_hist_pos) [2]; // &echo_hist [0 to 7]
+		
+		int every_other_sample; // toggles every sample
+		int kon;                // KON value when last checked
+		int noise;
+		int echo_offset;        // offset from ESA in echo buffer
+		int echo_length;        // number of bytes that echo_offset will stop at
+		int phase;              // next clock cycle to run (0-31)
+		unsigned counters [4];
+		
+		int new_kon;
+		int t_koff;
+		
+		voice_t voices [voice_count];
+		
+		unsigned* counter_select [32];
+		
+		// non-emulation state
+		uint8_t* ram; // 64K shared RAM between DSP and SMP
+		int mute_mask;
+		int gain;
+		int surround_threshold;
+		sample_t* out;
+		sample_t* out_end;
+		sample_t* out_begin;
+		sample_t extra [extra_size];
 	};
-	
-	uint8_t* const ram;
-	
-	// Cache of echo FIR values for faster access
-	short fir_coeff [voice_count];
-	
-	// fir_buf [i + 8] == fir_buf [i], to avoid wrap checking in FIR code
-	short fir_buf [16] [2];
-	int fir_offset; // (0 to 7)
+	state_t m;
 	
-	enum { emu_gain_bits = 8 };
-	int emu_gain;
-	
-	int keyed_on; // 8-bits for 8 voices
-	int keys;
-	
-	int echo_ptr;
-	int noise_amp;
-	int noise;
-	int noise_count;
-	
-	int surround_threshold;
-	
-	static BOOST::int16_t const gauss [];
-	
-	enum state_t {
-		state_attack,
-		state_decay,
-		state_sustain,
-		state_release
-	};
-	
-	struct voice_t {
-		short volume [2];
-		short fraction;// 12-bit fractional position
-		short interp3; // most recent four decoded samples
-		short interp2;
-		short interp1;
-		short interp0;
-		short block_remain; // number of nybbles remaining in current block
-		unsigned short addr;
-		short block_header; // header byte from current block
-		short envcnt;
-		short envx;
-		short on_cnt;
-		short enabled; // 7 if enabled, 31 if disabled
-		short envstate;
-		short unused; // pad to power of 2
-	};
-	
-	voice_t voice_state [voice_count];
-	
-	int clock_envelope( int );
+	void init_counter();
+	void run_counter( int );
+	void soft_reset_common();
+	void write_outline( int addr, int data );
+	void update_voice_vol( int addr );
 };
 
-inline void Spc_Dsp::disable_surround( bool disable ) { surround_threshold = disable ? 0 : -0x7FFF; }
+#include <assert.h>
+
+inline int Spc_Dsp::sample_count() const { return m.out - m.out_begin; }
 
-inline void Spc_Dsp::set_gain( double v ) { emu_gain = (int) (v * (1 << emu_gain_bits)); }
+inline int Spc_Dsp::read( int addr ) const
+{
+	assert( (unsigned) addr < register_count );
+	return m.regs [addr];
+}
 
-inline int Spc_Dsp::read( int i )
+inline void Spc_Dsp::update_voice_vol( int addr )
 {
-	assert( (unsigned) i < register_count );
-	return reg [i];
+	int l = (int8_t) m.regs [addr + v_voll];
+	int r = (int8_t) m.regs [addr + v_volr];
+	
+	if ( l * r < m.surround_threshold )
+	{
+		// signs differ, so negate those that are negative
+		l ^= l >> 7;
+		r ^= r >> 7;
+	}
+	
+	voice_t& v = m.voices [addr >> 4];
+	int enabled = v.enabled;
+	v.volume [0] = l & enabled;
+	v.volume [1] = r & enabled;
 }
 
+inline void Spc_Dsp::write( int addr, int data )
+{
+	assert( (unsigned) addr < register_count );
+	
+	m.regs [addr] = (uint8_t) data;
+	int low = addr & 0x0F;
+	if ( low < 0x2 ) // voice volumes
+	{
+		update_voice_vol( low ^ addr );
+	}
+	else if ( low == 0xC )
+	{
+		if ( addr == r_kon )
+			m.new_kon = (uint8_t) data;
+		
+		if ( addr == r_endx ) // always cleared, regardless of data written
+			m.regs [r_endx] = 0;
+	}
+}
+
+inline void Spc_Dsp::set_gain( int gain ) { m.gain = gain; }
+
+inline void Spc_Dsp::disable_surround( bool disable )
+{
+	m.surround_threshold = disable ? 0 : -0x4000;
+}
+
+#define SPC_NO_COPY_STATE_FUNCS 1
+
+#define SPC_LESS_ACCURATE 1
+
 #endif