decoder.decode(...)

Fas Xmut

Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

decoder.decode(...) is a method of the azvzl::az_decoder class, it is the main methods to decode compressed data.

Calling Sig:

(overload-1)

decoder.decode(
	input__,			// const ptr, unsigned one byte type
	input_size__,		// const size
	prop_size__			// const size
);

The output data, and data size will be stored at the data member of the azvzl::az_decoder object.

Return void

Calling Sig:

(overload-2)

decoder.decode(
	input__,		// const ptr, unsigned one byte type
	input_size__,		// const size
	prop_size__,			// const size
	output__,		// ptr, unsigned one byte type
	output_size__		// non-const Lvalue reference
);

The output data and size will be stored at the parameters output__ and output_size__ .

output__ must be allocated by caller explicitly.

Note:

When entering calling decoder.decode(...), both (overload-1) and (overload-2) will reset internal __output to nullptr, __output_size to zero.
When leaving calling decoder.decode(...),
(overload-1) will store the output data and output data size to internal __output and __output_size;
(overload-2) will store the output data and output data size to its parameters output__ and output_size__, and reset internal __output to nullptr, __output_size to zero again.
Generally speaking, (overload-1) is for lazy case, and it is more efficiant than (overload-2) in memory usage.
(overload-1) is the recommanded overload method.
(overload-1) uses automatically memory allocation and release by using new/delete internally.
Sometimes, the caller's code have to preallocate its own memory, for this case, use (overload-2).

Back

Deck

Azvzl c++ library