annotate vamp-sdk/RealTime.h @ 270:06cfedd040c7

...
author cannam
date Wed, 26 Nov 2008 13:54:17 +0000
parents 521734d2b498
children
rev   line source
cannam@3 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
cannam@3 2
cannam@3 3 /*
cannam@3 4 Vamp
cannam@3 5
cannam@3 6 An API for audio analysis and feature extraction plugins.
cannam@3 7
cannam@3 8 Centre for Digital Music, Queen Mary, University of London.
cannam@3 9 Copyright 2006 Chris Cannam.
cannam@3 10
cannam@3 11 Permission is hereby granted, free of charge, to any person
cannam@3 12 obtaining a copy of this software and associated documentation
cannam@3 13 files (the "Software"), to deal in the Software without
cannam@3 14 restriction, including without limitation the rights to use, copy,
cannam@3 15 modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@3 16 of the Software, and to permit persons to whom the Software is
cannam@3 17 furnished to do so, subject to the following conditions:
cannam@3 18
cannam@3 19 The above copyright notice and this permission notice shall be
cannam@3 20 included in all copies or substantial portions of the Software.
cannam@3 21
cannam@3 22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@3 23 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@3 24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@6 25 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@3 26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@3 27 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@3 28 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@3 29
cannam@3 30 Except as contained in this notice, the names of the Centre for
cannam@3 31 Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@3 32 shall not be used in advertising or otherwise to promote the sale,
cannam@3 33 use or other dealings in this Software without prior written
cannam@3 34 authorization.
cannam@3 35 */
cannam@3 36
cannam@3 37 /*
cannam@3 38 This is a modified version of a source file from the
cannam@3 39 Rosegarden MIDI and audio sequencer and notation editor.
cannam@10 40 This file copyright 2000-2006 Chris Cannam.
cannam@10 41 Relicensed by the author as detailed above.
cannam@3 42 */
cannam@3 43
cannam@5 44 #ifndef _VAMP_REAL_TIME_H_
cannam@5 45 #define _VAMP_REAL_TIME_H_
cannam@3 46
cannam@3 47 #include <iostream>
cannam@3 48 #include <string>
cannam@3 49
cannam@80 50 #ifndef _WIN32
cannam@3 51 struct timeval;
cannam@80 52 #endif
cannam@3 53
cannam@230 54 #include "plugguard.h"
cannam@233 55 _VAMP_SDK_PLUGSPACE_BEGIN(RealTime.h)
cannam@230 56
cannam@3 57 namespace Vamp {
cannam@3 58
cannam@3 59 /**
cannam@76 60 * \class RealTime RealTime.h <vamp-sdk/RealTime.h>
cannam@76 61 *
cannam@3 62 * RealTime represents time values to nanosecond precision
cannam@3 63 * with accurate arithmetic and frame-rate conversion functions.
cannam@3 64 */
cannam@3 65
cannam@3 66 struct RealTime
cannam@3 67 {
cannam@3 68 int sec;
cannam@3 69 int nsec;
cannam@3 70
cannam@3 71 int usec() const { return nsec / 1000; }
cannam@3 72 int msec() const { return nsec / 1000000; }
cannam@3 73
cannam@3 74 RealTime(): sec(0), nsec(0) {}
cannam@3 75 RealTime(int s, int n);
cannam@3 76
cannam@3 77 RealTime(const RealTime &r) :
cannam@3 78 sec(r.sec), nsec(r.nsec) { }
cannam@3 79
cannam@3 80 static RealTime fromSeconds(double sec);
cannam@3 81 static RealTime fromMilliseconds(int msec);
cannam@80 82
cannam@80 83 #ifndef _WIN32
cannam@3 84 static RealTime fromTimeval(const struct timeval &);
cannam@80 85 #endif
cannam@3 86
cannam@3 87 RealTime &operator=(const RealTime &r) {
cannam@3 88 sec = r.sec; nsec = r.nsec; return *this;
cannam@3 89 }
cannam@3 90
cannam@3 91 RealTime operator+(const RealTime &r) const {
cannam@3 92 return RealTime(sec + r.sec, nsec + r.nsec);
cannam@3 93 }
cannam@3 94 RealTime operator-(const RealTime &r) const {
cannam@3 95 return RealTime(sec - r.sec, nsec - r.nsec);
cannam@3 96 }
cannam@3 97 RealTime operator-() const {
cannam@3 98 return RealTime(-sec, -nsec);
cannam@3 99 }
cannam@3 100
cannam@3 101 bool operator <(const RealTime &r) const {
cannam@3 102 if (sec == r.sec) return nsec < r.nsec;
cannam@3 103 else return sec < r.sec;
cannam@3 104 }
cannam@3 105
cannam@3 106 bool operator >(const RealTime &r) const {
cannam@3 107 if (sec == r.sec) return nsec > r.nsec;
cannam@3 108 else return sec > r.sec;
cannam@3 109 }
cannam@3 110
cannam@3 111 bool operator==(const RealTime &r) const {
cannam@3 112 return (sec == r.sec && nsec == r.nsec);
cannam@3 113 }
cannam@3 114
cannam@3 115 bool operator!=(const RealTime &r) const {
cannam@3 116 return !(r == *this);
cannam@3 117 }
cannam@3 118
cannam@3 119 bool operator>=(const RealTime &r) const {
cannam@3 120 if (sec == r.sec) return nsec >= r.nsec;
cannam@3 121 else return sec >= r.sec;
cannam@3 122 }
cannam@3 123
cannam@3 124 bool operator<=(const RealTime &r) const {
cannam@3 125 if (sec == r.sec) return nsec <= r.nsec;
cannam@3 126 else return sec <= r.sec;
cannam@3 127 }
cannam@3 128
cannam@3 129 RealTime operator/(int d) const;
cannam@3 130
cannam@99 131 /**
cannam@99 132 * Return the ratio of two times.
cannam@99 133 */
cannam@3 134 double operator/(const RealTime &r) const;
cannam@3 135
cannam@99 136 /**
cannam@99 137 * Return a human-readable debug-type string to full precision
cannam@99 138 * (probably not a format to show to a user directly)
cannam@99 139 */
cannam@3 140 std::string toString() const;
cannam@3 141
cannam@99 142 /**
cannam@99 143 * Return a user-readable string to the nearest millisecond
cannam@99 144 * in a form like HH:MM:SS.mmm
cannam@99 145 */
cannam@3 146 std::string toText(bool fixedDp = false) const;
cannam@3 147
cannam@99 148 /**
cannam@99 149 * Convert a RealTime into a sample frame at the given sample rate.
cannam@99 150 */
cannam@3 151 static long realTime2Frame(const RealTime &r, unsigned int sampleRate);
cannam@99 152
cannam@99 153 /**
cannam@99 154 * Convert a sample frame at the given sample rate into a RealTime.
cannam@99 155 */
cannam@3 156 static RealTime frame2RealTime(long frame, unsigned int sampleRate);
cannam@3 157
cannam@3 158 static const RealTime zeroTime;
cannam@3 159 };
cannam@3 160
cannam@3 161 std::ostream &operator<<(std::ostream &out, const RealTime &rt);
cannam@3 162
cannam@3 163 }
cannam@230 164
cannam@233 165 _VAMP_SDK_PLUGSPACE_END(RealTime.h)
cannam@3 166
cannam@3 167 #endif