allow block and sky light to exist separately

mworzala · mworzala · commit 108646e42819 · 2023-06-18T16:38:45.000-04:00
diff --git a/FORMAT.md b/FORMAT.md
@@ -7,8 +7,7 @@ The polar format resembles the anvil format in many ways, though it is binary, n
 | Name           | Type   | Notes                                                                   |
 |----------------|--------|-------------------------------------------------------------------------|
 | Magic Number   | int    | `Polr`                                                                  |
-| Major Version  | byte   |                                                                         |
-| Minor Version  | byte   |                                                                         |
+| Version        | short  |                                                                         |
 | Compression    | byte   | 0 = None, 1 = Zstd                                                      |
 | Length of data | varint | Uncompressed length of data (or just length of data if `Compression=0`) |
 | World          | world  |                                                                         |
@@ -49,8 +48,9 @@ Entities or some other extra data field needs to be added to chunks in the futur
 | Biome Palette             | array[string] |                                                                   |
 | Biome Palette Data Length | varint        | Only present if `Biome Palette Size > 1`                          |
 | Biome Palette Data        | array[long]   | See the anvil format for more information about this type         |
-| Has Light Data            | bool          | If unset, block and sky light are both ommitted                   |
+| Has Block Light Data      | bool          | If unset, block light is ommitted                                 |
 | Block Light               | bytes         | A 2048 byte long nibble array                                     |
+| Has Sky Light Data        | bool          | If unset, sky light is ommitted                                   |
 | Sky Light                 | bytes         | A 2048 byte long nibble array                                     |
 
 ### Block Entity
diff --git a/src/main/java/net/hollowcube/polar/AnvilPolar.java b/src/main/java/net/hollowcube/polar/AnvilPolar.java
@@ -178,9 +178,12 @@ public class AnvilPolar {
                     }
 
                     // Lighting data, if present
-                    byte[] blockLight = null, skyLight = null;
-                    if (sectionReader.getBlockLight() != null && sectionReader.getSkyLight() != null) {
+                    byte[] blockLight = null;
+                    if (sectionReader.getBlockLight() != null) {
                         blockLight = sectionReader.getBlockLight().copyArray();
+                    }
+                    byte[] skyLight = null;
+                    if (sectionReader.getSkyLight() != null) {
                         skyLight = sectionReader.getSkyLight().copyArray();
                     }
 
diff --git a/src/main/java/net/hollowcube/polar/PolarLoader.java b/src/main/java/net/hollowcube/polar/PolarLoader.java
@@ -1,7 +1,5 @@
 package net.hollowcube.polar;
 
-import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;
-import it.unimi.dsi.fastutil.shorts.Short2ObjectArrayMap;
 import it.unimi.dsi.fastutil.shorts.Short2ObjectMap;
 import it.unimi.dsi.fastutil.shorts.Short2ObjectOpenHashMap;
 import net.hollowcube.polar.compat.ChunkSupplierShim;
@@ -161,10 +159,10 @@ private void loadSection(@NotNull PolarSection sectionData, @NotNull Section sec
         }
 
         // Light
-        if (sectionData.hasLightData()) {
+        if (sectionData.hasBlockLightData())
             section.setBlockLight(sectionData.blockLight());
+        if (sectionData.hasSkyLightData())
             section.setSkyLight(sectionData.skyLight());
-        }
     }
 
     private void loadBlockEntity(@NotNull PolarChunk.BlockEntity blockEntity, @NotNull Chunk chunk) {
diff --git a/src/main/java/net/hollowcube/polar/PolarReader.java b/src/main/java/net/hollowcube/polar/PolarReader.java
@@ -35,18 +35,18 @@ private PolarReader() {}
         byte minSection = buffer.read(BYTE), maxSection = buffer.read(BYTE);
         assertThat(minSection < maxSection, "Invalid section range");
 
-        var chunks = buffer.readCollection(b -> readChunk(b, maxSection - minSection + 1));
+        var chunks = buffer.readCollection(b -> readChunk(version, b, maxSection - minSection + 1));
 
         return new PolarWorld(version, compression, minSection, maxSection, chunks);
     }
 
