2 Copyright (C) 2015 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic 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.
11 DCP-o-matic 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.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 /** @file test/srt_subtitle_test.cc
22 * @brief Test writing DCPs with subtitles from .srt.
27 #include "lib/text_subtitle_content.h"
28 #include "lib/dcp_content_type.h"
30 #include "lib/ratio.h"
31 #include "lib/subtitle_content.h"
33 #include <boost/test/unit_test.hpp>
34 #include <boost/algorithm/string.hpp>
39 using boost::shared_ptr;
41 /** Make a very short DCP with a single subtitle from .srt with no specified fonts */
42 BOOST_AUTO_TEST_CASE (srt_subtitle_test)
44 shared_ptr<Film> film = new_test_film ("srt_subtitle_test");
45 film->set_container (Ratio::from_id ("185"));
46 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
47 film->set_name ("frobozz");
48 film->set_audio_channels (6);
49 film->set_interop (false);
50 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, "test/data/subrip2.srt"));
51 film->examine_and_add_content (content);
54 content->subtitle->set_use (true);
55 content->subtitle->set_burn (false);
59 /* Should be blank video with a subtitle MXF */
60 check_dcp ("test/data/srt_subtitle_test", film->dir (film->dcp_name ()));
63 /** Same again but with a `font' specified */
64 BOOST_AUTO_TEST_CASE (srt_subtitle_test2)
66 shared_ptr<Film> film = new_test_film ("srt_subtitle_test2");
67 film->set_container (Ratio::from_id ("185"));
68 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
69 film->set_name ("frobozz");
70 film->set_audio_channels (6);
71 film->set_interop (false);
72 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, "test/data/subrip2.srt"));
73 film->examine_and_add_content (content);
76 content->subtitle->set_use (true);
77 content->subtitle->set_burn (false);
78 /* Use test/data/subrip2.srt as if it were a font file */
79 content->subtitle->fonts().front()->set_file (FontFiles::NORMAL, "test/data/subrip2.srt");
84 /* Should be blank video with a subtitle MXF */
85 check_dcp ("test/data/srt_subtitle_test2", film->dir (film->dcp_name ()));
89 check_subtitle_file (shared_ptr<Film> film, boost::filesystem::path ref)
91 /* Find the subtitle file and check it */
93 boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->directory().get() / film->dcp_name (false));
94 i != boost::filesystem::directory_iterator ();
97 if (boost::filesystem::is_directory (i->path ())) {
99 boost::filesystem::directory_iterator j = boost::filesystem::directory_iterator (i->path ());
100 j != boost::filesystem::directory_iterator ();
103 if (boost::algorithm::starts_with (j->path().leaf().string(), "sub_")) {
105 ignore.push_back ("SubtitleID");
106 check_xml (*j, ref, ignore);
113 /** Make another DCP with a longer .srt file */
114 BOOST_AUTO_TEST_CASE (srt_subtitle_test3)
116 shared_ptr<Film> film = new_test_film ("srt_subtitle_test3");
118 film->set_container (Ratio::from_id ("185"));
119 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
120 film->set_name ("frobozz");
121 film->set_interop (true);
122 film->set_audio_channels (6);
123 film->set_interop (false);
124 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, private_data / "Ankoemmling_short.srt"));
125 film->examine_and_add_content (content);
128 content->subtitle->set_use (true);
129 content->subtitle->set_burn (false);
134 check_subtitle_file (film, private_data / "Ankoemmling_short.xml");
137 /** Build a small DCP with no picture and a single subtitle overlaid onto it */
138 BOOST_AUTO_TEST_CASE (srt_subtitle_test4)
140 shared_ptr<Film> film = new_test_film ("srt_subtitle_test4");
141 film->set_container (Ratio::from_id ("185"));
142 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
143 film->set_name ("frobozz");
144 film->set_interop (false);
145 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, "test/data/subrip2.srt"));
146 content->subtitle->set_use (true);
147 content->subtitle->set_burn (false);
148 film->examine_and_add_content (content);
153 /* Should be blank video with MXF subtitles */
154 check_dcp ("test/data/xml_subtitle_test", film->dir (film->dcp_name ()));
157 /** Check the subtitle XML when there are two subtitle files in the project */
158 BOOST_AUTO_TEST_CASE (srt_subtitle_test5)
160 shared_ptr<Film> film = new_test_film ("srt_subtitle_test5");
161 film->set_container (Ratio::from_id ("185"));
162 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
163 film->set_name ("frobozz");
164 film->set_interop (true);
165 film->set_sequence (false);
166 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, "test/data/subrip2.srt"));
167 content->subtitle->set_use (true);
168 content->subtitle->set_burn (false);
169 film->examine_and_add_content (content);
170 film->examine_and_add_content (content);
172 content->set_position (DCPTime (0));
175 film->write_metadata ();
177 check_dcp ("test/data/xml_subtitle_test2", film->dir (film->dcp_name ()));
180 BOOST_AUTO_TEST_CASE (srt_subtitle_test6)
182 shared_ptr<Film> film = new_test_film2 ("srt_subtitle_test6");
183 film->set_interop (false);
184 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, "test/data/frames.srt"));
185 content->subtitle->set_use (true);
186 content->subtitle->set_burn (false);
187 film->examine_and_add_content (content);
188 BOOST_REQUIRE (!wait_for_jobs ());
190 BOOST_REQUIRE (!wait_for_jobs ());
191 film->write_metadata ();
193 check_dcp ("test/data/srt_subtitle_test6", film->dir(film->dcp_name()));
197 /* XXX: this is disabled; there is some difference in font rendering
198 between the test machine and others.
201 /** Test rendering of a SubRip subtitle */
202 BOOST_AUTO_TEST_CASE (srt_subtitle_test4)
204 shared_ptr<Film> film = new_test_film ("subrip_render_test");
205 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, "test/data/subrip.srt"));
206 content->examine (shared_ptr<Job> (), true);
207 BOOST_CHECK_EQUAL (content->full_length(), DCPTime::from_seconds ((3 * 60) + 56.471));
209 shared_ptr<SubRipDecoder> decoder (new SubRipDecoder (content));
210 list<ContentTextSubtitle> cts = decoder->get_text_subtitles (
212 ContentTime::from_seconds (109), ContentTime::from_seconds (110)
215 BOOST_CHECK_EQUAL (cts.size(), 1);
217 PositionImage image = render_subtitles (cts.front().subs, dcp::Size (1998, 1080));
218 write_image (image.image, "build/test/subrip_render_test.png");
219 check_file ("build/test/subrip_render_test.png", "test/data/subrip_render_test.png");