KTX compare tool - phase 1

Draft implementation for the compare tool with no image comparison yet. Basic test set covering the following: * Help * Command line errors * Use with invalid files without the "allow-invalid-input" flag * Use with invalid files with the "allow-invalid-input" flag * Unicode filename support
KhronosGroup · Dec 7, 2023 · 77c715c · 77c715c
1 parent d3ef5ed
commit 77c715c
Show file tree

Hide file tree

Showing 14 changed files with 3,208 additions and 67 deletions.
diff --git a/cmake/docs.cmake b/cmake/docs.cmake
@@ -154,6 +154,7 @@ function( CreateDocTools )
     doxygen_add_docs(
         tools.doc
         tools/ktx/ktx_main.cpp
+        tools/ktx/command_compare.cpp
         tools/ktx/command_create.cpp
         tools/ktx/command_encode.cpp
         tools/ktx/command_extract.cpp

diff --git a/lib/dfdutils/printdfd.c b/lib/dfdutils/printdfd.c
@@ -245,7 +245,7 @@ const char* dfdToStringColorModel(khr_df_model_e value) {
     return NULL;
 }
 
-const char* dfdToStringSampleDatatypeQualifiers(uint32_t bit_index, bool bit_value) {
+const char* dfdToStringSampleDatatypeQualifiersBit(uint32_t bit_index, bool bit_value) {
     if (!bit_value)
         return NULL;
 
@@ -782,7 +782,7 @@ void printDFD(uint32_t *DFD, uint32_t dataSize)
 
                 khr_df_sample_datatype_qualifiers_e qualifiers = KHR_DFDSVAL(block, sample, QUALIFIERS);
                 printf("    Qualifiers: 0x%X (", qualifiers);
-                printFlagBits(qualifiers, dfdToStringSampleDatatypeQualifiers);
+                printFlagBits(qualifiers, dfdToStringSampleDatatypeQualifiersBit);
                 printf(")\n");
                 printf("    Channel Type: 0x%X", channelType);
                 {
@@ -960,7 +960,7 @@ void printDFDJSON(uint32_t* DFD, uint32_t dataSize, uint32_t base_indent, uint32
 
                 } else {
                     PRINT_INDENT(4, "\"qualifiers\":%s[%s", space, nl)
-                    printFlagBitsJSON(LENGTH_OF_INDENT(5), nl, qualifiers, dfdToStringSampleDatatypeQualifiers);
+                    printFlagBitsJSON(LENGTH_OF_INDENT(5), nl, qualifiers, dfdToStringSampleDatatypeQualifiersBit);
                     PRINT_INDENT(4, "],%s", nl)
                 }
 

diff --git a/lib/internalexport_write.def b/lib/internalexport_write.def
@@ -21,7 +21,10 @@ EXPORTS
     dfdToStringColorModel
     dfdToStringColorPrimaries
     dfdToStringDescriptorType
+    dfdToStringFlagsBit
+    dfdToStringSampleDatatypeQualifiersBit
     dfdToStringTransferFunction
     dfdToStringVendorID
     dfdToStringVersionNumber
+    ktxBUImageFlagsBitString
     ktxTexture2_constructCopy
diff --git a/lib/internalexport_write_mingw.def b/lib/internalexport_write_mingw.def
@@ -21,7 +21,10 @@ EXPORTS
     dfdToStringColorModel
     dfdToStringColorPrimaries
     dfdToStringDescriptorType
+    dfdToStringFlagsBit
+    dfdToStringSampleDatatypeQualifiersBit
     dfdToStringTransferFunction
     dfdToStringVendorID
     dfdToStringVersionNumber
+    ktxBUImageFlagsBitString
     ktxTexture2_constructCopy
diff --git a/tests/cts b/tests/cts
diff --git a/tools/ktx/CMakeLists.txt b/tools/ktx/CMakeLists.txt
@@ -6,6 +6,7 @@
 add_executable(ktxtools
         command.cpp
         command.h
+        command_compare.cpp
         command_create.cpp
         command_encode.cpp
         command_extract.cpp

diff --git a/tools/ktx/command.h b/tools/ktx/command.h
@@ -77,6 +77,7 @@ enum class ReturnCode {
     DFD_FAILURE = RUNTIME_ERROR,
     NOT_SUPPORTED = 5,
     NOT_IMPLEMENTED = 6,
+    DIFFERENCE_FOUND = 7
 };
 using rc = ReturnCode;
 
@@ -358,6 +359,10 @@ class InputStream {
 public:
     InputStream(const std::string& filepath, Reporter& report);
 
+    const std::string& str() {
+        return filepath;
+    }
+
     /*explicit(false)*/ operator std::istream&() {
         return *activeStream;
     }
@@ -380,6 +385,11 @@ class OutputStream {
 public:
     OutputStream(const std::string& filepath, Reporter& report);
     ~OutputStream();
+
+    const std::string& str() {
+        return filepath;
+    }
+
     void writeKTX2(ktxTexture* texture, Reporter& report);
     void write(const char* data, std::size_t size, Reporter& report);
 };