feat: Create Choreographer

[mrousavy]

Creates Choreographer, a platform specific instance that fires onFrame callbacks at the screen's refresh rate.

The Choreographer instance runs on the Thread that created it. We could create such instances on the UI Thread or any other arbitrary Thread using either react-native-reanimated or react-native-worklets-core.

Currently you can create a Choreographer using the FilamentProxy:

const choreographer = FilamentProxy.createChoreographer()
choreographer.addOnFrameCallback((timestamp: number) => {
  console.log(`onFrame at ${timestamp}`)
})
choreographer.start()
setTimeout(() => {
  choreographer.stop()
}, 1500)

Create on the UI Thread:

runOnUI(() => {
  'worklet'
  const choreographer = FilamentProxy.createChoreographer()
  choreographer.addOnFrameCallback((timestamp: number) => {
    'worklet'
    // TODO: This is currently not possible since we don't have a Worklets integration. This func cannot be called probably.
    // Reanimated did work on something pretty interesting where they abstract all of this on the JS side, meaning there's
    // no change required from our end - we just receive a jsi::Function as normal - but it's not yet public.
    // So to make that work, we need to integrate react-native-reanimated or react-native-worklets-core in RNF for now.
  })
})()

Note: You need to keep a strong reference on the Choreographer, otherwise it might get deleted by GC.