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

    Galaxian-derived sound hardware

****************************************************************************

Notes:
-----

- There is currently no way to exactly reproduce the CD4066 switch control
  mixing. This is changing impedance of the input resistor for e.g.
  following filters to >> 10M Ohm. These resistors are static values in
  the discrete core.


TODO:
----

- Check more schematics for differences.

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

#include "driver.h"
#include "streams.h"
#include "includes/galaxian.h"

/*************************************
 *
 *  Defines
 *
 *************************************/

#define XTAL					18432000

#define SOUND_CLOCK 			(XTAL/6/2)			/* 1.536 MHz */
#define RNG_RATE				(XTAL/3*2)			/* RNG clock is XTAL/3*2 see Aaron's note in video/galaxian.c */

/* 74LS259 */
#define GAL_INP_BG_DAC			NODE_10		/* at 9M Q4 to Q7 in schematics */

#define GAL_INP_FS1				NODE_20		/* FS1 9L Q0 */
#define GAL_INP_FS2				NODE_21		/* FS2 9L Q1 */
#define GAL_INP_FS3				NODE_22		/* FS3 9L Q2 */
#define GAL_INP_HIT				NODE_23		/* HIT 9L Q3 */
//#define GAL_9L_Q4             NODE_24
#define GAL_INP_FIRE			NODE_25		/* FIRE 9L Q5 */
#define GAL_INP_VOL1			NODE_26		/* VOL1 9L Q6 */
#define GAL_INP_VOL2			NODE_27		/* VOL2 9L Q7 */

#define GAL_INP_PITCH			NODE_28		/* at 6T in schematics */

#define TTL_OUT					(4.0)

#define GAL_R15					RES_K(100)
#define GAL_R16					RES_K(220)
#define GAL_R17					RES_K(470)
#define GAL_R18					RES_K(1000)
#define GAL_R19					RES_K(330)

#define GAL_R20					RES_K(15)
#define GAL_R21					RES_K(100)
#define GAL_R22					RES_K(100)
#define GAL_R23					RES_K(470)
#define GAL_R24					RES_K(10)
#define GAL_R25					RES_K(100)
#define GAL_R26					RES_K(330)
#define GAL_R27					RES_K(10)
#define GAL_R28					RES_K(100)
#define GAL_R29					RES_K(220)

#define GAL_R30					RES_K(10)
#define GAL_R31					RES_K(47)
#define GAL_R32					RES_K(47)
#define GAL_R33					RES_K(10)
/*
 * R34 is given twice on galaxian board and both times as 5.1k. On moon cresta
 * it is only listed once and given as 15k. This is more in line with recordings
 */
#define GAL_R34					RES_K(5.1)
#define MCRST_R34					RES_K(15)

#define GAL_R35					RES_K(150)
#define GAL_R36					RES_K(22)
#define GAL_R37					RES_K(470)
#define GAL_R38					RES_K(33)
#define GAL_R39					RES_K(22)

/* The hit sound is too low compared with recordings
 * There may be an issue with the op-amp band filter
 */
#define GAL_R40					(RES_K(2.2)*0.6)	/* Volume adjust */
#define GAL_R41					RES_K(100)
#define GAL_R43					RES_K(2.2)
#define GAL_R44					RES_K(10)
#define GAL_R45					RES_K(22)
#define GAL_R46					RES_K(10)
#define GAL_R47					RES_K(2.2)
#define GAL_R48					RES_K(2.2)
#define GAL_R49					RES_K(10)

#define GAL_R50					RES_K(22)
#define GAL_R51					RES_K(33)
#define GAL_R52					RES_K(15)

#define GAL_R91					RES_K(10)

#define GAL_C15					CAP_U(1)
#define GAL_C17					CAP_U(0.01)
#define GAL_C18					CAP_U(0.01)
#define GAL_C19					CAP_U(0.01)

#define GAL_C20					CAP_U(0.1)
#define GAL_C21					CAP_U(2.2)
#define GAL_C22					CAP_U(0.01)
#define GAL_C23					CAP_U(0.01)
#define GAL_C25					CAP_U(1)
#define GAL_C26					CAP_U(0.01)
#define GAL_C27					CAP_U(0.01)
#define GAL_C28					CAP_U(47)

#define GAL_C46					CAP_U(0.1)


/*************************************
 *
 *  Structures for discrete core
 *
 *************************************/


static const discrete_dac_r1_ladder galaxian_bck_dac =
{
	4,			// size of ladder
	{GAL_R18, GAL_R17, GAL_R16, GAL_R15, 0,0,0,0},
	4.4,		// 5V - diode junction (0.6V)
	GAL_R20,	// rBIAS
	GAL_R19,	// rGnd
	0			// no C
};

static const discrete_555_cc_desc galaxian_bck_vco =
{
	DISC_555_OUT_DC | DISC_555_OUT_CAP,
	5,		// B+ voltage of 555
	DEFAULT_555_VALUES,
	0.7		// Q2 junction voltage
};

static const discrete_555_desc galaxian_555_vco_desc =
{
	DISC_555_OUT_ENERGY | DISC_555_OUT_DC,
	5.0,
	DEFAULT_555_CHARGE,
	(5.0 - 0.5)			// 10k means no real load
};

static const discrete_555_desc galaxian_555_fire_vco_desc =
{
	DISC_555_OUT_DC,
	5.0,
	DEFAULT_555_CHARGE,
	1.0 // Logic output
};

static const discrete_mixer_desc galaxian_bck_mixer_desc =
{
	DISC_MIXER_IS_RESISTOR,
	{GAL_R24, GAL_R27, GAL_R30},
	{0,0,0},
	{0,0,0,0},  /* no node capacitors */
	0, 0,
	GAL_C20,
	0,
	0, 1
};

static const discrete_lfsr_desc galaxian_lfsr =
{
	DISC_CLK_IS_FREQ,
	17,			          	/* Bit Length */
	0,			          	/* Reset Value */
	4,			          	/* Use Bit 10 (QC of second LS164) as F0 input 0 */
	16,			          	/* Use Bit 23 (QH of third LS164) as F0 input 1 */
	DISC_LFSR_XOR_INV_IN1,	/* F0 is XOR */
	DISC_LFSR_IN0,	  		/* F1 is inverted F0*/
	DISC_LFSR_REPLACE,	  	/* F2 replaces the shifted register contents */
	0x000001,		      	/* Everything is shifted into the first bit only */
	DISC_LFSR_FLAG_OUTPUT_F0, /* Output is result of F0 */
	0			          	/* Output bit */
};

static const discrete_mixer_desc galaxian_mixerpre_desc =
{
	DISC_MIXER_IS_RESISTOR,
	{GAL_R51, 0, GAL_R50, 0, GAL_R34},		/* A, C, C, D */
	{0, GAL_INP_VOL1, 0, GAL_INP_VOL2, 0},
	{0,0,0,0,0},
	0, 0,
	0,
	0,
	0, 1
};

static const discrete_mixer_desc galaxian_mixer_desc =
{
	DISC_MIXER_IS_RESISTOR,
	{GAL_R34, GAL_R40, GAL_R43},		/* A, C, C, D */
	{0, 0, 0},
	{0,0,GAL_C26},
	0, GAL_R91,
	0,
	GAL_C46,
	0, 1
};

/* moon cresta has different mixing */

static const discrete_mixer_desc mooncrst_mixer_desc =
{
	DISC_MIXER_IS_RESISTOR,
	{GAL_R51, 0, GAL_R50, 0, MCRST_R34, GAL_R40, GAL_R43},		/* A, C, C, D */
	{0, GAL_INP_VOL1, 0, GAL_INP_VOL2, 0, 0, 0},
	{0,0,0,0,0,0,GAL_C26},
	0, 0*GAL_R91,
	0,
	GAL_C46,
	0, 1
};

