using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using static BinaryObjectScanner.Models.BSP.Constants;
namespace BinaryObjectScanner.Wrappers
{
public class BSP : WrapperBase
{
#region Descriptive Properties
///
public override string Description => "Half-Life Level (BSP)";
#endregion
#region Pass-Through Properties
#region Header
///
public uint Version => _file.Header.Version;
#endregion
#region Lumps
///
public BinaryObjectScanner.Models.BSP.Lump[] Lumps => _file.Lumps;
#endregion
#region Texture Header
///
public uint TextureCount => _file.TextureHeader.TextureCount;
///
public uint[] Offsets => _file.TextureHeader.Offsets;
#endregion
#region Textures
///
public BinaryObjectScanner.Models.BSP.Texture[] Textures => _file.Textures;
#endregion
#endregion
#region Instance Variables
///
/// Internal representation of the BSP
///
private BinaryObjectScanner.Models.BSP.File _file;
#endregion
#region Constructors
///
/// Private constructor
///
private BSP() { }
///
/// Create a BSP from a byte array and offset
///
/// Byte array representing the BSP
/// Offset within the array to parse
/// A BSP wrapper on success, null on failure
public static BSP Create(byte[] data, int offset)
{
// If the data is invalid
if (data == null)
return null;
// If the offset is out of bounds
if (offset < 0 || offset >= data.Length)
return null;
// Create a memory stream and use that
MemoryStream dataStream = new MemoryStream(data, offset, data.Length - offset);
return Create(dataStream);
}
///
/// Create a BSP from a Stream
///
/// Stream representing the BSP
/// An BSP wrapper on success, null on failure
public static BSP Create(Stream data)
{
// If the data is invalid
if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead)
return null;
var file = Builders.BSP.ParseFile(data);
if (file == null)
return null;
var wrapper = new BSP
{
_file = file,
_dataSource = DataSource.Stream,
_streamData = data,
};
return wrapper;
}
#endregion
#region Printing
///
public override StringBuilder PrettyPrint()
{
StringBuilder builder = new StringBuilder();
builder.AppendLine("BSP Information:");
builder.AppendLine("-------------------------");
builder.AppendLine();
PrintHeader(builder);
PrintLumps(builder);
PrintTextureHeader(builder);
PrintTextures(builder);
return builder;
}
///
/// Print header information
///
/// StringBuilder to append information to
private void PrintHeader(StringBuilder builder)
{
builder.AppendLine(" Header Information:");
builder.AppendLine(" -------------------------");
builder.AppendLine($" Version: {Version} (0x{Version:X})");
builder.AppendLine();
}
///
/// Print lumps information
///
/// StringBuilder to append information to
private void PrintLumps(StringBuilder builder)
{
builder.AppendLine(" Lumps Information:");
builder.AppendLine(" -------------------------");
if (Lumps == null || Lumps.Length == 0)
{
builder.AppendLine(" No lumps");
}
else
{
for (int i = 0; i < Lumps.Length; i++)
{
var lump = Lumps[i];
string specialLumpName = string.Empty;
switch (i)
{
case HL_BSP_LUMP_ENTITIES:
specialLumpName = " (entities)";
break;
case HL_BSP_LUMP_TEXTUREDATA:
specialLumpName = " (texture data)";
break;
}
builder.AppendLine($" Lump {i}{specialLumpName}");
builder.AppendLine($" Offset: {lump.Offset} (0x{lump.Offset:X})");
builder.AppendLine($" Length: {lump.Length} (0x{lump.Length:X})");
}
}
builder.AppendLine();
}
///
/// Print texture header information
///
/// StringBuilder to append information to
private void PrintTextureHeader(StringBuilder builder)
{
builder.AppendLine(" Texture Header Information:");
builder.AppendLine(" -------------------------");
builder.AppendLine($" Texture count: {TextureCount}");
builder.AppendLine($" Offsets:");
for (int i = 0; i < Offsets.Length; i++)
{
builder.AppendLine($" Offset {i}: {Offsets[i]} (0x{Offsets[i]:X})");
}
builder.AppendLine();
}
///
/// Print textures information
///
/// StringBuilder to append information to
private void PrintTextures(StringBuilder builder)
{
builder.AppendLine(" Textures Information:");
builder.AppendLine(" -------------------------");
if (Textures == null || Textures.Length == 0)
{
builder.AppendLine(" No textures");
}
else
{
for (int i = 0; i < Textures.Length; i++)
{
var texture = Textures[i];
builder.AppendLine($" Texture {i}");
builder.AppendLine($" Name: {texture.Name}");
builder.AppendLine($" Width: {texture.Width} (0x{texture.Width:X})");
builder.AppendLine($" Height: {texture.Height} (0x{texture.Height:X})");
builder.AppendLine($" Offsets:");
for (int j = 0; j < texture.Offsets.Length; j++)
{
builder.AppendLine($" Offset {j}: {Offsets[i]} (0x{texture.Offsets[j]:X})");
}
// Skip texture data
builder.AppendLine($" Palette size: {texture.PaletteSize} (0x{texture.PaletteSize:X})");
// Skip palette data
}
}
builder.AppendLine();
}
#if NET6_0_OR_GREATER
///
public override string ExportJSON() => System.Text.Json.JsonSerializer.Serialize(_file, _jsonSerializerOptions);
#endif
#endregion
#region Extraction
///
/// Extract all lumps from the BSP to an output directory
///
/// Output directory to write to
/// True if all lumps extracted, false otherwise
public bool ExtractAllLumps(string outputDirectory)
{
// If we have no lumps
if (Lumps == null || Lumps.Length == 0)
return false;
// Loop through and extract all lumps to the output
bool allExtracted = true;
for (int i = 0; i < Lumps.Length; i++)
{
allExtracted &= ExtractLump(i, outputDirectory);
}
return allExtracted;
}
///
/// Extract a lump from the BSP to an output directory by index
///
/// Lump index to extract
/// Output directory to write to
/// True if the lump extracted, false otherwise
public bool ExtractLump(int index, string outputDirectory)
{
// If we have no lumps
if (Lumps == null || Lumps.Length == 0)
return false;
// If the lumps index is invalid
if (index < 0 || index >= Lumps.Length)
return false;
// Get the lump
var lump = Lumps[index];
if (lump == null)
return false;
// Read the data
byte[] data = ReadFromDataSource((int)lump.Offset, (int)lump.Length);
if (data == null)
return false;
// Create the filename
string filename = $"lump_{index}.bin";
switch (index)
{
case HL_BSP_LUMP_ENTITIES:
filename = "entities.ent";
break;
case HL_BSP_LUMP_TEXTUREDATA:
filename = "texture_data.bin";
break;
}
// If we have an invalid output directory
if (string.IsNullOrWhiteSpace(outputDirectory))
return false;
// Create the full output path
filename = Path.Combine(outputDirectory, filename);
// Ensure the output directory is created
Directory.CreateDirectory(Path.GetDirectoryName(filename));
// Try to write the data
try
{
// Open the output file for writing
using (Stream fs = File.OpenWrite(filename))
{
fs.Write(data, 0, data.Length);
}
}
catch
{
return false;
}
return true;
}
///
/// Extract all textures from the BSP to an output directory
///
/// Output directory to write to
/// True if all textures extracted, false otherwise
public bool ExtractAllTextures(string outputDirectory)
{
// If we have no textures
if (Offsets == null || Offsets.Length == 0)
return false;
// Loop through and extract all lumps to the output
bool allExtracted = true;
for (int i = 0; i < Offsets.Length; i++)
{
allExtracted &= ExtractTexture(i, outputDirectory);
}
return allExtracted;
}
///
/// Extract a texture from the BSP to an output directory by index
///
/// Lump index to extract
/// Output directory to write to
/// True if the texture extracted, false otherwise
public bool ExtractTexture(int index, string outputDirectory)
{
// If we have no textures
if (Textures == null || Textures.Length == 0)
return false;
// If the texture index is invalid
if (index < 0 || index >= Textures.Length)
return false;
// Get the texture
var texture = Textures[index];
if (texture == null)
return false;
// Read the data
byte[] data = CreateTextureData(texture);
if (data == null)
return false;
// Create the filename
string filename = $"{texture.Name}.bmp";
// If we have an invalid output directory
if (string.IsNullOrWhiteSpace(outputDirectory))
return false;
// Create the full output path
filename = Path.Combine(outputDirectory, filename);
// Ensure the output directory is created
Directory.CreateDirectory(Path.GetDirectoryName(filename));
// Try to write the data
try
{
// Open the output file for writing
using (Stream fs = File.OpenWrite(filename))
{
fs.Write(data, 0, data.Length);
}
}
catch
{
return false;
}
return true;
}
///
/// Create a bitmap from the texture and palette data
///
/// Texture object to format
/// Byte array representing the texture as a bitmap
private static byte[] CreateTextureData(BinaryObjectScanner.Models.BSP.Texture texture)
{
// If there's no texture data
if (texture.TextureData == null || texture.TextureData.Length == 0)
return null;
// Create the bitmap file header
var fileHeader = new BinaryObjectScanner.Models.BMP.BITMAPFILEHEADER()
{
Type = ('M' << 8) | 'B',
Size = 14 + 40 + (texture.PaletteSize * 4) + (texture.Width * texture.Height),
OffBits = 14 + 40 + (texture.PaletteSize * 4),
};
// Create the bitmap info header
var infoHeader = new BinaryObjectScanner.Models.BMP.BITMAPINFOHEADER
{
Size = 40,
Width = (int)texture.Width,
Height = (int)texture.Height,
Planes = 1,
BitCount = 8,
SizeImage = 0,
ClrUsed = texture.PaletteSize,
ClrImportant = texture.PaletteSize,
};
// Reformat the palette data
byte[] paletteData = new byte[texture.PaletteSize * 4];
for (uint i = 0; i < texture.PaletteSize; i++)
{
paletteData[i * 4 + 0] = texture.PaletteData[i * 3 + 2];
paletteData[i * 4 + 1] = texture.PaletteData[i * 3 + 1];
paletteData[i * 4 + 2] = texture.PaletteData[i * 3 + 0];
paletteData[i * 4 + 3] = 0;
}
// Reformat the pixel data
byte[] pixelData = new byte[texture.Width * texture.Height];
for (uint i = 0; i < texture.Width; i++)
{
for (uint j = 0; j < texture.Height; j++)
{
pixelData[i + ((texture.Height - 1 - j) * texture.Width)] = texture.TextureData[i + j * texture.Width];
}
}
// Build the file data
List buffer = new List();
// Bitmap file header
buffer.AddRange(BitConverter.GetBytes(fileHeader.Type));
buffer.AddRange(BitConverter.GetBytes(fileHeader.Size));
buffer.AddRange(BitConverter.GetBytes(fileHeader.Reserved1));
buffer.AddRange(BitConverter.GetBytes(fileHeader.Reserved2));
buffer.AddRange(BitConverter.GetBytes(fileHeader.OffBits));
// Bitmap info header
buffer.AddRange(BitConverter.GetBytes(infoHeader.Size));
buffer.AddRange(BitConverter.GetBytes(infoHeader.Width));
buffer.AddRange(BitConverter.GetBytes(infoHeader.Height));
buffer.AddRange(BitConverter.GetBytes(infoHeader.Planes));
buffer.AddRange(BitConverter.GetBytes(infoHeader.BitCount));
buffer.AddRange(BitConverter.GetBytes(infoHeader.Compression));
buffer.AddRange(BitConverter.GetBytes(infoHeader.SizeImage));
buffer.AddRange(BitConverter.GetBytes(infoHeader.XPelsPerMeter));
buffer.AddRange(BitConverter.GetBytes(infoHeader.YPelsPerMeter));
buffer.AddRange(BitConverter.GetBytes(infoHeader.ClrUsed));
buffer.AddRange(BitConverter.GetBytes(infoHeader.ClrImportant));
// Palette data
buffer.AddRange(paletteData);
// Pixel data
buffer.AddRange(pixelData);
return buffer.ToArray();
}
#endregion
}
}