core/compress package | Odin Programming Language

A collection of utilities to aid with other `compress`ion packages.

Collection Info

View Source

Collection: core
Path: compress
Entries: 48

Constants 2

Jump to Constants

COMPRESS_OUTPUT_ALLOCATE_MAX COMPRESS_OUTPUT_ALLOCATE_MIN

Types 8

Jump to Types

Context_Memory_Input Context_Stream_Input Deflate_Error Error General_Error GZIP_Error ZIP_Error ZLIB_Error

Procedures 27

Jump to Procedures

consume_bits_lsb_from_memory consume_bits_lsb_from_stream discard_to_next_byte_lsb_from_memory discard_to_next_byte_lsb_from_stream input_size_from_memory input_size_from_stream peek_back_byte peek_bits_lsb_from_memory peek_bits_lsb_from_stream peek_bits_no_refill_lsb_from_memory peek_bits_no_refill_lsb_from_stream peek_data_at_offset_from_memory peek_data_at_offset_from_stream peek_data_from_memory peek_data_from_stream read_bits_lsb_from_memory +11 more

Procedure Groups 11

Jump to Procedure Groups

consume_bits_lsb discard_to_next_byte_lsb input_size peek_bits_lsb peek_bits_no_refill_lsb peek_data read_bits_lsb read_bits_no_refill_lsb read_slice read_u8 refill_lsb

Variables 0

Source Files

common.odin

Constants

COMPRESS_OUTPUT_ALLOCATE_MAX #

Source

