diff --git a/docs/configuration.md b/docs/configuration.md index 2b282d1c7a1..d4e3354045b 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -2303,6 +2303,33 @@ editing the `conf` file in a text editor. Use the examples as reference. +## VA-API Encoder + +### vaapi_strict_rc_buffer + + + + + + + + + + + + + + +
Description + Enabling this option can avoid dropped frames over the network during scene changes, but video quality may + be reduced during motion. + @note{This option only applies for H.264 and HEVC when using VA-API [encoder](#encoder) on AMD GPUs.} +
Default@code{} + disabled + @endcode
Example@code{} + vaapi_strict_rc_buffer = enabled + @endcode
+ ## Software Encoder ### sw_preset diff --git a/src/config.cpp b/src/config.cpp index 8475a5e3370..a61b69b96f1 100644 --- a/src/config.cpp +++ b/src/config.cpp @@ -377,6 +377,10 @@ namespace config { -1, }, // vt + { + false, // strict_rc_buffer + }, // vaapi + {}, // capture {}, // encoder {}, // adapter_name @@ -1014,6 +1018,8 @@ namespace config { int_f(vars, "vt_software", video.vt.vt_require_sw, vt::force_software_from_view); int_f(vars, "vt_realtime", video.vt.vt_realtime, vt::rt_from_view); + bool_f(vars, "vaapi_strict_rc_buffer", video.vaapi.strict_rc_buffer); + string_f(vars, "capture", video.capture); string_f(vars, "encoder", video.encoder); string_f(vars, "adapter_name", video.adapter_name); diff --git a/src/config.h b/src/config.h index e599afae454..891a4079772 100644 --- a/src/config.h +++ b/src/config.h @@ -71,6 +71,10 @@ namespace config { int vt_coder; } vt; + struct { + bool strict_rc_buffer; + } vaapi; + std::string capture; std::string encoder; std::string adapter_name; diff --git a/src/platform/common.h b/src/platform/common.h index 368bc733b19..ee48ed3909a 100644 --- a/src/platform/common.h +++ b/src/platform/common.h @@ -418,7 +418,7 @@ namespace platf { * @note Implementations may set or modify codec options prior to codec initialization. */ virtual void - init_codec_options(AVCodecContext *ctx, AVDictionary *options) {}; + init_codec_options(AVCodecContext *ctx, AVDictionary **options) {}; /** * @brief Prepare to derive a context. diff --git a/src/platform/linux/vaapi.cpp b/src/platform/linux/vaapi.cpp index ada6370034a..49cad211cf9 100644 --- a/src/platform/linux/vaapi.cpp +++ b/src/platform/linux/vaapi.cpp @@ -9,6 +9,7 @@ extern "C" { #include +#include #include #include #if !VA_CHECK_VERSION(1, 9, 0) @@ -129,13 +130,168 @@ namespace va { return 0; } + /** + * @brief Finds a supported VA entrypoint for the given VA profile. + * @param profile The profile to match. + * @return A valid encoding entrypoint or 0 on failure. + */ + VAEntrypoint + select_va_entrypoint(VAProfile profile) { + std::vector entrypoints(vaMaxNumEntrypoints(va_display)); + int num_eps; + auto status = vaQueryConfigEntrypoints(va_display, profile, entrypoints.data(), &num_eps); + if (status != VA_STATUS_SUCCESS) { + BOOST_LOG(error) << "Failed to query VA entrypoints: "sv << vaErrorStr(status); + return (VAEntrypoint) 0; + } + entrypoints.resize(num_eps); + + // Sorted in order of descending preference + VAEntrypoint ep_preferences[] = { + VAEntrypointEncSliceLP, + VAEntrypointEncSlice, + VAEntrypointEncPicture + }; + for (auto ep_pref : ep_preferences) { + if (std::find(entrypoints.begin(), entrypoints.end(), ep_pref) != entrypoints.end()) { + return ep_pref; + } + } + + return (VAEntrypoint) 0; + } + + /** + * @brief Determines if a given VA profile is supported. + * @param profile The profile to match. + * @return Boolean value indicating if the profile is supported. + */ + bool + is_va_profile_supported(VAProfile profile) { + std::vector profiles(vaMaxNumProfiles(va_display)); + int num_profs; + auto status = vaQueryConfigProfiles(va_display, profiles.data(), &num_profs); + if (status != VA_STATUS_SUCCESS) { + BOOST_LOG(error) << "Failed to query VA profiles: "sv << vaErrorStr(status); + return false; + } + profiles.resize(num_profs); + + return std::find(profiles.begin(), profiles.end(), profile) != profiles.end(); + } + + /** + * @brief Determines the matching VA profile for the codec configuration. + * @param ctx The FFmpeg codec context. + * @return The matching VA profile or `VAProfileNone` on failure. + */ + VAProfile + get_va_profile(AVCodecContext *ctx) { + if (ctx->codec_id == AV_CODEC_ID_H264) { + // There's no VAAPI profile for H.264 4:4:4 + return VAProfileH264High; + } + else if (ctx->codec_id == AV_CODEC_ID_HEVC) { + switch (ctx->profile) { + case FF_PROFILE_HEVC_REXT: + switch (av_pix_fmt_desc_get(ctx->sw_pix_fmt)->comp[0].depth) { + case 10: + return VAProfileHEVCMain444_10; + case 8: + return VAProfileHEVCMain444; + } + break; + case FF_PROFILE_HEVC_MAIN_10: + return VAProfileHEVCMain10; + case FF_PROFILE_HEVC_MAIN: + return VAProfileHEVCMain; + } + } + else if (ctx->codec_id == AV_CODEC_ID_AV1) { + switch (ctx->profile) { + case FF_PROFILE_AV1_HIGH: + return VAProfileAV1Profile1; + case FF_PROFILE_AV1_MAIN: + return VAProfileAV1Profile0; + } + } + + BOOST_LOG(error) << "Unknown encoder profile: "sv << ctx->profile; + return VAProfileNone; + } + void - init_codec_options(AVCodecContext *ctx, AVDictionary *options) override { - // Don't set the RC buffer size when using H.264 on Intel GPUs. It causes - // major encoding quality degradation. + init_codec_options(AVCodecContext *ctx, AVDictionary **options) override { + auto va_profile = get_va_profile(ctx); + if (va_profile == VAProfileNone || !is_va_profile_supported(va_profile)) { + // Don't bother doing anything if the profile isn't supported + return; + } + + auto va_entrypoint = select_va_entrypoint(va_profile); + if (va_entrypoint == 0) { + // It's possible that only decoding is supported for this profile + return; + } + auto vendor = vaQueryVendorString(va_display); - if (ctx->codec_id != AV_CODEC_ID_H264 || (vendor && !strstr(vendor, "Intel"))) { + + if (va_entrypoint == VAEntrypointEncSliceLP) { + BOOST_LOG(info) << "Using LP encoding mode"sv; + av_dict_set_int(options, "low_power", 1, 0); + } + else { + BOOST_LOG(info) << "Using normal encoding mode"sv; + } + + VAConfigAttrib rc_attr = { VAConfigAttribRateControl }; + auto status = vaGetConfigAttributes(va_display, va_profile, va_entrypoint, &rc_attr, 1); + if (status != VA_STATUS_SUCCESS) { + // Stick to the default rate control (CQP) + rc_attr.value = 0; + } + + VAConfigAttrib slice_attr = { VAConfigAttribEncMaxSlices }; + status = vaGetConfigAttributes(va_display, va_profile, va_entrypoint, &slice_attr, 1); + if (status != VA_STATUS_SUCCESS) { + // Assume only a single slice is supported + slice_attr.value = 1; + } + if (ctx->slices > slice_attr.value) { + BOOST_LOG(info) << "Limiting slice count to encoder maximum: "sv << slice_attr.value; + ctx->slices = slice_attr.value; + } + + // Use VBR with a single frame VBV when the user forces it and for known good cases: + // - Intel GPUs + // - AV1 + // + // VBR ensures the bitstream isn't full of filler data for bitrate undershoots and + // single frame VBV ensures that we don't have large bitrate overshoots (at least + // as much as they can be avoided without pre-analysis). + // + // When we have to resort to the default 1 second VBV for encoding quality reasons, + // we stick to CBR in order to avoid encoding huge frames after bitrate undershoots + // leave headroom available in the RC window. + if (config::video.vaapi.strict_rc_buffer || + (vendor && strstr(vendor, "Intel")) || + ctx->codec_id == AV_CODEC_ID_AV1) { ctx->rc_buffer_size = ctx->bit_rate * ctx->framerate.den / ctx->framerate.num; + + if (rc_attr.value & VA_RC_VBR) { + BOOST_LOG(info) << "Using VBR with single frame VBV size"sv; + av_dict_set(options, "rc_mode", "VBR", 0); + } + else if (rc_attr.value & VA_RC_CBR) { + BOOST_LOG(info) << "Using CBR with single frame VBV size"sv; + av_dict_set(options, "rc_mode", "CBR", 0); + } + else { + BOOST_LOG(info) << "Using default rate control with single frame VBV size"sv; + } + } + else { + BOOST_LOG(info) << "Using default rate control"sv; } } diff --git a/src/video.cpp b/src/video.cpp index ecd92e2504a..603eb334732 100644 --- a/src/video.cpp +++ b/src/video.cpp @@ -857,7 +857,6 @@ namespace video { { // Common options { - { "low_power"s, 1 }, { "async_depth"s, 1 }, { "idr_interval"s, std::numeric_limits::max() }, }, @@ -865,17 +864,13 @@ namespace video { {}, // HDR-specific options {}, // YUV444 SDR-specific options {}, // YUV444 HDR-specific options - { - // Fallback options - { "low_power"s, 0 }, // Not all VAAPI drivers expose LP entrypoints - }, + {}, // Fallback options std::make_optional("qp"s, &config::video.qp), "av1_vaapi"s, }, { // Common options { - { "low_power"s, 1 }, { "async_depth"s, 1 }, { "sei"s, 0 }, { "idr_interval"s, std::numeric_limits::max() }, @@ -884,17 +879,13 @@ namespace video { {}, // HDR-specific options {}, // YUV444 SDR-specific options {}, // YUV444 HDR-specific options - { - // Fallback options - { "low_power"s, 0 }, // Not all VAAPI drivers expose LP entrypoints - }, + {}, // Fallback options std::make_optional("qp"s, &config::video.qp), "hevc_vaapi"s, }, { // Common options { - { "low_power"s, 1 }, { "async_depth"s, 1 }, { "sei"s, 0 }, { "idr_interval"s, std::numeric_limits::max() }, @@ -903,15 +894,12 @@ namespace video { {}, // HDR-specific options {}, // YUV444 SDR-specific options {}, // YUV444 HDR-specific options - { - // Fallback options - { "low_power"s, 0 }, // Not all VAAPI drivers expose LP entrypoints - }, + {}, // Fallback options std::make_optional("qp"s, &config::video.qp), "h264_vaapi"s, }, // RC buffer size will be set in platform code if supported - LIMITED_GOP_SIZE | PARALLEL_ENCODING | SINGLE_SLICE_ONLY | NO_RC_BUF_LIMIT + LIMITED_GOP_SIZE | PARALLEL_ENCODING | NO_RC_BUF_LIMIT }; #endif @@ -1696,7 +1684,7 @@ namespace video { } // Allow the encoding device a final opportunity to set/unset or override any options - encode_device->init_codec_options(ctx.get(), options); + encode_device->init_codec_options(ctx.get(), &options); if (auto status = avcodec_open2(ctx.get(), codec, &options)) { char err_str[AV_ERROR_MAX_STRING_SIZE] { 0 }; diff --git a/src_assets/common/assets/web/config.html b/src_assets/common/assets/web/config.html index c9c0a6ddf71..a7681fdde02 100644 --- a/src_assets/common/assets/web/config.html +++ b/src_assets/common/assets/web/config.html @@ -257,6 +257,13 @@

{{ $t('config.configuration') }}

"vt_realtime": "enabled", }, }, + { + id: "vaapi", + name: "VA-API Encoder", + options: { + "vaapi_strict_rc_buffer": "disabled", + }, + }, { id: "sw", name: "Software Encoder", @@ -283,7 +290,7 @@

{{ $t('config.configuration') }}

var app = document.getElementById("app"); if (this.platform === "windows") { this.tabs = this.tabs.filter((el) => { - return el.id !== "vt"; + return el.id !== "vt" && el.id !== "vaapi"; }); } if (this.platform === "linux") { @@ -293,7 +300,7 @@

{{ $t('config.configuration') }}

} if (this.platform === "macos") { this.tabs = this.tabs.filter((el) => { - return el.id !== "amd" && el.id !== "nv" && el.id !== "qsv"; + return el.id !== "amd" && el.id !== "nv" && el.id !== "qsv" && el.id !== "vaapi"; }); } diff --git a/src_assets/common/assets/web/configs/tabs/ContainerEncoders.vue b/src_assets/common/assets/web/configs/tabs/ContainerEncoders.vue index 084c3001f57..1dce1403adf 100644 --- a/src_assets/common/assets/web/configs/tabs/ContainerEncoders.vue +++ b/src_assets/common/assets/web/configs/tabs/ContainerEncoders.vue @@ -5,6 +5,7 @@ import IntelQuickSyncEncoder from './encoders/IntelQuickSyncEncoder.vue' import AmdAmfEncoder from './encoders/AmdAmfEncoder.vue' import VideotoolboxEncoder from './encoders/VideotoolboxEncoder.vue' import SoftwareEncoder from './encoders/SoftwareEncoder.vue' +import VAAPIEncoder from './encoders/VAAPIEncoder.vue' const props = defineProps([ 'platform', @@ -45,6 +46,13 @@ const config = ref(props.config) :config="config" /> + + + +import { ref } from 'vue' + +const props = defineProps([ + 'platform', + 'config', +]) + +const config = ref(props.config) + + + + + diff --git a/src_assets/common/assets/web/public/assets/locale/en.json b/src_assets/common/assets/web/public/assets/locale/en.json index 12844fcf874..a41617fe682 100644 --- a/src_assets/common/assets/web/public/assets/locale/en.json +++ b/src_assets/common/assets/web/public/assets/locale/en.json @@ -310,6 +310,8 @@ "touchpad_as_ds4_desc": "If disabled, touchpad presence will not be taken into account during gamepad type selection.", "upnp": "UPnP", "upnp_desc": "Automatically configure port forwarding for streaming over the Internet", + "vaapi_strict_rc_buffer": "Strictly enforce frame bitrate limits for H.264/HEVC on AMD GPUs", + "vaapi_strict_rc_buffer_desc": "Enabling this option can avoid dropped frames over the network during scene changes, but video quality may be reduced during motion.", "virtual_sink": "Virtual Sink", "virtual_sink_desc": "Manually specify a virtual audio device to use. If unset, the device is chosen automatically. We strongly recommend leaving this field blank to use automatic device selection!", "virtual_sink_placeholder": "Steam Streaming Speakers",