MuseScore/libmscore/pos.h
luz.paz f31624d746 fix various typos
* Found via `codespell -q 3 -S ./share/locale,./thirdparty -L ba,cann,clas,dur,foto,iff,nd,ois,ot,pres,possibile,snaped,strack,tage,te,uint,thru,valu`  
* Some revisions made per feedback given during review.
* Follow-up typos for review  
* Add revisions per feedback
2019-12-19 06:13:30 -05:00

139 lines
4.2 KiB
C++

//=============================================================================
// AL
// Audio Utility Library
//
// Copyright (C) 2002-2009 by Werner Schweer and others
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 2.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
//=============================================================================
#ifndef __POS_H__
#define __POS_H__
#include "sig.h"
namespace Ms {
class TempoMap;
class TimeSigMap;
class XmlWriter;
class XmlReader;
enum class TType : char { TICKS, FRAMES };
//---------------------------------------------------------
// Pos
// depending on type _tick or _frame is a cached
// value. When the tempomap changes, all cached values
// are invalid. Sn is used to check for tempomap
// changes.
//---------------------------------------------------------
class Pos {
TType _type;
bool _valid;
mutable int sn;
mutable unsigned _tick;
mutable unsigned _frame;
protected:
TempoMap* tempo;
TimeSigMap* sig;
public:
Pos();
Pos(TempoMap*, TimeSigMap*);
Pos(TempoMap*, TimeSigMap*, int measure, int beat, int tick);
Pos(TempoMap*, TimeSigMap*, int minute, int sec, int frame, int subframe);
Pos(TempoMap*, TimeSigMap*, unsigned, TType type = TType::TICKS);
Pos(TempoMap*, TimeSigMap*, const QString&);
void setContext(TempoMap* t, TimeSigMap* s) { tempo = t; sig = s; }
void dump(int n = 0) const;
unsigned time(TType t) const { return t == TType::TICKS ? tick() : frame(); }
void mbt(int* measure, int* beat, int* tick) const;
void msf(int* minute, int* sec, int* frame, int* subframe) const;
SigEvent timesig() const;
void snap(int);
void upSnap(int);
void downSnap(int);
Pos snapped(int) const;
Pos upSnapped(int) const;
Pos downSnapped(int) const;
void invalidSn() { sn = -1; }
TType type() const { return _type; }
void setType(TType t);
Pos& operator+=(const Pos& a);
Pos& operator+=(int a);
Pos& operator-=(const Pos& a);
Pos& operator-=(int a);
bool operator>=(const Pos& s) const;
bool operator>(const Pos& s) const;
bool operator<(const Pos& s) const;
bool operator<=(const Pos& s) const;
bool operator==(const Pos& s) const;
bool operator!=(const Pos& s) const;
friend Pos operator+(const Pos& a, const Pos& b);
friend Pos operator-(const Pos& a, const Pos& b);
friend Pos operator+(const Pos& a, int b);
friend Pos operator-(const Pos& a, int b);
unsigned tick() const;
unsigned frame() const;
void setTick(unsigned);
void setFrame(unsigned);
void write(XmlWriter&, const char*) const;
void read(XmlReader&);
bool valid() const { return _valid && tempo && sig; }
void setInvalid() { _valid = false; }
};
//---------------------------------------------------------
// PosLen
//---------------------------------------------------------
class PosLen : public Pos {
mutable unsigned _lenTick;
mutable unsigned _lenFrame;
mutable int sn;
public:
PosLen(TempoMap*, TimeSigMap*);
PosLen(const PosLen&);
void dump(int n = 0) const;
void write(XmlWriter&, const char*) const;
void read(XmlReader&);
void setLenTick(unsigned);
void setLenFrame(unsigned);
unsigned lenTick() const;
unsigned lenFrame() const;
Pos end() const;
unsigned endTick() const { return end().tick(); }
unsigned endFrame() const { return end().frame(); }
void setPos(const Pos&);
bool operator==(const PosLen& s) const;
};
} // namespace Ms
#endif