Add some more tests.
[libsub.git] / src / ssa_reader.cc
index 72ba13186ee8c6545f518a39a2ed712267c0b1c9..863225112d2fab532e2271d939f82a15b908a8cf 100644 (file)
@@ -24,8 +24,7 @@
 #include "subtitle.h"
 #include "compose.hpp"
 #include <boost/algorithm/string.hpp>
-#include <boost/bind.hpp>
-#include <boost/foreach.hpp>
+#include <boost/bind/bind.hpp>
 #include <iostream>
 #include <vector>
 
@@ -33,10 +32,12 @@ using std::string;
 using std::vector;
 using std::map;
 using std::cout;
-using std::list;
 using boost::optional;
 using boost::function;
 using namespace boost::algorithm;
+#if BOOST_VERSION >= 106100
+using namespace boost::placeholders;
+#endif
 using namespace sub;
 
 /** @param s Subtitle string encoded in UTF-8 */
@@ -124,28 +125,19 @@ public:
                                        effect = SHADOW;
                                }
                        } else if (keys[i] == "Alignment") {
-                               /* These values from libass' source code */
-                               switch ((raw_convert<int> (style[i]) - 1) % 3) {
-                               case 0:
-                                       horizontal_reference = LEFT_OF_SCREEN;
-                                       break;
-                               case 1:
-                                       horizontal_reference = HORIZONTAL_CENTRE_OF_SCREEN;
-                                       break;
-                               case 2:
-                                       horizontal_reference = RIGHT_OF_SCREEN;
-                                       break;
-                               }
-                               switch (raw_convert<int> (style[i]) & 12) {
-                               case 4:
+                               if (style[i] == "7" || style[i] == "8" || style[i] == "9") {
                                        vertical_reference = TOP_OF_SCREEN;
-                                       break;
-                               case 8:
+                               } else if (style[i] == "4" || style[i] == "5" || style[i] == "6") {
                                        vertical_reference = VERTICAL_CENTRE_OF_SCREEN;
-                                       break;
-                               case 0:
+                               } else {
                                        vertical_reference = BOTTOM_OF_SCREEN;
-                                       break;
+                               }
+                               if (style[i] == "1" || style[i] == "4" || style[i] == "7") {
+                                       horizontal_reference = LEFT_OF_SCREEN;
+                               } else if (style[i] == "3" || style[i] == "6" || style[i] == "9") {
+                                       horizontal_reference = RIGHT_OF_SCREEN;
+                               } else {
+                                       horizontal_reference = HORIZONTAL_CENTRE_OF_SCREEN;
                                }
                        } else if (keys[i] == "MarginV") {
                                vertical_margin = raw_convert<int> (style[i]);
@@ -155,7 +147,7 @@ public:
 
        string name;
        optional<string> font_name;
-       int font_size;
+       int font_size; ///< points
        Colour primary_colour;
        /** outline colour */
        optional<Colour> back_colour;
@@ -199,11 +191,73 @@ SSAReader::parse_time (string t) const
                );
 }
 
