Cycles: support for image sequences in image/environment texture node.
[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
34 struct RenderEngine;
35 struct RenderResult;
36
37 ID *rna_Object_to_mesh(void *_self, void *reports, void *scene, int apply_modifiers, int settings);
38 void rna_Main_meshes_remove(void *bmain, void *reports, void *mesh);
39 void rna_Object_create_duplilist(void *ob, void *reports, void *sce);
40 void rna_Object_free_duplilist(void *ob, void *reports);
41 void rna_RenderLayer_rect_set(PointerRNA *ptr, const float *values);
42 void rna_RenderPass_rect_set(PointerRNA *ptr, const float *values);
43 struct RenderResult *RE_engine_begin_result(struct RenderEngine *engine, int x, int y, int w, int h);
44 void RE_engine_update_result(struct RenderEngine *engine, struct RenderResult *result);
45 void RE_engine_end_result(struct RenderEngine *engine, struct RenderResult *result);
46 int RE_engine_test_break(struct RenderEngine *engine);
47 void RE_engine_update_stats(struct RenderEngine *engine, const char *stats, const char *info);
48 void RE_engine_update_progress(struct RenderEngine *engine, float progress);
49 void engine_tag_redraw(void *engine);
50 void engine_tag_update(void *engine);
51 int rna_Object_is_modified(void *ob, void *scene, int settings);
52 int rna_Object_is_deform_modified(void *ob, void *scene, int settings);
53 void BLI_timestr(double _time, char *str);
54 void rna_ColorRamp_eval(void *coba, float position, float color[4]);
55 void rna_Scene_frame_set(void *scene, int frame, float subframe);
56 void BKE_image_user_file_path(void *iuser, void *ima, int cfra, char *path);
57
58 }
59
60 CCL_NAMESPACE_BEGIN
61
62 static inline BL::Mesh object_to_mesh(BL::Object self, BL::Scene scene, bool apply_modifiers, bool render)
63 {
64         ID *data = rna_Object_to_mesh(self.ptr.data, NULL, scene.ptr.data, apply_modifiers, (render)? 2: 1);
65         PointerRNA ptr;
66         RNA_id_pointer_create(data, &ptr);
67         return BL::Mesh(ptr);
68 }
69
70 static inline void colorramp_to_array(BL::ColorRamp ramp, float4 *data, int size)
71 {
72         for(int i = 0; i < size; i++) {
73                 float color[4];
74
75                 rna_ColorRamp_eval(ramp.ptr.data, i/(float)(size-1), color);
76                 data[i] = make_float4(color[0], color[1], color[2], color[3]);
77         }
78 }
79
80 static inline void object_remove_mesh(BL::BlendData data, BL::Mesh mesh)
81 {
82         rna_Main_meshes_remove(data.ptr.data, NULL, mesh.ptr.data);
83 }
84
85 static inline void object_create_duplilist(BL::Object self, BL::Scene scene)
86 {
87         rna_Object_create_duplilist(self.ptr.data, NULL, scene.ptr.data);
88 }
89
90 static inline void object_free_duplilist(BL::Object self)
91 {
92         rna_Object_free_duplilist(self.ptr.data, NULL);
93 }
94
95 static inline bool BKE_object_is_modified(BL::Object self, BL::Scene scene, bool preview)
96 {
97         return rna_Object_is_modified(self.ptr.data, scene.ptr.data, (preview)? (1<<0): (1<<1))? true: false;
98 }
99
100 static inline bool BKE_object_is_deform_modified(BL::Object self, BL::Scene scene, bool preview)
101 {
102         return rna_Object_is_deform_modified(self.ptr.data, scene.ptr.data, (preview)? (1<<0): (1<<1))? true: false;
103 }
104
105 static inline string image_user_file_path(BL::ImageUser iuser, BL::Image ima, int cfra)
106 {
107         char filepath[1024];
108         BKE_image_user_file_path(iuser.ptr.data, ima.ptr.data, cfra, filepath);
109         return string(filepath);
110 }
111
112 static inline void scene_frame_set(BL::Scene scene, int frame)
113 {
114         rna_Scene_frame_set(scene.ptr.data, frame, 0.0f);
115 }
116
117 /* Utilities */
118
119 static inline Transform get_transform(BL::Array<float, 16> array)
120 {
121         Transform tfm;
122
123         /* we assume both types to be just 16 floats, and transpose because blender
124            use column major matrix order while we use row major */
125         memcpy(&tfm, &array, sizeof(float)*16);
126         tfm = transform_transpose(tfm);
127
128         return tfm;
129 }
130
131 static inline float2 get_float2(BL::Array<float, 2> array)
132 {
133         return make_float2(array[0], array[1]);
134 }
135
136 static inline float3 get_float3(BL::Array<float, 2> array)
137 {
138         return make_float3(array[0], array[1], 0.0f);
139 }
140
141 static inline float3 get_float3(BL::Array<float, 3> array)
142 {
143         return make_float3(array[0], array[1], array[2]);
144 }
145
146 static inline float3 get_float3(BL::Array<float, 4> array)
147 {
148         return make_float3(array[0], array[1], array[2]);
149 }
150
151 static inline int4 get_int4(BL::Array<int, 4> array)
152 {
153         return make_int4(array[0], array[1], array[2], array[3]);
154 }
155
156 static inline uint get_layer(BL::Array<int, 20> array)
157 {
158         uint layer = 0;
159
160         for(uint i = 0; i < 20; i++)
161                 if(array[i])
162                         layer |= (1 << i);
163         
164         return layer;
165 }
166
167 /*static inline float3 get_float3(PointerRNA& ptr, const char *name)
168 {
169         float3 f;
170         RNA_float_get_array(&ptr, name, &f.x);
171         return f;
172 }*/
173
174 static inline bool get_boolean(PointerRNA& ptr, const char *name)
175 {
176         return RNA_boolean_get(&ptr, name)? true: false;
177 }
178
179 static inline float get_float(PointerRNA& ptr, const char *name)
180 {
181         return RNA_float_get(&ptr, name);
182 }
183
184 static inline int get_int(PointerRNA& ptr, const char *name)
185 {
186         return RNA_int_get(&ptr, name);
187 }
188
189 static inline int get_enum(PointerRNA& ptr, const char *name)
190 {
191         return RNA_enum_get(&ptr, name);
192 }
193
194 static inline string get_enum_identifier(PointerRNA& ptr, const char *name)
195 {
196         PropertyRNA *prop = RNA_struct_find_property(&ptr, name);
197         const char *identifier = "";
198         int value = RNA_property_enum_get(&ptr, prop);
199
200         RNA_property_enum_identifier(NULL, &ptr, prop, value, &identifier);
201
202         return string(identifier);
203 }
204
205 /* Relative Paths */
206
207 static inline string blender_absolute_path(BL::BlendData b_data, BL::ID b_id, const string& path)
208 {
209         if(path.size() >= 2 && path[0] == '/' && path[1] == '/') {
210                 string dirname;
211                 
212                 if(b_id.library())
213                         dirname = blender_absolute_path(b_data, b_id.library(), b_id.library().filepath());
214                 else
215                         dirname = b_data.filepath();
216
217                 return path_join(path_dirname(dirname), path.substr(2));
218         }
219
220         return path;
221 }
222
223 /* ID Map
224  *
225  * Utility class to keep in sync with blender data.
226  * Used for objects, meshes, lights and shaders. */
227
228 template<typename K, typename T>
229 class id_map {
230 public:
231         id_map(vector<T*> *scene_data_)
232         {
233                 scene_data = scene_data_;
234         }
235
236         T *find(BL::ID id)
237         {
238                 return find(id.ptr.id.data);
239         }
240
241         T *find(const K& key)
242         {
243                 if(b_map.find(key) != b_map.end()) {
244                         T *data = b_map[key];
245                         return data;
246                 }
247
248                 return NULL;
249         }
250
251         void set_recalc(BL::ID id)
252         {
253                 b_recalc.insert(id.ptr.data);
254         }
255
256         bool has_recalc()
257         {
258                 return !(b_recalc.empty());
259         }
260
261         void pre_sync()
262         {
263                 used_set.clear();
264         }
265
266         bool sync(T **r_data, BL::ID id)
267         {
268                 return sync(r_data, id, id, id.ptr.id.data);
269         }
270
271         bool sync(T **r_data, BL::ID id, BL::ID parent, const K& key)
272         {
273                 T *data = find(key);
274                 bool recalc;
275
276                 if(!data) {
277                         /* add data if it didn't exist yet */
278                         data = new T();
279                         scene_data->push_back(data);
280                         b_map[key] = data;
281                         recalc = true;
282                 }
283                 else {
284                         recalc = (b_recalc.find(id.ptr.data) != b_recalc.end());
285                         if(parent.ptr.data)
286                                 recalc = recalc || (b_recalc.find(parent.ptr.data) != b_recalc.end());
287                 }
288
289                 used(data);
290
291                 *r_data = data;
292                 return recalc;
293         }
294
295         void used(T *data)
296         {
297                 /* tag data as still in use */
298                 used_set.insert(data);
299         }
300
301         void set_default(T *data)
302         {
303                 b_map[NULL] = data;
304         }
305
306         bool post_sync(bool do_delete = true)
307         {
308                 /* remove unused data */
309                 vector<T*> new_scene_data;
310                 typename vector<T*>::iterator it;
311                 bool deleted = false;
312
313                 for(it = scene_data->begin(); it != scene_data->end(); it++) {
314                         T *data = *it;
315
316                         if(do_delete && used_set.find(data) == used_set.end()) {
317                                 delete data;
318                                 deleted = true;
319                         }
320                         else
321                                 new_scene_data.push_back(data);
322                 }
323
324                 *scene_data = new_scene_data;
325
326                 /* update mapping */
327                 map<K, T*> new_map;
328                 typedef pair<const K, T*> TMapPair;
329                 typename map<K, T*>::iterator jt;
330
331                 for(jt = b_map.begin(); jt != b_map.end(); jt++) {
332                         TMapPair& pair = *jt;
333
334                         if(used_set.find(pair.second) != used_set.end())
335                                 new_map[pair.first] = pair.second;
336                 }
337
338                 used_set.clear();
339                 b_recalc.clear();
340                 b_map = new_map;
341
342                 return deleted;
343         }
344
345 protected:
346         vector<T*> *scene_data;
347         map<K, T*> b_map;
348         set<T*> used_set;
349         set<void*> b_recalc;
350 };
351
352 /* Object Key */
353
354 struct ObjectKey {
355         void *parent;
356         int index;
357         void *ob;
358
359         ObjectKey(void *parent_, int index_, void *ob_)
360         : parent(parent_), index(index_), ob(ob_) {}
361
362         bool operator<(const ObjectKey& k) const
363         { return (parent < k.parent || (parent == k.parent && (index < k.index || (index == k.index && ob < k.ob)))); }
364 };
365
366 CCL_NAMESPACE_END
367
368 #endif /* __BLENDER_UTIL_H__ */
369