1 /* MikMod sound library
2 (c) 1998, 1999, 2000, 2001, 2002 Miodrag Vallat and others - see file
3 AUTHORS for complete list.
4
5 This library is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Library General Public License as
7 published by the Free Software Foundation; either version 2 of
8 the License, or (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with this library; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
18 02111-1307, USA.
19 */
20
21 /*==============================================================================
22
23 $Id$
24
25 Ultratracker (ULT) module loader
26
27 ==============================================================================*/
28
29 #ifdef HAVE_CONFIG_H
30 #include "config.h"
31 #endif
32
33 #ifdef HAVE_UNISTD_H
34 #include <unistd.h>
35 #endif
36
37 #include <stdio.h>
38 #ifdef HAVE_MEMORY_H
39 #include <memory.h>
40 #endif
41 #include <string.h>
42
43 #include "mikmod_internals.h"
44
45 #ifdef SUNOS
46 extern int fprintf(FILE *, const char *, ...);
47 #endif
48
49 /*========== Module structure */
50
51 /* header */
52 typedef struct ULTHEADER {
53 CHAR id[16];
54 CHAR songtitle[32];
55 UBYTE reserved;
56 } ULTHEADER;
57
58 /* sample information */
59 typedef struct ULTSAMPLE {
60 CHAR samplename[32];
61 CHAR dosname[12];
62 SLONG loopstart;
63 SLONG loopend;
64 SLONG sizestart;
65 SLONG sizeend;
66 UBYTE volume;
67 UBYTE flags;
68 UWORD speed;
69 SWORD finetune;
70 } ULTSAMPLE;
71
72 typedef struct ULTEVENT {
73 UBYTE note,sample,eff,dat1,dat2;
74 } ULTEVENT;
75
76 /*========== Loader variables */
77
78 #define ULTS_16BITS 4
79 #define ULTS_LOOP 8
80 #define ULTS_REVERSE 16
81
82 #define ULT_VERSION_LEN 18
83 static CHAR ULT_Version[ULT_VERSION_LEN+1]="Ultra Tracker v1.x";
84
85 static ULTEVENT ev;
86
87 /*========== Loader code */
88
ULT_Test(void)89 static BOOL ULT_Test(void)
90 {
91 CHAR id[16];
92
93 if(!_mm_read_string(id,15,modreader)) return 0;
94 if(strncmp(id,"MAS_UTrack_V00",14)) return 0;
95 if((id[14]<'1')||(id[14]>'4')) return 0;
96 return 1;
97 }
98
ULT_Init(void)99 static BOOL ULT_Init(void)
100 {
101 return 1;
102 }
103
ULT_Cleanup(void)104 static void ULT_Cleanup(void)
105 {
106 }
107
ReadUltEvent(ULTEVENT * event)108 static UBYTE ReadUltEvent(ULTEVENT* event)
109 {
110 UBYTE flag,rep=1;
111
112 flag = _mm_read_UBYTE(modreader);
113 if(flag==0xfc) {
114 rep = _mm_read_UBYTE(modreader);
115 event->note =_mm_read_UBYTE(modreader);
116 } else
117 event->note = flag;
118
119 event->sample =_mm_read_UBYTE(modreader);
120 event->eff =_mm_read_UBYTE(modreader);
121 event->dat1 =_mm_read_UBYTE(modreader);
122 event->dat2 =_mm_read_UBYTE(modreader);
123
124 return rep;
125 }
126
ULT_Load(BOOL curious)127 static BOOL ULT_Load(BOOL curious)
128 {
129 int t,u,tracks=0;
130 SAMPLE *q;
131 ULTSAMPLE s;
132 ULTHEADER mh;
133 UBYTE nos,noc,nop;
134
135 /* try to read module header */
136 _mm_read_string(mh.id,15,modreader);
137 _mm_read_string(mh.songtitle,32,modreader);
138 mh.reserved=_mm_read_UBYTE(modreader);
139
140 if(_mm_eof(modreader)) {
141 _mm_errno = MMERR_LOADING_HEADER;
142 return 0;
143 }
144
145 ULT_Version[ULT_VERSION_LEN-1]='3'+(mh.id[14]-'1');
146 of.modtype = DupStr(ULT_Version,ULT_VERSION_LEN,1);
147 of.initspeed = 6;
148 of.inittempo = 125;
149 of.reppos = 0;
150
151 /* read songtext */
152 if ((mh.id[14]>'1')&&(mh.reserved))
153 if(!ReadLinedComment(mh.reserved * 32, 32)) return 0;
154
155 nos=_mm_read_UBYTE(modreader);
156 if(_mm_eof(modreader)) {
157 _mm_errno = MMERR_LOADING_HEADER;
158 return 0;
159 }
160
161 of.songname=DupStr(mh.songtitle,32,1);
162 of.numins=of.numsmp=nos;
163
164 if(!AllocSamples()) return 0;
165 q = of.samples;
166 for(t=0;t<nos;t++) {
167 /* try to read sample info */
168 _mm_read_string(s.samplename,32,modreader);
169 _mm_read_string(s.dosname,12,modreader);
170 s.loopstart =_mm_read_I_ULONG(modreader);
171 s.loopend =_mm_read_I_ULONG(modreader);
172 s.sizestart =_mm_read_I_ULONG(modreader);
173 s.sizeend =_mm_read_I_ULONG(modreader);
174 s.volume =_mm_read_UBYTE(modreader);
175 s.flags =_mm_read_UBYTE(modreader);
176 s.speed =(mh.id[14]>='4')?_mm_read_I_UWORD(modreader):8363;
177 s.finetune =_mm_read_I_SWORD(modreader);
178
179 if(_mm_eof(modreader)) {
180 _mm_errno = MMERR_LOADING_SAMPLEINFO;
181 return 0;
182 }
183
184 q->samplename=DupStr(s.samplename,32,1);
185 /* The correct formula for the coefficient would be
186 pow(2,(double)s.finetume/OCTAVE/32768), but to avoid floating point
187 here, we'll use a first order approximation here.
188 1/567290 == Ln(2)/OCTAVE/32768 */
189 q->speed=s.speed+s.speed*(((SLONG)s.speed*(SLONG)s.finetune)/567290);
190 q->length = s.sizeend-s.sizestart;
191 q->volume = s.volume>>2;
192 q->loopstart = s.loopstart;
193 q->loopend = s.loopend;
194 q->flags = SF_SIGNED;
195 if(s.flags&ULTS_LOOP) q->flags|=SF_LOOP;
196 if(s.flags&ULTS_16BITS) {
197 s.sizeend+=(s.sizeend-s.sizestart);
198 s.sizestart<<=1;
199 q->flags|=SF_16BITS;
200 q->loopstart>>=1;
201 q->loopend>>=1;
202 }
203 q++;
204 }
205
206 if(!AllocPositions(256)) return 0;
207 for(t=0;t<256;t++)
208 of.positions[t]=_mm_read_UBYTE(modreader);
209 for(t=0;t<256;t++)
210 if(of.positions[t]==255) {
211 of.positions[t]=LAST_PATTERN;
212 break;
213 }
214 of.numpos=t;
215
216 noc=_mm_read_UBYTE(modreader);
217 nop=_mm_read_UBYTE(modreader);
218
219 of.numchn=++noc;
220 of.numpat=++nop;
221 of.numtrk=of.numchn*of.numpat;
222 if(!AllocTracks()) return 0;
223 if(!AllocPatterns()) return 0;
224 for(u=0;u<of.numchn;u++)
225 for(t=0;t<of.numpat;t++)
226 of.patterns[(t*of.numchn)+u]=tracks++;
227
228 /* Secunia SA37775 / CVE-2009-3996 */
229 if (of.numchn>=UF_MAXCHAN)
230 of.numchn=UF_MAXCHAN - 1;
231
232 /* read pan position table for v1.5 and higher */
233 if(mh.id[14]>='3') {
234 for(t=0;t<of.numchn;t++) of.panning[t]=_mm_read_UBYTE(modreader)<<4;
235 of.flags |= UF_PANNING;
236 }
237
238 for(t=0;t<of.numtrk;t++) {
239 int rep,row=0;
240
241 UniReset();
242 while(row<64) {
243 rep=ReadUltEvent(&ev);
244
245 if(_mm_eof(modreader)) {
246 _mm_errno = MMERR_LOADING_TRACK;
247 return 0;
248 }
249
250 while(rep--) {
251 UBYTE eff;
252 int offset;
253
254 if(ev.sample) UniInstrument(ev.sample-1);
255 if(ev.note) UniNote(ev.note+2*OCTAVE-1);
256
257 /* first effect - various fixes by Alexander Kerkhove and
258 Thomas Neumann */
259 eff = ev.eff>>4;
260 switch(eff) {
261 case 0x3: /* tone portamento */
262 UniEffect(UNI_ITEFFECTG,ev.dat2);
263 break;
264 case 0x5:
265 break;
266 case 0x9: /* sample offset */
267 offset=(ev.dat2<<8)|((ev.eff&0xf)==9?ev.dat1:0);
268 UniEffect(UNI_ULTEFFECT9,offset);
269 break;
270 case 0xb: /* panning */
271 UniPTEffect(8,ev.dat2*0xf);
272 of.flags |= UF_PANNING;
273 break;
274 case 0xc: /* volume */
275 UniPTEffect(eff,ev.dat2>>2);
276 break;
277 default:
278 UniPTEffect(eff,ev.dat2);
279 break;
280 }
281
282 /* second effect */
283 eff=ev.eff&0xf;
284 switch(eff) {
285 case 0x3: /* tone portamento */
286 UniEffect(UNI_ITEFFECTG,ev.dat1);
287 break;
288 case 0x5:
289 break;
290 case 0x9: /* sample offset */
291 if((ev.eff>>4)!=9)
292 UniEffect(UNI_ULTEFFECT9,((UWORD)ev.dat1)<<8);
293 break;
294 case 0xb: /* panning */
295 UniPTEffect(8,ev.dat1*0xf);
296 of.flags |= UF_PANNING;
297 break;
298 case 0xc: /* volume */
299 UniPTEffect(eff,ev.dat1>>2);
300 break;
301 default:
302 UniPTEffect(eff,ev.dat1);
303 break;
304 }
305
306 UniNewline();
307 row++;
308 }
309 }
310 if(!(of.tracks[t]=UniDup())) return 0;
311 }
312 return 1;
313 }
314
ULT_LoadTitle(void)315 static CHAR * ULT_LoadTitle(void)
316 {
317 CHAR s[32];
318
319 _mm_fseek(modreader,15,SEEK_SET);
320 if(!_mm_read_UBYTES(s,32,modreader)) return NULL;
321
322 return(DupStr(s,32,1));
323 }
324
325 /*========== Loader information */
326
327 MIKMODAPI MLOADER load_ult={
328 NULL,
329 "ULT",
330 "ULT (UltraTracker)",
331 ULT_Init,
332 ULT_Test,
333 ULT_Load,
334 ULT_Cleanup,
335 ULT_LoadTitle
336 };
337
338
339 /* ex:set ts=4: */
340