X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Ftext_content.cc;h=a85b271a88d23dbfca216491e5777e701c720f03;hb=1266a5149e056a17b4a9276ccf6ea4a79cc93610;hp=ee29ae8c4d28122c6dfeafc2838906a48bf4c0d8;hpb=f80740363455d4c78f4132f9e58006a84034b9d0;p=dcpomatic.git

diff --git a/src/lib/text_content.cc b/src/lib/text_content.cc
index ee29ae8c4..a85b271a8 100644
--- a/src/lib/text_content.cc
+++ b/src/lib/text_content.cc
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -18,6 +18,7 @@
 
 */
 
+
 #include "text_content.h"
 #include "util.h"
 #include "exceptions.h"
@@ -26,19 +27,22 @@
 #include <dcp/raw_convert.h>
 #include <libcxml/cxml.h>
 #include <libxml++/libxml++.h>
-#include <boost/foreach.hpp>
 #include <iostream>
 
 #include "i18n.h"
 
+
 using std::string;
 using std::vector;
 using std::cout;
 using std::list;
-using boost::shared_ptr;
-using boost::dynamic_pointer_cast;
+using std::shared_ptr;
+using std::make_shared;
+using std::dynamic_pointer_cast;
 using boost::optional;
 using dcp::raw_convert;
+using namespace dcpomatic;
+
 
 int const TextContentProperty::X_OFFSET = 500;
 int const TextContentProperty::Y_OFFSET = 501;
@@ -46,16 +50,19 @@ int const TextContentProperty::X_SCALE = 502;
 int const TextContentProperty::Y_SCALE = 503;
 int const TextContentProperty::USE = 504;
 int const TextContentProperty::BURN = 505;
-int const TextContentProperty::LANGUAGE = 506;
-int const TextContentProperty::FONTS = 507;
-int const TextContentProperty::COLOUR = 508;
-int const TextContentProperty::EFFECT = 509;
-int const TextContentProperty::EFFECT_COLOUR = 510;
-int const TextContentProperty::LINE_SPACING = 511;
-int const TextContentProperty::FADE_IN = 512;
-int const TextContentProperty::FADE_OUT = 513;
-int const TextContentProperty::OUTLINE_WIDTH = 514;
-int const TextContentProperty::TYPE = 515;
+int const TextContentProperty::FONTS = 506;
+int const TextContentProperty::COLOUR = 507;
+int const TextContentProperty::EFFECT = 508;
+int const TextContentProperty::EFFECT_COLOUR = 509;
+int const TextContentProperty::LINE_SPACING = 510;
+int const TextContentProperty::FADE_IN = 511;
+int const TextContentProperty::FADE_OUT = 512;
+int const TextContentProperty::OUTLINE_WIDTH = 513;
+int const TextContentProperty::TYPE = 514;
+int const TextContentProperty::DCP_TRACK = 515;
+int const TextContentProperty::LANGUAGE = 516;
+int const TextContentProperty::LANGUAGE_IS_ADDITIONAL = 517;
+
 
 TextContent::TextContent (Content* parent, TextType type, TextType original_type)
 	: ContentPart (parent)
@@ -66,7 +73,7 @@ TextContent::TextContent (Content* parent, TextType type, TextType original_type
 	, _x_scale (1)
 	, _y_scale (1)
 	, _line_spacing (1)
-	, _outline_width (2)
+	, _outline_width (4)
 	, _type (type)
 	, _original_type (original_type)
 {
@@ -76,15 +83,15 @@ TextContent::TextContent (Content* parent, TextType type, TextType original_type
 /** @return TextContents from node or <Text> nodes under node (according to version).
  *  The list could be empty if no TextContents are found.
  */
-list<shared_ptr<TextContent> >
-TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
+list<shared_ptr<TextContent>>
+TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version, list<string>& notes)
 {
 	if (version < 34) {
 		/* With old metadata FFmpeg content has the subtitle-related tags even with no
 		   subtitle streams, so check for that.
 		*/
 		if (node->string_child("Type") == "FFmpeg" && node->node_children("SubtitleStream").empty()) {
-			return list<shared_ptr<TextContent> >();
+			return {};
 		}
 
 		/* Otherwise we can drop through to the newer logic */
@@ -92,25 +99,20 @@ TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
 
 	if (version < 37) {
 		if (!node->optional_number_child<double>("SubtitleXOffset") && !node->optional_number_child<double>("SubtitleOffset")) {
-			return list<shared_ptr<TextContent> >();
+			return {};
 		}
-		list<shared_ptr<TextContent> > c;
-		c.push_back (shared_ptr<TextContent> (new TextContent (parent, node, version)));
-		return c;
+		return { make_shared<TextContent>(parent, node, version, notes) };
 	}
 
-	if (!node->optional_node_child("Text")) {
-		return list<shared_ptr<TextContent> >();
+	list<shared_ptr<TextContent>> c;
+	for (auto i: node->node_children("Text")) {
+		c.push_back (make_shared<TextContent>(parent, i, version, notes));
 	}
 
-	list<shared_ptr<TextContent> > c;
-	BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Text")) {
-		c.push_back (shared_ptr<TextContent> (new TextContent (parent, i, version)));
-	}
 	return c;
 }
 
-TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
+TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version, list<string>& notes)
 	: ContentPart (parent)
 	, _use (false)
 	, _burn (false)
@@ -118,10 +120,10 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
 	, _y_offset (0)
 	, _x_scale (1)
 	, _y_scale (1)
-	, _line_spacing (node->optional_number_child<double>("LineSpacing").get_value_or (1))
-	, _outline_width (node->optional_number_child<int>("OutlineWidth").get_value_or (2))
-	, _type (TEXT_OPEN_SUBTITLE)
-	, _original_type (TEXT_OPEN_SUBTITLE)
+	, _line_spacing (node->optional_number_child<double>("LineSpacing").get_value_or(1))
+	, _outline_width (node->optional_number_child<int>("OutlineWidth").get_value_or(4))
+	, _type (TextType::OPEN_SUBTITLE)
+	, _original_type (TextType::OPEN_SUBTITLE)
 {
 	if (version >= 37) {
 		_use = node->bool_child ("Use");
@@ -142,21 +144,21 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
 	}
 
 	if (node->optional_bool_child("Outline").get_value_or(false)) {
-		_effect = dcp::BORDER;
+		_effect = dcp::Effect::BORDER;
 	} else if (node->optional_bool_child("Shadow").get_value_or(false)) {
-		_effect = dcp::SHADOW;
+		_effect = dcp::Effect::SHADOW;
 	} else {
-		_effect = dcp::NONE;
+		_effect = dcp::Effect::NONE;
 	}
 
-	optional<string> effect = node->optional_string_child("Effect");
+	auto effect = node->optional_string_child("Effect");
 	if (effect) {
 		if (*effect == "none") {
-			_effect = dcp::NONE;
+			_effect = dcp::Effect::NONE;
 		} else if (*effect == "outline") {
-			_effect = dcp::BORDER;
+			_effect = dcp::Effect::BORDER;
 		} else if (*effect == "shadow") {
-			_effect = dcp::SHADOW;
+			_effect = dcp::Effect::SHADOW;
 		}
 	}
 
@@ -170,17 +172,17 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
 		_x_scale = _y_scale = node->number_child<double> ("SubtitleScale");
 	}
 
-	optional<int> r = node->optional_number_child<int>("Red");
-	optional<int> g = node->optional_number_child<int>("Green");
-	optional<int> b = node->optional_number_child<int>("Blue");
+	auto r = node->optional_number_child<int>("Red");
+	auto g = node->optional_number_child<int>("Green");
+	auto b = node->optional_number_child<int>("Blue");
 	if (r && g && b) {
 		_colour = dcp::Colour (*r, *g, *b);
 	}
 
 	if (version >= 36) {
-		optional<int> er = node->optional_number_child<int>("EffectRed");
-		optional<int> eg = node->optional_number_child<int>("EffectGreen");
-		optional<int> eb = node->optional_number_child<int>("EffectBlue");
+		auto er = node->optional_number_child<int>("EffectRed");
+		auto eg = node->optional_number_child<int>("EffectGreen");
+		auto eb = node->optional_number_child<int>("EffectBlue");
 		if (er && eg && eb) {
 			_effect_colour = dcp::Colour (*er, *eg, *eb);
 		}
@@ -212,15 +214,8 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
 		_fade_out = ContentTime (*fo);
 	}
 
-	if (version >= 37) {
-		_language = node->optional_string_child ("Language").get_value_or ("");
-	} else {
-		_language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
-	}
-
-	list<cxml::NodePtr> fonts = node->node_children ("Font");
-	for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
-		_fonts.push_back (shared_ptr<Font> (new Font (*i)));
+	for (auto i: node->node_children ("Font")) {
+		_fonts.push_back (make_shared<Font>(i));
 	}
 
 	connect_to_fonts ();
@@ -231,17 +226,44 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
 			_original_type = string_to_text_type (node->optional_string_child("OriginalType").get());
 		}
 	}
