No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / src / lib / subtitle_content.cc
index a6dcbf9aef40dea4763802cdc336dbc77967889a..a45b0a24f5a92f08eb10762e28ad4bb8d0a0624e 100644 (file)
@@ -1,19 +1,20 @@
 /*
     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/>.
 
 */
 
@@ -38,27 +39,26 @@ using std::list;
 using boost::shared_ptr;
 using boost::dynamic_pointer_cast;
 
-int const SubtitleContentProperty::SUBTITLE_X_OFFSET = 500;
-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::BURN_SUBTITLES = 505;
-int const SubtitleContentProperty::SUBTITLE_LANGUAGE = 506;
+int const SubtitleContentProperty::X_OFFSET = 500;
+int const SubtitleContentProperty::Y_OFFSET = 501;
+int const SubtitleContentProperty::X_SCALE = 502;
+int const SubtitleContentProperty::Y_SCALE = 503;
+int const SubtitleContentProperty::USE = 504;
+int const SubtitleContentProperty::BURN = 505;
+int const SubtitleContentProperty::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)
+int const SubtitleContentProperty::COLOUR = 508;
+int const SubtitleContentProperty::OUTLINE = 509;
+int const SubtitleContentProperty::OUTLINE_COLOUR = 510;
+
+SubtitleContent::SubtitleContent (Content* parent)
+       : ContentPart (parent)
+       , _use (false)
+       , _burn (false)
+       , _x_offset (0)
+       , _y_offset (0)
+       , _x_scale (1)
+       , _y_scale (1)
        , _colour (255, 255, 255)
        , _outline (false)
        , _outline_colour (0, 0, 0)
@@ -66,14 +66,24 @@ SubtitleContent::SubtitleContent (Content* parent, shared_ptr<const Film> film)
 
 }
 
-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)
+shared_ptr<SubtitleContent>
+SubtitleContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
+{
+       if (!node->optional_number_child<double>("SubtitleXOffset") && !node->optional_number_child<double>("SubtitleOffset")) {
+               return shared_ptr<SubtitleContent> ();
+       }
+
+       return shared_ptr<SubtitleContent> (new SubtitleContent (parent, node, version));
+}
+
+SubtitleContent::SubtitleContent (Content* parent, cxml::ConstNodePtr node, int version)
+       : ContentPart (parent)
+       , _use (false)
+       , _burn (false)
+       , _x_offset (0)
+       , _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),
@@ -87,25 +97,25 @@ SubtitleContent::SubtitleContent (Content* parent, shared_ptr<const Film> film,
                )
 {
        if (version >= 32) {
-               _use_subtitles = node->bool_child ("UseSubtitles");
-               _burn_subtitles = node->bool_child ("BurnSubtitles");
+               _use = node->bool_child ("UseSubtitles");
+               _burn = node->bool_child ("BurnSubtitles");
        }
 
        if (version >= 7) {
-               _subtitle_x_offset = node->number_child<double> ("SubtitleXOffset");
-               _subtitle_y_offset = node->number_child<double> ("SubtitleYOffset");
+               _x_offset = node->number_child<double> ("SubtitleXOffset");
+               _y_offset = node->number_child<double> ("SubtitleYOffset");
        } else {
-               _subtitle_y_offset = node->number_child<double> ("SubtitleOffset");
+               _y_offset = node->number_child<double> ("SubtitleOffset");
        }
 
        if (version >= 10) {
-               _subtitle_x_scale = node->number_child<double> ("SubtitleXScale");
-               _subtitle_y_scale = node->number_child<double> ("SubtitleYScale");
+               _x_scale = node->number_child<double> ("SubtitleXScale");
+               _y_scale = node->number_child<double> ("SubtitleYScale");
        } else {
-               _subtitle_x_scale = _subtitle_y_scale = node->number_child<double> ("SubtitleScale");
+               _x_scale = _y_scale = node->number_child<double> ("SubtitleScale");
        }
 
-       _subtitle_language = node->optional_string_child ("SubtitleLanguage").get_value_or ("");
+       _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) {
@@ -115,41 +125,40 @@ SubtitleContent::SubtitleContent (Content* parent, shared_ptr<const Film> film,
        connect_to_fonts ();
 }
 
-SubtitleContent::SubtitleContent (Content* parent, shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
-       : ContentPart (parent, film)
+SubtitleContent::SubtitleContent (Content* parent, vector<shared_ptr<Content> > c)
+       : ContentPart (parent)
 {
-       shared_ptr<SubtitleContent> ref = dynamic_pointer_cast<SubtitleContent> (c[0]);
+       shared_ptr<SubtitleContent> ref = c[0]->subtitle;
        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]);
+       for (size_t i = 1; i < c.size(); ++i) {
 
-               if (sc->use_subtitles() != ref->use_subtitles()) {
+               if (c[i]->subtitle->use() != ref->use()) {
                        throw JoinError (_("Content to be joined must have the same 'use subtitles' setting."));
                }
 
-               if (sc->burn_subtitles() != ref->burn_subtitles()) {
+               if (c[i]->subtitle->burn() != ref->burn()) {
                        throw JoinError (_("Content to be joined must have the same 'burn subtitles' setting."));
                }
 
-               if (sc->subtitle_x_offset() != ref->subtitle_x_offset()) {
+               if (c[i]->subtitle->x_offset() != ref->x_offset()) {
                        throw JoinError (_("Content to be joined must have the same subtitle X offset."));
                }
 
-               if (sc->subtitle_y_offset() != ref->subtitle_y_offset()) {
+               if (c[i]->subtitle->y_offset() != ref->y_offset()) {
                        throw JoinError (_("Content to be joined must have the same subtitle Y offset."));
                }
 
-               if (sc->subtitle_x_scale() != ref->subtitle_x_scale()) {
+               if (c[i]->subtitle->x_scale() != ref->x_scale()) {
                        throw JoinError (_("Content to be joined must have the same subtitle X scale."));
                }
 
-               if (sc->subtitle_y_scale() != ref->subtitle_y_scale()) {
+               if (c[i]->subtitle->y_scale() != ref->y_scale()) {
                        throw JoinError (_("Content to be joined must have the same subtitle Y scale."));
                }
 
-               list<shared_ptr<Font> > fonts = sc->fonts ();
+               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."));
                }
@@ -166,13 +175,13 @@ SubtitleContent::SubtitleContent (Content* parent, shared_ptr<const Film> film,
                }
        }
 
-       _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 ();
+       _use = ref->use ();
+       _burn = ref->burn ();
+       _x_offset = ref->x_offset ();
+       _y_offset = ref->y_offset ();
+       _x_scale = ref->x_scale ();
+       _y_scale = ref->y_scale ();
+       _language = ref->language ();
        _fonts = ref_fonts;
 
        connect_to_fonts ();
@@ -184,13 +193,13 @@ 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("UseSubtitles")->add_child_text (raw_convert<string> (_use));
+       root->add_child("BurnSubtitles")->add_child_text (raw_convert<string> (_burn));
+       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));
@@ -204,84 +213,14 @@ SubtitleContent::as_xml (xmlpp::Node* root) const
        }
 }
 
-void
-SubtitleContent::set_use_subtitles (bool u)
-{
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _use_subtitles = u;
-       }
-       _parent->signal_changed (SubtitleContentProperty::USE_SUBTITLES);
-}
-
-void
-SubtitleContent::set_burn_subtitles (bool b)
-{
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _burn_subtitles = b;
-       }
-       _parent->signal_changed (SubtitleContentProperty::BURN_SUBTITLES);
-}
-
-void
-SubtitleContent::set_subtitle_x_offset (double o)
-{
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_x_offset = o;
-       }
-       _parent->signal_changed (SubtitleContentProperty::SUBTITLE_X_OFFSET);
-}
-
-void
-SubtitleContent::set_subtitle_y_offset (double o)
-{
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_y_offset = o;
-       }
-       _parent->signal_changed (SubtitleContentProperty::SUBTITLE_Y_OFFSET);
-}
-
-void
-SubtitleContent::set_subtitle_x_scale (double s)
-{
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_x_scale = s;
-       }
-       _parent->signal_changed (SubtitleContentProperty::SUBTITLE_X_SCALE);
-}
-
-void
-SubtitleContent::set_subtitle_y_scale (double s)
-{
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_y_scale = s;
-       }
-       _parent->signal_changed (SubtitleContentProperty::SUBTITLE_Y_SCALE);
-}
-
-void
-SubtitleContent::set_subtitle_language (string language)
-{
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_language = language;
-       }
-       _parent->signal_changed (SubtitleContentProperty::SUBTITLE_LANGUAGE);
-}
-
 string
 SubtitleContent::identifier () const
 {
        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());
