Implement generic-tranmap system

Author: MrAlaux

CHANGELOG.md

@@ -1,49 +1,13 @@
 ## New Features
 
-- **_Slow Motion_ button**
-- **Extra gibbing with high-damage projectiles and BFG tracers**
-- **_Group Repeated Messages_ setting**
-- **_'TRAILS'_ cheat**, to show hitscan trails
-- **Color settings** from International Doom
+None.
 
 ## Changes
 
-- **Merged changes from the following Woof! releases:**
-  - [Woof! 15.0.0](https://github.com/fabiangreffrath/woof/releases/tag/woof_15.0.0), note:
-    - NUGHUD now partially uses SBARDEF as its backend, which may cause some rendering differences
-    - Integrated periodic auto saves into the save/load menus
-    - Maintained key blink, message list, message duration, and chat-message duration settings [1]
-    - Turned optional vertical layout for _Stats_ and _Coordinates_ widgets into SBARDEF fields
-    - Removed `show_ssg` (now default behavior), `alt_arms` and `hud_highlight_weapon` settings
-    - Renamed `#_bobbing_percentage` to `#_bobbing_pct` [2]
-    - Renamed `show_berserk` to `sts_show_berserk` [2]
-    - Moved `sts_show_berserk` menu item to _Status Bar/HUD_ setup menu
-    - Revised the descriptions of many of Nugget's new CVARs
-  - [Woof! 15.0.1](https://github.com/fabiangreffrath/woof/releases/tag/woof_15.0.1)
-  - Also merged the ouch-face fix from Woof! post-15.0.1
-- **Messages in the message list now have individual durations**
-- **Made the minimap customizable through SBARDEF and NUGHUD**
-- **Improved FOV-based sky stretching**
-- **Smoother FOV effects**
-- **Allowed orbiting around freecam mobj**
-- **Replaced `translucent_pspr(_pct)` with `pspr_translucency_pct`** [2]
-- **Made _Screen Wipe Speed Percentage_ setting affect the _Fizzle_ fade**
-- **Raised maximum _Rewind Depth_ to 3000**
-- **Gave shadow to the _Pause_ graphic when using _HUD/Menu Shadows_**
-- **Removed _Physical [Weapon] Recoil_ menu item**
+- Nugget's translucency features now use translucency maps from a shared pool,
+  potentially improving program startup time in exchange for stutters
+  when enabling said features for the first time since launch
 
 ## Bug Fixes
 
-- **Desync involving lost-soul charge attack**
-- **Potential recursive spawning of blood splats when crushing with _Bloodier Gibbing_ enabled** (fixes `strg.wad`)
-- **FOV going below 1 degree and beyond 180 degrees**
-- **_Double autoaim range_ setting doubling range of BFG tracers**
-- **FOV effects disabling interpolation of weapon sprites**
-- **Crash when loading WADs with empty lumps between `C_#` markers** (fixes `nt_rc1.wad`)
-- **Characters not being drawn near right side of the screen in setup menus**
-- **Shadows not being drawn for HUD icons when using Boom font**
-- **Enemies potentially firing explosive-hitscan shots**
-
-**[1].** Not necessarily with the same CVARs; existing config files may be affected.
-
-**[2].** This will affect existing config files.
+None.

src/hu_crosshair.c

@@ -272,6 +272,7 @@ void HU_DrawCrosshair(void)
 
     // [Nugget] NUGHUD
     const int y = crosshair.y + (nughud.viewoffset * STRICTMODE(ST_GetNughudOn()));
+    byte *const xhair_tranmap = R_GetGenericTranMap(hud_crosshair_tran_pct);
 
     if (crosshair.patch)
     {

src/mn_setup.c

@@ -1934,7 +1934,7 @@ static void NuggetResetWeaponInertia(void)
 
 void WeaponFlashTrans(void)
 {
-    R_InitTranMapEx(&pspr_tranmap, pspr_translucency_pct);
+    R_GetGenericTranMap(pspr_translucency_pct);
 }
 
 static setup_menu_t weap_settings4[] =
@@ -2153,7 +2153,7 @@ static const char *hudcolor_strings[] = {
 // [Nugget] Translucent crosshair
 void CrosshairTrans(void)
 {
-    R_InitTranMapEx(&xhair_tranmap, hud_crosshair_tran_pct);
+    R_GetGenericTranMap(hud_crosshair_tran_pct);
 }
 
 #define XH_X (H_X - 13) // [Nugget] Tweaked
@@ -2370,7 +2370,8 @@ void MN_DrawStatusHUD(void)
         int y = M_Y + M_SPC + M_SPC / 2 - SHORT(patch->height) / 2 - 1; // [Nugget] Adjusted
 
         // [Nugget] Translucent crosshair
-        V_DrawPatchTRTL2(x, y, patch, colrngs[hud_crosshair_color], xhair_tranmap);
+        V_DrawPatchTRTL2(x, y, patch, colrngs[hud_crosshair_color],
+                         R_GetGenericTranMap(hud_crosshair_tran_pct));
     }
 
     // If the Reset Button has been selected, an "Are you sure?" message
@@ -3820,6 +3821,11 @@ setup_menu_t gen_settings7[] = {
 
 // Page 8 --------------------------------------------------------------------
 
+static void ShadowTrans(void)
+{
+  R_GetGenericTranMap(hud_menu_shadows_filter_pct);
+}
+
 static const char *fake_contrast_strings[] = {
   "Off", "Smooth", "Vanilla", NULL
 };
@@ -3832,7 +3838,7 @@ setup_menu_t gen_settings8[] = {
 
     {"Backdrop For All Menus",       S_ONOFF,                 N_X, M_SPC, {"menu_background_all"}},
     {"No Palette Tint in Menus",     S_ONOFF |S_STRICT,       N_X, M_SPC, {"no_menu_tint"}},
-    {"HUD/Menu Shadows",             S_ONOFF,                 N_X, M_SPC, {"hud_menu_shadows"}},
+    {"HUD/Menu Shadows",             S_ONOFF,                 N_X, M_SPC, {"hud_menu_shadows"}, .action = ShadowTrans},
     {"Flip Levels",                  S_ONOFF,                 N_X, M_SPC, {"flip_levels"}},
     {"No Berserk Tint",              S_ONOFF |S_STRICT,       N_X, M_SPC, {"no_berserk_tint"}},
     {"No Radiation Suit Tint",       S_ONOFF |S_STRICT,       N_X, M_SPC, {"no_radsuit_tint"}},

src/p_map.c

@@ -51,6 +51,7 @@
 #include <math.h>
 #include "g_game.h"
 #include "p_tick.h"
+#include "r_data.h"
 
 static mobj_t    *tmthing;
 static int       tmflags;
@@ -152,7 +153,7 @@ void P_SpawnHitscanTrail(fixed_t x, fixed_t y, fixed_t z,
     puff->alttics += (P_AproxDistance(xdist, ydist) >> FRACBITS) / 128;
 
     puff->flags |= MF_NOGRAVITY;
-    puff->tranmap = trail_tranmap;
+    puff->tranmap = R_GetGenericTranMap(25);
   }
 }
 

src/r_data.c

@@ -52,6 +52,91 @@
 // [Nugget]
 #include "hu_crosshair.h"
 
+// [Nugget] /-----------------------------------------------------------------
+
+// Brought from below
+#define TSC 12        /* number of fixed point digits in filter percent */
+
+static byte *R_InitGenericTranMap(const int filter_pct)
+{
+  I_Printf(VB_DEBUG, "R_InitGenericTranMap: %i%%", filter_pct);
+
+  unsigned char *const playpal = W_CacheLumpName("PLAYPAL", PU_STATIC);
+
+  long pal[3][256], pal_w1[3][256], tot[256];
+
+  const long w1 = ((unsigned long) filter_pct << TSC) / 100;
+
+  {
+    register int i = 255;
+    register const unsigned char *p = playpal + 255*3;
+
+    do {
+      register long t, d;
+
+      pal_w1[0][i] = (pal[0][i] = t = p[0]) * w1;
+      d = t*t;
+
+      pal_w1[1][i] = (pal[1][i] = t = p[1]) * w1;
+      d += t*t;
+
+      pal_w1[2][i] = (pal[2][i] = t = p[2]) * w1;
+      d += t*t;
+      p -= 3;
+
+      tot[i] = d << (TSC - 1);
+    } while (--i >= 0);
+  }
+
+  const long w2 = (1l << TSC) - w1;
+  byte *tmap = Z_Malloc(256*256, PU_STATIC, 0), *tp = tmap;
+
+  for (int i = 0;  i < 256;  i++)
+  {
+    const long r1 = pal[0][i] * w2;
+    const long g1 = pal[1][i] * w2;
+    const long b1 = pal[2][i] * w2;
+
+    for (int j = 0;  j < 256;  j++, tp++)
+    {
+      register int color = 255;
+      register long err;
+
+      const long r = pal_w1[0][j] + r1,
+                 g = pal_w1[1][j] + g1,
+                 b = pal_w1[2][j] + b1;
+
+      long best = LONG_MAX;
+
+      do {
+        if ((err = tot[color] - pal[0][color]*r - pal[1][color]*g - pal[2][color]*b) < best)
+        {
+          best = err;
+          *tp = color;
+        }
+      } while (--color >= 0);
+    }
+  }
+
+  Z_ChangeTag(playpal, PU_CACHE);
+
+  return tmap;
+}
+
+// 0% and 100% are trivial, but we'll allow them for now
+static byte *generic_tranmaps[101] = { NULL };
+
+byte *R_GetGenericTranMap(const int filter_pct)
+{
+  byte **const tmap = &generic_tranmaps[filter_pct];
+
+  if (!*tmap) { *tmap = R_InitGenericTranMap(filter_pct); }
+
+  return *tmap;
+}
+
+// [Nugget] -----------------------------------------------------------------/
+
 //
 // Graphics.
 // DOOM graphics for walls and sprites
@@ -933,7 +1018,7 @@ int R_ColormapNumForName(const char *name)
 
 int tran_filter_pct = 66;       // filter percent
 
-#define TSC 12        /* number of fixed point digits in filter percent */
+// [Nugget] Moved `TSC` macro above
 
 void R_InitTranMap(int progress)
 {
@@ -1079,71 +1164,6 @@ void R_InitTranMap(int progress)
   }
 }
 
-// [Nugget]
-void R_InitTranMapEx(byte **const tmap, const int filter_pct)
-{
-  if (*tmap == NULL) { *tmap = Z_Malloc(256*256, PU_STATIC, 0); }
-
-  long pal[3][256], tot[256], pal_w1[3][256];
-
-  long w1 = ((unsigned long) filter_pct << TSC) / 100;
-  long w2 = (1l << TSC) - w1;
-
-  unsigned char *const playpal = W_CacheLumpName("PLAYPAL", PU_STATIC);
-
-  {
-    register int i = 255;
-    register const unsigned char *p = playpal + 255*3;
-
-    do {
-      register long t, d;
-
-      pal_w1[0][i] = (pal[0][i] = t = p[0]) * w1;
-      d = t*t;
-
-      pal_w1[1][i] = (pal[1][i] = t = p[1]) * w1;
-      d += t*t;
-
-      pal_w1[2][i] = (pal[2][i] = t = p[2]) * w1;
-      d += t*t;
-      p -= 3;
-
-      tot[i] = d << (TSC - 1);
-    } while (--i >= 0);
-  }
-
-  byte *tp = *tmap;
-
-  for (int i = 0;  i < 256;  i++)
-  {
-    long r1 = pal[0][i] * w2;
-    long g1 = pal[1][i] * w2;
-    long b1 = pal[2][i] * w2;
-
-    for (int j = 0;  j < 256;  j++, tp++)
-    {
-      register int color = 255;
-      register long err;
-
-      long r = pal_w1[0][j] + r1,
-           g = pal_w1[1][j] + g1,
-           b = pal_w1[2][j] + b1;
-
-      long best = LONG_MAX;
-
-      do {
-        if ((err = tot[color] - pal[0][color]*r - pal[1][color]*g - pal[2][color]*b) < best)
-        {
-          best = err;
-          *tp = color;
-        }
-      } while (--color >= 0);
-    }
-  }
-
-  Z_ChangeTag(playpal, PU_CACHE);
-}
-
 //
 // R_InitData
 // Locates all the lumps
@@ -1164,11 +1184,25 @@ void R_InitData(void)
     R_InitTranMap(1);                   // killough 2/21/98, 3/6/98
   R_InitColormaps();                    // killough 3/20/98
 
-  // [Nugget]
-  R_InitTranMapEx(&shadow_tranmap, hud_menu_shadows_filter_pct); // HUD/menu shadows
-  R_InitTranMapEx(&  pspr_tranmap, pspr_translucency_pct);       // Translucent flashes
-  R_InitTranMapEx(& xhair_tranmap, hud_crosshair_tran_pct);      // Translucent crosshair
-  R_InitTranMapEx(& trail_tranmap, 25);
+  // [Nugget] ----------------------------------------------------------------
+
+  // These could be initialized just in time, upon being requested,
+  // but if we can already guess that they'll be used,
+  // we initialize them in advance to prevent stutters later
+
+  // HUD/menu shadows
+  if (hud_menu_shadows && hud_menu_shadows_filter_pct != 100)
+  { R_GetGenericTranMap(hud_menu_shadows_filter_pct); }
+
+  // Translucent flashes
+  if (pspr_translucency_pct != 100)
+  { R_GetGenericTranMap(pspr_translucency_pct); }
+
+  // Translucent crosshair
+  if (hud_crosshair_tran_pct != 100)
+  { R_GetGenericTranMap(hud_crosshair_tran_pct); }
+
+  R_GetGenericTranMap(25); // Hitscan trails
 }
 
 //

src/r_data.h

@@ -66,7 +66,7 @@ typedef enum
 
 extern invul_mode_t invul_mode;
 
-void R_InitTranMapEx(byte **const tmap, const int filter_pct); // [Nugget]
+byte *R_GetGenericTranMap(const int filter_pct); // [Nugget]
 
 #endif
 

src/r_things.c

@@ -940,7 +940,8 @@ void R_DrawPSprite (pspdef_t *psp, boolean translucent) // [Nugget] Translucent
   }
   vis->brightmap = R_BrightmapForState(psp->state - states);
 
-  vis->tranmap = translucent ? pspr_tranmap : NULL; // [Nugget] Translucent flashes
+  // [Nugget] Translucent flashes
+  vis->tranmap = translucent ? R_GetGenericTranMap(pspr_translucency_pct) : NULL;
 
   // interpolation for weapon bobbing
   if (uncapped)

src/v_video.c

@@ -162,11 +162,7 @@ int menu_backdrop_darkening;
 
 byte cr_allblack[256],
      cr_gray_vc[256],  // `V_Colorize()` only
-     nightvision[256], // Night-vision visor
-     *shadow_tranmap,  // HUD/menu shadows
-     *pspr_tranmap,    // Translucent flashes
-     *xhair_tranmap,   // Translucent crosshair
-     *trail_tranmap;
+     nightvision[256]; // Night-vision visor
 
 // [Nugget] -----------------------------------------------------------------/
 
@@ -669,7 +665,12 @@ void V_DrawPatchShadowed(int x, int y, struct patch_s *patch, boolean flipped,
     if (hud_menu_shadows && drawshadows)
     {
       drawingshadow = true;
-      V_DrawPatchTranslucent2(x + 1, y + 1, patch, flipped, cr_allblack, NULL, shadow_tranmap);
+
+      V_DrawPatchTranslucent2(
+        x + 1, y + 1, patch, flipped, cr_allblack, NULL,
+        R_GetGenericTranMap(hud_menu_shadows_filter_pct)
+      );
+
       drawingshadow = false;
     }
 
@@ -869,7 +870,7 @@ void V_ShadowRect(int x, int y, int width, int height)
         {
           byte *const d = &dest[x];
 
-          *d = shadow_tranmap[*d << 8];
+          *d = R_GetGenericTranMap(hud_menu_shadows_filter_pct)[*d << 8];
         }
 
         dest += linesize;