+
+	auto dt = node->optional_node_child("DCPTrack");
+	if (dt) {
+		_dcp_track = DCPTextTrack (dt);
+	}
+
+	auto lang = node->optional_node_child("Language");
+	if (lang) {
+		try {
+			_language = dcp::LanguageTag(lang->content());
+			auto add = lang->optional_bool_attribute("Additional");
+			_language_is_additional = add && *add;
+		} catch (dcp::LanguageTagError&) {
+			/* The language tag can be empty or invalid if it was loaded from a
+			 * 2.14.x metadata file; we'll just ignore it in that case.
+			 */
+			if (version <= 37) {
+				if (!lang->content().empty()) {
+					notes.push_back (String::compose(
+						_("A subtitle or closed caption file in this project is marked with the language '%1', "
+						  "which DCP-o-matic does not recognise.  The file's language has been cleared."), lang->content()));
+				}
+			} else {
+				throw;
+			}
+		}
+	}
 }
 
-TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
+TextContent::TextContent (Content* parent, vector<shared_ptr<Content>> c)
 	: ContentPart (parent)
 {
 	/* This constructor is for join which is only supported for content types
 	   that have a single text, so we can use only_text() here.
 	*/
-	shared_ptr<TextContent> ref = c[0]->only_text();
+	auto ref = c[0]->only_text();
 	DCPOMATIC_ASSERT (ref);
-	list<shared_ptr<Font> > ref_fonts = ref->fonts ();
+	auto ref_fonts = ref->fonts ();
 
 	for (size_t i = 1; i < c.size(); ++i) {
 
@@ -281,13 +303,25 @@ TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
 			throw JoinError (_("Content to be joined must have the same outline width."));
 		}
 
-		list<shared_ptr<Font> > fonts = c[i]->only_text()->fonts ();
+		auto fonts = c[i]->only_text()->fonts ();
 		if (fonts.size() != ref_fonts.size()) {
 			throw JoinError (_("Content to be joined must use the same fonts."));
 		}
 
-		list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
-		list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
+		if (c[i]->only_text()->dcp_track() != ref->dcp_track()) {
+			throw JoinError (_("Content to be joined must use the same DCP track."));
+		}
+
+		if (c[i]->only_text()->language() != ref->language()) {
+			throw JoinError (_("Content to be joined must use the same text language."));
+		}
+
+		if (c[i]->only_text()->language_is_additional() != ref->language_is_additional()) {
+			throw JoinError (_("Content to be joined must both be main subtitle languages or both additional."));
+		}
+
+		auto j = ref_fonts.begin ();
+		auto k = fonts.begin ();
 
 		while (j != ref_fonts.end ()) {
 			if (**j != **k) {
@@ -304,7 +338,6 @@ TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
 	_y_offset = ref->y_offset ();
 	_x_scale = ref->x_scale ();
 	_y_scale = ref->y_scale ();
-	_language = ref->language ();
 	_fonts = ref_fonts;
 	_line_spacing = ref->line_spacing ();
 	_fade_in = ref->fade_in ();
@@ -312,6 +345,9 @@ TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
 	_outline_width = ref->outline_width ();
 	_type = ref->type ();
 	_original_type = ref->original_type ();
+	_dcp_track = ref->dcp_track ();
+	_language = ref->language ();
+	_language_is_additional = ref->language_is_additional ();
 
 	connect_to_fonts ();
 }
@@ -322,7 +358,7 @@ TextContent::as_xml (xmlpp::Node* root) const
 {
 	boost::mutex::scoped_lock lm (_mutex);
 
-	xmlpp::Element* text = root->add_child ("Text");
+	auto text = root->add_child ("Text");
 
 	text->add_child("Use")->add_child_text (_use ? "1" : "0");
 	text->add_child("Burn")->add_child_text (_burn ? "1" : "0");
@@ -330,7 +366,6 @@ TextContent::as_xml (xmlpp::Node* root) const
 	text->add_child("YOffset")->add_child_text (raw_convert<string> (_y_offset));
 	text->add_child("XScale")->add_child_text (raw_convert<string> (_x_scale));
 	text->add_child("YScale")->add_child_text (raw_convert<string> (_y_scale));
-	text->add_child("Language")->add_child_text (_language);
 	if (_colour) {
 		text->add_child("Red")->add_child_text (raw_convert<string> (_colour->r));
 		text->add_child("Green")->add_child_text (raw_convert<string> (_colour->g));
@@ -338,13 +373,13 @@ TextContent::as_xml (xmlpp::Node* root) const
 	}
 	if (_effect) {
 		switch (*_effect) {
-		case dcp::NONE:
+		case dcp::Effect::NONE:
 			text->add_child("Effect")->add_child_text("none");
 			break;
-		case dcp::BORDER:
+		case dcp::Effect::BORDER:
 			text->add_child("Effect")->add_child_text("outline");
 			break;
-		case dcp::SHADOW:
+		case dcp::Effect::SHADOW:
 			text->add_child("Effect")->add_child_text("shadow");
 			break;
 		}
@@ -363,18 +398,26 @@ TextContent::as_xml (xmlpp::Node* root) const
 	}
 	text->add_child("OutlineWidth")->add_child_text (raw_convert<string> (_outline_width));
 
-	for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
-		(*i)->as_xml (text->add_child("Font"));
+	for (auto i: _fonts) {
+		i->as_xml (text->add_child("Font"));
 	}
 
 	text->add_child("Type")->add_child_text (text_type_to_string(_type));
 	text->add_child("OriginalType")->add_child_text (text_type_to_string(_original_type));
+	if (_dcp_track) {
+		_dcp_track->as_xml(text->add_child("DCPTrack"));
+	}
+	if (_language) {
+		auto lang = text->add_child("Language");
+		lang->add_child_text (_language->to_string());
+		lang->set_attribute ("Additional", _language_is_additional ? "1" : "0");
+	}
 }
 
 string
 TextContent::identifier () const
 {
-	string s = raw_convert<string> (x_scale())
+	auto s = raw_convert<string> (x_scale())
 		+ "_" + raw_convert<string> (y_scale())
 		+ "_" + raw_convert<string> (x_offset())
 		+ "_" + raw_convert<string> (y_offset())
@@ -383,21 +426,18 @@ TextContent::identifier () const
 		+ "_" + raw_convert<string> (fade_out().get_value_or(ContentTime()).get())
 		+ "_" + raw_convert<string> (outline_width())
 		+ "_" + raw_convert<string> (colour().get_value_or(dcp::Colour(255, 255, 255)).to_argb_string())
-		+ "_" + raw_convert<string> (dcp::effect_to_string(effect().get_value_or(dcp::NONE)))
-		+ "_" + raw_convert<string> (effect_colour().get_value_or(dcp::Colour(0, 0, 0)).to_argb_string());
+		+ "_" + raw_convert<string> (dcp::effect_to_string(effect().get_value_or(dcp::Effect::NONE)))
+		+ "_" + raw_convert<string> (effect_colour().get_value_or(dcp::Colour(0, 0, 0)).to_argb_string())
+		+ "_" + raw_convert<string> (_parent->video_frame_rate().get_value_or(0));
 
 	/* XXX: I suppose really _fonts shouldn't be in here, since not all
 	   types of subtitle content involve fonts.
 	*/
-	BOOST_FOREACH (shared_ptr<Font> f, _fonts) {
-		for (int i = 0; i < FontFiles::VARIANTS; ++i) {
-			s += "_" + f->file(static_cast<FontFiles::Variant>(i)).get_value_or("Default").string();
-		}
+	for (auto f: _fonts) {
+		s += "_" + f->file().get_value_or("Default").string();
 	}
 
-	/* The language is for metadata only, and doesn't affect
-	   how this content looks.
-	*/
+	/* The DCP track and language are for metadata only, and don't affect how this content looks */
 
 	return s;
 }
@@ -405,6 +445,9 @@ TextContent::identifier () const
 void
 TextContent::add_font (shared_ptr<Font> font)
 {
+	boost::mutex::scoped_lock lm(_mutex);
+
+	DCPOMATIC_ASSERT(!get_font_unlocked(font->id()));
 	_fonts.push_back (font);
 	connect_to_fonts ();
 }
@@ -412,13 +455,13 @@ TextContent::add_font (shared_ptr<Font> font)
 void
 TextContent::connect_to_fonts ()
 {
-	BOOST_FOREACH (boost::signals2::connection& i, _font_connections) {
+	for (auto const& i: _font_connections) {
 		i.disconnect ();
 	}
 
 	_font_connections.clear ();
 
-	BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
+	for (auto i: _fonts) {
 		_font_connections.push_back (i->Changed.connect (boost::bind (&TextContent::font_changed, this)));
 	}
 }
@@ -426,7 +469,8 @@ TextContent::connect_to_fonts ()
 void
 TextContent::font_changed ()
 {
-	_parent->signal_changed (TextContentProperty::FONTS);
+	/* XXX: too late */
+	ContentChangeSignaller cc (_parent, TextContentProperty::FONTS);
 }
 
 void
@@ -501,12 +545,6 @@ TextContent::set_y_scale (double s)
 	maybe_set (_y_scale, s, TextContentProperty::Y_SCALE);
 }
 
-void
-TextContent::set_language (string language)
-{
-	maybe_set (_language, language, TextContentProperty::LANGUAGE);
-}
-
 void
 TextContent::set_line_spacing (double s)
 {
@@ -549,6 +587,30 @@ TextContent::set_outline_width (int w)
 	maybe_set (_outline_width, w, TextContentProperty::OUTLINE_WIDTH);
 }
 
+void
+TextContent::set_dcp_track (DCPTextTrack t)
+{
+	maybe_set (_dcp_track, t, TextContentProperty::DCP_TRACK);
+}
+
+void
+TextContent::unset_dcp_track ()
+{
+	maybe_set (_dcp_track, optional<DCPTextTrack>(), TextContentProperty::DCP_TRACK);
+}
+
+void
+TextContent::set_language (optional<dcp::LanguageTag> language)
+{
+	maybe_set (_language, language, TextContentProperty::LANGUAGE);
+}
+
+void
+TextContent::set_language_is_additional (bool additional)
+{
+	maybe_set (_language_is_additional, additional, TextContentProperty::LANGUAGE_IS_ADDITIONAL);
+}
+
 void
 TextContent::take_settings_from (shared_ptr<const TextContent> c)
 {
@@ -580,4 +642,44 @@ TextContent::take_settings_from (shared_ptr<const TextContent> c)
 		set_fade_out (*c->_fade_out);
 	}
 	set_outline_width (c->_outline_width);
+	if (c->_dcp_track) {
+		set_dcp_track (c->_dcp_track.get());
+	} else {
+		unset_dcp_track ();
+	}
+	set_language (c->_language);
+	set_language_is_additional (c->_language_is_additional);
+}
+
+
+shared_ptr<dcpomatic::Font>
+TextContent::get_font(string id) const
+{
+	boost::mutex::scoped_lock lm(_mutex);
+	return get_font_unlocked(id);
 }
+
+
+shared_ptr<dcpomatic::Font>
+TextContent::get_font_unlocked(string id) const
+{
+	auto iter = std::find_if(_fonts.begin(), _fonts.end(), [&id](shared_ptr<dcpomatic::Font> font) {
+		return font->id() == id;
+	});
+
+	if (iter == _fonts.end()) {
+		return {};
+	}
+
+	return *iter;
+}
+
+
+void
+TextContent::clear_fonts()
+{
+	boost::mutex::scoped_lock lm(_mutex);
+
+	_fonts.clear();
+}
+