ARTempo.h

#ifndef ARTempo_H
#define ARTempo_H
 
/*
  GUIDO Library
  Copyright (C) 2002  Holger Hoos, Juergen Kilian, Kai Renz
  Copyright (C) 2002-2017 Grame
 
  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
  Grame Research Laboratory, 11, cours de Verdun Gensoul 69002 Lyon - France
  research@grame.fr
 
*/
 
#include "ARMTParameter.h"
#include "ARFontAble.h"
#include "FormatStringParser.h"
 
/*@mkdoc
 
@group:Tempo
 
@tagname:\tempo
@tagalias:
@tagtype:P
@tagnotation:a tempo mark
@tagdesc
@tagend
 
@params:
@param:tempo:string:a tempo string:*none*:false
@param:bpm:string::*none*:true
@fontparams:
@paramdesc
- **tempo** is an arbitrary string that may contain a marker for note duration in the form "[n/d]" where 'n' and 'd' are integers.
The corresponding mark is decoded as a note duration and replaced with the corresponding note symbol. <br/>Example: "Andante [1/4] = 80"
 
See the [Tempo](@EXAMPLES/tempo/) example. <br />
See the [Lutkin](@EXAMPLES/lutkin/) example.
@paramend
 
*/
 
class ARTempo : /* public ARMTParameter, */ public ARFontAble
{
    public:
                 ARTempo();
        virtual ~ARTempo() {}
 
        virtual const char* getParamsStr() const    { return kARTempoParams; };
        virtual const char* getTagName() const      { return "ARTempo"; };
        virtual std::string getGMNName() const      { return "\\tempo"; };
 
        virtual void setTagParameters(const TagParameterMap& map);
 
        const FormatStringParserResult& getTempoMark() const { return mTempoMark; }     
    
        bool hasBpmInfos() const { return mHasBpmInfos; }
 
        bool isNoteEquiv() const { return mBpmNoteEquiv; }
 
 
        TYPE_DURATION getBpmUnit() const { return mBpmUnit; }   
 
 
        TYPE_DURATION getBpmValue() const { return mBpmValue; } 
 
        float getQpmValue() const;  
 
        virtual void browse(TimeUnwrap& mapper) const;
        virtual ARTempo *isARTempo()          { return this; }
 
    static TYPE_DURATION string2Duration (const char * str);
 
    private:
        void        ParseBpm(const char* str );
 
        FormatStringParserResult    mTempoMark;
 
        TYPE_DURATION   mBpmUnit;           // bpm="mBpmUnit=mBpmValue">
        TYPE_DURATION   mBpmValue;
        bool            mBpmNoteEquiv;  // true if bpm value is a note equivalent.
        bool            mHasBpmInfos;
};
 
 
#endif