2 Copyright (C) 2014-2021 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/burnt_subtitle_test.cc
22 * @brief Test the burning of subtitles into the DCP.
26 #include "lib/plain_text_content.h"
27 #include "lib/dcp_text_content.h"
29 #include "lib/ratio.h"
30 #include "lib/dcp_content_type.h"
31 #include "lib/text_content.h"
32 #include "lib/dcp_content.h"
33 #include "lib/content_factory.h"
34 #include "lib/config.h"
35 #include "lib/log_entry.h"
40 #include <dcp/j2k_transcode.h>
41 #include <dcp/mono_picture_asset.h>
42 #include <dcp/mono_picture_asset_reader.h>
43 #include <dcp/mono_picture_frame.h>
44 #include <dcp/openjpeg_image.h>
45 #include <dcp/reel_picture_asset.h>
46 #include <dcp/reel_mono_picture_asset.h>
47 #include <boost/test/unit_test.hpp>
52 using std::shared_ptr;
53 using std::dynamic_pointer_cast;
54 using std::make_shared;
55 using namespace dcpomatic;
57 /** Build a small DCP with no picture and a single subtitle overlaid onto it from a SubRip file */
58 BOOST_AUTO_TEST_CASE (burnt_subtitle_test_subrip)
60 auto film = new_test_film ("burnt_subtitle_test_subrip");
61 film->set_container (Ratio::from_id ("185"));
62 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
63 film->set_name ("frobozz");
64 auto content = make_shared<StringText>(film, "test/data/subrip2.srt");
65 content->subtitle->set_use (true);
66 content->subtitle->set_burn (true);
67 film->examine_and_add_content (content);
68 BOOST_REQUIRE (!wait_for_jobs());
69 make_and_verify_dcp (film);
71 check_dcp ("test/data/burnt_subtitle_test_subrip", film->dir (film->dcp_name ()));
74 /** Build a small DCP with no picture and a single subtitle overlaid onto it from a DCP XML file */
75 BOOST_AUTO_TEST_CASE (burnt_subtitle_test_dcp)
77 auto film = new_test_film ("burnt_subtitle_test_dcp");
78 film->set_container (Ratio::from_id ("185"));
79 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
80 film->set_name ("frobozz");
81 auto content = make_shared<DCPTextContent>(film, "test/data/dcp_sub.xml");
82 content->subtitle->set_use (true);
83 film->examine_and_add_content (content);
84 BOOST_REQUIRE (!wait_for_jobs());
85 make_and_verify_dcp (film);
87 check_dcp ("test/data/burnt_subtitle_test_dcp", film->dir (film->dcp_name ()));
90 /** Burn some subtitles into an existing DCP to check the colour conversion */
91 BOOST_AUTO_TEST_CASE (burnt_subtitle_test_onto_dcp)
93 auto film = new_test_film ("burnt_subtitle_test_onto_dcp");
94 film->set_container (Ratio::from_id ("185"));
95 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
96 film->set_name ("frobozz");
97 film->examine_and_add_content (content_factory(film, "test/data/flat_black.png").front());
98 BOOST_REQUIRE (!wait_for_jobs());
99 make_and_verify_dcp (film);
101 Config::instance()->set_log_types (Config::instance()->log_types() | LogEntry::TYPE_DEBUG_ENCODE);
102 auto film2 = new_test_film ("burnt_subtitle_test_onto_dcp2");
103 film2->set_container (Ratio::from_id ("185"));
104 film2->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
105 film2->set_name ("frobozz");
106 auto background_dcp = make_shared<DCPContent>(film2, film->dir(film->dcp_name()));
107 film2->examine_and_add_content (background_dcp);
108 auto sub = dynamic_pointer_cast<StringText> (
109 content_factory(film2, "test/data/subrip2.srt").front()
111 sub->subtitle->set_burn (true);
112 sub->subtitle->set_outline (true);
113 film2->examine_and_add_content (sub);
114 BOOST_REQUIRE (!wait_for_jobs());
115 make_and_verify_dcp (film2);
117 BOOST_CHECK (background_dcp->position() == DCPTime());
118 BOOST_CHECK (sub->position() == DCPTime());
120 dcp::DCP dcp (film2->dir (film2->dcp_name ()));
122 BOOST_REQUIRE_EQUAL (dcp.cpls().size(), 1);
123 BOOST_REQUIRE_EQUAL (dcp.cpls().front()->reels().size(), 1);
124 BOOST_REQUIRE (dcp.cpls().front()->reels().front()->main_picture());
125 BOOST_REQUIRE (dcp.cpls().front()->reels().front()->main_picture()->asset());
126 auto pic = dynamic_pointer_cast<dcp::ReelMonoPictureAsset> (
127 dcp.cpls().front()->reels().front()->main_picture()
130 auto frame = pic->start_read()->get_frame(12);
131 auto xyz = frame->xyz_image ();
132 BOOST_CHECK_EQUAL (xyz->size().width, 1998);
133 BOOST_CHECK_EQUAL (xyz->size().height, 1080);
135 check_dcp ("test/data/burnt_subtitle_test_onto_dcp", film->dir(film->dcp_name()));