Split new option into two

Author: FelonEkonom

lib/boombox.ex

@@ -86,7 +86,12 @@ defmodule Boombox do
           | {:stream, out_stream_opts()}
 
   @typep procs :: %{pipeline: pid(), supervisor: pid()}
-  @typep opts_map :: %{input: input(), output: output(), enforce_transcoding?: boolean()}
+  @typep opts_map :: %{
+           input: input(),
+           output: output(),
+           enforce_video_transcoding?: boolean(),
+           enforce_audio_transcoding?: boolean()
+         }
 
   @doc """
   Runs boombox with given input and output.
@@ -103,23 +108,36 @@ defmodule Boombox do
   If the input is `{:stream, opts}`, a `Stream` or other `Enumerable` is expected
   as the first argument.
 
-  If `:enforce_transcoding?` options is set to `true`, boombox will perform audio and/or video
-  transcoding, even if it is not necessary. By default this option is set to `false`.
+  If `:enforce_audio_transcoding?` or `:enforce_video_transcoding?` option is set to `true`,
+  boombox will perform audio and/or video transcoding, even if it is not necessary. By default
+  both options are set to `false`.
 
   ```
-  Boombox.run(input: "path/to/file.mp4", output: {:webrtc, "ws://0.0.0.0:1234"}, enforce_transcoding?: true)
+  Boombox.run(
+    input: "path/to/file.mp4",
+    output: {:webrtc, "ws://0.0.0.0:1234"},
+    enforce_video_transcoding?: true,
+    enforce_audio_transcoding?: true
+  )
   ```
   """
   @spec run(Enumerable.t() | nil,
           input: input(),
           output: output(),
-          enforce_transcoding?: boolean()
-        ) :: :ok | Enumerable.t()
+          enforce_video_transcoding?: boolean(),
+          enforce_audio_transcoding?: boolean()
+       ) :: :ok | Enumerable.t()
   @endpoint_opts [:input, :output]
   def run(stream \\ nil, opts) do
     opts =
       opts
-      |> Keyword.validate!(@endpoint_opts ++ [enforce_transcoding?: false])
+      |> Keyword.validate!(
+        @endpoint_opts ++
+          [
+            enforce_video_transcoding?: false,
+            enforce_audio_transcoding?: false
+          ]
+      )
       |> Map.new(fn
         {key, value} when key in @endpoint_opts -> {key, parse_endpoint_opt!(key, value)}
         {key, value} -> {key, value}
@@ -250,12 +268,12 @@ defmodule Boombox do
   @spec maybe_log_transcoding_related_warning(opts_map()) :: :ok
   def maybe_log_transcoding_related_warning(opts) do
     if is_webrtc_endpoint(opts.output) and not is_webrtc_endpoint(opts.input) and
-         not opts.enforce_transcoding? do
+         not opts.enforce_video_transcoding? do
       Logger.warning("""
       Boombox output protocol is WebRTC, while Boombox input doesn't support keyframe requests. This \
       might lead to issues with the output video if the output stream isn't sent only by localhost. You \
-      can solve this by setting `:enforce_transcoding?` option to `true`, but be aware that it will \
-      increase Boombox CPU usage.
+      can solve this by setting `:enforce_audio_transcoding?` option to `true`, but be aware that it \
+      will increase Boombox CPU usage.
       """)
     end
 

lib/boombox/elixir_stream.ex

@@ -5,7 +5,7 @@ defmodule Boombox.ElixirStream do
   require Membrane.Pad, as: Pad
 
   alias __MODULE__.{Sink, Source}
-  alias Boombox.Pipeline.Ready
+  alias Boombox.Pipeline.{Ready, State}
 
   @options_audio_keys [:audio_format, :audio_rate, :audio_channels]
 
@@ -41,9 +41,9 @@ defmodule Boombox.ElixirStream do
           options :: Boombox.out_stream_opts(),
           Boombox.Pipeline.track_builders(),
           Membrane.ChildrenSpec.t(),
-          boolean()
+          State.t()
         ) :: Ready.t()
-  def link_output(consumer, options, track_builders, spec_builder, enforce_transcoding?) do
+  def link_output(consumer, options, track_builders, spec_builder, state) do
     options = parse_options(options, :output)
 
     {track_builders, to_ignore} =
@@ -58,7 +58,7 @@ defmodule Boombox.ElixirStream do
             builder
             |> child(:mp4_audio_transcoder, %Membrane.Transcoder{
               output_stream_format: Membrane.RawAudio,
-              enforce_transcoding?: enforce_transcoding?
+              enforce_transcoding?: state.enforce_audio_transcoding?
             })
             |> maybe_plug_resampler(options)
             |> via_in(Pad.ref(:input, :audio))
