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 "core/core.h"
11#include "core/version.h"
12#ifdef M_CORE_GB
13#include "gb/core.h"
14#include "gb/gb.h"
15#endif
16#ifdef M_CORE_GBA
17#include "gba/cheats.h"
18#include "gba/core.h"
19#include "gba/serialize.h"
20#endif
21#include "util/circle-buffer.h"
22#include "util/memory.h"
23#include "util/vfs.h"
24
25#define SAMPLES 1024
26#define RUMBLE_PWM 35
27
28static retro_environment_t environCallback;
29static retro_video_refresh_t videoCallback;
30static retro_audio_sample_batch_t audioCallback;
31static retro_input_poll_t inputPollCallback;
32static retro_input_state_t inputCallback;
33static retro_log_printf_t logCallback;
34static retro_set_rumble_state_t rumbleCallback;
35
36static void GBARetroLog(struct mLogger* logger, int category, enum mLogLevel level, const char* format, va_list args);
37
38static void _postAudioBuffer(struct mAVStream*, blip_t* left, blip_t* right);
39static void _setRumble(struct mRumble* rumble, int enable);
40static uint8_t _readLux(struct GBALuminanceSource* lux);
41static void _updateLux(struct GBALuminanceSource* lux);
42
43static struct mCore* core;
44static void* outputBuffer;
45static void* data;
46static size_t dataSize;
47static void* savedata;
48static struct mAVStream stream;
49static int rumbleLevel;
50static struct CircleBuffer rumbleHistory;
51static struct mRumble rumble;
52static struct GBALuminanceSource lux;
53static int luxLevel;
54static struct GBACheatDevice cheats;
55static struct GBACheatSet cheatSet;
56static struct mLogger logger;
57
58static void _reloadSettings(void) {
59 struct mCoreOptions opts = {
60 .useBios = true,
61 .volume = 0x100,
62 };
63
64 struct retro_variable var;
65
66 var.key = "mgba_use_bios";
67 var.value = 0;
68 if (environCallback(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value) {
69 opts.useBios = strcmp(var.value, "ON") == 0;
70 }
71
72 var.key = "mgba_skip_bios";
73 var.value = 0;
74 if (environCallback(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value) {
75 opts.skipBios = strcmp(var.value, "ON") == 0;
76 }
77
78 var.key = "mgba_idle_optimization";
79 var.value = 0;
80 if (environCallback(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value) {
81 if (strcmp(var.value, "Don't Remove") == 0) {
82 mCoreConfigSetDefaultValue(&core->config, "idleOptimization", "ignore");
83 } else if (strcmp(var.value, "Remove Known") == 0) {
84 mCoreConfigSetDefaultValue(&core->config, "idleOptimization", "remove");
85 } else if (strcmp(var.value, "Detect and Remove") == 0) {
86 mCoreConfigSetDefaultValue(&core->config, "idleOptimization", "detect");
87 }
88 }
89
90 mCoreConfigLoadDefaults(&core->config, &opts);
91 mCoreLoadConfig(core);
92}
93
94unsigned retro_api_version(void) {
95 return RETRO_API_VERSION;
96}
97
98void retro_set_environment(retro_environment_t env) {
99 environCallback = env;
100
101 struct retro_variable vars[] = {
102 { "mgba_solar_sensor_level", "Solar sensor level; 0|1|2|3|4|5|6|7|8|9|10" },
103 { "mgba_allow_opposing_directions", "Allow opposing directional input; OFF|ON" },
104 { "mgba_use_bios", "Use BIOS file if found; ON|OFF" },
105 { "mgba_skip_bios", "Skip BIOS intro; OFF|ON" },
106 { "mgba_idle_optimization", "Idle loop removal; Remove Known|Detect and Remove|Don't Remove" },
107 { 0, 0 }
108 };
109
110 environCallback(RETRO_ENVIRONMENT_SET_VARIABLES, vars);
111}
112
113void retro_set_video_refresh(retro_video_refresh_t video) {
114 videoCallback = video;
115}
116
117void retro_set_audio_sample(retro_audio_sample_t audio) {
118 UNUSED(audio);
119}
120
121void retro_set_audio_sample_batch(retro_audio_sample_batch_t audioBatch) {
122 audioCallback = audioBatch;
123}
124
125void retro_set_input_poll(retro_input_poll_t inputPoll) {
126 inputPollCallback = inputPoll;
127}
128
129void retro_set_input_state(retro_input_state_t input) {
130 inputCallback = input;
131}
132
133void retro_get_system_info(struct retro_system_info* info) {
134 info->need_fullpath = false;
135 info->valid_extensions = "gba|gb|gbc";
136 info->library_version = projectVersion;
137 info->library_name = projectName;
138 info->block_extract = false;
139}
140
141void retro_get_system_av_info(struct retro_system_av_info* info) {
142 unsigned width, height;
143 core->desiredVideoDimensions(core, &width, &height);
144 info->geometry.base_width = width;
145 info->geometry.base_height = height;
146 info->geometry.max_width = width;
147 info->geometry.max_height = height;
148 info->geometry.aspect_ratio = width / (double) height;
149 info->timing.fps = GBA_ARM7TDMI_FREQUENCY / (float) VIDEO_TOTAL_LENGTH;
150 info->timing.sample_rate = 32768;
151}
152
153void retro_init(void) {
154 enum retro_pixel_format fmt;
155#ifdef COLOR_16_BIT
156#ifdef COLOR_5_6_5
157 fmt = RETRO_PIXEL_FORMAT_RGB565;
158#else
159#warning This pixel format is unsupported. Please use -DCOLOR_16-BIT -DCOLOR_5_6_5
160 fmt = RETRO_PIXEL_FORMAT_0RGB1555;
161#endif
162#else
163#warning This pixel format is unsupported. Please use -DCOLOR_16-BIT -DCOLOR_5_6_5
164 fmt = RETRO_PIXEL_FORMAT_XRGB8888;
165#endif
166 environCallback(RETRO_ENVIRONMENT_SET_PIXEL_FORMAT, &fmt);
167
168 struct retro_input_descriptor inputDescriptors[] = {
169 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_A, "A" },
170 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_B, "B" },
171 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_SELECT, "Select" },
172 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_START, "Start" },
173 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_RIGHT, "Right" },
174 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_LEFT, "Left" },
175 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_UP, "Up" },
176 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_DOWN, "Down" },
177 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_R, "R" },
178 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_L, "L" },
179 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_R3, "Brighten Solar Sensor" },
180 { 0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_L3, "Darken Solar Sensor" }
181 };
182 environCallback(RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS, &inputDescriptors);
183
184 // TODO: RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME when BIOS booting is supported
185
186 struct retro_rumble_interface rumbleInterface;
187 if (environCallback(RETRO_ENVIRONMENT_GET_RUMBLE_INTERFACE, &rumbleInterface)) {
188 rumbleCallback = rumbleInterface.set_rumble_state;
189 CircleBufferInit(&rumbleHistory, RUMBLE_PWM);
190 rumble.setRumble = _setRumble;
191 } else {
192 rumbleCallback = 0;
193 }
194
195 luxLevel = 0;
196 lux.readLuminance = _readLux;
197 lux.sample = _updateLux;
198 _updateLux(&lux);
199
200 struct retro_log_callback log;
201 if (environCallback(RETRO_ENVIRONMENT_GET_LOG_INTERFACE, &log)) {
202 logCallback = log.log;
203 } else {
204 logCallback = 0;
205 }
206 logger.log = GBARetroLog;
207 mLogSetDefaultLogger(&logger);
208
209 stream.videoDimensionsChanged = 0;
210 stream.postAudioFrame = 0;
211 stream.postAudioBuffer = _postAudioBuffer;
212 stream.postVideoFrame = 0;
213}
214
215void retro_deinit(void) {
216 GBACheatRemoveSet(&cheats, &cheatSet);
217 GBACheatDeviceDestroy(&cheats);
218 GBACheatSetDeinit(&cheatSet);
219 free(outputBuffer);
220}
221
222void retro_run(void) {
223 uint16_t keys;
224 inputPollCallback();
225
226 struct retro_variable var = {
227 .key = "mgba_allow_opposing_directions",
228 .value = 0
229 };
230
231 bool updated = false;
232 if (environCallback(RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE, &updated) && updated) {
233 if (environCallback(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value) {
234 ((struct GBA*) core->board)->allowOpposingDirections = strcmp(var.value, "yes") == 0;
235 }
236 }
237
238 keys = 0;
239 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_A)) << 0;
240 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_B)) << 1;
241 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_SELECT)) << 2;
242 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_START)) << 3;
243 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_RIGHT)) << 4;
244 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_LEFT)) << 5;
245 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_UP)) << 6;
246 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_DOWN)) << 7;
247 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_R)) << 8;
248 keys |= (!!inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_L)) << 9;
249 core->setKeys(core, keys);
250
251 static bool wasAdjustingLux = false;
252 if (wasAdjustingLux) {
253 wasAdjustingLux = inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_R3) ||
254 inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_L3);
255 } else {
256 if (inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_R3)) {
257 ++luxLevel;
258 if (luxLevel > 10) {
259 luxLevel = 10;
260 }
261 wasAdjustingLux = true;
262 } else if (inputCallback(0, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_L3)) {
263 --luxLevel;
264 if (luxLevel < 0) {
265 luxLevel = 0;
266 }
267 wasAdjustingLux = true;
268 }
269 }
270
271 core->runFrame(core);
272 unsigned width, height;
273 core->desiredVideoDimensions(core, &width, &height);
274 videoCallback(outputBuffer, width, height, BYTES_PER_PIXEL * 256);
275}
276
277void retro_reset(void) {
278 core->reset(core);
279
280 if (rumbleCallback) {
281 CircleBufferClear(&rumbleHistory);
282 }
283}
284
285bool retro_load_game(const struct retro_game_info* game) {
286 struct VFile* rom;
287 if (game->data) {
288 data = anonymousMemoryMap(game->size);
289 dataSize = game->size;
290 memcpy(data, game->data, game->size);
291 rom = VFileFromMemory(data, game->size);
292 } else {
293 data = 0;
294 rom = VFileOpen(game->path, O_RDONLY);
295 }
296 if (!rom) {
297 return false;
298 }
299
300 core = NULL;
301#ifdef M_CORE_GBA
302 if (!core && GBAIsROM(rom)) {
303 core = GBACoreCreate();
304 }
305#endif
306#ifdef M_CORE_GB
307 if (!core && GBIsROM(rom)) {
308 core = GBCoreCreate();
309 }
310#endif
311 if (!core) {
312 rom->close(rom);
313 mappedMemoryFree(data, game->size);
314 return false;
315 }
316 mCoreInitConfig(core, NULL);
317 core->init(core);
318 core->setAVStream(core, &stream);
319
320 outputBuffer = malloc(256 * VIDEO_VERTICAL_PIXELS * BYTES_PER_PIXEL);
321 core->setVideoBuffer(core, outputBuffer, 256);
322
323 core->setAudioBufferSize(core, SAMPLES);
324
325 blip_set_rates(core->getAudioChannel(core, 0), core->frequency(core), 32768);
326 blip_set_rates(core->getAudioChannel(core, 1), core->frequency(core), 32768);
327
328 core->setRumble(core, &rumble);
329
330#ifdef M_CORE_GBA
331 if (core->platform(core) == PLATFORM_GBA) {
332 struct GBA* gba = core->board;
333 gba->luminanceSource = &lux;
334
335 const char* sysDir = 0;
336 if (environCallback(RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY, &sysDir)) {
337 char biosPath[PATH_MAX];
338 snprintf(biosPath, sizeof(biosPath), "%s%s%s", sysDir, PATH_SEP, "gba_bios.bin");
339 struct VFile* bios = VFileOpen(biosPath, O_RDONLY);
340 if (bios) {
341 core->loadBIOS(core, bios, 0);
342 }
343 }
344
345 GBACheatDeviceCreate(&cheats);
346 GBACheatAttachDevice(gba, &cheats);
347 GBACheatSetInit(&cheatSet, "libretro");
348 GBACheatAddSet(&cheats, &cheatSet);
349 }
350#endif
351
352 savedata = anonymousMemoryMap(SIZE_CART_FLASH1M);
353 struct VFile* save = VFileFromMemory(savedata, SIZE_CART_FLASH1M);
354
355 _reloadSettings();
356 core->loadROM(core, rom);
357 core->loadSave(core, save);
358 core->reset(core);
359 return true;
360}
361
362void retro_unload_game(void) {
363 core->deinit(core);
364 mappedMemoryFree(data, dataSize);
365 data = 0;
366 mappedMemoryFree(savedata, SIZE_CART_FLASH1M);
367 savedata = 0;
368 CircleBufferDeinit(&rumbleHistory);
369}
370
371size_t retro_serialize_size(void) {
372 return sizeof(struct GBASerializedState);
373}
374
375bool retro_serialize(void* data, size_t size) {
376 if (size != retro_serialize_size()) {
377 return false;
378 }
379 GBASerialize(core->board, data);
380 return true;
381}
382
383bool retro_unserialize(const void* data, size_t size) {
384 if (size != retro_serialize_size()) {
385 return false;
386 }
387 GBADeserialize(core->board, data);
388 return true;
389}
390
391void retro_cheat_reset(void) {
392 GBACheatSetDeinit(&cheatSet);
393 GBACheatSetInit(&cheatSet, "libretro");
394}
395
396void retro_cheat_set(unsigned index, bool enabled, const char* code) {
397 UNUSED(index);
398 UNUSED(enabled);
399 // Convert the super wonky unportable libretro format to something normal
400 char realCode[] = "XXXXXXXX XXXXXXXX";
401 size_t len = strlen(code) + 1; // Include null terminator
402 size_t i, pos;
403 for (i = 0, pos = 0; i < len; ++i) {
404 if (isspace((int) code[i]) || code[i] == '+') {
405 realCode[pos] = ' ';
406 } else {
407 realCode[pos] = code[i];
408 }
409 if ((pos == 13 && (realCode[pos] == ' ' || !realCode[pos])) || pos == 17) {
410 realCode[pos] = '\0';
411 GBACheatAddLine(&cheatSet, realCode);
412 pos = 0;
413 continue;
414 }
415 ++pos;
416 }
417}
418
419unsigned retro_get_region(void) {
420 return RETRO_REGION_NTSC; // TODO: This isn't strictly true
421}
422
423void retro_set_controller_port_device(unsigned port, unsigned device) {
424 UNUSED(port);
425 UNUSED(device);
426}
427
428bool retro_load_game_special(unsigned game_type, const struct retro_game_info* info, size_t num_info) {
429 UNUSED(game_type);
430 UNUSED(info);
431 UNUSED(num_info);
432 return false;
433}
434
435void* retro_get_memory_data(unsigned id) {
436 if (id != RETRO_MEMORY_SAVE_RAM) {
437 return 0;
438 }
439 return savedata;
440}
441
442size_t retro_get_memory_size(unsigned id) {
443 if (id != RETRO_MEMORY_SAVE_RAM) {
444 return 0;
445 }
446 switch (((struct GBA*) core->board)->memory.savedata.type) {
447 case SAVEDATA_AUTODETECT:
448 case SAVEDATA_FLASH1M:
449 return SIZE_CART_FLASH1M;
450 case SAVEDATA_FLASH512:
451 return SIZE_CART_FLASH512;
452 case SAVEDATA_EEPROM:
453 return SIZE_CART_EEPROM;
454 case SAVEDATA_SRAM:
455 return SIZE_CART_SRAM;
456 case SAVEDATA_FORCE_NONE:
457 return 0;
458 }
459 return 0;
460}
461
462void GBARetroLog(struct mLogger* logger, int category, enum mLogLevel level, const char* format, va_list args) {
463 UNUSED(logger);
464 if (!logCallback) {
465 return;
466 }
467
468 char message[128];
469 vsnprintf(message, sizeof(message), format, args);
470
471 enum retro_log_level retroLevel = RETRO_LOG_INFO;
472 switch (level) {
473 case mLOG_ERROR:
474 case mLOG_FATAL:
475 retroLevel = RETRO_LOG_ERROR;
476 break;
477 case mLOG_WARN:
478 retroLevel = RETRO_LOG_WARN;
479 break;
480 case mLOG_INFO:
481 case mLOG_GAME_ERROR:
482 retroLevel = RETRO_LOG_INFO;
483 break;
484 case mLOG_DEBUG:
485 case mLOG_STUB:
486 retroLevel = RETRO_LOG_DEBUG;
487 break;
488 }
489 logCallback(retroLevel, "%s: %s\n", mLogCategoryName(category), message);
490}
491
492static void _postAudioBuffer(struct mAVStream* stream, blip_t* left, blip_t* right) {
493 UNUSED(stream);
494 int16_t samples[SAMPLES * 2];
495 blip_read_samples(left, samples, SAMPLES, true);
496 blip_read_samples(right, samples + 1, SAMPLES, true);
497 audioCallback(samples, SAMPLES);
498}
499
500static void _setRumble(struct mRumble* rumble, int enable) {
501 UNUSED(rumble);
502 if (!rumbleCallback) {
503 return;
504 }
505 rumbleLevel += enable;
506 if (CircleBufferSize(&rumbleHistory) == RUMBLE_PWM) {
507 int8_t oldLevel;
508 CircleBufferRead8(&rumbleHistory, &oldLevel);
509 rumbleLevel -= oldLevel;
510 }
511 CircleBufferWrite8(&rumbleHistory, enable);
512 rumbleCallback(0, RETRO_RUMBLE_STRONG, rumbleLevel * 0xFFFF / RUMBLE_PWM);
513 rumbleCallback(0, RETRO_RUMBLE_WEAK, rumbleLevel * 0xFFFF / RUMBLE_PWM);
514}
515
516static void _updateLux(struct GBALuminanceSource* lux) {
517 UNUSED(lux);
518 struct retro_variable var = {
519 .key = "mgba_solar_sensor_level",
520 .value = 0
521 };
522
523 bool updated = false;
524 if (!environCallback(RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE, &updated) || !updated) {
525 return;
526 }
527 if (!environCallback(RETRO_ENVIRONMENT_GET_VARIABLE, &var) || !var.value) {
528 return;
529 }
530
531 char* end;
532 int newLuxLevel = strtol(var.value, &end, 10);
533 if (!*end) {
534 if (newLuxLevel > 10) {
535 luxLevel = 10;
536 } else if (newLuxLevel < 0) {
537 luxLevel = 0;
538 } else {
539 luxLevel = newLuxLevel;
540 }
541 }
542}
543
544static uint8_t _readLux(struct GBALuminanceSource* lux) {
545 UNUSED(lux);
546 int value = 0x16;
547 if (luxLevel > 0) {
548 value += GBA_LUX_LEVELS[luxLevel - 1];
549 }
550 return 0xFF - value;
551}