+       s << raw_convert<string> (x_scale())
+         << "_" << raw_convert<string> (y_scale())
+         << "_" << raw_convert<string> (x_offset())
+         << "_" << raw_convert<string> (y_offset());
 
        /* XXX: I suppose really _fonts shouldn't be in here, since not all
           types of subtitle content involve fonts.
@@ -329,44 +268,59 @@ SubtitleContent::font_changed ()
 void
 SubtitleContent::set_colour (dcp::Colour colour)
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               if (_colour == colour) {
-                       return;
-               }
+       maybe_set (_colour, colour, SubtitleContentProperty::COLOUR);
+}
 
-               _colour = colour;
-       }
+void
+SubtitleContent::set_outline (bool o)
+{
+       maybe_set (_outline, o, SubtitleContentProperty::OUTLINE);
+}
 
-       _parent->signal_changed (SubtitleContentProperty::SUBTITLE_COLOUR);
+void
+SubtitleContent::set_outline_colour (dcp::Colour colour)
+{
+       maybe_set (_outline_colour, colour, SubtitleContentProperty::OUTLINE_COLOUR);
 }
 
 void
-SubtitleContent::set_outline (bool o)
+SubtitleContent::set_use (bool u)
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               if (_outline == o) {
-                       return;
-               }
+       maybe_set (_use, u, SubtitleContentProperty::USE);
+}
 
-               _outline = o;
-       }
+void
+SubtitleContent::set_burn (bool b)
+{
+       maybe_set (_burn, b, SubtitleContentProperty::BURN);
+}
 
-       _parent->signal_changed (SubtitleContentProperty::SUBTITLE_OUTLINE);
+void
+SubtitleContent::set_x_offset (double o)
+{
+       maybe_set (_x_offset, o, SubtitleContentProperty::X_OFFSET);
 }
 
 void
-SubtitleContent::set_outline_colour (dcp::Colour colour)
+SubtitleContent::set_y_offset (double o)
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               if (_outline_colour == colour) {
-                       return;
-               }
+       maybe_set (_y_offset, o, SubtitleContentProperty::Y_OFFSET);
+}
 
-               _outline_colour = colour;
-       }
+void
+SubtitleContent::set_x_scale (double s)
+{
+       maybe_set (_x_scale, s, SubtitleContentProperty::X_SCALE);
+}
 
-       _parent->signal_changed (SubtitleContentProperty::SUBTITLE_OUTLINE_COLOUR);
+void
+SubtitleContent::set_y_scale (double s)
+{
+       maybe_set (_y_scale, s, SubtitleContentProperty::Y_SCALE);
+}
+
+void
+SubtitleContent::set_language (string language)
+{
+       maybe_set (_language, language, SubtitleContentProperty::LANGUAGE);
 }