Missing finalize() in dcpdecryptmxf.
[libdcp.git] / src / smpte_subtitle_asset.h
index 1521bf359e1aca95a7d9c2566594c14a8ba301bf..4e220d4d586003a06da83ab79ec60fc3afc1d409 100644 (file)
 */
 
 
+#ifndef LIBDCP_SMPTE_SUBTITLE_ASSET_H
+#define LIBDCP_SMPTE_SUBTITLE_ASSET_H
+
+
 /** @file  src/smpte_subtitle_asset.h
  *  @brief SMPTESubtitleAsset class
  */
@@ -79,18 +83,18 @@ public:
                std::shared_ptr<const Asset>,
                EqualityOptions,
                NoteHandler note
-               ) const;
+               ) const override;
 
-       std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const;
+       std::vector<std::shared_ptr<LoadFontNode>> load_font_nodes () const override;
 
-       std::string xml_as_string () const;
+       std::string xml_as_string () const override;
 
        /** Write this content to a MXF file */
-       void write (boost::filesystem::path path) const;
+       void write (boost::filesystem::path path) const override;
 
-       void add (std::shared_ptr<Subtitle>);
-       void add_font (std::string id, dcp::ArrayData data);
-       void set_key (Key key);
+       void add (std::shared_ptr<Subtitle>) 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;
@@ -124,6 +128,10 @@ 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
         */
@@ -160,7 +168,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;
        }
 
@@ -168,10 +176,18 @@ public:
                return _start_time;
        }
 
-       std::string xml_id () const {
+       /** @return ID from XML's <Id> tag, or the <Id> that will be used when writing the XML,
+        *  or boost::none if this content is encrypted and no key is available.
+        */
+       boost::optional<std::string> xml_id () const {
                return _xml_id;
        }
 
+       /** @return ResourceID read from any MXF that was read */
+       boost::optional<std::string> resource_id () const {
+               return _resource_id;
+       }
+
        static bool valid_mxf (boost::filesystem::path);
        static std::string static_pkl_type (Standard) {
                return "application/mxf";
@@ -179,7 +195,7 @@ public:
 
 protected:
 
-       std::string pkl_type (Standard s) const {
+       std::string pkl_type (Standard s) const override {
                return static_pkl_type (s);
        }
 
@@ -191,7 +207,8 @@ private:
 
        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);
+       void read_mxf_descriptor (std::shared_ptr<ASDCP::TimedText::MXFReader> reader);
+       void read_mxf_resources (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.
@@ -211,11 +228,18 @@ private:
        boost::optional<Time> _start_time;
 
        std::vector<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.
+       /** UUID for the XML inside the MXF, which should be the same as the ResourceID in the MXF (our _resource_id)
+        *  but different to the AssetUUID in the MXF (our _id) according to SMPTE Bv2.1 and Doremi's 2.8.18 release notes.
+        *  May be boost::none if this object has been made from an encrypted object without a key.
         */
-       std::string _xml_id;
+       boost::optional<std::string> _xml_id;
+
+       /** ResourceID read from the MXF, if there was one */
+       boost::optional<std::string> _resource_id;
 };
 
 
 }
+
+
+#endif