RFC 45-1: Add protocol in Outputs API and check service protocol in the "UI" by tytan652 · Pull Request #5104 · obsproject/obs-studio

tytan652 · 2021-08-09T12:11:39Z

Description

This PR is about the RFC 45.

Add a "protocols" and "protocols_prefixes" fields in obs_output_info and add protocols to outputs meant for serv
Make the UI skip services where the protocol is not registered and also skip RTMPS servers for service providing RTMP and RTMPS server when the later is not registered.

Motivation and Context

Part of the implementation of the RFC 45.

How Has This Been Tested?

Artifacts from Github actions will not much help with testing this PR since it build with all protocol support.

Build OBS without FTL support and check if "Glimesh" service is not shown.
Build OBS without RTMPS support and check if "YouTube - RTMPS" RTMPS servers, "Facebook Live" service and "STAGE TEN" are not shown, RTMPS servers from other services are also not shown.
Build OBS with support for both and check those three services are shown.

Types of changes

Bug fix (non-breaking change which fixes an issue)
- Showing services that are not supported is sort of a bug
New feature (non-breaking change which adds functionality)
Documentation (a change to documentation pages)

Checklist:

My code has been run through clang-format.
I have read the contributing document.
My code is not on the master branch.
The code has been tested.
All commit messages are properly formatted and commits squashed where appropriate.
I have included updates to all appropriate documentation.

tytan652 · 2021-08-21T07:04:57Z

Since I re-written the RFC 45, this PR needed also a rewrite. So rewrite done, ~~only the doc addition is missing~~.

pkviet

Just read quickly the pr. Haven't tested it. I just have these comments.

libobs/obs-module.c

tytan652 · 2022-09-13T11:16:52Z

Rebase and fix memory leaks by using bstrdup() and return a char * rather than a const char * for obs_output_get_prefix_protocol().

tytan652 · 2022-10-07T18:05:49Z

Removed useless !! in if ().

tytan652 · 2023-01-27T12:13:00Z

Add missing changes in the JSON Schema.

~~I moved an element by accident I will push to remove this changes soon.~~

tytan652 · 2023-02-16T13:00:10Z

Improved obs_register_output_s changes (stop using simple NULL checks).

tytan652 · 2023-03-11T20:08:33Z

Remove prefix related changes as it was done in the RFC.

libobs/obs-output.c

tytan652 · 2023-03-13T09:46:38Z

No longer enforce the "protocol" field in the JSON if the server URL is a RTMP(S) one.

tt2468 · 2023-03-16T08:22:14Z

plugins/obs-ffmpeg/obs-ffmpeg-hls-mux.c

 	.id = "ffmpeg_hls_muxer",
 	.flags = OBS_OUTPUT_AV | OBS_OUTPUT_ENCODED | OBS_OUTPUT_MULTI_TRACK |
 		 OBS_OUTPUT_SERVICE,
+	.protocols = "HLS",


As described in voice discussions, I personally believe that using uppercase for these values does not align with common lowercase OBS implementations like the .encoded_video_codecs field. While I understand the desire to use the strings from this value directly in the UI, I personally believe that it would be better to uppercase convert these values in the UI and use a hash table if we someday get a protocol which has mixed case.

As of this comment, I'm not aware of any protocols which we officially support which use mixed case: RTMP, RTMPS, SRT, RIST, FTL, HLS, WHIP

I personally believe that using uppercase for these values does not align with common lowercase OBS implementations like the .encoded_video_codecs field.

If you check #8090, you will see that the whole lowercase/uppercase situation on codecs is not aligned.

I was drawing a parallel to codecs in regards to them being all lowercase, even though when presented to the user they are given in their correctly-capitalized form. I was not using it as an example of the uppercase-convert suggestion.

even though when presented to the user they are given in their correctly-capitalized form

Technically we don't, we expose to the user encoders names or presets names.

If the server URL is not an RTMP(S) URL, the protocol field becomes required. The output field becomes required on non-RTMP(S) services to keep backward compatibility. Also skip service if the protocol is not available.

WizardCM added the Enhancement Improvement to existing functionality label Aug 9, 2021

tytan652 marked this pull request as ready for review August 9, 2021 12:26

tytan652 marked this pull request as draft August 9, 2021 12:30

tytan652 mentioned this pull request Aug 9, 2021

Add RFC: Service Overhaul obsproject/rfcs#39

Closed

tytan652 force-pushed the rfcs_phase_1 branch from 7c03512 to 92a4d40 Compare August 19, 2021 11:08

tytan652 changed the title ~~Add Protocol API basics and protocol check in rtmp-services~~ Add protocol in Outputs API and protocol check in rtmp-services Aug 21, 2021

tytan652 force-pushed the rfcs_phase_1 branch from 92a4d40 to 9291ec7 Compare August 21, 2021 07:01

tytan652 force-pushed the rfcs_phase_1 branch from 9291ec7 to 1bba68e Compare August 21, 2021 07:26

tytan652 force-pushed the rfcs_phase_1 branch 5 times, most recently from 9ae4dec to dc60332 Compare September 25, 2021 12:37

tytan652 force-pushed the rfcs_phase_1 branch from dc60332 to 04d4747 Compare October 3, 2021 13:09

tytan652 force-pushed the rfcs_phase_1 branch from 04d4747 to 78d6fcb Compare October 14, 2021 10:45

tytan652 force-pushed the rfcs_phase_1 branch 5 times, most recently from 83dd342 to d375551 Compare October 27, 2021 16:30

tytan652 changed the title ~~Add protocol in Outputs API and protocol check in rtmp-services~~ RFC 45: Add protocol in Outputs API and protocol check in rtmp-services Oct 27, 2021

tytan652 changed the title ~~RFC 45: Add protocol in Outputs API and protocol check in rtmp-services~~ RFC 45 part 1: Add protocol in Outputs API and protocol check in rtmp-services Oct 27, 2021

tytan652 force-pushed the rfcs_phase_1 branch from d375551 to a0fe830 Compare October 29, 2021 18:49

tytan652 changed the title ~~RFC 45 part 1: Add protocol in Outputs API and protocol check in rtmp-services~~ RFC 45 : Add protocol in Outputs API and protocol check in rtmp-services Oct 29, 2021

tytan652 changed the title ~~RFC 45 : Add protocol in Outputs API and protocol check in rtmp-services~~ RFC 45, PR N°1: Add protocol in Outputs API and protocol check in rtmp-services Oct 29, 2021

tytan652 force-pushed the rfcs_phase_1 branch 3 times, most recently from b49ae81 to f7e1611 Compare October 30, 2021 13:27

tytan652 marked this pull request as ready for review October 30, 2021 17:45

tytan652 force-pushed the rfcs_phase_1 branch 2 times, most recently from 382aeff to 99a625c Compare July 20, 2022 18:23

tytan652 force-pushed the rfcs_phase_1 branch 2 times, most recently from 1ecf4a9 to 2c69776 Compare August 8, 2022 08:32

tytan652 force-pushed the rfcs_phase_1 branch from 2c69776 to ebaa29d Compare August 17, 2022 11:09

tytan652 changed the title ~~RFC 45: Add protocol in Outputs API and check service protocol in the UI~~ RFC 45: Add protocol in Outputs API and check service protocol in the "UI" Aug 17, 2022

tytan652 force-pushed the rfcs_phase_1 branch 2 times, most recently from 877a7ea to 4a38200 Compare August 17, 2022 15:51

pkviet reviewed Aug 19, 2022

View reviewed changes

libobs/obs-module.c Outdated Show resolved Hide resolved

libobs/obs-module.c Outdated Show resolved Hide resolved

tytan652 force-pushed the rfcs_phase_1 branch 2 times, most recently from e1fc5c1 to d99e585 Compare August 19, 2022 12:45

tytan652 force-pushed the rfcs_phase_1 branch from d99e585 to 2e054ec Compare September 5, 2022 10:37

tytan652 marked this pull request as ready for review September 5, 2022 10:38

jp9000 approved these changes Mar 12, 2023

View reviewed changes

derrod reviewed Mar 12, 2023

View reviewed changes

libobs/obs-output.c Outdated Show resolved Hide resolved

tt2468 reviewed Mar 16, 2023

View reviewed changes

tytan652 added 3 commits March 19, 2023 15:29

libobs,docs: Add protocol in Outputs API

201bcda

obs-outputs,obs-ffmpeg: Add protocol to service outputs

855956f

rtmp-services: Add protocols to services JSON

513c6bc

If the server URL is not an RTMP(S) URL, the protocol field becomes required. The output field becomes required on non-RTMP(S) services to keep backward compatibility. Also skip service if the protocol is not available.

Uh oh!

Conversation

tytan652 commented Aug 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

tytan652 commented Aug 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkviet left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

tytan652 commented Sep 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tytan652 commented Oct 7, 2022

Uh oh!

tytan652 commented Jan 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tytan652 commented Feb 16, 2023

Uh oh!

tytan652 commented Mar 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

tytan652 commented Mar 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tt2468 Mar 16, 2023

Choose a reason for hiding this comment

Uh oh!

tytan652 Mar 16, 2023

Choose a reason for hiding this comment

Uh oh!

tt2468 Mar 16, 2023

Choose a reason for hiding this comment

Uh oh!

tytan652 Mar 16, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

tytan652 commented Aug 9, 2021 •

edited

Loading

tytan652 commented Aug 21, 2021 •

edited

Loading

tytan652 commented Sep 13, 2022 •

edited

Loading

tytan652 commented Jan 27, 2023 •

edited

Loading

tytan652 commented Mar 11, 2023 •

edited

Loading

tytan652 commented Mar 13, 2023 •

edited

Loading