Niotso  git revision 558726a9f13d7c3423a683dd2f4323589b66c310
The New Implementation of The Sims Online
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
hitutils.h
Go to the documentation of this file.
1 /*
2  hitutils - The Sims HIT (dis)assembler and linker
3  hitutils.h - Copyright (c) 2012 Niotso Project <http://niotso.org/>
4  Author(s): Fatbag <X-Fi6@phppoll.org>
5 
6  Permission to use, copy, modify, and/or distribute this software for any
7  purpose with or without fee is hereby granted, provided that the above
8  copyright notice and this permission notice appear in all copies.
9 
10  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 
19 #ifndef min
20  #define min(x,y) ((x) < (y) ? (x) : (y))
21 #endif
22 #ifndef max
23  #define max(x,y) ((x) > (y) ? (x) : (y))
24 #endif
25 
26 #ifndef read_int32
27  #define read_uint32(x) (unsigned)(((x)[0]<<(8*0)) | ((x)[1]<<(8*1)) | ((x)[2]<<(8*2)) | ((x)[3]<<(8*3)))
28  #define read_uint16(x) (unsigned)(((x)[0]<<(8*0)) | ((x)[1]<<(8*1)))
29 #endif
30 
31 #ifndef write_int32
32  #define write_uint32(dest, src) do {\
33  (dest)[0] = ((src)&0x000000FF)>>(8*0); \
34  (dest)[1] = ((src)&0x0000FF00)>>(8*1); \
35  (dest)[2] = ((src)&0x00FF0000)>>(8*2); \
36  (dest)[3] = ((src)&0xFF000000)>>(8*3); \
37  } while(0)
38  #define write_uint16(dest, src) do {\
39  (dest)[0] = ((src)&0x00FF)>>(8*0); \
40  (dest)[1] = ((src)&0xFF00)>>(8*1); \
41  } while(0)
42 #endif
43 
44 extern char *strdup (const char *__s);
45 
46 static void Shutdown();
47 
48 static void Shutdown_M(const char * Message, ...){
49  va_list args;
50  va_start(args, Message);
51  vfprintf(stderr, Message, args);
52  va_end(args);
53 
54  Shutdown();
55  exit(EXIT_FAILURE);
56 }
57 
58 enum {
60 };
61 
62 #define OPERAND_BYTES(x) (x)
63 #define OPERAND(x, y) ((y)<<((x)*4+4))
64 #define UNIMPLEMENTED ((uint32_t)~0)
65 
66 enum operand_t {
67  o_byte = 1,
72 };
73 
74 typedef struct {
75  const char * Name;
76  uint32_t Operands;
78 
79 typedef struct {
80  const char * Name;
81  uint32_t Value;
82 } variable_t;
83 
84 typedef struct {
85  uint8_t * Data;
86  size_t Size;
88 
89 static const uint8_t HITHeader[] = {'H','I','T','!',0x01,0x00,0x00,0x00,0x08,0x00,0x00,0x00,'T','R','A','X'};
90 
91 #define InstructionCount 96
92 static const instruction_t Instructions[] = {
93  {"note", UNIMPLEMENTED},
94  {"note_on", OPERAND_BYTES(1) | OPERAND(0, o_variable)},
95  {"note_off", OPERAND_BYTES(1) | OPERAND(0, o_variable)},
96  {"loadb", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_byte)},
97  {"loadl", OPERAND_BYTES(5) | OPERAND(0, o_variable) | OPERAND(1, o_dword)},
98  {"set", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
99  {"call", OPERAND_BYTES(4) | OPERAND(0, o_address)},
100  {"return", OPERAND_BYTES(0)},
101  {"wait", OPERAND_BYTES(1) | OPERAND(0, o_variable)},
102  {"callentrypoint", UNIMPLEMENTED},
103  {"wait_samp", OPERAND_BYTES(0)},
104  {"end", OPERAND_BYTES(0)},
105  {"jump", OPERAND_BYTES(1) | OPERAND(0, o_jump)},
106  {"test", OPERAND_BYTES(1) | OPERAND(0, o_variable)},
107  {"nop", OPERAND_BYTES(0)},
108  {"add", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
109  {"sub", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
110  {"div", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
111  {"mul", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
112  {"cmp", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
113  {"less", UNIMPLEMENTED},
114  {"greater", UNIMPLEMENTED},
115  {"not", UNIMPLEMENTED},
116  {"rand", OPERAND_BYTES(3) | OPERAND(0, o_variable) | OPERAND(1, o_variable) | OPERAND(2, o_variable)},
117  {"abs", UNIMPLEMENTED},
118  {"limit", UNIMPLEMENTED},
119  {"error", UNIMPLEMENTED},
120  {"assert", UNIMPLEMENTED},
121  {"add_to_group", UNIMPLEMENTED},
122  {"remove_from_group", UNIMPLEMENTED},
123  {"get_var", UNIMPLEMENTED},
124  {"loop", OPERAND_BYTES(0)},
125  {"set_loop", OPERAND_BYTES(0)},
126  {"callback", UNIMPLEMENTED},
127  {"smart_add", UNIMPLEMENTED},
128  {"smart_remove", UNIMPLEMENTED},
129  {"smart_removeall", UNIMPLEMENTED},
130  {"smart_setcrit", UNIMPLEMENTED},
131  {"smart_choose", OPERAND_BYTES(1) | OPERAND(0, o_variable)},
132  {"and", UNIMPLEMENTED},
133  {"nand", UNIMPLEMENTED},
134  {"or", UNIMPLEMENTED},
135  {"nor", UNIMPLEMENTED},
136  {"xor", UNIMPLEMENTED},
137  {"max", OPERAND_BYTES(5) | OPERAND(0, o_variable) | OPERAND(1, o_dword)},
138  {"min", OPERAND_BYTES(5) | OPERAND(0, o_variable) | OPERAND(1, o_dword)},
139  {"inc", OPERAND_BYTES(1) | OPERAND(0, o_variable)},
140  {"dec", OPERAND_BYTES(1) | OPERAND(0, o_variable)},
141  {"printreg", UNIMPLEMENTED},
142  {"play_trk", OPERAND_BYTES(1) | OPERAND(0, o_variable)},
143  {"kill_trk", OPERAND_BYTES(1) | OPERAND(0, o_variable)},
144  {"push", UNIMPLEMENTED},
145  {"push_mask", UNIMPLEMENTED},
146  {"push_vars", UNIMPLEMENTED},
147  {"call_mask", UNIMPLEMENTED},
148  {"call_push", UNIMPLEMENTED},
149  {"pop", UNIMPLEMENTED},
150  {"test1", OPERAND_BYTES(0)},
151  {"test2", OPERAND_BYTES(0)},
152  {"test3", OPERAND_BYTES(0)},
153  {"test4", OPERAND_BYTES(0)},
154  {"ifeq", OPERAND_BYTES(4) | OPERAND(0, o_address)},
155  {"ifne", OPERAND_BYTES(4) | OPERAND(0, o_address)},
156  {"ifgt", OPERAND_BYTES(4) | OPERAND(0, o_address)},
157  {"iflt", OPERAND_BYTES(4) | OPERAND(0, o_address)},
158  {"ifge", OPERAND_BYTES(4) | OPERAND(0, o_address)},
159  {"ifle", OPERAND_BYTES(4) | OPERAND(0, o_address)},
160  {"smart_setlist", OPERAND_BYTES(1) | OPERAND(0, o_variable)},
161  {"seqgroup_kill", OPERAND_BYTES(1) | OPERAND(0, o_byte)},
162  {"seqgroup_wait", UNIMPLEMENTED},
163  {"seqgroup_return", OPERAND_BYTES(1) | OPERAND(0, o_byte)},
164  {"getsrcdatafield", OPERAND_BYTES(3) | OPERAND(0, o_variable) | OPERAND(1, o_variable) | OPERAND(2, o_variable)},
165  {"seqgroup_trkid", OPERAND_BYTES(2) | OPERAND(0, o_byte) | OPERAND(1, o_byte)},
166  {"setll", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
167  {"setlt", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
168  {"settl", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
169  {"waiteq", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
170  {"waitne", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
171  {"waitgt", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
172  {"waitlt", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
173  {"waitge", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
174  {"waitle", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
175  {"duck", OPERAND_BYTES(0)},
176  {"unduck", OPERAND_BYTES(0)},
177  {"testx", UNIMPLEMENTED},
178  {"setlg", OPERAND_BYTES(5) | OPERAND(0, o_variable) | OPERAND(1, o_dword)},
179  {"setgl", OPERAND_BYTES(5) | OPERAND(0, o_variable) | OPERAND(1, o_dword)},
180  {"throw", UNIMPLEMENTED},
181  {"setsrcdatafield", OPERAND_BYTES(3) | OPERAND(0, o_variable) | OPERAND(1, o_variable) | OPERAND(2, o_variable)},
182  {"stop_trk", OPERAND_BYTES(1) | OPERAND(0, o_variable)},
183  {"setchanreg", UNIMPLEMENTED},
184  {"play_note", UNIMPLEMENTED},
185  {"stop_note", UNIMPLEMENTED},
186  {"kill_note", UNIMPLEMENTED},
187  {"smart_index", OPERAND_BYTES(2) | OPERAND(0, o_variable) | OPERAND(1, o_variable)},
188  {"note_on_loop", OPERAND_BYTES(1) | OPERAND(0, o_variable)}
189 };
190 
191 #define TSOVariableCount 82
192 static const variable_t TSOVariables[] = {
193  {"arg0", 0x00},
194  {"arg1", 0x01},
195  {"arg2", 0x02},
196  {"arg3", 0x03},
197  {"arg4", 0x04},
198  {"v1", 0x05},
199  {"v2", 0x06},
200  {"v3", 0x07},
201  {"v4", 0x08},
202  {"v5", 0x09},
203  {"v6", 0x0A},
204  {"v7", 0x0B},
205  {"v8", 0x0C},
206  {"h1", 0x0D},
207  {"h2", 0x0E},
208  {"h3", 0x0F},
209  {"argstype", 0x10},
210  {"trackdatasource", 0x11},
211  {"patch", 0x12},
212  {"priority", 0x13},
213  {"vol", 0x14},
214  {"extvol", 0x15},
215  {"pan", 0x16},
216  {"pitch", 0x17},
217  {"paused", 0x18},
218  {"fxtype", 0x19},
219  {"fxlevel", 0x1a},
220  {"duckpri", 0x1b},
221  {"Is3d", 0x1c},
222  {"IsHeadRelative", 0x1d},
223  {"MinDistance", 0x1e},
224  {"MaxDistance", 0x1f},
225  {"X", 0x20},
226  {"Y", 0x21},
227  {"Z", 0x22},
228  {"attack", 0x23},
229  {"decay", 0x24},
230  {"IsStreamed", 0x25},
231  {"bufsizemult", 0x26},
232  {"fade_dest", 0x27},
233  {"fade_var", 0x28},
234  {"fade_speed", 0x29},
235  {"fade_on", 0x2a},
236  {"Preload", 0x2b},
237  {"isplaying", 0x2c},
238  {"whattodowithupdate", 0x2d},
239  {"tempo", 0x2e},
240  {"target", 0x2f},
241  {"ctrlgroup", 0x30},
242  {"interrupt", 0x31},
243  {"ispositioned", 0x32},
244  {"AppObjectId", 0x34},
245  {"callbackarg", 0x35},
246  {"pitchrandmin", 0x36},
247  {"pitchrandmax", 0x37},
248  {"spl", 0x38},
249  {"sem", 0x39},
250  {"starttrackid", 0x3a},
251  {"endtrackid", 0x3b},
252  {"startdelay", 0x3c},
253  {"fadeinspeed", 0x3d},
254  {"fadeoutspeed", 0x3e},
255  {"hitlist", 0x3f},
256  {"SimSpeed", 0x64},
257  {"test_g1", 0x65},
258  {"test_g2", 0x66},
259  {"test_g3", 0x67},
260  {"test_g4", 0x68},
261  {"test_g5", 0x69},
262  {"test_g6", 0x6a},
263  {"test_g7", 0x6b},
264  {"test_g8", 0x6c},
265  {"test_g9", 0x6d},
266  {"main_songnum", 0x6e},
267  {"main_musichitlistid", 0x6f},
268  {"campfire_nexttrack", 0x70},
269  {"campfire_busy", 0x71},
270  {"main_duckpri", 0x7b},
271  {"main_vol", 0x7c},
272  {"main_fxtype", 0x7d},
273  {"main_fxlevel", 0x7e},
274  {"main_pause", 0x7f},
275 };
276 
277 #define TS1VariableCount 87
278 static const variable_t TS1Variables[] = {
279  {"arg0", 0x00},
280  {"arg1", 0x01},
281  {"arg2", 0x02},
282  {"arg3", 0x03},
283  {"arg4", 0x04},
284  {"v1", 0x05},
285  {"v2", 0x06},
286  {"v3", 0x07},
287  {"v4", 0x08},
288  {"v5", 0x09},
289  {"v6", 0x0a},
290  {"v7", 0x0b},
291  {"v8", 0x0c},
292  {"h1", 0x0d},
293  {"h2", 0x0e},
294  {"h3", 0x0f},
295  {"priority", 0x11},
296  {"vol", 0x12},
297  {"extvol", 0x13},
298  {"pan", 0x14},
299  {"pitch", 0x15},
300  {"paused", 0x16},
301  {"fxtype", 0x17},
302  {"fxlevel", 0x18},
303  {"duckpri", 0x19},
304  {"Is3d", 0x1a},
305  {"IsHeadRelative", 0x1b},
306  {"MinDistance", 0x1c},
307  {"MaxDistance", 0x1d},
308  {"X", 0x1e},
309  {"Y", 0x1f},
310  {"Z", 0x20},
311  {"filter_type", 0x21},
312  {"filter_cutoff", 0x22},
313  {"filter_level", 0x23},
314  {"attack", 0x24},
315  {"decay", 0x25},
316  {"IsStreamed", 0x26},
317  {"BufSizeMult", 0x27},
318  {"fade_dest", 0x28},
319  {"fade_var", 0x29},
320  {"fade_speed", 0x2a},
321  {"Preload", 0x2b},
322  {"IsLooped", 0x2c},
323  {"fade_on", 0x2d},
324  {"isplaying", 0x2e},
325  {"source", 0x2f},
326  {"patch", 0x32},
327  {"WhatToDoWithUpdate", 0x33},
328  {"tempo", 0x34},
329  {"target", 0x35},
330  {"mutegroup", 0x36},
331  {"interrupt", 0x37},
332  {"IsPositioned", 0x38},
333  {"Spl", 0x39},
334  {"MultipleInstances", 0x3a},
335  {"AssociatedTrack1", 0x3b},
336  {"AssociatedTrack2", 0x3c},
337  {"AssociatedTrack3", 0x3d},
338  {"AssociatedTrack4", 0x3e},
339  {"AssociatedTrack5", 0x3f},
340  {"AssociatedTrack6", 0x40},
341  {"AssociatedTrack7", 0x41},
342  {"AssociatedTrack8", 0x42},
343  {"SimSpeed", 0x64},
344  {"test_g1", 0x65},
345  {"test_g2", 0x66},
346  {"test_g3", 0x67},
347  {"test_g4", 0x68},
348  {"test_g5", 0x69},
349  {"test_g6", 0x6a},
350  {"test_g7", 0x6b},
351  {"test_g8", 0x6c},
352  {"test_g9", 0x6d},
353  {"main_songnum", 0x6e},
354  {"main_musichitlistid", 0x6f},
355  {"campfire_nexttrack", 0x70},
356  {"campfire_busy", 0x71},
357  {"main_duckpri", 0x7b},
358  {"main_vol", 0x7c},
359  {"main_fxtype", 0x7d},
360  {"main_fxlevel", 0x7e},
361  {"main_pause", 0x7f},
362 };
363 
364 #define ConstantCount 72
365 static const variable_t Constants[] = {
366  {"duckpri_always", 0x0},
367  {"duckpri_low", 0xa},
368  {"duckpri_normal", 0x14},
369  {"duckpri_high", 0x1e},
370  {"duckpri_higher", 0x28},
371  {"duckpri_evenhigher", 0x32},
372  {"duckpri_never", 0x64},
373  {"spl_infinite", 0x0},
374  {"spl_loud", 0xa},
375  {"spl_normal", 0x14},
376  {"spl_quiet", 0x64},
377  {"Instance", 0x0},
378  {"Gender", 0x1},
379  {"GroupMusic", 0x1},
380  {"GroupDialogMain", 0x2},
381  {"GroupDialogOverlay", 0x3},
382  {"PchDishwasherClose", 0x32},
383  {"PchDishwasherLoad", 0x33},
384  {"PchDishwasherLoad2", 0x34},
385  {"PchDishwasherOpen", 0x35},
386  {"PchDishwasherTurnDial", 0x39},
387  {"PchDishwasherTurnDial2", 0x3a},
388  {"TrkRadioStationCountry", 0x104},
389  {"TrkRadioStationBossaNova", 0x10e},
390  {"TrkRadioStationClassical", 0x10d},
391  {"TrkRadioStationRock", 0x118},
392  {"kSndobPlay", 1},
393  {"kSndobStop", 2},
394  {"kSndobKill", 3},
395  {"kSndobUpdate", 4},
396  {"kSndobSetVolume", 5},
397  {"kSndobSetPitch", 6},
398  {"kSndobSetPan", 7},
399  {"kSndobSetPosition", 8},
400  {"kSndobSetFxType", 9},
401  {"kSndobSetFxLevel", 10},
402  {"kSndobPause", 11},
403  {"kSndobUnpause", 12},
404  {"kSndobLoad", 13},
405  {"kSndobUnload", 14},
406  {"kSndobCache", 15},
407  {"kSndobUncache", 16},
408  {"kSndobCancelNote", 19},
409  {"kPlayPiano", 43},
410  {"kSetMusicMode", 36},
411  {"kLive", 0},
412  {"kBuy", 1},
413  {"kBuild", 2},
414  {"kHood", 3},
415  {"kFrontEnd", 4},
416  {"kGroupSfx", 1},
417  {"kGroupMusic", 2},
418  {"kGroupVox", 3},
419  {"kAction", 1000},
420  {"kComedy", 1001},
421  {"kRomance", 1002},
422  {"kNews", 1003},
423  {"kCountry", 1004},
424  {"kRock", 1005},
425  {"kJazz", 1006},
426  {"kClassical", 1007},
427  {"kArgsNormal", 0},
428  {"kArgsVolPan", 1},
429  {"kArgsIdVolPan", 2},
430  {"kArgsXYZ", 3},
431  {"kKillAll", 20},
432  {"kPause", 21},
433  {"kUnpause", 22},
434  {"kKillInstance", 23},
435  {"kTurnOnTv", 30},
436  {"kTurnOffTv", 31},
437  {"kUpdateSourceVolPan", 32},
438 };
439 
440 static const char SHStringTable[] =
441  "\0.text"
442  "\0.shstrtab"
443  "\0.symtab"
444  "\0.strtab"
445  "\0.rel.text"
446 ;
447 
448 static const uint8_t SymbolTableHeader[] = {
449  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
450  0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x04, 0x00, 0xF1, 0xFF,
451  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x01, 0x00
452 };