Set bytes planes to non-zero for supercompressed formats. (#988)

* Changes ktxTexture2 reader to reconstruct the bytes planes values on
  initial construction, if they are zero, and removes post inflation
  reconstruction.

* Changes deflators to keep original bytesPlanes.

* Changes BasisLZ/ETC1S encoder to set bytesPlanes values in newly
  encoded texture.

* Changes validator to check bytesPlanes for all formats, including
  supercompressed, and to issue a warning if bytes planes are zero
  (unsized).

The PR includes a hack command for `ktx` that aided in patching the vast
number of test files. This will not be built, in the normal course of
development, or released but is being included in the repo to keep for
possible future use.

Author: MarkCallow

external/dfdutils/dfd.h

@@ -194,21 +194,21 @@ void printDFDJSON(uint32_t *DFD, uint32_t dataSize, uint32_t base_indent, uint32
 /* Get the number of components & component size from a DFD for an
  * unpacked format.
  */
-void
-getDFDComponentInfoUnpacked(const uint32_t* DFD, uint32_t* numComponents,
-                            uint32_t* componentByteLength);
+void getDFDComponentInfoUnpacked(const uint32_t* DFD, uint32_t* numComponents,
+                                 uint32_t* componentByteLength);
 
 /* Return the number of components described by a DFD. */
 uint32_t getDFDNumComponents(const uint32_t* DFD);
 
-/* Reconstruct and return the value of bytesPlane0 as it should be for the data
- * post-inflation from variable-rate compression.
+/* Reconstruct and update the bytesPlane[0-4] fields of an unsized DFD to what
+ * they were before supercompression.
  */
-uint32_t
-reconstructDFDBytesPlane0FromSamples(const uint32_t* DFD);
+void reconstructDFDBytesPlanesFromSamples(uint32_t* DFD);
 /* Deprecated. For backward compatibility. */
-void
-recreateBytesPlane0FromSampleInfo(const uint32_t* DFD, uint32_t* bytesPlane0);
+uint32_t reconstructDFDBytesPlane0FromSamples(const uint32_t* DFD);
+/* Deprecated. For backward compatibility. */
+void recreateBytesPlane0FromSampleInfo(const uint32_t* DFD,
+                                       uint32_t* bytesPlane0);
 
 /** @brief Colourspace primaries information.
  *

external/dfdutils/queries.c

@@ -97,19 +97,23 @@ uint32_t getDFDNumComponents(const uint32_t* DFD)
     return numComponents;
 }
 
-
 /**
  * @~English
  * @brief Reconstruct the value of bytesPlane0 from sample info.
  *
- * Reconstruct the value for data that has been variable-rate compressed so
- * has bytesPlane0 = 0.  For DFDs that are valid for KTX files. Little-endian
- * data only and no multi-plane formats.
+ * @deprecated Use reconstructDFDBytesPlanesFromSamples. This does not handle
+ *             the possible second plane of the ETC1S model.
  *
- * @param DFD Pointer to a Data Format Descriptor for which,
- *            described as 32-bit words in native endianness.
+ * Reconstruct the value for data that has been variable-rate compressed
+ * and and whose bytesPlane0 value has been set to 0.  For DFDs that
+ * are valid for KTX files. Little-endian data only and no multi-plane models
+ * except ETC1S.
+ *
+ * @param DFD Pointer to the Data Format Descriptor for which to provide
+ *            the value described as 32-bit words in native endianness.
  *            Note that this is the whole descriptor, not just
  *            the basic descriptor block.
+ * @return The number of bytes a pixel occupies in bytesPlane0.
  */
 uint32_t
 reconstructDFDBytesPlane0FromSamples(const uint32_t* DFD)
@@ -143,6 +147,10 @@ reconstructDFDBytesPlane0FromSamples(const uint32_t* DFD)
             }
         }
     }
