Strip Unicode U+202B (right-to-left-embedding) code; it looks like DoM does RTL ...
[libsub.git] / src / stl_binary_reader.cc
index ebcee1bd07e2de72a088c80dab3b34cded9aba42..55e0188fdcc8011f25400cb13ae45f212ff64f97 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#include <boost/lexical_cast.hpp>
-#include <boost/algorithm/string.hpp>
-#include <boost/locale.hpp>
 #include "stl_binary_reader.h"
 #include "exceptions.h"
 #include "iso6937.h"
+#include "stl_util.h"
 #include "compose.hpp"
+#include <boost/lexical_cast.hpp>
+#include <boost/algorithm/string.hpp>
+#include <boost/locale.hpp>
+#include <iostream>
 
 using std::map;
 using std::vector;
@@ -36,72 +38,26 @@ using boost::is_any_of;
 using boost::locale::conv::utf_to_utf;
 using namespace sub;
 
-template <class E, class F>
-E
-file_to_enum (F k, map<F, STLCode<E> > m, string name)
-{
-       typename map<F, STLCode<E> >::const_iterator i = m.find (k);
-       if (i == m.end ()) {
-               throw STLError (String::compose ("Unknown %1 %2 in binary STL file", name, k));
-       }
-
-       return i->second.value;
-}
-
-template <class E, class F>
-string
-enum_to_description (E v, map<F, STLCode<E> > const & m)
-{
-       for (typename map<F, STLCode<E> >::const_iterator i = m.begin(); i != m.end(); ++i) {
-               if (i->second.value == v) {
-                       return i->second.description;
-               }
-       }
-
-       return "";
-}
-
-template <class E, class F>
-void
-code (map<F, STLCode<E> >& m, F k, E v, string d)
-{
-       m[k] = STLCode<E> (v, d);
-}
-
-
 STLBinaryReader::STLBinaryReader (istream& in)
        : _buffer (new unsigned char[1024])
 {
-       create_tables ();
-       
        in.read ((char *) _buffer, 1024);
        if (in.gcount() != 1024) {
                throw STLError ("Could not read GSI block from binary STL file");
        }
-               
-       code_page_number = atoi (get_string (0, 3).c_str ());
-       
-       string const dfc = get_string (3, 8);
-       if (dfc == "STL24.01") {
-               frame_rate = 24;
-       } else if (dfc == "STL25.01") {
-               frame_rate = 25;
-       } else if (dfc == "STL30.01") {
-               frame_rate = 30;
-       } else {
-               throw STLError (String::compose ("Unknown disk format code %1 in binary STL file", dfc));
-       }
 
-       display_standard = file_to_enum (get_string (11, 1), _display_standard_map, "display standard code");
-       language_group = file_to_enum (get_string (12, 2), _language_group_map, "character code");
-       language = file_to_enum (get_string (14, 2), _language_map, "language code");
+       code_page_number = atoi (get_string (0, 3).c_str ());
+       frame_rate = stl_dfc_to_frame_rate (get_string (3, 8));
+       display_standard = _tables.display_standard_file_to_enum (get_string (11, 1));
+       language_group = _tables.language_group_file_to_enum (get_string (12, 2));
+       language = _tables.language_file_to_enum (get_string (14, 2));
        original_programme_title = get_string (16, 32);
        original_episode_title = get_string (48, 32);
        translated_programme_title = get_string (80, 32);
        translated_episode_title = get_string (112, 32);
        translator_name = get_string (144, 32);
        translator_contact_details = get_string (176, 32);
-       subtitle_list_reference_code = get_string (208, 32);
+       subtitle_list_reference_code = get_string (208, 16);
        creation_date = get_string (224, 6);
        revision_date = get_string (230, 6);
        revision_number = get_string (236, 2);
@@ -111,9 +67,9 @@ STLBinaryReader::STLBinaryReader (istream& in)
        subtitle_groups = atoi (get_string (248, 3).c_str ());
        maximum_characters = atoi (get_string (251, 2).c_str ());
        maximum_rows = atoi (get_string (253, 2).c_str ());
-       timecode_status = file_to_enum (get_string (255, 1), _timecode_status_map, "timecode status code");
+       timecode_status = _tables.timecode_status_file_to_enum (get_string (255, 1));
        start_of_programme = get_string (256, 8);
-       first_in_cue = get_string (256, 8);
+       first_in_cue = get_string (264, 8);
        disks = atoi (get_string (272, 1).c_str ());
        disk_sequence_number = atoi (get_string (273, 1).c_str ());
        country_of_origin = get_string (274, 3);
@@ -122,13 +78,13 @@ STLBinaryReader::STLBinaryReader (istream& in)
        editor_contact_details = get_string (341, 32);
 
        for (int i = 0; i < tti_blocks; ++i) {
-               
+
                in.read ((char *) _buffer, 128);
                if (in.gcount() != 128) {
                        throw STLError ("Could not read TTI block from binary STL file");
                }
 
-               if (file_to_enum (get_int (15, 1), _comment_map, "comment flag") == COMMENT_YES) {
+               if (_tables.comment_file_to_enum (get_int (15, 1)) == COMMENT_YES) {
                        continue;
                }
 
@@ -138,25 +94,83 @@ STLBinaryReader::STLBinaryReader (istream& in)
                vector<string> lines;
                split (lines, whole, is_any_of ("\x8a"));
 
+               /* Italic / underline specifications can span lines, so we need to track them
+                  outside the lines loop.
+               */
+               bool italic = false;
+               bool underline = false;
+
                for (size_t i = 0; i < lines.size(); ++i) {
-                       Subtitle sub;
-                       sub.from.set_frame (get_timecode (5));
-                       sub.to.set_frame (get_timecode (9));
+                       RawSubtitle sub;
+                       sub.from = get_timecode (5);
+                       sub.to = get_timecode (9);
                        sub.vertical_position.line = get_int (13, 1) + i;
-                       
-                       /* XXX: justification, effects */
+                       sub.vertical_position.lines = maximum_rows;
+                       sub.vertical_position.reference = TOP_OF_SCREEN;
+                       sub.italic = italic;
+                       sub.underline = underline;
+
+                       /* XXX: not sure what to do with JC = 0, "unchanged presentation" */
+                       int const h = get_int (14, 1);
+                       switch (h) {
+                       case 0:
+                       case 2:
+                               sub.horizontal_position.reference = HORIZONTAL_CENTRE_OF_SCREEN;
+                               break;
+                       case 1:
+                               sub.horizontal_position.reference = LEFT_OF_SCREEN;
+                               break;
+                       case 3:
+                               sub.horizontal_position.reference = RIGHT_OF_SCREEN;
+                               break;
+                       }
+
+                       /* Loop over characters */
+                       string text;
+                       for (size_t j = 0; j < lines[i].size(); ++j) {
+
+                               unsigned char const c = static_cast<unsigned char> (lines[i][j]);
+
+                               if (c == 0x8f) {
+                                       /* Unused space i.e. end of line */
+                                       break;
+                               }
+
+                               if (c >= 0x80 && c <= 0x83) {
+                                       /* Italic or underline control code */
+                                       sub.text = utf_to_utf<char> (iso6937_to_utf16 (text.c_str()));
+                                       _subs.push_back (sub);
+                                       text.clear ();
+                               }
+
+                               switch (c) {
+                               case 0x80:
+                                       italic = true;
+                                       break;
+                               case 0x81:
+                                       italic = false;
+                                       break;
+                               case 0x82:
+                                       underline = true;
+                                       break;
+                               case 0x83:
+                                       underline = false;
+                                       break;
+                               default:
+                                       text += lines[i][j];
+                                       break;
+                               }
+
+                               sub.italic = italic;
+                               sub.underline = underline;
+                       }
 
-                       /* 8Fh is unused space, so trim the string to the first instance of that */
-                       size_t unused = lines[i].find_first_of ('\x8f');
-                       if (unused != string::npos) {
-                               lines[i] = lines[i].substr (0, unused);
+                       if (!text.empty ()) {
+                               sub.text = utf_to_utf<char> (iso6937_to_utf16 (text.c_str()));
+                               _subs.push_back (sub);
                        }
 
-                       Block block;
-                       block.text = utf_to_utf<char> (iso6937_to_utf16 (lines[i].c_str()));
-                       sub.blocks.push_back (block);
-                       
-                       _subs.push_back (sub);
+                       /* XXX: justification */
                }
        }
 }
@@ -188,10 +202,10 @@ STLBinaryReader::get_int (int offset, int length) const
        return v;
 }
 
-FrameTime
+Time
 STLBinaryReader::get_timecode (int offset) const
 {
-       return FrameTime (_buffer[offset], _buffer[offset + 1], _buffer[offset + 2], _buffer[offset + 3]);
+       return Time::from_hmsf (_buffer[offset], _buffer[offset + 1], _buffer[offset + 2], _buffer[offset + 3], Rational (frame_rate, 1));
 }
 
 map<string, string>
@@ -201,9 +215,9 @@ STLBinaryReader::metadata () const
 
        m["Code page number"] = lexical_cast<string> (code_page_number);
        m["Frame rate"] = lexical_cast<string> (frame_rate);
-       m["Display standard"] = enum_to_description (display_standard, _display_standard_map);
-       m["Language group"] = enum_to_description (language_group, _language_group_map);
-       m["Language"] = enum_to_description (language, _language_map);
+       m["Display standard"] = _tables.display_standard_enum_to_description (display_standard);
+       m["Language group"] = _tables.language_group_enum_to_description (language_group);
+       m["Language"] = _tables.language_enum_to_description (language);
        m["Original programme title"] = original_programme_title;
        m["Original episode title"] = original_episode_title;
        m["Translated programme title"] = translated_programme_title;
@@ -219,7 +233,7 @@ STLBinaryReader::metadata () const
        m["Subtitle groups"] = lexical_cast<string> (subtitle_groups);
        m["Maximum characters"] = lexical_cast<string> (maximum_characters);
        m["Maximum rows"] = lexical_cast<string> (maximum_rows);
-       m["Timecode status"] = enum_to_description (timecode_status, _timecode_status_map);
+       m["Timecode status"] = _tables.timecode_status_enum_to_description (timecode_status);
        m["Start of programme"] = start_of_programme;
        m["First in cue"] = first_in_cue;
        m["Disks"] = lexical_cast<string> (disks);
@@ -231,138 +245,3 @@ STLBinaryReader::metadata () const
 
        return m;
 }
-
-void
-STLBinaryReader::create_tables ()
-{
-       code<DisplayStandard, string> (_display_standard_map, " ", DISPLAY_STANDARD_UNDEFINED, "Undefined");
-       code<DisplayStandard, string> (_display_standard_map, "0", DISPLAY_STANDARD_OPEN_SUBTITLING, "Open subtitling");
-       code<DisplayStandard, string> (_display_standard_map, "1", DISPLAY_STANDARD_LEVEL_1_TELETEXT, "Level 1 teletext");
-       code<DisplayStandard, string> (_display_standard_map, "2", DISPLAY_STANDARD_LEVEL_2_TELETEXT, "Level 2 teletext");
-       
-       code<LanguageGroup, string> (_language_group_map, "00", LANGUAGE_GROUP_LATIN, "Latin");
-       code<LanguageGroup, string> (_language_group_map, "01", LANGUAGE_GROUP_LATIN_CYRILLIC, "Latin/Cyrillic");
-       code<LanguageGroup, string> (_language_group_map, "02", LANGUAGE_GROUP_LATIN_ARABIC, "Latin/Arabic");
-       code<LanguageGroup, string> (_language_group_map, "03", LANGUAGE_GROUP_LATIN_GREEK, "Latin/Greek");
-       code<LanguageGroup, string> (_language_group_map, "04", LANGUAGE_GROUP_LATIN_HEBREW, "Latin/Hebrew");
-       
-       code<Language, string> (_language_map, "00", LANGUAGE_UNKNOWN, "Unknown");
-       code<Language, string> (_language_map, "01", LANGUAGE_ALBANIAN, "Albanian");
-       code<Language, string> (_language_map, "02", LANGUAGE_BRETON, "Breton");
-       code<Language, string> (_language_map, "03", LANGUAGE_CATALAN, "Catalan");
-       code<Language, string> (_language_map, "04", LANGUAGE_CROATIAN, "Croatian");
-       code<Language, string> (_language_map, "05", LANGUAGE_WELSH, "Welsh");
-       code<Language, string> (_language_map, "06", LANGUAGE_CZECH, "Czech");
-       code<Language, string> (_language_map, "07", LANGUAGE_DANISH, "Danish");
-       code<Language, string> (_language_map, "08", LANGUAGE_GERMAN, "German");
-       code<Language, string> (_language_map, "09", LANGUAGE_ENGLISH, "English");
-       code<Language, string> (_language_map, "0A", LANGUAGE_SPANISH, "Spanish");
-       code<Language, string> (_language_map, "0B", LANGUAGE_ESPERANTO, "Esperanto");
-       code<Language, string> (_language_map, "0C", LANGUAGE_ESTONIAN, "Estonian");
-       code<Language, string> (_language_map, "0D", LANGUAGE_BASQUE, "Basque");
-       code<Language, string> (_language_map, "0E", LANGUAGE_FAROESE, "Faroese");
-       code<Language, string> (_language_map, "0F", LANGUAGE_FRENCH, "French");
-       code<Language, string> (_language_map, "10", LANGUAGE_FRISIAN, "Frisian");
-       code<Language, string> (_language_map, "11", LANGUAGE_IRISH, "Irish");
-       code<Language, string> (_language_map, "12", LANGUAGE_GAELIC, "Gaelic");
-       code<Language, string> (_language_map, "13", LANGUAGE_GALACIAN, "Galacian");
-       code<Language, string> (_language_map, "14", LANGUAGE_ICELANDIC, "Icelandic");
-       code<Language, string> (_language_map, "15", LANGUAGE_ITALIAN, "Italian");
-       code<Language, string> (_language_map, "16", LANGUAGE_LAPPISH, "Lappish");
-       code<Language, string> (_language_map, "17", LANGUAGE_LATIN, "Latin");
-       code<Language, string> (_language_map, "18", LANGUAGE_LATVIAN, "Latvian");
-       code<Language, string> (_language_map, "19", LANGUAGE_LUXEMBORGIAN, "Luxemborgian");
-       code<Language, string> (_language_map, "1A", LANGUAGE_LITHUANIAN, "Lithuanian");
-       code<Language, string> (_language_map, "1B", LANGUAGE_HUNGARIAN, "Hungarian");
-       code<Language, string> (_language_map, "1C", LANGUAGE_MALTESE, "Maltese");
-       code<Language, string> (_language_map, "1D", LANGUAGE_DUTCH, "Dutch");
-       code<Language, string> (_language_map, "1E", LANGUAGE_NORWEGIAN, "Norwegian");
-       code<Language, string> (_language_map, "1F", LANGUAGE_OCCITAN, "Occitan");
-       code<Language, string> (_language_map, "20", LANGUAGE_POLISH, "Polish");
-       code<Language, string> (_language_map, "21", LANGUAGE_PORTUGESE, "Portugese");
-       code<Language, string> (_language_map, "22", LANGUAGE_ROMANIAN, "Romanian");
-       code<Language, string> (_language_map, "23", LANGUAGE_ROMANSH, "Romansh");
-       code<Language, string> (_language_map, "24", LANGUAGE_SERBIAN, "Serbian");
-       code<Language, string> (_language_map, "25", LANGUAGE_SLOVAK, "Slovak");
-       code<Language, string> (_language_map, "26", LANGUAGE_SLOVENIAN, "Slovenian");
-       code<Language, string> (_language_map, "27", LANGUAGE_FINNISH, "Finnish");
-       code<Language, string> (_language_map, "28", LANGUAGE_SWEDISH, "Swedish");
-       code<Language, string> (_language_map, "29", LANGUAGE_TURKISH, "Turkish");
-       code<Language, string> (_language_map, "2A", LANGUAGE_FLEMISH, "Flemish");
-       code<Language, string> (_language_map, "2B", LANGUAGE_WALLON, "Wallon");
-       code<Language, string> (_language_map, "7F", LANGUAGE_AMHARIC, "Amharic");
-       code<Language, string> (_language_map, "7E", LANGUAGE_ARABIC, "Arabic");
-       code<Language, string> (_language_map, "7D", LANGUAGE_ARMENIAN, "Armenian");
-       code<Language, string> (_language_map, "7C", LANGUAGE_ASSAMESE, "Assamese");
-       code<Language, string> (_language_map, "7B", LANGUAGE_AZERBAIJANI, "Azerbaijani");
-       code<Language, string> (_language_map, "7A", LANGUAGE_BAMBORA, "Bambora");
-       code<Language, string> (_language_map, "79", LANGUAGE_BIELORUSSIAN, "Bielorussian");
-       code<Language, string> (_language_map, "78", LANGUAGE_BENGALI, "Bengali");
-       code<Language, string> (_language_map, "77", LANGUAGE_BULGARIAN, "Bulgarian");
-       code<Language, string> (_language_map, "76", LANGUAGE_BURMESE, "Burmese");
-       code<Language, string> (_language_map, "75", LANGUAGE_CHINESE, "Chinese");
-       code<Language, string> (_language_map, "74", LANGUAGE_CHURASH, "Churash");
-       code<Language, string> (_language_map, "73", LANGUAGE_DARI, "Dari");
-       code<Language, string> (_language_map, "72", LANGUAGE_FULANI, "Fulani");
-       code<Language, string> (_language_map, "71", LANGUAGE_GEORGIAN, "Georgian");
-       code<Language, string> (_language_map, "70", LANGUAGE_GREEK, "Greek");
-       code<Language, string> (_language_map, "6F", LANGUAGE_GUJURATI, "Gujarati");
-       code<Language, string> (_language_map, "6E", LANGUAGE_GURANI, "Gurani");
-       code<Language, string> (_language_map, "6D", LANGUAGE_HAUSA, "Hausa");
-       code<Language, string> (_language_map, "6C", LANGUAGE_HEBREW, "Hebrew");
-       code<Language, string> (_language_map, "6B", LANGUAGE_HINDI, "Hindi");
-       code<Language, string> (_language_map, "6A", LANGUAGE_INDONESIAN, "Indonesian");
-       code<Language, string> (_language_map, "69", LANGUAGE_JAPANESE, "Japanese");
-       code<Language, string> (_language_map, "68", LANGUAGE_KANNADA, "Kannada");
-       code<Language, string> (_language_map, "67", LANGUAGE_KAZAKH, "Kazakh");
-       code<Language, string> (_language_map, "66", LANGUAGE_KHMER, "Khmer");
-       code<Language, string> (_language_map, "65", LANGUAGE_KOREAN, "Korean");
-       code<Language, string> (_language_map, "64", LANGUAGE_LAOTIAN, "Laotian");
-       code<Language, string> (_language_map, "63", LANGUAGE_MACEDONIAN, "Macedonian");
-       code<Language, string> (_language_map, "62", LANGUAGE_MALAGASAY, "Malagasay");
-       code<Language, string> (_language_map, "61", LANGUAGE_MALAYSIAN, "Malaysian");
-       code<Language, string> (_language_map, "60", LANGUAGE_MOLDAVIAN, "Moldavian");
-       code<Language, string> (_language_map, "5F", LANGUAGE_MARATHI, "Marathi");
-       code<Language, string> (_language_map, "5E", LANGUAGE_NDEBELE, "Ndebele");
-       code<Language, string> (_language_map, "5D", LANGUAGE_NEPALI, "Nepali");
-       code<Language, string> (_language_map, "5C", LANGUAGE_ORIYA, "Oriya");
-       code<Language, string> (_language_map, "5B", LANGUAGE_PAPAMIENTO, "Papamiento");
-       code<Language, string> (_language_map, "5A", LANGUAGE_PERSIAN, "Persian");
-       code<Language, string> (_language_map, "59", LANGUAGE_PUNJABI, "Punjabi");
-       code<Language, string> (_language_map, "58", LANGUAGE_PUSHTU, "Pushtu");
-       code<Language, string> (_language_map, "57", LANGUAGE_QUECHUA, "Quechua");
-       code<Language, string> (_language_map, "56", LANGUAGE_RUSSIAN, "Russian");
-       code<Language, string> (_language_map, "55", LANGUAGE_RUTHENIAN, "Ruthenian");
-       code<Language, string> (_language_map, "54", LANGUAGE_SERBO_CROAT, "Serbo Croat");
-       code<Language, string> (_language_map, "53", LANGUAGE_SHONA, "Shona");
-       code<Language, string> (_language_map, "52", LANGUAGE_SINHALESE, "Sinhalese");
-       code<Language, string> (_language_map, "51", LANGUAGE_SOMALI, "Somali");
-       code<Language, string> (_language_map, "50", LANGUAGE_SRANAN_TONGO, "Sranan Tongo");
-       code<Language, string> (_language_map, "4F", LANGUAGE_SWAHILI, "Swahili");
-       code<Language, string> (_language_map, "4E", LANGUAGE_TADZHIK, "Tadzhik");
-       code<Language, string> (_language_map, "4D", LANGUAGE_TAMIL, "Tamil");
-       code<Language, string> (_language_map, "4C", LANGUAGE_TATAR, "Tatar");
-       code<Language, string> (_language_map, "4B", LANGUAGE_TELUGU, "Telugu");
-       code<Language, string> (_language_map, "4A", LANGUAGE_THAI, "Thai");
-       code<Language, string> (_language_map, "49", LANGUAGE_UKRANIAN, "Ukranian");
-       code<Language, string> (_language_map, "48", LANGUAGE_URDU, "Urdu");
-       code<Language, string> (_language_map, "47", LANGUAGE_UZBEK, "Uzbek");
-       code<Language, string> (_language_map, "46", LANGUAGE_VIETNAMESE, "Vietnamese");
-       code<Language, string> (_language_map, "45", LANGUAGE_ZULU, "Zulu");
-
-       code<TimecodeStatus, string> (_timecode_status_map, "0", TIMECODE_STATUS_NOT_INTENDED_FOR_USE, "Not intended for use");
-       code<TimecodeStatus, string> (_timecode_status_map, "1", TIMECODE_STATUS_INTENDED_FOR_USE, "Intended for use");
-
-       code<CumulativeStatus, int> (_cumulative_status_map, 0, CUMULATIVE_STATUS_NOT_CUMULATIVE, "Not part of a cumulative set");
-       code<CumulativeStatus, int> (_cumulative_status_map, 1, CUMULATIVE_STATUS_FIRST, "First subtitle of a cumulative set");
-       code<CumulativeStatus, int> (_cumulative_status_map, 2, CUMULATIVE_STATUS_INTERMEDIATE, "Intermediate subtitle of a cumulative set");
-       code<CumulativeStatus, int> (_cumulative_status_map, 3, CUMULATIVE_STATUS_LAST, "Last subtitle of a cumulative set");
-
-       code<Justification, int> (_justification_map, 0, JUSTIFICATION_NONE, "No justification");
-       code<Justification, int> (_justification_map, 1, JUSTIFICATION_LEFT, "Left justification");
-       code<Justification, int> (_justification_map, 2, JUSTIFICATION_CENTRE, "Centre justification");
-       code<Justification, int> (_justification_map, 3, JUSTIFICATION_CENTRE, "Right justification");
-
-       code<Comment, int> (_comment_map, 0, COMMENT_NO, "Not a comment");
-       code<Comment, int> (_comment_map, 1, COMMENT_YES, "Is a comment");
-}