Proposed Pull Request Change

📄 Document Links

View on GitHub View on Microsoft Learn

--- title: References - How to collect diagnostic audio recordings titleSuffix: Azure Communication Services - Troubleshooting Guide description: Learn how to collect diagnostic audio recordings. author: enricohuang ms.author: enricohuang services: azure-communication-services ms.date: 02/24/2024 ms.topic: troubleshooting ms.service: azure-communication-services ms.subservice: calling --- # How to collect diagnostic audio recordings To debug some issue, you may need audio recordings, especially when investigating audio quality problems, such as distorted audio and echo issues. To collect diagnostic audio recordings, open the chrome://webrtc-internals(Chrome) or edge://webrtc-internals(Edge) page. When you click *Enable diagnostic audio recordings*, the browser prompts a dialog asking for the download file location. :::image type="content" source="./media/enable-diagnostic-audio-recordings.png" alt-text="Screenshot of diagnostic audio recordings settings."::: After you finish an ACS call, you should be able to see files saved in the folder you choose. :::image type="content" source="./media/diagnostic-audio-recordings.png" alt-text="Screenshot of diagnostic audio recording files."::: `*.output.N.wav` is the audio output sent to the speaker. `*.input.M.wav` is the audio input captured from the microphone. `*.aecdump` contains the necessary wav files for debugging audio after processed by the audio processing module in browsers. ## How to build tools for inspecting aecdump files To inspect `*.aecdump` files, you must use the `unpack_aecdump` utility program, the source code can be found at [unpack\_aecdump](https://chromium.googlesource.com/external/webrtc/+/HEAD/rtc_tools/unpack_aecdump?autodive=0) You need to prepare the build environment (Here we use Windows as an example) Prerequisites: * Visual Studio 2022 * Python 3 * depot\_tools: See Install depot\_tools in [Checking out and Building Chromium for Windows](https://chromium.googlesource.com/chromium/src/+/HEAD/docs/windows_build_instructions.md#Install) Make sure you add depot\_tools to the start of your PATH and it must be ahead of any installs of Python. Run the following commands ```sh mkdir webrtc cd webrtc gclient fetch --nohooks webrtc gclient sync cd src gn gen out/Default ninja -C out/Default unpack_aecdump ``` The file is available at webrtc/src/out/Default/unpack\_aecdump.exe ## How to inspect aecdump files Run the command: ``` unpack_aecdump.exe audio_debug.5.aecdump ``` :::image type="content" source="./media/extract-aecdump.png" alt-text="Screenshot of the extracted aecdump file."::: There are three different types of audio files extracted from the aecdump file * reverseN.wav: the rendered audio originated from the same process * inputN.wav: the captured audio, before audio processing. * ref\_outN.wav: the captured audio, after audio processing and will be sent to the network. If you think that audio quality issues are on the sending end, you can first check ref\_outN.wav, find the possible problem time points, and compare them with the same time points in inputN.wav to see if the audio quality issues are caused by the audio processing module, or if the audio quality was already poor in the source.