Add maybe_set to ContentPart.
[dcpomatic.git] / src / lib / subtitle_content.cc
index f42f3db370049ec394932e9310d3d75c485d40be..03c188b896b2c2a3c893689f72ac77c8ff3e7b13 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #include "safe_stringstream.h"
 #include "font.h"
 #include "raw_convert.h"
+#include "content.h"
 #include <libcxml/cxml.h>
+#include <libxml++/libxml++.h>
+#include <boost/foreach.hpp>
+#include <iostream>
 
 #include "i18n.h"
 
@@ -39,57 +43,66 @@ int const SubtitleContentProperty::SUBTITLE_Y_OFFSET = 501;
 int const SubtitleContentProperty::SUBTITLE_X_SCALE = 502;
 int const SubtitleContentProperty::SUBTITLE_Y_SCALE = 503;
 int const SubtitleContentProperty::USE_SUBTITLES = 504;
-int const SubtitleContentProperty::SUBTITLE_LANGUAGE = 505;
-int const SubtitleContentProperty::FONTS = 506;
-
-SubtitleContent::SubtitleContent (shared_ptr<const Film> f)
-       : Content (f)
-       , _use_subtitles (false)
-       , _subtitle_x_offset (0)
-       , _subtitle_y_offset (0)
-       , _subtitle_x_scale (1)
-       , _subtitle_y_scale (1)
-{
-
-}
-
-SubtitleContent::SubtitleContent (shared_ptr<const Film> f, boost::filesystem::path p)
-       : Content (f, p)
+int const SubtitleContentProperty::BURN_SUBTITLES = 505;
+int const SubtitleContentProperty::SUBTITLE_LANGUAGE = 506;
+int const SubtitleContentProperty::FONTS = 507;
+int const SubtitleContentProperty::SUBTITLE_VIDEO_FRAME_RATE = 508;
+int const SubtitleContentProperty::SUBTITLE_COLOUR = 509;
+int const SubtitleContentProperty::SUBTITLE_OUTLINE = 510;
+int const SubtitleContentProperty::SUBTITLE_OUTLINE_COLOUR = 511;
+
+SubtitleContent::SubtitleContent (Content* parent, shared_ptr<const Film> film)
+       : ContentPart (parent, film)
        , _use_subtitles (false)
+       , _burn_subtitles (false)
        , _subtitle_x_offset (0)
        , _subtitle_y_offset (0)
        , _subtitle_x_scale (1)
        , _subtitle_y_scale (1)
+       , _colour (255, 255, 255)
+       , _outline (false)
+       , _outline_colour (0, 0, 0)
 {
 
 }
 
-SubtitleContent::SubtitleContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version)
-       : Content (f, node)
+SubtitleContent::SubtitleContent (Content* parent, shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
+       : ContentPart (parent, film)
        , _use_subtitles (false)
+       , _burn_subtitles (false)
        , _subtitle_x_offset (0)
        , _subtitle_y_offset (0)
        , _subtitle_x_scale (1)
        , _subtitle_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))
