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,
 30#endif
 31#ifdef M_CORE_GB
 32	PLATFORM_GB,
 33#endif
 34#ifdef M_CORE_DS
 35	PLATFORM_DS,
 36#endif
 37};
 38
 39enum mCoreChecksumType {
 40	CHECKSUM_CRC32,
 41};
 42
 43struct mRTCSource;
 44struct mCoreConfig;
 45struct mCoreSync;
 46struct mStateExtdata;
 47struct mCore {
 48	void* cpu;
 49	void* board;
 50	struct mDebugger* debugger;
 51
 52#if !defined(MINIMAL_CORE) || MINIMAL_CORE < 2
 53	struct mDirectorySet dirs;
 54#endif
 55#ifndef MINIMAL_CORE
 56	struct mInputMap inputMap;
 57#endif
 58	struct mCoreConfig config;
 59	struct mCoreOptions opts;
 60
 61	bool (*init)(struct mCore*);
 62	void (*deinit)(struct mCore*);
 63
 64	enum mPlatform (*platform)(const struct mCore*);
 65
 66	void (*setSync)(struct mCore*, struct mCoreSync*);
 67	void (*loadConfig)(struct mCore*, const struct mCoreConfig*);
 68
 69	void (*desiredVideoDimensions)(struct mCore*, unsigned* width, unsigned* height);
 70	void (*setVideoBuffer)(struct mCore*, color_t* buffer, size_t stride);
 71
 72	void (*getPixels)(struct mCore*, const void** buffer, size_t* stride);
 73	void (*putPixels)(struct mCore*, const void* buffer, size_t stride);
 74
 75	struct blip_t* (*getAudioChannel)(struct mCore*, int ch);
 76	void (*setAudioBufferSize)(struct mCore*, size_t samples);
 77	size_t (*getAudioBufferSize)(struct mCore*);
 78
 79	void (*setCoreCallbacks)(struct mCore*, struct mCoreCallbacks*);
 80	void (*setAVStream)(struct mCore*, struct mAVStream*);
 81
 82	bool (*isROM)(struct VFile* vf);
 83	bool (*loadROM)(struct mCore*, struct VFile* vf);
 84	bool (*loadSave)(struct mCore*, struct VFile* vf);
 85	bool (*loadTemporarySave)(struct mCore*, struct VFile* vf);
 86	void (*unloadROM)(struct mCore*);
 87	void (*checksum)(const struct mCore*, void* data, enum mCoreChecksumType type);
 88
 89	bool (*loadBIOS)(struct mCore*, struct VFile* vf, int biosID);
 90	bool (*selectBIOS)(struct mCore*, int biosID);
 91
 92	bool (*loadPatch)(struct mCore*, struct VFile* vf);
 93
 94	void (*reset)(struct mCore*);
 95	void (*runFrame)(struct mCore*);
 96	void (*runLoop)(struct mCore*);
 97	void (*step)(struct mCore*);
 98
 99	size_t (*stateSize)(struct mCore*);
100	bool (*loadState)(struct mCore*, const void* state);
101	bool (*saveState)(struct mCore*, void* state);
102
103	void (*setKeys)(struct mCore*, uint32_t keys);
104	void (*addKeys)(struct mCore*, uint32_t keys);
105	void (*clearKeys)(struct mCore*, uint32_t keys);
106
107	int32_t (*frameCounter)(const struct mCore*);
108	int32_t (*frameCycles)(const struct mCore*);
109	int32_t (*frequency)(const struct mCore*);
110
111	void (*getGameTitle)(const struct mCore*, char* title);
112	void (*getGameCode)(const struct mCore*, char* title);
113
114	void (*setRTC)(struct mCore*, struct mRTCSource*);
115	void (*setRotation)(struct mCore*, struct mRotationSource*);
116	void (*setRumble)(struct mCore*, struct mRumble*);
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#ifdef USE_DEBUGGERS
135	bool (*supportsDebuggerType)(struct mCore*, enum mDebuggerType);
136	struct mDebuggerPlatform* (*debuggerPlatform)(struct mCore*);
137	struct CLIDebuggerSystem* (*cliDebuggerSystem)(struct mCore*);
138	void (*attachDebugger)(struct mCore*, struct mDebugger*);
139	void (*detachDebugger)(struct mCore*);
140#endif
141
142	struct mCheatDevice* (*cheatDevice)(struct mCore*);
143
144	size_t (*savedataClone)(struct mCore*, void** sram);
145	bool (*savedataRestore)(struct mCore*, const void* sram, size_t size, bool writeback);
146};
147
148#if !defined(MINIMAL_CORE) || MINIMAL_CORE < 2
149struct mCore* mCoreFind(const char* path);
150bool mCoreLoadFile(struct mCore* core, const char* path);
151
152bool mCoreAutoloadSave(struct mCore* core);
153bool mCoreAutoloadPatch(struct mCore* core);
154
155bool mCoreSaveState(struct mCore* core, int slot, int flags);
156bool mCoreLoadState(struct mCore* core, int slot, int flags);
157struct VFile* mCoreGetState(struct mCore* core, int slot, bool write);
158void mCoreDeleteState(struct mCore* core, int slot);
159
160void mCoreTakeScreenshot(struct mCore* core);
161#endif
162
163struct mCore* mCoreFindVF(struct VFile* vf);
164enum mPlatform mCoreIsCompatible(struct VFile* vf);
165
166bool mCoreSaveStateNamed(struct mCore* core, struct VFile* vf, int flags);
167bool mCoreLoadStateNamed(struct mCore* core, struct VFile* vf, int flags);
168
169void mCoreInitConfig(struct mCore* core, const char* port);
170void mCoreLoadConfig(struct mCore* core);
171void mCoreLoadForeignConfig(struct mCore* core, const struct mCoreConfig* config);
172
173CXX_GUARD_END
174
175#endif