xil_cis_get_autorecover(3)

NAME

xil_cis_get_autorecover, xil_cis_set_autorecover − allow autorecovery after a CIS error occurs

SYNOPSIS

#include <xil/xil.h>

Xil_boolean xil_cis_get_autorecover ( XilCis cis);

void xil_cis_set_autorecover (XilCis cis,

Xil_boolean on_off);

DESCRIPTION

This function gives permission to the XIL CIS compression and decompression functions to attempt recovery if an autorecoverable bitstream error occurs.

cis is the compressed image sequence (CIS) that is being compressed or decompressed.

on_off is a boolean value use in xil_cis_set_autorecover(3) to set the autorecover state.

The default value returned by xil_cis_get_autorecover () is FALSE (or OFF), which indicates that autorecovery will not be attempted after a bitstream error occurs unless xil_cis_set_autorecover () is called to turn it ON.

Two types of bitstream errors can occur during decompression of a CIS: autorecoverable and non-autorecoverable. An autorecoverable error is one with a predefined method of recovery. A non-autorecoverable error requires user intervention for recovery. When a non-autorecoverable error is detected, the CIS is marked invalid before the user is notified of the error. If a CIS is marked CIS_READ_INVALID for decompression, no further operations can be performed on this CIS until it has been marked valid again. A bitstream error in CIS compression and decompression can occur in any action on a CIS that requires the CIS to decode the bitstream or change the current read frame.

Calling this routine for codecs that do not have autorecoverable errors (for example, Cell) will have no effect.

After a non-autorecoverable error occurs, the user can revalidate the CIS in one of three ways: by calling xil_cis_reset(3) to remove any compressed data currently stored in the CIS, by calling xil_cis_seek(3) to seek to a valid frame, or by attempting recovery using xil_cis_attempt_recovery(3). If the user attempts to seek to a valid frame and the CIS cannot successfully complete the request, a seek error is generated. See xil_cis_attempt_recovery(3) for further information on CIS error recovery.

ERRORS

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

EXAMPLES

This example turns on auto-recovery:

XilCis cis;
xil_cis_set_autorecover(cis TRUE);

Museum