Simple pass-through of <Ruby> tags in subtitles.
[libdcp.git] / test / dcp_time_test.cc
1 /*
2     Copyright (C) 2013-2019 Carl Hetherington <cth@carlh.net>
3
4     This file is part of libdcp.
5
6     libdcp is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     libdcp is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
18
19     In addition, as a special exception, the copyright holders give
20     permission to link the code of portions of this program with the
21     OpenSSL library under certain conditions as described in each
22     individual source file, and distribute linked combinations
23     including the two.
24
25     You must obey the GNU General Public License in all respects
26     for all of the code used other than OpenSSL.  If you modify
27     file(s) with this exception, you may extend this exception to your
28     version of the file(s), but you are not obligated to do so.  If you
29     do not wish to do so, delete this exception statement from your
30     version.  If you delete this exception statement from all source
31     files in the program, then also delete it here.
32 */
33
34 #include <boost/test/unit_test.hpp>
35 #include "dcp_time.h"
36 #include "exceptions.h"
37
38 using boost::optional;
39
40 /** Check that dcp::Time works */
41 BOOST_AUTO_TEST_CASE (dcp_time)
42 {
43         /* tcr of 250 makes the editable event length the same as an Interop `tick' */
44         dcp::Time t (977143, 24, 250);
45
46         BOOST_CHECK_EQUAL (t.e, 73);
47         BOOST_CHECK_EQUAL (t.s, 34);
48         BOOST_CHECK_EQUAL (t.m, 18);
49         BOOST_CHECK_EQUAL (t.h, 11);
50         BOOST_CHECK_EQUAL (t.as_string(dcp::Standard::INTEROP), "11:18:34:073");
51
52         /* Use a tcr of 24 so that the editable event is a frame */
53         dcp::Time a (3, 2, 3, 4, 24);
54         dcp::Time b (2, 3, 4, 5, 24);
55
56         dcp::Time r = a - b;
57         BOOST_CHECK_EQUAL (r.h, 0);
58         BOOST_CHECK_EQUAL (r.m, 58);
59         BOOST_CHECK_EQUAL (r.s, 58);
60         BOOST_CHECK_EQUAL (r.e, 23);
61         BOOST_CHECK_EQUAL (r.as_string(dcp::Standard::INTEROP), "00:58:58:023");
62
63         /* Different tcr (25) */
64         a = dcp::Time (1, 58, 56, 2, 25);
65         b = dcp::Time (1, 7, 12, 1, 25);
66         r = a + b;
67         BOOST_CHECK_EQUAL (r.h, 3);
68         BOOST_CHECK_EQUAL (r.m, 6);
69         BOOST_CHECK_EQUAL (r.s, 8);
70         BOOST_CHECK_EQUAL (r.e, 3);
71         BOOST_CHECK_EQUAL (r.as_string(dcp::Standard::INTEROP), "03:06:08:003");
72         BOOST_CHECK_EQUAL (r.as_string(dcp::Standard::SMPTE), "03:06:08:03");
73
74         /* Another arbitrary tcr (30) */
75         a = dcp::Time (24, 12, 6, 3, 30);
76         b = dcp::Time (16, 8, 4, 2, 30);
77         BOOST_CHECK_CLOSE (a / b, 1.5, 1e-5);
78
79         a = dcp::Time (3600 * 24, 24, 250);
80         BOOST_CHECK_EQUAL (a.h, 1);
81         BOOST_CHECK_EQUAL (a.m, 0);
82         BOOST_CHECK_EQUAL (a.s, 0);
83         BOOST_CHECK_EQUAL (a.e, 0);
84
85         a = dcp::Time (60 * 24, 24, 250);
86         BOOST_CHECK_EQUAL (a.h, 0);
87         BOOST_CHECK_EQUAL (a.m, 1);
88         BOOST_CHECK_EQUAL (a.s, 0);
89         BOOST_CHECK_EQUAL (a.e, 0);
90
91         /* Check rounding; 3424 is 142.666666666... seconds or 0.166666666... ticks */
92         a = dcp::Time (3424, 24, 250);
93         BOOST_CHECK_EQUAL (a.h, 0);
94         BOOST_CHECK_EQUAL (a.m, 2);
95         BOOST_CHECK_EQUAL (a.s, 22);
96         BOOST_CHECK_EQUAL (a.e, 167);
97
98         a = dcp::Time (3425, 24, 250);
99         BOOST_CHECK_EQUAL (a.h, 0);
100         BOOST_CHECK_EQUAL (a.m, 2);
101         BOOST_CHECK_EQUAL (a.s, 22);
102         BOOST_CHECK_EQUAL (a.e, 177);
103
104         /* Check addition of times with different tcrs */
105         a = dcp::Time (0, 0, 0, 3, 24);
106         b = dcp::Time (0, 0, 0, 4, 48);
107         r = a + b;
108         BOOST_CHECK_EQUAL (r, dcp::Time (0, 0, 0, 240, 1152));
109
110         /* Check rounding on conversion from seconds */
111         BOOST_CHECK_EQUAL (dcp::Time (80.990, 1000), dcp::Time (0, 1, 20, 990, 1000));
112
113         /* Check rebase */
114         a = dcp::Time (1, 58, 56, 2, 25);
115         BOOST_CHECK_EQUAL (a.rebase(250), dcp::Time(1, 58, 56, 20, 250));
116         b = dcp::Time (9, 12, 41, 17, 99);
117         BOOST_CHECK_EQUAL (b.rebase(250), dcp::Time(9, 12, 41, 43, 250));
118         a = dcp::Time (0, 2, 57, 999, 1000);
119         BOOST_CHECK_EQUAL (a.rebase(250), dcp::Time(0, 2, 58, 0, 250));
120         a = dcp::Time (0, 47, 9, 998, 1000);
121         BOOST_CHECK_EQUAL (a.rebase(250), dcp::Time(0, 47, 10, 0, 250));
122
123         /* Check some allowed constructions from string */
124
125         /* Interop type 1 */
126         a = dcp::Time ("01:23:45:123", optional<int>());
127         BOOST_CHECK_EQUAL (a, dcp::Time (1, 23, 45, 123, 250));
128         /* Interop type 2 */
129         a = dcp::Time ("01:23:45.123", optional<int>());
130         BOOST_CHECK_EQUAL (a, dcp::Time (1, 23, 45, 123, 1000));
131         /* SMPTE */
132         a = dcp::Time ("01:23:45:12", 250);
133         BOOST_CHECK_EQUAL (a, dcp::Time (1, 23, 45, 12, 250));
134
135         /* Check some disallowed constructions from string */
136         BOOST_CHECK_THROW (dcp::Time ("01:23:45:1234", optional<int>()), dcp::ReadError);
137         BOOST_CHECK_THROW (dcp::Time ("01:23:45:1234:66", optional<int>()), dcp::ReadError);
138         BOOST_CHECK_THROW (dcp::Time ("01:23:45:", optional<int>()), dcp::ReadError);
139         BOOST_CHECK_THROW (dcp::Time ("01:23::123", optional<int>()), dcp::ReadError);
140         BOOST_CHECK_THROW (dcp::Time ("01::45:123", optional<int>()), dcp::ReadError);
141         BOOST_CHECK_THROW (dcp::Time (":23:45:123", optional<int>()), dcp::ReadError);
142         BOOST_CHECK_THROW (dcp::Time ("01:23:45.1234", optional<int>()), dcp::ReadError);
143         BOOST_CHECK_THROW (dcp::Time ("01:23:45.1234.66", optional<int>()), dcp::ReadError);
144         BOOST_CHECK_THROW (dcp::Time ("01:23:45.", optional<int>()), dcp::ReadError);
145         BOOST_CHECK_THROW (dcp::Time ("01:23:.123", optional<int>()), dcp::ReadError);
146         BOOST_CHECK_THROW (dcp::Time ("01::45.123", optional<int>()), dcp::ReadError);
147         BOOST_CHECK_THROW (dcp::Time (":23:45.123", optional<int>()), dcp::ReadError);
148         BOOST_CHECK_THROW (dcp::Time ("01:23:45:123", 250), dcp::ReadError);
149         BOOST_CHECK_THROW (dcp::Time ("01:23:45:123:66", 250), dcp::ReadError);
150         BOOST_CHECK_THROW (dcp::Time ("01:23:45:", 250), dcp::ReadError);
151         BOOST_CHECK_THROW (dcp::Time ("01:23::123", 250), dcp::ReadError);
152         BOOST_CHECK_THROW (dcp::Time ("01::45:123", 250), dcp::ReadError);
153         BOOST_CHECK_THROW (dcp::Time (":23:45:123", 250), dcp::ReadError);
154
155         /* Check operator< and operator> */
156         BOOST_CHECK (dcp::Time (3, 2, 3, 4, 24) < dcp::Time (3, 2, 3, 5, 24));
157         BOOST_CHECK (!(dcp::Time (3, 2, 3, 4, 24) < dcp::Time (3, 2, 3, 4, 24)));
158         BOOST_CHECK (dcp::Time (3, 2, 3, 5, 24) > dcp::Time (3, 2, 3, 4, 24));
159         BOOST_CHECK (!(dcp::Time (3, 2, 3, 4, 24) > dcp::Time (3, 2, 3, 4, 24)));
160         BOOST_CHECK (dcp::Time (6, 0, 0, 0, 24) < dcp::Time (7, 0, 0, 0, 24));
161         BOOST_CHECK (dcp::Time (0, 6, 0, 0, 24) < dcp::Time (0, 7, 0, 0, 24));
162         BOOST_CHECK (dcp::Time (0, 0, 6, 0, 24) < dcp::Time (0, 0, 7, 0, 24));
163         BOOST_CHECK (dcp::Time (0, 0, 0, 6, 24) < dcp::Time (0, 0, 0, 7, 24));
164         BOOST_CHECK (dcp::Time (7, 0, 0, 0, 24) > dcp::Time (6, 0, 0, 0, 24));
165         BOOST_CHECK (dcp::Time (0, 7, 0, 0, 24) > dcp::Time (0, 6, 0, 0, 24));
166         BOOST_CHECK (dcp::Time (0, 0, 7, 0, 24) > dcp::Time (0, 0, 6, 0, 24));
167         BOOST_CHECK (dcp::Time (0, 0, 0, 7, 24) > dcp::Time (0, 0, 0, 6, 24));
168 }