Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2024-12-23 12:26:59 +01:00
Code Issues Packages Projects Releases Wiki Activity
f927e2db73
pandemonium_engine/modules/network_synchronizer/input_network_encoder.cpp

432 lines
19 KiB
C++
Raw Normal View History

Ran the clang format script.
2023-12-25 20:27:28 +01:00
/*************************************************************************/
/* input_network_encoder.cpp */
/*************************************************************************/
/* This file is part of: */
/* PANDEMONIUM ENGINE */
/* https://github.com/Relintai/pandemonium_engine */
/*************************************************************************/
/* Copyright (c) 2022-present Péter Magyar. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
Updated NetworkSynchronizer from https://github.com/GameNetworking/network_synchronizer/tree/godot-3.x . f12fee66a7e3eb2013d6c5437837770455105b91 (Merge commit: cc3c7d244adea8b25822f43963618fd2dbf18ec8)
2023-12-25 19:27:07 +01:00
#include "input_network_encoder.h"
#include "scene_synchronizer.h"
void InputNetworkEncoder::_bind_methods() {
ClassDB::bind_method(D_METHOD("register_input", "name", "default_value", "type", "compression_level", "comparison_floating_point_precision"), &InputNetworkEncoder::register_input, DEFVAL(CMP_EPSILON));
ClassDB::bind_method(D_METHOD("find_input_id", "name"), &InputNetworkEncoder::find_input_id);
ClassDB::bind_method(D_METHOD("encode", "inputs", "buffer"), &InputNetworkEncoder::script_encode);
ClassDB::bind_method(D_METHOD("decode", "buffer"), &InputNetworkEncoder::script_decode);
ClassDB::bind_method(D_METHOD("get_defaults"), &InputNetworkEncoder::script_get_defaults);
ClassDB::bind_method(D_METHOD("are_different", "buffer_a", "buffer_b"), &InputNetworkEncoder::script_are_different);
ClassDB::bind_method(D_METHOD("count_size", "buffer"), &InputNetworkEncoder::script_count_size);
}
uint32_t InputNetworkEncoder::register_input(
const StringName &p_name,
const Variant &p_default_value,
DataBuffer::DataType p_type,
DataBuffer::CompressionLevel p_compression_level,
real_t p_comparison_floating_point_precision) {
switch (p_type) {
case DataBuffer::DATA_TYPE_BOOL:
ERR_FAIL_COND_V_MSG(p_default_value.get_type() != Variant::BOOL, UINT32_MAX, "The moveset initialization failed for" + p_name + " the specified data type is `BOOL` but the default parameter is " + itos(p_default_value.get_type()));
break;
case DataBuffer::DATA_TYPE_INT:
ERR_FAIL_COND_V_MSG(p_default_value.get_type() != Variant::INT, UINT32_MAX, "The moveset initialization failed for" + p_name + " the specified data type is `INT` but the default parameter is " + itos(p_default_value.get_type()));
break;
case DataBuffer::DATA_TYPE_UINT:
ERR_FAIL_COND_V_MSG(p_default_value.get_type() != Variant::INT, UINT32_MAX, "The moveset initialization failed for" + p_name + " the specified data type is `UINT` but the default parameter is " + itos(p_default_value.get_type()));
break;
case DataBuffer::DATA_TYPE_REAL:
ERR_FAIL_COND_V_MSG(p_default_value.get_type() != Variant::REAL, UINT32_MAX, "The moveset initialization failed for" + p_name + " the specified data type is `REAL` but the default parameter is " + itos(p_default_value.get_type()));
break;
case DataBuffer::DATA_TYPE_POSITIVE_UNIT_REAL:
ERR_FAIL_COND_V_MSG(p_default_value.get_type() != Variant::REAL, UINT32_MAX, "The moveset initialization failed for" + p_name + " the specified data type is `REAL` but the default parameter is " + itos(p_default_value.get_type()));
break;
case DataBuffer::DATA_TYPE_UNIT_REAL:
ERR_FAIL_COND_V_MSG(p_default_value.get_type() != Variant::REAL, UINT32_MAX, "The moveset initialization failed for" + p_name + " the specified data type is `REAL` but the default parameter is " + itos(p_default_value.get_type()));
break;
case DataBuffer::DATA_TYPE_VECTOR2:
ERR_FAIL_COND_V_MSG(p_default_value.get_type() != Variant::VECTOR2, UINT32_MAX, "The moveset initialization failed for" + p_name + " the specified data type is `Vector2` but the default parameter is " + itos(p_default_value.get_type()));
break;
case DataBuffer::DATA_TYPE_NORMALIZED_VECTOR2:
ERR_FAIL_COND_V_MSG(p_default_value.get_type() != Variant::VECTOR2, UINT32_MAX, "The moveset initialization failed for" + p_name + " the specified data type is `Vector2` but the default parameter is " + itos(p_default_value.get_type()));
break;
case DataBuffer::DATA_TYPE_VECTOR3:
ERR_FAIL_COND_V_MSG(p_default_value.get_type() != Variant::VECTOR3, UINT32_MAX, "The moveset initialization failed for" + p_name + " the specified data type is `Vector3` but the default parameter is " + itos(p_default_value.get_type()));
break;
case DataBuffer::DATA_TYPE_NORMALIZED_VECTOR3:
ERR_FAIL_COND_V_MSG(p_default_value.get_type() != Variant::VECTOR3, UINT32_MAX, "The moveset initialization failed for" + p_name + " the specified data type is `Vector3` but the default parameter is " + itos(p_default_value.get_type()));
break;
case DataBuffer::DATA_TYPE_VARIANT:
/* No need to check variant, anything is accepted at this point.*/
break;
};
const uint32_t index = input_info.size();
input_info.resize(input_info.size() + 1);
input_info[index].name = p_name;
input_info[index].default_value = p_default_value;
input_info[index].data_type = p_type;
input_info[index].compression_level = p_compression_level;
input_info[index].comparison_floating_point_precision = p_comparison_floating_point_precision;
return index;
}
uint32_t InputNetworkEncoder::find_input_id(const StringName &p_name) const {
for (uint32_t i = 0; i < input_info.size(); i += 1) {
if (input_info[i].name == p_name) {
return i;
}
}
return INDEX_NONE;
}
const LocalVector<NetworkedInputInfo> &InputNetworkEncoder::get_input_info() const {
return input_info;
}
void InputNetworkEncoder::encode(const LocalVector<Variant> &p_input, DataBuffer &r_buffer) const {
for (uint32_t i = 0; i < input_info.size(); i += 1) {
const NetworkedInputInfo &info = input_info[i];
#ifdef DEBUG_ENABLED
if (i < p_input.size() && info.default_value.get_type() != p_input[i].get_type() && p_input[i].get_type() != Variant::NIL) {
NET_DEBUG_ERR("During the input encoding the passed value `" + p_input[i] + "` has a different type to the expected one. Using the default value `" + info.default_value + "`.");
}
#endif
const bool is_default =
// If the input exist into the array.
i >= p_input.size() ||
// Use default if the variable type is different.
info.default_value.get_type() != p_input[i].get_type() ||
// Use default if the variable value is equal to default.
info.default_value == p_input[i];
if (info.default_value.get_type() != Variant::BOOL) {
r_buffer.add_bool(is_default);
if (!is_default) {
const Variant &pending_input = p_input[i];
switch (info.data_type) {
case DataBuffer::DATA_TYPE_BOOL:
CRASH_NOW_MSG("Boolean are handled differently. Thanks to the above IF this condition never occurs.");
break;
case DataBuffer::DATA_TYPE_UINT:
r_buffer.add_uint(pending_input.operator unsigned int(), info.compression_level);
break;
case DataBuffer::DATA_TYPE_INT:
r_buffer.add_int(pending_input.operator int(), info.compression_level);
break;
case DataBuffer::DATA_TYPE_REAL:
r_buffer.add_real(pending_input.operator real_t(), info.compression_level);
break;
case DataBuffer::DATA_TYPE_POSITIVE_UNIT_REAL:
r_buffer.add_positive_unit_real(pending_input.operator real_t(), info.compression_level);
break;
case DataBuffer::DATA_TYPE_UNIT_REAL:
r_buffer.add_unit_real(pending_input.operator real_t(), info.compression_level);
break;
case DataBuffer::DATA_TYPE_VECTOR2:
r_buffer.add_vector2(pending_input.operator Vector2(), info.compression_level);
break;
case DataBuffer::DATA_TYPE_NORMALIZED_VECTOR2:
r_buffer.add_normalized_vector2(pending_input.operator Vector2(), info.compression_level);
break;
case DataBuffer::DATA_TYPE_VECTOR3:
r_buffer.add_vector3(pending_input.operator Vector3(), info.compression_level);
break;
case DataBuffer::DATA_TYPE_NORMALIZED_VECTOR3:
r_buffer.add_normalized_vector3(pending_input.operator Vector3(), info.compression_level);
break;
case DataBuffer::DATA_TYPE_VARIANT:
r_buffer.add_variant(pending_input);
break;
};
}
} else {
// If the data is bool no need to set the default.
if (!is_default) {
r_buffer.add_bool(p_input[i].operator bool());
} else {
r_buffer.add_bool(info.default_value.operator bool());
}
}
}
}
void InputNetworkEncoder::decode(DataBuffer &p_buffer, LocalVector<Variant> &r_inputs) const {
if (r_inputs.size() < input_info.size()) {
r_inputs.resize(input_info.size());
}
for (uint32_t i = 0; i < input_info.size(); i += 1) {
const NetworkedInputInfo &info = input_info[i];
const bool is_bool = info.default_value.get_type() == Variant::BOOL;
bool is_default = false;
if (is_bool == false) {
is_default = p_buffer.read_bool();
}
if (is_default) {
r_inputs[i] = info.default_value;
} else {
switch (info.data_type) {
case DataBuffer::DATA_TYPE_BOOL:
r_inputs[i] = p_buffer.read_bool();
break;
case DataBuffer::DATA_TYPE_UINT:
r_inputs[i] = p_buffer.read_uint(info.compression_level);
break;
case DataBuffer::DATA_TYPE_INT:
r_inputs[i] = p_buffer.read_int(info.compression_level);
break;
case DataBuffer::DATA_TYPE_REAL:
r_inputs[i] = p_buffer.read_real(info.compression_level);
break;
case DataBuffer::DATA_TYPE_POSITIVE_UNIT_REAL:
r_inputs[i] = p_buffer.read_positive_unit_real(info.compression_level);
break;
case DataBuffer::DATA_TYPE_UNIT_REAL:
r_inputs[i] = p_buffer.read_unit_real(info.compression_level);
break;
case DataBuffer::DATA_TYPE_VECTOR2:
r_inputs[i] = p_buffer.read_vector2(info.compression_level);
break;
case DataBuffer::DATA_TYPE_NORMALIZED_VECTOR2:
r_inputs[i] = p_buffer.read_normalized_vector2(info.compression_level);
break;
case DataBuffer::DATA_TYPE_VECTOR3:
r_inputs[i] = p_buffer.read_vector3(info.compression_level);
break;
case DataBuffer::DATA_TYPE_NORMALIZED_VECTOR3:
r_inputs[i] = p_buffer.read_normalized_vector3(info.compression_level);
break;
case DataBuffer::DATA_TYPE_VARIANT:
r_inputs[i] = p_buffer.read_variant();
break;
};
}
}
}
void InputNetworkEncoder::reset_inputs_to_defaults(LocalVector<Variant> &r_input) const {
const uint32_t size = r_input.size() < input_info.size() ? r_input.size() : input_info.size();
for (uint32_t i = 0; i < size; i += 1) {
r_input[i] = input_info[i].default_value;
}
}
bool InputNetworkEncoder::are_different(DataBuffer &p_buffer_A, DataBuffer &p_buffer_B) const {
for (uint32_t i = 0; i < input_info.size(); i += 1) {
const NetworkedInputInfo &info = input_info[i];
const bool is_bool = info.default_value.get_type() == Variant::BOOL;
bool is_default_A = false;
bool is_default_B = false;
if (is_bool == false) {
is_default_A = p_buffer_A.read_bool();
is_default_B = p_buffer_B.read_bool();
}
bool are_equals = true;
if (is_default_A && is_default_B) {
are_equals = true;
} else {
switch (info.data_type) {
case DataBuffer::DATA_TYPE_BOOL:
are_equals = p_buffer_A.read_bool() == p_buffer_B.read_bool();
break;
case DataBuffer::DATA_TYPE_UINT:
are_equals = Math::is_equal_approx(p_buffer_A.read_uint(info.compression_level), p_buffer_B.read_uint(info.compression_level), info.comparison_floating_point_precision);
break;
case DataBuffer::DATA_TYPE_INT:
are_equals = Math::is_equal_approx(p_buffer_A.read_int(info.compression_level), p_buffer_B.read_int(info.compression_level), info.comparison_floating_point_precision);
break;
case DataBuffer::DATA_TYPE_REAL:
are_equals = Math::is_equal_approx(static_cast<real_t>(p_buffer_A.read_real(info.compression_level)), static_cast<real_t>(p_buffer_B.read_real(info.compression_level)), info.comparison_floating_point_precision);
break;
case DataBuffer::DATA_TYPE_POSITIVE_UNIT_REAL:
are_equals = Math::is_equal_approx(p_buffer_A.read_positive_unit_real(info.compression_level), p_buffer_B.read_positive_unit_real(info.compression_level), info.comparison_floating_point_precision);
break;
case DataBuffer::DATA_TYPE_UNIT_REAL:
are_equals = Math::is_equal_approx(p_buffer_A.read_unit_real(info.compression_level), p_buffer_B.read_unit_real(info.compression_level), info.comparison_floating_point_precision);
break;
case DataBuffer::DATA_TYPE_VECTOR2:
are_equals = SceneSynchronizer::compare(p_buffer_A.read_vector2(info.compression_level), p_buffer_B.read_vector2(info.compression_level), info.comparison_floating_point_precision);
break;
case DataBuffer::DATA_TYPE_NORMALIZED_VECTOR2:
are_equals = SceneSynchronizer::compare(p_buffer_A.read_normalized_vector2(info.compression_level), p_buffer_B.read_normalized_vector2(info.compression_level), info.comparison_floating_point_precision);
break;
case DataBuffer::DATA_TYPE_VECTOR3:
are_equals = SceneSynchronizer::compare(p_buffer_A.read_vector3(info.compression_level), p_buffer_B.read_vector3(info.compression_level), info.comparison_floating_point_precision);
break;
case DataBuffer::DATA_TYPE_NORMALIZED_VECTOR3:
are_equals = SceneSynchronizer::compare(p_buffer_A.read_normalized_vector3(info.compression_level), p_buffer_B.read_normalized_vector3(info.compression_level), info.comparison_floating_point_precision);
break;
case DataBuffer::DATA_TYPE_VARIANT:
are_equals = SceneSynchronizer::compare(p_buffer_A.read_variant(), p_buffer_B.read_variant(), info.comparison_floating_point_precision);
break;
};
}
if (!are_equals) {
return true;
}
}
return false;
}
uint32_t InputNetworkEncoder::count_size(DataBuffer &p_buffer) const {
int size = 0;
for (uint32_t i = 0; i < input_info.size(); i += 1) {
const NetworkedInputInfo &info = input_info[i];
const bool is_bool = info.default_value.get_type() == Variant::BOOL;
if (is_bool) {
// The bool data.
size += p_buffer.read_bool_size();
} else {
// The default marker
const bool is_default = p_buffer.read_bool();
size += p_buffer.get_bool_size();
if (is_default == false) {
// Non default data set the actual data, so we need to count
// the size.
switch (info.data_type) {
case DataBuffer::DATA_TYPE_BOOL:
CRASH_NOW_MSG("This can't ever happen, as the bool is already handled.");
break;
case DataBuffer::DATA_TYPE_UINT:
size += p_buffer.read_uint_size(info.compression_level);
break;
case DataBuffer::DATA_TYPE_INT:
size += p_buffer.read_int_size(info.compression_level);
break;
case DataBuffer::DATA_TYPE_REAL:
size += p_buffer.read_real_size(info.compression_level);
break;
case DataBuffer::DATA_TYPE_POSITIVE_UNIT_REAL:
size += p_buffer.read_positive_unit_real_size(info.compression_level);
break;
case DataBuffer::DATA_TYPE_UNIT_REAL:
size += p_buffer.read_unit_real_size(info.compression_level);
break;
case DataBuffer::DATA_TYPE_VECTOR2:
size += p_buffer.read_vector2_size(info.compression_level);
break;
case DataBuffer::DATA_TYPE_NORMALIZED_VECTOR2:
size += p_buffer.read_normalized_vector2_size(info.compression_level);
break;
case DataBuffer::DATA_TYPE_VECTOR3:
size += p_buffer.read_vector3_size(info.compression_level);
break;
case DataBuffer::DATA_TYPE_NORMALIZED_VECTOR3:
size += p_buffer.read_normalized_vector3_size(info.compression_level);
break;
case DataBuffer::DATA_TYPE_VARIANT:
size += p_buffer.read_variant_size();
break;
};
}
}
}
return size;
}
void InputNetworkEncoder::script_encode(const Array &p_inputs, Object *r_buffer) const {
ERR_FAIL_COND(r_buffer == nullptr);
DataBuffer *db = Object::cast_to<DataBuffer>(r_buffer);
ERR_FAIL_COND(db == nullptr);
LocalVector<Variant> inputs;
inputs.resize(p_inputs.size());
for (int i = 0; i < p_inputs.size(); i += 1) {
inputs[i] = p_inputs[i];
}
encode(inputs, *db);
}
Array InputNetworkEncoder::script_decode(Object *p_buffer) const {
ERR_FAIL_COND_V(p_buffer == nullptr, Array());
DataBuffer *db = Object::cast_to<DataBuffer>(p_buffer);
ERR_FAIL_COND_V(db == nullptr, Array());
LocalVector<Variant> inputs;
decode(*db, inputs);
Array out;
out.resize(inputs.size());
for (uint32_t i = 0; i < inputs.size(); i += 1) {
out[i] = inputs[i];
}
return out;
}
Array InputNetworkEncoder::script_get_defaults() const {
LocalVector<Variant> inputs;
inputs.resize(input_info.size());
reset_inputs_to_defaults(inputs);
Array out;
out.resize(inputs.size());
for (uint32_t i = 0; i < inputs.size(); i += 1) {
out[i] = inputs[i];
}
return out;
}
bool InputNetworkEncoder::script_are_different(Object *p_buffer_A, Object *p_buffer_B) const {
ERR_FAIL_COND_V(p_buffer_A == nullptr, true);
DataBuffer *db_A = Object::cast_to<DataBuffer>(p_buffer_A);
ERR_FAIL_COND_V(db_A == nullptr, false);
ERR_FAIL_COND_V(p_buffer_B == nullptr, true);
DataBuffer *db_B = Object::cast_to<DataBuffer>(p_buffer_B);
ERR_FAIL_COND_V(db_B == nullptr, true);
return are_different(*db_A, *db_B);
}
uint32_t InputNetworkEncoder::script_count_size(Object *p_buffer) const {
ERR_FAIL_COND_V(p_buffer == nullptr, 0);
DataBuffer *db = Object::cast_to<DataBuffer>(p_buffer);
ERR_FAIL_COND_V(db == nullptr, 0);
return count_size(*db);
}
Reference in New Issue Copy Permalink