xil_cis_create(3)

NAME

xil_cis_create − create a new compressed image sequence

SYNOPSIS

#include <xil/xil.h>

XilCis xil_cis_create ( XilSystemState system_state,

char ∗compressorname);

DESCRIPTION

This function creates a new compressed image sequence (CIS). A CIS is a container that holds compressed images. On creation, it is associated with a particular type of compressor and will then hold only frames of that type.

system_state is a handle to the object returned by xil_open(3) when it is invoked.

compressorname is a string that provides the name of a compressor recognized by the XIL library. XIL currently supports the following set of compression types.

"Jpeg"
"JpegLL"
"Cell"
"CellB"
"faxG3"
"faxG4"
"Mpeg1"
"H261"

Consult the man page of the same name for details about the individual compression types.

If this function is successful, then a handle to an XilCis object is returned, which may be used in subsequent calls to xil_cis-routines. When the XilCis object is no longer needed, release the resources associated with the CIS by passing its handle to xil_cis_destroy(3).

ERRORS

If the xil_cis_create() call fails, a value of NULL is returned. For a complete list of XIL error messages by number, consult Appendix B of the XIL Programmer’s Guide.

EXAMPLES

Open and close a JPEG CIS using the XIL library:

XilSystemState State;
XilCis cis;
State = xil_open();
cis = xil_cis_create(State, "Jpeg");
-- calls to JPEG-specific compression routines --
xil_cis_destroy(cis);
xil_close(State);

Museum