2 Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include "subrip_reader.h"
24 #include <boost/test/unit_test.hpp>
25 #include <boost/filesystem.hpp>
36 /* Test reading of a Subrip file */
37 BOOST_AUTO_TEST_CASE (subrip_reader_test)
39 FILE* f = fopen ("test/data/test.srt", "r");
40 sub::SubripReader reader (f);
42 list<sub::Subtitle> subs = sub::collect<std::list<sub::Subtitle> > (reader.subtitles ());
44 list<sub::Subtitle>::iterator i = subs.begin ();
49 BOOST_CHECK (i != subs.end ());
50 BOOST_CHECK_EQUAL (i->from, sub::Time::from_hms (0, 0, 41, 90));
51 BOOST_CHECK_EQUAL (i->to, sub::Time::from_hms (0, 0, 42, 210));
53 list<sub::Line>::iterator j = i->lines.begin ();
54 BOOST_CHECK (j != i->lines.end ());
55 BOOST_CHECK_EQUAL (j->blocks.size(), 1);
56 sub::Block b = j->blocks.front ();
57 BOOST_CHECK_EQUAL (b.text, "This is a subtitle");
58 /* No font is specified by subrip, so none should be seen here */
59 BOOST_CHECK (!b.font);
60 BOOST_CHECK (!b.font_size.specified());
61 BOOST_CHECK_EQUAL (b.bold, false);
62 BOOST_CHECK_EQUAL (b.italic, false);
63 BOOST_CHECK_EQUAL (b.underline, false);
64 BOOST_CHECK_EQUAL (j->vertical_position.line.get(), 0);
65 BOOST_CHECK_EQUAL (j->vertical_position.reference.get(), sub::TOP_OF_SUBTITLE);
68 BOOST_CHECK (j != i->lines.end ());
69 BOOST_CHECK_EQUAL (j->blocks.size(), 1);
70 b = j->blocks.front ();
71 BOOST_CHECK_EQUAL (b.text, "and that's a line break");
72 /* No font is specified by subrip, so none should be seen here */
73 BOOST_CHECK (!b.font);
74 BOOST_CHECK (!b.font_size.specified());
75 BOOST_CHECK_EQUAL (b.bold, false);
76 BOOST_CHECK_EQUAL (b.italic, false);
77 BOOST_CHECK_EQUAL (b.underline, false);
78 BOOST_CHECK_EQUAL (j->vertical_position.line.get(), 1);
79 BOOST_CHECK_EQUAL (j->vertical_position.reference.get(), sub::TOP_OF_SUBTITLE);
85 BOOST_CHECK (i != subs.end ());
86 BOOST_CHECK_EQUAL (i->from, sub::Time::from_hms (0, 1, 1, 10));
87 BOOST_CHECK_EQUAL (i->to, sub::Time::from_hms (0, 1, 2, 100));
89 BOOST_CHECK_EQUAL (i->lines.size(), 1);
90 sub::Line l = i->lines.front ();
91 BOOST_CHECK_EQUAL (l.blocks.size(), 7);
92 BOOST_CHECK_EQUAL (l.vertical_position.line.get(), 0);
93 BOOST_CHECK_EQUAL (l.vertical_position.reference.get(), sub::TOP_OF_SUBTITLE);
95 list<sub::Block>::iterator k = l.blocks.begin ();
97 BOOST_CHECK (k != l.blocks.end ());
98 BOOST_CHECK_EQUAL (k->text, "This is some ");
99 /* No font is specified by subrip, so none should be seen here */
100 BOOST_CHECK (!b.font);
101 BOOST_CHECK (!b.font_size.specified());
102 BOOST_CHECK_EQUAL (k->bold, false);
103 BOOST_CHECK_EQUAL (k->italic, false);
104 BOOST_CHECK_EQUAL (k->underline, false);
107 BOOST_CHECK (k != l.blocks.end ());
108 BOOST_CHECK_EQUAL (k->text, "bold");
109 /* No font is specified by subrip, so none should be seen here */
110 BOOST_CHECK (!b.font);
111 BOOST_CHECK (!b.font_size.specified());
112 BOOST_CHECK_EQUAL (k->bold, true);
113 BOOST_CHECK_EQUAL (k->italic, false);
114 BOOST_CHECK_EQUAL (k->underline, false);
117 BOOST_CHECK (k != l.blocks.end ());
118 BOOST_CHECK_EQUAL (k->text, " and some ");
119 /* No font is specified by subrip, so none should be seen here */
120 BOOST_CHECK (!b.font);
121 BOOST_CHECK (!b.font_size.specified());
122 BOOST_CHECK_EQUAL (k->bold, false);
123 BOOST_CHECK_EQUAL (k->italic, false);
124 BOOST_CHECK_EQUAL (k->underline, false);
127 BOOST_CHECK (k != l.blocks.end ());
128 BOOST_CHECK_EQUAL (k->text, "bold italic");
129 /* No font is specified by subrip, so none should be seen here */
130 BOOST_CHECK (!b.font);
131 BOOST_CHECK (!b.font_size.specified());
132 BOOST_CHECK_EQUAL (k->bold, true);
133 BOOST_CHECK_EQUAL (k->italic, true);
134 BOOST_CHECK_EQUAL (k->underline, false);
137 BOOST_CHECK (k != l.blocks.end ());
138 BOOST_CHECK_EQUAL (k->text, " and some ");
139 /* No font is specified by subrip, so none should be seen here */
140 BOOST_CHECK (!b.font);
141 BOOST_CHECK (!b.font_size.specified());
142 BOOST_CHECK_EQUAL (k->bold, false);
143 BOOST_CHECK_EQUAL (k->italic, false);
144 BOOST_CHECK_EQUAL (k->underline, false);
147 BOOST_CHECK (k != l.blocks.end ());
148 BOOST_CHECK_EQUAL (k->text, "underlined");
149 /* No font is specified by subrip, so none should be seen here */
150 BOOST_CHECK (!b.font);
151 BOOST_CHECK (!b.font_size.specified());
152 BOOST_CHECK_EQUAL (k->bold, false);
153 BOOST_CHECK_EQUAL (k->italic, false);
154 BOOST_CHECK_EQUAL (k->underline, true);
157 BOOST_CHECK (k != l.blocks.end ());
158 BOOST_CHECK_EQUAL (k->text, ".");
159 /* No font is specified by subrip, so none should be seen here */
160 BOOST_CHECK (!b.font);
161 BOOST_CHECK (!b.font_size.specified());
162 BOOST_CHECK_EQUAL (k->bold, false);
163 BOOST_CHECK_EQUAL (k->italic, false);
164 BOOST_CHECK_EQUAL (k->underline, false);
167 BOOST_CHECK (k == l.blocks.end ());
170 /* Test reading of another Subrip file */
171 BOOST_AUTO_TEST_CASE (subrip_reader_test2)
173 FILE* f = fopen ("test/data/test2.srt", "r");
174 sub::SubripReader reader (f);
176 list<sub::Subtitle> subs = sub::collect<list<sub::Subtitle> > (reader.subtitles ());
178 list<sub::Subtitle>::const_iterator i = subs.begin();
180 BOOST_CHECK (i != subs.end ());
181 BOOST_CHECK_EQUAL (i->from, sub::Time::from_hms (0, 1, 49, 200));
182 BOOST_CHECK_EQUAL (i->to, sub::Time::from_hms (0, 1, 52, 351));
183 BOOST_CHECK_EQUAL (i->lines.size(), 2);
184 BOOST_CHECK_EQUAL (i->lines.front().blocks.front().text, "This is a subtitle, and it goes ");
185 BOOST_CHECK_EQUAL (i->lines.back().blocks.front().text, "over two lines.");
188 BOOST_CHECK (i != subs.end ());
189 BOOST_CHECK_EQUAL (i->from, sub::Time::from_hms (0, 1, 52, 440));
190 BOOST_CHECK_EQUAL (i->to, sub::Time::from_hms (0, 1, 54, 351));
191 BOOST_CHECK_EQUAL (i->lines.size(), 1);
192 BOOST_CHECK_EQUAL (i->lines.front().blocks.front().text, "We have emboldened this");
193 BOOST_CHECK_EQUAL (i->lines.front().blocks.front().bold, true);
196 BOOST_CHECK (i != subs.end ());
197 BOOST_CHECK_EQUAL (i->from, sub::Time::from_hms (0, 1, 54, 440));
198 BOOST_CHECK_EQUAL (i->to, sub::Time::from_hms (0, 1, 56, 590));
199 BOOST_CHECK_EQUAL (i->lines.size(), 1);
200 BOOST_CHECK_EQUAL (i->lines.front().blocks.front().text, "And italicised this.");
201 BOOST_CHECK_EQUAL (i->lines.front().blocks.front().italic, true);
204 BOOST_CHECK (i != subs.end ());
205 BOOST_CHECK_EQUAL (i->from, sub::Time::from_hms (0, 1, 56, 680));
206 BOOST_CHECK_EQUAL (i->to, sub::Time::from_hms (0, 1, 58, 955));
207 BOOST_CHECK_EQUAL (i->lines.size(), 1);
208 BOOST_CHECK_EQUAL (i->lines.front().blocks.front().text, "Shall I compare thee to a summers' day?");
211 BOOST_CHECK (i != subs.end ());
212 BOOST_CHECK_EQUAL (i->from, sub::Time::from_hms (0, 2, 0, 840));
213 BOOST_CHECK_EQUAL (i->to, sub::Time::from_hms (0, 2, 3, 400));
214 BOOST_CHECK_EQUAL (i->lines.size(), 1);
215 BOOST_CHECK_EQUAL (i->lines.front().blocks.front().text, "Is this a dagger I see before me?");
218 BOOST_CHECK (i != subs.end ());
219 BOOST_CHECK_EQUAL (i->from, sub::Time::from_hms (0, 3, 54, 560));
220 BOOST_CHECK_EQUAL (i->to, sub::Time::from_hms (0, 3, 56, 471));
221 BOOST_CHECK_EQUAL (i->lines.size(), 1);
222 BOOST_CHECK_EQUAL (i->lines.front().blocks.front().text, "Hello world.");
225 BOOST_CHECK (i != subs.end ());
226 BOOST_CHECK_EQUAL (i->from, sub::Time::from_hms (0, 4, 50, 123));
227 BOOST_CHECK_EQUAL (i->to, sub::Time::from_hms (0, 4, 55, 23));
228 BOOST_CHECK_EQUAL (i->lines.size(), 2);
229 BOOST_CHECK_EQUAL (i->lines.front().blocks.front().text, "Some italics over");
230 BOOST_CHECK_EQUAL (i->lines.front().blocks.front().italic, true);
231 BOOST_CHECK_EQUAL (i->lines.back().blocks.front().text, "multiple lines");
232 BOOST_CHECK_EQUAL (i->lines.back().blocks.front().italic, true);
235 BOOST_CHECK (i == subs.end ());
238 /** Test SubripReader::convert_line */
239 BOOST_AUTO_TEST_CASE (subrip_reader_convert_line_test)
244 r.convert_line ("Hello world", rs);
245 BOOST_CHECK_EQUAL (r._subs.size(), 1);
246 BOOST_CHECK_EQUAL (r._subs.front().text, "Hello world");
249 rs = sub::RawSubtitle();
250 r.convert_line ("<b>Hello world</b>", rs);
251 BOOST_CHECK_EQUAL (r._subs.size(), 1);
252 BOOST_CHECK_EQUAL (r._subs.front().text, "Hello world");
253 BOOST_CHECK_EQUAL (r._subs.front().bold, true);
256 rs = sub::RawSubtitle();
257 r.convert_line ("<i>Hello world</i>", rs);
258 BOOST_CHECK_EQUAL (r._subs.size(), 1);
259 BOOST_CHECK_EQUAL (r._subs.front().text, "Hello world");
260 BOOST_CHECK_EQUAL (r._subs.front().italic, true);
263 rs = sub::RawSubtitle();
264 r.convert_line ("<u>Hello world</u>", rs);
265 BOOST_CHECK_EQUAL (r._subs.size(), 1);
266 BOOST_CHECK_EQUAL (r._subs.front().text, "Hello world");
267 BOOST_CHECK_EQUAL (r._subs.front().underline, true);
270 rs = sub::RawSubtitle();
271 r.convert_line ("{b}Hello world{/b}", rs);
272 BOOST_CHECK_EQUAL (r._subs.size(), 1);
273 BOOST_CHECK_EQUAL (r._subs.front().text, "Hello world");
274 BOOST_CHECK_EQUAL (r._subs.front().bold, true);
277 rs = sub::RawSubtitle();
278 r.convert_line ("{i}Hello world{/i}", rs);
279 BOOST_CHECK_EQUAL (r._subs.size(), 1);
280 BOOST_CHECK_EQUAL (r._subs.front().text, "Hello world");
281 BOOST_CHECK_EQUAL (r._subs.front().italic, true);
284 rs = sub::RawSubtitle();
285 r.convert_line ("{u}Hello world{/u}", rs);
286 BOOST_CHECK_EQUAL (r._subs.size(), 1);
287 BOOST_CHECK_EQUAL (r._subs.front().text, "Hello world");
288 BOOST_CHECK_EQUAL (r._subs.front().underline, true);
291 rs = sub::RawSubtitle();
292 r.convert_line ("<b>This is <i>nesting</i> of subtitles</b>", rs);
293 BOOST_CHECK_EQUAL (r._subs.size(), 3);
294 list<sub::RawSubtitle>::iterator i = r._subs.begin ();
295 BOOST_CHECK_EQUAL (i->text, "This is ");
296 BOOST_CHECK_EQUAL (i->bold, true);
297 BOOST_CHECK_EQUAL (i->italic, false);
299 BOOST_CHECK_EQUAL (i->text, "nesting");
300 BOOST_CHECK_EQUAL (i->bold, true);
301 BOOST_CHECK_EQUAL (i->italic, true);
303 BOOST_CHECK_EQUAL (i->text, " of subtitles");
304 BOOST_CHECK_EQUAL (i->bold, true);
305 BOOST_CHECK_EQUAL (i->italic, false);
309 rs = sub::RawSubtitle();
310 r.convert_line ("<font color=\"#ff00ff\">simple color</font>", rs);
311 BOOST_CHECK_EQUAL (r._subs.size(), 1);
312 BOOST_CHECK_EQUAL (r._subs.front().text, "simple color");
313 BOOST_CHECK_EQUAL (r._subs.front().bold, false);
314 BOOST_CHECK_CLOSE (r._subs.front().colour.r, 1, 0.1);
315 BOOST_CHECK (fabs (r._subs.front().colour.g) < 0.01);
316 BOOST_CHECK_CLOSE (r._subs.front().colour.b, 1, 0.1);
319 rs = sub::RawSubtitle();
320 r.convert_line ("<font color=\"#ff0000\">some red text <b>in bold</b></font>", rs);
321 BOOST_CHECK_EQUAL (r._subs.size(), 2);
322 i = r._subs.begin ();
323 BOOST_CHECK_EQUAL (i->text, "some red text ");
324 BOOST_CHECK_EQUAL (i->bold, false);
325 BOOST_CHECK_CLOSE (i->colour.r, 1, 0.1);
326 BOOST_CHECK (fabs (i->colour.g) < 0.01);
327 BOOST_CHECK (fabs (i->colour.b) < 0.01);
329 BOOST_CHECK_EQUAL (i->text, "in bold");
330 BOOST_CHECK_EQUAL (i->bold, true);
331 BOOST_CHECK_CLOSE (i->colour.r, 1, 0.1);
332 BOOST_CHECK (fabs (i->colour.g) < 0.01);
333 BOOST_CHECK (fabs (i->colour.b) < 0.01);
336 rs = sub::RawSubtitle();
337 r.convert_line ("<font color=\"#0000ff\">some blue text <b>in bold</b></font>", rs);
338 BOOST_CHECK_EQUAL (r._subs.size(), 2);
339 i = r._subs.begin ();
340 BOOST_CHECK_EQUAL (i->text, "some blue text ");
341 BOOST_CHECK_EQUAL (i->bold, false);
342 BOOST_CHECK (fabs (i->colour.r) < 0.01);
343 BOOST_CHECK (fabs (i->colour.g) < 0.01);
344 BOOST_CHECK_CLOSE (i->colour.b, 1, 0.1);
346 BOOST_CHECK_EQUAL (i->text, "in bold");
347 BOOST_CHECK_EQUAL (i->bold, true);
348 BOOST_CHECK (fabs (i->colour.r) < 0.01);
349 BOOST_CHECK (fabs (i->colour.g) < 0.01);
350 BOOST_CHECK_CLOSE (i->colour.b, 1, 0.1);
354 /** Test SubripReader::convert_time */
355 BOOST_AUTO_TEST_CASE (subrip_reader_convert_time_test)
357 BOOST_CHECK_EQUAL (sub::SubripReader::convert_time ("00:03:10,500"), sub::Time::from_hms (0, 3, 10, 500));
358 BOOST_CHECK_EQUAL (sub::SubripReader::convert_time ("04:19:51,782"), sub::Time::from_hms (4, 19, 51, 782));
362 test (boost::filesystem::path p)
364 p = private_test / p;
365 FILE* f = fopen (p.string().c_str(), "r");
368 cerr << p << " not found.\n";
371 sub::SubripReader r (f);
375 /** Test of reading some typical .srt files */
376 BOOST_AUTO_TEST_CASE (subrip_read_test)
378 test ("sintel_en.srt");
379 test ("sintel_fr.srt");
380 test ("Fight.Club.1999.720p.BRRip.x264-x0r.srt");
384 #define SUB_START(f, t) \
385 BOOST_REQUIRE (i != subs.end ()); \
386 BOOST_CHECK_EQUAL (i->from, f); \
387 BOOST_CHECK_EQUAL (i->to, t); \
388 j = i->lines.begin ();
391 BOOST_REQUIRE (j != i->lines.end ()); \
392 BOOST_CHECK (j->vertical_position.line); \
393 BOOST_CHECK_EQUAL (j->vertical_position.line.get(), p); \
394 BOOST_CHECK (j->vertical_position.reference); \
395 BOOST_CHECK_EQUAL (j->vertical_position.reference.get(), sub::TOP_OF_SUBTITLE); \
396 k = j->blocks.begin (); \
399 #define BLOCK(t, f, s, b, i, u) \
400 BOOST_REQUIRE (k != j->blocks.end ()); \
401 BOOST_CHECK_EQUAL (k->text, t); \
402 BOOST_CHECK_EQUAL (k->bold, b); \
403 BOOST_CHECK_EQUAL (k->italic, i); \
404 BOOST_CHECK_EQUAL (k->underline, u); \
410 /** Test reading of another .srt file */
411 BOOST_AUTO_TEST_CASE (subrip_reader_test3)
413 boost::filesystem::path p = private_test / "DCP-o-matic_test_subs_1.srt";
414 FILE* f = fopen (p.string().c_str(), "r");
415 sub::SubripReader reader (f);
417 list<sub::Subtitle> subs = sub::collect<std::list<sub::Subtitle> > (reader.subtitles ());
419 list<sub::Subtitle>::iterator i = subs.begin ();
420 list<sub::Line>::iterator j;
421 list<sub::Block>::iterator k;
423 BOOST_REQUIRE (i != subs.end ());
425 SUB_START (sub::Time::from_hms (0, 0, 0, 76), sub::Time::from_hms (0, 0, 1, 116));
427 BLOCK ("This line is normal", "Arial", 30, false, false, false);
429 BLOCK ("This line is bold", "Arial", 30, true, false, false);
432 SUB_START (sub::Time::from_hms (0, 0, 1, 206), sub::Time::from_hms (0, 0, 2, 246));
434 BLOCK ("This line is bold", "Arial", 30, true, false, false);
436 BLOCK ("This line is normal", "Arial", 30, false, false, false);
439 SUB_START (sub::Time::from_hms (0, 0, 2, 308), sub::Time::from_hms (0, 0, 3, 380));
441 BLOCK ("This line is bold", "Arial", 30, true, false, false);
443 BLOCK ("This line is italic", "Arial", 30, false, true, false);
446 SUB_START (sub::Time::from_hms (0, 0, 3, 404), sub::Time::from_hms (0, 0, 4, 484));
448 BLOCK ("This line is italic", "Arial", 30, false, true, false);
450 BLOCK ("This line is bold", "Arial", 30, true, false, false);
453 SUB_START (sub::Time::from_hms (0, 0, 4, 519), sub::Time::from_hms (0, 0, 5, 604));
455 BLOCK ("Last three words are ", "Arial", 30, false, false, false);
456 BLOCK ("bold AND italic", "Arial", 30, true, true, false);
458 BLOCK ("Last three words are ", "Arial", 30, false, false, false);
459 BLOCK ("italic AND bold", "Arial", 30, true, true, false);
462 SUB_START (sub::Time::from_hms (0, 0, 5, 628), sub::Time::from_hms (0, 0, 6, 712));
464 BLOCK ("Last three words are ", "Arial", 30, false, false, false);
465 BLOCK ("bold AND italic", "Arial", 30, true, true, false);
467 BLOCK ("First three words", "Arial", 30, true, true, false);
468 BLOCK (" are italic AND bold", "Arial", 30, false, false, false);
471 SUB_START (sub::Time::from_hms (0, 0, 6, 736), sub::Time::from_hms (0, 0, 8, 31));
473 BLOCK ("Last three words are ", "Arial", 30, false, false, false);
474 BLOCK ("bold AND italic", "Arial", 30, true, true, false);
476 BLOCK ("This line is normal", "Arial", 30, false, false, false);
479 SUB_START (sub::Time::from_hms (0, 0, 8, 94), sub::Time::from_hms (0, 0, 9, 211));
481 BLOCK ("Both lines are bold AND italic", "Arial", 30, true, true, false);
483 BLOCK ("Both lines are bold AND italic", "Arial", 30, true, true, false);