1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
6 An API for audio analysis and feature extraction plugins.
8 Centre for Digital Music, Queen Mary, University of London.
9 Copyright 2006 Chris Cannam.
11 Permission is hereby granted, free of charge, to any person
12 obtaining a copy of this software and associated documentation
13 files (the "Software"), to deal in the Software without
14 restriction, including without limitation the rights to use, copy,
15 modify, merge, publish, distribute, sublicense, and/or sell copies
16 of the Software, and to permit persons to whom the Software is
17 furnished to do so, subject to the following conditions:
19 The above copyright notice and this permission notice shall be
20 included in all copies or substantial portions of the Software.
22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
30 Except as contained in this notice, the names of the Centre for
31 Digital Music; Queen Mary, University of London; and Chris Cannam
32 shall not be used in advertising or otherwise to promote the sale,
33 use or other dealings in this Software without prior written
38 This is a modified version of a source file from the
39 Rosegarden MIDI and audio sequencer and notation editor.
40 This file copyright 2000-2006 Chris Cannam.
41 Relicensed by the author as detailed above.
44 #ifndef _VAMP_REAL_TIME_H_
45 #define _VAMP_REAL_TIME_H_
57 * \class RealTime RealTime.h <vamp-sdk/RealTime.h>
59 * RealTime represents time values to nanosecond precision
60 * with accurate arithmetic and frame-rate conversion functions.
68 int usec() const { return nsec / 1000; }
69 int msec() const { return nsec / 1000000; }
71 RealTime(): sec(0), nsec(0) {}
72 RealTime(int s, int n);
74 RealTime(const RealTime &r) :
75 sec(r.sec), nsec(r.nsec) { }
77 static RealTime fromSeconds(double sec);
78 static RealTime fromMilliseconds(int msec);
81 static RealTime fromTimeval(const struct timeval &);
84 RealTime &operator=(const RealTime &r) {
85 sec = r.sec; nsec = r.nsec; return *this;
88 RealTime operator+(const RealTime &r) const {
89 return RealTime(sec + r.sec, nsec + r.nsec);
91 RealTime operator-(const RealTime &r) const {
92 return RealTime(sec - r.sec, nsec - r.nsec);
94 RealTime operator-() const {
95 return RealTime(-sec, -nsec);
98 bool operator <(const RealTime &r) const {
99 if (sec == r.sec) return nsec < r.nsec;
100 else return sec < r.sec;
103 bool operator >(const RealTime &r) const {
104 if (sec == r.sec) return nsec > r.nsec;
105 else return sec > r.sec;
108 bool operator==(const RealTime &r) const {
109 return (sec == r.sec && nsec == r.nsec);
112 bool operator!=(const RealTime &r) const {
113 return !(r == *this);
116 bool operator>=(const RealTime &r) const {
117 if (sec == r.sec) return nsec >= r.nsec;
118 else return sec >= r.sec;
121 bool operator<=(const RealTime &r) const {
122 if (sec == r.sec) return nsec <= r.nsec;
123 else return sec <= r.sec;
126 RealTime operator/(int d) const;
128 // Find the fractional difference between times
130 double operator/(const RealTime &r) const;
132 // Return a human-readable debug-type string to full precision
133 // (probably not a format to show to a user directly)
135 std::string toString() const;
137 // Return a user-readable string to the nearest millisecond
138 // in a form like HH:MM:SS.mmm
140 std::string toText(bool fixedDp = false) const;
142 // Convenience functions for handling sample frames
144 static long realTime2Frame(const RealTime &r, unsigned int sampleRate);
145 static RealTime frame2RealTime(long frame, unsigned int sampleRate);
147 static const RealTime zeroTime;
150 std::ostream &operator<<(std::ostream &out, const RealTime &rt);