minetest/src/serialization.h

102 lines
3.8 KiB
C
Raw Normal View History

/*
2013-02-24 18:40:43 +01:00
Minetest
2013-02-24 19:38:45 +01:00
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#pragma once
2010-11-27 00:02:21 +01:00
2012-06-17 03:00:31 +02:00
#include "irrlichttypes.h"
2010-11-27 00:02:21 +01:00
#include "exceptions.h"
#include <iostream>
#include "util/pointer.h"
2010-11-27 00:02:21 +01:00
/*
Map format serialization version
--------------------------------
For map data (blocks, nodes, sectors).
2010-11-27 00:02:21 +01:00
NOTE: The goal is to increment this so that saved maps will be
loadable by any version. Other compatibility is not
maintained.
2010-11-27 00:02:21 +01:00
0: original networked test with 1-byte nodes
1: update with 2-byte nodes
2: lighting is transmitted in param
3: optional fetching of far blocks
4: block compression
5: sector objects NOTE: block compression was left accidentally out
6: failed attempt at switching block compression on again
7: block compression switched on again
8: server-initiated block transfers and all kinds of stuff
9: block objects
10: water pressure
11: zlib'd blocks, block flags
12: UnlimitedHeightmap now uses interpolated areas
13: Mapgen v2
14: NodeMetadata
15: StaticObjects
16: larger maximum size of node metadata, and compression
17: MapBlocks contain timestamp
18: new generator (not really necessary, but it's there)
19: new content type handling
2011-07-23 15:55:26 +02:00
20: many existing content types translated to extended ones
2011-11-16 12:03:28 +01:00
21: dynamic content type allocation
2012-03-19 01:08:04 +01:00
22: minerals removed, facedir & wallmounted changed
2012-07-17 15:00:04 +02:00
23: new node metadata format
24: 16-bit node ids and node timers (never released as stable)
25: Improved node timer format
2013-08-01 22:51:36 +02:00
26: Never written; read the same as 25
27: Added light spreading flags to blocks
28: Added "private" flag to NodeMetadata
29: Switched compression to zstd, a bit of reorganization
2010-11-27 00:02:21 +01:00
*/
// This represents an uninitialized or invalid format
#define SER_FMT_VER_INVALID 255
// Highest supported serialization version
#define SER_FMT_VER_HIGHEST_READ 29
2013-08-01 22:51:36 +02:00
// Saved on disk version
#define SER_FMT_VER_HIGHEST_WRITE 29
2010-11-27 00:02:21 +01:00
// Lowest supported serialization version
#define SER_FMT_VER_LOWEST_READ 0
// Lowest serialization version for writing
// Can't do < 24 anymore; we have 16-bit dynamically allocated node IDs
// in memory; conversion just won't work in this direction.
#define SER_FMT_VER_LOWEST_WRITE 24
2010-11-27 00:02:21 +01:00
inline bool ser_ver_supported(s32 v) {
return v >= SER_FMT_VER_LOWEST_READ && v <= SER_FMT_VER_HIGHEST_READ;
}
2010-11-27 00:02:21 +01:00
/*
Misc. serialization functions
*/
void compressZlib(const u8 *data, size_t data_size, std::ostream &os, int level = -1);
2014-09-14 23:42:08 +02:00
void compressZlib(const std::string &data, std::ostream &os, int level = -1);
void decompressZlib(std::istream &is, std::ostream &os, size_t limit = 0);
void compressZstd(const u8 *data, size_t data_size, std::ostream &os, int level = 0);
void compressZstd(const std::string &data, std::ostream &os, int level = 0);
void decompressZstd(std::istream &is, std::ostream &os);
// These choose between zlib and a self-made one according to version
void compress(const SharedBuffer<u8> &data, std::ostream &os, u8 version, int level = -1);
void compress(const std::string &data, std::ostream &os, u8 version, int level = -1);
void compress(u8 *data, u32 size, std::ostream &os, u8 version, int level = -1);
2010-11-27 00:02:21 +01:00
void decompress(std::istream &is, std::ostream &os, u8 version);