Fix line numbers in binary STL files.
[libsub.git] / src / stl_binary_reader.cc
index f7effdd8c740b863a07b52e5d70a6eddd1be6cc9..35091f083cfbcddebcbdcb12af77595a7289d35f 100644 (file)
@@ -36,8 +36,11 @@ using boost::lexical_cast;
 using boost::algorithm::replace_all;
 using boost::is_any_of;
 using boost::locale::conv::utf_to_utf;
+using std::shared_ptr;
 using namespace sub;
 
+namespace sub {
+
 class InputReader : public boost::noncopyable
 {
 public:
@@ -105,51 +108,95 @@ private:
        std::istream& _in;
 };
 
+class FILEInputReader : public InputReader
+{
+public:
+       FILEInputReader (FILE* in)
+               : _in (in)
+       {
+
+       }
+
+       void read (int size, string what)
+       {
+               size_t const N = fread (_buffer, 1, size, _in);
+               if (static_cast<int>(N) != size) {
+                       throw STLError (String::compose("Could not read %1 block from binary STL file", what));
+               }
+       }
+
+private:
+       FILE* _in;
+};
+
+}
+
 STLBinaryReader::STLBinaryReader (istream& in)
 {
-       StreamInputReader reader (in);
-       reader.read (1024, "GSI");
-
-       code_page_number = atoi (reader.get_string(0, 3).c_str());
-       frame_rate = stl_dfc_to_frame_rate (reader.get_string(3, 8));
-       display_standard = _tables.display_standard_file_to_enum (reader.get_string(11, 1));
-       language_group = _tables.language_group_file_to_enum (reader.get_string(12, 2));
-       language = _tables.language_file_to_enum (reader.get_string(14, 2));
-       original_programme_title = reader.get_string(16, 32);
-       original_episode_title = reader.get_string(48, 32);
-       translated_programme_title = reader.get_string(80, 32);
-       translated_episode_title = reader.get_string(112, 32);
-       translator_name = reader.get_string(144, 32);
-       translator_contact_details = reader.get_string(176, 32);
-       subtitle_list_reference_code = reader.get_string(208, 16);
-       creation_date = reader.get_string(224, 6);
-       revision_date = reader.get_string(230, 6);
-       revision_number = reader.get_string(236, 2);
-
-       tti_blocks = atoi (reader.get_string(238, 5).c_str());
-       number_of_subtitles = atoi (reader.get_string(243, 5).c_str());
-       subtitle_groups = atoi (reader.get_string(248, 3).c_str());
-       maximum_characters = atoi (reader.get_string(251, 2).c_str());
-       maximum_rows = atoi (reader.get_string(253, 2).c_str());
-       timecode_status = _tables.timecode_status_file_to_enum (reader.get_string(255, 1));
-       start_of_programme = reader.get_string(256, 8);
-       first_in_cue = reader.get_string(264, 8);
-       disks = atoi (reader.get_string(272, 1).c_str());
-       disk_sequence_number = atoi (reader.get_string(273, 1).c_str());
-       country_of_origin = reader.get_string(274, 3);
-       publisher = reader.get_string(277, 32);
-       editor_name = reader.get_string(309, 32);
-       editor_contact_details = reader.get_string(341, 32);
+       read (shared_ptr<InputReader>(new StreamInputReader(in)));
+}
+
+STLBinaryReader::STLBinaryReader (FILE* in)
+{
+       read (shared_ptr<InputReader>(new FILEInputReader(in)));
+}
 
