📚 Introduction

react-native-vision-camera-face-detector is a React Native library that integrates with the Vision Camera module to provide face detection functionality. It allows you to easily detect faces in real-time using the front camera and visualize the detected faces on the screen.

If you like this package please give it a ⭐ on GitHub.

🏗️ Features

• Real-time face detection using front camera
• Integration with Vision Camera library
• Adjustable face visualization with customizable styles
• Optional native side auto scaling for face bounds, contour and landmarks
• Can be combined with Skia Frame Processor

🧰 Installation

yarn add react-native-vision-camera-face-detector

Then you need to add react-native-worklets-core plugin to babel.config.js. More details here.

💡 Usage

Recommended way:

import { 
  StyleSheet, 
  Text, 
  View 
} from 'react-native'
import { 
  useEffect, 
  useState,
  useRef
} from 'react'
import {
  Frame,
  useCameraDevice
} from 'react-native-vision-camera'
import {
  Face,
  Camera,
  FaceDetectionOptions
} from 'react-native-vision-camera-face-detector'

export default function App() {
  const faceDetectionOptions = useRef<FaceDetectionOptions>( {
    // detection options
  } ).current

  const device = useCameraDevice('front')

  useEffect(() => {
    (async () => {
      const status = await Camera.requestCameraPermission()
      console.log({ status })
    })()
  }, [device])

  function handleFacesDetection( (
    faces: Face[],
    frame: Frame
  ) { 
    console.log(
      'faces', faces.length,
      'frame', frame.toString()
    )
  })

  return (
    <View style={{ flex: 1 }}>
      {!!device? <Camera
        style={StyleSheet.absoluteFill}
        device={device}
        faceDetectionCallback={ handleFacesDetection }
        faceDetectionOptions={ faceDetectionOptions }
      /> : <Text>
        No Device
      </Text>}
    </View>
  )
}

OBS: If you want to use Skia Frame Processor you should DISABLE auto scaling. See this and this for more details.

Face Detection Options

Option	Description	Default
performanceMode	Favor speed or accuracy when detecting faces.	fast
landmarkMode	Whether to attempt to identify facial landmarks: eyes, ears, nose, cheeks, mouth, and so on.	none
contourMode	Whether to detect the contours of facial features. Contours are detected for only the most prominent face in an image.	none
classificationMode	Whether or not to classify faces into categories such as 'smiling', and 'eyes open'.	none
minFaceSize	Sets the smallest desired face size, expressed as the ratio of the width of the head to width of the image.	0.15
trackingEnabled	Whether or not to assign faces an ID, which can be used to track faces across images. Note that when contour detection is enabled, only one face is detected, so face tracking doesn't produce useful results. For this reason, and to improve detection speed, don't enable both contour detection and face tracking.	false
autoScale	Should auto scale face bounds, contour and landmarks on native side? If this option is disabled all detection results will be relative to frame coordinates, not to screen/preview. This option should be DISABLED if you want to draw on frame using Skia Frame Processor.	false

🔧 Troubleshooting

Here is a common issue when trying to use this package and how you can try to fix it:

• Regular javascript function cannot be shared. Try decorating the function with the 'worklet' keyword...:
  • If you're using react-native-reanimated maybe you're missing this step.

If you find other errors while using this package you're wellcome to open a new issue or create a PR with the fix.

👷 Built With

• React Native
• Google MLKit
• Vision Camera

🔎 About

This package was tested using the following:

• react-native: 0.73.6 (new arch disabled)
• react-native-vision-camera: 4.0.0-beta.11
• react-native-worklets-core: 0.4.0
• react-native-reanimated: 3.8.1
• expo: 50.0.14

Min O.S version:

• Android: SDK 26 (Android 8)
• IOS: 14

📚 Author

Made with ❤️ by nonam4