xil_cis_get_read_invalid(3)

NAME

xil_cis_get_read_invalid − determine whether a CIS is able to be decompressed

SYNOPSIS

#include <xil/xil.h>

Xil_boolean xil_cis_get_read_invalid ( XilCis cis);

DESCRIPTION

This function determines whether a compressed image sequence (CIS) is able to be decompressed. cis is the CIS that is being decompressed. The default value returned by this routine is FALSE, which indicates that the CIS is valid and able to be decompressed. If a bitstream error occurs during decompression, this routine returns TRUE, indicating that the CIS was marked CIS_READ_INVALID.

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.

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.

ERRORS

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

EXAMPLES

Note that xil_cis_get_read_invalid() is not called until after the molecule runs. For information on molecules and deferred execution, consult the XIL Programmer’s Guide.

    XilCis cis;
    XilImage image;
    XilImage displayimage;
    XilLookup lookup;
    while(xil_cis_has_frame(cis)) {
        xil_decompress(cis, image);
        xil_nearest_color(image, displayimage, lookup);
        if (xil_cis_get_read_invalid(cis) == TRUE)
printf(" There is a problem with this CIS.\n");
    }

Museum