2 Copyright (C) 2012-2018 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.
34 #include "interop_subtitle_asset.h"
35 #include "interop_load_font_node.h"
36 #include "subtitle_asset_internal.h"
38 #include "raw_convert.h"
40 #include "font_asset.h"
41 #include "dcp_assert.h"
42 #include "compose.hpp"
43 #include "subtitle_image.h"
44 #include <libxml++/libxml++.h>
45 #include <boost/foreach.hpp>
46 #include <boost/weak_ptr.hpp>
55 using std::shared_ptr;
56 using boost::shared_array;
57 using boost::optional;
58 using std::dynamic_pointer_cast;
61 InteropSubtitleAsset::InteropSubtitleAsset (boost::filesystem::path file)
62 : SubtitleAsset (file)
64 _raw_xml = dcp::file_to_string (file);
66 shared_ptr<cxml::Document> xml (new cxml::Document ("DCSubtitle"));
67 xml->read_file (file);
68 _id = xml->string_child ("SubtitleID");
69 _reel_number = xml->string_child ("ReelNumber");
70 _language = xml->string_child ("Language");
71 _movie_title = xml->string_child ("MovieTitle");
72 _load_font_nodes = type_children<InteropLoadFontNode> (xml, "LoadFont");
74 /* Now we need to drop down to xmlpp */
77 xmlpp::Node::NodeList c = xml->node()->get_children ();
78 for (xmlpp::Node::NodeList::const_iterator i = c.begin(); i != c.end(); ++i) {
79 xmlpp::Element const * e = dynamic_cast<xmlpp::Element const *> (*i);
80 if (e && (e->get_name() == "Font" || e->get_name() == "Subtitle")) {
81 parse_subtitles (e, ps, optional<int>(), INTEROP);
85 BOOST_FOREACH (shared_ptr<Subtitle> i, _subtitles) {
86 shared_ptr<SubtitleImage> si = dynamic_pointer_cast<SubtitleImage>(i);
88 si->read_png_file (file.parent_path() / String::compose("%1.png", si->id()));
93 InteropSubtitleAsset::InteropSubtitleAsset ()
99 InteropSubtitleAsset::xml_as_string () const
102 xmlpp::Element* root = doc.create_root_node ("DCSubtitle");
103 root->set_attribute ("Version", "1.0");
105 root->add_child("SubtitleID")->add_child_text (_id);
106 root->add_child("MovieTitle")->add_child_text (_movie_title);
107 root->add_child("ReelNumber")->add_child_text (raw_convert<string> (_reel_number));
108 root->add_child("Language")->add_child_text (_language);
110 for (list<shared_ptr<InteropLoadFontNode> >::const_iterator i = _load_font_nodes.begin(); i != _load_font_nodes.end(); ++i) {
111 xmlpp::Element* load_font = root->add_child("LoadFont");
112 load_font->set_attribute ("Id", (*i)->id);
113 load_font->set_attribute ("URI", (*i)->uri);
116 subtitles_as_xml (root, 250, INTEROP);
118 return doc.write_to_string ("UTF-8");
122 InteropSubtitleAsset::add_font (string load_id, dcp::ArrayData data)
124 _fonts.push_back (Font(load_id, make_uuid(), data));
125 string const uri = String::compose("font_%1.ttf", _load_font_nodes.size());
126 _load_font_nodes.push_back (shared_ptr<InteropLoadFontNode>(new InteropLoadFontNode(load_id, uri)));
130 InteropSubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
132 if (!SubtitleAsset::equals (other_asset, options, note)) {
136 shared_ptr<const InteropSubtitleAsset> other = dynamic_pointer_cast<const InteropSubtitleAsset> (other_asset);
141 if (!options.load_font_nodes_can_differ) {
142 list<shared_ptr<InteropLoadFontNode> >::const_iterator i = _load_font_nodes.begin ();
143 list<shared_ptr<InteropLoadFontNode> >::const_iterator j = other->_load_font_nodes.begin ();
145 while (i != _load_font_nodes.end ()) {
146 if (j == other->_load_font_nodes.end ()) {
147 note (DCP_ERROR, "<LoadFont> nodes differ");
152 note (DCP_ERROR, "<LoadFont> nodes differ");
161 if (_movie_title != other->_movie_title) {
162 note (DCP_ERROR, "Subtitle movie titles differ");
169 list<shared_ptr<LoadFontNode> >
170 InteropSubtitleAsset::load_font_nodes () const
172 list<shared_ptr<LoadFontNode> > lf;
173 copy (_load_font_nodes.begin(), _load_font_nodes.end(), back_inserter (lf));
177 /** Write this content to an XML file with its fonts alongside */
179 InteropSubtitleAsset::write (boost::filesystem::path p) const
181 FILE* f = fopen_boost (p, "w");
183 throw FileError ("Could not open file for writing", p, -1);
186 string const s = xml_as_string ();
187 /* length() here gives bytes not characters */
188 fwrite (s.c_str(), 1, s.length(), f);
193 /* Image subtitles */
194 BOOST_FOREACH (shared_ptr<dcp::Subtitle> i, _subtitles) {
195 shared_ptr<dcp::SubtitleImage> im = dynamic_pointer_cast<dcp::SubtitleImage> (i);
197 im->write_png_file(p.parent_path() / String::compose("%1.png", im->id()));
202 BOOST_FOREACH (shared_ptr<InteropLoadFontNode> i, _load_font_nodes) {
203 boost::filesystem::path file = p.parent_path() / i->uri;
204 list<Font>::const_iterator j = _fonts.begin ();
205 while (j != _fonts.end() && j->load_id != i->id) {
208 if (j != _fonts.end ()) {
209 j->data.write (file);
215 /** Look at a supplied list of assets and find the fonts. Then match these
216 * fonts up with anything requested by a <LoadFont> so that _fonts contains
217 * a list of font ID, load ID and data.
220 InteropSubtitleAsset::resolve_fonts (list<shared_ptr<Asset> > assets)
222 BOOST_FOREACH (shared_ptr<Asset> i, assets) {
223 shared_ptr<FontAsset> font = dynamic_pointer_cast<FontAsset> (i);
228 BOOST_FOREACH (shared_ptr<InteropLoadFontNode> j, _load_font_nodes) {
230 BOOST_FOREACH (Font const & k, _fonts) {
231 if (k.load_id == j->id) {
237 if (!got && font->file() && j->uri == font->file()->leaf().string()) {
238 _fonts.push_back (Font (j->id, i->id(), font->file().get()));
245 InteropSubtitleAsset::add_font_assets (list<shared_ptr<Asset> >& assets)
247 BOOST_FOREACH (Font const & i, _fonts) {
249 assets.push_back (shared_ptr<FontAsset> (new FontAsset (i.uuid, i.file.get ())));
254 InteropSubtitleAsset::write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const
256 Asset::write_to_assetmap (node, root);
258 BOOST_FOREACH (shared_ptr<dcp::Subtitle> i, _subtitles) {
259 shared_ptr<dcp::SubtitleImage> im = dynamic_pointer_cast<dcp::SubtitleImage> (i);
261 DCP_ASSERT (im->file());
262 write_file_to_assetmap (node, root, im->file().get(), im->id());
268 InteropSubtitleAsset::add_to_pkl (shared_ptr<PKL> pkl, boost::filesystem::path root) const
270 Asset::add_to_pkl (pkl, root);
272 BOOST_FOREACH (shared_ptr<dcp::Subtitle> i, _subtitles) {
273 shared_ptr<dcp::SubtitleImage> im = dynamic_pointer_cast<dcp::SubtitleImage> (i);
275 ArrayData png_image = im->png_image ();
276 pkl->add_asset (im->id(), optional<string>(), make_digest(png_image), png_image.size(), "image/png");
283 InteropSubtitleAsset::set_font_file (string load_id, boost::filesystem::path file)
285 BOOST_FOREACH (Font& i, _fonts) {
286 if (i.load_id == load_id) {
291 BOOST_FOREACH (shared_ptr<InteropLoadFontNode> i, _load_font_nodes) {
292 if (i->id == load_id) {
293 i->uri = file.filename().string();