001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.compress.compressors.zstandard;
019
020
021import java.io.IOException;
022import java.io.InputStream;
023
024import com.github.luben.zstd.ZstdInputStream;
025import org.apache.commons.compress.compressors.CompressorInputStream;
026import org.apache.commons.compress.utils.CountingInputStream;
027import org.apache.commons.compress.utils.IOUtils;
028import org.apache.commons.compress.utils.InputStreamStatistics;
029
030/**
031 * {@link CompressorInputStream} implementation to decode Zstandard encoded stream.
032 * Library relies on <a href="https://github.com/luben/zstd-jni/">Zstandard JNI</a>
033 *
034 * @since 1.16
035 */
036public class ZstdCompressorInputStream extends CompressorInputStream
037    implements InputStreamStatistics {
038
039    private final CountingInputStream countingStream;
040    private final ZstdInputStream decIS;
041
042    public ZstdCompressorInputStream(final InputStream in) throws IOException {
043        this.decIS = new ZstdInputStream(countingStream = new CountingInputStream(in));
044    }
045
046    @Override
047    public int available() throws IOException {
048        return decIS.available();
049    }
050
051    @Override
052    public void close() throws IOException {
053        decIS.close();
054    }
055
056    @Override
057    public int read(final byte[] b) throws IOException {
058        return decIS.read(b);
059    }
060
061    @Override
062    public long skip(final long n) throws IOException {
063        return IOUtils.skip(decIS, n);
064    }
065
066    @Override
067    public void mark(final int readlimit) {
068        decIS.mark(readlimit);
069    }
070
071    @Override
072    public boolean markSupported() {
073        return decIS.markSupported();
074    }
075
076    @Override
077    public int read() throws IOException {
078        final int ret = decIS.read();
079        count(ret == -1 ? 0 : 1);
080        return ret;
081    }
082
083    @Override
084    public int read(final byte[] buf, final int off, final int len) throws IOException {
085        final int ret = decIS.read(buf, off, len);
086        count(ret);
087        return ret;
088    }
089
090    @Override
091    public String toString() {
092        return decIS.toString();
093    }
094
095    @Override
096    public void reset() throws IOException {
097        decIS.reset();
098    }
099
100    /**
101     * @since 1.17
102     */
103    @Override
104    public long getCompressedCount() {
105        return countingStream.getBytesRead();
106    }
107}