al_DynamicScene.hpp

 
#ifndef AL_DYNAMICSCENE_HPP
#define AL_DYNAMICSCENE_HPP
 
/*  Allocore --
        Multimedia / virtual environment application class library
 
        Copyright (C) 2009. AlloSphere Research Group, Media Arts & Technology,
   UCSB. Copyright (C) 2012-2018. The Regents of the University of California.
        All rights reserved.
 
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are
   met:
 
                Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 
                Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the following disclaimer in the
                documentation and/or other materials provided with the
   distribution.
 
                Neither the name of the University of California nor the names
   of its contributors may be used to endorse or promote products derived from
                this software without specific prior written permission.
 
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
   IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
   OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
   OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
   ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
        File description:
        Dynamic Scene Manager
 
        File author(s):
        Andrés Cabrera mantaraya36@gmail.com
*/
 
#include <condition_variable>
#include <memory>
#include <queue>
#include <thread>
 
#include "al/math/al_Vec.hpp"
#include "al/scene/al_SynthSequencer.hpp"
#include "al/sound/al_Speaker.hpp"
#include "al/sound/al_StereoPanner.hpp"
#include "al/spatial/al_DistAtten.hpp"
#include "al/spatial/al_Pose.hpp"
 
namespace al {
class PositionedVoice : public SynthVoice {
public:
  const Pose pose() { return mPose.get(); }
 
  float size() { return mSize.get(); }
 
  void setPose(Pose pose) { mPose.set(pose); }
 
  void setSize(float size) { mSize.set(size); }
 
  ParameterPose &parameterPose() { return mPose; }
 
  Parameter &parameterSize() { return mSize; }
 
  bool useDistanceAttenuation() { return mUseDistAtten; }
  void useDistanceAttenuation(bool atten) { mUseDistAtten = atten; }
 
  std::vector<Vec3f> &audioOutOffsets() { return mAudioOutPositionOffsets; }
 
  void audioOutOffsets(const std::vector<Vec3f> &offsets) {
    mAudioOutPositionOffsets = offsets;
  }
 
  virtual void preProcess(Graphics & /*g*/) {}
 
  virtual bool setTriggerParams(float *pFields, int numFields = -1) override;
 
  virtual bool setTriggerParams(std::vector<float> &pFields,
                                bool noCalls = false) override;
 
  virtual bool setTriggerParams(std::vector<ParameterField> pFields,
                                bool noCalls = false) override;
 
  virtual std::vector<ParameterField> getTriggerParams() override {
    std::vector<ParameterField> pFields = SynthVoice::getTriggerParams();
    pFields.reserve(pFields.size() + 8);
    Pose currentPose = pose();
    pFields.insert(pFields.end(), currentPose.vec().begin(),
                   currentPose.vec().end());
 
    auto *comps = currentPose.quat().components;
 
    pFields.push_back(*comps++);
    pFields.push_back(*comps++);
    pFields.push_back(*comps++);
    pFields.push_back(*comps);
 
    pFields.push_back(mSize.get());
    return pFields;
  }
 
protected:
  void markAsReplica() { mIsReplica = true; }
 
  ParameterPose mPose{"_pose"};
  Parameter mSize{"_size", "", 1.0};
  //    ParameterPose mPose {"_pose"};
  //    Parameter mSize {"_size", "", 1.0};
  std::vector<Vec3f>
      mAudioOutPositionOffsets; // This vector is added to the voice's position
                                // to determine the specific position of the
                                // audio out
 
  bool mUseDistAtten{true};
  bool mIsReplica{false}; // If voice is replica, it should not send its
                          // internal state but listen for changes.
};
 
struct UpdateThreadFuncData {
  SynthVoice *voice;
  double dt;
};
 
// thread pool from
// https://stackoverflow.com/questions/23896421/efficiently-waiting-for-all-tasks-in-a-threadpool-to-finish
class ThreadPool {
public:
  ThreadPool(unsigned int n = std::thread::hardware_concurrency());
 
