1/**************************************************************************/
2/* stream_peer_gzip.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 STREAM_PEER_GZIP_H
32#define STREAM_PEER_GZIP_H
33
34#include "core/io/stream_peer.h"
35
36#include "core/core_bind.h"
37#include "core/io/compression.h"
38#include "core/templates/ring_buffer.h"
39
40class StreamPeerGZIP : public StreamPeer {
41 GDCLASS(StreamPeerGZIP, StreamPeer);
42
43private:
44 void *ctx = nullptr; // Will hold our z_stream instance.
45 bool compressing = true;
46
47 RingBuffer<uint8_t> rb;
48 Vector<uint8_t> buffer;
49
50 Error _process(uint8_t *p_dst, int p_dst_size, const uint8_t *p_src, int p_src_size, int &r_consumed, int &r_out, bool p_close = false);
51 void _close();
52 Error _start(bool p_compress, bool p_is_deflate, int buffer_size = 65535);
53
54protected:
55 static void _bind_methods();
56
57public:
58 Error start_compression(bool p_is_deflate, int buffer_size = 65535);
59 Error start_decompression(bool p_is_deflate, int buffer_size = 65535);
60
61 Error finish();
62 void clear();
63
64 virtual Error put_data(const uint8_t *p_data, int p_bytes) override;
65 virtual Error put_partial_data(const uint8_t *p_data, int p_bytes, int &r_sent) override;
66
67 virtual Error get_data(uint8_t *p_buffer, int p_bytes) override;
68 virtual Error get_partial_data(uint8_t *p_buffer, int p_bytes, int &r_received) override;
69
70 virtual int get_available_bytes() const override;
71
72 StreamPeerGZIP();
73 ~StreamPeerGZIP();
74};
75
76#endif // STREAM_PEER_GZIP_H
77