defs.h

/*
 * Heart of Darkness engine rewrite
 * Copyright (C) 2009-2011 Gregory Montoir (cyx@users.sourceforge.net)
 */

#ifndef DEFS_H__
#define DEFS_H__

enum {
	kPosTopScreen    = 0,
	kPosRightScreen  = 1,
	kPosBottomScreen = 2,
	kPosLeftScreen   = 3
};

enum {
	kNone = 0xFFFFFFFF, // (uint32_t)-1
	kNoScreen = 0xFF, // (uint8_t)-1
	kFrameDuration = 80, // original engine frame duration is 80ms (12.5hz)
	kLvlAnimHdrOffset = 0x2C,
	kMaxScreens = 40,
	kMaxSpriteTypes = 32,
	kMonsterInfoSize = 28,
	kMonsterInfoDataSize = 948 // (32 * kMonsterInfoSize + 52)
};

enum {
	kActionKeyMaskRun   = 0x1,
	kActionKeyMaskJump  = 0x2,
	kActionKeyMaskShoot = 0x4
};

enum {
	kDirectionKeyMaskUp    = 1, // climb
	kDirectionKeyMaskRight = 2,
	kDirectionKeyMaskDown  = 4, // crouch
	kDirectionKeyMaskLeft  = 8,
	kDirectionKeyMaskHorizontal = kDirectionKeyMaskLeft | kDirectionKeyMaskRight, // 0xA
	kDirectionKeyMaskVertical   = kDirectionKeyMaskDown | kDirectionKeyMaskUp     // 0x5
};

enum {
	kLvl_rock, // 0
	kLvl_fort,
	kLvl_pwr1,
	kLvl_isld,
	kLvl_lava, // 4
	kLvl_pwr2,
	kLvl_lar1,
	kLvl_lar2,
	kLvl_dark, // 8
	kLvl_test
};

struct SetupConfig {
	struct {
		uint8_t progress[10];
		uint8_t levelNum;
		uint8_t checkpointNum;
		uint32_t cutscenesMask;
		uint8_t controls[32];
		uint8_t difficulty;
		uint8_t stereo;
		uint8_t volume;
		uint8_t lastLevelNum;
	} players[4]; // sizeof == 52
	uint8_t unkD0;
	uint8_t currentPlayer; // 0xD1
	uint8_t unkD2;
	uint8_t checksum;
}; // sizeof == 212

struct Point8_t {
	int8_t x;
	int8_t y;
} PACKED;

struct Point16_t {
	int16_t x;
	int16_t y;
};

struct AnimBackgroundData {
	const uint8_t *currentSpriteData; // 0
	const uint8_t *nextSpriteData; // 4
	const uint8_t *otherSpriteData; // 8
	uint16_t framesCount; // 12
	uint16_t currentFrame; // 14
};

struct LvlAnimSeqHeader {
	uint16_t firstFrame;
	uint16_t unk2; // unused
	int8_t dx; // 4
	int8_t dy; // 5
	uint8_t count; // 6
	uint8_t unk7; // unused
	uint16_t sound;
	uint16_t flags0;
	uint16_t flags1;
	uint16_t unkE; // unused
	uint32_t offset; // 0x10, LvlAnimSeqFrameHeader
} PACKED; // sizeof == 20

struct LvlAnimSeqFrameHeader {
	uint16_t move; // 0
	uint16_t anim; // 2
	uint8_t frame; // 4
	uint8_t flags; // 5
	int8_t xOffset; // 6
	int8_t yOffset; // 7
} PACKED; // sizeof == 8

struct LvlAnimHeader {
	uint16_t unk0;
	uint8_t seqCount;
	uint8_t unk2;
	uint32_t seqOffset;
} PACKED; // sizeof == 8

struct LvlSprMoveData {
	uint8_t op1;
	uint8_t op2;
	uint16_t op3;
	uint16_t op4;
	uint16_t unk0x6; // padding to 8 bytes
} PACKED; // sizeof == 8

struct LvlSprHotspotData {
	Point8_t pts[8];
} PACKED; // sizeof == 16

struct LvlObjectData {
	uint8_t unk0;
	uint8_t spriteNum;
	uint16_t framesCount;
	uint16_t hotspotsCount;
	uint16_t movesCount;
	uint16_t coordsCount;
	uint8_t refCount; // 0xA
	uint8_t frame; // 0xB
	uint16_t anim; // 0xC
	uint8_t *animsInfoData; // 0x10, LevelSprAnimInfo
	uint8_t *movesData; // 0x14, LvlSprMoveData
	uint8_t *framesData; // 0x18
	uint8_t *framesOffsetsTable; // 0x1C
	uint8_t *coordsData; // 0x20
	uint8_t *coordsOffsetsTable; // 0x24
	uint8_t *hotspotsData; // 0x28, LvlSprHotspotData
};

struct Game;
struct SssObject;

struct LvlObject {
	int32_t xPos; // 0
	int32_t yPos; // 4
	uint8_t screenNum; // 8
	uint8_t screenState;
	uint8_t dataNum;
	uint8_t frame;
	uint16_t anim;
	uint8_t type;
	uint8_t spriteNum;
	uint16_t flags0;
	uint16_t flags1;
	uint16_t flags2;
	uint8_t objectUpdateType;
	uint8_t hitCount;
	LvlObject *childPtr; // _andyObject : plasma cannon object or specialAnimation
	uint16_t width;
	uint16_t height;
	uint8_t actionKeyMask;
	uint8_t directionKeyMask;
	uint16_t currentSprite;
	uint16_t currentSound; // 24
	const uint8_t *bitmapBits; // 28
	int (Game::*callbackFuncPtr)(LvlObject *ptr); // 2C
	void *dataPtr; // 30
	SssObject *sssObject; // 34
	LvlObjectData *levelData0x2988;
	Point16_t posTable[8];
	LvlObject *nextPtr;
};

struct SssFilter;
struct SssPcm;

struct SssObject {
	SssPcm *pcm; // 0x0
	uint16_t num; // 0x4
	uint16_t bankIndex; // 0x6
	int8_t priority; // 0x8
	int8_t currentPriority; // 0x9
	uint8_t flags; // 0xA
	bool stereo; // 0xB
	uint32_t flags0; // 0xC
	uint32_t flags1; // 0x10
	int32_t panning; // 0x14 panning default:64
	int32_t volume; // 0x18 volume default:128
	int panL; // 0x1C
	int panR; // 0x20
	int panType; // 0x24 : 0: silent, 1:right 2:left 3:center 4:balance
	const int16_t *currentPcmPtr; // 0x28
	int32_t pcmFramesCount; // 0x2C
	SssObject *prevPtr; // 0x30
	SssObject *nextPtr; // 0x34
	const uint8_t *codeDataStage1; // 0x38
	const uint8_t *codeDataStage2; // 0x3C
	const uint8_t *codeDataStage3; // 0x40
	const uint8_t *codeDataStage4; // 0x44
	int32_t repeatCounter; // 0x48
	int32_t pauseCounter; // 0x4C
	int32_t delayCounter; // 0x50
	int32_t volumeModulateSteps; // 0x54
	int32_t panningModulateSteps; // 0x58
	int32_t volumeModulateCurrent; // 0x5C
	int32_t volumeModulateDelta; // 0x60
	int32_t panningModulateCurrent; // 0x64
	int32_t panningModulateDelta; // 0x68
	int32_t currentPcmFrame; // 0x6C
	int *panningPtr; // 0x70 if != 0, panning is relative to the object position
	LvlObject *lvlObject; // 0x74
	int32_t nextSoundBank; // 0x78
	int32_t nextSoundSample; // 0x7C
	SssFilter *filter;
};

struct Sprite {
	int16_t xPos;
	int16_t yPos;
	const uint8_t *bitmapBits;
	Sprite *nextPtr;
	uint16_t num;
	uint16_t w, h;
};

struct BoundingBox {
	int32_t x1; // 0
	int32_t y1; // 4
	int32_t x2; // 8
	int32_t y2; // C
};

struct AndyLvlObjectData {
	uint8_t unk0;
	uint8_t unk1;
	uint8_t unk2;
	uint8_t unk3;
	uint8_t unk4;
	uint8_t unk5;
	uint16_t unk6;
	BoundingBox boundingBox; // 0x8
	int32_t dxPos; // 0x18
	int32_t dyPos; // 0x1C
	LvlObject *shootLvlObject; // 0x20 'cannon plasma' or 'special powers'
};

struct ShootLvlObjectData {
	uint8_t type; // 0x0
	uint8_t state; // 0x1
	uint8_t counter; // 0x2
	uint8_t unk3; // 0x3 value
	int32_t dxPos; // 0x4
	int32_t dyPos; // 0x8
	int32_t xPosShoot; // 0xC
	int32_t yPosShoot; // 0x10
	int32_t xPosObject; // 0x14
	int32_t yPosObject; // 0x18
	LvlObject *o; // 0x1C
	ShootLvlObjectData *nextPtr; // 0x20 pointer to the next free entry
};

struct ScreenMask { // ShadowScreenMask
	uint32_t dataSize;
	uint8_t *projectionDataPtr;
	uint8_t *shadowPalettePtr;
	int16_t x;
	int16_t y;
	uint16_t w;
	uint16_t h;
}; // sizeof == 0x14

struct WormHoleSprite {
	uint8_t screenNum;
	uint8_t initData1;
	int8_t xPos;
	int8_t yPos;
	uint32_t initData4;
	uint8_t rect1_x1;
	uint8_t rect1_y1;
	uint8_t rect1_x2;
	uint8_t rect1_y2;
	uint8_t rect2_x1;
	uint8_t rect2_y1;
	uint8_t rect2_x2;
	uint8_t rect2_y2;
	uint32_t flags[7]; // 0x10
}; // sizeof == 0x2C

struct MonsterObject1;

struct AndyShootData {
	int32_t xPos;
	int32_t yPos; // 4
	BoundingBox boundingBox; // 8
	int32_t size; // 0x18
	int32_t width;
	int32_t height;
	int32_t directionMask; // 0x24
	ShootLvlObjectData *shootObjectData; // 0x28
	LvlObject *o; // 0x2C
	MonsterObject1 *m; // 0x30
	int32_t clipX; // 0x34
	int32_t clipY; // 0x38
	int32_t monsterDistance; // 0x3C
	uint8_t type; // 0x40
	uint8_t plasmaCannonPointsCount; // 0x41
}; // sizeof == 0x44

struct AndyMoveData {
	int32_t xPos;
	int32_t yPos;
	uint16_t flags0; // 0x12
	uint16_t flags1;
};

struct MstBoundingBox {
	int x1; // 0
	int y1; // 4
	int x2; // 8
	int y2; // 0xC
	int monster1Index; // 0x10
}; // sizeof == 0x20

struct MstCollision {
	MonsterObject1 *monster1[32]; // 0x00
	uint32_t count; // 0x80
}; // sizeof == 132

struct Task;

struct MstWalkCode;
struct MstWalkPath;
struct MstInfoMonster2;
struct MstBehavior;
struct MstBehaviorState;
struct MstWalkNode;
struct MstMonsterAreaAction;
struct MstMovingBounds;
struct MstMovingBoundsUnk1;

