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
|
/*
* Load_tcb.cpp
* ------------
* Purpose: TCB Tracker module loader
* Notes : Based on the manual scan available at https://files.scene.org/view/resources/gotpapers/manuals/tcb_tracker_1.0_manual_1990.pdf
* and a bit of messing about in TCB Tracker 1.0 and 1.1.
* Authors: OpenMPT Devs
* The OpenMPT source code is released under the BSD license. Read LICENSE for more details.
*/
#include "stdafx.h"
#include "Loaders.h"
#include "MODTools.h"
OPENMPT_NAMESPACE_BEGIN
struct TCBFileHeader
{
char magic[8]; // "AN COOL." (new) or "AN COOL!" (early TCB Tracker beta versions; not even TCB Tracker 1.0 can read these files)
uint32be numPatterns;
uint8 tempo;
uint8 unused1;
uint8 order[128];
uint8 numOrders;
uint8 unused2; // Supposed to be part of lastOrder but then it would have to be a little-endian word
bool IsNewFormat() const
{
return magic[7] == '.';
}
bool IsValid() const
{
if(memcmp(magic, "AN COOL.", 8) && memcmp(magic, "AN COOL!", 8))
return false;
if(tempo > 15 || unused1 || numOrders > 127 || unused2 || numPatterns > 128)
return false;
for(uint8 ord : order)
{
if(ord >= 128)
return false;
}
return true;
}
uint32 GetHeaderMinimumAdditionalSize() const
{
uint32 size = 16 * 8; // Instrument names
if(IsNewFormat())
size += 2 + 32; // Amiga flag + special values
size += numPatterns * 512;
return size;
}
};
MPT_BINARY_STRUCT(TCBFileHeader, 144)
CSoundFile::ProbeResult CSoundFile::ProbeFileHeaderTCB(MemoryFileReader file, const uint64 *pfilesize)
{
TCBFileHeader fileHeader;
file.Rewind();
if(!file.ReadStruct(fileHeader))
return ProbeWantMoreData;
if(!fileHeader.IsValid())
return ProbeFailure;
return ProbeAdditionalSize(file, pfilesize, fileHeader.GetHeaderMinimumAdditionalSize());
}
bool CSoundFile::ReadTCB(FileReader &file, ModLoadingFlags loadFlags)
{
file.Rewind();
TCBFileHeader fileHeader;
if(!file.ReadStruct(fileHeader) || !fileHeader.IsValid())
return false;
if(!file.CanRead(fileHeader.GetHeaderMinimumAdditionalSize()))
return false;
if(loadFlags == onlyVerifyHeader)
return true;
InitializeGlobals(MOD_TYPE_MOD, 4);
SetupMODPanning(true);
Order().SetDefaultSpeed(16 - fileHeader.tempo);
Order().SetDefaultTempoInt(125);
ReadOrderFromArray(Order(), fileHeader.order, std::max(uint8(1), fileHeader.numOrders));
m_nSamplePreAmp = 64;
m_SongFlags.set(SONG_IMPORTED);
m_playBehaviour.set(kApplyUpperPeriodLimit);
const bool newFormat = fileHeader.IsNewFormat();
bool useAmigaFreqs = false;
if(newFormat)
{
uint16 amigaFreqs = file.ReadUint16BE();
if(amigaFreqs > 1)
return false;
useAmigaFreqs = amigaFreqs != 0;
}
const auto instrNames = file.ReadArray<char[8], 16>();
std::array<int16be, 16> specialValues{};
if(newFormat)
file.ReadStruct(specialValues);
m_nMinPeriod = useAmigaFreqs ? 113 * 4 : 92 * 4;
m_nMaxPeriod = useAmigaFreqs ? 856 * 4 : 694 * 4;
const PATTERNINDEX numPatterns = static_cast<PATTERNINDEX>(fileHeader.numPatterns);
if(loadFlags & loadPatternData)
Patterns.ResizeArray(numPatterns);
const uint8 noteOffset = useAmigaFreqs ? 0 : 3;
for(PATTERNINDEX pat = 0; pat < numPatterns; pat++)
{
if(!(loadFlags & loadPatternData) || !Patterns.Insert(pat, 64))
{
file.Skip(512);
continue;
}
for(ModCommand &m : Patterns[pat])
{
const auto [note, instrEffect] = file.ReadArray<uint8, 2>();
if(note >= 0x10 && note <= 0x3B)
{
m.note = static_cast<ModCommand::NOTE>(NOTE_MIDDLEC - 24 + (note >> 4) * 12 + (note & 0x0F) + noteOffset);
m.instr = static_cast<ModCommand::INSTR>((instrEffect >> 4) + 1);
} else if(note)
{
return false;
}
switch(instrEffect & 0x0F)
{
case 0x00: // Nothing
case 0x0E: // Reserved
case 0x0F: // Reserved
break;
case 0x0B: // Interrupt sample
case 0x0C: // Continue sample after interrupt
m.SetVolumeCommand(VOLCMD_PLAYCONTROL, static_cast<ModCommand::VOL>(((specialValues[0x0B] == 2) ? 5 : 0) + ((instrEffect & 0x0F) - 0x0B)));
break;
case 0x0D: // End Pattern
m.SetEffectCommand(CMD_PATTERNBREAK, 0);
break;
default: // Pitch Bend
if(int value = specialValues[(instrEffect & 0x0F)]; value > 0)
m.SetEffectCommand(CMD_PORTAMENTODOWN, mpt::saturate_cast<ModCommand::PARAM>((value + 16) / 32));
else if(value < 0)
m.SetEffectCommand(CMD_PORTAMENTOUP, mpt::saturate_cast<ModCommand::PARAM>((- value + 16) / 32));
}
}
}
const auto sampleStart = file.GetPosition();
file.Skip(4); // Size of remaining data
FileReader sampleHeaders1 = file.ReadChunk(16 * 4);
FileReader sampleHeaders2 = file.ReadChunk(16 * 8);
SampleIO sampleIO(SampleIO::_8bit, SampleIO::mono, SampleIO::bigEndian, SampleIO::unsignedPCM);
m_nSamples = 16;
for(SAMPLEINDEX smp = 1; smp <= 16; smp++)
{
ModSample &mptSmp = Samples[smp];
mptSmp.Initialize(MOD_TYPE_MOD);
mptSmp.nVolume = std::min(sampleHeaders1.ReadUint8(), uint8(127)) * 2;
sampleHeaders1.Skip(1); // Empty value according to docs
mptSmp.nLoopStart = sampleHeaders1.ReadUint16BE();
uint32 offset = sampleHeaders2.ReadUint32BE();
mptSmp.nLength = sampleHeaders2.ReadUint32BE();
if(mptSmp.nLoopStart && mptSmp.nLoopStart < mptSmp.nLength)
{
mptSmp.nLoopEnd = mptSmp.nLength;
mptSmp.nLoopStart = mptSmp.nLength - mptSmp.nLoopStart;
mptSmp.uFlags.set(CHN_LOOP);
}
if(!useAmigaFreqs)
mptSmp.nFineTune = 5 * 16;
if((loadFlags & loadSampleData) && mptSmp.nLength > 1 && file.Seek(sampleStart + offset))
sampleIO.ReadSample(mptSmp, file);
m_szNames[smp] = mpt::String::ReadBuf(mpt::String::spacePadded, instrNames[smp - 1]);
}
m_modFormat.formatName = newFormat ? UL_("TCB Tracker") : UL_("TCB Tracker (Beta Format)");
m_modFormat.type = UL_("tcb"); // Official file extension is MOD (which is the only extension TCB Tracker accepts), but both ModLand and Fujiology use TCB instead, and this makes it easier to differentiate the format for library users...
m_modFormat.madeWithTracker = newFormat ? UL_("TCB Tracker 1.0 - 2.0") : UL_("TCB Tracker Beta");
m_modFormat.charset = mpt::Charset::AtariST;
return true;
}
OPENMPT_NAMESPACE_END
|
