Alembic: Construct ISampleSelector once and pass along
[blender.git] / source / blender / alembic / intern / abc_object.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_object.h"
24
25 #include "abc_util.h"
26
27 extern "C" {
28 #include "DNA_cachefile_types.h"
29 #include "DNA_constraint_types.h"
30 #include "DNA_modifier_types.h"
31 #include "DNA_object_types.h"
32 #include "DNA_space_types.h"  /* for FILE_MAX */
33
34 #include "BKE_constraint.h"
35 #include "BKE_depsgraph.h"
36 #include "BKE_idprop.h"
37 #include "BKE_library.h"
38 #include "BKE_modifier.h"
39 #include "BKE_object.h"
40
41 #include "BLI_listbase.h"
42 #include "BLI_math.h"
43 #include "BLI_string.h"
44 }
45
46 using Alembic::AbcGeom::IObject;
47 using Alembic::AbcGeom::IXform;
48 using Alembic::AbcGeom::IXformSchema;
49
50 using Alembic::AbcGeom::OCompoundProperty;
51 using Alembic::AbcGeom::ODoubleArrayProperty;
52 using Alembic::AbcGeom::ODoubleProperty;
53 using Alembic::AbcGeom::OFloatArrayProperty;
54 using Alembic::AbcGeom::OFloatProperty;
55 using Alembic::AbcGeom::OInt32ArrayProperty;
56 using Alembic::AbcGeom::OInt32Property;
57 using Alembic::AbcGeom::OStringArrayProperty;
58 using Alembic::AbcGeom::OStringProperty;
59
60 /* ************************************************************************** */
61
62 AbcObjectWriter::AbcObjectWriter(Scene *scene,
63                                  Object *ob,
64                                  uint32_t time_sampling,
65                                  ExportSettings &settings,
66                                  AbcObjectWriter *parent)
67     : m_object(ob)
68     , m_settings(settings)
69     , m_scene(scene)
70     , m_time_sampling(time_sampling)
71     , m_first_frame(true)
72 {
73         m_name = get_id_name(m_object) + "Shape";
74
75         if (parent) {
76                 parent->addChild(this);
77         }
78 }
79
80 AbcObjectWriter::~AbcObjectWriter()
81 {}
82
83 void AbcObjectWriter::addChild(AbcObjectWriter *child)
84 {
85         m_children.push_back(child);
86 }
87
88 Imath::Box3d AbcObjectWriter::bounds()
89 {
90         BoundBox *bb = BKE_object_boundbox_get(this->m_object);
91
92         if (!bb) {
93                 if (this->m_object->type != OB_CAMERA) {
94                         ABC_LOG(m_settings.logger) << "Bounding box is null!\n";
95                 }
96
97                 return Imath::Box3d();
98         }
99
100         /* Convert Z-up to Y-up. This also changes which vector goes into which min/max property. */
101         this->m_bounds.min.x = bb->vec[0][0];
102         this->m_bounds.min.y = bb->vec[0][2];
103         this->m_bounds.min.z = -bb->vec[6][1];
104
105         this->m_bounds.max.x = bb->vec[6][0];
106         this->m_bounds.max.y = bb->vec[6][2];
107         this->m_bounds.max.z = -bb->vec[0][1];
108
109         return this->m_bounds;
110 }
111
112 void AbcObjectWriter::write()
113 {
114         do_write();
115         m_first_frame = false;
116 }
117
118 /* ************************************************************************** */
119
120 AbcObjectReader::AbcObjectReader(const IObject &object, ImportSettings &settings)
121     : m_name("")
122     , m_object_name("")
123     , m_data_name("")
124     , m_object(NULL)
125     , m_iobject(object)
126     , m_settings(&settings)
127     , m_min_time(std::numeric_limits<chrono_t>::max())
128     , m_max_time(std::numeric_limits<chrono_t>::min())
129     , m_refcount(0)
130     , parent_reader(NULL)
131 {
132         m_name = object.getFullName();
133         std::vector<std::string> parts;
134         split(m_name, '/', parts);
135
136         if (parts.size() >= 2) {
137                 m_object_name = parts[parts.size() - 2];
138                 m_data_name = parts[parts.size() - 1];
139         }
140         else {
141                 m_object_name = m_data_name = parts[parts.size() - 1];
142         }
143 }
144
145 AbcObjectReader::~AbcObjectReader()
146 {}
147
148 const IObject &AbcObjectReader::iobject() const
149 {
150         return m_iobject;
151 }
152
153 Object *AbcObjectReader::object() const
154 {
155         return m_object;
156 }
157
158 void AbcObjectReader::object(Object *ob)
159 {
160         m_object = ob;
161 }
162
163 static Imath::M44d blend_matrices(const Imath::M44d &m0, const Imath::M44d &m1, const float weight)
164 {
165         float mat0[4][4], mat1[4][4], ret[4][4];
166
167         /* Cannot use Imath::M44d::getValue() since this returns a pointer to
168          * doubles and interp_m4_m4m4 expects pointers to floats. So need to convert
169          * the matrices manually.
170          */
171
172         for (int i = 0; i < 4; ++i) {
173                 for (int j = 0; j < 4; ++j) {
174                         mat0[i][j] = static_cast<float>(m0[i][j]);
175                 }
176         }
177
178         for (int i = 0; i < 4; ++i) {
179                 for (int j = 0; j < 4; ++j) {
180                         mat1[i][j] = static_cast<float>(m1[i][j]);
181                 }
182         }
183
184         interp_m4_m4m4(ret, mat0, mat1, weight);
185
186         Imath::M44d m;
187
188         for (int i = 0; i < 4; ++i) {
189                 for (int j = 0; j < 4; ++j) {
190                         m[i][j] = ret[i][j];
191                 }
192         }
193
194         return m;
195 }
196
197 Imath::M44d get_matrix(const IXformSchema &schema, const float time)
198 {
199         Alembic::AbcGeom::index_t i0, i1;
200         Alembic::AbcGeom::XformSample s0, s1;
201
202         const float weight = get_weight_and_index(time,
203                                                   schema.getTimeSampling(),
204                                                   schema.getNumSamples(),
205                                                   i0,
206                                                   i1);
207
208         schema.get(s0, Alembic::AbcGeom::ISampleSelector(i0));
209
210         if (i0 != i1) {
211                 schema.get(s1, Alembic::AbcGeom::ISampleSelector(i1));
212                 return blend_matrices(s0.getMatrix(), s1.getMatrix(), weight);
213         }
214
215         return s0.getMatrix();
216 }
217
218 DerivedMesh *AbcObjectReader::read_derivedmesh(DerivedMesh *dm,
219                                                const Alembic::Abc::ISampleSelector &UNUSED(sample_sel),
220                                                int UNUSED(read_flag),
221                                                const char **UNUSED(err_str))
222 {
223         return dm;
224 }
225
226 void AbcObjectReader::setupObjectTransform(const float time)
227 {
228         bool is_constant = false;
229
230         this->read_matrix(m_object->obmat, time, m_settings->scale, is_constant);
231         invert_m4_m4(m_object->imat, m_object->obmat);
232
233         BKE_object_apply_mat4(m_object, m_object->obmat, false,  false);
234
235         if (!is_constant) {
236                 bConstraint *con = BKE_constraint_add_for_object(m_object, NULL, CONSTRAINT_TYPE_TRANSFORM_CACHE);
237                 bTransformCacheConstraint *data = static_cast<bTransformCacheConstraint *>(con->data);
238                 BLI_strncpy(data->object_path, m_iobject.getFullName().c_str(), FILE_MAX);
239
240                 data->cache_file = m_settings->cache_file;
241                 id_us_plus(&data->cache_file->id);
242
243                 data->reader = reinterpret_cast<CacheReader *>(this);
244                 this->incref();
245         }
246 }
247
248 Alembic::AbcGeom::IXform AbcObjectReader::xform()
249 {
250         /* Check that we have an empty object (locator, bone head/tail...).  */
251         if (IXform::matches(m_iobject.getMetaData())) {
252                 return IXform(m_iobject, Alembic::AbcGeom::kWrapExisting);
253         }
254
255         /* Check that we have an object with actual data, in which case the
256          * parent Alembic object should contain the transform. */
257         IObject abc_parent = m_iobject.getParent();
258
259         /* The archive's top object can be recognised by not having a parent. */
260         if (abc_parent.getParent()
261                 && IXform::matches(abc_parent.getMetaData())) {
262                 return IXform(abc_parent, Alembic::AbcGeom::kWrapExisting);
263         }
264
265         /* Should not happen. */
266         std::cerr << "AbcObjectReader::xform(): "
267                   << "unable to find IXform for Alembic object '"
268                   << m_iobject.getFullName() << "'\n";
269         BLI_assert(false);
270
271         return IXform();
272 }
273
274 void AbcObjectReader::read_matrix(float r_mat[4][4], const float time,
275                                   const float scale, bool &is_constant)
276 {
277         IXform ixform = xform();
278         if (!ixform) {
279                 return;
280         }
281
282         const IXformSchema & schema(ixform.getSchema());
283         if (!schema.valid()) {
284                 std::cerr << "Alembic object " << ixform.getFullName()
285                           << " has an invalid schema." << std::endl;
286                 return;
287         }
288
289         bool has_alembic_parent;
290         IObject ixform_parent = ixform.getParent();
291         if (!ixform_parent.getParent()) {
292                 /* The archive top object certainly is not a transform itself, so handle
293                  * it as "no parent". */
294                 has_alembic_parent = false;
295         }
296         else {
297                 has_alembic_parent = ixform_parent && schema.getInheritsXforms();
298
299                 if (has_alembic_parent && m_object->parent == NULL) {
300                         /* TODO Sybren: This happened in some files. I think I solved it,
301                          * but I'll leave this check in here anyway until we've tested it
302                          * more thoroughly. Better than crashing on a null parent anyway. */
303                         std::cerr << "Alembic object " << m_iobject.getFullName()
304                                   << " with transform " << ixform.getFullName()
305                                   << " has an Alembic parent but no parent Blender object."
306                                   << std::endl;
307                         has_alembic_parent = false;
308                 }
309         }
310
311         const Imath::M44d matrix = get_matrix(schema, time);
312         convert_matrix(matrix, m_object, r_mat);
313
314         if (has_alembic_parent) {
315                 /* In this case, the matrix in Alembic is in local coordinates, so
316                  * convert to world matrix. To prevent us from reading and accumulating
317                  * all parent matrices in the Alembic file, we assume that the Blender
318                  * parent object is already updated for the current timekey, and use its
319                  * world matrix. */
320                 BLI_assert(m_object->parent);
321                 mul_m4_m4m4(r_mat, m_object->parent->obmat, r_mat);
322         }
323         else {
324                 /* Only apply scaling to root objects, parenting will propagate it. */
325                 float scale_mat[4][4];
326                 scale_m4_fl(scale_mat, scale);
327                 scale_mat[3][3] = scale; /* scale translations too */
328                 mul_m4_m4m4(r_mat, r_mat, scale_mat);
329         }
330
331         is_constant = schema.isConstant();
332 }
333
334 void AbcObjectReader::addCacheModifier()
335 {
336         ModifierData *md = modifier_new(eModifierType_MeshSequenceCache);
337         BLI_addtail(&m_object->modifiers, md);
338
339         MeshSeqCacheModifierData *mcmd = reinterpret_cast<MeshSeqCacheModifierData *>(md);
340
341         mcmd->cache_file = m_settings->cache_file;
342         id_us_plus(&mcmd->cache_file->id);
343
344         BLI_strncpy(mcmd->object_path, m_iobject.getFullName().c_str(), FILE_MAX);
345
346         mcmd->reader = reinterpret_cast<CacheReader *>(this);
347         this->incref();
348 }
349
350 chrono_t AbcObjectReader::minTime() const
351 {
352         return m_min_time;
353 }
354
355 chrono_t AbcObjectReader::maxTime() const
356 {
357         return m_max_time;
358 }
359
360 int AbcObjectReader::refcount() const
361 {
362         return m_refcount;
363 }
364
365 void AbcObjectReader::incref()
366 {
367         ++m_refcount;
368 }
369
370 void AbcObjectReader::decref()
371 {
372         --m_refcount;
373         BLI_assert(m_refcount >= 0);
374 }