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

       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.h

Go to the documentation of this file.

//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
//
//      (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 <vector>

#include "unit.h"
#include "unitsound.h"
#include "player.h"

/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/

class CUnit;
class Missile;
class CSample;
class LuaActionListener;

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

#define MaxSampleVolume 255  
#define NO_SOUND 0           


class GameSound
{
public:
    SoundConfig PlacementError;        
    SoundConfig PlacementSuccess;      
    SoundConfig Click;                 
    SoundConfig Docking;               
    SoundConfig BuildingConstruction;  
    SoundConfig WorkComplete;          
    SoundConfig Rescue;                
    SoundConfig ChatMessage;           
};

class CSound {
public:
    CSound() : Range(0), Number(0)
    {
        memset(&Sound, 0, sizeof(Sound));
    }
    ~CSound();

    unsigned char Range;        
    unsigned char Number;       
    union {
        CSample *OneSound;       
        CSample **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 bool CallbackMusic;  

extern int DistanceSilent;

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

extern void PlayUnitSound(const CUnit *unit, UnitVoiceGroup unit_voice_group);
extern void PlayUnitSound(const CUnit *unit, CSound *sound);
extern void PlayMissileSound(const Missile *missile, CSound *sound);
extern void PlayGameSound(CSound *sound, unsigned char volume);

extern int PlayFile(const std::string &name, LuaActionListener *listener = NULL);

extern void SetSoundRange(CSound *sound, unsigned char range);

extern CSound *RegisterSound(const char *files[], unsigned number);

extern CSound *RegisterTwoGroups(CSound *first, CSound *second);

extern void InitSoundClient(void);


// music.cpp

extern void CheckMusicFinished(bool force = false);

extern void InitMusic(void);

#define CallbackMusicOn() \
    CallbackMusic = true;
#define CallbackMusicOff() \
    CallbackMusic = false;


// 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 char *file[], int nb);
extern CSound *MakeSoundGroup(const std::string &name, CSound *first, CSound *second);
#ifdef DEBUG
extern void FreeSounds();
#endif


// script_sound.cpp

extern void SoundCclRegister(void);



#endif  // !__SOUND_H__

---