yuzu-fork/src/common/lz4_compression.h

60 lines
2.2 KiB
C++
Raw Normal View History

// SPDX-FileCopyrightText: Copyright 2019 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
2019-02-08 05:45:50 +00:00
#pragma once
#include <span>
2019-02-08 05:45:50 +00:00
#include <vector>
#include "common/common_types.h"
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 of the uncompressed source memory region.
2019-02-08 05:45:50 +00:00
*
* @return the compressed data.
*/
[[nodiscard]] std::vector<u8> CompressDataLZ4(const u8* source, std::size_t source_size);
2019-02-08 05:45:50 +00:00
/**
* Utilizes the LZ4 subalgorithm LZ4HC with the specified compression level. Higher compression
* levels result in a smaller compressed size, but require more CPU time for compression. The
* compression level has almost no impact on decompression speed. Data compressed with LZ4HC can
* also be decompressed with the default LZ4 decompression.
*
* @param source The uncompressed source memory region.
* @param source_size The size of the uncompressed source memory region.
* @param compression_level The used compression level. Should be between 3 and 12.
2019-02-08 05:45:50 +00:00
*
* @return the compressed data.
*/
[[nodiscard]] std::vector<u8> CompressDataLZ4HC(const u8* source, std::size_t source_size,
s32 compression_level);
2019-02-08 05:45:50 +00:00
/**
* Utilizes the LZ4 subalgorithm LZ4HC with the highest possible compression level.
*
* @param source The uncompressed source memory region.
* @param source_size The size of the uncompressed source memory region
2019-02-08 05:45:50 +00:00
*
* @return the compressed data.
*/
[[nodiscard]] std::vector<u8> CompressDataLZ4HCMax(const u8* source, std::size_t source_size);
2019-02-08 05:45:50 +00:00
/**
* Decompresses a source memory region with LZ4 and returns the uncompressed data in a vector.
*
* @param compressed the compressed source memory region.
* @param uncompressed_size the size in bytes of the uncompressed data.
*
* @return the decompressed data.
*/
[[nodiscard]] std::vector<u8> DecompressDataLZ4(std::span<const u8> compressed,
std::size_t uncompressed_size);
2019-02-08 05:45:50 +00:00
} // namespace Common::Compression