ZKLiveFace SDK For Java

native class

 com.zkteco.android.biometric.ZKLiveFaceService 

動態庫加載

 static {     System.loadLibrary("zkdnnapi");     System.loadLibrary("zkdnnfd");     System.loadLibrary("zkipbase");     System.loadLibrary("msvcr100");     System.loadLibrary("msvcp100");     System.loadLibrary("opencv_highgui2410");     System.loadLibrary("opencv_core2410");     System.loadLibrary("zksface");     System.loadLibrary("ZKLiveFace"); } 

接口

getHardwareId

 [函數]     public native static int getHardwareId(byte[] hwid, int[] size); [功能]     獲取機器碼 [參數]     hwId[out]         返回機器碼（建議預分配256字節，足夠使用）     size[in/out]         [in]:hwId內存大小(字節數)         [out]:實際返回hwId長度 [返回值]     錯誤碼(見附錄1) [示例]     byte[] hwid = new byte[256];     int[] size = new int[1];     size[0] = 256;     if (0 == ZKLiveFaceService.getHardwareId(hwid, size))     {         String hwidStr = new String(hwid, 0, size[0]);     } [備注]     暫不支持     

getLastError

 [函數]     public native static int getLastError(long context,byte[] lasterror, int[] size); [功能]     返回最近一次的錯誤信息 [參數]    context[in]         算法實例指針(允許傳NULL)，當傳的不為NULL時為該實例的最近一次錯誤(錯誤碼為11時可調用該接口獲取錯誤描述)     lasterror[out]         錯誤信息（建議預分配512字節，足夠使用）     size[in/out]         [in]:version內存大小(字節數)         [out]:實際返回lasterror長度 [返回值]     錯誤碼(見附錄1)(該接口返回失敗，一般錯誤原因是分配的內存不足)       [備注]     暫不支持     

version

 [函數]     public native static int version(byte[] version, int[] size); [功能]     獲取版本號 [參數]     version[out]         返回版本號(建議預分配32字節以上)     size[in/out]         [in]:version內存大小(字節數)         [out]:實際返回version長度 [返回值]     錯誤碼(見附錄1) [示例]     byte[] version = new byte[256];     int[] size = new int[1];     size[0] = 256;     if (0 == ZKLiveFaceService.version(version, size))     {         String verStr = new String(version, 0, size[0]);     }   

loadImage

 [函數]     public native static int loadImage(String fileName, byte[] rawImage, int[] width, int[] height, int[] size); [功能]     加載圖片文件并轉換為BGR格式圖像數據 [參數]     fileName[in]         文件全路徑(支持的格式有:png, bmp, tif, jpg)     rawImage[out]          BGR格式圖像數據，請參考備注1的說明，得到要預分配的內存長度。返回原始圖數據     width[out]         返回圖像寬     height[out]         返回圖像高     size[in/out]         [in]:rawImage分配內存大小         [out]:實際返回rawImage數據長度 [返回值]     錯誤碼(見附錄1) [示例]     byte[] rawImage = null;     int[] width = new int[1];     int[] height = new int[1];     int[] size = new int[1];     int ret = 0;     if (0 == (ret = ZKLiveFaceService.loadImage(fileName, rawImage, width, height, size)))     {         rawImage = new byte[size[0]];         ret = ZKLiveFaceService.loadImage(fileName, rawImage, width, height, size);         ...     } [備注]     1、rawImage為NULL時，接口調用成功則width，height返回原始圖像的寬和高，size即為圖像大小(應分配的內存大小)     2、默認獲取到的原始圖像數據為：BGR圖像位深度為24位的原始圖像數據 

