Update code docs

Author: jellyrock-bot

docs/components_captionTask.bs.html

@@ -10,6 +10,7 @@
   m.top.observeField("url", "fetchCaption")
   m.top.currentCaption = []
   m.top.currentPos = 0
+  m.lastCaptionTexts = invalid
 
   m.captionTimer = m.top.findNode("captionTimer")
   m.captionTimer.ObserveField("fire", "updateCaption")
@@ -31,6 +32,19 @@
   m.textOpac = m.percentageDict[deviceInfo.GetCaptionsOption("Text/Opacity")]
   m.bgColor = m.bgColorDict[deviceInfo.GetCaptionsOption("Background/Color")]
   m.bgOpac = m.percentageDict[deviceInfo.GetCaptionsOption("Background/Opacity")]
+
+  ' Validate fontSize - fallback to default if invalid
+  if not isValid(m.fontSize) or m.fontSize <= 0
+    m.fontSize = m.fontSizeDict["Default"]
+    m.log.warn("Invalid font size from device settings, using default", m.fontSize)
+  end if
+
+  ' Validate text opacity - ensure visibility if set to 0 (Off)
+  if not isValid(m.textOpac) or m.textOpac <= 0
+    m.textOpac = m.percentageDict["Default"]
+    m.log.warn("Text opacity is 0 or invalid, using default for visibility", m.textOpac)
+  end if
+
   setFont()
 end sub
 
@@ -45,8 +59,20 @@
   end if
 end sub
 
+function arraysEqual(arr1, arr2) as boolean
+  if not isValid(arr1) and not isValid(arr2) then return true
+  if not isValid(arr1) or not isValid(arr2) then return false
+  if arr1.count() <> arr2.count() then return false
+
+  for i = 0 to arr1.count() - 1
+    if arr1[i] <> arr2[i] then return false
+  end for
+
+  return true
+end function
+
 sub fetchCaption()
-  m.log.debug("start fetchCaption()")
+  m.log.debug("Start fetchCaption()", m.top.url)
   m.captionTimer.control = "stop"
   re = CreateObject("roRegex", "(http.*?\.vtt)", "s")
   url = re.match(m.top.url)[0]
@@ -56,16 +82,30 @@
     m.reader.setUrl(url)
     m.reader.setMessagePort(port)
     if m.reader.AsyncGetToString()
-      msg = port.waitMessage(0)
-      if type(msg) = "roUrlEvent"
-        m.captionList = parseVTT(msg.GetString())
-        m.captionTimer.control = "start"
+      ' Wait for response with 10 second timeout to prevent infinite blocking
+      msg = port.waitMessage(10000)
+      if isValid(msg) and type(msg) = "roUrlEvent"
+        responseCode = msg.GetResponseCode()
+        if responseCode = 200
+          vttContent = msg.GetString()
+          m.log.debug("VTT content received, length:", vttContent.len())
+          m.captionList = parseVTT(vttContent)
+          m.log.info("Parsed", m.captionList.count(), "caption entries")
+          m.captionTimer.control = "start"
+        else
+          m.log.error("Failed to fetch captions. HTTP response code:", responseCode)
+        end if
+      else
+        m.log.error("Timeout or invalid response when fetching captions")
       end if
+    else
+      m.log.error("Failed to initiate caption download")
     end if
   else
+    m.log.warn("No valid VTT URL found in:", m.top.url)
     m.captionTimer.control = "stop"
   end if
-  m.log.debug("end fetchCaption()", url)
+  m.log.debug("End fetchCaption()")
 end sub
 
 function newlabel(txt)
@@ -107,7 +147,6 @@
 
 
 sub updateCaption()
-  m.top.currentCaption = []
   if LCase(m.top.playerState) = "playingon"
     m.top.currentPos = m.top.currentPos + 100
     texts = []
@@ -117,15 +156,27 @@
         texts.push(t)
       end if
     end for
-    labels = []
-    for each text in texts
-      labels.push(newlabel (text))
-    end for
-    lines = newLayoutGroup(labels)
-    rect = newRect(lines)
-    m.top.currentCaption = [rect, lines]
+
+    ' Only update captions if content has changed
+    if not isValid(m.lastCaptionTexts) or not arraysEqual(texts, m.lastCaptionTexts)
+      m.lastCaptionTexts = texts
+      m.top.currentCaption = []
+
+      if texts.count() > 0
+        labels = []
+        for each text in texts
+          labels.push(newlabel(text))
+        end for
+        lines = newLayoutGroup(labels)
+        rect = newRect(lines)
+        m.top.currentCaption = [rect, lines]
+      else
+        ' Clear captions when no text should be displayed
+        m.top.currentCaption = []
+      end if
+    end if
   else if LCase(m.top.playerState.right(1)) = "w"
-    m.top.playerState = m.top.playerState.left(len (m.top.playerState) - 1)
+    m.top.playerState = m.top.playerState.left(len(m.top.playerState) - 1)
   end if
 end sub
 

docs/components_video_VideoPlayerView.bs.html

@@ -275,6 +275,43 @@
   end if
 end sub
 
