3 * (C) 2018 by Andreas Eversberg <jolly@eversberg.eu>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include <sys/types.h>
25 #include "../libsdl/sdl.h"
26 #include "../libsdl/opengl.h"
27 #include "../libsdl/print.h"
28 #include "../libcpu/m68k.h"
29 #include "../libcpu/execute.h"
30 #include "../libvideo/video.h"
31 #include "../libsound/sound.h"
32 #include "../libjoystick/joystick.h"
33 #include "../libkeyboard/keyboard.h"
34 #include "../libdisk/disk.h"
35 #include "mercenary.h"
38 static int config_amiga_speed = 1;
39 static const char *config_gamesave_dir = ".mercenary";
40 static int config_video_filter = 1;
41 static int config_audio_filter = 1;
42 static int config_render = 0;
43 static int config_debug_opengl = 0;
45 #define CPU_SPEED 7093790.0;
47 #define SOUND_SAMPLERATE 48000
49 * - must be used for sound rendering chunk
52 /* numbe of buffer chunks to dejitter:
53 * - SDL render interval
54 * - sound rendering interval
55 * - sound card interval
56 * 4 should be minimum, if video rate is >=50 Hz
58 #define SOUND_CHUNKS 4
60 /* test sound to check if buffer does not overflow / underrun */
61 //#define DEBUG_SOUND_BUFFERING
63 #define IOSIZE 0x1000 /* bytes in io space */
64 #define MEMORY_SIZE 0x80000
65 static uint8_t *memory = NULL;
66 static uint8_t *image = NULL;
67 #define SCREEN_WIDTH 320
68 #define SCREEN_HEIGHT 200
69 #define IMAGE_WIDTH 320
70 #define IMAGE_HEIGHT 200
71 #define BENSON_AT_LINE 136
72 #define IMAGE_DIWSTART 0x2c
73 static uint16_t *chipreg = NULL;
74 static stereo_t *sound_buffer = NULL; /* sound buffer memory */
75 static int sound_buffer_size; /* buffer sample size */
76 static int sound_buffer_writep; /* write pointer at buffer */
77 static int sound_buffer_readp; /* read pointer at buffer */
78 static int double_size = 1; /* render in double size, so each pixle is 2*2 pixles wide */
79 static int render_legacy = 0; /* render original amiga screen, if set */
80 static int render_improved = 0; /* render improved image, if set */
81 static int render_debug = 0; /* render both, amiga screen and improved image, if set */
83 static const char *home_dir;
87 int parse_args(int argc, char *argv[])
92 if (!strcmp(argv[i], "-h") || !strcmp(argv[i], "--help")) {
93 print_info("Usage: %s\n", argv[0]);
94 print_info(" -s --amiga-speed original | full\n");
95 print_info(" Set speed of rendering to original Amiga or full speed.\n");
96 print_info(" -v --video-filter on | off\n");
97 print_info(" Set video filter.\n");
98 print_info(" -a --audio-filter on | off\n");
99 print_info(" Set audio filter.\n");
100 print_info(" -r --render original | opegl\n");
101 print_info(" Set speed of rendering to original Amiga or full speed.\n");
102 print_info(" -o --debug-opengl\n");
103 print_info(" Use split screen to debug opengl rendering vs. amiga rendering.\n");
106 if (!strcmp(argv[i], "-s") || !strcmp(argv[i], "--amiga-speed")) {
110 print_info("Missing parameter, use '--help'!\n");
113 if (!strcmp(argv[i], "original"))
114 config_amiga_speed = 1;
116 if (!strcmp(argv[i], "full"))
117 config_amiga_speed = 0;
120 print_info("Illegal parameter, use '--help'!\n");
124 if (!strcmp(argv[i], "-v") || !strcmp(argv[i], "--video-filter")) {
127 goto missing_parameter;
128 if (!strcmp(argv[i], "on"))
129 config_video_filter = 1;
131 if (!strcmp(argv[i], "off"))
132 config_video_filter = 0;
134 goto illegal_parameter;
136 if (!strcmp(argv[i], "-a") || !strcmp(argv[i], "--audio-filter")) {
139 goto missing_parameter;
140 if (!strcmp(argv[i], "on"))
141 config_audio_filter = 1;
143 if (!strcmp(argv[i], "off"))
144 config_audio_filter = 0;
146 goto illegal_parameter;
148 if (!strcmp(argv[i], "-r") || !strcmp(argv[i], "--render")) {
151 goto missing_parameter;
152 if (!strcmp(argv[i], "original"))
155 if (!strcmp(argv[i], "opengl"))
158 goto illegal_parameter;
160 if (!strcmp(argv[i], "-o") || !strcmp(argv[i], "--debug-opengl")) {
161 config_debug_opengl = 1;
163 print_info("Illegal option '%s', use '--help'!\n", argv[i]);
172 static void special_event(int event)
175 render_improved_event(event);
178 static void main_loop(void)
180 int had_first_irq = 0;
181 static uint32_t current_time, last_time = 0, diff;
184 int cycle_count, event;
185 double render_delay = 0.0;
186 uint32_t palette_address;
187 uint16_t palette[16];
189 last_time = SDL_GetTicks();
191 /* render result on window */
193 /* handle SDL events */
201 /* initialize rendering */
202 render_debug = config_debug_opengl;
203 render_legacy = (!config_render) || render_debug;
204 render_improved = config_render || render_debug;
205 /* start rendering for improved graphics */
207 opengl_viewport_improved(render_debug, (double_size) ? BENSON_AT_LINE * 2 : BENSON_AT_LINE);
209 /* STEP 1: let the CPU render/process the game */
210 /* don't render if we still delay */
212 /* execute until the rendered image is ready (wait for VBL) */
215 cycle_count += execute_cpu(0, mercenary_stop_at, &event);
216 /* handle special events */
217 if (event != STOP_AT_WAIT_VBL)
218 special_event(event);
219 } while (event != STOP_AT_WAIT_VBL);
221 palette_address = mercenary_palette();
222 for (i = 0; i < 16; i++)
223 palette[i] = m68k_read_memory_16(palette_address + i*2);
224 /* for amiga speed: set delay by the number of cycles */
225 if (config_amiga_speed)
226 render_delay = (double)cycle_count / CPU_SPEED;
229 /* STEP 2: transfer legacy image in memory to OpenGL texture */
231 /* render game view without benson
232 * because benson is not updated before VBL IRQ, we don't want old image from double buffer
235 emul_video(image, memory, palette, IMAGE_WIDTH, IMAGE_HEIGHT, IMAGE_DIWSTART, chipreg, 0, BENSON_AT_LINE, double_size);
237 /* render benson on improved rendering, if enabled */
239 opengl_render_benson(image, config_video_filter, (double_size) ? BENSON_AT_LINE * 2 : BENSON_AT_LINE);
240 /* setup viewport for legacy image and render image, if enabled */
242 opengl_viewport_legacy(render_debug);
243 opengl_render_legacy(image, config_video_filter);
247 /* STEP 3: execute interrupt at rate of 50Hz, render sound */
248 current_time = SDL_GetTicks();
249 diff = current_time - last_time;
250 /* in case of timer glitch, execute IRQ only by maximum number of SOUND_CHUNKS */
251 if (diff > 1000 * SOUND_CHUNKS / IRQ_RATE) {
252 diff = 1000 * SOUND_CHUNKS / IRQ_RATE;
253 last_time = current_time - 1000 * SOUND_CHUNKS / IRQ_RATE;
255 while (diff > 1000 / IRQ_RATE) {
256 execute_cpu(3, NULL, NULL);
257 execute_cpu(4, NULL, NULL);
259 /* render benson without game view
260 * because we only got benson refreshed during VBL IRQ
262 emul_video(image, memory, palette, IMAGE_WIDTH, IMAGE_HEIGHT, IMAGE_DIWSTART, chipreg, BENSON_AT_LINE, IMAGE_HEIGHT, double_size);
263 /* render sound to sound buffer
264 * buffer pointer read and write is atomic, so no locking required!
266 space = (sound_buffer_readp - sound_buffer_writep - 1 + sound_buffer_size) % sound_buffer_size;
267 if (space < SOUND_SAMPLERATE / IRQ_RATE) {
268 #ifdef DEBUG_SOUND_BUFFERING
269 fprintf(stderr, "sound buffer overflow\n");
273 length = SOUND_SAMPLERATE / IRQ_RATE;
274 #ifdef DEBUG_SOUND_BUFFERING
275 printf("can write %d, write %d\n", space, length);
278 for (s = 0; s < length; s++) {
279 sound_buffer[(sound_buffer_writep + s) % sound_buffer_size].left =
280 sound_buffer[(sound_buffer_writep + s) % sound_buffer_size].right
281 = sin(2 * M_PI * 999 * cnt / SOUND_SAMPLERATE)
282 * sin(2 * M_PI * 21 * cnt / SOUND_SAMPLERATE)
283 * sin(2 * M_PI * 0.5 * cnt / SOUND_SAMPLERATE);
287 render_sound(memory, sound_buffer, sound_buffer_size, sound_buffer_writep, length, config_audio_filter);
289 sound_buffer_writep = (sound_buffer_writep + length) % sound_buffer_size;
290 diff -= 1000 / IRQ_RATE;
291 last_time += 1000 / IRQ_RATE;
293 /* count down render delay */
295 render_delay -= 1.0 / (double)IRQ_RATE;
296 if (render_delay < 0.0)
303 static uint16_t io_read(uint32_t address)
305 uint16_t value = 0xffff;
307 /* joystick and fire button */
308 if (address == 0xbfe000 || address == 0xdff00c)
309 value &= emulate_joystick_read(address);
311 if (address == 0xbfec00 || address == 0xbfed00 || address == 0xbfee00)
312 value &= emulate_keyboard_read(address);
314 if (address == 0xbfd100 || address == 0xbfe000 || address == 0xdff01a || address == 0xdff01e)
315 value &= emulate_disk_read(address);
320 static void io_write(uint32_t address, uint16_t value)
322 /* dmacon and sound registers */
323 if (address == 0xdff096 || (address >= 0xdff0a0 && address <= 0xdff0df))
324 emulate_sound_write(address, value, SOUND_SAMPLERATE);
325 if (address == 0xbfd100 || (address >= 0xdff020 && address <= 0xdff024))
326 emulate_disk_write(address, value);
329 /* two tracks with 0x1820 words of length */
330 static uint8_t game_save[2][0x1820 << 1];
331 static int last_track = 0;
333 /* game reads track with saved game */
334 static void disk_read(int track, int __attribute__((unused)) side, uint32_t data, uint16_t length)
336 if (length > sizeof(game_save[0])) {
337 print_error("loading game state failed, because length exceeds game save data size, please fix!\n");
341 /* if even track is selected, load game */
344 int gamesave_num = (track - 2) >> 1;
348 memset(game_save, 0, sizeof(game_save)); /* clear so make the game fail, if we fail */
352 sprintf(filename, "%s/%s/", home_dir, config_gamesave_dir);
353 mkdir(filename, 0777);
355 sprintf(filename + strlen(filename), "%d%s", gamesave_num, mercenary_gamesavesuffix);
356 fp = fopen(filename, "r");
359 print_error("failed to load game from '%s'\n", filename);
362 got = fread(game_save, sizeof(game_save[0]), 2, fp);
370 memcpy(memory + data, game_save[track & 1], length /* sizeof(game_save[0])*/);
373 /* game writes track with saved game */
374 static void disk_write(int track, int __attribute__((unused)) side, uint32_t data, uint16_t length)
376 /* skip sync info that is provided by game and only relevant for a real disk track */
380 if (length != sizeof(game_save[0])) {
381 print_error("saving game state failed, because length of data does not match, please fix!\n");
385 /* don't save if last track is the same, because disk is written on both sides with the same data */
386 if (track == last_track) {
387 if (memcmp(memory + data, game_save[track & 1], length)) {
388 print_error("saving game data on other side of the disk is different, please fix!\n");
395 memcpy(game_save[track & 1], memory + data, length);
397 /* if done with saving */
400 int gamesave_num = (track - 2) >> 1;
407 sprintf(filename, "%s/%s/", home_dir, config_gamesave_dir);
408 mkdir(filename, 0777);
410 sprintf(filename + strlen(filename), "%d%s", gamesave_num, mercenary_gamesavesuffix);
411 fp = fopen(filename, "w");
414 print_error("failed to save game to '%s'\n", filename);
417 print_info("Game state saved to '%s'\n", filename);
418 wrote = fwrite(game_save, sizeof(game_save[0]), 2, fp);
425 static int shift = 0, ctrl = 0;
427 static void keyboard_sdl(int down, SDL_Keycode sym)
436 config_video_filter ^= 1;
437 print_info("video filter: %s\n", (config_video_filter) ? "on" : "off");
442 config_audio_filter ^= 1;
443 print_info("audio filter: %s\n", (config_audio_filter) ? "on" : "off");
448 config_amiga_speed ^= 1;
449 print_info("amiga speed: %s\n", (config_amiga_speed) ? "original" : "full");
455 printf("render: %s\n", (config_render) ? "opengl" : "original");
466 set_key("LSH", down);
470 set_key("RSH", down);
476 set_joystick(-1, -1, -1, -1, -1);
480 set_joystick(down, -1, -1, -1, -1);
485 set_joystick(-1, -1, -1, -1, -1);
489 set_joystick(-1, down, -1, -1, -1);
494 set_joystick(-1, -1, -1, -1, -1);
498 set_joystick(-1, -1, down, -1, -1);
503 set_joystick(-1, -1, -1, -1, -1);
507 set_joystick(-1, -1, -1, down, -1);
510 set_joystick(-1, -1, -1, -1, down);
513 case SDLK_a: set_key("A", down); break;
514 case SDLK_b: set_key("B", down); break;
515 case SDLK_c: set_key("C", down); break;
516 case SDLK_d: set_key("D", down); break;
517 case SDLK_e: set_key("E", down); break;
518 case SDLK_f: set_key("F", down); break;
519 case SDLK_g: set_key("G", down); break;
520 case SDLK_h: set_key("H", down); break;
521 case SDLK_i: set_key("I", down); break;
522 case SDLK_j: set_key("J", down); break;
523 case SDLK_k: set_key("K", down); break;
524 case SDLK_l: set_key("L", down); break;
525 case SDLK_m: set_key("M", down); break;
526 case SDLK_n: set_key("N", down); break;
527 case SDLK_o: set_key("O", down); break;
528 case SDLK_p: set_key("P", down); break;
529 case SDLK_q: set_key("Q", down); break;
530 case SDLK_r: set_key("R", down); break;
531 case SDLK_s: set_key("S", down); break;
532 case SDLK_t: set_key("T", down); break;
533 case SDLK_u: set_key("U", down); break;
534 case SDLK_v: set_key("V", down); break;
535 case SDLK_w: set_key("W", down); break;
536 case SDLK_x: set_key("X", down); break;
537 case SDLK_y: set_key("Y", down); break;
538 case SDLK_z: set_key("Z", down); break;
540 case SDLK_0: set_key("0", down); break;
541 case SDLK_1: set_key("1", down); break;
542 case SDLK_2: set_key("2", down); break;
543 case SDLK_3: set_key("3", down); break;
544 case SDLK_4: set_key("4", down); break;
545 case SDLK_5: set_key("5", down); break;
546 case SDLK_6: set_key("6", down); break;
547 case SDLK_7: set_key("7", down); break;
548 case SDLK_8: set_key("8", down); break;
549 case SDLK_9: set_key("9", down); break;
551 case SDLK_KP_0: set_key("NP0", down); break;
552 case SDLK_KP_1: set_key("NP1", down); break;
553 case SDLK_KP_2: set_key("NP2", down); break;
554 case SDLK_KP_3: set_key("NP3", down); break;
555 case SDLK_KP_4: set_key("NP4", down); break;
556 case SDLK_KP_5: set_key("NP5", down); break;
557 case SDLK_KP_6: set_key("NP6", down); break;
558 case SDLK_KP_7: set_key("NP7", down); break;
559 case SDLK_KP_8: set_key("NP8", down); break;
560 case SDLK_KP_9: set_key("NP9", down); break;
561 case SDLK_KP_DIVIDE: set_key("NPDIV", down); break;
562 case SDLK_KP_MULTIPLY: set_key("NPMUL", down); break;
563 case SDLK_KP_MINUS: set_key("NPSUB", down); break;
564 case SDLK_KP_PLUS: set_key("NPADD", down); break;
565 case SDLK_KP_PERIOD: set_key("NPDEL", down); break;
566 // NPLPAREN and NPRPAREN are not emulated
568 case SDLK_F1: set_key("F1", down); break;
569 case SDLK_F2: set_key("F2", down); break;
570 case SDLK_F3: set_key("F3", down); break;
571 case SDLK_F4: set_key("F4", down); break;
572 case SDLK_F5: set_key("F5", down); break;
573 case SDLK_F6: set_key("F6", down); break;
574 case SDLK_F7: set_key("F7", down); break;
575 case SDLK_F8: set_key("F8", down); break;
576 case SDLK_F9: set_key("F9", down); break;
577 case SDLK_F10: set_key("F10", down); break;
579 case SDLK_SPACE: set_key("SPC", down); break;
580 case SDLK_BACKSPACE: set_key("BS", down); break;
581 case SDLK_TAB: set_key("TAB", down); break;
582 case SDLK_KP_ENTER: set_key("ENT", down); break;
583 case SDLK_RETURN: set_key("RET", down); break;
584 case SDLK_ESCAPE: set_key("ESC", down); break;
585 case SDLK_DELETE: set_key("DEL", down); break;
586 case SDLK_INSERT: set_key("HELP", down); break;
591 void audio_sdl(float *data, int length)
595 /* read sound from sound buffer
596 * buffer pointer read and write is atomic, so no locking required!
598 fill = (sound_buffer_writep - sound_buffer_readp + sound_buffer_size) % sound_buffer_size;
600 #ifdef DEBUG_SOUND_BUFFERING
601 fprintf(stderr, "sound buffer underrun\n");
603 /* correct read pointer as if the buffer would have 'length' of samples stored inside */
604 sound_buffer_readp = (sound_buffer_readp + fill - length + sound_buffer_size) % sound_buffer_size;
606 for (s = 0; s < length; s++) {
607 *data++ = sound_buffer[(sound_buffer_readp + s) % sound_buffer_size].left;
608 *data++ = sound_buffer[(sound_buffer_readp + s) % sound_buffer_size].right;
610 #ifdef DEBUG_SOUND_BUFFERING
611 printf("fill %d = %.4f\n", length, sound_buffer[sound_buffer_readp][0]);
613 sound_buffer_readp =(sound_buffer_readp + length) % sound_buffer_size;
616 int main(int argc, char *argv[])
621 home_dir = getenv("HOME");
625 rc = parse_args(argc, argv);
630 image = calloc(IMAGE_WIDTH * IMAGE_HEIGHT * ((double_size) ? 4 : 1), 3);
632 print_error("Failed to allocate image buffer\n");
636 if ((SOUND_SAMPLERATE % IRQ_RATE)) {
637 print_error("Sample rate must be a multiple of IRQ rate, please fix!\n");
640 if ((1000 % IRQ_RATE)) {
641 print_error("1000 (Ticks per second) rate must be a multiple of IRQ rate, please fix!\n");
645 /* calculate SDL chunk size for audio
646 * it must be a power of two, but not more than the chunk size for each IRQ!
648 for (sdl_sound_chunk = 2; sdl_sound_chunk <= (SOUND_SAMPLERATE / IRQ_RATE); sdl_sound_chunk <<= 1)
650 sdl_sound_chunk >>= 1;
651 // printf("samples per IRQ = %d, samples per SDL audio = %d\n", SOUND_SAMPLERATE / IRQ_RATE, sdl_sound_chunk); exit(0);
653 /* allocate sound buffers */
654 sound_buffer_size = SOUND_SAMPLERATE / IRQ_RATE * SOUND_CHUNKS;
655 sound_buffer = calloc(sound_buffer_size, sizeof(*sound_buffer));
657 print_error("Failed to allocate image buffer\n");
661 /* allocate memory */
662 memory = calloc(MEMORY_SIZE, 1);
664 print_error("Failed to allocate cpu's memory\n");
667 chipreg = calloc(IOSIZE, 1);
669 print_error("Failed to allocate chip register\n");
674 execute_init(MEMORY_SIZE, memory, chipreg, io_read, io_write);
676 /* init disk emulation */
677 disk_init(disk_read, disk_write);
682 /* patch some stuff */
685 /* init SDL and OpenGL */
686 rc = init_sdl(argv[0], (config_debug_opengl) ? SCREEN_WIDTH * 2 : SCREEN_WIDTH * 3, (config_debug_opengl) ? SCREEN_HEIGHT * 4 : SCREEN_HEIGHT * 3, SOUND_SAMPLERATE, sdl_sound_chunk, keyboard_sdl, audio_sdl);
689 rc = init_opengl((double_size) ? IMAGE_WIDTH * 2 : IMAGE_WIDTH, (double_size) ? IMAGE_HEIGHT * 2 : IMAGE_HEIGHT);
692 resize_opengl((config_debug_opengl) ? SCREEN_WIDTH * 2 : SCREEN_WIDTH * 3, (config_debug_opengl) ? SCREEN_HEIGHT * 4 : SCREEN_HEIGHT * 3);
694 /* init audio filter */
695 sound_init_filter(SOUND_SAMPLERATE);
700 print_info("**********************************\n");
701 print_info("* Welcome to Mercenary Reloaded! *\n");
702 print_info("**********************************\n\n");
703 print_info("Press CTRL + cursor keys to select inventory or pickup/drop item.\n");
704 print_info("Press CTRL + f to toggle full screen.\n");
705 print_info("Press CTRL + s to toggle rendering speed.\n");
706 print_info("Press CTRL + v to toggle video filter.\n");
707 print_info("Press CTRL + a to toggle audio filter.\n");
708 print_info("Press CTRL + r to toggle rendering with opengl or orignal code.\n");
709 print_info("Press CTRL + c to exit game.\n\n");
710 print_info("Use '--help' as command line option for configuration settings.\n\n");