X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fsmpte_subtitle_asset.h;h=2632e0a526868bf9216a416dc55b002ce2e9c095;hb=refs%2Ftags%2Fv1.8.63;hp=23c0e948bddfe2526ea858d868153c8f91344625;hpb=4debca21936fd004fdcabe8d6178694f8cbf5f4d;p=libdcp.git diff --git a/src/smpte_subtitle_asset.h b/src/smpte_subtitle_asset.h index 23c0e948..2632e0a5 100644 --- a/src/smpte_subtitle_asset.h +++ b/src/smpte_subtitle_asset.h @@ -1,72 +1,114 @@ /* - 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. */ + +#ifndef LIBDCP_SMPTE_SUBTITLE_ASSET_H +#define LIBDCP_SMPTE_SUBTITLE_ASSET_H + + /** @file src/smpte_subtitle_asset.h - * @brief SMPTESubtitleAsset class. + * @brief SMPTESubtitleAsset class */ -#include "subtitle_asset.h" + +#include "crypto_context.h" +#include "language_tag.h" #include "local_time.h" #include "mxf.h" +#include "subtitle_asset.h" +#include "subtitle_standard.h" #include + namespace ASDCP { namespace TimedText { class MXFReader; } } + +struct verify_invalid_language1; +struct verify_invalid_language2; +struct write_subtitles_in_vertical_order_with_top_alignment; +struct write_subtitles_in_vertical_order_with_bottom_alignment; + + namespace dcp { + class SMPTELoadFontNode; + /** @class SMPTESubtitleAsset - * @brief A set of subtitles to be read and/or written in the SMPTE format. + * @brief A set of subtitles to be read and/or written in the SMPTE format */ class SMPTESubtitleAsset : public SubtitleAsset, public MXF { public: - SMPTESubtitleAsset (); + explicit SMPTESubtitleAsset(SubtitleStandard standard = SubtitleStandard::SMPTE_2014); - /** @param file File name + /** Construct a SMPTESubtitleAsset by reading an MXF or XML file + * @param file Filename */ - SMPTESubtitleAsset (boost::filesystem::path file); + explicit SMPTESubtitleAsset (boost::filesystem::path file); bool equals ( - boost::shared_ptr, + std::shared_ptr, EqualityOptions, NoteHandler note - ) const; + ) const override; + + std::vector> load_font_nodes () const override; - std::list > load_font_nodes () const; + std::string xml_as_string () const override; - Glib::ustring xml_as_string () const; - void write (boost::filesystem::path path) const; - void add (SubtitleString); - void add_font (std::string id, boost::filesystem::path file); + /** Write this content to a MXF file */ + void write (boost::filesystem::path path) const override; + + void add (std::shared_ptr) override; + void add_font (std::string id, dcp::ArrayData data) override; + void set_key (Key key) override; void set_content_title_text (std::string t) { _content_title_text = t; } - void set_language (std::string l) { - _language = l; + void set_language (dcp::LanguageTag l) { + _language = l.to_string(); + } + + void set_issue_date (LocalTime t) { + _issue_date = t; } void set_reel_number (int r) { @@ -89,14 +131,20 @@ public: _intrinsic_duration = d; } + int64_t intrinsic_duration () const { + return _intrinsic_duration; + } + /** @return title of the film that these subtitles are for, - * to be presented to the user. + * 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 */ + /** @return Language, if one was set. This should be a xs:language, but + * it might not be if a non-compliant DCP was read in. + */ boost::optional language () const { return _language; } @@ -106,7 +154,7 @@ public: return _annotation_text; } - /** @return file creation time and date */ + /** @return file issue time and date */ LocalTime issue_date () const { return _issue_date; } @@ -123,7 +171,7 @@ public: * 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 { + int time_code_rate () const override { return _time_code_rate; } @@ -131,31 +179,83 @@ public: return _start_time; } + /** @return ID from XML's tag, or the that will be used when writing the XML, + * or boost::none if this content is encrypted and no key is available. + */ + boost::optional xml_id () const { + return _xml_id; + } + + /** @return ResourceID read from any MXF that was read */ + boost::optional resource_id () const { + return _resource_id; + } + + SubtitleStandard subtitle_standard() const override { + return _subtitle_standard; + } + 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 override { + return static_pkl_type (s); } private: - void read_fonts (boost::shared_ptr); + friend struct ::write_smpte_subtitle_test; + friend struct ::write_smpte_subtitle_test2; + friend struct ::verify_invalid_language1; + friend struct ::verify_invalid_language2; + friend struct ::write_subtitles_in_vertical_order_with_top_alignment; + friend struct ::write_subtitles_in_vertical_order_with_bottom_alignment; + + void read_fonts (std::shared_ptr); + void parse_xml (std::shared_ptr xml); + void read_mxf_descriptor (std::shared_ptr reader); + void read_mxf_resources (std::shared_ptr reader, std::shared_ptr dec); + std::string schema_namespace() const; /** The total length of this content in video frames. The amount of * content presented may be less than this. */ - int64_t _intrinsic_duration; + int64_t _intrinsic_duration = 0; + /** from the asset */ std::string _content_title_text; + /** This is stored and returned as a string so that we can tolerate non-RFC-5646 strings, + * but must be set as a dcp::LanguageTag to try to ensure that we create compliant output. + */ boost::optional _language; boost::optional _annotation_text; LocalTime _issue_date; boost::optional _reel_number; Fraction _edit_rate; - int _time_code_rate; + int _time_code_rate = 0; boost::optional