static const discrete_op_amp_filt_info galaxian_bandpass_desc =
{
	GAL_R35, GAL_R36, 0, 0,
	GAL_R37,
	GAL_C22, GAL_C23, 0,
	5.0*GAL_R39/(GAL_R38+GAL_R39),
	5, 0
};

/*************************************
 *
 *  Discrete Sound Blocks
 *
 *************************************/


static DISCRETE_SOUND_START(galaxian)

	/************************************************/
	/* Input register mapping for galaxian          */
	/************************************************/
	DISCRETE_INPUT_DATA(GAL_INP_BG_DAC)

	/* FS1 to FS3 */
	DISCRETE_INPUT_LOGIC(GAL_INP_FS1)
	DISCRETE_INPUT_LOGIC(GAL_INP_FS2)
	DISCRETE_INPUT_LOGIC(GAL_INP_FS3)

	/* HIT */
	DISCRETE_INPUTX_DATA(GAL_INP_HIT, TTL_OUT, 0, 0)

	/* FIRE */
	DISCRETE_INPUT_LOGIC(GAL_INP_FIRE)

	/* Turns on / off resistors in mixer */
	DISCRETE_INPUTX_DATA(GAL_INP_VOL1, GAL_R49, 0, 0)
	DISCRETE_INPUTX_DATA(GAL_INP_VOL2, GAL_R52, 0, 0)

	/* Pitch */
	DISCRETE_INPUT_DATA(GAL_INP_PITCH)

	/* Group Background and pitch */
	DISCRETE_TASK_START()

		/************************************************/
		/* Background                                   */
		/************************************************/

		DISCRETE_DAC_R1(NODE_100, 1, GAL_INP_BG_DAC, TTL_OUT, &galaxian_bck_dac)
		DISCRETE_555_CC(NODE_105, 1, NODE_100, GAL_R21, GAL_C15, 0, 0, 0, &galaxian_bck_vco)
		// Next is mult/add opamp circuit
		DISCRETE_MULTADD(NODE_110, 1, NODE_105, GAL_R33/RES_3_PARALLEL(GAL_R31,GAL_R32,GAL_R33),
				-5.0*GAL_R33/GAL_R31)
		DISCRETE_CLAMP(NODE_111,1,NODE_110,0.0,5.0,0.0)
		// The three 555
		DISCRETE_555_ASTABLE_CV(NODE_115, GAL_INP_FS1, GAL_R22, GAL_R23, GAL_C17, NODE_111, &galaxian_555_vco_desc)
		DISCRETE_555_ASTABLE_CV(NODE_116, GAL_INP_FS2, GAL_R25, GAL_R26, GAL_C18, NODE_111, &galaxian_555_vco_desc)
		DISCRETE_555_ASTABLE_CV(NODE_117, GAL_INP_FS3, GAL_R28, GAL_R29, GAL_C19, NODE_111, &galaxian_555_vco_desc)

		DISCRETE_MIXER3(NODE_120, 1, NODE_115, NODE_116, NODE_117, &galaxian_bck_mixer_desc)

		/************************************************/
		/* PITCH                                        */
		/************************************************/

		/* two cascaded LS164 which are reset to pitch latch value,
         * thus generating SOUND_CLOCK / (256 - pitch_clock) signal
         *
         * One possibility to implement this is
         * DISCRETE_TRANSFORM3(NODE_130, SOUND_CLOCK, 256, GAL_INP_PITCH, "012-/")
         * DISCRETE_COUNTER(NODE_132, 1, 0, NODE_130, 15, DISC_COUNT_UP, 0, DISC_CLK_IS_FREQ)
         * but there is a native choice:
         */
	    DISCRETE_NOTE(NODE_132, 1, SOUND_CLOCK, GAL_INP_PITCH, 255, 15,  DISC_CLK_IS_FREQ)

	    /* from the 74393 (counter 2 above) only QA, QC, QD are used.
         * We decode three here and use SUB_NODE(133,x) below to access.
         */
	    DISCRETE_BITS_DECODE(NODE_133, NODE_132, 0, 3, TTL_OUT)		/* QA-QD 74393 */

    /* End of this task */
    DISCRETE_TASK_END()

    /* Group Hit and Fire */

    DISCRETE_TASK_START()

	    /************************************************/
		/* HIT                                          */
		/************************************************/

	    /* NOISE */
	    /* since only a sample of the LFSR is latched @V2 we let the lfsr
         * run at a lower speed
         */
	    DISCRETE_LFSR_NOISE(NODE_150, 1, 1, RNG_RATE/100, 1.0, 0, 0.5, &galaxian_lfsr)
		DISCRETE_SQUAREWFIX(NODE_151,1,60*264/2,1.0,50,0.5,0)  /* 2V signal */
		DISCRETE_LOGIC_DFLIPFLOP(NODE_152,1,1,1,NODE_151,NODE_150)


		/* Not 100% correct - switching causes high impedance input for node_157
         * this is not emulated */
		DISCRETE_RCDISC5(NODE_155, NODE_152, GAL_INP_HIT, (GAL_R35 + GAL_R36), GAL_C21)
		DISCRETE_OP_AMP_FILTER(NODE_157, 1, NODE_155, 0, DISC_OP_AMP_FILTER_IS_BAND_PASS_1M, &galaxian_bandpass_desc)

		/************************************************/
		/* FIRE                                         */
		/************************************************/

		DISCRETE_LOGIC_INVERT(NODE_170, 1, GAL_INP_FIRE)
		DISCRETE_MULTIPLY(NODE_171, 1, TTL_OUT, GAL_INP_FIRE)
		DISCRETE_MULTIPLY(NODE_172, 1, TTL_OUT, NODE_170) // inverted
		DISCRETE_RCFILTER(NODE_173, 1, NODE_172, GAL_R47, GAL_C28)
		/* Mix noise and 163 */
		DISCRETE_TRANSFORM5(NODE_177, NODE_152, TTL_OUT, 1.0/GAL_R46, NODE_173, 1.0/GAL_R48,
				"01*2*34*+" )
		//DISCRETE_MULTIPLY(NODE_174, 1, TTL_OUT, NODE_152)
		//DISCRETE_MULTIPLY(NODE_175, 1, 1.0/GAL_R46, NODE_174)
		//DISCRETE_MULTIPLY(NODE_176, 1, 1.0/GAL_R48, NODE_173)
		//DISCRETE_ADDER2(NODE_177, 1, NODE_175, NODE_176)
		DISCRETE_MULTIPLY(NODE_178, 1, RES_2_PARALLEL(GAL_R46, GAL_R48), NODE_177)

		DISCRETE_555_ASTABLE_CV(NODE_181, 1, GAL_R44, GAL_R45, GAL_C27, NODE_178, &galaxian_555_fire_vco_desc)

		/* 555 toggles discharge on rc discharge module */
		DISCRETE_RCDISC5(NODE_182, NODE_181, NODE_171, (GAL_R41), GAL_C25)

	/* End of task */
	DISCRETE_TASK_END()

	/************************************************/
	/* FINAL MIX                                    */
	/************************************************/

	DISCRETE_MIXER5(NODE_279, 1, NODE_SUB(133,0), NODE_SUB(133,2), NODE_SUB(133,2), NODE_SUB(133,3), NODE_120, &galaxian_mixerpre_desc)
	DISCRETE_MIXER3(NODE_280, 1, NODE_279, NODE_157, NODE_182, &galaxian_mixer_desc)
	DISCRETE_OUTPUT(NODE_280, 32767.0/5.0*5)

