face-engine

Utilities for face recognition.

License

License

GroupId

GroupId

com.github.charleslzq
ArtifactId

ArtifactId

face-engine
Last Version

Last Version

1.0.2-RC1
Release Date

Release Date

Type

Type

aar
Description

Description

face-engine
Utilities for face recognition.
Project URL

Project URL

https://github.com/charleslzq/ArcSoftTool/
Source Code Management

Source Code Management

https://github.com/charleslzq/ArcSoftTool/

Download face-engine

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.charleslzq/face-engine/ -->
<dependency>
    <groupId>com.github.charleslzq</groupId>
    <artifactId>face-engine</artifactId>
    <version>1.0.2-RC1</version>
    <type>aar</type>
</dependency>
// https://jarcasting.com/artifacts/com.github.charleslzq/face-engine/
implementation 'com.github.charleslzq:face-engine:1.0.2-RC1'
// https://jarcasting.com/artifacts/com.github.charleslzq/face-engine/
implementation ("com.github.charleslzq:face-engine:1.0.2-RC1")
'com.github.charleslzq:face-engine:aar:1.0.2-RC1'
<dependency org="com.github.charleslzq" name="face-engine" rev="1.0.2-RC1">
  <artifact name="face-engine" type="aar" />
</dependency>
@Grapes(
@Grab(group='com.github.charleslzq', module='face-engine', version='1.0.2-RC1')
)
libraryDependencies += "com.github.charleslzq" % "face-engine" % "1.0.2-RC1"
[com.github.charleslzq/face-engine "1.0.2-RC1"]

Dependencies

compile (15)

Group / Artifact Type Version
com.github.charleslzq : face-store jar 1.0.1-RC2
joda-time : joda-time jar 2.9.9
io.fotoapparat.fotoapparat » library jar 2.2.0
io.fotoapparat.fotoapparat » adapter-rxjava2 jar 2.2.0
org.jetbrains.kotlin : kotlin-stdlib jar 1.2.41
org.jetbrains.kotlinx : kotlinx-coroutines-core jar 0.22.5
org.jetbrains.kotlinx : kotlinx-coroutines-android jar 0.22.5
io.reactivex.rxjava2 : rxjava jar 2.0.2
io.reactivex.rxjava2 : rxandroid jar 2.0.0
com.github.charleslzq : TP-libuvccamera jar 1.0.0
com.github.charleslzq : TP-usbCameraCommon jar 1.0.0
com.android.support » support-compat jar 27.1.1
com.google.code.gson : gson jar 2.8.2
com.fatboyindustrial.gson-jodatime-serialisers : gson-jodatime-serialisers jar 1.6.0
com.serenegiant » common jar 1.5.20

Project Modules

There are no modules declared in this project.

简介

本项目提供了了人脸识别的两个组件: FaceDetectView和FaceEngine. 前者主要用于从安卓设备 自带摄像头或者外接UVC摄像头中获取相片流.后者用于对图片进行处理, 提取相关信息等, 是个通用的接口, 本 项目还提供了arcsoft的离线人脸识别引擎对该接口的实现以及百度在线人脸api对该引擎的对接.

使用

在项目根目录下的build.gradle里面加入maven中央仓库, 如下所示

allprojects {
    repositories {
        // 其它仓库, 如google()等
        mavenCentral()
    }
}

在要使用该库的模块的build.gradle中加入如下依赖(使用arcsoft离线识别引擎):

dependencies {
    // 其它依赖
    implementation 'com.github.charleslzq:arcsoft-binding:1.0.2-RC1'
}

或者使用百度在线人脸api

dependencies {
    // 其它依赖
    implementation 'com.github.charleslzq:baidu-binding:1.0.2-RC1'
}

另外还需要加入以下代码避免报错:

android {
    //其它配置, 如sdk版本等

    packagingOptions {
        exclude 'META-INF/rxjava.properties'
    }
}

FaceDetectView

该组件有其生命周期, 一般跟包含它的activity或者fragment同步. 在xml中有如下配置参数

1. showTrackRect 布尔型,是否在View中显示检测到头像的方框, 默认为true
2. rectColor 颜色, 显示方框边框的颜色, 默认为Color.RED
3. rectWidth demension, 显示方框边框的宽度, 默认为1f
4. enableSample 是否启用采样, 默认为true
5. sampleInterval integer, 取样间隔, 每隔该时间发送一次相片取样, 单位毫秒, 默认为500. 仅在enableSample为true时生效
6. autoSwitchToNewDevice 是否在新摄像头可用时自动切到新摄像头上,默认为true
7. previewResolution 预览分辨率偏好, 可以为HIGHEST或者LOWEST, 默认为HIGHEST. 更为精细的选择需要通过在代码中调用FaceDetectView.updateConfiguration方法实现
8. taskRunner 指定异步任务运行的方式, 可以为RX(使用rxjava进行任务管理)或者COROUTINE(使用kotlin协程), 默认为COROUTINE.

