/*
- Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
This file is part of libdcp.
files in the program, then also delete it here.
*/
+
+/** @file src/subtitle_asset.h
+ * @brief SubtitleAsset class
+ */
+
+
#ifndef LIBDCP_SUBTITLE_ASSET_H
#define LIBDCP_SUBTITLE_ASSET_H
#include "array_data.h"
#include "asset.h"
#include "dcp_time.h"
+#include "subtitle_standard.h"
#include "subtitle_string.h"
#include <libcxml/cxml.h>
#include <boost/shared_array.hpp>
#include <map>
+#include <string>
+#include <utility>
+#include <vector>
+
namespace xmlpp {
+ class Document;
class Element;
}
+
struct interop_dcp_font_test;
struct smpte_dcp_font_test;
struct pull_fonts_test1;
struct pull_fonts_test2;
struct pull_fonts_test3;
-namespace dcp
-{
+
+namespace dcp {
+
class SubtitleString;
class SubtitleImage;
class LoadFontNode;
class ReelAsset;
+
namespace order {
class Part;
struct Context;
}
+
/** @class SubtitleAsset
- * @brief A parent for classes representing a file containing subtitles.
+ * @brief A parent for classes representing a file containing subtitles
*
* This class holds a list of Subtitle objects which it can extract
* from the appropriate part of either an Interop or SMPTE XML file.
bool equals (
std::shared_ptr<const Asset>,
- EqualityOptions,
+ EqualityOptions const&,
NoteHandler note
- ) const;
+ ) const override;
std::vector<std::shared_ptr<const Subtitle>> subtitles_during (Time from, Time to, bool starting) const;
std::vector<std::shared_ptr<const Subtitle>> subtitles_in_reel(std::shared_ptr<const dcp::ReelAsset> asset) const;
virtual void add (std::shared_ptr<Subtitle>);
virtual void add_font (std::string id, dcp::ArrayData data) = 0;
+ void ensure_font(std::string id, dcp::ArrayData data);
std::map<std::string, ArrayData> font_data () const;
std::map<std::string, boost::filesystem::path> font_filenames () const;
virtual int time_code_rate () const = 0;
- std::string raw_xml () const {
+ /** @return Raw XML loaded from, or written to, an on-disk asset, or boost::none if
+ * - this object was not created from an existing on-disk asset and has not been written to one, or
+ * - this asset is encrypted and no key is available.
+ */
+ virtual boost::optional<std::string> raw_xml () const {
return _raw_xml;
}
+ virtual SubtitleStandard subtitle_standard() const = 0;
+
+ static std::string format_xml(xmlpp::Document const& document, boost::optional<std::pair<std::string, std::string>> xml_namespace);
+
protected:
friend struct ::interop_dcp_font_test;
friend struct ::smpte_dcp_font_test;
boost::optional<HAlign> h_align;
boost::optional<float> v_position;
boost::optional<VAlign> v_align;
+ boost::optional<float> z_position;
boost::optional<Direction> direction;
boost::optional<Time> in;
boost::optional<Time> out;
IMAGE
};
boost::optional<Type> type;
+ float space_before = 0;
};
void parse_subtitles (xmlpp::Element const * node, std::vector<ParseState>& state, boost::optional<int> tcr, Standard standard);
/** TTF font data that we need */
std::vector<Font> _fonts;
- /** The raw XML data that we read from our asset; useful for validation */
- std::string _raw_xml;
+ /** The raw XML data that we read from or wrote to our asset; useful for validation */
+ mutable boost::optional<std::string> _raw_xml;
private:
friend struct ::pull_fonts_test1;
friend struct ::pull_fonts_test2;
friend struct ::pull_fonts_test3;
- void maybe_add_subtitle (std::string text, std::vector<ParseState> const & parse_state, Standard standard);
+ void maybe_add_subtitle (std::string text, std::vector<ParseState> const & parse_state, float space_before, Standard standard);
static void pull_fonts (std::shared_ptr<order::Part> part);
};
+
}
+
#endif