com.github.czietsman.lz4.LZ4BlockInputStream Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lz4-java Show documentation
Minimal LZ4 java only library
The newest version!
package com.github.czietsman.lz4;

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import com.github.czietsman.xxhash.StreamingXXHash32;
import com.github.czietsman.xxhash.XXHashFactory;
import com.github.czietsman.util.Utils;
import com.github.czietsman.xxhash.XXHash32;

import java.io.EOFException;
import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.zip.Checksum;

/**
 * {@link InputStream} implementation to decode data written with
 * {@link LZ4BlockOutputStream}. This class is not thread-safe and does not
 * support {@link #mark(int)}/{@link #reset()}.
 *
 * @see LZ4BlockOutputStream
 */
public final class LZ4BlockInputStream extends FilterInputStream {

    private final LZ4FastDecompressor decompressor;
    private final Checksum checksum;
    private byte[] buffer;
    private byte[] compressedBuffer;
    private int originalLen;
    private int o;
    private boolean finished;

    /**
     * Create a new {@link InputStream}.
     *
     * @param in           the {@link InputStream} to poll
     * @param decompressor the {@link LZ4FastDecompressor decompressor} instance to
     *                     use
     * @param checksum     the {@link Checksum} instance to use, must be
     *                     equivalent to the instance which has been used to
     *                     write the stream
     */
    public LZ4BlockInputStream(InputStream in, LZ4FastDecompressor decompressor, Checksum checksum) {
        super(in);
        this.decompressor = decompressor;
        this.checksum = checksum;
        this.buffer = new byte[0];
        this.compressedBuffer = new byte[LZ4BlockOutputStream.HEADER_LENGTH];
        o = originalLen = 0;
        finished = false;
    }

    /**
     * Create a new instance using {@link XXHash32} for checksuming.
     *
     * @see #LZ4BlockInputStream(InputStream, LZ4FastDecompressor, Checksum)
     * @see StreamingXXHash32#asChecksum()
     */
    public LZ4BlockInputStream(InputStream in, LZ4FastDecompressor decompressor) {
        this(in, decompressor, XXHashFactory.INSTANCE.newStreamingHash32(LZ4BlockOutputStream.DEFAULT_SEED).asChecksum());
    }

    @Override
    public int available() throws IOException {
        return originalLen - o;
    }

    @Override
    public int read() throws IOException {
        if (finished) {
            return -1;
        }
        if (o == originalLen) {
            refill();
        }
        if (finished) {
            return -1;
        }
        return buffer[o++] & 0xFF;
    }

    @Override
    public int read(byte[] b, int off, int len) throws IOException {
        Utils.checkRange(b, off, len);
        if (finished) {
            return -1;
        }
        if (o == originalLen) {
            refill();
        }
        if (finished) {
            return -1;
        }
        len = Math.min(len, originalLen - o);
        System.arraycopy(buffer, o, b, off, len);
        o += len;
        return len;
    }

    @Override
    public int read(byte[] b) throws IOException {
        return read(b, 0, b.length);
    }

    @Override
    public long skip(long n) throws IOException {
        if (finished) {
            return -1;
        }
        if (o == originalLen) {
            refill();
        }
        if (finished) {
            return -1;
        }
        final int skipped = (int) Math.min(n, originalLen - o);
        o += skipped;
        return skipped;
    }

    private void refill() throws IOException {
        readFully(compressedBuffer, LZ4BlockOutputStream.HEADER_LENGTH);
        for (int i = 0; i < LZ4BlockOutputStream.MAGIC_LENGTH; ++i) {
            if (compressedBuffer[i] != LZ4BlockOutputStream.MAGIC[i]) {
                throw new IOException("Stream is corrupted");
            }
        }
        final int token = compressedBuffer[LZ4BlockOutputStream.MAGIC_LENGTH] & 0xFF;
        final int compressionMethod = token & 0xF0;
        final int compressionLevel = LZ4BlockOutputStream.COMPRESSION_LEVEL_BASE + (token & 0x0F);
        if (compressionMethod != LZ4BlockOutputStream.COMPRESSION_METHOD_RAW && compressionMethod != LZ4BlockOutputStream.COMPRESSION_METHOD_LZ4) {
            throw new IOException("Stream is corrupted");
        }
        final int compressedLen = Utils.readIntLE(compressedBuffer, LZ4BlockOutputStream.MAGIC_LENGTH + 1);
        originalLen = Utils.readIntLE(compressedBuffer, LZ4BlockOutputStream.MAGIC_LENGTH + 5);
        final int check = Utils.readIntLE(compressedBuffer, LZ4BlockOutputStream.MAGIC_LENGTH + 9);
        assert LZ4BlockOutputStream.HEADER_LENGTH == LZ4BlockOutputStream.MAGIC_LENGTH + 13;
        if (originalLen > 1 << compressionLevel
                || originalLen < 0
                || compressedLen < 0
                || (originalLen == 0 && compressedLen != 0)
                || (originalLen != 0 && compressedLen == 0)
                || (compressionMethod == LZ4BlockOutputStream.COMPRESSION_METHOD_RAW && originalLen != compressedLen)) {
            throw new IOException("Stream is corrupted");
        }
        if (originalLen == 0 && compressedLen == 0) {
            if (check != 0) {
                throw new IOException("Stream is corrupted");
            }
            finished = true;
            return;
        }
        if (buffer.length < originalLen) {
            buffer = new byte[Math.max(originalLen, buffer.length * 3 / 2)];
        }
        switch (compressionMethod) {
            case LZ4BlockOutputStream.COMPRESSION_METHOD_RAW:
                readFully(buffer, originalLen);
                break;
            case LZ4BlockOutputStream.COMPRESSION_METHOD_LZ4:
                if (compressedBuffer.length < originalLen) {
                    compressedBuffer = new byte[Math.max(compressedLen, compressedBuffer.length * 3 / 2)];
                }
                readFully(compressedBuffer, compressedLen);
                try {
                    final int compressedLen2 = decompressor.decompress(compressedBuffer, 0, buffer, 0, originalLen);
                    if (compressedLen != compressedLen2) {
                        throw new IOException("Stream is corrupted");
                    }
                } catch (LZ4Exception e) {
                    throw new IOException("Stream is corrupted", e);
                }
                break;
            default:
                throw new AssertionError();
        }
        checksum.reset();
        checksum.update(buffer, 0, originalLen);
        if ((int) checksum.getValue() != check) {
            throw new IOException("Stream is corrupted");
        }
        o = 0;
    }

    private void readFully(byte[] b, int len) throws IOException {
        int read = 0;
        while (read < len) {
            final int r = in.read(b, read, len - read);
            if (r < 0) {
                throw new EOFException("Stream ended prematurely");
            }
            read += r;
        }
        assert len == read;
    }

    @Override
    public boolean markSupported() {
        return false;
    }

    @SuppressWarnings("sync-override")
    @Override
    public void mark(int readlimit) {
        // unsupported
    }

    @SuppressWarnings("sync-override")
    @Override
    public void reset() throws IOException {
        throw new IOException("mark/reset not supported");
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() + "(in=" + in
                + ", decompressor=" + decompressor + ", checksum=" + checksum + ")";
    }

}