+       , _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)
+               )
 {
        if (version >= 32) {
                _use_subtitles = node->bool_child ("UseSubtitles");
-       } else {
-               _use_subtitles = false;
+               _burn_subtitles = node->bool_child ("BurnSubtitles");
        }
-       
+
        if (version >= 7) {
-               _subtitle_x_offset = node->number_child<float> ("SubtitleXOffset");
-               _subtitle_y_offset = node->number_child<float> ("SubtitleYOffset");
+               _subtitle_x_offset = node->number_child<double> ("SubtitleXOffset");
+               _subtitle_y_offset = node->number_child<double> ("SubtitleYOffset");
        } else {
-               _subtitle_y_offset = node->number_child<float> ("SubtitleOffset");
+               _subtitle_y_offset = node->number_child<double> ("SubtitleOffset");
        }
 
        if (version >= 10) {
-               _subtitle_x_scale = node->number_child<float> ("SubtitleXScale");
-               _subtitle_y_scale = node->number_child<float> ("SubtitleYScale");
+               _subtitle_x_scale = node->number_child<double> ("SubtitleXScale");
+               _subtitle_y_scale = node->number_child<double> ("SubtitleYScale");
        } else {
-               _subtitle_x_scale = _subtitle_y_scale = node->number_child<float> ("SubtitleScale");
+               _subtitle_x_scale = _subtitle_y_scale = node->number_child<double> ("SubtitleScale");
        }
 
        _subtitle_language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
@@ -98,15 +111,17 @@ SubtitleContent::SubtitleContent (shared_ptr<const Film> f, cxml::ConstNodePtr n
        for (list<cxml::NodePtr>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
                _fonts.push_back (shared_ptr<Font> (new Font (*i)));
        }
+
+       connect_to_fonts ();
 }
 
-SubtitleContent::SubtitleContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
-       : Content (f, c)
+SubtitleContent::SubtitleContent (Content* parent, shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
+       : ContentPart (parent, film)
 {
        shared_ptr<SubtitleContent> ref = dynamic_pointer_cast<SubtitleContent> (c[0]);
        DCPOMATIC_ASSERT (ref);
        list<shared_ptr<Font> > ref_fonts = ref->fonts ();
-       
+
        for (size_t i = 0; i < c.size(); ++i) {
                shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c[i]);
 
@@ -114,10 +129,14 @@ SubtitleContent::SubtitleContent (shared_ptr<const Film> f, vector<shared_ptr<Co
                        throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
                }
 
+               if (sc->burn_subtitles() != ref->burn_subtitles()) {
+                       throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting."));
+               }
+
                if (sc->subtitle_x_offset() != ref->subtitle_x_offset()) {
                        throw JoinError (_("Content to be joined must have the same subtitle X offset."));
                }
-               
+
                if (sc->subtitle_y_offset() != ref->subtitle_y_offset()) {
                        throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
                }
@@ -148,12 +167,15 @@ SubtitleContent::SubtitleContent (shared_ptr<const Film> f, vector<shared_ptr<Co
        }
 
        _use_subtitles = ref->use_subtitles ();
+       _burn_subtitles = ref->burn_subtitles ();
        _subtitle_x_offset = ref->subtitle_x_offset ();
        _subtitle_y_offset = ref->subtitle_y_offset ();
        _subtitle_x_scale = ref->subtitle_x_scale ();
        _subtitle_y_scale = ref->subtitle_y_scale ();
        _subtitle_language = ref->subtitle_language ();
        _fonts = ref_fonts;
+
+       connect_to_fonts ();
 }
 
 /** _mutex must not be held on entry */
@@ -161,92 +183,135 @@ void
 SubtitleContent::as_xml (xmlpp::Node* root) const
 {
        boost::mutex::scoped_lock lm (_mutex);
-       
+
        root->add_child("UseSubtitles")->add_child_text (raw_convert<string> (_use_subtitles));
+       root->add_child("BurnSubtitles")->add_child_text (raw_convert<string> (_burn_subtitles));
        root->add_child("SubtitleXOffset")->add_child_text (raw_convert<string> (_subtitle_x_offset));
        root->add_child("SubtitleYOffset")->add_child_text (raw_convert<string> (_subtitle_y_offset));
        root->add_child("SubtitleXScale")->add_child_text (raw_convert<string> (_subtitle_x_scale));
        root->add_child("SubtitleYScale")->add_child_text (raw_convert<string> (_subtitle_y_scale));
        root->add_child("SubtitleLanguage")->add_child_text (_subtitle_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("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));
 
        for (list<shared_ptr<Font> >::const_iterator i = _fonts.begin(); i != _fonts.end(); ++i) {
                (*i)->as_xml (root->add_child("Font"));
        }
 }
 
-void
-SubtitleContent::set_use_subtitles (bool u)
+string
+SubtitleContent::identifier () const
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _use_subtitles = u;
+       SafeStringStream s;
+       s << raw_convert<string> (subtitle_x_scale())
+         << "_" << raw_convert<string> (subtitle_y_scale())
+         << "_" << raw_convert<string> (subtitle_x_offset())
+         << "_" << raw_convert<string> (subtitle_y_offset());
+
+       /* 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");
+               }
        }
-       signal_changed (SubtitleContentProperty::USE_SUBTITLES);
+
+       /* The language is for metadata only, and doesn't affect
+          how this content looks.
+       */
+
+       return s.str ();
 }
-       
+
 void
-SubtitleContent::set_subtitle_x_offset (double o)
+SubtitleContent::add_font (shared_ptr<Font> font)
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_x_offset = o;
-       }
-       signal_changed (SubtitleContentProperty::SUBTITLE_X_OFFSET);
+       _fonts.push_back (font);
+       connect_to_fonts ();
 }
 
 void
-SubtitleContent::set_subtitle_y_offset (double o)
+SubtitleContent::connect_to_fonts ()
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_y_offset = o;
+       BOOST_FOREACH (boost::signals2::connection& i, _font_connections) {
+               i.disconnect ();
+       }
+
+       _font_connections.clear ();
+
+       BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
+               _font_connections.push_back (i->Changed.connect (boost::bind (&SubtitleContent::font_changed, this)));
        }
