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 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, "test/data/subrip2.srt"));
50 film->examine_and_add_content (content);
53 content->subtitle->set_use (true);
54 content->subtitle->set_burn (false);
58 /* Should be blank video with a subtitle MXF */
59 check_dcp ("test/data/srt_subtitle_test", film->dir (film->dcp_name ()));
62 /** Same again but with a `font' specified */
63 BOOST_AUTO_TEST_CASE (srt_subtitle_test2)
65 shared_ptr<Film> film = new_test_film ("srt_subtitle_test2");
66 film->set_container (Ratio::from_id ("185"));
67 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
68 film->set_name ("frobozz");
69 film->set_audio_channels (6);
70 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, "test/data/subrip2.srt"));
71 film->examine_and_add_content (content);
74 content->subtitle->set_use (true);
75 content->subtitle->set_burn (false);
76 /* Use test/data/subrip2.srt as if it were a font file */
77 content->subtitle->fonts().front()->set_file (FontFiles::NORMAL, "test/data/subrip2.srt");
82 /* Should be blank video with a subtitle MXF */
83 check_dcp ("test/data/srt_subtitle_test2", film->dir (film->dcp_name ()));
87 check_subtitle_file (shared_ptr<Film> film, boost::filesystem::path ref)
89 /* Find the subtitle file and check it */
91 boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->directory().get() / film->dcp_name (false));
92 i != boost::filesystem::directory_iterator ();
95 if (boost::filesystem::is_directory (i->path ())) {
97 boost::filesystem::directory_iterator j = boost::filesystem::directory_iterator (i->path ());
98 j != boost::filesystem::directory_iterator ();
101 if (boost::algorithm::starts_with (j->path().leaf().string(), "sub_")) {
103 ignore.push_back ("SubtitleID");
104 check_xml (*j, ref, ignore);
111 /** Make another DCP with a longer .srt file */
112 BOOST_AUTO_TEST_CASE (srt_subtitle_test3)
114 shared_ptr<Film> film = new_test_film ("srt_subtitle_test3");
116 film->set_container (Ratio::from_id ("185"));
117 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
118 film->set_name ("frobozz");
119 film->set_interop (true);
120 film->set_audio_channels (6);
121 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, private_data / "Ankoemmling_short.srt"));
122 film->examine_and_add_content (content);
125 content->subtitle->set_use (true);
126 content->subtitle->set_burn (false);
131 check_subtitle_file (film, private_data / "Ankoemmling_short.xml");
134 /** Build a small DCP with no picture and a single subtitle overlaid onto it */
135 BOOST_AUTO_TEST_CASE (srt_subtitle_test4)
137 shared_ptr<Film> film = new_test_film ("srt_subtitle_test4");
138 film->set_container (Ratio::from_id ("185"));
139 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
140 film->set_name ("frobozz");
141 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, "test/data/subrip2.srt"));
142 content->subtitle->set_use (true);
143 content->subtitle->set_burn (false);
144 film->examine_and_add_content (content);
149 /* Should be blank video with MXF subtitles */
150 check_dcp ("test/data/xml_subtitle_test", film->dir (film->dcp_name ()));
153 /** Check the subtitle XML when there are two subtitle files in the project */
154 BOOST_AUTO_TEST_CASE (srt_subtitle_test5)
156 shared_ptr<Film> film = new_test_film ("srt_subtitle_test5");
157 film->set_container (Ratio::from_id ("185"));
158 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
159 film->set_name ("frobozz");
160 film->set_interop (true);
161 film->set_sequence (false);
162 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, "test/data/subrip2.srt"));
163 content->subtitle->set_use (true);
164 content->subtitle->set_burn (false);
165 film->examine_and_add_content (content);
166 film->examine_and_add_content (content);
168 content->set_position (DCPTime (0));
171 film->write_metadata ();
173 check_dcp ("test/data/xml_subtitle_test2", film->dir (film->dcp_name ()));
177 /* XXX: this is disabled; there is some difference in font rendering
178 between the test machine and others.
181 /** Test rendering of a SubRip subtitle */
182 BOOST_AUTO_TEST_CASE (srt_subtitle_test4)
184 shared_ptr<Film> film = new_test_film ("subrip_render_test");
185 shared_ptr<TextSubtitleContent> content (new TextSubtitleContent (film, "test/data/subrip.srt"));
186 content->examine (shared_ptr<Job> (), true);
187 BOOST_CHECK_EQUAL (content->full_length(), DCPTime::from_seconds ((3 * 60) + 56.471));
189 shared_ptr<SubRipDecoder> decoder (new SubRipDecoder (content));
190 list<ContentTextSubtitle> cts = decoder->get_text_subtitles (
192 ContentTime::from_seconds (109), ContentTime::from_seconds (110)
195 BOOST_CHECK_EQUAL (cts.size(), 1);
197 PositionImage image = render_subtitles (cts.front().subs, dcp::Size (1998, 1080));
198 write_image (image.image, "build/test/subrip_render_test.png");
199 check_file ("build/test/subrip_render_test.png", "test/data/subrip_render_test.png");