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
 
#include <vector>
 
class FCKeySignature : public __FCBase
{
    friend class FCTransposer;
    
    twobyte _transposealteration;
    bool _simplifykey;
    eKey _key;
    
    eHarmLev _CalcKeyStepsInNormalizedDiatonicInterval(eHarmLev normalizedInterval) const;
 
    eHarmLev _CalcKeyStepsBetweenScaleDegrees(eHarmLev first, eHarmLev second) const;
 
    eHarmAlt _CalcStepsInAlteration(eHarmLev diatonicInterval, eHarmLev alteration) const;
 
public:
 
    FCKeySignature(eKey key = KEY_C_MAJOR) : __FCBase()
    {
        _key = key;
        _transposealteration = 0;
        _simplifykey = false;
    }
 
    const char* ClassName() const override { return "FCKeySignature"; }
    const PDKFRAMEWORK_CLASSID GetClassID() const override { return FCID_KEYSIGNATURE; }
 
    twobyte GetKeyMode() const
    {
        if (IsLinear()) return GetLinearKeyMode(_key);
        return _key;
    }
 
    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 (!IsLinear()) 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 < -6)
            {
                keyalteration += 12;
            }
            if (keyalteration > 6)
            {
                keyalteration -= 12;
            }
        }
        
        if (IsLinear())
            return MakeLinearKey( keyalteration, GetLinearKeyMode(_key) );
        else
            return _key;
    }
 
    twobyte GetTransposeAlteration() const
    {
        return _transposealteration;
    }
    
    bool GetTransposeSimplify() const
    {
        return _simplifykey;
    }
    
    bool GetTransposeChromatic() const
    {
        return _simplifykey; //?? RGP 12/11/21 (not Lua-supported)
    }
 
    int CalcScaleRootIndex() const;
 
    int CalcRootRelationIndex() const;
    
    int CalcRootRelationAbsoluteIndex() const;
    
    twobyte CalcSharps() const;
 
    twobyte CalcFlats() const;
 
    twobyte CalcTotalChromaticSteps() const;
 
    std::vector<eHarmLev> CalcDiatonicStepsMap() const;
 
    bool IsPredefined() const { return IsPredefinedKey( GetIDWithTransposition() ); }
 
    bool IsLinear() const { return IsLinearKey( GetID() ); }
 
    bool IsMajor() const { return IsMajorKey(GetIDWithTransposition()); }
 
    bool IsMinor() const { return IsMinorKey(GetIDWithTransposition());  }
    
    bool IsIdentical(const __FCBase* pCompareObject) const override;
    
    bool IsSharpNote(int letterindex) const;
    
    bool IsFlatNote(int letterindex) const;
    
    void MakeString(FCString* pString) const;
    
    eHarmLev CalcScaleNumber(eHarmLev displacement) const;
 
    
#ifdef PDK_FRAMEWORK_DEBUG
    void DebugDump() override
    {    
        __FCBase::DebugDump();
        DebugOutInt("Key ID: ", GetID());
        DebugOutBool("Is major: ", IsMajor());
        DebugOutBool("Is minor: ", IsMinor());
        DebugOutInt("Calculate sharps: ", CalcSharps());
        DebugOutInt("Calculate flats: ", CalcFlats());
        DebugOutInt("Calculate scale root index: ", CalcScaleRootIndex());
        DebugOutInt("Calculate root relation index: ", CalcRootRelationIndex());
        DebugOutInt("Calculate root relation absolute index: ", CalcRootRelationAbsoluteIndex());
    }
#endif
    
};
 
#endif  /* FF_KEYSIG_H */