Skip to content

Commit 5eececb

Browse files
tomjnixontomjnixon
committed
initial commit
see CONTRIBUTORS.md for authors
0 parents  commit 5eececb

File tree

128 files changed

+29132
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

128 files changed

+29132
-0
lines changed

‎.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.*
2+
!.git*
3+
build
4+
dist
5+
*.egg-info
6+
env
7+
__pycache__

‎.gitmodules

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[submodule "visr_bear/submodules/rapidjson"]
2+
path = visr_bear/submodules/rapidjson
3+
url = https://github.com/Tencent/rapidjson.git
4+
[submodule "visr_bear/submodules/libear"]
5+
path = visr_bear/submodules/libear
6+
url = https://github.com/ebu/libear.git
7+
branch = extent_performance

‎CONTRIBUTORS.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
The following people have contributed to this project; feel free to update this list when opening a PR.
2+
3+
- Andreas Franck
4+
- Chris Pike
5+
- Galen Reich
6+
- Matt Firth
7+
- Mhairi Finlayson
8+
- Tom Nixon

‎LICENSE

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎README.md

+147
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
# Binaural EBU ADM Renderer (BEAR)
2+
3+
The BEAR is a binaural renderer for ADM content. It is based on the [EAR], and is is integrated into the [EAR Production Suite].
4+
5+
This repository contains:
6+
7+
- visr_bear: a real-time C++ implementation of the BEAR, using [libear] and
8+
[VISR]. It has a C++ API that makes it reasonably straightforward to embed
9+
into other applications; see visr_bear/include/api.hpp
10+
11+
- bear: a python module containing a command-line tool `bear-render`, which
12+
uses visr_bear to render ADM WAV files to binaural.
13+
14+
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.
15+
16+
[EAR]: https://github.com/ebu/ebu_adm_renderer
17+
[libear]: https://github.com/ebu/libear
18+
[VISR]: https://github.com/s3a-spatialaudio/VISR
19+
[EAR Production Suite]: https://ear-production-suite.ebu.io/
20+
21+
## Install
22+
23+
To get this running, you'll need to install:
24+
25+
- This python module
26+
- VISR
27+
- visr_bear
28+
29+
Steps for each are outlined below.
30+
31+
To fetch the required submodules, first run:
32+
33+
git submodule update --init --recursive
34+
35+
Installation in a virtualenv is generally preferable to doing a system-wide
36+
install; follow the [Use a virtualenv](#use-a-virtualenv) steps below first to
37+
do that.
38+
39+
### Python
40+
41+
This repository contains a standard python package.
42+
43+
Install it by changing into this directory and running:
44+
45+
pip install -e .
46+
47+
To download required data files, run:
48+
49+
python -m bear.data.download_data
50+
51+
For development you can install the test and dev dependencies with:
52+
53+
pip install -e .[test,dev]
54+
55+
Tests are ran with:
56+
57+
pytest
58+
59+
To reformat code to match the existing style, run `black` on any changed sources. `flake8` should ideally not report any warnings.
60+
61+
### VISR
62+
63+
Get VISR 0.13.0 or greater from:
64+
65+
https://github.com/s3a-spatialaudio/VISR
66+
67+
To configure:
68+
69+
cmake -B build . -DBUILD_PYTHON_BINDINGS=ON -DBUILD_DOCUMENTATION=OFF -DBUILD_AUDIOINTERFACES_PORTAUDIO=OFF -DBUILD_USE_SNDFILE_LIBRARY=OFF
70+
71+
Build:
72+
73+
cmake --build build
74+
75+
Install:
76+
77+
cmake --build build -t install
78+
79+
The cmake flags can be adjusted, but python bindings are currently necessary to
80+
run `bear-render` and the tests.
81+
82+
### visr_bear
83+
84+
This is in the `visr_bear` subdirectory:
85+
86+
cd visr_bear
87+
88+
The process is the same as for VISR; to configure:
89+
90+
cmake -B build .
91+
92+
Build:
93+
94+
cmake --build build
95+
96+
Install:
97+
98+
cmake --build build -t install
99+
100+
### Adjustments
101+
102+
There are various ways to configure and build this:
103+
104+
#### Use a virtualenv
105+
106+
You should probably [use a virtualenv](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment)
107+
to avoid messing up your system by installing things to your system directories
108+
(which will require sudo). This is just a directory containing an installation
109+
of python, and directories for installing libraries and programs.
110+
111+
Create it in `env` with:
112+
113+
python -m venv env
114+
115+
To use the virtualenv you'll need to activate it; this just sets up some environment variables:
116+
117+
source ./env/bin/activate
118+
119+
To get cmake to install into the virtualenv, add this to the cmake 'configuration' commands:
120+
121+
-DCMAKE_INSTALL_PREFIX=$VIRTUAL_ENV
122+
123+
With this setup you'll probably need to add `env/lib` to your library search path; set this with:
124+
125+
export LD_LIBRARY_PATH=$VIRTUAL_ENV/lib/
126+
127+
This could be added to the end of the `env/bin/activate` script if desired.
128+
129+
#### Release mode
130+
131+
For better performance, set either `-DCMAKE_BUILD_TYPE=Release` or
132+
`-DCMAKE_BUILD_TYPE=RelWithDebInfo`. The latter is nice for development as it
133+
retains debug symbols.
134+
135+
## Usage
136+
137+
### native ADM file renderer
138+
139+
bear-render infile.wav outfile.wav
140+
141+
This supports various options similar to `ear-render`; see `bear-render --help`.
142+
143+
# License
144+
145+
Copyright 2020 BBC
146+
147+
BEAR is licensed under the terms of the Apache License, Version 2.0; see LICENSE for details.

‎bear/__init__.py

Whitespace-only changes.

‎bear/data_file.py

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import pkg_resources
2+
import os
3+
4+
5+
def get_path(file_url):
6+
"""Get the real path given a url with forms:
7+
8+
`file:PATH`: load from file at PATH
9+
`resource:PATH`: load from package resource PATH
10+
`PATH`: same as `file:PATH`
11+
"""
12+
scheme, path = file_url.split(":", 1)
13+
14+
if file_url.startswith("resource:"):
15+
path = file_url.split(":", 1)[1]
16+
17+
# try to find the file in a couple of different places
18+
for package, prefix in ("bear", "data/"), ("visr_bear_data", ""):
19+
try:
20+
full_path = pkg_resources.resource_filename(package, prefix + path)
21+
except ModuleNotFoundError:
22+
continue
23+
24+
if os.path.isfile(full_path):
25+
return full_path
26+
else:
27+
raise Exception(f"resource '{path}' not found")
28+
elif file_url.startswith("file:"):
29+
return file_url.split(":", 1)[1]
30+
else:
31+
return file_url

0 commit comments

Comments
 (0)