diasurgical · glebm · Oct 12, 2024 · Oct 12, 2024 · Oct 12, 2024 · Oct 12, 2024
diff --git a/Source/engine/clx_sprite.hpp b/Source/engine/clx_sprite.hpp
@@ -5,21 +5,20 @@
  * @brief CLX format sprites.
  *
  * CLX is a format used for DevilutionX graphics at runtime.
+ * CLX encodes pixel in the same way CL2 but encodes metadata differently.
  *
- * It is identical to CL2, except we use the frame header to store the frame's width and height.
+ * Unlike CL2:
  *
- * CLX frame header (10 bytes, same as CL2):
+ * 1. CLX frame header stores frame width and height.
+ * 2. CLX frame header does not store 32-pixel block offsets.
  *
- *      Bytes |   Type   | Value
- *     :-----:|:--------:|------------------------------------
- *      0..2  | uint16_t | offset to data start (same as CL2)
- *      2..4  | uint16_t | width
- *      4..6  | uint16_t | height
- *      6..10 |    -     | unused
+ * CLX frame header is 6 bytes:
  *
- * The CLX format is otherwise identical to CL2.
- *
- * Since the header is identical to CL2, CL2 can be converted to CLX without reallocation.
+ *  Bytes |   Type   | Value
+ * :-----:|:--------:|-------------
+ *  0..2  | uint16_t | header size
+ *  2..4  | uint16_t | width
+ *  4..6  | uint16_t | height
  *
  * CL2 reference: https://github.com/savagesteel/d1-file-formats/blob/master/PC-Mac/CL2.md#2-file-structure
  */
