Fix #42: Serious gltf bugs by Squareys · Pull Request #43 · mosra/magnum-plugins

Squareys · 2018-05-22T14:28:09Z

Hi @mosra !

Here's a WIP PR for #42!

Cheers, Jonathan.

TODOs

bufferView.stride (now failing on non-trivial as suggested)
sensible material defaults (and interpretation of pbr values)
fix flipped textures
solve python scripts/buffer generation
test load more of the khronos provided example models

codecov-io · 2018-05-22T21:42:14Z

Codecov Report

Merging #43 into master will decrease coverage by 0.1%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #43      +/-   ##
==========================================
- Coverage   87.26%   87.15%   -0.11%     
==========================================
  Files          41       39       -2     
  Lines        3903     3193     -710     
==========================================
- Hits         3406     2783     -623     
+ Misses        497      410      -87

Impacted Files	Coverage Δ
...rc/MagnumPlugins/AssimpImporter/AssimpImporter.cpp	`69.79% <0%> (-13.55%)`	⬇️
...numPlugins/StbImageConverter/StbImageConverter.cpp	`73.84% <0%> (-0.44%)`	⬇️
src/Magnum/OpenDdl/Document.h	`88.57% <0%> (-0.32%)`	⬇️
src/Magnum/OpenDdl/Structure.h	`96.55% <0%> (-0.06%)`	⬇️
src/MagnumPlugins/OpenGexImporter/openGexSpec.hpp	`100% <0%> (ø)`	⬆️
src/MagnumPlugins/PngImporter/PngImporter.cpp	`69.87% <0%> (+0.11%)`	⬆️
...numPlugins/PngImageConverter/PngImageConverter.cpp	`69.11% <0%> (+0.54%)`	⬆️
...agnumPlugins/StanfordImporter/StanfordImporter.cpp	`94.3% <0%> (+0.55%)`	⬆️
src/Magnum/OpenDdl/Implementation/Parsers.cpp	`88.03% <0%> (+0.56%)`	⬆️
.../MagnumPlugins/OpenGexImporter/OpenGexImporter.cpp	`94.45% <0%> (+0.79%)`	⬆️
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 99174e8...b44bd06. Read the comment docs.

mosra

Initial review. Did not pull locally yet, as I assume you'd still be testing with the sample models (and maybe finding some more issues there).

Thanks a lot for all the work!

mosra · 2018-05-26T07:44:29Z

+unsigned int: 2 1 0 3
+# Triangle Fan
+float: 5.1 5.2 5.3 6.1 6.2 6.3 7.1 7.2 7.3 8.1 8.2 8.3
+unsigned int: 2 1 3 0


Why not make use of the Python struct package as I suggested on Gitter? You wouldn't need to do any parsing or anything, just feed structure definition together with a single array to Python. Original suggestion, for the record:

/* type = "<3Hxx9f" input = [0, 1, 2, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0, 0.0] */ "uri" : "data:application/octet-> stream;base64,AAABAAIAAAAAAAAAAAAAAAAAAAAAAIA/AAAAAAAAAAAAAAAAAACAPwAAAAA=", "byteLength" : 44

to explain, first is type specification according to https://docs.python.org/3.6/library/struct.html, second is a list of values encoded based on that spec:

< to denote little endian (could be even omitted, I think, and just part of the script)

then three unsigned short values, encoding indices

after that two padding bytes

after that 9 floats (three three-component vectors), encoding positions
6 bytes + 2 padding + 36 bytes = 44 bytes total

The whole script would be then just:

import struct exec(the_type_and_input_lines_above) # you get type and input from it with open(file, 'wb') as f: f.write(struct.pack(type, input))

Back when I read that message I thought you meant having that comment like in the code snippet which would then be parsed and then insert its result into the appropriate place in the gltf file :D That seemed a little too complicated.
Didn't realize you meant having a script that would just create the bin in a hardcoded way... kinda makes sense, though.

I thought you meant

Wellll, yes, sorry, I did. My initial ideas are always over-the-board crazy 😆 Having that in a separate .bin.in file is fine as well now, no need to go that crazy ;)

mosra · 2018-05-26T08:02:26Z

    CORRADE_INTERNAL_ASSERT(node.rotation.size() == 0 || node.rotation.size() == 4);
    CORRADE_INTERNAL_ASSERT(node.translation.size() == 0 || node.translation.size() == 3);
    CORRADE_INTERNAL_ASSERT(node.scale.size() == 0 || node.scale.size() == 3);
