2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
6 libdcp is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 libdcp is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with libdcp. If not, see <http://www.gnu.org/licenses/>.
19 In addition, as a special exception, the copyright holders give
20 permission to link the code of portions of this program with the
21 OpenSSL library under certain conditions as described in each
22 individual source file, and distribute linked combinations
25 You must obey the GNU General Public License in all respects
26 for all of the code used other than OpenSSL. If you modify
27 file(s) with this exception, you may extend this exception to your
28 version of the file(s), but you are not obligated to do so. If you
29 do not wish to do so, delete this exception statement from your
30 version. If you delete this exception statement from all source
31 files in the program, then also delete it here.
35 /** @file src/interop_subtitle_asset.cc
36 * @brief InteropSubtitleAsset class
40 #include "compose.hpp"
41 #include "dcp_assert.h"
42 #include "equality_options.h"
43 #include "filesystem.h"
44 #include "font_asset.h"
46 #include "interop_load_font_node.h"
47 #include "interop_subtitle_asset.h"
48 #include "raw_convert.h"
49 #include "subtitle_asset_internal.h"
50 #include "subtitle_image.h"
54 LIBDCP_DISABLE_WARNINGS
55 #include <libxml++/libxml++.h>
56 LIBDCP_ENABLE_WARNINGS
57 #include <boost/weak_ptr.hpp>
64 using std::dynamic_pointer_cast;
65 using std::make_shared;
66 using std::shared_ptr;
69 using boost::optional;
73 InteropSubtitleAsset::InteropSubtitleAsset (boost::filesystem::path file)
74 : SubtitleAsset (file)
76 _raw_xml = dcp::file_to_string (file);
78 auto xml = make_shared<cxml::Document>("DCSubtitle");
79 xml->read_file(dcp::filesystem::fix_long_path(file));
80 _id = xml->string_child ("SubtitleID");
81 _reel_number = xml->string_child ("ReelNumber");
82 _language = xml->string_child ("Language");
83 _movie_title = xml->string_child ("MovieTitle");
84 _load_font_nodes = type_children<InteropLoadFontNode> (xml, "LoadFont");
86 /* Now we need to drop down to xmlpp */
88 vector<ParseState> ps;
89 for (auto i: xml->node()->get_children()) {
90 auto e = dynamic_cast<xmlpp::Element const *>(i);
91 if (e && (e->get_name() == "Font" || e->get_name() == "Subtitle")) {
92 parse_subtitles (e, ps, optional<int>(), Standard::INTEROP);
96 for (auto i: _subtitles) {
97 auto si = dynamic_pointer_cast<SubtitleImage>(i);
99 si->read_png_file (file.parent_path() / String::compose("%1.png", si->id()));
105 InteropSubtitleAsset::InteropSubtitleAsset ()
112 InteropSubtitleAsset::xml_as_string () const
115 auto root = doc.create_root_node ("DCSubtitle");
116 root->set_attribute ("Version", "1.0");
118 cxml::add_text_child(root, "SubtitleID", _id);
119 cxml::add_text_child(root, "MovieTitle", _movie_title);
120 cxml::add_text_child(root, "ReelNumber", raw_convert<string> (_reel_number));
121 cxml::add_text_child(root, "Language", _language);
123 for (auto i: _load_font_nodes) {
124 auto load_font = cxml::add_child(root, "LoadFont");
125 load_font->set_attribute ("Id", i->id);
126 load_font->set_attribute ("URI", i->uri);
129 subtitles_as_xml (root, 250, Standard::INTEROP);
131 return format_xml(doc, {});
136 InteropSubtitleAsset::add_font (string load_id, dcp::ArrayData data)
138 _fonts.push_back (Font(load_id, make_uuid(), data));
139 auto const uri = String::compose("font_%1.ttf", _load_font_nodes.size());
140 _load_font_nodes.push_back (make_shared<InteropLoadFontNode>(load_id, uri));
145 InteropSubtitleAsset::equals(shared_ptr<const Asset> other_asset, EqualityOptions const& options, NoteHandler note) const
147 if (!SubtitleAsset::equals (other_asset, options, note)) {
151 auto other = dynamic_pointer_cast<const InteropSubtitleAsset> (other_asset);
156 if (!options.load_font_nodes_can_differ) {
157 auto i = _load_font_nodes.begin();
158 auto j = other->_load_font_nodes.begin();
160 while (i != _load_font_nodes.end ()) {
161 if (j == other->_load_font_nodes.end ()) {
162 note (NoteType::ERROR, "<LoadFont> nodes differ");
167 note (NoteType::ERROR, "<LoadFont> nodes differ");
176 if (_movie_title != other->_movie_title) {
177 note (NoteType::ERROR, "Subtitle movie titles differ");
185 vector<shared_ptr<LoadFontNode>>
186 InteropSubtitleAsset::load_font_nodes () const
188 vector<shared_ptr<LoadFontNode>> lf;
189 copy (_load_font_nodes.begin(), _load_font_nodes.end(), back_inserter (lf));
195 InteropSubtitleAsset::write (boost::filesystem::path p) const
199 throw FileError ("Could not open file for writing", p, -1);
202 _raw_xml = xml_as_string ();
203 /* length() here gives bytes not characters */
204 f.write(_raw_xml->c_str(), 1, _raw_xml->length());
208 /* Image subtitles */
209 for (auto i: _subtitles) {
210 auto im = dynamic_pointer_cast<dcp::SubtitleImage> (i);
212 im->write_png_file(p.parent_path() / String::compose("%1.png", im->id()));
217 for (auto i: _load_font_nodes) {
218 auto file = p.parent_path() / i->uri;
219 auto font_with_id = std::find_if(_fonts.begin(), _fonts.end(), [i](Font const& font) { return font.load_id == i->id; });
220 if (font_with_id != _fonts.end()) {
221 font_with_id->data.write(file);
222 font_with_id->file = file;
228 /** Look at a supplied list of assets and find the fonts. Then match these
229 * fonts up with anything requested by a <LoadFont> so that _fonts contains
230 * a list of font ID, load ID and data.
233 InteropSubtitleAsset::resolve_fonts (vector<shared_ptr<Asset>> assets)
235 for (auto asset: assets) {
236 auto font = dynamic_pointer_cast<FontAsset>(asset);
243 for (auto load_font_node: _load_font_nodes) {
244 auto const path_in_load_font_node = _file->parent_path() / load_font_node->uri;
245 if (font->file() && path_in_load_font_node == *font->file()) {
246 auto existing = std::find_if(_fonts.begin(), _fonts.end(), [load_font_node](Font const& font) { return font.load_id == load_font_node->id; });
247 if (existing != _fonts.end()) {
248 *existing = Font(load_font_node->id, asset->id(), font->file().get());
250 _fonts.push_back(Font(load_font_node->id, asset->id(), font->file().get()));
258 vector<shared_ptr<Asset>>
259 InteropSubtitleAsset::font_assets()
261 vector<shared_ptr<Asset>> assets;
262 for (auto const& i: _fonts) {
264 assets.push_back(make_shared<FontAsset>(i.uuid, i.file.get()));
270 vector<shared_ptr<const Asset>>
271 InteropSubtitleAsset::font_assets() const
273 vector<shared_ptr<const Asset>> assets;
274 for (auto const& i: _fonts) {
276 assets.push_back(make_shared<const FontAsset>(i.uuid, i.file.get()));
283 InteropSubtitleAsset::add_to_assetmap (AssetMap& asset_map, boost::filesystem::path root) const
285 Asset::add_to_assetmap(asset_map, root);
287 for (auto i: _subtitles) {
288 auto im = dynamic_pointer_cast<dcp::SubtitleImage>(i);
290 DCP_ASSERT(im->file());
291 add_file_to_assetmap(asset_map, root, im->file().get(), im->id());
298 InteropSubtitleAsset::add_to_pkl (shared_ptr<PKL> pkl, boost::filesystem::path root) const
300 Asset::add_to_pkl (pkl, root);
302 for (auto i: _subtitles) {
303 auto im = dynamic_pointer_cast<dcp::SubtitleImage> (i);
305 auto png_image = im->png_image ();
306 pkl->add_asset(im->id(), optional<string>(), make_digest(png_image), png_image.size(), "image/png", root.filename().string());
313 InteropSubtitleAsset::set_font_file (string load_id, boost::filesystem::path file)
315 for (auto& i: _fonts) {
316 if (i.load_id == load_id) {
321 for (auto i: _load_font_nodes) {
322 if (i->id == load_id) {
323 i->uri = file.filename().string();
330 InteropSubtitleAsset::unresolved_fonts() const
332 vector<string> unresolved;
333 for (auto load_font_node: _load_font_nodes) {
334 if (std::find_if(_fonts.begin(), _fonts.end(), [load_font_node](Font const& font) { return font.load_id == load_font_node->id; }) == _fonts.end()) {
335 unresolved.push_back(load_font_node->id);