Add AspectAdjust to subtitles.
[libdcp.git] / src / subtitle_content.cc
index a622e7b09a2cce1b144c0e03763b0e5d7540fd6a..1977861e17892798f6eabd27c4e774d59b6d7ba3 100644 (file)
 #include "subtitle_content.h"
 #include "util.h"
 #include "xml.h"
-#include "font.h"
-#include "text.h"
-#include "load_font.h"
+#include "font_node.h"
+#include "text_node.h"
 #include "subtitle_string.h"
+#include "dcp_assert.h"
 #include "AS_DCP.h"
 #include "KM_util.h"
 #include <libxml++/nodes/element.h>
@@ -39,89 +39,49 @@ using std::stringstream;
 using std::cout;
 using boost::shared_ptr;
 using boost::optional;
+using boost::dynamic_pointer_cast;
 using namespace dcp;
 
-SubtitleContent::SubtitleContent (boost::filesystem::path file, bool mxf)
+SubtitleContent::SubtitleContent ()
+       : _reel_number ("1")
+{
+
+}
+
+SubtitleContent::SubtitleContent (boost::filesystem::path file)
        : Content (file)
-       , _need_sort (false)
+       , _reel_number ("1")
 {
-       shared_ptr<cxml::Document> xml;
-       
-       if (mxf) {
-               ASDCP::TimedText::MXFReader reader;
-               Kumu::Result_t r = reader.OpenRead (file.string().c_str ());
-               if (ASDCP_FAILURE (r)) {
-                       boost::throw_exception (MXFFileError ("could not open MXF file for reading", file, r));
-               }
-               
-               string s;
-               reader.ReadTimedTextResource (s, 0, 0);
-               xml.reset (new cxml::Document ("SubtitleReel"));
-               stringstream t;
-               t << s;
-               xml->read_stream (t);
-
-               ASDCP::WriterInfo info;
-               reader.FillWriterInfo (info);
-               
-               char buffer[64];
-               Kumu::bin2UUIDhex (info.AssetUUID, ASDCP::UUIDlen, buffer, sizeof (buffer));
-               _id = buffer;
-
-       } else {
-               xml.reset (new cxml::Document ("DCSubtitle"));
-               xml->read_file (file);
-               _id = xml->string_child ("SubtitleID");
-       }
 
-       /* XXX: hacks aplenty in here; probably need separate parsers for DCSubtitle and SubtitleReel */
+}
 
-       _movie_title = xml->optional_string_child ("MovieTitle");
+void
+SubtitleContent::parse_common (shared_ptr<cxml::Document> xml, list<shared_ptr<dcp::FontNode> > font_nodes)
+{
        _reel_number = xml->string_child ("ReelNumber");
        _language = xml->string_child ("Language");
 
-       xml->ignore_child ("LoadFont");
-
-       list<shared_ptr<dcp::Font> > font_nodes = type_children<dcp::Font> (xml, "Font");
-       _load_font_nodes = type_children<dcp::LoadFont> (xml, "LoadFont");
-
        /* Now make Subtitle objects to represent the raw XML nodes
           in a sane way.
        */
 
-       shared_ptr<cxml::Node> subtitle_list = xml->optional_node_child ("SubtitleList");
-       if (subtitle_list) {
-               list<shared_ptr<dcp::Font> > font = type_children<dcp::Font> (subtitle_list, "Font");
-               copy (font.begin(), font.end(), back_inserter (font_nodes));
-       }
-       
        ParseState parse_state;
        examine_font_nodes (xml, font_nodes, parse_state);
 }
 
