Cleanup: test tidying.
[dcpomatic.git] / test / subtitle_reel_test.cc
1 /*
2     Copyright (C) 2019-2020 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
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.
10
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.
15
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/>.
18
19 */
20
21 #include "lib/content_factory.h"
22 #include "lib/dcp_subtitle_content.h"
23 #include "lib/film.h"
24 #include "lib/image_content.h"
25 #include "lib/text_content.h"
26 #include "lib/video_content.h"
27 #include "test.h"
28 #include <dcp/dcp.h>
29 #include <dcp/cpl.h>
30 #include <dcp/reel.h>
31 #include <dcp/interop_subtitle_asset.h>
32 #include <dcp/reel_closed_caption_asset.h>
33 #include <dcp/reel_subtitle_asset.h>
34 #include <boost/test/unit_test.hpp>
35
36
37 using std::list;
38 using std::make_shared;
39 using std::string;
40 using boost::optional;
41
42
43 /* Check that timings are done correctly for multi-reel DCPs with PNG subs */
44 BOOST_AUTO_TEST_CASE (subtitle_reel_test)
45 {
46         auto film = new_test_film2 ("subtitle_reel_test");
47         film->set_interop (true);
48         auto red_a = make_shared<ImageContent>("test/data/flat_red.png");
49         auto red_b = make_shared<ImageContent>("test/data/flat_red.png");
50         auto sub_a = make_shared<DCPSubtitleContent>("test/data/png_subs/subs.xml");
51         auto sub_b = make_shared<DCPSubtitleContent>("test/data/png_subs/subs.xml");
52
53         film->examine_and_add_content (red_a);
54         film->examine_and_add_content (red_b);
55         film->examine_and_add_content (sub_a);
56         film->examine_and_add_content (sub_b);
57
58         BOOST_REQUIRE (!wait_for_jobs());
59
60         red_a->set_position (film, dcpomatic::DCPTime());
61         red_a->video->set_length (240);
62         sub_a->set_position (film, dcpomatic::DCPTime());
63         red_b->set_position (film, dcpomatic::DCPTime::from_seconds(10));
64         red_b->video->set_length (240);
65         sub_b->set_position (film, dcpomatic::DCPTime::from_seconds(10));
66
67         film->set_reel_type (ReelType::BY_VIDEO_CONTENT);
68
69         make_and_verify_dcp (film, {dcp::VerificationNote::Code::INVALID_STANDARD});
70
71         dcp::DCP dcp ("build/test/subtitle_reel_test/" + film->dcp_name());
72         dcp.read ();
73         BOOST_REQUIRE_EQUAL (dcp.cpls().size(), 1U);
74         auto cpl = dcp.cpls().front();
75
76         auto reels = cpl->reels ();
77         BOOST_REQUIRE_EQUAL (reels.size(), 2U);
78         auto i = reels.begin ();
79         BOOST_REQUIRE ((*i)->main_subtitle());
80         BOOST_REQUIRE ((*i)->main_subtitle()->asset());
81         auto A = std::dynamic_pointer_cast<dcp::InteropSubtitleAsset>((*i)->main_subtitle()->asset());
82         BOOST_REQUIRE (A);
83         ++i;
84         BOOST_REQUIRE ((*i)->main_subtitle());
85         BOOST_REQUIRE ((*i)->main_subtitle()->asset());
86         auto B = std::dynamic_pointer_cast<dcp::InteropSubtitleAsset>((*i)->main_subtitle()->asset());
87         BOOST_REQUIRE (B);
88
89         BOOST_REQUIRE_EQUAL (A->subtitles().size(), 1U);
90         BOOST_REQUIRE_EQUAL (B->subtitles().size(), 1U);
91
92         /* These times should be the same as they are should be offset from the start of the reel */
93         BOOST_CHECK (A->subtitles().front()->in() == B->subtitles().front()->in());
94 }
95
96
97
98 /** Check that with a SMPTE DCP if we have subtitles in one reel, all reels have a
99  *  SubtitleAsset (even if it's empty); SMPTE Bv2.1 section 8.3.1.
100  */
101 BOOST_AUTO_TEST_CASE (subtitle_in_all_reels_test)
102 {
103         auto film = new_test_film2 ("subtitle_in_all_reels_test");
104         film->set_interop (false);
105         film->set_sequence (false);
106         film->set_reel_type (ReelType::BY_VIDEO_CONTENT);
107         for (int i = 0; i < 3; ++i) {
108                 auto video = content_factory("test/data/flat_red.png")[0];
109                 film->examine_and_add_content (video);
110                 BOOST_REQUIRE (!wait_for_jobs());
111                 video->video->set_length (15 * 24);
112                 video->set_position (film, dcpomatic::DCPTime::from_seconds(15 * i));
113         }
114         auto subs = content_factory("test/data/15s.srt")[0];
115         film->examine_and_add_content (subs);
116         BOOST_REQUIRE (!wait_for_jobs());
117         make_and_verify_dcp (
118                 film,
119                 {
120                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
121                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
122                         dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING
123                 });
124
125         dcp::DCP dcp ("build/test/subtitle_in_all_reels_test/" + film->dcp_name());
126         dcp.read ();
127         BOOST_REQUIRE_EQUAL (dcp.cpls().size(), 1U);
128         auto cpl = dcp.cpls()[0];
129         BOOST_REQUIRE_EQUAL (cpl->reels().size(), 3U);
130
131         for (auto i: cpl->reels()) {
132                 BOOST_CHECK (i->main_subtitle());
133         }
134 }
135
136
137 /** Check that with a SMPTE DCP if we have closed captions in one reel, all reels have a
138  *  ClosedCaptionAssets for the same set of tracks (even if they are empty); SMPTE Bv2.1 section 8.3.1.
139  */
140 BOOST_AUTO_TEST_CASE (closed_captions_in_all_reels_test)
141 {
142         auto film = new_test_film2 ("closed_captions_in_all_reels_test");
143         film->set_interop (false);
144         film->set_sequence (false);
145         film->set_reel_type (ReelType::BY_VIDEO_CONTENT);
146
147         for (int i = 0; i < 3; ++i) {
148                 auto video = content_factory("test/data/flat_red.png")[0];
149                 film->examine_and_add_content (video);
150                 BOOST_REQUIRE (!wait_for_jobs());
151                 video->video->set_length (15 * 24);
152                 video->set_position (film, dcpomatic::DCPTime::from_seconds(15 * i));
153         }
154
155         auto ccap1 = content_factory("test/data/15s.srt")[0];
156         film->examine_and_add_content (ccap1);
157         BOOST_REQUIRE (!wait_for_jobs());
158         ccap1->text.front()->set_type (TextType::CLOSED_CAPTION);
159         ccap1->text.front()->set_dcp_track (DCPTextTrack("Test", dcp::LanguageTag("de-DE")));
160
161         auto ccap2 = content_factory("test/data/15s.srt")[0];
162         film->examine_and_add_content (ccap2);
163         BOOST_REQUIRE (!wait_for_jobs());
164         ccap2->text.front()->set_type (TextType::CLOSED_CAPTION);
165         ccap2->text.front()->set_dcp_track (DCPTextTrack("Other", dcp::LanguageTag("en-GB")));
166
167         make_and_verify_dcp (
168                 film,
169                 {
170                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
171                         dcp::VerificationNote::Code::INVALID_SUBTITLE_SPACING
172                 });
173
174         dcp::DCP dcp ("build/test/closed_captions_in_all_reels_test/" + film->dcp_name());
175         dcp.read ();
176         BOOST_REQUIRE_EQUAL (dcp.cpls().size(), 1U);
177         auto cpl = dcp.cpls().front();
178         BOOST_REQUIRE_EQUAL (cpl->reels().size(), 3U);
179
180         for (auto i: cpl->reels()) {
181                 BOOST_REQUIRE_EQUAL (i->closed_captions().size(), 2U);
182                 auto first = i->closed_captions().front()->language();
183                 auto second = i->closed_captions().back()->language();
184                 BOOST_REQUIRE (first);
185                 BOOST_REQUIRE (second);
186                 BOOST_CHECK (
187                         (*first == "en-GB" && *second == "de-DE") ||
188                         (*first == "de-DE" && *second == "en-GB")
189                         );
190         }
191 }
192
193
194 BOOST_AUTO_TEST_CASE (subtitles_split_at_reel_boundaries)
195 {
196         auto film = new_test_film2 ("subtitles_split_at_reel_boundaries");
197         film->set_interop (true);
198
199         film->set_sequence (false);
200         film->set_reel_type (ReelType::BY_VIDEO_CONTENT);
201
202         for (int i = 0; i < 3; ++i) {
203                 auto video = content_factory("test/data/flat_red.png")[0];
204                 film->examine_and_add_content (video);
205                 BOOST_REQUIRE (!wait_for_jobs());
206                 video->video->set_length (15 * 24);
207                 video->set_position (film, dcpomatic::DCPTime::from_seconds(15 * i));
208         }
209
210         auto subtitle = content_factory("test/data/45s.srt")[0];
211         film->examine_and_add_content (subtitle);
212         BOOST_REQUIRE (!wait_for_jobs());
213
214         make_and_verify_dcp (film, { dcp::VerificationNote::Code::INVALID_STANDARD });
215
216         dcp::DCP dcp (film->dir(film->dcp_name()));
217         dcp.read();
218         BOOST_REQUIRE_EQUAL (dcp.cpls().size(), 1U);
219         auto cpl = dcp.cpls()[0];
220         BOOST_REQUIRE_EQUAL (cpl->reels().size(), 3U);
221
222         for (auto i: cpl->reels()) {
223                 auto reel_sub = i->main_subtitle();
224                 BOOST_REQUIRE (reel_sub);
225                 auto sub = reel_sub->asset();
226                 BOOST_REQUIRE (sub);
227                 BOOST_CHECK_EQUAL (sub->subtitles().size(), 1U);
228         }
229 }
230