The Immersive Audio Model and Formats (IAMF) standard is defined by the Alliance for Open Media (AOM).
iamf-tools
implements tools to help users process and work with the IAMF
format. These tools can be used as a complement to the libiamf
reference decoder.
<root>
- Project-level files like the license, README (this file), and BUILD files.iamf/
common/
- Common utility files.tests/
- Unit tests for files undercommon/
.
cli/
- Files related to the command line interface (CLI) to generate and write an IA Sequence.adm_to_user_metadata/
- Components to convert ADM files to proto files which can be used for input to the encoder.codec/
- Files that encode or decode substreams with codec-specific libraries.tests/
- Unit tests for files undercodec/
.
proto/
- Protocol buffers defining the data scheme for the input files underiamf/cli/testdata/
or user-created ones.testdata/
- Sample input files to the encoder. See also Test Suite.tests/
- Unit tests for files underiamf/cli/
.
obu/
- Files relating to IAMF Open Bitstream Units (OBU)s.decoder_config/
- Files relating codec-specific decoder configs.tests/
- Unit tests for files underdecoder_config/
.
tests/
- Unit tests for files underobu/
.
external/
- Custom*.BUILD
files for external dependencies.
The encoder can be used to encode a standalone IAMF Sequence (.iamf
) file
based on an input proto file. See Test Suite for several example
input files.
- Bazel:
iamf-tools
uses the Bazel build system. See Bazel's Getting started page for installation instructions. - CMake: required to build some dependencies. See CMake's Download page to install.
Building the encoder binary:
bazel build -c opt //iamf/cli:encoder_main
Running built-in tests:
bazel test -c opt //iamf/...
Run the encoder. Specify the input file with --user_metadata_filename
.
Optional flags:
--input_wav_directory
controls the directory wav files are read from (default iamf/cli/testdata/).--output_iamf_directory
controls the output directory of the IAMF files.--output_wav_directory
controls the output directory of wav files.
Using the encoder:
bazel-bin/iamf/cli/encoder_main --user_metadata_filename=iamf/cli/testdata/test_000002.textproto --output_iamf_directory=.
If this example is successful the encoder will produce an output
test_000002.iamf
file in the current directory.
Run the encoder. Specify the input file with --adm_filename
. See the
adm_to_user_metadata
README.md for details on
the conversion.
Optional flags:
--output_iamf_directory
controls the output directory of the IAMF files.--output_wav_directory
controls the output directory of wav files.--adm_importance_threshold
controls the threshold below which ADMaudioObject
s are omitted (default 0).--adm_frame_duration_ms
controls the frame size of the output IAMF in ms (default 10).
bazel-bin/iamf/cli/encoder_main --adm_filename=path/to/adm.wav --output_iamf_directory=.
iamf/cli/testdata covers a wide variety of IAMF features.
These samples can be used as encoder input. After encoding the resultant .iamf
files can be used to assist in testing or debugging an IAMF-compliant decoder.
See the separate README.md for further documentation.
Released under the BSD 3-Clause Clear License. See LICENSE for details.