商米AI识客SDK代码示例

  1. SDK 初始化
  2. 获取摄像头预览信息
  3. 获取摄像头拍照数据
  4. 获取特征值
  5. 人脸特征值比较
  6. 删除特征记录
  7. 会员库添加
  8. 会员注册
  9. IPC 回调接口

1. SDK初始化

public boolean initFaceSdkInstance(Context context, String licencePath) {
         //初始化配置文件
        int ret = SunmiFaceSDK.init(confPath);
        if (licencePath == null) {
            Log.d(TAG, "Please input licence");
            return false;
        }
        File f = new File(licencePath);
        if (!f.exists()) {
            Log.d(TAG, "licence is not exist");
            return false;
        }
        String licence = readToString(licencePath);
        //验证Licence
        ret = SunmiFaceSDK.verifyLicence(context, licence);
        if (ret != 0) {
            Log.d(TAG, "Licence is not OK ErrorCode " + ret);
            return false;
        }
        //设置配置参数
        SunmiFaceConfigParam param = new SunmiFaceConfigParam();
        SunmiFaceSDK.getConfig(param);
        param.setDistance_threshold_(1.3f);
        param.setYaw_threshold_(50.0f);
        param.setPitch_threshold_(50.0f);
        param.setRoll_threshold_(50.0f);
        param.setMin_face_size(60);
        param.setImage_quality_threshold_(10);
        param.setMin_luminance_(10);
        param.setMax_luminance_(180);
        param.setLiveness_on_(false);
        param.setThread_num_(1);
        //设置配置参数
        ret = SunmiFaceSDK.setConfig(param);

        if (ret != 0) {
            Log.d(TAG, "param is not init");
            return false;
        }
        return true;
    }

public void init(Context context) {
      //设置licence_valid.txt为sd卡路径,也可以换成app运行工作目录。
      String licencePath = Environment.getExternalStorageDirectory() + File.separator + "licence_valid.txt";
      initFaceSdkInstance(context, licence_path);
     // 调用IPCameraManager静态类getInstance初始化IPCManger对象
     mIPCManager = IPCameraManager.getInstance(context);
}

2. 获取摄像头预览信息

//摄像头数据回调接口	
CameraDataCallback cameraDataCallback = new CameraDataCallback() {
    @Override
    public void onImageDataArrival(Bitmap bitmap, int width, int height) {
        if (mBackgroundHandler != null) {
            if (mClickAction == 1 && !faceDetectState.get()) {
                mBackgroundHandler.post(new MotionDetector(bitmap, width, height));
            } else {
                bitmap.recycle();
            }
        }

    }
};
//开启摄像头预览
FaceCameraManager.getInstance().startPreview(getApplicationContext(), this, FaceCameraManager.getInstance().getCurCamera(), cameraView, PREVIEW_WIDTH, PREVIEW_HEIGHT, cameraDataCallback);

3. 获取摄像头拍照数据

{
//根据摄像头是USB还是系统摄像头,调用不同的方法,获取bitmap数据
if (FaceCameraManager.getInstance().getCurCamera() == FaceCameraManager.CAMERA_USB)
    bitmap = mUVCCameraView.captureStillImage();
else
    bitmap = mTextureView.getBitmap();

}

4. 获取特征值

说明:通过bitmap获取特征值

    public ArrayList‹SunmiFaceFeature› getFeatures(Bitmap bitmap, int maxFace) {

        int ret = 0;
        //bitmap的RGB数据转化成BGR数据
        byte[] srcData = ImageUtils.getPixelsBGR(bitmap);
        //通过BGR数据构造SunmifaceImage对象
        SunmiFaceImage image = new SunmiFaceImage(srcData, bitmap.getHeight(), bitmap.getWidth(), maxFace);
        SunmiFaceImageFeatures features = new SunmiFaceImageFeatures();
        //从SunmifaceImage数据中提取人脸特征
        ret = SunmiFaceSDK.getImageFeatures(image, features);
        //返回人脸特征数组
        SunmiFaceFeature feature_ary = features.getFeatures_();
        ArrayList‹SunmiFaceFeature› arrayList = new ArrayList‹›();
        if (features.getFeatures_count_() == 0) {
            SunmiFaceSDK.releaseImageFeatures(features);
            return arrayList;
        }

        for (int i = 0; i ‹ features.getFeatures_count_(); i++) {
            SunmiFaceFeature sunmiFaceFeature = SunmiFaceLib.SunmiFaceFeatureArray_getitem(feature_ary, i);
            arrayList.add(sunmiFaceFeature);
        }
        SunmiFaceSDK.releaseImageFeatures(features);
        return arrayList;
        // return getFeature(srcData, bitmap.getWidth(),bitmap.getHeight(), 1);
    }

5. 人脸特征值比较

    public SunmiFaceCompareResult compareFeature1V1(float similar, float[] feature1, float[] feature2) {
        //构造SunmiFaceFeature对象
        SunmiFaceFeature feat1 = new SunmiFaceFeature();
        SunmiFaceFeature feat2 = new SunmiFaceFeature();
        feat1.setFeature_(feature1);
        feat2.setFeature_(feature2);
        SunmiFaceCompareResult result = new SunmiFaceCompareResult();
        //调用compare1v1进行比较
        int ret = SunmiFaceSDK.compare1v1(feat1, feat2, result);
        return result;
    }

6. 会员删除

说明: 删除会员信息时,需要把删除的人脸会员信息同步到IPC。向IPC传递用户的唯一识别ID

{
//删除人脸库记录
int result = SunmiFaceSDK.deleteDBRecord(user.getImageName());
//同步删除IPC人脸记录
if (mIPCManager != null) {
    mIPCManager.deleteFaceRecord("GVIP", userId, new RPCCallback‹RPCResponse‹RPCResponse.FaceDeleteSubResult››() {
         //IPC人脸删除记录完成后回调接口
        @Override
        public void onComplete(RPCResponse‹RPCResponse.FaceDeleteSubResult› result) {
            Log.i(TAG, "deleteFaceRecord, code:" + result.code());
        }
    });
}
}

7. 人脸会员库添加

说明: 添加人脸时,同时要向IPC注册人脸信息。向IPC传递信息包括:人脸会员库(GVIP),人脸照片、人脸会员唯一识别ID。

{
        //使用faceFeature构建record
        SunmiFaceDBRecord record =     SunmiFaceSDK.faceFeature2FaceDBRecord(faceFeature);
        record.setId_(user.getUserId());
        record.setName_(user.getUserName());
        //把record添加到人脸库
        int ret = SunmiFaceSDK.addDBRecord(record);
        //把人脸照片传递给IPC,向IPC添加人脸记录   
         if (mIPCManager != null) {
                    mIPCManager.addFaceRecord("GVIP", picPath, uid, new RPCCallback‹RPCResponse›() {
                        //IPC人脸添加记录完成后回调接口
                        @Override
                        public void onComplete(RPCResponse result) {
                            Log.i(TAG, "addFaceRecord, code:" + result.code());
                        }
                        //IPC人脸添加记录失败时回调接口
                        @Override
                        public void onAbort(int httpStatus) {
                            Log.i(TAG, "addFaceRecord, httpStatus:" + httpStatus);
                        }
                        //IPC人脸添加记录异常时回调接口
                        @Override
                        public void onException(Throwable t) {
                            Log.i(TAG, "addFaceRecord, Exception:" + t.getMessage());
                        }
                    });
                }

}

8 会员注册

/*
 *向系统注册会员信息
 *@groupname, 会员组
 *@userNanem, 会员名
 *@picPath,   会员照片存放路劲
 *@userInfo,  会员详情
 *@faceFeature, 会员照片提取的特征值
 */
public boolean registerUserIntoDBmanager(String groupName, String userName, String picPath, String userInfo, SunmiFaceFeature faceFeature) {
        boolean isSuccess = false;
        Group group = new Group();
        group.setGroupId(groupName);
        //创建会员
        User user = new User();
        user.setGroupId(groupName);
        //final String uid = UUID.randomUUID().toString();
        String uid = String.valueOf(System.currentTimeMillis());
        user.setUserId(uid);
        user.setUserName(userName);
        user.setFeature(faceFeature.getFeature_());
        //创建人脸库记录信息
        SunmiFaceDBRecord record = SunmiFaceSDK.faceFeature2FaceDBRecord(faceFeature);
        record.setId_(user.getUserId());
        record.setName_(user.getUserName());
        //像人脸库添加记录
        int ret = SunmiFaceSDK.addDBRecord(record);
        if (ret != 0) {
            Log.d(TAG, "addDBRecord failed " + SunmiFaceSDK.getErrorString(ret));
            return false;
        }
        //在会员数据库中记录,特征值对应的图片在人脸数据中的ID
        user.setImageName(record.getImg_id_());
        if (userInfo != null) {
            user.setUserInfo(userInfo);
        }
        // 添加用户信息到数据库
        boolean importUserSuccess = FaceManager.getInstance().userAdd(user);
        if (importUserSuccess) {
            // 如果添加到数据库成功,则添加用户组信息到数据库
            // 如果当前图片组名和上一张图片组名相同,则不添加数据库到组表
            if (FaceManager.getInstance().groupAdd(group)) {
                isSuccess = true;
                if (mIPCManager != null) {
                    Log.i(TAG, "picPath: " + picPath);
                    Log.i(TAG, "uid: " + uid);
                    //把会员照片同步发送到IPC,同步会员信息到IPC
                    mIPCManager.addFaceRecord("GVIP", picPath, uid, new RPCCallback‹RPCResponse›() {
                        @Override
                        public void onComplete(RPCResponse result) {
                            Log.i(TAG, "addFaceRecord, code:" + result.code());
                        }

                        @Override
                        public void onAbort(int httpStatus) {
                            Log.i(TAG, "addFaceRecord, httpStatus:" + httpStatus);
                        }

                        @Override
                        public void onException(Throwable t) {
                            Log.i(TAG, "addFaceRecord, Exception:" + t.getMessage());
                        }
                    });
                }
            } else {
                isSuccess = false;
            }

        } else {
            isSuccess = false;
        }
        return isSuccess;
    }

9. IPC 回调接口

说明:用户获取IPC的状态、返回信息等。

