-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Snap Captions.lua
1109 lines (960 loc) · 35.3 KB
/
Snap Captions.lua
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
-- Copyright (C) 2023 Orson Lord & Dan Knowlton
--
-- Snap Captions v1.4
-- This tool automates the process of creating Text+ clips from subtitle
-- clips.
--
-- If you find this tool useful, please consider donating to support its
-- development: https://bit.ly/SnapCaptions
--
-- This software can not be redistributed or sold without the express
-- permission of the authors.
local utf8 = string
local hasUtf8Support = false
local ui = fu.UIManager
local disp = bmd.UIDispatcher(ui)
local winID = "SnapCaptionsWin"
local projectManager = resolve:GetProjectManager()
local project = projectManager:GetCurrentProject()
local mediaPool = project:GetMediaPool()
local fusion_titles = {}
local TEXT_TEMPLATE_FOLDER = "Snap Captions"
local platform = (FuPLATFORM_WINDOWS and "Windows") or
(FuPLATFORM_MAC and "Mac") or
(FuPLATFORM_LINUX and "Linux")
local function script_path()
return debug.getinfo(2, "S").source:sub(2)
end
local function ScriptIsInstalled()
local script_path = script_path()
if platform == "Windows" then
local match1 = script_path:find("\\Blackmagic Design\\DaVinci Resolve\\Support\\Fusion\\Scripts")
local match2 = script_path:find("\\Blackmagic Design\\DaVinci Resolve\\Fusion\\Scripts")
return match1 ~= nil or match2 ~= nil
elseif platform == "Mac" then
local match1 = script_path:find("/Library/Application Support/Blackmagic Design/DaVinci Resolve/Fusion/Scripts")
return match1 ~= nil
else
local match1 = script_path:find("resolve/Fusion/Scripts")
local match2 = script_path:find("resolve/Fusion/Scripts")
local match3 = script_path:find("/DaVinciResolve/Fusion/Scripts")
return match1 ~= nil or match2 ~= nil or match3 ~= nil
end
end
local SCRIPT_INSTALLED = ScriptIsInstalled()
local function LoadUTF8Module()
-- Remove any previously loaded utf8 module.
package.loaded.utf8_snapcaptions = nil
hasUtf8Support, utf8 = pcall(require, "utf8_snapcaptions")
if not hasUtf8Support and SCRIPT_INSTALLED then
print("[WARNING]: Snap Captions utf8 module could not be loaded. " ..
"Please ensure that the utf8_snapcaptions.lua file exists in " ..
"the Modules/Lua folder.")
utf8 = string
end
end
LoadUTF8Module()
local COLUMN_WIDTH = 130
local WINDOW_WIDTH = 320
local WINDOW_HEIGHT = 356
local COMBOBOX_ACTION_BUTTON_CSS = [[
QPushButton
{
border: 1px solid rgb(0,0,0);
border-top-right-radius: 4px;
border-bottom-right-radius: 4px;
border-top-left-radius: 0px;
border-bottom-left-radius: 0px;
border-left: 0px;
font-size: 22px;
min-height: 26px;
max-height: 26px;
min-width: 26px;
max-width: 26px;
background-color: rgb(31,31,31);
}
QPushButton:hover
{
color: rgb(255, 255, 255);
}
QPushButton:pressed
{
background-color: rgb(20,20,20);
}
]]
local SECTION_TITLE_CSS = [[
QLabel
{
color: rgb(255, 255, 255);
font-size: 13px;
font-weight: bold;
}
QLabel:!enabled
{
color: rgb(150, 150, 150);
}
]]
local BANNER_ACTION_BUTTON_CSS = [[
QPushButton
{
max-height: 20px;
min-height: 20px;
color: rgb(200, 200, 200);
font-size: 12px;
min-width: 80px;
}
]]
local PRIMARY_ACTION_BUTTON_CSS = [[
QPushButton
{
border: 1px solid rgb(51,176,74);
max-height: 28px;
border-radius: 14px;
background-color: rgb(51,176,74);
color: rgb(255, 255, 255);
min-height: 28px;
font-size: 13px;
}
QPushButton:hover
{
border: 2px solid rgb(40,140,59);
background-color: rgb(40,140,59);
}
QPushButton:pressed
{
border: 2px solid rgb(36,126,53);
background-color: rgb(36,126,53);
}
QPushButton:!enabled
{
border: 2px solid rgb(36,126,53);
background-color: rgb(36,126,53);
color: rgb(150, 150, 150);
}
]]
local SECONDARY_ACTION_BUTTON_CSS = [[
QPushButton
{
max-height: 24px;
min-height: 24px;
}
]]
local DIVIDER_CSS = [[
QFrame[frameShape="4"]
{
border: none;
background-color: rgb(30, 30, 30);
max-height: 1px;
}
]]
local COMBOBOX_PLACEHOLDER_CSS = [[
QLabel
{
color: rgb(140, 140, 140);
font-size: 13px;
min-height: 26px;
max-height: 26px;
background-color: rgb(31,31,31);
border: 1px solid rgb(0,0,0);
border-top-right-radius: 0px;
border-bottom-right-radius: 0px;
border-top-left-radius: 4px;
border-bottom-left-radius: 4px;
padding-left: 4px;
}
]]
local DONATE_URL = "https://bit.ly/SnapCaptions"
local TUTORIAL_URL = "https://bit.ly/SnapCaptionsTutorial"
local timeline_type_names = {}
timeline_type_names["Timeline"] = true
timeline_type_names["タイムライン"] = true
timeline_type_names["时间线"] = true
timeline_type_names["Línea de tiempo"] = true
timeline_type_names["Linha de Tempo"] = true
timeline_type_names["Временная шкала"] = true
timeline_type_names["ไทม์ไลน์"] = true
timeline_type_names["타임라인"] = true
local function OpenURL(url)
if bmd.openurl then
bmd.openurl(url)
print("[Opening URL] " .. url)
end
end
local function ClearTable(table)
for k in pairs(table) do
table[k] = nil
end
end
local function EndDispLoop()
local win = ui:FindWindow(winID)
if win ~= nil then
return
end
disp:ExitLoop()
end
local function CreateDialog(title, message)
local position = {nil, nil}
local win = ui:FindWindow(winID)
if win ~= nil then
position = {win.Geometry[1] + 10, win.Geometry[2] + 150}
end
local dialog = disp:AddWindow({
ID = "SnapCaptionsDialog",
WindowTitle = "Snap Captions | Error",
WindowModality = "ApplicationModal",
Geometry = {position[1], position[2], 300, 100},
FixedSize = {300, 100},
Margin = 16,
ui:VGroup
{
ID = "root",
Spacing = 4,
FixedX = 300,
FixedY = 100,
ui:Label
{
Weight = 0,
ID = "error_title",
Text = title,
Alignment = { AlignHCenter = true, AlignBottom = true},
WordWrap = true,
StyleSheet = [[
QLabel {
color: rgb(255, 255, 255);
font-size: 13px;
font-weight: bold;
}
]]
},
ui:Label
{
Weight = 10,
ID = "error_message",
Text = message,
WordWrap = true,
Alignment = { AlignHCenter = true, AlignTop = true }
},
ui:VGap(0, 1),
ui:HGroup
{
Weight = 0,
ui:Button{ ID = "OK",
Text = "OK",
StyleSheet = SECONDARY_ACTION_BUTTON_CSS
}
}
}
})
function dialog.On.OK.Clicked(ev)
dialog:Hide()
dialog = nil
EndDispLoop()
end
function dialog.On.SnapCaptionsDialog.Close(ev)
dialog:Hide()
dialog = nil
EndDispLoop()
end
return dialog
end
local function CopyFile(source, target)
local source_file = io.open(source, "r")
local contents = source_file:read("*a")
source_file:close()
local target_file = io.open(target, "w")
if target_file == nil then
return false
end
target_file:write(contents)
target_file:close()
return true
end
local function InstallScript()
local source_path = script_path()
local target_path = nil
local modules_path = nil
if platform == "Windows" then
target_path = os.getenv("APPDATA") .. "\\Blackmagic Design\\DaVinci Resolve\\Support\\Fusion\\Scripts\\Comp\\"
modules_path = os.getenv("APPDATA") .. "\\Blackmagic Design\\DaVinci Resolve\\Support\\Fusion\\Modules\\Lua\\"
elseif platform == "Mac" then
target_path = os.getenv("HOME") .. "/Library/Application Support/Blackmagic Design/DaVinci Resolve/Fusion/Scripts/Comp/"
modules_path = os.getenv("HOME") .. "/Library/Application Support/Blackmagic Design/DaVinci Resolve/Fusion/Modules/Lua/"
else
target_path = os.getenv("HOME") .. "/.local/share/DaVinciResolve/Fusion/Scripts/Comp/"
modules_path = os.getenv("HOME") .. "/.local/share/DaVinciResolve/Fusion/Modules/Lua/"
end
local script_name = source_path:match(".*[/\\](.*)")
target_path = target_path .. script_name
-- Copy the file.
local success = CopyFile(source_path, target_path)
if not success then
local dialog = CreateDialog("Failed to install Snap Captions",
"Snap Captions could not be installed automatically. " ..
"Please manually copy to the Scripts/Comp folder.")
dialog:Show()
dialog:RecalcLayout()
return false
end
-- Also copy the utf8 modules to the Modules folder.
local utf8_source = source_path:match("(.*[/\\]).+$") .. "utf8_snapcaptions.lua"
local utf8_target = modules_path .. "utf8_snapcaptions.lua"
success = CopyFile(utf8_source, utf8_target)
if success then
-- Reload the utf8 module.
LoadUTF8Module()
end
print("[Snap Captions] Installed to " .. target_path)
return true
end
local function PopulateSubtitleTracks(win)
local combobox = win:Find("subtitle_tracks")
local subtitle_stack = win:Find("subtitle_stack")
local subtitle_placeholder = win:Find("subtitle_placeholder")
combobox:Clear()
local timeline = project:GetCurrentTimeline()
local track_count = timeline:GetTrackCount("subtitle")
if track_count == 0 then
combobox:SetEnabled(false)
subtitle_stack:SetCurrentIndex(1)
combobox:SetVisible(false)
subtitle_placeholder:SetVisible(true)
return
end
subtitle_stack:SetCurrentIndex(0)
combobox:SetEnabled(true)
subtitle_placeholder:SetVisible(false)
combobox:SetVisible(true)
for i=1,track_count do
win:Find("subtitle_tracks"):AddItems(
{"[ST" .. i .. "] " .. timeline:GetTrackName("subtitle", i)})
end
end
local function PopulateTextTemplates(win)
ClearTable(fusion_titles)
local combobox = win:Find("title_templates")
local title_stack = win:Find("title_stack")
local title_placeholder = win:Find("title_placeholder")
combobox:Clear()
local template_folder = nil
for i, subfolder in ipairs(mediaPool:GetRootFolder():GetSubFolderList()) do
if subfolder:GetName() == TEXT_TEMPLATE_FOLDER then
template_folder = subfolder
break
end
end
if template_folder == nil or #template_folder:GetClipList() == 0 then
if template_folder == nil then
title_placeholder:SetText("No '" .. TEXT_TEMPLATE_FOLDER .. "' Bin Found")
else
title_placeholder:SetText("No Text+ Templates Found")
end
title_stack:SetCurrentIndex(1)
combobox:SetEnabled(false)
combobox:SetVisible(false)
title_placeholder:SetVisible(true)
return
end
title_stack:SetCurrentIndex(0)
combobox:SetEnabled(true)
title_placeholder:SetVisible(false)
combobox:SetVisible(true)
for i, clip in ipairs(template_folder:GetClipList()) do
-- Filter out items that are not Text+ templates.
if clip:GetClipProperty("File Path") == "" then
table.insert(fusion_titles, clip)
combobox:AddItems({clip:GetClipProperty("Clip Name")})
end
end
end
local function PopulateTextTransforms(win)
local transform_combobox = win:Find("text_transform")
transform_combobox:Clear()
transform_combobox:AddItems({"None"})
transform_combobox:AddItems({"To Lowercase"})
transform_combobox:AddItems({"To Uppercase"})
transform_combobox:AddItems({"Capitalize All Words"})
end
local function IsTimelineClip(clip)
local clip_type = clip:GetClipProperty("Type")
return timeline_type_names[clip_type] ~= nil
end
local function GetTimelineClipFromMediaPool(timeline_name, folder)
local folder = folder or mediaPool:GetRootFolder()
for i, clip in ipairs(folder:GetClipList()) do
if IsTimelineClip(clip) and
clip:GetClipProperty("Clip Name") == timeline_name then
return clip
end
end
for i, subfolder in ipairs(folder:GetSubFolderList()) do
local clip = GetTimelineClipFromMediaPool(timeline_name, subfolder)
if clip ~= nil then
return clip
end
end
return nil
end
local function ConvertTimecodeToFrame(timecode, fps, is_drop_frame, is_interlaced)
local time_pieces = {}
for str in string.gmatch(timecode, "(%d+)") do
table.insert(time_pieces, str)
end
local rounded_fps = math.floor(fps + 0.5)
local hours = tonumber(time_pieces[1])
local minutes = tonumber(time_pieces[2])
local seconds = tonumber(time_pieces[3])
local frame = (hours * 60 * 60 + minutes * 60 + seconds) * rounded_fps
local frame_count = tonumber(time_pieces[4])
if is_interlaced then
frame_count = frame_count * 2
local add_frame = timecode:find('%.') == nil and timecode:find(',') == nil
if add_frame then
frame_count = frame_count + 1
end
end
frame = frame + frame_count
if is_drop_frame then
local dropped_frames = math.floor(fps / 15 + 0.5)
local total_minutes = 60 * hours + minutes
frame = frame - (dropped_frames * (total_minutes - math.floor(total_minutes / 10)))
end
return frame
end
local function ConvertFrameToTimecode(frame, fps, is_drop_frame, is_interlaced)
local rounded_fps = math.floor(fps + 0.5)
if is_drop_frame then
local dropped_frames = math.floor(fps / 15 + 0.5)
local frames_per_ten = math.floor(fps * 60 * 10 + 0.5)
local frames_per_minute = (rounded_fps * 60) - dropped_frames
local d = math.floor(frame / frames_per_ten)
local m = math.fmod(frame, frames_per_ten)
if m > dropped_frames then
frame = frame + (dropped_frames * 9 * d) +
dropped_frames * math.floor((m - dropped_frames) / frames_per_minute)
else
frame = frame + dropped_frames * 9 * d
end
end
local frame_count = math.fmod(frame, rounded_fps)
local seconds = math.fmod(math.floor(frame / rounded_fps), 60)
local minutes = math.fmod(math.floor(math.floor(frame / rounded_fps) / 60), 60)
local hours = math.floor(math.floor(math.floor(frame / rounded_fps) / 60) / 60)
local frame_chars = string.len(tostring(rounded_fps - 1))
local frame_divider = ":"
local interlace_divider = "."
if is_drop_frame then
frame_divider = ";"
interlace_divider = ","
end
local format_string = "%02d:%02d:%02d" .. frame_divider .. "%0" .. frame_chars .. "d"
if is_interlaced then
local frame_mod = math.fmod(frame_count , 2)
frame_count = math.floor(frame_count / 2)
if frame_mod == 0 then
format_string = format_string:gsub("(.*)" .. frame_divider,
"%1" .. interlace_divider)
end
end
return string.format(format_string, hours, minutes, seconds, frame_count)
end
local function TimelineUsesDropFrameTimecodes(timeline)
return timeline:GetSetting("timelineDropFrameTimecode") == "1"
end
local function TimelineUsesInterlacedTimecodes(timeline)
return timeline:GetSetting("timelineInterlaceProcessing") == "1"
end
local function GetTimelineInOutTimecodes(timeline_clip, is_drop_frame, is_interlaced)
local in_out_set = true
local in_timecode = timeline_clip:GetClipProperty("In")
if in_timecode == "" then
in_timecode = timeline_clip:GetClipProperty("Start TC")
local frame_divider = ":"
local interlace_divider = "."
if is_drop_frame then
frame_divider = ";"
interlace_divider = ","
end
if is_interlaced then
in_timecode = in_timecode:gsub("(.*)" .. frame_divider,
"%1" .. interlace_divider)
end
end
local out_timecode = timeline_clip:GetClipProperty("Out")
if out_timecode == "" then
out_timecode = timeline_clip:GetClipProperty("End TC")
end
return in_timecode, out_timecode
end
local function ToTitleCase(first, rest)
return utf8.upper(first)..utf8.lower(rest)
end
local function ApplyTextTransform(text, transform)
if transform == "To Lowercase" then
return utf8.lower(text)
elseif transform == "To Uppercase" then
return utf8.upper(text)
elseif transform == "Capitalize All Words" then
return utf8.gsub(text, "(%a)([%w_']*)", ToTitleCase)
else
return text
end
end
local function GetSubtitleData(subtitle_track_index,
in_frame,
out_frame,
transform,
remove_punctuation)
local timeline = project:GetCurrentTimeline()
local subtitle_clips = timeline:GetItemsInTrack("subtitle", subtitle_track_index)
local subtitle_data = {}
local index = 1
for _, clip in ipairs(subtitle_clips) do
if clip:GetEnd() <= in_frame or clip:GetStart() >= out_frame then
goto continue
end
local start_frame = clip:GetStart()
if start_frame < in_frame then
start_frame = in_frame
end
local end_frame = clip:GetEnd()
if end_frame > out_frame then
end_frame = out_frame
end
subtitle_data[index] = {}
subtitle_data[index]["start"] = start_frame
subtitle_data[index]["end"] = end_frame
subtitle_data[index]["duration"] = end_frame - start_frame
local text = clip:GetName()
text = ApplyTextTransform(text, transform)
if remove_punctuation then
text = text:gsub("[.!?,:;-]", "")
text = text:gsub('["]', "")
end
-- Remove "invisible" UTF-8 line break
text = text:gsub("\u{2028}", "\n")
subtitle_data[index]["text"] = text
index = index + 1
::continue::
end
return subtitle_data
end
local function CreateTextPlusClips(win, subtitle_data, template_index, video_track)
if #subtitle_data == 0 then
return true
end
local fill_gaps = win:Find("fill_gaps").Checked
local max_fill = win:Find("max_fill").Value
local text_clip = fusion_titles[template_index]
-- First calculate a duration multiplier to ensure that any scaling triggered
-- by the Fusion comp does not affect the length of the clip (too much...).
local testClip = {}
local testDuration = 100
testClip["mediaPoolItem"] = text_clip
testClip["startFrame"] = 0
testClip["endFrame"] = testDuration - 1
testClip["trackIndex"] = video_track
testClip["recordFrame"] = subtitle_data[1]["start"]
local testItem = mediaPool:AppendToTimeline({testClip})[1]
local testDurationReal = testItem:GetDuration()
local timeline = project:GetCurrentTimeline()
timeline:DeleteClips({testItem}, false)
local duration_multiplier = testDuration / testDurationReal
for i, subtitle in ipairs(subtitle_data) do
local newClip = {}
newClip["mediaPoolItem"] = text_clip
newClip["startFrame"] = 0
newClip["endFrame"] = subtitle["duration"] - 1
-- If filling gaps, check if there is a gap between this subtitle and
-- the next one. If so, set the end of this subtitle to the start of
-- the next one.
if fill_gaps and i < #subtitle_data then
local next_title = subtitle_data[i+1]
local gap_size = next_title["start"] - subtitle["end"]
if gap_size > 0 and gap_size <= max_fill then
newClip["endFrame"] = newClip["endFrame"] + gap_size
end
end
-- Update based on the duration multiplier. This conteracts any
-- modifications to the clip length triggered by the Fusion comp.
local base_duration = newClip["endFrame"] - newClip["startFrame"] + 1
local new_duration = math.floor(base_duration * duration_multiplier + 0.999)
newClip["endFrame"] = new_duration - 1
newClip["trackIndex"] = video_track
newClip["recordFrame"] = subtitle["start"]
local timelineItem = mediaPool:AppendToTimeline({newClip})[1]
timelineItem:SetClipColor("Green")
if timelineItem:GetFusionCompCount() == 0 then
local dialog = CreateDialog("No Fusion Comp found in the template",
"Please ensure that the Text+ template contains a Fusion Comp and try again.")
dialog:Show()
dialog:RecalcLayout()
return false
end
local comp = timelineItem:GetFusionCompByIndex(1)
-- Check that the TextPlus tool exists in the comp.
local text_plus_tools = comp:GetToolList(false, "TextPlus")
if #text_plus_tools == 0 then
local dialog = CreateDialog("No Text+ Tool found in the template",
"Please ensure that the Text+ template contains a Text+ tool and try again.")
dialog:Show()
dialog:RecalcLayout()
return false
end
text_plus_tools[1]:SetInput("StyledText", subtitle["text"])
app:Sleep(0.005)
win:Repaint()
end
return true
end
local function GenerateTextPlus(win)
-- Get the selected subtitle track.
local subtitle_track_index = win:Find("subtitle_tracks").CurrentIndex + 1
if subtitle_track_index == 0 then
local dialog = CreateDialog("No Subtitle Track",
"Please create a subtitle track and try again.")
dialog:Show()
dialog:RecalcLayout()
return false
end
local text_template_index = win:Find("title_templates").CurrentIndex + 1
if text_template_index == 0 then
local dialog = CreateDialog("No Text+ Template",
"Please add a Text+ template to the Media Pool in a bin named '" .. TEXT_TEMPLATE_FOLDER .. "' and try again.")
dialog:Show()
dialog:RecalcLayout()
return false
end
local timeline = project:GetCurrentTimeline()
local is_interlaced = TimelineUsesInterlacedTimecodes(timeline)
local is_drop_frame = TimelineUsesDropFrameTimecodes(timeline)
local timeline_clip = GetTimelineClipFromMediaPool(timeline:GetName())
local in_timecode, out_timecode =
GetTimelineInOutTimecodes(timeline_clip, is_drop_frame, is_interlaced)
local fps = timeline_clip:GetClipProperty("FPS")
local in_frame = ConvertTimecodeToFrame(in_timecode, fps, is_drop_frame, is_interlaced)
local out_frame = ConvertTimecodeToFrame(out_timecode, fps, is_drop_frame, is_interlaced)
local transform = win:Find("text_transform").CurrentText
local remove_punctuation = win:Find("remove_punctuation").Checked
local subtitle_data = GetSubtitleData(subtitle_track_index,
in_frame,
out_frame,
transform,
remove_punctuation)
-- Create a new video track.
local track_created = timeline:AddTrack("video")
if not track_created then
local dialog = CreateDialog("AddTrack Failed",
"Failed to add a new video track to add captions to.")
dialog:Show()
dialog:RecalcLayout()
return false
end
local track_count = timeline:GetTrackCount("video")
local success = CreateTextPlusClips(win, subtitle_data, text_template_index, track_count)
if not success then
-- Delete the added track.
timeline:DeleteTrack("video", track_count)
else
timeline:SetTrackEnable("subtitle", subtitle_track_index, false)
end
-- Reset the In/Out points.
local timeline_clip = GetTimelineClipFromMediaPool(timeline:GetName())
if timeline_clip:GetClipProperty("In") ~= "" or
timeline_clip:GetClipProperty("Out") ~= "" then
-- Note: SetClipProperty does not correctly handle interlaced timecodes.
timeline_clip:SetClipProperty("In",
ConvertFrameToTimecode(in_frame+1, fps, is_drop_frame, false))
if is_interlaced then
in_timecode = ConvertFrameToTimecode(in_frame, fps, is_drop_frame, false)
end
timeline_clip:SetClipProperty("In", in_timecode)
end
return success
end
local function CreateToolWindow()
local win = disp:AddWindow(
{
ID = winID,
WindowTitle = "Snap Captions v1.4",
Geometry = {nil, nil, WINDOW_WIDTH, WINDOW_HEIGHT},
Margin = 16,
ui:VGroup
{
Spacing = 0,
ui:VGroup
{
Weight = 0,
ID = "install_bar",
Spacing = 0
},
ui:VGroup
{
ID = "root",
Spacing = 0,
FixedX = WINDOW_WIDTH,
FixedY = WINDOW_HEIGHT,
ui:Label
{
Text = "Source Subtitle Track",
StyleSheet = SECTION_TITLE_CSS,
},
ui:VGap(8, 0),
ui:HGroup
{
Spacing = 0,
ID = "subtitle_track_group",
ui:Stack
{
ID = "subtitle_stack",
CurrentIndex = 0,
ui:ComboBox
{
ID = "subtitle_tracks",
MinimumSize = {10, 26}
},
ui:Label
{
ID = "subtitle_placeholder",
Visible = false,
Text = "No subtitle tracks found",
StyleSheet = COMBOBOX_PLACEHOLDER_CSS
}
},
ui:Button
{
ID = "refresh_subtitle_tracks",
Text = "↺",
ToolTip = "Refresh Subtitle Track List",
StyleSheet = COMBOBOX_ACTION_BUTTON_CSS
}
},
ui:VGap(16, 0),
ui:Label
{
Text = "Text+ Template",
StyleSheet = SECTION_TITLE_CSS,
},
ui:VGap(8, 0),
ui:HGroup
{
Spacing = 0,
ui:Stack
{
ID = "title_stack",
CurrentIndex = 0,
ui:ComboBox
{
ID = "title_templates",
MinimumSize = {10, 26}
},
ui:Label
{
ID = "title_placeholder",
Visible = false,
Text = "No '" .. TEXT_TEMPLATE_FOLDER .. "' Bin Found",
ToolTip = "<qt>Add Text+ templates to the Media Pool in a Bin named '" .. TEXT_TEMPLATE_FOLDER .. "'</qt>",
StyleSheet = COMBOBOX_PLACEHOLDER_CSS
}
},
ui:Button
{
ID = "refresh_text_templates",
Text = "↺",
ToolTip = "Refresh Text+ Template List",
StyleSheet = COMBOBOX_ACTION_BUTTON_CSS
}
},
ui:VGap(16, 0),
ui:Label
{
FrameStyle = 4,
StyleSheet = DIVIDER_CSS
},
ui:Label
{
Text = "Customization",
StyleSheet = SECTION_TITLE_CSS,
},
ui:VGap(8, 0),
ui:HGroup
{
Spacing = 8,
ui:Label{ Text = "Case Conversion",
MinimumSize = {COLUMN_WIDTH, 0},
MaximumSize = {COLUMN_WIDTH, 1000},
Alignment = { AlignRight = true, AlignVCenter = true }},
ui:ComboBox{ ID = "text_transform",
MinimumSize = {10, 26} }
},
ui:VGap(8, 0),
ui:HGroup
{
Spacing = 8,
ui:Label{ Text = "Remove Punctuation",
MinimumSize = {COLUMN_WIDTH, 0},
MaximumSize = {COLUMN_WIDTH, 1000},
Alignment = { AlignRight = true, AlignVCenter = true }},
ui:CheckBox{ ID = "remove_punctuation",
Checked = false}
},
ui:VGap(8, 0),
ui:HGroup
{
Spacing = 8,
ui:Label{ Text = "Fill Gaps",
MinimumSize = {COLUMN_WIDTH, 0},
MaximumSize = {COLUMN_WIDTH, 1000},
Alignment = { AlignRight = true, AlignVCenter = true }},
ui:CheckBox{ ID = "fill_gaps",
Checked = true,
Events = { Toggled = true }},
ui:HGroup
{
Weight = 1,
ID = "max_fill_group",
Enabled = true,
ui:Label{ Text = "Max Fill",
Alignment = { AlignVCenter = true },
Weight = 0 },
ui.SpinBox{ ID = "max_fill",
Suffix = " Frames",
Minimum = 1,
Maximum = 9999,
Value = 10,
Weight = 1,
MinimumSize = {100, 26}}
}
},
ui:VGap(16, 10),
ui:Label
{
FrameStyle = 4,
StyleSheet = DIVIDER_CSS
},
ui:VGap(4, 0),
ui:HGroup
{
ui:Button{ ID = "process",
Text = "Generate",
StyleSheet = PRIMARY_ACTION_BUTTON_CSS
}
},
ui:VGap(12, 0),
ui:HGroup
{
ui:Button{ ID = "tutorial_cta",
Text = "YouTube Tutorial",
StyleSheet = SECONDARY_ACTION_BUTTON_CSS},
ui:Button{ ID = "donate_cta",
Text = "Donate",
StyleSheet = SECONDARY_ACTION_BUTTON_CSS},
}
}
}
})
PopulateSubtitleTracks(win)
PopulateTextTemplates(win)
PopulateTextTransforms(win)
function win.On.tutorial_cta.Clicked(ev)
OpenURL(TUTORIAL_URL)
end
function win.On.donate_cta.Clicked(ev)
OpenURL(DONATE_URL)
end
function win.On.process.Clicked(ev)
local root_element = win:Find("root")