ooot/include/z64message.h

#pragma once
#include "ultra64/types.h"
#include "view.h"
//#include "z64audio.h"

struct OcarinaStaff;

enum TextBoxIcon
{
	TEXTBOX_ICON_TRIANGLE,
	TEXTBOX_ICON_SQUARE,
	TEXTBOX_ICON_ARROW
};

enum Language
{
	LANGUAGE_ENG,
	LANGUAGE_GER,
	LANGUAGE_FRA,
	LANGUAGE_MAX
};

// TODO get these properties from the textures themselves
#define FONT_CHAR_TEX_WIDTH 16
#define FONT_CHAR_TEX_HEIGHT 16
#define FONT_CHAR_TEX_SIZE ((16 * 16) / 2) // 16x16 I4 texture

// TODO get these properties from the textures themselves
#define MESSAGE_STATIC_TEX_SIZE 0x1000

enum MessageMode
{
	/* 0x00 */ MSGMODE_NONE,
	/* 0x01 */ MSGMODE_TEXT_START,
	/* 0x02 */ MSGMODE_TEXT_BOX_GROWING,
	/* 0x03 */ MSGMODE_TEXT_STARTING,
	/* 0x04 */ MSGMODE_TEXT_NEXT_MSG,
	/* 0x05 */ MSGMODE_TEXT_CONTINUING,
	/* 0x06 */ MSGMODE_TEXT_DISPLAYING,
	/* 0x07 */ MSGMODE_TEXT_AWAIT_INPUT,
	/* 0x08 */ MSGMODE_TEXT_DELAYED_BREAK,
	/* 0x09 */ MSGMODE_OCARINA_STARTING,
	/* 0x0A */ MSGMODE_SONG_DEMONSTRATION_STARTING,
	/* 0x0B */ MSGMODE_SONG_PLAYBACK_STARTING,
	/* 0x0C */ MSGMODE_OCARINA_PLAYING,
	/* 0x0D */ MSGMODE_OCARINA_CORRECT_PLAYBACK,
	/* 0x0E */ MSGMODE_OCARINA_FAIL,	 // Failed to play a valid song after entering 8 notes
	/* 0x0F */ MSGMODE_OCARINA_FAIL_NO_TEXT, // Never set, only compared against
	/* 0x10 */ MSGMODE_OCARINA_NOTES_DROP,
	/* 0x11 */ MSGMODE_SONG_PLAYED, // Played a full named song correctly
	/* 0x12 */ MSGMODE_SETUP_DISPLAY_SONG_PLAYED,
	/* 0x13 */ MSGMODE_DISPLAY_SONG_PLAYED,
	/* 0x14 */ MSGMODE_DISPLAY_SONG_PLAYED_TEXT_BEGIN,
	/* 0x15 */ MSGMODE_DISPLAY_SONG_PLAYED_TEXT,
	/* 0x16 */ MSGMODE_SONG_PLAYED_ACT_BEGIN,
	/* 0x17 */ MSGMODE_SONG_PLAYED_ACT, // Act on a played song
	/* 0x18 */ MSGMODE_SONG_DEMONSTRATION_SELECT_INSTRUMENT,
	/* 0x19 */ MSGMODE_SONG_DEMONSTRATION,
	/* 0x1A */ MSGMODE_SONG_DEMONSTRATION_DONE,
	/* 0x1B */ MSGMODE_SONG_PLAYBACK,
	/* 0x1C */ MSGMODE_SONG_PLAYBACK_SUCCESS,
	/* 0x1D */ MSGMODE_SONG_PLAYBACK_FAIL,
	/* 0x1E */ MSGMODE_SONG_PLAYBACK_NOTES_DROP,
	/* 0x1F */ MSGMODE_OCARINA_AWAIT_INPUT,
	/* 0x20 */ MSGMODE_UNK_20, // Never set and does nothing
	/* 0x21 */ MSGMODE_SCARECROW_LONG_RECORDING_START,
	/* 0x22 */ MSGMODE_SCARECROW_LONG_RECORDING_ONGOING,
	/* 0x23 */ MSGMODE_SCARECROW_LONG_PLAYBACK,
	/* 0x24 */ MSGMODE_SCARECROW_RECORDING_START,
	/* 0x25 */ MSGMODE_SCARECROW_RECORDING_ONGOING,
	/* 0x26 */ MSGMODE_SCARECROW_RECORDING_FAILED,
	/* 0x27 */ MSGMODE_SCARECROW_RECORDING_DONE,
	/* 0x28 */ MSGMODE_SCARECROW_PLAYBACK,
	/* 0x29 */ MSGMODE_MEMORY_GAME_START,
	/* 0x2A */ MSGMODE_MEMORY_GAME_LEFT_SKULLKID_PLAYING,
	/* 0x2B */ MSGMODE_MEMORY_GAME_LEFT_SKULLKID_WAIT,
	/* 0x2C */ MSGMODE_MEMORY_GAME_RIGHT_SKULLKID_PLAYING,
	/* 0x2D */ MSGMODE_MEMORY_GAME_RIGHT_SKULLKID_WAIT,
	/* 0x2E */ MSGMODE_MEMORY_GAME_PLAYER_PLAYING,
	/* 0x2F */ MSGMODE_MEMORY_GAME_ROUND_SUCCESS,
	/* 0x30 */ MSGMODE_MEMORY_GAME_START_NEXT_ROUND,
	/* 0x31 */ MSGMODE_FROGS_START,
	/* 0x32 */ MSGMODE_FROGS_PLAYING,
	/* 0x33 */ MSGMODE_FROGS_WAITING,
	/* 0x34 */ MSGMODE_TEXT_AWAIT_NEXT,
	/* 0x35 */ MSGMODE_TEXT_DONE,
	/* 0x36 */ MSGMODE_TEXT_CLOSING,
	/* 0x37 */ MSGMODE_PAUSED // Causes the message system to do nothing until external code sets a new message mode or
				  // calls a public function
};

enum TextState
{
	/*  0 */ TEXT_STATE_NONE,
	/*  1 */ TEXT_STATE_DONE_HAS_NEXT,
	/*  2 */ TEXT_STATE_CLOSING,
	/*  3 */ TEXT_STATE_DONE_FADING,
	/*  4 */ TEXT_STATE_CHOICE,
	/*  5 */ TEXT_STATE_EVENT,
	/*  6 */ TEXT_STATE_DONE,
	/*  7 */ TEXT_STATE_SONG_DEMO_DONE,
	/*  8 */ TEXT_STATE_8,
	/*  9 */ TEXT_STATE_9,
	/* 10 */ TEXT_STATE_AWAITING_NEXT
};

struct Font
{
	/* 0x0000 */ Pointer msgOffset;
	/* 0x0004 */ size_t msgLength;
	/* 0x0008 */ u8 charTexBuf[FONT_CHAR_TEX_SIZE * 120];
	/* 0x3C08 */ u8 iconBuf[FONT_CHAR_TEX_SIZE];
	/* 0x3C88 */ u8 fontBuf[FONT_CHAR_TEX_SIZE * 320];
	union
	{
		/* 0xDC88 */ char msgBuf[1280];
		/* 0xDC88 */ u16 msgBufWide[640];
	};
}; // size = 0xE188

#define TEXTBOX_ENDTYPE_DEFAULT 0x00
#define TEXTBOX_ENDTYPE_2_CHOICE 0x10
#define TEXTBOX_ENDTYPE_3_CHOICE 0x20
#define TEXTBOX_ENDTYPE_HAS_NEXT 0x30
#define TEXTBOX_ENDTYPE_PERSISTENT 0x40
#define TEXTBOX_ENDTYPE_EVENT 0x50
#define TEXTBOX_ENDTYPE_FADING 0x60

