Files
WiVRn/server/encoder/encoder_settings.cpp
T

452 lines
12 KiB
C++

/*
* WiVRn VR streaming
* Copyright (C) 2022 Guillaume Meunier <[email protected]>
* Copyright (C) 2022 Patrick Nicolas <[email protected]>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "encoder_settings.h"
#include "driver/configuration.h"
#include "util/u_logging.h"
#include "utils/wivrn_vk_bundle.h"
#include "video_encoder.h"
#include <cmath>
#include <magic_enum.hpp>
#include <string>
#include <vulkan/vulkan.h>
#include "wivrn_config.h"
#if WIVRN_USE_NVENC
#include "video_encoder_nvenc.h"
#endif
#if WIVRN_USE_VAAPI
#include "ffmpeg/video_encoder_va.h"
#include <libavutil/ffversion.h>
#endif
namespace wivrn
{
// TODO: size independent bitrate
static const uint64_t default_bitrate = 50'000'000;
// subsampling is also in monado's distortion shader
static const uint8_t passthrough_subsampling = 2;
static const double passthrough_bitrate_factor = 0.05;
#define WIVRN_SPLIT_ENCODERS 1
static bool is_nvidia(vk::PhysicalDevice physical_device)
{
auto props = physical_device.getProperties();
return props.vendorID == 0x10DE;
}
static void split_bitrate(std::vector<wivrn::encoder_settings> & encoders, uint64_t bitrate)
{
double total_weight = 0;
for (auto & encoder: encoders)
{
double w = encoder.width * encoder.height;
switch (encoder.codec)
{
case wivrn::h264:
w *= 2;
break;
case wivrn::h265:
case wivrn::av1:
break;
}
encoder.bitrate = w;
total_weight += w;
}
for (auto & encoder: encoders)
{
encoder.bitrate_multiplier = encoder.bitrate / total_weight;
encoder.bitrate = encoder.bitrate_multiplier * bitrate;
}
}
void print_encoders(const std::vector<wivrn::encoder_settings> & encoders)
{
int group = -1;
for (auto & encoder: encoders)
{
if (encoder.group != group)
{
group = encoder.group;
U_LOG_I("Group %d", group);
}
std::string codec(magic_enum::enum_name(encoder.codec));
U_LOG_I("\t%s (%s)", encoder.encoder_name.c_str(), codec.c_str());
U_LOG_I("\tchannels: %s", std::string(magic_enum::enum_name(encoder.channels)).c_str());
U_LOG_I("\tsize:%" PRIu16 "x%" PRIu16 " offset:%" PRIu16 "x%" PRIu16,
encoder.width,
encoder.height,
encoder.offset_x,
encoder.offset_y);
U_LOG_I("\tbitrate: %" PRIu64 "Mbit/s", encoder.bitrate / 1'000'000);
}
}
static void check_scale(std::string_view encoder_name, video_codec codec, uint16_t width, uint16_t height, std::array<double, 2> & scale)
{
#if WIVRN_USE_NVENC
if (encoder_name == encoder_nvenc)
{
auto max = video_encoder_nvenc::get_max_size(codec);
if (width * scale[0] > max[0])
{
scale[0] = double(max[0] - 1) / width;
U_LOG_W("Image is too wide for encoder, reducing scale to %f", scale[0]);
}
if (height * scale[1] > max[1])
{
scale[1] = double(max[1] - 1) / width;
U_LOG_W("Image is too tall for encoder, reducing scale to %f", scale[1]);
}
}
#endif
}
#if WIVRN_USE_VAAPI
static constexpr auto ffmpeg_version()
{
std::array<int, 3> result;
std::string_view version = FFMPEG_VERSION;
for (auto & item: result)
{
auto dot = version.find(".");
auto number = version.substr(version.find_first_of("0123456789"), dot);
version = version.substr(dot + 1);
auto res = std::from_chars(number.begin(), number.end(), item);
if (res.ec != std::errc{})
throw std::invalid_argument("Failed to parse FFMPEG_VERSION " FFMPEG_VERSION);
}
return result;
}
static std::optional<wivrn::video_codec> filter_codecs_vaapi(wivrn_vk_bundle & bundle, const std::vector<wivrn::video_codec> & codecs)
{
video_encoder_ffmpeg::mute_logs mute;
encoder_settings s{
{
.width = 800,
.height = 600,
.video_width = 800,
.video_height = 600,
},
"vaapi",
default_bitrate,
};
for (auto codec: codecs)
{
if constexpr (ffmpeg_version()[0] < 6)
{
if (codec == wivrn::video_codec::h264)
{
U_LOG_W("Skip h264 on ffmpeg < 6 due to poor performance");
continue;
}
}
try
{
s.codec = codec;
video_encoder_va test(bundle, s, 60, 0);
return codec;
}
catch (...)
{}
U_LOG_I("Video codec %s not supported", std::string(magic_enum::enum_name(codec)).c_str());
}
return {};
}
#endif
#if WIVRN_USE_NVENC
static bool probe_nvenc(wivrn_vk_bundle & bundle)
{
static bool res = [&]() {
encoder_settings s{
{
.width = 800,
.height = 600,
.video_width = 800,
.video_height = 600,
.codec = h264,
},
encoder_nvenc,
default_bitrate,
};
try
{
video_encoder_nvenc test(bundle, s, 60, 0);
return true;
}
catch (std::exception & e)
{
U_LOG_W("nvenc not supported: %s", e.what());
return false;
} }();
return res;
}
#endif
static void fill_defaults(wivrn_vk_bundle & bundle, const std::vector<wivrn::video_codec> & headset_codecs, configuration::encoder & config)
{
if (config.name.empty())
{
if (is_nvidia(*bundle.physical_device))
{
#if WIVRN_USE_NVENC
if (probe_nvenc(bundle))
config.name = encoder_nvenc;
else
#else
U_LOG_W("nvidia GPU detected, but nvenc support not compiled");
#endif
{
#if WIVRN_USE_X264
config.name = encoder_x264;
config.codec = h264;
#else
U_LOG_E("no suitable encoder available (compile with x264 or nvenc support)");
#endif
}
}
else
{
#if WIVRN_USE_VAAPI
config.name = encoder_vaapi;
#elif WIVRN_USE_X264
U_LOG_W("ffmpeg support not compiled, vaapi encoder not available");
config.name = encoder_x264;
config.codec = h264;
#else
U_LOG_E("no suitable encoder available (compile with x264 or nvenc support)");
#endif
}
}
#if WIVRN_USE_VAAPI
if (config.name == encoder_vaapi and not config.codec)
{
config.codec = filter_codecs_vaapi(bundle, headset_codecs);
if (not config.codec)
{
U_LOG_W("Failed to initialize vaapi, fallback to software encoding");
config.name = encoder_x264;
config.codec = h264;
}
}
#endif
if (config.name == encoder_vulkan and not config.codec)
config.codec = h264;
#if WIVRN_USE_X264
if (config.name == encoder_x264)
config.codec = h264;
#endif
if (not config.codec)
config.codec = h264;
}
static std::vector<configuration::encoder> get_encoder_default_settings(wivrn_vk_bundle & bundle, const std::vector<wivrn::video_codec> & headset_codecs)
{
configuration::encoder base;
fill_defaults(bundle, headset_codecs, base);
#ifdef WIVRN_SPLIT_ENCODERS
if (base.name != encoder_x264)
{
/* Split in 3 parts:
* +--------+--------+
* | | |
* | | |
* +--------+ |
* | | |
* | | |
* | | |
* | | |
* | | |
* +--------+--------+
* All 3 are encoded sequentially, so that the smallest is ready earlier.
* Decoder can start work as fast as possible, reducing idle time.
*
*/
return {
{
.name = base.name,
.width = 0.5,
.height = 0.25,
.group = 0,
.codec = base.codec,
},
{
.name = base.name,
.width = 0.5,
.height = 0.75,
.offset_y = 0.25,
.group = 0,
.codec = base.codec,
},
{
.name = base.name,
.width = 0.5,
.offset_x = 0.5,
.group = 0,
.codec = base.codec,
},
};
}
#endif
return {base};
}
static uint16_t align(uint16_t value, uint16_t alignment)
{
return ((value + alignment - 1) / alignment) * alignment;
}
std::vector<encoder_settings> get_encoder_settings(wivrn_vk_bundle & bundle, uint32_t & width, uint32_t & height, const from_headset::headset_info_packet & info)
{
configuration config;
try
{
config = configuration::read_user_configuration();
}
catch (const std::exception & e)
{
U_LOG_E("Failed to read encoder configuration: %s", e.what());
}
if (config.encoders.empty())
config.encoders = get_encoder_default_settings(bundle, info.supported_codecs);
if (not config.encoder_passthrough)
config.encoder_passthrough.emplace();
config.encoder_passthrough->width = 1;
config.encoder_passthrough->height = 1;
config.encoder_passthrough->offset_x = 0;
config.encoder_passthrough->offset_y = 0;
fill_defaults(bundle, info.supported_codecs, *config.encoder_passthrough);
uint64_t bitrate = config.bitrate.value_or(default_bitrate);
std::array<double, 2> default_scale;
default_scale.fill(info.eye_gaze ? 0.35 : 0.5);
auto scale = config.scale.value_or(default_scale);
check_scale(config.encoder_passthrough->name,
*config.encoder_passthrough->codec,
// passthrough stream is subsampled
width / passthrough_subsampling,
height / passthrough_subsampling,
scale);
for (auto & encoder: config.encoders)
{
fill_defaults(bundle, info.supported_codecs, encoder);
assert(encoder.codec);
check_scale(encoder.name,
*encoder.codec,
std::ceil(encoder.width.value_or(1) * width),
std::ceil(encoder.height.value_or(1) * height),
scale);
}
width = align(width * scale[0], 64);
height = align(height * scale[1], 64);
std::vector<wivrn::encoder_settings> res;
std::unordered_map<std::string, int> groups;
int next_group = 0;
for (const auto & encoder: config.encoders)
{
if (encoder.group)
{
groups[encoder.name] = *encoder.group;
next_group = std::max(next_group, *encoder.group + 1);
}
}
for (const auto & encoder: config.encoders)
{
wivrn::encoder_settings settings{};
settings.channels = to_headset::video_stream_description::channels_t::colour;
settings.subsampling = 1;
settings.encoder_name = encoder.name;
settings.offset_x = align(std::ceil(encoder.offset_x.value_or(0) * width), 32);
settings.offset_y = align(std::ceil(encoder.offset_y.value_or(0) * height), 32);
settings.width = align(std::ceil(encoder.width.value_or(1) * width), 32);
settings.height = align(std::ceil(encoder.height.value_or(1) * height), 32);
settings.width = std::min<uint16_t>(settings.width, width - settings.offset_x);
settings.height = std::min<uint16_t>(settings.height, height - settings.offset_y);
settings.video_width = settings.width;
settings.video_height = settings.height;
settings.codec = *encoder.codec;
if (encoder.group)
settings.group = *encoder.group;
else
{
auto [it, inserted] = groups.emplace(encoder.name, next_group);
settings.group = it->second;
if (inserted)
++next_group;
}
settings.options = encoder.options;
settings.device = encoder.device;
res.push_back(settings);
}
split_bitrate(res, bitrate);
// passthrough encoder
{
const auto & encoder = *config.encoder_passthrough;
wivrn::encoder_settings settings{};
settings.channels = to_headset::video_stream_description::channels_t::alpha;
settings.subsampling = passthrough_subsampling;
settings.encoder_name = encoder.name;
settings.width = width / settings.subsampling;
settings.height = height / settings.subsampling;
assert(settings.width % 32 == 0);
assert(settings.height % 32 == 0);
settings.video_width = settings.width;
settings.video_height = settings.height;
settings.codec = *encoder.codec;
if (encoder.group)
settings.group = *encoder.group;
else
{
auto [it, inserted] = groups.emplace(encoder.name, next_group);
settings.group = it->second;
if (inserted)
++next_group;
}
settings.options = encoder.options;
settings.device = encoder.device;
settings.bitrate = bitrate * passthrough_bitrate_factor;
res.push_back(settings);
}
return res;
}
} // namespace wivrn