nel/src/sound/sound_animation.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) 2019  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 #include "stdsound.h"
  21 #include "nel/sound/sound_animation.h"
  22 #include "nel/sound/sound_anim_marker.h"
  23 #include "nel/misc/stream.h"
  24 #include "nel/misc/i_xml.h"
  25 #include "nel/misc/o_xml.h"
  26 #include "nel/misc/file.h"
  27
  28 using namespace std;
  29 using namespace NLSOUND;
  30 using namespace NLMISC;
  31
  32 namespace NLSOUND {
  33
  34
  35 // ********************************************************
  36
  37 void CSoundAnimation::addMarker(CSoundAnimMarker* marker)
  38 {
  39         if (marker == NULL)
  40                 return;
  41
  42         _Dirty = true;
  43         _Markers.push_back(marker);
  44         sort();
  45 }
  46
  47 // ********************************************************
  48
  49 void CSoundAnimation::removeMarker(CSoundAnimMarker* marker)
  50 {
  51         if (marker == NULL)
  52                 return;
  53
  54         _Dirty = true;
  55         vector<CSoundAnimMarker*>::iterator iter;
  56         for (iter = _Markers.begin(); iter != _Markers.end(); iter++)
  57         {
  58                 if (*iter == marker)
  59                 {
  60                         _Markers.erase(iter);
  61                         break;
  62                 }
  63         }
  64 }
  65
  66 // ********************************************************
  67
  68 void CSoundAnimation::sort()
  69 {
  70         //std::sort<CSoundAnimMarker*, eqmarker>(_Markers.begin(), _Markers.end(), eqmarker());
  71 }
  72
  73 // ********************************************************
  74
  75 void CSoundAnimation::save()
  76 {
  77         // File stream
  78         COFile file;
  79         vector<NLMISC::TStringId>       sounds;
  80
  81         // Open the file
  82         if (!file.open(_Filename.c_str()))
  83         {
  84                 throw NLMISC::Exception("Can't open the file for writing");
  85         }
  86
  87         // Create the XML stream
  88         COXml output;
  89
  90         // Init
  91         if (output.init (&file, "1.0"))
  92         {
  93                 xmlDocPtr xmlDoc = output.getDocument();
  94
  95                 // Create the first node
  96                 xmlNodePtr root = xmlNewDocNode (xmlDoc, NULL, (const xmlChar*)"SOUNDANIMATION", NULL);
  97                 xmlDocSetRootElement (xmlDoc, root);
  98
  99                 vector<CSoundAnimMarker*>::iterator iter;
 100                 for (iter = _Markers.begin(); iter != _Markers.end(); iter++)
 101                 {
 102                         CSoundAnimMarker* marker = (*iter);
 103
 104                         set<string>::iterator iter;
 105
 106                         char s[64];
 107                         smprintf(s, 64, "%f", marker->getTime());
 108
 109                         xmlNodePtr markerNode = xmlNewChild (root, NULL, (const xmlChar*)"MARKER", NULL);
 110                         xmlSetProp (markerNode, (const xmlChar*) "time", (const xmlChar*) s);
 111
 112                         marker->getSounds(sounds);
 113
 114                         vector<NLMISC::TStringId>::iterator iter2;
 115                         for (iter2 = sounds.begin(); iter2 != sounds.end(); iter2++)
 116                         {
 117                                 xmlNodePtr soundNode = xmlNewChild ( markerNode, NULL, (const xmlChar*)"SOUND", NULL );
 118                                 xmlSetProp (soundNode, (const xmlChar*)"name", (const xmlChar*) CStringMapper::unmap(*iter2).c_str());
 119                         }
 120
 121                         sounds.clear();
 122                 }
 123
 124                 // Flush the stream, write all the output file
 125                 output.flush ();
 126         }
 127
 128         // Close the file
 129         file.close ();
 130
 131         _Dirty = false;
 132 }
 133
 134 // ********************************************************
 135
 136 void CSoundAnimation::play(UAudioMixer* mixer, float lastTime, float curTime, NL3D::CCluster *cluster, CSoundContext &context)
 137 {
 138         vector<CSoundAnimMarker*>::iterator iter;
 139         for (iter = _Markers.begin(); iter != _Markers.end(); iter++)
 140         {
 141                 CSoundAnimMarker* marker = *iter;
 142                 nlassert(marker);
 143
 144                 if ((lastTime <= marker->getTime()) && (marker->getTime() < curTime))
 145                 {
 146                         marker->play(mixer, cluster, context);
 147                 }
 148         }
 149 }
 150
 151 // ********************************************************
 152
 153 void CSoundAnimation::load()
 154 {
 155         CIFile file;
 156
 157         // Open the file
 158         if (!file.open(_Filename.c_str()))
 159         {
 160                 throw NLMISC::Exception("Can't open the file for reading");
 161         }
 162
 163         // Create the XML stream
 164         CIXml input;
 165
 166         // Init
 167         if (input.init (file))
 168         {
 169                 xmlNodePtr animNode = input.getRootNode ();
 170                 xmlNodePtr markerNode = input.getFirstChildNode(animNode, "MARKER");
 171
 172                 while (markerNode != 0)
 173                 {
 174                         CSoundAnimMarker* marker = new CSoundAnimMarker();
 175
 176                         const char *time = (const char*) xmlGetProp(markerNode, (xmlChar*) "time");
 177                         if (time == 0)
 178                         {
 179                                 throw NLMISC::Exception("Invalid sound animation marker");
 180                         }
 181
 182                         float val;
 183                         NLMISC::fromString(time, val);
 184
 185                         marker->setTime(val);
 186                         xmlFree ((void*)time);
 187
 188
 189                         xmlNodePtr soundNode = input.getFirstChildNode(markerNode, "SOUND");
 190
 191                         while (soundNode != 0)
 192                         {
 193                                 char *name = (char*) xmlGetProp(soundNode, (xmlChar*) "name");
 194                                 if (name == 0)
 195                                 {
 196                                         throw NLMISC::Exception("Invalid sound animation marker");
 197                                 }
 198
 199                                 marker->addSound(CStringMapper::map(string(name)));
 200
 201                                 xmlFree ((void*)name);
 202
 203                                 soundNode = input.getNextChildNode(soundNode, "SOUND");
 204                         }
 205
 206                         addMarker(marker);
 207
 208                         markerNode = input.getNextChildNode(markerNode, "MARKER");
 209                 }
 210         }
 211
 212         // Close the file
 213         file.close ();
 214         _Dirty = false;
 215 }
 216
 217 } //namespace NLSOUND