/* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022 Vladimír Vondruš 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 "AnyConverter.h" #include #include #include #include #include #include /* for PluginMetadata::name() */ #include #include #include #include "MagnumPlugins/Implementation/propagateConfiguration.h" namespace Magnum { namespace ShaderTools { struct AnyConverter::State { Format inputFormat, outputFormat; Containers::String inputVersion, outputVersion; Containers::Array> definitions; Containers::Array> definitionViews; Containers::String debugInfoLevel, optimizationLevel; }; AnyConverter::AnyConverter(PluginManager::Manager& manager): AbstractConverter{manager} {} AnyConverter::AnyConverter(PluginManager::AbstractManager& manager, const std::string& plugin): AbstractConverter{manager, plugin}, _state{InPlaceInit} {} AnyConverter::~AnyConverter() = default; ConverterFeatures AnyConverter::doFeatures() const { return ConverterFeature::ValidateFile|ConverterFeature::ValidateData|ConverterFeature::ConvertFile|ConverterFeature::ConvertData|ConverterFeature::Preprocess|ConverterFeature::DebugInfo|ConverterFeature::Optimize; } void AnyConverter::doSetInputFormat(const Format format, const Containers::StringView version) { _state->inputFormat = format; _state->inputVersion = Containers::String::nullTerminatedGlobalView(version); } void AnyConverter::doSetOutputFormat(Format format, Containers::StringView version) { _state->outputFormat = format; _state->outputVersion = Containers::String::nullTerminatedGlobalView(version); } void AnyConverter::doSetDefinitions(const Containers::ArrayView> definitions) { /* We have to make a local copy, unfortunately, and then a view on that local copy */ _state->definitions = Containers::Array>{definitions.size()}; _state->definitionViews = Containers::Array>{definitions.size()}; for(std::size_t i = 0; i != definitions.size(); ++i) { /* Avoid a copy if the input is a global string literal */ _state->definitions[i] = { Containers::String::nullTerminatedGlobalView(definitions[i].first), Containers::String::nullTerminatedGlobalView(definitions[i].second) }; /* Preserve the distinction between empty defines ("") and undefines (nullptr or default constructor) */ _state->definitionViews[i] = { _state->definitions[i].first, definitions[i].second.data() ? Containers::StringView{_state->definitions[i].second} : Containers::StringView{} }; } } void AnyConverter::doSetDebugInfoLevel(const Containers::StringView level) { _state->debugInfoLevel = Containers::String::nullTerminatedGlobalView(level); } void AnyConverter::doSetOptimizationLevel(const Containers::StringView level) { _state->optimizationLevel = Containers::String::nullTerminatedGlobalView(level); } namespace { using namespace Containers::Literals; Containers::StringView stringForFormat(const Format format) { switch(format) { #define _c(format) case Format::format: return #format ## _s; _c(Glsl) _c(Spirv) _c(SpirvAssembly) _c(Hlsl) _c(Msl) _c(Wgsl) _c(Dxil) #undef _c case Format::Unspecified: return {}; } CORRADE_INTERNAL_ASSERT_UNREACHABLE(); /* LCOV_EXCL_LINE */ } Format formatForExtension(const char* prefix, const Containers::StringView filename) { /* Can't reliably lowercase just the extension as we detect double extensions as well. But we can lowercase just the filename, at least. */ const Containers::String normalized = Utility::String::lowercase(Utility::Path::split(filename).second()); /* https://github.com/KhronosGroup/SPIRV-Tools/blob/a715b1b4053519ad0f2bdb2d22ace35d35867cff/README.md#command-line-tools "It's a convention to name SPIR-V assembly and binary files with suffix .spvasm and .spv, respectively." IT'S GREAT THAT I HAD TO SEARCH HALF THE INTERNET TO FIND THIS CONVENTION. Especially when tests in the SPIRV-Cross repo use `.asm.bla` instead, FFS. */ if(normalized.hasSuffix(".spvasm"_s) || /* Not official, used by https://github.com/KhronosGroup/SPIRV-Cross */ normalized.hasSuffix(".asm.vert"_s) || normalized.hasSuffix(".asm.frag"_s) || normalized.hasSuffix(".asm.geom"_s) || normalized.hasSuffix(".asm.comp"_s) || normalized.hasSuffix(".asm.tesc"_s) || normalized.hasSuffix(".asm.tese"_s) || normalized.hasSuffix(".asm.rgen"_s) || normalized.hasSuffix(".asm.rint"_s) || normalized.hasSuffix(".asm.rahit"_s) || normalized.hasSuffix(".asm.rchit"_s) || normalized.hasSuffix(".asm.rmiss"_s) || normalized.hasSuffix(".asm.rcall"_s) || normalized.hasSuffix(".asm.mesh"_s) || normalized.hasSuffix(".asm.task"_s)) return Format::SpirvAssembly; /* https://github.com/KhronosGroup/glslang/blob/3ce148638bdc3807316e358dee4a5c9583189ae7/StandAlone/StandAlone.cpp#L260-L274 */ else if(normalized.hasSuffix(".glsl"_s) || normalized.hasSuffix(".vert"_s) || normalized.hasSuffix(".frag"_s) || normalized.hasSuffix(".geom"_s) || normalized.hasSuffix(".comp"_s) || normalized.hasSuffix(".tesc"_s) || normalized.hasSuffix(".tese"_s) || normalized.hasSuffix(".rgen"_s) || normalized.hasSuffix(".rint"_s) || normalized.hasSuffix(".rahit"_s) || normalized.hasSuffix(".rchit"_s) || normalized.hasSuffix(".rmiss"_s) || normalized.hasSuffix(".rcall"_s) || normalized.hasSuffix(".mesh"_s) || normalized.hasSuffix(".task"_s)) return Format::Glsl; else if(normalized.hasSuffix(".spv"_s)) return Format::Spirv; Error{} << prefix << "cannot determine the format of" << filename; return {}; } } std::pair AnyConverter::doValidateFile(const Stage stage, const Containers::StringView filename) { CORRADE_INTERNAL_ASSERT(manager()); /* Prefer the explicitly set input format. If not set, fall back to detecting based on extension. */ const Containers::StringView format = stringForFormat( _state->inputFormat != Format::Unspecified ? _state->inputFormat : formatForExtension("ShaderTools::AnyConverter::validateFile():", filename) ); if(format.isEmpty()) return {}; /* Decide on a plugin name based on the format */ const std::string plugin = Utility::formatString("{}ShaderConverter", format); /* Try to load the plugin */ if(!(manager()->load(plugin) & PluginManager::LoadState::Loaded)) { Error{} << "ShaderTools::AnyConverter::validateFile(): cannot load the" << plugin << "plugin"; return {}; } const PluginManager::PluginMetadata* const metadata = manager()->metadata(plugin); CORRADE_INTERNAL_ASSERT(metadata); if(flags() & ConverterFlag::Verbose) { Debug d; d << "ShaderTools::AnyConverter::validateFile(): using" << plugin; if(plugin != metadata->name()) d << "(provided by" << metadata->name() << Debug::nospace << ")"; } /* Instantiate the plugin */ Containers::Pointer converter = static_cast*>(manager())->instantiate(plugin); /* Check that it can actually validate */ if(!(converter->features() & ConverterFeature::ValidateFile)) { Error{} << "ShaderTools::AnyConverter::validateFile():" << metadata->name() << "does not support validation"; return {}; } /* Check that it can preprocess, in case we were asked to preprocess */ if((!_state->definitionViews.isEmpty() || (flags() & ConverterFlag::PreprocessOnly)) && !(converter->features() & ConverterFeature::Preprocess)) { Error{} << "ShaderTools::AnyConverter::validateFile():" << metadata->name() << "does not support preprocessing"; return {}; } /* Propagate input/output version and flags */ converter->setFlags(flags()); converter->setInputFormat(_state->inputFormat, _state->inputVersion); converter->setOutputFormat(_state->outputFormat, _state->outputVersion); /* Propagate definitions, if any */ if(!_state->definitionViews.isEmpty()) converter->setDefinitions(_state->definitionViews); /* Propagate configuration */ Magnum::Implementation::propagateConfiguration("ShaderTools::AnyConverter::validateFile():", {}, metadata->name(), configuration(), converter->configuration()); /* Try to validate the file (error output should be printed by the plugin itself) */ return converter->validateFile(stage, filename); } std::pair AnyConverter::doValidateData(const Stage stage, const Containers::ArrayView data) { CORRADE_INTERNAL_ASSERT(manager()); /* Decide on a plugin name based on the format */ if(_state->inputFormat == Format::Unspecified) { Error{} << "ShaderTools::AnyConverter::validateData(): no input format specified"; return {}; } const std::string plugin = Utility::formatString("{}ShaderConverter", stringForFormat(_state->inputFormat)); /* Try to load the plugin */ if(!(manager()->load(plugin) & PluginManager::LoadState::Loaded)) { Error{} << "ShaderTools::AnyConverter::validateData(): cannot load the" << plugin << "plugin"; return {}; } const PluginManager::PluginMetadata* const metadata = manager()->metadata(plugin); CORRADE_INTERNAL_ASSERT(metadata); if(flags() & ConverterFlag::Verbose) { Debug d; d << "ShaderTools::AnyConverter::validateData(): using" << plugin; if(plugin != metadata->name()) d << "(provided by" << metadata->name() << Debug::nospace << ")"; } /* Instantiate the plugin */ Containers::Pointer converter = static_cast*>(manager())->instantiate(plugin); /* Check that it can actually validate */ if(!(converter->features() & ConverterFeature::ValidateData)) { Error{} << "ShaderTools::AnyConverter::validateData():" << metadata->name() << "does not support validation"; return {}; } /* Check that it can preprocess, in case we were asked to preprocess */ if((!_state->definitionViews.isEmpty() || (flags() & ConverterFlag::PreprocessOnly)) && !(converter->features() & ConverterFeature::Preprocess)) { Error{} << "ShaderTools::AnyConverter::validateData():" << metadata->name() << "does not support preprocessing"; return {}; } /* Propagate input/output version and flags */ converter->setFlags(flags()); converter->setInputFormat(_state->inputFormat, _state->inputVersion); converter->setOutputFormat(_state->outputFormat, _state->outputVersion); /* Propagate definitions, if any */ if(!_state->definitionViews.isEmpty()) converter->setDefinitions(_state->definitionViews); /* Propagate configuration */ Magnum::Implementation::propagateConfiguration("ShaderTools::AnyConverter::validateData():", {}, metadata->name(), configuration(), converter->configuration()); /* Try to validate the data (error output should be printed by the plugin itself) */ return converter->validateData(stage, data); } bool AnyConverter::doConvertFileToFile(const Stage stage, const Containers::StringView from, const Containers::StringView to) { CORRADE_INTERNAL_ASSERT(manager()); /* Prefer the explicitly set input format. If not set, fall back to detecting based on input and output extension. */ const Containers::StringView formatFrom = stringForFormat( _state->inputFormat != Format::Unspecified ? _state->inputFormat : formatForExtension("ShaderTools::AnyConverter::convertFileToFile():", from) ); if(formatFrom.isEmpty()) return {}; const Containers::StringView formatTo = stringForFormat( _state->outputFormat != Format::Unspecified ? _state->outputFormat : formatForExtension("ShaderTools::AnyConverter::convertFileToFile():", to) ); if(formatTo.isEmpty()) return {}; /* Decide on a plugin name based on the format. This might result in invalid combinations such as SpirvToGlslShaderConverter which can't be really handled yet but I think that's okay for now. */ const std::string plugin = Utility::formatString( formatFrom == formatTo ? "{}ShaderConverter" : "{}To{}ShaderConverter", formatFrom, formatTo); /* Try to load the plugin */ if(!(manager()->load(plugin) & PluginManager::LoadState::Loaded)) { Error{} << "ShaderTools::AnyConverter::convertFileToFile(): cannot load the" << plugin << "plugin"; return {}; } const PluginManager::PluginMetadata* const metadata = manager()->metadata(plugin); CORRADE_INTERNAL_ASSERT(metadata); if(flags() & ConverterFlag::Verbose) { Debug d; d << "ShaderTools::AnyConverter::convertFileToFile(): using" << plugin; if(plugin != metadata->name()) d << "(provided by" << metadata->name() << Debug::nospace << ")"; } /* Instantiate the plugin */ Containers::Pointer converter = static_cast*>(manager())->instantiate(plugin); /* Check that it can actually convert */ if(!(converter->features() & ConverterFeature::ConvertFile)) { Error{} << "ShaderTools::AnyConverter::convertFileToFile():" << metadata->name() << "does not support conversion"; return {}; } /* Check that it can preprocess, in case we were asked to preprocess */ if((!_state->definitionViews.isEmpty() || (flags() & ConverterFlag::PreprocessOnly)) && !(converter->features() & ConverterFeature::Preprocess)) { Error{} << "ShaderTools::AnyConverter::convertFileToFile():" << metadata->name() << "does not support preprocessing"; return {}; } /* Check that it can output debug info, in case we were asked to */ if(!_state->debugInfoLevel.isEmpty() && !(converter->features() & ConverterFeature::DebugInfo)) { Error{} << "ShaderTools::AnyConverter::convertFileToFile():" << metadata->name() << "does not support controlling debug info output"; return {}; } /* Check that it can optimize, in case we were asked to */ if(!_state->optimizationLevel.isEmpty() && !(converter->features() & ConverterFeature::Optimize)) { Error{} << "ShaderTools::AnyConverter::convertFileToFile():" << metadata->name() << "does not support optimization"; return {}; } /* Propagate input/output version and flags */ converter->setFlags(flags()); converter->setInputFormat(_state->inputFormat, _state->inputVersion); converter->setOutputFormat(_state->outputFormat, _state->outputVersion); /* Propagate definitions and debug info, if any */ if(!_state->definitionViews.isEmpty()) converter->setDefinitions(_state->definitionViews); if(!_state->debugInfoLevel.isEmpty()) converter->setDebugInfoLevel(_state->debugInfoLevel); if(!_state->optimizationLevel.isEmpty()) converter->setOptimizationLevel(_state->optimizationLevel); /* Propagate configuration */ Magnum::Implementation::propagateConfiguration("ShaderTools::AnyConverter::convertFileToFile():", {}, metadata->name(), configuration(), converter->configuration()); /* Try to convert the file (error output should be printed by the plugin itself) */ return converter->convertFileToFile(stage, from, to); } Containers::Array AnyConverter::doConvertFileToData(const Stage stage, const Containers::StringView filename) { CORRADE_INTERNAL_ASSERT(manager()); /* Prefer the explicitly set input format. If not set, fall back to detecting based on input and output extension. */ const Containers::StringView formatFrom = stringForFormat( _state->inputFormat != Format::Unspecified ? _state->inputFormat : formatForExtension("ShaderTools::AnyConverter::convertFileToData():", filename) ); if(formatFrom.isEmpty()) return {}; if(_state->outputFormat == Format::Unspecified) { Error{} << "ShaderTools::AnyConverter::convertFileToData(): no output format specified"; return {}; } const Containers::StringView formatTo = stringForFormat(_state->outputFormat); /* Decide on a plugin name based on the format. This might result in invalid combinations such as SpirvToGlslShaderConverter which can't be really handled yet but I think that's okay for now. */ const std::string plugin = Utility::formatString( formatFrom == formatTo ? "{}ShaderConverter" : "{}To{}ShaderConverter", formatFrom, formatTo); /* Try to load the plugin */ if(!(manager()->load(plugin) & PluginManager::LoadState::Loaded)) { Error{} << "ShaderTools::AnyConverter::convertFileToData(): cannot load the" << plugin << "plugin"; return {}; } const PluginManager::PluginMetadata* const metadata = manager()->metadata(plugin); CORRADE_INTERNAL_ASSERT(metadata); if(flags() & ConverterFlag::Verbose) { Debug d; d << "ShaderTools::AnyConverter::convertFileToData(): using" << plugin; if(plugin != metadata->name()) d << "(provided by" << metadata->name() << Debug::nospace << ")"; } /* Instantiate the plugin */ Containers::Pointer converter = static_cast*>(manager())->instantiate(plugin); /* Check that it can actually convert */ if(!(converter->features() & ConverterFeature::ConvertData)) { Error{} << "ShaderTools::AnyConverter::convertFileToData():" << metadata->name() << "does not support conversion"; return {}; } /* Check that it can preprocess, in case we were asked to preprocess */ if((!_state->definitionViews.isEmpty() || (flags() & ConverterFlag::PreprocessOnly)) && !(converter->features() & ConverterFeature::Preprocess)) { Error{} << "ShaderTools::AnyConverter::convertFileToData():" << metadata->name() << "does not support preprocessing"; return {}; } /* Check that it can output debug info, in case we were asked to */ if(!_state->debugInfoLevel.isEmpty() && !(converter->features() & ConverterFeature::DebugInfo)) { Error{} << "ShaderTools::AnyConverter::convertFileToData():" << metadata->name() << "does not support controlling debug info output"; return {}; } /* Check that it can optimize, in case we were asked to */ if(!_state->optimizationLevel.isEmpty() && !(converter->features() & ConverterFeature::Optimize)) { Error{} << "ShaderTools::AnyConverter::convertFileToData():" << metadata->name() << "does not support optimization"; return {}; } /* Propagate input/output version and flags */ converter->setFlags(flags()); converter->setInputFormat(_state->inputFormat, _state->inputVersion); converter->setOutputFormat(_state->outputFormat, _state->outputVersion); /* Propagate definitions and debug info, if any */ if(!_state->definitionViews.isEmpty()) converter->setDefinitions(_state->definitionViews); if(!_state->debugInfoLevel.isEmpty()) converter->setDebugInfoLevel(_state->debugInfoLevel); if(!_state->optimizationLevel.isEmpty()) converter->setOptimizationLevel(_state->optimizationLevel); /* Propagate configuration */ Magnum::Implementation::propagateConfiguration("ShaderTools::AnyConverter::convertFileToData():", {}, metadata->name(), configuration(), converter->configuration()); /* Try to convert the file (error output should be printed by the plugin itself) */ return converter->convertFileToData(stage, filename); } Containers::Array AnyConverter::doConvertDataToData(const Stage stage, const Containers::ArrayView from) { CORRADE_INTERNAL_ASSERT(manager()); /* Decide on a plugin name based on the format. This might result in invalid combinations such as SpirvToGlslShaderConverter which can't be really handled yet but I think that's okay for now. */ if(_state->inputFormat == Format::Unspecified) { Error{} << "ShaderTools::AnyConverter::convertDataToData(): no input format specified"; return {}; } if(_state->outputFormat == Format::Unspecified) { Error{} << "ShaderTools::AnyConverter::convertDataToData(): no output format specified"; return {}; } const Containers::StringView formatFrom = stringForFormat(_state->inputFormat); const Containers::StringView formatTo = stringForFormat(_state->outputFormat); const std::string plugin = Utility::formatString( formatFrom == formatTo ? "{}ShaderConverter" : "{}To{}ShaderConverter", formatFrom, formatTo); /* Try to load the plugin */ if(!(manager()->load(plugin) & PluginManager::LoadState::Loaded)) { Error{} << "ShaderTools::AnyConverter::convertDataToData(): cannot load the" << plugin << "plugin"; return {}; } const PluginManager::PluginMetadata* const metadata = manager()->metadata(plugin); CORRADE_INTERNAL_ASSERT(metadata); if(flags() & ConverterFlag::Verbose) { Debug d; d << "ShaderTools::AnyConverter::convertDataToData(): using" << plugin; if(plugin != metadata->name()) d << "(provided by" << metadata->name() << Debug::nospace << ")"; } /* Instantiate the plugin */ Containers::Pointer converter = static_cast*>(manager())->instantiate(plugin); /* Check that it can actually convert */ if(!(converter->features() & ConverterFeature::ConvertData)) { Error{} << "ShaderTools::AnyConverter::convertDataToData():" << metadata->name() << "does not support conversion"; return {}; } /* Check that it can preprocess, in case we were asked to preprocess */ if((!_state->definitionViews.isEmpty() || (flags() & ConverterFlag::PreprocessOnly)) && !(converter->features() & ConverterFeature::Preprocess)) { Error{} << "ShaderTools::AnyConverter::convertDataToData():" << metadata->name() << "does not support preprocessing"; return {}; } /* Check that it can output debug info, in case we were asked to */ if(!_state->debugInfoLevel.isEmpty() && !(converter->features() & ConverterFeature::DebugInfo)) { Error{} << "ShaderTools::AnyConverter::convertDataToData():" << metadata->name() << "does not support controlling debug info output"; return {}; } /* Check that it can optimize, in case we were asked to */ if(!_state->optimizationLevel.isEmpty() && !(converter->features() & ConverterFeature::Optimize)) { Error{} << "ShaderTools::AnyConverter::convertDataToData():" << metadata->name() << "does not support optimization"; return {}; } /* Propagate input/output version and flags */ converter->setFlags(flags()); converter->setInputFormat(_state->inputFormat, _state->inputVersion); converter->setOutputFormat(_state->outputFormat, _state->outputVersion); /* Propagate definitions and debug info, if any */ if(!_state->definitionViews.isEmpty()) converter->setDefinitions(_state->definitionViews); if(!_state->debugInfoLevel.isEmpty()) converter->setDebugInfoLevel(_state->debugInfoLevel); if(!_state->optimizationLevel.isEmpty()) converter->setOptimizationLevel(_state->optimizationLevel); /* Propagate configuration */ Magnum::Implementation::propagateConfiguration("ShaderTools::AnyConverter::convertDataToData():", {}, metadata->name(), configuration(), converter->configuration()); /* Try to convert the file (error output should be printed by the plugin itself) */ return converter->convertDataToData(stage, from); } }} CORRADE_PLUGIN_REGISTER(AnyShaderConverter, Magnum::ShaderTools::AnyConverter, "cz.mosra.magnum.ShaderTools.AbstractConverter/0.1")