nel/src/sound/group_controller.cpp

   1 /**
   2  * \file group_controller.cpp
   3  * \brief CGroupController
   4  * \date 2012-04-10 09:29GMT
   5  * \author Jan Boon (Kaetemi)
   6  * CGroupController
   7  */
   8
   9 // NeL - MMORPG Framework <https://wiki.ryzom.dev/>
  10 // Copyright (C) 2012  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
  11 //
  12 // This program is free software: you can redistribute it and/or modify
  13 // it under the terms of the GNU Affero General Public License as
  14 // published by the Free Software Foundation, either version 3 of the
  15 // License, or (at your option) any later version.
  16 //
  17 // This program is distributed in the hope that it will be useful,
  18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 // GNU Affero General Public License for more details.
  21 //
  22 // You should have received a copy of the GNU Affero General Public License
  23 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 #include "stdsound.h"
  26 #include <nel/sound/group_controller.h>
  27
  28 // STL includes
  29
  30 // NeL includes
  31 // #include <nel/misc/debug.h>
  32 #include <nel/sound/source_common.h>
  33
  34 // Project includes
  35
  36 using namespace std;
  37 // using namespace NLMISC;
  38
  39 namespace NLSOUND {
  40
  41 CGroupController::CGroupController(CGroupController *parent) :
  42         m_Parent(parent), m_Gain(1.0f), m_NbSourcesInclChild(0)
  43 {
  44
  45 }
  46
  47 CGroupController::~CGroupController()
  48 {
  49         // If m_Sources is not empty, a crash is very likely.
  50         nlassert(m_Sources.empty());
  51
  52         for (std::map<std::string, CGroupController *>::iterator it(m_Children.begin()), end(m_Children.end()); it != end; ++it)
  53         {
  54                 delete it->second;
  55                 it->second = NULL;
  56         }
  57         m_Parent = NULL;
  58 }
  59
  60 void CGroupController::addSource(CSourceCommon *source)
  61 {
  62         nlassert(this != NULL);
  63
  64         m_Sources.insert(source);
  65         increaseSources();
  66 }
  67
  68 void CGroupController::removeSource(CSourceCommon *source)
  69 {
  70         decreaseSources();
  71         m_Sources.erase(source);
  72 }
  73
  74 std::string CGroupController::getPath() // overridden by root
  75 {
  76         for (std::map<std::string, CGroupController *>::iterator it(m_Parent->m_Children.begin()), end(m_Parent->m_Children.end()); it != end; ++it)
  77         {
  78                 if (it->second == this)
  79                 {
  80                         const std::string &name = it->first;
  81                         std::string returnPath = m_Parent->getPath() + ":" + name;
  82                         return returnPath;
  83                 }
  84         }
  85         nlerror("Group Controller not child of parent");
  86         return "";
  87 }
  88
  89 void CGroupController::calculateFinalGain() // overridden by root
  90 {
  91         m_FinalGain = calculateTotalGain() * m_Parent->getFinalGain();
  92 }
  93
  94 void CGroupController::updateSourceGain()
  95 {
  96         // Dont update source gain when this controller is inactive.
  97         if (m_NbSourcesInclChild)
  98         {
  99                 calculateFinalGain();
 100                 for (TSourceContainer::iterator it(m_Sources.begin()), end(m_Sources.end()); it != end; ++it)
 101                         (*it)->updateFinalGain();
 102                 for (std::map<std::string, CGroupController *>::iterator it(m_Children.begin()), end(m_Children.end()); it != end; ++it)
 103                         (*it).second->updateSourceGain();
 104         }
 105 }
 106
 107 void CGroupController::increaseSources() // overridden by root
 108 {
 109         ++m_NbSourcesInclChild;
 110         m_Parent->increaseSources();
 111
 112         // Update source gain when this controller was inactive before but the parent was active before.
 113         // Thus, when this controller was the root of inactive controllers.
 114         if (m_NbSourcesInclChild == 1 && m_Parent->m_NbSourcesInclChild > 1)
 115                 updateSourceGain();
 116 }
 117
 118 void CGroupController::decreaseSources() // overridden by root
 119 {
 120         --m_NbSourcesInclChild;
 121         m_Parent->decreaseSources();
 122 }
 123
 124 } /* namespace NLSOUND */
 125
 126 /* end of file */