feat(session-replay): add preferred frame rate to display link wrapper

SentryTestUtils/TestDisplayLinkWrapper.swift

@@ -17,9 +17,32 @@ public enum FrameRate: UInt64 {
     }
 }
 
+public struct FrameRateRange {
+    public let minimum: Float
+    public let maximum: Float
+    public let preferred: Float?
+
+    public init(minimum: Float, maximum: Float, preferred: Float?) {
+        self.minimum = minimum
+        self.maximum = maximum
+        self.preferred = preferred
+    }
+
+    @available(iOS 15.0, tvOS 15.0, *)
+    fileprivate static func from(_ range: CAFrameRateRange) -> FrameRateRange {
+        return FrameRateRange(
+            minimum: range.minimum,
+            maximum: range.maximum,
+            preferred: range.preferred
+        )
+    }
+}
+
 public class TestDisplayLinkWrapper: SentryDisplayLinkWrapper {
     public var target: AnyObject!
     public var selector: Selector!
+    public var preferredFrameRateRange: FrameRateRange?
+    public var preferredFramesPerSecond: Int?
     public var currentFrameRate: FrameRate = .low
 
     private let frozenFrameThreshold = 0.7
@@ -43,15 +66,28 @@ public class TestDisplayLinkWrapper: SentryDisplayLinkWrapper {
 
     public var ignoreLinkInvocations = false
     public var linkInvocations = Invocations<Void>()
-    public override func link(withTarget target: Any, selector sel: Selector) {
+
+    @available(iOS 15.0, tvOS 15.0, *)
+    public override func link( withTarget target: Any, selector sel: Selector, preferredFrameRateRange: CAFrameRateRange) {
         if ignoreLinkInvocations == false {
             linkInvocations.record(Void())
             self.target = target as AnyObject
             self.selector = sel
+            self.preferredFrameRateRange = FrameRateRange.from(preferredFrameRateRange)
         	_isRunning = true
         }
     }
 
+    public override func link(withTarget target: Any, selector sel: Selector, preferredFramesPerSecond fps: Int) {
+        if ignoreLinkInvocations == false {
+            linkInvocations.record(Void())
+            self.target = target as AnyObject
+            self.selector = sel
+            self.preferredFramesPerSecond = fps
+            _isRunning = true
+        }
+    }
+
     public override var timestamp: CFTimeInterval {
         return dateProvider.systemTime().toTimeInterval()
     }

Sources/Sentry/SentryFramesTracker.m

@@ -168,7 +168,10 @@
 
     _isRunning = YES;
 
-    [_displayLinkWrapper linkWithTarget:self selector:@selector(displayLinkCallback)];
+    // Set the display link to use the default frame rate of 60 fps.
+    [_displayLinkWrapper linkWithTarget:self
+                               selector:@selector(displayLinkCallback)
+               preferredFramesPerSecond:-1];
 }
 
 - (void)displayLinkCallback

Sources/Sentry/include/SentryDisplayLinkWrapper.h

@@ -2,6 +2,8 @@
 
 #if SENTRY_HAS_UIKIT
 
+#    import <QuartzCore/QuartzCore.h>
+
 NS_ASSUME_NONNULL_BEGIN
 
 /**
@@ -13,7 +15,25 @@ NS_ASSUME_NONNULL_BEGIN
 
 @property (readonly, nonatomic) CFTimeInterval targetTimestamp API_AVAILABLE(ios(10.0), tvos(10.0));
 
-- (void)linkWithTarget:(id)target selector:(SEL)sel;
+/**
+ * Link the display link to the target and selector with the preferred frames per second.
+ * @param target The target of the selector.
+ * @param sel The selector to call on the target.
+ * @param fps The preferred frames per second. Setting to `-1` will use the default frames per
+ * second.
+ */
+- (void)linkWithTarget:(id)target selector:(SEL)sel preferredFramesPerSecond:(NSInteger)fps;
+
+/**
+ * Link the display link to the target and selector with the preferred frame rate range.
+ * @param target The target of the selector.
+ * @param sel The selector to call on the target.
+ * @param preferredFrameRateRange The preferred frame rate range. Use `CAFrameRateRangeDefault` to
+ * use the  default frame rate range.
+ */
+- (void)linkWithTarget:(id)target
+                   selector:(SEL)sel
+    preferredFrameRateRange:(CAFrameRateRange)preferredFrameRateRange API_AVAILABLE(ios(15.0));
 
 - (void)invalidate;
 

Sources/Sentry/include/SentryDisplayLinkWrapper.m

@@ -18,9 +18,23 @@
     return displayLink.targetTimestamp;
 }
 
-- (void)linkWithTarget:(id)target selector:(SEL)sel
+- (void)linkWithTarget:(id)target
+                    selector:(SEL)sel
+    preferredFramesPerSecond:(NSInteger)preferredFramesPerSecond
 {
     displayLink = [CADisplayLink displayLinkWithTarget:target selector:sel];
+    if (preferredFramesPerSecond >= 0) {
+        displayLink.preferredFramesPerSecond = preferredFramesPerSecond;
+    }
+    [displayLink addToRunLoop:[NSRunLoop mainRunLoop] forMode:NSRunLoopCommonModes];
+}
+
+- (void)linkWithTarget:(id)target
+                   selector:(SEL)sel
+    preferredFrameRateRange:(CAFrameRateRange)preferredFrameRateRange API_AVAILABLE(ios(15.0))
+{
+    displayLink = [CADisplayLink displayLinkWithTarget:target selector:sel];
+    displayLink.preferredFrameRateRange = preferredFrameRateRange;
     [displayLink addToRunLoop:[NSRunLoop mainRunLoop] forMode:NSRunLoopCommonModes];
 }
 

Sources/Swift/Integrations/SessionReplay/SentrySessionReplay.swift

@@ -56,17 +56,20 @@
         self.replayMaker = replayMaker
         self.breadcrumbConverter = breadcrumbConverter
         self.touchTracker = touchTracker
+        super.init()
     }
 
