Bv2.1 6.2.1: Check that subtitle XML <Language> conforms to RFC 5646.

[libdcp.git] / src / smpte_subtitle_asset.h

diff --git a/src/smpte_subtitle_asset.h b/src/smpte_subtitle_asset.h
index 9169a3d64298f315c8944140ebf540e919940756..28aecefa25c7a674f60472c077a5c7f2e01d2b6c 100644 (file)
--- a/src/smpte_subtitle_asset.h
+++ b/src/smpte_subtitle_asset.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -36,6 +36,7 @@
  */
 
 #include "subtitle_asset.h"
+#include "language_tag.h"
 #include "local_time.h"
 #include "mxf.h"
 #include "crypto_context.h"
@@ -47,6 +48,8 @@ namespace ASDCP {
        }
 }
 
+struct verify_test26;
+
 namespace dcp {
 
 class SMPTELoadFontNode;
@@ -64,25 +67,25 @@ public:
        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;
 
        std::string xml_as_string () const;
        void write (boost::filesystem::path path) const;
-       void add (SubtitleString);
-       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) {
@@ -116,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;
        }
@@ -156,20 +161,24 @@ public:
        }
 
        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 (boost::shared_ptr<ASDCP::TimedText::MXFReader>);
-       void parse_xml (boost::shared_ptr<cxml::Document> xml);
-       void read_mxf_descriptor (boost::shared_ptr<ASDCP::TimedText::MXFReader> reader, boost::shared_ptr<DecryptionContext> dec);
+       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.
@@ -177,6 +186,9 @@ private:
        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;
@@ -185,7 +197,7 @@ 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.
         */