1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
|
unit MODImport;
{$mode objfpc}{$H+}
interface
uses
Classes, SysUtils, Song, hugedatatypes, fgl, math, constants,
instruments, LazLoggerBase;
function LoadSongFromModStream(Stream: TStream): TSong;
implementation
type
TPeriodToCodeMap = specialize TFPGMap<Integer, Integer>;
// TODO: Find some way to de-duplicate these from the instruments file
// without a circular reference
Bit = Boolean;
TwoBits = 0..%11;
ThreeBits = 0..%111;
FourBits = 0..%1111;
FiveBits = 0..%11111;
SixBits = 0..%111111;
SevenBits = 0..%1111111;
EightBits = Byte;
TwelveBits = 0..%111111111111;
{ TMODSample }
TMODSample = packed record
Name: array[0..21] of char; //string[21];
SampleLength: Word;
Finetune: Byte;
Volume: Byte;
RepeatPoint: Word;
RepeatLength: Word;
end;
{ TMODRawRow }
TMODRawRow = packed array[0..3] of Byte;
{ TMODRow }
TMODRow = record
Note: Integer;
Instrument: Integer;
Effect: bitpacked record
case Boolean of
True: (Code, Params: Byte);
False: (Value: Word);
end
end;
TMODPattern = array[0..63] of array[1..4] of TMODRow;
{ TMODFile }
TMODFile = packed record
Name: array[0..19] of Char; //string[19];
Samples: array[1..31] of TMODSample;
SongLen: Byte;
NumPatternsMagic: Byte;
Positions: array[0..127] of Byte;
MKMagic: array[0..3] of char; //string[3];
Patterns: array of TMODPattern;
end;
const
// https://github.com/AntonioND/gbt-player/blob/master/rgbds_example/gbt_player_bank1.asm
GBT_WAVEFORMS: array[0..7] of array[0..15] of Byte =
(($A5,$D7,$C9,$E1,$BC,$9A,$76,$31,$0C,$BA,$DE,$60,$1B,$CA,$03,$93),
($F0,$E1,$D2,$C3,$B4,$A5,$96,$87,$78,$69,$5A,$4B,$3C,$2D,$1E,$0F),
($FD,$EC,$DB,$CA,$B9,$A8,$97,$86,$79,$68,$57,$46,$35,$24,$13,$02),
($DE,$FE,$DC,$BA,$9A,$A9,$87,$77,$88,$87,$65,$56,$54,$32,$10,$12),
($AB,$CD,$EF,$ED,$CB,$A0,$12,$3E,$DC,$BA,$BC,$DE,$FE,$DC,$32,$10),
($FF,$EE,$DD,$CC,$BB,$AA,$99,$88,$77,$66,$55,$44,$33,$22,$11,$00),
($FF,$FF,$FF,$FF,$FF,$FF,$FF,$FF,$00,$00,$00,$00,$00,$00,$00,$00),
($79,$BC,$DE,$EF,$FF,$EE,$DC,$B9,$75,$43,$21,$10,$00,$11,$23,$45));
// https://github.com/RichardULZ/gb-studio/blob/master/buildTools/win32-ia32/mod2gbt/mod2gbt.c#L169
GBT_NOISE: array of Integer = (
// 7 bit
$5F,$4E,$3E,$2F,$2E,$2C,$1F,$0F,
// 15 bit
$64,$54,$44,$24,$00,
$67,$56,$46
);
var
PeriodToCodeMap: TPeriodToCodeMap;
function RawRowToRegularRow(RawRow: TMODRawRow): TMODRow;
begin
Result.Note := ((RawRow[0] and %1111) shl 8) or RawRow[1];
Result.Effect.Code := RawRow[2] and %1111;
Result.Effect.Params := RawRow[3];
Result.Instrument := (RawRow[0] and %11110000) or ((RawRow[2] and %11110000) shr 4);
end;
function ConvertNote(Note: Integer): Integer;
begin
if Note = 0 then
Result := NO_NOTE
else if not PeriodToCodeMap.TryGetData(Note, Result) then
Result := LOWEST_NOTE;
end;
function ConvertInstrument(Instr: Integer): Integer;
begin
Result := EnsureRange(Instr, 0, 15);
end;
procedure ConvertEffect(Code, Params: Byte; out OutCode: Integer; out OutParams: TEffectParams);
var
EP: TEffectParams absolute Params;
label IdentityEffect;
begin
case Code of
$F, $B, $D: begin
OutCode := Code;
OutParams.Value := Params + 1;
end;
$9: begin
OutCode := $C;
OutParams.Param1 := Lo(Params);
OutParams.Param2 := Hi(Params);
end;
$C: begin
if Params <> 0 then begin
OutCode := $C;
OutParams.Value := Round((Params / $40)*$F);
end else begin
OutCode := $E;
OutParams.Value := 0;
end;
end;
$E: begin
if EP.Param1 = $C then begin
OutCode := $E;
OutParams.Value := EP.Param2;
end
else goto IdentityEffect;
end;
else begin
IdentityEffect:
OutCode := Code;
OutParams.Value := Params;
end;
end
end;
function ConvertCell(MC: TMODRow): TCell;
begin
Result.Note := ConvertNote(MC.Note);
Result.Instrument := ConvertInstrument(MC.Instrument);
ConvertEffect(MC.Effect.Code, MC.Effect.Params, Result.EffectCode, Result.EffectParams);
end;
function ConvertCellCh4(MR: TMODRow): TCell;
var
Instrument: Byte;
NoiseBreak: Byte;
Noise: Byte;
PolyCounter: TPolynomialCounterRegister;
Ch4Freq: Integer;
RealR: Double;
NoteIndex: Integer;
begin
// https://github.com/RichardULZ/gb-studio/blob/bf6d60ee2530791cae009e3a8cb6b28f900f08d7/buildTools/win32-ia32/mod2gbt/mod2gbt.c#L827
// This makes a smooth Ramp of every noise type, inspired by Pigu-A's Cherry Blossom Dive
// SSSS WDDD, preserve Width bit, combine Shift + Divisor (ignore bit 0100), add pitch.
// Divisor 4,5,6,7 can make any noise found in 0,1,2,3 unless with 0 Clock Shift.
// Solution, add 4, add note, if less than 4, set bit 0x04 to 0, and remove 4 again.
// Notes will pitch correctly using C D# F# A# C, scale has been divided by 3.
if PeriodToCodeMap.TryGetData(MR.Note, NoteIndex) then begin
Noise := 0;
NoiseBreak := 0;
if (MR.Instrument < 16) then
DebugLn(['[DEBUG] Note value ', MR.Note, ' was accompanied by incorrect instrument ', MR.Instrument]);
if (MR.Instrument < 32) and (MR.Instrument > 16) then begin
Instrument := GBT_NOISE[((MR.Instrument - 16) and $1F)]; // Only 0 - 0xF implemented
NoiseBreak := ((Instrument and $03) or (((Instrument and $F0) shr 2) + 4));
NoiseBreak := NoiseBreak - (Trunc((NoteIndex + 1) / 3) - 8);
Noise := ((NoiseBreak and $03) or
((IfThen((NoiseBreak - 4) < 0, $0, (NoiseBreak - 4)) and $3C) shl 2) or
IfThen(NoiseBreak > 3, $04, $0)) or (Instrument and $08);
PolyCounter.ByteValue := Noise;
if PolyCounter.DividingRatio = 0 then
RealR := 0.5
else
RealR := PolyCounter.DividingRatio;
Ch4Freq := Trunc((524288 / RealR) / 2**(PolyCounter.ShiftClockFrequency+1));
if not Ch4FreqToNoteCodeMap.TryGetData(Ch4Freq, Result.Note) then
DebugLn(['[DEBUG] Note value ', Result.Note, ' not found.']);
end else
Result.Note := NO_NOTE;
end else
Result.Note := NO_NOTE;
if MR.Instrument <> 0 then
Result.Instrument := 1
else
Result.Instrument := 0;
ConvertEffect(MR.Effect.Code, MR.Effect.Params, Result.EffectCode, Result.EffectParams);
end;
procedure TranscribeColumn(MP: TMODPattern; Pat: PPattern; Column: Integer);
var
I: Integer;
LastPlayedNote: Integer;
LastPlayedInstrument: Integer;
begin
LastPlayedNote := C_5;
LastPlayedInstrument := 0;
for I := Low(MP) to High(MP) do begin
if Column = 4 then
Pat^[I] := ConvertCellCh4(MP[I, Column])
else
Pat^[I] := ConvertCell(MP[I, Column]);
if (Pat^[I].EffectCode = $C) then begin
if (Pat^[I].Instrument = 0) then
Pat^[I].Instrument := LastPlayedInstrument;
if (Pat^[I].Note = NO_NOTE) then
Pat^[I].Note := LastPlayedNote;
end;
if (Pat^[I].Note <> NO_NOTE) then LastPlayedNote := Pat^[I].Note;
if (Pat^[I].Instrument <> 0) then LastPlayedInstrument := Pat^[I].Instrument;
end;
end;
function LoadSongFromModStream(Stream: TStream): TSong;
var
ModFile: TMODFile;
I, J, K: Integer;
MaxOrder: Integer;
RawRow: TMODRawRow;
begin
Stream.Read(ModFile, SizeOf(ModFile) - SizeOf(ModFile.Patterns));
for I := Low(ModFile.Samples) to High(ModFile.Samples) do
with ModFile.Samples[I] do begin
SampleLength := BEtoN(SampleLength);
RepeatPoint := BEtoN(RepeatPoint);
RepeatLength := BEtoN(RepeatLength);
end;
MaxOrder := 0;
for I := Low(ModFile.Positions) to High(ModFile.Positions) do
if ModFile.Positions[I] > MaxOrder then
MaxOrder := ModFile.Positions[I];
SetLength(ModFile.Patterns, MaxOrder+1);
for I := 0 to MaxOrder do
for J := Low(TMODPattern) to High(TMODPattern) do
for K := 1 to 4 do begin
Stream.Read(RawRow, SizeOf(TMODRawRow));
ModFile.Patterns[I, J, K] := RawRowToRegularRow(RawRow);
end;
InitializeSong(Result);
// Create the instruments.
// First four are just the default instrument with a different duty cycle.
Result.Instruments.Duty[1].Duty := 1;
Result.Instruments.Duty[2].Duty := 2;
Result.Instruments.Duty[3].Duty := 3;
Result.Instruments.Duty[4].Duty := 0;
for I := 8 to 15 do
with Result.Instruments.Wave[I] do begin
Waveform := I - 8;
Type_ := itWave;
end;
// Waveforms.
for I := Low(GBT_WAVEFORMS) to High(GBT_WAVEFORMS) do
for J := Low(GBT_WAVEFORMS[I]) to High(GBT_WAVEFORMS[I]) do begin
Result.Waves[I, J*2] := hi(GBT_WAVEFORMS[I, J]);
Result.Waves[I, (J*2) + 1] := lo(GBT_WAVEFORMS[I, J]);
end;
// Convert all patterns
for I := Low(ModFile.Patterns) to High(ModFile.Patterns) do begin
TranscribeColumn(ModFile.Patterns[I], Result.Patterns.GetOrCreateNew(I*10 + 0), 1);
TranscribeColumn(ModFile.Patterns[I], Result.Patterns.GetOrCreateNew(I*10 + 1), 2);
TranscribeColumn(ModFile.Patterns[I], Result.Patterns.GetOrCreateNew(I*10 + 2), 3);
TranscribeColumn(ModFile.Patterns[I], Result.Patterns.GetOrCreateNew(I*10 + 3), 4);
end;
// Import the order table. Uses a weird numbering scheme because hUGE has
// 4 separate patterns like AHX and unlike MOD.
for I := Low(Result.OrderMatrix) to High(Result.OrderMatrix) do begin
SetLength(Result.OrderMatrix[I], ModFile.SongLen+1);
for J := 0 to ModFile.SongLen do
Result.OrderMatrix[I, J] := (ModFile.Positions[J]*10) + I;
end;
Result.Name := ModFile.Name;
end;
begin
PeriodToCodeMap := TPeriodToCodeMap.Create;
PeriodToCodeMap.add(1712,0);
PeriodToCodeMap.add(1616,1);
PeriodToCodeMap.add(1524,2);
PeriodToCodeMap.add(1440,3);
PeriodToCodeMap.add(1356,4);
PeriodToCodeMap.add(1280,5);
PeriodToCodeMap.add(1208,6);
PeriodToCodeMap.add(1140,7);
PeriodToCodeMap.add(1076,8);
PeriodToCodeMap.add(1016,9);
PeriodToCodeMap.add(960,10);
PeriodToCodeMap.add(907,11);
PeriodToCodeMap.add(856,12);
PeriodToCodeMap.add(808,13);
PeriodToCodeMap.add(762,14);
PeriodToCodeMap.add(720,15);
PeriodToCodeMap.add(678,16);
PeriodToCodeMap.add(640,17);
PeriodToCodeMap.add(604,18);
PeriodToCodeMap.add(570,19);
PeriodToCodeMap.add(538,20);
PeriodToCodeMap.add(508,21);
PeriodToCodeMap.add(480,22);
PeriodToCodeMap.add(453,23);
PeriodToCodeMap.add(428,24);
PeriodToCodeMap.add(404,25);
PeriodToCodeMap.add(381,26);
PeriodToCodeMap.add(360,27);
PeriodToCodeMap.add(339,28);
PeriodToCodeMap.add(320,29);
PeriodToCodeMap.add(302,30);
PeriodToCodeMap.add(285,31);
PeriodToCodeMap.add(269,32);
PeriodToCodeMap.add(254,33);
PeriodToCodeMap.add(240,34);
PeriodToCodeMap.add(226,35);
PeriodToCodeMap.add(214,36);
PeriodToCodeMap.add(202,37);
PeriodToCodeMap.add(190,38);
PeriodToCodeMap.add(180,39);
PeriodToCodeMap.add(170,40);
PeriodToCodeMap.add(160,41);
PeriodToCodeMap.add(151,42);
PeriodToCodeMap.add(143,43);
PeriodToCodeMap.add(135,44);
PeriodToCodeMap.add(127,45);
PeriodToCodeMap.add(120,46);
PeriodToCodeMap.add(113,47);
PeriodToCodeMap.add(107,48);
PeriodToCodeMap.add(101,49);
PeriodToCodeMap.add(95, 50);
PeriodToCodeMap.add(90, 51);
PeriodToCodeMap.add(85, 52);
PeriodToCodeMap.add(80, 53);
PeriodToCodeMap.add(75, 54);
PeriodToCodeMap.add(71, 55);
PeriodToCodeMap.add(67, 56);
PeriodToCodeMap.add(63, 57);
PeriodToCodeMap.add(60, 58);
PeriodToCodeMap.add(56, 59);
PeriodToCodeMap.add(53, 60);
PeriodToCodeMap.add(50, 61);
PeriodToCodeMap.add(47, 62);
PeriodToCodeMap.add(45, 63);
PeriodToCodeMap.add(42, 64);
PeriodToCodeMap.add(40, 65);
PeriodToCodeMap.add(37, 66);
PeriodToCodeMap.add(35, 67);
PeriodToCodeMap.add(33, 68);
PeriodToCodeMap.add(31, 69);
PeriodToCodeMap.add(30, 70);
PeriodToCodeMap.add(28, 71);
end.
|
