src/lib/string_text_file.cc

   1 /*
   2     Copyright (C) 2014-2020 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 #include "cross.h"
  23 #include "exceptions.h"
  24 #include "string_text_file.h"
  25 #include "string_text_file_content.h"
  26 #include <dcp/file.h>
  27 #include <sub/collect.h>
  28 #include <sub/exceptions.h>
  29 #include <sub/ssa_reader.h>
  30 #include <sub/stl_binary_reader.h>
  31 #include <sub/subrip_reader.h>
  32 #include <sub/web_vtt_reader.h>
  33 #include <unicode/ucsdet.h>
  34 #include <unicode/ucnv.h>
  35 #include <iostream>
  36
  37 #include "i18n.h"
  38
  39
  40 using std::cout;
  41 using std::shared_ptr;
  42 using std::string;
  43 using std::vector;
  44 using boost::scoped_array;
  45 using boost::optional;
  46 using dcp::ArrayData;
  47 using namespace dcpomatic;
  48
  49
  50 StringTextFile::StringTextFile (shared_ptr<const StringTextFileContent> content)
  51 {
  52         string ext = content->path(0).extension().string();
  53         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
  54
  55         std::unique_ptr<sub::Reader> reader;
  56
  57         if (ext == ".stl") {
  58                 dcp::File f(content->path(0), "rb");
  59                 if (!f) {
  60                         throw OpenFileError (f.path(), errno, OpenFileError::READ);
  61                 }
  62                 try {
  63                         reader.reset(new sub::STLBinaryReader(f.get()));
  64                 } catch (...) {
  65                         throw;
  66                 }
  67
  68         } else {
  69                 /* Text-based file; sort out its character encoding before we try to parse it */
  70
  71                 ArrayData in (content->path (0));
  72
  73                 UErrorCode status = U_ZERO_ERROR;
  74                 UCharsetDetector* detector = ucsdet_open (&status);
  75                 ucsdet_setText (detector, reinterpret_cast<const char *>(in.data()), in.size(), &status);
  76
  77                 UCharsetMatch const * match = ucsdet_detect (detector, &status);
  78                 char const * in_charset = ucsdet_getName (match, &status);
  79
  80                 UConverter* to_utf16 = ucnv_open (in_charset, &status);
  81                 /* This is a guess; I think we should be able to encode any input in 4 times its input size */
  82                 scoped_array<uint16_t> utf16 (new uint16_t[in.size() * 2]);
  83                 int const utf16_len = ucnv_toUChars (
  84                                 to_utf16, reinterpret_cast<UChar*>(utf16.get()), in.size() * 2,
  85                                 reinterpret_cast<const char *>(in.data()), in.size(),
  86                                 &status
  87                                 );
  88
  89                 UConverter* to_utf8 = ucnv_open ("UTF-8", &status);
  90                 /* Another guess */
  91                 scoped_array<char> utf8 (new char[utf16_len * 2]);
  92                 ucnv_fromUChars (to_utf8, utf8.get(), utf16_len * 2, reinterpret_cast<UChar*>(utf16.get()), utf16_len, &status);
  93
  94                 /* Fix OS X line endings */
  95                 size_t utf8_len = strlen (utf8.get ());
  96                 for (size_t i = 0; i < utf8_len; ++i) {
  97                         if (utf8[i] == '\r' && ((i == utf8_len - 1) || utf8[i + 1] != '\n')) {
  98                                 utf8[i] = '\n';
  99                         }
 100                 }
 101
 102                 ucsdet_close (detector);
 103                 ucnv_close (to_utf16);
 104                 ucnv_close (to_utf8);
 105
 106                 if (ext == ".srt") {
 107                         try {
 108                                 reader.reset(new sub::SubripReader(utf8.get()));
 109                         } catch (sub::SubripError& subrip_error) {
 110                                 /* Sometimes files are have the .srt extension but are really WEBVTT... */
 111                                 try {
 112                                         reader.reset(new sub::WebVTTReader(utf8.get()));
 113                                 } catch (sub::WebVTTHeaderError&) {
 114                                         /* ...but in this case there isn't even a WebVTT error */
 115                                         throw subrip_error;
 116                                 }
 117                         }
 118                 } else if (ext == ".ssa" || ext == ".ass") {
 119                         reader.reset(new sub::SSAReader(utf8.get()));
 120                 } else if (ext == ".vtt") {
 121                         reader.reset(new sub::WebVTTReader(utf8.get()));
 122                 }
 123         }
 124
 125         if (reader) {
 126                 _subtitles = sub::collect<vector<sub::Subtitle>>(reader->subtitles());
 127         }
 128 }
 129
 130 /** @return time of first subtitle, if there is one */
 131 optional<ContentTime>
 132 StringTextFile::first () const
 133 {
 134         if (_subtitles.empty()) {
 135                 return {};
 136         }
 137
 138         return ContentTime::from_seconds(_subtitles[0].from.all_as_seconds());
 139 }
 140
 141 ContentTime
 142 StringTextFile::length () const
 143 {
 144         if (_subtitles.empty ()) {
 145                 return {};
 146         }
 147
 148         return ContentTime::from_seconds (_subtitles.back().to.all_as_seconds ());
 149 }