nel/src/sound/music_channel_fader.cpp

   1 // NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
   2 // Copyright (C) 2008-2020  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   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) 2010  Winch Gate Property Limited
   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 #include "nel/sound/music_channel_fader.h"
  23
  24 // Project includes
  25 #include "nel/sound/driver/sound_driver.h"
  26 #include "nel/sound/driver/music_channel.h"
  27 #include "nel/sound/source_music_channel.h"
  28
  29 using namespace std;
  30 using namespace NLMISC;
  31
  32 namespace NLSOUND {
  33
  34 CMusicChannelFader::CMusicChannelFader() : _SoundDriver(NULL), _ActiveMusicFader(0), _Gain(1.0f), _LastTime(0)
  35 {
  36
  37 }
  38
  39 CMusicChannelFader::~CMusicChannelFader()
  40 {
  41
  42 }
  43
  44 void CMusicChannelFader::init(ISoundDriver *soundDriver)
  45 {
  46         nlassert(!_SoundDriver);
  47         _SoundDriver = soundDriver;
  48         _ActiveMusicFader = 0;
  49         _Gain = 1.0f;
  50         _LastTime = CTime::getLocalTime();
  51         for (uint i = 0; i < _MaxMusicFader; ++i)
  52         {
  53                 nlassert(!_MusicFader[i].MusicChannel);
  54                 _MusicFader[i].MusicChannel = _SoundDriver->createMusicChannel();
  55                 if (!_MusicFader[i].MusicChannel)
  56                 {
  57                         if (_SoundDriver->getOption(ISoundDriver::OptionHasBufferStreaming))
  58                         {
  59                                 _MusicFader[i].MusicChannel = new CSourceMusicChannel();
  60                         }
  61                         else
  62                         {
  63                                 release();
  64                                 nlwarning("No music channel available!");
  65                                 return;
  66                         }
  67                 }
  68         }
  69 }
  70
  71 void CMusicChannelFader::release()
  72 {
  73         if (_SoundDriver)
  74         {
  75                 for (uint i = 0; i < _MaxMusicFader; ++i) if (_MusicFader[i].MusicChannel)
  76                 {
  77                         delete _MusicFader[i].MusicChannel;
  78                         _MusicFader[i].MusicChannel = NULL;
  79                 }
  80                 _SoundDriver = NULL;
  81         }
  82 }
  83
  84 void CMusicChannelFader::reset()
  85 {
  86         for (uint i = 0; i < _MaxMusicFader; ++i) if (_MusicFader[i].MusicChannel)
  87         {
  88                 if (_MusicFader[i].MusicChannel)
  89                         _MusicFader[i].MusicChannel->reset();
  90         }
  91 }
  92
  93 void CMusicChannelFader::update()
  94 {
  95         TTime current_time = CTime::getLocalTime();
  96         float delta_time = (float)(current_time - _LastTime) / 1000.0f;
  97         _LastTime = current_time;
  98         for (uint i = 0; i < _MaxMusicFader; ++i)
  99         {
 100                 _CMusicFader &fader = _MusicFader[i];
 101                 if (fader.Playing)
 102                 {
 103                         if (fader.MusicChannel->isEnded())
 104                         {
 105                                 fader.MusicChannel->stop();
 106                                 fader.Playing = false;
 107                                 fader.Fade = false;
 108                         }
 109                         else if (fader.Fade)
 110                         {
 111                                 // wait with fading in until the song has started playing (at 0 volume)
 112                                 if (!fader.MusicChannel->isLoadingAsync())
 113                                 {
 114                                         fader.XFadeVolume += fader.XFadeDVolume * delta_time;
 115                                         if (fader.XFadeVolume <= 0.f)
 116                                         {
 117                                                 // fadeout complete
 118                                                 fader.MusicChannel->stop();
 119                                                 fader.Fade = false;
 120                                                 fader.Playing = false;
 121                                         }
 122                                         else if (fader.XFadeVolume >= 1.f)
 123                                         {
 124                                                 // fadein complete
 125                                                 fader.Fade = false;
 126                                                 fader.XFadeVolume = 1.f;
 127                                         }
 128                                 }
 129                         }
 130                 }
 131         }
 132         updateVolume();
 133 }
 134
 135 void CMusicChannelFader::updateVolume()
 136 {
 137         for (uint i = 0; i < _MaxMusicFader; ++i)
 138                 if (_MusicFader[i].Playing)
 139                         _MusicFader[i].MusicChannel->setVolume(_MusicFader[i].XFadeVolume * _Gain);
 140 }
 141
 142 /** Play some music (.ogg etc...)
 143  *      NB: if an old music was played, it is first stop with stopMusic()
 144  *      \param filepath file path, CPath::lookup is done here
 145  *  \param async stream music from hard disk, preload in memory if false
 146  *      \param loop must be true to play the music in loop.
 147  */
 148 bool CMusicChannelFader::play(const std::string &filepath, uint xFadeTime, bool async, bool loop)
 149 {
 150         bool stopped = stop(xFadeTime);
 151
 152         // Find the next best free music channel
 153         uint nextFader = _MaxMusicFader;
 154         for (uint i = 0; i < _MaxMusicFader; ++i) if (!_MusicFader[i].Playing)
 155                 { nextFader = i; break; }
 156         if (nextFader == _MaxMusicFader)
 157         {
 158                 nextFader = (_ActiveMusicFader + 1) % _MaxMusicFader;
 159                 _MusicFader[nextFader].MusicChannel->stop();
 160                 _MusicFader[nextFader].Fade = false;
 161                 _MusicFader[nextFader].Playing = false;
 162         }
 163         _ActiveMusicFader = nextFader;
 164
 165         // Play a song in it :)
 166         _CMusicFader &fader = _MusicFader[_ActiveMusicFader];
 167         if (xFadeTime && !stopped) fader.fadeIn(xFadeTime); // only fade in when fading out
 168         else fader.XFadeVolume = 1.0f;
 169         fader.Playing = true;
 170         updateVolume(); // make sure at ok volume to start :)
 171         fader.Playing = fader.MusicChannel->play(filepath, async, loop);
 172         return fader.Playing;
 173 }
 174
 175 /// Stop the music previously loaded and played (the Memory is also freed)
 176 bool CMusicChannelFader::stop(uint xFadeTime)
 177 {
 178         if (xFadeTime)
 179         {
 180                 bool stopped = true;
 181                 for (uint i = 0; i < _MaxMusicFader; ++i) if (_MusicFader[i].Playing)
 182                 {
 183                         _MusicFader[i].fadeOut(xFadeTime);
 184                         stopped = false; // fading
 185                 }
 186                 return stopped;
 187         }
 188         else
 189         {
 190                 for (uint i = 0; i < _MaxMusicFader; ++i) if (_MusicFader[i].Playing)
 191                 {
 192                         _MusicFader[i].MusicChannel->stop();
 193                         _MusicFader[i].Fade = false;
 194                         _MusicFader[i].Playing = false;
 195                 }
 196                 return true;
 197         }
 198 }
 199
 200 /// Pause the music previously loaded and played (the Memory is not freed)
 201 void CMusicChannelFader::pause()
 202 {
 203         for (uint i = 0; i < _MaxMusicFader; ++i)
 204                 if (_MusicFader[i].Playing)
 205                         _MusicFader[i].MusicChannel->pause();
 206 }
 207
 208 /// Resume the music previously paused
 209 void CMusicChannelFader::resume()
 210 {
 211         for (uint i = 0; i < _MaxMusicFader; ++i)
 212                 if (_MusicFader[i].Playing)
 213                         _MusicFader[i].MusicChannel->resume();
 214 }
 215
 216 /// Return true if all songs are finished.
 217 bool CMusicChannelFader::isEnded()
 218 {
 219         for (uint i = 0; i < _MaxMusicFader; ++i)
 220         {
 221                 if (_MusicFader[i].Playing) if (!_MusicFader[i].MusicChannel->isEnded())
 222                         return false; // at least one song still playing
 223         }
 224         return true; // no song found that is still playing
 225 }
 226
 227 /// Return the total length (in second) of the music currently played
 228 float CMusicChannelFader::getLength()
 229 {
 230         return _MusicFader[_ActiveMusicFader].MusicChannel->getLength();
 231 }
 232
 233 /// Set the music volume (if any music played). (volume value inside [0 , 1]) (default: 1)
 234 /// NB: the volume of music is NOT affected by IListener::setGain()
 235 void CMusicChannelFader::setVolume(float gain)
 236 {
 237         _Gain = gain;
 238         updateVolume();
 239 }
 240
 241 } /* namespace NLSOUND */
 242
 243 /* end of file */