Remove in-place translations support.
[dcpomatic.git] / src / lib / text_content.cc
index 86fd85b68b8da47e08c218f249c353665605ddda..92a35b8220cbca3f41c7302d9d8f0536a0b22ab9 100644 (file)
@@ -18,6 +18,7 @@
 
 */
 
+
 #include "text_content.h"
 #include "util.h"
 #include "exceptions.h"
@@ -30,6 +31,7 @@
 
 #include "i18n.h"
 
+
 using std::string;
 using std::vector;
 using std::cout;
@@ -41,6 +43,7 @@ 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)
@@ -75,10 +81,10 @@ 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.
+ *  The vector could be empty if no TextContents are found.
  */
-list<shared_ptr<TextContent>>
-TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
+vector<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
@@ -95,24 +101,19 @@ TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
                if (!node->optional_number_child<double>("SubtitleXOffset") && !node->optional_number_child<double>("SubtitleOffset")) {
                        return {};
                }
-               list<shared_ptr<TextContent>> c;
-               c.push_back (make_shared<TextContent>(parent, node, version));
-               return c;
-       }
-
-       if (!node->optional_node_child("Text")) {
-               return {};
+               return { make_shared<TextContent>(parent, node, version, notes) };
        }
 
-       list<shared_ptr<TextContent>> c;
+       vector<shared_ptr<TextContent>> content;
        for (auto i: node->node_children("Text")) {
-               c.push_back (make_shared<TextContent>(parent, i, version));
+               content.push_back(make_shared<TextContent>(parent, i, version, notes));
        }
 
-       return c;
+       return content;
 }
 
-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)
@@ -120,10 +121,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");
@@ -147,8 +148,6 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
                _effect = dcp::Effect::BORDER;
        } else if (node->optional_bool_child("Shadow").get_value_or(false)) {
                _effect = dcp::Effect::SHADOW;
-       } else {
-               _effect = dcp::Effect::NONE;
        }
 
        auto effect = node->optional_string_child("Effect");
@@ -231,6 +230,28 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version)
        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)
@@ -290,6 +311,14 @@ TextContent::TextContent (Content* parent, vector<shared_ptr<Content>> c)
                        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 ();
 
@@ -316,6 +345,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 ();
 }
@@ -375,6 +406,11 @@ 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
@@ -400,7 +436,7 @@ TextContent::identifier () const
                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;
 }
@@ -408,6 +444,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 ();
 }
@@ -430,7 +469,7 @@ void
 TextContent::font_changed ()
 {
        /* XXX: too late */
-       ChangeSignaller<Content> cc (_parent, TextContentProperty::FONTS);
+       ContentChangeSignaller cc (_parent, TextContentProperty::FONTS);
 }
 
 void
@@ -559,6 +598,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)
 {
@@ -595,4 +646,39 @@ 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);
+}
+
+
+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();
+}
+