HCStreaming_ringBuffer.c 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. // LZ4 HC streaming API example : ring buffer
  2. // Based on a previous example by Takayuki Matsuoka
  3. /**************************************
  4. * Compiler Options
  5. **************************************/
  6. #if defined(_MSC_VER) && (_MSC_VER <= 1800) /* Visual Studio <= 2013 */
  7. # define _CRT_SECURE_NO_WARNINGS
  8. # define snprintf sprintf_s
  9. #endif
  10. #define GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__)
  11. #ifdef __GNUC__
  12. # pragma GCC diagnostic ignored "-Wmissing-braces" /* GCC bug 53119 : doesn't accept { 0 } as initializer (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=53119) */
  13. #endif
  14. /**************************************
  15. * Includes
  16. **************************************/
  17. #include "lz4hc.h"
  18. #include "lz4.h"
  19. #include <stdio.h>
  20. #include <stdint.h>
  21. #include <stdlib.h>
  22. #include <string.h>
  23. #include <assert.h>
  24. enum {
  25. MESSAGE_MAX_BYTES = 1024,
  26. RING_BUFFER_BYTES = 1024 * 8 + MESSAGE_MAX_BYTES,
  27. DEC_BUFFER_BYTES = RING_BUFFER_BYTES + MESSAGE_MAX_BYTES // Intentionally larger to test unsynchronized ring buffers
  28. };
  29. size_t write_int32(FILE* fp, int32_t i) {
  30. return fwrite(&i, sizeof(i), 1, fp);
  31. }
  32. size_t write_bin(FILE* fp, const void* array, int arrayBytes) {
  33. assert(arrayBytes >= 0);
  34. return fwrite(array, 1, (size_t)arrayBytes, fp);
  35. }
  36. size_t read_int32(FILE* fp, int32_t* i) {
  37. return fread(i, sizeof(*i), 1, fp);
  38. }
  39. size_t read_bin(FILE* fp, void* array, int arrayBytes) {
  40. assert(arrayBytes >= 0);
  41. return fread(array, 1, (size_t)arrayBytes, fp);
  42. }
  43. void test_compress(FILE* outFp, FILE* inpFp)
  44. {
  45. LZ4_streamHC_t lz4Stream_body = { 0 };
  46. LZ4_streamHC_t* lz4Stream = &lz4Stream_body;
  47. static char inpBuf[RING_BUFFER_BYTES];
  48. int inpOffset = 0;
  49. for(;;) {
  50. // Read random length ([1,MESSAGE_MAX_BYTES]) data to the ring buffer.
  51. char* const inpPtr = &inpBuf[inpOffset];
  52. const int randomLength = (rand() % MESSAGE_MAX_BYTES) + 1;
  53. const int inpBytes = (int) read_bin(inpFp, inpPtr, randomLength);
  54. if (0 == inpBytes) break;
  55. #define CMPBUFSIZE (LZ4_COMPRESSBOUND(MESSAGE_MAX_BYTES))
  56. { char cmpBuf[CMPBUFSIZE];
  57. const int cmpBytes = LZ4_compress_HC_continue(lz4Stream, inpPtr, cmpBuf, inpBytes, CMPBUFSIZE);
  58. if(cmpBytes <= 0) break;
  59. write_int32(outFp, cmpBytes);
  60. write_bin(outFp, cmpBuf, cmpBytes);
  61. inpOffset += inpBytes;
  62. // Wraparound the ringbuffer offset
  63. if(inpOffset >= RING_BUFFER_BYTES - MESSAGE_MAX_BYTES)
  64. inpOffset = 0;
  65. }
  66. }
  67. write_int32(outFp, 0);
  68. }
  69. void test_decompress(FILE* outFp, FILE* inpFp)
  70. {
  71. static char decBuf[DEC_BUFFER_BYTES];
  72. int decOffset = 0;
  73. LZ4_streamDecode_t lz4StreamDecode_body = { 0 };
  74. LZ4_streamDecode_t* lz4StreamDecode = &lz4StreamDecode_body;
  75. for(;;) {
  76. int cmpBytes = 0;
  77. char cmpBuf[CMPBUFSIZE];
  78. { const size_t r0 = read_int32(inpFp, &cmpBytes);
  79. size_t r1;
  80. if(r0 != 1 || cmpBytes <= 0)
  81. break;
  82. r1 = read_bin(inpFp, cmpBuf, cmpBytes);
  83. if(r1 != (size_t) cmpBytes)
  84. break;
  85. }
  86. { char* const decPtr = &decBuf[decOffset];
  87. const int decBytes = LZ4_decompress_safe_continue(
  88. lz4StreamDecode, cmpBuf, decPtr, cmpBytes, MESSAGE_MAX_BYTES);
  89. if(decBytes <= 0)
  90. break;
  91. decOffset += decBytes;
  92. write_bin(outFp, decPtr, decBytes);
  93. // Wraparound the ringbuffer offset
  94. if(decOffset >= DEC_BUFFER_BYTES - MESSAGE_MAX_BYTES)
  95. decOffset = 0;
  96. }
  97. }
  98. }
  99. // Compare 2 files content
  100. // return 0 if identical
  101. // return ByteNb>0 if different
  102. size_t compare(FILE* f0, FILE* f1)
  103. {
  104. size_t result = 1;
  105. for (;;) {
  106. char b0[65536];
  107. char b1[65536];
  108. const size_t r0 = fread(b0, 1, sizeof(b0), f0);
  109. const size_t r1 = fread(b1, 1, sizeof(b1), f1);
  110. if ((r0==0) && (r1==0)) return 0; // success
  111. if (r0 != r1) {
  112. size_t smallest = r0;
  113. if (r1<r0) smallest = r1;
  114. result += smallest;
  115. break;
  116. }
  117. if (memcmp(b0, b1, r0)) {
  118. unsigned errorPos = 0;
  119. while ((errorPos < r0) && (b0[errorPos]==b1[errorPos])) errorPos++;
  120. result += errorPos;
  121. break;
  122. }
  123. result += sizeof(b0);
  124. }
  125. return result;
  126. }
  127. int main(int argc, const char** argv)
  128. {
  129. char inpFilename[256] = { 0 };
  130. char lz4Filename[256] = { 0 };
  131. char decFilename[256] = { 0 };
  132. unsigned fileID = 1;
  133. unsigned pause = 0;
  134. if(argc < 2) {
  135. printf("Please specify input filename\n");
  136. return 0;
  137. }
  138. if (!strcmp(argv[1], "-p")) { pause = 1; fileID = 2; }
  139. snprintf(inpFilename, 256, "%s", argv[fileID]);
  140. snprintf(lz4Filename, 256, "%s.lz4s-%d", argv[fileID], 9);
  141. snprintf(decFilename, 256, "%s.lz4s-%d.dec", argv[fileID], 9);
  142. printf("input = [%s]\n", inpFilename);
  143. printf("lz4 = [%s]\n", lz4Filename);
  144. printf("decoded = [%s]\n", decFilename);
  145. // compress
  146. { FILE* const inpFp = fopen(inpFilename, "rb");
  147. FILE* const outFp = fopen(lz4Filename, "wb");
  148. test_compress(outFp, inpFp);
  149. fclose(outFp);
  150. fclose(inpFp);
  151. }
  152. // decompress
  153. { FILE* const inpFp = fopen(lz4Filename, "rb");
  154. FILE* const outFp = fopen(decFilename, "wb");
  155. test_decompress(outFp, inpFp);
  156. fclose(outFp);
  157. fclose(inpFp);
  158. }
  159. // verify
  160. { FILE* const inpFp = fopen(inpFilename, "rb");
  161. FILE* const decFp = fopen(decFilename, "rb");
  162. const size_t cmp = compare(inpFp, decFp);
  163. if(0 == cmp) {
  164. printf("Verify : OK\n");
  165. } else {
  166. printf("Verify : NG : error at pos %u\n", (unsigned)cmp-1);
  167. }
  168. fclose(decFp);
  169. fclose(inpFp);
  170. }
  171. if (pause) {
  172. int unused;
  173. printf("Press enter to continue ...\n");
  174. unused = getchar(); (void)unused; /* silence static analyzer */
  175. }
  176. return 0;
  177. }