ericw-tools/qbsp/writebsp.cc

/*
    Copyright (C) 1996-1997  Id Software, Inc.
    Copyright (C) 1997       Greg Lewis

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    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.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

    See file, 'COPYING', for details.
*/
// writebsp.c

#include <qbsp/qbsp.hh>
#include <qbsp/wad.hh>

#include <vector>
#include <algorithm>
#include <cstdint>

static void AssertVanillaContentType(const contentflags_t &flags)
{
    if (!flags.is_valid(options.target_game, false)) {
        FError("Internal error: Tried to save invalid contents type {}", flags.to_string(options.target_game));
    }
}

static contentflags_t RemapContentsForExport(const contentflags_t &content)
{
    if (content.extended & CFLAGS_DETAIL_FENCE) {
        /*
         * This is for func_detail_wall.. we want to write a solid leaf that has faces,
         * because it may be possible to see inside (fence textures).
         *
         * Normally solid leafs are not written and just referenced as leaf 0.
         */
        return options.target_game->create_solid_contents();
    }

    return content;
}

/**
 * Returns the output plane number
 */
int ExportMapPlane(int planenum)
{
    qbsp_plane_t *plane = &map.planes.at(planenum);

    if (plane->outputplanenum != PLANENUM_LEAF)
        return plane->outputplanenum; // already output.

    const int newIndex = static_cast<int>(map.exported_planes.size());
    map.exported_planes.push_back({});

    dplane_t *dplane = &map.exported_planes.back();
    dplane->normal[0] = plane->normal[0];
    dplane->normal[1] = plane->normal[1];
    dplane->normal[2] = plane->normal[2];
    dplane->dist = plane->dist;
    dplane->type = plane->type;

    plane->outputplanenum = newIndex;
    return newIndex;
}

int ExportMapTexinfo(int texinfonum)
{
    mtexinfo_t *src = &map.mtexinfos.at(texinfonum);
    if (src->outputnum.has_value())
        return src->outputnum.value();

    // this will be the index of the exported texinfo in the BSP lump
    const int i = static_cast<int>(map.exported_texinfos.size());

    map.exported_texinfos.push_back({});
    gtexinfo_t *dest = &map.exported_texinfos.back();
    memset(dest, 0, sizeof(dest));

    dest->flags = src->flags;
    dest->miptex = src->miptex;
    for (int j = 0; j < 2; j++) {
        for (int k = 0; k < 4; k++) {
            dest->vecs[j][k] = src->vecs[j][k];
        }
    }

    strcpy(dest->texture, map.texinfoTextureName(texinfonum).c_str());
    // dest->flags = map.miptex[src->miptex].flags;
    dest->value = map.miptex[src->miptex].value;

    src->outputnum = i;
    return i;
}

//===========================================================================

/*
==================
ExportClipNodes
==================
*/
static int ExportClipNodes(mapentity_t *entity, node_t *node)
{
    bsp2_dclipnode_t *clipnode;
    face_t *face, *next;

    // FIXME: free more stuff?
    if (node->planenum == PLANENUM_LEAF) {
        int contents = node->contents.native;
        delete node;
        return contents;
    }

    /* emit a clipnode */
    const int nodenum = static_cast<int>(map.exported_clipnodes.size());
    map.exported_clipnodes.push_back({});

    const int child0 = ExportClipNodes(entity, node->children[0]);
    const int child1 = ExportClipNodes(entity, node->children[1]);

    // Careful not to modify the vector while using this clipnode pointer
    clipnode = &map.exported_clipnodes.at(nodenum);
    clipnode->planenum = ExportMapPlane(node->planenum);
    clipnode->children[0] = child0;
    clipnode->children[1] = child1;

    for (face = node->faces; face; face = next) {
        next = face->next;
        delete face;
    }

    delete node;
    return nodenum;
}

/*
==================
ExportClipNodes

Called after the clipping hull is completed.  Generates a disk format
representation and frees the original memory.

This gets real ugly.  Gets called twice per entity, once for each clip hull.
First time just store away data, second time fix up reference points to
accomodate new data interleaved with old.
==================
*/
void ExportClipNodes(mapentity_t *entity, node_t *nodes, const int hullnum)
{
    auto *model = &map.exported_models.at(static_cast<size_t>(entity->outputmodelnumber));

    model->headnode[hullnum] = ExportClipNodes(entity, nodes);
}