{
                    //获取IPC信息
                    IPCameraManager manager = IPCameraManager.getInstance(getApplicationContext());
                    //IPC初始化
                    manager.init("test", "123456", "123456");
                    //注册IPC回调
                    manager.registerListener(new IPCameraListener() {
                        //IPC设备在线时回调接口
                        @Override
                        public void onDeviceOnline(IPCameraInfo device) {
                            showToast("[ " + device.getDeviceid() + " ]上线");
                        }
                        //IPC设备离线时回调接口
                        @Override
                        public void onDeviceOffline(IPCameraInfo device) {
                            showToast("[ " + device.getDeviceid() + " ]离线");
                        }
                        //IPC设备获取到进店信息后回调接口
                        @Override
                        public void onFaceDetect(String userId) {
                            String userName = null;
                            List‹User› users = DBManager.getInstance().queryUserByUserId(userId);
                            if (users != null && users.size() › 0) {
                                userName = users.get(0).getUserName();
                            }
                            if (userName == null) {
                                showToast("未注册的用户进店");
                            } else {
                                User user = users.get(0);
                                UserEvent userEvent = new UserEvent();
                                userEvent.setUserId(user.getUserId());
                                userEvent.setEnterTime(System.currentTimeMillis());
                                userEvent.setDesc("Enter Store");
                                DBManager.getInstance().addUserEvent(userEvent);
                                showToast("用户[ " + userName + " ]进店");
                            }
                        }
             }
}

10、IPC扫描

// 获取IPC扫描的AP热点
private void getWifiList() {
    BasicConfig.getInstance(context).getApListWithoutAuth(sunmiDevice.getDeviceid(),
            new RPCCallback‹RPCResponse‹IpcApBean››() {
                @Override
                public void onComplete(RPCResponse‹IpcApBean› result) {
                    if (result.code() == RPCErrorCode.SUCCESS) {
                        wifiListGetSuccess(result.data());
                    } else {
                        Log.i(TAG, "getApListWithoutAuth failed, errcode: " + result.code());
                    }
                }
        });

    new Handler().postDelayed(new Runnable() {
        @Override
        public void run() {
            if (wifiList.size() == 0) {
                setNoWifiVisible(View.VISIBLE);
            }
        }
    }, TIMEOUT_GET_WIFI);
}

11、IPC连接AP

private void setIpcWifi(String ssid, String psw) {
    showLoadingDialog();
    BasicConfig.getInstance(context).setWifiConfWithoutAuth(sunmiDevice.getDeviceid(),
            ssid, psw, new RPCCallback‹RPCResponse›() {
                @Override
                public void onComplete(RPCResponse result) {
                    if (result.code() == RPCErrorCode.SUCCESS) {
                        hideLoadingDialog();
                        shortTip("配置成功,请等待设备联网,联网后指示灯会变成蓝色");
                        createWaitDialog();
                    } else {
                        hideLoadingDialog();
                        shortTip("配置失败");
                    }
                }

                @Override
                public void onError(Throwable t) {
                    hideLoadingDialog();
                    shortTip("配置失败");
                }
            });
}

12、激活IPC

//激活ipc设备,并设置回调接口
DeviceManage.getInstance(context).activate(ipcList.get(postion).getDeviceid(),
    new RPCCallback‹RPCResponse›() {
        //IPC返回相关错误码。
        @Override
        public void onComplete(RPCResponse result) {
            if (result.code() == RPCErrorCode.SUCCESS || result.code() == RPCErrorCode.DEVICE_ACTIVATED) {
                Log.i(TAG, "activate ipc success");
            } else {
                Log.i(TAG, "activate ipc failed");
            }
        }
        //网络问题导致无法通信,会调用onError接口
        @Override
        public void onError(Throwable t) {
            Log.i(TAG, "activate ipc failed");
        }
    });

13、RTSP播放

    private void openMediaPlayer() {
        new Thread(new Runnable() {
            @Override
            public void run() {
                //获取播放流
                VideoStream.getInstance(context).getLiveStream(mDevice.getDeviceid(),
                        new RPCCallback‹RPCResponse‹RPCResponse.LiveAddressBean››() {
                            @Override
                            public void onComplete(RPCResponse‹RPCResponse.LiveAddressBean› result) {
                                if (result.code() == RPCErrorCode.SUCCESS) {
                                    Log.i(TAG, "live url: " + result.data().fhd_live_url);
                                    if (mPlayer == null) {
                                       //自定义的rtsp播放器
                                        mPlayer = new SunmiPlayer(context);
                                        mPlayer.setListener(new SunmiPlayerListener() {
                                            @Override
                                            public void onPrepared(IMediaPlayer iMediaPlayer) {
                                                iMediaPlayer.start();
                                            }
                                        });
                                        mPlayer.setSurface(mVideoView.getHolder().getSurface());
                                        //获取到ipc返回的播放流rtsp地址
                                        String liveUrl = result.data().fhd_live_url.replaceFirst("^rtsp://", "rtsp://admin:admin@");
                                        //自定义播放器开始播放rtsp视频流
                                        mPlayer.setUp(liveUrl);
                                    }
                                }
                            }
                });
            }
        }).start();
    }

14、IPC对焦、调焦

rivate BasicConfig mBasicConfig;

public void init() {
    ...
    mBasicConfig = BasicConfig.getInstance(context);
    ...
}

// 调焦
private void func1(){
    ...
    mBasicConfig.setZoom(mDevice.getDeviceid(), zfBean.zoom, new RPCCallback‹RPCResponse›() {
        @Override
        public void onComplete(RPCResponse result) {
            Log.i(TAG, "setZoom, code:" + result.code());
        }
    });
    ...
}

// 自动对焦
private void func2() {
    ...
    mBasicConfig.autoFocus(mDevice.getDeviceid(), xRelative, yRelative, new RPCCallback‹RPCResponse›() {
        @Override
        public void  onComplete(RPCResponse result) {
            Log.d(TAG, "autoFocus, code:" + result.code());
            if (result.code() == RPCErrorCode.SUCCESS) {
                mBasicConfig.getZoomFocusConf(mDevice.getDeviceid(), new RPCCallback‹RPCResponse‹RPCResponse.ZoomFocusBean››() {
                    @Override
                    public void onComplete(RPCResponse‹RPCResponse.ZoomFocusBean› result) {
                        if (result.code() == RPCErrorCode.SUCCESS) {
                            zfBean = result.data();
                            mSbZoom.setProgress(zfBean.zoom);
                        }
                    }
                });
            }
        }
    });
    ...
}

// 自动对焦如果不够清晰,可以手动对焦进行微调
private void func3() {
    ...
    mBasicConfig.manualFocus(mDevice.getDeviceid(), focus, new RPCCallback‹RPCResponse›() {
        @Override
        public void onComplete(RPCResponse result) {
            if (result.code() == RPCErrorCode.SUCCESS) {
                zfBean.focus = focus;
            }
        }
    });
    ....
}

15、设置IPC门线

private void func() {
    ...
    PeopleFlowStats.getInstance(context).setDoorLine(mDevice.getDeviceid(), 0, lineStart[0],
            lineStart[1], lineEnd[0], lineEnd[1], new RPCCallback‹RPCResponse›() {
                @Override
                public void onComplete(RPCResponse result) {
                    if (result.code() == RPCErrorCode.SUCCESS) {
                        stopPlay();
                        finish();
                        startActivity(new Intent(context, MainActivity.class));
                    }
                }
            });
    ...
}

16、IPC监听人脸消息

IPCameraManager.getInstance(context).setFaceDetectListener(new FaceDetectListener() {
    @Override
    public void onFaceDetect(String userId) {
        String userName = null;
        if (userName == null) {
            showToast(getApplicationContext(), "未注册的用户进店");
        } else {
            showToast(getApplicationContext(), "用户[ " + userName + " ]进店");
        }
    }
});

商米AI识客SDK开发指南

1.准备工作

1.1 申请SDK所需的材料

步骤一:联系商米售前技术团队,申请SDK需要向售前技术支持团队提供如下软件开发商信息

客户提供的信息说明
客户名称软件商公司名称

步骤二:售前技术团队根据客户的需求信息,返回软件商以下内容:

返回给客户的信息说明
SDK开发包用于人脸识别以及AI识客设备开发的SDK(目前只支持安卓版本)

SDK开发包:

序号文件/文件名说明
1FaceDemoDemo工程源码
2face-release.aar商米人脸识别SDK
3libipcsdk-release.aarIPC 联动版sdk
4asset商米人脸识别资源文件
5FaceDemo.apkFaceDemo程序

2、申请Licence

拿到SDK后,联系商米售前人员,提供以下信息申请Licence

提供的信息说明
收银设备硬件指纹1、通过Demo APP查看硬件指纹信息。安装运行FaceDemo.apk,授权FaceDemo存储器权限,会在sdcard目录生成一个硬件指纹信息文件device_fingerprint.txt。
2、或者通过SDK API查看硬件指纹信息。

返回的信息:

信息说明
Licence 激活人脸识别的SDK的Licence
appid和secret_key 激活设备IPC设备

SaaS开发者获取到以上信息后,可以使用人脸识别SDK,并激活IPC设备。

3、添加SDK到工程

3.1 导入SDK

右键点击app,选择New->Module->Import .JAR/.AAR Package

点击Finish即导入aar模块

3.2 权限申明

在AndroidManifest.xml文件里添加如下权限:

	‹uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/›
	‹uses-permission android:name="android.permission.INTERNET" /›
	‹uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /›
	‹uses-permission android:name="android.permission.CHANGE_WIFI_STATE" /›
	‹uses-permission android:name="android.permission.CHANGE_WIFI_MULTICAST_STATE" /›
	‹uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" /›
	‹uses-permission android:name="android.permission.CAMERA" /›

3.3 导入asset资源

导入提供的assets资源

说明:资源文件需要APP启动的时候复制到APP的运行目录,以方便SDK后续初始化。

3.4 导入licence文件

获取到licence_valid.txt文件,可以放到assets资源目录,也可以放到sdcard目录。

1)放到assets资源目录,则需要把licence_valid.txt文件从资源文件复制到app的工作目录。

2)如果放到sdcard目录,则需要app申请sdcard读取权限。

无论哪一种情况,最后使用的时候,需要传递licence_valid.txt文件的路径,以激活人脸识别SDK。详细见SDK初始化代码

4、DEMO 工程目录结构

4.1 app Module

app Module是DEMO的入口。其中包含了各个模块的入口函数调用。

4.2 commonlib

commonlib Module包含了整个DEMO通用的接口。其中包含摄像头管理,工具类。如下图:

4.2.1 FaceCameraManager

FaceCameraManager统一管理设备自带摄像头和USB摄像头。设备自带摄像头的流程是使用Android系统提供的摄像头通用方法。USB摄像头则使用UVC库提供的操作摄像头的方法。FaceCameraManager对上层应用提供统一的方法:startPreview和 stopPreview。

