Fix macOS build warning.
[libdcp.git] / src / subtitle_asset.cc
index 37b381ae64594065366284147f0ec5955e7406a4..bf4b1c63e4c476a37748f818855d1eb63494073a 100644 (file)
     files in the program, then also delete it here.
 */
 
+
+/** @file  src/subtitle_asset.cc
+ *  @brief SubtitleAsset class
+ */
+
+
 #include "raw_convert.h"
 #include "compose.hpp"
 #include "subtitle_asset.h"
@@ -48,7 +54,7 @@
 #include <boost/algorithm/string.hpp>
 #include <boost/lexical_cast.hpp>
 #include <boost/shared_array.hpp>
-#include <boost/foreach.hpp>
+
 
 using std::dynamic_pointer_cast;
 using std::string;
@@ -63,53 +69,59 @@ using boost::optional;
 using boost::lexical_cast;
 using namespace dcp;
 
+
 SubtitleAsset::SubtitleAsset ()
 {
 
 }
 
+
 SubtitleAsset::SubtitleAsset (boost::filesystem::path file)
        : Asset (file)
 {
 
 }
 
+
 string
 string_attribute (xmlpp::Element const * node, string name)
 {
-       xmlpp::Attribute* a = node->get_attribute (name);
+       auto a = node->get_attribute (name);
        if (!a) {
                throw XMLError (String::compose ("missing attribute %1", name));
        }
        return string (a->get_value ());
 }
 
+
 optional<string>
 optional_string_attribute (xmlpp::Element const * node, string name)
 {
-       xmlpp::Attribute* a = node->get_attribute (name);
+       auto a = node->get_attribute (name);
        if (!a) {
-               return optional<string>();
+               return {};
        }
        return string (a->get_value ());
 }
 
+
 optional<bool>
 optional_bool_attribute (xmlpp::Element const * node, string name)
 {
-       optional<string> s = optional_string_attribute (node, name);
+       auto s = optional_string_attribute (node, name);
        if (!s) {
-               return optional<bool> ();
+               return {};
        }
 
        return (s.get() == "1" || s.get() == "yes");
 }
 
+
 template <class T>
 optional<T>
 optional_number_attribute (xmlpp::Element const * node, string name)
 {
-       boost::optional<std::string> s = optional_string_attribute (node, name);
+       auto s = optional_string_attribute (node, name);
        if (!s) {
                return boost::optional<T> ();
        }
@@ -119,6 +131,7 @@ optional_number_attribute (xmlpp::Element const * node, string name)
        return raw_convert<T> (t);
 }
 
+
 SubtitleAsset::ParseState
 SubtitleAsset::font_node_state (xmlpp::Element const * node, Standard standard) const
 {
@@ -138,11 +151,11 @@ SubtitleAsset::font_node_state (xmlpp::Element const * node, Standard standard)
        } else {
                ps.underline = optional_bool_attribute (node, "Underline");
        }
-       optional<string> c = optional_string_attribute (node, "Color");
+       auto c = optional_string_attribute (node, "Color");
        if (c) {
                ps.colour = Colour (c.get ());
        }
-       optional<string> const e = optional_string_attribute (node, "Effect");
+       auto const e = optional_string_attribute (node, "Effect");
        if (e) {
                ps.effect = string_to_effect (e.get ());
        }
@@ -157,7 +170,7 @@ SubtitleAsset::font_node_state (xmlpp::Element const * node, Standard standard)
 void
 SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element const * node) const
 {
-       optional<float> hp = optional_number_attribute<float> (node, "HPosition");
+       auto hp = optional_number_attribute<float> (node, "HPosition");
        if (!hp) {
                hp = optional_number_attribute<float> (node, "Hposition");
        }
@@ -165,7 +178,7 @@ SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element con
                ps.h_position = hp.get () / 100;
        }
 
-       optional<string> ha = optional_string_attribute (node, "HAlign");
+       auto ha = optional_string_attribute (node, "HAlign");
        if (!ha) {
                ha = optional_string_attribute (node, "Halign");
        }
@@ -173,7 +186,7 @@ SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element con
                ps.h_align = string_to_halign (ha.get ());
        }
 
