3.1.92 • Published 4 months ago

@thi.ng/rle-pack v3.1.92

Weekly downloads
208
License
Apache-2.0
Repository
github
Last release
4 months ago

rle-pack

npm version npm downloads Twitter Follow

This project is part of the @thi.ng/umbrella monorepo.

About

Binary run-length encoding packer/unpacker with support for customizable input word sizes (1 - 32 bits) and repeat count (run-length) bit sizes (1 - 16 bits). The encoder uses 4 different repeat group sizes (thresholds) to minimize the number of bits used to store the run lengths. The range of supported run lengths is 16 bits (i.e. 65536 repetitions). If a value is repeated more often than that, the remainder will be encoded using additional RLE chunks...

Encoding format

data layout

  • 32 bits - original number of words
  • 5 bits - word size
  • 16 bits - 4x RLE repeat group / chunk sizes (in bits)

The default group sizes are: 3, 4, 8, 16, i.e. 8, 16, 256, 65536 repetitions

Then per value:

  • 1 bit - encoding flag (1 = RLE encoded, 0 = single occurrence)
  • 2 bits - repeat or chunk class ID
  • m bits - repeat count or chunk size (if greater than max group size then split into chunks...)
  • n bits - value(s)

Status

STABLE - used in production

Search or submit any issues for this package

Related packages

  • @thi.ng/binary - 100+ assorted binary / bitwise operations, conversions, utilities, lookup tables
  • @thi.ng/bitstream - ES6 iterator based read/write bit streams with support for variable word widths
  • @thi.ng/range-coder - Binary data range encoder / decoder

Installation

yarn add @thi.ng/rle-pack

ES module import:

<script type="module" src="https://cdn.skypack.dev/@thi.ng/rle-pack"></script>

Skypack documentation

For Node.js REPL:

# with flag only for < v16
node --experimental-repl-await

> const rlePack = await import("@thi.ng/rle-pack");

Package sizes (gzipped, pre-treeshake): ESM: 696 bytes

Dependencies

API

Generated API docs

import { encode, decode } from "@thi.ng/rle-pack";

// prepare dummy data
src = new Uint8Array(1024);
src.set([1,1,1,1,1,2,2,2,2,3,3,3,4,4,5,4,4,3,3,3,2,2,2,2,1,1,1,1,1], 512);

// pack data
packed = encode(src, src.length);
packed.length
// 30 => 2.93% of original

// pack with custom word size (3 bits, i.e. our value range is only 0-7)
// and use custom repeat group sizes suitable for our data
alt = encode(src, src.length, 3, [1, 2, 3, 9]);
alt.length
// 20 => 1.95% of original, 66% of default config

// unpack
unpacked = new Uint8Array(decode(alt));

Authors

Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-rle-pack,
  title = "@thi.ng/rle-pack",
  author = "Karsten Schmidt",
  note = "https://thi.ng/rle-pack",
  year = 2017
}

License

© 2017 - 2021 Karsten Schmidt // Apache Software License 2.0

3.1.92

4 months ago

3.1.91

5 months ago

3.1.90

5 months ago

3.1.89

5 months ago

3.1.88

6 months ago

3.1.87

6 months ago

3.1.86

6 months ago

3.1.85

7 months ago

3.1.84

7 months ago

3.1.83

8 months ago

3.1.82

8 months ago

3.1.69

1 year ago

3.1.78

11 months ago

3.1.77

11 months ago

3.1.79

11 months ago

3.1.70

1 year ago

3.1.72

12 months ago

3.1.71

1 year ago

3.1.74

12 months ago

3.1.73

12 months ago

3.1.76

11 months ago

3.1.75

11 months ago

3.1.81

9 months ago

3.1.80

10 months ago

3.1.68

1 year ago

3.1.67

1 year ago

3.1.66

1 year ago

3.1.65

1 year ago

3.1.64

1 year ago

3.1.63

1 year ago

3.1.62

1 year ago

3.1.61

1 year ago

3.1.60

1 year ago

3.1.59

1 year ago

3.1.58

1 year ago

3.1.57

1 year ago

3.1.56

