This repository was archived by the owner on Jan 26, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathload_umx.cpp
More file actions
332 lines (281 loc) · 8.07 KB
/
load_umx.cpp
File metadata and controls
332 lines (281 loc) · 8.07 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
/*
* This source code is public domain.
*
* Epic Games Unreal UMX container loading for libmodplug
* Written by O. Sezer <[email protected]>
* UPKG parsing partially based on Unreal Media Ripper (UMR) v0.3
* by Andy Ward <[email protected]>, with additional updates
* by O. Sezer - see git repo at https://github.com/sezero/umr.git
* Retrieves the offset, size and object type directly from umx.
*/
#include "stdafx.h"
#include "sndfile.h"
typedef LONG fci_t; /* FCompactIndex */
#define UPKG_HDR_TAG 0x9e2a83c1
struct _genhist { /* for upkg versions >= 68 */
LONG export_count;
LONG name_count;
};
struct upkg_hdr {
DWORD tag; /* UPKG_HDR_TAG */
LONG file_version;
DWORD pkg_flags;
LONG name_count; /* number of names in name table (>= 0) */
LONG name_offset; /* offset to name table (>= 0) */
LONG export_count; /* num. exports in export table (>= 0) */
LONG export_offset; /* offset to export table (>= 0) */
LONG import_count; /* num. imports in export table (>= 0) */
LONG import_offset; /* offset to import table (>= 0) */
/* number of GUIDs in heritage table (>= 1) and table's offset:
* only with versions < 68. */
LONG heritage_count;
LONG heritage_offset;
/* with versions >= 68: a GUID, a dword for generation count
* and export_count and name_count dwords for each generation: */
DWORD guid[4];
LONG generation_count;
#define UPKG_HDR_SIZE 64 /* 64 bytes up until here */
/*struct _genhist *gen;*/
};
#define UMUSIC_IT 0
#define UMUSIC_S3M 1
#define UMUSIC_XM 2
#define UMUSIC_MOD 3
#define UMUSIC_WAV 4
#define UMUSIC_MP2 5
static const char *mustype[] = {
"IT", "S3M", "XM", "MOD",
NULL
};
/* decode an FCompactIndex.
* original documentation by Tim Sweeney was at
* http://unreal.epicgames.com/Packages.htm
* also see Unreal Wiki:
* http://wiki.beyondunreal.com/Legacy:Package_File_Format/Data_Details
*/
static fci_t get_fci (const char *in, int *pos)
{
LONG a;
int size;
size = 1;
a = in[0] & 0x3f;
if (in[0] & 0x40) {
size++;
a |= (in[1] & 0x7f) << 6;
if (in[1] & 0x80) {
size++;
a |= (in[2] & 0x7f) << 13;
if (in[2] & 0x80) {
size++;
a |= (in[3] & 0x7f) << 20;
if (in[3] & 0x80) {
size++;
a |= (in[4] & 0x3f) << 27;
}
}
}
}
if (in[0] & 0x80)
a = -a;
*pos += size;
return a;
}
static int get_objtype (const BYTE *membase, LONG memlen,
LONG ofs, int type)
{
if (type == UMUSIC_IT) {
_retry:
if (memcmp(membase + ofs, "IMPM", 4) == 0)
return UMUSIC_IT;
return -1;
}
if (type == UMUSIC_XM) {
if (memcmp(membase + ofs, "Extended Module: ", 17) != 0)
return -1;
if (*(membase + ofs + 37) != 0x1a) return -1;
return UMUSIC_XM;
}
if (type == UMUSIC_S3M) {
if (memcmp(membase + ofs + 44, "SCRM", 4) == 0)
return UMUSIC_S3M;
/*return -1;*/
/* SpaceMarines.umx and Starseek.umx from Return to NaPali
* report as "s3m" whereas the actual music format is "it" */
goto _retry;
}
if (type == UMUSIC_MOD) {
membase += ofs + 1080;
if (memcmp(membase, "M.K.", 4) == 0 || memcmp(membase, "M!K!", 4) == 0)
return UMUSIC_MOD;
return -1;
}
return -1;
}
static int read_export (const BYTE *membase, LONG memlen,
const struct upkg_hdr *hdr,
LONG *ofs, LONG *objsize)
{
char buf[40];
int idx = 0, t;
memcpy(buf, membase + *ofs, 40);
if (hdr->file_version < 40) idx += 8; /* 00 00 00 00 00 00 00 00 */
if (hdr->file_version < 60) idx += 16; /* 81 00 00 00 00 00 FF FF FF FF FF FF FF FF 00 00 */
get_fci(&buf[idx], &idx); /* skip junk */
t = get_fci(&buf[idx], &idx); /* type_name */
if (hdr->file_version > 61) idx += 4; /* skip export size */
*objsize = get_fci(&buf[idx], &idx);
*ofs += idx; /* offset for real data */
return t; /* return type_name index */
}
static int read_typname(const BYTE *membase, LONG memlen,
const struct upkg_hdr *hdr,
int idx, char *out)
{
int i, s;
long l, ofs, siz;
char buf[64];
if (idx >= hdr->name_count) return -1;
memset(buf, 0, 64);
for (i = 0, l = 0; i <= idx; i++) {
if ((ofs = hdr->name_offset + l) >= memlen)
return -1;
if ((siz = memlen - ofs) > 63) siz = 63;
memcpy(buf, membase + ofs, siz);
if (hdr->file_version >= 64) {
s = *(signed char *)buf; /* numchars *including* terminator */
if (s <= 0) return -1;
l += s + 5; /* 1 for buf[0], 4 for int32_t name_flags */
} else {
l += (long)strlen(buf);
l += 5; /* 1 for terminator, 4 for int32_t name_flags */
}
}
strcpy(out, (hdr->file_version >= 64)? &buf[1] : buf);
return 0;
}
static void umx_strupr(char *str)
{
while (*str) {
if (*str >= 'a' && *str <= 'z') {
*str -= ('a' - 'A');
}
str++;
}
}
static int probe_umx (const BYTE *membase, LONG memlen,
const struct upkg_hdr *hdr,
LONG *ofs, LONG *objsize)
{
int i, idx, t;
LONG s, pos;
char buf[64];
if (hdr->name_offset >= memlen ||
hdr->export_offset >= memlen ||
hdr->import_offset >= memlen) {
return -1;
}
/* Find the offset and size of the first IT, S3M or XM
* by parsing the exports table. The umx files should
* have only one export. Kran32.umx from Unreal has two,
* but both pointing to the same music. */
s = memlen - hdr->export_offset;
if (s <= 0) return -1;
if (s > 64) s = 64;
memcpy(buf, membase + hdr->export_offset, s);
for (; s < 64; ++s) buf[s] = 0x0; /* really? */
idx = 0;
get_fci(&buf[idx], &idx); /* skip class_index */
get_fci(&buf[idx], &idx); /* skip super_index */
if (hdr->file_version >= 60) idx += 4; /* skip int32 package_index */
get_fci(&buf[idx], &idx); /* skip object_name */
idx += 4; /* skip int32 object_flags */
s = get_fci(&buf[idx], &idx); /* get serial_size */
if (s <= 0) return -1;
pos = get_fci(&buf[idx],&idx); /* get serial_offset */
if (pos < 0 || pos > memlen - 40) return -1;
if ((t = read_export(membase, memlen, hdr, &pos, &s)) < 0) return -1;
if (s <= 0 || s > memlen - pos) return -1;
if (read_typname(membase, memlen, hdr, t, buf) < 0) return -1;
umx_strupr(buf);
for (i = 0; mustype[i] != NULL; i++) {
if (!strcmp(buf, mustype[i])) {
t = i;
break;
}
}
if (mustype[i] == NULL) return -1;
if ((t = get_objtype(membase, memlen, pos, t)) < 0) return -1;
*ofs = pos;
*objsize = s;
return t;
}
static int probe_header (void *header)
{
struct upkg_hdr *hdr;
unsigned char *p;
DWORD *swp;
int i;
/* byte swap the header - all members are 32 bit LE values */
p = (unsigned char *) header;
swp = (DWORD *) header;
for (i = 0; i < UPKG_HDR_SIZE/4; i++, p += 4) {
swp[i] = p[0] | (p[1] << 8) | (p[2] << 16) | (p[3] << 24);
}
hdr = (struct upkg_hdr *) header;
if (hdr->tag != UPKG_HDR_TAG) {
return -1;
}
if (hdr->name_count < 0 ||
hdr->export_count < 0 ||
hdr->import_count < 0 ||
hdr->name_offset < 36 ||
hdr->export_offset < 36 ||
hdr->import_offset < 36 ) {
return -1;
}
#if 1 /* no need being overzealous */
return 0;
#else
switch (hdr->file_version) {
case 35: case 37: /* Unreal beta - */
case 40: case 41: /* 1998 */
case 61:/* Unreal */
case 62:/* Unreal Tournament */
case 63:/* Return to NaPali */
case 64:/* Unreal Tournament */
case 66:/* Unreal Tournament */
case 68:/* Unreal Tournament */
case 69:/* Tactical Ops */
case 83:/* Mobile Forces */
return 0;
}
return -1;/* Unknown upkg version for an UMX */
#endif /* #if 0 */
}
static int process_upkg (const BYTE *membase, LONG memlen,
LONG *ofs, LONG *objsize)
{
char header[UPKG_HDR_SIZE];
memcpy(header, membase, UPKG_HDR_SIZE);
if (probe_header(header) < 0)
return -1;
return probe_umx(membase, memlen, (struct upkg_hdr *)header, ofs, objsize);
}
BOOL CSoundFile::ReadUMX(const BYTE *lpStream, DWORD dwMemLength)
//---------------------------------------------------------------
{
int type;
LONG ofs = 0, size = 0;
if (!lpStream || dwMemLength < 0x800 || dwMemLength > 0x7fffffff)
return FALSE;
type = process_upkg(lpStream, (LONG)dwMemLength, &ofs, &size);
if (type < 0) return FALSE;
// Rip Mods from UMX
switch (type) {
case UMUSIC_IT: return ReadIT(lpStream + ofs, size);
case UMUSIC_S3M: return ReadS3M(lpStream + ofs, size);
case UMUSIC_XM: return ReadXM(lpStream + ofs, size);
case UMUSIC_MOD: return ReadMod(lpStream + ofs, size);
}
return FALSE;
}