//===========================================================================

/*
==================
ExportLeaf
==================
*/
static void ExportLeaf(mapentity_t *entity, node_t *node)
{
    map.exported_leafs.push_back({});
    mleaf_t *dleaf = &map.exported_leafs.back();

    const contentflags_t remapped = RemapContentsForExport(node->contents);
    AssertVanillaContentType(remapped);
    dleaf->contents = remapped.native;

    /*
     * write bounding box info
     */
    for (int32_t i = 0; i < 3; ++i) {
        dleaf->mins[i] = floor(node->mins[i]);
        dleaf->maxs[i] = ceil(node->maxs[i]);
    }

    dleaf->visofs = -1; // no vis info yet

    // write the marksurfaces
    dleaf->firstmarksurface = static_cast<int>(map.exported_marksurfaces.size());

    for (face_t **markfaces = node->markfaces; *markfaces; markfaces++) {
        face_t *face = *markfaces;
        if (map.mtexinfos.at(face->texinfo).flags.extended & TEX_EXFLAG_SKIP)
            continue;

        /* emit a marksurface */
        do {
            map.exported_marksurfaces.push_back(face->outputnumber);
            face = face->original; /* grab tjunction split faces */
        } while (face);
    }
    dleaf->nummarksurfaces = static_cast<int>(map.exported_marksurfaces.size()) - dleaf->firstmarksurface;

    // FIXME-Q2: fill in other things
    dleaf->area = 1;
    dleaf->cluster = node->viscluster;
    dleaf->firstleafbrush = node->firstleafbrush;
    dleaf->numleafbrushes = node->numleafbrushes;
}

/*
==================
ExportDrawNodes
==================
*/
static void ExportDrawNodes(mapentity_t *entity, node_t *node)
{
    bsp2_dnode_t *dnode;
    int i;

    const size_t ourNodeIndex = map.exported_nodes.size();
    map.exported_nodes.push_back({});

    dnode = &map.exported_nodes[ourNodeIndex];

    // VectorCopy doesn't work since dest are shorts
    for (int32_t i = 0; i < 3; ++i) {
        dnode->mins[i] = floor(node->mins[i]);
        dnode->maxs[i] = ceil(node->maxs[i]);
    }

    dnode->planenum = ExportMapPlane(node->planenum);
    dnode->firstface = node->firstface;
    dnode->numfaces = node->numfaces;

    // recursively output the other nodes
    for (i = 0; i < 2; i++) {
        if (node->children[i]->planenum == PLANENUM_LEAF) {
            // In Q2, all leaves must have their own ID even if they share solidity.
            // (probably for collision purposes? makes sense given they store leafbrushes)
            if (options.target_game->id != GAME_QUAKE_II && node->children[i]->contents.is_solid(options.target_game))
                dnode->children[i] = -1;
            else {
                int nextLeafIndex = static_cast<int>(map.exported_leafs.size());
                const int childnum = -(nextLeafIndex + 1);
                dnode->children[i] = childnum;
                ExportLeaf(entity, node->children[i]);
            }
        } else {
            const int childnum = static_cast<int>(map.exported_nodes.size());
            dnode->children[i] = childnum;
            ExportDrawNodes(entity, node->children[i]);

            // Important: our dnode pointer may be invalid after the recursive call, if the vector got resized.
            // So re-set the pointer.
            dnode = &map.exported_nodes[ourNodeIndex];
        }
    }

    // DarkPlaces asserts that the leaf numbers are different
    // if mod_bsp_portalize is 1 (default)
    // The most likely way it could fail is if both sides are the
    // shared CONTENTS_SOLID leaf (-1)
    Q_assert(!(dnode->children[0] == -1 && dnode->children[1] == -1));
    Q_assert(dnode->children[0] != dnode->children[1]);
}

