heatshrink-compression-ts 0.1.0 → 0.1.1

package/dist/lib/heatshrink-ts.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var heatshrink_encoder_1 = require("./heatshrink-encoder");
+exports.HeatshrinkEncoder = heatshrink_encoder_1.HeatshrinkEncoder;
+var heatshrink_decoder_1 = require("./heatshrink-decoder");
+exports.HeatshrinkDecoder = heatshrink_decoder_1.HeatshrinkDecoder;
+var heatshrink_basic_1 = require("./heatshrink-basic");
+exports.HSConfigError = heatshrink_basic_1.HSConfigError;
+exports.HSInternalError = heatshrink_basic_1.HSInternalError;
+exports.HSError = heatshrink_basic_1.HSError;
+//# sourceMappingURL=heatshrink-ts.js.map

package/dist/lib/heatshrink-ts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"heatshrink-ts.js","sourceRoot":"","sources":["../../src/heatshrink-ts.ts"],"names":[],"mappings":";;AAAA,2DAAyD;AAAhD,iDAAA,iBAAiB,CAAA;AAC1B,2DAAyD;AAAhD,iDAAA,iBAAiB,CAAA;AAC1B,uDAA6E;AAApE,2CAAA,aAAa,CAAA;AAAE,6CAAA,eAAe,CAAA;AAAE,qCAAA,OAAO,CAAA"}

package/dist/lib/heatshrink-utils.js

@@ -0,0 +1,75 @@
+"use strict";
+/**
+ * @module heatshrink-utils
+ * @external
+ * @preferred
+ *
+ * This internal module contains private utility functions that are used inside
+ * the heatshrink-ts package.  They are not meant to be used externally nor are
+ * they externally visible.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+var heatshrink_basic_1 = require("./heatshrink-basic");
+/**
+ * Get a specific number of bits from the input buffer.  You can get between
+ * 1 and 15 bits at a time and those bits are popped from the input buffer and
+ * returned.  If there are not enough bits remaining in buffer according to the
+ * state information in state, then HS_NOBITS is returned as a sentinal value
+ * and no bits are consumed from teh buffer.
+ *
+ * @param count The number of bits to return, must be in the range [1, 15]
+ * @param state The current state of the input bitstream.  This parameter is
+ *    modified with every invocation of this function to maintain state between
+ *    calls.
+ * @param buffer A buffer of input data that will be used to retrieve a fixed
+ *    number of bits.  This parameter is never modified.  The state of what
+ *    bits have and have not been extracted is stored in the state parameter.
+ * @returns The bits that were popped from the input buffer.  If there are not
+ *    enough bits left in the buffer then HS_NOBITS is returned and state is left
+ *    unchanged.
+ */
+function getBits(count, buffer, state) {
+    if (count > 15) {
+        throw new heatshrink_basic_1.HSInternalError("getBits called with invalid number of bits requested (" + count + " not in [1, 15])");
+    }
+    /*
+     * Make sure that we have enough available bits to satisfy this call.  There are two cases where
+     * we could fail to have enough bits:
+     * 1. We are on the last byte and there are fewer bits left than count
+     * 2. We are on the penultimate byte and there are fewers bits left in the byte than count - 8
+     *    so that when we move to the next byte
+     */
+    if (state.size === 0 && state.bitIndex < 1 << (count - 1)) {
+        return heatshrink_basic_1.HS_NOBITS;
+    }
+    else if (state.size - state.index === 1 && count > 8) {
+        var requiredBitmask = 1 << (count - 8 - 1);
+        if (state.bitIndex < requiredBitmask) {
+            return heatshrink_basic_1.HS_NOBITS;
+        }
+    }
+    var accum = 0;
+    for (var i = 0; i < count; ++i) {
+        if (state.bitIndex === 0 && state.size === 0) {
+            return heatshrink_basic_1.HS_NOBITS;
+        }
+        if (state.bitIndex === 0) {
+            state.currentByte = buffer[state.index];
+            state.index += 1;
+            // Keep track of when the inputBuffer is used up and mark it as empty again
+            if (state.index === state.size) {
+                state.index = 0;
+                state.size = 0;
+            }
+            state.bitIndex = 1 << 7;
+        }
+        accum <<= 1;
+        if (state.currentByte & state.bitIndex) {
+            accum |= 1;
+        }
+        state.bitIndex >>= 1;
+    }
+    return accum;
+}
+exports.getBits = getBits;
+//# sourceMappingURL=heatshrink-utils.js.map

