react-native-vision-camera/android
Marc Rousavy 30b56153db
feat: Sync Frame Processors (plus runAsync and runAtTargetFps) (#1472)
Before, Frame Processors ran on a separate Thread.

After, Frame Processors run fully synchronous and always at the same FPS as the Camera.

Two new functions have been introduced:

* `runAtTargetFps(fps: number, func: () => void)`: Runs the given code as often as the given `fps`, effectively throttling it's calls.
* `runAsync(frame: Frame, func: () => void)`: Runs the given function on a separate Thread for Frame Processing. A strong reference to the Frame is held as long as the function takes to execute.

You can use `runAtTargetFps` to throttle calls to a specific API (e.g. if your Camera is running at 60 FPS, but you only want to run face detection at ~25 FPS, use `runAtTargetFps(25, ...)`.)

You can use `runAsync` to run a heavy algorithm asynchronous, so that the Camera is not blocked while your algorithm runs. This is useful if your main sync processor draws something, and your async processor is doing some image analysis on the side. 

You can also combine both functions.

Examples:

```js
const frameProcessor = useFrameProcessor((frame) => {
  'worklet'
  console.log("I'm running at 60 FPS!")
}, [])
```

```js
const frameProcessor = useFrameProcessor((frame) => {
  'worklet'
  console.log("I'm running at 60 FPS!")

  runAtTargetFps(10, () => {
    'worklet'
    console.log("I'm running at 10 FPS!")
  })
}, [])
```



```js
const frameProcessor = useFrameProcessor((frame) => {
  'worklet'
  console.log("I'm running at 60 FPS!")

  runAsync(frame, () => {
    'worklet'
    console.log("I'm running on another Thread, I can block for longer!")
  })
}, [])
```

```js
const frameProcessor = useFrameProcessor((frame) => {
  'worklet'
  console.log("I'm running at 60 FPS!")

  runAtTargetFps(10, () => {
    'worklet'
    runAsync(frame, () => {
      'worklet'
      console.log("I'm running on another Thread at 10 FPS, I can block for longer!")
    })
  })
}, [])
```
2023-02-15 16:47:09 +01:00
..
.settings Bootstrap 2021-02-19 16:07:53 +01:00
gradle/wrapper chore: Upgrade to RN 71 (#1465) 2023-02-09 11:52:41 +01:00
src/main feat: Sync Frame Processors (plus runAsync and runAtTargetFps) (#1472) 2023-02-15 16:47:09 +01:00
.editorconfig Devops: KTLint to lint Kotlin code (#6) 2021-02-26 10:56:20 +01:00
.project Bootstrap 2021-02-19 16:07:53 +01:00
build.gradle feat: Replace Reanimated with RN Worklets (#1468) 2023-02-13 15:22:45 +01:00
CMakeLists.txt feat: Replace Reanimated with RN Worklets (#1468) 2023-02-13 15:22:45 +01:00
gradle.properties chore: Upgrade to RN 71 (#1465) 2023-02-09 11:52:41 +01:00
gradlew chore: Upgrade to RN 71 (#1465) 2023-02-09 11:52:41 +01:00
gradlew.bat Upgrade Example to RN 0.64 (#83) 2021-03-19 15:53:19 +01:00
README.md Add "check-all" script 2021-03-09 12:19:18 +01:00
settings.gradle feat: Replace Reanimated with RN Worklets (#1468) 2023-02-13 15:22:45 +01:00

android

This folder contains the Android-platform-specific code for react-native-vision-camera.

Prerequesites

  1. Install ktlint
    brew install ktlint
    

Getting Started

It is recommended that you work on the code using the Example project (example/android/), since that always includes the React Native header files, plus you can easily test changes that way.

You can however still edit the library project here by opening this folder with Android Studio.

Committing

Before committing, make sure that you're not violating the Kotlin codestyles. To do that, run the following command:

yarn check-android

This will also try to automatically fix any errors by re-formatting the Kotlin code.