4.2.2 NormalCameraManager

NormalCameraManager使用Android系统提供的摄像头方法,实现startPreview和stopPreview。并在内部实现回调接口用于返回每一帧摄像头获得的数据。

4.2.3 UVCCameraManager

UVCCameraManager使用第三方库UVClib提供的方法用于操作USB摄像头,实现startPreview和stopPreview。 并在内部实现回调接口用于返回每一帧摄像头获得的数据 。

4.2.4 ByteUtils

ByteUtils提供Byte操作的一些通用方法。

4.2.5 DBHelper

DBHelper提供创建数据的方法。

4.2.6 ImageUtils

ImageUtils提供图片操作的一些方法。

4.3 libuvccamera

libuvccamera Module采用第三方库开源库libuvccamera

4.4 facedemo

facedemo Module是DEMO实现功能的主要模块。其包含:配置IPC、会员注册、会员管理、会员查询等功能。

5、配置IPC

IPC设备使用时,如果未激活,需要先激活IPC设备。激活步骤如下:

5.1 SDK初始化

APP_ID:激活与API调用校验使用的账号。

SECRET_KEY:API调用所需的签名密钥。

LICENSE:激活API所需的激活码。

IPCameraManager mIPCameraManager = IPCameraManager.getInstance(context);
mIPCameraManager.init(APP_ID, SECRET_KEY, LICENSE);

5.2 配网

IPC设备激活时需要连接到互联网。IPC连接互联网时,可以通过无线(wifi)或有线(以太网口)连接到路由器。无线连接时需要做配网设置。

有线接入:

有线接入只需要通过网线把IPC设备和集成SDK的Android设备接入到同一局域网即可,不需要其它设置。

无线接入:

无线配网方式相对要复杂点,步骤如下:

  1. 使用手机/PC的无线网卡扫描IPC的AP热点,一般AP热点的名称为SUNMI_XXXX,其中XXXX为MAC地址最后2个字节的16进制数字,MAC地址可以通过设备机身后背的标贴或者包装盒的标贴查到,AP热点本身是无加密的。
  2. 使用手机/PC的无线网卡连接IPC的AP热点,此时手机/PC就会获取到IPC分配的IP地址(按照设备发现描述的方法即可获取到),一般会是192.168.200.XXX,手机/PC的网关地址就是IPC的地址,一般会是192.168.200.1。
  3. 调用无线配置 API(见获取无线扫描AP列表 (无需签名校验)的描述)获取IPC扫描到的AP热点。
  4. 调用无线配置 API(见设置无线参数(无需签名校验)的描述)设置IPC要连接的无线网络(例如无线路由器的SSID和密码),使得IPC能够从网关处获取到IP地址。
  5. 如果网络是可以正常上网的话,IPC取到IP地址后很快就会亮蓝灯,此时表明IPC可以正常连接Internet了。

IPC扫描AP代码见 商米AI识客SDK示例代码->IPC扫描

IPC连接Wifi代码详细见 商米AI识客SDK示例代码->IPC连接AP

5.3 激活

通过 5.2配网 后,IPC通过无线连接到路由或者直接有线连接路由。

由于使用IPC的其它API时需要签名校验,所以在使用API之前需要激活IPC。激活只需要在第一次使用IPC时进行,后续都不再需要激活。

调用active接口既可以激活IPC设备。详细见 商米AI识客SDK示例代码-> 激活IPC

5.4 画面调整

由于IPC的人脸识别对于人脸图像质量有一定要求,因此在使用IPC前需要调整IPC的画面,以达到最好的体验效果。画面调整包括镜头的调焦、对焦。步骤如下:

5.4.1 RTSP 播放

首先需要通过预览画面查看IPC设备镜头是对焦,画面是否清晰。IPC设备是通过RTSP协议传递视频流,所以开发一款RTSP播放器才能看到视频流。

调用VideoStream.getInstance(context).getLiveStream接口可以获取到RTSP播放流的地址。详细代码见 商米AI识客SDK示例代码-> RTSP播放

5.4.2 调焦、对焦

为了更好的人脸识别效果,需要对IPC设备进行调焦对焦。

调用接口BasicConfig.getInstance(context).setZoom调焦; BasicConfig.getInstance(context) .autoFoucus自动进行对焦调焦。

详细代码见 商米AI识客SDK示例代码-> IPC对焦、调焦

6、会员注册

完成会员的注册功能。输入会员的ID、分组、备注信息,并采集用户的人脸,注册人脸特征信息。注册信息的同时,会通过摄像头采集人脸照片传递给IPC设备。

6.1 获取摄像头数据

详细代码见 商米AI识客SDK示例代码->获取摄像头信息

6.2 注册会员信息和人脸信息

详细代码见 商米AI识客SDK示例代码-> 会员注册

7、会员管理

包括会员列表、会员删除、会员查看、会员注册。

会员删除详细代码见 会员删除

会员注册详细代码见  会员注册

8、会员实时查询

主要功能实现了实时的获取摄像头预览数据,并且实时对获取的摄像头数据进行特征提取,根据人脸特征信息查询会员。做到通过人脸查询会员的目的。主要使用到的功能有:实时获取摄像头预览数据以及人脸特征提取两个功能

详细代码见 商米AI识客SDK示例代码->获取摄像头预览信息

详细代码见 商米AI识客SDK示例代码->人脸特征提取

商米AI识客SDK接口说明

1. 商米人脸识别接口

人脸识别详细API详见链接 商米人脸识别

2. IPC管理接口

详细见 设备端SDK

商米AI识客SDK简介

商米AI识客SDK (Android版)是一种面向SUNMI OS设备的人脸识别开发包,配套商米AI识客摄像头使用,SDK主要包含人脸采集、人脸识别、人脸特征数据管理、摄像头配置激活、会员进店提醒等功能,以aar包形式发布。如下是SDK整体框架以及Demo APP架构。

SDK框架图如下:

  • 主要包含四层结构
  • 1、C/C++ library实现人脸特征提取,人脸特征对比等算法功能,并提供人脸库管理(人脸库的添加、查询、删除等操作)
  • 2、JNI层主要是封装C/C++实现的人脸识别的功能,为Java上层提供native接口
  • 3、Java API层使用native层提供的接口为上层 APP提供SunmiFace接口,并提供IPC配置管理、通讯交互的功能
  • 4、Demo APP,使用SDK提供的功能实现人脸识别、人脸库的管理、IPC配置管理、IPC通讯等功能。

人脸识别SDK

1. 概述

SUNMI人脸识别SDK是一种面向安卓设备的人脸技术开发包。此SDK开发包包含人脸检测、人脸识别和人证比对等功能,以arr包+models的形式发布。本文档介绍了SDK的使用说明以及数据结构和接口的定义,便于开发者在调用SDK接口时参考。

1.1. 文档使用范围

该人脸识别接口文档主要适用于人脸识别开发的相关人员参考阅读。

1.2. 功能清单

SUNMI人脸识别SDK主要提供如下功能:

模块功能
人脸检测检测图片中出现人脸的位置,并标记出人脸的五个关键点位置
人脸识别 将当前人脸和数据库中的人脸进行匹配,确定当前人脸身份信息
人证比对采集身份证上的照片,并且判断当前人脸是否和身份证上的人脸匹配

1.3. 开发包SDK的说明

SUNMI人脸识别SDK包含sunmi_facelib.aar文件和models文件夹。其中models文件夹包含一个配置文件和六个模型文件:

文件/文件夹名说明
sunmi_facelib.aarSDK lib库相关代码的arr
models配置文件:config.json模型文件:face_graph.json、face_param.params、detect_graph.json、detect_param.params、liveness_graph.json和liveness_param.params

2. 环境信息

系统环境平台编译环境
Android7及以上arm, arm64NDK

3. Java SDK使用说明

3.1. 获取设备硬件指纹

SUNMI人脸识别SDK的授权需要绑定硬件指纹信息以及Android系统信息。在第一次使用前,开发者可以通过如下代码获取硬件指纹信息提供给商米,商米将验证并提供人脸识别SDK的license授权文件。该文件用于3.6中的验证授权。
注:需保证wifi开关为打开状态。

String fingerprint = SunmiFaceSDK.getDeviceFingerprint(context);

3.2. 导入SDK

在Android Studio项目中导入SDK aar包即可。

3.3. 存放模型文件

模型文件(.json和.params文件)可以存放在SD卡某个路径下,也可以存放在APP文件路径下。请务必保证模型所在路径可以被访问。

3.4. 配置config.json文件

使用模型包中config.json文件作为模板,或者自行创建一个config.json文件,拷贝如下代码。根据3.3中6个文件face_graph.json、face_param.params、detect_graph.json、detect_param.params、liveness_graph.json和liveness_param.params存放的实际路径进行修改。SDK需通过读取此config.json配置文件进行初始化。

{  
    // 人脸识别库文件,此文件在SDK Jnilibs里,一般不需要修改
    "face_lib_path": "libface_lib.so", 
    // 人脸识别库网络描述文件,需要绝对路径 
    "face_graph_path": "/storage/emulated/0/faceTest/face_graph.json",  
    // 人脸识别库网络参数文件,需要绝对路径 
    "face_param_path": "/storage/emulated/0/faceTest/face_param.params",  
    // 人脸检测库文件,此文件在SDK Jnilibs里,一般不需要修改  
     "detect_lib_path": "libdetect_lib.so", 
    // 人脸检测库网络描述文件,需要绝对路径 
     "detect_graph_path": "/storage/emulated/0/faceTest/detect_graph.json",  
    // 人脸检测库网络参数文件,需要绝对路径 
    "detect_param_path": "/storage/emulated/0/faceTest/detect_param.params",  
    // 活体检测库文件,此文件在SDK Jnilibs里,一般不需要修改 
    "liveness_lib_path": "libliveness_lib.so",  
     // 活体检测库网络描述文件,需要绝对路径  
    "liveness_graph_path": "/storage/emulated/0/faceTest/liveness_graph.json",  
     // 活体检测库网络参数文件,需要绝对路径  
    "liveness_param_path": "/storage/emulated/0/faceTest/liveness_param.params",  
    // 人脸库存放路径,需要绝对路径  
    "face_db_file": "/storage/emulated/0/faceTest/sunmi_face.db", 
    // 3D活体检测模型
    "depth_detector": "/storage/emulated/0/faceTest/depth_detector.yml"
}

3.5. 始化SDK

以下为SDK调用init接口执行初始化的示例。init接口参数为3.4中的config.json文件的路径。

String confPath = Environment.getExternalStorageDirectory() + 
"/faceTest/config.json";
int code = SunmiFaceSDK.init(confPath);

3.6. 验证授权文件

使用类似如下代码读取授权文件内容到Java String中,再通过verifyLicense接口验证。若验证通过,可正常调用SDK其他接口。若验证失败,调用SDK其他接口将返回授权错误代码。错误代码为“10”,则表示授权文件无效;错误代码为“11”,则表示授权文件过期。如有授权问题,请联系商米解决。
注:需保证wifi开关为打开状态。

String license = readToString(Environment.getExternalStorageDirectory() + 
"/faceTest/license_valid.txt");
int code = SunmiFaceSDK.verifyLicense(context, license); // context为Android Context

3.7. 配置SDK

SUNMI人脸识别SDK参数都可动态配置,建议先通过getConfig得到当前参数,根据需要将参数修改完成后,再用setConfig接口进行设置。示例代码如下:

SunmiFaceConfigParam param = new SunmiFaceConfigParam();
SunmiFaceSDK.getConfig(param);
param.setDistance_threshold_(1.0f); //范围在1.0~1.2比较合适,越小,人脸识别越严格
param.setYaw_threshold_(50.f);//人脸姿态阈值,设置较小的人脸姿态阈值,阈值越小,人脸姿态要求越严格,保证相对正面的人脸姿态做识别
param.setPitch_threshold_(50.f);
param.setRoll_threshold_(50.f);
param.setMin_face_size(60);//最小人脸检测尺寸,较大较清晰的人脸识别较准确
param.setImage_quality_threshold_(10);//阈值越高,人脸清晰度越好,人脸识别越准确
param.setMin_luminance_(10);//最小光照
param.setMax_luminance_(180);//最大光照
param.setLiveness_on_(true);//开启人脸活体检测
param.setThread_num_(1); //使用一个cpu核心执行人脸检测,人脸识别
int code = SunmiFaceSDK.setConfig(param);

3.8. 提取人脸特征

提取步骤:

  1. 获取的Bitmap图片:用户根据需求,从摄像头获取bitmap传给SDK。
  2. 传入图片的尺寸:人脸SDK检测最佳输入图的宽高比为1:1。若宽高比过大,可能导致检测性能略微下降。
  3. 图像格式处理:将获取的Bitmap图片转为BGR byte buffer格式。(可参考如下示例代码)
  4. 接口调用:传入BGR byte buffer,通过SunmiFaceImage构造函数创建SunmiFaceImage。再通过getImageFeatures接口传入SunmiFaceImage图片数据,得到SunmiFaceImageFeatures人脸结果。
  5. 多人脸识别逻辑:如果有多张人脸,SunmiFaceFeature在SunmiFaceImageFeatures中按照置信度score从高到低排列。
  6. 人脸库记录:faceFeature2FaceDBRecord把得到的人脸特征转换为人脸库的记录,设置相关ID,name。
  7. 资源释放:SunmiFaceImageFeatures在SDK中动态分配内存空间,使用完毕后需要调用接口释放资源。

示例代码如下:

public static byte[] getPixelsBGR(Bitmap image) {
    // 计算图片有多少字节
    int bytes = image.getByteCount();

    ByteBuffer buffer = ByteBuffer.allocate(bytes); // 创建新的buffer
    image.copyPixelsToBuffer(buffer); // 移动字节数据到buffer

    byte[] temp = buffer.array(); // 获取包含数据的底层数组
    byte[] pixels = new byte[(temp.length / 4) * 3]; // 分配空间给BGR

    // 对像素重组
    for (int i = 0; i ‹ temp.length / 4; i++) {
        pixels[i * 3] = temp[i * 4 + 2];        //B
        pixels[i * 3 + 1] = temp[i * 4 + 1];    //G
        pixels[i * 3 + 2] = temp[i * 4];        //R
    }
    return pixels;
}
private void addFeature(String name) {
    if (bitmap == null) {
        Toast.makeText(context, "请先拍照", Toast.LENGTH_SHORT).show();
        return;
    }
    byte[] srcData = FileUtils.getPixelsBGR(bitmap);
    SunmiFaceImage image = new SunmiFaceImage(srcData, bitmap.getHeight(), bitmap.getWidth(), 1);
    SunmiFaceImageFeatures features = new SunmiFaceImageFeatures();
    SunmiFaceSDK.getImageFeatures(image, features);
    SunmiFaceFeature feature_ary = features.getFeatures_();
    Log.e("ma", "face info: " + features.getFeatures_count_());
    if (features.getFeatures_count_() == 0) {
        showId("没有检测到人脸,请重新拍照!");
        return;
    }
    SunmiFaceFeature feature = SunmiFaceLib.SunmiFaceFeatureArray_getitem(feature_ary, 0);
    SunmiFaceDBRecord record = SunmiFaceSDK.faceFeature2FaceDBRecord(feature);
    record.setId_(name);
    record.setName_(name);
    SunmiFaceSDK.addDBRecord(record);
    SunmiFaceSDK.releaseImageFeatures(features);
    Log.e("face", "采集成功 " + etName.getText().toString());
}

3.9. 人脸库添加人脸特征

SunmiFaceDBRecord包含img_id_、id和name三个参数,其中img_id_无需设置,id和name需要调用者进行设置:

  1. img_id_无需设置。调用addDBRecord将记录成功加入到人脸库后,SunmiFaceDBRecord中img_id_会自动被设置为人脸库中代表此图片的唯一id。img_id_可以理解为录入图片的唯一名字,SDK保证返回的img_id不重复。用户可以以img_id为文件名来保存拍摄的人脸照片。根据此img_id可以调用deleteDBRecord来删除这条记录。
  2. id为被录入人脸的人员的唯一id。SDK考虑开发者调用的灵活性,没有对其唯一性进行限制。在通常情况下,建议调用者务必保证id的唯一性,id可理解为一般不会重号的身份证号,食堂卡号,会员号等。
  3. name可以不唯一,允许出现两个人名相同的情况,同时允许每个人录入多张人脸。

示例:
数据库中记录:
用户A,id为0001,姓名张三,图片1,图片2;
用户B, id为0002,姓名也是张三,图片3,图片4,图片5。
用户A和B同名,并且都有多张图片,存储每张图片提取的人脸特征。

3.10. 人脸关键点获取

通过getLandmark_得到人脸关键点数组,在获取数组中的每个关键点信息。示例代码如下:

SunmiFaceFeature feature = SunmiFaceLib.SunmiFaceFeatureArray_getitem(feature_ary, 0);
SunmiFaceLmk lmk_ary = feature.getLandmark_();
for(int i = 0; i ‹ SunmiFaceLibConstants.SUNMI_FACE_LANDMARK_LEN; i++) {
    SunmiFaceLmk lmk = SunmiFaceLib.SunmiFaceLmkArray_getitem(lmk_ary, i);
}

3.11. 搜索人脸库

调用searchDB执行人脸库搜索寻找最相似的人脸。如果SDK判断人脸距离小于阈值,matched设为true,否则为false。示例代码如下:

SunmiFaceDBRecord record = SunmiFaceSDK.faceFeature2FaceDBRecord(feature);
SunmiFaceDBIdInfo info = new SunmiFaceDBIdInfo();
SunmiFaceSDK.searchDB(record, info);
if (info.getIs_matched_()) {
	Log.e("ma", “Found”);
}
else {
Log.e("ma", “Not Found”);
}

3.12. 人脸1:1比对

    分别对要比对的两张图片进行人脸特征的提取,得到类型为SunmiFaceFeature两个人脸特征feature1,feature2。在调用compare1v1接口得到比对结果。getIsMatched()得到比对结果,getDistance()得到两张人脸的距离度量。

SunmiFaceCompareResult result;
int code = SunmiFaceSDK.compare1v1(feature1, feature2, result)
boolean isMatched = result.getIsMatched()
float distance = result.getDistance();

3.13. 3D活体检测

3D活体检测使用奥比中光3D结构光摄像头实现3D活体检测功能。深度图depth为16bit数据,表示物体到摄像头以毫米为单位的距离。需要注意以下几点:

  1. 使用3D活体检测,要求BRG图像分辨率为640×480,深度图分辨率为640×400。
  2. 保证BGR图像和深度图像在时间上是对应的。
  3. 3D活体检测存在一定的真人判断为非活体的概率。所以推荐判断非活体需要执行3次左右来确认。非活体判断为真人的概率低于1%。

3D活体检测的使用步骤如下:

  • 1. 开启3D活体检测,配置阈值(可选)。
SunmiFaceConfigParam param = new SunmiFaceConfigParam();
SunmiFaceSDK.getConfig(param);
param.setLivenessOn(true);
param.setDepthLivenessThreshold(0.1f); //推荐阈值在0.1~0.2
ret = SunmiFaceSDK.setConfig(param);
  • 2. 构造SunmiFaceImage,同时传入BGR图像和深度图像。
SunmiFaceImage image = new SunmiFaceImage(srcData, bitmap.getHeight(), bitmap.getWidth(), depth, depth_height, depth_width, 1);
  • 3. 查看活体判断结果,如果code为FACE_CODE_OK则判断为活体。如果code为FACE_CODE_NOT_LIVENESS则判断为非活体。
int code = SunmiFaceSDK.getImageFeatures(image, features);

4. 数据类型定义

4.1. 类型别名

别名类型说明
SunmiFaceStatusintTypedef,定义在face_type.h 文件中
SunmiFaceHandlevoid*Typedef,定义在face.h 文件中

4.2. 宏

接口使用的数据类型定义在face_type.h头文件中,主要数据如下:

成员说明
SUNMI_FACE_FEATURE_LEN256人脸特征向量长度
SUNMI_FACE_ID_LEN64id字符长度限制
SUNMI_FACE_NAME_LEN64人脸用户名长度
SUNMI_FACE_IMG_ID_LEN64人脸采集图片ID长度
SUNMI_FACE_LANDMARK_LEN5人脸关键点数量

4.3. 枚举类型

接口使用的数据结构定义在face_type.h头文件中。

4.3.1. SunmiFaceStatusCode 商米人脸识别状态码

