Remove erroneous defaulting of text language to en_US.
[dcpomatic.git] / src / lib / text_content.cc
index 656aec7ebca226744911839f8b724dfd3af779eb..4ba2de348d076c79aee657aac4b79086bab60e4b 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2020 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"
 #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 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;
 int const TextContentProperty::X_SCALE = 502;
@@ -57,6 +60,9 @@ 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)
@@ -77,7 +83,7 @@ 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> >
+list<shared_ptr<TextContent>>
 TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
 {
        if (version < 34) {
@@ -85,7 +91,7 @@ TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
                   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 */
@@ -93,20 +99,18 @@ 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) };
        }
 
        if (!node->optional_node_child("Text")) {
-               return list<shared_ptr<TextContent> >();
+               return {};
        }
 
-       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)));
+       list<shared_ptr<TextContent>> c;
+       for (auto i: node->node_children("Text")) {
+               c.push_back (make_shared<TextContent>(parent, i, version));
        }
 
        return c;
@@ -120,10 +124,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 (4))
-       , _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");
@@ -144,21 +148,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;
                }
        }
 
@@ -172,17 +176,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);
                }
@@ -214,9 +218,8 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
                _fade_out = ContentTime (*fo);
        }
 
-       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 ();
@@ -228,21 +231,28 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
                }
        }
 
-       cxml::ConstNodePtr dt = node->optional_node_child("DCPTrack");
+       auto dt = node->optional_node_child("DCPTrack");
        if (dt) {
                _dcp_track = DCPTextTrack (dt);
        }
+
+       auto lang = node->optional_node_child("Language");
+       if (lang) {
+               _language = dcp::LanguageTag(lang->content());
+               auto add = lang->optional_bool_attribute("Additional");
+               _language_is_additional = add && *add;
+       }
 }
 
-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) {
 
@@ -282,7 +292,7 @@ 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."));
                }
@@ -291,8 +301,16 @@ TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
                        throw JoinError (_("Content to be joined must use the same DCP track."));
                }
 
-               list<shared_ptr<Font> >::const_iterator j = ref_fonts.begin ();
-               list<shared_ptr<Font> >::const_iterator k = fonts.begin ();
+               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) {
@@ -317,6 +335,8 @@ TextContent::TextContent (Content* parent, vector<shared_ptr<Content> > c)
        _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 ();
 }
@@ -327,7 +347,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");
@@ -342,13 +362,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;
                }
@@ -367,8 +387,8 @@ 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));
@@ -376,12 +396,17 @@ TextContent::as_xml (xmlpp::Node* root) const
        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())
@@ -390,18 +415,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> (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 (auto f: _fonts) {
                s += "_" + f->file().get_value_or("Default").string();
        }
 
-       /* The DCP track 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;
 }
@@ -416,13 +441,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)));
        }
 }
@@ -431,7 +456,7 @@ void
 TextContent::font_changed ()
 {
        /* XXX: too late */
-       ChangeSignaller<Content> cc (_parent, TextContentProperty::FONTS);
+       ContentChangeSignaller cc (_parent, TextContentProperty::FONTS);
 }
 
 void
@@ -560,6 +585,18 @@ 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)
 {
@@ -596,4 +633,6 @@ TextContent::take_settings_from (shared_ptr<const TextContent> c)
        } else {
                unset_dcp_track ();
        }
+       set_language (c->_language);
+       set_language_is_additional (c->_language_is_additional);
 }