struct MessageContext
{
	/* 0x0000 */ View view;
	/* 0x0128 */ Font font;
	/* 0xE2B0 */ void* textboxSegment; // original name: "fukidashiSegment"
	/* 0xE2B4 */ char unk_E2B4[0x4];
	/* 0xE2B8 */ OcarinaStaff* ocarinaStaff; // original name : "info"
	/* 0xE2BC */ char unk_E2BC[0x3C];
	/* 0xE2F8 */ u16 textId;
	/* 0xE2FA */ u16 choiceTextId;
	/* 0xE2FC */ u8 textBoxProperties; // original name : "msg_disp_type"
	/* 0xE2FD */ u8 textBoxType;	   // "Text Box Type"
	/* 0xE2FE */ u8 textBoxPos;	   // text box position
	/* 0xE300 */ s32 msgLength;	   // original name : "msg_data"
	/* 0xE304 */ u8 msgMode;	   // original name: "msg_mode"
	/* 0xE305 */ char unk_E305[0x1];
	/* 0xE306 */ u8 msgBufDecoded[200]; // decoded message buffer, may be smaller than this
	/* 0xE3CE */ u16 msgBufPos;	    // original name : "rdp"
	/* 0xE3D0 */ u16 unk_E3D0;	    // unused, only ever set to 0
	/* 0xE3D2 */ Counter textDrawPos;   // draw all decoded characters up to this buffer position
	/* 0xE3D4 */ u16 decodedTextLen;    // decoded message buffer length
	/* 0xE3D6 */ u16 textUnskippable;
	/* 0xE3D8 */ s16 textPosX;
	/* 0xE3DA */ s16 textPosY;
	/* 0xE3DC */ s16 textColorR;
	/* 0xE3DE */ s16 textColorG;
	/* 0xE3E0 */ s16 textColorB;
	/* 0xE3E2 */ s16 textColorAlpha;
	/* 0xE3E4 */ u8 textboxEndType; // original name : "select"
	/* 0xE3E5 */ u8 choiceIndex;
	/* 0xE3E6 */ u8 choiceNum; // textboxes that are not choice textboxes have a choiceNum of 1
	/* 0xE3E7 */ TimerU8 stateTimer;
	/* 0xE3E8 */ TimerU16 textDelayTimer;
	/* 0xE3EA */ u16 textDelay;
	/* 0xE3EA */ u16 lastPlayedSong; // original references : "Ocarina_Flog" , "Ocarina_Free"
	/* 0xE3EE */ u16 ocarinaMode;	 // original name : "ocarina_mode"
	/* 0xE3F0 */ u16 ocarinaAction;	 // original name : "ocarina_no"
	/* 0xE3F2 */ u16 unk_E3F2;	 // this is like "lastPlayedSong" but set less often, original name : "chk_ocarina_no"
	/* 0xE3F4 */ u16 unk_E3F4;	 // unused, only set to 0 in z_actor
	/* 0xE3F6 */ u16 textboxBackgroundIdx;
	/* 0xE3F8 */ u8 textboxBackgroundForeColorIdx;
	/* 0xE3F8 */ u8 textboxBackgroundBackColorIdx;
	/* 0xE3F8 */ u8 textboxBackgroundYOffsetIdx;
	/* 0xE3F8 */ u8 textboxBackgroundUnkArg; // unused, set by the textbox background control character arguments
	/* 0xE3FC */ char unk_E3FC[0x2];
	/* 0xE3FE */ s16 textboxColorRed;
	/* 0xE400 */ s16 textboxColorGreen;
	/* 0xE402 */ s16 textboxColorBlue;
	/* 0xE404 */ s16 textboxColorAlphaTarget;
	/* 0xE406 */ s16 textboxColorAlphaCurrent;
	/* 0xE408 */ struct Actor* talkActor;
	/* 0xE40C */ s16 disableWarpSongs; // warp song flag set by scene commands
	/* 0xE40E */ s16 unk_E40E;	   // ocarina related
	/* 0xE410 */ u8 lastOcaNoteIdx;
}; // size = 0xE418

