X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fsmpte_subtitle_asset.h;h=79a0024bc74b115d102db1dbab42966cd0d56d1c;hb=201b6fdf572c04424d870ac4d07d1d1a8725b24c;hp=5f4d8833137251d2fc1ae299f4580772ac14821d;hpb=42a65cba0d8da23c12af52015e66cd9dc0b5a5fa;p=libdcp.git

diff --git a/src/smpte_subtitle_asset.h b/src/smpte_subtitle_asset.h
index 5f4d8833..79a0024b 100644
--- a/src/smpte_subtitle_asset.h
+++ b/src/smpte_subtitle_asset.h
@@ -1,74 +1,198 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2018 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/smpte_subtitle_asset.h
+ *  @brief SMPTESubtitleAsset class.
+ */
+
 #include "subtitle_asset.h"
 #include "local_time.h"
 #include "mxf.h"
+#include "crypto_context.h"
 #include <boost/filesystem.hpp>
 
+namespace ASDCP {
+	namespace TimedText {
+		class MXFReader;
+	}
+}
+
 namespace dcp {
 
 class SMPTELoadFontNode;
 
+/** @class SMPTESubtitleAsset
+ *  @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
-	 *  @param mxf true if `file' is a MXF, or false if it is an XML file.
 	 */
-	SMPTESubtitleAsset (boost::filesystem::path file, bool mxf = true);
+	explicit SMPTESubtitleAsset (boost::filesystem::path file);
 
 	bool equals (
 		boost::shared_ptr<const Asset>,
 		EqualityOptions,
 		NoteHandler note
 		) const;
-	
+
 	std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
 
-	Glib::ustring xml_as_string () const;
+	std::string xml_as_string () const;
 	void write (boost::filesystem::path path) const;
+	void add (boost::shared_ptr<Subtitle>);
+	void add_font (std::string id, boost::filesystem::path file);
+	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_issue_date (LocalTime t) {
+		_issue_date = t;
+	}
 
-	/** @return language, if one was specified */
+	void set_reel_number (int r) {
+		_reel_number = r;
+	}
+
+	void set_edit_rate (Fraction e) {
+		_edit_rate = e;
+	}
+
+	void set_time_code_rate (int t) {
+		_time_code_rate = t;
+	}
+
+	void set_start_time (Time t) {
+		_start_time = t;
+	}
+
+	void set_intrinsic_duration (int64_t d) {
+		_intrinsic_duration = d;
+	}
+
+	/** @return title of the film that these subtitles are for,
+	 *  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 */
 	boost::optional<std::string> language () const {
 		return _language;
 	}
-	
+
+	/** @return annotation text, to be presented to the user */
+	boost::optional<std::string> annotation_text () const {
+		return _annotation_text;
+	}
+
+	/** @return file creation time and date */
+	LocalTime issue_date () const {
+		return _issue_date;
+	}
+
+	boost::optional<int> reel_number () const {
+		return _reel_number;
+	}
+
+	Fraction edit_rate () const {
+		return _edit_rate;
+	}
+
+	/** @return subdivision of 1 second that is used for subtitle times;
+	 *  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 {
+		return _time_code_rate;
+	}
+
+	boost::optional<Time> start_time () const {
+		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:
+	friend struct ::write_smpte_subtitle_test;
+	friend struct ::write_smpte_subtitle_test2;
+
+	void read_fonts (boost::shared_ptr<ASDCP::TimedText::MXFReader>);
+	void parse_xml (boost::shared_ptr<cxml::Document> xml);
+	void read_mxf_descriptor (boost::shared_ptr<ASDCP::TimedText::MXFReader> reader, boost::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;
+	/** <ContentTitleText> from the asset */
 	std::string _content_title_text;
+	boost::optional<std::string> _language;
 	boost::optional<std::string> _annotation_text;
 	LocalTime _issue_date;
 	boost::optional<int> _reel_number;
-	boost::optional<std::string> _language;
 	Fraction _edit_rate;
 	int _time_code_rate;
 	boost::optional<Time> _start_time;
-	
+
 	std::list<boost::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;
 };
 
 }