2 Copyright (C) 2016-2019 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include "ssa_reader.h"
22 #include "sub_assert.h"
23 #include "raw_convert.h"
25 #include "compose.hpp"
26 #include <boost/algorithm/string.hpp>
27 #include <boost/bind/bind.hpp>
36 using boost::optional;
37 using boost::function;
38 using namespace boost::algorithm;
39 #if BOOST_VERSION >= 106100
40 using namespace boost::placeholders;
44 /** @param s Subtitle string encoded in UTF-8 */
45 SSAReader::SSAReader (string s)
47 this->read (boost::bind(&get_line_string, &s));
50 /** @param f Subtitle file encoded in UTF-8 */
51 SSAReader::SSAReader (FILE* f)
53 this->read (boost::bind (&get_line_file, f));
59 if (s.empty() || s[0] != '&' || s[1] != 'H') {
60 throw SSAError(String::compose("Badly formatted colour tag %1", s));
63 auto start = s.c_str();
64 auto const end = start + s.length();
65 while (start < end && (*start == '&' || *start == 'H')) {
69 auto const colour = strtoll(start, nullptr, 16);
71 /* XXX: ignoring alpha channel here; note that 00 is opaque and FF is transparent */
73 ((colour & 0x000000ff) >> 0) / 255.0,
74 ((colour & 0x0000ff00) >> 8) / 255.0,
75 ((colour & 0x00ff0000) >> 16) / 255.0
84 , primary_colour (255, 255, 255)
88 , horizontal_reference (HORIZONTAL_CENTRE_OF_SCREEN)
89 , vertical_reference (BOTTOM_OF_SCREEN)
93 Style (string format_line, string style_line)
95 , primary_colour (255, 255, 255)
99 , horizontal_reference (HORIZONTAL_CENTRE_OF_SCREEN)
100 , vertical_reference (BOTTOM_OF_SCREEN)
101 , vertical_margin (0)
104 split (keys, format_line, boost::is_any_of (","));
105 vector<string> style;
106 split (style, style_line, boost::is_any_of (","));
108 SUB_ASSERT (!keys.empty());
109 SUB_ASSERT (!style.empty());
110 SUB_ASSERT (keys.size() == style.size());
112 for (size_t i = 0; i < style.size(); ++i) {
115 if (keys[i] == "Name") {
117 } else if (keys[i] == "Fontname") {
118 font_name = style[i];
119 } else if (keys[i] == "Fontsize") {
120 font_size = raw_convert<int> (style[i]);
121 } else if (keys[i] == "PrimaryColour") {
122 primary_colour = colour (style[i]);
123 } else if (keys[i] == "BackColour") {
124 back_colour = colour (style[i]);
125 } else if (keys[i] == "Bold") {
126 bold = style[i] == "-1";
127 } else if (keys[i] == "Italic") {
128 italic = style[i] == "-1";
129 } else if (keys[i] == "Underline") {
130 underline = style[i] == "-1";
131 } else if (keys[i] == "BorderStyle") {
132 if (style[i] == "1") {
135 } else if (keys[i] == "Alignment") {
136 if (style[i] == "7" || style[i] == "8" || style[i] == "9") {
137 vertical_reference = TOP_OF_SCREEN;
138 } else if (style[i] == "4" || style[i] == "5" || style[i] == "6") {
139 vertical_reference = VERTICAL_CENTRE_OF_SCREEN;
141 vertical_reference = BOTTOM_OF_SCREEN;
143 if (style[i] == "1" || style[i] == "4" || style[i] == "7") {
144 horizontal_reference = LEFT_OF_SCREEN;
145 } else if (style[i] == "3" || style[i] == "6" || style[i] == "9") {
146 horizontal_reference = RIGHT_OF_SCREEN;
148 horizontal_reference = HORIZONTAL_CENTRE_OF_SCREEN;
150 } else if (keys[i] == "MarginV") {
151 vertical_margin = raw_convert<int> (style[i]);
157 optional<string> font_name;
158 int font_size; ///< points
159 Colour primary_colour;
160 /** outline colour */
161 optional<Colour> back_colour;
165 optional<Effect> effect;
166 HorizontalReference horizontal_reference;
167 VerticalReference vertical_reference;
171 Colour colour (string c) const
173 if (c.length() > 0 && c[0] == '&') {
174 /* &Hbbggrr or &Haabbggrr */
178 int i = raw_convert<int>(c);
180 ((i & 0x0000ff) >> 0) / 255.0,
181 ((i & 0x00ff00) >> 8) / 255.0,
182 ((i & 0xff0000) >> 16) / 255.0
189 SSAReader::parse_time (string t) const
192 split (bits, t, is_any_of (":."));
193 SUB_ASSERT (bits.size() == 4);
194 return Time::from_hms (
195 raw_convert<int> (bits[0]),
196 raw_convert<int> (bits[1]),
197 raw_convert<int> (bits[2]),
198 raw_convert<int> (bits[3]) * 10
203 SSAReader::parse_style(RawSubtitle& sub, string style, int play_res_x, int play_res_y, Colour primary_colour)
205 if (style == "\\i1") {
207 } else if (style == "\\i0" || style == "\\i") {
209 } else if (style == "\\b1") {
211 } else if (style == "\\b0") {
213 } else if (style == "\\u1") {
214 sub.underline = true;
215 } else if (style == "\\u0") {
216 sub.underline = false;
217 } else if (style == "\\an1") {
218 sub.horizontal_position.reference = sub::LEFT_OF_SCREEN;
219 sub.vertical_position.reference = sub::BOTTOM_OF_SCREEN;
220 } else if (style == "\\an2") {
221 sub.horizontal_position.reference = sub::HORIZONTAL_CENTRE_OF_SCREEN;
222 sub.vertical_position.reference = sub::BOTTOM_OF_SCREEN;
223 } else if (style == "\\an3") {
224 sub.horizontal_position.reference = sub::RIGHT_OF_SCREEN;
225 sub.vertical_position.reference = sub::BOTTOM_OF_SCREEN;
226 } else if (style == "\\an4") {
227 sub.horizontal_position.reference = sub::LEFT_OF_SCREEN;
228 sub.vertical_position.reference = sub::VERTICAL_CENTRE_OF_SCREEN;
229 } else if (style == "\\an5") {
230 sub.horizontal_position.reference = sub::HORIZONTAL_CENTRE_OF_SCREEN;
231 sub.vertical_position.reference = sub::VERTICAL_CENTRE_OF_SCREEN;
232 } else if (style == "\\an6") {
233 sub.horizontal_position.reference = sub::RIGHT_OF_SCREEN;
234 sub.vertical_position.reference = sub::VERTICAL_CENTRE_OF_SCREEN;
235 } else if (style == "\\an7") {
236 sub.horizontal_position.reference = sub::LEFT_OF_SCREEN;
237 sub.vertical_position.reference = sub::TOP_OF_SCREEN;
238 } else if (style == "\\an8") {
239 sub.horizontal_position.reference = sub::HORIZONTAL_CENTRE_OF_SCREEN;
240 sub.vertical_position.reference = sub::TOP_OF_SCREEN;
241 } else if (style == "\\an9") {
242 sub.horizontal_position.reference = sub::RIGHT_OF_SCREEN;
243 sub.vertical_position.reference = sub::TOP_OF_SCREEN;
244 } else if (boost::starts_with(style, "\\pos")) {
246 boost::algorithm::split (bits, style, boost::is_any_of("(,"));
247 SUB_ASSERT (bits.size() == 3);
248 sub.horizontal_position.reference = sub::LEFT_OF_SCREEN;
249 sub.horizontal_position.proportional = raw_convert<float>(bits[1]) / play_res_x;
250 sub.vertical_position.reference = sub::TOP_OF_SCREEN;
251 sub.vertical_position.proportional = raw_convert<float>(bits[2]) / play_res_y;
252 } else if (boost::starts_with(style, "\\fs")) {
253 SUB_ASSERT (style.length() > 3);
254 sub.font_size.set_proportional(raw_convert<float>(style.substr(3)) / play_res_y);
255 } else if (boost::starts_with(style, "\\c")) {
257 if (style.length() > 2) {
258 sub.colour = h_colour(style.substr(2, style.length() - 3));
259 } else if (style.length() == 2) {
260 sub.colour = primary_colour;
262 throw SSAError(String::compose("Badly formatted colour tag %1", style));
267 /** @param base RawSubtitle filled in with any required common values.
268 * @param line SSA line string (i.e. just the subtitle, possibly with embedded stuff)
269 * @return List of RawSubtitles to represent line with vertical reference TOP_OF_SUBTITLE.
272 SSAReader::parse_line(RawSubtitle base, string line, int play_res_x, int play_res_y, Colour primary_colour)
280 vector<RawSubtitle> subs;
281 RawSubtitle current = base;
284 if (!current.vertical_position.reference) {
285 current.vertical_position.reference = BOTTOM_OF_SCREEN;
288 /* Any vertical_position that is set in base (and therefore current) is a margin, which
289 * we need to ignore if we end up vertically centering this subtitle.
290 * Clear out vertical_position from current; we'll re-add it from base later
293 current.vertical_position.proportional = 0;
295 /* We must have a font size, as there could be a margin specified
296 in pixels and in that case we must know how big the subtitle
297 lines are to work out the position on screen.
299 if (!current.font_size.proportional()) {
300 current.font_size.set_proportional(72.0 / play_res_y);
303 /* Count the number of line breaks */
305 if (line.length() > 0) {
306 for (size_t i = 0; i < line.length() - 1; ++i) {
307 if (line[i] == '\\' && (line[i+1] == 'n' || line[i+1] == 'N')) {
313 /* There are vague indications that with ASS 1 point should equal 1 pixel */
314 double const line_size = current.font_size.proportional(play_res_y) * 1.2;
316 for (size_t i = 0; i < line.length(); ++i) {
317 char const c = line[i];
322 } else if (c == '\\') {
324 } else if (c != '\r' && c != '\n') {
329 if (c == '}' || c == '\\') {
330 if (!current.text.empty ()) {
331 subs.push_back (current);
334 parse_style(current, style, play_res_x, play_res_y, primary_colour);
345 if (c == 'n' || c == 'N') {
346 if (!current.text.empty ()) {
347 subs.push_back (current);
350 /* Move down one line (1.2 times the font size) */
351 if (current.vertical_position.reference.get() == BOTTOM_OF_SCREEN) {
352 current.vertical_position.proportional = current.vertical_position.proportional.get() - line_size;
354 current.vertical_position.proportional = current.vertical_position.proportional.get() + line_size;
362 if (!current.text.empty ()) {
363 subs.push_back (current);
366 /* Now we definitely know the vertical position reference we can finish off the position */
367 for (auto& sub: subs) {
368 switch (sub.vertical_position.reference.get()) {
370 case TOP_OF_SUBTITLE:
371 /* Just re-add any margins we came in with */
372 sub.vertical_position.proportional = sub.vertical_position.proportional.get() + base.vertical_position.proportional.get_value_or(0);
374 case VERTICAL_CENTRE_OF_SCREEN:
375 /* Margins are ignored, but we need to centre */
376 sub.vertical_position.proportional = sub.vertical_position.proportional.get() - ((line_breaks + 1) * line_size) / 2;
378 case BOTTOM_OF_SCREEN:
379 /* Re-add margins and account for each line */
380 sub.vertical_position.proportional =
381 sub.vertical_position.proportional.get()
382 + base.vertical_position.proportional.get_value_or(0)
383 + line_breaks * line_size;
392 SSAReader::read (function<optional<string> ()> get_line)
400 int play_res_x = 288;
401 int play_res_y = 288;
402 map<string, Style> styles;
403 string style_format_line;
404 vector<string> event_format;
407 optional<string> line = get_line ();
413 remove_unicode_bom (line);
415 if (starts_with (*line, ";") || line->empty ()) {
419 if (starts_with (*line, "[")) {
420 /* Section heading */
421 if (line.get() == "[Script Info]") {
423 } else if (line.get() == "[V4 Styles]" || line.get() == "[V4+ Styles]") {
425 } else if (line.get() == "[Events]") {
431 size_t const colon = line->find (":");
432 SUB_ASSERT (colon != string::npos);
433 string const type = line->substr (0, colon);
434 string body = line->substr (colon + 1);
439 if (type == "PlayResX") {
440 play_res_x = raw_convert<int> (body);
441 } else if (type == "PlayResY") {
442 play_res_y = raw_convert<int> (body);
446 if (type == "Format") {
447 style_format_line = body;
448 } else if (type == "Style") {
449 SUB_ASSERT (!style_format_line.empty ());
450 Style s (style_format_line, body);
455 if (type == "Format") {
456 split (event_format, body, is_any_of (","));
457 for (auto& i: event_format) {
460 } else if (type == "Dialogue") {
461 SUB_ASSERT (!event_format.empty ());
462 vector<string> event;
463 split (event, body, is_any_of (","));
465 /* There may be commas in the subtitle part; reassemble any extra parts
466 from when we just split it.
468 while (event.size() > event_format.size()) {
469 string const ex = event.back ();
471 event.back() += "," + ex;
474 SUB_ASSERT (!event.empty());
475 SUB_ASSERT (event_format.size() == event.size());
478 optional<Style> style;
480 for (size_t i = 0; i < event.size(); ++i) {
482 if (event_format[i] == "Start") {
483 sub.from = parse_time (event[i]);
484 } else if (event_format[i] == "End") {
485 sub.to = parse_time (event[i]);
486 } else if (event_format[i] == "Style") {
487 /* libass trims leading '*'s from style names, commenting that
488 "they seem to mean literally nothing". Go figure...
490 trim_left_if (event[i], boost::is_any_of ("*"));
491 SUB_ASSERT (styles.find(event[i]) != styles.end());
492 style = styles[event[i]];
493 sub.font = style->font_name;
494 sub.font_size = FontSize::from_proportional(static_cast<float>(style->font_size) / play_res_y);
495 sub.colour = style->primary_colour;
496 sub.effect_colour = style->back_colour;
497 sub.bold = style->bold;
498 sub.italic = style->italic;
499 sub.underline = style->underline;
500 sub.effect = style->effect;
501 sub.horizontal_position.reference = style->horizontal_reference;
502 sub.vertical_position.reference = style->vertical_reference;
503 if (sub.vertical_position.reference != sub::VERTICAL_CENTRE_OF_SCREEN) {
504 sub.vertical_position.proportional = float(style->vertical_margin) / play_res_y;
506 } else if (event_format[i] == "MarginV") {
507 if (event[i] != "0" && sub.vertical_position.reference != sub::VERTICAL_CENTRE_OF_SCREEN) {
508 /* Override the style if its non-zero */
509 sub.vertical_position.proportional = raw_convert<float>(event[i]) / play_res_y;
511 } else if (event_format[i] == "Text") {
512 for (auto j: parse_line(sub, event[i], play_res_x, play_res_y, style ? style->primary_colour : Colour(1, 1, 1))) {