+    if (KHR_DFDVAL(BDFDB, MODEL) == KHR_DF_MODEL_ETC1S) {
+        // Size of the first plane.
+        return 8;
+    }
     for (sampleNumber = 0; sampleNumber < numSamples; ++sampleNumber) {
         int32_t sampleBitOffset = KHR_DFDSVAL(BDFDB, sampleNumber, BITOFFSET);
         if (sampleBitOffset > largestOffset) {
@@ -157,16 +165,44 @@ reconstructDFDBytesPlane0FromSamples(const uint32_t* DFD)
     return bitsPlane0 >> 3U;
 }
 
+/**
+ * @~English
+ * @brief Reconstruct the values of bytesPlane[01] from sample info.
+ *
+ * Reconstruct the values for data that has been variable-rate compressed
+ * and whose bytesPlane[01] values have been set to 0 and update the
+ * fields of the target DFD. For DFDs that are valid for KTX files.
+ * Little-endian data only and no multi-plane models except ETC1S hence
+ * only looking at bytesPlane0 abd bytesPlane1.
+ *
+ * @param DFD Pointer to a Data Format Descriptor for which,
+ *            described as 32-bit words in native endianness.
+ *            Note that this is the whole descriptor, not just
+ *            the basic descriptor block.
+ */
+
+void
+reconstructDFDBytesPlanesFromSamples(uint32_t* DFD)
+{
+    uint32_t *BDFDB = DFD+1;
+
+    KHR_DFDSETVAL(BDFDB, BYTESPLANE0, reconstructDFDBytesPlane0FromSamples(DFD));
+    if (KHR_DFDVAL(BDFDB, MODEL) == KHR_DF_MODEL_ETC1S) {
+        if (KHR_DFDSAMPLECOUNT(BDFDB) == 2)
+            KHR_DFDSETVAL(BDFDB, BYTESPLANE1, 8);
+    }
+}
+
 /**
  * @~English
  * @brief Reconstruct the value of bytesPlane0 from sample info.
  *
  * @see reconstructDFDBytesPlane0FromSamples for details.
  * @deprecated For backward comparibility only. Use
- *             reconstructDFDBytesPlane0FromSamples.
+ *             reconstructDFDBytesPlanesFromSamples.
  *
- * @param DFD Pointer to a Data Format Descriptor for which,
- *            described as 32-bit words in native endianness.
+ * @param DFD Pointer to the Data Format Descriptor for which to provide
+ *            the value described as 32-bit words in native endianness.
  *            Note that this is the whole descriptor, not just
  *            the basic descriptor block.
  * @param bytesPlane0  pointer to a 32-bit word in which the recreated

include/ktx.h

@@ -1036,6 +1036,9 @@ ktxTexture1_Destroy(ktxTexture1* This);
 KTX_API ktx_bool_t KTX_APIENTRY
 ktxTexture1_NeedsTranscoding(ktxTexture1* This);
 
+KTX_API ktx_error_code_e KTX_APIENTRY
+ktxTexture1_LoadImageData(ktxTexture1* This, ktx_uint8_t* pBuffer, ktx_size_t bufSize);
+
 /*
  * These four write a ktxTexture1 object to a KTX v1 file.
  */
@@ -1131,7 +1134,7 @@ ktxTexture2_GetNumComponents(ktxTexture2* This);
 
 KTX_API khr_df_transfer_e KTX_APIENTRY
 ktxTexture2_GetTransferFunction_e(ktxTexture2* This);
-// For backward compatibility
+/* For backward compatibility. */
 KTX_API khr_df_transfer_e KTX_APIENTRY
 ktxTexture2_GetOETF_e(ktxTexture2* This);
 KTX_API ktx_uint32_t KTX_APIENTRY
@@ -1150,14 +1153,23 @@ KTX_API ktx_bool_t KTX_APIENTRY
 ktxTexture2_NeedsTranscoding(ktxTexture2* This);
 
 KTX_API ktx_error_code_e KTX_APIENTRY
-ktxTexture2_SeTransferFunction(ktxTexture2* This, khr_df_transfer_e oetf);
-// For backward compatibility
+ktxTexture2_SetTransferFunction(ktxTexture2* This, khr_df_transfer_e tf);
+/* For backward compatibility. */
 KTX_API ktx_error_code_e KTX_APIENTRY
 ktxTexture2_SetOETF(ktxTexture2* This, khr_df_transfer_e oetf);
 
 KTX_API ktx_error_code_e KTX_APIENTRY
 ktxTexture2_SetPrimaries(ktxTexture2* This, khr_df_primaries_e primaries);
 
+KTX_API ktx_error_code_e KTX_APIENTRY
+ktxTexture2_LoadImageData(ktxTexture2* This, ktx_uint8_t* pBuffer, ktx_size_t bufSize);
+/*
+ * For rare testing scenarios. Use ktxTexture2_LoadImageData.
+ */
+KTX_API ktx_error_code_e KTX_APIENTRY
+ktxTexture2_LoadDeflatedImageData(ktxTexture2* This,
+                                  ktx_uint8_t* pBuffer, ktx_size_t bufSize);
+
 /*
  * These four write a ktxTexture2 object to a KTX v2 file.
  */

lib/astc_codec.cpp

@@ -53,7 +53,7 @@ pthread_create(pthread_t* thread, const pthread_attr_t* attribs,
     #pragma clang diagnostic push
     #pragma clang diagnostic ignored "-Wcast-function-type-mismatch"
 #endif
-    LPTHREAD_START_ROUTINE func = reinterpret_cast<LPTHREAD_START_ROUTINE>(threadfunc);
+    LPTHREAD_START_ROUTINE func = (LPTHREAD_START_ROUTINE)(threadfunc);
 #ifdef __clang__
     #pragma clang diagnostic pop
 #endif

lib/basis_encode.cpp

@@ -264,8 +264,10 @@ ktxTexture2_rewriteDfd4BasisLzETC1S(ktxTexture2* This,
 
     nbdb[KHR_DF_WORD_TEXELBLOCKDIMENSION0] =
                             3 | (3 << KHR_DF_SHIFT_TEXELBLOCKDIMENSION1);
-    // Show it describes an unsized format.
     nbdb[KHR_DF_WORD_BYTESPLANE0] = 0; /* bytesPlane3..0 = 0 */
+    KHR_DFDSETVAL(nbdb, BYTESPLANE0, 8);
+    if (alphaContent != eNone)
+        KHR_DFDSETVAL(nbdb, BYTESPLANE1, 8);
     nbdb[KHR_DF_WORD_BYTESPLANE4] = 0; /* bytesPlane7..5 = 0 */
 
     for (uint32_t sample = 0; sample < newSampleCount; sample++) {

lib/gl_funcs.c

@@ -155,7 +155,7 @@ ktxFindOpenGL() {
 #endif
         pfnWglGetProcAddress =
             (PFNGLGETPROCADDRESS)GetProcAddress(module,
-                                               "wglGetProcAddress");
+                                                "wglGetProcAddress");
 #ifdef __clang__
     #pragma clang diagnostic pop
 #endif

lib/internalexport.def

@@ -43,7 +43,7 @@ EXPORTS
     ktxTexture2_GetImageOffset
     ktxTexture2_calcLevelOffset
     ktxTexture2_destruct
-    reconstructDFDBytesPlane0FromSamples
+    reconstructDFDBytesPlanesFromSamples
     stringToVkFormat
     vk2dfd
     vkFormatString

lib/internalexport_mingw.def

@@ -43,7 +43,7 @@ EXPORTS
     ktxTexture2_GetImageOffset
     ktxTexture2_calcLevelOffset
     ktxTexture2_destruct
-    reconstructDFDBytesPlane0FromSamples
+    reconstructDFDBytesPlanesFromSamples
     stringToVkFormat
     vk2dfd
     vkFormatString