dep-minizip-ng/mz_strm_ppmd.c
2026-08-06 21:47:01 -07:00

492 lines
14 KiB
C

/* mz_strm_ppmd.c -- Stream for PPMd compress/decompress
part of the minizip-ng project
Copyright (C) Nathan Moinvaziri
https://github.com/zlib-ng/minizip-ng
This program is distributed under the terms of the same license as zlib.
See the accompanying LICENSE file for the full text of the license.
*/
#include <assert.h>
#include "mz.h"
#include "mz_strm.h"
#include "mz_strm_ppmd.h"
#include "C/Ppmd8.h"
#include "C/7zTypes.h"
/***************************************************************************/
static mz_stream_vtbl mz_stream_ppmd_vtbl = {
mz_stream_ppmd_open, mz_stream_ppmd_is_open, mz_stream_ppmd_read, mz_stream_ppmd_write,
mz_stream_ppmd_tell, mz_stream_ppmd_seek, mz_stream_ppmd_close, mz_stream_ppmd_error,
mz_stream_ppmd_create, mz_stream_ppmd_delete, mz_stream_ppmd_get_prop_int64, mz_stream_ppmd_set_prop_int64};
/***************************************************************************/
#define PPMD_PRESET_DEFAULT 9 // Should match default in 7-Zip
// Return values from Ppmd8_DecodeSymbol
#define PPMD_RESULT_EOF (-1)
#define PPMD_RESULT_ERROR (-2)
/***************************************************************************/
typedef struct mz_in_buffer_s {
const void *src;
size_t size;
size_t pos;
} mz_in_buffer;
typedef struct mz_out_buffer_s {
void *dst;
size_t size;
size_t pos;
} mz_out_buffer;
typedef struct mz_ppmd_info_s {
/* hold CPpmd8 or CPpmd7 struct pointer */
void *cPpmd;
void *rc;
mz_in_buffer *in;
mz_out_buffer *out;
int max_length;
int result;
void *t;
} mz_ppmd_info;
typedef struct {
/* Inherits from IByteIn */
Byte (*read)(void *p);
mz_in_buffer *in_buffer;
void *t;
} mz_buffer_reader;
typedef struct {
/* Inherits from IByteOut */
void (*write)(void *p, Byte b);
mz_out_buffer *out_buffer;
mz_ppmd_info *t;
} mz_buffer_writer;
typedef struct mz_stream_ppmd_s {
mz_stream stream;
CPpmd8 ppmd8;
uint8_t buffer[INT16_MAX];
int64_t total_in;
int64_t total_out;
int64_t max_total_in;
int32_t mode;
int32_t error;
int8_t initialized;
ISzAlloc allocator;
// Write specific
mz_buffer_writer writer;
mz_out_buffer out;
int32_t preset; // PPMD uses the term level for this
// Read Specific
mz_buffer_reader reader;
mz_in_buffer in;
int8_t end_stream;
} mz_stream_ppmd;
/***************************************************************************/
/* malloc wrapper for PPMD library */
static void *mz_ppmd_alloc_func(const ISzAlloc *p, size_t size) {
MZ_UNUSED(p);
return malloc(size);
}
/* free wrapper for PPMD library */
static void mz_ppmd_free_func(const ISzAlloc *p, void *address) {
MZ_UNUSED(p);
free(address);
}
#ifndef MZ_ZIP_NO_COMPRESSION
static void writer(void *p, Byte b) {
mz_buffer_writer *buffer_writer = (mz_buffer_writer *)p;
if (buffer_writer->out_buffer->size == buffer_writer->out_buffer->pos) {
return;
}
*((Byte *)buffer_writer->out_buffer->dst + buffer_writer->out_buffer->pos++) = b;
}
static int32_t mz_stream_ppmd_flush(void *stream) {
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)stream;
if (ppmd->out.pos) {
if (mz_stream_write(ppmd->stream.base, ppmd->out.dst, ppmd->out.pos) != ppmd->out.pos)
return MZ_WRITE_ERROR;
ppmd->total_out += ppmd->out.pos;
ppmd->out.pos = 0;
}
return MZ_OK;
}
static void mz_setup_buffered_writer(mz_stream_ppmd *ppmd) {
ppmd->out.dst = ppmd->buffer;
ppmd->out.size = sizeof(ppmd->buffer); // INT16_MAX;
ppmd->out.pos = 0;
ppmd->writer.write = writer;
ppmd->writer.out_buffer = &ppmd->out;
ppmd->ppmd8.Stream.Out = (IByteOut *)&ppmd->writer;
}
#endif
#ifndef MZ_ZIP_NO_DECOMPRESSION
static Byte reader(void *p) {
mz_buffer_reader *buffer_reader = (mz_buffer_reader *)p;
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)buffer_reader->t;
uint8_t b;
int32_t status;
if (ppmd->max_total_in > 0 && ppmd->total_in >= ppmd->max_total_in) {
ppmd->error = MZ_STREAM_ERROR;
return 0;
}
if ((status = mz_stream_read_uint8((mz_stream_ppmd *)ppmd->stream.base, &b)) != MZ_OK) {
ppmd->error = status;
b = 0;
} else
++ppmd->total_in;
return (Byte)b;
}
static void mz_setup_buffered_reader(mz_stream_ppmd *ppmd) {
ppmd->in.src = ppmd->buffer;
ppmd->in.size = sizeof(ppmd->buffer); // INT16_MAX;
ppmd->in.pos = 0;
ppmd->reader.read = reader;
ppmd->reader.in_buffer = &ppmd->in;
ppmd->ppmd8.Stream.In = (IByteIn *)&ppmd->reader;
ppmd->reader.t = ppmd;
}
#endif
int32_t mz_stream_ppmd_open(void *stream, const char *path, int32_t mode) {
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)stream;
MZ_UNUSED(path);
Ppmd8_Construct(&ppmd->ppmd8);
if (mode & MZ_OPEN_MODE_WRITE) {
#ifdef MZ_ZIP_NO_COMPRESSION
MZ_UNUSED(stream);
return MZ_SUPPORT_ERROR;
#else
/* PPMD8_MIN_ORDER (= 2) <= order <= PPMD8_MAX_ORDER (= 16)
* 2MB (= 2^ 1) <= memSize <= 128MB (= 2^ 7) (M = 2^ 20)
* restor = 0 (PPMD8_RESTORE_METHOD_RESTART),
* 1 (PPMD8_RESTORE_METHOD_CUT_OFF)
*
* Currently using 7-Zip-compatible values:
* order = 3 + level
* memory size = 2^ (level- 1) (MB) (level 9 treated as level 8.)
* restoration method = 0 for level <= 6, 1 for level >= 7.
*
*/
/* PPMd parameters. */
unsigned order = ppmd->preset; /* 2, 3, ..., 16. */
uint32_t mem_size;
unsigned restor;
uint16_t ppmd_param_word;
if (order < PPMD8_MIN_ORDER || order > PPMD8_MAX_ORDER)
return MZ_OPEN_ERROR;
mz_setup_buffered_writer(ppmd);
mem_size = 1 << ((order < 8 ? order : 8) - 1); /* 2MB, 4MB, ..., 128MB. */
restor = (order <= 6 ? 0 : 1);
mem_size <<= 20; /* Convert B to MB. */
if (!Ppmd8_Alloc(&ppmd->ppmd8, mem_size, &ppmd->allocator)) {
return MZ_MEM_ERROR;
}
Ppmd8_Init_RangeEnc(&ppmd->ppmd8);
Ppmd8_Init(&ppmd->ppmd8, order, restor);
/* wPPMd = (Model order - 1) +
* ((Sub-allocator size - 1) << 4) +
* (Model restoration method << 12)
*
* 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
* Mdl_Res_Mth ___Sub-allocator_size-1 Mdl_Order-1
*/
/* Form the PPMd properties word. Put out the bytes. */
ppmd_param_word = ((order - 1) & 0xf) + ((((mem_size >> 20) - 1) & 0xff) << 4) + ((restor & 0xf) << 12);
// write header bytes directly to output buffer, bypassing the compression code
// These bytes will be included in the compressed size stored in the zip metadata.
((uint8_t *)ppmd->out.dst)[0] = (uint8_t)(ppmd_param_word & 0xff);
((uint8_t *)ppmd->out.dst)[1] = (uint8_t)(ppmd_param_word >> 8);
ppmd->out.pos += 2;
mz_stream_ppmd_flush(ppmd);
#endif
} else if (mode & MZ_OPEN_MODE_READ) {
#ifdef MZ_ZIP_NO_DECOMPRESSION
MZ_UNUSED(stream);
return MZ_SUPPORT_ERROR;
#else
uint8_t ppmd_props[2]; /* PPMd properties. */
uint16_t ppmd_prop_word; /* PPMd properties. */
/* Initialize the 7-Zip I/O structure. */
mz_setup_buffered_reader(ppmd);
/* Read & parse the 2 PPMD header bytes into a 16-bit word */
if (mz_stream_read_uint8(ppmd->stream.base, &ppmd_props[0]) != MZ_OK ||
mz_stream_read_uint8(ppmd->stream.base, &ppmd_props[1]) != MZ_OK)
return MZ_STREAM_ERROR;
ppmd_prop_word = ppmd_props[0] | (ppmd_props[1] << 8);
ppmd->total_in += 2;
/* wPPMd = (Model order - 1) +
* ((Sub-allocator size - 1) << 4) +
* (Model restoration method << 12)
*
* 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
* Mdl_Res_Mth ___Sub-allocator_size-1 Mdl_Order-1
*/
unsigned order = (ppmd_prop_word & 0xf) + 1;
uint32_t mem_size = ((ppmd_prop_word >> 4) & 0xff) + 1;
unsigned restor = (ppmd_prop_word >> 12);
/* Convert archive MB value into raw byte value. */
mem_size <<= 20;
if ((order < PPMD8_MIN_ORDER) || (order > PPMD8_MAX_ORDER))
return MZ_STREAM_ERROR;
if (!Ppmd8_Alloc(&ppmd->ppmd8, mem_size, &ppmd->allocator))
return MZ_STREAM_ERROR;
if (!Ppmd8_Init_RangeDec(&ppmd->ppmd8)) {
Ppmd8_Free(&ppmd->ppmd8, &ppmd->allocator);
return MZ_STREAM_ERROR;
}
Ppmd8_Init(&ppmd->ppmd8, order, restor);
#endif
}
ppmd->initialized = 1;
ppmd->mode = mode;
return MZ_OK;
}
int32_t mz_stream_ppmd_is_open(void *stream) {
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)stream;
if (ppmd->initialized != 1)
return MZ_OPEN_ERROR;
return MZ_OK;
}
int32_t mz_stream_ppmd_read(void *stream, void *buf, int32_t size) {
#ifdef MZ_ZIP_NO_DECOMPRESSION
MZ_UNUSED(stream);
MZ_UNUSED(buf);
MZ_UNUSED(size);
return MZ_SUPPORT_ERROR;
#else
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)stream;
uint8_t *next_out = buf;
int32_t avail_out;
int64_t start_in = ppmd->total_in;
int64_t avail_in = (ppmd->max_total_in > 0 ? ppmd->max_total_in : INT64_MAX) - start_in;
int sym = 0;
int32_t written = 0;
if (ppmd->end_stream)
return MZ_OK;
/* Decode input to fill the output buffer. */
for (avail_out = size; avail_out > 0 && avail_in > (ppmd->total_in - start_in); avail_out--) {
sym = Ppmd8_DecodeSymbol(&ppmd->ppmd8);
/* There are two ways to terminate the loop early:
1. Ppmd8_DecodeSymbol returns a negative number to flag EOF or stream error.
2. ppmd->error gets set to true here when the call to mz_stream_read_uint8
in reader() does not return MZ_OK.
*/
if (sym < 0 || ppmd->error)
break;
*(next_out++) = sym;
++written;
}
// sym contains the return code from Ppmd8_DecodeSymbol
if (sym == PPMD_RESULT_EOF) {
ppmd->end_stream = 1;
// Drop through and return written bytes
} else if (sym == PPMD_RESULT_ERROR) {
/* Insufficient input data. */
return MZ_STREAM_ERROR;
} else if (ppmd->error) {
/* Invalid end of input data */
return ppmd->error;
}
ppmd->total_out += written;
return written;
#endif
}
int32_t mz_stream_ppmd_write(void *stream, const void *buf, int32_t size) {
#ifdef MZ_ZIP_NO_COMPRESSION
MZ_UNUSED(stream);
MZ_UNUSED(buf);
MZ_UNUSED(size);
return MZ_SUPPORT_ERROR;
#else
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)stream;
const uint8_t *buf_ptr = (const uint8_t *)buf;
int32_t bytes_written = 0;
mz_setup_buffered_writer(ppmd);
for (bytes_written = 0; bytes_written < size; bytes_written++) {
if (ppmd->out.pos == ppmd->out.size) {
if (mz_stream_ppmd_flush(ppmd) != MZ_OK)
return MZ_WRITE_ERROR;
}
Ppmd8_EncodeSymbol(&ppmd->ppmd8, buf_ptr[bytes_written]);
}
ppmd->total_in += size;
if (mz_stream_ppmd_flush(stream) != MZ_OK)
return MZ_WRITE_ERROR;
return size;
#endif
}
int64_t mz_stream_ppmd_tell(void *stream) {
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)stream;
return ppmd->total_in;
}
int32_t mz_stream_ppmd_seek(void *stream, int64_t offset, int32_t origin) {
MZ_UNUSED(stream);
MZ_UNUSED(offset);
MZ_UNUSED(origin);
return MZ_SEEK_ERROR;
}
int32_t mz_stream_ppmd_close(void *stream) {
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)stream;
#ifndef MZ_ZIP_NO_COMPRESSION
if (ppmd->mode & MZ_OPEN_MODE_WRITE) {
mz_setup_buffered_writer(ppmd);
/* Encode end marker */
Ppmd8_EncodeSymbol(&ppmd->ppmd8, -1);
Ppmd8_Flush_RangeEnc(&ppmd->ppmd8);
/* Flush any remaining buffered output */
mz_stream_ppmd_flush(stream);
}
#endif
Ppmd8_Free(&ppmd->ppmd8, &ppmd->allocator);
ppmd->initialized = 0;
return MZ_OK;
}
int32_t mz_stream_ppmd_error(void *stream) {
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)stream;
return ppmd->error;
}
int32_t mz_stream_ppmd_get_prop_int64(void *stream, int32_t prop, int64_t *value) {
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)stream;
switch (prop) {
case MZ_STREAM_PROP_TOTAL_IN:
*value = ppmd->total_in;
return MZ_OK;
case MZ_STREAM_PROP_TOTAL_OUT:
*value = ppmd->total_out;
return MZ_OK;
case MZ_STREAM_PROP_TOTAL_IN_MAX:
*value = ppmd->max_total_in;
return MZ_OK;
}
return MZ_PARAM_ERROR;
}
int32_t mz_stream_ppmd_set_prop_int64(void *stream, int32_t prop, int64_t value) {
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)stream;
switch (prop) {
case MZ_STREAM_PROP_TOTAL_IN_MAX:
ppmd->max_total_in = value;
return MZ_OK;
case MZ_STREAM_PROP_COMPRESS_LEVEL:
if (value == MZ_COMPRESS_LEVEL_DEFAULT)
ppmd->preset = PPMD_PRESET_DEFAULT;
else
ppmd->preset = (int16_t)value;
return MZ_OK;
}
return MZ_PARAM_ERROR;
}
void *mz_stream_ppmd_create(void) {
mz_stream_ppmd *ppmd = (mz_stream_ppmd *)calloc(1, sizeof(mz_stream_ppmd));
if (ppmd) {
ppmd->stream.vtbl = &mz_stream_ppmd_vtbl;
ppmd->allocator.Alloc = mz_ppmd_alloc_func;
ppmd->allocator.Free = mz_ppmd_free_func;
ppmd->preset = PPMD_PRESET_DEFAULT;
}
return ppmd;
}
void mz_stream_ppmd_delete(void **stream) {
mz_stream_ppmd *ppmd = NULL;
if (!stream)
return;
ppmd = (mz_stream_ppmd *)*stream;
free(ppmd);
*stream = NULL;
}
void *mz_stream_ppmd_get_interface(void) {
return (void *)&mz_stream_ppmd_vtbl;
}
/***************************************************************************/