Move stream compression code to lib; fix max block size reduction bug

Author: marty-emmanuel

Makefile

@@ -11,8 +11,9 @@ $(OBJDIR)/%.o: src/../%.c
 APP := lz4ultra
 
 OBJS := $(OBJDIR)/src/lz4ultra.o
-OBJS += $(OBJDIR)/src/frame.o
 OBJS += $(OBJDIR)/src/lib.o
+OBJS += $(OBJDIR)/src/stream.o
+OBJS += $(OBJDIR)/src/frame.o
 OBJS += $(OBJDIR)/src/matchfinder.o
 OBJS += $(OBJDIR)/src/shrink.o
 OBJS += $(OBJDIR)/src/expand.o

VS2017/lz4ultra.vcxproj

@@ -186,6 +186,7 @@
     <ClInclude Include="..\src\libdivsufsort\include\divsufsort_private.h" />
     <ClInclude Include="..\src\matchfinder.h" />
     <ClInclude Include="..\src\shrink.h" />
+    <ClInclude Include="..\src\stream.h" />
     <ClInclude Include="..\src\xxhash\xxhash.h" />
     <ClInclude Include="pch.h" />
   </ItemGroup>
@@ -200,6 +201,7 @@
     <ClCompile Include="..\src\lz4ultra.c" />
     <ClCompile Include="..\src\matchfinder.c" />
     <ClCompile Include="..\src\shrink.c" />
+    <ClCompile Include="..\src\stream.c" />
     <ClCompile Include="..\src\xxhash\xxhash.c" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />

VS2017/lz4ultra.vcxproj.filters

@@ -60,6 +60,9 @@
     <ClInclude Include="..\src\frame.h">
       <Filter>Fichiers sources</Filter>
     </ClInclude>
+    <ClInclude Include="..\src\stream.h">
+      <Filter>Fichiers sources</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="..\src\libdivsufsort\lib\divsufsort.c">
@@ -95,5 +98,8 @@
     <ClCompile Include="..\src\frame.c">
       <Filter>Fichiers sources</Filter>
     </ClCompile>
+    <ClCompile Include="..\src\stream.c">
+      <Filter>Fichiers sources</Filter>
+    </ClCompile>
   </ItemGroup>
 </Project>

src/expand.c

