ff_timesig.h

/*
 * File:   ff_timesig.h
 * Author: Jari Williamsson
 *
 * Created on den 9 april 2011, 14:28
 */

#ifndef FF_TIMESIG_H
#define FF_TIMESIG_H

#include "ff_basecollection.h"
/* ff_other.h can NOT be included here! */


#ifdef PDK_FRAMEWORK_COMPOSITETIMESIGS
class FCCompositeTimeSigTop;
class FCCompositeTimeSigBottom;
#endif

class FCTimeSignature : public __FCBaseData
{
#include "pragma_align_begin.h"
    struct _TIMESIG_DATASTRUCT {
        twobyte beats;
        twobyte beatduration;
        bool compositetop;
        bool compositebottom;
        bool abbreviate;
    } _timesigdata;
#include "pragma_align_end.h"
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS

    virtual EXTAG Tag() { return 0; }
    virtual int DataSizeLoad() { return sizeof(_timesigdata); }
    virtual void* Allocate() { return (void*) &_timesigdata; }

    virtual void CloneMemoryFrom(__FCBaseData* pSource)
    {
        memcpy(&_timesigdata, ((FCTimeSignature*)pSource)->_GetTimeSigDataPtr(), sizeof(_timesigdata));
        _datablock = &_timesigdata;
        _loadedsize = DataSizeLoad();
    }

    virtual __FCBaseData* CreateObject() { return new FCTimeSignature(); }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */

    virtual bool LoadFirst() { return false; }
public:


#ifndef DOXYGEN_SHOULD_IGNORE_THIS

    _TIMESIG_DATASTRUCT* _GetTimeSigDataPtr()
    {
        return &_timesigdata;
    }
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */


    FCTimeSignature() : __FCBaseData()
    {
        _timesigdata.beats = 4;
        _timesigdata.beatduration = 1024;
        _timesigdata.compositetop = false;
        _timesigdata.compositebottom = false;
        _timesigdata.abbreviate = false;
    }

    virtual const char* ClassName() { return "FCTimeSignature"; }
    virtual const PDKFRAMEWORK_CLASSID GetClassID() { return FCID_TIMESIGNATURE; }

    void SetBeats(twobyte value)
    {
        _timesigdata.beats = value;        
    }

    void SetBeatDuration(twobyte value)
    {
        _timesigdata.beatduration = value;        
    }

    void SetCompositeTop(bool value) { _timesigdata.compositetop = value; }

    void SetCompositeBottom(bool value) { _timesigdata.compositebottom = value; }


    void SetAbbreviate(bool state) { _timesigdata.abbreviate = state; }

    twobyte GetBeats() const
    {    
        return _timesigdata.beats;
    }

#ifdef PDK_FRAMEWORK_COMPOSITETIMESIGS

    twobyte CalcBeats();

    twobyte CalcLargestBeats();
#endif

    twobyte GetBeatDuration() const
    {     
        return _timesigdata.beatduration;
    }

#ifdef PDK_FRAMEWORK_COMPOSITETIMESIGS

    twobyte CalcSmallestBeatDuration();

    twobyte CalcLargestBeatDuration();
#endif

    bool GetCompositeTop() const { return _timesigdata.compositetop; }

    bool GetCompositeBottom() const { return _timesigdata.compositebottom; }

    bool GetAbbreviate() const { return _timesigdata.abbreviate; }

#ifdef PDK_FRAMEWORK_COMPOSITETIMESIGS

    bool IsBeatPosition(TimeEdu32 eduposition);

    int CalcBeatPosition(TimeEdu32 eduposition);

    TimeEdu32 CalcPrevBeatPosition(TimeEdu32 eduposition);
        
    TimeEdu32 CalcNextBeatPosition(TimeEdu32 eduposition);

    bool IsIdentical(FCTimeSignature* pCompareSig);

    bool IsCompound();

    bool IsCommonTime()
    {
        if (GetBeats() != 4) return false;
        if (GetBeatDuration() != 1024) return false;
        return true;
    }
#endif

    static bool IsCompoundBeatDuration(TimeEdu32 duration);
    
    void MakeString(FCString* pString);

#ifdef PDK_FRAMEWORK_COMPOSITETIMESIGS

    FCCompositeTimeSigTop* CreateCompositeTop();

    bool SaveNewCompositeTop(FCCompositeTimeSigTop* pCompositeTop);

    FCCompositeTimeSigBottom* CreateCompositeBottom();

    bool SaveNewCompositeBottom(FCCompositeTimeSigBottom* pCompositeBottom);
#endif
};


#endif  /* FF_TIMESIG_H */