--- /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_s3m.c,v 1.1.1.1 2004/01/21 01:36:35 raph Exp $\r
+\r
+ Screamtracker (S3M) module loader\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 S3MHEADER {\r
+ CHAR songname[28];\r
+ UBYTE t1a;\r
+ UBYTE type;\r
+ UBYTE unused1[2];\r
+ UWORD ordnum;\r
+ UWORD insnum;\r
+ UWORD patnum;\r
+ UWORD flags;\r
+ UWORD tracker;\r
+ UWORD fileformat;\r
+ CHAR scrm[4];\r
+ UBYTE mastervol;\r
+ UBYTE initspeed;\r
+ UBYTE inittempo;\r
+ UBYTE mastermult;\r
+ UBYTE ultraclick;\r
+ UBYTE pantable;\r
+ UBYTE unused2[8];\r
+ UWORD special;\r
+ UBYTE channels[32];\r
+} S3MHEADER;\r
+\r
+/* sample information */\r
+typedef struct S3MSAMPLE {\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
+} S3MSAMPLE;\r
+\r
+typedef struct S3MNOTE {\r
+ UBYTE note,ins,vol,cmd,inf;\r
+} S3MNOTE;\r
+\r
+/*========== Loader variables */\r
+\r
+static S3MNOTE *s3mbuf = NULL; /* pointer to a complete S3M pattern */\r
+static S3MHEADER *mh = NULL;\r
+static UWORD *paraptr = NULL; /* parapointer array (see S3M docs) */\r
+static unsigned int tracker; /* tracker id */\r
+\r
+/* tracker identifiers */\r
+#define NUMTRACKERS 4\r
+static CHAR* S3M_Version[] = {\r
+ "Screamtracker x.xx",\r
+ "Imago Orpheus x.xx (S3M format)",\r
+ "Impulse Tracker x.xx (S3M format)",\r
+ "Unknown tracker x.xx (S3M format)",\r
+ "Impulse Tracker 2.14p3 (S3M format)",\r
+ "Impulse Tracker 2.14p4 (S3M format)"\r
+};\r
+/* version number position in above array */\r
+static int numeric[NUMTRACKERS]={14,14,16,16};\r
+\r
+/*========== Loader code */\r
+\r
+BOOL S3M_Test(void)\r
+{\r
+ UBYTE id[4];\r
+\r
+ _mm_fseek(modreader,0x2c,SEEK_SET);\r
+ if(!_mm_read_UBYTES(id,4,modreader)) return 0;\r
+ if(!memcmp(id,"SCRM",4)) return 1;\r
+ return 0;\r
+}\r
+\r
+BOOL S3M_Init(void)\r
+{\r
+ if(!(s3mbuf=(S3MNOTE*)_mm_malloc(32*64*sizeof(S3MNOTE)))) return 0;\r
+ if(!(mh=(S3MHEADER*)_mm_malloc(sizeof(S3MHEADER)))) 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
+void S3M_Cleanup(void)\r
+{\r
+ _mm_free(s3mbuf);\r
+ _mm_free(paraptr);\r
+ _mm_free(poslookup);\r
+ _mm_free(mh);\r
+ _mm_free(origpositions);\r
+}\r
+\r
+/* Because so many s3m files have 16 channels as the set number used, but really\r
+ only use far less (usually 8 to 12 still), I had to make this function, which\r
+ determines the number of channels that are actually USED by a pattern.\r
+\r
+ For every channel that's used, it sets the appropriate array entry of the\r
+ global variable 'remap'\r
+\r
+ NOTE: You must first seek to the file location of the pattern before calling\r
+ this procedure.\r
+\r
+ Returns 1 on fail. */\r
+static BOOL S3M_GetNumChannels(void)\r
+{\r
+ int row=0,flag,ch;\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 1;\r
+ }\r
+\r
+ if(flag) {\r
+ ch=flag&31;\r
+ if(mh->channels[ch]<32) remap[ch] = 0;\r
+ if(flag&32) {_mm_read_UBYTE(modreader);_mm_read_UBYTE(modreader);}\r
+ if(flag&64) _mm_read_UBYTE(modreader);\r
+ if(flag&128){_mm_read_UBYTE(modreader);_mm_read_UBYTE(modreader);}\r
+ } else row++;\r
+ }\r
+ return 0;\r
+} \r
+\r
+static BOOL S3M_ReadPattern(void)\r
+{\r
+ int row=0,flag,ch;\r
+ S3MNOTE *n,dummy;\r
+\r
+ /* clear pattern data */\r
+ memset(s3mbuf,255,32*64*sizeof(S3MNOTE));\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=remap[flag&31];\r
+\r
+ if(ch!=-1)\r
+ n=&s3mbuf[(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* S3M_ConvertTrack(S3MNOTE* tr)\r
+{\r
+ int t;\r
+\r
+ UniReset();\r
+ for(t=0;t<64;t++) {\r
+ UBYTE note,ins,vol;\r
+\r
+ note=tr[t].note;\r
+ ins=tr[t].ins;\r
+ vol=tr[t].vol;\r
+\r
+ if((ins)&&(ins!=255)) UniInstrument(ins-1);\r
+ if(note!=255) {\r
+ if(note==254) {\r
+ UniPTEffect(0xc,0); /* note cut command */\r
+ vol=255;\r
+ } else\r
+ UniNote(((note>>4)*OCTAVE)+(note&0xf)); /* normal note */\r
+ }\r
+ if(vol<255) UniPTEffect(0xc,vol);\r
+\r
+ S3MIT_ProcessCmd(tr[t].cmd,tr[t].inf,\r
+ tracker == 1 ? S3MIT_OLDSTYLE | S3MIT_SCREAM : S3MIT_OLDSTYLE);\r
+ UniNewline();\r
+ }\r
+ return UniDup();\r
+}\r
+\r
+BOOL S3M_Load(BOOL curious)\r
+{\r
+ int t,u,track = 0;\r
+ SAMPLE *q;\r
+ UBYTE pan[32];\r
+\r
+ /* try to read module header */\r
+ _mm_read_string(mh->songname,28,modreader);\r
+ mh->t1a =_mm_read_UBYTE(modreader);\r
+ mh->type =_mm_read_UBYTE(modreader);\r
+ _mm_read_UBYTES(mh->unused1,2,modreader);\r
+ mh->ordnum =_mm_read_I_UWORD(modreader);\r
+ mh->insnum =_mm_read_I_UWORD(modreader);\r
+ mh->patnum =_mm_read_I_UWORD(modreader);\r
+ mh->flags =_mm_read_I_UWORD(modreader);\r
+ mh->tracker =_mm_read_I_UWORD(modreader);\r
+ mh->fileformat =_mm_read_I_UWORD(modreader);\r
+ _mm_read_string(mh->scrm,4,modreader);\r
+ mh->mastervol =_mm_read_UBYTE(modreader);\r
+ mh->initspeed =_mm_read_UBYTE(modreader);\r
+ mh->inittempo =_mm_read_UBYTE(modreader);\r
+ mh->mastermult =_mm_read_UBYTE(modreader);\r
+ mh->ultraclick =_mm_read_UBYTE(modreader);\r
+ mh->pantable =_mm_read_UBYTE(modreader);\r
+ _mm_read_UBYTES(mh->unused2,8,modreader);\r
+ mh->special =_mm_read_I_UWORD(modreader);\r
+ _mm_read_UBYTES(mh->channels,32,modreader);\r
+\r
+ if(_mm_eof(modreader)) {\r
+ _mm_errno = MMERR_LOADING_HEADER;\r
+ return 0;\r
+ }\r
+\r
+ /* then we can decide the module type */\r
+ tracker=mh->tracker>>12;\r
+ if((!tracker)||(tracker>=NUMTRACKERS))\r
+ tracker=NUMTRACKERS-1; /* unknown tracker */\r
+ else {\r
+ if(mh->tracker>=0x3217)\r
+ tracker=NUMTRACKERS+1; /* IT 2.14p4 */\r
+ else if(mh->tracker>=0x3216)\r
+ tracker=NUMTRACKERS; /* IT 2.14p3 */\r
+ else tracker--;\r
+ }\r
+ of.modtype = strdup(S3M_Version[tracker]);\r
+ if(tracker<NUMTRACKERS) {\r
+ of.modtype[numeric[tracker]] = ((mh->tracker>>8) &0xf)+'0';\r
+ of.modtype[numeric[tracker]+2] = ((mh->tracker>>4)&0xf)+'0';\r
+ of.modtype[numeric[tracker]+3] = ((mh->tracker)&0xf)+'0';\r
+ }\r
+ /* set module variables */\r
+ of.songname = DupStr(mh->songname,28,0);\r
+ of.numpat = mh->patnum;\r
+ of.reppos = 0;\r
+ of.numins = of.numsmp = mh->insnum;\r
+ of.initspeed = mh->initspeed;\r
+ of.inittempo = mh->inittempo;\r
+ of.initvolume = mh->mastervol<<1;\r
+ of.flags |= UF_ARPMEM | UF_PANNING;\r
+ if((mh->tracker==0x1300)||(mh->flags&64))\r
+ of.flags|=UF_S3MSLIDES;\r
+ of.bpmlimit = 32;\r
+\r
+ /* read the order data */\r
+ if(!AllocPositions(mh->ordnum)) return 0;\r
+ if(!(origpositions=_mm_calloc(mh->ordnum,sizeof(UWORD)))) return 0;\r
+\r
+ for(t=0;t<mh->ordnum;t++) {\r
+ origpositions[t]=_mm_read_UBYTE(modreader);\r
+ if((origpositions[t]>=mh->patnum)&&(origpositions[t]<254))\r
+ origpositions[t]=255/*mh->patnum-1*/;\r
+ }\r
+\r
+ if(_mm_eof(modreader)) {\r
+ _mm_errno = MMERR_LOADING_HEADER;\r
+ return 0;\r
+ }\r
+\r
+ poslookupcnt=mh->ordnum;\r
+ S3MIT_CreateOrders(curious);\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_read_I_UWORDS(paraptr,of.numins+of.numpat,modreader);\r
+\r
+ if(mh->pantable==252) {\r
+ /* read the panning table (ST 3.2 addition. See below for further\r
+ portions of channel panning [past reampper]). */\r
+ _mm_read_UBYTES(pan,32,modreader);\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
+ q = of.samples;\r
+ for(t=0;t<of.numins;t++) {\r
+ S3MSAMPLE 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
+ /* ScreamTracker imposes a 64000 bytes (not 64k !) limit */\r
+ if (s.length > 64000)\r
+ s.length = 64000;\r
+\r
+ if(_mm_eof(modreader)) {\r
+ _mm_errno = MMERR_LOADING_SAMPLEINFO;\r
+ return 0;\r
+ }\r
+\r
+ q->samplename = DupStr(s.sampname,28,0);\r
+ q->speed = s.c2spd;\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
+\r
+ if(s.flags&1) q->flags |= SF_LOOP;\r
+ if(s.flags&4) q->flags |= SF_16BITS;\r
+ if(mh->fileformat==1) q->flags |= SF_SIGNED;\r
+\r
+ /* don't load sample if it doesn't have the SCRS tag */\r
+ if(memcmp(s.scrs,"SCRS",4)) q->length = 0;\r
+\r
+ q++;\r
+ }\r
+\r
+ /* determine the number of channels actually used. */\r
+ of.numchn = 0;\r
+ memset(remap,-1,32*sizeof(UBYTE));\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)+2,SEEK_SET);\r
+ if(S3M_GetNumChannels()) return 0;\r
+ }\r
+\r
+ /* build the remap array */\r
+ for(t=0;t<32;t++)\r
+ if(!remap[t]) \r
+ remap[t]=of.numchn++;\r
+\r
+ /* set panning positions after building remap chart! */\r
+ for(t=0;t<32;t++) \r
+ if((mh->channels[t]<32)&&(remap[t]!=-1)) {\r
+ if(mh->channels[t]<8)\r
+ of.panning[remap[t]]=0x30;\r
+ else\r
+ of.panning[remap[t]]=0xc0;\r
+ }\r
+ if(mh->pantable==252)\r
+ /* set panning positions according to panning table (new for st3.2) */\r
+ for(t=0;t<32;t++)\r
+ if((pan[t]&0x20)&&(mh->channels[t]<32)&&(remap[t]!=-1))\r
+ of.panning[remap[t]]=(pan[t]&0xf)<<4;\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)+2,SEEK_SET);\r
+ if(!S3M_ReadPattern()) return 0;\r
+ for(u=0;u<of.numchn;u++)\r
+ if(!(of.tracks[track++]=S3M_ConvertTrack(&s3mbuf[u*64]))) return 0;\r
+ }\r
+\r
+ return 1;\r
+}\r
+\r
+CHAR *S3M_LoadTitle(void)\r
+{\r
+ CHAR s[28];\r
+\r
+ _mm_fseek(modreader,0,SEEK_SET);\r
+ if(!_mm_read_UBYTES(s,28,modreader)) return NULL;\r
+\r
+ return(DupStr(s,28,0));\r
+}\r
+\r
+/*========== Loader information */\r
+\r
+MIKMODAPI MLOADER load_s3m={\r
+ NULL,\r
+ "S3M",\r
+ "S3M (Scream Tracker 3)",\r
+ S3M_Init,\r
+ S3M_Test,\r
+ S3M_Load,\r
+ S3M_Cleanup,\r
+ S3M_LoadTitle\r
+};\r
+\r
+/* ex:set ts=4: */\r
projects / mikmod-rockbox.git / blobdiff