enum DoAction
{
	/* 0x00 */ DO_ACTION_ATTACK,
	/* 0x01 */ DO_ACTION_CHECK,
	/* 0x02 */ DO_ACTION_ENTER,
	/* 0x03 */ DO_ACTION_RETURN,
	/* 0x04 */ DO_ACTION_OPEN,
	/* 0x05 */ DO_ACTION_JUMP,
	/* 0x06 */ DO_ACTION_DECIDE,
	/* 0x07 */ DO_ACTION_DIVE,
	/* 0x08 */ DO_ACTION_FASTER,
	/* 0x09 */ DO_ACTION_THROW,
	/* 0x0A */ DO_ACTION_NONE, // in do_action_static, the texture at this position is NAVI, however this value is in
				   // practice the "No Action" value
	/* 0x0B */ DO_ACTION_CLIMB,
	/* 0x0C */ DO_ACTION_DROP,
	/* 0x0D */ DO_ACTION_DOWN,
	/* 0x0E */ DO_ACTION_SAVE,
	/* 0x0F */ DO_ACTION_SPEAK,
	/* 0x10 */ DO_ACTION_NEXT,
	/* 0x11 */ DO_ACTION_GRAB,
	/* 0x12 */ DO_ACTION_STOP,
	/* 0x13 */ DO_ACTION_PUTAWAY,
	/* 0x14 */ DO_ACTION_REEL,
	/* 0x15 */ DO_ACTION_1,
	/* 0x16 */ DO_ACTION_2,
	/* 0x17 */ DO_ACTION_3,
	/* 0x18 */ DO_ACTION_4,
	/* 0x19 */ DO_ACTION_5,
	/* 0x1A */ DO_ACTION_6,
	/* 0x1B */ DO_ACTION_7,
	/* 0x1C */ DO_ACTION_8,
	/* 0x1D */ DO_ACTION_MAX
};

enum OcarinaSongId
{
	/*  0 */ OCARINA_SONG_MINUET,
	/*  1 */ OCARINA_SONG_BOLERO,
	/*  2 */ OCARINA_SONG_SERENADE,
	/*  3 */ OCARINA_SONG_REQUIEM,
	/*  4 */ OCARINA_SONG_NOCTURNE,
	/*  5 */ OCARINA_SONG_PRELUDE,
	/*  6 */ OCARINA_SONG_SARIAS,
	/*  7 */ OCARINA_SONG_EPONAS,
	/*  8 */ OCARINA_SONG_LULLABY,
	/*  9 */ OCARINA_SONG_SUNS,
	/* 10 */ OCARINA_SONG_TIME,
	/* 11 */ OCARINA_SONG_STORMS,
	/* 12 */ OCARINA_SONG_SCARECROW,
	/* 13 */ OCARINA_SONG_MEMORY_GAME,
	/* 14 */ OCARINA_SONG_MAX,
	/* 14 */ OCARINA_SONG_SCARECROW_LONG = OCARINA_SONG_MAX // anything larger than 13 is considered the long scarecrow's song
};

