Chris@1: Chris@1: Chris@1: Chris@1: Chris@3: Chris@6: Chris@6: Chris@1: VampPluginSDK: Vamp::RealTime Class Reference Chris@1: Chris@6: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1:
Chris@1:
VampPluginSDK Chris@6:  2.7 Chris@1:
Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Public Member Functions | Chris@1: Static Public Member Functions | Chris@1: Public Attributes | Chris@6: Static Public Attributes | Chris@6: List of all members
Chris@1:
Chris@1:
Vamp::RealTime Class Reference
Chris@3:
Chris@1:
Chris@3: Chris@1:

RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions. Chris@1: More...

Chris@1: Chris@1:

#include <vamp-sdk/RealTime.h>

Chris@1: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:

Chris@1: Public Member Functions

int usec () const
 
int msec () const
 
 RealTime ()
 
 RealTime (int s, int n)
 
 RealTime (const RealTime &r)
 
RealTime & operator= (const RealTime &r)
 
RealTime operator+ (const RealTime &r) const
 
RealTime operator- (const RealTime &r) const
 
RealTime operator- () const
 
bool operator< (const RealTime &r) const
 
bool operator> (const RealTime &r) const
 
bool operator== (const RealTime &r) const
 
bool operator!= (const RealTime &r) const
 
bool operator>= (const RealTime &r) const
 
bool operator<= (const RealTime &r) const
 
RealTime operator/ (int d) const
 
double operator/ (const RealTime &r) const
 Return the ratio of two times. More...
 
std::string toString () const
 Return a human-readable debug-type string to full precision (probably not a format to show to a user directly) More...
 
std::string toText (bool fixedDp=false) const
 Return a user-readable string to the nearest millisecond in a form like HH:MM:SS.mmm. More...
 
Chris@6: Chris@3: Chris@6: Chris@6: Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@6:

Chris@1: Static Public Member Functions

static RealTime fromSeconds (double sec)
 
static RealTime fromMilliseconds (int msec)
 
static RealTime fromTimeval (const struct timeval &)
 
static long realTime2Frame (const RealTime &r, unsigned int sampleRate)
 Convert a RealTime into a sample frame at the given sample rate. More...
 
static RealTime frame2RealTime (long frame, unsigned int sampleRate)
 Convert a sample frame at the given sample rate into a RealTime. More...
 
Chris@6: Chris@3: Chris@6: Chris@3: Chris@6: Chris@6:

Chris@1: Public Attributes

int sec
 
int nsec
 
Chris@6: Chris@3: Chris@6: Chris@1:

Chris@1: Static Public Attributes

static const RealTime zeroTime
 
Chris@6:

Detailed Description

Chris@1:

RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions.

Chris@1: Chris@6:

Definition at line 66 of file vamp-sdk/RealTime.h.

Chris@6:

Constructor & Destructor Documentation

Chris@6: Chris@6:

◆ RealTime() [1/3]

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Vamp::RealTime::RealTime ()
Chris@6: 		Chris@6: inline
Chris@6:
Chris@6: Chris@6:

Definition at line 74 of file vamp-sdk/RealTime.h.

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6:

◆ RealTime() [2/3]

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Vamp::RealTime::RealTime (int s,
int n 
)
Chris@6:
Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ RealTime() [3/3]

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
Vamp::RealTime::RealTime (const RealTime & r)
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 77 of file vamp-sdk/RealTime.h.

Chris@1: Chris@1:
Chris@1:
Chris@6:

Member Function Documentation

Chris@6: Chris@6:

◆ usec()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
int Vamp::RealTime::usec () const
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 71 of file vamp-sdk/RealTime.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ msec()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
int Vamp::RealTime::msec () const
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 72 of file vamp-sdk/RealTime.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ fromSeconds()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
static RealTime Vamp::RealTime::fromSeconds (double sec)
Chris@6: 		Chris@6: static
Chris@6:
Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ fromMilliseconds()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
static RealTime Vamp::RealTime::fromMilliseconds (int msec)
Chris@6: 		Chris@6: static
Chris@6:
Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ fromTimeval()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
static RealTime Vamp::RealTime::fromTimeval (const struct timeval & )
Chris@6: 		Chris@6: static
Chris@6:
Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator=()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
RealTime& Vamp::RealTime::operator= (const RealTime & r)
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 87 of file vamp-sdk/RealTime.h.

Chris@1: Chris@6:

References nsec, and sec.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator+()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
RealTime Vamp::RealTime::operator+ (const RealTime & r) const
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 91 of file vamp-sdk/RealTime.h.

