Update code docs

Author: jellyrock-bot

docs/components_ItemGrid_LoadVideoContentTask.bs.html

@@ -48,18 +48,19 @@
   mediaSourceId = invalid
   audio_stream_idx = m.top.selectedAudioStreamIndex
   forceTranscoding = false
+  bypassDoviPreservation = m.top.bypassDoviPreservation
 
-  m.top.content = [LoadItems_VideoPlayer(id, mediaSourceId, audio_stream_idx, forceTranscoding)]
+  m.top.content = [LoadItems_VideoPlayer(id, mediaSourceId, audio_stream_idx, forceTranscoding, bypassDoviPreservation)]
 end sub
 
-function LoadItems_VideoPlayer(id as string, mediaSourceId as dynamic, audio_stream_idx = 1 as integer, forceTranscoding = false as boolean) as dynamic
+function LoadItems_VideoPlayer(id as string, mediaSourceId as dynamic, audio_stream_idx = 1 as integer, forceTranscoding = false as boolean, bypassDoviPreservation = false as boolean) as dynamic
 
   video = {}
   video.id = id
   video.content = createObject("RoSGNode", "ContentNode")
   video.content.addField("trickplayMetadata", "assocarray", false)
 
-  LoadItems_AddVideoContent(video, mediaSourceId, audio_stream_idx, forceTranscoding)
+  LoadItems_AddVideoContent(video, mediaSourceId, audio_stream_idx, forceTranscoding, bypassDoviPreservation)
 
   if not isValid(video.content)
     return invalid
@@ -68,7 +69,7 @@
   return video
 end function
 
-sub LoadItems_AddVideoContent(video as object, mediaSourceId as dynamic, audio_stream_idx = 1 as integer, forceTranscoding = false as boolean)
+sub LoadItems_AddVideoContent(video as object, mediaSourceId as dynamic, audio_stream_idx = 1 as integer, forceTranscoding = false as boolean, bypassDoviPreservation = false as boolean)
 
   meta = ItemMetaData(video.id)
   if not isValid(meta)
@@ -220,7 +221,7 @@
   if meta.live then mediaSourceId = ""
 
   ' Call ItemPostPlaybackInfo ONCE with final subtitle_idx
-  m.playbackInfo = ItemPostPlaybackInfo(video.id, mediaSourceId, audio_stream_idx, subtitle_idx, playbackPosition, meta)
+  m.playbackInfo = ItemPostPlaybackInfo(video.id, mediaSourceId, audio_stream_idx, subtitle_idx, playbackPosition, meta, bypassDoviPreservation)
   if not isValid(m.playbackInfo)
     video.errorMsg = "Error loading playback info"
     video.content = invalid
@@ -312,6 +313,16 @@
     video.transcodeReasons = getTranscodeReasons(m.playbackInfo.MediaSources[0].TranscodingUrl)
     video.content.url = buildURL(m.playbackInfo.MediaSources[0].TranscodingUrl)
     video.isTranscoded = true
+
+    ' If DoVi preservation caused this transcode, flag that direct play is a viable buffer-overflow fallback.
+    ' VideoRangeTypeNotSupported is the reason Jellyfin returns when our DoVi container profile blocks the MKV.
+    ' On a buffer:loop: error the player will retry with bypassDoviPreservation=true, letting the server
+    ' re-evaluate without the DoVi constraint and (usually) grant direct play instead.
+    if userSettings.playbackPreserveDovi and not bypassDoviPreservation
+      if arrayHasValue(video.transcodeReasons, "VideoRangeTypeNotSupported")
+        video.doviDirectPlayFallbackAvailable = true
+      end if
+    end if
   end if
 
   setCertificateAuthority(video.content)

docs/components_manager_ViewCreator.bs.html

@@ -232,6 +232,8 @@
 ' Playback state change event handlers
 sub onStateChange()
   if LCase(m.view.state) = "finished"
+    ' Don't pop the scene mid-retry; the DoVi fallback calls stop which can fire "finished".
+    if isValid(m.view.isRetrying) and m.view.isRetrying then return
     sceneManager = m.global.sceneManager
     queueManager = m.global.queueManager
 

docs/components_video_VideoPlayerView.bs.html

@@ -514,6 +514,8 @@
   m.LoadMetaDataTask.unobserveField("content")
   m.LoadMetaDataTask.control = "STOP"
 
+  m.top.isRetrying = false
+
   videoContent = m.LoadMetaDataTask.content
   m.LoadMetaDataTask.content = []
 
@@ -539,6 +541,11 @@
   m.chapters = videoContent[0].chapters
   m.top.showID = videoContent[0].showID
   m.top.cachedPlaybackInfo = videoContent[0].playbackInfo
+  m.top.doviDirectPlayFallbackAvailable = isValid(videoContent[0].doviDirectPlayFallbackAvailable) and videoContent[0].doviDirectPlayFallbackAvailable
+
+  ' Reset bypass flag so subsequent reloads (audio/subtitle changes) re-evaluate DoVi naturally.
+  ' It will be set back to true by the error handler if another buffer overflow occurs.
+  m.LoadMetaDataTask.bypassDoviPreservation = false
 
   if isValidAndNotEmpty(videoContent[0].json)
     m.osd.json = formatJson(videoContent[0].json)
@@ -894,7 +901,25 @@
 
     print m.top.errorInfo
 
-    if not m.playReported and m.top.transcodeAvailable
+    ' Detect a Roku video buffer overflow (buffer:loop: source) caused by DoVi transcoding.
+    ' When DoVi preservation forced a transcode and the HLS segments overflow the device buffer,
+    ' retry with direct play by bypassing the DoVi container profile injection.
+    isBufferLoopError = isValid(m.top.errorInfo) and isValid(m.top.errorInfo.source) and m.top.errorInfo.source = "buffer:loop:"
+
+    if isBufferLoopError and m.top.doviDirectPlayFallbackAvailable
+      m.log.warn("Buffer overflow in DoVi transcode; falling back to direct play", m.currentItem.id)
+      m.top.doviDirectPlayFallbackAvailable = false ' prevent retry loop if direct play also fails
+      m.global.queueManager.callFunc("setTopStartingPoint", int(m.top.position) * 10000000&)
+      ' Prevents ViewCreator popping the scene when stop causes Roku to fire "finished".
+      m.top.isRetrying = true
+      m.top.control = "stop"
+      m.LoadMetaDataTask.bypassDoviPreservation = true
+      m.LoadMetaDataTask.selectedSubtitleIndex = m.top.SelectedSubtitle
+      m.LoadMetaDataTask.selectedAudioStreamIndex = m.top.audioIndex
+      m.LoadMetaDataTask.itemId = m.currentItem.id
+      m.LoadMetaDataTask.observeField("content", "onVideoContentLoaded")
+      m.LoadMetaDataTask.control = "RUN"
+    else if not m.playReported and m.top.transcodeAvailable
       m.log.info("retrying with transcoding", m.currentItem.id, m.top.SelectedSubtitle, m.top.audioIndex)
       m.top.retryWithTranscoding = true ' If playback was not reported, retry with transcoding
     else

docs/module-Items.html

@@ -6,7 +6,7 @@
 import "pkg:/source/utils/deviceCapabilities.bs"
 import "pkg:/source/utils/misc.bs"
 
-function ItemPostPlaybackInfo(id as string, mediaSourceId = "" as string, audioTrackIndex = -1 as integer, subtitleTrackIndex = SubtitleSelection.none as integer, startTimeTicks = 0& as longinteger, videoMetadata = invalid as dynamic)
+function ItemPostPlaybackInfo(id as string, mediaSourceId = "" as string, audioTrackIndex = -1 as integer, subtitleTrackIndex = SubtitleSelection.none as integer, startTimeTicks = 0& as longinteger, videoMetadata = invalid as dynamic, bypassDoviPreservation = false as boolean)
   globalUser = m.global.user
   postData = {
     "UserId": globalUser.id,
@@ -82,8 +82,9 @@
   end if
 
   ' DOVI not supported using MKV container, so force remux for DOVI content
-  ' Only run DOVI logic if the user setting exists and is enabled
-  if isValid(mediaStreams) and isValid(globalUser.settings.playbackPreserveDovi) and globalUser.settings.playbackPreserveDovi
+  ' Only run DOVI logic if the user setting exists and is enabled, and caller has not bypassed it
+  ' (bypassDoviPreservation is set when retrying after a buffer overflow to allow direct play)
+  if not bypassDoviPreservation and isValid(mediaStreams) and isValid(globalUser.settings.playbackPreserveDovi) and globalUser.settings.playbackPreserveDovi
     ' Check if device supports DOVI before proceeding
     deviceSupportsDovi = false
     di = CreateObject("roDeviceInfo")

docs/module-LoadVideoContentTask.html

@@ -349,10 +349,8 @@
     ' Video codecs
     videoCodecList = "h264"
 
-    if container = "mp4"
-      if di.CanDecodeVideo({ Codec: "hevc", Container: container }).Result
-        videoCodecList = "hevc,h265," + videoCodecList
-      end if
+    if di.CanDecodeVideo({ Codec: "hevc", Container: container }).Result
+      videoCodecList = "hevc,h265," + videoCodecList
     end if
 
     if di.CanDecodeVideo({ Codec: "mpeg4 avc", Container: container }).Result