Develop (#2)

* update naming

* update format description

* update readme

* add circle config

* remove fec_enabled field

* update CI

.circleci/config.yml

@@ -0,0 +1,15 @@
+version: 2.0
+jobs:
+  build:
+    docker:
+      - image: membrane/membrane:latest
+        environment:
+          MIX_ENV: test
+
+    working_directory: ~/app
+
+    steps:
+      - checkout
+      - run: mix deps.get
+      - run: mix format --check-formatted
+      - run: mix test

README.md

@@ -1,4 +1,4 @@
-# Membrane Multimedia Framework: Opus Audio Format Description
+# Membrane OPUS Format
 
 [![Hex.pm](https://img.shields.io/hexpm/v/membrane_opus_format.svg)](https://hex.pm/packages/membrane_opus_format)
 [![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/membrane_opus_format/)

lib/membrane_opus/description.ex → lib/membrane_opus.ex

@@ -1,4 +1,4 @@
-defmodule Membrane.Opus.Description do
+defmodule Membrane.Opus do
   @moduledoc """
   This module implements struct describing an Opus-encoded audio stream.
 
@@ -8,31 +8,24 @@ defmodule Membrane.Opus.Description do
   @typedoc """
   Number of channels transmitted in the stream.
   """
-  @type channels_t :: 1 | 2
-
-  @typedoc """
-  Enable/disable in-band _Forward Error Correction_ (FEC).
-  """
-  @type fec_enabled_t :: boolean
+  @type channels_t :: 1 | 2 | nil
 
   @typedoc """
   Bitrate used to encode the stream in `bit/s`.
 
   Opus supports all bitrates from `6 kbit/s` to `510 kbit/s`,
   so this value has to be in range `6144` to `522240`.
   """
-  @type bitrate_t :: non_neg_integer
+  @type bitrate_t :: non_neg_integer | nil
 
   @type t :: %__MODULE__{
           bitrate: bitrate_t,
-          channels: channels_t,
-          fec_enabled: fec_enabled_t
+          channels: channels_t
         }
 
   @enforce_keys [
     :bitrate,
-    :channels,
-    :fec_enabled
+    :channels
   ]
   defstruct @enforce_keys
 end