cannam@50: cannam@50: cannam@50: cannam@50: cannam@0: VampPluginSDK: Vamp::RealTime Class Reference cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50: cannam@50: cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50:
VampPluginSDK cannam@50:  2.1 cannam@50:
cannam@50: cannam@50:
cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50:
cannam@50: cannam@50:
cannam@0:
cannam@0:
cannam@50: cannam@50:
cannam@50:
cannam@50:
cannam@50: Public Member Functions | cannam@50: Static Public Member Functions | cannam@50: Public Attributes | cannam@50: Static Public Attributes
cannam@50:
cannam@50:
Vamp::RealTime Class Reference
cannam@50:
cannam@0:
cannam@50: cannam@50:

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

cannam@0: cannam@50:

#include <vamp-sdk/RealTime.h>

cannam@0: cannam@50:

List of all members.

cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:

cannam@50: 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.
std::string toString () const
 Return a human-readable debug-type string to full precision (probably not a format to show to a user directly)
std::string toText (bool fixedDp=false) const
 Return a user-readable string to the nearest millisecond in a form like HH:MM:SS.mmm.

cannam@50: 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.
static RealTime frame2RealTime (long frame, unsigned int sampleRate)
 Convert a sample frame at the given sample rate into a RealTime.

cannam@50: Public Attributes

int sec
int nsec

cannam@50: Static Public Attributes

static const RealTime zeroTime
cannam@50:

Detailed Description

cannam@50:

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

cannam@0: cannam@50:

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

cannam@50:

Constructor & Destructor Documentation

cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@21: cannam@0: cannam@0:
Vamp::RealTime::RealTime () [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@0: cannam@0: cannam@0: cannam@0: cannam@50: cannam@50: cannam@0: cannam@0: cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
Vamp::RealTime::RealTime (int s,
int n 
)
cannam@0:
cannam@0:
cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
Vamp::RealTime::RealTime (const RealTime & r) [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@50:
cannam@50:

Member Function Documentation

cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@21: cannam@0: cannam@0:
int Vamp::RealTime::usec () const [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@21: cannam@0: cannam@0:
int Vamp::RealTime::msec () const [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
static RealTime Vamp::RealTime::fromSeconds (double sec) [static]
cannam@0:
cannam@0:
cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
static RealTime Vamp::RealTime::fromMilliseconds (int msec) [static]
cannam@0:
cannam@0:
cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
static RealTime Vamp::RealTime::fromTimeval (const struct timeval & ) [static]
cannam@0:
cannam@0:
cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
RealTime& Vamp::RealTime::operator= (const RealTime & r) [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

References nsec, and sec.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
RealTime Vamp::RealTime::operator+ (const RealTime & r) const [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

References nsec, and sec.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
RealTime Vamp::RealTime::operator- (const RealTime & r) const [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

References nsec, and sec.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@21: cannam@0: cannam@0:
RealTime Vamp::RealTime::operator- () const [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
bool Vamp::RealTime::operator< (const RealTime & r) const [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

References nsec, and sec.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
bool Vamp::RealTime::operator> (const RealTime & r) const [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

References nsec, and sec.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
bool Vamp::RealTime::operator== (const RealTime & r) const [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

References nsec, and sec.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
bool Vamp::RealTime::operator!= (const RealTime & r) const [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
bool Vamp::RealTime::operator>= (const RealTime & r) const [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

References nsec, and sec.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
bool Vamp::RealTime::operator<= (const RealTime & r) const [inline]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

References nsec, and sec.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
RealTime Vamp::RealTime::operator/ (int d) const
cannam@0:
cannam@0:
cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
double Vamp::RealTime::operator/ (const RealTime & r) const
cannam@0:
cannam@0:
cannam@0: cannam@50:

Return the ratio of two times.

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@21: cannam@0: cannam@0:
std::string Vamp::RealTime::toString () const
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

Referenced by printFeatures().

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@21: cannam@0: cannam@0:
std::string Vamp::RealTime::toText (bool fixedDp = false) const
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@0: cannam@0: cannam@0: cannam@0: cannam@50: cannam@50: cannam@0: cannam@0: cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
static long Vamp::RealTime::realTime2Frame (const RealTime & r,
unsigned int sampleRate 
) [static]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@50: cannam@50: cannam@0: cannam@0: cannam@0: cannam@0: cannam@50: cannam@50: cannam@0: cannam@0: cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
static RealTime Vamp::RealTime::frame2RealTime (long frame,
unsigned int sampleRate 
) [static]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@50:
cannam@50:

Member Data Documentation

cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
int Vamp::RealTime::sec
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
int Vamp::RealTime::nsec
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@50:
cannam@50: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@50: cannam@0: cannam@0:
const RealTime Vamp::RealTime::zeroTime [static]
cannam@0:
cannam@0:
cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@0:
cannam@50:
The documentation for this class was generated from the following file: cannam@50:
cannam@50:
cannam@50: cannam@50: cannam@50: cannam@0: cannam@0: