lz4

简介

LZ4库相关笔记

lz4.h 是什么

lz4.h 是 LZ4 压缩库的头文件。LZ4 是一种非常快速的无损压缩算法，专为高性能和高压缩率设计。LZ4 库主要用于数据压缩和解压缩操作，适用于需要快速处理大量数据的应用程序。

LZ4 库的头文件 lz4.h 定义了所有必要的函数和数据结构，使得开发者可以在他们的 C 或 C++ 项目中轻松地使用 LZ4 压缩和解压缩功能。这个头文件通常包含以下内容：

数据类型和结构：定义了用于压缩和解压缩过程的数据类型和结构体。
宏和常量：定义了库中使用的一些常量和宏。
函数声明：声明了库中提供的所有函数，包括压缩和解压缩函数。

常用的函数包括：

LZ4_compress_default()
LZ4_decompress_safe()
LZ4_compressBound()

这些函数分别用于默认压缩、解压缩和计算压缩缓冲区的最大大小。

以下是一个使用 lz4.h 的简单示例，演示如何进行压缩和解压缩：

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "lz4.h"

int main() {
    // 原始数据
    const char* input = "Hello, LZ4 compression!";
    int inputSize = strlen(input) + 1;

    // 压缩缓冲区
    int maxCompressedSize = LZ4_compressBound(inputSize);
    char* compressedData = (char*)malloc(maxCompressedSize);

    // 压缩数据
    int compressedDataSize = LZ4_compress_default(input, compressedData, inputSize, maxCompressedSize);
    if (compressedDataSize <= 0) {
        fprintf(stderr, "Compression failed!\n");
        free(compressedData);
        return 1;
    }

    // 解压缩缓冲区
    char* decompressedData = (char*)malloc(inputSize);

    // 解压缩数据
    int decompressedSize = LZ4_decompress_safe(compressedData, decompressedData, compressedDataSize, inputSize);
    if (decompressedSize < 0) {
        fprintf(stderr, "Decompression failed!\n");
        free(compressedData);
        free(decompressedData);
        return 1;
    }

    // 输出解压缩后的数据
    printf("Decompressed data: %s\n", decompressedData);

    // 清理内存
    free(compressedData);
    free(decompressedData);

    return 0;
}

这个示例展示了如何使用 LZ4 库进行数据的压缩和解压缩操作。

LZ4 库是什么

LZ4 库是一个开源的压缩算法库，专注于提供高效、快速的无损压缩和解压缩功能。LZ4 是一种非常快的压缩算法，能够在保持高压缩速度的同时提供良好的压缩率。它特别适用于需要快速处理大量数据的应用程序，例如日志压缩、传输数据的实时压缩、存储系统等。

LZ4 库具有以下几个主要特点：

高速压缩和解压缩：LZ4 以其极快的压缩和解压缩速度而闻名，通常在几百MB/s到几GB/s的范围内。
无损压缩：LZ4 是无损压缩算法，这意味着压缩和解压缩过程中数据不会丢失。
简单易用：LZ4 库提供了简单易用的 API，可以很容易地集成到 C、C++ 项目中。它还提供了其他语言的绑定，例如 Python、Java 等。
小内存占用：LZ4 的压缩和解压缩过程对内存的占用很小，适合在内存受限的环境中使用。

LZ4 库的使用

LZ4 库主要提供了两个核心函数：LZ4_compress_default 和 LZ4_decompress_safe。

压缩数据

LZ4_compress_default 函数用于压缩数据：

int LZ4_compress_default(const char* source, char* dest, int sourceSize, int maxDestSize);

source：指向要压缩的源数据。
dest：指向压缩后存储数据的目标缓冲区。
sourceSize：源数据的大小。
maxDestSize：目标缓冲区的最大大小。

返回值是压缩后的数据大小，如果返回值为 0 或负值，则表示压缩失败。

解压缩数据

LZ4_decompress_safe 函数用于解压缩数据：

int LZ4_decompress_safe(const char* source, char* dest, int compressedSize, int maxDecompressedSize);

source：指向要解压缩的压缩数据。
dest：指向解压缩后存储数据的目标缓冲区。
compressedSize：压缩数据的大小。
maxDecompressedSize：目标缓冲区的最大大小。

返回值是解压缩后的数据大小，如果返回值为负值，则表示解压缩失败。

