deflate.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef COMMON_DEFLATE_H
#define COMMON_DEFLATE_H

#include "src/common/types.h"

namespace Common {

/* TODO (should be need it):
 * - Compression
 * - Decompress dynamically, without needing to know the size
 *   of the decompressed data beforehand
 */

class ReadStream;
class SeekableReadStream;

static const int kWindowBitsMax    =  15;
static const int kWindowBitsMaxRaw = -kWindowBitsMax;

byte *decompressDeflate(const byte *data, size_t inputSize,
                        size_t outputSize, int windowBits);

byte *decompressDeflateWithoutOutputSize(const byte *data, size_t inputSize, size_t &outputSize,
                                         int windowBits, unsigned int frameSize = 4096);

SeekableReadStream *decompressDeflate(ReadStream &input, size_t inputSize,
                                      size_t outputSize, int windowBits);

SeekableReadStream *decompressDeflateWithoutOutputSize(ReadStream &input, size_t inputSize,
                                                       int windowBits, unsigned int frameSize = 4096);

size_t decompressDeflateChunk(SeekableReadStream &input, int windowBits, byte *output, size_t outputSize,
                              unsigned int frameSize = 4096);

} // End of namespace Common

#endif // COMMON_DEFLATE_H