cannam@0: cannam@0: cannam@0: VampPluginSDK: Vamp::RealTime Class Reference cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
cannam@0:

Vamp::RealTime Class Reference

#include <vamp-sdk/RealTime.h> cannam@0:

cannam@0: cannam@0:

cannam@0: List of all members.

Detailed Description

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

Definition at line 63 of file RealTime.h.

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

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.

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.

Public Attributes

int sec
int nsec

Static Public Attributes

static const RealTime zeroTime
cannam@0:

Constructor & Destructor Documentation

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

cannam@0: cannam@0:

Definition at line 71 of file RealTime.h.

cannam@0: cannam@0:

Referenced by fromMilliseconds(), fromSeconds(), fromTimeval(), operator+(), operator-(), and operator/().

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

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
Vamp::RealTime::RealTime (int  s,
int  n 
)
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: cannam@0:

Definition at line 75 of file RealTime.cpp.

cannam@0: cannam@0:

References nsec, ONE_BILLION, and sec.

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

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
Vamp::RealTime::RealTime (const RealTime &  r  )  [inline]
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: cannam@0:

Definition at line 74 of file RealTime.h.

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

cannam@0:

Member Function Documentation

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

cannam@0: cannam@0:

Definition at line 68 of file RealTime.h.

cannam@0: cannam@0:

References nsec.

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 69 of file RealTime.h.

cannam@0: cannam@0:

References nsec.

cannam@0: cannam@0:

Referenced by toText().

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

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
RealTime Vamp::RealTime::fromSeconds (double  sec  )  [static]
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: cannam@0:

Definition at line 91 of file RealTime.cpp.

cannam@0: cannam@0:

References ONE_BILLION, and RealTime().

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

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
RealTime Vamp::RealTime::fromMilliseconds (int  msec  )  [static]
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: cannam@0:

Definition at line 97 of file RealTime.cpp.

cannam@0: cannam@0:

References RealTime().

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

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
RealTime Vamp::RealTime::fromTimeval (const struct timeval &  tv  )  [static]
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: cannam@0:

Definition at line 104 of file RealTime.cpp.

cannam@0: cannam@0:

References RealTime().

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 84 of file RealTime.h.

cannam@0: cannam@0:

References nsec, and sec.

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 88 of file RealTime.h.

cannam@0: cannam@0:

References nsec, RealTime(), and sec.

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 91 of file RealTime.h.

cannam@0: cannam@0:

References nsec, RealTime(), and sec.

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 94 of file RealTime.h.

cannam@0: cannam@0:

References nsec, RealTime(), and sec.

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 98 of file RealTime.h.

cannam@0: cannam@0:

References nsec, and sec.

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 103 of file RealTime.h.

cannam@0: cannam@0:

References nsec, and sec.

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 108 of file RealTime.h.

cannam@0: cannam@0:

References nsec, and sec.

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 112 of file RealTime.h.

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 116 of file RealTime.h.

cannam@0: cannam@0:

References nsec, and sec.

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 121 of file RealTime.h.

cannam@0: cannam@0:

References nsec, and sec.

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

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
RealTime Vamp::RealTime::operator/ (int  d  )  const
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: cannam@0:

Definition at line 203 of file RealTime.cpp.

cannam@0: cannam@0:

References nsec, ONE_BILLION, RealTime(), and sec.

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

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
double Vamp::RealTime::operator/ (const RealTime &  r  )  const
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Return the ratio of two times. cannam@0:

cannam@0: cannam@0:

Definition at line 214 of file RealTime.cpp.

cannam@0: cannam@0:

References nsec, ONE_BILLION, and sec.

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

cannam@0: cannam@0:

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

cannam@0: Return a human-readable debug-type string to full precision (probably not a format to show to a user directly). cannam@0:

cannam@0: cannam@0:

Definition at line 135 of file RealTime.cpp.

cannam@0: cannam@0:

References stringstream.

cannam@0: cannam@0:

Referenced by printFeatures().

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

cannam@0: cannam@0:

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

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

cannam@0: cannam@0:

Definition at line 151 of file RealTime.cpp.

cannam@0: cannam@0:

References msec(), sec, stringstream, and zeroTime.

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

cannam@0: cannam@0:

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

cannam@0: Convert a RealTime into a sample frame at the given sample rate. cannam@0:

cannam@0: cannam@0:

Definition at line 224 of file RealTime.cpp.

cannam@0: cannam@0:

References nsec, sec, and zeroTime.

cannam@0: cannam@0:

Referenced by Vamp::HostExt::PluginBufferingAdapter::Impl::process().

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

cannam@0: cannam@0:

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

cannam@0: Convert a sample frame at the given sample rate into a RealTime. cannam@0:

cannam@0: cannam@0:

Definition at line 232 of file RealTime.cpp.

cannam@0: cannam@0:

References nsec, and sec.

cannam@0: cannam@0:

Referenced by ZeroCrossing::process(), Vamp::HostExt::PluginInputDomainAdapter::Impl::process(), PercussionOnsetDetector::process(), and Vamp::HostExt::PluginBufferingAdapter::Impl::processBlock().

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

cannam@0:

Member Data Documentation

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

cannam@0: cannam@0:

Definition at line 65 of file RealTime.h.

cannam@0: cannam@0:

Referenced by frame2RealTime(), operator+(), operator-(), operator/(), operator<(), Vamp::operator<<(), operator<=(), operator=(), operator==(), operator>(), operator>=(), Vamp::PluginHostAdapter::process(), RealTime(), realTime2Frame(), and toText().

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 66 of file RealTime.h.

cannam@0: cannam@0:

Referenced by frame2RealTime(), msec(), operator+(), operator-(), operator/(), operator<(), Vamp::operator<<(), operator<=(), operator=(), operator==(), operator>(), operator>=(), Vamp::PluginHostAdapter::process(), RealTime(), realTime2Frame(), and usec().

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

cannam@0: cannam@0:

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

cannam@0: cannam@0:

Definition at line 155 of file RealTime.h.

cannam@0: cannam@0:

Referenced by Vamp::operator<<(), realTime2Frame(), and toText().

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

cannam@0:

The documentation for this class was generated from the following files: cannam@0:
cannam@0:
Generated on Wed Jul 9 11:36:10 2008 for VampPluginSDK by  cannam@0: cannam@0: doxygen 1.5.5
cannam@0: cannam@0: