3.0 - Microcode overhaul

.gitignore

@@ -2157,8 +2157,6 @@ lib/libs2d_engine.a
 !/lib/n64/*.a
 !/lib/ique/*.a
 
-!/lib/PR/hvqm/*.o
-
 # .orig files
 *.orig
 

Makefile

@@ -30,10 +30,8 @@ CONSOLE ?= n64
 $(eval $(call validate-option,CONSOLE,n64 bb))
 
 ifeq      ($(CONSOLE),n64)
-  INCLUDE_DIRS   += include/n64
   LIBS_DIR       := lib/n64
 else ifeq ($(CONSOLE),bb)
-  INCLUDE_DIRS   += include/ique
   LIBS_DIR       := lib/ique
   DEFINES        += BBPLAYER=1
 endif
@@ -94,42 +92,6 @@ DEBUG_MAP_STACKTRACE_FLAG := -D DEBUG_MAP_STACKTRACE
 
 TARGET := sm64
 
-
-# GRUCODE - selects which RSP microcode to use.
-#   f3dex   -
-#   f3dex2  -
-#   l3dex2  - F3DEX2 version that only renders in wireframe
-#   f3dzex  - newer, experimental microcode used in Animal Crossing
-#   super3d - extremely experimental version of Fast3D lacking many features for speed
-GRUCODE ?= f3dzex
-$(eval $(call validate-option,GRUCODE,f3dex f3dex2 f3dex2pl f3dzex super3d l3dex2))
-
-ifeq ($(GRUCODE),f3dex) # Fast3DEX
-  DEFINES += F3DEX_GBI=1 F3DEX_GBI_SHARED=1
-else ifeq ($(GRUCODE),f3dex2) # Fast3DEX2
-  DEFINES += F3DEX_GBI_2=1 F3DEX_GBI_SHARED=1
-else ifeq ($(GRUCODE),l3dex2) # Line3DEX2
-  DEFINES += L3DEX2_GBI=1 L3DEX2_ALONE=1 F3DEX_GBI_2=1 F3DEX_GBI_SHARED=1
-else ifeq ($(GRUCODE),f3dex2pl) # Fast3DEX2_PosLight
-  DEFINES += F3DEX2PL_GBI=1 F3DEX_GBI_2=1 F3DEX_GBI_SHARED=1
-else ifeq ($(GRUCODE),f3dzex) # Fast3DZEX (2.08J / Animal Forest - Dōbutsu no Mori)
-  DEFINES += F3DZEX_NON_GBI_2=1 F3DEX_GBI_2=1 F3DEX_GBI_SHARED=1
-else ifeq ($(GRUCODE),super3d) # Super3D
-  $(warning Super3D is experimental. Try at your own risk.)
-  DEFINES += SUPER3D_GBI=1 F3D_NEW=1
-endif
-
-# TEXT ENGINES
-#   s2dex_text_engine - Text Engine by someone2639
-TEXT_ENGINE := none
-$(eval $(call validate-option,TEXT_ENGINE,none s2dex_text_engine))
-
-ifeq ($(TEXT_ENGINE), s2dex_text_engine)
-  DEFINES += S2DEX_GBI_2=1 S2DEX_TEXT_ENGINE=1
-  SRC_DIRS += src/s2d_engine
-endif
-# add more text engines here
-
 #==============================================================================#
 # Optimization flags                                                           #
 #==============================================================================#
@@ -243,15 +205,6 @@ else
   DEFINES += _FINALROM=1 NDEBUG=1 OVERWRITE_OSPRINT=0
 endif
 
-# HVQM - whether to use HVQM fmv library
-#   1 - includes code in ROM
-#   0 - does not
-HVQM ?= 0
-$(eval $(call validate-option,HVQM,0 1))
-ifeq ($(HVQM),1)
-  DEFINES += HVQM=1
-  SRC_DIRS += src/hvqm
-endif
 
 # LIBPL - whether to include libpl library for interfacing with Parallel Launcher
 # (library will be pulled into repo after building with this enabled for the first time)
@@ -422,8 +375,7 @@ SOUND_SEQUENCE_FILES := \
 O_FILES := $(foreach file,$(C_FILES),$(BUILD_DIR)/$(file:.c=.o)) \
            $(foreach file,$(CPP_FILES),$(BUILD_DIR)/$(file:.cpp=.o)) \
            $(foreach file,$(S_FILES),$(BUILD_DIR)/$(file:.s=.o)) \
-           $(foreach file,$(GENERATED_C_FILES),$(file:.c=.o)) \
-           lib/PR/hvqm/hvqm2sp1.o lib/PR/hvqm/hvqm2sp2.o
+           $(foreach file,$(GENERATED_C_FILES),$(file:.c=.o))
 
 LIBZ_O_FILES := $(foreach file,$(LIBZ_C_FILES),$(BUILD_DIR)/$(file:.c=.o))
 GODDARD_O_FILES := $(foreach file,$(GODDARD_C_FILES),$(BUILD_DIR)/$(file:.c=.o))
@@ -454,7 +406,7 @@ else
   $(error Unable to detect a suitable MIPS toolchain installed)
 endif
 
-LIBRARIES := nustd hvqm2 z goddard
+LIBRARIES := nustd z goddard
 
 LINK_LIBRARIES = $(foreach i,$(LIBRARIES),-l$(i))
 
@@ -492,15 +444,10 @@ ifeq ($(LD), tools/mips64-elf-ld)
   endif
 endif
 
-ifeq ($(TARGET_N64),1)
-  TARGET_CFLAGS := -nostdinc -DTARGET_N64 -D_LANGUAGE_C
-  CC_CFLAGS := -fno-builtin
-endif
+TARGET_CFLAGS := -nostdinc -DTARGET_N64 -D_LANGUAGE_C
+CC_CFLAGS := -fno-builtin
 
-INCLUDE_DIRS += include $(BUILD_DIR) $(BUILD_DIR)/include src . include/hvqm
-ifeq ($(TARGET_N64),1)
-  INCLUDE_DIRS += include/libc
-endif
+INCLUDE_DIRS := include include/n64 include/libc $(BUILD_DIR) $(BUILD_DIR)/include src .
 
 C_DEFINES := $(foreach d,$(DEFINES),-D$(d))
 DEF_INC_CFLAGS := $(foreach i,$(INCLUDE_DIRS),-I$(i)) $(C_DEFINES)
@@ -598,10 +545,6 @@ endef
 all: $(ROM)
 	@$(SHA1SUM) $(ROM)
 	@$(PRINT) "${BLINK}Build succeeded.\n$(NO_COL)"
-	@$(PRINT) "==== Build Options ====$(NO_COL)\n"
-	@$(PRINT) "${GREEN}Version:        $(BLUE)$(VERSION)$(NO_COL)\n"
-	@$(PRINT) "${GREEN}Microcode:      $(BLUE)$(GRUCODE)$(NO_COL)\n"
-	@$(PRINT) "${GREEN}Console:        $(BLUE)$(CONSOLE)$(NO_COL)\n"
 
 clean:
 	$(RM) -r $(BUILD_DIR_BASE)
@@ -643,7 +586,6 @@ patch: $(ROM)
 $(BUILD_DIR)/asm/ipl3.o:              $(IPL3_RAW_FILES)
 $(BUILD_DIR)/src/game/crash_screen.o: $(CRASH_TEXTURE_C_FILES)
 $(BUILD_DIR)/src/game/version.o:      $(BUILD_DIR)/src/game/version_data.h
-$(BUILD_DIR)/lib/aspMain.o:           $(BUILD_DIR)/rsp/audio.bin
 $(SOUND_BIN_DIR)/sound_data.o:        $(SOUND_BIN_DIR)/sound_data.ctl $(SOUND_BIN_DIR)/sound_data.tbl $(SOUND_BIN_DIR)/sequences.bin $(SOUND_BIN_DIR)/bank_sets
 $(BUILD_DIR)/levels/scripts.o:        $(BUILD_DIR)/include/level_headers.h
 
@@ -846,11 +788,6 @@ $(BUILD_DIR)/%.o: %.s
 	$(call print,Assembling:,$<,$@)
 	$(V)$(CROSS)gcc -c $(ASMFLAGS) $(foreach i,$(INCLUDE_DIRS),-Wa,-I$(i)) -x assembler-with-cpp -MMD -MF $(BUILD_DIR)/$*.d  -o $@ $<
 
-# Assemble RSP assembly code
-$(BUILD_DIR)/rsp/%.bin $(BUILD_DIR)/rsp/%_data.bin: rsp/%.s
-	$(call print,Assembling:,$<,$@)
-	$(V)$(RSPASM) -sym $@.sym $(RSPASMFLAGS) -strequ CODE_FILE $(BUILD_DIR)/rsp/$*.bin -strequ DATA_FILE $(BUILD_DIR)/rsp/$*_data.bin $<
-
 # Run linker script through the C preprocessor
 $(BUILD_DIR)/$(LD_SCRIPT): $(LD_SCRIPT) $(BUILD_DIR)/goddard.txt
 	$(call print,Preprocessing linker script:,$<,$@)

README.md

@@ -31,11 +31,20 @@ This is a fork of the ultrasm64 repo by CrashOveride which includes the followin
 - **anonymous_moose**: porting falco's extended bounds to decomp
 - **tuxlovesyou**: `LOAD_MIO0_TEXTURE` macro and moral support
 - **devwizard**: the PJ64 pre-v3.0 detection part of the emulator detector
+- **Sauraen**: Creating the F3DEX3 microcode. HackerSM64 implementation by red.
 
 Thanks to Frame#5375 and AloXado320 for also helping with silhouette stuff
 
-**Lighting Engine by Wiseguy**
-- Lighting Engine is available on a separate branch ([base/lighting-engine](https://github.com/Reonu/HackerSM64/tree/base/lighting-engine)). Instructions on how to use it are in the readme of that branch.
+**Lighting Engine by red**
+- A new lighting engine for the F3DEX3 is included with the repository. Enable `F3DEX3_LIGHTING_ENGINE` within `config_graphics.h` to use.
+- Improvements to the older lighting engine by wiseguy:
+    - Support for variable number of directional lights at once.
+    - Support for vanilla actors.
+        - Limits you to up to 7 extra lights when setup this way (`gLightNumBase = NUMLIGHTS_3`), but for scenes tailored specifically for a lighting engine (`gLightNumBase = NUMLIGHTS_1`), you can have up to 9 variable lights.
+        - Ambient light does not count towards the light limit.
+        - F3DEX3 fixes point lights with kc < 8, allowing for more expressive lighting.
+        - F3DEX3 also fixes point light behavior when close to triangles.
+- See `src/game/f3dex3.c` for more details.
 
 **Puppycam**
 - Puppycam is available on the master branch now, you can toggle it in `config/config_camera.h`. *
@@ -137,7 +146,6 @@ Thanks to Frame#5375 and AloXado320 for also helping with silhouette stuff
   This does mean that any framebuffer effects will have to be done on buffer 0 if targeting emulators
 - Automatic console and emulator detection: Use the `gEmulator` variable to wrap your code in an emulator check.
 - Separate defines for emulator and console black border height.
-- Getting HVQM FMV support to work with the game is WIP.
 
 Requirements are the same as regular SM64, however a GCC MIPS cross compiler is also required. If you're on Debian-like Linux, you can use the ``gcc-mips-linux-gnu`` package. The toolchain that comes with my SDK is also supported.
 

include/config/config_debug.h

@@ -94,3 +94,9 @@
  * Intentionally crash the game whenever a runtime assertion fails (also invoked by the DEBUG define in the Makefile).
  */
 #define DEBUG_ASSERTIONS
