sensel_decompress.h

Includes:

Introduction


Functions

senselDecompressFrame
senselDecompressionTriggerDetailChange
senselFreeDecompressionHandle
senselInitDecompressionHandle

senselDecompressFrame


SENSEL_API SenselStatus WINAPI senselDecompressFrame(
    SENSEL_HANDLE handle,
    unsigned char frame_data,
    int data_size, 
    unsigned char content_mask,
    SenselFrameData data,
    unsigned int *decompress_bytes_read);  
Parameters
handle

Sensel device handle

frame_data

Raw protocol payload to process

data_size

Size of the payload

content_mask

Content mask as reported for this frame

data

Frame data to store the decompression result

decompress_bytes_read

Will hold the number of bytes read from the payload

Return Value

SENSEL_OK on success or error

Discussion

Decompresses the payload pointed to by frame_data and fills the FrameData structure accordingly.


senselDecompressionTriggerDetailChange


SENSEL_API SenselStatus WINAPI senselDecompressionTriggerDetailChange(
    SENSEL_HANDLE handle,
    unsigned char *data);  
Parameters
handle

Sensel device handle

data

Metadata in raw form

Return Value

SENSEL_OK on success or error

Discussion

Notifies the decompression engine that a scan detail change was requested


senselFreeDecompressionHandle


Parameters
handle

Sensel device handle from which to free the decompression handle

Return Value

SENSEL_OK on success or error

Discussion

Frees the decompression handle from the provided device handle


senselInitDecompressionHandle


SENSEL_API SenselStatus WINAPI senselInitDecompressionHandle(
    SENSEL_HANDLE handle,
    unsigned char *data);  
Parameters
handle

Sensel device handle where to allocate decompression handle

Return Value

SENSEL_OK on success or error

Discussion

Allocates a decompression handle inside the device handle