VampPluginSDK: RealTime.h Source File

00001 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@0: 00002 
cannam@0: 00003 /*
cannam@0: 00004     Vamp
cannam@0: 00005 
cannam@0: 00006     An API for audio analysis and feature extraction plugins.
cannam@0: 00007 
cannam@0: 00008     Centre for Digital Music, Queen Mary, University of London.
cannam@0: 00009     Copyright 2006 Chris Cannam.
cannam@0: 00010   
cannam@0: 00011     Permission is hereby granted, free of charge, to any person
cannam@0: 00012     obtaining a copy of this software and associated documentation
cannam@0: 00013     files (the "Software"), to deal in the Software without
cannam@0: 00014     restriction, including without limitation the rights to use, copy,
cannam@0: 00015     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@0: 00016     of the Software, and to permit persons to whom the Software is
cannam@0: 00017     furnished to do so, subject to the following conditions:
cannam@0: 00018 
cannam@0: 00019     The above copyright notice and this permission notice shall be
cannam@0: 00020     included in all copies or substantial portions of the Software.
cannam@0: 00021 
cannam@0: 00022     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@0: 00023     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@0: 00024     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@0: 00025     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@0: 00026     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@0: 00027     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@0: 00028     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@0: 00029 
cannam@0: 00030     Except as contained in this notice, the names of the Centre for
cannam@0: 00031     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@0: 00032     shall not be used in advertising or otherwise to promote the sale,
cannam@0: 00033     use or other dealings in this Software without prior written
cannam@0: 00034     authorization.
cannam@0: 00035 */
cannam@0: 00036 
cannam@0: 00037 /*
cannam@0: 00038    This is a modified version of a source file from the 
cannam@0: 00039    Rosegarden MIDI and audio sequencer and notation editor.
cannam@0: 00040    This file copyright 2000-2006 Chris Cannam.
cannam@0: 00041    Relicensed by the author as detailed above.
cannam@0: 00042 */
cannam@0: 00043 
cannam@0: 00044 #ifndef _VAMP_REAL_TIME_H_
cannam@0: 00045 #define _VAMP_REAL_TIME_H_
cannam@0: 00046 
cannam@0: 00047 #include <iostream>
cannam@0: 00048 #include <string>
cannam@0: 00049 
cannam@0: 00050 #ifndef _WIN32
cannam@0: 00051 struct timeval;
cannam@0: 00052 #endif
cannam@0: 00053 
cannam@0: 00054 namespace Vamp {
cannam@0: 00055 
cannam@0: 00063 struct RealTime
cannam@0: 00064 {
cannam@0: 00065     int sec;
cannam@0: 00066     int nsec;
cannam@0: 00067 
cannam@0: 00068     int usec() const { return nsec / 1000; }
cannam@0: 00069     int msec() const { return nsec / 1000000; }
cannam@0: 00070 
cannam@0: 00071     RealTime(): sec(0), nsec(0) {}
cannam@0: 00072     RealTime(int s, int n);
cannam@0: 00073 
cannam@0: 00074     RealTime(const RealTime &r) :
cannam@0: 00075         sec(r.sec), nsec(r.nsec) { }
cannam@0: 00076 
cannam@0: 00077     static RealTime fromSeconds(double sec);
cannam@0: 00078     static RealTime fromMilliseconds(int msec);
cannam@0: 00079 
cannam@0: 00080 #ifndef _WIN32
cannam@0: 00081     static RealTime fromTimeval(const struct timeval &);
cannam@0: 00082 #endif
cannam@0: 00083 
cannam@0: 00084     RealTime &operator=(const RealTime &r) {
cannam@0: 00085         sec = r.sec; nsec = r.nsec; return *this;
cannam@0: 00086     }
cannam@0: 00087 
cannam@0: 00088     RealTime operator+(const RealTime &r) const {
cannam@0: 00089         return RealTime(sec + r.sec, nsec + r.nsec);
cannam@0: 00090     }
cannam@0: 00091     RealTime operator-(const RealTime &r) const {
cannam@0: 00092         return RealTime(sec - r.sec, nsec - r.nsec);
cannam@0: 00093     }
cannam@0: 00094     RealTime operator-() const {
cannam@0: 00095         return RealTime(-sec, -nsec);
cannam@0: 00096     }
cannam@0: 00097 
cannam@0: 00098     bool operator <(const RealTime &r) const {
cannam@0: 00099         if (sec == r.sec) return nsec < r.nsec;
cannam@0: 00100         else return sec < r.sec;
cannam@0: 00101     }
cannam@0: 00102 
cannam@0: 00103     bool operator >(const RealTime &r) const {
cannam@0: 00104         if (sec == r.sec) return nsec > r.nsec;
cannam@0: 00105         else return sec > r.sec;
cannam@0: 00106     }
cannam@0: 00107 
cannam@0: 00108     bool operator==(const RealTime &r) const {
cannam@0: 00109         return (sec == r.sec && nsec == r.nsec);
cannam@0: 00110     }
cannam@0: 00111  
cannam@0: 00112     bool operator!=(const RealTime &r) const {
cannam@0: 00113         return !(r == *this);
cannam@0: 00114     }
cannam@0: 00115  
cannam@0: 00116     bool operator>=(const RealTime &r) const {
cannam@0: 00117         if (sec == r.sec) return nsec >= r.nsec;
cannam@0: 00118         else return sec >= r.sec;
cannam@0: 00119     }
cannam@0: 00120 
cannam@0: 00121     bool operator<=(const RealTime &r) const {
cannam@0: 00122         if (sec == r.sec) return nsec <= r.nsec;
cannam@0: 00123         else return sec <= r.sec;
cannam@0: 00124     }
cannam@0: 00125 
cannam@0: 00126     RealTime operator/(int d) const;
cannam@0: 00127 
cannam@0: 00131     double operator/(const RealTime &r) const;
cannam@0: 00132 
cannam@0: 00137     std::string toString() const;
cannam@0: 00138 
cannam@0: 00143     std::string toText(bool fixedDp = false) const;
cannam@0: 00144 
cannam@0: 00148     static long realTime2Frame(const RealTime &r, unsigned int sampleRate);
cannam@0: 00149 
cannam@0: 00153     static RealTime frame2RealTime(long frame, unsigned int sampleRate);
cannam@0: 00154 
cannam@0: 00155     static const RealTime zeroTime;
cannam@0: 00156 };
cannam@0: 00157 
cannam@0: 00158 std::ostream &operator<<(std::ostream &out, const RealTime &rt);
cannam@0: 00159 
cannam@0: 00160 }
cannam@0: 00161     
cannam@0: 00162 #endif
cannam@0: