build(deps): bump third-party/nvapi-open-source-sdk

Bumps [third-party/nvapi-open-source-sdk](https://github.com/LizardByte/nvapi-open-source-sdk) from `cce4e90` to `c873858`.
- [Commits](cce4e90b62...c873858214)

---
updated-dependencies:
- dependency-name: third-party/nvapi-open-source-sdk
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/ISSUE_TEMPLATE/config.yml

@@ -5,9 +5,15 @@
 
 blank_issues_enabled: false
 contact_links:
+  - name: Discussions
+    url: https://github.com/orgs/LizardByte/discussions
+    about: Community discussions
+  - name: Questions
+    url: https://github.com/orgs/LizardByte/discussions
+    about: Ask questions
+  - name: Feature Requests
+    url: https://github.com/orgs/LizardByte/discussions
+    about: Request new features
   - name: Support Center
     url: https://app.lizardbyte.dev/support
     about: Official LizardByte support
-  - name: Discussions
-    url: https://github.com/orgs/LizardByte/discussions
-    about: Community discussions, questions, and feature requests

.github/workflows/CI.yml

@@ -554,12 +554,16 @@ jobs:
           rm '/usr/local/bin/2to3-3.12'
           rm '/usr/local/bin/idle3'
           rm '/usr/local/bin/idle3.12'
+          rm '/usr/local/bin/idle3.13'
           rm '/usr/local/bin/pydoc3'
           rm '/usr/local/bin/pydoc3.12'
+          rm '/usr/local/bin/pydoc3.13'
           rm '/usr/local/bin/python3'
-          rm '/usr/local/bin/python3-config'
           rm '/usr/local/bin/python3.12'
+          rm '/usr/local/bin/python3.13'
+          rm '/usr/local/bin/python3-config'
           rm '/usr/local/bin/python3.12-config'
+          rm '/usr/local/bin/python3.13-config'
           brew install python
 
       - name: Setup python

.github/workflows/ci-docker.yml

@@ -123,7 +123,7 @@ jobs:
   docker:
     needs: [check_dockerfiles, setup_release]
     if: ${{ needs.check_dockerfiles.outputs.dockerfiles }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     permissions:
       packages: write
       contents: write

docs/configuration.md

@@ -974,7 +974,9 @@ editing the `conf` file in a text editor. Use the examples as reference.
     </tr>
     <tr>
         <td>Default</td>
-        <td colspan="2">@code{}verify_only@endcode</td>
+        <td colspan="2">@code{}
+            disabled
+            @endcode</td>
     </tr>
     <tr>
         <td>Example</td>
@@ -1314,6 +1316,29 @@ editing the `conf` file in a text editor. Use the examples as reference.
     </tr>
 </table>
 
+### max_bitrate
+
+<table>
+    <tr>
+        <td>Description</td>
+        <td colspan="2">
+            The maximum bitrate (in Kbps) that Sunshine will encode the stream at. If set to 0, it will always use the bitrate requested by Moonlight.
+        </td>
+    </tr>
+    <tr>
+        <td>Default</td>
+        <td colspan="2">@code{}
+            0
+            @endcode</td>
+    </tr>
+    <tr>
+        <td>Example</td>
+        <td colspan="2">@code{}
+            max_bitrate = 5000
+            @endcode</td>
+    </tr>
+</table>
+
 ### min_fps_factor
 
 <table>

package.json

@@ -10,12 +10,12 @@
   "dependencies": {
     "@lizardbyte/shared-web": "2024.921.191855",
     "vue": "3.5.13",
-    "vue-i18n": "11.0.1"
+    "vue-i18n": "11.1.1"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "4.6.2",
     "serve": "14.2.3",
-    "vite": "4.5.2",
+    "vite": "4.5.9",
     "vite-plugin-ejs": "1.6.4"
   }
 }

scripts/linux_build.sh

@@ -3,6 +3,7 @@ set -e
 
 # Default value for arguments
 appimage_build=0
+num_processors=$(nproc)
 publisher_name="Third Party Publisher"
 publisher_website=""
 publisher_issue_url="https://app.lizardbyte.dev/support"
@@ -27,6 +28,7 @@ Options:
   -h, --help               Display this help message.
   -s, --sudo-off           Disable sudo command.
   --appimage-build         Compile for AppImage, this will not create the AppImage, just the executable.
+  --num-processors         The number of processors to use for compilation. Default is the value of 'nproc'.
   --publisher-name         The name of the publisher (not developer) of the application.
   --publisher-website      The URL of the publisher's website.
   --publisher-issue-url    The URL of the publisher's support site or issue tracker.
@@ -53,6 +55,9 @@ while getopts ":hs-:" opt; do
           appimage_build=1
           skip_libva=1
           ;;
+        num-processors=*)
+          num_processors="${OPTARG#*=}"
+          ;;
         publisher-name=*)
           publisher_name="${OPTARG#*=}"
           ;;
