Home    News    Components    Get ViTooKi    Documentation    Community    Developers    @sf.net  

Info

Last update:
12 Feb 2007

Documentation

Doxygen LXR

MP7Time Class Reference

This class represents an MPEG-7 time value. More...

#include <MP7Time.hpp>

List of all members.

Public Member Functions
	MP7Time ()
	Default constructor.
bool	setTimePoint (uint value, uint ticksPerSecond=1)
	Set time point from a tick value.
bool	setTimePoint (const char *mp7Value)
	Set time point from the MPEG-7 representation.
bool	setTimePoint (const MP7Time &otherTime)
	Copy time point from other MP7Time value.
bool	moveTimePoint (int value, uint ticksPerSecond)
	Move time point by the given number of ticks.
bool	setDuration (uint value, uint ticks)
	Set duration from a tick value.
bool	setDuration (const char *mp7Value)
	Set duration from the MPEG-7 representation.
bool	setDuration (const MP7Time &duration)
	Set duration from another MP7Time instance.
bool	setDurationFromEnd (const MP7Time &end)
	Set the duration according to this object's time point and the given end time point.
bool	addDuration (const MP7Time &otherTime)
	Add the duration of otherTime.
const char *	timePointPretty (bool forceSubSec=false) const
	Pretty-print time point.
const char *	durationPretty () const
	Pretty-print duration.
MP7Time	endTimePoint () const
	Return end time point (time point + duration) of this interval.
const char *	endTimePointPretty (bool forceSubSec=false) const
	Pretty-print end time point (time point + duration).
const char *	toString () const
	Pretty-print time and duration.
const char *	timePointMP7 () const
	Return MPEG-7 representation of time point.
const char *	durationMP7 () const
	Return MPEG-7 representation of duration.
double	timeToSec () const
	Return time point in seconds.
int	timeToMSec () const
	Return time point in milliseconds.
int	durationToMSec () const
	Return duration in milliseconds.
double	durationToSec () const
	Return duration in seconds.
bool	timePointIsValid () const
	Return true if the time point is valid, i.e.
bool	durationIsNull () const
	Return true if the duration is 0.
int	compareTimePoint (const MP7Time &other) const
	Compare this time point to another one.
bool	contains (const MP7Time &time) const
	Return true if this interval contains the given time point or interval.

---

Detailed Description

This class represents an MPEG-7 time value.

It may denote a time point or a time interval. Note that this class may also represent media time.

Author:

Mario Taschwer

Version:

Id

MP7Time.hpp,v 1.4 2005/01/14 12:01:19 mkropfbe Exp

Definition at line 57 of file MP7Time.hpp.

---

Constructor & Destructor Documentation

MP7Time::MP7Time (   )

Default constructor. Initializes to time point 0 with duration 0. Definition at line 53 of file MP7Time.cpp. { reset(); }

---

Member Function Documentation

bool MP7Time::addDuration (  const MP7Time &  otherTime  )

Add the duration of otherTime. This function supports non-negative durations only. If one of the operands has a negative duration, an error status is returned. Returns: true on success. Definition at line 345 of file MP7Time.cpp. References duration. { if (duration.sign < 0 || otherTime.duration.sign < 0) return false; if (otherTime.duration.num > 0) { uint newDenom = commonMultiple(duration.denom, otherTime.duration.denom); duration.num *= newDenom / duration.denom; duration.denom = newDenom; duration.num += otherTime.duration.num * newDenom / otherTime.duration.denom; if (duration.num >= duration.denom) { duration.sec++; duration.num -= duration.denom; } } duration.sec += otherTime.duration.sec; if (duration.sec >= SECS_PER_DAY) { duration.days++; duration.sec -= SECS_PER_DAY; } duration.days += otherTime.duration.days; return true; }

int MP7Time::compareTimePoint (  const MP7Time &  other  )  const