-       optional<float> vp = optional_number_attribute<float> (node, "VPosition");
+       auto vp = optional_number_attribute<float> (node, "VPosition");
        if (!vp) {
                vp = optional_number_attribute<float> (node, "Vposition");
        }
@@ -181,7 +194,7 @@ SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element con
                ps.v_position = vp.get () / 100;
        }
 
-       optional<string> va = optional_string_attribute (node, "VAlign");
+       auto va = optional_string_attribute (node, "VAlign");
        if (!va) {
                va = optional_string_attribute (node, "Valign");
        }
@@ -191,6 +204,7 @@ SubtitleAsset::position_align (SubtitleAsset::ParseState& ps, xmlpp::Element con
 
 }
 
+
 SubtitleAsset::ParseState
 SubtitleAsset::text_node_state (xmlpp::Element const * node) const
 {
@@ -198,16 +212,17 @@ SubtitleAsset::text_node_state (xmlpp::Element const * node) const
 
        position_align (ps, node);
 
-       optional<string> d = optional_string_attribute (node, "Direction");
+       auto d = optional_string_attribute (node, "Direction");
        if (d) {
                ps.direction = string_to_direction (d.get ());
        }
 
-       ps.type = ParseState::TEXT;
+       ps.type = ParseState::Type::TEXT;
 
        return ps;
 }
 
+
 SubtitleAsset::ParseState
 SubtitleAsset::image_node_state (xmlpp::Element const * node) const
 {
@@ -215,11 +230,12 @@ SubtitleAsset::image_node_state (xmlpp::Element const * node) const
 
        position_align (ps, node);
 
-       ps.type = ParseState::IMAGE;
+       ps.type = ParseState::Type::IMAGE;
 
        return ps;
 }
 
