mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-12 12:09:15 +00:00
79 lines
2.2 KiB
C++
79 lines
2.2 KiB
C++
/* ScummVM - Graphic Adventure Engine
|
|
*
|
|
* ScummVM is the legal property of its developers, whose names
|
|
* are too numerous to list here. Please refer to the COPYRIGHT
|
|
* file distributed with this source distribution.
|
|
*
|
|
* This program 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 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program 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 this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef COMMON_DCL_H
|
|
#define COMMON_DCL_H
|
|
|
|
#include "common/scummsys.h"
|
|
|
|
namespace Common {
|
|
|
|
/**
|
|
* @defgroup common_dcl Data compression library
|
|
* @ingroup common
|
|
*
|
|
* @brief PKWARE data compression library (DCL).
|
|
*
|
|
* @details PKWARE DCL ("explode") ("PKWARE data compression library") decompressor used in engines:
|
|
* - AGOS (exclusively for Simon 2 setup.shr file)
|
|
* - Mohawk
|
|
* - Neverhood
|
|
* - SCI
|
|
* @{
|
|
*/
|
|
|
|
class ReadStream;
|
|
class SeekableReadStream;
|
|
|
|
/**
|
|
* Decompress a PKWARE DCL compressed stream.
|
|
*
|
|
* @return Returns true if successful.
|
|
*/
|
|
bool decompressDCL(ReadStream *sourceStream, byte *dest, uint32 packedSize, uint32 unpackedSize);
|
|
|
|
/**
|
|
* @overload
|
|
*
|
|
* Decompress a PKWARE DCL compressed stream.
|
|
*
|
|
* @return Returns a valid pointer if successful or 0 otherwise.
|
|
*/
|
|
SeekableReadStream *decompressDCL(SeekableReadStream *sourceStream, uint32 packedSize, uint32 unpackedSize);
|
|
|
|
/**
|
|
* @overload
|
|
*
|
|
* Decompress a PKWARE DCL compressed stream.
|
|
*
|
|
* This method is meant for cases, where the unpacked size is not known.
|
|
*
|
|
* @return Returns a valid pointer if successful or 0 otherwise.
|
|
*/
|
|
SeekableReadStream *decompressDCL(SeekableReadStream *sourceStream);
|
|
|
|
/** @} */
|
|
|
|
} // End of namespace Common
|
|
|
|
#endif
|