Add test() to cscript.
[libdcp.git] / src / subtitle_asset.h
index 392d70b433b8c11c31bf664438356991f9a3688b..335b9f37b0af22c3456b12b003348339d34e2d1a 100644 (file)
 
 */
 
+#ifndef LIBDCP_SUBTITLE_ASSET_H
+#define LIBDCP_SUBTITLE_ASSET_H
+
+#include <libcxml/cxml.h>
 #include "asset.h"
-#include "xml.h"
 #include "dcp_time.h"
 
 namespace libdcp
 {
 
-class Text : public XMLNode
+namespace parse
 {
-public:
-       Text () {}
-       Text (xmlpp::Node const * node);
+       class Font;
+       class Text;
+       class Subtitle;
+       class LoadFont;
+}
 
-       float v_position () const {
-               return _v_position;
+class Subtitle
+{
+public:
+       Subtitle (
+               std::string font,
+               bool italic,
+               Color color,
+               int size,
+               Time in,
+               Time out,
+               float v_position,
+               VAlign v_align,
+               HAlign h_align,
+               std::string text,
+               Effect effect,
+               Color effect_color,
+               Time fade_up_time,
+               Time fade_down_time
+               );
+
+       std::string font () const {
+               return _font;
        }
 
-       std::string text () const {
-               return _text;
+       bool italic () const {
+               return _italic;
        }
 
-private:
-       float _v_position;
-       std::string _text;
-};
-
-class Subtitle : public XMLNode
-{
-public:
-       Subtitle () {}
-       Subtitle (xmlpp::Node const * node);
+       Color color () const {
+               return _color;
+       }
 
        Time in () const {
                return _in;
@@ -57,54 +75,133 @@ public:
                return _out;
        }
 
-       std::list<boost::shared_ptr<Text> > texts () const {
-               return _texts;
+       std::string text () const {
+               return _text;
        }
 
-private:
-       std::list<boost::shared_ptr<Text> > _texts;
-       Time _in;
-       Time _out;
-};
+       void set_text (std::string t) {
+               _text = t;
+       }
 
-class Font : public XMLNode
-{
-public:
-       Font () {}
-       Font (xmlpp::Node const * node);
+       float v_position () const {
+               return _v_position;
+       }
 
-       std::list<boost::shared_ptr<Subtitle> > subtitles () const {
-               return _subtitles;
+       VAlign v_align () const {
+               return _v_align;
        }
 
+       HAlign h_align () const {
+               return _h_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::list<boost::shared_ptr<Subtitle> > _subtitles;
+       std::string _font;
+       bool _italic;
+       Color _color;
+       /** Size in points as if the screen height is 11 inches, so a 72pt font
+        *  would be 1/11th of the screen height.
+        */ 
+       int _size;
+       Time _in;
+       Time _out;
+       /** Vertical position as a proportion of the screen height from the top
+        *  (between 0 and 100).
+        */
+       float _v_position;
+       VAlign _v_align;
+       HAlign _h_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);
-
-       void write_to_cpl (std::ostream&) const {}
-       virtual std::list<std::string> equals (boost::shared_ptr<const Asset>, EqualityOptions) const {
-               return std::list<std::string> ();
+       SubtitleAsset (std::string directory, std::string xml_file);
+       SubtitleAsset (std::string directory, std::string movie_title, std::string language);
+
+       void write_to_cpl (xmlpp::Element *) const;
+       virtual bool equals (boost::shared_ptr<const Asset>, EqualityOptions, boost::function<void (NoteType, std::string)> note) const {
+               /* XXX */
+               note (ERROR, "subtitle assets not compared yet");
+               return true;
        }
 
        std::string language () const {
                return _language;
        }
 
-       std::list<boost::shared_ptr<Font> > fonts () const {
-               return _fonts;
+       std::list<boost::shared_ptr<Subtitle> > subtitles_during (Time from, Time to) 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 () const;
+       Glib::ustring xml_as_string () const;
+
+protected:
+
+       std::string asdcp_kind () const {
+               return "Subtitle";
        }
 
 private:
-       std::string _subtitle_id;
-       std::string _movie_title;
-       int64_t _reel_number;
+       std::string font_id_to_name (std::string id) const;
+       void read_mxf (std::string);
+       void read_xml (boost::shared_ptr<cxml::Document>, bool smpte);
+
+       struct ParseState {
+               std::list<boost::shared_ptr<parse::Font> > font_nodes;
+               std::list<boost::shared_ptr<parse::Text> > text_nodes;
+               std::list<boost::shared_ptr<parse::Subtitle> > subtitle_nodes;
+               boost::shared_ptr<Subtitle> current;
+       };
+
+       void parse_node (xmlpp::Node* node, ParseState& parse_state, boost::optional<int> tcr);
+       void maybe_add_subtitle (std::string text, ParseState& parse_state);
+
+       boost::optional<std::string> _movie_title;
+       /* strangely, this is sometimes a string */
+       std::string _reel_number;
        std::string _language;
-       std::list<boost::shared_ptr<Font> > _fonts;
+       std::list<boost::shared_ptr<parse::LoadFont> > _load_font_nodes;
+
+       std::list<boost::shared_ptr<Subtitle> > _subtitles;
+       bool _need_sort;
 };
 
 }
+
+#endif