test/dcp_subtitle_test.cc

   1 /*
   2     Copyright (C) 2014-2016 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 /** @file  test/dcp_subtitle_test.cc
  22  *  @brief Test DCP subtitle content in various ways.
  23  *  @ingroup specific
  24  */
  25
  26 #include <boost/test/unit_test.hpp>
  27 #include "lib/film.h"
  28 #include "lib/dcp_subtitle_content.h"
  29 #include "lib/dcp_content.h"
  30 #include "lib/ratio.h"
  31 #include "lib/dcp_decoder.h"
  32 #include "lib/dcp_content_type.h"
  33 #include "lib/dcp_subtitle_decoder.h"
  34 #include "lib/subtitle_content.h"
  35 #include "lib/content_subtitle.h"
  36 #include "lib/subtitle_decoder.h"
  37 #include "test.h"
  38 #include <iostream>
  39
  40 using std::cout;
  41 using std::list;
  42 using boost::shared_ptr;
  43 using boost::optional;
  44
  45 optional<ContentTextSubtitle> stored;
  46
  47 static void
  48 store (ContentTextSubtitle sub)
  49 {
  50         stored = sub;
  51 }
  52
  53 /** Test pass-through of a very simple DCP subtitle file */
  54 BOOST_AUTO_TEST_CASE (dcp_subtitle_test)
  55 {
  56         shared_ptr<Film> film = new_test_film ("dcp_subtitle_test");
  57         film->set_container (Ratio::from_id ("185"));
  58         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
  59         film->set_name ("frobozz");
  60         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent (film, "test/data/dcp_sub.xml"));
  61         film->examine_and_add_content (content);
  62         wait_for_jobs ();
  63
  64         BOOST_CHECK_EQUAL (content->full_length().get(), DCPTime::from_seconds(2).get());
  65
  66         content->subtitle->set_use (true);
  67         content->subtitle->set_burn (false);
  68         film->make_dcp ();
  69         wait_for_jobs ();
  70
  71         check_dcp ("test/data/dcp_subtitle_test", film->dir (film->dcp_name ()));
  72 }
  73
  74 /** Test parsing of a subtitle within an existing DCP */
  75 BOOST_AUTO_TEST_CASE (dcp_subtitle_within_dcp_test)
  76 {
  77         shared_ptr<Film> film = new_test_film ("dcp_subtitle_within_dcp_test");
  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         shared_ptr<DCPContent> content (new DCPContent (film, private_data / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV"));
  82         film->examine_and_add_content (content);
  83         wait_for_jobs ();
  84
  85         shared_ptr<DCPDecoder> decoder (new DCPDecoder (content, film->log()));
  86         decoder->subtitle->TextData.connect (bind (store, _1));
  87
  88         stored = optional<ContentTextSubtitle> ();
  89         while (!decoder->pass() && !stored) {}
  90
  91         BOOST_REQUIRE (stored);
  92         BOOST_REQUIRE_EQUAL (stored->subs.size(), 2);
  93         BOOST_CHECK_EQUAL (stored->subs.front().text(), "Noch mal.");
  94         BOOST_CHECK_EQUAL (stored->subs.back().text(), "Encore une fois.");
  95 }
  96
  97 /** Test subtitles whose text includes things like &lt;b&gt; */
  98 BOOST_AUTO_TEST_CASE (dcp_subtitle_test2)
  99 {
 100         shared_ptr<Film> film = new_test_film ("dcp_subtitle_test2");
 101         film->set_container (Ratio::from_id ("185"));
 102         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 103         film->set_name ("frobozz");
 104         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent (film, "test/data/dcp_sub2.xml"));
 105         film->examine_and_add_content (content);
 106         wait_for_jobs ();
 107
 108         shared_ptr<DCPSubtitleDecoder> decoder (new DCPSubtitleDecoder (content, film->log()));
 109         decoder->subtitle->TextData.connect (bind (store, _1));
 110
 111         stored = optional<ContentTextSubtitle> ();
 112         while (!decoder->pass ()) {
 113                 if (stored && stored->period().from == ContentTime(0)) {
 114                         BOOST_CHECK_EQUAL (stored->subs.front().text(), "&lt;b&gt;Hello world!&lt;/b&gt;");
 115                 }
 116         }
 117 }
 118
 119 /** Test a failure case */
 120 BOOST_AUTO_TEST_CASE (dcp_subtitle_test3)
 121 {
 122         shared_ptr<Film> film = new_test_film ("dcp_subtitle_test3");
 123         film->set_container (Ratio::from_id ("185"));
 124         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 125         film->set_name ("frobozz");
 126         film->set_interop (true);
 127         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent (film, "test/data/dcp_sub3.xml"));
 128         film->examine_and_add_content (content);
 129         wait_for_jobs ();
 130
 131         film->make_dcp ();
 132         wait_for_jobs ();
 133
 134         shared_ptr<DCPSubtitleDecoder> decoder (new DCPSubtitleDecoder (content, film->log()));
 135         stored = optional<ContentTextSubtitle> ();
 136         while (!decoder->pass ()) {
 137                 decoder->subtitle->TextData.connect (bind (store, _1));
 138                 if (stored && stored->period().from == ContentTime::from_seconds(0.08)) {
 139                         list<dcp::SubtitleString> s = stored->subs;
 140                         list<dcp::SubtitleString>::const_iterator i = s.begin ();
 141                         BOOST_CHECK_EQUAL (i->text(), "This");
 142                         ++i;
 143                         BOOST_REQUIRE (i != s.end ());
 144                         BOOST_CHECK_EQUAL (i->text(), " is ");
 145                         ++i;
 146                         BOOST_REQUIRE (i != s.end ());
 147                         BOOST_CHECK_EQUAL (i->text(), "wrong.");
 148                         ++i;
 149                         BOOST_REQUIRE (i == s.end ());
 150                 }
 151         }
 152 }