cannam@99: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@99: 
cannam@99: /*
cannam@99:     Vamp
cannam@99: 
cannam@99:     An API for audio analysis and feature extraction plugins.
cannam@99: 
cannam@99:     Centre for Digital Music, Queen Mary, University of London.
cannam@99:     Copyright 2006 Chris Cannam.
cannam@99:   
cannam@99:     Permission is hereby granted, free of charge, to any person
cannam@99:     obtaining a copy of this software and associated documentation
cannam@99:     files (the "Software"), to deal in the Software without
cannam@99:     restriction, including without limitation the rights to use, copy,
cannam@99:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@99:     of the Software, and to permit persons to whom the Software is
cannam@99:     furnished to do so, subject to the following conditions:
cannam@99: 
cannam@99:     The above copyright notice and this permission notice shall be
cannam@99:     included in all copies or substantial portions of the Software.
cannam@99: 
cannam@99:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@99:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@99:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@99:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@99:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@99:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@99:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@99: 
cannam@99:     Except as contained in this notice, the names of the Centre for
cannam@99:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@99:     shall not be used in advertising or otherwise to promote the sale,
cannam@99:     use or other dealings in this Software without prior written
cannam@99:     authorization.
cannam@99: */
cannam@99: 
cannam@99: /*
cannam@99:    This is a modified version of a source file from the 
cannam@99:    Rosegarden MIDI and audio sequencer and notation editor.
cannam@99:    This file copyright 2000-2006 Chris Cannam.
cannam@99:    Relicensed by the author as detailed above.
cannam@99: */
cannam@99: 
cannam@99: #ifndef _VAMP_REAL_TIME_H_
cannam@99: #define _VAMP_REAL_TIME_H_
cannam@99: 
cannam@99: #include <iostream>
cannam@99: #include <string>
cannam@99: 
cannam@99: #ifndef _WIN32
cannam@99: struct timeval;
cannam@99: #endif
cannam@99: 
cannam@99: #include "plugguard.h"
cannam@99: _VAMP_SDK_PLUGSPACE_BEGIN(RealTime.h)
cannam@99: 
cannam@99: namespace Vamp {
cannam@99: 
cannam@99: /**
cannam@99:  * \class RealTime RealTime.h <vamp-sdk/RealTime.h>
cannam@99:  * 
cannam@99:  * RealTime represents time values to nanosecond precision
cannam@99:  * with accurate arithmetic and frame-rate conversion functions.
cannam@99:  */
cannam@99: 
cannam@99: struct RealTime
cannam@99: {
cannam@99:     int sec;
cannam@99:     int nsec;
cannam@99: 
cannam@99:     int usec() const { return nsec / 1000; }
cannam@99:     int msec() const { return nsec / 1000000; }
cannam@99: 
cannam@99:     RealTime(): sec(0), nsec(0) {}
cannam@99:     RealTime(int s, int n);
cannam@99: 
cannam@99:     RealTime(const RealTime &r) :
cannam@99: 	sec(r.sec), nsec(r.nsec) { }
cannam@99: 
cannam@99:     static RealTime fromSeconds(double sec);
cannam@99:     static RealTime fromMilliseconds(int msec);
cannam@99: 
cannam@99: #ifndef _WIN32
cannam@99:     static RealTime fromTimeval(const struct timeval &);
cannam@99: #endif
cannam@99: 
cannam@99:     RealTime &operator=(const RealTime &r) {
cannam@99: 	sec = r.sec; nsec = r.nsec; return *this;
cannam@99:     }
cannam@99: 
cannam@99:     RealTime operator+(const RealTime &r) const {
cannam@99: 	return RealTime(sec + r.sec, nsec + r.nsec);
cannam@99:     }
cannam@99:     RealTime operator-(const RealTime &r) const {
cannam@99: 	return RealTime(sec - r.sec, nsec - r.nsec);
cannam@99:     }
cannam@99:     RealTime operator-() const {
cannam@99: 	return RealTime(-sec, -nsec);
cannam@99:     }
cannam@99: 
cannam@99:     bool operator <(const RealTime &r) const {
cannam@99: 	if (sec == r.sec) return nsec < r.nsec;
cannam@99: 	else return sec < r.sec;
cannam@99:     }
cannam@99: 
cannam@99:     bool operator >(const RealTime &r) const {
cannam@99: 	if (sec == r.sec) return nsec > r.nsec;
cannam@99: 	else return sec > r.sec;
cannam@99:     }
cannam@99: 
cannam@99:     bool operator==(const RealTime &r) const {
cannam@99:         return (sec == r.sec && nsec == r.nsec);
cannam@99:     }
cannam@99:  
cannam@99:     bool operator!=(const RealTime &r) const {
cannam@99:         return !(r == *this);
cannam@99:     }
cannam@99:  
cannam@99:     bool operator>=(const RealTime &r) const {
cannam@99:         if (sec == r.sec) return nsec >= r.nsec;
cannam@99:         else return sec >= r.sec;
cannam@99:     }
cannam@99: 
cannam@99:     bool operator<=(const RealTime &r) const {
cannam@99:         if (sec == r.sec) return nsec <= r.nsec;
cannam@99:         else return sec <= r.sec;
cannam@99:     }
cannam@99: 
cannam@99:     RealTime operator/(int d) const;
cannam@99: 
cannam@99:     /**
cannam@99:      * Return the ratio of two times.
cannam@99:      */
cannam@99:     double operator/(const RealTime &r) const;
cannam@99: 
cannam@99:     /**
cannam@99:      * Return a human-readable debug-type string to full precision
cannam@99:      * (probably not a format to show to a user directly)
cannam@99:      */ 
cannam@99:     std::string toString() const;
cannam@99: 
cannam@99:     /**
cannam@99:      * Return a user-readable string to the nearest millisecond
cannam@99:      * in a form like HH:MM:SS.mmm
cannam@99:      */
cannam@99:     std::string toText(bool fixedDp = false) const;
cannam@99: 
cannam@99:     /**
cannam@99:      * Convert a RealTime into a sample frame at the given sample rate.
cannam@99:      */
cannam@99:     static long realTime2Frame(const RealTime &r, unsigned int sampleRate);
cannam@99: 
cannam@99:     /**
cannam@99:      * Convert a sample frame at the given sample rate into a RealTime.
cannam@99:      */
cannam@99:     static RealTime frame2RealTime(long frame, unsigned int sampleRate);
cannam@99: 
cannam@99:     static const RealTime zeroTime;
cannam@99: };
cannam@99: 
cannam@99: std::ostream &operator<<(std::ostream &out, const RealTime &rt);
cannam@99: 
cannam@99: }
cannam@99: 
cannam@99: _VAMP_SDK_PLUGSPACE_END(RealTime.h)
cannam@99:     
cannam@99: #endif