Use an enum for the effect in SubtitleContent.

[dcpomatic.git] / src / lib / subtitle_content.cc

diff --git a/src/lib/subtitle_content.cc b/src/lib/subtitle_content.cc
index 37d431e1aa1701234cc0827c206ca559de0900e1..df05b356afda68b43a53b5f2be04df0fe935039b 100644 (file)
--- a/src/lib/subtitle_content.cc
+++ b/src/lib/subtitle_content.cc
@@ -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,13 +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::FADE_IN = 513;
-int const SubtitleContentProperty::FADE_OUT = 514;
-int const SubtitleContentProperty::OUTLINE_WIDTH = 515;
+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)
@@ -64,10 +64,7 @@ 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)
+       , _effect (dcp::NONE)
        , _line_spacing (1)
        , _outline_width (2)
 {
@@ -103,13 +100,6 @@ 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))
        , _fade_in (node->optional_number_child<Frame>("SubtitleFadeIn").get_value_or (0))
        , _fade_out (node->optional_number_child<Frame>("SubtitleFadeOut").get_value_or (0))
@@ -127,6 +117,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");
@@ -134,12 +143,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),
@@ -249,14 +266,27 @@ SubtitleContent::as_xml (xmlpp::Node* root) const
        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 (_outline ? "1" : "0");
-       root->add_child("Shadow")->add_child_text (_shadow ? "1" : "0");
-       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));
+       }
+       switch (_effect) {
+       case dcp::NONE:
+               root->add_child("none");
+               break;
+       case dcp::BORDER:
+               root->add_child("outline");
+               break;
+       case dcp::SHADOW:
+               root->add_child("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));
        root->add_child("SubtitleFadeIn")->add_child_text (raw_convert<string> (_fade_in.get()));
        root->add_child("SubtitleFadeOut")->add_child_text (raw_convert<string> (_fade_out.get()));
@@ -329,15 +359,15 @@ 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
@@ -346,6 +376,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)
 {
@@ -413,21 +449,28 @@ SubtitleContent::set_outline_width (int w)
 }
 
 void
-SubtitleContent::use_template (shared_ptr<const SubtitleContent> c)
+SubtitleContent::take_settings_from (shared_ptr<const SubtitleContent> c)
 {
-       _use = c->_use;
-       _burn = c->_burn;
-       _x_offset = c->_x_offset;
-       _y_offset = c->_y_offset;
-       _x_scale = c->_x_scale;
-       _y_scale = c->_y_scale;
-       _fonts = c->_fonts;
-       _colour = c->_colour;
-       _outline = c->_outline;
-       _shadow = c->_shadow;
-       _effect_colour = c->_effect_colour;
-       _line_spacing = c->_line_spacing;
-       _fade_in = c->_fade_in;
-       _fade_out = c->_fade_out;
-       _outline_width = c->_outline_width;
+       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 ();
+       }
+       set_effect (c->_effect);
+       if (c->_effect_colour) {
+               set_effect_colour (*c->_effect_colour);
+       } else {
+               unset_effect_colour ();
+       }
+       set_line_spacing (c->_line_spacing);
+       set_fade_in (c->_fade_in);
+       set_fade_out (c->_fade_out);
+       set_outline_width (c->_outline_width);
 }