  template <class F> void enqueue(F &&f, UpdateThreadFuncData &data);
  void waitForProcessingDone();
  ~ThreadPool();
 
  size_t size() { return workers.size(); }
 
  void stopThreads();
 
private:
  std::vector<std::thread> workers;
  std::deque<std::pair<std::function<void(UpdateThreadFuncData)>,
                       UpdateThreadFuncData>>
      tasks;
  std::mutex queue_mutex;
  std::condition_variable cv_task;
  std::condition_variable cv_finished;
  unsigned int busy;
  bool stop{false};
 
  void thread_proc();
};
 
template <class F> void ThreadPool::enqueue(F &&f, UpdateThreadFuncData &data) {
  std::unique_lock<std::mutex> lock(queue_mutex);
  tasks.emplace_back(std::pair<std::function<void(UpdateThreadFuncData)>,
                               UpdateThreadFuncData>(std::forward<F>(f), data));
  cv_task.notify_one();
}
 
class DynamicScene : public PolySynth {
public:
  DynamicScene(int threadPoolSize = 0,
               TimeMasterMode masterMode = TimeMasterMode::TIME_MASTER_AUDIO);
 
  virtual ~DynamicScene();
 
  template <class TSpatializer>
  std::shared_ptr<TSpatializer> setSpatializer(Speakers &sl) {
    mSpatializer = std::make_shared<TSpatializer>(sl);
    mSpatializer->compile();
    return std::static_pointer_cast<TSpatializer>(mSpatializer);
  }
 
  void prepare(AudioIOData &io);
 
  virtual void cleanup() {}
 
  Pose &listenerPose() { return mListenerPose; }
  void listenerPose(Pose &pose) { mListenerPose = pose; }
 
  virtual void render(Graphics &g) final;
  virtual void render(AudioIOData &io) final;
 
  virtual void update(double dt = 0) final;
 
  void setUpdateThreaded(bool threaded) { mThreadedUpdate = threaded; }
  void setAudioThreaded(bool threaded) { mThreadedAudio = threaded; }
 
  DistAtten<> &distanceAttenuation() { return mDistAtten; }
 
  void print(std::ostream &stream = std::cout);
 
  void showWorldMarker(bool show = true) { mDrawWorldMarker = show; }
 
  void sortDrawingByDistance(bool sort = true);
 
  void stopAudioThreads() {
    mSynthRunning = false;
    mThreadTrigger.notify_all();
    for (auto &thr : mAudioThreads) {
      thr.join();
    }
    mAudioThreads.clear();
  }
 
protected:
private:
  // A speaker layout and spatializer
  std::shared_ptr<Spatializer> mSpatializer;
 
  Pose mListenerPose;
  DistAtten<> mDistAtten;
 
  bool mSortDrawingByDistance{false};
  // For threaded simulation
  std::unique_ptr<ThreadPool> mWorkerThreads; // Update worker threads
  bool mThreadedUpdate{true};
 
  // For threaded audio
  bool mThreadedAudio{false};
  std::vector<std::thread> mAudioThreads;
  std::vector<AudioIOData> mThreadedAudioData;
  std::map<int, std::vector<int>>
      mThreadMap; // Defines which threads run which voices. Key is thread id,
                  // value is voice ids.
  std::condition_variable mThreadTrigger;
  std::condition_variable mAudioThreadDone;
  std::mutex mSpatializerLock;
  AudioIOData
      *externalAudioIO; // This is captured by the audio callback and passed to
                        // the audio threads. Protected by mSpatializerLock
  std::mutex mThreadTriggerLock;
  bool mSynthRunning{true};
  unsigned int mAudioBusy = 0;
 
  static void updateThreadFunc(UpdateThreadFuncData data);
 
  static void audioThreadFunc(DynamicScene *scene, int id);
 
  // World marker
  bool mDrawWorldMarker{false};
  Mesh mWorldMarker;
};
 
} // namespace al
 
#endif // AL_DYNAMICSCENE_HPP