+
+/**
+ * Enable F3DEX3 profiling tool. Hold L + C Down to display and cycle through profiler views.
+ * Using pages 2, 3, and 4 can disable certain F3DEX3 features. Read the F3DEX3 README for more information.
+ */
+//  #define DEBUG_F3DEX3_PROFILER

include/config/config_graphics.h

@@ -152,3 +152,30 @@
  * Only use this if you can test the difference of your hack with and without this change on console.
  */
 // #define USE_FRUSTRATIO2
+
+/**
+ * Primary graphics microcode selection
+ * Define F3DEX_VERSION as one of the following to select the primary graphics microcode:
+ * 2 - F3DZEX2 - (Majora's Mask version). HLE emulator compatible, good console performance.
+ * 3 - F3DEX3  - Created by Sauraen. Better console performance in most situations.
+ * All microcodes provided by HackerSM64 use the "NoN" (no near-field clipping) variants.
+ * A built-in profiler is available for F3DEX3 and can be enabled inside config/config_debug.h
+ * under DEBUG_F3DEX3_PROFILER.
+ */
+#define F3DEX_VERSION 2
+
+/**
+ * Enables usage of the line microcode. It can be loaded with gSPLoadUcode within a display list.
+ * This feature is not available for use with F3DEX3.
+ */
+
+// #define ENABLE_LINE_UCODE
+
+/**
+ * Enables F3DEX3 point lighting engine.
+ * Replaces the lighting engine branch.
+ * See README.md and src/game/f3dex3.c for more details.
+ * NOTE: Game looks visually identical if not setup.
+ */
+#define F3DEX3_LIGHTING_ENGINE
+

