aboutsummaryrefslogtreecommitdiff
path: root/source/snes9x.h
blob: 6dd2e8fe71872fdaa570f46a9f9214ec4336c357 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
#include "../copyright"

#ifndef _SNES9X_H_
#define _SNES9X_H_

#include <stdlib.h>
#include <stdint.h>

#include <libretro.h>

#include "port.h"
#include "65c816.h"

#define ROM_NAME_LEN 23

/* SNES screen width and height */
#define SNES_WIDTH            256
#define SNES_HEIGHT           224
#define SNES_HEIGHT_EXTENDED  239
#define IMAGE_WIDTH           SNES_WIDTH * 2
#define IMAGE_HEIGHT          SNES_HEIGHT_EXTENDED * 2

#define SNES_MAX_NTSC_VCOUNTER  262
#define SNES_MAX_PAL_VCOUNTER   312
#define SNES_HCOUNTER_MAX       341
#define SPC700_TO_65C816_RATIO  2
#define AUTO_FRAMERATE          200

/* NTSC master clock signal 21.47727MHz
 * PPU: master clock / 4
 * 1 / PPU clock * 342 -> 63.695us
 * 63.695us / (1 / 3.579545MHz) -> 228 cycles per scanline
 * From Earth Worm Jim: APU executes an average of 65.14285714 cycles per
 * scanline giving an APU clock speed of 1.022731096MHz                    */

/* PAL master clock signal 21.28137MHz
 * PPU: master clock / 4
 * 1 / PPU clock * 342 -> 64.281us
 * 64.281us / (1 / 3.546895MHz) -> 228 cycles per scanline.  */

#define SNES_SCANLINE_TIME (63.695e-6)
#define SNES_CLOCK_SPEED   (3579545u)

#define SNES_CLOCK_LEN (1.0 / SNES_CLOCK_SPEED)

#define SNES_CYCLES_PER_SCANLINE ((uint32_t) ((SNES_SCANLINE_TIME / SNES_CLOCK_LEN) * 6 + 0.5))

#define ONE_CYCLE        (overclock_cycles ? one_c : 6u)
#define SLOW_ONE_CYCLE   (overclock_cycles ? slow_one_c : 8u)
#define TWO_CYCLES       (overclock_cycles ? two_c : 12u)

#define SNES_TR_MASK     (1u << 4)
#define SNES_TL_MASK     (1u << 5)
#define SNES_X_MASK      (1u << 6)
#define SNES_A_MASK      (1u << 7)
#define SNES_RIGHT_MASK  (1u << 8)
#define SNES_LEFT_MASK   (1u << 9)
#define SNES_DOWN_MASK   (1u << 10)
#define SNES_UP_MASK     (1u << 11)
#define SNES_START_MASK  (1u << 12)
#define SNES_SELECT_MASK (1u << 13)
#define SNES_Y_MASK      (1u << 14)
#define SNES_B_MASK      (1u << 15)

extern bool overclock_cycles;
extern int one_c, slow_one_c, two_c;

enum
{
   SNES_MULTIPLAYER5,
   SNES_JOYPAD,
   SNES_MOUSE,
   SNES_SUPERSCOPE,
   SNES_JUSTIFIER,
   SNES_JUSTIFIER_2,
   SNES_MAX_CONTROLLER_OPTIONS
};

#define DEBUG_MODE_FLAG    (1u << 0)
#define TRACE_FLAG         (1u << 1)
#define SINGLE_STEP_FLAG   (1u << 2)
#define BREAK_FLAG         (1u << 3)
#define SCAN_KEYS_FLAG     (1u << 4)
#define SAVE_SNAPSHOT_FLAG (1u << 5)
#define DELAYED_NMI_FLAG   (1u << 6)
#define NMI_FLAG           (1u << 7)
#define PROCESS_SOUND_FLAG (1u << 8)
#define FRAME_ADVANCE_FLAG (1u << 9)
#define DELAYED_NMI_FLAG2  (1u << 10)
#define IRQ_PENDING_FLAG   (1u << 11)

