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
  43 /** Test pass-through of a very simple DCP subtitle file */
  44 BOOST_AUTO_TEST_CASE (dcp_subtitle_test)
  45 {
  46         shared_ptr<Film> film = new_test_film ("dcp_subtitle_test");
  47         film->set_container (Ratio::from_id ("185"));
  48         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
  49         film->set_name ("frobozz");
  50         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent (film, "test/data/dcp_sub.xml"));
  51         film->examine_and_add_content (content);
  52         wait_for_jobs ();
  53
  54         BOOST_CHECK_EQUAL (content->full_length().get(), DCPTime::from_seconds(2).get());
  55
  56         content->subtitle->set_use (true);
  57         content->subtitle->set_burn (false);
  58         film->make_dcp ();
  59         wait_for_jobs ();
  60
  61         check_dcp ("test/data/dcp_subtitle_test", film->dir (film->dcp_name ()));
  62 }
  63
  64 /** Test parsing of a subtitle within an existing DCP */
  65 BOOST_AUTO_TEST_CASE (dcp_subtitle_within_dcp_test)
  66 {
  67         shared_ptr<Film> film = new_test_film ("dcp_subtitle_within_dcp_test");
  68         film->set_container (Ratio::from_id ("185"));
  69         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
  70         film->set_name ("frobozz");
  71         shared_ptr<DCPContent> content (new DCPContent (film, private_data / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV"));
  72         film->examine_and_add_content (content);
  73         wait_for_jobs ();
  74
  75         shared_ptr<DCPDecoder> decoder (new DCPDecoder (content, film->log()));
  76
  77         list<ContentTimePeriod> ctp = decoder->text_subtitles_during (
  78                 ContentTimePeriod (
  79                         ContentTime::from_seconds (25),
  80                         ContentTime::from_seconds (26)
  81                         ),
  82                 true
  83                 );
  84
  85         BOOST_REQUIRE_EQUAL (ctp.size(), 2);
  86         BOOST_CHECK_EQUAL (ctp.front().from.get(), ContentTime::from_seconds(25 + 12 * 0.04).get());
  87         BOOST_CHECK_EQUAL (ctp.front().to.get(), ContentTime::from_seconds(26 + 4 * 0.04).get());
  88         BOOST_CHECK_EQUAL (ctp.back().from.get(), ContentTime::from_seconds(25 + 12 * 0.04).get());
  89         BOOST_CHECK_EQUAL (ctp.back().to.get(), ContentTime::from_seconds(26 + 4 * 0.04).get());
  90
  91         list<ContentTextSubtitle> subs = decoder->subtitle->get_text (
  92                 ContentTimePeriod (
  93                         ContentTime::from_seconds (25),
  94                         ContentTime::from_seconds (26)
  95                         ),
  96                 true,
  97                 true
  98                 );
  99
 100         BOOST_REQUIRE_EQUAL (subs.size(), 1);
 101         BOOST_REQUIRE_EQUAL (subs.front().subs.size(), 2);
 102         BOOST_CHECK_EQUAL (subs.front().subs.front().text(), "Noch mal.");
 103         BOOST_CHECK_EQUAL (subs.front().subs.back().text(), "Encore une fois.");
 104 }
 105
 106 /** Test subtitles whose text includes things like &lt;b&gt; */
 107 BOOST_AUTO_TEST_CASE (dcp_subtitle_test2)
 108 {
 109         shared_ptr<Film> film = new_test_film ("dcp_subtitle_test2");
 110         film->set_container (Ratio::from_id ("185"));
 111         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
 112         film->set_name ("frobozz");
 113         shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent (film, "test/data/dcp_sub2.xml"));
 114         film->examine_and_add_content (content);
 115         wait_for_jobs ();
 116
 117         shared_ptr<DCPSubtitleDecoder> decoder (new DCPSubtitleDecoder (content));
 118         list<ContentTextSubtitle> sub = decoder->subtitle->get_text (
 119                 ContentTimePeriod (ContentTime::from_seconds(0), ContentTime::from_seconds(2)), true, true
 120                 );
 121         BOOST_REQUIRE_EQUAL (sub.size(), 1);
 122         BOOST_REQUIRE_EQUAL (sub.front().subs.size(), 1);
 123         BOOST_CHECK_EQUAL (sub.front().subs.front().text(), "&lt;b&gt;Hello world!&lt;/b&gt;");
 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));
 142         list<ContentTextSubtitle> sub = decoder->subtitle->get_text (
 143                 ContentTimePeriod (ContentTime::from_seconds(0), ContentTime::from_seconds(2)), true, true
 144                 );
 145         BOOST_REQUIRE_EQUAL (sub.size(), 1);
 146         BOOST_REQUIRE_EQUAL (sub.front().subs.size(), 3);
 147         list<dcp::SubtitleString> s = sub.front().subs;
 148         list<dcp::SubtitleString>::const_iterator i = s.begin ();
 149         BOOST_CHECK_EQUAL (i->text(), "This");
 150         ++i;
 151         BOOST_REQUIRE (i != s.end ());
 152         BOOST_CHECK_EQUAL (i->text(), " is ");
 153         ++i;
 154         BOOST_REQUIRE (i != s.end ());
 155         BOOST_CHECK_EQUAL (i->text(), "wrong.");
 156         ++i;
 157         BOOST_REQUIRE (i == s.end ());
 158 }