struct MonsterObject1 {
	MstBehavior *m46; // 0x0
	MstBehaviorState *behaviorState; // 0x4
	const uint8_t *monsterInfos; // 0x8
	MstWalkNode *walkNode; // 0xC
	LvlObject *o16; // 0x10
	LvlObject *o20; // 0x14
	MstMonsterAreaAction *action; // 0x18
	AndyShootData *shootData; // 0x1C
	int monster1Index; // 0x20
	int executeCounter; // 0x24
	int32_t localVars[8]; // 0x28
	uint8_t flags48; // 0x48 0x4:indexUnk51!=kNone, 0x10:attackBox!=kNone
	uint8_t facingDirectionMask; // 0x49
	uint8_t goalDirectionMask; // 0x4A
	uint8_t goalScreenNum; // 0x4B
	int xPos; // 0x4C
	int yPos; // 0x50
	int xMstPos; // 0x54 currentLevelPos_x
	int yMstPos; // 0x58 currentLevelPos_y
	int xDelta; // 0x5C
	int yDelta; // 0x60
	int goalDistance_x1; // 0x64
	int goalDistance_x2; // 0x68
	int goalDistance_y1; // 0x6C
	int goalDistance_y2; // 0x70
	int goalPos_x1; // 0x74
	int goalPos_y1; // 0x78
	int goalPos_x2; // 0x7C
	int goalPos_y2; // 0x80
	int goalPosBounds_x2; // 0x84
	int goalPosBounds_x1; // 0x88
	// int goalPosBounds_y2; // 0x8C unused
	// int goalPosBounds_y1; // 0x90 unused
	int levelPosBounds_x2; // 0x94
	int levelPosBounds_x1; // 0x98
	int levelPosBounds_y2; // 0x9C
	int levelPosBounds_y1; // 0xA0
	uint8_t o_flags0; // 0xA4
	uint8_t flagsA5; // 0xA5
	uint8_t flagsA6; // 0xA6 |1:turning |2:idle |4:colliding
	uint8_t targetDirectionMask; // 0xA7
	uint8_t bboxNum[2]; // 0xA8, 0xA9
	uint8_t walkBoxNum; // 0xAA
	uint8_t unkAB; // 0xAB
	int32_t targetLevelPos_x; // 0xAC
	int32_t targetLevelPos_y; // 0xB0
	int32_t previousDxPos; // 0xB4 _xMstPos2
	int32_t previousDyPos; // 0xB8 _yMstPos2
	int32_t unkBC; // 0xBC _xMstPos1
	int32_t unkC0; // 0xC0 _yMstPos1
	Task *task; // 0xC4
	uint8_t rnd_m49[4]; // 0xC8
	uint8_t rnd_m35[4]; // 0xCC
	MstWalkCode *walkCode; // 0xD0
	MstMovingBoundsUnk1 *m49Unk1; // 0xD4
	MstMovingBounds *m49; // 0xD8
	int indexUnk49Unk1; // 0xDC
	uint8_t unkE4;
	uint8_t unkE5;
	uint8_t lut4Index; // 0xE6
	uint8_t directionKeyMask;
	uint16_t o_flags2; // 0xE8
	int collideDistance; // 0xEC
	int shootActionIndex; // 0xF0 [0..8]
	int shootSource; // 0xF4
	uint8_t goalDirectionKeyMask; // 0xF8
	int shootDirection; // 0xFC
}; // sizeof == 256

struct MonsterObject2 {
	MstInfoMonster2 *monster2Info;
	LvlObject *o; // 4
	MonsterObject1 *monster1; // 8
	int monster2Index; // 10
	int xPos; // 14
	int yPos; // 18
	int xMstPos; // 1C
	int yMstPos; // 20
	uint8_t flags24; // 24
	int x1; // 28
	int x2; // 2C
	int y1; // 30
	int y2; // 34
	uint8_t hPosIndex; // 38
	uint8_t vPosIndex; // 39
	uint8_t hDir; // 3A
	uint8_t vDir; // 3B
	Task *task; // 0x3C
}; // sizeof == 64

struct Task {
	const uint8_t *codeData;
	Task *prevPtr, *nextPtr; // 4,8
	MonsterObject1 *monster1; // 0xC
	MonsterObject2 *monster2; // 0x10
	int32_t localVars[8]; // 0x14
	uint8_t flags; // 0x34
	uint8_t state; // 0x35
	int16_t arg1; // 0x36 delay/counter/type
	uint32_t arg2; // 0x38  num/index
	int (Game::*run)(Task *t); // 0x3C
	Task *child; // 0x40
}; // sizeof == 0x44

#endif // DEFS_H__