aboutsummaryrefslogtreecommitdiff
path: root/zencore/compress.cpp
blob: 35a5acb3aa225a2522d8e733dd1625639bfb1730 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
// Copyright Epic Games, Inc. All Rights Reserved.

#include <zencore/compress.h>

#include <zencore/blake3.h>
#include <zencore/compositebuffer.h>
#include <zencore/crc32.h>
#include <zencore/endian.h>
#include <zencore/testing.h>

#include "../thirdparty/Oodle/include/oodle2.h"
#if ZEN_PLATFORM_WINDOWS
#	pragma comment(lib, "oo2core_win64.lib")
#endif

#include <lz4.h>
#include <functional>
#include <limits>

namespace zen::detail {

///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

static constexpr uint64_t DefaultBlockSize = 256 * 1024;

///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

/** Method used to compress the data in a compressed buffer. */
enum class CompressionMethod : uint8_t
{
	/** Header is followed by one uncompressed block. */
	None = 0,
	/** Header is followed by an array of compressed block sizes then the compressed blocks. */
	Oodle = 3,
	/** Header is followed by an array of compressed block sizes then the compressed blocks. */
	LZ4 = 4,
};

///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

/** Header used on every compressed buffer. Always stored in big-endian format. */
struct BufferHeader
{
	static constexpr uint32_t ExpectedMagic = 0xb7756362;  // <dot>ucb

	uint32_t		  Magic = ExpectedMagic;  // A magic number to identify a compressed buffer. Always 0xb7756362.
	uint32_t		  Crc32 = 0;			  // A CRC-32 used to check integrity of the buffer. Uses the polynomial 0x04c11db7
	CompressionMethod Method =
		CompressionMethod::None;	   // The method used to compress the buffer. Affects layout of data following the header
	uint8_t	 Compressor			 = 0;  // The method-specific compressor used to compress the buffer.
	uint8_t	 CompressionLevel	 = 0;  // The method-specific compression level used to compress the buffer.
	uint8_t	 BlockSizeExponent	 = 0;  // The power of two size of every uncompressed block except the last. Size is 1 << BlockSizeExponent
	uint32_t BlockCount			 = 0;  // The number of blocks that follow the header
	uint64_t TotalRawSize		 = 0;  // The total size of the uncompressed data
	uint64_t TotalCompressedSize = 0;  // The total size of the compressed data including the header
	BLAKE3	 RawHash;				   // The hash of the uncompressed data

	/** Checks validity of the buffer based on the magic number, method, and CRC-32. */
	static bool IsValid(const CompositeBuffer& CompressedData);
	static bool IsValid(const SharedBuffer& CompressedData) { return IsValid(CompositeBuffer(CompressedData)); }

	/** Read a header from a buffer that is at least sizeof(BufferHeader) without any validation. */
	static BufferHeader Read(const CompositeBuffer& CompressedData)
	{
		BufferHeader Header;
		if (sizeof(BufferHeader) <= CompressedData.GetSize())
		{
			CompressedData.CopyTo(MakeMutableMemoryView(&Header, &Header + 1));
			Header.ByteSwap();
		}
		return Header;
	}

	/**
	 * Write a header to a memory view that is at least sizeof(BufferHeader).
	 *
	 * @param HeaderView   View of the header to write, including any method-specific header data.
	 */
	void Write(MutableMemoryView HeaderView) const
	{
		BufferHeader Header = *this;
		Header.ByteSwap();
		HeaderView.CopyFrom(MakeMemoryView(&Header, &Header + 1));
		Header.ByteSwap();
		Header.Crc32 = CalculateCrc32(HeaderView);
		Header.ByteSwap();
		HeaderView.CopyFrom(MakeMemoryView(&Header, &Header + 1));
	}

	void ByteSwap()
	{
		Magic				= zen::ByteSwap(Magic);
		Crc32				= zen::ByteSwap(Crc32);
		BlockCount			= zen::ByteSwap(BlockCount);
		TotalRawSize		= zen::ByteSwap(TotalRawSize);
		TotalCompressedSize = zen::ByteSwap(TotalCompressedSize);
	}

	/** Calculate the CRC-32 from a view of a header including any method-specific header data. */
	static uint32_t CalculateCrc32(MemoryView HeaderView)
	{
		uint32_t		   Crc32		= 0;
		constexpr uint64_t MethodOffset = offsetof(BufferHeader, Method);
		for (MemoryView View = HeaderView + MethodOffset; const uint64_t ViewSize = View.GetSize();)
		{
			const int32_t Size = static_cast<int32_t>(zen::Min<uint64_t>(ViewSize, /* INT_MAX */ 2147483647u));
			Crc32			   = zen::MemCrc32(View.GetData(), Size, Crc32);
			View += Size;
		}
		return Crc32;
	}
};

static_assert(sizeof(BufferHeader) == 64, "BufferHeader is the wrong size.");

///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

class BaseEncoder
{
public:
	virtual CompositeBuffer Compress(const CompositeBuffer& RawData, uint64_t BlockSize = DefaultBlockSize) const = 0;
};

class BaseDecoder
{
public:
	virtual CompositeBuffer Decompress(const BufferHeader& Header, const CompositeBuffer& CompressedData) const = 0;
	virtual bool			TryDecompressTo(const BufferHeader&	   Header,
											const CompositeBuffer& CompressedData,
											MutableMemoryView	   RawView,
											uint64_t			   RawOffset) const											= 0;
	virtual uint64_t		GetHeaderSize(const BufferHeader& Header) const										= 0;
};

///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

class NoneEncoder final : public BaseEncoder
{
public:
	[[nodiscard]] CompositeBuffer Compress(const CompositeBuffer& RawData, uint64_t /* BlockSize */) const final
	{
		BufferHeader Header;
		Header.Method			   = CompressionMethod::None;
		Header.BlockCount		   = 1;
		Header.TotalRawSize		   = RawData.GetSize();
		Header.TotalCompressedSize = Header.TotalRawSize + sizeof(BufferHeader);
		Header.RawHash			   = BLAKE3::HashBuffer(RawData);

		UniqueBuffer HeaderData = UniqueBuffer::Alloc(sizeof(BufferHeader));
		Header.Write(HeaderData);
		return CompositeBuffer(HeaderData.MoveToShared(), RawData.MakeOwned());
	}
};

class NoneDecoder final : public BaseDecoder
{
public:
	[[nodiscard]] CompositeBuffer Decompress(const BufferHeader& Header, const CompositeBuffer& CompressedData) const final
	{
		if (Header.Method == CompressionMethod::None && Header.TotalCompressedSize == CompressedData.GetSize() &&
			Header.TotalCompressedSize == Header.TotalRawSize + sizeof(BufferHeader))
		{
			return CompressedData.Mid(sizeof(BufferHeader), Header.TotalRawSize).MakeOwned();
		}
		return CompositeBuffer();
	}

	[[nodiscard]] bool TryDecompressTo(const BufferHeader&	  Header,
									   const CompositeBuffer& CompressedData,
									   MutableMemoryView	  RawView,
									   uint64_t				  RawOffset) const final
	{
		if (Header.Method == CompressionMethod::None && RawOffset + RawView.GetSize() <= Header.TotalRawSize &&
			Header.TotalCompressedSize == CompressedData.GetSize() &&
			Header.TotalCompressedSize == Header.TotalRawSize + sizeof(BufferHeader))
		{
			CompressedData.CopyTo(RawView, sizeof(BufferHeader) + RawOffset);
			return true;
		}
		return false;
	}

	[[nodiscard]] uint64_t GetHeaderSize(const BufferHeader&) const final { return sizeof(BufferHeader); }
};

//////////////////////////////////////////////////////////////////////////

class BlockEncoder : public BaseEncoder
{
public:
	CompositeBuffer Compress(const CompositeBuffer& RawData, uint64_t BlockSize = DefaultBlockSize) const final;

protected:
	virtual CompressionMethod GetMethod() const															 = 0;
	virtual uint8_t			  GetCompressor() const														 = 0;
	virtual uint8_t			  GetCompressionLevel() const												 = 0;
	virtual uint64_t		  CompressBlockBound(uint64_t RawSize) const								 = 0;
	virtual bool			  CompressBlock(MutableMemoryView& CompressedData, MemoryView RawData) const = 0;

private:
	uint64_t GetCompressedBlocksBound(uint64_t BlockCount, uint64_t BlockSize, uint64_t RawSize) const
	{
		switch (BlockCount)
		{
			case 0:
				return 0;
			case 1:
				return CompressBlockBound(RawSize);
			default:
				return CompressBlockBound(BlockSize) - BlockSize + RawSize;
		}
	}
};

CompositeBuffer
BlockEncoder::Compress(const CompositeBuffer& RawData, const uint64_t BlockSize) const
{
	ZEN_ASSERT(IsPow2(BlockSize) && (BlockSize <= (1u << 31)));

	const uint64_t RawSize = RawData.GetSize();
	BLAKE3Stream   RawHash;

	const uint64_t BlockCount = RoundUp(RawSize, BlockSize) / BlockSize;
	ZEN_ASSERT(BlockCount <= ~uint32_t(0));

	// Allocate the buffer for the header, metadata, and compressed blocks.
	const uint64_t MetaSize			  = BlockCount * sizeof(uint32_t);
	const uint64_t CompressedDataSize = sizeof(BufferHeader) + MetaSize + GetCompressedBlocksBound(BlockCount, BlockSize, RawSize);
	UniqueBuffer   CompressedData	  = UniqueBuffer::Alloc(CompressedDataSize);

	// Compress the raw data in blocks and store the raw data for incompressible blocks.
	std::vector<uint32_t> CompressedBlockSizes;
	CompressedBlockSizes.reserve(BlockCount);
	uint64_t CompressedSize = 0;
	{
		UniqueBuffer	  RawBlockCopy;
		MutableMemoryView CompressedBlocksView = CompressedData.GetMutableView() + sizeof(BufferHeader) + MetaSize;
		for (uint64_t RawOffset = 0; RawOffset < RawSize;)
		{
			const uint64_t	 RawBlockSize = zen::Min(RawSize - RawOffset, BlockSize);
			const MemoryView RawBlock	  = RawData.ViewOrCopyRange(RawOffset, RawBlockSize, RawBlockCopy);
			RawHash.Append(RawBlock);

			MutableMemoryView CompressedBlock = CompressedBlocksView;
			if (!CompressBlock(CompressedBlock, RawBlock))
			{
				return CompositeBuffer();
			}

			uint64_t CompressedBlockSize = CompressedBlock.GetSize();
			if (RawBlockSize <= CompressedBlockSize)
			{
				CompressedBlockSize	 = RawBlockSize;
				CompressedBlocksView = CompressedBlocksView.CopyFrom(RawBlock);
			}
			else
			{
				CompressedBlocksView += CompressedBlockSize;
			}

			CompressedBlockSizes.push_back(static_cast<uint32_t>(CompressedBlockSize));
			CompressedSize += CompressedBlockSize;
			RawOffset += RawBlockSize;
		}
	}

	// Return an uncompressed buffer if the compressed data is larger than the raw data.
	if (RawSize <= MetaSize + CompressedSize)
	{
		CompressedData.Reset();
		return NoneEncoder().Compress(RawData, BlockSize);
	}

	// Write the header and calculate the CRC-32.
	for (uint32_t& Size : CompressedBlockSizes)
	{
		Size = ByteSwap(Size);
	}
	CompressedData.GetMutableView().Mid(sizeof(BufferHeader), MetaSize).CopyFrom(MakeMemoryView(CompressedBlockSizes));

	BufferHeader Header;
	Header.Method			   = GetMethod();
	Header.Compressor		   = GetCompressor();
	Header.CompressionLevel	   = GetCompressionLevel();
	Header.BlockSizeExponent   = static_cast<uint8_t>(zen::FloorLog2_64(BlockSize));
	Header.BlockCount		   = static_cast<uint32_t>(BlockCount);
	Header.TotalRawSize		   = RawSize;
	Header.TotalCompressedSize = sizeof(BufferHeader) + MetaSize + CompressedSize;
	Header.RawHash			   = RawHash.GetHash();
	Header.Write(CompressedData.GetMutableView().Left(sizeof(BufferHeader) + MetaSize));

	const MemoryView CompositeView = CompressedData.GetView().Left(Header.TotalCompressedSize);
	return CompositeBuffer(SharedBuffer::MakeView(CompositeView, CompressedData.MoveToShared()));
}

class BlockDecoder : public BaseDecoder
{
public:
	CompositeBuffer		   Decompress(const BufferHeader& Header, const CompositeBuffer& CompressedData) const final;
	[[nodiscard]] bool	   TryDecompressTo(const BufferHeader&	  Header,
										   const CompositeBuffer& CompressedData,
										   MutableMemoryView	  RawView,
										   uint64_t				  RawOffset) const final;
	[[nodiscard]] uint64_t GetHeaderSize(const BufferHeader& Header) const final
	{
		return sizeof(BufferHeader) + sizeof(uint32_t) * uint64_t(Header.BlockCount);
	}

protected:
	virtual bool DecompressBlock(MutableMemoryView RawData, MemoryView CompressedData) const = 0;
};

CompositeBuffer
BlockDecoder::Decompress(const BufferHeader& Header, const CompositeBuffer& CompressedData) const
{
	if (Header.BlockCount == 0 || Header.TotalCompressedSize != CompressedData.GetSize())
	{
		return CompositeBuffer();
	}

	// The raw data cannot reference the compressed data unless it is owned.
	// An empty raw buffer requires an empty segment, which this path creates.
	if (!CompressedData.IsOwned() || Header.TotalRawSize == 0)
	{
		UniqueBuffer Buffer = UniqueBuffer::Alloc(Header.TotalRawSize);
		return TryDecompressTo(Header, CompressedData, Buffer, 0) ? CompositeBuffer(Buffer.MoveToShared()) : CompositeBuffer();
	}

	std::vector<uint32_t> CompressedBlockSizes;
	CompressedBlockSizes.resize(Header.BlockCount);
	CompressedData.CopyTo(MakeMutableMemoryView(CompressedBlockSizes), sizeof(BufferHeader));

	for (uint32_t& Size : CompressedBlockSizes)
	{
		Size = ByteSwap(Size);
	}

	// Allocate the buffer for the raw blocks that were compressed.
	SharedBuffer	  RawData;
	MutableMemoryView RawDataView;
	const uint64_t	  BlockSize = uint64_t(1) << Header.BlockSizeExponent;
	{
		uint64_t RawDataSize	  = 0;
		uint64_t RemainingRawSize = Header.TotalRawSize;
		for (const uint32_t CompressedBlockSize : CompressedBlockSizes)
		{
			const uint64_t RawBlockSize = zen::Min(RemainingRawSize, BlockSize);
			if (CompressedBlockSize < BlockSize)
			{
				RawDataSize += RawBlockSize;
			}
			RemainingRawSize -= RawBlockSize;
		}
		UniqueBuffer RawDataBuffer = UniqueBuffer::Alloc(RawDataSize);
		RawDataView				   = RawDataBuffer;
		RawData					   = RawDataBuffer.MoveToShared();
	}

	// Decompress the compressed data in blocks and reference the uncompressed blocks.
	uint64_t				  PendingCompressedSegmentOffset = sizeof(BufferHeader) + uint64_t(Header.BlockCount) * sizeof(uint32_t);
	uint64_t				  PendingCompressedSegmentSize	 = 0;
	uint64_t				  PendingRawSegmentOffset		 = 0;
	uint64_t				  PendingRawSegmentSize			 = 0;
	std::vector<SharedBuffer> Segments;

	const auto CommitPendingCompressedSegment =
		[&PendingCompressedSegmentOffset, &PendingCompressedSegmentSize, &CompressedData, &Segments] {
			if (PendingCompressedSegmentSize)
			{
				CompressedData.IterateRange(PendingCompressedSegmentOffset,
											PendingCompressedSegmentSize,
											[&Segments](MemoryView View, const SharedBuffer& ViewOuter) {
												Segments.push_back(SharedBuffer::MakeView(View, ViewOuter));
											});
				PendingCompressedSegmentOffset += PendingCompressedSegmentSize;
				PendingCompressedSegmentSize = 0;
			}
		};

	const auto CommitPendingRawSegment = [&PendingRawSegmentOffset, &PendingRawSegmentSize, &RawData, &Segments] {
		if (PendingRawSegmentSize)
		{
			const MemoryView PendingSegment = RawData.GetView().Mid(PendingRawSegmentOffset, PendingRawSegmentSize);
			Segments.push_back(SharedBuffer::MakeView(PendingSegment, RawData));
			PendingRawSegmentOffset += PendingRawSegmentSize;
			PendingRawSegmentSize = 0;
		}
	};

	UniqueBuffer CompressedBlockCopy;
	uint64_t	 RemainingRawSize		 = Header.TotalRawSize;
	uint64_t	 RemainingCompressedSize = CompressedData.GetSize();
	for (const uint32_t CompressedBlockSize : CompressedBlockSizes)
	{
		if (RemainingCompressedSize < CompressedBlockSize)
		{
			return CompositeBuffer();
		}

		const uint64_t RawBlockSize = zen::Min(RemainingRawSize, BlockSize);
		if (RawBlockSize == CompressedBlockSize)
		{
			CommitPendingRawSegment();
			PendingCompressedSegmentSize += RawBlockSize;
		}
		else
		{
			CommitPendingCompressedSegment();
			const MemoryView CompressedBlock =
				CompressedData.ViewOrCopyRange(PendingCompressedSegmentOffset, CompressedBlockSize, CompressedBlockCopy);
			if (!DecompressBlock(RawDataView.Left(RawBlockSize), CompressedBlock))
			{
				return CompositeBuffer();
			}
			PendingCompressedSegmentOffset += CompressedBlockSize;
			PendingRawSegmentSize += RawBlockSize;
			RawDataView += RawBlockSize;
		}

		RemainingCompressedSize -= CompressedBlockSize;
		RemainingRawSize -= RawBlockSize;
	}

	CommitPendingCompressedSegment();
	CommitPendingRawSegment();

	return CompositeBuffer(std::move(Segments));
}

bool
BlockDecoder::TryDecompressTo(const BufferHeader&	 Header,
							  const CompositeBuffer& CompressedData,
							  MutableMemoryView		 RawView,
							  uint64_t				 RawOffset) const
{
	if (Header.TotalRawSize < RawOffset + RawView.GetSize() || Header.TotalCompressedSize != CompressedData.GetSize())
	{
		return false;
	}

	const uint64_t BlockSize = uint64_t(1) << Header.BlockSizeExponent;

	UniqueBuffer BlockSizeBuffer;
	MemoryView BlockSizeView = CompressedData.ViewOrCopyRange(sizeof(BufferHeader), Header.BlockCount * sizeof(uint32_t), BlockSizeBuffer);
	std::span<uint32_t const> CompressedBlockSizes(reinterpret_cast<const uint32_t*>(BlockSizeView.GetData()), Header.BlockCount);

	UniqueBuffer CompressedBlockCopy;
	UniqueBuffer UncompressedBlockCopy;

	const size_t   FirstBlockIndex	  = uint64_t(RawOffset / BlockSize);
	const size_t   LastBlockIndex	  = uint64_t((RawOffset + RawView.GetSize() - 1) / BlockSize);
	const uint64_t LastBlockSize	  = BlockSize - ((Header.BlockCount * BlockSize) - Header.TotalRawSize);
	uint64_t	   OffsetInFirstBlock = RawOffset % BlockSize;
	uint64_t	   CompressedOffset	  = sizeof(BufferHeader) + uint64_t(Header.BlockCount) * sizeof(uint32_t);
	uint64_t	   RemainingRawSize	  = RawView.GetSize();

	for (size_t BlockIndex = 0; BlockIndex < FirstBlockIndex; BlockIndex++)
	{
		const uint32_t CompressedBlockSize = ByteSwap(CompressedBlockSizes[BlockIndex]);
		CompressedOffset += CompressedBlockSize;
	}

	for (size_t BlockIndex = FirstBlockIndex; BlockIndex <= LastBlockIndex; BlockIndex++)
	{
		const uint64_t UncompressedBlockSize = BlockIndex == Header.BlockCount - 1 ? LastBlockSize : BlockSize;
		const uint32_t CompressedBlockSize	 = ByteSwap(CompressedBlockSizes[BlockIndex]);
		const bool	   IsCompressed			 = CompressedBlockSize < UncompressedBlockSize;

		const uint64_t BytesToUncompress = OffsetInFirstBlock > 0 ? zen::Min(RawView.GetSize(), UncompressedBlockSize - OffsetInFirstBlock)
																  : zen::Min(RemainingRawSize, BlockSize);

		MemoryView CompressedBlock = CompressedData.ViewOrCopyRange(CompressedOffset, CompressedBlockSize, CompressedBlockCopy);

		if (IsCompressed)
		{
			MutableMemoryView UncompressedBlock = RawView.Left(BytesToUncompress);

			const bool IsAligned = BytesToUncompress == UncompressedBlockSize;
			if (!IsAligned)
			{
				// Decompress to a temporary buffer when the first or the last block reads are not aligned with the block boundaries.
				if (UncompressedBlockCopy.IsNull())
				{
					UncompressedBlockCopy = UniqueBuffer::Alloc(BlockSize);
				}
				UncompressedBlock = UncompressedBlockCopy.GetMutableView().Mid(0, UncompressedBlockSize);
			}

			if (!DecompressBlock(UncompressedBlock, CompressedBlock))
			{
				return false;
			}

			if (!IsAligned)
			{
				RawView.CopyFrom(UncompressedBlock.Mid(OffsetInFirstBlock, BytesToUncompress));
			}
		}
		else
		{
			RawView.CopyFrom(CompressedBlock.Mid(OffsetInFirstBlock, BytesToUncompress));
		}

		OffsetInFirstBlock = 0;
		RemainingRawSize -= BytesToUncompress;
		CompressedOffset += CompressedBlockSize;
		RawView += BytesToUncompress;
	}

	return RemainingRawSize == 0;
}

//////////////////////////////////////////////////////////////////////////

struct OodleInit
{
	OodleInit()
	{
		OodleConfigValues Config;
		Oodle_GetConfigValues(&Config);
		// Always read/write Oodle v9 binary data.
		Config.m_OodleLZ_BackwardsCompatible_MajorVersion = 9;
		Oodle_SetConfigValues(&Config);
	}
};

OodleInit InitOodle;

class OodleEncoder final : public BlockEncoder
{
public:
	OodleEncoder(OodleCompressor InCompressor, OodleCompressionLevel InCompressionLevel)
	: Compressor(InCompressor)
	, CompressionLevel(InCompressionLevel)
	{
	}

protected:
	CompressionMethod GetMethod() const final { return CompressionMethod::Oodle; }
	uint8_t			  GetCompressor() const final { return static_cast<uint8_t>(Compressor); }
	uint8_t			  GetCompressionLevel() const final { return static_cast<uint8_t>(CompressionLevel); }

