Alembic export: fix frame range values being reset at every update, draw
[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         RNA_boolean_set(op->ptr, "init_scene_frame_range", true);
72
73         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
74                 Main *bmain = CTX_data_main(C);
75                 char filepath[FILE_MAX];
76
77                 if (bmain->name[0] == '\0') {
78                         BLI_strncpy(filepath, "untitled", sizeof(filepath));
79                 }
80                 else {
81                         BLI_strncpy(filepath, bmain->name, sizeof(filepath));
82                 }
83
84                 BLI_replace_extension(filepath, sizeof(filepath), ".abc");
85                 RNA_string_set(op->ptr, "filepath", filepath);
86         }
87
88         WM_event_add_fileselect(C, op);
89
90         return OPERATOR_RUNNING_MODAL;
91
92         UNUSED_VARS(event);
93 }
94
95 static int wm_alembic_export_exec(bContext *C, wmOperator *op)
96 {
97         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
98                 BKE_report(op->reports, RPT_ERROR, "No filename given");
99                 return OPERATOR_CANCELLED;
100         }
101
102         char filename[FILE_MAX];
103         RNA_string_get(op->ptr, "filepath", filename);
104
105         const struct AlembicExportParams params = {
106             .frame_start = RNA_int_get(op->ptr, "start"),
107             .frame_end = RNA_int_get(op->ptr, "end"),
108
109             .frame_step_xform = 1.0 / (double)RNA_int_get(op->ptr, "xsamples"),
110             .frame_step_shape = 1.0 / (double)RNA_int_get(op->ptr, "gsamples"),
111
112             .shutter_open = RNA_float_get(op->ptr, "sh_open"),
113             .shutter_close = RNA_float_get(op->ptr, "sh_close"),
114
115             .selected_only = RNA_boolean_get(op->ptr, "selected"),
116             .uvs = RNA_boolean_get(op->ptr, "uvs"),
117             .normals = RNA_boolean_get(op->ptr, "normals"),
118             .vcolors = RNA_boolean_get(op->ptr, "vcolors"),
119             .apply_subdiv = RNA_boolean_get(op->ptr, "apply_subdiv"),
120             .flatten_hierarchy = RNA_boolean_get(op->ptr, "flatten"),
121             .visible_layers_only = RNA_boolean_get(op->ptr, "visible_layers_only"),
122             .renderable_only = RNA_boolean_get(op->ptr, "renderable_only"),
123             .face_sets = RNA_boolean_get(op->ptr, "face_sets"),
124             .use_subdiv_schema = RNA_boolean_get(op->ptr, "subdiv_schema"),
125             .compression_type = RNA_enum_get(op->ptr, "compression_type"),
126             .packuv = RNA_boolean_get(op->ptr, "packuv"),
127                 .triangulate = RNA_boolean_get(op->ptr, "triangulate"),
128                 .quad_method = RNA_enum_get(op->ptr, "quad_method"),
129                 .ngon_method = RNA_enum_get(op->ptr, "ngon_method"),
130
131             .global_scale = RNA_float_get(op->ptr, "global_scale"),
132         };
133
134         ABC_export(CTX_data_scene(C), C, filename, &params);
135
136         return OPERATOR_FINISHED;
137 }
138
139 static void ui_alembic_export_settings(uiLayout *layout, PointerRNA *imfptr)
140 {
141         uiLayout *box;
142         uiLayout *row;
143
144 #ifdef WITH_ALEMBIC_HDF5
145         box = uiLayoutBox(layout);
146         row = uiLayoutRow(box, false);
147         uiItemL(row, IFACE_("Archive Options:"), ICON_NONE);
148
149         row = uiLayoutRow(box, false);
150         uiItemR(row, imfptr, "compression_type", 0, NULL, ICON_NONE);
151 #endif
152
153         box = uiLayoutBox(layout);
154         row = uiLayoutRow(box, false);
155         uiItemL(row, IFACE_("Manual Transform:"), ICON_NONE);
156
157         row = uiLayoutRow(box, false);
158         uiItemR(row, imfptr, "global_scale", 0, NULL, ICON_NONE);
159
160         /* Scene Options */
161         box = uiLayoutBox(layout);
162         row = uiLayoutRow(box, false);
163         uiItemL(row, IFACE_("Scene Options:"), ICON_SCENE_DATA);
164
165         row = uiLayoutRow(box, false);
166         uiItemR(row, imfptr, "start", 0, NULL, ICON_NONE);
167
168         row = uiLayoutRow(box, false);
169         uiItemR(row, imfptr, "end", 0, NULL, ICON_NONE);
170
171         row = uiLayoutRow(box, false);
172         uiItemR(row, imfptr, "xsamples", 0, NULL, ICON_NONE);
173
174         row = uiLayoutRow(box, false);
175         uiItemR(row, imfptr, "gsamples", 0, NULL, ICON_NONE);
176
177         row = uiLayoutRow(box, false);
178         uiItemR(row, imfptr, "sh_open", 0, NULL, ICON_NONE);
179
180         row = uiLayoutRow(box, false);
181         uiItemR(row, imfptr, "sh_close", 0, NULL, ICON_NONE);
182
183         row = uiLayoutRow(box, false);
184         uiItemR(row, imfptr, "selected", 0, NULL, ICON_NONE);
185
186         row = uiLayoutRow(box, false);
187         uiItemR(row, imfptr, "renderable_only", 0, NULL, ICON_NONE);
188
189         row = uiLayoutRow(box, false);
190         uiItemR(row, imfptr, "visible_layers_only", 0, NULL, ICON_NONE);
191
192         row = uiLayoutRow(box, false);
193         uiItemR(row, imfptr, "flatten", 0, NULL, ICON_NONE);
194
195         /* Object Data */
196         box = uiLayoutBox(layout);
197         row = uiLayoutRow(box, false);
198         uiItemL(row, IFACE_("Object Options:"), ICON_OBJECT_DATA);
199
200         row = uiLayoutRow(box, false);
201         uiItemR(row, imfptr, "uvs", 0, NULL, ICON_NONE);
202
203         row = uiLayoutRow(box, false);
204         uiItemR(row, imfptr, "packuv", 0, NULL, ICON_NONE);
205         uiLayoutSetEnabled(row, RNA_boolean_get(imfptr, "uvs"));
206
207         row = uiLayoutRow(box, false);
208         uiItemR(row, imfptr, "normals", 0, NULL, ICON_NONE);
209
210         row = uiLayoutRow(box, false);
211         uiItemR(row, imfptr, "vcolors", 0, NULL, ICON_NONE);
212
213         row = uiLayoutRow(box, false);
214         uiItemR(row, imfptr, "face_sets", 0, NULL, ICON_NONE);
215
216         row = uiLayoutRow(box, false);
217         uiItemR(row, imfptr, "subdiv_schema", 0, NULL, ICON_NONE);
218
219         row = uiLayoutRow(box, false);
220         uiItemR(row, imfptr, "apply_subdiv", 0, NULL, ICON_NONE);
221
222         row = uiLayoutRow(box, false);
223         uiItemR(row, imfptr, "triangulate", 0, NULL, ICON_NONE);
224
225         const bool triangulate = RNA_boolean_get(imfptr, "triangulate");
226
227         row = uiLayoutRow(box, false);
228         uiLayoutSetEnabled(row, triangulate);
229         uiItemR(row, imfptr, "quad_method", 0, NULL, ICON_NONE);
230
231         row = uiLayoutRow(box, false);
232         uiLayoutSetEnabled(row, triangulate);
233         uiItemR(row, imfptr, "ngon_method", 0, NULL, ICON_NONE);
234 }
235
236 static void wm_alembic_export_draw(bContext *C, wmOperator *op)
237 {
238         PointerRNA ptr;
239
240         RNA_pointer_create(NULL, op->type->srna, op->properties, &ptr);
241
242         /* Conveniently set start and end frame to match the scene's frame range. */
243         Scene *scene = CTX_data_scene(C);
244
245         if (scene != NULL && RNA_boolean_get(&ptr, "init_scene_frame_range")) {
246                 RNA_int_set(&ptr, "start", SFRA);
247                 RNA_int_set(&ptr, "end", EFRA);
248
249                 RNA_boolean_set(&ptr, "init_scene_frame_range", false);
250         }
251
252         ui_alembic_export_settings(op->layout, &ptr);
253 }
254
255 static bool wm_alembic_export_check(bContext *UNUSED(C), wmOperator *op)
256 {
257         char filepath[FILE_MAX];
258         RNA_string_get(op->ptr, "filepath", filepath);
259
260         if (!BLI_testextensie(filepath, ".abc")) {
261                 BLI_ensure_extension(filepath, FILE_MAX, ".abc");
262                 RNA_string_set(op->ptr, "filepath", filepath);
263                 return true;
264         }
265
266         return false;
267 }
268
269 void WM_OT_alembic_export(wmOperatorType *ot)
270 {
271         ot->name = "Export Alembic";
272         ot->description = "Export current scene in an Alembic archive";
273         ot->idname = "WM_OT_alembic_export";
274
275         ot->invoke = wm_alembic_export_invoke;
276         ot->exec = wm_alembic_export_exec;
277         ot->poll = WM_operator_winactive;
278         ot->ui = wm_alembic_export_draw;
279         ot->check = wm_alembic_export_check;
280
281         WM_operator_properties_filesel(ot, FILE_TYPE_FOLDER | FILE_TYPE_ALEMBIC,
282                                        FILE_BLENDER, FILE_SAVE, WM_FILESEL_FILEPATH,
283                                        FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
284
285         RNA_def_int(ot->srna, "start", 1, INT_MIN, INT_MAX,
286                     "Start Frame", "Start Frame", INT_MIN, INT_MAX);
287
288         RNA_def_int(ot->srna, "end", 1, INT_MIN, INT_MAX,
289                     "End Frame", "End Frame", INT_MIN, INT_MAX);
290
291         RNA_def_int(ot->srna, "xsamples", 1, 1, 128,
292                     "Transform Samples", "Number of times per frame transformations are sampled", 1, 128);
293
294         RNA_def_int(ot->srna, "gsamples", 1, 1, 128,
295                     "Geometry Samples", "Number of times per frame object data are sampled", 1, 128);
296
297         RNA_def_float(ot->srna, "sh_open", 0.0f, -1.0f, 1.0f,
298                       "Shutter Open", "Time at which the shutter is open", -1.0f, 1.0f);
299
300         RNA_def_float(ot->srna, "sh_close", 1.0f, -1.0f, 1.0f,
301                       "Shutter Close", "Time at which the shutter is closed", -1.0f, 1.0f);
302
303         RNA_def_boolean(ot->srna, "selected", 0,
304                         "Selected Objects Only", "Export only selected objects");
305
306         RNA_def_boolean(ot->srna, "renderable_only", 1,
307                         "Renderable Objects Only",
308                         "Export only objects marked renderable in the outliner");
309
310         RNA_def_boolean(ot->srna, "visible_layers_only", 0,
311                         "Visible Layers Only", "Export only objects in visible layers");
312
313         RNA_def_boolean(ot->srna, "flatten", 0,
314                         "Flatten Hierarchy",
315                         "Do not preserve objects' parent/children relationship");
316
317         RNA_def_boolean(ot->srna, "uvs", 1, "UVs", "Export UVs");
318
319         RNA_def_boolean(ot->srna, "packuv", 1, "Pack UV Islands",
320                         "Export UVs with packed island");
321
322         RNA_def_boolean(ot->srna, "normals", 1, "Normals", "Export normals");
323
324         RNA_def_boolean(ot->srna, "vcolors", 0, "Vertex Colors", "Export vertex colors");
325
326         RNA_def_boolean(ot->srna, "face_sets", 0, "Face Sets", "Export per face shading group assignments");
327
328         RNA_def_boolean(ot->srna, "subdiv_schema", 0,
329                         "Use Subdivision Schema",
330                         "Export meshes using Alembic's subdivision schema");
331
332         RNA_def_boolean(ot->srna, "apply_subdiv", 0,
333                         "Apply Subsurf", "Export subdivision surfaces as meshes");
334
335         RNA_def_enum(ot->srna, "compression_type", rna_enum_abc_compression_items,
336                      ABC_ARCHIVE_OGAWA, "Compression", "");
337
338         RNA_def_float(ot->srna, "global_scale", 1.0f, 0.0001f, 1000.0f, "Scale",
339                       "Value by which to enlarge or shrink the objects with respect to the world's origin",
340                       0.0001f, 1000.0f);
341
342         RNA_def_boolean(ot->srna, "triangulate", false, "Triangulate",
343                         "Export Polygons (Quads & NGons) as Triangles");
344
345         RNA_def_enum(ot->srna, "quad_method", rna_enum_modifier_triangulate_quad_method_items,
346                      MOD_TRIANGULATE_QUAD_SHORTEDGE, "Quad Method", "Method for splitting the quads into triangles");
347
348         RNA_def_enum(ot->srna, "ngon_method", rna_enum_modifier_triangulate_quad_method_items,
349                      MOD_TRIANGULATE_NGON_BEAUTY, "Polygon Method", "Method for splitting the polygons into triangles");
350
351         /* This dummy prop is used to check whether we need to init the start and
352      * end frame values to that of the scene's, otherwise they are reset at
353      * every change, draw update. */
354         RNA_def_boolean(ot->srna, "init_scene_frame_range", false, "", "");
355 }
356
357 /* ************************************************************************** */
358
359 /* TODO(kevin): check on de-duplicating all this with code in image_ops.c */
360
361 typedef struct CacheFrame {
362         struct CacheFrame *next, *prev;
363         int framenr;
364 } CacheFrame;
365
366 static int cmp_frame(const void *a, const void *b)
367 {
368         const CacheFrame *frame_a = a;
369         const CacheFrame *frame_b = b;
370
371         if (frame_a->framenr < frame_b->framenr) return -1;
372         if (frame_a->framenr > frame_b->framenr) return 1;
373         return 0;
374 }
375
376 static int get_sequence_len(char *filename, int *ofs)
377 {
378         int frame;
379         int numdigit;
380
381         if (!BLI_path_frame_get(filename, &frame, &numdigit)) {
382                 return 1;
383         }
384
385         char path[FILE_MAX];
386         BLI_split_dir_part(filename, path, FILE_MAX);
387
388         DIR *dir = opendir(path);
389
390         const char *ext = ".abc";
391         const char *basename = BLI_path_basename(filename);
392         const int len = strlen(basename) - (numdigit + strlen(ext));
393
394         ListBase frames;
395         BLI_listbase_clear(&frames);
396
397         struct dirent *fname;
398         while ((fname = readdir(dir)) != NULL) {
399                 /* do we have the right extension? */
400                 if (!strstr(fname->d_name, ext)) {
401                         continue;
402                 }
403
404                 if (!STREQLEN(basename, fname->d_name, len)) {
405                         continue;
406                 }
407
408                 CacheFrame *cache_frame = MEM_callocN(sizeof(CacheFrame), "abc_frame");
409
410                 BLI_path_frame_get(fname->d_name, &cache_frame->framenr, &numdigit);
411
412                 BLI_addtail(&frames, cache_frame);
413         }
414
415         closedir(dir);
416
417         BLI_listbase_sort(&frames, cmp_frame);
418
419         CacheFrame *cache_frame = frames.first;
420
421         if (cache_frame) {
422                 int frame_curr = cache_frame->framenr;
423                 (*ofs) = frame_curr;
424
425                 while (cache_frame && (cache_frame->framenr == frame_curr)) {
426                         ++frame_curr;
427                         cache_frame = cache_frame->next;
428                 }
429
430                 BLI_freelistN(&frames);
431
432                 return frame_curr - (*ofs);
433         }
434
435         return 1;
436 }
437
438 /* ************************************************************************** */
439
440 static void ui_alembic_import_settings(uiLayout *layout, PointerRNA *imfptr)
441 {
442         uiLayout *box = uiLayoutBox(layout);
443         uiLayout *row = uiLayoutRow(box, false);
444         uiItemL(row, IFACE_("Manual Transform:"), ICON_NONE);
445
446         row = uiLayoutRow(box, false);
447         uiItemR(row, imfptr, "scale", 0, NULL, ICON_NONE);
448
449         box = uiLayoutBox(layout);
450         row = uiLayoutRow(box, false);
451         uiItemL(row, IFACE_("Options:"), ICON_NONE);
452
453         row = uiLayoutRow(box, false);
454         uiItemR(row, imfptr, "set_frame_range", 0, NULL, ICON_NONE);
455
456         row = uiLayoutRow(box, false);
457         uiItemR(row, imfptr, "is_sequence", 0, NULL, ICON_NONE);
458
459         row = uiLayoutRow(box, false);
460         uiItemR(row, imfptr, "validate_meshes", 0, NULL, ICON_NONE);
461 }
462
463 static void wm_alembic_import_draw(bContext *UNUSED(C), wmOperator *op)
464 {
465         PointerRNA ptr;
466
467         RNA_pointer_create(NULL, op->type->srna, op->properties, &ptr);
468         ui_alembic_import_settings(op->layout, &ptr);
469 }
470
471 static int wm_alembic_import_exec(bContext *C, wmOperator *op)
472 {
473         if (!RNA_struct_property_is_set(op->ptr, "filepath")) {
474                 BKE_report(op->reports, RPT_ERROR, "No filename given");
475                 return OPERATOR_CANCELLED;
476         }
477
478         char filename[FILE_MAX];
479         RNA_string_get(op->ptr, "filepath", filename);
480
481         const float scale = RNA_float_get(op->ptr, "scale");
482         const bool is_sequence = RNA_boolean_get(op->ptr, "is_sequence");
483         const bool set_frame_range = RNA_boolean_get(op->ptr, "set_frame_range");
484         const bool validate_meshes = RNA_boolean_get(op->ptr, "validate_meshes");
485
486         int offset = 0;
487         int sequence_len = 1;
488
489         if (is_sequence) {
490                 sequence_len = get_sequence_len(filename, &offset);
491         }
492
493         ABC_import(C, filename, scale, is_sequence, set_frame_range, sequence_len, offset, validate_meshes);
494
495         return OPERATOR_FINISHED;
496 }
497
498 void WM_OT_alembic_import(wmOperatorType *ot)
499 {
500         ot->name = "Import Alembic";
501         ot->description = "Load an Alembic archive";
502         ot->idname = "WM_OT_alembic_import";
503
504         ot->invoke = WM_operator_filesel;
505         ot->exec = wm_alembic_import_exec;
506         ot->poll = WM_operator_winactive;
507         ot->ui = wm_alembic_import_draw;
508
509         WM_operator_properties_filesel(ot, FILE_TYPE_FOLDER | FILE_TYPE_ALEMBIC,
510                                        FILE_BLENDER, FILE_SAVE, WM_FILESEL_FILEPATH,
511                                        FILE_DEFAULTDISPLAY, FILE_SORT_ALPHA);
512
513         RNA_def_float(ot->srna, "scale", 1.0f, 0.0001f, 1000.0f, "Scale",
514                       "Value by which to enlarge or shrink the objects with respect to the world's origin",
515                       0.0001f, 1000.0f);
516
517         RNA_def_boolean(ot->srna, "set_frame_range", true,
518                         "Set Frame Range",
519                         "If checked, update scene's start and end frame to match those of the Alembic archive");
520
521         RNA_def_boolean(ot->srna, "validate_meshes", 0,
522                         "Validate Meshes", "Check imported mesh objects for invalid data (slow)");
523
524         RNA_def_boolean(ot->srna, "is_sequence", false, "Is Sequence",
525                         "Set to true if the cache is split into separate files");
526 }
527
528 #endif