mirror of https://github.com/mosra/magnum.git
Browse Source
Currently provides just the --info option similarly to magnum-imageconverter, nothing else.pull/432/head
Vladimír Vondruš
6 years ago
33 changed files with 300 additions and 2 deletions
@ -0,0 +1,251 @@ |
|||||||
|
/*
|
||||||
|
This file is part of Magnum. |
||||||
|
|
||||||
|
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 |
||||||
|
Vladimír Vondruš <mosra@centrum.cz> |
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a |
||||||
|
copy of this software and associated documentation files (the "Software"), |
||||||
|
to deal in the Software without restriction, including without limitation |
||||||
|
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||||
|
and/or sell copies of the Software, and to permit persons to whom the |
||||||
|
Software is furnished to do so, subject to the following conditions: |
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included |
||||||
|
in all copies or substantial portions of the Software. |
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||||
|
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||||
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||||
|
DEALINGS IN THE SOFTWARE. |
||||||
|
*/ |
||||||
|
|
||||||
|
#include <algorithm> |
||||||
|
#include <Corrade/Containers/Optional.h> |
||||||
|
#include <Corrade/Utility/Arguments.h> |
||||||
|
#include <Corrade/Utility/DebugStl.h> |
||||||
|
#include <Corrade/Utility/Directory.h> |
||||||
|
#include <Corrade/Utility/FormatStl.h> |
||||||
|
#include <Corrade/Utility/String.h> |
||||||
|
|
||||||
|
#include "Magnum/PixelFormat.h" |
||||||
|
#include "Magnum/Trade/AbstractImporter.h" |
||||||
|
#include "Magnum/Trade/MeshData.h" |
||||||
|
#include "Magnum/Trade/Implementation/converterUtilities.h" |
||||||
|
|
||||||
|
namespace Magnum { |
||||||
|
|
||||||
|
/** @page magnum-sceneconverter Scene conversion utility
|
||||||
|
@brief Converts scenes of different formats |
||||||
|
|
||||||
|
@m_footernavigation |
||||||
|
@m_keywords{magnum-sceneconverter sceneconverter} |
||||||
|
|
||||||
|
This utility is built if both `WITH_TRADE` and `WITH_SCENECONVERTER` is enabled |
||||||
|
when building Magnum. To use this utility with CMake, you need to request the |
||||||
|
`sceneconverter` component of the `Magnum` package and use the |
||||||
|
`Magnum::sceneconverter` target for example in a custom command: |
||||||
|
|
||||||
|
@code{.cmake} |
||||||
|
find_package(Magnum REQUIRED imageconverter) |
||||||
|
|
||||||
|
add_custom_command(OUTPUT ... COMMAND Magnum::sceneconverter ...) |
||||||
|
@endcode |
||||||
|
|
||||||
|
See @ref building, @ref cmake and the @ref Trade namespace for more |
||||||
|
information. |
||||||
|
|
||||||
|
@section magnum-sceneconverter-usage Usage |
||||||
|
|
||||||
|
@code{.sh} |
||||||
|
magnum-sceneconverter [-h|--help] [--importer IMPORTER] [--plugin-dir DIR] |
||||||
|
[-i|--importer-options key=val,key2=val2,…] [--info] [--] input |
||||||
|
@endcode |
||||||
|
|
||||||
|
Arguments: |
||||||
|
|
||||||
|
- `input` --- input file |
||||||
|
- `-h`, `--help` --- display this help message and exit |
||||||
|
- `--importer IMPORTER` --- scene importer plugin (default: |
||||||
|
@ref Trade::AnySceneImporter "AnySceneImporter") |
||||||
|
- `--plugin-dir DIR` --- override base plugin dir |
||||||
|
- `-i`, `--importer-options key=val,key2=val2,…` --- configuration options to |
||||||
|
pass to the importer |
||||||
|
- `--info` --- print info about the input file and exit |
||||||
|
|
||||||
|
If `--info` is given, the utility will print information about all meshes |
||||||
|
and images present in the file. **This option is currently mandatory.** |
||||||
|
|
||||||
|
The `-i` / `--importer-options` argument accepts a comma-separated list of |
||||||
|
key/value pairs to set in the importer plugin configuration. If the `=` |
||||||
|
character is omitted, it's equivalent to saying `key=true`. |
||||||
|
|
||||||
|
@see @ref magnum-imageconverter |
||||||
|
*/ |
||||||
|
} |
||||||
|
|
||||||
|
using namespace Magnum; |
||||||
|
|
||||||
|
int main(int argc, char** argv) { |
||||||
|
Utility::Arguments args; |
||||||
|
args.addArgument("input").setHelp("input", "input file") |
||||||
|
.addOption("importer", "AnySceneImporter").setHelp("importer", "scene importer plugin") |
||||||
|
.addOption("plugin-dir").setHelp("plugin-dir", "override base plugin dir", "DIR") |
||||||
|
.addOption('i', "importer-options").setHelp("importer-options", "configuration options to pass to the importer", "key=val,key2=val2,…") |
||||||
|
.addBooleanOption("info").setHelp("info", "print info about the input file and exit") |
||||||
|
/** @todo add the parse error callback from imageconverter once there's
|
||||||
|
an output argument, also remove the "mandatory" from all docs */ |
||||||
|
.setGlobalHelp(R"(Converts scenes of different formats. |
||||||
|
|
||||||
|
If --info is given, the utility will print information about all meshes and |
||||||
|
images present in the file. This option is currently mandatory. |
||||||
|
|
||||||
|
The -i / --importer-options argument accepts a comma-separated list of |
||||||
|
key/value pairs to set in the importer plugin configuration. If the = character |
||||||
|
is omitted, it's equivalent to saying key=true.)") |
||||||
|
.parse(argc, argv); |
||||||
|
|
||||||
|
PluginManager::Manager<Trade::AbstractImporter> importerManager{ |
||||||
|
args.value("plugin-dir").empty() ? std::string{} : |
||||||
|
Utility::Directory::join(args.value("plugin-dir"), Trade::AbstractImporter::pluginSearchPaths()[0])}; |
||||||
|
|
||||||
|
Containers::Pointer<Trade::AbstractImporter> importer = importerManager.loadAndInstantiate(args.value("importer")); |
||||||
|
if(!importer) { |
||||||
|
Debug{} << "Available importer plugins:" << Utility::String::join(importerManager.aliasList(), ", "); |
||||||
|
return 1; |
||||||
|
} |
||||||
|
|
||||||
|
/* Set options, if passed */ |
||||||
|
Trade::Implementation::setOptions(*importer, args.value("importer-options")); |
||||||
|
|
||||||
|
/* Print file info, if requested */ |
||||||
|
if(args.isSet("info")) { |
||||||
|
/* Open the file, but don't fail when an image can't be opened */ |
||||||
|
if(!importer->openFile(args.value("input"))) { |
||||||
|
Error() << "Cannot open file" << args.value("input"); |
||||||
|
return 3; |
||||||
|
} |
||||||
|
|
||||||
|
if(!importer->meshCount() && !importer->image1DCount() && !importer->image2DCount() && !importer->image2DCount()) { |
||||||
|
Debug{} << "No meshes or images found."; |
||||||
|
return 0; |
||||||
|
} |
||||||
|
|
||||||
|
struct MeshAttributeInfo { |
||||||
|
std::size_t offset; |
||||||
|
UnsignedInt stride, arraySize; |
||||||
|
Trade::MeshAttribute name; |
||||||
|
std::string customName; |
||||||
|
VertexFormat format; |
||||||
|
}; |
||||||
|
|
||||||
|
struct MeshInfo { |
||||||
|
UnsignedInt mesh, level; |
||||||
|
MeshPrimitive primitive; |
||||||
|
UnsignedInt indexCount, vertexCount; |
||||||
|
MeshIndexType indexType; |
||||||
|
Containers::Array<MeshAttributeInfo> attributes; |
||||||
|
std::size_t indexDataSize, vertexDataSize; |
||||||
|
std::string name; |
||||||
|
}; |
||||||
|
|
||||||
|
/* Parse everything first to avoid errors interleaved with output */ |
||||||
|
bool error = false; |
||||||
|
Containers::Array<MeshInfo> meshInfos; |
||||||
|
for(UnsignedInt i = 0; i != importer->meshCount(); ++i) { |
||||||
|
for(UnsignedInt j = 0; j != importer->meshLevelCount(i); ++j) { |
||||||
|
Containers::Optional<Trade::MeshData> mesh = importer->mesh(i, j); |
||||||
|
if(!mesh) { |
||||||
|
error = true; |
||||||
|
continue; |
||||||
|
} |
||||||
|
|
||||||
|
MeshInfo info{}; |
||||||
|
info.mesh = i; |
||||||
|
info.level = j; |
||||||
|
info.primitive = mesh->primitive(); |
||||||
|
info.vertexCount = mesh->vertexCount(); |
||||||
|
info.vertexDataSize = mesh->vertexData().size(); |
||||||
|
if(!j) info.name = importer->meshName(i); |
||||||
|
if(mesh->isIndexed()) { |
||||||
|
info.indexCount = mesh->indexCount(); |
||||||
|
info.indexType = mesh->indexType(); |
||||||
|
info.indexDataSize = mesh->indexData().size(); |
||||||
|
} |
||||||
|
for(UnsignedInt k = 0; k != mesh->attributeCount(); ++k) { |
||||||
|
const Trade::MeshAttribute name = mesh->attributeName(k); |
||||||
|
arrayAppend(info.attributes, Containers::InPlaceInit, |
||||||
|
mesh->attributeOffset(k), |
||||||
|
mesh->attributeStride(k), |
||||||
|
mesh->attributeArraySize(k), |
||||||
|
name, Trade::isMeshAttributeCustom(name) ? |
||||||
|
importer->meshAttributeName(name) : "", |
||||||
|
mesh->attributeFormat(k)); |
||||||
|
} |
||||||
|
|
||||||
|
std::sort(info.attributes.begin(), info.attributes.end(), |
||||||
|
[](const MeshAttributeInfo& a, const MeshAttributeInfo& b) { |
||||||
|
return a.offset < b.offset; |
||||||
|
}); |
||||||
|
|
||||||
|
arrayAppend(meshInfos, std::move(info)); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
Containers::Array<Trade::Implementation::ImageInfo> imageInfos = |
||||||
|
Trade::Implementation::imageInfo(*importer, error); |
||||||
|
|
||||||
|
for(const MeshInfo& info: meshInfos) { |
||||||
|
Debug d; |
||||||
|
if(info.level == 0) { |
||||||
|
d << "Mesh" << info.mesh << Debug::nospace << ":"; |
||||||
|
if(!info.name.empty()) d << info.name; |
||||||
|
d << Debug::newline; |
||||||
|
} |
||||||
|
d << " Level" << info.level << Debug::nospace << ":" |
||||||
|
<< info.primitive << Debug::nospace << "," << info.vertexCount |
||||||
|
<< "vertices (" << Debug::nospace |
||||||
|
<< Utility::formatString("{:.1f}", info.vertexDataSize/1024.0f) |
||||||
|
<< "kB)"; |
||||||
|
if(info.indexType != MeshIndexType{}) { |
||||||
|
d << Debug::newline << " " << info.indexCount << "indices @" |
||||||
|
<< info.indexType << "(" << Debug::nospace |
||||||
|
<< Utility::formatString("{:.1f}", info.indexDataSize/1024.0f) |
||||||
|
<< "kB)"; |
||||||
|
} |
||||||
|
|
||||||
|
for(const MeshAttributeInfo& attribute: info.attributes) { |
||||||
|
d << Debug::newline << " Offset" << attribute.offset |
||||||
|
<< Debug::nospace << ":" << attribute.name; |
||||||
|
if(Trade::isMeshAttributeCustom(attribute.name)) { |
||||||
|
d << "(" << Debug::nospace << attribute.customName |
||||||
|
<< Debug::nospace << ")"; |
||||||
|
} |
||||||
|
d << "@" << attribute.format << Debug::nospace << ", stride" |
||||||
|
<< attribute.stride; |
||||||
|
} |
||||||
|
} |
||||||
|
for(const Trade::Implementation::ImageInfo& info: imageInfos) { |
||||||
|
Debug d; |
||||||
|
if(info.level == 0) { |
||||||
|
d << "Image" << info.image << Debug::nospace << ":"; |
||||||
|
if(!info.name.empty()) d << info.name; |
||||||
|
d << Debug::newline; |
||||||
|
} |
||||||
|
d << " Level" << info.level << Debug::nospace << ":"; |
||||||
|
if(info.compressed) d << info.compressedFormat; |
||||||
|
else d << info.format; |
||||||
|
if(info.size.z()) d << info.size; |
||||||
|
else if(info.size.y()) d << info.size.xy(); |
||||||
|
else d << Math::Vector<1, Int>(info.size.x()); |
||||||
|
} |
||||||
|
|
||||||
|
return error ? 1 : 0; |
||||||
|
} |
||||||
|
|
||||||
|
Error{} << "Sorry, only the --info option is currently implemented"; |
||||||
|
return 6; |
||||||
|
} |
||||||
Loading…
Reference in new issue