-       signal_changed (SubtitleContentProperty::SUBTITLE_Y_OFFSET);
 }
 
 void
-SubtitleContent::set_subtitle_x_scale (double s)
+SubtitleContent::font_changed ()
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_x_scale = s;
-       }
-       signal_changed (SubtitleContentProperty::SUBTITLE_X_SCALE);
+       _parent->signal_changed (SubtitleContentProperty::FONTS);
 }
 
 void
-SubtitleContent::set_subtitle_y_scale (double s)
+SubtitleContent::set_colour (dcp::Colour colour)
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_y_scale = s;
-       }
-       signal_changed (SubtitleContentProperty::SUBTITLE_Y_SCALE);
+       maybe_set (_colour, colour, SubtitleContentProperty::SUBTITLE_COLOUR);
 }
 
 void
-SubtitleContent::set_subtitle_language (string language)
+SubtitleContent::set_outline (bool o)
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_language = language;
-       }
-       signal_changed (SubtitleContentProperty::SUBTITLE_LANGUAGE);
+       maybe_set (_outline, o, SubtitleContentProperty::SUBTITLE_OUTLINE);
 }
 
-string
-SubtitleContent::identifier () const
+void
+SubtitleContent::set_outline_colour (dcp::Colour colour)
 {
-       SafeStringStream s;
-       s << Content::identifier()
-         << "_" << raw_convert<string> (subtitle_x_scale())
-         << "_" << raw_convert<string> (subtitle_y_scale())
-         << "_" << raw_convert<string> (subtitle_x_offset())
-         << "_" << raw_convert<string> (subtitle_y_offset());
+       maybe_set (_outline_colour, colour, SubtitleContentProperty::SUBTITLE_OUTLINE_COLOUR);
+}
 
-       /* The language is for metadata only, and doesn't affect
-          how this content looks.
-       */
+void
+SubtitleContent::set_use_subtitles (bool u)
+{
+       maybe_set (_use_subtitles, u, SubtitleContentProperty::USE_SUBTITLES);
+}
 
-       return s.str ();
+void
+SubtitleContent::set_burn_subtitles (bool b)
+{
+       maybe_set (_burn_subtitles, b, SubtitleContentProperty::BURN_SUBTITLES);
+}
+
+void
+SubtitleContent::set_subtitle_x_offset (double o)
+{
+       maybe_set (_subtitle_x_offset, o, SubtitleContentProperty::SUBTITLE_X_OFFSET);
+}
+
+void
+SubtitleContent::set_subtitle_y_offset (double o)
+{
+       maybe_set (_subtitle_y_offset, o, SubtitleContentProperty::SUBTITLE_Y_OFFSET);
+}
+
+void
+SubtitleContent::set_subtitle_x_scale (double s)
+{
+       maybe_set (_subtitle_x_scale, s, SubtitleContentProperty::SUBTITLE_X_SCALE);
+}
+
+void
+SubtitleContent::set_subtitle_y_scale (double s)
+{
+       maybe_set (_subtitle_y_scale, s, SubtitleContentProperty::SUBTITLE_Y_SCALE);
+}
+
+void
+SubtitleContent::set_subtitle_language (string language)
+{
+       maybe_set (_subtitle_language, language, SubtitleContentProperty::SUBTITLE_LANGUAGE);
 }