	uint64_t CompressBlockBound(uint64_t RawSize) const final
	{
		return static_cast<uint64_t>(OodleLZ_GetCompressedBufferSizeNeeded(OodleLZ_Compressor_Kraken, static_cast<OO_SINTa>(RawSize)));
	}

	bool CompressBlock(MutableMemoryView& CompressedData, MemoryView RawData) const final
	{
		const OodleLZ_Compressor	   LZCompressor		  = GetOodleLZCompressor(Compressor);
		const OodleLZ_CompressionLevel LZCompressionLevel = GetOodleLZCompressionLevel(CompressionLevel);
		if (LZCompressor == OodleLZ_Compressor_Invalid || LZCompressionLevel == OodleLZ_CompressionLevel_Invalid ||
			LZCompressionLevel == OodleLZ_CompressionLevel_None)
		{
			return false;
		}

		const OO_SINTa RawSize = static_cast<OO_SINTa>(RawData.GetSize());
		if (static_cast<OO_SINTa>(CompressedData.GetSize()) < OodleLZ_GetCompressedBufferSizeNeeded(LZCompressor, RawSize))
		{
			return false;
		}

		const OO_SINTa Size = OodleLZ_Compress(LZCompressor, RawData.GetData(), RawSize, CompressedData.GetData(), LZCompressionLevel);
		CompressedData.LeftInline(static_cast<uint64_t>(Size));
		return Size > 0;
	}