+void
+SSAReader::parse_style (RawSubtitle& sub, string style, int play_res_x, int play_res_y)
+{
+       if (style == "\\i1") {
+               sub.italic = true;
+       } else if (style == "\\i0" || style == "\\i") {
+               sub.italic = false;
+       } else if (style == "\\b1") {
+               sub.bold = true;
+       } else if (style == "\\b0") {
+               sub.bold = false;
+       } else if (style == "\\u1") {
+               sub.underline = true;
+       } else if (style == "\\u0") {
+               sub.underline = false;
+       } else if (style == "\\an1") {
+               sub.horizontal_position.reference = sub::LEFT_OF_SCREEN;
+               sub.vertical_position.reference = sub::BOTTOM_OF_SCREEN;
+       } else if (style == "\\an2") {
+               sub.horizontal_position.reference = sub::HORIZONTAL_CENTRE_OF_SCREEN;
+               sub.vertical_position.reference = sub::BOTTOM_OF_SCREEN;
+       } else if (style == "\\an3") {
+               sub.horizontal_position.reference = sub::RIGHT_OF_SCREEN;
+               sub.vertical_position.reference = sub::BOTTOM_OF_SCREEN;
+       } else if (style == "\\an4") {
+               sub.horizontal_position.reference = sub::LEFT_OF_SCREEN;
+               sub.vertical_position.reference = sub::VERTICAL_CENTRE_OF_SCREEN;
+       } else if (style == "\\an5") {
+               sub.horizontal_position.reference = sub::HORIZONTAL_CENTRE_OF_SCREEN;
+               sub.vertical_position.reference = sub::VERTICAL_CENTRE_OF_SCREEN;
+       } else if (style == "\\an6") {
+               sub.horizontal_position.reference = sub::RIGHT_OF_SCREEN;
+               sub.vertical_position.reference = sub::VERTICAL_CENTRE_OF_SCREEN;
+       } else if (style == "\\an7") {
+               sub.horizontal_position.reference = sub::LEFT_OF_SCREEN;
+               sub.vertical_position.reference = sub::TOP_OF_SCREEN;
+       } else if (style == "\\an8") {
+               sub.horizontal_position.reference = sub::HORIZONTAL_CENTRE_OF_SCREEN;
+               sub.vertical_position.reference = sub::TOP_OF_SCREEN;
+       } else if (style == "\\an9") {
+               sub.horizontal_position.reference = sub::RIGHT_OF_SCREEN;
+               sub.vertical_position.reference = sub::TOP_OF_SCREEN;
+       } else if (boost::starts_with(style, "\\pos")) {
+               vector<string> bits;
+               boost::algorithm::split (bits, style, boost::is_any_of("(,"));
+               SUB_ASSERT (bits.size() == 3);
+               sub.horizontal_position.reference = sub::LEFT_OF_SCREEN;
+               sub.horizontal_position.proportional = raw_convert<float>(bits[1]) / play_res_x;
+               sub.vertical_position.reference = sub::TOP_OF_SCREEN;
+               sub.vertical_position.proportional = raw_convert<float>(bits[2]) / play_res_y;
+       } else if (boost::starts_with(style, "\\fs")) {
+               SUB_ASSERT (style.length() > 3);
+               sub.font_size.set_proportional(raw_convert<float>(style.substr(3)) / play_res_y);
+       } else if (boost::starts_with(style, "\\c")) {
+               /* \c&Hbbggrr& */
+               if (style.length() <= 2) {
+                       throw SSAError(String::compose("Badly formatted colour tag %1", style));
+               }
+               sub.colour = h_colour (style.substr(2, style.length() - 3));
+       }
+}
+
 /** @param base RawSubtitle filled in with any required common values.
  *  @param line SSA line string (i.e. just the subtitle, possibly with embedded stuff)
  *  @return List of RawSubtitles to represent line with vertical reference TOP_OF_SUBTITLE.
  */
