Skip to content

RFC 45-4: Use protocol to select output type for streaming #8089

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

Merged
jp9000 merged 16 commits into from
Mar 20, 2023
Merged

RFC 45-4: Use protocol to select output type for streaming #8089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
201bcda
libobs,docs: Add protocol in Outputs API
tytan652 Aug 21, 2021
855956f
obs-outputs,obs-ffmpeg: Add protocol to service outputs
tytan652 Aug 21, 2021
513c6bc
rtmp-services: Add protocols to services JSON
tytan652 Apr 25, 2022
813b3b2
libobs,docs: Add protocol to Services API
tytan652 Sep 5, 2022
56411ed
libobs,docs: Add protocol enumeration functions
tytan652 Sep 5, 2022
fa58a38
rtmp-services: Add protocol getter to services
tytan652 Sep 5, 2022
48dc6dd
libobs,docs: Add supported codecs functions with output id
tytan652 Sep 28, 2022
5a40934
UI: Refactor Qt slots in stream settings page
tytan652 Sep 21, 2022
e00e271
UI: Use protocol to list compatible codecs
tytan652 Sep 28, 2022
9d8d98b
rtmp-services: Remove fallback to H264 if no codec found
tytan652 Oct 7, 2022
44ca002
UI: Use protocol to enable network options
tytan652 Sep 28, 2022
8d6cacc
UI: Remove hardcoded stream codec list
tytan652 Sep 28, 2022
e317c88
obs-ffmpeg: Remove AV1 from SRT/RIST supported codecs
tytan652 Jan 19, 2023
1e0f4a6
libobs,docs: Add preferred output type to Service API
tytan652 Oct 7, 2022
213eb61
rtmp-services: Remove output getter from rtmp_common
tytan652 Oct 7, 2022
ea28587
UI: Select streaming output based on the protocol
tytan652 Oct 7, 2022
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
1 change: 1 addition & 0 deletions UI/data/locale/en-US.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ Basic.AutoConfig.TestPage="Final Results"
Basic.AutoConfig.TestPage.SubTitle.Testing="The program is now executing a set of tests to estimate the ideal settings"
Basic.AutoConfig.TestPage.SubTitle.Complete="Testing complete"
Basic.AutoConfig.TestPage.TestingBandwidth="Performing bandwidth test, this may take a few minutes..."
Basic.AutoConfig.TestPage.TestingBandwidth.NoOutput="No output for the protocol of this service was found"
Basic.AutoConfig.TestPage.TestingBandwidth.Connecting="Connecting to: %1..."
Basic.AutoConfig.TestPage.TestingBandwidth.ConnectFailed="Failed to connect to any servers, please check your internet connection and try again."
Basic.AutoConfig.TestPage.TestingBandwidth.Server="Testing bandwidth for: %1"
Expand Down
52 changes: 49 additions & 3 deletions UI/window-basic-auto-config-test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ class TestMode {
#define SUBTITLE_TESTING TEST_STR("Subtitle.Testing")
#define SUBTITLE_COMPLETE TEST_STR("Subtitle.Complete")
#define TEST_BW TEST_STR("TestingBandwidth")
#define TEST_BW_NO_OUTPUT TEST_STR("TestingBandwidth.NoOutput")
#define TEST_BW_CONNECTING TEST_STR("TestingBandwidth.Connecting")
#define TEST_BW_CONNECT_FAIL TEST_STR("TestingBandwidth.ConnectFailed")
#define TEST_BW_SERVER TEST_STR("TestingBandwidth.Server")
Expand Down Expand Up @@ -155,6 +156,23 @@ static inline void string_depad_key(string &key)

const char *FindAudioEncoderFromCodec(const char *type);

static inline bool can_use_output(const char *prot, const char *output,
const char *prot_test1,
const char *prot_test2 = nullptr)
{
return (strcmp(prot, prot_test1) == 0 ||
(prot_test2 && strcmp(prot, prot_test2) == 0)) &&
(obs_get_output_flags(output) & OBS_OUTPUT_SERVICE) != 0;
}

static bool return_first_id(void *data, const char *id)
{
const char **output = (const char **)data;

*output = id;
return false;
}

void AutoConfigTestPage::TestBandwidthThread()
{
bool connected = false;
Expand Down Expand Up @@ -268,9 +286,37 @@ void AutoConfigTestPage::TestBandwidthThread()
/* -----------------------------------*/
/* create output */

const char *output_type = obs_service_get_output_type(service);
if (!output_type)
output_type = "rtmp_output";
/* Check if the service has a preferred output type */
const char *output_type =
obs_service_get_preferred_output_type(service);
if (!output_type ||
(obs_get_output_flags(output_type) & OBS_OUTPUT_SERVICE) == 0) {
/* Otherwise, prefer first-party output types */
const char *protocol = obs_service_get_protocol(service);

if (can_use_output(protocol, "rtmp_output", "RTMP", "RTMPS")) {
output_type = "rtmp_output";
} else if (can_use_output(protocol, "ffmpeg_hls_muxer",
"HLS")) {
output_type = "ffmpeg_hls_muxer";
} else if (can_use_output(protocol, "ffmpeg_mpegts_muxer",
"SRT", "RIST")) {
output_type = "ffmpeg_mpegts_muxer";
}

/* If third-party protocol, use the first enumerated type */
if (!output_type)
obs_enum_output_types_with_protocol(
protocol, &output_type, return_first_id);

/* If none, fail */
if (!output_type) {
QMetaObject::invokeMethod(
this, "Failure",
Q_ARG(QString, QTStr(TEST_BW_NO_OUTPUT)));
return;
}
}

OBSOutputAutoRelease output =
obs_output_create(output_type, "test_stream", nullptr, nullptr);
Expand Down
97 changes: 73 additions & 24 deletions UI/window-basic-main-outputs.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,73 @@ static bool CreateAACEncoder(OBSEncoder &res, string &id, int bitrate,
return false;
}

static inline bool can_use_output(const char *prot, const char *output,
const char *prot_test1,
const char *prot_test2 = nullptr)
{
return (strcmp(prot, prot_test1) == 0 ||
(prot_test2 && strcmp(prot, prot_test2) == 0)) &&
(obs_get_output_flags(output) & OBS_OUTPUT_SERVICE) != 0;
}

static bool return_first_id(void *data, const char *id)
{
const char **output = (const char **)data;

*output = id;
return false;
}

static const char *GetStreamOutputType(const obs_service_t *service)
{
const char *protocol = obs_service_get_protocol(service);
const char *output = nullptr;

if (!protocol) {
blog(LOG_WARNING, "The service '%s' has no protocol set",
obs_service_get_id(service));
return nullptr;
}

if (!obs_is_output_protocol_registered(protocol)) {
blog(LOG_WARNING, "The protocol '%s' is not registered",
protocol);
return nullptr;
}

/* Check if the service has a preferred output type */
output = obs_service_get_preferred_output_type(service);
if (output) {
if ((obs_get_output_flags(output) & OBS_OUTPUT_SERVICE) != 0)
return output;

blog(LOG_WARNING,
"The output '%s' is not registered, fallback to another one",
output);
}

/* Otherwise, prefer first-party output types */
if (can_use_output(protocol, "rtmp_output", "RTMP", "RTMPS")) {
return "rtmp_output";
} else if (can_use_output(protocol, "ffmpeg_hls_muxer", "HLS")) {
return "ffmpeg_hls_muxer";
} else if (can_use_output(protocol, "ffmpeg_mpegts_muxer", "SRT",
"RIST")) {
return "ffmpeg_mpegts_muxer";
}

/* If third-party protocol, use the first enumerated type */
obs_enum_output_types_with_protocol(protocol, &output, return_first_id);
if (output)
return output;

blog(LOG_WARNING,
"No output compatible with the service '%s' is registered",
obs_service_get_id(service));

return nullptr;
}

/* ------------------------------------------------------------------------ */

inline BasicOutputHandler::BasicOutputHandler(OBSBasic *main_) : main(main_)
Expand Down Expand Up @@ -913,18 +980,9 @@ bool SimpleOutput::SetupStreaming(obs_service_t *service)

/* --------------------- */

const char *type = obs_service_get_output_type(service);
if (!type) {
type = "rtmp_output";
const char *url = obs_service_get_url(service);
if (url != NULL &&
strncmp(url, FTL_PROTOCOL, strlen(FTL_PROTOCOL)) == 0) {
type = "ftl_output";
} else if (url != NULL && strncmp(url, RTMP_PROTOCOL,
strlen(RTMP_PROTOCOL)) != 0) {
type = "ffmpeg_mpegts_muxer";
}
}
const char *type = GetStreamOutputType(service);
if (!type)
return false;

/* XXX: this is messy and disgusting and should be refactored */
if (outputType != type) {
Expand Down Expand Up @@ -1898,18 +1956,9 @@ bool AdvancedOutput::SetupStreaming(obs_service_t *service)

/* --------------------- */

const char *type = obs_service_get_output_type(service);
if (!type) {
type = "rtmp_output";
const char *url = obs_service_get_url(service);
if (url != NULL &&
strncmp(url, FTL_PROTOCOL, strlen(FTL_PROTOCOL)) == 0) {
type = "ftl_output";
} else if (url != NULL && strncmp(url, RTMP_PROTOCOL,
strlen(RTMP_PROTOCOL)) != 0) {
type = "ffmpeg_mpegts_muxer";
}
}
const char *type = GetStreamOutputType(service);
if (!type)
return false;

/* XXX: this is messy and disgusting and should be refactored */
if (outputType != type) {
Expand Down
Loading