Compare this time point to another one. An invalid time point is considered to be earlier than any valid time point. Two invalid time points are considered to be equal. Note: The date part and time zone of the operands are currently ignored. Returns: -1 if this time point is earlier than other; 0 if they are equal; 1 if this time point is later than other. See also: timePointIsValid() Definition at line 734 of file MP7Time.cpp. References tpoint. Referenced by contains(), and setDurationFromEnd(). { if (!tpoint.hasTime && !other.tpoint.hasTime) return 0; if (!tpoint.hasTime) return -1; if (!other.tpoint.hasTime) return 1; if (tpoint.sec < other.tpoint.sec) return -1; if (tpoint.sec > other.tpoint.sec) return 1; uint denom = commonMultiple(tpoint.denom, other.tpoint.denom); uint thisnum = tpoint.num * (denom / tpoint.denom); uint othernum = other.tpoint.num * (denom / other.tpoint.denom); if (thisnum < othernum) return -1; if (thisnum > othernum) return 1; return 0; }

const char * MP7Time::durationMP7 (   )  const

Return MPEG-7 representation of duration. If the duration is an IncrDuration type, only the timeUnit will be returned. Returns: a pointer to a static buffer, which will be overwritten by each invocation of this method. Definition at line 597 of file MP7Time.cpp. { static char buf[MP7TIME_DURATION_BUFSIZE]; char *pos = buf; int size = MP7TIME_DURATION_BUFSIZE; int len = strlen(duration.tz); int n; const char *err_format = "MP7Time::durationMP7() static buffer too small, buf = %s\n"; bool hasTime = (duration.sec != 0 || duration.num != 0); if (duration.sign < 0) { *pos++ = '-'; size--; } *pos++ = 'P'; size--; if (duration.days) { n = snprintf(pos, size, "%uD", duration.days); if (n >= size) { dprintf_err(err_format, buf); return buf; } pos += n; size -= n; } if (hasTime) { if (size >= 2) { *pos++ = 'T'; *pos = '\0'; size--; } uint val = duration.sec / 3600; if (val) { n = snprintf(pos, size, "%uH", val); if (n >= size) { dprintf_err(err_format, buf); return buf; } pos += n; size -= n; } val = (duration.sec % 3600) / 60; if (val) { n = snprintf(pos, size, "%uM", val); if (n >= size) { dprintf_err(err_format, buf); return buf; } pos += n; size -= n; } val = duration.sec % 60; if (val) { n = snprintf(pos, size, "%uS", val); if (n >= size) { dprintf_err(err_format, buf); return buf; } pos += n; size -= n; } if (duration.num) { n = snprintf(pos, size, "%uN%uF", duration.num, duration.denom); if (n >= size) { dprintf_err(err_format, buf); return buf; } pos += n; size -= n; } } if (len > 0) { if (len+1 >= size) { dprintf_err(err_format, buf); return buf; } memcpy(pos, duration.tz, len); pos += len; *pos++ = 'Z'; } *pos = '\0'; return buf; }

const char * MP7Time::durationPretty (   )  const

