feat: Add onShutter event

mrousavy · mrousavy · commit edc001af68e5 · 2024-02-29T13:23:14.000+01:00
diff --git a/package/android/src/main/java/com/mrousavy/camera/CameraView+Events.kt b/package/android/src/main/java/com/mrousavy/camera/CameraView+Events.kt
@@ -37,6 +37,14 @@ fun CameraView.invokeOnStopped() {
   this.sendEvent(event)
 }
 
+fun CameraView.invokeOnShutter() {
+  Log.i(CameraView.TAG, "invokeOnShutter()")
+
+  val surfaceId = UIManagerHelper.getSurfaceId(this)
+  val event = CameraShutterEvent(surfaceId, id)
+  this.sendEvent(event)
+}
+
 fun CameraView.invokeOnError(error: Throwable) {
   Log.e(CameraView.TAG, "invokeOnError(...):")
   error.printStackTrace()
diff --git a/package/android/src/main/java/com/mrousavy/camera/CameraView+TakeSnapshot.kt b/package/android/src/main/java/com/mrousavy/camera/CameraView+TakeSnapshot.kt
@@ -13,6 +13,8 @@ fun CameraView.takeSnapshot(options: SnapshotOptions): WritableMap {
   Log.i(TAG, "Capturing snapshot of Camera View...")
   val bitmap = previewView.bitmap ?: throw SnapshotFailedError()
 
+  onShutter()
+
   val file = FileUtils.createTempFile(context, "jpg")
   FileUtils.writeBitmapTofile(bitmap, file, options.quality)
 
diff --git a/package/android/src/main/java/com/mrousavy/camera/CameraView.kt b/package/android/src/main/java/com/mrousavy/camera/CameraView.kt
@@ -277,6 +277,10 @@ class CameraView(context: Context) :
     invokeOnStopped()
   }
 
+  override fun onShutter() {
+    invokeOnShutter()
+  }
+
   override fun onCodeScanned(codes: List<Barcode>, scannerFrame: CodeScannerFrame) {
     invokeOnCodeScanned(codes, scannerFrame)
   }
diff --git a/package/android/src/main/java/com/mrousavy/camera/CameraViewManager.kt b/package/android/src/main/java/com/mrousavy/camera/CameraViewManager.kt
@@ -32,6 +32,7 @@ class CameraViewManager : ViewGroupManager<CameraView>() {
       .put("cameraInitialized", MapBuilder.of("registrationName", "onInitialized"))
       .put("cameraStarted", MapBuilder.of("registrationName", "onStarted"))
       .put("cameraStopped", MapBuilder.of("registrationName", "onStopped"))
+      .put("cameraShutter", MapBuilder.of("registrationName", "onShutter"))
       .put("cameraError", MapBuilder.of("registrationName", "onError"))
       .put("cameraCodeScanned", MapBuilder.of("registrationName", "onCodeScanned"))
       .build()
diff --git a/package/android/src/main/java/com/mrousavy/camera/core/CameraSession.kt b/package/android/src/main/java/com/mrousavy/camera/core/CameraSession.kt
@@ -430,7 +430,7 @@ class CameraSession(private val context: Context, private val cameraManager: Cam
     photoOutput.targetRotation = outputOrientation.toDegrees()
     val playSound = enableShutterSound || CameraInfo.mustPlayShutterSound()
 
-    val image = photoOutput.takePicture(playSound, CameraQueues.cameraExecutor)
+    val image = photoOutput.takePicture(playSound, callback, CameraQueues.cameraExecutor)
     val isMirrored = camera.cameraInfo.lensFacing == CameraSelector.LENS_FACING_FRONT
     return Photo(image, isMirrored)
   }
@@ -524,6 +524,7 @@ class CameraSession(private val context: Context, private val cameraManager: Cam
     fun onInitialized()
     fun onStarted()
     fun onStopped()
+    fun onShutter()
     fun onCodeScanned(codes: List<Barcode>, scannerFrame: CodeScannerFrame)
   }
 }
diff --git a/package/android/src/main/java/com/mrousavy/camera/extensions/ImageCapture+takePicture.kt b/package/android/src/main/java/com/mrousavy/camera/extensions/ImageCapture+takePicture.kt
@@ -4,12 +4,13 @@ import android.media.MediaActionSound
 import androidx.camera.core.ImageCapture
 import androidx.camera.core.ImageCaptureException
 import androidx.camera.core.ImageProxy
+import com.mrousavy.camera.core.CameraSession
 import java.util.concurrent.Executor
 import kotlin.coroutines.resume
 import kotlin.coroutines.resumeWithException
 import kotlinx.coroutines.suspendCancellableCoroutine
 
-suspend inline fun ImageCapture.takePicture(enableShutterSound: Boolean, executor: Executor): ImageProxy =
+suspend inline fun ImageCapture.takePicture(enableShutterSound: Boolean, callback: CameraSession.Callback, executor: Executor): ImageProxy =
   suspendCancellableCoroutine { continuation ->
     // Shutter sound
     val shutterSound = if (enableShutterSound) MediaActionSound() else null
@@ -23,6 +24,8 @@ suspend inline fun ImageCapture.takePicture(enableShutterSound: Boolean, executo
           if (enableShutterSound) {
             shutterSound?.play(MediaActionSound.SHUTTER_CLICK)
           }
+
+          callback.onShutter()
         }
 
         override fun onCaptureSuccess(image: ImageProxy) {
diff --git a/package/android/src/main/java/com/mrousavy/camera/types/Events.kt b/package/android/src/main/java/com/mrousavy/camera/types/Events.kt
@@ -19,6 +19,11 @@ class CameraStoppedEvent(surfaceId: Int, viewId: Int) : Event<CameraStoppedEvent
   override fun getEventData(): WritableMap = Arguments.createMap()
 }
 
+class CameraShutterEvent(surfaceId: Int, viewId: Int) : Event<CameraShutterEvent>(surfaceId, viewId) {
+  override fun getEventName() = "cameraShutter"
+  override fun getEventData(): WritableMap = Arguments.createMap()
+}
+
 class CameraErrorEvent(surfaceId: Int, viewId: Int, private val data: WritableMap) : Event<CameraErrorEvent>(surfaceId, viewId) {
   override fun getEventName() = "cameraError"
   override fun getEventData() = data
diff --git a/package/ios/CameraView+TakeSnapshot.swift b/package/ios/CameraView+TakeSnapshot.swift
@@ -30,6 +30,8 @@ extension CameraView {
         // capture was already aborted (timed out)
         return
       }
+      
+      self.onCaptureShutter()
 
       guard let imageBuffer = CMSampleBufferGetImageBuffer(buffer) else {
         promise.reject(error: .capture(.imageDataAccessError))
diff --git a/package/ios/CameraView.swift b/package/ios/CameraView.swift
@@ -62,6 +62,7 @@ public final class CameraView: UIView, CameraSessionDelegate {
   @objc var onError: RCTDirectEventBlock?
   @objc var onStarted: RCTDirectEventBlock?
   @objc var onStopped: RCTDirectEventBlock?
+  @objc var onShutter: RCTDirectEventBlock?
   @objc var onViewReady: RCTDirectEventBlock?
   @objc var onCodeScanned: RCTDirectEventBlock?
   // zoom
@@ -328,6 +329,13 @@ public final class CameraView: UIView, CameraSessionDelegate {
     }
     onStopped([:])
   }
+  
+  func onCaptureShutter() {
+    guard let onShutter = onShutter else {
+      return
+    }
+    onShutter([:])
+  }
 
   func onFrame(sampleBuffer: CMSampleBuffer) {
     #if VISION_CAMERA_ENABLE_FRAME_PROCESSORS
diff --git a/package/ios/CameraViewManager.m b/package/ios/CameraViewManager.m
@@ -55,6 +55,7 @@ @interface RCT_EXTERN_REMAP_MODULE (CameraView, CameraViewManager, RCTViewManage
 RCT_EXPORT_VIEW_PROPERTY(onInitialized, RCTDirectEventBlock);
 RCT_EXPORT_VIEW_PROPERTY(onStarted, RCTDirectEventBlock);
 RCT_EXPORT_VIEW_PROPERTY(onStopped, RCTDirectEventBlock);
+RCT_EXPORT_VIEW_PROPERTY(onShutter, RCTDirectEventBlock);
 RCT_EXPORT_VIEW_PROPERTY(onViewReady, RCTDirectEventBlock);
 // Code Scanner
 RCT_EXPORT_VIEW_PROPERTY(codeScannerOptions, NSDictionary);
diff --git a/package/ios/Core/CameraSessionDelegate.swift b/package/ios/Core/CameraSessionDelegate.swift
@@ -29,6 +29,10 @@ protocol CameraSessionDelegate: AnyObject {
    Called when the [CameraSession] stopped streaming frames. (isActive=false)
    */
   func onCameraStopped()
+  /**
+   Called just before a photo or snapshot is captured.
+   */
+  func onCaptureShutter()
   /**
    Called for every frame (if video or frameProcessor is enabled)
    */
diff --git a/package/ios/Core/PhotoCaptureDelegate.swift b/package/ios/Core/PhotoCaptureDelegate.swift
@@ -16,10 +16,12 @@ private var delegatesReferences: [NSObject] = []
 class PhotoCaptureDelegate: NSObject, AVCapturePhotoCaptureDelegate {
   private let promise: Promise
   private let enableShutterSound: Bool
+  private let cameraSessionDelegate: CameraSessionDelegate
 
-  required init(promise: Promise, enableShutterSound: Bool) {
+  required init(promise: Promise, enableShutterSound: Bool, cameraSessionDelegate: CameraSessionDelegate) {
     self.promise = promise
     self.enableShutterSound = enableShutterSound
+    self.cameraSessionDelegate = cameraSessionDelegate
     super.init()
     delegatesReferences.append(self)
   }
@@ -29,6 +31,9 @@ class PhotoCaptureDelegate: NSObject, AVCapturePhotoCaptureDelegate {
       // disable system shutter sound (see https://stackoverflow.com/a/55235949/5281431)
       AudioServicesDisposeSystemSoundID(1108)
     }
+    
+    // onShutter() event
+    cameraSessionDelegate.onCaptureShutter()
   }
 
   func photoOutput(_: AVCapturePhotoOutput, didFinishProcessingPhoto photo: AVCapturePhoto, error: Error?) {
diff --git a/package/src/Camera.tsx b/package/src/Camera.tsx
@@ -36,6 +36,7 @@ type NativeCameraViewProps = Omit<CameraProps, 'device' | 'onInitialized' | 'onE
   onCodeScanned?: (event: NativeSyntheticEvent<OnCodeScannedEvent>) => void
   onStarted?: (event: NativeSyntheticEvent<void>) => void
   onStopped?: (event: NativeSyntheticEvent<void>) => void
+  onShutter?: () => void
   onViewReady: () => void
 }
 type NativeRecordVideoOptions = Omit<RecordVideoOptions, 'onRecordingError' | 'onRecordingFinished' | 'videoBitRate'> & {
@@ -94,6 +95,7 @@ export class Camera extends React.PureComponent<CameraProps, CameraState> {
     this.onInitialized = this.onInitialized.bind(this)
     this.onStarted = this.onStarted.bind(this)
     this.onStopped = this.onStopped.bind(this)
+    this.onShutter = this.onShutter.bind(this)
     this.onError = this.onError.bind(this)
     this.onCodeScanned = this.onCodeScanned.bind(this)
     this.ref = React.createRef<RefType>()
@@ -438,6 +440,10 @@ export class Camera extends React.PureComponent<CameraProps, CameraState> {
   private onStopped(): void {
     this.props.onStopped?.()
   }
+
+  private onShutter(): void {
+    this.props.onShutter?.()
+  }
   //#endregion
 
   private onCodeScanned(event: NativeSyntheticEvent<OnCodeScannedEvent>): void {
@@ -507,6 +513,7 @@ export class Camera extends React.PureComponent<CameraProps, CameraState> {
         onCodeScanned={this.onCodeScanned}
         onStarted={this.onStarted}
         onStopped={this.onStopped}
+        onShutter={this.onShutter}
         onError={this.onError}
         codeScannerOptions={codeScanner}
         enableFrameProcessor={frameProcessor != null}
diff --git a/package/src/CameraProps.ts b/package/src/CameraProps.ts
@@ -289,6 +289,12 @@ export interface CameraProps extends ViewProps {
    * Called when the camera stopped the session (`isActive={false}`)
    */
   onStopped?: () => void
+  /**
+   * Called just before a photo or snapshot is captured.
+   *
+   * Inside this callback you can play a custom shutter sound or show visual feedback to the user.
+   */
+  onShutter?: () => void
   /**
    * A worklet which will be called for every frame the Camera "sees".
    *

Original file line number	Diff line number	Diff line change
`@@ -277,6 +277,10 @@ class CameraView(context: Context) :`
`277`	`277`	`invokeOnStopped()`
`278`	`278`	`}`
`279`	`279`
	`280`	`+ override fun onShutter() {`
	`281`	`+ invokeOnShutter()`
	`282`	`+ }`
	`283`	`+`
`280`	`284`	`override fun onCodeScanned(codes: List<Barcode>, scannerFrame: CodeScannerFrame) {`
`281`	`285`	`invokeOnCodeScanned(codes, scannerFrame)`
`282`	`286`	`}`
Original file line number	Diff line number	Diff line change
`@@ -430,7 +430,7 @@ class CameraSession(private val context: Context, private val cameraManager: Cam`
`430`	`430`	`photoOutput.targetRotation = outputOrientation.toDegrees()`
`431`	`431`	`val playSound = enableShutterSound \|\| CameraInfo.mustPlayShutterSound()`
`432`	`432`
`433`		`- val image = photoOutput.takePicture(playSound, CameraQueues.cameraExecutor)`
	`433`	`+ val image = photoOutput.takePicture(playSound, callback, CameraQueues.cameraExecutor)`
`434`	`434`	`val isMirrored = camera.cameraInfo.lensFacing == CameraSelector.LENS_FACING_FRONT`
`435`	`435`	`return Photo(image, isMirrored)`
`436`	`436`	`}`
`@@ -524,6 +524,7 @@ class CameraSession(private val context: Context, private val cameraManager: Cam`
`524`	`524`	`fun onInitialized()`
`525`	`525`	`fun onStarted()`
`526`	`526`	`fun onStopped()`
	`527`	`+ fun onShutter()`
`527`	`528`	`fun onCodeScanned(codes: List<Barcode>, scannerFrame: CodeScannerFrame)`
`528`	`529`	`}`
`529`	`530`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,8 @@ extension CameraView {`
`30`	`30`	`// capture was already aborted (timed out)`
`31`	`31`	`return`
`32`	`32`	`}`
	`33`	`+`
	`34`	`+ self.onCaptureShutter()`
`33`	`35`
`34`	`36`	`guard let imageBuffer = CMSampleBufferGetImageBuffer(buffer) else {`
`35`	`37`	`promise.reject(error: .capture(.imageDataAccessError))`