RenderEngine API: add self.report() error reporting function for render engines,
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2009)
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/makesrna/intern/rna_render.c
26  *  \ingroup RNA
27  */
28
29
30 #include <stdlib.h>
31
32 #include "DNA_scene_types.h"
33
34 #include "RNA_define.h"
35 #include "RNA_enum_types.h"
36
37 #include "rna_internal.h"
38
39 #include "RE_pipeline.h"
40
41 #include "BKE_utildefines.h"
42
43 #ifdef RNA_RUNTIME
44
45 #include "MEM_guardedalloc.h"
46
47 #include "RNA_access.h"
48
49 #include "BKE_context.h"
50 #include "BKE_report.h"
51
52 /* RenderEngine */
53
54 static RenderEngineType internal_render_type = {
55         NULL, NULL, "BLENDER_RENDER", "Blender Render", RE_INTERNAL, NULL, {NULL, NULL, NULL, NULL}};
56 #ifdef WITH_GAMEENGINE
57 static RenderEngineType internal_game_type = {
58         NULL, NULL, "BLENDER_GAME", "Blender Game", RE_INTERNAL|RE_GAME, NULL, {NULL, NULL, NULL, NULL}};
59 #endif
60
61 ListBase R_engines = {NULL, NULL};
62
63 void RE_engines_init(void)
64 {
65         BLI_addtail(&R_engines, &internal_render_type);
66 #ifdef WITH_GAMEENGINE
67         BLI_addtail(&R_engines, &internal_game_type);
68 #endif
69 }
70
71 void RE_engines_exit(void)
72 {
73         RenderEngineType *type, *next;
74
75         for(type=R_engines.first; type; type=next) {
76                 next= type->next;
77
78                 BLI_remlink(&R_engines, type);
79
80                 if(!(type->flag & RE_INTERNAL)) {
81                         if(type->ext.free)
82                                 type->ext.free(type->ext.data);
83
84                         MEM_freeN(type);
85                 }
86         }
87 }
88
89 static void engine_render(RenderEngine *engine, struct Scene *scene)
90 {
91         PointerRNA ptr;
92         ParameterList list;
93         FunctionRNA *func;
94
95         RNA_pointer_create(NULL, engine->type->ext.srna, engine, &ptr);
96         func= RNA_struct_find_function(&ptr, "render");
97
98         RNA_parameter_list_create(&list, &ptr, func);
99         RNA_parameter_set_lookup(&list, "scene", &scene);
100         engine->type->ext.call(NULL, &ptr, func, &list);
101
102         RNA_parameter_list_free(&list);
103 }
104
105 static void rna_RenderEngine_unregister(Main *UNUSED(bmain), StructRNA *type)
106 {
107         RenderEngineType *et= RNA_struct_blender_type_get(type);
108
109         if(!et)
110                 return;
111         
112         RNA_struct_free_extension(type, &et->ext);
113         BLI_freelinkN(&R_engines, et);
114         RNA_struct_free(&BLENDER_RNA, type);
115 }
116
117 static StructRNA *rna_RenderEngine_register(Main *bmain, ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
118 {
119         RenderEngineType *et, dummyet = {NULL};
120         RenderEngine dummyengine= {NULL};
121         PointerRNA dummyptr;
122         int have_function[1];
123
124         /* setup dummy engine & engine type to store static properties in */
125         dummyengine.type= &dummyet;
126         RNA_pointer_create(NULL, &RNA_RenderEngine, &dummyengine, &dummyptr);
127
128         /* validate the python class */
129         if(validate(&dummyptr, data, have_function) != 0)
130                 return NULL;
131
132         if(strlen(identifier) >= sizeof(dummyet.idname)) {
133                 BKE_reportf(reports, RPT_ERROR, "registering render engine class: '%s' is too long, maximum length is %d.", identifier, (int)sizeof(dummyet.idname));
134                 return NULL;
135         }
136
137         /* check if we have registered this engine type before, and remove it */
138         for(et=R_engines.first; et; et=et->next) {
139                 if(strcmp(et->idname, dummyet.idname) == 0) {
140                         if(et->ext.srna)
141                                 rna_RenderEngine_unregister(bmain, et->ext.srna);
142                         break;
143                 }
144         }
145         
146         /* create a new engine type */
147         et= MEM_callocN(sizeof(RenderEngineType), "python buttons engine");
148         memcpy(et, &dummyet, sizeof(dummyet));
149
150         et->ext.srna= RNA_def_struct(&BLENDER_RNA, et->idname, "RenderEngine"); 
151         et->ext.data= data;
152         et->ext.call= call;
153         et->ext.free= free;
154         RNA_struct_blender_type_set(et->ext.srna, et);
155
156         et->render= (have_function[0])? engine_render: NULL;
157
158         BLI_addtail(&R_engines, et);
159
160         return et->ext.srna;
161 }
162
163 static StructRNA* rna_RenderEngine_refine(PointerRNA *ptr)
164 {
165         RenderEngine *engine= (RenderEngine*)ptr->data;
166         return (engine->type && engine->type->ext.srna)? engine->type->ext.srna: &RNA_RenderEngine;
167 }
168
169 static void rna_RenderResult_layers_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
170 {
171         RenderResult *rr= (RenderResult*)ptr->data;
172         rna_iterator_listbase_begin(iter, &rr->layers, NULL);
173 }
174
175 static void rna_RenderLayer_passes_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
176 {
177         RenderLayer *rl= (RenderLayer*)ptr->data;
178         rna_iterator_listbase_begin(iter, &rl->passes, NULL);
179 }
180
181 static int rna_RenderLayer_rect_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
182 {
183         RenderLayer *rl= (RenderLayer*)ptr->data;
184
185         length[0]= rl->rectx*rl->recty;
186         length[1]= 4;
187
188         return length[0]*length[1];
189 }
190
191 static void rna_RenderLayer_rect_get(PointerRNA *ptr, float *values)
192 {
193         RenderLayer *rl= (RenderLayer*)ptr->data;
194         memcpy(values, rl->rectf, sizeof(float)*rl->rectx*rl->recty*4);
195 }
196
197 static void rna_RenderLayer_rect_set(PointerRNA *ptr, const float *values)
198 {
199         RenderLayer *rl= (RenderLayer*)ptr->data;
200         memcpy(rl->rectf, values, sizeof(float)*rl->rectx*rl->recty*4);
201 }
202
203 static int rna_RenderPass_rect_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
204 {
205         RenderPass *rpass= (RenderPass*)ptr->data;
206
207         length[0]= rpass->rectx*rpass->recty;
208         length[1]= rpass->channels;
209
210         return length[0]*length[1];
211 }
212
213 static void rna_RenderPass_rect_get(PointerRNA *ptr, float *values)
214 {
215         RenderPass *rpass= (RenderPass*)ptr->data;
216         memcpy(values, rpass->rect, sizeof(float)*rpass->rectx*rpass->recty*rpass->channels);
217 }
218
219 static void rna_RenderPass_rect_set(PointerRNA *ptr, const float *values)
220 {
221         RenderPass *rpass= (RenderPass*)ptr->data;
222         memcpy(rpass->rect, values, sizeof(float)*rpass->rectx*rpass->recty*rpass->channels);
223 }
224
225 #else // RNA_RUNTIME
226
227 static void rna_def_render_engine(BlenderRNA *brna)
228 {
229         StructRNA *srna;
230         PropertyRNA *prop;
231         FunctionRNA *func;
232         
233         srna= RNA_def_struct(brna, "RenderEngine", NULL);
234         RNA_def_struct_sdna(srna, "RenderEngine");
235         RNA_def_struct_ui_text(srna, "Render Engine", "Render engine");
236         RNA_def_struct_refine_func(srna, "rna_RenderEngine_refine");
237         RNA_def_struct_register_funcs(srna, "rna_RenderEngine_register", "rna_RenderEngine_unregister", NULL);
238
239         /* render */
240         func= RNA_def_function(srna, "render", NULL);
241         RNA_def_function_ui_description(func, "Render scene into an image.");
242         RNA_def_function_flag(func, FUNC_REGISTER);
243         RNA_def_pointer(func, "scene", "Scene", "", "");
244
245         func= RNA_def_function(srna, "begin_result", "RE_engine_begin_result");
246         prop= RNA_def_int(func, "x", 0, 0, INT_MAX, "X", "", 0, INT_MAX);
247         RNA_def_property_flag(prop, PROP_REQUIRED);
248         prop= RNA_def_int(func, "y", 0, 0, INT_MAX, "Y", "", 0, INT_MAX);
249         RNA_def_property_flag(prop, PROP_REQUIRED);
250         prop= RNA_def_int(func, "w", 0, 0, INT_MAX, "Width", "", 0, INT_MAX);
251         RNA_def_property_flag(prop, PROP_REQUIRED);
252         prop= RNA_def_int(func, "h", 0, 0, INT_MAX, "Height", "", 0, INT_MAX);
253         RNA_def_property_flag(prop, PROP_REQUIRED);
254         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
255         RNA_def_function_return(func, prop);
256
257         func= RNA_def_function(srna, "update_result", "RE_engine_update_result");
258         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
259         RNA_def_property_flag(prop, PROP_REQUIRED);
260
261         func= RNA_def_function(srna, "end_result", "RE_engine_end_result");
262         prop= RNA_def_pointer(func, "result", "RenderResult", "Result", "");
263         RNA_def_property_flag(prop, PROP_REQUIRED);
264
265         func= RNA_def_function(srna, "test_break", "RE_engine_test_break");
266         prop= RNA_def_boolean(func, "do_break", 0, "Break", "");
267         RNA_def_function_return(func, prop);
268
269         func= RNA_def_function(srna, "update_stats", "RE_engine_update_stats");
270         prop= RNA_def_string(func, "stats", "", 0, "Stats", "");
271         RNA_def_property_flag(prop, PROP_REQUIRED);
272         prop= RNA_def_string(func, "info", "", 0, "Info", "");
273         RNA_def_property_flag(prop, PROP_REQUIRED);
274
275         func= RNA_def_function(srna, "report", "RE_engine_report");
276         prop= RNA_def_enum_flag(func, "type", wm_report_items, 0, "Type", "");
277         RNA_def_property_flag(prop, PROP_REQUIRED);
278         prop= RNA_def_string(func, "message", "", 0, "Report Message", "");
279         RNA_def_property_flag(prop, PROP_REQUIRED);
280
281         /* registration */
282         RNA_define_verify_sdna(0);
283
284         prop= RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
285         RNA_def_property_string_sdna(prop, NULL, "type->idname");
286         RNA_def_property_flag(prop, PROP_REGISTER|PROP_NEVER_CLAMP);
287
288         prop= RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
289         RNA_def_property_string_sdna(prop, NULL, "type->name");
290         RNA_def_property_flag(prop, PROP_REGISTER);
291
292         prop= RNA_def_property(srna, "bl_use_preview", PROP_BOOLEAN, PROP_NONE);
293         RNA_def_property_boolean_sdna(prop, NULL, "type->flag", RE_DO_PREVIEW);
294         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
295
296         prop= RNA_def_property(srna, "bl_use_postprocess", PROP_BOOLEAN, PROP_NONE);
297         RNA_def_property_boolean_negative_sdna(prop, NULL, "type->flag", RE_DO_ALL);
298         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
299
300         RNA_define_verify_sdna(1);
301 }
302
303 static void rna_def_render_result(BlenderRNA *brna)
304 {
305         StructRNA *srna;
306         FunctionRNA *func;
307         PropertyRNA *parm;
308         
309         srna= RNA_def_struct(brna, "RenderResult", NULL);
310         RNA_def_struct_ui_text(srna, "Render Result", "Result of rendering, including all layers and passes");
311
312         func= RNA_def_function(srna, "load_from_file", "RE_result_load_from_file");
313         RNA_def_function_ui_description(func, "Copies the pixels of this render result from an image file.");
314         RNA_def_function_flag(func, FUNC_USE_REPORTS);
315         parm= RNA_def_string_file_name(func, "filename", "", FILE_MAX, "File Name", "Filename to load into this render tile, must be no smaller than the render result");
316         RNA_def_property_flag(parm, PROP_REQUIRED);
317
318         RNA_define_verify_sdna(0);
319
320         parm= RNA_def_property(srna, "resolution_x", PROP_INT, PROP_NONE);
321         RNA_def_property_int_sdna(parm, NULL, "rectx");
322         RNA_def_property_clear_flag(parm, PROP_EDITABLE);
323
324         parm= RNA_def_property(srna, "resolution_y", PROP_INT, PROP_NONE);
325         RNA_def_property_int_sdna(parm, NULL, "recty");
326         RNA_def_property_clear_flag(parm, PROP_EDITABLE);
327
328         parm= RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
329         RNA_def_property_struct_type(parm, "RenderLayer");
330         RNA_def_property_collection_funcs(parm, "rna_RenderResult_layers_begin", "rna_iterator_listbase_next", "rna_iterator_listbase_end", "rna_iterator_listbase_get", 0, 0, 0);
331
332         RNA_define_verify_sdna(1);
333 }
334
335 static void rna_def_render_layer(BlenderRNA *brna)
336 {
337         StructRNA *srna;
338         PropertyRNA *prop;
339         FunctionRNA *func;
340         
341         srna= RNA_def_struct(brna, "RenderLayer", NULL);
342         RNA_def_struct_ui_text(srna, "Render Layer", "");
343
344         func= RNA_def_function(srna, "load_from_file", "RE_layer_load_from_file");
345         RNA_def_function_ui_description(func, "Copies the pixels of this renderlayer from an image file.");
346         RNA_def_function_flag(func, FUNC_USE_REPORTS);
347         prop= RNA_def_string(func, "filename", "", 0, "Filename", "Filename to load into this render tile, must be no smaller than the renderlayer");
348         RNA_def_property_flag(prop, PROP_REQUIRED);
349         RNA_def_int(func, "x", 0, 0, INT_MAX, "Offset X", "Offset the position to copy from if the image is larger than the render layer", 0, INT_MAX);
350         RNA_def_int(func, "y", 0, 0, INT_MAX, "Offset Y", "Offset the position to copy from if the image is larger than the render layer", 0, INT_MAX);
351
352         RNA_define_verify_sdna(0);
353
354         rna_def_render_layer_common(srna, 0);
355
356         prop= RNA_def_property(srna, "passes", PROP_COLLECTION, PROP_NONE);
357         RNA_def_property_struct_type(prop, "RenderPass");
358         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);
359
360         prop= RNA_def_property(srna, "rect", PROP_FLOAT, PROP_NONE);
361         RNA_def_property_flag(prop, PROP_DYNAMIC);
362         RNA_def_property_multi_array(prop, 2, NULL);
363         RNA_def_property_dynamic_array_funcs(prop, "rna_RenderLayer_rect_get_length");
364         RNA_def_property_float_funcs(prop, "rna_RenderLayer_rect_get", "rna_RenderLayer_rect_set", NULL);
365
366         RNA_define_verify_sdna(1);
367 }
368
369 static void rna_def_render_pass(BlenderRNA *brna)
370 {
371         StructRNA *srna;
372         PropertyRNA *prop;
373
374         static EnumPropertyItem pass_type_items[]= {
375                 {SCE_PASS_COMBINED, "COMBINED", 0, "Combined", ""},
376                 {SCE_PASS_Z, "Z", 0, "Z", ""},
377                 {SCE_PASS_RGBA, "COLOR", 0, "Color", ""},
378                 {SCE_PASS_DIFFUSE, "DIFFUSE", 0, "Diffuse", ""},
379                 {SCE_PASS_SPEC, "SPECULAR", 0, "Specular", ""},
380                 {SCE_PASS_SHADOW, "SHADOW", 0, "Shadow", ""},
381                 {SCE_PASS_AO, "AO", 0, "AO", ""},
382                 {SCE_PASS_REFLECT, "REFLECTION", 0, "Reflection", ""},
383                 {SCE_PASS_NORMAL, "NORMAL", 0, "Normal", ""},
384                 {SCE_PASS_VECTOR, "VECTOR", 0, "Vector", ""},
385                 {SCE_PASS_REFRACT, "REFRACTION", 0, "Refraction", ""},
386                 {SCE_PASS_INDEXOB, "OBJECT_INDEX", 0, "Object Index", ""},
387                 {SCE_PASS_UV, "UV", 0, "UV", ""},
388                 {SCE_PASS_MIST, "MIST", 0, "Mist", ""},
389                 {SCE_PASS_EMIT, "EMIT", 0, "Emit", ""},
390                 {SCE_PASS_ENVIRONMENT, "ENVIRONMENT", 0, "Environment", ""},
391                 {0, NULL, 0, NULL, NULL}};
392         
393         srna= RNA_def_struct(brna, "RenderPass", NULL);
394         RNA_def_struct_ui_text(srna, "Render Pass", "");
395
396         RNA_define_verify_sdna(0);
397
398         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
399         RNA_def_property_string_sdna(prop, NULL, "name");
400         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
401         RNA_def_struct_name_property(srna, prop);
402
403         prop= RNA_def_property(srna, "channel_id", PROP_STRING, PROP_NONE);
404         RNA_def_property_string_sdna(prop, NULL, "chan_id");
405         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
406
407         prop= RNA_def_property(srna, "channels", PROP_INT, PROP_NONE);
408         RNA_def_property_int_sdna(prop, NULL, "channels");
409         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
410
411         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
412         RNA_def_property_enum_sdna(prop, NULL, "passtype");
413         RNA_def_property_enum_items(prop, pass_type_items);
414         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
415
416         prop= RNA_def_property(srna, "rect", PROP_FLOAT, PROP_NONE);
417         RNA_def_property_flag(prop, PROP_DYNAMIC);
418         RNA_def_property_multi_array(prop, 2, NULL);
419         RNA_def_property_dynamic_array_funcs(prop, "rna_RenderPass_rect_get_length");
420         RNA_def_property_float_funcs(prop, "rna_RenderPass_rect_get", "rna_RenderPass_rect_set", NULL);
421
422         RNA_define_verify_sdna(1);
423 }
424
425 void RNA_def_render(BlenderRNA *brna)
426 {
427         rna_def_render_engine(brna);
428         rna_def_render_result(brna);
429         rna_def_render_layer(brna);
430         rna_def_render_pass(brna);
431 }
432
433 #endif // RNA_RUNTIME
434