Add handle EoS and SoS options to debug elements (#993)

* Add handle_end_of_stream option to debug elements

* Bump version

* Update changelog

* Fix typo

* Add handle_start_of_stream as well

* Update lib/membrane/debug/sink.ex

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update lib/membrane/debug/sink.ex

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Fix typo

* Implement AI suggestion

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: FelonEkonom

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.2.4
+ * Add `:handle_end_of_stream` and `:handle_start_of_stream` options to debug elements. [#993](https://github.com/membraneframework/membrane_core/pull/993)
+
 ## 1.2.3
  * Deprecate calling a children group `nil` in [#964](https://github.com/membraneframework/membrane_core/pull/964)
  * Adds new fields for the handle_child_terminated context: crash_initiator, exit_reason and group_name in [#964](https://github.com/membraneframework/membrane_core/pull/964)

lib/membrane/debug/filter.ex

@@ -26,9 +26,17 @@ defmodule Membrane.Debug.Filter do
   def_output_pad :output, accepted_format: _any, flow_control: :auto
 
   @spec noop(any()) :: :ok
-  def noop(_arg), do: :ok
+  def noop(_arg \\ nil), do: :ok
 
-  def_options handle_buffer: [
+  def_options handle_start_of_stream: [
+                spec: (-> any()),
+                default: &__MODULE__.noop/0,
+                description: """
+                Function with arity 0, that will be called when the start of stream is received on the input pad.
+                Result of this function is ignored.
+                """
+              ],
+              handle_buffer: [
                 spec: (Buffer.t() -> any()),
                 default: &__MODULE__.noop/1,
                 description: """
@@ -51,28 +59,48 @@ defmodule Membrane.Debug.Filter do
                 Function with arity 1, that will be called with all stream formats handled by this sink.
                 Result of this function is ignored.
                 """
+              ],
+              handle_end_of_stream: [
+                spec: (-> any()),
+                default: &__MODULE__.noop/0,
+                description: """
+                Function with arity 0, that will be called when the end of stream is received on the input pad.
+                Result of this function is ignored.
+                """
               ]
 
   @impl true
   def handle_init(_ctx, opts) do
     {[], Map.from_struct(opts)}
   end
 
+  @impl true
+  def handle_start_of_stream(:input, _ctx, state) do
+    _ignored = state.handle_start_of_stream.()
+    {[], state}
+  end
+
   @impl true
   def handle_buffer(:input, buffer, _ctx, state) do
-    _ingored = state.handle_buffer.(buffer)
+    _ignored = state.handle_buffer.(buffer)
     {[buffer: {:output, buffer}], state}
   end
 
   @impl true
   def handle_event(_pad, event, _ctx, state) do
-    _ingored = state.handle_event.(event)
+    _ignored = state.handle_event.(event)
     {[forward: event], state}
   end
 
   @impl true
   def handle_stream_format(:input, stream_format, _ctx, state) do
-    _ingored = state.handle_stream_format.(stream_format)
+    _ignored = state.handle_stream_format.(stream_format)
     {[stream_format: {:output, stream_format}], state}
   end
+
+  @impl true
+  def handle_end_of_stream(:input, _ctx, state) do
+    _ignored = state.handle_end_of_stream.()
+    {[end_of_stream: :output], state}
+  end
 end

lib/membrane/debug/sink.ex

@@ -21,9 +21,17 @@ defmodule Membrane.Debug.Sink do
   def_input_pad :input, accepted_format: _any, flow_control: :auto
 
   @spec noop(any()) :: :ok
-  def noop(_arg), do: :ok
+  def noop(_arg \\ nil), do: :ok
 
-  def_options handle_buffer: [
+  def_options handle_start_of_stream: [
+                spec: (-> any()),
+                default: &__MODULE__.noop/0,
+                description: """
+                Function with arity 0, that will be called when the start of stream is received on the input pad.
+                Result of this function is ignored.
+                """
+              ],
+              handle_buffer: [
                 spec: (Buffer.t() -> any()),
                 default: &__MODULE__.noop/1,
                 description: """
@@ -46,13 +54,27 @@ defmodule Membrane.Debug.Sink do
                 Function with arity 1, that will be called with all stream formats handled by this sink.
                 Result of this function is ignored.
                 """
+              ],
+              handle_end_of_stream: [
+                spec: (-> any()),
+                default: &__MODULE__.noop/0,
+                description: """
+                Function with arity 0, that will be called when the end of stream is received on the input pad.
+                Result of this function is ignored.
+                """
               ]
 
   @impl true
   def handle_init(_ctx, opts) do
     {[], Map.from_struct(opts)}
   end
 
+  @impl true
+  def handle_start_of_stream(:input, _ctx, state) do
+    _ignored = state.handle_start_of_stream.()
+    {[], state}
+  end
+
   @impl true
   def handle_buffer(:input, buffer, _ctx, state) do
     _ignored = state.handle_buffer.(buffer)
@@ -70,4 +92,10 @@ defmodule Membrane.Debug.Sink do
     _ignored = state.handle_stream_format.(stream_format)
     {[], state}
   end
+
+  @impl true
+  def handle_end_of_stream(:input, _ctx, state) do
+    _ignored = state.handle_end_of_stream.()
+    {[], state}
+  end
 end

mix.exs

@@ -1,7 +1,7 @@
 defmodule Membrane.Mixfile do
   use Mix.Project
 
-  @version "1.2.3"
+  @version "1.2.4"
   @source_ref "v#{@version}"
 
   def project do