-SubtitleContent::SubtitleContent (Fraction edit_rate, string movie_title, string language)
-       : Content (edit_rate)
-       , _movie_title (movie_title)
-       , _reel_number ("1")
-       , _language (language)
-       , _need_sort (false)
-{
-
-}
-
 void
 SubtitleContent::examine_font_nodes (
        shared_ptr<const cxml::Node> xml,
-       list<shared_ptr<dcp::Font> > const & font_nodes,
+       list<shared_ptr<dcp::FontNode> > const & font_nodes,
        ParseState& parse_state
        )
 {
-       for (list<shared_ptr<dcp::Font> >::const_iterator i = font_nodes.begin(); i != font_nodes.end(); ++i) {
+       for (list<shared_ptr<dcp::FontNode> >::const_iterator i = font_nodes.begin(); i != font_nodes.end(); ++i) {
 
                parse_state.font_nodes.push_back (*i);
                maybe_add_subtitle ((*i)->text, parse_state);
 
-               for (list<shared_ptr<dcp::Subtitle> >::iterator j = (*i)->subtitle_nodes.begin(); j != (*i)->subtitle_nodes.end(); ++j) {
+               for (list<shared_ptr<dcp::SubtitleNode> >::iterator j = (*i)->subtitle_nodes.begin(); j != (*i)->subtitle_nodes.end(); ++j) {
                        parse_state.subtitle_nodes.push_back (*j);
                        examine_text_nodes (xml, (*j)->text_nodes, parse_state);
                        examine_font_nodes (xml, (*j)->font_nodes, parse_state);
@@ -138,11 +98,11 @@ SubtitleContent::examine_font_nodes (
 void
 SubtitleContent::examine_text_nodes (
        shared_ptr<const cxml::Node> xml,
-       list<shared_ptr<dcp::Text> > const & text_nodes,
+       list<shared_ptr<dcp::TextNode> > const & text_nodes,
        ParseState& parse_state
        )
 {
-       for (list<shared_ptr<dcp::Text> >::const_iterator i = text_nodes.begin(); i != text_nodes.end(); ++i) {
+       for (list<shared_ptr<dcp::TextNode> >::const_iterator i = text_nodes.begin(); i != text_nodes.end(); ++i) {
                parse_state.text_nodes.push_back (*i);
                maybe_add_subtitle ((*i)->text, parse_state);
                examine_font_nodes (xml, (*i)->font_nodes, parse_state);
@@ -161,40 +121,39 @@ SubtitleContent::maybe_add_subtitle (string text, ParseState const & parse_state
                return;
        }
 
-       assert (!parse_state.text_nodes.empty ());
-       assert (!parse_state.subtitle_nodes.empty ());
+       DCP_ASSERT (!parse_state.text_nodes.empty ());
+       DCP_ASSERT (!parse_state.subtitle_nodes.empty ());
        
-       dcp::Font effective_font (parse_state.font_nodes);
-       dcp::Text effective_text (*parse_state.text_nodes.back ());
-       dcp::Subtitle effective_subtitle (*parse_state.subtitle_nodes.back ());
+       dcp::FontNode effective_font (parse_state.font_nodes);
+       dcp::TextNode effective_text (*parse_state.text_nodes.back ());
+       dcp::SubtitleNode effective_subtitle (*parse_state.subtitle_nodes.back ());
 
        _subtitles.push_back (
-               shared_ptr<SubtitleString> (
-                       new SubtitleString (
-                               font_id_to_name (effective_font.id),
-                               effective_font.italic.get(),
-                               effective_font.color.get(),
-                               effective_font.size,
-                               effective_subtitle.in,
-                               effective_subtitle.out,
-                               effective_text.v_position,
-                               effective_text.v_align,
-                               text,
-                               effective_font.effect ? effective_font.effect.get() : NONE,
-                               effective_font.effect_color.get(),
-                               effective_subtitle.fade_up_time,
-                               effective_subtitle.fade_down_time
-                               )
+               SubtitleString (
+                       effective_font.id,
+                       effective_font.italic.get_value_or (false),
+                       effective_font.colour.get_value_or (dcp::Colour (255, 255, 255)),
+                       effective_font.size,
+                       effective_font.aspect_adjust.get_value_or (1.0),
+                       effective_subtitle.in,
+                       effective_subtitle.out,
+                       effective_text.v_position,
+                       effective_text.v_align,
+                       text,
+                       effective_font.effect.get_value_or (NONE),
+                       effective_font.effect_colour.get_value_or (dcp::Colour (0, 0, 0)),
+                       effective_subtitle.fade_up_time,
+                       effective_subtitle.fade_down_time
                        )
                );
 }
 
-list<shared_ptr<SubtitleString> >
-SubtitleContent::subtitles_at (Time t) const
+list<SubtitleString>
+SubtitleContent::subtitles_during (Time from, Time to) const
 {
-       list<shared_ptr<SubtitleString> > s;
-       for (list<shared_ptr<SubtitleString> >::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
-               if ((*i)->in() <= t && t <= (*i)->out ()) {
+       list<SubtitleString> s;
+       for (list<SubtitleString>::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
+               if (i->out() >= from && i->in() <= to) {
                        s.push_back (*i);
                }
        }
@@ -202,163 +161,66 @@ SubtitleContent::subtitles_at (Time t) const
        return s;
 }
 
-std::string
-SubtitleContent::font_id_to_name (string id) const
-{
-       list<shared_ptr<dcp::LoadFont> >::const_iterator i = _load_font_nodes.begin();
-       while (i != _load_font_nodes.end() && (*i)->id != id) {
-               ++i;
-       }
-
-       if (i == _load_font_nodes.end ()) {
-               return "";
-       }
-
-       if ((*i)->uri && (*i)->uri.get() == "arial.ttf") {
-               return "Arial";
-       }
-
-       return "";
-}
-
 void
-SubtitleContent::add (shared_ptr<SubtitleString> s)
+SubtitleContent::add (SubtitleString s)
 {
        _subtitles.push_back (s);
-       _need_sort = true;
 }
 
-struct SubtitleSorter {
-       bool operator() (shared_ptr<SubtitleString> a, shared_ptr<SubtitleString> b) {
-               if (a->in() != b->in()) {
-                       return a->in() < b->in();
-               }
-               return a->v_position() < b->v_position();
-       }
-};
-
 void
-SubtitleContent::write_xml () const
+SubtitleContent::write_xml (boost::filesystem::path p) const
 {
-       FILE* f = fopen_boost (file (), "r");
+       FILE* f = fopen_boost (p, "w");
+       if (!f) {
+               throw FileError ("Could not open file for writing", p, -1);
+       }
+       
        Glib::ustring const s = xml_as_string ();
-       fwrite (s.c_str(), 1, s.length(), f);
+       fwrite (s.c_str(), 1, s.bytes(), f);
        fclose (f);
+
+       _file = p;
 }
 
-Glib::ustring
-SubtitleContent::xml_as_string () const
+Time
+SubtitleContent::latest_subtitle_out () const
 {
-       xmlpp::Document doc;
-       xmlpp::Element* root = doc.create_root_node ("DCSubtitle");
-       root->set_attribute ("Version", "1.0");
-
-       root->add_child("SubtitleID")->add_child_text (_id);
-       if (_movie_title) {
-               root->add_child("MovieTitle")->add_child_text (_movie_title.get ());
+       Time t;
+       for (list<SubtitleString>::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
+               if (i->out() > t) {
+                       t = i->out ();
+               }
        }
-       root->add_child("ReelNumber")->add_child_text (raw_convert<string> (_reel_number));
-       root->add_child("Language")->add_child_text (_language);
 
-       if (_load_font_nodes.size() > 1) {
-               boost::throw_exception (MiscError ("multiple LoadFont nodes not supported"));
-       }
+       return t;
+}
 
-       if (!_load_font_nodes.empty ()) {
-               xmlpp::Element* load_font = root->add_child("LoadFont");
-               load_font->set_attribute ("Id", _load_font_nodes.front()->id);
-               if (_load_font_nodes.front()->uri) {
-                       load_font->set_attribute ("URI", _load_font_nodes.front()->uri.get ());
-               }
+bool
+SubtitleContent::equals (shared_ptr<const Asset> other_asset, EqualityOptions options, NoteHandler note) const
+{
+       if (!Asset::equals (other_asset, options, note)) {
+               return false;
        }
-
-       list<shared_ptr<SubtitleString> > sorted = _subtitles;
-       if (_need_sort) {
-               sorted.sort (SubtitleSorter ());
+       
+       shared_ptr<const SubtitleContent> other = dynamic_pointer_cast<const SubtitleContent> (other_asset);
+       if (!other) {
+               return false;
        }
 
-       /* XXX: multiple fonts not supported */
-       /* XXX: script, underlined, weight not supported */
-
-       bool italic = false;
-       Color color;
-       int size = 0;
-       Effect effect = NONE;
-       Color effect_color;
-       int spot_number = 1;
-       Time last_in;
-       Time last_out;
-       Time last_fade_up_time;
-       Time last_fade_down_time;
-
-       xmlpp::Element* font = 0;
-       xmlpp::Element* subtitle = 0;
-
-       for (list<shared_ptr<SubtitleString> >::iterator i = sorted.begin(); i != sorted.end(); ++i) {
-
-               /* We will start a new <Font>...</Font> whenever some font property changes.
-                  I suppose we should really make an optimal hierarchy of <Font> tags, but
-                  that seems hard.
-               */
-
-               bool const font_changed =
-                       italic       != (*i)->italic()       ||
-                       color        != (*i)->color()        ||
-                       size         != (*i)->size()         ||
-                       effect       != (*i)->effect()       ||
-                       effect_color != (*i)->effect_color();
-
-               if (font_changed) {
-                       italic = (*i)->italic ();
-                       color = (*i)->color ();
-                       size = (*i)->size ();
-                       effect = (*i)->effect ();
-                       effect_color = (*i)->effect_color ();
-               }
-
-               if (!font || font_changed) {
-                       font = root->add_child ("Font");
-                       string id = "theFontId";
-                       if (!_load_font_nodes.empty()) {
-                               id = _load_font_nodes.front()->id;
-                       }
-                       font->set_attribute ("Id", id);
-                       font->set_attribute ("Italic", italic ? "yes" : "no");
-                       font->set_attribute ("Color", color.to_argb_string());
-                       font->set_attribute ("Size", raw_convert<string> (size));
-                       font->set_attribute ("Effect", effect_to_string (effect));
-                       font->set_attribute ("EffectColor", effect_color.to_argb_string());
-                       font->set_attribute ("Script", "normal");
-                       font->set_attribute ("Underlined", "no");
-                       font->set_attribute ("Weight", "normal");
-               }
+       if (_reel_number != other->_reel_number) {
+               note (DCP_ERROR, "subtitle reel numbers differ");
+               return false;
+       }
 
-               if (!subtitle || font_changed ||
-                   (last_in != (*i)->in() ||
-                    last_out != (*i)->out() ||
-                    last_fade_up_time != (*i)->fade_up_time() ||
-                    last_fade_down_time != (*i)->fade_down_time()
-                           )) {
-
-                       subtitle = font->add_child ("Subtitle");
-                       subtitle->set_attribute ("SpotNumber", raw_convert<string> (spot_number++));
-                       subtitle->set_attribute ("TimeIn", (*i)->in().to_string());
-                       subtitle->set_attribute ("TimeOut", (*i)->out().to_string());
-                       subtitle->set_attribute ("FadeUpTime", raw_convert<string> ((*i)->fade_up_time().to_ticks()));
-                       subtitle->set_attribute ("FadeDownTime", raw_convert<string> ((*i)->fade_down_time().to_ticks()));
-
-                       last_in = (*i)->in ();
-                       last_out = (*i)->out ();
-                       last_fade_up_time = (*i)->fade_up_time ();
-                       last_fade_down_time = (*i)->fade_down_time ();
-               }
+       if (_language != other->_language) {
+               note (DCP_ERROR, "subtitle languages differ");
+               return false;
+       }
 
-               xmlpp::Element* text = subtitle->add_child ("Text");
-               text->set_attribute ("VAlign", valign_to_string ((*i)->v_align()));             
-               text->set_attribute ("VPosition", raw_convert<string> ((*i)->v_position()));
-               text->add_child_text ((*i)->text());
+       if (_subtitles != other->_subtitles) {
+               note (DCP_ERROR, "subtitles differ");
+               return false;
        }
 
-       return doc.write_to_string_formatted ("UTF-8");
+       return true;
 }
-