heatshrink_encoder.h File Reference

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

Include dependency graph for heatshrink_encoder.h:

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

Go to the source code of this file.

Classes
struct	hs_index
struct	heatshrink_encoder

Macros
#define	HEATSHRINK_ENCODER_WINDOW_BITS(HSE)
#define	HEATSHRINK_ENCODER_LOOKAHEAD_BITS(HSE)
#define	HEATSHRINK_ENCODER_INDEX(HSE)

Enumerations
enum	HSE_sink_res { HSER_SINK_OK , HSER_SINK_ERROR_NULL =-1 , HSER_SINK_ERROR_MISUSE =-2 }
enum	HSE_poll_res { HSER_POLL_EMPTY , HSER_POLL_MORE , HSER_POLL_ERROR_NULL =-1 , HSER_POLL_ERROR_MISUSE =-2 }
enum	HSE_finish_res { HSER_FINISH_DONE , HSER_FINISH_MORE , HSER_FINISH_ERROR_NULL =-1 }

Functions
heatshrink_encoder *	heatshrink_encoder_alloc (uint8_t window_sz2, uint8_t lookahead_sz2)
void	heatshrink_encoder_free (heatshrink_encoder *hse)
void	heatshrink_encoder_reset (heatshrink_encoder *hse)
HSE_sink_res	heatshrink_encoder_sink (heatshrink_encoder *hse, uint8_t *in_buf, size_t size, size_t *input_size)
HSE_poll_res	heatshrink_encoder_poll (heatshrink_encoder *hse, uint8_t *out_buf, size_t out_buf_size, size_t *output_size)
HSE_finish_res	heatshrink_encoder_finish (heatshrink_encoder *hse)

Macro Definition Documentation

HEATSHRINK_ENCODER_INDEX

#define HEATSHRINK_ENCODER_INDEX

(

HSE

)

Value:

((HSE)->search_index)

HEATSHRINK_ENCODER_LOOKAHEAD_BITS

#define HEATSHRINK_ENCODER_LOOKAHEAD_BITS

(

HSE

)

Value:

((HSE)->lookahead_sz2)

HEATSHRINK_ENCODER_WINDOW_BITS

#define HEATSHRINK_ENCODER_WINDOW_BITS

(

HSE

)

Value:

((HSE)->window_sz2)

Enumeration Type Documentation

HSE_finish_res

enum HSE_finish_res

Enumerator
HSER_FINISH_DONE
HSER_FINISH_MORE
HSER_FINISH_ERROR_NULL

HSE_poll_res

enum HSE_poll_res

Enumerator
HSER_POLL_EMPTY
HSER_POLL_MORE
HSER_POLL_ERROR_NULL
HSER_POLL_ERROR_MISUSE

HSE_sink_res

enum HSE_sink_res

Enumerator
HSER_SINK_OK
HSER_SINK_ERROR_NULL
HSER_SINK_ERROR_MISUSE

Function Documentation

heatshrink_encoder_alloc()

heatshrink_encoder * heatshrink_encoder_alloc	(	uint8_t	window_sz2,
		uint8_t	lookahead_sz2 )

Here is the caller graph for this function:

heatshrink_encoder_finish()

HSE_finish_res heatshrink_encoder_finish

(

heatshrink_encoder *

hse

)

Here is the caller graph for this function:

heatshrink_encoder_free()

void heatshrink_encoder_free

(

heatshrink_encoder *

hse

)

Here is the caller graph for this function:

heatshrink_encoder_poll()

HSE_poll_res heatshrink_encoder_poll	(	heatshrink_encoder *	hse,
		uint8_t *	out_buf,
		size_t	out_buf_size,
		size_t *	output_size )

Here is the call graph for this function:

Here is the caller graph for this function:

heatshrink_encoder_reset()

void heatshrink_encoder_reset

(

heatshrink_encoder *

hse

)

Here is the call graph for this function:

heatshrink_encoder_sink()

HSE_sink_res heatshrink_encoder_sink	(	heatshrink_encoder *	hse,
		uint8_t *	in_buf,
		size_t	size,
		size_t *	input_size )

Here is the call graph for this function:

Here is the caller graph for this function: