PlaybackState.h

Go to the documentation of this file.

#ifndef PlaybackState_h
#define PlaybackState_h

#include "MusicData.h"

namespace choir {

class PlaybackState: public MusicDatabaseObject
{
public:
   PlaybackState();

   ~PlaybackState();

   virtual void SetToDefaultState();

   virtual status_t SetFromArchive(const ConstMessageRef & archive);

   virtual status_t SaveToArchive(const MessageRef & archive) const;

   virtual uint32 GetCurrentChecksum() const {return CalculateChecksum();}

   virtual uint32 CalculateChecksum() const;

   virtual ConstMessageRef SeniorUpdate(const ConstMessageRef & seniorDoMsg);

   virtual status_t JuniorUpdate(const ConstMessageRef & juniorDoMsg);

   uint64 GetNetworkStartTimeMicros() const {return _networkStartTimeMicros;}

   uint64 GetMicrosPerChord() const {return _microsPerChord;}

   uint32 GetPausedIndex() const {return _pausedIndex;};

   void SetNetworkStartTimeMicros(uint64 networkStartTimeMicros) {_networkStartTimeMicros = networkStartTimeMicros;}

   void SetMicrosPerChord(uint64 microsPerChord, uint64 optNetworkNow = MUSCLE_TIME_NEVER);

   void SetPausedIndex(bool pausedIndex) {_pausedIndex = pausedIndex;};

   bool IsPaused() const {return (_pausedIndex != MUSCLE_NO_LIMIT);}

   void SetLoop(bool loop) {_loop = loop;}

   bool IsLoop() const {return _loop;}

   void StartPlayback(uint64 networkNow);

   void PausePlayback(uint64 networkNow);

   void SeekTo(uint64 networkNow, uint32 whichChord);

   uint32 GetChordIndexForNetworkTimeStamp(uint64 networkTimeStamp, uint32 optLoopLengthChords) const;

   uint64 GetNetworkTimeToPlayChord(uint32 chordIndex) const;

   int64 GetPlaybackPositionForNetworkTimeMicroseconds(uint64 networkTimestamp) const;

   virtual String ToString() const;

private:
   void SetToDefaultStateAux();
   MessageRef SeniorAdjustPlaybackState(uint32 whatCode, const uint64 * optNewMicrosPerChord, const uint32 * optSeekTo, bool * optSetLoop);

   uint64 _networkStartTimeMicros; // the network-time at which chord #0 is/was to be played
   uint64 _microsPerChord;         // How many microseconds each chord represents (i.e. this controls the playback tempo)
   uint32 _pausedIndex;            // If playback is paused, this is the chord it's currently at; if MUSCLE_NO_LIMIT then we're playing
   bool _loop;                     // If true, then playback should loop forever; if false, we'll only play through once
};
DECLARE_REFTYPES(PlaybackState);

}; // end namespace choir

#endif