apps/plugins/mikmod/loaders/load_stx.c

   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
   4 \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
   9  \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
  14  \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
  18         02111-1307, USA.\r
  19 */\r
  20 \r
  21 /*==============================================================================\r
  22 \r
  23   $Id: load_stx.c,v 1.1.1.1 2004/01/21 01:36:35 raph Exp $\r
  24 \r
  25   STMIK 0.2 (STX) module loader\r
  26 \r
  27 ==============================================================================*/\r
  28 \r
  29 /*\r
  30 \r
  31         Written by Claudio Matsuoka <claudio@helllabs.org>\r
  32 \r
  33 */\r
  34 \r
  35 #ifdef HAVE_CONFIG_H\r
  36 #include "config.h"\r
  37 #endif\r
  38 \r
  39 #ifdef HAVE_UNISTD_H\r
  40 #include <unistd.h>\r
  41 #endif\r
  42 \r
  43 #include <stdio.h>\r
  44 #ifdef HAVE_MEMORY_H\r
  45 #include <memory.h>\r
  46 #endif\r
  47 #include <string.h>\r
  48 \r
  49 #include "mikmod_internals.h"\r
  50 \r
  51 #ifdef SUNOS\r
  52 extern int fprintf(FILE *, const char *, ...);\r
  53 #endif\r
  54 \r
  55 /*========== Module structure */\r
  56 \r
  57 /* header */\r
  58 typedef struct STXHEADER {\r
  59         CHAR  songname[20];\r
  60         CHAR  trackername[8];\r
  61         UWORD patsize;\r
  62         UWORD unknown1;\r
  63         UWORD patptr;\r
  64         UWORD insptr;\r
  65         UWORD chnptr;   /* not sure */\r
  66         UWORD unknown2;\r
  67         UWORD unknown3;\r
  68         UBYTE mastermult;\r
  69         UBYTE initspeed;\r
  70         UWORD unknown4;\r
  71         UWORD unknown5;\r
  72         UWORD patnum;\r
  73         UWORD insnum;\r
  74         UWORD ordnum;\r
  75         UWORD unknown6;\r
  76         UWORD unknown7;\r
  77         UWORD unknown8;\r
  78         CHAR  scrm[4];\r
  79 } STXHEADER;\r
  80 \r
  81 /* sample information */\r
  82 typedef struct STXSAMPLE {\r
  83         UBYTE type;\r
  84         CHAR  filename[12];\r
  85         UBYTE memsegh;\r
  86         UWORD memsegl;\r
  87         ULONG length;\r
  88         ULONG loopbeg;\r
  89         ULONG loopend;\r
  90         UBYTE volume;\r
  91         UBYTE dsk;\r
  92         UBYTE pack;\r
  93         UBYTE flags;\r
  94         ULONG c2spd;\r
  95         UBYTE unused[12];\r
  96         CHAR  sampname[28];\r
  97         CHAR  scrs[4];\r
  98 } STXSAMPLE;\r
  99 \r
 100 typedef struct STXNOTE {\r
 101         UBYTE note,ins,vol,cmd,inf;\r
 102 } STXNOTE;\r
 103 \r
 104 /*========== Loader variables */\r
 105 \r
 106 static STXNOTE   *stxbuf  = NULL; /* pointer to a complete STX pattern */\r
 107 static STXHEADER *mh      = NULL;\r
 108 static UWORD     *paraptr = NULL; /* parapointer array (see STX docs) */\r
 109 \r
 110 /*========== Loader code */\r
 111 \r
 112 static BOOL STX_Test(void)\r
 113 {\r
 114         UBYTE id[8];\r
 115         int t;\r
 116 \r
 117         _mm_fseek(modreader,0x3C,SEEK_SET);\r
 118         if(!_mm_read_UBYTES(id,4,modreader)) return 0;\r
 119         if(memcmp(id,"SCRM",4)) return 0;\r
 120 \r
 121         _mm_fseek(modreader,0x14,SEEK_SET);\r
 122         if(!_mm_read_UBYTES(id,8,modreader)) return 0;\r
 123         \r
 124         for(t=0;t<STM_NTRACKERS;t++)\r
 125                 if(!memcmp(id,STM_Signatures[t],8)) return 1;\r
 126 \r
 127         return 0;\r
 128 }\r
 129 \r
 130 static BOOL STX_Init(void)\r
 131 {\r
 132         if(!(stxbuf=(STXNOTE*)_mm_malloc(4*64*sizeof(STXNOTE)))) return 0;\r
 133         if(!(mh=(STXHEADER*)_mm_malloc(sizeof(STXHEADER)))) return 0;\r
 134         if(!(poslookup=(UBYTE*)_mm_malloc(sizeof(UBYTE)*256))) return 0;\r
 135         memset(poslookup,-1,256);\r
 136 \r
 137         return 1;\r
 138 }\r
 139 \r
 140 static void STX_Cleanup(void)\r
 141 {\r
 142         _mm_free(stxbuf);\r
 143         _mm_free(paraptr);\r
 144         _mm_free(poslookup);\r
 145         _mm_free(mh);\r
 146 }\r
 147 \r
 148 static BOOL STX_ReadPattern(void)\r
 149 {\r
 150         int row=0,flag,ch;\r
 151         STXNOTE *n,dummy;\r
 152 \r
 153         /* clear pattern data */\r
 154         memset(stxbuf,255,4*64*sizeof(STXNOTE));\r
 155 \r
 156         while(row<64) {\r
 157                 flag=_mm_read_UBYTE(modreader);\r
 158 \r
 159                 if(_mm_eof(modreader)) {\r
 160                         _mm_errno = MMERR_LOADING_PATTERN;\r
 161                         return 0;\r
 162                 }\r
 163 \r
 164                 if(flag) {\r
 165                         ch=flag&31;\r
 166 \r
 167                         if((ch>=0)&&(ch<4))\r
 168                                 n=&stxbuf[(64U*ch)+row];\r
 169                         else\r
 170                                 n=&dummy;\r
 171 \r
 172                         if(flag&32) {\r
 173                                 n->note=_mm_read_UBYTE(modreader);\r
 174                                 n->ins=_mm_read_UBYTE(modreader);\r
 175                         }\r
 176                         if(flag&64) {\r
 177                                 n->vol=_mm_read_UBYTE(modreader);\r
 178                                 if(n->vol>64) n->vol=64;\r
 179                         }\r
 180                         if(flag&128) {\r
 181                                 n->cmd=_mm_read_UBYTE(modreader);\r
 182                                 n->inf=_mm_read_UBYTE(modreader);\r
 183                         }\r
 184                 } else row++;\r
 185         }\r
 186         return 1;\r
 187 }\r
 188 \r
 189 static UBYTE* STX_ConvertTrack(STXNOTE* tr)\r
 190 {\r
 191         int t;\r
 192 \r
 193         UniReset();\r
 194         for(t=0;t<64;t++) {\r
 195                 UBYTE note,ins,vol,cmd,inf;\r
 196 \r
 197                 note=tr[t].note;\r
 198                 ins=tr[t].ins;\r
 199                 vol=tr[t].vol;\r
 200                 cmd=tr[t].cmd;\r
 201                 inf=tr[t].inf;\r
 202 \r
 203                 if((ins)&&(ins!=255)) UniInstrument(ins-1);\r
 204                 if((note)&&(note!=255)) {\r
 205                         if(note==254) {\r
 206                                 UniPTEffect(0xc,0);     /* note cut command */\r
 207                                 vol=255;\r
 208                         } else UniNote(24+((note>>4)*OCTAVE)+(note&0xf)); /* normal note */\r
 209                 }\r
 210 \r
 211                 if(vol<255) UniPTEffect(0xc,vol);\r
 212 \r
 213                 if(cmd<255) switch(cmd) {\r
 214                         case 1: /* Axx set speed to xx */\r
 215                                 UniPTEffect(0xf,inf>>4);\r
 216                                 break;\r
 217                         case 2: /* Bxx position jump */\r
 218                                 UniPTEffect(0xb,inf);\r
 219                                 break;\r
 220                         case 3: /* Cxx patternbreak to row xx */\r
 221                                 UniPTEffect(0xd,(((inf&0xf0)>>4)*10)+(inf&0xf));\r
 222                                 break;\r
 223                         case 4: /* Dxy volumeslide */\r
 224                                 UniEffect(UNI_S3MEFFECTD,inf);\r
 225                                 break;\r
 226                         case 5: /* Exy toneslide down */\r
 227                                 UniEffect(UNI_S3MEFFECTE,inf);\r
 228                                 break;\r
 229                         case 6: /* Fxy toneslide up */\r
 230                                 UniEffect(UNI_S3MEFFECTF,inf);\r
 231                                 break;\r
 232                         case 7: /* Gxx Tone portamento,speed xx */\r
 233                                 UniPTEffect(0x3,inf);\r
 234                                 break;\r
 235                         case 8: /* Hxy vibrato */\r
 236                                 UniPTEffect(0x4,inf);\r
 237                                 break;\r
 238                         case 9: /* Ixy tremor, ontime x, offtime y */\r
 239                                 UniEffect(UNI_S3MEFFECTI,inf);\r
 240                         break;\r
 241                         case 0:         /* protracker arpeggio */\r
 242                                 if(!inf) break;\r
 243                                 /* fall through */\r
 244                         case 0xa:       /* Jxy arpeggio */\r
 245                                 UniPTEffect(0x0,inf);\r
 246                                 break;\r
 247                         case 0xb:       /* Kxy Dual command H00 & Dxy */\r
 248                                 UniPTEffect(0x4,0);\r
 249                                 UniEffect(UNI_S3MEFFECTD,inf);\r
 250                                 break;\r
 251                         case 0xc:       /* Lxy Dual command G00 & Dxy */\r
 252                                 UniPTEffect(0x3,0);\r
 253                                 UniEffect(UNI_S3MEFFECTD,inf);\r
 254                                 break;\r
 255                         /* Support all these above, since ST2 can LOAD these values but can\r
 256                            actually only play up to J - and J is only half-way implemented\r
 257                            in ST2 */\r
 258                         case 0x18:      /* Xxx amiga panning command 8xx */\r
 259                                 UniPTEffect(0x8,inf);\r
 260                                 of.flags |= UF_PANNING;\r
 261                                 break;\r
 262                 }\r
 263                 UniNewline();\r
 264         }\r
 265         return UniDup();\r
 266 }\r
 267 \r
 268 static BOOL STX_Load(BOOL curious)\r
 269 {\r
 270         int t,u,track = 0;\r
 271         int version = 0;\r
 272         SAMPLE *q;\r
 273 \r
 274         /* try to read module header */\r
 275         _mm_read_string(mh->songname,20,modreader);\r
 276         _mm_read_string(mh->trackername,8,modreader);\r
 277         mh->patsize     =_mm_read_I_UWORD(modreader);\r
 278         mh->unknown1    =_mm_read_I_UWORD(modreader);\r
 279         mh->patptr      =_mm_read_I_UWORD(modreader);\r
 280         mh->insptr      =_mm_read_I_UWORD(modreader);\r
 281         mh->chnptr      =_mm_read_I_UWORD(modreader);\r
 282         mh->unknown2    =_mm_read_I_UWORD(modreader);\r
 283         mh->unknown3    =_mm_read_I_UWORD(modreader);\r
 284         mh->mastermult  =_mm_read_UBYTE(modreader);\r
 285         mh->initspeed   =_mm_read_UBYTE(modreader)>>4;\r
 286         mh->unknown4    =_mm_read_I_UWORD(modreader);\r
 287         mh->unknown5    =_mm_read_I_UWORD(modreader);\r
 288         mh->patnum      =_mm_read_I_UWORD(modreader);\r
 289         mh->insnum      =_mm_read_I_UWORD(modreader);\r
 290         mh->ordnum      =_mm_read_I_UWORD(modreader);\r
 291         mh->unknown6    =_mm_read_I_UWORD(modreader);\r
 292         mh->unknown7    =_mm_read_I_UWORD(modreader);\r
 293         mh->unknown8    =_mm_read_I_UWORD(modreader);\r
 294         _mm_read_string(mh->scrm,4,modreader);\r
 295 \r
 296         if(_mm_eof(modreader)) {\r
 297                 _mm_errno = MMERR_LOADING_HEADER;\r
 298                 return 0;\r
 299         }\r
 300 \r
 301         /* set module variables */\r
 302         of.songname    = DupStr(mh->songname,20,1);\r
 303         of.numpat      = mh->patnum;\r
 304         of.reppos      = 0;\r
 305         of.numins      = of.numsmp = mh->insnum;\r
 306         of.initspeed   = mh->initspeed;\r
 307         of.inittempo   = 125;\r
 308         of.numchn      = 4;\r
 309         of.flags      |= UF_S3MSLIDES;\r
 310         of.bpmlimit    = 32;\r
 311 \r
 312         if(!(paraptr=(UWORD*)_mm_malloc((of.numins+of.numpat)*sizeof(UWORD))))\r
 313                 return 0;\r
 314 \r
 315         /* read the instrument+pattern parapointers */\r
 316         _mm_fseek(modreader,mh->insptr<<4,SEEK_SET);\r
 317         _mm_read_I_UWORDS(paraptr,of.numins,modreader);\r
 318         _mm_fseek(modreader,mh->patptr<<4,SEEK_SET);\r
 319         _mm_read_I_UWORDS(paraptr+of.numins,of.numpat,modreader);\r
 320 \r
 321         /* check module version */\r
 322         _mm_fseek(modreader,paraptr[of.numins]<<4,SEEK_SET);\r
 323         version=_mm_read_I_UWORD(modreader);\r
 324         if(version==mh->patsize) {\r
 325                 version    = 0x10;\r
 326                 of.modtype = strdup("STMIK 0.2 (STM2STX 1.0)");\r
 327         } else {\r
 328                 version    = 0x11;\r
 329                 of.modtype = strdup("STMIK 0.2 (STM2STX 1.1)");\r
 330         }\r
 331 \r
 332         /* read the order data */\r
 333         _mm_fseek(modreader,(mh->chnptr<<4)+32,SEEK_SET);\r
 334         if(!AllocPositions(mh->ordnum)) return 0;\r
 335         for(t=0;t<mh->ordnum;t++) {\r
 336                 of.positions[t]=_mm_read_UBYTE(modreader);\r
 337                 _mm_fseek(modreader,4,SEEK_CUR);\r
 338         }\r
 339 \r
 340         of.numpos=0;poslookupcnt=mh->ordnum;\r
 341         for(t=0;t<mh->ordnum;t++) {\r
 342                 int order=of.positions[t];\r
 343                 if(order==255) order=LAST_PATTERN;\r
 344                 of.positions[of.numpos]=order;\r
 345                 poslookup[t]=of.numpos; /* bug fix for freaky S3Ms */\r
 346                 if(of.positions[t]<254) of.numpos++;        \r
 347                 else\r
 348                   /* special end of song pattern */\r
 349                   if((order==LAST_PATTERN)&&(!curious)) break;\r
 350         }\r
 351 \r
 352         if(_mm_eof(modreader)) {\r
 353                 _mm_errno = MMERR_LOADING_HEADER;\r
 354                 return 0;\r
 355         }\r
 356 \r
 357         /* load samples */\r
 358         if(!AllocSamples()) return 0;\r
 359         for(q=of.samples,t=0;t<of.numins;t++,q++) {\r
 360                 STXSAMPLE s;\r
 361 \r
 362                 /* seek to instrument position */\r
 363                 _mm_fseek(modreader,((long)paraptr[t])<<4,SEEK_SET);\r
 364                 /* and load sample info */\r
 365                 s.type      =_mm_read_UBYTE(modreader);\r
 366                 _mm_read_string(s.filename,12,modreader);\r
 367                 s.memsegh   =_mm_read_UBYTE(modreader);\r
 368                 s.memsegl   =_mm_read_I_UWORD(modreader);\r
 369                 s.length    =_mm_read_I_ULONG(modreader);\r
 370                 s.loopbeg   =_mm_read_I_ULONG(modreader);\r
 371                 s.loopend   =_mm_read_I_ULONG(modreader);\r
 372                 s.volume    =_mm_read_UBYTE(modreader);\r
 373                 s.dsk       =_mm_read_UBYTE(modreader);\r
 374                 s.pack      =_mm_read_UBYTE(modreader);\r
 375                 s.flags     =_mm_read_UBYTE(modreader);\r
 376                 s.c2spd     =_mm_read_I_ULONG(modreader);\r
 377                 _mm_read_UBYTES(s.unused,12,modreader);\r
 378                 _mm_read_string(s.sampname,28,modreader);\r
 379                 _mm_read_string(s.scrs,4,modreader);\r
 380 \r
 381                 if(_mm_eof(modreader)) {\r
 382                         _mm_errno = MMERR_LOADING_SAMPLEINFO;\r
 383                         return 0;\r
 384                 }\r
 385 \r
 386                 q->samplename = DupStr(s.sampname,28,1);\r
 387                 q->speed      = (s.c2spd * 8363) / 8448;\r
 388                 q->length     = s.length;\r
 389                 q->loopstart  = s.loopbeg;\r
 390                 q->loopend    = s.loopend;\r
 391                 q->volume     = s.volume;\r
 392                 q->seekpos    = (((long)s.memsegh)<<16|s.memsegl)<<4;\r
 393                 q->flags     |= SF_SIGNED;\r
 394 \r
 395                 if(s.flags&1) q->flags |= SF_LOOP;\r
 396                 if(s.flags&4) q->flags |= SF_16BITS;\r
 397         }\r
 398 \r
 399         /* load pattern info */\r
 400         of.numtrk=of.numpat*of.numchn;\r
 401         if(!AllocTracks()) return 0;\r
 402         if(!AllocPatterns()) return 0;\r
 403 \r
 404         for(t=0;t<of.numpat;t++) {\r
 405                 /* seek to pattern position (+2 skip pattern length) */\r
 406                 _mm_fseek(modreader,(((long)paraptr[of.numins+t])<<4)+\r
 407                         (version==0x10?2:0),SEEK_SET);\r
 408                 if(!STX_ReadPattern()) return 0;\r
 409                 for(u=0;u<of.numchn;u++)\r
 410                         if(!(of.tracks[track++]=STX_ConvertTrack(&stxbuf[u*64]))) return 0;\r
 411         }\r
 412 \r
 413         return 1;\r
 414 }\r
 415 \r
 416 static CHAR *STX_LoadTitle(void)\r
 417 {\r
 418         CHAR s[28];\r
 419 \r
 420         _mm_fseek(modreader,0,SEEK_SET);\r
 421         if(!_mm_read_UBYTES(s,20,modreader)) return NULL;\r
 422 \r
 423         return(DupStr(s,28,1));\r
 424 }\r
 425 \r
 426 /*========== Loader information */\r
 427 \r
 428 MIKMODAPI MLOADER load_stx={\r
 429         NULL,\r
 430         "STX",\r
 431         "STX (Scream Tracker Music Interface Kit)",\r
 432         STX_Init,\r
 433         STX_Test,\r
 434         STX_Load,\r
 435         STX_Cleanup,\r
 436         STX_LoadTitle\r
 437 };\r
 438 \r
 439 /* ex:set ts=4: */\r