Release/v8.12.0

CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [8.12.0] - 25-01-09
+
+### Fixed
+
+- Fixed a memory leak on iOS, where the presentationModeManager was holding a strong reference to the fullscreen's target and return views
+- Fixed an issue on iOS where the destruction of the THEOplayerView was not always propagated correctly over the iOS Bridge, resulting in an occasional memory leak.
+- Fixed an issue where, when requesting a text track's cues, the time properties would sometimes be in seconds instead of milliseconds.
+- Fixed a rare crash on Android due to a `java.lang.NullPointerException` when creating the THEOplayerView.
+- Fixed an issue on Android where R8 minification would obfuscate some API class names, which could lead to a crash.
+
+### Added
+
+- Added a `adLoadTimeout` property to `GoogleImaConfiguration` to control the amount of time that the SDK will wait before moving onto the next ad or main content.
+
 ## [8.11.1] - 24-12-18
 
 ### Fixed

android/proguard-rules.pro

@@ -1,3 +1,7 @@
 # Do no warn if any of the API classes we resolve with compileOnly are missing because the feature
 # is disabled: it is expected.
 -dontwarn com.theoplayer.android.api.**
+-dontwarn com.google.android.gms.cast.**
+
+# We rely on gson to instantiate some source classes from json, so make sure they are not obfuscated.
+-keep,includedescriptorclasses class com.theoplayer.android.api.source.** { *; }

android/src/main/java/com/theoplayer/PlayerConfigAdapter.kt

@@ -28,6 +28,7 @@ private const val PROP_RETRY_MAX_BACKOFF = "maximumBackoff"
 private const val PROP_CAST_CONFIGURATION = "cast"
 private const val PROP_ADS_CONFIGURATION = "ads"
 private const val PROP_IMA_CONFIGURATION = "ima"
+private const val PROP_IMA_AD_LOAD_TIMEOUT = "adLoadTimeout"
 private const val PROP_MEDIA_CONTROL = "mediaControl"
 private const val PROP_PPID = "ppid"
 private const val PROP_MAX_REDIRECTS = "maxRedirects"
@@ -169,11 +170,17 @@ class PlayerConfigAdapter(private val configProps: ReadableMap?) {
           }
         }
       }
-      // bitrate is configured under the ima config
+      // bitrate and timeout are configured under the ima config
       configProps?.getMap(PROP_ADS_CONFIGURATION)?.getMap(PROP_IMA_CONFIGURATION)?.run {
         if (hasKey(PROP_BITRATE)) {
           bitrateKbps = getInt(PROP_BITRATE)
         }
+
+        // The time needs to be in milliseconds on android but seconds on ios.
+        // we unify the prop from javascript by multiplying it by 1000 here
+        if (hasKey(PROP_IMA_AD_LOAD_TIMEOUT)) {
+          setLoadVideoTimeout(getInt(PROP_IMA_AD_LOAD_TIMEOUT) * 1000)
+        }
       }
     }
   }

android/src/main/java/com/theoplayer/ReactTHEOplayerContext.kt

@@ -205,7 +205,7 @@ class ReactTHEOplayerContext private constructor(
   }
 
   private fun initializePlayerView() {
-    playerView = object : THEOplayerView(reactContext.currentActivity!!, configAdapter.playerConfig()) {
+    playerView = object : THEOplayerView(reactContext, configAdapter.playerConfig()) {
       private fun measureAndLayout() {
         measure(
           MeasureSpec.makeMeasureSpec(measuredWidth, MeasureSpec.EXACTLY),

example/src/App.tsx

@@ -83,7 +83,7 @@ export default function App() {
 
     player.source = SOURCES[0].source;
 
-    player.backgroundAudioConfiguration = { enabled: true };
+    player.backgroundAudioConfiguration = { enabled: true, shouldResumeAfterInterruption: true };
     player.pipConfiguration = { startsAutomatically: true };
 
     console.log('THEOplayer is ready');

ios/THEOplayerRCTBridge.m

@@ -112,8 +112,6 @@ @interface RCT_EXTERN_REMAP_MODULE(THEORCTPlayerModule, THEOplayerRCTPlayerAPI,
 RCT_EXTERN_METHOD(setTextTrackStyle:(nonnull NSNumber *)node
                   textTrackStyle:(NSDictionary)textTrackStyle)
 
-RCT_EXTERN_METHOD(destroyPlayer:(nonnull NSNumber *)node);
-
 @end
 
 // ----------------------------------------------------------------------------

ios/THEOplayerRCTPlayerAPI.swift

@@ -356,14 +356,4 @@ class THEOplayerRCTPlayerAPI: NSObject, RCTBridgeModule {
             }
         }
     }
-
-    @objc(destroyPlayer:)
-    func destroyPlayer(_ node: NSNumber) -> Void {
-        DispatchQueue.main.async {
-            if let theView = self.bridge.uiManager.view(forReactTag: node) as? THEOplayerRCTView {
-                theView.destroyPlayer()
-            }
-        }
-    }
-
 }

ios/THEOplayerRCTView.swift

@@ -9,15 +9,16 @@ public class THEOplayerRCTView: UIView {
     public private(set) var player: THEOplayer?
     public private(set) var mainEventHandler: THEOplayerRCTMainEventHandler
     public private(set) var broadcastEventHandler: THEOplayerRCTBroadcastEventHandler
-    let theoPlayerViewController = UIViewController()
     var textTrackEventHandler: THEOplayerRCTTextTrackEventHandler
     var mediaTrackEventHandler: THEOplayerRCTMediaTrackEventHandler
     var metadataTrackEventHandler: THEOplayerRCTSideloadedMetadataTrackEventHandler
     var adEventHandler: THEOplayerRCTAdsEventHandler
     var castEventHandler: THEOplayerRCTCastEventHandler
     var presentationModeManager: THEOplayerRCTPresentationModeManager
+    var backgroundAudioManager: THEOplayerRCTBackgroundAudioManager
     var nowPlayingManager: THEOplayerRCTNowPlayingManager
     var remoteCommandsManager: THEOplayerRCTRemoteCommandsManager
+    var pipManager: THEOplayerRCTPipManager
     var pipControlsManager: THEOplayerRCTPipControlsManager
 
     var adsConfig = AdsConfig()
@@ -36,8 +37,8 @@ public class THEOplayerRCTView: UIView {
     }
     var backgroundAudioConfig = BackgroundAudioConfig() {
           didSet {
-              self.updateInterruptionNotifications()
-              self.updateAVAudioSessionMode()
+              self.backgroundAudioManager.updateInterruptionNotifications()
+              self.backgroundAudioManager.updateAVAudioSessionMode()
           }
       }
 
@@ -61,8 +62,10 @@ public class THEOplayerRCTView: UIView {
         self.adEventHandler = THEOplayerRCTAdsEventHandler()
         self.castEventHandler = THEOplayerRCTCastEventHandler()
         self.presentationModeManager = THEOplayerRCTPresentationModeManager()
+        self.backgroundAudioManager = THEOplayerRCTBackgroundAudioManager()
         self.nowPlayingManager = THEOplayerRCTNowPlayingManager()
         self.remoteCommandsManager = THEOplayerRCTRemoteCommandsManager()
+        self.pipManager = THEOplayerRCTPipManager()
         self.pipControlsManager = THEOplayerRCTPipControlsManager()
 
         super.init(frame: .zero)
@@ -71,20 +74,32 @@ public class THEOplayerRCTView: UIView {
     required init?(coder aDecoder: NSCoder) {
         fatalError("[NATIVE] init(coder:) has not been implemented")
     }
+
+    deinit {
+        self.mainEventHandler.destroy()
+        self.textTrackEventHandler.destroy()
+        self.mediaTrackEventHandler.destroy()
+        self.adEventHandler.destroy()
+        self.castEventHandler.destroy()
+        self.nowPlayingManager.destroy()
+        self.remoteCommandsManager.destroy()
+        self.pipManager.destroy()
+        self.pipControlsManager.destroy()
+        self.presentationModeManager.destroy()
+        self.backgroundAudioManager.destroy()
+
+        self.destroyBackgroundAudio()
+        self.player?.removeAllIntegrations()
+        self.player?.destroy()
+        self.player = nil
+        if DEBUG_THEOPLAYER_INTERACTION { PrintUtils.printLog(logText: "[NATIVE] THEOplayer instance destroyed.") }
+    }
 
     override public func layoutSubviews() {
         super.layoutSubviews()
         if let player = self.player {
             player.frame = self.frame
             player.autoresizingMask = [.flexibleBottomMargin, .flexibleHeight, .flexibleLeftMargin, .flexibleRightMargin, .flexibleTopMargin, .flexibleWidth]
-
-            // wrap theoPlayerViewController around the view
-            if theoPlayerViewController.parent == nil,
-               let parentViewController = self.findViewController() {
-                parentViewController.addChild(self.theoPlayerViewController)
-                self.theoPlayerViewController.didMove(toParent: parentViewController)
-                self.theoPlayerViewController.view = self
-            }
         }
     }
 
@@ -97,12 +112,14 @@ public class THEOplayerRCTView: UIView {
             self.mainEventHandler.setPlayer(player)
             self.textTrackEventHandler.setPlayer(player)
             self.mediaTrackEventHandler.setPlayer(player)
-            self.presentationModeManager.setPlayer(player, view: self)
             self.adEventHandler.setPlayer(player)
             self.castEventHandler.setPlayer(player)
             self.nowPlayingManager.setPlayer(player)
             self.remoteCommandsManager.setPlayer(player)
             self.pipControlsManager.setPlayer(player)
+            self.presentationModeManager.setPlayer(player, view: self)
+            self.backgroundAudioManager.setPlayer(player, view: self)
+            self.pipManager.setView(view: self)
             // Attach player to view
             player.addAsSubview(of: self)
         }
@@ -137,28 +154,6 @@ public class THEOplayerRCTView: UIView {
         return self.player
     }
 
-    // MARK: - Destroy Player
-
-    public func destroyPlayer() {
-        self.mainEventHandler.destroy()
-        self.textTrackEventHandler.destroy()
-        self.mediaTrackEventHandler.destroy()
-        self.adEventHandler.destroy()
-        self.castEventHandler.destroy()
-        self.nowPlayingManager.destroy()
-        self.remoteCommandsManager.destroy()
-        self.pipControlsManager.destroy()
-
-        self.destroyBackgroundAudio()
-        self.player?.removeAllIntegrations()
-        self.player?.destroy()
-        self.player = nil
-        if DEBUG_THEOPLAYER_INTERACTION { PrintUtils.printLog(logText: "[NATIVE] THEOplayer instance destroyed.") }
-
-        self.theoPlayerViewController.view = nil
-        self.theoPlayerViewController.removeFromParent()
-    }
-
     func processMetadataTracks(metadataTrackDescriptions: [TextTrackDescription]?) {
         THEOplayerRCTSideloadedMetadataProcessor.loadTrackInfoFromTrackDescriptions(metadataTrackDescriptions) { tracksInfo in
             self.mainEventHandler.setLoadedMetadataTracksInfo(tracksInfo)

ios/THEOplayerRCTViewManager.swift

@@ -16,13 +16,4 @@ class THEOplayerRCTViewManager: RCTViewManager {
     override class func requiresMainQueueSetup() -> Bool {
         return true
     }
-
-    @objc func destroy(_ node: NSNumber) {
-        DispatchQueue.main.async {
-            let theView = self.bridge.uiManager.view(
-                forReactTag: node
-            ) as! THEOplayerRCTView
-            theView.destroyPlayer()
-        }
-    }
 }

ios/ads/THEOplayerRCTView+Ads.swift

@@ -57,6 +57,10 @@ extension THEOplayerRCTView {
             imaRenderSettings.mimeTypes = allowedMimeTypes
         }
 
+        if let adLoadTimeout = self.adsConfig.adsImaConfig.adLoadTimeout {
+            imaRenderSettings.loadVideoTimeout = adLoadTimeout
+        }
+
         // setup integration
         let imaIntegration = GoogleIMAIntegrationFactory.createIntegration(on: player, with: imaSettings)
         imaIntegration.renderingSettings = imaRenderSettings

ios/ads/THEOplayerRCTView+AdsConfig.swift

@@ -21,14 +21,16 @@ struct AdsImaConfig {
     var autoPlayAdBreaks: Bool?
     var sessionID: String?
     var bitrate: Int
+    var adLoadTimeout: TimeInterval?
 
-    init(maxRedirects: UInt, enableDebugMode: Bool, ppid: String? = nil, featureFlags: [String : String]? = nil, autoPlayAdBreaks: Bool? = nil, sessionID: String? = nil, bitrate: Int? = -1) {
+    init(maxRedirects: UInt, enableDebugMode: Bool, ppid: String? = nil, featureFlags: [String : String]? = nil, autoPlayAdBreaks: Bool? = nil, sessionID: String? = nil, bitrate: Int? = -1, adLoadTimeout: TimeInterval? = nil) {
         self.maxRedirects = maxRedirects
         self.enableDebugMode = enableDebugMode
         self.ppid = ppid
         self.featureFlags = featureFlags
         self.autoPlayAdBreaks = autoPlayAdBreaks
         self.sessionID = sessionID
+        self.adLoadTimeout = adLoadTimeout
 #if canImport(THEOplayerGoogleIMAIntegration)
         self.bitrate = bitrate ?? kIMAAutodetectBitrate
 #else
@@ -67,6 +69,9 @@ extension THEOplayerRCTView {
                 if let bitrate = adsImaConfig["bitrate"] as? Int {
                     self.adsConfig.adsImaConfig.bitrate = bitrate
                 }
+                if let adLoadTimeout = adsImaConfig["adLoadTimeout"] as? TimeInterval {
+                    self.adsConfig.adsImaConfig.adLoadTimeout = adLoadTimeout
+                }
             }
         }
     }

ios/backgroundAudio/THEOplayerRCTBackgroundAudioManager.swift

@@ -0,0 +1,105 @@
+// TTHEOplayerRCTBackgroundAudioManager.swift
+
+import Foundation
+import THEOplayerSDK
+import AVFAudio
+import AVKit
+
+struct BackgroundAudioConfig {
+    var enabled: Bool = false
+    var shouldResumeAfterInterruption: Bool = false
+    var audioSessionMode: AVAudioSession.Mode = .moviePlayback
+}
+
+class THEOplayerRCTBackgroundAudioManager: NSObject, BackgroundPlaybackDelegate {
+    // MARK: Members
+    private weak var player: THEOplayer?
+    private weak var view: THEOplayerRCTView?
+
+    // MARK: - player setup / breakdown
+    func setPlayer(_ player: THEOplayer, view: THEOplayerRCTView?) {
+        self.player = player
+        self.view = view
+    }
+
+    // MARK: - destruction
+    func destroy() {
+        self.cancelInterruptionNotifications()
+    }
+
+    // MARK: - logic
+    func shouldContinueAudioPlaybackInBackground() -> Bool {
+        if let view = self.view {
+            view.nowPlayingManager.updateNowPlaying()
+            return view.backgroundAudioConfig.enabled
+        }
+        return false
+    }
+
+    func cancelInterruptionNotifications() {
+        NotificationCenter.default.removeObserver(self,
+                                                  name: AVAudioSession.interruptionNotification,
+                                                  object: AVAudioSession.sharedInstance())
+    }
+
+    func updateInterruptionNotifications() {
+        guard let view = self.view else { return }
+
+        // Get the default notification center instance.
+        if view.backgroundAudioConfig.shouldResumeAfterInterruption {
+            NotificationCenter.default.addObserver(self,
+                                                   selector: #selector(handleInterruption),
+                                                   name: AVAudioSession.interruptionNotification,
+                                                   object: AVAudioSession.sharedInstance())
+        } else {
+            NotificationCenter.default.removeObserver(self,
+                                                      name: AVAudioSession.interruptionNotification,
+                                                      object: AVAudioSession.sharedInstance())
+        }
+    }
+
+    func updateAVAudioSessionMode() {
+        guard let view = self.view else { return }
+
+        do {
+            THEOplayer.automaticallyManageAudioSession = (view.backgroundAudioConfig.audioSessionMode == .moviePlayback)
+            try AVAudioSession.sharedInstance().setCategory(AVAudioSession.Category.playback, mode: view.backgroundAudioConfig.audioSessionMode)
+            if view.backgroundAudioConfig.audioSessionMode != .moviePlayback {
+                if DEBUG_INTERRUPTIONS { PrintUtils.printLog(logText: "[NATIVE] AVAudioSession mode updated to \(view.backgroundAudioConfig.audioSessionMode.rawValue)") }
+            }
+        } catch {
+            if DEBUG_INTERRUPTIONS { PrintUtils.printLog(logText: "[NATIVE] Unable to update AVAudioSession mode to \(view.backgroundAudioConfig.audioSessionMode.rawValue): \(error)") }
+        }
+    }
+
+    @objc func handleInterruption(notification: Notification) {
+        guard let userInfo = notification.userInfo,
+              let typeValue = userInfo[AVAudioSessionInterruptionTypeKey] as? UInt,
+              let type = AVAudioSession.InterruptionType(rawValue: typeValue) else {
+            return
+        }
+
+        // Switch over the interruption type.
+        switch type {
+        case .began:
+            // An interruption began. Update the UI as necessary.
+            if DEBUG_INTERRUPTIONS { PrintUtils.printLog(logText: "[NATIVE] An interruption began")}
+        case .ended:
+            // An interruption ended. Resume playback, if appropriate.
+            if DEBUG_INTERRUPTIONS { PrintUtils.printLog(logText: "[NATIVE] An interruption ended")}
+            guard let optionsValue = userInfo[AVAudioSessionInterruptionOptionKey] as? UInt else { return }
+            let options = AVAudioSession.InterruptionOptions(rawValue: optionsValue)
+            if options.contains(.shouldResume) {
+                // An interruption ended. Resume playback.
+                if let player = self.player {
+                    if DEBUG_INTERRUPTIONS { PrintUtils.printLog(logText: "[NATIVE] Ended interruption should resume playback => play()")}
+                    player.play()
+                }
+            } else {
+                // An interruption ended. Don't resume playback.
+                if DEBUG_INTERRUPTIONS { PrintUtils.printLog(logText: "[NATIVE] Ended interruption should not resume playback.")}
+            }
+        default: ()
+        }
+    }
+}