+
 SubtitleAsset::ParseState
 SubtitleAsset::subtitle_node_state (xmlpp::Element const * node, optional<int> tcr) const
 {
@@ -231,10 +247,11 @@ SubtitleAsset::subtitle_node_state (xmlpp::Element const * node, optional<int> t
        return ps;
 }
 
+
 Time
 SubtitleAsset::fade_time (xmlpp::Element const * node, string name, optional<int> tcr) const
 {
-       string const u = optional_string_attribute(node, name).get_value_or ("");
+       auto const u = optional_string_attribute(node, name).get_value_or ("");
        Time t;
 
        if (u.empty ()) {
@@ -252,6 +269,7 @@ SubtitleAsset::fade_time (xmlpp::Element const * node, string name, optional<int
        return t;
 }
 
+
 void
 SubtitleAsset::parse_subtitles (xmlpp::Element const * node, vector<ParseState>& state, optional<int> tcr, Standard standard)
 {
@@ -269,13 +287,12 @@ SubtitleAsset::parse_subtitles (xmlpp::Element const * node, vector<ParseState>&
                throw XMLError ("unexpected node " + node->get_name());
        }
 
-       xmlpp::Node::NodeList c = node->get_children ();
-       for (xmlpp::Node::NodeList::const_iterator i = c.begin(); i != c.end(); ++i) {
-               xmlpp::ContentNode const * v = dynamic_cast<xmlpp::ContentNode const *> (*i);
+       for (auto i: node->get_children()) {
+               auto const v = dynamic_cast<xmlpp::ContentNode const *>(i);
                if (v) {
                        maybe_add_subtitle (v->get_content(), state, standard);
                }
-               xmlpp::Element const * e = dynamic_cast<xmlpp::Element const *> (*i);
+               auto const e = dynamic_cast<xmlpp::Element const *>(i);
                if (e) {
                        parse_subtitles (e, state, tcr, standard);
                }
@@ -284,6 +301,7 @@ SubtitleAsset::parse_subtitles (xmlpp::Element const * node, vector<ParseState>&
        state.pop_back ();
 }
 
+
 void
 SubtitleAsset::maybe_add_subtitle (string text, vector<ParseState> const & parse_state, Standard standard)
 {
@@ -292,7 +310,7 @@ SubtitleAsset::maybe_add_subtitle (string text, vector<ParseState> const & parse
        }
 
        ParseState ps;
-       BOOST_FOREACH (ParseState const & i, parse_state) {
+       for (auto const& i: parse_state) {
                if (i.font_id) {
                        ps.font_id = i.font_id.get();
                }
@@ -360,53 +378,70 @@ SubtitleAsset::maybe_add_subtitle (string text, vector<ParseState> const & parse
        DCP_ASSERT (ps.type);
 
        switch (ps.type.get()) {
-       case ParseState::TEXT:
+       case ParseState::Type::TEXT:
                _subtitles.push_back (
-                       shared_ptr<Subtitle> (
-                               new SubtitleString (
-                                       ps.font_id,
-                                       ps.italic.get_value_or (false),
-                                       ps.bold.get_value_or (false),
-                                       ps.underline.get_value_or (false),
-                                       ps.colour.get_value_or (dcp::Colour (255, 255, 255)),
-                                       ps.size.get_value_or (42),
-                                       ps.aspect_adjust.get_value_or (1.0),
-                                       ps.in.get(),
-                                       ps.out.get(),
-                                       ps.h_position.get_value_or(0),
-                                       ps.h_align.get_value_or(HAlign::CENTER),
-                                       ps.v_position.get_value_or(0),
-                                       ps.v_align.get_value_or(VAlign::CENTER),
-                                       ps.direction.get_value_or (Direction::LTR),
-                                       text,
-                                       ps.effect.get_value_or (Effect::NONE),
-                                       ps.effect_colour.get_value_or (dcp::Colour (0, 0, 0)),
-                                       ps.fade_up_time.get_value_or(Time()),
-                                       ps.fade_down_time.get_value_or(Time())
-                                       )
+                       make_shared<SubtitleString>(
+                               ps.font_id,
+                               ps.italic.get_value_or (false),
+                               ps.bold.get_value_or (false),
+                               ps.underline.get_value_or (false),
+                               ps.colour.get_value_or (dcp::Colour (255, 255, 255)),
+                               ps.size.get_value_or (42),
+                               ps.aspect_adjust.get_value_or (1.0),
+                               ps.in.get(),
+                               ps.out.get(),
+                               ps.h_position.get_value_or(0),
+                               ps.h_align.get_value_or(HAlign::CENTER),
+                               ps.v_position.get_value_or(0),
+                               ps.v_align.get_value_or(VAlign::CENTER),
+                               ps.direction.get_value_or (Direction::LTR),
+                               text,
+                               ps.effect.get_value_or (Effect::NONE),
+                               ps.effect_colour.get_value_or (dcp::Colour (0, 0, 0)),
+                               ps.fade_up_time.get_value_or(Time()),
+                               ps.fade_down_time.get_value_or(Time())
                                )
                        );
                break;
-       case ParseState::IMAGE:
+       case ParseState::Type::IMAGE:
+       {
+               switch (standard) {
+               case Standard::INTEROP:
+                       if (text.size() >= 4) {
+                               /* Remove file extension */
+                               text = text.substr(0, text.size() - 4);
+                       }
+                       break;
+               case Standard::SMPTE:
+                       /* It looks like this urn:uuid: is required, but DoM wasn't expecting it (and not writing it)
+                        * until around 2.15.140 so I guess either:
+                        *   a) it is not (always) used in the field, or
+                        *   b) nobody noticed / complained.
+                        */
+                       if (text.substr(0, 9) == "urn:uuid:") {
+                               text = text.substr(9);
+                       }
+                       break;
+               }
+
                /* Add a subtitle with no image data and we'll fill that in later */
                _subtitles.push_back (
-                       shared_ptr<Subtitle> (
-                               new SubtitleImage (
-                                       ArrayData (),
-                                       standard == Standard::INTEROP ? text.substr(0, text.size() - 4) : text,
-                                       ps.in.get(),
-                                       ps.out.get(),
-                                       ps.h_position.get_value_or(0),
-                                       ps.h_align.get_value_or(HAlign::CENTER),
-                                       ps.v_position.get_value_or(0),
-                                       ps.v_align.get_value_or(VAlign::CENTER),
-                                       ps.fade_up_time.get_value_or(Time()),
-                                       ps.fade_down_time.get_value_or(Time())
-                                       )
+                       make_shared<SubtitleImage>(
+                               ArrayData(),
+                               text,
+                               ps.in.get(),
+                               ps.out.get(),
+                               ps.h_position.get_value_or(0),
+                               ps.h_align.get_value_or(HAlign::CENTER),
+                               ps.v_position.get_value_or(0),
+                               ps.v_align.get_value_or(VAlign::CENTER),
+                               ps.fade_up_time.get_value_or(Time()),
+                               ps.fade_down_time.get_value_or(Time())
                                )
                        );
                break;
        }
+       }
 }
 
 
@@ -461,11 +496,12 @@ SubtitleAsset::add (shared_ptr<Subtitle> s)
        _subtitles.push_back (s);
 }
 
+
 Time
 SubtitleAsset::latest_subtitle_out () const
 {
        Time t;
-       BOOST_FOREACH (shared_ptr<Subtitle> i, _subtitles) {
+       for (auto i: _subtitles) {
                if (i->out() > t) {
                        t = i->out ();
                }
@@ -474,6 +510,7 @@ SubtitleAsset::latest_subtitle_out () const
        return t;
 }
 
+
 bool
 SubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
 {
@@ -481,7 +518,7 @@ SubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions opti
                return false;
        }
 
-       shared_ptr<const SubtitleAsset> other = dynamic_pointer_cast<const SubtitleAsset> (other_asset);
+       auto other = dynamic_pointer_cast<const SubtitleAsset> (other_asset);
        if (!other) {
                return false;
        }
@@ -495,10 +532,10 @@ SubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions opti
        auto j = other->_subtitles.begin();
 
        while (i != _subtitles.end()) {
-               shared_ptr<SubtitleString> string_i = dynamic_pointer_cast<SubtitleString> (*i);
-               shared_ptr<SubtitleString> string_j = dynamic_pointer_cast<SubtitleString> (*j);
-               shared_ptr<SubtitleImage> image_i = dynamic_pointer_cast<SubtitleImage> (*i);
-               shared_ptr<SubtitleImage> image_j = dynamic_pointer_cast<SubtitleImage> (*j);
+               auto string_i = dynamic_pointer_cast<SubtitleString> (*i);
+               auto string_j = dynamic_pointer_cast<SubtitleString> (*j);
+               auto image_i = dynamic_pointer_cast<SubtitleImage> (*i);
+               auto image_j = dynamic_pointer_cast<SubtitleImage> (*j);
 
                if ((string_i && !string_j) || (image_i && !image_j)) {
                        note (NoteType::ERROR, "subtitles differ: string vs. image");
@@ -521,6 +558,7 @@ SubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions opti
        return true;
 }
 
+
 struct SubtitleSorter
 {
        bool operator() (shared_ptr<Subtitle> a, shared_ptr<Subtitle> b) {
@@ -531,6 +569,7 @@ struct SubtitleSorter
        }
 };
 
+
 void
 SubtitleAsset::pull_fonts (shared_ptr<order::Part> part)
 {
@@ -539,7 +578,7 @@ SubtitleAsset::pull_fonts (shared_ptr<order::Part> part)
        }
 
        /* Pull up from children */
-       BOOST_FOREACH (shared_ptr<order::Part> i, part->children) {
+       for (auto i: part->children) {
                pull_fonts (i);
        }
 
@@ -548,12 +587,12 @@ SubtitleAsset::pull_fonts (shared_ptr<order::Part> part)
                   these features go into part's font.
                */
                part->font = part->children.front()->font;
-               BOOST_FOREACH (shared_ptr<order::Part> i, part->children) {
+               for (auto i: part->children) {
                        part->font.take_intersection (i->font);
                }
 
                /* Remove common values from part's children's fonts */
-               BOOST_FOREACH (shared_ptr<order::Part> i, part->children) {
+               for (auto i: part->children) {
                        i->font.take_difference (part->font);
                }
        }
@@ -591,20 +630,21 @@ SubtitleAsset::pull_fonts (shared_ptr<order::Part> part)
        part->children = merged;
 }
 
+
 /** @param standard Standard (INTEROP or SMPTE); this is used rather than putting things in the child
  *  class because the differences between the two are fairly subtle.
  */
 void
 SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, Standard standard) const
 {
-       vector<shared_ptr<Subtitle> > sorted = _subtitles;
+       auto sorted = _subtitles;
        std::stable_sort(sorted.begin(), sorted.end(), SubtitleSorter());
 
        /* Gather our subtitles into a hierarchy of Subtitle/Text/String objects, writing
           font information into the bottom level (String) objects.
        */
 
-       shared_ptr<order::Part> root (new order::Part (shared_ptr<order::Part> ()));
+       auto root = make_shared<order::Part>(shared_ptr<order::Part>());
        shared_ptr<order::Subtitle> subtitle;
        shared_ptr<order::Text> text;
 
@@ -618,7 +658,7 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, S
        float last_v_position;
        Direction last_direction;
 
-       BOOST_FOREACH (shared_ptr<Subtitle> i, sorted) {
+       for (auto i: sorted) {
                if (!subtitle ||
                    (last_in != i->in() ||
                     last_out != i->out() ||
@@ -626,7 +666,7 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, S
                     last_fade_down_time != i->fade_down_time())
                        ) {
 
-                       subtitle.reset (new order::Subtitle (root, i->in(), i->out(), i->fade_up_time(), i->fade_down_time()));
+                       subtitle = make_shared<order::Subtitle>(root, i->in(), i->out(), i->fade_up_time(), i->fade_down_time());
                        root->children.push_back (subtitle);
 
                        last_in = i->in ();
@@ -636,7 +676,7 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, S
                        text.reset ();
                }
 
-               shared_ptr<SubtitleString> is = dynamic_pointer_cast<SubtitleString>(i);
+               auto is = dynamic_pointer_cast<SubtitleString>(i);
                if (is) {
                        if (!text ||
                            last_h_align != is->h_align() ||
@@ -655,14 +695,14 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, S
                                last_direction = is->direction ();
                        }
 
-                       text->children.push_back (shared_ptr<order::String> (new order::String (text, order::Font (is, standard), is->text())));
+                       text->children.push_back (make_shared<order::String>(text, order::Font (is, standard), is->text()));
                }
 
-               shared_ptr<SubtitleImage> ii = dynamic_pointer_cast<SubtitleImage>(i);
+               auto ii = dynamic_pointer_cast<SubtitleImage>(i);
                if (ii) {
                        text.reset ();
                        subtitle->children.push_back (
-                               shared_ptr<order::Image> (new order::Image (subtitle, ii->id(), ii->png_image(), ii->h_align(), ii->h_position(), ii->v_align(), ii->v_position()))
+                               make_shared<order::Image>(subtitle, ii->id(), ii->png_image(), ii->h_align(), ii->h_position(), ii->v_align(), ii->v_position())
                                );
                }
        }
@@ -681,11 +721,12 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* xml_root, int time_code_rate, S
        root->write_xml (xml_root, context);
 }
 
+
 map<string, ArrayData>
 SubtitleAsset::font_data () const
 {
        map<string, ArrayData> out;
-       BOOST_FOREACH (Font const & i, _fonts) {
+       for (auto const& i: _fonts) {
                out[i.load_id] = i.data;
        }
        return out;
@@ -696,7 +737,7 @@ map<string, boost::filesystem::path>
 SubtitleAsset::font_filenames () const
 {
        map<string, boost::filesystem::path> out;
-       BOOST_FOREACH (Font const& i, _fonts) {
+       for (auto const& i: _fonts) {
                if (i.file) {
                        out[i.load_id] = *i.file;
                }
@@ -714,7 +755,7 @@ SubtitleAsset::fix_empty_font_ids ()
 {
        bool have_empty = false;
        vector<string> ids;
-       BOOST_FOREACH (shared_ptr<LoadFontNode> i, load_font_nodes()) {
+       for (auto i: load_font_nodes()) {
                if (i->id == "") {
                        have_empty = true;
                } else {
@@ -728,14 +769,14 @@ SubtitleAsset::fix_empty_font_ids ()
 
        string const empty_id = unique_string (ids, "font");
 
-       BOOST_FOREACH (shared_ptr<LoadFontNode> i, load_font_nodes()) {
+       for (auto i: load_font_nodes()) {
                if (i->id == "") {
                        i->id = empty_id;
                }
        }
 
-       BOOST_FOREACH (shared_ptr<Subtitle> i, _subtitles) {
-               shared_ptr<SubtitleString> j = dynamic_pointer_cast<SubtitleString> (i);
+       for (auto i: _subtitles) {
+               auto j = dynamic_pointer_cast<SubtitleString> (i);
                if (j && j->font() && j->font().get() == "") {
                        j->set_font (empty_id);
                }