chore(docs): update code docs

Author: jellyrock[bot]

docs/components_ItemGrid_LoadVideoContentTask.bs.html

@@ -352,30 +352,8 @@
       tryDirectPlay = tryDirectPlay or (userSettings.playbackTryDirectHevcProfileLevel and videoStream.codec = "hevc")
 
       ' Check source resolution against hardware ceiling before allowing override
-      if tryDirectPlay
-        sourceHeight = 0
-        sourceWidth = 0
-
-        if isValid(videoStream.Height)
-          sourceHeight = videoStream.Height
-          if type(sourceHeight) = "roString" or type(sourceHeight) = "String"
-            sourceHeight = sourceHeight.toInt()
-          end if
-        end if
-
-        if isValid(videoStream.Width)
-          sourceWidth = videoStream.Width
-          if type(sourceWidth) = "roString" or type(sourceWidth) = "String"
-            sourceWidth = sourceWidth.toInt()
-          end if
-        end if
-
-        ' h264: Roku hardware ceiling is 1080p — 4K h264 is physically impossible to decode
-        ' Check both dimensions to catch ultrawide or non-standard aspect ratios
-        if videoStream.codec = "h264" and (sourceHeight > 1080 or sourceWidth > 1920)
-          tryDirectPlay = false
-        end if
-        ' hevc: no additional guard needed — Roku supports up to 4K hevc natively
+      if tryDirectPlay and not isWithinH264HardwareCeiling(videoStream)
+        tryDirectPlay = false
       end if
     else
       tryDirectPlay = false

docs/data/search.json

@@ -146,7 +146,9 @@
           end for
 
           for each codecProfile in postData.DeviceProfile.CodecProfiles
-            ' Codec field is a comma-separated list of aliases (e.g. "h264,avc")
+            ' Codec field is a comma-separated list of aliases set by getCodecProfiles().
+            ' Known values: "h264,avc", "h265,hevc", "vp9", "vp8", "av1", "mpeg2video", "mpeg4".
+            ' Substring match is safe: no other codec contains "h264" as a substring.
             if isValid(codecProfile.Codec) and Instr(1, LCase(codecProfile.Codec), "h264") > 0
               applyResolutionCapToProfile(codecProfile, h264CapHeight, h264CapWidth, true)
             end if

docs/module-deviceCapabilities.html

@@ -141,6 +141,7 @@
     settingsNode.playbackPlayDefaultAudioTrack = settingsData["playbackPlayDefaultAudioTrack"] ?? ""
     settingsNode.playbackPreferredMultichannelCodec = settingsData["playbackPreferredMultichannelCodec"] ?? ""
     settingsNode.playbackSubsOnlyText = toBoolean(settingsData["playbackSubsOnlyText"])
+    settingsNode.playbackForceTranscodeAnamorphic = toBoolean(settingsData["playbackForceTranscodeAnamorphic"])
     settingsNode.playbackMpeg2 = toBoolean(settingsData["playbackMpeg2"])
     settingsNode.playbackMpeg4 = toBoolean(settingsData["playbackMpeg4"])
     settingsNode.playbackTryDirectH264ProfileLevel = toBoolean(settingsData["playbackTryDirectH264ProfileLevel"])

docs/source_api_Items.bs.html

@@ -836,12 +836,6 @@
     "Type": "Video",
     "Codec": "h264,avc",
     "Conditions": [
-      {
-        "Condition": "NotEquals",
-        "Property": "IsAnamorphic",
-        "Value": "true",
-        "IsRequired": false
-      },
       {
         "Condition": "EqualsAny",
         "Property": "VideoProfile",
@@ -869,6 +863,11 @@
     "IsRequired": false
   })
 
+  anamorphicCondition = getAnamorphicCondition()
+  if anamorphicCondition.count() > 0
+    h264ProfileArray.Conditions.push(anamorphicCondition)
+  end if
+
   ' set max resolution
   h264ProfileArray.Conditions.Append(resolutionConditions)
 
@@ -912,6 +911,11 @@
       mpeg2ProfileArray.Conditions.push(bitRateArray)
     end if
 
+    anamorphicCondition = getAnamorphicCondition()
+    if anamorphicCondition.count() > 0
+      mpeg2ProfileArray.Conditions.push(anamorphicCondition)
+    end if
+
     codecProfiles.push(mpeg2ProfileArray)
   end if
 
