/*
- 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.
*/
+
#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 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;
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;
-
-TextContent::TextContent (Content* parent)
+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)
, _use (false)
, _burn (false)
, _x_scale (1)
, _y_scale (1)
, _line_spacing (1)
- , _outline_width (2)
+ , _outline_width (4)
+ , _type (type)
+ , _original_type (original_type)
{
}
-shared_ptr<TextContent>
-TextContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
+/** @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<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 shared_ptr<TextContent> ();
+ return {};
}
/* Otherwise we can drop through to the newer logic */
}
- if (!node->optional_number_child<double>("SubtitleXOffset") && !node->optional_number_child<double>("SubtitleOffset")) {
- return shared_ptr<TextContent> ();
+ if (version < 37) {
+ if (!node->optional_number_child<double>("SubtitleXOffset") && !node->optional_number_child<double>("SubtitleOffset")) {
+ return {};
+ }
+ return { make_shared<TextContent>(parent, node, version, notes) };
+ }
+
+ list<shared_ptr<TextContent>> c;
+ for (auto i: node->node_children("Text")) {
+ c.push_back (make_shared<TextContent>(parent, i, version, notes));
}
- return shared_ptr<TextContent> (new TextContent (parent, node, 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)
, _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))
+ , _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 >= 32) {
+ if (version >= 37) {
+ _use = node->bool_child ("Use");
+ _burn = node->bool_child ("Burn");
+ } else if (version >= 32) {
_use = node->bool_child ("UseSubtitles");
_burn = node->bool_child ("BurnSubtitles");
}
- if (version >= 7) {
+ if (version >= 37) {
+ _x_offset = node->number_child<double> ("XOffset");
+ _y_offset = node->number_child<double> ("YOffset");
+ } else if (version >= 7) {
_x_offset = node->number_child<double> ("SubtitleXOffset");
_y_offset = node->number_child<double> ("SubtitleYOffset");
} else {
}
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;
}
}
- if (version >= 10) {
+ if (version >= 37) {
+ _x_scale = node->number_child<double> ("XScale");
+ _y_scale = node->number_child<double> ("YScale");
+ } else if (version >= 10) {
_x_scale = node->number_child<double> ("SubtitleXScale");
_y_scale = node->number_child<double> ("SubtitleYScale");
} else {
_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);
}
);
}
- optional<Frame> fi = node->optional_number_child<Frame>("SubtitleFadeIn");
+ optional<Frame> fi;
+ if (version >= 37) {
+ fi = node->optional_number_child<Frame>("FadeIn");
+ } else {
+ fi = node->optional_number_child<Frame>("SubtitleFadeIn");
+ }
if (fi) {
_fade_in = ContentTime (*fi);
}
- optional<Frame> fo = node->optional_number_child<Frame>("SubtitleFadeOut");
+
+ optional<Frame> fo;
+ if (version >= 37) {
+ fo = node->optional_number_child<Frame>("FadeOut");
+ } else {
+ fo = node->optional_number_child<Frame>("SubtitleFadeOut");
+ }
if (fo) {
_fade_out = ContentTime (*fo);
}
- _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 ();
+
+ if (version >= 37) {
+ _type = string_to_text_type (node->optional_string_child("Type").get_value_or("open"));
+ if (node->optional_string_child("OriginalType")) {
+ _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)
{
- shared_ptr<TextContent> ref = c[0]->subtitle;
+ /* This constructor is for join which is only supported for content types
+ that have a single text, so we can use only_text() here.
+ */
+ 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) {
- if (c[i]->subtitle->use() != ref->use()) {
+ if (c[i]->only_text()->use() != ref->use()) {
throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
}
- if (c[i]->subtitle->burn() != ref->burn()) {
+ if (c[i]->only_text()->burn() != ref->burn()) {
throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting."));
}
- if (c[i]->subtitle->x_offset() != ref->x_offset()) {
+ if (c[i]->only_text()->x_offset() != ref->x_offset()) {
throw JoinError (_("Content to be joined must have the same subtitle X offset."));
}
- if (c[i]->subtitle->y_offset() != ref->y_offset()) {
+ if (c[i]->only_text()->y_offset() != ref->y_offset()) {
throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
}
- if (c[i]->subtitle->x_scale() != ref->x_scale()) {
+ if (c[i]->only_text()->x_scale() != ref->x_scale()) {
throw JoinError (_("Content to be joined must have the same subtitle X scale."));
}
- if (c[i]->subtitle->y_scale() != ref->y_scale()) {
+ if (c[i]->only_text()->y_scale() != ref->y_scale()) {
throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
}
- if (c[i]->subtitle->line_spacing() != ref->line_spacing()) {
+ if (c[i]->only_text()->line_spacing() != ref->line_spacing()) {
throw JoinError (_("Content to be joined must have the same subtitle line spacing."));
}
- if ((c[i]->subtitle->fade_in() != ref->fade_in()) || (c[i]->subtitle->fade_out() != ref->fade_out())) {
+ if ((c[i]->only_text()->fade_in() != ref->fade_in()) || (c[i]->only_text()->fade_out() != ref->fade_out())) {
throw JoinError (_("Content to be joined must have the same subtitle fades."));
}
- if ((c[i]->subtitle->outline_width() != ref->outline_width())) {
+ if ((c[i]->only_text()->outline_width() != ref->outline_width())) {
throw JoinError (_("Content to be joined must have the same outline width."));
}
- list<shared_ptr<Font> > fonts = c[i]->subtitle->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) {
_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 ();
_fade_out = ref->fade_out ();
_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 ();
}
{
boost::mutex::scoped_lock lm (_mutex);
- root->add_child("UseSubtitles")->add_child_text (_use ? "1" : "0");
- root->add_child("BurnSubtitles")->add_child_text (_burn ? "1" : "0");
- root->add_child("SubtitleXOffset")->add_child_text (raw_convert<string> (_x_offset));
- root->add_child("SubtitleYOffset")->add_child_text (raw_convert<string> (_y_offset));
- root->add_child("SubtitleXScale")->add_child_text (raw_convert<string> (_x_scale));
- root->add_child("SubtitleYScale")->add_child_text (raw_convert<string> (_y_scale));
- root->add_child("SubtitleLanguage")->add_child_text (_language);
+ 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");
+ text->add_child("XOffset")->add_child_text (raw_convert<string> (_x_offset));
+ 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));
if (_colour) {
- root->add_child("Red")->add_child_text (raw_convert<string> (_colour->r));
- root->add_child("Green")->add_child_text (raw_convert<string> (_colour->g));
- root->add_child("Blue")->add_child_text (raw_convert<string> (_colour->b));
+ text->add_child("Red")->add_child_text (raw_convert<string> (_colour->r));
+ text->add_child("Green")->add_child_text (raw_convert<string> (_colour->g));
+ text->add_child("Blue")->add_child_text (raw_convert<string> (_colour->b));
}
if (_effect) {
switch (*_effect) {
- case dcp::NONE:
- root->add_child("Effect")->add_child_text("none");
+ case dcp::Effect::NONE:
+ text->add_child("Effect")->add_child_text("none");
break;
- case dcp::BORDER:
- root->add_child("Effect")->add_child_text("outline");
+ case dcp::Effect::BORDER:
+ text->add_child("Effect")->add_child_text("outline");
break;
- case dcp::SHADOW:
- root->add_child("Effect")->add_child_text("shadow");
+ case dcp::Effect::SHADOW:
+ text->add_child("Effect")->add_child_text("shadow");
break;
}
}
if (_effect_colour) {
- root->add_child("EffectRed")->add_child_text (raw_convert<string> (_effect_colour->r));
- root->add_child("EffectGreen")->add_child_text (raw_convert<string> (_effect_colour->g));
- root->add_child("EffectBlue")->add_child_text (raw_convert<string> (_effect_colour->b));
+ text->add_child("EffectRed")->add_child_text (raw_convert<string> (_effect_colour->r));
+ text->add_child("EffectGreen")->add_child_text (raw_convert<string> (_effect_colour->g));
+ text->add_child("EffectBlue")->add_child_text (raw_convert<string> (_effect_colour->b));
}
- root->add_child("LineSpacing")->add_child_text (raw_convert<string> (_line_spacing));
+ text->add_child("LineSpacing")->add_child_text (raw_convert<string> (_line_spacing));
if (_fade_in) {
- root->add_child("SubtitleFadeIn")->add_child_text (raw_convert<string> (_fade_in->get()));
+ text->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in->get()));
}
if (_fade_out) {
- root->add_child("SubtitleFadeOut")->add_child_text (raw_convert<string> (_fade_out->get()));
+ text->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out->get()));
+ }
+ text->add_child("OutlineWidth")->add_child_text (raw_convert<string> (_outline_width));
+
+ for (auto i: _fonts) {
+ i->as_xml (text->add_child("Font"));
}
- root->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 (root->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())
+ "_" + 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;
}
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)));
}
}
void
TextContent::font_changed ()
{
- _parent->signal_changed (TextContentProperty::FONTS);
+ /* XXX: too late */
+ ContentChangeSignaller cc (_parent, TextContentProperty::FONTS);
}
void
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)
{
maybe_set (_fade_out, optional<ContentTime>(), TextContentProperty::FADE_OUT);
}
+void
+TextContent::set_type (TextType type)
+{
+ maybe_set (_type, type, TextContentProperty::TYPE);
+}
+
void
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)
{
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);
}
projects / dcpomatic.git / blobdiff