Merge branch 'master' of ssh://git.carlh.net/home/carl/git/dcpomatic
[dcpomatic.git] / src / lib / subtitle_content.cc
index d6bf54aef5cf36a62bfe2d60a487d6ba7a0aa004..9e3ed322969b71b3e65fedec84d5f0824b510b41 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -37,6 +37,7 @@ using std::cout;
 using std::list;
 using boost::shared_ptr;
 using boost::dynamic_pointer_cast;
+using boost::optional;
 using dcp::raw_convert;
 
 int const SubtitleContentProperty::X_OFFSET = 500;
@@ -48,10 +49,12 @@ int const SubtitleContentProperty::BURN = 505;
 int const SubtitleContentProperty::LANGUAGE = 506;
 int const SubtitleContentProperty::FONTS = 507;
 int const SubtitleContentProperty::COLOUR = 508;
-int const SubtitleContentProperty::OUTLINE = 509;
-int const SubtitleContentProperty::SHADOW = 510;
-int const SubtitleContentProperty::EFFECT_COLOUR = 511;
-int const SubtitleContentProperty::LINE_SPACING = 512;
+int const SubtitleContentProperty::EFFECT = 509;
+int const SubtitleContentProperty::EFFECT_COLOUR = 510;
+int const SubtitleContentProperty::LINE_SPACING = 511;
+int const SubtitleContentProperty::FADE_IN = 512;
+int const SubtitleContentProperty::FADE_OUT = 513;
+int const SubtitleContentProperty::OUTLINE_WIDTH = 514;
 
 SubtitleContent::SubtitleContent (Content* parent)
        : ContentPart (parent)
@@ -61,11 +64,8 @@ SubtitleContent::SubtitleContent (Content* parent)
        , _y_offset (0)
        , _x_scale (1)
        , _y_scale (1)
-       , _colour (255, 255, 255)
-       , _outline (false)
-       , _shadow (false)
-       , _effect_colour (0, 0, 0)
        , _line_spacing (1)
+       , _outline_width (2)
 {
 
 }
@@ -99,14 +99,8 @@ SubtitleContent::SubtitleContent (Content* parent, cxml::ConstNodePtr node, int
        , _y_offset (0)
        , _x_scale (1)
        , _y_scale (1)
-       , _colour (
-               node->optional_number_child<int>("Red").get_value_or(255),
-               node->optional_number_child<int>("Green").get_value_or(255),
-               node->optional_number_child<int>("Blue").get_value_or(255)
-               )
-       , _outline (node->optional_bool_child("Outline").get_value_or(false))
-       , _shadow (node->optional_bool_child("Shadow").get_value_or(false))
        , _line_spacing (node->optional_number_child<double>("LineSpacing").get_value_or (1))
+       , _outline_width (node->optional_number_child<int>("OutlineWidth").get_value_or (2))
 {
        if (version >= 32) {
                _use = node->bool_child ("UseSubtitles");
@@ -120,6 +114,25 @@ SubtitleContent::SubtitleContent (Content* parent, cxml::ConstNodePtr node, int
                _y_offset = node->number_child<double> ("SubtitleOffset");
        }
 
+       if (node->optional_bool_child("Outline").get_value_or(false)) {
+               _effect = dcp::BORDER;
+       } else if (node->optional_bool_child("Shadow").get_value_or(false)) {
+               _effect = dcp::SHADOW;
+       } else {
+               _effect = dcp::NONE;
+       }
+
+       optional<string> effect = node->optional_string_child("Effect");
+       if (effect) {
+               if (*effect == "none") {
+                       _effect = dcp::NONE;
+               } else if (*effect == "outline") {
+                       _effect = dcp::BORDER;
+               } else if (*effect == "shadow") {
+                       _effect = dcp::SHADOW;
+               }
+       }
+
        if (version >= 10) {
                _x_scale = node->number_child<double> ("SubtitleXScale");
                _y_scale = node->number_child<double> ("SubtitleYScale");
@@ -127,12 +140,20 @@ SubtitleContent::SubtitleContent (Content* parent, cxml::ConstNodePtr node, int
                _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");
+       if (r && g && b) {
+               _colour = dcp::Colour (*r, *g, *b);
+       }
+
        if (version >= 36) {
-               _effect_colour = dcp::Colour (
-                       node->optional_number_child<int>("EffectRed").get_value_or(255),
-                       node->optional_number_child<int>("EffectGreen").get_value_or(255),
-                       node->optional_number_child<int>("EffectBlue").get_value_or(255)
-                       );
+               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");
+               if (er && eg && eb) {
+                       _effect_colour = dcp::Colour (*er, *eg, *eb);
+               }
        } else {
                _effect_colour = dcp::Colour (
                        node->optional_number_child<int>("OutlineRed").get_value_or(255),
@@ -141,6 +162,15 @@ SubtitleContent::SubtitleContent (Content* parent, cxml::ConstNodePtr node, int
                        );
        }
 
+       optional<Frame> fi = node->optional_number_child<Frame>("SubtitleFadeIn");
+       if (fi) {
+               _fade_in = ContentTime (*fi);
+       }
+       optional<Frame> 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");
@@ -188,6 +218,14 @@ SubtitleContent::SubtitleContent (Content* parent, vector<shared_ptr<Content> >
                        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())) {
+                       throw JoinError (_("Content to be joined must have the same subtitle fades."));
+               }
+
+               if ((c[i]->subtitle->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 ();
                if (fonts.size() != ref_fonts.size()) {
                        throw JoinError (_("Content to be joined must use the same fonts."));
@@ -214,6 +252,9 @@ SubtitleContent::SubtitleContent (Content* parent, vector<shared_ptr<Content> >
        _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 ();
 
        connect_to_fonts ();
 }
@@ -224,22 +265,44 @@ SubtitleContent::as_xml (xmlpp::Node* root) const
 {
        boost::mutex::scoped_lock lm (_mutex);
 
-       root->add_child("UseSubtitles")->add_child_text (raw_convert<string> (_use));
-       root->add_child("BurnSubtitles")->add_child_text (raw_convert<string> (_burn));
+       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);
-       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));
-       root->add_child("Outline")->add_child_text (raw_convert<string> (_outline));
-       root->add_child("Shadow")->add_child_text (raw_convert<string> (_shadow));
-       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));
+       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));
+       }
+       if (_effect) {
+               switch (*_effect) {
+               case dcp::NONE:
+                       root->add_child("Effect")->add_child_text("none");
+                       break;
+               case dcp::BORDER:
+                       root->add_child("Effect")->add_child_text("outline");
+                       break;
+               case dcp::SHADOW:
+                       root->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));
+       }
        root->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()));