typedef struct
{
   uint32_t Flags;
   bool     BranchSkip;
   bool     NMIActive;
   uint8_t  IRQActive;
   bool     WaitingForInterrupt;
   bool     InDMA;
   uint8_t  WhichEvent;
   uint8_t* PC;
   uint8_t* PCBase;
   uint8_t* PCAtOpcodeStart;
   uint8_t* WaitAddress;
   uint32_t WaitCounter;
   long     Cycles;       /* For savestate compatibility can't change to int32_t */
   long     NextEvent;    /* For savestate compatibility can't change to int32_t */
   long     V_Counter;    /* For savestate compatibility can't change to int32_t */
   long     MemSpeed;     /* For savestate compatibility can't change to int32_t */
   long     MemSpeedx2;   /* For savestate compatibility can't change to int32_t */
   long     FastROMSpeed; /* For savestate compatibility can't change to int32_t */
   uint32_t SaveStateVersion;
   bool     SRAMModified;
   uint32_t NMITriggerPoint;
   bool     UNUSED2;
   bool     TriedInterleavedMode2;
   uint32_t NMICycleCount;
   uint32_t IRQCycleCount;
} SCPUState;

#define HBLANK_START_EVENT  0u
#define HBLANK_END_EVENT    1u
#define HTIMER_BEFORE_EVENT 2u
#define HTIMER_AFTER_EVENT  3u
#define NO_EVENT            4u

typedef struct
{
   /* CPU options */
   bool     APUEnabled;
   bool     Shutdown;
   int32_t  H_Max;
   int32_t  HBlankStart;
   int32_t  CyclesPercentage;
   bool     DisableIRQ;

   /* Joystick options */
   bool     JoystickEnabled;

   /* ROM timing options (see also H_Max above) */
   bool     ForcePAL;
   bool     ForceNTSC;
   bool     PAL;
   uint32_t FrameTimePAL;
   uint32_t FrameTimeNTSC;
   uint32_t FrameTime;

   /* ROM image options */
   bool     ForceLoROM;
   bool     ForceHiROM;
   bool     ForceHeader;
   bool     ForceNoHeader;
   bool     ForceInterleaved;
   bool     ForceInterleaved2;
   bool     ForceNotInterleaved;

   /* Peripheral options */
   bool     ForceSuperFX;
   bool     ForceNoSuperFX;
   bool     ForceDSP1;
   bool     ForceNoDSP1;
   bool     ForceSA1;
   bool     ForceNoSA1;
   bool     ForceC4;
   bool     ForceNoC4;
   bool     ForceSDD1;
   bool     ForceNoSDD1;
   bool     MultiPlayer5;
   bool     Mouse;
   bool     SuperScope;
   bool     SRTC;
   uint32_t ControllerOption;
   bool     MultiPlayer5Master;
   bool     SuperScopeMaster;
   bool     MouseMaster;

   bool     SuperFX;
   bool     DSP1Master;
   bool     SA1;
   bool     C4;
   bool     SDD1;
   bool     SPC7110;
   bool     SPC7110RTC;
   bool     OBC1;
   uint8_t  DSP;

   /* Sound options */
   uint32_t SoundPlaybackRate;
#ifdef USE_BLARGG_APU
   uint32_t SoundInputRate;
#endif
   bool     TraceSoundDSP;
   bool     EightBitConsoleSound; /* due to caching, this needs S9xSetEightBitConsoleSound() */
   int32_t  SoundBufferSize;
   int32_t  SoundMixInterval;
   bool     SoundEnvelopeHeightReading;
   bool     DisableSoundEcho;
   bool     DisableMasterVolume;
   bool     SoundSync;
   bool     InterpolatedSound;
   bool     ThreadSound;
   bool     Mute;
   bool     NextAPUEnabled;

   /* Others */
   bool     ApplyCheats;

   /* Fixes for individual games */
   bool     StarfoxHack;
   bool     WinterGold;
   bool     BS; /* Japanese Satellite System games. */
   bool     JustifierMaster;
   bool     Justifier;
   bool     SecondJustifier;
   int8_t   SETA;
   bool     HardDisableAudio;
} SSettings;

extern SSettings Settings;
extern SCPUState CPU;
extern char String [513];

#ifdef LAGFIX
extern bool finishedFrame;
#endif

void S9xSetPause(uint32_t mask);
void S9xClearPause(uint32_t mask);
#endif