sound_server.h

Go to the documentation of this file.

//       _________ __                 __
//      /   _____//  |_____________ _/  |______     ____  __ __  ______
//      \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
//      /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ |
//     /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
//             \/                  \/          \//_____/            \/
//  ______________________                           ______________________
//                        T H E   W A R   B E G I N S
//         Stratagus - A free fantasy real time strategy game engine
//
//
//      (c) Copyright 1998-2005 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__
 
 
/*----------------------------------------------------------------------------
--  Includes
----------------------------------------------------------------------------*/
 
#include "sound.h"
 
/*----------------------------------------------------------------------------
--  Definitons
----------------------------------------------------------------------------*/
 
#define MaxVolume 255
#define SOUND_BUFFER_SIZE 65536
 
/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/
 
extern int SetChannelVolume(int channel, int volume);
extern void SetChannelStereo(int channel, int stereo);
extern Mix_Chunk *GetChannelSample(int channel);
extern void StopChannel(int channel);
extern void StopAllChannels();
 
extern bool UnitSoundIsPlaying(Origin *origin);
extern bool SampleIsPlaying(Mix_Chunk *sample);
extern Mix_Music *LoadMusic(const std::string &name);
extern Mix_Chunk *LoadSample(const std::string &name);
extern void FreeSample(Mix_Chunk *sample);
extern int PlaySample(Mix_Chunk *sample, Origin *origin = NULL);
extern int PlaySample(Mix_Chunk *sample, void (*callback)(int channel));
extern int PlaySoundFile(const std::string &name);
 
extern void SetEffectsVolume(int volume);
extern int GetEffectsVolume();
extern void SetEffectsEnabled(bool enabled);
extern bool IsEffectsEnabled();
 
void SetMusicFinishedCallback(void (*callback)());
extern int PlayMusic(const std::string &file);
extern void StopMusic();
extern void SetMusicVolume(int volume);
extern int GetMusicVolume();
extern void SetMusicEnabled(bool enabled);
extern bool IsMusicEnabled();
extern bool IsMusicPlaying();
 
extern bool SoundEnabled();
extern int InitSound();
extern void QuitSound();
 
extern uint32_t SDL_SOUND_FINISHED;
extern void HandleSoundEvent(SDL_Event &event);
 
 
#endif  // !__SOUND_SERVER_H__