background_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_BACKGROUND_SOUND_H
#define NL_BACKGROUND_SOUND_H

#include "nel/misc/string_mapper.h"
#include "sound.h"
#include "nel/sound/u_audio_mixer.h"

namespace NLSOUND {

//class ISoundDriver;
//class IBuffer;
//class CSound;



class CBackgroundSound : public CSound
{
public:
        CBackgroundSound();
        ~CBackgroundSound();

        TSOUND_TYPE getSoundType()                                                      { return SOUND_BACKGROUND;}

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

        bool                            isDetailed() const                              { return false;}
        virtual uint32          getDuration();

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

        virtual float           getMaxDistance() const;

        void                            serial(NLMISC::IStream &s);

        struct TSoundInfo
        {
                NLMISC::TStringId               SoundName;
                UAudioMixer::TBackgroundFlags           Filter;

                void serial(NLMISC::IStream &s)
                {
                        std::string soundName;
                        if (s.isReading())
                        {
                                s.serial(soundName);
                                SoundName = NLMISC::CStringMapper::map(soundName);
                        }
                        else
                        {
                                soundName = NLMISC::CStringMapper::unmap(SoundName);
                                s.serial(soundName);
                        }
                        s.serial(Filter);
                }
        };

        const std::vector<TSoundInfo> &getSounds() const                        { return _Sounds;}

private:


        std::vector<TSoundInfo>         _Sounds;
        

        // Duration of sound.
        uint32                                          _Duration;
        // flag for validity of duration (after first evaluation).
        bool                                            _DurationValid;
};

} // NLSOUND

#endif // NL_BACKGROUND_SOUND_H

---