Skip to content

Commit

Permalink
README.md: tweak section on encoding ADM-BWF to iamf
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 684997354
  • Loading branch information
felicialim committed Oct 16, 2024
1 parent 7a721cf commit 065cb10
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ format. These tools can be used as a complement to the `libiamf`
### Encoder

The encoder can be used to encode a standalone IAMF Sequence (`.iamf`) file
based on an input protocol buffer. See
[Test suite](docs/build_instructions.md#Test-suite) for several example input
files.
based on an ADM-BWF file or an input protocol buffer. See
[Test suite](docs/build_instructions.md#Test-suite) for several example
input protocol buffer files.

#### Building the encoder

Expand All @@ -41,7 +41,7 @@ bazel-bin/iamf/cli/encoder_main --user_metadata_filename=iamf/cli/testdata/test_
If this example is successful the encoder will produce an output
`test_000002.iamf` file in the current directory.

#### Using the encoder with ADM input
#### Using the encoder with ADM-BWF input

Run the encoder. Specify the input file with `--adm_filename`. See the
`adm_to_user_metadata` [README.md](iamf/cli/adm_to_user_metadata) for details on
Expand All @@ -59,6 +59,9 @@ Optional flags:
bazel-bin/iamf/cli/encoder_main --adm_filename=path/to/adm.wav --output_iamf_directory=.
```

The encoder will produce an output `.iamf` file in the output directory, where
the underlying audio streams are encoded with PCM.

## Web demo

The [web demo](https://aomediacodec.github.io/iamf-tools/web_demo/) hosted in
Expand Down

0 comments on commit 065cb10

Please sign in to comment.