Fix some bitmaps being loaded directly, skipping alternative extension logic and causing crashes when extensions mismatch (followup to 022510c)

Add flag to not store in static map to ContentFile::GetAsBitmap
Changed ContentFile::LoadAndReleaseBitmap and ContentFile::LoadAndReleaseSample to access specifier to private

Author: MaximDude

Activities/MultiplayerServerLobby.cpp

@@ -342,7 +342,7 @@ namespace RTE {
 		m_pScenePreviewBitmap = create_bitmap_ex(8, Scene::PREVIEW_WIDTH, Scene::PREVIEW_HEIGHT);
 
 		ContentFile defaultPreview("Base.rte/GUIs/DefaultPreview.png");
-		m_pDefaultPreviewBitmap = defaultPreview.LoadAndReleaseBitmap();
+		m_pDefaultPreviewBitmap = defaultPreview.GetAsBitmap(COLORCONV_NONE, false);
 
 		clear_to_color(m_pScenePreviewBitmap, g_MaskColor);
 

Entities/Scene.cpp

@@ -1309,7 +1309,7 @@ int Scene::ReadProperty(std::string propName, Reader &reader)
     else if (propName == "PreviewBitmapFile")
 	{
         reader >> m_PreviewBitmapFile;
-		m_pPreviewBitmap = m_PreviewBitmapFile.LoadAndReleaseBitmap();
+		m_pPreviewBitmap = m_PreviewBitmapFile.GetAsBitmap(COLORCONV_NONE, false);
 	}
     else if (propName == "Terrain")
     {

Entities/SceneLayer.cpp

@@ -224,7 +224,7 @@ int SceneLayer::LoadData()
     blit(pCopyFrom, m_pMainBitmap, 0, 0, 0, 0, pCopyFrom->w, pCopyFrom->h);
 */
     // Re-load directly from disk each time; don't do any caching of these bitmaps
-    m_pMainBitmap = m_BitmapFile.LoadAndReleaseBitmap();
+    m_pMainBitmap = m_BitmapFile.GetAsBitmap(COLORCONV_NONE, false);
 
     m_MainBitmapOwned = true;
 

Main.cpp

@@ -339,21 +339,21 @@ bool PlayIntroTitle() {
     // Load the Intro slides
     BITMAP **apIntroSlides = new BITMAP *[SLIDECOUNT];
     ContentFile introSlideFile("Base.rte/GUIs/Title/Intro/IntroSlideA.png");
-    apIntroSlides[SLIDEPAST] = introSlideFile.LoadAndReleaseBitmap();
+    apIntroSlides[SLIDEPAST] = introSlideFile.GetAsBitmap(COLORCONV_NONE, false);
     introSlideFile.SetDataPath("Base.rte/GUIs/Title/Intro/IntroSlideB.png");
-    apIntroSlides[SLIDENOW] = introSlideFile.LoadAndReleaseBitmap();
+    apIntroSlides[SLIDENOW] = introSlideFile.GetAsBitmap(COLORCONV_NONE, false);
     introSlideFile.SetDataPath("Base.rte/GUIs/Title/Intro/IntroSlideC.png");
-    apIntroSlides[SLIDEVR] = introSlideFile.LoadAndReleaseBitmap();
+    apIntroSlides[SLIDEVR] = introSlideFile.GetAsBitmap(COLORCONV_NONE, false);
     introSlideFile.SetDataPath("Base.rte/GUIs/Title/Intro/IntroSlideD.png");
-    apIntroSlides[SLIDETRAVEL] = introSlideFile.LoadAndReleaseBitmap();
+    apIntroSlides[SLIDETRAVEL] = introSlideFile.GetAsBitmap(COLORCONV_NONE, false);
     introSlideFile.SetDataPath("Base.rte/GUIs/Title/Intro/IntroSlideE.png");
-    apIntroSlides[SLIDEALIENS] = introSlideFile.LoadAndReleaseBitmap();
+    apIntroSlides[SLIDEALIENS] = introSlideFile.GetAsBitmap(COLORCONV_NONE, false);
     introSlideFile.SetDataPath("Base.rte/GUIs/Title/Intro/IntroSlideF.png");
-    apIntroSlides[SLIDETRADE] = introSlideFile.LoadAndReleaseBitmap();
+    apIntroSlides[SLIDETRADE] = introSlideFile.GetAsBitmap(COLORCONV_NONE, false);
     introSlideFile.SetDataPath("Base.rte/GUIs/Title/Intro/IntroSlideG.png");
-    apIntroSlides[SLIDEPEACE] = introSlideFile.LoadAndReleaseBitmap();
+    apIntroSlides[SLIDEPEACE] = introSlideFile.GetAsBitmap(COLORCONV_NONE, false);
     introSlideFile.SetDataPath("Base.rte/GUIs/Title/Intro/IntroSlideH.png");
-    apIntroSlides[SLIDEFRONTIER] = introSlideFile.LoadAndReleaseBitmap();
+    apIntroSlides[SLIDEFRONTIER] = introSlideFile.GetAsBitmap(COLORCONV_NONE, false);
 
     ContentFile alphaFile;
     BITMAP *pAlpha = 0;

Managers/FrameMan.cpp

@@ -266,7 +266,7 @@ namespace RTE {
 		CreateBackBuffers();
 
 		ContentFile scenePreviewGradientFile("Base.rte/GUIs/PreviewSkyGradient.png");
-		m_ScenePreviewDumpGradient = scenePreviewGradientFile.LoadAndReleaseBitmap(COLORCONV_8_TO_32);
+		m_ScenePreviewDumpGradient = scenePreviewGradientFile.GetAsBitmap(COLORCONV_8_TO_32, false);
 
 		return 0;
 	}

Managers/SceneMan.cpp

@@ -1409,7 +1409,7 @@ bool SceneMan::LoadUnseenLayer(std::string bitmapPath, int team)
 {
     ContentFile bitmapFile(bitmapPath.c_str());
     SceneLayer *pUnseenLayer = new SceneLayer();
-    if (pUnseenLayer->Create(bitmapFile.LoadAndReleaseBitmap(), true, Vector(), m_pCurrentScene->WrapsX(), m_pCurrentScene->WrapsY(), Vector(1.0, 1.0)) < 0)
+    if (pUnseenLayer->Create(bitmapFile.GetAsBitmap(COLORCONV_NONE, false), true, Vector(), m_pCurrentScene->WrapsX(), m_pCurrentScene->WrapsY(), Vector(1.0, 1.0)) < 0)
     {
         g_ConsoleMan.PrintString("ERROR: Loading background layer " + pUnseenLayer->GetPresetName() + "\'s data failed!");
         return false;

Menus/ScenarioGUI.cpp

@@ -317,7 +317,7 @@ int ScenarioGUI::Create(Controller *pController)
 
 	// Load default preview bitmap
 	ContentFile defaultPreview("Base.rte/GUIs/DefaultPreview.png");
-	m_pDefaultPreviewBitmap = defaultPreview.LoadAndReleaseBitmap();
+	m_pDefaultPreviewBitmap = defaultPreview.GetAsBitmap(COLORCONV_NONE, false);
 
 	clear_to_color(m_pScenePreviewBitmap, g_MaskColor);
 

System/ContentFile.cpp

@@ -103,7 +103,7 @@ namespace RTE {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	BITMAP * ContentFile::GetAsBitmap(int conversionMode, const std::string &dataPathToSpecificFrame) {
+	BITMAP * ContentFile::GetAsBitmap(int conversionMode, bool storeBitmap, const std::string &dataPathToSpecificFrame) {
 		if (m_DataPath.empty()) {
 			return nullptr;
 		}
@@ -132,7 +132,7 @@ namespace RTE {
 			returnBitmap = LoadAndReleaseBitmap(conversionMode, dataPathToLoad); // NOTE: This takes ownership of the bitmap file
 
 			// Insert the bitmap into the map, PASSING OVER OWNERSHIP OF THE LOADED DATAFILE
-			s_LoadedBitmaps.at(bitDepth).insert(std::pair<std::string, BITMAP *>(dataPathToLoad, returnBitmap));
+			if (storeBitmap) { s_LoadedBitmaps.at(bitDepth).insert({ dataPathToLoad, returnBitmap }); }
 		}
 		return returnBitmap;
 	}
@@ -166,7 +166,7 @@ namespace RTE {
 		char framePath[1024];
 		for (int frameNum = 0; frameNum < frameCount; frameNum++) {
 			std::snprintf(framePath, sizeof(framePath), "%s%03i%s", m_DataPathWithoutExtension.c_str(), frameNum, m_DataPathExtension.c_str());
-			returnBitmaps[frameNum] = GetAsBitmap(conversionMode, framePath);
+			returnBitmaps[frameNum] = GetAsBitmap(conversionMode, true, framePath);
 		}
 		return returnBitmaps;
 	}
@@ -208,7 +208,7 @@ namespace RTE {
 			returnSample = LoadAndReleaseSample(abortGameForInvalidSound, asyncLoading); //NOTE: This takes ownership of the sample file
 
 			// Insert the Sound object into the map, PASSING OVER OWNERSHIP OF THE LOADED FILE
-			s_LoadedSamples.insert(std::pair<std::string, FMOD::Sound *>(m_DataPath, returnSample));
+			s_LoadedSamples.insert({ m_DataPath, returnSample });
 		}
 		return returnSample;
 	}

System/ContentFile.h

@@ -119,9 +119,10 @@ namespace RTE {
 		/// Gets the data represented by this ContentFile object as an Allegro BITMAP, loading it into the static maps if it's not already loaded. Note that ownership of the BITMAP is NOT transferred!
 		/// </summary>
 		/// <param name="conversionMode">The Allegro color conversion mode to use when loading this bitmap.</param>
+		/// <param name="storeBitmap">Whether to store the BITMAP in the relevant static map after loading it or not.</param>
 		/// <param name="dataPathToSpecificFrame">Path to a specific frame when loading an animation to avoid overwriting the original preset DataPath when loading each frame.</param>
 		/// <returns>Pointer to the BITMAP loaded from disk.</returns>
-		BITMAP * GetAsBitmap(int conversionMode = 0, const std::string &dataPathToSpecificFrame = "");
+		BITMAP * GetAsBitmap(int conversionMode = 0, bool storeBitmap = true, const std::string &dataPathToSpecificFrame = "");
 
 		/// <summary>
 		/// Gets the data represented by this ContentFile object as an array of Allegro BITMAPs, each representing a frame in the animation.
@@ -132,15 +133,6 @@ namespace RTE {
 		/// <returns>Pointer to the beginning of the array of BITMAP pointers loaded from the disk, the length of which is specified with the FrameCount argument.</returns>
 		BITMAP ** GetAsAnimation(int frameCount = 1, int conversionMode = 0);
 
-		/// <summary>
-		/// Loads and transfers the data represented by this ContentFile object as an Allegro BITMAP. Ownership of the BITMAP IS transferred!
-		/// Note that this is relatively slow since it reads the data from disk each time.
-		/// </summary>
-		/// <param name="conversionMode">The Allegro color conversion mode to use when loading this bitmap. Only applies the first time a bitmap is loaded from the disk.</param>
-		/// <param name="dataPathToSpecificFrame">Path to a specific frame when loading an animation to avoid overwriting the original preset DataPath when loading each frame.</param>
-		/// <returns>Pointer to the BITMAP loaded from disk.</returns>
-		BITMAP * LoadAndReleaseBitmap(int conversionMode = 0, const std::string &dataPathToSpecificFrame = "");
-
 		/// <summary>
 		/// Gets the data represented by this ContentFile object as an FMOD FSOUND_SAMPLE, loading it into the static maps if it's not already loaded. Ownership of the FSOUND_SAMPLE is NOT transferred!
 		/// </summary>
@@ -149,13 +141,6 @@ namespace RTE {
 		/// <returns>Pointer to the FSOUND_SAMPLE loaded from disk.</returns>
 		FMOD::Sound * GetAsSample(bool abortGameForInvalidSound = true, bool asyncLoading = true);
 
-		/// <summary>
-		/// Loads and transfers the data represented by this ContentFile object as an FMOD FSOUND_SAMPLE. Ownership of the FSOUND_SAMPLE is NOT transferred!
-		/// </summary>
-		/// <param name="abortGameForInvalidSound">Whether to abort the game if the sound couldn't be added, or just show a console error. Default true.</param>
-		/// <param name="asyncLoading">Whether to enable FMOD asynchronous loading or not. Should be disabled for loading audio files with Lua AddSound.
-		/// <returns>Pointer to the FSOUND_SAMPLE loaded from disk.</returns>
-		FMOD::Sound * LoadAndReleaseSample(bool abortGameForInvalidSound = true, bool asyncLoading = true);
 #pragma endregion
 
 #pragma region Class Info
@@ -190,6 +175,25 @@ namespace RTE {
 
 	private:
 
+#pragma region Data Handling
+		/// <summary>
+		/// Loads and transfers the data represented by this ContentFile object as an Allegro BITMAP. Ownership of the BITMAP IS transferred!
+		/// Note that this is relatively slow since it reads the data from disk each time.
+		/// </summary>
+		/// <param name="conversionMode">The Allegro color conversion mode to use when loading this bitmap. Only applies the first time a bitmap is loaded from the disk.</param>
+		/// <param name="dataPathToSpecificFrame">Path to a specific frame when loading an animation to avoid overwriting the original preset DataPath when loading each frame.</param>
+		/// <returns>Pointer to the BITMAP loaded from disk.</returns>
+		BITMAP * LoadAndReleaseBitmap(int conversionMode = 0, const std::string &dataPathToSpecificFrame = "");
+
+		/// <summary>
+		/// Loads and transfers the data represented by this ContentFile object as an FMOD FSOUND_SAMPLE. Ownership of the FSOUND_SAMPLE is NOT transferred!
+		/// </summary>
+		/// <param name="abortGameForInvalidSound">Whether to abort the game if the sound couldn't be added, or just show a console error. Default true.</param>
+		/// <param name="asyncLoading">Whether to enable FMOD asynchronous loading or not. Should be disabled for loading audio files with Lua AddSound.
+		/// <returns>Pointer to the FSOUND_SAMPLE loaded from disk.</returns>
+		FMOD::Sound * LoadAndReleaseSample(bool abortGameForInvalidSound = true, bool asyncLoading = true);
+#pragma endregion
+
 		/// <summary>
 		/// Clears all the member variables of this ContentFile, effectively resetting the members of this abstraction level only.
 		/// </summary>