load.h

/*****************************************************************************
 * VCLib                                                                     *
 * Visual Computing Library                                                  *
 *                                                                           *
 * Copyright(C) 2021-2025                                                    *
 * Visual Computing Lab                                                      *
 * ISTI - Italian National Research Council                                  *
 *                                                                           *
 * All rights reserved.                                                      *
 *                                                                           *
 * This program is free software; you can redistribute it and/or modify      *
 * it under the terms of the Mozilla Public License Version 2.0 as published *
 * by the Mozilla 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              *
 * Mozilla Public License Version 2.0                                        *
 * (https://www.mozilla.org/en-US/MPL/2.0/) for more details.                *
 ****************************************************************************/
 
#ifndef VCL_LOAD_SAVE_STL_LOAD_H
#define VCL_LOAD_SAVE_STL_LOAD_H
 
#include <vclib/io/read.h>
#include <vclib/load_save/settings.h>
#include <vclib/misc/logger.h>
#include <vclib/space/complex/mesh_info.h>
 
namespace vcl {
 
namespace detail {
 
inline bool isBinStlMalformed(
    const std::string& filename,
    bool&              isBinary,
    std::size_t&       fsize)
{
    fsize    = FileInfo::fileSize(filename);
    isBinary = FileInfo::isFileBinary(filename);
 
    if (isBinary) {
        // we can check if the size of the file is the expected one
        std::ifstream fp = openInputFileStream(filename);
        fp.seekg(80); // size of the header
        uint        fnum = io::readUInt<uint>(fp, std::endian::little);
        std::size_t expectedFileSize =
            80 + 4 +                     // header and number of faces
            fnum *                       // for each face
                (3 * sizeof(float) +     // 3 floats for the face normal
                 3 * 3 * sizeof(float) + // 3 floats for each vertex of the face
                 sizeof(unsigned short)); // a short containing attributes
        if (expectedFileSize != fsize) {
            // sometimes the size is a bit wrong
            std::size_t diff =
                std::abs((long int) expectedFileSize - (long int) fsize);
            if (diff > fsize / 20)
                return true;
        }
    }
 
    return false;
}
 
inline bool isStlColored(std::istream& fp, bool& magicsMode)
{
    bool colored = false;
 
    char buf[80];
    fp.read(buf, 80);
    std::string s(buf);
    size_t      cInd = s.rfind("COLOR=");
    size_t      mInd = s.rfind("MATERIAL=");
    if (cInd != std::string::npos && mInd != std::string::npos)
        magicsMode = true;
    else
        magicsMode = false;
    uint              fnum = io::readUInt<uint>(fp, std::endian::little);
    static const uint fmax = 1000;
    // 3 floats for normal and 9 for vcoords
    static const uint fdataSize = 12 * sizeof(float);
 
    for (uint i = 0; i < std::min(fnum, fmax); ++i) {
        fp.seekg(fdataSize, std::ios::cur);
        unsigned short attr =
            io::readShort<unsigned short>(fp, std::endian::little);
        Color c;
        c.setBgr5(attr);
        if (c != Color::White)
            colored = true;
    }
    return colored;
}
 
template<MeshConcept MeshType, LoggerConcept LogType>
void readStlBin(
    MeshType&           m,
    std::istream&       fp,
    MeshInfo&           loadedInfo,
    LogType&            log,
    const LoadSettings& settings)
{
    bool magicsMode, colored;
    colored = isStlColored(fp, magicsMode);
 
    if (settings.enableOptionalComponents) {
        if (colored)
            loadedInfo.setFaceColors();
        enableOptionalComponentsFromInfo(loadedInfo, m);
    }
    else if (colored) {
        if constexpr (HasPerFaceColor<MeshType>) {
            if (isPerFaceColorAvailable(m))
                loadedInfo.setFaceColors();
        }
    }
 
    fp.seekg(80); // size of the header
    uint fnum = io::readUInt<uint>(fp, std::endian::little);
    if (fnum > 0)
        loadedInfo.setTriangleMesh();
 
    log.startProgress("Loading STL file", fnum);
 
    m.addVertices(fnum * 3);
    if constexpr (HasFaces<MeshType>) {
        m.reserveFaces(fnum);
    }
 
    uint vi = 0;
    for (uint i = 0; i < fnum; ++i) {
        Point3f norm;
        norm.x() = io::readFloat<float>(fp, std::endian::little);
        norm.y() = io::readFloat<float>(fp, std::endian::little);
        norm.z() = io::readFloat<float>(fp, std::endian::little);
 
        for (uint j = 0; j < 3; ++j) {
            m.vertex(vi + j).coord().x() =
                io::readFloat<float>(fp, std::endian::little);
            m.vertex(vi + j).coord().y() =
                io::readFloat<float>(fp, std::endian::little);
            m.vertex(vi + j).coord().z() =
                io::readFloat<float>(fp, std::endian::little);
        }
 
        unsigned short attr =
            io::readShort<unsigned short>(fp, std::endian::little);
 
        if constexpr (HasFaces<MeshType>) {
            using FaceType = MeshType::FaceType;
 
            uint      fi = m.addFace();
            FaceType& f  = m.face(fi);
            // we have a polygonal mesh
            if constexpr (FaceType::VERTEX_NUMBER < 0) {
                // need to resize the face to the right number of verts
                f.resizeVertices(3);
            }
            for (uint j = 0; j < 3; ++j)
                f.setVertex(j, vi + j);
            if (HasPerFaceNormal<MeshType>) {
                using ST = FaceType::NormalType::ScalarType;
                if (isPerFaceNormalAvailable(m)) {
                    f.normal() = norm.cast<ST>();
                }
            }
            if (HasPerFaceColor<MeshType>) {
                if (isPerFaceColorAvailable(m) && colored) {
                    Color c;
                    if (magicsMode)
                        c.setBgr5(attr);
                    else
                        c.setRgb5(attr);
                    f.color() = c;
                }
            }
        }
 
        vi += 3;
 
        log.progress(i);
    }
    log.endProgress();
}
 
template<MeshConcept MeshType, LoggerConcept LogType>
void readStlAscii(
    MeshType&           m,
    std::istream&       fp,
    MeshInfo&           loadedInfo,
    LogType&            log,
    const LoadSettings& settings)
{
    if (settings.enableOptionalComponents) {
        enableOptionalComponentsFromInfo(loadedInfo, m);
    }
 
    fp.seekg(0, fp.end);
    std::size_t fsize = fp.tellg();
    fp.seekg(0, fp.beg);
    log.startProgress("Loading STL file", fsize);
 
    Tokenizer tokens = readAndTokenizeNextNonEmptyLineNoThrow(fp);
    if (fp) {
        // cycle that reads a face starting from the actual tokenized line
        do {
            Tokenizer::iterator token = tokens.begin();
            if (token != tokens.end() && *token == "facet") {
                ++token; // skip the "facet" word
                ++token; // skip the "normal" word
 
                // add 3 vertices for the face
                uint vi = m.addVertices(3);
 
                // read the normal of the face
                Point3f normal;
 
                normal.x() = io::readFloat<float>(token, std::endian::little);
                normal.y() = io::readFloat<float>(token, std::endian::little);
                normal.z() = io::readFloat<float>(token, std::endian::little);
 
                readAndTokenizeNextNonEmptyLine(fp); // outer loop
                // vertex x y z
                tokens = readAndTokenizeNextNonEmptyLine(fp);
 
                for (uint i = 0; i < 3; i++) { // read the three vertices
                    token = tokens.begin();
                    ++token; // skip the "vertex" word
 
                    m.vertex(vi + i).coord().x() =
                        io::readFloat<float>(token, std::endian::little);
                    m.vertex(vi + i).coord().y() =
                        io::readFloat<float>(token, std::endian::little);
                    m.vertex(vi + i).coord().z() =
                        io::readFloat<float>(token, std::endian::little);
 
                    // next vertex
                    tokens = readAndTokenizeNextNonEmptyLine(fp);
                }
                readAndTokenizeNextNonEmptyLine(fp); // endfacet
 
                if constexpr (HasFaces<MeshType>) {
                    using FaceType = MeshType::FaceType;
                    uint fi        = m.addFace();
 
                    FaceType& f = m.face(fi);
                    // we have a polygonal mesh
                    if constexpr (FaceType::VERTEX_NUMBER < 0) {
                        // need to resize the face to the right number of verts
                        f.resizeVertices(3);
                    }
                    for (uint j = 0; j < 3; ++j)
                        f.setVertex(j, vi + j);
                    if (HasPerFaceNormal<MeshType>) {
                        using ST = FaceType::NormalType::ScalarType;
                        if (isPerFaceNormalAvailable(m)) {
                            f.normal() = normal.cast<ST>();
                        }
                    }
                }
            }
            tokens = readAndTokenizeNextNonEmptyLineNoThrow(fp);
 
            log.progress(fp.tellg());
        } while (fp);
 
        if constexpr (HasFaces<MeshType>) {
            if (m.faceNumber() > 0)
                loadedInfo.setTriangleMesh();
        }
    }
 
    log.endProgress();
}
 
} // namespace detail
 
template<MeshConcept MeshType, LoggerConcept LogType = NullLogger>
void loadStl(
    MeshType&           m,
    std::istream&       inputStlStream,
    MeshInfo&           loadedInfo,
    bool                isBinary = false,
    LogType&            log      = nullLogger,
    const LoadSettings& settings = LoadSettings())
{
    loadedInfo.clear();
    loadedInfo.setVertices();
    loadedInfo.setVertexCoords();
 
    if constexpr (HasFaces<MeshType>) {
        loadedInfo.setFaces();
        loadedInfo.setFaceVRefs();
        loadedInfo.setFaceNormals();
    }
 
    log.log(0, "Loading STL file");
 
    if (isBinary)
        detail::readStlBin(m, inputStlStream, loadedInfo, log, settings);
    else
        detail::readStlAscii(m, inputStlStream, loadedInfo, log, settings);
 
    log.log(100, "STL file loaded");
}
 
template<MeshConcept MeshType, LoggerConcept LogType = NullLogger>
void loadStl(
    MeshType&           m,
    std::istream&       inputStlStream,
    bool                isBinary = false,
    LogType&            log      = nullLogger,
    const LoadSettings& settings = LoadSettings())
{
    MeshInfo loadedInfo;
    loadStl(m, inputStlStream, loadedInfo, isBinary, log, settings);
}
 
template<MeshConcept MeshType, LoggerConcept LogType = NullLogger>
MeshType loadStl(
    std::istream&       inputStlStream,
    MeshInfo&           loadedInfo,
    bool                isBinary = false,
    LogType&            log      = nullLogger,
    const LoadSettings& settings = LoadSettings())
{
    MeshType m;
    loadStl(m, inputStlStream, loadedInfo, isBinary, log, settings);
    return m;
}
 
template<MeshConcept MeshType, LoggerConcept LogType = NullLogger>
MeshType loadStl(
    std::istream&       inputStlStream,
    bool                isBinary = false,
    LogType&            log      = nullLogger,
    const LoadSettings& settings = LoadSettings())
{
    MeshInfo loadedInfo;
    return loadStl<MeshType>(
        inputStlStream, loadedInfo, isBinary, log, settings);
}
 
template<MeshConcept MeshType, LoggerConcept LogType = NullLogger>
void loadStl(
    MeshType&           m,
    const std::string&  filename,
    MeshInfo&           loadedInfo,
    LogType&            log      = nullLogger,
    const LoadSettings& settings = LoadSettings())
{
    log.log(0, "Checking STL file");
 
    bool        isBinary;
    std::size_t filesize;
    if (detail::isBinStlMalformed(filename, isBinary, filesize))
        throw MalformedFileException(filename + " is malformed.");
 
    log.log(0, "Opening STL file");
 
    std::ifstream fp = openInputFileStream(filename);
 
    if constexpr (HasName<MeshType>) {
        m.name() = FileInfo::fileNameWithoutExtension(filename);
    }
 
    loadStl(m, fp, loadedInfo, isBinary, log, settings);
}
 
template<MeshConcept MeshType, LoggerConcept LogType = NullLogger>
void loadStl(
    MeshType&           m,
    const std::string&  filename,
    LogType&            log      = nullLogger,
    const LoadSettings& settings = LoadSettings())
{
    MeshInfo loadedInfo;
    loadStl(m, filename, loadedInfo, log, settings);
}
 
template<MeshConcept MeshType, LoggerConcept LogType = NullLogger>
MeshType loadStl(
    const std::string&  filename,
    MeshInfo&           loadedInfo,
    LogType&            log      = nullLogger,
    const LoadSettings& settings = LoadSettings())
{
    MeshType m;
    loadStl(m, filename, loadedInfo, log, settings);
    return m;
}
 
template<MeshConcept MeshType, LoggerConcept LogType = NullLogger>
MeshType loadStl(
    const std::string&  filename,
    LogType&            log      = nullLogger,
    const LoadSettings& settings = LoadSettings())
{
    MeshInfo loadedInfo;
    return loadStl<MeshType>(filename, loadedInfo, log, settings);
}
 
} // namespace vcl
 
#endif // VCL_LOAD_SAVE_STL_LOAD_H