2 Copyright (C) 2012-2015 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 #ifndef LIBDCP_SUBTITLE_ASSET_H
35 #define LIBDCP_SUBTITLE_ASSET_H
39 #include "subtitle_string.h"
41 #include <libcxml/cxml.h>
42 #include <boost/shared_array.hpp>
49 struct interop_dcp_font_test;
50 struct smpte_dcp_font_test;
51 struct pull_fonts_test1;
52 struct pull_fonts_test2;
53 struct pull_fonts_test3;
70 /** @class SubtitleAsset
71 * @brief A parent for classes representing a file containing subtitles.
73 * This class holds a list of Subtitle objects which it can extract
74 * from the appropriate part of either an Interop or SMPTE XML file.
75 * Its subclasses InteropSubtitleAsset and SMPTESubtitleAsset handle the
76 * differences between the two types.
78 class SubtitleAsset : public Asset
82 explicit SubtitleAsset (boost::filesystem::path file);
85 boost::shared_ptr<const Asset>,
90 std::list<boost::shared_ptr<Subtitle> > subtitles_during (Time from, Time to, bool starting) const;
91 std::list<boost::shared_ptr<Subtitle> > const & subtitles () const {
95 virtual void add (boost::shared_ptr<Subtitle>);
96 virtual void add_font (std::string id, boost::filesystem::path file) = 0;
97 std::map<std::string, Data> fonts_with_load_ids () const;
99 virtual void write (boost::filesystem::path) const = 0;
100 virtual std::string xml_as_string () const = 0;
102 Time latest_subtitle_out () const;
104 void fix_empty_font_ids ();
106 virtual std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const = 0;
109 friend struct ::interop_dcp_font_test;
110 friend struct ::smpte_dcp_font_test;
113 boost::optional<std::string> font_id;
114 boost::optional<int64_t> size;
115 boost::optional<float> aspect_adjust;
116 boost::optional<bool> italic;
117 boost::optional<bool> bold;
118 boost::optional<bool> underline;
119 boost::optional<Colour> colour;
120 boost::optional<Effect> effect;
121 boost::optional<Colour> effect_colour;
122 boost::optional<float> h_position;
123 boost::optional<HAlign> h_align;
124 boost::optional<float> v_position;
125 boost::optional<VAlign> v_align;
126 boost::optional<Direction> direction;
127 boost::optional<Time> in;
128 boost::optional<Time> out;
129 boost::optional<Time> fade_up_time;
130 boost::optional<Time> fade_down_time;
135 boost::optional<Type> type;
138 void parse_subtitles (xmlpp::Element const * node, std::list<ParseState>& state, boost::optional<int> tcr, Standard standard);
139 ParseState font_node_state (xmlpp::Element const * node, Standard standard) const;
140 ParseState text_node_state (xmlpp::Element const * node) const;
141 ParseState image_node_state (xmlpp::Element const * node) const;
142 ParseState subtitle_node_state (xmlpp::Element const * node, boost::optional<int> tcr) const;
143 Time fade_time (xmlpp::Element const * node, std::string name, boost::optional<int> tcr) const;
144 void position_align (ParseState& ps, xmlpp::Element const * node) const;
146 void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const;
148 /** All our subtitles, in no particular order */
149 std::list<boost::shared_ptr<Subtitle> > _subtitles;
154 Font (std::string load_id_, std::string uuid_, boost::filesystem::path file_)
161 Font (std::string load_id_, std::string uuid_, Data data_)
170 /** .ttf file that this data was last written to, if applicable */
171 mutable boost::optional<boost::filesystem::path> file;
174 /** TTF font data that we need */
175 std::list<Font> _fonts;
178 friend struct ::pull_fonts_test1;
179 friend struct ::pull_fonts_test2;
180 friend struct ::pull_fonts_test3;
182 void maybe_add_subtitle (std::string text, std::list<ParseState> const & parse_state, Standard standard);
184 static void pull_fonts (boost::shared_ptr<order::Part> part);