al_SynthSequencer.hpp

 
#ifndef AL_SYNTHSEQUENCER_HPP
#define AL_SYNTHSEQUENCER_HPP
 
/*  Allolib --
        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:
        Event Voice and Sequencer
 
        File author(s):
        Andrés Cabrera mantaraya36@gmail.com
*/
 
#include <atomic>
#include <cassert>
#include <functional>
#include <list>
#include <memory>
#include <mutex>
#include <string>
#include <thread>
#include <vector>
 
#include "al/graphics/al_Graphics.hpp"
#include "al/io/al_AudioIOData.hpp"
#include "al/io/al_File.hpp"
#include "al/scene/al_PolySynth.hpp"
#include "al/ui/al_Parameter.hpp"
 
namespace al {
 
class SynthSequencerEvent {
public:
  SynthSequencerEvent() {}
 
  ~SynthSequencerEvent() {}
 
  typedef enum { EVENT_VOICE, EVENT_PFIELDS, EVENT_TEMPO } EventType;
 
  double startTime{0};
  double duration{-1};
  int offsetCounter{0}; // To offset event within audio buffer
 
  EventType type{EVENT_VOICE};
 
  typedef struct {
    std::string name; // instrument name
    std::vector<ParameterField> pFields;
  } ParamFields;
 
  SynthVoice *voice{nullptr};
  ParamFields fields;
  float tempo;
  int voiceId;
};
 
enum SynthEventType { TRIGGER_ON, TRIGGER_OFF, PARAMETER_CHANGE };
 
struct SynthEvent {
  std::string synthName;
  double time;
  int id;
  double duration = -1;
  std::vector<ParameterField> pFields;
  SynthEventType type;
};
 
class SynthSequencer {
public:
  SynthSequencer(TimeMasterMode masterMode = TimeMasterMode::TIME_MASTER_CPU) {
    mMasterMode = masterMode;
    mInternalSynth = std::make_unique<PolySynth>(masterMode);
    registerSynth(*mInternalSynth.get());
  }
 
  SynthSequencer(PolySynth &synth) { registerSynth(synth); }
 
  ~SynthSequencer() {
    stopSequence();
    if (mCpuThread) {
      mCpuThread->join();
    }
  }
 
  void render(AudioIOData &io);
 
  void render(Graphics &g);
 
  void update(double dt);
 
  void setGraphicsFrameRate(float fps) { mFps = fps; }
 
  template <class TSynthVoice>
  TSynthVoice &add(double startTime, double duration = -1);
 
  template <class TSynthVoice>
  void addVoice(TSynthVoice *voice, double startTime, double duration = -1);
 
  template <class TSynthVoice>
  void addVoiceFromNow(TSynthVoice *voice, double startTime,
                       double duration = -1);
 
  static void audioCB(AudioIOData &io) { io.user<SynthSequencer>().render(io); }
 
  void print();
 
  bool playing() { return mPlaying; }
 
  bool verbose() { return mVerbose; }
  void verbose(bool verbose) { mVerbose = verbose; }
 
  void setTempo(float tempo) { mNormalizedTempo = tempo / 60.; }
 
  bool playSequence(std::string sequenceName = "", float startTime = 0.0f);
 
  void stopSequence();
  void setTime(float newTime);
 
  void setDirectory(std::string directory);
 
  std::string buildFullPath(std::string sequenceName);
 
  std::list<SynthSequencerEvent> loadSequence(std::string sequenceName,
                                              double timeOffset = 0,
                                              double timeScale = 1.0);
 
  void playEvents(std::list<SynthSequencerEvent> events,
                  double timeOffset = 0.1);
 
  std::vector<std::string> getSequenceList();
 
  double getSequenceDuration(std::string sequenceName);
 
  PolySynth &synth() { return *mPolySynth; }
 
  // Callbacks
  void registerTimeChangeCallback(std::function<void(float)> func,
                                  float minTimeDeltaSec = 0);
 
  void registerSequenceBeginCallback(std::function<void(std::string)> func);
  void registerSequenceEndCallback(std::function<void(std::string)> func);
 
  void registerSynth(PolySynth &synth);
 
  void operator<<(PolySynth &synth) { return registerSynth(synth); }
 
private:
  PolySynth *mPolySynth;
  std::unique_ptr<PolySynth> mInternalSynth;
 
  std::string mDirectory{"."};
  bool mVerbose{false};
  std::string mLastSequencePlayed;
 
  double mFps{0}; // graphics frames per second
 
  unsigned int mNextEvent{0};
  std::list<SynthSequencerEvent>
      mEvents; // List of events sorted by start time.
  std::mutex mEventLock;
  std::mutex mLoadingLock;
  bool mPlaying{false};
 
  TimeMasterMode mMasterMode{TimeMasterMode::TIME_MASTER_AUDIO};
  double mMasterTime{0.0};
  double mPlaybackStartTime{0.0};
 
  double mNormalizedTempo{1.0}; // Linearly normalized inverted around 60 bpm
                                // (1.0 = 60bpm, 0.5 = 120 bpm)
 
  // Time change callback
  std::vector<std::pair<std::function<void(float)>, float>>
      mTimeChangeCallbacks;
  //    float mTimeChangeMinTimeDelta = 0;
  std::vector<double> mTimeAccumCallbackNs; // Accumulator for tirggering
                                            // time change callback.
 
  std::vector<std::function<void(std::string sequenceName)>>
      mSequenceBeginCallbacks;
  std::vector<std::function<void(std::string sequenceName)>>
      mSequenceEndCallbacks;
 
  // CPU processing thread. Used when TIME_MASTER_CPU
  std::shared_ptr<std::thread> mCpuThread;
 
  void processEvents(double blockStartTime, double fps);
};
 
//  Implementations -------------
 
template <class TSynthVoice>
TSynthVoice &SynthSequencer::add(double startTime, double duration) {
  TSynthVoice *newVoice = mPolySynth->getVoice<TSynthVoice>();
  if (newVoice) {
    addVoice<TSynthVoice>(newVoice, startTime, duration);
  }
  return *newVoice;
}
 
template <class TSynthVoice>
void SynthSequencer::addVoice(TSynthVoice *voice, double startTime,
                              double duration) {
  std::list<SynthSequencerEvent>::iterator insertedEvent;
  std::unique_lock<std::mutex> lk(mEventLock);
  // Insert into event list, sorted.
  auto position = mEvents.begin();
  while (position != mEvents.end() && position->startTime < startTime) {
    position++;
  }
  insertedEvent = mEvents.insert(position, SynthSequencerEvent());
  insertedEvent->startTime = startTime;
  insertedEvent->duration = duration;
  insertedEvent->voice = voice;
}
 
template <class TSynthVoice>
void SynthSequencer::addVoiceFromNow(TSynthVoice *voice, double startTime,
                                     double duration) {
  float triggerOffset = 0.05;
  addVoice(voice, mMasterTime + startTime + triggerOffset, duration);
}
 
} // namespace al
 
#endif // AL_SYNTHSEQUENCER_HPP