PreRender.c OK (#1320)

* begin prerender

* match func_801716C4

* copy more docs from OoT

* begin func_801720FC

* improve func_801720FC

* match func_801720FC

* background 2D

* merge master

* func_801717F8 attempt

* z64prerender.h

* import bss

* non-equivalent

* document func_801716C4

* cleanup comments

* import tharo docs

* minor improvement on PreRender_DivotFilter

* Match PreRender_DivotFilter

* Remove fakes

* format

* Fix comment about RM_VISCVG in PreRender_FetchFbufCoverage

* PreRender cleanup

* PR Review

* review

* listalloc.h

* bss

* capitalization

---------

Co-authored-by: angie <angheloalf95@gmail.com>
Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

include/functions.h

@@ -1160,34 +1160,6 @@ void Play_AssignPlayerCsIdsFromScene(GameState* thisx, s32 spawnCsId);
 void Play_FillScreen(GameState* thisx, s16 fillScreenOn, u8 red, u8 green, u8 blue, u8 alpha);
 void Play_Init(GameState* thisx);
 
-void PreRender_SetValuesSave(PreRender* this, u32 width, u32 height, void* fbuf, void* zbuf, void* cvg);
-void PreRender_Init(PreRender* this);
-void PreRender_SetValues(PreRender* this, u32 width, u32 height, void* fbuf, void* zbuf);
-void PreRender_Destroy(PreRender* this);
-void func_8016FDB8(PreRender* this, Gfx** gfxp, void* buf, void* bufSave, u32 arg4);
-void func_8016FF70(PreRender* this, Gfx** gfxp, void* buf, void* bufSave);
-void func_8016FF90(PreRender* this, Gfx** gfxp, void* buf, void* bufSave, s32 envR, s32 envG, s32 envB, s32 envA);
-void func_80170200(PreRender* this, Gfx** gfxp, void* buf, void* bufSave);
-void func_8017023C(PreRender* this, Gfx** gfxp, void* buf, void* bufSave);
-void func_8017057C(PreRender* this, Gfx** gfxp);
-void func_801705B4(PreRender* this, Gfx** gfxp);
-void func_801705EC(PreRender* this, Gfx** gfxp);
-void func_80170730(PreRender* this, Gfx** gfxp);
-void func_80170774(PreRender* this, Gfx** gfxp);
-void func_80170798(PreRender* this, Gfx** gfxp);
-void func_80170AE0(PreRender* this, Gfx** gfxp, s32 alpha);
-void func_80170B28(PreRender* this, Gfx** gfxp);
-void PreRender_AntiAliasAlgorithm(PreRender* this, s32 x, s32 y);
-void PreRender_ApplyAntiAliasingFilter(PreRender* this);
-u32 func_801716C4(u8* arg0, u8* arg1, u8* arg2);
-void func_801717F8(PreRender* this);
-void PreRender_ApplyFilters(PreRender* this);
-void PreRender_ApplyFiltersSlowlyInit(PreRender* this);
-void PreRender_ApplyFiltersSlowlyDestroy(PreRender* this);
-void func_801720C4(PreRender* this);
-void func_801720FC(PreRenderParams* params, Gfx** gfxp);
-void Prerender_DrawBackground2D(Gfx** gfxp, void* timg, void* tlut, u16 width, u16 height, u8 fmt, u8 siz, u16 tt, u16 arg8, f32 x, f32 y, f32 xScale, f32 yScale, u32 flags);
-
 void GameAlloc_Log(GameAlloc* this);
 void* GameAlloc_Malloc(GameAlloc* this, size_t size);
 void GameAlloc_Free(GameAlloc* this, void* data);
@@ -1208,10 +1180,6 @@ void Graph_ThreadEntry(void* arg);
 Gfx* Graph_GfxPlusOne(Gfx* gfx);
 Gfx* Graph_BranchDlist(Gfx* gfx, Gfx* dst);
 void* Graph_DlistAlloc(Gfx** gfx, size_t size);
-ListAlloc* ListAlloc_Init(ListAlloc* this);
-// void ListAlloc_Alloc(void);
-// void ListAlloc_Free(void);
-void ListAlloc_FreeAll(ListAlloc* this);
 
 void Sched_SwapFramebuffer(CfbInfo* cfbInfo);
 void Sched_RetraceUpdateFramebuffer(SchedContext* sched, CfbInfo* cfbInfo);

include/listalloc.h

@@ -0,0 +1,16 @@
+#ifndef LISTALLOC_H
+#define LISTALLOC_H
+
+#include "ultra64.h"
+
+typedef struct ListAlloc {
+    /* 0x0 */ struct ListAlloc* prev;
+    /* 0x4 */ struct ListAlloc* next;
+} ListAlloc; // size = 0x8
+
+ListAlloc* ListAlloc_Init(ListAlloc* this);
+void* ListAlloc_Alloc(ListAlloc* this, size_t size);
+void ListAlloc_Free(ListAlloc* this, void* data);
+void ListAlloc_FreeAll(ListAlloc* this);
+
+#endif

include/z64.h

@@ -52,6 +52,7 @@
 #include "z64object.h"
 #include "z64ocarina.h"
 #include "z64player.h"
+#include "z64prerender.h"
 #include "z64save.h"
 #include "z64scene.h"
 #include "z64schedule.h"
@@ -222,53 +223,6 @@ typedef struct {
     /* 0xFA */ u8 unk_FA[4];
 } EnvironmentContext; // size = 0x100
 
-typedef struct ListAlloc {
-    /* 0x0 */ struct ListAlloc* prev;
-    /* 0x4 */ struct ListAlloc* next;
-} ListAlloc; // size = 0x8
-
-typedef struct {
-    /* 0x00 */ u16 width;
-    /* 0x02 */ u16 height;
-    /* 0x04 */ u16 widthSave;
-    /* 0x06 */ u16 heightSave;
-    /* 0x08 */ char unk_8[8];
-    /* 0x10 */ u16* fbuf;
-    /* 0x14 */ u16* fbufSave;
-    /* 0x18 */ u8* cvgSave;
-    /* 0x1C */ u16* zbuf;
-    /* 0x20 */ u16* zbufSave;
-    /* 0x24 */ u16 ulxSave;
-    /* 0x26 */ u16 ulySave;
-    /* 0x28 */ u16 lrxSave;
-    /* 0x2A */ u16 lrySave;
-    /* 0x2C */ u16 ulx;
-    /* 0x2E */ u16 uly;
-    /* 0x30 */ u16 lrx;
-    /* 0x32 */ u16 lry;
-    /* 0x34 */ char unk_34[16];
-    /* 0x44 */ ListAlloc alloc;
-    /* 0x4C */ u8 unk_4C;
-    /* 0x4D */ u8 unk_4D;
-    /* 0x4E */ char unk_4E[2];
-} PreRender; // size = 0x50
-
-typedef struct {
-    /* 0x00 */ void* timg;
-    /* 0x04 */ void* tlut;
-    /* 0x08 */ u16 width;
-    /* 0x0A */ u16 height;
-    /* 0x0C */ u8 fmt;
-    /* 0x0D */ u8 siz;
-    /* 0x0E */ u16 tt;
-    /* 0x10 */ u16 unk_10;
-    /* 0x14 */ f32 x;
-    /* 0x18 */ f32 y;
-    /* 0x1C */ f32 xScale;
-    /* 0x20 */ f32 yScale;
-    /* 0x24 */ u32 flags;
-} PreRenderParams; // size = 0x28
-
 struct PlayState;
 
 typedef struct {

include/z64prerender.h

@@ -0,0 +1,73 @@
+#ifndef Z64_PRERENDER_H
+#define Z64_PRERENDER_H
+
+#include "ultra64.h"
+#include "listalloc.h"
+#include "unk.h"
+
+#define BG2D_FLAGS_1 (1 << 0)
+#define BG2D_FLAGS_2 (1 << 1)
+#define BG2D_FLAGS_AC_THRESHOLD (1 << 2)
+#define BG2D_FLAGS_LOAD_S2DEX2 (1 << 3)
+#define BG2D_FLAGS_COPY (1 << 4)
+
+typedef enum PrerenderFilterState {
+    /* 0 */ PRERENDER_FILTER_STATE_NONE,
+    /* 1 */ PRERENDER_FILTER_STATE_PROCESS,
+    /* 2 */ PRERENDER_FILTER_STATE_DONE
+} PrerenderFilterState;
+
+typedef struct PreRender {
+    /* 0x00 */ u16 width;
+    /* 0x02 */ u16 height;
+    /* 0x04 */ u16 widthSave;
+    /* 0x06 */ u16 heightSave;
+    /* 0x08 */ UNK_TYPE1 unk_08[0x8];
+    /* 0x10 */ u16* fbuf;
+    /* 0x14 */ u16* fbufSave;
+    /* 0x18 */ u8* cvgSave;
+    /* 0x1C */ u16* zbuf;
+    /* 0x20 */ u16* zbufSave;
+    /* 0x24 */ u16 ulxSave;
+    /* 0x26 */ u16 ulySave;
+    /* 0x28 */ u16 lrxSave;
+    /* 0x2A */ u16 lrySave;
+    /* 0x2C */ u16 ulx;
+    /* 0x2E */ u16 uly;
+    /* 0x30 */ u16 lrx;
+    /* 0x32 */ u16 lry;
+    /* 0x34 */ UNK_TYPE1 unk_34[0x10];
+    /* 0x44 */ ListAlloc alloc;
+    /* 0x4C */ u8 unk_4C;
+    /* 0x4D */ u8 filterState; // See `PrerenderFilterState`
+} PreRender; // size = 0x50
+
+
+void PreRender_SetValuesSave(PreRender* this, u32 width, u32 height, void* fbuf, void* zbuf, void* cvg);
+void PreRender_Init(PreRender* this);
+void PreRender_SetValues(PreRender* this, u32 width, u32 height, void* fbuf, void* zbuf);
+void PreRender_Destroy(PreRender* this);
+void PreRender_CopyImage(PreRender* this, Gfx** gfxp, void* img, void* imgDst, u32 useThresholdAlphaCompare);
+void PreRender_RestoreBuffer(PreRender* this, Gfx** gfxp, void* buf, void* bufSave);
+void func_8016FF90(PreRender* this, Gfx** gfxp, void* buf, void* bufSave, s32 envR, s32 envG, s32 envB, s32 envA);
+void func_80170200(PreRender* this, Gfx** gfxp, void* buf, void* bufSave);
+void PreRender_CoverageRgba16ToI8(PreRender* this, Gfx** gfxp, void* img, void* cvgDst);
+void PreRender_SaveZBuffer(PreRender* this, Gfx** gfxp);
+void PreRender_SaveFramebuffer(PreRender* this, Gfx** gfxp);
+void PreRender_FetchFbufCoverage(PreRender* this, Gfx** gfxp);
+void PreRender_DrawCoverage(PreRender* this, Gfx** gfxp);
+void PreRender_RestoreZBuffer(PreRender* this, Gfx** gfxp);
+void func_80170798(PreRender* this, Gfx** gfxp);
+void func_80170AE0(PreRender* this, Gfx** gfxp, s32 alpha);
+void PreRender_RestoreFramebuffer(PreRender* this, Gfx** gfxp);
+void PreRender_AntiAliasFilterPixel(PreRender* this, s32 x, s32 y);
+void PreRender_AntiAliasFilter(PreRender* this);
+u32 PreRender_Get5bMedian9(u8* px1, u8* px2, u8* px3);
+void PreRender_DivotFilter(PreRender* this);
+void PreRender_ApplyFilters(PreRender* this);
+void PreRender_ApplyFiltersSlowlyInit(PreRender* this);
+void PreRender_ApplyFiltersSlowlyDestroy(PreRender* this);
+void func_801720C4(PreRender* this);
+void Prerender_DrawBackground2D(Gfx** gfxp, void* timg, void* tlut, u16 width, u16 height, u8 fmt, u8 siz, u16 tt, u16 tlutCount, f32 x, f32 y, f32 xScale, f32 yScale, u32 flags);
+
+#endif

spec

@@ -547,7 +547,6 @@ beginseg
     include "build/src/code/z_play.o"
     include "build/src/code/z_play_hireso.o"
     include "build/src/code/PreRender.o"
-    include "build/data/code/PreRender.bss.o"
     include "build/src/code/TwoHeadGfxArena.o"
     include "build/src/code/TwoHeadArena.o"
     include "build/src/code/audio_stop_all_sfx.o"

src/code/listalloc.c

@@ -1,4 +1,4 @@
-#include "global.h"
+#include "listalloc.h"
 #include "system_malloc.h"
 
 ListAlloc* ListAlloc_Init(ListAlloc* this) {

src/code/z_actor.c

@@ -2892,7 +2892,7 @@ void Actor_DrawLensActors(PlayState* play, s32 numLensActors, Actor** lensActors
                              play->pauseBgPreRender.fbuf);
 
             gfxTemp = gfx;
-            func_8016FDB8(&play->pauseBgPreRender, &gfxTemp, spA4, zbuffer, 1);
+            PreRender_CopyImage(&play->pauseBgPreRender, &gfxTemp, spA4, zbuffer, true);
             gfx = gfxTemp;
         }
 

src/code/z_lifemeter.c

@@ -1,4 +1,3 @@
-#include "prevent_bss_reordering.h"
 #include "global.h"
 #include "overlays/kaleido_scope/ovl_kaleido_scope/z_kaleido_scope.h"
 #include "interface/parameter_static/parameter_static.h"

src/code/z_play.c

@@ -83,7 +83,7 @@ void Play_DrawMotionBlur(PlayState* this) {
             sMotionBlurStatus = MOTION_BLUR_PROCESS;
         }
 
-        func_801705B4(&this->pauseBgPreRender, &gfx);
+        PreRender_SaveFramebuffer(&this->pauseBgPreRender, &gfx);
 
         gSPEndDisplayList(gfx++);
 
@@ -1267,8 +1267,8 @@ void Play_DrawMain(PlayState* this) {
             if (R_PAUSE_BG_PRERENDER_STATE == PAUSE_BG_PRERENDER_READY) {
                 Gfx* sp8C = POLY_OPA_DISP;
 
-                if (this->pauseBgPreRender.unk_4D == 2) {
-                    func_80170B28(&this->pauseBgPreRender, &sp8C);
+                if (this->pauseBgPreRender.filterState == PRERENDER_FILTER_STATE_DONE) {
+                    PreRender_RestoreFramebuffer(&this->pauseBgPreRender, &sp8C);
                 } else {
                     func_80170798(&this->pauseBgPreRender, &sp8C);
                 }
@@ -1405,10 +1405,10 @@ void Play_DrawMain(PlayState* this) {
                     this->pauseBgPreRender.cvgSave = NULL;
                 }
 
-                func_801705B4(&this->pauseBgPreRender, &sp74);
+                PreRender_SaveFramebuffer(&this->pauseBgPreRender, &sp74);
 
                 if (this->pauseBgPreRender.cvgSave != NULL) {
-                    func_80170730(&this->pauseBgPreRender, &sp74);
+                    PreRender_DrawCoverage(&this->pauseBgPreRender, &sp74);
                 }
 
                 gSPEndDisplayList(sp74++);

src/overlays/actors/ovl_Dm_Char01/z_dm_char01.c

@@ -4,6 +4,7 @@
  * Description: Woodfall scene objects (temple, water, walls, etc)
  */
 
+#include "prevent_bss_reordering.h"
 #include "z_dm_char01.h"
 #include "objects/object_mtoride/object_mtoride.h"
 #include "overlays/actors/ovl_Obj_Etcetera/z_obj_etcetera.h"

tools/disasm/functions.txt

@@ -3057,28 +3057,28 @@
     0x8016FD2C:("PreRender_Init",),
     0x8016FD60:("PreRender_SetValues",),
     0x8016FD94:("PreRender_Destroy",),
-    0x8016FDB8:("func_8016FDB8",),
-    0x8016FF70:("func_8016FF70",),
+    0x8016FDB8:("PreRender_CopyImage",),
+    0x8016FF70:("PreRender_RestoreBuffer",),
     0x8016FF90:("func_8016FF90",),
     0x80170200:("func_80170200",),
-    0x8017023C:("func_8017023C",),
-    0x8017057C:("func_8017057C",),
-    0x801705B4:("func_801705B4",),
-    0x801705EC:("func_801705EC",),
-    0x80170730:("func_80170730",),
-    0x80170774:("func_80170774",),
+    0x8017023C:("PreRender_CoverageRgba16ToI8",),
+    0x8017057C:("PreRender_SaveZBuffer",),
+    0x801705B4:("PreRender_SaveFramebuffer",),
+    0x801705EC:("PreRender_FetchFbufCoverage",),
+    0x80170730:("PreRender_DrawCoverage",),
+    0x80170774:("PreRender_RestoreZBuffer",),
     0x80170798:("func_80170798",),
     0x80170AE0:("func_80170AE0",),
-    0x80170B28:("func_80170B28",),
-    0x80170B4C:("PreRender_AntiAliasAlgorithm",),
-    0x8017160C:("PreRender_ApplyAntiAliasingFilter",),
-    0x801716C4:("func_801716C4",),
-    0x801717F8:("func_801717F8",),
+    0x80170B28:("PreRender_RestoreFramebuffer",),
+    0x80170B4C:("PreRender_AntiAliasFilterPixel",),
+    0x8017160C:("PreRender_AntiAliasFilter",),
+    0x801716C4:("PreRender_Get5bMedian9",),
+    0x801717F8:("PreRender_DivotFilter",),
     0x80171F4C:("PreRender_ApplyFilters",),
     0x80171FA8:("PreRender_ApplyFiltersSlowlyInit",),
     0x80172078:("PreRender_ApplyFiltersSlowlyDestroy",),
     0x801720C4:("func_801720C4",),
-    0x801720FC:("func_801720FC",),
+    0x801720FC:("Prerender_DrawBackground2DImpl",),
     0x80172758:("Prerender_DrawBackground2D",),
     0x801727F0:("THGA_Init",),
     0x80172810:("THGA_Destroy",),

tools/disasm/variables.txt

@@ -4021,7 +4021,7 @@
     0x801F6DFC:("sBombersNotebookOpen","u8","",0x1),
     0x801F6DFD:("sMotionBlurStatus","UNK_TYPE1","",0x1),
     0x801F6E00:("sSlowlyMgr","SlowlyMgr","",0x1c0),
-    0x801F6FC0:("D_801F6FC0","UNK_TYPE1","",0x1),
+    0x801F6FC0:("sSlowlyRunning","UNK_TYPE1","",0x1),
     0x801F6FC8:("sSlowlyStackInfo","StackEntry","",0x1c),
     0x801F6FE8:("sSlowlyStack","u8","[4096]",0x1000),
     0x801F7FF0:("sGameSpeedMeter","SpeedMeter","", 0x20),

tools/sizes/code_functions.csv

@@ -2571,28 +2571,28 @@ asm/non_matchings/code/PreRender/PreRender_SetValuesSave.s,PreRender_SetValuesSa
 asm/non_matchings/code/PreRender/PreRender_Init.s,PreRender_Init,0x8016FD2C,0xD
 asm/non_matchings/code/PreRender/PreRender_SetValues.s,PreRender_SetValues,0x8016FD60,0xD
 asm/non_matchings/code/PreRender/PreRender_Destroy.s,PreRender_Destroy,0x8016FD94,0x9
-asm/non_matchings/code/PreRender/func_8016FDB8.s,func_8016FDB8,0x8016FDB8,0x6E
-asm/non_matchings/code/PreRender/func_8016FF70.s,func_8016FF70,0x8016FF70,0x8
+asm/non_matchings/code/PreRender/PreRender_CopyImage.s,PreRender_CopyImage,0x8016FDB8,0x6E
+asm/non_matchings/code/PreRender/PreRender_RestoreBuffer.s,PreRender_RestoreBuffer,0x8016FF70,0x8
 asm/non_matchings/code/PreRender/func_8016FF90.s,func_8016FF90,0x8016FF90,0x9C
 asm/non_matchings/code/PreRender/func_80170200.s,func_80170200,0x80170200,0xF
-asm/non_matchings/code/PreRender/func_8017023C.s,func_8017023C,0x8017023C,0xD0
-asm/non_matchings/code/PreRender/func_8017057C.s,func_8017057C,0x8017057C,0xE
-asm/non_matchings/code/PreRender/func_801705B4.s,func_801705B4,0x801705B4,0xE
-asm/non_matchings/code/PreRender/func_801705EC.s,func_801705EC,0x801705EC,0x51
-asm/non_matchings/code/PreRender/func_80170730.s,func_80170730,0x80170730,0x11
-asm/non_matchings/code/PreRender/func_80170774.s,func_80170774,0x80170774,0x9
+asm/non_matchings/code/PreRender/PreRender_CoverageRgba16ToI8.s,PreRender_CoverageRgba16ToI8,0x8017023C,0xD0
+asm/non_matchings/code/PreRender/PreRender_SaveZBuffer.s,PreRender_SaveZBuffer,0x8017057C,0xE
+asm/non_matchings/code/PreRender/PreRender_SaveFramebuffer.s,PreRender_SaveFramebuffer,0x801705B4,0xE
+asm/non_matchings/code/PreRender/PreRender_FetchFbufCoverage.s,PreRender_FetchFbufCoverage,0x801705EC,0x51
+asm/non_matchings/code/PreRender/PreRender_DrawCoverage.s,PreRender_DrawCoverage,0x80170730,0x11
+asm/non_matchings/code/PreRender/PreRender_RestoreZBuffer.s,PreRender_RestoreZBuffer,0x80170774,0x9
 asm/non_matchings/code/PreRender/func_80170798.s,func_80170798,0x80170798,0xD2
 asm/non_matchings/code/PreRender/func_80170AE0.s,func_80170AE0,0x80170AE0,0x12
-asm/non_matchings/code/PreRender/func_80170B28.s,func_80170B28,0x80170B28,0x9
-asm/non_matchings/code/PreRender/PreRender_AntiAliasAlgorithm.s,PreRender_AntiAliasAlgorithm,0x80170B4C,0x2B0
-asm/non_matchings/code/PreRender/PreRender_ApplyAntiAliasingFilter.s,PreRender_ApplyAntiAliasingFilter,0x8017160C,0x2E
-asm/non_matchings/code/PreRender/func_801716C4.s,func_801716C4,0x801716C4,0x4D
-asm/non_matchings/code/PreRender/func_801717F8.s,func_801717F8,0x801717F8,0x1D5
+asm/non_matchings/code/PreRender/PreRender_RestoreFramebuffer.s,PreRender_RestoreFramebuffer,0x80170B28,0x9
+asm/non_matchings/code/PreRender/PreRender_AntiAliasFilterPixel.s,PreRender_AntiAliasFilterPixel,0x80170B4C,0x2B0
+asm/non_matchings/code/PreRender/PreRender_AntiAliasFilter.s,PreRender_AntiAliasFilter,0x8017160C,0x2E
+asm/non_matchings/code/PreRender/PreRender_Get5bMedian9.s,PreRender_Get5bMedian9,0x801716C4,0x4D
+asm/non_matchings/code/PreRender/PreRender_DivotFilter.s,PreRender_DivotFilter,0x801717F8,0x1D5
 asm/non_matchings/code/PreRender/PreRender_ApplyFilters.s,PreRender_ApplyFilters,0x80171F4C,0x17
 asm/non_matchings/code/PreRender/PreRender_ApplyFiltersSlowlyInit.s,PreRender_ApplyFiltersSlowlyInit,0x80171FA8,0x34
 asm/non_matchings/code/PreRender/PreRender_ApplyFiltersSlowlyDestroy.s,PreRender_ApplyFiltersSlowlyDestroy,0x80172078,0x13
 asm/non_matchings/code/PreRender/func_801720C4.s,func_801720C4,0x801720C4,0xE
-asm/non_matchings/code/PreRender/func_801720FC.s,func_801720FC,0x801720FC,0x197
+asm/non_matchings/code/PreRender/Prerender_DrawBackground2DImpl.s,Prerender_DrawBackground2DImpl,0x801720FC,0x197
 asm/non_matchings/code/PreRender/Prerender_DrawBackground2D.s,Prerender_DrawBackground2D,0x80172758,0x26
 asm/non_matchings/code/TwoHeadGfxArena/THGA_Init.s,THGA_Init,0x801727F0,0x8
 asm/non_matchings/code/TwoHeadGfxArena/THGA_Destroy.s,THGA_Destroy,0x80172810,0x8