loadImageFromMemoryExt

 [函數]     public native static int loadImageFromMemoryExt(byte[] ImageFileData ,int cbImageFileData,byte[] rawImage, int[] width, int[] height, int[] size); [功能]    加載圖片文件數據轉并轉換為BGR格式圖像數據 [參數]     ImageFileData[in]         圖像的文件數據(支持的格式有:png, bmp, jpg)     cbImageFileData[in]         圖像的文件數據的大小     rawImage[out]          BGR格式圖像數據，請參考備注1的說明，得到要預分配的內存長度。     width[out]         返回圖像寬     height[out]         返回圖像高     size[in/out]         [in]:rawImage分配內存大小         [out]:實際返回rawImage數據長度 [返回值]     錯誤碼(見附錄1) [備注]     1、rawImage為NULL時，接口調用成功則width，height返回原始圖像的寬和高，size即為圖像大小(應分配的內存大小)     2、默認獲取到的原始圖像數據為：BGR圖像位深度為24位的原始圖像數據 

init

 [函數]     public native static int init(long[] context); [功能]     初始化算法庫 [參數]     context[out]         返回算法實例指針(context[0]) [返回值]     錯誤碼(見附錄1) [示例]     long context[] = new long[1];     int ret = ZKFaceService.init(context);     if (0 == ret)     {         System.out.print("Init succ, context=" + context[0]);     }     else     {         System.out.print("Init failed, error code=" + ret);     } [返回值]     錯誤碼 [示例]     long[] retContext = new long[1];     int ret = ZKLiveFaceService.init(retContext);     if (0 == ret)     {         context = retContext[0];     }     ... [備注]         1、調用初始接口成功后可以調用setParameter來設置探測人臉數、、1：1比對閥值具體設置步驟及相關參數說明可以參考setParameter接口說明 

setParameter

 [函數]     public native static int setParameter(long context, int code, byte[] value, int size); [功能]     設置參數 [參數]     context[in]         算法實例指針     code[in]         參數代碼（見附錄2）     value[in]         參數值     size[in]         數據長度(字節數) [返回值]     錯誤碼(見附錄1) [備注]     1、設置探測人臉數(默認為10)、1：1比對閥值、參數值為純數字字符串。例如設置的參數值為："8"。     2、如果調用設置許可文件路徑或者許可文件數據，在初始化前調用，此時算法句柄context傳0。     3、相關的參數說明和參數代碼可見附錄2詳細說明 [示例]     String maxFaceCnt = "8";     int ret = ZKLiveFaceService.setParameter(context, 1008, maxFaceCnt.getBytes(), maxFaceCnt.length()); 

getParameter

 [函數]     public native static int getParameter(long context, int code, byte[] value, int[] size); [功能]     獲取參數 [參數]     context[in]         算法實例指針     code[in]         參數代碼(見附錄2)     value[out]         參數值     size[in/out]         [in]:value分配數據長度         [out]:實際返回參數數據長度 [返回值]     錯誤碼(見附錄1) [備注]     1、獲取探測人臉數、1：1比對閥值,獲取到的參數值為純數字字符串。例如獲取探測人臉數，返回的參數值為："10"。 

detectFaces

 [函數]     public native static int detectFaces(long context, byte[] rawImage, int width, int height, int[] detectedFaces); [功能]     探測人臉 [參數]     context[in]         算法實例指針     rawImage[in]         原始圖像數據(見loadImage)     width[in]         圖像寬     height[in]         圖像高     detectedFaces[out]         探測到人臉數(<=探測人臉數(PARAM_CODE_MAX_FACE)) [返回]     錯誤碼(見附錄1) [備注]     1、rawImage默認為：BGR圖像位深度為24位的原始圖像數據     2、該接口為非線程安全接口。 [示例]     int[] detectedFaces = new int[1];     int ret = ZKLiveFaceService.detectFaces(context, rawImage, width, height, detectedFaces);     ... 