+    /* Ensure we have either a matrix or L-R-S */


What does L stand for? (The glTF tutorial names it as TRS.)

Location. (Like LocRotScale in blender)

Will change it to match the spec

Ahh, Loc in Blender, of course. Sorry for dumb questions 🙊

mosra · 2018-05-26T08:08:16Z

 // The MIT License (MIT)
 //
-// Copyright (c) 2015 - 2017 Syoyo Fujita, Aurélien Chatelain and many
+// Copyright (c) 2015 - 2018 Syoyo Fujita, Aurélien Chatelain and many


Can you amend the commit message that updates this file and say which upstream SHA-1 is this? Helps a lot when updating later.

Thanks.

mosra · 2018-05-26T08:09:32Z

    } else if(primitive.mode == TINYGLTF_MODE_LINE_LOOP) {
        meshPrimitive = MeshPrimitive::LineLoop;
+    } else if(primitive.mode == 3) {
+        /* For some reason tiny_gltf doesn't have a define for this */


mosra · 2018-05-26T08:11:51Z

            }

-            const size_t numPositions = bufferView.byteLength/sizeof(Vector3);
+            const size_t numPositions = accessor.count;


I think this variable is not really needed anymore. (Yes, sorry, this originates from my patch, which was just hastily put together to make things working).

mosra · 2018-05-26T08:23:22Z

+        if(dt != material.values.end()) {
+            diffuseTexture = dt->second.TextureIndex();
+            flags |= PhongMaterialData::Flag::DiffuseTexture;
+        }


Similarly to baseColorTexture, there's the baseColorFactor. As I mentioned in #42, the glTF sample model repository uses it on even the most basic models. Assimp imports it as diffuse, so we could do the same here (unless diffuseFactor is set).

mosra · 2018-05-26T08:52:40Z

    } else if(idxAccessor.componentType == TINYGLTF_COMPONENT_TYPE_UNSIGNED_INT) {
-        std::copy_n(reinterpret_cast<const UnsignedInt*>(start), idxBufferView.byteLength/sizeof(UnsignedInt), std::back_inserter(indices));
+        std::copy_n(reinterpret_cast<const UnsignedInt*>(start), idxAccessor.count, std::back_inserter(indices));
    } else CORRADE_ASSERT_UNREACHABLE(); /* LCOV_EXCL_LINE */


Unless I missed something, this is still not correctly handling interleaved data. Failing with a clear error in that case would be the best, but can you mention that in the limitations in the docs, at least? I have no idea if tinygltf supports that, even.

It does, there is accessor.stride...

Okay, great. I am planning on supporting interleaved attributes directly in MeshData later, so at that point I can implement support for them here as well.

Until then, could you fail in case of a non-trivial stride?

Pardon me, it's bufferView.stride (just in case you need it sometime)

mosra · 2018-05-26T08:56:29Z

+        /* The specification instructs to use "auto sampling", i.e. it is left to the implementor to decide on the default values... */
+        return TextureData{TextureData::Type::Texture2D, SamplerFilter::Linear, SamplerFilter::Linear,
+            Sampler::Mipmap::Linear, {Sampler::Wrapping::Repeat, Sampler::Wrapping::Repeat, Sampler::Wrapping::Repeat}, UnsignedInt(tex.source), &tex};
+    }


Would be great if you could mention the defaults in case no sampler definition is present in the docs.

mosra · 2018-05-26T08:57:03Z

    UnsignedInt diffuseTexture{}, specularTexture{};
+    Vector4 diffuseColor{1.0f};
+    Vector3 specularColor{0.0f};
+    Float shininess{1.0f};


Mentioning these defaults in the docs would be great :)

mosra · 2018-05-26T09:07:53Z

Oh, one more thing: are you planning to handle the texture coordinate flipping here as well? I am not exactly sure what's happening, though.

Signed-off-by: Squareys <squareys@googlemail.com>

mosra · 2018-06-01T18:17:13Z

        const tinygltf::Buffer& buffer = _d->model.buffers[bufferView.buffer];

+        const int stride = bufferView.byteStride;
+        CORRADE_ASSERT(stride == 0, "Trade::TinyGltfImporter::mesh3D(): non-zero strides for buffer views are unsupported.", {});


... can this be a non-fatal failure? Like, returning NullOpt instead of blowing up :)

Yes, already did that.

Squareys · 2018-06-01T20:54:05Z

