Fix encoder selection (#1666)

summeroff · web-flow · commit 6eaf4a0b8139 · 2026-04-09T12:44:13.000-07:00
* get list of encoders in new api

* update ts

* codestyle fix
diff --git a/js/module.d.ts b/js/module.d.ts
@@ -805,6 +805,7 @@ export interface IStreaming {
     network: INetwork;
     video: IVideo;
     signalHandler: (signal: EOutputSignal) => void;
+    getAvailableEncoders(): IEncoderOption[];
     start(): void; // throws
     stop(force?: boolean): void;
     droppedFrames: number;
@@ -818,6 +819,10 @@ export interface EOutputSignal {
     code: number;
     error: string;
 }
+export interface IEncoderOption {
+    title: string;
+    name: string;
+}
 export interface ISimpleStreaming extends IStreaming {
     audioEncoder: IAudioEncoder;
     useAdvanced: boolean;
@@ -878,6 +883,7 @@ export interface IRecording extends IFileOutput {
     splitSize: number;
     fileResetTimestamps: boolean;
     signalHandler: (signal: EOutputSignal) => void;
+    getAvailableEncoders(): IEncoderOption[];
     start(): void;
     stop(force?: boolean): void;
     splitFile(): void;
diff --git a/js/module.ts b/js/module.ts
@@ -1712,6 +1712,7 @@ export interface IStreaming {
     network: INetwork,
     video: IVideo,
     signalHandler: (signal: EOutputSignal) => void,
+    getAvailableEncoders(): IEncoderOption[],
     start(): void, // throws
     stop(force?: boolean): void,
     droppedFrames: number;
@@ -1727,6 +1728,11 @@ export interface EOutputSignal {
     error: string
 }
 
+export interface IEncoderOption {
+    title: string,
+    name: string
+}
+
 export interface ISimpleStreaming extends IStreaming {
     audioEncoder: IAudioEncoder,
     useAdvanced: boolean,
@@ -1796,6 +1802,7 @@ export interface IRecording extends IFileOutput {
     splitSize: number,
     fileResetTimestamps: boolean,
     signalHandler: (signal: EOutputSignal) => void,
+    getAvailableEncoders(): IEncoderOption[],
     start(): void,
     stop(force?: boolean): void,
     splitFile(): void
diff --git a/obs-studio-client/source/advanced-recording.cpp b/obs-studio-client/source/advanced-recording.cpp
@@ -54,6 +54,7 @@ Napi::Object osn::AdvancedRecording::Init(Napi::Env env, Napi::Object exports)
 		 InstanceMethod("start", &osn::AdvancedRecording::Start),
 		 InstanceMethod("stop", &osn::AdvancedRecording::Stop),
 		 InstanceMethod("splitFile", &osn::AdvancedRecording::SplitFile),
+		 InstanceMethod("getAvailableEncoders", &osn::AdvancedRecording::GetAvailableEncoders),
 
 		 StaticAccessor("legacySettings", &osn::AdvancedRecording::GetLegacySettings, &osn::AdvancedRecording::SetLegacySettings),
 		 InstanceMethod("lastFile", &osn::AdvancedRecording::GetLastFile),
diff --git a/obs-studio-client/source/advanced-streaming.cpp b/obs-studio-client/source/advanced-streaming.cpp
@@ -55,6 +55,7 @@ Napi::Object osn::AdvancedStreaming::Init(Napi::Env env, Napi::Object exports)
 
 		 InstanceMethod("start", &osn::AdvancedStreaming::Start),
 		 InstanceMethod("stop", &osn::AdvancedStreaming::Stop),
+		 InstanceMethod("getAvailableEncoders", &osn::AdvancedStreaming::GetAvailableEncoders),
 
 		 StaticAccessor("legacySettings", &osn::AdvancedStreaming::GetLegacySettings, &osn::AdvancedStreaming::SetLegacySettings)});
 
diff --git a/obs-studio-client/source/enhanced-broadcasting-advanced-streaming.cpp b/obs-studio-client/source/enhanced-broadcasting-advanced-streaming.cpp
@@ -68,6 +68,7 @@ Napi::Object osn::EnhancedBroadcastingAdvancedStreaming::Init(Napi::Env env, Nap
 
 		 InstanceMethod("start", &osn::EnhancedBroadcastingAdvancedStreaming::Start),
 		 InstanceMethod("stop", &osn::EnhancedBroadcastingAdvancedStreaming::Stop),
+		 InstanceMethod("getAvailableEncoders", &osn::EnhancedBroadcastingAdvancedStreaming::GetAvailableEncoders),
 
 		 StaticAccessor("legacySettings", &osn::EnhancedBroadcastingAdvancedStreaming::GetLegacySettings,
 				&osn::EnhancedBroadcastingAdvancedStreaming::SetLegacySettings)});
diff --git a/obs-studio-client/source/enhanced-broadcasting-simple-streaming.cpp b/obs-studio-client/source/enhanced-broadcasting-simple-streaming.cpp
@@ -65,6 +65,7 @@ Napi::Object osn::EnhancedBroadcastingSimpleStreaming::Init(Napi::Env env, Napi:
 
 		 InstanceMethod("start", &osn::EnhancedBroadcastingSimpleStreaming::Start),
 		 InstanceMethod("stop", &osn::EnhancedBroadcastingSimpleStreaming::Stop),
+		 InstanceMethod("getAvailableEncoders", &osn::EnhancedBroadcastingSimpleStreaming::GetAvailableEncoders),
 
 		 StaticAccessor("legacySettings", &osn::EnhancedBroadcastingSimpleStreaming::GetLegacySettings,
 				&osn::EnhancedBroadcastingSimpleStreaming::SetLegacySettings)});
diff --git a/obs-studio-client/source/recording.cpp b/obs-studio-client/source/recording.cpp
@@ -77,6 +77,29 @@ void osn::Recording::SetSignalHandler(const Napi::CallbackInfo &info, const Napi
 	this->cb.SuppressDestruct();
 }
 
+Napi::Value osn::Recording::GetAvailableEncoders(const Napi::CallbackInfo &info)
+{
+	auto conn = GetConnection(info);
+	if (!conn)
+		return info.Env().Undefined();
+
+	std::vector<ipc::value> response = conn->call_synchronous_helper(className, "GetAvailableEncoders", {ipc::value(this->uid)});
+
+	if (!ValidateResponse(info, response))
+		return info.Env().Undefined();
+
+	Napi::Array arr = Napi::Array::New(info.Env());
+	uint32_t idx = 0;
+	for (size_t i = 1; i + 1 < response.size(); i += 2) {
+		Napi::Object obj = Napi::Object::New(info.Env());
+		obj.Set("title", Napi::String::New(info.Env(), response[i].value_str));
+		obj.Set("name", Napi::String::New(info.Env(), response[i + 1].value_str));
+		arr.Set(idx++, obj);
+	}
+
+	return arr;
+}
+
 void osn::Recording::Start(const Napi::CallbackInfo &info)
 {
 	auto conn = GetConnection(info);
diff --git a/obs-studio-client/source/recording.hpp b/obs-studio-client/source/recording.hpp
@@ -48,6 +48,7 @@ class Recording : public WorkerSignals, public FileOutput {
 	Napi::Value GetFileResetTimestamps(const Napi::CallbackInfo &info);
 	void SetFileResetTimestamps(const Napi::CallbackInfo &info, const Napi::Value &value);
 
+	Napi::Value GetAvailableEncoders(const Napi::CallbackInfo &info);
 	void Start(const Napi::CallbackInfo &info);
 	void Stop(const Napi::CallbackInfo &info);
 	void SplitFile(const Napi::CallbackInfo &info);
diff --git a/obs-studio-client/source/simple-recording.cpp b/obs-studio-client/source/simple-recording.cpp
@@ -58,6 +58,7 @@ Napi::Object osn::SimpleRecording::Init(Napi::Env env, Napi::Object exports)
 			InstanceMethod("start", &osn::SimpleRecording::Start),
 			InstanceMethod("stop", &osn::SimpleRecording::Stop),
 			InstanceMethod("splitFile", &osn::SimpleRecording::SplitFile),
+			InstanceMethod("getAvailableEncoders", &osn::SimpleRecording::GetAvailableEncoders),
 
 			StaticAccessor("legacySettings", &osn::SimpleRecording::GetLegacySettings, &osn::SimpleRecording::SetLegacySettings),
 			InstanceMethod("lastFile", &osn::SimpleRecording::GetLastFile),
diff --git a/obs-studio-client/source/simple-streaming.cpp b/obs-studio-client/source/simple-streaming.cpp
@@ -53,6 +53,7 @@ Napi::Object osn::SimpleStreaming::Init(Napi::Env env, Napi::Object exports)
 
 		 InstanceMethod("start", &osn::SimpleStreaming::Start),
 		 InstanceMethod("stop", &osn::SimpleStreaming::Stop),
+		 InstanceMethod("getAvailableEncoders", &osn::SimpleStreaming::GetAvailableEncoders),
 
 		 StaticAccessor("legacySettings", &osn::SimpleStreaming::GetLegacySettings, &osn::SimpleStreaming::SetLegacySettings)});
 
diff --git a/obs-studio-client/source/streaming.cpp b/obs-studio-client/source/streaming.cpp
@@ -325,6 +325,29 @@ void osn::Streaming::SetSignalHandler(const Napi::CallbackInfo &info, const Napi
 	this->cb.SuppressDestruct();
 }
 
+Napi::Value osn::Streaming::GetAvailableEncoders(const Napi::CallbackInfo &info)
+{
+	auto conn = GetConnection(info);
+	if (!conn)
+		return info.Env().Undefined();
+
+	std::vector<ipc::value> response = conn->call_synchronous_helper(className, "GetAvailableEncoders", {ipc::value(this->uid)});
+
+	if (!ValidateResponse(info, response))
+		return info.Env().Undefined();
+
+	Napi::Array arr = Napi::Array::New(info.Env());
+	uint32_t idx = 0;
+	for (size_t i = 1; i + 1 < response.size(); i += 2) {
+		Napi::Object obj = Napi::Object::New(info.Env());
+		obj.Set("title", Napi::String::New(info.Env(), response[i].value_str));
+		obj.Set("name", Napi::String::New(info.Env(), response[i + 1].value_str));
+		arr.Set(idx++, obj);
+	}
+
+	return arr;
+}
+
 void osn::Streaming::Start(const Napi::CallbackInfo &info)
 {
 	auto conn = GetConnection(info);
diff --git a/obs-studio-client/source/streaming.hpp b/obs-studio-client/source/streaming.hpp
@@ -61,6 +61,7 @@ class Streaming : public WorkerSignals {
 	Napi::Value GetKBitsPerSec(const Napi::CallbackInfo &info);
 	Napi::Value GetDataOutput(const Napi::CallbackInfo &info);
 
+	Napi::Value GetAvailableEncoders(const Napi::CallbackInfo &info);
 	void Start(const Napi::CallbackInfo &info);
 	void Stop(const Napi::CallbackInfo &info);
 };
diff --git a/obs-studio-server/source/osn-advanced-recording.cpp b/obs-studio-server/source/osn-advanced-recording.cpp
@@ -65,6 +65,7 @@ void osn::IAdvancedRecording::Register(ipc::server &srv)
 	cls->register_function(std::make_shared<ipc::function>("GetFileResetTimestamps", std::vector<ipc::type>{ipc::type::UInt64}, GetFileResetTimestamps));
 	cls->register_function(std::make_shared<ipc::function>("SetFileResetTimestamps", std::vector<ipc::type>{ipc::type::UInt64, ipc::type::UInt32},
 							       SetFileResetTimestamps));
+	cls->register_function(std::make_shared<ipc::function>("GetAvailableEncoders", std::vector<ipc::type>{ipc::type::UInt64}, GetAvailableEncoders));
 
 	srv.register_collection(cls);
 }
@@ -485,4 +486,16 @@ void osn::IAdvancedRecording::SetStreaming(void *data, const int64_t id, const s
 
 	rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
 	AUTO_DEBUG;
+}
+
+void osn::IAdvancedRecording::GetAvailableEncoders(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval)
+{
+	AdvancedRecording *recording = static_cast<AdvancedRecording *>(osn::IFileOutput::Manager::GetInstance().find(args[0].value_union.ui64));
+	if (!recording) {
+		PRETTY_ERROR_RETURN(ErrorCode::InvalidReference, "Advanced recording reference is not valid.");
+	}
+
+	rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
+	osn::EncoderUtils::getAvailableEncoders(rval, nullptr, false, true, recording->format);
+	AUTO_DEBUG;
 }
diff --git a/obs-studio-server/source/osn-advanced-recording.hpp b/obs-studio-server/source/osn-advanced-recording.hpp
@@ -71,5 +71,6 @@ class IAdvancedRecording : public IRecording {
 	static void SetLegacySettings(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
 	static void GetStreaming(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
 	static void SetStreaming(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
+	static void GetAvailableEncoders(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
 };
 }
diff --git a/obs-studio-server/source/osn-advanced-streaming.cpp b/obs-studio-server/source/osn-advanced-streaming.cpp
@@ -69,6 +69,7 @@ void osn::IAdvancedStreaming::Register(ipc::server &srv)
 	cls->register_function(std::make_shared<ipc::function>("GetTotalFrames", std::vector<ipc::type>{ipc::type::UInt64}, GetTotalFrames));
 	cls->register_function(std::make_shared<ipc::function>("GetKBitsPerSec", std::vector<ipc::type>{ipc::type::UInt64}, GetKBitsPerSec));
 	cls->register_function(std::make_shared<ipc::function>("GetDataOutput", std::vector<ipc::type>{ipc::type::UInt64}, GetDataOutput));
+	cls->register_function(std::make_shared<ipc::function>("GetAvailableEncoders", std::vector<ipc::type>{ipc::type::UInt64}, GetAvailableEncoders));
 
 	srv.register_collection(cls);
 }
@@ -565,4 +566,16 @@ void osn::IAdvancedStreaming::SetLegacySettings(void *data, const int64_t id, co
 
 	rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
 	AUTO_DEBUG;
+}
+
+void osn::IAdvancedStreaming::GetAvailableEncoders(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval)
+{
+	AdvancedStreaming *streaming = static_cast<AdvancedStreaming *>(osn::IStreaming::Manager::GetInstance().find(args[0].value_union.ui64));
+	if (!streaming) {
+		PRETTY_ERROR_RETURN(ErrorCode::InvalidReference, "Advanced streaming reference is not valid.");
+	}
+
+	rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
+	osn::EncoderUtils::getAvailableEncoders(rval, streaming->service, false, false, "");
+	AUTO_DEBUG;
 }
diff --git a/obs-studio-server/source/osn-advanced-streaming.hpp b/obs-studio-server/source/osn-advanced-streaming.hpp
@@ -69,5 +69,6 @@ class IAdvancedStreaming : public IStreaming {
 	static void Stop(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
 	static void GetLegacySettings(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
 	static void SetLegacySettings(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
+	static void GetAvailableEncoders(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
 };
 }
diff --git a/obs-studio-server/source/osn-encoders.cpp b/obs-studio-server/source/osn-encoders.cpp
@@ -199,6 +199,23 @@ bool osn::EncoderUtils::isEncoderCompatibleRecording(const char *encoderToFind,
 	return validEncoder;
 }
 
+void osn::EncoderUtils::getAvailableEncoders(std::vector<ipc::value> &rval, obs_service_t *service, bool simpleMode, bool recording,
+					     const std::string &container)
+{
+	for (int i = 0; i < videoEncoderOptions.size(); i++) {
+		const auto &opt = videoEncoderOptions[i];
+		const std::string &title = simpleMode ? opt.simple_title : opt.advanced_title;
+		const std::string &name = simpleMode ? opt.simple_name : opt.advanced_name;
+		if (title.empty() || name.empty())
+			continue;
+		std::string encoderName = simpleMode ? opt.getSimpleName() : opt.advanced_name;
+		if (isEncoderCompatible(encoderName, service, simpleMode, recording, container, i)) {
+			rval.push_back(ipc::value(title));
+			rval.push_back(ipc::value(name));
+		}
+	}
+}
+
 bool osn::EncoderUtils::isInvalidAppleEncoder(const char *encoderID)
 {
 #if defined(__APPLE__)
diff --git a/obs-studio-server/source/osn-encoders.hpp b/obs-studio-server/source/osn-encoders.hpp
@@ -24,6 +24,7 @@
 #include <unordered_set>
 #include "obs.h"
 #include "nodeobs_configManager.hpp"
+#include <ipc-server.hpp>
 
 //obs-x264 plugin
 #ifdef WIN32
@@ -116,6 +117,7 @@ bool isEncoderCompatible(std::string encoderName, obs_service_t *service, bool s
 bool isEncoderCompatibleStreaming(obs_service_t *service, const char *encoderToFind, bool simpleMode);
 bool isEncoderCompatibleRecording(const char *encoderToFind, const std::string &container, bool simpleMode);
 bool updateNvencPresets(obs_data_t *data, const char *encoderId);
+void getAvailableEncoders(std::vector<ipc::value> &rval, obs_service_t *service, bool simpleMode, bool recording, const std::string &container);
 const char *convertNvencSimplePreset(const char *old_preset);
 
 class EncoderSettings {
diff --git a/obs-studio-server/source/osn-simple-recording.cpp b/obs-studio-server/source/osn-simple-recording.cpp
@@ -60,6 +60,7 @@ void osn::ISimpleRecording::Register(ipc::server &srv)
 	cls->register_function(std::make_shared<ipc::function>("GetFileResetTimestamps", std::vector<ipc::type>{ipc::type::UInt64}, GetFileResetTimestamps));
 	cls->register_function(std::make_shared<ipc::function>("SetFileResetTimestamps", std::vector<ipc::type>{ipc::type::UInt64, ipc::type::UInt32},
 							       SetFileResetTimestamps));
+	cls->register_function(std::make_shared<ipc::function>("GetAvailableEncoders", std::vector<ipc::type>{ipc::type::UInt64}, GetAvailableEncoders));
 
 	srv.register_collection(cls);
 }
@@ -667,4 +668,16 @@ void osn::ISimpleRecording::SetLegacySettings(void *data, const int64_t id, cons
 
 	rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
 	AUTO_DEBUG;
+}
+
+void osn::ISimpleRecording::GetAvailableEncoders(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval)
+{
+	SimpleRecording *recording = static_cast<SimpleRecording *>(osn::IFileOutput::Manager::GetInstance().find(args[0].value_union.ui64));
+	if (!recording) {
+		PRETTY_ERROR_RETURN(ErrorCode::InvalidReference, "Simple recording reference is not valid.");
+	}
+
+	rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
+	osn::EncoderUtils::getAvailableEncoders(rval, nullptr, true, true, recording->format);
+	AUTO_DEBUG;
 }
diff --git a/obs-studio-server/source/osn-simple-recording.hpp b/obs-studio-server/source/osn-simple-recording.hpp
@@ -66,5 +66,6 @@ class ISimpleRecording : public IRecording {
 	static obs_encoder_t *CreateLegacyAudioEncoder();
 	static void GetStreaming(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
 	static void SetStreaming(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
+	static void GetAvailableEncoders(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
 };
 }
diff --git a/obs-studio-server/source/osn-simple-streaming.cpp b/obs-studio-server/source/osn-simple-streaming.cpp
@@ -65,6 +65,7 @@ void osn::ISimpleStreaming::Register(ipc::server &srv)
 	cls->register_function(std::make_shared<ipc::function>("GetTotalFrames", std::vector<ipc::type>{ipc::type::UInt64}, GetTotalFrames));
 	cls->register_function(std::make_shared<ipc::function>("GetKBitsPerSec", std::vector<ipc::type>{ipc::type::UInt64}, GetKBitsPerSec));
 	cls->register_function(std::make_shared<ipc::function>("GetDataOutput", std::vector<ipc::type>{ipc::type::UInt64}, GetDataOutput));
+	cls->register_function(std::make_shared<ipc::function>("GetAvailableEncoders", std::vector<ipc::type>{ipc::type::UInt64}, GetAvailableEncoders));
 
 	srv.register_collection(cls);
 }
@@ -606,4 +607,16 @@ void osn::ISimpleStreaming::SetLegacySettings(void *data, const int64_t id, cons
 
 	rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
 	AUTO_DEBUG;
+}
+
+void osn::ISimpleStreaming::GetAvailableEncoders(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval)
+{
+	SimpleStreaming *streaming = static_cast<SimpleStreaming *>(osn::IStreaming::Manager::GetInstance().find(args[0].value_union.ui64));
+	if (!streaming) {
+		PRETTY_ERROR_RETURN(ErrorCode::InvalidReference, "Simple streaming reference is not valid.");
+	}
+
+	rval.push_back(ipc::value((uint64_t)ErrorCode::Ok));
+	osn::EncoderUtils::getAvailableEncoders(rval, streaming->service, true, false, "");
+	AUTO_DEBUG;
 }
diff --git a/obs-studio-server/source/osn-simple-streaming.hpp b/obs-studio-server/source/osn-simple-streaming.hpp
@@ -64,5 +64,6 @@ class ISimpleStreaming : public IStreaming {
 	static void SetLegacySettings(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
 	static void SetLegacyVideoEncoderSettings(obs_encoder_t *encoder);
 	static void SetLegacyAudioEncoderSettings(obs_encoder_t *encoder);
+	static void GetAvailableEncoders(void *data, const int64_t id, const std::vector<ipc::value> &args, std::vector<ipc::value> &rval);
 };
 }
diff --git a/tests/osn-tests/src/test_osn_get_available_encoders.ts b/tests/osn-tests/src/test_osn_get_available_encoders.ts
