sound.h

Go to the documentation of this file.

/* Copyright, 2001 Nevrax Ltd.
 *
 * This file is part of NEVRAX NEL.
 * NEVRAX NEL 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, or (at your option)
 * any later version.

 * NEVRAX NEL 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 NEVRAX NEL; see the file COPYING. If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

#ifndef NL_SOUND_H
#define NL_SOUND_H

#include "nel/misc/types_nl.h"
#include "nel/misc/stream.h"
#include "nel/misc/string_mapper.h"
#include "nel/sound/u_source.h"
#include "nel/georges/u_form_elm.h"
#include <string>

namespace NLSOUND {


class ISoundDriver;
class IBuffer;
class CSound;


//typedef std::hash_map<std::string, CSound*> TSoundMap;
typedef CHashMap<NLMISC::TStringId, CSound*, NLMISC::CStringIdHashMapTraits> TSoundMap;

typedef std::set<CSound*> TSoundSet;

const double Sqrt12_2 = 1.0594630943592952645618252949463;  // 2^1/12

class CSound
{
    friend class CAudioMixerUser;
public:
    static CSound *createSound(const std::string &filename, NLGEORGES::UFormElm& formRoot);

    enum TSOUND_TYPE
    {
        SOUND_SIMPLE,
        SOUND_COMPLEX,
        SOUND_BACKGROUND,
        SOUND_CONTEXT,
        SOUND_MUSIC
    };


    CSound();
    virtual ~CSound();

    virtual TSOUND_TYPE getSoundType() =0;

    virtual void        importForm(const std::string& filename, NLGEORGES::UFormElm& formRoot);

    bool                getLooping() const              { return _Looping; }
    float               getGain() const                 { return _Gain; }
    float               getPitch() const                { return _Pitch; }
    TSoundPriority      getPriority() const             { return _Priority; }
    virtual bool        isDetailed() const = 0;
    float               getConeInnerAngle() const           { return _ConeInnerAngle; }
    float               getConeOuterAngle() const           { return _ConeOuterAngle; }
    float               getConeOuterGain() const            { return _ConeOuterGain; }
    const NLMISC::CVector &getDirectionVector()const        { return _Direction;}
    virtual uint32      getDuration() = 0;
    const NLMISC::TStringId&    getName() const                     { return _Name; }
    virtual float       getMaxDistance() const              { return _MaxDist; }

    void                setLooping( bool looping ) { _Looping = looping; }

    virtual void        getSubSoundList(std::vector<std::pair<std::string, CSound*> > &subsounds) const =0;


    virtual void        serial(NLMISC::IStream &s);

    NLMISC::TStringId   getUserVarControler() { return _UserVarControler; }

    bool                operator<( const CSound& otherSound ) const
    {
        return NLMISC::CStringMapper::unmap(_Name) < NLMISC::CStringMapper::unmap(otherSound._Name);
    }

protected:

    // Static properties
    float               _Gain;  // [0,1]
    float               _Pitch; // ]0,1]
    TSoundPriority      _Priority;
    float               _ConeInnerAngle, _ConeOuterAngle, _ConeOuterGain;
    NLMISC::CVector     _Direction;

    bool                _Looping;

    float               _MaxDist;

    // Sound name.
    NLMISC::TStringId   _Name;
    NLMISC::TStringId   _UserVarControler;

};


class ESoundFileNotFound : public NLMISC::Exception
{
public:
    ESoundFileNotFound( const std::string filename ) :
      NLMISC::Exception( (std::string("Sound file not found, or invalid file format: ")+filename).c_str() ) {}
};


} // NLSOUND


#endif // NL_SOUND_H

/* End of sound.h */