UltimateZoneBuilder/Source/Core/Data/WADReader.cs
MaxED bf2f520a8e Fixed a crash when opening Thing Filters form when non-UDMF map was loaded.
Fixed a possible crash when rendering thing arrows in classic modes caused by incorrect vertex buffer size calculation.
Reverted changes to texture\flat access when "mixtexturesflats" option is set to true in game configuration.
2013-12-03 10:50:33 +00:00

925 lines
25 KiB
C#

#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;
#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<LumpRange> flatranges;
private List<LumpRange> invertedflatranges; //mxd
private List<LumpRange> patchranges;
private List<LumpRange> spriteranges;
private List<LumpRange> textureranges;
private List<LumpRange> colormapranges;
#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<LumpRange>();
spriteranges = new List<LumpRange>();
flatranges = new List<LumpRange>();
textureranges = new List<LumpRange>();
colormapranges = new List<LumpRange>();
// 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");
//mxd
invertedflatranges = new List<LumpRange>();
if(flatranges.Count > 0 && flatranges[0].start > 0) {
LumpRange range = new LumpRange();
range.start = 0;
range.end = flatranges[0].start - 1;
invertedflatranges.Add(range);
}
for (int i = 0; i < flatranges.Count; i++) {
if (flatranges[i].start == 0) continue;
LumpRange range = new LumpRange();
if(i == flatranges.Count - 1) {
if (flatranges[i].end < file.Lumps.Count - 1) {
range.start = flatranges[i].end + 1;
range.end = file.Lumps.Count - 1;
invertedflatranges.Add(range);
}
} else {
range.start = flatranges[i - 1].end + 1;
range.end = flatranges[i].start - 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<LumpRange> ranges, IDictionary rangeinfos, string rangename)
{
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)
{
ranges.Add(range);
startindex = file.FindLumpIndex(rangestart, range.end);
}
else
{
startindex = -1;
}
}
}
}
}
#endregion
#region ================== Palette
// This loads the PLAYPAL palette
public override Playpal LoadPalette()
{
Lump lump;
// Error when suspended
if(issuspended) throw new Exception("Data reader is suspended");
// Look for a lump named PLAYPAL
lump = file.FindLump("PLAYPAL");
if(lump != null)
{
// Read the PLAYPAL from stream
return new Playpal(lump.Stream);
}
else
{
// No palette
return null;
}
}
#endregion
#region ================== Colormaps
// This loads the textures
public override ICollection<ImageData> LoadColormaps()
{
List<ImageData> images = new List<ImageData>();
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<ImageData> 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)
{
Lump lump;
// Error when suspended
if(issuspended) throw new Exception("Data reader is suspended");
// 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<ImageData> LoadTextures(PatchNames pnames)
{
List<ImageData> images = new List<ImageData>();
int lumpindex;
Lump lump;
// Error when suspended
if(issuspended) throw new Exception("Data reader is suspended");
// Load two sets of textures, if available
lump = file.FindLump("TEXTURE1");
if(lump != null) LoadTextureSet("TEXTURE1", lump.Stream, ref images, pnames);
lump = file.FindLump("TEXTURE2");
if(lump != null) LoadTextureSet("TEXTURE2", lump.Stream, ref images, pnames);
// Read ranges from configuration
foreach(LumpRange range in textureranges)
{
// Load texture range
LoadTexturesRange(range.start, range.end, ref images, pnames);
}
// Load TEXTURES lump file
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 a range of textures
private void LoadTexturesRange(int startindex, int endindex, ref List<ImageData> images, PatchNames pnames)
{
// Determine default scale
float defaultscale = General.Map.Config.DefaultTextureScale;
// 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
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 name
General.ErrorLogger.Add(ErrorType.Error, "Can't load an unnamed texture from lump index " + i + ". Please consider giving names to your resources.");
}
}
}
// This loads the texture definitions from a TEXTURES lump
public static void LoadHighresTextures(Stream stream, string filename, ref List<ImageData> images, Dictionary<long, ImageData> textures, Dictionary<long, ImageData> flats)
{
// Parse the data
TexturesParser parser = new TexturesParser();
parser.Parse(stream, filename);
// Make the textures
foreach(TextureStructure t in parser.Textures)
{
if(t.Name.Length > 0)
{
// Add the texture
ImageData img = t.MakeImage(textures, flats);
images.Add(img);
}
else
{
// Can't load image without name
General.ErrorLogger.Add(ErrorType.Error, "Can't load an unnamed texture from \"" + filename + "\". Please consider giving names to your resources.");
}
}
}
// This loads a set of textures
public static void LoadTextureSet(string sourcename, Stream texturedata, ref List<ImageData> 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(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()
{
Lump lump;
// Error when suspended
if(issuspended) throw new Exception("Data reader is suspended");
// Look for a lump named PNAMES
lump = file.FindLump("PNAMES");
if(lump != null)
{
// Read the PNAMES from stream
return new PatchNames(lump.Stream);
}
else
{
// No palette
return null;
}
}
// This finds and returns a patch stream
public override Stream GetPatchData(string pname)
{
Lump lump;
// Error when suspended
if(issuspended) throw new Exception("Data reader is suspended");
// 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)
{
Lump lump;
// Error when suspended
if(issuspended) throw new Exception("Data reader is suspended");
// 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
// This loads the textures
public override ICollection<ImageData> LoadFlats()
{
List<ImageData> images = new List<ImageData>();
string rangestart, rangeend;
int lumpindex;
// Error when suspended
if(issuspended) throw new Exception("Data reader is suspended");
// Read ranges from configuration
foreach(DictionaryEntry r in General.Map.Config.FlatRanges)
{
// Read start and end
rangestart = General.Map.Config.ReadSetting("flats." + r.Key + ".start", "");
rangeend = General.Map.Config.ReadSetting("flats." + r.Key + ".end", "");
if((rangestart.Length > 0) && (rangeend.Length > 0))
{
// Load texture range
LoadFlatsRange(rangestart, rangeend, ref images);
}
}
// Load TEXTURES lump file
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 a range of flats
private void LoadFlatsRange(string startlump, string endlump, ref List<ImageData> images)
{
int startindex, endindex;
FlatImage 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 FlatImage(file.Lumps[i].Name);
// Add image to collection
images.Add(image);
}
}
}
// Find the next start
startindex = file.FindLumpIndex(startlump, startindex + 1);
}
}
// This loads the flat definitions from a TEXTURES lump
public static void LoadHighresFlats(Stream stream, string filename, ref List<ImageData> images, Dictionary<long, ImageData> textures, Dictionary<long, ImageData> flats)
{
// Parse the data
TexturesParser parser = new TexturesParser();
parser.Parse(stream, filename);
// Make the textures
foreach(TextureStructure t in parser.Flats)
{
if(t.Name.Length > 0)
{
// Add the texture
ImageData img = t.MakeImage(textures, flats);
images.Add(img);
}
else
{
// Can't load image without name
General.ErrorLogger.Add(ErrorType.Error, "Can't load an unnamed flat from \"" + filename + "\". Please consider giving names to your resources.");
}
}
}
// This finds and returns a patch stream
public override Stream GetFlatData(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 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<ImageData> LoadSprites()
{
List<ImageData> images = new List<ImageData>();
//string rangestart, rangeend;
int lumpindex;
// Error when suspended
if(issuspended) throw new Exception("Data reader is suspended");
// Load TEXTURES lump file
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<ImageData> images, Dictionary<long, ImageData> textures, Dictionary<long, ImageData> flats)
{
// Parse the data
TexturesParser parser = new TexturesParser();
parser.Parse(stream, filename);
// Make the textures
foreach(TextureStructure t in parser.Sprites)
{
if(t.Name.Length > 0)
{
// Add the sprite
ImageData img = t.MakeImage(textures, flats);
images.Add(img);
}
else
{
// Can't load image without name
General.ErrorLogger.Add(ErrorType.Error, "Can't load an unnamed sprite from \"" + filename + "\". Please consider giving names to your resources.");
}
}
}
// 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 ================== Decorate, Gldefs, Mapinfo, etc...
// This finds and returns a sprite stream
public override List<Stream> GetDecorateData(string pname)
{
List<Stream> streams = new List<Stream>();
int lumpindex;
// Error when suspended
if(issuspended) throw new Exception("Data reader is suspended");
// Find all lumps named 'DECORATE'
lumpindex = file.FindLumpIndex(pname);
while(lumpindex > -1)
{
streams.Add(file.Lumps[lumpindex].Stream);
// Find next
lumpindex = file.FindLumpIndex(pname, lumpindex + 1);
}
return streams;
}
//mxd
public override Dictionary<string, Stream> GetMapinfoData() {
if (issuspended) throw new Exception("Data reader is suspended");
Dictionary<string, Stream> streams = new Dictionary<string, Stream>();
int lumpindex;
string src = "ZMAPINFO";
//should be only one entry per wad
//first look for ZMAPINFO
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<string, Stream> GetGldefsData(GameType gameType) {
if (issuspended) throw new Exception("Data reader is suspended");
Dictionary<string, Stream> streams = new Dictionary<string, Stream>();
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<string, Stream> GetGldefsData(string location) {
if (issuspended) throw new Exception("Data reader is suspended");
Dictionary<string, Stream> streams = new Dictionary<string, Stream>();
int lumpindex;
lumpindex = file.FindLumpIndex(location);
if (lumpindex != -1)
streams.Add(location, file.Lumps[lumpindex].Stream);
return streams;
}
//mxd
public override Dictionary<string, Stream> GetModeldefData() {
return GetGldefsData("MODELDEF");
}
//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
}
}