stbhuffman.h File Reference

STB midware Huffman decompression routines defined by the BBC. More...

#include "techtype.h"

Go to the source code of this file.

Functions
U16BIT	STB_HuffmanDecompress (U8BIT encoding_type, U8BIT *input, U8BIT *output, U16BIT output_size)
	Decompresses the input buffer according to the BBC's Huffman algorithm as defined in the DTG D-Book 6.1 and using the licensed tables provided by the BBC that relate to the algorithm. More...

Detailed Description

STB midware Huffman decompression routines defined by the BBC.

Date

17 February 2010

Author

Steve Ford

Function Documentation

U16BIT STB_HuffmanDecompress	(	U8BIT	encoding_type,
		U8BIT *	input,
		U8BIT *	output,
		U16BIT	output_size
	)

Decompresses the input buffer according to the BBC's Huffman algorithm as defined in the DTG D-Book 6.1 and using the licensed tables provided by the BBC that relate to the algorithm.

---

Parameters

encoding_type	- Defines which table should be used
input	- start of buffer containing the encoded data
output	- allocated buffer into which the decoded data will be placed
output_size	- size of the supplied output buffer

Returns

Number of bytes decompressed into the output buffer, 0 when the decompression failes.