detectFacesExt

 [函數]     public native static int detectFacesExt(long context, byte[] rawImage, int width, int height, int[] detectedFaces,int colortype); [功能]     探測人臉 [參數]     context[in]         算法實例指針     rawImage[in]         原始圖像數據(見loadImage)     width[in]         圖像寬     height[in]         圖像高     detectedFaces[out]         探測到人臉數(<=探測人臉數(PARAM_CODE_MAX_FACE))     colortype[in]         圖片色彩類型(備注：0：表示灰度圖像位深度為8位  1：表示BGR圖像位深度為24位 )         建議使用BGR圖像位深度為24位的圖片 [返回]     錯誤碼(見附錄1) [備注]     暫不支持     

terminate

 [函數]     public native static int terminate(long context); [功能]     釋放算法資源 [參數]     context[in]         算法實例指針 [返回值]     錯誤碼(見附錄1) 

getFaceContext

 [函數]     public native static int getFaceContext(long context, int faceIdx, long[] faceContext); [功能]     獲取人臉實例指針 [參數]     context[in]         算法實例指針     faceIdx[in]         人臉索引(見ZKFace_DetectFaces，0~[detectedFaces-1])     faceContext[out]         返回人臉實例指針 [返回值]     錯誤碼(見附錄1) 

setThumbnailParameter

 [函數]     public native static int setThumbnailParameter(long context, int thumbnailWidth, int thumbnailHeight, float thumbnailScale, float thumbnailQuality); [功能]     設置小圖像壓縮參數 [參數]     context[in]         算法實例指針     thumbnailWidth[in]         縮略圖圖像寬度(（范圍：32~1024）默認值為：192(建議使用該值))     thumbnailHeight[in]         縮略圖圖像高度((范圍：32~1024) 默認值為：256(建議使用該值))     thumbnailScale[in]         要縮略的尺度(范圍：0.1~1)默認值為：0.6(建議使用該值)     thumbnailScale[in]         縮略圖的質量(范圍：0~100)默認值為：32(建議使用該值) [返回值]     錯誤碼(見附錄1) [備注]     該函數應該在調用探測人臉數接口(detectFaces或者detectFacesExt)前調用方可生效 [備注]     暫不支持     

getCropImageData

 [函數]     public native static int getCropImageData(long faceContext, int[] cropWidth, int[] cropHeight, int[] cropLength, byte[] rawCroppedImage); [功能]      獲取小圖像數據（RGB圖像位深度為24位圖像數據） [參數]     faceContext[in]         人臉實例指針     cropWidth[out]         縮略圖圖像寬度     cropHeight[out]         縮略圖圖像高度     cropLength[in/out]         [in]:rawCroppedImage內存大小         [out]:實際返回圖像數據大小     rawCroppedImage         返回圖像數據(RGB圖像位深度為24位圖像數據) [返回值]     錯誤碼(見附錄1) 

getFaceFeature

 [函數]     public native static int getFaceFeature(long faceContext, int featureID, int[] pX, int[] pY, int[] score); [功能]     獲取特征 [參數]     faceContext[in]         人臉實例指針     featureID[in]         特征ID（見附錄4）     pX[out]         返回X坐標     pY[out]         返回Y坐標     score[out]         返回分數(預留參數)  [返回值]     錯誤碼(見附錄1) 

getFaceICaoFeature

 [函數]     public native static int getFaceICaoFeature(long faceContext, int featureID, int[] score); [功能]     獲取ICao特征 [參數]     faceContext[in]         人臉實例指針     featureID[in]         特征ID（見附錄3）     score[out]         返回對應的特征值 [返回值]     錯誤碼(見附錄1) [備注]     該接口僅供參考，有可能存在誤差 

extractTemplate

 [函數]     public native static int extractTemplate(long faceContext, byte[] template, int[] size, int[] resverd); [功能]     提取人臉模板 [參數]     faceContext[in]         人臉實例指針     temlpate[out] （建議預分配2048個字節，足夠使用）         人臉模板     size[in/out]         [in]:template內存分配大小         [out]:實際返回template數據長度     resverd[out]         該參數為預留參數 [返回值]     錯誤碼(見附錄1) [示例]     int ret = 0;     byte[] template = new byte[2048];     int[] size = new int[1];     int[] resverd = new int[1];     size[0] = 2048;     ret = ZKLiveFaceService.extractTemplate(faceContext, template, size, resverd);     ... 

