Cleanup: remove Cycles layer bits checking in the kernel.
[blender.git] / intern / cycles / blender / blender_util.h
1 /*
2  * Copyright 2011-2013 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __BLENDER_UTIL_H__
18 #define __BLENDER_UTIL_H__
19
20 #include "util_map.h"
21 #include "util_path.h"
22 #include "util_set.h"
23 #include "util_transform.h"
24 #include "util_types.h"
25 #include "util_vector.h"
26
27 /* Hacks to hook into Blender API
28  * todo: clean this up ... */
29
30 extern "C" {
31 size_t BLI_timecode_string_from_time_simple(char *str, size_t maxlen, double time_seconds);
32 void BKE_image_user_frame_calc(void *iuser, int cfra, int fieldnr);
33 void BKE_image_user_file_path(void *iuser, void *ima, char *path);
34 unsigned char *BKE_image_get_pixels_for_frame(void *image, int frame);
35 float *BKE_image_get_float_pixels_for_frame(void *image, int frame);
36 }
37
38 CCL_NAMESPACE_BEGIN
39
40 void python_thread_state_save(void **python_thread_state);
41 void python_thread_state_restore(void **python_thread_state);
42
43 static inline BL::Mesh object_to_mesh(BL::BlendData& data,
44                                       BL::Object& object,
45                                       BL::Scene& scene,
46                                       bool apply_modifiers,
47                                       bool render,
48                                       bool calc_undeformed)
49 {
50         BL::Mesh me = data.meshes.new_from_object(scene, object, apply_modifiers, (render)? 2: 1, false, calc_undeformed);
51         if((bool)me) {
52                 if(me.use_auto_smooth()) {
53                         me.calc_normals_split();
54                 }
55                 me.calc_tessface(true);
56         }
57         return me;
58 }
59
60 static inline void colorramp_to_array(BL::ColorRamp& ramp,
61                                       array<float3>& ramp_color,
62                                       array<float>& ramp_alpha,
63                                       int size)
64 {
65         ramp_color.resize(size);
66         ramp_alpha.resize(size);
67
68         for(int i = 0; i < size; i++) {
69                 float color[4];
70
71                 ramp.evaluate((float)i/(float)(size-1), color);
72                 ramp_color[i] = make_float3(color[0], color[1], color[2]);
73                 ramp_alpha[i] = color[3];
74         }
75 }
76
77 static inline void curvemap_minmax_curve(/*const*/ BL::CurveMap& curve,
78                                          float *min_x,
79                                          float *max_x)
80 {
81         *min_x = min(*min_x, curve.points[0].location()[0]);
82         *max_x = max(*max_x, curve.points[curve.points.length() - 1].location()[0]);
83 }
84
85 static inline void curvemapping_minmax(/*const*/ BL::CurveMapping& cumap,
86                                        bool rgb_curve,
87                                        float *min_x,
88                                        float *max_x)
89 {
90         /* const int num_curves = cumap.curves.length(); */  /* Gives linking error so far. */
91         const int num_curves = rgb_curve? 4: 3;
92         *min_x = FLT_MAX;
93         *max_x = -FLT_MAX;
94         for(int i = 0; i < num_curves; ++i) {
95                 BL::CurveMap map(cumap.curves[i]);
96                 curvemap_minmax_curve(map, min_x, max_x);
97         }
98 }
99
100 static inline void curvemapping_to_array(BL::CurveMapping& cumap,
101                                          float *data,
102                                          int size)
103 {
104         cumap.update();
105         BL::CurveMap curve = cumap.curves[0];
106         for(int i = 0; i < size; i++) {
107                 float t = (float)i/(float)(size-1);
108                 data[i] = curve.evaluate(t);
109         }
110 }
111
112 static inline void curvemapping_color_to_array(BL::CurveMapping& cumap,
113                                                array<float3>& data,
114                                                int size,
115                                                bool rgb_curve)
116 {
117         float min_x = 0.0f, max_x = 1.0f;
118
119         /* TODO(sergey): There is no easy way to automatically guess what is
120          * the range to be used here for the case when mapping is applied on
121          * top of another mapping (i.e. R curve applied on top of common
122          * one).
123          *
124          * Using largest possible range form all curves works correct for the
125          * cases like vector curves and should be good enough heuristic for
126          * the color curves as well.
127          *
128          * There might be some better estimations here tho.
129          */
130         curvemapping_minmax(cumap, rgb_curve, &min_x, &max_x);
131
132         const float range_x = max_x - min_x;
133
134         cumap.update();
135
136         BL::CurveMap mapR = cumap.curves[0];
137         BL::CurveMap mapG = cumap.curves[1];
138         BL::CurveMap mapB = cumap.curves[2];
139
140         data.resize(size);
141
142         if(rgb_curve) {
143                 BL::CurveMap mapI = cumap.curves[3];
144
145                 for(int i = 0; i < size; i++) {
146                         float t = min_x + (float)i/(float)(size-1) * range_x;
147
148                         data[i][0] = mapR.evaluate(mapI.evaluate(t));
149                         data[i][1] = mapG.evaluate(mapI.evaluate(t));
150                         data[i][2] = mapB.evaluate(mapI.evaluate(t));
151                 }
152         }
153         else {
154                 for(int i = 0; i < size; i++) {
155                         float t = min_x + (float)i/(float)(size-1) * range_x;
156
157                         data[i][0] = mapR.evaluate(t);
158                         data[i][1] = mapG.evaluate(t);
159                         data[i][2] = mapB.evaluate(t);
160                 }
161         }
162 }
163
164 static inline bool BKE_object_is_modified(BL::Object& self,
165                                           BL::Scene& scene,
166                                           bool preview)
167 {
168         return self.is_modified(scene, (preview)? (1<<0): (1<<1))? true: false;
169 }
170
171 static inline bool BKE_object_is_deform_modified(BL::Object& self,
172                                                  BL::Scene& scene,
173                                                  bool preview)
174 {
175         return self.is_deform_modified(scene, (preview)? (1<<0): (1<<1))? true: false;
176 }
177
178 static inline int render_resolution_x(BL::RenderSettings& b_render)
179 {
180         return b_render.resolution_x()*b_render.resolution_percentage()/100;
181 }
182
183 static inline int render_resolution_y(BL::RenderSettings& b_render)
184 {
185         return b_render.resolution_y()*b_render.resolution_percentage()/100;
186 }
187
188 static inline string image_user_file_path(BL::ImageUser& iuser,
189                                           BL::Image& ima,
190                                           int cfra)
191 {
192         char filepath[1024];
193         BKE_image_user_frame_calc(iuser.ptr.data, cfra, 0);
194         BKE_image_user_file_path(iuser.ptr.data, ima.ptr.data, filepath);
195         return string(filepath);
196 }
197
198 static inline int image_user_frame_number(BL::ImageUser& iuser, int cfra)
199 {
200         BKE_image_user_frame_calc(iuser.ptr.data, cfra, 0);
201         return iuser.frame_current();
202 }
203
204 static inline unsigned char *image_get_pixels_for_frame(BL::Image& image,
205                                                         int frame)
206 {
207         return BKE_image_get_pixels_for_frame(image.ptr.data, frame);
208 }
209
210 static inline float *image_get_float_pixels_for_frame(BL::Image& image,
211                                                       int frame)
212 {
213         return BKE_image_get_float_pixels_for_frame(image.ptr.data, frame);
214 }
215
216 /* Utilities */
217
218 static inline Transform get_transform(const BL::Array<float, 16>& array)
219 {
220         Transform tfm;
221
222         /* we assume both types to be just 16 floats, and transpose because blender
223          * use column major matrix order while we use row major */
224         memcpy(&tfm, &array, sizeof(float)*16);
225         tfm = transform_transpose(tfm);
226
227         return tfm;
228 }
229
230 static inline float2 get_float2(const BL::Array<float, 2>& array)
231 {
232         return make_float2(array[0], array[1]);
233 }
234
235 static inline float3 get_float3(const BL::Array<float, 2>& array)
236 {
237         return make_float3(array[0], array[1], 0.0f);
238 }
239
240 static inline float3 get_float3(const BL::Array<float, 3>& array)
241 {
242         return make_float3(array[0], array[1], array[2]);
243 }
244
245 static inline float3 get_float3(const BL::Array<float, 4>& array)
246 {
247         return make_float3(array[0], array[1], array[2]);
248 }
249
250 static inline float4 get_float4(const BL::Array<float, 4>& array)
251 {
252         return make_float4(array[0], array[1], array[2], array[3]);
253 }
254
255 static inline int3 get_int3(const BL::Array<int, 3>& array)
256 {
257         return make_int3(array[0], array[1], array[2]);
258 }
259
260 static inline int4 get_int4(const BL::Array<int, 4>& array)
261 {
262         return make_int4(array[0], array[1], array[2], array[3]);
263 }
264
265 static inline uint get_layer(const BL::Array<int, 20>& array)
266 {
267         uint layer = 0;
268
269         for(uint i = 0; i < 20; i++)
270                 if(array[i])
271                         layer |= (1 << i);
272         
273         return layer;
274 }
275
276 static inline uint get_layer(const BL::Array<int, 20>& array,
277                              const BL::Array<int, 8>& local_array,
278                              bool is_light = false,
279                              uint scene_layers = (1 << 20) - 1)
280 {
281         uint layer = 0;
282
283         for(uint i = 0; i < 20; i++)
284                 if(array[i])
285                         layer |= (1 << i);
286
287         if(is_light) {
288                 /* Consider light is visible if it was visible without layer
289                  * override, which matches behavior of Blender Internal.
290                  */
291                 if(layer & scene_layers) {
292                         for(uint i = 0; i < 8; i++)
293                                 layer |= (1 << (20+i));
294                 }
295         }
296         else {
297                 for(uint i = 0; i < 8; i++)
298                         if(local_array[i])
299                                 layer |= (1 << (20+i));
300         }
301
302         return layer;
303 }
304
305 static inline float3 get_float3(PointerRNA& ptr, const char *name)
306 {
307         float3 f;
308         RNA_float_get_array(&ptr, name, &f.x);
309         return f;
310 }
311
312 static inline void set_float3(PointerRNA& ptr, const char *name, float3 value)
313 {
314         RNA_float_set_array(&ptr, name, &value.x);
315 }
316
317 static inline float4 get_float4(PointerRNA& ptr, const char *name)
318 {
319         float4 f;
320         RNA_float_get_array(&ptr, name, &f.x);
321         return f;
322 }
323
324 static inline void set_float4(PointerRNA& ptr, const char *name, float4 value)
325 {
326         RNA_float_set_array(&ptr, name, &value.x);
327 }
328
329 static inline bool get_boolean(PointerRNA& ptr, const char *name)
330 {
331         return RNA_boolean_get(&ptr, name)? true: false;
332 }
333
334 static inline void set_boolean(PointerRNA& ptr, const char *name, bool value)
335 {
336         RNA_boolean_set(&ptr, name, (int)value);
337 }
338
339 static inline float get_float(PointerRNA& ptr, const char *name)
340 {
341         return RNA_float_get(&ptr, name);
342 }
343
344 static inline void set_float(PointerRNA& ptr, const char *name, float value)
345 {
346         RNA_float_set(&ptr, name, value);
347 }
348
349 static inline int get_int(PointerRNA& ptr, const char *name)
350 {
351         return RNA_int_get(&ptr, name);
352 }
353
354 static inline void set_int(PointerRNA& ptr, const char *name, int value)
355 {
356         RNA_int_set(&ptr, name, value);
357 }
358
359 /* Get a RNA enum value with sanity check: if the RNA value is above num_values
360  * the function will return a fallback default value.
361  *
362  * NOTE: This function assumes that RNA enum values are a continuous sequence
363  * from 0 to num_values-1. Be careful to use it with enums where some values are
364  * deprecated!
365  */
366 static inline int get_enum(PointerRNA& ptr,
367                            const char *name,
368                            int num_values = -1,
369                            int default_value = -1)
370 {
371         int value = RNA_enum_get(&ptr, name);
372         if(num_values != -1 && value >= num_values) {
373                 assert(default_value != -1);
374                 value = default_value;
375         }
376         return value;
377 }
378
379 static inline string get_enum_identifier(PointerRNA& ptr, const char *name)
380 {
381         PropertyRNA *prop = RNA_struct_find_property(&ptr, name);
382         const char *identifier = "";
383         int value = RNA_property_enum_get(&ptr, prop);
384
385         RNA_property_enum_identifier(NULL, &ptr, prop, value, &identifier);
386
387         return string(identifier);
388 }
389
390 static inline void set_enum(PointerRNA& ptr, const char *name, int value)
391 {
392         RNA_enum_set(&ptr, name, value);
393 }
394
395 static inline void set_enum(PointerRNA& ptr, const char *name, const string &identifier)
396 {
397         RNA_enum_set_identifier(NULL, &ptr, name, identifier.c_str());
398 }
399
400 static inline string get_string(PointerRNA& ptr, const char *name)
401 {
402         char cstrbuf[1024];
403         char *cstr = RNA_string_get_alloc(&ptr, name, cstrbuf, sizeof(cstrbuf));
404         string str(cstr);
405         if(cstr != cstrbuf)
406                 MEM_freeN(cstr);
407         
408         return str;
409 }
410
411 static inline void set_string(PointerRNA& ptr, const char *name, const string &value)
412 {
413         RNA_string_set(&ptr, name, value.c_str());
414 }
415
416 /* Relative Paths */
417
418 static inline string blender_absolute_path(BL::BlendData& b_data,
419                                            BL::ID& b_id,
420                                            const string& path)
421 {
422         if(path.size() >= 2 && path[0] == '/' && path[1] == '/') {
423                 string dirname;
424                 
425                 if(b_id.library()) {
426                         BL::ID b_library_id(b_id.library());
427                         dirname = blender_absolute_path(b_data,
428                                                         b_library_id,
429                                                         b_id.library().filepath());
430                 }
431                 else
432                         dirname = b_data.filepath();
433
434                 return path_join(path_dirname(dirname), path.substr(2));
435         }
436
437         return path;
438 }
439
440 /* Texture Space */
441
442 static inline void mesh_texture_space(BL::Mesh& b_mesh,
443                                       float3& loc,
444                                       float3& size)
445 {
446         loc = get_float3(b_mesh.texspace_location());
447         size = get_float3(b_mesh.texspace_size());
448
449         if(size.x != 0.0f) size.x = 0.5f/size.x;
450         if(size.y != 0.0f) size.y = 0.5f/size.y;
451         if(size.z != 0.0f) size.z = 0.5f/size.z;
452
453         loc = loc*size - make_float3(0.5f, 0.5f, 0.5f);
454 }
455
456 /* object used for motion blur */
457 static inline bool object_use_motion(BL::Object& b_parent, BL::Object& b_ob)
458 {
459         PointerRNA cobject = RNA_pointer_get(&b_ob.ptr, "cycles");
460         bool use_motion = get_boolean(cobject, "use_motion_blur");
461         /* If motion blur is enabled for the object we also check
462          * whether it's enabled for the parent object as well.
463          *
464          * This way we can control motion blur from the dupligroup
465          * duplicator much easier.
466          */
467         if(use_motion && b_parent.ptr.data != b_ob.ptr.data) {
468                 PointerRNA parent_cobject = RNA_pointer_get(&b_parent.ptr, "cycles");
469                 use_motion &= get_boolean(parent_cobject, "use_motion_blur");
470         }
471         return use_motion;
472 }
473
474 /* object motion steps */
475 static inline uint object_motion_steps(BL::Object& b_ob)
476 {
477         PointerRNA cobject = RNA_pointer_get(&b_ob.ptr, "cycles");
478         uint steps = get_int(cobject, "motion_steps");
479
480         /* use uneven number of steps so we get one keyframe at the current frame,
481          * and ue 2^(steps - 1) so objects with more/fewer steps still have samples
482          * at the same times, to avoid sampling at many different times */
483         return (2 << (steps - 1)) + 1;
484 }
485
486 /* object uses deformation motion blur */
487 static inline bool object_use_deform_motion(BL::Object& b_parent,
488                                             BL::Object& b_ob)
489 {
490         PointerRNA cobject = RNA_pointer_get(&b_ob.ptr, "cycles");
491         bool use_deform_motion = get_boolean(cobject, "use_deform_motion");
492         /* If motion blur is enabled for the object we also check
493          * whether it's enabled for the parent object as well.
494          *
495          * This way we can control motion blur from the dupligroup
496          * duplicator much easier.
497          */
498         if(use_deform_motion && b_parent.ptr.data != b_ob.ptr.data) {
499                 PointerRNA parent_cobject = RNA_pointer_get(&b_parent.ptr, "cycles");
500                 use_deform_motion &= get_boolean(parent_cobject, "use_deform_motion");
501         }
502         return use_deform_motion;
503 }
504
505 static inline BL::SmokeDomainSettings object_smoke_domain_find(BL::Object& b_ob)
506 {
507         BL::Object::modifiers_iterator b_mod;
508
509         for(b_ob.modifiers.begin(b_mod); b_mod != b_ob.modifiers.end(); ++b_mod) {
510                 if(b_mod->is_a(&RNA_SmokeModifier)) {
511                         BL::SmokeModifier b_smd(*b_mod);
512
513                         if(b_smd.smoke_type() == BL::SmokeModifier::smoke_type_DOMAIN)
514                                 return b_smd.domain_settings();
515                 }
516         }
517         
518         return BL::SmokeDomainSettings(PointerRNA_NULL);
519 }
520
521 /* ID Map
522  *
523  * Utility class to keep in sync with blender data.
524  * Used for objects, meshes, lights and shaders. */
525
526 template<typename K, typename T>
527 class id_map {
528 public:
529         id_map(vector<T*> *scene_data_)
530         {
531                 scene_data = scene_data_;
532         }
533
534         T *find(const BL::ID& id)
535         {
536                 return find(id.ptr.id.data);
537         }
538
539         T *find(const K& key)
540         {
541                 if(b_map.find(key) != b_map.end()) {
542                         T *data = b_map[key];
543                         return data;
544                 }
545
546                 return NULL;
547         }
548
549         void set_recalc(const BL::ID& id)
550         {
551                 b_recalc.insert(id.ptr.data);
552         }
553
554         bool has_recalc()
555         {
556                 return !(b_recalc.empty());
557         }
558
559         void pre_sync()
560         {
561                 used_set.clear();
562         }
563
564         bool sync(T **r_data, const BL::ID& id)
565         {
566                 return sync(r_data, id, id, id.ptr.id.data);
567         }
568
569         bool sync(T **r_data, const BL::ID& id, const BL::ID& parent, const K& key)
570         {
571                 T *data = find(key);
572                 bool recalc;
573
574                 if(!data) {
575                         /* add data if it didn't exist yet */
576                         data = new T();
577                         scene_data->push_back(data);
578                         b_map[key] = data;
579                         recalc = true;
580                 }
581                 else {
582                         recalc = (b_recalc.find(id.ptr.data) != b_recalc.end());
583                         if(parent.ptr.data)
584                                 recalc = recalc || (b_recalc.find(parent.ptr.data) != b_recalc.end());
585                 }
586
587                 used(data);
588
589                 *r_data = data;
590                 return recalc;
591         }
592
593         bool is_used(const K& key)
594         {
595                 T *data = find(key);
596                 return (data) ? used_set.find(data) != used_set.end() : false;
597         }
598
599         void used(T *data)
600         {
601                 /* tag data as still in use */
602                 used_set.insert(data);
603         }
604
605         void set_default(T *data)
606         {
607                 b_map[NULL] = data;
608         }
609
610         bool post_sync(bool do_delete = true)
611         {
612                 /* remove unused data */
613                 vector<T*> new_scene_data;
614                 typename vector<T*>::iterator it;
615                 bool deleted = false;
616
617                 for(it = scene_data->begin(); it != scene_data->end(); it++) {
618                         T *data = *it;
619
620                         if(do_delete && used_set.find(data) == used_set.end()) {
621                                 delete data;
622                                 deleted = true;
623                         }
624                         else
625                                 new_scene_data.push_back(data);
626                 }
627
628                 *scene_data = new_scene_data;
629
630                 /* update mapping */
631                 map<K, T*> new_map;
632                 typedef pair<const K, T*> TMapPair;
633                 typename map<K, T*>::iterator jt;
634
635                 for(jt = b_map.begin(); jt != b_map.end(); jt++) {
636                         TMapPair& pair = *jt;
637
638                         if(used_set.find(pair.second) != used_set.end())
639                                 new_map[pair.first] = pair.second;
640                 }
641
642                 used_set.clear();
643                 b_recalc.clear();
644                 b_map = new_map;
645
646                 return deleted;
647         }
648
649 protected:
650         vector<T*> *scene_data;
651         map<K, T*> b_map;
652         set<T*> used_set;
653         set<void*> b_recalc;
654 };
655
656 /* Object Key */
657
658 enum { OBJECT_PERSISTENT_ID_SIZE = 8 };
659
660 struct ObjectKey {
661         void *parent;
662         int id[OBJECT_PERSISTENT_ID_SIZE];
663         void *ob;
664
665         ObjectKey(void *parent_, int id_[OBJECT_PERSISTENT_ID_SIZE], void *ob_)
666         : parent(parent_), ob(ob_)
667         {
668                 if(id_)
669                         memcpy(id, id_, sizeof(id));
670                 else
671                         memset(id, 0, sizeof(id));
672         }
673
674         bool operator<(const ObjectKey& k) const
675         {
676                 if(ob < k.ob) {
677                         return true;
678                 }
679                 else if(ob == k.ob) {
680                         if(parent < k.parent)
681                                 return true;
682                         else if(parent == k.parent)
683                                 return memcmp(id, k.id, sizeof(id)) < 0;
684                 }
685
686                 return false;
687         }
688 };
689
690 /* Particle System Key */
691
692 struct ParticleSystemKey {
693         void *ob;
694         int id[OBJECT_PERSISTENT_ID_SIZE];
695
696         ParticleSystemKey(void *ob_, int id_[OBJECT_PERSISTENT_ID_SIZE])
697         : ob(ob_)
698         {
699                 if(id_)
700                         memcpy(id, id_, sizeof(id));
701                 else
702                         memset(id, 0, sizeof(id));
703         }
704
705         bool operator<(const ParticleSystemKey& k) const
706         {
707                 /* first id is particle index, we don't compare that */
708                 if(ob < k.ob)
709                         return true;
710                 else if(ob == k.ob)
711                         return memcmp(id+1, k.id+1, sizeof(int)*(OBJECT_PERSISTENT_ID_SIZE-1)) < 0;
712
713                 return false;
714         }
715 };
716
717 CCL_NAMESPACE_END
718
719 #endif /* __BLENDER_UTIL_H__ */
720