Basic template support (#485).
[dcpomatic.git] / src / lib / subtitle_content.cc
index 01db0cee6f9c14991d1dbbfd391174d4e9cee09c..34ffa3f4ba3790f278950b6d9d60c50292a330a8 100644 (file)
@@ -1,29 +1,29 @@
 /*
     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 #include "subtitle_content.h"
 #include "util.h"
 #include "exceptions.h"
-#include "safe_stringstream.h"
 #include "font.h"
-#include "raw_convert.h"
 #include "content.h"
+#include <dcp/raw_convert.h>
 #include <libcxml/cxml.h>
 #include <libxml++/libxml++.h>
 #include <boost/foreach.hpp>
@@ -37,6 +37,7 @@ using std::cout;
 using std::list;
 using boost::shared_ptr;
 using boost::dynamic_pointer_cast;
+using dcp::raw_convert;
 
 int const SubtitleContentProperty::X_OFFSET = 500;
 int const SubtitleContentProperty::Y_OFFSET = 501;
@@ -48,7 +49,11 @@ int const SubtitleContentProperty::LANGUAGE = 506;
 int const SubtitleContentProperty::FONTS = 507;
 int const SubtitleContentProperty::COLOUR = 508;
 int const SubtitleContentProperty::OUTLINE = 509;
-int const SubtitleContentProperty::OUTLINE_COLOUR = 510;
+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;
 
 SubtitleContent::SubtitleContent (Content* parent)
        : ContentPart (parent)
@@ -60,7 +65,9 @@ SubtitleContent::SubtitleContent (Content* parent)
        , _y_scale (1)
        , _colour (255, 255, 255)
        , _outline (false)
-       , _outline_colour (0, 0, 0)
+       , _shadow (false)
+       , _effect_colour (0, 0, 0)
+       , _line_spacing (1)
 {
 
 }
@@ -68,6 +75,17 @@ SubtitleContent::SubtitleContent (Content* parent)
 shared_ptr<SubtitleContent>
 SubtitleContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
 {
+       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<SubtitleContent> ();
+               }
+
+               /* 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<SubtitleContent> ();
        }
@@ -89,11 +107,10 @@ SubtitleContent::SubtitleContent (Content* parent, cxml::ConstNodePtr node, int
                node->optional_number_child<int>("Blue").get_value_or(255)
                )
        , _outline (node->optional_bool_child("Outline").get_value_or(false))
-       , _outline_colour (
-               node->optional_number_child<int>("OutlineRed").get_value_or(255),
-               node->optional_number_child<int>("OutlineGreen").get_value_or(255),
-               node->optional_number_child<int>("OutlineBlue").get_value_or(255)
-               )
+       , _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))
 {
        if (version >= 32) {
                _use = node->bool_child ("UseSubtitles");
@@ -114,6 +131,20 @@ SubtitleContent::SubtitleContent (Content* parent, cxml::ConstNodePtr node, int
                _x_scale = _y_scale = node->number_child<double> ("SubtitleScale");
        }
 
+       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)
+                       );
+       } else {
+               _effect_colour = dcp::Colour (
+                       node->optional_number_child<int>("OutlineRed").get_value_or(255),
+                       node->optional_number_child<int>("OutlineGreen").get_value_or(255),
+                       node->optional_number_child<int>("OutlineBlue").get_value_or(255)
+                       );
+       }
+
        _language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
 
        list<cxml::NodePtr> fonts = node->node_children ("Font");
@@ -157,6 +188,14 @@ SubtitleContent::SubtitleContent (Content* parent, vector<shared_ptr<Content> >
                        throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
                }
 
+               if (c[i]->subtitle->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())) {
+                       throw JoinError (_("Content to be joined must have the same subtitle fades."));
+               }
+
                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."));
@@ -182,6 +221,9 @@ SubtitleContent::SubtitleContent (Content* parent, vector<shared_ptr<Content> >
        _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 ();
 
        connect_to_fonts ();
 }
@@ -192,8 +234,8 @@ 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));
@@ -202,10 +244,14 @@ SubtitleContent::as_xml (xmlpp::Node* root) const
        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("OutlineRed")->add_child_text (raw_convert<string> (_outline_colour.r));
-       root->add_child("OutlineGreen")->add_child_text (raw_convert<string> (_outline_colour.g));
-       root->add_child("OutlineBlue")->add_child_text (raw_convert<string> (_outline_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));
+       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()));
 
        for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
                (*i)->as_xml (root->add_child("Font"));
@@ -215,18 +261,20 @@ SubtitleContent::as_xml (xmlpp::Node* root) const
 string
 SubtitleContent::identifier () const
 {
-       SafeStringStream s;
-       s << raw_convert<string> (x_scale())
-         << "_" << raw_convert<string> (y_scale())
-         << "_" << raw_convert<string> (x_offset())
-         << "_" << raw_convert<string> (y_offset());
+       string s = raw_convert<string> (x_scale())
+               + "_" + raw_convert<string> (y_scale())
+               + "_" + raw_convert<string> (x_offset())
+               + "_" + raw_convert<string> (y_offset())
+               + "_" + raw_convert<string> (line_spacing())
+               + "_" + raw_convert<string> (fade_in().get())
+               + "_" + raw_convert<string> (fade_out().get());
 
        /* 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");
+                       s += "_" + f->file(static_cast<FontFiles::Variant>(i)).get_value_or("Default").string();
                }
        }
 
@@ -234,7 +282,7 @@ SubtitleContent::identifier () const
           how this content looks.
        */
 
-       return s.str ();
+       return s;
 }
 
 void
@@ -277,9 +325,15 @@ SubtitleContent::set_outline (bool o)
 }
 
 void
-SubtitleContent::set_outline_colour (dcp::Colour colour)
+SubtitleContent::set_shadow (bool s)
+{
+       maybe_set (_shadow, s, SubtitleContentProperty::SHADOW);
+}
+
+void
+SubtitleContent::set_effect_colour (dcp::Colour colour)
 {
-       maybe_set (_outline_colour, colour, SubtitleContentProperty::OUTLINE_COLOUR);
+       maybe_set (_effect_colour, colour, SubtitleContentProperty::EFFECT_COLOUR);
 }
 
 void
@@ -323,3 +377,40 @@ SubtitleContent::set_language (string language)
 {
        maybe_set (_language, language, SubtitleContentProperty::LANGUAGE);
 }
+
+void
+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::set_fade_out (ContentTime t)
+{
+       maybe_set (_fade_out, t, SubtitleContentProperty::FADE_OUT);
+}
+
+void
+SubtitleContent::use_template (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;
+}