	static OodleLZ_Compressor GetOodleLZCompressor(OodleCompressor Compressor)
	{
		switch (Compressor)
		{
			case OodleCompressor::Selkie:
				return OodleLZ_Compressor_Selkie;
			case OodleCompressor::Mermaid:
				return OodleLZ_Compressor_Mermaid;
			case OodleCompressor::Kraken:
				return OodleLZ_Compressor_Kraken;
			case OodleCompressor::Leviathan:
				return OodleLZ_Compressor_Leviathan;
			case OodleCompressor::NotSet:
			default:
				return OodleLZ_Compressor_Invalid;
		}
	}

	static OodleLZ_CompressionLevel GetOodleLZCompressionLevel(OodleCompressionLevel Level)
	{
		const int IntLevel = (int)Level;
		if (IntLevel < (int)OodleLZ_CompressionLevel_Min || IntLevel > (int)OodleLZ_CompressionLevel_Max)
		{
			return OodleLZ_CompressionLevel_Invalid;
		}
		return OodleLZ_CompressionLevel(IntLevel);
	}

private:
	const OodleCompressor		Compressor;
	const OodleCompressionLevel CompressionLevel;
};

class OodleDecoder final : public BlockDecoder
{
protected:
	bool DecompressBlock(MutableMemoryView RawData, MemoryView CompressedData) const final
	{
		const OO_SINTa RawSize = static_cast<OO_SINTa>(RawData.GetSize());
		const OO_SINTa Size	   = OodleLZ_Decompress(CompressedData.GetData(),
													static_cast<OO_SINTa>(CompressedData.GetSize()),
													RawData.GetData(),
													RawSize,
													OodleLZ_FuzzSafe_Yes,
													OodleLZ_CheckCRC_Yes,
													OodleLZ_Verbosity_None);
		return Size == RawSize;
	}
};

///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

class LZ4Decoder final : public BlockDecoder
{
protected:
	bool DecompressBlock(MutableMemoryView RawData, MemoryView CompressedData) const final
	{
		if (CompressedData.GetSize() <= std::numeric_limits<int>::max())
		{
			const int Size = LZ4_decompress_safe(static_cast<const char*>(CompressedData.GetData()),
												 static_cast<char*>(RawData.GetData()),
												 static_cast<int>(CompressedData.GetSize()),
												 static_cast<int>(zen::Min<uint64_t>(RawData.GetSize(), uint64_t(LZ4_MAX_INPUT_SIZE))));
			return static_cast<uint64_t>(Size) == RawData.GetSize();
		}
		return false;
	}
};

//////////////////////////////////////////////////////////////////////////

static const BaseDecoder*
GetDecoder(CompressionMethod Method)
{
	static NoneDecoder	None;
	static OodleDecoder Oodle;
	static LZ4Decoder	LZ4;

	switch (Method)
	{
		default:
			return nullptr;
		case CompressionMethod::None:
			return &None;
		case CompressionMethod::Oodle:
			return &Oodle;
		case CompressionMethod::LZ4:
			return &LZ4;
	}
}

//////////////////////////////////////////////////////////////////////////

bool
BufferHeader::IsValid(const CompositeBuffer& CompressedData)
{
	if (sizeof(BufferHeader) <= CompressedData.GetSize())
	{
		const BufferHeader Header = Read(CompressedData);
		if (Header.Magic == BufferHeader::ExpectedMagic)
		{
			if (const BaseDecoder* const Decoder = GetDecoder(Header.Method))
			{
				UniqueBuffer	 HeaderCopy;
				const MemoryView HeaderView = CompressedData.ViewOrCopyRange(0, Decoder->GetHeaderSize(Header), HeaderCopy);
				if (Header.Crc32 == BufferHeader::CalculateCrc32(HeaderView))
				{
					return true;
				}
			}
		}
	}
	return false;
}

//////////////////////////////////////////////////////////////////////////

template<typename BufferType>
inline CompositeBuffer
ValidBufferOrEmpty(BufferType&& CompressedData)
{
	return BufferHeader::IsValid(CompressedData) ? CompositeBuffer(std::forward<BufferType>(CompressedData)) : CompositeBuffer();
}

CompositeBuffer
CopyCompressedRange(const BufferHeader& Header, const CompositeBuffer& CompressedData, uint64_t RawOffset, uint64_t RawSize)
{
	if (Header.TotalRawSize < RawOffset + RawSize)
	{
		return CompositeBuffer();
	}

	if (Header.Method == CompressionMethod::None)
	{
		UniqueBuffer NewCompressedData = UniqueBuffer::Alloc(RawSize);
		CompressedData.CopyTo(NewCompressedData.GetMutableView(), sizeof(Header) + RawOffset);

		BufferHeader NewHeader		  = Header;
		NewHeader.Crc32				  = 0;
		NewHeader.TotalRawSize		  = RawSize;
		NewHeader.TotalCompressedSize = NewHeader.TotalRawSize + sizeof(BufferHeader);
		NewHeader.RawHash			  = BLAKE3();

		UniqueBuffer HeaderData = UniqueBuffer::Alloc(sizeof(BufferHeader));
		NewHeader.Write(HeaderData);

		return CompositeBuffer(HeaderData.MoveToShared(), NewCompressedData.MoveToShared());
	}
	else
	{
		UniqueBuffer BlockSizeBuffer;
		MemoryView	 BlockSizeView =
			CompressedData.ViewOrCopyRange(sizeof(BufferHeader), Header.BlockCount * sizeof(uint32_t), BlockSizeBuffer);
		std::span<uint32_t const> CompressedBlockSizes(reinterpret_cast<const uint32_t*>(BlockSizeView.GetData()), Header.BlockCount);

		const uint64_t BlockSize		= uint64_t(1) << Header.BlockSizeExponent;
		const uint64_t LastBlockSize	= BlockSize - ((Header.BlockCount * BlockSize) - Header.TotalRawSize);
		const size_t   FirstBlock		= uint64_t(RawOffset / BlockSize);
		const size_t   LastBlock		= uint64_t((RawOffset + RawSize - 1) / BlockSize);
		uint64_t	   CompressedOffset = sizeof(BufferHeader) + uint64_t(Header.BlockCount) * sizeof(uint32_t);

		const uint64_t		  NewBlockCount		= LastBlock - FirstBlock + 1;
		const uint64_t		  NewMetaSize		= NewBlockCount * sizeof(uint32_t);
		uint64_t			  NewCompressedSize = 0;
		uint64_t			  NewTotalRawSize	= 0;
		std::vector<uint32_t> NewCompressedBlockSizes;

		NewCompressedBlockSizes.reserve(NewBlockCount);
		for (size_t BlockIndex = FirstBlock; BlockIndex <= LastBlock; ++BlockIndex)
		{
			const uint64_t UncompressedBlockSize = (BlockIndex == Header.BlockCount - 1) ? LastBlockSize : BlockSize;
			NewTotalRawSize += UncompressedBlockSize;

			const uint32_t CompressedBlockSize = CompressedBlockSizes[BlockIndex];
			NewCompressedBlockSizes.push_back(CompressedBlockSize);
			NewCompressedSize += ByteSwap(CompressedBlockSize);
		}

		const uint64_t	  NewTotalCompressedSize = sizeof(BufferHeader) + NewBlockCount * sizeof(uint32_t) + NewCompressedSize;
		UniqueBuffer	  NewCompressedData		 = UniqueBuffer::Alloc(NewTotalCompressedSize);
		MutableMemoryView NewCompressedBlocks	 = NewCompressedData.GetMutableView() + sizeof(BufferHeader) + NewMetaSize;

		// Seek to first compressed block
		for (size_t BlockIndex = 0; BlockIndex < FirstBlock; ++BlockIndex)
		{
			const uint64_t CompressedBlockSize = ByteSwap(CompressedBlockSizes[BlockIndex]);
			CompressedOffset += CompressedBlockSize;
		}

		// Copy blocks
		UniqueBuffer	 CompressedBlockCopy;
		const MemoryView CompressedRange = CompressedData.ViewOrCopyRange(CompressedOffset, NewCompressedSize, CompressedBlockCopy);
		NewCompressedBlocks.CopyFrom(CompressedRange);

		// Copy block sizes
		NewCompressedData.GetMutableView().Mid(sizeof(BufferHeader), NewMetaSize).CopyFrom(MakeMemoryView(NewCompressedBlockSizes));

		BufferHeader NewHeader;
		NewHeader.Crc32				  = 0;
		NewHeader.Method			  = Header.Method;
		NewHeader.Compressor		  = Header.Compressor;
		NewHeader.CompressionLevel	  = Header.CompressionLevel;
		NewHeader.BlockSizeExponent	  = Header.BlockSizeExponent;
		NewHeader.BlockCount		  = static_cast<uint32_t>(NewBlockCount);
		NewHeader.TotalRawSize		  = NewTotalRawSize;
		NewHeader.TotalCompressedSize = NewTotalCompressedSize;
		NewHeader.RawHash			  = BLAKE3();
		NewHeader.Write(NewCompressedData.GetMutableView().Left(sizeof(BufferHeader) + NewMetaSize));

		return CompositeBuffer(NewCompressedData.MoveToShared());
	}
}

}  // namespace zen::detail

