1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  */
22 
23 #ifndef COMMON_DCL_H
24 #define COMMON_DCL_H
25 
26 #include "common/scummsys.h"
27 
28 namespace Common {
29 
30 /**
31  * @defgroup common_dcl Data compression library
32  * @ingroup common
33  *
34  * @brief  PKWARE data compression library (DCL).
35  *
36  * @details PKWARE DCL ("explode") ("PKWARE data compression library") decompressor used in engines:
37  *          - AGOS (exclusively for Simon 2 setup.shr file)
38  *          - Mohawk
39  *          - Neverhood
40  *          - SCI
41  * @{
42  */
43 
44 class ReadStream;
45 class SeekableReadStream;
46 
47 /**
48  * Decompress a PKWARE DCL compressed stream.
49  *
50  * @return Returns true if successful.
51  */
52 bool decompressDCL(ReadStream *sourceStream, byte *dest, uint32 packedSize, uint32 unpackedSize);
53 
54 /**
55  * @overload
56  *
57  * Decompress a PKWARE DCL compressed stream.
58  *
59  * @return Returns a valid pointer if successful or 0 otherwise.
60  */
61 SeekableReadStream *decompressDCL(SeekableReadStream *sourceStream, uint32 packedSize, uint32 unpackedSize);
62 
63 /**
64  * @overload
65  *
66  * Decompress a PKWARE DCL compressed stream.
67  *
68  * This method is meant for cases, where the unpacked size is not known.
69  *
70  * @return Returns a valid pointer if successful or 0 otherwise.
71  */
72 SeekableReadStream *decompressDCL(SeekableReadStream *sourceStream);
73 
74 /** @} */
75 
76 } // End of namespace Common
77 
78 #endif
79