Remove all use of add_child() from xmlpp.
[dcpomatic.git] / src / lib / film.cc
index 7ba245422a94329c0e54788d075101db2687f86c..a88e8a855573d62a270ccf9a2eb35a428b9df0aa 100644 (file)
@@ -114,6 +114,7 @@ using namespace dcpomatic;
 
 
 static constexpr char metadata_file[] = "metadata.xml";
+static constexpr char ui_state_file[] = "ui.xml";
 
 
 /* 5 -> 6
@@ -379,87 +380,91 @@ Film::metadata (bool with_content_paths) const
        auto doc = make_shared<xmlpp::Document>();
        auto root = doc->create_root_node ("Metadata");
 
-       root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
-       auto last_write = root->add_child("LastWrittenBy");
+       cxml::add_text_child(root, "Version", raw_convert<string>(current_state_version));
+       auto last_write = cxml::add_child(root, "LastWrittenBy");
        last_write->add_child_text (dcpomatic_version);
        last_write->set_attribute("git", dcpomatic_git_commit);
-       root->add_child("Name")->add_child_text (_name);
-       root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
+       cxml::add_text_child(root, "Name", _name);
+       cxml::add_text_child(root, "UseISDCFName", _use_isdcf_name ? "1" : "0");
 
        if (_dcp_content_type) {
-               root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
+               cxml::add_text_child(root, "DCPContentType", _dcp_content_type->isdcf_name());
        }
 
        if (_container) {
-               root->add_child("Container")->add_child_text (_container->id ());
-       }
-
-       root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
-       root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
-       root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
-       root->add_child("AudioFrameRate")->add_child_text(raw_convert<string>(_audio_frame_rate));
-       root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
-       root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
-       root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
-       root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
-       root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
-       root->add_child("LimitToSMPTEBv20")->add_child_text(_limit_to_smpte_bv20 ? "1" : "0");
-       root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
-       root->add_child("Key")->add_child_text (_key.hex ());
-       root->add_child("ContextID")->add_child_text (_context_id);
+               cxml::add_text_child(root, "Container", _container->id());
+       }
+
+       cxml::add_text_child(root, "Resolution", resolution_to_string(_resolution));
+       cxml::add_text_child(root, "J2KBandwidth", raw_convert<string>(_j2k_bandwidth));
+       cxml::add_text_child(root, "VideoFrameRate", raw_convert<string>(_video_frame_rate));
+       cxml::add_text_child(root, "AudioFrameRate", raw_convert<string>(_audio_frame_rate));
+       cxml::add_text_child(root, "ISDCFDate", boost::gregorian::to_iso_string(_isdcf_date));
+       cxml::add_text_child(root, "AudioChannels", raw_convert<string>(_audio_channels));
+       cxml::add_text_child(root, "ThreeD", _three_d ? "1" : "0");
+       cxml::add_text_child(root, "Sequence", _sequence ? "1" : "0");
+       cxml::add_text_child(root, "Interop", _interop ? "1" : "0");
+       cxml::add_text_child(root, "LimitToSMPTEBv20", _limit_to_smpte_bv20 ? "1" : "0");
+       cxml::add_text_child(root, "Encrypted", _encrypted ? "1" : "0");
+       cxml::add_text_child(root, "Key", _key.hex ());
+       cxml::add_text_child(root, "ContextID", _context_id);
        if (_audio_processor) {
-               root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
+               cxml::add_text_child(root, "AudioProcessor", _audio_processor->id());
        }
-       root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
-       root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
-       root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
-       root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
+       cxml::add_text_child(root, "ReelType", raw_convert<string>(static_cast<int> (_reel_type)));
+       cxml::add_text_child(root, "ReelLength", raw_convert<string>(_reel_length));
+       for (auto boundary: _custom_reel_boundaries) {
+               cxml::add_text_child(root, "CustomReelBoundary", raw_convert<string>(boundary.get()));
+       }
+       cxml::add_text_child(root, "ReencodeJ2K", _reencode_j2k ? "1" : "0");
+       cxml::add_text_child(root, "UserExplicitVideoFrameRate", _user_explicit_video_frame_rate ? "1" : "0");
        for (auto const& marker: _markers) {
-               auto m = root->add_child("Marker");
-               m->set_attribute("Type", dcp::marker_to_string(marker.first));
+               auto m = cxml::add_child(root, "Marker");
+               m->set_attribute("type", dcp::marker_to_string(marker.first));
                m->add_child_text(raw_convert<string>(marker.second.get()));
        }
        for (auto i: _ratings) {
-               i.as_xml (root->add_child("Rating"));
+               i.as_xml(cxml::add_child(root, "Rating"));
        }
        for (auto i: _content_versions) {
-               root->add_child("ContentVersion")->add_child_text(i);
+               cxml::add_text_child(root, "ContentVersion", i);
        }
-       root->add_child("NameLanguage")->add_child_text(_name_language.to_string());
+       cxml::add_text_child(root, "NameLanguage", _name_language.to_string());
+       cxml::add_text_child(root, "TerritoryType", territory_type_to_string(_territory_type));
        if (_release_territory) {
-               root->add_child("ReleaseTerritory")->add_child_text(_release_territory->subtag());
+               cxml::add_text_child(root, "ReleaseTerritory", _release_territory->subtag());
        }
        if (_sign_language_video_language) {
-               root->add_child("SignLanguageVideoLanguage")->add_child_text(_sign_language_video_language->to_string());
+               cxml::add_text_child(root, "SignLanguageVideoLanguage", _sign_language_video_language->to_string());
        }
-       root->add_child("VersionNumber")->add_child_text(raw_convert<string>(_version_number));
-       root->add_child("Status")->add_child_text(dcp::status_to_string(_status));
+       cxml::add_text_child(root, "VersionNumber", raw_convert<string>(_version_number));
+       cxml::add_text_child(root, "Status", dcp::status_to_string(_status));
        if (_chain) {
-               root->add_child("Chain")->add_child_text(*_chain);
+               cxml::add_text_child(root, "Chain", *_chain);
        }
        if (_distributor) {
-               root->add_child("Distributor")->add_child_text(*_distributor);
+               cxml::add_text_child(root, "Distributor", *_distributor);
        }
        if (_facility) {
-               root->add_child("Facility")->add_child_text(*_facility);
+               cxml::add_text_child(root, "Facility", *_facility);
        }
        if (_studio) {
-               root->add_child("Studio")->add_child_text(*_studio);
+               cxml::add_text_child(root, "Studio", *_studio);
        }
-       root->add_child("TempVersion")->add_child_text(_temp_version ? "1" : "0");
-       root->add_child("PreRelease")->add_child_text(_pre_release ? "1" : "0");
-       root->add_child("RedBand")->add_child_text(_red_band ? "1" : "0");
-       root->add_child("TwoDVersionOfThreeD")->add_child_text(_two_d_version_of_three_d ? "1" : "0");
+       cxml::add_text_child(root, "TempVersion", _temp_version ? "1" : "0");
+       cxml::add_text_child(root, "PreRelease", _pre_release ? "1" : "0");
+       cxml::add_text_child(root, "RedBand", _red_band ? "1" : "0");
+       cxml::add_text_child(root, "TwoDVersionOfThreeD", _two_d_version_of_three_d ? "1" : "0");
        if (_luminance) {
-               root->add_child("LuminanceValue")->add_child_text(raw_convert<string>(_luminance->value()));
-               root->add_child("LuminanceUnit")->add_child_text(dcp::Luminance::unit_to_string(_luminance->unit()));
+               cxml::add_text_child(root, "LuminanceValue", raw_convert<string>(_luminance->value()));
+               cxml::add_text_child(root, "LuminanceUnit", dcp::Luminance::unit_to_string(_luminance->unit()));
        }
-       root->add_child("UserExplicitContainer")->add_child_text(_user_explicit_container ? "1" : "0");
-       root->add_child("UserExplicitResolution")->add_child_text(_user_explicit_resolution ? "1" : "0");
+       cxml::add_text_child(root, "UserExplicitContainer", _user_explicit_container ? "1" : "0");
+       cxml::add_text_child(root, "UserExplicitResolution", _user_explicit_resolution ? "1" : "0");
        if (_audio_language) {
-               root->add_child("AudioLanguage")->add_child_text(_audio_language->to_string());
+               cxml::add_text_child(root, "AudioLanguage", _audio_language->to_string());
        }
-       _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
+       _playlist->as_xml(cxml::add_child(root, "Playlist"), with_content_paths);
 
        return doc;
 }
@@ -598,11 +603,18 @@ Film::read_metadata (optional<boost::filesystem::path> path)
 
        _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(ReelType::SINGLE)));
        _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
+       for (auto boundary: f.node_children("CustomReelBoundary")) {
+               _custom_reel_boundaries.push_back(DCPTime(raw_convert<int64_t>(boundary->content())));
+       }
        _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
        _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
 
        for (auto i: f.node_children("Marker")) {
-               _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
+               auto type = i->optional_string_attribute("Type");
+               if (!type) {
+                       type = i->string_attribute("type");
+               }
+               _markers[dcp::marker_from_string(*type)] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
        }
 
        for (auto i: f.node_children("Rating")) {
@@ -617,6 +629,10 @@ Film::read_metadata (optional<boost::filesystem::path> path)
        if (name_language) {
                _name_language = dcp::LanguageTag (*name_language);
        }
+       auto territory_type = f.optional_string_child("TerritoryType");
+       if (territory_type) {
+               _territory_type = string_to_territory_type(*territory_type);
+       }
        auto release_territory = f.optional_string_child("ReleaseTerritory");
        if (release_territory) {
                _release_territory = dcp::LanguageTag::RegionSubtag (*release_territory);
@@ -771,16 +787,27 @@ Film::mapped_audio_channels () const
 
 
 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>>
-Film::subtitle_languages () const
+Film::subtitle_languages(bool* burnt_in) const
 {
+       if (burnt_in) {
+               *burnt_in = true;
+       }
+
        pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>> result;
        for (auto i: content()) {
+               auto dcp = dynamic_pointer_cast<DCPContent>(i);
                for (auto const& text: i->text) {
-                       if (text->use() && text->type() == TextType::OPEN_SUBTITLE && text->language()) {
-                               if (text->language_is_additional()) {
-                                       result.second.push_back(text->language().get());
-                               } else {
-                                       result.first = text->language().get();
+                       auto const use = text->use() || (dcp && dcp->reference_text(TextType::OPEN_SUBTITLE));
+                       if (use && text->type() == TextType::OPEN_SUBTITLE) {
+                               if (!text->burn() && burnt_in) {
+                                       *burnt_in = false;
+                               }
+                               if (text->language()) {
+                                       if (text->language_is_additional()) {
+                                               result.second.push_back(text->language().get());
+                                       } else {
+                                               result.first = text->language().get();
+                                       }
                                }
                        }
                }
@@ -927,10 +954,12 @@ Film::isdcf_name (bool if_created_now) const
        if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::ContentKind::TRAILER) {
                auto first_video = std::find_if(content_list.begin(), content_list.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->video); });
                if (first_video != content_list.end()) {
-                       auto first_ratio = lrintf((*first_video)->video->scaled_size(frame_size()).ratio() * 100);
-                       auto container_ratio = lrintf(container()->ratio() * 100);
-                       if (first_ratio != container_ratio) {
-                               isdcf_name += "-" + dcp::raw_convert<string>(first_ratio);
+                       if (auto scaled_size = (*first_video)->video->scaled_size(frame_size())) {
+                               auto first_ratio = lrintf(scaled_size->ratio() * 100);
+                               auto container_ratio = lrintf(container()->ratio() * 100);
+                               if (first_ratio != container_ratio) {
+                                       isdcf_name += "-" + dcp::raw_convert<string>(first_ratio);
+                               }
                        }
                }
        }
@@ -950,16 +979,8 @@ Film::isdcf_name (bool if_created_now) const
 
        isdcf_name += "_" + to_upper (audio_language);
 
-       auto burnt_in = true;
-       for (auto i: content_list) {
-               for (auto text: i->text) {
-                       if (text->type() == TextType::OPEN_SUBTITLE && text->use() && !text->burn()) {
-                               burnt_in = false;
-                       }
-               }
-       }
-
-       auto sub_langs = subtitle_languages();
+       bool burnt_in;
+       auto sub_langs = subtitle_languages(&burnt_in);
        auto ccap_langs = closed_caption_languages();
        if (sub_langs.first && sub_langs.first->language()) {
                auto lang = entry_for_language(*sub_langs.first);
@@ -977,7 +998,11 @@ Film::isdcf_name (bool if_created_now) const
                isdcf_name += "-XX";
        }
 
-       if (_release_territory) {
+       if (_territory_type == TerritoryType::INTERNATIONAL_TEXTED) {
+               isdcf_name += "_INT-TD";
+       } else if (_territory_type == TerritoryType::INTERNATIONAL_TEXTLESS) {
+               isdcf_name += "_INT-TL";
+       } else if (_release_territory) {
                auto territory = _release_territory->subtag();
                isdcf_name += "_" + to_upper (territory);
                if (!_ratings.empty()) {
@@ -1214,6 +1239,16 @@ Film::set_reel_length (int64_t r)
        _reel_length = r;
 }
 
+
+void
+Film::set_custom_reel_boundaries(vector<DCPTime> boundaries)
+{
+       FilmChangeSignaller ch(this, FilmProperty::CUSTOM_REEL_BOUNDARIES);
+       std::sort(boundaries.begin(), boundaries.end());
+       _custom_reel_boundaries = std::move(boundaries);
+}
+
+
 void
 Film::set_reencode_j2k (bool r)
 {
@@ -1400,7 +1435,9 @@ Film::add_content (shared_ptr<Content> c)
 
        maybe_set_container_and_resolution ();
        if (c->atmos) {
-               set_audio_channels (14);
+               if (_audio_channels < 14) {
+                       set_audio_channels(14);
+               }
                set_interop (false);
        }
 }
@@ -1421,13 +1458,13 @@ Film::maybe_set_container_and_resolution ()
                }
        }
 
-       if (video) {
+       if (video && video->size()) {
                /* This is the only piece of video content in this Film.  Use it to make a guess for
                 * DCP container size and resolution, unless the user has already explicitly set these
                 * things.
                 */
                if (!_user_explicit_container) {
-                       if (video->size().ratio() > 2.3) {
+                       if (video->size()->ratio() > 2.3) {
                                set_container (Ratio::from_id("239"), false);
                        } else {
                                set_container (Ratio::from_id("185"), false);
@@ -1435,7 +1472,7 @@ Film::maybe_set_container_and_resolution ()
                }
 
                if (!_user_explicit_resolution) {
-                       if (video->size_after_crop().width > 2048 || video->size_after_crop().height > 1080) {
+                       if (video->size_after_crop()->width > 2048 || video->size_after_crop()->height > 1080) {
                                set_resolution (Resolution::FOUR_K, false);
                        } else {
                                set_resolution (Resolution::TWO_K, false);
@@ -1579,6 +1616,23 @@ Film::check_settings_consistency ()
        if (change_made) {
                Message (_("DCP-o-matic had to change your settings for referring to DCPs as OV.  Please review those settings to make sure they are what you want."));
        }
+
+       if (reel_type() == ReelType::CUSTOM) {
+               auto boundaries = custom_reel_boundaries();
+               auto too_late = std::find_if(boundaries.begin(), boundaries.end(), [this](dcpomatic::DCPTime const& time) {
+                       return time >= length();
+               });
+
+               if (too_late != boundaries.end()) {
+                       if (std::distance(too_late, boundaries.end()) > 1) {
+                               Message(_("DCP-o-matic had to remove some of your custom reel boundaries as they no longer lie within the film."));
+                       } else {
+                               Message(_("DCP-o-matic had to remove one of your custom reel boundaries as it no longer lies within the film."));
+                       }
+                       boundaries.erase(too_late, boundaries.end());
+                       set_custom_reel_boundaries(boundaries);
+               }
+       }
 }
 
 void
@@ -1633,9 +1687,10 @@ Film::active_area () const
 
        for (auto i: content()) {
                if (i->video) {
-                       dcp::Size s = i->video->scaled_size (frame);
-                       active.width = max(active.width, s.width);
-                       active.height = max(active.height, s.height);
+                       if (auto s = i->video->scaled_size(frame)) {
+                               active.width = max(active.width, s->width);
+                               active.height = max(active.height, s->height);
+                       }
                }
        }
 
@@ -1782,15 +1837,16 @@ Film::audio_analysis_finished ()
        /* XXX */
 }
 
-list<DCPTimePeriod>
+
+vector<DCPTimePeriod>
 Film::reels () const
 {
-       list<DCPTimePeriod> p;
+       vector<DCPTimePeriod> periods;
        auto const len = length();
 
        switch (reel_type ()) {
        case ReelType::SINGLE:
-               p.push_back (DCPTimePeriod (DCPTime (), len));
+               periods.emplace_back(DCPTime(), len);
                break;
        case ReelType::BY_VIDEO_CONTENT:
        {
@@ -1815,7 +1871,7 @@ Film::reels () const
                for (auto t: split_points) {
                        if (last && (t - *last) >= DCPTime::from_seconds(1)) {
                                /* Period from *last to t is long enough; use it and start a new one */
-                               p.push_back (DCPTimePeriod(*last, t));
+                               periods.emplace_back(*last, t);
                                last = t;
                        } else if (!last) {
                                /* That was the first time, so start a new period */
@@ -1823,8 +1879,8 @@ Film::reels () const
                        }
                }
 
-               if (!p.empty()) {
-                       p.back().to = split_points.back();
+               if (!periods.empty()) {
+                       periods.back().to = split_points.back();
                }
                break;
        }
@@ -1837,16 +1893,29 @@ Film::reels () const
                Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
                while (current < len) {
                        DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
-                       p.push_back (DCPTimePeriod (current, end));
+                       periods.emplace_back(current, end);
                        current = end;
                }
                break;
        }
+       case ReelType::CUSTOM:
+       {
+               DCPTimePeriod current;
+               for (auto boundary: _custom_reel_boundaries) {
+                       current.to = boundary;
+                       periods.push_back(current);
+                       current.from = boundary;
+               }
+               current.to = len;
+               periods.push_back(current);
+               break;
+       }
        }
 
-       return p;
+       return periods;
 }
 
+
 /** @param period A period within the DCP
  *  @return Name of the content which most contributes to the given period.
  */
@@ -2205,3 +2274,61 @@ Film::last_written_by_earlier_than(int major, int minor, int micro) const
        return our_micro < micro;
 }
 
+
+void
+Film::set_territory_type(TerritoryType type)
+{
+       FilmChangeSignaller ch(this, FilmProperty::TERRITORY_TYPE);
+       _territory_type = type;
+}
+
+
+void
+Film::set_ui_state(string key, string value)
+{
+       _ui_state[key] = value;
+       write_ui_state();
+}
+
+
+boost::optional<std::string>
+Film::ui_state(string key) const
+{
+       auto iter = _ui_state.find(key);
+       if (iter == _ui_state.end()) {
+               return {};
+       }
+
+       return iter->second;
+}
+
+
+void
+Film::write_ui_state() const
+{
+       auto doc = make_shared<xmlpp::Document>();
+       auto root = doc->create_root_node("UI");
+
+       for (auto state: _ui_state) {
+               cxml::add_text_child(root, state.first, state.second);
+       }
+
+       try {
+               doc->write_to_file_formatted(dcp::filesystem::fix_long_path(file(ui_state_file)).string());
+       } catch (...) {}
+}
+
+
+void
+Film::read_ui_state()
+{
+       try {
+               cxml::Document xml("UI");
+               xml.read_file(dcp::filesystem::fix_long_path(file(ui_state_file)));
+               for (auto node: xml.node_children()) {
+                       if (!node->is_text()) {
+                               _ui_state[node->name()] = node->content();
+                       }
+               }
+       } catch (...) {}
+}