Basic WebVTT subtitle support (#1361).
[dcpomatic.git] / 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/ssa_reader.h>
29 #include <sub/stl_binary_reader.h>
30 #include <sub/subrip_reader.h>
31 #include <sub/web_vtt_reader.h>
32 #include <unicode/ucsdet.h>
33 #include <unicode/ucnv.h>
34 #include <iostream>
35
36 #include "i18n.h"
37
38
39 using std::cout;
40 using std::shared_ptr;
41 using std::string;
42 using std::vector;
43 using boost::scoped_array;
44 using boost::optional;
45 using dcp::ArrayData;
46 using namespace dcpomatic;
47
48
49 StringTextFile::StringTextFile (shared_ptr<const StringTextFileContent> content)
50 {
51         string ext = content->path(0).extension().string();
52         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
53
54         std::unique_ptr<sub::Reader> reader;
55
56         if (ext == ".stl") {
57                 dcp::File f(content->path(0), "rb");
58                 if (!f) {
59                         throw OpenFileError (f.path(), errno, OpenFileError::READ);
60                 }
61                 try {
62                         reader.reset(new sub::STLBinaryReader(f.get()));
63                 } catch (...) {
64                         throw;
65                 }
66
67         } else {
68                 /* Text-based file; sort out its character encoding before we try to parse it */
69
70                 ArrayData in (content->path (0));
71
72                 UErrorCode status = U_ZERO_ERROR;
73                 UCharsetDetector* detector = ucsdet_open (&status);
74                 ucsdet_setText (detector, reinterpret_cast<const char *>(in.data()), in.size(), &status);
75
76                 UCharsetMatch const * match = ucsdet_detect (detector, &status);
77                 char const * in_charset = ucsdet_getName (match, &status);
78
79                 UConverter* to_utf16 = ucnv_open (in_charset, &status);
80                 /* This is a guess; I think we should be able to encode any input in 4 times its input size */
81                 scoped_array<uint16_t> utf16 (new uint16_t[in.size() * 2]);
82                 int const utf16_len = ucnv_toUChars (
83                                 to_utf16, reinterpret_cast<UChar*>(utf16.get()), in.size() * 2,
84                                 reinterpret_cast<const char *>(in.data()), in.size(),
85                                 &status
86                                 );
87
88                 UConverter* to_utf8 = ucnv_open ("UTF-8", &status);
89                 /* Another guess */
90                 scoped_array<char> utf8 (new char[utf16_len * 2]);
91                 ucnv_fromUChars (to_utf8, utf8.get(), utf16_len * 2, reinterpret_cast<UChar*>(utf16.get()), utf16_len, &status);
92
93                 /* Fix OS X line endings */
94                 size_t utf8_len = strlen (utf8.get ());
95                 for (size_t i = 0; i < utf8_len; ++i) {
96                         if (utf8[i] == '\r' && ((i == utf8_len - 1) || utf8[i + 1] != '\n')) {
97                                 utf8[i] = '\n';
98                         }
99                 }
100
101                 ucsdet_close (detector);
102                 ucnv_close (to_utf16);
103                 ucnv_close (to_utf8);
104
105                 if (ext == ".srt") {
106                         reader.reset(new sub::SubripReader(utf8.get()));
107                 } else if (ext == ".ssa" || ext == ".ass") {
108                         reader.reset(new sub::SSAReader(utf8.get()));
109                 } else if (ext == ".vtt") {
110                         reader.reset(new sub::WebVTTReader(utf8.get()));
111                 }
112         }
113
114         if (reader) {
115                 _subtitles = sub::collect<vector<sub::Subtitle>>(reader->subtitles());
116         }
117 }
118
119 /** @return time of first subtitle, if there is one */
120 optional<ContentTime>
121 StringTextFile::first () const
122 {
123         if (_subtitles.empty()) {
124                 return {};
125         }
126
127         return ContentTime::from_seconds(_subtitles[0].from.all_as_seconds());
128 }
129
130 ContentTime
131 StringTextFile::length () const
132 {
133         if (_subtitles.empty ()) {
134                 return {};
135         }
136
137         return ContentTime::from_seconds (_subtitles.back().to.all_as_seconds ());
138 }