Change video content scaling so that it either:
[dcpomatic.git] / test / dcp_subtitle_test.cc
index 0e5f2d6ad2b894c4cea765f98d56a3bb15779282..80dacbb473dc161fa43a6096e83c351e3ccd1a70 100644 (file)
@@ -1,24 +1,26 @@
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2019 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 /** @file  test/dcp_subtitle_test.cc
  *  @brief Test DCP subtitle content in various ways.
+ *  @ingroup specific
  */
 
 #include <boost/test/unit_test.hpp>
 #include "lib/ratio.h"
 #include "lib/dcp_decoder.h"
 #include "lib/dcp_content_type.h"
+#include "lib/dcp_subtitle_decoder.h"
+#include "lib/text_content.h"
+#include "lib/content_text.h"
+#include "lib/font.h"
+#include "lib/text_decoder.h"
 #include "test.h"
 #include <iostream>
 
 using std::cout;
 using std::list;
 using boost::shared_ptr;
+using boost::optional;
+using namespace dcpomatic;
+
+optional<ContentStringText> stored;
+
+static void
+store (ContentStringText sub)
+{
+       if (!stored) {
+               stored = sub;
+       } else {
+               BOOST_FOREACH (dcp::SubtitleString i, sub.subs) {
+                       stored->subs.push_back (i);
+               }
+       }
+}
 
 /** Test pass-through of a very simple DCP subtitle file */
 BOOST_AUTO_TEST_CASE (dcp_subtitle_test)
@@ -42,16 +65,17 @@ BOOST_AUTO_TEST_CASE (dcp_subtitle_test)
        film->set_container (Ratio::from_id ("185"));
        film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
        film->set_name ("frobozz");
-       shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent (film, "test/data/dcp_sub.xml"));
+       film->set_interop (false);
+       shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent ("test/data/dcp_sub.xml"));
        film->examine_and_add_content (content);
-       wait_for_jobs ();
+       BOOST_REQUIRE (!wait_for_jobs ());
 
-       BOOST_CHECK_EQUAL (content->full_length(), DCPTime::from_seconds (2));
+       BOOST_CHECK_EQUAL (content->full_length(film).get(), DCPTime::from_seconds(2).get());
 
-       content->set_use_subtitles (true);
-       content->set_burn_subtitles (false);
+       content->only_text()->set_use (true);
+       content->only_text()->set_burn (false);
        film->make_dcp ();
-       wait_for_jobs ();
+       BOOST_REQUIRE (!wait_for_jobs ());
 
        check_dcp ("test/data/dcp_subtitle_test", film->dir (film->dcp_name ()));
 }
@@ -63,37 +87,134 @@ BOOST_AUTO_TEST_CASE (dcp_subtitle_within_dcp_test)
        film->set_container (Ratio::from_id ("185"));
        film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
        film->set_name ("frobozz");
-       shared_ptr<DCPContent> content (new DCPContent (film, private_data / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV"));
+       shared_ptr<DCPContent> content (new DCPContent(TestPaths::private_data / "JourneyToJah_TLR-1_F_EN-DE-FR_CH_51_2K_LOK_20140225_DGL_SMPTE_OV"));
+       film->examine_and_add_content (content);
+       BOOST_REQUIRE (!wait_for_jobs ());
+
+       shared_ptr<DCPDecoder> decoder (new DCPDecoder (film, content, false, false, shared_ptr<DCPDecoder>()));
+       decoder->only_text()->PlainStart.connect (bind (store, _1));
+
+       stored = optional<ContentStringText> ();
+       while (!decoder->pass() && !stored) {}
+
+       BOOST_REQUIRE (stored);
+       BOOST_REQUIRE_EQUAL (stored->subs.size(), 2);
+       BOOST_CHECK_EQUAL (stored->subs.front().text(), "Noch mal.");
+       BOOST_CHECK_EQUAL (stored->subs.back().text(), "Encore une fois.");
+}
+
+/** Test subtitles whose text includes things like &lt;b&gt; */
+BOOST_AUTO_TEST_CASE (dcp_subtitle_test2)
+{
+       shared_ptr<Film> film = new_test_film ("dcp_subtitle_test2");
+       film->set_container (Ratio::from_id ("185"));
+       film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
+       film->set_name ("frobozz");
+       shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent("test/data/dcp_sub2.xml"));
+       film->examine_and_add_content (content);
+       BOOST_REQUIRE (!wait_for_jobs ());
+
+       shared_ptr<DCPSubtitleDecoder> decoder (new DCPSubtitleDecoder(film, content));
+       decoder->only_text()->PlainStart.connect (bind (store, _1));
+
+       stored = optional<ContentStringText> ();
+       while (!decoder->pass()) {
+               if (stored && stored->from() == ContentTime(0)) {
+                       BOOST_CHECK_EQUAL (stored->subs.front().text(), "&lt;b&gt;Hello world!&lt;/b&gt;");
+               }
+       }
+}
+
+/** Test a failure case */
+BOOST_AUTO_TEST_CASE (dcp_subtitle_test3)
+{
+       shared_ptr<Film> film = new_test_film ("dcp_subtitle_test3");
+       film->set_container (Ratio::from_id ("185"));
+       film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TLR"));
+       film->set_name ("frobozz");
+       film->set_interop (true);
+       shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent ("test/data/dcp_sub3.xml"));
        film->examine_and_add_content (content);