+       }
+       if (_fade_out) {
+               root->add_child("SubtitleFadeOut")->add_child_text (raw_convert<string> (_fade_out->get()));
+       }
+       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"));
@@ -253,7 +316,10 @@ SubtitleContent::identifier () const
                + "_" + raw_convert<string> (y_scale())
                + "_" + raw_convert<string> (x_offset())
                + "_" + raw_convert<string> (y_offset())
-               + "_" + raw_convert<string> (line_spacing());
+               + "_" + raw_convert<string> (line_spacing())
+               + "_" + raw_convert<string> (fade_in().get_value_or(ContentTime()).get())
+               + "_" + raw_convert<string> (fade_out().get_value_or(ContentTime()).get())
+               + "_" + raw_convert<string> (outline_width());
 
        /* XXX: I suppose really _fonts shouldn't be in here, since not all
           types of subtitle content involve fonts.
@@ -305,15 +371,21 @@ SubtitleContent::set_colour (dcp::Colour colour)
 }
 
 void
-SubtitleContent::set_outline (bool o)
+SubtitleContent::unset_colour ()
 {
-       maybe_set (_outline, o, SubtitleContentProperty::OUTLINE);
+       maybe_set (_colour, optional<dcp::Colour>(), SubtitleContentProperty::COLOUR);
 }
 
 void
-SubtitleContent::set_shadow (bool s)
+SubtitleContent::set_effect (dcp::Effect e)
 {
-       maybe_set (_shadow, s, SubtitleContentProperty::SHADOW);
+       maybe_set (_effect, e, SubtitleContentProperty::EFFECT);
+}
+
+void
+SubtitleContent::unset_effect ()
+{
+       maybe_set (_effect, optional<dcp::Effect>(), SubtitleContentProperty::EFFECT);
 }
 
 void
@@ -322,6 +394,12 @@ SubtitleContent::set_effect_colour (dcp::Colour colour)
        maybe_set (_effect_colour, colour, SubtitleContentProperty::EFFECT_COLOUR);
 }
 
+void
+SubtitleContent::unset_effect_colour ()
+{
+       maybe_set (_effect_colour, optional<dcp::Colour>(), SubtitleContentProperty::EFFECT_COLOUR);
+}
+
 void
 SubtitleContent::set_use (bool u)
 {
@@ -369,3 +447,66 @@ SubtitleContent::set_line_spacing (double s)
 {
        maybe_set (_line_spacing, s, SubtitleContentProperty::LINE_SPACING);
 }
+
+void
+SubtitleContent::set_fade_in (ContentTime t)
+{
+       maybe_set (_fade_in, t, SubtitleContentProperty::FADE_IN);
+}
+
+void
+SubtitleContent::unset_fade_in ()
+{
+       maybe_set (_fade_in, optional<ContentTime>(), SubtitleContentProperty::FADE_IN);
+}
+
+void
+SubtitleContent::set_fade_out (ContentTime t)
+{
+       maybe_set (_fade_out, t, SubtitleContentProperty::FADE_OUT);
+}
+
+void
+SubtitleContent::unset_fade_out ()
+{
+       maybe_set (_fade_out, optional<ContentTime>(), SubtitleContentProperty::FADE_OUT);
+}
+
+void
+SubtitleContent::set_outline_width (int w)
+{
+       maybe_set (_outline_width, w, SubtitleContentProperty::OUTLINE_WIDTH);
+}
+
+void
+SubtitleContent::take_settings_from (shared_ptr<const SubtitleContent> c)
+{
+       set_use (c->_use);
+       set_burn (c->_burn);
+       set_x_offset (c->_x_offset);
+       set_y_offset (c->_y_offset);
+       set_x_scale (c->_x_scale);
+       set_y_scale (c->_y_scale);
+       maybe_set (_fonts, c->_fonts, SubtitleContentProperty::FONTS);
+       if (c->_colour) {
+               set_colour (*c->_colour);
+       } else {
+               unset_colour ();
+       }
+       if (c->_effect) {
+               set_effect (*c->_effect);
+       }
+       if (c->_effect_colour) {
+               set_effect_colour (*c->_effect_colour);
+       } else {
+               unset_effect_colour ();
+       }
+       set_line_spacing (c->_line_spacing);
+       if (c->_fade_in) {
+               set_fade_in (*c->_fade_in);
+       }
+       if (c->_fade_out) {
+               set_fade_out (*c->_fade_out);
+       }
+       set_outline_width (c->_outline_width);
+}