Pretty-print duration. Returns: a pointer to a static buffer, which will be overwritten by each invocation of this method. Definition at line 397 of file MP7Time.cpp. Referenced by toString(). { static char buf[MP7TIME_DURATION_BUFSIZE]; char *pos = buf; int size = MP7TIME_DURATION_BUFSIZE; int n; bool hasTime = (duration.sec != 0 || duration.num != 0); if (duration.units) { n = snprintf(pos, size, "%d * [", duration.units); if (n+1 >= size) { // count also '-' added below dprintf_err("MP7Time::durationPretty() static buffer too small, buf = %s\n", buf); return buf; } pos += n; size -= n; } if (duration.sign < 0) { *pos++ = '-'; size--; } if (duration.days) { n = snprintf(pos, size, "%u days", duration.days); if (n+1 >= size) { dprintf_err("MP7Time::durationPretty() static buffer too small, buf = %s\n", buf); return buf; } pos += n; size -= n; if (hasTime || *duration.tz) { *pos++ = ' '; *pos = '\0'; size--; } } if (hasTime) { n = snprintf(pos, size, "%02u:%02u:%02u", duration.sec / 3600, (duration.sec % 3600) / 60, duration.sec % 60); if (n+3 >= size) { dprintf_err("MP7Time::durationPretty() static buffer too small, buf = %s\n", buf); return buf; } pos += n; size -= n; if (duration.num) { n = snprintf(pos, size, ".%02u", duration.num * 100 / duration.denom); pos += n; size -= n; } } if (*duration.tz) { int len = strlen(duration.tz); if (len >= size) { dprintf_err("MP7Time::durationPretty() static buffer too small, buf = %s\n", buf); return buf; } strcpy(pos, duration.tz); pos += len; size -= len; } if (duration.units) { if (size < 2) { dprintf_err("MP7Time::durationPretty() static buffer too small, buf = %s\n", buf); return buf; } *pos++ = ']'; } *pos = '\0'; return buf; }

MP7Time MP7Time::endTimePoint (   )  const

Return end time point (time point + duration) of this interval. Note: This method currently ignores the date and time-zone parts of an MP7Time instance. Definition at line 472 of file MP7Time.cpp. References tpoint. Referenced by contains(), and endTimePointPretty(). { MP7Time end; end.tpoint.hasTime = tpoint.hasTime; end.tpoint.sec = tpoint.sec; end.tpoint.num = tpoint.num; end.tpoint.denom = tpoint.denom; if (duration.num > 0) { end.tpoint.denom = commonMultiple(tpoint.denom, duration.denom); if (end.tpoint.denom != tpoint.denom) end.tpoint.num *= end.tpoint.denom / tpoint.denom; } int i = 1; int sign = duration.sign; if (duration.units > 0) { i = duration.units; } else if (duration.units < 0) { i = -duration.units; sign = -sign; } if (sign > 0) { if (duration.days) end.tpoint.sec += duration.days * SECS_PER_DAY; end.tpoint.sec += duration.sec; if (duration.num > 0) { end.tpoint.num += duration.num * end.tpoint.denom / duration.denom; end.tpoint.sec += end.tpoint.num / end.tpoint.denom; end.tpoint.num %= end.tpoint.denom; } } else { if (duration.days) end.tpoint.sec -= duration.days * SECS_PER_DAY; end.tpoint.sec -= duration.sec; if (duration.num > 0) { uint diff = duration.num * end.tpoint.denom / duration.denom; end.tpoint.sec -= diff / end.tpoint.denom; diff %= end.tpoint.denom; if (diff > end.tpoint.num) { end.tpoint.sec--; diff -= end.tpoint.denom; } end.tpoint.num -= diff; } } return end; }

const char * MP7Time::endTimePointPretty (  bool  forceSubSec = false  )  const

Pretty-print end time point (time point + duration). Note: This method currently ignores the date and time-zone parts of an MP7Time instance. Returns: a pointer to a static buffer, which will be overwritten by each invocation of this method. See also: #endtimePoint() #timePointPretty(bool) Definition at line 519 of file MP7Time.cpp. References endTimePoint(), and timePointPretty(). { return endTimePoint().timePointPretty(forceSubSec); }

bool MP7Time::moveTimePoint (  int  value, uint  ticksPerSecond )

Move time point by the given number of ticks. If the resulting time point would be negative, this time point is reset to 0 and an error status is returned. The date part and time zone of this object are ignored. Returns: true on success. Definition at line 183 of file MP7Time.cpp. { bool rval = true; uint denom = commonMultiple(tpoint.denom, ticksPerSecond); tpoint.num *= denom / tpoint.denom; value *= (int) (denom / ticksPerSecond); tpoint.denom = denom; if (value < 0) { int sec = (int) tpoint.sec; value = -value; tpoint.num += denom; tpoint.num -= value % denom; if (tpoint.num >= denom) tpoint.num -= denom; else sec--; sec -= value / denom; if (sec < 0) { rval = false; resetTimePoint(); } else tpoint.sec = (uint) sec; } else { tpoint.num += value % denom; if (tpoint.num >= denom) { tpoint.sec++; tpoint.num -= denom; } tpoint.sec += value / denom; } tpoint.hasTime = true; return rval; }

bool MP7Time::setDuration (  const MP7Time &  duration  )

Set duration from another MP7Time instance. The time point value remains unchanged. Returns: true on success. Definition at line 307 of file MP7Time.cpp. References duration. { this->duration = duration.duration; return true; }

bool MP7Time::setDuration (  const char *  mp7Value  )

Set duration from the MPEG-7 representation. Returns: true on success. Definition at line 231 of file MP7Time.cpp. References MP7TIME_TZ_LEN. { resetDuration(); const char *pos = mp7Value; /* duration sign */ if (*pos == '-') { duration.sign = -1; pos++; } if (*pos != 'P') { dprintf_err("MP7Time::setDuration(mp7Value = %s) invalid MPEG-7 duration!\n", mp7Value); resetDuration(); return false; } pos++; /* parse duration and time zone */ const char *start = pos; uint val; for (; *pos; pos++) { /* duration */ if (*pos == 'T') { start = pos + 1; } else if (*pos == 'D' || *pos == 'H' || *pos == 'M' || *pos == 'S' || *pos == 'N' || *pos == 'F') { char *tail; errno = 0; val = (uint) strtoul(start, &tail, 10); if (errno || tail != pos) { dprintf_err("MP7Time::setDuration(mp7Value = %s) integer conversion FAILED!\n", mp7Value); resetDuration(); return false; } start = pos + 1; switch (*pos) { case 'D': duration.days = val; break; case 'H': duration.sec += val * 3600; break; case 'M': duration.sec += val * 60; break; case 'S': duration.sec += val; break; case 'N': duration.num = val; break; case 'F': if (val > 0) duration.denom = val; else { dprintf_err("MP7Time::setDuration(mp7Value = %s) invalid fraction!\n", mp7Value); resetDuration(); return false; } } //switch } else if (*pos == 'Z') { // time zone difference int len = pos - start; // don't copy the 'Z' character if (len > MP7TIME_TZ_LEN) { dprintf_err("MP7Time::setDuration(mp7Value = %s) time zone string too long!\n", mp7Value); resetDuration(); return false; } memcpy(duration.tz, start, len); duration.tz[len] = '\0'; } } // for return true; }

bool MP7Time::setDuration (  uint  value, uint  ticks )

Set duration from a tick value. Returns: true on success. Definition at line 217 of file MP7Time.cpp. { resetDuration(); if (ticks == 0) { dprintf_err("MP7Time::setDuration(value = %u, ticks = %u) invalid ticks value!\n", value, ticks); return false; } duration.sec = value / ticks; duration.num = value % ticks; duration.denom = ticks; return true; }

bool MP7Time::setDurationFromEnd (  const MP7Time &  end  )

Set the duration according to this object's time point and the given end time point. Note: This function currently ignores the date part and time zone of the operands. Returns: true on success. Definition at line 313 of file MP7Time.cpp. References compareTimePoint(), duration, and tpoint. { if (!tpoint.hasTime || !end.tpoint.hasTime) return false; resetDuration(); uint denom = commonMultiple(tpoint.denom, end.tpoint.denom); duration.denom = denom; if (compareTimePoint(end) <= 0) { duration.sign = 1; duration.num = end.tpoint.num * (denom / end.tpoint.denom); duration.sec = end.tpoint.sec; uint thisnum = tpoint.num * (denom / tpoint.denom); if (thisnum > duration.num) { duration.num += denom; duration.sec--; } duration.num -= thisnum; duration.sec -= tpoint.sec; } else { MP7Time end2(end); if (!end2.setDurationFromEnd(*this)) return false; duration = end2.duration; duration.sign = -1; } if (duration.sec >= SECS_PER_DAY) { duration.days = duration.sec / SECS_PER_DAY; duration.sec %= SECS_PER_DAY; } return true; }

bool MP7Time::setTimePoint (  const MP7Time &  otherTime  )

Copy time point from other MP7Time value. The duration value is not modified. Returns: true on success. Definition at line 177 of file MP7Time.cpp. References tpoint. { tpoint = otherTime.tpoint; return true; }

bool MP7Time::setTimePoint (  const char *  mp7Value  )

Set time point from the MPEG-7 representation. Returns: true on success. Definition at line 100 of file MP7Time.cpp. References MP7TIME_DATE_LEN, and MP7TIME_TZ_LEN. { resetTimePoint(); uint val; char *pos = strchr(mp7Value, 'T'); /* date part */ if (!pos) pos = strchr(mp7Value, '\0'); if (pos > mp7Value) { int len = pos - mp7Value; if (len > MP7TIME_DATE_LEN) return false; memcpy(tpoint.date, mp7Value, len); tpoint.date[len] = '\0'; } if (*pos == '\0') return true; pos++; // advance to character after 'T' /* time zone */ char *postz = strchr(pos, '+'); if (!postz) postz = strchr(pos, '-'); if (postz) { if (strlen(postz) > MP7TIME_TZ_LEN) { resetTimePoint(); return false; } strcpy(tpoint.tz, postz); } else postz = strchr(pos, '\0'); if (pos == postz) return true; /* parse time part */ int unit = 3600; // time unit (in seconds) of next field char *num = pos; for (; pos <= postz; pos++) { if (*pos == ':' || *pos == 'F' || *pos == '+' || *pos == '-' || *pos == '\0') { char *tail; errno = 0; val = (uint) strtoul(num, &tail, 10); if (errno || tail != pos) { dprintf_err("MP7Time::setTimePoint(mp7value = %s) integer conversion FAILED!\n", mp7Value); resetTimePoint(); return false; } num = pos + 1; switch (*pos) { case ':': // fall through case '+': // fall through case '-': // fall through case '\0': if (unit) { tpoint.sec += val * unit; unit /= 60; } else { if (!val) { dprintf_err("MP7Time::setTimePoint(mp7value = %s) 0 denominator!\n", mp7Value); resetTimePoint(); return false; } tpoint.denom = val; } break; case 'F': tpoint.num = val; unit = 0; break; } // switch } // if } tpoint.hasTime = true; return true; }

bool MP7Time::setTimePoint (  uint  value, uint  ticksPerSecond = 1 )

Set time point from a tick value. Returns: true on success. See also: timePointIsValid() Definition at line 85 of file MP7Time.cpp. { resetTimePoint(); if (ticksPerSecond == 0) { dprintf_err("MP7Time::setTimePoint(value = %u, ticksPerSecond = %u) invalid ticksPerSecond value!\n", value, ticksPerSecond); return false; } tpoint.sec = value / ticksPerSecond; tpoint.num = value % ticksPerSecond; tpoint.denom = ticksPerSecond; tpoint.hasTime = true; return true; }

bool MP7Time::timePointIsValid (   )  const

Return true if the time point is valid, i.e. it has been set before. Definition at line 724 of file MP7Time.cpp. { return *tpoint.date || tpoint.hasTime; }

const char * MP7Time::timePointMP7 (   )  const

Return MPEG-7 representation of time point. Returns: a pointer to a static buffer, which will be overwritten by each invocation of this method. Definition at line 550 of file MP7Time.cpp. { static char buf[MP7TIME_TPOINT_BUFSIZE]; char *pos = buf; int size = MP7TIME_TPOINT_BUFSIZE; int len = strlen(tpoint.date); int n; if (len > 0) { strcpy(pos, tpoint.date); pos += len; size -= len; } if (tpoint.hasTime) { *pos++ = 'T'; size--; n = snprintf(pos, size, "%02u:%02u:%02u", tpoint.sec / 3600, (tpoint.sec % 3600) / 60, tpoint.sec % 60); if (n >= size) { dprintf_err("MP7Time::timePointMP7() static buffer too small, buf = %s\n", buf); return buf; } pos += n; size -= n; if (tpoint.num) { n = snprintf(pos, size, ":%uF%u", tpoint.num, tpoint.denom); if (n >= size) { dprintf_err("MP7Time::timePointMP7() static buffer too small, buf = %s\n", buf); return buf; } pos += n; size -= n; } } len = strlen(tpoint.tz); if (len > 0) { if (len >= size) { dprintf_err("MP7Time::timePointMP7() static buffer too small, buf = %s\n", buf); return buf; } strcpy(pos, tpoint.tz); } return buf; }

const char * MP7Time::timePointPretty (  bool  forceSubSec = false  )  const

Pretty-print time point. A fresh object returns 00:00:00. Output format: YYYY-MM-DD hh:mm:ss.cc[+|-]hh:mm Parameters: forceSubSec  if true, print sub-seconds digits also if they are 0. Returns: a pointer to a static buffer, which will be overwritten by each invocation of this method. Definition at line 368 of file MP7Time.cpp. Referenced by endTimePointPretty(), and toString(). { static char buf[MP7TIME_TPOINT_BUFSIZE]; int len = strlen(tpoint.date); char *pos = buf; if (len > 0) { memcpy(pos, tpoint.date, len); pos += len; if (tpoint.hasTime && *(pos-1) != '-') *pos++ = ' '; } /* avoid returning a null string for "empty" time point */ if (tpoint.hasTime || !len) { pos += sprintf(pos, "%02u:%02u:%02u", tpoint.sec / 3600, (tpoint.sec % 3600) / 60, tpoint.sec % 60); if (tpoint.num || forceSubSec) { *pos++ = '.'; pos += sprintf(pos, "%02u", tpoint.num * 100 / tpoint.denom); } } len = strlen(tpoint.tz); if (len > 0) { memcpy(pos, tpoint.tz, len); pos += len; } *pos = '\0'; return buf; }

int MP7Time::timeToMSec (   )  const

Return time point in milliseconds. The date and time zone parts of this instance are ignored. Definition at line 690 of file MP7Time.cpp. { if (!tpoint.hasTime) return 0; int msec = (int) tpoint.sec * 1000; if (tpoint.num) msec += (int) (tpoint.num * 1000 / tpoint.denom); return msec; }

double MP7Time::timeToSec (   )  const

Return time point in seconds. The date and time zone parts of this instance are ignored. Definition at line 680 of file MP7Time.cpp. { if (!tpoint.hasTime) return 0.0; double sec = (double) tpoint.sec; if (tpoint.num) sec += (double) tpoint.num / (double) tpoint.denom; return sec; }

const char * MP7Time::toString (   )  const

Pretty-print time and duration. Returns: a pointer to a static buffer, which will be overwritten by each invocation of this method. Definition at line 524 of file MP7Time.cpp. References durationPretty(), and timePointPretty(). { static char buf[MP7TIME_TPOINT_BUFSIZE + MP7TIME_DURATION_BUFSIZE + 3]; const char *tp = timePointPretty(); const char *dur = durationPretty(); int len1 = strlen(tp); int len2 = strlen(dur); char *pos = buf; if (len1 > 0) { memcpy(pos, tp, len1); pos += len1; if (len2 > 0) { *pos++ = ' '; *pos++ = '['; } } if (len2 > 0) { memcpy(pos, dur, len2); pos += len2; if (len1 > 0) *pos++ = ']'; } *pos = '\0'; return buf; }

---

The documentation for this class was generated from the following files:

• MP7Time.hpp
• MP7Time.cpp

© ViTooKi 2003 :: [Lite version] Created with Doxygen