src/platform/libretro/libretro.c (view raw)
1/* Copyright (c) 2013-2015 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 "libretro.h"
7
8#include "util/common.h"
9
10#include "gba/cheats.h"
11#include "gba/renderers/video-software.h"
12#include "gba/serialize.h"
13#include "gba/context/context.h"
14#include "util/circle-buffer.h"
15#include "util/memory.h"
16#include "util/vfs.h"
17
18#define SAMPLES 1024
19#define RUMBLE_PWM 35
20
21#define SOLAR_SENSOR_LEVEL "mgba_solar_sensor_level"
22
23static retro_environment_t environCallback;
24static retro_video_refresh_t videoCallback;
25static retro_audio_sample_batch_t audioCallback;
26static retro_input_poll_t inputPollCallback;
27static retro_input_state_t inputCallback;
28static retro_log_printf_t logCallback;
29static retro_set_rumble_state_t rumbleCallback;
30
31static void GBARetroLog(struct GBAThread* thread, enum GBALogLevel level, const char* format, va_list args);
32
33static void _postAudioBuffer(struct GBAAVStream*, struct GBAAudio* audio);
34static void _setRumble(struct GBARumble* rumble, int enable);
35static uint8_t _readLux(struct GBALuminanceSource* lux);
36static void _updateLux(struct GBALuminanceSource* lux);
37
38static struct GBAContext context;
39static struct GBAVideoSoftwareRenderer renderer;
40static void* data;
41static size_t dataSize;
42static void* savedata;
43static struct GBAAVStream stream;
44static int rumbleLevel;
45static struct CircleBuffer rumbleHistory;
46static struct GBARumble rumble;
47static struct GBALuminanceSource lux;
48static int luxLevel;
49static struct GBACheatDevice cheats;
50static struct GBACheatSet cheatSet;
51
52unsigned retro_api_version(void) {
53 return RETRO_API_VERSION;
54}
55
56void retro_set_environment(retro_environment_t env) {
57 environCallback = env;
58
59 struct retro_variable vars[] = {
60 { SOLAR_SENSOR_LEVEL, "Solar sensor level; 0|1|2|3|4|5|6|7|8|9|10" },
61 { 0, 0 }
62 };
63
64 environCallback(RETRO_ENVIRONMENT_SET_VARIABLES, vars);
65}
66
67void retro_set_video_refresh(retro_video_refresh_t video) {
68 videoCallback = video;
69}
70
71void retro_set_audio_sample(retro_audio_sample_t audio) {
72 UNUSED(audio);
73}
74
75void retro_set_audio_sample_batch(retro_audio_sample_batch_t audioBatch) {
76 audioCallback = audioBatch;
77}
78
79void retro_set_input_poll(retro_input_poll_t inputPoll) {
80 inputPollCallback = inputPoll;
81}
82
83void retro_set_input_state(retro_input_state_t input) {
84 inputCallback = input;
85}
86
87void retro_get_system_info(struct retro_system_info* info) {
88 info->need_fullpath = false;
89 info->valid_extensions = "gba";
90 info->library_version = projectVersion;
91 info->library_name = projectName;
92 info->block_extract = false;
93}
94
95void retro_get_system_av_info(struct retro_system_av_info* info) {
96 info->geometry.base_width = VIDEO_HORIZONTAL_PIXELS;
97 info->geometry.base_height = VIDEO_VERTICAL_PIXELS;
98 info->geometry.max_width = VIDEO_HORIZONTAL_PIXELS;
99 info->geometry.max_height = VIDEO_VERTICAL_PIXELS;
100 info->timing.fps = GBA_ARM7TDMI_FREQUENCY / (float) VIDEO_TOTAL_LENGTH;
101 info->timing.sample_rate = 32768;
102}
103
104void retro_init(void) {
105 enum retro_pixel_format fmt;
106#ifdef COLOR_16_BIT
107#ifdef COLOR_5_6_5
108 fmt = RETRO_PIXEL_FORMAT_RGB565;
109#else
110#warning This pixel format is unsupported. Please use -DCOLOR_16-BIT -DCOLOR_5_6_5
111 fmt = RETRO_PIXEL_FORMAT_0RGB1555;
112#endif
113#else
114#warning This pixel format is unsupported. Please use -DCOLOR_16-BIT -DCOLOR_5_6_5
115 fmt = RETRO_PIXEL_FORMAT_XRGB8888;
116#endif
117 environCallback(RETRO_ENVIRONMENT_SET_PIXEL_FORMAT, &fmt);
118
119 struct retro_input_descriptor inputDescriptors[] = {
120 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_A, "A" },
121 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_B, "B" },
122 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_SELECT, "Select" },
123 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_START, "Start" },
124 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_RIGHT, "Right" },
125 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_LEFT, "Left" },
126 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_UP, "Up" },
127 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_DOWN, "Down" },
128 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_R, "R" },
129 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_L, "L" },
130 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_R3, "Brighten Solar Sensor" },
131 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_L3, "Darken Solar Sensor" }
132 };
133 environCallback(RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS, &inputDescriptors);
134
135 // TODO: RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME when BIOS booting is supported
136
137 struct retro_rumble_interface rumbleInterface;
138 if (environCallback(RETRO_ENVIRONMENT_GET_RUMBLE_INTERFACE, &rumbleInterface)) {
139 rumbleCallback = rumbleInterface.set_rumble_state;
140 CircleBufferInit(&rumbleHistory, RUMBLE_PWM);
141 rumble.setRumble = _setRumble;
142 } else {
143 rumbleCallback = 0;
144 }
145
146 luxLevel = 0;
147 lux.readLuminance = _readLux;
148 lux.sample = _updateLux;
149 _updateLux(&lux);
150
151 struct retro_log_callback log;
152 if (environCallback(RETRO_ENVIRONMENT_GET_LOG_INTERFACE, &log)) {
153 logCallback = log.log;
154 } else {
155 logCallback = 0;
156 }
157
158 stream.postAudioFrame = 0;
159 stream.postAudioBuffer = _postAudioBuffer;
160 stream.postVideoFrame = 0;
161
162 GBAContextInit(&context, 0);
163 struct GBAOptions opts = {
164 .useBios = true,
165 .idleOptimization = IDLE_LOOP_REMOVE
166 };
167 GBAConfigLoadDefaults(&context.config, &opts);
168 context.gba->logHandler = GBARetroLog;
169 context.gba->stream = &stream;
170 if (rumbleCallback) {
171 context.gba->rumble = &rumble;
172 }
173 context.gba->luminanceSource = &lux;
174
175 const char* sysDir = 0;
176 if (environCallback(RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY, &sysDir)) {
177 char biosPath[PATH_MAX];
178 snprintf(biosPath, sizeof(biosPath), "%s%s%s", sysDir, PATH_SEP, "gba_bios.bin");
179 struct VFile* bios = VFileOpen(biosPath, O_RDONLY);
180 if (bios) {
181 GBAContextLoadBIOSFromVFile(&context, bios);
182 }
183 }
184
185 GBAVideoSoftwareRendererCreate(&renderer);
186 renderer.outputBuffer = malloc(256 * VIDEO_VERTICAL_PIXELS * BYTES_PER_PIXEL);
187 renderer.outputBufferStride = 256;
188 context.renderer = &renderer.d;
189
190 GBAAudioResizeBuffer(&context.gba->audio, SAMPLES);
191
192#if RESAMPLE_LIBRARY == RESAMPLE_BLIP_BUF
193 blip_set_rates(context.gba->audio.left, GBA_ARM7TDMI_FREQUENCY, 32768);
194 blip_set_rates(context.gba->audio.right, GBA_ARM7TDMI_FREQUENCY, 32768);
195#endif
196
197 GBACheatDeviceCreate(&cheats);
198 GBACheatSetInit(&cheatSet, "libretro");
199 GBACheatAddSet(&cheats, &cheatSet);
200 GBACheatAttachDevice(context.gba, &cheats);
201}
202
203void retro_deinit(void) {
204 GBAContextDeinit(&context);
205 GBACheatRemoveSet(&cheats, &cheatSet);
206 GBACheatDeviceDestroy(&cheats);
207 GBACheatSetDeinit(&cheatSet);
208 free(renderer.outputBuffer);
209}
210
211void retro_run(void) {
212 uint16_t keys;
213 inputPollCallback();
214
215 keys = 0;
216 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_A)) << 0;
217 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_B)) << 1;
218 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_SELECT)) << 2;
219 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_START)) << 3;
220 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_RIGHT)) << 4;
221 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_LEFT)) << 5;
222 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_UP)) << 6;
223 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_DOWN)) << 7;
224 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_R)) << 8;
225 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_L)) << 9;
226
227 static bool wasAdjustingLux = false;
228 if (wasAdjustingLux) {
229 wasAdjustingLux = inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_R3) ||
230 inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_L3);
231 } else {
232 if (inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_R3)) {
233 ++luxLevel;
234 if (luxLevel > 10) {
235 luxLevel = 10;
236 }
237 wasAdjustingLux = true;
238 } else if (inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_L3)) {
239 --luxLevel;
240 if (luxLevel < 0) {
241 luxLevel = 0;
242 }
243 wasAdjustingLux = true;
244 }
245 }
246
247 GBAContextFrame(&context, keys);
248 videoCallback(renderer.outputBuffer, VIDEO_HORIZONTAL_PIXELS, VIDEO_VERTICAL_PIXELS, BYTES_PER_PIXEL * renderer.outputBufferStride);
249}
250
251void retro_reset(void) {
252 ARMReset(context.cpu);
253
254 if (rumbleCallback) {
255 CircleBufferClear(&rumbleHistory);
256 }
257}
258
259bool retro_load_game(const struct retro_game_info* game) {
260 struct VFile* rom;
261 if (game->data) {
262 data = anonymousMemoryMap(game->size);
263 dataSize = game->size;
264 memcpy(data, game->data, game->size);
265 rom = VFileFromMemory(data, game->size);
266 } else {
267 data = 0;
268 rom = VFileOpen(game->path, O_RDONLY);
269 }
270 if (!rom) {
271 return false;
272 }
273 if (!GBAIsROM(rom)) {
274 rom->close(rom);
275 mappedMemoryFree(data, game->size);
276 return false;
277 }
278
279 savedata = anonymousMemoryMap(SIZE_CART_FLASH1M);
280 struct VFile* save = VFileFromMemory(savedata, SIZE_CART_FLASH1M);
281
282 GBAContextLoadROMFromVFile(&context, rom, save);
283 GBAContextStart(&context);
284 return true;
285}
286
287void retro_unload_game(void) {
288 GBAContextStop(&context);
289 mappedMemoryFree(data, dataSize);
290 data = 0;
291 mappedMemoryFree(savedata, SIZE_CART_FLASH1M);
292 savedata = 0;
293 CircleBufferDeinit(&rumbleHistory);
294}
295
296size_t retro_serialize_size(void) {
297 return sizeof(struct GBASerializedState);
298}
299
300bool retro_serialize(void* data, size_t size) {
301 if (size != retro_serialize_size()) {
302 return false;
303 }
304 GBASerialize(context.gba, data);
305 return true;
306}
307
308bool retro_unserialize(const void* data, size_t size) {
309 if (size != retro_serialize_size()) {
310 return false;
311 }
312 GBADeserialize(context.gba, data);
313 return true;
314}
315
316void retro_cheat_reset(void) {
317 GBACheatSetDeinit(&cheatSet);
318 GBACheatSetInit(&cheatSet, "libretro");
319}
320
321void retro_cheat_set(unsigned index, bool enabled, const char* code) {
322 UNUSED(index);
323 UNUSED(enabled);
324 GBACheatAddLine(&cheatSet, code);
325}
326
327unsigned retro_get_region(void) {
328 return RETRO_REGION_NTSC; // TODO: This isn't strictly true
329}
330
331void retro_set_controller_port_device(unsigned port, unsigned device) {
332 UNUSED(port);
333 UNUSED(device);
334}
335
336bool retro_load_game_special(unsigned game_type, const struct retro_game_info* info, size_t num_info) {
337 UNUSED(game_type);
338 UNUSED(info);
339 UNUSED(num_info);
340 return false;
341}
342
343void* retro_get_memory_data(unsigned id) {
344 if (id != RETRO_MEMORY_SAVE_RAM) {
345 return 0;
346 }
347 return savedata;
348}
349
350size_t retro_get_memory_size(unsigned id) {
351 if (id != RETRO_MEMORY_SAVE_RAM) {
352 return 0;
353 }
354 switch (context.gba->memory.savedata.type) {
355 case SAVEDATA_AUTODETECT:
356 case SAVEDATA_FLASH1M:
357 return SIZE_CART_FLASH1M;
358 case SAVEDATA_FLASH512:
359 return SIZE_CART_FLASH512;
360 case SAVEDATA_EEPROM:
361 return SIZE_CART_EEPROM;
362 case SAVEDATA_SRAM:
363 return SIZE_CART_SRAM;
364 case SAVEDATA_FORCE_NONE:
365 return 0;
366 }
367 return 0;
368}
369
370void GBARetroLog(struct GBAThread* thread, enum GBALogLevel level, const char* format, va_list args) {
371 UNUSED(thread);
372 if (!logCallback) {
373 return;
374 }
375
376 char message[128];
377 vsnprintf(message, sizeof(message), format, args);
378
379 enum retro_log_level retroLevel = RETRO_LOG_INFO;
380 switch (level) {
381 case GBA_LOG_ALL:
382 case GBA_LOG_ERROR:
383 case GBA_LOG_FATAL:
384 retroLevel = RETRO_LOG_ERROR;
385 break;
386 case GBA_LOG_WARN:
387 retroLevel = RETRO_LOG_WARN;
388 break;
389 case GBA_LOG_INFO:
390 case GBA_LOG_GAME_ERROR:
391 case GBA_LOG_SWI:
392 case GBA_LOG_STATUS:
393 retroLevel = RETRO_LOG_INFO;
394 break;
395 case GBA_LOG_DEBUG:
396 case GBA_LOG_STUB:
397 case GBA_LOG_SIO:
398 retroLevel = RETRO_LOG_DEBUG;
399 break;
400 }
401 logCallback(retroLevel, "%s\n", message);
402}
403
404static void _postAudioBuffer(struct GBAAVStream* stream, struct GBAAudio* audio) {
405 UNUSED(stream);
406 int16_t samples[SAMPLES * 2];
407#if RESAMPLE_LIBRARY == RESAMPLE_BLIP_BUF
408 blip_read_samples(audio->left, samples, SAMPLES, true);
409 blip_read_samples(audio->right, samples + 1, SAMPLES, true);
410#else
411 int16_t samplesR[SAMPLES];
412 GBAAudioCopy(audio, &samples[SAMPLES], samplesR, SAMPLES);
413 size_t i;
414 for (i = 0; i < SAMPLES; ++i) {
415 samples[i * 2] = samples[SAMPLES + i];
416 samples[i * 2 + 1] = samplesR[i];
417 }
418#endif
419 audioCallback(samples, SAMPLES);
420}
421
422static void _setRumble(struct GBARumble* rumble, int enable) {
423 UNUSED(rumble);
424 if (!rumbleCallback) {
425 return;
426 }
427 rumbleLevel += enable;
428 if (CircleBufferSize(&rumbleHistory) == RUMBLE_PWM) {
429 int8_t oldLevel;
430 CircleBufferRead8(&rumbleHistory, &oldLevel);
431 rumbleLevel -= oldLevel;
432 }
433 CircleBufferWrite8(&rumbleHistory, enable);
434 rumbleCallback(0, RETRO_RUMBLE_STRONG, rumbleLevel * 0xFFFF / RUMBLE_PWM);
435 rumbleCallback(0, RETRO_RUMBLE_WEAK, rumbleLevel * 0xFFFF / RUMBLE_PWM);
436}
437
438static void _updateLux(struct GBALuminanceSource* lux) {
439 UNUSED(lux);
440 struct retro_variable var = {
441 .key = SOLAR_SENSOR_LEVEL,
442 .value = 0
443 };
444
445 bool updated = false;
446 if (!environCallback(RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE, &updated) || !updated) {
447 return;
448 }
449 if (!environCallback(RETRO_ENVIRONMENT_GET_VARIABLE, &var) || !var.value) {
450 return;
451 }
452
453 char* end;
454 int newLuxLevel = strtol(var.value, &end, 10);
455 if (!*end) {
456 if (newLuxLevel > 10) {
457 luxLevel = 10;
458 } else if (newLuxLevel < 0) {
459 luxLevel = 0;
460 } else {
461 luxLevel = newLuxLevel;
462 }
463 }
464}
465
466static uint8_t _readLux(struct GBALuminanceSource* lux) {
467 UNUSED(lux);
468 int value = 0x16;
469 if (luxLevel > 0) {
470 value += GBA_LUX_LEVELS[luxLevel - 1];
471 }
472 return 0xFF - value;
473}