Merge pull request #653 from THEOplayer/release/v10.1.0

Release/v10.1.0

Author: tvanlaerhoven

CHANGELOG.md

@@ -5,6 +5,25 @@ 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).
 
+## [10.1.0] - 25-10-06
+
+### Added
+
+- Added an explicit clearing of the NowPlayingInfo on iOS, when the app receives a `willTerminateNotification`, to make sure all NowPlayingInfo is removed from the lock screen when an app is closed.
+- Added `videoWidth` and `videoHeight` properties to `THEOplayer` containing the active video's resolution in pixels.
+- Added `videoresize` player event enabling monitoring of video rendition resizes.
+- Added `dimensionchange` player event enabling monitoring of player resizes. This event is set to replace the now deprecated `resize` player event.
+- Added `fontPath` to `TextTrackStyle` to allow loading custom fonts from the Android assets folder.
+
+### Fixed
+
+- Fixed an issue on Android where play-out of Millicast sources in the example app would fail. The Android NDK version needs to be at least v28.
+- Fixed an issue on Web where on older devices the `display: contents` style property is sometimes not supported.
+- Fixed an issue on Android where the `MediaPlaybackService` could be restarted after the app was closed, in some cases causing a `ForegroundServiceDidNotStartInTimeException`. A conditional receiver makes sure the service is never restarted.
+- Fixed an issue on iOS where a setup with multiple players could cause a view index NSInternalInconsistencyException after moving players in and out of fullscreen.
+- Fixed an issue on Android where some event listeners were not properly disposed of after destroying the player.
+- Fixed an issue on Web where the `width` and `height` properties on `THEOplayer` would show the active video rendition's resolution width and height instead of the width and height of the video element.
+
 ## [10.0.0] - 25-09-15
 
 ### Added

android/build.gradle

@@ -43,12 +43,12 @@ def enabledMediaSession = safeExtGet("THEOplayer_extensionMediaSession", 'true')
 def enabledMillicast = safeExtGet("THEOplayer_extensionMillicast", 'false').toBoolean()
 
 android {
-    compileSdk safeExtGet('THEOplayer_compileSdkVersion', 35)
+    compileSdk safeExtGet('THEOplayer_compileSdkVersion', 36)
     namespace "com.theoplayer"
 
     defaultConfig {
         minSdkVersion safeExtGet('THEOplayer_minSdkVersion', 23)
-        targetSdkVersion safeExtGet('THEOplayer_targetSdkVersion', 35)
+        targetSdkVersion safeExtGet('THEOplayer_targetSdkVersion', 36)
         versionCode 1
         versionName "1.0"
 
@@ -124,16 +124,15 @@ repositories {
     mavenLocal()
 }
 
-// The minimum supported THEOplayer version is 9.9.0
-def theoVersion = safeExtGet('THEOplayer_sdk', '[9.9.0, 11.0.0)')
+// The minimum supported THEOplayer version is 10.0.1
+def theoVersion = safeExtGet('THEOplayer_sdk', '[10.0.1, 11.0.0)')
 def theoMediaSessionVersion = safeExtGet('THEOplayer_mediasession', '[8.0.0, 11.0.0)')
 def theoAdsWrapperVersion = "10.0.0"
 def coroutinesVersion = safeExtGet('coroutinesVersion', '1.10.2')
 def appcompatVersion = safeExtGet('appcompatVersion', '1.7.1')
 def corektxVersion = safeExtGet('corektxVersion', '1.16.0')
 def gsonVersion = safeExtGet('gsonVersion', '2.13.1')
 def activityktxVersion = safeExtGet('activityktxVersion', '1.10.1')
-def millicastVersion = safeExtGet('millicastVersion', '2.5.0')
 
 dependencies {
     def addOptiViewIntegration = { enabled, notation, additional = null ->
@@ -169,5 +168,5 @@ dependencies {
     addOptiViewIntegration(enabledGoogleDAI || enabledTHEOads, 'integration-ads-dai')
     addOptiViewIntegration(enabledTHEOads, 'integration-ads-theoads')
     addOptiViewIntegration(enabledCast, 'integration-cast')
-    addOptiViewIntegration(enabledMillicast, 'integration-millicast', "com.millicast:millicast-sdk-android:$millicastVersion")
+    addOptiViewIntegration(enabledMillicast, 'integration-millicast')
 }

android/src/main/AndroidManifest.xml

@@ -41,7 +41,7 @@
       </intent-filter>
     </service>
 
-  <receiver android:name="androidx.media.session.MediaButtonReceiver"
+  <receiver android:name=".media.ConditionalMediaButtonReceiver"
     android:exported="false">
     <intent-filter>
       <action android:name="android.intent.action.MEDIA_BUTTON" />

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

@@ -82,7 +82,8 @@ private const val EVENT_THEOLIVE_EVENT = "onNativeTHEOliveEvent"
 private const val EVENT_THEOADS_EVENT = "onNativeTHEOadsEvent"
 private const val EVENT_PRESENTATIONMODECHANGE = "onNativePresentationModeChange"
 private const val EVENT_VOLUMECHANGE = "onNativeVolumeChange"
-private const val EVENT_RESIZE = "onNativeResize"
+private const val EVENT_DIMENSIONCHANGE = "onNativeDimensionChange"
+private const val EVENT_VIDEORESIZE = "onNativeVideoResize"
 
 private const val EVENT_PROP_TYPE = "type"
 private const val EVENT_PROP_STATE = "state"
@@ -126,7 +127,8 @@ class PlayerEventEmitter internal constructor(
     EVENT_THEOADS_EVENT,
     EVENT_PRESENTATIONMODECHANGE,
     EVENT_VOLUMECHANGE,
-    EVENT_RESIZE
+    EVENT_DIMENSIONCHANGE,
+    EVENT_VIDEORESIZE
   )
   annotation class VideoEvents
 
@@ -162,7 +164,8 @@ class PlayerEventEmitter internal constructor(
       EVENT_THEOADS_EVENT,
       EVENT_PRESENTATIONMODECHANGE,
       EVENT_VOLUMECHANGE,
-      EVENT_RESIZE
+      EVENT_DIMENSIONCHANGE,
+      EVENT_VIDEORESIZE
     )
   }
 
@@ -177,9 +180,9 @@ class PlayerEventEmitter internal constructor(
   private var theoAdsEventAdapter: THEOadsEventAdapter? = null
   private var lastTimeUpdate: Long = 0
   private var lastCurrentTime = 0.0
-  private var resizeListener = View.OnLayoutChangeListener { v, _, _, _, _, oldLeft, oldTop, oldRight, oldBottom ->
+  private var dimensionChangeListener = View.OnLayoutChangeListener { v, _, _, _, _, oldLeft, oldTop, oldRight, oldBottom ->
     if (v.width != oldRight - oldLeft || v.height != oldBottom - oldTop) {
-      onResize(v.width, v.height)
+      onDimensionChange(v.width, v.height)
     }
   }
 
@@ -233,6 +236,8 @@ class PlayerEventEmitter internal constructor(
       EventListener { event: PresentationModeChange -> onPresentationModeChange(event) }
     playerListeners[PlayerEventTypes.VOLUMECHANGE] =
       EventListener { event: VolumeChangeEvent -> onVolumeChange(event) }
+    playerListeners[PlayerEventTypes.RESIZE] =
+      EventListener { event: ResizeEvent -> onResize(event) }
     textTrackListeners[TextTrackListEventTypes.ADDTRACK] =
       EventListener { event: AddTrackEvent -> onTextTrackAdd(event) }
     textTrackListeners[TextTrackListEventTypes.REMOVETRACK] =
@@ -438,13 +443,20 @@ class PlayerEventEmitter internal constructor(
     )
   }
 
-  private fun onResize(width: Int, height: Int) {
+  private fun onDimensionChange(width: Int, height: Int) {
     receiveEvent(
-      EVENT_RESIZE,
+      EVENT_DIMENSIONCHANGE,
       PayloadBuilder().size(width, height).build()
     )
   }
 
+  private fun onResize(event: ResizeEvent) {
+    receiveEvent(
+      EVENT_VIDEORESIZE,
+      PayloadBuilder().videoSize(event.width, event.height).build()
+    )
+  }
+
   private val onTextTrackAddCue = EventListener<AddCueEvent> { event ->
     val payload = PayloadBuilder().textTrackCue(event.cue, event.track).build().apply {
       putInt(EVENT_PROP_TYPE, TextTrackCueEventType.ADD_CUE.type)
@@ -700,7 +712,7 @@ class PlayerEventEmitter internal constructor(
     }
 
     // Attach view size listener
-    playerView.addOnLayoutChangeListener(resizeListener)
+    playerView.addOnLayoutChangeListener(dimensionChangeListener)
   }
 
   fun removeListeners(player: Player?) {
@@ -737,7 +749,7 @@ class PlayerEventEmitter internal constructor(
     }
 
     // Remove view size listener
-    playerView.removeOnLayoutChangeListener(resizeListener)
+    playerView.removeOnLayoutChangeListener(dimensionChangeListener)
 
     castEventAdapter?.destroy()
     adEventAdapter?.destroy()

android/src/main/java/com/theoplayer/cast/CastEventAdapter.kt

@@ -6,6 +6,7 @@ import com.theoplayer.android.api.cast.Cast
 import com.theoplayer.android.api.cast.chromecast.CastError
 import com.theoplayer.android.api.cast.chromecast.ErrorCode
 import com.theoplayer.android.api.cast.chromecast.PlayerCastState
+import com.theoplayer.android.api.event.EventListener
 import com.theoplayer.android.api.event.chromecast.CastErrorEvent
 import com.theoplayer.android.api.event.chromecast.CastStateChangeEvent
 import com.theoplayer.android.api.event.chromecast.ChromecastEventTypes
@@ -22,24 +23,27 @@ class CastEventAdapter(private val castApi: Cast, private val emitter: Emitter)
     fun emit(payload: WritableMap?)
   }
 
+  private val onCastError = EventListener<CastErrorEvent> { handleCastError(it) }
+  private val onStateChange = EventListener<CastStateChangeEvent> { handleStateChange(it) }
+
   init {
-    castApi.chromecast.addEventListener(ChromecastEventTypes.ERROR, this::onCastError)
-    castApi.chromecast.addEventListener(ChromecastEventTypes.STATECHANGE, this::onStateChange)
+    castApi.chromecast.addEventListener(ChromecastEventTypes.ERROR, onCastError)
+    castApi.chromecast.addEventListener(ChromecastEventTypes.STATECHANGE, onStateChange)
   }
 
   fun destroy() {
-    castApi.chromecast.removeEventListener(ChromecastEventTypes.ERROR, this::onCastError)
-    castApi.chromecast.removeEventListener(ChromecastEventTypes.STATECHANGE, this::onStateChange)
+    castApi.chromecast.removeEventListener(ChromecastEventTypes.ERROR, onCastError)
+    castApi.chromecast.removeEventListener(ChromecastEventTypes.STATECHANGE, onStateChange)
   }
 
-  private fun onCastError(event: CastErrorEvent) {
+  private fun handleCastError(event: CastErrorEvent) {
     val payload = Arguments.createMap()
     payload.putString(EVENT_PROP_TYPE, "chromecasterror")
     payload.putMap(EVENT_PROP_ERROR, serializeError(event.error))
     emitter.emit(payload)
   }
 
-  private fun serializeError(error: CastError): WritableMap  {
+  private fun serializeError(error: CastError): WritableMap {
     val errorPayload = Arguments.createMap()
     @Suppress("SENSELESS_NULL_IN_WHEN")
     errorPayload.putString(
@@ -62,7 +66,7 @@ class CastEventAdapter(private val castApi: Cast, private val emitter: Emitter)
     return errorPayload
   }
 
-  private fun onStateChange(event: CastStateChangeEvent) {
+  private fun handleStateChange(event: CastStateChangeEvent) {
     val payload = Arguments.createMap()
     payload.putString(EVENT_PROP_TYPE, "chromecaststatechange")
     if (event.state != null) {

android/src/main/java/com/theoplayer/media/ConditionalMediaButtonReceiver.kt

@@ -0,0 +1,38 @@
+package com.theoplayer.media
+
+import android.app.ActivityManager
+import android.content.BroadcastReceiver
+import android.content.Context
+import android.content.Intent
+
+/**
+ * A MediaButtonReceiver that only forwards MediaButton events if the MediaPlaybackService is
+ * running, otherwise ignore the event.
+ * This avoid the service is being restarted when the parent app was closed.
+ * It also avoids the ForegroundServiceDidNotStartInTimeException, which is sent when the
+ * service doesn't start in time (within 5 seconds) due to heavy load.
+ */
+class ConditionalMediaButtonReceiver : BroadcastReceiver() {
+
+    override fun onReceive(context: Context, intent: Intent) {
+        if (Intent.ACTION_MEDIA_BUTTON == intent.action) {
+            // Only send the intent if service is already running.
+            if (isServiceRunning(context, MediaPlaybackService::class.java)) {
+                intent.setClass(context, MediaPlaybackService::class.java)
+                context.startService(intent)
+            }
+        }
+    }
+
+    private fun isServiceRunning(context: Context, serviceClass: Class<*>): Boolean {
+        val am = context.getSystemService(Context.ACTIVITY_SERVICE) as ActivityManager
+        @Suppress("DEPRECATION") // Only alternative is usage stats, heavier
+        val runningServices = am.getRunningServices(Int.MAX_VALUE)
+        for (service in runningServices) {
+            if (serviceClass.name == service.service.className) {
+                return true
+            }
+        }
+        return false
+    }
+}

android/src/main/java/com/theoplayer/player/PlayerModule.kt

@@ -253,7 +253,7 @@ class PlayerModule(context: ReactApplicationContext) : ReactContextBaseJavaModul
   fun setTextTrackStyle(tag: Int, style: ReadableMap?) {
     viewResolver.resolveViewByTag(tag) { view: ReactTHEOplayerView? ->
       view?.player?.let { player ->
-        TextTrackStyleAdapter.applyTextTrackStyle(player.textTrackStyle, style)
+        TextTrackStyleAdapter.applyTextTrackStyle(player.textTrackStyle, reactApplicationContext, style)
       }
     }
   }

android/src/main/java/com/theoplayer/source/SourceAdapter.kt

@@ -427,7 +427,7 @@ class SourceAdapter {
   private fun parseCmcdTransmissionMode(cmcdConfiguration : JSONObject) : CMCDTransmissionMode {
     try {
       val transmissionMode = cmcdConfiguration.optInt(CMCD_TRANSMISSION_MODE)
-      if (transmissionMode === CmcdTransmissionMode.QUERY_ARGUMENT.ordinal) {
+      if (transmissionMode == CmcdTransmissionMode.QUERY_ARGUMENT.ordinal) {
         return CMCDTransmissionMode.QUERY_ARGUMENT
       }
       return CMCDTransmissionMode.HTTP_HEADER

android/src/main/java/com/theoplayer/theoads/THEOadsEventAdapter.kt

@@ -8,6 +8,7 @@ import com.theoplayer.android.api.ads.theoads.event.InterstitialEvent
 import com.theoplayer.android.api.ads.theoads.event.TheoAdsErrorEvent
 import com.theoplayer.android.api.ads.theoads.event.TheoAdsEvent
 import com.theoplayer.android.api.ads.theoads.event.TheoAdsEventTypes
+import com.theoplayer.android.api.event.EventListener
 
 private const val EVENT_PROP_TYPE = "type"
 private const val EVENT_PROP_INTERSTITIAL = "interstitial"
@@ -27,15 +28,17 @@ class THEOadsEventAdapter(private val api: TheoAdsIntegration, private val emitt
     fun emit(payload: WritableMap?)
   }
 
+  private val onEvent = EventListener<TheoAdsEvent<*>> { handleEvent(it) }
+
   init {
-    FORWARDED_EVENTS.forEach { api.addEventListener(it, this::onEvent) }
+    FORWARDED_EVENTS.forEach { api.addEventListener(it, onEvent) }
   }
 
   fun destroy() {
-    FORWARDED_EVENTS.forEach { api.removeEventListener(it, this::onEvent) }
+    FORWARDED_EVENTS.forEach { api.removeEventListener(it, onEvent) }
   }
 
-  private fun onEvent(event: TheoAdsEvent<*>) {
+  private fun handleEvent(event: TheoAdsEvent<*>) {
     emitter.emit(Arguments.createMap().apply {
       putString(EVENT_PROP_TYPE, event.type.name)
       (event as? InterstitialEvent)?.let {

android/src/main/java/com/theoplayer/theolive/THEOliveEventAdapter.kt

@@ -2,6 +2,7 @@ package com.theoplayer.theolive
 
 import com.facebook.react.bridge.Arguments
 import com.facebook.react.bridge.WritableMap
+import com.theoplayer.android.api.event.EventListener
 import com.theoplayer.android.api.event.player.theolive.DistributionLoadStartEvent
 import com.theoplayer.android.api.event.player.theolive.DistributionOfflineEvent
 import com.theoplayer.android.api.event.player.theolive.EndpointLoadedEvent
@@ -21,18 +22,30 @@ class THEOliveEventAdapter(private val theoLiveApi: TheoLive, private val emitte
     fun emit(payload: WritableMap?)
   }
 
+  private val onDistributionLoadStart =
+    EventListener<DistributionLoadStartEvent> { onDistributionLoadStart(it) }
+  private val onDistributionOffline =
+    EventListener<DistributionOfflineEvent> { onDistributionOffline(it) }
+  private val onEndPointLoaded =
+    EventListener<EndpointLoadedEvent> { onEndPointLoaded(it) }
+  private val onIntentOfFallback =
+    EventListener<IntentToFallbackEvent> { onIntentOfFallback(it) }
+
   init {
-    theoLiveApi.addEventListener(TheoLiveEventTypes.DISTRIBUTIONLOADSTART, this::onDistributionLoadStart)
-    theoLiveApi.addEventListener(TheoLiveEventTypes.DISTRIBUTIONOFFLINE, this::onDistributionOffline)
-    theoLiveApi.addEventListener(TheoLiveEventTypes.ENDPOINTLOADED, this::onEndPointLoaded)
-    theoLiveApi.addEventListener(TheoLiveEventTypes.INTENTTOFALLBACK, this::onIntentOfFallback)
+    theoLiveApi.addEventListener(TheoLiveEventTypes.DISTRIBUTIONLOADSTART, onDistributionLoadStart)
+    theoLiveApi.addEventListener(TheoLiveEventTypes.DISTRIBUTIONOFFLINE, onDistributionOffline)
+    theoLiveApi.addEventListener(TheoLiveEventTypes.ENDPOINTLOADED, onEndPointLoaded)
+    theoLiveApi.addEventListener(TheoLiveEventTypes.INTENTTOFALLBACK, onIntentOfFallback)
   }
 
   fun destroy() {
-    theoLiveApi.removeEventListener(TheoLiveEventTypes.DISTRIBUTIONLOADSTART, this::onDistributionLoadStart)
-    theoLiveApi.removeEventListener(TheoLiveEventTypes.DISTRIBUTIONOFFLINE, this::onDistributionOffline)
-    theoLiveApi.removeEventListener(TheoLiveEventTypes.ENDPOINTLOADED, this::onEndPointLoaded)
-    theoLiveApi.removeEventListener(TheoLiveEventTypes.INTENTTOFALLBACK, this::onIntentOfFallback)
+    theoLiveApi.removeEventListener(
+      TheoLiveEventTypes.DISTRIBUTIONLOADSTART,
+      onDistributionLoadStart
+    )
+    theoLiveApi.removeEventListener(TheoLiveEventTypes.DISTRIBUTIONOFFLINE, onDistributionOffline)
+    theoLiveApi.removeEventListener(TheoLiveEventTypes.ENDPOINTLOADED, onEndPointLoaded)
+    theoLiveApi.removeEventListener(TheoLiveEventTypes.INTENTTOFALLBACK, onIntentOfFallback)
   }
 
   private fun onDistributionLoadStart(event: DistributionLoadStartEvent) {