namespace libdcp -> dcp.

[libdcp.git] / src / subtitle_asset.h

diff --git a/src/subtitle_asset.h b/src/subtitle_asset.h
index aff3dae582ef0e8cf111ed3b1129d11bde3e658d..e5e2e853df91653d8c5c339d00e6046d86806fda 100644 (file)
--- a/src/subtitle_asset.h
+++ b/src/subtitle_asset.h
@@ -17,61 +17,23 @@
 
 */
 
+#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 TextNode : public XMLNode
-{
-public:
-       TextNode () {}
-       TextNode (xmlpp::Node const * node);
-
-       float v_position;
-       std::string text;
-};
-
-class SubtitleNode : public XMLNode
-{
-public:
-       SubtitleNode () {}
-       SubtitleNode (xmlpp::Node const * node);
-
-       Time in;
-       Time out;
-       std::list<boost::shared_ptr<TextNode> > text_nodes;
-};
-
-class FontNode : public XMLNode
+namespace dcp
 {
-public:
-       FontNode () {}
-       FontNode (xmlpp::Node const * node);
-       FontNode (std::list<boost::shared_ptr<FontNode> > const & font_nodes);
-
-       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;
-};
 
-class LoadFontNode : public XMLNode
+namespace parse
 {
-public:
-       LoadFontNode () {}
-       LoadFontNode (xmlpp::Node const * node);
-
-       std::string id;
-       std::string uri;
-};
+       class Font;
+       class Text;
+       class Subtitle;
+       class LoadFont;
+}
 
 class Subtitle
 {
@@ -84,9 +46,12 @@ public:
                Time in,
                Time out,
                float v_position,
+               VAlign v_align,
                std::string text,
                Effect effect,
-               Color effect_color
+               Color effect_color,
+               Time fade_up_time,
+               Time fade_down_time
                );
 
        std::string font () const {
@@ -117,6 +82,10 @@ public:
                return _v_position;
        }
 
+       VAlign v_align () const {
+               return _v_align;
+       }
+
        Effect effect () const {
                return _effect;
        }
@@ -125,30 +94,56 @@ public:
                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;
+       /** 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 1)
+        */
        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 (xmlpp::Element *) const;
+       virtual bool equals (boost::shared_ptr<const Asset>, EqualityOptions, boost::function<void (NoteType, std::string)> note) const {
                /* XXX */
-               return std::list<std::string> ();
+               note (ERROR, "subtitle assets not compared yet");
+               return true;
        }
 
        std::string language () const {
@@ -156,18 +151,49 @@ 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 () const;
+       Glib::ustring xml_as_string () const;
 
 private:
        std::string font_id_to_name (std::string id) const;
-       void examine_font_node (boost::shared_ptr<FontNode> font_node, std::list<boost::shared_ptr<FontNode> >& current_font_nodes);
+
+       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;
+       };
+
+       void maybe_add_subtitle (std::string text, ParseState const & parse_state);
        
-       std::string _subtitle_id;
+       void examine_font_nodes (
+               boost::shared_ptr<const cxml::Node> xml,
+               std::list<boost::shared_ptr<parse::Font> > const & font_nodes,
+               ParseState& parse_state
+               );
+       
+       void examine_text_nodes (
+               boost::shared_ptr<const cxml::Node> xml,
+               std::list<boost::shared_ptr<parse::Text> > 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<parse::LoadFont> > _load_font_nodes;
 
        std::list<boost::shared_ptr<Subtitle> > _subtitles;
+       bool _need_sort;
 };
 
 }
+
+#endif