1/**************************************************************************/
2/* file_access_compressed.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef FILE_ACCESS_COMPRESSED_H
32#define FILE_ACCESS_COMPRESSED_H
33
34#include "core/io/compression.h"
35#include "core/io/file_access.h"
36
37class FileAccessCompressed : public FileAccess {
38 Compression::Mode cmode = Compression::MODE_ZSTD;
39 bool writing = false;
40 uint64_t write_pos = 0;
41 uint8_t *write_ptr = nullptr;
42 uint32_t write_buffer_size = 0;
43 uint64_t write_max = 0;
44 uint32_t block_size = 0;
45 mutable bool read_eof = false;
46 mutable bool at_end = false;
47
48 struct ReadBlock {
49 uint32_t csize;
50 uint64_t offset;
51 };
52
53 mutable Vector<uint8_t> comp_buffer;
54 uint8_t *read_ptr = nullptr;
55 mutable uint32_t read_block = 0;
56 uint32_t read_block_count = 0;
57 mutable uint32_t read_block_size = 0;
58 mutable uint64_t read_pos = 0;
59 Vector<ReadBlock> read_blocks;
60 uint64_t read_total = 0;
61
62 String magic = "GCMP";
63 mutable Vector<uint8_t> buffer;
64 Ref<FileAccess> f;
65
66 void _close();
67
68public:
69 void configure(const String &p_magic, Compression::Mode p_mode = Compression::MODE_ZSTD, uint32_t p_block_size = 4096);
70
71 Error open_after_magic(Ref<FileAccess> p_base);
72
73 virtual Error open_internal(const String &p_path, int p_mode_flags) override; ///< open a file
74 virtual bool is_open() const override; ///< true when file is open
75
76 virtual String get_path() const override; /// returns the path for the current open file
77 virtual String get_path_absolute() const override; /// returns the absolute path for the current open file
78
79 virtual void seek(uint64_t p_position) override; ///< seek to a given position
80 virtual void seek_end(int64_t p_position = 0) override; ///< seek from the end of file
81 virtual uint64_t get_position() const override; ///< get position in the file
82 virtual uint64_t get_length() const override; ///< get size of the file
83
84 virtual bool eof_reached() const override; ///< reading passed EOF
85
86 virtual uint8_t get_8() const override; ///< get a byte
87 virtual uint64_t get_buffer(uint8_t *p_dst, uint64_t p_length) const override;
88
89 virtual Error get_error() const override; ///< get last error
90
91 virtual void flush() override;
92 virtual void store_8(uint8_t p_dest) override; ///< store a byte
93
94 virtual bool file_exists(const String &p_name) override; ///< return true if a file exists
95
96 virtual uint64_t _get_modified_time(const String &p_file) override;
97 virtual BitField<FileAccess::UnixPermissionFlags> _get_unix_permissions(const String &p_file) override;
98 virtual Error _set_unix_permissions(const String &p_file, BitField<FileAccess::UnixPermissionFlags> p_permissions) override;
99
100 virtual bool _get_hidden_attribute(const String &p_file) override;
101 virtual Error _set_hidden_attribute(const String &p_file, bool p_hidden) override;
102 virtual bool _get_read_only_attribute(const String &p_file) override;
103 virtual Error _set_read_only_attribute(const String &p_file, bool p_ro) override;
104
105 virtual void close() override;
106
107 FileAccessCompressed() {}
108 virtual ~FileAccessCompressed();
109};
110
111#endif // FILE_ACCESS_COMPRESSED_H
112