@@ -147,7 +147,7 @@ static inline FORCE_INLINE int lz4ultra_expand_match_slow(const unsigned char **
  *
  * @return size of decompressed data in bytes, or -1 for error
  */
-int lz4ultra_expand_block_lz4(const unsigned char *pInBlock, int nBlockSize, unsigned char *pOutData, int nOutDataOffset, int nBlockMaxSize) {
+int lz4ultra_decompressor_expand_block_lz4(const unsigned char *pInBlock, int nBlockSize, unsigned char *pOutData, int nOutDataOffset, int nBlockMaxSize) {
    const unsigned char *pInBlockEnd = pInBlock + nBlockSize;
    const unsigned char *pInBlockFastEnd = pInBlock + nBlockSize - 16;
    unsigned char *pCurOutData = pOutData + nOutDataOffset;

src/expand.h

@@ -44,6 +44,6 @@
  *
  * @return size of decompressed data in bytes, or -1 for error
  */
-int lz4ultra_expand_block_lz4(const unsigned char *pInBlock, int nBlockSize, unsigned char *pOutData, int nOutDataOffset, int nBlockMaxSize);
+int lz4ultra_decompressor_expand_block_lz4(const unsigned char *pInBlock, int nBlockSize, unsigned char *pOutData, int nOutDataOffset, int nBlockMaxSize);
 
 #endif /* _EXPAND_H */

src/frame.c

@@ -39,19 +39,19 @@
  * @param pFrameData encoding buffer
  * @param nMaxFrameDataSize max encoding buffer size, in bytes
  * @param nBlockMaxCode max block size code (4-7)
- * @param bIndependentBlocks true if the stream contains independently compressed blocks, false if blocks back-reference the previous block
+ * @param nIsIndependentBlocks nonzero if the stream contains independently compressed blocks, 0 if blocks back-reference the previous block
  *
  * @return number of encoded bytes, or -1 for failure
  */
-int lz4ultra_encode_header(unsigned char *pFrameData, const int nMaxFrameDataSize, int nBlockMaxCode, bool bIndependentBlocks) {
+int lz4ultra_encode_header(unsigned char *pFrameData, const int nMaxFrameDataSize, int nBlockMaxCode, int nIsIndependentBlocks) {
    if (nMaxFrameDataSize >= 7) {
       pFrameData[0] = 0x04;                              /* Magic number: 0x184D2204 */
       pFrameData[1] = 0x22;
       pFrameData[2] = 0x4D;
       pFrameData[3] = 0x18;
 
       pFrameData[4] = 0b01000000;                        /* Version.Hi Version.Lo !B.Indep B.Checksum Content.Size Content.Checksum Reserved.Hi Reserved.Lo */
-      if (bIndependentBlocks)
+      if (nIsIndependentBlocks)
          pFrameData[4] |= 0b00100000;                    /*                       B.Indep */
       pFrameData[5] = nBlockMaxCode << 4;                /* Block MaxSize */
 
@@ -136,11 +136,11 @@ int lz4ultra_encode_footer_frame(unsigned char *pFrameData, const int nMaxFrameD
  * @param pFrameData data bytes
  * @param nFrameDataSize number of bytes to decode
  * @param nBlockMaxCode pointer to max block size code (4-7), updated if this function succeeds
- * @param bIndependentBlocks returned flag that indicates if the stream contains independently compressed blocks
+ * @param nIsIndependentBlocks returned flag that indicates if the stream contains independently compressed blocks
  *
  * @return LZ4ULTRA_DECODE_OK for success, or LZ4ULTRA_DECODE_ERR_xxx for failure
  */
-int lz4ultra_decode_header(const unsigned char *pFrameData, const int nFrameDataSize, int *nBlockMaxCode, bool *bIndependentBlocks) {
+int lz4ultra_decode_header(const unsigned char *pFrameData, const int nFrameDataSize, int *nBlockMaxCode, int *nIsIndependentBlocks) {
    if (nFrameDataSize == 7) {
       if (pFrameData[0] != 0x04 ||
          pFrameData[1] != 0x22 ||
@@ -156,7 +156,7 @@ int lz4ultra_decode_header(const unsigned char *pFrameData, const int nFrameData
          return LZ4ULTRA_DECODE_ERR_SUM;
       }
 
-      *bIndependentBlocks = (pFrameData[4] & 0x20) != 0;
+      *nIsIndependentBlocks = (pFrameData[4] & 0x20) ? 1 : 0;
       *nBlockMaxCode = (pFrameData[5] >> 4);
 
       return LZ4ULTRA_DECODE_OK;
@@ -176,14 +176,14 @@ int lz4ultra_decode_header(const unsigned char *pFrameData, const int nFrameData
  *
  * @return LZ4ULTRA_DECODE_OK for success, or LZ4ULTRA_DECODE_ERR_FORMAT for failure
  */
-int lz4ultra_decode_frame(const unsigned char *pFrameData, const int nFrameDataSize, unsigned int *nBlockSize, bool *bIsUncompressed) {
+int lz4ultra_decode_frame(const unsigned char *pFrameData, const int nFrameDataSize, unsigned int *nBlockSize, int *nIsUncompressed) {
    if (nFrameDataSize == 4) {
       *nBlockSize = ((unsigned int)pFrameData[0]) |
          (((unsigned int)pFrameData[1]) << 8) |
          (((unsigned int)pFrameData[2]) << 16) |
          (((unsigned int)pFrameData[3]) << 24);
 
-      *bIsUncompressed = ((*nBlockSize) & 0x80000000) != 0;
+      *nIsUncompressed = ((*nBlockSize) & 0x80000000) ? 1 : 0;
       (*nBlockSize) &= 0x7fffffff;
       return 0;
    }

src/frame.h

@@ -34,7 +34,6 @@
 #define _FRAME_H
 
 #include <stdio.h>
-#include <stdbool.h>
 
 #define LZ4ULTRA_HEADER_SIZE        7
 #define LZ4ULTRA_FRAME_SIZE         4
@@ -51,11 +50,11 @@
  * @param pFrameData encoding buffer
  * @param nMaxFrameDataSize max encoding buffer size, in bytes
  * @param nBlockMaxCode max block size code (4-7)
- * @param bIndependentBlocks true if the stream contains independently compressed blocks, false if blocks back-reference the previous block
+ * @param nIsIndependentBlocks nonzero if the stream contains independently compressed blocks, 0 if blocks back-reference the previous block
  *
  * @return number of encoded bytes, or -1 for failure
  */
-int lz4ultra_encode_header(unsigned char *pFrameData, const int nMaxFrameDataSize, int nBlockMaxCode, bool bIndependentBlocks);
+int lz4ultra_encode_header(unsigned char *pFrameData, const int nMaxFrameDataSize, int nBlockMaxCode, int nIsIndependentBlocks);
 
 /**
  * Encode compressed block frame header
@@ -95,11 +94,11 @@ int lz4ultra_encode_footer_frame(unsigned char *pFrameData, const int nMaxFrameD
  * @param pFrameData data bytes
  * @param nFrameDataSize number of bytes to decode
  * @param nBlockMaxCode pointer to max block size code (4-7), updated if this function succeeds
- * @param bIndependentBlocks returned flag that indicates if the stream contains independently compressed blocks
+ * @param nIsIndependentBlocks returned flag that indicates if the stream contains independently compressed blocks
  *
  * @return LZ4ULTRA_DECODE_OK for success, or LZ4ULTRA_DECODE_ERR_xxx for failure
  */
-int lz4ultra_decode_header(const unsigned char *pFrameData, const int nFrameDataSize, int *nBlockMaxCode, bool *bIndependentBlocks);
+int lz4ultra_decode_header(const unsigned char *pFrameData, const int nFrameDataSize, int *nBlockMaxCode, int *nIsIndependentBlocks);
 
 /**
  * Decode frame header
@@ -111,6 +110,6 @@ int lz4ultra_decode_header(const unsigned char *pFrameData, const int nFrameData
  *
  * @return LZ4ULTRA_DECODE_OK for success, or LZ4ULTRA_DECODE_ERR_FORMAT for failure
  */
-int lz4ultra_decode_frame(const unsigned char *pFrameData, const int nFrameDataSize, unsigned int *nBlockSize, bool *bIsUncompressed);
+int lz4ultra_decode_frame(const unsigned char *pFrameData, const int nFrameDataSize, unsigned int *nBlockSize, int *nIsUncompressed);
 
 #endif /* _FRAME_H */