From 3d5cf5286bb4a84aeecc2ec5a4a9fdd204ba5d73 Mon Sep 17 00:00:00 2001 From: Techjar Date: Fri, 28 May 2021 20:53:02 -0400 Subject: [PATCH] NetPlay: Refactor some functions into a common header --- Source/Core/Core/CMakeLists.txt | 2 + Source/Core/Core/NetPlayClient.cpp | 89 +---------- Source/Core/Core/NetPlayClient.h | 3 - Source/Core/Core/NetPlayCommon.cpp | 227 +++++++++++++++++++++++++++++ Source/Core/Core/NetPlayCommon.h | 21 +++ Source/Core/Core/NetPlayProto.h | 17 +-- Source/Core/Core/NetPlayServer.cpp | 127 +--------------- Source/Core/Core/NetPlayServer.h | 2 - Source/Core/DolphinLib.props | 4 +- 9 files changed, 262 insertions(+), 230 deletions(-) create mode 100644 Source/Core/Core/NetPlayCommon.cpp create mode 100644 Source/Core/Core/NetPlayCommon.h diff --git a/Source/Core/Core/CMakeLists.txt b/Source/Core/Core/CMakeLists.txt index 892960e05c..c9a966267a 100644 --- a/Source/Core/Core/CMakeLists.txt +++ b/Source/Core/Core/CMakeLists.txt @@ -408,6 +408,8 @@ add_library(core Movie.h NetPlayClient.cpp NetPlayClient.h + NetPlayCommon.cpp + NetPlayCommon.h NetPlayServer.cpp NetPlayServer.h NetworkCaptureLogger.cpp diff --git a/Source/Core/Core/NetPlayClient.cpp b/Source/Core/Core/NetPlayClient.cpp index aaaa0bca38..dd66fe6366 100644 --- a/Source/Core/Core/NetPlayClient.cpp +++ b/Source/Core/Core/NetPlayClient.cpp @@ -15,7 +15,6 @@ #include #include -#include #include #include "Common/Assert.h" @@ -23,7 +22,6 @@ #include "Common/CommonTypes.h" #include "Common/ENetUtil.h" #include "Common/FileUtil.h" -#include "Common/IOFile.h" #include "Common/Logging/Log.h" #include "Common/MD5.h" #include "Common/MsgHandler.h" @@ -54,6 +52,7 @@ #include "Core/IOS/USB/Bluetooth/BTEmu.h" #include "Core/IOS/Uids.h" #include "Core/Movie.h" +#include "Core/NetPlayCommon.h" #include "Core/PowerPC/PowerPC.h" #include "Core/SyncIdentifier.h" @@ -1635,92 +1634,6 @@ void NetPlayClient::SyncCodeResponse(const bool success) } } -bool NetPlayClient::DecompressPacketIntoFile(sf::Packet& packet, const std::string& file_path) -{ - u64 file_size = Common::PacketReadU64(packet); - - if (file_size == 0) - return true; - - File::IOFile file(file_path, "wb"); - if (!file) - { - PanicAlertFmtT("Failed to open file \"{0}\". Verify your write permissions.", file_path); - return false; - } - - std::vector in_buffer(NETPLAY_LZO_OUT_LEN); - std::vector out_buffer(NETPLAY_LZO_IN_LEN); - - while (true) - { - u32 cur_len = 0; // number of bytes to read - lzo_uint new_len = 0; // number of bytes to write - - packet >> cur_len; - if (!cur_len) - break; // We reached the end of the data stream - - for (size_t j = 0; j < cur_len; j++) - { - packet >> in_buffer[j]; - } - - if (lzo1x_decompress(in_buffer.data(), cur_len, out_buffer.data(), &new_len, nullptr) != - LZO_E_OK) - { - PanicAlertFmtT("Internal LZO Error - decompression failed"); - return false; - } - - if (!file.WriteBytes(out_buffer.data(), new_len)) - { - PanicAlertFmtT("Error writing file: {0}", file_path); - return false; - } - } - - return true; -} - -std::optional> NetPlayClient::DecompressPacketIntoBuffer(sf::Packet& packet) -{ - u64 size = Common::PacketReadU64(packet); - - std::vector out_buffer(size); - - if (size == 0) - return out_buffer; - - std::vector in_buffer(NETPLAY_LZO_OUT_LEN); - - lzo_uint i = 0; - while (true) - { - u32 cur_len = 0; // number of bytes to read - lzo_uint new_len = 0; // number of bytes to write - - packet >> cur_len; - if (!cur_len) - break; // We reached the end of the data stream - - for (size_t j = 0; j < cur_len; j++) - { - packet >> in_buffer[j]; - } - - if (lzo1x_decompress(in_buffer.data(), cur_len, &out_buffer[i], &new_len, nullptr) != LZO_E_OK) - { - PanicAlertFmtT("Internal LZO Error - decompression failed"); - return {}; - } - - i += new_len; - } - - return out_buffer; -} - // called from ---GUI--- thread bool NetPlayClient::ChangeGame(const std::string&) { diff --git a/Source/Core/Core/NetPlayClient.h b/Source/Core/Core/NetPlayClient.h index 794cfe5c49..8cb2d7953e 100644 --- a/Source/Core/Core/NetPlayClient.h +++ b/Source/Core/Core/NetPlayClient.h @@ -9,7 +9,6 @@ #include #include #include -#include #include #include #include @@ -221,8 +220,6 @@ private: void SyncSaveDataResponse(bool success); void SyncCodeResponse(bool success); - bool DecompressPacketIntoFile(sf::Packet& packet, const std::string& file_path); - std::optional> DecompressPacketIntoBuffer(sf::Packet& packet); bool PollLocalPad(int local_pad, sf::Packet& packet); void SendPadHostPoll(PadIndex pad_num); diff --git a/Source/Core/Core/NetPlayCommon.cpp b/Source/Core/Core/NetPlayCommon.cpp new file mode 100644 index 0000000000..910c7308fd --- /dev/null +++ b/Source/Core/Core/NetPlayCommon.cpp @@ -0,0 +1,227 @@ +// Copyright 2021 Dolphin Emulator Project +// SPDX-License-Identifier: GPL-2.0-or-later + +#include "Core/NetPlayCommon.h" + +#include + +#include "Common/FileUtil.h" +#include "Common/IOFile.h" +#include "Common/MsgHandler.h" +#include "Common/SFMLHelper.h" + +namespace NetPlay +{ +constexpr u32 LZO_IN_LEN = 1024 * 64; +constexpr u32 LZO_OUT_LEN = LZO_IN_LEN + (LZO_IN_LEN / 16) + 64 + 3; + +bool CompressFileIntoPacket(const std::string& file_path, sf::Packet& packet) +{ + File::IOFile file(file_path, "rb"); + if (!file) + { + PanicAlertFmtT("Failed to open file \"{0}\".", file_path); + return false; + } + + const sf::Uint64 size = file.GetSize(); + packet << size; + + if (size == 0) + return true; + + std::vector in_buffer(LZO_IN_LEN); + std::vector out_buffer(LZO_OUT_LEN); + std::vector wrkmem(LZO1X_1_MEM_COMPRESS); + + lzo_uint i = 0; + while (true) + { + lzo_uint32 cur_len = 0; // number of bytes to read + lzo_uint out_len = 0; // number of bytes to write + + if ((i + LZO_IN_LEN) >= size) + { + cur_len = static_cast(size - i); + } + else + { + cur_len = LZO_IN_LEN; + } + + if (cur_len <= 0) + break; // EOF + + if (!file.ReadBytes(in_buffer.data(), cur_len)) + { + PanicAlertFmtT("Error reading file: {0}", file_path.c_str()); + return false; + } + + if (lzo1x_1_compress(in_buffer.data(), cur_len, out_buffer.data(), &out_len, wrkmem.data()) != + LZO_E_OK) + { + PanicAlertFmtT("Internal LZO Error - compression failed"); + return false; + } + + // The size of the data to write is 'out_len' + packet << static_cast(out_len); + for (size_t j = 0; j < out_len; j++) + { + packet << out_buffer[j]; + } + + if (cur_len != LZO_IN_LEN) + break; + + i += cur_len; + } + + // Mark end of data + packet << static_cast(0); + + return true; +} + +bool CompressBufferIntoPacket(const std::vector& in_buffer, sf::Packet& packet) +{ + const sf::Uint64 size = in_buffer.size(); + packet << size; + + if (size == 0) + return true; + + std::vector out_buffer(LZO_OUT_LEN); + std::vector wrkmem(LZO1X_1_MEM_COMPRESS); + + lzo_uint i = 0; + while (true) + { + lzo_uint32 cur_len = 0; // number of bytes to read + lzo_uint out_len = 0; // number of bytes to write + + if ((i + LZO_IN_LEN) >= size) + { + cur_len = static_cast(size - i); + } + else + { + cur_len = LZO_IN_LEN; + } + + if (cur_len <= 0) + break; // end of buffer + + if (lzo1x_1_compress(&in_buffer[i], cur_len, out_buffer.data(), &out_len, wrkmem.data()) != + LZO_E_OK) + { + PanicAlertFmtT("Internal LZO Error - compression failed"); + return false; + } + + // The size of the data to write is 'out_len' + packet << static_cast(out_len); + for (size_t j = 0; j < out_len; j++) + { + packet << out_buffer[j]; + } + + if (cur_len != LZO_IN_LEN) + break; + + i += cur_len; + } + + // Mark end of data + packet << static_cast(0); + + return true; +} + +bool DecompressPacketIntoFile(sf::Packet& packet, const std::string& file_path) +{ + u64 file_size = Common::PacketReadU64(packet); + + if (file_size == 0) + return true; + + File::IOFile file(file_path, "wb"); + if (!file) + { + PanicAlertFmtT("Failed to open file \"{0}\". Verify your write permissions.", file_path); + return false; + } + + std::vector in_buffer(LZO_OUT_LEN); + std::vector out_buffer(LZO_IN_LEN); + + while (true) + { + u32 cur_len = 0; // number of bytes to read + lzo_uint new_len = 0; // number of bytes to write + + packet >> cur_len; + if (!cur_len) + break; // We reached the end of the data stream + + for (size_t j = 0; j < cur_len; j++) + { + packet >> in_buffer[j]; + } + + if (lzo1x_decompress(in_buffer.data(), cur_len, out_buffer.data(), &new_len, nullptr) != + LZO_E_OK) + { + PanicAlertFmtT("Internal LZO Error - decompression failed"); + return false; + } + + if (!file.WriteBytes(out_buffer.data(), new_len)) + { + PanicAlertFmtT("Error writing file: {0}", file_path); + return false; + } + } + + return true; +} + +std::optional> DecompressPacketIntoBuffer(sf::Packet& packet) +{ + u64 size = Common::PacketReadU64(packet); + + std::vector out_buffer(size); + + if (size == 0) + return out_buffer; + + std::vector in_buffer(LZO_OUT_LEN); + + lzo_uint i = 0; + while (true) + { + u32 cur_len = 0; // number of bytes to read + lzo_uint new_len = 0; // number of bytes to write + + packet >> cur_len; + if (!cur_len) + break; // We reached the end of the data stream + + for (size_t j = 0; j < cur_len; j++) + { + packet >> in_buffer[j]; + } + + if (lzo1x_decompress(in_buffer.data(), cur_len, &out_buffer[i], &new_len, nullptr) != LZO_E_OK) + { + PanicAlertFmtT("Internal LZO Error - decompression failed"); + return {}; + } + + i += new_len; + } + + return out_buffer; +} +} // namespace NetPlay diff --git a/Source/Core/Core/NetPlayCommon.h b/Source/Core/Core/NetPlayCommon.h new file mode 100644 index 0000000000..fc2a017047 --- /dev/null +++ b/Source/Core/Core/NetPlayCommon.h @@ -0,0 +1,21 @@ +// Copyright 2021 Dolphin Emulator Project +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + +#include + +#include +#include +#include +#include + +#include "Common/CommonTypes.h" + +namespace NetPlay +{ +bool CompressFileIntoPacket(const std::string& file_path, sf::Packet& packet); +bool CompressBufferIntoPacket(const std::vector& in_buffer, sf::Packet& packet); +bool DecompressPacketIntoFile(sf::Packet& packet, const std::string& file_path); +std::optional> DecompressPacketIntoBuffer(sf::Packet& packet); +} // namespace NetPlay diff --git a/Source/Core/Core/NetPlayProto.h b/Source/Core/Core/NetPlayProto.h index 9c3a37d723..1b547eda80 100644 --- a/Source/Core/Core/NetPlayProto.h +++ b/Source/Core/Core/NetPlayProto.h @@ -117,11 +117,6 @@ struct NetTraversalConfig u16 traversal_port = 0; }; -struct Rpt : public std::vector -{ - u16 channel; -}; - // messages enum { @@ -210,13 +205,15 @@ enum SYNC_CODES_FAILURE = 6, }; -constexpr u32 NETPLAY_LZO_IN_LEN = 1024 * 64; -constexpr u32 NETPLAY_LZO_OUT_LEN = NETPLAY_LZO_IN_LEN + (NETPLAY_LZO_IN_LEN / 16) + 64 + 3; constexpr u32 MAX_NAME_LENGTH = 30; constexpr size_t CHUNKED_DATA_UNIT_SIZE = 16384; -constexpr u8 CHANNEL_COUNT = 2; -constexpr u8 DEFAULT_CHANNEL = 0; -constexpr u8 CHUNKED_DATA_CHANNEL = 1; + +enum : u8 +{ + DEFAULT_CHANNEL, + CHUNKED_DATA_CHANNEL, + CHANNEL_COUNT +}; struct WiimoteInput { diff --git a/Source/Core/Core/NetPlayServer.cpp b/Source/Core/Core/NetPlayServer.cpp index fe50dc0399..f0dae94923 100644 --- a/Source/Core/Core/NetPlayServer.cpp +++ b/Source/Core/Core/NetPlayServer.cpp @@ -18,13 +18,11 @@ #include #include -#include #include "Common/CommonPaths.h" #include "Common/ENetUtil.h" #include "Common/FileUtil.h" #include "Common/HttpRequest.h" -#include "Common/IOFile.h" #include "Common/Logging/Log.h" #include "Common/MsgHandler.h" #include "Common/SFMLHelper.h" @@ -55,6 +53,7 @@ #include "Core/IOS/IOS.h" #include "Core/IOS/Uids.h" #include "Core/NetPlayClient.h" //for NetPlayUI +#include "Core/NetPlayCommon.h" #include "Core/SyncIdentifier.h" #include "DiscIO/Enums.h" @@ -1906,130 +1905,6 @@ void NetPlayServer::CheckSyncAndStartGame() } } -bool NetPlayServer::CompressFileIntoPacket(const std::string& file_path, sf::Packet& packet) -{ - File::IOFile file(file_path, "rb"); - if (!file) - { - PanicAlertFmtT("Failed to open file \"{0}\".", file_path); - return false; - } - - const sf::Uint64 size = file.GetSize(); - packet << size; - - if (size == 0) - return true; - - std::vector in_buffer(NETPLAY_LZO_IN_LEN); - std::vector out_buffer(NETPLAY_LZO_OUT_LEN); - std::vector wrkmem(LZO1X_1_MEM_COMPRESS); - - lzo_uint i = 0; - while (true) - { - lzo_uint32 cur_len = 0; // number of bytes to read - lzo_uint out_len = 0; // number of bytes to write - - if ((i + NETPLAY_LZO_IN_LEN) >= size) - { - cur_len = static_cast(size - i); - } - else - { - cur_len = NETPLAY_LZO_IN_LEN; - } - - if (cur_len <= 0) - break; // EOF - - if (!file.ReadBytes(in_buffer.data(), cur_len)) - { - PanicAlertFmtT("Error reading file: {0}", file_path.c_str()); - return false; - } - - if (lzo1x_1_compress(in_buffer.data(), cur_len, out_buffer.data(), &out_len, wrkmem.data()) != - LZO_E_OK) - { - PanicAlertFmtT("Internal LZO Error - compression failed"); - return false; - } - - // The size of the data to write is 'out_len' - packet << static_cast(out_len); - for (size_t j = 0; j < out_len; j++) - { - packet << out_buffer[j]; - } - - if (cur_len != NETPLAY_LZO_IN_LEN) - break; - - i += cur_len; - } - - // Mark end of data - packet << static_cast(0); - - return true; -} - -bool NetPlayServer::CompressBufferIntoPacket(const std::vector& in_buffer, sf::Packet& packet) -{ - const sf::Uint64 size = in_buffer.size(); - packet << size; - - if (size == 0) - return true; - - std::vector out_buffer(NETPLAY_LZO_OUT_LEN); - std::vector wrkmem(LZO1X_1_MEM_COMPRESS); - - lzo_uint i = 0; - while (true) - { - lzo_uint32 cur_len = 0; // number of bytes to read - lzo_uint out_len = 0; // number of bytes to write - - if ((i + NETPLAY_LZO_IN_LEN) >= size) - { - cur_len = static_cast(size - i); - } - else - { - cur_len = NETPLAY_LZO_IN_LEN; - } - - if (cur_len <= 0) - break; // end of buffer - - if (lzo1x_1_compress(&in_buffer[i], cur_len, out_buffer.data(), &out_len, wrkmem.data()) != - LZO_E_OK) - { - PanicAlertFmtT("Internal LZO Error - compression failed"); - return false; - } - - // The size of the data to write is 'out_len' - packet << static_cast(out_len); - for (size_t j = 0; j < out_len; j++) - { - packet << out_buffer[j]; - } - - if (cur_len != NETPLAY_LZO_IN_LEN) - break; - - i += cur_len; - } - - // Mark end of data - packet << static_cast(0); - - return true; -} - u64 NetPlayServer::GetInitialNetPlayRTC() const { const auto& config = SConfig::GetInstance(); diff --git a/Source/Core/Core/NetPlayServer.h b/Source/Core/Core/NetPlayServer.h index b0019f92d4..26c7c6e20f 100644 --- a/Source/Core/Core/NetPlayServer.h +++ b/Source/Core/Core/NetPlayServer.h @@ -120,8 +120,6 @@ private: bool SyncSaveData(); bool SyncCodes(); void CheckSyncAndStartGame(); - bool CompressFileIntoPacket(const std::string& file_path, sf::Packet& packet); - bool CompressBufferIntoPacket(const std::vector& in_buffer, sf::Packet& packet); u64 GetInitialNetPlayRTC() const; diff --git a/Source/Core/DolphinLib.props b/Source/Core/DolphinLib.props index 8ad1af3b4a..67c1a2eace 100644 --- a/Source/Core/DolphinLib.props +++ b/Source/Core/DolphinLib.props @@ -375,6 +375,7 @@ + @@ -952,6 +953,7 @@ + @@ -1215,4 +1217,4 @@ - \ No newline at end of file +