Merge remote-tracking branch 'decomp/main' into decomp_merge

include/array_count.h

@@ -0,0 +1,8 @@
+#ifndef ARRAY_COUNT_H
+#define ARRAY_COUNT_H
+
+#define ARRAY_COUNT(arr) (s32)(sizeof(arr) / sizeof(arr[0]))
+#define ARRAY_COUNTU(arr) (u32)(sizeof(arr) / sizeof(arr[0]))
+#define ARRAY_COUNT_2D(arr) (s32)(sizeof(arr) / sizeof(arr[0][0]))
+
+#endif

include/avoid_ub.h

@@ -0,0 +1,13 @@
+#ifndef AVOID_UB_H
+#define AVOID_UB_H
+
+/**
+ * This macro is used when the return type of a function is incorrect
+ */
+#ifndef AVOID_UB
+#define BAD_RETURN(type) type
+#else
+#define BAD_RETURN(type) void
+#endif
+
+#endif

include/buffers.h

@@ -2,7 +2,6 @@
 #define BUFFERS_H
 
 #include "gfx.h"
-#include "macros.h"
 #include "ultra64.h"
 #include "config.h"
 

include/color.h

@@ -33,4 +33,6 @@ typedef union Color_RGBA16 {
     u16 rgba;
 } Color_RGBA16;
 
+#define RGBA8(r, g, b, a) ((((r) & 0xFF) << 24) | (((g) & 0xFF) << 16) | (((b) & 0xFF) << 8) | (((a) & 0xFF) << 0))
+
 #endif

include/controller.h

@@ -24,4 +24,13 @@
 #define CHECK_BTN_ALL(state, combo) (~((state) | ~(combo)) == 0)
 #endif
 
+// HackerOoT
+
+#if DEBUG_FEATURES
+// if using button combo check for the input, else simply return true
+#define DEBUG_BTN_COMBO(useCombo, btnToHold, btnToPress, input) ((useCombo ? CHECK_BTN_ALL(input->cur.button, btnToHold) : true) && CHECK_BTN_ALL(input->press.button, btnToPress))
+#else
+#define DEBUG_BTN_COMBO(useCombo, btnToHold, btnToPress, input) true
+#endif
+
 #endif

include/debug.h

@@ -3,7 +3,6 @@
 
 #include "config.h"
 #include "ultra64.h"
-#include "macros.h"
 #include "padmgr.h"
 #include "debug/print.h"
 #include "debug/collision_view.h"

include/fault.h

@@ -1,9 +1,10 @@
 #ifndef FAULT_H
 #define FAULT_H
 
-#include "ultra64.h"
-#include "attributes.h"
+#include "libu64/debug.h"
 #include "libu64/pad.h"
+#include "attributes.h"
+#include "ultra64.h"
 
 #if !PLATFORM_N64
 // These are the same as the 3-bit ansi color codes
@@ -50,6 +51,12 @@ void Fault_Init(void);
 NORETURN void Fault_AddHungupAndCrashImpl(const char* exp1, const char* exp2);
 NORETURN void Fault_AddHungupAndCrash(const char* file, int line);
 
+#if PLATFORM_N64 || DEBUG_FEATURES
+#define HUNGUP_AND_CRASH(...) Fault_AddHungupAndCrash(__FILE__, __LINE__)
+#else
+#define HUNGUP_AND_CRASH(...) LogUtils_HungupThread(__FILE__, __LINE__)
+#endif
+
 // Client Registration
 
 void Fault_AddClient(FaultClient* client, void* callback, void* arg0, void* arg1);

include/gfx.h

@@ -8,6 +8,9 @@
 #include "config.h"
 #include "versions.h"
 
+#define SCREEN_WIDTH  320
+#define SCREEN_HEIGHT 240
+
 // Texture memory size, 4 KiB
 #define TMEM_SIZE 0x1000
 
@@ -130,4 +133,78 @@ void Graph_ThreadEntry(void*);
 extern u64 gMojiFontTLUTs[4][4]; // original name: "moji_tlut"
 extern u64 gMojiFontTex[]; // original name: "font_ff"
 
+/**
+ * `x` vertex x
+ * `y` vertex y
+ * `z` vertex z
+ * `s` texture s coordinate
+ * `t` texture t coordinate
+ * `crnx` red component of color vertex, or x component of normal vertex
+ * `cgny` green component of color vertex, or y component of normal vertex
+ * `cbnz` blue component of color vertex, or z component of normal vertex
+ * `a` alpha
+ */
+#define VTX(x,y,z,s,t,crnx,cgny,cbnz,a) { { { x, y, z }, 0, { s, t }, { crnx, cgny, cbnz, a } } }
+
+#define VTX_T(x,y,z,s,t,cr,cg,cb,a) { { x, y, z }, 0, { s, t }, { cr, cg, cb, a } }
+
+#define gDPSetTileCustom(pkt, fmt, siz, uls, ult, lrs, lrt, pal,        \
+                         cms, cmt, masks, maskt, shifts, shiftt)        \
+_DW({                                                                   \
+    gDPPipeSync(pkt);                                                   \
+    gDPTileSync(pkt);                                                   \
+    gDPSetTile(pkt, fmt, siz,                                           \
+        (((((lrs) - (uls) + 1) * siz##_TILE_BYTES) + 7) >> 3), 0,       \
+        G_TX_LOADTILE, 0, cmt, maskt, shiftt, cms, masks,               \
+        shifts);                                                        \
+    gDPTileSync(pkt);                                                   \
+    gDPSetTile(pkt, fmt, siz,                                           \
+        (((((lrs) - (uls) + 1) * siz##_LINE_BYTES) + 7) >> 3), 0,       \
+        G_TX_RENDERTILE, pal, cmt, maskt, shiftt, cms, masks, shifts);  \
+    gDPSetTileSize(pkt, G_TX_RENDERTILE,                                \
+        (uls) << G_TEXTURE_IMAGE_FRAC,                                  \
+        (ult) << G_TEXTURE_IMAGE_FRAC,                                  \
+        (lrs) << G_TEXTURE_IMAGE_FRAC,                                  \
+        (lrt) << G_TEXTURE_IMAGE_FRAC);                                 \
+})
+
+// HackerOoT
+
+// System for inserting SPDontSkipTexLoadsAcross for actors/effects which
+// manipulate segments to select texture indices. Note that this only needs to
+// be done for things which have a single material and which can appear multiple
+// times consecutively in the scene, such as Rupees and effects.
+#if ENABLE_F3DEX3
+
+// It might seem that we'd need to ensure this is reset every frame. But we
+// actually only care about when this changes within a frame, as the texture
+// loads would only ever be skipped between two or more rupees drawn
+// consecutively. This is s32 so it can hold an actual texture pointer in case
+// an "index" is not available.
+#define IF_F3DEX3_DONT_SKIP_TEX_INIT() \
+    static s32 _lastTexIndex = -1; \
+    (void)0
+
+// If we have consecutive items rendering with different textures, F3DEX3's
+// optimizer will incorrectly believe the texture loads can be skipped, so this
+// command tells it not to skip them. However, if the texture really is the same
+// as last time, then we can let the optimizer skip the load.
+#define IF_F3DEX3_DONT_SKIP_TEX_HERE(pkt, texIndex) \
+    if ((s32)(texIndex) != _lastTexIndex) { \
+        gSPDontSkipTexLoadsAcross(pkt); \
+        _lastTexIndex = (s32)(texIndex); \
+    } \
+    (void)0
+
+// In some cases we are sure things are rendered consecutively with different
+// textures, e.g. in Fire Temple fire objects.
+#define IF_F3DEX3_ALWAYS_DONT_SKIP_TEX(pkt) \
+    gSPDontSkipTexLoadsAcross(pkt)
+
+#else
+#define IF_F3DEX3_DONT_SKIP_TEX_INIT() (void)0
+#define IF_F3DEX3_DONT_SKIP_TEX_HERE(pkt, texIndex) (void)0
+#define IF_F3DEX3_ALWAYS_DONT_SKIP_TEX(pkt) (void)0
+#endif
+
 #endif

include/global.h

@@ -1,6 +0,0 @@
-#ifndef GLOBAL_H
-#define GLOBAL_H
-
-#include "macros.h"
-
-#endif

include/language_array.h

@@ -0,0 +1,12 @@
+#ifndef LANGUAGE_ARRAY_H
+#define LANGUAGE_ARRAY_H
+
+#include "versions.h"
+
+#if OOT_NTSC
+#define LANGUAGE_ARRAY(jpn, eng, ger, fra) { jpn, eng }
+#else
+#define LANGUAGE_ARRAY(jpn, eng, ger, fra) { eng, ger, fra }
+#endif
+
+#endif

include/macros.h

@@ -1,143 +0,0 @@
-#ifndef MACROS_H
-#define MACROS_H
-
-#include "versions.h"
-
-#define SCREEN_WIDTH  320
-#define SCREEN_HEIGHT 240
-
-#ifndef AVOID_UB
-#define BAD_RETURN(type) type
-#else
-#define BAD_RETURN(type) void
-#endif
-
-#define ARRAY_COUNT(arr) (s32)(sizeof(arr) / sizeof(arr[0]))
-#define ARRAY_COUNTU(arr) (u32)(sizeof(arr) / sizeof(arr[0]))
-#define ARRAY_COUNT_2D(arr) (s32)(sizeof(arr) / sizeof(arr[0][0]))
-
-#define ABS(x) ((x) >= 0 ? (x) : -(x))
-#define ABS_ALT(x) ((x) < 0 ? -(x) : (x))
-#define DECR(x) ((x) == 0 ? 0 : --(x))
-#define CLAMP(x, min, max) ((x) < (min) ? (min) : (x) > (max) ? (max) : (x))
-#define CLAMP_MAX(x, max) ((x) > (max) ? (max) : (x))
-#define CLAMP_MIN(x, min) ((x) < (min) ? (min) : (x))
-
-#define SWAP(type, a, b)    \
-    {                       \
-        type _temp = (a);   \
-        (a) = (b);          \
-        (b) = _temp;        \
-    }                       \
-    (void)0
-
-#define RGBA8(r, g, b, a) ((((r) & 0xFF) << 24) | (((g) & 0xFF) << 16) | (((b) & 0xFF) << 8) | (((a) & 0xFF) << 0))
-
-#define CHECK_FLAG_ALL(flags, mask) (((flags) & (mask)) == (mask))
-
-#if PLATFORM_N64 || DEBUG_FEATURES
-#define HUNGUP_AND_CRASH(...) Fault_AddHungupAndCrash(__FILE__, __LINE__)
-#else
-#define HUNGUP_AND_CRASH(...) LogUtils_HungupThread(__FILE__, __LINE__)
-#endif
-
-#define MATRIX_FINALIZE_AND_LOAD(pkt, gfxCtx, file, line) \
-    gSPMatrix(pkt, MATRIX_FINALIZE(gfxCtx, file, line), G_MTX_NOPUSH | G_MTX_LOAD | G_MTX_MODELVIEW)
-
-#if OOT_NTSC
-#define LANGUAGE_ARRAY(jpn, eng, ger, fra) { jpn, eng }
-#else
-#define LANGUAGE_ARRAY(jpn, eng, ger, fra) { eng, ger, fra }
-#endif
-
-/**
- * `x` vertex x
- * `y` vertex y
- * `z` vertex z
- * `s` texture s coordinate
- * `t` texture t coordinate
- * `crnx` red component of color vertex, or x component of normal vertex
- * `cgny` green component of color vertex, or y component of normal vertex
- * `cbnz` blue component of color vertex, or z component of normal vertex
- * `a` alpha
- */
-#define VTX(x,y,z,s,t,crnx,cgny,cbnz,a) { { { x, y, z }, 0, { s, t }, { crnx, cgny, cbnz, a } } }
-
-#define VTX_T(x,y,z,s,t,cr,cg,cb,a) { { x, y, z }, 0, { s, t }, { cr, cg, cb, a } }
-
-#define gDPSetTileCustom(pkt, fmt, siz, uls, ult, lrs, lrt, pal,        \
-                         cms, cmt, masks, maskt, shifts, shiftt)        \
-_DW({                                                                   \
-    gDPPipeSync(pkt);                                                   \
-    gDPTileSync(pkt);                                                   \
-    gDPSetTile(pkt, fmt, siz,                                           \
-        (((((lrs) - (uls) + 1) * siz##_TILE_BYTES) + 7) >> 3), 0,       \
-        G_TX_LOADTILE, 0, cmt, maskt, shiftt, cms, masks,               \
-        shifts);                                                        \
-    gDPTileSync(pkt);                                                   \
-    gDPSetTile(pkt, fmt, siz,                                           \
-        (((((lrs) - (uls) + 1) * siz##_LINE_BYTES) + 7) >> 3), 0,       \
-        G_TX_RENDERTILE, pal, cmt, maskt, shiftt, cms, masks, shifts);  \
-    gDPSetTileSize(pkt, G_TX_RENDERTILE,                                \
-        (uls) << G_TEXTURE_IMAGE_FRAC,                                  \
-        (ult) << G_TEXTURE_IMAGE_FRAC,                                  \
-        (lrs) << G_TEXTURE_IMAGE_FRAC,                                  \
-        (lrt) << G_TEXTURE_IMAGE_FRAC);                                 \
-})
-
-#endif
-
-// HackerOoT
-
-#if DEBUG_FEATURES
-// if using button combo check for the input, else simply return true
-#define DEBUG_BTN_COMBO(useCombo, btnToHold, btnToPress, input) ((useCombo ? CHECK_BTN_ALL(input->cur.button, btnToHold) : true) && CHECK_BTN_ALL(input->press.button, btnToPress))
-#else
-#define DEBUG_BTN_COMBO(useCombo, btnToHold, btnToPress, input) true
-#endif
-
-#define IS_DEBUG_CAM_ENABLED (IS_CAMERA_DEBUG_ENABLED ? gDebugCamEnabled : false)
-
-#define IS_IN_RANGE(val, min, max) ((val >= min) && (val <= max))
-#define TIMER_DECR(val, target, changeBy) (((val - changeBy) < target) ? target : (val > target) ? (val - changeBy) : val)
-#define TIMER_INCR(val, target, changeBy) (((val + changeBy) > target) ? target : (val < target) ? (val + changeBy) : val)
-
-// System for inserting SPDontSkipTexLoadsAcross for actors/effects which
-// manipulate segments to select texture indices. Note that this only needs to
-// be done for things which have a single material and which can appear multiple
-// times consecutively in the scene, such as Rupees and effects.
-#if ENABLE_F3DEX3
-
-// It might seem that we'd need to ensure this is reset every frame. But we
-// actually only care about when this changes within a frame, as the texture
-// loads would only ever be skipped between two or more rupees drawn
-// consecutively. This is s32 so it can hold an actual texture pointer in case
-// an "index" is not available.
-#define IF_F3DEX3_DONT_SKIP_TEX_INIT() \
-    static s32 _lastTexIndex = -1; \
-    (void)0
-
-// If we have consecutive items rendering with different textures, F3DEX3's
-// optimizer will incorrectly believe the texture loads can be skipped, so this
-// command tells it not to skip them. However, if the texture really is the same
-// as last time, then we can let the optimizer skip the load.
-#define IF_F3DEX3_DONT_SKIP_TEX_HERE(pkt, texIndex) \
-    if ((s32)(texIndex) != _lastTexIndex) { \
-        gSPDontSkipTexLoadsAcross(pkt); \
-        _lastTexIndex = (s32)(texIndex); \
-    } \
-    (void)0
-
-// In some cases we are sure things are rendered consecutively with different
-// textures, e.g. in Fire Temple fire objects.
-#define IF_F3DEX3_ALWAYS_DONT_SKIP_TEX(pkt) \
-    gSPDontSkipTexLoadsAcross(pkt)
-
-#else
-#define IF_F3DEX3_DONT_SKIP_TEX_INIT() (void)0
-#define IF_F3DEX3_DONT_SKIP_TEX_HERE(pkt, texIndex) (void)0
-#define IF_F3DEX3_ALWAYS_DONT_SKIP_TEX(pkt) (void)0
-#endif
-
-#define STRINGIFY(s) #s
-#define EXPAND_AND_STRINGIFY(s) STRINGIFY(s)

include/sys_matrix.h

@@ -64,6 +64,9 @@ Mtx* Matrix_Finalize(struct GraphicsContext* gfxCtx);
 
 #endif
 
+#define MATRIX_FINALIZE_AND_LOAD(pkt, gfxCtx, file, line) \
+    gSPMatrix(pkt, MATRIX_FINALIZE(gfxCtx, file, line), G_MTX_NOPUSH | G_MTX_LOAD | G_MTX_MODELVIEW)
+
 /* Vector operations */
 
 void Matrix_MultVec3f(Vec3f* src, Vec3f* dest);

include/z64.h

@@ -4,6 +4,8 @@
 // TODO: This file still exists ONLY to provide neccesary headers to extracted assets.
 //       After assets are modified to include the headers they need directly, delete this file.
 
+#include "array_count.h"
+#include "gfx.h"
 #include "sequence.h"
 #include "sys_matrix.h"
 #include "ultra64.h"

include/z64actor.h

@@ -167,6 +167,8 @@ typedef struct ActorShape {
 // Note: Not implemented yet.
 #define ACTOR_FLAG_FREEZE_EXCEPTION (1 << 29)
 
+#define ACTOR_FLAGS_CHECK_ALL(thisx, mask) (((thisx)->flags & (mask)) == (mask))
+
 #define COLORFILTER_GET_COLORINTENSITY(colorFilterParams) (((colorFilterParams) & 0x1F00) >> 5)
 #define COLORFILTER_GET_DURATION(colorFilterParams) ((colorFilterParams) & 0xFF)
 

include/z64animation.h

@@ -1,10 +1,10 @@
 #ifndef Z64_ANIMATION_H
 #define Z64_ANIMATION_H
 
+#include "avoid_ub.h"
 #include "ultra64.h"
 #include "z64dma.h"
 #include "z64math.h"
-#include "macros.h"
 
 struct PlayState;
 struct Actor;

include/z64camera.h

@@ -1630,6 +1630,7 @@ typedef struct Camera {
 } Camera; // size = 0x16C
 
 extern s32 gDebugCamEnabled;
+#define IS_DEBUG_CAM_ENABLED (IS_CAMERA_DEBUG_ENABLED ? gDebugCamEnabled : false)
 
 void Camera_Init(Camera* camera, struct View* view, struct CollisionContext* colCtx, struct PlayState* play);
 void Camera_InitDataUsingPlayer(Camera* camera, struct Player* player);

include/z64math.h

@@ -1,11 +1,8 @@
 #ifndef Z64MATH_H
 #define Z64MATH_H
 
-#include "ultra64.h"
 #include "math.h"
-
-#define SQ(x) ((x)*(x))
-#define VEC_SET(V,X,Y,Z) (V).x=(X);(V).y=(Y);(V).z=(Z)
+#include "ultra64.h"
 
 typedef union FloatInt {
     f32 f;
@@ -99,6 +96,27 @@ typedef VecSphGeo VecSph;
 // Pitch is 0 along the xz-plane (horizon)
 typedef VecSphGeo VecGeo;
 
+/**
+ * Macros
+ */
+
+// General number macros
+#define SQ(x) ((x)*(x))
+#define ABS(x) ((x) >= 0 ? (x) : -(x))
+#define DECR(x) ((x) == 0 ? 0 : --(x))
+#define CLAMP(x, min, max) ((x) < (min) ? (min) : (x) > (max) ? (max) : (x))
+#define CLAMP_MAX(x, max) ((x) > (max) ? (max) : (x))
+#define CLAMP_MIN(x, min) ((x) < (min) ? (min) : (x))
+
+#define SWAP(type, a, b)    \
+    {                       \
+        type _temp = (a);   \
+        (a) = (b);          \
+        (b) = _temp;        \
+    }                       \
+    (void)0
+
+// LERP macros
 #define LERP(x, y, scale) (((y) - (x)) * (scale) + (x))
 #define LERP32(x, y, scale) ((s32)(((y) - (x)) * (scale)) + (x))
 #define LERP16(x, y, scale) ((s16)(((y) - (x)) * (scale)) + (x))
@@ -114,6 +132,7 @@ typedef VecSphGeo VecGeo;
     (dst)->z = (v0)->z + (((v1)->z - (v0)->z) * t); \
 }
 
+// Floating point macros
 #define IS_ZERO(f) (fabsf(f) < 0.008f)
 
 // Casting a float to an integer, when the float value is larger than what the integer type can hold,
@@ -149,6 +168,7 @@ typedef VecSphGeo VecGeo;
 #define CAM_BINANG_TO_DEG(binang) ((f32)(binang) * (360.0001525f / 65535.0f))
 
 // Vector macros
+#define VEC_SET(V,X,Y,Z) (V).x=(X);(V).y=(Y);(V).z=(Z)
 #define SQXZ(vec) ((vec).x * (vec).x + (vec).z * (vec).z)
 #define DOTXZ(vec1, vec2) ((vec1).x * (vec2).x + (vec1).z * (vec2).z)
 #define SQXYZ(vec) ((vec).x * (vec).x + (vec).y * (vec).y + (vec).z * (vec).z)

include/z64save.h

@@ -604,14 +604,11 @@ typedef enum LinkAge {
     (EVENTCHKINF_MASK(EVENTCHKINF_CARPENTER_0_RESCUED) | EVENTCHKINF_MASK(EVENTCHKINF_CARPENTER_1_RESCUED) | \
      EVENTCHKINF_MASK(EVENTCHKINF_CARPENTER_2_RESCUED) | EVENTCHKINF_MASK(EVENTCHKINF_CARPENTER_3_RESCUED))
 
-#define GET_EVENTCHKINF_CARPENTERS_ALL_RESCUED()                                             \
-    CHECK_FLAG_ALL(gSaveContext.save.info.eventChkInf[EVENTCHKINF_INDEX_CARPENTERS_RESCUED], \
-                   EVENTCHKINF_CARPENTERS_ALL_RESCUED_MASK)
+#define GET_EVENTCHKINF_CARPENTERS_ALL_RESCUED() \
+    ((gSaveContext.save.info.eventChkInf[EVENTCHKINF_INDEX_CARPENTERS_RESCUED] & EVENTCHKINF_CARPENTERS_ALL_RESCUED_MASK) == (EVENTCHKINF_CARPENTERS_ALL_RESCUED_MASK))
 
-#define GET_EVENTCHKINF_CARPENTERS_ALL_RESCUED2()                                             \
-    CHECK_FLAG_ALL(gSaveContext.save.info.eventChkInf[EVENTCHKINF_INDEX_CARPENTERS_RESCUED] & \
-                       (EVENTCHKINF_CARPENTERS_ALL_RESCUED_MASK | 0xF0),                      \
-                   EVENTCHKINF_CARPENTERS_ALL_RESCUED_MASK)
+#define GET_EVENTCHKINF_CARPENTERS_ALL_RESCUED2() \
+    ((gSaveContext.save.info.eventChkInf[EVENTCHKINF_INDEX_CARPENTERS_RESCUED] & (EVENTCHKINF_CARPENTERS_ALL_RESCUED_MASK | 0xF0) & EVENTCHKINF_CARPENTERS_ALL_RESCUED_MASK) == (EVENTCHKINF_CARPENTERS_ALL_RESCUED_MASK))
 
 #define ENDAIKU_CARPENTER_RESCUED_MASK(carpenterType) (1 << (carpenterType))
 

include/z64scene.h

@@ -1,7 +1,7 @@
 #ifndef Z64SCENE_H
 #define Z64SCENE_H
 
-#include "macros.h"
+#include "avoid_ub.h"
 #include "ultra64.h"
 #include "z64bgcheck.h"
 #include "z64environment.h"

include/z64view.h

@@ -1,7 +1,7 @@
 #ifndef Z64VIEW_H
 #define Z64VIEW_H
 
-#include "macros.h"
+#include "avoid_ub.h"
 #include "ultra64.h"
 #include "z64math.h"