SDL_LoadWAV

Use this function to load a WAVE file.

Syntax

SDL_AudioSpec* SDL_LoadWAV(const char*    filename,
                           SDL_AudioSpec* spec,
                           Uint8**        audio_buf,
                           Uint32*        audio_len)

Function Parameters

Return Value

If this function succeeds, it returns the given SDL_AudioSpec, filled with the audio data format of the wave data, fils audio_buf with a pointer to a malloc()'d buffer containing the audio data, and fills audio_len with a pointer to the length of that audio buffer, in bytes.

This function returns NULL if the wave file cannot be opened, uses an unknown data format, or is corrupt; call SDL_GetError() for more information.

Code Examples

SDL_AudioSpec wav_spec;
Uint32 wav_length;
Uint8 *wav_buffer;

/* Load the WAV */
if( SDL_LoadWAV("test.wav", &wav_spec, &wav_buffer, &wav_length) == NULL ){
  fprintf(stderr, "Could not open test.wav: %s\n", SDL_GetError());
  exit(-1);
}
.
.
.
/* Do stuff with the WAV */
.
.
/* Free It */
SDL_FreeWAV(wav_buffer);

Remarks

Currently raw and MS-ADPCM WAVE files are supported.

You need to free the audio buffer with SDL_FreeWAV() when you are done with it.

Related Functions

• SDL_FreeWAV

• SDL_LoadWAV_RW

CategoryAPI, CategoryAudio