Fixed TR1 level loading (sound samples and colors)

ChangeLog.md

@@ -2,6 +2,12 @@
 
 ## OpenRaider (0.1.3) xythobuz <xythobuz@xythobuz.de>
 
+    [ 20140305 ]
+    * SoundAL now has more useful error message output.
+    * Fixed TR1 color map parsing, now textures have the proper color values.
+    * Fixed TR1 sound sample parsing. Can now load all TR1 levels without crashing.
+    * Improved parsing and summaries in binspector level reading script.
+
     [ 20140304 ]
     * Added (more or less working) support for loading TR1 levels
     * Updated imgui

include/loader/LoaderTR2.h

@@ -45,7 +45,7 @@ class LoaderTR2 : public Loader {
     virtual void loadSampleIndices();
 
     virtual void loadExternalSoundFile(std::string f);
-    virtual void loadSoundFiles(BinaryReader& sfx);
+    virtual int loadSoundFiles(BinaryReader& sfx, unsigned int count = 0);
 
     virtual int getPaletteIndex(uint16_t index);
 };

src/loader/LoaderTR1.cpp

@@ -47,7 +47,6 @@ int LoaderTR1::load(std::string f) {
     loadSoundMap();
     loadSoundDetails();
     loadSoundSamples();
-    loadSampleIndices();
 
     return 0;
 }
