5a80db74c3846194e353b91ea69ab384174e8761
[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 int rna_RenderLayer_rect_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
174 {
175         RenderLayer *rl= (RenderLayer*)ptr->data;
176
177         length[0]= rl->rectx*rl->recty;
178         length[1]= 4;
179
180         return length[0]*length[1];
181 }
182
183 static void rna_RenderLayer_rect_get(PointerRNA *ptr, float *values)
184 {
185         RenderLayer *rl= (RenderLayer*)ptr->data;
186         memcpy(values, rl->rectf, sizeof(float)*rl->rectx*rl->recty*4);
187 }
188
189 static void rna_RenderLayer_rect_set(PointerRNA *ptr, const float *values)
190 {
191         RenderLayer *rl= (RenderLayer*)ptr->data;
192         memcpy(rl->rectf, values, sizeof(float)*rl->rectx*rl->recty*4);
193 }
194
195 static int rna_RenderPass_rect_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
196 {
197         RenderPass *rpass= (RenderPass*)ptr->data;
198
199         length[0]= rpass->rectx*rpass->recty;
200         length[1]= rpass->channels;
201
202         return length[0]*length[1];
203 }
204
205 static void rna_RenderPass_rect_get(PointerRNA *ptr, float *values)
206 {
207         RenderPass *rpass= (RenderPass*)ptr->data;
208         printf("rect get\n");
209         memcpy(values, rpass->rect, sizeof(float)*rpass->rectx*rpass->recty*rpass->channels);
210 }
211
212 static void rna_RenderPass_rect_set(PointerRNA *ptr, const float *values)
213 {
214         RenderPass *rpass= (RenderPass*)ptr->data;
215         printf("rect set\n");
216         memcpy(rpass->rect, values, sizeof(float)*rpass->rectx*rpass->recty*rpass->channels);
217 }
218
219 #else // RNA_RUNTIME
220
221 static void rna_def_render_engine(BlenderRNA *brna)
222 {
223         StructRNA *srna;
224         PropertyRNA *prop;
225         FunctionRNA *func;
226         
227         srna= RNA_def_struct(brna, "RenderEngine", NULL);
228         RNA_def_struct_sdna(srna, "RenderEngine");
229         RNA_def_struct_ui_text(srna, "Render Engine", "Render engine.");
230         RNA_def_struct_refine_func(srna, "rna_RenderEngine_refine");
231         RNA_def_struct_register_funcs(srna, "rna_RenderEngine_register", "rna_RenderEngine_unregister");
232
233         /* render */
234         func= RNA_def_function(srna, "render", NULL);
235         RNA_def_function_ui_description(func, "Render scene into an image.");
236         RNA_def_function_flag(func, FUNC_REGISTER);
237         RNA_def_pointer(func, "scene", "Scene", "", "");
238
239         func= RNA_def_function(srna, "begin_result", "RE_engine_begin_result");
240         prop= RNA_def_int(func, "x", 0, 0, INT_MAX, "X", "", 0, INT_MAX);
241         RNA_def_property_flag(prop, PROP_REQUIRED);
242         prop= RNA_def_int(func, "y", 0, 0, INT_MAX, "Y", "", 0, INT_MAX);
243         RNA_def_property_flag(prop, PROP_REQUIRED);
244         prop= RNA_def_int(func, "w", 0, 0, INT_MAX, "Width", "", 0, INT_MAX);
245         RNA_def_property_flag(prop, PROP_REQUIRED);
246         prop= RNA_def_int(func, "h", 0, 0, INT_MAX, "Height", "", 0, INT_MAX);
247         RNA_def_property_flag(prop, PROP_REQUIRED);
248         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
249         RNA_def_function_return(func, prop);
250
251         func= RNA_def_function(srna, "update_result", "RE_engine_update_result");
252         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
253         RNA_def_property_flag(prop, PROP_REQUIRED);
254
255         func= RNA_def_function(srna, "end_result", "RE_engine_end_result");
256         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
257         RNA_def_property_flag(prop, PROP_REQUIRED);
258
259         func= RNA_def_function(srna, "test_break", "RE_engine_test_break");
260         prop= RNA_def_boolean(func, "do_break", 0, "Break", "");
261         RNA_def_function_return(func, prop);
262
263         func= RNA_def_function(srna, "update_stats", "RE_engine_update_stats");
264         prop= RNA_def_string(func, "stats", "", 0, "Stats", "");
265         RNA_def_property_flag(prop, PROP_REQUIRED);
266         prop= RNA_def_string(func, "info", "", 0, "Info", "");
267         RNA_def_property_flag(prop, PROP_REQUIRED);
268
269         /* registration */
270         RNA_define_verify_sdna(0);
271
272         prop= RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
273         RNA_def_property_string_sdna(prop, NULL, "type->idname");
274         RNA_def_property_flag(prop, PROP_REGISTER);
275
276         prop= RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
277         RNA_def_property_string_sdna(prop, NULL, "type->name");
278         RNA_def_property_flag(prop, PROP_REGISTER);
279
280         RNA_define_verify_sdna(1);
281 }
282
283 static void rna_def_render_result(BlenderRNA *brna)
284 {
285         StructRNA *srna;
286         PropertyRNA *prop;
287         FunctionRNA *func;
288         
289         srna= RNA_def_struct(brna, "RenderResult", NULL);
290         RNA_def_struct_ui_text(srna, "Render Result", "Result of rendering, including all layers and passes.");
291
292         func= RNA_def_function(srna, "load_from_file", "RE_result_load_from_file");
293         RNA_def_function_ui_description(func, "Copies the pixels of this render result from an image file.");
294         RNA_def_function_flag(func, FUNC_USE_REPORTS);
295         prop= RNA_def_string(func, "filename", "", 0, "Filename", "Filename to load into this render tile, must be no smaller then the render result");
296         RNA_def_property_flag(prop, PROP_REQUIRED);
297
298         RNA_define_verify_sdna(0);
299
300         prop= RNA_def_property(srna, "resolution_x", PROP_INT, PROP_NONE);
301         RNA_def_property_int_sdna(prop, NULL, "rectx");
302         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
303
304         prop= RNA_def_property(srna, "resolution_y", PROP_INT, PROP_NONE);
305         RNA_def_property_int_sdna(prop, NULL, "recty");
306         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
307
308         prop= RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
309         RNA_def_property_struct_type(prop, "RenderLayer");
310         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);
311
312         RNA_define_verify_sdna(1);
313 }
314
315 static void rna_def_render_layer(BlenderRNA *brna)
316 {
317         StructRNA *srna;
318         PropertyRNA *prop;
319         FunctionRNA *func;
320         
321         srna= RNA_def_struct(brna, "RenderLayer", NULL);
322         RNA_def_struct_ui_text(srna, "Render Layer", "");
323
324         func= RNA_def_function(srna, "load_from_file", "RE_layer_load_from_file");
325         RNA_def_function_ui_description(func, "Copies the pixels of this renderlayer from an image file.");
326         RNA_def_function_flag(func, FUNC_USE_REPORTS);
327         prop= RNA_def_string(func, "filename", "", 0, "Filename", "Filename to load into this render tile, must be no smaller then the renderlayer");
328         RNA_def_property_flag(prop, PROP_REQUIRED);
329         
330         RNA_define_verify_sdna(0);
331
332         rna_def_render_layer_common(srna, 0);
333
334         prop= RNA_def_property(srna, "passes", PROP_COLLECTION, PROP_NONE);
335         RNA_def_property_struct_type(prop, "RenderPass");
336         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);
337
338         prop= RNA_def_property(srna, "rect", PROP_FLOAT, PROP_NONE);
339         RNA_def_property_flag(prop, PROP_DYNAMIC);
340         RNA_def_property_multi_array(prop, 2, NULL);
341         RNA_def_property_dynamic_array_funcs(prop, "rna_RenderLayer_rect_get_length");
342         RNA_def_property_float_funcs(prop, "rna_RenderLayer_rect_get", "rna_RenderLayer_rect_set", NULL);
343
344         RNA_define_verify_sdna(1);
345 }
346
347 static void rna_def_render_pass(BlenderRNA *brna)
348 {
349         StructRNA *srna;
350         PropertyRNA *prop;
351
352         static EnumPropertyItem pass_type_items[]= {
353                 {SCE_PASS_COMBINED, "COMBINED", 0, "Combined", ""},
354                 {SCE_PASS_Z, "Z", 0, "Z", ""},
355                 {SCE_PASS_RGBA, "COLOR", 0, "Color", ""},
356                 {SCE_PASS_DIFFUSE, "DIFFUSE", 0, "Diffuse", ""},
357                 {SCE_PASS_SPEC, "SPECULAR", 0, "Specular", ""},
358                 {SCE_PASS_SHADOW, "SHADOW", 0, "Shadow", ""},
359                 {SCE_PASS_AO, "AO", 0, "AO", ""},
360                 {SCE_PASS_REFLECT, "REFLECTION", 0, "Reflection", ""},
361                 {SCE_PASS_NORMAL, "NORMAL", 0, "Normal", ""},
362                 {SCE_PASS_VECTOR, "VECTOR", 0, "Vecotr", ""},
363                 {SCE_PASS_REFRACT, "REFRACTION", 0, "Refraction", ""},
364                 {SCE_PASS_INDEXOB, "OBJECT_INDEX", 0, "Object Index", ""},
365                 {SCE_PASS_UV, "UV", 0, "UV", ""},
366                 {SCE_PASS_MIST, "MIST", 0, "Mist", ""},
367                 {0, NULL, 0, NULL, NULL}};
368         
369         srna= RNA_def_struct(brna, "RenderPass", NULL);
370         RNA_def_struct_ui_text(srna, "Render Pass", "");
371
372         RNA_define_verify_sdna(0);
373
374         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
375         RNA_def_property_string_sdna(prop, NULL, "name");
376         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
377         RNA_def_struct_name_property(srna, prop);
378
379         prop= RNA_def_property(srna, "channel_id", PROP_STRING, PROP_NONE);
380         RNA_def_property_string_sdna(prop, NULL, "chan_id");
381         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
382
383         prop= RNA_def_property(srna, "channels", PROP_INT, PROP_NONE);
384         RNA_def_property_int_sdna(prop, NULL, "channels");
385         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
386
387         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
388         RNA_def_property_enum_sdna(prop, NULL, "passtype");
389         RNA_def_property_enum_items(prop, pass_type_items);
390         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
391
392         prop= RNA_def_property(srna, "rect", PROP_FLOAT, PROP_NONE);
393         RNA_def_property_flag(prop, PROP_DYNAMIC);
394         RNA_def_property_multi_array(prop, 2, NULL);
395         RNA_def_property_dynamic_array_funcs(prop, "rna_RenderPass_rect_get_length");
396         RNA_def_property_float_funcs(prop, "rna_RenderPass_rect_get", "rna_RenderPass_rect_set", NULL);
397
398         RNA_define_verify_sdna(1);
399 }
400
401 void RNA_def_render(BlenderRNA *brna)
402 {
403         rna_def_render_engine(brna);
404         rna_def_render_result(brna);
405         rna_def_render_layer(brna);
406         rna_def_render_pass(brna);
407 }
408
409 #endif // RNA_RUNTIME
410