heatshrink_decoder.h File Reference

#include <stdint.h>
#include <stddef.h>
#include "heatshrink_common.h"
#include "heatshrink_config.h"

Include dependency graph for heatshrink_decoder.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	heatshrink_decoder

Macros
#define	HEATSHRINK_DECODER_INPUT_BUFFER_SIZE(BUF)
#define	HEATSHRINK_DECODER_WINDOW_BITS(BUF)
#define	HEATSHRINK_DECODER_LOOKAHEAD_BITS(BUF)

Enumerations
enum	HSD_sink_res { HSDR_SINK_OK , HSDR_SINK_FULL , HSDR_SINK_ERROR_NULL =-1 }
enum	HSD_poll_res { HSDR_POLL_EMPTY , HSDR_POLL_MORE , HSDR_POLL_ERROR_NULL =-1 , HSDR_POLL_ERROR_UNKNOWN =-2 }
enum	HSD_finish_res { HSDR_FINISH_DONE , HSDR_FINISH_MORE , HSDR_FINISH_ERROR_NULL =-1 }

Functions
heatshrink_decoder *	heatshrink_decoder_alloc (uint16_t input_buffer_size, uint8_t expansion_buffer_sz2, uint8_t lookahead_sz2)
void	heatshrink_decoder_free (heatshrink_decoder *hsd)
void	heatshrink_decoder_reset (heatshrink_decoder *hsd)
HSD_sink_res	heatshrink_decoder_sink (heatshrink_decoder *hsd, uint8_t *in_buf, size_t size, size_t *input_size)
HSD_poll_res	heatshrink_decoder_poll (heatshrink_decoder *hsd, uint8_t *out_buf, size_t out_buf_size, size_t *output_size)
HSD_finish_res	heatshrink_decoder_finish (heatshrink_decoder *hsd)

Macro Definition Documentation

HEATSHRINK_DECODER_INPUT_BUFFER_SIZE

#define HEATSHRINK_DECODER_INPUT_BUFFER_SIZE

(

BUF

)

Value:

((BUF)->input_buffer_size)

HEATSHRINK_DECODER_LOOKAHEAD_BITS

#define HEATSHRINK_DECODER_LOOKAHEAD_BITS

(

BUF

)

Value:

((BUF)->lookahead_sz2)

HEATSHRINK_DECODER_WINDOW_BITS

#define HEATSHRINK_DECODER_WINDOW_BITS

(

BUF

)

Value:

((BUF)->window_sz2)

Enumeration Type Documentation

HSD_finish_res

enum HSD_finish_res

Enumerator
HSDR_FINISH_DONE
HSDR_FINISH_MORE
HSDR_FINISH_ERROR_NULL

HSD_poll_res

enum HSD_poll_res

Enumerator
HSDR_POLL_EMPTY
HSDR_POLL_MORE
HSDR_POLL_ERROR_NULL
HSDR_POLL_ERROR_UNKNOWN

HSD_sink_res

enum HSD_sink_res

Enumerator
HSDR_SINK_OK
HSDR_SINK_FULL
HSDR_SINK_ERROR_NULL

Function Documentation

heatshrink_decoder_alloc()

heatshrink_decoder * heatshrink_decoder_alloc	(	uint16_t	input_buffer_size,
		uint8_t	expansion_buffer_sz2,
		uint8_t	lookahead_sz2 )

Here is the call graph for this function:

heatshrink_decoder_finish()

HSD_finish_res heatshrink_decoder_finish

(

heatshrink_decoder *

hsd

)

heatshrink_decoder_free()

void heatshrink_decoder_free

(

heatshrink_decoder *

hsd

)

heatshrink_decoder_poll()

HSD_poll_res heatshrink_decoder_poll	(	heatshrink_decoder *	hsd,
		uint8_t *	out_buf,
		size_t	out_buf_size,
		size_t *	output_size )

Here is the call graph for this function:

heatshrink_decoder_reset()

void heatshrink_decoder_reset

(

heatshrink_decoder *

hsd

)

Here is the caller graph for this function:

heatshrink_decoder_sink()

HSD_sink_res heatshrink_decoder_sink	(	heatshrink_decoder *	hsd,
		uint8_t *	in_buf,
		size_t	size,
		size_t *	input_size )