nel/src/sound/music_sound.cpp

   1 // NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2010  Matt RAYKOWSKI (sfb) <matt.raykowski@gmail.com>
   6 // Copyright (C) 2012  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   7 //
   8 // This program is free software: you can redistribute it and/or modify
   9 // it under the terms of the GNU Affero General Public License as
  10 // published by the Free Software Foundation, either version 3 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU Affero General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU Affero General Public License
  19 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 #include "stdsound.h"
  22
  23 #include "nel/sound/music_sound.h"
  24 #include "nel/misc/path.h"
  25 #include "nel/georges/u_form_elm.h"
  26
  27 #if NLSOUND_SHEET_VERSION_BUILT < 2
  28 #       include "nel/sound/group_controller_root.h"
  29 #endif
  30
  31 using namespace std;
  32 using namespace NLMISC;
  33
  34 namespace NLSOUND {
  35
  36
  37 // ***************************************************************************
  38 CMusicSound::CMusicSound()
  39 {
  40         // init with NULL in case of unexcepted access
  41         _FileName= NULL;
  42         _FadeInLength= 2000;
  43         _FadeOutLength= 2000;
  44         _MinimumPlayTime= 10000;
  45         _TimeBeforeCanReplay= 0;
  46         LastStopTime= INT_MIN;
  47 }
  48
  49 // ***************************************************************************
  50 CMusicSound::~CMusicSound()
  51 {
  52 }
  53
  54
  55 // ***************************************************************************
  56 void            CMusicSound::importForm(const std::string& filename, NLGEORGES::UFormElm& root)
  57 {
  58         NLGEORGES::UFormElm *psoundType;
  59         std::string dfnName;
  60
  61         // some basic checking.
  62         root.getNodeByName(&psoundType, ".SoundType");
  63         nlassert(psoundType != NULL);
  64         psoundType->getDfnName(dfnName);
  65         nlassert(dfnName == "music_sound.dfn");
  66
  67         // Call the base class
  68         CSound::importForm(filename, root);
  69
  70         // fileName
  71         std::string musicFileName;
  72         root.getValueByName(musicFileName, ".SoundType.FileName");
  73         musicFileName = CFile::getFilename(musicFileName);
  74         _FileName = CStringMapper::map(musicFileName);
  75
  76         // Other params
  77         root.getValueByName(_FadeInLength, ".SoundType.FadeInLength");
  78         root.getValueByName(_FadeOutLength, ".SoundType.FadeOutLength");
  79         root.getValueByName(_MinimumPlayTime, ".SoundType.MinimumPlayTime");
  80         root.getValueByName(_TimeBeforeCanReplay, ".SoundType.TimeBeforeCanReplay");
  81
  82 #if NLSOUND_SHEET_VERSION_BUILT < 2
  83         _GroupController = CGroupControllerRoot::getInstance()->getGroupController(NLSOUND_SHEET_V1_DEFAULT_SOUND_MUSIC_GROUP_CONTROLLER);
  84 #endif
  85
  86 }
  87
  88 // ***************************************************************************
  89 uint32          CMusicSound::getDuration()
  90 {
  91         // Cannot know the length of this music sound.
  92         // Since its not really a sound (played in another "channel"), suppose 0
  93         return 0;
  94 }
  95
  96 // ***************************************************************************
  97 void            CMusicSound::getSubSoundList(std::vector<std::pair<std::string, CSound*> > &subsounds) const
  98 {
  99         subsounds.clear();
 100 }
 101
 102 // ***************************************************************************
 103 void            CMusicSound::serial(NLMISC::IStream &s)
 104 {
 105         s.serialVersion(0);
 106         CSound::serial(s);
 107
 108         CStringMapper::serialString(s, _FileName);
 109         s.serial(_FadeInLength, _FadeOutLength);
 110         s.serial(_MinimumPlayTime, _TimeBeforeCanReplay);
 111
 112 #if NLSOUND_SHEET_VERSION_BUILT < 2
 113         if (s.isReading()) _GroupController = CGroupControllerRoot::getInstance()->getGroupController(NLSOUND_SHEET_V1_DEFAULT_SOUND_MUSIC_GROUP_CONTROLLER);
 114 #endif
 115
 116 }
 117
 118 // ***************************************************************************
 119 float           CMusicSound::getMaxDistance() const
 120 {
 121         // used in background_sound_manager, since 2D sound, return 0 because
 122         // the sound must be cut once out of the patat
 123         return 0.f;
 124 }
 125
 126 // ***************************************************************************
 127 bool            CMusicSound::isDetailed() const
 128 {
 129         return false;
 130 }
 131
 132
 133
 134 } // NLSOUND