package/dist/lib/heatshrink-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"heatshrink-utils.js","sourceRoot":"","sources":["../../src/heatshrink-utils.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;AAEH,uDAAkF;AAElF;;;;;;;;;;;;;;;;;GAiBG;AACH,iBAAwB,KAAa,EAAE,MAAkB,EAAE,KAAuB;IAC9E,EAAE,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC;QACb,MAAM,IAAI,kCAAe,CACrB,2DAAyD,KAAK,qBAAkB,CACnF,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACxD,MAAM,CAAC,4BAAS,CAAC;IACrB,CAAC;IAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,KAAK,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QACrD,IAAI,eAAe,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3C,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC;YACnC,MAAM,CAAC,4BAAS,CAAC;QACrB,CAAC;IACL,CAAC;IAED,IAAI,KAAK,GAAW,CAAC,CAAC;IAEtB,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC;QAC7B,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;YAC3C,MAAM,CAAC,4BAAS,CAAC;QACrB,CAAC;QAED,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC;YACvB,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACxC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;YAEjB,2EAA2E;YAC3E,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC7B,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;gBAChB,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;YACnB,CAAC;YAED,KAAK,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAED,KAAK,KAAK,CAAC,CAAC;QACZ,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;YACrC,KAAK,IAAI,CAAC,CAAC;QACf,CAAC;QAED,KAAK,CAAC,QAAQ,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC;AACjB,CAAC;AApDD,0BAoDC"}

package/dist/types/heatshrink-basic.d.ts

@@ -0,0 +1,42 @@
+export declare enum HSState {
+    TAG_BIT = 0,
+    YIELD_LITERAL = 1,
+    BACKREF_INDEX_MSB = 2,
+    BACKREF_INDEX_LSB = 3,
+    BACKREF_COUNT_MSB = 4,
+    BACKREF_COUNT_LSB = 5,
+    YIELD_BACKREF = 6,
+}
+export interface HSBitstreamState {
+    size: number;
+    index: number;
+    currentByte: number;
+    bitIndex: number;
+}
+/**
+ * All errors thrown by the heatshrink-ts package will inherit from
+ * this class.  Different subclasses are thrown for different kinds of
+ * errors.  All errors have a string message that indicates what exactly
+ * went wrong.
+ *
+ * @category Errors
+ */
+export declare class HSError extends Error {
+}
+/**
+ * The heatshrink engine has been misconfigured.
+ *
+ * @category Errors
+ */
+export declare class HSConfigError extends HSError {
+}
+export declare class HSInternalError extends HSError {
+}
+export declare class HSCorruptDataError extends HSError {
+}
+export declare const HS_MIN_WINDOW_BITS: number;
+export declare const HS_MAX_WINDOW_BITS: number;
+export declare const HS_MIN_LOOKAHEAD_BITS: number;
+export declare const HS_LITERAL_MARKER: number;
+export declare const HS_BACKREF_MARKER: number;
+export declare const HS_NOBITS: number;

package/dist/types/heatshrink-decoder.d.ts

