Skip to content

Add function to check if configured encoder is valid for service(s) #1620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mhoyer-streamlabs wants to merge 2 commits into
base: staging
Choose a base branch
from
Open

Add function to check if configured encoder is valid for service(s) #1620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d72642
Add function to check if configured encoder is valid for service(s)
mhoyer-streamlabs Jan 15, 2026
36f7998
Formatting
mhoyer-streamlabs Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions obs-studio-client/source/nodeobs_settings.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,21 @@ void settings::OBS_settings_saveSettings(const Napi::CallbackInfo &info)
return;
}

Napi::Value settings::OBS_settings_isValidEncoder(const Napi::CallbackInfo &info)
{
std::string category = info[0].ToString().Utf8Value();
auto conn = GetConnection(info);
if (!conn)
return info.Env().Undefined();

std::vector<ipc::value> response = conn->call_synchronous_helper("Settings", "OBS_settings_isValidEncoder", {ipc::value(category)});

if (!ValidateResponse(info, response))
return info.Env().Undefined();

return Napi::Boolean::New(info.Env(), response[1].value_union.ui32);
}

std::vector<std::string> settings::getListCategories(void)
{
std::vector<std::string> categories;
Expand Down Expand Up @@ -525,6 +540,7 @@ void settings::Init(Napi::Env env, Napi::Object exports)
{
exports.Set(Napi::String::New(env, "OBS_settings_getSettings"), Napi::Function::New(env, settings::OBS_settings_getSettings));
exports.Set(Napi::String::New(env, "OBS_settings_saveSettings"), Napi::Function::New(env, settings::OBS_settings_saveSettings));
exports.Set(Napi::String::New(env, "OBS_settings_isValidEncoder"), Napi::Function::New(env, settings::OBS_settings_isValidEncoder));
exports.Set(Napi::String::New(env, "OBS_settings_getListCategories"), Napi::Function::New(env, settings::OBS_settings_getListCategories));
exports.Set(Napi::String::New(env, "OBS_settings_getInputAudioDevices"), Napi::Function::New(env, settings::OBS_settings_getInputAudioDevices));
exports.Set(Napi::String::New(env, "OBS_settings_getOutputAudioDevices"), Napi::Function::New(env, settings::OBS_settings_getOutputAudioDevices));
Expand Down
2 changes: 2 additions & 0 deletions obs-studio-client/source/nodeobs_settings.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ void Init(Napi::Env env, Napi::Object exports);

Napi::Value OBS_settings_getSettings(const Napi::CallbackInfo &info);
void OBS_settings_saveSettings(const Napi::CallbackInfo &info);
Napi::Value OBS_settings_isValidEncoder(const Napi::CallbackInfo &info);

Napi::Value OBS_settings_getListCategories(const Napi::CallbackInfo &info);

Napi::Value OBS_settings_getInputAudioDevices(const Napi::CallbackInfo &info);
Expand Down
55 changes: 55 additions & 0 deletions obs-studio-server/source/nodeobs_settings.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ void OBS_settings::Register(ipc::server &srv)
cls->register_function(std::make_shared<ipc::function>(
"OBS_settings_saveSettings", std::vector<ipc::type>{ipc::type::String, ipc::type::UInt32, ipc::type::UInt32, ipc::type::Binary},
OBS_settings_saveSettings));
cls->register_function(std::make_shared<ipc::function>("OBS_settings_isValidEncoder", std::vector<ipc::type>{}, OBS_settings_isValidEncoder));
cls->register_function(
std::make_shared<ipc::function>("OBS_settings_getInputAudioDevices", std::vector<ipc::type>{}, OBS_settings_getInputAudioDevices));
cls->register_function(
Expand Down Expand Up @@ -1196,6 +1197,60 @@ static void converOldJimNvencEncoder(config_t *config, const std::string &config
}
}

static bool validateEncoderForService(StreamServiceId serviceId, const char *encoderToFind)
{
bool validEncoder = false;

//have encoder - find in encoders_set, validate 'streaming' flag and check availability based on 'check_availability_streaming' flag
for (int i = 0; i < encoders_set.size(); i++) {
if (std::string(encoderToFind) == encoders_set[i].simple_name || std::string(encoderToFind) == encoders_set[i].advanced_name) {
if (encoders_set[i].streaming) {
if (encoders_set[i].check_availability_streaming) {
if (isEncoderAvailableForStreaming(encoderToFind, OBS_service::getService(serviceId))) {
validEncoder = true;
break;
}
} else {
validEncoder = true;
}
}
break;
}
}

return validEncoder;
}

void OBS_settings::OBS_settings_isValidEncoder(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval)
{
const char *mode = NULL;
const char *curEncoder = NULL;
bool validEncoder = false;
std::string serviceToCheck = args[0].value_str;

//get mode and configured encoder
mode = config_get_string(ConfigManager::getInstance().getBasic(), "Output", "Mode");
if (mode == NULL) {
mode = "Simple";
}
if (strcmp(mode, "Advanced") == 0) {
curEncoder = config_get_string(ConfigManager::getInstance().getBasic(), "AdvOut", "Encoder");
} else {
curEncoder = config_get_string(ConfigManager::getInstance().getBasic(), "SimpleOutput", "StreamingEncoder");
}

if (serviceToCheck == "Both") {
validEncoder = validateEncoderForService(StreamServiceId::Main, curEncoder) && validateEncoderForService(StreamServiceId::Second, curEncoder);
} else if (serviceToCheck == "Stream") {
validEncoder = validateEncoderForService(StreamServiceId::Main, curEncoder);
} else if (serviceToCheck == "StreamSecond") {
validEncoder = validateEncoderForService(StreamServiceId::Second, curEncoder);
}

rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
rval.push_back(ipc::value(validEncoder));
}

void OBS_settings::getSimpleOutputSettings(std::vector<SubCategory> *outputSettings, config_t *config, bool isCategoryEnabled)
{
converOldJimNvencEncoder(config, "SimpleOutput", "StreamEncoder", "RecEncoder");
Expand Down
2 changes: 2 additions & 0 deletions obs-studio-server/source/nodeobs_settings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,8 @@ class OBS_settings {
static void OBS_settings_getSettings(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
static void OBS_settings_saveSettings(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);

static void OBS_settings_isValidEncoder(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);

static void saveGenericSettings(std::vector<SubCategory> genericSettings, std::string section, config_t *config);

static void OBS_settings_getInputAudioDevices(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
Expand Down
Loading