/*
==================
ExportDrawNodes
==================
*/
void ExportDrawNodes(mapentity_t *entity, node_t *headnode, int firstface)
{
    int i;
    dmodelh2_t *dmodel;

    // populate model struct (which was emitted previously)
    dmodel = &map.exported_models.at(static_cast<size_t>(entity->outputmodelnumber));
    dmodel->headnode[0] = static_cast<int>(map.exported_nodes.size());
    dmodel->firstface = firstface;
    dmodel->numfaces = static_cast<int>(map.exported_faces.size()) - firstface;

    const size_t mapleafsAtStart = map.exported_leafs.size();

    if (headnode->planenum == PLANENUM_LEAF)
        ExportLeaf(entity, headnode);
    else
        ExportDrawNodes(entity, headnode);

    // count how many leafs were exported by the above calls
    dmodel->visleafs = static_cast<int>(map.exported_leafs.size() - mapleafsAtStart);

    /* remove the headnode padding */
    for (i = 0; i < 3; i++) {
        dmodel->mins[i] = headnode->mins[i] + SIDESPACE + 1;
        dmodel->maxs[i] = headnode->maxs[i] - SIDESPACE - 1;
    }
}

//=============================================================================

/*
==================
BeginBSPFile
==================
*/
void BeginBSPFile(void)
{
    // First edge must remain unused because 0 can't be negated
    map.exported_edges.push_back({});
    Q_assert(map.exported_edges.size() == 1);

    // Leave room for leaf 0 (must be solid)
    map.exported_leafs.push_back({});
    map.exported_leafs.back().contents = options.target_game->create_solid_contents().native;
    Q_assert(map.exported_leafs.size() == 1);
}

/*
 * Writes extended texinfo flags to a file so they can be read by the light tool.
 * Used for phong shading and other lighting settings on func_detail.
 */
static void WriteExtendedTexinfoFlags(void)
{
    bool needwrite = false;
    const int num_texinfo = map.numtexinfo();

    for (int i = 0; i < num_texinfo; i++) {
        if (map.mtexinfos.at(i).flags.needs_write()) {
            // this texinfo uses some extended flags, write them to a file
            needwrite = true;
            break;
        }
    }

    if (!needwrite)
        return;

    // sort by output texinfo number
    std::vector<mtexinfo_t> texinfos_sorted(map.mtexinfos);
    std::sort(texinfos_sorted.begin(), texinfos_sorted.end(),
        [](const mtexinfo_t &a, const mtexinfo_t &b) { return a.outputnum < b.outputnum; });

    options.szBSPName.replace_extension("texinfo");

    qfile_t texinfofile = SafeOpenWrite(options.szBSPName);

    if (!texinfofile)
        FError("Failed to open {}: {}", options.szBSPName, strerror(errno));

    extended_flags_header_t header;
    header.num_texinfo = map.exported_texinfos.size();
    header.surfflags_size = sizeof(surfflags_t);

    SafeWrite(texinfofile, &header, sizeof(header));

    int count = 0;
    for (const auto &tx : texinfos_sorted) {
        if (!tx.outputnum.has_value())
            continue;

        Q_assert(count == tx.outputnum.value()); // check we are outputting them in the proper sequence

        SafeWrite(texinfofile, &tx.flags, sizeof(tx.flags));
        count++;
    }
    Q_assert(count == static_cast<int>(map.exported_texinfos.size()));
}

template<class C>
static void CopyVector(const std::vector<C> &vec, int *elementCountOut, C **arrayCopyOut)
{
    C *data = new C[vec.size()];
    memcpy(data, vec.data(), sizeof(C) * vec.size());

    *elementCountOut = vec.size();
    *arrayCopyOut = (C *)data;
}

static void CopyString(const std::string &string, bool addNullTermination, int *elementCountOut, void **arrayCopyOut)
{
    const size_t numBytes = addNullTermination ? string.size() + 1 : string.size();
    void *data = new uint8_t[numBytes];
    memcpy(data, string.data(), numBytes); // std::string::data() has null termination, so it's safe to copy it

    *elementCountOut = numBytes;
    *arrayCopyOut = data;
}

