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