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 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
|
/*
* XMTools.cpp
* -----------
* Purpose: Definition of XM file structures and helper functions
* Notes : (currently none)
* 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 "XMTools.h"
#include "Sndfile.h"
#include "../common/version.h"
#include <algorithm>
OPENMPT_NAMESPACE_BEGIN
// Convert OpenMPT's internal envelope representation to XM envelope data.
void XMInstrument::ConvertEnvelopeToXM(const InstrumentEnvelope &mptEnv, uint8le &numPoints, uint8le &flags, uint8le &sustain, uint8le &loopStart, uint8le &loopEnd, EnvType env)
{
numPoints = static_cast<uint8>(std::min<std::size_t>(12u, mptEnv.size()));
// Envelope Data
for(uint8 i = 0; i < numPoints; i++)
{
switch(env)
{
case EnvTypeVol:
volEnv[i * 2] = std::min(mptEnv[i].tick, uint16_max);
volEnv[i * 2 + 1] = std::min(mptEnv[i].value, uint8(64));
break;
case EnvTypePan:
panEnv[i * 2] = std::min(mptEnv[i].tick, uint16_max);
panEnv[i * 2 + 1] = std::min(mptEnv[i].value, uint8(63));
break;
}
}
// Envelope Flags
if(mptEnv.dwFlags[ENV_ENABLED]) flags |= XMInstrument::envEnabled;
if(mptEnv.dwFlags[ENV_SUSTAIN]) flags |= XMInstrument::envSustain;
if(mptEnv.dwFlags[ENV_LOOP]) flags |= XMInstrument::envLoop;
// Envelope Loops
sustain = std::min(uint8(12), mptEnv.nSustainStart);
loopStart = std::min(uint8(12), mptEnv.nLoopStart);
loopEnd = std::min(uint8(12), mptEnv.nLoopEnd);
}
// Convert OpenMPT's internal sample representation to an XMInstrument.
uint16 XMInstrument::ConvertToXM(const ModInstrument &mptIns, bool compatibilityExport)
{
MemsetZero(*this);
// FFF is maximum in the FT2 GUI, but it can also accept other values. MilkyTracker just allows 0...4095 and 32767 ("cut")
volFade = static_cast<uint16>(std::min(mptIns.nFadeOut, uint32(32767)));
// Convert envelopes
ConvertEnvelopeToXM(mptIns.VolEnv, volPoints, volFlags, volSustain, volLoopStart, volLoopEnd, EnvTypeVol);
ConvertEnvelopeToXM(mptIns.PanEnv, panPoints, panFlags, panSustain, panLoopStart, panLoopEnd, EnvTypePan);
// Create sample assignment table
auto sampleList = GetSampleList(mptIns, compatibilityExport);
for(size_t i = 0; i < CountOf(sampleMap); i++)
{
if(mptIns.Keyboard[i + 12] > 0)
{
auto sample = std::find(sampleList.begin(), sampleList.end(), mptIns.Keyboard[i + 12]);
if(sample != sampleList.end())
{
// Yep, we want to export this sample.
sampleMap[i] = static_cast<uint8>(sample - sampleList.begin());
}
}
}
if(mptIns.nMidiChannel != MidiNoChannel)
{
midiEnabled = 1;
midiChannel = (mptIns.nMidiChannel != MidiMappedChannel ? (mptIns.nMidiChannel - MidiFirstChannel) : 0);
}
midiProgram = (mptIns.nMidiProgram != 0 ? mptIns.nMidiProgram - 1 : 0);
pitchWheelRange = std::min(mptIns.midiPWD, int8(36));
return static_cast<uint16>(sampleList.size());
}
// Get a list of samples that should be written to the file.
std::vector<SAMPLEINDEX> XMInstrument::GetSampleList(const ModInstrument &mptIns, bool compatibilityExport) const
{
std::vector<SAMPLEINDEX> sampleList; // List of samples associated with this instrument
std::vector<bool> addedToList; // Which samples did we already add to the sample list?
uint8 numSamples = 0;
for(size_t i = 0; i < CountOf(sampleMap); i++)
{
const SAMPLEINDEX smp = mptIns.Keyboard[i + 12];
if(smp > 0)
{
if(smp > addedToList.size())
{
addedToList.resize(smp, false);
}
if(!addedToList[smp - 1] && numSamples < (compatibilityExport ? 16 : 32))
{
// We haven't considered this sample yet.
addedToList[smp - 1] = true;
numSamples++;
sampleList.push_back(smp);
}
}
}
return sampleList;
}
// Convert XM envelope data to an OpenMPT's internal envelope representation.
void XMInstrument::ConvertEnvelopeToMPT(InstrumentEnvelope &mptEnv, uint8 numPoints, uint8 flags, uint8 sustain, uint8 loopStart, uint8 loopEnd, EnvType env) const
{
mptEnv.resize(std::min<uint8>(numPoints, 12));
// Envelope Data
for(uint32 i = 0; i < mptEnv.size(); i++)
{
switch(env)
{
case EnvTypeVol:
mptEnv[i].tick = volEnv[i * 2];
mptEnv[i].value = static_cast<EnvelopeNode::value_t>(volEnv[i * 2 + 1]);
break;
case EnvTypePan:
mptEnv[i].tick = panEnv[i * 2];
mptEnv[i].value = static_cast<EnvelopeNode::value_t>(panEnv[i * 2 + 1]);
break;
}
if(i > 0 && mptEnv[i].tick < mptEnv[i - 1].tick)
{
// libmikmod code says: "Some broken XM editing program will only save the low byte of the position
// value. Try to compensate by adding the missing high byte."
// Note: It appears that MPT 1.07's XI instrument saver omitted the high byte of envelope nodes.
// This might be the source for some broken envelopes in IT and XM files.
mptEnv[i].tick &= 0xFF;
mptEnv[i].tick += mptEnv[i - 1].tick & 0xFF00;
if(mptEnv[i].tick < mptEnv[i - 1].tick) mptEnv[i].tick += 0x100;
}
}
// Envelope Flags
mptEnv.dwFlags.reset();
if((flags & XMInstrument::envEnabled) != 0 && !mptEnv.empty()) mptEnv.dwFlags.set(ENV_ENABLED);
// Envelope Loops
if(sustain < 12)
{
if((flags & XMInstrument::envSustain) != 0) mptEnv.dwFlags.set(ENV_SUSTAIN);
mptEnv.nSustainStart = mptEnv.nSustainEnd = sustain;
}
if(loopEnd < 12 && loopEnd >= loopStart)
{
if((flags & XMInstrument::envLoop) != 0) mptEnv.dwFlags.set(ENV_LOOP);
mptEnv.nLoopStart = loopStart;
mptEnv.nLoopEnd = loopEnd;
}
}
// Convert an XMInstrument to OpenMPT's internal instrument representation.
void XMInstrument::ConvertToMPT(ModInstrument &mptIns) const
{
mptIns.nFadeOut = volFade;
// Convert envelopes
ConvertEnvelopeToMPT(mptIns.VolEnv, volPoints, volFlags, volSustain, volLoopStart, volLoopEnd, EnvTypeVol);
ConvertEnvelopeToMPT(mptIns.PanEnv, panPoints, panFlags, panSustain, panLoopStart, panLoopEnd, EnvTypePan);
// Create sample assignment table
for(size_t i = 0; i < CountOf(sampleMap); i++)
{
mptIns.Keyboard[i + 12] = sampleMap[i];
}
if(midiEnabled)
{
mptIns.nMidiChannel = midiChannel + MidiFirstChannel;
Limit(mptIns.nMidiChannel, uint8(MidiFirstChannel), uint8(MidiLastChannel));
mptIns.nMidiProgram = static_cast<uint8>(std::min<uint16>(midiProgram, 127) + 1);
}
mptIns.midiPWD = static_cast<int8>(pitchWheelRange);
}
// Apply auto-vibrato settings from sample to file.
void XMInstrument::ApplyAutoVibratoToXM(const ModSample &mptSmp, MODTYPE fromType)
{
vibType = mptSmp.nVibType;
vibSweep = mptSmp.nVibSweep;
vibDepth = mptSmp.nVibDepth;
vibRate = mptSmp.nVibRate;
if((vibDepth | vibRate) != 0 && !(fromType & MOD_TYPE_XM))
{
if(mptSmp.nVibSweep != 0)
vibSweep = mpt::saturate_cast<decltype(vibSweep)::base_type>(Util::muldivr_unsigned(mptSmp.nVibDepth, 256, mptSmp.nVibSweep));
else
vibSweep = 255;
}
}
// Apply auto-vibrato settings from file to a sample.
void XMInstrument::ApplyAutoVibratoToMPT(ModSample &mptSmp) const
{
mptSmp.nVibType = static_cast<VibratoType>(vibType.get());
mptSmp.nVibSweep = vibSweep;
mptSmp.nVibDepth = vibDepth;
mptSmp.nVibRate = vibRate;
}
// Write stuff to the header that's always necessary (also for empty instruments)
void XMInstrumentHeader::Finalise()
{
size = sizeof(XMInstrumentHeader);
if(numSamples > 0)
{
sampleHeaderSize = sizeof(XMSample);
} else
{
// TODO: FT2 completely ignores MIDI settings (and also the less important stuff) if not at least one (empty) sample is assigned to this instrument!
size -= sizeof(XMInstrument);
sampleHeaderSize = 0;
}
}
// Convert OpenMPT's internal sample representation to an XMInstrumentHeader.
void XMInstrumentHeader::ConvertToXM(const ModInstrument &mptIns, bool compatibilityExport)
{
numSamples = instrument.ConvertToXM(mptIns, compatibilityExport);
mpt::String::Write<mpt::String::spacePadded>(name, mptIns.name);
type = mptIns.nMidiProgram; // If FT2 writes crap here, we can do so, too! (we probably shouldn't, though. This is just for backwards compatibility with old MPT versions.)
}
// Convert an XMInstrumentHeader to OpenMPT's internal instrument representation.
void XMInstrumentHeader::ConvertToMPT(ModInstrument &mptIns) const
{
instrument.ConvertToMPT(mptIns);
// Create sample assignment table
for(size_t i = 0; i < CountOf(instrument.sampleMap); i++)
{
if(instrument.sampleMap[i] < numSamples)
{
mptIns.Keyboard[i + 12] = instrument.sampleMap[i];
} else
{
mptIns.Keyboard[i + 12] = 0;
}
}
mpt::String::Read<mpt::String::spacePadded>(mptIns.name, name);
// Old MPT backwards compatibility
if(!instrument.midiEnabled)
{
mptIns.nMidiProgram = type;
}
}
// Convert OpenMPT's internal sample representation to an XIInstrumentHeader.
void XIInstrumentHeader::ConvertToXM(const ModInstrument &mptIns, bool compatibilityExport)
{
numSamples = instrument.ConvertToXM(mptIns, compatibilityExport);
memcpy(signature, "Extended Instrument: ", 21);
mpt::String::Write<mpt::String::spacePadded>(name, mptIns.name);
eof = 0x1A;
const std::string openMptTrackerName = mpt::ToCharset(mpt::CharsetCP437, Version::Current().GetOpenMPTVersionString());
mpt::String::Write<mpt::String::spacePadded>(trackerName, openMptTrackerName);
version = 0x102;
}
// Convert an XIInstrumentHeader to OpenMPT's internal instrument representation.
void XIInstrumentHeader::ConvertToMPT(ModInstrument &mptIns) const
{
instrument.ConvertToMPT(mptIns);
// Fix sample assignment table
for(size_t i = 12; i < CountOf(instrument.sampleMap) + 12; i++)
{
if(mptIns.Keyboard[i] >= numSamples)
{
mptIns.Keyboard[i] = 0;
}
}
mpt::String::Read<mpt::String::spacePadded>(mptIns.name, name);
}
// Convert OpenMPT's internal sample representation to an XMSample.
void XMSample::ConvertToXM(const ModSample &mptSmp, MODTYPE fromType, bool compatibilityExport)
{
MemsetZero(*this);
// Volume / Panning
vol = static_cast<uint8>(std::min(mptSmp.nVolume / 4u, 64u));
pan = static_cast<uint8>(std::min(mptSmp.nPan, uint16(255)));
// Sample Frequency
if((fromType & (MOD_TYPE_MOD | MOD_TYPE_XM)))
{
finetune = mptSmp.nFineTune;
relnote = mptSmp.RelativeTone;
} else
{
int f2t = ModSample::FrequencyToTranspose(mptSmp.nC5Speed);
relnote = (int8)(f2t >> 7);
finetune = (int8)(f2t & 0x7F);
}
flags = 0;
if(mptSmp.uFlags[CHN_PINGPONGLOOP])
flags |= XMSample::sampleBidiLoop;
else if(mptSmp.uFlags[CHN_LOOP])
flags |= XMSample::sampleLoop;
// Sample Length and Loops
length = mpt::saturate_cast<uint32>(mptSmp.nLength);
loopStart = mpt::saturate_cast<uint32>(mptSmp.nLoopStart);
loopLength = mpt::saturate_cast<uint32>(mptSmp.nLoopEnd - mptSmp.nLoopStart);
if(mptSmp.uFlags[CHN_16BIT])
{
flags |= XMSample::sample16Bit;
length *= 2;
loopStart *= 2;
loopLength *= 2;
}
if(mptSmp.uFlags[CHN_STEREO] && !compatibilityExport)
{
flags |= XMSample::sampleStereo;
length *= 2;
loopStart *= 2;
loopLength *= 2;
}
}
// Convert an XMSample to OpenMPT's internal sample representation.
void XMSample::ConvertToMPT(ModSample &mptSmp) const
{
mptSmp.Initialize(MOD_TYPE_XM);
// Volume
mptSmp.nVolume = vol * 4;
LimitMax(mptSmp.nVolume, uint16(256));
// Panning
mptSmp.nPan = pan;
mptSmp.uFlags = CHN_PANNING;
// Sample Frequency
mptSmp.nFineTune = finetune;
mptSmp.RelativeTone = relnote;
// Sample Length and Loops
mptSmp.nLength = length;
mptSmp.nLoopStart = loopStart;
mptSmp.nLoopEnd = mptSmp.nLoopStart + loopLength;
if((flags & XMSample::sample16Bit))
{
mptSmp.nLength /= 2;
mptSmp.nLoopStart /= 2;
mptSmp.nLoopEnd /= 2;
}
if((flags & XMSample::sampleStereo))
{
mptSmp.nLength /= 2;
mptSmp.nLoopStart /= 2;
mptSmp.nLoopEnd /= 2;
}
if((flags & (XMSample::sampleLoop | XMSample::sampleBidiLoop)) && mptSmp.nLoopStart < mptSmp.nLength && mptSmp.nLoopEnd > mptSmp.nLoopStart)
{
mptSmp.uFlags.set(CHN_LOOP);
if((flags & XMSample::sampleBidiLoop))
{
mptSmp.uFlags.set(CHN_PINGPONGLOOP);
}
}
strcpy(mptSmp.filename, "");
}
// Retrieve the internal sample format flags for this instrument.
SampleIO XMSample::GetSampleFormat() const
{
if(reserved == sampleADPCM && !(flags & (XMSample::sample16Bit | XMSample::sampleStereo)))
{
// MODPlugin :(
return SampleIO(SampleIO::_8bit, SampleIO::mono, SampleIO::littleEndian, SampleIO::ADPCM);
}
return SampleIO(
(flags & XMSample::sample16Bit) ? SampleIO::_16bit : SampleIO::_8bit,
(flags & XMSample::sampleStereo) ? SampleIO::stereoSplit : SampleIO::mono,
SampleIO::littleEndian,
SampleIO::deltaPCM);
}
OPENMPT_NAMESPACE_END
|