Implement Debug.Filter and Debug.Sink #552

FelonEkonom · 2023-05-08T15:26:50Z

Related Jira ticket: https://membraneframework.atlassian.net/browse/MC-174

mat-hek · 2023-05-09T09:14:55Z

lib/membrane/simple/filter.ex

+  Accepts 3 options:
+   - `:handle_buffer` - function with arity 1, that maps buffers handled by this filter. Defaults to `&(&1)`.
+   - `:handle_event` - function with arity 1, that maps events handled by this filter. Defaults to `&(&1)`.
+   - `:handle_stream_format` - function with arity 1, that maps stream formats handled by this filter. Defaults to `&(&1)`.


Let's move that to the options' descriptions. Defaults are automatically put there (generate the docs and verify)

mat-hek · 2023-05-09T09:16:46Z

lib/membrane/simple/filter.ex

+  def_options handle_buffer: [spec: (Buffer.t() -> Buffer.t()), default: &__MODULE__.identity/1],
+              handle_event: [spec: (Event.t() -> Event.t()), default: &__MODULE__.identity/1],


Suggested change

def_options handle_buffer: [spec: (Buffer.t() -> Buffer.t()), default: &__MODULE__.identity/1],

handle_event: [spec: (Event.t() -> Event.t()), default: &__MODULE__.identity/1],

def_options handle_buffer: [spec: (Buffer.t() -> Buffer.t() | [Buffer.t()]), default: &__MODULE__.identity/1],

handle_event: [spec: (Event.t() -> Event.t() | [Event.t()]), default: &__MODULE__.identity/1],

This should already work and may be useful

BTW, you can use &Function.identity/1

mat-hek · 2023-05-09T09:17:15Z

lib/membrane/simple/filter.ex

@@ -0,0 +1,68 @@
+defmodule Membrane.Simple.Filter do


Suggested change

defmodule Membrane.Simple.Filter do

defmodule Membrane.SimpleFilter do

mat-hek · 2023-05-09T09:17:25Z

lib/membrane/simple/sink.ex

@@ -0,0 +1,60 @@
+defmodule Membrane.Simple.Sink do


Suggested change

defmodule Membrane.Simple.Sink do

defmodule Membrane.SimpleSink do

mat-hek · 2023-05-09T09:29:01Z

lib/membrane/simple/sink.ex

+  @spec identity(any()) :: any()
+  def identity(arg), do: arg
+
+  def_options handle_buffer: [spec: (Buffer.t() -> any()), default: &__MODULE__.identity/1],
+              handle_event: [spec: (Event.t() -> any()), default: &__MODULE__.identity/1],
+              handle_stream_format: [
+                spec: (StreamFormat.t() -> any()),
+                default: &__MODULE__.identity/1
+              ]


Suggested change

@spec identity(any()) :: any()

def identity(arg), do: arg

def_options handle_buffer: [spec: (Buffer.t() -> any()), default: &__MODULE__.identity/1],

handle_event: [spec: (Event.t() -> any()), default: &__MODULE__.identity/1],

handle_stream_format: [

spec: (StreamFormat.t() -> any()),

default: &__MODULE__.identity/1

]

@spec noop(any()) :: any()

def noop(_arg), do: nil

def_options handle_buffer: [spec: (Buffer.t() -> any()), default: &__MODULE__.noop/1],

handle_event: [spec: (Event.t() -> any()), default: &__MODULE__.noop/1],

handle_stream_format: [

spec: (StreamFormat.t() -> any()),

default: &__MODULE__.noop/1

]

mat-hek · 2023-05-09T09:29:44Z

lib/membrane/simple/sink.ex

+  Accepts 3 options:
+   - `:handle_buffer` - function with arity 1, that will be called with all buffers handled by this sink
+   - `:handle_event` - function with arity 1, that will be called with all events handled by this sink
+   - `:handle_stream_format` - function with arity 1, that will be called with all stream formats handled by this sink


like in the filter, and mention that the returned values are ignored

mat-hek · 2023-05-09T10:04:24Z

test/membrane/integration/simple_elements_test.exs

+  defmodule HelperSource do
+    use Membrane.Source
+
+    def_output_pad :output, flow_control: :push, accepted_format: _any
+
+    defmodule StreamFormat do
+      defstruct []
+    end
+
+    @impl true
+    def handle_playing(_ctx, state) do
+      {[stream_format: {:output, %StreamFormat{}}], state}
+    end
+
+    @impl true
+    def handle_parent_notification({:send_buffers, number}, _ctx, state) do
+      buffers =
+        Enum.map(1..number, fn i ->
+          %Buffer{payload: inspect(i)}
+        end)
+
+      {[buffer: {:output, buffers}], state}
+    end
+  end


Does this do anything beyond the testing source?