/*
=============
WriteBSPFile
=============
*/
static void WriteBSPFile()
{
    bspdata_t bspdata { };
    mbsp_t &bsp = bspdata.bsp.emplace<mbsp_t>();

    bspdata.version = &bspver_generic;

    CopyVector(map.exported_planes, &bsp.numplanes, &bsp.dplanes);
    CopyVector(map.exported_leafs, &bsp.numleafs, &bsp.dleafs);
    CopyVector(map.exported_vertexes, &bsp.numvertexes, &bsp.dvertexes);
    CopyVector(map.exported_nodes, &bsp.numnodes, &bsp.dnodes);
    CopyVector(map.exported_texinfos, &bsp.numtexinfo, &bsp.texinfo);
    CopyVector(map.exported_faces, &bsp.numfaces, &bsp.dfaces);
    CopyVector(map.exported_clipnodes, &bsp.numclipnodes, &bsp.dclipnodes);
    CopyVector(map.exported_marksurfaces, &bsp.numleaffaces, &bsp.dleaffaces);
    CopyVector(map.exported_surfedges, &bsp.numsurfedges, &bsp.dsurfedges);
    CopyVector(map.exported_edges, &bsp.numedges, &bsp.dedges);
    CopyVector(map.exported_models, &bsp.nummodels, &bsp.dmodels);
    CopyVector(map.exported_leafbrushes, &bsp.numleafbrushes, &bsp.dleafbrushes);
    CopyVector(map.exported_brushsides, &bsp.numbrushsides, &bsp.dbrushsides);
    CopyVector(map.exported_brushes, &bsp.numbrushes, &bsp.dbrushes);

    CopyString(map.exported_entities, true, &bsp.entdatasize, (void **)&bsp.dentdata);
    CopyString(map.exported_texdata, false, &bsp.texdatasize, (void **)&bsp.dtexdata);

    if (map.needslmshifts) {
        BSPX_AddLump(&bspdata, "LMSHIFT", map.exported_lmshifts.data(), map.exported_lmshifts.size());
    }
    if (!map.exported_bspxbrushes.empty()) {
        BSPX_AddLump(&bspdata, "BRUSHLIST", map.exported_bspxbrushes.data(), map.exported_bspxbrushes.size());
    }

    // FIXME: temp
    bsp.numareaportals = 1;
    bsp.dareaportals = new dareaportal_t[bsp.numareaportals] { };

    bsp.numareas = 2;
    bsp.dareas = new darea_t[bsp.numareas] { };
    bsp.dareas[1].firstareaportal = 1;
    if (!ConvertBSPFormat(&bspdata, options.target_version)) {
        const bspversion_t *highLimitsFormat = nullptr;

        if (options.target_version == &bspver_q1) {
            highLimitsFormat = &bspver_bsp2;
        } else if (options.target_version == &bspver_h2) {
            highLimitsFormat = &bspver_h2bsp2;
        } else if (options.target_version == &bspver_q2) {
            highLimitsFormat = &bspver_qbism;
        } else {
            FError("No high limits version of {} available", options.target_version->name);
        }

        LogPrint(
            "NOTE: limits exceeded for {} - switching to {}\n", options.target_version->name, highLimitsFormat->name);

        Q_assert(ConvertBSPFormat(&bspdata, highLimitsFormat));
    }

    options.szBSPName.replace_extension("bsp");

    WriteBSPFile(options.szBSPName, &bspdata);
    LogPrint("Wrote {}\n", options.szBSPName);

    PrintBSPFileSizes(&bspdata);
}

/*
==================
FinishBSPFile
==================
*/
void FinishBSPFile(void)
{
    options.fVerbose = true;
    LogPrint(LOG_PROGRESS, "---- {} ----\n", __func__);

    WriteExtendedTexinfoFlags();
    WriteBSPFile();

    options.fVerbose = options.fAllverbose;
}

/*
==================
UpdateBSPFileEntitiesLump
==================
*/
void UpdateBSPFileEntitiesLump()
{
    bspdata_t bspdata;

    options.szBSPName.replace_extension("bsp");

    // load the .bsp
    LoadBSPFile(options.szBSPName, &bspdata);
    ConvertBSPFormat(&bspdata, &bspver_generic);

    mbsp_t &bsp = std::get<mbsp_t>(bspdata.bsp);

    // replace the existing entities lump with map.exported_entities
    CopyString(map.exported_entities, true, &bsp.entdatasize, (void **)&bsp.dentdata);

    // write the .bsp back to disk
    ConvertBSPFormat(&bspdata, bspdata.loadversion);
    WriteBSPFile(options.szBSPName, &bspdata);

    LogPrint("Wrote {}\n", options.szBSPName);
}