*/
+/** @file src/dcp_time.h
+ * @brief A representation of time within a DCP.
+ */
+
#ifndef LIBDCP_TIME_H
#define LIBDCP_TIME_H
namespace libdcp {
+/** @class Time
+ * @brief A representation of time within a DCP.
+ */
+
class Time
{
public:
- Time () : h (0), m (0), s (0), ms (0) {}
- Time (int h_, int m_, int s_, int ms_)
+ Time () : h (0), m (0), s (0), t (0) {}
+
+ /** Construct a Time from a frame index (starting from 0)
+ * and a frames per second count.
+ */
+ Time (int frame, int frames_per_second);
+
+ Time (int h_, int m_, int s_, int t_)
: h (h_)
, m (m_)
, s (s_)
- , ms (ms_)
+ , t (t_)
{}
- int h;
- int m;
- int s;
- int ms;
+ int h; ///< hours
+ int m; ///< minutes
+ int s; ///< seconds
+ int t; ///< `ticks', where 1 tick is 4 milliseconds
};
extern bool operator== (Time const & a, Time const & b);