lib/membrane_rtc_engine/endpoint.ex

defmodule Membrane.RTC.Engine.Endpoint do
  @moduledoc """
  Module representing RTC Engine's endpoint.

  For specific information about possible endpoints, refer to the documentation of `Membrane.RTC.Engine`.
  """
  use Bunch.Access
  alias Membrane.RTC.Engine.Track

  @type id() :: any()

  @type type() :: module()

  @typedoc """
  Module representing RTC Engine's endpoint.

  This module contains:
  * `id` - id of the endpoint.
  * `type` - type of the endpoint.
  * `metadata` - metadata of the endpoint, assigned when engine receives `{:ready, metadata}` message from the endpoint.
  * `inbound_tracks` - inbound tracks (received by the endpoint from "outside" of the engine) of the endpoint.
  """
  @type t :: %__MODULE__{
          id: id(),
          type: type(),
          metadata: any(),
          inbound_tracks: %{Track.id() => Track.t()}
        }

  @enforce_keys [:id, :type]
  defstruct @enforce_keys ++ [metadata: nil, inbound_tracks: %{}]

  @spec new(id :: id(), type :: type(), inbound_tracks :: [Track.t()]) :: t()
  def new(id, type, inbound_tracks) do
    inbound_tracks = Map.new(inbound_tracks, &{&1.id, &1})
    %__MODULE__{id: id, type: type, inbound_tracks: inbound_tracks}
  end

  @spec get_audio_tracks(endpoint :: t()) :: [Track.t()]
  def get_audio_tracks(endpoint),
    do: Map.values(endpoint.inbound_tracks) |> Enum.filter(&(&1.type == :audio))

  @spec get_video_tracks(endpoint :: t()) :: [Track.t()]
  def get_video_tracks(endpoint),
    do: Map.values(endpoint.inbound_tracks) |> Enum.filter(&(&1.type == :video))

  @spec get_track_by_id(endpoint :: t(), id :: Track.id()) :: Track.t() | nil
  def get_track_by_id(endpoint, id), do: endpoint.inbound_tracks[id]

  @spec get_tracks(endpoint :: t()) :: [Track.t()]
  def get_tracks(endpoint), do: Map.values(endpoint.inbound_tracks)

  @spec update_track_metadata(endpoint :: t(), track_id :: Track.id(), metadata :: any()) :: t()
  def update_track_metadata(endpoint, track_id, metadata),
    do:
      update_in(endpoint, [:inbound_tracks, track_id, :metadata], fn _old_metadata -> metadata end)

  @spec get_active_tracks(endpoint :: t()) :: [Track.t()]
  def get_active_tracks(%__MODULE__{} = endpoint),
    do:
      endpoint.inbound_tracks
      |> Map.values()
      |> Enum.filter(& &1.active?)

  @spec get_active_track_metadata(endpoint :: t()) :: %{Track.id() => any}
  def get_active_track_metadata(%__MODULE__{} = endpoint),
    do:
      endpoint
      |> get_active_tracks()
      |> Map.new(&{&1.id, &1.metadata})

  @spec update_track_encoding(endpoint :: t(), track_id :: Track.id(), encoding :: atom) :: t()
  def update_track_encoding(endpoint, track_id, value),
    do: update_in(endpoint.inbound_tracks[track_id], &%Track{&1 | encoding: value})
end