lz4_compression: Make use of std::span in interfaces

Allows compressing the data and size parameters into one.
This commit is contained in:
Lioncash 2020-07-25 03:17:01 -04:00
parent c5bdccfecb
commit 2e511246fa
2 changed files with 14 additions and 17 deletions

View file

@ -10,14 +10,14 @@
namespace Common::Compression { namespace Common::Compression {
std::vector<u8> CompressDataLZ4(const u8* source, std::size_t source_size) { std::vector<u8> CompressDataLZ4(std::span<const u8> source) {
ASSERT_MSG(source_size <= LZ4_MAX_INPUT_SIZE, "Source size exceeds LZ4 maximum input size"); ASSERT_MSG(source.size() <= LZ4_MAX_INPUT_SIZE, "Source size exceeds LZ4 maximum input size");
const auto source_size_int = static_cast<int>(source_size); const auto source_size_int = static_cast<int>(source.size());
const int max_compressed_size = LZ4_compressBound(source_size_int); const int max_compressed_size = LZ4_compressBound(source_size_int);
std::vector<u8> compressed(max_compressed_size); std::vector<u8> compressed(max_compressed_size);
const int compressed_size = LZ4_compress_default(reinterpret_cast<const char*>(source), const int compressed_size = LZ4_compress_default(reinterpret_cast<const char*>(source.data()),
reinterpret_cast<char*>(compressed.data()), reinterpret_cast<char*>(compressed.data()),
source_size_int, max_compressed_size); source_size_int, max_compressed_size);
@ -31,18 +31,17 @@ std::vector<u8> CompressDataLZ4(const u8* source, std::size_t source_size) {
return compressed; return compressed;
} }
std::vector<u8> CompressDataLZ4HC(const u8* source, std::size_t source_size, std::vector<u8> CompressDataLZ4HC(std::span<const u8> source, s32 compression_level) {
s32 compression_level) { ASSERT_MSG(source.size() <= LZ4_MAX_INPUT_SIZE, "Source size exceeds LZ4 maximum input size");
ASSERT_MSG(source_size <= LZ4_MAX_INPUT_SIZE, "Source size exceeds LZ4 maximum input size");
compression_level = std::clamp(compression_level, LZ4HC_CLEVEL_MIN, LZ4HC_CLEVEL_MAX); compression_level = std::clamp(compression_level, LZ4HC_CLEVEL_MIN, LZ4HC_CLEVEL_MAX);
const auto source_size_int = static_cast<int>(source_size); const auto source_size_int = static_cast<int>(source.size());
const int max_compressed_size = LZ4_compressBound(source_size_int); const int max_compressed_size = LZ4_compressBound(source_size_int);
std::vector<u8> compressed(max_compressed_size); std::vector<u8> compressed(max_compressed_size);
const int compressed_size = LZ4_compress_HC( const int compressed_size = LZ4_compress_HC(
reinterpret_cast<const char*>(source), reinterpret_cast<char*>(compressed.data()), reinterpret_cast<const char*>(source.data()), reinterpret_cast<char*>(compressed.data()),
source_size_int, max_compressed_size, compression_level); source_size_int, max_compressed_size, compression_level);
if (compressed_size <= 0) { if (compressed_size <= 0) {
@ -55,8 +54,8 @@ std::vector<u8> CompressDataLZ4HC(const u8* source, std::size_t source_size,
return compressed; return compressed;
} }
std::vector<u8> CompressDataLZ4HCMax(const u8* source, std::size_t source_size) { std::vector<u8> CompressDataLZ4HCMax(std::span<const u8> source) {
return CompressDataLZ4HC(source, source_size, LZ4HC_CLEVEL_MAX); return CompressDataLZ4HC(source, LZ4HC_CLEVEL_MAX);
} }
std::vector<u8> DecompressDataLZ4(const std::vector<u8>& compressed, std::vector<u8> DecompressDataLZ4(const std::vector<u8>& compressed,

View file

@ -4,6 +4,7 @@
#pragma once #pragma once
#include <span>
#include <vector> #include <vector>
#include "common/common_types.h" #include "common/common_types.h"
@ -14,11 +15,10 @@ namespace Common::Compression {
* Compresses a source memory region with LZ4 and returns the compressed data in a vector. * Compresses a source memory region with LZ4 and returns the compressed data in a vector.
* *
* @param source the uncompressed source memory region. * @param source the uncompressed source memory region.
* @param source_size the size in bytes of the uncompressed source memory region.
* *
* @return the compressed data. * @return the compressed data.
*/ */
std::vector<u8> CompressDataLZ4(const u8* source, std::size_t source_size); std::vector<u8> CompressDataLZ4(std::span<const u8> source);
/** /**
* Utilizes the LZ4 subalgorithm LZ4HC with the specified compression level. Higher compression * Utilizes the LZ4 subalgorithm LZ4HC with the specified compression level. Higher compression
@ -27,22 +27,20 @@ std::vector<u8> CompressDataLZ4(const u8* source, std::size_t source_size);
* also be decompressed with the default LZ4 decompression. * also be decompressed with the default LZ4 decompression.
* *
* @param source the uncompressed source memory region. * @param source the uncompressed source memory region.
* @param source_size the size in bytes of the uncompressed source memory region.
* @param compression_level the used compression level. Should be between 3 and 12. * @param compression_level the used compression level. Should be between 3 and 12.
* *
* @return the compressed data. * @return the compressed data.
*/ */
std::vector<u8> CompressDataLZ4HC(const u8* source, std::size_t source_size, s32 compression_level); std::vector<u8> CompressDataLZ4HC(std::span<const u8> source, s32 compression_level);
/** /**
* Utilizes the LZ4 subalgorithm LZ4HC with the highest possible compression level. * Utilizes the LZ4 subalgorithm LZ4HC with the highest possible compression level.
* *
* @param source the uncompressed source memory region. * @param source the uncompressed source memory region.
* @param source_size the size in bytes of the uncompressed source memory region.
* *
* @return the compressed data. * @return the compressed data.
*/ */
std::vector<u8> CompressDataLZ4HCMax(const u8* source, std::size_t source_size); std::vector<u8> CompressDataLZ4HCMax(std::span<const u8> source);
/** /**
* Decompresses a source memory region with LZ4 and returns the uncompressed data in a vector. * Decompresses a source memory region with LZ4 and returns the uncompressed data in a vector.