- registering new python classes runs the free functions on existing classes.
[blender-staging.git] / source / blender / makesrna / intern / rna_render.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Blender Foundation (2009)
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "DNA_scene_types.h"
28
29 #include "RNA_define.h"
30 #include "RNA_types.h"
31
32 #include "rna_internal.h"
33
34 #include "WM_types.h"
35
36 #include "RE_pipeline.h"
37
38 #ifdef RNA_RUNTIME
39
40 #include "MEM_guardedalloc.h"
41
42 #include "RNA_access.h"
43
44 #include "BKE_context.h"
45 #include "BKE_report.h"
46
47 #include "WM_api.h"
48
49 /* RenderEngine */
50
51 static RenderEngineType internal_render_type = {
52         NULL, NULL, "BLENDER_RENDER", "Blender Render", RE_INTERNAL, NULL, {NULL, NULL, NULL, NULL}};
53 #if GAMEBLENDER == 1
54 static RenderEngineType internal_game_type = {
55         NULL, NULL, "BLENDER_GAME", "Blender Game", RE_INTERNAL|RE_GAME, NULL, {NULL, NULL, NULL, NULL}};
56 #endif
57
58 ListBase R_engines = {NULL, NULL};
59
60 void RE_engines_init()
61 {
62         BLI_addtail(&R_engines, &internal_render_type);
63 #if GAMEBLENDER == 1
64         BLI_addtail(&R_engines, &internal_game_type);
65 #endif
66 }
67
68 void RE_engines_exit()
69 {
70         RenderEngineType *type, *next;
71
72         for(type=R_engines.first; type; type=next) {
73                 next= type->next;
74
75                 BLI_remlink(&R_engines, type);
76
77                 if(!(type->flag & RE_INTERNAL)) {
78                         if(type->ext.free)
79                                 type->ext.free(type->ext.data);
80
81                         MEM_freeN(type);
82                 }
83         }
84 }
85
86 static void engine_render(RenderEngine *engine, struct Scene *scene)
87 {
88         PointerRNA ptr;
89         ParameterList list;
90         FunctionRNA *func;
91
92         RNA_pointer_create(NULL, engine->type->ext.srna, engine, &ptr);
93         func= RNA_struct_find_function(&ptr, "render");
94
95         RNA_parameter_list_create(&list, &ptr, func);
96         RNA_parameter_set_lookup(&list, "scene", &scene);
97         engine->type->ext.call(&ptr, func, &list);
98
99         RNA_parameter_list_free(&list);
100 }
101
102 static void rna_RenderEngine_unregister(const bContext *C, StructRNA *type)
103 {
104         RenderEngineType *et= RNA_struct_blender_type_get(type);
105
106         if(!et)
107                 return;
108         
109         et->ext.free(et->ext.data);                     /* decref's the PyObject that the srna owns */
110         RNA_struct_py_type_set(type, NULL);     /* NULL the srna's value so RNA_struct_free wont complain of a leak */
111
112         BLI_freelinkN(&R_engines, et);
113         RNA_struct_free(&BLENDER_RNA, type);
114 }
115
116 static StructRNA *rna_RenderEngine_register(const bContext *C, ReportList *reports, void *data, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
117 {
118         RenderEngineType *et, dummyet = {0};
119         RenderEngine dummyengine= {0};
120         PointerRNA dummyptr;
121         int have_function[1];
122
123         /* setup dummy engine & engine type to store static properties in */
124         dummyengine.type= &dummyet;
125         RNA_pointer_create(NULL, &RNA_RenderEngine, &dummyengine, &dummyptr);
126
127         /* validate the python class */
128         if(validate(&dummyptr, data, have_function) != 0)
129                 return NULL;
130         
131         /* check if we have registered this engine type before, and remove it */
132         for(et=R_engines.first; et; et=et->next) {
133                 if(strcmp(et->idname, dummyet.idname) == 0) {
134                         if(et->ext.srna)
135                                 rna_RenderEngine_unregister(C, et->ext.srna);
136                         break;
137                 }
138         }
139         
140         /* create a new engine type */
141         et= MEM_callocN(sizeof(RenderEngineType), "python buttons engine");
142         memcpy(et, &dummyet, sizeof(dummyet));
143
144         et->ext.srna= RNA_def_struct(&BLENDER_RNA, et->idname, "RenderEngine"); 
145         et->ext.data= data;
146         et->ext.call= call;
147         et->ext.free= free;
148         RNA_struct_blender_type_set(et->ext.srna, et);
149
150         et->render= (have_function[0])? engine_render: NULL;
151
152         BLI_addtail(&R_engines, et);
153
154         return et->ext.srna;
155 }
156
157 static StructRNA* rna_RenderEngine_refine(PointerRNA *ptr)
158 {
159         RenderEngine *engine= (RenderEngine*)ptr->data;
160         return (engine->type && engine->type->ext.srna)? engine->type->ext.srna: &RNA_RenderEngine;
161 }
162
163 static void rna_RenderResult_layers_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
164 {
165         RenderResult *rr= (RenderResult*)ptr->data;
166         rna_iterator_listbase_begin(iter, &rr->layers, NULL);
167 }
168
169 static void rna_RenderLayer_passes_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
170 {
171         RenderLayer *rl= (RenderLayer*)ptr->data;
172         rna_iterator_listbase_begin(iter, &rl->passes, NULL);
173 }
174
175 static float rna_RenderValue_value_get(PointerRNA *ptr)
176 {
177         return *(float*)ptr->data;
178 }
179
180 static void rna_RenderValue_value_set(PointerRNA *ptr, float value)
181 {
182         *(float*)ptr->data= value;
183 }
184
185 static void rna_RenderLayer_rect_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
186 {
187         RenderLayer *rl= (RenderLayer*)ptr->data;
188         rna_iterator_array_begin(iter, (void*)rl->rectf, sizeof(float), rl->rectx*rl->recty*4, 0, NULL);
189 }
190
191 static int rna_RenderLayer_rect_length(PointerRNA *ptr)
192 {
193         RenderLayer *rl= (RenderLayer*)ptr->data;
194         return rl->rectx*rl->recty*4;
195 }
196
197 static void rna_RenderPass_rect_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
198 {
199         RenderPass *rpass= (RenderPass*)ptr->data;
200         rna_iterator_array_begin(iter, (void*)rpass->rect, sizeof(float), rpass->rectx*rpass->recty*rpass->channels, 0, NULL);
201 }
202
203 static int rna_RenderPass_rect_length(PointerRNA *ptr)
204 {
205         RenderPass *rpass= (RenderPass*)ptr->data;
206         return rpass->rectx*rpass->recty*rpass->channels;
207 }
208
209
210 #else // RNA_RUNTIME
211
212 static void rna_def_render_engine(BlenderRNA *brna)
213 {
214         StructRNA *srna;
215         PropertyRNA *prop;
216         FunctionRNA *func;
217         
218         srna= RNA_def_struct(brna, "RenderEngine", NULL);
219         RNA_def_struct_sdna(srna, "RenderEngine");
220         RNA_def_struct_ui_text(srna, "Render Engine", "Render engine.");
221         RNA_def_struct_refine_func(srna, "rna_RenderEngine_refine");
222         RNA_def_struct_register_funcs(srna, "rna_RenderEngine_register", "rna_RenderEngine_unregister");
223
224         /* render */
225         func= RNA_def_function(srna, "render", NULL);
226         RNA_def_function_ui_description(func, "Render scene into an image.");
227         RNA_def_function_flag(func, FUNC_REGISTER);
228         RNA_def_pointer(func, "scene", "Scene", "", "");
229
230         func= RNA_def_function(srna, "begin_result", "RE_engine_begin_result");
231         prop= RNA_def_int(func, "x", 0, 0, INT_MAX, "X", "", 0, INT_MAX);
232         RNA_def_property_flag(prop, PROP_REQUIRED);
233         prop= RNA_def_int(func, "y", 0, 0, INT_MAX, "Y", "", 0, INT_MAX);
234         RNA_def_property_flag(prop, PROP_REQUIRED);
235         prop= RNA_def_int(func, "w", 0, 0, INT_MAX, "Width", "", 0, INT_MAX);
236         RNA_def_property_flag(prop, PROP_REQUIRED);
237         prop= RNA_def_int(func, "h", 0, 0, INT_MAX, "Height", "", 0, INT_MAX);
238         RNA_def_property_flag(prop, PROP_REQUIRED);
239         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
240         RNA_def_function_return(func, prop);
241
242         func= RNA_def_function(srna, "update_result", "RE_engine_update_result");
243         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
244         RNA_def_property_flag(prop, PROP_REQUIRED);
245
246         func= RNA_def_function(srna, "end_result", "RE_engine_end_result");
247         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
248         RNA_def_property_flag(prop, PROP_REQUIRED);
249
250         func= RNA_def_function(srna, "test_break", "RE_engine_test_break");
251         prop= RNA_def_boolean(func, "do_break", 0, "Break", "");
252         RNA_def_function_return(func, prop);
253
254         func= RNA_def_function(srna, "update_stats", "RE_engine_update_stats");
255         prop= RNA_def_string(func, "stats", "", 0, "Stats", "");
256         RNA_def_property_flag(prop, PROP_REQUIRED);
257         prop= RNA_def_string(func, "info", "", 0, "Info", "");
258         RNA_def_property_flag(prop, PROP_REQUIRED);
259
260         /* registration */
261         RNA_define_verify_sdna(0);
262
263         prop= RNA_def_property(srna, "idname", PROP_STRING, PROP_NONE);
264         RNA_def_property_string_sdna(prop, NULL, "type->idname");
265         RNA_def_property_flag(prop, PROP_REGISTER);
266
267         prop= RNA_def_property(srna, "label", PROP_STRING, PROP_NONE);
268         RNA_def_property_string_sdna(prop, NULL, "type->name");
269         RNA_def_property_flag(prop, PROP_REGISTER);
270
271         RNA_define_verify_sdna(1);
272 }
273
274 static void rna_def_render_result(BlenderRNA *brna)
275 {
276         StructRNA *srna;
277         PropertyRNA *prop;
278         
279         srna= RNA_def_struct(brna, "RenderResult", NULL);
280         RNA_def_struct_ui_text(srna, "Render Result", "Result of rendering, including all layers and passes.");
281
282         RNA_define_verify_sdna(0);
283
284         prop= RNA_def_property(srna, "resolution_x", PROP_INT, PROP_NONE);
285         RNA_def_property_int_sdna(prop, NULL, "rectx");
286         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
287
288         prop= RNA_def_property(srna, "resolution_y", PROP_INT, PROP_NONE);
289         RNA_def_property_int_sdna(prop, NULL, "recty");
290         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
291
292         prop= RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
293         RNA_def_property_struct_type(prop, "RenderLayer");
294         RNA_def_property_collection_funcs(prop, "rna_RenderResult_layers_begin", "rna_iterator_listbase_next", "rna_iterator_listbase_end", "rna_iterator_listbase_get", 0, 0, 0, 0, 0);
295
296         RNA_define_verify_sdna(1);
297 }
298
299 static void rna_def_render_layer(BlenderRNA *brna)
300 {
301         StructRNA *srna;
302         PropertyRNA *prop;
303         FunctionRNA *func;
304         
305         srna= RNA_def_struct(brna, "RenderLayer", NULL);
306         RNA_def_struct_ui_text(srna, "Render Layer", "");
307
308         func= RNA_def_function(srna, "rect_from_file", "RE_layer_rect_from_file");
309         RNA_def_function_ui_description(func, "Copies the pixels of this renderlayer from an image file.");
310         RNA_def_function_flag(func, FUNC_USE_REPORTS);
311         prop= RNA_def_string(func, "filename", "", 0, "Filename", "Filename to load into this render tile, must be no smaller then the renderlayer");
312         RNA_def_property_flag(prop, PROP_REQUIRED);
313         prop= RNA_def_int(func, "x", 0, 0, INT_MAX, "Offset X", "Offset the position to copy from if the image is larger then the render layer", 0, INT_MAX);
314         RNA_def_property_flag(prop, PROP_REQUIRED);
315         prop= RNA_def_int(func, "y", 0, 0, INT_MAX, "Offset Y", "Offset the position to copy from if the image is larger then the render layer", 0, INT_MAX);
316         RNA_def_property_flag(prop, PROP_REQUIRED);
317         
318         RNA_define_verify_sdna(0);
319
320         rna_def_render_layer_common(srna, 0);
321
322         prop= RNA_def_property(srna, "passes", PROP_COLLECTION, PROP_NONE);
323         RNA_def_property_struct_type(prop, "RenderPass");
324         RNA_def_property_collection_funcs(prop, "rna_RenderLayer_passes_begin", "rna_iterator_listbase_next", "rna_iterator_listbase_end", "rna_iterator_listbase_get", 0, 0, 0, 0, 0);
325
326         prop= RNA_def_property(srna, "rect", PROP_COLLECTION, PROP_NONE);
327         RNA_def_property_struct_type(prop, "RenderValue");
328         RNA_def_property_collection_funcs(prop, "rna_RenderLayer_rect_begin", "rna_iterator_array_next", "rna_iterator_array_end", "rna_iterator_array_get", "rna_RenderLayer_rect_length", 0, 0, 0, 0);
329
330         /* value */
331         srna= RNA_def_struct(brna, "RenderValue", NULL);
332         RNA_def_struct_ui_text(srna, "Render Value", "");
333
334         prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
335         RNA_def_property_float_funcs(prop, "rna_RenderValue_value_get", "rna_RenderValue_value_set", NULL);
336
337         RNA_define_verify_sdna(1);
338 }
339
340 static void rna_def_render_pass(BlenderRNA *brna)
341 {
342         StructRNA *srna;
343         PropertyRNA *prop;
344
345         static EnumPropertyItem pass_type_items[]= {
346                 {SCE_PASS_COMBINED, "COMBINED", 0, "Combined", ""},
347                 {SCE_PASS_Z, "Z", 0, "Z", ""},
348                 {SCE_PASS_RGBA, "COLOR", 0, "Color", ""},
349                 {SCE_PASS_DIFFUSE, "DIFFUSE", 0, "Diffuse", ""},
350                 {SCE_PASS_SPEC, "SPECULAR", 0, "Specular", ""},
351                 {SCE_PASS_SHADOW, "SHADOW", 0, "Shadow", ""},
352                 {SCE_PASS_AO, "AO", 0, "AO", ""},
353                 {SCE_PASS_REFLECT, "REFLECTION", 0, "Reflection", ""},
354                 {SCE_PASS_NORMAL, "NORMAL", 0, "Normal", ""},
355                 {SCE_PASS_VECTOR, "VECTOR", 0, "Vecotr", ""},
356                 {SCE_PASS_REFRACT, "REFRACTION", 0, "Refraction", ""},
357                 {SCE_PASS_INDEXOB, "OBJECT_INDEX", 0, "Object Index", ""},
358                 {SCE_PASS_UV, "UV", 0, "UV", ""},
359                 {SCE_PASS_MIST, "MIST", 0, "Mist", ""},
360                 {0, NULL, 0, NULL, NULL}};
361         
362         srna= RNA_def_struct(brna, "RenderPass", NULL);
363         RNA_def_struct_ui_text(srna, "Render Pass", "");
364
365         RNA_define_verify_sdna(0);
366
367         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
368         RNA_def_property_string_sdna(prop, NULL, "name");
369         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
370         RNA_def_struct_name_property(srna, prop);
371
372         prop= RNA_def_property(srna, "channel_id", PROP_STRING, PROP_NONE);
373         RNA_def_property_string_sdna(prop, NULL, "chan_id");
374         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
375
376         prop= RNA_def_property(srna, "channels", PROP_INT, PROP_NONE);
377         RNA_def_property_int_sdna(prop, NULL, "channels");
378         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
379
380         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
381         RNA_def_property_enum_sdna(prop, NULL, "passtype");
382         RNA_def_property_enum_items(prop, pass_type_items);
383         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
384
385         prop= RNA_def_property(srna, "rect", PROP_COLLECTION, PROP_NONE);
386         RNA_def_property_struct_type(prop, "RenderValue");
387         RNA_def_property_collection_funcs(prop, "rna_RenderPass_rect_begin", "rna_iterator_array_next", "rna_iterator_array_end", "rna_iterator_array_get", "rna_RenderPass_rect_length", 0, 0, 0, 0);
388
389         RNA_define_verify_sdna(1);
390 }
391
392 void RNA_def_render(BlenderRNA *brna)
393 {
394         rna_def_render_engine(brna);
395         rna_def_render_result(brna);
396         rna_def_render_layer(brna);
397         rna_def_render_pass(brna);
398 }
399
400 #endif // RNA_RUNTIME
401