@@ -42,12 +41,10 @@ class OptionalClxSprite;
  * @brief A single CLX sprite.
  */
 class ClxSprite {
-	static constexpr uint32_t HeaderSize = 10;
-
 public:
 	explicit constexpr ClxSprite(const uint8_t *data, uint32_t dataSize)
 	    : data_(data)
-	    , pixel_data_size_(dataSize - HeaderSize)
+	    , pixel_data_size_(dataSize - LoadLE16(data))
 	{
 		assert(data != nullptr);
 	}
@@ -69,7 +66,7 @@ class ClxSprite {
 	 */
 	[[nodiscard]] constexpr const uint8_t *pixelData() const
 	{
-		return &data_[HeaderSize];
+		return &data_[LoadLE16(data_)];
 	}
 
 	[[nodiscard]] constexpr uint32_t pixelDataSize() const

diff --git a/Source/utils/cel_to_clx.cpp b/Source/utils/cel_to_clx.cpp
@@ -86,9 +86,8 @@ OwnedClxSpriteListOrSheet CelToClx(const uint8_t *data, size_t size, PointerOrVa
 
 			// CLX frame header.
 			const size_t frameHeaderPos = cl2Data.size();
-			constexpr size_t FrameHeaderSize = 10;
-			cl2Data.resize(cl2Data.size() + FrameHeaderSize);
-			WriteLE16(&cl2Data[frameHeaderPos], FrameHeaderSize);
+			cl2Data.resize(cl2Data.size() + ClxFrameHeaderSize);
+			WriteLE16(&cl2Data[frameHeaderPos], ClxFrameHeaderSize);
 			WriteLE16(&cl2Data[frameHeaderPos + 2], frameWidth);
 
 			unsigned transparentRunWidth = 0;
@@ -111,7 +110,6 @@ OwnedClxSpriteListOrSheet CelToClx(const uint8_t *data, size_t size, PointerOrVa
 				++frameHeight;
 			}
 			WriteLE16(&cl2Data[frameHeaderPos + 4], static_cast<uint16_t>(frameHeight));
-			memset(&cl2Data[frameHeaderPos + 6], 0, 4);
 			AppendClxTransparentRun(transparentRunWidth, cl2Data);
 		}
 

diff --git a/Source/utils/cl2_to_clx.cpp b/Source/utils/cl2_to_clx.cpp
@@ -56,9 +56,8 @@ uint16_t Cl2ToClx(const uint8_t *data, size_t size,
 			const uint16_t frameWidth = widthOrWidths.HoldsPointer() ? widthOrWidths.AsPointer()[frame - 1] : widthOrWidths.AsValue();
 
 			const size_t frameHeaderPos = clxData.size();
-			constexpr size_t FrameHeaderSize = 10;
-			clxData.resize(clxData.size() + FrameHeaderSize);
-			WriteLE16(&clxData[frameHeaderPos], FrameHeaderSize);
+			clxData.resize(clxData.size() + ClxFrameHeaderSize);
+			WriteLE16(&clxData[frameHeaderPos], ClxFrameHeaderSize);
 			WriteLE16(&clxData[frameHeaderPos + 2], frameWidth);
 
 			unsigned transparentRunWidth = 0;
@@ -104,7 +103,6 @@ uint16_t Cl2ToClx(const uint8_t *data, size_t size,
 			AppendClxTransparentRun(transparentRunWidth, clxData);
 
 			WriteLE16(&clxData[frameHeaderPos + 4], static_cast<uint16_t>(frameHeight));
-			memset(&clxData[frameHeaderPos + 6], 0, 4);
 		}
 
 		WriteLE32(&clxData[clxDataOffset + 4 * (1 + static_cast<size_t>(numFrames))], static_cast<uint32_t>(clxData.size() - clxDataOffset));

diff --git a/Source/utils/clx_encode.hpp b/Source/utils/clx_encode.hpp
@@ -6,6 +6,17 @@
 
 namespace devilution {
 
+/**
+ * CLX frame header is 6 bytes:
+ *
+ *  Bytes |   Type   | Value
+ * :-----:|:--------:|-------------
+ *  0..2  | uint16_t | header size
+ *  2..4  | uint16_t | width
+ *  4..6  | uint16_t | height
+ */
+constexpr size_t ClxFrameHeaderSize = 6;
+
 inline void AppendClxTransparentRun(unsigned width, std::vector<uint8_t> &out)
 {
 	while (width >= 0x7F) {

diff --git a/Source/utils/pcx_to_clx.cpp b/Source/utils/pcx_to_clx.cpp
@@ -98,20 +98,13 @@ OptionalOwnedClxSpriteList PcxToClx(AssetHandle &handle, size_t fileSize, int nu
 	for (unsigned frame = 1; frame <= numFrames; ++frame) {
 		WriteLE32(&cl2Data[4 * static_cast<size_t>(frame)], static_cast<uint32_t>(cl2Data.size()));
 
-		// Frame header: 5 16-bit values:
-		// 1. Offset to start of the pixel data.
-		// 2. Width
-		// 3. Height
-		// 4..5. Unused (0)
 		const size_t frameHeaderPos = cl2Data.size();
-		constexpr size_t FrameHeaderSize = 10;
-		cl2Data.resize(cl2Data.size() + FrameHeaderSize);
+		cl2Data.resize(cl2Data.size() + ClxFrameHeaderSize);
 
 		// Frame header:
-		WriteLE16(&cl2Data[frameHeaderPos], FrameHeaderSize);
+		WriteLE16(&cl2Data[frameHeaderPos], ClxFrameHeaderSize);
 		WriteLE16(&cl2Data[frameHeaderPos + 2], static_cast<uint16_t>(width));
 		WriteLE16(&cl2Data[frameHeaderPos + 4], static_cast<uint16_t>(frameHeight));
-		memset(&cl2Data[frameHeaderPos + 6], 0, 4);
 
 		for (unsigned j = 0; j < frameHeight; ++j) {
 			uint8_t *buffer = &frameBuffer[static_cast<size_t>(j) * width];

diff --git a/Source/utils/surface_to_clx.cpp b/Source/utils/surface_to_clx.cpp
@@ -31,20 +31,13 @@ OwnedClxSpriteList SurfaceToClx(const Surface &surface, unsigned numFrames,
 	for (unsigned frame = 1; frame <= numFrames; ++frame) {
 		WriteLE32(&clxData[4 * static_cast<size_t>(frame)], static_cast<uint32_t>(clxData.size()));
 
-		// Frame header: 5 16-bit values:
-		// 1. Offset to start of the pixel data.
-		// 2. Width
-		// 3. Height
-		// 4..5. Unused (0)
 		const size_t frameHeaderPos = clxData.size();
-		constexpr size_t FrameHeaderSize = 10;
-		clxData.resize(clxData.size() + FrameHeaderSize);
+		clxData.resize(clxData.size() + ClxFrameHeaderSize);
 
 		// Frame header:
-		WriteLE16(&clxData[frameHeaderPos], FrameHeaderSize);
+		WriteLE16(&clxData[frameHeaderPos], ClxFrameHeaderSize);
 		WriteLE16(&clxData[frameHeaderPos + 2], static_cast<uint16_t>(width));
 		WriteLE16(&clxData[frameHeaderPos + 4], static_cast<uint16_t>(frameHeight));
-		memset(&clxData[frameHeaderPos + 6], 0, 4);
 
 		unsigned transparentRunWidth = 0;
 		size_t line = 0;

diff --git a/assets/data/boxleftend.clx b/assets/data/boxleftend.clx
diff --git a/assets/data/boxmiddle.clx b/assets/data/boxmiddle.clx
diff --git a/assets/data/boxrightend.clx b/assets/data/boxrightend.clx
diff --git a/assets/data/charbg.clx b/assets/data/charbg.clx
diff --git a/assets/data/dirtybuc.clx b/assets/data/dirtybuc.clx
diff --git a/assets/data/dirtybucp.clx b/assets/data/dirtybucp.clx
diff --git a/assets/data/health.clx b/assets/data/health.clx
diff --git a/assets/data/healthbox.clx b/assets/data/healthbox.clx
diff --git a/assets/data/hintbox.clx b/assets/data/hintbox.clx
diff --git a/assets/data/hintboxbackground.clx b/assets/data/hintboxbackground.clx
diff --git a/assets/data/hinticons.clx b/assets/data/hinticons.clx
diff --git a/assets/data/monstertags.clx b/assets/data/monstertags.clx
diff --git a/assets/data/panel8buc.clx b/assets/data/panel8buc.clx
diff --git a/assets/data/panel8bucp.clx b/assets/data/panel8bucp.clx
diff --git a/assets/data/resistance.clx b/assets/data/resistance.clx
diff --git a/assets/data/stash.clx b/assets/data/stash.clx
diff --git a/assets/data/stashnavbtns.clx b/assets/data/stashnavbtns.clx
diff --git a/assets/data/talkbutton.clx b/assets/data/talkbutton.clx
diff --git a/assets/data/xpbar.clx b/assets/data/xpbar.clx
diff --git a/assets/fonts/12-00.clx b/assets/fonts/12-00.clx
diff --git a/assets/fonts/12-01.clx b/assets/fonts/12-01.clx
diff --git a/assets/fonts/12-02.clx b/assets/fonts/12-02.clx
diff --git a/assets/fonts/12-03.clx b/assets/fonts/12-03.clx
diff --git a/assets/fonts/12-04.clx b/assets/fonts/12-04.clx
diff --git a/assets/fonts/12-1f1.clx b/assets/fonts/12-1f1.clx
diff --git a/assets/fonts/12-1f3.clx b/assets/fonts/12-1f3.clx
diff --git a/assets/fonts/12-1f4.clx b/assets/fonts/12-1f4.clx
diff --git a/assets/fonts/12-1f5.clx b/assets/fonts/12-1f5.clx
diff --git a/assets/fonts/12-1f6.clx b/assets/fonts/12-1f6.clx
diff --git a/assets/fonts/12-1f9.clx b/assets/fonts/12-1f9.clx
diff --git a/assets/fonts/12-20.clx b/assets/fonts/12-20.clx
diff --git a/assets/fonts/12-26.clx b/assets/fonts/12-26.clx
diff --git a/assets/fonts/12-e0.clx b/assets/fonts/12-e0.clx
diff --git a/assets/fonts/22-00.clx b/assets/fonts/22-00.clx
diff --git a/assets/fonts/22-01.clx b/assets/fonts/22-01.clx
diff --git a/assets/fonts/22-02.clx b/assets/fonts/22-02.clx
diff --git a/assets/fonts/22-03.clx b/assets/fonts/22-03.clx
diff --git a/assets/fonts/22-04.clx b/assets/fonts/22-04.clx
diff --git a/assets/fonts/22-05.clx b/assets/fonts/22-05.clx
diff --git a/assets/fonts/22-20.clx b/assets/fonts/22-20.clx
diff --git a/assets/fonts/24-00.clx b/assets/fonts/24-00.clx
diff --git a/assets/fonts/24-01.clx b/assets/fonts/24-01.clx
diff --git a/assets/fonts/24-02.clx b/assets/fonts/24-02.clx
diff --git a/assets/fonts/24-03.clx b/assets/fonts/24-03.clx
diff --git a/assets/fonts/24-04.clx b/assets/fonts/24-04.clx
diff --git a/assets/fonts/24-1f1.clx b/assets/fonts/24-1f1.clx
diff --git a/assets/fonts/24-1f3.clx b/assets/fonts/24-1f3.clx
diff --git a/assets/fonts/24-1f4.clx b/assets/fonts/24-1f4.clx
diff --git a/assets/fonts/24-1f5.clx b/assets/fonts/24-1f5.clx
diff --git a/assets/fonts/24-1f6.clx b/assets/fonts/24-1f6.clx
diff --git a/assets/fonts/24-1f9.clx b/assets/fonts/24-1f9.clx
diff --git a/assets/fonts/24-20.clx b/assets/fonts/24-20.clx
diff --git a/assets/fonts/24-26.clx b/assets/fonts/24-26.clx
diff --git a/assets/fonts/24-e0.clx b/assets/fonts/24-e0.clx
diff --git a/assets/fonts/30-00.clx b/assets/fonts/30-00.clx
diff --git a/assets/fonts/30-01.clx b/assets/fonts/30-01.clx
diff --git a/assets/fonts/30-02.clx b/assets/fonts/30-02.clx
diff --git a/assets/fonts/30-03.clx b/assets/fonts/30-03.clx
diff --git a/assets/fonts/30-04.clx b/assets/fonts/30-04.clx
diff --git a/assets/fonts/30-20.clx b/assets/fonts/30-20.clx
diff --git a/assets/fonts/42-00.clx b/assets/fonts/42-00.clx
diff --git a/assets/fonts/42-01.clx b/assets/fonts/42-01.clx
diff --git a/assets/fonts/42-02.clx b/assets/fonts/42-02.clx
diff --git a/assets/fonts/42-03.clx b/assets/fonts/42-03.clx
diff --git a/assets/fonts/42-04.clx b/assets/fonts/42-04.clx
diff --git a/assets/fonts/42-20.clx b/assets/fonts/42-20.clx
diff --git a/assets/fonts/46-00.clx b/assets/fonts/46-00.clx
diff --git a/assets/fonts/46-01.clx b/assets/fonts/46-01.clx
diff --git a/assets/fonts/46-02.clx b/assets/fonts/46-02.clx
diff --git a/assets/fonts/46-03.clx b/assets/fonts/46-03.clx
diff --git a/assets/fonts/46-04.clx b/assets/fonts/46-04.clx
diff --git a/assets/fonts/46-20.clx b/assets/fonts/46-20.clx
diff --git a/assets/fonts/tr/12-00.clx b/assets/fonts/tr/12-00.clx
diff --git a/assets/fonts/tr/24-00.clx b/assets/fonts/tr/24-00.clx
diff --git a/assets/fonts/tr/30-00.clx b/assets/fonts/tr/30-00.clx
diff --git a/assets/fonts/tr/42-00.clx b/assets/fonts/tr/42-00.clx
diff --git a/assets/fonts/tr/46-00.clx b/assets/fonts/tr/46-00.clx
diff --git a/assets/gendata/cut2w.clx b/assets/gendata/cut2w.clx
diff --git a/assets/gendata/cut3w.clx b/assets/gendata/cut3w.clx
diff --git a/assets/gendata/cut4w.clx b/assets/gendata/cut4w.clx
diff --git a/assets/gendata/cutgatew.clx b/assets/gendata/cutgatew.clx
diff --git a/assets/gendata/cutl1dw.clx b/assets/gendata/cutl1dw.clx
diff --git a/assets/gendata/cutportlw.clx b/assets/gendata/cutportlw.clx
diff --git a/assets/gendata/cutportrw.clx b/assets/gendata/cutportrw.clx
diff --git a/assets/gendata/cutstartw.clx b/assets/gendata/cutstartw.clx
diff --git a/assets/gendata/cutttw.clx b/assets/gendata/cutttw.clx
diff --git a/assets/ui_art/creditsw.clx b/assets/ui_art/creditsw.clx
diff --git a/assets/ui_art/dvl_but_sml.clx b/assets/ui_art/dvl_but_sml.clx
diff --git a/assets/ui_art/dvl_lrpopup.clx b/assets/ui_art/dvl_lrpopup.clx
diff --git a/assets/ui_art/hf_titlew.clx b/assets/ui_art/hf_titlew.clx
diff --git a/assets/ui_art/mainmenuw.clx b/assets/ui_art/mainmenuw.clx
diff --git a/assets/ui_art/supportw.clx b/assets/ui_art/supportw.clx