-list<RawSubtitle>
+vector<RawSubtitle>
 SSAReader::parse_line (RawSubtitle base, string line, int play_res_x, int play_res_y)
 {
        enum {
@@ -212,7 +266,7 @@ SSAReader::parse_line (RawSubtitle base, string line, int play_res_x, int play_r
                BACKSLASH
        } state = TEXT;
 
-       list<RawSubtitle> subs;
+       vector<RawSubtitle> subs;
        RawSubtitle current = base;
        string style;
 
@@ -220,16 +274,19 @@ SSAReader::parse_line (RawSubtitle base, string line, int play_res_x, int play_r
                current.vertical_position.reference = BOTTOM_OF_SCREEN;
        }
 
-       if (!current.vertical_position.proportional) {
-               current.vertical_position.proportional = 0;
-       }
+       /* Any vertical_position that is set in base (and therefore current) is a margin, which
+        * we need to ignore if we end up vertically centering this subtitle.
+        * Clear out vertical_position from current; we'll re-add it from base later
+        * if required.
+        */
+       current.vertical_position.proportional = 0;
 
        /* We must have a font size, as there could be a margin specified
           in pixels and in that case we must know how big the subtitle
           lines are to work out the position on screen.
        */
-       if (!current.font_size.points()) {
-               current.font_size.set_points (72);
+       if (!current.font_size.proportional()) {
+               current.font_size.set_proportional(72.0 / play_res_y);
        }
 
        /* Count the number of line breaks */
@@ -242,22 +299,8 @@ SSAReader::parse_line (RawSubtitle base, string line, int play_res_x, int play_r
                }
        }
 
-       /* Imagine that the screen is 792 points (i.e. 11 inches) high (as with DCP) */
-       double const line_size = current.font_size.proportional(792) * 1.2;
-
-       /* Tweak vertical_position accordingly */
-       switch (current.vertical_position.reference.get()) {
-       case TOP_OF_SCREEN:
-       case TOP_OF_SUBTITLE:
-               /* Nothing to do */
-               break;
-       case VERTICAL_CENTRE_OF_SCREEN:
-               current.vertical_position.proportional = current.vertical_position.proportional.get() - ((line_breaks + 1) * line_size) / 2;
-               break;
-       case BOTTOM_OF_SCREEN:
-               current.vertical_position.proportional = current.vertical_position.proportional.get() + line_breaks * line_size;
-               break;
-       }
+       /* There are vague indications that with ASS 1 point should equal 1 pixel */
+       double const line_size = current.font_size.proportional(play_res_y) * 1.2;
 
        for (size_t i = 0; i < line.length(); ++i) {
                char const c = line[i];
@@ -277,42 +320,7 @@ SSAReader::parse_line (RawSubtitle base, string line, int play_res_x, int play_r
                                        subs.push_back (current);
                                        current.text = "";
                                }
-                               if (style == "\\i1") {
-                                       current.italic = true;
-                               } else if (style == "\\i0" || style == "\\i") {
-                                       current.italic = false;
-                               } else if (style == "\\b1") {
-                                       current.bold = true;
-                               } else if (style == "\\b0") {
-                                       current.bold = false;
-                               } else if (style == "\\u1") {
-                                       current.underline = true;
-                               } else if (style == "\\u0") {
-                                       current.underline = false;
-                               } else if (style == "\\an1" || style == "\\an2" || style == "\\an3") {
-                                       current.vertical_position.reference = sub::BOTTOM_OF_SCREEN;
-                               } else if (style == "\\an4" || style == "\\an5" || style == "\\an6") {
-                                       current.vertical_position.reference = sub::VERTICAL_CENTRE_OF_SCREEN;
-                               } else if (style == "\\an7" || style == "\\an8" || style == "\\an9") {
-                                       current.vertical_position.reference = sub::TOP_OF_SCREEN;
-                               } else if (boost::starts_with(style, "\\pos")) {
-                                       vector<string> bits;
-                                       boost::algorithm::split (bits, style, boost::is_any_of("(,"));
-                                       SUB_ASSERT (bits.size() == 3);
-                                       current.horizontal_position.reference = sub::LEFT_OF_SCREEN;
-                                       current.horizontal_position.proportional = raw_convert<float>(bits[1]) / play_res_x;
-                                       current.vertical_position.reference = sub::TOP_OF_SCREEN;
-                                       current.vertical_position.proportional = raw_convert<float>(bits[2]) / play_res_y;
-                               } else if (boost::starts_with(style, "\\fs")) {
-                                       SUB_ASSERT (style.length() > 3);
-                                       current.font_size.set_points (raw_convert<int>(style.substr(3)));
-                               } else if (boost::starts_with(style, "\\c")) {
-                                       /* \c&Hbbggrr& */
-                                       if (style.length() <= 2) {
-                                               throw SSAError(String::compose("Badly formatted colour tag %1", style));
-                                       }
-                                       current.colour = h_colour (style.substr(2, style.length() - 3));
-                               }
+                               parse_style (current, style, play_res_x, play_res_y);
                                style = "";
                        }
 
@@ -344,6 +352,28 @@ SSAReader::parse_line (RawSubtitle base, string line, int play_res_x, int play_r
                subs.push_back (current);
        }
 
+       /* Now we definitely know the vertical position reference we can finish off the position */
+       for (auto& sub: subs) {
+               switch (sub.vertical_position.reference.get()) {
+               case TOP_OF_SCREEN:
+               case TOP_OF_SUBTITLE:
+                       /* Just re-add any margins we came in with */
+                       sub.vertical_position.proportional = sub.vertical_position.proportional.get() + base.vertical_position.proportional.get_value_or(0);
+                       break;
+               case VERTICAL_CENTRE_OF_SCREEN:
+                       /* Margins are ignored, but we need to centre */
+                       sub.vertical_position.proportional = sub.vertical_position.proportional.get() - ((line_breaks + 1) * line_size) / 2;
+                       break;
+               case BOTTOM_OF_SCREEN:
+                       /* Re-add margins and account for each line */
+                       sub.vertical_position.proportional =
+                               sub.vertical_position.proportional.get()
+                               + base.vertical_position.proportional.get_value_or(0)
+                               + line_breaks * line_size;
+                       break;
+               }
+       }
+
        return subs;
 }
 
@@ -413,7 +443,7 @@ SSAReader::read (function<optional<string> ()> get_line)
                case EVENTS:
                        if (type == "Format") {
                                split (event_format, body, is_any_of (","));
-                               BOOST_FOREACH (string& i, event_format) {
+                               for (auto& i: event_format) {
                                        trim (i);
                                }
                        } else if (type == "Dialogue") {
@@ -449,7 +479,7 @@ SSAReader::read (function<optional<string> ()> get_line)
                                                SUB_ASSERT (styles.find(event[i]) != styles.end());
                                                Style style = styles[event[i]];
                                                sub.font = style.font_name;
-                                               sub.font_size = FontSize::from_points (style.font_size);
+                                               sub.font_size = FontSize::from_proportional(static_cast<float>(style.font_size) / play_res_y);
                                                sub.colour = style.primary_colour;
                                                sub.effect_colour = style.back_colour;
                                                sub.bold = style.bold;
@@ -458,11 +488,16 @@ SSAReader::read (function<optional<string> ()> get_line)
                                                sub.effect = style.effect;
                                                sub.horizontal_position.reference = style.horizontal_reference;
                                                sub.vertical_position.reference = style.vertical_reference;
-                                               sub.vertical_position.proportional = float(style.vertical_margin) / play_res_y;
+                                               if (sub.vertical_position.reference != sub::VERTICAL_CENTRE_OF_SCREEN) {
+                                                       sub.vertical_position.proportional = float(style.vertical_margin) / play_res_y;
+                                               }
                                        } else if (event_format[i] == "MarginV") {
-                                               sub.vertical_position.proportional = raw_convert<float>(event[i]) / play_res_y;
+                                               if (event[i] != "0" && sub.vertical_position.reference != sub::VERTICAL_CENTRE_OF_SCREEN) {
+                                                       /* Override the style if its non-zero */
+                                                       sub.vertical_position.proportional = raw_convert<float>(event[i]) / play_res_y;
+                                               }
                                        } else if (event_format[i] == "Text") {
-                                               BOOST_FOREACH (sub::RawSubtitle j, parse_line (sub, event[i], play_res_x, play_res_y)) {
+                                               for (auto j: parse_line (sub, event[i], play_res_x, play_res_y)) {
                                                        _subs.push_back (j);
                                                }
                                        }