scummvm/simon/simon.h
Oliver Kiehl 9c647b4dbe cleanup
svn-id: r13277
2004-03-14 17:50:40 +00:00

833 lines
20 KiB
C++

/* ScummVM - Scumm Interpreter
* Copyright (C) 2001-2004 The ScummVM project
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Header$
*
*/
#ifndef SIMON_H
#define SIMON_H
#include <stdio.h>
#include "base/engine.h"
#include "common/util.h"
#include "simon/midi.h"
#include "simon/sound.h"
class GameDetector;
namespace Simon {
/* Various other settings */
//#define DUMP_FILE_NR 8
//#define DUMP_BITMAPS_FILE_NR 8
uint fileReadItemID(File *in);
#define CHECK_BOUNDS(x, y) assert((uint)(x) < ARRAYSIZE(y))
#define NUM_PALETTE_FADEOUT 32
struct Child;
struct Child2;
struct Item;
struct FillOrCopyStruct;
struct Subroutine;
struct SubroutineLine;
struct TimeEvent;
struct TextLocation {
int16 x, y, width;
TextLocation() { memset(this, 0, sizeof(*this)); }
};
struct HitArea {
uint16 x, y;
uint16 width, height;
uint16 flags;
uint16 id;
FillOrCopyStruct *fcs;
Item *item_ptr;
uint16 unk3;
uint16 layer;
HitArea() { memset(this, 0, sizeof(*this)); }
};
struct VgaPointersEntry {
byte *vgaFile1;
byte *vgaFile2;
uint32 dd;
VgaPointersEntry() { memset(this, 0, sizeof(*this)); }
};
struct VgaSprite {
uint16 id;
uint16 image;
uint16 base_color;
uint16 x, y; /* actually signed numbers */
uint16 unk4;
uint16 priority;
uint16 unk6, unk7;
VgaSprite() { memset(this, 0, sizeof(*this)); }
};
struct VgaSleepStruct {
uint16 ident;
byte *code_ptr;
uint16 sprite_id;
uint16 cur_vga_file;
VgaSleepStruct() { memset(this, 0, sizeof(*this)); }
};
struct VgaTimerEntry {
uint16 delay;
byte *script_pointer;
uint16 sprite_id;
uint16 cur_vga_file;
VgaTimerEntry() { memset(this, 0, sizeof(*this)); }
};
struct GameSpecificSettings;
class Debugger;
class SimonEngine : public Engine {
friend class Debugger;
void errorString(const char *buf_input, char *buf_output);
protected:
void playSting(uint a);
byte *_vc_ptr; /* video code ptr */
uint32 *_game_offsets_ptr;
uint VGA_DELAY_BASE;
uint TABLE_INDEX_BASE;
uint TEXT_INDEX_BASE;
uint NUM_VIDEO_OP_CODES;
uint VGA_MEM_SIZE;
uint TABLES_MEM_SIZE;
uint MUSIC_INDEX_BASE;
uint SOUND_INDEX_BASE;
const GameSpecificSettings *gss;
byte _game;
byte _key_pressed;
typedef enum {
FORMAT_NONE,
FORMAT_MP3,
FORMAT_WAV,
FORMAT_VOC
} SoundFormat;
File *_game_file;
byte *_stripped_txt_mem;
uint _text_size;
uint _stringtab_num, _stringtab_pos, _stringtab_numalloc;
byte **_stringtab_ptr;
Item **_itemarray_ptr;
uint _itemarray_size;
uint _itemarray_inited;
byte *_itemheap_ptr;
uint _itemheap_curpos;
uint _itemheap_size;
byte *_icon_file_ptr;
byte *_tbl_list;
byte *_code_ptr;
byte **_local_stringtable;
uint _string_id_local_min, _string_id_local_max;
byte *_tablesheap_ptr, *_tablesheap_ptr_org, *_tablesheap_ptr_new;
uint _tablesheap_size, _tablesheap_curpos, _tablesheap_curpos_org;
uint _tablesheap_curpos_new;
Subroutine *_subroutine_list, *_subroutine_list_org;
uint _subroutine;
uint _dx_surface_pitch;
uint _recursion_depth;
uint32 _last_vga_tick;
uint16 _op_189_flags;
bool _scriptvar_2;
bool _run_script_return_1;
bool _skip_vga_wait;
bool _no_parent_notify;
bool _vga_res_328_loaded;
bool _hitarea_unk_3;
bool _mortal_flag;
volatile bool _sync_flag_1;
byte _video_var_8;
bool _use_palette_delay;
bool _sync_flag_2;
bool _in_callback;
bool _cepe_flag;
byte _copy_partial_mode;
uint _speed;
bool _fast_mode;
bool _dx_use_3_or_4_for_lock;
uint16 _debugMode;
uint16 _language;
bool _pause;
bool _start_mainscript;
bool _continous_mainscript;
bool _start_vgascript;
bool _continous_vgascript;
bool _draw_images_debug;
bool _dump_images;
bool _speech;
bool _subtitles;
bool _fade;
byte _mouse_cursor;
bool _vga_var9;
int16 _script_unk_1;
bool _vga_var6;
int _x_scroll, _vga_var1, _vga_var2, _vga_var3, _vga_var5;
byte *_vga_var7;
byte _vga_var8;
int16 _script_cond_a, _script_cond_b, _script_cond_c;
uint16 _fcs_unk_1;
FillOrCopyStruct *_fcs_ptr_1;
Item *_subject_item, *_object_item;
Item *_item_1;
Item *_hitarea_object_item;
HitArea *_last_hitarea;
HitArea *_last_hitarea_2_ptr;
HitArea *_last_hitarea_3;
byte _left_button_down;
Item *_hitarea_subject_item;
HitArea *_hitarea_ptr_5, *_hitarea_ptr_7;
uint _need_hitarea_recalc;
uint _verb_hitarea;
uint16 _hitarea_unk_4;
uint _lock_counter;
uint16 _video_palette_mode;
uint _print_char_unk_1, _print_char_unk_2;
uint _num_letters_to_print;
uint _last_time;
TimeEvent *_first_time_struct, *_pending_delete_time_event;
uint _base_time;
uint _mouse_x, _mouse_y;
uint _mouse_x_old, _mouse_y_old;
Item *_dummy_item_1;
Item *_dummy_item_2;
Item *_dummy_item_3;
volatile uint16 _lock_word;
uint16 _scroll_up_hit_area;
uint16 _scroll_down_hit_area;
uint16 _video_var_7;
volatile uint16 _palette_color_count;
byte _video_var_4;
bool _video_var_5;
bool _video_var_3;
bool _unk_pal_flag;
bool _exit_cutscene;
bool _skip_speech;
byte _video_var_9;
uint _sound_file_id;
int16 _last_music_played;
int16 _next_music_to_play;
bool _show_preposition;
bool _showmessage_flag;
uint _video_num_pal_colors;
uint _invoke_timer_callback;
uint _vga_sprite_changed;
byte *_vga_buf_free_start, *_vga_buf_end, *_vga_buf_start;
byte *_vga_file_buf_org, *_vga_file_buf_org_2;
byte *_cur_vga_file_1;
byte *_cur_vga_file_2;
uint16 _timer_1, _timer_5, _timer_4;
uint16 _vga_base_delay;
uint16 _vga_cur_file_2;
uint16 _vga_wait_for, _vga_cur_file_id;
uint16 _vga_cur_sprite_id;
VgaTimerEntry *_next_vga_timer_to_process;
Item *_vc_item_array[20];
Item *_item_array_6[20];
uint16 _stringid_array_2[20];
uint16 _stringid_array_3[20];
uint16 _speechid_array_4[20];
uint16 _bit_array[32];
int16 _variableArray[256];
FillOrCopyStruct *_fcs_ptr_array_3[8];
byte _fcs_data_1[8];
bool _fcs_data_2[8];
TextLocation _textlocation_1, _textlocation_2, _textlocation_3, _textlocation_4;
int _free_string_slot;
byte _stringReturnBuffer[2][180];
HitArea _hit_areas[90];
VgaPointersEntry _vga_buffer_pointers[180];
VgaSprite _vga_sprites[180];
VgaSleepStruct _vga_sleep_structs[30];
uint16 *_pathfind_array[20];
uint8 _palette_backup[1024];
uint8 _palette[1024];
byte _video_buf_1[3000];
VgaTimerEntry _vga_timer_list[95];
FillOrCopyStruct *_fcs_list;
byte _letters_to_print_buf[80];
MidiPlayer midi;
int _num_screen_updates;
int _vga_tick_counter;
Sound *_sound;
bool _effects_paused;
bool _ambient_paused;
bool _music_paused;
Debugger *_debugger;
int _timer_id;
FILE *_dump_file;
int _saveload_row_curpos;
int _num_savegame_rows;
bool _savedialog_flag;
bool _save_or_load;
bool _saveload_flag;
byte _saveLoadFlag, _saveLoadSlot;
char _saveLoadName[32];
int _sdl_mouse_x, _sdl_mouse_y;
byte *_sdl_buf_3;
byte *_sdl_buf;
byte *_sdl_buf_attached;
Common::RandomSource _rnd;
byte *_vc_10_base_ptr_old;
byte _hebrew_char_widths[32];
public:
SimonEngine(GameDetector *detector, OSystem *syst);
virtual ~SimonEngine();
protected:
int allocGamePcVars(File *in);
void loginPlayerHelper(Item *item, int a, int b);
void loginPlayer();
void allocateStringTable(int num);
void setupStringTable(byte *mem, int num);
void setupLocalStringTable(byte *mem, int num);
void readGamePcText(File *in);
void readItemChildren(File *in, Item *item, uint tmp);
void readItemFromGamePc(File *in, Item *item);
void loadGamePcFile(const char *filename);
byte *allocateItem(uint size);
byte *allocateTable(uint size);
void alignTableMem();
Child *findChildOfType(Item *i, uint child);
Child *allocateChildBlock(Item *i, uint type, uint size);
void allocItemHeap();
void allocTablesHeap();
Subroutine *createSubroutine(uint a);
void readSubroutine(File *in, Subroutine *sub);
SubroutineLine *createSubroutineLine(Subroutine *sub, int a);
void readSubroutineLine(File *in, SubroutineLine *new_table, Subroutine *sub);
byte *readSingleOpcode(File *in, byte *ptr);
void readSubroutineBlock(File *in);
Subroutine *getSubroutineByID(uint subroutine_id);
/* used in debugger */
void dumpSubroutines();
void dumpSubroutine(Subroutine *sub);
void dumpSubroutineLine(SubroutineLine *sl, Subroutine *sub);
byte *dumpOpcode(byte *p);
int startSubroutine(Subroutine *sub);
int startSubroutineEx(Subroutine *sub);
bool checkIfToRunSubroutineLine(SubroutineLine *sl, Subroutine *sub);
int runScript();
Item *getNextItemPtr();
uint getNextItemID();
uint getItem1ID() {return 1;}
Item *getItem1Ptr();
Item *getItemPtrB();
byte getByte();
int getNextWord();
uint getNextVarContents();
uint getVarOrWord();
uint getVarOrByte();
uint readVariable(uint variable);
void writeNextVarContents(uint16 contents);
void writeVariable(uint variable, uint16 contents);
void setItemParent(Item *item, Item *parent);
uint itemPtrToID(Item *id);
Item *derefItem(uint item);
void setItemUnk3(Item *item, int value);
void showMessageFormat(const char *s, ...);
const byte *getStringPtrByID(uint string_id);
const byte *getLocalStringByID(uint string_id);
uint getNextStringID();
void addTimeEvent(uint timeout, uint subroutine_id);
void delTimeEvent(TimeEvent *te);
bool hasChildOfType1(Item *item);
bool hasChildOfType2(Item *item);
void itemChildrenChanged(Item *item);
void unlinkItem(Item *item);
void linkItem(Item *item, Item *parent);
bool o_unk_23(uint a);
void o_kill_sprite_simon1(uint a);
void o_kill_sprite_simon2(uint a, uint b);
void o_vga_reset();
void o_unk_101();
void fcs_unk_2(uint a);
void o_unk_103();
void fcs_delete(uint a);
void o_unk_108(uint a);
void clear_hitarea_bit_0x40(uint hitarea);
void set_hitarea_bit_0x40(uint hitarea);
void set_hitarea_x_y(uint hitarea, int x, int y);
bool is_hitarea_0x40_clear(uint hitarea);
void delete_hitarea(uint hitarea);
void addNewHitArea(int id, int x, int y, int width, int height, int flags, int unk3, Item *item_ptr);
HitArea *findEmptyHitArea();
void hitarea_proc_1();
void handle_verb_hitarea(HitArea * ha);
void hitarea_leave(HitArea * ha);
void leaveHitAreaById(uint hitarea_id);
void o_unk_114();
void o_wait_for_vga(uint a);
void skip_speech();
void o_unk_120(uint a);
void o_unk_126();
void o_play_music_resource();
void o_save_game();
void o_load_game();
void o_quit_if_user_presses_y();
void o_unk_137(uint a);
void o_unk_138();
void killAllTimers();
uint getOffsetOfChild2Param(Child2 *child, uint prop);
void o_unk_160(uint a);
void o_play_sound(uint a);
void o_unk_175();
void o_unk_176();
void o_pathfind(int x, int y, uint var_1, uint var_2);
void o_force_unlock();
void o_force_lock();
void o_read_vgares_328();
void o_read_vgares_23();
void o_clear_vgapointer_entry(uint a);
void o_unk_186();
void o_fade_to_black();
TextLocation *getTextLocation(uint a);
void o_print_str();
void o_setup_cond_c();
void setup_cond_c_helper();
void o_inventory_descriptions();
void lock();
void unlock();
void fcs_unk_proc_1(uint i, Item *item_ptr, int unk1, int unk2);
void loadTextIntoMem(uint string_id);
void loadTablesIntoMem(uint subr_id);
uint loadTextFile(const char *filename, byte *dst);
File *openTablesFile(const char *filename);
void closeTablesFile(File *in);
uint loadTextFile_simon1(const char *filename, byte *dst);
File *openTablesFile_simon1(const char *filename);
uint loadTextFile_gme(const char *filename, byte *dst);
File *openTablesFile_gme(const char *filename);
void invokeTimeEvent(TimeEvent *te);
bool kickoffTimeEvents();
void defocusHitarea();
void startSubroutine170();
void runSubroutine101();
void handle_uparrow_hitarea(FillOrCopyStruct *fcs);
void handle_downarrow_hitarea(FillOrCopyStruct *fcs);
void hitareaChangedHelper();
void focusVerb(uint hitarea_id);
HitArea *findHitAreaByID(uint hitarea_id);
void showActionString(uint x, const byte *string);
void video_putchar(FillOrCopyStruct *fcs, byte c, byte b = 0);
void video_fill_or_copy_from_3_to_2(FillOrCopyStruct *fcs);
void video_toggle_colors(HitArea * ha, byte a, byte b, byte c, byte d);
void read_vga_from_datfile_1(uint vga_id);
uint get_fcs_ptr_3_index(FillOrCopyStruct *fcs);
void setup_hitarea_from_pos(uint x, uint y, uint mode);
void new_current_hitarea(HitArea * ha);
bool hitarea_proc_2(uint a);
bool hitarea_proc_3(Item *item);
void f10_key();
void hitarea_stuff();
void handle_mouse_moved();
void pollMouseXY();
void draw_mouse_pointer();
void fcs_unk1(uint fcs_index);
void draw_icon_c(FillOrCopyStruct *fcs, uint icon, uint x, uint y);
bool has_item_childflag_0x10(Item *item);
uint item_get_icon_number(Item *item);
uint setup_icon_hit_area(FillOrCopyStruct *fcs, uint x, uint y, uint icon_number, Item *item_ptr);
void fcs_unk_proc_2(FillOrCopyStruct *fcs, uint fcs_index);
void loadIconFile();
void processSpecialKeys();
void hitarea_stuff_helper();
void startUp(uint a);
void startUp_helper_2();
void startUp_helper_3();
void startUp_helper();
void showmessage_helper_3(uint a, uint b);
void showmessage_print_char(byte chr);
void handle_verb_clicked(uint verb);
void o_set_video_mode(uint mode, uint vga_res);
void set_video_mode(uint mode, uint vga_res_id);
void set_video_mode_internal(uint mode, uint vga_res_id);
void ensureVgaResLoadedC(uint vga_res);
void ensureVgaResLoaded(uint vga_res);
void start_vga_code(uint b, uint vga_res, uint vga_sprite_id, uint x, uint y, uint base_color);
void o_unk26_helper(uint a, uint b, uint c, uint d, uint e, uint f, uint g, uint h);
void talk_with_speech(uint speech_id, uint vga_sprite_id);
void talk_with_text(uint vga_sprite_id, uint color, const char *string_ptr, int16 x, int16 y, int16 width);
FillOrCopyStruct *fcs_alloc(uint x, uint y, uint w, uint h, uint flags, uint fill_color, uint unk4);
void render_string_amiga(uint vga_sprite_id, uint color, uint width, uint height, const char *txt);
void render_string(uint vga_sprite_id, uint color, uint width, uint height, const char *txt);
void setup_hit_areas(FillOrCopyStruct *fcs, uint fcs_index);
byte *setup_vga_destination(uint32 size);
void vga_buf_unk_proc3(byte *end);
void vga_buf_unk_proc1(byte *end);
void vga_buf_unk_proc2(uint a, byte *end);
void delete_memptr_range(byte *end);
void setup_vga_file_buf_pointers();
void run_vga_script();
public:
// Simon1/Simon2 video script opcodes
void vc_1_dummy_op();
void vc_2_call();
void vc_3_new_sprite();
void vc_4_dummy_op();
void vc_5_skip_if_neq();
void vc_6_skip_ifn_sib_with_a();
void vc_7_skip_if_sib_with_a();
void vc_8_skip_if_parent_is();
void vc_9_skip_if_unk3_is();
void vc_10_draw();
void vc_11_clear_pathfind_array();
void vc_12_delay();
void vc_13_set_sprite_offset_x();
void vc_14_set_sprite_offset_y();
void vc_15_wakeup_id();
void vc_16_sleep_on_id();
void vc_17_set_pathfind_item();
void vc_18_jump_rel();
void vc_19_chain_to_script();
void vc_20_set_code_word();
void vc_21_jump_if_code_word();
void vc_22_set_sprite_palette();
void vc_23_set_sprite_priority();
void vc_24_set_sprite_xy();
void vc_25_halt_sprite();
void vc_26_set_window();
void vc_27_reset();
void vc_27_reset_simon1();
void vc_27_reset_simon2();
void vc_28_dummy_op();
void vc_29_stop_all_sounds();
void vc_30_set_base_delay();
void vc_31_set_palette_mode();
void vc_32_copy_var();
void vc_33_force_unlock();
void vc_34_force_lock();
void vc_35();
void vc_36_saveload_thing();
void vc_37_set_sprite_offset_y();
void vc_38_skip_if_var_zero();
void vc_39_set_var();
void vc_40_var_add();
void vc_41_var_sub();
void vc_42_delay_if_not_eq();
void vc_43_skip_if_bit_clear();
void vc_44_skip_if_bit_set();
void vc_45_set_sprite_x();
void vc_46_set_sprite_y();
void vc_47_add_var_f();
void vc_48();
void vc_49_set_bit();
void vc_50_clear_bit();
void vc_51_clear_hitarea_bit_0x40();
void vc_52_play_sound();
void vc_53_no_op();
void vc_54_no_op();
void vc_55_offset_hit_area();
void vc_56_delay();
void vc_57_no_op();
void vc_58();
void vc_59();
void vc_60_kill_sprite();
void vc_61_sprite_change();
void vc_62_palette_thing();
void vc_63_palette_thing_2();
// Simon2 specific Video Script Opcodes
void vc_64_skip_if_no_speech();
void vc_65_palette_thing_3();
void vc_66_skip_if_nz();
void vc_67_skip_if_ge();
void vc_68_skip_if_le();
void vc_69_play_track();
void vc_70_queue_music();
void vc_71_check_music_queue();
void vc_72_play_track_2();
void vc_73_set_op189_flag();
void vc_74_clear_op189_flag();
protected:
void delete_vga_timer(VgaTimerEntry * vte);
void vc_resume_sprite(byte *code_ptr, uint16 cur_file, uint16 cur_sprite);
int vc_read_var_or_word();
uint vc_read_next_word();
uint vc_read_next_byte();
uint vc_read_var(uint var);
void vc_write_var(uint var, int16 value);
void vc_skip_next_instruction();
bool itemIsSiblingOf(uint16 val);
bool itemIsParentOf(uint16 a, uint16 b);
bool vc_maybe_skip_proc_1(uint16 a, int16 b);
void add_vga_timer(uint num, byte *code_ptr, uint cur_sprite, uint cur_file);
VgaSprite *find_cur_sprite();
void vc_set_bit_to(uint bit, bool value);
void expire_vga_timers();
bool has_vga_sprite_with_id(uint16 id, uint16 file);
bool vc_get_bit(uint bit);
void fcs_setTextColor(FillOrCopyStruct *fcs, uint value);
void video_copy_if_flag_0x8_c(FillOrCopyStruct *fcs);
void delete_hitarea_by_index(uint index);
void fcs_unk_5(FillOrCopyStruct *fcs, uint fcs_index);
void fcs_putchar(uint a);
void copy_img_from_3_to_2(FillOrCopyStruct *fcs);
void video_erase(FillOrCopyStruct *fcs);
void dx_copy_rgn_from_3_to_2(uint b, uint r, uint y, uint x);
byte *dx_lock_2();
void dx_unlock_2();
byte *dx_lock_attached();
void dx_unlock_attached();
byte *read_vga_from_datfile_2(uint id);
void resfile_read(void *dst, uint32 offs, uint32 size);
void go();
void openGameFile();
static int CDECL game_thread_proc(void *param);
void timer_callback();
void timer_proc1();
void timer_vga_sprites();
void timer_vga_sprites_2();
void dx_clear_surfaces(uint num_lines);
void dx_update_screen_and_palette();
void dump_video_script(byte *src, bool one_opcode_only);
void dump_vga_file(byte *vga);
void dump_vga_script(byte *ptr, uint res, uint sprite_id);
void dump_vga_script_always(byte *ptr, uint res, uint sprite_id);
void dump_vga_bitmaps(byte *vga, byte *vga1, int res);
void dump_single_bitmap(int file, int image, byte *offs, int w, int h, byte base);
void dx_clear_attached_from_top(uint lines);
void dx_copy_from_attached_to_2(uint x, uint y, uint w, uint h);
void dx_copy_from_attached_to_3(uint lines);
void dx_copy_from_2_to_attached(uint x, uint y, uint w, uint h);
void print_char_helper_1(const byte *src, uint len);
void print_char_helper_5(FillOrCopyStruct *fcs);
void quick_load_or_save();
void shutdown();
byte *vc_10_depack_swap(byte *src, uint w, uint h);
byte *vc_10_no_depack_swap(byte *src, uint w, uint h);
Item *getNextItemPtrStrange();
bool save_game(uint slot, char *caption);
bool load_game(uint slot);
void showmessage_helper_2();
void print_char_helper_6(uint i);
void video_putchar_newline(FillOrCopyStruct *fcs);
void video_putchar_drawchar(FillOrCopyStruct *fcs, uint x, uint y, byte chr);
void loadMusic(uint music);
void checkTimerCallback();
void delay(uint delay);
void pause();
void o_83_helper();
void o_190_helper(uint i);
void timer_vga_sprites_helper();
void decodeStripA(byte *dst, byte *src, int height);
void scroll_timeout();
void hitarea_stuff_helper_2();
void realizePalette();
void fadeUpPalette();
void vc_kill_sprite(uint file, uint sprite);
void set_dummy_cursor();
void set_volume(byte volume);
void save_or_load_dialog(bool load);
void o_unk_132_helper_3();
int o_unk_132_helper(bool *b, char *buf);
void o_clear_character(FillOrCopyStruct *fcs, int x, byte b = 0);
void savegame_dialog(char *buf);
void o_file_error(FillOrCopyStruct *fcs, bool save_error);
int count_savegames();
int display_savegame_list(int curpos, bool load, char *dst);
void show_it(void *buf);
char *gen_savename(int slot);
};
void palette_fadeout(uint32 *pal_values, uint num);
} // End of namespace Simon
#endif