DISCRETE_SOUND_END


static DISCRETE_SOUND_START(mooncrst)
	DISCRETE_IMPORT(galaxian)

	/************************************************/
	/* Moon Cresta mixing stage                     */
	/************************************************/
	DISCRETE_DELETE(NODE_279, NODE_279)
	DISCRETE_REPLACE
	DISCRETE_MIXER7(NODE_280, 1, NODE_SUB(133,0), NODE_SUB(133,2), NODE_SUB(133,2), NODE_SUB(133,3), NODE_120, NODE_157, NODE_182, &mooncrst_mixer_desc)
DISCRETE_SOUND_END

/*************************************
 *
 *  Static Variables
 *
 *************************************/

static UINT8 lfo_val;

static SOUND_START(galaxian)
{
	lfo_val = 0;
}

/*************************************
 *
 *  Write handlers
 *
 *************************************/

/* IC 9J */
WRITE8_DEVICE_HANDLER( galaxian_pitch_w )
{
	discrete_sound_w(device, GAL_INP_PITCH, data );
}

WRITE8_DEVICE_HANDLER( galaxian_lfo_freq_w )
{
	UINT8 lfo_val_new = (lfo_val & ~(1<<offset)) | ((data & 0x01) << offset);

	if (lfo_val != lfo_val_new)
	{
		lfo_val = lfo_val_new;
		discrete_sound_w(device, GAL_INP_BG_DAC, lfo_val);
	}
}

