warzone2100/lib/sound/track.h

148 lines
4.6 KiB
C

/*
This file is part of Warzone 2100.
Copyright (C) 1999-2004 Eidos Interactive
Copyright (C) 2005-2010 Warzone 2100 Project
Warzone 2100 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.
Warzone 2100 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 Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef __INCLUDED_LIB_SOUND_TRACK_H__
#define __INCLUDED_LIB_SOUND_TRACK_H__
#include "lib/framework/frame.h"
#include <physfs.h>
#ifndef WZ_NOSOUND
# ifdef WZ_OS_MAC
# include <OpenAL/al.h>
# else
# include <AL/al.h>
# endif
#endif
#if defined(__cplusplus)
extern "C"
{
#endif
#define ATTENUATION_FACTOR 0.0003f
#define SAMPLE_NOT_ALLOCATED -1
#define SAMPLE_NOT_FOUND -3
#define SAMPLE_COORD_INVALID -5
#define AUDIO_VOL_MAX 100L
/* typedefs
*/
typedef BOOL (* AUDIO_CALLBACK) ( void *psObj );
typedef struct __audio_stream AUDIO_STREAM;
/* structs */
typedef struct AUDIO_SAMPLE
{
SDWORD iTrack; // ID number identifying a specific sound; currently (r1182) mapped in audio_id.c
#ifndef WZ_NOSOUND
ALuint iSample; // OpenAL name of the sound source
#ifdef DEBUG // only used for debugging
ALboolean isLooping; // if sample loops
ALboolean is3d; // if sample is 3d (as opposed to 2d)
char filename[256]; // actual filename of sample
#endif
#endif
SDWORD x, y, z;
float fVol; // computed volume of sample
BOOL bFinishedPlaying;
AUDIO_CALLBACK pCallback;
void *psObj;
struct AUDIO_SAMPLE *psPrev;
struct AUDIO_SAMPLE *psNext;
} AUDIO_SAMPLE;
typedef struct TRACK
{
BOOL bLoop;
SDWORD iVol;
SDWORD iAudibleRadius;
SDWORD iTime; // duration in milliseconds
UDWORD iTimeLastFinished; // time last finished in ms
UDWORD iNumPlaying;
#ifndef WZ_NOSOUND
ALuint iBufferName; // OpenAL name of the buffer
#endif
const char* fileName;
} TRACK;
/* functions
*/
BOOL sound_Init(void);
BOOL sound_Shutdown(void);
TRACK * sound_LoadTrackFromFile(const char *fileName);
unsigned int sound_SetTrackVals(const char* fileName, BOOL loop, unsigned int volume, unsigned int audibleRadius);
void sound_ReleaseTrack( TRACK * psTrack );
void sound_StopTrack( AUDIO_SAMPLE *psSample );
void sound_PauseTrack( AUDIO_SAMPLE *psSample );
void sound_UpdateSample( AUDIO_SAMPLE *psSample );
void sound_CheckAllUnloaded( void );
void sound_RemoveActiveSample( AUDIO_SAMPLE *psSample );
BOOL sound_CheckTrack( SDWORD iTrack );
SDWORD sound_GetTrackTime( SDWORD iTrack );
SDWORD sound_GetTrackAudibleRadius( SDWORD iTrack );
SDWORD sound_GetTrackVolume( SDWORD iTrack );
const char * sound_GetTrackName( SDWORD iTrack );
BOOL sound_TrackLooped( SDWORD iTrack );
void sound_SetCallbackFunction( void * fn );
BOOL sound_Play2DTrack( AUDIO_SAMPLE *psSample, BOOL bQueued );
BOOL sound_Play3DTrack( AUDIO_SAMPLE *psSample );
void sound_PlayWithCallback( AUDIO_SAMPLE *psSample, SDWORD iCurTime, AUDIO_CALLBACK pDoneFunc );
void sound_FinishedCallback( AUDIO_SAMPLE *psSample );
BOOL sound_GetSystemActive( void );
SDWORD sound_GetTrackID( TRACK *psTrack );
SDWORD sound_GetAvailableID( void );
SDWORD sound_GetNumPlaying( SDWORD iTrack );
SDWORD sound_GetGlobalVolume( void );
void sound_SetGlobalVolume( SDWORD iVol );
void sound_SetStoppedCallback( AUDIO_CALLBACK pStopTrackCallback );
UDWORD sound_GetTrackTimeLastFinished( SDWORD iTrack );
void sound_SetTrackTimeLastFinished( SDWORD iTrack, UDWORD iTime );
extern BOOL sound_isStreamPlaying(AUDIO_STREAM *stream);
extern void sound_StopStream(AUDIO_STREAM* stream);
extern void sound_PauseStream(AUDIO_STREAM* stream);
extern void sound_ResumeStream(AUDIO_STREAM* stream);
extern AUDIO_STREAM* sound_PlayStreamWithBuf(PHYSFS_file* fileHandle, float volume, void (*onFinished)(void*), void* user_data, size_t streamBufferSize, unsigned int buffer_count);
extern float sound_GetStreamVolume(const AUDIO_STREAM* stream);
extern void sound_SetStreamVolume(AUDIO_STREAM* stream, float volume);
#if defined(__cplusplus)
}
#endif
void soundTest(void);
#endif // __INCLUDED_LIB_SOUND_TRACK_H__