This source works in push, while Testing Source works in pull

does it matter in this use case?

While LambaSink work in auto pull, number of produced and consumed buffers would be tremendous, if we used Testing.Sink

It wouldn't be more than you provide via the output option

mat-hek · 2023-05-11T09:01:48Z

lib/membrane/lambda_filter.ex

@@ -1,16 +1,11 @@
-defmodule Membrane.Simple.Filter do
+defmodule Membrane.LambdaFilter do


mat-hek · 2023-05-11T09:03:58Z

lib/membrane/lambda_filter.ex

+                default: &Function.identity/1,
+                description: """
+                Function with arity 1, that maps events handled by this filter.
+                Result of this function is passed to the `:event` action on the opposite pad to


hmm, this way we cannot know whether the event is going downstream or upstream, which is pretty important

mat-hek · 2023-05-12T12:20:07Z

lib/membrane/debug/filter.ex

+    opposite_pad =
+      case pad do
+        :input -> :output
+        :output -> :input
+      end


you can use the forward action instead

mat-hek · 2023-05-12T12:21:01Z

lib/membrane/debug/filter.ex

@@ -0,0 +1,84 @@
+defmodule Membrane.Debug.Filter do
+  @moduledoc """
+  Membrane Filter, that can be used to create a child that will be used to debug data flowing thouth pipeline.


Suggested change

Membrane Filter, that can be used to create a child that will be used to debug data flowing thouth pipeline.

Membrane Filter, that can be used to create a child that will be used to debug data flowing thouth pipeline.

FelonEkonom added 2 commits May 8, 2023 16:19

Write Simple.Sink and Simple.Filter implementation

068f183

Write tests for simple elements

f02cf51

FelonEkonom requested a review from mat-hek as a code owner May 8, 2023 15:26

FelonEkonom added 2 commits May 8, 2023 17:47

Update CHANGELOG.md

265d1b1

FIX TYPO

e3d9617

mat-hek requested changes May 9, 2023

View reviewed changes

FelonEkonom changed the title ~~Implement Simple.Filter and Simple.Sink~~ Implement Lambda.Filter and Lambda.Sink May 10, 2023

Implement comments from PR

4a40d78

FelonEkonom requested a review from mat-hek May 10, 2023 14:13

mat-hek reviewed May 11, 2023

View reviewed changes

Replace lambda elements with debug elements

8e63393

FelonEkonom changed the title ~~Implement Lambda.Filter and Lambda.Sink~~ Implement Debug.Filter and Debug.Sink May 12, 2023

Fix bug in alias in test

484c5d5

FelonEkonom requested a review from mat-hek May 12, 2023 09:46

Replace HelperSource with Testing.Source

b07ec00

mat-hek approved these changes May 12, 2023

View reviewed changes

FelonEkonom added 2 commits May 15, 2023 12:02

Implement suggestions from CR

a7a761b

Merge remote-tracking branch 'origin/master' into simple-elements

92cac56

FelonEkonom merged commit fade9a0 into master May 15, 2023

FelonEkonom deleted the simple-elements branch May 15, 2023 12:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Debug.Filter and Debug.Sink #552

Implement Debug.Filter and Debug.Sink #552

FelonEkonom commented May 8, 2023

mat-hek May 9, 2023

mat-hek May 9, 2023

mat-hek May 10, 2023 •

edited

Loading

mat-hek May 9, 2023

mat-hek May 9, 2023

mat-hek May 9, 2023

mat-hek May 9, 2023

mat-hek May 9, 2023

FelonEkonom May 10, 2023

mat-hek May 10, 2023

FelonEkonom May 10, 2023

mat-hek May 10, 2023

mat-hek May 11, 2023

mat-hek May 11, 2023

mat-hek May 12, 2023

mat-hek May 12, 2023

		def_options handle_buffer: [spec: (Buffer.t() -> Buffer.t()), default: &__MODULE__.identity/1],
		handle_event: [spec: (Event.t() -> Event.t()), default: &__MODULE__.identity/1],

	defmodule Membrane.Simple.Filter do
	defmodule Membrane.SimpleFilter do

	defmodule Membrane.Simple.Sink do
	defmodule Membrane.SimpleSink do

		@@ -1,16 +1,11 @@
		defmodule Membrane.Simple.Filter do
		defmodule Membrane.LambdaFilter do

	Membrane Filter, that can be used to create a child that will be used to debug data flowing thouth pipeline.
	Membrane Filter, that can be used to create a child that will be used to debug data flowing thouth pipeline.

Implement Debug.Filter and Debug.Sink #552

Implement Debug.Filter and Debug.Sink #552

Conversation

FelonEkonom commented May 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mat-hek May 10, 2023 • 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

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 May 10, 2023 •

edited

Loading