X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fsmpte_subtitle_asset.h;h=26144fe101be003e4e2c556e5a892afce0446ed9;hb=dfc34502469e9c975bf78011b0efc365c11e9779;hp=12eb58dba414a3cfa8ea4f44f210416e9a430942;hpb=f3402802c7f17e883dda8da562e8fe09c6f5c5af;p=libdcp.git

diff --git a/src/smpte_subtitle_asset.h b/src/smpte_subtitle_asset.h
index 12eb58db..26144fe1 100644
--- a/src/smpte_subtitle_asset.h
+++ b/src/smpte_subtitle_asset.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -31,55 +31,73 @@
     files in the program, then also delete it here.
 */
 
+
+#ifndef LIBDCP_SMPTE_SUBTITLE_ASSET_H
+#define LIBDCP_SMPTE_SUBTITLE_ASSET_H
+
+
 /** @file  src/smpte_subtitle_asset.h
- *  @brief SMPTESubtitleAsset class.
+ *  @brief SMPTESubtitleAsset class
  */
 
-#include "subtitle_asset.h"
+
+#include "crypto_context.h"
 #include "language_tag.h"
 #include "local_time.h"
 #include "mxf.h"
-#include "crypto_context.h"
+#include "subtitle_asset.h"
+#include "subtitle_standard.h"
 #include <boost/filesystem.hpp>
 
+
 namespace ASDCP {
 	namespace TimedText {
 		class MXFReader;
 	}
 }
 
+
 struct verify_invalid_language1;
 struct verify_invalid_language2;
+struct write_subtitles_in_vertical_order_with_top_alignment;
+struct write_subtitles_in_vertical_order_with_bottom_alignment;
+
 
 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 ();
+	explicit SMPTESubtitleAsset(SubtitleStandard standard = SubtitleStandard::SMPTE_2014);
 
-	/** @param file File name
+	/** Construct a SMPTESubtitleAsset by reading an MXF or XML file
+	 *  @param file Filename
 	 */
 	explicit SMPTESubtitleAsset (boost::filesystem::path file);
 
 	bool equals (
 		std::shared_ptr<const Asset>,
-		EqualityOptions,
+		EqualityOptions const&,
 		NoteHandler note
-		) const;
+		) const override;
+
+	std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const override;
 
-	std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const;
+	std::string xml_as_string () const override;
 
-	std::string xml_as_string () const;
-	void write (boost::filesystem::path path) const;
-	void add (std::shared_ptr<Subtitle>);
-	void add_font (std::string id, dcp::ArrayData data);
-	void set_key (Key key);
+	/** Write this content to a MXF file */
+	void write (boost::filesystem::path path) const override;
+
+	void add (std::shared_ptr<Subtitle>) override;
+	void add_font (std::string id, dcp::ArrayData data) override;
+	void set_key (Key key) override;
 
 	void set_content_title_text (std::string t) {
 		_content_title_text = t;
@@ -113,8 +131,12 @@ public:
 		_intrinsic_duration = d;
 	}
 
+	int64_t intrinsic_duration () const {
+		return _intrinsic_duration;
+	}
+
 	/** @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;
@@ -132,7 +154,7 @@ public:
 		return _annotation_text;
 	}
 
-	/** @return file creation time and date */
+	/** @return file issue time and date */
 	LocalTime issue_date () const {
 		return _issue_date;
 	}
@@ -149,7 +171,7 @@ public:
 	 *  e.g. a time_code_rate of 250 means that a subtitle time of 0:0:0:001
 	 *  represents 4ms.
 	 */
-	int time_code_rate () const {
+	int time_code_rate () const override {
 		return _time_code_rate;
 	}
 
@@ -157,10 +179,22 @@ public:
 		return _start_time;
 	}
 
-	std::string xml_id () const {
+	/** @return ID from XML's <Id> tag, or the <Id> that will be used when writing the XML,
+	 *  or boost::none if this content is encrypted and no key is available.
+	 */
+	boost::optional<std::string> xml_id () const {
 		return _xml_id;
 	}
 
+	/** @return ResourceID read from any MXF that was read */
+	boost::optional<std::string> resource_id () const {
+		return _resource_id;
+	}
+
+	SubtitleStandard subtitle_standard() const override {
+		return _subtitle_standard;
+	}
+
 	static bool valid_mxf (boost::filesystem::path);
 	static std::string static_pkl_type (Standard) {
 		return "application/mxf";
@@ -168,7 +202,7 @@ public:
 
 protected:
 
-	std::string pkl_type (Standard s) const {
+	std::string pkl_type (Standard s) const override {
 		return static_pkl_type (s);
 	}
 
@@ -177,15 +211,19 @@ private:
 	friend struct ::write_smpte_subtitle_test2;
 	friend struct ::verify_invalid_language1;
 	friend struct ::verify_invalid_language2;
+	friend struct ::write_subtitles_in_vertical_order_with_top_alignment;
+	friend struct ::write_subtitles_in_vertical_order_with_bottom_alignment;
 
 	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);
+	void read_mxf_descriptor (std::shared_ptr<ASDCP::TimedText::MXFReader> reader);
+	void read_mxf_resources (std::shared_ptr<ASDCP::TimedText::MXFReader> reader, std::shared_ptr<DecryptionContext> dec);
+	std::string schema_namespace() const;
 
 	/** 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,
@@ -196,14 +234,28 @@ private:
 	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;
+	/** There are two SMPTE standards describing subtitles, 428-7:2010 and 428-7:2014, and they
+	 *  have different interpretations of what Vposition means.  Though libdcp does not need to
+	 *  know the difference, this variable stores the standard from the namespace that this asset was
+	 *  written with (or will be written with).
+	 */
+	SubtitleStandard _subtitle_standard;
 
 	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.
+	/** UUID for the XML inside the MXF, which should be the same as the ResourceID in the MXF (our _resource_id)
+	 *  but different to the AssetUUID in the MXF (our _id) according to SMPTE Bv2.1 and Doremi's 2.8.18 release notes.
+	 *  May be boost::none if this object has been made from an encrypted object without a key.
 	 */
-	std::string _xml_id;
+	boost::optional<std::string> _xml_id;
+
+	/** ResourceID read from the MXF, if there was one */
+	boost::optional<std::string> _resource_id;
 };
 
+
 }
+
+
+#endif