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