1 /* MikMod sound library
\r
2 (c) 1998, 1999, 2000, 2001, 2002 Miodrag Vallat and others - see file
\r
3 AUTHORS for complete list.
\r
5 This library is free software; you can redistribute it and/or modify
\r
6 it under the terms of the GNU Library General Public License as
\r
7 published by the Free Software Foundation; either version 2 of
\r
8 the License, or (at your option) any later version.
\r
10 This program is distributed in the hope that it will be useful,
\r
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
13 GNU Library General Public License for more details.
\r
15 You should have received a copy of the GNU Library General Public
\r
16 License along with this library; if not, write to the Free Software
\r
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
\r
21 /*==============================================================================
\r
23 $Id: load_ult.c,v 1.1.1.1 2004/01/21 01:36:35 raph Exp $
\r
25 Ultratracker (ULT) module loader
\r
27 ==============================================================================*/
\r
29 #ifdef HAVE_CONFIG_H
\r
33 #ifdef HAVE_UNISTD_H
\r
38 #ifdef HAVE_MEMORY_H
\r
43 #include "mikmod_internals.h"
\r
46 extern int fprintf(FILE *, const char *, ...);
\r
49 /*========== Module structure */
\r
52 typedef struct ULTHEADER {
\r
58 /* sample information */
\r
59 typedef struct ULTSAMPLE {
\r
60 CHAR samplename[32];
\r
72 typedef struct ULTEVENT {
\r
73 UBYTE note,sample,eff,dat1,dat2;
\r
76 /*========== Loader variables */
\r
78 #define ULTS_16BITS 4
\r
80 #define ULTS_REVERSE 16
\r
82 #define ULT_VERSION_LEN 18
\r
83 static CHAR ULT_Version[ULT_VERSION_LEN]="Ultra Tracker v1.x";
\r
87 /*========== Loader code */
\r
93 if(!_mm_read_string(id,15,modreader)) return 0;
\r
94 if(strncmp(id,"MAS_UTrack_V00",14)) return 0;
\r
95 if((id[14]<'1')||(id[14]>'4')) return 0;
\r
104 void ULT_Cleanup(void)
\r
108 static UBYTE ReadUltEvent(ULTEVENT* event)
\r
112 flag = _mm_read_UBYTE(modreader);
\r
114 rep = _mm_read_UBYTE(modreader);
\r
115 event->note =_mm_read_UBYTE(modreader);
\r
117 event->note = flag;
\r
119 event->sample =_mm_read_UBYTE(modreader);
\r
120 event->eff =_mm_read_UBYTE(modreader);
\r
121 event->dat1 =_mm_read_UBYTE(modreader);
\r
122 event->dat2 =_mm_read_UBYTE(modreader);
\r
127 BOOL ULT_Load(BOOL curious)
\r
133 UBYTE nos,noc,nopa;
\r
136 /* try to read module header */
\r
137 _mm_read_string(mh.id,15,modreader);
\r
138 _mm_read_string(mh.songtitle,32,modreader);
\r
139 mh.reserved=_mm_read_UBYTE(modreader);
\r
141 if(_mm_eof(modreader)) {
\r
142 _mm_errno = MMERR_LOADING_HEADER;
\r
146 ULT_Version[ULT_VERSION_LEN-1]='3'+(mh.id[14]-'1');
\r
147 of.modtype = DupStr(ULT_Version,ULT_VERSION_LEN,1);
\r
149 of.inittempo = 125;
\r
152 /* read songtext */
\r
153 if ((mh.id[14]>'1')&&(mh.reserved))
\r
154 if(!ReadLinedComment(mh.reserved * 32, 32)) return 0;
\r
156 nos=_mm_read_UBYTE(modreader);
\r
157 if(_mm_eof(modreader)) {
\r
158 _mm_errno = MMERR_LOADING_HEADER;
\r
162 of.songname=DupStr(mh.songtitle,32,1);
\r
163 of.numins=of.numsmp=nos;
\r
165 if(!AllocSamples()) return 0;
\r
167 for(t=0;t<nos;t++) {
\r
168 /* try to read sample info */
\r
169 _mm_read_string(s.samplename,32,modreader);
\r
170 _mm_read_string(s.dosname,12,modreader);
\r
171 s.loopstart =_mm_read_I_ULONG(modreader);
\r
172 s.loopend =_mm_read_I_ULONG(modreader);
\r
173 s.sizestart =_mm_read_I_ULONG(modreader);
\r
174 s.sizeend =_mm_read_I_ULONG(modreader);
\r
175 s.volume =_mm_read_UBYTE(modreader);
\r
176 s.flags =_mm_read_UBYTE(modreader);
\r
177 s.speed =(mh.id[14]>='4')?_mm_read_I_UWORD(modreader):8363;
\r
178 s.finetune =_mm_read_I_SWORD(modreader);
\r
180 if(_mm_eof(modreader)) {
\r
181 _mm_errno = MMERR_LOADING_SAMPLEINFO;
\r
185 q->samplename=DupStr(s.samplename,32,1);
\r
186 /* The correct formula for the coefficient would be
\r
187 pow(2,(double)s.finetume/OCTAVE/32768), but to avoid floating point
\r
188 here, we'll use a first order approximation here.
\r
189 1/567290 == Ln(2)/OCTAVE/32768 */
\r
190 q->speed=s.speed+s.speed*(((SLONG)s.speed*(SLONG)s.finetune)/567290);
\r
191 q->length = s.sizeend-s.sizestart;
\r
192 q->volume = s.volume>>2;
\r
193 q->loopstart = s.loopstart;
\r
194 q->loopend = s.loopend;
\r
195 q->flags = SF_SIGNED;
\r
196 if(s.flags&ULTS_LOOP) q->flags|=SF_LOOP;
\r
197 if(s.flags&ULTS_16BITS) {
\r
198 s.sizeend+=(s.sizeend-s.sizestart);
\r
200 q->flags|=SF_16BITS;
\r
207 if(!AllocPositions(256)) return 0;
\r
209 of.positions[t]=_mm_read_UBYTE(modreader);
\r
211 if(of.positions[t]==255) {
\r
212 of.positions[t]=LAST_PATTERN;
\r
217 noc=_mm_read_UBYTE(modreader);
\r
218 nopa=_mm_read_UBYTE(modreader);
\r
222 of.numtrk=of.numchn*of.numpat;
\r
223 if(!AllocTracks()) return 0;
\r
224 if(!AllocPatterns()) return 0;
\r
225 for(u=0;u<of.numchn;u++)
\r
226 for(t=0;t<of.numpat;t++)
\r
227 of.patterns[(t*of.numchn)+u]=tracks++;
\r
229 /* read pan position table for v1.5 and higher */
\r
230 if(mh.id[14]>='3') {
\r
231 for(t=0;t<of.numchn;t++) of.panning[t]=_mm_read_UBYTE(modreader)<<4;
\r
232 of.flags |= UF_PANNING;
\r
235 for(t=0;t<of.numtrk;t++) {
\r
240 rep=ReadUltEvent(&ev);
\r
242 if(_mm_eof(modreader)) {
\r
243 _mm_errno = MMERR_LOADING_TRACK;
\r
251 if(ev.sample) UniInstrument(ev.sample-1);
\r
252 if(ev.note) UniNote(ev.note+2*OCTAVE-1);
\r
254 /* first effect - various fixes by Alexander Kerkhove and
\r
258 case 0x3: /* tone portamento */
\r
259 UniEffect(UNI_ITEFFECTG,ev.dat2);
\r
263 case 0x9: /* sample offset */
\r
264 offset=(ev.dat2<<8)|((ev.eff&0xf)==9?ev.dat1:0);
\r
265 UniEffect(UNI_ULTEFFECT9,offset);
\r
267 case 0xb: /* panning */
\r
268 UniPTEffect(8,ev.dat2*0xf);
\r
269 of.flags |= UF_PANNING;
\r
271 case 0xc: /* volume */
\r
272 UniPTEffect(eff,ev.dat2>>2);
\r
275 UniPTEffect(eff,ev.dat2);
\r
279 /* second effect */
\r
282 case 0x3: /* tone portamento */
\r
283 UniEffect(UNI_ITEFFECTG,ev.dat1);
\r
287 case 0x9: /* sample offset */
\r
289 UniEffect(UNI_ULTEFFECT9,((UWORD)ev.dat1)<<8);
\r
291 case 0xb: /* panning */
\r
292 UniPTEffect(8,ev.dat1*0xf);
\r
293 of.flags |= UF_PANNING;
\r
295 case 0xc: /* volume */
\r
296 UniPTEffect(eff,ev.dat1>>2);
\r
299 UniPTEffect(eff,ev.dat1);
\r
307 if(!(of.tracks[t]=UniDup())) return 0;
\r
312 CHAR *ULT_LoadTitle(void)
\r
316 _mm_fseek(modreader,15,SEEK_SET);
\r
317 if(!_mm_read_UBYTES(s,32,modreader)) return NULL;
\r
319 return(DupStr(s,32,1));
\r
322 /*========== Loader information */
\r
324 MIKMODAPI MLOADER load_ult={
\r
327 "ULT (UltraTracker)",
\r