Add "MikMod for Rockbox 0.1" from 2007-06-29
[mikmod-rockbox.git] / apps / plugins / mikmod / loaders / load_amf.c
diff --git a/apps/plugins/mikmod/loaders/load_amf.c b/apps/plugins/mikmod/loaders/load_amf.c
new file mode 100644 (file)
index 0000000..f53d2ee
--- /dev/null
@@ -0,0 +1,570 @@
+/*     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_amf.c,v 1.1.1.1 2004/01/21 01:36:35 raph Exp $\r
+\r
+  DMP Advanced Module Format 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
+typedef struct AMFHEADER {\r
+       UBYTE id[3];                    /* AMF file marker */\r
+       UBYTE version;                  /* upper major, lower nibble minor version number */\r
+       CHAR  songname[32];             /* ASCIIZ songname */\r
+       UBYTE numsamples;               /* number of samples saved */\r
+       UBYTE numorders;\r
+       UWORD numtracks;                /* number of tracks saved */\r
+       UBYTE numchannels;              /* number of channels used  */\r
+       SBYTE panpos[32];               /* voice pan positions */\r
+       UBYTE songbpm;\r
+       UBYTE songspd;\r
+} AMFHEADER;\r
+\r
+typedef struct AMFSAMPLE {\r
+       UBYTE type;\r
+       CHAR  samplename[32];\r
+       CHAR  filename[13];\r
+       ULONG offset;\r
+       ULONG length;\r
+       UWORD c2spd;\r
+       UBYTE volume;\r
+       ULONG reppos;\r
+       ULONG repend;\r
+} AMFSAMPLE;\r
+\r
+typedef struct AMFNOTE {\r
+       UBYTE note,instr,volume,fxcnt;\r
+       UBYTE effect[3];\r
+       SBYTE parameter[3];\r
+} AMFNOTE;\r
+\r
+/*========== Loader variables */\r
+\r
+static AMFHEADER *mh = NULL;\r
+#define AMFTEXTLEN 22\r
+static CHAR AMF_Version[AMFTEXTLEN+1] = "DSMI Module Format 0.0";\r
+static AMFNOTE *track = NULL;\r
+\r
+/*========== Loader code */\r
+\r
+BOOL AMF_Test(void)\r
+{\r
+       UBYTE id[3],ver;\r
+\r
+       if(!_mm_read_UBYTES(id,3,modreader)) return 0;\r
+       if(memcmp(id,"AMF",3)) return 0;\r
+\r
+       ver=_mm_read_UBYTE(modreader);\r
+       if((ver>=10)&&(ver<=14)) return 1;\r
+       return 0;\r
+}\r
+\r
+BOOL AMF_Init(void)\r
+{\r
+       if(!(mh=(AMFHEADER*)_mm_malloc(sizeof(AMFHEADER)))) return 0;\r
+       if(!(track=(AMFNOTE*)_mm_calloc(64,sizeof(AMFNOTE)))) return 0;\r
+\r
+       return 1;\r
+}\r
+\r
+void AMF_Cleanup(void)\r
+{\r
+       _mm_free(mh);\r
+       _mm_free(track);\r
+}\r
+\r
+static BOOL AMF_UnpackTrack(MREADER* modreader)\r
+{\r
+       ULONG tracksize;\r
+       UBYTE row,cmd;\r
+       SBYTE arg;\r
+\r
+       /* empty track */\r
+       memset(track,0,64*sizeof(AMFNOTE));\r
+\r
+       /* read packed track */\r
+       if (modreader) {\r
+               tracksize=_mm_read_I_UWORD(modreader);\r
+               tracksize+=((ULONG)_mm_read_UBYTE(modreader))<<16;\r
+               if (tracksize)\r
+                       while(tracksize--) {\r
+                               row=_mm_read_UBYTE(modreader);\r
+                               cmd=_mm_read_UBYTE(modreader);\r
+                               arg=_mm_read_SBYTE(modreader);\r
+                               /* unexpected end of track */\r
+                               if(!tracksize) {\r
+                                       if((row==0xff)&&(cmd==0xff)&&(arg==-1))\r
+                                               break;\r
+                                       /* the last triplet should be FF FF FF, but this is not\r
+                                          always the case... maybe a bug in m2amf ? \r
+                                       else\r
+                                               return 0;\r
+                                       */\r
+\r
+                               }\r
+                               /* invalid row (probably unexpected end of row) */\r
+                               if (row>=64)\r
+                                       return 0;\r
+                               if (cmd<0x7f) {\r
+                                       /* note, vol */\r
+                                       track[row].note=cmd;\r
+                                       track[row].volume=(UBYTE)arg+1;\r
+                               } else\r
+                                 if (cmd==0x7f) {\r
+                                       /* duplicate row */\r
+                                       if ((arg<0)&&(row+arg>=0)) {\r
+                                               memcpy(track+row,track+(row+arg),sizeof(AMFNOTE));\r
+                                       }\r
+                               } else\r
+                                 if (cmd==0x80) {\r
+                                       /* instr */\r
+                                       track[row].instr=arg+1;\r
+                               } else\r
+                                 if (cmd==0x83) {\r
+                                       /* volume without note */\r
+                                       track[row].volume=(UBYTE)arg+1;\r
+                               } else \r
+                                 if (cmd==0xff) {\r
+                                       /* apparently, some M2AMF version fail to estimate the\r
+                                          size of the compressed patterns correctly, and end\r
+                                          up with blanks, i.e. dead triplets. Those are marked\r
+                                          with cmd == 0xff. Let's ignore them. */\r
+                               } else\r
+                                 if(track[row].fxcnt<3) {\r
+                                       /* effect, param */\r
+                                       if(cmd>0x97)\r
+                                               return 0;\r
+                                       track[row].effect[track[row].fxcnt]=cmd&0x7f;\r
+                                       track[row].parameter[track[row].fxcnt]=arg;\r
+                                       track[row].fxcnt++;\r
+                               } else\r
+                                       return 0;\r
+                       }\r
+       }\r
+       return 1;\r
+}\r
+\r
+static UBYTE* AMF_ConvertTrack(void)\r
+{\r
+       int row,fx4memory=0;\r
+\r
+       /* convert track */\r
+       UniReset();\r
+       for (row=0;row<64;row++) {\r
+               if (track[row].instr)  UniInstrument(track[row].instr-1);\r
+               if (track[row].note>OCTAVE) UniNote(track[row].note-OCTAVE);\r
+\r
+               /* AMF effects */\r
+               while(track[row].fxcnt--) {\r
+                       SBYTE inf=track[row].parameter[track[row].fxcnt];\r
+\r
+                       switch(track[row].effect[track[row].fxcnt]) {\r
+                               case 1: /* Set speed */\r
+                                       UniEffect(UNI_S3MEFFECTA,inf);\r
+                                       break;\r
+                               case 2: /* Volume slide */\r
+                                       if(inf) {\r
+                                               UniWriteByte(UNI_S3MEFFECTD);\r
+                                               if (inf>=0)\r
+                                                       UniWriteByte((inf&0xf)<<4);\r
+                                               else\r
+                                                       UniWriteByte((-inf)&0xf);\r
+                                       }\r
+                                       break;\r
+                               /* effect 3, set channel volume, done in UnpackTrack */\r
+                               case 4: /* Porta up/down */\r
+                                       if(inf) {\r
+                                               if(inf>0) {\r
+                                                       UniEffect(UNI_S3MEFFECTE,inf);\r
+                                                       fx4memory=UNI_S3MEFFECTE;\r
+                                               } else {\r
+                                                       UniEffect(UNI_S3MEFFECTF,-inf);\r
+                                                       fx4memory=UNI_S3MEFFECTF;\r
+                                               }\r
+                                       } else if(fx4memory)\r
+                                               UniEffect(fx4memory,0);\r
+                                       break;\r
+                               /* effect 5, "Porta abs", not supported */\r
+                               case 6: /* Porta to note */\r
+                                       UniEffect(UNI_ITEFFECTG,inf);\r
+                                       break;\r
+                               case 7: /* Tremor */\r
+                                       UniEffect(UNI_S3MEFFECTI,inf);\r
+                                       break;\r
+                               case 8: /* Arpeggio */\r
+                                       UniPTEffect(0x0,inf);\r
+                                       break;\r
+                               case 9: /* Vibrato */\r
+                                       UniPTEffect(0x4,inf);\r
+                                       break;\r
+                               case 0xa: /* Porta + Volume slide */\r
+                                       UniPTEffect(0x3,0);\r
+                                       if(inf) {\r
+                                               UniWriteByte(UNI_S3MEFFECTD);\r
+                                               if (inf>=0)\r
+                                                       UniWriteByte((inf&0xf)<<4);\r
+                                               else\r
+                                                       UniWriteByte((-inf)&0xf);\r
+                                       }\r
+                                       break;\r
+                               case 0xb: /* Vibrato + Volume slide */\r
+                                       UniPTEffect(0x4,0);\r
+                                       if(inf) {\r
+                                               UniWriteByte(UNI_S3MEFFECTD);\r
+                                               if (inf>=0)\r
+                                                       UniWriteByte((inf&0xf)<<4);\r
+                                               else\r
+                                                       UniWriteByte((-inf)&0xf);\r
+                                       }\r
+                                       break;\r
+                               case 0xc: /* Pattern break (in hex) */\r
+                                       UniPTEffect(0xd,inf);\r
+                                       break;\r
+                               case 0xd: /* Pattern jump */\r
+                                       UniPTEffect(0xb,inf);\r
+                                       break;\r
+                               /* effect 0xe, "Sync", not supported */\r
+                               case 0xf: /* Retrig */\r
+                                       UniEffect(UNI_S3MEFFECTQ,inf&0xf);\r
+                                       break;\r
+                               case 0x10: /* Sample offset */\r
+                                       UniPTEffect(0x9,inf);\r
+                                       break;\r
+                               case 0x11: /* Fine volume slide */\r
+                                       if(inf) {\r
+                                               UniWriteByte(UNI_S3MEFFECTD);\r
+                                               if (inf>=0)\r
+                                                       UniWriteByte((inf&0xf)<<4|0xf);\r
+                                               else\r
+                                                       UniWriteByte(0xf0|((-inf)&0xf));\r
+                                       }\r
+                                       break;\r
+                               case 0x12: /* Fine portamento */\r
+                                       if(inf) {\r
+                                               if(inf>0) {\r
+                                                       UniEffect(UNI_S3MEFFECTE,0xf0|(inf&0xf));\r
+                                                       fx4memory=UNI_S3MEFFECTE;\r
+                                               } else {\r
+                                                       UniEffect(UNI_S3MEFFECTF,0xf0|((-inf)&0xf));\r
+                                                       fx4memory=UNI_S3MEFFECTF;\r
+                                               }\r
+                                       } else if(fx4memory)\r
+                                               UniEffect(fx4memory,0);\r
+                                       break;\r
+                               case 0x13: /* Delay note */\r
+                                       UniPTEffect(0xe,0xd0|(inf&0xf));\r
+                                       break;\r
+                               case 0x14: /* Note cut */\r
+                                       UniPTEffect(0xc,0);\r
+                                       track[row].volume=0;\r
+                                       break;\r
+                               case 0x15: /* Set tempo */\r
+                                       UniEffect(UNI_S3MEFFECTT,inf);\r
+                                       break;\r
+                               case 0x16: /* Extra fine portamento */\r
+                                       if(inf) {\r
+                                               if(inf>0) {\r
+                                                       UniEffect(UNI_S3MEFFECTE,0xe0|((inf>>2)&0xf));\r
+                                                       fx4memory=UNI_S3MEFFECTE;\r
+                                               } else {\r
+                                                       UniEffect(UNI_S3MEFFECTF,0xe0|(((-inf)>>2)&0xf));\r
+                                                       fx4memory=UNI_S3MEFFECTF;\r
+                                               }\r
+                                       } else if(fx4memory)\r
+                                               UniEffect(fx4memory,0);\r
+                                       break;\r
+                               case 0x17: /* Panning */\r
+                                       if (inf>64)\r
+                                               UniEffect(UNI_ITEFFECTS0,0x91); /* surround */\r
+                                       else\r
+                                               UniPTEffect(0x8,(inf==64)?255:(inf+64)<<1);\r
+                                       of.flags |= UF_PANNING;\r
+                                       break;\r
+                       }\r
+                       \r
+               }\r
+               if (track[row].volume) UniVolEffect(VOL_VOLUME,track[row].volume-1);\r
+               UniNewline();\r
+       }\r
+       return UniDup();\r
+}\r
+\r
+BOOL AMF_Load(BOOL curious)\r
+{\r
+       int t,u,realtrackcnt,realsmpcnt,defaultpanning;\r
+       AMFSAMPLE s;\r
+       SAMPLE *q;\r
+       UWORD *track_remap;\r
+       ULONG samplepos;\r
+       int channel_remap[16];\r
+       (void)curious;\r
+\r
+       /* try to read module header  */\r
+       _mm_read_UBYTES(mh->id,3,modreader);\r
+       mh->version     =_mm_read_UBYTE(modreader);\r
+       _mm_read_string(mh->songname,32,modreader);\r
+       mh->numsamples  =_mm_read_UBYTE(modreader);\r
+       mh->numorders   =_mm_read_UBYTE(modreader);\r
+       mh->numtracks   =_mm_read_I_UWORD(modreader);\r
+       mh->numchannels =_mm_read_UBYTE(modreader);\r
+       if((!mh->numchannels)||(mh->numchannels>(mh->version>=12?32:16))) {\r
+               _mm_errno=MMERR_NOT_A_MODULE;\r
+               return 0;\r
+       }\r
+\r
+       if(mh->version>=11) {\r
+               memset(mh->panpos,0,32);\r
+               _mm_read_SBYTES(mh->panpos,(mh->version>=13)?32:16,modreader);\r
+       } else\r
+               _mm_read_UBYTES(channel_remap,16,modreader);\r
+\r
+       if (mh->version>=13) {\r
+               mh->songbpm=_mm_read_UBYTE(modreader);\r
+               if(mh->songbpm<32) {\r
+                       _mm_errno=MMERR_NOT_A_MODULE;\r
+                       return 0;\r
+               }\r
+               mh->songspd=_mm_read_UBYTE(modreader);\r
+               if(mh->songspd>32) {\r
+                       _mm_errno=MMERR_NOT_A_MODULE;\r
+                       return 0;\r
+               }\r
+       } else {\r
+               mh->songbpm=125;\r
+               mh->songspd=6;\r
+       }\r
+\r
+       if(_mm_eof(modreader)) {\r
+               _mm_errno = MMERR_LOADING_HEADER;\r
+               return 0;\r
+       }\r
+\r
+       /* set module variables */\r
+       of.initspeed = mh->songspd;\r
+       of.inittempo = mh->songbpm;\r
+       AMF_Version[AMFTEXTLEN-3]='0'+(mh->version/10);\r
+       AMF_Version[AMFTEXTLEN-1]='0'+(mh->version%10);\r
+       of.modtype   = strdup(AMF_Version);\r
+       of.numchn    = mh->numchannels;\r
+       of.numtrk    = mh->numorders*mh->numchannels;\r
+       if (mh->numtracks>of.numtrk)\r
+               of.numtrk=mh->numtracks;\r
+       of.numtrk++;    /* add room for extra, empty track */\r
+       of.songname  = DupStr(mh->songname,32,1);\r
+       of.numpos    = mh->numorders;\r
+       of.numpat    = mh->numorders;\r
+       of.reppos    = 0;\r
+       of.flags    |= UF_S3MSLIDES;\r
+       /* XXX whenever possible, we should try to determine the original format.\r
+          Here we assume it was S3M-style wrt bpmlimit... */\r
+       of.bpmlimit = 32;\r
+       \r
+       /*\r
+        * Play with the panning table. Although the AMF format embeds a\r
+        * panning table, if the module was a MOD or an S3M with default\r
+        * panning and didn't use any panning commands, don't flag\r
+        * UF_PANNING, to use our preferred panning table for this case.\r
+        */\r
+       defaultpanning = 1;\r
+       for (t = 0; t < 32; t++) {\r
+               if (mh->panpos[t] > 64) {\r
+                       of.panning[t] = PAN_SURROUND;\r
+                       defaultpanning = 0;\r
+               } else\r
+                       if (mh->panpos[t] == 64)\r
+                               of.panning[t] = PAN_RIGHT;\r
+                       else\r
+                               of.panning[t] = (mh->panpos[t] + 64) << 1;\r
+       }\r
+       if (defaultpanning) {\r
+               for (t = 0; t < of.numchn; t++)\r
+                       if (of.panning[t] == (((t + 1) & 2) ? PAN_RIGHT : PAN_LEFT)) {\r
+                               defaultpanning = 0;     /* not MOD canonical panning */\r
+                               break;\r
+                       }\r
+       }\r
+       if (defaultpanning)\r
+               of.flags |= UF_PANNING;\r
+\r
+       of.numins=of.numsmp=mh->numsamples;\r
+\r
+       if(!AllocPositions(of.numpos)) return 0;\r
+       for(t=0;t<of.numpos;t++)\r
+               of.positions[t]=t;\r
+\r
+       if(!AllocTracks()) return 0;\r
+       if(!AllocPatterns()) return 0;\r
+\r
+       /* read AMF order table */\r
+       for (t=0;t<of.numpat;t++) {\r
+               if (mh->version>=14)\r
+                       /* track size */\r
+                       of.pattrows[t]=_mm_read_I_UWORD(modreader);\r
+               if (mh->version>=10)\r
+                       _mm_read_I_UWORDS(of.patterns+(t*of.numchn),of.numchn,modreader);\r
+               else\r
+                       for(u=0;u<of.numchn;u++)\r
+                               of.patterns[t*of.numchn+channel_remap[u]]=_mm_read_I_UWORD(modreader);\r
+       }\r
+       if(_mm_eof(modreader)) {\r
+               _mm_errno = MMERR_LOADING_HEADER;\r
+               return 0;\r
+       }\r
+\r
+       /* read sample information */\r
+       if(!AllocSamples()) return 0;\r
+       q=of.samples;\r
+       for(t=0;t<of.numins;t++) {\r
+               /* try to read sample info */\r
+               s.type=_mm_read_UBYTE(modreader);\r
+               _mm_read_string(s.samplename,32,modreader);\r
+               _mm_read_string(s.filename,13,modreader);\r
+               s.offset    =_mm_read_I_ULONG(modreader);\r
+               s.length    =_mm_read_I_ULONG(modreader);\r
+               s.c2spd     =_mm_read_I_UWORD(modreader);\r
+               if(s.c2spd==8368) s.c2spd=8363;\r
+               s.volume    =_mm_read_UBYTE(modreader);\r
+               if(mh->version>=11) {\r
+                       s.reppos    =_mm_read_I_ULONG(modreader);\r
+                       s.repend    =_mm_read_I_ULONG(modreader);\r
+               } else {\r
+                       s.reppos    =_mm_read_I_UWORD(modreader);\r
+                       s.repend    =s.length;\r
+               }\r
+\r
+               if(_mm_eof(modreader)) {\r
+                       _mm_errno = MMERR_LOADING_SAMPLEINFO; \r
+                       return 0;\r
+               }\r
+\r
+               q->samplename = DupStr(s.samplename,32,1);\r
+               q->speed     = s.c2spd;\r
+               q->volume    = s.volume;\r
+               if (s.type) {\r
+                       q->seekpos   = s.offset;\r
+                       q->length    = s.length;\r
+                       q->loopstart = s.reppos;\r
+                       q->loopend   = s.repend;\r
+                       if((s.repend-s.reppos)>2) q->flags |= SF_LOOP;\r
+               }\r
+               q++;\r
+       }\r
+\r
+       /* read track table */\r
+       if(!(track_remap=_mm_calloc(mh->numtracks+1,sizeof(UWORD))))\r
+               return 0;\r
+       _mm_read_I_UWORDS(track_remap+1,mh->numtracks,modreader);\r
+       if(_mm_eof(modreader)) {\r
+               free(track_remap);\r
+               _mm_errno=MMERR_LOADING_TRACK;\r
+               return 0;\r
+       }\r
+\r
+       for(realtrackcnt=t=0;t<=mh->numtracks;t++)\r
+               if (realtrackcnt<track_remap[t])\r
+                       realtrackcnt=track_remap[t];\r
+       for(t=0;t<of.numpat*of.numchn;t++)\r
+               of.patterns[t]=(of.patterns[t]<=mh->numtracks)?\r
+                              track_remap[of.patterns[t]]-1:realtrackcnt;\r
+\r
+       free(track_remap);\r
+\r
+       /* unpack tracks */\r
+       for(t=0;t<realtrackcnt;t++) {\r
+               if(_mm_eof(modreader)) {\r
+                       _mm_errno = MMERR_LOADING_TRACK;\r
+                       return 0;\r
+               }\r
+               if (!AMF_UnpackTrack(modreader)) {\r
+                       _mm_errno = MMERR_LOADING_TRACK;\r
+                       return 0;\r
+               }\r
+               if(!(of.tracks[t]=AMF_ConvertTrack()))\r
+                       return 0;\r
+       }\r
+       /* add an extra void track */\r
+       UniReset();\r
+       for(t=0;t<64;t++) UniNewline();\r
+       of.tracks[realtrackcnt++]=UniDup();\r
+       for(t=realtrackcnt;t<of.numtrk;t++) of.tracks[t]=NULL;\r
+\r
+       /* compute sample offsets */\r
+       samplepos=_mm_ftell(modreader);\r
+       for(realsmpcnt=t=0;t<of.numsmp;t++)\r
+               if(realsmpcnt<of.samples[t].seekpos)\r
+                       realsmpcnt=of.samples[t].seekpos;\r
+       for(t=1;t<=realsmpcnt;t++) {\r
+               q=of.samples;\r
+               while(q->seekpos!=t) q++;\r
+               q->seekpos=samplepos;\r
+               samplepos+=q->length;\r
+       }\r
+               \r
+       return 1;\r
+}\r
+\r
+CHAR *AMF_LoadTitle(void)\r
+{\r
+       CHAR s[32];\r
+\r
+       _mm_fseek(modreader,4,SEEK_SET);\r
+       if(!_mm_read_UBYTES(s,32,modreader)) return NULL;\r
+\r
+       return(DupStr(s,32,1));\r
+}\r
+\r
+/*========== Loader information */\r
+\r
+MIKMODAPI MLOADER load_amf={\r
+       NULL,\r
+       "AMF",\r
+       "AMF (DSMI Advanced Module Format)",\r
+       AMF_Init,\r
+       AMF_Test,\r
+       AMF_Load,\r
+       AMF_Cleanup,\r
+       AMF_LoadTitle\r
+};\r
+\r
+/* ex:set ts=4: */\r