--- /dev/null
+/* MikMod sound library\r
+ (c) 1998, 1999, 2000, 2001, 2002 Miodrag Vallat and others - see file\r
+ AUTHORS for complete list.\r
+\r
+ This library is free software; you can redistribute it and/or modify\r
+ it under the terms of the GNU Library General Public License as\r
+ published by the Free Software Foundation; either version 2 of\r
+ the License, or (at your option) any later version.\r
+ \r
+ This program is distributed in the hope that it will be useful,\r
+ but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+ GNU Library General Public License for more details.\r
+ \r
+ You should have received a copy of the GNU Library General Public\r
+ License along with this library; if not, write to the Free Software\r
+ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA\r
+ 02111-1307, USA.\r
+*/\r
+\r
+/*==============================================================================\r
+\r
+ $Id: load_stx.c,v 1.1.1.1 2004/01/21 01:36:35 raph Exp $\r
+\r
+ STMIK 0.2 (STX) module loader\r
+\r
+==============================================================================*/\r
+\r
+/*\r
+\r
+ Written by Claudio Matsuoka <claudio@helllabs.org>\r
+\r
+*/\r
+\r
+#ifdef HAVE_CONFIG_H\r
+#include "config.h"\r
+#endif\r
+\r
+#ifdef HAVE_UNISTD_H\r
+#include <unistd.h>\r
+#endif\r
+\r
+#include <stdio.h>\r
+#ifdef HAVE_MEMORY_H\r
+#include <memory.h>\r
+#endif\r
+#include <string.h>\r
+\r
+#include "mikmod_internals.h"\r
+\r
+#ifdef SUNOS\r
+extern int fprintf(FILE *, const char *, ...);\r
+#endif\r
+\r
+/*========== Module structure */\r
+\r
+/* header */\r
+typedef struct STXHEADER {\r
+ CHAR songname[20];\r
+ CHAR trackername[8];\r
+ UWORD patsize;\r
+ UWORD unknown1;\r
+ UWORD patptr;\r
+ UWORD insptr;\r
+ UWORD chnptr; /* not sure */\r
+ UWORD unknown2;\r
+ UWORD unknown3;\r
+ UBYTE mastermult;\r
+ UBYTE initspeed;\r
+ UWORD unknown4;\r
+ UWORD unknown5;\r
+ UWORD patnum;\r
+ UWORD insnum;\r
+ UWORD ordnum;\r
+ UWORD unknown6;\r
+ UWORD unknown7;\r
+ UWORD unknown8;\r
+ CHAR scrm[4];\r
+} STXHEADER;\r
+\r
+/* sample information */\r
+typedef struct STXSAMPLE {\r
+ UBYTE type;\r
+ CHAR filename[12];\r
+ UBYTE memsegh;\r
+ UWORD memsegl;\r
+ ULONG length;\r
+ ULONG loopbeg;\r
+ ULONG loopend;\r
+ UBYTE volume;\r
+ UBYTE dsk;\r
+ UBYTE pack;\r
+ UBYTE flags;\r
+ ULONG c2spd;\r
+ UBYTE unused[12];\r
+ CHAR sampname[28];\r
+ CHAR scrs[4];\r
+} STXSAMPLE;\r
+\r
+typedef struct STXNOTE {\r
+ UBYTE note,ins,vol,cmd,inf;\r
+} STXNOTE;\r
+\r
+/*========== Loader variables */\r
+\r
+static STXNOTE *stxbuf = NULL; /* pointer to a complete STX pattern */\r
+static STXHEADER *mh = NULL;\r
+static UWORD *paraptr = NULL; /* parapointer array (see STX docs) */\r
+\r
+/*========== Loader code */\r
+\r
+static BOOL STX_Test(void)\r
+{\r
+ UBYTE id[8];\r
+ int t;\r
+\r
+ _mm_fseek(modreader,0x3C,SEEK_SET);\r
+ if(!_mm_read_UBYTES(id,4,modreader)) return 0;\r
+ if(memcmp(id,"SCRM",4)) return 0;\r
+\r
+ _mm_fseek(modreader,0x14,SEEK_SET);\r
+ if(!_mm_read_UBYTES(id,8,modreader)) return 0;\r
+ \r
+ for(t=0;t<STM_NTRACKERS;t++)\r
+ if(!memcmp(id,STM_Signatures[t],8)) return 1;\r
+\r
+ return 0;\r
+}\r
+\r
+static BOOL STX_Init(void)\r
+{\r
+ if(!(stxbuf=(STXNOTE*)_mm_malloc(4*64*sizeof(STXNOTE)))) return 0;\r
+ if(!(mh=(STXHEADER*)_mm_malloc(sizeof(STXHEADER)))) return 0;\r
+ if(!(poslookup=(UBYTE*)_mm_malloc(sizeof(UBYTE)*256))) return 0;\r
+ memset(poslookup,-1,256);\r
+\r
+ return 1;\r
+}\r
+\r
+static void STX_Cleanup(void)\r
+{\r
+ _mm_free(stxbuf);\r
+ _mm_free(paraptr);\r
+ _mm_free(poslookup);\r
+ _mm_free(mh);\r
+}\r
+\r
+static BOOL STX_ReadPattern(void)\r
+{\r
+ int row=0,flag,ch;\r
+ STXNOTE *n,dummy;\r
+\r
+ /* clear pattern data */\r
+ memset(stxbuf,255,4*64*sizeof(STXNOTE));\r
+\r
+ while(row<64) {\r
+ flag=_mm_read_UBYTE(modreader);\r
+\r
+ if(_mm_eof(modreader)) {\r
+ _mm_errno = MMERR_LOADING_PATTERN;\r
+ return 0;\r
+ }\r
+\r
+ if(flag) {\r
+ ch=flag&31;\r
+\r
+ if((ch>=0)&&(ch<4))\r
+ n=&stxbuf[(64U*ch)+row];\r
+ else\r
+ n=&dummy;\r
+\r
+ if(flag&32) {\r
+ n->note=_mm_read_UBYTE(modreader);\r
+ n->ins=_mm_read_UBYTE(modreader);\r
+ }\r
+ if(flag&64) {\r
+ n->vol=_mm_read_UBYTE(modreader);\r
+ if(n->vol>64) n->vol=64;\r
+ }\r
+ if(flag&128) {\r
+ n->cmd=_mm_read_UBYTE(modreader);\r
+ n->inf=_mm_read_UBYTE(modreader);\r
+ }\r
+ } else row++;\r
+ }\r
+ return 1;\r
+}\r
+\r
+static UBYTE* STX_ConvertTrack(STXNOTE* tr)\r
+{\r
+ int t;\r
+\r
+ UniReset();\r
+ for(t=0;t<64;t++) {\r
+ UBYTE note,ins,vol,cmd,inf;\r
+\r
+ note=tr[t].note;\r
+ ins=tr[t].ins;\r
+ vol=tr[t].vol;\r
+ cmd=tr[t].cmd;\r
+ inf=tr[t].inf;\r
+\r
+ if((ins)&&(ins!=255)) UniInstrument(ins-1);\r
+ if((note)&&(note!=255)) {\r
+ if(note==254) {\r
+ UniPTEffect(0xc,0); /* note cut command */\r
+ vol=255;\r
+ } else UniNote(24+((note>>4)*OCTAVE)+(note&0xf)); /* normal note */\r
+ }\r
+\r
+ if(vol<255) UniPTEffect(0xc,vol);\r
+\r
+ if(cmd<255) switch(cmd) {\r
+ case 1: /* Axx set speed to xx */\r
+ UniPTEffect(0xf,inf>>4);\r
+ break;\r
+ case 2: /* Bxx position jump */\r
+ UniPTEffect(0xb,inf);\r
+ break;\r
+ case 3: /* Cxx patternbreak to row xx */\r
+ UniPTEffect(0xd,(((inf&0xf0)>>4)*10)+(inf&0xf));\r
+ break;\r
+ case 4: /* Dxy volumeslide */\r
+ UniEffect(UNI_S3MEFFECTD,inf);\r
+ break;\r
+ case 5: /* Exy toneslide down */\r
+ UniEffect(UNI_S3MEFFECTE,inf);\r
+ break;\r
+ case 6: /* Fxy toneslide up */\r
+ UniEffect(UNI_S3MEFFECTF,inf);\r
+ break;\r
+ case 7: /* Gxx Tone portamento,speed xx */\r
+ UniPTEffect(0x3,inf);\r
+ break;\r
+ case 8: /* Hxy vibrato */\r
+ UniPTEffect(0x4,inf);\r
+ break;\r
+ case 9: /* Ixy tremor, ontime x, offtime y */\r
+ UniEffect(UNI_S3MEFFECTI,inf);\r
+ break;\r
+ case 0: /* protracker arpeggio */\r
+ if(!inf) break;\r
+ /* fall through */\r
+ case 0xa: /* Jxy arpeggio */\r
+ UniPTEffect(0x0,inf);\r
+ break;\r
+ case 0xb: /* Kxy Dual command H00 & Dxy */\r
+ UniPTEffect(0x4,0);\r
+ UniEffect(UNI_S3MEFFECTD,inf);\r
+ break;\r
+ case 0xc: /* Lxy Dual command G00 & Dxy */\r
+ UniPTEffect(0x3,0);\r
+ UniEffect(UNI_S3MEFFECTD,inf);\r
+ break;\r
+ /* Support all these above, since ST2 can LOAD these values but can\r
+ actually only play up to J - and J is only half-way implemented\r
+ in ST2 */\r
+ case 0x18: /* Xxx amiga panning command 8xx */\r
+ UniPTEffect(0x8,inf);\r
+ of.flags |= UF_PANNING;\r
+ break;\r
+ }\r
+ UniNewline();\r
+ }\r
+ return UniDup();\r
+}\r
+\r
+static BOOL STX_Load(BOOL curious)\r
+{\r
+ int t,u,track = 0;\r
+ int version = 0;\r
+ SAMPLE *q;\r
+\r
+ /* try to read module header */\r
+ _mm_read_string(mh->songname,20,modreader);\r
+ _mm_read_string(mh->trackername,8,modreader);\r
+ mh->patsize =_mm_read_I_UWORD(modreader);\r
+ mh->unknown1 =_mm_read_I_UWORD(modreader);\r
+ mh->patptr =_mm_read_I_UWORD(modreader);\r
+ mh->insptr =_mm_read_I_UWORD(modreader);\r
+ mh->chnptr =_mm_read_I_UWORD(modreader);\r
+ mh->unknown2 =_mm_read_I_UWORD(modreader);\r
+ mh->unknown3 =_mm_read_I_UWORD(modreader);\r
+ mh->mastermult =_mm_read_UBYTE(modreader);\r
+ mh->initspeed =_mm_read_UBYTE(modreader)>>4;\r
+ mh->unknown4 =_mm_read_I_UWORD(modreader);\r
+ mh->unknown5 =_mm_read_I_UWORD(modreader);\r
+ mh->patnum =_mm_read_I_UWORD(modreader);\r
+ mh->insnum =_mm_read_I_UWORD(modreader);\r
+ mh->ordnum =_mm_read_I_UWORD(modreader);\r
+ mh->unknown6 =_mm_read_I_UWORD(modreader);\r
+ mh->unknown7 =_mm_read_I_UWORD(modreader);\r
+ mh->unknown8 =_mm_read_I_UWORD(modreader);\r
+ _mm_read_string(mh->scrm,4,modreader);\r
+\r
+ if(_mm_eof(modreader)) {\r
+ _mm_errno = MMERR_LOADING_HEADER;\r
+ return 0;\r
+ }\r
+\r
+ /* set module variables */\r
+ of.songname = DupStr(mh->songname,20,1);\r
+ of.numpat = mh->patnum;\r
+ of.reppos = 0;\r
+ of.numins = of.numsmp = mh->insnum;\r
+ of.initspeed = mh->initspeed;\r
+ of.inittempo = 125;\r
+ of.numchn = 4;\r
+ of.flags |= UF_S3MSLIDES;\r
+ of.bpmlimit = 32;\r
+\r
+ if(!(paraptr=(UWORD*)_mm_malloc((of.numins+of.numpat)*sizeof(UWORD))))\r
+ return 0;\r
+\r
+ /* read the instrument+pattern parapointers */\r
+ _mm_fseek(modreader,mh->insptr<<4,SEEK_SET);\r
+ _mm_read_I_UWORDS(paraptr,of.numins,modreader);\r
+ _mm_fseek(modreader,mh->patptr<<4,SEEK_SET);\r
+ _mm_read_I_UWORDS(paraptr+of.numins,of.numpat,modreader);\r
+\r
+ /* check module version */\r
+ _mm_fseek(modreader,paraptr[of.numins]<<4,SEEK_SET);\r
+ version=_mm_read_I_UWORD(modreader);\r
+ if(version==mh->patsize) {\r
+ version = 0x10;\r
+ of.modtype = strdup("STMIK 0.2 (STM2STX 1.0)");\r
+ } else {\r
+ version = 0x11;\r
+ of.modtype = strdup("STMIK 0.2 (STM2STX 1.1)");\r
+ }\r
+\r
+ /* read the order data */\r
+ _mm_fseek(modreader,(mh->chnptr<<4)+32,SEEK_SET);\r
+ if(!AllocPositions(mh->ordnum)) return 0;\r
+ for(t=0;t<mh->ordnum;t++) {\r
+ of.positions[t]=_mm_read_UBYTE(modreader);\r
+ _mm_fseek(modreader,4,SEEK_CUR);\r
+ }\r
+\r
+ of.numpos=0;poslookupcnt=mh->ordnum;\r
+ for(t=0;t<mh->ordnum;t++) {\r
+ int order=of.positions[t];\r
+ if(order==255) order=LAST_PATTERN;\r
+ of.positions[of.numpos]=order;\r
+ poslookup[t]=of.numpos; /* bug fix for freaky S3Ms */\r
+ if(of.positions[t]<254) of.numpos++; \r
+ else\r
+ /* special end of song pattern */\r
+ if((order==LAST_PATTERN)&&(!curious)) break;\r
+ }\r
+\r
+ if(_mm_eof(modreader)) {\r
+ _mm_errno = MMERR_LOADING_HEADER;\r
+ return 0;\r
+ }\r
+\r
+ /* load samples */\r
+ if(!AllocSamples()) return 0;\r
+ for(q=of.samples,t=0;t<of.numins;t++,q++) {\r
+ STXSAMPLE s;\r
+\r
+ /* seek to instrument position */\r
+ _mm_fseek(modreader,((long)paraptr[t])<<4,SEEK_SET);\r
+ /* and load sample info */\r
+ s.type =_mm_read_UBYTE(modreader);\r
+ _mm_read_string(s.filename,12,modreader);\r
+ s.memsegh =_mm_read_UBYTE(modreader);\r
+ s.memsegl =_mm_read_I_UWORD(modreader);\r
+ s.length =_mm_read_I_ULONG(modreader);\r
+ s.loopbeg =_mm_read_I_ULONG(modreader);\r
+ s.loopend =_mm_read_I_ULONG(modreader);\r
+ s.volume =_mm_read_UBYTE(modreader);\r
+ s.dsk =_mm_read_UBYTE(modreader);\r
+ s.pack =_mm_read_UBYTE(modreader);\r
+ s.flags =_mm_read_UBYTE(modreader);\r
+ s.c2spd =_mm_read_I_ULONG(modreader);\r
+ _mm_read_UBYTES(s.unused,12,modreader);\r
+ _mm_read_string(s.sampname,28,modreader);\r
+ _mm_read_string(s.scrs,4,modreader);\r
+\r
+ if(_mm_eof(modreader)) {\r
+ _mm_errno = MMERR_LOADING_SAMPLEINFO;\r
+ return 0;\r
+ }\r
+\r
+ q->samplename = DupStr(s.sampname,28,1);\r
+ q->speed = (s.c2spd * 8363) / 8448;\r
+ q->length = s.length;\r
+ q->loopstart = s.loopbeg;\r
+ q->loopend = s.loopend;\r
+ q->volume = s.volume;\r
+ q->seekpos = (((long)s.memsegh)<<16|s.memsegl)<<4;\r
+ q->flags |= SF_SIGNED;\r
+\r
+ if(s.flags&1) q->flags |= SF_LOOP;\r
+ if(s.flags&4) q->flags |= SF_16BITS;\r
+ }\r
+\r
+ /* load pattern info */\r
+ of.numtrk=of.numpat*of.numchn;\r
+ if(!AllocTracks()) return 0;\r
+ if(!AllocPatterns()) return 0;\r
+\r
+ for(t=0;t<of.numpat;t++) {\r
+ /* seek to pattern position (+2 skip pattern length) */\r
+ _mm_fseek(modreader,(((long)paraptr[of.numins+t])<<4)+\r
+ (version==0x10?2:0),SEEK_SET);\r
+ if(!STX_ReadPattern()) return 0;\r
+ for(u=0;u<of.numchn;u++)\r
+ if(!(of.tracks[track++]=STX_ConvertTrack(&stxbuf[u*64]))) return 0;\r
+ }\r
+\r
+ return 1;\r
+}\r
+\r
+static CHAR *STX_LoadTitle(void)\r
+{\r
+ CHAR s[28];\r
+\r
+ _mm_fseek(modreader,0,SEEK_SET);\r
+ if(!_mm_read_UBYTES(s,20,modreader)) return NULL;\r
+\r
+ return(DupStr(s,28,1));\r
+}\r
+\r
+/*========== Loader information */\r
+\r
+MIKMODAPI MLOADER load_stx={\r
+ NULL,\r
+ "STX",\r
+ "STX (Scream Tracker Music Interface Kit)",\r
+ STX_Init,\r
+ STX_Test,\r
+ STX_Load,\r
+ STX_Cleanup,\r
+ STX_LoadTitle\r
+};\r
+\r
+/* ex:set ts=4: */\r