namespace zen {

const CompressedBuffer CompressedBuffer::Null;

CompressedBuffer
CompressedBuffer::Compress(const CompositeBuffer& RawData,
						   OodleCompressor		  Compressor,
						   OodleCompressionLevel  CompressionLevel,
						   uint64_t				  BlockSize)
{
	using namespace detail;

	if (BlockSize == 0)
	{
		BlockSize = DefaultBlockSize;
	}

	CompressedBuffer Local;
	if (CompressionLevel == OodleCompressionLevel::None)
	{
		Local.CompressedData = NoneEncoder().Compress(RawData, BlockSize);
	}
	else
	{
		Local.CompressedData = OodleEncoder(Compressor, CompressionLevel).Compress(RawData, BlockSize);
	}
	return Local;
}

CompressedBuffer
CompressedBuffer::Compress(const SharedBuffer&	 RawData,
						   OodleCompressor		 Compressor,
						   OodleCompressionLevel CompressionLevel,
						   uint64_t				 BlockSize)
{
	return Compress(CompositeBuffer(RawData), Compressor, CompressionLevel, BlockSize);
}

CompressedBuffer
CompressedBuffer::FromCompressed(const CompositeBuffer& InCompressedData)
{
	CompressedBuffer Local;
	Local.CompressedData = detail::ValidBufferOrEmpty(InCompressedData);
	return Local;
}

CompressedBuffer
CompressedBuffer::FromCompressed(CompositeBuffer&& InCompressedData)
{
	CompressedBuffer Local;
	Local.CompressedData = detail::ValidBufferOrEmpty(std::move(InCompressedData));
	return Local;
}

CompressedBuffer
CompressedBuffer::FromCompressed(const SharedBuffer& InCompressedData)
{
	CompressedBuffer Local;
	Local.CompressedData = detail::ValidBufferOrEmpty(InCompressedData);
	return Local;
}

CompressedBuffer
CompressedBuffer::FromCompressed(SharedBuffer&& InCompressedData)
{
	CompressedBuffer Local;
	Local.CompressedData = detail::ValidBufferOrEmpty(std::move(InCompressedData));
	return Local;
}

uint64_t
CompressedBuffer::GetRawSize() const
{
	return CompressedData ? detail::BufferHeader::Read(CompressedData).TotalRawSize : 0;
}

BLAKE3
CompressedBuffer::GetRawHash() const
{
	return CompressedData ? detail::BufferHeader::Read(CompressedData).RawHash : BLAKE3();
}

CompressedBuffer
CompressedBuffer::CopyRange(uint64_t RawOffset, uint64_t RawSize) const
{
	using namespace detail;
	const BufferHeader Header		= BufferHeader::Read(CompressedData);
	const uint64_t	   TotalRawSize = RawSize < ~uint64_t(0) ? RawSize : Header.TotalRawSize - RawOffset;

	CompressedBuffer Range;
	Range.CompressedData = CopyCompressedRange(Header, CompressedData, RawOffset, TotalRawSize);

	return Range;
}

bool
CompressedBuffer::TryDecompressTo(MutableMemoryView RawView, uint64_t RawOffset) const
{
	using namespace detail;
	if (CompressedData)
	{
		const BufferHeader Header = BufferHeader::Read(CompressedData);
		if (const BaseDecoder* const Decoder = GetDecoder(Header.Method))
		{
			return Decoder->TryDecompressTo(Header, CompressedData, RawView, RawOffset);
		}
	}
	return false;
}

SharedBuffer
CompressedBuffer::Decompress(uint64_t RawOffset, uint64_t RawSize) const
{
	using namespace detail;
	if (CompressedData && RawSize > 0)
	{
		const BufferHeader Header = BufferHeader::Read(CompressedData);
		if (const BaseDecoder* const Decoder = GetDecoder(Header.Method))
		{
			const uint64_t TotalRawSize = RawSize < ~uint64_t(0) ? RawSize : Header.TotalRawSize - RawOffset;
			UniqueBuffer   RawData		= UniqueBuffer::Alloc(TotalRawSize);
			if (Decoder->TryDecompressTo(Header, CompressedData, RawData, RawOffset))
			{
				return RawData.MoveToShared();
			}
		}
	}
	return SharedBuffer();
}

CompositeBuffer
CompressedBuffer::DecompressToComposite() const
{
	using namespace detail;
	if (CompressedData)
	{
		const BufferHeader Header = BufferHeader::Read(CompressedData);
		if (const BaseDecoder* const Decoder = GetDecoder(Header.Method))
		{
			return Decoder->Decompress(Header, CompressedData);
		}
	}
	return CompositeBuffer();
}

bool
CompressedBuffer::TryGetCompressParameters(OodleCompressor& OutCompressor, OodleCompressionLevel& OutCompressionLevel) const
{
	using namespace detail;
	if (CompressedData)
	{
		switch (const BufferHeader Header = BufferHeader::Read(CompressedData); Header.Method)
		{
			case CompressionMethod::None:
				OutCompressor		= OodleCompressor::NotSet;
				OutCompressionLevel = OodleCompressionLevel::None;
				return true;
			case CompressionMethod::Oodle:
				OutCompressor		= OodleCompressor(Header.Compressor);
				OutCompressionLevel = OodleCompressionLevel(Header.CompressionLevel);
				return true;
			default:
				break;
		}
	}
	return false;
}

/**
	______________________ _____________________________
	\__    ___/\_   _____//   _____/\__    ___/   _____/
	  |    |    |    __)_ \_____  \   |    |  \_____  \
	  |    |    |        \/        \  |    |  /        \
	  |____|   /_______  /_______  /  |____| /_______  /
					   \/        \/                  \/
 */

#if ZEN_WITH_TESTS

TEST_CASE("CompressedBuffer")
{
	uint8_t Zeroes[1024]{};
	uint8_t Ones[1024];
	memset(Ones, 1, sizeof Ones);

	{
		CompressedBuffer Buffer = CompressedBuffer::Compress(CompositeBuffer(SharedBuffer::MakeView(MakeMemoryView(Zeroes))),
															 OodleCompressor::NotSet,
															 OodleCompressionLevel::None);

		CHECK(Buffer.GetRawSize() == sizeof(Zeroes));
		CHECK(Buffer.GetCompressedSize() == (sizeof(Zeroes) + sizeof(detail::BufferHeader)));

		CompositeBuffer	 Compressed = Buffer.GetCompressed();
		CompressedBuffer BufferD	= CompressedBuffer::FromCompressed(Compressed);

		CHECK(BufferD.IsNull() == false);

		CompositeBuffer Decomp = BufferD.DecompressToComposite();

		CHECK(Decomp.GetSize() == Buffer.GetRawSize());
		CHECK(BLAKE3::HashBuffer(Decomp) == BufferD.GetRawHash());
	}

	{
		CompressedBuffer Buffer = CompressedBuffer::Compress(
			CompositeBuffer(SharedBuffer::MakeView(MakeMemoryView(Zeroes)), SharedBuffer::MakeView(MakeMemoryView(Ones))),
			OodleCompressor::NotSet,
			OodleCompressionLevel::None);

		CHECK(Buffer.GetRawSize() == (sizeof(Zeroes) + sizeof(Ones)));
		CHECK(Buffer.GetCompressedSize() == (sizeof(Zeroes) + sizeof(Ones) + sizeof(detail::BufferHeader)));

		CompositeBuffer	 Compressed = Buffer.GetCompressed();
		CompressedBuffer BufferD	= CompressedBuffer::FromCompressed(Compressed);

		CHECK(BufferD.IsNull() == false);

		CompositeBuffer Decomp = BufferD.DecompressToComposite();

		CHECK(Decomp.GetSize() == Buffer.GetRawSize());
		CHECK(BLAKE3::HashBuffer(Decomp) == BufferD.GetRawHash());
	}

	{
		CompressedBuffer Buffer = CompressedBuffer::Compress(CompositeBuffer(SharedBuffer::MakeView(MakeMemoryView(Zeroes))));

		CHECK(Buffer.GetRawSize() == sizeof(Zeroes));
		CHECK(Buffer.GetCompressedSize() < sizeof(Zeroes));

		CompositeBuffer	 Compressed = Buffer.GetCompressed();
		CompressedBuffer BufferD	= CompressedBuffer::FromCompressed(Compressed);

		CHECK(BufferD.IsNull() == false);

		CompositeBuffer Decomp = BufferD.DecompressToComposite();

		CHECK(Decomp.GetSize() == Buffer.GetRawSize());
		CHECK(BLAKE3::HashBuffer(Decomp) == BufferD.GetRawHash());
	}

	{
		CompressedBuffer Buffer = CompressedBuffer::Compress(
			CompositeBuffer(SharedBuffer::MakeView(MakeMemoryView(Zeroes)), SharedBuffer::MakeView(MakeMemoryView(Ones))));

		CHECK(Buffer.GetRawSize() == (sizeof(Zeroes) + sizeof(Ones)));
		CHECK(Buffer.GetCompressedSize() < (sizeof(Zeroes) + sizeof(Ones)));

		CompositeBuffer	 Compressed = Buffer.GetCompressed();
		CompressedBuffer BufferD	= CompressedBuffer::FromCompressed(Compressed);

		CHECK(BufferD.IsNull() == false);

		CompositeBuffer Decomp = BufferD.DecompressToComposite();

		CHECK(Decomp.GetSize() == Buffer.GetRawSize());
		CHECK(BLAKE3::HashBuffer(Decomp) == BufferD.GetRawHash());
	}

	auto GenerateData = [](uint64_t N) -> std::vector<uint64_t> {
		std::vector<uint64_t> Data;
		Data.resize(N);
		for (size_t Idx = 0; Idx < Data.size(); ++Idx)
		{
			Data[Idx] = Idx;
		}
		return Data;
	};

	auto ValidateData = [](std::span<uint64_t const> Values, std::span<uint64_t const> ExpectedValues, uint64_t Offset) {
		for (size_t Idx = Offset; uint64_t Value : Values)
		{
			const uint64_t ExpectedValue = ExpectedValues[Idx++];
			CHECK(Value == ExpectedValue);
		}
	};

	SUBCASE("decompress with offset and size")
	{
		auto UncompressAndValidate = [&ValidateData](CompressedBuffer			  Compressed,
													 uint64_t					  OffsetCount,
													 uint64_t					  Count,
													 const std::vector<uint64_t>& ExpectedValues) {
			SharedBuffer Uncompressed = Compressed.Decompress(OffsetCount * sizeof(uint64_t), Count * sizeof(uint64_t));
			CHECK(Uncompressed.GetSize() == Count * sizeof(uint64_t));
			std::span<uint64_t const> Values((const uint64_t*)Uncompressed.GetData(), Uncompressed.GetSize() / sizeof(uint64_t));
			ValidateData(Values, ExpectedValues, OffsetCount);
		};

		const uint64_t		  BlockSize		 = 64 * sizeof(uint64_t);
		const uint64_t		  N				 = 5000;
		std::vector<uint64_t> ExpectedValues = GenerateData(N);
		CompressedBuffer	  Compressed	 = CompressedBuffer::Compress(SharedBuffer::MakeView(MakeMemoryView(ExpectedValues)),
																  OodleCompressor::Mermaid,
																  OodleCompressionLevel::Optimal4,
																  BlockSize);
		UncompressAndValidate(Compressed, 0, N, ExpectedValues);
		UncompressAndValidate(Compressed, 1, N - 1, ExpectedValues);
		UncompressAndValidate(Compressed, N - 1, 1, ExpectedValues);
		UncompressAndValidate(Compressed, 0, 1, ExpectedValues);
		UncompressAndValidate(Compressed, 2, 4, ExpectedValues);
		UncompressAndValidate(Compressed, 0, 512, ExpectedValues);
		UncompressAndValidate(Compressed, 3, 514, ExpectedValues);
		UncompressAndValidate(Compressed, 256, 512, ExpectedValues);
		UncompressAndValidate(Compressed, 512, 512, ExpectedValues);
	}

	SUBCASE("decompress with offset only")
	{
		const uint64_t			  BlockSize		 = 64 * sizeof(uint64_t);
		const uint64_t			  N				 = 1000;
		std::vector<uint64_t>	  ExpectedValues = GenerateData(N);
		CompressedBuffer		  Compressed	 = CompressedBuffer::Compress(SharedBuffer::MakeView(MakeMemoryView(ExpectedValues)),
																  OodleCompressor::Mermaid,
																  OodleCompressionLevel::Optimal4,
																  BlockSize);
		const uint64_t			  OffsetCount	 = 150;
		SharedBuffer			  Uncompressed	 = Compressed.Decompress(OffsetCount * sizeof(uint64_t));
		std::span<uint64_t const> Values((const uint64_t*)Uncompressed.GetData(), Uncompressed.GetSize() / sizeof(uint64_t));
		ValidateData(Values, ExpectedValues, OffsetCount);
	}

	SUBCASE("decompress buffer with one block")
	{
		const uint64_t			  BlockSize		 = 256 * sizeof(uint64_t);
		const uint64_t			  N				 = 100;
		std::vector<uint64_t>	  ExpectedValues = GenerateData(N);
		CompressedBuffer		  Compressed	 = CompressedBuffer::Compress(SharedBuffer::MakeView(MakeMemoryView(ExpectedValues)),
																  OodleCompressor::Mermaid,
																  OodleCompressionLevel::Optimal4,
																  BlockSize);
		const uint64_t			  OffsetCount	 = 2;
		const uint64_t			  Count			 = 50;
		SharedBuffer			  Uncompressed	 = Compressed.Decompress(OffsetCount * sizeof(uint64_t), Count * sizeof(uint64_t));
		std::span<uint64_t const> Values((const uint64_t*)Uncompressed.GetData(), Uncompressed.GetSize() / sizeof(uint64_t));
		ValidateData(Values, ExpectedValues, OffsetCount);
	}

	SUBCASE("decompress uncompressed buffer")
	{
		const uint64_t		  N				 = 4242;
		std::vector<uint64_t> ExpectedValues = GenerateData(N);
		CompressedBuffer	  Compressed	 = CompressedBuffer::Compress(SharedBuffer::MakeView(MakeMemoryView(ExpectedValues)),
																  OodleCompressor::NotSet,
																  OodleCompressionLevel::None);
		{
			const uint64_t			  OffsetCount  = 0;
			const uint64_t			  Count		   = N;
			SharedBuffer			  Uncompressed = Compressed.Decompress(OffsetCount * sizeof(uint64_t), Count * sizeof(uint64_t));
			std::span<uint64_t const> Values((const uint64_t*)Uncompressed.GetData(), Uncompressed.GetSize() / sizeof(uint64_t));
			ValidateData(Values, ExpectedValues, OffsetCount);
		}

		{
			const uint64_t			  OffsetCount  = 21;
			const uint64_t			  Count		   = 999;
			SharedBuffer			  Uncompressed = Compressed.Decompress(OffsetCount * sizeof(uint64_t), Count * sizeof(uint64_t));
			std::span<uint64_t const> Values((const uint64_t*)Uncompressed.GetData(), Uncompressed.GetSize() / sizeof(uint64_t));
			ValidateData(Values, ExpectedValues, OffsetCount);
		}
	}

	SUBCASE("copy range")
	{
		const uint64_t		  BlockSize		 = 64 * sizeof(uint64_t);
		const uint64_t		  N				 = 1000;
		std::vector<uint64_t> ExpectedValues = GenerateData(N);

		CompressedBuffer Compressed = CompressedBuffer::Compress(SharedBuffer::MakeView(MakeMemoryView(ExpectedValues)),
																 OodleCompressor::Mermaid,
																 OodleCompressionLevel::Optimal4,
																 BlockSize);

		{
			const uint64_t OffsetCount	= 0;
			const uint64_t Count		= N;
			SharedBuffer   Uncompressed = Compressed.CopyRange(OffsetCount * sizeof(uint64_t), Count * sizeof(uint64_t)).Decompress();
			std::span<uint64_t const> Values((const uint64_t*)Uncompressed.GetData(), Uncompressed.GetSize() / sizeof(uint64_t));
			CHECK(Values.size() == Count);
			ValidateData(Values, ExpectedValues, OffsetCount);
		}

		{
			const uint64_t OffsetCount	= 64;
			const uint64_t Count		= N - 64;
			SharedBuffer   Uncompressed = Compressed.CopyRange(OffsetCount * sizeof(uint64_t), Count * sizeof(uint64_t)).Decompress();
			std::span<uint64_t const> Values((const uint64_t*)Uncompressed.GetData(), Uncompressed.GetSize() / sizeof(uint64_t));
			CHECK(Values.size() == Count);
			ValidateData(Values, ExpectedValues, OffsetCount);
		}

		{
			const uint64_t OffsetCount		= 64 * 2 + 32;
			const uint64_t Count			= N - OffsetCount;
			const uint64_t RawOffset		= OffsetCount * sizeof(uint64_t);
			const uint64_t RawSize			= Count * sizeof(uint64_t);
			uint64_t	   FirstBlockOffset = RawOffset % BlockSize;

			SharedBuffer			  Uncompressed = Compressed.CopyRange(RawOffset, RawSize).Decompress();
			std::span<uint64_t const> AllValues((const uint64_t*)Uncompressed.GetData(), RawSize / sizeof(uint64_t));
			std::span<uint64_t const> Values((const uint64_t*)(((const uint8_t*)(Uncompressed.GetData()) + FirstBlockOffset)),
											 RawSize / sizeof(uint64_t));
			CHECK(Values.size() == Count);
			ValidateData(Values, ExpectedValues, OffsetCount);
		}

		{
			const uint64_t OffsetCount		= 64 * 2 + 63;
			const uint64_t Count			= N - OffsetCount - 5;
			const uint64_t RawOffset		= OffsetCount * sizeof(uint64_t);
			const uint64_t RawSize			= Count * sizeof(uint64_t);
			uint64_t	   FirstBlockOffset = RawOffset % BlockSize;

			SharedBuffer			  Uncompressed = Compressed.CopyRange(RawOffset, RawSize).Decompress();
			std::span<uint64_t const> AllValues((const uint64_t*)Uncompressed.GetData(), RawSize / sizeof(uint64_t));
			std::span<uint64_t const> Values((const uint64_t*)(((const uint8_t*)(Uncompressed.GetData()) + FirstBlockOffset)),
											 RawSize / sizeof(uint64_t));
			CHECK(Values.size() == Count);
			ValidateData(Values, ExpectedValues, OffsetCount);
		}
	}

	SUBCASE("copy uncompressed range")
	{
		const uint64_t		  N				 = 1000;
		std::vector<uint64_t> ExpectedValues = GenerateData(N);

		CompressedBuffer Compressed = CompressedBuffer::Compress(SharedBuffer::MakeView(MakeMemoryView(ExpectedValues)),
																 OodleCompressor::NotSet,
																 OodleCompressionLevel::None);

		{
			const uint64_t OffsetCount	= 0;
			const uint64_t Count		= N;
			SharedBuffer   Uncompressed = Compressed.CopyRange(OffsetCount * sizeof(uint64_t), Count * sizeof(uint64_t)).Decompress();
			std::span<uint64_t const> Values((const uint64_t*)Uncompressed.GetData(), Uncompressed.GetSize() / sizeof(uint64_t));
			CHECK(Values.size() == Count);
			ValidateData(Values, ExpectedValues, OffsetCount);
		}

		{
			const uint64_t OffsetCount	= 1;
			const uint64_t Count		= N - OffsetCount;
			SharedBuffer   Uncompressed = Compressed.CopyRange(OffsetCount * sizeof(uint64_t), Count * sizeof(uint64_t)).Decompress();
			std::span<uint64_t const> Values((const uint64_t*)Uncompressed.GetData(), Uncompressed.GetSize() / sizeof(uint64_t));
			CHECK(Values.size() == Count);
			ValidateData(Values, ExpectedValues, OffsetCount);
		}

		{
			const uint64_t OffsetCount	= 42;
			const uint64_t Count		= 100;
			SharedBuffer   Uncompressed = Compressed.CopyRange(OffsetCount * sizeof(uint64_t), Count * sizeof(uint64_t)).Decompress();
			std::span<uint64_t const> Values((const uint64_t*)Uncompressed.GetData(), Uncompressed.GetSize() / sizeof(uint64_t));
			CHECK(Values.size() == Count);
			ValidateData(Values, ExpectedValues, OffsetCount);
		}
	}
}

void
compress_forcelink()
{
}
#endif

}  // namespace zen