COMPRESS_OUTPUT_ALLOCATE_MAX :: int(#config(COMPRESS_OUTPUT_ALLOCATE_MAX, 1 << 32))

For 64-bit platforms, we set the default max buffer size to 4 GiB, which is GZIP and PKZIP's max payload size.

COMPRESS_OUTPUT_ALLOCATE_MIN #

Source

COMPRESS_OUTPUT_ALLOCATE_MIN :: int(#config(COMPRESS_OUTPUT_ALLOCATE_MIN, 1 << 20))

When a decompression routine doesn't stream its output, but writes to a buffer, we pre-allocate an output buffer to speed up decompression. The default is 1 MiB.

Types

Context_Memory_Input #

Source

Context_Memory_Input :: Context_Memory_Input

General I/O context for ZLIB, LZW, etc.

Context_Stream_Input #

Source

Context_Stream_Input :: Context_Stream_Input

Deflate_Error #

Source

Deflate_Error :: Deflate_Error

Error #

Source

Error :: Error

General_Error #

Source

General_Error :: General_Error

GZIP_Error #

Source

GZIP_Error :: GZIP_Error

ZIP_Error #

Source

ZIP_Error :: ZIP_Error

ZLIB_Error #

Source

ZLIB_Error :: ZLIB_Error

Procedures

consume_bits_lsb_from_memory #

Source

@(optimization_mode="favor_size")

consume_bits_lsb_from_memory :: proc(z: ^Context_Memory_Input, width: u8) {…}

consume_bits_lsb_from_stream #

Source

@(optimization_mode="favor_size")

consume_bits_lsb_from_stream :: proc(z: ^Context_Stream_Input, width: u8) {…}

discard_to_next_byte_lsb_from_memory #

Source

@(optimization_mode="favor_size")

discard_to_next_byte_lsb_from_memory :: proc(z: ^Context_Memory_Input) {…}

discard_to_next_byte_lsb_from_stream #

Source

@(optimization_mode="favor_size")

discard_to_next_byte_lsb_from_stream :: proc(z: ^Context_Stream_Input) {…}

input_size_from_memory #

Source

input_size_from_memory :: proc(z: ^Context_Memory_Input) -> (res: i64, err: Error) {…}

input_size_from_stream #

Source

input_size_from_stream :: proc(z: ^Context_Stream_Input) -> (res: i64, err: Error) {…}

peek_back_byte #

Source

@(optimization_mode="favor_size")

peek_back_byte :: proc(z: ^$C, offset: i64) -> (res: u8, err: Error) {…}

Sliding window read back

peek_bits_lsb_from_memory #

Source

@(optimization_mode="favor_size")

peek_bits_lsb_from_memory :: proc(z: ^Context_Memory_Input, width: u8) -> u32 {…}

peek_bits_lsb_from_stream #

Source

@(optimization_mode="favor_size")

peek_bits_lsb_from_stream :: proc(z: ^Context_Stream_Input, width: u8) -> u32 {…}

peek_bits_no_refill_lsb_from_memory #

Source

@(optimization_mode="favor_size")

peek_bits_no_refill_lsb_from_memory :: proc(z: ^Context_Memory_Input, width: u8) -> u32 {…}

peek_bits_no_refill_lsb_from_stream #

Source

@(optimization_mode="favor_size")

peek_bits_no_refill_lsb_from_stream :: proc(z: ^Context_Stream_Input, width: u8) -> u32 {…}

peek_data_at_offset_from_memory #

Source

@(optimization_mode="favor_size")

peek_data_at_offset_from_memory :: proc(z: ^Context_Memory_Input, $T: typeid, #any_int offset: int) -> (res: typeid, err: Error) {…}

peek_data_at_offset_from_stream #

Source

@(optimization_mode="favor_size")

peek_data_at_offset_from_stream :: proc(z: ^Context_Stream_Input, $T: typeid, #any_int offset: int) -> (res: typeid, err: Error) {…}

peek_data_from_memory #

Source

@(optimization_mode="favor_size")

peek_data_from_memory :: proc(z: ^Context_Memory_Input, $T: typeid) -> (res: typeid, err: Error) {…}

peek_data_from_stream #

Source

@(optimization_mode="favor_size")

peek_data_from_stream :: proc(z: ^Context_Stream_Input, $T: typeid) -> (res: typeid, err: Error) {…}

read_bits_lsb_from_memory #

Source

@(optimization_mode="favor_size")

read_bits_lsb_from_memory :: proc(z: ^Context_Memory_Input, width: u8) -> u32 {…}

read_bits_lsb_from_stream #

Source

@(optimization_mode="favor_size")

read_bits_lsb_from_stream :: proc(z: ^Context_Stream_Input, width: u8) -> u32 {…}

read_bits_no_refill_lsb_from_memory #

Source

@(optimization_mode="favor_size")

read_bits_no_refill_lsb_from_memory :: proc(z: ^Context_Memory_Input, width: u8) -> u32 {…}

read_bits_no_refill_lsb_from_stream #

Source

@(optimization_mode="favor_size")

read_bits_no_refill_lsb_from_stream :: proc(z: ^Context_Stream_Input, width: u8) -> u32 {…}

read_data #

Source

@(optimization_mode="favor_size")

read_data :: proc(z: ^$C, $T: typeid) -> (res: typeid, err: Error) {…}

read_slice_from_memory #

Source

@(optimization_mode="favor_size")

read_slice_from_memory :: proc(z: ^Context_Memory_Input, size: int) -> (res: []u8, err: Error) {…}

read_slice_from_stream #

Source

@(optimization_mode="favor_size")

read_slice_from_stream :: proc(z: ^Context_Stream_Input, size: int) -> (res: []u8, err: Error) {…}

read_u8_from_memory #

Source

@(optimization_mode="favor_size")

read_u8_from_memory :: proc(z: ^Context_Memory_Input) -> (res: u8, err: Error) {…}

read_u8_from_stream #

Source

@(optimization_mode="favor_size")

read_u8_from_stream :: proc(z: ^Context_Stream_Input) -> (res: u8, err: Error) {…}

read_u8_prefer_code_buffer_lsb #

Source

@(optimization_mode="favor_size")

read_u8_prefer_code_buffer_lsb :: proc(z: ^$C) -> (res: u8, err: Error) {…}

You would typically only use this at the end of Inflate, to drain bits from the code buffer preferentially.

refill_lsb_from_memory #

Source

@(optimization_mode="favor_size")

refill_lsb_from_memory :: proc(z: ^Context_Memory_Input, width: i8 = i8(48)) {…}

Generalized bit reader LSB

refill_lsb_from_stream #

Source

@(optimization_mode="favor_size")

refill_lsb_from_stream :: proc(z: ^Context_Stream_Input, width: i8 = i8(24)) {…}

Generalized bit reader LSB

Procedure Groups

consume_bits_lsb #

Source

consume_bits_lsb :: proc{
	consume_bits_lsb_from_memory,
	consume_bits_lsb_from_stream,
}

discard_to_next_byte_lsb #

Source

discard_to_next_byte_lsb :: proc{
	discard_to_next_byte_lsb_from_memory,
	discard_to_next_byte_lsb_from_stream,
}

input_size #

Source

input_size :: proc{
	input_size_from_memory,
	input_size_from_stream,
}

peek_bits_lsb #

Source

peek_bits_lsb :: proc{
	peek_bits_lsb_from_memory,
	peek_bits_lsb_from_stream,
}

peek_bits_no_refill_lsb #

Source

peek_bits_no_refill_lsb :: proc{
	peek_bits_no_refill_lsb_from_memory,
	peek_bits_no_refill_lsb_from_stream,
}

peek_data #

Source

peek_data :: proc{
	peek_data_from_memory,
	peek_data_from_stream,
	peek_data_at_offset_from_memory,
	peek_data_at_offset_from_stream,
}

read_bits_lsb #

Source

read_bits_lsb :: proc{
	read_bits_lsb_from_memory,
	read_bits_lsb_from_stream,
}

read_bits_no_refill_lsb #

Source

read_bits_no_refill_lsb :: proc{
	read_bits_no_refill_lsb_from_memory,
	read_bits_no_refill_lsb_from_stream,
}

read_slice #

Source

read_slice :: proc{
	read_slice_from_memory,
	read_slice_from_stream,
}

read_u8 #

Source

read_u8 :: proc{
	read_u8_from_memory,
	read_u8_from_stream,
}

refill_lsb #

Source

refill_lsb :: proc{
	refill_lsb_from_memory,
	refill_lsb_from_stream,
}