src/stl_binary_reader.cc

   1 /*
   2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #include "stl_binary_reader.h"
  21 #include "exceptions.h"
  22 #include "iso6937.h"
  23 #include "stl_util.h"
  24 #include "compose.hpp"
  25 #include <boost/lexical_cast.hpp>
  26 #include <boost/algorithm/string.hpp>
  27 #include <boost/locale.hpp>
  28
  29 using std::map;
  30 using std::vector;
  31 using std::cout;
  32 using std::string;
  33 using std::istream;
  34 using boost::lexical_cast;
  35 using boost::algorithm::replace_all;
  36 using boost::is_any_of;
  37 using boost::locale::conv::utf_to_utf;
  38 using namespace sub;
  39
  40 STLBinaryReader::STLBinaryReader (istream& in)
  41         : _buffer (new unsigned char[1024])
  42 {
  43         in.read ((char *) _buffer, 1024);
  44         if (in.gcount() != 1024) {
  45                 throw STLError ("Could not read GSI block from binary STL file");
  46         }
  47
  48         code_page_number = atoi (get_string (0, 3).c_str ());
  49         frame_rate = stl_dfc_to_frame_rate (get_string (3, 8));
  50         display_standard = _tables.display_standard_file_to_enum (get_string (11, 1));
  51         language_group = _tables.language_group_file_to_enum (get_string (12, 2));
  52         language = _tables.language_file_to_enum (get_string (14, 2));
  53         original_programme_title = get_string (16, 32);
  54         original_episode_title = get_string (48, 32);
  55         translated_programme_title = get_string (80, 32);
  56         translated_episode_title = get_string (112, 32);
  57         translator_name = get_string (144, 32);
  58         translator_contact_details = get_string (176, 32);
  59         subtitle_list_reference_code = get_string (208, 16);
  60         creation_date = get_string (224, 6);
  61         revision_date = get_string (230, 6);
  62         revision_number = get_string (236, 2);
  63
  64         tti_blocks = atoi (get_string (238, 5).c_str ());
  65         number_of_subtitles = atoi (get_string (243, 5).c_str ());
  66         subtitle_groups = atoi (get_string (248, 3).c_str ());
  67         maximum_characters = atoi (get_string (251, 2).c_str ());
  68         maximum_rows = atoi (get_string (253, 2).c_str ());
  69         timecode_status = _tables.timecode_status_file_to_enum (get_string (255, 1));
  70         start_of_programme = get_string (256, 8);
  71         first_in_cue = get_string (264, 8);
  72         disks = atoi (get_string (272, 1).c_str ());
  73         disk_sequence_number = atoi (get_string (273, 1).c_str ());
  74         country_of_origin = get_string (274, 3);
  75         publisher = get_string (277, 32);
  76         editor_name = get_string (309, 32);
  77         editor_contact_details = get_string (341, 32);
  78
  79         for (int i = 0; i < tti_blocks; ++i) {
  80
  81                 in.read ((char *) _buffer, 128);
  82                 if (in.gcount() != 128) {
  83                         throw STLError ("Could not read TTI block from binary STL file");
  84                 }
  85
  86                 if (_tables.comment_file_to_enum (get_int (15, 1)) == COMMENT_YES) {
  87                         continue;
  88                 }
  89
  90                 string const whole = get_string (16, 112);
  91
  92                 /* Split the text up into lines (8Ah is a new line) */
  93                 vector<string> lines;
  94                 split (lines, whole, is_any_of ("\x8a"));
  95
  96                 for (size_t i = 0; i < lines.size(); ++i) {
  97                         RawSubtitle sub;
  98                         sub.from.set_frame (get_timecode (5));
  99                         sub.to.set_frame (get_timecode (9));
 100                         sub.vertical_position.line = get_int (13, 1) + i;
 101                         sub.vertical_position.reference = TOP_OF_SCREEN;
 102
 103                         string text;
 104                         for (size_t j = 0; j < lines[i].size(); ++j) {
 105
 106                                 unsigned char const c = static_cast<unsigned char> (lines[i][j]);
 107
 108                                 if (c == 0x8f) {
 109                                         /* Unused space i.e. end of line */
 110                                         break;
 111                                 }
 112
 113                                 if (c >= 0x80 && c <= 0x83) {
 114                                         /* Italic or underline control code */
 115                                         sub.text = utf_to_utf<char> (iso6937_to_utf16 (text.c_str()));
 116                                         _subs.push_back (sub);
 117                                         text.clear ();
 118                                 }
 119
 120                                 switch (c) {
 121                                 case 0x80:
 122                                         sub.italic = true;
 123                                         break;
 124                                 case 0x81:
 125                                         sub.italic = false;
 126                                         break;
 127                                 case 0x82:
 128                                         sub.underline = true;
 129                                         break;
 130                                 case 0x83:
 131                                         sub.underline = false;
 132                                         break;
 133                                 default:
 134                                         text += lines[i][j];
 135                                         break;
 136                                 }
 137                         }
 138
 139                         if (!text.empty ()) {
 140                                 sub.text = utf_to_utf<char> (iso6937_to_utf16 (text.c_str()));
 141                                 _subs.push_back (sub);
 142                         }
 143
 144                         /* XXX: justification */
 145                 }
 146         }
 147 }
 148
 149 STLBinaryReader::~STLBinaryReader ()
 150 {
 151         delete[] _buffer;
 152 }
 153
 154 string
 155 STLBinaryReader::get_string (int offset, int length) const
 156 {
 157         string s;
 158         for (int i = 0; i < length; ++i) {
 159                 s += _buffer[offset + i];
 160         }
 161
 162         return s;
 163 }
 164
 165 int
 166 STLBinaryReader::get_int (int offset, int length) const
 167 {
 168         int v = 0;
 169         for (int i = 0; i < length; ++i) {
 170                 v |= _buffer[offset + i] << (8 * i);
 171         }
 172
 173         return v;
 174 }
 175
 176 FrameTime
 177 STLBinaryReader::get_timecode (int offset) const
 178 {
 179         return FrameTime (_buffer[offset], _buffer[offset + 1], _buffer[offset + 2], _buffer[offset + 3]);
 180 }
 181
 182 map<string, string>
 183 STLBinaryReader::metadata () const
 184 {
 185         map<string, string> m;
 186
 187         m["Code page number"] = lexical_cast<string> (code_page_number);
 188         m["Frame rate"] = lexical_cast<string> (frame_rate);
 189         m["Display standard"] = _tables.display_standard_enum_to_description (display_standard);
 190         m["Language group"] = _tables.language_group_enum_to_description (language_group);
 191         m["Language"] = _tables.language_enum_to_description (language);
 192         m["Original programme title"] = original_programme_title;
 193         m["Original episode title"] = original_episode_title;
 194         m["Translated programme title"] = translated_programme_title;
 195         m["Translated episode title"] = translated_episode_title;
 196         m["Translator name"] = translator_name;
 197         m["Translator contact details"] = translator_contact_details;
 198         m["Subtitle list reference code"] = subtitle_list_reference_code;
 199         m["Creation date"] = creation_date;
 200         m["Revision date"] = revision_date;
 201         m["Revision number"] = revision_number;
 202         m["TTI blocks"] = lexical_cast<string> (tti_blocks);
 203         m["Number of subtitles"] = lexical_cast<string> (number_of_subtitles);
 204         m["Subtitle groups"] = lexical_cast<string> (subtitle_groups);
 205         m["Maximum characters"] = lexical_cast<string> (maximum_characters);
 206         m["Maximum rows"] = lexical_cast<string> (maximum_rows);
 207         m["Timecode status"] = _tables.timecode_status_enum_to_description (timecode_status);
 208         m["Start of programme"] = start_of_programme;
 209         m["First in cue"] = first_in_cue;
 210         m["Disks"] = lexical_cast<string> (disks);
 211         m["Disk sequence number"] = lexical_cast<string> (disk_sequence_number);
 212         m["Country of origin"] = country_of_origin;
 213         m["Publisher"] = publisher;
 214         m["Editor name"] = editor_name;
 215         m["Editor contact details"] = editor_contact_details;
 216
 217         return m;
 218 }