feat: Split config for default constraints. (#2252)

* feat: Split config for default constraints. * squash: Use the correct property.
jitsi · Nov 14, 2024 · 847cb3e · 847cb3e
1 parent 94fb805
commit 847cb3e
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 13 deletions.
diff --git a/jvb/src/main/kotlin/org/jitsi/videobridge/cc/allocation/AllocationSettings.kt b/jvb/src/main/kotlin/org/jitsi/videobridge/cc/allocation/AllocationSettings.kt
@@ -80,7 +80,7 @@ internal class AllocationSettingsWrapper(
 
     private var videoConstraints: Map<String, VideoConstraints> = emptyMap()
 
-    private var defaultConstraints: VideoConstraints = VideoConstraints(config.thumbnailMaxHeightPx)
+    private var defaultConstraints: VideoConstraints = VideoConstraints(config.defaultMaxHeightPx)
 
     private var assumedBandwidthBps: Long = -1
 

diff --git a/jvb/src/main/kotlin/org/jitsi/videobridge/cc/allocation/BandwidthAllocator.kt b/jvb/src/main/kotlin/org/jitsi/videobridge/cc/allocation/BandwidthAllocator.kt
@@ -78,11 +78,11 @@ internal class BandwidthAllocator<T : MediaSourceContainer>(
         addHandler(eventHandler)
     }
 
-    /**
-     * The allocations settings signalled by the receiver.
-     */
+    /** The allocations settings signalled by the receiver. */
     private var allocationSettings =
-        AllocationSettings(defaultConstraints = VideoConstraints(BitrateControllerConfig.config.thumbnailMaxHeightPx))
+        AllocationSettings(
+            defaultConstraints = VideoConstraints(BitrateControllerConfig.config.initialMaxHeightPx)
+        )
 
     /**
      * The last time [BandwidthAllocator.update] was called.

diff --git a/jvb/src/main/kotlin/org/jitsi/videobridge/cc/config/BitrateControllerConfig.kt b/jvb/src/main/kotlin/org/jitsi/videobridge/cc/config/BitrateControllerConfig.kt
@@ -39,12 +39,17 @@ class BitrateControllerConfig private constructor() {
         "videobridge.cc.bwe-change-threshold".from(JitsiConfig.newConfig)
     }
 
-    /**
-     * The max resolution to allocate for the thumbnails.
-     */
-    val thumbnailMaxHeightPx: Int by config {
-        "org.jitsi.videobridge.THUMBNAIL_MAX_HEIGHT".from(JitsiConfig.legacyConfig)
+    val initialMaxHeightPx: Int by config {
+        // Support the old property name if the user has overridden it.
+        "videobridge.cc.thumbnail-max-height-px".from(JitsiConfig.newConfig)
+            .softDeprecated("use videobridge.cc.initial-max-height-px")
+        "videobridge.cc.initial-max-height-px".from(JitsiConfig.newConfig)
+    }
+    val defaultMaxHeightPx: Int by config {
+        // Support the old property name if the user has overridden it.
         "videobridge.cc.thumbnail-max-height-px".from(JitsiConfig.newConfig)
+            .softDeprecated("use videobridge.cc.default-max-height-px")
+        "videobridge.cc.default-max-height-px".from(JitsiConfig.newConfig)
     }
 
     /**

diff --git a/jvb/src/main/resources/reference.conf b/jvb/src/main/resources/reference.conf
@@ -42,9 +42,13 @@ videobridge {
     # How often we check endpoint's connectivity status
     check-interval = 500 milliseconds
   }
+  # Congestion Control
   cc {
     bwe-change-threshold = 0.15
-    thumbnail-max-height-px = 180
+    # The default constraint to use if the receiver signals ReceiverConstraints with missing defaultConstraints.
+    default-max-height-px = 180
+    # The constraint to use for the initial allocation, before the receiver has signaled ReceiverConstraints.
+    initial-max-height-px = 180
     onstage-preferred-height-px = 360
     onstage-preferred-framerate = 30
     // Whether the bridge is allowed to oversend (send the lowest layer regardless of BWE) for on-stage endpoints. If

diff --git a/jvb/src/test/kotlin/org/jitsi/videobridge/cc/allocation/EffectiveConstraintsTest.kt b/jvb/src/test/kotlin/org/jitsi/videobridge/cc/allocation/EffectiveConstraintsTest.kt
@@ -21,7 +21,6 @@ import io.kotest.core.spec.style.ShouldSpec
 import io.kotest.matchers.shouldBe
 import org.jitsi.nlj.MediaSourceDesc
 import org.jitsi.nlj.VideoType
-import org.jitsi.videobridge.cc.config.BitrateControllerConfig
 
 fun testSource(endpointId: String, sourceName: String, videoType: VideoType = VideoType.CAMERA): MediaSourceDesc {
     return MediaSourceDesc(
@@ -44,7 +43,7 @@ class EffectiveConstraintsTest : ShouldSpec() {
         val s5 = testSource("e1", "s5", videoType = VideoType.DISABLED)
         val s6 = testSource("e1", "s6", videoType = VideoType.DISABLED)
 
-        val defaultConstraints = VideoConstraints(BitrateControllerConfig.config.thumbnailMaxHeightPx)
+        val defaultConstraints = VideoConstraints(180)
 
         val sources = listOf(s1, s2, s3, s4, s5, s6)
         val zeroEffectiveConstraints = mutableMapOf(