Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-05 14:05:27 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #263 from daleglass-overte/fix-gltf-crash

Browse source 
Fix crash with models from ReadyPlayerMe by adding extra validation.
This commit is contained in:
Dale Glass 2022-11-27 16:52:53 +01:00 committed by GitHub
commit 0ac80b4b87
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 356 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
libraries/hfm/src/hfm/HFM.h
View file

@ -342,6 +342,26 @@ public:
FlowData flowData;
void debugDump();
/**
* @brief Get the number of warnings that were generated when loading this model.
*
* These may indicate non-compliance with the spec, or usage of deprecated functionality.
* This function is intended to be used for testing.
*
* @return Count
*/
int loadWarningCount = 0;
/**
* @brief Get the number of errors that were generated when loading this model.
*
* Errors indicate the model is probably broken and unusable.
*
* @return Count
*/
int loadErrorCount = 0;
};
};

49
libraries/model-serializers/src/GLTFSerializer.cpp
View file

@ -1063,6 +1063,7 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
if (indicesAccessorIdx > _file.accessors.size()) {
qWarning(modelformat) << "Indices accessor index is out of bounds for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
@ -1091,6 +1092,7 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
if (!success) {
qWarning(modelformat) << "There was a problem reading glTF INDICES data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
@ -1106,6 +1108,7 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
if (accessorIdx > _file.accessors.size()) {
qWarning(modelformat) << "Accessor index is out of bounds for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
@ -1114,23 +1117,27 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
if (key == "POSITION") {
if (accessor.type != GLTFAccessorType::VEC3) {
qWarning(modelformat) << "Invalid accessor type on glTF POSITION data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
success = addArrayFromAccessor(accessor, vertices);
if (!success) {
qWarning(modelformat) << "There was a problem reading glTF POSITION data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
} else if (key == "NORMAL") {
if (accessor.type != GLTFAccessorType::VEC3) {
qWarning(modelformat) << "Invalid accessor type on glTF NORMAL data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
success = addArrayFromAccessor(accessor, normals);
if (!success) {
qWarning(modelformat) << "There was a problem reading glTF NORMAL data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
} else if (key == "TANGENT") {
@ -1140,12 +1147,14 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
tangentStride = 3;
} else {
qWarning(modelformat) << "Invalid accessor type on glTF TANGENT data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
success = addArrayFromAccessor(accessor, tangents);
if (!success) {
qWarning(modelformat) << "There was a problem reading glTF TANGENT data for model " << _url;
hfmModel.loadErrorCount++;
tangentStride = 0;
continue;
}
@ -1153,22 +1162,26 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
success = addArrayFromAccessor(accessor, texcoords);
if (!success) {
qWarning(modelformat) << "There was a problem reading glTF TEXCOORD_0 data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
if (accessor.type != GLTFAccessorType::VEC2) {
qWarning(modelformat) << "Invalid accessor type on glTF TEXCOORD_0 data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
} else if (key == "TEXCOORD_1") {
success = addArrayFromAccessor(accessor, texcoords2);
if (!success) {
qWarning(modelformat) << "There was a problem reading glTF TEXCOORD_1 data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
if (accessor.type != GLTFAccessorType::VEC2) {
qWarning(modelformat) << "Invalid accessor type on glTF TEXCOORD_1 data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
} else if (key == "COLOR_0") {
@ -1178,12 +1191,14 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
colorStride = 3;
} else {
qWarning(modelformat) << "Invalid accessor type on glTF COLOR_0 data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
success = addArrayFromAccessor(accessor, colors);
if (!success) {
qWarning(modelformat) << "There was a problem reading glTF COLOR_0 data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
} else if (key == "JOINTS_0") {
@ -1197,12 +1212,14 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
jointStride = 1;
} else {
qWarning(modelformat) << "Invalid accessor type on glTF JOINTS_0 data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
success = addArrayFromAccessor(accessor, joints);
if (!success) {
qWarning(modelformat) << "There was a problem reading glTF JOINTS_0 data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
} else if (key == "WEIGHTS_0") {
@ -1216,12 +1233,14 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
weightStride = 1;
} else {
qWarning(modelformat) << "Invalid accessor type on glTF WEIGHTS_0 data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
success = addArrayFromAccessor(accessor, weights);
if (!success) {
qWarning(modelformat) << "There was a problem reading glTF WEIGHTS_0 data for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
}
@ -1230,10 +1249,12 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
// Validation stage
if (indices.count() == 0) {
qWarning(modelformat) << "Missing indices for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
if (vertices.count() == 0) {
qWarning(modelformat) << "Missing vertices for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
@ -1257,6 +1278,7 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
if (v1_index + 2 >= vertices.size() || v2_index + 2 >= vertices.size() || v3_index + 2 >= vertices.size()) {
qWarning(modelformat) << "Indices out of range for model " << _url;
hfmModel.loadErrorCount++;
break;
}
@ -1355,6 +1377,7 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
if (validatedIndices.size() == 0) {
qWarning(modelformat) << "No valid indices for model " << _url;
hfmModel.loadErrorCount++;
continue;
}
@ -1498,6 +1521,32 @@ bool GLTFSerializer::buildGeometry(HFMModel& hfmModel, const hifi::VariantHash&
}
for (int c = 0; c < clusterJoints.size(); ++c) {
if (mesh.clusterIndices.length() <= prevMeshClusterIndexCount + c) {
qCWarning(modelformat) << "Trying to write past end of clusterIndices at" << prevMeshClusterIndexCount + c;
hfmModel.loadErrorCount++;
continue;
}
if ( clusterJoints.length() <= c) {
qCWarning(modelformat) << "Trying to read past end of clusterJoints at" << c;
hfmModel.loadErrorCount++;
continue;
}
if ( _file.skins.length() <= node.skin ) {
qCWarning(modelformat) << "Trying to read past end of _file.skins at" << node.skin;
hfmModel.loadErrorCount++;
continue;
}
if ( _file.skins[node.skin].joints.length() <= clusterJoints[c]) {
qCWarning(modelformat) << "Trying to read past end of _file.skins[node.skin].joints at" << clusterJoints[c]
<< "; there are only" << _file.skins[node.skin].joints.length() << "for skin" << node.skin;
hfmModel.loadErrorCount++;
continue;
}
mesh.clusterIndices[prevMeshClusterIndexCount + c] =
originalToNewNodeIndexMap[_file.skins[node.skin].joints[clusterJoints[c]]];
}

99
tests/model-serializers/CMakeLists.txt Normal file
View file

@ -0,0 +1,99 @@
include(ExternalProject)
# Declare dependencies
macro (setup_testcase_dependencies)
# link in the shared libraries
link_hifi_libraries(shared test-utils model-serializers networking model-networking hfm graphics gpu image)
# The test system is a bit unusual in how it works, and generates targets on its own.
# This macro will be called for each of them, so we want to add stuff only to the
# right targets.
if("${TARGET_NAME}" STREQUAL "model-serializers-ModelSerializersTests")
# Abuse the ExternalProject system to download files. There exists ExternalData, but it really wants to
# use some obscure hash-based naming system for some reason. I think it's preferrable to have human readable
# filenames.
# Provided by DrFran for testing.
ExternalProject_Add(
ukr_franny
PREFIX "models"
URL "https://testing-assets.overte.org/model-serializers/UkraineFranny.glb.gz"
URL_HASH SHA512=a0187ea19252b506621d34bb5652642e1d29832377fe2584d73fdb297ea353c3153c0bf9975c3b24f1d328b435b7081a1490c1948d20dbcd06f1516a5bb2972e
DOWNLOAD_NO_EXTRACT true CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND ""
)
# Provided by DrFran for testing.
ExternalProject_Add(
dragon_franny
PREFIX "models"
URL "https://testing-assets.overte.org/model-serializers/DragonAvatar1.glb.gz"
URL_HASH SHA512=0c3b353ed3d7e9d6eaaaa9ec0026671ab0be1651182468828b8522f37d51d8a42f45269dd37bcdbeaa72b968872372a62ae1997cc1ceb40fdc30e6fb286aa263
DOWNLOAD_NO_EXTRACT true CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND ""
)
# Provided by DrFran for testing.
ExternalProject_Add(
franny
PREFIX "models"
URL "https://testing-assets.overte.org/model-serializers/Franny.glb.gz"
URL_HASH SHA512=dddcdfa629fb2f8153ffa8d04aaca47974147a038f615b78ad1a56b2e6a07b267e63a5618f735e726d8e5da0c9dcd0db901d988a6f0aa08e5f6078b7d1d62ac9
DOWNLOAD_NO_EXTRACT true CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND ""
)
# Provided by Madders for testing.
ExternalProject_Add(
madders1
PREFIX "models"
URL "https://testing-assets.overte.org/model-serializers/womanInTShirt.glb.gz"
URL_HASH SHA512=fca388c04de5a9e3ed05bd28b9021873f5f95e26bf9fbb525fd1940d9d3652b2d38d548db4826927b16cb4b8a8d2017f12b303cbd4ee52688716533f438cdbd7
DOWNLOAD_NO_EXTRACT true CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND ""
)
# Provided by Madders for testing.
ExternalProject_Add(
madders2
PREFIX "models"
URL "https://testing-assets.overte.org/model-serializers/female-avatar-with-swords.glb.gz"
URL_HASH SHA512=8ef5d3e8c9031dfa1de1b81fcf1efd398f4a369b23f4cda7e2c709072ddd86ac4b61928dd04a7312ca88874f6d99c264e5681b0e6e48a9d08de9f297c4330098
DOWNLOAD_NO_EXTRACT true CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND ""
)
# Generated by Dale Glass at Ready Player Me for testing.
ExternalProject_Add(
broken
PREFIX "models"
URL "https://testing-assets.overte.org/model-serializers/broken-2022-11-27.glb.gz"
URL_HASH SHA512=10193c35cc92ca3b760189bb9c308e4bd87f2424f02a38da91c21f4b472f6115af7248c64d827d98d0e7659b378cbf01591bec0c5b964f4d19388a10e5b83ffc
DOWNLOAD_NO_EXTRACT true CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND ""
)
ExternalProject_Add(
gltf_samples
PREFIX "models"
GIT_REPOSITORY "https://github.com/KhronosGroup/glTF-Sample-models"
GIT_TAG "master"
DOWNLOAD_NO_EXTRACT true CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND ""
)
add_dependencies(${TARGET_NAME} ukr_franny)
add_dependencies(${TARGET_NAME} dragon_franny)
add_dependencies(${TARGET_NAME} franny)
add_dependencies(${TARGET_NAME} madders1)
add_dependencies(${TARGET_NAME} madders2)
add_dependencies(${TARGET_NAME} broken)
add_dependencies(${TARGET_NAME} gltf_samples)
endif()
package_libraries_for_deployment()
endmacro ()
setup_hifi_testcase(Script Network)

161
tests/model-serializers/src/ModelSerializersTests.cpp Normal file
View file

@ -0,0 +1,161 @@
//
// ModelSerializersTests.cpp
// tests/model-serializers/src
//
// Created by Dale Glass on 20/11/2022.
// Copyright 2022 Overte e.V.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
// This test checks a large amount of files. To debug more comfortably and avoid going through
// a lot of uninteresting data, QTest allows us to narrow down what gets run with command line
// arguments, like this:
//
// ./model-serializers-ModelSerializersTests loadGLTF:gltf2.0-RecursiveSkeletons.glb
//
// This will run only the loadGLTF test, and only on the gltf2.0-RecursiveSkeletons.glb file.
#include "ModelSerializersTests.h"
#include "GLTFSerializer.h"
#include "FBXSerializer.h"
#include "OBJSerializer.h"
#include "Gzip.h"
#include "model-networking/ModelLoader.h"
#include <hfm/ModelFormatRegistry.h>
#include "DependencyManager.h"
#include "ResourceManager.h"
#include "AssetClient.h"
#include "LimitedNodeList.h"
#include "NodeList.h"
#include <QUrl>
#include <QNetworkAccessManager>
#include <QNetworkRequest>
#include <QNetworkReply>
#include <QByteArray>
#include <QDebug>
#include <QDirIterator>
QTEST_MAIN(ModelSerializersTests)
void ModelSerializersTests::initTestCase() {
qRegisterMetaType<QNetworkReply*>("QNetworkReply*");
DependencyManager::registerInheritance<LimitedNodeList, NodeList>();
DependencyManager::set<NodeList>(NodeType::Agent, INVALID_PORT);
DependencyManager::set<ModelFormatRegistry>(); // ModelFormatRegistry must be defined before ModelCache. See the ModelCache constructor.
DependencyManager::set<ResourceManager>();
DependencyManager::set<AssetClient>();
auto modelFormatRegistry = DependencyManager::get<ModelFormatRegistry>();
modelFormatRegistry->addFormat(FBXSerializer());
modelFormatRegistry->addFormat(OBJSerializer());
modelFormatRegistry->addFormat(GLTFSerializer());
}
void ModelSerializersTests::loadGLTF_data() {
// We feed a large amount of files into the test. Some we expect to fail, some we expect to load with issues. The
// added columns below indicate our expectations for each file.
QTest::addColumn<QString>("filename");
QTest::addColumn<bool>("expectParseFail");
QTest::addColumn<bool>("expectWarnings");
QTest::addColumn<bool>("expectErrors");
QTest::newRow("ready-player-me-good1") << "models/src/DragonAvatar1.glb.gz" << false << false << false;
QTest::newRow("ready-player-me-good2") << "models/src/UkraineFranny.glb.gz" << false << false << false;
QTest::newRow("ready-player-me-good3") << "models/src/Franny.glb.gz" << false << false << false;
QTest::newRow("ready-player-me-good4") << "models/src/womanInTShirt.glb.gz" << false << false << false;
QTest::newRow("ready-player-me-good5") << "models/src/female-avatar-with-swords.glb.gz" << false << false << false;
QTest::newRow("ready-player-me-broken1") << "models/src/broken-2022-11-27.glb.gz" << false << true;
// We can't parse GLTF 1.0 at present, and probably not ever. We're expecting all these to fail.
QDirIterator it("models/src/gltf_samples/1.0", QStringList() << "*.glb", QDir::Files, QDirIterator::Subdirectories);
while(it.hasNext()) {
QString filename = it.next();
QFileInfo fi(filename);
QString testname = "gltf1.0-" + fi.fileName();
QTest::newRow(testname.toUtf8().data()) << filename << true << false << false;
}
QDirIterator it2("models/src/gltf_samples/2.0", QStringList() << "*.glb", QDir::Files, QDirIterator::Subdirectories);
while(it2.hasNext()) {
QString filename = it2.next();
QFileInfo fi(filename);
QString testname = "gltf2.0-" + fi.fileName();
QTest::newRow(testname.toUtf8().data()) << filename << false << false << false;
}
}
void ModelSerializersTests::loadGLTF() {
QFETCH(QString, filename);
QFETCH(bool, expectParseFail);
QFETCH(bool, expectWarnings);
QFETCH(bool, expectErrors);
QFile gltf_file(filename);
QVERIFY(gltf_file.open(QIODevice::ReadOnly));
QByteArray data = gltf_file.readAll();
QByteArray uncompressedData;
QUrl url("https://example.com");
qInfo() << "URL: " << url;
if (filename.toLower().endsWith(".gz")) {
url.setPath("/" + filename.chopped(3));
if (gunzip(data, uncompressedData)) {
qInfo() << "Uncompressed into" << uncompressedData.length();
} else {
qCritical() << "Failed to uncompress";
}
} else {
url.setPath("/" + filename);
uncompressedData = data;
}
ModelLoader loader;
QMultiHash<QString, QVariant> serializerMapping;
std::string webMediaType;
serializerMapping.insert("combineParts", true);
serializerMapping.insert("deduplicateIndices", true);
qInfo() << "Loading model from" << uncompressedData.length() << "bytes data, url" << url;
// Check that we can find a serializer for this
auto serializer = DependencyManager::get<ModelFormatRegistry>()->getSerializerForMediaType(uncompressedData, url, webMediaType);
QVERIFY(serializer);
hfm::Model::Pointer model = loader.load(uncompressedData, serializerMapping, url, webMediaType);
QVERIFY(expectParseFail == !model);
if (!model) {
// We expected this parse to fail, so nothing more to do here.
return;
}
QVERIFY(!model->meshes.empty());
QVERIFY(!model->joints.empty());
qInfo() << "Model was loaded with" << model->meshes.count() << "meshes and" << model->joints.count() << "joints. Found" << model->loadWarningCount << "warnings and" << model->loadErrorCount << "errors";
// Some models we test are expected to be broken. We're testing that we can load the model without blowing up,
// so loading it with errors is still a successful test.
QVERIFY(expectWarnings == (model->loadWarningCount>0));
QVERIFY(expectErrors == (model->loadErrorCount>0));
}

27
tests/model-serializers/src/ModelSerializersTests.h Normal file
View file

@ -0,0 +1,27 @@
//
// ModelSerializersTests.h
// tests/model-serializers/src
//
// Created by Dale Glass on 20/11/2022.
// Copyright 2022 Overte e.V.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
#ifndef overte_ModelSerializersTests_h
#define overte_ModelSerializersTests_h
#include <QtTest/QtTest>
class ModelSerializersTests : public QObject {
Q_OBJECT
private slots:
void initTestCase();
void loadGLTF_data();
void loadGLTF();
};
#endif // overte_ModelSerializersTests_h