枚举成员状态码说明
FACE_CODE_OK0正确
FACE_CODE_UNINIT1SDK没有初始化
FACE_CODE_EMPTY_IMAGE2图片为空
FACE_CODE_NO_MODEL3无加载模型文件
FACE_CODE_CONFIG_ERROR4配置错误
FACE_CODE_BAD_ILLUMINATION5光线条件不好
FACE_CODE_POSE_ERROR6面部位置不符合要求
FACE_CODE_SMALL_FACE_SIZE7人脸尺寸太小
FACE_CODE_LOW_IMAGE_QUALITY8人脸图像模糊
FACE_CODE_NOT_LIVENESS9非活体人脸图像
FACE_CODE_LICENSE_ERROR10授权文件无效
FACE_CODE_LICENSE_EXPIRED11授权文件过期
FACE_CODE_IMAGE_ID_ERROR101删除时图像id不存在
FACE_CODE_OTHER_ERROR1000其他错误

4.4. 结构体类型

4.4.1. SunmiFaceRect人脸框位置

成员类型说明
x1_float人脸框左上角横坐标
y1_float人脸框左上角纵坐标
x2_float人脸框右下角横坐标
y2_float人脸框右小角纵坐标
score_float置信度

4.4.2. SunmiFaceLmk人脸关键点坐标

成员类型说明
x_float关键点横坐标
y_float关键点纵坐标

4.4.3. SunmiFaceImage人脸识别输入图像

成员类型说明
buf_unsigned char *图片像素字节地址
buf_len_int字节缓冲区长度
img_w_int图像宽度
img_h_int图像高度
max_face_count_int单图人脸数最大返回值
depth_buf_unsigned char *深度图数据字节地址
depth_buf_len_int深度图数据长度
depth_img_w_int深度图宽度
depth_img_h_int深度图高度

4.4.4. SunmiFacePose人脸姿态

成员类型说明
pitch_float俯仰角度
yaw_float偏航角度
roll_float翻滚角度

4.4.5. SunmiFaceFeature单个特征提取输出信息结构体

成员类型说明
face_rect_SunmiFaceRect人脸矩形框位置
liveness_score_float活体分数
feature_[SUNMI_FACE_FEATURE_LEN]float人脸特征数组
landmark_[SUNMI_FACE_LANDMARK_LEN]SunmiFaceLmk关键点
pose_SunmiFacePose人脸姿态

4.4.6. SunmiFaceImageFeatures多个特征提取输出信息结构体

成员类型说明
features_SunmiFaceFeature *特征数组
features_count_int特征数组长度

4.4.7. SunmiFaceConfigParam人脸配置参数

成员类型说明
thread_num_intSDK人脸检测人脸识别计算使用的线程数量(cpu核数),0代表使用所有的cpu核
distance_threshold_float人脸距离阈值
yaw_threshold_float偏航角度阈值
pitch_threshold_float俯仰角度阈值
roll_threshold_float翻滚角度阈值
min_face_sizeint人脸最小尺寸
image_quality_threshold_float图像质量阈值
min_luminance_int最低亮度
max_luminance_int最高亮度
rgb_liveness_threshold_floatRGB活体检测阈值
depth_liveness_threshold_float3D活体检测阈值
liveness_on_bool活体检测开关

4.4.8. SunmiFaceCompareResult人脸匹配结果

成员类型说明
is_matched_bool如果距离小于人脸间距阈值,则为真,否则为假
distance_float人脸距离

4.4.9. SunmiFaceDBRecord人脸数据库记录

成员类型说明
id_[SUNMI_FACE_ID_LEN]char人脸唯一id
name_[SUNMI_FACE_NAME_LEN]char用户名
img_id_[SUNMI_FACE_IMG_ID_LEN]char人脸采集图像唯一id
feature_[SUNMI_FACE_FEATURE_LEN]float人脸特征

4.4.10. SunmiFaceDBIdInfo人脸数据库信息

成员类型说明
id_[SUNMI_FACE_ID_LEN]char人脸唯一id
name_[SUNMI_FACE_NAME_LEN]char用户名
is_matched_bool如果距离小于人脸间距阈值,则为真,否则为假
distance_float人脸距离

5. C++函数接口定义

对外接口的定义在face.h头文件中。

5.1. 函数接口定义

5.1.1. SunmiFaceGetVersion

函数定义:SUNMI_FACE_API const char* SunmiFaceGetVersion();

函数功能:获取Sunmi人脸识别SDK版本

返回值:SDK版本字符串

5.1.2. SunmiFaceCreate

函数定义:SunmiFaceStatus SunmiFaceCreate(SunmiFaceHandle* handle);

函数功能:创建句柄,用户需要保持这个句柄直到释放

变量类型说明
handleSunmiFaceHandle*输出参数,创建人脸SDK句柄

返回值:SunmiFaceStatus

5.1.3. SunmiFaceInit

函数定义:SunmiFaceStatus SunmiFaceInit(SunmiFaceHandle handle,  const std::string& config_file);

函数功能:使用配置文件初始化SDK

变量类型说明
handleSunmiFaceHandle输出参数,创建人脸SDK句柄
config_fileconst std::string&配置文件路径

返回值:SunmiFaceStatus

5.1.4. SunmiFaceGetErrorString

函数定义:const char* SunmiFaceGetErrorString(SunmiFaceStatus code);

函数功能:通过SunmiFaceStatus得到错误描述字符串

变量类型说明
codeSunmiFaceStatusSunmiFaceStatus code

返回值:错误描述字符串

5.1.5. SunmiFaceVerifyLicense

函数定义:SunmiFaceStatus SunmiFaceVerifyLicense(SunmiFaceHandle handle, const std::string& fingerprint, const std::string& license);

函数功能:验证设备指纹和授权文件是否合法

变量类型说明
handleSunmiFaceHandle输出参数,创建人脸SDK句柄
fingerprintconst std::string&设备指纹字符串
licenseconst std::string&授权文件字符串

返回值:SunmiFaceStatus

5.1.6. SunmiFaceSetConfig

函数定义:SunmiFaceStatus SunmiFaceSetConfig(SunmiFaceHandle handle, const SunmiFaceConfigParam& config);  

函数功能:设置配置信息

变量类型说明
handleSunmiFaceHandle输出参数,创建人脸SDK句柄
configconst SunmiFaceConfigParam&配置参数

返回值:SunmiFaceStatus

5.1.7. SunmiFaceGetConfig

函数定义:SunmiFaceStatus SunmiFaceGetConfig(SunmiFaceHandle handle, SunmiFaceConfigParam& config);

函数功能:获取当前SDK参数

变量类型说明
handleSunmiFaceHandle输出参数,创建人脸SDK句柄
configSunmiFaceConfigParam&配置参数

返回值:SunmiFaceStatus

5.1.8. SunmiFaceRelease

函数定义:SunmiFaceStatus SunmiFaceRelease(SunmiFaceHandle handle);

函数功能:释放句柄

变量类型说明
handleSunmiFaceHandle输出参数,创建人脸SDK句柄

返回值:SunmiFaceStatus

5.1.9. SunmiFaceGetImageFeatures

函数定义:SunmiFaceStatus SunmiFaceGetImageFeatures(SunmiFaceHandle handle, SunmiFaceImage image, SunmiFaceImageFeatures *features);

函数功能:从图像中获取人脸特征

变量类型说明
handleSunmiFaceHandle输出参数,创建人脸SDK句柄
imageSunmiFaceImage输入图片结构体
featuresSunmiFaceImageFeatures *返回人脸特征

