Top-level interface

The top-level interface to the XRIF library. More...

The top-level interface to the XRIF library.

The following code illustrates how the XRIF library shoud used to compress data under most circumstances.
Lower level access is provided if fine-grain control is needed.

First, create the xrif library handle:

xrif_error_t rv;
xrif_t handle; //note: this is a pointer type
rv = xrif_new(&handle); //note: the argument is a pointer to pointer
//check rv for errors here . . .

You now have an initialized xrif handle. The xrif_t type can not be used until xrif_new has been called on it. Never call xrif_new twice on the same handle, unless xrif_delete (see below) has been called.

Next you need to configure and allocate the handle:

rv = xrif_set_size(handle, 64,64, 1,1024, XRIF_TYPECODE_INT16); 
rv = xrif_configure(handle, XRIF_DIFFERENCE_PREVIOUS, XRIF_REORDER_BYTEPACK, XRIF_COMPRESS_LZ4); //Note this is optional if defaults are ok.
rv = xrif_allocate(handle);

The above results in an xrif handle prepared to operate on 1024 signed 16-bit images of size 64x64. (Note that you should check the value of rv for errors!)

Now to compress data:

memcpy(xrif->raw_buffer, my_source, handle->width*handle->height*handle->depth*handle->frames*handle->data_size); //You are responsible for `my_source`.
rv = xrif_encode(handle);
printf("%f\%\n", handle->compression_ratio*100.0);

After this handle->raw_buffer contains the compressed data. This is because handle->compress_on_raw == 1 by default, causing the raw_buffer to be re-used. This also illustrates the built in performance monitoring, which is on by default but can be turned off.

To decompress:

rv = xrif_decode(handle);
memcpy(my_dest, xrif->raw_buffer, xrif->width*xrif->height*xrif->depth*xrif->frames*xrif->data_size); //You are responsible for `my_dest`.

after which my_dest will contain the original data.

To start over, use:

rv = xrif_reset(handle);

And when you are done with the handle, it can be fully de-allocated with

rv = xrif_delete(handle);

after which the handle should not be used again, unless xrif_new is called on it.

Collaboration diagram for Top-level interface:

Data Structures
struct	xrif_handle
	The xrif library configuration structure, organizing various parameters used by the functions. More...

Modules
	Initialization, Setup, and Allocation
	Current Configuration
	Header Processing
	Encoding & Decoding
	Performance Measurements

Typedefs
typedef xrif_handle *	xrif_t
	The xrif handle pointer type. This provides the main interface to the xrif library.