~ubuntu-branches/ubuntu/quantal/vice/quantal

/*

 * sid.h - MOS6581 (SID) emulation, hooks to actual implementation.

 *

 * Written by

 *  Dag Lem <resid@nimrod.no>

 *

 * This file is part of VICE, the Versatile Commodore Emulator.

 * See README for copyright notice.

 *

 *  This program is free software; you can redistribute it and/or modify

 *  it under the terms of the GNU General Public License as published by

 *  the Free Software Foundation; either version 2 of the License, or

 *  (at your option) any later version.

 *

 *  This program is distributed in the hope that it will be useful,

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 *  GNU General Public License for more details.

 *

 *  You should have received a copy of the GNU General Public License

 *  along with this program; if not, write to the Free Software

 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA

 *  02111-1307  USA.

 *

 */

#ifndef VICE_SID_ENGINE_H

#define VICE_SID_ENGINE_H

#include "types.h"

#include "sound.h"

struct sound_s;

struct sid_snapshot_state_s;

#define SID_ENGINE_FASTSID        0

#define SID_ENGINE_RESID          1

#define SID_ENGINE_CATWEASELMKIII 2

#define SID_ENGINE_HARDSID        3

#define SID_ENGINE_PARSID_PORT1   4

#define SID_ENGINE_PARSID_PORT2   5

#define SID_ENGINE_PARSID_PORT3   6

#define SID_ENGINE_RESID_FP       7

#define SID_MODEL_6581           0

#define SID_MODEL_8580           1

#define SID_MODEL_8580D          2

#define SID_MODEL_6581R4         3

#define SID_MODEL_DTVSID         4

#define SID_MODEL_6581R3_4885    8

#define SID_MODEL_6581R3_0486S   9

#define SID_MODEL_6581R3_3984   10

#define SID_MODEL_6581R4AR_3789 11

#define SID_MODEL_6581R3_4485   12

#define SID_MODEL_6581R4_1986S  13

#define SID_MODEL_8580R5_3691   16

#define SID_MODEL_8580R5_3691D  17

#define SID_MODEL_8580R5_1489   18

#define SID_MODEL_8580R5_1489D  19

#define SID_MODEL_DEFAULT       99

extern BYTE REGPARM1 sid_read(WORD address);

extern BYTE REGPARM1 sid2_read(WORD address);

extern void REGPARM2 sid_store(WORD address, BYTE byte);

extern void REGPARM2 sid2_store(WORD address, BYTE byte);

extern void sid_reset(void);

extern void sid_set_machine_parameter(long clock_rate);

extern BYTE *sid_get_siddata(unsigned int channel);

extern int sid_engine_set(int engine);

extern void sid_state_read(unsigned int channel,

                           struct sid_snapshot_state_s *sid_state);

extern void sid_state_write(unsigned int channel,

                            struct sid_snapshot_state_s *sid_state);

struct sid_engine_s {

    struct sound_s *(*open)(BYTE *sidstate);

    int (*init)(struct sound_s *psid, int speed, int cycles_per_sec);

    void (*close)(struct sound_s *psid);

    BYTE (*read)(struct sound_s *psid, WORD addr);

    void (*store)(struct sound_s *psid, WORD addr, BYTE val);

    void (*reset)(struct sound_s *psid, CLOCK cpu_clk);

    int (*calculate_samples)(struct sound_s *psid, SWORD *pbuf, int nr,

                             int interleave, int *delta_t);

    void (*prevent_clk_overflow)(struct sound_s *psid, CLOCK sub);

    char *(*dump_state)(struct sound_s *psid);

    void (*state_read)(struct sound_s *psid,

                       struct sid_snapshot_state_s *sid_state);

    void (*state_write)(struct sound_s *psid,

                        struct sid_snapshot_state_s *sid_state);

};

typedef struct sid_engine_s sid_engine_t;

extern sound_t *sid_sound_machine_open(int chipno);

extern int sid_sound_machine_init(sound_t *psid, int speed, int cycles_per_sec);

extern void sid_sound_machine_close(sound_t *psid);

extern BYTE sid_sound_machine_read(sound_t *psid, WORD addr);

extern void sid_sound_machine_store(sound_t *psid, WORD addr, BYTE byte);

extern void sid_sound_machine_reset(sound_t *psid, CLOCK cpu_clk);

extern int sid_sound_machine_calculate_samples(sound_t *psid, SWORD *pbuf, 

int nr, int interleave, int *delta_t);

extern void sid_sound_machine_prevent_clk_overflow(sound_t *psid, CLOCK sub);

extern char *sid_sound_machine_dump_state(sound_t *psid);

extern int sid_sound_machine_cycle_based(void);

extern int sid_sound_machine_channels(void);

extern void sid_sound_machine_enable(int enable);

#endif