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/subtitle_asset.h
36 * @brief SubtitleAsset class
40 #ifndef LIBDCP_SUBTITLE_ASSET_H
41 #define LIBDCP_SUBTITLE_ASSET_H
44 #include "array_data.h"
47 #include "subtitle_string.h"
48 #include <libcxml/cxml.h>
49 #include <boost/shared_array.hpp>
62 struct interop_dcp_font_test;
63 struct smpte_dcp_font_test;
64 struct pull_fonts_test1;
65 struct pull_fonts_test2;
66 struct pull_fonts_test3;
87 /** @class SubtitleAsset
88 * @brief A parent for classes representing a file containing subtitles
90 * This class holds a list of Subtitle objects which it can extract
91 * from the appropriate part of either an Interop or SMPTE XML file.
92 * Its subclasses InteropSubtitleAsset and SMPTESubtitleAsset handle the
93 * differences between the two types.
95 class SubtitleAsset : public Asset
99 explicit SubtitleAsset (boost::filesystem::path file);
102 std::shared_ptr<const Asset>,
107 std::vector<std::shared_ptr<const Subtitle>> subtitles_during (Time from, Time to, bool starting) const;
108 std::vector<std::shared_ptr<const Subtitle>> subtitles_in_reel(std::shared_ptr<const dcp::ReelAsset> asset) const;
109 std::vector<std::shared_ptr<const Subtitle>> subtitles () const;
111 virtual void add (std::shared_ptr<Subtitle>);
112 virtual void add_font (std::string id, dcp::ArrayData data) = 0;
113 std::map<std::string, ArrayData> font_data () const;
114 std::map<std::string, boost::filesystem::path> font_filenames () const;
116 virtual void write (boost::filesystem::path) const = 0;
117 virtual std::string xml_as_string () const = 0;
119 Time latest_subtitle_out () const;
121 void fix_empty_font_ids ();
123 virtual std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const = 0;
125 virtual int time_code_rate () const = 0;
127 /** @return Raw XML loaded from, or written to, an on-disk asset, or boost::none if
128 * - this object was not created from an existing on-disk asset and has not been written to one, or
129 * - this asset is encrypted and no key is available.
131 virtual boost::optional<std::string> raw_xml () const {
135 static std::string format_xml (xmlpp::Document const& document, std::vector<std::pair<std::string, std::string>> const& namespaces);
138 friend struct ::interop_dcp_font_test;
139 friend struct ::smpte_dcp_font_test;
142 boost::optional<std::string> font_id;
143 boost::optional<int64_t> size;
144 boost::optional<float> aspect_adjust;
145 boost::optional<bool> italic;
146 boost::optional<bool> bold;
147 boost::optional<bool> underline;
148 boost::optional<Colour> colour;
149 boost::optional<Effect> effect;
150 boost::optional<Colour> effect_colour;
151 boost::optional<float> h_position;
152 boost::optional<HAlign> h_align;
153 boost::optional<float> v_position;
154 boost::optional<VAlign> v_align;
155 boost::optional<Direction> direction;
156 boost::optional<Time> in;
157 boost::optional<Time> out;
158 boost::optional<Time> fade_up_time;
159 boost::optional<Time> fade_down_time;
164 boost::optional<Type> type;
165 float space_before = 0;
168 void parse_subtitles (xmlpp::Element const * node, std::vector<ParseState>& state, boost::optional<int> tcr, Standard standard);
169 ParseState font_node_state (xmlpp::Element const * node, Standard standard) const;
170 ParseState text_node_state (xmlpp::Element const * node) const;
171 ParseState image_node_state (xmlpp::Element const * node) const;
172 ParseState subtitle_node_state (xmlpp::Element const * node, boost::optional<int> tcr) const;
173 Time fade_time (xmlpp::Element const * node, std::string name, boost::optional<int> tcr) const;
174 void position_align (ParseState& ps, xmlpp::Element const * node) const;
176 void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const;
178 /** All our subtitles, in no particular order */
179 std::vector<std::shared_ptr<Subtitle>> _subtitles;
184 Font (std::string load_id_, std::string uuid_, boost::filesystem::path file_)
191 Font (std::string load_id_, std::string uuid_, ArrayData data_)
200 /** .ttf file that this data was last written to, if applicable */
201 mutable boost::optional<boost::filesystem::path> file;
204 /** TTF font data that we need */
205 std::vector<Font> _fonts;
207 /** The raw XML data that we read from or wrote to our asset; useful for validation */
208 mutable boost::optional<std::string> _raw_xml;
211 friend struct ::pull_fonts_test1;
212 friend struct ::pull_fonts_test2;
213 friend struct ::pull_fonts_test3;
215 void maybe_add_subtitle (std::string text, std::vector<ParseState> const & parse_state, float space_before, Standard standard);
217 static void pull_fonts (std::shared_ptr<order::Part> part);