X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fsubtitle_asset.h;h=bc5fa8824711cf8d600c6c3763631196916d6e86;hb=refs%2Ftags%2Fv1.8.69;hp=607b054d91a3ed6ea054d611211022824df7cdb5;hpb=9b84debc374f426bb3a00baa82bae5fdd88a018e;p=libdcp.git

diff --git a/src/subtitle_asset.h b/src/subtitle_asset.h
index 607b054d..bc5fa882 100644
--- a/src/subtitle_asset.h
+++ b/src/subtitle_asset.h
@@ -1,198 +1,229 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
+
+/** @file  src/subtitle_asset.h
+ *  @brief SubtitleAsset class
+ */
+
+
+#ifndef LIBDCP_SUBTITLE_ASSET_H
+#define LIBDCP_SUBTITLE_ASSET_H
+
+
+#include "array_data.h"
 #include "asset.h"
-#include "xml.h"
 #include "dcp_time.h"
+#include "subtitle_standard.h"
+#include "subtitle_string.h"
+#include <libcxml/cxml.h>
+#include <boost/shared_array.hpp>
+#include <map>
+#include <string>
+#include <utility>
+#include <vector>
+
+
+namespace xmlpp {
+	class Document;
+	class Element;
+}
 
-namespace libdcp
-{
 
-class TextNode : public XMLNode
-{
-public:
-	TextNode () {}
-	TextNode (xmlpp::Node const * node);
+struct interop_dcp_font_test;
+struct smpte_dcp_font_test;
+struct pull_fonts_test1;
+struct pull_fonts_test2;
+struct pull_fonts_test3;
 
-	float v_position;
-	VAlign v_align;
-	std::string text;
-	Time fade_up_time;
-	Time fade_down_time;
 
-private:
-	Time fade_time (std::string name);
-	
-};
+namespace dcp {
 
-class SubtitleNode : public XMLNode
-{
-public:
-	SubtitleNode () {}
-	SubtitleNode (xmlpp::Node const * node);
 
-	Time in;
-	Time out;
-	std::list<boost::shared_ptr<TextNode> > text_nodes;
-};
+class SubtitleString;
+class SubtitleImage;
+class FontNode;
+class TextNode;
+class SubtitleNode;
+class LoadFontNode;
+class ReelAsset;
 
-class FontNode : public XMLNode
-{
-public:
-	FontNode () {}
-	FontNode (xmlpp::Node const * node);
-	FontNode (std::list<boost::shared_ptr<FontNode> > const & font_nodes);
-
-	std::string id;
-	int size;
-	boost::optional<bool> italic;
-	boost::optional<Color> color;
-	boost::optional<Effect> effect;
-	boost::optional<Color> effect_color;
-	
-	std::list<boost::shared_ptr<SubtitleNode> > subtitle_nodes;
-	std::list<boost::shared_ptr<FontNode> > font_nodes;
-};
 
-class LoadFontNode : public XMLNode
-{
-public:
-	LoadFontNode () {}
-	LoadFontNode (xmlpp::Node const * node);
+namespace order {
+	class Part;
+	struct Context;
+}
 
-	std::string id;
-	std::string uri;
-};
 
-class Subtitle
+/** @class SubtitleAsset
+ *  @brief A parent for classes representing a file containing subtitles
+ *
+ *  This class holds a list of Subtitle objects which it can extract
+ *  from the appropriate part of either an Interop or SMPTE XML file.
+ *  Its subclasses InteropSubtitleAsset and SMPTESubtitleAsset handle the
+ *  differences between the two types.
+ */
+class SubtitleAsset : public Asset
 {
 public:
-	Subtitle (
-		std::string font,
-		bool italic,
-		Color color,
-		int size,
-		Time in,
-		Time out,
-		float v_position,
-		VAlign v_align,
-		std::string text,
-		Effect effect,
-		Color effect_color,
-		Time fade_up_time,
-		Time fade_down_time
-		);
-
-	std::string font () const {
-		return _font;
-	}
-
-	bool italic () const {
-		return _italic;
-	}
+	SubtitleAsset ();
+	explicit SubtitleAsset (boost::filesystem::path file);
 
-	Color color () const {
-		return _color;
-	}
+	bool equals (
+		std::shared_ptr<const Asset>,
+		EqualityOptions,
+		NoteHandler note
+		) const override;
 
-	Time in () const {
-		return _in;
-	}
+	std::vector<std::shared_ptr<const Subtitle>> subtitles_during (Time from, Time to, bool starting) const;
+	std::vector<std::shared_ptr<const Subtitle>> subtitles_in_reel(std::shared_ptr<const dcp::ReelAsset> asset) const;
+	std::vector<std::shared_ptr<const Subtitle>> subtitles () const;
 
-	Time out () const {
-		return _out;
-	}
+	virtual void add (std::shared_ptr<Subtitle>);
+	virtual void add_font (std::string id, dcp::ArrayData data) = 0;
+	void ensure_font(std::string id, dcp::ArrayData data);
+	std::map<std::string, ArrayData> font_data () const;
+	std::map<std::string, boost::filesystem::path> font_filenames () const;
 
-	std::string text () const {
-		return _text;
-	}
+	virtual void write (boost::filesystem::path) const = 0;
+	virtual std::string xml_as_string () const = 0;
 
-	float v_position () const {
-		return _v_position;
-	}
+	Time latest_subtitle_out () const;
 
-	VAlign v_align () const {
-		return _v_align;
-	}
+	void fix_empty_font_ids ();
 
-	Effect effect () const {
-		return _effect;
-	}
+	virtual std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const = 0;
 
-	Color effect_color () const {
-		return _effect_color;
-	}
+	virtual int time_code_rate () const = 0;
 
-	Time fade_up_time () const {
-		return _fade_up_time;
+	/** @return Raw XML loaded from, or written to, an on-disk asset, or boost::none if
+	 *  - this object was not created from an existing on-disk asset and has not been written to one, or
+	 *  - this asset is encrypted and no key is available.
+	 */
+	virtual boost::optional<std::string> raw_xml () const {
+		return _raw_xml;
 	}
 
-	Time fade_down_time () const {
-		return _fade_down_time;
-	}
-
-	int size_in_pixels (int screen_height) const;
+	virtual SubtitleStandard subtitle_standard() const = 0;
+
+	static std::string format_xml(xmlpp::Document const& document, boost::optional<std::pair<std::string, std::string>> xml_namespace);
+
+protected:
+	friend struct ::interop_dcp_font_test;
+	friend struct ::smpte_dcp_font_test;
+
+	struct ParseState {
+		boost::optional<std::string> font_id;
+		boost::optional<int64_t> size;
+		boost::optional<float> aspect_adjust;
+		boost::optional<bool> italic;
+		boost::optional<bool> bold;
+		boost::optional<bool> underline;
+		boost::optional<Colour> colour;
+		boost::optional<Effect> effect;
+		boost::optional<Colour> effect_colour;
+		boost::optional<float> h_position;
+		boost::optional<HAlign> h_align;
+		boost::optional<float> v_position;
+		boost::optional<VAlign> v_align;
+		boost::optional<float> z_position;
+		boost::optional<Direction> direction;
+		boost::optional<Time> in;
+		boost::optional<Time> out;
+		boost::optional<Time> fade_up_time;
+		boost::optional<Time> fade_down_time;
+		enum class Type {
+			TEXT,
+			IMAGE
+		};
+		boost::optional<Type> type;
+		float space_before = 0;
+	};
+
+	void parse_subtitles (xmlpp::Element const * node, std::vector<ParseState>& state, boost::optional<int> tcr, Standard standard);
+	ParseState font_node_state (xmlpp::Element const * node, Standard standard) const;
+	ParseState text_node_state (xmlpp::Element const * node) const;
+	ParseState image_node_state (xmlpp::Element const * node) const;
+	ParseState subtitle_node_state (xmlpp::Element const * node, boost::optional<int> tcr) const;
+	Time fade_time (xmlpp::Element const * node, std::string name, boost::optional<int> tcr) const;
+	void position_align (ParseState& ps, xmlpp::Element const * node) const;
+
+	void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const;
+
+	/** All our subtitles, in no particular order */
+	std::vector<std::shared_ptr<Subtitle>> _subtitles;
+
+	class Font
+	{
+	public:
+		Font (std::string load_id_, std::string uuid_, boost::filesystem::path file_)
+			: load_id (load_id_)
+			, uuid (uuid_)
+			, data (file_)
+			, file (file_)
+		{}
+
+		Font (std::string load_id_, std::string uuid_, ArrayData data_)
+			: load_id (load_id_)
+			, uuid (uuid_)
+			, data (data_)
+		{}
+
+		std::string load_id;
+		std::string uuid;
+		ArrayData data;
+		/** .ttf file that this data was last written to, if applicable */
+		mutable boost::optional<boost::filesystem::path> file;
+	};
+
+	/** TTF font data that we need */
+	std::vector<Font> _fonts;
+
+	/** The raw XML data that we read from or wrote to our asset; useful for validation */
+	mutable boost::optional<std::string> _raw_xml;
 
 private:
-	std::string _font;
-	bool _italic;
-	Color _color;
-	int _size;
-	Time _in;
-	Time _out;
-	float _v_position;
-	VAlign _v_align;
-	std::string _text;
-	Effect _effect;
-	Color _effect_color;
-	Time _fade_up_time;
-	Time _fade_down_time;
-};
+	friend struct ::pull_fonts_test1;
+	friend struct ::pull_fonts_test2;
+	friend struct ::pull_fonts_test3;
 
-class SubtitleAsset : public Asset, public XMLFile
-{
-public:
-	SubtitleAsset (std::string directory, std::string xml);
+	void maybe_add_subtitle (std::string text, std::vector<ParseState> const & parse_state, float space_before, Standard standard);
 
-	void write_to_cpl (std::ostream&) const {}
-	virtual std::list<std::string> equals (boost::shared_ptr<const Asset>, EqualityOptions) const {
-		/* XXX */
-		return std::list<std::string> ();
-	}
+	static void pull_fonts (std::shared_ptr<order::Part> part);
+};
 
-	std::string language () const {
-		return _language;
-	}
 
-	std::list<boost::shared_ptr<Subtitle> > subtitles_at (Time t) const;
+}
 
-private:
-	std::string font_id_to_name (std::string id) const;
-	void examine_font_node (boost::shared_ptr<FontNode> font_node, std::list<boost::shared_ptr<FontNode> >& current_font_nodes);
-	
-	std::string _subtitle_id;
-	std::string _movie_title;
-	int64_t _reel_number;
-	std::string _language;
-	std::list<boost::shared_ptr<LoadFontNode> > _load_font_nodes;
-
-	std::list<boost::shared_ptr<Subtitle> > _subtitles;
-};
 
-}
+#endif