1 year ago

3.1.55

1 year ago

3.1.54

1 year ago

3.1.52

1 year ago

3.1.51

1 year ago

3.1.53

1 year ago

3.1.49

1 year ago

3.1.47

2 years ago

3.1.48

2 years ago

3.1.45

2 years ago

3.1.46

2 years ago

3.1.44

2 years ago

3.1.43

2 years ago

3.1.34

2 years ago

3.1.33

2 years ago

3.1.36

2 years ago

3.1.35

2 years ago

3.1.38

2 years ago

3.1.37

2 years ago

3.1.31

2 years ago

3.1.41

2 years ago

3.1.40

2 years ago

3.1.42

2 years ago

3.1.30

2 years ago

3.1.29

2 years ago

3.1.25

2 years ago

3.1.27

2 years ago

3.1.26

2 years ago

3.1.28

2 years ago

3.1.24

2 years ago

3.1.23

2 years ago

3.1.21

2 years ago

3.1.18

3 years ago

3.1.20

3 years ago

3.1.19

3 years ago

3.1.14

3 years ago

3.1.13

3 years ago

3.1.16

3 years ago

3.1.15

3 years ago

3.1.17

3 years ago

3.1.12

3 years ago

3.1.11

3 years ago

3.1.10

3 years ago

3.1.9

3 years ago

3.1.8

3 years ago

3.1.7

3 years ago

3.1.6

3 years ago

3.1.5

3 years ago

3.1.4

3 years ago

3.0.7

4 years ago

3.1.3

4 years ago

3.1.2

4 years ago

3.1.1

4 years ago

3.1.0

4 years ago

3.0.4

4 years ago

3.0.6

4 years ago

3.0.3

4 years ago

3.0.2

4 years ago

3.0.1

4 years ago

3.0.0

4 years ago

2.1.43

4 years ago

2.1.41

4 years ago

2.1.42

4 years ago

2.1.40

4 years ago

2.1.39

4 years ago

2.1.38

4 years ago

2.1.37

4 years ago

2.1.36

4 years ago

2.1.34

4 years ago

2.1.32

4 years ago

2.1.31

5 years ago

2.1.30

5 years ago

2.1.29

5 years ago

2.1.28

5 years ago

2.1.27

5 years ago

2.1.26

5 years ago

2.1.25

5 years ago

2.1.24

5 years ago

2.1.23

5 years ago

2.1.22

5 years ago

2.1.21

5 years ago

2.1.20

5 years ago

2.1.19

5 years ago

2.1.18

5 years ago

2.1.17

5 years ago

2.1.16

5 years ago

2.1.15

5 years ago

2.1.14

5 years ago

2.1.13

5 years ago

2.1.12

5 years ago

2.1.11

5 years ago

2.1.10

5 years ago

2.1.9

5 years ago

2.1.8

5 years ago

2.1.7

5 years ago

2.1.6

5 years ago

2.1.5

6 years ago

2.1.4

6 years ago

2.1.3

6 years ago

2.1.2

6 years ago

2.1.1

6 years ago

2.1.0

6 years ago

2.0.6

6 years ago

2.0.5

6 years ago

2.0.4

6 years ago

2.0.3

6 years ago

2.0.2

6 years ago

2.0.1

6 years ago

2.0.0

6 years ago

1.0.8

7 years ago

1.0.7

7 years ago

1.0.6

7 years ago

1.0.5

7 years ago

1.0.4

7 years ago

1.0.3

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago

0.2.24

7 years ago

0.2.23

7 years ago

0.2.22

7 years ago

0.2.20

7 years ago

0.2.19

7 years ago

0.2.18

7 years ago

0.2.17

7 years ago

0.2.16

7 years ago

0.2.15

7 years ago

0.2.14

7 years ago

0.2.13

7 years ago

0.2.12

7 years ago

0.2.11

7 years ago

0.2.10

7 years ago

0.2.8

7 years ago

0.2.7

7 years ago

0.2.6

7 years ago

0.2.5

7 years ago

0.2.4

7 years ago

0.2.3

7 years ago

0.2.2

7 years ago