X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fsubtitle_asset.h;h=bc5fa8824711cf8d600c6c3763631196916d6e86;hb=refs%2Ftags%2Fv1.8.69;hp=c28f64462589683e07052722cccebfbda07de3e8;hpb=8771c1f7b00ab0fb5c252adaa437d753155b7c18;p=libdcp.git diff --git a/src/subtitle_asset.h b/src/subtitle_asset.h index c28f6446..bc5fa882 100644 --- a/src/subtitle_asset.h +++ b/src/subtitle_asset.h @@ -1,52 +1,94 @@ /* - Copyright (C) 2012-2015 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington - 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 . + + 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 #include +#include +#include +#include +#include + 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 -{ -class SubtitleString; +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. @@ -55,84 +97,133 @@ class SubtitleAsset : public Asset { public: SubtitleAsset (); - SubtitleAsset (boost::filesystem::path file); + explicit SubtitleAsset (boost::filesystem::path file); bool equals ( - boost::shared_ptr, + std::shared_ptr, EqualityOptions, NoteHandler note - ) const; + ) const override; - std::list subtitles_during (Time from, Time to) const; - std::list const & subtitles () const { - return _subtitles; - } + std::vector> subtitles_during (Time from, Time to, bool starting) const; + std::vector> subtitles_in_reel(std::shared_ptr asset) const; + std::vector> subtitles () const; - void add (SubtitleString); - virtual void add_font (std::string id, boost::filesystem::path file) = 0; - std::map fonts () const; + virtual void add (std::shared_ptr); + virtual void add_font (std::string id, dcp::ArrayData data) = 0; + void ensure_font(std::string id, dcp::ArrayData data); + std::map font_data () const; + std::map 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 > load_font_nodes () const = 0; + void fix_empty_font_ids (); + + virtual std::vector> 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 raw_xml () const { + return _raw_xml; + } + + virtual SubtitleStandard subtitle_standard() const = 0; + + static std::string format_xml(xmlpp::Document const& document, boost::optional> xml_namespace); protected: friend struct ::interop_dcp_font_test; friend struct ::smpte_dcp_font_test; - - void parse_subtitles (boost::shared_ptr xml, std::list > 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 font_id; + boost::optional size; + boost::optional aspect_adjust; + boost::optional italic; + boost::optional bold; + boost::optional underline; + boost::optional colour; + boost::optional effect; + boost::optional effect_colour; + boost::optional h_position; + boost::optional h_align; + boost::optional v_position; + boost::optional v_align; + boost::optional z_position; + boost::optional direction; + boost::optional