add series wad creation

creates a wad from embedded textures in connected maps

Author: wootguy

src/bsp/Bsp.cpp

@@ -2816,6 +2816,10 @@ float Bsp::calc_allocblock_usage() {
 		if (info.nFlags & TEX_SPECIAL)
 			continue; // does not use lightmaps
 
+		BSPMIPTEX* tex = get_texture(info.iMiptex);
+		if (tex && tex->szName[0] == '!')
+			continue; // water doesn't use lightmaps
+
 		int size[2];
 		GetFaceLightmapSize(this, i, size);
 
@@ -3785,6 +3789,43 @@ void Bsp::remove_unused_wads(vector<Wad*>& wads) {
 	}
 }
 
+// returns data for all embedded textures, ready to be wrtten to a WAD
+vector<WADTEX> Bsp::get_embedded_textures() {
+	vector<WADTEX> wadTextures;
+
+	for (int i = 0; i < textureCount; i++) {
+		int32_t offset = ((int32_t*)textures)[i + 1];
+		BSPMIPTEX* tex = (BSPMIPTEX*)(textures + offset);
+
+		if (tex->nOffsets[0] == 0) {
+			continue; // not embedded
+		}
+
+		WADTEX copy;
+		memcpy(&copy, tex, sizeof(BSPMIPTEX)); // copy name, offset, dimenions
+		int dataSz = copy.getDataSize();
+		copy.data = new byte[dataSz];
+		memcpy(copy.data, (byte*)tex + tex->nOffsets[0], dataSz);
+
+		wadTextures.push_back(copy);
+	}
+
+	return wadTextures;
+}
+
+int Bsp::get_texture_id(string name) {
+	for (int i = 0; i < textureCount; i++) {
+		int32_t offset = ((int32_t*)textures)[i + 1];
+		BSPMIPTEX* tex = (BSPMIPTEX*)(textures + offset);
+
+		if (!strcasecmp(tex->szName, name.c_str())) {
+			return i;
+		}
+	}
+
+	return -1;
+}
+
 int Bsp::zero_entity_origins(string classname) {
 	int moveCount = 0;
 
@@ -3902,7 +3943,7 @@ bool Bsp::embed_texture(int textureId, vector<Wad*>& wads) {
 	return embedded;
 }
 
-int Bsp::unembed_texture(int textureId, vector<Wad*>& wads, bool force) {
+int Bsp::unembed_texture(int textureId, vector<Wad*>& wads, bool force, bool quiet) {
 	int32_t texOffset = ((int32_t*)textures)[textureId + 1];
 
 	BSPMIPTEX* tex = get_texture(textureId);
@@ -3965,7 +4006,8 @@ int Bsp::unembed_texture(int textureId, vector<Wad*>& wads, bool force) {
 	memcpy(newTexData, lumps[LUMP_TEXTURES], endOffset);
 	memcpy(newTexData + endOffset, lumps[LUMP_TEXTURES] + endOffset + texDataSz, newTexBufferSz - endOffset);
 
-	logf("Unembedded texture %s\n", tex->szName);
+	if (!quiet)
+		logf("Unembedded texture %s\n", tex->szName);
 	delete[] lumps[LUMP_TEXTURES];
 	lumps[LUMP_TEXTURES] = newTexData;
 	header.lump[LUMP_TEXTURES].nLength -= texDataSz;
@@ -4713,6 +4755,7 @@ void Bsp::write(string path) {
 	// write the lumps
 	for (int i = 0; i < HEADER_LUMPS; i++) {
 		file.write((char*)lumps[i], header.lump[i].nLength);
+		//logf("LUMP %10s = %.2f MB\n", g_lump_names[i], (float)header.lump[i].nLength / (1024.0f*1024.0f));
 	}
 }
 
@@ -5254,6 +5297,7 @@ bool Bsp::validate() {
 		mark_model_structures(i, &usage, false);
 		usage.compute_sum();
 		if (usage.sum.faces != models[i].nFaces) {
+			//logf("Bad face count in model %d: %d / %d (fixed)\n", i, usage.sum.faces, models[i].nFaces);
 			logf("Bad face count in model %d: %d / %d\n", i, usage.sum.faces, models[i].nFaces);
 		}
 	}

src/bsp/Bsp.h

@@ -284,7 +284,7 @@ class Bsp
 	bool embed_texture(int textureId, vector<Wad*>& wads);
 
 	// return 1 on success, 0 on failure, 2 on success and resize
-	int unembed_texture(int textureId, vector<Wad*>& wads, bool force=false);
+	int unembed_texture(int textureId, vector<Wad*>& wads, bool force=false, bool quiet=false);
 
 	// adds a texture reference to the BSP (does not embed it)
 	// returns an iMipTex for use in texture infos
@@ -302,6 +302,12 @@ class Bsp
 
 	void remove_unused_wads(vector<Wad*>& wads);
 
+	// returns data for all embedded textures, ready to be wrtten to a WAD
+	vector<WADTEX> get_embedded_textures();
+
+	// gets the ID for a texture, or -1 if not found
+	int get_texture_id(string name);
+
 	// updates texture coordinates after a texture has been resized
 	void adjust_resized_texture_coordinates(BSPFACE& face, BSPTEXTUREINFO& info, int newWidth, int newHeight, int oldWidth, int oldHeight);
 	void adjust_resized_texture_coordinates(int textureId, int oldWidth, int oldHeight);

src/editor/Gui.cpp

@@ -1114,23 +1114,7 @@ void Gui::drawStandardMenuBar() {
 					1, wadFilterPatterns, "Half-Life Package (*.wad)");
 
 				if (fname) {
-					vector<WADTEX> wadTextures;
-					for (int i = 0; i < map->textureCount; i++) {
-						int32_t offset = ((int32_t*)map->textures)[i + 1];
-						BSPMIPTEX* tex = (BSPMIPTEX*)(map->textures + offset);
-
-						if (tex->nOffsets[0] == 0) {
-							continue; // not embedded
-						}
-
-						WADTEX copy;
-						memcpy(&copy, tex, sizeof(BSPMIPTEX)); // copy name, offset, dimenions
-						int dataSz = copy.getDataSize();
-						copy.data = new byte[dataSz];
-						memcpy(copy.data, (byte*)tex + tex->nOffsets[0], dataSz);
-
-						wadTextures.push_back(copy);
-					}
+					vector<WADTEX> wadTextures = map->get_embedded_textures();
 
 					Wad outWad = Wad();
 					outWad.write(fname, &wadTextures[0], wadTextures.size());
@@ -1839,9 +1823,18 @@ void Gui::drawStandardMenuBar() {
 		}
 		tooltip(g, "Scales up textures on invisible model faces to reduce AllocBlock size. "
 			"Manually increase texture scales or downscale large textures to reduce "
-			"AllocBlocks further.\n");
+			"AllocBlocks further.");
 
 		if (ImGui::BeginMenu("Textures")) {
+			if (ImGui::MenuItem("Create Series WAD", "")) {
+				createSeriesWad();
+			}
+			tooltip(g, "Creates a WAD file containing the embedded textures from all maps in a series. "
+				"Textures with the same name but different appearance will not be exported.\n\n"
+				"Textures that are exported will also be unembedded from their BSPs, and included "
+				"via the newly created WAD file instead. The point of this tool is to reduce disk "
+				"space used by campaigns that duplicate textures across many maps.");
+
 			if (ImGui::MenuItem("Embed All", 0, false, !app->isLoading)) {
 				LumpReplaceCommand* command = new LumpReplaceCommand("Embed Textures");
 
@@ -1897,12 +1890,7 @@ void Gui::drawStandardMenuBar() {
 				"in the worldspawn entity.\n\nIf an embedded texture cannot be found in a WAD, it will become "
 				"a missing texture. You may want to export embedded textures first to avoid losing data.");
 
-			if (ImGui::MenuItem("Remove Unused WADs", 0, false, !app->isLoading)) {
-				LumpReplaceCommand* command = new LumpReplaceCommand("Remove Unused WADs", true);
-				map->remove_unused_wads(wads);
-				command->pushUndoState();
-			}
-			tooltip(g, "Removes unused WADs from the worldspawn 'wad' keyvalue and strips folder paths.");
+			ImGui::Separator();
 
 			if (ImGui::MenuItem("Downscale Invalid", 0, false, !app->isLoading)) {
 				LumpReplaceCommand* command = new LumpReplaceCommand("Downscale Textures");
@@ -1917,6 +1905,13 @@ void Gui::drawStandardMenuBar() {
 				"and adjusts texture coordinates accordingly.\n\nIf a texture is stored in a WAD, "
 				"it is first embedded into the BSP before being downscaled.\n");
 
+			if (ImGui::MenuItem("Remove Unused WADs", 0, false, !app->isLoading)) {
+				LumpReplaceCommand* command = new LumpReplaceCommand("Remove Unused WADs", true);
+				map->remove_unused_wads(wads);
+				command->pushUndoState();
+			}
+			tooltip(g, "Removes unused WADs from the worldspawn 'wad' keyvalue and strips folder paths.");
+
 			ImGui::EndMenu();
 		}
 
@@ -7990,4 +7985,128 @@ void Gui::windowResized(int width, int height) {
 
 string Gui::getUserLayoutPath() {
 	return getFolderPath(ImGui::GetIO().IniFilename) + "imgui_user.ini";
+}
+
+void Gui::createSeriesWad() {
+	char* fnamestr = tinyfd_openFileDialog("Select Series Maps", "",
+		1, bspFilterPatterns, "GoldSrc Map Files (*.bsp)", 1);
+
+	vector<string> fnames;
+
+	if (fnamestr)
+		fnames = splitString(fnamestr, "|");
+
+	string defaultPath = getFolderPath(getFolderPath(fnames[0]));
+
+	char* sharedWadName = tinyfd_saveFileDialog("Series WAD Name", defaultPath.c_str(),
+		1, wadFilterPatterns, "Half-Life Package (*.wad)");
+
+	if (!fnames.size() || !sharedWadName) {
+		return;
+	}
+
+
+	vector<WADTEX> sharedTex;
+	vector<Wad*> emptyWadList;
+
+	for (int i = 0; i < fnames.size(); i++) {
+		Bsp* temp = new Bsp(fnames[i]);
+		if (!temp->valid) {
+			delete temp;
+			continue;
+		}
+
+		vector<WADTEX> embedded = temp->get_embedded_textures();
+
+		if (embedded.empty()) {
+			logf("No embedded textures found in %s\n", temp->name);
+			delete temp;
+			continue;
+		}
+
+		int numExport = 0;
+		bool anyUnembed = false;
+
+		for (int j = 0; j < embedded.size(); j++) {
+			WADTEX& bsptex = embedded[j];
+
+			bool isConflicted = false;
+			bool isAlreadyWritten = false;
+			for (int k = 0; k < sharedTex.size(); k++) {
+				WADTEX& wadtex = sharedTex[k];
+
+				if (strcasecmp(wadtex.szName, bsptex.szName)) {
+					continue;
+				}
+
+				// names match, but do the contents?
+				if (wadtex.nHeight != bsptex.nHeight || wadtex.nWidth != bsptex.nWidth) {
+					logf("Texture %s in %s has different dimensions than in the WAD\n",
+						bsptex.szName, temp->name);
+					isConflicted = true;
+					break;
+				}
+
+				if (memcmp(wadtex.data, bsptex.data, bsptex.getDataSize())) {
+					logf("Texture %s in %s has different data than in the WAD\n",
+						bsptex.szName, temp->name);
+					isConflicted = true;
+					break;
+				}
+
+				isAlreadyWritten = true;
+				break;
+			}
+
+			if (!isConflicted) {
+				int id = temp->get_texture_id(bsptex.szName);
+				temp->unembed_texture(id, emptyWadList, true, true);
+				anyUnembed = true;
+
+				if (!isAlreadyWritten) {
+					sharedTex.push_back(bsptex);
+					numExport++;
+				}
+				else {
+					delete[] bsptex.data;
+				}
+			}
+			else
+				delete[] bsptex.data;
+		}
+
+		if (anyUnembed) {
+			bool didUpdate = false;
+			for (Entity* ent : temp->ents) {
+				if (ent->getClassname() == "worldspawn") {
+					string wadlist = ent->getKeyvalue("wad");
+					if (wadlist.size() && wadlist[wadlist.size() - 1] != ';') {
+						wadlist += ";";
+					}
+					wadlist += basename(sharedWadName);
+					ent->setOrAddKeyvalue("wad", wadlist);
+					didUpdate = true;
+					break;
+				}
+			}
+			if (!didUpdate) {
+				logf("ERROR: %s does not have a worldspawn entity to update.\n", temp->name);
+			}
+			temp->update_ent_lump();
+		}
+
+		logf("Added %d / %d embedded textures from %s\n",
+			numExport, embedded.size(), temp->name.c_str());
+
+		temp->write(fnames[i]);
+		delete temp;
+	}
+
+	Wad outWad = Wad();
+	outWad.write(sharedWadName, &sharedTex[0], sharedTex.size());
+	logf("Exported %d embedded textures to %s\n", sharedTex.size(), sharedWadName);
+
+	for (WADTEX& tex : sharedTex) {
+		delete[] tex.data;
+	}
 }

src/editor/Gui.h

@@ -180,4 +180,5 @@ class Gui {
 	void loadFonts();
 	void checkFaceErrors();
 	string getUserLayoutPath(); // path to user's saved widget layout
+	void createSeriesWad();
 };