expo-video-subtitle 0.7.5 → 0.7.6

package/CHANGELOG.md

@@ -7,6 +7,33 @@ Changes inherited from the upstream base version are not repeated here — see t
 [upstream changelog](https://github.com/expo/expo/blob/main/packages/expo-video/CHANGELOG.md)
 for the history of everything that isn't subtitle related.
 
+## 0.7.6
+
+### Fixed
+
+- **Signs stopped appearing at all.** The id lookup between the parser and the overlay had never
+  matched. Media3 prefixes a merged track's id with the index of the source it came from, so the
+  parser is handed `expo-subtitle:id:https://…` while the overlay reads
+  `2:expo-subtitle:id:https://…` off the selected track. Every lookup missed, and the
+  "use the only script on hand" fallback quietly covered for it — which is why removing that
+  fallback in 0.7.5 took the whole feature with it, and why the fallback's own bug (one episode's
+  signs drawing over the next) had been the only visible symptom until then.
+
+  Both ends now normalize the id through the same function before touching the map. Five tests pin
+  it, using the exact strings a device produced, and were checked by removing the normalization and
+  watching them fail.
+
+- **A track with no typesetting no longer logs once a second forever.** The parser files its result
+  even when there are no signs in it. Absence in the store used to mean two different things —
+  "still parsing" and "nothing to draw" — and the overlay kept asking for the second one.
+
+### Changed
+
+- A missed lookup is now logged, throttled to once a second, naming both the id being asked for and
+  the ids on hand. Its absence is what let this bug hide behind a fallback for three releases: the
+  overlay asked, got nothing, and said nothing, so a wrong key looked exactly like a file that had
+  not finished parsing.
+
 ## 0.7.5
 
 ### Fixed

package/android/src/main/java/expo/modules/video/utils/AssSignOverlay.kt

@@ -109,7 +109,18 @@ internal class AssSignOverlay(context: Context) : View(context), Player.Listener
     val trackId = selectedTextTrackId()
     val next = AssSignStore.get(trackId)
     scriptTrackId = trackId
-    if (next === script) return
+    if (next === script) {
+      // Reported, not swallowed. A lookup that quietly finds nothing is how this subsystem has
+      // failed three times running: the overlay asks, gets nothing, and says nothing, so the log
+      // looks identical whether the file is still parsing or the key is simply wrong. Throttled to
+      // once a second because the poll runs four times that.
+      val now = SystemClock.uptimeMillis()
+      if (now - lastMissLogMs >= MISS_LOG_INTERVAL_MS) {
+        lastMissLogMs = now
+        Log.w(TAG, "no ASS signs for track $trackId; parsed so far: ${AssSignStore.keys()}")
+      }
+      return
+    }
     // The one line worth keeping. Every failure of this subsystem has been silent — a span dropped
     // by Parcel, a timestamp rejected, a loop that never started — and each time this line would
     // have named the stage that broke.
@@ -169,6 +180,7 @@ internal class AssSignOverlay(context: Context) : View(context), Player.Listener
 
 
   private var lastLookupMs = 0L
+  private var lastMissLogMs = 0L
 
   private fun tick() {
     val player = this.player ?: return
@@ -367,6 +379,9 @@ internal class AssSignOverlay(context: Context) : View(context), Player.Listener
 
     /** How often to ask the store for a script that has not arrived yet. */
     private const val LOOKUP_INTERVAL_MS = 250L
+
+    /** How often to say so when the answer is still nothing. */
+    private const val MISS_LOG_INTERVAL_MS = 1000L
     private const val OPAQUE = 0xFF000000.toInt()
 
     /** Removes the overlay from [playerView], dropping its listener registration with it. */

package/android/src/main/java/expo/modules/video/utils/AssSignStore.kt

@@ -41,10 +41,27 @@ internal object AssSignStore {
       size > MAX_TRACKS
   }
 
+  /**
+   * A merged track's id carries the index of the source it came from: Media3 hands the overlay
+   * `2:expo-subtitle:id:https://…` for the track the parser was given as `expo-subtitle:id:https://…`.
+   * Both ends key on the same string only if that prefix is taken off first.
+   *
+   * Measured on a device, and it is what made every id lookup miss while a fallback quietly covered
+   * for it. Stripped repeatedly, since sources can nest, and safe for these ids because
+   * `SubtitleSource` always begins them with `expo-subtitle:`, never a digit.
+   */
+  private val MERGED_SOURCE_PREFIX = Regex("""^\d+:""")
+
+  fun normalizeTrackId(trackId: String): String {
+    var id = trackId
+    while (MERGED_SOURCE_PREFIX.containsMatchIn(id)) id = id.replaceFirst(MERGED_SOURCE_PREFIX, "")
+    return id
+  }
+
   /** Called from the extractor's loading thread. */
   @Synchronized
   fun put(trackId: String, script: AssScript) {
-    scripts[trackId] = script
+    scripts[normalizeTrackId(trackId)] = script
   }
 
   /**
@@ -61,7 +78,11 @@ internal object AssSignStore {
    * script takes about twelve seconds, and the overlay polls until it has.
    */
   @Synchronized
-  fun get(trackId: String?): AssScript? = trackId?.let { scripts[it] }
+  fun get(trackId: String?): AssScript? = trackId?.let { scripts[normalizeTrackId(it)] }
+
+  /** The keys on hand, for telling a "not parsed yet" miss from a "wrong key" miss. */
+  @Synchronized
+  fun keys(): List<String> = scripts.keys.toList()
 
   @Synchronized
   fun clear() {

package/android/src/main/java/expo/modules/video/utils/StackingSubtitleParser.kt

@@ -342,10 +342,13 @@ class StackingSsaParser(
       if (trackId == null) return@runCatching Split(data, offset, length)
 
       val script = AssSignParser.parse(String(data, offset, length, Charsets.UTF_8))
+      // Filed even with no signs in it. The overlay cannot tell "still parsing" from "nothing to
+      // draw" by absence alone, and would go on asking — and logging — for the whole episode.
+      AssSignStore.put(trackId, script)
+
       if (script.signs.isEmpty()) {
         Split(data, offset, length)
       } else {
-        AssSignStore.put(trackId, script)
         val dialogue = script.dialogueOnly.toByteArray(Charsets.UTF_8)
         Split(dialogue, 0, dialogue.size)
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-video-subtitle",
-  "version": "0.7.5",
+  "version": "0.7.6",
   "description": "A cross-platform, performant video component for React Native and Expo with external subtitle sideloading and custom subtitle styling.",
   "keywords": [
     "expo",