include/config/config_safeguards.h

@@ -49,6 +49,33 @@
     #undef BETTER_REVERB
 #endif
 
+/*****************
+ * config_graphics.h
+ */
+
+#ifdef F3DEX_VERSION
+    #if F3DEX_VERSION == 2
+        #define F3DEX_GBI_2
+    #elif F3DEX_VERSION == 3
+        #define F3DEX_GBI_3
+    #else
+        #error "Invalid microcode selection. Valid options are 2-3 inclusive."
+    #endif
+#else
+    #error "F3DEX_VERSION is not defined in config/config_graphics.h"
+#endif
+
+#ifdef ENABLE_LINE_UCODE
+    #if F3DEX_VERSION > 2
+        #undef ENABLE_LINE_UCODE
+        #warning "F3DEX3 does not support ENABLE_LINE_UCODE, so it will be disabled."
+    #endif
+#endif
+
+#if !defined(F3DEX_GBI_3) && defined(F3DEX3_LIGHTING_ENGINE)
+    #undef F3DEX3_LIGHTING_ENGINE
+#endif // F3DEX3_LIGHTING_ENGINE
+
 /*****************
  * config_debug.h
  */
@@ -112,6 +139,15 @@
     #define UNLOCK_ALL
 #endif // COMPLETE_SAVE_FILE
 
+#ifdef DEBUG_F3DEX3_PROFILER
+    #ifdef F3DEX_GBI_3
+        #undef PUPPYPRINT
+        #define PUPPYPRINT
+    #else
+        #undef DEBUG_F3DEX3_PROFILER
+    #endif
+#endif // DEBUG_F3DEX3_PROFILER
+
 #ifdef DEBUG
     #undef DEBUG_ASSERTIONS
     #define DEBUG_ASSERTIONS
@@ -206,3 +242,4 @@
     #undef BORDER_HEIGHT_EMULATOR
     #define BORDER_HEIGHT_EMULATOR 0
 #endif // !TARGET_N64
+