X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fsubtitle_asset.h;h=d3f186ef965b72ad74f5fb12c2b729653360a125;hb=bec7cbcc015814452690a0f702cc41b6f5f56311;hp=2da1ce7b8f9b7ae6f0c3090428a4b6351bdd027d;hpb=59617eb2230e47b59882c4f9ca6092ce05f53cf1;p=libdcp.git

diff --git a/src/subtitle_asset.h b/src/subtitle_asset.h
index 2da1ce7b..d3f186ef 100644
--- a/src/subtitle_asset.h
+++ b/src/subtitle_asset.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,165 +17,140 @@
 
 */
 
+#ifndef LIBDCP_SUBTITLE_ASSET_H
+#define LIBDCP_SUBTITLE_ASSET_H
+
 #include "asset.h"
-#include "xml.h"
 #include "dcp_time.h"
-#include "parse/subtitle.h"
+#include "subtitle_string.h"
+#include "data.h"
+#include <libcxml/cxml.h>
+#include <boost/shared_array.hpp>
+#include <map>
+
+namespace xmlpp {
+	class Element;
+}
+
+struct interop_dcp_font_test;
+struct smpte_dcp_font_test;
 
-namespace libdcp
+namespace dcp
 {
 
-class Subtitle
+class SubtitleString;
+class FontNode;
+class TextNode;
+class SubtitleNode;
+class LoadFontNode;
+
+/** @class SubtitleAsset
+ *  @brief A parent for classes representing a file containing subtitles.
+ *
+ *  This class holds a list of SubtitleString 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;
-	}
-
-	Color color () const {
-		return _color;
-	}
-
-	Time in () const {
-		return _in;
-	}
-
-	Time out () const {
-		return _out;
-	}
-
-	std::string text () const {
-		return _text;
-	}
-
-	float v_position () const {
-		return _v_position;
-	}
-
-	VAlign v_align () const {
-		return _v_align;
-	}
+	SubtitleAsset ();
+	SubtitleAsset (boost::filesystem::path file);
 
-	Effect effect () const {
-		return _effect;
-	}
-
-	Color effect_color () const {
-		return _effect_color;
-	}
+	bool equals (
+		boost::shared_ptr<const Asset>,
+		EqualityOptions,
+		NoteHandler note
+		) const;
 
-	Time fade_up_time () const {
-		return _fade_up_time;
-	}
-
-	Time fade_down_time () const {
-		return _fade_down_time;
+	std::list<SubtitleString> subtitles_during (Time from, Time to, bool starting) const;
+	std::list<SubtitleString> const & subtitles () const {
+		return _subtitles;
 	}
 
-	int size () const {
-		return _size;
-	}
-	
-	int size_in_pixels (int screen_height) const;
+	virtual void add (SubtitleString);
+	virtual void add_font (std::string id, boost::filesystem::path file) = 0;
+	std::map<std::string, Data> fonts_with_load_ids () const;
 
-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;
-};
+	virtual void write (boost::filesystem::path) const = 0;
+	virtual std::string xml_as_string () const = 0;
 
-bool operator== (Subtitle const & a, Subtitle const & b);
-std::ostream& operator<< (std::ostream& s, Subtitle const & sub);
+	Time latest_subtitle_out () const;
 
-class SubtitleAsset : public Asset
-{
-public:
-	SubtitleAsset (std::string directory, std::string xml_file);
-	SubtitleAsset (std::string directory, std::string movie_title, std::string language);
-
-	void write_to_cpl (xmlpp::Node *) const;
-	virtual bool equals (boost::shared_ptr<const Asset>, EqualityOptions, boost::function<void (NoteType, std::string)> note) const {
-		/* XXX */
-		note (ERROR, "subtitle assets not compared yet");
-		return true;
-	}
+	virtual std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const = 0;
 
-	std::string language () const {
-		return _language;
-	}
+protected:
+	friend struct ::interop_dcp_font_test;
+	friend struct ::smpte_dcp_font_test;
 
-	std::list<boost::shared_ptr<Subtitle> > subtitles_at (Time t) const;
-	std::list<boost::shared_ptr<Subtitle> > const & subtitles () const {
-		return _subtitles;
-	}
+	void parse_subtitles (
+		boost::shared_ptr<cxml::Document> xml,
+		std::list<boost::shared_ptr<FontNode> > font_nodes,
+		std::list<boost::shared_ptr<SubtitleNode> > subtitle_nodes
+		);
 
-	void add (boost::shared_ptr<Subtitle>);
+	void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const;
+
+	/** All our subtitles, in no particular order */
+	std::list<SubtitleString> _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_, Data data_)
+			: load_id (load_id_)
+			, uuid (uuid_)
+			, data (data_)
+		{}
+
+		std::string load_id;
+		std::string uuid;
+		Data data;
+		/** .ttf file that this data was last written to, if applicable */
+		mutable boost::optional<boost::filesystem::path> file;
+	};
 
-	void read_xml (std::string);
-	void write_xml () const;
-	void write_xml (std::ostream &) const;
+	std::list<Font> _fonts;
 
 private:
-	std::string font_id_to_name (std::string id) const;
-
+	/** @struct ParseState
+	 *  @brief  A struct to hold state when parsing a subtitle XML file.
+	 */
 	struct ParseState {
-		std::list<boost::shared_ptr<parse::Font> > font_nodes;
-		std::list<boost::shared_ptr<parse::Text> > text_nodes;
-		std::list<boost::shared_ptr<parse::Subtitle> > subtitle_nodes;
+		std::list<boost::shared_ptr<FontNode> > font_nodes;
+		std::list<boost::shared_ptr<TextNode> > text_nodes;
+		std::list<boost::shared_ptr<SubtitleNode> > subtitle_nodes;
 	};
 
 	void maybe_add_subtitle (std::string text, ParseState const & parse_state);
-	
-	void examine_font_nodes (
+
+	void examine_nodes (
 		boost::shared_ptr<const cxml::Node> xml,
-		std::list<boost::shared_ptr<parse::Font> > const & font_nodes,
+		std::list<boost::shared_ptr<FontNode> > const & font_nodes,
 		ParseState& parse_state
 		);
-	
-	void examine_text_nodes (
+
+	void examine_nodes (
 		boost::shared_ptr<const cxml::Node> xml,
-		std::list<boost::shared_ptr<parse::Text> > const & text_nodes,
+		std::list<boost::shared_ptr<TextNode> > const & text_nodes,
 		ParseState& parse_state
 		);
 
-	std::string _movie_title;
-	/* strangely, this is sometimes a string */
-	std::string _reel_number;
-	std::string _language;
-	std::list<boost::shared_ptr<parse::LoadFont> > _load_font_nodes;
-
-	std::list<boost::shared_ptr<Subtitle> > _subtitles;
-	bool _need_sort;
+	void examine_nodes (
+		boost::shared_ptr<const cxml::Node> xml,
+		std::list<boost::shared_ptr<SubtitleNode> > const & subtitle_nodes,
+		ParseState& parse_state
+		);
 };
 
 }
+
+#endif