Chris@1: Chris@6:

References nsec, and sec.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator-() [1/2]

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
RealTime Vamp::RealTime::operator- (const RealTime & r) const
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 94 of file vamp-sdk/RealTime.h.

Chris@1: Chris@6:

References nsec, and sec.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator-() [2/2]

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
RealTime Vamp::RealTime::operator- () const
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 97 of file vamp-sdk/RealTime.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator<()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
bool Vamp::RealTime::operator< (const RealTime & r) const
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 101 of file vamp-sdk/RealTime.h.

Chris@1: Chris@6:

References nsec, and sec.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator>()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
bool Vamp::RealTime::operator> (const RealTime & r) const
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 106 of file vamp-sdk/RealTime.h.

Chris@1: Chris@6:

References nsec, and sec.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator==()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
bool Vamp::RealTime::operator== (const RealTime & r) const
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 111 of file vamp-sdk/RealTime.h.

Chris@1: Chris@6:

References nsec, and sec.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator!=()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
bool Vamp::RealTime::operator!= (const RealTime & r) const
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 115 of file vamp-sdk/RealTime.h.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator>=()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
bool Vamp::RealTime::operator>= (const RealTime & r) const
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 119 of file vamp-sdk/RealTime.h.

Chris@1: Chris@6:

References nsec, and sec.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator<=()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
bool Vamp::RealTime::operator<= (const RealTime & r) const
Chris@6: 		Chris@6: inline
Chris@6:
Chris@1: Chris@6:

Definition at line 124 of file vamp-sdk/RealTime.h.

Chris@1: Chris@6:

References nsec, and sec.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator/() [1/2]

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
RealTime Vamp::RealTime::operator/ (int d) const
Chris@6:
Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ operator/() [2/2]

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
double Vamp::RealTime::operator/ (const RealTime & r) const
Chris@6:
Chris@1: Chris@1:

Return the ratio of two times.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ toString()

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
std::string Vamp::RealTime::toString () const
Chris@6:
Chris@1: Chris@1:

Return a human-readable debug-type string to full precision (probably not a format to show to a user directly)

Chris@1: Chris@6:

Referenced by printFeatures().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ toText()

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
std::string Vamp::RealTime::toText (bool fixedDp = false) const
Chris@6:
Chris@1: Chris@1:

Return a user-readable string to the nearest millisecond in a form like HH:MM:SS.mmm.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ realTime2Frame()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
static long Vamp::RealTime::realTime2Frame (const RealTime & r,
unsigned int sampleRate 
)
Chris@6: 		Chris@6: static
Chris@6:
Chris@1: Chris@1:

Convert a RealTime into a sample frame at the given sample rate.

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ frame2RealTime()

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
static RealTime Vamp::RealTime::frame2RealTime (long frame,
unsigned int sampleRate 
)
Chris@6: 		Chris@6: static
Chris@6:
Chris@1: Chris@1:

Convert a sample frame at the given sample rate into a RealTime.

Chris@1: Chris@6:

Referenced by ZeroCrossing::process(), and PercussionOnsetDetector::process().

Chris@1: Chris@1:
Chris@1:
Chris@6:

Member Data Documentation

Chris@6: Chris@6:

◆ sec

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
int Vamp::RealTime::sec
Chris@6:
Chris@1: Chris@6:

Definition at line 68 of file vamp-sdk/RealTime.h.

Chris@1: Chris@6:

Referenced by operator+(), operator-(), operator<(), operator<=(), operator=(), operator==(), operator>(), operator>=(), and toSeconds().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ nsec

Chris@6: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
int Vamp::RealTime::nsec
Chris@6:
Chris@1: Chris@6:

Definition at line 69 of file vamp-sdk/RealTime.h.

Chris@1: Chris@6:

Referenced by operator+(), operator-(), operator<(), operator<=(), operator=(), operator==(), operator>(), operator>=(), and toSeconds().

Chris@1: Chris@1:
Chris@1:
Chris@6: Chris@6:

◆ zeroTime

Chris@6: Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1: Chris@1: Chris@6: Chris@1: Chris@1:
const RealTime Vamp::RealTime::zeroTime
Chris@6: 		Chris@6: static
Chris@6:
Chris@1: Chris@6:

Definition at line 158 of file vamp-sdk/RealTime.h.

Chris@1: Chris@1:
Chris@1:
Chris@1:
The documentation for this class was generated from the following file: Chris@3:
Chris@6:
Chris@6: Chris@6: Chris@1: Chris@1: