Initial commit

Connor Rigby · Connor Rigby · commit 5d1be1f1d385 · 2020-01-31T10:11:55.000-08:00
diff --git a/.formatter.exs b/.formatter.exs
@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["{mix,.formatter,bundlex}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,24 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+turbojpeg-*.tar
+
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+Copyright 2020 BinaryNoggin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/README.md b/README.md
@@ -0,0 +1,93 @@
+# TurboJPEG
+
+Fast JPEG encoding from raw YUV data using [libjpeg-turbo](https://libjpeg-turbo.org/)
+
+## Installation
+
+This library requires libjpeg-turbo to be installed
+
+### Arch linux
+
+    sudo pacman -S libjpeg-turbo
+
+### Ubuntu/Debian
+
+    sudo apt-get install libjpeg-turbo
+
+### OSX
+
+    brew install libjpeg-turbo
+
+If [available in Hex](https://hex.pm/turbojpeg/), the package can be installed
+by adding `turbojpeg` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+  [
+    {:shmex, "~> 0.2.0"},
+    {:turbojpeg, "~> 0.1.0"}
+  ]
+end
+```
+
+## Basic Usage
+
+```elixir 
+iex(1)> {:ok, native} = Turbojpeg.Native.create(1920, 1080, 90, :I420)
+{:ok, #Reference<0.938325095.2990669826.234059>}
+iex(2)> frame = File.read!("fixture/i420.yuv")
+<<0, 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 2, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, ...>>
+iex(3)> Turbojpeg.Native.to_jpeg(Shmex.new(frame), native)
+{:ok,
+ %Shmex{
+   capacity: 203783,
+   guard: #Reference<0.938325095.2990669827.232440>,
+   name: "/shmex-00000005607042890133#000",
+   size: 203783
+ }}
+iex(4)> Shmex.to_binary(jpeg)
+<<255, 216, 255, 224, 0, 16, 74, 70, 73, 70, 0, 1, 1, 0, 0, 1, 0, 1, 0, 0, 255,
+  219, 0, 67, 0, 3, 2, 2, 3, 2, 2, 3, 3, 3, 3, 4, 3, 3, 4, 5, 8, 5, 5, 4, 4, 5,
+  10, 7, 7, 6, ...>>
+iex(5)> File.write!("test.jpg", Shmex.to_binary(jpeg))
+:ok
+```
+
+## Membrane Sink Usage
+
+Pleas See [the membrane guide](https://membraneframework.org/guide/v0.5/pipeline.html#content)
+before using this.
+
+```elixir
+defmodule Your.Module.Pipeline do
+  use Membrane.Pipeline
+
+  @impl true
+  def handle_init(location) do
+    children = %{
+      source: %SomeMembraneSourceModule{location: location},
+      decoder: Membrane.Element.FFmpeg.H264.Decoder,
+      jpeg_converter: %Turbojpeg.Sink{filename: "/tmp/frame.jpeg", quality: 100},
+    }
+
+    links = [
+      link(:source) 
+      |> to(:decoder) 
+      |> to(:jpeg_converter) 
+    ]
+
+    spec = %ParentSpec{
+      children: children,
+      links: links
+    }
+
+    {{:ok, spec: spec}, %{}}
+  end
+
+end
+```
+
+# Copyright and License
+
+Copyright 2020, Binary Noggin
diff --git a/bundlex.exs b/bundlex.exs
@@ -0,0 +1,20 @@
+defmodule Turbojpeg.BundlexProject do
+  use Bundlex.Project
+
+  def project() do
+    [
+      nifs: nifs(Bundlex.platform())
+    ]
+  end
+
+  def nifs(_platform) do
+    [
+      turbojpeg_native: [
+        deps: [unifex: :unifex, shmex: :lib],
+        src_base: "turbojpeg_native",
+        sources: ["_generated/turbojpeg_native.c", "turbojpeg_native.c"],
+        pkg_configs: ["libturbojpeg"]
+      ]
+    ]
+  end
+end
diff --git a/c_src/turbojpeg_native/_generated/.gitignore b/c_src/turbojpeg_native/_generated/.gitignore
@@ -0,0 +1,2 @@
+*.c
+*.h
diff --git a/c_src/turbojpeg_native/turbojpeg_native.c b/c_src/turbojpeg_native/turbojpeg_native.c
@@ -0,0 +1,58 @@
+#include "turbojpeg_native.h"
+
+/** 
+ * Supported pixel formats: :I420 | :I422 | :I444 
+ * Unsupported pixel formats: :RGB | :BGRA | :RGBA | :NV12 | :NV21 | :YV12 | :AYUV
+*/
+UNIFEX_TERM create(UnifexEnv *env, int width, int height, int jpegQuality, char *format) {
+  UNIFEX_TERM res;
+  State *state = unifex_alloc_state(env);
+  state->width = width; state->height = height; 
+  state->flags = 0; state->quality = jpegQuality;
+  if(strcmp(format, "I420") == 0) {
+    state->format = TJSAMP_420;
+  } else if(strcmp(format, "I422") == 0) {
+    state->format = TJSAMP_422;
+  } else if(strcmp(format, "I444") == 0) {
+    state->format = TJSAMP_444;
+  } else {
+    res = create_result_error(env, "unsupported_format");
+    unifex_release_state(env, state);
+    return(res); 
+  }
+  res = create_result_ok(env, state);
+  unifex_release_state(env, state);
+  return(res);
+}
+
+/**
+ * Convert a binary h264 payload into a jpeg encoded payload
+*/
+UNIFEX_TERM to_jpeg(UnifexEnv* env, UnifexPayload *payload, State *state) {
+  state->tjh = tjInitCompress();
+  
+  unsigned char *jpegBuf = NULL;
+  unsigned long jpegSize;
+
+  int res = tjCompressFromYUV(
+    state->tjh, 
+    payload->data, 
+    state->width, 4, state->height, state->format, 
+    &jpegBuf, &jpegSize, 
+    state->quality, state->flags
+  );
+
+  if(res) {
+    return to_jpeg_result_error(env, tjGetErrorStr());
+  } else {
+    UnifexPayload *jpegFrame = unifex_payload_alloc(env, UNIFEX_PAYLOAD_SHM, jpegSize);
+    memcpy(jpegFrame->data, jpegBuf, jpegSize);
+    tjFree(jpegBuf);
+    return to_jpeg_result_ok(env, jpegFrame);
+  }
+}
+
+void handle_destroy_state(UnifexEnv* env, State* state) {
+  UNIFEX_UNUSED(env);
+  if(state->tjh) { tjDestroy(state->tjh); }
+}
diff --git a/c_src/turbojpeg_native/turbojpeg_native.h b/c_src/turbojpeg_native/turbojpeg_native.h
@@ -0,0 +1,18 @@
+#pragma once
+
+#include <erl_nif.h>
+#include <turbojpeg.h>
+
+/** NIF State */
+typedef struct _h264_parser_state {
+  /** Handle to turbojpeg */
+  tjhandle tjh;
+  enum TJSAMP format;
+  int flags;
+  int width; int height; int quality;
+} UnifexNifState;
+
+/** NIF State */
+typedef UnifexNifState State;
+
+#include "_generated/turbojpeg_native.h"
diff --git a/c_src/turbojpeg_native/turbojpeg_native.spec.exs b/c_src/turbojpeg_native/turbojpeg_native.spec.exs
@@ -0,0 +1,4 @@
+module Turbojpeg.Native
+
+spec create(width::int, height::int, quality::int, format::atom) :: {:ok :: label, state} | {:error :: label, reason :: atom}
+spec to_jpeg(payload, state) :: {:ok :: label, payload} | {:error :: label, reason :: atom}
diff --git a/fixture/i420.yuv b/fixture/i420.yuv
diff --git a/lib/turbojpeg.ex b/lib/turbojpeg.ex
@@ -0,0 +1,3 @@
+defmodule Turbojpeg do
+  @moduledoc File.read!("README.md")
+end
diff --git a/lib/turbojpeg/native.ex b/lib/turbojpeg/native.ex
@@ -0,0 +1,3 @@
+defmodule Turbojpeg.Native do
+  use Unifex.Loader
+end
diff --git a/lib/turbojpeg/sink.ex b/lib/turbojpeg/sink.ex
@@ -0,0 +1,64 @@
+defmodule Turbojpeg.Sink do
+  alias Turbojpeg.Native
+  use Membrane.Sink
+  alias Membrane.{Buffer, Time}
+  alias Membrane.Caps.Video.Raw
+
+  def_input_pad(:input, caps: Raw, demand_unit: :buffers)
+
+  def_options(
+    filename: [type: :binary, description: "File to write the jpeg file"],
+    quality: [type: :integer, description: "Jpeg encoding quality"]
+  )
+
+  @impl true
+  def handle_init(options) do
+    state = %{
+      quality: options.quality,
+      filename: options.filename,
+      jpeg_ref: nil,
+      timer_started?: false
+    }
+
+    {:ok, state}
+  end
+
+  @impl true
+  def handle_start_of_stream(:input, ctx, state) do
+    use Ratio
+    {nom, denom} = ctx.pads.input.caps.framerate
+    timer = {:demand_timer, Time.seconds(denom) <|> nom}
+
+    {{:ok, demand: :input, start_timer: timer}, %{state | timer_started?: true}}
+  end
+
+  @impl true
+  def handle_caps(:input, caps, ctx, state) do
+    %{input: input} = ctx.pads
+
+    if !input.caps || caps == input.caps do
+      {:ok, ref} = Native.create(caps.width, caps.height, state.quality, caps.format)
+      {:ok, %{state | jpeg_ref: ref}}
+    else
+      raise "Caps have changed while playing. This is not supported."
+    end
+  end
+
+  @impl true
+  def handle_write(:input, %Buffer{payload: payload}, _ctx, state) do
+    File.write!("fixture_i420.yuv", Shmex.to_binary(payload))
+
+    with {:ok, data} <- Native.to_jpeg(payload, state.jpeg_ref),
+         :ok <- File.write(state.filename, Shmex.to_binary(data)) do
+      {:ok, state}
+    else
+      {:error, reason} ->
+        {{:error, reason}, state}
+    end
+  end
+
+  @impl true
+  def handle_tick(:demand_timer, _ctx, state) do
+    {{:ok, demand: :input}, state}
+  end
+end
diff --git a/mix.exs b/mix.exs
@@ -0,0 +1,59 @@
+defmodule Turbojpeg.MixProject do
+  use Mix.Project
+
+  @version "0.1.0"
+  @github_link "https://github.com/binarynoggin/elixir-turbojpeg"
+
+  def project do
+    [
+      compilers: [:unifex, :bundlex] ++ Mix.compilers(),
+      app: :turbojpeg,
+      version: @version,
+      elixir: "~> 1.9",
+      start_permanent: Mix.env() == :prod,
+      description: "Elixir bindings for libjpeg-turbo",
+      source_url: @github_link,
+      homepage_url: @github_link,
+      package: package(),
+      docs: docs(),
+      deps: deps()
+    ]
+  end
+
+  # Run "mix help compile.app" to learn about applications.
+  def application do
+    [
+      extra_applications: [:logger]
+    ]
+  end
+
+  # Run "mix help deps" to learn about dependencies.
+  defp deps do
+    [
+      {:unifex, "~> 0.1"},
+      {:shmex, "~> 0.2.0"},
+      {:bundlex, "~> 0.2.6"},
+      {:membrane_core, "~> 0.5.0"},
+      {:ex_doc, "~> 0.21.3", only: [:docs]}
+    ]
+  end
+
+  defp package do
+    [
+      licenses: ["Apache 2.0"],
+      files: ["lib", "c_src", "mix.exs", "README*", "LICENSE*", ".formatter.exs", "bundlex.exs"],
+      links: %{
+        "GitHub" => @github_link,
+        "Binary Noggin" => "https://binarynoggin.com/"
+      }
+    ]
+  end
+
+  defp docs do
+    [
+      main: "readme",
+      extras: ["README.md"],
+      source_ref: "v#{@version}"
+    ]
+  end
+end
diff --git a/mix.lock b/mix.lock
diff --git a/test/test_helper.exs b/test/test_helper.exs
diff --git a/test/turbojpeg_test.exs b/test/turbojpeg_test.exs

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +# Used by "mix format"
 +[
 +  inputs: ["{mix,.formatter,bundlex}.exs", "{config,lib,test}/**/*.{ex,exs}"]
 +]