enum OcarinaSongActionIDs
{
	/* 0x00 */ OCARINA_ACTION_UNK_0, // acts like free play but never set
	/* 0x01 */ OCARINA_ACTION_FREE_PLAY,
	/* 0x02 */ OCARINA_ACTION_TEACH_MINUET, // Song demonstrations by teachers
	/* 0x03 */ OCARINA_ACTION_TEACH_BOLERO,
	/* 0x04 */ OCARINA_ACTION_TEACH_SERENADE,
	/* 0x05 */ OCARINA_ACTION_TEACH_REQUIEM,
	/* 0x06 */ OCARINA_ACTION_TEACH_NOCTURNE,
	/* 0x07 */ OCARINA_ACTION_TEACH_PRELUDE,
	/* 0x08 */ OCARINA_ACTION_TEACH_SARIA,
	/* 0x09 */ OCARINA_ACTION_TEACH_EPONA,
	/* 0x0A */ OCARINA_ACTION_TEACH_LULLABY,
	/* 0x0B */ OCARINA_ACTION_TEACH_SUNS,
	/* 0x0C */ OCARINA_ACTION_TEACH_TIME,
	/* 0x0D */ OCARINA_ACTION_TEACH_STORMS,
	/* 0x0E */ OCARINA_ACTION_UNK_E,
	/* 0x0F */ OCARINA_ACTION_PLAYBACK_MINUET, // Playing back a particular song
	/* 0x10 */ OCARINA_ACTION_PLAYBACK_BOLERO,
	/* 0x11 */ OCARINA_ACTION_PLAYBACK_SERENADE,
	/* 0x12 */ OCARINA_ACTION_PLAYBACK_REQUIEM,
	/* 0x13 */ OCARINA_ACTION_PLAYBACK_NOCTURNE,
	/* 0x14 */ OCARINA_ACTION_PLAYBACK_PRELUDE,
	/* 0x15 */ OCARINA_ACTION_PLAYBACK_SARIA,
	/* 0x16 */ OCARINA_ACTION_PLAYBACK_EPONA,
	/* 0x17 */ OCARINA_ACTION_PLAYBACK_LULLABY,
	/* 0x18 */ OCARINA_ACTION_PLAYBACK_SUNS,
	/* 0x19 */ OCARINA_ACTION_PLAYBACK_TIME,
	/* 0x1A */ OCARINA_ACTION_PLAYBACK_STORMS,
	/* 0x1B */ OCARINA_ACTION_UNK_1B,
	/* 0x1C */ OCARINA_ACTION_CHECK_MINUET, // Playing songs for check spots
	/* 0x1D */ OCARINA_ACTION_CHECK_BOLERO,
	/* 0x1E */ OCARINA_ACTION_CHECK_SERENADE,
	/* 0x1F */ OCARINA_ACTION_CHECK_REQUIEM,
	/* 0020 */ OCARINA_ACTION_CHECK_NOCTURNE,
	/* 0x21 */ OCARINA_ACTION_CHECK_PRELUDE,
	/* 0x22 */ OCARINA_ACTION_CHECK_SARIA,
	/* 0x23 */ OCARINA_ACTION_CHECK_EPONA,
	/* 0x24 */ OCARINA_ACTION_CHECK_LULLABY,
	/* 0x25 */ OCARINA_ACTION_CHECK_SUNS,
	/* 0x26 */ OCARINA_ACTION_CHECK_TIME,
	/* 0x27 */ OCARINA_ACTION_CHECK_STORMS,
	/* 0x28 */ OCARINA_ACTION_CHECK_SCARECROW, // Playing back the song as adult that was set as child
	/* 0x29 */ OCARINA_ACTION_FREE_PLAY_DONE,
	/* 0x2A */ OCARINA_ACTION_SCARECROW_LONG_RECORDING,
	/* 0x2B */ OCARINA_ACTION_SCARECROW_LONG_PLAYBACK,
	/* 0x2C */ OCARINA_ACTION_SCARECROW_RECORDING,
	/* 0x2D */ OCARINA_ACTION_SCARECROW_PLAYBACK,
	/* 0x2E */ OCARINA_ACTION_MEMORY_GAME,
	/* 0x2F */ OCARINA_ACTION_FROGS,
	/* 0x30 */ OCARINA_ACTION_CHECK_NOWARP, // Check for any of sarias - storms
	/* 0x31 */ OCARINA_ACTION_CHECK_NOWARP_DONE
};

enum OcarinaMode
{
	/* 0x00 */ OCARINA_MODE_00,
	/* 0x01 */ OCARINA_MODE_01,
	/* 0x02 */ OCARINA_MODE_02,
	/* 0x03 */ OCARINA_MODE_03,
	/* 0x04 */ OCARINA_MODE_04,
	/* 0x05 */ OCARINA_MODE_05,
	/* 0x06 */ OCARINA_MODE_06,
	/* 0x07 */ OCARINA_MODE_07,
	/* 0x08 */ OCARINA_MODE_08,
	/* 0x09 */ OCARINA_MODE_09,
	/* 0x0A */ OCARINA_MODE_0A,
	/* 0x0B */ OCARINA_MODE_0B,
	/* 0x0C */ OCARINA_MODE_0C,
	/* 0x0D */ OCARINA_MODE_0D,
	/* 0x0E */ OCARINA_MODE_0E,
	/* 0x0F */ OCARINA_MODE_0F
};