@@ -68,7 +68,7 @@ defmodule Boombox.ElixirStream do
             builder
             |> child(:elixir_stream_video_transcoder, %Membrane.Transcoder{
               output_stream_format: Membrane.RawVideo,
-              enforce_transcoding?: enforce_transcoding?
+              enforce_transcoding?: state.enforce_video_transcoding?
             })
             |> child(:elixir_stream_rgb_converter, %Membrane.FFmpeg.SWScale.Converter{
               format: :RGB

lib/boombox/hls.ex

@@ -4,17 +4,17 @@ defmodule Boombox.HLS do
   import Membrane.ChildrenSpec
 
   require Membrane.Pad, as: Pad
-  alias Boombox.Pipeline.Ready
+  alias Boombox.Pipeline.{Ready, State}
   alias Membrane.H264
   alias Membrane.Time
 
   @spec link_output(
           Path.t(),
           Boombox.Pipeline.track_builders(),
           Membrane.ChildrenSpec.t(),
-          boolean()
+          State.t()
         ) :: Ready.t()
-  def link_output(location, track_builders, spec_builder, enforce_transcoding?) do
+  def link_output(location, track_builders, spec_builder, state) do
     {directory, manifest_name} =
       if Path.extname(location) == ".m3u8" do
         {Path.dirname(location), Path.basename(location, ".m3u8")}
@@ -46,7 +46,7 @@ defmodule Boombox.HLS do
             builder
             |> child(:hls_audio_transcoder, %Membrane.Transcoder{
               output_stream_format: Membrane.AAC,
-              enforce_transcoding?: enforce_transcoding?
+              enforce_transcoding?: state.enforce_audio_transcoding?
             })
             |> via_in(Pad.ref(:input, :audio),
               options: [encoding: :AAC, segment_duration: Time.milliseconds(2000)]
@@ -57,7 +57,7 @@ defmodule Boombox.HLS do
             builder
             |> child(:hls_video_transcoder, %Membrane.Transcoder{
               output_stream_format: %H264{alignment: :au, stream_structure: :avc3},
-              enforce_transcoding?: enforce_transcoding?
+              enforce_transcoding?: state.enforce_video_transcoding?
             })
             |> via_in(Pad.ref(:input, :video),
               options: [encoding: :H264, segment_duration: Time.milliseconds(2000)]

lib/boombox/mp4.ex

@@ -3,7 +3,7 @@ defmodule Boombox.MP4 do
 
   import Membrane.ChildrenSpec
   require Membrane.Pad, as: Pad
-  alias Boombox.Pipeline.{Ready, Wait}
+  alias Boombox.Pipeline.{Ready, State, Wait}
   alias Membrane.H264
   alias Membrane.H265
 
@@ -55,9 +55,9 @@ defmodule Boombox.MP4 do
           String.t(),
           Boombox.Pipeline.track_builders(),
           Membrane.ChildrenSpec.t(),
-          boolean()
+          State.t()
         ) :: Ready.t()
-  def link_output(location, track_builders, spec_builder, enforce_transcoding?) do
+  def link_output(location, track_builders, spec_builder, state) do
     spec =
       [
         spec_builder,
@@ -68,7 +68,7 @@ defmodule Boombox.MP4 do
             builder
             |> child(:mp4_audio_transcoder, %Membrane.Transcoder{
               output_stream_format: Membrane.AAC,
-              enforce_transcoding?: enforce_transcoding?
+              enforce_transcoding?: state.enforce_audio_transcoding?
             })
             |> child(:mp4_out_aac_parser, %Membrane.AAC.Parser{
               out_encapsulation: :none,
@@ -93,7 +93,7 @@ defmodule Boombox.MP4 do
                 _not_h26x ->
                   %H264{stream_structure: :avc3, alignment: :au}
               end,
-              enforce_transcoding?: enforce_transcoding?
+              enforce_transcoding?: state.enforce_video_transcoding?
             })
             |> via_in(Pad.ref(:input, :video))
             |> get_child(:mp4_muxer)

lib/boombox/pipeline.ex

@@ -53,7 +53,14 @@ defmodule Boombox.Pipeline do
   defmodule State do
     @moduledoc false
 
-    @enforce_keys [:status, :input, :output, :parent, :enforce_transcoding?]
+    @enforce_keys [
+      :status,
+      :input,
+      :output,
+      :parent,
+      :enforce_video_transcoding?,
+      :enforce_audio_transcoding?
+    ]
 
     defstruct @enforce_keys ++
                 [
@@ -96,7 +103,8 @@ defmodule Boombox.Pipeline do
             rtsp_state: Boombox.RTSP.state() | nil,
             parent: pid(),
             output_webrtc_state: Boombox.WebRTC.output_webrtc_state() | nil,
-            enforce_transcoding?: boolean()
+            enforce_video_transcoding?: boolean(),
+            enforce_audio_transcoding?: boolean()
           }
   end
 
@@ -106,7 +114,8 @@ defmodule Boombox.Pipeline do
       input: opts.input,
       output: opts.output,
       parent: opts.parent,
-      enforce_transcoding?: opts.enforce_transcoding?,
+      enforce_audio_transcoding?: opts.enforce_audio_transcoding?,
+      enforce_video_transcoding?: opts.enforce_video_transcoding?,
       status: :init
     }
 
@@ -359,25 +368,19 @@ defmodule Boombox.Pipeline do
   end
 
   defp link_output({:mp4, location}, track_builders, spec_builder, _ctx, state) do
-    Boombox.MP4.link_output(location, track_builders, spec_builder, state.enforce_transcoding?)
+    Boombox.MP4.link_output(location, track_builders, spec_builder, state)
   end
 
   defp link_output({:hls, location}, track_builders, spec_builder, _ctx, state) do
-    Boombox.HLS.link_output(location, track_builders, spec_builder, state.enforce_transcoding?)
+    Boombox.HLS.link_output(location, track_builders, spec_builder, state)
   end
 
   defp link_output({:rtp, opts}, track_builders, spec_builder, _ctx, state) do
-    Boombox.RTP.link_output(opts, track_builders, spec_builder, state.enforce_transcoding?)
+    Boombox.RTP.link_output(opts, track_builders, spec_builder, state)
   end
 
   defp link_output({:stream, opts}, track_builders, spec_builder, _ctx, state) do
-    Boombox.ElixirStream.link_output(
-      state.parent,
-      opts,
-      track_builders,
-      spec_builder,
-      state.enforce_transcoding?
-    )
+    Boombox.ElixirStream.link_output(state.parent, opts, track_builders, spec_builder, state)
   end
 
   # Wait between sending the last packet

lib/boombox/rtp.ex

@@ -4,7 +4,7 @@ defmodule Boombox.RTP do
 
   require Membrane.Pad
 
-  alias Boombox.Pipeline.Ready
+  alias Boombox.Pipeline.{Ready, State}
   alias Membrane.RTP
 
   @supported_encodings [audio: [:AAC, :Opus], video: [:H264, :H265]]
@@ -123,9 +123,9 @@ defmodule Boombox.RTP do
           Boombox.out_rtp_opts(),
           Boombox.Pipeline.track_builders(),
           Membrane.ChildrenSpec.t(),
-          boolean()
+          State.t()
         ) :: Ready.t()
-  def link_output(opts, track_builders, spec_builder, enforce_transcoding?) do
+  def link_output(opts, track_builders, spec_builder, state) do
     parsed_opts = validate_and_parse_options(:output, opts)
 
     spec = [
@@ -138,29 +138,29 @@ defmodule Boombox.RTP do
       Enum.map(track_builders, fn {media_type, builder} ->
         track_config = parsed_opts.track_configs[media_type]
 
-        {output_stream_format, parser, payloader} =
+        {output_stream_format, parser, payloader, enforce_transcoding?} =
           case track_config.encoding_name do
             :H264 ->
               {%Membrane.H264{stream_structure: :annexb, alignment: :nalu},
                %Membrane.H264.Parser{output_stream_structure: :annexb, output_alignment: :nalu},
-               Membrane.RTP.H264.Payloader}
+               Membrane.RTP.H264.Payloader, state.enforce_video_transcoding?}
 
             :AAC ->
               {%Membrane.AAC{encapsulation: :none},
                %Membrane.AAC.Parser{out_encapsulation: :none},
                %Membrane.RTP.AAC.Payloader{
                  mode: track_config.encoding_specific_params.aac_bitrate_mode,
                  frames_per_packet: 1
-               }}
+               }, state.enforce_video_transcoding?}
 
             :OPUS ->
               {Membrane.Opus, %Membrane.Opus.Parser{delimitation: :undelimit},
-               Membrane.RTP.Opus.Payloader}
+               Membrane.RTP.Opus.Payloader, state.enforce_audio_transcoding}
 
             :H265 ->
               {%Membrane.H265{stream_structure: :annexb, alignment: :nalu},
                %Membrane.H265.Parser{output_stream_structure: :annexb, output_alignment: :nalu},
-               Membrane.RTP.H265.Payloader}
+               Membrane.RTP.H265.Payloader, state.enforce_audio_transcoding}
           end
 
         builder

