vkQuake embedded pack : removed dependency on compressor tooling

- Removed zopfli external dependency, also because discontinued
- replaced by bintoc -c option, built around our existing miniz
- Upgraded to miniz 3.10 to bring back compression routines, was stripped previously
- Embed miniz.c stb-style (supported by miniz) dicrectly into common.c and bintoc.c compilations units
- Makefiles and Meson now rebuild both vkquake.pak and embedded_pak.c.
- TODO: Do the same for MSVC: add a mkpak.vcxproj, make embedded.vcxproj run both mkpak + bintoc to regenerate all

Author: vsonnier

.gitignore

@@ -5,6 +5,7 @@ Quake/*.o
 Quake/*.d
 Quake/id1/
 Quake/vkquake
+Quake/vkquake.pak
 Quake/*.exe
 Quake/*.res
 Windows/VisualStudio/Id1

Misc/vq_pak/Makefile

@@ -1,36 +1,22 @@
-INPUT := gfx/conback.lmp \
-	gfx/mainmenu2.lmp \
-	gfx/p_mods.lmp \
-	maps/e1m1@c49d.ent \
-	maps/e1m2@0caa.ent \
-	maps/e1m4@958e.ent \
-	maps/e2m2@fbfe.ent \
-	maps/e2m3@237a.ent \
-	maps/e2m7@10a8.ent \
-	maps/r2m3@63f4.ent \
-	maps/r2m3@76ec.ent \
-	default.cfg
-
+HOST_CC = gcc
+INPUT := $(shell cat vq_pak_contents.txt)
 OUTPUT_NAME := vkquake.pak
 OUTPUT := ../../Quake/$(OUTPUT_NAME)
 OUTPUT_EMBEDDED := ../../Quake/embedded_pak.c
 
-$(OUTPUT_EMBEDDED): bintoc $(OUTPUT) $(OUTPUT).deflate
-	./bintoc $(OUTPUT) $(OUTPUT_NAME) $(OUTPUT_EMBEDDED)
-
-$(OUTPUT).deflate: $(OUTPUT)
-	zopfli --deflate $(OUTPUT)
+$(OUTPUT_EMBEDDED): bintoc $(OUTPUT)
+	./../../Shaders/bintoc -c $(OUTPUT) $(OUTPUT_NAME) $(OUTPUT_EMBEDDED)
 
 $(OUTPUT): mkpak $(INPUT)
-	./mkpak $(OUTPUT) $(INPUT)
+	./mkpak $(OUTPUT) . $(INPUT)
 
 mkpak: mkpak.c
-	cc mkpak.c -o mkpak --std=gnu11 -g
+	$(HOST_CC) mkpak.c -o mkpak --std=gnu11 -g
 
-bintoc: ../../Shaders/bintoc.c
-	cc ../../Shaders/bintoc.c -o bintoc --std=gnu11 -g
+bintoc: ../../Shaders/bintoc.c 
+	$(HOST_CC) -I../../Quake/ ../../Shaders/bintoc.c -o ../../Shaders/bintoc --std=gnu11 -g 
 
 .PHONY: clean
 clean:
 	rm -f mkpak
-	rm -f bintoc
+	rm -f ../../Shaders/bintoc

Misc/vq_pak/mkpak.c

@@ -57,9 +57,10 @@ void write_header (int32_t directory_offset, int32_t directory_size)
 
 int main (int argc, char *argv[])
 {
-	if (argc < 3)
+	
+	if (argc < 4)
 	{
-		fprintf (stderr, "Usage: mkpak [output.pak] [files...]\n");
+		fprintf (stderr, "Usage: mkpak [output.pak] [root dir for files] [files...]\n");
 		return 1;
 	}
 
@@ -71,20 +72,24 @@ int main (int argc, char *argv[])
 	}
 
 	int32_t directory_offset = 12;
-	int32_t num_in_files = argc - 2;
+	int32_t num_in_files = argc - 3;
 	int32_t directory_size = num_in_files * sizeof (dpackfile_t);
 	int32_t file_offset = directory_offset + directory_size;
 
 	write_header (directory_offset, directory_size);
 
+    char input_file_path[1024];
+	
 	uint8_t *in_buffer = NULL;
-	for (int i = 2; i < argc; ++i)
+	for (int i = 3; i < argc; ++i)
 	{
-		int   file_index = i - 2;
-		FILE *in = fopen (argv[i], "rb");
+		int   file_index = i - 3;
+		//prepend the root dir
+		snprintf(input_file_path, sizeof(input_file_path), "%s/%s", argv[2], argv[i]);
+		FILE *in = fopen (input_file_path, "rb");
 		if (in == NULL)
 		{
-			fprintf (stderr, "Could not open input file '%s'", argv[i]);
+			fprintf (stderr, "Could not open input file '%s'", input_file_path);
 			return 1;
 		}
 

Misc/vq_pak/vq_pak_contents.txt

@@ -0,0 +1,12 @@
+gfx/conback.lmp
+gfx/mainmenu2.lmp
+gfx/p_mods.lmp
+maps/e1m1@c49d.ent
+maps/e1m2@0caa.ent
+maps/e1m4@958e.ent
+maps/e2m2@fbfe.ent
+maps/e2m3@237a.ent
+maps/e2m7@10a8.ent
+maps/r2m3@63f4.ent
+maps/r2m3@76ec.ent
+default.cfg

Quake/Makefile

@@ -89,7 +89,7 @@ LIBS := $(COMMON_LIBS) $(CODECLIBS)
 # ---------------------------
 # targets / rules
 # ---------------------------
-all: $(DEFAULT_TARGET)
+all: $(BINTOC_EXE) .WAIT $(DEFAULT_TARGET)
 
 vkquake: $(SHADER_OBJS) $(OBJS)
 	$(LINKER) $(SHADER_OBJS) $(OBJS) $(LDFLAGS) $(LIBS) $(SDL_LIBS) -o $@
@@ -100,7 +100,8 @@ debug:
 	$(error Use "make DEBUG=1")
 
 clean:
-	$(RM) *.o *.d $(DEFAULT_TARGET) $(BINTOC_EXE) \
+	make -C ../Misc/vq_pak clean
+	$(RM) *.o *.d $(DEFAULT_TARGET) vkquake.pak $(BINTOC_EXE) \
 	../Shaders/Compiled/$(GLSLANG_OUT_FOLDER)/*.c \
 	../Shaders/Compiled/$(GLSLANG_OUT_FOLDER)/*.spv \
 	../Shaders/Compiled/$(GLSLANG_OUT_FOLDER)/*.d

Quake/Makefile.w64

@@ -77,7 +77,7 @@ LIBWINPTHREAD = $(MSYSTEM_PREFIX)/bin/libwinpthread-1.dll
 # ---------------------------
 # targets / rules
 # ---------------------------
-all: $(DEFAULT_TARGET) dll
+all: $(BINTOC_EXE) .WAIT $(DEFAULT_TARGET) dll
 
 %.res: ../Windows/%.rc
 	$(WINDRES) -I../Windows -I../Quake --output-format=coff --target=pe-x86-64 -o $@ $<
@@ -98,7 +98,8 @@ debug:
 	$(error Use "make DEBUG=1")
 
 clean:
-	$(RM) *.o *.d *.res *.dll $(DEFAULT_TARGET) \
+	make -C ../Misc/vq_pak clean
+	$(RM) *.o *.d *.res *.dll vkquake.pak $(DEFAULT_TARGET) \
 	$(BINTOC_EXE) \
 	../Shaders/Compiled/$(GLSLANG_OUT_FOLDER)/*.c \
 	../Shaders/Compiled/$(GLSLANG_OUT_FOLDER)/*.spv \

Quake/common.c

@@ -28,7 +28,14 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #include "q_ctype.h"
 #include <errno.h>
 
-#include "miniz.h"
+// Plug our allocators into miniz:
+#define MZ_MALLOC(x)	 Mem_Alloc (x)
+#define MZ_FREE(x)		 Mem_Free (x)
+#define MZ_REALLOC(p, x) Mem_Realloc (p, x)
+
+// include miniz stb-syle, directly in this compilation unit.
+#define MINIZ_HEADER_FILE_ONLY
+#include "miniz.c"
 
 static char *largv[MAX_NUM_ARGVS + 1];
 static char	 argvdummy[] = " ";
@@ -2255,9 +2262,12 @@ static void COM_AddGameDirectory (const char *dir)
 				tinfl_decompressor inflator;
 				tinfl_init (&inflator);
 				vkquake_pak_extracted = Mem_Alloc (vkquake_pak_size_extracted);
-				if (TINFL_STATUS_DONE != tinfl_decompress (
-											 &inflator, vkquake_pak, &vkquake_pak_size_compressed, vkquake_pak_extracted, vkquake_pak_extracted,
-											 &vkquake_pak_size_extracted, TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF))
+
+				tinfl_status decomp_status = tinfl_decompress (
+					&inflator, vkquake_pak, &vkquake_pak_size_compressed, vkquake_pak_extracted, vkquake_pak_extracted, &vkquake_pak_size_extracted,
+					TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF);
+
+				if (TINFL_STATUS_DONE != decomp_status)
 					Sys_Error ("Error extracting embedded pack");
 			}
 			qboolean pak0_modified = com_modified;

Quake/common.make

@@ -216,7 +216,6 @@ OBJS := strlcat.o \
 	wad.o \
 	cmd.o \
 	common.o \
-	miniz.o \
 	crc.o \
 	cvar.o \
 	cfgfile.o \
@@ -240,7 +239,8 @@ OBJS := strlcat.o \
 	$(SYSOBJ_SYS) $(SYSOBJ_MAIN)
 
 $(BINTOC_EXE): ../Shaders/bintoc.c
-	$(HOST_CC) -o $@ $<
+	make -C ../Misc/vq_pak clean
+	make -B -C ../Misc/vq_pak
 
 .SECONDARY:
 ../Shaders/Compiled/$(GLSLANG_OUT_FOLDER)/%_frag.spv: ../Shaders/%.frag
@@ -270,7 +270,7 @@ $(BINTOC_EXE): ../Shaders/bintoc.c
 	$(BINTOC_EXE) $< $*_comp_spv ../Shaders/Compiled/$(GLSLANG_OUT_FOLDER)/$*_comp.c
 	$(CC) $(DFLAGS) -c $(CFLAGS) $(SDL_CFLAGS) -o $@ ../Shaders/Compiled/$(GLSLANG_OUT_FOLDER)/$*_comp.c
 
-%.o:	%.c
+%.o: %.c
 	$(CC) $(DFLAGS) -c $(CFLAGS) $(SDL_CFLAGS) -o $@ $<
 
 sinclude $(OBJS:.o=.d)