Add multiple compression options and unit tests

2024-03-16 17:25:15 -05:00
parent d5074feda2
commit 6413e17e4b
12 changed files with 551 additions and 279 deletions
@@ -0,0 +1,100 @@
+/*
+ *    This file is part of the Distant Horizons mod
+ *    licensed under the GNU LGPL v3 License.
+ *
+ *    Copyright (C) 2020-2023 James Seibel
+ *
+ *    This program is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU Lesser General Public License as published by
+ *    the Free Software Foundation, version 3.
+ *
+ *    This program is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public License
+ *    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.seibel.distanthorizons.api.enums.config;
+
+/**
+ * UNCOMPRESSED <br>
+ * LZ4 <br>
+ * ZSTD <br>
+ * XZ <br><br>
+ * 
+ * Note: speed and compression ratios are examples
+ * and should only be used for estimated comparisons.
+ * 
+ * @version 2024-3-16
+ * @since API 1.1.0
+ */
+public enum EDhApiDataCompressionMode
+{
+	// Reminder:
+	// when adding items up the API minor version
+	// when removing items up the API major version
+	
+	/** 
+	 * Should only be used internally and for unit testing. <br><br> 
+	 * 
+	 * Read Speed: 1.64 MS / DTO <br>
+	 * Write Speed: 12.44 MS / DTO <br>
+	 * Compression ratio: 1.0 <br>
+	 */
+	@DisallowSelectingViaConfigGui
+	UNCOMPRESSED(0),
+	
+	/** 
+	 * Extremely fast (often faster than uncompressed), but generally poor compression. <br><br> 
+	 * 
+	 * Read Speed: 1.85 MS / DTO <br>
+	 * Write Speed: 9.46 MS / DTO <br>
+	 * Compression ratio: 0.3638 <br>
+	 */
+	LZ4(1),
+	
+	/**
+	 * Decent speed and good compression. <br><br> 
+	 *
+	 * Read Speed: 11.78 MS / DTO <br>
+	 * Write Speed: 16.76 MS / DTO <br>
+	 * Compression ratio: 0.2199 <br>
+	 */
+	Z_STD(2),
+	
+	/** 
+	 * Extremely slow, but very good compression. <br><br> 
+	 *
+	 * Read Speed: 12.25 MS / DTO <br>
+	 * Write Speed: 490.07 MS / DTO <br>
+	 * Compression ratio: 0.1242 <br>
+	 */
+	LZMA2(3);
+	
+	
+	
+	/** More stable than using the ordinal of the enum */
+	public final byte value;
+	
+	EDhApiDataCompressionMode(int value) { this.value = (byte) value; }
+	
+	
+	public static EDhApiDataCompressionMode getFromValue(byte value)
+	{
+		EDhApiDataCompressionMode[] enumList = EDhApiDataCompressionMode.values();
+		for (int i = 0; i < enumList.length; i++)
+		{
+			if (enumList[i].value == value)
+			{
+				return enumList[i];
+			}
+		}
+		
+		throw new IllegalArgumentException("No compression mode with the value ["+value+"]");
+	}
+	
+	
+}