getFaceRect

 [函數]     public native static int getFaceRect(long faceContext, int[] points, int cntPx); [功能]     獲取探測到人臉的矩形框 [參數]     faceContext[in]         人臉實例指針     points[out]         矩形框四個坐標點p0.x p0.y p1.x p1.y p2.x p2.y p3.x p3.y順序排列（順時針方向）     cntPx[in]          points數組大小(8) [返回值]     錯誤碼(見附錄1) 

closeFaceContext

 [函數]     public native static int closeFaceContext(long faceContext); [功能]     釋放人臉實例對象 [參數]     faceContext[in]         人臉實例指針 [返回值]     錯誤碼(見附錄1) 

verify

 [函數]     public native static int verify(long context, byte[] regTemplate, byte[] verTemplate, int[] score) [功能]     人臉1:1比對 [參數]     context[in]         算法實例指針     regTemplate[in]         登記模板     verTemplate[in]         比對模板     score[out]         返回分數 [返回值]         錯誤碼(見附錄1) [備注]     1、默認1:1的比對閥值為60。超過即為比對成功。     2、比對分數范圍：0~120     3、人證合一時閥值可以設置為：55~60 。普通照片時：1：1人臉閥值可以設置為：80 [示例]     int ret = 0;     int[] score = new int[1];     ret = ZKLiveFaceService.verify(context, regTemplate, verTemplate, score); 

dbAdd

 [函數]     public native static int dbAdd(long context, String faceID, byte[] regTemplate) [功能]     添加人臉模板到默認的1:N高速緩沖區 [參數]     context[in]         算法實例指針     faceID[in]         人臉ID     regTemplate[in]         登記模板 [返回值]     錯誤碼(見附錄1) 

dbDel

 [函數]     public native static int dbDel(long context, String faceID) [功能]     從默認的1:N高速緩沖區刪除一個人臉模板 [參數]     context[in]         算法實例指針     faceID[in]         人臉ID [返回值]     錯誤碼(見附錄1) [備注]     暫不支持     

dbClear

 [函數]     public native static int dbClear(long context) [功能]     清空默認的1:N高速緩沖區 [參數]     context[in]         算法實例指針 [返回值]     錯誤碼(見附錄1) 

dbCount

 [函數]     public native static int dbCount(long context, int[] count) [功能]     獲取默認的1:N高速緩沖區的模板數 [參數]     context[in]         算法實例指針     count[out]         返回的模板個數 [返回值]     錯誤碼(見附錄1) 

dbIdentify

 [函數]     public native static int dbIdentify(long context, byte[] verTemplate, byte[] faceIDs, int[] score, int[] maxRetCount, int minScore, int maxScore) [功能]     1:N識別 [參數]     context[in]         算法實例指針     verTemplate[in]         比對模板     faceID[out]         返回人臉ID數組     score[out]         返回比對分數     maxRetCount[in/out]         [in]:返回多少個         [out]:實際返回多少個     minScore[in]         匹配分數。只有要識別的人臉與數據庫中 的某一人臉模板的相似度達到該值時，才能識別 成功     maxScore[in]         當要識別人臉與數據庫中的某一人臉模板的相似 度達到該值時，識別成功立即返回 [返回值]     錯誤碼(見附錄1) [示例]     int ret = 0;     int[] score = new int[1];     byte[] faceIDS = new byte[256];     int[] maxRetCount = new int[1];     maxRetCount[0] = 1; //只返回1個人臉     ret = ZKLiveFaceService.dbIdentify(context, verTemplate, faceIDS, score, maxRetCount, 80, 110);     ...  [備注]         1、比對分數范圍：0~160     2、匹配分數一般設置為：80 

