SDL_sound.h

/*
 * SDL_sound; An abstract sound format decoding API.
 *
 * Please see the file LICENSE.txt in the source's root directory.
 */
 
/* WIKI CATEGORY: SDLSound */

 
#ifndef SDL_SOUND_H_
#define SDL_SOUND_H_
 
#include <SDL3/SDL.h>
 
#if SDL_MAJOR_VERSION < 3
#error SDL3_sound requires SDL 3.0.0 or later.
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

#define SDL_SOUND_MAJOR_VERSION 3

#define SDL_SOUND_MINOR_VERSION 0

#define SDL_SOUND_MICRO_VERSION 0

#define SDL_SOUND_VERSION \
    SDL_VERSIONNUM(SDL_SOUND_MAJOR_VERSION, SDL_SOUND_MINOR_VERSION, SDL_SOUND_MICRO_VERSION)

#define SDL_SOUND_VERSION_ATLEAST(X, Y, Z) \
    ((SDL_SOUND_MAJOR_VERSION >= X) && \
     (SDL_SOUND_MAJOR_VERSION > X || SDL_SOUND_MINOR_VERSION >= Y) && \
     (SDL_SOUND_MAJOR_VERSION > X || SDL_SOUND_MINOR_VERSION > Y || SDL_SOUND_MICRO_VERSION >= Z))
 

extern SDL_DECLSPEC int SDLCALL Sound_Version(void);
 

typedef enum Sound_SampleFlags
{
    SOUND_SAMPLEFLAG_NONE    = 0,       
 
        /* these are set at sample creation time... */
    SOUND_SAMPLEFLAG_CANSEEK = 1,       
 
        /* these are set during decoding... */
    SOUND_SAMPLEFLAG_EOF     = 1 << 29, 
    SOUND_SAMPLEFLAG_ERROR   = 1 << 30, 
    SOUND_SAMPLEFLAG_EAGAIN  = 1 << 31  
} Sound_SampleFlags;
 

typedef struct Sound_DecoderInfo
{
    const char **extensions; 
    const char *description; 
    const char *author;      
    const char *url;         
} Sound_DecoderInfo;
 
 

typedef struct Sound_Sample
{
    void *opaque;  
    const Sound_DecoderInfo *decoder;  
    SDL_AudioSpec desired;  
    SDL_AudioSpec actual;  
    void *buffer;  
    Uint32 buffer_size;  
    Sound_SampleFlags flags;  
} Sound_Sample;
 
 
 
/* functions and macros... */

extern SDL_DECLSPEC int SDLCALL Sound_Init(void);
 

extern SDL_DECLSPEC int SDLCALL Sound_Quit(void);
 

extern SDL_DECLSPEC const Sound_DecoderInfo ** SDLCALL Sound_AvailableDecoders(void);
 

extern SDL_DECLSPEC const char * SDLCALL Sound_GetError(void);
 

extern SDL_DECLSPEC void SDLCALL Sound_ClearError(void);
 

extern SDL_DECLSPEC Sound_Sample * SDLCALL Sound_NewSample(SDL_IOStream *io,
                                                   const char *ext,
                                                   const SDL_AudioSpec *desired,
                                                   Uint32 bufferSize);

extern SDL_DECLSPEC Sound_Sample * SDLCALL Sound_NewSampleFromMem(const Uint8 *data,
                                                      Uint32 size,
                                                      const char *ext,
                                                      const SDL_AudioSpec *desired,
                                                      Uint32 bufferSize);
 

extern SDL_DECLSPEC Sound_Sample * SDLCALL Sound_NewSampleFromFile(const char *filename,
                                                      const SDL_AudioSpec *desired,
                                                      Uint32 bufferSize);

extern SDL_DECLSPEC void SDLCALL Sound_FreeSample(Sound_Sample *sample);
 

extern SDL_DECLSPEC Sint32 SDLCALL Sound_GetDuration(Sound_Sample *sample);
 

extern SDL_DECLSPEC int SDLCALL Sound_SetBufferSize(Sound_Sample *sample,
                                            Uint32 new_size);
 

extern SDL_DECLSPEC Uint32 SDLCALL Sound_Decode(Sound_Sample *sample);
 

extern SDL_DECLSPEC Uint32 SDLCALL Sound_DecodeAll(Sound_Sample *sample);
 

extern SDL_DECLSPEC int SDLCALL Sound_Rewind(Sound_Sample *sample);
 

extern SDL_DECLSPEC int SDLCALL Sound_Seek(Sound_Sample *sample, Uint32 ms);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* !defined SDL_SOUND_H_ */
 
/* end of SDL_sound.h ... */