"WSQ image library" for Android (version 2.0)
FBI certified WSQ implementation number:
11288 (scanned certificate)

Registered users of version 1.0-1.x please upgrade to version 2.0 free of charge

WSQ image library adds the power of WSQ (FBI's Wavelet Scalar Quantization) file format to your software projects using only a few lines of code.
The source code of WSQ image library contains 20,099,433 lines of code and saves you months of tedious work.
The library also supports 11 other graphic file formats and allows conversion between them.

Click here for Free WSQ Viewer (for Android) which demonstrates capabilities of WSQ image library.

Windows 32-bit version of WSQ image library is available here.
Windows 64-bit version of WSQ image library is available here.
Linux 32-bit version of WSQ image library is available here.
Linux 64-bit version of WSQ image library is available here.
Windows CE/Windows Mobile/Pocket PC version of WSQ image library is available here.
WSQ image library for Texas Instruments family microprocessors (embedded systems) is available here.

Importance of WSQ format

Electronic fingerprints submitted to the FBI either through Integrated Automated Fingerprint Identification System (IAFIS), or Electronic Fingerprint Image Print System (EFIPS) may not be compressed with any technique other than WSQ.

Price of WSQ image library

WSQ image library (for Android) runtime free / royalty free license costs 2526.00 U.S. dollars.

Linux 32-bit, Linux 64-bit, Windows 32-bit, Windows 64-bit, Windows CE/Windows Mobile/Pocket PC, and Android versions of WSQ Image Library are considered separate products and each has its own pricing.
To order WSQ image library please click here

WSQ image library (for Android) specifications

Table 1 Format of WSQ image library

Feature Format
Operating system Android (arm64-v8a/armeabi-v7a/x86/x86_64)
Library format Shared Library (*.so)
Format of exported functions C language
Calling convention
of exported functions
Internal engine C++

Table 2 Supported formats for reading

Format Description
WSQ FBI's Wavelet Scalar Quantization
BMP Windows Bitmap Graphics
TIFF Macintosh Tagged Information File Format images
TIF PC Tagged Information File Format images
JPG, JPEG Joint Photographic Experts Group images
PNG Portable Network Graphics images
GIF Compuserve Graphic Interchange Format images
TGA Truevision Targa Graphic images
PCX ZSoft Paintbrush images (PC Paintbrush Bitmap Graphic)
RGB Silicon Graphics International true color images
PSD Photoshop images
CEL Autodesk images / Animator Graphic (FLC and FLI formats)
IFF Amiga Bitmap Graphic (8 bits)

Table 3 Supported formats for writing

Format Description
WSQ FBI's Wavelet Scalar Quantization
BMP Windows Bitmap Graphics
TIF Tagged Information File Format (no LZW compression)
PNG Portable Network Graphics
JPG Joint Photographic Experts Group
RGB Silicon Graphics International (uncompressed)
TGA Truevision Targa Graphic

Table 4 Functions available in the library

Function Description
int ReadImageFromFile(const char* fileName, int* width, int* height, unsigned char** imageData)Creates an image data array from an image file. The extension of the file name determines the file type. Returns an 1 if successful, 0 otherwise.
int SaveImageToFile(const char* fileName, int filetype, int width, int height, unsigned char* imageData)Saves the contents of an image data array to a file. Returns 1 if successful, 0 otherwise.
"filetype" denotes integer with possible values:
1 - WSQ
2 - Windows BMP
3 - TIFF
4 - PNG
5 - JPEG
6 - Targa
7 - RGB
char* GenerateSerialNumber() Generates serial number for registration of WSQ image library.
int UnlockWSQLibrary(char* authorization_code) Registers WSQ image library on the computer. Returns 1 if successful, 0 otherwise.
void WriteWSQ_bitrate(double bitrate) Sets current WSQ bitrate. For example 0.75, 2.25 (-1.0 if unknown)
double ReadWSQ_bitrate() Reads current WSQ bitrate. For example 0.75, 2.25 (-1.0 if unknown)
void WriteWSQ_ppi(int ppi) Sets current WSQ ppi (pixels per inch). Value "-1" is used for unknown ppi.
int ReadWSQ_ppi() Reads current WSQ ppi (pixels per inch). Value "-1" is used for unknown ppi.
void WriteWSQ_comment(char *comment) Sets current WSQ comment text.
char* ReadWSQ_comment() Reads current WSQ comment text.
void WriteTIFFcompression(int tiff_compression) Sets the TIFF compression type. Available options are:
0 - NONE
1 - ZIP compression
(if ZIP compression is used, you also need to set TIFF "predictor" parameter)
2 - MACINTOSH compression
void WriteTIFFpredictor(int tiff_predictor) Sets the TIFF ZIP compression predictor value.
int WSQ_decode_stream(unsigned char *input_data_stream, const int input_stream_length, unsigned char **output_data_stream, int *width, int *height, int *ppi, unsigned char **comment_text)Decodes memory stream (memory block) from WSQ format into uncompressed format. Returns 1 if successful, or error code otherwise.
int WSQ_encode_stream(unsigned char *input_data_stream, const int width, const int height, const double bitrate, const int ppi, char *comment_text, unsigned char **output_data_stream, int *output_stream_length)Encodes memory stream (memory block) from uncompressed format into WSQ format. Returns 1 if successful, or error code otherwise.

WSQ format description

In the USA, fingerprints have traditionally been collected on cards, each card containing the inked impressions of all ten fingers. The U.S. Federal Bureau of Investigation's fingerprint database began in 1924 with a cataloged collection of 810,188 cards. By the start of World War II, this collection had grown to over 10 million cards, and by 1946 had reached over 100 million cards.

In 1995 this collection was contained on over 200 million cards stored in filing cabinets occupying one acre of floor space in the J. Edgar Hoover building in Washington D.C. and archive size was increasing at the rate of 30,000 to 50,000 new cards per day. Digitization of fingerprint cards seemed to be the most obvious choice and the project named FBI's Integrated Automated Fingerprint Identification System (IAFIS) was started to cope with the design and implementation of a national standard for collecting, encoding, storing, and retrieving digitized fingerprint images. According to the FBI standard fingerprints are stored as 8-bit grayscale images. Each fingerprint card, when digitized at 500 dpi requires about 10 Mbytes of storage. The FBI's entire collection would therefore consume two petabytes (2,000,000,000 megabytes) of electronic storage space.

The need for an effective compression technique was then very urgent. Unfortunately, neither the well-known lossless methods nor the JPEG methods were found to be satisfactory. Most lossy compression methods, such as JPEG, discard the smallest (highest frequency) details in images, and at higher compression ratios unacceptably distort the image. Contained within fingerprints are tiny details that are considered admissible points of identification in a court of law. To JPEG, these details may be regarded as noise and removed. The JPEG quantization matrix also allows blocking artifacts to occur in the image at compression ratios above about 10:1. Shifting bits to the high frequencies to preserve small details will only make the blocking worse. Lossless compression methods, such as LZW and JBIG, cannot achieve the high compression ratios of WSQ on fingerprint data, with 2:1 typically being the best. A new compression technique (with small acceptable loss), called Wavelet Scalar Quantization (WSQ) was developed and it became the FBI standard for the compression of 500 dpi fingerprint images.

WSQ is a lossy compression method that is well-suited for preserving the very high resolution details of grayscale images while maintaining high compression ratios of typically 12:1 to 15:1 on images that have not undergone "quality enhancements" (such as histogram equalization) to improve the appearance of the image.

Table 5 WSQ file format specifications

Feature Description
Name FBI's Wavelet Scalar Quantization file format.
Also known as: FBI Fingerprint Format or FBI WSQ
Application The standard file format used by the FBI for storage and interchange of grayscale fingerprint images
Originator FBI (U.S. Federal Bureau of Investigation)
Type Bitmap
Colors 8 bit grayscale
Compression Wavelet Scalar Quantization
Maximum image size 64K x 64K
Multiple images per file No

Adding WSQ image library to your software project

Using "WSQ image library" is very easy. Only 4 steps and a few lines of code are needed. Several examples are provided below.



Click here for important notes for Java developers

Step 1

Put the file "WSQlib.java" into your project's directory

To download file "WSQlib.java" click here
The file "WSQlib.java" contains declarations of "WSQ image library" functions:

public static native int[] ReadImageFromFile(int[] dimension, String fileName);
public static native void SaveImageToFile(int[] data, int width, int height, String fileName, int type);

Step 2

Add the following line at the beginning of your java program code:
import com.cognaxon.WSQlib;

Step 3

Copy the contents of directory "jniLibs" (full path is "/app/src/main/jniLibs/")
into your project's directory

Step 4

Create new instance of "WSQ image library":
WSQlibrary = new WSQlib();

Step 5

Call and use "WSQ image library" functions:

int[] data = WSQlibrary.ReadImageFromFile(dimension, fileName)
WSQlibrary.SaveImageToFile(pixels, width, height, fileName, type)

where "WSQlibrary" is the class name.

JNI function prototypes using JNIEXPORT wrapper interface are listed in the file

To download Android Studio 3.0.1 sample project click here

To download Android application package file (APK) click here

Table 6 “WSQ image library” sample projects

Program Size   QR-Code of download link
WSQ (FBI's Wavelet Scalar Quantization) sample image file 23 KB Download qrcode
ZIPed WSQ sample image file 23 KB Download qrcode
WSQ image library Shared Library (*.so) Android. Version 2.0 1716 KB Download qrcode
WSQ image library Android Studio 3.2.1 (minSdkVersion API 14 Android 4.0 (Ice Cream Sandwich), targetSdkVersion API 26 Android 8.0 (Oreo), Android NDK 16.1.4479499) sample project 18577 KB Download qrcode
WSQ image library Android (API level 14 Android 4.0 (Ice Cream Sandwich)) application package file (APK) 3554 KB Download qrcode

Copyright © 2020 Cognaxon. All rights reserved. Privacy