src/gb/extra/proxy.c (view raw)
1/* Copyright (c) 2013-2017 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#include <mgba/internal/gb/renderers/proxy.h>
7
8#include <mgba/core/cache-set.h>
9#include <mgba/internal/gb/gb.h>
10#include <mgba/internal/gb/io.h>
11
12#define BUFFER_OAM 1
13#define BUFFER_SGB 2
14
15static void GBVideoProxyRendererInit(struct GBVideoRenderer* renderer, enum GBModel model, bool borders);
16static void GBVideoProxyRendererDeinit(struct GBVideoRenderer* renderer);
17static uint8_t GBVideoProxyRendererWriteVideoRegister(struct GBVideoRenderer* renderer, uint16_t address, uint8_t value);
18static void GBVideoProxyRendererWriteSGBPacket(struct GBVideoRenderer* renderer, uint8_t* data);
19static void GBVideoProxyRendererWriteVRAM(struct GBVideoRenderer* renderer, uint16_t address);
20static void GBVideoProxyRendererWriteOAM(struct GBVideoRenderer* renderer, uint16_t oam);
21static void GBVideoProxyRendererWritePalette(struct GBVideoRenderer* renderer, int address, uint16_t value);
22static void GBVideoProxyRendererDrawRange(struct GBVideoRenderer* renderer, int startX, int endX, int y);
23static void GBVideoProxyRendererFinishScanline(struct GBVideoRenderer* renderer, int y);
24static void GBVideoProxyRendererFinishFrame(struct GBVideoRenderer* renderer);
25static void GBVideoProxyRendererEnableSGBBorder(struct GBVideoRenderer* renderer, bool enable);
26static void GBVideoProxyRendererGetPixels(struct GBVideoRenderer* renderer, size_t* stride, const void** pixels);
27static void GBVideoProxyRendererPutPixels(struct GBVideoRenderer* renderer, size_t stride, const void* pixels);
28
29static bool _parsePacket(struct mVideoLogger* logger, const struct mVideoLoggerDirtyInfo* packet);
30static uint16_t* _vramBlock(struct mVideoLogger* logger, uint32_t address);
31
32void GBVideoProxyRendererCreate(struct GBVideoProxyRenderer* renderer, struct GBVideoRenderer* backend) {
33 renderer->d.init = GBVideoProxyRendererInit;
34 renderer->d.deinit = GBVideoProxyRendererDeinit;
35 renderer->d.writeVideoRegister = GBVideoProxyRendererWriteVideoRegister;
36 renderer->d.writeSGBPacket = GBVideoProxyRendererWriteSGBPacket;
37 renderer->d.writeVRAM = GBVideoProxyRendererWriteVRAM;
38 renderer->d.writeOAM = GBVideoProxyRendererWriteOAM;
39 renderer->d.writePalette = GBVideoProxyRendererWritePalette;
40 renderer->d.drawRange = GBVideoProxyRendererDrawRange;
41 renderer->d.finishScanline = GBVideoProxyRendererFinishScanline;
42 renderer->d.finishFrame = GBVideoProxyRendererFinishFrame;
43 renderer->d.enableSGBBorder = GBVideoProxyRendererEnableSGBBorder;
44 renderer->d.getPixels = GBVideoProxyRendererGetPixels;
45 renderer->d.putPixels = GBVideoProxyRendererPutPixels;
46
47 renderer->d.disableBG = false;
48 renderer->d.disableWIN = false;
49 renderer->d.disableOBJ = false;
50
51 renderer->d.highlightBG = false;
52 renderer->d.highlightWIN = false;
53 int i;
54 for (i = 0; i < GB_VIDEO_MAX_OBJ; ++i) {
55 renderer->d.highlightOBJ[i] = false;
56 }
57 renderer->d.highlightColor = M_COLOR_WHITE;
58 renderer->d.highlightAmount = 0;
59
60 renderer->logger->context = renderer;
61 renderer->logger->parsePacket = _parsePacket;
62 renderer->logger->vramBlock = _vramBlock;
63 renderer->logger->paletteSize = 0;
64 renderer->logger->vramSize = GB_SIZE_VRAM;
65 renderer->logger->oamSize = GB_SIZE_OAM;
66
67 renderer->backend = backend;
68}
69
70static void _init(struct GBVideoProxyRenderer* proxyRenderer) {
71 mVideoLoggerRendererInit(proxyRenderer->logger);
72
73 if (proxyRenderer->logger->block) {
74 proxyRenderer->backend->vram = (uint8_t*) proxyRenderer->logger->vram;
75 proxyRenderer->backend->oam = (union GBOAM*) proxyRenderer->logger->oam;
76 proxyRenderer->backend->cache = NULL;
77 }
78}
79
80static void _reset(struct GBVideoProxyRenderer* proxyRenderer) {
81 memcpy(proxyRenderer->logger->oam, &proxyRenderer->d.oam->raw, GB_SIZE_OAM);
82 memcpy(proxyRenderer->logger->vram, proxyRenderer->d.vram, GB_SIZE_VRAM);
83
84 mVideoLoggerRendererReset(proxyRenderer->logger);
85}
86
87static void _copyExtraState(struct GBVideoProxyRenderer* proxyRenderer) {
88 proxyRenderer->backend->disableBG = proxyRenderer->d.disableBG;
89 proxyRenderer->backend->disableWIN = proxyRenderer->d.disableWIN;
90 proxyRenderer->backend->disableOBJ = proxyRenderer->d.disableOBJ;
91 proxyRenderer->backend->highlightBG = proxyRenderer->d.highlightBG;
92 proxyRenderer->backend->highlightWIN = proxyRenderer->d.highlightWIN;
93 memcpy(proxyRenderer->backend->highlightOBJ, proxyRenderer->d.highlightOBJ, sizeof(proxyRenderer->backend->highlightOBJ));
94 proxyRenderer->backend->highlightAmount = proxyRenderer->d.highlightAmount;
95 proxyRenderer->backend->highlightColor = proxyRenderer->d.highlightColor;
96}
97
98void GBVideoProxyRendererShim(struct GBVideo* video, struct GBVideoProxyRenderer* renderer) {
99 if ((renderer->backend && video->renderer != renderer->backend) || video->renderer == &renderer->d) {
100 return;
101 }
102 renderer->backend = video->renderer;
103 video->renderer = &renderer->d;
104 renderer->d.cache = renderer->backend->cache;
105 renderer->d.vram = video->vram;
106 renderer->d.oam = &video->oam;
107 _init(renderer);
108 _reset(renderer);
109}
110
111void GBVideoProxyRendererUnshim(struct GBVideo* video, struct GBVideoProxyRenderer* renderer) {
112 if (video->renderer != &renderer->d) {
113 return;
114 }
115 renderer->backend->cache = video->renderer->cache;
116 video->renderer = renderer->backend;
117 renderer->backend->vram = video->vram;
118 renderer->backend->oam = &video->oam;
119
120 mVideoLoggerRendererDeinit(renderer->logger);
121}
122
123void GBVideoProxyRendererInit(struct GBVideoRenderer* renderer, enum GBModel model, bool borders) {
124 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
125
126 _init(proxyRenderer);
127
128 proxyRenderer->backend->init(proxyRenderer->backend, model, borders);
129}
130
131void GBVideoProxyRendererDeinit(struct GBVideoRenderer* renderer) {
132 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
133
134 proxyRenderer->backend->deinit(proxyRenderer->backend);
135
136 mVideoLoggerRendererDeinit(proxyRenderer->logger);
137}
138
139static bool _parsePacket(struct mVideoLogger* logger, const struct mVideoLoggerDirtyInfo* item) {
140 struct GBVideoProxyRenderer* proxyRenderer = logger->context;
141 uint8_t sgbPacket[16];
142 struct GBObj legacyBuffer[GB_VIDEO_MAX_OBJ];
143 switch (item->type) {
144 case DIRTY_REGISTER:
145 proxyRenderer->backend->writeVideoRegister(proxyRenderer->backend, item->address, item->value);
146 break;
147 case DIRTY_PALETTE:
148 if (item->address < 64) {
149 proxyRenderer->backend->writePalette(proxyRenderer->backend, item->address, item->value);
150 }
151 break;
152 case DIRTY_OAM:
153 if (item->address < GB_SIZE_OAM) {
154 ((uint8_t*) logger->oam)[item->address] = item->value;
155 proxyRenderer->backend->writeOAM(proxyRenderer->backend, item->address);
156 }
157 break;
158 case DIRTY_VRAM:
159 if (item->address <= GB_SIZE_VRAM - 0x1000) {
160 logger->readData(logger, &logger->vram[item->address >> 1], 0x1000, true);
161 proxyRenderer->backend->writeVRAM(proxyRenderer->backend, item->address);
162 }
163 break;
164 case DIRTY_SCANLINE:
165 _copyExtraState(proxyRenderer);
166 if (item->address < GB_VIDEO_VERTICAL_PIXELS) {
167 proxyRenderer->backend->finishScanline(proxyRenderer->backend, item->address);
168 }
169 break;
170 case DIRTY_RANGE:
171 if (item->value < item->value2 && item->value2 <= GB_VIDEO_HORIZONTAL_PIXELS && item->address < GB_VIDEO_VERTICAL_PIXELS) {
172 proxyRenderer->backend->drawRange(proxyRenderer->backend, item->value, item->value2, item->address);
173 }
174 break;
175 case DIRTY_FRAME:
176 proxyRenderer->backend->finishFrame(proxyRenderer->backend);
177 break;
178 case DIRTY_BUFFER:
179 switch (item->address) {
180 case BUFFER_OAM:
181 if (item->value2 / sizeof(struct GBObj) > GB_VIDEO_MAX_OBJ) {
182 return false;
183 }
184 logger->readData(logger, legacyBuffer, item->value2, true);
185 break;
186 case BUFFER_SGB:
187 logger->readData(logger, sgbPacket, 16, true);
188 proxyRenderer->backend->writeSGBPacket(proxyRenderer->backend, sgbPacket);
189 break;
190 }
191 break;
192 case DIRTY_FLUSH:
193 return false;
194 default:
195 return false;
196 }
197 return true;
198}
199
200static uint16_t* _vramBlock(struct mVideoLogger* logger, uint32_t address) {
201 struct GBVideoProxyRenderer* proxyRenderer = logger->context;
202 return (uint16_t*) &proxyRenderer->d.vram[address];
203}
204
205uint8_t GBVideoProxyRendererWriteVideoRegister(struct GBVideoRenderer* renderer, uint16_t address, uint8_t value) {
206 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
207
208 mVideoLoggerRendererWriteVideoRegister(proxyRenderer->logger, address, value);
209 if (!proxyRenderer->logger->block) {
210 proxyRenderer->backend->writeVideoRegister(proxyRenderer->backend, address, value);
211 }
212 return value;
213}
214
215void GBVideoProxyRendererWriteSGBPacket(struct GBVideoRenderer* renderer, uint8_t* data) {
216 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
217 if (!proxyRenderer->logger->block) {
218 proxyRenderer->backend->writeSGBPacket(proxyRenderer->backend, data);
219 }
220 mVideoLoggerWriteBuffer(proxyRenderer->logger, BUFFER_SGB, 0, 16, data);
221}
222
223void GBVideoProxyRendererWriteVRAM(struct GBVideoRenderer* renderer, uint16_t address) {
224 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
225 mVideoLoggerRendererWriteVRAM(proxyRenderer->logger, address);
226 if (!proxyRenderer->logger->block) {
227 proxyRenderer->backend->writeVRAM(proxyRenderer->backend, address);
228 }
229 if (renderer->cache) {
230 mCacheSetWriteVRAM(renderer->cache, address);
231 }
232}
233
234void GBVideoProxyRendererWritePalette(struct GBVideoRenderer* renderer, int address, uint16_t value) {
235 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
236 mVideoLoggerRendererWritePalette(proxyRenderer->logger, address, value);
237 if (!proxyRenderer->logger->block) {
238 proxyRenderer->backend->writePalette(proxyRenderer->backend, address, value);
239 }
240 if (renderer->cache) {
241 mCacheSetWritePalette(renderer->cache, address, mColorFrom555(value));
242 }
243}
244
245void GBVideoProxyRendererWriteOAM(struct GBVideoRenderer* renderer, uint16_t oam) {
246 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
247 if (!proxyRenderer->logger->block) {
248 proxyRenderer->backend->writeOAM(proxyRenderer->backend, oam);
249 }
250 mVideoLoggerRendererWriteOAM(proxyRenderer->logger, oam, ((uint8_t*) proxyRenderer->d.oam->raw)[oam]);
251}
252
253void GBVideoProxyRendererDrawRange(struct GBVideoRenderer* renderer, int startX, int endX, int y) {
254 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
255 if (!proxyRenderer->logger->block) {
256 _copyExtraState(proxyRenderer);
257 proxyRenderer->backend->drawRange(proxyRenderer->backend, startX, endX, y);
258 }
259 mVideoLoggerRendererDrawRange(proxyRenderer->logger, startX, endX, y);
260}
261
262void GBVideoProxyRendererFinishScanline(struct GBVideoRenderer* renderer, int y) {
263 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
264 if (!proxyRenderer->logger->block) {
265 proxyRenderer->backend->finishScanline(proxyRenderer->backend, y);
266 }
267 mVideoLoggerRendererDrawScanline(proxyRenderer->logger, y);
268 if (proxyRenderer->logger->block && proxyRenderer->logger->wake) {
269 proxyRenderer->logger->wake(proxyRenderer->logger, y);
270 }
271}
272
273void GBVideoProxyRendererFinishFrame(struct GBVideoRenderer* renderer) {
274 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
275 if (!proxyRenderer->logger->block) {
276 proxyRenderer->backend->finishFrame(proxyRenderer->backend);
277 }
278 mVideoLoggerRendererFinishFrame(proxyRenderer->logger);
279 mVideoLoggerRendererFlush(proxyRenderer->logger);
280}
281
282static void GBVideoProxyRendererEnableSGBBorder(struct GBVideoRenderer* renderer, bool enable) {
283 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
284 if (proxyRenderer->logger->block && proxyRenderer->logger->wait) {
285 // Insert an extra item into the queue to make sure it gets flushed
286 mVideoLoggerRendererFlush(proxyRenderer->logger);
287 proxyRenderer->logger->wait(proxyRenderer->logger);
288 }
289 proxyRenderer->backend->enableSGBBorder(proxyRenderer->backend, enable);
290}
291
292static void GBVideoProxyRendererGetPixels(struct GBVideoRenderer* renderer, size_t* stride, const void** pixels) {
293 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
294 if (proxyRenderer->logger->block && proxyRenderer->logger->wait) {
295 proxyRenderer->logger->lock(proxyRenderer->logger);
296 // Insert an extra item into the queue to make sure it gets flushed
297 mVideoLoggerRendererFlush(proxyRenderer->logger);
298 proxyRenderer->logger->postEvent(proxyRenderer->logger, LOGGER_EVENT_GET_PIXELS);
299 mVideoLoggerRendererFlush(proxyRenderer->logger);
300 proxyRenderer->logger->unlock(proxyRenderer->logger);
301 *pixels = proxyRenderer->logger->pixelBuffer;
302 *stride = proxyRenderer->logger->pixelStride;
303 } else {
304 proxyRenderer->backend->getPixels(proxyRenderer->backend, stride, pixels);
305 }
306}
307
308static void GBVideoProxyRendererPutPixels(struct GBVideoRenderer* renderer, size_t stride, const void* pixels) {
309 struct GBVideoProxyRenderer* proxyRenderer = (struct GBVideoProxyRenderer*) renderer;
310 if (proxyRenderer->logger->block && proxyRenderer->logger->wait) {
311 proxyRenderer->logger->lock(proxyRenderer->logger);
312 }
313 proxyRenderer->backend->putPixels(proxyRenderer->backend, stride, pixels);
314 if (proxyRenderer->logger->block && proxyRenderer->logger->wait) {
315 proxyRenderer->logger->unlock(proxyRenderer->logger);
316 }
317}