Alembic Export: set start and end frame to that of the scene for
[blender.git] / source / blender / editors / io / io_alembic.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software  Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2016 Blender Foundation.
19  * All rights reserved.
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  *
23  */
24
25 #ifdef WITH_ALEMBIC
26
27 /* needed for directory lookup */
28 #ifndef WIN32
29 #  include <dirent.h>
30 #else
31 #  include "BLI_winstuff.h"
32 #endif
33
34 #include "MEM_guardedalloc.h"
35
36 #include "DNA_mesh_types.h"
37 #include "DNA_modifier_types.h"
38 #include "DNA_object_types.h"
39 #include "DNA_scene_types.h"
40 #include "DNA_space_types.h"
41
42 #include "BKE_context.h"
43 #include "BKE_global.h"
44 #include "BKE_main.h"
45 #include "BKE_report.h"
46
47 #include "BLI_listbase.h"
48 #include "BLI_math_vector.h"
49 #include "BLI_path_util.h"
50 #include "BLI_string.h"
51 #include "BLI_utildefines.h"
52
53 #include "BLT_translation.h"
54
55 #include "RNA_access.h"
56 #include "RNA_define.h"
57 #include "RNA_enum_types.h"
58
59 #include "UI_interface.h"
60 #include "UI_resources.h"
61
62 #include "WM_api.h"
63 #include "WM_types.h"
64
65 #include "io_alembic.h"
66
67 #include "ABC_alembic.h"
68
69 static int wm_alembic_export_invoke(bContext *C, wmOperator *op, const wmEvent *event)
70 {
71         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
72                 Main *bmain = CTX_data_main(C);
73                 char filepath[FILE_MAX];
74
75                 if (bmain->name[0] == '\0') {
76                         BLI_strncpy(filepath, "untitled", sizeof(filepath));
77                 }
78                 else {
79                         BLI_strncpy(filepath, bmain->name, sizeof(filepath));
80                 }
81
82                 BLI_replace_extension(filepath, sizeof(filepath), ".abc");
83                 RNA_string_set(op->ptr, "filepath", filepath);
84         }
85
86         WM_event_add_fileselect(C, op);
87
88         return OPERATOR_RUNNING_MODAL;
89
90         UNUSED_VARS(event);
91 }
92
93 static int wm_alembic_export_exec(bContext *C, wmOperator *op)
94 {
95         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
96                 BKE_report(op->reports, RPT_ERROR, "No filename given");
97                 return OPERATOR_CANCELLED;
98         }
99
100         char filename[FILE_MAX];
101         RNA_string_get(op->ptr, "filepath", filename);
102
103         const struct AlembicExportParams params = {
104             .frame_start = RNA_int_get(op->ptr, "start"),
105             .frame_end = RNA_int_get(op->ptr, "end"),
106
107             .frame_step_xform = 1.0 / (double)RNA_int_get(op->ptr, "xsamples"),
108             .frame_step_shape = 1.0 / (double)RNA_int_get(op->ptr, "gsamples"),
109
110             .shutter_open = RNA_float_get(op->ptr, "sh_open"),
111             .shutter_close = RNA_float_get(op->ptr, "sh_close"),
112
113             .selected_only = RNA_boolean_get(op->ptr, "selected"),
114             .uvs = RNA_boolean_get(op->ptr, "uvs"),
115             .normals = RNA_boolean_get(op->ptr, "normals"),
116             .vcolors = RNA_boolean_get(op->ptr, "vcolors"),
117             .apply_subdiv = RNA_boolean_get(op->ptr, "apply_subdiv"),
118             .flatten_hierarchy = RNA_boolean_get(op->ptr, "flatten"),
119             .visible_layers_only = RNA_boolean_get(op->ptr, "visible_layers_only"),
120             .renderable_only = RNA_boolean_get(op->ptr, "renderable_only"),
121             .face_sets = RNA_boolean_get(op->ptr, "face_sets"),
122             .use_subdiv_schema = RNA_boolean_get(op->ptr, "subdiv_schema"),
123             .compression_type = RNA_enum_get(op->ptr, "compression_type"),
124             .packuv = RNA_boolean_get(op->ptr, "packuv"),
125                 .triangulate = RNA_boolean_get(op->ptr, "triangulate"),
126                 .quad_method = RNA_enum_get(op->ptr, "quad_method"),
127                 .ngon_method = RNA_enum_get(op->ptr, "ngon_method"),
128
129             .global_scale = RNA_float_get(op->ptr, "global_scale"),
130         };
131
132         ABC_export(CTX_data_scene(C), C, filename, &params);
133
134         return OPERATOR_FINISHED;
135 }
136
137 static void ui_alembic_export_settings(uiLayout *layout, PointerRNA *imfptr)
138 {
139         uiLayout *box;
140         uiLayout *row;
141
142 #ifdef WITH_ALEMBIC_HDF5
143         box = uiLayoutBox(layout);
144         row = uiLayoutRow(box, false);
145         uiItemL(row, IFACE_("Archive Options:"), ICON_NONE);
146
147         row = uiLayoutRow(box, false);
148         uiItemR(row, imfptr, "compression_type", 0, NULL, ICON_NONE);
149 #endif
150
151         box = uiLayoutBox(layout);
152         row = uiLayoutRow(box, false);
153         uiItemL(row, IFACE_("Manual Transform:"), ICON_NONE);
154
155         row = uiLayoutRow(box, false);
156         uiItemR(row, imfptr, "global_scale", 0, NULL, ICON_NONE);
157
158         /* Scene Options */
159         box = uiLayoutBox(layout);
160         row = uiLayoutRow(box, false);
161         uiItemL(row, IFACE_("Scene Options:"), ICON_SCENE_DATA);
162
163         row = uiLayoutRow(box, false);
164         uiItemR(row, imfptr, "start", 0, NULL, ICON_NONE);
165
166         row = uiLayoutRow(box, false);
167         uiItemR(row, imfptr, "end", 0, NULL, ICON_NONE);
168
169         row = uiLayoutRow(box, false);
170         uiItemR(row, imfptr, "xsamples", 0, NULL, ICON_NONE);
171
172         row = uiLayoutRow(box, false);
173         uiItemR(row, imfptr, "gsamples", 0, NULL, ICON_NONE);
174
175         row = uiLayoutRow(box, false);
176         uiItemR(row, imfptr, "sh_open", 0, NULL, ICON_NONE);
177
178         row = uiLayoutRow(box, false);
179         uiItemR(row, imfptr, "sh_close", 0, NULL, ICON_NONE);
180
181         row = uiLayoutRow(box, false);
182         uiItemR(row, imfptr, "selected", 0, NULL, ICON_NONE);
183
184         row = uiLayoutRow(box, false);
185         uiItemR(row, imfptr, "renderable_only", 0, NULL, ICON_NONE);
186
187         row = uiLayoutRow(box, false);
188         uiItemR(row, imfptr, "visible_layers_only", 0, NULL, ICON_NONE);
189
190         row = uiLayoutRow(box, false);
191         uiItemR(row, imfptr, "flatten", 0, NULL, ICON_NONE);
192
193         /* Object Data */
194         box = uiLayoutBox(layout);
195         row = uiLayoutRow(box, false);
196         uiItemL(row, IFACE_("Object Options:"), ICON_OBJECT_DATA);
197
198         row = uiLayoutRow(box, false);
199         uiItemR(row, imfptr, "uvs", 0, NULL, ICON_NONE);
200
201         row = uiLayoutRow(box, false);
202         uiItemR(row, imfptr, "packuv", 0, NULL, ICON_NONE);
203         uiLayoutSetEnabled(row, RNA_boolean_get(imfptr, "uvs"));
204
205         row = uiLayoutRow(box, false);
206         uiItemR(row, imfptr, "normals", 0, NULL, ICON_NONE);
207
208         row = uiLayoutRow(box, false);
209         uiItemR(row, imfptr, "vcolors", 0, NULL, ICON_NONE);
210
211         row = uiLayoutRow(box, false);
212         uiItemR(row, imfptr, "face_sets", 0, NULL, ICON_NONE);
213
214         row = uiLayoutRow(box, false);
215         uiItemR(row, imfptr, "subdiv_schema", 0, NULL, ICON_NONE);
216
217         row = uiLayoutRow(box, false);
218         uiItemR(row, imfptr, "apply_subdiv", 0, NULL, ICON_NONE);
219
220         row = uiLayoutRow(box, false);
221         uiItemR(row, imfptr, "triangulate", 0, NULL, ICON_NONE);
222
223         const bool triangulate = RNA_boolean_get(imfptr, "triangulate");
224
225         row = uiLayoutRow(box, false);
226         uiLayoutSetEnabled(row, triangulate);
227         uiItemR(row, imfptr, "quad_method", 0, NULL, ICON_NONE);
228
229         row = uiLayoutRow(box, false);
230         uiLayoutSetEnabled(row, triangulate);
231         uiItemR(row, imfptr, "ngon_method", 0, NULL, ICON_NONE);
232 }
233
234 static void wm_alembic_export_draw(bContext *C, wmOperator *op)
235 {
236         PointerRNA ptr;
237
238         RNA_pointer_create(NULL, op->type->srna, op->properties, &ptr);
239
240         /* Conveniently set start and end frame to match the scene's frame range. */
241         Scene *scene = CTX_data_scene(C);
242
243         if (scene != NULL) {
244                 RNA_int_set(&ptr, "start", SFRA);
245                 RNA_int_set(&ptr, "end", EFRA);
246         }
247
248         ui_alembic_export_settings(op->layout, &ptr);
249 }
250
251 static bool wm_alembic_export_check(bContext *UNUSED(C), wmOperator *op)
252 {
253         char filepath[FILE_MAX];
254         RNA_string_get(op->ptr, "filepath", filepath);
255
256         if (!BLI_testextensie(filepath, ".abc")) {
257                 BLI_ensure_extension(filepath, FILE_MAX, ".abc");
258                 RNA_string_set(op->ptr, "filepath", filepath);
259                 return true;
260         }
261
262         return false;
263 }
264
265 void WM_OT_alembic_export(wmOperatorType *ot)
266 {
267         ot->name = "Export Alembic";
268         ot->description = "Export current scene in an Alembic archive";
269         ot->idname = "WM_OT_alembic_export";
270
271         ot->invoke = wm_alembic_export_invoke;
272         ot->exec = wm_alembic_export_exec;
273         ot->poll = WM_operator_winactive;
274         ot->ui = wm_alembic_export_draw;
275         ot->check = wm_alembic_export_check;
276
277         WM_operator_properties_filesel(ot, FILE_TYPE_FOLDER | FILE_TYPE_ALEMBIC,
278                                        FILE_BLENDER, FILE_SAVE, WM_FILESEL_FILEPATH,
279                                        FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
280
281         RNA_def_int(ot->srna, "start", 1, INT_MIN, INT_MAX,
282                     "Start Frame", "Start Frame", INT_MIN, INT_MAX);
283
284         RNA_def_int(ot->srna, "end", 1, INT_MIN, INT_MAX,
285                     "End Frame", "End Frame", INT_MIN, INT_MAX);
286
287         RNA_def_int(ot->srna, "xsamples", 1, 1, 128,
288                     "Transform Samples", "Number of times per frame transformations are sampled", 1, 128);
289
290         RNA_def_int(ot->srna, "gsamples", 1, 1, 128,
291                     "Geometry Samples", "Number of times per frame object data are sampled", 1, 128);
292
293         RNA_def_float(ot->srna, "sh_open", 0.0f, -1.0f, 1.0f,
294                       "Shutter Open", "Time at which the shutter is open", -1.0f, 1.0f);
295
296         RNA_def_float(ot->srna, "sh_close", 1.0f, -1.0f, 1.0f,
297                       "Shutter Close", "Time at which the shutter is closed", -1.0f, 1.0f);
298
299         RNA_def_boolean(ot->srna, "selected", 0,
300                         "Selected Objects Only", "Export only selected objects");
301
302         RNA_def_boolean(ot->srna, "renderable_only", 1,
303                         "Renderable Objects Only",
304                         "Export only objects marked renderable in the outliner");
305
306         RNA_def_boolean(ot->srna, "visible_layers_only", 0,
307                         "Visible Layers Only", "Export only objects in visible layers");
308
309         RNA_def_boolean(ot->srna, "flatten", 0,
310                         "Flatten Hierarchy",
311                         "Do not preserve objects' parent/children relationship");
312
313         RNA_def_boolean(ot->srna, "uvs", 1, "UVs", "Export UVs");
314
315         RNA_def_boolean(ot->srna, "packuv", 1, "Pack UV Islands",
316                         "Export UVs with packed island");
317
318         RNA_def_boolean(ot->srna, "normals", 1, "Normals", "Export normals");
319
320         RNA_def_boolean(ot->srna, "vcolors", 0, "Vertex Colors", "Export vertex colors");
321
322         RNA_def_boolean(ot->srna, "face_sets", 0, "Face Sets", "Export per face shading group assignments");
323
324         RNA_def_boolean(ot->srna, "subdiv_schema", 0,
325                         "Use Subdivision Schema",
326                         "Export meshes using Alembic's subdivision schema");
327
328         RNA_def_boolean(ot->srna, "apply_subdiv", 0,
329                         "Apply Subsurf", "Export subdivision surfaces as meshes");
330
331         RNA_def_enum(ot->srna, "compression_type", rna_enum_abc_compression_items,
332                      ABC_ARCHIVE_OGAWA, "Compression", "");
333
334         RNA_def_float(ot->srna, "global_scale", 1.0f, 0.0001f, 1000.0f, "Scale",
335                       "Value by which to enlarge or shrink the objects with respect to the world's origin",
336                       0.0001f, 1000.0f);
337
338         RNA_def_boolean(ot->srna, "triangulate", false, "Triangulate",
339                         "Export Polygons (Quads & NGons) as Triangles");
340
341         RNA_def_enum(ot->srna, "quad_method", rna_enum_modifier_triangulate_quad_method_items,
342                      MOD_TRIANGULATE_QUAD_SHORTEDGE, "Quad Method", "Method for splitting the quads into triangles");
343
344         RNA_def_enum(ot->srna, "ngon_method", rna_enum_modifier_triangulate_quad_method_items,
345                      MOD_TRIANGULATE_NGON_BEAUTY, "Polygon Method", "Method for splitting the polygons into triangles");
346 }
347
348 /* ************************************************************************** */
349
350 /* TODO(kevin): check on de-duplicating all this with code in image_ops.c */
351
352 typedef struct CacheFrame {
353         struct CacheFrame *next, *prev;
354         int framenr;
355 } CacheFrame;
356
357 static int cmp_frame(const void *a, const void *b)
358 {
359         const CacheFrame *frame_a = a;
360         const CacheFrame *frame_b = b;
361
362         if (frame_a->framenr < frame_b->framenr) return -1;
363         if (frame_a->framenr > frame_b->framenr) return 1;
364         return 0;
365 }
366
367 static int get_sequence_len(char *filename, int *ofs)
368 {
369         int frame;
370         int numdigit;
371
372         if (!BLI_path_frame_get(filename, &frame, &numdigit)) {
373                 return 1;
374         }
375
376         char path[FILE_MAX];
377         BLI_split_dir_part(filename, path, FILE_MAX);
378
379         DIR *dir = opendir(path);
380
381         const char *ext = ".abc";
382         const char *basename = BLI_path_basename(filename);
383         const int len = strlen(basename) - (numdigit + strlen(ext));
384
385         ListBase frames;
386         BLI_listbase_clear(&frames);
387
388         struct dirent *fname;
389         while ((fname = readdir(dir)) != NULL) {
390                 /* do we have the right extension? */
391                 if (!strstr(fname->d_name, ext)) {
392                         continue;
393                 }
394
395                 if (!STREQLEN(basename, fname->d_name, len)) {
396                         continue;
397                 }
398
399                 CacheFrame *cache_frame = MEM_callocN(sizeof(CacheFrame), "abc_frame");
400
401                 BLI_path_frame_get(fname->d_name, &cache_frame->framenr, &numdigit);
402
403                 BLI_addtail(&frames, cache_frame);
404         }
405
406         closedir(dir);
407
408         BLI_listbase_sort(&frames, cmp_frame);
409
410         CacheFrame *cache_frame = frames.first;
411
412         if (cache_frame) {
413                 int frame_curr = cache_frame->framenr;
414                 (*ofs) = frame_curr;
415
416                 while (cache_frame && (cache_frame->framenr == frame_curr)) {
417                         ++frame_curr;
418                         cache_frame = cache_frame->next;
419                 }
420
421                 BLI_freelistN(&frames);
422
423                 return frame_curr - (*ofs);
424         }
425
426         return 1;
427 }
428
429 /* ************************************************************************** */
430
431 static void ui_alembic_import_settings(uiLayout *layout, PointerRNA *imfptr)
432 {
433         uiLayout *box = uiLayoutBox(layout);
434         uiLayout *row = uiLayoutRow(box, false);
435         uiItemL(row, IFACE_("Manual Transform:"), ICON_NONE);
436
437         row = uiLayoutRow(box, false);
438         uiItemR(row, imfptr, "scale", 0, NULL, ICON_NONE);
439
440         box = uiLayoutBox(layout);
441         row = uiLayoutRow(box, false);
442         uiItemL(row, IFACE_("Options:"), ICON_NONE);
443
444         row = uiLayoutRow(box, false);
445         uiItemR(row, imfptr, "set_frame_range", 0, NULL, ICON_NONE);
446
447         row = uiLayoutRow(box, false);
448         uiItemR(row, imfptr, "is_sequence", 0, NULL, ICON_NONE);
449
450         row = uiLayoutRow(box, false);
451         uiItemR(row, imfptr, "validate_meshes", 0, NULL, ICON_NONE);
452 }
453
454 static void wm_alembic_import_draw(bContext *UNUSED(C), wmOperator *op)
455 {
456         PointerRNA ptr;
457
458         RNA_pointer_create(NULL, op->type->srna, op->properties, &ptr);
459         ui_alembic_import_settings(op->layout, &ptr);
460 }
461
462 static int wm_alembic_import_exec(bContext *C, wmOperator *op)
463 {
464         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
465                 BKE_report(op->reports, RPT_ERROR, "No filename given");
466                 return OPERATOR_CANCELLED;
467         }
468
469         char filename[FILE_MAX];
470         RNA_string_get(op->ptr, "filepath", filename);
471
472         const float scale = RNA_float_get(op->ptr, "scale");
473         const bool is_sequence = RNA_boolean_get(op->ptr, "is_sequence");
474         const bool set_frame_range = RNA_boolean_get(op->ptr, "set_frame_range");
475         const bool validate_meshes = RNA_boolean_get(op->ptr, "validate_meshes");
476
477         int offset = 0;
478         int sequence_len = 1;
479
480         if (is_sequence) {
481                 sequence_len = get_sequence_len(filename, &offset);
482         }
483
484         ABC_import(C, filename, scale, is_sequence, set_frame_range, sequence_len, offset, validate_meshes);
485
486         return OPERATOR_FINISHED;
487 }
488
489 void WM_OT_alembic_import(wmOperatorType *ot)
490 {
491         ot->name = "Import Alembic";
492         ot->description = "Load an Alembic archive";
493         ot->idname = "WM_OT_alembic_import";
494
495         ot->invoke = WM_operator_filesel;
496         ot->exec = wm_alembic_import_exec;
497         ot->poll = WM_operator_winactive;
498         ot->ui = wm_alembic_import_draw;
499
500         WM_operator_properties_filesel(ot, FILE_TYPE_FOLDER | FILE_TYPE_ALEMBIC,
501                                        FILE_BLENDER, FILE_SAVE, WM_FILESEL_FILEPATH,
502                                        FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
503
504         RNA_def_float(ot->srna, "scale", 1.0f, 0.0001f, 1000.0f, "Scale",
505                       "Value by which to enlarge or shrink the objects with respect to the world's origin",
506                       0.0001f, 1000.0f);
507
508         RNA_def_boolean(ot->srna, "set_frame_range", true,
509                         "Set Frame Range",
510                         "If checked, update scene's start and end frame to match those of the Alembic archive");
511
512         RNA_def_boolean(ot->srna, "validate_meshes", 0,
513                         "Validate Meshes", "Check imported mesh objects for invalid data (slow)");
514
515         RNA_def_boolean(ot->srna, "is_sequence", false, "Is Sequence",
516                         "Set to true if the cache is split into separate files");
517 }
518
519 #endif