-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathobs-instant-replay.lua
219 lines (187 loc) · 6.88 KB
/
obs-instant-replay.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
obs = obslua
script_enabled = false
source_name = ""
source_scene_name = ""
source_scene_time = 20
hotkey_id = obs.OBS_INVALID_HOTKEY_ID
attempts = 0
replaying = false
----------------------------------------------------------
-- Toggle scene
function show_replay(visible)
if visible == true then
replaying = true
else
replaying = false
end
local scenes = obs.obs_frontend_get_scenes()
if scenes ~= nil then
for _, scene in ipairs(scenes) do
if obs.obs_source_get_name(scene) == source_scene_name then
replay_scene = obs.obs_scene_from_source(scene)
local items = obs.obs_scene_enum_items(replay_scene)
for _,item in ipairs(items) do
if item ~= nil then
obs.obs_sceneitem_set_visible(item, visible)
end
end
obs.sceneitem_list_release(items)
end
end
end
obs.source_list_release(scenes)
end
-- Stop replay timer
function stop_replay()
attempts = attempts + 1
if source_scene_time == nul or source_scene_time < 1 then
source_scene_time = 1
end
if attempts >= source_scene_time then
show_replay(false)
obs.remove_current_callback()
end
end
-- Play replay
function try_play()
local replay_buffer = obs.obs_frontend_get_replay_buffer_output()
if replay_buffer == nil then
show_replay(false)
obs.remove_current_callback()
return
end
show_replay(true)
-- Call the procedure of the replay buffer named "get_last_replay" to
-- get the last replay created by the replay buffer
local cd = obs.calldata_create()
local ph = obs.obs_output_get_proc_handler(replay_buffer)
obs.proc_handler_call(ph, "get_last_replay", cd)
local path = obs.calldata_string(cd, "path")
obs.calldata_destroy(cd)
obs.obs_output_release(replay_buffer)
-- If the path is valid and the source exists, update it with the
-- replay file to play back the replay. Otherwise, stop attempting to
-- replay after 10 seconds
if path == nil then
attempts = attempts + 1
if attempts >= 10 then
show_replay(false)
obs.remove_current_callback()
end
else
local source = obs.obs_get_source_by_name(source_name)
if source ~= nil then
local settings = obs.obs_data_create()
obs.obs_data_set_string(settings, "local_file", path)
obs.obs_data_get_bool(settings, "active")
obs.obs_data_set_bool(settings, "close_when_inactive", true)
obs.obs_data_set_bool(settings, "restart_on_activate", true)
-- updating will automatically cause the source to
-- refresh if the source is currently active, otherwise
-- the source will play whenever its scene is activated
obs.obs_source_update(source, settings)
obs.obs_data_release(settings)
obs.obs_source_release(source)
attempts = 0
obs.timer_add(stop_replay, 1000)
end
obs.remove_current_callback()
end
end
-- The "Instant Replay" hotkey callback
function obs_instant_replay(pressed)
if not pressed then
return
end
if script_enabled == false then
return
end
if replaying == true then
return
end
local replay_buffer = obs.obs_frontend_get_replay_buffer_output()
if replay_buffer ~= nil then
-- Call the procedure of the replay buffer named "get_last_replay" to
-- get the last replay created by the replay buffer
local ph = obs.obs_output_get_proc_handler(replay_buffer)
obs.proc_handler_call(ph, "save", nil)
-- Set a 1-second timer to attempt playback every 1 second
-- until the replay is available
if obs.obs_output_active(replay_buffer) then
attempts = 0
obs.timer_add(try_play, 1000)
else
obs.script_log(obs.LOG_WARNING, "Tried to save an instant replay, but the replay buffer is not active!")
end
obs.obs_output_release(replay_buffer)
else
obs.script_log(obs.LOG_WARNING, "Tried to save an instant replay, but found no active replay buffer!")
end
end
----------------------------------------------------------
-- A function named script_update will be called when settings are changed
function script_update(settings)
source_name = obs.obs_data_get_string(settings, "source")
source_scene_name = obs.obs_data_get_string(settings, "source_scene")
source_scene_time = obs.obs_data_get_int(settings, "source_time")
script_enabled = obs.obs_data_get_bool(settings, "script_enabled")
end
-- A function named script_description returns the description shown to
-- the user
function script_description()
return "When the \"Instant Replay\" hotkey is triggered, saves a replay from the replay buffer, and then plays it in a media source as soon as the replay is ready.\nRequires an active replay buffer."
end
-- A function named script_properties defines the properties that the user
-- can change for the entire script module itself
function script_properties()
props = obs.obs_properties_create()
obs.obs_properties_add_bool(props, "script_enabled", "Enable")
local s = obs.obs_properties_add_list(props, "source_scene", "Replay Scene", obs.OBS_COMBO_TYPE_EDITABLE, obs.OBS_COMBO_FORMAT_STRING)
local scenes = obs.obs_frontend_get_scenes()
if scenes ~= nil then
for _, scene in ipairs(scenes) do
local name = obs.obs_source_get_name(scene)
obs.obs_property_list_add_string(s, name, name)
end
end
obs.source_list_release(scenes)
local p = obs.obs_properties_add_list(props, "source", "Media Source", obs.OBS_COMBO_TYPE_EDITABLE, obs.OBS_COMBO_FORMAT_STRING)
local sources = obs.obs_enum_sources()
if sources ~= nil then
for _, source in ipairs(sources) do
source_id = obs.obs_source_get_id(source)
if source_id == "ffmpeg_source" then
local name = obs.obs_source_get_name(source)
obs.obs_property_list_add_string(p, name, name)
end
end
end
obs.source_list_release(sources)
obs.obs_properties_add_int(props, "source_time", "Replay duration (seconds)", 1, 120, 1)
return props
end
-- A function named script_defaults will be called to set the default settings
function script_defaults(settings)
obs.obs_data_set_default_int(settings, "source_time", 20)
end
-- A function named script_load will be called on startup
function script_load(settings)
source_name = obs.obs_data_get_string(settings, "source")
source_scene_name = obs.obs_data_get_string(settings, "source_scene")
source_scene_time = obs.obs_data_get_int(settings, "source_time")
show_replay(false)
hotkey_id = obs.obs_hotkey_register_frontend("obs_instant_replay.trigger", "OBS Instant Replay", obs_instant_replay)
local hotkey_save_array = obs.obs_data_get_array(settings, "obs_instant_replay.trigger")
obs.obs_hotkey_load(hotkey_id, hotkey_save_array)
obs.obs_data_array_release(hotkey_save_array)
end
-- A function named script_save will be called when the script is saved
--
-- NOTE: This function is usually used for saving extra data (such as in this
-- case, a hotkey's save data). Settings set via the properties are saved
-- automatically.
function script_save(settings)
local hotkey_save_array = obs.obs_hotkey_save(hotkey_id)
obs.obs_data_set_array(settings, "obs_instant_replay.trigger", hotkey_save_array)
obs.obs_data_array_release(hotkey_save_array)
end