BSP.h

Go to the documentation of this file.

#pragma once
 
#include <array>
#include <cstddef>
#include <optional>
#include <span>
#include <string>
#include <tuple>
#include <vector>
#include <unordered_map>
 
#include <sourcepp/parser/Binary.h>
 
#include "EntityLump.h"
#include "LumpData.h"
#include "PakLump.h"
 
namespace bsppp {
 
constexpr auto BSP_SIGNATURE = sourcepp::parser::binary::makeFourCC("VBSP");
constexpr auto BSP_CONSOLE_SIGNATURE = sourcepp::parser::binary::makeFourCC("PSBV");
 
enum class BSPLump : int32_t {
    UNKNOWN = -1,
    ENTITIES = 0,
    PLANES,
    TEXDATA,
    VERTEXES,
    VISIBILITY,
    NODES,
    TEXINFO,
    FACES,
    LIGHTING,
    OCCLUSION,
    LEAFS,
    FACEIDS,
    EDGES,
    SURFEDGES,
    MODELS,
    WORLDLIGHTS,
    LEAFFACES,
    LEAFBRUSHES,
    BRUSHES,
    BRUSHSIDES,
    AREAS,
    AREAPORTALS,
    S2004_PORTALS,
    UNUSED0 = S2004_PORTALS,
    SL4D2_PROPCOLLISION = S2004_PORTALS,
    S2004_CLUSTERS,
    UNUSED1 = S2004_CLUSTERS,
    SL4D2_PROPHULLS = S2004_CLUSTERS,
    S2004_PORTALVERTS,
    UNUSED2 = S2004_PORTALVERTS,
    SL4D2_PROPHULLVERTS = S2004_PORTALVERTS,
    S2004_CLUSTERPORTALS,
    UNUSED3 = S2004_CLUSTERPORTALS,
    SL4D2_PROPTRIS = S2004_CLUSTERPORTALS,
    DISPINFO,
    ORIGINALFACES,
    PHYSDISP,
    PHYSCOLLIDE,
    VERTNORMALS,
    VERTNORMALINDICES,
    S2004_DISP_LIGHTMAP_ALPHAS,
    UNUSED4 = S2004_DISP_LIGHTMAP_ALPHAS,
    DISP_VERTS,
    DISP_LIGHTMAP_SAMPLE_POSITIONS,
    GAME_LUMP,
    LEAFWATERDATA,
    PRIMITIVES,
    PRIMVERTS,
    PRIMINDICES,
    PAKFILE,
    CLIPPORTALVERTS,
    CUBEMAPS,
    TEXDATA_STRING_DATA,
    TEXDATA_STRING_TABLE,
    OVERLAYS,
    LEAFMINDISTTOWATER,
    FACE_MACRO_TEXTURE_INFO,
    DISP_TRIS,
    S2004_PHYSCOLLIDESURFACE,
    UNUSED5 = S2004_PHYSCOLLIDESURFACE,
    SL4D2_PROP_BLOB = S2004_PHYSCOLLIDESURFACE,
    WATEROVERLAYS,
    S2006_XBOX_LIGHTMAPPAGES,
    LEAF_AMBIENT_INDEX_HDR = S2006_XBOX_LIGHTMAPPAGES,
    S2006_XBOX_LIGHTMAPPAGEINFOS,
    LEAF_AMBIENT_INDEX = S2006_XBOX_LIGHTMAPPAGEINFOS,
    LIGHTING_HDR,
    WORLDLIGHTS_HDR,
    LEAF_AMBIENT_LIGHTING_HDR,
    LEAF_AMBIENT_LIGHTING,
    XBOX_XZIPPAKFILE,
    FACES_HDR,
    MAP_FLAGS,
    OVERLAY_FADES,
    L4D_OVERLAY_SYSTEM_LEVELS,
    UNUSED6 = L4D_OVERLAY_SYSTEM_LEVELS,
    L4D2_PHYSLEVEL,
    UNUSED7 = L4D2_PHYSLEVEL,
    ASW_DISP_MULTIBLEND,
    UNUSED8 = ASW_DISP_MULTIBLEND,
 
    COUNT,
};
constexpr int32_t BSP_LUMP_COUNT = 64;
static_assert(static_cast<std::underlying_type_t<BSPLump>>(BSPLump::COUNT) == BSP_LUMP_COUNT, "Incorrect lump count!");

constexpr std::array<uint32_t, 64> BSP_LUMP_ORDER{
    25, 24, 32, 49, 59,  6,  2, 43,
    44, 10, 17,  1, 18, 19, 14,  5,
    20, 21,  4,  0, 29, 26, 62,  3,
    12, 13,  7, 58, 33, 48, 63, 28,
    9,  8,  53, 37, 38, 39, 30, 31,
    56, 52, 51, 55, 16, 36, 45, 50,
    60, 61, 46, 42, 41, 54, 15, 34,
    47, 11, 22, 23, 27, 35, 40, 57,
};
 
class BSP {
    struct Lump {
        uint32_t offset;
        uint32_t length;
        uint32_t version;
        uint32_t uncompressedLength;
    };
 
