src/libs/decoders/SDL_sound.h

/*
 *  Modified SDL Sound API
 *  ----------------------
 *  The basic gist of SDL_sound is that you use an SDL_RWops to get sound data
 *  into this library, and SDL_sound will take that data, in one of several
 *  popular formats, and decode it into raw waveform data in the format of
 *  your choice. This gives you a nice abstraction for getting sound into your
 *  game or application; just feed it to SDL_sound, and it will handle
 *  decoding and converting, so you can just pass it to your SDL audio
 *  callback (or whatever). Since it gets data from an SDL_RWops, you can get
 *  the initial sound data from any number of sources: file, memory buffer,
 *  network connection, etc.
 *
 *  As the name implies, this library depends on SDL2: Simple Directmedia Layer,
 *  which is a powerful, free, and cross-platform multimedia library. It can
 *  be found at http://www.libsdl.org/
 *
 * Support is in place for the following sound formats:
 *   - .WAV/.W64 (Microsoft WAVfile RIFF and Sony Wave64 data, via the dr_wav single-header codec)
 *   - .MP3  (MPEG-1 Layer 3 support via the dr_mp3 single-header decoder)
 *   - .OGG  (Ogg Vorbis support via the std_vorbis single-header decoder)
 *   - .OPUS (Ogg Opus support via the Opusfile and SpeexDSP libraries)
 *   - .FLAC (Free Lossless Audio Codec support via the dr_flac single-header decoder)
 *
 *  Copyright (C) 2020       The DOSBox Team
 *  Copyright (C) 2018-2019  Kevin R. Croft <krcroft@gmail.com>
 *  Copyright (C) 2001-2017  Ryan C. Gordon <icculus@icculus.org>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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)
#elif (__GNUC__ >= 3)
#  define SNDDECLSPEC __attribute__((visibility("default")))
#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    = 0x0, 
    /* these are set at sample creation time... */
    SOUND_SAMPLEFLAG_CANSEEK = 0x1, 
    /* these are set during decoding... */
    SOUND_SAMPLEFLAG_EOF     = 0x2, 
    SOUND_SAMPLEFLAG_ERROR   = 0x4, 
    SOUND_SAMPLEFLAG_EAGAIN  = 0x8  
} 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;  
    Uint32 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);

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

SNDDECLSPEC void SDLCALL Sound_FreeSample(Sound_Sample *sample);


SNDDECLSPEC Sint32 SDLCALL Sound_GetDuration(Sound_Sample *sample);

SNDDECLSPEC Uint32 SDLCALL Sound_Decode_Direct(Sound_Sample *sample, void* buffer, Uint32 desired_frames);

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 ... */