1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
/*
SPDX-FileCopyrightText: 2022 Jean-Baptiste Mardelle <jb@kdenlive.org>
SPDX-FileCopyrightText: 2022 Eric Jiang
SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
*/
#include "catch.hpp"
#include "test_utils.hpp"
// test specific headers
#include "core.h"
#include "definitions.h"
#include "doc/docundostack.hpp"
#include "doc/kdenlivedoc.h"
using namespace fakeit;
TEST_CASE("Read subtitle file", "[Subtitles]")
{
// Create timeline
auto binModel = pCore->projectItemModel();
binModel->clean();
std::shared_ptr<DocUndoStack> undoStack = std::make_shared<DocUndoStack>(nullptr);
// Here we do some trickery to enable testing.
// We mock the project class so that the undoStack function returns our undoStack
pCore->setCurrentProfile(QStringLiteral("dv_pal"));
KdenliveDoc document(undoStack);
pCore->projectManager()->testSetDocument(&document);
QDateTime documentDate = QDateTime::currentDateTime();
KdenliveTests::updateTimeline(false, QString(), QString(), documentDate, 0);
auto timeline = document.getTimeline(document.uuid());
pCore->projectManager()->testSetActiveTimeline(timeline);
KdenliveTests::resetNextId();
QDir dir = QDir::temp();
QString documentId = QString::number(QDateTime::currentMSecsSinceEpoch());
document.setDocumentProperty(QStringLiteral("documentid"), documentId);
// Initialize subtitle model
std::shared_ptr<SubtitleModel> subtitleModel = timeline->createSubtitleModel();
SECTION("Load a subtitle file")
{
QString subtitleFile = sourcesPath + "/dataset/01.srt";
bool ok;
QByteArray guessedEncoding = SubtitleModel::guessFileEncoding(subtitleFile, &ok);
CHECK(guessedEncoding == "UTF-8");
subtitleModel->importSubtitle(subtitleFile, 0, false, 30.00, 30.00, guessedEncoding);
// Ensure the 3 dialogues are loaded
REQUIRE(subtitleModel->rowCount() == 3);
QList<std::pair<std::pair<int, GenTime>, SubtitleEvent>> allSubs = subtitleModel->getAllSubtitles();
QList<GenTime> sTime;
QList<GenTime> controleTime;
controleTime << GenTime(140, 25) << GenTime(265, 25) << GenTime(503, 25) << GenTime(628, 25) << GenTime(628, 25) << GenTime(875, 25);
QStringList subtitlesText;
QStringList control = {QStringLiteral("J'hésite à vérifier"), QStringLiteral("Ce test de sous-titres"), QStringLiteral("!! Quand même !!")};
for (const auto &s : std::as_const(allSubs)) {
subtitlesText << s.second.text();
sTime << s.first.second;
sTime << s.second.endTime();
}
// Ensure the texts are read correctly
REQUIRE(subtitlesText == control);
// Ensure timing is correct
REQUIRE(sTime == controleTime);
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
}
// TODO: qt6 fix
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
SECTION("Load a non-UTF-8 subtitle")
{
QString subtitleFile = sourcesPath + "/dataset/01-iso-8859-1.srt";
bool ok;
QByteArray guessedEncoding = SubtitleModel::guessFileEncoding(subtitleFile, &ok);
qDebug() << "Guessed encoding: " << guessedEncoding;
subtitleModel->importSubtitle(subtitleFile, 0, false, 30.00, 30.00, guessedEncoding);
// Ensure the 3 dialogues are loaded
REQUIRE(subtitleModel->rowCount() == 3);
QList<std::pair<std::pair<int, GenTime>, SubtitleEvent>> allSubs = subtitleModel->getAllSubtitles();
QStringList subtitlesText;
QStringList control = {QStringLiteral("J'hésite à vérifier"), QStringLiteral("Ce test de sous-titres"), QStringLiteral("!! Quand même !!")};
for (const auto &s : std::as_const(allSubs)) {
subtitlesText << s.second.text();
}
// Ensure that non-ASCII characters are read correctly
CHECK(subtitlesText == control);
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
}
#endif
SECTION("Load ASS file with commas")
{
QString subtitleFile = sourcesPath + "/dataset/subs-with-commas.ass";
bool ok;
QByteArray guessedEncoding = SubtitleModel::guessFileEncoding(subtitleFile, &ok);
qDebug() << "Guessed encoding: " << guessedEncoding;
subtitleModel->importSubtitle(subtitleFile, 0, false, 30.00, 30.00, guessedEncoding);
// Ensure all 2 lines are loaded
REQUIRE(subtitleModel->rowCount() == 2);
QList<std::pair<std::pair<int, GenTime>, SubtitleEvent>> allSubs = subtitleModel->getAllSubtitles();
QStringList subtitlesText;
QStringList control = {QStringLiteral("Line with one comma, second part."), QStringLiteral("Line with two commas, second part, third part.")};
for (const auto &s : std::as_const(allSubs)) {
subtitlesText << s.second.text();
}
// Ensure that non-ASCII characters are read correctly
CHECK(subtitlesText == control);
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
}
SECTION("Load a broken subtitle file")
{
QString subtitleFile = sourcesPath + "/dataset/02.srt";
subtitleModel->importSubtitle(subtitleFile);
// Ensure the 2 dialogues are loaded
REQUIRE(subtitleModel->rowCount() == 2);
QList<std::pair<std::pair<int, GenTime>, SubtitleEvent>> allSubs = subtitleModel->getAllSubtitles();
QList<GenTime> sTime;
QList<GenTime> controleTime;
controleTime << GenTime(140, 25) << GenTime(265, 25) << GenTime(628, 25) << GenTime(875, 25);
QStringList subtitlesText;
QStringList control = {QStringLiteral("J'hésite à vérifier"), QStringLiteral("!! Quand même !!")};
for (const auto &s : allSubs) {
subtitlesText << s.second.text();
sTime << s.first.second;
sTime << s.second.endTime();
}
// Ensure the texts are read correctly
REQUIRE(subtitlesText == control);
// Ensure timing is correct
REQUIRE(sTime == controleTime);
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
}
SECTION("Preserve multiple spaces in subtitles")
{
QString subtitleFile = sourcesPath + "/dataset/multiple-spaces.srt";
subtitleModel->importSubtitle(subtitleFile);
const QList<std::pair<std::pair<int, GenTime>, SubtitleEvent>> allSubs = subtitleModel->getAllSubtitles();
CHECK(allSubs.at(0).second.text().toStdString() == "three spaces");
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
}
SECTION("Load SBV subtitle file")
{
QString subtitleFile = sourcesPath + "/dataset/01.sbv";
subtitleModel->importSubtitle(subtitleFile);
// Ensure the 3 dialogues are loaded
REQUIRE(subtitleModel->rowCount() == 3);
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
}
SECTION("Load VTT subtitle file")
{
QString subtitleFile = sourcesPath + "/dataset/01.vtt";
subtitleModel->importSubtitle(subtitleFile);
// Ensure the 2 dialogues are loaded
REQUIRE(subtitleModel->rowCount() == 2);
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
}
SECTION("Load SRT subtitle file with two dots")
{
QString subtitleFile = sourcesPath + "/dataset/subs-with-two-dots.srt";
subtitleModel->importSubtitle(subtitleFile);
// Ensure the 2 dialogues are loaded
REQUIRE(subtitleModel->rowCount() == 2);
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
}
SECTION("Ensure 2 subtitles cannot be place at same frame position")
{
// In our current implementation, having 2 subtitles at same start time is not allowed
int subId = KdenliveTests::getNextId();
int subId2 = KdenliveTests::getNextId();
int subId3 = KdenliveTests::getNextId();
double fps = pCore->getCurrentFps();
REQUIRE(subtitleModel->addSubtitle(subId, {0, GenTime(50, fps)},
SubtitleEvent(true, GenTime(70, fps), "Default", "", 0, 0, 0, "", QStringLiteral("Hello")), false, false));
REQUIRE(subtitleModel->addSubtitle(subId2, {0, GenTime(50, fps)},
SubtitleEvent(true, GenTime(90, fps), "Default", "", 0, 0, 0, "", QStringLiteral("Hello2")), false, false) == false);
REQUIRE(subtitleModel->addSubtitle(subId3, {0, GenTime(100, fps)},
SubtitleEvent(true, GenTime(140, fps), "Default", "", 0, 0, 0, "", QStringLiteral("Second")), false, false));
REQUIRE(subtitleModel->rowCount() == 2);
REQUIRE(subtitleModel->moveSubtitle(subId, 0, GenTime(100, fps), false, false) == false);
REQUIRE(subtitleModel->moveSubtitle(subId, 0, GenTime(300, fps), false, false));
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
}
SECTION("Ensure we cannot cut overlapping subtitles (it would create 2 subtitles at same frame position")
{
// In our current implementation, having 2 subtitles at same start time is not allowed
int subId = KdenliveTests::getNextId();
int subId2 = KdenliveTests::getNextId();
double fps = pCore->getCurrentFps();
REQUIRE(subtitleModel->addSubtitle(subId, {0, GenTime(50, fps)},
SubtitleEvent(true, GenTime(70, fps), "Default", "", 0, 0, 0, "", QStringLiteral("Hello")), false, false));
REQUIRE(subtitleModel->addSubtitle(subId2, {0, GenTime(60, fps)},
SubtitleEvent(true, GenTime(90, fps), "Default", "", 0, 0, 0, "", QStringLiteral("Hello2")), false, false));
REQUIRE(subtitleModel->rowCount() == 2);
REQUIRE(timeline->requestClipsGroup({subId, subId2}));
REQUIRE_FALSE(TimelineFunctions::requestClipCut(timeline, subId, 65));
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
}
SECTION("Read start/end time of the subtitles")
{
// srt
QString subtitleFile = sourcesPath + "/dataset/01.srt";
subtitleModel->importSubtitle(subtitleFile);
// Ensure the 3 dialogues are loaded
REQUIRE(subtitleModel->rowCount() == 3);
QList<std::pair<std::pair<int, GenTime>, SubtitleEvent>> allSubs = subtitleModel->getAllSubtitles();
REQUIRE(allSubs.at(0).first.second.ms() - 5600 < 40);
REQUIRE(allSubs.at(0).second.endTime().ms() - 10600 < 40);
REQUIRE(allSubs.at(1).first.second.ms() - 20120 < 40);
REQUIRE(allSubs.at(1).second.endTime().ms() - 25120 < 40);
REQUIRE(allSubs.at(2).first.second.ms() - 25120 < 40);
REQUIRE(allSubs.at(2).second.endTime().ms() - 35000 < 40);
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
// sbv
subtitleFile = sourcesPath + "/dataset/01.sbv";
subtitleModel->importSubtitle(subtitleFile);
// Ensure the 3 dialogues are loaded
REQUIRE(subtitleModel->rowCount() == 3);
allSubs = subtitleModel->getAllSubtitles();
REQUIRE(allSubs.at(0).first.second.ms() - 150000 < 40);
REQUIRE(allSubs.at(0).second.endTime().ms() - 286000 < 40);
REQUIRE(allSubs.at(1).first.second.ms() - 342000 < 40);
REQUIRE(allSubs.at(1).second.endTime().ms() - 353000 < 40);
REQUIRE(allSubs.at(2).first.second.ms() - 411000 < 40);
REQUIRE(allSubs.at(2).first.second.ms() - 415000 < 40);
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
// vtt
subtitleFile = sourcesPath + "/dataset/01.vtt";
subtitleModel->importSubtitle(subtitleFile);
// Ensure the 2 dialogues are loaded
REQUIRE(subtitleModel->rowCount() == 2);
allSubs = subtitleModel->getAllSubtitles();
REQUIRE(allSubs.at(0).first.second.ms() - 600 < 40);
REQUIRE(allSubs.at(0).second.endTime().ms() - 2000 < 40);
REQUIRE(allSubs.at(1).first.second.ms() - 2400 < 40);
REQUIRE(allSubs.at(1).second.endTime().ms() - 4400 < 40);
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
// ASS
subtitleFile = sourcesPath + "/dataset/subs-with-commas.ass";
subtitleModel->importSubtitle(subtitleFile);
// Ensure the 2 dialogues are loaded
REQUIRE(subtitleModel->rowCount() == 2);
allSubs = subtitleModel->getAllSubtitles();
REQUIRE(allSubs.at(0).first.second.ms() - 580 < 40);
REQUIRE(allSubs.at(0).second.endTime().ms() - 2980 < 40);
REQUIRE(allSubs.at(1).first.second.ms() - 4330 < 40);
REQUIRE(allSubs.at(1).second.endTime().ms() - 9100 < 40);
subtitleModel->removeAllSubtitles();
REQUIRE(subtitleModel->rowCount() == 0);
}
binModel->clean();
pCore->projectManager()->closeCurrentDocument(false, false);
}
|
