fc559febcbdb837036cd35b0f7d3aeb9d0248c37
[libs/core.git] / source / io / zlibcompressed.h
1 #ifndef MSP_IO_ZLIBCOMPRESSED_H_
2 #define MSP_IO_ZLIBCOMPRESSED_H_
3
4 #include <stdexcept>
5 #include <string>
6 #include <sigc++/trackable.h>
7 #include "base.h"
8
9 namespace Msp {
10 namespace IO {
11
12 class zlib_error: public std::runtime_error
13 {
14 private:
15         int code_;
16
17 public:
18         zlib_error(const std::string &, int);
19         ~zlib_error() throw() { }
20
21         int code() const throw() { return code_; }
22 };
23
24 /**
25 Compresses or decompresses data with zlib.  This class is a filter that
26 operates on top of another I/O object.
27
28 To ensure proper termination of the compressed data stream, the ZlibCompressed
29 object must be destroyed before the underlying object is closed.
30 */
31 class ZlibCompressed: public Base, public sigc::trackable
32 {
33 private:
34         struct Private;
35
36         Base &below;
37         unsigned buffer_size;
38         unsigned char *in_buffer;
39         unsigned char *out_buffer;
40         bool stream_end;
41         Private *priv;
42
43 public:
44         /** Creates a zlib de/compression object.  The underlying object must be
45         open for reading or writing, not both.  The level parameter determines
46         compression quality, ranging from 1 (fastest) to 9 (best compression). */
47         ZlibCompressed(Base &, unsigned level = 9);
48
49         /** Creates a zlib de/compression object.  Mode must be either read or
50         write, and compatible with the underlying object. */
51         ZlibCompressed(Base &, Mode, unsigned level = 9);
52
53 private:
54         void init(unsigned);
55
56 public:
57         virtual ~ZlibCompressed();
58
59         virtual void set_block(bool);
60
61         void flush();
62
63 protected:
64         virtual unsigned do_write(const char *, unsigned);
65
66 private:
67         /** Compresses data and writes it to the underlying object.  Returns true if
68         progress was made, false otherwise.  flush_mode can be any of zlib's flush
69         modes.  If it is Z_FINISH, false is also returned when the stream has been
70         terminated. */
71         bool compress_data(int flush_mode);
72
73 public:
74         virtual unsigned do_read(char *, unsigned);
75
76         virtual const Handle &get_handle(Mode);
77 };
78
79 } // namespace IO
80 } // namespace Msp
81
82 #endif