Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_LoadWAV (3)

Name

SDL_LoadWAV - Load a WAVE file

Synopsis

#include "SDL.h"

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

Description

SDL_LoadWAV(3)                 SDL API Reference                SDL_LoadWAV(3)



NAME
       SDL_LoadWAV - Load a WAVE file

SYNOPSIS
       #include "SDL.h"

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

DESCRIPTION
       SDL_LoadWAV This function loads a WAVE file into memory.

       If this function succeeds, it returns the given  SDL_AudioSpec,  filled
       with  the  audio  data format of the wave data, and sets audio_buf to a
       malloc'd buffer containing the audio data, and sets  audio_len  to  the
       length  of that audio buffer, in bytes. You need to free the audio buf-
       fer with SDL_FreeWAV when you are done with it.

       This function returns NULL and sets the SDL error message if  the  wave
       file cannot be opened, uses an unknown data format, or is corrupt. Cur-
       rently raw, MS-ADPCM and IMA-ADPCM WAVE files are supported.

EXAMPLE
       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
       ", SDL_GetError());
         exit(-1);
       }
       .
       .
       .
       /* Do stuff with the WAV */
       .
       .
       /* Free It */
       SDL_FreeWAV(wav_buffer);

ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_AudioSpec, SDL_OpenAudio, SDL_FreeWAV



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source       was        downloaded        from         https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 22:58              SDL_LoadWAV(3)