Add set_log_level on ffmpeg (#46)

* Add set_log_level on ffmpeg

* Move set_log_level to Xav module; rename config key to :ffmpeg_log_level

Author: kipcole9

README.md

@@ -24,6 +24,33 @@ def deps do
 end
 ```
 
+## Controlling FFmpeg log output
+
+FFmpeg's underlying libraries (`libavcodec`, `libswscale`, ...) print to `stderr` at the `AV_LOG_INFO` level by default. This is usually fine but can produce informational noise such as
+
+```
+[swscaler @ 0x1490a0000] No accelerated colorspace conversion found from yuv420p to rgb24.
+```
+
+when `libswscale` falls back to a generic colorspace conversion path. These are not errors — decoded frames are bit-exact — but they can clutter test output and logs.
+
+You can raise the threshold from Elixir:
+
+```elixir
+Xav.set_log_level(:error)
+```
+
+Or set it once at application start by configuring your application env:
+
+```elixir
+# config/runtime.exs
+config :xav, ffmpeg_log_level: :error
+```
+
+`Xav.Application` reads this on boot and applies it before your supervision tree starts. Valid atoms are `:quiet`, `:panic`, `:fatal`, `:error`, `:warning`, `:info`, `:verbose`, `:debug`, and `:trace`. An integer FFmpeg level is also accepted.
+
+Note that `av_log_set_level/1` is process-global — changing the level affects every `libav*` call made from the current OS process, not just the reader that triggered the change.
+
 ## Usage
 
 Decode

c_src/xav/xav_reader.c

@@ -327,9 +327,31 @@ void free_xav_reader(ErlNifEnv *env, void *obj) {
   }
 }
 
-static ErlNifFunc xav_funcs[] = {{"new", 9, new},
-                                 {"next_frame", 1, next_frame, ERL_NIF_DIRTY_JOB_CPU_BOUND},
-                                 {"seek", 2, seek, ERL_NIF_DIRTY_JOB_CPU_BOUND}};
+/* Wraps av_log_set_level(int). The level integer is validated on the
+ * Elixir side (Xav.Reader.set_log_level/1 maps atoms to the AV_LOG_*
+ * constants) so the NIF only needs to pass it through. Note that
+ * av_log_set_level() is process-global: it changes the log level for
+ * every libav* call made from the current OS process, not just the
+ * reader that triggered the call. */
+ERL_NIF_TERM set_log_level(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]) {
+  if (argc != 1) {
+    return xav_nif_raise(env, "invalid_arg_count");
+  }
+
+  int level;
+  if (!enif_get_int(env, argv[0], &level)) {
+    return xav_nif_raise(env, "invalid_log_level");
+  }
+
+  av_log_set_level(level);
+  return enif_make_atom(env, "ok");
+}
+
+static ErlNifFunc xav_funcs[] = {
+    {"new", 9, new},
+    {"next_frame", 1, next_frame, ERL_NIF_DIRTY_JOB_CPU_BOUND},
+    {"seek", 2, seek, ERL_NIF_DIRTY_JOB_CPU_BOUND},
+    {"set_log_level", 1, set_log_level}};
 
 static int load(ErlNifEnv *env, void **priv, ERL_NIF_TERM load_info) {
 

lib/xav.ex

@@ -17,6 +17,101 @@ defmodule Xav do
           media_type: atom()
         }
 
+  @typedoc """
+  A human-readable FFmpeg log level.
+
+  The mapping to FFmpeg's `AV_LOG_*` constants is:
+
+  | Atom        | FFmpeg constant   | Value |
+  |-------------|-------------------|-------|
+  | `:quiet`    | `AV_LOG_QUIET`    | -8    |
+  | `:panic`    | `AV_LOG_PANIC`    | 0     |
+  | `:fatal`    | `AV_LOG_FATAL`    | 8     |
+  | `:error`    | `AV_LOG_ERROR`    | 16    |
+  | `:warning`  | `AV_LOG_WARNING`  | 24    |
+  | `:info`     | `AV_LOG_INFO`     | 32    |
+  | `:verbose`  | `AV_LOG_VERBOSE`  | 40    |
+  | `:debug`    | `AV_LOG_DEBUG`    | 48    |
+  | `:trace`    | `AV_LOG_TRACE`    | 56    |
+
+  FFmpeg's default is `:info`.
+  """
+  @type log_level ::
+          :quiet
+          | :panic
+          | :fatal
+          | :error
+          | :warning
+          | :info
+          | :verbose
+          | :debug
+          | :trace
+
+  @log_levels %{
+    quiet: -8,
+    panic: 0,
+    fatal: 8,
+    error: 16,
+    warning: 24,
+    info: 32,
+    verbose: 40,
+    debug: 48,
+    trace: 56
+  }
+
+  @doc """
+  Sets the FFmpeg log level.
+
+  Accepts either one of the level atoms listed in `t:log_level/0`
+  or a raw integer level. Returns `:ok`.
+
+  This call wraps FFmpeg's `av_log_set_level/1`, which is
+  **process-global**: the level is shared across every `libav*` and
+  `libswscale` call in the current OS process, including readers,
+  decoders, encoders, and converters created from the Elixir VM.
+
+  Typical use is to silence the informational `[swscaler @ ...]` lines
+  that `libswscale` prints when it falls back to a non-SIMD
+  colorspace conversion path (which happens for example on
+  `yuv420p -> rgb24` on Apple Silicon):
+
+      Xav.set_log_level(:error)
+
+  To configure the level declaratively at application start, use the
+  `:ffmpeg_log_level` key in your application env instead:
+
+      # config/runtime.exs
+      config :xav, ffmpeg_log_level: :error
+
+  `Xav.Application` reads this on boot and calls `set_log_level/1`
+  for you.
+
+  ## Examples
+
+      iex> Xav.set_log_level(:error)
+      :ok
+
+      iex> Xav.set_log_level(:quiet)
+      :ok
+
+  """
+  @spec set_log_level(log_level() | integer()) :: :ok
+  def set_log_level(level) when is_atom(level) do
+    case Map.fetch(@log_levels, level) do
+      {:ok, int} ->
+        Xav.Reader.NIF.set_log_level(int)
+
+      :error ->
+        raise ArgumentError,
+              "invalid FFmpeg log level #{inspect(level)}. " <>
+                "Expected one of #{inspect(Map.keys(@log_levels))} or an integer."
+    end
+  end
+
+  def set_log_level(level) when is_integer(level) do
+    Xav.Reader.NIF.set_log_level(level)
+  end
+
   @doc """
   Get all available pixel formats.
 

lib/xav/application.ex

@@ -0,0 +1,19 @@
+defmodule Xav.Application do
+  @moduledoc false
+
+  use Application
+
+  @impl true
+  def start(_type, _args) do
+    maybe_set_log_level()
+
+    Supervisor.start_link([], strategy: :one_for_one, name: Xav.Supervisor)
+  end
+
+  defp maybe_set_log_level do
+    case Application.get_env(:xav, :ffmpeg_log_level) do
+      nil -> :ok
+      level -> Xav.set_log_level(level)
+    end
+  end
+end

lib/xav/reader_nif.ex

@@ -15,4 +15,6 @@ defmodule Xav.Reader.NIF do
   def next_frame(_reader), do: :erlang.nif_error(:undef)
 
   def seek(_reader, _time_in_seconds), do: :erlang.nif_error(:undef)
+
+  def set_log_level(_level), do: :erlang.nif_error(:undef)
 end

mix.exs

@@ -40,7 +40,8 @@ defmodule Xav.MixProject do
 
   def application do
     [
-      extra_applications: [:logger]
+      extra_applications: [:logger],
+      mod: {Xav.Application, []}
     ]
   end
 

test/xav_test.exs

@@ -0,0 +1,23 @@
+defmodule XavTest do
+  use ExUnit.Case, async: false
+
+  describe "set_log_level/1" do
+    test "accepts atoms" do
+      assert :ok = Xav.set_log_level(:error)
+      assert :ok = Xav.set_log_level(:quiet)
+      # restore default for other tests
+      assert :ok = Xav.set_log_level(:info)
+    end
+
+    test "accepts integers" do
+      assert :ok = Xav.set_log_level(16)
+      assert :ok = Xav.set_log_level(:info)
+    end
+
+    test "rejects unknown atoms" do
+      assert_raise ArgumentError, ~r/invalid FFmpeg log level/, fn ->
+        Xav.set_log_level(:nonsense)
+      end
+    end
+  end
+end