@mosra Alright, did everything (I tripple checked this time, but you may want to do so, too 😜 ). Ready for review 👍

Signed-off-by: Squareys <squareys@googlemail.com>

Matches 7c56f8eb9eba408fc7db8ec15ad621c25b414b7b in https://github.com/syoyo/tinygltf. Signed-off-by: Squareys <squareys@googlemail.com>

Signed-off-by: Squareys <squareys@googlemail.com>

mosra · 2018-06-02T12:17:42Z

Finally merged, thank you a lot :)

steeve · 2018-06-02T13:30:04Z

congrats guys ! and thank you !

Squareys force-pushed the serious-gltf-issues branch from 6cfad28 to 636a0cc Compare May 24, 2018 23:23

mosra reviewed May 26, 2018

View reviewed changes

Squareys and others added 2 commits June 1, 2018 18:25

TinyGltfImporter: Fix importer not failing on non-existent files

70aaa84

Signed-off-by: Squareys <squareys@googlemail.com>

TinyGltfImporter: Fix mesh import

e1dd3fb

Squareys force-pushed the serious-gltf-issues branch 2 times, most recently from 5b360ea to 5b21a82 Compare June 1, 2018 17:49

mosra mentioned this pull request Jun 1, 2018

Serious glTF importer bugs #42

Closed

5 tasks

Squareys force-pushed the serious-gltf-issues branch from 5b21a82 to 0053ada Compare June 1, 2018 18:15

mosra reviewed Jun 1, 2018

View reviewed changes

Squareys force-pushed the serious-gltf-issues branch from 0053ada to b5bb024 Compare June 1, 2018 20:52

Squareys changed the title ~~[WIP] Fix #42: Serious gltf bugs~~ Fix #42: Serious gltf bugs Jun 1, 2018

Squareys force-pushed the serious-gltf-issues branch from b5bb024 to ec574af Compare June 1, 2018 21:27

Squareys added 6 commits June 1, 2018 23:33

TinyGltfImporter: Cleanup test files, extend tests and fix some bugs

335329f

Signed-off-by: Squareys <squareys@googlemail.com>

tinygltf: Merge upstream changes

f353bfa

Matches 7c56f8eb9eba408fc7db8ec15ad621c25b414b7b in https://github.com/syoyo/tinygltf. Signed-off-by: Squareys <squareys@googlemail.com>

tinygltf: No, scene.nodes is not required.

66d8f67

Signed-off-by: Squareys <squareys@googlemail.com>

TinyGltfImporter: Adapt to changes in tiny_gltf.h

3bdd975

Signed-off-by: Squareys <squareys@googlemail.com>

TinyGltfImporter: Fix loading external images with .glb files

ace9c70

Signed-off-by: Squareys <squareys@googlemail.com>

TinyGltfImporter: Minor cleanup

616e63d

Signed-off-by: Squareys <squareys@googlemail.com>

Squareys force-pushed the serious-gltf-issues branch from ec574af to 5d66a56 Compare June 1, 2018 21:35

Squareys added 5 commits June 1, 2018 23:47

TinyGltfImporter: Import diffuse textures and fail on non-trivial stride

5706056

Signed-off-by: Squareys <squareys@googlemail.com>

TinyGltfImporter: Document defaults for sampler and material properties

989f27b

Signed-off-by: Squareys <squareys@googlemail.com>

TinyGltfImporter: Add python scripts for working with binary gltf

24317f6

Signed-off-by: Squareys <squareys@googlemail.com>

TinyGltfImporter: Add test for mesh primitives and index types

f8e5ab2

Signed-off-by: Squareys <squareys@googlemail.com>

TinyGltfImporter: Flip Y-axis of texture coordinates

b44bd06

Signed-off-by: Squareys <squareys@googlemail.com>

Squareys force-pushed the serious-gltf-issues branch from 5d66a56 to b44bd06 Compare June 1, 2018 21:48

mosra merged commit b44bd06 into mosra:master Jun 2, 2018

mosra added this to the 2018.0c milestone Jun 2, 2018

mosra added the changelog mention added label Jun 2, 2018

Conversation

Squareys commented May 22, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-io commented May 22, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mosra left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mosra commented May 26, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Squareys commented Jun 1, 2018

Uh oh!

mosra commented Jun 2, 2018

Uh oh!

steeve commented Jun 2, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Squareys commented May 22, 2018 •

edited

Loading

codecov-io commented May 22, 2018 •

edited

Loading