@@ -933,6 +937,11 @@
     ' set max resolution
     mpeg4ProfileArray.Conditions.Append(resolutionConditions)
 
+    anamorphicCondition = getAnamorphicCondition()
+    if anamorphicCondition.count() > 0
+      mpeg4ProfileArray.Conditions.push(anamorphicCondition)
+    end if
+
     codecProfiles.push(mpeg4ProfileArray)
   end if
 
@@ -983,6 +992,11 @@
       av1ProfileArray.Conditions.push(bitRateArray)
     end if
 
+    anamorphicCondition = getAnamorphicCondition()
+    if anamorphicCondition.count() > 0
+      av1ProfileArray.Conditions.push(anamorphicCondition)
+    end if
+
     codecProfiles.push(av1ProfileArray)
   end if
 
@@ -1006,12 +1020,6 @@
       "Type": "Video",
       "Codec": "h265,hevc",
       "Conditions": [
-        {
-          "Condition": "NotEquals",
-          "Property": "IsAnamorphic",
-          "Value": "true",
-          "IsRequired": false
-        },
         {
           "Condition": "EqualsAny",
           "Property": "VideoProfile",
@@ -1047,6 +1055,11 @@
       hevcProfileArray.Conditions.push(bitRateArray)
     end if
 
+    anamorphicCondition = getAnamorphicCondition()
+    if anamorphicCondition.count() > 0
+      hevcProfileArray.Conditions.push(anamorphicCondition)
+    end if
+
     codecProfiles.push(hevcProfileArray)
   end if
 
@@ -1085,6 +1098,11 @@
       vp9ProfileArray.Conditions.push(bitRateArray)
     end if
 
+    anamorphicCondition = getAnamorphicCondition()
+    if anamorphicCondition.count() > 0
+      vp9ProfileArray.Conditions.push(anamorphicCondition)
+    end if
+
     codecProfiles.push(vp9ProfileArray)
   end if
 
@@ -1107,6 +1125,11 @@
     ' set max resolution
     vp8ProfileArray.Conditions.Append(resolutionConditions)
 
+    anamorphicCondition = getAnamorphicCondition()
+    if anamorphicCondition.count() > 0
+      vp8ProfileArray.Conditions.push(anamorphicCondition)
+    end if
+
     codecProfiles.push(vp8ProfileArray)
   end if
 
@@ -1237,6 +1260,52 @@
   return {}
 end function
 
+' Returns an IsAnamorphic codec profile condition when the user has enabled
+' forced transcoding of anamorphic video. Returns empty object when disabled.
+' @return {object} - Condition AA or empty AA
+function getAnamorphicCondition() as object
+  if m.global.user.settings.playbackForceTranscodeAnamorphic
+    return {
+      "Condition": "NotEquals",
+      "Property": "IsAnamorphic",
+      "Value": "true",
+      "IsRequired": false
+    }
+  end if
+  return {}
+end function
+
+' Checks whether a video stream's resolution is within the h264 hardware
+' decoding ceiling (1080p / 1920x1080). Returns true for non-h264 codecs
+' since they have higher ceilings handled elsewhere.
+' Handles Height/Width fields arriving as strings or integers, and defaults
+' to 0 (within ceiling) when metadata is missing.
+' @param videoStream {object} - MediaStream object with codec, Height, Width
+' @return {boolean} - true if within ceiling or not h264, false if exceeds ceiling
+function isWithinH264HardwareCeiling(videoStream as object) as boolean
+  if not isValid(videoStream) or not isValid(videoStream.codec) then return false
+  if videoStream.codec <> "h264" then return true
+
+  sourceHeight = 0
+  sourceWidth = 0
+
+  if isValid(videoStream.Height)
+    sourceHeight = videoStream.Height
+    if type(sourceHeight) = "roString" or type(sourceHeight) = "String"
+      sourceHeight = sourceHeight.toInt()
+    end if
+  end if
+
+  if isValid(videoStream.Width)
+    sourceWidth = videoStream.Width
+    if type(sourceWidth) = "roString" or type(sourceWidth) = "String"
+      sourceWidth = sourceWidth.toInt()
+    end if
+  end if
+
+  return sourceHeight <= 1080 and sourceWidth <= 1920
+end function
+
 function getResolutionConditions(isRequired = false as boolean) as object
   userMaxHeight = m.global.user.settings.playbackResolutionMax
   if userMaxHeight = invalid or userMaxHeight = "" then userMaxHeight = "auto"