MusicSheet.h

Go to the documentation of this file.

#ifndef MusicSheet_h
#define MusicSheet_h

#include "MusicData.h"

namespace choir {

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

   MusicSheet(const MusicSheet & rhs);

   ~MusicSheet();
   
   MusicSheet & operator = (const MusicSheet & rhs);

   virtual void SetToDefaultState();

   virtual status_t SetFromArchive(const ConstMessageRef & archive);

   virtual status_t SaveToArchive(const MessageRef & archive) const;

   status_t UpdateFromArchive(const ConstMessageRef & archive);

   void SetSongFilePath(const String & songFilePath);

   const String & GetSongFilePath() const {return _songFilePath;}

   const OrderedKeysHashtable<uint32, uint64> & GetChordsTable() const {return _chords;}
  
   uint64 GetChordAtIndex(uint32 whichChord, bool useLoopingLogic) const {return _chords.GetWithDefault(useLoopingLogic?(whichChord%GetSongLengthInChords(false)):whichChord);}

   status_t PutChord(uint32 whichChord, uint64 chordValue);

   void RemoveChord(uint32 whichChord) {(void) PutChord(whichChord, 0);}

   void InsertChordAt(uint32 whichChord);

   void DeleteChordAt(uint32 whichChord);

   uint32 GetSongLengthInChords(bool useLoopingLogic) const {return ((useLoopingLogic)&&(_chords.HasItems())) ? MUSCLE_NO_LIMIT : (_chords.GetLastKeyWithDefault()+1);}

   uint64 GetAllUsedNotesChord() const {return _usedNotes;}

   virtual uint32 GetCurrentChecksum() const {return _checksum;}

   virtual uint32 CalculateChecksum() const;

   virtual ConstMessageRef SeniorUpdate(const ConstMessageRef & seniorDoMsg);

   virtual status_t JuniorUpdate(const ConstMessageRef & juniorDoMsg);

   virtual String ToString() const;

private:
   uint32 CalculateChecksumForChord(uint32 whichChord, uint64 chordValue) const {return ((whichChord+1)*CalculateChecksumForUint64(chordValue));}
   void MoveChordsBackOneStartingAt(uint32 whichChord);
   void SetToDefaultStateAux();

   String _songFilePath;                          // filepath this song was saved to (also used to generate a user-readable song title)
   OrderedKeysHashtable<uint32, uint64> _chords;  // time-index -> notes-chord (each bit indicates the presence or absence of a note)

   Hashtable<uint8, uint32> _noteHistogram;  // how many times each note is used in this song
   uint64 _usedNotes;                        // bit-chord of currently used notes (computed from the histogram)

   uint32 _checksum;    // always kept current, by updating it after each change
};
DECLARE_REFTYPES(MusicSheet);

}; // end namespace choir

#endif