示例代码

下面是一个简单的示例，展示了如何使用 LZ4 库进行数据的压缩和解压缩：

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "lz4.h"

int main() {
    // 原始数据
    const char* input = "Hello, LZ4 compression!";
    int inputSize = strlen(input) + 1;

    // 压缩缓冲区
    int maxCompressedSize = LZ4_compressBound(inputSize);
    char* compressedData = (char*)malloc(maxCompressedSize);

    // 压缩数据
    int compressedDataSize = LZ4_compress_default(input, compressedData, inputSize, maxCompressedSize);
    if (compressedDataSize <= 0) {
        fprintf(stderr, "Compression failed!\n");
        free(compressedData);
        return 1;
    }

    // 解压缩缓冲区
    char* decompressedData = (char*)malloc(inputSize);

    // 解压缩数据
    int decompressedSize = LZ4_decompress_safe(compressedData, decompressedData, compressedDataSize, inputSize);
    if (decompressedSize < 0) {
        fprintf(stderr, "Decompression failed!\n");
        free(compressedData);
        free(decompressedData);
        return 1;
    }

    // 输出解压缩后的数据
    printf("Decompressed data: %s\n", decompressedData);

    // 清理内存
    free(compressedData);
    free(decompressedData);

    return 0;
}

这个示例展示了如何使用 LZ4 库的压缩和解压缩函数来处理字符串数据。

LZ4库编译安装

要编译和安装 LZ4 库，你可以按照以下步骤进行。这里假设你使用的是 Unix 系统，例如 Linux 或 macOS。如果你使用的是 Windows 系统，可以参考对应的指南。

1. 下载 LZ4 源代码

首先，你需要从 LZ4 的 GitHub 仓库下载源代码。你可以使用 git 命令来克隆仓库，或者直接从 GitHub 网站下载压缩包。

git clone https://github.com/lz4/lz4.git
cd lz4

2. 编译 LZ4 库

进入 LZ4 源代码目录后，使用以下命令来编译库。LZ4 使用 make 工具来管理编译过程。

make

这个命令会编译所有的源文件并生成可执行文件和库文件。

3. 安装 LZ4 库

编译完成后，你可以使用以下命令来安装 LZ4 库。默认情况下，库会安装到系统的标准位置（例如 /usr/local）。

sudo make install

如果你希望将库安装到自定义位置，可以使用 PREFIX 选项来指定目标路径：

sudo make install PREFIX=/path/to/your/installation/directory

4. 验证安装

你可以使用以下命令来验证 LZ4 是否安装成功：

lz4 -V

这个命令会输出 LZ4 的版本信息，表明 LZ4 已成功安装。

5. 在项目中使用 LZ4 库

在你的 C/C++ 项目中，你需要包含 LZ4 的头文件并链接 LZ4 库。假设你已经安装 LZ4，并且头文件和库文件位于系统的标准位置，你可以使用以下示例代码：

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "lz4.h"

int main() {
    // 原始数据
    const char* input = "Hello, LZ4 compression!";
    int inputSize = strlen(input) + 1;

    // 压缩缓冲区
    int maxCompressedSize = LZ4_compressBound(inputSize);
    char* compressedData = (char*)malloc(maxCompressedSize);

    // 压缩数据
    int compressedDataSize = LZ4_compress_default(input, compressedData, inputSize, maxCompressedSize);
    if (compressedDataSize <= 0) {
        fprintf(stderr, "Compression failed!\n");
        free(compressedData);
        return 1;
    }

    // 解压缩缓冲区
    char* decompressedData = (char*)malloc(inputSize);

    // 解压缩数据
    int decompressedSize = LZ4_decompress_safe(compressedData, decompressedData, compressedDataSize, inputSize);
    if (decompressedSize < 0) {
        fprintf(stderr, "Decompression failed!\n");
        free(compressedData);
        free(decompressedData);
        return 1;
    }

    // 输出解压缩后的数据
    printf("Decompressed data: %s\n", decompressedData);

    // 清理内存
    free(compressedData);
    free(decompressedData);

    return 0;
}

编译这个示例代码时，记得链接 LZ4 库：

gcc -o example example.c -llz4

通过以上步骤，你应该能够成功地编译、安装和使用 LZ4 库。

简介