NAME

xil_decompress − decompress an image from a compressed image sequence

SYNOPSIS

#include <xil/xil.h>

void xil_decompress ( XilCis cis,

XilImage dst);

DESCRIPTION

This function decompresses the current read frame in a compressed image sequence (CIS) and puts its output into an image object.  It also increments the CIS’s current read frame.  cis is the input compressed image sequence.  dst is the output XilImage.  If the function is successful, an image from the CIS will be decompressed into the destination. 

The XIL library supports a number of compression formats, including CCITT G3/G4, JPEG, MPEG-1, H.261, Cell, and CellB. 

ROI Behavior

A region of interest (ROI) is associated with each image.  The default ROI encompasses the entire image.  As a destination attribute, the ROI functions as a "write mask" for the destination image.  Consult xil_compress(3) for more information. 

ERRORS

For a complete list of XIL error messages by number, consult Appendix B of the XIL Programmer’s Guide. 

EXAMPLES

Decompress the current read frame of a compressed image sequence:

XilCis cis;
XilImage dst;
XilImageType type;
XilSystemState State;
type = xil_cis_get_output_type(cis);
dst = xil_create_from_type(State, type);
while (xil_cis_has_frame(cis))
   xil_decompress(cis, dst);

NOTES

The data type and number of bands of the destination image must match the attributes of the images that are stored in compressed image sequence.  Use xil_cis_get_output_type(3) to get a CIS’s image type. 

SEE ALSO

xil_compress(3), xil_cis_has_frame(3), xil_cis_put_bits(3), xil_cis_put_bits_ptr(3), xil_cis_get_output_type(3). 

SunOS   —  Last change: 09 June 1993