Fix erroneous reports of unresolved assets when checking OV/VF pairs.
[libdcp.git] / src / subtitle_asset.h
index 62314263010c8a1bfa3ed1e79760f6eee33516a5..9f137abe300c1c1aae52af0e0d8c65c522474af4 100644 (file)
@@ -48,20 +48,29 @@ namespace xmlpp {
 
 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;
+class SubtitleImage;
 class FontNode;
 class TextNode;
 class SubtitleNode;
 class LoadFontNode;
 
+namespace order {
+       class Part;
+       class Context;
+}
+
 /** @class SubtitleAsset
  *  @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.
@@ -78,12 +87,12 @@ public:
                NoteHandler note
                ) const;
 
-       std::list<SubtitleString> subtitles_during (Time from, Time to, bool starting) const;
-       std::list<SubtitleString> const & subtitles () const {
+       std::list<boost::shared_ptr<Subtitle> > subtitles_during (Time from, Time to, bool starting) const;
+       std::list<boost::shared_ptr<Subtitle> > const & subtitles () const {
                return _subtitles;
        }
 
-       virtual void add (SubtitleString);
+       virtual void add (boost::shared_ptr<Subtitle>);
        virtual void add_font (std::string id, boost::filesystem::path file) = 0;
        std::map<std::string, Data> fonts_with_load_ids () const;
 
@@ -92,6 +101,8 @@ public:
 
        Time latest_subtitle_out () const;
 
+       void fix_empty_font_ids ();
+
        virtual std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const = 0;
 
 protected:
@@ -117,18 +128,25 @@ protected:
                boost::optional<Time> out;
                boost::optional<Time> fade_up_time;
                boost::optional<Time> fade_down_time;
+               enum Type {
+                       TEXT,
+                       IMAGE
+               };
+               boost::optional<Type> type;
        };
 
        void parse_subtitles (xmlpp::Element const * node, std::list<ParseState>& state, boost::optional<int> tcr, Standard standard);
        ParseState font_node_state (xmlpp::Element const * node, Standard standard) const;
        ParseState text_node_state (xmlpp::Element const * node) const;
+       ParseState image_node_state (xmlpp::Element const * node) const;
        ParseState subtitle_node_state (xmlpp::Element const * node, boost::optional<int> tcr) const;
        Time fade_time (xmlpp::Element const * node, std::string name, boost::optional<int> tcr) const;
+       void position_align (ParseState& ps, xmlpp::Element const * node) const;
 
        void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const;
 
        /** All our subtitles, in no particular order */
-       std::list<SubtitleString> _subtitles;
+       std::list<boost::shared_ptr<Subtitle> > _subtitles;
 
        class Font
        {
@@ -153,10 +171,17 @@ protected:
                mutable boost::optional<boost::filesystem::path> file;
        };
 
+       /** TTF font data that we need */
        std::list<Font> _fonts;
 
 private:
-       void maybe_add_subtitle (std::string text, std::list<ParseState> const & parse_state);
+       friend struct ::pull_fonts_test1;
+       friend struct ::pull_fonts_test2;
+       friend struct ::pull_fonts_test3;
+
+       void maybe_add_subtitle (std::string text, std::list<ParseState> const & parse_state, Standard standard);
+
+       static void pull_fonts (boost::shared_ptr<order::Part> part);
 };
 
 }