    struct Header {
        uint32_t version;
        std::array<Lump, BSP_LUMP_COUNT> lumps;
        uint32_t mapRevision;
    };
 
public:
    explicit BSP(std::string path_, bool loadPatchFiles = true);
 
    explicit operator bool() const;
 
    static BSP create(std::string path, uint32_t version = 21, uint32_t mapRevision = 0);
 
    [[nodiscard]] uint32_t getVersion() const;
 
    void setVersion(uint32_t version);
 
    [[nodiscard]] uint32_t getMapRevision() const;
 
    void setMapRevision(uint32_t mapRevision);
 
    [[nodiscard]] bool isL4D2() const;
 
    void setL4D2(bool isL4D2);
 
    [[nodiscard]] bool isConsole() const;
 
    void setConsole(bool isConsole);
 
    [[nodiscard]] bool hasLump(BSPLump lumpIndex) const;
 
    [[nodiscard]] bool isLumpCompressed(BSPLump lumpIndex) const;
 
    [[nodiscard]] uint32_t getLumpVersion(BSPLump lumpIndex) const;
 
    [[nodiscard]] std::optional<std::vector<std::byte>> getLumpData(BSPLump lumpIndex, bool noDecompression = false) const;
 
    template<BSPLump Lump>
    [[nodiscard]] auto getLumpData() const {
        if constexpr (Lump == BSPLump::ENTITIES) {
            return this->parseEntities();
        } else if constexpr (Lump == BSPLump::PLANES) {
            return this->parsePlanes();
        } else if constexpr (Lump == BSPLump::TEXDATA) {
            return this->parseTextureData();
        } else if constexpr (Lump == BSPLump::VERTEXES) {
            return this->parseVertices();
        } else if constexpr (Lump == BSPLump::NODES) {
            return this->parseNodes();
        } else if constexpr (Lump == BSPLump::TEXINFO) {
            return this->parseTextureInfo();
        } else if constexpr (Lump == BSPLump::FACES) {
            return this->parseFaces();
        } else if constexpr (Lump == BSPLump::EDGES) {
            return this->parseEdges();
        } else if constexpr (Lump == BSPLump::SURFEDGES) {
            return this->parseSurfEdges();
        } else if constexpr (Lump == BSPLump::MODELS) {
            return this->parseBrushModels();
        } else if constexpr (Lump == BSPLump::ORIGINALFACES) {
            return this->parseOriginalFaces();
        } else if constexpr (Lump == BSPLump::GAME_LUMP) {
            return this->parseGameLumps(true);
        } else {
            return this->getLumpData(Lump);
        }
    }

    bool setLump(BSPLump lumpIndex, uint32_t version, std::span<const std::byte> data, uint8_t compressLevel = 0);
 
    bool setLump(uint32_t version, std::span<const BSPEntityKeyValues> data, uint8_t compressLevel = 0);
 
    [[nodiscard]] bool isGameLumpCompressed(BSPGameLump::Signature signature) const;
 
    [[nodiscard]] uint16_t getGameLumpVersion(BSPGameLump::Signature signature) const;
 
    [[nodiscard]] std::optional<std::vector<std::byte>> getGameLumpData(BSPGameLump::Signature signature) const;
 
    bool setGameLump(BSPGameLump::Signature signature, uint16_t version, std::span<const std::byte> data, uint8_t compressLevel = 0);

    void resetLump(BSPLump lumpIndex);

    void reset();
 
    void createLumpPatchFile(BSPLump lumpIndex) const;
 
    bool setLumpFromPatchFile(const std::string& lumpFilePath);
 
    bool bake(std::string_view outputPath = "");
 
protected:
    bool readHeader();
 
    [[nodiscard]] std::vector<BSPEntityKeyValues> parseEntities() const;
 
    [[nodiscard]] std::vector<BSPPlane> parsePlanes() const;
 
    [[nodiscard]] std::vector<BSPTextureData> parseTextureData() const;
 
    [[nodiscard]] std::vector<BSPVertex> parseVertices() const;
 
    [[nodiscard]] std::vector<BSPNode> parseNodes() const;
 
    [[nodiscard]] std::vector<BSPTextureInfo> parseTextureInfo() const;
 
    [[nodiscard]] std::vector<BSPFace> parseFaces() const;
 
    [[nodiscard]] std::vector<BSPEdge> parseEdges() const;
 
    [[nodiscard]] std::vector<BSPSurfEdge> parseSurfEdges() const;
 
    [[nodiscard]] std::vector<BSPBrushModel> parseBrushModels() const;
 
    [[nodiscard]] std::vector<BSPFace> parseOriginalFaces() const;
 
    [[nodiscard]] std::vector<BSPGameLump> parseGameLumps(bool decompress) const;
 
    std::string path;
    Header header{};
 
    uint32_t stagedVersion{};
    std::unordered_map<uint32_t, std::pair<Lump, std::vector<std::byte>>> stagedLumps;
    std::vector<BSPGameLump> stagedGameLumps;
    uint32_t stagedMapRevision{};
 
    // Slightly different header despite using the same version just to be quirky
    bool l4d2 = false;
    // BSP is mostly big-endian
    bool console = false;
};
 
} // namespace bsppp