WRITE8_DEVICE_HANDLER( galaxian_background_enable_w )
{
	discrete_sound_w(device, NODE_RELATIVE(GAL_INP_FS1, offset), data & 0x01);
}

WRITE8_DEVICE_HANDLER( galaxian_noise_enable_w )
{
	discrete_sound_w(device, GAL_INP_HIT, data & 0x01);
}

WRITE8_DEVICE_HANDLER( galaxian_vol_w )
{
	discrete_sound_w(device, NODE_RELATIVE(GAL_INP_VOL1,offset), data & 0x01);
}

/* FIXME: rename to fire to be consistent */
WRITE8_DEVICE_HANDLER( galaxian_shoot_enable_w )
{
	discrete_sound_w(device, GAL_INP_FIRE, data & 0x01);
}

/* FIXME: May be replaced by one call! */
WRITE8_DEVICE_HANDLER( galaxian_sound_w )
{
	data &= 0x01;
	switch (offset & 7)
	{
		case 0:		/* FS1 (controls 555 timer at 8R) */
		case 1:		/* FS2 (controls 555 timer at 8S) */
		case 2:		/* FS3 (controls 555 timer at 8T) */
			galaxian_background_enable_w(device, offset, data);
			break;

		case 3:		/* HIT */
			galaxian_noise_enable_w(device, 0, data);
			break;

		case 4:		/* n/c */
			break;

		case 5:		/* FIRE */
			galaxian_shoot_enable_w(device, 0, data);
			break;

		case 6:		/* VOL1 */
		case 7:		/* VOL2 */
			galaxian_vol_w(device, offset & 1, data);
			break;
	}
}

/*************************************
 *
 *  Driver definitions
 *
 *************************************/

MACHINE_DRIVER_START( galaxian_audio )

	MDRV_SOUND_START(galaxian)

	MDRV_SOUND_ADD(GAL_AUDIO, DISCRETE, 0)
	MDRV_SOUND_CONFIG_DISCRETE(galaxian)

	MDRV_SOUND_ROUTE(ALL_OUTPUTS, "mono", 1.0)
MACHINE_DRIVER_END

MACHINE_DRIVER_START( mooncrst_audio )

	MDRV_SOUND_START(galaxian)

	MDRV_SOUND_ADD(GAL_AUDIO, DISCRETE, 0)
	MDRV_SOUND_CONFIG_DISCRETE(mooncrst)

	MDRV_SOUND_ROUTE(ALL_OUTPUTS, "mono", 1.0)
MACHINE_DRIVER_END
