sound.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-2007 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_H__
#define __SOUND_H__
 
 
/*----------------------------------------------------------------------------
--  Includes
----------------------------------------------------------------------------*/
 
#include "unitsound.h"
#include "SDL.h"
#include "SDL_mixer.h"
 
/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/
 
class CUnit;
class Missile;
class LuaActionListener;
 
/*----------------------------------------------------------------------------
--  Definitons
----------------------------------------------------------------------------*/
 
#define MaxSampleVolume 255  
#define NO_SOUND 0           
 
 
enum UnitVoiceGroup {
        VoiceSelected,          
        VoiceAcknowledging,     
        VoiceReady,             
        VoiceHelpMe,            
        VoiceDying,             
        VoiceWorkCompleted,     
        VoiceBuilding,          
        VoiceDocking,           
        VoiceRepairing,         
        VoiceHarvesting,        
        VoiceAttack,            
        VoiceBuild              
};
 
 
class GameSound
{
public:
        SoundConfig PlacementError[MAX_RACES];        
        SoundConfig PlacementSuccess[MAX_RACES];      
        SoundConfig Click;                            
        SoundConfig Docking;                          
        SoundConfig BuildingConstruction[MAX_RACES];  
        SoundConfig WorkComplete[MAX_RACES];          
        SoundConfig Rescue[MAX_RACES];                
        SoundConfig ChatMessage;                      
        SoundConfig ResearchComplete[MAX_RACES];      
        SoundConfig NotEnoughRes[MAX_RACES][MaxCosts];
        SoundConfig NotEnoughFood[MAX_RACES];         
};
 
class CSound
{
public:
        CSound() : Mapref(0), Range(0), Number(0)
        {
                memset(&Sound, 0, sizeof(Sound));
        }
        ~CSound();
        unsigned int Mapref;
        unsigned char Range;        
        unsigned char Number;       
        union {
                Mix_Chunk *OneSound;       
                Mix_Chunk **OneGroup;      
                struct {
                        CSound *First;       
                        CSound *Second;      
                } TwoGroups;             
        } Sound;
};
 
#define ONE_SOUND 0
 
#define TWO_GROUPS 1
 
#define INFINITE_SOUND_RANGE 255
 
#define MAX_SOUND_RANGE 254
 
struct Origin {
        const void *Base;   
        unsigned Id;        
};
 
 
/*----------------------------------------------------------------------------
--  Variables
----------------------------------------------------------------------------*/
 
extern GameSound GameSounds;  
 
extern int DistanceSilent;
 
/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/
 
extern unsigned char CalculateVolume(bool isVolume, int power, unsigned char range);
extern void PlayUnitSound(const CUnit &unit, UnitVoiceGroup unit_voice_group, bool sampleUnique = false);
extern void PlayUnitSound(const CUnit &unit, CSound *sound);
extern void PlayMissileSound(const Missile &missile, CSound *sound);
extern void PlayGameSound(CSound *sound, unsigned char volume, bool always = false);
 
extern int PlayFile(const std::string &name, LuaActionListener *listener = NULL);
 
extern void SetSoundRange(CSound *sound, unsigned char range);
 
extern CSound *RegisterSound(const std::vector<std::string> &files);
 
extern CSound *RegisterTwoGroups(CSound *first, CSound *second);
 
extern void InitSoundClient();
 
 
// music.cpp
 
extern void InitMusic();
 
extern void CallbackMusicEnable();
 
extern void CallbackMusicDisable();
 
extern void CallbackMusicTrigger();
 
// sound_id.cpp
 
extern void MapSound(const std::string &sound_name, CSound *id);
extern CSound *SoundForName(const std::string &sound_name);
extern CSound *MakeSound(const std::string &sound_name, const std::vector<std::string> &files);
extern CSound *MakeSoundGroup(const std::string &name, CSound *first, CSound *second);
 
extern void FreeSounds();
 
// script_sound.cpp
 
extern void SoundCclRegister();
 
 
 
#endif  // !__SOUND_H__