X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Ftext_content.cc;h=1e9c609c9cafc92686f36cadad576d7aa6bf4f55;hb=ccd69987ab861ea4521836fa2a5227e2dfac3479;hp=9869974c5bf7a7a61452b5402f90ec799d0c0a98;hpb=5aa057f73c9b5d0f2a4a1479bd75dee849250265;p=dcpomatic.git diff --git a/src/lib/text_content.cc b/src/lib/text_content.cc index 9869974c5..1e9c609c9 100644 --- a/src/lib/text_content.cc +++ b/src/lib/text_content.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2013-2018 Carl Hetherington + Copyright (C) 2013-2021 Carl Hetherington 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 #include #include -#include #include #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,17 +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::DCP_TRACK = 516; +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) @@ -67,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) { @@ -77,15 +83,15 @@ TextContent::TextContent (Content* parent, TextType type, TextType original_type /** @return TextContents from node or nodes under node (according to version). * The list could be empty if no TextContents are found. */ -list > -TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version) +list> +TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version, list& 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 >(); + return {}; } /* Otherwise we can drop through to the newer logic */ @@ -93,26 +99,20 @@ TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version) if (version < 37) { if (!node->optional_number_child("SubtitleXOffset") && !node->optional_number_child("SubtitleOffset")) { - return list >(); + return {}; } - list > c; - c.push_back (shared_ptr (new TextContent (parent, node, version))); - return c; - } - - if (!node->optional_node_child("Text")) { - return list >(); + return { make_shared(parent, node, version, notes) }; } - list > c; - BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Text")) { - c.push_back (shared_ptr (new TextContent (parent, i, version))); + list> c; + for (auto i: node->node_children("Text")) { + c.push_back (make_shared(parent, i, version, notes)); } return c; } -TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version) +TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version, list& notes) : ContentPart (parent) , _use (false) , _burn (false) @@ -120,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("LineSpacing").get_value_or (1)) - , _outline_width (node->optional_number_child("OutlineWidth").get_value_or (2)) - , _type (TEXT_OPEN_SUBTITLE) - , _original_type (TEXT_OPEN_SUBTITLE) + , _line_spacing (node->optional_number_child("LineSpacing").get_value_or(1)) + , _outline_width (node->optional_number_child("OutlineWidth").get_value_or(4)) + , _type (TextType::OPEN_SUBTITLE) + , _original_type (TextType::OPEN_SUBTITLE) { if (version >= 37) { _use = node->bool_child ("Use"); @@ -144,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 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 +172,17 @@ TextContent::TextContent (Content* parent, cxml::ConstNodePtr node, int version) _x_scale = _y_scale = node->number_child ("SubtitleScale"); } - optional r = node->optional_number_child("Red"); - optional g = node->optional_number_child("Green"); - optional b = node->optional_number_child("Blue"); + auto r = node->optional_number_child("Red"); + auto g = node->optional_number_child("Green"); + auto b = node->optional_number_child("Blue"); if (r && g && b) { _colour = dcp::Colour (*r, *g, *b); } if (version >= 36) { - optional er = node->optional_number_child("EffectRed"); - optional eg = node->optional_number_child("EffectGreen"); - optional eb = node->optional_number_child("EffectBlue"); + auto er = node->optional_number_child("EffectRed"); + auto eg = node->optional_number_child("EffectGreen"); + auto eb = node->optional_number_child("EffectBlue"); if (er && eg && eb) { _effect_colour = dcp::Colour (*er, *eg, *eb); } @@ -214,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 fonts = node->node_children ("Font"); - for (list::const_iterator i = fonts.begin(); i != fonts.end(); ++i) { - _fonts.push_back (shared_ptr (new Font (*i))); + for (auto i: node->node_children ("Font")) { + _fonts.push_back (make_shared(i)); } connect_to_fonts (); @@ -234,21 +227,43 @@ 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) { + 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 > c) +TextContent::TextContent (Content* parent, vector> 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 ref = c[0]->only_text(); + auto ref = c[0]->only_text(); DCPOMATIC_ASSERT (ref); - list > ref_fonts = ref->fonts (); + auto ref_fonts = ref->fonts (); for (size_t i = 1; i < c.size(); ++i) { @@ -288,7 +303,7 @@ TextContent::TextContent (Content* parent, vector > c) throw JoinError (_("Content to be joined must have the same outline width.")); } - list > 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.")); } @@ -297,8 +312,16 @@ TextContent::TextContent (Content* parent, vector > c) throw JoinError (_("Content to be joined must use the same DCP track.")); } - list >::const_iterator j = ref_fonts.begin (); - list >::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) { @@ -315,7 +338,6 @@ TextContent::TextContent (Content* parent, vector > 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 (); @@ -324,6 +346,8 @@ TextContent::TextContent (Content* parent, vector > 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 (); } @@ -334,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"); @@ -342,7 +366,6 @@ TextContent::as_xml (xmlpp::Node* root) const text->add_child("YOffset")->add_child_text (raw_convert (_y_offset)); text->add_child("XScale")->add_child_text (raw_convert (_x_scale)); text->add_child("YScale")->add_child_text (raw_convert (_y_scale)); - text->add_child("Language")->add_child_text (_language); if (_colour) { text->add_child("Red")->add_child_text (raw_convert (_colour->r)); text->add_child("Green")->add_child_text (raw_convert (_colour->g)); @@ -350,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; } @@ -375,8 +398,8 @@ TextContent::as_xml (xmlpp::Node* root) const } text->add_child("OutlineWidth")->add_child_text (raw_convert (_outline_width)); - for (list >::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)); @@ -384,12 +407,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 (x_scale()) + auto s = raw_convert (x_scale()) + "_" + raw_convert (y_scale()) + "_" + raw_convert (x_offset()) + "_" + raw_convert (y_offset()) @@ -398,21 +426,18 @@ TextContent::identifier () const + "_" + raw_convert (fade_out().get_value_or(ContentTime()).get()) + "_" + raw_convert (outline_width()) + "_" + raw_convert (colour().get_value_or(dcp::Colour(255, 255, 255)).to_argb_string()) - + "_" + raw_convert (dcp::effect_to_string(effect().get_value_or(dcp::NONE))) - + "_" + raw_convert (effect_colour().get_value_or(dcp::Colour(0, 0, 0)).to_argb_string()); + + "_" + raw_convert (dcp::effect_to_string(effect().get_value_or(dcp::Effect::NONE))) + + "_" + raw_convert (effect_colour().get_value_or(dcp::Colour(0, 0, 0)).to_argb_string()) + + "_" + raw_convert (_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 f, _fonts) { - for (int i = 0; i < FontFiles::VARIANTS; ++i) { - s += "_" + f->file(static_cast(i)).get_value_or("Default").string(); - } + for (auto f: _fonts) { + s += "_" + f->file().get_value_or("Default").string(); } - /* The DCP track and language are for metadata only, and don'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; } @@ -427,13 +452,13 @@ TextContent::add_font (shared_ptr 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 i, _fonts) { + for (auto i: _fonts) { _font_connections.push_back (i->Changed.connect (boost::bind (&TextContent::font_changed, this))); } } @@ -442,7 +467,7 @@ void TextContent::font_changed () { /* XXX: too late */ - ChangeSignaller cc (_parent, TextContentProperty::FONTS); + ContentChangeSignaller cc (_parent, TextContentProperty::FONTS); } void @@ -517,12 +542,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) { @@ -577,6 +596,18 @@ TextContent::unset_dcp_track () maybe_set (_dcp_track, optional(), TextContentProperty::DCP_TRACK); } +void +TextContent::set_language (optional 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 c) { @@ -613,4 +644,6 @@ TextContent::take_settings_from (shared_ptr c) } else { unset_dcp_track (); } + set_language (c->_language); + set_language_is_additional (c->_language_is_additional); }