X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fsmpte_subtitle_asset.h;h=1521bf359e1aca95a7d9c2566594c14a8ba301bf;hb=4078aaae757db466d727c667dd9197b56d6b3f58;hp=1a609c611386c035b2a3b4de5b08f306f0d77911;hpb=d1f0b2b71a702b5624485cfeacaee5d58c4af5b2;p=libdcp.git

diff --git a/src/smpte_subtitle_asset.h b/src/smpte_subtitle_asset.h
index 1a609c61..1521bf35 100644
--- a/src/smpte_subtitle_asset.h
+++ b/src/smpte_subtitle_asset.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -15,58 +15,89 @@
 
     You should have received a copy of the GNU General Public License
     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/smpte_subtitle_asset.h
- *  @brief SMPTESubtitleAsset class.
+ *  @brief SMPTESubtitleAsset class
  */
 
+
 #include "subtitle_asset.h"
+#include "language_tag.h"
 #include "local_time.h"
 #include "mxf.h"
+#include "crypto_context.h"
 #include <boost/filesystem.hpp>
 
+
 namespace ASDCP {
 	namespace TimedText {
 		class MXFReader;
 	}
 }
 
+
+struct verify_invalid_language1;
+struct verify_invalid_language2;
+
+
 namespace dcp {
 
+
 class SMPTELoadFontNode;
 
+
 /** @class SMPTESubtitleAsset
- *  @brief A set of subtitles to be read and/or written in the SMPTE format.
+ *  @brief A set of subtitles to be read and/or written in the SMPTE format
  */
 class SMPTESubtitleAsset : public SubtitleAsset, public MXF
 {
 public:
 	SMPTESubtitleAsset ();
 
-	/** @param file File name
+	/** Construct a SMPTESubtitleAsset by reading an MXF or XML file
+	 *  @param file Filename
 	 */
-	SMPTESubtitleAsset (boost::filesystem::path file);
+	explicit SMPTESubtitleAsset (boost::filesystem::path file);
 
 	bool equals (
-		boost::shared_ptr<const Asset>,
+		std::shared_ptr<const Asset>,
 		EqualityOptions,
 		NoteHandler note
 		) const;
 
-	std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
+	std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const;
 
 	std::string xml_as_string () const;
+
+	/** Write this content to a MXF file */
 	void write (boost::filesystem::path path) const;
-	void add (SubtitleString);
-	void add_font (std::string id, boost::filesystem::path file);
+
+	void add (std::shared_ptr<Subtitle>);
+	void add_font (std::string id, dcp::ArrayData data);
+	void set_key (Key key);
 
 	void set_content_title_text (std::string t) {
 		_content_title_text = t;
 	}
 
-	void set_language (std::string l) {
-		_language = l;
+	void set_language (dcp::LanguageTag l) {
+		_language = l.to_string();
 	}
 
 	void set_issue_date (LocalTime t) {
@@ -94,13 +125,15 @@ public:
 	}
 
 	/** @return title of the film that these subtitles are for,
-	 *  to be presented to the user.
+	 *  to be presented to the user
 	 */
 	std::string content_title_text () const {
 		return _content_title_text;
 	}
 
-	/** @return language as a xs:language, if one was specified */
+	/** @return Language, if one was set.  This should be a xs:language, but
+	 *  it might not be if a non-compliant DCP was read in.
+	 */
 	boost::optional<std::string> language () const {
 		return _language;
 	}
@@ -110,7 +143,7 @@ public:
 		return _annotation_text;
 	}
 
-	/** @return file creation time and date */
+	/** @return file issue time and date */
 	LocalTime issue_date () const {
 		return _issue_date;
 	}
@@ -135,31 +168,54 @@ public:
 		return _start_time;
 	}
 
+	std::string xml_id () const {
+		return _xml_id;
+	}
+
 	static bool valid_mxf (boost::filesystem::path);
+	static std::string static_pkl_type (Standard) {
+		return "application/mxf";
+	}
 
 protected:
 
-	std::string pkl_type (Standard) const {
-		return "application/mxf";
+	std::string pkl_type (Standard s) const {
+		return static_pkl_type (s);
 	}
 
 private:
-	void read_fonts (boost::shared_ptr<ASDCP::TimedText::MXFReader>);
+	friend struct ::write_smpte_subtitle_test;
+	friend struct ::write_smpte_subtitle_test2;
+	friend struct ::verify_invalid_language1;
+	friend struct ::verify_invalid_language2;
+
+	void read_fonts (std::shared_ptr<ASDCP::TimedText::MXFReader>);
+	void parse_xml (std::shared_ptr<cxml::Document> xml);
+	void read_mxf_descriptor (std::shared_ptr<ASDCP::TimedText::MXFReader> reader, std::shared_ptr<DecryptionContext> dec);
 
 	/** The total length of this content in video frames.  The amount of
 	 *  content presented may be less than this.
 	 */
-	int64_t _intrinsic_duration;
+	int64_t _intrinsic_duration = 0;
+	/** <ContentTitleText> from the asset */
 	std::string _content_title_text;
+	/** This is stored and returned as a string so that we can tolerate non-RFC-5646 strings,
+	 *  but must be set as a dcp::LanguageTag to try to ensure that we create compliant output.
+	 */
 	boost::optional<std::string> _language;
 	boost::optional<std::string> _annotation_text;
 	LocalTime _issue_date;
 	boost::optional<int> _reel_number;
 	Fraction _edit_rate;
-	int _time_code_rate;
+	int _time_code_rate = 0;
 	boost::optional<Time> _start_time;
 
-	std::list<boost::shared_ptr<SMPTELoadFontNode> > _load_font_nodes;
+	std::vector<std::shared_ptr<SMPTELoadFontNode>> _load_font_nodes;
+	/** UUID for the XML inside the MXF, which should be different to the ID of the MXF according to
+	 *  Doremi's 2.8.18 release notes.
+	 */
+	std::string _xml_id;
 };
 
+
 }