svn merge ^/trunk/blender -r55372:55392
[blender.git] / intern / cycles / blender / blender_util.h
1 /*
2  * Copyright 2011, Blender Foundation.
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
19 #ifndef __BLENDER_UTIL_H__
20 #define __BLENDER_UTIL_H__
21
22 #include "util_map.h"
23 #include "util_path.h"
24 #include "util_set.h"
25 #include "util_transform.h"
26 #include "util_types.h"
27 #include "util_vector.h"
28
29 /* Hacks to hook into Blender API
30  * todo: clean this up ... */
31
32 extern "C" {
33 void BLI_timestr(double _time, char *str);
34 void BKE_image_user_frame_calc(void *iuser, int cfra, int fieldnr);
35 void BKE_image_user_file_path(void *iuser, void *ima, char *path);
36 unsigned char *BKE_image_get_pixels_for_frame(void *image, int frame);
37 float *BKE_image_get_float_pixels_for_frame(void *image, int frame);
38 }
39
40 CCL_NAMESPACE_BEGIN
41
42 static inline BL::Mesh object_to_mesh(BL::BlendData data, BL::Object object, BL::Scene scene, bool apply_modifiers, bool render)
43 {
44         return data.meshes.new_from_object(scene, object, apply_modifiers, (render)? 2: 1, true);
45 }
46
47 static inline void colorramp_to_array(BL::ColorRamp ramp, float4 *data, int size)
48 {
49         for(int i = 0; i < size; i++) {
50                 float color[4];
51
52                 ramp.evaluate(i/(float)(size-1), color);
53                 data[i] = make_float4(color[0], color[1], color[2], color[3]);
54         }
55 }
56
57 static inline void curvemapping_color_to_array(BL::CurveMapping cumap, float4 *data, int size, bool rgb_curve)
58 {
59         cumap.update();
60
61         BL::CurveMap mapR = cumap.curves[0];
62         BL::CurveMap mapG = cumap.curves[1];
63         BL::CurveMap mapB = cumap.curves[2];
64
65         if(rgb_curve) {
66                 BL::CurveMap mapI = cumap.curves[3];
67
68                 for(int i = 0; i < size; i++) {
69                         float t = i/(float)(size-1);
70
71                         data[i][0] = mapR.evaluate(mapI.evaluate(t));
72                         data[i][1] = mapG.evaluate(mapI.evaluate(t));
73                         data[i][2] = mapB.evaluate(mapI.evaluate(t));
74                 }
75         }
76         else {
77                 for(int i = 0; i < size; i++) {
78                         float t = i/(float)(size-1);
79
80                         data[i][0] = mapR.evaluate(t);
81                         data[i][1] = mapG.evaluate(t);
82                         data[i][2] = mapB.evaluate(t);
83                 }
84         }
85 }
86
87 static inline bool BKE_object_is_modified(BL::Object self, BL::Scene scene, bool preview)
88 {
89         return self.is_modified(scene, (preview)? (1<<0): (1<<1))? true: false;
90 }
91
92 static inline bool BKE_object_is_deform_modified(BL::Object self, BL::Scene scene, bool preview)
93 {
94         return self.is_deform_modified(scene, (preview)? (1<<0): (1<<1))? true: false;
95 }
96
97 static inline string image_user_file_path(BL::ImageUser iuser, BL::Image ima, int cfra)
98 {
99         char filepath[1024];
100         BKE_image_user_frame_calc(iuser.ptr.data, cfra, 0);
101         BKE_image_user_file_path(iuser.ptr.data, ima.ptr.data, filepath);
102         return string(filepath);
103 }
104
105 static inline int image_user_frame_number(BL::ImageUser iuser, int cfra)
106 {
107         BKE_image_user_frame_calc(iuser.ptr.data, cfra, 0);
108         return iuser.frame_current();
109 }
110
111 static inline unsigned char *image_get_pixels_for_frame(BL::Image image, int frame)
112 {
113         return BKE_image_get_pixels_for_frame(image.ptr.data, frame);
114 }
115
116 static inline float *image_get_float_pixels_for_frame(BL::Image image, int frame)
117 {
118         return BKE_image_get_float_pixels_for_frame(image.ptr.data, frame);
119 }
120
121 /* Utilities */
122
123 static inline Transform get_transform(BL::Array<float, 16> array)
124 {
125         Transform tfm;
126
127         /* we assume both types to be just 16 floats, and transpose because blender
128          * use column major matrix order while we use row major */
129         memcpy(&tfm, &array, sizeof(float)*16);
130         tfm = transform_transpose(tfm);
131
132         return tfm;
133 }
134
135 static inline float2 get_float2(BL::Array<float, 2> array)
136 {
137         return make_float2(array[0], array[1]);
138 }
139
140 static inline float3 get_float3(BL::Array<float, 2> array)
141 {
142         return make_float3(array[0], array[1], 0.0f);
143 }
144
145 static inline float3 get_float3(BL::Array<float, 3> array)
146 {
147         return make_float3(array[0], array[1], array[2]);
148 }
149
150 static inline float3 get_float3(BL::Array<float, 4> array)
151 {
152         return make_float3(array[0], array[1], array[2]);
153 }
154
155 static inline float4 get_float4(BL::Array<float, 4> array)
156 {
157         return make_float4(array[0], array[1], array[2], array[3]);
158 }
159
160 static inline int4 get_int4(BL::Array<int, 4> array)
161 {
162         return make_int4(array[0], array[1], array[2], array[3]);
163 }
164
165 static inline uint get_layer(BL::Array<int, 20> array)
166 {
167         uint layer = 0;
168
169         for(uint i = 0; i < 20; i++)
170                 if(array[i])
171                         layer |= (1 << i);
172         
173         return layer;
174 }
175
176 static inline uint get_layer(BL::Array<int, 20> array, BL::Array<int, 8> local_array, bool use_local, bool is_light = false)
177 {
178         uint layer = 0;
179
180         for(uint i = 0; i < 20; i++)
181                 if(array[i])
182                         layer |= (1 << i);
183
184         if(is_light) {
185                 /* consider lamps on all local view layers */
186                 for(uint i = 0; i < 8; i++)
187                         layer |= (1 << (20+i));
188         }
189         else {
190                 for(uint i = 0; i < 8; i++)
191                         if(local_array[i])
192                                 layer |= (1 << (20+i));
193         }
194
195         /* we don't have spare bits for localview (normally 20-28) because
196          * PATH_RAY_LAYER_SHIFT uses 20-32. So - check if we have localview and if
197          * so, shift local view bits down to 1-8, since this is done for the view
198          * port only - it should be OK and not conflict with render layers. */
199         if(use_local)
200                 layer >>= 20;
201
202         return layer;
203 }
204
205 static inline float3 get_float3(PointerRNA& ptr, const char *name)
206 {
207         float3 f;
208         RNA_float_get_array(&ptr, name, &f.x);
209         return f;
210 }
211
212 static inline void set_float3(PointerRNA& ptr, const char *name, float3 value)
213 {
214         RNA_float_set_array(&ptr, name, &value.x);
215 }
216
217 static inline float4 get_float4(PointerRNA& ptr, const char *name)
218 {
219         float4 f;
220         RNA_float_get_array(&ptr, name, &f.x);
221         return f;
222 }
223
224 static inline void set_float4(PointerRNA& ptr, const char *name, float4 value)
225 {
226         RNA_float_set_array(&ptr, name, &value.x);
227 }
228
229 static inline bool get_boolean(PointerRNA& ptr, const char *name)
230 {
231         return RNA_boolean_get(&ptr, name)? true: false;
232 }
233
234 static inline void set_boolean(PointerRNA& ptr, const char *name, bool value)
235 {
236         RNA_boolean_set(&ptr, name, (int)value);
237 }
238
239 static inline float get_float(PointerRNA& ptr, const char *name)
240 {
241         return RNA_float_get(&ptr, name);
242 }
243
244 static inline void set_float(PointerRNA& ptr, const char *name, float value)
245 {
246         RNA_float_set(&ptr, name, value);
247 }
248
249 static inline int get_int(PointerRNA& ptr, const char *name)
250 {
251         return RNA_int_get(&ptr, name);
252 }
253
254 static inline void set_int(PointerRNA& ptr, const char *name, int value)
255 {
256         RNA_int_set(&ptr, name, value);
257 }
258
259 static inline int get_enum(PointerRNA& ptr, const char *name)
260 {
261         return RNA_enum_get(&ptr, name);
262 }
263
264 static inline string get_enum_identifier(PointerRNA& ptr, const char *name)
265 {
266         PropertyRNA *prop = RNA_struct_find_property(&ptr, name);
267         const char *identifier = "";
268         int value = RNA_property_enum_get(&ptr, prop);
269
270         RNA_property_enum_identifier(NULL, &ptr, prop, value, &identifier);
271
272         return string(identifier);
273 }
274
275 static inline void set_enum(PointerRNA& ptr, const char *name, int value)
276 {
277         RNA_enum_set(&ptr, name, value);
278 }
279
280 static inline void set_enum(PointerRNA& ptr, const char *name, const string &identifier)
281 {
282         RNA_enum_set_identifier(&ptr, name, identifier.c_str());
283 }
284
285 static inline string get_string(PointerRNA& ptr, const char *name)
286 {
287         char cstrbuf[1024];
288         char *cstr = RNA_string_get_alloc(&ptr, name, cstrbuf, sizeof(cstrbuf));
289         string str(cstr);
290         if (cstr != cstrbuf)
291                 MEM_freeN(cstr);
292         
293         return str;
294 }
295
296 static inline void set_string(PointerRNA& ptr, const char *name, const string &value)
297 {
298         RNA_string_set(&ptr, name, value.c_str());
299 }
300
301 /* Relative Paths */
302
303 static inline string blender_absolute_path(BL::BlendData b_data, BL::ID b_id, const string& path)
304 {
305         if(path.size() >= 2 && path[0] == '/' && path[1] == '/') {
306                 string dirname;
307                 
308                 if(b_id.library())
309                         dirname = blender_absolute_path(b_data, b_id.library(), b_id.library().filepath());
310                 else
311                         dirname = b_data.filepath();
312
313                 return path_join(path_dirname(dirname), path.substr(2));
314         }
315
316         return path;
317 }
318
319 /* Texture Space */
320
321 static inline void mesh_texture_space(BL::Mesh b_mesh, float3& loc, float3& size)
322 {
323         loc = get_float3(b_mesh.texspace_location());
324         size = get_float3(b_mesh.texspace_size());
325
326         if(size.x != 0.0f) size.x = 0.5f/size.x;
327         if(size.y != 0.0f) size.y = 0.5f/size.y;
328         if(size.z != 0.0f) size.z = 0.5f/size.z;
329
330         loc = loc*size - make_float3(0.5f, 0.5f, 0.5f);
331 }
332
333 /* ID Map
334  *
335  * Utility class to keep in sync with blender data.
336  * Used for objects, meshes, lights and shaders. */
337
338 template<typename K, typename T>
339 class id_map {
340 public:
341         id_map(vector<T*> *scene_data_)
342         {
343                 scene_data = scene_data_;
344         }
345
346         T *find(BL::ID id)
347         {
348                 return find(id.ptr.id.data);
349         }
350
351         T *find(const K& key)
352         {
353                 if(b_map.find(key) != b_map.end()) {
354                         T *data = b_map[key];
355                         return data;
356                 }
357
358                 return NULL;
359         }
360
361         void set_recalc(BL::ID id)
362         {
363                 b_recalc.insert(id.ptr.data);
364         }
365
366         bool has_recalc()
367         {
368                 return !(b_recalc.empty());
369         }
370
371         void pre_sync()
372         {
373                 used_set.clear();
374         }
375
376         bool sync(T **r_data, BL::ID id)
377         {
378                 return sync(r_data, id, id, id.ptr.id.data);
379         }
380
381         bool sync(T **r_data, BL::ID id, BL::ID parent, const K& key)
382         {
383                 T *data = find(key);
384                 bool recalc;
385
386                 if(!data) {
387                         /* add data if it didn't exist yet */
388                         data = new T();
389                         scene_data->push_back(data);
390                         b_map[key] = data;
391                         recalc = true;
392                 }
393                 else {
394                         recalc = (b_recalc.find(id.ptr.data) != b_recalc.end());
395                         if(parent.ptr.data)
396                                 recalc = recalc || (b_recalc.find(parent.ptr.data) != b_recalc.end());
397                 }
398
399                 used(data);
400
401                 *r_data = data;
402                 return recalc;
403         }
404
405         bool is_used(const K& key)
406         {
407                 T *data = find(key);
408                 return (data) ? used_set.find(data) != used_set.end() : false;
409         }
410
411         void used(T *data)
412         {
413                 /* tag data as still in use */
414                 used_set.insert(data);
415         }
416
417         void set_default(T *data)
418         {
419                 b_map[NULL] = data;
420         }
421
422         bool post_sync(bool do_delete = true)
423         {
424                 /* remove unused data */
425                 vector<T*> new_scene_data;
426                 typename vector<T*>::iterator it;
427                 bool deleted = false;
428
429                 for(it = scene_data->begin(); it != scene_data->end(); it++) {
430                         T *data = *it;
431
432                         if(do_delete && used_set.find(data) == used_set.end()) {
433                                 delete data;
434                                 deleted = true;
435                         }
436                         else
437                                 new_scene_data.push_back(data);
438                 }
439
440                 *scene_data = new_scene_data;
441
442                 /* update mapping */
443                 map<K, T*> new_map;
444                 typedef pair<const K, T*> TMapPair;
445                 typename map<K, T*>::iterator jt;
446
447                 for(jt = b_map.begin(); jt != b_map.end(); jt++) {
448                         TMapPair& pair = *jt;
449
450                         if(used_set.find(pair.second) != used_set.end())
451                                 new_map[pair.first] = pair.second;
452                 }
453
454                 used_set.clear();
455                 b_recalc.clear();
456                 b_map = new_map;
457
458                 return deleted;
459         }
460
461 protected:
462         vector<T*> *scene_data;
463         map<K, T*> b_map;
464         set<T*> used_set;
465         set<void*> b_recalc;
466 };
467
468 /* Object Key */
469
470 enum { OBJECT_PERSISTENT_ID_SIZE = 8 };
471
472 struct ObjectKey {
473         void *parent;
474         int id[OBJECT_PERSISTENT_ID_SIZE];
475         void *ob;
476
477         ObjectKey(void *parent_, int id_[OBJECT_PERSISTENT_ID_SIZE], void *ob_)
478         : parent(parent_), ob(ob_)
479         {
480                 if(id_)
481                         memcpy(id, id_, sizeof(id));
482                 else
483                         memset(id, 0, sizeof(id));
484         }
485
486         bool operator<(const ObjectKey& k) const
487         {
488                 if(ob < k.ob) {
489                         return true;
490                 }
491                 else if(ob == k.ob) {
492                         if(parent < k.parent)
493                                 return true;
494                         else if(parent == k.parent)
495                                 return memcmp(id, k.id, sizeof(id)) < 0;
496                 }
497
498                 return false;
499         }
500 };
501
502 /* Particle System Key */
503
504 struct ParticleSystemKey {
505         void *ob;
506         int id[OBJECT_PERSISTENT_ID_SIZE];
507
508         ParticleSystemKey(void *ob_, int id_[OBJECT_PERSISTENT_ID_SIZE])
509         : ob(ob_)
510         {
511                 if(id_)
512                         memcpy(id, id_, sizeof(id));
513                 else
514                         memset(id, 0, sizeof(id));
515         }
516
517         bool operator<(const ParticleSystemKey& k) const
518         {
519                 /* first id is particle index, we don't compare that */
520                 if(ob < k.ob)
521                         return true;
522                 else if(ob == k.ob)
523                         return memcmp(id+1, k.id+1, sizeof(int)*(OBJECT_PERSISTENT_ID_SIZE-1)) < 0;
524
525                 return false;
526         }
527 };
528
529 CCL_NAMESPACE_END
530
531 #endif /* __BLENDER_UTIL_H__ */
532