initial commit

see CONTRIBUTORS.md for authors

.gitignore

@@ -0,0 +1,7 @@
+.*
+!.git*
+build
+dist
+*.egg-info
+env
+__pycache__

.gitmodules

@@ -0,0 +1,7 @@
+[submodule "visr_bear/submodules/rapidjson"]
+	path = visr_bear/submodules/rapidjson
+	url = https://github.com/Tencent/rapidjson.git
+[submodule "visr_bear/submodules/libear"]
+	path = visr_bear/submodules/libear
+	url = https://github.com/ebu/libear.git
+	branch = extent_performance

CONTRIBUTORS.md

@@ -0,0 +1,8 @@
+The following people have contributed to this project; feel free to update this list when opening a PR.
+
+- Andreas Franck
+- Chris Pike
+- Galen Reich
+- Matt Firth
+- Mhairi Finlayson
+- Tom Nixon

LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

README.md

@@ -0,0 +1,147 @@
+# Binaural EBU ADM Renderer (BEAR)
+
+The BEAR is a binaural renderer for ADM content. It is based on the [EAR], and is is integrated into the [EAR Production Suite].
+
+This repository contains:
+
+- visr_bear: a real-time C++ implementation of the BEAR, using [libear] and
+  [VISR]. It has a C++ API that makes it reasonably straightforward to embed
+  into other applications; see visr_bear/include/api.hpp
+
+- bear: a python module containing a command-line tool `bear-render`, which
+  uses visr_bear to render ADM WAV files to binaural.
+
+This is currently a pre-release, awaiting code to generate the data files from publicly-available data and an EBU tech-doc describing the processing performed by the BEAR.
+
+[EAR]: https://github.com/ebu/ebu_adm_renderer
+[libear]: https://github.com/ebu/libear
+[VISR]: https://github.com/s3a-spatialaudio/VISR
+[EAR Production Suite]: https://ear-production-suite.ebu.io/
+
+## Install
+
+To get this running, you'll need to install:
+
+- This python module
+- VISR
+- visr_bear
+
+Steps for each are outlined below.
+
+To fetch the required submodules, first run:
+
+    git submodule update --init --recursive
+
+Installation in a virtualenv is generally preferable to doing a system-wide
+install; follow the [Use a virtualenv](#use-a-virtualenv) steps below first to
+do that.
+
+### Python
+
+This repository contains a standard python package.
+
+Install it by changing into this directory and running:
+
+    pip install -e .
+
+To download required data files, run:
+
+    python -m bear.data.download_data
+
+For development you can install the test and dev dependencies with:
+
+    pip install -e .[test,dev]
+
+Tests are ran with:
+
+    pytest
+
+To reformat code to match the existing style, run `black` on any changed sources. `flake8` should ideally not report any warnings.
+
+### VISR
+
+Get VISR 0.13.0 or greater from:
+
+https://github.com/s3a-spatialaudio/VISR
+
+To configure:
+
+    cmake -B build . -DBUILD_PYTHON_BINDINGS=ON -DBUILD_DOCUMENTATION=OFF -DBUILD_AUDIOINTERFACES_PORTAUDIO=OFF -DBUILD_USE_SNDFILE_LIBRARY=OFF
+
+Build:
+
+    cmake --build build
+
+Install:
+
+    cmake --build build -t install
+
+The cmake flags can be adjusted, but python bindings are currently necessary to
+run `bear-render` and the tests.
+
+### visr_bear
+
+This is in the `visr_bear` subdirectory:
+
+    cd visr_bear
+
+The process is the same as for VISR; to configure:
+
+    cmake -B build .
+
+Build:
+
+    cmake --build build
+
+Install:
+
+    cmake --build build -t install
+
+### Adjustments
+
+There are various ways to configure and build this:
+
+#### Use a virtualenv
+
+You should probably [use a virtualenv](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment)
+to avoid messing up your system by installing things to your system directories
+(which will require sudo). This is just a directory containing an installation
+of python, and directories for installing libraries and programs.
+
+Create it in `env` with:
+
+    python -m venv env
+
+To use the virtualenv you'll need to activate it; this just sets up some environment variables:
+
+    source ./env/bin/activate
+
+To get cmake to install into the virtualenv, add this to the cmake 'configuration' commands:
+
+    -DCMAKE_INSTALL_PREFIX=$VIRTUAL_ENV
+
+With this setup you'll probably need to add `env/lib` to your library search path; set this with:
+
+    export LD_LIBRARY_PATH=$VIRTUAL_ENV/lib/
+
+This could be added to the end of the `env/bin/activate` script if desired.
+
+#### Release mode
+
+For better performance, set either `-DCMAKE_BUILD_TYPE=Release` or
+`-DCMAKE_BUILD_TYPE=RelWithDebInfo`. The latter is nice for development as it
+retains debug symbols.
+
+## Usage
+
+### native ADM file renderer
+
+    bear-render infile.wav outfile.wav
+
+This supports various options similar to `ear-render`; see `bear-render --help`.
+
+# License
+
+Copyright 2020 BBC
+
+BEAR is licensed under the terms of the Apache License, Version 2.0; see LICENSE for details.

bear/data_file.py

@@ -0,0 +1,31 @@
+import pkg_resources
+import os
+
+
+def get_path(file_url):
+    """Get the real path given a url with forms:
+
+    `file:PATH`: load from file at PATH
+    `resource:PATH`: load from package resource PATH
+    `PATH`: same as `file:PATH`
+    """
+    scheme, path = file_url.split(":", 1)
+
+    if file_url.startswith("resource:"):
+        path = file_url.split(":", 1)[1]
+
+        # try to find the file in a couple of different places
+        for package, prefix in ("bear", "data/"), ("visr_bear_data", ""):
+            try:
+                full_path = pkg_resources.resource_filename(package, prefix + path)
+            except ModuleNotFoundError:
+                continue
+
+            if os.path.isfile(full_path):
+                return full_path
+        else:
+            raise Exception(f"resource '{path}' not found")
+    elif file_url.startswith("file:"):
+        return file_url.split(":", 1)[1]
+    else:
+        return file_url