@@ -0,0 +1,66 @@
+/**
+ * A typescript implementation of the heatshrink compression library.
+ *
+ * Heatshrink is an open-source LZSS based compression library suitable
+ * for use in embedded systems since it has a very small and bounded
+ * memory footprint.  This is an adaptation of the heatshink code to
+ * typescript with a slightly more user-fiendly API.
+ */
+export declare class HeatshrinkDecoder {
+    inputBuffer: Uint8Array;
+    outputBuffer: Uint8Array;
+    outputSize: number;
+    private windowBuffer;
+    private headIndex;
+    private outputIndex;
+    private outputCount;
+    private state;
+    private inputState;
+    private windowBits;
+    private lookaheadBits;
+    constructor(windowBits: number, lookaheadBits: number, inputBufferSize: number);
+    reset(): void;
+    /**
+     * Feed data into the heatshrink decoder state machine.
+     *
+     * This function will take the chunk of input data and turn it into as
+     * much expanded output as it can.  Decoding a stream of data should be
+     * done by calling this function repeatedly with chunks of data from the
+     * stream.
+     *
+     * You can call isFinished() to check and see if all of the data that you
+     * have fed in from previous calls to process() has been successfully
+     * decoded.
+     *
+     * @param rawInput A chunk of data that has encoded using the heatshrink
+     *      library.  You can push data a little bit at a time and stop at
+     *      any byte boundary.
+     */
+    process(rawInput: Uint8Array | ArrayBuffer): void;
+    sink(input: Uint8Array): number;
+    poll(): void;
+    isFinished(): boolean;
+    /**
+     * Get all output data and truncate the output buffer.
+     *
+     * Calling this function repeatedly will have the effect of
+     * pulling the output in chunks from the HeatshrinkDecoder.
+     * It will return all data currently available and remove it
+     * from the output buffer so another call to getOutput() will
+     * not return duplicate data.
+     *
+     * @returns All data currently in the output buffer.
+     */
+    getOutput(): Uint8Array;
+    private assureUint8Array(buffer);
+    private processTag();
+    private yieldLiteral();
+    private processBackrefIndexMSB();
+    private processBackrefIndexLSB();
+    private processBackrefCountMSB();
+    private processBackrefCountLSB();
+    private yieldBackref();
+    private ensureOutputSpace(neededBytes);
+    private emitByte(byte);
+    private storeByte(byte);
+}

package/dist/types/heatshrink-encoder.d.ts

@@ -0,0 +1,11 @@
+export declare class HeatshrinkEncoder {
+    private windowBits;
+    private lookaheadBits;
+    private windowSize;
+    private lookaheadSize;
+    constructor(windowBits: number, lookaheadBits: number);
+    /**
+     * Compress input and return compressed Uint8Array in heatshrink bitstream format.
+     */
+    compress(rawInput: Uint8Array | ArrayBuffer): Uint8Array;
+}

package/dist/types/heatshrink-ts.d.ts

@@ -0,0 +1,3 @@
+export { HeatshrinkEncoder } from "./heatshrink-encoder";
+export { HeatshrinkDecoder } from "./heatshrink-decoder";
+export { HSConfigError, HSInternalError, HSError } from "./heatshrink-basic";

package/dist/types/heatshrink-utils.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @module heatshrink-utils
+ * @external
+ * @preferred
+ *
+ * This internal module contains private utility functions that are used inside
+ * the heatshrink-ts package.  They are not meant to be used externally nor are
+ * they externally visible.
+ */
+import { HSBitstreamState } from "./heatshrink-basic";
+/**
+ * Get a specific number of bits from the input buffer.  You can get between
+ * 1 and 15 bits at a time and those bits are popped from the input buffer and
+ * returned.  If there are not enough bits remaining in buffer according to the
+ * state information in state, then HS_NOBITS is returned as a sentinal value
+ * and no bits are consumed from teh buffer.
+ *
+ * @param count The number of bits to return, must be in the range [1, 15]
+ * @param state The current state of the input bitstream.  This parameter is
+ *    modified with every invocation of this function to maintain state between
+ *    calls.
+ * @param buffer A buffer of input data that will be used to retrieve a fixed
+ *    number of bits.  This parameter is never modified.  The state of what
+ *    bits have and have not been extracted is stored in the state parameter.
+ * @returns The bits that were popped from the input buffer.  If there are not
+ *    enough bits left in the buffer then HS_NOBITS is returned and state is left
+ *    unchanged.
+ */
+export declare function getBits(count: number, buffer: Uint8Array, state: HSBitstreamState): number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "heatshrink-compression-ts",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A typescript implementation of the heatshrink compression library",
   "keywords": [],
   "main": "dist/heatshrink-ts.umd.js",