#region ================== Copyright (c) 2007 Pascal vd Heiden /* * Copyright (c) 2007 Pascal vd Heiden, www.codeimp.com * This program is released under GNU General Public License * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * */ #endregion #region ================== Namespaces using System; using System.Collections; using System.Collections.Generic; using System.IO; using CodeImp.DoomBuilder.IO; using CodeImp.DoomBuilder.ZDoom; using CodeImp.DoomBuilder.GZBuilder.Data; using System.Text.RegularExpressions; #endregion namespace CodeImp.DoomBuilder.Data { internal sealed class WADReader : DataReader { #region ================== Constants #endregion #region ================== Structures private struct LumpRange { public int start; public int end; } #endregion #region ================== Variables // Source private WAD file; private bool is_iwad; private bool strictpatches; // Lump ranges private List flatranges; private List invertedflatranges; //mxd private List patchranges; private List spriteranges; private List textureranges; private List colormapranges; private List voxelranges; //mxd #endregion #region ================== Properties public bool IsIWAD { get { return is_iwad; } } #endregion #region ================== Constructor / Disposer // Constructor public WADReader(DataLocation dl) : base(dl) { General.WriteLogLine("Opening WAD resource '" + location.location + "'"); if(!File.Exists(location.location)) throw new FileNotFoundException("Could not find the file \"" + location.location + "\"", location.location); // Initialize file = new WAD(location.location, true); is_iwad = (file.Type == WAD.TYPE_IWAD); strictpatches = dl.option1; patchranges = new List(); spriteranges = new List(); flatranges = new List(); textureranges = new List(); colormapranges = new List(); voxelranges = new List(); //mxd // Find ranges FindRanges(patchranges, General.Map.Config.PatchRanges, "patches"); FindRanges(spriteranges, General.Map.Config.SpriteRanges, "sprites"); FindRanges(flatranges, General.Map.Config.FlatRanges, "flats"); FindRanges(textureranges, General.Map.Config.TextureRanges, "textures"); FindRanges(colormapranges, General.Map.Config.ColormapRanges, "colormaps"); FindRanges(voxelranges, General.Map.Config.VoxelRanges, "voxels"); //mxd invertedflatranges = new List(); if(flatranges.Count > 0) { //add range before the first flatrange if (flatranges[0].start > 0) { LumpRange range = new LumpRange {start = 0, end = flatranges[0].start - 1}; invertedflatranges.Add(range); } //add ranges between flatranges for(int i = 1; i < flatranges.Count; i++) { LumpRange range = new LumpRange { start = flatranges[i - 1].end + 1, end = flatranges[i].start - 1 }; invertedflatranges.Add(range); } //add range after the last flatrange if(flatranges[flatranges.Count - 1].end < file.Lumps.Count - 1) { LumpRange range = new LumpRange { start = flatranges[flatranges.Count - 1].end + 1, end = file.Lumps.Count - 1 }; invertedflatranges.Add(range); } } else // No flat ranges? Make one giant range then... { LumpRange range = new LumpRange {start = 0, end = file.Lumps.Count - 1}; invertedflatranges.Add(range); } // We have no destructor GC.SuppressFinalize(this); } // Disposer public override void Dispose() { // Not already disposed? if(!isdisposed) { General.WriteLogLine("Closing WAD resource '" + location.location + "'"); // Clean up file.Dispose(); // Done base.Dispose(); } } #endregion #region ================== Management // Return a short name for this data location public override string GetTitle() { return Path.GetFileName(location.location); } // This suspends use of this resource public override void Suspend() { file.Dispose(); base.Suspend(); } // This resumes use of this resource public override void Resume() { file = new WAD(location.location, true); is_iwad = (file.Type == WAD.TYPE_IWAD); base.Resume(); } // This fills a ranges list private void FindRanges(List ranges, IDictionary rangeinfos, string rangename) { Dictionary> failedranges = new Dictionary>(); //mxd Dictionary successfulrangestarts = new Dictionary(); //mxd Dictionary failedrangestarts = new Dictionary(); //mxd foreach(DictionaryEntry r in rangeinfos) { // Read start and end string rangestart = General.Map.Config.ReadSetting(rangename + "." + r.Key + ".start", ""); string rangeend = General.Map.Config.ReadSetting(rangename + "." + r.Key + ".end", ""); if((rangestart.Length > 0) && (rangeend.Length > 0)) { // Find ranges int startindex = file.FindLumpIndex(rangestart); while(startindex > -1) { LumpRange range = new LumpRange(); range.start = startindex; range.end = file.FindLumpIndex(rangeend, startindex); if(range.end > -1) { if(!successfulrangestarts.ContainsKey(startindex)) successfulrangestarts.Add(startindex, false); //mxd ranges.Add(range); startindex = file.FindLumpIndex(rangestart, range.end); } else { //mxd if (!failedrangestarts.ContainsKey(startindex)) { failedranges.Add(range, new KeyValuePair(rangestart, rangeend)); //mxd failedrangestarts.Add(startindex, false); } startindex = -1; } } } } //mxd. Display warnings for unclosed ranges foreach (KeyValuePair> group in failedranges) { if(successfulrangestarts.ContainsKey(group.Key.start)) continue; General.ErrorLogger.Add(ErrorType.Warning, "'" + group.Value.Key + "' range at index " + group.Key.start + " is not closed in '" + location.location + "' ('" + group.Value.Value + "' marker is missing)!"); } } #endregion #region ================== Palette // This loads the PLAYPAL palette public override Playpal LoadPalette() { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); // Look for a lump named PLAYPAL Lump lump = file.FindLump("PLAYPAL"); if(lump != null) return new Playpal(lump.Stream); // Read the PLAYPAL from stream return null; // No palette } #endregion #region ================== Colormaps // This loads the textures public override ICollection LoadColormaps() { List images = new List(); string rangestart, rangeend; // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); // Read ranges from configuration foreach(DictionaryEntry r in General.Map.Config.ColormapRanges) { // Read start and end rangestart = General.Map.Config.ReadSetting("colormaps." + r.Key + ".start", ""); rangeend = General.Map.Config.ReadSetting("colormaps." + r.Key + ".end", ""); if((rangestart.Length > 0) && (rangeend.Length > 0)) { // Load texture range LoadColormapsRange(rangestart, rangeend, ref images); } } // Add images to the container-specific texture set foreach(ImageData img in images) textureset.AddFlat(img); // Return result return images; } // This loads a range of colormaps private void LoadColormapsRange(string startlump, string endlump, ref List images) { int startindex, endindex; ColormapImage image; // Continue until no more start can be found startindex = file.FindLumpIndex(startlump); while(startindex > -1) { // Find end index endindex = file.FindLumpIndex(endlump, startindex + 1); if(endindex > -1) { // Go for all lumps between start and end exclusive for(int i = startindex + 1; i < endindex; i++) { // Lump not zero-length? if(file.Lumps[i].Length > 0) { // Make the image object image = new ColormapImage(file.Lumps[i].Name); // Add image to collection images.Add(image); } } } // Find the next start startindex = file.FindLumpIndex(startlump, startindex + 1); } } // This finds and returns a colormap stream public override Stream GetColormapData(string pname) { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); Lump lump; // Strictly read patches only between C_START and C_END? if(strictpatches) { // Find the lump in ranges foreach(LumpRange range in colormapranges) { lump = file.FindLump(pname, range.start, range.end); if(lump != null) return lump.Stream; } } else { // Find the lump anywhere lump = file.FindLump(pname); if(lump != null) return lump.Stream; } return null; } #endregion #region ================== Textures // This loads the textures public override ICollection LoadTextures(PatchNames pnames) { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); List images = new List(); float defaultscale = General.Map.Config.DefaultTextureScale; //mxd // Load two sets of textures, if available Lump lump = file.FindLump("TEXTURE1"); if(lump != null) { LoadTextureSet("TEXTURE1", lump.Stream, ref images, pnames); if(images.Count > 0) images.RemoveAt(0); //mxd. The first TEXTURE1 texture cannot be used. Let's remove it here } lump = file.FindLump("TEXTURE2"); if(lump != null) LoadTextureSet("TEXTURE2", lump.Stream, ref images, pnames); // Read ranges from configuration foreach(LumpRange range in textureranges) { // Go for all lumps between start and end exclusive for(int i = range.start + 1; i < range.end; i++) { // Lump not zero length? if(file.Lumps[i].Length > 0) { // Make the image SimpleTextureImage image = new SimpleTextureImage(file.Lumps[i].Name, file.Lumps[i].Name, defaultscale, defaultscale); // Add image to collection images.Add(image); } else { // Can't load image without size General.ErrorLogger.Add(ErrorType.Error, "Can't load texture '" + file.Lumps[i].Name + "' because it doesn't contain any data."); } } } // Load TEXTURES lump file int lumpindex = file.FindLumpIndex("TEXTURES"); while(lumpindex > -1) { MemoryStream filedata = new MemoryStream(file.Lumps[lumpindex].Stream.ReadAllBytes()); WADReader.LoadHighresTextures(filedata, "TEXTURES", ref images, null, null); filedata.Dispose(); // Find next lumpindex = file.FindLumpIndex("TEXTURES", lumpindex + 1); } // Add images to the container-specific texture set foreach(ImageData img in images) textureset.AddTexture(img); // Return result return images; } // This loads the texture definitions from a TEXTURES lump public static void LoadHighresTextures(Stream stream, string filename, ref List images, Dictionary textures, Dictionary flats) { // Parse the data TexturesParser parser = new TexturesParser(); parser.Parse(stream, filename); if(parser.HasError) parser.LogError(); //mxd // Make the textures foreach(TextureStructure t in parser.Textures) { // Add the texture ImageData img = t.MakeImage(); images.Add(img); } } // This loads a set of textures public static void LoadTextureSet(string sourcename, Stream texturedata, ref List images, PatchNames pnames) { BinaryReader reader = new BinaryReader(texturedata); int flags, width, height, patches, px, py, pi; uint numtextures; byte scalebytex, scalebytey; float scalex, scaley, defaultscale; byte[] namebytes; TextureImage image = null; bool strifedata; if(texturedata.Length == 0) return; // Determine default scale defaultscale = General.Map.Config.DefaultTextureScale; // Get number of textures texturedata.Seek(0, SeekOrigin.Begin); numtextures = reader.ReadUInt32(); // Skip offset bytes (we will read all textures sequentially) texturedata.Seek(4 * numtextures, SeekOrigin.Current); // Go for all textures defined in this lump for(uint i = 0; i < numtextures; i++) { // Read texture properties namebytes = reader.ReadBytes(8); flags = reader.ReadUInt16(); scalebytex = reader.ReadByte(); scalebytey = reader.ReadByte(); width = reader.ReadInt16(); height = reader.ReadInt16(); patches = reader.ReadInt16(); // Check for doom or strife data format if(patches == 0) { // Ignore 2 bytes and then read number of patches texturedata.Seek(2, SeekOrigin.Current); patches = reader.ReadInt16(); strifedata = false; } else { // Texture data is in strife format strifedata = true; } // Determine actual scales if(scalebytex == 0) scalex = defaultscale; else scalex = 1f / (scalebytex / 8f); if(scalebytey == 0) scaley = defaultscale; else scaley = 1f / (scalebytey / 8f); // Validate data if((width > 0) && (height > 0) && (patches > 0) && (scalex != 0) || (scaley != 0)) { string texname = Lump.MakeNormalName(namebytes, WAD.ENCODING); if(texname.Length > 0) { // Make the image object image = new TextureImage(sourcename, Lump.MakeNormalName(namebytes, WAD.ENCODING), width, height, scalex, scaley); } else { // Can't load image without name General.ErrorLogger.Add(ErrorType.Error, "Can't load an unnamed texture from \"" + sourcename + "\". Please consider giving names to your resources."); } // Go for all patches in texture for(int p = 0; p < patches; p++) { // Read patch properties px = reader.ReadInt16(); py = reader.ReadInt16(); pi = reader.ReadUInt16(); if(!strifedata) texturedata.Seek(4, SeekOrigin.Current); // Validate data if((pi >= 0) && (pi < pnames.Length)) { if(pnames[pi].Length > 0) { // Create patch on image if(image != null) image.AddPatch(new TexturePatch(pnames[pi], px, py)); } else { // Can't load image without name General.ErrorLogger.Add(ErrorType.Error, "Can't use an unnamed patch referenced in \"" + sourcename + "\". Please consider giving names to your resources."); } } } // Add image to collection images.Add(image); } else { // Skip patches data texturedata.Seek(6 * patches, SeekOrigin.Current); if(!strifedata) texturedata.Seek(4 * patches, SeekOrigin.Current); } } } // This returns the patch names from the PNAMES lump public override PatchNames LoadPatchNames() { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); // Look for a lump named PNAMES Lump lump = file.FindLump("PNAMES"); if(lump != null) return new PatchNames(lump.Stream); // Read the PNAMES from stream return null; // No patch names found } // This finds and returns a patch stream public override Stream GetPatchData(string pname, bool longname) { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); if(longname) return null; //mxd Lump lump; // mxd. First strictly read patches between P_START and P_END foreach(LumpRange range in patchranges) { lump = file.FindLump(pname, range.start, range.end); if(lump != null) return lump.Stream; } if (!strictpatches) { //mxd. Find the lump anywhere EXCEPT flat ranges (the way it's done in ZDoom) foreach (LumpRange range in invertedflatranges) { lump = file.FindLump(pname, range.start, range.end); if(lump != null) return lump.Stream; } // Find the lump anywhere IN flat ranges foreach (LumpRange range in flatranges) { lump = file.FindLump(pname, range.start, range.end); if(lump != null) return lump.Stream; } } return null; } // This finds and returns a texture stream public override Stream GetTextureData(string pname, bool longname) { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); if(longname) return null; //mxd Lump lump; // Find the lump in ranges foreach(LumpRange range in textureranges) { lump = file.FindLump(pname, range.start, range.end); if(lump != null) return lump.Stream; } return null; } #endregion #region ================== Flats //mxd. This loads the flats public override ICollection LoadFlats() { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); List images = new List(); FlatImage image; foreach(LumpRange range in flatranges) { if(range.end < range.start + 2) continue; for(int i = range.start + 1; i < range.end; i++) { // Lump not zero-length? if(file.Lumps[i].Length > 0) { // Make the image object image = new FlatImage(file.Lumps[i].Name); // Add image to collection images.Add(image); } } } // Load TEXTURES lump file int lumpindex = file.FindLumpIndex("TEXTURES"); while(lumpindex > -1) { MemoryStream filedata = new MemoryStream(file.Lumps[lumpindex].Stream.ReadAllBytes()); WADReader.LoadHighresFlats(filedata, "TEXTURES", ref images, null, null); filedata.Dispose(); // Find next lumpindex = file.FindLumpIndex("TEXTURES", lumpindex + 1); } // Add images to the container-specific texture set foreach(ImageData img in images) textureset.AddFlat(img); // Return result return images; } // This loads the flat definitions from a TEXTURES lump public static void LoadHighresFlats(Stream stream, string filename, ref List images, Dictionary textures, Dictionary flats) { // Parse the data TexturesParser parser = new TexturesParser(); parser.Parse(stream, filename); if(parser.HasError) parser.LogError(); //mxd // Make the textures foreach(TextureStructure t in parser.Flats) { // Add the texture ImageData img = t.MakeImage(); images.Add(img); } } // This finds and returns a patch stream public override Stream GetFlatData(string pname, bool longname) { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); if(longname) return null; //mxd Lump lump; // Find the lump in ranges foreach(LumpRange range in flatranges) { lump = file.FindLump(pname, range.start, range.end); if(lump != null) return lump.Stream; } return null; } #endregion #region ================== Sprite // This loads the textures public override ICollection LoadSprites() { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); List images = new List(); // Load TEXTURES lump file int lumpindex = file.FindLumpIndex("TEXTURES"); while(lumpindex > -1) { MemoryStream filedata = new MemoryStream(file.Lumps[lumpindex].Stream.ReadAllBytes()); WADReader.LoadHighresSprites(filedata, "TEXTURES", ref images, null, null); filedata.Dispose(); // Find next lumpindex = file.FindLumpIndex("TEXTURES", lumpindex + 1); } // Return result return images; } // This loads the sprites definitions from a TEXTURES lump public static void LoadHighresSprites(Stream stream, string filename, ref List images, Dictionary textures, Dictionary flats) { // Parse the data TexturesParser parser = new TexturesParser(); parser.Parse(stream, filename); if(parser.HasError) parser.LogError(); //mxd // Make the textures foreach(TextureStructure t in parser.Sprites) { // Add the sprite ImageData img = t.MakeImage(); images.Add(img); } } // This finds and returns a sprite stream public override Stream GetSpriteData(string pname) { Lump lump; // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); // Find the lump in ranges foreach(LumpRange range in spriteranges) { lump = file.FindLump(pname, range.start, range.end); if(lump != null) return lump.Stream; } return null; } // This checks if the given sprite exists public override bool GetSpriteExists(string pname) { Lump lump; // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); // Find the lump in ranges foreach(LumpRange range in spriteranges) { lump = file.FindLump(pname, range.start, range.end); if(lump != null) return true; } return false; } #endregion #region ================== Voxels (mxd) //mxd. This returns the list of voxels, which can be used without VOXELDEF definition public override string[] GetVoxelNames() { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); List voxels = new List(); Regex spriteName = new Regex(SPRITE_NAME_PATTERN); foreach(LumpRange range in voxelranges) { if(range.start == range.end) continue; for(int i = range.start + 1; i < range.end; i++) { if(spriteName.IsMatch(file.Lumps[i].Name)) voxels.Add(file.Lumps[i].Name); } } return voxels.ToArray(); } //mxd public override KeyValuePair GetVoxeldefData() { Lump lump = file.FindLump("VOXELDEF"); if(lump != null) return new KeyValuePair("VOXELDEF", lump.Stream); return new KeyValuePair(); } //mxd. This finds and returns a voxel stream or null if no voxel was found public override Stream GetVoxelData(string name) { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); Lump lump; foreach(LumpRange range in voxelranges) { if(range.start == range.end) continue; lump = file.FindLump(name, range.start, range.end); if(lump != null) return lump.Stream; } return null; } #endregion #region ================== Decorate, Gldefs, Mapinfo, etc... // This finds and returns a sprite stream public override Dictionary GetDecorateData(string pname) { // Error when suspended if(issuspended) throw new Exception("Data reader is suspended"); Dictionary result = new Dictionary(); // Find all lumps named 'DECORATE' int lumpindex = file.FindLumpIndex(pname); while(lumpindex > -1) { //mxd. Since we are using Dictionary, all names should be unique result.Add(Path.Combine(file.Filename, pname + "#" + lumpindex), file.Lumps[lumpindex].Stream); // Find next lumpindex = file.FindLumpIndex(pname, lumpindex + 1); } return result; } //mxd public override Dictionary GetMapinfoData() { if (issuspended) throw new Exception("Data reader is suspended"); Dictionary streams = new Dictionary(StringComparer.Ordinal); string src = "ZMAPINFO"; //should be only one entry per wad //first look for ZMAPINFO int lumpindex = file.FindLumpIndex(src); //then for MAPINFO if (lumpindex == -1) { src = "MAPINFO"; lumpindex = file.FindLumpIndex(src); } if(lumpindex != -1) streams.Add(src, file.Lumps[lumpindex].Stream); return streams; } //mxd public override Dictionary GetGldefsData(GameType gameType) { if (issuspended) throw new Exception("Data reader is suspended"); Dictionary streams = new Dictionary(StringComparer.Ordinal); int lumpindex; //try to load game specific GLDEFS first if (gameType != GameType.UNKNOWN) { string lumpName = Gldefs.GLDEFS_LUMPS_PER_GAME[(int)gameType]; lumpindex = file.FindLumpIndex(lumpName); if (lumpindex != -1) streams.Add(lumpName, file.Lumps[lumpindex].Stream); } //should be only one entry per wad lumpindex = file.FindLumpIndex("GLDEFS"); if (lumpindex != -1) streams.Add("GLDEFS", file.Lumps[lumpindex].Stream); return streams; } //mxd public override Dictionary GetModeldefData() { if(issuspended) throw new Exception("Data reader is suspended"); Dictionary streams = new Dictionary(StringComparer.Ordinal); int lumpindex = file.FindLumpIndex("MODELDEF"); if(lumpindex != -1) streams.Add("MODELDEF", file.Lumps[lumpindex].Stream); return streams; } //mxd public override Dictionary GetReverbsData() { if(issuspended) throw new Exception("Data reader is suspended"); Dictionary result = new Dictionary(); Lump lump = file.FindLump("REVERBS"); if(lump != null) result.Add(Path.Combine(location.location, "REVERBS"), lump.Stream); return result; } //mxd public override List GetSndSeqData() { if(issuspended) throw new Exception("Data reader is suspended"); List result = new List(); Lump lump = file.FindLump("SNDSEQ"); if(lump != null) result.Add(lump.Stream); return result; } //mxd internal override MemoryStream LoadFile(string name) { Lump l = file.FindLump(name); if (l != null) { l.Stream.Seek(0, SeekOrigin.Begin); return new MemoryStream(l.Stream.ReadAllBytes()); } return null; } //mxd internal override bool FileExists(string name) { return file.FindLumpIndex(name) != -1; } #endregion } }