Examples
[Image handling]

Table of contents:

pr_capture_simple - Simple Capture example

Show how to capture image.

The needed gxsdldr.cpp loader file is included directly:

#include "prapi.h"
#include "gxsdldr.cpp"

The __lib__.h file contains some library functions used only in the sample programs, such as the FunctionStart and FunctionEnd functions that implement the simple command line interface and measures the elapsed time between the two function calls.

#include "../__lib__.h"
Lib lib;

The main function:

#ifdef GX_NAMESPACES
using namespace gx;
using namespace pr;
#endif

int main() {

    try {

Opening the Passport Reader system:

Note:: When the pr variable of the PasspportReader class is instantiated, the Passport Reader system is opened automaticaly:

        /* Opening the PR system */
        lib.FunctionStart("Opening system files");
        PassportReader pr;  /* Object for the PR system */
        lib.FunctionEnd();

Checking if the Passport Reader modules were opened:

        /* Validity check */
        if (!pr.IsValid()) {
            lib.Error("Failed to initialize!");
            return 0;
        }

Connecting to the first device. If no device is connected then the UseDevice() function throws an exception:

        /* Connecting to the first device */
        lib.FunctionStart("Connecting to the first device");
        pr.UseDevice(0,PR_UMODE_FULL_CONTROL);
        lib.FunctionEnd();

The main loop begins:

        while (!lib.KbHit()) {

            lib.ProcessStart("Processing document");

Capturing images:

            /* Capturing images */
            lib.FunctionStart("Capturing images");
            pr.Capture();
            lib.FunctionEnd();

Saving the white image:

            /* Saving to file */
            lib.FunctionStart("Saving image");
            pr.SaveImage(0,PR_LIGHT_WHITE,PR_IT_ORIGINAL,"white.bmp",GX_BMP);
            lib.FunctionEnd();

The main loop ends:

            lib.ProcessEnd();
            lib.WaitForSec(3);
        }

Closing the device:

        /* Closing the device */
        lib.FunctionStart("Closing the device");
        pr.CloseDevice();
        lib.FunctionEnd();

Exception handling section, catching the exception and displaying the error code and error message:

    } catch (gxException e) {
        lib.DisplExcp(e);
    }

The sample program ends printing some statistic information:

    return lib.PrintStat();
}

The complete source code:

#include "prapi.h"
#include "gxsdldr.cpp"

#include "../__lib__.h"
Lib lib;

#ifdef GX_NAMESPACES
using namespace gx;
using namespace pr;
#endif

int main() {

    try {
        /* Opening the PR system */
        lib.FunctionStart("Opening system files");
        PassportReader pr;  /* Object for the PR system */
        lib.FunctionEnd();

        /* Validity check */
        if (!pr.IsValid()) {
            lib.Error("Failed to initialize!");
            return 0;
        }

        /* Connecting to the first device */
        lib.FunctionStart("Connecting to the first device");
        pr.UseDevice(0,PR_UMODE_FULL_CONTROL);
        lib.FunctionEnd();
        while (!lib.KbHit()) {

            lib.ProcessStart("Processing document");
            /* Capturing images */
            lib.FunctionStart("Capturing images");
            pr.Capture();
            lib.FunctionEnd();

            /* Saving to file */
            lib.FunctionStart("Saving image");
            pr.SaveImage(0,PR_LIGHT_WHITE,PR_IT_ORIGINAL,"white.bmp",GX_BMP);
            lib.FunctionEnd();

            lib.ProcessEnd();
            lib.WaitForSec(3);
        }

        /* Closing the device */
        lib.FunctionStart("Closing the device");
        pr.CloseDevice();
        lib.FunctionEnd();

    } catch (gxException e) {
        lib.DisplExcp(e);
    }

    return lib.PrintStat();
}

pr_capture_adv - Advanced Capture example

Show how to capture image using advanced features

The needed gxsdldr.cpp loader file is included directly:

#include "prapi.h"
#include "gxsdldr.cpp"

#include "../__lib__.h"
Lib lib;

The callback event function. When an event signals, its name is displayed:

#ifdef GX_NAMESPACES
using namespace gx;
using namespace pr;
#endif

void GXAPI evfunc(int event, int param1, int param2, void *uparam)
{
    switch (event) {
        case PR_EV_UVLEDWARMING:
            lib.WriteLine("<Event> UV tube warming started");
            break;
        case PR_EV_PAGECAPTURED:
            lib.WriteLine("<Event> Page captured: page = " + lib.itos(param1) + ", error_code = " + lib.itos(param2));
            break;
        case PR_EV_IMAGECAPTURED:
            lib.WriteLine("<Event> Image captured: page = " + lib.itos(param1) + ", light = " + lib.itos(param2));
            break;
        case PR_EV_CAPTURESTARTED:
            lib.WriteLine("<Event> Capture started: page = " + lib.itos(param1));
            break;
        case PR_EV_NOIMAGEINFO:
            lib.WriteLine("<Event> No image info: page = " + lib.itos(param1) + ", light = " + lib.itos(param2));
            break;
        case PR_EV_DOCFRAMEFOUND:
            lib.WriteLine("<Event> Document frame found: page = " + lib.itos(param1));
            break;
        default:
            lib.WriteLine("<Event> General event(" + lib.itos(event) + "): p1 = " + lib.itos(param1) + ", p2 = " + lib.itos(param2));
            break;
    }
}

The main function:

int main() {
    try {

Opening the Passport Reader system:

Note:: When the pr variable of the PasspportReader class is instantiated, the Passport Reader system is opened automaticaly:

        /* Opening the PR system */
        lib.FunctionStart("Opening system files");
        PassportReader pr;  /* Object for the PR system */
        lib.FunctionEnd();

Checking if the Passport Reader modules were opened:

        /* Validity check */
        if (!pr.IsValid()) {
            lib.Error("Failed to initialize!");
            return 0;
        }

Get the device list. If no device is found, the program ends.

        /* Getting the device list */
        lib.FunctionStart("Getting device list");
        vector<string> devlist = pr.GetDeviceListA();
        lib.FunctionEnd();

        if (!devlist.size()) {
            lib.WriteLine("No device found!");
            return 0;
        } else {
            lib.WriteLine(lib.itos(devlist.size()) + " device(s) found!");
        }

Connecting to the first device. If no device is connected then the UseDevice() function throws an exception:

        /* Connecting to the first device */
        lib.FunctionStart("Connecting to the first device " + devlist[0]);
        pr.UseDevice(devlist[0], PR_UMODE_FULL_CONTROL);
        lib.FunctionEnd();

Warming UV tubes:

        /* Warming UV tubes */
        try {
            lib.FunctionStart("Warming UV tubes");
            pr.SetProperty("freerun_mode", PR_FRMODE_UVLEDWARMING);
            lib.FunctionEnd();
        } catch (gxException e) {
            lib.DisplExcp(e);
        }

Setting all the lights for the first page:

        /* Setting all the lights for the first page */
        try {
            lib.FunctionStart("Setting lights");
            vector<int> pages;
            pages.push_back(0xFF);
            pr.SetPageLight(pages);
            lib.FunctionEnd();
        } catch (gxException e) {
            lib.DisplExcp(e);
        }

Setting the event callback function:

        /* Setting event function */
        try {
            lib.FunctionStart("Setting event function");
            pr.SetProperty("event_types", PR_ET_LED | PR_ET_CAPTURE);
            pr.SetEventFunction(evfunc, NULL);
            lib.FunctionEnd();
        } catch (gxException e) {
            lib.DisplExcp(e);
        }