Katie &'s WAVFileReader

A simple reader for .wav files that allows you to load most .wav files from the user's file system. It includes simple error handling features for both file system errors as well as WAV parse errors.

This plugin uses a simple parser to know where the audio data starts, instead of naively assuming that this data will be found at byte 44 (which is not guaranteed).

The example track in this repository was made by me.

Features

• Load most .wav files into godot from outside the res:// directory
• Simple error handling for those who want their .wav file loading to never fail
• The ability to obtain the file's abstract syntax tree

Known problems

• If your data is in PCM8 unsigned format, the audio will not load properly as this parser currently does not convert it into signed data.
• I have no idea how compressed WAV files work, so I am not certain that they are properly implemented

How To Use

Loading A File

To load a file, simply call WAVFileReader.load("your/file/path"). This will return a Dictionary. If the loading process didn't error, your file will be in the result field as an AudioStreamSample, otherwise this field will be null.

This means you can simply do something like this, and it'll work.

$MyAudioStream.stream = WAVFileReader.load("user://my/file/path.wav").result

However, this will not error if the file is corrupted or not present. Instead, it will make the AudioStream be silent.

Error Handling

The most basic form of error detection this plugin provides comes in the form of merely detecting whether everything went fine or not. Simply check if the result is null.

var MyStream :AudioStreamSample = WAVFileReader.load("user://my/file/path.wav").result
if MyStream.result:
	$MyAudioStream.stream = MyStream.result
else:
	push_error("no music? *megamind meme*")

The output dictionary also contains error message data, which can be used, for example, to show the user what kind of error happened.

var MyStream :AudioStreamSample = WAVFileReader.load("user://my/file/path.wav").result
if MyStream.result:
	$MyAudioStream.stream = MyStream.result
else:
	$MyNotificationBox.text = MyStream.message

You can also separate between file system errors and WAV parse errors, as all WAV parse error codes are negative numbers, while all file system error codes are positive number. WAV parse errors occur when the file you tried to open is missing vital data, such as the audio part of it, or how many audio channels there are. File system errors occur when the file is missing, corrupted, or in some other way inaccessible at the moment.

var MyStream :AudioStreamSample = WAVFileReader.load("user://my/file/path.wav").result
if MyStream.result:
	$MyAudioStream.stream = MyStream.result
elif MyStream.code > 0:
	push_error("no file? *megamind meme*")
else:
	push_error("broken file? *megamind meme*")

WAV Parsing Error Codes

This table contains the custom error codes and a simple explanation of them