Debian Codegraph @

engine/core/vfs/dat/lzssdecoder.h

raw
1 /***************************************************************************
2 * Copyright (C) 2005-2019 by the FIFE team *
3 * http://www.fifengine.net *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or *
7 * modify it under the terms of the GNU Lesser General Public *
8 * License as published by the Free Software Foundation; either *
9 * version 2.1 of the License, or (at your option) any later version. *
10 * *
11 * This library is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_LZSSDECODER_H
23 #define FIFE_LZSSDECODER_H
24
25 // Standard C++ library includes
26
27 // 3rd party library includes
28
29 // FIFE includes
30 #include "util/base/fife_stdint.h"
31 #include "vfs/vfs.h"
32
33 namespace FIFE {
34 /** A helper class for unpacking LZSS encoded data
35 * @bug just a quick&dirty LZSS implementation, optimized a bit
36 * see revision 719 for the original one and 795 for the broken optimized one
37 * @bug the lzss decoder might very well crash on corrupt data.
38 */
39 class LZSSDecoder {
40 public:
41 /** Constructor
42 */
43 LZSSDecoder();
44
45 /** Destructor
46 */
47 ~LZSSDecoder();
48
49 /** Decodes from a file into a pointer.
50 * @param input The VFS file to read from
51 * @param output The memory location to write to
52 * @param outputsize The size of the memory location in byte
53 */
54 void decode(RawData* input, uint8_t* output, const uint32_t outputsize);
55
56 private:
57 uint32_t m_outlen;
58 uint32_t m_outindex;
59 void LZSSDecode(uint8_t* in, int64_t len, uint8_t* out);
60
61 };
62
63 }
64
65 #endif