Blender V5.3
io_otio_ops.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2026 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#ifdef WITH_OPENTIMELINEIO
10
11# include <cerrno>
12# include <cstring>
13
14# include "DNA_sequence_types.h"
15# include "DNA_space_enums.h"
17# include "DNA_workspace_types.h"
18
19# include "BKE_context.hh"
20# include "BKE_file_handler.hh"
21# include "BKE_report.hh"
22
23# include "BLI_listbase.hh"
24# include "BLI_path_utils.hh"
25# include "BLI_string.hh"
26# include "BLI_string_utf8.hh"
27# include "BLI_vector.hh"
28
29# include "BLT_translation.hh"
30
31# include "RNA_access.hh"
32# include "RNA_define.hh"
33# include "RNA_enum_types.hh"
34
35# include "ED_fileselect.hh"
36# include "ED_object.hh"
37# include "ED_sequencer.hh"
38
39# include "WM_api.hh"
40# include "WM_types.hh"
41
42# include "SEQ_sequencer.hh"
43
44# include "IO_otio.hh"
45# include "io_otio_ops.hh"
46# include "io_utils.hh"
47
48namespace blender {
49
50static wmOperatorStatus wm_otio_export_invoke(bContext *C,
51 wmOperator *op,
52 const wmEvent * /*event*/)
53{
55
57
59}
60
61static wmOperatorStatus wm_otio_export_exec(bContext *C, wmOperator *op)
62{
63 if (!RNA_struct_property_is_set_ex(op->ptr, "filepath", false)) {
64 BKE_report(op->reports, RPT_ERROR, "No filepath given");
65 return OPERATOR_CANCELLED;
66 }
67
69 Editing *editing = seq::editing_get(scene);
70
71 if (!scene || !editing) {
72 BKE_report(op->reports, RPT_ERROR, "No sequencer scene found");
73 return OPERATOR_CANCELLED;
74 }
75
76 OTIOExportParams export_params;
77 RNA_string_get(op->ptr, "filepath", export_params.filepath);
78 export_params.use_resolve_metadata = RNA_boolean_get(op->ptr, "use_resolve_metadata");
79 export_params.reports = op->reports;
80
81 OTIO_export(C, export_params);
82
83 return OPERATOR_FINISHED;
84}
85
86static bool wm_otio_export_check(bContext * /*C*/, wmOperator *op)
87{
88 char filepath[FILE_MAX];
89 RNA_string_get(op->ptr, "filepath", filepath);
90
91 if (!BLI_path_extension_check(filepath, ".otio")) {
92 BLI_path_extension_ensure(filepath, FILE_MAX, ".otio");
93 RNA_string_set(op->ptr, "filepath", filepath);
94 return true;
95 }
96
97 return false;
98}
99
100static bool wm_otio_export_poll(bContext *C)
101{
102 if (!WM_operator_winactive(C)) {
103 return false;
104 }
105
107 Editing *editing = seq::editing_get(scene);
108
109 if (!scene) {
110 CTX_wm_operator_poll_msg_set(C, "No sequencer scene");
111 return false;
112 }
113 if (!editing || BLI_listbase_is_empty(&editing->seqbase)) {
114 CTX_wm_operator_poll_msg_set(C, "Sequencer scene has no strips");
115 return false;
116 }
117
118 return true;
119}
120
122{
123 ot->name = "Export OTIO";
124 ot->description = "Export the sequencer scene as an OpenTimelineIO timeline";
125 ot->idname = "WM_OT_otio_export";
126
127 ot->invoke = wm_otio_export_invoke;
128 ot->exec = wm_otio_export_exec;
129 ot->poll = wm_otio_export_poll;
130 ot->check = wm_otio_export_check;
131
135 FILE_SAVE,
139
140 PropertyRNA *prop = RNA_def_string(ot->srna, "filter_glob", "*.otio", 0, "", "");
142
143 RNA_def_boolean(ot->srna,
144 "use_resolve_metadata",
145 false,
146 "Export DaVinci Resolve Metadata",
147 "Write additional metadata so DaVinci Resolve can recreate generated strips, "
148 "transforms, blending, audio levels and more");
149}
150
151static wmOperatorStatus wm_otio_import_invoke(bContext *C, wmOperator *op, const wmEvent *event)
152{
153 return ed::io::filesel_drop_import_invoke(C, op, event);
154}
155
156static wmOperatorStatus wm_otio_import_exec(bContext *C, wmOperator *op)
157{
158 OTIOImportParams params;
159 params.reports = op->reports;
160
161 const auto paths = ed::io::paths_from_operator_properties(op->ptr);
162
163 if (paths.is_empty()) {
164 BKE_report(op->reports, RPT_ERROR, "No filepath given");
165 return OPERATOR_CANCELLED;
166 }
167
168 Scene *scene = nullptr;
169 for (const auto &path : paths) {
170 STRNCPY(params.filepath, path.c_str());
171 if (Scene *imported_scene = OTIO_import(C, params)) {
172 scene = imported_scene;
173 }
174 }
175
176 if (scene) {
177 wmWindow *win = CTX_wm_window(C);
178 WorkSpace *workspace = CTX_wm_workspace(C);
179 if (win && workspace && CTX_wm_space_seq(C)) {
180 if (scene != workspace->sequencer_scene) {
181 workspace->sequencer_scene = scene;
184 }
185 }
186 else {
187 BKE_reportf(op->reports,
188 RPT_INFO,
189 TIP_("Imported OTIO timeline into scene '%s'"),
190 scene->id.name + 2);
191 }
192 }
194
195 return OPERATOR_FINISHED;
196}
197
199{
200 ot->name = "Import OTIO";
201 ot->description = "Import OpenTimelineIO Timeline into Sequencer Scene";
202 ot->idname = "WM_OT_otio_import";
203
204 ot->invoke = wm_otio_import_invoke;
205 ot->exec = wm_otio_import_exec;
206 ot->poll = WM_operator_winactive;
207 ot->flag = OPTYPE_UNDO;
208
217
218 PropertyRNA *prop = RNA_def_string(ot->srna, "filter_glob", "*.otio", 0, "", "");
220}
221
222namespace ed::io {
223static bool otio_poll_drop(const bContext *C, bke::FileHandlerType * /*fh*/)
224{
225 return CTX_wm_space_seq(C) != nullptr;
226}
227
229{
230 auto fh = std::make_unique<bke::FileHandlerType>();
231 STRNCPY_UTF8(fh->idname, "IO_FH_otio");
232 STRNCPY_UTF8(fh->import_operator, "WM_OT_otio_import");
233 STRNCPY_UTF8(fh->label, "OpenTimelineIO");
234 STRNCPY_UTF8(fh->file_extensions_str, ".otio");
235 fh->poll_drop = otio_poll_drop;
236 bke::file_handler_add(std::move(fh));
237}
238} // namespace ed::io
239} // namespace blender
240
241#endif
#define FILE_MAX
#define STRNCPY_UTF8(dst, src)
#define TIP_(msgid)
#define C
Definition RandGen.cpp:29
#define NC_WINDOW
Definition WM_types.hh:388
string name
Definition scene.h:136
void file_handler_add(std::unique_ptr< FileHandlerType > file_handler)
Vector< std::string > paths_from_operator_properties(PointerRNA *ptr)
Definition io_utils.cc:79
void otio_file_handler_add()
wmOperatorStatus filesel_drop_import_invoke(bContext *C, wmOperator *op, const wmEvent *)
Definition io_utils.cc:30
void sync_active_scene_and_time_with_scene_strip(bContext &C)
Editing * editing_get(const Scene *scene)
Definition sequencer.cc:304
BMesh Iterators.
void WM_window_set_active_scene(Main *bmain, bContext *C, wmWindow *win, Scene *scene)
char * STRNCPY(char(&dst)[N], const char *src)
PropertyRNA * RNA_def_string(StructOrFunctionRNA *cont_, const char *identifier, const char *default_value, const int maxlen, const char *ui_name, const char *ui_description)
Scene * CTX_data_sequencer_scene(const bContext *C)
WorkSpace * CTX_wm_workspace(const bContext *C)
void RNA_string_set(PointerRNA *ptr, const char *name, const char *value)
Scene * OTIO_import(bContext *C, const OTIOImportParams &params)
Definition IO_otio.cc:20
bool RNA_struct_property_is_set_ex(PointerRNA *ptr, const char *identifier, bool use_ghost)
wmWindow * CTX_wm_window(const bContext *C)
BLI_INLINE bool BLI_listbase_is_empty(const ListBase *lb)
void WM_operator_properties_filesel(wmOperatorType *ot, const int filter, const short type, const eFileSel_Action action, const eFileSel_Flag flag, const short display, const short sort)
SpaceSeq * CTX_wm_space_seq(const bContext *C)
bool BLI_path_extension_ensure(char *path, size_t path_maxncpy, const char *ext) ATTR_NONNULL(1
void CTX_wm_operator_poll_msg_set(bContext *C, const char *msg)
void BKE_report(ReportList *reports, eReportType type, const char *message)
Definition report.cc:162
@ WM_FILESEL_DIRECTORY
Definition WM_api.hh:1330
@ WM_FILESEL_RELPATH
Definition WM_api.hh:1329
@ WM_FILESEL_SHOW_PROPS
Definition WM_api.hh:1335
@ WM_FILESEL_FILES
Definition WM_api.hh:1333
@ WM_FILESEL_FILEPATH
Definition WM_api.hh:1332
void ED_fileselect_ensure_default_filepath(bContext *C, wmOperator *op, const char *extension)
Definition filesel.cc:1515
bool RNA_boolean_get(PointerRNA *ptr, const char *name)
void WM_event_add_notifier(const bContext *C, uint type, void *reference)
void RNA_def_property_flag(PropertyRNA *prop, PropertyFlag flag)
void BKE_reportf(ReportList *reports, eReportType type, const char *format,...) ATTR_PRINTF_FORMAT(3
Definition report.cc:191
@ FILE_SAVE
Definition WM_api.hh:1342
@ FILE_OPENFILE
Definition WM_api.hh:1341
bool WM_operator_winactive(bContext *C)
Main * CTX_data_main(const bContext *C)
bool BLI_path_extension_check(const char *path, const char *ext) ATTR_NONNULL(1
@ PROP_HIDDEN
Definition RNA_types.hh:408
void OTIO_export(bContext *C, const OTIOExportParams &params)
Definition IO_otio.cc:15
@ OPTYPE_UNDO
Definition WM_types.hh:190
std::string RNA_string_get(PointerRNA *ptr, const char *name)
PropertyRNA * RNA_def_boolean(StructOrFunctionRNA *cont_, const char *identifier, const bool default_value, const char *ui_name, const char *ui_description)
void WM_OT_otio_export(wmOperatorType *ot)
void WM_OT_otio_import(wmOperatorType *ot)
void WM_event_add_fileselect(bContext *C, wmOperator *op)