SDL_sound.h

Go to the documentation of this file.

/*
 * SDL_sound -- An abstract sound format decoding API.
 * Copyright (C) 2001  Ryan C. Gordon.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _INCLUDE_SDL_SOUND_H_
#define _INCLUDE_SDL_SOUND_H_

#include "SDL.h"
#include "SDL_endian.h"

#ifdef __cplusplus
extern "C" {
#endif

#ifndef DOXYGEN_SHOULD_IGNORE_THIS

#ifndef SDLCALL  /* may not be defined with older SDL releases. */
#define SDLCALL
#endif

#ifdef SDL_SOUND_DLL_EXPORTS
#  define SNDDECLSPEC __declspec(dllexport)
#else
#  define SNDDECLSPEC
#endif

#define SOUND_VER_MAJOR 1
#define SOUND_VER_MINOR 0
#define SOUND_VER_PATCH 1
#endif


typedef enum
{
    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
{
    Uint16 format;  
    Uint8 channels; 
    Uint32 rate;    
} Sound_AudioInfo;


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



typedef struct
{
    void *opaque;  
    const Sound_DecoderInfo *decoder;  
    Sound_AudioInfo desired;  
    Sound_AudioInfo actual;  
    void *buffer;  
    Uint32 buffer_size;  
    Sound_SampleFlags flags;  
} Sound_Sample;


typedef struct
{
    int major; 
    int minor; 
    int patch; 
} Sound_Version;


/* functions and macros... */

#define SOUND_VERSION(x) \
{ \
    (x)->major = SOUND_VER_MAJOR; \
    (x)->minor = SOUND_VER_MINOR; \
    (x)->patch = SOUND_VER_PATCH; \
}


SNDDECLSPEC void SDLCALL Sound_GetLinkedVersion(Sound_Version *ver);


SNDDECLSPEC int SDLCALL Sound_Init(void);


SNDDECLSPEC int SDLCALL Sound_Quit(void);


SNDDECLSPEC const Sound_DecoderInfo ** SDLCALL Sound_AvailableDecoders(void);


SNDDECLSPEC const char * SDLCALL Sound_GetError(void);


SNDDECLSPEC void SDLCALL Sound_ClearError(void);


SNDDECLSPEC Sound_Sample * SDLCALL Sound_NewSample(SDL_RWops *rw,
                                                   const char *ext,
                                                   Sound_AudioInfo *desired,
                                                   Uint32 bufferSize);

SNDDECLSPEC Sound_Sample * SDLCALL Sound_NewSampleFromFile(const char *fname,
                                                      Sound_AudioInfo *desired,
                                                      Uint32 bufferSize);

SNDDECLSPEC void SDLCALL Sound_FreeSample(Sound_Sample *sample);


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


SNDDECLSPEC Uint32 SDLCALL Sound_Decode(Sound_Sample *sample);


SNDDECLSPEC Uint32 SDLCALL Sound_DecodeAll(Sound_Sample *sample);


SNDDECLSPEC int SDLCALL Sound_Rewind(Sound_Sample *sample);


SNDDECLSPEC int SDLCALL Sound_Seek(Sound_Sample *sample, Uint32 ms);

#ifdef __cplusplus
}
#endif

#endif  /* !defined _INCLUDE_SDL_SOUND_H_ */

/* end of SDL_sound.h ... */

---