1/* Copyright (c) 2013-2016 Jeffrey Pfau
  2 *
  3 * This Source Code Form is subject to the terms of the Mozilla Public
  4 * License, v. 2.0. If a copy of the MPL was not distributed with this
  5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
  6#ifndef M_CORE_H
  7#define M_CORE_H
  8
  9#include <mgba-util/common.h>
 10
 11CXX_GUARD_START
 12
 13#include <mgba/core/config.h>
 14#if !defined(MINIMAL_CORE) || MINIMAL_CORE < 2
 15#include <mgba/core/directories.h>
 16#endif
 17#ifndef MINIMAL_CORE
 18#include <mgba/core/input.h>
 19#endif
 20#include <mgba/core/interface.h>
 21#ifdef USE_DEBUGGERS
 22// TODO: Fix layering violation
 23#include <mgba/internal/debugger/debugger.h>
 24#endif
 25
 26enum mPlatform {
 27	PLATFORM_NONE = -1,
 28#ifdef M_CORE_GBA
 29	PLATFORM_GBA = 0,
 30#endif
 31#ifdef M_CORE_GB
 32	PLATFORM_GB = 1,
 33#endif
 34};
 35
 36enum mCoreChecksumType {
 37	CHECKSUM_CRC32,
 38};
 39
 40struct mCoreConfig;
 41struct mCoreSync;
 42struct mDebuggerSymbols;
 43struct mStateExtdata;
 44struct mVideoLogContext;
 45struct mCore {
 46	void* cpu;
 47	void* board;
 48	struct mDebugger* debugger;
 49	struct mDebuggerSymbols* symbolTable;
 50
 51#if !defined(MINIMAL_CORE) || MINIMAL_CORE < 2
 52	struct mDirectorySet dirs;
 53#endif
 54#ifndef MINIMAL_CORE
 55	struct mInputMap inputMap;
 56#endif
 57	struct mCoreConfig config;
 58	struct mCoreOptions opts;
 59
 60	struct mRTCGenericSource rtc;
 61
 62	bool (*init)(struct mCore*);
 63	void (*deinit)(struct mCore*);
 64
 65	enum mPlatform (*platform)(const struct mCore*);
 66
 67	void (*setSync)(struct mCore*, struct mCoreSync*);
 68	void (*loadConfig)(struct mCore*, const struct mCoreConfig*);
 69
 70	void (*desiredVideoDimensions)(struct mCore*, unsigned* width, unsigned* height);
 71	void (*setVideoBuffer)(struct mCore*, color_t* buffer, size_t stride);
 72
 73	void (*getPixels)(struct mCore*, const void** buffer, size_t* stride);
 74	void (*putPixels)(struct mCore*, const void* buffer, size_t stride);
 75
 76	struct blip_t* (*getAudioChannel)(struct mCore*, int ch);
 77	void (*setAudioBufferSize)(struct mCore*, size_t samples);
 78	size_t (*getAudioBufferSize)(struct mCore*);
 79
 80	void (*addCoreCallbacks)(struct mCore*, struct mCoreCallbacks*);
 81	void (*clearCoreCallbacks)(struct mCore*);
 82	void (*setAVStream)(struct mCore*, struct mAVStream*);
 83
 84	bool (*isROM)(struct VFile* vf);
 85	bool (*loadROM)(struct mCore*, struct VFile* vf);
 86	bool (*loadSave)(struct mCore*, struct VFile* vf);
 87	bool (*loadTemporarySave)(struct mCore*, struct VFile* vf);
 88	void (*unloadROM)(struct mCore*);
 89	void (*checksum)(const struct mCore*, void* data, enum mCoreChecksumType type);
 90
 91	bool (*loadBIOS)(struct mCore*, struct VFile* vf, int biosID);
 92	bool (*selectBIOS)(struct mCore*, int biosID);
 93
 94	bool (*loadPatch)(struct mCore*, struct VFile* vf);
 95
 96	void (*reset)(struct mCore*);
 97	void (*runFrame)(struct mCore*);
 98	void (*runLoop)(struct mCore*);
 99	void (*step)(struct mCore*);
100
101	size_t (*stateSize)(struct mCore*);
102	bool (*loadState)(struct mCore*, const void* state);
103	bool (*saveState)(struct mCore*, void* state);
104
105	void (*setKeys)(struct mCore*, uint32_t keys);
106	void (*addKeys)(struct mCore*, uint32_t keys);
107	void (*clearKeys)(struct mCore*, uint32_t keys);
108
109	int32_t (*frameCounter)(const struct mCore*);
110	int32_t (*frameCycles)(const struct mCore*);
111	int32_t (*frequency)(const struct mCore*);
112
113	void (*getGameTitle)(const struct mCore*, char* title);
114	void (*getGameCode)(const struct mCore*, char* title);
115
116	void (*setPeripheral)(struct mCore*, int type, void*);
117
118	uint32_t (*busRead8)(struct mCore*, uint32_t address);
119	uint32_t (*busRead16)(struct mCore*, uint32_t address);
120	uint32_t (*busRead32)(struct mCore*, uint32_t address);
121
122	void (*busWrite8)(struct mCore*, uint32_t address, uint8_t);
123	void (*busWrite16)(struct mCore*, uint32_t address, uint16_t);
124	void (*busWrite32)(struct mCore*, uint32_t address, uint32_t);
125
126	uint32_t (*rawRead8)(struct mCore*, uint32_t address, int segment);
127	uint32_t (*rawRead16)(struct mCore*, uint32_t address, int segment);
128	uint32_t (*rawRead32)(struct mCore*, uint32_t address, int segment);
129
130	void (*rawWrite8)(struct mCore*, uint32_t address, int segment, uint8_t);
131	void (*rawWrite16)(struct mCore*, uint32_t address, int segment, uint16_t);
132	void (*rawWrite32)(struct mCore*, uint32_t address, int segment, uint32_t);
133
134	size_t (*listMemoryBlocks)(const struct mCore*, const struct mCoreMemoryBlock**);
135	void* (*getMemoryBlock)(struct mCore*, size_t id, size_t* sizeOut);
136
137#ifdef USE_DEBUGGERS
138	bool (*supportsDebuggerType)(struct mCore*, enum mDebuggerType);
139	struct mDebuggerPlatform* (*debuggerPlatform)(struct mCore*);
140	struct CLIDebuggerSystem* (*cliDebuggerSystem)(struct mCore*);
141	void (*attachDebugger)(struct mCore*, struct mDebugger*);
142	void (*detachDebugger)(struct mCore*);
143
144	void (*loadSymbols)(struct mCore*, struct VFile*);
145#endif
146
147	struct mCheatDevice* (*cheatDevice)(struct mCore*);
148
149	size_t (*savedataClone)(struct mCore*, void** sram);
150	bool (*savedataRestore)(struct mCore*, const void* sram, size_t size, bool writeback);
151
152	size_t (*listVideoLayers)(const struct mCore*, const struct mCoreChannelInfo**);
153	size_t (*listAudioChannels)(const struct mCore*, const struct mCoreChannelInfo**);
154	void (*enableVideoLayer)(struct mCore*, size_t id, bool enable);
155	void (*enableAudioChannel)(struct mCore*, size_t id, bool enable);
156
157#ifndef MINIMAL_CORE
158	void (*startVideoLog)(struct mCore*, struct mVideoLogContext*);
159	void (*endVideoLog)(struct mCore*);
160#endif
161};
162
163#if !defined(MINIMAL_CORE) || MINIMAL_CORE < 2
164struct mCore* mCoreFind(const char* path);
165bool mCoreLoadFile(struct mCore* core, const char* path);
166
167bool mCorePreloadVF(struct mCore* core, struct VFile* vf);
168bool mCorePreloadFile(struct mCore* core, const char* path);
169
170bool mCoreAutoloadSave(struct mCore* core);
171bool mCoreAutoloadPatch(struct mCore* core);
172
173bool mCoreSaveState(struct mCore* core, int slot, int flags);
174bool mCoreLoadState(struct mCore* core, int slot, int flags);
175struct VFile* mCoreGetState(struct mCore* core, int slot, bool write);
176void mCoreDeleteState(struct mCore* core, int slot);
177
178void mCoreTakeScreenshot(struct mCore* core);
179#endif
180
181struct mCore* mCoreFindVF(struct VFile* vf);
182enum mPlatform mCoreIsCompatible(struct VFile* vf);
183
184bool mCoreSaveStateNamed(struct mCore* core, struct VFile* vf, int flags);
185bool mCoreLoadStateNamed(struct mCore* core, struct VFile* vf, int flags);
186
187void mCoreInitConfig(struct mCore* core, const char* port);
188void mCoreLoadConfig(struct mCore* core);
189void mCoreLoadForeignConfig(struct mCore* core, const struct mCoreConfig* config);
190
191void mCoreSetRTC(struct mCore* core, struct mRTCSource* rtc);
192
193CXX_GUARD_END
194
195#endif