Merge branch 'master' into blender2.8
[blender.git] / source / blender / alembic / intern / abc_util.cc
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  * Contributor(s): Esteban Tovagliari, Cedric Paille, Kevin Dietrich
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #include "abc_util.h"
24
25 #include "abc_camera.h"
26 #include "abc_curves.h"
27 #include "abc_mesh.h"
28 #include "abc_nurbs.h"
29 #include "abc_points.h"
30 #include "abc_transform.h"
31
32 #include <Alembic/AbcMaterial/IMaterial.h>
33
34 #include <algorithm>
35
36 extern "C" {
37 #include "DNA_object_types.h"
38 #include "DNA_layer_types.h"
39
40 #include "BLI_math.h"
41
42 #include "PIL_time.h"
43 }
44
45 std::string get_id_name(const Object * const ob)
46 {
47         if (!ob) {
48                 return "";
49         }
50
51         return get_id_name(&ob->id);
52 }
53
54 std::string get_id_name(const ID * const id)
55 {
56         std::string name(id->name + 2);
57         std::replace(name.begin(), name.end(), ' ', '_');
58         std::replace(name.begin(), name.end(), '.', '_');
59         std::replace(name.begin(), name.end(), ':', '_');
60
61         return name;
62 }
63
64 /**
65  * @brief get_object_dag_path_name returns the name under which the object
66  *  will be exported in the Alembic file. It is of the form
67  *  "[../grandparent/]parent/object" if dupli_parent is NULL, or
68  *  "dupli_parent/[../grandparent/]parent/object" otherwise.
69  * @param ob
70  * @param dupli_parent
71  * @return
72  */
73 std::string get_object_dag_path_name(const Object * const ob, Object *dupli_parent)
74 {
75         std::string name = get_id_name(ob);
76
77         Object *p = ob->parent;
78
79         while (p) {
80                 name = get_id_name(p) + "/" + name;
81                 p = p->parent;
82         }
83
84         if (dupli_parent && (ob != dupli_parent)) {
85                 name = get_id_name(dupli_parent) + "/" + name;
86         }
87
88         return name;
89 }
90
91 bool object_selected(const Base * const ob_base)
92 {
93         return ob_base->flag & SELECT;
94 }
95
96 Imath::M44d convert_matrix(float mat[4][4])
97 {
98         Imath::M44d m;
99
100         for (int i = 0; i < 4; ++i) {
101                 for (int j = 0; j < 4; ++j) {
102                         m[i][j] = mat[i][j];
103                 }
104         }
105
106         return m;
107 }
108
109 void split(const std::string &s, const char delim, std::vector<std::string> &tokens)
110 {
111         tokens.clear();
112
113         std::stringstream ss(s);
114         std::string item;
115
116         while (std::getline(ss, item, delim)) {
117                 if (!item.empty()) {
118                         tokens.push_back(item);
119                 }
120         }
121 }
122
123 void create_swapped_rotation_matrix(
124         float rot_x_mat[3][3], float rot_y_mat[3][3],
125         float rot_z_mat[3][3], const float euler[3],
126         AbcAxisSwapMode mode)
127 {
128         const float rx = euler[0];
129         float ry;
130         float rz;
131
132         /* Apply transformation */
133         switch (mode) {
134                 case ABC_ZUP_FROM_YUP:
135                         ry = -euler[2];
136                         rz = euler[1];
137                         break;
138                 case ABC_YUP_FROM_ZUP:
139                         ry = euler[2];
140                         rz = -euler[1];
141                         break;
142                 default:
143                         BLI_assert(false);
144         }
145
146         unit_m3(rot_x_mat);
147         unit_m3(rot_y_mat);
148         unit_m3(rot_z_mat);
149
150         rot_x_mat[1][1] = cos(rx);
151         rot_x_mat[2][1] = -sin(rx);
152         rot_x_mat[1][2] = sin(rx);
153         rot_x_mat[2][2] = cos(rx);
154
155         rot_y_mat[2][2] = cos(ry);
156         rot_y_mat[0][2] = -sin(ry);
157         rot_y_mat[2][0] = sin(ry);
158         rot_y_mat[0][0] = cos(ry);
159
160         rot_z_mat[0][0] = cos(rz);
161         rot_z_mat[1][0] = -sin(rz);
162         rot_z_mat[0][1] = sin(rz);
163         rot_z_mat[1][1] = cos(rz);
164 }
165
166 /* Convert matrix from Z=up to Y=up or vice versa. Use yup_mat = zup_mat for in-place conversion. */
167 void copy_m44_axis_swap(float dst_mat[4][4], float src_mat[4][4], AbcAxisSwapMode mode)
168 {
169         float dst_rot[3][3], src_rot[3][3], dst_scale_mat[4][4];
170         float rot_x_mat[3][3], rot_y_mat[3][3], rot_z_mat[3][3];
171         float src_trans[3], dst_scale[3], src_scale[3], euler[3];
172
173         zero_v3(src_trans);
174         zero_v3(dst_scale);
175         zero_v3(src_scale);
176         zero_v3(euler);
177         unit_m3(src_rot);
178         unit_m3(dst_rot);
179         unit_m4(dst_scale_mat);
180
181         /* We assume there is no sheer component and no homogeneous scaling component. */
182         BLI_assert(fabs(src_mat[0][3]) < 2 * FLT_EPSILON);
183         BLI_assert(fabs(src_mat[1][3]) < 2 * FLT_EPSILON);
184         BLI_assert(fabs(src_mat[2][3]) < 2 * FLT_EPSILON);
185         BLI_assert(fabs(src_mat[3][3] - 1.0f) < 2 * FLT_EPSILON);
186
187         /* Extract translation, rotation, and scale form matrix. */
188         mat4_to_loc_rot_size(src_trans, src_rot, src_scale, src_mat);
189
190         /* Get euler angles from rotation matrix. */
191         mat3_to_eulO(euler, ROT_MODE_XZY, src_rot);
192
193         /* Create X, Y, Z rotation matrices from euler angles. */
194         create_swapped_rotation_matrix(rot_x_mat, rot_y_mat, rot_z_mat, euler, mode);
195
196         /* Concatenate rotation matrices. */
197         mul_m3_m3m3(dst_rot, dst_rot, rot_z_mat);
198         mul_m3_m3m3(dst_rot, dst_rot, rot_y_mat);
199         mul_m3_m3m3(dst_rot, dst_rot, rot_x_mat);
200
201         mat3_to_eulO(euler, ROT_MODE_XZY, dst_rot);
202
203         /* Start construction of dst_mat from rotation matrix */
204         unit_m4(dst_mat);
205         copy_m4_m3(dst_mat, dst_rot);
206
207         /* Apply translation */
208         switch (mode) {
209                 case ABC_ZUP_FROM_YUP:
210                         copy_zup_from_yup(dst_mat[3], src_trans);
211                         break;
212                 case ABC_YUP_FROM_ZUP:
213                         copy_yup_from_zup(dst_mat[3], src_trans);
214                         break;
215                 default:
216                         BLI_assert(false);
217         }
218
219         /* Apply scale matrix. Swaps y and z, but does not
220          * negate like translation does. */
221         dst_scale[0] = src_scale[0];
222         dst_scale[1] = src_scale[2];
223         dst_scale[2] = src_scale[1];
224
225         size_to_mat4(dst_scale_mat, dst_scale);
226         mul_m4_m4m4(dst_mat, dst_mat, dst_scale_mat);
227 }
228
229 void convert_matrix(const Imath::M44d &xform, Object *ob, float r_mat[4][4])
230 {
231         for (int i = 0; i < 4; ++i) {
232                 for (int j = 0; j < 4; ++j) {
233                         r_mat[i][j] = static_cast<float>(xform[i][j]);
234                 }
235         }
236
237         if (ob->type == OB_CAMERA) {
238                 float cam_to_yup[4][4];
239                 axis_angle_to_mat4_single(cam_to_yup, 'X', M_PI_2);
240                 mul_m4_m4m4(r_mat, r_mat, cam_to_yup);
241         }
242
243         copy_m44_axis_swap(r_mat, r_mat, ABC_ZUP_FROM_YUP);
244 }
245
246 /* Recompute transform matrix of object in new coordinate system
247  * (from Z-Up to Y-Up). */
248 void create_transform_matrix(Object *obj, float r_yup_mat[4][4], AbcMatrixMode mode,
249                              Object *proxy_from)
250 {
251         float zup_mat[4][4];
252
253         /* get local or world matrix. */
254         if (mode == ABC_MATRIX_LOCAL && obj->parent) {
255                 /* Note that this produces another matrix than the local matrix, due to
256                  * constraints and modifiers as well as the obj->parentinv matrix. */
257                 invert_m4_m4(obj->parent->imat, obj->parent->obmat);
258                 mul_m4_m4m4(zup_mat, obj->parent->imat, obj->obmat);
259         }
260         else {
261                 copy_m4_m4(zup_mat, obj->obmat);
262         }
263
264         if (proxy_from) {
265                 mul_m4_m4m4(zup_mat, proxy_from->obmat, zup_mat);
266         }
267
268         copy_m44_axis_swap(r_yup_mat, zup_mat, ABC_YUP_FROM_ZUP);
269 }
270
271 bool has_property(const Alembic::Abc::ICompoundProperty &prop, const std::string &name)
272 {
273         if (!prop.valid()) {
274                 return false;
275         }
276
277         return prop.getPropertyHeader(name) != NULL;
278 }
279
280 typedef std::pair<Alembic::AbcCoreAbstract::index_t, float> index_time_pair_t;
281
282 float get_weight_and_index(float time,
283                            const Alembic::AbcCoreAbstract::TimeSamplingPtr &time_sampling,
284                            int samples_number,
285                            Alembic::AbcGeom::index_t &i0,
286                            Alembic::AbcGeom::index_t &i1)
287 {
288         samples_number = std::max(samples_number, 1);
289
290         index_time_pair_t t0 = time_sampling->getFloorIndex(time, samples_number);
291         i0 = i1 = t0.first;
292
293         if (samples_number == 1 || (fabs(time - t0.second) < 0.0001f)) {
294                 return 0.0f;
295         }
296
297         index_time_pair_t t1 = time_sampling->getCeilIndex(time, samples_number);
298         i1 = t1.first;
299
300         if (i0 == i1) {
301                 return 0.0f;
302         }
303
304         const float bias = (time - t0.second) / (t1.second - t0.second);
305
306         if (fabs(1.0f - bias) < 0.0001f) {
307                 i0 = i1;
308                 return 0.0f;
309         }
310
311         return bias;
312 }
313
314 //#define USE_NURBS
315
316 AbcObjectReader *create_reader(const Alembic::AbcGeom::IObject &object, ImportSettings &settings)
317 {
318         AbcObjectReader *reader = NULL;
319
320         const Alembic::AbcGeom::MetaData &md = object.getMetaData();
321
322         if (Alembic::AbcGeom::IXform::matches(md)) {
323                 reader = new AbcEmptyReader(object, settings);
324         }
325         else if (Alembic::AbcGeom::IPolyMesh::matches(md)) {
326                 reader = new AbcMeshReader(object, settings);
327         }
328         else if (Alembic::AbcGeom::ISubD::matches(md)) {
329                 reader = new AbcSubDReader(object, settings);
330         }
331         else if (Alembic::AbcGeom::INuPatch::matches(md)) {
332 #ifdef USE_NURBS
333                 /* TODO(kevin): importing cyclic NURBS from other software crashes
334                  * at the moment. This is due to the fact that NURBS in other
335                  * software have duplicated points which causes buffer overflows in
336                  * Blender. Need to figure out exactly how these points are
337                  * duplicated, in all cases (cyclic U, cyclic V, and cyclic UV).
338                  * Until this is fixed, disabling NURBS reading. */
339                 reader = new AbcNurbsReader(child, settings);
340 #endif
341         }
342         else if (Alembic::AbcGeom::ICamera::matches(md)) {
343                 reader = new AbcCameraReader(object, settings);
344         }
345         else if (Alembic::AbcGeom::IPoints::matches(md)) {
346                 reader = new AbcPointsReader(object, settings);
347         }
348         else if (Alembic::AbcMaterial::IMaterial::matches(md)) {
349                 /* Pass for now. */
350         }
351         else if (Alembic::AbcGeom::ILight::matches(md)) {
352                 /* Pass for now. */
353         }
354         else if (Alembic::AbcGeom::IFaceSet::matches(md)) {
355                 /* Pass, those are handled in the mesh reader. */
356         }
357         else if (Alembic::AbcGeom::ICurves::matches(md)) {
358                 reader = new AbcCurveReader(object, settings);
359         }
360         else {
361                 std::cerr << "Alembic: unknown how to handle objects of schema "
362                           << md.get("schemaObjTitle")
363                           << ", skipping object "
364                           << object.getFullName() << std::endl;
365         }
366
367         return reader;
368 }
369
370 /* ********************** */
371
372 ScopeTimer::ScopeTimer(const char *message)
373         : m_message(message)
374         , m_start(PIL_check_seconds_timer())
375 {}
376
377 ScopeTimer::~ScopeTimer()
378 {
379         fprintf(stderr, "%s: %fs\n", m_message, PIL_check_seconds_timer() - m_start);
380 }
381
382 /* ********************** */
383
384 bool SimpleLogger::empty()
385 {
386         return ((size_t)m_stream.tellp()) == 0ul;
387 }
388
389 std::string SimpleLogger::str() const
390 {
391         return m_stream.str();
392 }
393
394 void SimpleLogger::clear()
395 {
396         m_stream.clear();
397         m_stream.str("");
398 }
399
400 std::ostringstream &SimpleLogger::stream()
401 {
402         return m_stream;
403 }
404
405 std::ostream &operator<<(std::ostream &os, const SimpleLogger &logger)
406 {
407         os << logger.str();
408         return os;
409 }