aboutsummaryrefslogtreecommitdiff
path: root/common/dcl.h
diff options
context:
space:
mode:
authorMartin Kiewitz2015-07-04 01:44:51 +0200
committerMartin Kiewitz2015-07-04 01:45:34 +0200
commit2bd07431257927968a7ca89f72982d0090812e2c (patch)
tree287f70d271093655ad51630f96a8610935bc0af6 /common/dcl.h
parent1347e8a42431b3020bf488f4be0953b66acb1f38 (diff)
downloadscummvm-rg350-2bd07431257927968a7ca89f72982d0090812e2c.tar.gz
scummvm-rg350-2bd07431257927968a7ca89f72982d0090812e2c.tar.bz2
scummvm-rg350-2bd07431257927968a7ca89f72982d0090812e2c.zip
COMMON: PKWARE data comp. lib. cleanup + enhanced
- uses streams now - additional method for decompressing, when the target size is not known - improved comments - added AGOS for using it
Diffstat (limited to 'common/dcl.h')
-rw-r--r--common/dcl.h17
1 files changed, 12 insertions, 5 deletions
diff --git a/common/dcl.h b/common/dcl.h
index 0e96f74c07..f90bc23c8d 100644
--- a/common/dcl.h
+++ b/common/dcl.h
@@ -22,7 +22,8 @@
/**
* @file
- * PKWARE DCL ("explode") decompressor used in engines:
+ * PKWARE DCL ("explode") ("PKWARE data compression library") decompressor used in engines:
+ * - agos (exclusively for Simon 2 setup.shr file)
* - mohawk
* - sci
*/
@@ -38,16 +39,22 @@ class ReadStream;
class SeekableReadStream;
/**
- * Try to decompress a PKWARE DCL compressed stream. Returns true if
+ * Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream. Returns true if
* successful.
*/
-bool decompressDCL(ReadStream *src, byte *dest, uint32 packedSize, uint32 unpackedSize);
+bool decompressDCL(ReadStream *sourceStream, byte *dest, uint32 packedSize, uint32 unpackedSize);
/**
- * Try to decompress a PKWARE DCL compressed stream. Returns a valid pointer
+ * Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream. Returns a valid pointer
* if successful and 0 otherwise.
*/
-SeekableReadStream *decompressDCL(ReadStream *src, uint32 packedSize, uint32 unpackedSize);
+SeekableReadStream *decompressDCL(SeekableReadStream *sourceStream, uint32 packedSize, uint32 unpackedSize);
+
+/**
+ * Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream. Returns a valid pointer
+ * if successful and 0 otherwise. This method is meant for cases, where the unpacked size is not known.
+ */
+SeekableReadStream *decompressDCL(SeekableReadStream *sourceStream);
} // End of namespace Common