lib/boombox/webrtc.ex

@@ -149,7 +149,7 @@ defmodule Boombox.WebRTC do
           builder
           |> child(:mp4_audio_transcoder, %Membrane.Transcoder{
             output_stream_format: Membrane.Opus,
-            enforce_transcoding?: state.enforce_transcoding?
+            enforce_transcoding?: state.enforce_audio_transcoding?
           })
           |> child(:webrtc_out_audio_realtimer, Membrane.Realtimer)
           |> via_in(Pad.ref(:input, tracks.audio), options: [kind: :audio])
@@ -168,9 +168,9 @@ defmodule Boombox.WebRTC do
                 &1,
                 vp8_negotiated?,
                 h264_negotiated?,
-                state.enforce_transcoding?
+                state.enforce_video_transcoding?
               ),
-            enforce_transcoding?: state.enforce_transcoding?
+            enforce_transcoding?: state.enforce_video_transcoding?
           })
           |> via_in(Pad.ref(:input, tracks.video), options: [kind: :video])
           |> get_child(:webrtc_output)

mix.exs

@@ -47,10 +47,7 @@ defmodule Boombox.Mixfile do
   defp deps do
     [
       {:membrane_core, "~> 1.1"},
-      # {:membrane_transcoder_plugin, "~> 0.1.2"},
-      {:membrane_transcoder_plugin,
-       github: "membraneframework/membrane_transcoder_plugin",
-       ref: "9a6fbbb2318b5ac4c2ecbd77c5845d3e0ca62531"},
+      {:membrane_transcoder_plugin, "~> 0.1.3"},
       {:membrane_webrtc_plugin, "~> 0.24.0"},
       {:membrane_mp4_plugin, "~> 0.35.2"},
       {:membrane_realtimer_plugin, "~> 0.9.0"},

mix.lock

@@ -84,7 +84,7 @@
   "membrane_tee_plugin": {:hex, :membrane_tee_plugin, "0.12.0", "f94989b4080ef4b7937d74c1a14d3379577c7bd4c6d06e5a2bb41c351ad604d4", [:mix], [{:bunch, "~> 1.0", [hex: :bunch, repo: "hexpm", optional: false]}, {:membrane_core, "~> 1.0", [hex: :membrane_core, repo: "hexpm", optional: false]}], "hexpm", "0d61c9ed5e68e5a75d54200e1c6df5739c0bcb52fee0974183ad72446a179887"},
   "membrane_telemetry_metrics": {:hex, :membrane_telemetry_metrics, "0.1.1", "57917e72012f9ebe124eab54f29ca74c9d9eb3ae2207f55c95618ee51280eb4f", [:mix], [{:telemetry, "~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}, {:telemetry_metrics, "~> 0.6.1 or ~> 1.0", [hex: :telemetry_metrics, repo: "hexpm", optional: false]}], "hexpm", "69392966e6bd51937244758c2b3d835c5ff47d8953d25431a9d37059737afc11"},
   "membrane_timestamp_queue": {:hex, :membrane_timestamp_queue, "0.2.2", "1c831b2273d018a6548654aa9f7fa7c4b683f71d96ffe164934ef55f9d11f693", [:mix], [{:heap, "~> 2.0", [hex: :heap, repo: "hexpm", optional: false]}, {:membrane_core, "~> 1.0", [hex: :membrane_core, repo: "hexpm", optional: false]}], "hexpm", "7c830e760baaced0988421671cd2c83c7cda8d1bd2b61fd05332711675d1204f"},
-  "membrane_transcoder_plugin": {:git, "https://github.com/membraneframework/membrane_transcoder_plugin.git", "9a6fbbb2318b5ac4c2ecbd77c5845d3e0ca62531", [ref: "9a6fbbb2318b5ac4c2ecbd77c5845d3e0ca62531"]},
+  "membrane_transcoder_plugin": {:hex, :membrane_transcoder_plugin, "0.1.3", "cc8655a9a37d905551261b58623d10c34a91ab0a2b31206b70864a6179b94e3d", [:mix], [{:membrane_aac_fdk_plugin, "~> 0.18.0", [hex: :membrane_aac_fdk_plugin, repo: "hexpm", optional: false]}, {:membrane_aac_format, "~> 0.8.0", [hex: :membrane_aac_format, repo: "hexpm", optional: false]}, {:membrane_aac_plugin, "~> 0.19.0", [hex: :membrane_aac_plugin, repo: "hexpm", optional: false]}, {:membrane_core, "~> 1.1", [hex: :membrane_core, repo: "hexpm", optional: false]}, {:membrane_ffmpeg_swresample_plugin, "~> 0.20.0", [hex: :membrane_ffmpeg_swresample_plugin, repo: "hexpm", optional: false]}, {:membrane_funnel_plugin, "~> 0.9.1", [hex: :membrane_funnel_plugin, repo: "hexpm", optional: false]}, {:membrane_h264_ffmpeg_plugin, "~> 0.32.0", [hex: :membrane_h264_ffmpeg_plugin, repo: "hexpm", optional: false]}, {:membrane_h264_format, "~> 0.6.1", [hex: :membrane_h264_format, repo: "hexpm", optional: false]}, {:membrane_h265_ffmpeg_plugin, "~> 0.4.2", [hex: :membrane_h265_ffmpeg_plugin, repo: "hexpm", optional: false]}, {:membrane_h265_format, "~> 0.2.0", [hex: :membrane_h265_format, repo: "hexpm", optional: false]}, {:membrane_h26x_plugin, "~> 0.10.0", [hex: :membrane_h26x_plugin, repo: "hexpm", optional: false]}, {:membrane_opus_format, "~> 0.3.0", [hex: :membrane_opus_format, repo: "hexpm", optional: false]}, {:membrane_opus_plugin, "~> 0.20.3", [hex: :membrane_opus_plugin, repo: "hexpm", optional: false]}, {:membrane_timestamp_queue, "~> 0.2.2", [hex: :membrane_timestamp_queue, repo: "hexpm", optional: false]}, {:membrane_vp8_format, "~> 0.5.0", [hex: :membrane_vp8_format, repo: "hexpm", optional: false]}, {:membrane_vpx_plugin, "~> 0.3.0", [hex: :membrane_vpx_plugin, repo: "hexpm", optional: false]}], "hexpm", "3bf08fbeddec340515c5816ba276b7e553f1f7ef7d95e1b0ae8b215707ddda4c"},
   "membrane_udp_plugin": {:hex, :membrane_udp_plugin, "0.14.0", "d533ee5f6fcdd0551ad690045cdb6c1a76307a155d9255cc4a4606f85774bc37", [:mix], [{:membrane_core, "~> 1.0", [hex: :membrane_core, repo: "hexpm", optional: false]}, {:mockery, "~> 2.3.0", [hex: :mockery, repo: "hexpm", optional: false]}], "hexpm", "902d1a7aa228ec377482d53a605b100e20e0b6e59196f94f94147bb62b23c47e"},
   "membrane_vp8_format": {:hex, :membrane_vp8_format, "0.5.0", "a589c20bb9d97ddc9b717684d00cefc84e2500ce63a0c33c4b9618d9b2f9b2ea", [:mix], [], "hexpm", "d29e0dae4bebc6838e82e031c181fe626d168c687e4bc617c1d0772bdeed19d5"},
   "membrane_vp9_format": {:hex, :membrane_vp9_format, "0.5.0", "c6a4f2cbfc39dba5d80ad8287162c52b5cf6488676bd64435c1ac957bd16e66f", [:mix], [], "hexpm", "68752d8cbe7270ec222fc84a7d1553499f0d8ff86ef9d9e89f8955d49e20278e"},

test/browser_test.exs

@@ -108,16 +108,19 @@ defmodule Boombox.BrowserTest do
   end
 
   for first <- [:ingress, :egress], transcoding? <- [true, false] do
-    test "browser -> boombox -> browser, but #{first} browser page connects first and :enforce_transcoding? is set to #{transcoding?}",
+    test "browser -> boombox -> browser, but #{first} browser page connects first and :enforce_audio/video_transcoding? is set to #{transcoding?}",
          %{
            browser: browser
          } do
+      transcoding? = unquote(transcoding?)
+
       boombox_task =
         Task.async(fn ->
           Boombox.run(
             input: {:webrtc, "ws://localhost:8829"},
             output: {:webrtc, "ws://localhost:8830"},
-            enforce_transcoding?: unquote(transcoding?)
+            enforce_video_transcoding?: transcoding?,
+            enforce_audio_transcoding?: transcoding?
           )
         end)