/*
- Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
- This program is free software; you can redistribute it and/or modify
+ This file is part of DCP-o-matic.
+
+ DCP-o-matic is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
- This program is distributed in the hope that it will be useful,
+ DCP-o-matic is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
*/
+
+/** @file src/lib/dcpomatic_time.h
+ * @brief Types to describe time.
+ */
+
+
#ifndef DCPOMATIC_TIME_H
#define DCPOMATIC_TIME_H
+
+#include "frame_rate_change.h"
+#include "dcpomatic_assert.h"
+#include <boost/optional.hpp>
+#include <stdint.h>
#include <cmath>
#include <ostream>
-#include <sstream>
#include <iomanip>
-#include <stdint.h>
-#include "frame_rate_change.h"
+#include <cstdio>
+
+
+struct dcpomatic_time_ceil_test;
+struct dcpomatic_time_floor_test;
+
+
+namespace dcpomatic {
+
+
+class HMSF
+{
+public:
+ HMSF () {}
+
+ HMSF (int h_, int m_, int s_, int f_)
+ : h(h_)
+ , m(m_)
+ , s(s_)
+ , f(f_)
+ {}
-class dcpomatic_round_up_test;
+ int h = 0;
+ int m = 0;
+ int s = 0;
+ int f = 0;
+};
-class Time;
-/** A time in seconds, expressed as a number scaled up by Time::HZ. */
+/** A time in seconds, expressed as a number scaled up by Time::HZ. We want two different
+ * versions of this class, dcpomatic::ContentTime and dcpomatic::DCPTime, and we want it to be impossible to
+ * convert implicitly between the two. Hence there's this template hack. I'm not
+ * sure if it's the best way to do it.
+ *
+ * S is the name of `this' class and O is its opposite (see the typedefs below).
+ */
+template <class S, class O>
class Time
{
public:
: _t (t)
{}
- virtual ~Time () {}
-
- Type get () const {
- return _t;
- }
+ explicit Time (Type n, Type d)
+ : _t (n * HZ / d)
+ {}
- double seconds () const {
- return double (_t) / HZ;
- }
+ /* Explicit conversion from type O */
+ Time (Time<O, S> d, FrameRateChange f);
- template <typename T>
- int64_t frames (T r) const {
- return rint (_t * r / HZ);
+ /** @param hmsf Hours, minutes, seconds, frames.
+ * @param fps Frame rate
+ */
+ Time (HMSF const& hmsf, float fps) {
+ *this = from_seconds (hmsf.h * 3600)
+ + from_seconds (hmsf.m * 60)
+ + from_seconds (hmsf.s)
+ + from_frames (hmsf.f, fps);
}
- template <typename T>
- void split (T r, int& h, int& m, int& s, int& f) const
- {
- /* Do this calculation with frames so that we can round
- to a frame boundary at the start rather than the end.
- */
- int64_t ff = frames (r);
-
- h = ff / (3600 * r);
- ff -= h * 3600 * r;
- m = ff / (60 * r);
- ff -= m * 60 * r;
- s = ff / r;
- ff -= s * r;
-
- f = static_cast<int> (ff);
+ Type get () const {
+ return _t;
}
- template <typename T>
- std::string timecode (T r) const {
- int h;
- int m;
- int s;
- int f;
- split (r, h, m, s, f);
-
- std::ostringstream o;
- o.width (2);
- o.fill ('0');
- o << std::setw(2) << std::setfill('0') << h << ":"
- << std::setw(2) << std::setfill('0') << m << ":"
- << std::setw(2) << std::setfill('0') << s << ":"
- << std::setw(2) << std::setfill('0') << f;
- return o.str ();
- }
-
-protected:
- friend class dcptime_round_up_test;
-
- Type _t;
- static const int HZ = 96000;
-};
-
-class DCPTime;
-
-class ContentTime : public Time
-{
-public:
- ContentTime () : Time () {}
- explicit ContentTime (Type t) : Time (t) {}
- ContentTime (Type n, Type d) : Time (n * HZ / d) {}
- ContentTime (DCPTime d, FrameRateChange f);
-
- bool operator< (ContentTime const & o) const {
+ bool operator< (Time<S, O> const & o) const {
return _t < o._t;
}
- bool operator<= (ContentTime const & o) const {
+ bool operator<= (Time<S, O> const & o) const {
return _t <= o._t;
}
- bool operator== (ContentTime const & o) const {
+ bool operator== (Time<S, O> const & o) const {
return _t == o._t;
}
- bool operator!= (ContentTime const & o) const {
+ bool operator!= (Time<S, O> const & o) const {
return _t != o._t;
}
- bool operator>= (ContentTime const & o) const {
+ bool operator>= (Time<S, O> const & o) const {
return _t >= o._t;
}
- bool operator> (ContentTime const & o) const {
+ bool operator> (Time<S, O> const & o) const {
return _t > o._t;
}
- ContentTime operator+ (ContentTime const & o) const {
- return ContentTime (_t + o._t);
+ Time<S, O> operator+ (Time<S, O> const & o) const {
+ return Time<S, O> (_t + o._t);
}
- ContentTime & operator+= (ContentTime const & o) {
+ Time<S, O> & operator+= (Time<S, O> const & o) {
_t += o._t;
return *this;
}
- ContentTime operator- () const {
- return ContentTime (-_t);
+ Time<S, O> operator- () const {
+ return Time<S, O> (-_t);
}
- ContentTime operator- (ContentTime const & o) const {
- return ContentTime (_t - o._t);
+ Time<S, O> operator- (Time<S, O> const & o) const {
+ return Time<S, O> (_t - o._t);
}
- ContentTime & operator-= (ContentTime const & o) {
+ Time<S, O> & operator-= (Time<S, O> const & o) {
_t -= o._t;
return *this;
}
+ Time<S, O> operator/ (int o) const {
+ return Time<S, O> (_t / o);
+ }
+
/** Round up to the nearest sampling interval
* at some sampling rate.
* @param r Sampling rate.
*/
- ContentTime round_up (float r) {
- Type const n = rint (HZ / r);
- Type const a = _t + n - 1;
- return ContentTime (a - (a % n));
+ Time<S, O> ceil (double r) const {
+ return Time<S, O> (llrint(HZ * frames_ceil(r) / r));
}
- static ContentTime from_seconds (double s) {
- return ContentTime (s * HZ);
+ Time<S, O> floor (double r) const {
+ return Time<S, O> (llrint(HZ * frames_floor(r) / r));
}
- template <class T>
- static ContentTime from_frames (int64_t f, T r) {
- assert (r > 0);
- return ContentTime (f * HZ / r);
+ Time<S, O> round (double r) const {
+ return Time<S, O> (llrint(HZ * frames_round(r) / r));
}
- static ContentTime max () {
- return ContentTime (INT64_MAX);
+ double seconds () const {
+ return double (_t) / HZ;
}
-};
-std::ostream& operator<< (std::ostream& s, ContentTime t);
+ Time<S, O> abs () const {
+ return Time<S, O> (std::abs(_t));
+ }
-class ContentTimePeriod
-{
-public:
- ContentTimePeriod () {}
- ContentTimePeriod (ContentTime f, ContentTime t)
- : from (f)
- , to (t)
- {}
+ template <typename T>
+ int64_t frames_round (T r) const {
+ /* We must cast to double here otherwise if T is integer
+ the calculation will round down before we get the chance
+ to llrint().
+ */
+ return llrint (_t * double(r) / HZ);
+ }
- ContentTime from;
- ContentTime to;
+ template <typename T>
+ int64_t frames_floor (T r) const {
+ return ::floor (_t * r / HZ);
+ }
- ContentTimePeriod operator+ (ContentTime const & o) const {
- return ContentTimePeriod (from + o, to + o);
+ template <typename T>
+ int64_t frames_ceil (T r) const {
+ /* We must cast to double here otherwise if T is integer
+ the calculation will round down before we get the chance
+ to ceil().
+ */
+ return ::ceil (_t * double(r) / HZ);
}
- bool overlaps (ContentTimePeriod const & o) const;
- bool contains (ContentTime const & o) const;
-};
+ /** Split a time into hours, minutes, seconds and frames.
+ * @param r Frames per second.
+ * @return Split time.
+ */
+ template <typename T>
+ HMSF split (T r) const
+ {
+ /* Do this calculation with frames so that we can round
+ to a frame boundary at the start rather than the end.
+ */
+ auto ff = frames_round (r);
+ HMSF hmsf;
-class DCPTime : public Time
-{
-public:
- DCPTime () : Time () {}
- explicit DCPTime (Type t) : Time (t) {}
- DCPTime (ContentTime t, FrameRateChange c) : Time (rint (t.get() / c.speed_up)) {}
+ hmsf.h = ff / (3600 * r);
+ ff -= static_cast<int64_t>(hmsf.h) * 3600 * r;
+ hmsf.m = ff / (60 * r);
+ ff -= static_cast<int64_t>(hmsf.m) * 60 * r;
+ hmsf.s = ff / r;
+ ff -= static_cast<int64_t>(hmsf.s) * r;
- bool operator< (DCPTime const & o) const {
- return _t < o._t;
+ hmsf.f = static_cast<int> (ff);
+ return hmsf;
}
- bool operator<= (DCPTime const & o) const {
- return _t <= o._t;
- }
+ template <typename T>
+ std::string timecode (T r) const {
+ auto hmsf = split (r);
- bool operator== (DCPTime const & o) const {
- return _t == o._t;
+ char buffer[128];
+ snprintf (buffer, sizeof(buffer), "%02d:%02d:%02d:%02d", hmsf.h, hmsf.m, hmsf.s, hmsf.f);
+ return buffer;
}
- bool operator!= (DCPTime const & o) const {
- return _t != o._t;
+ static Time<S, O> from_seconds (double s) {
+ return Time<S, O> (llrint (s * HZ));
}
- bool operator>= (DCPTime const & o) const {
- return _t >= o._t;
+ template <class T>
+ static Time<S, O> from_frames (int64_t f, T r) {
+ DCPOMATIC_ASSERT (r > 0);
+ return Time<S, O> (f * HZ / r);
}
- bool operator> (DCPTime const & o) const {
- return _t > o._t;
+ static Time<S, O> delta () {
+ return Time<S, O> (1);
}
- DCPTime operator+ (DCPTime const & o) const {
- return DCPTime (_t + o._t);
+ static Time<S, O> min () {
+ return Time<S, O> (-INT64_MAX);
}
- DCPTime & operator+= (DCPTime const & o) {
- _t += o._t;
- return *this;
+ static Time<S, O> max () {
+ return Time<S, O> (INT64_MAX);
}
- DCPTime operator- () const {
- return DCPTime (-_t);
- }
+ static const int HZ = 96000;
- DCPTime operator- (DCPTime const & o) const {
- return DCPTime (_t - o._t);
- }
+private:
+ friend struct ::dcpomatic_time_ceil_test;
+ friend struct ::dcpomatic_time_floor_test;
- DCPTime & operator-= (DCPTime const & o) {
- _t -= o._t;
- return *this;
+ Type _t;
+};
+
+
+class ContentTimeDifferentiator {};
+class DCPTimeDifferentiator {};
+
+
+/* Specializations for the two allowed explicit conversions */
+
+template<>
+Time<ContentTimeDifferentiator, DCPTimeDifferentiator>::Time (Time<DCPTimeDifferentiator, ContentTimeDifferentiator> d, FrameRateChange f);
+
+template<>
+Time<DCPTimeDifferentiator, ContentTimeDifferentiator>::Time (Time<ContentTimeDifferentiator, DCPTimeDifferentiator> d, FrameRateChange f);
+
+
+/** Time relative to the start or position of a piece of content in its native frame rate */
+typedef Time<ContentTimeDifferentiator, DCPTimeDifferentiator> ContentTime;
+/** Time relative to the start of the output DCP in its frame rate */
+typedef Time<DCPTimeDifferentiator, ContentTimeDifferentiator> DCPTime;
+
+template <class T>
+class TimePeriod
+{
+public:
+ TimePeriod () {}
+
+ TimePeriod (T f, T t)
+ : from (f)
+ , to (t)
+ {}
+
+ /** start time of sampling interval that the period is from */
+ T from;
+ /** start time of next sampling interval after the period */
+ T to;
+
+ T duration () const {
+ return to - from;
}
- /** Round up to the nearest sampling interval
- * at some sampling rate.
- * @param r Sampling rate.
- */
- DCPTime round_up (float r) {
- Type const n = rint (HZ / r);
- Type const a = _t + n - 1;
- return DCPTime (a - (a % n));
+ TimePeriod<T> operator+ (T const & o) const {
+ return TimePeriod<T> (from + o, to + o);
}
- DCPTime abs () const {
- return DCPTime (std::abs (_t));
+ boost::optional<TimePeriod<T>> overlap (TimePeriod<T> const & other) const {
+ T const max_from = std::max (from, other.from);
+ T const min_to = std::min (to, other.to);
+
+ if (max_from >= min_to) {
+ return {};
+ }
+
+ return TimePeriod<T> (max_from, min_to);
}
- static DCPTime from_seconds (double s) {
- return DCPTime (s * HZ);
+ bool contains (T const & other) const {
+ return (from <= other && other < to);
}
- template <class T>
- static DCPTime from_frames (int64_t f, T r) {
- assert (r > 0);
- return DCPTime (f * HZ / r);
+ bool operator< (TimePeriod<T> const & o) const {
+ if (from != o.from) {
+ return from < o.from;
+ }
+ return to < o.to;
}
- static DCPTime delta () {
- return DCPTime (1);
+ bool operator== (TimePeriod<T> const & other) const {
+ return from == other.from && to == other.to;
}
- static DCPTime max () {
- return DCPTime (INT64_MAX);
+ bool operator!= (TimePeriod<T> const & other) const {
+ return !(*this == other);
}
};
+
+/** @param A Period which is subtracted from.
+ * @param B Periods to subtract from `A', must be in ascending order of start time and must not overlap.
+ */
+template <class T>
+std::list<TimePeriod<T>> subtract (TimePeriod<T> A, std::list<TimePeriod<T>> const & B)
+{
+ std::list<TimePeriod<T>> result;
+ result.push_back (A);
+
+ for (auto i: B) {
+ std::list<TimePeriod<T>> new_result;
+ for (auto j: result) {
+ auto ov = i.overlap (j);
+ if (ov) {
+ if (*ov == i) {
+ /* A contains all of B */
+ if (i.from != j.from) {
+ new_result.push_back (TimePeriod<T>(j.from, i.from));
+ }
+ if (i.to != j.to) {
+ new_result.push_back (TimePeriod<T>(i.to, j.to));
+ }
+ } else if (*ov == j) {
+ /* B contains all of A */
+ } else if (i.from < j.from) {
+ /* B overlaps start of A */
+ new_result.push_back (TimePeriod<T>(i.to, j.to));
+ } else if (i.to > j.to) {
+ /* B overlaps end of A */
+ new_result.push_back (TimePeriod<T>(j.from, i.from));
+ }
+ } else {
+ new_result.push_back (j);
+ }
+ }
+ result = new_result;
+ }
+
+ return result;
+}
+
+
+typedef TimePeriod<ContentTime> ContentTimePeriod;
+typedef TimePeriod<DCPTime> DCPTimePeriod;
+
+
DCPTime min (DCPTime a, DCPTime b);
-std::ostream& operator<< (std::ostream& s, DCPTime t);
+DCPTime max (DCPTime a, DCPTime b);
+ContentTime min (ContentTime a, ContentTime b);
+ContentTime max (ContentTime a, ContentTime b);
+std::string to_string (ContentTime t);
+std::string to_string (DCPTime t);
+std::string to_string (DCPTimePeriod p);
+
+
+}
+
#endif
projects / dcpomatic.git / blobdiff