{,Interop,SMPTE}SubtitleAsset -> {,Interop,SMPTE}TextAsset.

1 files changed, 163 insertions, 0 deletions

diff --git a/src/interop_text_asset.h b/src/interop_text_asset.h
new file mode 100644
index 00000000..363b1f27
--- /dev/null
+++ b/src/interop_text_asset.h
@@ -0,0 +1,163 @@
+/*
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
+
+    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.
+
+    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 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/interop_text_asset.h
+ *  @brief InteropTextAsset class
+ */
+
+
+#ifndef LIBDCP_INTEROP_TEXT_ASSET_H
+#define LIBDCP_INTEROP_TEXT_ASSET_H
+
+
+#include "text_asset.h"
+#include "subtitle_standard.h"
+#include <boost/filesystem.hpp>
+
+
+namespace dcp {
+
+
+class InteropLoadFontNode;
+
+
+/** @class InteropTextAsset
+ *  @brief A set of subtitles to be read and/or written in the Inter-Op format
+ *
+ *  Inter-Op subtitles are sometimes known as CineCanvas.
+ */
+class InteropTextAsset : public TextAsset
+{
+public:
+	InteropTextAsset();
+	explicit InteropTextAsset(boost::filesystem::path file);
+
+	bool equals (
+		std::shared_ptr<const Asset>,
+		EqualityOptions const&,
+		NoteHandler note
+		) const override;
+
+	void add_to_assetmap (AssetMap& asset_map, boost::filesystem::path root) const override;
+	void add_to_pkl (std::shared_ptr<PKL> pkl, boost::filesystem::path root) const override;
+
+	std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const override;
+
+	void add_font (std::string load_id, dcp::ArrayData data) override;
+
+	std::string xml_as_string () const override;
+
+	/** Write this content to an XML file with its fonts alongside */
+	void write (boost::filesystem::path path) const override;
+
+	void resolve_fonts (std::vector<std::shared_ptr<Asset>> assets);
+	void set_font_file (std::string load_id, boost::filesystem::path file);
+	std::vector<std::shared_ptr<Asset>> font_assets();
+	std::vector<std::shared_ptr<const Asset>> font_assets() const;
+
+	/** @return the <LoadFont> IDs of fonts for which we have not (yet) found a font asset.
+	 *  This could be because resolve_fonts() has not yet been called, or because there is
+	 *  a missing font file.
+	 */
+	std::vector<std::string> unresolved_fonts() const;
+
+	/** Set the reel number or sub-element identifier
+	 *  of these subtitles.
+	 *  @param n New reel number.
+	 */
+	void set_reel_number (std::string n) {
+		_reel_number = n;
+	}
+
+	/** Set the language tag of these subtitles.
+	 *  @param l New language.
+	 */
+	void set_language (std::string l) {
+		_language = l;
+	}
+
+	/** @return title of the movie that the subtitles are for */
+	void set_movie_title (std::string m) {
+		_movie_title = m;
+	}
+
+	/** @return reel number or sub-element of a programme that
+	 *  these subtitles refer to.
+	 */
+	std::string reel_number () const {
+		return _reel_number;
+	}
+
+	/** @return language used in the subtitles */
+	std::string language () const {
+		return _language;
+	}
+
+	/** @return movie title that these subtitles are for */
+	std::string movie_title () const {
+		return _movie_title;
+	}
+
+	int time_code_rate () const override {
+		/* Interop can use either; just pick one */
+		return 1000;
+	}
+
+	SubtitleStandard subtitle_standard() const override {
+		return SubtitleStandard::INTEROP;
+	}
+
+	static std::string static_pkl_type (Standard) {
+		return "text/xml;asdcpKind=Subtitle";
+	}
+
+protected:
+
+	std::string pkl_type (Standard s) const override {
+		return static_pkl_type (s);
+	}
+
+private:
+	std::string _reel_number;
+	std::string _language;
+	std::string _movie_title;
+	std::vector<std::shared_ptr<InteropLoadFontNode>> _load_font_nodes;
+};
+
+
+}
+
+
+#endif
+