src/hardware/mame/saa1099.h

// license:BSD-3-Clause
// copyright-holders:Juergen Buchmueller, Manuel Abadia
/**********************************************
    Philips SAA1099 Sound driver
**********************************************/

#ifndef MAME_SOUND_SAA1099_H
#define MAME_SOUND_SAA1099_H

#pragma once

//**************************************************************************
//  INTERFACE CONFIGURATION MACROS
//**************************************************************************

#define MCFG_SAA1099_ADD(_tag, _clock) \
        MCFG_DEVICE_ADD(_tag, SAA1099, _clock)
#define MCFG_SAA1099_REPLACE(_tag, _clock) \
        MCFG_DEVICE_REPLACE(_tag, SAA1099, _clock)


//**************************************************************************
//  TYPE DEFINITIONS
//**************************************************************************

//Container class for int that just initalizes to 0
class NullInt {
    int value;
public:
    operator int& () {
        return value;
    }
    
    int& operator= ( int set ) {
        value = set;
        return value;
    }
    
    NullInt( int set = 0 ) : value( set ) {
    }
};

// ======================> saa1099_device

class saa1099_device : public device_t,
                                                public device_sound_interface
{
public:
        saa1099_device(const machine_config &mconfig, const char *tag, device_t *owner, uint32_t clock);

        DECLARE_WRITE8_MEMBER( control_w );
        DECLARE_WRITE8_MEMBER( data_w );

        DECLARE_WRITE8_MEMBER( write );

//protected:
        // device-level overrides
        virtual void device_start();

        // sound stream update overrides
        virtual void sound_stream_update(sound_stream &stream, stream_sample_t **inputs, stream_sample_t **outputs, int samples);

        void SaveState( std::ostream& stream );
        void LoadState( std::istream& stream );

private:
        struct saa1099_channel
        {
                saa1099_channel() {
                    //Quite hacky, but let's see how it goes
                    memset( this, 0, sizeof( *this ) );
                }

                int frequency    ;   /* frequency (0x00..0xff) */
                int freq_enable  ;   /* frequency enable */
                int noise_enable ;   /* noise enable */
                int octave       ;   /* octave (0x00..0x07) */
                int amplitude[2];       /* amplitude (0x00..0x0f) */
                int envelope[2];        /* envelope (0x00..0x0f or 0x10 == off) */

                /* vars to simulate the square wave */
                double counter ;
                double freq ;
                int level ;
                
        };

        struct saa1099_noise
        {
                saa1099_noise() { 
                    counter = 0;
                    freq = 0;
                    level = 0xFFFFFFFF;
                }

                /* vars to simulate the noise generator output */
                double counter;
                double freq;
                uint32_t level;         /* noise polynomial shifter */
        };

        void envelope_w(int ch);

        sound_stream *m_stream;          /* our stream */
        int m_noise_params[2];            /* noise generators parameters */
        int m_env_enable[2];              /* envelope generators enable */
        int m_env_reverse_right[2];       /* envelope reversed for right channel */
        int m_env_mode[2];                /* envelope generators mode */
        int m_env_bits[2];                /* non zero = 3 bits resolution */
        int m_env_clock[2];               /* envelope clock mode (non-zero external) */
        int m_env_step[2];                /* current envelope step */
        int m_all_ch_enable;              /* all channels enable */
        int m_sync_state;                 /* sync all channels */
        int m_selected_reg;               /* selected register */
        saa1099_channel m_channels[6];    /* channels */
        saa1099_noise m_noise[2];         /* noise generators */
        double m_sample_rate;
        int m_master_clock;
};

DECLARE_DEVICE_TYPE(SAA1099, saa1099_device)

#endif // MAME_SOUND_SAA1099_H