Add general use RTMP server #85

varsill · 2024-02-13T15:23:10Z

This PR:

adds a separate RTMP server capable of serving multiple clients

TODO:

Rewritte Membrane.RTMP.Source in such a manner that it uses the RTMP.Server
Add support for SSL socket
Update docs and examples

To run the server, use the following command:

Membrane.RTMP.Server.run(port: 1935)

and start some RTMP client, e.g. with the use FFmpeg:

ffmpeg -r 30 -f lavfi -i testsrc -vf scale=1280:960 -vcodec h264 -profile:v baseline -pix_fmt yuv420p -f flv rtmp://localhost:1935/live/test

…the message_handler's internal state. Add actions handler in rtmp server

…it callback from the behaviour

…s. Add support for :ssl sockets. Add new tests proper for new architecture

…e_rtmp_plugin into rtmp_server

mat-hek · 2024-02-28T12:05:22Z

lib/membrane_rtmp_plugin/rtmp/source/source.ex

-  @type ssl_socket_control_needed_t() :: {:ssl_socket_control_needed, :ssl.sslsocket(), pid()}
-
-  @type validation_stage_t :: :publish | :release_stream | :set_data_frame
+    flow_control: :push


Not sure if we should change it to push 🤔

mat-hek · 2024-02-28T12:09:39Z

lib/membrane_rtmp_plugin/rtmp/source/source_behaviour.ex

+  @behaviour Membrane.RTMP.Server.ClientHandlerBehaviour
+
+  @impl true
+  def handle_init() do


ability to pass some options to init would be probably useful

mat-hek · 2024-02-28T12:11:25Z

lib/membrane_rtmp_plugin/rtmp/source/source_behaviour.ex

+
+  @impl true
+  def handle_end_of_stream(state) do
+    if state.source_pid != nil, do: send(state.source_pid, :end_of_stream)


this probably should be buffered too

mat-hek · 2024-02-28T12:12:16Z

lib/membrane_rtmp_plugin/rtmp/source/source.ex

-  This notification is only sent when the `:output` pad never reaches `:start_of_stream`.
-  """
-  @type unexpected_socket_closed_t() :: :unexpected_socket_closed
+  def_options app: [], stream_key: [], server: []


a possibility to pass server options and have the server started by the source would be nice for use cases with a single client

mat-hek · 2024-02-28T14:33:47Z

lib/membrane_rtmp_plugin/rtmp_server.ex

+  @type t :: %__MODULE__{
+          port: :inet.port_number(),
+          behaviour: Membrane.RTMP.Server.ClientHandlerBehaviour.t(),
+          listener: pid()


it seems that the listener is always spawned and this pid is ignored in init

lib/membrane_rtmp_plugin/rtmp_server/client_handler.ex

lib/membrane_rtmp_plugin/rtmp/source/message_parser.ex

test/support/rtmp_source_test_pipeline.ex

test/membrane_rtmp_plugin/rtmp_source_bin_test.exs

mat-hek · 2024-02-28T14:54:05Z

lib/membrane_rtmp_plugin/rtmp/source/source.ex

-      _message ->
-        :noop
-    end
+    send(state.server, {:subscribe, state.app, state.stream_key, self()})


let's wrap all these sends with functions

since the source subscribes for the given stream key, does it mean you need to spawn the source upfront for each key you want to accept? Wouldn't it be better to receive the key from the server and decide what to do with it (spawn a pipeline possibly)?

…e_rtmp_plugin into rtmp_server

…rver

…ementation

mat-hek

Please also make sure that the CPU usage is still reasonable

mat-hek · 2024-05-29T14:24:38Z

lib/membrane_rtmp_plugin/rtmp/source/default_behaviour_implementation.ex

@@ -0,0 +1,82 @@
+defmodule Membrane.RTMP.Source.DefaultBehaviourImplementation do


Suggested change

defmodule Membrane.RTMP.Source.DefaultBehaviourImplementation do

defmodule Membrane.RTMP.Source.ClientHandler do

WDYT?

mat-hek · 2024-05-29T14:26:11Z

lib/membrane_rtmp_plugin/rtmp_server.ex

+
+  alias Membrane.RTMP.Server.ClientHandlerBehaviour
+
+  @enforce_keys [:behaviour, :port, :use_ssl?, :listen_options]


Suggested change

@enforce_keys [:behaviour, :port, :use_ssl?, :listen_options]

@enforce_keys [:client_handler, :port, :use_ssl?, :listen_options]

and perhaps listen_options shouldn't be configurable

mat-hek · 2024-05-29T14:44:03Z

lib/membrane_rtmp_plugin/rtmp_server.ex

+  Starts the RTMP server.
+  """
+  @spec start_link(server_options :: t(), name :: atom()) :: GenServer.on_start()
+  def start_link(server_options, name \\ nil) do


Let's move name to server_options, then we'll be able to pass {Membrane.RTMP.Server, options} to a supervisor. Also, the options are usually a keyword list in such cases.

…in source element and source bin

…<script.exs> in the examples.

README.md

examples/source.exs

examples/source_with_standalone_server.exs

mat-hek · 2024-06-13T08:46:43Z

examples/source_with_standalone_server.exs

+
+# Wait for the client handler
+client_handler =
+  receive do


Maybe we could have a very simple GenServer that would start a pipeline each time it gets the client handler?

I believe this one would require adding an option to subscribe to "any" app and any stream_key. It could be quite useful to have such an option, but perhaps let' add it in a separate PR, WDYT?

@varsill Ok, please create an issue, put it in TODO and assign @bartkrak ;) We should also have documentation for the message with client_ref, and the way to get the app and the stream key from there. Maybe we should allow awaiting for any app and stream key too.

examples/source_with_standalone_server.exs

lib/membrane_rtmp_plugin/rtmp/source/source.ex

…handler. Rename client handler pid into client ref. Make use of await_subscription function. Add app and stream key to the message with client ref. Improve README with description where output is expected. Update unifex to v1.2

varsill added 2 commits February 13, 2024 15:44

Add POC of RTMP server capable of serving multiple RTMP clients

5c0b665

Perform refactor. Move parsing functions to message_parser. Separate …

fe10680

…the message_handler's internal state. Add actions handler in rtmp server

varsill requested a review from Qizot as a code owner February 13, 2024 15:23

varsill marked this pull request as draft February 13, 2024 15:23

varsill added 12 commits February 13, 2024 16:26

Move client handler to a separate module

02f1f9d

Remove validator. Add RTMP.Server.Behaviour

2495cc6

Add ability to specify initial client handler state. Remove handle_in…

6c56ca0

…it callback from the behaviour

Rewrite Source and SourceBin to support new architecture. Adjust test…

982bc0d

…s. Add support for :ssl sockets. Add new tests proper for new architecture

Perform formatting

a821766

Fix compilation warnings

6262d90

Fix formatting

7888b2c

Refactor

2eaead3

Merge branch 'master' of https://github.com/membraneframework/membran…

0f4a5cd

…e_rtmp_plugin into rtmp_server

Add moduledocs and typespecs

6747ddd

Remove nonexisting reference in docs

348f525

fix dialyzer error

1d55c5e

varsill requested a review from mat-hek February 22, 2024 15:49

varsill added 4 commits February 26, 2024 16:27

Allow for spawning RTMP server under desired name

af6a05e

Fix a misspelling of a Source behaviour module

4e6358e

Add typespec for RTMP.Server.start_link/1

855c71d

perform formatting

6c6a4b4

mat-hek requested changes Feb 28, 2024

View reviewed changes

varsill added 8 commits May 21, 2024 15:49

Implement reviewers suggestions. Add backpressure mechanism.

e9df383

Fix tests running

baa1014

Add hansling of elements demands

3c3b351

Fix credo warnings

6a68408

Merge branch 'master' of https://github.com/membraneframework/membran…

27a5d20

…e_rtmp_plugin into rtmp_server

Fix options name

cf98cfd

simplify handling of demands

3518d97

Add helper function to send demands from the client handler

bc80001

Make source properly handle playing mode enterance in different modes

692c664

varsill requested a review from mat-hek May 22, 2024 13:40

varsill added 9 commits May 23, 2024 14:08

Make the rtmp source test server bind to port 0

385bce1

remove debugging leftover

a5a521d

Add ability not to pass controlling process to default source behaviour

8a53668

Update RTMPServer.subscribe() spec

7752fd8

Change handle_info into handle_cast for subscribe handling in RTMP se…

b833ff9

…rver

Add await_subscription/2 function in rtmp server

2620570

Fix a spec in rtmp server

6e15040

Add struct to define options in default source handler behaviour impl…

bd74a5a

…ementation

Fix credo warnings

83adaf3

varsill marked this pull request as ready for review May 28, 2024 14:01

mat-hek requested changes May 29, 2024

View reviewed changes

varsill mentioned this pull request May 29, 2024

Defer connection setup in RTMP Server membraneframework/membrane_core#812

Closed

mat-hek requested changes May 29, 2024

View reviewed changes

varsill added 3 commits June 11, 2024 11:34

Implement reviewers suggestions.

ecb4c3f

Update source description in the README. Add more comprehensive docs …

9dd8317

…in source element and source bin

Update source.exs example

5d11bfd

varsill requested a review from mat-hek June 11, 2024 10:08

varsill added 2 commits June 11, 2024 13:58

Add an example with standalone server. Use mix run instead of elixir …

8eee65c

…<script.exs> in the examples.

Revoke usage of elixir <script.exs> for sink examples.

cdc36d7

mat-hek reviewed Jun 13, 2024

View reviewed changes

varsill added 2 commits June 14, 2024 09:58

Fix credo warning

d976959

varsill requested a review from mat-hek June 14, 2024 08:06

mat-hek approved these changes Jun 14, 2024

View reviewed changes

varsill enabled auto-merge (squash) June 17, 2024 14:42

varsill disabled auto-merge June 17, 2024 14:43

mat-hek merged commit 00c9671 into master Jun 18, 2024
3 checks passed

mat-hek deleted the rtmp_server branch June 18, 2024 09:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add general use RTMP server #85

Add general use RTMP server #85

varsill commented Feb 13, 2024 •

edited

Loading

mat-hek Feb 28, 2024

mat-hek Feb 28, 2024

mat-hek Feb 28, 2024

mat-hek Feb 28, 2024

mat-hek Feb 28, 2024

mat-hek Feb 28, 2024

mat-hek left a comment

mat-hek May 29, 2024

varsill Jun 12, 2024

mat-hek May 29, 2024

varsill Jun 12, 2024

mat-hek May 29, 2024

varsill Jun 12, 2024

mat-hek Jun 13, 2024

varsill Jun 14, 2024

mat-hek Jun 14, 2024 •

edited

Loading

		@@ -0,0 +1,82 @@
		defmodule Membrane.RTMP.Source.DefaultBehaviourImplementation do

	defmodule Membrane.RTMP.Source.DefaultBehaviourImplementation do
	defmodule Membrane.RTMP.Source.ClientHandler do


		alias Membrane.RTMP.Server.ClientHandlerBehaviour

		@enforce_keys [:behaviour, :port, :use_ssl?, :listen_options]

	@enforce_keys [:behaviour, :port, :use_ssl?, :listen_options]
	@enforce_keys [:client_handler, :port, :use_ssl?, :listen_options]

Add general use RTMP server #85

Add general use RTMP server #85

Conversation

varsill commented Feb 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mat-hek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mat-hek Jun 14, 2024 • edited Loading

Choose a reason for hiding this comment

varsill commented Feb 13, 2024 •

edited

Loading

mat-hek Jun 14, 2024 •

edited

Loading