test/burnt_subtitle_test.cc

   1 /*
   2     Copyright (C) 2014-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
  22 /** @file  test/burnt_subtitle_test.cc
  23  *  @brief Test the burning of subtitles into the DCP.
  24  *  @ingroup feature
  25  */
  26
  27
  28 #include "lib/config.h"
  29 #include "lib/content_factory.h"
  30 #include "lib/dcp_content.h"
  31 #include "lib/dcp_content_type.h"
  32 #include "lib/film.h"
  33 #include "lib/ffmpeg_encoder.h"
  34 #include "lib/log_entry.h"
  35 #include "lib/ratio.h"
  36 #include "lib/text_content.h"
  37 #include "test.h"
  38 #include <dcp/dcp.h>
  39 #include <dcp/cpl.h>
  40 #include <dcp/reel.h>
  41 #include <dcp/j2k_transcode.h>
  42 #include <dcp/mono_picture_asset.h>
  43 #include <dcp/mono_picture_asset_reader.h>
  44 #include <dcp/mono_picture_frame.h>
  45 #include <dcp/openjpeg_image.h>
  46 #include <dcp/reel_picture_asset.h>
  47 #include <dcp/reel_mono_picture_asset.h>
  48 #include <boost/test/unit_test.hpp>
  49
  50
  51 using std::dynamic_pointer_cast;
  52 using std::make_shared;
  53 using std::map;
  54 using std::string;
  55 using namespace dcpomatic;
  56
  57
  58 /** Build a small DCP with no picture and a single subtitle overlaid onto it from a SubRip file */
  59 BOOST_AUTO_TEST_CASE (burnt_subtitle_test_subrip)
  60 {
  61         auto film = new_test_film ("burnt_subtitle_test_subrip");
  62         film->set_container (Ratio::from_id ("185"));
  63         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
  64         film->set_name ("frobozz");
  65         auto content = content_factory("test/data/subrip2.srt")[0];
  66         content->text[0]->set_use(true);
  67         content->text[0]->set_burn(true);
  68         film->examine_and_add_content (content);
  69         BOOST_REQUIRE (!wait_for_jobs());
  70         make_and_verify_dcp(
  71                 film,
  72                 { dcp::VerificationNote::Code::MISSING_CPL_METADATA }
  73                 );
  74
  75 #ifdef DCPOMATIC_WINDOWS
  76         check_dcp("test/data/windows/burnt_subtitle_test_subrip", film);
  77 #else
  78         check_dcp("test/data/burnt_subtitle_test_subrip", film);
  79 #endif
  80 }
  81
  82 /** Build a small DCP with no picture and a single subtitle overlaid onto it from a DCP XML file */
  83 BOOST_AUTO_TEST_CASE (burnt_subtitle_test_dcp)
  84 {
  85         auto film = new_test_film ("burnt_subtitle_test_dcp");
  86         film->set_container (Ratio::from_id ("185"));
  87         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
  88         film->set_name ("frobozz");
  89         auto content = content_factory("test/data/dcp_sub.xml")[0];
  90         content->text[0]->set_use(true);
  91         film->examine_and_add_content (content);
  92         BOOST_REQUIRE (!wait_for_jobs());
  93         make_and_verify_dcp(
  94                 film,
  95                 {
  96                         dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
  97                         dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
  98                         dcp::VerificationNote::Code::MISSING_CPL_METADATA
  99                 });
 100
 101         check_dcp("test/data/burnt_subtitle_test_dcp", film);
 102 }
 103
 104 /** Burn some subtitles into an existing DCP to check the colour conversion */
 105 BOOST_AUTO_TEST_CASE (burnt_subtitle_test_onto_dcp)
 106 {
 107         auto film = new_test_film ("burnt_subtitle_test_onto_dcp");
 108         film->set_container (Ratio::from_id ("185"));
 109         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 110         film->set_name ("frobozz");
 111         film->examine_and_add_content(content_factory("test/data/flat_black.png")[0]);
 112         BOOST_REQUIRE (!wait_for_jobs());
 113         make_and_verify_dcp (film);
 114
 115         Config::instance()->set_log_types (Config::instance()->log_types() | LogEntry::TYPE_DEBUG_ENCODE);
 116         auto film2 = new_test_film ("burnt_subtitle_test_onto_dcp2");
 117         film2->set_container (Ratio::from_id ("185"));
 118         film2->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 119         film2->set_name ("frobozz");
 120         auto background_dcp = make_shared<DCPContent>(film->dir(film->dcp_name()));
 121         film2->examine_and_add_content (background_dcp);
 122         auto sub = content_factory("test/data/subrip2.srt")[0];
 123         sub->text[0]->set_burn(true);
 124         sub->text[0]->set_effect(dcp::Effect::BORDER);
 125         film2->examine_and_add_content (sub);
 126         BOOST_REQUIRE (!wait_for_jobs());
 127         make_and_verify_dcp (film2);
 128
 129         BOOST_CHECK (background_dcp->position() == DCPTime());
 130         BOOST_CHECK (sub->position() == DCPTime());
 131
 132         dcp::DCP dcp (film2->dir (film2->dcp_name ()));
 133         dcp.read ();
 134         BOOST_REQUIRE_EQUAL(dcp.cpls().size(), 1U);
 135         BOOST_REQUIRE_EQUAL(dcp.cpls().front()->reels().size(), 1U);
 136         BOOST_REQUIRE (dcp.cpls().front()->reels().front()->main_picture());
 137         BOOST_REQUIRE (dcp.cpls().front()->reels().front()->main_picture()->asset());
 138         auto pic = dynamic_pointer_cast<dcp::ReelMonoPictureAsset> (
 139                 dcp.cpls().front()->reels().front()->main_picture()
 140                 )->mono_asset();
 141         BOOST_REQUIRE (pic);
 142         auto frame = pic->start_read()->get_frame(12);
 143         auto xyz = frame->xyz_image ();
 144         BOOST_CHECK_EQUAL (xyz->size().width, 1998);
 145         BOOST_CHECK_EQUAL (xyz->size().height, 1080);
 146
 147 #ifdef DCPOMATIC_WINDOWS
 148         check_dcp("test/data/windows/burnt_subtitle_test_onto_dcp2", film2);
 149 #else
 150         check_dcp("test/data/burnt_subtitle_test_onto_dcp2", film2);
 151 #endif
 152 }
 153
 154
 155
 156 /** Check positioning of some burnt subtitles from XML files */
 157 BOOST_AUTO_TEST_CASE(burnt_subtitle_test_position)
 158 {
 159         auto check = [](string alignment)
 160         {
 161                 auto const name = String::compose("burnt_subtitle_test_position_%1", alignment);
 162                 auto subs = content_factory(String::compose("test/data/burn_%1.xml", alignment));
 163                 auto film = new_test_film2(name, subs);
 164                 subs[0]->text[0]->set_use(true);
 165                 subs[0]->text[0]->set_burn(true);
 166                 make_and_verify_dcp(
 167                         film,
 168                         {
 169                                 dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
 170                                 dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
 171                                 dcp::VerificationNote::Code::MISSING_CPL_METADATA
 172                         });
 173
 174 #ifdef DCPOMATIC_WINDOWS
 175                 check_dcp(String::compose("test/data/windows/%1", name), film);
 176 #else
 177                 check_dcp(String::compose("test/data/%1", name), film);
 178 #endif
 179         };
 180
 181         /* Should have a baseline 216 pixels from the top (0.2 * 1080) */
 182         check("top");
 183         /* Should have a baseline 756 pixels from the top ((0.5 + 0.2) * 1080) */
 184         check("center");
 185         /* Should have a baseline 864 pixels from the top ((1 - 0.2) * 1080) */
 186         check("bottom");
 187 }
 188
 189
 190 /* Bug #2743 */
 191 BOOST_AUTO_TEST_CASE(burn_empty_subtitle_test)
 192 {
 193         Cleanup cl;
 194
 195         auto content = content_factory("test/data/empty_sub.xml")[0];
 196         auto film = new_test_film2("burnt_empty_subtitle_test", { content });
 197         content->text[0]->set_use(true);
 198
 199         auto job = make_shared<TranscodeJob>(film, TranscodeJob::ChangedBehaviour::IGNORE);
 200         auto file = boost::filesystem::path("build") / "test" / "burnt_empty_subtitle_test.mov";
 201         cl.add(file);
 202         FFmpegEncoder encoder(film, job, file, ExportFormat::PRORES_4444, false, false, false, 23);
 203         encoder.go();
 204
 205         cl.run();
 206 }
 207
 208