@@ -367,7 +372,7 @@ function run_install() {
       tar -xzf "${build_dir}/doxygen.tar.gz"
       cd "doxygen-${doxygen_min}"
       cmake -DCMAKE_BUILD_TYPE=Release -G="Ninja" -B="build" -S="."
-      ninja -C "build"
+      ninja -C "build" -j"${num_processors}"
       ninja -C "build" install
     else
       echo "Doxygen version too low, skipping docs"

scripts/requirements.txt

@@ -1,2 +1,2 @@
-Babel==2.16.0
+Babel==2.17.0
 clang-format

src/config.cpp

@@ -497,7 +497,7 @@ namespace config {
     {},  // output_name
 
     {
-      video_t::dd_t::config_option_e::verify_only,  // configuration_option
+      video_t::dd_t::config_option_e::disabled,  // configuration_option
       video_t::dd_t::resolution_option_e::automatic,  // resolution_option
       {},  // manual_resolution
       video_t::dd_t::refresh_rate_option_e::automatic,  // refresh_rate_option
@@ -509,7 +509,8 @@ namespace config {
       {}  // wa
     },  // display_device
 
-    1  // min_fps_factor
+    1,  // min_fps_factor
+    0  // max_bitrate
   };
 
   audio_t audio {
@@ -1138,6 +1139,7 @@ namespace config {
     bool_f(vars, "dd_wa_hdr_toggle", video.dd.wa.hdr_toggle);
 
     int_between_f(vars, "min_fps_factor", video.min_fps_factor, {1, 3});
+    int_f(vars, "max_bitrate", video.max_bitrate);
 
     path_f(vars, "pkey", nvhttp.pkey);
     path_f(vars, "cert", nvhttp.cert);

src/config.h

@@ -138,6 +138,7 @@ namespace config {
     } dd;
 
     int min_fps_factor;  // Minimum fps target, determines minimum frame time
+    int max_bitrate;  // Maximum bitrate, sets ceiling in kbps for bitrate requested from client
   };
 
   struct audio_t {

src/nvenc/nvenc_base.cpp

@@ -528,7 +528,7 @@ namespace nvenc {
 
     NV_ENC_LOCK_BITSTREAM lock_bitstream = {min_struct_version(NV_ENC_LOCK_BITSTREAM_VER, 1, 2)};
     lock_bitstream.outputBitstream = output_bitstream;
-    lock_bitstream.doNotWait = 0;
+    lock_bitstream.doNotWait = async_event_handle ? 1 : 0;
 
     if (async_event_handle && !wait_for_async_event(100)) {
       BOOST_LOG(error) << "NvEnc: frame " << frame_index << " encode wait timeout";

src/nvenc/nvenc_d3d11.cpp

@@ -10,11 +10,19 @@
 
 namespace nvenc {
 
+  nvenc_d3d11::nvenc_d3d11(NV_ENC_DEVICE_TYPE device_type):
+      nvenc_base(device_type) {
+    async_event_handle = CreateEvent(NULL, FALSE, FALSE, NULL);
+  }
+
   nvenc_d3d11::~nvenc_d3d11() {
     if (dll) {
       FreeLibrary(dll);
       dll = NULL;
     }
+    if (async_event_handle) {
+      CloseHandle(async_event_handle);
+    }
   }
 
   bool nvenc_d3d11::init_library() {
@@ -53,5 +61,9 @@ namespace nvenc {
     return false;
   }
 
+  bool nvenc_d3d11::wait_for_async_event(uint32_t timeout_ms) {
+    return WaitForSingleObject(async_event_handle, timeout_ms) == WAIT_OBJECT_0;
+  }
+
 }  // namespace nvenc
 #endif

src/nvenc/nvenc_d3d11.h

@@ -25,10 +25,7 @@ namespace nvenc {
    */
   class nvenc_d3d11: public nvenc_base {
   public:
-    explicit nvenc_d3d11(NV_ENC_DEVICE_TYPE device_type):
+    explicit nvenc_d3d11(NV_ENC_DEVICE_TYPE device_type);
-        nvenc_base(device_type) {
-    }
-
     ~nvenc_d3d11();
 
     /**
@@ -39,6 +36,7 @@ namespace nvenc {
 
   protected:
     bool init_library() override;
+    bool wait_for_async_event(uint32_t timeout_ms) override;
 
   private:
     HMODULE dll = NULL;

src/video.cpp

@@ -299,6 +299,7 @@ namespace video {
     REF_FRAMES_INVALIDATION = 1 << 8,  ///< Support reference frames invalidation
     ALWAYS_REPROBE = 1 << 9,  ///< This is an encoder of last resort and we want to aggressively probe for a better one
     YUV444_SUPPORT = 1 << 10,  ///< Encoder may support 4:4:4 chroma sampling depending on hardware
+    ASYNC_TEARDOWN = 1 << 11,  ///< Encoder supports async teardown on a different thread
   };
 
   class avcodec_encode_session_t: public encode_session_t {
@@ -503,7 +504,7 @@ namespace video {
       {},  // Fallback options
       "h264_nvenc"s,
     },
-    PARALLEL_ENCODING | REF_FRAMES_INVALIDATION | YUV444_SUPPORT  // flags
+    PARALLEL_ENCODING | REF_FRAMES_INVALIDATION | YUV444_SUPPORT | ASYNC_TEARDOWN  // flags
   };
 #elif !defined(__APPLE__)
   encoder_t nvenc {
@@ -1686,7 +1687,8 @@ namespace video {
         }
       }
 
-      auto bitrate = config.bitrate * 1000;
+      auto bitrate = ((config::video.max_bitrate > 0) ? std::min(config.bitrate, config::video.max_bitrate) : config.bitrate) * 1000;
+      BOOST_LOG(info) << "Streaming bitrate is " << bitrate;
       ctx->rc_max_rate = bitrate;
       ctx->bit_rate = bitrate;
 
@@ -1856,6 +1858,23 @@ namespace video {
       return;
     }
 
+    // As a workaround for NVENC hangs and to generally speed up encoder reinit,
+    // we will complete the encoder teardown in a separate thread if supported.
+    // This will move expensive processing off the encoder thread to allow us
+    // to restart encoding as soon as possible. For cases where the NVENC driver
+    // hang occurs, this thread may probably never exit, but it will allow
+    // streaming to continue without requiring a full restart of Sunshine.
+    auto fail_guard = util::fail_guard([&encoder, &session] {
+      if (encoder.flags & ASYNC_TEARDOWN) {
+        std::thread encoder_teardown_thread {[session = std::move(session)]() mutable {
+          BOOST_LOG(info) << "Starting async encoder teardown";
+          session.reset();
+          BOOST_LOG(info) << "Async encoder teardown complete";
+        }};
+        encoder_teardown_thread.detach();
+      }
+    });
+
     // set minimum frame time, avoiding violation of client-requested target framerate
     auto minimum_frame_time = std::chrono::milliseconds(1000 / std::min(config.framerate, (config::video.min_fps_factor * 10)));
     BOOST_LOG(debug) << "Minimum frame time set to "sv << minimum_frame_time.count() << "ms, based on min fps factor of "sv << config::video.min_fps_factor << "."sv;

src_assets/common/assets/web/apps.html

@@ -441,7 +441,7 @@
         );
         if (resp) {
           fetch("./api/apps/" + id, { method: "DELETE" }).then((r) => {
-            if (r.status == 200) document.location.reload();
+            if (r.status === 200) document.location.reload();
           });
         }
       },
@@ -557,7 +557,7 @@
           method: "POST",
           body: JSON.stringify(this.editForm),
         }).then((r) => {
-          if (r.status == 200) document.location.reload();
+          if (r.status === 200) document.location.reload();
         });
       },
     },

src_assets/common/assets/web/config.html

@@ -168,7 +168,7 @@
               "install_steam_audio_drivers": "enabled",
               "adapter_name": "",
               "output_name": "",
-              "dd_configuration_option": "verify_only",
+              "dd_configuration_option": "disabled",
               "dd_resolution_option": "auto",
               "dd_manual_resolution": "",
               "dd_refresh_rate_option": "auto",
@@ -179,6 +179,7 @@
               "dd_mode_remapping": {"mixed": [], "resolution_only": [], "refresh_rate_only": []},
               "dd_wa_hdr_toggle": "disabled",
               "min_fps_factor": 1,
+              "max_bitrate": 0,
             },
           },
           {

src_assets/common/assets/web/configs/tabs/audiovideo/DisplayDeviceOptions.vue

@@ -68,7 +68,7 @@ function addRemappingEntry() {
                   {{ $t('config.dd_config_label') }}
                 </label>
                 <select id="dd_configuration_option" class="form-select" v-model="config.dd_configuration_option">
-                  <option value="disabled">{{ $t('_common.disabled') }}</option>
+                  <option value="disabled">{{ $t('_common.disabled_def') }}</option>
                   <option value="verify_only">{{ $t('config.dd_config_verify_only') }}</option>
                   <option value="ensure_active">{{ $t('config.dd_config_ensure_active') }}</option>
                   <option value="ensure_primary">{{ $t('config.dd_config_ensure_primary') }}</option>

src_assets/common/assets/web/configs/tabs/audiovideo/DisplayModesSettings.vue

@@ -17,6 +17,13 @@ const config = ref(props.config)
     <input type="number" min="1" max="3" class="form-control" id="min_fps_factor" placeholder="1" v-model="config.min_fps_factor" />
     <div class="form-text">{{ $t('config.min_fps_factor_desc') }}</div>
   </div>
+
+  <!--max_bitrate-->
+  <div class="mb-3">
+    <label for="max_bitrate" class="form-label">{{ $t("config.max_bitrate") }}</label>
+    <input type="number" class="form-control" id="max_bitrate" placeholder="0" v-model="config.max_bitrate" />
+    <div class="form-text">{{ $t("config.max_bitrate_desc") }}</div>
+  </div>
 </template>
 
 <style scoped>

src_assets/common/assets/web/password.html

@@ -94,10 +94,10 @@
           method: "POST",
           body: JSON.stringify(this.passwordData),
         }).then((r) => {
-          if (r.status == 200) {
+          if (r.status === 200) {
             r.json().then((rj) => {
-              if (rj.status.toString() === "true") {
+              this.success = rj.status;
-                this.success = true;
+              if (this.success === true) {
                 setTimeout(() => {
                   document.location.reload();
                 }, 5000);

src_assets/common/assets/web/pin.html

@@ -42,7 +42,7 @@
         fetch("./api/pin", {method: "POST", body: b})
           .then((response) => response.json())
           .then((response) => {
-            if (response.status.toString().toLowerCase() === "true") {
+            if (response.status === true) {
               document.querySelector(
                 "#status"
               ).innerHTML = `<div class="alert alert-success" role="alert">${this.i18n.t('pin.pair_success')}</div>`;

src_assets/common/assets/web/public/assets/locale/en.json

@@ -160,7 +160,7 @@
     "dd_config_revert_delay_desc": "Additional delay in milliseconds to wait before reverting configuration when the app has been closed or the last session terminated. Main purpose is to provide a smoother transition when quickly switching between apps.",
     "dd_config_revert_on_disconnect": "Config revert on disconnect",
     "dd_config_revert_on_disconnect_desc": "Revert configuration upon disconnect of all clients instead of app close or last session termination.",
-    "dd_config_verify_only": "Verify that the display is enabled (default)",
+    "dd_config_verify_only": "Verify that the display is enabled",
     "dd_hdr_option": "HDR",
     "dd_hdr_option_auto": "Switch on/off the HDR mode as requested by the client (default)",
     "dd_hdr_option_disabled": "Do not change HDR settings",
@@ -252,6 +252,8 @@
     "log_level_desc": "The minimum log level printed to standard out",
     "log_path": "Logfile Path",
     "log_path_desc": "The file where the current logs of Sunshine are stored.",
+    "max_bitrate": "Maximum Bitrate",
+    "max_bitrate_desc": "The maximum bitrate (in Kbps) that Sunshine will encode the stream at. If set to 0, it will always use the bitrate requested by Moonlight.",
     "min_fps_factor": "Minimum FPS Factor",
     "min_fps_factor_desc": "Sunshine will use this factor to calculate the minimum time between frames. Increasing this value slightly may help when streaming mostly static content. Higher values will consume more bandwidth.",
     "min_threads": "Minimum CPU Thread Count",

src_assets/common/assets/web/troubleshooting.html

@@ -120,7 +120,8 @@
       </div>
       <ul id="client-list" class="list-group list-group-flush list-group-item-light" v-if="clients && clients.length > 0">
         <div v-for="client in clients" class="list-group-item d-flex">
-          <div class="p-2 flex-grow-1">{{client.name != "" ? client.name : $t('troubleshooting.unpair_single_unknown')}}</div><div class="me-2 ms-auto btn btn-danger" @click="unpairSingle(client.uuid)"><i class="fas fa-trash"></i></div>
+          <div class="p-2 flex-grow-1">{{ client.name !== "" ? client.name : $t('troubleshooting.unpair_single_unknown') }}</div>
+          <div class="me-2 ms-auto btn btn-danger" @click="unpairSingle(client.uuid)"><i class="fas fa-trash"></i></div>
         </div>
       </ul>
       <ul v-else class="list-group list-group-flush list-group-item-light">
@@ -176,7 +177,7 @@
         actualLogs() {
           if (!this.logFilter) return this.logs;
           let lines = this.logs.split("\n");
-          lines = lines.filter(x => x.indexOf(this.logFilter) != -1);
+          lines = lines.filter(x => x.indexOf(this.logFilter) !== -1);
           return lines.join("\n");
         }
       },
@@ -210,7 +211,7 @@
             .then((r) => r.json())
             .then((r) => {
               this.closeAppPressed = false;
-              this.closeAppStatus = r.status.toString() === "true";
+              this.closeAppStatus = r.status;
               setTimeout(() => {
                 this.closeAppStatus = null;
               }, 5000);
@@ -222,7 +223,7 @@
             .then((r) => r.json())
             .then((r) => {
               this.unpairAllPressed = false;
-              this.unpairAllStatus = r.status.toString() === "true";
+              this.unpairAllStatus = r.status;
               setTimeout(() => {
                 this.unpairAllStatus = null;
               }, 5000);
@@ -240,9 +241,9 @@
             .then((response) => response.json())
             .then((response) => {
               const clientList = document.querySelector("#client-list");
-              if (response.status === 'true' && response.named_certs && response.named_certs.length) {
+              if (response.status === true && response.named_certs && response.named_certs.length) {
                 this.clients = response.named_certs.sort((a, b) => {
-                  return (a.name.toLowerCase() > b.name.toLowerCase() || a.name == "" ? 1 : -1)
+                  return (a.name.toLowerCase() > b.name.toLowerCase() || a.name === "" ? 1 : -1)
                 });
               } else {
                 this.clients = [];
@@ -270,7 +271,7 @@
             .then((r) => r.json())
             .then((r) => {
               this.ddResetPressed = false;
-              this.ddResetStatus = r.status.toString() === "true";
+              this.ddResetStatus = r.status;
               setTimeout(() => {
                 this.ddResetStatus = null;
               }, 5000);

src_assets/common/assets/web/welcome.html

@@ -81,10 +81,10 @@
           body: JSON.stringify(this.passwordData),
         }).then((r) => {
           this.loading = false;
-          if (r.status == 200) {
+          if (r.status === 200) {
             r.json().then((rj) => {
-              if (rj.status.toString() === "true") {
+              this.success = rj.status;
-                this.success = true;
+              if (this.success === true) {
                 setTimeout(() => {
                   document.location.reload();
                 }, 5000);