Bv2.1 6.2.1: Check that subtitle XML <Language> conforms to RFC 5646.
[libdcp.git] / src / smpte_subtitle_asset.h
index 444c53e6c4a3395dbf74be5e8d982dc807992159..28aecefa25c7a674f60472c077a5c7f2e01d2b6c 100644 (file)
@@ -1,20 +1,34 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 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/smpte_subtitle_asset.h
  */
 
 #include "subtitle_asset.h"
+#include "language_tag.h"
 #include "local_time.h"
 #include "mxf.h"
+#include "crypto_context.h"
 #include <boost/filesystem.hpp>
 
+namespace ASDCP {
+       namespace TimedText {
+               class MXFReader;
+       }
+}
+
+struct verify_test26;
+
 namespace dcp {
 
 class SMPTELoadFontNode;
@@ -40,26 +64,36 @@ public:
 
        /** @param file File name
         */
-       SMPTESubtitleAsset (boost::filesystem::path file);
+       explicit SMPTESubtitleAsset (boost::filesystem::path file);
 
        bool equals (
-               boost::shared_ptr<const Asset>,
+               std::shared_ptr<const Asset>,
                EqualityOptions,
                NoteHandler note
                ) const;
 
-       std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
+       std::list<std::shared_ptr<LoadFontNode> > load_font_nodes () const;
 
-       Glib::ustring xml_as_string () const;
+       std::string xml_as_string () const;
        void write (boost::filesystem::path path) const;
-       void add_font (std::string id, boost::filesystem::path file);
+       void add (std::shared_ptr<Subtitle>);
+       void add_font (std::string id, dcp::ArrayData data);
+       void set_key (Key key);
 
        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) {
+               _reel_number = r;
        }
 
        void set_edit_rate (Fraction e) {
@@ -70,6 +104,14 @@ public:
                _time_code_rate = t;
        }
 
+       void set_start_time (Time t) {
+               _start_time = t;
+       }
+
+       void set_intrinsic_duration (int64_t d) {
+               _intrinsic_duration = d;
+       }
+
        /** @return title of the film that these subtitles are for,
         *  to be presented to the user.
         */
@@ -77,7 +119,9 @@ public:
                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<std::string> language () const {
                return _language;
        }
@@ -112,16 +156,39 @@ public:
                return _start_time;
        }
 
+       std::string xml_id () const {
+               return _xml_id;
+       }
+
        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 {
+               return static_pkl_type (s);
        }
 
 private:
+       friend struct ::write_smpte_subtitle_test;
+       friend struct ::write_smpte_subtitle_test2;
+       friend struct ::verify_test26;
+
+       void read_fonts (std::shared_ptr<ASDCP::TimedText::MXFReader>);
+       void parse_xml (std::shared_ptr<cxml::Document> xml);
+       void read_mxf_descriptor (std::shared_ptr<ASDCP::TimedText::MXFReader> reader, std::shared_ptr<DecryptionContext> dec);
+
+       /** The total length of this content in video frames.  The amount of
+        *  content presented may be less than this.
+        */
+       int64_t _intrinsic_duration;
+       /** <ContentTitleText> 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<std::string> _language;
        boost::optional<std::string> _annotation_text;
        LocalTime _issue_date;
@@ -130,7 +197,11 @@ private:
        int _time_code_rate;
        boost::optional<Time> _start_time;
 
-       std::list<boost::shared_ptr<SMPTELoadFontNode> > _load_font_nodes;
+       std::list<std::shared_ptr<SMPTELoadFontNode> > _load_font_nodes;
+       /** UUID for the XML inside the MXF, which should be different to the ID of the MXF according to
+        *  Doremi's 2.8.18 release notes.
+        */
+       std::string _xml_id;
 };
 
 }