2
* This source code is public domain.
4
* Authors: Olivier Lapicque <olivierl@jps.net>
7
///////////////////////////////////////////////////////
8
// DMF DELUSION DIGITAL MUSIC FILEFORMAT (X-Tracker) //
9
///////////////////////////////////////////////////////
20
//#pragma warning(disable:4244)
24
typedef struct DMFHEADER
26
DWORD id; // "DDMF" = 0x464d4444
28
CHAR trackername[8]; // "XTRACKER"
34
typedef struct DMFINFO
40
typedef struct DMFSEQU
49
typedef struct DMFPATT
53
WORD numpat; // 1-1024
58
typedef struct DMFTRACK
61
BYTE beat; // [hi|lo] -> hi=ticks per beat, lo=beats per measure
62
WORD ticks; // max 512
66
typedef struct DMFSMPI
73
typedef struct DMFSAMPLE
87
extern void Log(LPCSTR s, ...);
91
BOOL CSoundFile::ReadDMF(const BYTE *lpStream, DWORD dwMemLength)
92
//---------------------------------------------------------------
94
DMFHEADER *pfh = (DMFHEADER *)lpStream;
99
BYTE smplflags[MAX_SAMPLES];
101
if ((!lpStream) || (dwMemLength < 1024)) return FALSE;
102
if ((pfh->id != 0x464d4444) || (!pfh->version) || (pfh->version & 0xF0)) return FALSE;
104
memcpy(m_szNames[0], pfh->songname, 30);
105
m_szNames[0][30] = 0;
106
m_nType = MOD_TYPE_DMF;
109
Log("DMF version %d: \"%s\": %d bytes (0x%04X)\n", pfh->version, m_szNames[0], dwMemLength, dwMemLength);
111
while (dwMemPos + 7 < dwMemLength)
113
DWORD id = *((LPDWORD)(lpStream+dwMemPos));
121
psi = (DMFINFO *)(lpStream+dwMemPos);
122
if (id == 0x47534d43) dwMemPos++;
123
if ((psi->infosize > dwMemLength) || (psi->infosize + dwMemPos + 8 > dwMemLength)) goto dmfexit;
124
if ((psi->infosize >= 8) && (!m_lpszSongComments))
126
m_lpszSongComments = new char[psi->infosize]; // changed from CHAR
127
if (m_lpszSongComments)
129
for (UINT i=0; i<psi->infosize-1; i++)
131
CHAR c = lpStream[dwMemPos+8+i];
133
m_lpszSongComments[i] = 0x0d;
135
m_lpszSongComments[i] = (c < ' ') ? ' ' : c;
137
m_lpszSongComments[psi->infosize-1] = 0;
140
dwMemPos += psi->infosize + 8 - 1;
145
sequ = (DMFSEQU *)(lpStream+dwMemPos);
146
if ((sequ->seqsize >= dwMemLength) || (dwMemPos + sequ->seqsize + 12 > dwMemLength)) goto dmfexit;
148
UINT nseq = sequ->seqsize >> 1;
149
if (nseq >= MAX_ORDERS-1) nseq = MAX_ORDERS-1;
150
if (sequ->loopstart < nseq) m_nRestartPos = sequ->loopstart;
151
for (UINT i=0; i<nseq; i++) Order[i] = (BYTE)sequ->sequ[i];
153
dwMemPos += sequ->seqsize + 8;
160
DMFPATT *patt = (DMFPATT *)(lpStream+dwMemPos);
162
DWORD dwPos = dwMemPos + 11;
163
if ((patt->patsize >= dwMemLength) || (dwMemPos + patt->patsize + 8 > dwMemLength)) goto dmfexit;
164
numpat = patt->numpat;
165
if (numpat > MAX_PATTERNS) numpat = MAX_PATTERNS;
166
m_nChannels = patt->tracks;
167
if (m_nChannels < patt->firstpatinfo) m_nChannels = patt->firstpatinfo;
168
if (m_nChannels > 32) m_nChannels = 32;
169
if (m_nChannels < 4) m_nChannels = 4;
170
for (UINT npat=0; npat<numpat; npat++)
172
DMFTRACK *pt = (DMFTRACK *)(lpStream+dwPos);
174
Log("Pattern #%d: %d tracks, %d rows\n", npat, pt->tracks, pt->ticks);
176
UINT tracks = pt->tracks;
177
if (tracks > 32) tracks = 32;
178
UINT ticks = pt->ticks;
179
if (ticks > 256) ticks = 256;
180
if (ticks < 16) ticks = 16;
182
if ((pt->jmpsize >= dwMemLength) || (dwPos + pt->jmpsize + 4 >= dwMemLength)) break;
183
PatternSize[npat] = (WORD)ticks;
184
MODCOMMAND *m = AllocatePattern(PatternSize[npat], m_nChannels);
185
if (!m) goto dmfexit;
188
dwPos += pt->jmpsize;
191
UINT glbinfobyte = 0;
192
UINT pbeat = (pt->beat & 0xf0) ? pt->beat>>4 : 8;
193
BOOL tempochange = (pt->beat & 0xf0) ? TRUE : FALSE;
194
memset(infobyte, 0, sizeof(infobyte));
195
for (UINT row=0; row<ticks; row++)
197
MODCOMMAND *p = &m[row*m_nChannels];
198
// Parse track global effects
201
BYTE info = lpStream[d++];
203
if ((info & 0x80) && (d < dwPos)) glbinfobyte = lpStream[d++];
205
if ((info) && (d < dwPos)) infoval = lpStream[d++];
208
case 1: ttype = 0; tempo = infoval; tempochange = TRUE; break;
209
case 2: ttype = 1; tempo = infoval; tempochange = TRUE; break;
210
case 3: pbeat = infoval>>4; tempochange = ttype; break;
212
default: if (info) Log("GLB: %02X.%02X\n", info, infoval);
220
for (UINT i=0; i<tracks; i++) if (!infobyte[i])
222
MODCOMMAND cmd = {0,0,0,0,0,0};
223
BYTE info = lpStream[d++];
224
if (info & 0x80) infobyte[i] = lpStream[d++];
228
cmd.instr = lpStream[d++];
233
cmd.note = lpStream[d++];
234
if ((cmd.note) && (cmd.note < 0xfe)) cmd.note &= 0x7f;
235
if ((cmd.note) && (cmd.note < 128)) cmd.note += 24;
240
cmd.volcmd = VOLCMD_VOLUME;
241
cmd.vol = (lpStream[d++]+3)>>2;
246
BYTE efx = lpStream[d++];
247
BYTE eval = lpStream[d++];
251
case 1: if (!cmd.note) cmd.note = 0xFE; break;
254
case 4: if (eval&0xe0) { cmd.command = CMD_S3MCMDEX; cmd.param = (eval>>5)|0xD0; } break;
256
case 5: if (eval&0xe0) { cmd.command = CMD_RETRIG; cmd.param = (eval>>5); } break;
258
case 6: cmd.command = CMD_OFFSET; cmd.param = eval; break;
260
default: Log("FX1: %02X.%02X\n", efx, eval);
267
BYTE efx = lpStream[d++];
268
BYTE eval = lpStream[d++];
272
case 1: if (eval&0xf0) { cmd.command = CMD_S3MCMDEX; cmd.param = (eval>>4)|0x20; } break;
274
case 2: if (eval&0xe0) { cmd.command = CMD_S3MCMDEX; cmd.param = (eval>>5)|0xD0; } break;
276
case 3: if (eval) { cmd.command = CMD_ARPEGGIO; cmd.param = eval; } break;
278
case 4: cmd.command = CMD_PORTAMENTOUP; cmd.param = (eval >= 0xe0) ? 0xdf : eval; break;
279
// 5: Portamento Down
280
case 5: cmd.command = CMD_PORTAMENTODOWN; cmd.param = (eval >= 0xe0) ? 0xdf : eval; break;
281
// 6: Tone Portamento
282
case 6: cmd.command = CMD_TONEPORTAMENTO; cmd.param = eval; break;
284
case 8: cmd.command = CMD_VIBRATO; cmd.param = eval; break;
286
case 12: if (eval & 0xe0) { cmd.command = CMD_S3MCMDEX; cmd.param = (eval>>5)|0xc0; }
287
else if (!cmd.note) { cmd.note = 0xfe; } break;
289
default: Log("FX2: %02X.%02X\n", efx, eval);
296
BYTE efx = lpStream[d++];
297
BYTE eval = lpStream[d++];
301
case 1: if (eval == 0xff) break;
302
eval = (eval+3)>>2; if (eval > 0x0f) eval = 0x0f;
303
cmd.command = CMD_VOLUMESLIDE; cmd.param = eval<<4; break;
305
case 2: if (eval == 0xff) break;
306
eval = (eval+3)>>2; if (eval > 0x0f) eval = 0x0f;
307
cmd.command = CMD_VOLUMESLIDE; cmd.param = eval; break;
309
case 7: if (!cmd.volcmd) { cmd.volcmd = VOLCMD_PANNING; cmd.vol = (eval+3)>>2; }
310
else { cmd.command = CMD_PANNING8; cmd.param = eval; } break;
312
case 8: eval = (eval+3)>>2; if (eval > 0x0f) eval = 0x0f;
313
cmd.command = CMD_PANNINGSLIDE; cmd.param = eval<<4; break;
314
// 9: Pan Slide Right
315
case 9: eval = (eval+3)>>2; if (eval > 0x0f) eval = 0x0f;
316
cmd.command = CMD_PANNINGSLIDE; cmd.param = eval; break;
318
default: Log("FX3: %02X.%02X\n", efx, eval);
324
if (i < m_nChannels) p[i] = cmd;
328
Log("Unexpected EOP: row=%d\n", row);
337
// Find free channel for tempo change
341
UINT speed=6, modtempo=tempo;
342
UINT rpm = ((ttype) && (pbeat)) ? tempo*pbeat : (tempo+1)*15;
343
for (speed=30; speed>1; speed--)
345
modtempo = rpm*speed/24;
346
if (modtempo <= 200) break;
347
if ((speed < 6) && (modtempo < 256)) break;
350
Log("Tempo change: ttype=%d pbeat=%d tempo=%3d -> speed=%d tempo=%d\n",
351
ttype, pbeat, tempo, speed, modtempo);
353
for (UINT ich=0; ich<m_nChannels; ich++) if (!p[ich].command)
357
p[ich].command = CMD_SPEED;
358
p[ich].param = (BYTE)speed;
361
if ((modtempo >= 32) && (modtempo < 256))
363
p[ich].command = CMD_TEMPO;
364
p[ich].param = (BYTE)modtempo;
372
if (d >= dwPos) break;
375
Log(" %d/%d bytes remaining\n", dwPos-d, pt->jmpsize);
377
if (dwPos + 8 >= dwMemLength) break;
379
dwMemPos += patt->patsize + 8;
383
// "SMPI": Sample Info
386
DMFSMPI *pds = (DMFSMPI *)(lpStream+dwMemPos);
387
if (pds->size <= dwMemLength - dwMemPos)
389
DWORD dwPos = dwMemPos + 9;
390
m_nSamples = pds->samples;
391
if (m_nSamples >= MAX_SAMPLES) m_nSamples = MAX_SAMPLES-1;
392
for (UINT iSmp=1; iSmp<=m_nSamples; iSmp++)
394
UINT namelen = lpStream[dwPos];
396
if (dwPos+namelen+1+sizeof(DMFSAMPLE) > dwMemPos+pds->size+8) break;
399
UINT rlen = (namelen < 32) ? namelen : 31;
400
memcpy(m_szNames[iSmp], lpStream+dwPos+1, rlen);
401
m_szNames[iSmp][rlen] = 0;
403
dwPos += namelen + 1;
404
DMFSAMPLE *psh = (DMFSAMPLE *)(lpStream+dwPos);
405
MODINSTRUMENT *psmp = &Ins[iSmp];
406
psmp->nLength = psh->len;
407
psmp->nLoopStart = psh->loopstart;
408
psmp->nLoopEnd = psh->loopend;
409
psmp->nC4Speed = psh->c3speed;
410
psmp->nGlobalVol = 64;
411
psmp->nVolume = (psh->volume) ? ((WORD)psh->volume)+1 : (WORD)256;
412
psmp->uFlags = (psh->flags & 2) ? CHN_16BIT : 0;
413
if (psmp->uFlags & CHN_16BIT) psmp->nLength >>= 1;
414
if (psh->flags & 1) psmp->uFlags |= CHN_LOOP;
415
smplflags[iSmp] = psh->flags;
416
dwPos += (pfh->version < 8) ? 22 : 30;
418
Log("SMPI %d/%d: len=%d flags=0x%02X\n", iSmp, m_nSamples, psmp->nLength, psh->flags);
422
dwMemPos += pds->size + 8;
426
// "SMPD": Sample Data
429
DWORD dwPos = dwMemPos + 8;
431
for (UINT iSmp=1; iSmp<=m_nSamples; iSmp++)
435
if (dwPos + 4 >= dwMemLength)
438
Log("Unexpected EOF at sample %d/%d! (pos=%d)\n", iSmp, m_nSamples, dwPos);
442
pksize = *((LPDWORD)(lpStream+dwPos));
444
Log("sample %d: pos=0x%X pksize=%d ", iSmp, dwPos, pksize);
445
Log("len=%d flags=0x%X [%08X]\n", Ins[iSmp].nLength, smplflags[ismpd], *((LPDWORD)(lpStream+dwPos+4)));
448
if (pksize > dwMemLength - dwPos)
451
Log("WARNING: pksize=%d, but only %d bytes left\n", pksize, dwMemLength-dwPos);
453
pksize = dwMemLength - dwPos;
455
if ((pksize) && (iSmp <= m_nSamples))
457
UINT flags = (Ins[iSmp].uFlags & CHN_16BIT) ? RS_PCM16S : RS_PCM8S;
458
if (smplflags[ismpd] & 4) flags = (Ins[iSmp].uFlags & CHN_16BIT) ? RS_DMF16 : RS_DMF8;
459
ReadSample(&Ins[iSmp], flags, (LPSTR)(lpStream+dwPos), pksize);
467
// "ENDE": end of file
471
// Unrecognized id, or "ENDE" field
482
m_nType = MOD_TYPE_NONE;
491
///////////////////////////////////////////////////////////////////////
496
typedef struct DMF_HNODE
498
short int left, right;
502
typedef struct DMF_HTREE
504
LPBYTE ibuf, ibufmax;
507
UINT lastnode, nodecount;
508
DMF_HNODE nodes[256];
514
// DMF Huffman ReadBits
515
BYTE DMFReadBits(DMF_HTREE *tree, UINT nbits)
516
//-------------------------------------------
518
BYTE x = 0, bitv = 1;
526
tree->bitbuf = (tree->ibuf < tree->ibufmax) ? *(tree->ibuf++) : 0;
529
if (tree->bitbuf & 1) x |= bitv;
537
// tree: [8-bit value][12-bit index][12-bit index] = 32-bit
540
void DMFNewNode(DMF_HTREE *tree)
541
//------------------------------
543
BYTE isleft, isright;
546
actnode = tree->nodecount;
547
if (actnode > 255) return;
548
tree->nodes[actnode].value = DMFReadBits(tree, 7);
549
isleft = DMFReadBits(tree, 1);
550
isright = DMFReadBits(tree, 1);
551
actnode = tree->lastnode;
552
if (actnode > 255) return;
554
tree->lastnode = tree->nodecount;
557
tree->nodes[actnode].left = tree->lastnode;
561
tree->nodes[actnode].left = -1;
563
tree->lastnode = tree->nodecount;
566
tree->nodes[actnode].right = tree->lastnode;
570
tree->nodes[actnode].right = -1;
575
int DMFUnpack(LPBYTE psample, LPBYTE ibuf, LPBYTE ibufmax, UINT maxlen)
576
//----------------------------------------------------------------------
580
BYTE value, sign, delta = 0;
582
memset(&tree, 0, sizeof(tree));
584
tree.ibufmax = ibufmax;
587
for (UINT i=0; i<maxlen; i++)
590
sign = DMFReadBits(&tree, 1);
593
if (DMFReadBits(&tree, 1))
594
actnode = tree.nodes[actnode].right;
596
actnode = tree.nodes[actnode].left;
597
if (actnode > 255) break;
598
delta = tree.nodes[actnode].value;
599
if ((tree.ibuf >= tree.ibufmax) && (!tree.bitnum)) break;
600
} while ((tree.nodes[actnode].left >= 0) && (tree.nodes[actnode].right >= 0));
601
if (sign) delta ^= 0xFF;
603
psample[i] = (i) ? value : 0;
606
// Log("DMFUnpack: %d remaining bytes\n", tree.ibufmax-tree.ibuf);
608
return tree.ibuf - ibuf;
added
removed
gst/modplug/libmodplug/load_dmf.cpp