-    deinit { displayLink.invalidate() }
+    deinit {
+        disconnectDisplayLink()
+    }
 
     func start(rootView: UIView, fullSession: Bool) {
         SentryLog.debug("[Session Replay] Starting session replay with full session: \(fullSession)")
         guard !isRunning else { 
             SentryLog.debug("[Session Replay] Session replay is already running, not starting again")
             return 
         }
-        displayLink.link(withTarget: self, selector: #selector(newFrame(_:)))
+        connectDisplayLink()
         self.rootView = rootView
         lastScreenShot = dateProvider.date()
         videoSegmentStart = nil
@@ -101,7 +104,7 @@
         lock.lock()
         defer { lock.unlock() }
 
-        displayLink.invalidate()
+        disconnectDisplayLink()
         if isFullSession {
             prepareSegmentUntil(date: dateProvider.date())
         }
@@ -128,7 +131,7 @@
         }
 
         videoSegmentStart = nil
-        displayLink.link(withTarget: self, selector: #selector(newFrame(_:)))
+        connectDisplayLink()
     }
 
     func captureReplayFor(event: Event) {
@@ -194,7 +197,7 @@
     }
 
     @objc 
-    private func newFrame(_ sender: CADisplayLink) {
+    private func displayLinkDidUpdateAction(_ sender: CADisplayLink) {
         guard let lastScreenShot = lastScreenShot, isRunning &&
                 !(isFullSession && isSessionPaused) //If replay is in session mode but it is paused we dont take screenshots
         else { return }
@@ -362,7 +365,22 @@
             replayMaker.addFrameAsync(image: image, forScreen: screen)
         }
     }
+
+    // - MARK: - Display Link
+
+    func connectDisplayLink() {
+        if #available(iOS 15.0, tvOS 15.0, *) {
+            let preferredFrameRateRange = CAFrameRateRange(minimum: Float(replayOptions.frameRate), maximum: Float(replayOptions.frameRate))
+            displayLink.link(withTarget: self, selector: #selector(displayLinkDidUpdateAction(_:)), preferredFrameRateRange: preferredFrameRateRange)
+        } else {
+            let preferredFramesPerSecond = Int(replayOptions.frameRate)
+            displayLink.link(withTarget: self, selector: #selector(displayLinkDidUpdateAction(_:)), preferredFramesPerSecond: preferredFramesPerSecond)
+        }
+    }
+
+    func disconnectDisplayLink() {
+        displayLink.invalidate()
+    }
 }
 // swiftlint:enable type_body_length
-
 #endif