Initial commit

common/compression/dcl.h

@@ -0,0 +1,78 @@
+/* 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 3 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, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#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
+ *          - MADS (exclusively for the Rex Nebular installer) 
+ * @{
+ */
+
+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