lzw.h

Go to the documentation of this file.

/*
 * This file is part of NetSurf's LibNSGIF, http://www.netsurf-browser.org/
 * Licensed under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 *
 * Copyright 2017 Michael Drake <michael.drake@codethink.co.uk>
 * Copyright 2021 Michael Drake <tlsa@netsurf-browser.org>
 */
 
#ifndef LZW_H_
#define LZW_H_
 
#define LZW_CODE_MAX 12
 
/* Declare lzw internal context structure */
struct lzw_ctx;
 
typedef enum lzw_result {
    LZW_OK,        
    LZW_OK_EOD,    
    LZW_NO_MEM,    
    LZW_NO_DATA,   
    LZW_EOI_CODE,  
    LZW_NO_COLOUR, 
    LZW_BAD_ICODE, 
    LZW_BAD_PARAM, 
    LZW_BAD_CODE,  
} lzw_result;
 
lzw_result lzw_context_create(
        struct lzw_ctx **ctx);
 
void lzw_context_destroy(
        struct lzw_ctx *ctx);
 
lzw_result lzw_decode_init(
        struct lzw_ctx *ctx,
        uint8_t minimum_code_size,
        const uint8_t *input_data,
        size_t input_length,
        size_t input_pos);
 
lzw_result lzw_decode(struct lzw_ctx *ctx,
        const uint8_t *restrict *const restrict output_data,
        uint32_t *restrict                      output_written);
 
lzw_result lzw_decode_init_map(
        struct lzw_ctx *ctx,
        uint8_t minimum_code_size,
        uint32_t transparency_idx,
        const uint32_t *colour_table,
        const uint8_t *input_data,
        size_t input_length,
        size_t input_pos);
 
lzw_result lzw_decode_map(struct lzw_ctx *ctx,
        uint32_t *restrict output_data,
        uint32_t           output_length,
        uint32_t *restrict output_written);
 
#endif