Rename EncodeCodec to BasisCodec in preparation for separating encode tools

Author: wasimabbas-arm

tools/ktx/command_create.cpp

@@ -906,15 +906,15 @@ void CommandCreate::processOptions(cxxopts::Options& opts, cxxopts::ParseResult&
                 options.inputFilepaths.size(), expectedInputImages);
     }
 
-    if (options.codec == EncodeCodec::BasisLZ) {
+    if (options.codec == BasisCodec::BasisLZ) {
         if (options.zstd.has_value())
             fatal_usage("Cannot encode to BasisLZ and supercompress with Zstd.");
 
         if (options.zlib.has_value())
             fatal_usage("Cannot encode to BasisLZ and supercompress with ZLIB.");
     }
 
-    if (options.codec != EncodeCodec::NONE) {
+    if (options.codec != BasisCodec::NONE) {
         switch (options.vkFormat) {
         case VK_FORMAT_R8_UNORM:
         case VK_FORMAT_R8_SRGB:
@@ -933,7 +933,7 @@ void CommandCreate::processOptions(cxxopts::Options& opts, cxxopts::ParseResult&
         }
     }
 
-    const auto canCompare = options.codec == EncodeCodec::BasisLZ || options.codec == EncodeCodec::UASTC;
+    const auto canCompare = options.codec == BasisCodec::BasisLZ || options.codec == BasisCodec::UASTC;
     if (options.compare_ssim && !canCompare)
         fatal_usage("--compare-ssim can only be used with BasisLZ or UASTC encoding.");
     if (options.compare_psnr && !canCompare)
@@ -1270,7 +1270,7 @@ void CommandCreate::encode(KTXTexture2& texture, OptionsCodec<false>& opts) {
     MetricsCalculator metrics;
     metrics.saveReferenceImages(texture, options, *this);
 
-    if (opts.codec != EncodeCodec::NONE) {
+    if (opts.codec != BasisCodec::NONE) {
         auto ret = ktxTexture2_CompressBasisEx(texture, &opts);
         if (ret != KTX_SUCCESS)
             fatal(rc::KTX_FAILURE, "Failed to encode KTX2 file with codec \"{}\". KTX Error: {}",

tools/ktx/command_encode.cpp

@@ -128,15 +128,15 @@ void CommandEncode::processOptions(cxxopts::Options& opts, cxxopts::ParseResult&
 
     fillCodecOptions<decltype(options), ktxBasisParams>(options);
 
-    if (options.codec == EncodeCodec::BasisLZ) {
+    if (options.codec == BasisCodec::BasisLZ) {
         if (options.zstd.has_value())
             fatal_usage("Cannot encode to BasisLZ and supercompress with Zstd.");
 
         if (options.zlib.has_value())
             fatal_usage("Cannot encode to BasisLZ and supercompress with ZLIB.");
     }
 
-    const auto canCompare = options.codec == EncodeCodec::BasisLZ || options.codec == EncodeCodec::UASTC;
+    const auto canCompare = options.codec == BasisCodec::BasisLZ || options.codec == BasisCodec::UASTC;
     if (options.compare_ssim && !canCompare)
         fatal_usage("--compare-ssim can only be used with BasisLZ or UASTC encoding.");
     if (options.compare_psnr && !canCompare)

tools/ktx/encode_utils.h

@@ -14,7 +14,7 @@
 
 namespace ktx {
 
-enum class EncodeCodec {
+enum class BasisCodec {
     NONE = 0,
     BasisLZ,
     UASTC,
@@ -217,7 +217,7 @@ struct OptionsCodec : public ktxBasisParams {
 
     std::string codecOptions{};
     std::string codecName;
-    EncodeCodec codec;
+    BasisCodec codec;
 
     void init(cxxopts::Options& opts) {
         opts.add_options("Encode BasisLZ")
@@ -269,20 +269,20 @@ struct OptionsCodec : public ktxBasisParams {
             (kUastcRdoM, "Disable RDO multithreading (slightly higher compression, deterministic).");
     }
 
-    EncodeCodec validateEncodeCodec(const cxxopts::OptionValue& codecOpt) const {
-        static const std::unordered_map<std::string, EncodeCodec> codecs = {
-            { "basis-lz", EncodeCodec::BasisLZ },
-            { "uastc", EncodeCodec::UASTC }
+    BasisCodec validateEncodeCodec(const cxxopts::OptionValue& codecOpt) const {
+        static const std::unordered_map<std::string, BasisCodec> codecs = {
+            { "basis-lz", BasisCodec::BasisLZ },
+            { "uastc", BasisCodec::UASTC }
         };
         if (codecOpt.count()) {
             auto it = codecs.find(to_lower_copy(codecOpt.as<std::string>()));
             if (it != codecs.end()) {
                 return it->second;
             } else {
-                return EncodeCodec::INVALID;
+                return BasisCodec::INVALID;
             }
         } else {
-            return EncodeCodec::NONE;
+            return BasisCodec::NONE;
         }
     }
 
@@ -298,13 +298,13 @@ struct OptionsCodec : public ktxBasisParams {
     }
 
     void validateCommonEncodeArg(Reporter& report, const char* name) {
-        if (codec == EncodeCodec::NONE)
+        if (codec == BasisCodec::NONE)
             report.fatal(rc::INVALID_ARGUMENTS,
                 "Invalid use of argument --{} that only applies to encoding.", name);
     }
 
     void validateBasisLZArg(Reporter& report, const char* name) {
-        if (codec != EncodeCodec::BasisLZ)
+        if (codec != BasisCodec::BasisLZ)
             report.fatal(rc::INVALID_ARGUMENTS,
                 "Invalid use of argument --{} that only applies when the used codec is BasisLZ.", name);
     }
@@ -324,7 +324,7 @@ struct OptionsCodec : public ktxBasisParams {
     }
 
     void validateUASTCArg(Reporter& report, const char* name) {
-        if (codec != EncodeCodec::UASTC)
+        if (codec != BasisCodec::UASTC)
             report.fatal(rc::INVALID_ARGUMENTS,
                 "Invalid use of argument --{} that only applies when the used codec is UASTC.", name);
     }
@@ -341,12 +341,12 @@ struct OptionsCodec : public ktxBasisParams {
             // "encode" command - required "codec" argument
             codec = validateEncodeCodec(args["codec"]);
             switch (codec) {
-            case EncodeCodec::NONE:
+            case BasisCodec::NONE:
                 report.fatal(rc::INVALID_ARGUMENTS, "Missing codec argument.");
                 break;
 
-            case EncodeCodec::BasisLZ:
-            case EncodeCodec::UASTC:
+            case BasisCodec::BasisLZ:
+            case BasisCodec::UASTC:
                 codecName = to_lower_copy(args["codec"].as<std::string>());
                 break;
 
@@ -358,12 +358,12 @@ struct OptionsCodec : public ktxBasisParams {
             // "create" command - optional "encode" argument
             codec = validateEncodeCodec(args["encode"]);
             switch (codec) {
-            case EncodeCodec::NONE:
+            case BasisCodec::NONE:
                 // Not specified
                 break;
 
-            case EncodeCodec::BasisLZ:
-            case EncodeCodec::UASTC:
+            case BasisCodec::BasisLZ:
+            case BasisCodec::UASTC:
                 codecName = to_lower_copy(args["encode"].as<std::string>());
                 break;
 
@@ -373,7 +373,7 @@ struct OptionsCodec : public ktxBasisParams {
             }
         }
 
-        if (codec == EncodeCodec::UASTC) {
+        if (codec == BasisCodec::UASTC) {
             uastc = 1;
         }