Authentication Camera

Authentication View is an Android library for easy face-recognition authentication usage, developed by ESaS team for own use and for client companies. It incorporates a ready-to-use camera view element, that can gather face images from different angles and pass them to your API for further processing.

Capabilities

• Preview image from camera

• Detect faces on pictures

• Detect face masks and sunglasses

• Direct your client into perfect conditions for identification

• Acquire face images for your own processing

Dependency

Gradle

In your project-level build.gradle specify a Jetpack Navigation plugin dependency.

buildscript {
    dependencies {
        def nav_version = "2.3.5"
        classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version"
        ...
    }
}

Place .aar library file into libs folder in your application module. After that, in your application-level build.gradle add following dependencies and a Jetpack Navigation plugin.

plugins {
    ...
    id 'androidx.navigation.safeargs.kotlin'
    ...
}

dependencies {
    // Includes all .jar and .aar files from ./libs directory
    // Read more on that here: https://developer.android.com/studio/build/dependencies#dependency-types
    implementation fileTree(include: ['*.jar', '*.aar'], dir: 'libs')
    
    // Jetpack Navigation
    def nav_version = "2.3.5"
    implementation "androidx.navigation:navigation-fragment-ktx:$nav_version"
    implementation "androidx.navigation:navigation-ui-ktx:$nav_version"

    // Jetpack Lifecycles
    def lifecycle_version = "2.3.1"
    implementation "androidx.lifecycle:lifecycle-livedata-ktx:$lifecycle_version"
    implementation "androidx.lifecycle:lifecycle-common-java8:$lifecycle_version"
    
    // ML Kit
    implementation 'com.google.mlkit:face-detection:16.1.2'
    
    // PyTorch
    implementation 'org.pytorch:pytorch_android_lite:1.9.0'
    
    // CameraView
    implementation 'com.otaliastudios:cameraview:2.6.1'
    
    // Circular Progress Bar
    implementation 'com.dinuscxj:circleprogressbar:1.3.6'
    
    // Blurkit
    implementation "io.alterac.blurkit:blurkit:1.1.0"
    ...
}

Maven

TODO

How to use

Code

To initialize the procedure, you need to launch ActivityResultContract from your Activity/Fragment.

val authenticationCameraContract = registerForActivityResult(
    AuthenticationCameraContract(),
    this::handleAuthenticationCameraResult
)

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
    super.onViewCreated(view, savedInstanceState)
    
    authenticateButton.setOnClickListener {
        authenticationCameraContract.launch(null)
    }
}

private fun handleAuthenticationCameraResult(photo: String?) {
    if (photo == null) return
    val bitmap = bitmapFromBase64(photo)

    binding.photoImageView.setImageBitmap(bitmap)
}

This launches an Activity, that shows user a guide screen and performs face capture on another screen.

Customization

You can customize your AuthenticationCameraActivity both visually and language-wise. You may override the default theme by inheriting fromAuthenticationCameraTheme:

<style name="Theme.CustomAuthCam" parent="AuthenticationCameraTheme">
    <!-- Encouraging buttons color -->
    <item name="AuthCam_brandColor">#2F62C1</item>
    <item name="AuthCam_onBrandColor">#FFFFFF</item>
    
    <!-- Discouraging buttons color -->
    <item name="AuthCam_discourageColor">#F8F8F8</item>
    <item name="AuthCam_onDiscourageColor">#7C7B7A</item>
    
    <!-- Colors for the progress bar on camera screen -->
    <item name="AuthCam_successColor">#5BB741</item>
    <item name="AuthCam_errorColor">#DA392F</item>
    <item name="AuthCam_neutralColor">#D9D9D9</item>
    
    <!-- Background color and cards color -->
    <item name="AuthCam_backgroundPrimaryColor">#FFFFFF</item>
    <item name="AuthCam_backgroundSecondaryColor">#F8F8F8</item>
    
    <!-- Text colors -->
    <item name="AuthCam_textPrimaryColor">#333333</item>
    <item name="AuthCam_textSecondaryColor">#5B5E67</item>
    
    <!-- Guide screen illustration colors -->
    <item name="AuthCam_illustration_hairColor">#FD4833</item>
    <item name="AuthCam_illustration_backgroundColor">#3D3D3D</item>
    <item name="AuthCam_illustration_progressBarColor">#FFFFFF</item>
    <item name="AuthCam_illustration_strokeColor">#FEFEFE</item>

    <!-- Text appearances for different TextViews (see example below) -->
    <item name="AuthCam_toolbarTextAppearance">@style/Text.Header</item>
    <item name="AuthCam_rulesTextAppearance">@style/Text.Content</item>
    <item name="AuthCam_headerTextAppearance">@style/Text.Header</item>
    <item name="AuthCam_detailsTextAppearance">@style/Text.Details</item>
    <item name="AuthCam_buttonTextAppearance">@style/Text.Button</item>
    
    ...
</style>

<style name="Text.Header">
    <item name="android:textSize">20sp</item>
    <item name="android:fontFamily">@font/roboto_medium</item>
</style>

Please, note that you can customize text colors only through AuthCam_textPrimaryColor and AuthCam_textSecondaryColor and not through any of the text appearance attributes. Also note, that AuthenticationCameraTheme inherits default theme Theme.AppCompat.NoActionBarwith android:statusBarColorset to be the same with the AuthCam_backgroundPrimaryColor, so make sure to add any other customization features to that activity, even if they have nothing to do with AuthCam attributes.

If you choose to customize your activity, please, make sure to override its default theme in your Manifest file the following way:

<application ...>
        
<activity
        android:name="by.esas.authenticationview.presentation.AuthenticationCameraActivity"
        android:theme="@style/Theme.CustomAuthCam"
        tools:replace="android:theme" />
        ...
</application>

You can optionally override string resources that are used in AuthenticationCameraActivity. Here are their ids:

<string name="auth_cam_biometric_template">Biometric template</string>

<string name="auth_cam_bullet">•</string>
<string name="auth_cam_hold_head_straight">Hold your head straight</string>
<string name="auth_cam_keep_face_lit">Keep your face evenly lit</string>
<string name="auth_cam_no_mask_sunglasses">Take off your mask and sunglasses,\nif you have them</string>

<string name="auth_cam_continue">Continue</string>
<string name="auth_cam_cancel">Cancel</string>
<string name="auth_cam_error">Error</string>
<string name="auth_cam_processing">Processing…</string>
<string name="auth_cam_done">Done!</string>
<string name="capturing">Capturing</string>
    
<string name="auth_cam_state_ok">Don\'t move for 3 seconds</string>
<string name="auth_cam_state_multiple_faces">There should be only one face in the frame</string>
<string name="auth_cam_state_too_tilted">Don\'t tilt your head</string>
<string name="auth_cam_state_too_turned">Don\'t turn your head</string>
<string name="auth_cam_state_too_pitched">Don\'t pitch your head</string>

<string name="auth_cam_state_eyes_closed">Open your eyes</string>
<string name="auth_cam_state_image_blurred">Steady your phone</string>
<string name="auth_cam_state_wears_mask_or_sunglasses">Take off your mask and sunglasses</string>

<string name="auth_cam_state_too_far">Come closer to the camera</string>
<string name="auth_cam_state_too_close">Move away from the camera</string>
<string name="auth_cam_state_out_of_screen">Keep your face in frame</string>
<string name="auth_cam_state_face_not_found">We can\'t see you</string>

Just declare strings with same ids in your resources for that.