depp/vadpcm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
VADPCM audio codec
251 commits 3 branches 0 tags 1.8 MiB
Find a file
Exact
Dietrich Epp d2facb736f Clamp state values in encoder 
The current decoder clamps output values to 16 bits. These clamped
values are used as state, so the encoder must clamp these values too.

Similar state consistency problems may exist in the original SDK tools,
so we may need to select different behavior here to maintain
compatibility.
2026-01-20 08:26:06 -05:00
.vscode Clean up VS Code settings 2023-09-12 00:41:45 -04:00
bazel Fix Bazel build system 2026-01-14 23:19:50 -05:00
codec Clamp state values in encoder 2026-01-20 08:26:06 -05:00
common Add audio pcm / vadpcm destroy functions 2026-01-19 02:17:41 -05:00
docs Reorganize documentation 2023-09-12 00:40:45 -04:00
scripts Add Python program for analyzing the encoder 2026-01-18 15:39:35 -05:00
stats Fix uninitialized memory 2026-01-05 02:14:40 -05:00
tests Add test case for state discrepancy 2026-01-20 08:22:22 -05:00
vadpcm Add audio pcm / vadpcm destroy functions 2026-01-19 02:17:41 -05:00
vadpcmstats Add audio pcm / vadpcm destroy functions 2026-01-19 02:17:41 -05:00
.bazelrc Fix Bazel build system 2026-01-14 23:19:50 -05:00
.clang-format Create font rasterizer tool 2023-09-11 23:59:15 -04:00
.gitignore Windows: Add project for codec library 2026-01-14 23:50:14 -05:00
BUILD.bazel Get entire repository to build again 2023-09-11 23:59:27 -04:00
CMakeLists.txt Add statecheck tool 2026-01-19 02:50:23 -05:00
LICENSE.txt Add MPL 2.0 license 2023-09-11 23:59:28 -04:00
MODULE.bazel Fix Bazel build system 2026-01-14 23:19:50 -05:00
MODULE.bazel.lock Update dependency versions 2025-09-13 13:24:55 -04:00
Properties.props MSVC: Create project for CLI 2026-01-15 00:30:46 -05:00
README.md Update README 2026-01-14 23:30:06 -05:00
vadpcm.slnx MSVC: Create project for CLI 2026-01-15 00:30:46 -05:00
WORKSPACE Fix Bazel build system 2026-01-14 23:19:50 -05:00

README.md

VADPCM

This is an implementation of the VADPCM codec. The VADPCM codec is often used by Nintendo 64 games—this includes both homebrew games made using LibDragon and commercial games made during the 1990s and 2000s with the proprietary SDK, LibUltra.

VADPCM is licensed under the terms of the Mozilla Public License Version 2.0. See LICENSE.txt for details.

Usage

Convert an AIFF file to use VADPCM:

vadpcm encode input.aiff output.aifc

Convert a VADPCM file back to AIFF:

vadpcm decode input.aifc output.aiff

VADPCM-encoded files are always AIFF-C files with the .aifc extension. The unencoded version can be AIFF, AIFF-C, or WAV.

Project Status

The project is, as of January 2026, under active development. Version 1.0 is expected within the next six months.

What is VADPCM?

VADPCM is a variant of ADPCM. It encodes blocks of 16 samples of audio into 9 bytes of data, giving 4.5 bits per sample. There are no settings or parameters to change the bit rate; the bit rate is always 4.5 bits per sample.

The audio quality of VADPCM is good, but this codec is not competitive with codecs like Opus, Vorbis, or even MP3.

Technical Details

VADPCM uses a codebook of second-order linear predictors, and encodes the residuals using 4 bits per sample. Each block of 16 samples shares the same predictor and scaling factor. The predictors in the codebook are stored in a vector format, which makes it easy to write a high-performance decoder using SIMD instructions. The Nintendo 64 has a coprocessor, called the Reality Signal Processor, with SIMD capabilities.

Building

CMake

You can build using CMake:

cmake -B build -DCMAKE_BUILD_TYPE=Release
make -C build -j4

This places the main program at build/vadpcm.

If you are doing development work, recommended CMake flags are:

  • -G Ninja to use Ninja instead of Make,
  • -DENABLE_WARNINGS=ON to enable compiler warnings,
  • -DENABLE_WERROR=ON to treat warning sas errors,
  • -DCMAKE_EXPORT_COMPILE_COMMANDS=ON to generate the compilation database for Clangd,
  • DCMAKE_C_FLAGS='-fdiagnostics-color=always for color warnings and errors.

Bazel

You can build using Bazel:

bazel build -c opt //vadpcm

This places the main program at bazel-bin/vadpcm/vadpcm.

If you are doing development work, generate the compilation database with hedron:

bazel run @hedron_compile_commands//:refresh_all

Recommended Bazel flags are --//bazel:warnings=error.

Development

For CMake, you may want the compile_commands.json, which

Pass -DCMAKE_EXPORT_COMPILE_COMMANDS=ON to CMake to generate the compile_commands.json file that Clangd uses. On Unix systems, this will be symlinked into the project source directory.