engine: embed media files

Author: illwieckz

CMakeLists.txt

@@ -1010,6 +1010,9 @@ if (NOT NACL)
             Tests ${ENGINETESTLIST}
         )
     endif()
+
+    # Generate media include files.
+    daemon_embed_files("EngineMedia" "MEDIA" "BINARY" "engine-lib")
 endif()
 
 if (BUILD_CLIENT)

src.cmake

@@ -86,6 +86,13 @@ else()
     include (${ENGINE_DIR}/renderer/src.cmake)
 endif()
 
+set(MEDIA_EMBED_DIR ${ENGINE_DIR}/media)
+set(MEDIA_EMBED_LIST
+	gfx/2d/bigchars.png
+	scripts/engine.shader
+	sound/null.wav
+)
+
 set(GLSL_EMBED_DIR "${ENGINE_DIR}/renderer/glsl_source")
 set(GLSL_EMBED_LIST
     # Common shader libraries
@@ -167,6 +174,8 @@ set(SERVERLIST
 )
 
 set(ENGINELIST
+    ${DAEMON_EMBEDDED_DIR}/EngineMedia.cpp
+    ${DAEMON_EMBEDDED_DIR}/EngineMedia.h
     ${ENGINE_DIR}/framework/Application.cpp
     ${ENGINE_DIR}/framework/Application.h
     ${ENGINE_DIR}/framework/ApplicationInternals.h

src/common/FileSystem.cpp

@@ -30,6 +30,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 #if defined(BUILD_ENGINE)
 #include "minizip/unzip.h"
+#include "DaemonEmbedded/EngineMedia.h"
 #endif
 
 #ifdef BUILD_VM
@@ -129,6 +130,15 @@ static Cvar::Cvar<bool> fs_legacypaks("fs_legacypaks", "also load pk3s, ignoring
 static Cvar::Cvar<int> fs_maxSymlinkDepth("fs_maxSymlinkDepth", "max depth of symlinks in zip paks (0 means disabled)", Cvar::NONE, 1);
 static Cvar::Cvar<std::string> fs_pakprefixes("fs_pakprefixes", "prefixes to look for paks to load", 0, "");
 
+const PakInfo builtinPak =
+{
+	"*builtin",
+	ENGINE_VERSION,
+	0,
+	pakType_t::PAK_BUILTIN,
+	"*builtin",
+};
+
 bool UseLegacyPaks()
 {
 	return fs_legacypaks.Get();
@@ -1258,6 +1268,7 @@ static void InternalLoadPak(
 	offset_t depsOffset = 0;
 	ZipArchive zipFile;
 	bool isLegacy = pak.version.empty();
+	bool isBuiltin = pak.type == pakType_t::PAK_BUILTIN;
 
 	// Check if this pak has already been loaded to avoid recursive dependencies
 	for (auto& x: loadedPaks) {
@@ -1279,6 +1290,8 @@ static void InternalLoadPak(
 		} else {
 			fsLogs.WithoutSuppression().Notice("Loading legacy pakdir '%s'...", pak.path.c_str());
 		}
+	} else if (pak.type == pakType_t::PAK_BUILTIN ) {
+		fsLogs.WithoutSuppression().Notice("Loading builtin pak '%s'...", pak.path.c_str());
 	} else {
 		ASSERT_UNREACHABLE();
 	}
@@ -1369,6 +1382,10 @@ static void InternalLoadPak(
 		}, err);
 		if (err)
 			return;
+	} else if (pak.type == pakType_t::PAK_BUILTIN) {
+		for ( auto it : EngineMedia::FileMap ) {
+			fileMap.emplace(it.first, std::pair<uint32_t, offset_t>(loadedPaks.size() - 1, 0));
+		}
 	} else {
 		ASSERT_UNREACHABLE();
 	}
@@ -1388,8 +1405,8 @@ static void InternalLoadPak(
 
 	loadedPak.pathPrefix = pathPrefix;
 
-	// Legacy paks don't have version neither checksum
-	if (!isLegacy) {
+	// Legacy and builtin paks don't have version neither checksum
+	if (!isLegacy && !isBuiltin) {
 		// If an explicit checksum was requested, verify that the pak we loaded is the one we are expecting
 		if (expectedChecksum && realChecksum != *expectedChecksum) {
 			SetErrorCodeFilesystem(err, filesystem_error::wrong_pak_checksum, pak.path);
@@ -1589,6 +1606,8 @@ std::string ReadFile(Str::StringRef path, std::error_code& err)
 			return "";
 
 		return out;
+	} else if (pak.type == pakType_t::PAK_BUILTIN) {
+		return EngineMedia::ReadFile(it->first);
 	}
 
 	ASSERT_UNREACHABLE();
@@ -2660,6 +2679,13 @@ static const PakInfo* FindPakNoPrefix(Str::StringRef name)
 
 const PakInfo* FindPak(Str::StringRef name)
 {
+#if defined(BUILD_ENGINE)
+	if (name == builtinPak.name)
+	{
+		return &builtinPak;
+	}
+#endif
+
 	Cmd::Args pakprefixes(Cvar::GetValue("fs_pakprefixes"));
 	for (const std::string &pakprefix: pakprefixes)
 	{

src/common/FileSystem.h

@@ -265,7 +265,8 @@ template<typename State> class DirectoryIterator {
 // Type of pak
 enum class pakType_t {
 	PAK_ZIP, // Zip archive
-	PAK_DIR // Directory
+	PAK_DIR, // Directory
+	PAK_BUILTIN, // Embedded in the executable
 };
 
 // Information about a package
@@ -288,6 +289,8 @@ struct PakInfo {
 	std::string path;
 };
 
+extern const PakInfo builtinPak;
+
 // Information about a package that has been loaded
 struct LoadedPakInfo: public PakInfo {
 	// Actual CRC32 checksum of the pak, derived from the pak contents. This is

pkg/daemon_src.dpkdir/gfx/2d/bigchars.png renamed to src/engine/media/gfx/2d/bigchars.png

@@ -655,6 +655,10 @@ bool FS_LoadPak(const Str::StringRef name)
 
 void FS_LoadBasePak()
 {
+#if defined(BUILD_GRAPHICAL_CLIENT)
+	FS_LoadPak(FS::builtinPak.name);
+#endif
+
 	Cmd::Args extrapaks(fs_extrapaks.Get());
 	for (auto& x: extrapaks) {
 		if (!FS_LoadPak(x)) {