@@ -59,17 +58,11 @@ void LoaderTR1::loadPalette() {
         uint8_t g = file.readU8();
         uint8_t b = file.readU8();
 
-        //! \fixme Hack to make everything brighter
-        static const uint8_t lightHackFactor = 3;
-        r *= lightHackFactor;
-        if (r > 255)
-            r = 255;
-        g *= lightHackFactor;
-        if (g > 255)
-            g = 255;
-        b *= lightHackFactor;
-        if (b > 255)
-            b = 255;
+        // Color values range from 0 to 63, so multiply by 4
+        static const uint8_t lightFactor = 4;
+        r *= lightFactor;
+        g *= lightFactor;
+        b *= lightFactor;
 
         glm::vec4 c(r / 255.0f, g / 255.0f, b / 255.0f, 1.0f);
         TextureManager::setPalette(i, c);
@@ -253,18 +246,26 @@ void LoaderTR1::loadSoundMap() {
 
 void LoaderTR1::loadSoundSamples() {
     uint32_t soundSampleSize = file.readU32();
-    if (soundSampleSize <= 0) {
-        return;
-    }
-
     std::vector<uint8_t> buffer;
     for (int i = 0; i < soundSampleSize; i++) {
         buffer.push_back(file.readU8());
     }
 
-    char* tmpPtr = reinterpret_cast<char*>(&buffer[0]);
-    BinaryMemory sfx(tmpPtr, soundSampleSize);
-    loadSoundFiles(sfx);
+    uint32_t numSampleIndices = file.readU32();
+    for (unsigned int i = 0; i < numSampleIndices; i++) {
+        SoundManager::addSampleIndex(i);
+        uint32_t sampleOffset = file.readU32();
+        assertLessThan(sampleOffset, soundSampleSize);
+        char* tmpPtr = reinterpret_cast<char*>(&buffer[sampleOffset]);
+        BinaryMemory sample(tmpPtr, soundSampleSize - sampleOffset);
+        int ret = loadSoundFiles(sample, 1);
+        assertEqual(ret, 1);
+    }
+
+    if (numSampleIndices > 0)
+        Log::get(LOG_INFO) << "LoaderTR1: Found " << numSampleIndices << " SoundSamples" << Log::endl;
+    else
+        Log::get(LOG_INFO) << "LoaderTR1: No SoundSamples in this level?!" << Log::endl;
 }
 
 int LoaderTR1::getPaletteIndex(uint16_t index) {

src/loader/LoaderTR2.cpp

@@ -1113,21 +1113,30 @@ void LoaderTR2::loadExternalSoundFile(std::string f) {
         return;
     }
 
-    loadSoundFiles(sfx);
+    int riffCount = loadSoundFiles(sfx);
+    if (riffCount > 0)
+        Log::get(LOG_INFO) << "LoaderTR2: Loaded " << riffCount << " SoundSamples" << Log::endl;
+    else if (riffCount == 0)
+        Log::get(LOG_INFO) << "LoaderTR2: No SoundSamples found!" << Log::endl;
+    else
+        Log::get(LOG_ERROR) << "LoaderTR2: Error loading SoundSamples!" << Log::endl;
 }
 
-void LoaderTR2::loadSoundFiles(BinaryReader& sfx) {
+int LoaderTR2::loadSoundFiles(BinaryReader& sfx, unsigned int count) {
     int riffCount = 0;
     while (!sfx.eof()) {
+        if ((count > 0) && (riffCount >= count))
+            break;
+
         char test[5];
         test[4] = '\0';
         for (int i = 0; i < 4; i++)
             test[i] = sfx.read8();
 
         if (std::string("RIFF") != std::string(test)) {
-            Log::get(LOG_DEBUG) << "LoaderTR2: External SFX invalid! (" << riffCount
+            Log::get(LOG_DEBUG) << "LoaderTR2: SoundSamples invalid! (" << riffCount
                                 << ", \"" << test << "\" != \"RIFF\")" << Log::endl;
-            return;
+            return -1;
         }
 
         // riffSize is (fileLength - 8)
@@ -1144,11 +1153,7 @@ void LoaderTR2::loadSoundFiles(BinaryReader& sfx) {
 
         riffCount++;
     }
-
-    if (riffCount > 0)
-        Log::get(LOG_INFO) << "LoaderTR2: Loaded " << riffCount << " SoundSamples" << Log::endl;
-    else
-        Log::get(LOG_INFO) << "LoaderTR2: No SoundSamples found!" << Log::endl;
+    return riffCount;
 }
 
 // ---- Stuff ----

src/system/SoundAL.cpp

@@ -27,8 +27,10 @@ std::vector<unsigned int> SoundAL::listenerSources;
 glm::vec3 SoundAL::lastPosition(0.0f, 0.0f, 0.0f);
 
 int SoundAL::initialize() {
-    if (init)
+    if (init) {
+        Log::get(LOG_WARNING) << "SoundAL Warning: Already initialized..." << Log::endl;
         return 0;
+    }
 
     ALCdevice* device = alcOpenDevice(nullptr);
     ALCcontext* context = alcCreateContext(device, nullptr);
@@ -51,18 +53,23 @@ int SoundAL::initialize() {
 }
 
 void SoundAL::shutdown() {
-    if (!init)
+    if (!init) {
+        Log::get(LOG_ERROR) << "SoundAL Error: Shutdown but not initialized!" << Log::endl;
         return;
+    }
 
     clear();
+    init = false;
+
     if (alutExit() == AL_FALSE)
         Log::get(LOG_ERROR) << "SoundAL Error: " << alutGetErrorString(alutGetError()) << Log::endl;
-    init = false;
 }
 
 void SoundAL::clear() {
-    if (!init)
+    if (!init) {
+        Log::get(LOG_ERROR) << "SoundAL Error: Clear but not initialized!" << Log::endl;
         return;
+    }
 
     stopAll();
 
@@ -98,8 +105,10 @@ int SoundAL::numBuffers() {
 }
 
 int SoundAL::loadBuffer(unsigned char* buffer, unsigned int length) {
-    if (!init)
+    if (!init) {
+        Log::get(LOG_ERROR) << "SoundAL Error: Buffer load, but not initialized!" << Log::endl;
         return -1;
+    }
 
     alGetError();
     unsigned int r = alutCreateBufferFromFileImage(buffer, length);
@@ -119,8 +128,16 @@ int SoundAL::numSources(bool atListener) {
 }
 
 int SoundAL::addSource(int buffer, float volume, bool atListener, bool loop) {
-    if ((!init) || (buffer < 0) || (buffer >= buffers.size()))
+    if (!init) {
+        Log::get(LOG_ERROR) << "SoundAL Error: Adding source, but not initialized!" << Log::endl;
         return -1;
+    }
+
+    if ((buffer < 0) || (buffer >= buffers.size())) {
+        Log::get(LOG_ERROR) << "SoundAL Error: Adding source, but '" << buffer
+                            << "' invalid (max '" << buffers.size() << "')!" << Log::endl;
+        return -2;
+    }
 
     unsigned int id;
 
@@ -128,7 +145,7 @@ int SoundAL::addSource(int buffer, float volume, bool atListener, bool loop) {
     alGenSources(1, &id);
     if (alGetError() != AL_NO_ERROR) {
         Log::get(LOG_ERROR) << "SoundAL Error: Could not create source!" << Log::endl;
-        return -2;
+        return -3;
     }
 
     alSourcei(id, AL_BUFFER, buffers.at(buffer));
@@ -148,8 +165,10 @@ int SoundAL::addSource(int buffer, float volume, bool atListener, bool loop) {
 }
 
 int SoundAL::sourceAt(int source, glm::vec3 pos) {
-    if (!init)
+    if (!init) {
+        Log::get(LOG_ERROR) << "SoundAL Error: Positioning source, but not initialized!" << Log::endl;
         return -1;
+    }
 
     if ((source < 0) || (source >= sources.size())) {
         Log::get(LOG_ERROR) << "SoundAL: Can't position non-existing source!" << Log::endl;
@@ -162,8 +181,10 @@ int SoundAL::sourceAt(int source, glm::vec3 pos) {
 }
 
 void SoundAL::listenAt(glm::vec3 pos, glm::vec3 at, glm::vec3 up) {
-    if (!init)
+    if (!init) {
+        Log::get(LOG_ERROR) << "SoundAL Error: Positioning listener, but not initialized!" << Log::endl;
         return;
+    }
 
     float orientation[6] = { at.x, at.y, at.z, up.x, up.y, up.z };
     alListenerfv(AL_POSITION, &pos[0]);

utils/tombraider.bfft

@@ -380,7 +380,7 @@ struct sound_details_t {
     signed 16 little unknown1;
     signed 16 little unknown2;
 
-    summary sample, " - ", volume;
+    summary "Sample: ", sample, ", Vol: ", volume * 100 / 32767, "%";
 }
 
 // ########## Main file layout ##########
@@ -508,20 +508,20 @@ struct main {
 
     // TR1s sound map has 256 entries, TR2 & TR3 have 370
     if (TRversion > 1)
-        skip soundMap[370 * 2];
+        signed 16 little soundMap[370];
     else
-        skip soundMap[256 * 2];
+        signed 16 little soundMap[256];
 
     unsigned 32 little numSoundDetails;
     sound_details_t soundDetails[numSoundDetails];
 
     // TR1 has the sample data embedded here (WAV files)
     if (TRversion == 1) {
-        unsigned 32 little numSamples;
-        skip samples[numSamples];
+        unsigned 32 little numWAVSamples;
+        skip wavSamples[numWAVSamples];
     }
 
     unsigned 32 little numSampleIndices;
-    skip sampleIndices[numSampleIndices * 4];
+    unsigned 32 little sampleIndices[numSampleIndices];
 }