返回值:SunmiFaceStatus

5.1.10. SunmiFaceCompare1v1

函数定义:SunmiFaceStatus SunmiFaceCompare1v1(SunmiFaceHandle handle, SunmiFaceFeature *feature1, SunmiFaceFeature *feature2, SunmiFaceCompareResult *compare_result);

函数功能:1:1人脸比对

变量类型说明
handleSunmiFaceHandle输出参数,创建人脸SDK句柄
feature1SunmiFaceFeature *比较特征1
feature2SunmiFaceFeature *比较特征2
compare_resultSunmiFaceCompareResult *比对结果

返回值:SunmiFaceStatus

5.1.11. SunmiFaceReleaseImageFeatures

函数定义:SunmiFaceStatus SunmiFaceReleaseImageFeatures(SunmiFaceImageFeatures *features);

函数功能:释放人脸特征

变量类型说明
featuresSunmiFaceImageFeatures *人脸特征

返回值:SunmiFaceStatus

5.1.12. SunmiFaceInitDB

函数定义:SunmiFaceStatus SunmiFaceInitDB(SunmiFaceHandle handle, const char* db_name);

函数功能:打开人脸数据库文件,如果不存在,则创建空的人脸数据库。SDK初始化时会默认打开config.json里面指定的face_db_file

变量类型说明
handleSunmiFaceHandle输出参数,创建人脸SDK句柄
db_nameconst char*数据库文件名称

返回值:SunmiFaceStatus

5.1.13. SunmiFaceAddDBRecord

函数定义:SunmiFaceStatus SunmiFaceAddDBRecord(SunmiFaceHandle handle, SunmiFaceDBRecord *record);

函数功能:添加一条人脸记录到人脸数据库中

变量类型说明
handleSunmiFaceHandle输出参数,创建人脸SDK句柄
recordSunmiFaceDBRecord *record人脸记录

返回值:SunmiFaceStatus

5.1.14. SunmiFaceSearchDB

函数定义:SunmiFaceStatus SunmiFaceSearchDB(SunmiFaceHandle handle, SunmiFaceDBRecord *record, SunmiFaceDBIdInfo *idInfo);

函数功能:1:N 人脸搜索

变量类型说明
handleSunmiFaceHandle输出参数,创建人脸SDK句柄
recordSunmiFaceDBRecord *人脸库记录结构体
idInfoSunmiFaceDBIdInfo *搜索结果

返回值:SunmiFaceStatus

5.1.15. SunmiFaceDeleteDBRecord

函数定义:SunmiFaceStatus SunmiFaceDeleteDBRecord(SunmiFaceHandle handle, char *img_id);

函数功能:根据图像id删除人脸数据库中的一个人脸记录

变量类型说明
handleSunmiFaceHandle输出参数,创建人脸SDK句柄
img_idchar *人脸采集图像在人脸库里的唯一ID

返回值:SunmiFaceStatus

6. Java函数接口定义

对外接口的定义在SunmiFaceSDK.java文件中。

6.1. 接口类定义

类名说明
SunmiFaceSDK人脸识别接口类名定义

6.2. 函数接口定义

6.2.1. getVersion

函数定义:public static String getVersion()

函数功能:获取Sunmi人脸识别SDK版本号

返回值:SDK版本字符串

6.2.2. Init

函数定义:public static int init(String configPath)

函数功能:初始化SDK

变量类型说明
configPathString配置文件路径

返回值:SunmiFaceStatusCode

6.2.3. verifyLicense

函数定义:public static int verifyLicense(Context context, String license)

函数功能:验证许可证

变量类型说明
contextContextAndroid context
licenseString许可证字符串

返回值:SunmiFaceStatusCode

6.2.4. getDeviceFingerprint

函数定义:public static String getDeviceFingerprint(Context context)

函数功能:获取Android设备指纹

变量类型说明
contextContextandroid context

返回值:设备指纹字符串

6.2.5. getErrorString

函数定义:public static String getErrorString(int code)

函数功能:获得错误字符串

变量类型说明
codeint错误代码

返回值:错误描述字符串

6.2.6. setConfig

函数定义:public static int setConfig(SunmiFaceConfigParam config)

函数功能:设置配置

变量类型说明
configSunmiFaceConfigParamSDK配置参数

返回值:SunmiFaceStatusCode

6.2.7. getConfig

函数定义:public static int getConfig(SunmiFaceConfigParam config)

函数功能:获取当前SDK配置

变量类型说明
configSunmiFaceConfigParamSDK配置参数

返回值:SunmiFaceStatusCode

6.2.8. getImageFeatures

函数定义:public static int getImageFeatures(SunmiFaceImage image, SunmiFaceImageFeatures features)

函数功能:从图像中进行人脸检测和人脸特征提取

变量类型说明
imageSunmiFaceImage输入图像
featuresSunmiFaceImageFeatures返回人脸特征

返回值:SunmiFaceStatusCode

6.2.9. compare1v1

函数定义:public int compare1v1(SunmiFaceFeature feature1, SunmiFaceFeature feature2, SunmiFaceCompareResult compare_result)

函数功能:人脸1:1比对

变量类型说明
features1SunmiFaceFeature人脸特征1
features2SunmiFaceFeature人脸特征2
compare_resultSunmiFaceCompareResult比对结果

返回值:SunmiFaceStatusCode

6.2.10. releaseImageFeatures

函数定义:public static int releaseImageFeatures(SunmiFaceImageFeatures features)

函数功能:释放人脸特征

变量类型说明
featuresSunmiFaceImageFeatures人脸特征

返回值:SunmiFaceStatusCode

6.2.11. initDB

函数定义:public static int initDB(String db_name)

函数功能:初始化新人脸数据库

变量类型说明
db_nameString人脸数据库文件名

返回值:SunmiFaceStatusCode

6.2.12. faceFeature2FaceDBRecord

函数定义:public static SunmiFaceDBRecord faceFeature2FaceDBRecord(SunmiFaceFeature feature)

函数功能:将人脸特征结构体转换成人脸库记录结构体

变量类型说明
featureSunmiFaceFeature人脸特征

返回值:SunmiFaceDBRecord

6.2.13. addDBRecord

函数定义:public static int addDBRecord(SunmiFaceDBRecord record)

函数功能:添加一条记录到人脸数据库,添加成功后通过img_id_可以的到人脸库中图片的ID,后续可以用来删除操作

变量类型说明
recordSunmiFaceDBRecord人脸库记录结构体

返回值:SunmiFaceStatusCode

6.2.14. searchDB

函数定义:public static int searchDB(SunmiFaceDBRecord record, SunmiFaceDBIdInfo idInfo)

函数功能:数据库中1:N人脸比对

变量类型说明
recordSunmiFaceDBRecord要搜索的人脸记录
idInfoSunmiFaceDBIdInfo搜索结果

返回值:SunmiFaceStatusCode

6.2.15. deleteDBRecord

函数定义:public static int deleteDBRecord(String img_id)

函数功能:根据图像id删除人脸数据库中的一条记录

变量类型说明
img_idString人脸采集图像的ID

返回值:SunmiFaceStatusCode