-
Notifications
You must be signed in to change notification settings - Fork 261
/
Caption.cpp
416 lines (365 loc) · 18.3 KB
/
Caption.cpp
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
/**
* @file
* @brief Source file for Caption effect class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @ref License
*/
/* LICENSE
*
* Copyright (c) 2008-2019 OpenShot Studios, LLC
* <http://www.openshotstudios.com/>. This file is part of
* OpenShot Library (libopenshot), an open-source project dedicated to
* delivering high quality video editing and animation solutions to the
* world. For more information visit <http://www.openshot.org/>.
*
* OpenShot Library (libopenshot) is free software: you can redistribute it
* and/or modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* OpenShot Library (libopenshot) is distributed in the hope that it will be
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
*/
#include "Caption.h"
#include "../Clip.h"
#include "../Timeline.h"
using namespace openshot;
/// Blank constructor, useful when using Json to load the effect properties
Caption::Caption() : color("#ffffff"), stroke("#a9a9a9"), background("#ff000000"), background_alpha(0.0), left(0.25), top(0.7), right(0.1),
stroke_width(0.5), font_size(30.0), font_alpha(1.0), is_dirty(true), font_name("sans"), font(NULL), metrics(NULL),
fade_in(0.35), fade_out(0.35), background_corner(10.0), background_padding(20.0)
{
// Init effect properties
init_effect_details();
}
// Default constructor
Caption::Caption(Color color, std::string captions) :
color(color), caption_text(captions), stroke("#a9a9a9"), background("#ff000000"), background_alpha(0.0),
left(0.25), top(0.7), right(0.1), stroke_width(0.5), font_size(30.0), font_alpha(1.0), is_dirty(true), font_name("sans"),
font(NULL), metrics(NULL), fade_in(0.35), fade_out(0.35), background_corner(10.0), background_padding(20.0)
{
// Init effect properties
init_effect_details();
}
// Init effect settings
void Caption::init_effect_details()
{
/// Initialize the values of the EffectInfo struct.
InitEffectInfo();
/// Set the effect info
info.class_name = "Caption";
info.name = "Caption";
info.description = "Add text captions on top of your video.";
info.has_audio = false;
info.has_video = true;
}
// Set the caption string to use (see VTT format)
std::string Caption::CaptionText() {
return caption_text;
}
// Get the caption string
void Caption::CaptionText(std::string new_caption_text) {
caption_text = new_caption_text;
is_dirty = true;
}
// Process regex string only when dirty
void Caption::process_regex() {
if (is_dirty) {
is_dirty = false;
// Clear existing matches
matchedCaptions.clear();
// Parse regex and find all matches
QRegularExpression allPathsRegex(QStringLiteral("(\\d{2})?:*(\\d{2}):(\\d{2}).(\\d{2,3})\\s*-->\\s*(\\d{2})?:*(\\d{2}):(\\d{2}).(\\d{2,3})([\\s\\S]*?)\\n(.*?)(?=\\n\\d{2,3}|\\Z)"), QRegularExpression::MultilineOption);
QRegularExpressionMatchIterator i = allPathsRegex.globalMatch(QString(caption_text.c_str()));
while (i.hasNext()) {
QRegularExpressionMatch match = i.next();
if (match.hasMatch()) {
// Push all match objects into a vector (so we can reverse them later)
matchedCaptions.push_back(match);
}
}
}
}
// This method is required for all derived classes of EffectBase, and returns a
// modified openshot::Frame object
std::shared_ptr<openshot::Frame> Caption::GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number)
{
// Process regex (if needed)
process_regex();
// Get the Clip and Timeline pointers (if available)
Clip* clip = (Clip*) ParentClip();
Timeline* timeline = NULL;
Fraction fps;
double scale_factor = 1.0; // amount of scaling needed for text (based on preview window size)
if (clip->ParentTimeline() != NULL) {
timeline = (Timeline*) clip->ParentTimeline();
} else if (this->ParentTimeline() != NULL) {
timeline = (Timeline*) this->ParentTimeline();
}
// Get the FPS from the parent object (Timeline or Clip's Reader)
if (timeline != NULL) {
fps.num = timeline->info.fps.num;
fps.den = timeline->info.fps.den;
// preview window is sometimes smaller/larger than the timeline size
scale_factor = (double) timeline->preview_width / (double) timeline->info.width;
} else if (clip != NULL && clip->Reader() != NULL) {
fps.num = clip->Reader()->info.fps.num;
fps.den = clip->Reader()->info.fps.den;
scale_factor = 1.0;
}
// Get the frame's image
std::shared_ptr<QImage> frame_image = frame->GetImage();
// Load timeline's new frame image into a QPainter
QPainter painter(frame_image.get());
painter.setRenderHints(QPainter::Antialiasing | QPainter::SmoothPixmapTransform | QPainter::TextAntialiasing, true);
// Composite a new layer onto the image
painter.setCompositionMode(QPainter::CompositionMode_SourceOver);
// Font options and metrics for caption text
double font_size_value = font_size.GetValue(frame_number) * scale_factor;
QFont font(QString(font_name.c_str()), int(font_size_value));
font.setPointSizeF(std::max(font_size_value, 1.0));
QFontMetricsF metrics = QFontMetricsF(font);
// Get current keyframe values
double left_value = left.GetValue(frame_number);
double top_value = top.GetValue(frame_number);
double fade_in_value = fade_in.GetValue(frame_number) * fps.ToDouble();
double fade_out_value = fade_out.GetValue(frame_number) * fps.ToDouble();
double right_value = right.GetValue(frame_number);
double background_corner_value = background_corner.GetValue(frame_number);
double padding_value = background_padding.GetValue(frame_number);
// Calculate caption area (based on left, top, and right margin)
double left_margin_x = frame_image->width() * left_value;
double starting_y = (frame_image->height() * top_value) + (metrics.lineSpacing() * scale_factor);
double right_margin_x = frame_image->width() - (frame_image->width() * right_value);
double caption_area_width = right_margin_x - left_margin_x;
QRectF caption_area = QRectF(left_margin_x, starting_y, caption_area_width, frame_image->height());
QRectF caption_area_with_padding = QRectF(left_margin_x - (padding_value / 2.0), starting_y - (padding_value / 2.0), caption_area_width + padding_value, frame_image->height() + padding_value);
// Set background color of caption
QBrush brush;
QColor background_qcolor = QColor(QString(background.GetColorHex(frame_number).c_str()));
background_qcolor.setAlphaF(background_alpha.GetValue(frame_number));
brush.setColor(background_qcolor);
brush.setStyle(Qt::SolidPattern);
painter.setBrush(brush);
painter.setPen(Qt::NoPen);
painter.drawRoundedRect(caption_area_with_padding, background_corner_value, background_corner_value);
// Set text color of caption
QPen pen;
QColor stroke_qcolor;
if (stroke_width.GetValue(frame_number) <= 0.0) {
// No stroke
painter.setPen(Qt::NoPen);
} else {
// Stroke color
stroke_qcolor = QColor(QString(stroke.GetColorHex(frame_number).c_str()));
stroke_qcolor.setAlphaF(font_alpha.GetValue(frame_number));
pen.setColor(stroke_qcolor);
pen.setWidthF(stroke_width.GetValue(frame_number) * scale_factor);
painter.setPen(pen);
}
// Fill color of text
QColor font_qcolor = QColor(QString(color.GetColorHex(frame_number).c_str()));
font_qcolor.setAlphaF(font_alpha.GetValue(frame_number));
brush.setColor(font_qcolor);
painter.setBrush(brush);
// Loop through matches and find text to display (if any)
for (auto match = matchedCaptions.begin(); match != matchedCaptions.end(); match++) {
// Build timestamp (00:00:04.000 --> 00:00:06.500)
int64_t start_frame = ((match->captured(1).toFloat() * 60.0 * 60.0 ) + (match->captured(2).toFloat() * 60.0 ) +
match->captured(3).toFloat() + (match->captured(4).toFloat() / 1000.0)) * fps.ToFloat();
int64_t end_frame = ((match->captured(5).toFloat() * 60.0 * 60.0 ) + (match->captured(6).toFloat() * 60.0 ) +
match->captured(7).toFloat() + (match->captured(8).toFloat() / 1000.0)) * fps.ToFloat();
// Split multiple lines into separate paths
QStringList lines = match->captured(9).split("\n");
for(int index = 0; index < lines.length(); index++) {
// Multi-line
QString line = lines[index];
// Ignore lines that start with NOTE, or are <= 1 char long
if (!line.startsWith(QStringLiteral("NOTE")) &&
!line.isEmpty() && frame_number >= start_frame && frame_number <= end_frame &&
!line.length() <= 1 ) {
// Calculate fade in/out ranges
double fade_in_percentage = ((float) frame_number - (float) start_frame) / fade_in_value;
double fade_out_percentage = 1.0 - (((float) frame_number - ((float) end_frame - fade_out_value)) / fade_out_value);
if (fade_in_percentage < 1.0) {
// Fade in
font_qcolor.setAlphaF(fade_in_percentage * font_alpha.GetValue(frame_number));
stroke_qcolor.setAlphaF(fade_in_percentage * font_alpha.GetValue(frame_number));
} else if (fade_out_percentage >= 0.0 && fade_out_percentage <= 1.0) {
// Fade out
font_qcolor.setAlphaF(fade_out_percentage * font_alpha.GetValue(frame_number));
stroke_qcolor.setAlphaF(fade_out_percentage * font_alpha.GetValue(frame_number));
}
pen.setColor(stroke_qcolor);
brush.setColor(font_qcolor);
painter.setPen(pen);
painter.setBrush(brush);
// Loop through words, and find word-wrap boundaries
QStringList words = line.split(" ");
int words_remaining = words.length();
while (words_remaining > 0) {
bool words_displayed = false;
for(int word_index = words.length(); word_index > 0; word_index--) {
// Current matched caption string (from the beginning to the current word index)
QString fitting_line = words.mid(0, word_index).join(" ");
// Calculate size of text
QRectF textRect = metrics.boundingRect(caption_area, Qt::TextSingleLine, fitting_line);
if (textRect.width() <= caption_area.width()) {
// Location for text
QPoint p(left_margin_x, starting_y);
// Draw text onto path (for correct border and fill)
QPainterPath path1;
QString fitting_line = words.mid(0, word_index).join(" ");
path1.addText(p, font, fitting_line);
painter.drawPath(path1);
// Increment QPoint to height of text (for next line) + padding
starting_y += path1.boundingRect().height() + (metrics.lineSpacing() * scale_factor);
// Update line (to remove words already drawn
words = words.mid(word_index, words.length());
words_remaining = words.length();
words_displayed = true;
break;
}
}
if (words_displayed == false) {
// Exit loop if no words displayed
words_remaining = 0;
}
}
}
}
}
// End painter
painter.end();
// return the modified frame
return frame;
}
// Generate JSON string of this object
std::string Caption::Json() const {
// Return formatted string
return JsonValue().toStyledString();
}
// Generate Json::Value for this object
Json::Value Caption::JsonValue() const {
// Create root json object
Json::Value root = EffectBase::JsonValue(); // get parent properties
root["type"] = info.class_name;
root["color"] = color.JsonValue();
root["stroke"] = stroke.JsonValue();
root["background"] = background.JsonValue();
root["background_alpha"] = background_alpha.JsonValue();
root["background_corner"] = background_corner.JsonValue();
root["background_padding"] = background_padding.JsonValue();
root["stroke_width"] = stroke_width.JsonValue();
root["font_size"] = font_size.JsonValue();
root["font_alpha"] = font_alpha.JsonValue();
root["fade_in"] = fade_in.JsonValue();
root["fade_out"] = fade_out.JsonValue();
root["left"] = left.JsonValue();
root["top"] = top.JsonValue();
root["right"] = right.JsonValue();
root["caption_text"] = caption_text;
root["caption_font"] = font_name;
// return JsonValue
return root;
}
// Load JSON string into this object
void Caption::SetJson(const std::string value) {
// Parse JSON string into JSON objects
try
{
const Json::Value root = openshot::stringToJson(value);
// Set all values that match
SetJsonValue(root);
}
catch (const std::exception& e)
{
// Error parsing JSON (or missing keys)
throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
}
}
// Load Json::Value into this object
void Caption::SetJsonValue(const Json::Value root) {
// Set parent data
EffectBase::SetJsonValue(root);
// Set data from Json (if key is found)
if (!root["color"].isNull())
color.SetJsonValue(root["color"]);
if (!root["stroke"].isNull())
stroke.SetJsonValue(root["stroke"]);
if (!root["background"].isNull())
background.SetJsonValue(root["background"]);
if (!root["background_alpha"].isNull())
background_alpha.SetJsonValue(root["background_alpha"]);
if (!root["background_corner"].isNull())
background_corner.SetJsonValue(root["background_corner"]);
if (!root["background_padding"].isNull())
background_padding.SetJsonValue(root["background_padding"]);
if (!root["stroke_width"].isNull())
stroke_width.SetJsonValue(root["stroke_width"]);
if (!root["font_size"].isNull())
font_size.SetJsonValue(root["font_size"]);
if (!root["font_alpha"].isNull())
font_alpha.SetJsonValue(root["font_alpha"]);
if (!root["fade_in"].isNull())
fade_in.SetJsonValue(root["fade_in"]);
if (!root["fade_out"].isNull())
fade_out.SetJsonValue(root["fade_out"]);
if (!root["left"].isNull())
left.SetJsonValue(root["left"]);
if (!root["top"].isNull())
top.SetJsonValue(root["top"]);
if (!root["right"].isNull())
right.SetJsonValue(root["right"]);
if (!root["caption_text"].isNull())
caption_text = root["caption_text"].asString();
if (!root["caption_font"].isNull())
font_name = root["caption_font"].asString();
// Mark effect as dirty to reparse Regex
is_dirty = true;
}
// Get all properties for a specific frame
std::string Caption::PropertiesJSON(int64_t requested_frame) const {
// Generate JSON properties list
Json::Value root;
root["id"] = add_property_json("ID", 0.0, "string", Id(), NULL, -1, -1, true, requested_frame);
root["position"] = add_property_json("Position", Position(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
root["layer"] = add_property_json("Track", Layer(), "int", "", NULL, 0, 20, false, requested_frame);
root["start"] = add_property_json("Start", Start(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
root["end"] = add_property_json("End", End(), "float", "", NULL, 0, 1000 * 60 * 30, false, requested_frame);
root["duration"] = add_property_json("Duration", Duration(), "float", "", NULL, 0, 1000 * 60 * 30, true, requested_frame);
// Keyframes
root["color"] = add_property_json("Color", 0.0, "color", "", NULL, 0, 255, false, requested_frame);
root["color"]["red"] = add_property_json("Red", color.red.GetValue(requested_frame), "float", "", &color.red, 0, 255, false, requested_frame);
root["color"]["blue"] = add_property_json("Blue", color.blue.GetValue(requested_frame), "float", "", &color.blue, 0, 255, false, requested_frame);
root["color"]["green"] = add_property_json("Green", color.green.GetValue(requested_frame), "float", "", &color.green, 0, 255, false, requested_frame);
root["stroke"] = add_property_json("Border", 0.0, "color", "", NULL, 0, 255, false, requested_frame);
root["stroke"]["red"] = add_property_json("Red", stroke.red.GetValue(requested_frame), "float", "", &stroke.red, 0, 255, false, requested_frame);
root["stroke"]["blue"] = add_property_json("Blue", stroke.blue.GetValue(requested_frame), "float", "", &stroke.blue, 0, 255, false, requested_frame);
root["stroke"]["green"] = add_property_json("Green", stroke.green.GetValue(requested_frame), "float", "", &stroke.green, 0, 255, false, requested_frame);
root["background_alpha"] = add_property_json("Background Alpha", background_alpha.GetValue(requested_frame), "float", "", &background_alpha, 0.0, 1.0, false, requested_frame);
root["background_corner"] = add_property_json("Background Corner Radius", background_corner.GetValue(requested_frame), "float", "", &background_corner, 0.0, 60.0, false, requested_frame);
root["background_padding"] = add_property_json("Background Padding", background_padding.GetValue(requested_frame), "float", "", &background_padding, 0.0, 60.0, false, requested_frame);
root["background"] = add_property_json("Background", 0.0, "color", "", NULL, 0, 255, false, requested_frame);
root["background"]["red"] = add_property_json("Red", background.red.GetValue(requested_frame), "float", "", &background.red, 0, 255, false, requested_frame);
root["background"]["blue"] = add_property_json("Blue", background.blue.GetValue(requested_frame), "float", "", &background.blue, 0, 255, false, requested_frame);
root["background"]["green"] = add_property_json("Green", background.green.GetValue(requested_frame), "float", "", &background.green, 0, 255, false, requested_frame);
root["stroke_width"] = add_property_json("Stroke Width", stroke_width.GetValue(requested_frame), "float", "", &stroke_width, 0, 10.0, false, requested_frame);
root["font_size"] = add_property_json("Font Size", font_size.GetValue(requested_frame), "float", "", &font_size, 0, 200.0, false, requested_frame);
root["font_alpha"] = add_property_json("Font Alpha", font_alpha.GetValue(requested_frame), "float", "", &font_alpha, 0.0, 1.0, false, requested_frame);
root["fade_in"] = add_property_json("Fade In (Seconds)", fade_in.GetValue(requested_frame), "float", "", &fade_in, 0.0, 3.0, false, requested_frame);
root["fade_out"] = add_property_json("Fade Out (Seconds)", fade_out.GetValue(requested_frame), "float", "", &fade_out, 0.0, 3.0, false, requested_frame);
root["left"] = add_property_json("Left Size", left.GetValue(requested_frame), "float", "", &left, 0.0, 0.5, false, requested_frame);
root["top"] = add_property_json("Top Size", top.GetValue(requested_frame), "float", "", &top, 0.0, 1.0, false, requested_frame);
root["right"] = add_property_json("Right Size", right.GetValue(requested_frame), "float", "", &right, 0.0, 0.5, false, requested_frame);
root["caption_text"] = add_property_json("Captions", 0.0, "string", caption_text, NULL, -1, -1, false, requested_frame);
root["caption_font"] = add_property_json("Font", 0.0, "string", font_name, NULL, -1, -1, false, requested_frame);
// Return formatted string
return root.toStyledString();
}