+void STLBinaryReader::read (shared_ptr<InputReader> reader)
+{
+       reader->read (1024, "GSI");
+
+       code_page_number = atoi (reader->get_string(0, 3).c_str());
+       frame_rate = stl_dfc_to_frame_rate (reader->get_string(3, 8));
+       display_standard = _tables.display_standard_file_to_enum (reader->get_string(11, 1));
+       language_group = _tables.language_group_file_to_enum (reader->get_string(12, 2));
+       language = _tables.language_file_to_enum (reader->get_string(14, 2));
+       original_programme_title = reader->get_string(16, 32);
+       original_episode_title = reader->get_string(48, 32);
+       translated_programme_title = reader->get_string(80, 32);
+       translated_episode_title = reader->get_string(112, 32);
+       translator_name = reader->get_string(144, 32);
+       translator_contact_details = reader->get_string(176, 32);
+       subtitle_list_reference_code = reader->get_string(208, 16);
+       creation_date = reader->get_string(224, 6);
+       revision_date = reader->get_string(230, 6);
+       revision_number = reader->get_string(236, 2);
+
+       tti_blocks = atoi (reader->get_string(238, 5).c_str());
+       number_of_subtitles = atoi (reader->get_string(243, 5).c_str());
+       subtitle_groups = atoi (reader->get_string(248, 3).c_str());
+       maximum_characters = atoi (reader->get_string(251, 2).c_str());
+       maximum_rows = atoi (reader->get_string(253, 2).c_str());
+
+       if (maximum_rows == 99) {
+               /* https://tech.ebu.ch/docs/tech/tech3360.pdf says
+                  "It is recommended that for files with a large MNR value (e.g. '99') the
+                  font size (height) should be defined as ~ 1/15 of the 'Subtitle Safe Area'
+                  and a lineHeight of 120% is used to achieve a row height of ~ 1/12 of the height
+                  of the 'Subtitle Safe Area'.
+               */
+               maximum_rows = 12;
+       }
+
+       timecode_status = _tables.timecode_status_file_to_enum (reader->get_string(255, 1));
+       start_of_programme = reader->get_string(256, 8);
+       first_in_cue = reader->get_string(264, 8);
+       disks = atoi (reader->get_string(272, 1).c_str());
+       disk_sequence_number = atoi (reader->get_string(273, 1).c_str());
+       country_of_origin = reader->get_string(274, 3);
+       publisher = reader->get_string(277, 32);
+       editor_name = reader->get_string(309, 32);
+       editor_contact_details = reader->get_string(341, 32);
+
+       int highest_line = 0;
        for (int i = 0; i < tti_blocks; ++i) {
 
-               reader.read (128, "TTI");
+               reader->read (128, "TTI");
 
-               if (_tables.comment_file_to_enum (reader.get_int(15, 1)) == COMMENT_YES) {
+               if (_tables.comment_file_to_enum (reader->get_int(15, 1)) == COMMENT_YES) {
                        continue;
                }
 
-               string const whole = reader.get_string(16, 112);
+               string const whole = reader->get_string(16, 112);
 
                /* Split the text up into lines (8Ah is a new line) */
                vector<string> lines;
@@ -161,18 +208,22 @@ STLBinaryReader::STLBinaryReader (istream& in)
                bool italic = false;
                bool underline = false;
 
-               for (size_t i = 0; i < lines.size(); ++i) {
+               for (size_t j = 0; j < lines.size(); ++j) {
                        RawSubtitle sub;
-                       sub.from = reader.get_timecode(5, frame_rate);
-                       sub.to = reader.get_timecode(9, frame_rate);
-                       sub.vertical_position.line = reader.get_int(13, 1) + i;
+                       sub.from = reader->get_timecode(5, frame_rate);
+                       sub.to = reader->get_timecode(9, frame_rate);
+                       /* XXX: vertical position of TTI extension blocks should be ignored (spec page 10) so this
+                        * is wrong if the EBN of this TTI block is not 255 (I think).
+                        */
+                       sub.vertical_position.line = reader->get_int(13, 1) + j;
+                       highest_line = std::max(highest_line, *sub.vertical_position.line);
                        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 = reader.get_int(14, 1);
+                       int const h = reader->get_int(14, 1);
                        switch (h) {
                        case 0:
                        case 2:
@@ -188,9 +239,9 @@ STLBinaryReader::STLBinaryReader (istream& in)
 
                        /* Loop over characters */
                        string text;
-                       for (size_t j = 0; j < lines[i].size(); ++j) {
+                       for (size_t k = 0; k < lines[j].size(); ++k) {
 
-                               unsigned char const c = static_cast<unsigned char> (lines[i][j]);
+                               unsigned char const c = static_cast<unsigned char> (lines[j][k]);
 
                                if (c == 0x8f) {
                                        /* Unused space i.e. end of line */
@@ -218,7 +269,7 @@ STLBinaryReader::STLBinaryReader (istream& in)
                                        underline = false;
                                        break;
                                default:
-                                       text += lines[i][j];
+                                       text += lines[j][k];
                                        break;
                                }
 
@@ -234,6 +285,14 @@ STLBinaryReader::STLBinaryReader (istream& in)
                        /* XXX: justification */
                }
        }
+
+       /* Fix line numbers so they don't go off the bottom of the screen */
+       if (highest_line > maximum_rows) {
+               int correction = highest_line - maximum_rows;
+               for (auto& i: _subs) {
+                       *i.vertical_position.line -= correction;
+               }
+       }
 }
 
 map<string, string>