Replace confusing PNG with MIP (Model-in-Picture) in Thumbnail_cImportExport

Author: 0KepOnline

Spore ModAPI/SourceCode/App/App.cpp

@@ -25,27 +25,27 @@ namespace App
 	auto_METHOD(Thumbnail_cImportExport, bool, FolderPathFromLocale,
 		Args(uint32_t instanceID, eastl::string16& dst, uint32_t tableID), Args(instanceID, dst, tableID));
 
-	auto_METHOD(Thumbnail_cImportExport, bool, SavePNG,
+	auto_METHOD(Thumbnail_cImportExport, bool, SaveMIP,
 		Args(Resource::ResourceObject* pResource, RenderWare::Raster* pImage, Resource::Database* pDBPF,
 			bool forceReplace, bool disableSteganography),
 		Args(pResource, pImage, pDBPF, forceReplace, disableSteganography));
 
-	auto_METHOD(Thumbnail_cImportExport, bool, ImportPNG,
+	auto_METHOD(Thumbnail_cImportExport, bool, ImportMIP,
 		Args(const char16_t* path, ResourceKey& key), Args(path, key));
 
-	auto_METHOD(Thumbnail_cImportExport, bool, DecodePNG,
+	auto_METHOD(Thumbnail_cImportExport, bool, DecodeMIP,
 		Args(IO::IStream* stream, ThumbnailDecodedMetadata& dstMetadata, IStreamPtr& dstDataStream),
 		Args(stream, dstMetadata, dstDataStream));
 
 	auto_METHOD_(Thumbnail_cImportExport, bool, SaveFilePaths);
 
-	auto_METHOD(Thumbnail_cImportExport, bool, ImportDirectoryPNGs,
+	auto_METHOD(Thumbnail_cImportExport, bool, ImportDirectoryMIPs,
 		Args(const eastl::string16& path, eastl::hash_set<eastl::string16>& dstSkippedPaths, int& dstCount),
 		Args(path, dstSkippedPaths, dstCount));
 
-	auto_METHOD(PngEncoder, bool, EncodePNG,
-		Args(IO::IStream* stream, int mode),
-		Args(stream, mode));
+	auto_METHOD(MIPEncoder, bool, WriteImageToStream,
+		Args(IO::IStream* stream, App::MIPEncoder::Format format),
+		Args(stream, format));
 
 
 	auto_STATIC_METHOD_(cIDGenerator, cIDGenerator*, Get);

Spore ModAPI/SourceCode/DLL/AddressesApp.cpp

@@ -407,16 +407,16 @@ namespace App
 		DefineAddress(Get, SelectAddress(0x5F7750, 0x5F79C0));
 		DefineAddress(GetFolderPath, SelectAddress(0x5F9140, 0x5F92C0));
 		DefineAddress(FolderPathFromLocale, SelectAddress(0x5F9220, 0x5F93A0));
-		DefineAddress(SavePNG, SelectAddress(0x5FA7E0, 0x5FA960));
-		DefineAddress(ImportPNG, SelectAddress(0x5FC240, 0x5FC3C0));
-		DefineAddress(DecodePNG, SelectAddress(0x5FBA10, 0x5FBB90));
+		DefineAddress(SaveMIP, SelectAddress(0x5FA7E0, 0x5FA960));
+		DefineAddress(ImportMIP, SelectAddress(0x5FC240, 0x5FC3C0));
+		DefineAddress(DecodeMIP, SelectAddress(0x5FBA10, 0x5FBB90));
 		DefineAddress(SaveFilePaths, SelectAddress(0x5F89C0, 0x5F8B60));
-		DefineAddress(ImportDirectoryPNGs, SelectAddress(0x5FC900, 0x5FCA80));
+		DefineAddress(ImportDirectoryMIPs, SelectAddress(0x5FC900, 0x5FCA80));
 	}
 
-	namespace Addresses(PngEncoder)
+	namespace Addresses(MIPEncoder)
 	{
-		DefineAddress(EncodePNG, SelectAddress(0x68E660, 0x68e190));
+		DefineAddress(WriteImageToStream, SelectAddress(0x68E660, 0x68e190));
 	}
 
 	namespace Addresses(cLocaleManager)

Spore ModAPI/Spore/App/Thumbnail_cImportExport.h

@@ -13,9 +13,17 @@
 
 namespace App
 {
-	struct PngEncoder {
+	struct MIPEncoder {
+
+		enum Format {
+			kImageFormatPNG,
+			kImageFormatTGA,
+			kImageFormatBMP
+		};
+
+		bool WriteImageToStream(IO::IStream* outputStream, Format format);
+
 
-		bool EncodePNG(IO::IStream* outputStream, int mode);
 
 		/* 00h */	eastl::vector<int> mPixelBuf;
 		/* 14h */	uint32_t mnImageWidth;
@@ -39,7 +47,7 @@ namespace App
 		/* 58h */	eastl::vector<int8_t> mData;
 		/* 6Ch */	int field_6C;
 	};
-	ASSERT_SIZE(PngEncoder, 0x70);
+	ASSERT_SIZE(MIPEncoder, 0x70);
 
 	struct ThumbnailDecodedMetadata
 	{
@@ -83,11 +91,11 @@ namespace App
 		/// @param[out] dst The eastl::string where the path will be written.
 		bool GetFolderPath(uint32_t creationType, eastl::string16& dst);
 
-		/// Used to obtain a path from a locale file, by default `0x19F76D11.locale`, similar to the one that would
+		/// Used to obtain a path from a locale file, by default `SaveDataFolders.locale`, similar to the one that would
 		/// return GetFolderPath()
 		bool FolderPathFromLocale(uint32_t instanceID, eastl::string16& dst, uint32_t tableID = 0xFFFFFFFF);
 
-		/// Encodes the given resource into a `.png` image and saves it, both in the given package and in the
+		/// Encodes the given resource into a `.png` Model-in-Picture and saves it, both in the given package and in the
 		/// "My Spore Creations" in the user Documents folder. 
 		/// 
 		/// In the package, the image will be saved using the same ResourceKey as the resource, but with a TypeIDs::png type.
@@ -100,21 +108,21 @@ namespace App
 		/// @param forceReplace [Optional] If false (by default), if the `.png` already exists in the folder, it will try writing variants like `(1)`, `(2)`,...
 		/// @param disableSteganography [Optional] If false (by default), the data in the `.png` will be stored in a special way meant to save space.
 		/// @returns `true` on success, `false` if something failed.
-		bool SavePNG(Resource::ResourceObject* pResource, RenderWare::Raster* pImage, Resource::Database* database, 
+		bool SaveMIP(Resource::ResourceObject* pResource, RenderWare::Raster* pImage, Resource::Database* database, 
 			bool forceReplace = false, bool disableSteganography = false);
 
 		/// Reads the PNG file from the given file path, and adds the creation found within to the Sporepedia if it hasn't been added yet. 
 		/// 
 		/// @param path The full path to the file being read.
 		/// @param key Resource key to the creation being read.
 		/// @returns 'true' on success, 'false' if something failed.
-		bool ImportPNG(const char16_t* path, ResourceKey& key);
+		bool ImportMIP(const char16_t* path, ResourceKey& key);
 
-		/// Extracts information from a PNG file. It extracts both the metadata, and the data encoded within the image.
+		/// Extracts information from a Model-in-Picture PNG file. It extracts both the metadata, and the data encoded within the image.
 		/// @param[out] dstMetadata 
 		/// @param[out] dstDataStream
 		/// @returns true on success, false if something failed
-		bool DecodePNG(IO::IStream* stream, ThumbnailDecodedMetadata& dstMetadata, IStreamPtr& dstDataStream);
+		bool DecodeMIP(IO::IStream* stream, ThumbnailDecodedMetadata& dstMetadata, IStreamPtr& dstDataStream);
 
 		/// Saves the file paths information that keeps track of which PNGs have been loaded.
 		/// It saves it in file `0x473C3E6!0x473C3E6.0x473C3E6` of Resource::SaveAreaID::Server (`Pollination.package`)
@@ -129,7 +137,7 @@ namespace App
 		/// @param[out] dstSkippedPaths A list of paths that were skipped because they were already in mPngPathToKey or too many files were loaded
 		/// @param[out] dstCount The number of PNGs that were imported is added to this value
 		/// @returns True if some PNG was loaded, false otherwise
-		bool ImportDirectoryPNGs(const eastl::string16& directoryPath, eastl::hash_set<eastl::string16>& dstSkippedPaths, int& dstCount);
+		bool ImportDirectoryMIPs(const eastl::string16& directoryPath, eastl::hash_set<eastl::string16>& dstSkippedPaths, int& dstCount);
 
 		static Thumbnail_cImportExport* Get();
 
@@ -140,7 +148,7 @@ namespace App
 		/* 44h */	uint32_t mMachineId;  // not initialized
 		/* 48h */	eastl::hash_map<int, int> field_48;
 		/* 68h */	eastl::hash_map<int, int> field_68;
-		/* 88h */	PngEncoder mPngEncoder;
+		/* 88h */	MIPEncoder mMipEncoder;
 		/* F8h */	ResourceKey mCurImage;
 		/* 104h */	eastl::string16 mCellsPath;
 		/* 114h */	eastl::string16 mCreaturesPath;
@@ -159,15 +167,15 @@ namespace App
 		DeclareAddress(Get);
 		DeclareAddress(GetFolderPath);
 		DeclareAddress(FolderPathFromLocale);
-		DeclareAddress(SavePNG);
-		DeclareAddress(ImportPNG);
-		DeclareAddress(DecodePNG);  // 0x5FBA10 0x5FBB90
+		DeclareAddress(SaveMIP);
+		DeclareAddress(ImportMIP);
+		DeclareAddress(DecodeMIP);  // 0x5FBA10 0x5FBB90
 		DeclareAddress(SaveFilePaths);  // 0x5F89C0 0x5F8B60
-		DeclareAddress(ImportDirectoryPNGs);  // 0x5FC900 0x5FCA80
+		DeclareAddress(ImportDirectoryMIPs);  // 0x5FC900 0x5FCA80
 	}
 
-	namespace Addresses(PngEncoder)
+	namespace Addresses(MIPEncoder)
 	{
-		DeclareAddress(EncodePNG);  // 0x68E660 0x68e190
+		DeclareAddress(WriteImageToStream);  // 0x68E660 0x68e190
 	}
 }