apps/plugins/mikmod/load_mtm.c

   1 /*      MikMod sound library
   2         (c) 1998, 1999, 2000, 2001, 2002 Miodrag Vallat and others - see file
   3         AUTHORS for complete list.
   4
   5         This library is free software; you can redistribute it and/or modify
   6         it under the terms of the GNU Library General Public License as
   7         published by the Free Software Foundation; either version 2 of
   8         the License, or (at your option) any later version.
   9
  10         This program is distributed in the hope that it will be useful,
  11         but WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13         GNU Library General Public License for more details.
  14
  15         You should have received a copy of the GNU Library General Public
  16         License along with this library; if not, write to the Free Software
  17         Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  18         02111-1307, USA.
  19 */
  20
  21 /*==============================================================================
  22
  23   $Id: load_mtm.c,v 1.3 2005/04/07 19:57:38 realtech Exp $
  24
  25   MTM module loader
  26
  27 ==============================================================================*/
  28
  29 #ifdef HAVE_CONFIG_H
  30 #include "config.h"
  31 #endif
  32
  33 #ifdef HAVE_UNISTD_H
  34 #include <unistd.h>
  35 #endif
  36
  37 #include <stdio.h>
  38 #ifdef HAVE_MEMORY_H
  39 #include <memory.h>
  40 #endif
  41 #include <string.h>
  42
  43 #include "mikmod_internals.h"
  44
  45 #ifdef SUNOS
  46 extern int fprintf(FILE *, const char *, ...);
  47 #endif
  48
  49 /*========== Module structure */
  50
  51 typedef struct MTMHEADER {
  52         UBYTE id[3];                    /* MTM file marker */
  53         UBYTE version;                  /* upper major, lower nibble minor version number */
  54         CHAR  songname[20];             /* ASCIIZ songname */
  55         UWORD numtracks;                /* number of tracks saved */
  56         UBYTE lastpattern;              /* last pattern number saved */
  57         UBYTE lastorder;                /* last order number to play (songlength-1) */
  58         UWORD commentsize;              /* length of comment field */
  59         UBYTE numsamples;               /* number of samples saved  */
  60         UBYTE attribute;                /* attribute byte (unused) */
  61         UBYTE beatspertrack;
  62         UBYTE numchannels;              /* number of channels used  */
  63         UBYTE panpos[32];               /* voice pan positions */
  64 } MTMHEADER;
  65
  66 typedef struct MTMSAMPLE {
  67         CHAR  samplename[22];
  68         ULONG length;
  69         ULONG reppos;
  70         ULONG repend;
  71         UBYTE finetune;
  72         UBYTE volume;
  73         UBYTE attribute;
  74 } MTMSAMPLE;
  75
  76 typedef struct MTMNOTE {
  77         UBYTE a,b,c;
  78 } MTMNOTE;
  79
  80 /*========== Loader variables */
  81
  82 static MTMHEADER *mh = NULL;
  83 static MTMNOTE *mtmtrk = NULL;
  84 static UWORD pat[32];
  85
  86 static CHAR MTM_Version[] = "MTM";
  87
  88 /*========== Loader code */
  89
  90 static int MTM_Test(void)
  91 {
  92         UBYTE id[3];
  93
  94         if(!_mm_read_UBYTES(id,3,modreader)) return 0;
  95         if(!memcmp(id,"MTM",3)) return 1;
  96         return 0;
  97 }
  98
  99 static int MTM_Init(void)
 100 {
 101         if(!(mtmtrk=(MTMNOTE*)MikMod_calloc(64,sizeof(MTMNOTE)))) return 0;
 102         if(!(mh=(MTMHEADER*)MikMod_malloc(sizeof(MTMHEADER)))) return 0;
 103
 104         return 1;
 105 }
 106
 107 static void MTM_Cleanup(void)
 108 {
 109         MikMod_free(mtmtrk);
 110         MikMod_free(mh);
 111 }
 112
 113 static UBYTE* MTM_Convert(void)
 114 {
 115         int t;
 116         UBYTE a,b,inst,note,eff,dat;
 117
 118         UniReset();
 119         for(t=0;t<64;t++) {
 120                 a=mtmtrk[t].a;
 121                 b=mtmtrk[t].b;
 122                 inst=((a&0x3)<<4)|(b>>4);
 123                 note=a>>2;
 124                 eff=b&0xf;
 125                 dat=mtmtrk[t].c;
 126
 127                 if(inst) UniInstrument(inst-1);
 128                 if(note) UniNote(note+2*OCTAVE);
 129
 130                 /* MTM bug workaround : when the effect is volslide, slide-up *always*
 131                    overrides slide-down. */
 132                 if(eff==0xa && (dat&0xf0)) dat&=0xf0;
 133
 134                 /* Convert pattern jump from Dec to Hex */
 135                 if(eff==0xd)
 136                         dat=(((dat&0xf0)>>4)*10)+(dat&0xf);
 137                 UniPTEffect(eff,dat);
 138                 UniNewline();
 139         }
 140         return UniDup();
 141 }
 142
 143 static int MTM_Load(int curious)
 144 {
 145         int t,u;
 146         MTMSAMPLE s;
 147         SAMPLE *q;
 148     (void)curious;
 149
 150         /* try to read module header  */
 151         _mm_read_UBYTES(mh->id,3,modreader);
 152         mh->version     =_mm_read_UBYTE(modreader);
 153         _mm_read_string(mh->songname,20,modreader);
 154         mh->numtracks   =_mm_read_I_UWORD(modreader);
 155         mh->lastpattern =_mm_read_UBYTE(modreader);
 156         mh->lastorder   =_mm_read_UBYTE(modreader);
 157         mh->commentsize =_mm_read_I_UWORD(modreader);
 158         mh->numsamples  =_mm_read_UBYTE(modreader);
 159         mh->attribute   =_mm_read_UBYTE(modreader);
 160         mh->beatspertrack=_mm_read_UBYTE(modreader);
 161         mh->numchannels =_mm_read_UBYTE(modreader);
 162         _mm_read_UBYTES(mh->panpos,32,modreader);
 163
 164         if(_mm_eof(modreader)) {
 165                 _mm_errno = MMERR_LOADING_HEADER;
 166                 return 0;
 167         }
 168
 169         /* set module variables */
 170         of.initspeed = 6;
 171         of.inittempo = 125;
 172         of.modtype   = StrDup(MTM_Version);
 173         of.numchn    = mh->numchannels;
 174         of.numtrk    = mh->numtracks+1;           /* get number of channels */
 175         of.songname  = DupStr(mh->songname,20,1); /* make a cstr of songname */
 176         of.numpos    = mh->lastorder+1;           /* copy the songlength */
 177         of.numpat    = mh->lastpattern+1;
 178         of.reppos    = 0;
 179         of.flags    |= UF_PANNING;
 180         for(t=0;t<32;t++) of.panning[t]=mh->panpos[t]<< 4;
 181         of.numins=of.numsmp=mh->numsamples;
 182
 183         if(!AllocSamples()) return 0;
 184         q=of.samples;
 185         for(t=0;t<of.numins;t++) {
 186                 /* try to read sample info */
 187                 _mm_read_string(s.samplename,22,modreader);
 188                 s.length    =_mm_read_I_ULONG(modreader);
 189                 s.reppos    =_mm_read_I_ULONG(modreader);
 190                 s.repend    =_mm_read_I_ULONG(modreader);
 191                 s.finetune  =_mm_read_UBYTE(modreader);
 192                 s.volume    =_mm_read_UBYTE(modreader);
 193                 s.attribute =_mm_read_UBYTE(modreader);
 194
 195                 if(_mm_eof(modreader)) {
 196                         _mm_errno = MMERR_LOADING_SAMPLEINFO;
 197                         return 0;
 198                 }
 199
 200                 q->samplename = DupStr(s.samplename,22,1);
 201                 q->seekpos   = 0;
 202                 q->speed     = finetune[s.finetune];
 203                 q->length    = s.length;
 204                 q->loopstart = s.reppos;
 205                 q->loopend   = s.repend;
 206                 q->volume    = s.volume;
 207                 if((s.repend-s.reppos)>2) q->flags |= SF_LOOP;
 208
 209                 if(s.attribute&1) {
 210                         /* If the sample is 16-bits, convert the length and replen
 211                            byte-values into sample-values */
 212                         q->flags|=SF_16BITS;
 213                         q->length>>=1;
 214                         q->loopstart>>=1;
 215                         q->loopend>>=1;
 216                 }
 217                 q++;
 218         }
 219
 220         if(!AllocPositions(of.numpos)) return 0;
 221         for(t=0;t<of.numpos;t++)
 222                 of.positions[t]=_mm_read_UBYTE(modreader);
 223         for(;t<128;t++) (void)_mm_read_UBYTE(modreader);
 224         if(_mm_eof(modreader)) {
 225                 _mm_errno = MMERR_LOADING_HEADER;
 226                 return 0;
 227         }
 228
 229         if(!AllocTracks()) return 0;
 230         if(!AllocPatterns()) return 0;
 231
 232         of.tracks[0]=MTM_Convert();             /* track 0 is empty */
 233         for(t=1;t<of.numtrk;t++) {
 234                 int s;
 235
 236                 for(s=0;s<64;s++) {
 237                         mtmtrk[s].a=_mm_read_UBYTE(modreader);
 238                         mtmtrk[s].b=_mm_read_UBYTE(modreader);
 239                         mtmtrk[s].c=_mm_read_UBYTE(modreader);
 240                 }
 241
 242                 if(_mm_eof(modreader)) {
 243                         _mm_errno = MMERR_LOADING_TRACK;
 244                         return 0;
 245                 }
 246
 247                 if(!(of.tracks[t]=MTM_Convert())) return 0;
 248         }
 249
 250         for(t=0;t<of.numpat;t++) {
 251                 _mm_read_I_UWORDS(pat,32,modreader);
 252                 for(u=0;u<of.numchn;u++)
 253                         of.patterns[((long)t*of.numchn)+u]=pat[u];
 254         }
 255
 256         /* read comment field */
 257         if(mh->commentsize)
 258                 if(!ReadLinedComment(mh->commentsize, 40)) return 0;
 259
 260         return 1;
 261 }
 262
 263 static CHAR *MTM_LoadTitle(void)
 264 {
 265         CHAR s[20];
 266
 267         _mm_fseek(modreader,4,SEEK_SET);
 268         if(!_mm_read_UBYTES(s,20,modreader)) return NULL;
 269
 270         return(DupStr(s,20,1));
 271 }
 272
 273 /*========== Loader information */
 274
 275 MIKMODAPI MLOADER load_mtm={
 276         NULL,
 277         "MTM",
 278         "MTM (MultiTracker Module editor)",
 279         MTM_Init,
 280         MTM_Test,
 281         MTM_Load,
 282         MTM_Cleanup,
 283         MTM_LoadTitle
 284 };
 285
 286 /* ex:set ts=4: */