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         if (!stored) {
  51                 stored = sub;
  52         } else {
  53                 BOOST_FOREACH (dcp::SubtitleString i, sub.subs) {
  54                         stored->subs.push_back (i);
  55                 }
  56         }
  57 }
  58
  59 /** Test pass-through of a very simple DCP subtitle file */
  60 BOOST_AUTO_TEST_CASE (dcp_subtitle_test)
  61 {
  62         shared_ptr<Film> film = new_test_film ("dcp_subtitle_test");
  63         film->set_container (Ratio::from_id ("185"));
  64         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
  65         film->set_name ("frobozz");
  66         film->set_interop (false);
  67         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent (film, "test/data/dcp_sub.xml"));
  68         film->examine_and_add_content (content);
  69         wait_for_jobs ();
  70
  71         BOOST_CHECK_EQUAL (content->full_length().get(), DCPTime::from_seconds(2).get());
  72
  73         content->subtitle->set_use (true);
  74         content->subtitle->set_burn (false);
  75         film->make_dcp ();
  76         wait_for_jobs ();
  77
  78         check_dcp ("test/data/dcp_subtitle_test", film->dir (film->dcp_name ()));
  79 }
  80
  81 /** Test parsing of a subtitle within an existing DCP */
  82 BOOST_AUTO_TEST_CASE (dcp_subtitle_within_dcp_test)
  83 {
  84         shared_ptr<Film> film = new_test_film ("dcp_subtitle_within_dcp_test");
  85         film->set_container (Ratio::from_id ("185"));
  86         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
  87         film->set_name ("frobozz");
  88         shared_ptr<DCPContent> content (new DCPContent (film, private_data / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV"));
  89         film->examine_and_add_content (content);
  90         wait_for_jobs ();
  91
  92         shared_ptr<DCPDecoder> decoder (new DCPDecoder (content, film->log(), false));
  93         decoder->subtitle->TextStart.connect (bind (store, _1));
  94
  95         stored = optional<ContentTextSubtitle> ();
  96         while (!decoder->pass() && !stored) {}
  97
  98         BOOST_REQUIRE (stored);
  99         BOOST_REQUIRE_EQUAL (stored->subs.size(), 2);
 100         BOOST_CHECK_EQUAL (stored->subs.front().text(), "Noch mal.");
 101         BOOST_CHECK_EQUAL (stored->subs.back().text(), "Encore une fois.");
 102 }
 103
 104 /** Test subtitles whose text includes things like &lt;b&gt; */
 105 BOOST_AUTO_TEST_CASE (dcp_subtitle_test2)
 106 {
 107         shared_ptr<Film> film = new_test_film ("dcp_subtitle_test2");
 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         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent (film, "test/data/dcp_sub2.xml"));
 112         film->examine_and_add_content (content);
 113         wait_for_jobs ();
 114
 115         shared_ptr<DCPSubtitleDecoder> decoder (new DCPSubtitleDecoder (content, film->log()));
 116         decoder->subtitle->TextStart.connect (bind (store, _1));
 117
 118         stored = optional<ContentTextSubtitle> ();
 119         while (!decoder->pass ()) {
 120                 if (stored && stored->from() == ContentTime(0)) {
 121                         BOOST_CHECK_EQUAL (stored->subs.front().text(), "&lt;b&gt;Hello world!&lt;/b&gt;");
 122                 }
 123         }
 124 }
 125
 126 /** Test a failure case */
 127 BOOST_AUTO_TEST_CASE (dcp_subtitle_test3)
 128 {
 129         shared_ptr<Film> film = new_test_film ("dcp_subtitle_test3");
 130         film->set_container (Ratio::from_id ("185"));
 131         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 132         film->set_name ("frobozz");
 133         film->set_interop (true);
 134         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent (film, "test/data/dcp_sub3.xml"));
 135         film->examine_and_add_content (content);
 136         wait_for_jobs ();
 137
 138         film->make_dcp ();
 139         wait_for_jobs ();
 140
 141         shared_ptr<DCPSubtitleDecoder> decoder (new DCPSubtitleDecoder (content, film->log()));
 142         stored = optional<ContentTextSubtitle> ();
 143         while (!decoder->pass ()) {
 144                 decoder->subtitle->TextStart.connect (bind (store, _1));
 145                 if (stored && stored->from() == ContentTime::from_seconds(0.08)) {
 146                         list<dcp::SubtitleString> s = stored->subs;
 147                         list<dcp::SubtitleString>::const_iterator i = s.begin ();
 148                         BOOST_CHECK_EQUAL (i->text(), "This");
 149                         ++i;
 150                         BOOST_REQUIRE (i != s.end ());
 151                         BOOST_CHECK_EQUAL (i->text(), " is ");
 152                         ++i;
 153                         BOOST_REQUIRE (i != s.end ());
 154                         BOOST_CHECK_EQUAL (i->text(), "wrong.");
 155                         ++i;
 156                         BOOST_REQUIRE (i == s.end ());
 157                 }
 158         }
 159 }