-       wait_for_jobs ();
-
-       shared_ptr<DCPDecoder> decoder (new DCPDecoder (content, false));
-
-       list<ContentTimePeriod> ctp = decoder->text_subtitles_during (
-               ContentTimePeriod (
-                       ContentTime::from_seconds (25),
-                       ContentTime::from_seconds (26)
-                       ),
-               true
-               );
-
-       BOOST_REQUIRE_EQUAL (ctp.size(), 2);
-       BOOST_CHECK_EQUAL (ctp.front().from, ContentTime::from_seconds (25 + 12 * 0.04));
-       BOOST_CHECK_EQUAL (ctp.front().to, ContentTime::from_seconds (26 + 4 * 0.04));
-       BOOST_CHECK_EQUAL (ctp.back().from, ContentTime::from_seconds (25 + 12 * 0.04));
-       BOOST_CHECK_EQUAL (ctp.back().to, ContentTime::from_seconds (26 + 4 * 0.04));
-
-       list<ContentTextSubtitle> subs = decoder->get_text_subtitles (
-               ContentTimePeriod (
-                       ContentTime::from_seconds (25),
-                       ContentTime::from_seconds (26)
-                       ),
-               true,
-               true
-               );
-
-       BOOST_REQUIRE_EQUAL (subs.size(), 1);
-       BOOST_REQUIRE_EQUAL (subs.front().subs.size(), 2);
-       BOOST_CHECK_EQUAL (subs.front().subs.front().text(), "Noch mal.");
-       BOOST_CHECK_EQUAL (subs.front().subs.back().text(), "Encore une fois.");
+       BOOST_REQUIRE (!wait_for_jobs ());
+
+       film->make_dcp ();
+       BOOST_REQUIRE (!wait_for_jobs ());
+
+       shared_ptr<DCPSubtitleDecoder> decoder (new DCPSubtitleDecoder (film, content));
+       stored = optional<ContentStringText> ();
+       while (!decoder->pass ()) {
+               decoder->only_text()->PlainStart.connect (bind (store, _1));
+               if (stored && stored->from() == ContentTime::from_seconds(0.08)) {
+                       list<dcp::SubtitleString> s = stored->subs;
+                       list<dcp::SubtitleString>::const_iterator i = s.begin ();
+                       BOOST_CHECK_EQUAL (i->text(), "This");
+                       ++i;
+                       BOOST_REQUIRE (i != s.end ());
+                       BOOST_CHECK_EQUAL (i->text(), " is ");
+                       ++i;
+                       BOOST_REQUIRE (i != s.end ());
+                       BOOST_CHECK_EQUAL (i->text(), "wrong.");
+                       ++i;
+                       BOOST_REQUIRE (i == s.end ());
+               }
+       }
+}
+
+/** Check that Interop DCPs aren't made with more than one <LoadFont> (#1273) */
+BOOST_AUTO_TEST_CASE (dcp_subtitle_test4)
+{
+       shared_ptr<Film> film = new_test_film2 ("dcp_subtitle_test4");
+       film->set_interop (true);
+
+       shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent ("test/data/dcp_sub3.xml"));
+       film->examine_and_add_content (content);
+       shared_ptr<DCPSubtitleContent> content2 (new DCPSubtitleContent ("test/data/dcp_sub3.xml"));
+       film->examine_and_add_content (content2);
+       BOOST_REQUIRE (!wait_for_jobs ());
+
+       content->only_text()->add_font (shared_ptr<Font> (new Font ("font1")));
+       content2->only_text()->add_font (shared_ptr<Font> (new Font ("font2")));
+
+       film->make_dcp ();
+       BOOST_REQUIRE (!wait_for_jobs ());
+
+       cxml::Document doc ("DCSubtitle");
+       doc.read_file (subtitle_file (film));
+       BOOST_REQUIRE_EQUAL (doc.node_children("LoadFont").size(), 1);
+}
+
+static
+void
+check_font_tags (list<cxml::NodePtr> nodes)
+{
+       BOOST_FOREACH (cxml::NodePtr i, nodes) {
+               if (i->name() == "Font") {
+                       BOOST_CHECK (!i->optional_string_attribute("Id") || i->string_attribute("Id") != "");
+               }
+               check_font_tags (i->node_children());
+       }
+}
+
+/** Check that imported <LoadFont> tags with empty IDs (or corresponding Font tags with empty IDs)
+ *  are not passed through into the DCP.
+ */
+BOOST_AUTO_TEST_CASE (dcp_subtitle_test5)
+{
+       shared_ptr<Film> film = new_test_film2 ("dcp_subtitle_test5");
+       film->set_interop (true);
+
+       shared_ptr<DCPSubtitleContent> content (new DCPSubtitleContent("test/data/dcp_sub6.xml"));
+       film->examine_and_add_content (content);
+       BOOST_REQUIRE (!wait_for_jobs());
+
+       film->make_dcp ();
+       BOOST_REQUIRE (!wait_for_jobs());
+       film->write_metadata ();
+
+       cxml::Document doc ("DCSubtitle");
+       doc.read_file (subtitle_file(film));
+       BOOST_REQUIRE_EQUAL (doc.node_children("LoadFont").size(), 1);
+       BOOST_CHECK (doc.node_children("LoadFont").front()->string_attribute("Id") != "");
+
+       check_font_tags (doc.node_children());
 }