ref: 8457c7dcbb4115460ae4d882982763fbeb80595c
dir: /src/ft2_module_loader.c/
// for finding memory leaks in debug mode with Visual Studio #if defined _DEBUG && defined _MSC_VER #include <crtdbg.h> #endif #include <stdio.h> #include <stdint.h> #include <stdbool.h> #ifndef _WIN32 #include <unistd.h> #endif #include "ft2_header.h" #include "ft2_config.h" #include "ft2_scopes.h" #include "ft2_trim.h" #include "ft2_inst_ed.h" #include "ft2_sample_ed.h" #include "ft2_wav_renderer.h" #include "ft2_pattern_ed.h" #include "ft2_gui.h" #include "ft2_diskop.h" #include "ft2_sample_loader.h" #include "ft2_mouse.h" #include "ft2_midi.h" #include "ft2_events.h" #include "ft2_video.h" #include "ft2_tables.h" #include "ft2_structs.h" /* This is a *HUGE* mess! ** I hope you never have to modify it, and you probably shouldn't either. ** You will experience a lot of headaches if you dig into this file... ** If something looks to be wrong, it's probably right! ** ** The actual module load routines are ported from FT2 and slightly modified. */ enum { FORMAT_NONE = 0, FORMAT_XM = 1, FORMAT_MOD = 2, FORMAT_S3M = 3, FORMAT_STM = 4 }; // .MOD types enum { FORMAT_MK, // ProTracker or compatible FORMAT_FLT, // StarTrekker (4-channel modules only) FORMAT_FT2, // FT2 (or other trackers, multichannel) FORMAT_STK, // The Ultimate SoundTracker (15 samples) FORMAT_NT, // NoiseTracker FORMAT_HMNT, // His Master's NoiseTracker (special one) FORMAT_UNKNOWN // may be The Ultimate Soundtracker (set to FORMAT_STK later) }; // DO NOT TOUCH THESE STRUCTS! #ifdef _MSC_VER #pragma pack(push) #pragma pack(1) #endif typedef struct songSTMinstrHeaderTyp_t { char name[12]; uint8_t nul, insDisk; uint16_t reserved1, len, repS, repE; uint8_t vol, reserved2; uint16_t rate; int32_t reserved3; uint16_t paraLen; } #ifdef __GNUC__ __attribute__ ((packed)) #endif songSTMinstrHeaderTyp; typedef struct songSTMHeaderTyp_t { char name[20], sig[8]; uint8_t id1a, typ; uint8_t verMajor, verMinor; uint8_t tempo, ap, vol, reserved[13]; songSTMinstrHeaderTyp instr[31]; uint8_t songTab[128]; } #ifdef __GNUC__ __attribute__ ((packed)) #endif songSTMHeaderTyp; typedef struct songS3MinstrHeaderTyp_t { uint8_t typ; char dosName[12]; uint8_t memSegH; uint16_t memSeg; int32_t len, repS, repE; uint8_t vol, dsk, pack, flags; int32_t c2Spd, res1; uint16_t gusPos; uint8_t res2[6]; char name[28], id[4]; } #ifdef __GNUC__ __attribute__ ((packed)) #endif songS3MinstrHeaderTyp; typedef struct songS3MHeaderTyp_t { char name[28]; uint8_t id1a, typ; uint16_t res1; int16_t songTabLen, antInstr, antPatt; uint16_t flags, trackerID, ver; char id[4]; uint8_t globalVol, defSpeed, defTempo, masterVol, res2[12], chanType[32]; } #ifdef __GNUC__ __attribute__ ((packed)) #endif songS3MHeaderTyp; #ifdef _MSC_VER #pragma pack(pop) #endif static volatile uint8_t loadedFormat; static volatile bool linearFreqTable, musicIsLoading, moduleLoaded, moduleFailedToLoad; static uint8_t oldPlayMode, pattBuff[12288], packedPattData[65536]; static const uint8_t stmEff[16] = { 0, 0, 11, 0, 10, 2, 1, 3, 4, 7, 0, 5 ,6, 0, 0, 0 }; static SDL_Thread *thread; // these temporarily read to, then copied to real struct if load was OK (should not need to be volatile'd) static int16_t pattLensTmp[MAX_PATTERNS]; static uint32_t extraSampleLengths[32-MAX_SMP_PER_INST]; // ModPlug Tracker & OpenMPT supports up to 32 samples per instrument in .XM static tonTyp *pattTmp[MAX_PATTERNS]; static instrTyp *instrTmp[1+MAX_INST]; static songTyp songTmp; static void setupLoadedModule(void); static void freeTmpModule(void); static bool loadInstrHeader(FILE *f, uint16_t i, bool externalThreadFlag); static bool loadInstrSample(FILE *f, uint16_t i, bool externalThreadFlag); void unpackPatt(uint8_t *dst, uint8_t *src, uint16_t len, int32_t antChn); static bool tmpPatternEmpty(uint16_t nr); static bool loadPatterns(FILE *f, uint16_t antPtn, bool externalThreadFlag); void checkSampleRepeat(sampleTyp *s); // ft2_replayer.c extern const char modSig[32][5]; static bool allocateTmpInstr(int16_t nr) { instrTyp *p; if (instrTmp[nr] != NULL) return false; // already allocated p = (instrTyp *)calloc(1, sizeof (instrTyp)); if (p == NULL) return false; for (int8_t i = 0; i < MAX_SMP_PER_INST; i++) // set standard sample pan/vol { p->samp[i].pan = 128; p->samp[i].vol = 64; } instrTmp[nr] = p; return true; } #define IS_ID(s, b) !strncmp(s, b, 4) static uint8_t getModType(uint8_t *numChannels, const char *id) { uint8_t modFormat = FORMAT_UNKNOWN; *numChannels = 4; if (IS_ID("M.K.", id) || IS_ID("M!K!", id) || IS_ID("NSMS", id) || IS_ID("LARD", id) || IS_ID("PATT", id)) { modFormat = FORMAT_MK; // ProTracker or compatible } else if (id[1] == 'C' && id[2] == 'H' && id[3] == 'N') { modFormat = FORMAT_FT2; // FT2 or generic multichannel *numChannels = id[0] - '0'; } else if (id[2] == 'C' && (id[3] == 'H' || id[3] == 'N')) { modFormat = FORMAT_FT2; // FT2 or generic multichannel *numChannels = ((id[0] - '0') * 10) + (id[1] - '0'); } else if (IS_ID("FLT4", id)) { modFormat = FORMAT_FLT; // StarTrekker (4-channel modules only) } else if (IS_ID("N.T.", id)) { modFormat = FORMAT_NT; // NoiseTracker } else if (IS_ID("M&K!", id) || IS_ID("FEST", id)) { modFormat = FORMAT_HMNT; // His Master's NoiseTracker } return modFormat; } static bool loadMusicMOD(FILE *f, uint32_t fileLength, bool externalThreadFlag) { char ID[16]; bool mightBeSTK, lateSTKVerFlag, veryLateSTKVerFlag; uint8_t bytes[4], modFormat, numChannels; int16_t i, j, k, ai; uint16_t a, b, period; tonTyp *ton; sampleTyp *s; songMOD31HeaderTyp h_MOD31; songMOD15HeaderTyp h_MOD15; int16_t (*showMsg)(int16_t, const char *, const char *); showMsg = externalThreadFlag ? okBoxThreadSafe : okBox; veryLateSTKVerFlag = false; // "DFJ SoundTracker III" nad later lateSTKVerFlag = false; // "TJC SoundTracker II" and later mightBeSTK = false; memset(&songTmp, 0, sizeof (songTmp)); memset(&h_MOD31, 0, sizeof (songMOD31HeaderTyp)); memset(&h_MOD15, 0, sizeof (songMOD15HeaderTyp)); // start loading MOD loadedFormat = FORMAT_MOD; rewind(f); fread(ID, 1, 16, f); fseek(f, 0x1D, SEEK_SET); fread(bytes, 1, 1, f); rewind(f); // since .mod is the last format tested, check if the file is an .it module (Impulse Tracker) if (!memcmp(ID, "IMPM", 4) && bytes[0] == 0) { showMsg(0, "System message", "Error: Impulse Tracker modules are not supported!"); goto modLoadError; } // check if the file to load is a WAV, if so reject it if (!memcmp(ID, "RIFF", 4) && !memcmp(&ID[8], "WAVEfmt", 7)) { showMsg(0, "System message", "Error: Can't load a .wav file as a module!"); goto modLoadError; } if (fileLength < 1596 || fileLength > 20842494) // minimum and maximum possible size for a supported .mod { showMsg(0, "System message", "Error: This file is either not a module, or is not supported."); goto modLoadError; } if (fread(&h_MOD31, 1, sizeof (h_MOD31), f) != sizeof (h_MOD31)) { showMsg(0, "System message", "Error: This file is either not a module, or is not supported."); goto modLoadError; } modFormat = getModType(&numChannels, h_MOD31.sig); if (modFormat == FORMAT_FLT && numChannels == 8) { showMsg(0, "System message", "8-channel Startrekker modules are not supported!"); goto modLoadError; } if (modFormat != FORMAT_UNKNOWN) { if (fileLength < sizeof (h_MOD31)) { showMsg(0, "System message", "Error: This file is either not a module, or is not supported."); goto modLoadError; } songTmp.antChn = numChannels; songTmp.len = h_MOD31.len; songTmp.repS = h_MOD31.repS; memcpy(songTmp.songTab, h_MOD31.songTab, 128); ai = 31; } else { mightBeSTK = true; if (fileLength < sizeof (h_MOD15)) { showMsg(0, "System message", "Error: This file is not a module!"); goto modLoadError; } rewind(f); if (fread(&h_MOD15, 1, sizeof (h_MOD15), f) != sizeof (h_MOD15)) { showMsg(0, "System message", "Error: This file is either not a module, or is not supported."); goto modLoadError; } songTmp.antChn = numChannels; songTmp.len = h_MOD15.len; songTmp.repS = h_MOD15.repS; memcpy(songTmp.songTab, h_MOD15.songTab, 128); ai = 15; } if (modFormat == FORMAT_MK && songTmp.len == 129) songTmp.len = 127; // fixes a specific copy of beatwave.mod (FIXME: Do we want to keep this digsuting hack?) if (songTmp.antChn == 0 || songTmp.len < 1 || songTmp.len > 128 || (mightBeSTK && songTmp.repS > 220)) { showMsg(0, "System message", "Error: This file is either not a module, or is not supported."); goto modLoadError; } for (a = 0; a < ai; a++) { songMODInstrHeaderTyp *smp = &h_MOD31.instr[a]; if (modFormat != FORMAT_HMNT) // most of "His Master's Noisetracker" songs have junk sample names, so let's not load them { // trim off spaces at end of name for (i = 21; i >= 0; i--) { if (smp->name[i] == ' ' || smp->name[i] == 0x1A) smp->name[i] = '\0'; else break; } memcpy(songTmp.instrName[1+a], smp->name, 22); songTmp.instrName[1+a][22] = '\0'; } /* Only late versions of Ultimate SoundTracker could have samples larger than 9999 bytes. ** If found, we know for sure that this is a late STK module. */ if (mightBeSTK && 2*SWAP16(smp->len) > 9999) lateSTKVerFlag = true; } songTmp.speed = 125; if (mightBeSTK) { /* If we're still here at this point and the mightBeSTK flag is set, ** then it's most likely a proper The Ultimate SoundTracker (STK/UST) module. */ modFormat = FORMAT_STK; if (songTmp.repS == 0) songTmp.repS = 120; // jjk55.mod by Jesper Kyd has a bogus STK tempo value that should be ignored (hackish!) if (!strcmp("jjk55", h_MOD31.name)) songTmp.repS = 120; // The "restart pos" field in STK is the inital tempo (must be converted to BPM first) if (songTmp.repS != 120) // 120 is a special case and means 50Hz (125BPM) { if (songTmp.repS > 220) songTmp.repS = 220; // convert UST tempo to BPM uint16_t ciaPeriod = (240 - songTmp.repS) * 122; double dHz = 709379.0 / ciaPeriod; int32_t BPM = (int32_t)((dHz * 2.5) + 0.5); songTmp.speed = (uint16_t)BPM; } songTmp.repS = 0; } else if (songTmp.repS >= songTmp.len) { songTmp.repS = 0; } // trim off spaces at end of name for (i = 19; i >= 0; i--) { if (h_MOD31.name[i] == ' ' || h_MOD31.name[i] == 0x1A) h_MOD31.name[i] = '\0'; else break; } memcpy(songTmp.name, h_MOD31.name, 20); songTmp.name[20] = '\0'; // count number of patterns b = 0; for (a = 0; a < 128; a++) { if (songTmp.songTab[a] > b) b = songTmp.songTab[a]; } b++; for (a = 0; a < b; a++) { pattTmp[a] = (tonTyp *)calloc((MAX_PATT_LEN * TRACK_WIDTH) + 16, 1); if (pattTmp[a] == NULL) { showMsg(0, "System message", "Not enough memory!"); goto modLoadError; } pattLensTmp[a] = 64; for (j = 0; j < 64; j++) { for (k = 0; k < songTmp.antChn; k++) { ton = &pattTmp[a][(j * MAX_VOICES) + k]; if (fread(bytes, 1, 4, f) != 4) { showMsg(0, "System message", "Error: This file is either not a module, or is not supported."); goto modLoadError; } // period to note period = ((bytes[0] & 0x0F) << 8) | bytes[1]; for (i = 0; i < 8*12; i++) { if (period >= amigaPeriod[i]) { ton->ton = (uint8_t)i + 1; break; } } ton->instr = (bytes[0] & 0xF0) | (bytes[2] >> 4); ton->effTyp = bytes[2] & 0x0F; ton->eff = bytes[3]; if (modFormat == FORMAT_STK) { if (ton->effTyp == 0xC || ton->effTyp == 0xD || ton->effTyp == 0xE) { // "TJC SoundTracker II" and later lateSTKVerFlag = true; } if (ton->effTyp == 0xF) { // "DFJ SoundTracker III" and later lateSTKVerFlag = true; veryLateSTKVerFlag = true; } } if (ton->effTyp == 0xC) { if (ton->eff > 64) ton->eff = 64; } else if (ton->effTyp == 0x1) { if (ton->eff == 0) ton->effTyp = 0; } else if (ton->effTyp == 0x2) { if (ton->eff == 0) ton->effTyp = 0; } else if (ton->effTyp == 0x5) { if (ton->eff == 0) ton->effTyp = 0x3; } else if (ton->effTyp == 0x6) { if (ton->eff == 0) ton->effTyp = 0x4; } else if (ton->effTyp == 0xA) { if (ton->eff == 0) ton->effTyp = 0; } else if (ton->effTyp == 0xE) { // check if certain E commands are empty if (ton->eff == 0x10 || ton->eff == 0x20 || ton->eff == 0xA0 || ton->eff == 0xB0) { ton->effTyp = 0; ton->eff = 0; } } } } if (tmpPatternEmpty(a)) { if (pattTmp[a] != NULL) { free(pattTmp[a]); pattTmp[a] = NULL; } } } // pattern command conversion for non-PT formats if (modFormat == FORMAT_STK || modFormat == FORMAT_NT || modFormat == FORMAT_HMNT || modFormat == FORMAT_FLT) { for (a = 0; a < b; a++) { if (pattTmp[a] == NULL) continue; for (j = 0; j < 64; j++) { for (k = 0; k < songTmp.antChn; k++) { ton = &pattTmp[a][(j * MAX_VOICES) + k]; if (modFormat == FORMAT_NT || modFormat == FORMAT_HMNT) { // any Dxx == D00 in NT/HMNT if (ton->effTyp == 0xD) ton->eff = 0; // effect F with param 0x00 does nothing in NT/HMNT if (ton->effTyp == 0xF && ton->eff == 0) ton->effTyp = 0; } else if (modFormat == FORMAT_FLT) // Startrekker { if (ton->effTyp == 0xE) // remove unsupported "assembly macros" command { ton->effTyp = 0; ton->eff = 0; } // Startrekker is always in vblank mode, and limits speed to 0x1F if (ton->effTyp == 0xF && ton->eff > 0x1F) ton->eff = 0x1F; } else if (modFormat == FORMAT_STK) { // convert STK effects to PT effects if (!lateSTKVerFlag) { // old SoundTracker 1.x commands if (ton->effTyp == 1) { // arpeggio ton->effTyp = 0; } else if (ton->effTyp == 2) { // pitch slide if (ton->eff & 0xF0) { // pitch slide down ton->effTyp = 2; ton->eff >>= 4; } else if (ton->eff & 0x0F) { // pitch slide up ton->effTyp = 1; } } } else { // "DFJ SoundTracker II" or later if (ton->effTyp == 0xD) { if (veryLateSTKVerFlag) // "DFJ SoundTracker III" or later { // pattern break w/ no param (param must be cleared to fix some songs) ton->eff = 0; } else { // volume slide ton->effTyp = 0xA; } } } // effect F with param 0x00 does nothing in UST/STK (I think?) if (ton->effTyp == 0xF && ton->eff == 0) ton->effTyp = 0; } } } } } for (a = 0; a < ai; a++) { if (h_MOD31.instr[a].len == 0) continue; if (!allocateTmpInstr(1+a)) { showMsg(0, "System message", "Not enough memory!"); goto modLoadError; } setNoEnvelope(instrTmp[1+a]); s = &instrTmp[1+a]->samp[0]; s->len = 2 * SWAP16(h_MOD31.instr[a].len); if (modFormat != FORMAT_HMNT) // most of "His Master's Noisetracker" songs have junk sample names, so let's not load them memcpy(s->name, songTmp.instrName[1+a], 22); if (modFormat == FORMAT_HMNT) // finetune in "His Master's NoiseTracker" is different h_MOD31.instr[a].fine = (uint8_t)((-h_MOD31.instr[a].fine & 0x1F) >> 1); // one more bit of precision, + inverted if (modFormat != FORMAT_STK) s->fine = 8 * ((2 * ((h_MOD31.instr[a].fine & 0xF) ^ 8)) - 16); s->pan = 128; s->vol = h_MOD31.instr[a].vol; if (s->vol > 64) s->vol = 64; s->repS = 2 * SWAP16(h_MOD31.instr[a].repS); s->repL = 2 * SWAP16(h_MOD31.instr[a].repL); if (s->repL < 2) s->repL = 2; // in The Ultimate SoundTracker, sample loop start is in bytes, not words if (modFormat == FORMAT_STK) s->repS >>= 1; // fix for poorly converted STK (< v2.5) -> PT/NT modules (FIXME: Worth keeping or not?) if (modFormat != FORMAT_STK && s->repL > 2 && s->repS+s->repL > s->len) { if ((s->repS>>1)+s->repL <= s->len) s->repS >>= 1; } // fix overflown loop if (s->repS+s->repL > s->len) { if (s->repS >= s->len) { s->repS = 0; s->repL = 0; } else { s->repL = s->len - s->repS; } } if (s->repS+s->repL > 2) s->typ = 1; // enable loop /* For Ultimate SoundTracker modules, only the loop area of a looped sample is played. ** Skip loading of eventual data present before loop start. */ if (modFormat == FORMAT_STK && s->repS > 0 && s->repL < s->len) { s->len -= s->repS; fseek(f, s->repS, SEEK_CUR); s->repS = 0; } s->pek = NULL; s->origPek = (int8_t *)malloc(s->len + LOOP_FIX_LEN); if (s->origPek == NULL) { showMsg(0, "System message", "Not enough memory!"); goto modLoadError; } s->pek = s->origPek + SMP_DAT_OFFSET; int32_t bytesRead = (int32_t)fread(s->pek, 1, s->len, f); if (bytesRead < s->len) { int32_t bytesToClear = s->len - bytesRead; memset(&s->pek[bytesRead], 0, bytesToClear); } // clear repL and repS on non-looping samples... if (s->typ == 0) { s->repL = 0; s->repS = 0; } fixSample(s); } fclose(f); songTmp.initialTempo = songTmp.tempo = 6; moduleLoaded = true; return true; modLoadError: fclose(f); freeTmpModule(); moduleFailedToLoad = true; return false; } static uint8_t stmTempoToBPM(uint8_t tempo) // ported from original ST2.3 replayer code { const uint8_t slowdowns[16] = { 140, 50, 25, 15, 10, 7, 6, 4, 3, 3, 2, 2, 2, 2, 1, 1 }; uint32_t bpm; uint16_t hz = 50; hz -= ((slowdowns[tempo >> 4] * (tempo & 15)) >> 4); // can and will underflow bpm = (hz << 1) + (hz >> 1); // BPM = hz * 2.5 return (uint8_t)CLAMP(bpm, 32, 255); // result can be slightly off, but close enough... } static bool loadMusicSTM(FILE *f, uint32_t fileLength, bool externalThreadFlag) { uint8_t typ, tempo; int16_t i, j, k, ap, tmp; uint16_t a; tonTyp *ton; sampleTyp *s; songSTMHeaderTyp h_STM; int16_t (*showMsg)(int16_t, const char *, const char *); showMsg = externalThreadFlag ? okBoxThreadSafe : okBox; rewind(f); // start loading STM if (fread(&h_STM, 1, sizeof (h_STM), f) != sizeof (h_STM)) return loadMusicMOD(f, fileLength, externalThreadFlag); // file is not a .stm, try to load as .mod if (memcmp(h_STM.sig, "!Scream!", 8) && memcmp(h_STM.sig, "BMOD2STM", 8) && memcmp(h_STM.sig, "WUZAMOD!", 8) && memcmp(h_STM.sig, "SWavePro", 8)) { return loadMusicMOD(f, fileLength, externalThreadFlag); // file is not a .stm, try to load as .mod } loadedFormat = FORMAT_STM; if (h_STM.verMinor == 0 || h_STM.typ != 2) { showMsg(0, "System message", "Error loading .stm: Incompatible module!"); goto stmLoadError; } songTmp.antChn = 4; memcpy(songTmp.songTab, h_STM.songTab, 128); i = 0; while (i < 128 && songTmp.songTab[i] < 99) i++; songTmp.len = i + (i == 0); if (songTmp.len < 255) memset(&songTmp.songTab[songTmp.len], 0, 256 - songTmp.len); // trim off spaces at end of name for (i = 19; i >= 0; i--) { if (h_STM.name[i] == ' ' || h_STM.name[i] == 0x1A) h_STM.name[i] = '\0'; else break; } memcpy(songTmp.name, h_STM.name, 20); songTmp.name[20] = '\0'; tempo = h_STM.tempo; if (h_STM.verMinor < 21) tempo = ((tempo / 10) << 4) + (tempo % 10); if (tempo == 0) tempo = 96; songTmp.initialTempo = songTmp.tempo = CLAMP(h_STM.tempo >> 4, 1, 31); songTmp.speed = stmTempoToBPM(tempo); if (h_STM.verMinor > 10) songTmp.globVol = MIN(h_STM.vol, 64); ap = h_STM.ap; for (i = 0; i < ap; i++) { pattTmp[i] = (tonTyp *)calloc((MAX_PATT_LEN * TRACK_WIDTH) + 16, 1); if (pattTmp[i] == NULL) { showMsg(0, "System message", "Not enough memory!"); goto stmLoadError; } pattLensTmp[i] = 64; if (fread(pattBuff, 64 * 4 * 4, 1, f) != 1) { showMsg(0, "System message", "General I/O error during loading!"); goto stmLoadError; } a = 0; for (j = 0; j < 64; j++) { for (k = 0; k < 4; k++) { ton = &pattTmp[i][(j * MAX_VOICES) + k]; if (pattBuff[a] == 254) { ton->ton = 97; } else if (pattBuff[a] < 96) { ton->ton = (12 * (pattBuff[a] >> 4)) + (25 + (pattBuff[a] & 0x0F)); if (ton->ton > 96) ton->ton = 0; } else { ton->ton = 0; } ton->instr = pattBuff[a + 1] >> 3; typ = (pattBuff[a + 1] & 7) + ((pattBuff[a + 2] & 0xF0) >> 1); if (typ <= 64) ton->vol = typ + 0x10; ton->eff = pattBuff[a + 3]; tmp = pattBuff[a + 2] & 0x0F; if (tmp == 1) { ton->effTyp = 15; if (h_STM.verMinor < 21) ton->eff = ((ton->eff / 10) << 4) + (ton->eff % 10); ton->eff >>= 4; } else if (tmp == 3) { ton->effTyp = 13; ton->eff = 0; } else if (tmp == 2 || (tmp >= 4 && tmp <= 12)) { ton->effTyp = stmEff[tmp]; if (ton->effTyp == 0xA) { if (ton->eff & 0x0F) ton->eff &= 0x0F; else ton->eff &= 0xF0; } } else { ton->eff = 0; } if (ton->effTyp > 35) { ton->effTyp = 0; ton->eff = 0; } a += 4; } } if (tmpPatternEmpty(i)) { if (pattTmp[i] != NULL) { free(pattTmp[i]); pattTmp[i] = NULL; } } } for (i = 0; i < 31; i++) { // trim off spaces at end of name for (j = 11; j >= 0; j--) { if (h_STM.instr[i].name[j] == ' ' || h_STM.instr[i].name[j] == 0x1A) h_STM.instr[i].name[j] = '\0'; else break; } memset(&songTmp.instrName[1+i], 0, sizeof (songTmp.instrName[1+i])); memcpy(&songTmp.instrName[1+i], h_STM.instr[i].name, 12); if (h_STM.instr[i].len != 0 && h_STM.instr[i].reserved1 != 0) { allocateTmpInstr(1 + i); setNoEnvelope(instrTmp[i]); s = &instrTmp[1+i]->samp[0]; s->pek = NULL; s->origPek = (int8_t *)malloc(h_STM.instr[i].len + LOOP_FIX_LEN); if (s->origPek == NULL) { showMsg(0, "System message", "Not enough memory!"); goto stmLoadError; } s->pek = s->origPek + SMP_DAT_OFFSET; s->len = h_STM.instr[i].len; tuneSample(s, h_STM.instr[i].rate); s->vol = h_STM.instr[i].vol; s->repS = h_STM.instr[i].repS; s->repL = h_STM.instr[i].repE - h_STM.instr[i].repS; s->pan = 128; if (s->repS < s->len && h_STM.instr[i].repE > s->repS && h_STM.instr[i].repE != 0xFFFF) { if (s->repS+s->repL > s->len) s->repL = s->len - s->repS; s->typ = 1; // enable loop } else { s->repS = 0; s->repL = 0; s->typ = 0; } if (s->vol > 64) s->vol = 64; if (fread(s->pek, s->len, 1, f) != 1) { showMsg(0, "System message", "General I/O error during loading! Possibly corrupt module?"); goto stmLoadError; } fixSample(s); } } fclose(f); moduleLoaded = true; return true; stmLoadError: fclose(f); freeTmpModule(); moduleFailedToLoad = true; return false; } static int8_t countS3MChannels(uint16_t antPtn) { uint8_t j, k, channels; int16_t i; tonTyp ton; channels = 0; for (i = 0; i < antPtn; i++) { if (pattTmp[i] == NULL) continue; for (j = 0; j < 64; j++) { for (k = 0; k < MAX_VOICES; k++) { ton = pattTmp[i][(j * MAX_VOICES) + k]; if (ton.eff == 0 && ton.effTyp == 0 && ton.instr == 0 && ton.ton == 0 && ton.vol == 0) continue; if (k > channels) channels = k; } } } channels++; return channels; } static bool loadMusicS3M(FILE *f, uint32_t dataLength, bool externalThreadFlag) { int8_t *tmpSmp; uint8_t ha[2048]; uint8_t alastnfo[32], alastefx[32], alastvibnfo[32], s3mLastGInstr[32]; uint8_t typ; int16_t ai, ap, ver, ii, kk, tmp; uint16_t ptnOfs[256]; int32_t i, j, k, len; tonTyp ton; sampleTyp *s; songS3MHeaderTyp h_S3M; songS3MinstrHeaderTyp h_S3MInstr; int16_t (*showMsg)(int16_t, const char *, const char *); showMsg = externalThreadFlag ? okBoxThreadSafe : okBox; rewind(f); // start loading S3M if (fread(&h_S3M, 1, sizeof (h_S3M), f) != sizeof (h_S3M)) return loadMusicSTM(f, dataLength, externalThreadFlag); // not a .s3m, try loading as .stm if (memcmp(h_S3M.id, "SCRM", 4)) return loadMusicSTM(f, dataLength, externalThreadFlag); // not a .s3m, try loading as .stm loadedFormat = FORMAT_S3M; if (h_S3M.antInstr > MAX_INST || h_S3M.songTabLen > 256 || h_S3M.antPatt > 256 || h_S3M.typ != 16 || h_S3M.ver < 1 || h_S3M.ver > 2) { showMsg(0, "System message", "Error loading .s3m: Incompatible module!"); goto s3mLoadError; } memset(songTmp.songTab, 255, sizeof (songTmp.songTab)); if (fread(songTmp.songTab, h_S3M.songTabLen, 1, f) != 1) { showMsg(0, "System message", "General I/O error during loading! Is the file in use?"); goto s3mLoadError; } songTmp.len = h_S3M.songTabLen; // remove pattern separators (254) k = 0; j = 0; for (i = 0; i < songTmp.len; i++) { if (songTmp.songTab[i] != 254) songTmp.songTab[j++] = songTmp.songTab[i]; else k++; } if (k <= songTmp.len) songTmp.len -= (uint16_t)k; else songTmp.len = 1; for (i = 1; i < songTmp.len; i++) { if (songTmp.songTab[i] == 255) { songTmp.len = (uint16_t)i; break; } } // clear unused song table entries if (songTmp.len < 255) memset(&songTmp.songTab[songTmp.len], 0, 255-songTmp.len); songTmp.speed = h_S3M.defTempo; if (songTmp.speed < 32) songTmp.speed = 32; songTmp.tempo = h_S3M.defSpeed; if (songTmp.tempo == 0) songTmp.tempo = 6; if (songTmp.tempo > 31) songTmp.tempo = 31; songTmp.initialTempo = songTmp.tempo; // trim off spaces at end of name for (i = 19; i >= 0; i--) { if (h_S3M.name[i] == ' ' || h_S3M.name[i] == 0x1A) h_S3M.name[i] = '\0'; else break; } memcpy(songTmp.name, h_S3M.name, 20); songTmp.name[20] = '\0'; ap = h_S3M.antPatt; ai = h_S3M.antInstr; ver = h_S3M.ver; k = 31; while (k >= 0 && h_S3M.chanType[k] >= 16) k--; songTmp.antChn = (k + 2) & 254; if (fread(ha, ai + ai, 1, f) != 1) { showMsg(0, "System message", "General I/O error during loading! Is the file in use?"); goto s3mLoadError; } if (fread(ptnOfs, ap + ap, 1, f) != 1) { showMsg(0, "System message", "General I/O error during loading! Is the file in use?"); goto s3mLoadError; } // *** PATTERNS *** k = 0; for (i = 0; i < ap; i++) { if (ptnOfs[i] == 0) continue; // empty pattern memset(alastnfo, 0, sizeof (alastnfo)); memset(alastefx, 0, sizeof (alastefx)); memset(alastvibnfo, 0, sizeof (alastvibnfo)); memset(s3mLastGInstr, 0, sizeof (s3mLastGInstr)); fseek(f, ptnOfs[i] << 4, SEEK_SET); if (feof(f)) continue; if (fread(&j, 2, 1, f) != 1) { showMsg(0, "System message", "General I/O error during loading! Is the file in use?"); goto s3mLoadError; } if (j > 0 && j <= 12288) { pattTmp[i] = (tonTyp *)calloc((MAX_PATT_LEN * TRACK_WIDTH) + 16, 1); if (pattTmp[i] == NULL) { showMsg(0, "System message", "Not enough memory!"); goto s3mLoadError; } pattLensTmp[i] = 64; fread(pattBuff, j, 1, f); k = 0; kk = 0; while (k < j && kk < 64) { typ = pattBuff[k++]; if (typ == 0) { kk++; } else { ii = typ & 31; memset(&ton, 0, sizeof (ton)); // note and sample if (typ & 32) { ton.ton = pattBuff[k++]; ton.instr = pattBuff[k++]; if (ton.instr > MAX_INST) ton.instr = 0; if (ton.ton == 254) ton.ton = 97; else if (ton.ton == 255) ton.ton = 0; else { ton.ton = 1 + (ton.ton & 0xF) + (ton.ton >> 4) * 12; if (ton.ton > 96) ton.ton = 0; } } // volume column if (typ & 64) { ton.vol = pattBuff[k++]; if (ton.vol <= 64) ton.vol += 0x10; else ton.vol = 0; } // effect if (typ & 128) { ton.effTyp = pattBuff[k++]; ton.eff = pattBuff[k++]; if (ton.eff > 0) { alastnfo[ii] = ton.eff; if (ton.effTyp == 8 || ton.effTyp == 21) alastvibnfo[ii] = ton.eff; // H/U } // in ST3, a lot of effects directly share the same memory! if (ton.eff == 0 && ton.effTyp != 7) // G { uint8_t efx = ton.effTyp; if (efx == 8 || efx == 21) // H/U ton.eff = alastvibnfo[ii]; else if ((efx >= 4 && efx <= 12) || (efx >= 17 && efx <= 19)) // D/E/F/I/J/K/L/Q/R/S ton.eff = alastnfo[ii]; /* If effect data is zero and effect type was the same as last one, clear out ** data if it's not J or S (those have no memory in the equivalent XM effects). ** Also goes for extra fine pitch slides and fine volume slides, ** since they get converted to other effects. */ if (efx == alastefx[ii] && ton.effTyp != 10 && ton.effTyp != 19) // J/S { uint8_t nfo = ton.eff; bool extraFinePitchSlides = (efx == 5 || efx == 6) && ((nfo & 0xF0) == 0xE0); bool fineVolSlides = (efx == 4 || efx == 11) && ((nfo > 0xF0) || (((nfo & 0xF) == 0xF) && ((nfo & 0xF0) > 0))); if (!extraFinePitchSlides && !fineVolSlides) ton.eff = 0; } } if (ton.effTyp > 0) alastefx[ii] = ton.effTyp; switch (ton.effTyp) { case 1: // A { ton.effTyp = 0xF; if (ton.eff == 0 || ton.eff > 0x1F) { ton.effTyp = 0; ton.eff = 0; } } break; case 2: ton.effTyp = 0xB; break; // B case 3: ton.effTyp = 0xD; break; // C case 4: // D { if (ton.eff > 0xF0) // fine slide up { ton.effTyp = 0xE; ton.eff = 0xB0 | (ton.eff & 0xF); } else if ((ton.eff & 0x0F) == 0x0F && (ton.eff & 0xF0) > 0) // fine slide down { ton.effTyp = 0xE; ton.eff = 0xA0 | (ton.eff >> 4); } else { ton.effTyp = 0xA; if (ton.eff & 0x0F) // on D/K, last nybble has first priority in ST3 ton.eff &= 0x0F; } } break; case 5: // E case 6: // F { if ((ton.eff & 0xF0) >= 0xE0) { // convert to fine slide if ((ton.eff & 0xF0) == 0xE0) tmp = 0x21; else tmp = 0xE; ton.eff &= 0x0F; if (ton.effTyp == 0x05) ton.eff |= 0x20; else ton.eff |= 0x10; ton.effTyp = (uint8_t)tmp; if (ton.effTyp == 0x21 && ton.eff == 0) { ton.effTyp = 0; } } else { // convert to normal 1xx/2xx slide ton.effTyp = 7 - ton.effTyp; } } break; case 7: // G { ton.effTyp = 0x03; // fix illegal slides (to new instruments) if (ton.instr != 0 && ton.instr != s3mLastGInstr[ii]) ton.instr = s3mLastGInstr[ii]; } break; case 11: // K { if (ton.eff > 0xF0) // fine slide up { ton.effTyp = 0xE; ton.eff = 0xB0 | (ton.eff & 0xF); // if volume column is unoccupied, set to vibrato if (ton.vol == 0) ton.vol = 0xB0; } else if ((ton.eff & 0x0F) == 0x0F && (ton.eff & 0xF0) > 0) // fine slide down { ton.effTyp = 0xE; ton.eff = 0xA0 | (ton.eff >> 4); // if volume column is unoccupied, set to vibrato if (ton.vol == 0) ton.vol = 0xB0; } else { ton.effTyp = 0x6; if (ton.eff & 0x0F) // on D/K, last nybble has first priority in ST3 ton.eff &= 0x0F; } } break; case 8: ton.effTyp = 0x04; break; // H case 9: ton.effTyp = 0x1D; break; // I case 10: ton.effTyp = 0x00; break; // J case 12: ton.effTyp = 0x05; break; // L case 15: ton.effTyp = 0x09; break; // O case 17: ton.effTyp = 0x1B; break; // Q case 18: ton.effTyp = 0x07; break; // R case 19: // S { ton.effTyp = 0xE; tmp = ton.eff >> 4; ton.eff &= 0x0F; if (tmp == 0x1) ton.eff |= 0x30; else if (tmp == 0x2) ton.eff |= 0x50; else if (tmp == 0x3) ton.eff |= 0x40; else if (tmp == 0x4) ton.eff |= 0x70; // ignore S8x becuase it's not compatible with FT2 panning else if (tmp == 0xB) ton.eff |= 0x60; else if (tmp == 0xC) // Note Cut { ton.eff |= 0xC0; if (ton.eff == 0xC0) { // EC0 does nothing in ST3 but cuts voice in FT2, remove effect ton.effTyp = 0; ton.eff = 0; } } else if (tmp == 0xD) // Note Delay { ton.eff |= 0xD0; if (ton.ton == 0 || ton.ton == 97) { // EDx without a note does nothing in ST3 but retrigs in FT2, remove effect ton.effTyp = 0; ton.eff = 0; } else if (ton.eff == 0xD0) { // ED0 prevents note/smp/vol from updating in ST3, remove everything ton.ton = 0; ton.instr = 0; ton.vol = 0; ton.effTyp = 0; ton.eff = 0; } } else if (tmp == 0xE) ton.eff |= 0xE0; else if (tmp == 0xF) ton.eff |= 0xF0; else { ton.effTyp = 0; ton.eff = 0; } } break; case 20: // T { ton.effTyp = 0x0F; if (ton.eff < 0x21) // Txx with a value lower than 33 (0x21) does nothing in ST3, remove effect { ton.effTyp = 0; ton.eff = 0; } } break; case 22: // V { ton.effTyp = 0x10; if (ton.eff > 0x40) { // Vxx > 0x40 does nothing in ST3 ton.effTyp = 0; ton.eff = 0; } } break; default: { ton.effTyp = 0; ton.eff = 0; } break; } } if (ton.instr != 0 && ton.effTyp != 0x3) s3mLastGInstr[ii] = ton.instr; if (ton.effTyp > 35) { ton.effTyp = 0; ton.eff = 0; } pattTmp[i][(kk * MAX_VOICES) + ii] = ton; } } if (tmpPatternEmpty((uint16_t)i)) { if (pattTmp[i] != NULL) { free(pattTmp[i]); pattTmp[i] = NULL; } } } } // *** SAMPLES *** bool adlibInsWarn = false; memcpy(ptnOfs, ha, 512); for (i = 0; i < ai; i++) { fseek(f, ptnOfs[i] << 4, SEEK_SET); if (fread(&h_S3MInstr, 1, sizeof (h_S3MInstr), f) != sizeof (h_S3MInstr)) { showMsg(0, "System message", "Not enough memory!"); goto s3mLoadError; } // trim off spaces at end of name for (j = 21; j >= 0; j--) { if (h_S3MInstr.name[j] == ' ' || h_S3MInstr.name[j] == 0x1A) h_S3MInstr.name[j] = '\0'; else break; } memcpy(songTmp.instrName[1+i], h_S3MInstr.name, 22); songTmp.instrName[1+i][22] = '\0'; if (h_S3MInstr.typ == 2) { adlibInsWarn = true; } else if (h_S3MInstr.typ == 1) { if ((h_S3MInstr.flags & (255-1-2-4)) != 0 || h_S3MInstr.pack != 0) { showMsg(0, "System message", "Error loading .s3m: Incompatible module!"); goto s3mLoadError; } else if (h_S3MInstr.memSeg > 0 && h_S3MInstr.len > 0) { if (!allocateTmpInstr((int16_t)(1 + i))) { showMsg(0, "System message", "Not enough memory!"); goto s3mLoadError; } setNoEnvelope(instrTmp[1 + i]); s = &instrTmp[1+i]->samp[0]; len = h_S3MInstr.len; bool hasLoop = h_S3MInstr.flags & 1; bool stereoSample = (h_S3MInstr.flags >> 1) & 1; bool is16Bit = (h_S3MInstr.flags >> 2) & 1; if (is16Bit) // 16-bit len <<= 1; if (stereoSample) // stereo len <<= 1; tmpSmp = (int8_t *)malloc(len + LOOP_FIX_LEN); if (tmpSmp == NULL) { showMsg(0, "System message", "Not enough memory!"); goto s3mLoadError; } int8_t *newPtr = tmpSmp + SMP_DAT_OFFSET; memcpy(s->name, h_S3MInstr.name, 21); if (h_S3MInstr.c2Spd > 65535) // ST3 (and OpenMPT) does this h_S3MInstr.c2Spd = 65535; tuneSample(s, h_S3MInstr.c2Spd); s->len = h_S3MInstr.len; s->vol = h_S3MInstr.vol; s->repS = h_S3MInstr.repS; s->repL = h_S3MInstr.repE - h_S3MInstr.repS; // non-FT2: fixes "miracle man.s3m" if ((h_S3MInstr.memSeg<<4)+s->len > (int32_t)dataLength) s->len = dataLength - (h_S3MInstr.memSeg << 4); if (s->repL <= 2 || s->repS+s->repL > s->len) { s->repS = 0; s->repL = 0; hasLoop = false; } if (s->repL == 0) hasLoop = false; s->typ = hasLoop + (is16Bit << 4); if (s->vol > 64) s->vol = 64; s->pan = 128; fseek(f, h_S3MInstr.memSeg << 4, SEEK_SET); // non-FT2: fixes "miracle man.s3m" if ((h_S3MInstr.memSeg<<4)+len > (int32_t)dataLength) len = dataLength - (h_S3MInstr.memSeg << 4); if (ver == 1) { fseek(f, len, SEEK_CUR); // sample not supported } else { if (fread(newPtr, len, 1, f) != 1) { free(tmpSmp); showMsg(0, "System message", "General I/O error during loading! Is the file in use?"); goto s3mLoadError; } if (is16Bit) { conv16BitSample(newPtr, len, stereoSample); s->origPek = tmpSmp; s->pek = s->origPek + SMP_DAT_OFFSET; s->len <<= 1; s->repS <<= 1; s->repL <<= 1; } else { conv8BitSample(newPtr, len, stereoSample); s->origPek = tmpSmp; s->pek = s->origPek + SMP_DAT_OFFSET; } // if stereo sample: reduce memory footprint after sample was downmixed to mono if (stereoSample) { newPtr = (int8_t *)realloc(s->origPek, s->len + LOOP_FIX_LEN); if (newPtr != NULL) { s->origPek = newPtr; s->pek = s->origPek + SMP_DAT_OFFSET; } } fixSample(s); } } } } fclose(f); songTmp.antChn = countS3MChannels(ap); if (adlibInsWarn) showMsg(0, "System message", "Warning: The module contains unsupported AdLib instruments!"); if (!(config.dontShowAgainFlags & DONT_SHOW_S3M_LOAD_WARNING_FLAG)) showMsg(6, "System message", "Warning: S3M channel panning is ignored because it's not compatible with FT2."); moduleLoaded = true; return true; s3mLoadError: fclose(f); freeTmpModule(); moduleFailedToLoad = true; return false; } bool doLoadMusic(bool externalThreadFlag) { char tmpText[128]; int16_t k; uint16_t i; uint32_t filelength; songHeaderTyp h; FILE *f; int16_t (*showMsg)(int16_t, const char *, const char *); showMsg = externalThreadFlag ? okBoxThreadSafe : okBox; linearFreqTable = false; if (editor.tmpFilenameU == NULL) { showMsg(0, "System message", "Generic memory fault during loading!"); moduleFailedToLoad = true; return false; } f = UNICHAR_FOPEN(editor.tmpFilenameU, "rb"); if (f == NULL) { showMsg(0, "System message", "General I/O error during loading! Is the file in use? Does it exist?"); moduleFailedToLoad = true; return false; } fseek(f, 0, SEEK_END); filelength = ftell(f); rewind(f); // start loading if (fread(&h, 1, sizeof (h), f) != sizeof (h)) return loadMusicS3M(f, filelength, externalThreadFlag); // not a .xm file, try to load as .s3m if (memcmp(h.sig, "Extended Module: ", 17)) return loadMusicS3M(f, filelength, externalThreadFlag); // not a .xm file, try to load as .s3m loadedFormat = FORMAT_XM; if (h.ver < 0x0102 || h.ver > 0x0104) { fclose(f); const int32_t major = (h.ver >> 8) & 0x0F; const int32_t minor = h.ver & 0xFF; sprintf(tmpText, "Error loading XM: Unsupported file version (v%01X.%02X).", major, minor); showMsg(0, "System message", tmpText); moduleFailedToLoad = true; return false; } if (h.len > MAX_ORDERS) { showMsg(0, "System message", "Error loading XM: The song has more than 256 orders!"); goto xmLoadError; } if (h.antPtn > MAX_PATTERNS) { showMsg(0, "System message", "Error loading XM: The song has more than 256 patterns!"); goto xmLoadError; } if (h.antChn == 0) { showMsg(0, "System message", "Error loading XM: This file is corrupt."); goto xmLoadError; } fseek(f, 60 + h.headerSize, SEEK_SET); if (filelength != 336 && feof(f)) // 336 in length at this point = empty XM { showMsg(0, "System message", "Error loading XM: The module is empty!"); goto xmLoadError; } // trim off spaces at end of name for (k = 19; k >= 0; k--) { if (h.name[k] == ' ' || h.name[k] == 0x1A) h.name[k] = '\0'; else break; } memcpy(songTmp.name, h.name, 20); songTmp.name[20] = '\0'; songTmp.len = h.len; songTmp.repS = h.repS; songTmp.antChn = (uint8_t)h.antChn; songTmp.speed = h.defSpeed; songTmp.tempo = h.defTempo; songTmp.ver = h.ver; linearFreqTable = h.flags & 1; songTmp.speed = CLAMP(songTmp.speed, 1, 999); songTmp.tempo = CLAMP(songTmp.tempo, 1, 99); songTmp.initialTempo = songTmp.tempo; if (songTmp.globVol > 64) songTmp.globVol = 64; if (songTmp.len == 0) songTmp.len = 1; // songTmp.songTab is already empty else memcpy(songTmp.songTab, h.songTab, songTmp.len); // some strange XMs have the order list padded with 0xFF, remove them! for (int16_t j = 255; j >= 0; j--) { if (songTmp.songTab[j] != 0xFF) break; if (songTmp.len > j) songTmp.len = j; } // even though XM supports 256 orders, FT2 supports only 255... if (songTmp.len > 0xFF) songTmp.len = 0xFF; if (songTmp.ver < 0x0104) { // XM v1.02 and XM v1.03 for (i = 1; i <= h.antInstrs; i++) { if (!loadInstrHeader(f, i, externalThreadFlag)) goto xmLoadError; } if (!loadPatterns(f, h.antPtn, externalThreadFlag)) goto xmLoadError; for (i = 1; i <= h.antInstrs; i++) { if (!loadInstrSample(f, i, externalThreadFlag)) goto xmLoadError; } } else { // XM v1.04 (latest version) if (!loadPatterns(f, h.antPtn, externalThreadFlag)) goto xmLoadError; for (i = 1; i <= h.antInstrs; i++) { if (!loadInstrHeader(f, i, externalThreadFlag)) goto xmLoadError; if (!loadInstrSample(f, i, externalThreadFlag)) goto xmLoadError; } } fclose(f); /* We support loading XMs with up to 32 samples per instrument (ModPlug/OpenMPT), ** but only the first 16 will be loaded. Now make sure we set the number of samples ** back to max 16 in the headers before loading is done. */ bool instrHasMoreThan16Samples = false; for (i = 1; i <= MAX_INST; i++) { if (instrTmp[i] != NULL && instrTmp[i]->antSamp > MAX_SMP_PER_INST) { instrHasMoreThan16Samples = true; instrTmp[i]->antSamp = MAX_SMP_PER_INST; } } if (songTmp.antChn > MAX_VOICES) { songTmp.antChn = MAX_VOICES; showMsg(0, "System message", "Warning: This XM contains >32 channels. The extra channels will be discarded!"); } if (h.antInstrs > MAX_INST) showMsg(0, "System message", "Warning: This XM contains >128 instruments. The extra instruments will be discarded!"); if (instrHasMoreThan16Samples) showMsg(0, "System message", "Warning: This XM contains instrument(s) with >16 samples. The extra samples will be discarded!"); moduleLoaded = true; return true; xmLoadError: fclose(f); freeTmpModule(); moduleFailedToLoad = true; return false; } static int32_t SDLCALL loadMusicThread(void *ptr) { (void)ptr; return doLoadMusic(true); } void loadMusic(UNICHAR *filenameU) { if (musicIsLoading) return; mouseAnimOn(); musicIsLoading = true; moduleLoaded = false; moduleFailedToLoad = false; loadedFormat = FORMAT_NONE; UNICHAR_STRCPY(editor.tmpFilenameU, filenameU); // clear deprecated pointers from possible last loading session (super important) memset(pattTmp, 0, sizeof (pattTmp)); memset(instrTmp, 0, sizeof (instrTmp)); // prevent stuck instrument names from previous module memset(&songTmp, 0, sizeof (songTmp)); for (uint32_t i = 0; i < MAX_PATTERNS; i++) pattLensTmp[i] = 64; thread = SDL_CreateThread(loadMusicThread, NULL, NULL); if (thread == NULL) { editor.loadMusicEvent = EVENT_NONE; okBox(0, "System message", "Couldn't create thread!"); musicIsLoading = false; return; } SDL_DetachThread(thread); } bool loadMusicUnthreaded(UNICHAR *filenameU, bool autoPlay) { if (filenameU == NULL || editor.tmpFilenameU == NULL) return false; // clear deprecated pointers from possible last loading session (super important) memset(pattTmp, 0, sizeof (pattTmp)); memset(instrTmp, 0, sizeof (instrTmp)); // prevent stuck instrument names from previous module memset(&songTmp, 0, sizeof (songTmp)); for (uint32_t i = 0; i < MAX_PATTERNS; i++) pattLensTmp[i] = 64; UNICHAR_STRCPY(editor.tmpFilenameU, filenameU); editor.loadMusicEvent = EVENT_NONE; doLoadMusic(false); if (moduleLoaded) { setupLoadedModule(); if (autoPlay) startPlaying(PLAYMODE_SONG, 0); return true; } return false; } static void freeTmpModule(void) // called on module load error { int32_t i, j; // free all patterns for (i = 0; i < MAX_PATTERNS; i++) { if (pattTmp[i] != NULL) { free(pattTmp[i]); pattTmp[i] = NULL; } } // free all samples for (i = 1; i <= MAX_INST; i++) { if (instrTmp[i] != NULL) { for (j = 0; j < MAX_SMP_PER_INST; j++) { if (instrTmp[i]->samp[j].origPek != NULL) free(instrTmp[i]->samp[j].origPek); } free(instrTmp[i]); instrTmp[i] = NULL; } } } static bool loadInstrHeader(FILE *f, uint16_t i, bool externalThreadFlag) { int8_t k; uint8_t j; uint32_t readSize; instrHeaderTyp ih; instrTyp *ins; sampleHeaderTyp *src; sampleTyp *s; int16_t (*showMsg)(int16_t, const char *, const char *); showMsg = externalThreadFlag ? okBoxThreadSafe : okBox; memset(extraSampleLengths, 0, sizeof (extraSampleLengths)); memset(&ih, 0, sizeof (ih)); fread(&ih.instrSize, 4, 1, f); readSize = ih.instrSize; // yes, some XMs can have a header size of 0, and it usually means 263 bytes (INSTR_HEADER_SIZE) if (readSize == 0 || readSize > INSTR_HEADER_SIZE) readSize = INSTR_HEADER_SIZE; if (readSize < 4) { showMsg(0, "System message", "Error loading XM: This file is corrupt (or not supported)!"); return false; } // load instrument data into temp buffer fread(ih.name, readSize-4, 1, f); // -4 = skip ih.instrSize // FT2 bugfix: skip instrument header data if instrSize is above INSTR_HEADER_SIZE if (ih.instrSize > INSTR_HEADER_SIZE) fseek(f, ih.instrSize-INSTR_HEADER_SIZE, SEEK_CUR); if (ih.antSamp < 0 || ih.antSamp > 32) { showMsg(0, "System message", "Error loading XM: This file is corrupt (or not supported)!"); return false; } if (i <= MAX_INST) { // trim off spaces at end of name for (k = 21; k >= 0; k--) { if (ih.name[k] == ' ' || ih.name[k] == 0x1A) ih.name[k] = '\0'; else break; } memcpy(songTmp.instrName[i], ih.name, 22); songTmp.instrName[i][22] = '\0'; } if (ih.antSamp > 0) { if (i <= MAX_INST) { if (!allocateTmpInstr(i)) { showMsg(0, "System message", "Not enough memory!"); return false; } // copy instrument header elements to our instrument struct ins = instrTmp[i]; memcpy(ins->ta, ih.ta, 96); memcpy(ins->envVP, ih.envVP, 12*2*sizeof(int16_t)); memcpy(ins->envPP, ih.envPP, 12*2*sizeof(int16_t)); ins->envVPAnt = ih.envVPAnt; ins->envPPAnt = ih.envPPAnt; ins->envVSust = ih.envVSust; ins->envVRepS = ih.envVRepS; ins->envVRepE = ih.envVRepE; ins->envPSust = ih.envPSust; ins->envPRepS = ih.envPRepS; ins->envPRepE = ih.envPRepE; ins->envVTyp = ih.envVTyp; ins->envPTyp = ih.envPTyp; ins->vibTyp = ih.vibTyp; ins->vibSweep = ih.vibSweep; ins->vibDepth = ih.vibDepth; ins->vibRate = ih.vibRate; ins->fadeOut = ih.fadeOut; ins->midiOn = (ih.midiOn == 1) ? true : false; ins->midiChannel = ih.midiChannel; ins->midiProgram = ih.midiProgram; ins->midiBend = ih.midiBend; ins->mute = (ih.mute == 1) ? true : false; ins->antSamp = ih.antSamp; // used in loadInstrSample() // sanitize stuff for broken/unsupported instruments ins->midiProgram = CLAMP(ins->midiProgram, 0, 127); ins->midiBend = CLAMP(ins->midiBend, 0, 36); if (ins->midiChannel > 15) ins->midiChannel = 15; if (ins->vibDepth > 0x0F) ins->vibDepth = 0x0F; if (ins->vibRate > 0x3F) ins->vibRate = 0x3F; if (ins->vibTyp > 3) ins->vibTyp = 0; for (j = 0; j < 96; j++) { if (ins->ta[j] >= MAX_SMP_PER_INST) ins->ta[j] = MAX_SMP_PER_INST-1; } if (ins->envVPAnt > 12) ins->envVPAnt = 12; if (ins->envVRepS > 11) ins->envVRepS = 11; if (ins->envVRepE > 11) ins->envVRepE = 11; if (ins->envVSust > 11) ins->envVSust = 11; if (ins->envPPAnt > 12) ins->envPPAnt = 12; if (ins->envPRepS > 11) ins->envPRepS = 11; if (ins->envPRepE > 11) ins->envPRepE = 11; if (ins->envPSust > 11) ins->envPSust = 11; for (j = 0; j < 12; j++) { if ((uint16_t)ins->envVP[j][0] > 32767) ins->envVP[j][0] = 32767; if ((uint16_t)ins->envPP[j][0] > 32767) ins->envPP[j][0] = 32767; if ((uint16_t)ins->envVP[j][1] > 64) ins->envVP[j][1] = 64; if ((uint16_t)ins->envPP[j][1] > 63) ins->envPP[j][1] = 63; } } int32_t sampleHeadersToRead = ih.antSamp; if (sampleHeadersToRead > MAX_SMP_PER_INST) sampleHeadersToRead = MAX_SMP_PER_INST; if (fread(ih.samp, sampleHeadersToRead * sizeof (sampleHeaderTyp), 1, f) != 1) { showMsg(0, "System message", "General I/O error during loading!"); return false; } // if instrument contains more than 16 sample headers (unsupported), skip them if (ih.antSamp > MAX_SMP_PER_INST) // can only be 0..32 at this point { const int32_t samplesToSkip = ih.antSamp-MAX_SMP_PER_INST; for (j = 0; j < samplesToSkip; j++) { fread(&extraSampleLengths[j], 4, 1, f); // used for skipping data in loadInstrSample() fseek(f, sizeof (sampleHeaderTyp)-4, SEEK_CUR); } } if (i <= MAX_INST) { for (j = 0; j < sampleHeadersToRead; j++) { s = &instrTmp[i]->samp[j]; src = &ih.samp[j]; // copy sample header elements to our sample struct s->len = src->len; s->repS = src->repS; s->repL = src->repL; s->vol = src->vol; s->fine = src->fine; s->typ = src->typ; s->pan = src->pan; s->relTon = src->relTon; memcpy(s->name, src->name, 22); s->name[22] = '\0'; // dst->pek is set up later // trim off spaces at end of name for (k = 21; k >= 0; k--) { if (s->name[k] == ' ' || s->name[k] == 0x1A) s->name[k] = '\0'; else break; } // sanitize stuff broken/unsupported samples if (s->vol > 64) s->vol = 64; s->relTon = CLAMP(s->relTon, -48, 71); } } } return true; } void checkSampleRepeat(sampleTyp *s) { if (s->repS < 0) s->repS = 0; if (s->repL < 0) s->repL = 0; if (s->repS > s->len) s->repS = s->len; if (s->repS+s->repL > s->len) s->repL = s->len - s->repS; if (s->repL == 0) s->typ &= ~3; // non-FT2 fix: force loop off if looplen is 0 } static bool loadInstrSample(FILE *f, uint16_t i, bool externalThreadFlag) { int8_t *newPtr; uint16_t j, k; int32_t l, bytesToSkip; sampleTyp *s; int16_t (*showMsg)(int16_t, const char *, const char *); showMsg = externalThreadFlag ? okBoxThreadSafe : okBox; if (i > MAX_INST || instrTmp[i] == NULL) return true; // yes, let's just pretend they got loaded k = instrTmp[i]->antSamp; if (k > MAX_SMP_PER_INST) k = MAX_SMP_PER_INST; for (j = 0; j < k; j++) { s = &instrTmp[i]->samp[j]; // if a sample has both forward loop and pingpong loop set, make it pingpong loop only (FT2 mixer behavior) if ((s->typ & 3) == 3) s->typ &= 0xFE; l = s->len; if (l <= 0) { s->pek = NULL; s->len = 0; s->repL = 0; s->repS = 0; if (s->typ & 32) s->typ &= ~32; // remove stereo flag } else { bytesToSkip = 0; if (l > MAX_SAMPLE_LEN) { bytesToSkip = l - MAX_SAMPLE_LEN; l = MAX_SAMPLE_LEN; } s->pek = NULL; s->origPek = (int8_t *)malloc(l + LOOP_FIX_LEN); if (s->origPek == NULL) { showMsg(0, "System message", "Not enough memory!"); return false; } s->pek = s->origPek + SMP_DAT_OFFSET; const int32_t bytesRead = (int32_t)fread(s->pek, 1, l, f); if (bytesRead < l) { const int32_t bytesToClear = l - bytesRead; memset(&s->pek[bytesRead], 0, bytesToClear); } if (bytesToSkip > 0) fseek(f, bytesToSkip, SEEK_CUR); delta2Samp(s->pek, l, s->typ); if (s->typ & 32) // stereo sample - already downmixed to mono in delta2samp() { s->typ &= ~32; // remove stereo flag s->len >>= 1; s->repL >>= 1; s->repS >>= 1; newPtr = (int8_t *)realloc(s->origPek, s->len + LOOP_FIX_LEN); if (newPtr != NULL) { s->origPek = newPtr; s->pek = s->origPek + SMP_DAT_OFFSET; } } } // NON-FT2 FIX: Align to 2-byte if 16-bit sample if (s->typ & 16) { s->repL &= 0xFFFFFFFE; s->repS &= 0xFFFFFFFE; s->len &= 0xFFFFFFFE; } checkSampleRepeat(s); fixSample(s); } if (instrTmp[i]->antSamp > MAX_SMP_PER_INST) { const int32_t samplesToSkip = instrTmp[i]->antSamp-MAX_SMP_PER_INST; for (i = 0; i < samplesToSkip; i++) { if (extraSampleLengths[i] > 0) fseek(f, extraSampleLengths[i], SEEK_CUR); } } return true; } void unpackPatt(uint8_t *dst, uint8_t *src, uint16_t len, int32_t antChn) { uint8_t note, data; int32_t srcEnd, srcIdx, j; if (dst == NULL) return; srcEnd = len * (sizeof (tonTyp) * antChn); srcIdx = 0; int32_t numChannels = antChn; if (numChannels > MAX_VOICES) numChannels = MAX_VOICES; for (int32_t i = 0; i < len; i++) { for (j = 0; j < numChannels; j++) { if (srcIdx >= srcEnd) return; // error! note = *src++; if (note & 0x80) { data = 0; if (note & 0x01) data = *src++; *dst++ = data; data = 0; if (note & 0x02) data = *src++; *dst++ = data; data = 0; if (note & 0x04) data = *src++; *dst++ = data; data = 0; if (note & 0x08) data = *src++; *dst++ = data; data = 0; if (note & 0x10) data = *src++; *dst++ = data; } else { *dst++ = note; *dst++ = *src++; *dst++ = *src++; *dst++ = *src++; *dst++ = *src++; } // if note is overflowing (>97), remove it if (*(dst-5) > 97) *(dst-5) = 0; // non-FT2 security fix: if effect is above 35 (Z), clear effect and parameter if (*(dst-2) > 35) { *(dst-2) = 0; *(dst-1) = 0; } srcIdx += sizeof (tonTyp); } // if more than 32 channels, skip rest of the channels for this row for (; j < antChn; j++) { if (srcIdx >= srcEnd) return; // error! note = *src++; if (note & 0x80) { if (note & 0x01) src++; if (note & 0x02) src++; if (note & 0x04) src++; if (note & 0x08) src++; if (note & 0x10) src++; } else { src++; src++; src++; src++; } srcIdx += sizeof (tonTyp); } // if song has <32 channels, align pointer to next row (skip unused channels) if (antChn < MAX_VOICES) dst += sizeof (tonTyp) * (MAX_VOICES - antChn); } } static bool tmpPatternEmpty(uint16_t nr) { uint8_t *scanPtr; uint32_t scanLen; if (pattTmp[nr] == NULL) return true; scanPtr = (uint8_t *)pattTmp[nr]; scanLen = pattLensTmp[nr] * TRACK_WIDTH; for (uint32_t i = 0; i < scanLen; i++) { if (scanPtr[i] != 0) return false; } return true; } void clearUnusedChannels(tonTyp *p, int16_t pattLen, int32_t antChn) { if (p == NULL || antChn >= MAX_VOICES) return; for (int32_t i = 0; i < pattLen; i++) memset(&p[(i * MAX_VOICES) + antChn], 0, sizeof (tonTyp) * (MAX_VOICES - antChn)); } static bool loadPatterns(FILE *f, uint16_t antPtn, bool externalThreadFlag) { bool pattLenWarn; uint8_t tmpLen; uint16_t i; patternHeaderTyp ph; int16_t (*showMsg)(int16_t, const char *, const char *); showMsg = externalThreadFlag ? okBoxThreadSafe : okBox; pattLenWarn = false; for (i = 0; i < antPtn; i++) { if (fread(&ph.patternHeaderSize, 4, 1, f) != 1) goto pattCorrupt; if (fread(&ph.typ, 1, 1, f) != 1) goto pattCorrupt; ph.pattLen = 0; if (songTmp.ver == 0x0102) { if (fread(&tmpLen, 1, 1, f) != 1) goto pattCorrupt; if (fread(&ph.dataLen, 2, 1, f) != 1) goto pattCorrupt; ph.pattLen = tmpLen + 1; // +1 in v1.02 if (ph.patternHeaderSize > 8) fseek(f, ph.patternHeaderSize - 8, SEEK_CUR); } else { if (fread(&ph.pattLen, 2, 1, f) != 1) goto pattCorrupt; if (fread(&ph.dataLen, 2, 1, f) != 1) goto pattCorrupt; if (ph.patternHeaderSize > 9) fseek(f, ph.patternHeaderSize - 9, SEEK_CUR); } if (feof(f)) goto pattCorrupt; pattLensTmp[i] = ph.pattLen; if (pattLensTmp[i] > MAX_PATT_LEN) { pattLensTmp[i] = MAX_PATT_LEN; pattLenWarn = true; } if (ph.dataLen > 0) { pattTmp[i] = (tonTyp *)calloc((MAX_PATT_LEN * TRACK_WIDTH) + 16, 1); if (pattTmp[i] == NULL) { showMsg(0, "System message", "Not enough memory!"); return false; } if (fread(packedPattData, 1, ph.dataLen, f) != ph.dataLen) goto pattCorrupt; unpackPatt((uint8_t *)pattTmp[i], packedPattData, pattLensTmp[i], songTmp.antChn); clearUnusedChannels(pattTmp[i], pattLensTmp[i], songTmp.antChn); } if (tmpPatternEmpty(i)) { if (pattTmp[i] != NULL) { free(pattTmp[i]); pattTmp[i] = NULL; } pattLensTmp[i] = 64; } } if (pattLenWarn) showMsg(0, "System message", "This module contains pattern(s) with a length above 256! They will be truncated."); return true; pattCorrupt: showMsg(0, "System message", "Error loading XM: This file is corrupt!"); return false; } // called from input/video thread after the module was done loading static void setupLoadedModule(void) { int16_t i; lockMixerCallback(); freeAllInstr(); freeAllPatterns(); oldPlayMode = playMode; playMode = PLAYMODE_IDLE; songPlaying = false; #ifdef HAS_MIDI midi.currMIDIVibDepth = 0; midi.currMIDIPitch = 0; #endif memset(editor.keyOnTab, 0, sizeof (editor.keyOnTab)); // copy over new pattern pointers and lengths for (i = 0; i < MAX_PATTERNS; i++) { patt[i] = pattTmp[i]; pattLens[i] = pattLensTmp[i]; } // copy over new instruments (includes sample pointers) for (i = 1; i <= MAX_INST; i++) { instr[i] = instrTmp[i]; fixSampleName(i); } // copy over song struct memcpy(&song, &songTmp, sizeof (songTyp)); fixSongName(); // we are the owners of the allocated memory ptrs set by the loader thread now // support non-even channel numbers if (song.antChn & 1) { song.antChn++; if (song.antChn > MAX_VOICES) song.antChn = MAX_VOICES; } if (song.len == 0) song.len = 1; if (song.repS >= song.len) song.repS = 0; song.globVol = 64; setScrollBarEnd(SB_POS_ED, (song.len - 1) + 5); setScrollBarPos(SB_POS_ED, 0, false); resetChannels(); setPos(0, 0, true); P_SetSpeed(song.speed); editor.tmpPattern = editor.editPattern; // set kludge variable editor.speed = song.speed; editor.tempo = song.tempo; editor.timer = song.timer; editor.globalVol = song.globVol; if (loadedFormat == FORMAT_XM) setFrqTab(linearFreqTable); else setFrqTab(false); unlockMixerCallback(); editor.currVolEnvPoint = 0; editor.currPanEnvPoint = 0; refreshScopes(); exitTextEditing(); updateTextBoxPointers(); resetChannelOffset(); updateChanNums(); resetWavRenderer(); clearPattMark(); resetTrimSizes(); resetPlaybackTime(); diskOpSetFilename(DISKOP_ITEM_MODULE, editor.tmpFilenameU); // redraw top part of screen if (ui.extended) { togglePatternEditorExtended(); // exit togglePatternEditorExtended(); // re-enter (force redrawing) } else { // redraw top screen hideTopScreen(); showTopScreen(true); } updateSampleEditorSample(); showBottomScreen(); // redraw bottom screen (also redraws pattern editor) if (ui.instEditorShown) drawPiano(NULL); // redraw piano now (since if playing = wait for next tick update) removeSongModifiedFlag(); moduleFailedToLoad = false; moduleLoaded = false; editor.loadMusicEvent = EVENT_NONE; } bool handleModuleLoadFromArg(int argc, char **argv) { int32_t filesize; uint32_t filenameLen; UNICHAR *filenameU, tmpPathU[PATH_MAX+2]; // this is crude, we always expect only one parameter, and that it is the module. if (argc != 2 || argv[1] == NULL || argv[1][0] == '\0') return false; #ifdef __APPLE__ if (argc == 2 && !strncmp(argv[1], "-psn_", 5)) return false; // OS X < 10.9 passes a -psn_x_xxxxx parameter on double-click launch #endif filenameLen = (uint32_t)strlen(argv[1]); filenameU = (UNICHAR *)calloc(filenameLen+1, sizeof (UNICHAR)); if (filenameU == NULL) { okBox(0, "System message", "Not enough memory!"); return false; } #ifdef _WIN32 MultiByteToWideChar(CP_UTF8, 0, argv[1], -1, filenameU, filenameLen); #else strcpy(filenameU, argv[1]); #endif // store old path UNICHAR_GETCWD(tmpPathU, PATH_MAX); // set path to where the main executable is UNICHAR_CHDIR(editor.binaryPathU); filesize = getFileSize(filenameU); if (filesize == -1 || filesize >= 512L*1024*1024) // >=2GB or >=512MB { okBox(0, "System message", "Error: The module is too big to be loaded!"); /* This is not really true, but let's add this check to prevent accidentally ** passing really big files to the program. And how often do you really ** see a >=512MB .XM/.S3M module? */ free(filenameU); UNICHAR_CHDIR(tmpPathU); // set old path back return false; } bool result = loadMusicUnthreaded(filenameU, true); free(filenameU); UNICHAR_CHDIR(tmpPathU); // set old path back return result; } void loadDroppedFile(char *fullPathUTF8, bool songModifiedCheck) { int32_t fullPathLen, filesize; UNICHAR *fullPathU; if (ui.sysReqShown || fullPathUTF8 == NULL) return; fullPathLen = (int32_t)strlen(fullPathUTF8); if (fullPathLen == 0) return; fullPathU = (UNICHAR *)calloc(fullPathLen + 2, sizeof (UNICHAR)); if (fullPathU == NULL) { okBox(0, "System message", "Not enough memory!"); return; } #ifdef _WIN32 MultiByteToWideChar(CP_UTF8, 0, fullPathUTF8, -1, fullPathU, fullPathLen); #else strcpy(fullPathU, fullPathUTF8); #endif filesize = getFileSize(fullPathU); if (filesize == -1) // >2GB { okBox(0, "System message", "The file is too big and can't be loaded (over 2GB)."); free(fullPathU); return; } if (filesize >= 128L*1024*1024) // 128MB { if (okBox(2, "System request", "Are you sure you want to load such a big file?") != 1) { free(fullPathU); return; } } // pass UTF8 to these tests so that we can test file ending in ASCII/ANSI if (fileIsInstrument(fullPathUTF8)) { loadInstr(fullPathU); } else if (fileIsSample(fullPathUTF8)) { loadSample(fullPathU, editor.curSmp, false); } else { SDL_RestoreWindow(video.window); if (songModifiedCheck && song.isModified) { // de-minimize window and set focus so that the user sees the message box SDL_RestoreWindow(video.window); SDL_RaiseWindow(video.window); if (!askUnsavedChanges(ASK_TYPE_LOAD_SONG)) { free(fullPathU); return; } } editor.loadMusicEvent = EVENT_LOADMUSIC_DRAGNDROP; loadMusic(fullPathU); } free(fullPathU); } static void handleOldPlayMode(void) { playMode = oldPlayMode; if (oldPlayMode != PLAYMODE_IDLE && oldPlayMode != PLAYMODE_EDIT) startPlaying(oldPlayMode, 0); songPlaying = (playMode >= PLAYMODE_SONG); } // called from input/video thread after module load thread was finished void handleLoadMusicEvents(void) { if (!moduleLoaded && !moduleFailedToLoad) return; // no event to handle if (moduleFailedToLoad) { // module failed to load from loading thread musicIsLoading = false; moduleFailedToLoad = false; moduleLoaded = false; editor.loadMusicEvent = EVENT_NONE; setMouseBusy(false); return; } if (moduleLoaded) { // module was successfully loaded from loading thread switch (editor.loadMusicEvent) { // module dragged and dropped *OR* user double clicked a file associated with FT2 clone case EVENT_LOADMUSIC_DRAGNDROP: { setupLoadedModule(); if (editor.autoPlayOnDrop) startPlaying(PLAYMODE_SONG, 0); else handleOldPlayMode(); } break; // filename passed as an exe argument *OR* user double clicked a file associated with FT2 clone case EVENT_LOADMUSIC_ARGV: { setupLoadedModule(); startPlaying(PLAYMODE_SONG, 0); } break; // module filename pressed in Disk Op. case EVENT_LOADMUSIC_DISKOP: { setupLoadedModule(); handleOldPlayMode(); } break; default: break; } moduleLoaded = false; editor.loadMusicEvent = EVENT_NONE; musicIsLoading = false; mouseAnimOff(); } }