Verify a whole bunch of DCPs made by unit tests.
[dcpomatic.git] / test / closed_caption_test.cc
1 /*
2     Copyright (C) 2018-2021 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/film.h"
22 #include "lib/text_content.h"
23 #include "lib/string_text_file_content.h"
24 #include "test.h"
25 #include <dcp/dcp.h>
26 #include <dcp/cpl.h>
27 #include <dcp/reel.h>
28 #include <dcp/reel_closed_caption_asset.h>
29 #include <boost/test/unit_test.hpp>
30
31 using std::list;
32 using std::make_shared;
33 using std::shared_ptr;
34
35 /** Basic test that Interop closed captions are written */
36 BOOST_AUTO_TEST_CASE (closed_caption_test1)
37 {
38         Cleanup cl;
39
40         auto content = make_shared<StringTextFileContent>("test/data/subrip.srt");
41         auto film = new_test_film2 ("closed_caption_test1", { content }, &cl);
42
43         content->only_text()->set_type (TextType::CLOSED_CAPTION);
44
45         film->make_dcp ();
46         BOOST_REQUIRE (!wait_for_jobs ());
47
48         /* Just check to see that there's a CCAP in the CPL: this
49            check could be better!
50         */
51
52         dcp::DCP check (film->dir(film->dcp_name()));
53         check.read ();
54
55         BOOST_REQUIRE_EQUAL (check.cpls().size(), 1U);
56         BOOST_REQUIRE_EQUAL (check.cpls().front()->reels().size(), 1U);
57         BOOST_REQUIRE (!check.cpls().front()->reels().front()->closed_captions().empty());
58
59         cl.run ();
60 }
61
62 /** Test multiple closed captions */
63 BOOST_AUTO_TEST_CASE (closed_caption_test2)
64 {
65         Cleanup cl;
66         auto content1 = make_shared<StringTextFileContent>("test/data/subrip.srt");
67         auto content2 = make_shared<StringTextFileContent>("test/data/subrip2.srt");
68         auto content3 = make_shared<StringTextFileContent>("test/data/subrip3.srt");
69         auto film = new_test_film2 ("closed_caption_test2", { content1, content2, content3 }, &cl);
70
71         content1->only_text()->set_type (TextType::CLOSED_CAPTION);
72         content1->only_text()->set_dcp_track (DCPTextTrack("First track", "fr-FR"));
73         content2->only_text()->set_type (TextType::CLOSED_CAPTION);
74         content2->only_text()->set_dcp_track (DCPTextTrack("Second track", "de-DE"));
75         content3->only_text()->set_type (TextType::CLOSED_CAPTION);
76         content3->only_text()->set_dcp_track (DCPTextTrack("Third track", "it-IT"));
77
78         make_and_verify_dcp (
79                 film,
80                 {
81                         dcp::VerificationNote::Code::INVALID_SUBTITLE_DURATION,
82                         dcp::VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_LENGTH,
83                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
84                 }
85                 );
86
87         dcp::DCP check (film->dir(film->dcp_name()));
88         check.read ();
89
90         BOOST_REQUIRE_EQUAL (check.cpls().size(), 1U);
91         BOOST_REQUIRE_EQUAL (check.cpls().front()->reels().size(), 1U);
92         auto ccaps = check.cpls().front()->reels().front()->closed_captions();
93         BOOST_REQUIRE_EQUAL (ccaps.size(), 3U);
94
95         auto i = ccaps.begin ();
96         BOOST_CHECK_EQUAL ((*i)->annotation_text(), "First track");
97         BOOST_REQUIRE (static_cast<bool>((*i)->language()));
98         BOOST_CHECK_EQUAL ((*i)->language().get(), "fr-FR");
99         ++i;
100         BOOST_CHECK_EQUAL ((*i)->annotation_text(), "Second track");
101         BOOST_REQUIRE (static_cast<bool>((*i)->language()));
102         BOOST_CHECK_EQUAL ((*i)->language().get(), "de-DE");
103         ++i;
104         BOOST_CHECK_EQUAL ((*i)->annotation_text(), "Third track");
105         BOOST_REQUIRE (static_cast<bool>((*i)->language()));
106         BOOST_CHECK_EQUAL ((*i)->language().get(), "it-IT");
107
108         cl.run ();
109 }