Undo revision 23130 which was a merge with 2.5, a messy one because I did something...
[blender.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         RNA_struct_free_extension(type, &et->ext);
110         BLI_freelinkN(&R_engines, et);
111         RNA_struct_free(&BLENDER_RNA, type);
112 }
113
114 static StructRNA *rna_RenderEngine_register(const bContext *C, ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
115 {
116         RenderEngineType *et, dummyet = {0};
117         RenderEngine dummyengine= {0};
118         PointerRNA dummyptr;
119         int have_function[1];
120
121         /* setup dummy engine & engine type to store static properties in */
122         dummyengine.type= &dummyet;
123         RNA_pointer_create(NULL, &RNA_RenderEngine, &dummyengine, &dummyptr);
124
125         /* validate the python class */
126         if(validate(&dummyptr, data, have_function) != 0)
127                 return NULL;
128         
129         /* check if we have registered this engine type before, and remove it */
130         for(et=R_engines.first; et; et=et->next) {
131                 if(strcmp(et->idname, dummyet.idname) == 0) {
132                         if(et->ext.srna)
133                                 rna_RenderEngine_unregister(C, et->ext.srna);
134                         break;
135                 }
136         }
137         
138         /* create a new engine type */
139         et= MEM_callocN(sizeof(RenderEngineType), "python buttons engine");
140         memcpy(et, &dummyet, sizeof(dummyet));
141
142         et->ext.srna= RNA_def_struct(&BLENDER_RNA, et->idname, "RenderEngine"); 
143         et->ext.data= data;
144         et->ext.call= call;
145         et->ext.free= free;
146         RNA_struct_blender_type_set(et->ext.srna, et);
147
148         et->render= (have_function[0])? engine_render: NULL;
149
150         BLI_addtail(&R_engines, et);
151
152         return et->ext.srna;
153 }
154
155 static StructRNA* rna_RenderEngine_refine(PointerRNA *ptr)
156 {
157         RenderEngine *engine= (RenderEngine*)ptr->data;
158         return (engine->type && engine->type->ext.srna)? engine->type->ext.srna: &RNA_RenderEngine;
159 }
160
161 static void rna_RenderResult_layers_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
162 {
163         RenderResult *rr= (RenderResult*)ptr->data;
164         rna_iterator_listbase_begin(iter, &rr->layers, NULL);
165 }
166
167 static void rna_RenderLayer_passes_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
168 {
169         RenderLayer *rl= (RenderLayer*)ptr->data;
170         rna_iterator_listbase_begin(iter, &rl->passes, NULL);
171 }
172
173 static float rna_RenderValue_value_get(PointerRNA *ptr)
174 {
175         return *(float*)ptr->data;
176 }
177
178 static void rna_RenderValue_value_set(PointerRNA *ptr, float value)
179 {
180         *(float*)ptr->data= value;
181 }
182
183 static void rna_RenderLayer_rect_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
184 {
185         RenderLayer *rl= (RenderLayer*)ptr->data;
186         rna_iterator_array_begin(iter, (void*)rl->rectf, sizeof(float), rl->rectx*rl->recty*4, 0, NULL);
187 }
188
189 static int rna_RenderLayer_rect_length(PointerRNA *ptr)
190 {
191         RenderLayer *rl= (RenderLayer*)ptr->data;
192         return rl->rectx*rl->recty*4;
193 }
194
195 static void rna_RenderPass_rect_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
196 {
197         RenderPass *rpass= (RenderPass*)ptr->data;
198         rna_iterator_array_begin(iter, (void*)rpass->rect, sizeof(float), rpass->rectx*rpass->recty*rpass->channels, 0, NULL);
199 }
200
201 static int rna_RenderPass_rect_length(PointerRNA *ptr)
202 {
203         RenderPass *rpass= (RenderPass*)ptr->data;
204         return rpass->rectx*rpass->recty*rpass->channels;
205 }
206
207
208 #else // RNA_RUNTIME
209
210 static void rna_def_render_engine(BlenderRNA *brna)
211 {
212         StructRNA *srna;
213         PropertyRNA *prop;
214         FunctionRNA *func;
215         
216         srna= RNA_def_struct(brna, "RenderEngine", NULL);
217         RNA_def_struct_sdna(srna, "RenderEngine");
218         RNA_def_struct_ui_text(srna, "Render Engine", "Render engine.");
219         RNA_def_struct_refine_func(srna, "rna_RenderEngine_refine");
220         RNA_def_struct_register_funcs(srna, "rna_RenderEngine_register", "rna_RenderEngine_unregister");
221
222         /* render */
223         func= RNA_def_function(srna, "render", NULL);
224         RNA_def_function_ui_description(func, "Render scene into an image.");
225         RNA_def_function_flag(func, FUNC_REGISTER);
226         RNA_def_pointer(func, "scene", "Scene", "", "");
227
228         func= RNA_def_function(srna, "begin_result", "RE_engine_begin_result");
229         prop= RNA_def_int(func, "x", 0, 0, INT_MAX, "X", "", 0, INT_MAX);
230         RNA_def_property_flag(prop, PROP_REQUIRED);
231         prop= RNA_def_int(func, "y", 0, 0, INT_MAX, "Y", "", 0, INT_MAX);
232         RNA_def_property_flag(prop, PROP_REQUIRED);
233         prop= RNA_def_int(func, "w", 0, 0, INT_MAX, "Width", "", 0, INT_MAX);
234         RNA_def_property_flag(prop, PROP_REQUIRED);
235         prop= RNA_def_int(func, "h", 0, 0, INT_MAX, "Height", "", 0, INT_MAX);
236         RNA_def_property_flag(prop, PROP_REQUIRED);
237         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
238         RNA_def_function_return(func, prop);
239
240         func= RNA_def_function(srna, "update_result", "RE_engine_update_result");
241         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
242         RNA_def_property_flag(prop, PROP_REQUIRED);
243
244         func= RNA_def_function(srna, "end_result", "RE_engine_end_result");
245         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
246         RNA_def_property_flag(prop, PROP_REQUIRED);
247
248         func= RNA_def_function(srna, "test_break", "RE_engine_test_break");
249         prop= RNA_def_boolean(func, "do_break", 0, "Break", "");
250         RNA_def_function_return(func, prop);
251
252         func= RNA_def_function(srna, "update_stats", "RE_engine_update_stats");
253         prop= RNA_def_string(func, "stats", "", 0, "Stats", "");
254         RNA_def_property_flag(prop, PROP_REQUIRED);
255         prop= RNA_def_string(func, "info", "", 0, "Info", "");
256         RNA_def_property_flag(prop, PROP_REQUIRED);
257
258         /* registration */
259         RNA_define_verify_sdna(0);
260
261         prop= RNA_def_property(srna, "idname", PROP_STRING, PROP_NONE);
262         RNA_def_property_string_sdna(prop, NULL, "type->idname");
263         RNA_def_property_flag(prop, PROP_REGISTER);
264
265         prop= RNA_def_property(srna, "label", PROP_STRING, PROP_NONE);
266         RNA_def_property_string_sdna(prop, NULL, "type->name");
267         RNA_def_property_flag(prop, PROP_REGISTER);
268
269         RNA_define_verify_sdna(1);
270 }
271
272 static void rna_def_render_result(BlenderRNA *brna)
273 {
274         StructRNA *srna;
275         PropertyRNA *prop;
276         FunctionRNA *func;
277         
278         srna= RNA_def_struct(brna, "RenderResult", NULL);
279         RNA_def_struct_ui_text(srna, "Render Result", "Result of rendering, including all layers and passes.");
280
281         func= RNA_def_function(srna, "load_from_file", "RE_result_load_from_file");
282         RNA_def_function_ui_description(func, "Copies the pixels of this render result from an image file.");
283         RNA_def_function_flag(func, FUNC_USE_REPORTS);
284         prop= RNA_def_string(func, "filename", "", 0, "Filename", "Filename to load into this render tile, must be no smaller then the render result");
285         RNA_def_property_flag(prop, PROP_REQUIRED);
286
287         RNA_define_verify_sdna(0);
288
289         prop= RNA_def_property(srna, "resolution_x", PROP_INT, PROP_NONE);
290         RNA_def_property_int_sdna(prop, NULL, "rectx");
291         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
292
293         prop= RNA_def_property(srna, "resolution_y", PROP_INT, PROP_NONE);
294         RNA_def_property_int_sdna(prop, NULL, "recty");
295         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
296
297         prop= RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
298         RNA_def_property_struct_type(prop, "RenderLayer");
299         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);
300
301         RNA_define_verify_sdna(1);
302 }
303
304 static void rna_def_render_layer(BlenderRNA *brna)
305 {
306         StructRNA *srna;
307         PropertyRNA *prop;
308         FunctionRNA *func;
309         
310         srna= RNA_def_struct(brna, "RenderLayer", NULL);
311         RNA_def_struct_ui_text(srna, "Render Layer", "");
312
313         func= RNA_def_function(srna, "load_from_file", "RE_layer_load_from_file");
314         RNA_def_function_ui_description(func, "Copies the pixels of this renderlayer from an image file.");
315         RNA_def_function_flag(func, FUNC_USE_REPORTS);
316         prop= RNA_def_string(func, "filename", "", 0, "Filename", "Filename to load into this render tile, must be no smaller then the renderlayer");
317         RNA_def_property_flag(prop, PROP_REQUIRED);
318         
319         RNA_define_verify_sdna(0);
320
321         rna_def_render_layer_common(srna, 0);
322
323         prop= RNA_def_property(srna, "passes", PROP_COLLECTION, PROP_NONE);
324         RNA_def_property_struct_type(prop, "RenderPass");
325         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);
326
327         prop= RNA_def_property(srna, "rect", PROP_COLLECTION, PROP_NONE);
328         RNA_def_property_struct_type(prop, "RenderValue");
329         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);
330
331         /* value */
332         srna= RNA_def_struct(brna, "RenderValue", NULL);
333         RNA_def_struct_ui_text(srna, "Render Value", "");
334
335         prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
336         RNA_def_property_float_funcs(prop, "rna_RenderValue_value_get", "rna_RenderValue_value_set", NULL);
337
338         RNA_define_verify_sdna(1);
339 }
340
341 static void rna_def_render_pass(BlenderRNA *brna)
342 {
343         StructRNA *srna;
344         PropertyRNA *prop;
345
346         static EnumPropertyItem pass_type_items[]= {
347                 {SCE_PASS_COMBINED, "COMBINED", 0, "Combined", ""},
348                 {SCE_PASS_Z, "Z", 0, "Z", ""},
349                 {SCE_PASS_RGBA, "COLOR", 0, "Color", ""},
350                 {SCE_PASS_DIFFUSE, "DIFFUSE", 0, "Diffuse", ""},
351                 {SCE_PASS_SPEC, "SPECULAR", 0, "Specular", ""},
352                 {SCE_PASS_SHADOW, "SHADOW", 0, "Shadow", ""},
353                 {SCE_PASS_AO, "AO", 0, "AO", ""},
354                 {SCE_PASS_REFLECT, "REFLECTION", 0, "Reflection", ""},
355                 {SCE_PASS_NORMAL, "NORMAL", 0, "Normal", ""},
356                 {SCE_PASS_VECTOR, "VECTOR", 0, "Vecotr", ""},
357                 {SCE_PASS_REFRACT, "REFRACTION", 0, "Refraction", ""},
358                 {SCE_PASS_INDEXOB, "OBJECT_INDEX", 0, "Object Index", ""},
359                 {SCE_PASS_UV, "UV", 0, "UV", ""},
360                 {SCE_PASS_MIST, "MIST", 0, "Mist", ""},
361                 {0, NULL, 0, NULL, NULL}};
362         
363         srna= RNA_def_struct(brna, "RenderPass", NULL);
364         RNA_def_struct_ui_text(srna, "Render Pass", "");
365
366         RNA_define_verify_sdna(0);
367
368         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
369         RNA_def_property_string_sdna(prop, NULL, "name");
370         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
371         RNA_def_struct_name_property(srna, prop);
372
373         prop= RNA_def_property(srna, "channel_id", PROP_STRING, PROP_NONE);
374         RNA_def_property_string_sdna(prop, NULL, "chan_id");
375         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
376
377         prop= RNA_def_property(srna, "channels", PROP_INT, PROP_NONE);
378         RNA_def_property_int_sdna(prop, NULL, "channels");
379         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
380
381         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
382         RNA_def_property_enum_sdna(prop, NULL, "passtype");
383         RNA_def_property_enum_items(prop, pass_type_items);
384         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
385
386         prop= RNA_def_property(srna, "rect", PROP_COLLECTION, PROP_NONE);
387         RNA_def_property_struct_type(prop, "RenderValue");
388         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);
389
390         RNA_define_verify_sdna(1);
391 }
392
393 void RNA_def_render(BlenderRNA *brna)
394 {
395         rna_def_render_engine(brna);
396         rna_def_render_result(brna);
397         rna_def_render_layer(brna);
398         rna_def_render_pass(brna);
399 }
400
401 #endif // RNA_RUNTIME
402