common.h

/*****************************************************************************
    common.h - the common header file
 
*******************************************************************************/
 
#ifndef COMMON_H__
#define COMMON_H__
 
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
 
#include "win2lin.h"    
#include "ansi_nist_itl_1.h"
 
// packing defines
#define _CORE_TIGHT      1
#define _CORE_PACKING    8
 
#define _DBG_INFO
#define _DBG_INFO_1
#define _DBG_INFO_2
 
#define MAX_MINUTIAE           255
 
#ifdef __cplusplus
   extern "C"{
#endif
/******************************************************************
          THE CONSTANRS
******************************************************************/
ENUM_DECLARATION MATCH_SPEED
{
   LOWEST_MATCH_SPEED      = 0,
   LOW_MATCH_SPEED         = 1,
   REDUCED_MATCH_SPEED     = 2,
   NORMAL_MATCH_SPEED      = 3,
   INCREASED_MATCH_SPEED   = 4,
   HIGH_MATCH_SPEED        = 5,
   HIGHEST_MATCH_SPEED     = 6,
};
 
ENUM_DECLARATION NIST_QUALITY
{
   QUAL_POOR      =  20,    
   QUAL_FAIR      =  40,    
   QUAL_GOOD      =  60,    
   QUAL_VGOOD     =  80,    
   QUAL_EXCELLENT = 100     
};
 
ENUM_DECLARATION IMAGE_TYPE
{
    UNDEFINED_IMAGE = 0,
    WSQ_IMAGE = 1,
    BMP_IMAGE = 2,
    J2K_IMAGE = 3,
    JPEG_IMAGE = 4,
    PNG_IMAGE = 5,
    TIFF_IMAGE = 6,
};
 
 
 
ENUM_DECLARATION IMPRESSION_TYPE
{
   IMPTYPE_LP  = 0,       
   IMPTYPE_LR  = 1,       
   IMPTYPE_NP  = 2,       
   IMPTYPE_NR  = 3,       
   IMPTYPE_L_I = 4,       
   IMPTYPE_L_T = 5,       
   IMPTYPE_L_P = 6,       
   IMPTYPE_L_L = 7,       
   IMPTYPE_SW  = 8,       
   IMPTYPE_LCL = 9,
   IMPTYPE_PALM_LS = 10,
   IMPTYPE_PALM_NON_LS = 11,
   IMPTYPE_PALM_LT_IMP = 12,
   IMPTYPE_PALM_LT_TRACING = 13,
   IMPTYPE_PALM_LT_PHOTO = 14,
   IMPTYPE_PALM_LT_LIFT = 15,
 
  IMPTYPE_FP_LS_OP_CT_PL = 20,
  IMPTYPE_FP_LS_OP_CT_RD = 21,
  IMPTYPE_FP_LS_NON_OP_CT_PL = 22,
  IMPTYPE_FP_LS_NON_OP_CT_RD = 23,
  IMPTYPE_FP_LS_OP_CS_PL = 24,
  IMPTYPE_FP_LS_OP_CS_RD = 25,
  IMPTYPE_FP_LS_NON_OP_CS_PL = 26,
  IMPTYPE_FP_LS_NON_OP_CS_RD = 27,
 
  IMPTYPE_OTHER = 28,
  IMPTYPE_UNKNOWN = 29,
 
  IMPTYPE_PLANTAR_LS = 30,
  IMPTYPE_PLANTAR_NON_LS = 31,
  IMPTYPE_PLANTAR_LT_IMP = 32,
  IMPTYPE_PLANTAR_LT_TRACING = 33,
  IMPTYPE_PLANTAR_LT_PHOTO = 34,
  IMPTYPE_PLANTAR_LT_LIFT = 35,
 
  IMPTYPE_U_FR_LT_IMP = 36,
  IMPTYPE_U_FR_LT_TRACING = 37,
  IMPTYPE_U_FR_LT_PHOTO = 38,
  IMPTYPE_U_FR_LT_LIFT = 39,
 
  IMPTYPE_FP_LS_OP_MS_PL = 40,
  IMPTYPE_FP_LS_OP_MS_RD = 41
 
};
 
ENUM_DECLARATION FINGERS
{
#ifdef __cplusplus
   FINGPOS_UK              = (int32_t)NIST_POS_CODE::POS_CODE_U_FINGER,
   FINGPOS_RT              = (int32_t)NIST_POS_CODE::POS_CODE_R_THUMB,
   FINGPOS_RI              = (int32_t)NIST_POS_CODE::POS_CODE_R_INDEX_F,
   FINGPOS_RM              = (int32_t)NIST_POS_CODE::POS_CODE_R_MIDDLE_F,
   FINGPOS_RR              = (int32_t)NIST_POS_CODE::POS_CODE_R_RING_F,
   FINGPOS_RL              = (int32_t)NIST_POS_CODE::POS_CODE_R_LITTLE_F,
   FINGPOS_LT              = (int32_t)NIST_POS_CODE::POS_CODE_L_THUMB,
   FINGPOS_LI              = (int32_t)NIST_POS_CODE::POS_CODE_L_INDEX_F,
   FINGPOS_LM              = (int32_t)NIST_POS_CODE::POS_CODE_L_MIDDLE_F,
   FINGPOS_LR              = (int32_t)NIST_POS_CODE::POS_CODE_L_RING_F,
   FINGPOS_LL              = (int32_t)NIST_POS_CODE::POS_CODE_L_LITTLE_F,
   
   POS_CODE_U_PALM         = (int32_t)NIST_POS_CODE::POS_CODE_U_PALM,
   POS_CODE_R_FULL_PALM    = (int32_t)NIST_POS_CODE::POS_CODE_R_FULL_PALM,
   POS_CODE_R_WR_PALM      = (int32_t)NIST_POS_CODE::POS_CODE_R_WR_PALM,
   POS_CODE_L_FULL_PALM    = (int32_t)NIST_POS_CODE::POS_CODE_L_FULL_PALM,
   POS_CODE_L_WR_PALM      = (int32_t)NIST_POS_CODE::POS_CODE_L_WR_PALM,
   POS_CODE_R_LOWER_PALM   = (int32_t)NIST_POS_CODE::POS_CODE_R_LOWER_PALM,
   POS_CODE_R_UPPER_PALM   = (int32_t)NIST_POS_CODE::POS_CODE_R_UPPER_PALM,
   POS_CODE_L_LOWER_PALM   = (int32_t)NIST_POS_CODE::POS_CODE_L_LOWER_PALM,
   POS_CODE_L_UPPER_PALM   = (int32_t)NIST_POS_CODE::POS_CODE_L_UPPER_PALM,
   POS_CODE_R_OTHER        = (int32_t)NIST_POS_CODE::POS_CODE_R_OTHER,
   POS_CODE_L_OTHER        = (int32_t)NIST_POS_CODE::POS_CODE_L_OTHER,
   POS_CODE_R_INTERDIGITAL = (int32_t)NIST_POS_CODE::POS_CODE_R_INTERDIGITAL,
   POS_CODE_R_THENAR       = (int32_t)NIST_POS_CODE::POS_CODE_R_THENAR,
   POS_CODE_R_HYPOTHENAR   = (int32_t)NIST_POS_CODE::POS_CODE_R_HYPOTHENAR,
   POS_CODE_L_INTERDIGITAL = (int32_t)NIST_POS_CODE::POS_CODE_L_INTERDIGITAL,
   POS_CODE_L_THENAR       = (int32_t)NIST_POS_CODE::POS_CODE_L_THENAR,
   POS_CODE_L_HYPOTHENAR   = (int32_t)NIST_POS_CODE::POS_CODE_L_HYPOTHENAR
#else
    FINGPOS_UK              = (int32_t)POS_CODE_U_FINGER,
    FINGPOS_RT              = (int32_t)POS_CODE_R_THUMB,
    FINGPOS_RI              = (int32_t)POS_CODE_R_INDEX_F,
    FINGPOS_RM              = (int32_t)POS_CODE_R_MIDDLE_F,
    FINGPOS_RR              = (int32_t)POS_CODE_R_RING_F,
    FINGPOS_RL              = (int32_t)POS_CODE_R_LITTLE_F,
    FINGPOS_LT              = (int32_t)POS_CODE_L_THUMB,
    FINGPOS_LI              = (int32_t)POS_CODE_L_INDEX_F,
    FINGPOS_LM              = (int32_t)POS_CODE_L_MIDDLE_F,
    FINGPOS_LR              = (int32_t)POS_CODE_L_RING_F,
    FINGPOS_LL              = (int32_t)POS_CODE_L_LITTLE_F,
    
    FINGPOS_U_PALM         = (int32_t)POS_CODE_U_PALM,
    FINGPOS_R_FULL_PALM    = (int32_t)POS_CODE_R_FULL_PALM,
    FINGPOS_R_WR_PALM      = (int32_t)POS_CODE_R_WR_PALM,
    FINGPOS_L_FULL_PALM    = (int32_t)POS_CODE_L_FULL_PALM,
    FINGPOS_L_WR_PALM      = (int32_t)POS_CODE_L_WR_PALM,
    FINGPOS_R_LOWER_PALM   = (int32_t)POS_CODE_R_LOWER_PALM,
    FINGPOS_R_UPPER_PALM   = (int32_t)POS_CODE_R_UPPER_PALM,
    FINGPOS_L_LOWER_PALM   = (int32_t)POS_CODE_L_LOWER_PALM,
    FINGPOS_L_UPPER_PALM   = (int32_t)POS_CODE_L_UPPER_PALM,
    FINGPOS_R_OTHER        = (int32_t)POS_CODE_R_OTHER,
    FINGPOS_L_OTHER        = (int32_t)POS_CODE_L_OTHER,
    FINGPOS_R_INTERDIGITAL = (int32_t)POS_CODE_R_INTERDIGITAL,
    FINGPOS_R_THENAR       = (int32_t)POS_CODE_R_THENAR,
    FINGPOS_R_HYPOTHENAR   = (int32_t)POS_CODE_R_HYPOTHENAR,
    FINGPOS_L_INTERDIGITAL = (int32_t)POS_CODE_L_INTERDIGITAL,
    FINGPOS_L_THENAR       = (int32_t)POS_CODE_L_THENAR,
    FINGPOS_L_HYPOTHENAR   = (int32_t)POS_CODE_L_HYPOTHENAR
#endif
};
 
 
ENUM_DECLARATION MinexTemplateType
{
    NIST_TEMPLATE = 0,
    ISO_TEMPLATE = 1,
    NIST_T5_TEMPLATE = 2,
};
 
const int32_t MAX_WIDTH = (4 * 1024);
const int32_t MAX_HEIGHT = (4 * 1024);
 
ENUM_DECLARATION MINUTIAE_TYPE
{
    BIFURCATION = 0,
    ENDING = 1
};
 
 
struct RawImage
{
   enum FINGERS    m_finger    ;   
   uint32_t   m_width          ;   
   uint32_t   m_height         ;   
   uint8_t   *m_image          ;
   uint16_t  m_ppi             ;
   enum IMPRESSION_TYPE m_impression_type;   
      
#ifdef __cplusplus
   RawImage()                                   
   {
       m_finger = FINGERS::FINGPOS_UK;
       m_width = 0;
       m_height = 0;
       m_image = nullptr;
       m_ppi = 0;
       m_impression_type = IMPRESSION_TYPE::IMPTYPE_LP;
   }
#endif
};
 
 
struct ImageData
{
    enum IMAGE_TYPE       m_type;
    uint8_t*          m_image;              
    uint32_t          m_imageSize;
    uint16_t  m_ppi;
    enum FINGERS           m_fingerPos;              
    enum IMPRESSION_TYPE   m_impression_type;
 
#ifdef __cplusplus
   ImageData()
    {
       m_type              = IMAGE_TYPE::UNDEFINED_IMAGE ;
       m_image             = nullptr;
       m_imageSize         = 0; 
       m_ppi               = 0;
       m_fingerPos         = FINGERS::FINGPOS_UK;
       m_impression_type   = IMPRESSION_TYPE::IMPTYPE_LP;
    }
#endif
};
 
#pragma pack(push, _CORE_TIGHT)
struct P_PACKED_1 PersonalData
{
   uint8_t        m_sex;
   uint16_t       m_birthYear;
   uint8_t        m_leftSlapError;
   uint8_t        m_rightSlapError;
   uint8_t        m_thumbsError;
   uint16_t       m_region;
   uint8_t        m_reserved[8];
#ifdef __cplusplus
   PersonalData()
   {
      clear();
   }
   void clear()
   {
      memset(this, 0, sizeof(PersonalData));
   }
   PersonalData& operator=(const PersonalData& pd)
   {
      memcpy(this, &pd, sizeof(PersonalData));
      return *this;
   }
   PersonalData(const PersonalData& pd)
   {
      *this = pd;
   }
#endif // __cplusplus
};
#pragma pack(pop)
 
#pragma pack(push, _CORE_PACKING)
struct  P_PACKED_8 MatchResult
{
    enum FINGERS   fingerP;
    enum FINGERS   fingerG;
    int32_t            similarity;
    uint32_t   numPairs;
    int16_t minutiaeNum[MAX_MINUTIAE][2];
    int32_t            xcP;
    int32_t            ycP;
    int32_t            xcG;
    int32_t            ycG;
    int32_t            angle;
 
 
#ifdef __cplusplus
    MatchResult()
    {
        clear();
    }
    void clear()
    {
        memset(this, 0, sizeof(MatchResult));
    }
#endif
};
#pragma pack (pop)
 
struct  Feature
{
    int32_t             x;
    int32_t             y;
    uint8_t           prob;
    int32_t            angle;
    uint8_t           density;
 
#ifdef __cplusplus
    Feature()
    {
        x = 0;
        y = 0;
        prob = 0;
        angle = 0;
        density = 0;
    }
#endif
};
 
#ifdef __cplusplus
struct Minutiae : public ::Feature
{
    enum MINUTIAE_TYPE  type;
    Minutiae() : Feature()
    {
        type = MINUTIAE_TYPE::BIFURCATION;
    }
};
#else
struct Minutiae
{
    int32_t                   x;
    int32_t                   y;
    uint8_t              prob;
    int32_t                  angle;
    uint8_t              density;
    enum MINUTIAE_TYPE   type;
};
 
#endif
 
#ifdef __cplusplus
   } // extern "C"{
#endif
 
#endif // COMMON_H__