Skip to content
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.

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

Add onMetaData command support #84

Merged
merged 1 commit into from
Jan 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions lib/membrane_rtmp_plugin/rtmp/source/message.ex
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,13 @@ defmodule Membrane.RTMP.Message do
"FCPublish" => Messages.FCPublish,
"createStream" => Messages.CreateStream,
"publish" => Messages.Publish,
"@setDataFrame" => Messages.SetDataFrame
"@setDataFrame" => Messages.SetDataFrame,
"onMetaData" => Messages.OnMetaData
}

@amf_data_to_module %{
"@setDataFrame" => Messages.SetDataFrame
"@setDataFrame" => Messages.SetDataFrame,
"onMetaData" => Messages.OnMetaData
}

@spec deserialize_message(type_id :: integer(), binary()) :: struct()
Expand Down
11 changes: 11 additions & 0 deletions lib/membrane_rtmp_plugin/rtmp/source/message_handler.ex
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,17 @@ defmodule Membrane.RTMP.MessageHandler do
end
end

@validation_stage :on_meta_data
defp do_handle_client_message(%Messages.OnMetaData{} = on_meta_data, _header, state) do
case MessageValidator.validate_on_meta_data(state.validator, on_meta_data) do
{:ok, _msg} = result ->
{:cont, validation_action(state, @validation_stage, result)}

{:error, _reason} = error ->
{:halt, {:error, :stream_validation, validation_action(state, @validation_stage, error)}}
end
end

# According to ffmpeg's documentation, this command should prepare the server to receive media streams
# We are simply acknowledging the message
defp do_handle_client_message(%Messages.FCPublish{}, _header, state) do
Expand Down
6 changes: 6 additions & 0 deletions lib/membrane_rtmp_plugin/rtmp/source/message_validator.ex
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,10 @@ defprotocol Membrane.RTMP.MessageValidator do
"""
@spec validate_set_data_frame(t(), Messages.SetDataFrame.t()) :: validation_result_t()
def validate_set_data_frame(impl, message)

@doc """
Validates the `t:Membrane.RTMP.Messages.OnMetaData.t/0` message.
"""
@spec validate_on_meta_data(t(), Messages.OnMetaData.t()) :: validation_result_t()
def validate_on_meta_data(impl, message)
end
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,7 @@ defimpl Membrane.RTMP.MessageValidator, for: Membrane.RTMP.MessageValidator.Defa

@impl true
def validate_set_data_frame(_impl, _message), do: {:ok, "set data frame success"}

@impl true
def validate_on_meta_data(_impl, _message), do: {:ok, "on meta data success"}
end
74 changes: 74 additions & 0 deletions lib/membrane_rtmp_plugin/rtmp/source/messages/on_meta_data.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
defmodule Membrane.RTMP.Messages.OnMetaData do
@moduledoc """
Defines the RTMP `onMetaData` command (sent by nginx client).
"""

@behaviour Membrane.RTMP.Message

alias Membrane.RTMP.AMF.Encoder

@attributes_to_keys %{
Qizot marked this conversation as resolved.
Show resolved Hide resolved
"duration" => :duration,
"width" => :width,
"height" => :height,
"videocodecid" => :video_codec_id,
"videodatarate" => :video_data_rate,
"framerate" => :framerate,
"audiocodecid" => :audio_codec_id,
"audiodatarate" => :audio_data_rate
}

@keys_to_attributes Map.new(@attributes_to_keys, fn {key, value} -> {value, key} end)

defstruct Map.keys(@keys_to_attributes)

@type t :: %__MODULE__{
duration: number(),
# video related
width: number(),
height: number(),
video_codec_id: number(),
video_data_rate: number(),
framerate: number(),
# audio related
audio_codec_id: number(),
audio_data_rate: number()
}

@impl true
def from_data(["onMetaData", properties]) do
new(properties)
end

@spec new([{String.t(), any()}]) :: t()
def new(options) do
params =
options
|> Map.new()
|> Map.take(Map.keys(@attributes_to_keys))
|> Enum.map(fn {key, value} ->
{Map.fetch!(@attributes_to_keys, key), value}
end)

struct!(__MODULE__, params)
end

# helper for message serialization
@doc false
@spec to_map(t()) :: map()
def to_map(%__MODULE__{} = message) do
Map.new(message, fn {key, value} -> {Map.fetch!(@keys_to_attributes, key), value} end)
end

defimpl Membrane.RTMP.Messages.Serializer do
require Membrane.RTMP.Header

@impl true
def serialize(%@for{} = message) do
Encoder.encode([@for.to_map(message)])
end

@impl true
def type(%@for{}), do: Membrane.RTMP.Header.type(:amf_data)
end
end
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defmodule Membrane.RTMP.Mixfile do
use Mix.Project

@version "0.20.2"
@version "0.21.0"
@github_url "https://github.com/membraneframework/membrane_rtmp_plugin"

def project do
Expand Down
3 changes: 3 additions & 0 deletions test/support/test_validator.ex
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,7 @@ defimpl Membrane.RTMP.MessageValidator, for: Support.TestValidator do

@impl true
def validate_set_data_frame(_impl, _message), do: {:ok, "set data frame success"}

@impl true
def validate_on_meta_data(_impl, _message), do: {:ok, "on meta data success"}
end