remove prvm_boundscheck cvar (security hole) and force bounds check on unless DP...
[divverent/darkplaces.git] / palette.c
1
2 #include "quakedef.h"
3
4 cvar_t r_colormap_palette = {0, "r_colormap_palette", "gfx/colormap_palette.lmp", "name of a palette lmp file to override the shirt/pants colors of player models. It consists of 16 shirt colors, 16 scoreboard shirt colors, 16 pants colors and 16 scoreboard pants colors"};
5
6 unsigned char palette_rgb[256][3];
7 unsigned char palette_rgb_pantscolormap[16][3];
8 unsigned char palette_rgb_shirtcolormap[16][3];
9 unsigned char palette_rgb_pantsscoreboard[16][3];
10 unsigned char palette_rgb_shirtscoreboard[16][3];
11
12 unsigned int palette_bgra_complete[256];
13 unsigned int palette_bgra_font[256];
14 unsigned int palette_bgra_alpha[256];
15 unsigned int palette_bgra_nocolormap[256];
16 unsigned int palette_bgra_nocolormapnofullbrights[256];
17 unsigned int palette_bgra_nofullbrights[256];
18 unsigned int palette_bgra_onlyfullbrights[256];
19 unsigned int palette_bgra_pantsaswhite[256];
20 unsigned int palette_bgra_shirtaswhite[256];
21 unsigned int palette_bgra_transparent[256];
22 unsigned int palette_bgra_embeddedpic[256];
23
24 // John Carmack said the quake palette.lmp can be considered public domain because it is not an important asset to id, so I include it here as a fallback if no external palette file is found.
25 unsigned char host_quakepal[768] =
26 {
27 // marked: colormap colors: cb = (colormap & 0xF0);cb += (cb >= 128 && cb < 224) ? 4 : 12;
28 // 0x0*
29         0,0,0,        15,15,15,     31,31,31,     47,47,47,     63,63,63,     75,75,75,     91,91,91,     107,107,107,
30         123,123,123,  139,139,139,  155,155,155,  171,171,171,  187,187,187,  203,203,203,  219,219,219,  235,235,235,
31 // 0x1*                                                   0 ^
32         15,11,7,      23,15,11,     31,23,11,     39,27,15,     47,35,19,     55,43,23,     63,47,23,     75,55,27,
33         83,59,27,     91,67,31,     99,75,31,     107,83,31,    115,87,31,    123,95,35,    131,103,35,   143,111,35,
34 // 0x2*                                                   1 ^
35         11,11,15,     19,19,27,     27,27,39,     39,39,51,     47,47,63,     55,55,75,     63,63,87,     71,71,103,
36         79,79,115,    91,91,127,    99,99,139,    107,107,151,  115,115,163,  123,123,175,  131,131,187,  139,139,203,
37 // 0x3*                                                   2 ^
38         0,0,0,        7,7,0,        11,11,0,      19,19,0,      27,27,0,      35,35,0,      43,43,7,      47,47,7,
39         55,55,7,      63,63,7,      71,71,7,      75,75,11,     83,83,11,     91,91,11,     99,99,11,     107,107,15,
40 // 0x4*                                                   3 ^
41         7,0,0,        15,0,0,       23,0,0,       31,0,0,       39,0,0,       47,0,0,       55,0,0,       63,0,0,
42         71,0,0,       79,0,0,       87,0,0,       95,0,0,       103,0,0,      111,0,0,      119,0,0,      127,0,0,
43 // 0x5*                                                   4 ^
44         19,19,0,      27,27,0,      35,35,0,      47,43,0,      55,47,0,      67,55,0,      75,59,7,      87,67,7,
45         95,71,7,      107,75,11,    119,83,15,    131,87,19,    139,91,19,    151,95,27,    163,99,31,    175,103,35,
46 // 0x6*                                                   5 ^
47         35,19,7,      47,23,11,     59,31,15,     75,35,19,     87,43,23,     99,47,31,     115,55,35,    127,59,43,
48         143,67,51,    159,79,51,    175,99,47,    191,119,47,   207,143,43,   223,171,39,   239,203,31,   255,243,27,
49 // 0x7*                                                   6 ^
50         11,7,0,       27,19,0,      43,35,15,     55,43,19,     71,51,27,     83,55,35,     99,63,43,     111,71,51,
51         127,83,63,    139,95,71,    155,107,83,   167,123,95,   183,135,107,  195,147,123,  211,163,139,  227,179,151,
52 // 0x8*                                                   7 ^        v 8
53         171,139,163,  159,127,151,  147,115,135,  139,103,123,  127,91,111,   119,83,99,    107,75,87,    95,63,75,
54         87,55,67,     75,47,55,     67,39,47,     55,31,35,     43,23,27,     35,19,19,     23,11,11,     15,7,7,
55 // 0x9*                                                   9 v
56         187,115,159,  175,107,143,  163,95,131,   151,87,119,   139,79,107,   127,75,95,    115,67,83,    107,59,75,
57         95,51,63,     83,43,55,     71,35,43,     59,31,35,     47,23,27,     35,19,19,     23,11,11,     15,7,7,
58 // 0xA*                                                  10 v
59         219,195,187,  203,179,167,  191,163,155,  175,151,139,  163,135,123,  151,123,111,  135,111,95,   123,99,83,
60         107,87,71,    95,75,59,     83,63,51,     67,51,39,     55,43,31,     39,31,23,     27,19,15,     15,11,7,
61 // 0xB*                                                  11 v
62         111,131,123,  103,123,111,  95,115,103,   87,107,95,    79,99,87,     71,91,79,     63,83,71,     55,75,63,
63         47,67,55,     43,59,47,     35,51,39,     31,43,31,     23,35,23,     15,27,19,     11,19,11,     7,11,7,
64 // 0xC*                                                  12 v
65         255,243,27,   239,223,23,   219,203,19,   203,183,15,   187,167,15,   171,151,11,   155,131,7,    139,115,7,
66         123,99,7,     107,83,0,     91,71,0,      75,55,0,      59,43,0,      43,31,0,      27,15,0,      11,7,0,
67 // 0xD*                                                  13 v
68         0,0,255,      11,11,239,    19,19,223,    27,27,207,    35,35,191,    43,43,175,    47,47,159,    47,47,143,
69         47,47,127,    47,47,111,    47,47,95,     43,43,79,     35,35,63,     27,27,47,     19,19,31,     11,11,15,
70 // 0xE*
71         43,0,0,       59,0,0,       75,7,0,       95,7,0,       111,15,0,     127,23,7,     147,31,7,     163,39,11,
72         183,51,15,    195,75,27,    207,99,43,    219,127,59,   227,151,79,   231,171,95,   239,191,119,  247,211,139,
73 // 0xF*                                                  14 ^
74         167,123,59,   183,155,55,   199,195,55,   231,227,87,   127,191,255,  171,231,255,  215,255,255,  103,0,0,
75         139,0,0,      179,0,0,      215,0,0,      255,0,0,      255,243,147,  255,247,199,  255,255,255,  159,91,83
76 }; //                                                    15 ^
77
78 void Palette_SetupSpecialPalettes(void)
79 {
80         int i;
81         int fullbright_start, fullbright_end;
82         int pants_start, pants_end;
83         int shirt_start, shirt_end;
84         int reversed_start, reversed_end;
85         int transparentcolor;
86         unsigned char *colormap;
87         fs_offset_t filesize;
88         union
89         {
90                 int i;
91                 unsigned char b[4];
92         }
93         u;
94
95         colormap = FS_LoadFile("gfx/colormap.lmp", tempmempool, true, &filesize);
96         if (colormap && filesize >= 16385)
97                 fullbright_start = 256 - colormap[16384];
98         else
99                 fullbright_start = 256;
100         if (colormap)
101                 Mem_Free(colormap);
102         fullbright_end = 256;
103         pants_start = 96;
104         pants_end = 112;
105         shirt_start = 16;
106         shirt_end = 32;
107         reversed_start = 128;
108         reversed_end = 224;
109         transparentcolor = 255;
110
111         for (i = 0;i < 256;i++)
112                 palette_bgra_transparent[i] = palette_bgra_complete[i];
113         palette_bgra_transparent[transparentcolor] = 0;
114
115         for (i = 0;i < fullbright_start;i++)
116                 palette_bgra_nofullbrights[i] = palette_bgra_complete[i];
117         for (i = fullbright_start;i < fullbright_end;i++)
118                 palette_bgra_nofullbrights[i] = palette_bgra_complete[0];
119
120         for (i = 0;i < 256;i++)
121                 palette_bgra_onlyfullbrights[i] = 0;
122         for (i = fullbright_start;i < fullbright_end;i++)
123                 palette_bgra_onlyfullbrights[i] = palette_bgra_complete[i];
124
125         for (i = 0;i < 256;i++)
126                 palette_bgra_nocolormapnofullbrights[i] = palette_bgra_complete[i];
127         for (i = pants_start;i < pants_end;i++)
128                 palette_bgra_nocolormapnofullbrights[i] = 0;
129         for (i = shirt_start;i < shirt_end;i++)
130                 palette_bgra_nocolormapnofullbrights[i] = 0;
131         for (i = fullbright_start;i < fullbright_end;i++)
132                 palette_bgra_nocolormapnofullbrights[i] = 0;
133
134         for (i = 0;i < 256;i++)
135                 palette_bgra_nocolormap[i] = palette_bgra_complete[i];
136         for (i = pants_start;i < pants_end;i++)
137                 palette_bgra_nocolormap[i] = 0;
138         for (i = shirt_start;i < shirt_end;i++)
139                 palette_bgra_nocolormap[i] = 0;
140
141         for (i = 0;i < 256;i++)
142                 palette_bgra_pantsaswhite[i] = 0;
143         for (i = pants_start;i < pants_end;i++)
144         {
145                 if (i >= reversed_start && i < reversed_end)
146                         palette_bgra_pantsaswhite[i] = palette_bgra_complete[15 - (i - pants_start)];
147                 else
148                         palette_bgra_pantsaswhite[i] = palette_bgra_complete[i - pants_start];
149         }
150
151         for (i = 0;i < 256;i++)
152                 palette_bgra_shirtaswhite[i] = 0;
153         for (i = shirt_start;i < shirt_end;i++)
154         {
155                 if (i >= reversed_start && i < reversed_end)
156                         palette_bgra_shirtaswhite[i] = palette_bgra_complete[15 - (i - shirt_start)];
157                 else
158                         palette_bgra_shirtaswhite[i] = palette_bgra_complete[i - shirt_start];
159         }
160
161         for (i = 0;i < 256;i++)
162                 palette_bgra_alpha[i] = 0xFFFFFFFF;
163         u.i = 0xFFFFFFFF;
164         u.b[3] = 0;
165         palette_bgra_alpha[transparentcolor] = u.i;
166
167         for (i = 0;i < 256;i++)
168                 palette_bgra_font[i] = palette_bgra_complete[i];
169         palette_bgra_font[0] = 0;
170 }
171
172 void BuildGammaTable8(float prescale, float gamma, float scale, float base, unsigned char *out, int rampsize)
173 {
174         int i, adjusted;
175         double invgamma;
176
177         invgamma = 1.0 / gamma;
178         prescale /= (double) (rampsize - 1);
179         for (i = 0;i < rampsize;i++)
180         {
181                 adjusted = (int) (255.0 * (pow((double) i * prescale, invgamma) * scale + base) + 0.5);
182                 out[i] = bound(0, adjusted, 255);
183         }
184 }
185
186 void BuildGammaTable16(float prescale, float gamma, float scale, float base, unsigned short *out, int rampsize)
187 {
188         int i, adjusted;
189         double invgamma;
190
191         invgamma = 1.0 / gamma;
192         prescale /= (double) (rampsize - 1);
193         for (i = 0;i < rampsize;i++)
194         {
195                 adjusted = (int) (65535.0 * (pow((double) i * prescale, invgamma) * scale + base) + 0.5);
196                 out[i] = bound(0, adjusted, 65535);
197         }
198 }
199
200 void Palette_Shutdown(void)
201 {
202 }
203
204 void Palette_NewMap(void)
205 {
206 }
207
208 void Palette_Load(void)
209 {
210         int i;
211         unsigned char *out;
212         float gamma, scale, base;
213         fs_offset_t filesize;
214         unsigned char *palfile;
215         unsigned char texturegammaramp[256];
216         union
217         {
218                 unsigned char b[4];
219                 unsigned int i;
220         }
221         bgra;
222
223         gamma = 1;
224         scale = 1;
225         base = 0;
226 // COMMANDLINEOPTION: Client: -texgamma <number> sets the quake palette gamma, allowing you to make quake textures brighter/darker, not recommended
227         i = COM_CheckParm("-texgamma");
228         if (i)
229                 gamma = atof(com_argv[i + 1]);
230 // COMMANDLINEOPTION: Client: -texcontrast <number> sets the quake palette contrast, allowing you to make quake textures brighter/darker, not recommended
231         i = COM_CheckParm("-texcontrast");
232         if (i)
233                 scale = atof(com_argv[i + 1]);
234 // COMMANDLINEOPTION: Client: -texbrightness <number> sets the quake palette brightness (brightness of black), allowing you to make quake textures brighter/darker, not recommended
235         i = COM_CheckParm("-texbrightness");
236         if (i)
237                 base = atof(com_argv[i + 1]);
238         gamma = bound(0.01, gamma, 10.0);
239         scale = bound(0.01, scale, 10.0);
240         base = bound(0, base, 0.95);
241
242         BuildGammaTable8(1.0f, gamma, scale, base, texturegammaramp, 256);
243
244         palfile = (unsigned char *)FS_LoadFile ("gfx/palette.lmp", tempmempool, false, &filesize);
245         if (palfile && filesize >= 768)
246                 memcpy(palette_rgb, palfile, 768);
247         else
248         {
249                 Con_DPrint("Couldn't load gfx/palette.lmp, falling back on internal palette\n");
250                 memcpy(palette_rgb, host_quakepal, 768);
251         }
252         if (palfile)
253                 Mem_Free(palfile);
254
255         out = (unsigned char *) palette_bgra_complete; // palette is accessed as 32bit for speed reasons, but is created as 8bit bytes
256         for (i = 0;i < 256;i++)
257         {
258                 out[i*4+2] = texturegammaramp[palette_rgb[i][0]];
259                 out[i*4+1] = texturegammaramp[palette_rgb[i][1]];
260                 out[i*4+0] = texturegammaramp[palette_rgb[i][2]];
261                 out[i*4+3] = 255;
262         }
263
264         if(*r_colormap_palette.string)
265                 palfile = (unsigned char *)FS_LoadFile (r_colormap_palette.string, tempmempool, false, &filesize);
266         else
267                 palfile = NULL;
268
269         if (palfile && filesize >= 48*2)
270         {
271                 memcpy(palette_rgb_shirtcolormap[0], palfile, 48);
272                 memcpy(palette_rgb_shirtscoreboard[0], palfile + 48, 48);
273         }
274         else
275         {
276                 for(i = 0;i < 16;i++)
277                 {
278                         VectorCopy(palette_rgb[(i << 4) | ((i >= 8 && i <= 13) ? 0x04 : 0x0C)], palette_rgb_shirtcolormap[i]);
279                         VectorCopy(palette_rgb[(i << 4) | 0x08], palette_rgb_shirtscoreboard[i]);
280                 }
281         }
282
283         if (palfile && filesize >= 48*4)
284         {
285                 memcpy(palette_rgb_pantscolormap[0], palfile + 48*2, 48);
286                 memcpy(palette_rgb_pantsscoreboard[0], palfile + 48*3, 48);
287         }
288         else
289         {
290                 memcpy(palette_rgb_pantscolormap, palette_rgb_shirtcolormap, sizeof(palette_rgb_pantscolormap));
291                 memcpy(palette_rgb_pantsscoreboard, palette_rgb_shirtscoreboard, sizeof(palette_rgb_pantsscoreboard));
292         }
293
294         if(palfile)
295                 Mem_Free(palfile);
296
297         memset(palette_bgra_embeddedpic, 0, sizeof(palette_bgra_embeddedpic));
298         for (i = '1';i <= '7';i++)
299         {
300                 Vector4Set(bgra.b, 255, 255, 255, (i - '0') * 255 / 7);
301                 palette_bgra_embeddedpic[i] = bgra.i;
302         }
303
304         Palette_SetupSpecialPalettes();
305 }
306
307 void Palette_Init(void)
308 {
309         R_RegisterModule("Palette", Palette_Load, Palette_Shutdown, Palette_NewMap);
310         Cvar_RegisterVariable(&r_colormap_palette);
311         Palette_Load();
312 }