Google Git
Sign in
chromium / chromiumos / third_party / webrtc-apm / refs/heads/stabilize-15485.B
commit03052ae1cac650ce3b0c731ae84cba9ca7bfef4b[log] [tgz]
authorLi-Yu Yu <aaronyu@google.com>Tue May 30 13:57:09 2023
committerChromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue May 30 14:26:28 2023
tree00fbd171250931227c7718d186541dfa41f547c9
parent13b962e554c760b81cad4f49918109fa7ccec85c [diff]
Update README for ebuild

BUG=b:235200394
TEST=None

Change-Id: Ib98751630ae919c138ec016e1f89b4fb45ca230e
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/third_party/webrtc-apm/+/4572752
Commit-Queue: Chih-Yang Hsia <paulhsia@chromium.org>
Reviewed-by: Chih-Yang Hsia <paulhsia@chromium.org>
Auto-Submit: Li-Yu Yu <aaronyu@google.com>
Tested-by: Li-Yu Yu <aaronyu@google.com>
1 file changed
tree: 00fbd171250931227c7718d186541dfa41f547c9
  1. absl/
  2. api/
  3. audio/
  4. common_audio/
  5. cras-config/
  6. modules/
  7. repositories/
  8. rtc_base/
  9. script/
  10. system_wrappers/
  11. third_party/
  12. .bazelrc
  13. .gitignore
  14. bak.h
  15. BUILD.bazel
  16. BUILD.iniparser.bazel
  17. common.mk
  18. common_types.h
  19. defs.bzl
  20. DIR_METADATA
  21. libwebrtc_apm.pc.template
  22. Makefile
  23. OWNERS
  24. pc_utils.mk
  25. PRESUBMIT.cfg
  26. README.md
  27. typedefs.h
  28. webrtc_apm.cc
  29. webrtc_apm.h
  30. webrtc_apm_test.cc
  31. WORKSPACE.bazel
README.md

WebRTC APM

APM is the audio processing module of WebRTC project in charge of effects like echo cancellation, noise suppression, etc. The purpose of this project is to build a standalone library for Chrome OS system side audio processing.

Files content

  • scripts to copy over folders and files from upstream WebRTC project for APM and its dependencies.
  • Copied files from upstream WebRTC project. For example: common_audio, modules, rtc_base and system_wrappers.
  • webrtc_apm.cc/h C wrappers to access APM functions.
  • common-mk based makefiles to build shared library libwebrtc_apm.so

Update

To update this package to latest upstream WebRC:

  • Run ./script/sync-apm.sh path/to/webrtc-checkout/src .
  • emerge-${BOARD} adhd to see if anything breaks.
  • If emerge success, then we're good.
  • Otherwise look into the emerge failure, and then possibly:
    • Update sync-apm.sh to copy more files if upstream directory structure changes.
    • Update BUILD.bazel files if upstream build files has changed.
    • Update the adhd ebuild file if dependencies changed.
  • Create a new commit

Build

There are three ways to build/test this package:

  1. Build webrtc-apm alone
  2. Build webrtc-apm with cras
  3. Build webrtc-apm inside a ChromiumOS SDK

The first one is the easiest to iterate with, and the last one is closest to the way ChromiumOS infra actually use to build OS images. The second one is somewhere in-between.

Build webrtc-apm alone

In the directory same as this README file, run:

bazel test //:tests

If you see pkg-config errors you are missing some system dependencies. (Googlers: follow go/cras-dev#prerequisites to install dependencies on gLinux)

Build webrtc-apm with cras

  1. Clone https://chromium.googlesource.com/chromiumos/third_party/adhd/ to the directory adjacent to this directory, so that adhd and webrtc-apm (this repository) are in the same directory.

    NOTE: If you use repo to set up a ChromiumOS checkout, the directory tree is already set up this way.

  2. In the adhd directory, run:

    bazel test //... @webrtc_apm//:tests

    There are some configs you can use, such as --config=local-clang and --config=asan. Refer to adhd's bazelrc for details.

    If you see pkg-config errors you are missing some system dependencies. (Googlers: follow go/cras-dev#prerequisites to install dependencies on gLinux)

Build webrtc-apm inside a ChromiumOS SDK

Example:

FEATURES=test USE=asan emerge-${BOARD} adhd