获取相片流在创建时调用其onPreview接口即可, java需实现FrameConsumer接口, 如下所示:

faceDetectView.onPreview(new FrameConsumer() {
            @Override
            public void accept(@NotNull PreviewFrame previewFrame) {
                // 处理收到的数据
            }
        });

该接口有多个重载版本, 可指定超时时间(默认为2秒). 收到的数据类型为PreviewFrame, 可能包含的各字段含义如下:

1. source 相片来源, 为camera的标识符
2. size 相片大小, Resolution类型, 可获取长\宽\面积\长宽比等数据
3. image byte数组, 图像原始数据, 为nv21编码
4. rotation 倾斜角度
5. sequence 该相片的序号, 可能为空

该组件可获取安卓内置摄像头(底层使用Fotoapparat)以及外接UVC摄像头(底层使用UVCCamera), 启动时按UVC 摄像头\前置摄像头\后置摄像头的顺序进行检测, 并打开第一个可用的摄像头. .

FaceEngine

该接口是人脸离线识别的通用接口, 并带有三个泛型参数, 含义按顺序如下:

1. 所处理的包含图像数据的类
2. 包含人元信息的类
3. 包含人脸元信息的类

并提供了两个基础接口

1. detect 用于从图片中检测人脸
2. search 用于根据图片搜索对应的用户

离线引擎还包括两个泛型参数,分别用于表示人脸相似度的类和存储人脸数据.

本项目提供了arcsoft的实现ArcSoftFaceEngine和调用百度在线api的实现BaiduFaceEngine, 都通过服务的方式 提供人脸识别的基础功能, 包括人脸识别与比较, 检测性别与年龄等等. arcsoft模块默认提供了两种服务:

1. LocalArcSoftEngineService 所有数据都保存在本地, 不跟服务器端进行交互
2. WebSocketArcSoftEngineService 当尝试把新数据写入时, 它将通过websocket会向服务器端发送数据而不是保存到本地. 同时接受通过服务器端通过websocket推送过来的数据.

这些服务除了最基础的接口外, 还提供了年龄和性别检测的接口

百度模块则提供了一个后台服务 BaiduFaceEngineServiceBackground. 该服务也提供了直接调用百度api的接口, 各接口和百度人脸接口一一对应.

本项目同时提供了一些工具类:

1. ImageUtils, 其toBitmap方法可将包含NV21编码的图像原始数据转换成Bitmap, toEncodedBytes方法用于将图像编码,使其符合百度的要求
2. Nv21ImageUtils, 其toNv21Bytes方法提供相反的转换,即bitmap转换成Nv21编码的byte数组

ArcSoft的配置

sample和sample-java项目assets目录下有一个sample.arcsoft.keys, 将其拷到项目的assets文件夹 下并更名为arcsoft.keys, 填上从arcsoft官网获取到的app id, key等即可. 具体参数的配置在sample/sample-java资源 values目录的ArcSoftSetting.xml里面, 参照它以及arcsoft官网的说明进行配置即可.

百度引擎的配置

因为调用百度的api需要使用在百度云服务上申请的token等信息, 为了保证token的安全, 百度建议将token放在服务器端, 所以百度模块需要配合服务器端库baifu-face-server使用. 可以通过string属性Baidu_Base或者BaiduFaceEngine 的setUrl方法配置服务器地址. 另外百度客户端的接口底层使用kotlin的协程实现, 在java中调用时需要使用CoroutineSupport 的blockingGet方法, 如下所示:

CoroutineSupport.blockingGet(baiduFaceEngineService.listGroup(0, 100))

另外百度的人脸搜索功能需要指定用户组, 直接调用BaiduFaceEngine的search方法将会传入空的用户组造成搜索失败, 可用searchWithOptions方法代替, 或者更新BaiduFaceEngine的defaultSearchOption字段.

Versions

Version
1.0.2-RC1
1.0.1
1.0.1-RC2
1.0.1-RC1
1.0.0
1.0.0-RC4
1.0.0-RC3
1.0.0-RC2
1.0.0-RC1