MusicData.h

Go to the documentation of this file.

#ifndef MusicData_h
#define MusicData_h

#include "message/Message.h"
#include "util/Hashtable.h"
#include "util/String.h"

#include "zg/ZGPeerID.h"
#include "zg/IDatabaseObject.h"
#include "ChoirNameSpace.h"

namespace choir {

class ChoirSession;

enum 
{
   CHOIR_NOTE_E6 = 0, // 1318.51 (third implied-line above the top-most line of the treble staff)
   CHOIR_NOTE_D6,  // 1174.659
   CHOIR_NOTE_C6,  // 1046.502
   CHOIR_NOTE_B5,  // 987.7666
   CHOIR_NOTE_A5,  // 880
   CHOIR_NOTE_G5,  // 783.9909
   CHOIR_NOTE_F5,  // 698.4565 (top-most explicit-line of the treble staff)
   CHOIR_NOTE_E5,  // 659.2551
   CHOIR_NOTE_D5,  // 587.3295
   CHOIR_NOTE_C5,  // 523.2511
   CHOIR_NOTE_B4,  // 493.8833
   CHOIR_NOTE_A4,  // 440
   CHOIR_NOTE_G4,  // 391.9954
   CHOIR_NOTE_F4,  // 349.2282
   CHOIR_NOTE_E4,  // 329.6276 (bottom-most explicit-line of the treble staff)
   CHOIR_NOTE_D4,  // 293.6648
   CHOIR_NOTE_C4,  // 261.6256 (middle C)
   CHOIR_NOTE_B3,  // 246.9417
   CHOIR_NOTE_A3,  // 220
   CHOIR_NOTE_G3,  // 195.9977
   CHOIR_NOTE_F3,  // 174.6141 (third implied-line below the bottom-most line of the treble staff)
   NUM_CHOIR_NOTES
};

const char * GetNoteName(uint32 noteIdx);

String GetPeerNickname(const ZGPeerID & pid, const ConstMessageRef & optPeerInfo);

enum {
   MUSIC_TYPE_MUSIC_SHEET = 1836413795, // 'musc' 
   MUSIC_TYPE_PLAYBACK_STATE,
   MUSIC_TYPE_ASSIGNMENTS_MAP
};

enum {
   DEFAULT_MICROSECONDS_PER_CHORD = 250000  // 4 chords/second is a reasonable default, I suppose?
};

enum {
   ASSIGNMENT_STRATEGY_AUTOMATIC = 0,  // ChoirSession will try to keep bells load-balanced at all times
   ASSIGNMENT_STRATEGY_ASSISTED,       // ChoirSession will assign unassigned bells, but otherwise leave things as they are
   ASSIGNMENT_STRATEGY_MANUAL,         // ChoirSession won't auto-assign anything; it's up the user to do it
   NUM_ASSIGNMENT_STRATEGIES
};

class MusicDatabaseObject : public IDatabaseObject
{
public:
   MusicDatabaseObject() {/* empty */}

protected:
   ChoirSession * GetChoirSession();

   const ChoirSession * GetChoirSession() const;

   ConstMessageRef SendFullStateToGUI(bool allowReviewTrigger);

   void SendMessageToGUI(const ConstMessageRef & msg, bool allowReviewTrigger);

   void SetReviewResults(uint64 allNotesUsedChord);
};
DECLARE_REFTYPES(MusicDatabaseObject);

// Utility function to upgrade our histogram and notes-bit-chord in response to the addition or removal of a notes-chord
void UpdateNoteHistogram(uint64 chordVal, bool isAdd, Hashtable<uint8, uint32> & histogram, uint64 & bitchord);

}; // end namespace choir

#endif