Use a HMAC context to write HMAC stuff to encrypted MXFs.
[libdcp.git] / src / subtitle_asset.cc
index 1c341de49d309369d0ac89a85e6d2c27dfcccd12..5074c35b9c4d08c3eec5ebf6391adc940ebc4918 100644 (file)
@@ -29,6 +29,8 @@
 #include "KM_util.h"
 #include <libxml++/nodes/element.h>
 #include <boost/algorithm/string.hpp>
+#include <boost/shared_array.hpp>
+#include <boost/foreach.hpp>
 #include <fstream>
 
 using std::string;
@@ -37,7 +39,10 @@ using std::ostream;
 using std::ofstream;
 using std::stringstream;
 using std::cout;
+using std::cerr;
+using std::map;
 using boost::shared_ptr;
+using boost::shared_array;
 using boost::optional;
 using boost::dynamic_pointer_cast;
 using namespace dcp;
@@ -54,50 +59,64 @@ SubtitleAsset::SubtitleAsset (boost::filesystem::path file)
 }
 
 void
-SubtitleAsset::parse_common (shared_ptr<cxml::Document> xml, list<shared_ptr<dcp::FontNode> > font_nodes)
+SubtitleAsset::parse_subtitles (
+       shared_ptr<cxml::Document> xml,
+       list<shared_ptr<dcp::FontNode> > font_nodes,
+       list<shared_ptr<dcp::SubtitleNode> > subtitle_nodes
+       )
 {
        /* Make Subtitle objects to represent the raw XML nodes in a sane way */
        ParseState parse_state;
-       examine_font_nodes (xml, font_nodes, parse_state);
+       examine_nodes (xml, font_nodes, parse_state);
+       examine_nodes (xml, subtitle_nodes, parse_state);
+}
+
+void
+SubtitleAsset::examine_nodes (
+       shared_ptr<const cxml::Node> xml,
+       list<shared_ptr<dcp::SubtitleNode> > const & subtitle_nodes,
+       ParseState& parse_state
+       )
+{
+       BOOST_FOREACH (shared_ptr<dcp::SubtitleNode> i, subtitle_nodes) {
+               parse_state.subtitle_nodes.push_back (i);
+               examine_nodes (xml, i->text_nodes, parse_state);
+               examine_nodes (xml, i->font_nodes, parse_state);
+               parse_state.subtitle_nodes.pop_back ();
+       }
 }
 
 void
-SubtitleAsset::examine_font_nodes (
+SubtitleAsset::examine_nodes (
        shared_ptr<const cxml::Node> xml,
        list<shared_ptr<dcp::FontNode> > const & font_nodes,
        ParseState& parse_state
        )
 {
-       for (list<shared_ptr<dcp::FontNode> >::const_iterator i = font_nodes.begin(); i != font_nodes.end(); ++i) {
+       BOOST_FOREACH (shared_ptr<dcp::FontNode> i, font_nodes) {
 
-               parse_state.font_nodes.push_back (*i);
-               maybe_add_subtitle ((*i)->text, parse_state);
+               parse_state.font_nodes.push_back (i);
+               maybe_add_subtitle (i->text, parse_state);
+
+               examine_nodes (xml, i->subtitle_nodes, parse_state);
+               examine_nodes (xml, i->font_nodes, parse_state);
+               examine_nodes (xml, i->text_nodes, parse_state);
 
-               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);
-                       parse_state.subtitle_nodes.pop_back ();
-               }
-       
-               examine_font_nodes (xml, (*i)->font_nodes, parse_state);
-               examine_text_nodes (xml, (*i)->text_nodes, parse_state);
-               
                parse_state.font_nodes.pop_back ();
        }
 }
 
 void
-SubtitleAsset::examine_text_nodes (
+SubtitleAsset::examine_nodes (
        shared_ptr<const cxml::Node> xml,
        list<shared_ptr<dcp::TextNode> > const & text_nodes,
        ParseState& parse_state
        )
 {
-       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);
+       BOOST_FOREACH (shared_ptr<dcp::TextNode> i, text_nodes) {
+               parse_state.text_nodes.push_back (i);
+               maybe_add_subtitle (i->text, parse_state);
+               examine_nodes (xml, i->font_nodes, parse_state);
                parse_state.text_nodes.pop_back ();
        }
 }
@@ -108,14 +127,14 @@ SubtitleAsset::maybe_add_subtitle (string text, ParseState const & parse_state)
        if (empty_or_white_space (text)) {
                return;
        }
-       
+
        if (parse_state.text_nodes.empty() || parse_state.subtitle_nodes.empty ()) {
                return;
        }
 
        DCP_ASSERT (!parse_state.text_nodes.empty ());
        DCP_ASSERT (!parse_state.subtitle_nodes.empty ());
-       
+
        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 ());
@@ -143,12 +162,12 @@ SubtitleAsset::maybe_add_subtitle (string text, ParseState const & parse_state)
 }
 
 list<SubtitleString>
-SubtitleAsset::subtitles_during (Time from, Time to) const
+SubtitleAsset::subtitles_during (Time from, Time to, bool starting) const
 {
        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);
+       BOOST_FOREACH (SubtitleString const & i, _subtitles) {
+               if ((starting && from <= i.in() && i.in() < to) || (!starting && i.out() >= from && i.in() <= to)) {
+                       s.push_back (i);
                }
        }
 
@@ -165,9 +184,9 @@ Time
 SubtitleAsset::latest_subtitle_out () const
 {
        Time t;
-       for (list<SubtitleString>::const_iterator i = _subtitles.begin(); i != _subtitles.end(); ++i) {
-               if (i->out() > t) {
-                       t = i->out ();
+       BOOST_FOREACH (SubtitleString const & i, _subtitles) {
+               if (i.out() > t) {
+                       t = i.out ();
                }
        }
 
@@ -180,7 +199,7 @@ SubtitleAsset::equals (shared_ptr<const Asset> other_asset, EqualityOptions opti
        if (!Asset::equals (other_asset, options, note)) {
                return false;
        }
-       
+
        shared_ptr<const SubtitleAsset> other = dynamic_pointer_cast<const SubtitleAsset> (other_asset);
        if (!other) {
                return false;
@@ -203,12 +222,17 @@ struct SubtitleSorter {
        }
 };
 
+/** @param standard Standard (INTEROP or SMPTE); this is used rather than putting things in the child
+ *  class because the differences between the two are fairly subtle.
+ */
 void
-SubtitleAsset::subtitles_as_xml (xmlpp::Element* root, int time_code_rate, string xmlns) const
+SubtitleAsset::subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const
 {
        list<SubtitleString> sorted = _subtitles;
        sorted.sort (SubtitleSorter ());
 
+       string const xmlns = standard == SMPTE ? "dcst" : "";
+
        /* XXX: script, underlined, weight not supported */
 
        optional<string> font;
@@ -227,7 +251,7 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* root, int time_code_rate, strin
        xmlpp::Element* font_element = 0;
        xmlpp::Element* subtitle_element = 0;
 
-       for (list<SubtitleString>::iterator i = sorted.begin(); i != sorted.end(); ++i) {
+       BOOST_FOREACH (SubtitleString const & i, sorted) {
 
                /* 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
@@ -235,28 +259,32 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* root, int time_code_rate, strin
                */
 
                bool const font_changed =
-                       font          != i->font()          ||
-                       italic        != i->italic()        ||
-                       colour        != i->colour()        ||
-                       size          != i->size()          ||
-                       fabs (aspect_adjust - i->aspect_adjust()) > ASPECT_ADJUST_EPSILON ||
-                       effect        != i->effect()        ||
-                       effect_colour != i->effect_colour();
+                       font          != i.font()          ||
+                       italic        != i.italic()        ||
+                       colour        != i.colour()        ||
+                       size          != i.size()          ||
+                       fabs (aspect_adjust - i.aspect_adjust()) > ASPECT_ADJUST_EPSILON ||
+                       effect        != i.effect()        ||
+                       effect_colour != i.effect_colour();
 
                if (font_changed) {
-                       font = i->font ();
-                       italic = i->italic ();
-                       colour = i->colour ();
-                       size = i->size ();
-                       aspect_adjust = i->aspect_adjust ();
-                       effect = i->effect ();
-                       effect_colour = i->effect_colour ();
+                       font = i.font ();
+                       italic = i.italic ();
+                       colour = i.colour ();
+                       size = i.size ();
+                       aspect_adjust = i.aspect_adjust ();
+                       effect = i.effect ();
+                       effect_colour = i.effect_colour ();
                }
 
                if (!font_element || font_changed) {
                        font_element = root->add_child ("Font", xmlns);
                        if (font) {
-                               font_element->set_attribute ("Id", font.get ());
+                               if (standard == SMPTE) {
+                                       font_element->set_attribute ("ID", font.get ());
+                               } else {
+                                       font_element->set_attribute ("Id", font.get ());
+                               }
                        }
                        font_element->set_attribute ("Italic", italic ? "yes" : "no");
                        font_element->set_attribute ("Color", colour.to_argb_string());
@@ -267,41 +295,82 @@ SubtitleAsset::subtitles_as_xml (xmlpp::Element* root, int time_code_rate, strin
                        font_element->set_attribute ("Effect", effect_to_string (effect));
                        font_element->set_attribute ("EffectColor", effect_colour.to_argb_string());
                        font_element->set_attribute ("Script", "normal");
-                       font_element->set_attribute ("Underlined", "no");
+                       if (standard == SMPTE) {
+                               font_element->set_attribute ("Underline", "no");
+                       } else {
+                               font_element->set_attribute ("Underlined", "no");
+                       }
                        font_element->set_attribute ("Weight", "normal");
                }
 
                if (!subtitle_element || 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()
+                   (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_element = font_element->add_child ("Subtitle", xmlns);
                        subtitle_element->set_attribute ("SpotNumber", raw_convert<string> (spot_number++));
-                       subtitle_element->set_attribute ("TimeIn", i->in().rebase(time_code_rate).as_string());
-                       subtitle_element->set_attribute ("TimeOut", i->out().rebase(time_code_rate).as_string());
-                       subtitle_element->set_attribute ("FadeUpTime", raw_convert<string> (i->fade_up_time().as_editable_units(time_code_rate)));
-                       subtitle_element->set_attribute ("FadeDownTime", raw_convert<string> (i->fade_down_time().as_editable_units(time_code_rate)));
-
-                       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_element->set_attribute ("TimeIn", i.in().rebase(time_code_rate).as_string(standard));
+                       subtitle_element->set_attribute ("TimeOut", i.out().rebase(time_code_rate).as_string(standard));
+                       if (standard == SMPTE) {
+                               subtitle_element->set_attribute ("FadeUpTime", i.fade_up_time().rebase(time_code_rate).as_string(standard));
+                               subtitle_element->set_attribute ("FadeDownTime", i.fade_down_time().rebase(time_code_rate).as_string(standard));
+                       } else {
+                               subtitle_element->set_attribute ("FadeUpTime", raw_convert<string> (i.fade_up_time().as_editable_units(time_code_rate)));
+                               subtitle_element->set_attribute ("FadeDownTime", raw_convert<string> (i.fade_down_time().as_editable_units(time_code_rate)));
+                       }
+
+                       last_in = i.in ();
+                       last_out = i.out ();
+                       last_fade_up_time = i.fade_up_time ();
+                       last_fade_down_time = i.fade_down_time ();
                }
 
                xmlpp::Element* text = subtitle_element->add_child ("Text", xmlns);
-               if (i->h_align() != HALIGN_CENTER) {
-                       text->set_attribute ("HAlign", halign_to_string (i->h_align ()));
+               if (i.h_align() != HALIGN_CENTER) {
+                       if (standard == SMPTE) {
+                               text->set_attribute ("Halign", halign_to_string (i.h_align ()));
+                       } else {
+                               text->set_attribute ("HAlign", halign_to_string (i.h_align ()));
+                       }
+               }
+               if (i.h_position() > ALIGN_EPSILON) {
+                       if (standard == SMPTE) {
+                               text->set_attribute ("Hposition", raw_convert<string> (i.h_position() * 100, 6));
+                       } else {
+                               text->set_attribute ("HPosition", raw_convert<string> (i.h_position() * 100, 6));
+                       }
                }
-               if (i->h_position() > ALIGN_EPSILON) {
-                       text->set_attribute ("HPosition", raw_convert<string> (i->h_position() * 100, 6));
+               if (standard == SMPTE) {
+                       text->set_attribute ("Valign", valign_to_string (i.v_align()));
+               } else {
+                       text->set_attribute ("VAlign", valign_to_string (i.v_align()));
                }
-               text->set_attribute ("VAlign", valign_to_string (i->v_align()));                
-               text->set_attribute ("VPosition", raw_convert<string> (i->v_position() * 100, 6));
-               text->add_child_text (i->text());
+               if (i.v_position() > ALIGN_EPSILON) {
+                       if (standard == SMPTE) {
+                               text->set_attribute ("Vposition", raw_convert<string> (i.v_position() * 100, 6));
+                       } else {
+                               text->set_attribute ("VPosition", raw_convert<string> (i.v_position() * 100, 6));
+                       }
+               } else {
+                       if (standard == SMPTE) {
+                               text->set_attribute ("Vposition", "0");
+                       } else {
+                               text->set_attribute ("VPosition", "0");
+                       }
+               }
+               text->add_child_text (i.text());
        }
 }
 
-       
+map<string, Data>
+SubtitleAsset::fonts_with_load_ids () const
+{
+       map<string, Data> out;
+       BOOST_FOREACH (Font const & i, _fonts) {
+               out[i.load_id] = i.data;
+       }
+       return out;
+}