zip.hpp

Go to the documentation of this file.

#pragma once
 
// ZIP archive and GZIP compression utilities via miniz.
 
#include <string>
#include <string_view>
#include <vector>
#include <cstdint>
#include <optional>
 
namespace pulp::runtime {
 
// ── GZIP compression/decompression ──────────────────────────────────────
//
// gzip_compress() emits a real RFC 1952 gzip stream:
//
//   header(10) || raw deflate || CRC32(little-endian, 4) || ISIZE(little-endian, 4)
//
// gzip_decompress() accepts both gzip (RFC 1952, magic 0x1f 0x8b) and zlib
// (RFC 1950) input. The zlib lane is preserved for backward compatibility
// with older callers and test fixtures that historically passed zlib-wrapped
// data through this entry point. Earlier revisions of this API silently
// produced and consumed zlib streams under a "gzip" name; that asymmetry
// has been removed — the function now actually handles RFC 1952 gzip.

std::optional<std::vector<uint8_t>> gzip_compress(const uint8_t* data, size_t size,
                                                   int level = 6);

inline constexpr size_t kDefaultMaxDecompressOutput = 256u * 1024u * 1024u;

std::optional<std::vector<uint8_t>> gzip_decompress(
    const uint8_t* data, size_t size,
    size_t max_output = kDefaultMaxDecompressOutput);

std::optional<std::vector<uint8_t>> gzip_compress(std::string_view data, int level = 6);

std::optional<std::string> gzip_decompress_string(const uint8_t* data, size_t size);
 
// ── Raw deflate compression ─────────────────────────────────────────────

std::optional<std::vector<uint8_t>> deflate_compress(const uint8_t* data, size_t size,
                                                      int level = 6);

std::optional<std::vector<uint8_t>> deflate_decompress(const uint8_t* data, size_t size);
 
// ── zlib (RFC 1950) compression ─────────────────────────────────────────
//
// zlib_compress emits a real RFC 1950 zlib stream:
//
//   CMF(1) FLG(1) || raw deflate || Adler32(big-endian, 4)
//
// Used for the MIDI-CI 1.2 Property Exchange `zlib+Mcoded7` payload
// encoding (PE spec §6.3). For symmetry with gzip_compress this
// emits a self-contained stream; gzip_decompress() already accepts
// zlib input on the inflate side.

std::optional<std::vector<uint8_t>> zlib_compress(const uint8_t* data, size_t size,
                                                  int level = 6);

std::optional<std::vector<uint8_t>> zlib_decompress(
    const uint8_t* data, size_t size,
    size_t max_output = kDefaultMaxDecompressOutput);

std::optional<std::string> zlib_decompress_exact(const uint8_t* data, size_t size,
                                                 size_t expected_size);
 
}  // namespace pulp::runtime