-    private static @NotNull PolarChunk readChunk(@NotNull NetworkBuffer buffer, int sectionCount) {
+    private static @NotNull PolarChunk readChunk(short version, @NotNull NetworkBuffer buffer, int sectionCount) {
         var chunkX = buffer.read(VAR_INT);
         var chunkZ = buffer.read(VAR_INT);
 
         var sections = new PolarSection[sectionCount];
         for (int i = 0; i < sectionCount; i++) {
-            sections[i] = readSection(buffer);
+            sections[i] = readSection(version, buffer);
         }
 
         var blockEntities = buffer.readCollection(PolarReader::readBlockEntity);
@@ -68,7 +68,7 @@ private PolarReader() {}
         );
     }
 
-    private static @NotNull PolarSection readSection(@NotNull NetworkBuffer buffer) {
+    private static @NotNull PolarSection readSection(short version, @NotNull NetworkBuffer buffer) {
         // If section is empty exit immediately
         if (buffer.read(BOOLEAN)) return new PolarSection();
 
@@ -93,7 +93,13 @@ private PolarReader() {}
         }
 
         byte[] blockLight = null, skyLight = null;
-        if (buffer.read(BOOLEAN)) {
+
+        if (version > PolarWorld.VERSION_UNIFIED_LIGHT) {
+            if (buffer.read(BOOLEAN))
+                blockLight = buffer.readBytes(2048);
+            if (buffer.read(BOOLEAN))
+                skyLight = buffer.readBytes(2048);
+        } else {
             blockLight = buffer.readBytes(2048);
             skyLight = buffer.readBytes(2048);
         }
diff --git a/src/main/java/net/hollowcube/polar/PolarSection.java b/src/main/java/net/hollowcube/polar/PolarSection.java
@@ -85,17 +85,21 @@ public int[] biomeData() {
         return biomeData;
     }
 
-    public boolean hasLightData() {
-        return blockLight != null && skyLight != null;
+    public boolean hasBlockLightData() {
+        return blockLight != null;
+    }
+
+    public boolean hasSkyLightData() {
+        return skyLight != null;
     }
 
     public byte[] blockLight() {
-        assert blockLight != null : "must check hasLightData() before calling blockLight()";
+        assert blockLight != null : "must check hasBlockLightData() before calling blockLight()";
         return blockLight;
     }
 
     public byte[] skyLight() {
-        assert skyLight != null : "must check hasLightData() before calling skyLight()";
+        assert skyLight != null : "must check hasSkyLightData() before calling skyLight()";
         return skyLight;
     }
 }
diff --git a/src/main/java/net/hollowcube/polar/PolarWorld.java b/src/main/java/net/hollowcube/polar/PolarWorld.java
@@ -15,7 +15,9 @@
 @SuppressWarnings("UnstableApiUsage")
 public class PolarWorld {
     public static final int MAGIC_NUMBER = 0x506F6C72;
-    public static final short LATEST_VERSION = 1;
+    public static final short LATEST_VERSION = 2;
+
+    static final short VERSION_UNIFIED_LIGHT = 1;
 
     public static CompressionType DEFAULT_COMPRESSION = CompressionType.ZSTD;
 
diff --git a/src/main/java/net/hollowcube/polar/PolarWriter.java b/src/main/java/net/hollowcube/polar/PolarWriter.java
@@ -76,11 +76,12 @@ private static void writeSection(@NotNull NetworkBuffer buffer, @NotNull PolarSe
         }
 
         // Light
-        buffer.write(BOOLEAN, section.hasLightData());
-        if (section.hasLightData()) {
+        buffer.write(BOOLEAN, section.hasBlockLightData());
+        if (section.hasBlockLightData())
             buffer.write(RAW_BYTES, section.blockLight());
+        buffer.write(BOOLEAN, section.hasSkyLightData());
+        if (section.hasSkyLightData())
             buffer.write(RAW_BYTES, section.skyLight());
-        }
     }
 
     private static void writeBlockEntity(@NotNull NetworkBuffer buffer, @NotNull PolarChunk.BlockEntity blockEntity) {
diff --git a/src/test/java/net/hollowcube/polar/TestAnvilPolar.java b/src/test/java/net/hollowcube/polar/TestAnvilPolar.java
@@ -12,14 +12,13 @@ class TestAnvilPolar {
     @Test
     void testConvertAnvilWorld() throws Exception {
         var world = AnvilPolar.anvilToPolar(
-                Path.of("./src/test/resources/abc").toRealPath(),
-                ChunkSelector.radius(5)
+                Path.of("./src/test/resources/emclobby").toRealPath()
         );
         assertEquals(-4, world.minSection());
 
         var result = PolarWriter.write(world);
         System.out.println(result.length);
-        Files.write(Path.of("./src/test/resources/bench/abc.polar"), result);
+        Files.write(Path.of("./src/test/resources/emclobby.polar"), result);
     }
 
 }
diff --git a/src/test/java/net/hollowcube/polar/demo/DemoServer.java b/src/test/java/net/hollowcube/polar/demo/DemoServer.java
@@ -18,7 +18,7 @@ public static void main(String[] args) throws Exception {
         var server = MinecraftServer.init();
 
         var instance = MinecraftServer.getInstanceManager().createInstanceContainer();
-        instance.setChunkLoader(new PolarLoader(Path.of("./src/test/resources/bench.polar")));
+        instance.setChunkLoader(new PolarLoader(Path.of("./src/test/resources/emclobby.polar")));
 //        instance.setChunkSupplier(LightingChunk::new);
 
         MinecraftServer.getGlobalEventHandler()
diff --git a/src/test/resources/bench.polar b/src/test/resources/bench.polar
diff --git a/src/test/resources/bench/really-old-version-of-bench.polar b/src/test/resources/bench/really-old-version-of-bench.polar
diff --git a/src/test/resources/emclobby.polar b/src/test/resources/emclobby.polar

Original file line number	Diff line number	Diff line change
`@@ -178,9 +178,12 @@ public class AnvilPolar {`
`178`	`178`	`}`
`179`	`179`
`180`	`180`	`// Lighting data, if present`
`181`		`- byte[] blockLight = null, skyLight = null;`
`182`		`- if (sectionReader.getBlockLight() != null && sectionReader.getSkyLight() != null) {`
	`181`	`+ byte[] blockLight = null;`
	`182`	`+ if (sectionReader.getBlockLight() != null) {`
`183`	`183`	`blockLight = sectionReader.getBlockLight().copyArray();`
	`184`	`+ }`
	`185`	`+ byte[] skyLight = null;`
	`186`	`+ if (sectionReader.getSkyLight() != null) {`
`184`	`187`	`skyLight = sectionReader.getSkyLight().copyArray();`
`185`	`188`	`}`
`186`	`189`
Original file line number	Diff line number	Diff line change
`@@ -85,17 +85,21 @@ public int[] biomeData() {`
`85`	`85`	`return biomeData;`
`86`	`86`	`}`
`87`	`87`
`88`		`- public boolean hasLightData() {`
`89`		`- return blockLight != null && skyLight != null;`
	`88`	`+ public boolean hasBlockLightData() {`
	`89`	`+ return blockLight != null;`
	`90`	`+ }`
	`91`	`+`
	`92`	`+ public boolean hasSkyLightData() {`
	`93`	`+ return skyLight != null;`
`90`	`94`	`}`
`91`	`95`
`92`	`96`	`public byte[] blockLight() {`
`93`		`- assert blockLight != null : "must check hasLightData() before calling blockLight()";`
	`97`	`+ assert blockLight != null : "must check hasBlockLightData() before calling blockLight()";`
`94`	`98`	`return blockLight;`
`95`	`99`	`}`
`96`	`100`
`97`	`101`	`public byte[] skyLight() {`
`98`		`- assert skyLight != null : "must check hasLightData() before calling skyLight()";`
	`102`	`+ assert skyLight != null : "must check hasSkyLightData() before calling skyLight()";`
`99`	`103`	`return skyLight;`
`100`	`104`	`}`
`101`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,11 +76,12 @@ private static void writeSection(@NotNull NetworkBuffer buffer, @NotNull PolarSe`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`// Light`
`79`		`- buffer.write(BOOLEAN, section.hasLightData());`
`80`		`- if (section.hasLightData()) {`
	`79`	`+ buffer.write(BOOLEAN, section.hasBlockLightData());`
	`80`	`+ if (section.hasBlockLightData())`
`81`	`81`	`buffer.write(RAW_BYTES, section.blockLight());`
	`82`	`+ buffer.write(BOOLEAN, section.hasSkyLightData());`
	`83`	`+ if (section.hasSkyLightData())`
`82`	`84`	`buffer.write(RAW_BYTES, section.skyLight());`
`83`		`- }`
`84`	`85`	`}`
`85`	`86`
`86`	`87`	`private static void writeBlockEntity(@NotNull NetworkBuffer buffer, @NotNull PolarChunk.BlockEntity blockEntity) {`