core/compress/zlib package | Odin Programming Language

`Deflate` decompression of raw and `ZLIB`-type streams. Example: package main import "core:bytes" import "core:compress/zlib" import "core:fmt" main :: proc() { ODIN_DEMO := []u8{ 120, 218, 101, 144, 65, 110, 131, 48, 16, 69, 215, 246, 41, 190, 44, 69, 73, 32, 148, 182, 75, 75, 28, 32, 251, 46, 217, 88, 238, 0, 86, 192, 32, 219, 36, 170, 170, 172, 122, 137, 238, 122, 197, 30, 161, 70, 162, 20, 81, 203, 139, 25, 191, 255, 191, 60, 51, 40, 125, 81, 53, 33, 144, 15, 156, 155, 110, 232, 93, 128, 208, 189, 35, 89, 117, 65, 112, 222, 41, 99, 33, 37, 6, 215, 235, 195, 17, 239, 156, 197, 170, 118, 170, 131, 44, 32, 82, 164, 72, 240, 253, 245, 249, 129, 12, 185, 224, 76, 105, 61, 118, 99, 171, 66, 239, 38, 193, 35, 103, 85, 172, 66, 127, 33, 139, 24, 244, 235, 141, 49, 204, 223, 76, 208, 205, 204, 166, 7, 173, 60, 97, 159, 238, 37, 214, 41, 105, 129, 167, 5, 102, 27, 152, 173, 97, 178, 129, 73, 129, 231, 5, 230, 27, 152, 175, 225, 52, 192, 127, 243, 170, 157, 149, 18, 121, 142, 115, 109, 227, 122, 64, 87, 114, 111, 161, 49, 182, 6, 181, 158, 162, 226, 206, 167, 27, 215, 246, 48, 56, 99, 67, 117, 16, 47, 13, 45, 35, 151, 98, 231, 75, 1, 173, 90, 61, 101, 146, 71, 136, 244, 170, 218, 145, 176, 123, 45, 173, 56, 113, 134, 191, 51, 219, 78, 235, 95, 28, 249, 253, 7, 159, 150, 133, 125, } OUTPUT_SIZE :: 432 buf: bytes.Buffer // We can pass ", true" to inflate a raw DEFLATE stream instead of a ZLIB wrapped one. err := zlib.inflate(input=ODIN_DEMO, buf=&buf, expected_output_size=OUTPUT_SIZE) defer bytes.buffer_destroy(&buf) if err != nil { fmt.printf("\nError: %v\n", err) } s := bytes.buffer_to_string(&buf) fmt.printf("Input: %v bytes, output (%v bytes):\n%v\n", len(ODIN_DEMO), len(s), s) assert(len(s) == OUTPUT_SIZE) }

Collection Info

Collection: core
Path: compress/zlib
Entries: 39

Constants 9

Jump to Constants

DEFLATE_MAX_CHUNK_SIZE DEFLATE_MAX_DISTANCE DEFLATE_MAX_LENGTH DEFLATE_MAX_LITERAL_SIZE HUFFMAN_FAST_BITS HUFFMAN_FAST_MASK HUFFMAN_MAX_BITS ZFAST_BITS ZFAST_MASK

Types 8

Compression_Level Compression_Method Deflate_Error Error General_Error Huffman_Table Options ZLIB_Error

Procedures 14

Jump to Procedures

allocate_huffman_table build_huffman decode_huffman decode_huffman_slowpath grow_buffer inflate_from_byte_array inflate_from_byte_array_raw inflate_from_context inflate_raw parse_huffman_block repl_byte repl_bytes write_byte z_bit_reverse

Procedure Groups 1

Jump to Procedure Groups

Variables 7

Jump to Variables

Z_DIST_BASE Z_DIST_EXTRA Z_FIXED_DIST Z_FIXED_LENGTH Z_LENGTH_BASE Z_LENGTH_DEZIGZAG Z_LENGTH_EXTRA

Source Files

Constants

9

DEFLATE_MAX_CHUNK_SIZE #

DEFLATE_MAX_CHUNK_SIZE :: 65535

DEFLATE_MAX_DISTANCE #

DEFLATE_MAX_DISTANCE :: 32768

DEFLATE_MAX_LENGTH #

DEFLATE_MAX_LENGTH :: 258

DEFLATE_MAX_LITERAL_SIZE #

DEFLATE_MAX_LITERAL_SIZE :: 65535

HUFFMAN_FAST_BITS #

HUFFMAN_FAST_BITS :: 9

HUFFMAN_FAST_MASK #

HUFFMAN_FAST_MASK :: (1 << HUFFMAN_FAST_BITS) - 1

HUFFMAN_MAX_BITS #

HUFFMAN_MAX_BITS :: 16

ZFAST_BITS #

ZFAST_BITS :: 9

Accelerate all cases in default tables.

ZFAST_MASK #

ZFAST_MASK :: (1 << ZFAST_BITS) - 1

Types

8

Compression_Level #

Compression_Level :: Compression_Level

Compression_Method #

Compression_Method :: Compression_Method

Deflate_Error #

Deflate_Error :: Deflate_Error

Error #

Error :: Error

General_Error #

General_Error :: General_Error

Huffman_Table #

Huffman_Table :: Huffman_Table

ZLIB-style Huffman encoding. JPEG packs from left, ZLIB from right. We can't share code.

Options #

Options :: Options

ZLIB_Error #

ZLIB_Error :: ZLIB_Error

Procedures

14

allocate_huffman_table #

allocate_huffman_table :: proc(allocator := context.allocator) -> (z: ^Huffman_Table, err: Error) {…}

build_huffman #

@(optimization_mode="favor_size")

build_huffman :: proc(z: ^Huffman_Table, code_lengths: []u8) -> (err: Error) {…}

decode_huffman #

@(optimization_mode="favor_size")

decode_huffman :: proc(z: ^$C, t: ^Huffman_Table) -> (r: u16, err: Error) {…}

decode_huffman_slowpath #

@(optimization_mode="favor_size")

decode_huffman_slowpath :: proc(z: ^$C, t: ^Huffman_Table) -> (r: u16, err: Error) {…}

grow_buffer #

@(optimization_mode="favor_size")

grow_buffer :: proc(buf: ^[dynamic]u8) -> (err: Error) {…}

inflate_from_byte_array #

inflate_from_byte_array :: proc(input: []u8, buf: ^Buffer, raw: bool = false, expected_output_size: int = -1) -> (err: Error) {…}

inflate_from_byte_array_raw #

inflate_from_byte_array_raw :: proc(input: []u8, buf: ^Buffer, raw: bool = false, expected_output_size: int = -1) -> (err: Error) {…}

inflate_from_context #

@(optimization_mode="favor_size")

inflate_from_context :: proc(using ctx: ^Context_Memory_Input, raw: bool = false, expected_output_size: int = -1, allocator := context.allocator) -> (err: Error) {…}

inflate_raw #

@(optimization_mode="favor_size")

inflate_raw :: proc(z: ^$C, expected_output_size: int = -1, allocator := context.allocator) -> (err: Error) {…}

parse_huffman_block #

@(optimization_mode="favor_size")

parse_huffman_block :: proc(z: ^$C, z_repeat, z_offset: ^Huffman_Table) -> (err: Error) {…}

repl_byte #

@(optimization_mode="favor_size")

repl_byte :: proc(z: ^$C, count: u16, c: u8) -> (err: Error) {…}

repl_bytes #

@(optimization_mode="favor_size")

repl_bytes :: proc(z: ^$C, count: u16, distance: u16) -> (err: Error) {…}

write_byte #

@(optimization_mode="favor_size")

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

z_bit_reverse #

@(optimization_mode="favor_size")

z_bit_reverse :: proc(n: u16, bits: u8) -> (r: u16) {…}

Implementation starts here

Procedure Groups

1

inflate #

inflate :: proc{
	inflate_from_context,
	inflate_from_byte_array,
}

Variables

7

Z_DIST_BASE #

Z_DIST_BASE: [32]u16 = [32]u16{1, 2, 3, 4, 5, 7, 9, 13, 17, 25, 33, 49, 65, 97, 129, 193, 257, 385, 513, 769, 1025, 1537, 2049, 3073, 4097, 6145, 8193, 12289, 16385, 24577, 0, 0}

Z_DIST_EXTRA #

Z_DIST_EXTRA: [32]u8 = [32]u8{0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9, 10, 10, 11, 11, 12, 12, 13, 13, 0, 0}

Z_FIXED_DIST #

Z_FIXED_DIST: [32]u8 = [32]u8{5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5}

Z_FIXED_LENGTH #

Z_FIXED_LENGTH: [288]u8 = [288]u8{8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 8, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 7, 8, 8, 8, 8, 8, 8, 8, 8}

Z_LENGTH_BASE #

Z_LENGTH_BASE: [31]u16 = [31]u16{3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 17, 19, 23, 27, 31, 35, 43, 51, 59, 67, 83, 99, 115, 131, 163, 195, 227, 258, 0, 0}

Z_LENGTH_DEZIGZAG #

Z_LENGTH_DEZIGZAG: []u8 = []u8{16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15}

Z_LENGTH_EXTRA #

Z_LENGTH_EXTRA: [31]u8 = [31]u8{0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5, 0, 0, 0}