/*
- Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 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/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 "data.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 FontNode;
class TextNode;
class SubtitleNode;
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 SubtitleString objects which it can extract
+ * This class holds a list of Subtitle objects which it can extract
* from the appropriate part of either an Interop or SMPTE XML file.
* Its subclasses InteropSubtitleAsset and SMPTESubtitleAsset handle the
* differences between the two types.
{
public:
SubtitleAsset ();
- SubtitleAsset (boost::filesystem::path file);
+ explicit SubtitleAsset (boost::filesystem::path file);
bool equals (
- boost::shared_ptr<const Asset>,
- EqualityOptions,
+ std::shared_ptr<const Asset>,
+ EqualityOptions const&,
NoteHandler note
- ) const;
+ ) const override;
- std::list<SubtitleString> subtitles_during (Time from, Time to) const;
- std::list<SubtitleString> const & subtitles () const {
- return _subtitles;
- }
+ 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;
+ std::vector<std::shared_ptr<const Subtitle>> subtitles () const;
- void add (SubtitleString);
- virtual void add_font (std::string id, boost::filesystem::path file) = 0;
- std::map<std::string, Data> fonts () 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 void write (boost::filesystem::path) const = 0;
- virtual Glib::ustring xml_as_string () const = 0;
+ virtual std::string xml_as_string () const = 0;
Time latest_subtitle_out () const;
- virtual std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const = 0;
+ void fix_empty_font_ids ();
+
+ virtual std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const = 0;
+
+ virtual int time_code_rate () const = 0;
+
+ /** @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;
- void parse_subtitles (boost::shared_ptr<cxml::Document> xml, std::list<boost::shared_ptr<FontNode> > font_nodes);
- void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, std::string xmlns) const;
- void add_font_data (std::string id, boost::filesystem::path file);
+ struct ParseState {
+ boost::optional<std::string> font_id;
+ boost::optional<int64_t> size;
+ boost::optional<float> aspect_adjust;
+ boost::optional<bool> italic;
+ boost::optional<bool> bold;
+ boost::optional<bool> underline;
+ boost::optional<Colour> colour;
+ boost::optional<Effect> effect;
+ boost::optional<Colour> effect_colour;
+ boost::optional<float> h_position;
+ 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;
+ boost::optional<Time> fade_up_time;
+ boost::optional<Time> fade_down_time;
+ enum class Type {
+ TEXT,
+ 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);
+ ParseState font_node_state (xmlpp::Element const * node, Standard standard) const;
+ ParseState text_node_state (xmlpp::Element const * node) const;
+ ParseState image_node_state (xmlpp::Element const * node) const;
+ ParseState subtitle_node_state (xmlpp::Element const * node, boost::optional<int> tcr) const;
+ Time fade_time (xmlpp::Element const * node, std::string name, boost::optional<int> tcr) const;
+ void position_align (ParseState& ps, xmlpp::Element const * node) const;
+
+ void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const;
/** All our subtitles, in no particular order */
- std::list<SubtitleString> _subtitles;
+ std::vector<std::shared_ptr<Subtitle>> _subtitles;
- class FileData : public Data {
+ class Font
+ {
public:
- FileData () {}
+ Font (std::string load_id_, std::string uuid_, boost::filesystem::path file_)
+ : load_id (load_id_)
+ , uuid (uuid_)
+ , data (file_)
+ , file (file_)
+ {}
- FileData (boost::shared_array<uint8_t> data_, boost::uintmax_t size_)
- : Data (data_, size_)
+ Font (std::string load_id_, std::string uuid_, ArrayData data_)
+ : load_id (load_id_)
+ , uuid (uuid_)
+ , data (data_)
{}
- /** .ttf file that this data was last written to */
+ std::string load_id;
+ std::string uuid;
+ ArrayData data;
+ /** .ttf file that this data was last written to, if applicable */
mutable boost::optional<boost::filesystem::path> file;
};
- /** Font data, keyed by a subclass-dependent identifier.
- * For Interop, the string is the font ID from the subtitle file.
- * For SMPTE, the string is the font's URN from the subtitle file.
- */
- std::map<std::string, FileData> _fonts;
+ /** TTF font data that we need */
+ std::vector<Font> _fonts;
-private:
- /** @struct ParseState
- * @brief A struct to hold state when parsing a subtitle XML file.
- */
- struct ParseState {
- std::list<boost::shared_ptr<FontNode> > font_nodes;
- std::list<boost::shared_ptr<TextNode> > text_nodes;
- std::list<boost::shared_ptr<SubtitleNode> > subtitle_nodes;
- };
+ /** The raw XML data that we read from or wrote to our asset; useful for validation */
+ mutable boost::optional<std::string> _raw_xml;
- void maybe_add_subtitle (std::string text, ParseState const & parse_state);
+private:
+ friend struct ::pull_fonts_test1;
+ friend struct ::pull_fonts_test2;
+ friend struct ::pull_fonts_test3;
- void examine_font_nodes (
- boost::shared_ptr<const cxml::Node> xml,
- std::list<boost::shared_ptr<FontNode> > const & font_nodes,
- ParseState& parse_state
- );
+ void maybe_add_subtitle (std::string text, std::vector<ParseState> const & parse_state, float space_before, Standard standard);
- void examine_text_nodes (
- boost::shared_ptr<const cxml::Node> xml,
- std::list<boost::shared_ptr<TextNode> > const & text_nodes,
- ParseState& parse_state
- );
+ static void pull_fonts (std::shared_ptr<order::Part> part);
};
+
}
+
#endif
projects / libdcp.git / blobdiff