+' Determines if custom subtitles should be used for the current selection
+' Custom subtitles should only be used for external subtitles when the user has enabled the setting
+function shouldUseCustomSubtitlesForCurrentSelection() as boolean
+  ' First check if the user has enabled custom subtitles at all
+  if not m.global.session.user.settings["playback.subs.custom"]
+    m.log.debug("Custom subtitles disabled by user setting")
+    return false
+  end if
+
+  ' If no subtitle is currently selected, no need for custom subtitles
+  if not isValid(m.top.selectedSubtitle) or m.top.selectedSubtitle = -1
+    m.log.debug("No subtitle selected", m.top.selectedSubtitle)
+    return false
+  end if
+
+  ' Find the selected subtitle in the fullSubtitleData
+  selectedSubtitle = invalid
+  if isValid(m.top.fullSubtitleData)
+    for each subtitle in m.top.fullSubtitleData
+      if subtitle.Index = m.top.selectedSubtitle
+        selectedSubtitle = subtitle
+        exit for
+      end if
+    end for
+  end if
+
+  ' If we found the selected subtitle and it's external, use custom subtitles
+  if isValid(selectedSubtitle) and isValid(selectedSubtitle.IsExternal)
+    m.log.debug("Subtitle found", selectedSubtitle.IsExternal, selectedSubtitle.Index)
+    return selectedSubtitle.IsExternal
+  end if
+
+  m.log.debug("Selected subtitle not found in fullSubtitleData or invalid IsExternal flag")
+  ' Default to false (use native Roku subtitles)
+  return false
+end function
+
 ' Only setup caption items if captions are allowed
 sub onAllowCaptionsChange()
   if not m.top.allowCaptions then return
@@ -287,17 +324,13 @@
   m.top.observeField("subtitleTrack", "loadCaption")
   m.top.observeField("globalCaptionMode", "toggleCaption")
 
-  if m.global.session.user.settings["playback.subs.custom"]
-    m.top.suppressCaptions = true
-    toggleCaption()
-  else
-    m.top.suppressCaptions = false
-  end if
 end sub
 
 ' Set caption url to server subtitle track
 sub loadCaption()
+  m.log.debug("loadCaption() called", m.top.subtitleTrack, m.top.suppressCaptions)
   if m.top.suppressCaptions
+    m.log.debug("Setting captionTask.url", m.top.subtitleTrack)
     m.captionTask.url = m.top.subtitleTrack
   end if
 end sub
@@ -331,6 +364,22 @@
   ' If previous sustitle was encoded, then we need to a video stop/start to change subtitle content
   if m.top.previousSubtitleWasEncoded then switchWithoutRefresh = false
 
+  ' Update custom subtitle behavior based on new selection
+  if m.top.allowCaptions
+    shouldUseCustomSubtitles = shouldUseCustomSubtitlesForCurrentSelection()
+
+    m.log.debug("Subtitle changed", shouldUseCustomSubtitles, m.top.suppressCaptions)
+
+    if shouldUseCustomSubtitles <> m.top.suppressCaptions
+      ' Custom subtitle mode has changed, update it
+      m.log.debug("Changing custom subtitle mode to", shouldUseCustomSubtitles)
+      m.top.suppressCaptions = shouldUseCustomSubtitles
+      if m.top.suppressCaptions
+        toggleCaption()
+      end if
+    end if
+  end if
+
   if switchWithoutRefresh then return
 
   ' Save the current video position
@@ -460,6 +509,15 @@
 
   m.top.selectedSubtitle = videoContent[0].selectedSubtitle
 
+  ' Update custom subtitle behavior based on the selected subtitle
+  if m.top.allowCaptions
+    shouldUseCustomSubtitles = shouldUseCustomSubtitlesForCurrentSelection()
+    m.top.suppressCaptions = shouldUseCustomSubtitles
+    if m.top.suppressCaptions
+      toggleCaption()
+    end if
+  end if
+
   m.top.observeField("selectedSubtitle", "onSubtitleChange")
 
   if isValid(m.top.audioIndex)
@@ -526,7 +584,6 @@
 
   ' align button with bottom right edge with 5% padding
   boundingRect = m.notifyButtons.localBoundingRect()
-  print "boundingRect =", boundingRect
 
   m.notifyButtons.translation = [
     1920 - (1920 * 0.05),
@@ -613,7 +670,7 @@
 '
 ' When Video Player state changes
 sub onState()
-  m.log.debug("start onState()", m.top.state)
+  m.log.debug("start onState", m.top.state)
   if isValid(m.captionTask)
     m.captionTask.playerState = m.top.state + m.top.globalCaptionMode
   end if
@@ -683,15 +740,15 @@
   else
     m.log.warning("Unhandled state", m.top.state, m.playReported, m.playFinished)
   end if
-  m.log.debug("end onState()", m.top.state)
+  m.log.debug("end onState", m.top.state)
 end sub
 
 '
 ' Report playback to server
 sub ReportPlayback(state = "update" as string)
   if not isValid(m.top.position) then return
 
-  m.log.debug("start ReportPlayback()", state, int(m.top.position))
+  m.log.debug("start ReportPlayback", state, int(m.top.position))
 
   params = {
     "ItemId": m.top.id,
@@ -708,7 +765,7 @@
   end if
 
   if (state = "stop" or state = "finished") and isValid(m.originalClosedCaptionState)
-    m.log.debug("ReportPlayback() setting", m.top.globalCaptionMode, "back to", m.originalClosedCaptionState)
+    m.log.debug("ReportPlayback setting", m.top.globalCaptionMode, "back to", m.originalClosedCaptionState)
     m.top.globalCaptionMode = m.originalClosedCaptionState
     m.originalClosedCaptionState = invalid
   end if
@@ -718,7 +775,7 @@
   playstateTask.setFields({ status: state, params: params })
   playstateTask.control = "RUN"
 
-  m.log.debug("end ReportPlayback()", state, int(m.top.position))
+  m.log.debug("end ReportPlayback", state, int(m.top.position))
 end sub
 
 '