____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.

(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

---

sound_server.h

Go to the documentation of this file.

//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
//
//      (c) Copyright 1998-2008 by Lutz Sammer, Fabrice Rossi, and
//                                 Jimmy Salmon
//
//      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; only version 2 of the License.
//
//      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., 59 Temple Place - Suite 330, Boston, MA
//      02111-1307, USA.

#ifndef __SOUND_SERVER_H__
#define __SOUND_SERVER_H__


/*----------------------------------------------------------------------------
--  Definitons
----------------------------------------------------------------------------*/

#define MaxVolume 255
#define SOUND_BUFFER_SIZE 65536

class CSample {
public:
    CSample() : Channels(0), SampleSize(0), Frequency(0), BitsPerSample(0),
        Buffer(NULL), Pos(0), Len(0) {}
    virtual ~CSample() {}

    virtual int Read(void *buf, int len) = 0;

    unsigned char Channels;       
    unsigned char SampleSize;     
    unsigned int Frequency;       
    unsigned short BitsPerSample; 

    unsigned char *Buffer;        
    int Pos;                      
    int Len;                      
};

enum _play_audio_flags_ {
    PlayAudioStream = 1,        
    PlayAudioPreLoad = 2,       
    PlayAudioLoadInMemory = 4,  
    PlayAudioLoadOnDemand = 8,  
};

/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/

extern CSample *LoadWav(const std::string &name, int flags);    
extern CSample *LoadVorbis(const std::string &name, int flags); 

extern int SetChannelVolume(int channel, int volume);
extern int SetChannelStereo(int channel, int stereo);
extern void SetChannelFinishedCallback(int channel, void (*callback)(int channel));
extern CSample *GetChannelSample(int channel);
extern void StopChannel(int channel);
extern void StopAllChannels();

extern CSample *LoadSample(const std::string &name);
extern int PlaySample(CSample *sample);
extern int PlaySoundFile(const std::string &name);

extern void SetEffectsVolume(int volume);
extern int GetEffectsVolume(void);
extern void SetEffectsEnabled(bool enabled);
extern bool IsEffectsEnabled(void);

void SetMusicFinishedCallback(void (*callback)(void));
extern int PlayMusic(CSample *sample);
extern int PlayMusic(const std::string &file);
extern void StopMusic(void);
extern void SetMusicVolume(int volume);
extern int GetMusicVolume(void);
extern void SetMusicEnabled(bool enabled);
extern bool IsMusicEnabled(void);
extern bool IsMusicPlaying(void);

extern bool SoundEnabled(void);
extern int InitSound(void);
extern void QuitSound(void);


#endif  // !__SOUND_SERVER_H__

---