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

@ -4,6 +4,7 @@
#pragma once
#include <span>
#include <vector>
#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.
*
* @param source the uncompressed source memory region.
* @param source_size the size in bytes of the uncompressed source memory region.
*
* @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
@ -27,22 +27,20 @@ std::vector<u8> CompressDataLZ4(const u8* source, std::size_t source_size);
* also be decompressed with the default LZ4 decompression.
*
* @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.
*
* @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.
*
* @param source the uncompressed source memory region.
* @param source_size the size in bytes of the uncompressed source memory region.
*
* @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.