al_PresetSequencer.hpp

#ifndef AL_PRESETSEQUENCER_H
#define AL_PRESETSEQUENCER_H
 
/*  Allocore --
        Multimedia / virtual environment application class library
 
        Copyright (C) 2009. AlloSphere Research Group, Media Arts & Technology,
   UCSB. Copyright (C) 2012-2016. 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:
        Preset sequencing
 
        File author(s):
        Andrés Cabrera mantaraya36@gmail.com
*/
 
#include <atomic>
#include <condition_variable>
#include <functional>
#include <future>
#include <mutex>
#include <queue>
#include <string>
#include <thread>
#include <utility>
 
#include "al/protocol/al_OSC.hpp"
#include "al/ui/al_PresetHandler.hpp"
 
namespace al {
 
class SequenceRecorder;
class Composition;
 
class PresetSequencer : public osc::MessageConsumer {
  friend class Composition;
 
 public:
  PresetSequencer(
      TimeMasterMode timeMasterMode = TimeMasterMode::TIME_MASTER_CPU);
  ~PresetSequencer() override;
 
  typedef enum { PRESET, EVENT, PARAMETER } StepType;
 
  struct Step {
    StepType type = PRESET;
    std::string name;
    float morphTime;  // The time to get to the preset
    float waitTime;   // The time to stay in the preset before the next step
    std::vector<ParameterField> params;
  };
 
  typedef struct {
    std::string eventName;
    std::function<void(void *data, std::vector<ParameterField> &params)>
        callback;
    void *callbackData;
  } EventCallback;
 
  void playSequence(std::string sequenceName, double timeScale = 1.0f,
                    double timeOffset = 0.0);
 
  void stopSequence(bool triggerCallbacks = true);
 
  void setTime(double time);
 
  void rewind();
 
  bool playbackFinished() { return mSteps.size() == mCurrentStep; }
 
  std::vector<std::string> getSequenceList();
 
  void setDirectory(std::string directory) { mDirectory = directory; }
 
  void setHandlerSubDirectory(std::string subDir);
 
  inline bool running() { return mRunning; }
 
  PresetSequencer &registerPresetHandler(PresetHandler &presetHandler);
 
  PresetSequencer &operator<<(PresetHandler &presetHandler) {
    return registerPresetHandler(presetHandler);
  }
 
  PresetSequencer &operator<<(ParameterMeta &param) {
    return registerParameter(param);
  }
 
  PresetSequencer &registerParameter(ParameterMeta &param) {
    mParameters.push_back(&param);
    return *this;
  }
 
  std::vector<Step> loadSequence(std::string sequenceName,
                                 double timeScale = 1.0);
 
  std::string currentSequence() { return mCurrentSequence; }
 
  void registerEventCommand(
      std::string eventName,
      std::function<void(void *data, std::vector<ParameterField> &params)>
          callback,
      void *data);
 
  void setOSCSubPath(std::string subPath) { mOSCsubPath = subPath; }
 
  void registerBeginCallback(
      std::function<void(PresetSequencer *sender)> beginCallback);
 
  void enableBeginCallback(bool enable) { mBeginCallbackEnabled = enable; }
 
  void toggleEnableBeginCallback() {
    mBeginCallbackEnabled = !mBeginCallbackEnabled;
  }
 
  void registerEndCallback(
      std::function<void(bool finished, PresetSequencer *sender)> endCallback);
 
  void enableEndCallback(bool enable) { mEndCallbackEnabled = enable; }
  void toggleEnableEndCallback() { mEndCallbackEnabled = !mEndCallbackEnabled; }
 
  void registerTimeChangeCallback(std::function<void(float)> func,
                                  float minTimeDeltaSec = -1.0);
 
  float getSequenceStartOffset(std::string sequenceName);
  float getSequenceTotalDuration(std::string sequenceName);
 
  // For programmatic control of the sequencer:
  void clearSteps();
 
  void appendStep(Step &newStep);
 
  void setTimeMaster(TimeMasterMode masterMode);
 
  void stepSequencer(double dt);
 
  void stepSequencer();
 
  void setSequencerStepTime(double stepTime) { mGranularity = stepTime * 1e9; }
 
 protected:
  virtual bool consumeMessage(osc::Message &m,
                              std::string rootOSCPath) override;
 
  void processTimeChangeRequest();
  void updateTime(double time);
 
  void updateSequencer();
 
 private:
  static void sequencerFunction(PresetSequencer *sequencer);
 
  std::string buildFullPath(std::string sequenceName);
 
  void startCpuThread();
  void stopCpuThread();
 
  std::vector<Step> mSteps;
  std::string mDirectory;
  PresetHandler *mPresetHandler{nullptr};
  std::vector<ParameterMeta *> mParameters;
  std::string mOSCsubPath;
  std::string mCurrentSequence;
 
  std::atomic<float> mTimeRequest{-1.0f};  // Request setting the current time.
                                           // Passes info to playback thread
 
  TimeMasterMode mTimeMasterMode;
 
  bool mSequencerActive{false};
  bool mRunning;
  bool mStartRunning;
  std::queue<Step> mParameterList;
  double mCurrentTime = 0.0;  // Current time (in seconds)
  double mTargetTime;
  double mLastPresetTime;  // To anchor parameter deltas
  double mParameterTargetTime;
  double mLastTimeUpdate = 0.0;
  double mStepTime;
 
  uint64_t mGranularity = 10e6;  // nanoseconds
  bool mBeginCallbackEnabled;
  std::function<void(PresetSequencer *)> mBeginCallback;
  bool mEndCallbackEnabled;
  std::function<void(bool, PresetSequencer *)> mEndCallback;
  std::vector<EventCallback> mEventCallbacks;
  std::vector<std::function<void(float)>> mTimeChangeCallbacks;
  float mTimeChangeMinTimeDelta = 0.05f;
 
  // CPU thread
 
  //  std::chrono::high_resolution_clock::time_point mSequenceStart =
  //      std::chrono::high_resolution_clock::now();
  std::unique_ptr<std::thread> mSequencerThread;
  std::mutex mSequenceLock;
  uint64_t mCurrentStep;
  PresetHandler::ParameterStates mStartValues;
  std::mutex mPlayWaitLock;
  std::condition_variable mPlayWaitVariable;
  //  std::mutex mPlayStartedLock;
  //  std::condition_variable mPlayStartedVariable;
  std::shared_ptr<std::promise<void>> mPlayPromiseObj;
};
 
}  // namespace al
 
#endif  // AL_PRESETSEQUENCER_H