SGI Audio Tools

Revision as of 04:40, 9 August 2020 by Danielface (talk | contribs) (Partial work on audio sample compression steps)

Introduction

TODO

Prerequisites

This article assumes you're familiar with the following terms/concepts:

  • Audio samples
  • Sample rate
  • MIDI
  • Linear predictive coding
  • AIFF format

If you're a bit unfamiliar, a quick search or Wikipedia skim should suffice.

This article assumes you have the SGI Audio Tools as part of the Nintendo 64 SDK. The programs in particular you're going to need are:

  • tabledesign
  • vadpcm_enc
  • ic
  • midicvt
  • midicomp
  • sbc

This article also assumes that you're using the aforementioned programs in a Windows 95-like environment. An emulator, such as Oracle VirtualBox works fine too.

The n64decomp project has decompiled tabledesign and adpcm here. It's possible to build those two particular programs yourself and run them in the environment of your choice, which might make your life a little easier!

Authoring a Song with the SGI Audio Tools

Compressing Sounds

Converting samples with SoX

SoX bills itself as the Swiss Army knife of sound processing programs. Its uses include (but aren't limited to) converting audio between formats, providing effects, and even recording. Given that SoX is an open-source tool, it's well worth including into any game developer's setup.

The tabledesign and vadpcm_enc tools require audio samples to be in AIFF or AIFC. If the samples you're using are in a different format, such as WAV, you can use SoX to batch-convert your samples. It's also a good idea to resample each effect to the same sample rate, such as 32000Hz. If you're generating your bank file via a script, you can assume the sample rate in your code to save time.

If we want to convert an arbitrary WAV file to AIFF with a sample rate of 32000 and in mono we can enter:
sox some_file.wav -r 32000 -c 1 converted_file.aiff

This article assumes that the reader is converting their files to AIFF with SoX.

Creating a code book for each file

You'll want to create a code book for each AIFF sample you want to use in your song. To do this, you'll run the tabledesign command on each of your samples and save the output of that program to a file.

For clarity, we'll be suffix-ing each code book with .table but it's not necessary to do.

On each of your samples, run the following:
tabledesign song_sample.aiff > song_sample.table

It's worth noting that by default tabledesign will print to STDOUT. The > operator for writing to a file should work both on Mac/Linux/BSD/etc. and Windows here.

Compressing each sample

Once we've created a code book, we'll want to convert our AIFF samples to Nintendo's compressed AIFC formats. To do that, we'll be using vadpcm_enc.

On each of your samples, run the following:
vadpcm_enc -c song_sample.table song_sample.aiff compressed_song_sample.aifc

Authoring the Bank File

Creating the Instrument Bank

Playing a song with NuSystem

Linking the Audio Library

Setting up playback

Starting/stoping playback