bayerToBGR24

 [函數]     public native static int bayerToBGR24(byte[] bayer, int width, int height, byte[] imgData) [參數]     bayer         bayer數據     width         圖像寬     height         圖像高     imgData         圖像數據 [返回值]     錯誤碼(見附錄1) [備注]     暫不支持     

dbVerifyByID

 [函數]     public native static int dbVerifyByID(long context,String faceID,byte[]verTemplate,int[] score); [功能]     在默認的1:N高速緩沖區中通過人臉ID號進行1:1比對 [參數]     context[in]         算法實例指針     faceID[in]         人臉ID     verTemplate[in]         比對的模板     score[out]         返回比對分數 [返回值]     錯誤碼(見附錄1) [備注]     暫不支持     

dbInitExt

 [函數]     public native static int dbInitExt(long context,long[] dbcontext); [功能]     初始化并創建1:N高速緩沖區 (可以創建多個高速緩沖區) [參數]      context[in]         算法實例指針      dbcontext[out]         返回1:N高速緩沖區實例指針 [返回值]     錯誤碼(見附錄1) [備注]     暫不支持     

dbAddExt

 [函數]      public native static int dbAddExt(long dbcontext,String faceID,byte[] regTemplate); [功能]      添加人臉模板到1:N高速緩沖區 [參數]      dbcontext[in]         1:N高速緩沖區實例指針      faceID[in]         人臉ID      regTemplate[in]         登記模板 [返回值]     錯誤碼(見附錄1) [備注]     暫不支持     

dbDelExt

 [函數]     public native static int dbDelExt(long dbcontext,String faceID); [功能]     從1:N高速緩沖區中刪除一個人臉模板 [參數]     dbcontext[in]         1:N高速緩沖區實例指針     faceID[in]         要刪除的人臉ID [返回值]     錯誤碼(見附錄1) [備注]     暫不支持     

dbCountExt

 [函數]      public native static int dbCountExt(long dbcontext,int[] count); [功能]      獲取1:N高速緩沖區的模板數 [參數]      dbcontext[in]         1:N高速緩沖區實例指針      count[out]         返回模板個數 [返回值]     錯誤碼(見附錄1)。 [備注]     暫不支持     

dbIdentifyExt

 [函數]     public native static int dbIdentifyExt(long dbcontext, byte[] verTemplate, byte[] faceIDs, int[] score, int[] maxRetCount, int minScore, int maxScore); [功能]     在1:N高速緩沖區中進行1:N識別 [參數]     dbcontext[in]         1:N高速緩沖區實例指針     verTemplate[in]         比對模板     faceID[out]         返回人臉ID數組     score[out]         返回比對分數     maxRetCount[in/out]         [in]:返回多少個         [out]:實際返回多少個     minScore[in]         匹配分數。只有要識別的人臉與數據庫中 的某一人臉模板的相似度達到該值時，才能識別 成功     maxScore[in]         當要識別人臉與數據庫中的某一人臉模板的相似 度達到該值時，識別成功立即返回 [返回值]     錯誤碼(見附錄1) [備注]     暫不支持     

dbVerifyByIDExt

 [函數]     public native static int dbVerifyByIDExt(long dbcontext,String faceID,byte[] verTemplate,int[] score); [功能]      在1:N高速緩沖區中通過人臉ID號進行1:1比對 [參數]      dbcontext[in]         1:N高速緩沖區實例指針      faceID[in]         人臉ID      verTemplate[in]         比對模板      cbVerTemplate[in]         比對模板長度      score[out]         返回分數 [返回值]     錯誤碼(見附錄1) [備注]     暫不支持     

dbFreeExt

 [函數]      public native static int dbFreeExt(long dbcontext); [功能]      釋放1:N高速緩沖區資源 [參數]      dbcontext[in]         1:N高速緩沖區實例指針 [返回值]     錯誤碼(見附錄1) [備注]     暫不支持     

附錄

附錄1

錯誤碼如下表所示