Fix numerous bugs in subtitle XML generation.

[libdcp.git] / src / subtitle_asset.h

diff --git a/src/subtitle_asset.h b/src/subtitle_asset.h
index 038ff1fa98b4fcf96316683948901d639a8b81e9..5d996c7ad95b7323716f913234bb442dfe9873bd 100644 (file)
--- a/src/subtitle_asset.h
+++ b/src/subtitle_asset.h
@@ -24,6 +24,8 @@
 namespace libdcp
 {
 
+class FontNode;
+
 class TextNode : public XMLNode
 {
 public:
@@ -31,7 +33,9 @@ public:
        TextNode (xmlpp::Node const * node);
 
        float v_position;
+       VAlign v_align;
        std::string text;
+       std::list<boost::shared_ptr<FontNode> > font_nodes;
 };
 
 class SubtitleNode : public XMLNode
@@ -42,7 +46,13 @@ public:
 
        Time in;
        Time out;
+       Time fade_up_time;
+       Time fade_down_time;
+       std::list<boost::shared_ptr<FontNode> > font_nodes;
        std::list<boost::shared_ptr<TextNode> > text_nodes;
+
+private:
+       Time fade_time (std::string name);
 };
 
 class FontNode : public XMLNode
@@ -50,11 +60,19 @@ class FontNode : public XMLNode
 public:
        FontNode () {}
        FontNode (xmlpp::Node const * node);
+       FontNode (std::list<boost::shared_ptr<FontNode> > const & font_nodes);
 
+       std::string text;
        std::string id;
        int size;
+       boost::optional<bool> italic;
+       boost::optional<Color> color;
+       boost::optional<Effect> effect;
+       boost::optional<Color> effect_color;
        
        std::list<boost::shared_ptr<SubtitleNode> > subtitle_nodes;
+       std::list<boost::shared_ptr<FontNode> > font_nodes;
+       std::list<boost::shared_ptr<TextNode> > text_nodes;
 };
 
 class LoadFontNode : public XMLNode
@@ -72,17 +90,32 @@ class Subtitle
 public:
        Subtitle (
                std::string font,
+               bool italic,
+               Color color,
                int size,
                Time in,
                Time out,
                float v_position,
-               std::string text
+               VAlign v_align,
+               std::string text,
+               Effect effect,
+               Color effect_color,
+               Time fade_up_time,
+               Time fade_down_time
                );
 
        std::string font () const {
                return _font;
        }
 
+       bool italic () const {
+               return _italic;
+       }
+
+       Color color () const {
+               return _color;
+       }
+
        Time in () const {
                return _in;
        }
@@ -99,26 +132,62 @@ public:
                return _v_position;
        }
 
+       VAlign v_align () const {
+               return _v_align;
+       }
+
+       Effect effect () const {
+               return _effect;
+       }
+
+       Color effect_color () const {
+               return _effect_color;
+       }
+
+       Time fade_up_time () const {
+               return _fade_up_time;
+       }
+
+       Time fade_down_time () const {
+               return _fade_down_time;
+       }
+
+       int size () const {
+               return _size;
+       }
+       
        int size_in_pixels (int screen_height) const;
 
 private:
        std::string _font;
+       bool _italic;
+       Color _color;
        int _size;
        Time _in;
        Time _out;
        float _v_position;
+       VAlign _v_align;
        std::string _text;
+       Effect _effect;
+       Color _effect_color;
+       Time _fade_up_time;
+       Time _fade_down_time;
 };
 
-class SubtitleAsset : public Asset, public XMLFile
+bool operator== (Subtitle const & a, Subtitle const & b);
+std::ostream& operator<< (std::ostream& s, Subtitle const & sub);
+
+class SubtitleAsset : public Asset
 {
 public:
-       SubtitleAsset (std::string directory, std::string xml);
+       SubtitleAsset (std::string directory, std::string xml_file);
+       SubtitleAsset (std::string directory, std::string movie_title, std::string language);
 
-       void write_to_cpl (std::ostream&) const {}
-       virtual std::list<std::string> equals (boost::shared_ptr<const Asset>, EqualityOptions) const {
+       void write_to_cpl (std::ostream&) const;
+       virtual bool equals (boost::shared_ptr<const Asset>, EqualityOptions, std::list<std::string>& notes) const {
                /* XXX */
-               return std::list<std::string> ();
+               notes.push_back ("subtitle assets not compared yet");
+               return true;
        }
 
        std::string language () const {
@@ -126,14 +195,44 @@ public:
        }
 
        std::list<boost::shared_ptr<Subtitle> > subtitles_at (Time t) const;
+       std::list<boost::shared_ptr<Subtitle> > const & subtitles () const {
+               return _subtitles;
+       }
+
+       void add (boost::shared_ptr<Subtitle>);
+
+       void read_xml (std::string);
+       void write_xml ();
+       void write_xml (std::ostream& s);
 
 private:
-       std::string font_id_to_name (std::string id, std::list<boost::shared_ptr<LoadFontNode> > const & load_font_nodes) const;
+       std::string font_id_to_name (std::string id) const;
+
+       struct ParseState {
+               std::list<boost::shared_ptr<FontNode> > font_nodes;
+               std::list<boost::shared_ptr<TextNode> > text_nodes;
+               std::list<boost::shared_ptr<SubtitleNode> > subtitle_nodes;
+       };
+
+       void maybe_add_subtitle (std::string text, ParseState const & parse_state);
        
-       std::string _subtitle_id;
+       void examine_font_nodes (
+               boost::shared_ptr<XMLFile> xml,
+               std::list<boost::shared_ptr<FontNode> > const & font_nodes,
+               ParseState& parse_state
+               );
+       
+       void examine_text_nodes (
+               boost::shared_ptr<XMLFile> xml,
+               std::list<boost::shared_ptr<TextNode> > const & text_nodes,
+               ParseState& parse_state
+               );
+
        std::string _movie_title;
-       int64_t _reel_number;
+       /* strangely, this is sometimes a string */
+       std::string _reel_number;
        std::string _language;
+       std::list<boost::shared_ptr<LoadFontNode> > _load_font_nodes;
 
        std::list<boost::shared_ptr<Subtitle> > _subtitles;
 };