ff_keysig.h

/* 
 * File:   ff_keysig.h
 * Author: Jari Williamsson
 *
 * Created on den 15 november 2010, 00:14
 */

#ifndef FF_KEYSIG_H
#define FF_KEYSIG_H

class FCKeySignature : public __FCBaseData
{
    twobyte _transposealteration;
    bool _simplifykey;
    eKey _key;
protected:
#ifndef DOXYGEN_SHOULD_IGNORE_THIS

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

    virtual void CloneMemoryFrom(__FCBaseData* pSource)
    {
        _key = ((FCKeySignature*)pSource)->GetID();
        _transposealteration = ((FCKeySignature*)pSource)->GetTransposeAlteration();
        _simplifykey = ((FCKeySignature*)pSource)->GetTransposeSimplify();
        _datablock = &_key;
        _loadedsize = DataSizeLoad();
    }

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

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

    FCKeySignature() : __FCBaseData() 
    {
        _key = 0;
        _transposealteration = 0;
        _simplifykey = false;
    }

    virtual const char* ClassName() { return "FCKeySignature"; }
    virtual const PDKFRAMEWORK_CLASSID GetClassID() { return FCID_KEYSIGNATURE; }

    void SetID(eKey newkey) { _key = newkey; }

    void SetTransposeAlteration(twobyte value)
    {        
        _transposealteration = value;
    }
    
    void SetTransposeSimplify(bool state)
    {     
        _simplifykey = state;
    }
    
    void SetMajorKey(int accidentalnumber)
    {
        if (accidentalnumber < -7) return;
        if (accidentalnumber > 7) return;
        _key = MakeLinearKey( accidentalnumber, KEYMODE_MAJOR);
    }

    void SetMinorKey(int accidentalnumber)
    {
        if (accidentalnumber < -7) return;
        if (accidentalnumber > 7) return;
        _key = MakeLinearKey( accidentalnumber, KEYMODE_MINOR);
    }

    eKey GetID() const { return _key; }

    twobyte GetAlteration() const
    {
        if (!IsPredefined()) return 0;
        return GetKeyAlteration(GetIDWithTransposition());
    }

    eKey GetIDWithTransposition() const
    {
        /* Don't use other methods here, to avoid recursive calls.
         * Instead, use the PDK helper functions and macros.
         */
        twobyte keyalteration = GetKeyAlteration(_key);
        
        /* Chromatic key uses the standard key, so the transposition
         alteration should NOT be set. */
        keyalteration += _transposealteration;
        if (_simplifykey)
        {
            if (keyalteration < -7)
            {
                keyalteration += 12;
            }
            if (keyalteration > 7)
            {
                keyalteration -= 12;
            }
        }
        
        
        if (IsMinorKey(_key))
            return MAKE_TWOBYTE( keyalteration, KEYMODE_MINOR );
        else if (IsMajorKey(_key))
            return MAKE_TWOBYTE( keyalteration, KEYMODE_MAJOR );
        else
            return _key;
    }

    twobyte GetTransposeAlteration() const
    {
        return _transposealteration;
    }
    
    bool GetTransposeSimplify() const
    {
        return _simplifykey;
    }
    
    bool GetTransposeChromatic() const
    {
        return _simplifykey;
    }

    int CalcScaleRootIndex();

    int CalcRootRelationIndex();
    
    int CalcRootRelationAbsoluteIndex();
    
    twobyte CalcSharps();

    twobyte CalcFlats();

    bool IsPredefined() const { return IsPredefinedKey( GetIDWithTransposition() ); }

    bool IsMajor() { return IsMajorKey(GetIDWithTransposition()); }

    bool IsMinor() { return IsMinorKey(GetIDWithTransposition());  }
    
    bool IsIdentical(FCKeySignature* pCompareSig);
    
    bool IsSharpNote(int letterindex);
    
    bool IsFlatNote(int letterindex);
    
    void MakeString(FCString* pString);
    
    
#ifdef PDK_FRAMEWORK_DEBUG
    virtual void DebugDump()
    {    
        __FCBaseData::DebugDump();
        DebugOutDigit("Key ID: ", GetID());
        DebugOutBool("Is major: ", IsMajor());
        DebugOutBool("Is minor: ", IsMinor());
        DebugOutDigit("Calculate sharps: ", CalcSharps());
        DebugOutDigit("Calculate flats: ", CalcFlats());
        DebugOutDigit("Calculate scale root index: ", CalcScaleRootIndex());
        DebugOutDigit("Calculate root relation index: ", CalcRootRelationIndex());
        DebugOutDigit("Calculate root relation absolute index: ", CalcRootRelationAbsoluteIndex());
    }
#endif
    
};

#endif  /* FF_KEYSIG_H */